Skip to content

GETTING_STARTED.md

Latest commit

 

History

History
66 lines (48 loc) · 1.81 KB

GETTING_STARTED.md

File metadata and controls

66 lines (48 loc) · 1.81 KB

Getting Started

Prerequisites

  • macOS 14.5 or later
  • Xcode 16.x or later
  • Node.js 18.x or later

Installation

Most MCP clients use JSON configuration. Add the following server entry to your client's MCP config:

"XcodeBuildMCP": {
  "command": "npx",
  "args": ["-y", "xcodebuildmcp@latest"]
}

See the main README for client-specific configuration paths and quick install links.

Project config (optional)

For deterministic session defaults and runtime configuration, add a config file at:

<workspace-root>/.xcodebuildmcp/config.yaml

See CONFIGURATION.md for the full schema and examples.

Client-specific configuration

OpenAI Codex CLI

Codex uses TOML for MCP configuration. Add this to ~/.codex/config.toml:

[mcp_servers.XcodeBuildMCP]
command = "npx"
args = ["-y", "xcodebuildmcp@latest"]
env = { "XCODEBUILDMCP_SENTRY_DISABLED" = "false" }

If you see tool calls timing out (for example, timed out awaiting tools/call after 60s), increase the timeout:

tool_timeout_sec = 600

For more info see the OpenAI Codex configuration docs: https://github.com/openai/codex/blob/main/docs/config.md#connecting-to-mcp-servers

Claude Code CLI

# Add XcodeBuildMCP server to Claude Code
claude mcp add XcodeBuildMCP npx xcodebuildmcp@latest

# Or with environment variables
claude mcp add XcodeBuildMCP npx xcodebuildmcp@latest -e XCODEBUILDMCP_SENTRY_DISABLED=false

Note: XcodeBuildMCP requests xcodebuild to skip macro validation to avoid Swift Macro build errors.

Next steps