Cursor Azure Devops MCP

🚀 Azure DevOps Cursor Tool

The Azure DevOps Cursor Tool is a powerful utility designed for interacting with Azure DevOps services. It enables users to perform a variety of operations via the command line or scripts, including querying work items, code repositories, pull requests, and managing tests.

🚀 Quick Start

System Requirements

• Operating System: Windows, macOS, and Linux are supported.
• Node.js Version: v12 or higher.
• Npm Version: 6.0 or higher.

Installation Steps

1. Install the tool using the Node Package Manager (npm):

   npm install -g azdo-cursor
   

2. Verify the installation:

   azdo-cursor --version
   

Environment Variable Configuration

To connect to Azure DevOps, you need to set the following environment variables:

• AZURE_DEVOPS_ORG_URL: Specify the organization URL (e.g., https://dev.azure.com/your-org).
• AZURE_DEVOPS_PROJECT: Optional, the default project name.
• AZURE_DEVOPS_TOKEN: Required, a Personal Access Token (PAT).

✨ Features

Basic Commands

Here are some commonly used tool commands:

azdo-cursor --help          # Display help information
azdo-cursor work-items     # Get work items
azdo-cursor pr [REPO_ID]    # Get pull requests
azdo-cursor test-plans      # Get test plans

Advanced Features

• Code Repository Management: Provides comprehensive support for Git repositories, including commit, branch, and tag operations.
• Pull Request Handling: Supports creating, updating, and deleting pull requests, and viewing detailed comments.
• Work Item Tracking: Allows querying, creating, and updating work items, with support for attachment and comment management.

💻 Usage Examples

Basic Usage

# Example 1: Connect to Azure DevOps
export AZURE_DEVOPS_ORG_URL="https://dev.azure.com/contoso"
export AZURE_DEVOPS_PROJECT="DefaultCollection"
export AZURE_DEVOPS_TOKEN="your-pat-token"

azdo-cursor work-items --projectId=project001

Advanced Usage

# Example 2: Get pull requests
azdo-cursor pr repo001 \
    --branch "main" \
    --status "all" \
    --output json > pull-requests.json

📚 Documentation

Work Item Commands

• work-items: Get all work items in the project.
• work-item <id>: Get a specific work item by ID.

Pull Request Commands

• pr [REPO_ID]: Get all pull requests in the specified repository.
• pr getById <REPO_ID> <PR_ID>: Get specific pull request information by repository ID and PR ID.
• create-pr [REPO_ID] --title "Title" --description "Description": Create a new pull request.

Test Management Commands

• test-plans: List all test plans.
• test-suite <SUITE_ID>: Execute the specified test suite and generate a result report.

Detailed Parameters

Work Item Command Parameters

Pull Request Command Parameters

Test Management Command Parameters

Use Cases

Project Management

• Query Tasks: Quickly find all pending tasks using the work-items command.
• Update Status: Update the status of a specific work item, e.g., azdo-cursor work-item 123 --state Resolved.

Development Process

• Create PR: Create a pull request for review before submitting code.
• Get Feedback: View all relevant comments and modify the code based on feedback.

Test Execution

• Plan Management: List all available test plans using test-plans and select the plan to execute by specifying parameters.
• Result Analysis: After execution, view the generated result report to identify potential issues.

Error Handling

Common Errors

1. Authentication Failure:
   • Check if the environment variables are set correctly, especially the validity of AZURE_DEVOPS_TOKEN.
2. Project Not Found:
   • Ensure that the specified projectId is valid and the user has the appropriate permissions.

Advanced Features

Automation Scripts

You can create automation scripts to complete complex tasks by combining multiple commands. For example:

# Example: Get all open work items and output to a file
azdo-cursor work-items --projectId=project001 --filterByState=open --output=json > open-issues.json

# Example: Batch update work item status
for i in $(cat open-issues.json | jq -r '.[].id'); do azdo-cursor work-item $i --state Resolved; done

Logging

The tool supports detailed log output for debugging and monitoring operations:

azdo-cursor pr repo001 --verbose > pull-request.log 2>&1

Test Management Tool

Function Overview

The test management feature allows users to execute test plans via the command line and automatically generate result reports.

Command Examples

# Get all test plans
azdo-cursor test-plans

# Execute a specific test suite
azdo-cursor test-suite 123 --runMode parallel --resultFormat json > test-results.json

Parameter Explanation

• --planId: Specify the ID of the test plan to execute.
• --runMode: Set the run mode, supporting parallel or serial execution.
• --resultFormat: Control the result output format, supporting JSON and XML.

Best Practices

1. Configuration Management: Always keep the environment variables up-to-date and ensure appropriate permissions.
2. Log Monitoring: Enable detailed logging for troubleshooting during large-scale operations.
3. Regular Updates: Check for tool updates regularly to get new features and performance improvements.

Issues and Feedback

If you encounter any issues during use, please provide feedback in the following ways:

• Submit GitHub Issues: https://github.com/azdo-cursor/issues
• Join the user community discussion: Discord Community

Appendix

Error Codes

Output Formats

• JSON: Standard JSON structure for easy subsequent processing.
• Text: Human-readable text output.

Supported Branches

• Main: Stable version
• Dev: Latest feature development version

Update Log

Version 1.0.0 (2023-10-15)

• Added test management functionality.
• Improved the performance of work item commands.
• Fixed authentication-related bugs.

Version 0.9.0 (2023-08-14)

• Initial release, including basic project management and pull request features.