A CLI and MCP server for analyzing iOS code quality using AI suggestions and test results.
npm install ios-mcp-code-quality-serverA versatile iOS code quality analysis tool that operates in two modes:
1. CLI Tool: Direct command-line interface for iOS testing and linting
2. 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.
Use instantly without installation:
``bashRun iOS tests
npx ios-mcp-code-quality-server test --xcworkspace MyApp.xcworkspace --scheme MyAppTests
$3
For frequent use across multiple projects, you can install globally:
`bash
npm install -g ios-mcp-code-quality-serverThen 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
npx is recommended as it ensures you always use the latest version without global installs.$3
`bash
Start as MCP server (no arguments)
npx ios-mcp-code-quality-serverOr explicitly start server mode
npx ios-mcp-code-quality-server server
`The 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:
$3
- 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$3
- 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 debuggingSimple Mode Detection:
`bash
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 lint
`CLI Usage
$3
Use
npx to run the CLI directly without installation:`bash
npx ios-mcp-code-quality-server --help # Show all available commands
npx ios-mcp-code-quality-server --help # Show help for specific command
`$3
#### Test Command
Run iOS tests with comprehensive analysis:
`bash
Basic usage
npx ios-mcp-code-quality-server test --xcworkspace MyApp.xcworkspace --scheme MyAppTestsWith 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 MyAppTestsGet JSON output for script integration
npx ios-mcp-code-quality-server test --xcworkspace MyApp.xcworkspace --scheme MyAppTests --jsonVerbose logging for debugging
npx ios-mcp-code-quality-server test --xcworkspace MyApp.xcworkspace --scheme MyAppTests --verbose
`Test Command Options:
-
--xcworkspace : Path to .xcworkspace file
- --xcodeproj : Path to .xcodeproj file (either xcworkspace or xcodeproj required)
- --scheme : Scheme name for testing (required)
- --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:
`bash
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.ymlGet JSON output
npx ios-mcp-code-quality-server lint --changed-files "ViewController.swift" --jsonVerbose output
npx ios-mcp-code-quality-server lint --changed-files "*.swift" --verbose
`Lint Command Options:
-
--changed-files : Comma-separated list of files to lint (required)
- --config-path : Path to SwiftLint configuration file
- --json: Output results in JSON format
- --verbose: Enable verbose logging#### Server Command
Start MCP server mode explicitly:
`bash
Start server on default port (3000)
npx ios-mcp-code-quality-server serverStart server on custom port
npx ios-mcp-code-quality-server server --port 8080Server with custom settings
PORT=3001 LOG_LEVEL=debug npx ios-mcp-code-quality-server server
`$3
`bash
Complete iOS project test workflow
npx ios-mcp-code-quality-server test --xcworkspace MyApp.xcworkspace --scheme MyAppTests --verboseQuick 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.jsonCheck specific Swift files before commit
npx ios-mcp-code-quality-server lint --changed-files "LoginViewController.swift,UserModel.swift" --config-path .swiftlint.yml
`MCP Server Installation
$3
- 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
$3
1. Clone the repository:
`bash
git clone https://github.com/a-25/ios-mcp-code-quality-server.git
cd ios-mcp-code-quality-server
`2. Install dependencies:
`bash
npm install
`3. Build the project:
`bash
npm run build
`4. Start the server:
`bash
npm start
# or explicitly
node dist/index.js server
`$3
Configure your AI assistant (Claude, Copilot, etc.) to use this MCP server:
`json
{
"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:
`bash
export PORT=8080
export LOG_LEVEL=debug
npm start
or for CLI mode:
PORT=8080 LOG_LEVEL=debug npx ios-mcp-code-quality-server server
`$3
Environment variables (with defaults):
`bash
Server Configuration
PORT=3000
NODE_ENV=development
LOG_LEVEL=infoMCP Server Identity
MCP_SERVER_NAME=ios-mcp-code-quality-server
MCP_SERVER_VERSION=0.1.0Security Settings
ALLOWED_HOSTS=127.0.0.1,localhost,127.0.0.1:3000,localhost:3000
RATE_LIMIT_WINDOW_MS=60000
RATE_LIMIT_MAX_REQUESTS=100Performance Settings
SESSION_CLEANUP_INTERVAL_MS=300000
MAX_CONCURRENT_TASKS=5
`Tools & Capabilities
$3
Executes iOS tests and provides detailed failure analysis with support for running specific tests.Parameters:
-
xcodeproj (optional): Path to Xcode project file
- xcworkspace (optional): Path to Xcode workspace file
- Note: Either xcodeproj or xcworkspace parameter is mandatory (at least one must be provided)
- scheme (required): Xcode scheme to test
- destination (optional): Test destination (simulator/device)
- Default value: generic/platform=iOS Simulator
- tests (optional): Array of specific test names to run
- Format: ['MyTarget/TestClass/testMethod', 'MyTarget/TestClass']
- Examples: ['MyAppTests/LoginTests/testValidLogin', 'MyAppUITests/HomeScreenTests']
- target (optional): Target parameter for test execution context
- Can be used to specify different test environments or configurationsExample Responses:
Success Case (all tests passed):
`json
{
"content": [
{
"type": "text",
"text": "โ
All tests passed."
}
]
}
`Build Errors Case (compilation issues):
`json
{
"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):
`json
{
"content": [
{
"type": "text",
"text": "โ Test failed. Please provide the code for the failing test and the class/function under test for better AI suggestions."
}
]
}
`$3
Discovers and lists all available tests in the iOS project.Parameters:
-
xcodeproj (optional): Path to Xcode project file
- xcworkspace (optional): Path to Xcode workspace file
- Note: Either xcodeproj or xcworkspace parameter is mandatory (at least one must be provided)
- scheme (optional): Xcode scheme to analyze
- destination (optional): Test destination (simulator/device)$3
Performs lint analysis on your iOS project. Currently supported linters: SwiftLintUsage Examples
$3
Direct Testing:
`bash
Run all tests in a scheme
npx ios-mcp-code-quality-server test --xcworkspace MyApp.xcworkspace --scheme MyAppTestsRun 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 --json
`Code Quality Analysis:
`bash
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.ymlGit workflow integration
git diff --name-only HEAD~1 | grep "\.swift$" | tr '\n' ',' | \
npx ios-mcp-code-quality-server lint --changed-files
`Development Workflow:
`bash
Pre-commit hook example
#!/bin/sh
changed_swift_files=$(git diff --cached --name-only --diff-filter=ACM | grep "\.swift$" | tr '\n' ',' | sed 's/,$//')
if [ -n "$changed_swift_files" ]; then
npx ios-mcp-code-quality-server lint --changed-files "$changed_swift_files" || exit 1
fi
`$3
Running Tests with AI Assistant:
`
"Can you run the tests for the LoginFeature scheme and tell me what failed?"
``
"Run only the LoginTests for the MyApp scheme"
``
"List all available tests in my project and then run the failing ones"
`The AI assistant will use the enhanced test tools to:
1. Discover available tests using the list-tests tool
2. Execute specific tests or all tests for the specified scheme
3. Validate test names and provide suggestions for typos
4. Parse build and test results with detailed failure analysis
5. Provide structured summaries of failures with file locations and line numbers
Code Quality Analysis:
`
"Please analyze the code quality of my iOS project using SwiftLint"
`Troubleshooting
$3
CLI command not found:
- If using global install:
npm install -g . from the project directory
- Otherwise use: node dist/index.js from the project directory
- Verify build completed: npm run buildServer won't start:
- Check that port 3000 is available:
lsof -i :3000
- Ensure Node.js 18+ is installed: node --version
- Verify dependencies are installed: npm listTests fail to run:
- Ensure Xcode is installed and command line tools are available
- Check that the specified scheme exists in your project
- Verify the destination device/simulator is available:
xcrun simctl list devices
- For CLI mode: ensure xcworkspace/xcodeproj paths are correct and accessibleSwiftLint not working:
- Install SwiftLint:
brew install swiftlint
- Verify installation: swiftlint version
- For CLI mode: ensure changed-files paths are correct and files existMCP Connection Issues:
- Verify the server is running: check that the process is active on port 3000 with
lsof -i :3000
- Check AI assistant MCP configuration
- Review server logs for connection errors$3
Enable detailed logging for troubleshooting:
CLI Mode:
`bash
npx ios-mcp-code-quality-server test --xcworkspace MyApp.xcworkspace --scheme MyAppTests --verbose
`MCP Server Mode:
`bash
export LOG_LEVEL=debug
npm start
or
LOG_LEVEL=debug npx ios-mcp-code-quality-server server
`Development
$3
`bash
Run all tests
npm testRun with coverage
npm run test:coverage
`$3
`bash
Run linter
npm run lintFix linting issues
npm run lint:fixType checking
npm run type-check
`$3
`bash
npm run build
`Contributing
We welcome contributions! Please follow these steps:
1. Fork the repository
2. Create a feature branch:
git checkout -b feature/amazing-feature
3. Make your changes and add tests
4. Ensure all tests pass: npm test
5. Commit your changes: git commit -m 'Add amazing feature'
6. Push to your branch: git push origin feature/amazing-feature`- Write tests for new features
- Follow TypeScript best practices
- Update documentation for API changes
- Ensure backwards compatibility when possible
This project is licensed under the MIT License - see the LICENSE file for details.
- All processing happens locally on your machine
- No data is sent to external services without explicit configuration
- Do not share your local server endpoint publicly
- Keep dependencies updated to address security vulnerabilities
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Documentation: This README and inline code documentation
---
Made with โค๏ธ for the iOS development community