使用说明

Vercel MCP集成

Vercel的REST API的模型上下文协议（MCP）集成，通过Claude和Cursor等人工智能助手提供对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和名称创建新团队

🛣️ 路线图

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

📚 工具文档

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

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

🚀 入门指南

先决条件

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

安装

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

配置

创建 .env 文件：

VERCEL_API_TOKEN=your_api_token_here

启动MCP服务器：

npm start

🔗 与AI助手集成

与克劳德融合

Claude通过其Anthropic控制台或Claude Code界面支持MCP工具。

使用以下命令在本地启动MCP服务器 npm start
在Claude Code中，使用 /connect 命令：
```
/connect mcp --path [path-to-server]
```
对于使用stdio的基于CLI的服务器，指定服务器可执行文件的路径
Claude将自动发现可用的Vercel工具

然后，您可以要求Claude执行Vercel操作，例如：

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

或者，您可以使用以下工具将MCP服务器公开为HTTP服务器 mcp-proxy
```
npm install -g @modelcontextprotocol/proxy
mcp-proxy --stdio --cmd "npm start" --port 3399
```
然后用Claude连接： /connect mcp --url http://localhost:3399

与Cursor集成

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

使用以下命令启动MCP服务器 npm start
在光标中，访问设置→ Tools
在“模型上下文协议（MCP）”下，单击“+添加MCP工具”
配置新连接：
- 对于stdio传输：指向可执行路径
- 对于HTTP传输：指定URL（例如。，http://localhost:3399)
Cursor将自动发现可用的Vercel工具
通过在提示中提及工具，使用Cursor的AI功能与您的Vercel部署进行交互

程序集成

您还可以使用模型上下文协议SDK在您自己的应用程序中以编程方式与服务器集成：

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

使用Live Reload进行开发

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访问令牌	是

🤝 贡献

分叉存储库
创建特征分支(git checkout -b feature/amazing-feature)
提交更改(git commit -m 'Add amazing feature')
推送到分支(git push origin feature/amazing-feature)
打开拉取请求

📄 许可证

MIT许可证-请参阅许可证详见