list_documentationBrowse all available Adonis documentation files by listing their names and descriptions, helping you identify relevant guides quickly.
Lists all available documentation markdown files with their names and descriptions
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections.
v0.2.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With readOnlyHint and idempotentHint already present, the annotations cover safety and side-effect behavior. The description adds the useful behavioral context that the result contains file names and descriptions, which is more than the annotations alone provide and compensates for the lack of an output schema.
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?
A single sentence with no filler. The verb, scope, and output detail are all included with high efficiency, and the description is front-loaded with the key action 'Lists'.
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 zero-parameter, read-only, idempotent list tool, the description is complete: it identifies the resource type, the scope ('all available'), and the return content ('names and descriptions'). No output schema exists, so this succinct description supplies the necessary contract.
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?
The input schema has zero parameters, so there is nothing for the description to clarify. The baseline for a parameterless tool is 4, and the description appropriately avoids inventing unnecessary parameter guidance.
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 uses the specific verb 'Lists', identifies the resource as 'all available documentation markdown files', and states the output includes 'names and descriptions'. It is clear and actionable, though it does not explicitly distinguish itself from the sibling tools.
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 implies use when the agent needs an overview or inventory of documentation files. However, it does not explicitly state when to use this tool instead of search_in_docs or extract_code_examples, leaving the routing decision to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.