Get Shortcut Story

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It only states the read operation and gives no information about error handling, authentication requirements, or the meaning of the dry_run parameter. It fails to disclose what happens for non-existent IDs or the response shape.

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?

A single sentence, front-loaded with the verb and object, and no unnecessary words. It is as concise as possible while still stating the tool's core function.

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 has only two parameters, but one (dry_run) is completely undocumented in both the schema and description. There is no output schema, so the description should explain return values or side effects. The current description leaves critical gaps for a non-trivial boolean parameter.

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 description coverage is 0%, so the description must compensate. It adds some value by specifying that story_id is numeric, but it completely omits the dry_run parameter. The description does not provide enough detail for an agent to understand all parameters.

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 uses a specific verb ('Get') and identifies the resource ('Shortcut story') with a precise lookup method ('by numeric story ID'). It clearly distinguishes from sibling tools that list, search, or update stories.

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?

Usage is implied: you need a numeric story ID to fetch a single story. However, there is no explicit guidance about when to prefer this over search_stories or list-based tools, nor any exclusions or prerequisites.

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