Add installation guide for OpenAI Codex #1340
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds installation documentation for integrating the GitHub MCP Server with OpenAI Codex. The guide covers remote and local Docker configurations, verification steps, usage examples, and security best practices.
- Adds comprehensive installation guide for OpenAI Codex integration at
docs/installation-guides/install-codex.md - Updates the installation guides index to include the new OpenAI Codex entry
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/installation-guides/install-codex.md | New comprehensive installation guide covering prerequisites, remote/local configuration, verification, usage examples, troubleshooting, and security practices for OpenAI Codex |
| docs/installation-guides/README.md | Adds link to the new OpenAI Codex installation guide in the directory index |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
SamMorrowDrums
assigned
SamMorrowDrums and
Copilot and unassigned
SamMorrowDrums and
Copilot
|
|
||
| > The remote GitHub MCP server is hosted by GitHub at `https://api.githubcopilot.com/mcp/` and supports Streamable HTTP. | ||
| ## Remote Configuration |
There was a problem hiding this comment.
I would put this above the .env section above and then offer .env as an alternative to bearer_token_env_var below the config setup
| bearer_token_env_var = "GITHUB_PAT_TOKEN" | ||
| ``` | ||
|
|
||
| ## Local Docker Configuration |
There was a problem hiding this comment.
Why would somebody want the local docker configuration?
|
|
||
| ## Security Best Practices | ||
| 1. Never commit tokens into version control | ||
| 2. Prefer environment variables or secret managers |
There was a problem hiding this comment.
| 2. Prefer environment variables or secret managers |
This should be adequately covered by the configuration options
| ```toml | ||
| [mcp_servers.github] | ||
| url = "https://api.githubcopilot.com/mcp/" | ||
| # Replace with your real PAT (least-privilege scopes). Do NOT commit this. | ||
| bearer_token_env_var = "GITHUB_PAT_TOKEN" | ||
| ``` |
There was a problem hiding this comment.
You can also recommend
codex mcp add github --url https://api.githubcopilot.com/mcp/
| | Issue | Possible Cause | Fix | | ||
| |-------|----------------|-----| | ||
| | Authentication failed | Missing/incorrect PAT scope | Regenerate PAT; ensure `repo` scope present | | ||
| | 401 Unauthorized (remote) | Token expired/revoked | Create new PAT; update `bearer_token` | |
There was a problem hiding this comment.
| | 401 Unauthorized (remote) | Token expired/revoked | Create new PAT; update `bearer_token` | | |
| | 401 Unauthorized (remote) | Token expired/revoked | Create new PAT; update `bearer_token_env_var` | |
Introduce a comprehensive installation guide for setting up the GitHub MCP server in OpenAI Codex, detailing prerequisites, configuration steps, and troubleshooting tips. This guide enhances user accessibility and understanding of the integration process.