iOS MCP Code Quality Server
A versatile iOS code quality analysis tool that operates in two modes:
- CLI Tool: Direct command-line interface for iOS testing and linting
- MCP Server: Model Context Protocol server for AI assistant integration
This tool provides comprehensive iOS code quality analysis and test automation capabilities, enabling both direct developer usage and AI assistant integration for Xcode tests, linter analysis, and detailed feedback on iOS projects through structured, actionable reports.
Quick Start
CLI Mode (Direct Usage with npx - Recommended)
Use instantly without installation:
# Run iOS tests
npx ios-mcp-code-quality-server test --xcworkspace MyApp.xcworkspace --scheme MyAppTests
# Run SwiftLint analysis
npx ios-mcp-code-quality-server lint --changed-files "ViewController.swift,Model.swift"
# Show help
npx ios-mcp-code-quality-server --helpAlternative: Install Globally (Optional)
For frequent use across multiple projects, you can install globally:
npm install -g ios-mcp-code-quality-server
# Then use the full name (following MCP conventions)
ios-mcp-code-quality-server test --xcworkspace MyApp.xcworkspace --scheme MyAppTests
ios-mcp-code-quality-server lint --changed-files "ViewController.swift,Model.swift"๐ก Tip: Using
npxis recommended as it ensures you always use the latest version without global installs.
MCP Server Mode (AI Assistant Integration)
# Start as MCP server (no arguments)
npx ios-mcp-code-quality-server
# Or explicitly start server mode
npx ios-mcp-code-quality-server serverThe server will start on http://localhost:3000 and be ready to receive MCP requests.
Features
- ๐งช iOS Test Execution: Run Xcode tests with detailed failure analysis
- ๐ฑ Multiple Schemes Support: Test different iOS project configurations
- ๐ SwiftLint Integration: Automated Swift code style and quality checking
- ๐ Structured Reporting: Clear, actionable feedback with file locations and line numbers
- ๐ Build Error Detection: Intelligent parsing of Xcode build failures
- ๐ Local Processing: All analysis happens on your machine for security
- โก Dual Mode Operation: Use as CLI tool or MCP server
- ๐ป Command Line Interface: Direct terminal usage for developers
- ๐ค AI Assistant Ready: MCP protocol support for seamless AI integration
Architecture
This tool operates in two distinct modes with intelligent detection:
CLI Mode
- Activation: When command-line arguments are provided
- Usage: Direct developer interaction via terminal commands or npx
- Output: Human-readable or JSON format for scripting
- Benefits: Fast execution, scriptable, CI/CD friendly, no installation required with npx
MCP Server Mode
- Activation: When no arguments are provided (default)
- Usage: AI assistant integration via Model Context Protocol
- Output: Structured MCP responses for AI consumption
- Benefits: AI-powered analysis, contextual suggestions, interactive debugging
Simple Mode Detection:
# MCP Server Mode (no arguments)
npx ios-mcp-code-quality-server # โ Starts MCP server
ios-mcp-code-quality-server # โ Starts MCP server (if globally installed)
# CLI Mode (arguments provided)
npx ios-mcp-code-quality-server --help # โ CLI help
npx ios-mcp-code-quality-server test --help # โ CLI test help
npx ios-mcp-code-quality-server lint --changed-files="file.swift" # โ CLI lintCLI Usage
No Installation Required
Use npx to run the CLI directly without installation:
npx ios-mcp-code-quality-server --help # Show all available commands
npx ios-mcp-code-quality-server <command> --help # Show help for specific commandCommands
Test Command
Run iOS tests with comprehensive analysis:
# Basic usage
npx ios-mcp-code-quality-server test --xcworkspace MyApp.xcworkspace --scheme MyAppTests
# With specific destination
npx ios-mcp-code-quality-server test --xcworkspace MyApp.xcworkspace --scheme MyAppTests \
--destination "platform=iOS Simulator,name=iPhone 15"
# Using Xcode project instead of workspace
npx ios-mcp-code-quality-server test --xcodeproj MyApp.xcodeproj --scheme MyAppTests
# Get JSON output for script integration
npx ios-mcp-code-quality-server test --xcworkspace MyApp.xcworkspace --scheme MyAppTests --json
# Verbose logging for debugging
npx ios-mcp-code-quality-server test --xcworkspace MyApp.xcworkspace --scheme MyAppTests --verboseTest Command Options:
--xcworkspace <path>: Path to .xcworkspace file--xcodeproj <path>: Path to .xcodeproj file (either xcworkspace or xcodeproj required)--scheme <name>: Scheme name for testing (required)--destination <destination>: Test destination (default: "platform=iOS Simulator")--json: Output results in JSON format--verbose: Enable verbose logging
Lint Command
Run SwiftLint analysis on specific files:
# Lint specific files
npx ios-mcp-code-quality-server lint --changed-files "ViewController.swift,Model.swift"
# With custom SwiftLint configuration
npx ios-mcp-code-quality-server lint --changed-files "*.swift" --config-path .swiftlint.yml
# Get JSON output
npx ios-mcp-code-quality-server lint --changed-files "ViewController.swift" --json
# Verbose output
npx ios-mcp-code-quality-server lint --changed-files "*.swift" --verboseLint Command Options:
--changed-files <files>: Comma-separated list of files to lint (required)--config-path <path>: Path to SwiftLint configuration file--json: Output results in JSON format--verbose: Enable verbose logging
Server Command
Start MCP server mode explicitly:
# Start server on default port (3000)
npx ios-mcp-code-quality-server server
# Start server on custom port
npx ios-mcp-code-quality-server server --port 8080
# Server with custom settings
PORT=3001 LOG_LEVEL=debug npx ios-mcp-code-quality-server serverCLI Examples
# Complete iOS project test workflow
npx ios-mcp-code-quality-server test --xcworkspace MyApp.xcworkspace --scheme MyAppTests --verbose
# Quick SwiftLint check on modified files
git diff --name-only | grep "\.swift$" | xargs -I {} npx ios-mcp-code-quality-server lint --changed-files {}
# CI/CD integration with JSON output
npx ios-mcp-code-quality-server test --xcworkspace MyApp.xcworkspace --scheme MyAppTests --json > test-results.json
# Check specific Swift files before commit
npx ios-mcp-code-quality-server lint --changed-files "LoginViewController.swift,UserModel.swift" --config-path .swiftlint.ymlMCP Server Installation
Prerequisites
- Node.js 18+: Required for running the MCP server
- Xcode: For iOS project building and testing
- iOS Simulator: For running tests (or physical iOS device)
- SwiftLint (optional): For code quality analysis
Setup Steps
-
Clone the repository:
git clone https://github.com/a-25/ios-mcp-code-quality-server.git cd ios-mcp-code-quality-server -
Install dependencies:
npm install -
Build the project:
npm run build -
Start the server:
npm start # or explicitly node dist/index.js server
AI Assistant Integration
Configure your AI assistant (Claude, Copilot, etc.) to use this MCP server:
{
"mcpServers": {
"ios-code-quality": {
"url": "http://localhost:3000",
"timeout": 30000
}
}
}Configuration
The server supports several configuration options through environment variables:
| Variable | Description | Default |
|---|---|---|
PORT | Server port | 3000 |
NODE_ENV | Environment mode | development |
LOG_LEVEL | Logging verbosity | info |
Example configuration:
export PORT=8080
export LOG_LEVEL=debug
npm start
# or for CLI mode:
PORT=8080 LOG_LEVEL=debug npx ios-mcp-code-quality-server serverConfiguration
Environment variables (with defaults):
# Server Configuration
PORT=3000
NODE_ENV=development
LOG_LEVEL=info
# MCP Server Identity
MCP_SERVER_NAME=ios-mcp-code-quality-server
MCP_SERVER_VERSION=0.1.0
# Security Settings
ALLOWED_HOSTS=127.0.0.1,localhost,127.0.0.1:3000,localhost:3000
RATE_LIMIT_WINDOW_MS=60000
RATE_LIMIT_MAX_REQUESTS=100
# Performance Settings
SESSION_CLEANUP_INTERVAL_MS=300000
MAX_CONCURRENT_TASKS=5Tools & Capabilities
Test Tool
Executes iOS tests and provides detailed failure analysis with support for running specific tests.
Parameters:
xcodeproj(optional): Path to Xcode project filexcworkspace(optional): Path to Xcode workspace file- Note: Either
xcodeprojorxcworkspaceparameter is mandatory (at least one must be provided) scheme(required): Xcode scheme to testdestination(optional): Test destination (simulator/device)- Default value:
generic/platform=iOS Simulator
- Default value:
tests(optional): Array of specific test names to run- Format:
['MyTarget/TestClass/testMethod', 'MyTarget/TestClass'] - Examples:
['MyAppTests/LoginTests/testValidLogin', 'MyAppUITests/HomeScreenTests']
- Format:
target(optional): Target parameter for test execution context- Can be used to specify different test environments or configurations
Example Responses:
Success Case (all tests passed):
{
"content": [
{
"type": "text",
"text": "โ
All tests passed."
}
]
}Build Errors Case (compilation issues):
{
"content": [
{
"type": "text",
"text": "โ Build failed. Please provide the code for the failing test and the class/function under test for better AI suggestions."
}
]
}Test Errors Case (tests built but failed):
{
"content": [
{
"type": "text",
"text": "โ Test failed. Please provide the code for the failing test and the class/function under test for better AI suggestions."
}
]
}List Tests Tool
Discovers and lists all available tests in the iOS project.
Parameters:
xcodeproj(optional): Path to Xcode project filexcworkspace(optional): Path to Xcode workspace file- Note: Either
xcodeprojorxcworkspaceparameter is mandatory (at least one must be provided) scheme(optional): Xcode scheme to analyzedestination(optional): Test destination (simulator/device)
Lint Tool
Performs lint analysis on your iOS project. Currently supported linters: SwiftLint
Usage Examples
CLI Usage Examples
Direct Testing:
# Run all tests in a scheme
npx ios-mcp-code-quality-server test --xcworkspace MyApp.xcworkspace --scheme MyAppTests
# Run tests with specific simulator
npx ios-mcp-code-quality-server test --xcworkspace MyApp.xcworkspace --scheme MyAppTests \
--destination "platform=iOS Simulator,name=iPhone 15 Pro"
# Get machine-readable output for CI/CD
npx ios-mcp-code-quality-server test --xcworkspace MyApp.xcworkspace --scheme MyAppTests --jsonCode Quality Analysis:
# Lint specific files
npx ios-mcp-code-quality-server lint --changed-files "LoginView.swift,UserModel.swift"
# Lint with custom config
npx ios-mcp-code-quality-server lint --changed-files "*.swift" --config-path .swiftlint.yml
# Git workflow integration
git diff --name-only HEAD~1 | grep "\.swift$" | tr '\n' ',' | \
npx ios-mcp-code-quality-server lint --changed-filesDevelopment Workflow:
# Pre-commit hook example
#!/bin/sh
changed_swift_files=$(git diff --cached --name-o
โฆ