From 21cbbba9998e7de0cb37da6c9ef55edc23a852e2 Mon Sep 17 00:00:00 2001 From: TharunYettiK Date: Fri, 17 Jul 2026 10:49:32 +0530 Subject: [PATCH 1/2] docs: document self-hosted MCP server configuration --- packages/docs/mcp-server.mdx | 53 ++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/packages/docs/mcp-server.mdx b/packages/docs/mcp-server.mdx index 507b101f99..d8db53b8db 100644 --- a/packages/docs/mcp-server.mdx +++ b/packages/docs/mcp-server.mdx @@ -56,6 +56,12 @@ The `npx -y @trycompai/mcp-server` command you'll see throughout is what handles No JSON editing required. + +The drag-and-drop installer is configured for the hosted Comp AI service. + +If you're using a self-hosted deployment, use the manual JSON configuration and include the `--server-url` argument. + + If you prefer to manage `claude_desktop_config.json` yourself, open **Settings → Developer → Edit Config** and merge: @@ -89,6 +95,12 @@ Fully quit and reopen Claude Desktop. Click the button above, confirm in Cursor, then paste your Comp AI API key when prompted. + +The one-click installer is configured for the hosted Comp AI service. + +If you're using a self-hosted deployment, use the Advanced — manual JSON config below and include the `--server-url` argument. + + Open **Cursor → Settings → Tools and Integrations → New MCP Server** and paste: @@ -118,6 +130,12 @@ Save and reload Cursor. Click the button above, confirm in VS Code, then paste your Comp AI API key when prompted. + +The one-click installer is configured for the hosted Comp AI service. + +If you're using a self-hosted deployment, use the Advanced — manual JSON config below and include the `--server-url` argument. + + Open the **Command Palette → MCP: Open User Configuration** and paste: @@ -200,6 +218,41 @@ Save and reload Windsurf. +## Self-hosted deployments + +If you're connecting to a self-hosted Comp AI deployment instead of the hosted Comp AI service, you must include the `--server-url` argument in your MCP server configuration. + +Hosted Comp AI users do not need to specify --server-url. + +### Example + +```json +{ + "mcpServers": { + "comp-ai": { + "command": "npx", + "args": [ + "-y", + "@trycompai/mcp-server", + "start", + "--apikey", + "comp_your_api_key_here", + "--server-url", + "https://your-self-hosted-comp-api.example.com" + ] + } + } +} +``` + +For CLI-based clients, append: + +```text +--server-url https://your-self-hosted-comp-api.example.com +``` + +to the existing installation command. + That's it. The first time you start a chat in your AI client after install, the assistant will discover the Comp AI tools and start using them. ## Verify it worked From 5d1849ad343715bec96c1a9c920232af695810b6 Mon Sep 17 00:00:00 2001 From: TharunYettiK Date: Fri, 17 Jul 2026 11:16:50 +0530 Subject: [PATCH 2/2] docs: add self-hosted MCP configuration examples --- packages/docs/mcp-server.mdx | 110 +++++++++++++++++++++++++++++++++-- 1 file changed, 104 insertions(+), 6 deletions(-) diff --git a/packages/docs/mcp-server.mdx b/packages/docs/mcp-server.mdx index d8db53b8db..dfd3b5d409 100644 --- a/packages/docs/mcp-server.mdx +++ b/packages/docs/mcp-server.mdx @@ -222,9 +222,15 @@ Save and reload Windsurf. If you're connecting to a self-hosted Comp AI deployment instead of the hosted Comp AI service, you must include the `--server-url` argument in your MCP server configuration. -Hosted Comp AI users do not need to specify --server-url. +Hosted Comp AI users do not need to specify `--server-url`. -### Example +Choose your AI client below and update its configuration by adding the `--server-url` argument. + + + + + +Update the manual JSON configuration by adding the `--server-url` argument. ```json { @@ -244,14 +250,106 @@ Hosted Comp AI users do not need to specify --server-url. } } ``` + + + + +Update the manual JSON configuration by adding the `--server-url` argument. + +```json +{ + "command": "npx", + "args": [ + "-y", + "@trycompai/mcp-server", + "start", + "--apikey", + "comp_your_api_key_here", + "--server-url", + "https://your-self-hosted-comp-api.example.com" + ] +} +``` + + + + +Update your MCP configuration by adding the `--server-url` argument. + +```json +{ + "command": "npx", + "args": [ + "-y", + "@trycompai/mcp-server", + "start", + "--apikey", + "comp_your_api_key_here", + "--server-url", + "https://your-self-hosted-comp-api.example.com" + ] +} +``` + + + + +Append the `--server-url` argument to your existing installation command. + +```bash +claude mcp add CompAI -- npx -y @trycompai/mcp-server start \ + --apikey comp_your_api_key_here \ + --server-url https://your-self-hosted-comp-api.example.com +``` + + + + +Append the `--server-url` argument to your existing installation command. + +```bash +codex mcp add comp-ai -- npx -y @trycompai/mcp-server start \ + --apikey comp_your_api_key_here \ + --server-url https://your-self-hosted-comp-api.example.com +``` + + + + +Append the `--server-url` argument to your existing installation command. + +```bash +gemini mcp add CompAI -- npx -y @trycompai/mcp-server start \ + --apikey comp_your_api_key_here \ + --server-url https://your-self-hosted-comp-api.example.com +``` + + + -For CLI-based clients, append: +Update your MCP configuration by adding the `--server-url` argument. -```text ---server-url https://your-self-hosted-comp-api.example.com +```json +{ + "mcpServers": { + "comp-ai": { + "command": "npx", + "args": [ + "-y", + "@trycompai/mcp-server", + "start", + "--apikey", + "comp_your_api_key_here", + "--server-url", + "https://your-self-hosted-comp-api.example.com" + ] + } + } +} ``` + -to the existing installation command. + That's it. The first time you start a chat in your AI client after install, the assistant will discover the Comp AI tools and start using them.