Get Pipeline Variables

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive, and openWorld, so the safety profile is covered. The description adds genuinely useful context beyond that: values are gated behind a server-side env var and include_value=true, telling the agent to expect redacted or empty values otherwise. It stops short of describing pagination behavior or what the variable list looks like.

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, front-loaded with the purpose and followed by the one gating condition that matters. No filler, no redundant restatement of the tool name.

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 read-only nature and value-redaction rule are adequately covered, and no output schema exists so return shape need not be explained. However, with five undocumented parameters and no annotations covering scoping, the definition leaves pagination and project_id semantics unaddressed, which is a meaningful gap for an otherwise simple tool.

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 carry parameter meaning, and it explains only include_value (and its env-var dependency). The other four parameters, including page, per_page, and project_id, get no mention, leaving the agent to guess at pagination and scoping from parameter names alone.

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 opens with a specific verb and resource: list the variables a pipeline was started with, which cleanly separates it from gitlab_get_pipeline (the pipeline itself) and gitlab_get_pipeline_job_output. It does not explicitly name a sibling alternative, but the scope is precise enough for an agent to select the right tool.

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 rather than stated: an agent infers this tool applies when it needs CI variables scoped to a specific pipeline run. The second sentence gives a concrete condition for retrieving actual values (GITLAB_ALLOW_CI_VARIABLE_VALUES=true plus include_value=true), but there is no guidance on when to prefer this over related pipeline tools or on prerequisites such as permissions.

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