Search Flarum docs

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

States 'Reads the live docs, so results reflect the current docs.' No annotations provided, but description covers read-only nature. Could mention that it is non-destructive and doesn't require authentication, but overall clear.

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?

Four sentences, front-loaded with purpose, efficient and no wasted words.

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 explains return format (ranked results with page path and snippet) and how to use results (call flarum_docs_get). Sufficient for a search tool.

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%, so schema already documents parameters. Description adds a bit (e.g., 'natural language or keywords') but does not significantly enhance meaning beyond schema.

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?

Clearly states the tool searches official Flarum 2.0 docs and returns ranked results with page path and snippet. Distinguishes from sibling tools like flarum_docs_get (reads full page) and flarum_search (forum search).

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 says when to use: 'look up how something works... before acting on a forum.' Provides an example query and instructs to call flarum_docs_get with a result's 'page' for full content.

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