MCP Vercel Github Integration

🚀 GitHub-Vercel MCP Server

An automated MCP service for automatic GitHub repository creation and Vercel template deployment.

🚀 Quick Start

This service offers automated GitHub repository creation and Vercel template deployment. It comes with several features to simplify the process and ensure security.

✨ Features

• 🚀 Automatic Detection: Automatically identifies the GitHub namespace from the token.
• 🤖 Team Awareness: Supports Vercel operations at the team level.
• ⚡ Zero Configuration: No additional configuration is required for most use cases.
• 🔒 Security: Handles credential information properly.

📦 Installation

Local Installation

npm install -g @yourpackage/mcp-server-github

📚 Documentation

MCP Configuration

Add the following to your mcp.config.json:

{
  "mcpServers": {
        "vercel-github": {
          "command": "npx",
          "args": [
            "mcp-vercel-github-integration",
            "-v",
            "<Your Vercel API Key>",
            "-g",
            "<Your Git API Key>"
          ]
    }
  }
}

Required Permissions

GitHub Token

repo:       # Global repository control permissions
user:       # Read user configuration profile
read:org    # If using the organization feature

Vercel Token

• projects:read and projects:write
• teams:read (if using teams)

💻 Usage Examples

Basic Deployment

mcp execute github --REPO_NAME "my-app" --TEMPLATE_SOURCE "https://github.com/vercel/vercel/tree/main/examples/nextjs"

All Parameters

API Response

On successful execution, it returns:

{
  "status": "success",
  "data": {
    "githubRepo": "https://github.com/yourname/repo",
    "vercelProject": "https://repo.vercel.app",
    "projectId": "prj_abc123"
  }
}

Error Handling

Common error responses include:

{
  "status": "error",
  "error": {
    "code": "GITHUB_AUTH_FAILED",
    "message": "Invalid GitHub token"
  }
}

Development

1. Clone the repository.
2. Install dependencies:

   npm install
   

3. Configure the environment:

   cp .env.example .env
   

4. Run tests:

   npm test
   

Publishing

Package and publish the package to npm:

npm publish --access public

📄 License

MIT