---
document_id: agent.guide
schema_version: 1
---

<!-- Generated by scripts.build_agent_guide; do not edit. -->

# Asklear Developer Docs / Asklear 开发者文档

Query directly by default; discovery is an error-recovery path, not preflight.
默认直接查询；发现能力用于错误恢复，不是前置检查。

## Getting started / 开始接入

- [Getting started / 开始接入](/docs/agent/getting-started.md)
- [MCP integration and query reference / MCP 接入与查询参考](/docs/agent/for-agents.md)

## Workflow / 工作流

- Exact reference or known fields: `query_metrics` (1 call)
- User-supplied brand, shop, or category name: `search_values` → `query_metrics` (2 calls)
- Multiple analyses: one bundled `query_metrics` call
- Unknown dataset or capability error: discover/describe, then retry once

- [Developer workflow](/docs/agent/workflow.md)

## Datasets / 数据集

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

## Output policy / 输出纪律

- Lead with the business conclusion in the user's language; include API fields or implementation details only when they help the user act.
  先用用户语言给出业务结论；API 字段名和实现细节只在有助于用户行动时说明。
- State the resolved time window and business scope, including when the result covers all available categories rather than one named category.
  说明服务端实际解析的时间范围和业务范围；未限定品类时，要明确结果覆盖全部可用类目。
- State the data coverage and metric definitions returned by the API.
  说明 API 返回的数据覆盖范围和指标口径。
- Distinguish server-returned metrics from Agent-computed results.
  区分服务端返回指标与 Agent 计算结果。
- Use only the currency, unit, precision, and scale returned by the dataset contract.
  币种、单位、精度和数量级以数据集契约返回值为准。
- Explain user-relevant limitations, approvals, or ambiguities without narrating routine discovery and retries.
  说明与用户有关的限制、授权或歧义，省略例行工具发现和内部重试。
- Keep API keys confined to MCP authentication.
  API Key 仅用于 MCP 认证。

## Error recovery / 错误恢复

Read the `.md` URL in `error.documentation.url` and follow its Agent action.
读取 `error.documentation.url` 指向的 `.md`，按其中的 Agent 动作恢复。