Files
dingtalk-workspace-cli/internal/cli/schema_catalog/tools/devdoc.json
T
玉澜andCursor 31cade34ff feat(schema): finish ParamDecl migration for remaining overlays
Move the last hint parameter overlays into in-code ParamDecls (helpers +
shortcuts), regenerate catalog, and harden the migrate script for factory
and Use/RPC matching so all 74 overlay tools are declaration-backed.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-08-01 09:43:21 +08:00

743 lines
26 KiB
JSON

{
"product": "devdoc",
"tools": {
"devdoc.search_open_platform_docs_rag": {
"agent_metadata_source": "corecmd.contract",
"agent_source_refs": [
"corecmd.SchemaDecl"
],
"agent_summary": "搜索钉钉开放平台开发文档,返回资料与链接(不生成分析答案)",
"agent_summary_source": "corecmd.SchemaDecl",
"availability": "available",
"avoid_when": [
"搜索用户业务文档用 drive/wiki/doc,不要用 devdoc",
"要执行开放平台应用配置变更时用 dev"
],
"canonical_path": "devdoc.search_open_platform_docs_rag",
"cli_name": "search",
"cli_path": "devdoc article search",
"confirmation": "not_required",
"constraints": {
"require_one_of": [
[
"query",
"keyword"
]
]
},
"description": "按关键词搜索 open.dingtalk.com 文档,支持分页。默认表格输出,可用 -f json 获取完整响应。",
"display": "开放平台文档搜索",
"effect": "read",
"effect_source": "corecmd.contract",
"examples": [
"dws devdoc article search --query \"OAuth2 接入\" --format json",
"dws devdoc article search --query \"errcode 40078\" --format json"
],
"field_provenance": {
"agent_summary": {
"candidates": [
{
"precedence": "contract_final",
"review_reason": "Contract final Schema pass-through",
"selected": true,
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": "搜索钉钉开放平台开发文档,返回资料与链接(不生成分析答案)"
}
],
"precedence": "contract_final",
"resolution": "contract_pass_through",
"review_reason": "Contract final Schema pass-through",
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": "搜索钉钉开放平台开发文档,返回资料与链接(不生成分析答案)"
},
"availability": {
"candidates": [
{
"precedence": "contract_final",
"review_reason": "Contract final Schema pass-through",
"selected": true,
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": "available"
}
],
"precedence": "contract_final",
"resolution": "contract_pass_through",
"review_reason": "Contract final Schema pass-through",
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": "available"
},
"avoid_when": {
"candidates": [
{
"precedence": "contract_final",
"review_reason": "Contract final Schema pass-through",
"selected": true,
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": [
"搜索用户业务文档用 drive/wiki/doc,不要用 devdoc",
"要执行开放平台应用配置变更时用 dev"
]
}
],
"precedence": "contract_final",
"resolution": "contract_pass_through",
"review_reason": "Contract final Schema pass-through",
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": [
"搜索用户业务文档用 drive/wiki/doc,不要用 devdoc",
"要执行开放平台应用配置变更时用 dev"
]
},
"canonical_path": {
"candidates": [
{
"precedence": "contract_final",
"review_reason": "Contract final Schema pass-through",
"selected": true,
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": "devdoc.search_open_platform_docs_rag"
}
],
"precedence": "contract_final",
"resolution": "contract_pass_through",
"review_reason": "Contract final Schema pass-through",
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": "devdoc.search_open_platform_docs_rag"
},
"confirmation": {
"candidates": [
{
"precedence": "contract_final",
"review_reason": "Contract final Schema pass-through",
"selected": true,
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": "not_required"
}
],
"precedence": "contract_final",
"resolution": "contract_pass_through",
"review_reason": "Contract final Schema pass-through",
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": "not_required"
},
"description": {
"candidates": [
{
"precedence": "contract_final",
"review_reason": "Contract final Schema pass-through",
"selected": true,
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": "按关键词搜索 open.dingtalk.com 文档,支持分页。默认表格输出,可用 -f json 获取完整响应。"
}
],
"precedence": "contract_final",
"resolution": "contract_pass_through",
"review_reason": "Contract final Schema pass-through",
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": "按关键词搜索 open.dingtalk.com 文档,支持分页。默认表格输出,可用 -f json 获取完整响应。"
},
"effect": {
"candidates": [
{
"precedence": "contract_final",
"review_reason": "Contract final Schema pass-through",
"selected": true,
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": "read"
}
],
"precedence": "contract_final",
"resolution": "contract_pass_through",
"review_reason": "Contract final Schema pass-through",
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": "read"
},
"examples": {
"candidates": [
{
"precedence": "contract_final",
"review_reason": "Contract final Schema pass-through",
"selected": true,
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": [
"dws devdoc article search --query \"OAuth2 接入\" --format json",
"dws devdoc article search --query \"errcode 40078\" --format json"
]
}
],
"precedence": "contract_final",
"resolution": "contract_pass_through",
"review_reason": "Contract final Schema pass-through",
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": [
"dws devdoc article search --query \"OAuth2 接入\" --format json",
"dws devdoc article search --query \"errcode 40078\" --format json"
]
},
"idempotency": {
"candidates": [
{
"precedence": "contract_final",
"review_reason": "Contract final Schema pass-through",
"selected": true,
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": "idempotent"
}
],
"precedence": "contract_final",
"resolution": "contract_pass_through",
"review_reason": "Contract final Schema pass-through",
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": "idempotent"
},
"interface_mode": {
"candidates": [
{
"precedence": "contract_final",
"review_reason": "Contract final Schema pass-through",
"selected": true,
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": "mcp"
}
],
"precedence": "contract_final",
"resolution": "contract_pass_through",
"review_reason": "Contract final Schema pass-through",
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": "mcp"
},
"interface_ref": {
"candidates": [
{
"precedence": "contract_final",
"review_reason": "Contract final Schema pass-through",
"selected": true,
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": {
"product_id": "devdoc",
"rpc_name": "search_open_platform_docs"
}
}
],
"precedence": "contract_final",
"resolution": "contract_pass_through",
"review_reason": "Contract final Schema pass-through",
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": {
"product_id": "devdoc",
"rpc_name": "search_open_platform_docs"
}
},
"metadata_source": {
"candidates": [
{
"precedence": "contract_final",
"review_reason": "Contract final Schema pass-through",
"selected": true,
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": "corecmd.contract"
}
],
"precedence": "contract_final",
"resolution": "contract_pass_through",
"review_reason": "Contract final Schema pass-through",
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": "corecmd.contract"
},
"reviewed": {
"candidates": [
{
"precedence": "contract_final",
"review_reason": "Contract final Schema pass-through",
"selected": true,
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": true
}
],
"precedence": "contract_final",
"resolution": "contract_pass_through",
"review_reason": "Contract final Schema pass-through",
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": true
},
"risk": {
"candidates": [
{
"precedence": "contract_final",
"review_reason": "Contract final Schema pass-through",
"selected": true,
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": "low"
}
],
"precedence": "contract_final",
"resolution": "contract_pass_through",
"review_reason": "Contract final Schema pass-through",
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": "low"
},
"title": {
"candidates": [
{
"precedence": "contract_final",
"review_reason": "Contract final Schema pass-through",
"selected": true,
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": "搜索开放平台文档"
}
],
"precedence": "contract_final",
"resolution": "contract_pass_through",
"review_reason": "Contract final Schema pass-through",
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": "搜索开放平台文档"
},
"use_when": {
"candidates": [
{
"precedence": "contract_final",
"review_reason": "Contract final Schema pass-through",
"selected": true,
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": [
"查 OpenAPI、字段、错误码、OAuth2、接入指南等开放平台开发问题"
]
}
],
"precedence": "contract_final",
"resolution": "contract_pass_through",
"review_reason": "Contract final Schema pass-through",
"source": "corecmd.contract",
"source_ref": "corecmd.SchemaDecl",
"value": [
"查 OpenAPI、字段、错误码、OAuth2、接入指南等开放平台开发问题"
]
}
},
"group": "article",
"has_parameters": true,
"idempotency": "idempotent",
"interface_mode": "mcp",
"interface_ref": {
"product_id": "devdoc",
"rpc_name": "search_open_platform_docs"
},
"is_alias": false,
"metadata_source": "corecmd.contract",
"name": "search_open_platform_docs_rag",
"parameter_count": 3,
"parameters": {
"page": {
"default": "1",
"description": "页码,默认 1",
"field_provenance": {
"description": {
"candidates": [
{
"precedence": "cobra_contract",
"selected": true,
"source": "cobra_usage",
"value": "页码,默认 1"
},
{
"precedence": "mcp_metadata",
"selected": false,
"source": "mcp_metadata",
"value": "分页页码"
},
{
"precedence": "default",
"selected": false,
"source": "default",
"value": ""
}
],
"precedence": "cobra_contract",
"resolution": "highest_precedence",
"source": "cobra_usage",
"value": "页码,默认 1"
},
"interface_type": {
"candidates": [
{
"precedence": "mcp_metadata",
"selected": true,
"source": "mcp_metadata",
"value": "number"
},
{
"precedence": "fallback",
"selected": false,
"source": "cobra_flag_type",
"value": "string"
}
],
"precedence": "mcp_metadata",
"resolution": "highest_precedence",
"source": "mcp_metadata",
"value": "number"
},
"property": {
"candidates": [
{
"precedence": "inference",
"selected": true,
"source": "flag_name_inference",
"value": "page"
}
],
"precedence": "inference",
"resolution": "highest_precedence",
"source": "flag_name_inference",
"value": "page"
},
"required": {
"candidates": [
{
"precedence": "cobra_contract",
"selected": true,
"source": "cobra_nonzero_default",
"value": false
},
{
"precedence": "default",
"selected": false,
"source": "default",
"value": false
}
],
"precedence": "cobra_contract",
"resolution": "highest_precedence",
"source": "cobra_nonzero_default",
"value": false
},
"required_when": {
"candidates": [
{
"precedence": "default",
"selected": true,
"source": "default",
"value": ""
}
],
"precedence": "default",
"resolution": "highest_precedence",
"source": "default",
"value": ""
},
"type": {
"candidates": [
{
"precedence": "cobra_contract",
"selected": true,
"source": "cobra_flag_type",
"value": "string"
}
],
"precedence": "cobra_contract",
"resolution": "highest_precedence",
"source": "cobra_flag_type",
"value": "string"
}
},
"interface_description": "分页页码",
"interface_type": "number",
"property": "page",
"required": false,
"type": "string"
},
"query": {
"description": "搜索关键词 (必填)",
"field_provenance": {
"description": {
"candidates": [
{
"precedence": "cobra_contract",
"selected": true,
"source": "cobra_usage",
"value": "搜索关键词 (必填)"
},
{
"precedence": "mcp_metadata",
"selected": false,
"source": "mcp_metadata",
"value": "搜索关键词"
},
{
"precedence": "default",
"selected": false,
"source": "default",
"value": ""
}
],
"precedence": "cobra_contract",
"resolution": "highest_precedence",
"source": "cobra_usage",
"value": "搜索关键词 (必填)"
},
"property": {
"candidates": [
{
"precedence": "versioned_binding",
"selected": true,
"source": "versioned_parameter_binding",
"value": "keyword"
},
{
"precedence": "inference",
"selected": false,
"source": "flag_name_inference",
"value": "query"
}
],
"precedence": "versioned_binding",
"resolution": "highest_precedence",
"source": "versioned_parameter_binding",
"value": "keyword"
},
"required": {
"candidates": [
{
"precedence": "command_constraint",
"selected": true,
"source": "require_one_of_constraint",
"value": false
},
{
"precedence": "native_annotation",
"selected": false,
"source": "native_annotation",
"value": false
},
{
"precedence": "mcp_metadata",
"selected": false,
"source": "mcp_metadata",
"value": true
},
{
"precedence": "inference",
"selected": false,
"source": "usage_required_inference",
"value": true
},
{
"precedence": "default",
"selected": false,
"source": "default",
"value": false
}
],
"precedence": "command_constraint",
"resolution": "highest_precedence",
"source": "require_one_of_constraint",
"value": false
},
"required_when": {
"candidates": [
{
"precedence": "default",
"selected": true,
"source": "default",
"value": ""
}
],
"precedence": "default",
"resolution": "highest_precedence",
"source": "default",
"value": ""
},
"type": {
"candidates": [
{
"precedence": "cobra_contract",
"selected": true,
"source": "cobra_flag_type",
"value": "string"
}
],
"precedence": "cobra_contract",
"resolution": "highest_precedence",
"source": "cobra_flag_type",
"value": "string"
}
},
"interface_description": "搜索关键词",
"property": "keyword",
"required": false,
"type": "string"
},
"size": {
"default": "10",
"description": "每页数量,默认 10",
"field_provenance": {
"description": {
"candidates": [
{
"precedence": "cobra_contract",
"selected": true,
"source": "cobra_usage",
"value": "每页数量,默认 10"
},
{
"precedence": "mcp_metadata",
"selected": false,
"source": "mcp_metadata",
"value": "分页大小"
},
{
"precedence": "default",
"selected": false,
"source": "default",
"value": ""
}
],
"precedence": "cobra_contract",
"resolution": "highest_precedence",
"source": "cobra_usage",
"value": "每页数量,默认 10"
},
"interface_type": {
"candidates": [
{
"precedence": "mcp_metadata",
"selected": true,
"source": "mcp_metadata",
"value": "number"
},
{
"precedence": "fallback",
"selected": false,
"source": "cobra_flag_type",
"value": "string"
}
],
"precedence": "mcp_metadata",
"resolution": "highest_precedence",
"source": "mcp_metadata",
"value": "number"
},
"property": {
"candidates": [
{
"precedence": "inference",
"selected": true,
"source": "flag_name_inference",
"value": "size"
}
],
"precedence": "inference",
"resolution": "highest_precedence",
"source": "flag_name_inference",
"value": "size"
},
"required": {
"candidates": [
{
"precedence": "cobra_contract",
"selected": true,
"source": "cobra_nonzero_default",
"value": false
},
{
"precedence": "default",
"selected": false,
"source": "default",
"value": false
}
],
"precedence": "cobra_contract",
"resolution": "highest_precedence",
"source": "cobra_nonzero_default",
"value": false
},
"required_when": {
"candidates": [
{
"precedence": "default",
"selected": true,
"source": "default",
"value": ""
}
],
"precedence": "default",
"resolution": "highest_precedence",
"source": "default",
"value": ""
},
"type": {
"candidates": [
{
"precedence": "cobra_contract",
"selected": true,
"source": "cobra_flag_type",
"value": "string"
}
],
"precedence": "cobra_contract",
"resolution": "highest_precedence",
"source": "cobra_flag_type",
"value": "string"
}
},
"interface_description": "分页大小",
"interface_type": "number",
"property": "size",
"required": false,
"type": "string"
}
},
"path": "devdoc.search_open_platform_docs_rag",
"positionals": [
{
"description": "搜索关键词;也可通过 --query 传入",
"index": 0,
"name": "keyword",
"required": false,
"type": "string"
}
],
"primary_cli_path": "devdoc article search",
"product_id": "devdoc",
"reviewed": true,
"risk": "low",
"source": "reviewed_command_registry",
"title": "搜索开放平台文档",
"use_when": [
"查 OpenAPI、字段、错误码、OAuth2、接入指南等开放平台开发问题"
]
}
}
}