get_docs

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

With no annotations provided, the description carries the full burden. It discloses that the tool fetches MDX content from a specific repository (heroui-inc/heroui@main) and path (apps/docs/content/docs), which is valuable behavioral context. It does not mention error handling or return format, but for a simple read operation, this is sufficient.

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 concise, with three purposeful sentences plus a line of example paths. It is front-loaded with the key purpose and negative scope, and every sentence adds value.

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 is a simple single-parameter getter with no output schema, the description is largely complete: it explains what it retrieves, what it does not, and provides source and examples. It could be more explicit about the output format, but the current level is adequate for agent use.

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% and the schema already describes the 'path' parameter with examples. The description adds value by specifying the underlying repository and path structure ('apps/docs/content/docs'), providing context beyond the schema.

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 verb 'Get' and the resource 'general HeroUI v2 documentation (guides, customization, frameworks, API references)' and explicitly excludes component docs, distinguishing it from the sibling tool get_component_docs.

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 'For component documentation use get_component_docs instead,' providing a direct alternative and clear usage context. It also gives example paths to guide the agent on valid inputs.

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