List Pipeline Jobs

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

Annotations already provide readOnlyHint=true, idempotentHint=true, and destructiveHint=false. The description adds no behavioral context beyond the basic purpose, such as pagination behavior, sorting, or the fact that listing may return multiple pages (openWorldHint). It does not mention that results can be filtered by scope or that include_retried exists.

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 extremely short (one sentence) but fails to convey essential information beyond the bare purpose. While concise, it sacrifices completeness, making it insufficient for proper tool selection and use.

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?

Given the complexity (6 parameters, no output schema, many siblings), the description is vastly insufficient. It does not mention that it returns a list, supports filtering by scope, pagination, or the optional project_id. No output format is described, leaving the agent with incomplete context.

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 has 6 parameters with 0% description coverage, and the tool description does not explain any parameter meanings (e.g., pipeline_id, scope, page, per_page, project_id, include_retried). The description offers no value beyond the schema structure.

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 'List jobs in a pipeline' clearly identifies the action (list), the resource (jobs), and the scope (in a pipeline). It distinguishes from siblings like gitlab_get_pipeline_job (single job) and gitlab_list_pipeline_trigger_jobs (different type). However, it does not explicitly mention that the pipeline_id parameter is required, which is minor.

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 provides no guidance on when to use this tool versus alternatives such as gitlab_get_pipeline_job for a specific job or gitlab_list_pipelines for pipelines. No exclusions or context are given.

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