wecom_edit_doc

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries full burden. It states the tool writes content but does not disclose if the operation is destructive (overwrites vs appends), whether it requires special permissions, or what happens if the document does not exist. This is a significant gap for a mutation tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, no filler. The first sentence states the action, the second provides necessary detail on supported syntax and identification methods. Efficient and clear.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no output schema and no annotations, the description could benefit from mentioning return behavior (e.g., success confirmation, errors). The tool has 3 params, one required, and current description covers identification but not the write behavior (overwrite vs append) or effects on existing content.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, and description adds value by explaining that 'docid' is preferred and 'url' is a fallback, which clarifies their relative importance beyond the schema descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'Write' and resource 'Markdown content to a WeCom document', and lists supported syntax (headings, lists, tables, bold, italic). However, it does not explicitly distinguish itself from sibling tools like wecom_read_doc or wecom_get_doc_content, though the action is different.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description mentions using docid (preferred) or url to identify the document, which gives some guidance. But it does not explain when to use this tool over alternatives, e.g., when to edit vs create (wecom_create_doc) or read (wecom_read_doc).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.