list_cicd_variables

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

With no annotations, the description carries the transparency burden. It discloses that variable values may be masked for security, which is a key behavioral trait. It also notes that variables are available to all pipelines, adding context beyond the basic list operation. However, it doesn't explicitly state it's read-only or describe return format, so a small gap remains.

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 only two sentences, front-loaded with the primary purpose. Every sentence adds value: the first defines the action, the second gives behavioral context. No wasted words.

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 simple list tool with two parameters and no output schema, the description covers the core purpose and an important behavioral note (masking). It could be slightly more complete by mentioning what details are returned (e.g., variable names, scopes) or pagination, but it adequately equips an agent for basic usage.

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 input schema already provides 100% coverage for both parameters (owner and project) with clear descriptions. The tool description adds no extra parameter detail, so it stays at the baseline for high schema coverage.

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 action ('List'), the resource ('CI/CD environment variables'), and the scope ('configured for a project'). It is easily distinguished from sibling tools, as no other tool mentions variables, and the added context about pipeline availability reinforces its purpose.

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 implies usage by defining what the tool does: use it to list CI/CD variables for a project. It does not explicitly mention alternatives or exclusions, but since no sibling variable tools exist and the context is clear, this is sufficient.

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