opik-mcp 0.0.7 → 0.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +57 -57
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -65,6 +65,61 @@ You can use Opik MCP Server for:
|
|
|
65
65
|
|
|
66
66
|
### Installation
|
|
67
67
|
|
|
68
|
+
#### Cursor Integration
|
|
69
|
+
|
|
70
|
+
To integrate with Cursor IDE, open to the Cursor settings page and navigate
|
|
71
|
+
to the Features tab. If you scroll down to the MCP section you will see the
|
|
72
|
+
button `+ Add new MCP server` that will allow you to add the Opik MCP server.
|
|
73
|
+
|
|
74
|
+
Once the `New MCP server` modal is open, select `command` as the server type and
|
|
75
|
+
enter the command: `npx -y opik-mcp --apiKey YOUR_API_KEY`.
|
|
76
|
+
|
|
77
|
+
Alternatively, you can create a `.cursor/mcp.json` in your project and add:
|
|
78
|
+
|
|
79
|
+
```json
|
|
80
|
+
{
|
|
81
|
+
"mcpServers": {
|
|
82
|
+
"opik": {
|
|
83
|
+
"command": "npx",
|
|
84
|
+
"args": [
|
|
85
|
+
"-y",
|
|
86
|
+
"opik-mcp",
|
|
87
|
+
"--apiKey",
|
|
88
|
+
"YOUR_API_KEY"
|
|
89
|
+
]
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
Note: If you are using the Open-Source version of Opik, you will need to specify
|
|
96
|
+
the `apiBaseUrl` parameter as `http://localhost:5173/api`.
|
|
97
|
+
|
|
98
|
+
#### Windsurf Installation
|
|
99
|
+
|
|
100
|
+
To install the MCP server in Windsurf, you will need to open the Windsurf settings
|
|
101
|
+
and navigate to the MCP section. From there, click on `View raw config` and update
|
|
102
|
+
the configuration object to be:
|
|
103
|
+
|
|
104
|
+
```json
|
|
105
|
+
{
|
|
106
|
+
"mcpServers": {
|
|
107
|
+
"opik": {
|
|
108
|
+
"command": "npx",
|
|
109
|
+
"args": [
|
|
110
|
+
"-y",
|
|
111
|
+
"opik-mcp",
|
|
112
|
+
"--apiKey",
|
|
113
|
+
"YOUR_API_KEY"
|
|
114
|
+
]
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
Note: If you are using the Open-Source version of Opik, you will need to specify
|
|
121
|
+
the `apiBaseUrl` parameter as `http://localhost:5173/api`.
|
|
122
|
+
|
|
68
123
|
#### Manual Installation
|
|
69
124
|
```bash
|
|
70
125
|
# Clone the repository
|
|
@@ -76,7 +131,7 @@ npm install
|
|
|
76
131
|
npm run build
|
|
77
132
|
```
|
|
78
133
|
|
|
79
|
-
|
|
134
|
+
**Configuration**
|
|
80
135
|
|
|
81
136
|
Create a `.env` file based on the example:
|
|
82
137
|
|
|
@@ -85,7 +140,7 @@ cp .env.example .env
|
|
|
85
140
|
# Edit .env with your specific configuration
|
|
86
141
|
```
|
|
87
142
|
|
|
88
|
-
|
|
143
|
+
**Starting the Server**
|
|
89
144
|
|
|
90
145
|
```bash
|
|
91
146
|
# Start with stdio transport (default)
|
|
@@ -95,61 +150,6 @@ npm run start:stdio
|
|
|
95
150
|
npm run start:sse
|
|
96
151
|
```
|
|
97
152
|
|
|
98
|
-
## IDE Integration
|
|
99
|
-
|
|
100
|
-
### Cursor Integration
|
|
101
|
-
|
|
102
|
-
To integrate with Cursor IDE, create a `.cursor/mcp.json` file in your project directory with the following configuration:
|
|
103
|
-
|
|
104
|
-
```json
|
|
105
|
-
{
|
|
106
|
-
"mcpServers": {
|
|
107
|
-
"opik": {
|
|
108
|
-
"command": "/path/to/node",
|
|
109
|
-
"args": [
|
|
110
|
-
"/path/to/opik-mcp/build/index.js",
|
|
111
|
-
"--apiUrl",
|
|
112
|
-
"https://www.comet.com/opik/api",
|
|
113
|
-
"--apiKey",
|
|
114
|
-
"YOUR_API_KEY",
|
|
115
|
-
"--workspace",
|
|
116
|
-
"default",
|
|
117
|
-
"--debug",
|
|
118
|
-
"true"
|
|
119
|
-
],
|
|
120
|
-
"env": {
|
|
121
|
-
"OPIK_API_BASE_URL": "https://www.comet.com/opik/api",
|
|
122
|
-
"OPIK_API_KEY": "YOUR_API_KEY",
|
|
123
|
-
"OPIK_WORKSPACE_NAME": "default",
|
|
124
|
-
}
|
|
125
|
-
}
|
|
126
|
-
}
|
|
127
|
-
}
|
|
128
|
-
```
|
|
129
|
-
|
|
130
|
-
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.
|
|
131
|
-
|
|
132
|
-
## Available Commands
|
|
133
|
-
|
|
134
|
-
The project includes a Makefile for common operations:
|
|
135
|
-
|
|
136
|
-
```bash
|
|
137
|
-
# Display all available commands
|
|
138
|
-
make help
|
|
139
|
-
|
|
140
|
-
# Run tests
|
|
141
|
-
make test
|
|
142
|
-
|
|
143
|
-
# Run transport-specific tests
|
|
144
|
-
make test-transport
|
|
145
|
-
|
|
146
|
-
# Start the server with SSE transport (experimental)
|
|
147
|
-
make start-sse
|
|
148
|
-
|
|
149
|
-
# Start the server with stdio transport
|
|
150
|
-
make start-stdio
|
|
151
|
-
```
|
|
152
|
-
|
|
153
153
|
## Transport Options
|
|
154
154
|
|
|
155
155
|
### Standard Input/Output
|