List Flarum resources

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

Discloses truncation of long text fields and how to override (maxFieldChars, fields, flarum_get). No annotations provided, so description carries this burden well. Could mention pagination behavior more explicitly but it's covered by 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?

Concise and front-loaded. Every sentence adds value. Includes example usage and important notes about truncation.

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 8 parameters and no output schema, description covers key behaviors (truncation, JSON:API features). Could mention return format but list tools typically return JSON:API collections. Adequate.

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 has 100% coverage, baseline 3. Description adds value by explaining truncation, providing example usage (type, filter, include), and contextualizing parameters like maxFieldChars.

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?

Description explicitly states the tool lists or searches any Flarum resource collection, with examples (discussions, posts, users, etc.). It distinguishes from sibling tools like flarum_get (for full content) and flarum_search (which may be more specific).

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?

Clearly indicates when to use (for listing/searching collections). Implicitly contrasts with flarum_get for reading full content. Could explicitly state not to use for single resource retrieval.

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