what is Comet Opik?

Comet Opik is an open-source engine that allows users to query and analyze their Opik logs, traces, prompts, and other LLM telemetry in natural language through an implementation of the Model Context Protocol (MCP). It provides a unified interface for interacting with Opik's capabilities and supports multiple transport mechanisms for integration with various environments, including IDEs.

How to use Comet Opik?

To use Comet Opik:

1. Clone the repository (git clone https://github.com/comet-ml/opik-mcp.git).
2. Install dependencies and build the project (npm install && npm run build).
3. Configure the server by creating a .env file.
4. Start the server with either stdio (npm run start:stdio) or SSE transport (npm run start:sse, experimental).
5. Integrate with IDEs like Cursor by setting up a .cursor/mcp.json file.

Key features of Comet Opik?

• Prompts Management: Create, list, update, and delete prompts.
• Projects/Workspaces Management: Organize and manage projects/workspaces.
• Traces: Track and analyze LLM execution traces.
• Metrics: Query and analyze metrics data.
• Transport Options: Supports stdio (local) and SSE (experimental, network-based).
• IDE Integration: Seamlessly works with Cursor and compatible IDEs.

Use cases of Comet Opik?

1. Debugging LLM Applications: Analyze traces and metrics to identify issues.
2. Workflow Automation: Integrate prompts and projects into development environments.
3. Multi-Client Environments: Use SSE transport for remote/parallel interactions.
4. Research & Prototyping: Experiment with LLM telemetry via natural language queries.

FAQ from Comet Opik?

• Q: What is the MCP protocol?

  A: The Model Context Protocol (MCP) standardizes communication between LLM tools and clients (e.g., IDEs).

• Q: Is the SSE transport stable for production?

  A: No, SSE is experimental. Use stdio for production deployments.

• Q: How do I integrate with Cursor IDE?

  A: Configure .cursor/mcp.json with the server path and your Opik API key.

• Q: Where can I find documentation?

  A: See the official docs for guides on API reference, transports, and IDE setup.

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.

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

# 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