Read a Flarum docs page

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

Without annotations, the description carries full behavioral burden. It discloses that it returns Markdown source (preserving code blocks and headings) and ignores URL anchors. No mention of error handling or rate limits, but the safe read nature is evident.

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 sentences with no wasted words. Key information is front-loaded: the purpose and input flexibility, then behavioral notes, then sibling pairing advice. 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?

No output schema, but description implies return value (Markdown content). Two parameters are both well-explained. Could mention error behavior for invalid pages, but adequate for a simple read tool. Contextual completeness is high given the tool's simplicity.

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%, but description adds value by explaining acceptable page formats (slug, path, URL, anchor ignored) and clarifying that maxChars=0 returns the whole page. These details go beyond the schema's generic descriptions.

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 fetches the full Markdown of one Flarum documentation page, specifying accepted input formats (slug, path, URL). It distinguishes itself from the sibling tool flarum_docs_search by recommending pairing to find the right page first.

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?

Explicitly advises pairing with flarum_docs_search for discovery, and provides concrete examples of acceptable inputs (page slug, site path, URL). This gives clear context for when to use this tool versus alternatives.

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