Лицензия Версия Node.js Машинопись ДОИ

⚠️ Примечание: поддержка транспорта SSE (Server-Sent Events) в настоящее время экспериментальная и непроверенная. Для производственного использования мы рекомендуем использовать подход прямого выполнения процесса, показанный в примерах интеграции IDE.

🚀 Что такое Opik MCP Server?

Opik MCP Server — это реализация Model Context Protocol с открытым исходным кодом для платформы Opik. Он предоставляет унифицированный интерфейс для взаимодействия с возможностями Opik, поддерживая несколько транспортных механизмов для гибкой интеграции в различные среды.

Вы можете использовать Opik MCP Server для:

Интеграция с IDE:
- Простая интеграция с Cursor и другими совместимыми IDE
- Предоставьте прямой доступ к возможностям Opik из вашей среды разработки
Унифицированный API-доступ:
- Доступ ко всем функциям Opik через стандартизированный протокол
- Используйте несколько вариантов транспорта (stdio, SSE) для различных сценариев интеграции
Управление платформой:
- Управляйте подсказками, проектами, трассировками и метриками через единый интерфейс
- Эффективно организуйте и отслеживайте ваши заявки на получение степени LLM

Related MCP server: OpenAI MCP Server

Функции

Управление подсказками : создание, перечисление, обновление и удаление подсказок.
Управление проектами/рабочими пространствами : организация и управление проектами
Трассировки : отслеживание и анализ данных трассировки
Метрики : сбор и запрос данных метрик

Быстрый старт

Установка

Ручная установка

# 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 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 на ваш фактический ключ API Opik.

Доступные команды

Проект включает 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

Предварительные фиксации Хуков

В этом проекте используются хуки pre-commit для обеспечения качества кода:

# Run pre-commit checks manually
make precommit

Документация

Транспорт SSE - Подробности использования транспорта SSE
Справочник API — Полная документация API
Конфигурация — Расширенные параметры конфигурации
Интеграция с IDE — Интеграция с Cursor IDE

Цитата

Если вы используете этот проект в своих исследованиях, пожалуйста, укажите ссылку на него следующим образом:

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 в этом репозитории.