Atlas-Docs

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

With no annotations provided, the description carries full burden and adds valuable behavioral context: it discloses that the tool returns 'a large volume of text' (output characteristic) and implies it's a read operation ('retrieves'). However, it doesn't mention potential performance impacts, rate limits, or authentication requirements that would be helpful for a tool returning large volumes.

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 perfectly concise with three sentences that each earn their place: first states purpose, second provides usage guidelines, third warns about volume and suggests alternatives. It's front-loaded with the core functionality and wastes no words.

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 (single parameter, no output schema, no annotations), the description is mostly complete: it explains purpose, usage context, and output characteristics. The main gap is the undocumented parameter, but otherwise it provides good context for agent decision-making.

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 0%, so the description must compensate. It doesn't mention the single parameter 'docName' at all, leaving its meaning undocumented. The baseline would be lower, but the description's strong guidance on usage provides some indirect context about what documentation is being retrieved.

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 with specific verbs ('retrieves', 'consolidated') and resource ('complete documentation content'), distinguishing it from siblings by emphasizing comprehensive vs. targeted retrieval. It explicitly contrasts with get_docs_page and search_docs for targeted information.

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 ('when you need comprehensive knowledge or need to analyze the full documentation context') and when not to ('consider using get_docs_page or search_docs for targeted information'), naming specific alternatives. This gives clear context for selection among siblings.

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