Azuredevops MCP

🚀 Azure DevOps MCP Server Guide

This guide provides a comprehensive introduction to the Azure DevOps MCP server, which uses the Machine Class Protocol (MCP) to interact with Azure DevOps services. It enables you to automate and manage various development tasks efficiently.

🚀 Quick Start

Configuration of the Project

Authentication Settings

To connect to Azure DevOps, you must configure authentication. The following methods are supported:

1. Personal Access Token (PAT)

   az devops login --organization https://dev.azure.com/your-org --username your-username --password your-pat
   

2. OAuth2.0

   • Log in to Azure DevOps.
   • Generate a new access token.
   • Use the generated token for authentication.

Connecting to an Azure DevOps Organization

Specify the target organization in the project configuration file:

export const config = {
  organization: 'your-org',
  project: 'your-project',
  // Other configurations...
};

📦 Project Structure

The project is divided into the following main parts:

• src/
  • Interfaces/: Defines the types of parameters and responses.
  • Services/: Handles communication with the Azure DevOps API.
  • Tools/: Provides the functional implementation of the MCP protocol interface.
  • index.ts: The entry point for starting the server.
  • config.ts: Manages configurations.

✨ Features

Service Layer

Core Service Classes

• WorkItemService: Handles work item operations, such as creation, update, and query.
• GitService: Manages code repositories, including branch, tag, and commit operations.
• BuildService: Controls the build process and monitors the build status.
• ReleaseService: Manages the release pipeline and performs environment configuration.

Example Code

// src/Services/WorkItemService.ts
export class WorkItemService {
  private client: WorkItemHttpClient;

  constructor() {
    this.client = new WorkItemHttpClient();
  }

  public async getWorkItems(query: string): Promise<WorkItem[]> {
    return await this.client.queryWorkItems(query);
  }
}

Tool Layer

Tool Implementations

• GitTools: Provides interfaces for code repository operations, such as listRepositories and getBranches.
• BuildTools: Encapsulates build-related functions, such as queueBuild and getBuildStatus.

Configuration Management

Project configurations are stored in the config.ts file:

export const config = {
  organizationUrl: 'https://dev.azure.com/your-org',
  projectId: 'your-project-id',
  authentication: {
    type: 'pat', // Optional: 'oauth2'
    token: 'your-personal-access-token'
  }
};

Authentication Flow

1. Initialize the Authentication Provider

   const authProvider = new AzureAuthProvider(config.authentication);
   

2. Get the Access Token

   async function getAccessToken(): Promise<string> {
     return await authProvider.getAccessToken();
   }
   

💻 Usage Examples

Basic Usage

The following code demonstrates how to use the WorkItemService to query work items:

// src/Services/WorkItemService.ts
export class WorkItemService {
  private client: WorkItemHttpClient;

  constructor() {
    this.client = new WorkItemHttpClient();
  }

  public async getWorkItems(query: string): Promise<WorkItem[]> {
    return await this.client.queryWorkItems(query);
  }
}

Advanced Usage

You can expand the functionality of the service classes according to your specific requirements. For example, you can add more complex query logic to the WorkItemService.

📚 Documentation

Troubleshooting

Common Issues

1. Authentication Errors

• Ensure that your personal access token is valid and has the correct permissions.
• Check if the organization URL is correct.

2. TypeScript Compilation Errors

• Use npm run build:ignore-errors to skip type checking.
• Check for missing or incorrect type definitions.

Contribution Guidelines

Contributions are welcome! Follow these steps:

1. Fork the repository
2. Create a feature branch

   git checkout -b feature/amazing-feature
   

3. Commit your changes

   git add .
   git commit -m "Add a new feature"
   

4. Push to GitHub

   git push origin feature/amazing-feature
   

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.