🧠 神经医学博士
> 具有语义连接的AI原生知识库
NeuralMD是你的 第二大脑 --一个人类和人工智能合作存储、连接和检索知识的地方。与传统的笔记应用程序不同,NeuralMD使用 语义嵌入 自动找到你的想法之间的联系。
✨ 特性
- 🔍 语义搜索 --按含义查找笔记,而不仅仅是关键字
- 🔗 自动连接 --通过相似度图发现相关笔记
- 🤖 人工智能原生 --人工智能辅助集成的MCP协议
- 🏠 100%自托管 --您的数据保留在您的基础设施上
- 🔐 安全 -API密钥+可选的web UI基本验证
- 🆓 不需要API密钥 --使用Olama进行免费本地嵌入
- 📝 Markdown优先 --简单、便携、版本控制友好
- 👥 多租户就绪 --具有用户帐户和计划限制的SaaS模式
🏢 多租户模式(SaaS)
NeuralMD可以在SaaS部署中以多租户模式运行:```bash
Enable multi-tenant mode
MULTI_TENANT=true
**启用时的功能:**
- 用户使用电子邮件和密码注册/登录
- 用户数据隔离(注释、API密钥)
- 基于计划的限制(自由/专业/团队)
- 已准备好进行Stripe计费集成
**API终点:**```bash
# Sign up
curl -X POST /api/auth/signup \
-d '{"email": "user@example.com", "password": "secret123"}'
# Login
curl -X POST /api/auth/login \
-d '{"email": "user@example.com", "password": "secret123"}'
> 在单租户模式(默认)下,这些端点被禁用。
🚀 快速开始
先决条件
- Docker&Docker编写
安装```bash
git clone https://github.com/Samael27/neuralmd.git
cd neuralmd
cp .env.example .env
docker compose up -d
**就是这样!** 打开http://localhost:3000 🎉
> 第一次启动需要几分钟(Ollama下载了嵌入模型)。
### 可选:保护您的实例
编辑 `.env` 要启用身份验证,请执行以下操作:```bash
# API Authentication (recommended for production)
API_AUTH_REQUIRED=true
INTERNAL_API_TOKEN=
ADMIN_SECRET=
# Web UI Authentication (optional Basic Auth)
UI_USERNAME=admin
UI_PASSWORD=
🖥️ 截图
| 注释列表 | 语义图 |
|---|---|
| 浏览和搜索您的知识 | 可视化想法之间的联系 |
📡 API
通过身份验证```bash
Create an API key (requires ADMIN_SECRET)
curl -X POST https://your-instance/api/keys \
-H "Authorization: Bearer YOUR_ADMIN_SECRET" \
-H "Content-Type: application/json" \
-d '{"name": "My App"}'
Returns: { "key": "nmd_xxx..." }
Use the API key
curl https://your-instance/api/notes \
-H "Authorization: Bearer nmd_xxx..."
### 创建笔记```bash
curl -X POST http://localhost:3000/api/notes \
-H "Content-Type: application/json" \
-d '{
"title": "Meeting Notes",
"content": "Discussed the new architecture...",
"tags": ["meetings", "architecture"],
"source": "human"
}'
语义搜索```bash
curl -X POST http://localhost:3000/api/search \
-H "Content-Type: application/json" \
-d '{"query": "architecture decisions", "limit": 10}'
## 🔌 MCP集成
NeuralMD实现了 模型上下文协议(MCP) 实现无缝的AI助手集成。
### 可用工具
|工具|说明|
|------|-------------|
| `create_note` |创建带有自动嵌入功能的笔记|
| `search_notes` |跨笔记的语义搜索|
| `get_note` |按ID获取笔记|
| `update_note` |更新笔记内容|
| `delete_note` |删除注释|
| `list_notes` |带分页和过滤器的列表|
| `list_tags` |列出所有唯一标签|
### HTTP传输```bash
curl -X POST https://your-instance/api/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "search_notes",
"arguments": {"query": "architecture", "limit": 5}
}
}'
Clawdbot集成
即用型技能包含在 skills/neuralmd/.
☁️ 部署到生产
冷却(推荐)
- 添加新资源→ 应用→ Docker Compose
- 来源:GitHub→
Samael27/neuralmd - Docker编写位置:
/docker-compose.coolify.yml - 在Coolify UI中设置环境变量
- 部署!
看 安装.md 详细说明。
其他平台
适用于任何兼容Docker的平台:
- 波特纳
- CapRover
- 铁路
- 您自己的VPS
🛠️ 技术栈
| 组件 | 技术 |
|---|---|
| 框架 | Next.js 14(应用路由器) |
| 数据库 | PostgreSQL+pgvector |
| ORM | 棱镜 |
| 嵌入 | Ollama(默认)或OpenAI |
| 协议 | MCP(HTTP+stdio) |
| 身份验证 | API密钥+基本身份验证 |
🤝 贡献
欢迎投稿!请随意:
- 🐛 报告错误
- 💡 建议功能
- 🔧 提交PR
📄 许可证
MIT许可证 --随心所欲地使用它。
Built with 🧠 by humans and AI working together
