Memos Api MCP

🚀 MemOS API的MCP服务器

这是一个为 MemOS API服务实现的模型上下文协议（MCP）。该包提供了一个命令行界面，可使用MCP标准与MemOS API进行交互。

🚀 快速开始

MCP配置

若要在MCP客户端中使用此包，请使用以下配置：

{
  "mcpServers": {
    "memos-api-mcp": {
      "command": "npx",
      "args": ["-y", "@memtensor/memos-api-mcp"],
      "env": {
        "MEMOS_API_KEY": "your-api-key",
        "MEMOS_USER_ID": "your-user-id",
        "MEMOS_CHANNEL": "the-site-where-you-are-seeing-this-document"
      }
    }
  }
}

配置说明

• command：使用 npx 来运行此包。
• args：传递给 npx 以运行此包的参数。
• env：环境变量。
  • MEMOS_API_KEY：用于身份验证的Memos API密钥（在仪表盘[https://memos-dashboard-pre.openmem.net/cn/quickstart/]获取API密钥）。
  • MEMOS_USER_ID：稳定的每人标识符。必须是确定性的且不包含个人身份信息（PII），并且对于同一人在不同设备/会话中必须保持一致。切勿在不同人之间重复使用。不要使用随机值、设备ID或模型/聊天会话ID。建议使用：SHA - 256(lowercase(trim(email))) 或您的单点登录主题/员工ID。
  • MEMOS_CHANNEL：您查看此文档的站点。候选值：MODELSCOPE、MCPSO、MCPMARKETCN、MCPMARKETCOM、GLAMA、PULSEMCP、MCPSERVERS、LOBEHUB、MEMOS（表示MemOS官方网站）、GITHUB（表示此README文件）。

可用的MCP工具

此包提供了以下MCP工具：

1. add_message

   • 向对话中添加一条新消息。
   • 参数：
     • conversation_id：用于标识消息所属对话的对话ID。
     • messages：包含角色和内容信息的消息数组。
       • role：消息发送者的角色，例如用户、助手。
       • content：消息内容。

2. search_memory

   • 在对话中搜索记忆。
   • 参数：
     • query：用于在对话历史中查找相关内容的搜索查询。
     • conversation_id：定义搜索范围的对话ID。
     • memory_limit_number：返回结果的最大数量，默认为6。

3. get_message

   • 从对话中检索消息。
   • 参数：
     • conversation_id：用于标识要检索哪个对话的消息的对话ID。

所有工具都使用相同的配置，并且需要 MEMOS_API_KEY 环境变量。

✨ 主要特性

• 符合MCP的API接口。
• 便于交互的命令行工具。
• 使用TypeScript构建，确保类型安全。
• 采用Express.js服务器实现。
• 具备Zod模式验证。

📦 安装指南

全局安装

你可以使用npm全局安装此包：

npm install -g @memtensor/memos-api-mcp

或者使用pnpm：

pnpm add -g @memtensor/memos-api-mcp

💻 使用示例

基础用法

安装完成后，你可以使用以下命令运行CLI工具：

npx @memtensor/memos-api-mcp

如果你进行了全局安装，则可以使用：

memos-api-mcp

📚 详细文档

开发步骤

1. 克隆仓库：

git clone <repository-url>
cd memos-api-mcp

2. 安装依赖：

pnpm install

3. 启动开发服务器：

pnpm dev

4. 构建项目：

pnpm build

可用脚本

• pnpm build：构建项目。
• pnpm dev：使用 tsx 启动开发服务器。
• pnpm start：运行构建后的版本。
• pnpm inspect：使用 @modelcontextprotocol/inspector 检查MCP实现。

项目结构

memos-mcp/
├── src/           # 源代码
├── build/         # 编译后的JavaScript文件
├── package.json   # 项目配置
└── tsconfig.json  # TypeScript配置

依赖项

• @modelcontextprotocol/sdk: ^1.0.0
• express: ^4.19.2
• zod: ^3.23.8
• ts-md5: ^2.0.0

版本

当前版本：1.0.0 - beta.2