# Asklear Developer Docs

> Machine-readable index of the Asklear developer documentation; fetch any `.md` link below for the full page text.
> Asklear Agent 文档全站机器可读索引；抓取下方任意 `.md` 链接即可获得对应页面全文。

## Guide / 指南

- [Asklear Developer Docs / Asklear 开发者文档](/docs/agent/index.md): workflow routes, output policy, and error recovery entry / 工作流路径、输出纪律与错误恢复入口
- [Getting started / 开始接入](/docs/agent/getting-started.md): MCP onboarding and completion criteria / MCP 接入步骤与完成标准
- [Developer workflow / 开发者工作流](/docs/agent/workflow.md): decision routes, rules, and billing policy / 决策路径、规则与计费策略
- [MCP integration and query reference / MCP 接入与查询参考](/docs/agent/for-agents.md): connection and query reference / MCP 接入与查询参考

## Clients / 客户端

- [Codex · Asklear MCP](/docs/agent/clients/codex.md): MCP configuration for Codex / Codex 的 MCP 配置
- [Claude Code · Asklear MCP](/docs/agent/clients/claude_code.md): MCP configuration for Claude Code / Claude Code 的 MCP 配置
- [Manus · Asklear MCP](/docs/agent/clients/manus.md): MCP configuration for Manus / Manus 的 MCP 配置
- [OpenClaw · Asklear MCP](/docs/agent/clients/openclaw.md): MCP configuration for OpenClaw / OpenClaw 的 MCP 配置
- [Hermes · Asklear MCP](/docs/agent/clients/hermes.md): MCP configuration for Hermes / Hermes 的 MCP 配置
- [WorkBuddy · Asklear MCP](/docs/agent/clients/workbuddy.md): MCP configuration for WorkBuddy / WorkBuddy 的 MCP 配置
- [QoderWork · Asklear MCP](/docs/agent/clients/qoderwork.md): MCP configuration for QoderWork / QoderWork 的 MCP 配置
- [Trae Work · Asklear MCP](/docs/agent/clients/trae.md): MCP configuration for Trae Work / Trae Work 的 MCP 配置

## Datasets / 数据集

- [Douyin Monthly Product Sales / 抖音商品月度销量明细表](/docs/agent/datasets/douyin.md): Douyin / 抖音 → Douyin Monthly Product Sales / 抖音商品月度销量明细表 → `dataset=douyin`
- [JD Monthly Product Sales / 京东商品月度销量明细表](/docs/agent/datasets/jd.md): JD / 京东 → JD Monthly Product Sales / 京东商品月度销量明细表 → `dataset=jd`
- [PDD Monthly Product Sales / 拼多多商品月度销量明细表](/docs/agent/datasets/pdd.md): PDD / 拼多多 → PDD Monthly Product Sales / 拼多多商品月度销量明细表 → `dataset=pdd`
- [Tmall Monthly Product Sales / 天猫商品月度销量明细表](/docs/agent/datasets/tmall.md): Tmall / 天猫 → Tmall Monthly Product Sales / 天猫商品月度销量明细表 → `dataset=tmall`

### `douyin` tasks / 任务

- [Aggregate and product drilldown / 汇总与商品下钻](/docs/agent/datasets/douyin/tasks/aggregate_drilldown.md): Query a category scope, then rank products under the same filters. / 先查询品类汇总，再在相同筛选条件下对商品排名。
- [Brand share / 品牌份额](/docs/agent/datasets/douyin/tasks/brand_share.md): Compute brand share from two atomic GMV results. / 通过两个原子销售额结果计算品牌份额。
- [Category product ranking / 品类商品排名](/docs/agent/datasets/douyin/tasks/category_product_ranking.md): Rank exact product IDs within a resolved category. / 在已对齐的品类内对商品 ID 排名。
- [Douyin daily product performance / 抖音商品每日表现](/docs/agent/datasets/douyin/tasks/product_performance.md): Query daily sales metrics for one exact product within month-partitioned coverage. / 在按月分区的数据范围内，查询一个精确商品的每日销售指标。
- [Shop performance by name / 按店铺名查询销售表现](/docs/agent/datasets/douyin/tasks/shop_name_performance.md): Resolve a shop name and query monthly metrics. / 对齐店铺名并查询月度指标。

### `jd` tasks / 任务

- [Aggregate and product drilldown / 汇总与商品下钻](/docs/agent/datasets/jd/tasks/aggregate_drilldown.md): Query an aggregate scope, then rank products under exactly the same filters. / 先查询汇总范围，再在完全相同的筛选条件下对商品下钻排序。
- [Brand share / 品牌份额](/docs/agent/datasets/jd/tasks/brand_share.md): Compute a brand's share from two atomic GMV results returned by one bundled call. / 通过一次组合调用返回的两个原子销售额结果计算品牌份额。
- [Brand trend / 品牌趋势](/docs/agent/datasets/jd/tasks/brand_trend.md): Query monthly atomic metrics for one exact brand. / 查询一个精确品牌的月度原子指标。
- [Category product ranking / 品类商品排名](/docs/agent/datasets/jd/tasks/category_product_ranking.md): Rank exact product IDs within a resolved category and time range. / 在已对齐的品类和时间范围内对精确商品 ID 排名。
- [Cross-period product sets / 跨期商品集合](/docs/agent/datasets/jd/tasks/cross_period_products.md): Compare product-ID sets returned by one bundled period call. / 比较一次组合调用返回的两个期间商品 ID 集合。
- [Product comparison / 商品比较](/docs/agent/datasets/jd/tasks/product_comparison.md): Compare multiple exact JD product references over one time range. / 在同一时间范围内比较多个精确京东商品引用。
- [Product contribution to change / 商品变化贡献](/docs/agent/datasets/jd/tasks/product_contribution.md): Attribute cross-period GMV change from two product-level atomic queries. / 通过两次商品级原子查询归因跨期销售额变化。
- [Product performance / 商品销售表现](/docs/agent/datasets/jd/tasks/product_performance.md): Query monthly sales metrics for one exact JD product reference. / 查询一个精确京东商品引用的月度销售指标。
- [Shop performance by name / 按店铺名查询销售表现](/docs/agent/datasets/jd/tasks/shop_name_performance.md): Resolve one spoken shop name and query its monthly atomic metrics. / 对齐一个口语店铺名并查询月度原子指标。
- [Shop performance / 店铺销售表现](/docs/agent/datasets/jd/tasks/shop_performance.md): Query monthly atomic metrics for one exact JD shop ID or standard URL. / 按精确京东店铺 ID 或标准链接查询月度原子指标。

### `pdd` tasks / 任务

- [Aggregate and product drilldown / 汇总与商品下钻](/docs/agent/datasets/pdd/tasks/aggregate_drilldown.md): Query a category scope, then rank products under the same filters. / 先查询品类汇总，再在相同筛选条件下对商品排名。
- [Brand share / 品牌份额](/docs/agent/datasets/pdd/tasks/brand_share.md): Compute brand share from two atomic GMV results. / 通过两个原子销售额结果计算品牌份额。
- [Category product ranking / 品类商品排名](/docs/agent/datasets/pdd/tasks/category_product_ranking.md): Rank exact product IDs within a resolved category. / 在已对齐的品类内对商品 ID 排名。
- [Shop performance by name / 按店铺名查询销售表现](/docs/agent/datasets/pdd/tasks/shop_name_performance.md): Resolve a shop name and query monthly metrics. / 对齐店铺名并查询月度指标。

### `tmall` tasks / 任务

- [Aggregate and product drilldown / 汇总与商品下钻](/docs/agent/datasets/tmall/tasks/aggregate_drilldown.md): Query an aggregate scope, then rank products under exactly the same filters. / 先查询汇总范围，再在完全相同的筛选条件下对商品下钻排序。
- [B/C shop comparison / B/C 店铺比较](/docs/agent/datasets/tmall/tasks/bc_shop_comparison.md): Compare monthly atomic sales metrics across normalized B/C shop groups. / 按归一化后的 B/C 店铺分组比较月度原子销售指标。
- [Brand share / 品牌份额](/docs/agent/datasets/tmall/tasks/brand_share.md): Compute a brand's share from two atomic GMV results returned by one bundled call. / 通过一次组合调用返回的两个原子销售额结果计算品牌份额。
- [Brand trend / 品牌趋势](/docs/agent/datasets/tmall/tasks/brand_trend.md): Query monthly atomic metrics for one exact brand. / 查询一个精确品牌的月度原子指标。
- [Subsidy indicator coverage / 百亿补贴标识覆盖](/docs/agent/datasets/tmall/tasks/bybt_coverage.md): Inspect monthly atomic sales metrics grouped by the normalized subsidy indicator. / 按归一化后的百亿补贴标识分组查看月度原子销售指标。
- [Category product ranking / 品类商品排名](/docs/agent/datasets/tmall/tasks/category_product_ranking.md): Rank exact product IDs within a resolved category and time range. / 在已对齐的品类和时间范围内对精确商品 ID 排名。
- [Cross-period product sets / 跨期商品集合](/docs/agent/datasets/tmall/tasks/cross_period_products.md): Compare product-ID sets returned by one bundled period call. / 比较一次组合调用返回的两个期间商品 ID 集合。
- [Live-commerce sales comparison / 直播商品销售比较](/docs/agent/datasets/tmall/tasks/live_sales_comparison.md): Compare monthly atomic sales metrics by the normalized live-commerce indicator. / 按归一化后的直播标识比较月度原子销售指标。
- [Product comparison / 商品比较](/docs/agent/datasets/tmall/tasks/product_comparison.md): Compare multiple exact Tmall product references over one time range. / 在同一时间范围内比较多个精确天猫商品引用。
- [Product contribution to change / 商品变化贡献](/docs/agent/datasets/tmall/tasks/product_contribution.md): Attribute cross-period GMV change from two product-level atomic queries. / 通过两次商品级原子查询归因跨期销售额变化。
- [Product performance / 商品销售表现](/docs/agent/datasets/tmall/tasks/product_performance.md): Query monthly sales metrics for one exact Tmall product reference. / 查询一个精确天猫商品引用的月度销售指标。
- [Shop performance by name / 按店铺名查询销售表现](/docs/agent/datasets/tmall/tasks/shop_name_performance.md): Resolve one spoken shop name and query its monthly atomic metrics. / 对齐一个口语店铺名并查询月度原子指标。
- [Shop performance / 店铺销售表现](/docs/agent/datasets/tmall/tasks/shop_performance.md): Query monthly atomic metrics for one exact Tmall shop ID or standard URL. / 按精确天猫店铺 ID 或标准链接查询月度原子指标。

## Errors / 错误码

- [approval_stale](/docs/agent/errors/approval_stale.md): The approved query plan changed before execution and must be approved again. / 执行前查询计划已变化，需要重新确认。
- [billing_unavailable](/docs/agent/errors/billing_unavailable.md): The billing service is temporarily unavailable and the operation was not charged. / 计费服务暂时不可用，本次操作未扣费。
- [cap_exceeded](/docs/agent/errors/cap_exceeded.md): The approved or configured credit cap is below the current upper bound. / 已同意或已配置的 Credits 上限低于当前费用上界。
- [concurrency_limited](/docs/agent/errors/concurrency_limited.md): Wait for an in-flight request to finish before retrying once. / 等待进行中的请求完成后再重试一次。
- [data_range_unavailable](/docs/agent/errors/data_range_unavailable.md): The request includes dataset months that have not been published for serving. / 请求包含尚未发布到查询服务的数据月份。
- [dictionary_unavailable](/docs/agent/errors/dictionary_unavailable.md): Ask for an exact value or choose another searchable field; do not guess. / 请用户提供精确值或改用其他可搜索字段，不要猜测。
- [download_cap_exceeded](/docs/agent/errors/download_cap_exceeded.md): Stop because the monthly download traffic cap has been reached. / 本月下载流量已达到上限时停止。
- [forbidden](/docs/agent/errors/forbidden.md): Stop and explain that the authenticated tenant lacks access. / 停止并说明当前租户没有访问权限。
- [idempotency_conflict](/docs/agent/errors/idempotency_conflict.md): The idempotency key was already used for a different payload. / 该幂等键已用于另一组请求参数。
- [idempotency_failed](/docs/agent/errors/idempotency_failed.md): The earlier idempotent operation failed and has no downloadable result. / 此前的幂等操作失败，没有可下载结果。
- [idempotency_in_progress](/docs/agent/errors/idempotency_in_progress.md): An identical request with this idempotency key is still running. / 使用该幂等键的相同请求仍在执行。
- [idempotency_replay](/docs/agent/errors/idempotency_replay.md): This request already finished and was not executed or charged again. / 该请求已经完成，本次没有重复执行或扣费。
- [insufficient_credits](/docs/agent/errors/insufficient_credits.md): Stop before querying and explain that more credits are required. / 查询前停止，并说明需要更多 Credits。
- [invalid_query](/docs/agent/errors/invalid_query.md): Correct or narrow the request using the returned validation details. / 根据返回的校验信息修正或缩小请求。
- [invalid_reference](/docs/agent/errors/invalid_reference.md): Ask for an exact supported entity reference. / 请用户提供受支持的精确实体引用。
- [max_credits_required](/docs/agent/errors/max_credits_required.md): The operation's safe upper bound exceeds the key's auto-run threshold; obtain explicit approval before executing. / 本次操作的安全费用上界超过密钥自动执行阈值；执行前需要用户明确同意。
- [not_found](/docs/agent/errors/not_found.md): Stop because the referenced public resource does not exist or is no longer available. / 引用的公共资源不存在或已不可用时停止。
- [pricing_snapshot_mismatch](/docs/agent/errors/pricing_snapshot_mismatch.md): The execution plan no longer matches its approved pricing snapshot. / 执行计划已不再匹配获批时的计价快照。
- [pricing_unavailable](/docs/agent/errors/pricing_unavailable.md): Pricing could not be finalized, so no result was delivered or charged. / 计价未能完成，因此没有交付结果，也没有扣费。
- [pricing_unconfigured](/docs/agent/errors/pricing_unconfigured.md): Stop because the server cannot produce a valid price for this request. / 服务端无法为该请求生成有效价格时停止。
- [query_queue_full](/docs/agent/errors/query_queue_full.md): Wait for Retry-After and retry the same request once. / 等待 Retry-After 后对同一请求重试一次。
- [query_queue_timeout](/docs/agent/errors/query_queue_timeout.md): The request timed out while waiting for query capacity. / 请求在等待查询容量时超时。
- [query_too_broad](/docs/agent/errors/query_too_broad.md): The query exceeded the server's physical work hard limit. / 查询超过服务端物理工作硬上限。
- [rate_limited](/docs/agent/errors/rate_limited.md): Wait for Retry-After before retrying; never retry in a tight loop. / 等待 Retry-After 指定的时间后再重试，禁止紧密循环重试。
- [task_not_supported](/docs/agent/errors/task_not_supported.md): The requested recipe is unavailable; this does not mean the analytical query is unsupported. / 请求的 recipe 不存在，但不代表分析查询不受支持。
- [unauthorized](/docs/agent/errors/unauthorized.md): Stop because the MCP credential is missing, invalid, disabled, or revoked. / MCP 凭据缺失、无效、停用或已吊销时停止。
- [unknown_field](/docs/agent/errors/unknown_field.md): Replace the guessed field with one returned by describe. / 将猜测字段改为 describe 返回的字段。
- [upstream_busy](/docs/agent/errors/upstream_busy.md): Retry once after the returned delay; then narrow the query or stop. / 按返回的等待时间重试一次；仍失败则缩小查询或停止。
- [value_search_unsupported](/docs/agent/errors/value_search_unsupported.md): Do not guess or repeatedly search an unsupported field. / 不要猜测或循环搜索不支持的字段。

## Pricing / 价格

- [JD Monthly Product Sales credit pricing / 京东商品月度销量明细表 Credit 价格](/api/public/credit-pricing?dataset=jd&format=markdown): current active credit pricing document / 当前生效的 Credit 价格说明
- [Tmall Monthly Product Sales credit pricing / 天猫商品月度销量明细表 Credit 价格](/api/public/credit-pricing?dataset=tmall&format=markdown): current active credit pricing document / 当前生效的 Credit 价格说明
- `douyin`: no public pricing, query, or billing is listed here; authenticated runtime status is authoritative.
- `pdd`: no public pricing, query, or billing is listed here; authenticated runtime status is authoritative.