Vercel MCP 集成

Vercel 的 REST API 的 Model Context Protocol (MCP) 集成，通过像 Claude 和 Cursor 这样的AI助手提供对 Vercel 部署管理的程序化访问。

📋 概述 _{^{最后更新：2025年5月}}

此 MCP 服务器实现了 Vercel 的核心 API 端点作为工具，支持以下功能：

• 部署监控与管理
• 环境变量检索
• 项目部署状态跟踪
• 团队创建与管理
• CI/CD 管道集成

✨ 功能

当前工具

部署管理

• vercel-list-all-deployments - 列出部署并进行过滤
• vercel-get-deployment - 获取特定部署的详细信息
• vercel-list-deployment-files - 列出部署中的文件
• vercel-create-deployment - 创建新的部署

项目管理

• vercel-create-project - 创建新的 Vercel 项目
• vercel-list-projects - 列出所有项目并分页
• vercel-find-project - 根据ID或名称查找特定项目
• vercel-create-environment-variables - 创建多个环境变量
• vercel-get-project-domain - 获取项目中特定域的信息

环境管理

• vercel-get-environments - 访问项目环境变量
• vercel-create-custom-environment - 为项目创建自定义环境

团队管理

• vercel-list-all-teams - 列出所有可访问团队
• [vercel-create-team](docs/teams.md#ver- cel-create-team) - 创建具有自定义slug和名称的新团队

🛣️ 发展路线图

• 部署创建工作流
• 项目管理工具
• 团队管理集成（列出和创建团队）
• 高级错误处理

📚 工具文档

有关每个工具的详细信息，请参阅以下文档：

• 部署工具 - 用于管理部署的工具
• 项目工具 - 用于项目和环境变量管理的工具
• 环境工具 - 用于环境配置的工具
• 团队工具 - 用于团队管理的工具

🚀 快速开始

先决条件

• Node.js 18+
• Vercel API Token
• MCP 客户端（Claude、Cursor 或其他支持 MCP 的AI助手）

安装

git clone [your-repo-url]
cd vercel-mcp
npm install

配置

1. 创建 .env 文件：

VERCEL_API_TOKEN=your_api_token_here

2. 启动 MCP 服务器：

npm start

🔗 与AI助手集成

与 Claude 集成

Claude 通过其 Anthropic Console 或 Claude Code 接口支持 MCP 工具。

1. 使用 npm start 在本地启动 MCP 服务器
2. 在 Claude Code 中，使用 /connect 命令：

   /connect mcp --path [path-to-server]
   

   对于基于 CLI 的使用 stdio 的服务器，指定服务器可执行文件的路径
3. Claude 将自动发现可用的 Vercel 工具
4. 然后你可以让 Claude 执行 Vercel 操作，例如：

   请使用 vercel-list-all-deployments 工具列出我最近的 Vercel 部署
   

5. 或者，你可以使用类似 mcp-proxy 的工具将 MCP 服务器暴露为 HTTP 服务器

   npm install -g @modelcontextprotocol/proxy
   mcp-proxy --stdio --cmd "npm start" --port 3399
   

   然后在 Claude 中连接：/connect mcp --url http://localhost:3399

与 Cursor 集成

Cursor 通过其扩展系统内置支持 MCP 工具。

1. 使用 npm start 启动 MCP 服务器
2. 在 Cursor 中，访问设置 → 工具
3. 在“模型上下文协议（MCP）”下，点击“+ 添加 MCP 工具”
4. 配置新连接：
   • 对于 stdio 传输：指向可执行文件路径
   • 对于 HTTP 传输：指定 URL（例如，http://localhost:3399）
5. Cursor 将自动发现可用的 Vercel 工具
6. 使用 Cursor 的 AI 功能与你的 Vercel 部署互动，在提示中提及工具

程序化集成

你也可以使用 Model Context Protocol SDK 在自己的应用程序中与服务器进行程序化集成：

import { Client } from "@modelcontextprotocol/sdk/client";

// 创建一个连接到 stdio 传输的 MCP 客户端
const client = new Client({
  transport: "stdio",
  cmd: "npm --prefix /path/to/vercel-mcp start",
});

// 或连接到 HTTP 传输
const httpClient = new Client({
  transport: "http",
  url: "http://localhost:3399",
});

// 连接到服务器
await client.connect();

// 列出可用工具
const { tools } = await client.listTools();
console.log(
  "可用工具：",
  tools.map((t) => t.name)
);

// 调用工具
const result = await client.callTool({
  name: "vercel-list-all-deployments",
  args: { limit: 5 },
});

console.log("部署：", result);

// 你也可以在 Express 服务器中使用这个：
app.post("/api/deployments", async (req, res) => {
  try {
    const result = await client.callTool({
      name: "vercel-list-all-deployments",
      args: req.body,
    });
    res.json(result);
  } catch (error) {
    res.status(500).json({ error: error.message });
  }
});

🛠️ 工具使用示例

这里有一些快速示例来帮助你入门。对于更详细的文档和更多示例，请参阅 工具文档。

列出最近的部署

const response = await mcpClient.callTool({
  name: "vercel-list-all-deployments",
  args: {
    limit: 5,
    target: "production",
  },
});

创建一个新的项目

const project = await mcpClient.callTool({
  name: "vercel-create-project",
  args: {
    name: "my-awesome-project",
    framework: "nextjs",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
  },
});

从Git部署

const deployment = await mcpClient.callTool({
  name: "vercel-create-deployment",
  args: {
    project: "my-project-id",
    gitSource: {
      type: "github",
      ref: "main",
    },
  },
});

对于包括文件部署、环境管理和团队操作在内的更详细示例，请参阅文档：

• 部署示例
• 项目示例
• 环境示例
• 团队示例

🐳 Docker 部署

构建镜像

docker build -t vercel-mcp .

运行容器

docker run -it --rm \
  -e VERCEL_API_TOKEN=your_token_here \
  -p 3399:3399 \
  vercel-mcp

生产部署

docker run -d \
  --name vercel-mcp \
  --restart unless-stopped \
  -e VERCEL_API_TOKEN=your_token_here \
  -p 3399:3399 \
  vercel-mcp

开发时实时重载

docker build --target builder -t vercel-mcp-dev .
docker run -it --rm \
  -e VERCEL_API_TOKEN=your_token_here \
  -p 3399:3399 \
  -v $(pwd)/src:/app/src \
  vercel-mcp-dev

🗂️ 项目结构

src/
├── constants/       # 工具定义
├── tools/
│   ├── deployments/ # 部署处理器
│   │   ├── handlers.ts
│   │   ├── schema.ts
│   │   └── types.ts
│   └── environments/# 环境管理
├── utils/          # API 辅助工具
└── index.ts         # 服务器入口点

🔧 配置

环境变量

变量	描述	必需
VERCEL_API_TOKEN	Vercel 访问令牌	是

🤝 贡献

1. 分叉仓库
2. 创建功能分支 (git checkout -b feature/amazing-feature)
3. 提交更改 (git commit -m '添加神奇功能')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 打开拉取请求

📄 许可证

MIT 许可证 - 详情见 LICENSE