使用说明

项目简介

Opik MCP Server 是一个开源项目，实现了 Model Context Protocol (MCP) 协议，专为 Opik 平台设计。它充当 LLM 应用的后端，提供标准化的接口，使得 LLM 客户端能够便捷地访问 Opik 平台的各项功能，例如 Prompt 管理、项目管理、Trace 追踪和 Metrics 指标监控等。该服务器支持多种传输协议，方便集成到不同的开发环境，特别是 IDE。

主要功能点

Prompt 管理: 支持创建、列出、更新和删除 Prompt 模板，方便用户管理和维护用于 LLM 交互的 Prompt。
项目/工作区管理: 提供项目和工作区的组织管理功能，帮助用户有效管理 LLM 应用的资源。
Trace 追踪: 能够追踪和分析 LLM 应用的 Trace 数据，用于性能监控和问题诊断。
Metrics 指标: 收集和查询 LLM 应用的 Metrics 指标数据，支持性能评估和优化。
多种传输协议: 支持 Stdio 和 SSE (实验性) 等多种传输协议，适应不同的部署和集成场景。
IDE 集成: 特别为 IDE 环境设计，例如 Cursor，方便开发者在熟悉的 IDE 中直接使用 Opik 的功能。

安装步骤

克隆仓库

git clone https://github.com/comet-ml/opik-mcp.git
cd opik-mcp

安装依赖并构建

npm install
npm run build

配置环境变量

复制 '.env.example' 文件并重命名为 '.env'，然后根据需要编辑 '.env' 文件，配置 Opik API 相关的密钥和 URL。
```
cp .env.example .env
# 编辑 .env 文件
```

MCP 客户端配置

以 Cursor IDE 集成为例，需要在项目目录的 '.cursor/mcp.json' 文件中添加 MCP 服务器的配置信息。以下是一个示例配置，请根据实际情况修改路径和 API 密钥：

{
  "mcpServers": {
    "opik": {
      "command": "/path/to/node",  // Node.js 可执行文件的路径
      "args": [
        "/path/to/opik-mcp/build/index.js", // opik-mcp 服务器入口文件路径
        "--apiUrl",  // Opik API 基地址参数
        "https://www.comet.com/opik/api", // 替换为您的 Opik API 地址
        "--apiKey",  // Opik API 密钥参数
        "YOUR_API_KEY", // 替换为您的 Opik API 密钥
        "--workspace", // Opik 工作区名称参数
        "default", // 替换为您的 Opik 工作区名称
        "--debug", // 开启 debug 模式参数
        "true"
      ],
      "env": {
        "OPIK_API_BASE_URL": "https://www.comet.com/opik/api", // 环境变量：Opik API 基地址
        "OPIK_API_KEY": "YOUR_API_KEY", // 环境变量：Opik API 密钥
        "OPIK_WORKSPACE_NAME": "default" // 环境变量：Opik 工作区名称
      }
    }
  }
}

基本使用方法

启动服务器

使用以下命令启动 Opik MCP Server，可以选择 Stdio 或 SSE 传输方式：
- 使用 Stdio 传输 (默认，适用于本地集成)
```
npm run start:stdio
```
- 使用 SSE 传输 (实验性，支持网络访问)
```
npm run start:sse
```
客户端连接

配置好 MCP 客户端后（例如 Cursor IDE），客户端会自动连接到 Opik MCP Server。之后，您就可以在客户端中通过 MCP 协议调用 Opik MCP Server 提供的各项功能，例如列出 Prompt、查看 Trace 数据等。

关键词

使用说明

信息