run_rollback_pipeline

Run a rollback pipeline for a CircleCI project. This tool guides you through the full rollback process, adapting to the information you provide and prompting for any missing details.

**Initial Step:**
- First, call the `listFollowedProjects` tool to retrieve the list of projects the user follows.
- Then, ask the user to select a project by providing either a `projectID` or the exact `projectSlug` as returned by `listFollowedProjects`.

**Typical Flow:**
1. **Start:** User initiates a rollback request.
2. **Project Selection:** If a `projectSlug` or `projectID` is not provided, call `listFollowedProjects` and prompt the user to select a project using the exact value returned.
3. **Execute the tool and list the versions.**
4. **Workflow Rerun:** 
   - Inform the user of the fact that no rollback pipeline is defined for this project.
   - Ask the user if they want to rerun a workflow.
   - If the user wants to rerun a workflow, execute the tool with rollback_type set to `WORKFLOW_RERUN`. Do not propose to choose another project.
6. **Component Selection:** 
   - If the project has multiple components, present up to 20 options for the user to choose from.
   - If there is only one component, proceed automatically and do not ask the user to select a component.
7. **Environment Selection:** 
   - If the project has multiple environments, present up to 20 options for the user to choose from.
   - If there is only one environment, proceed automatically and do not ask the user to select an environment.
8. **Version Selection:** 
   - Present the user with available versions to rollback to, based on the selected environment and component. Include the namespace for each version.
   - Ask for both the current deployed version and the target version to rollback to.
9. **Optional Details:** 
   - If the rollback type is `PIPELINE`, prompt the user for an optional reason for the rollback (e.g., "Critical bug fix").
   - If the rollback type is `WORKFLOW_RERUN`, provide the workflow ID of the selected version to the tool.
   - provide the namespace for the selected version to the tool.
10. **Confirmation:** 
   - Summarize the rollback request and confirm with the user before submitting.

**Parameters:**
- Either `projectSlug` (e.g., "gh/organization/repository") or `projectID` (UUID) must be provided.
- `environment_name` (optional at first if multiple environments): The target environment (e.g., "production", "staging").
- `component_name` (optional at first components): The component to rollback (e.g., "frontend", "backend").
- `current_version` (optional at first): The currently deployed version.
- `target_version` (optional at first): The version to rollback to.
- `reason` (optional): Reason for the rollback.
- `parameters` (optional): Additional rollback parameters as key-value pairs.

**Behavior:**
- If there are more than 20 environments or components, ask the user to refine their selection.
- Never attempt to guess or construct project slugs or URLs; always use values provided by the user or from `listFollowedProjects`.
- Do not prompt for missing parameters until versions have been listed.
- Do not call this tool with incomplete parameters.
- If the selected project lacks rollback pipeline configuration, provide a definitive error message without suggesting alternative projects.

**Returns:**

On success: The rollback ID or a confirmation in case of workflow rerun.
- On error: A clear message describing what is missing or what went wrong.
- If the selected project does not have a rollback pipeline configured: The tool will provide a clear error message specific to that project and will NOT suggest trying another project.
Important Note:
- This tool is designed to work only with the specific project provided by the user.
- If a project does not have rollback capability configured, the tool will NOT suggest alternatives or recommend trying other projects.
- The assistant should NOT suggest trying different projects when a project lacks rollback configuration.
- Each project must have its own rollback pipeline configuration to be eligible for rollback operations.
- When a project cannot be rolled back, provide only the configuration guidance for THAT specific project.
If neither option is fully satisfied, prompt the user for the missing information before making the tool call.

Name	Required	Description	Default
`params`	No

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "params": {
      "additionalProperties": false,
      "properties": {
        "component_name": {
          "description": "The component name",
          "type": "string"
        },
        "current_version": {
          "description": "The current version",
          "type": "string"
        },
        "environment_name": {
          "description": "The environment name",
          "type": "string"
        },
        "parameters": {
          "additionalProperties": {},
          "description": "The extra parameters for the rollback pipeline",
          "type": "object"
        },
        "projectID": {
          "description": "The ID of the CircleCI project (UUID)",
          "format": "uuid",
          "type": "string"
        },
        "projectSlug": {
          "description": "The project slug from listFollowedProjects tool (e.g., \"gh/organization/project\"). When using this option, branch must also be provided.",
          "type": "string"
        },
        "reason": {
          "description": "The reason for the rollback",
          "type": "string"
        },
        "rollback_type": {
          "default": "PIPELINE",
          "description": "The type of rollback operation to perform",
          "enum": [
            "PIPELINE",
            "WORKFLOW_RERUN"
          ],
          "type": "string"
        },
        "target_version": {
          "description": "The target version",
          "type": "string"
        },
        "workflow_id": {
          "description": "The ID of the workflow to rerun",
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

CircleCI MCP Server

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from CircleCI MCP Server

Related Tools

MCP directory API