SupaCloud MCP Server

关键词

模型上下文协议资源管理工具注册JSON-RPC跨传输协议

使用说明（Markdown 格式）

  • 项目简介

    • 本仓库中的 MCP 服务器实现面向 AI 客户端，按照 MCP 协议约定提供标准化的资源管理、工具执行、以及提示模板能力，核心目标是为 LLM/AI 代理提供对后端资源与外部功能的安全、可扩展访问。

  • 主要功能点

    • 资源与数据访问：通过 MCP 服务器对后端资源进行托管、查询、更新等操作，便于 LLM 客户端获取所需上下文信息。
    • Tools 注册与执行：实现对外部工具的注册、发现与执行，允许 MCP 客户端通过工具调用外部功能、完成复杂流程。
    • Prompts 与模板：提供对 Prompt 模板的注册、渲染与管理能力，支持自定义的对话模式与上下文注入。
    • JSON-RPC 通信：服务端遵循 MCP 的 JSON-RPC 风格请求/响应，方便集成到各种客户端。
    • 多传输协议支持：理论上支持多种传输途径（如 STDIO、SSE、WebSocket 等，具体实现可通过传输层扩展）。
    • 会话与能力声明：服务器端负责会话管理、能力声明，确保安全可控的上下文服务。

  • 安装步骤

    • 先决条件：Node.js/TypeScript 环境、NPM 或 Bun 等运行时、Git 等。
    • 获取代码：将仓库克隆到本地或通过已有镜像获取 MCP 服务器实现代码。
    • 构建与运行：在包含 mcp 服务的包中，通过对应入口启动 MCP 服务器。示例：使用标准 Node/Bun 场景运行入口脚本，若使用内置的 Stdio 传输，可直接从 CLI 启动。
    • 启动命令与参数（常用场景）
      • MCP 服务器启动（标准输入输出管道工作模式）：
        • 启动命令示例：npx @supacloud/mcp-server
        • 参数示例（若有）请参考实际运行时文档或源码入口处的注释与 README。
    • 注意：本实现中包含多种工具与传输适配，实际运行时请根据环境准备 SSH、HTTP（Management API）等访问能力。

  • 服务器配置（MCP 客户端需要的配置 JSON） 说明：MCP 客户端在连接 MCP 服务器时需要进行配置，至少包含服务器标识、启动命令（command）及参数（args），以及必要的环境变量。以下示例基于仓库信息拟定，供 MCP 客户端使用时参考。请按实际环境替换 host/token 等字段。

{ "mcpServers": { "supacloud": { "name": "supacloud", "command": "npx", "args": ["-y", "@supacloud/mcp-server"], "env": { // MCP 服务器地址（需要能够被 MCP 客户端访问） "SUPACLOUD_HOST": "your-server-ip", // 可选：SSH 私钥路径（若通过 SSH 工具组网） "SUPACLOUD_SSH_KEY": "~/.ssh/id_rsa", // MCP 管理端口/令牌等 "SUPACLOUD_API_TOKEN": "your-master-token" } } } }

  • 基本使用方法

    • 启动 MCP 服务器后，MCP 客户端通过上述配置与服务器建立连接，访问资源、调用工具、渲染 Prompts 等能力。
    • 在实际使用中，客户端会通过 MCP 的工具集合查询、执行外部操作、获取上下文信息，以实现对后端系统的智能化管理和自动化工作流。

  • 运行与测试要点

    • 确保 Management API、SSH 及 HTTP 传输渠道可达，网络和鉴权配置正确。
    • 通过 MCP 客户端向 MCP 服务器发起请求，验证资源访问、工具执行、以及 Prompts 渲染等核心功能是否正常工作。
    • 关注日志输出与错误信息，逐步排查跨传输通道、权限、以及资源访问的潜在问题。

  • 备注

    • MCP 服务器实现具备可扩展性，后续可以继续添加更多工具、资源接口、以及自定义的 Prompt/模板渲染能力。

服务器信息

访问项目