Opik MCP

🚀 What is the Opik MCP Server?

The Opik MCP Server is an open - source implementation of the Model Context Protocol (MCP) for the Opik platform. It offers a unified interface to access Opik's features and supports multiple transport mechanisms, suitable for both local and remote integration.

✨ Features

• Multi - transport Support: Supports standard input/output (stdio) and Server - Sent Events (SSE).
• IDE Integration: Can be seamlessly integrated with IDE tools such as Cursor.
• Flexible Configuration: Achieves flexible configuration through command - line parameters and environment variables.
• Comprehensive Documentation: Provides detailed API documentation and technical explanations.

🚀 Quick Start

📦 Installation

# Clone the repository
git clone /path/to/opik-mcp
cd opik-mcp

# Run npm build
npm install

Configuration

Create a .env file in the project's root directory:

OPIK_API_BASE_URL=https://www.comet.com/opik/api
OPIK_API_KEY=YOUR_API_KEY
OPIK_WORKSPACE_NAME=default

Start the Server

Standard Input/Output Mode (Recommended for Local Development)

# Run the npm script to start the service
npm start

Server - Sent Events Mode (Suitable for Remote Access)

# Install dependencies
npm install

# Start the SSE transport server
make start-sse

💻 Usage Examples

IDE Integration

To use Opik MCP in Cursor, create a .cursor/mcp.json file in the project's root directory:

{
  "mcpServers": {
    "opik": {
      "command": "/usr/local/bin/node",
      "args": [
        "./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"
      }
    }
  }
}

Available Commands

The project provides Makefile scripts to simplify operations:

# View all available commands
make help

# Run tests
make test

# Start the service in SSE mode (experimental)
make start-sse

# Start the service in stdio mode
make start-stdio

Transport Options

Standard Input/Output (stdio)

Suitable for local environments where the server and client run on the same machine.

make start-stdio

Server - Sent Events (SSE)

Supports remote access and multiple clients connecting simultaneously. This transport method is currently in the experimental stage.

make start-sse

For more detailed information about the SSE transport, please refer to docs/sse-transport.md.

🔧 Technical Details

Development

Testing

# Run all test cases
npm test

# Run a specified test suite
npm test -- tests/transports/sse-transport.test.ts

Pre - commit Hooks

The project uses pre - commit hooks to ensure code quality:

# Manually run pre - commit checks
make precommit

📚 Documentation

• SSE Transport - Detailed explanation of the SSE transport method.
• API Reference - Complete API documentation.
• Configuration Options - Advanced configuration guide.
• IDE Integration - In - depth details of IDE integration.

📄 License

This project is open - sourced under the Apache 2.0 license.