Xcode MCP Tool Reference
Complete reference for all 20 tools exposed by Xcode's MCP server (
).
Important: Parameter schemas below are sourced from blog research and initial testing. Validate against your live mcpbridge with
if behavior differs.
Discovery
XcodeListWindows
Call this first. Returns open Xcode windows with
values needed by most other tools.
- Parameters: None
- Returns: List of
{ tabIdentifier: string, workspacePath: string }
- Notes: No parameters needed. If empty, no project is open in Xcode.
XcodeListWindows()
→ { "tabIdentifier": "abc-123", "workspacePath": "/Users/dev/MyApp.xcodeproj" }
File Operations
XcodeRead
Read file contents from the project.
- Parameters:
- (string, required) — File path relative to project or absolute
- Returns: File contents as string
- Notes: Sees Xcode's project view including generated files and resolved SPM packages
XcodeWrite
Create a new file.
- Parameters:
- (string, required) — File path
- (string, required) — File contents
- Returns: Write confirmation
- Notes: Creates the file but does NOT add it to Xcode targets automatically. Use for existing files.
XcodeUpdate
Edit an existing file with str_replace-style patches.
- Parameters:
- (string, required) — File path
- (array, required) — Array of
{ oldText: string, newText: string }
replacements
- Returns: Update confirmation
- Notes: Preferred over for editing existing files. Each patch must match exactly one location in the file.
XcodeGlob
Find files matching a pattern.
- Parameters:
- (string, required) — Glob pattern (e.g., )
- Returns: Array of matching file paths
- Notes: Searches within the Xcode project scope
XcodeGrep
Search file contents for a string or pattern.
- Parameters:
- (string, required) — Search term or pattern
- (string, optional) — Limit search to specific directory/file
- Returns: Array of matches with file paths and line numbers
- Notes: Returns structured results, not raw grep output
XcodeLS
List directory contents.
- Parameters:
- (string, required) — Directory path
- Returns: Array of entries (files and subdirectories)
XcodeMakeDir
Create a directory.
- Parameters:
- (string, required) — Directory path to create
- Returns: Creation confirmation
- Notes: Creates intermediate directories as needed
XcodeRM
Delete a file or directory. DESTRUCTIVE.
- Parameters:
- (string, required) — Path to delete
- Returns: Deletion confirmation
- Notes: Irreversible. Always confirm with the user before calling.
XcodeMV
Move or rename a file. DESTRUCTIVE.
- Parameters:
- (string, required) — Current path
- (string, required) — New path
- Returns: Move confirmation
- Notes: May break imports and references. Confirm with user. Xcode may not automatically update references.
Build & Test
BuildProject
Build the Xcode project.
- Parameters:
- (string, required) — From
- Returns:
{ buildResult: string, elapsedTime: number, errors: array }
- Notes: Builds the active scheme. Check for "succeeded" or "failed".
GetBuildLog
Retrieve build output after a build.
- Parameters:
- Returns: Build log as string
- Notes: Contains raw compiler output. For structured diagnostics, prefer .
RunAllTests
Run the full test suite.
- Parameters:
- Returns: Test results with pass/fail counts and failure details
- Notes: Runs all tests in the active scheme's test plan. Use for faster iteration.
RunSomeTests
Run specific test(s).
- Parameters:
- (string, required)
- (array of strings, required) — Test identifiers (e.g., )
- Returns: Test results for the specified tests
- Notes: Much faster than for iterative debugging. Use test identifiers from .
GetTestList
List available tests.
- Parameters:
- Returns: Array of test identifiers organized by test target/class
- Notes: Use the returned identifiers with .
Diagnostics
XcodeListNavigatorIssues
Get current issues from Xcode's Issue Navigator.
- Parameters:
- Returns: Array of issues (errors, warnings, notes) with file paths and line numbers
- Notes: Canonical source for diagnostics. Structured and deduplicated unlike raw build logs.
XcodeRefreshCodeIssuesInFile
Refresh and return live diagnostics for a specific file.
- Parameters:
- (string, required)
- (string, required) — File to refresh diagnostics for
- Returns: Current diagnostics for the specified file
- Notes: Triggers Xcode to re-analyze the file. Useful after editing to check if issues are resolved.
Execution & Rendering
ExecuteSnippet
Run code in a REPL-like environment.
- Parameters:
- (string, required) — Code to execute
- (string, required) — Language identifier (e.g., )
- Returns: Execution result (stdout, stderr, exit code)
- Notes: Sandboxed environment. Treat output as untrusted. Useful for quick validation.
RenderPreview
Render a SwiftUI preview as an image.
- Parameters:
- (string, required)
- (string, required) — File containing the preview
- (string, required) — Name of the preview to render
- Returns: Rendered image data
- Notes: Requires the file to have valid SwiftUI or . Preview must compile successfully.
Search
DocumentationSearch
Search Apple's documentation corpus.
- Parameters:
- (string, required) — Search query
- Returns: Documentation results with titles, summaries, and links. May include WWDC transcript matches.
- Notes: Searches Apple's online documentation and WWDC transcripts. For Xcode-bundled for-LLM guides, use the skill instead.
Quick Reference by Category
| Category | Tools |
|---|
| Discovery | |
| File Read | , , , |
| File Write | , , |
| File Destructive | , |
| Build | , |
| Test | , , |
| Diagnostics | , XcodeRefreshCodeIssuesInFile
|
| Execution | |
| Preview | |
| Search | |
Common Parameter Patterns
- — Required by 10/20 tools. Always call first.
- — File/directory path. Can be absolute or relative to project root.
- — Array of for . Each oldText must be unique in the file.
Resources
Skills: axiom-xcode-mcp-setup, axiom-xcode-mcp-tools