Skip to main content
Glama

Cancel project job

gitlab_cancel_project_job

Cancel a specific job in a GitLab project using project_id and job_id, stopping active pipeline work and returning the updated job response.

Instructions

Cancel a specific job within a project.

Args: **kwargs: Additional parameters for the request (e.g., project_id, job_id).

Returns: Response: A wrapper containing the original response and a Job model.

Raises: MissingParameterError: If the project_id or job_id is missing. ParameterError: If invalid parameters are provided.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "gitlab_cancel_project_job"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNo
scopeNo
job_idNo
per_pageNo
max_pagesNo
project_idNo
pipeline_idNo
total_pagesNo
include_retriedNo
job_variable_attributesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv27.3.20
    • removedInput schema / properties / api_parameters
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "additionalProperties": true,
      -      "type": "object"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "default": null
      -}
  2. First observedv27.3.13

TDQS

C2.8/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=false, idempotentHint=false, openWorldHint=true, and destructiveHint=false, so the safety profile is partly covered. The description adds that it returns a wrapper with a Job model and lists MissingParameterError/ParameterError, but it does not explain the actual effect on the job, required permissions, or whether cancellation is reversible.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is short and front-loads the core action, but the 'Args: **kwargs' section is inaccurate for a schema with named parameters and does not earn its place. The Returns and Raises blocks add some value but are boilerplate.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with 10 parameters, no output schema, and a mutation that cancels a job, the description is incomplete. It does not explain most parameters, the actual cancellation semantics, or the required-parameter mismatch with the schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema has 10 parameters at 0% description coverage, but the description only mentions project_id and job_id as examples inside '**kwargs'. It leaves page, scope, per_page, max_pages, pipeline_id, total_pages, include_retried, and job_variable_attributes completely unexplained, and its claim that project_id/job_id are required conflicts with the schema showing zero required parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: 'Cancel a specific job within a project.' That clearly distinguishes it from sibling tools such as retry_project_job, get_project_job, and erase_project_job, though it does not explicitly name those alternatives.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no guidance on when to use this tool versus retry_project_job, run_project_job, or erase_project_job, and no stated prerequisites such as whether the job must be running or queued. The description only implies usage from the verb 'Cancel'.

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

Deploy Server

Other Tools