docs: add GitHub MCP setup for Actions - #145
Open
sylvesterkaczmarek wants to merge 2 commits into
Open
Conversation
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.
Summary
Document how to configure GitHub's MCP server for
codex-action, including a copyable workflow example that uses the job's GitHub token with explicit permissions.Fixes #60.
Problem
The README currently mentions MCP only as a general suggestion. It does not show how an Actions user should:
That leaves users asking how to give Codex GitHub MCP access from the Action without a supported example to follow.
Documentation added
docs/github-mcp.mdprovides a complete remote-server setup using the current Codex MCP config shape:The workflow exposes
github.tokenonly asGITHUB_TOKENfor the Codex step and passes the same prepared home throughcodex-home.The guide also explains:
openai-api-keyand the GitHub credential;github.tokenwith a dedicated secret when needed;examples/github-mcp.ymlcontains the same pattern as a standalone workflow example.Verification
The example is based on the current public interfaces of both projects:
mcp_servers.<name>.urlandbearer_token_env_var;https://api.githubcopilot.com/mcp/as its remote endpoint and supports token authentication;codex-actionalready preserves caller-provided Codex configuration when adding its Responses proxy settings.No runtime code, action inputs, generated bundle, or security behavior changes.
Scope
Documentation and example workflow only. This PR does not install a local MCP process, add new action inputs, broaden
GITHUB_TOKENpermissions automatically, or change the action's write-access guard.