使用说明

项目简介

'vercel-mcp' 是一个基于 Model Context Protocol (MCP) 构建的服务器,它充当 LLM 客户端和 Vercel API 之间的桥梁。通过该服务器,LLM 客户端可以调用预定义的工具来管理 Vercel 上的资源,例如部署、域名、项目和环境变量等。

主要功能点

  • 提供多种工具,用于管理 Vercel 的部署 (Deployments)、域名 (Domains)、DNS 记录、项目 (Projects) 和环境变量 (Environment Variables)。
  • 通过 MCP 协议与 LLM 客户端通信,以标准化的方式提供 Vercel API 的功能。
  • 使用 Stdio 作为传输协议,易于集成到各种 LLM 客户端中。

安装步骤

  1. 确保已安装 Node.js 和 npm。
  2. 全局安装 'vercel-mcp' 或在项目本地安装(推荐本地安装)。
    • 全局安装命令: 'npm install -g vercel-api-mcp'
    • 本地安装命令: 'npm install vercel-api-mcp'

服务器配置

为了让 MCP 客户端(例如 Cursor 或 Windsurf)连接到 'vercel-mcp' 服务器,您需要在客户端的 MCP 服务器配置文件中添加以下配置信息。请注意将 '<YOUR_API_KEY>' 替换为您的 Vercel API 密钥。

{
    "server name": "vercel",  //  服务器名称,可以自定义
    "command": "npx",         //  启动服务器的命令,这里使用 npx 运行本地安装的 vercel-mcp
    "args": ["vercel-mcp VERCEL_API_KEY=<YOUR_API_KEY>"] //  启动参数,指定 Vercel API 密钥
}

基本使用方法

  1. 启动 'vercel-mcp' 服务器(通常由 MCP 客户端自动启动)。
  2. 在 LLM 客户端中,可以使用预定义的工具名称(例如 'getVercelDeployments', 'createVercelDNSRecord' 等)来调用 Vercel API 的功能。
  3. LLM 客户端会通过 MCP 协议向 'vercel-mcp' 服务器发送请求,服务器执行相应的 Vercel API 调用,并将结果返回给客户端。
  4. 具体工具的参数和使用方式请参考仓库 README.md 文件中 "Tools" 部分的描述。

信息

分类

开发者工具