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

GitHub Checks (BYOK) — connector documentation

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

What GitHub Checks (BYOK) is for

GitHub Checks (BYOK) lets an AI assistant read your own GitHub Checks data through the GitHub Checks API with a key you supply (GitHub personal access token (repo scope for private repositories)). Read-only: 8 tools (list_check_runs_for_ref, list_check_suites_for_ref, get_combined_status, list_commit_statuses, get_check_run, list_check_run_annotations, get_check_suite, list_check_runs_in_suite). 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.github.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by GitHub Checks. GitHub Checks 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 CI checks passed on the main branch of octocat/Hello-World?"
  • "Which apps ran check suites on commit ce58745 of octocat/Hello-World?"
  • "What is the combined commit status of main on octocat/Hello-World?"
  • "Show the history of commit statuses for commit ce58745 of octocat/Hello-World"
  • "Give me the details of check run 4 on octocat/Hello-World"
  • "What annotations did check run 4 add on octocat/Hello-World?"

What it does

  • list_check_runs_for_ref: List the check runs (CI jobs, linters, scanners) reported for a commit, branch or tag with status, conclusion, app and timing.
  • list_check_suites_for_ref: List the check suites (one per app that reported checks) for a commit, branch or tag with status, conclusion and counts.
  • get_combined_status: Get the combined commit status for a ref (success, failure, pending or error) plus the individual status contexts behind it.
  • list_commit_statuses: List every commit status posted for a ref, newest first, with context, state, description and target URL.
  • get_check_run: Get one check run by its numeric ID: name, status, conclusion, timing, output title and summary, and annotation count.
  • list_check_run_annotations: List the annotations (file, line range, level, title, message) a check run attached to code, for example linter warnings.
  • get_check_suite: Get one check suite by its numeric ID: branch, SHA, status, conclusion, creating app and the run count.
  • list_check_runs_in_suite: List the check runs that belong to one check suite with status, conclusion and timing.

BYOK key

You bring your own GitHub Checks GitHub personal access token (repo scope for private repositories) (https://github.com/settings/tokens). 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.github.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 GitHub Checks API (api.github.com) with a BYOK key; documentation: https://docs.github.com/en/rest/checks. 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 GitHub Checks. GitHub Checks 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 GitHub Checks account.

Built for: Worldwide. Languages: English.