Get AdonisJS doc page

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

With no annotations, the description carries the behavioral burden. It discloses the return format (plain markdown/asciidoc) and the section-filtering behavior, including the 'cheaper than the full page' performance hint. It does not mention errors or edge cases, but for a read-only doc fetcher this is reasonable.

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?

Two concise sentences with no filler. The core purpose and id source are front-loaded, and the section usage tip earns its place by providing actionable guidance.

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?

The description is adequate for a fetch-by-id tool: it identifies the id source, output format, and a useful partial-fetch option. The rich schema covers parameters and defaults. A little more context about behavior when no id is found or when maxLength truncates output would round it out, but nothing critical is missing.

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%, so the baseline is 3. The description adds only a little beyond the schema, mostly reinforcing the 'section' parameter's purpose. It does not need to compensate for missing parameter docs.

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?

States a specific verb and resource: 'Fetches a documentation page by id' as plain markdown/asciidoc. The phrase 'from search_docs' distinguishes it from the search sibling and makes the intended fetch-by-id role clear.

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?

Implies the correct flow by saying the id comes from search_docs, and gives explicit guidance on when to use 'section' for a cheaper partial fetch. It stops short of stating when not to use get_doc or comparing it directly to detect_version, but the context is clear.

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