Opik模型上下文协议

⚠️ 注意： SSE（服务器发送事件）传输支持目前仍处于实验阶段且未经测试。对于生产环境使用，我们建议采用在IDE集成示例中展示的直接进程执行方法。

🚀 什么是 Opik MCP 服务器？

Opik MCP 服务器是为Opik平台实现的一个开源模型上下文协议。它提供了一个统一的接口来与Opik的功能进行交互，支持多种传输机制以灵活地集成到各种环境中。

您可以使用Opik MCP服务器进行：

• IDE 集成：

  • 无缝集成到Cursor和其他兼容的IDE中
  • 直接从开发环境中访问Opik的功能

• 统一API访问：

  • 通过标准化协议访问所有Opik功能
  • 利用多种传输选项（如标准输入输出、SSE）适应不同的集成场景

• 平台管理：

  • 通过一致的界面管理提示、项目、跟踪和度量
  • 高效组织和监控您的LLM应用程序

功能

• 提示管理：创建、列出、更新和删除提示
• 项目/工作区管理：组织和管理项目
• 跟踪：跟踪和分析跟踪数据
• 指标：收集和查询指标数据

快速开始

安装

手动安装

# Clone the repository
git clone https://github.com/comet-ml/opik-mcp.git
cd opik-mcp

# Install dependencies and build
npm install
npm run build

配置

根据示例创建一个 .env 文件：

cp .env.example .env
# Edit .env with your specific configuration

启动服务器

# Start with stdio transport (default)
npm run start:stdio

# Start with SSE transport for network access (experimental)
npm run start:sse

IDE 集成

Cursor 集成

要与 Cursor IDE 集成，在您的项目目录中创建一个 .cursor/mcp.json 文件，并使用以下配置：

{
  "mcpServers": {
    "opik": {
      "command": "/path/to/node",
      "args": [
        "/path/to/opik-mcp/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",
      }
    }
  }
}

将 /path/to/node 替换为您的 Node.js 可执行文件的路径，将 /path/to/opik-mcp 替换为您的 opik-mcp 安装路径。同时将 YOUR_API_KEY 替换为您的实际 Opik API 密钥。

可用命令

该项目包含一个用于常见操作的 Makefile：

# Display all available commands
make help

# Run tests
make test

# Run transport-specific tests
make test-transport

# Start the server with SSE transport (experimental)
make start-sse

# Start the server with stdio transport
make start-stdio

传输选项

标准输入/输出

适用于客户端和服务器在同一台机器上运行的本地集成。

make start-stdio

服务器发送事件 (SSE)

通过 HTTP 实现远程访问和支持多个同时连接的客户端。请注意，此传输选项是实验性的。

make start-sse

有关 SSE 传输的详细信息，请参阅 docs/sse-transport.md。

开发

测试

# Run all tests
npm test

# Run specific test suite
npm test -- tests/transports/sse-transport.test.ts

提交前钩子

该项目使用提交前钩子来确保代码质量：

# Run pre-commit checks manually
make precommit

文档

• SSE 传输 - 使用 SSE 传输的详细信息
• API 参考 - 完整的 API 文档
• 配置 - 高级配置选项
• IDE 集成 - 与 Cursor IDE 的集成

许可证

Apache 2.0