关键词

文件操作目录管理分布式文件系统API 网关集成Hyperslop

项目简介

Hyperslop MCP 服务器是一个基于 Model Context Protocol (MCP) 实现的应用后端，它允许 LLM (大型语言模型) 客户端通过标准化的方式访问 HyperSlop 网络上的文件和目录。它通过集成 HyperSlop Gateway API，将 LLM 的请求转化为对 Hyperslop 分布式文件系统的操作，并返回结果作为上下文信息。

主要功能点

  • 文件操作： 支持在 Hyperslop 网络上读取文本文件内容、写入文本文件、删除文件。
  • 目录操作： 支持创建、读取（列出内容）、删除目录。
  • 文件树浏览： 支持读取整个节点的文件系统结构（不含文件内容）。
  • 节点识别： 支持获取服务器配置中指定的当前节点名称。
  • API 网关集成： 所有操作均通过配置在 'api.json' 中的 Hyperslop Gateway API 进行。
  • 日志记录与进度报告： 记录操作过程，并支持向客户端报告长时间操作的进度。

安装步骤

  1. 克隆仓库： 将项目代码下载到本地。 
    git clone https://github.com/assemblycapital/hyperslop-mcp.git
cd hyperslop-mcp
  2. 创建并激活虚拟环境： 推荐使用虚拟环境隔离项目依赖。 
    python -m venv venv
source venv/bin/activate  # macOS/Linux
# 或
.\venv\Scripts\activate  # Windows
  3. 安装依赖： 安装运行服务器所需的 Python 包。 
    pip install -r requirements.txt
  4. 安装 FastMCP： Hyperslop MCP 服务器依赖 FastMCP 框架运行。
    • 首先确保安装了 'uv' 工具：请参考 uv 安装指南。
    • 然后使用 'uv' 安装 FastMCP： 
      uv pip install fastmcp
  5. 配置 Gateway API：
    • 打开 Hyperslop 应用。
    • 找到并点击“Copy API”按钮，复制 API 配置信息。
    • 在项目的根目录创建一个名为 'api.json' 的文件。
    • 将复制的 API 配置内容粘贴到 'api.json' 文件中。这个文件包含了 Gateway 的 URL、API 密钥以及你的节点名称。
  6. 安装 MCP 服务器： 使用 FastMCP 将该服务器注册到系统中，以便 MCP 客户端（如 Claude Desktop）可以发现并运行它。 
    fastmcp install main.py
    安装成功后，下次启动你的 MCP 客户端时，Hyperslop MCP 服务器应该就会出现在可用服务器列表中。

服务器配置（供 MCP 客户端参考）

为了让 MCP 客户端（例如 Claude Desktop）能够找到并启动 Hyperslop MCP 服务器，客户端需要配置服务器的启动信息。这些信息通常在客户端的设置界面中以结构化的方式提供，用户只需要填写对应的参数即可。

典型的 MCP 客户端配置项通常包括：

  • 服务器名称 (Server Name): 用于在客户端界面中标识该服务器的名称。对于此项目，建议填写 'Hyperslop Server'。
  • 命令 (Command): 启动服务器进程的可执行文件路径或名称。如果您按照上述步骤使用 'fastmcp install' 进行了安装，通常客户端可以自动找到或您需要指定 'fastmcp' 命令的路径。
  • 参数 (Arguments): 传递给启动命令的额外参数。对于通过 FastMCP 运行的服务器，参数通常是 'run' 后跟主脚本文件路径，例如 'run main.py'。您可能需要在客户端配置界面中将 'run' 和 'main.py' 作为单独的参数项填写。
  • 工作目录 (Working Directory): 指定服务器进程的运行目录，通常应设置为项目的根目录，确保 'api.json' 等文件能被找到。

重要提示： 在启动 MCP 服务器之前，请确保 'api.json' 文件已正确配置并放置在服务器主脚本 ('main.py') 所在的目录下。服务器将读取此文件来连接 Hyperslop Gateway。

基本使用方法

安装并配置好 MCP 服务器后，启动支持 MCP 的 LLM 客户端。客户端将检测到 Hyperslop MCP 服务器。

LLM 客户端（或其集成的 AI 模型）现在可以通过 MCP 协议调用服务器提供的工具：

  • 'hyperslop_network_read' 工具： 用于执行读取操作，如获取节点名、读取目录内容、读取文本文件、读取文件树。调用时需要指定 'operation' (操作类型)、'node' (目标节点)，以及可选的 'path' (文件/目录路径)。
  • 'hyperslop_network_write' 工具： 用于执行写入操作，如创建目录、删除目录、写入文本文件、删除文件。调用时需要指定 'operation' (操作类型)、'node' (必须是您的节点名)、'path' (文件/目录路径)，以及 'content' (写入文件时所需的文本内容)。

LLM 模型会根据您的指令（例如“在 Hyperslop 网络上读取文件 /documents/report.txt 的内容”）自动构造相应的工具调用请求（JSON-RPC 格式）发送给 MCP 服务器。服务器执行操作后，将结果返回给客户端，作为模型的上下文信息供其后续处理。

信息

分类

数据库与文件

访问项目