List API endpoints

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

Adds real context beyond the annotations: the source of generation (OpenAPI docs) and the explicit exclusion of write/secret endpoints. Annotations already cover readOnly/idempotent/destructive, but the exclusion rule and provenance are valuable additions. It doesn't mention pagination or result-count behavior.

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?

Three sentences, front-loaded with what it does, then when to use it, then the follow-up workflow. No filler.

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?

Complete enough for a discovery/list tool: purpose, trigger condition, exclusions, and the chained follow-up tools are all stated. No output schema exists, so return-shape explanation is not required, though noting the list format would help slightly.

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 the schema already documents query and service with examples and enum values. The description adds no parameter syntax or format detail beyond the schema. Baseline 3 is appropriate.

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?

States a specific verb (Lists) and resource (every read-only endpoint of the Forum and Market APIs), plus the data source (generated from official OpenAPI documents). Clearly distinguishes itself from the dedicated forum_* and market_* siblings by being the catch-all for uncovered needs.

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?

Gives explicit when-to-use: 'when no dedicated forum_* or market_* tool covers what the user needs.' It also routes the follow-up sequence explicitly: call api_describe_endpoint then api_call_endpoint. Exclusions are stated (write/expose-secret endpoints are excluded).

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