Skip to content

Commit d1168bb

Browse files
updates on feedback
1 parent 10c274c commit d1168bb

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed

docs/installation-guides/install-codex.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,25 @@
55
1. OpenAI Codex (MCP-enabled) installed / available
66
2. A [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new)
77

8+
> The remote GitHub MCP server is hosted by GitHub at `https://api.githubcopilot.com/mcp/` and supports Streamable HTTP.
9+
10+
## Remote Configuration
11+
12+
Edit `~/.codex/config.toml` (shared by CLI and IDE extension) and add:
13+
14+
```toml
15+
[mcp_servers.github]
16+
url = "https://api.githubcopilot.com/mcp/"
17+
# Replace with your real PAT (least-privilege scopes). Do NOT commit this.
18+
bearer_token_env_var = "GITHUB_PAT_TOKEN"
19+
```
20+
21+
You can also add it via the Codex CLI:
22+
23+
```cli
24+
codex mcp add github --url https://api.githubcopilot.com/mcp/
25+
```
26+
827
<details>
928
<summary><b>Storing Your PAT Securely</b></summary>
1029
<br>
@@ -22,19 +41,6 @@ echo -e ".env" >> .gitignore
2241
```
2342
</details>
2443

25-
> The remote GitHub MCP server is hosted by GitHub at `https://api.githubcopilot.com/mcp/` and supports Streamable HTTP.
26-
27-
## Remote Configuration
28-
29-
Edit `~/.codex/config.toml` (shared by CLI and IDE extension) and add:
30-
31-
```toml
32-
[mcp_servers.github]
33-
url = "https://api.githubcopilot.com/mcp/"
34-
# Replace with your real PAT (least-privilege scopes). Do NOT commit this.
35-
bearer_token_env_var = "GITHUB_PAT_TOKEN"
36-
```
37-
3844
## Local Docker Configuration
3945

4046
Use this if you prefer a local, self-hosted instance instead of the remote HTTP server, please refer to the [OpenAI documentation for configuration](https://developers.openai.com/codex/mcp).
@@ -88,7 +94,7 @@ Use the principle of least privilege: add scopes only when a tool request fails
8894
| Issue | Possible Cause | Fix |
8995
|-------|----------------|-----|
9096
| Authentication failed | Missing/incorrect PAT scope | Regenerate PAT; ensure `repo` scope present |
91-
| 401 Unauthorized (remote) | Token expired/revoked | Create new PAT; update `bearer_token` |
97+
| 401 Unauthorized (remote) | Token expired/revoked | Create new PAT; update `bearer_token_env_var` |
9298
| Server not listed | Wrong table name or syntax error | Use `[mcp_servers.github]`; validate TOML |
9399
| Tools missing / zero tools | Insufficient PAT scopes | Add needed scopes (workflow, gist, etc.) |
94100
| Token in file risks leakage | Committed accidentally | Rotate token; add file to `.gitignore` |

0 commit comments

Comments
 (0)