Ado MCP

🚀 Azure DevOps Multi-Tenant Control Plane (MCP)

The Azure DevOps MCP provides a multi - tenant control plane solution for managing Azure DevOps organizations and projects.

🚀 Quick Start

This README provides a comprehensive overview of the Azure DevOps MCP project, including its architecture, class diagrams, configuration instructions, usage examples, development guidelines, and licensing information.

📦 Project Structure Diagram

The following figure shows the overall architecture of the Azure DevOps MCP project:

📚 Class Diagram

The following is the class diagram of Azure DevOps MCP, which shows the relationships and interactions between various components:

classDiagram

    class ADOrganization {
        string name
        string description
        void addProject()
        void removeProject()
        ProjectsList projects
    }

    class ADProject {
        string id
        string name
        string state
        Repository[] repositories
        Pipeline[] pipelines
    }

    class ProjectManager {
        ADProject currentProject
        void switchProject(string projectId)
        void createProject(ADProject project)
        void deleteProject(string projectId)
        ProjectsList listProjects()
    }

    class ADOrganization {
        <<Aggregate Root>>
        string name
        string description
        ADProject[] projects
    }

    class ADUser {
        string id
        string email
        string firstName
        string lastName
        Role role
    }

    class Repository {
        string id
        string name
        Branch[] branches
        PullRequest[] pullRequests
    }

    class Pipeline {
        string id
        string name
        string state
        Job[] jobs
    }

    class ADOrganizationRepository {
        void save(ADOrganization org)
        ADOrganization findById(string id)
        List<ADOrganization> findAll()
    }

    ProjectManager o -> ADOrganizationRepository: findCurrentOrganization()

    ProjectManager --> ADProject: CurrentProject

    ADUser --> Role: hasRole()

    ADProject --> Repository: getRepositories()

    ADProject --> Pipeline: getPipelines()

    Repository --> Branch: getBranches()

    Repository --> PullRequest: getPullRequests()

    Pipeline --> Job: getJobs()

📚 Documentation

Configuration Instructions

Environment Variable Configuration

• ADO_ORGANIZATION: Azure DevOps organization name (required)
• ADO_PROJECT: Default project name (optional)
• ADO_PAT: Personal access token for authentication (required)
• ADO_API_URL: API base URL (optional, default is https://dev.azure.com)
• ADO_API_VERSION: API version (optional, default is 7.0)
• ADO_API_MAX_RETRIES: Maximum number of retries for API calls (optional, default is 3)
• ADO_API_DELAY_MS: Delay time between retries (in milliseconds) (optional, default is 1000)
• ADO_API_USE_KERBEROS: Whether to enable Kerberos authentication (optional, default is false)

Configuration File Example

# Configuration file path: config/azure-devops-mcp.properties

# Azure DevOps organization name
organization.name = my_organization

# Default project ID
project.id = 12345678-9abc-defg-1234-56789abcdef

# API base URL
api.url = https://dev.azure.com

# Personal access token
pat.token = your_personal_access_token_here

# Maximum number of retries
max.retries = 3

# Retry delay (milliseconds)
retry.delay.ms = 1000

💻 Usage Examples

Basic Usage

List All Projects

{
    "id": "12345678-9abc-defg-1234-56789abcdef",
    "name": "MyProject",
    "description": "This is my project description.",
    "state": "active"
}

Get Repository Information

{
    "id": "repo_123",
    "name": "my_repository",
    "branches": [
        {
            "name": "main",
            "commit": {
                "sha": "abc123def456789",
                "message": "Initial commit"
            }
        }
    ],
    "pullRequests": [
        {
            "id": 1,
            "title": "Add feature X",
            "status": "open"
        }
    ]
}

🔧 Technical Details

Development Guidelines

Build the Project

mvn clean install -DskipTests

Run the Server

mvn spring-boot:run

Docker Image Build

# Base image
FROM openjdk:jdk17

# Set the working directory
WORKDIR /app

# Copy project files
COPY . .

# Package the application
RUN mvn clean install -DskipTests && \
    cp target/azure-devops-mcp.jar .

# Run the application
CMD ["java", "-jar", "target/azure-devops-mcp.jar"]

📄 License

MIT License

Copyright (c) 2024 Azure DevOps MCP Development Team.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

⚠️ Important Note

For commercial use, please contact the development team for authorization.