# Jenkins to GitHub Actions MCP Server

An MCP (Model Context Protocol) Server that converts Jenkinsfiles to GitHub Actions workflows. This tool helps you migrate your CI/CD pipelines from Jenkins to GitHub Actions by automatically converting declarative Jenkins pipelines into equivalent GitHub Actions workflow YAML files.

## Quick Start

```bash
# Install dependencies
npm install

# Build the project
npm run build

# Run tests
npm test

# Start the MCP server
npm start

# Try the examples
node examples/test-converter.js
node examples/test-mcp-tools.js
```

## Features

- 🔄 Convert Jenkins declarative pipelines to GitHub Actions workflows
- 📊 Analyze Jenkinsfile structure and extract pipeline information
- 🔍 Support for common Jenkins pipeline constructs:
  - Stages and steps
  - Environment variables
  - Shell commands (`sh`)
  - Echo commands
  - SCM checkout
- ⚡ MCP protocol integration for seamless AI assistant interaction
- 🛠️ Both JSON and YAML output formats

## Installation

```bash
npm install
npm run build
```

## Usage

### As an MCP Server

The server can be integrated with MCP-compatible clients (like Claude Desktop):

```bash
npm start
```

### Configuration for Claude Desktop

Add to your Claude Desktop configuration:

```json
{
  "mcpServers": {
    "jenkins-to-github-actions": {
      "command": "node",
      "args": ["/path/to/jenkins-to-github-actions-mcp-server/dist/index.js"]
    }
  }
}
```

### Available Tools

#### 1. `convert_jenkinsfile`

Convert a Jenkinsfile to GitHub Actions workflow.

**Parameters:**
- `jenkinsfile` (string, required): The content of the Jenkinsfile to convert
- `format` (string, optional): Output format - "yaml" or "json" (default: "yaml")

**Example:**

```javascript
{
  "jenkinsfile": "pipeline { agent any stages { stage('Build') { steps { sh 'npm install' } } } }",
  "format": "yaml"
}
```

#### 2. `analyze_jenkinsfile`

Analyze a Jenkinsfile and provide information about its structure.

**Parameters:**
- `jenkinsfile` (string, required): The content of the Jenkinsfile to analyze

**Example:**

```javascript
{
  "jenkinsfile": "pipeline { agent any stages { stage('Build') { steps { sh 'npm install' } } } }"
}
```

## Example Conversion

### Input (Jenkinsfile):

```groovy
pipeline {
  agent any
  
  environment {
    NODE_ENV = 'production'
    VERSION = '1.0.0'
  }
  
  stages {
    stage('Build') {
      steps {
        sh 'npm install'
        sh 'npm run build'
      }
    }
    
    stage('Test') {
      steps {
        sh 'npm test'
      }
    }
    
    stage('Deploy') {
      steps {
        echo 'Deploying application'
        sh 'npm run deploy'
      }
    }
  }
}
```

### Output (GitHub Actions):

```yaml
name: CI
on:
  push:
    branches:
      - main
      - master
  pull_request:
    branches:
      - main
      - master
jobs:
  build:
    runs-on: ubuntu-latest
    env:
      NODE_ENV: production
      VERSION: 1.0.0
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Build
        run: npm install
      - name: Build
        run: npm run build
      - name: Test
        run: npm test
      - name: Deploy
        run: echo "Deploying application"
      - name: Deploy
        run: npm run deploy
```

## Development

### Build

```bash
npm run build
```

### Watch Mode

```bash
npm run watch
```

### Run Tests

```bash
npm test
```

### Test Examples

Try the interactive examples to see the converter in action:

```bash
# Test the converter with the sample Jenkinsfile
node examples/test-converter.js

# Run the interactive MCP tools test suite
node examples/test-mcp-tools.js
```

### Lint

```bash
npm run lint
```

## Supported Jenkins Pipeline Features

- ✅ Declarative pipeline syntax
- ✅ Agent configuration
- ✅ Environment variables
- ✅ Multiple stages
- ✅ Shell commands (`sh`)
- ✅ Echo commands
- ✅ SCM checkout
- ⚠️ Scripted pipelines (limited support)
- ❌ Complex Groovy scripting
- ❌ Jenkins-specific plugins

## Limitations

- This tool focuses on declarative Jenkins pipelines
- Complex Groovy scripting and Jenkins-specific plugins may not be fully supported
- Some Jenkins-specific features may require manual adjustment in the output
- The converter makes best-effort conversions and may include warnings for constructs that don't have direct GitHub Actions equivalents

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

MIT