Opik MCP Server

Official

hybrid server

The server is able to function both locally and remotely, depending on the configuration or use case.

Integrations

  • Used for configuration through environment variables in a .env file

  • Hosts the repository and provides licensing information

  • Provides a Makefile for common operations like testing and starting the server

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

License

Apache 2.0

-
security - not tested
A
license - permissive license
-
quality - not tested

An implementation of the Model Context Protocol for the Opik platform that provides a unified interface for accessing Opik's capabilities, supporting multiple transport mechanisms for flexible integration with IDEs and other environments.

  1. Features
    1. Quick Start
      1. Installation
        1. Manual Installation
        2. Configuration
          1. Starting the Server
          2. IDE Integration
            1. Cursor Integration
            2. Available Commands
              1. Transport Options
                1. Standard Input/Output
                  1. Server-Sent Events (SSE)
                  2. Development
                    1. Testing
                      1. Pre-commit Hooks
                      2. Documentation
                        1. License