Opik MCP Server
(Model Context Protocol)

A Model Context Protocol (MCP) implementation for the Opik platform with support for multiple transport mechanisms, enabling seamless integration with IDEs and providing a unified interface for Opik's capabilities.

[![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/)

Website • Slack community • Twitter • Documentation

> **⚠️ Notice:** SSE (Server-Sent Events) transport support is currently experimental and untested. For production use, we recommend using the direct process execution approach shown in the IDE integration examples. ## 🚀 What is Opik MCP Server? Opik MCP Server is an open-source implementation of the Model Context Protocol for the Opik platform. It provides a unified interface for interacting with Opik's capabilities, supporting multiple transport mechanisms for flexible integration into various environments.
You can use Opik MCP Server for: * **IDE Integration:** * Seamlessly integrate with Cursor and other compatible IDEs * Provide direct access to Opik's capabilities from your development environment * **Unified API Access:** * Access all Opik features through a standardized protocol * Leverage multiple transport options (stdio, SSE) for different integration scenarios * **Platform Management:** * Manage prompts, projects, traces, and metrics through a consistent interface * Organize and monitor your LLM applications efficiently ## Features - **Prompts Management**: Create, list, update, and delete prompts - **Projects/Workspaces Management**: Organize and manage projects - **Traces**: Track and analyze trace data - **Metrics**: Gather and query metrics data ## Quick Start ### Installation #### Manual Installation ```bash # 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 ``` ### Configuration Create a `.env` file based on the example: ```bash cp .env.example .env # Edit .env with your specific configuration ``` ### Starting the Server ```bash # Start with stdio transport (default) npm run start:stdio # Start with SSE transport for network access (experimental) npm run start:sse ``` ## IDE Integration ### Cursor Integration To integrate with Cursor IDE, create a `.cursor/mcp.json` file in your project directory with the following configuration: ```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", } } } } ``` Replace `/path/to/node` with the path to your Node.js executable and `/path/to/opik-mcp` with the path to your opik-mcp installation. Also replace `YOUR_API_KEY` with your actual Opik API key. ## Available Commands The project includes a Makefile for common operations: ```bash # 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 ``` ## Transport Options ### Standard Input/Output Ideal for local integration where the client and server run on the same machine. ```bash make start-stdio ``` ### Server-Sent Events (SSE) Enables remote access and multiple simultaneous clients over HTTP. Note that this transport option is experimental. ```bash make start-sse ``` For detailed information about the SSE transport, see [docs/sse-transport.md](docs/sse-transport.md). ## Development ### Testing ```bash # Run all tests npm test # Run specific test suite npm test -- tests/transports/sse-transport.test.ts ``` ### Pre-commit Hooks This project uses pre-commit hooks to ensure code quality: ```bash # Run pre-commit checks manually make precommit ``` ## Documentation - [SSE Transport](docs/sse-transport.md) - Details on using the SSE transport - [API Reference](docs/api-reference.md) - Complete API documentation - [Configuration](docs/configuration.md) - Advanced configuration options - [IDE Integration](docs/ide-integration.md) - Integration with Cursor IDE ## License Apache 2.0

Opik MCP Server (Model Context Protocol)

Opik MCP Server
(Model Context Protocol)