Documentation
¶
Overview ¶
Package xcmcp documents the xcmcp module.
xcmcp is a macOS-focused toolkit for Xcode, Simulator, Accessibility, and AppleScript automation. The module is organized around command packages and internal implementation libraries rather than a single top-level API.
Commands ¶
The main entry points are:
- cmd/xcmcp, a stdio MCP server for project inspection, build and test, simulator control, device control, UI inspection, and Xcode integration
- cmd/xc, a direct CLI built on the same packages
- cmd/ax and cmd/axmcp, tools for the macOS Accessibility API
- cmd/ascript and cmd/ascriptmcp, tools for scriptable macOS applications
Internal Packages ¶
The main implementation packages are:
- internal/project, for discovering Xcode projects and schemes
- internal/xcodebuild, for build and test execution
- internal/simctl, for simulator management through xcrun simctl
- internal/devicectl, for physical device management
- internal/ui, for macOS Accessibility access and UI screenshots
- internal/screen, for screen capture helpers
- internal/crash, for crash report inspection
- internal/resources, for MCP resource registration
Environment ¶
xcmcp targets macOS and assumes Xcode and the simulator tooling are installed. Packages that drive the UI require Accessibility permission. Simulator and device features also depend on the corresponding runtime state, such as a booted simulator or a connected device.
This package exists to document the module as a whole. The supported entry points are the commands under cmd/. Most library code lives in internal/ packages and is not intended as a public import surface.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
ascript
command
Command ascript is a CLI for exploring and running AppleScript commands against scriptable macOS applications.
|
Command ascript is a CLI for exploring and running AppleScript commands against scriptable macOS applications. |
|
ascriptmcp
command
Command ascriptmcp is an MCP server that dynamically exposes scriptable macOS applications as MCP tools by parsing their sdef (scripting definition).
|
Command ascriptmcp is an MCP server that dynamically exposes scriptable macOS applications as MCP tools by parsing their sdef (scripting definition). |
|
ax
command
Command ax is a CLI for macOS Accessibility API navigation with dynamic tab completion.
|
Command ax is a CLI for macOS Accessibility API navigation with dynamic tab completion. |
|
axmcp
command
Command axmcp is an MCP server for macOS Accessibility API automation.
|
Command axmcp is an MCP server for macOS Accessibility API automation. |
|
xc
command
|
|
|
xcmcp
command
Command xcmcp is a MCP server that exposes various tools for interacting with Xcode projects, simulators, devices, and related resources.
|
Command xcmcp is a MCP server that exposes various tools for interacting with Xcode projects, simulators, devices, and related resources. |
|
internal
|
|
|
altool
Package altool wraps xcrun altool for app upload and validation.
|
Package altool wraps xcrun altool for app upload and validation. |
|
asc
Package asc wraps the asc CLI for App Store Connect API operations.
|
Package asc wraps the asc CLI for App Store Connect API operations. |
|
devicectl
Package devicectl provides wrappers around xcrun devicectl for physical device management.
|
Package devicectl provides wrappers around xcrun devicectl for physical device management. |
|
purego/coresim
Package coresim provides purego bindings for CoreSimulator.framework.
|
Package coresim provides purego bindings for CoreSimulator.framework. |
|
purego/objc
Package objc provides Objective-C runtime bindings using purego.
|
Package objc provides Objective-C runtime bindings using purego. |
|
sdef
Package sdef parses macOS scripting definition (sdef) XML and generates AppleScript runners from the parsed definitions.
|
Package sdef parses macOS scripting definition (sdef) XML and generates AppleScript runners from the parsed definitions. |