Opik MCP Server

Opik MCP Server

What is Opik MCP Server about? Enables developers to interact with Opik’s prompt, project, trace, and metric management capabilities through a standardized protocol, supporting both local stdio communication and experimental Server‑Sent Events (SSE) for remote access.

How to use Opik MCP Server?

1. Clone the repository and install dependencies.

   git clone https://github.com/comet-ml/opik-mcp.git
   cd opik-mcp
   npm install
   npm run build
   

2. Configure environment variables in a .env file (copy from .env.example).
3. Start the server:
   • Local stdio (default): npm run start:stdio
   • Experimental SSE: npm run start:sse
4. Integrate with an IDE (e.g., Cursor) by creating a .cursor/mcp.json that points to the running server using the stdio command.

Key features of Opik MCP Server

• Prompt management: create, list, update, delete.
• Project/workspace organization.
• Trace tracking and analysis.
• Metric collection and querying.
• Multiple transport mechanisms (stdio, SSE).
• Ready‑made integration instructions for popular IDEs.

Use cases of Opik MCP Server

• Developers building LLM applications who need a unified API to log prompts, runs, and results.
• IDE extensions that want real‑time access to Opik’s observability features without custom networking code.
• Teams requiring a consistent interface for both local development (stdio) and remote collaboration (SSE).

FAQ from the Opik MCP Server

• Is SSE production‑ready? No, it is currently experimental and untested for production workloads.
• Do I need an API key? Yes, the server requires OPIK_API_KEY to authenticate against the Opik backend.
• Can I run multiple clients simultaneously? With the SSE transport you can, but only after confirming stability in your environment.
• What Node.js version is required? Node ≥ 20.11.0.
• How do I contribute? Fork the repo, run tests via npm test, and submit a pull request.

⚠️ 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

# 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:

cp .env.example .env
# Edit .env with your specific configuration

Starting the Server

# 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:

{
  "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:

# 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.

make start-stdio

Server-Sent Events (SSE)

Enables remote access and multiple simultaneous clients over HTTP. Note that this transport option is experimental.

make start-sse

For detailed information about the SSE transport, see docs/sse-transport.md.

Development

Testing

# 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:

# Run pre-commit checks manually
make precommit

Documentation

• SSE Transport - Details on using the SSE transport
• API Reference - Complete API documentation
• Configuration - Advanced configuration options
• IDE Integration - Integration with Cursor IDE

Citation

If you use this project in your research, please cite it as follows:

Comet ML, Inc, Koc, V., & Boiko, Y. (2025). Opik MCP Server. Github. https://doi.org/10.5281/zenodo.15411156

Or use the following BibTeX entry:

@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}
}

You can also find citation information in the CITATION.cff file in this repository.

License

Apache 2.0