JinDaGe - mcp-vercel-github-integration MCP Details

article

README

🚀 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"

高级用法

所有参数

| 参数 | 默认值 | 描述 | |-----------|---------|-------------| | VERCEL_API_KEY | - |（必需）Vercel API 密钥 | | GITHUB_TOKEN | - |（必需）GitHub 个人访问令牌 | | REPO_NAME | "new-repo" | 仓库名称 | | TEMPLATE_SOURCE | Vercel Next.js | 模板 Git URL 地址 | | IS_PRIVATE | true | 是否将仓库设为私有 |

📚 详细文档

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 令牌"
  }
}

🔧 技术细节

开发

克隆仓库。
安装依赖项：
```
npm install
```
配置环境：
```
cp .env.example .env
```
执行测试：
```
npm test
```

发布

将包打包并发布到 npm，使用以下命令：

npm publish --access public

📄 许可证

本项目采用 MIT 许可证。

mcp-vercel-github-integration