Skip to content

ref(tools): Generate manifest-driven CLI docs #198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cameroncooke merged 5 commits into from
Feb 3, 2026
Merged

ref(tools): Generate manifest-driven CLI docs #198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0d097fc
Improve tool analysis and docs
cameroncooke Feb 3, 2026
a24ece7
Update SKILLs and SKILL installer
cameroncooke Feb 3, 2026
cedacbf
fix: remove redundant 'CLI interface' and add missing article in CLI …
cursoragent Feb 3, 2026
3785fba
fix: rename xcodebuilmcp-cli to xcodebuildmcp-cli and update installe…
cursoragent Feb 3, 2026
c1836d1
refactor: remove unused getCanonicalTools and getToolsByWorkflow func…
cursoragent Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 17 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Add XcodeBuildMCP to your MCP client configuration. Most clients use JSON config
```json
"XcodeBuildMCP": {
"command": "npx",
"args": ["-y", "xcodebuildmcp@latest", "mcp"]
"args": ["-y", "xcodebuildmcp@beta", "mcp"]
}
```

Expand All @@ -26,15 +26,15 @@ Add XcodeBuildMCP to your MCP client configuration. Most clients use JSON config
"mcpServers": {
"XcodeBuildMCP": {
"command": "npx",
"args": ["-y", "xcodebuildmcp@latest", "mcp"]
"args": ["-y", "xcodebuildmcp@beta", "mcp"]
}
}
}
```

Or use the quick install link:

[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](cursor://anysphere.cursor-deeplink/mcp/install?name=XcodeBuildMCP&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsInhjb2RlYnVpbGRtY3BAbGF0ZXN0IiwibWNwIl19)
[![Install MCP Server](https://cursor.com/deeplink/mcp-install-light.svg)](https://cursor.com/en-US/install-mcp?name=XcodeBuildMCP&config=eyJjb21tYW5kIjoibnB4IC15IHhjb2RlYnVpbGRtY3BAYmV0YSBtY3AifQ%3D%3D)
<br />
</details>

Expand All @@ -44,7 +44,7 @@ Add XcodeBuildMCP to your MCP client configuration. Most clients use JSON config

Run:
```bash
claude mcp add XcodeBuildMCP -- npx -y xcodebuildmcp@latest mcp
claude mcp add XcodeBuildMCP -- npx -y xcodebuildmcp@beta mcp
```
<br />
</details>
Expand All @@ -55,14 +55,14 @@ Add XcodeBuildMCP to your MCP client configuration. Most clients use JSON config

Run:
```bash
codex mcp add XcodeBuildMCP -- npx -y xcodebuildmcp@latest mcp
codex mcp add XcodeBuildMCP -- npx -y xcodebuildmcp@beta mcp
```

Or add to `~/.codex/config.toml`:
```toml
[mcp_servers.XcodeBuildMCP]
command = "npx"
args = ["-y", "xcodebuildmcp@latest", "mcp"]
args = ["-y", "xcodebuildmcp@beta", "mcp"]
```
<br />
</details>
Expand All @@ -77,7 +77,7 @@ Add XcodeBuildMCP to your MCP client configuration. Most clients use JSON config
"mcpServers": {
"XcodeBuildMCP": {
"command": "npx",
"args": ["-y", "xcodebuildmcp@latest", "mcp"]
"args": ["-y", "xcodebuildmcp@beta", "mcp"]
}
}
}
Expand All @@ -95,16 +95,16 @@ Add XcodeBuildMCP to your MCP client configuration. Most clients use JSON config
"servers": {
"XcodeBuildMCP": {
"command": "npx",
"args": ["-y", "xcodebuildmcp@latest", "mcp"]
"args": ["-y", "xcodebuildmcp@beta", "mcp"]
}
}
}
```

Or use the quick install links:

[<img src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Server&color=0098FF" alt="Install in VS Code">](https://insiders.vscode.dev/redirect/mcp/install?name=XcodeBuildMCP&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22xcodebuildmcp%40latest%22%2C%22mcp%22%5D%7D)
[<img alt="Install in VS Code Insiders" src="https://img.shields.io/badge/VS_Code_Insiders-VS_Code_Insiders?style=flat-square&label=Install%20Server&color=24bfa5">](https://insiders.vscode.dev/redirect/mcp/install?name=XcodeBuildMCP&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22xcodebuildmcp%40latest%22%2C%22mcp%22%5D%7D&quality=insiders)
[![Install MCP Server](https://cursor.com/deeplink/mcp-install-light.svg)](https://cursor.com/en-US/install-mcp?name=XcodeBuildMCP&config=eyJjb21tYW5kIjoibnB4IC15IHhjb2RlYnVpbGRtY3BAYmV0YSBtY3AifQ%3D%3D)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-XcodeBuildMCP-24bfa5?style=flat&logo=visualstudiocode&logoColor=ffffff)](vscode-insiders:mcp/install?%7B%22name%22%3A%22XcodeBuildMCP%22%2C%22type%22%3A%22stdio%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22xcodebuildmcp%40beta%22%2C%22mcp%22%5D%7D)
<br />
</details>

Expand All @@ -118,7 +118,7 @@ Add XcodeBuildMCP to your MCP client configuration. Most clients use JSON config
"mcpServers": {
"XcodeBuildMCP": {
"command": "npx",
"args": ["-y", "xcodebuildmcp@latest", "mcp"]
"args": ["-y", "xcodebuildmcp@beta", "mcp"]
}
}
}
Expand All @@ -136,7 +136,7 @@ Add XcodeBuildMCP to your MCP client configuration. Most clients use JSON config
"mcpServers": {
"XcodeBuildMCP": {
"command": "npx",
"args": ["-y", "xcodebuildmcp@latest", "mcp"]
"args": ["-y", "xcodebuildmcp@beta", "mcp"]
}
}
}
Expand All @@ -160,9 +160,10 @@ When configuring a client manually, ensure the command includes the `mcp` subcom

XcodeBuildMCP now includes an optional agent skill. Some clients (e.g., Cursor, Claude Code) hide MCP tool schemas behind search/progressive disclosure, which can reduce tool discovery and usage. The skill provides a concise overview of available tools to counter that. If your client already exposes tools up front, you likely don’t need it; only use it if your agent isn’t reaching for XcodeBuildMCP tools.

To install, replace `<client-name>` with your client (cursor, claude, codex):
To install, download and run the installer in a terminal, then choose your client when prompted:
```bash
curl -fsSL https://raw.githubusercontent.com/cameroncooke/XcodeBuildMCP/main/scripts/install-skill.sh | bash -s -- --<client-name>
curl -fsSL https://raw.githubusercontent.com/cameroncooke/XcodeBuildMCP/main/scripts/install-skill.sh -o install-skill.sh
bash install-skill.sh
```

For further information on how to install the skill, see: [docs/SKILLS.md](docs/SKILLS.md)
Expand All @@ -182,7 +183,7 @@ XcodeBuildMCP provides a unified command-line interface. The `mcp` subcommand st

```bash
# Install globally
npm install -g xcodebuildmcp
npm install -g xcodebuildmcp@beta

# Start the MCP server (for MCP clients)
xcodebuildmcp mcp
Expand All @@ -191,7 +192,7 @@ xcodebuildmcp mcp
xcodebuildmcp tools

# Build for simulator
xcodebuildmcp build-sim --scheme MyApp --project-path ./MyApp.xcodeproj
xcodebuildmcp simulator build-sim --scheme MyApp --project-path ./MyApp.xcodeproj
```

The CLI uses a per-workspace daemon for stateful operations (log capture, debugging, etc.) that auto-starts when needed. See [docs/CLI.md](docs/CLI.md) for full documentation.
Expand Down
Loading
Loading