Align containerized env gate docs with MCP_GATEWAY_AGENT_ID#7229
Merged
Conversation
Copilot
AI
changed the title
[WIP] Fix containerized script agent ID gate alignment with validation environment
Align containerized env gate docs with Jun 8, 2026
MCP_GATEWAY_AGENT_ID
Contributor
There was a problem hiding this comment.
Pull request overview
Aligns containerized development documentation and script commentary with the runtime’s canonical gateway deployment gate environment variable (MCP_GATEWAY_AGENT_ID), while acknowledging MCP_GATEWAY_API_KEY as a deprecated compatibility fallback.
Changes:
- Update
run_containerized.shproxy-mode inline comment to referenceAGENT_IDinstead of the legacyAPI_KEY. - Update
CONTRIBUTING.mdDocker guidance to treatMCP_GATEWAY_AGENT_IDas canonical and call outMCP_GATEWAY_API_KEYas deprecated fallback.
Show a summary per file
| File | Description |
|---|---|
| run_containerized.sh | Updates proxy-mode comment wording to align with AGENT_ID terminology. |
| CONTRIBUTING.md | Updates Docker/containerized entrypoint guidance to use MCP_GATEWAY_AGENT_ID as canonical and note MCP_GATEWAY_API_KEY deprecation. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 2
Comment on lines
358
to
360
| # Run proxy mode — lightweight path that skips gateway-specific checks | ||
| # (no Docker socket, no stdin config, no MCP_GATEWAY_PORT/DOMAIN/API_KEY needed) | ||
| # (no Docker socket, no stdin config, no MCP_GATEWAY_PORT/DOMAIN/AGENT_ID needed) | ||
| run_proxy_mode() { |
Comment on lines
573
to
576
| The container uses `run_containerized.sh` as the entrypoint, which: | ||
| - Requires the `-i` flag for JSON configuration via stdin | ||
| - Requires `MCP_GATEWAY_PORT`, `MCP_GATEWAY_DOMAIN`, `MCP_GATEWAY_AGENT_ID` env vars (the agent ID is a deployment gate; reference it in your JSON config via `"gateway": {"agentId": "${MCP_GATEWAY_AGENT_ID}"}` to enable authentication) | ||
| - Requires `MCP_GATEWAY_PORT`, `MCP_GATEWAY_DOMAIN`, and `MCP_GATEWAY_AGENT_ID` env vars (`MCP_GATEWAY_API_KEY` is accepted as a deprecated fallback; the agent ID is a deployment gate, so reference it in your JSON config via `"gateway": {"agentId": "${MCP_GATEWAY_AGENT_ID}"}` to enable authentication) | ||
| - Queries the Docker daemon API version (falls back to 1.44) |
Collaborator
|
@copilot address review feedback |
Contributor
Author
Addressed in commit
|
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
run_containerized.shand the containerized docs had one remaining mismatch around the gateway deployment gate: the runtime already treatsMCP_GATEWAY_AGENT_IDas the canonical variable, withMCP_GATEWAY_API_KEYas a deprecated fallback, but the docs/commentary still referenced the legacy name in places.Containerized entrypoint docs
CONTRIBUTING.mdDocker development guidance to describeMCP_GATEWAY_AGENT_IDas the required gate variable.MCP_GATEWAY_API_KEYonly as a deprecated compatibility alias.Script comment alignment
run_containerized.shto referenceAGENT_IDinstead ofAPI_KEY, so the shell script terminology matchesinternal/config/validation_env.goand the environment variable docs.Example of the intended containerized config reference:
{ "gateway": { "agentId": "${MCP_GATEWAY_AGENT_ID}" } }