MCP Vercel Github Integration

🚀 GitHub-Vercel MCP 服務器

GitHub-Vercel MCP 服務器是一款自動化 MCP 服務，可實現 GitHub 倉庫的自動創建以及 Vercel 模板的自動部署，極大提升開發效率。

🚀 快速開始

本服務能自動完成 GitHub 倉庫創建與 Vercel 模板部署，你只需按以下步驟操作，即可輕鬆使用。

✨ 主要特性

• 🚀 自動檢測：從令牌中自動識別 GitHub 命名空間。
• 🤖 團隊感知：支持團隊層面的 Vercel 操作。
• ⚡ 零配置：大多數用例下無需額外配置。
• 🔒 安全：妥善處理憑證信息。

📦 安裝指南

本地安裝

在本地環境中，你可以使用以下命令進行安裝：

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

MCP 配置

在你的 mcp.config.json 中添加如下配置：

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

必要權限

GitHub Token

repo:       # 全局倉庫控制權限
user:       # 讀取用戶配置資料
read:org    # 如果使用組織功能

Vercel Token

• projects:read 和 projects:write
• teams:read（如果使用團隊）

💻 使用示例

基礎用法

以下是基本部署的命令示例：

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

高級用法

所有參數

📚 詳細文檔

API 響應

成功執行時，服務將返回如下信息：

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

錯誤處理

常見錯誤響應示例如下：

{
  "status": "error",
  "error": {
    "code": "GITHUB_AUTH_FAILED",
    "message": "無效的 GitHub 令牌"
  }
}

🔧 技術細節

開發

1. 克隆倉庫。
2. 安裝依賴項：

   npm install
   

3. 配置環境：

   cp .env.example .env
   

4. 執行測試：

   npm test
   

發佈

將包打包併發布到 npm，使用以下命令：

npm publish --access public

📄 許可證

本項目採用 MIT 許可證。