yeastar_get_outbound_route

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

With no annotations, the description carries the behavioral burden. 'Get full detail' reasonably implies a read-only operation returning complete information, but it does not disclose potential errors, authentication requirements, or whether the route data includes sensitive fields. This is adequate for a simple getter but not richly transparent.

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 sentences convey purpose, scope, and prerequisite with no redundant wording. The description is front-loaded with the primary action and quickly gives the actionable instruction about obtaining an ID.

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?

For a single-parameter read tool with no output schema, the description covers the essential context: what the tool does and where the required ID comes from. It could go further by describing the return structure or behavior when the ID is invalid, but these are minor gaps for a straightforward getter.

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?

The schema already documents the 'id' parameter at 100% coverage, so the baseline is 3. The description adds value by naming the specific source tool (yeastar_list_outbound_routes) rather than the schema's generic 'corresponding list tool', giving the agent a precise way to obtain a valid ID.

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 states a specific verb ('Get'), a clear resource ('outbound route'), and the singular scope ('a single'), which clearly distinguishes it from yeastar_list_outbound_routes. 'Full detail' also sets user expectations about the response. This is a clear and specific purpose statement.

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 gives an explicit prerequisite: the ID must come from yeastar_list_outbound_routes, which tells the agent when this tool is appropriate. It does not explicitly mention alternatives or when not to use it, but for a simple get-by-id tool this context is sufficiently clear.

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