Omi MCP

🚀 Omi MCP サーバー

このプロジェクトは、Omi API とやり取りする Model Context Protocol (MCP) サーバーを提供します。このサーバーは、会話とメモリの読み取り、新しい会話とメモリの作成ツールを提供します。

🚀 クイックスタート

インストールが完了したら、以下のコマンドを実行します。

npm start

その後、http://localhost:3000 にアクセスして、提供されているテストクライアントを使用します。

✨ 主な機能

• このサーバーは、Omi API とのやり取りを可能にする Model Context Protocol (MCP) サーバーです。
• 会話とメモリの読み取り、新しい会話とメモリの作成ツールを提供します。

📦 インストール

依存関係

• Node.js (バージョン 14.17.0 以上)
• npm (バージョン 6.0.0 以上)

インストール手順

1. リポジトリをクローンします。

   git clone https://github.com/your-repository.git
   cd your-repository
   

2. 依存関係をインストールします。

   npm install
   

3. 以下の変数を含む .env ファイルを作成します。
   • OMI_API_KEY: Omi API のキー
   • PORT: サーバーが動作するポート（デフォルトは 3000）

📚 ドキュメント

設定ガイド

環境変数

.env ファイルを作成し、以下の内容を追加します。

OMI_API_KEY=your-api-key-here
PORT=3000

サーバー起動

以下のコマンドを実行してサーバーを起動します。

npm start

ツール説明

会話の取得

• リクエスト URL: GET /conversations
• クエリパラメータ:
  • userId: 必須、文字列型、ユーザー ID。
• レスポンス形式:

{
  "data": [
    {
      "id": string,
      "content": string,
      "source": string,
      "createdAt": string,
      "updatedAt": string
    }
  ],
  "message": string
}

メモリの取得

• リクエスト URL: GET /memories
• クエリパラメータ:
  • userId: 必須、文字列型、ユーザー ID。
• レスポンス形式:

{
  "data": [
    {
      "id": string,
      "content": string,
      "tags": [string],
      "source": string,
      "createdAt": string,
      "updatedAt": string
    }
  ],
  "message": string
}

会話の作成

• リクエストメソッド: POST /conversations
• リクエストボディパラメータ:

{
  "content": string,        // 会話内容
  "source": string,         // 内容のソース、選択肢: audio_transcript、message、other_text
  "startedAt": string,      // 開始時間（ISO 8601 形式）
  "finishedAt": string,     // 終了時間（ISO 8601 形式）
  "language": string,       // 言語コード、デフォルトは en
  "geolocation": {
    "latitude": number,     // 緯度座標
    "longitude": number     // 経度座標
  },
  "sourceSpec": string      // 内容のソースの追加説明
}

メモリの作成

• リクエストメソッド: POST /memories
• リクエストボディパラメータ:

{
  "text": string,          // テキスト内容（オプション）
  "memories": [
    {
      "content": string,    // 内容
      "tags": [string]     // タグ配列（オプション）
    }
  ],
  "source": string,         // 内容のソース（オプション）
  "sourceSpec": string      // 内容のソースの追加説明（オプション）
}

テスト

提供されているテストクライアントを使用してテストを行います。

node test-mcp-client.js

これにより、対話型のテストクライアントが起動し、以下の操作を実行できます。

1. 会話の取得
2. メモリの取得
3. 会話の作成
4. 終了

すべての操作は、デフォルトのテストユーザー ID (test-user-123) を使用します。

ログ記録

MCP サーバーには、デフォルトでコンソールとファイルにログを出力する組み込みのログ記録機能が含まれています。これは、サーバーのデバッグと監視に非常に役立ちます。

ログファイルの場所

ログは logs/mcp-server.log ファイルに書き込まれます。ログ内容には以下が含まれます。

• サーバーの起動と停止
• すべての API リクエストとレスポンス
• エラーメッセージとスタックトレース
• Omi API 呼び出し記録
• リクエストパラメータとレスポンスデータ

ログの表示

以下のコマンドを使用して、ログをリアルタイムで表示します。

tail -f logs/mcp-server.log

ログ形式

各ログ記録の形式は以下の通りです。

[2024-03-21T12:34:56.789Z] Log message here

タイムスタンプは ISO 8601 形式で、イベントの関連付けとデバッグに便利です。