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

Annotations already declare readOnly/idempotent/non-destructive, and the description adds substantial context beyond them: required access level (full_access or comment_and_notes), that comment/view access is insufficient, that download_url works tokenless for one hour, that only team members can add files, and a prompt-injection warning to treat notes as data.

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?

Front-loaded with purpose and usage before permissions and security caveats, and nearly every sentence carries operational value (curl invocation, token expiry, access tiers). It is dense but the length is justified by the safety and workflow information.

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?

With no output schema, the description still describes the return shape (name, size, download_url), the null-markdown case, and end-to-end usage. An agent has everything needed to authenticate, fetch, and safely use the result.

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%, so the single asset_id parameter is already documented, including that it accepts an asset id resolving to the current version. The description adds the return-side nuance that markdown is null when no notes exist, which goes slightly beyond the schema baseline of 3.

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?

States a specific verb+resource ('Read a version's notes (Markdown) and its files') and immediately explains what each part is. It is clearly distinguishable from siblings like version_download (files only) and version_notes_update (writes notes).

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?

Explicitly prescribes when to use it: 'Call this before continuing work someone else uploaded: read the current version's notes, download its files, then make the changes the feedback asks for.' That is a concrete trigger plus a follow-on workflow that rules out ambiguity.

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