Skip to content

MCP 客户端

任何兼容 MCP 的客户端都可以直接连接 OpenViking 内置的 /mcp 端点——无需安装插件或启动额外进程。适用于 Cursor、Trae、Manus、Claude Desktop、ChatGPT 等。

快速配置

大多数 MCP 客户端使用标准 mcpServers 格式:

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

本地服务未配置 root_api_key 时(dev 模式)无需认证。

各平台注意事项

Claude Code

Claude Code 需要额外指定 "type": "http",通过命令行添加:

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

--scope user 使配置全局生效。

如果你需要免工具调用的自动召回与自动捕获,请使用 Claude Code 记忆插件

Trae / Cursor / ChatGPT

使用上面的标准 mcpServers 配置即可——均已通过 API Key 鉴权验证。

Codex

Codex 请使用 Codex 记忆插件。插件通过 manifest 提供 stdio MCP 代理,并让 MCP 与生命周期 hooks 共用同一套凭据配置。

OpenCode

~/.config/opencode/opencode.json 中使用 OpenCode 原生 mcp 配置:

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)

这些客户端要求 OAuth 2.1——无法直接传 API Key。OpenViking 自带原生 OAuth 2.1 实现,无需外部代理。

如果你已经为 OpenViking 服务配好了 HTTPS,直接连接 https://your-server.com/mcp 端点即可——客户端会自动引导你完成 OAuth 授权流程。

HTTPS 配置、部署模板和完整授权流程详见 OAuth 2.1 指南公网访问指南

可用工具

连接后,OpenViking 会提供检索、记忆、资源、watch、文件系统和代码导航工具。完整工具清单、参数、渐进式文件上传和高级配置见 MCP 集成指南

故障排查

现象修复
连接被拒绝确认 openviking-server 正在运行:curl http://localhost:1933/health
认证错误确保客户端配置中的 API Key 与服务端一致。见 鉴权指南

参见

Released under the Apache-2.0 License.