Get a Flarum resource

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

No annotations are provided, so the description carries the full burden. It mentions that 'Returns full field values by default (no truncation)', which is a useful behavioral note. However, it does not explicitly state that the operation is read-only, nor does it disclose any side effects, permission requirements, or rate limits. The word 'Fetch' implies a safe operation, but more explicit disclosure would improve clarity.

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 concise sentences plus an example. Every sentence adds value: first sentence states the core function, second sentence notes default behavior, and the example illustrates common usage. No fluff or 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?

The description covers the essential aspects for a single-resource fetch tool: how to specify type and id, optional includes and field narrowing, and default truncation behavior. No output schema exists, but the description's note on 'full field values' provides adequate expectation. Missing aspects like error responses or relationship to other tools are minor 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 description coverage is 100%, so the baseline is 3. The description adds an example (type='discussions', id='42', include='posts,user') which provides concrete usage context but does not add substantial meaning beyond what the schema already provides for each parameter.

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 'Fetch a single Flarum resource by type and id', with a specific verb ('Fetch'), resource ('Flarum resource'), and scope ('single'), which distinguishes it from sibling tools like flarum_list (list multiple) and flarum_search (search across resources).

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 implies when to use (need a single resource by ID) but does not explicitly state when not to use or mention alternatives. It lacks exclusions or context for choosing between this and sibling tools like flarum_search or flarum_list.

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