连接客户端
先把密钥放入QUERYING_API_KEY 环境变量。密钥可在 API 密钥页面获取。
- Claude Code
- Codex
- mcp.json
401。无效密钥会在第一次工具调用时以工具错误的形式报告。
工具
提交任务的工具与相同 API 调用的费用一致。只读工具免费。任务与研究
run_prompt 和 submit_prompt 接受 taskType、prompt,以及可选的 country、idempotencyKey、include 和 page(1 到 10,用于 GOOGLE_SERP 和 NAVER_SERP)。引擎及其价格请参阅引擎,研究输入请参阅 Prompt Research。
COMMERCE_SERP 用 site 和 query 代替 prompt,limit(1 到 40)可选;请参阅 Commerce Search。read_product 接受 url,以及可选的 country 和 idempotencyKey;请参阅 Commerce Product。
run_product_lookup 接受 product、country 以及可选的 competitors、prompts、engines 和 idempotencyKey,参见 Product Lookup。默认返回摘要:每个商品包含展示它的引擎、价格区间、前 10 个卖家和引用网站,以及每个引擎一行对比;每个购物提示词包含各引擎展示或提及的商品。约为完整响应的十分之一。需要所有商品记录、引用页面和任务 id 时,传入 detail: "full"。
GEO 监测
每个监测器工具都用你的密钥发起一次 API 调用,因此所有权、密钥范围和套餐限制与 REST 相同。参见 GEO 监测。超时
run_prompt、scrape_page、read_product 和 research_prompts 会轮询直到任务结束。它们最多等待 timeoutSeconds(默认 180,最大 900)。如果任务仍在运行,工具返回带有 taskId 的 TASK_TIMEOUT 错误。任务会继续运行;用该 id 调用 get_task 即可获取结果。
run_product_lookup 以同样方式轮询。默认等待 210 秒,以便在 240 秒的客户端超时内结束,多数查询在 2 到 3 分钟内完成。如果查询仍在运行,工具返回带有 lookupId 的 LOOKUP_TIMEOUT 错误;用该 id 调用 get_product_lookup。
请把客户端的工具超时设得比 timeoutSeconds 更长。Codex 示例针对默认的 180 秒使用了 tool_timeout_sec = 240。如果客户端只允许较短的工具调用,请先用 submit_prompt,再用 get_task。