Opik MCP Server

<h1 align="center" style="border-bottom: none">
    <div>
        <a href="https://www.comet.com/site/products/opik/?from=llm&utm_source=opik&utm_medium=github&utm_content=header_img&utm_campaign=opik-mcp">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="docs/assets/logo-dark-mode.svg">
                <source media="(prefers-color-scheme: light)" srcset="docs/assets/logo-light-mode.svg">
                <img alt="Comet Opik logo" src="docs/assets/logo-light-mode.svg" width="200" />
            </picture>
        </a>
        <br>
        Opik MCP 服务器
    </div>
    (模型上下文协议)
</h1>

<p align="center">
一个用于 <a href="https://github.com/comet-ml/opik/">Opik 平台</a>的模型上下文协议 (MCP) 实现，支持多种传输机制，能够与 IDE 无缝集成，并为 Opik 的各项功能提供统一的接口。
</p>

<div align="center">

[![License](https://img.shields.io/github/license/comet-ml/opik-mcp)](https://github.com/comet-ml/opik-mcp/blob/main/LICENSE)
[![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.11.0-brightgreen)](https://nodejs.org/)
[![TypeScript](https://img.shields.io/badge/typescript-%5E5.8.2-blue)](https://www.typescriptlang.org/)
<img src="https://badge.mcpx.dev?status=on" title="MCP Enabled"/>

</div>

<p align="center">
    <a href="https://www.comet.com/site/products/opik/?from=llm&utm_source=opik&utm_medium=github&utm_content=website_button&utm_campaign=opik"><b>网站</b></a> •
    <a href="https://chat.comet.com"><b>Slack 社区</b></a> •
    <a href="https://x.com/Cometml"><b>Twitter</b></a> •
    <a href="https://www.comet.com/docs/opik/?from=llm&utm_source=opik&utm_medium=github&utm_content=docs_button&utm_campaign=opik"><b>文档</b></a>
</p>

<p align="center">
    <a href="https://glama.ai/mcp/servers/@comet-ml/opik-mcp" rel="nofollow" target="_blank">
      <img width="380" height="200" src="https://glama.ai/mcp/servers/@comet-ml/opik-mcp/badge" alt="Opik Server MCP server" />
    </a>
</p>

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

## 🚀 什么是 Opik MCP 服务器？

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

<br>

您可以使用 Opik MCP 服务器来：
* **IDE 集成：**
  * 与 Cursor 和其他兼容的 IDE 无缝集成
  * 从您的开发环境直接访问 Opik 的各项功能

* **统一的 API 访问：**
  * 通过标准化的协议访问所有 Opik 功能
  * 利用多种传输选项（stdio、SSE）来适应不同的集成场景

* **平台管理：**
  * 通过一致的界面管理提示、项目、跟踪和指标
  * 高效地组织和监控您的 LLM 应用程序

## 功能特性

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

## 快速开始

### 安装

#### 手动安装
```bash
# 克隆仓库
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

文档

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

许可证

Apache 2.0