使用说明

项目简介

Sakura Cloud MCP 服务器是一个基于 Model Context Protocol (MCP) 标准构建的后端服务,旨在为大型语言模型 (LLM) 应用提供与 Sakura Cloud 云平台交互的桥梁。它允许 LLM 安全、便捷地访问和管理 Sakura Cloud 的各种资源,并利用预置的工具执行特定操作。

主要功能点

  • 资源访问: 提供对 Sakura Cloud 服务器、存储、网络、容器应用 (AppRun) 等多种云资源的标准化访问接口。
  • 工具集成: 内置丰富的工具集,支持查询资源列表、获取资源详情、管理 AppRun 应用(创建、删除、启动、停止、更新、查看日志)等操作。
  • 区域支持: 支持 Sakura Cloud 多个数据中心区域 (Zone),允许用户指定操作的目标区域。
  • Claude 集成: 特别为 Anthropic 的 Claude 桌面应用提供集成方案,通过简单的配置即可在 Claude 中调用 Sakura Cloud 的资源和工具。
  • 公共定价查询: 无需认证即可查询 Sakura Cloud 公共服务定价信息。

安装步骤

  1. 克隆仓库:

    git clone https://github.com/hidenorigoto/sacloud-mcp.git
    cd sacloud-mcp
  2. 安装依赖: 确保已安装 Node.js (v16 或更高版本) 和 npm。执行以下命令安装项目依赖:

    npm install
  3. 构建项目:

    npm run build

服务器配置

MCP 客户端(例如 Claude 桌面应用)需要配置 MCP 服务器的启动命令才能连接。以下是针对 Claude 桌面应用的 'claude_desktop_config.json' 配置示例,用于连接到 Sakura Cloud MCP 服务器:

{
  "sacloud-server": {  // 服务器名称,在Claude中用于标识
    "command": "node", // 启动服务器的命令,这里使用 Node.js 运行 JavaScript
    "args": ["path/to/sacloud-mcp/dist/server.js"], // 启动命令的参数,指向编译后的服务器入口文件
    "env": { // 环境变量配置
      "SACLOUD_API_TOKEN": "your_sakuracloud_api_token", //  Sakura Cloud API Token,请替换为你的Token
      "SACLOUD_API_SECRET": "your_sakuracloud_api_secret" // Sakura Cloud API Secret,请替换为你的Secret
    }
  }
}

配置说明:

  • '"sacloud-server"': 这是在 Claude 客户端中识别和引用此 MCP 服务器的名称。你可以自定义名称。
  • '"command": "node"': 指定用于启动服务器的命令是 'node',表示使用 Node.js 运行时环境。
  • '"args": ["path/to/sacloud-mcp/dist/server.js"]': 'args' 数组包含传递给 'node' 命令的参数。这里指定了服务器入口文件 'server.js' 的路径。你需要将 '"path/to/sacloud-mcp"' 替换为你的 'sacloud-mcp' 仓库的实际本地路径。 注意:路径必须指向编译后的 'dist/server.js' 文件。
  • '"env"': 'env' 对象用于设置服务器运行所需的环境变量。
    • '"SACLOUD_API_TOKEN"': 必须配置。 Sakura Cloud API 访问令牌。请替换 '"your_sakuracloud_api_token"' 为你在 Sakura Cloud 控制台中生成的 API Token。
    • '"SACLOUD_API_SECRET"': 必须配置。 Sakura Cloud API 访问密钥。请替换 '"your_sakuracloud_api_secret"' 为你在 Sakura Cloud 控制台中生成的 API Secret。

配置文件位置:

将上述 'claude_desktop_config.json' 文件保存到以下对应你操作系统的目录:

  • Windows: '%APPDATA%\Claude\claude_desktop_config.json'
  • macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
  • Linux: '~/.config/Claude/claude_desktop_config.json'

基本使用方法

  1. 启动服务器: 在 'sacloud-mcp' 仓库根目录下,执行以下命令启动服务器:

    npm start

    或者直接运行编译后的 'server.js' 文件:

    node dist/server.js

    服务器默认监听标准输入输出 (stdio)。

  2. 配置 Claude 客户端: 按照上述 "服务器配置" 步骤配置 'claude_desktop_config.json' 文件,并确保配置中的路径和 API 密钥正确。

  3. 在 Claude 中使用: 重启 Claude 桌面应用。在与 Claude 的对话中,你可以使用自然语言指示 Claude 调用 Sakura Cloud 的资源和工具。例如:

    • "列出我的 Sakura Cloud 服务器"
    • "获取 server id 为 123456789012 的服务器信息"
    • "创建 AppRun 应用,名称为 my-app,镜像为 nginx,plan id 为 plan-standard"

    Claude 会根据你的指令,通过 MCP 协议与 Sakura Cloud MCP 服务器通信,执行相应的操作并返回结果。

重要提示:

  • API 密钥安全: 请务必妥善保管 Sakura Cloud API Token 和 Secret,避免泄露。不要将 API 密钥硬编码在代码中,推荐使用环境变量方式配置。
  • Claude 桌面应用: 目前 MCP 协议主要在 Claude 桌面应用中得到支持。请确保使用 Claude 桌面应用进行测试和使用。

信息

分类

开发者工具