跳到正文
AsKlear Data开发者文档

MCP 接入与查询参考

一页查看 MCP 接入、查询规则、数据集契约、错误恢复与 Credits 计费。

租户实际范围和当前数据时间以认证后的 describe 返回为准。

通过 Streamable HTTP MCP 将 Asklear 接入你的 Agent,并验证第一次认证工具调用。

{
  "mcpServers": {
    "asklear": {
      "type": "http",
      "url": "<YOUR_API_BASE_URL>/mcp",
      "headers": {
        "Authorization": "Bearer <YOUR_ASKLEAR_API_KEY>"
      }
    }
  }
}

工作流规则

开发者工作流
  1. query_metrics
  2. search_values
  3. describe(dataset)
  4. list_datasets
  • 当前或最新对每个 dataset 分别发送 time.last_complete_months=1。JD/Tmall 跨数据集比较使用分开的 query_metrics 调用,分别报告 meta.resolved_query 中的实际月份,不假设共用数据水位。
  • 用户明确指定公共时间范围时,将原范围分别发送给每个数据集,不得静默裁剪。
  • 向用户解释 data_range_unavailable;不得裁剪、替换月份、补零或静默省略不可用数据。这是范围错误,不是 503 能力不可用。
  • 契约声明的指标、可分组维度、筛选和排序可自由组合;recipe 是示例,不是白名单。
  • group_by 即实际结果粒度;趋势包含 month,店铺或商品结果包含实体身份字段。

数据集契约要点

dataset=douyin · month

抖音商品月度销量明细表

指标:gmvunitsasp

可筛选字段:product_idshop_idbrandcategory_l1category_l2category_l3category_l4shop

  • 数据按自然月分区;商品明细支持在月份范围内按日查询
  • 商品筛选仅支持精确 product_id,不支持名称、别名、商品链接或模糊搜索
  • 店铺可使用精确 shop_id 或经 search_values 对齐后的店铺名
  • 不提供评价、流量、库存、因果解释或其他平台数据
  • 同比、环比、份额、贡献度和跨期集合差异由 Agent 基于原子查询结果计算
  • 指标口径、覆盖量级、更新时间和访问授权仍待上游确认
  • 当前仅含 2026-06 前四天数据,数据不完整
完整契约
dataset=jd · month

京东商品月度销量明细表

指标:gmvunitsasp

可筛选字段:product_idshop_idbrandcategory_l1category_l2category_l3shop

  • 仅支持月粒度数据
  • 商品仅支持精确 product_id 或标准 item.jd.com 商品链接,不支持名称、别名、模糊搜索或短链
  • 店铺可使用精确 shop_id、标准 mall.jd.com 链接或经 search_values 对齐后的店铺名
  • 不提供评价、流量、库存、因果解释或其他平台数据
  • 同比、环比、份额、贡献度和跨期集合差异由 Agent 基于原子查询结果计算
完整契约
dataset=pdd · month

拼多多商品月度销量明细表

指标:gmvunitsasp

可筛选字段:product_idshop_idbrandcategory_l1category_l2category_l3shop

  • 仅支持月粒度数据
  • 商品筛选仅支持精确 product_id,不支持名称、别名或模糊搜索
  • 店铺可使用精确 shop_id 或经 search_values 对齐后的店铺名
  • 不提供评价、流量、库存、因果解释或其他平台数据
  • 同比、环比、份额、贡献度和跨期集合差异由 Agent 基于原子查询结果计算
  • 指标口径、覆盖量级、更新时间和访问授权仍待上游确认
  • 当前仅含 2026-06 单月数据
完整契约
dataset=tmall · month

天猫商品月度销量明细表

指标:gmvunitsasp

可筛选字段:product_idshop_idbrandcategory_l1category_l2category_l3shopis_livehas_bybtbc_type

  • 仅支持月粒度数据;2026-06 是首发水位,不是订阅起始月份
  • 商品和店铺只支持精确 ID 或已确认的 HTTPS 淘宝链接格式
  • NULL 和空字符串统一表示未知,不等同于否
完整契约

错误恢复

读取 error.documentation.url 指向的 .md,按其中的 Agent 动作恢复;失败请求不扣费。

Credits 计费

费用与确认

  • 仅当 approval_required=true,即费用上界超过访问密钥的 approval_threshold_credits(默认 200 Credits)时,才要求用户明确同意。
  • 将 upper_bound_credits 表述为最多消耗;实际 Credits 以执行结果为准。
  • 付费操作完成后,以 charged_credits 作为实际扣点,以 balance_after.available 作为与 Dashboard 一致的可用余额。credits 与 priced_credits 表示计算价格;billing_mode=shadow 时 charged_credits 为 0,钱包不扣减。balance_after.total 是尚未扣除 reserved 和 refund_holds 的钱包总额。
  • 需要同意时,使用 max_credits 绑定服务端返回的上界;任何分析参数变化后都要不带确认重新请求。
  • 扫描实现由服务端选择;以返回的计划元数据作为执行事实。
  • 余额不足、预算上限拒绝、权限拒绝和能力不支持属于终止结果。

常见陷阱

  • 每次 Asklear 业务工具调用都必须携带有效 task_query;缺失或无效会被 task_query_required 或 invalid_task_query 拒绝且不执行。按错误 hint 修正 task_query 后,使用原请求参数重试。
  • JD 与 Tmall 的数据水位相互独立。跨数据集比较必须对每个数据集分开调用 query_metrics,并分别报告 meta.resolved_query 中各自的实际月份;不得假设共用数据水位。
  • data_range_unavailable 是范围错误,不是 503 能力不可用,不要当故障重试;应向用户解释不可用月份,不得裁剪、替换月份、补零或静默省略不可用数据。
  • 收到 approval_required 时,将费用上界 upper_bound_credits 表述为最多消耗,实际 Credits 以执行结果为准。用户同意后,使用 max_credits,并把返回的 plan_digest 赋给 approved_plan_digest,对完全相同的请求重试一次。
  • 对 dataset=tmall,2026-06 是首发数据水位(首个已发布覆盖月份),不是订阅起始月份;不要把它解释成租户订阅的开始时间。
  • 不确定具体规则、字段名、数据集限制或错误恢复方式时,先在会话内调用只读 `docs` 工具查文档,不要靠猜。它与开发者文档站同源,免费、不计入 Usage、也不触发数据集查询。

输出纪律

  • 先用用户语言给出业务结论;API 字段名和实现细节只在有助于用户行动时说明。
  • 说明服务端实际解析的时间范围和业务范围;未限定品类时,要明确结果覆盖全部可用类目。
  • 说明 API 返回的数据覆盖范围和指标口径。
  • 区分服务端返回指标与 Agent 计算结果。
  • 币种、单位、精度和数量级以数据集契约返回值为准。
  • 说明与用户有关的限制、授权或歧义,省略例行工具发现和内部重试。
  • API Key 仅用于 MCP 认证。

客户端配置模板

把这份模板放入客户端,完成 Asklear MCP 配置并验证第一次查询。

Integrate the Asklear MCP data service for me, then run a first verified
query. Follow these steps in order:

1. Fetch <YOUR_DASHBOARD_ORIGIN>/docs/agent/llms.txt from the Asklear docs
   site to get the index of all Asklear agent documentation, and fetch any
   linked .md page you need while you work. <YOUR_DASHBOARD_ORIGIN> is the
   Asklear dashboard origin, which may differ from the MCP origin below.
2. Ask me for my business scenario and my target dataset:
   jd (JD), tmall (Tmall), or both.
3. Generate the MCP configuration (mcp.json) for my coding agent client,
   with my values filled into this template:

{
  "mcpServers": {
    "asklear": {
      "type": "http",
      "url": "<YOUR_API_BASE_URL>/mcp",
      "headers": {
        "Authorization": "Bearer <YOUR_ASKLEAR_API_KEY>"
      }
    }
  }
}

4. Accept the integration only after one authenticated connection_status
   call succeeds, and show me its result.
5. Run the first query with query_metrics on my target dataset, then report
   the business conclusion and the resolved month from meta.resolved_query.