Opik MCP Server

⚠️ Hinweis: Die Unterstützung für den SSE-Transport (Server-Sent Events) ist derzeit experimentell und ungetestet. Für den produktiven Einsatz empfehlen wir den in den IDE-Integrationsbeispielen gezeigten Ansatz zur direkten Prozessausführung.

🚀 Was ist der Opik MCP-Server?

Opik MCP Server ist eine Open-Source-Implementierung des Model Context Protocol für die Opik-Plattform. Er bietet eine einheitliche Schnittstelle für die Interaktion mit den Funktionen von Opik und unterstützt mehrere Transportmechanismen für die flexible Integration in verschiedene Umgebungen.

Sie können den Opik MCP Server für Folgendes verwenden:

• IDE-Integration:

  • Nahtlose Integration mit Cursor und anderen kompatiblen IDEs

  • Ermöglichen Sie direkten Zugriff auf die Funktionen von Opik aus Ihrer Entwicklungsumgebung

• Einheitlicher API-Zugriff:

  • Zugriff auf alle Opik-Funktionen über ein standardisiertes Protokoll

  • Nutzen Sie mehrere Transportoptionen (stdio, SSE) für verschiedene Integrationsszenarien

• Plattformverwaltung:

  • Verwalten Sie Eingabeaufforderungen, Projekte, Traces und Metriken über eine einheitliche Schnittstelle

  • Organisieren und überwachen Sie Ihre LLM-Anwendungen effizient

Related MCP server: OpenAI MCP Server

Merkmale

• Eingabeaufforderungsverwaltung : Erstellen, Auflisten, Aktualisieren und Löschen von Eingabeaufforderungen

• Projekt-/Arbeitsbereichsverwaltung : Projekte organisieren und verwalten

• Spuren : Verfolgen und analysieren Sie Spurendaten

• Metriken : Sammeln und Abfragen von Metrikdaten

Schnellstart

Installation

Manuelle 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

Konfiguration

Erstellen Sie eine .env Datei basierend auf dem Beispiel:

cp .env.example .env
# Edit .env with your specific configuration

Starten des Servers

# 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

Erstellen Sie zur Integration mit Cursor IDE eine .cursor/mcp.json Datei in Ihrem Projektverzeichnis mit der folgenden Konfiguration:

{
  "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",
      }
    }
  }
}

Ersetzen Sie /path/to/node durch den Pfad zu Ihrer Node.js-Programmdatei und /path/to/opik-mcp durch den Pfad zu Ihrer opik-mcp-Installation. Ersetzen Sie außerdem YOUR_API_KEY durch Ihren tatsächlichen Opik-API-Schlüssel.

Verfügbare Befehle

Das Projekt enthält ein Makefile für allgemeine Vorgänge:

# 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

Transportmöglichkeiten

Standard-Eingabe/Ausgabe

Ideal für die lokale Integration, bei der Client und Server auf derselben Maschine ausgeführt werden.

make start-stdio

Server-Sent Events (SSE)

Ermöglicht Fernzugriff und mehrere gleichzeitige Clients über HTTP. Beachten Sie, dass diese Transportoption experimentell ist.

make start-sse

Ausführliche Informationen zum SSE-Transport finden Sie unter docs/sse-transport.md .

Entwicklung

Testen

# Run all tests
npm test

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

Pre-Commit-Hooks

Dieses Projekt verwendet Pre-Commit-Hooks, um die Codequalität sicherzustellen:

# Run pre-commit checks manually
make precommit

Dokumentation

• SSE-Transport - Details zur Nutzung des SSE-Transports

• API-Referenz – Vollständige API-Dokumentation

• Konfiguration – Erweiterte Konfigurationsoptionen

• IDE-Integration – Integration mit Cursor IDE

Zitat

Wenn Sie dieses Projekt in Ihrer Forschung verwenden, zitieren Sie es bitte wie folgt:

Comet ML, Inc, Koc, V., & Boiko, Y. (2025). Opik MCP Server. Github. https://doi.org/10.5281/zenodo.15411156

Oder verwenden Sie den folgenden BibTeX-Eintrag:

@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}
}

Zitationsinformationen finden Sie auch in der Datei CITATION.cff in diesem Repository.

Lizenz

Apache 2.0