概述
QuantDB MCP 是只读的数据查询入口:AI 客户端可在受控权限内发现数据集、检索标的、预览数据并查询短期日线。它不提供 COS 凭据、不创建下载直链、不执行交易;账户、订阅与第 6 类 ML 数据集权限仍由 QuantDB 主服务统一执行。
支持两种接入方式:
| 方式 | 说明 | 状态 |
|---|---|---|
| 本地 stdio | 在本机以 go run ./cmd/quantdb-mcp 启动 MCP 服务,用 API Key 鉴权;适用于 TRAE、WorkBuddy 等支持 stdio 的客户端。 | 可用 |
| 远程 MCP | 通过 HTTPS 连接 /api/v1/mcp,走 OAuth 2.1 + PKCE 授权;适用于支持远程 MCP 的客户端。 | 联测中 |
前置条件
- 一个 QuantDB 账户,并已创建 API Key。
- 本地 stdio 接入需要:Go 1.21+ 运行环境,以及本机已克隆 QuantDB 仓库。
- 远程接入无需本地环境,只需客户端支持远程 MCP(URL)与 OAuth 2.1。
创建 API Key
登录个人中心,在 API Key 区域创建一个仅供本机使用的密钥。请勿把 Key 提交到 Git 仓库、公开分享或粘贴到聊天内容。
把 API Key 直接填入下方配置的 QUANTDB_API_KEY 字段即可使用。也支持环境变量方式(客户端支持 ${env:...} 插值时):
QUANTDB_API_KEY=你的_API_KeyWindows 可用 setx QUANTDB_API_KEY "你的_API_Key" 持久化(重开终端生效);macOS/Linux 写入 shell 配置或 export。
本地 stdio 配置
在客户端的 MCP 配置文件(或「MCP Servers」设置面板)中加入以下配置。将 cwd 替换为你本机 QuantDB 仓库的 backend 目录绝对路径。
{
"mcpServers": {
"quantdb": {
"command": "go",
"args": ["run", "./cmd/quantdb-mcp"],
"cwd": "/path/to/quantDB/backend",
"env": {
"QUANTDB_API_BASE_URL": "https://quantdb.quantmind.cloud",
"QUANTDB_API_KEY": "你的_API_Key"
}
}
}
}
字段说明
| 字段 | 说明 |
|---|---|
command / args | 以 stdio 方式启动本地 MCP 服务:go run ./cmd/quantdb-mcp。 |
cwd | QuantDB 仓库的 backend 目录(go run 的运行目录),必须为绝对路径。 |
env.QUANTDB_API_BASE_URL | 生产 API 地址,保持默认 https://quantdb.quantmind.cloud。 |
env.QUANTDB_API_KEY | 你的 API Key。直接填写即可;也可用 ${env:QUANTDB_API_KEY} 引用环境变量。 |
在客户端中添加
| 客户端 | 添加方式 |
|---|---|
| TRAE | 打开 MCP 设置面板,选择「添加 / 手动添加」,粘贴上方 JSON(mcpServers 格式)。 |
| WorkBuddy | 在 MCP 设置中新增一个 stdio 服务器,粘贴上方 JSON;如支持导入配置文件可直接引用。 |
| 其他 stdio 客户端 | 凡支持标准 mcpServers 配置的客户端均可复用同一份 JSON。 |
环境变量为可选项:若已在系统中设置 QUANTDB_API_KEY,可将该字段改为 ${env:QUANTDB_API_KEY} 引用(部分客户端支持此插值),避免密钥落盘。
仓库内已提供示例配置 plugins/quantdb-mcp/.mcp.json,可直接参考或导入。
远程 MCP(OAuth 2.1)
远程 MCP 通过 HTTPS 暴露在 /api/v1/mcp,使用 OAuth 2.1 授权(支持动态客户端注册 DCR、PKCE S256 与 CIMD),无需本地 Go 环境。
https://quantdb.quantmind.cloud/api/v1/mcp{
"mcpServers": {
"quantdb": {
"type": "http",
"url": "https://quantdb.quantmind.cloud/api/v1/mcp"
}
}
}
客户端通常会自动发现 OAuth 配置(受保护资源元数据):
| 发现端点 | 说明 |
|---|---|
/.well-known/oauth-protected-resource | 受保护资源元数据(resource、授权服务器、scopes) |
/.well-known/oauth-authorization-server | 授权服务器元数据(authorize / token / register / revoke,PKCE S256) |
状态说明:远程 MCP 服务端已在生产启用,正在客户端联测;授权流程为浏览器登录 → 同意授权 → 获得短期访问令牌,令牌可刷新、可撤销。如连接异常,请在个人中心或反馈渠道告知。
验证连接
- 1确认服务已加载
客户端连接后应能列出
quantdb服务器及其工具。 - 2让 AI 调用一次
对 AI 说:用 QuantDB 搜索一下日线数据集,应触发
search_datasets并返回数据集列表。 - 3核对单位口径
行情数据固定为:OHLC 为元、
volume为股、amount为万元。
可用工具
| 工具 | 用途 |
|---|---|
search_datasets | 查找数据集及稳定 sub_category 标识 |
describe_dataset | 获取单位约定与实际覆盖区间 |
preview_data | 最多预览 100 行数据 |
query_kline_range | 查询单一标的最多 31 个自然日的日线 OHLCV |
search_instruments | 按证券代码或名称查标的 |
get_sdk_sync_guide | 获取官方 SDK 的安装与增量同步指引 |
get_account_status | 查询当前账户、订阅与数据访问状态 |
get_usage | 查询已用流量、额度、流量包余额与订阅状态 |
常见问题
pip install -U quantdb-sdk,详见 SDK 文档。get_account_status 查看当前可访问范围。