IRCTC Train Search Between Stations

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

Annotations already provide readOnlyHint, destructiveHint, idempotentHint, and openWorldHint. The description adds value by listing the specific return fields (e.g., class availability, running days) and clarifying the date range (within 120 days). No contradictions with annotations.

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 two sentences long, with the purpose immediately stated and supported by concise detail about returned data. No wasted words; every sentence adds value.

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 tool is simple with three required parameters and clear return values listed. The description, combined with the input schema and annotations, provides complete context for an agent to use it correctly. The return fields are explicitly mentioned, so no output schema is needed.

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?

Input schema covers all three parameters with descriptions, but the description adds meaning by providing concrete examples of station codes and date format, and advises using a companion tool for code discovery. This goes beyond the schema's 'Examples' field.

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 tool's purpose: 'Search trains running between two Indian railway stations.' It specifies the verb (search), resource (trains), and context (between stations). It lists returned fields (train number, name, times, class availability, running days), distinguishing it from sibling tools like `irctc.stations.search` which searches for station codes.

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 provides usage context by mentioning that station codes should be in '3-5 uppercase letters' and recommends using `irctc.station_search` to discover codes. It also gives examples (NDLS, CSMT, etc.) and date format constraints. However, it does not explicitly state when not to use this tool or compare it to alternatives like `irctc.trains.status`. Still, the hints are helpful.

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