@qverisai/mcp 是面向 Cursor、Cherry Studio、GitHub Copilot、Cline、Roo Code、Kiro、Qoder、CodeBuddy、WorkBuddy 及其他编程 Agent 等 MCP 兼容客户端的官方 QVeris MCP 服务器。
@qverisai/mcp v0.14.5 是最新测试版本,通过六个规范 MCP 工具为 Agent 提供 QVeris 访问能力:
discover — 用自然语言发现能力inspect — 获取工具详情(参数、成功率、示例)probe — 不执行能力的参数校验与报价call — 执行工具并传入参数usage_history — 上下文安全的调用审计摘要 / 精确查询 / 文件导出credits_ledger — 上下文安全的最终积分账本摘要 / 精确查询 / 文件导出进行 Provider 比较时,如果需要确认当前范围或完整契约,必须逐一 Inspect;Discover 摘要不等于确认。比较需要当前报价时,必须逐一 Probe。复用只能保留精确路由,不能保留业务参数或结果:参数必须来自当前请求;当前、最新、今天或其他时效性数据必须执行新的 Call。
换言之,MCP 服务器是本仓库其他文档所描述的 QVeris 核心协议的 Agent 侧传输层。
适合使用 MCP 服务器的场景:
适合使用 REST API 的场景:
两种方式均映射到同一套 QVeris 协议:
| 协议操作 | MCP 工具 | REST API |
|---|---|---|
| 发现 | discover | POST /search |
| 检查 | inspect | POST /tools/by-ids |
| 探测 | probe | POST /tools/probe |
| 调用 | call | POST /tools/execute |
| 调用审计 | usage_history | GET /auth/usage/history/v2 |
| Credits 账本 | credits_ledger | GET /auth/credits/ledger |
**注意:**旧工具名称(
search_tools、get_tools_by_ids、execute_tool)仍作为弃用别名支持。
QVERIS_API_KEY18+只要客户端支持远程 Streamable HTTP,就应优先使用托管 MCP。它使用一个受管端点,无需维护本地软件包、Node.js 进程或服务器生命周期。
支持 MCP OAuth 自动发现的客户端可添加以下端点,按提示在浏览器中完成登录,无需创建或粘贴 API 密钥。示例使用 mcpServers 外层键;VS Code 应改用 servers。
{
"mcpServers": {
"qveris": {
"type": "http",
"url": "https://mcp.qveris.cn/mcp"
}
}
}
如果远程客户端不支持 OAuth 自动发现,请使用托管 MCP 详细说明中的 API 密钥备用方案。可前往托管 MCP 页面复制端点并查看各客户端的配置说明。只有当客户端不支持远程 Streamable HTTP 时,才使用下方本地 stdio 备用方案。
npx 安装npx -y @qverisai/mcp
MCP 服务器从以下环境变量读取配置:
QVERIS_API_KEY=your-api-key # 必填
QVERIS_BASE_URL=https://qveris.cn/api/v1 # 必填:设置 API 地址
可以用 CLI 生成客户端配置,无需手写 JSON。默认会打印带有 YOUR_QVERIS_API_KEY 占位符的安全配置;占位符输出会故意无法通过 API key 校验,直到你替换占位符或使用 --include-key。
export QVERIS_BASE_URL="https://qveris.cn/api/v1"
# 打印安全的 Cursor 配置
qveris mcp configure --target cursor
# 使用 qveris login 或 QVERIS_API_KEY 中的 API key 写入可直接使用的配置
qveris mcp configure --target cursor --write --include-key
qveris mcp configure --target opencode --write --include-key
qveris mcp configure --target openclaw --write --include-key
重启客户端前可以先校验配置:
qveris mcp validate --target cursor
对 stdio 客户端,可添加 --probe 启动配置中的 MCP server,并通过 tools/list 确认 discover、inspect、probe、call 可见:
qveris mcp validate --target cursor --probe
{
"mcpServers": {
"qveris": {
"command": "npx",
"args": ["-y", "@qverisai/mcp"],
"env": {
"QVERIS_API_KEY": "your-api-key-here",
"QVERIS_BASE_URL": "https://qveris.cn/api/v1"
}
}
}
}
在 Cherry Studio 中打开设置 → MCP 服务器,新增服务器后将以下内容填入对应配置字段:
{
"name": "QVeris",
"command": "npx",
"args": ["-y", "@qverisai/mcp"],
"env": {
"QVERIS_API_KEY": "your-api-key-here",
"QVERIS_BASE_URL": "https://qveris.cn/api/v1"
},
"disabledTools": []
}
保存服务器,在对话中启用它,并确认可见 discover、inspect、probe 和 call。
除上文客户端外,以下桌面端 Agent 在支持远程 Streamable HTTP 时应优先使用托管 MCP,本地 stdio 仅作为备用方案:GitHub Copilot、Cline、Roo Code、Continue、Kiro、Junie、Augment、Zed、Google Antigravity、Qoder、CodeBuddy 和 WorkBuddy。
对于 GitHub Copilot 以外的仅支持本地 stdio 的客户端,请在 MCP 设置中导入以下备用配置。Zed 在 Agent 面板中填写相同的名称、命令、参数和环境变量。
{
"mcpServers": {
"qveris": {
"command": "npx",
"args": ["-y", "@qverisai/mcp"],
"env": {
"QVERIS_API_KEY": "your-api-key-here",
"QVERIS_BASE_URL": "https://qveris.cn/api/v1"
}
}
}
}
GitHub Copilot 的 mcp.json 使用顶层 servers 对象,而不是 mcpServers。
请在 .vscode/mcp.json 中手动配置以下托管端点。VS Code 会自动发现 OAuth,按提示在浏览器中完成登录即可:
{
"servers": {
"qveris": {
"type": "http",
"url": "https://mcp.qveris.cn/mcp"
}
}
}
如需在 VS Code 中使用 API 密钥备用方案,请保留 servers 外层键,并通过密码输入保存密钥,避免将密钥提交到工作区:
{
"inputs": [
{
"type": "promptString",
"id": "qveris-api-key",
"description": "QVeris API 密钥",
"password": true
}
],
"servers": {
"qveris": {
"type": "http",
"url": "https://mcp.qveris.cn/mcp",
"headers": {
"Authorization": "Bearer ${input:qveris-api-key}"
}
}
}
}
如果客户端环境不能使用远程 HTTP,请保留同一 servers 外层键,改用以下本地 stdio 条目:
{
"servers": {
"qveris": {
"command": "npx",
"args": ["-y", "@qverisai/mcp"],
"env": {
"QVERIS_API_KEY": "your-api-key-here",
"QVERIS_BASE_URL": "https://qveris.cn/api/v1"
}
}
}
}
各环境的详细配置指南,请参考:
QVeris 提供远程 Streamable HTTP MCP 托管服务。对于支持它的客户端,这是首选 MCP 连接方式:无需安装本地软件包或运行后台进程。
https://mcp.qveris.cn/mcp
支持 MCP OAuth 自动发现的客户端可按快速开始中的说明添加服务地址,并在浏览器中完成登录,无需创建 API 密钥。
对于不支持 OAuth 自动发现的远程 MCP 客户端,可使用以下配置,在每次请求中发送 QVeris API 密钥:
{
"mcpServers": {
"qveris": {
"type": "http",
"url": "https://mcp.qveris.cn/mcp",
"headers": {
"Authorization": "Bearer YOUR_QVERIS_API_KEY"
}
}
}
}
API 密钥接入步骤:
discover、inspect、probe、call 可见。服务会在会话启动时验证并绑定密钥。401 表示密钥缺失或无效;503 表示验证服务暂时不可用。更换密钥后请新建 MCP 会话。可前往托管 MCP 页面复制配置。
不支持远程 Streamable HTTP MCP 的客户端仍可使用本地 stdio 软件包。
discover使用自然语言发现能力。
这是**发现(Discover)**操作,免费使用。
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
query | string | 是 | 用自然语言描述所需能力 |
limit | number | 否 | 最大返回数量(1-100,默认 20) |
session_id | string | 否 | 用于追踪的会话标识符 |
view | string | 否 | routing 返回精简 routing card;full 或省略返回完整结果 |
lang | string | 否 | 响应语言:zh 或 en;省略时由服务端协商 |
示例:
{
"query": "天气预报 API",
"limit": 10,
"view": "routing",
"lang": "zh"
}
典型响应字段:
search_idtotalresults[]results[].tool_idresults[].paramsresults[].examplesresults[].statsinspect在复用或调用之前,检查一个或多个已知 tool_id 的详情。
这是**检查(Inspect)**操作。
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
tool_ids | array | 是 | 要查询的工具 ID 数组 |
search_id | string | 否 | 返回该工具的发现操作的搜索 ID |
session_id | string | 否 | 用于追踪的会话标识符 |
示例:
{
"tool_ids": ["openweathermap.weather.execute.v1"],
"search_id": "YOUR_SEARCH_ID"
}
以下情况建议使用 inspect:
响应结构与 /search 一致,包含所请求工具的参数、示例和统计数据。
probe用于在不执行能力的情况下校验候选参数并获取零成本报价。输入包括 tool_id、可选 parameters、可选 checks(schema、quote、coverage、sample)以及可选 live_budget(none、metadata、sampled)。当前已实现 schema 与 quote;coverage 和 sample 可能返回 unknown。Probe 不执行能力,也不消耗 credits。
call调用已发现的 QVeris 能力。
调用响应可能包含 compact 的 billing 预结算账单。最终是否扣费请通过 usage_history 或 credits_ledger 查询。
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
tool_id | string | 是 | 来自发现结果的工具 ID |
search_id | string | 是 | 发现该工具的搜索 ID |
params_to_tool | object | 是 | 传递给工具的参数字典 |
session_id | string | 否 | 用于追踪的会话标识符 |
model | string | 否 | 选择能力并生成参数的模型(最多 128 个字符) |
max_response_size | number | 否 | 最大响应字节数(默认 20480) |
respond_with | string | 否 | full、summary 或 fields:<JSONPath,...>;省略时为 full |
示例:
{
"tool_id": "openweathermap.weather.execute.v1",
"search_id": "YOUR_SEARCH_ID",
"params_to_tool": {"city": "北京", "units": "metric"},
"model": "router-model-v1",
"respond_with": "summary"
}
投影参数仅在显式指定时发送。旧服务返回 422 extra_forbidden 时仅移除对应可选字段并重试一次;无效投影仍按错误返回。
典型成功响应字段:
execution_idtool_id(所选投影返回时)successresult.data,或显式请求的精简摘要字段elapsed_time_ms 或 execution_timebilling / pre_settlement_bill(如可用)usage_history当用户询问某次调用是否成功、失败或扣费时使用。默认 summary 模式,不会把全量历史塞进上下文。
常用参数:
mode: summary、search 或 export_fileexecution_id / search_idcharge_outcome: charged、included、failed_not_charged、failed_charged_reviewmin_credits / max_creditsstart_date / end_datesummary 模式会优先请求服务端 summary=true 聚合摘要;若旧部署暂不支持,则回退到有上限的客户端聚合。
示例:
{ "mode": "search", "execution_id": "EXECUTION_ID" }
credits_ledger当用户询问余额为何变化时使用。默认 summary 模式。
常用参数:
mode: summary、search 或 export_filedirection: consume、grant 或 anyentry_typemin_credits / max_creditsstart_date / end_datesummary 模式会优先请求服务端 summary=true 聚合摘要;若旧部署暂不支持,则回退到有上限的客户端聚合。
示例:
{ "mode": "search", "direction": "consume", "min_credits": 50 }
大量记录应使用 mode: "export_file",MCP 服务器会写入 .qveris/exports/*.jsonl 并返回文件路径,而不是直接输出全量记录。
对于超大的工具调用输出,QVeris 可能返回:
truncated_contentfull_content_file_urlmessage应根据任务适配度、数据质量/时效、费用、用户约束和调用开销,在已连接工具与 QVeris 之间选择。能力缺失、Provider 未知、需要跨 Provider 比较或 fallback,或用户明确指定 QVeris 时,QVeris 尤其适合;它不是所有任务的必经入口。
对于大多数 QVeris 任务,默认使用:
discover — 发现相关能力call实践中:
inspectprobe;报价不等于锁价或授权search_id,并根据用户本次请求重新构造业务参数在单次用户会话中提供一致的 session_id 有助于:
若省略 session_id,MCP 服务器会在进程存活期间自动生成一个。该行为不等于语义路由记忆或持久化 schema 缓存。如果 Host 自行实现复用,必须按账户、API 地址、授权上下文和会话隔离;保留原始 search_id;分别管理 schema、费用和可用性的失效;不得缓存凭据、敏感业务值或业务结果。Host 未实现这些能力时,应重新 Discover,不能假设存在记忆。
node --versionQVERIS_API_KEY 设置正确tool_id 来自此前的发现结果inspect 检查工具后再调用params_to_tool 是否为有效对象如果在某些客户端中直接执行 npx 失败,用 cmd /c 包裹:
{
"command": "cmd",
"args": ["/c", "npx", "-y", "@qverisai/mcp"]
}
这个页面对你有帮助吗?