Vercel MCP Integration

Vercel MCP 集成

用于 Vercel REST API 的模型上下文协议（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 - 使用自定义 slug 和名称创建新团队

🛣️ 路线图

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

📚 工具文档

如需了解每个工具的详细信息，请参阅以下文档：

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

🚀 入门

前提条件

• Node.js 18+
• Vercel API 令牌
• 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]
   

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

   Please list my recent Vercel deployments using the vercel-list-all-deployments tool
   

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 中，打开 Settings → Tools
3. 在“Model Context Protocol (MCP)”下，点击“+ Add MCP tool”
4. 配置新连接：
   • 对于 stdio 传输：指定可执行文件路径
   • 对于 HTTP 传输：指定 URL（例如，http://localhost:3399）
5. Cursor 将自动发现可用的 Vercel 工具
6. 在提示词中提及这些工具，即可使用 Cursor 的 AI 功能与 Vercel 部署交互

编程集成

你也可以在自己的应用程序中使用 Model Context Protocol SDK，以编程方式与 MCP 服务集成：

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

// Create an MCP client connected to a stdio transport
const client = new Client({
  transport: "stdio",
  cmd: "npm --prefix /path/to/vercel-mcp start",
});

// Or connect to an HTTP transport
const httpClient = new Client({
  transport: "http",
  url: "http://localhost:3399",
});

// Connect to the server
await client.connect();

// List available tools
const { tools } = await client.listTools();
console.log(
  "Available tools:",
  tools.map((t) => t.name)
);

// Call a tool
const result = await client.callTool({
  name: "vercel-list-all-deployments",
  args: { limit: 5 },
});

console.log("Deployments:", result);

// You can also use this in an Express server:
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/       # Tool definitions
├── tools/
│   ├── deployments/ # Deployment handlers
│   │   ├── handlers.ts
│   │   ├── schema.ts
│   │   └── types.ts
│   └── environments/# Environment management
├── utils/          # API helpers
└── index.ts         # Server entrypoint

🔧 配置

环境变量

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

🤝 贡献

1. Fork 此仓库
2. 创建功能分支（git checkout -b feature/amazing-feature）
3. 提交更改（git commit -m 'Add amazing feature'）
4. 推送到分支（git push origin feature/amazing-feature）
5. 创建 Pull Request

📄 许可证

MIT 许可证 - 详情请参阅 LICENSE