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