RevGlance文档

API 和 AI 助手

通过 REST API 从您自己的代码读取指标,或通过 MCP 从 Claude、ChatGPT 和 Cursor 读取。

AI 助手(MCP)

RevGlance 运行着一个 MCP 服务器,因此 AI 助手可以读取您的指标,所用的校验和报告与 Ask 相同。它们从不调用 RevGlance 的模型,也从不消耗问题次数。

设置 › AI 助手 会显示服务器地址以及每个客户端的操作步骤。简而言之:

  1. 使用该页面上以 /mcp 结尾的地址,将 RevGlance 添加为自定义连接器。
  2. 当助手提示时登录 RevGlance。授权页面会说明它能读取和不能读取的内容。
  3. 尽管提问。每次查询都会保存为一个答案,并附带查看计算链接。

对于 Claude Code:

bash
claude mcp add --transport http revglance https://your-revglance-address/mcp

然后在 Claude Code 中运行 /mcp 进行登录。

助手可以使用四个只读工具:

  • list-businesses:您可以读取的业务,包括其币种、您的角色,以及每个数据源及其上次同步时间。
  • describe-data:某个业务可以查询的内容:每个指标及其含义和单位、有数据的月份,以及可用于筛选或拆分查询的方案、计费周期、国家、数据源和属性。
  • query-metrics:一个或多个指标在一段月份范围内的数据,筛选和拆分方式与指标页面相同。RevGlance 会校验每个名称,说明做了哪些调整,使用相同的报告计算,并将每个答案连同查看计算链接一起保存。
  • explain-figure:某个数字背后的计算:展开后的公式,以及构成它的最大几行数据。在隐私模式下,客户显示为简短标签。

设置 › AI 助手 还会列出谁连接了哪个客户端、各自问了什么,并可断开某个连接、吊销其令牌。演示账户和已结束的试用无法连接。

REST API

位于 /api/v1 的只读 REST API,适用于付费方案。

  1. 在 设置 › API 密钥 中创建密钥。它只显示一次。
  2. 将其作为 bearer 令牌发送:Authorization: Bearer <key>。
bash
curl https://your-revglance-address/api/v1/businesses \
  -H "Authorization: Bearer $REVGLANCE_KEY" \
  -H "Accept: application/json"

它涵盖业务、指标目录、与指标页面相同筛选和拆分方式的指标(每个数字都附带查看计算链接)、“为什么”解释,以及支持游标分页的客户和扣款。隐私模式的效果与界面上一致。每个密钥每分钟最多可发出 120 个请求,每个请求都会记录在密钥页面上,密钥一年后过期。API 密钥永远不能用于 MCP。

包含所有端点和字段的完整参考,请参阅 REST API 参考。