Skip to content

docs: clarify BYOK and MCP registry enforcement behavior #26900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 1 commit into from
Apr 17, 2026
+8 −3
Merged

docs: clarify BYOK and MCP registry enforcement behavior #26900

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/src/content/docs/guides/getting-started-mcp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ mcp-servers:
allowed: ["*"]
```

The `registry` field provides metadata for tooling while the `container` or `command` fields specify how to run the server.
The `registry` field provides metadata for tooling while the `container` or `command` fields specify how to run the server. Registry usage is informational and not enforced by gh-aw.

### Using a Custom Registry

Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/guides/mcps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ The `auth.type: github-oidc` field is only valid on HTTP servers. The MCP server

### Registry-based MCP Servers

Reference MCP servers from the GitHub MCP registry (the `registry` field provides metadata for tooling):
Reference MCP servers from the GitHub MCP registry (the `registry` field provides metadata for tooling and is not enforced by gh-aw):

```yaml wrap
mcp-servers:
Expand Down
5 changes: 5 additions & 0 deletions docs/src/content/docs/reference/frontmatter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -433,6 +433,11 @@ features:

Without this flag, BYOK mode requires manual composition of all three behaviors. With `byok-copilot: true`, the compiler handles the wiring automatically.

> [!IMPORTANT]
> `byok-copilot` is a gh-aw convenience extension point, not an enforcement boundary. gh-aw does not enforce Copilot BYOK usage.
>
> For Copilot BYOK setup and policy details, see [Using your LLM provider API keys with Copilot](https://docs.github.com/en/copilot/how-tos/administer-copilot/manage-for-enterprise/use-your-own-api-keys).

Copy link

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 440 appears to contain trailing whitespace (two spaces on an otherwise blank line). This can cause unintended Markdown line breaks and may trip markdown/whitespace linters; please replace it with a truly empty line.

Suggested change

Copilot uses AI. Check for mistakes.
> [!NOTE]
> `byok-copilot` applies only to `engine: copilot` workflows. The implicit `cli-proxy` enablement does not apply to other engines.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/reference/tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ mcp-servers:

### Registry Field

The `registry` field specifies the source URI of an MCP server in a registry. It is informational — useful for documenting server origin and enabling registry-aware tooling — and does not affect execution. Works with both stdio and HTTP servers:
The `registry` field specifies the source URI of an MCP server in a registry. It is informational — useful for documenting server origin and enabling registry-aware tooling — and does not affect execution. gh-aw does not enforce registry usage. Works with both stdio and HTTP servers:

```yaml wrap
mcp-servers:
Expand Down
Loading