Discover Transitous API actions

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

Annotations already declare readOnlyHint and idempotentHint; the description adds that it is read-only, what fields are returned, and includes usage warnings about the service. No contradiction with annotations, but could mention error behavior or rate limits.

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?

The description is three sentences, starting with the core purpose and then adding behavioral context and warnings. It is efficient but includes necessary usage guidance without being verbose.

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?

Despite no output schema, the description details return fields (action IDs, methods, etc.). It includes documentation and OpenAPI links. For a two-parameter tool, this provides adequate context for the agent to understand usage and integration.

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?

Both parameters are fully described in the schema (100% coverage). The description adds useful guidance: 'use an empty string to list the catalog' for query, which enhances schema descriptions. No additional hints for limit 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?

The description clearly states the action ('Search or list'), the resource ('complete allowlisted Transitous/MOTIS API action catalog'), and the return fields. It distinguishes this tool from siblings like execute_api_action and search_connections by focusing on API action discovery.

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 explains the tool's role in discovering actions for use with execute_api_action. It includes responsible usage warnings about Transitous being volunteer-run and asks for contact before resource-intensive use, but does not explicitly state when not to use this tool vs. alternatives.

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