List Flarum docs pages

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

No annotations are provided, so the description must disclose behavioral traits. It indicates the tool fetches from the live sitemap, implying a read-only operation. It does not detail return format or potential side effects, but the behavior is straightforward for a list tool.

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 two sentences long, front-loading the purpose and then providing usage guidance. Every sentence is meaningful and without redundancy.

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?

Given the absence of an output schema, the description mentions paths and URLs as return elements, which is adequate for a list tool. However, it could be improved by specifying whether URLs are absolute or relative, but overall it provides enough context for the agent to understand the tool's output.

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 100% coverage for the single parameter 'filter'. The description adds value beyond the schema by providing a concrete example (e.g., filter='extend'), which helps the agent understand usage.

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 explicitly states what the tool does: listing available Flarum 2.0 documentation pages (paths and URLs) from the live sitemap. It uses specific verbs and resources, and distinguishes itself from sibling tools like flarum_docs_get by indicating it is a preliminary discovery step.

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 guidance on when to use the tool: before reading a page with flarum_docs_get. It also mentions the optional filter parameter. However, it does not explicitly state when not to use it or contrast with other sibling tools like flarum_docs_search.

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