README.md•15.1 kB
# Azure DevOps MCP
[](https://badge.fury.io/js/@wangkanai%2Fdevops-mcp)
A dynamic Azure DevOps MCP (Model Context Protocol) server that automatically switches authentication context based on the current working directory. This enables seamless integration with multiple Azure DevOps organizations and projects from a single MCP server.
<a href="https://glama.ai/mcp/servers/@wangkanai/devops-enhanced-mcp">
<img width="380" height="200" src="https://glama.ai/mcp/servers/@wangkanai/devops-enhanced-mcp/badge" alt="DevOps Enhanced MCP server" />
</a>
## Features
- **Local Configuration Files**: Each repository contains `.azure-devops.json` configuration
- **Dynamic Environment Switching**: Automatically detects project context based on directory location
- **Multiple Project Support**: Supports unlimited projects with separate authentication
- **Comprehensive Azure DevOps Integration**: Work items, repositories, builds, and more
- **Zero Configuration Switching**: Seamless switching between projects with local config files
- **Secure Token Storage**: PAT tokens stored locally per repository (excluded from git)
- **Error Handling & Fallback**: Robust error handling with graceful degradation to environment variables
## Local Configuration
Each repository should contain a `.azure-devops.json` configuration file:
### Configuration File Structure
```json
{
"organizationUrl": "https://dev.azure.com/your-org",
"project": "YourProject",
"pat": "your-pat-token-here",
"description": "Azure DevOps configuration for this repository",
"settings": {
"timeout": 30000,
"retries": 3,
"apiVersion": "7.1"
},
"tools": {
"workItems": true,
"repositories": true,
"builds": true,
"pullRequests": true,
"pipelines": true
},
"meta": {
"configVersion": "1.0",
"lastUpdated": "2025-07-21",
"createdBy": "devops-mcp"
}
}
```
### Security Configuration
**Important**: Add `.azure-devops.json` to your `.gitignore` file:
```gitignore
# Azure DevOps MCP local configuration (contains PAT tokens)
.azure-devops.json
```
### Example Projects
#### RiverSync Project
- **Directory**: `/Users/wangkanai/Sources/riversync`
- **Configuration**: `.azure-devops.json` with RiverSync organization settings
#### Mula Project
- **Directory**: `/Users/wangkanai/Sources/mula`
- **Configuration**: `.azure-devops.json` with Mula organization settings
## Installation
### Claude Code Installation (Recommended)
```bash
# Install and add to Claude Code MCP
claude mcp add devops-mcp -- -y @wangkanai/devops-mcp
```
> **Note**: The `-y` flag automatically accepts the package installation prompt, ensuring smooth non-interactive execution for MCP servers.
### Claude Desktop Installation
For Claude Desktop users, add this configuration to your MCP settings:
```json
{
"mcpServers": {
"devops-mcp": {
"command": "npx",
"args": ["-y", "@wangkanai/devops-mcp"]
}
}
}
```
**Claude Desktop MCP Settings Location:**
- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
### Alternative Installation Methods
#### Global Installation
```bash
# Install globally
npm install -g @wangkanai/devops-mcp
# Add to Claude Code MCP
claude mcp add devops-mcp -- devops-mcp
```
#### Development Installation
```bash
# Clone repository
git clone https://github.com/wangkanai/devops-mcp.git
cd devops-mcp
# Install dependencies
npm install
# Build the project
npm run build
# Start the server
npm start
```
## Development
```bash
# Development mode with auto-reload
npm run dev
# Type checking
npm run type-check
# Clean build artifacts
npm run clean
```
## Available Tools
> **📋 For comprehensive command documentation with detailed examples, see [MCP-COMMANDS.md](./MCP-COMMANDS.md)**
### Work Items
- **get-work-items**: Retrieve work items using WIQL queries or specific IDs with field selection
- **create-work-item**: Create new work items with **full hierarchy support** (Epic → Feature → User Story → Task)
- **update-work-item**: Update existing work items including state, assignments, parent relationships, and iteration paths
- **add-work-item-comment**: Add comments to existing work items for progress tracking
### Repositories & Pull Requests
- **get-repositories**: List all repositories in the current project context
- **get-pull-requests**: Get pull requests with filtering options (status, creator, repository)
### Builds & Pipelines
- **get-builds**: Get build definitions and recent build history with filtering
- **trigger-pipeline**: Trigger build pipelines with parameters and branch selection
- **get-pipeline-status**: Get detailed build status and timeline information
### Context Management
- **get-current-context**: Get current Azure DevOps context based on directory
### 🎯 **Key Features**
- ✅ **Hierarchical Work Items**: Full Epic → Feature → User Story → Task hierarchy support
- ✅ **Parent Relationships**: Establish parent-child relationships during work item creation
- ✅ **WIQL Queries**: Powerful Work Item Query Language support for complex searches
- ✅ **Sprint Management**: Iteration path assignment and management
- ✅ **Pipeline Integration**: Trigger builds and monitor deployment status
- ✅ **Multi-Project Support**: Seamless switching between Azure DevOps organizations
## Usage Examples
### Get Current Context
```json
{
"name": "get-current-context",
"arguments": {
"directory": "/Users/wangkanai/Sources/riversync"
}
}
```
### Query Work Items
```json
{
"name": "get-work-items",
"arguments": {
"wiql": "SELECT [System.Id], [System.Title] FROM WorkItems WHERE [System.State] = 'Active'"
}
}
```
### Create Work Item
```json
{
"name": "create-work-item",
"arguments": {
"type": "Task",
"title": "Implement new feature",
"description": "Add authentication system",
"assignedTo": "user@example.com"
}
}
```
### Get Repositories
```json
{
"name": "get-repositories",
"arguments": {
"includeLinks": true
}
}
```
## Directory Detection Logic
The server uses intelligent directory detection:
1. **Exact Match**: Direct match of configured directory paths
2. **Nested Directory Support**: Detects parent project directories
3. **Longest Match Priority**: Most specific directory match takes precedence
4. **Parent Directory Search**: Searches up the directory tree for matches
5. **Fallback Configuration**: Uses default configuration when no match found
## Local Configuration
Each repository should contain a `.azure-devops.json` configuration file:
### Configuration File Structure
```json
{
"organizationUrl": "https://dev.azure.com/your-org",
"project": "YourProject",
"pat": "your-pat-token-here",
"description": "Azure DevOps configuration for this repository",
"settings": {
"timeout": 30000,
"retries": 3,
"apiVersion": "7.1"
},
"tools": {
"workItems": true,
"repositories": true,
"builds": true,
"pullRequests": true,
"pipelines": true
},
"meta": {
"configVersion": "1.0",
"lastUpdated": "2025-07-21",
"createdBy": "devops-mcp"
}
}
```
### Security Configuration
**Important**: Add `.azure-devops.json` to your `.gitignore` file:
```gitignore
# Azure DevOps MCP local configuration (contains PAT tokens)
.azure-devops.json
```
### Example Projects
#### RiverSync Project
- **Directory**: `/Users/wangkanai/Sources/riversync`
- **Configuration**: `.azure-devops.json` with RiverSync organization settings
#### Mula Project
- **Directory**: `/Users/wangkanai/Sources/mula`
- **Configuration**: `.azure-devops.json` with Mula organization settings
## Authentication
The server uses Personal Access Tokens (PAT) for Azure DevOps authentication. PAT tokens are configured per project in local `.azure-devops.json` configuration files within each repository.
### PAT Token Requirements
PAT tokens should have the following scopes:
- **Work Items**: Read & Write
- **Code**: Read
- **Build**: Read
- **Project and Team**: Read
## Error Handling
The server includes comprehensive error handling:
- **Configuration Errors**: Graceful fallback when configuration is missing
- **Authentication Errors**: Clear error messages for authentication failures
- **API Errors**: Detailed error reporting for Azure DevOps API issues
- **Network Errors**: Retry logic and timeout handling
## Testing & Validation
### Enhanced Validation System (Recommended)
The enhanced validation system includes MCP server startup, connection verification, and readiness checks:
#### 1. MCP Server Warmup
```bash
# Prepare MCP servers for validation
./warmup-mcp.sh
# Use custom configuration file
./warmup-mcp.sh custom-config.json
```
#### 2. Enhanced Comprehensive Validation
```bash
# Full validation with MCP server initialization
./validate-enhanced.sh
# Skip interactive Claude tests (faster)
./validate-enhanced.sh --skip-interactive
# Extended warmup for slow systems
./validate-enhanced.sh --warmup 20
# Test only specific repositories
./validate-enhanced.sh --repos "RiverSync,Mula"
# Use custom configuration file
./validate-enhanced.sh --config custom-config.json
# Show all options
./validate-enhanced.sh --help
```
#### 3. Manual Testing
```bash
# Build and test the server manually
npm run build
node test-server.js
```
### Configuration File
The generic validation system uses `validation-config.json`:
```json
{
"proxyPath": "/Users/wangkanai/Sources/devops-mcp",
"repositories": [
{
"name": "RiverSync",
"path": "/Users/wangkanai/Sources/riversync",
"expectedOrganization": "riversync",
"organizationUrl": "https://dev.azure.com/riversync",
"project": "RiverSync",
"enabled": true
}
],
"testSettings": {
"timeoutSeconds": 30,
"skipInteractive": false,
"mcpServerName": "devops-mcp",
"configFileName": ".azure-devops.json"
},
"expectedTools": ["workItems", "repositories", "builds", "pullRequests", "pipelines"]
}
```
### Enhanced Validation Features
The enhanced validation system includes:
#### **🚀 MCP Server Management**
- **Startup Verification**: Ensures MCP servers are properly configured
- **Connection Testing**: Verifies server connectivity with retry logic
- **Readiness Checks**: Confirms servers respond to basic commands
- **Warmup Period**: Configurable delay for server initialization (default: 10s)
#### **🔍 Comprehensive Testing Coverage**
- ✅ **Prerequisites**: PowerShell, Claude Code, directory structure, proxy build
- ✅ **MCP Initialization**: Server startup, connectivity, and readiness verification
- ✅ **Local Configuration**: `.azure-devops.json` file validation with expected values
- ✅ **Server Configuration**: Local scope verification without environment variables
- ✅ **Claude Integration**: MCP command execution and context detection
- ✅ **Dynamic Switching**: Environment switching between multiple repositories
- ✅ **Error Handling**: Comprehensive error detection and reporting with retry logic
### Expected Results
**Full Validation Results:**
- Pass Rate: >90% for successful implementation
- All MCP commands functional in both repositories
- Automatic context switching based on directory location
## Legacy Environment Configuration (Deprecated)
The server previously supported a global `config/environments.json` file for environment mapping. This approach has been **deprecated** in favor of local `.azure-devops.json` configuration files for better security and project isolation.
If you need to migrate from the old environment-based configuration, convert your settings to local configuration files in each repository.
## Architecture
### Core Components
- **AzureDevOpsMCPProxy**: Main server class with MCP protocol handling
- **DirectoryDetector**: Smart directory detection and configuration mapping
- **ToolHandlers**: Azure DevOps API integration and tool implementations
- **ConfigLoader**: Configuration file loading and validation
### Request Flow
1. **Tool Call Received**: MCP client sends tool call request
2. **Context Detection**: Directory detector identifies current project context
3. **Configuration Switch**: Server switches to appropriate Azure DevOps configuration
4. **API Request**: Tool handler makes authenticated API request to Azure DevOps
5. **Response Processing**: Response is formatted and returned to MCP client
## Integration with Claude Code
This MCP server is designed to work seamlessly with Claude Code for Azure DevOps operations:
1. **Automatic Context Switching**: When working in RiverSync or Mula project directories
2. **Transparent Authentication**: No manual configuration required
3. **Rich Tool Set**: Comprehensive Azure DevOps functionality
4. **Error Recovery**: Graceful handling of authentication and network issues
## Security Considerations
- PAT tokens are stored in configuration files (ensure proper file permissions)
- HTTPS is used for all Azure DevOps API communications
- Authentication is handled per-request with proper token encoding
- No token caching or persistence beyond configuration file
## Troubleshooting
### Common Issues
#### 1. Installation Command Issues (Issue #14 Resolution)
**Problem**: Incorrect installation commands that fail to start the server
**Root Cause**: Outdated documentation showing incorrect command syntax
**Solution**: Use the correct installation command:
```bash
# ✅ Correct (RECOMMENDED)
claude mcp add devops-mcp -- -y @wangkanai/devops-mcp
# ❌ Incorrect (will fail)
```
**Alternative working commands**:
```bash
# Global installation method
npm install -g @wangkanai/devops-mcp
claude mcp add devops-mcp -- devops-mcp
```
#### 2. Configuration Issues
1. **Configuration Not Found**: Ensure `.azure-devops.json` exists in your project directory
2. **Authentication Errors**: Verify PAT token permissions and expiration in your local configuration
3. **Directory Detection**: Check that your project has a valid `.azure-devops.json` file
4. **API Errors**: Verify Azure DevOps organization and project names in your local configuration
#### 3. Installation Verification
Test your installation with these commands:
```bash
# Test server startup (build and run directly)
npm run build && node dist/index.js
# Verify MCP integration
mcp__devops-mcp__get-current-context
# Test work item creation
mcp__devops-mcp__create-work-item --type "Task" --title "Test Item"
```
### Debug Mode
Enable debug logging by setting environment variable:
```bash
export DEBUG=devops-mcp
npm start
```
### NPM Package Technical Details
- **Package Name**: `@wangkanai/devops-mcp`
- **Binary Name**: `devops-mcp` (auto-generated by NPM)
- **Latest Version**: Check with `npm view @wangkanai/devops-mcp version`
- **Installation Verification**: `npm list -g @wangkanai/devops-mcp`
## License
MIT License - see LICENSE file for details.