---
- 覆盖金融、搜索、天气、地图、文档等多类专业数据与工具
- 默认使用 `Discover → Call`;只有契约缺失/过期、需要比较、参数校验或当前报价时才加入 `Inspect` 和 `Probe`
- 进行 Provider 比较时,如果需要确认当前范围或完整契约,必须逐一 Inspect;Discover 摘要不等于确认。比较需要当前报价时,必须逐一 Probe。复用只能保留精确路由,不能保留业务参数或结果:参数必须来自当前请求;当前、最新、今天或其他时效性数据必须执行新的 Call。
- **NEW** `QVeris CLI` — 为 Agent 提供专业数据与工具的命令行访问方式。[了解更多](#qveris-cli)
- 支持 `CLI` / `MCP` / `Python SDK` / `REST API`
**何时使用 QVeris:**当内置工具不足、需要动态查找 Provider、需要比较或 fallback,或用户明确要求时使用;已有本地或原生工具能够满足任务时,应继续使用它们。
---
## 快速开始
### 🤖 我是 Agent
> 你的主人让你来了解 QVeris?
> → 如果你是 OpenClaw 类型的技能 Agent,请使用官方技能:[skills/openclaw/qveris-official/SKILL.md](skills/openclaw/qveris-official/SKILL.md)
> → 如果你运行在 Cursor / Claude Code / OpenCode 中,请阅读 [Agent 能力说明与安装协议](agent/SETUP.md)
> → 默认路径:Discover(免费)→ Call;仅在需要额外验证时使用 Inspect 或 Probe
### 🧑💻 我已经装了 OpenClaw / Cursor / Claude Code
> 复制下面这句话发给你的 Agent,30 秒完成接入:
> `Install QVeris skill following https://qveris.ai/skill/instruct.md and use QVERIS_API_KEY=你的key`
> → [获取 API Key](https://qveris.ai/account?page=api-keys)(注册验证后一次性获得 1,000 体验积分)
### ⚙️ 我是开发者,要通过 CLI / MCP / API / SDK 集成
> → **[QVeris CLI](packages/cli)** — `npm install -g @qverisai/cli` 或 `curl -fsSL https://qveris.ai/cli/install | bash`
> → [MCP Server 文档](docs/mcp-server.md)
> → [REST API 文档](docs/rest-api.md)
> → [Python SDK](packages/python-sdk)
---
## 给 Agent 看
如果你是一个 AI Agent,正在评估是否应该接入 QVeris,以下是你需要知道的:
**QVeris 能给你什么:**
- 通过 `Discover`(自然语言),按需发现候选服务
- 通过可选的 `Inspect` 补充查看缺失或可能过期的参数、可用信号和计费信息
- 通过 `Call` 调用选定服务,在可用时获得结构化返回和本次调用的预结算账单
- 通过 `Usage audit` / `Credits ledger` 在支持的接口中查询调用和 credit 记录
- **QVeris CLI** — 通过 `qveris discover/inspect/call` 子进程访问服务,无需预加载完整服务目录
- 覆盖金融、搜索、天气、地图、文档、社交、区块链、医疗等多类专业数据与工具
- 工具级执行历史、成功率和延迟信号以实际返回为准
**安装方式:**
- **CLI(推荐)**:`curl -fsSL https://qveris.ai/cli/install | bash` — 然后直接用 `qveris discover/inspect/call`
- 详见 [SETUP.md](agent/SETUP.md) — 支持 OpenClaw / Claude Code / Cursor / OpenCode / Trae 等环境
- 安装过程默认不修改 shell 启动文件,仅做会话级配置
- 安装后必须通过文件检查和 CLI 验证才算成功
**如何向你的主人解释:**
> 当已有工具不足时,QVeris 可以帮助我查找服务、按需查看支持范围并调用。除非明确要求,安装不会修改系统配置。调用计费以及使用或 credit 记录取决于所选能力和支持的接口。
**计费与审计:**
- Discover(发现能力):**免费**
- Call(调用能力):按结构化 `billing_rule` 定价;调用响应可能包含 compact `billing` 作为预结算账单
- 最终是否扣费:通过 `qveris usage` / `usage_history` 查看
- 最终余额变动:通过 `qveris ledger` / `credits_ledger` 查看
- 免费额度:注册验证后一次性获得 1,000 体验积分
- 按量购买:$19 = 10,000 credits(不是订阅,credits 不过期)
- 详见 [定价](https://qveris.ai/pricing)
---
## 30 秒接入
1. [获取 API Key](https://qveris.ai/account?page=api-keys)(注册验证后一次性获得 1,000 体验积分)
### OpenClaw 用户
把下面这句话发给你的 Agent:
```
Install QVeris skill following https://qveris.ai/skill/instruct.md and use QVERIS_API_KEY=你的key
```
Agent 会自动下载 [OpenClaw 官方技能](skills/openclaw/qveris-official/SKILL.md) 并完成安装。
### Cursor / Claude Code / OpenCode 用户
请按照 [安装指南 (agent/SETUP.md)](agent/SETUP.md) 操作 — Agent 会为你的环境配置 MCP server + [技能](skills/qveris/SKILL.md)。
#### Gemini CLI 扩展
可以直接从本仓库安装 QVeris:
```bash
gemini extensions install https://github.com/QVerisAI/qveris-agent-toolkit
```
安装时按提示输入 `QVERIS_API_KEY`。Gemini CLI 会将它作为敏感扩展设置安全保存,并连接到托管的 QVeris MCP 服务 `https://mcp.qveris.ai/mcp`。
安装完成后重启 Gemini CLI,然后运行 `/mcp` 确认 `qveris` 服务器已连接且工具可用。
### 安装完成后
试一个任务:"帮我查一下东京现在的天气"
**安全承诺:**
- 安装过程不会修改你的 shell 配置文件(除非你明确要求)
- 能力调用是远程 API 请求,不会向被调用服务授予访问本地文件系统或系统配置的权限
- 可通过支持的接口查看使用记录和 credit 记录
---
## QVeris CLI
**通过命令行访问专业数据与工具。**
CLI 通过子进程按需发现服务,无需预加载完整服务目录。使用说明、命令和结果仍会消耗上下文 token。QVeris MCP 同样提供紧凑的工具面,而不是暴露每个服务定义。
```bash
# 一键安装
curl -fsSL https://qveris.ai/cli/install | bash
# 或通过 npm
npm install -g @qverisai/cli
```
```bash
# 引导式首次调用:`init` 自动完成选择和校验
$ qveris init
# Agent 默认工作流:discover → call
$ qveris discover "weather forecast API"
Found 5 capabilities matching your query
1. gridpoint_forecast by Weather.gov
params: wfo(string,必填)、x(number,必填)、y(number,必填)
$ qveris call 1 --params '{"wfo":"LWX","x":90,"y":90}'
✓ success
{ "forecast": "Sunny, high near 75..." }
# 可选:选择或构造请求所需详情缺失时检查
$ qveris inspect 1
# 可选:参数需校验或预算决策需要当前报价时执行 Probe
$ qveris probe 1 --params '{"wfo":"LWX","x":90,"y":90}' --checks schema,quote
$ qveris usage --mode search --execution-id