vercel-mcp

vercel-mcp

site icon
2025.02.28 7
TypeScriptVercel API 管理部署管理DNS 管理域名管理项目管理环境变量管理开发效率
vercel-api-mcp 是一个连接 Vercel API 的 MCP 服务器,提供了一系列工具来管理和操作 Vercel 平台上的资源,包括部署、DNS、域名、项目和环境变量等。
View on GitHub

Overview

基本能力

产品定位

vercel-api-mcp 是一个用于与 Vercel API 交互的 MCP 服务器,旨在简化 Vercel 平台上的资源管理和操作。

核心功能

  • 部署管理:获取部署事件、部署信息、取消部署、列出部署文件、获取部署文件内容、列出部署、删除部署等。
  • DNS 管理:列出、创建、更新和删除 DNS 记录。
  • 域名管理:获取域名配置、单个域名信息、列出所有域名。
  • 项目管理:列出项目、更新项目、管理项目域名(添加、更新、移除、验证)等。
  • 环境变量管理:过滤项目环境变量、获取环境变量值、创建、移除和编辑环境变量。

适用场景

  • 自动化 Vercel 平台的部署流程。
  • 管理和配置 Vercel 项目中的 DNS 和域名。
  • 批量操作 Vercel 项目中的环境变量。

工具列表

  • Deployments
  • getVercelDeploymentEvents:获取部署事件。
  • getVercelDeployment:获取部署信息。
  • cancelVercelDeployment:取消部署。
  • listVercelDeploymentFiles:列出部署文件。
  • getVercelDeploymentFileContents:获取部署文件内容。
  • getVercelDeployments:列出部署。
  • deleteVercelDeployment:删除部署。
  • DNS
  • getVercelDNSRecords:列出 DNS 记录。
  • createVercelDNSRecord:创建 DNS 记录。
  • updateVercelDNSRecord:更新 DNS 记录。
  • deleteVercelDNSRecord:删除 DNS 记录。
  • Domains
  • getVercelDomainConfig:获取域名配置。
  • getVercelDomain:获取单个域名信息。
  • getVercelDomains:列出所有域名。
  • Projects
  • getVercelProjects:列出项目。
  • updateVercelProject:更新项目。
  • getVercelProjectDomains:列出项目域名。
  • getVercelProjectDomain:获取项目域名。
  • updateVercelProjectDomain:更新项目域名。
  • removeVercelProjectDomain:移除项目域名。
  • addVercelProjectDomain:添加项目域名。
  • verifyVercelProjectDomain:验证项目域名。
  • Environment Variables
  • filterVercelProjectEnvs:过滤项目环境变量。
  • getVercelProjectEnv:获取环境变量值。
  • createVercelProjectEnv:创建环境变量。
  • removeVercelProjectEnv:移除环境变量。
  • editVercelProjectEnv:编辑环境变量。

使用教程

使用依赖

  • 需要安装 Node.js 和 npm。
  • 需要 Vercel API 密钥。

安装教程

  1. 在项目中安装: 将以下内容添加到 .cursor/mcp.json 文件中: json { "mcpServers": { "vercel": { "command": "npx", "args": ["vercel-mcp VERCEL_API_KEY=<YOUR_API_KEY>"] } } }
  2. 全局安装: 在 Cursor 设置中添加以下命令: bash npx vercel-mcp VERCEL_API_KEY=<your-vercel-api-key>
  3. Windsurf 安装: 将以下内容添加到 ~/.codeium/windsurf/mcp_config.json 文件中: json { "mcpServers": { "vercel": { "command": "npx", "args": ["vercel-mcp VERCEL_API_KEY=<YOUR_API_KEY>"] } } }

调试方式

安装完成后,可以通过运行提供的工具命令来测试功能是否正常。例如:

npx vercel-mcp VERCEL_API_KEY=<your-vercel-api-key> getVercelProjects

确保能够正确列出 Vercel 项目。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。