doc-bot

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It describes what the tool returns ('complete implementation details, code examples, and architectural decisions') and hints at content types ('Project docs contain battle-tested patterns; API docs show framework usage'). However, it doesn't mention potential limitations like file size constraints, authentication requirements, or error conditions, leaving some behavioral aspects unspecified.

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 appropriately sized and front-loaded with the core purpose. Most sentences earn their place by providing usage guidance and behavioral context. However, the final sentence about 'Project docs' and 'API docs' feels somewhat redundant with the earlier 'complete implementation details' statement, slightly reducing efficiency.

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 moderate complexity (2 parameters, no output schema, no annotations), the description provides good contextual coverage. It explains the tool's purpose, usage scenarios, and return content types. The main gap is the lack of output format details (since no output schema exists), but the description compensates by describing what kind of content to expect ('implementation details, code examples, architectural decisions').

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%, providing complete parameter documentation. The description doesn't add any parameter-specific information beyond what's in the schema (fileName and page parameters are not mentioned in the description text). This meets the baseline expectation when schema coverage is high, but doesn't provide additional semantic context about how parameters affect the reading behavior.

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's purpose: 'Read full documentation file content' (specific verb+resource). It distinguishes from siblings by explicitly mentioning 'search_documentation' as a precursor and contrasting with 'skimming search results', establishing its unique role in providing comprehensive documentation access.

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 provides explicit guidance on when to use this tool: 'WHENEVER search results point you here', 'after search_documentation identifies relevant docs', 'when you need complete context before implementing', and 'when revisiting a topic mid-work'. It also specifies when not to use it: 'Don't just skim search results', effectively positioning it as a deep-dive alternative to surface-level search tools.

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