Skip to content

MCP Clients ​

Clients supporting MCP Streamable HTTP can connect directly to OpenViking's /mcp endpoint. Clients that support only stdio can use the proxy in the Agent Plugins package.

Quick setup ​

Clients accepting mcpServers and custom headers can use this example. For other clients, follow the platform-specific instructions below:

json
{
  "mcpServers": {
    "openviking": {
      "url": "https://your-server.com/mcp",
      "headers": {
        "Authorization": "Bearer your-api-key-here"
      }
    }
  }
}

No authentication is needed for a server running in dev mode. Keep it bound to loopback; an authenticated server still requires credentials when accessed locally.

Platform-specific notes ​

Claude Code ​

Claude Code requires "type": "http". Add via CLI:

bash
claude mcp add --transport http openviking \
  https://your-server.com/mcp \
  --header "Authorization: Bearer your-api-key-here"

Add --scope user to make the config global across all projects.

For auto-recall and auto-capture without manual tool calls, use the Claude Code Memory Plugin instead.

Trae / Cursor ​

Add the service URL and API key shown above to the client's MCP configuration.

ChatGPT ​

Create a custom App in developer mode and complete OAuth authorization. See the OAuth guide.

Codex ​

For Codex, use the Codex Memory Plugin. It supplies a stdio MCP proxy through the plugin manifest and keeps MCP credentials aligned with the lifecycle hooks.

OpenCode ​

Use OpenCode's native mcp config in ~/.config/opencode/opencode.json:

json
{
  "mcp": {
    "openviking": {
      "type": "remote",
      "url": "https://your-server.com/mcp",
      "enabled": true,
      "oauth": false,
      "headers": {
        "Authorization": "Bearer your-api-key-here"
      }
    }
  }
}

Claude Desktop / Claude.ai (OAuth) ​

For the hosted remote-connector flow, use OpenViking’s native OAuth implementation. At the authorization page, sign in with an existing OpenViking User/Admin key. Claude Desktop’s local stdio configuration is a separate connection path.

Enable oauth.enabled on the server and configure HTTPS, then connect the client to https://your-server.com/mcp and complete authorization in the browser.

See the OAuth 2.1 Guide and Public Access Guide for HTTPS setup, deployment templates, and the full authorization flow.

Available tools ​

Once connected, OpenViking exposes retrieval, memory, resource, watch, filesystem, and code-navigation tools. See the MCP Integration Guide for the canonical tool list, parameters, progressive file upload, and advanced configuration.

Troubleshooting ​

SymptomFix
Connection refusedVerify openviking-server is running: curl http://localhost:1933/health
Authentication errorsCheck that the client uses a valid user/admin key. See Authentication Guide

See also ​

Open source under the AGPL-3.0 License. Font licenses