get_document_outline

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so safety is covered. The description adds real behavioral context beyond that: content is masked, and a password-protected document comes back as 'locked' rather than opened, with a note about Keychain-supplied passwords.

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, no filler, and the return shape is stated first followed by behavioral caveats and sibling routing. The first sentence is slightly convoluted in phrasing but still earns its place.

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?

There is no output schema, so the description carries the burden of describing the return value, and it does so reasonably (pages, masked first lines, forms/worksheets, order). Pagination semantics are left to the schema parameters, which is acceptable given full coverage.

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%, with limit, lines, start and id all documented in the schema including defaults and maxima. The description adds only indirect color (why lines are masked on tax forms) and no syntax or format detail beyond the schema, so the baseline 3 applies.

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 states a concrete resource and return shape: a document's pages with masked first lines, listing which forms and worksheets it holds and in what order. It also distinguishes itself from siblings by routing form-check results to get_form_checks and id lookup to list_documents.

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?

It explicitly names two alternatives with the condition that selects each ('to see how the forms in it checked out use get_form_checks; to find the id, list_documents'). It also flags the locked-document case so the agent knows why a document may not open.

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