List Catalog Items

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

No annotations provided, so description must cover behavior. It states the tool lists items from a specific table and supports filters, implying read-only. However, it does not disclose output format, default ordering, or any potential side effects. Lacks explicit statement that it is non-destructive.

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 short paragraphs, first succinctly describing functionality, second providing usage guidance. No unnecessary words 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?

Given 8 parameters and no output schema, the description lacks details about returned data (e.g., fields included, ordering, pagination behavior beyond limit/offset). While the usage hint is helpful, completeness would benefit from mentioning typical output structure.

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 covers 100% of parameters with descriptions. The tool description only repeats filter capabilities already documented in schema. No additional meaning or context beyond schema fields.

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 it lists service catalog items from a specific table, supporting text search and filters. Distinguishes from sibling tools like get_catalog_item (detailed view) and submit_catalog_request (request submission).

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?

Second paragraph explicitly says 'Use this to browse or search for available catalog offerings before getting item details or submitting a request,' providing clear usage timing. Does not explicitly contrast with other list tools like list_catalog_item_variables, but context is sufficiently informative.

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