使用说明

项目简介

vercel-mcp 是一个基于 Model Context Protocol (MCP) 构建的服务器，它作为一个桥梁，连接大型语言模型 (LLM) 应用和 Vercel 平台。通过此 MCP 服务器，LLM 应用可以调用预定义的工具，查询和获取 Vercel 项目的部署信息。这使得开发者可以构建更智能的应用，例如，LLM 可以根据最新的部署状态提供更准确的建议或执行相应的操作。

主要功能点

列出 Vercel 部署信息: 提供 'vercel-list-all-deployments' 工具，允许 LLM 应用查询指定 Vercel 项目或用户的部署列表。
灵活的查询参数: 支持通过应用名称 (app)、项目 ID (projectId)、部署状态 (state)、目标环境 (target) 等多种参数过滤部署信息，满足不同的查询需求。
标准 MCP 协议: 遵循 MCP 协议标准，易于与任何兼容 MCP 协议的 LLM 客户端集成。
基于 Stdio 传输: 使用 Stdio 作为默认传输协议，简化部署和运行方式。

安装步骤

克隆仓库:

git clone https://github.com/nganiet/mcp-vercel.git
cd mcp-vercel

安装依赖: 确保已安装 Node.js 和 npm。在项目根目录下运行：
```
npm install
```
设置 Vercel API Token 环境变量: vercel-mcp 服务器需要 Vercel API Token 才能访问 Vercel API。请在运行服务器的环境中设置 'VERCEL_API_TOKEN' 环境变量，例如：
```
export VERCEL_API_TOKEN="YOUR_VERCEL_API_TOKEN"
```
或者，如果您使用的是 '.env' 文件，可以创建一个 '.env' 文件并将以下内容添加到文件中：
```
VERCEL_API_TOKEN=YOUR_VERCEL_API_TOKEN
```
请将 'YOUR_VERCEL_API_TOKEN' 替换为您的 Vercel API Token。 您可以在 Vercel 控制台的 "Settings" -> "Tokens" 中创建 API Token。

服务器配置

以下 JSON 配置信息用于 MCP 客户端连接 vercel-mcp 服务器。

{
  "serverName": "vercel",  // MCP 服务器名称，与服务器声明的名称一致
  "command": "node",      // 启动服务器的命令，这里使用 node.js 运行时
  "args": ["src/index.js"] // 启动命令的参数，指向服务器入口文件
}

配置参数说明:

'serverName': 定义了此 MCP 服务器的名称，客户端通过此名称识别和调用服务器。
'command': 指定运行 MCP 服务器的命令。对于 Node.js 服务器，通常设置为 'node'。
'args': 一个字符串数组，包含了传递给 'command' 的参数。这里指向了 'src/index.js' 文件，即 vercel-mcp 服务器的入口文件。

MCP 客户端需要配置以上 JSON 信息，才能正确连接和使用 vercel-mcp 服务器。

基本使用方法

启动 vercel-mcp 服务器: 在项目根目录下，运行以下命令启动服务器：
```
npm start
```
或者直接运行入口文件:
```
node src/index.js
```
启动成功后，您应该会在控制台看到 'Vercel MCP Server running on stdio' 的提示信息。
配置并启动 MCP 客户端: 根据 MCP 客户端的文档，配置服务器连接信息。将上面提供的服务器配置 JSON 添加到您的 MCP 客户端配置中。
在 MCP 客户端中调用工具: 一旦客户端成功连接到 vercel-mcp 服务器，您就可以在客户端中调用 'vercel-list-all-deployments' 工具来查询 Vercel 部署信息。

例如，在支持自然语言调用的 LLM 客户端中，您可以指示 LLM "列出我最近的 Vercel 部署" 或 "查询应用名为 'my-app' 的 Vercel 部署状态"。 LLM 客户端会将这些自然语言指令转换为对 'vercel-list-all-deployments' 工具的调用，并将参数传递给服务器。

服务器会调用 Vercel API 获取部署信息，并将结果返回给 MCP 客户端，最终呈现给用户或供 LLM 应用进一步处理。

注意: vercel-mcp 服务器目前只提供 'vercel-list-all-deployments' 这一个工具。未来可能会扩展更多与 Vercel 平台交互的功能。

关键词