Memos Api MCP

🚀 MemOS API用MCPサーバー

MemOS APIサービス向けのモデルコンテキストプロトコル（MCP）実装です。このパッケージは、MCP標準を使用してMemOS APIと対話するためのコマンドラインインターフェースを提供します。

🚀 クイックスタート

このパッケージを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：人ごとに安定した識別子です。決定論的で個人を特定できない情報である必要があり、同じ人についてはデバイスやセッションをまたいで同じ値である必要があります。異なる人に対して再利用しないでください。ランダムな値、デバイスID、モデル/チャットセッションIDは使用しないでください。推奨：SHA-256(lowercase(trim(email)))またはあなたのSSOサブジェクト/社員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：メッセージ送信者の役割です。例：user、assistant
       • 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スキーマ検証

📦 インストール

前提条件

• Node.js >= 18
• npmまたはpnpm（推奨）

インストール手順

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