From 47e3cc2d0bc71ce475941ecda0c766fe6ed646d6 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 17 Apr 2026 15:15:52 +0000 Subject: [PATCH] docs: clarify BYOK and MCP registry are not enforced Agent-Logs-Url: https://github.com/github/gh-aw/sessions/4288c841-4380-44f6-beaf-7db2c8840676 Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com> --- docs/src/content/docs/guides/getting-started-mcp.md | 2 +- docs/src/content/docs/guides/mcps.md | 2 +- docs/src/content/docs/reference/frontmatter.md | 5 +++++ docs/src/content/docs/reference/tools.md | 2 +- 4 files changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/src/content/docs/guides/getting-started-mcp.md b/docs/src/content/docs/guides/getting-started-mcp.md index b640633b31d..a3ee9e12335 100644 --- a/docs/src/content/docs/guides/getting-started-mcp.md +++ b/docs/src/content/docs/guides/getting-started-mcp.md @@ -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 diff --git a/docs/src/content/docs/guides/mcps.md b/docs/src/content/docs/guides/mcps.md index 83ccc2aaf50..ab798067795 100644 --- a/docs/src/content/docs/guides/mcps.md +++ b/docs/src/content/docs/guides/mcps.md @@ -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: diff --git a/docs/src/content/docs/reference/frontmatter.md b/docs/src/content/docs/reference/frontmatter.md index fbf74ef1f48..e4783a71082 100644 --- a/docs/src/content/docs/reference/frontmatter.md +++ b/docs/src/content/docs/reference/frontmatter.md @@ -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). + > [!NOTE] > `byok-copilot` applies only to `engine: copilot` workflows. The implicit `cli-proxy` enablement does not apply to other engines. diff --git a/docs/src/content/docs/reference/tools.md b/docs/src/content/docs/reference/tools.md index 9b3d80b4417..e4ddc2a50ea 100644 --- a/docs/src/content/docs/reference/tools.md +++ b/docs/src/content/docs/reference/tools.md @@ -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: