deploy-mcp

Demo

Quick Start

─────────────────────────

Get started in under 30 seconds:

npx deploy-mcp

That's it! The server is now running and ready to be configured in your AI assistant.

Supported Platforms

─────────────────────────

deploy-mcp supports multiple deployment platforms simultaneously. Configure as many as you need:

Multi-Platform Configuration

You can use multiple platforms simultaneously by providing tokens for each platform you want to track:

{
  "mcpServers": {
    "deploy-mcp": {
      "command": "npx",
      "args": ["-y", "deploy-mcp"],
      "env": {
        "VERCEL_TOKEN": "your-vercel-token",
        "NETLIFY_TOKEN": "your-netlify-token",
        "CLOUDFLARE_TOKEN": "accountId:globalApiKey"
        // Add more platform tokens as needed
      }
    }
  }
}

Platform Configuration

─────────────────────────

Vercel

Setup Instructions

1. Get your API token:

2. Add to your AI assistant configuration:

{
     "env": {
       "VERCEL_TOKEN": "your-vercel-token"
     }
   }

3. Available commands:

4. Required permissions: Read access to deployments and projects

Netlify

Setup Instructions

1. Get your API token:

2. Add to your AI assistant configuration:

{
     "env": {
       "NETLIFY_TOKEN": "your-netlify-token"
     }
   }

3. Available commands:

4. Required permissions: Read access to sites and deploys

Cloudflare Pages

Setup Instructions

1. Get your API token:

2. Add to your AI assistant configuration:

{
     "env": {
       "CLOUDFLARE_TOKEN": "your-cloudflare-token-or-accountId:globalApiKey"
     }
   }

3. Available commands:

4. Token formats supported:

5. Required permissions: Account access to Cloudflare Pages

AI Assistant Configuration

─────────────────────────

deploy-mcp works with any MCP-compatible AI assistant. Here's how to set it up:

Claude Desktop

Configuration

File location:

• macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
• Windows: `%APPDATA%\Claude\claude_desktop_config.json`
• Linux: `~/.config/Claude/claude_desktop_config.json`

Configuration:

{
  "mcpServers": {
    "deploy-mcp": {
      "command": "npx",
      "args": ["-y", "deploy-mcp"],
      "env": {
        "VERCEL_TOKEN": "your-vercel-token",
        "NETLIFY_TOKEN": "your-netlify-token"
      }
    }
  }
}

VS Code

Configuration

File location:

• Workspace: `.vscode/mcp.json`
• Global: `~/.vscode/mcp.json`

Requirements: GitHub Copilot subscription with MCP enabled

Configuration: Same as Claude Desktop

Cursor AI

Configuration

File location: `~/.cursor/mcp.json`

Setup: Navigate to Cursor Settings → MCP

Configuration: Same as Claude Desktop

Windsurf IDE

Configuration

File location: `~/.codeium/windsurf/mcp_config.json`

Setup: Settings → Advanced Settings → Cascade

Configuration: Same as Claude Desktop

Continue.dev

Configuration

File location: `~/.continue/config.json`

Configuration (different structure):

{
  "experimental": {
    "modelContextProtocolServer": {
      "transport": {
        "type": "stdio",
        "command": "npx",
        "args": ["-y", "deploy-mcp"]
      },
      "env": {
        "VERCEL_TOKEN": "your-vercel-token",
        "NETLIFY_TOKEN": "your-netlify-token"
      }
    }
  }
}

Cline (VS Code Extension)

Configuration

Natural language setup:

• Ask: *"Add the deploy-mcp tool to check deployments"*

Manual setup:

• MCP Servers icon → Advanced MCP Settings

Configuration: Same as Claude Desktop

Deployment Status Badges

─────────────────────────

Get live deployment status badges for your repositories:

Badge Format

The deploy-mcp.io endpoint returns JSON data for shields.io. Use the shields.io endpoint wrapper:

![Platform Deployment](https://img.shields.io/endpoint?url=https://deploy-mcp.io/badge/{username}/{repository}/{platform})

Examples by Platform

Vercel Badge

![Vercel](https://img.shields.io/endpoint?url=https://deploy-mcp.io/badge/john/my-app/vercel)

Netlify Badge

![Netlify](https://img.shields.io/endpoint?url=https://deploy-mcp.io/badge/john/my-app/netlify)

Multiple Badges

![Vercel](https://img.shields.io/endpoint?url=https://deploy-mcp.io/badge/john/my-app/vercel)
![Netlify](https://img.shields.io/endpoint?url=https://deploy-mcp.io/badge/john/my-app/netlify)

Webhook Configuration

For real-time badge updates, configure webhooks:

Vercel Webhooks (Pro/Enterprise only)

1. Go to your Vercel team settings

2. Navigate to "Webhooks" section

3. Click "Create Webhook"

4. Configure:

Netlify Webhooks

1. Go to Site Settings → Build & deploy → Deploy notifications

2. Add notification → Outgoing webhook

3. Configure:

Note: Badges require public repositories. Private repo support coming soon.

Available Tools

─────────────────────────

deploy-mcp provides these tools to your AI assistant:

Core Tools

Platform-Specific Usage

Commands work across all configured platforms:

"Check my Vercel deployment for my-app"
"Show last 10 deployments for my-app on Vercel"
"List all my Vercel projects"
"Check my Netlify deployment for my-site"
"Show me logs for deployment abc123 on Vercel"
"Watch my Netlify deployment progress"
"Show all my Netlify sites"

New Features

List Projects

Discover all your projects/sites across platforms:

"List my Vercel projects"
"Show all Netlify sites"
"What projects do I have on Vercel?"

Deployment History

View multiple recent deployments at once:

"Show last 5 deployments for my-app"
"Get deployment history for my-site"
"Check last 10 deployments on Vercel"

The AI will automatically use the correct platform based on:

1. Explicit platform mention in your command

2. Project/site name matching

3. Available tokens in configuration

Security

─────────────────────────

• Local tokens only - Your API tokens stay on your machine
• No telemetry - We don't track usage or collect data
• Open source - Fully auditable codebase
• Minimal permissions - Only read access required

Advanced Configuration

─────────────────────────

Environment Variables

You can also set tokens via environment variables:

export VERCEL_TOKEN="your-vercel-token"
export NETLIFY_TOKEN="your-netlify-token"
npx deploy-mcp

Custom Installation

For production use, install globally:

npm install -g deploy-mcp
deploy-mcp

Contributing

─────────────────────────

We welcome contributions! See CONTRIBUTING.md for guidelines.

Adding New Platforms

1. Implement the `BaseAdapter` interface

2. Add platform-specific API client

3. Update configuration documentation

4. Add tests

License

─────────────────────────

Apache 2.0 - See LICENSE for details.

Links

─────────────────────────

• Website
• npm Package
• GitHub Repository
• Report Issues