Opik MCP

🚀 Opik MCP サーバーとは？

Opik MCP サーバーは、Opik プラットフォームのモデルコンテキストプロトコル（Model Context Protocol, MCP）のオープンソース実装です。Opik の機能にアクセスするための統一インターフェースを提供し、複数のトランスポートメカニズムをサポートしており、ローカルおよびリモートの統合に適しています。

✨ 主な機能

• 多トランスポートサポート：標準入出力（stdio）とサーバー送信イベント（SSE）をサポート
• IDE 統合：Cursor などの IDE ツールとシームレスに統合可能
• 柔軟な設定：コマンドライン引数と環境変数による柔軟な設定
• 充実したドキュメント：詳細な API ドキュメントと技術説明を提供

🚀 クイックスタート

📦 インストール

# リポジトリをクローン
git clone /path/to/opik-mcp
cd opik-mcp

# npm ビルドを実行
npm install

設定

プロジェクトのルートディレクトリに .env ファイルを作成します。

OPIK_API_BASE_URL=https://www.comet.com/opik/api
OPIK_API_KEY=YOUR_API_KEY
OPIK_WORKSPACE_NAME=default

サーバーの起動

標準入出力モード（ローカル開発に推奨）

# npm スクリプトを実行してサービスを起動
npm start

サーバー送信イベントモード（リモートアクセスに適しています）

# 依存関係をインストール
npm install

# SSE トランスポートサーバーを起動
make start-sse

💻 使用例

IDE 統合

Cursor で Opik MCP を使用するには、プロジェクトのルートディレクトリに .cursor/mcp.json ファイルを作成します。

{
  "mcpServers": {
    "opik": {
      "command": "/usr/local/bin/node",
      "args": [
        "./build/index.js",
        "--apiUrl",
        "https://www.comet.com/opik/api",
        "--apiKey",
        "YOUR_API_KEY",
        "--workspace",
        "default",
        "--debug",
        "true"
      ],
      "env": {
        "OPIK_API_BASE_URL": "https://www.comet.com/opik/api",
        "OPIK_API_KEY": "YOUR_API_KEY",
        "OPIK_WORKSPACE_NAME": "default"
      }
    }
  }
}

利用可能なコマンド

プロジェクトでは Makefile スクリプトを使用して操作を簡素化しています。

# 利用可能なすべてのコマンドを表示
make help

# テストを実行
make test

# SSE モードのサービスを起動（実験的）
make start-sse

# stdio モードのサービスを起動
make start-stdio

トランスポートオプション

標準入出力（stdio）

ローカル環境で、サーバーとクライアントが同一のマシン上で動作する場合に適しています。

make start-stdio

サーバー送信イベント（SSE）

リモートアクセスと複数のクライアントの同時接続をサポートします。このトランスポート方式は現在実験段階です。

make start-sse

SSE トランスポートに関する詳細情報は、docs/sse-transport.md を参照してください。

🔧 技術詳細

テスト

# すべてのテストケースを実行
npm test

# 指定されたテストスイートを実行
npm test -- tests/transports/sse-transport.test.ts

コミット前フック

プロジェクトではコード品質を保証するために pre-commit フックを使用しています。

# コミット前チェックを手動で実行
make precommit

📚 ドキュメント

• SSE トランスポート - SSE トランスポート方式の詳細な説明
• API リファレンス - 完全な API ドキュメント
• 設定オプション - 高度な設定ガイド
• IDE 統合 - IDE 統合の詳細な解説

📄 ライセンス

このプロジェクトは Apache 2.0 ライセンスの下で公開されています。