MCP Server Azure Devops

🚀 Azure DevOps MCP Server

The Azure DevOps MCP (Model Context Protocol) Server is a tool for interacting with Azure DevOps services, offering various functions such as user management, project management, code repository access, work item operations, search functions, pipeline management, Wiki operations, and pull request management.

🚀 Quick Start

Prerequisites

1. Install Node.js and npm:
   • Make sure you have Node.js and npm installed. You can download and install them from the official Node.js website.
2. Clone the repository:

   git clone https://github.com/tiberriver256/mcp-server-azure-devops.git
   cd mcp-server-azure-devops
   

3. Install dependencies:

   npm install
   

4. Configure environment variables:
   • Set the necessary environment variables (e.g., AZURE_DEVOPS_TOKEN) as required in the documentation.
5. Run the server:

   node index.js
   

✨ Features

The Azure DevOps MCP Server provides a wide range of features, including user management, project management, code repository access, work item operations, search functions, pipeline management, Wiki operations, and pull request management.

🔧 Technical Details

Server Structure

Core Components

• User Tools
  • get_me: Get detailed information (ID, display name, email) of the authenticated user.
• Organization Tools
  • list_organizations: List all accessible organizations.
• Project Tools
  • list_projects: List all projects in an organization.
  • get_project: Get detailed information about a specific project.
  • get_project_details: Get comprehensive details of a project, including processes, work item types, and teams.
• Repository Tools
  • list_repositories: List all repositories in a project.
  • get_repository: Get detailed information about a specific repository.
  • get_repository_details: Get detailed information about a repository, including statistics and references.
  • get_file_content: Get the content of a file or directory in a repository.
• Work Item Tools
  • get_work_item: Get a work item by ID.
  • create_work_item: Create a new work item.
  • update_work_item: Update an existing work item.
  • list_work_items: List work items in a project.
  • manage_work_item_link: Add, delete, or update links between work items.
• Search Tools
  • search_code: Search for code in a project's repositories.
  • search_wiki: Search for Wiki content in a project.
  • search_work_items: Search for work items in all projects in Azure DevOps.
• Pipeline Tools
  • list_pipelines: List all pipelines in a project.
  • get_pipeline: Get detailed information about a specific pipeline.
  • trigger_pipeline: Trigger a pipeline run with customizable parameters.
• Wiki Tools
  • get_wikis: List all Wikis in a project.
  • get_wiki_page: Get the content (in plain text format) of a specific Wiki page.
• Pull Request Tools
  • create_pull_request: Create a new pull request between repositories.
  • list_pull_requests: List and filter pull requests in a project or repository.
  • get_pull_request_comments: Get comments and their discussion threads for a specific pull request.
  • add_pull_request_comment: Add a comment to a pull request (reply to an existing comment or create a new thread).

Authentication Methods

Implementation Details

The authentication module is located in the src/auth directory of the project. It supports multiple authentication methods, including:

• Token-based authentication:
  • Authenticate using an Azure DevOps personal access token.
  • Example configuration file:

    {
      "auth": {
        "method": "token",
        "token": "your_azure_devops_token"
      }
    }
    

• OAuth-based authentication:
  • Authenticate using OAuth 2.0.
  • Example configuration file:

    {
      "auth": {
        "method": "oauth",
        "clientId": "your_client_id",
        "clientSecret": "your_client_secret"
      }
    }
    

Environment Variables

The following are some commonly used environment variables and their descriptions:

Error Handling

Common Errors and Solutions

1. Unauthorized error:
   • Ensure that you have set and are using a valid Azure DevOps token or OAuth token.
2. Insufficient permissions error:
   • Check if your token has sufficient permissions to perform the required operations.
   • If higher permissions are needed, generate a new token and grant appropriate permissions.
3. Network connection issue:
   • Ensure that you have a stable internet connection and are not blocked by a firewall or proxy from accessing the Azure DevOps service.
4. Parsing error:
   • Check if the URL of the API request is correct and ensure that the returned data format matches the expected format.

Troubleshooting

Debugging Steps

1. Check the log output:
   • When running the server, pay attention to any error or warning messages in the console output.

   node index.js --debug
   

2. Verify the configuration file:
   • Ensure that all parameters in the config.json file are correct.
3. Reinstall dependencies:
   • If you encounter unexpected issues, try deleting the node_modules directory and reinstalling the dependencies.

   rm -rf node_modules && npm install
   

💻 Usage Examples

Basic Usage

1. Create a new work item:

   const mcp = require('mcp-server-azure-devops');
   mcp.createWorkItem({
     title: 'New feature requirement',
     description: 'Develop a new user story feature.'
   }, (error, workItem) => {
     if (error) {
       console.error('Error creating work item:', error);
     } else {
       console.log('Work item created, ID:', workItem.id);
     }
   });
   

2. Search for code:

   mcp.searchCode('Feature:X', (error, results) => {
     if (error) {
       console.error('Error searching for code:', error);
     } else {
       console.log('Files found:', results.files);
     }
   });
   

3. Trigger a pipeline run:

   mcp.triggerPipeline('main', 'master', (error, pipelineRun) => {
     if (error) {
       console.error('Error triggering pipeline:', error);
     } else {
       console.log('Pipeline triggered, run ID:', pipelineRun.id);
     }
   });
   

📄 License

This project is licensed under the MIT License.

📚 Documentation

Submitting Issues

If you encounter any problems or need help during use, please submit issues in the following ways:

1. GitHub Issues:
   • Visit the project repository and submit your issues in the Issues section.
2. Email contact:
   • Send an email to support@yourdomain.com to contact the development team.

Changelog

Latest Versions

• v1.0.0: Initial version with basic features.
• v1.1.0: Added OAuth support and fixed several known bugs.
• v1.2.0: Improved performance and stability, and supported more Azure DevOps features.