MCP Codepipeline Server

🚀 AWS CodePipeline MCP Server

This is a Model Context Protocol (MCP) server integrated with AWS CodePipeline, allowing you to manage and operate pipelines through Windsurf and Cascade. The server offers a rich set of features, including pipeline creation, modification, deletion, as well as monitoring and management of pipeline resources.

✨ Features

• Pipeline Lifecycle Management: Supports pipeline creation, start, stop, and deletion operations.
• Resource Monitoring and Alarming: Monitors pipeline running status in real-time, provides detailed running logs, and can trigger alarms based on preset conditions.
• Extended Integration: Supports integration with other AWS services (such as CloudWatch, S3, etc.) to implement automated workflows.
• Multi-Tenant Support: Allows independent management of pipeline resources in different environments, suitable for enterprise users.

📋 Prerequisites

1. Operating System Requirements: Linux or macOS
2. Node.js Version: >= 14.x
3. npm Version: >= 6.x
4. AWS Account and Corresponding Permissions (Requires permissions to operate CodePipeline and CloudWatch)
5. Familiarity with basic concepts of pipeline management and the use of AWS CLI tools

📦 Installation

Step 1: Clone the Repository

git clone https://github.com/your-organization/aws-codepipeline-mcp.git
cd aws-codepipeline-mcp

Step 2: Install Dependencies

npm install

Step 3: Configure Environment Variables

Create and edit the .env file, adding the following content:

# AWS Configuration
AWS_REGION=us-east-1
AWS_ACCESS_KEY_ID=YOUR_ACCESS_KEY
AWS_SECRET_ACCESS_KEY=YOUR_SECRET_KEY

# MCP Service Configuration
MCP_PORT=3000

Step 4: Start the Service

npm start

💻 Usage Examples

Create a Pipeline

Use the AWS CLI to create a new CodePipeline pipeline:

aws codepipeline create-pipeline \
--name MyFirstPipeline \
--pipeline {
  "Stages": [
    {
      "Name": "Source",
      "Actions": [
        {
          "Name": "GetSource",
          "ActionTypeId": {
            "Category": "Source",
            "Owner": "ThirdParty",
            "Provider": "GitHub",
            "Version": "1"
          },
          "Configuration": {
            "Owner": "your-org",
            "Repo": "my-repo",
            "Branch": "main"
          }
        }
      ]
    },
    {
      "Name": "Build",
      "Actions": [
        {
          "Name": "BuildAction",
          "ActionTypeId": {
            "Category": "Build",
            "Owner": "AWS",
            "Provider": "CodeBuild",
            "Version": "1"
          },
          "Configuration": {
            "ProjectName": "my-build-project"
          }
        }
      ]
    }
  ],
  "Artifacts": {
    "Location": {
      "S3Location": "my-bucket/pipeline-artifacts"
    }
  }
}

Query Pipeline Status

Query the pipeline running status through the AWS CLI:

aws codepipeline list-pipelines --region us-east-1
aws codepipeline get-pipeline-state --name MyFirstPipeline --region us-east-1

Create a Pipeline with Conditional Judgments

The following is an example of a complex pipeline configuration containing conditional judgments:

{
  "Stages": [
    {
      "Name": "Source",
      "Actions": [
        {
          "Name": "CheckoutCode",
          "ActionTypeId": {
            "Category": "Source",
            "Owner": "ThirdParty",
            "Provider": "GitHub",
            "Version": "1"
          },
          "Configuration": {
            "Repo": "my-repo",
            "Branch": "main"
          }
        }
      ]
    },
    {
      "Name": "Validation",
      "Actions": [
        {
          "Name": "ValidateCode",
          "ActionTypeId": {
            "Category": "Build",
            "Owner": "Custom",
            "Provider": "MyValidator",
            "Version": "1"
          }
        }
      ]
    },
    {
      "Name": "Build",
      "Actions": [
        {
          "Name": "BuildCode",
          "ActionTypeId": {
            "Category": "Build",
            "Owner": "AWS",
            "Provider": "CodeBuild",
            "Version": "1"
          }
        }
      ]
    },
    {
      "Name": "Deploy",
      "Conditions": [
        {
          "Type": "StringEquals",
          "Key": "ValidationResult",
          "Value": "Success"
        }
      ],
      "Actions": [
        {
          "Name": "DeployToStage",
          "ActionTypeId": {
            "Category": "Deploy",
            "Owner": "AWS",
            "Provider": "CodeDeploy",
            "Version": "1"
          },
          "Configuration": {
            "DeploymentGroupName": "my-stage-deployment-group"
          }
        }
      ]
    }
  ],
  "Artifacts": {
    "Location": {
      "S3Location": "my-bucket/pipeline-artifacts"
    }
  }
}

Pipeline Cleanup Strategy

To ensure the tidiness of pipeline resources, it is recommended to implement the following cleanup strategies:

1. Regularly Check Unused Pipelines: Use the AWS CLI to regularly list all pipelines and remove those that are no longer needed.
2. Set Default Expiration Time: For experimental pipelines, configure a reasonable expiration time so that the pipelines will be automatically deleted after the specified duration.
3. Monitor Resource Usage: Monitor the number of pipeline runs and time consumption through CloudWatch to analyze if there are redundant or inefficient pipelines.

⚠️ Important Note

• Ensure that your AWS account has sufficient permissions to perform the required operations.
• Regularly back up important pipeline configurations to avoid data loss due to misoperations.
• Conduct comprehensive functional tests and performance tuning before using in a production environment.

📚 Documentation

• AWS CodePipeline User Guide
• CodePipeline REST API Reference Documentation
• CodeBuild User Guide
• CodeDeploy User Guide

🛠️ Support

If you need help or encounter problems, please contact our support team at support@your-provider.com.