dingtalk-workspace-cli/internal/cli/schema_hints/metadata/doc.json

{
  "version": 1,
  "source": {
    "kind": "explicit",
    "name": "dws-tool-metadata/doc",
    "repository": "DingTalk-Real-AI/dingtalk-workspace-cli",
    "channel": "open-source",
    "reviewed": true
  },
  "tools": {
    "doc.add_permission": {
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true
    },
    "doc.copy_document": {
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true
    },
    "doc.create_comment": {
      "effect": "write",
      "risk": "medium",
      "confirmation": "not_required",
      "idempotency": "unknown",
      "interface_ref": {
        "product_id": "doc-comment",
        "rpc_name": "create_comment"
      },
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true,
      "parameters": {
        "mentioned-open-conversation-id": {
          "required": false,
          "interface_type": "array"
        }
      },
      "review_reason": "The reviewed handler normalizes repeated or comma-separated group conversation IDs into a stable de-duplicated array while preserving existing user mentions.",
      "cli_path": "doc comment create",
      "runtime_gate": "none"
    },
    "doc.create_document": {
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true
    },
    "doc.create_file": {
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true
    },
    "doc.create_folder": {
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true
    },
    "doc.create_inline_comment": {
      "interface_ref": {
        "product_id": "doc-comment",
        "rpc_name": "create_inline_comment"
      },
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true
    },
    "doc.delete_comment": {
      "effect": "write",
      "risk": "medium",
      "confirmation": "user_required",
      "idempotency": "unknown",
      "interface_mode": "composite",
      "availability": "available",
      "interface_reason": "Reviewed unpinned remote adapter: this executable CLI wrapper calls a remote helper that is absent from the pinned MCP metadata snapshot; no single pinned semantically equivalent interface_ref can represent the command.",
      "reviewed": true,
      "runtime_gate": "confirm_dangerous"
    },
    "doc.delete_document": {
      "effect": "destructive",
      "risk": "high",
      "confirmation": "user_required",
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true,
      "runtime_gate": "confirm_delete"
    },
    "doc.delete_document_block": {
      "effect": "destructive",
      "risk": "high",
      "confirmation": "user_required",
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true,
      "runtime_gate": "confirm_delete"
    },
    "doc.download_doc_attachment": {
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true
    },
    "doc.download_file": {
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true
    },
    "doc.get_document_content": {
      "effect": "read",
      "risk": "low",
      "confirmation": "not_required",
      "idempotency": "idempotent",
      "interface_ref": {
        "product_id": "doc",
        "rpc_name": "get_document_content"
      },
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true,
      "parameters": {
        "content-format": {
          "property": "format",
          "required": false
        },
        "scope": {
          "required": false
        },
        "tags": {
          "required": false,
          "required_when": "--scope=tags"
        },
        "max-depth": {
          "required": false,
          "interface_type": "integer"
        },
        "start-block-id": {
          "required": false,
          "required_when": "--scope=range or --scope=section"
        },
        "end-block-id": {
          "required": false
        }
      },
      "review_reason": "The reviewed handler preserves full Markdown/JSONML reads and adds validated outline, range, section, and tag-scoped JSONML fragment reads with optional file output.",
      "cli_path": "doc read",
      "runtime_gate": "none"
    },
    "doc.get_document_info": {
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true
    },
    "doc.import_get": {
      "effect": "write",
      "risk": "medium",
      "confirmation": "not_required",
      "idempotency": "unknown",
      "interface_mode": "composite",
      "availability": "available",
      "interface_reason": "Reviewed unpinned remote adapter: this executable CLI wrapper calls a remote helper that is absent from the pinned MCP metadata snapshot; no single pinned semantically equivalent interface_ref can represent the command.",
      "reviewed": true,
      "review_reason": "migrated to reviewed metadata block"
    },
    "doc.insert_document_block": {
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true
    },
    "doc.list_comments": {
      "interface_ref": {
        "product_id": "doc-comment",
        "rpc_name": "list_comments"
      },
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true
    },
    "doc.list_document_blocks": {
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true
    },
    "doc.list_nodes": {
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true
    },
    "doc.list_permission": {
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true
    },
    "doc.media_insert": {
      "effect": "write",
      "risk": "medium",
      "interface_mode": "composite",
      "availability": "available",
      "interface_reason": "命令包含多个 RPC、条件分派或本地 HTTP/文件步骤，不能绑定为单一 interface_ref",
      "reviewed": true
    },
    "doc.move_document": {
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true
    },
    "doc.query_export_job": {
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true
    },
    "doc.remove_permission": {
      "effect": "write",
      "risk": "medium",
      "confirmation": "not_required",
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true,
      "runtime_gate": "none"
    },
    "doc.rename_document": {
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true
    },
    "doc.reply_comment": {
      "effect": "write",
      "risk": "medium",
      "confirmation": "not_required",
      "idempotency": "unknown",
      "interface_ref": {
        "product_id": "doc-comment",
        "rpc_name": "reply_comment"
      },
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true,
      "parameters": {
        "mentioned-open-conversation-id": {
          "required": false,
          "interface_type": "array"
        }
      },
      "review_reason": "The reviewed handler normalizes group conversation IDs into a stable de-duplicated array and rejects group mentions for emoji replies, which the remote operation does not support.",
      "cli_path": "doc comment reply",
      "runtime_gate": "none"
    },
    "doc.search_documents": {
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true
    },
    "doc.template_apply": {
      "effect": "write",
      "risk": "medium",
      "confirmation": "not_required",
      "idempotency": "unknown",
      "interface_mode": "composite",
      "availability": "available",
      "interface_reason": "Reviewed unpinned remote adapter: this executable CLI wrapper calls a remote helper that is absent from the pinned MCP metadata snapshot; no single pinned semantically equivalent interface_ref can represent the command.",
      "reviewed": true,
      "review_reason": "migrated to reviewed metadata block"
    },
    "doc.template_list": {
      "effect": "read",
      "risk": "low",
      "confirmation": "not_required",
      "idempotency": "idempotent",
      "interface_mode": "composite",
      "availability": "available",
      "interface_reason": "Reviewed unpinned remote adapter: this executable CLI wrapper calls a remote helper that is absent from the pinned MCP metadata snapshot; no single pinned semantically equivalent interface_ref can represent the command.",
      "reviewed": true,
      "review_reason": "migrated to reviewed metadata block"
    },
    "doc.template_search": {
      "effect": "read",
      "risk": "low",
      "confirmation": "not_required",
      "idempotency": "idempotent",
      "interface_mode": "composite",
      "availability": "available",
      "interface_reason": "Reviewed unpinned remote adapter: this executable CLI wrapper calls a remote helper that is absent from the pinned MCP metadata snapshot; no single pinned semantically equivalent interface_ref can represent the command.",
      "reviewed": true,
      "review_reason": "migrated to reviewed metadata block"
    },
    "doc.update_comment": {
      "effect": "write",
      "risk": "medium",
      "confirmation": "not_required",
      "idempotency": "unknown",
      "interface_mode": "composite",
      "availability": "available",
      "interface_reason": "Reviewed unpinned remote adapter: this executable CLI wrapper calls a remote helper that is absent from the pinned MCP metadata snapshot; no single pinned semantically equivalent interface_ref can represent the command.",
      "reviewed": true,
      "parameters": {
        "mention": {
          "interface_type": "array"
        },
        "mentioned-open-conversation-id": {
          "property": "mentionedOpenConversationIds",
          "required": false,
          "interface_type": "array"
        }
      },
      "review_reason": "Preserve the reviewed user-mention conversion and normalize repeated or comma-separated group conversation IDs into mentionedOpenConversationIds.",
      "cli_path": "doc comment update",
      "runtime_gate": "none",
      "confirmation": "not_required"
    },
    "doc.update_document": {
      "effect": "write",
      "risk": "medium",
      "confirmation": "not_required",
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true,
      "runtime_gate": "none"
    },
    "doc.update_document_block": {
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true
    },
    "doc.update_permission": {
      "effect": "write",
      "risk": "medium",
      "confirmation": "not_required",
      "interface_mode": "mcp",
      "availability": "available",
      "reviewed": true,
      "runtime_gate": "none"
    },
    "doc.upload": {
      "effect": "write",
      "risk": "medium",
      "interface_mode": "composite",
      "availability": "available",
      "interface_reason": "命令包含多个 RPC、条件分派或本地 HTTP/文件步骤，不能绑定为单一 interface_ref",
      "reviewed": true
    },
    "doc.version_list": {
      "effect": "read",
      "risk": "low",
      "confirmation": "not_required",
      "idempotency": "idempotent",
      "interface_mode": "composite",
      "availability": "available",
      "interface_reason": "Reviewed unpinned remote adapter: this executable CLI wrapper calls a remote helper that is absent from the pinned MCP metadata snapshot; no single pinned semantically equivalent interface_ref can represent the command.",
      "reviewed": true,
      "review_reason": "migrated to reviewed metadata block"
    },
    "doc.version_revert": {
      "effect": "write",
      "risk": "medium",
      "confirmation": "user_required",
      "idempotency": "unknown",
      "interface_mode": "composite",
      "availability": "available",
      "interface_reason": "Reviewed unpinned remote adapter: this executable CLI wrapper calls a remote helper that is absent from the pinned MCP metadata snapshot; no single pinned semantically equivalent interface_ref can represent the command.",
      "reviewed": true,
      "runtime_gate": "confirm_dangerous"
    },
    "doc.version_save": {
      "effect": "write",
      "risk": "medium",
      "confirmation": "not_required",
      "idempotency": "unknown",
      "interface_mode": "composite",
      "availability": "available",
      "interface_reason": "Reviewed unpinned remote adapter: this executable CLI wrapper calls a remote helper that is absent from the pinned MCP metadata snapshot; no single pinned semantically equivalent interface_ref can represent the command.",
      "reviewed": true,
      "review_reason": "migrated to reviewed metadata block"
    }
  }
}