Comet Opik

⚠️ 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, VS Code, Windsurf 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

Cursor Integration

To integrate with Cursor IDE, open to the Cursor settings page and navigate to the Features tab. If you scroll down to the MCP section you will see the button + Add new MCP server that will allow you to add the Opik MCP server.

Once the New MCP server modal is open, select command as the server type and enter the command: npx -y opik-mcp --apiKey YOUR_API_KEY.

Alternatively, you can create a .cursor/mcp.json in your project and add:

{
  "mcpServers": {
    "opik": {
      "command": "npx",
      "args": [
        "-y",
        "opik-mcp",
        "--apiKey",
        "YOUR_API_KEY"
      ]
    }
  }
}

Note: If you are using the Open-Source version of Opik, you will need to specify the apiBaseUrl parameter as http://localhost:5173/api.

VS Code Integration (GitHub Copilot)

To integrate Opik with VS Code (GitHub Copilot), you need to add the MCP server configuration to your workspace or user settings.

1. Create or open the .vscode/mcp.json file in your workspace (or run the MCP: Open User Configuration command to add it globally).

2. Add the Opik MCP server configuration:

{
    "inputs": [
        {
            "type": "promptString",
            "id": "opik-api-key",
            "description": "Opik API Key",
            "password": true
        }
    ],
    "servers": {
        "opik-mcp": {
            "type": "stdio",
            "command": "npx",
            "args": [
                "-y",
                "opik-mcp",
                "--apiKey",
                "${input:opik-api-key}"
            ]
        }
    }
}

3. When you start the MCP server for the first time, VS Code will prompt you to enter your Opik API key. The value is securely stored for subsequent use.

Note: If you are using the Open-Source version of Opik, add the --apiBaseUrl argument and remove the --apiKey argument:

{
    "servers": {
        "opik-mcp": {
            "type": "stdio",
            "command": "npx",
            "args": [
                "-y",
                "opik-mcp",
                "--apiBaseUrl",
                "http://localhost:5173/api"
            ]
        }
    },
    "inputs": []
}

Windsurf Installation

To install the MCP server in Windsurf, you will need to open the Windsurf settings and navigate to the MCP section. From there, click on View raw config and update the configuration object to be:

{
    "mcpServers": {
      "opik": {
        "command": "npx",
        "args": [
          "-y",
          "opik-mcp",
          "--apiKey",
          "YOUR_API_KEY"
        ]
      }
    }
  }

Note: If you are using the Open-Source version of Opik, you will need to specify the apiBaseUrl parameter as http://localhost:5173/api.

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

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