Skip to content

Commit 4c902d4

Browse files
documenting mcp rollback tool (#9550)
Co-authored-by: Rosie Yohannan <[email protected]>
1 parent c81f6e8 commit 4c902d4

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

docs/guides/modules/toolkit/pages/using-the-circleci-mcp-server.adoc

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,25 @@ The tool provides:
237237
* Configuration recommendations.
238238
* Best practices for CircleCI configuration.
239239

240+
=== Rollback Tool (`run_rollback_pipeline`)
241+
242+
This tool executes rollback operations for CircleCI projects, enabling you to revert
243+
deployments to previous versions by either running your configured rollback pipeline or rerunning your workflow.
244+
245+
The tool provides:
246+
247+
- Interactive rollback process with guided parameter collection.
248+
- Project resolution from either project slug or project ID.
249+
- Target environment selection.
250+
- Component version selection assistance.
251+
- Rollback pipeline execution or workflow rerun options.
252+
- Clear error handling and configuration guidance.
253+
254+
Prerequisites:
255+
256+
- In order to trigger the rollback using a Rollback pipeline, the pipeline must be configured in the project. See the xref:deploy:set-up-rollbacks.adoc[Set up rollbacks] page for help.
257+
- Deploy markers should be set up for version tracking. See the xref:deploy:configure-deploy-markers.adoc[Configure deploy markers] page for help.
258+
240259
== Real-world examples
241260

242261
Here are common scenarios where the CircleCI MCP server can help you and your team:
@@ -268,6 +287,19 @@ Your team wastes time with unreliable tests:
268287
. Your assistant explains the issues and suggests improvements to you.
269288
. You fix the tests and improve the reliability of your pipeline.
270289

290+
=== Example 4: Emergency production rollback using rollback pipeline
291+
292+
A critical bug is discovered in production after your latest deployment:
293+
294+
. You tell your assistant: "I need to rollback the frontend component in production
295+
due to a critical bug"
296+
. The assistant lists your followed projects and you select the affected project.
297+
. The MCP server fetches available component versions and you choose the last known
298+
good version.
299+
. You provide the rollback reason: "Critical authentication bug affecting user login"
300+
. The assistant executes the rollback pipeline, reverting to the stable version
301+
within minutes.
302+
271303
== Troubleshooting
272304

273305
For general MCP server troubleshooting steps, see the link:https://modelcontextprotocol.io/docs/tools/debugging[Model Context Protocol docs].

0 commit comments

Comments
 (0)