Opik MCP Server
(模型上下文协议)
Opik MCP Server
一个支持多种传输机制的模型上下文协议（MCP）实现，用于 Opik 平台，能够与 IDE 无缝集成，并提供 Opik 功能的统一接口。
⚠️ 注意： SSE（服务器发送事件）传输支持目前处于实验阶段且未经测试。对于生产环境，我们建议使用 IDE 集成示例中显示的直接进程执行方法。
🚀 什么是 Opik MCP Server？
Opik MCP Server 是 Opik 平台的模型上下文协议（MCP）的开源实现。它提供了一个统一的接口来与 Opik 的功能交互，支持多种传输机制，以便灵活地集成到各种环境中。
您可以使用 Opik MCP Server 来：
-
IDE 集成：
- 与 Cursor 和其他兼容的 IDE 无缝集成
- 从您的开发环境直接访问 Opik 的功能
-
统一 API 访问：
- 通过标准协议访问所有 Opik 功能
- 利用多种传输选项（stdio、SSE）适应不同的集成场景
-
平台管理：
- 通过一致的接口管理提示、项目、跟踪和指标
- 高效地组织和监控您的 LLM 应用
功能
- 提示管理：创建、列出、更新和删除提示
- 项目/工作区管理：组织和管理工作区
- 跟踪：跟踪和分析跟踪数据
- 指标：收集和查询指标数据
快速入门
安装
手动安装
# 克隆仓库
git clone https://github.com/comet-ml/opik-mcp.git
cd opik-mcp
# 安装依赖并构建
npm install
npm run build
配置
基于示例创建 .env 文件：
cp .env.example .env
# 使用您的具体配置编辑 .env
启动服务器
# 使用 stdio 传输启动（默认）
npm run start:stdio
# 使用 SSE 传输启动以进行网络访问（实验性）
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：
# 显示所有可用命令
make help
# 运行测试
make test
# 运行特定传输的测试
make test-transport
# 使用 SSE 传输启动服务器（实验性）
make start-sse
# 使用 stdio 传输启动服务器
make start-stdio
传输选项
标准输入/输出
适用于本地集成，客户端和服务器在同一台机器上运行。
make start-stdio
服务器发送事件（SSE）
启用远程访问和 HTTP 上的多个同时客户端。请注意，此传输选项处于实验阶段。
make start-sse
有关 SSE 传输的详细信息，请参阅 docs/sse-transport.md。
开发
测试
# 运行所有测试
npm test
# 运行特定测试套件
npm test -- tests/transports/sse-transport.test.ts
提交前钩子
该项目使用提交前钩子来确保代码质量：
# 手动运行提交前检查
make precommit
文档
引用
如果您在研究中使用此项目，请按以下方式引用：
Comet ML, Inc, Koc, V., & Boiko, Y. (2025). Opik MCP Server. Github. https://doi.org/10.5281/zenodo.15411156
或者使用以下 BibTeX 条目：
@software{CometML_Opik_MCP_Server_2025,
author = {{Comet ML, Inc} and Koc, V. and Boiko, Y.},
title = {{Opik MCP Server}},
year = {2025},
publisher = {Github},
url = {https://doi.org/10.5281/zenodo.15411156},
doi = {10.5281/zenodo.15411156}
}
您也可以在存储库中的 CITATION.cff 文件中找到引用信息。
许可证
Apache 2.0