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

GitHub Environments (BYOK) — connector documentation

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

What GitHub Environments (BYOK) is for

GitHub Environments (BYOK) lets an AI assistant read your own GitHub Environments data through the GitHub Environments API with a key you supply (personal access token). Read-only: 10 tools (list_environments, get_environment, list_branch_policies, list_protection_rules, list_protection_rule_apps, list_environment_secret_names, list_environment_variable_names, list_deployments, list_deployment_statuses, get_pending_deployments). 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 Environments. GitHub Environments 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 deployment environments does octocat/Hello-World have?"
  • "What protection rules does the production environment of octocat/Hello-World have?"
  • "Which branches may deploy to the production environment of octocat/Hello-World?"
  • "Which custom protection rules gate the production environment of octocat/Hello-World?"
  • "Which apps can I use as protection rules for the production environment of octocat/Hello-World?"
  • "Which secrets are defined on the production environment of octocat/Hello-World?"

What it does

  • list_environments: List a repository's deployment environments with protection rules and branch policy flags.
  • get_environment: Get one deployment environment with its protection rules (wait timer, required reviewers) and branch policy.
  • list_branch_policies: List the branch and tag name patterns allowed to deploy to an environment.
  • list_protection_rules: List the custom deployment protection rules (GitHub App gates) enabled on an environment.
  • list_protection_rule_apps: List GitHub Apps that could be added as custom deployment protection rules on an environment.
  • list_environment_secret_names: List the names and dates of an environment's Actions secrets (values are never returned by GitHub).
  • list_environment_variable_names: List the names and dates of an environment's Actions variables (variable values are left out).
  • list_deployments: List a repository's deployments, optionally filtered by environment, ref, SHA or task, newest first.
  • list_deployment_statuses: List the status history of one deployment (queued, in_progress, success, failure ...) with environment URL and log URL.
  • get_pending_deployments: List the environments a workflow run is waiting on, with wait timers and required reviewers.

BYOK key

You bring your own GitHub Environments personal access token (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 Environments API (api.github.com) with a BYOK key; documentation: https://docs.github.com/en/rest/deployments. 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 Environments. GitHub Environments 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 Environments account.

Built for: Worldwide. Languages: English.