项目简介

Gridscale MCP 服务器是基于 Model Context Protocol (MCP) 构建的后端服务,旨在允许大型语言模型 (LLM) 通过结构化、标准化的方式与 Gridscale 云服务提供商的 API 进行交互。它将 Gridscale 的功能封装为 MCP 定义的 资源 (Resources)工具 (Tools),从而扩展了 LLM 的能力范围,使其能够执行如创建存储、管理 IP 地址等操作。

主要功能点

  • Gridscale API 集成: 将 Gridscale 的关键 API 操作(如创建/删除 IP、创建存储、获取存储模板列表)暴露给 LLM。
  • 资源提供: 提供对 Gridscale 数据的访问能力,例如获取可用的存储模板列表。
  • 工具注册与执行: 允许 LLM 通过调用定义的工具来执行具体的 Gridscale 操作,如创建新的云存储或 IP 地址。
  • MCP 标准兼容: 实现 MCP 协议,通过 JSON-RPC 在标准输入/输出 (Stdio) 上与兼容的 MCP 客户端(如 5ire 等)通信。
  • 能力声明: 声明服务器支持的资源和工具能力。

安装步骤

  1. 安装 Go 语言环境: 您需要在您的系统上安装 Go 语言开发环境 (版本 1.18 或更高)。请访问 go.dev 获取下载和安装说明。
  2. 获取源代码: 克隆或下载 Gridscale MCP 服务器的源代码仓库。
  3. 构建程序: 在项目根目录下打开终端,运行以下命令进行构建:
    make build
    这将在当前目录下生成一个名为 'gridscale-mcp' 的可执行文件(在 Windows 上可能是 'gridscale-mcp.exe')。
  4. 可选安装: 您可以将生成的可执行文件安装到系统的 PATH 路径下,以便从任意位置运行。在 Linux/macOS 上,可以使用以下命令(可能需要管理员权限):
    make install
    如果您想卸载,可以运行:
    make uninstall

服务器配置(用于 MCP 客户端)

Gridscale MCP 服务器需要您的 Gridscale API 用户密钥 ('--user-key') 和用户令牌 ('--user-token') 才能运行和访问 Gridscale API。这些信息需要在您使用的 MCP 客户端中进行配置。

大多数 MCP 客户端会要求您提供以下信息来添加一个 MCP 服务器:

  • 名称 (Name): 一个易于识别的名称,例如 "Gridscale"。
  • 键 (Key): 一个唯一的标识符,例如 "gridscale"。
  • 命令 (Command): 启动 Gridscale MCP 服务器的可执行文件的路径。如果您已安装到 PATH,只需填写 'gridscale-mcp';否则,需要填写完整路径。
  • 参数 (Args): 传递给服务器启动命令的参数列表。需要提供 '--user-key' 和 '--user-token' 参数及其对应的值。

例如,在一个支持 JSON 配置的 MCP 客户端中,配置信息可能类似于(注意:这只是一个示例结构,实际配置方式取决于您的客户端):

{
  "name": "Gridscale", // 服务器名称
  "key": "gridscale",   // 服务器唯一标识符
  "command": "gridscale-mcp", // 可执行文件路径 (如果已安装到PATH)
  "args": [ // 启动参数列表
    "--user-key", "您的 Gridscale API 用户密钥", // 替换为您的用户密钥
    "--user-token", "您的 Gridscale API 用户令牌" // 替换为您的用户令牌
  ]
}

请将 '"您的 Gridscale API 用户密钥"' 和 '"您的 Gridscale API 用户令牌"' 替换为您的实际 Gridscale API 凭据。这些凭据可以在 Gridscale 控制面板中获取。

基本使用方法

  1. 准备 Gridscale API 凭据: 确保您拥有有效的 Gridscale API 用户密钥和用户令牌。
  2. 运行服务器: 在终端中,导航到 'gridscale-mcp' 可执行文件所在的目录(如果未安装到 PATH),然后运行服务器,并提供您的 Gridscale API 凭据:
    ./gridscale-mcp --user-key <您的用户密钥> --user-token <您的用户令牌>
    或者,如果您已经将其安装到 PATH 中:
    gridscale-mcp --user-key <您的用户密钥> --user-token <您的用户令牌>
    服务器将在标准输入/输出上启动,等待 MCP 客户端连接。
  3. 连接 MCP 客户端: 启动您偏好的 MCP 客户端(如 5ire)。在客户端中,按照其说明添加并配置 Gridscale MCP 服务器,使用您在步骤 2 中运行服务器时提供的相同命令和参数。
  4. 与 LLM 交互: 一旦 MCP 客户端成功连接到 Gridscale MCP 服务器,您就可以通过 LLM 与 Gridscale API 进行交互,例如请求获取存储模板列表,或者让 LLM 调用工具来创建新的 IP 地址或存储。

重要提示: 由于此服务器允许 AI 模型直接操作您的 Gridscale 账户资源,请务必谨慎使用。强烈建议您在隔离的环境(例如一个空的 Gridscale 项目)中进行测试,以避免意外的数据丢失或资源费用。使用此程序产生的一切后果由您自行负责。

信息

分类

AI与计算