Surge MCP Server 使用说明

项目简介

Surge MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为 AI 模型提供与 Surge.sh 交互的能力。通过此服务器，AI 模型可以调用工具来登录 Surge.sh 账户并将本地项目部署到 Surge.sh 平台，方便快捷地发布静态网站。

主要功能点

Surge.sh 账户登录: 允许 AI 模型通过 'surge_login' 工具安全地登录到 Surge.sh 账户。
项目部署: 支持 AI 模型使用 'surge_deploy' 工具将指定目录下的项目部署到 Surge.sh，并自动生成随机域名。

安装步骤

确保 Node.js 环境: 请确保您的系统已安装 Node.js 和 npm (或 npx)。
安装 Surge MCP Server: 打开终端，运行以下命令即可安装 Surge MCP Server：
```
npx -y https://github.com/xhyqaq/surge-mcp-server
```
这个命令会使用 'npx' 临时下载并执行仓库中的服务器代码。

服务器配置

MCP 服务器需要 MCP 客户端才能连接和使用。您需要在 MCP 客户端中配置以下信息以启动 Surge MCP Server 并建立连接。

{
  "serverName": "surge-server",
  "command": "npx",
  "args": ["-y", "https://github.com/xhyqaq/surge-mcp-server"]
}

配置参数说明：

'serverName': 服务器名称，这里设置为 "surge-server"，用于在 MCP 客户端中标识该服务器。
'command': 启动服务器的命令，这里使用 'npx'，它可以方便地运行 GitHub 仓库中的代码。
'args': 命令参数，这里指定了 '-y' 参数 (用于跳过 npx 的安装确认) 和 GitHub 仓库的 URL 'https://github.com/xhyqaq/surge-mcp-server'，'npx' 会自动从该 URL 下载并执行服务器代码。

请注意：这种配置方式每次启动 MCP 客户端都会重新下载服务器代码。如果需要更持久的安装方式，可以考虑将仓库克隆到本地，然后使用 'node <server_entrypoint.js>' 的方式启动。

基本使用方法

启动 MCP 服务器: 当 MCP 客户端启动并尝试连接到 Surge MCP Server 时，服务器会自动启动。
调用 'surge_login' 工具: 在 MCP 客户端中，调用 'surge_login' 工具并提供您的 Surge.sh 账户邮箱和密码。这将使服务器登录到您的 Surge.sh 账户。
调用 'surge_deploy' 工具: 在 MCP 客户端中，调用 'surge_deploy' 工具并指定您要部署的项目目录的路径。服务器会将该目录下的文件部署到 Surge.sh，并返回一个自动生成的随机域名。

示例工具调用 (JSON-RPC 请求):

登录工具 'surge_login':

{
  "jsonrpc": "2.0",
  "method": "call_tool",
  "params": {
    "name": "surge_login",
    "arguments": {
      "email": "[email protected]",
      "password": "your_password"
    }
  },
  "id": "login_request"
}

部署工具 'surge_deploy':

{
  "jsonrpc": "2.0",
  "method": "call_tool",
  "params": {
    "name": "surge_deploy",
    "arguments": {
      "directory": "/path/to/your/project/directory"
    }
  },
  "id": "deploy_request"
}

请根据您的 MCP 客户端的具体使用方式发送相应的 JSON-RPC 请求来调用工具。

关键词