Opik MCP

🚀 Opik MCP 服務器

Opik MCP 服務器是 Opik 平臺的模型上下文協議（Model Context Protocol, MCP）的開源實現。它提供了一個統一的接口來訪問 Opik 的功能，支持多種傳輸機制，適用於本地和遠程集成，為用戶提供了便捷、高效的使用體驗。

🚀 快速開始

📦 安裝

# 克隆倉庫
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

✨ 主要特性

• 多傳輸支持：支持標準輸入輸出（stdio）和服務器發送事件（SSE）。
• IDE 集成：可與 Cursor 等 IDE 工具無縫集成。
• 靈活配置：通過命令行參數和環境變量實現靈活配置。
• 文檔完善：提供詳細的 API 文檔和技術說明。

💻 使用示例

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 協議開源。