wecom_read_doc

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

No annotations provided; the description carries full burden. It discloses auto-detection of URL type and return format (Markdown). However, it does not mention potential errors, rate limits, or whether authentication is needed. Still, for a read tool, this is adequate.

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?

Three sentences, all essential. No fluff, front-loaded with purpose, then adss specific behavior about return format and URL auto-detection.

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 only one parameter, no output schema, and no annotations, the description is relatively complete. It explains input, behavior, and output. Could mention pagination or limitations for large docs, but overall sufficient.

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 description coverage is 100% (the url parameter is described). The description adds meaning beyond the schema by explaining what URLs are accepted and how they are processed (auto-detect). It could be more precise about the scode parameter, but minimal.

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 tool reads a WeCom document or smartsheet and returns content as Markdown. It distinguishes itself from siblings (e.g., wecom_get_doc_content, wecom_smartsheet_get_records) by focusing on reading with Markdown output and URL auto-detection.

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 does not explicitly state when not to use this tool vs. siblings, but it does provide context on URL types (smartsheet vs. doc) and what to expect. Implicitly, if the user wants raw data or specific fields, other tools might be better, but this is not stated.

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