Asklear 开发者文档
统一说明数据集、MCP 接入和查询规则。
Markdown文档 ID:
agent.guide租户实际范围和当前数据时间以认证后的 describe 返回为准。
几分钟跑通第一次查询
- 01
API key在 Dashboard 创建访问密钥(API key),拿到 MCP URL。
- 02
mcp.json把 mcp.json 配置到你的 Agent 客户端,用真实 URL 和 Key 替换占位符。
查看 mcp.json 模板
{ "mcpServers": { "asklear": { "type": "http", "url": "<YOUR_API_BASE_URL>/mcp", "headers": { "Authorization": "Bearer <YOUR_ASKLEAR_API_KEY>" } } } } - 03
query_metrics直接调用 query_metrics 完成第一次查询;无需前置发现。
dataset=douyindataset=jddataset=pdddataset=tmall
开始接入
选择你的 Agent,完成 MCP 配置和第一次认证调用。
标准工作流
默认直接查询,仅在歧义或契约错误时发现能力。
query_metricssearch_valuesdescribe(dataset)list_datasets
数据集
douyin
抖音商品月度销量明细表
抖音 → 抖音商品月度销量明细表 → dataset=douyin
5 分析任务 · month
公开契约 · 运行时状态以认证环境为准
浏览能力 →jd京东商品月度销量明细表
京东 → 京东商品月度销量明细表 → dataset=jd
10 分析任务 · month
Credits 计费 · 当前价格见数据集页
浏览能力 →pdd拼多多商品月度销量明细表
拼多多 → 拼多多商品月度销量明细表 → dataset=pdd
4 分析任务 · month
公开契约 · 运行时状态以认证环境为准
浏览能力 →tmall天猫商品月度销量明细表
天猫 → 天猫商品月度销量明细表 → dataset=tmall
13 分析任务 · month
Credits 计费 · 当前价格见数据集页
浏览能力 →输出纪律
- 先用用户语言给出业务结论;API 字段名和实现细节只在有助于用户行动时说明。
- 说明服务端实际解析的时间范围和业务范围;未限定品类时,要明确结果覆盖全部可用类目。
- 说明 API 返回的数据覆盖范围和指标口径。
- 区分服务端返回指标与 Agent 计算结果。
- 币种、单位、精度和数量级以数据集契约返回值为准。
- 说明与用户有关的限制、授权或歧义,省略例行工具发现和内部重试。
- API Key 仅用于 MCP 认证。
错误恢复
approval_staleask_userbilling_unavailableretrycap_exceedednarrow_queryconcurrency_limitedretrydata_range_unavailablenarrow_querydictionary_unavailableask_userdownload_cap_exceededstopforbiddenstopidempotency_conflictstopidempotency_failedretryidempotency_in_progressretryidempotency_replaystopinsufficient_creditsstopinvalid_querynarrow_queryinvalid_referenceask_usermax_credits_requiredask_usernot_foundstoppricing_snapshot_mismatchretrypricing_unavailableretrypricing_unconfiguredstopquery_queue_fullretryquery_queue_timeoutretryquery_too_broadnarrow_queryrate_limitedretrytask_not_supportedretryunauthorizedstopunknown_fieldnarrow_queryupstream_busyretryvalue_search_unsupportedstop