get_stages

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

Describes read operation ('Retrieves') and return type (JSON array). No annotations provided, so description bears full burden; it adequately discloses behavior without mentioning auth or rate limits, which are less critical for a simple get.

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?

Concise, front-loaded summary, followed by structured details (Args, Returns, Examples). Every sentence adds value with no fluff.

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?

Single optional parameter fully explained; return type described; examples cover both use cases. Output schema exists, so no gaps.

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 has 0% description coverage, but description explains pipeline_id is optional, filters stages, and adds examples. Adds significant meaning 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?

Clearly states the tool retrieves all stages with optional pipeline filtering. Distinguishes from sibling tools like get_pipelines (pipelines vs stages).

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?

Provides explicit context for when to use (with/without filter) and includes examples. Does not explicitly state when not to use, but clarity is sufficient given sibling tools.

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