Vercel MCP 服务器使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 实现的服务器,旨在为大型语言模型 (LLM) 客户端提供与 Vercel 云平台交互的能力。通过此服务器,LLM 可以调用工具来管理 Vercel 上的部署、项目、域名以及环境变量等资源,从而实现云服务的自动化管理和集成。

主要功能点

  • 部署管理: 列出 Vercel 部署信息。
  • 项目管理:
    • 创建、删除和列出 Vercel 项目。
    • 获取项目详情。
  • 域名管理:
    • 为 Vercel 项目添加和删除域名。
  • 环境变量管理:
    • 设置、获取和删除 Vercel 项目的环境变量。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/fer1994ly/Vercel_MCP_Complete.git
    cd Vercel_MCP_Complete
  2. 安装依赖: 确保你已经安装了 Node.js 和 npm。运行以下命令安装项目依赖:
    npm install
  3. 构建项目:
    npm run build

服务器配置

MCP 客户端需要配置以下信息以连接到 Vercel MCP 服务器。配置信息为 JSON 格式,通常在 MCP 客户端的服务器配置中设置。

{
  "serverName": "vercel",  // 服务器名称,客户端用于识别和调用
  "command": "node",       // 启动服务器的命令,这里使用 node.js 运行时
  "args": [                 // 启动命令的参数
    "dist/index.js"      // 服务器入口文件路径,构建后文件位于 dist 目录
  ]
}

重要参数说明:

  • 'serverName': 自定义服务器名称,例如 "vercel",在客户端调用工具时会用到。
  • 'command': 运行服务器端代码的命令,通常为 'node'。
  • 'args': 传递给 'command' 的参数数组,指定服务器入口文件 'dist/index.js'。

环境变量配置: Vercel MCP 服务器需要 Vercel API Token 才能进行身份验证和操作。你需要在运行服务器的环境中设置 'VERCEL_API_TOKEN' 环境变量。

export VERCEL_API_TOKEN=<你的 Vercel API Token>

或者,你也可以在运行服务器的命令前直接设置环境变量:

VERCEL_API_TOKEN=<你的 Vercel API Token> node dist/index.js

请替换 '<你的 Vercel API Token>' 为你实际的 Vercel API Token。

基本使用方法

  1. 启动服务器: 在项目根目录下,运行以下命令启动 Vercel MCP 服务器:

    npm run start

    或者直接运行构建后的文件(确保已设置 'VERCEL_API_TOKEN' 环境变量):

    VERCEL_API_TOKEN=<你的 Vercel API Token> node dist/index.js

    服务器成功启动后,会在控制台输出 'Vercel MCP Server running on stdio'。

  2. 配置 MCP 客户端: 在你的 MCP 客户端中,添加上面提供的服务器配置信息。

  3. 通过 MCP 客户端调用工具: 使用 MCP 客户端,你可以发送 'ListToolsRequest' 请求获取 Vercel MCP 服务器提供的工具列表。然后,你可以使用 'CallToolRequest' 请求调用具体的 Vercel 工具,例如 'vercel-list-projects'、'vercel-deploy-project' 等,并传递相应的参数。

    具体的工具名称和参数定义,请参考 'src/index.ts' 文件中 'VERCEL_TOOLS' 数组的定义,以及每个工具的 'inputSchema' 属性。MCP 客户端会根据这些信息生成用户界面或指令,供用户操作和调用。

注意:

  • 确保你的 Vercel API Token 具有足够的权限来执行你想要调用的 Vercel 工具操作。
  • 本服务器通过标准输入/输出 (stdio) 与 MCP 客户端通信。你需要使用支持 stdio 传输协议的 MCP 客户端。

信息

分类

开发者工具