article
README
🚀 MemoDB MCP 服务器
MCP 服务器可用于管理 AI 应用的对话上下文与个人知识库。它借助模型上下文协议(MCP),提供了用户数据、对话内容和知识管理的工具,能有效提升 AI 应用的交互体验和知识管理效率。
🚀 快速开始
MCP 服务器通过模型上下文协议(MCP),为 AI 应用提供了强大的用户数据、对话内容和知识管理能力。以下是启动服务器的步骤:
- 安装依赖:
npm install
- 配置环境变量:
创建
.env文件并设置:
MEMOBASE_API_URL=your_api_url # API 服务器地址
MEMOBASE_API_KEY=your_api_key # API 访问密钥
- 构建项目:
npm run build
- 运行服务器:
# 生产环境
npm start
# 开发环境
npm run dev
✨ 主要特性
用户管理
create_user:创建新用户get_user:获取用户信息update_user:更新用户信息delete_user:删除用户
对话数据管理
insert_blob:插入对话数据get_blob:获取对话数据delete_blob:删除对话数据
知识库管理
query_knowledge:查询知识库- 支持全文搜索
- 支持按类型、标签、来源过滤
- 支持限制返回结果数量
add_knowledge:添加新知识- 支持设置知识来源
- 支持设置知识类型
- 支持添加标签
update_knowledge:更新已有知识- 支持更新内容和元数据
- 支持修改标签
relate_knowledge:创建知识关联- 支持设置关联类型
- 支持设置关联权重
🔧 技术细节
类型安全
- 使用 TypeScript 实现,具备完整的类型定义和检查,可在编译时进行错误检测。
错误处理
- 拥有全面的错误处理机制,能提供详细的错误信息,并进行错误日志记录。
API 设计
- 基于 JSON - RPC 2.0 协议,采用 RESTful API 风格,接口定义清晰。
可扩展性
- 采用模块化设计,支持插件式工具注册,便于添加新功能。
📦 安装指南
安装依赖
npm install
配置环境变量
创建 .env 文件并设置:
MEMOBASE_API_URL=your_api_url # API 服务器地址
MEMOBASE_API_KEY=your_api_key # API 访问密钥
构建项目
npm run build
运行服务器
# 生产环境
npm start
# 开发环境
npm run dev
💻 使用示例
基础用法
添加知识
const result = await callTool('add_knowledge', {
uid: 'user123',
content: '人工智能是计算机科学的一个分支...',
metadata: {
source: 'wiki',
type: 'article',
tags: ['AI', '计算机科学', '技术']
}
});
查询知识
const result = await callTool('query_knowledge', {
uid: 'user123',
query: '人工智能',
filters: {
types: ['article'],
tags: ['AI'],
sources: ['wiki']
},
limit: 10
});
关联知识
const result = await callTool('relate_knowledge', {
uid: 'user123',
source_kid: 'knowledge1',
target_kid: 'knowledge2',
relation_type: 'related_to',
weight: 0.8
});
📚 详细文档
开发指南
添加新工具
- 在代码中新增功能模块,需遵循现有设计模式和命名规范,确保模块间接口兼容性。
修改配置
- 更新
.env文件参数值,保持环境变量命名一致,并测试不同配置下的运行效果。
运行测试
- 使用
npm test执行单元测试,检查测试覆盖率报告,定期更新测试用例。
常见问题
- 如何获取帮助?查看文档或联系支持团队。
- 遇到错误如何处理?检查日志文件并参考排错指南。
📄 许可证
本项目遵循 [许可证名称] 协议。详细信息请参阅 LICENSE 文件。
扫码联系在线客服