Skip to content

Commit 58b7c1d

Browse files
committed
Remove Smithery guideance
Smithery latest CLI release has broken install and now requires an API key, this has been reported, but for now we remove this guidence and recommend npx install method.
1 parent 786a1dd commit 58b7c1d

File tree

2 files changed

+73
-41
lines changed

2 files changed

+73
-41
lines changed

README.md

Lines changed: 67 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,40 +5,59 @@ 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
8+
## Installation
99

10-
The easiest way to install XcodeBuildMCP is to use [Smithery](https://smithery.ai) to install it from the registry. Use the following command in your terminal below (requires npm/node) and replace `<client-name>` with the name of your AI agent (claude-code, codex, etc.) or use one of the client-specific examples provided.
10+
Add XcodeBuildMCP to your MCP client configuration. Most clients use JSON configuration with the following server entry:
1111

12-
```bash
13-
npx -y @smithery/cli@latest install cameroncooke/xcodebuildmcp --client <client-name>
12+
```json
13+
"XcodeBuildMCP": {
14+
"command": "npx",
15+
"args": ["-y", "xcodebuildmcp@latest"]
16+
}
1417
```
1518

1619
<details>
1720
<summary>Cursor</summary>
1821
<br />
1922

20-
```bash
21-
npx -y @smithery/cli@latest install cameroncooke/xcodebuildmcp --client cursor
23+
Add to `~/.cursor/mcp.json`:
24+
```json
25+
{
26+
"mcpServers": {
27+
"XcodeBuildMCP": {
28+
"command": "npx",
29+
"args": ["-y", "xcodebuildmcp@latest"]
30+
}
31+
}
32+
}
2233
```
34+
35+
Or use the quick install link:
36+
37+
[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=XcodeBuildMCP&config=eyJ0eXBlIjoic3RkaW8iLCJjb21tYW5kIjoibnB4IC15IHhjb2RlYnVpbGRtY3BAbGF0ZXN0IiwiZW52Ijp7IklOQ1JFTUVOVEFMX0JVSUxEU19FTkFCTEVEIjoiZmFsc2UiLCJYQ09ERUJVSUxETUNQX1NFTlRSWV9ESVNBQkxFRCI6ImZhbHNlIn19)
2338
<br />
2439
</details>
2540

2641
<details>
27-
<summary>Codex CLI</summary>
42+
<summary>Claude Code</summary>
2843
<br />
2944

45+
Run:
3046
```bash
31-
npx -y @smithery/cli@latest install cameroncooke/xcodebuildmcp --client codex
47+
claude mcp add XcodeBuildMCP -- npx -y xcodebuildmcp@latest
3248
```
3349
<br />
3450
</details>
3551

3652
<details>
37-
<summary>Claude Code</summary>
53+
<summary>Codex CLI</summary>
3854
<br />
3955

40-
```bash
41-
npx -y @smithery/cli@latest install cameroncooke/xcodebuildmcp --client claude-code
56+
Add to `~/.codex/config.toml`:
57+
```toml
58+
[mcp_servers.XcodeBuildMCP]
59+
command = "npx"
60+
args = ["-y", "xcodebuildmcp@latest"]
4261
```
4362
<br />
4463
</details>
@@ -47,35 +66,64 @@ npx -y @smithery/cli@latest install cameroncooke/xcodebuildmcp --client <client-
4766
<summary>Claude Desktop</summary>
4867
<br />
4968

50-
```bash
51-
npx -y @smithery/cli@latest install cameroncooke/xcodebuildmcp --client claude
69+
Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
70+
```json
71+
{
72+
"mcpServers": {
73+
"XcodeBuildMCP": {
74+
"command": "npx",
75+
"args": ["-y", "xcodebuildmcp@latest"]
76+
}
77+
}
78+
}
5279
```
5380
<br />
5481
</details>
5582

5683
<details>
57-
<summary>VS Code</summary>
84+
<summary>VS Code / VS Code Insiders</summary>
5885
<br />
5986

60-
```bash
61-
npx -y @smithery/cli@latest install cameroncooke/xcodebuildmcp --client vscode
87+
Add to your VS Code settings JSON:
88+
```json
89+
"mcp": {
90+
"servers": {
91+
"XcodeBuildMCP": {
92+
"command": "npx",
93+
"args": ["-y", "xcodebuildmcp@latest"]
94+
}
95+
}
96+
}
6297
```
98+
99+
Or use the quick install links:
100+
101+
[<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)
102+
[<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)
63103
<br />
64104
</details>
65105

66106
<details>
67107
<summary>Windsurf</summary>
68108
<br />
69109

70-
```bash
71-
npx -y @smithery/cli@latest install cameroncooke/xcodebuildmcp --client windsurf
110+
Add to `~/.codeium/windsurf/mcp_config.json`:
111+
```json
112+
{
113+
"mcpServers": {
114+
"XcodeBuildMCP": {
115+
"command": "npx",
116+
"args": ["-y", "xcodebuildmcp@latest"]
117+
}
118+
}
119+
}
72120
```
73121
<br />
74122
</details>
75123

76124
<br />
77125

78-
For other clients see: [Smithery XcodeBuildMCP](https://smithery.ai/server/cameroncooke/xcodebuildmcp), for other installation options including manual installation see [Getting Started](docs/GETTING_STARTED.md)
126+
For other installation options see [Getting Started](docs/GETTING_STARTED.md)
79127

80128
## Requirements
81129

docs/GETTING_STARTED.md

Lines changed: 6 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,35 +5,19 @@
55
- Xcode 16.x or later
66
- Node.js 18.x or later
77

8-
## Install options
8+
## Installation
99

10-
### Smithery (recommended)
11-
```bash
12-
npx -y @smithery/cli@latest install cameroncooke/xcodebuildmcp --client client-name
13-
```
14-
15-
### One click install
16-
If you are using Cursor or VS Code you can use the quick install links below.
17-
18-
[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=XcodeBuildMCP&config=eyJ0eXBlIjoic3RkaW8iLCJjb21tYW5kIjoibnB4IC15IHhjb2RlYnVpbGRtY3BAbGF0ZXN0IiwiZW52Ijp7IklOQ1JFTUVOVEFMX0JVSUxEU19FTkFCTEVEIjoiZmFsc2UiLCJYQ09ERUJVSUxETUNQX1NFTlRSWV9ESVNBQkxFRCI6ImZhbHNlIn19)
19-
20-
[<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)
21-
22-
[<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)
23-
24-
### Manual installation
25-
Most MCP clients use JSON configuration. Add the following to your client configuration under `mcpServers`:
10+
Most MCP clients use JSON configuration. Add the following server entry to your client's MCP config:
2611

2712
```json
2813
"XcodeBuildMCP": {
2914
"command": "npx",
30-
"args": [
31-
"-y",
32-
"xcodebuildmcp@latest"
33-
]
15+
"args": ["-y", "xcodebuildmcp@latest"]
3416
}
3517
```
3618

19+
See the main [README](../README.md#installation) for client-specific configuration paths and quick install links.
20+
3721
## Project config (optional)
3822
For deterministic session defaults and runtime configuration, add a config file at:
3923

@@ -46,7 +30,7 @@ See [CONFIGURATION.md](CONFIGURATION.md) for the full schema and examples.
4630
## Client-specific configuration
4731

4832
### OpenAI Codex CLI
49-
Codex uses TOML for MCP configuration. Add this to your Codex CLI config file:
33+
Codex uses TOML for MCP configuration. Add this to `~/.codex/config.toml`:
5034

5135
```toml
5236
[mcp_servers.XcodeBuildMCP]

0 commit comments

Comments
 (0)