Juno Documentation

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, so the safety profile is clear. The description adds the source (GitHub repo) and naming convention, but does not detail response format or error behavior. Value added but not rich.

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 concise sentences: purpose, source URL, naming convention. Front-loaded with critical info, no wasted 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?

For a simple one-parameter tool with strong annotations, the description covers source, naming, and reference. It lacks response format (e.g., raw markdown or HTML), but is adequate for a documentation fetch tool.

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% with enum list. Description adds meaning beyond schema by explaining the underscore naming pattern and folder hierarchy relationship (e.g., build_authentication), which helps agents understand topic structure.

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 'Fetch Juno documentation from GitHub repo' with a specific verb and resource. It distinguishes from sibling tools which are action-oriented (e.g., deploy, build), as this is the only documentation retrieval tool.

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 clear context: the documentation source URL and the underscore naming convention that mirrors folder hierarchy. While it doesn't explicitly state when-not to use or offer alternatives, the context is sufficient for an agent to understand usage.

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