# Quick Start Guide
Get the MCP Xcode Server up and running in 5 minutes!
## 1. Install
```bash
cd mcp-xcode-server
npm install
```
## 2. Get Your Server Path
```bash
pwd
# Copy the output, you'll need it in the next step
```
## 3. Configure MCP Client
Add to your MCP configuration (Claude Desktop, Cursor, etc.):
```json
{
"mcpServers": {
"xcode": {
"command": "node",
"args": ["/path/from/step/2/src/index.js"],
"env": {}
}
}
}
```
Replace `/path/from/step/2` with the actual path from step 2.
## 4. Restart Your Client
Restart Claude Desktop, Cursor, or your MCP client to load the server.
## 5. Test It!
Ask your AI assistant:
- "Read my Xcode project at /path/to/project.xcodeproj"
- "List schemes in my Xcode project"
- "Build my Xcode project"
## Common Commands
### Read Project Structure
```json
{
"tool": "xcode_read_project",
"arguments": {
"projectPath": "/path/to/Project.xcodeproj"
}
}
```
### List Schemes
```json
{
"tool": "xcode_list_schemes",
"arguments": {
"projectPath": "/path/to/Project.xcodeproj"
}
}
```
### Build Project
```json
{
"tool": "xcode_build",
"arguments": {
"projectPath": "/path/to/Project.xcodeproj",
"scheme": "MyScheme",
"configuration": "Debug"
}
}
```
### Run Tests
```json
{
"tool": "xcode_test",
"arguments": {
"projectPath": "/path/to/Project.xcodeproj",
"scheme": "MySchemeTests"
}
}
```
## Need Help?
- See [SETUP.md](./SETUP.md) for detailed setup instructions
- See [README.md](./README.md) for complete documentation
- Check troubleshooting section in SETUP.md
## Example: Adding Your Test Target
After setting up, you can ask:
"Add a test target called FuelManagerTests to my project at /Users/chace/Developer/FuelManager/FuelManager.xcodeproj"
The server will guide you through the process or provide instructions.
