Skip to content

Commit 4791de7

Browse files
committed
Update README
1 parent 6509330 commit 4791de7

1 file changed

Lines changed: 86 additions & 34 deletions

File tree

README.md

Lines changed: 86 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,89 @@ A Model Context Protocol (MCP) server that provides Xcode-related tools for inte
55
[![CI](https://github.com/cameroncooke/XcodeBuildMCP/actions/workflows/ci.yml/badge.svg)](https://github.com/cameroncooke/XcodeBuildMCP/actions/workflows/ci.yml)
66
[![npm version](https://badge.fury.io/js/xcodebuildmcp.svg)](https://badge.fury.io/js/xcodebuildmcp) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Node.js](https://img.shields.io/badge/node->=18.x-brightgreen.svg)](https://nodejs.org/) [![Xcode 16](https://img.shields.io/badge/Xcode-16-blue.svg)](https://developer.apple.com/xcode/) [![macOS](https://img.shields.io/badge/platform-macOS-lightgrey.svg)](https://www.apple.com/macos/) [![MCP](https://img.shields.io/badge/MCP-Compatible-green.svg)](https://modelcontextprotocol.io/) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/cameroncooke/XcodeBuildMCP)
77

8+
## Easy install
9+
10+
Easiest way to install XcodeBuildMCP is to use Smithery to install it from the registry. Copy and paste one of the following commands into your terminal.
11+
12+
```bash
13+
npx -y @smithery/cli@latest install cameroncooke/xcodebuildmcp --client client-name
14+
```
15+
16+
<details>
17+
<summary>Cursor</summary>
18+
<br />
19+
20+
```bash
21+
npx -y @smithery/cli@latest install cameroncooke/xcodebuildmcp --client cursor
22+
```
23+
<br />
24+
</details>
25+
26+
<details>
27+
<summary>Codex CLI</summary>
28+
<br />
29+
30+
```bash
31+
npx -y @smithery/cli@latest install cameroncooke/xcodebuildmcp --client codex
32+
```
33+
<br />
34+
</details>
35+
36+
<details>
37+
<summary>Claude Code</summary>
38+
<br />
39+
40+
```bash
41+
npx -y @smithery/cli@latest install cameroncooke/xcodebuildmcp --client claude-code
42+
```
43+
<br />
44+
</details>
45+
46+
<details>
47+
<summary>Claude Desktop</summary>
48+
<br />
49+
50+
```bash
51+
npx -y @smithery/cli@latest install cameroncooke/xcodebuildmcp --client claude
52+
```
53+
<br />
54+
</details>
55+
56+
<details>
57+
<summary>VS Code</summary>
58+
<br />
59+
60+
```bash
61+
npx -y @smithery/cli@latest install cameroncooke/xcodebuildmcp --client vscode
62+
```
63+
<br />
64+
</details>
65+
66+
<details>
67+
<summary>Windsurf</summary>
68+
<br />
69+
70+
```bash
71+
npx -y @smithery/cli@latest install cameroncooke/xcodebuildmcp --client windsurf
72+
```
73+
<br />
74+
</details>
75+
76+
<br />
77+
78+
For more installation options see: [Smithery XcodeBuildMCP](https://smithery.ai/server/cameroncooke/xcodebuildmcp).
79+
80+
>[!NOTE]
81+
> XcodeBuildMCP requires Node 18.x or later and Xcode 16.x or later to be installed.
82+
83+
## View the full Readme
84+
85+
<details>
86+
<summary>Click to expand the full readme with manual installation instructions, configuration options, feature list and demos.</summary>
87+
888
## Table of contents
989

90+
- [View the full Readme](#view-the-full-readme)
1091
- [Overview](#overview)
1192
- [Why?](#why)
1293
- [Features](#features)
@@ -19,12 +100,10 @@ A Model Context Protocol (MCP) server that provides Xcode-related tools for inte
19100
- [Getting started](#getting-started)
20101
- [Prerequisites](#prerequisites)
21102
- [One click install](#one-click-install)
22-
- [General installation](#general-installation)
103+
- [Manual installation](#manual-installation)
23104
- [Specific client installation instructions](#specific-client-installation-instructions)
24105
- [OpenAI Codex CLI](#openai-codex-cli)
25106
- [Claude Code CLI](#claude-code-cli)
26-
- [Smithery](#smithery)
27-
- [MCP Compatibility](#mcp-compatibility)
28107
- [Incremental build support](#incremental-build-support)
29108
- [Workflow Selection](#workflow-selection)
30109
- [Session-aware opt-out](#session-aware-opt-out)
@@ -119,15 +198,15 @@ Configure your MCP client
119198

120199
#### One click install
121200

122-
For a quick install, you can use the following links:
201+
If you're using Curor or VS Code you can use one the below quick install links to install XcodeBuildMCP.
123202

124203
[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=XcodeBuildMCP&config=eyJ0eXBlIjoic3RkaW8iLCJjb21tYW5kIjoibnB4IC15IHhjb2RlYnVpbGRtY3BAbGF0ZXN0IiwiZW52Ijp7IklOQ1JFTUVOVEFMX0JVSUxEU19FTkFCTEVEIjoiZmFsc2UiLCJYQ09ERUJVSUxETUNQX1NFTlRSWV9ESVNBQkxFRCI6ImZhbHNlIn19)
125204

126205
[<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%5D%7D)
127206

128207
[<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%5D%7D&quality=insiders)
129208

130-
#### General installation
209+
#### Manual installation
131210

132211
Most MCP clients (Cursor, VS Code, Windsurf, Claude Desktop etc) have standardised on the following JSON configuration format, just add the the following to your client's JSON configuration's `mcpServers` object:
133212

@@ -174,38 +253,9 @@ claude mcp add XcodeBuildMCP npx xcodebuildmcp@latest
174253
claude mcp add XcodeBuildMCP npx xcodebuildmcp@latest -e INCREMENTAL_BUILDS_ENABLED=false -e XCODEBUILDMCP_SENTRY_DISABLED=false
175254
```
176255

177-
##### Smithery
178-
179-
XcodeBuildMCP runs as a local (stdio) server when installed via [Smithery](https://smithery.ai/server/@cameroncooke/XcodeBuildMCP). You can configure it in the Smithery session UI or via environment variables.
180-
181-
```bash
182-
# Claude Desktop / Claude Code
183-
npx -y @smithery/cli install @cameroncooke/XcodeBuildMCP --client claude
184-
185-
# Cursor
186-
npx -y @smithery/cli install @cameroncooke/XcodeBuildMCP --client cursor
187-
188-
# VS Code
189-
npx -y @smithery/cli install @cameroncooke/XcodeBuildMCP --client vscode
190-
```
191-
192-
If your client isn't listed, run `npx smithery install --help` to see supported values for `--client`.
193-
194256
> [!IMPORTANT]
195257
> Please note that XcodeBuildMCP will request xcodebuild to skip macro validation. This is to avoid errors when building projects that use Swift Macros.
196258
197-
#### MCP Compatibility
198-
199-
XcodeBuildMCP supports both MCP tools, resources and sampling. At time of writing the following editors have varying levels of MCP feature support:
200-
201-
| Editor | Tools | Resources | Samplng |
202-
|--------|-------|-----------|---------|
203-
| **VS Code** ||||
204-
| **Cursor** ||||
205-
| **Windsurf** ||||
206-
| **Claude Code** ||||
207-
| **Claude Desktop** ||||
208-
209259
## Incremental build support
210260

211261
XcodeBuildMCP includes experimental support for incremental builds. This feature is disabled by default and can be enabled by setting the `INCREMENTAL_BUILDS_ENABLED` environment variable to `true`:
@@ -350,6 +400,8 @@ See our documentation for development:
350400
- [TESTING](docs/TESTING.md) - Testing principles and patterns
351401
- [ARCHITECTURE](docs/ARCHITECTURE.md) - System architecture and design principles
352402

403+
</details>
404+
353405
## Licence
354406

355407
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)