Read a documentation page

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

The readOnlyHint and openWorldHint annotations already indicate safety, and the description goes further by specifying that the whole page is returned, anchors are ignored, and the output includes page title, URL, version, and markdown. This provides concrete behavioral expectations beyond the annotations.

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 front-loaded with the primary purpose and every sentence serves a distinct role: purpose, usage relationship, output details, and exclusion rules. It is slightly verbose but not redundant, and each sentence adds necessary 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?

Despite having no output schema, the description explicitly lists what will be returned, making the tool fully understandable. It also covers version defaults, URL formats, and exclusion boundaries, so an agent has all necessary context to invoke it correctly.

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 schema already covers required and optional parameters, but the description adds meaningful context: URL examples, the fact that anchors are ignored, and that the version defaults to v9 and should match the user's package.json. This goes well beyond the raw schema information.

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 reads the full markdown of a single page of the official Ionic Framework documentation. It also distinguishes itself from sibling tools by explicitly saying to use it after search_docs to read a page rather than to find one.

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 when-to-use guidance: after search_docs and before writing markup against a component. It also gives clear when-not-to-use instructions, including not to find a page and not to use it for pages outside ionicframework.com.

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