opik-mcp 0.0.1

package/LICENSE

@@ -0,0 +1,203 @@
+Copyright (c) Comet ML, Inc
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Comet ML, Inc
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,203 @@
+<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="docs/assets/logo-dark-mode.svg">
+                <source media="(prefers-color-scheme: light)" srcset="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">
+
+[![License](https://img.shields.io/github/license/comet-ml/opik-mcp)](https://github.com/comet-ml/opik-mcp/blob/main/LICENSE)
+[![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.11.0-brightgreen)](https://nodejs.org/)
+[![TypeScript](https://img.shields.io/badge/typescript-%5E5.8.2-blue)](https://www.typescriptlang.org/)
+<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>
+
+> **⚠️ 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
+```bash
+# 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:
+
+```bash
+cp .env.example .env
+# Edit .env with your specific configuration
+```
+
+### Starting the Server
+
+```bash
+# 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:
+
+```json
+{
+  "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:
+
+```bash
+# 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.
+
+```bash
+make start-stdio
+```
+
+### Server-Sent Events (SSE)
+
+Enables remote access and multiple simultaneous clients over HTTP. Note that this transport option is experimental.
+
+```bash
+make start-sse
+```
+
+For detailed information about the SSE transport, see [docs/sse-transport.md](docs/sse-transport.md).
+
+## Development
+
+### Testing
+
+```bash
+# 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:
+
+```bash
+# Run pre-commit checks manually
+make precommit
+```
+
+## Documentation
+
+- [SSE Transport](docs/sse-transport.md) - Details on using the SSE transport
+- [API Reference](docs/api-reference.md) - Complete API documentation
+- [Configuration](docs/configuration.md) - Advanced configuration options
+- [IDE Integration](docs/ide-integration.md) - Integration with Cursor IDE
+
+## License
+
+Apache 2.0

package/build/cli.js

@@ -0,0 +1,72 @@
+#!/usr/bin/env node
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
+import { SSEServerTransport } from './transports/sse-transport.js';
+import { startServerWithTransport } from './mcp-server.js';
+// Parse command line arguments
+const argv = yargs(hideBin(process.argv))
+    .scriptName('opik-mcp')
+    .usage('$0 [args]')
+    .command('serve', 'Start the MCP server', yargs => {
+    return yargs
+        .option('transport', {
+        alias: 't',
+        description: 'Transport to use (stdio or sse)',
+        type: 'string',
+        default: 'stdio',
+        choices: ['stdio', 'sse'],
+    })
+        .option('port', {
+        alias: 'p',
+        description: 'Port to listen on (for sse transport)',
+        type: 'number',
+        default: 3001,
+    });
+})
+    .demandCommand(1, 'You need to specify a command')
+    .help()
+    .alias('help', 'h')
+    .parseSync();
+/**
+ * Function to start the MCP server with the specified transport
+ */
+async function startServer() {
+    let transport;
+    // Create the appropriate transport based on command line argument
+    if (argv.transport === 'sse') {
+        console.log(`Starting MCP server with SSE transport on port ${argv.port}`);
+        transport = new SSEServerTransport({ port: argv.port });
+    }
+    else {
+        console.log('Starting MCP server with stdio transport');
+        transport = new StdioServerTransport();
+    }
+    try {
+        // Start the server with the configured transport
+        await startServerWithTransport(transport);
+        if (argv.transport === 'sse') {
+            console.log(`Server is now accessible at http://localhost:${argv.port}`);
+            console.log(`- Health check: http://localhost:${argv.port}/health`);
+            console.log(`- SSE events: http://localhost:${argv.port}/events`);
+            console.log(`- Send messages: POST to http://localhost:${argv.port}/send`);
+        }
+        // Keep the process alive
+        process.on('SIGINT', async () => {
+            console.log('Shutting down server...');
+            await transport.close();
+            process.exit(0);
+        });
+    }
+    catch (error) {
+        console.error(`Error starting server: ${error}`);
+        process.exit(1);
+    }
+}
+// Only start the server if we're running the serve command
+if (argv._[0] === 'serve') {
+    startServer().catch(error => {
+        console.error(`Fatal error: ${error}`);
+        process.exit(1);
+    });
+}