<img src="https://badge.mcpx.dev?status=on" title="启用MCP"/>
⚠️ 注意: SSE(服务器发送事件)传输支持目前是实验性的且未经测试。对于生产用途,我们建议使用在IDE集成示例中展示的直接进程执行方法。
Opik MCP服务器是Opik平台上的模型上下文协议的开源实现。它提供了与Opik功能交互的统一接口,支持多种传输机制,以灵活地集成到各种环境中。
<br>你可以使用Opik MCP服务器进行以下操作:
IDE集成:
统一API访问:
平台管理:
要与Cursor IDE集成,请打开Cursor设置页面并导航到功能标签页。向下滚动到MCP部分,你会看到一个“+ 添加新MCP服务器”的按钮,这将允许你添加Opik MCP服务器。
一旦“新MCP服务器”模态窗口打开,选择“命令”作为服务器类型,并输入命令:npx -y opik-mcp --apiKey YOUR_API_KEY。
或者,你可以在项目中创建一个.cursor/mcp.json文件,并添加:
{
"mcpServers": {
"opik": {
"command": "npx",
"args": [
"-y",
"opik-mcp",
"--apiKey",
"YOUR_API_KEY"
]
}
}
}
注意:如果你使用的是Opik的开源版本,你需要指定apiBaseUrl参数为http://localhost:5173/api。
要在Windsurf中安装MCP服务器,你需要打开Windsurf设置并导航到MCP部分。从那里点击“查看原始配置”,并更新配置对象为:
{
"mcpServers": {
"opik": {
"command": "npx",
"args": [
"-y",
"opik-mcp",
"--apiKey",
"YOUR_API_KEY"
]
}
}
}
注意:如果你使用的是Opik的开源版本,你需要指定apiBaseUrl参数为http://localhost:5173/api。
# 克隆仓库
git clone https://github.com/comet-ml/opik-mcp.git
cd opik-mcp
# 安装依赖并构建
npm install
npm run build
配置
基于示例创建一个.env文件:
cp .env.example .env
# 编辑.env文件以匹配你的特定配置
启动服务器
# 使用标准输入输出传输(默认)
npm run start:stdio
# 使用SSE传输以实现网络访问(实验性)
npm run start:sse
适用于客户端和服务器在同一台机器上运行的本地集成。
make start-stdio
启用远程访问和多个同时通过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 = {110.5281/zenodo.15411156}
}
你也可以在该仓库中的CITATION.cff文件中找到引用信息。
Apache 2.0