Omi MCP サーバー

このプロジェクトは、Omi APIと連携するためのモデルコンテキストプロトコル（MCP）サーバーを提供します。このサーバーは、会話や思い出の読み取り、および新しい会話や思い出の作成のためのツールを提供します。

設定

1. リポジトリをクローンする

2. npm installで依存関係をインストールする

3. 次の変数を含む.envファイルを作成します。

   API_KEY=your_api_key
   APP_ID=your_app_id

Related MCP server: MCP Toolkit

使用法

Smithery経由でインストール

Smithery経由で Claude Desktop 用の Omi MCP Server を自動的にインストールするには:

npx -y @smithery/cli install @fourcolors/omi-mcp --client claude

サーバーの構築

npm run build

サーバーの実行

npm run start

開発モード

ホットリロードを使用した開発の場合:

npm run dev

サーバーのテスト

MCPサーバーとやり取りするためのシンプルなテストクライアントが含まれています。プロジェクトをビルドしたら、以下を実行してください。

npm run test

または直接:

./test-mcp-client.js

MCPサーバーが起動し、利用可能なツールをテストするための対話型メニューが表示されます。テストクライアントは、すべての操作にデフォルトのテストユーザーID（ test-user-123 ）を使用します。

クリーンアップと再構築

ビルド ディレクトリをクリーンアップして最初から再構築するには:

npm run rebuild

クロードとカーソルを使った構成

クロード・コンフィグレーション

この MCP サーバーを Anthropic Console または API 経由で Claude で使用するには:

1. MCP サーバーをローカルで起動します。

   npm run start

2. Claude 会話を設定するときは、MCP 接続を構成します。

   {
   	"mcp_config": {
   		"transports": [
   			{
   				"type": "stdio",
   				"executable": {
   					"path": "/path/to/your/omi-mcp-local/dist/index.js",
   					"args": []
   				}
   			}
   		]
   	}
   }

3. クロードへのプロンプトの例:

   Please fetch the latest 5 conversations for user "user123" using the Omi API.

4. Claude は MCP を使用してread_omi_conversationsツールを実行します。

   {
   	"id": "req-1",
   	"type": "request",
   	"method": "tools.read_omi_conversations",
   	"params": {
   		"user_id": "user123",
   		"limit": 5
   	}
   }

カーソルの設定

この MCP サーバーを Cursor で使用するには:

1. ターミナルで MCP サーバーを起動します。

   npm run start

2. カーソルで、「設定」>「拡張機能」>「MCPサーバー」に移動します。

3. 次の設定で新しい MCP サーバーを追加します。

   • 名前: Omi API

   • URL: stdio:/path/to/your/omi-mcp-local/dist/index.js

   • サーバーを有効にする

4. これで、カーソル内でOmiツールを直接使用できるようになりました。例:

   @Omi API Please fetch memories for user "user123" and summarize them.

5. カーソルは MCP サーバーと通信して、必要な API 呼び出しを実行します。

利用可能なツール

MCP サーバーは次のツールを提供します。

omi会話を読む

オプションのフィルターを使用して、特定のユーザーの Omi から会話を取得します。

パラメータ:

• user_id (文字列): 会話を取得するユーザーID

• limit （数値、オプション）：返される会話の最大数

• offset （数値、オプション）：ページ区切りでスキップする会話の数

• include_discarded (ブール値、オプション): 破棄された会話を含めるかどうか

• statuses （文字列、オプション）：会話をフィルタリングするためのステータスのコンマ区切りリスト

omi_memories を読む

特定のユーザーの Omi から思い出を取得します。

パラメータ:

• user_id (文字列): 思い出を取得するユーザーID

• limit (数値、オプション): 返されるメモリの最大数

• offset （数値、オプション）：ページ区切りでスキップするメモリの数

omi会話を作成する

特定のユーザー向けに Omi で新しい会話を作成します。

パラメータ:

• text （文字列）：会話の全文

• user_id (文字列): 会話を作成するユーザーID

• text_source (文字列): テキストコンテンツのソース (オプション: "audio_transcript", "message", "other_text")

• started_at (文字列、オプション): 会話/イベントが開始された時刻 (ISO 8601 形式)

• finished_at （文字列、オプション）：会話/イベントが終了した時刻（ISO 8601形式）

• language (文字列、オプション): 言語コード (デフォルト: "en")

• geolocation （オブジェクト、オプション）: 会話の位置データ

  • latitude （数値）：緯度座標

  • longitude （数値）：経度座標

• text_source_spec (文字列、オプション): ソースに関する追加の仕様

omi_memoriesを作成する

特定のユーザーのためにOmiに新しい思い出を作成します。

パラメータ:

• user_id (文字列): 思い出を作成するユーザーID

• text （文字列、オプション）：記憶を抽出するテキストコンテンツ

• memories （配列、オプション）：直接作成される明示的なメモリオブジェクトの配列

  • content （文字列）：メモリの内容

  • tags (文字列の配列、オプション): メモリのタグ

• text_source (文字列、オプション): テキストコンテンツのソース

• text_source_spec (文字列、オプション): ソースに関する追加の仕様

テスト

MCP サーバーをテストするには、提供されているテスト クライアントを使用できます。

node test-mcp-client.js

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

1. 会話を始める

2. 思い出を手に入れる

3. 会話を作成する

4. やめる

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

ログ記録

MCPサーバーには、コンソールとログファイルの両方にログを書き込む組み込みのログ機能が搭載されています。これは、サーバーのアクティビティのデバッグや監視に役立ちます。

ログファイルの場所

ログはプロジェクトディレクトリのlogs/mcp-server.logに書き込まれます。ログファイルには、タイムスタンプと以下の詳細情報が含まれます。

• サーバーの起動とシャットダウン

• すべてのAPIリクエストとレスポンス

• エラーメッセージとスタックトレース

• OmiへのAPI呼び出し

• リクエストパラメータと応答データ

ログの表示

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

tail -f logs/mcp-server.log

これにより、サーバーがリクエストを処理し、Omi API と対話するときにライブ更新が表示されます。

ログ形式

各ログエントリは次の形式に従います。

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

タイムスタンプは ISO 8601 形式であるため、イベントの相関関係の特定や問題のデバッグが容易になります。