使用说明

项目简介

'@vercel/sdk' 不仅是一个 type-safe 的 Typescript SDK，用于通过 Vercel REST API 完全控制 Vercel 平台，它还可以作为一个 MCP (Model Context Protocol) 服务器 运行。这意味着你可以将 Vercel 平台的各项功能，如部署管理、域名配置、项目设置等，以 工具 (Tools) 的形式暴露给支持 MCP 协议的 LLM (Large Language Model) 客户端，例如 Claude 和 Cursor。

主要功能点

Vercel API 工具化: 将 Vercel 平台的 REST API 封装成一系列可被 LLM 客户端调用的工具 (Tools)。
上下文信息访问: 允许 LLM 客户端通过工具获取 Vercel 平台的上下文信息，例如项目部署状态、域名配置等。
自动化操作: LLM 客户端可以调用工具来自动化执行 Vercel 平台上的操作，例如创建部署、更新项目配置等。
易于集成: 提供了详细的 Claude 和 Cursor MCP 服务器配置步骤，方便快速集成。

注意： 运行 MCP 服务器需要 Node.js v20 或更高版本。

安装步骤

安装 '@vercel/sdk' 包: 使用 npm, pnpm, bun 或 yarn 等包管理器安装 '@vercel/sdk'。

以 npm 为例，在你的项目目录下运行：
```
npm add @vercel/sdk
```

服务器配置

为了让 MCP 客户端（如 Claude 或 Cursor）连接到 '@vercel/sdk' MCP 服务器，你需要配置客户端的 MCP 服务器设置。以下是针对 Claude 和 Cursor 的配置示例：

Claude 配置 (编辑 'claude_desktop_config.json')

{
  "mcpServers": {
    "Vercel": {
      "command": "npx",  // 启动命令，通常使用 npx 来执行本地安装的 npm 包
      "args": [
        "-y", "--package", "@vercel/sdk", // 确保 @vercel/sdk 包被安装和使用
        "--",                             // 分隔 npx 参数和 @vercel/sdk 包的参数
        "mcp", "start",                     // 启动 MCP 服务器的命令
        "--bearer-token", "YOUR_VERCEL_ACCESS_TOKEN" //  Vercel 访问令牌，用于 API 鉴权，请替换为你的实际 Token
      ]
    }
  }
}

Cursor 配置 (Cursor 设置 > Features > MCP Servers > Add new MCP server)

Name: 'Vercel' （服务器名称，可以自定义）
Type: 'command' （服务器类型为命令）

Command:

npx -y --package @vercel/sdk -- mcp start --bearer-token YOUR_VERCEL_ACCESS_TOKEN

(请将 'YOUR_VERCEL_ACCESS_TOKEN' 替换为你的实际 Vercel 访问令牌)

参数说明:

'command': 指定启动 MCP 服务器的命令，这里使用 'npx' 来执行本地 npm 包。
'args': 命令参数列表，包括：
- '-y', '--package', "@vercel/sdk": 'npx' 的参数，确保安装并使用 '@vercel/sdk' 包。
- '--': 分隔符，用于区分 'npx' 的参数和 '@vercel/sdk' 包的参数。
- 'mcp', 'start': '@vercel/sdk' 提供的 MCP 服务器启动命令。
- '--bearer-token', 'YOUR_VERCEL_ACCESS_TOKEN': 'mcp start' 命令的参数，用于设置 Vercel API 的访问令牌。务必替换为你的实际 Vercel 访问令牌。你可以在 Vercel 仪表盘中创建访问令牌。

你可以通过运行以下命令查看更多服务器启动参数：

npx -y --package @vercel/sdk -- mcp start --help

基本使用方法

配置完成后，在支持 MCP 协议的 LLM 客户端中，你就可以选择 "Vercel" MCP 服务器。LLM 客户端将能够发现并调用 '@vercel/sdk' 提供的 Vercel 平台工具，从而实现与 Vercel 平台的集成和自动化交互。

具体可用的工具列表，请参考仓库 README.md 中的 "Available Resources and Operations" 和 "Standalone functions" 部分。

例如，你可以指示 LLM 客户端使用 "deployments_get-deployments" 工具来获取项目部署列表，或者使用 "projects_update-project" 工具来更新项目名称等。

关键词