Opik Mcp Server (model Context Protocol)

What is Opik-MCP?

Opik-MCP is a Model Context Protocol (MCP) implementation designed for seamless integration with Integrated Development Environments (IDEs). It provides a unified access point for managing prompts, projects, traces, and metrics, enhancing the workflow for developers and data scientists. This tool is particularly useful for those who want to streamline their machine learning processes and improve collaboration across teams.

Features of Opik-MCP

• Seamless IDE Integration: Opik-MCP allows users to integrate their development environment effortlessly, making it easier to manage various aspects of machine learning projects.
• Unified Access: Users can access prompts, projects, traces, and metrics from a single interface, reducing the complexity of managing multiple tools.
• Enhanced Collaboration: The protocol facilitates better collaboration among team members by providing a shared platform for project management.
• Open Source: Being a public repository, Opik-MCP is open for contributions, allowing developers to enhance its features and functionalities.

How to Use Opik-MCP

1. Installation: Begin by cloning the Opik-MCP repository from GitHub. Use the command:

   git clone https://github.com/comet-ml/opik-mcp.git
   

2. Setup: Follow the setup instructions provided in the repository's README file to configure the environment according to your needs.
3. Integration: Integrate Opik-MCP with your preferred IDE. Detailed instructions can be found in the documentation section of the repository.
4. Usage: Start using the features of Opik-MCP to manage your machine learning projects effectively. Access prompts, projects, traces, and metrics through the unified interface.

Frequently Asked Questions

What programming languages does Opik-MCP support?

Opik-MCP is designed to be language-agnostic, allowing it to be used with various programming languages commonly used in machine learning, such as Python, R, and Java.

Is Opik-MCP free to use?

Yes, Opik-MCP is an open-source project released under the Apache-2.0 license, making it free to use and modify.

How can I contribute to Opik-MCP?

You can contribute by forking the repository, making your changes, and submitting a pull request. Contributions are welcome, and you can also report issues or suggest features.

Where can I find more information about Opik-MCP?

For more details, visit the official Opik-MCP page or check the documentation available in the GitHub repository.

<h1 align="center" style="border-bottom: none"> <div> <a href="https://www.comet.com/site/products/opik/?from=llm&utm_source=opik&utm_medium=github&utm_content=header_img&utm_campaign=opik-mcp"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/comet-ml/opik-mcp/refs/heads/main/docs/assets/logo-dark-mode.svg"> <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/comet-ml/opik-mcp/refs/heads/main/docs/assets/logo-light-mode.svg"> <img alt="Comet Opik logo" src="docs/assets/logo-light-mode.svg" width="200" /> </picture> </a> <br> Opik MCP Server </div> (Model Context Protocol)<br> </h1> <p align="center"> A Model Context Protocol (MCP) implementation for the <a href="https://github.com/comet-ml/opik/">Opik platform</a> with support for multiple transport mechanisms, enabling seamless integration with IDEs and providing a unified interface for Opik's capabilities. </p> <div align="center">

<img src="https://badge.mcpx.dev?status=on" title="MCP Enabled"/>

</div> <p align="center"> <a href="https://www.comet.com/site/products/opik/?from=llm&utm_source=opik&utm_medium=github&utm_content=website_button&utm_campaign=opik"><b>Website</b></a> • <a href="https://chat.comet.com"><b>Slack community</b></a> • <a href="https://x.com/Cometml"><b>Twitter</b></a> • <a href="https://www.comet.com/docs/opik/?from=llm&utm_source=opik&utm_medium=github&utm_content=docs_button&utm_campaign=opik"><b>Documentation</b></a> </p> <p align="center"> <a href="https://glama.ai/mcp/servers/@comet-ml/opik-mcp" rel="nofollow" target="_blank"> <img width="380" height="200" src="https://glama.ai/mcp/servers/@comet-ml/opik-mcp/badge" alt="Opik Server MCP server" /> </a> </p>

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

<br>

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