Opik's MCP server

To integrate with Cursor IDE, open to the Cursor settings page and navigate
to the Features tab. If you scroll down to the MCP section you will see the
button `+ Add new MCP server` that will allow you to add the Opik MCP server.

Once the New MCP server modal is open, select command as the server type and
enter the command: `npx -y opik-mcp --apiKey YOUR_API_KEY`.

<Frame>
    
</Frame>

Once the MCP server is available, you can now test it out by asking Cursor:
`What is the latest trace available in Opik?`

<Tip>
If you are using a self-hosted version of Opik, you will need to specify
the argument `apiBaseUrl` while removing the `--apiKey` argument:
`npx -y opik-mcp --apiBaseUrl http://localhost:5173/api`
</Tip>

</Tab>
<Tab title="VS Code">

To integrate Opik with VS Code (GitHub Copilot), you need to add the MCP server
configuration to your workspace or user settings.

1. Create or open the `.vscode/mcp.json` file in your workspace (or run the
   **MCP: Open User Configuration** command to add it globally).

2. Add the Opik MCP server configuration:

```json wordWrap title=".vscode/mcp.json"
{
    "inputs": [
        {
            "type": "promptString",
            "id": "opik-api-key",
            "description": "Opik API Key",
            "password": true
        }
    ],
    "servers": {
        "opik-mcp": {
            "type": "stdio",
            "command": "npx",
            "args": [
                "-y",
                "opik-mcp",
                "--apiKey",
                "${input:opik-api-key}"
            ]
        }
    }
}
```

3. When you start the MCP server for the first time, VS Code will prompt you
   to enter your Opik API key. The value is securely stored for subsequent use.

<Tip>
If you are using a self-hosted version of Opik, add the `--apiBaseUrl` argument
and remove the `--apiKey` argument:

```json wordWrap title=".vscode/mcp.json"
{
    "servers": {
        "opik-mcp": {
            "type": "stdio",
            "command": "npx",
            "args": [
                "-y",
                "opik-mcp",
                "--apiBaseUrl",
                "http://localhost:5173/api"
            ]
        }
    },
    "inputs": []
}
```
</Tip>

Once the MCP server is available, you can test it by asking Copilot:
`What is the latest trace available in Opik?`

</Tab>
<Tab title="Windsurf">
To install the Opik MCP server, you will need to navigate to the Windsurf settings
page and in the MCP servers section, click on the `Add server` button. Here
you will need to click on the `Add custom server` button:

<Frame>
    
</Frame>

Once the `mcp_config.json` file is created, you can configure the Opik server
by adding the following (make sure to update the API key placeholder with your
key):

```json wordWrap title="mcp_config.json"
{
    "mcpServers": {
    "opik": {
        "command": "npx",
        "args": [
        "-y",
        "opik-mcp",
        "--apiKey",
        "YOUR_API_KEY"
        ]
    }
    }
}
```

<Tip>
If you are using a self-hosted version of Opik, you will need to specify
the argument `apiBaseUrl` as `http://localhost:5173/api` while removing the
`--apiKey` argument.
</Tip>

Once the MCP server is available, you not test it out by asking Windsurf:
`What is the latest trace available in Opik ?`

</Tab>
<Tab title="Manual">
You can manually run the Opik MCP server by running:

```bash
npx -y opik-mcp --transport sse --apiKey YOUR_API_KEY
```

You can then access the Opik MCP server through the `sse` endpoint.
</Tab>