doc_get

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

With no annotations provided, the description carries the full burden. It states the tool retrieves a document, which implies a read-only operation, but does not disclose error handling, authentication needs, or any side effects. The description is adequate but could be improved with more behavioral details.

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?

The description is extremely concise, with two sentences and a tip. The first sentence immediately states the purpose, and the tip provides actionable guidance. Every sentence earns its place with no redundancy.

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 the tool's simplicity (2 required parameters, 100% schema coverage, and an output schema), the description is nearly complete. It covers the core action, parameter usage, and a workflow tip. It does not explain the return value, but that is acceptable since an output schema exists.

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?

The schema coverage is 100%, so baseline is 3. The description adds value by explaining the path format with examples and the tip about using 'doc_list' to get valid paths, which goes beyond the schema's descriptions and helps the agent understand how to use the parameters correctly.

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 action ('Retrieve') and the resource ('a specific document'), along with the required parameters (path and project). It distinguishes itself from the sibling tool 'doc_list' by specifying that it retrieves a specific document, not a list.

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 explicitly says 'Use this tool to look up a specific document within a project' and provides a tip to use 'doc_list' first to discover valid paths. This gives clear context on when to use the tool and suggests an alternative, though it does not explicitly state when not to use it.

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