List Deployment Variables

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

Annotations already indicate read-only and non-destructive behavior. The description adds valuable transparency: secured variables return null, and it details pagination parameters. This goes beyond the 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 concise and well-structured: a summary sentence, a security note, an Args section with bullet-point parameters, and a Returns line. Every part adds value without redundancy.

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 list tool, the description covers all necessary aspects: purpose, parameters with defaults, pagination, security (OAuth scope and null for secure variables), and return type. An output schema exists, so return details are not missed.

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?

Despite 0% schema coverage in context signals, the description provides clear parameter meanings (e.g., 'repo_slug: Repository slug') and default values (page_size: 20, max_pages: 1). This compensates for the lack of schema descriptions.

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: 'List the variables of a deployment environment.' It uses a specific verb ('list') and resource ('variables of a deployment environment'), distinguishing it from sibling tools like list_deployments and list_environments.

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 specifies the required OAuth scope ('deployment') and provides parameter defaults. While it does not explicitly state when not to use it, the sibling tool list_pipeline_variables exists for a different variable type, allowing inference of appropriate use.

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