View as Markdown

Agent Skills

Install the Mergify Agent Skills in Claude Code, Codex, or any skills.sh agent, so your coding agent can drive the Mergify CLI for you.


Mergify ships Agent Skills that teach an AI coding agent how to use the Mergify CLI: how to read the merge queue, how to find out why a pull request was dequeued, what belongs in a .mergify.yml, how to push a stack. They live in the Mergifyio/mergify-cli repository under skills/, are Apache-2.0, and ship as one bundle. For Codex, they’re published as the Mergify listing in the OpenAI plugin directory; every agent, Codex included, can also install them through skills.sh.

  • mergify-merge-queue queues and dequeues pull requests, reads queue status, works out why a pull request left the queue and which check failed, and pauses or resumes merging. See Merge Queue.

  • mergify-events reads the Activity Log for one pull request or for a whole repository, and reconstructs a pull request’s queue lifecycle.

  • mergify-config validates a .mergify.yml against the schema, and simulates what your rules would do on a real pull request. See Configuration File.

  • mergify-merge-protections sets up pull request dependencies, delayed merges, and scheduled freezes.

  • mergify-ci uploads JUnit test results, detects git refs, and sets Merge Queue Scopes. See CI Insights.

  • mergify-stack turns a branch of commits into a stack of pull requests and keeps them rebased.

Every skill shells out to mergify, so two things have to be true before any of them is useful:

  1. The CLI is installed and on the agent’s PATH. On macOS, brew install mergifyio/tap/mergify-cli. For Linux, Windows, and CI runners, see the CLI installation guide.

  2. It is authenticated. See Authentication below.

These skills only work in a terminal agent that can run the binary, such as Claude Code, Codex, or Cursor. A browser-only chat cannot run it, so the skills do nothing there.

/plugin install mergify@claude-plugins-official

The claude-plugins-official marketplace ships with Claude Code, so there is nothing to add first. You can also run /plugin on its own, open Discover, and search for mergify.

Codex and ChatGPT share one plugin directory, but the Mergify listing in it currently only works from Codex — the skills shell out to mergify, which ChatGPT itself cannot run. Open the plugin directory from Codex and search it for Mergify:

codex /plugins

Cursor, Cline, Copilot, and other skills.sh agents

Section titled Cursor, Cline, Copilot, and other skills.sh agents

skills.sh installs the same bundle into Cursor, Cline, Copilot, and dozens of other agents (Codex included, if you’d rather install it this way than through the plugin directory above):

Terminal window
npx skills add Mergifyio/mergify-cli

It detects the agent it is running under and writes the skills where that agent looks for them. To pick the target yourself, or to install once for every project instead of only the current one:

Terminal window
npx skills add Mergifyio/mergify-cli --agent cursor --global

Check the result with npx skills list.

Most of what the skills do goes through the Mergify API. Sign in once and every skill inherits the credential:

Terminal window
mergify auth login

That stores a Mergify user token outside the agent’s reach, so no secret has to go on a command line or into the project. Where the operating system has no credential store, which is the usual case in a container, the CLI writes a restricted file in your configuration directory instead. See Authentication for both paths.

mergify auth login opens the approval page in your browser. On a machine without one, pass --no-browser and open the URL it prints on another machine.

Stacks is the exception. It creates and updates pull requests through the GitHub API, so it needs a GitHub token of its own. Install the GitHub CLI, run gh auth login, and Stacks commands pick up its token on their own.

A Mergify application key is the alternative when the agent runs unattended and cannot complete an interactive sign-in. Create one from your dashboard and export it, so the agent does not have to put a secret on a command line:

Terminal window
export MERGIFY_TOKEN=your_token_here

An admin key covers queue status, the Activity Log, freezes, and browsing or quarantining tests; CI Insights uploads and Merge Queue Scopes need a ci key instead. No single key covers both, so pick the one that matches what you want the agent to do.

An application key does not work for Stacks. An unattended agent that pushes stacks needs a GitHub token, which is not deprecated: the deprecation above is only about using a GitHub token to reach the Mergify API. Exporting GITHUB_TOKEN is not enough on its own, though. Stacks commands read --token, then MERGIFY_TOKEN, then GITHUB_TOKEN, so an agent that already has an application key in MERGIFY_TOKEN hands that key to GitHub and the push fails. Pass the GitHub token as --token on the Stacks commands, or keep the application key out of MERGIFY_TOKEN. See GitHub token for Stacks for the full resolution order.

Application keys come with either the admin scope or the ci scope, and neither is read-only. admin covers the API except result uploads and Merge Queue Scopes, which need a ci key, so one key does not cover every command either. A key also belongs to a GitHub account rather than to a single repository, so it reaches every repository that account can see. Read Application Key Scopes before you hand one to an agent.

With the CLI installed and the skills in place, ask for what you want in plain language:

  • “Why did pull request #1234 leave the merge queue?”
  • “Validate this .mergify.yml, then show me what it would do on #1234.”
  • “Freeze the queue until Monday morning.”
  • “Turn these four commits into a stack and push it.”

The agent picks the skill that matches and runs the CLI itself.

Was this page helpful?