Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Mergify (BYOK) — connector documentation

  • MCP endpoint: https://byok-mergify.connectorbay.com/mcp
  • REST API: POST https://byok-mergify.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-mergify.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Mergify Mergify application key, sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-mergify.connectorbay.com/health · Tool schemas: https://byok-mergify.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-mergify · agent@connectorbay.com

What Mergify (BYOK) is for

Mergify (BYOK) lets an AI assistant read your own Mergify data through the Mergify API with a key you supply (Mergify application key). Read-only: 12 tools (get_application, get_merge_queue_status, list_merge_queues, get_queue_configuration, get_queue_pause, list_activity_events, get_time_to_merge, get_queue_size_stats, get_queue_failure_rate, search_ci_tests, get_ci_test, list_quarantined_tests). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.mergify.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Mergify. Mergify and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which Mergify application key and account scope am I using?"
  • "What is in the Mergify merge queue of acme/web right now?"
  • "Which pull requests are in the Mergify queues of acme/web?"
  • "Which merge queue rules does acme/web have in Mergify?"
  • "Is the Mergify merge queue of acme/web paused?"
  • "What did Mergify do on pull request 42 of acme/web?"

What it does

  • get_application: Show which Mergify application key is in use: its ID, name, scope and the GitHub account it is limited to.
  • get_merge_queue_status: Show the live merge queue of a repository: queue mode, pause state, batches being tested and pull requests waiting, with estimated merge times.
  • list_merge_queues: List the merge queues of a repository with the branch of each and the pull requests in it.
  • get_queue_configuration: Show the merge queue rules (names and settings) Mergify reads from a repository's configuration.
  • get_queue_pause: Show whether the merge queue of a repository is paused, with the reason and pause date.
  • list_activity_events: List recent Mergify activity events of a repository (queue entries, merges, check results, failures) newest first, filterable by pull request, base branch, outcome and time range. Returns the first page only.
  • get_time_to_merge: Show time to merge statistics for every merge queue of a repository, optionally at a given moment or for one branch.
  • get_queue_size_stats: Show how many pull requests were in the merge queue over time, grouped by base branch and queue.
  • get_queue_failure_rate: Show the merge queue failure rate over time, grouped by base branch and queue.
  • search_ci_tests: Search the CI tests Mergify tracks in a repository with flakiness metrics, filtered by name (globs allowed), pipeline, job or quarantine state. Returns the first page only.
  • get_ci_test: Get one CI test by ID: health status, success, failure and flakiness ratios, first and last failure, framework and file path.
  • list_quarantined_tests: List the CI tests quarantined in a repository with reason, scope (branch, pipeline, job), source and health. Returns the first page only.

BYOK key

You bring your own Mergify Mergify application key (https://dashboard.mergify.com). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.mergify.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Mergify API (api.mergify.com) with a BYOK key; documentation: https://docs.mergify.com/api/. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Mergify. Mergify and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Mergify account.

Built for: Worldwide. Languages: English.