Skip to content

Commit ee667fe

Browse files
committed
Add Xcode installation guide for Codex and Claude Agent
1 parent 926d049 commit ee667fe

2 files changed

Lines changed: 46 additions & 0 deletions

File tree

docs/installation-guides/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ This directory contains detailed installation instructions for the GitHub MCP Se
1313
- **[OpenAI Codex](install-codex.md)** - Installation guide for OpenAI Codex
1414
- **[Roo Code](install-roo-code.md)** - Installation guide for Roo Code
1515
- **[Windsurf](install-windsurf.md)** - Installation guide for Windsurf IDE
16+
- **[Xcode (Codex & Claude Agent)](install-xcode.md)** - Installation guide for Codex and Claude Agent within Xcode
1617

1718
## Support by Host Application
1819

@@ -32,6 +33,8 @@ This directory contains detailed installation instructions for the GitHub MCP Se
3233
| Windsurf || ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy |
3334
| Copilot in Xcode || ✅ Full (OAuth + PAT) | Local: Docker or Go build, GitHub PAT<br>Remote: Copilot for Xcode 0.41.0+ | Easy |
3435
| Copilot in Eclipse || ✅ Full (OAuth + PAT) | Local: Docker or Go build, GitHub PAT<br>Remote: Eclipse Plug-in for Copilot 0.10.0+ | Easy |
36+
| Xcode (Codex) || ✅ PAT + ❌ No OAuth | Local: Docker (full path required), GitHub PAT<br>Remote: GitHub PAT + env var | Easy |
37+
| Xcode (Claude Agent) || ✅ PAT + ❌ No OAuth | Local: Docker (full path required), GitHub PAT<br>Remote: GitHub PAT | Easy |
3538

3639
**Legend:**
3740
- ✅ = Fully supported
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Install GitHub MCP Server in Xcode
2+
3+
Xcode currently supports two built-in coding agents: **Codex** (powered by OpenAI) and **Claude Agent** (powered by Anthropic). Follow the standard installation guide for each agent, with one important difference: Xcode uses its own isolated configuration directories for each agent, separate from your global config.
4+
5+
> Configurations placed in these directories only affect agents when launched from Xcode. See [Apple's documentation](https://developer.apple.com/documentation/xcode/setting-up-coding-intelligence#Customize-the-Claude-Agent-and-Codex-environments) for more details.
6+
7+
## Configuration Directories
8+
9+
| Agent | Configuration Directory |
10+
|-------|------------------------|
11+
| Codex | `~/Library/Developer/Xcode/CodingAssistant/codex/` |
12+
| Claude Agent | `~/Library/Developer/Xcode/CodingAssistant/ClaudeAgentConfig/` |
13+
14+
Place your MCP server configuration in the relevant directory above rather than the default location used by the standalone CLI.
15+
16+
## Setup Guides
17+
18+
- **[Codex](install-codex.md)** — configure `config.toml` inside `~/Library/Developer/Xcode/CodingAssistant/codex/`
19+
- **[Claude Agent](install-claude.md#claude-desktop)** — configure `.claude.json` inside `~/Library/Developer/Xcode/CodingAssistant/ClaudeAgentConfig/`
20+
21+
## macOS Path Note
22+
23+
Xcode runs with a minimal `PATH` that typically excludes `/usr/local/bin`. If you are using a local STDIO server (e.g. Docker or a pre-built binary), use the **full path** to the command in your config:
24+
25+
```
26+
/usr/local/bin/docker
27+
/usr/local/bin/github-mcp-server
28+
```
29+
30+
## Troubleshooting
31+
32+
| Issue | Possible Cause | Fix |
33+
|-------|----------------|-----|
34+
| Tools not loading | Config placed in wrong directory | Ensure config is in the Xcode-specific path above, not `~/.codex/` or `~/.claude.json` |
35+
| Command not found (STDIO) | Xcode's PATH excludes `/usr/local/bin` | Use the full path to the command |
36+
| Docker not found | Docker not running | Start Docker Desktop and restart Xcode |
37+
| Authentication failed | Invalid or expired PAT | Regenerate PAT and update config |
38+
39+
## References
40+
41+
- [Apple Developer Documentation — Setting up coding intelligence](https://developer.apple.com/documentation/xcode/setting-up-coding-intelligence#Customize-the-Claude-Agent-and-Codex-environments)
42+
- [Codex MCP documentation](https://developers.openai.com/codex/mcp)
43+
- Main project README: [Advanced configuration options](../../README.md)

0 commit comments

Comments
 (0)