Files
dingtalk-workspace-cli/skills/multi/dingtalk-devdoc/references/devdoc.md
T
539d10f80f feat: 合并 pre-mcp-discovery 分支能力到 main(服务发现保持生产) (#391)
将 test/pre-mcp-discovery 分支上多位同学的能力改动整体合入 main,
服务发现端点保持生产 https://mcp.dingtalk.com,未携带分支上的预发改动。

主要内容:
- 修雨域(chat / report / todo / contact / mail)对齐 wukong 基线 (#355)
- DWS 内容生产能力增强 (#387)、文档导出与 OA 对齐 (#362 #388 #390)
- envelope 注册 cli.Aliases 为 cobra aliases、命令结构与 JSON 解析优化
- skills 多包同步 wukong 对齐内容(attendance/calendar/minutes/oa/sheet 等)
- product/oa 进一步对齐 wukong

排除项:未携带 566b4e1(test: point service discovery to pre-mcp.dingtalk.com);
以下 4 个常量保持生产:skill_command.go / auth/endpoints.go / cli/loader.go / market/registry.go。

Co-authored-by: john <32427341+wqyenjoy@users.noreply.github.com>
Co-authored-by: wxianfeng <wang.fl1429@gmail.com>
2026-06-02 21:04:12 +08:00

2.1 KiB

开放平台文档 (devdoc) 命令参考

搜索钉钉开放平台开发文档,用于回答开发者关于 OpenAPI、字段、错误码、接入指南、配额等技术问题。

命令总览

搜索开发文档

Usage:
  dws devdoc article search [flags]
Example:
  dws devdoc article search "MCP"
  dws devdoc article search --query "OAuth2 接入"
  dws devdoc article search --keyword "机器人" --size 10
  dws devdoc article search --query "消息卡片" --page 2 --size 5
Flags:
      --query string     搜索关键词 (必填)
      --keyword string   搜索关键词 (--query 的别名)
      --page int         分页页码 (从 1 开始,默认 1)
      --size int         分页大小 (默认 10)

意图判断

用户问开放平台 API / 字段 / 错误码 / SDK / 鉴权 / 回调 / 配额相关的技术细节:

  • 走 devdoc article search,把用户问的关键短语作为位置参数或 --query

关键区分:

  • devdoc(钉钉开放平台开发者文档,面向研发) vs doc(钉钉在线文档,面向普通用户内容)
  • devdoc 只做搜索,不做读取;命中条目返回标题、摘要、文档链接,由 Agent 引用链接或进一步浏览

核心工作流

# 开发者问"OAuth2 怎么接"
dws devdoc article search --query "OAuth2 接入" --format json

# 简短关键词可直接作为位置参数
dws devdoc article search "MCP" --format json

# 命中结果多时翻页
dws devdoc article search --query "消息卡片" --page 2 --size 5 --format json

# 查错误码 / 字段含义
dws devdoc article search --query "errcode 40078" --format json

注意事项

  • 关键词必填;可用位置参数、--query 或兼容别名 --keyword。建议传用户原话里的关键名词(API 名、错误码、能力名),不要过度改写
  • 返回按相关性排序,默认 --size 10;要拿更多结果时先翻页,再考虑换关键词
  • 命中结果里的链接是钉钉开放平台公开文档,可直接给用户做参考
  • 不要把 devdoc 用来查业务数据(那是 aitable / doc / report 的事);devdoc 只查官方开发者文档