Skip to content

docs: add Docker-based MCP server configuration#20053

Merged
pelikhan merged 3 commits intomainfrom
copilot/update-mcp-server-docs
Mar 8, 2026
Merged

docs: add Docker-based MCP server configuration#20053
pelikhan merged 3 commits intomainfrom
copilot/update-mcp-server-docs

Conversation

Copy link
Contributor

Copilot AI commented Mar 8, 2026

The MCP server reference had no Docker option for environments where gh is not installed locally.

Changes

docs/src/content/docs/reference/gh-aw-as-mcp-server.md

  • Added "Configuring with Docker" section using ghcr.io/github/gh-aw:latest for environments without gh installed:
{
  "command": "docker",
  "args": [
    "run", "--rm", "-i",
    "-e", "GITHUB_TOKEN",
    "-e", "GITHUB_ACTOR",
    "ghcr.io/github/gh-aw:latest",
    "mcp-server"
  ]
}

The Docker image ships with the GitHub CLI and gh-aw pre-installed. The GITHUB_TOKEN environment variable is used for authentication, and --validate-actor can be appended to enforce permission checks based on GITHUB_ACTOR.

Original prompt

Update MCP server documentation with clear instructions on how to configure it in any editor: command (docker), args, ...
Also how to configure the custom agent.

Custom agent used: technical-doc-writer
AI technical documentation writer for GitHub Actions library using GitHub Docs voice


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

…agent section

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Update MCP server documentation for configuration instructions docs: expand MCP server editor configuration and add custom agent setup guide Mar 8, 2026
@pelikhan
Copy link
Contributor

pelikhan commented Mar 8, 2026

@copilot keep the docker section, remove other changes

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Mar 8, 2026

@copilot keep the docker section, remove other changes

Done in 9f17cb3. Reverted all other editor sections and the custom agent section — only the Docker-based setup section remains as a new addition.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • telemetry.astro.build
    • Triggering command: /opt/hostedtoolcache/node/24.14.0/x64/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI changed the title docs: expand MCP server editor configuration and add custom agent setup guide docs: add Docker-based MCP server configuration Mar 8, 2026
@pelikhan pelikhan marked this pull request as ready for review March 8, 2026 12:51
Copilot AI review requested due to automatic review settings March 8, 2026 12:51
@pelikhan pelikhan merged commit cdda009 into main Mar 8, 2026
1 check passed
@pelikhan pelikhan deleted the copilot/update-mcp-server-docs branch March 8, 2026 12:51
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds Docker-based MCP server configuration documentation and a new workflow entry to the agent factory status table.

Changes:

  • Added a "Configuring with Docker" section to the MCP server reference docs, documenting how to run the MCP server via ghcr.io/github/gh-aw:latest Docker image for environments without gh CLI installed.
  • Added the "ACE Editor Session" workflow entry to the agent factory status table.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/src/content/docs/reference/gh-aw-as-mcp-server.md New "Configuring with Docker" section with docker run command, environment variable documentation, and --validate-actor instructions.
docs/src/content/docs/agent-factory-status.mdx New row for "ACE Editor Session" workflow in the agent factory status table.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants