项目简介

Jackal MCP 服务器是一个遵循 Model Context Protocol (MCP) 标准的应用后端,旨在通过提供标准化的工具接口,允许大型语言模型 (LLM) 客户端与 Jackal Protocol 进行交互。它连接到 Jackal Protocol 区块链,并暴露用于管理存储空间和文件的功能。

主要功能点

  • 购买存储空间: LLM 可以调用工具在 Jackal Protocol 上购买分布式存储空间。
  • 上传文件: LLM 可以调用工具将文件上传到用户的 Jackal Protocol 私有存储区域。
  • 下载文件: LLM 可以调用工具从用户的 Jackal Protocol 私有存储区域下载文件。
  • 通过标准化的 MCP 工具接口,使 LLM 能够执行区块链存储相关的操作。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/JackalLabs/jackal-mcp.git
    cd jackal-mcp
  2. 安装依赖: 确保您已安装 Node.js 和 npm。
    npm install
  3. 配置 Jackal Protocol 助记词: 在项目根目录下创建一个名为 '.env' 的文件,并在其中添加您的 Jackal Protocol 账户助记词。请注意,出于安全考虑,请谨慎使用此文件,并避免在公共仓库中分享。
    JKLTESTSEED="your twelve or twenty-four word mnemonic phrase here"
  4. 构建项目: 编译 TypeScript 代码。
    npm run build 
    (这通常会将源代码从 'src' 目录编译到 'dist' 目录)

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

MCP 客户端需要配置如何启动和连接到此服务器。典型的配置包含服务器名称、启动命令及其参数。

例如,您可以在 MCP 客户端的配置中添加一个服务器条目,其中:

  • 服务器名称: 'jackal'
  • 启动命令 (command): 'node' (用于执行 Node.js 脚本)
  • 启动参数 (args): '["dist/index.js"]' (指向编译后的服务器入口文件)

此外,服务器启动时会尝试读取 '.env' 文件中的 'JKLTESTSEED' 环境变量以连接到 Jackal Protocol。请确保运行服务器的环境已正确配置此变量或存在 '.env' 文件。

基本使用方法

一旦服务器根据上述配置由 MCP 客户端成功启动并连接,LLM 客户端即可发现并调用服务器注册的工具。LLM 可以向服务器发送 JSON-RPC 请求,如:

  • 调用 'buy-storage' 工具购买存储空间。
  • 调用 'upload-file' 工具,并提供 'filepath' 参数,指定要上传的本地文件路径。
  • 调用 'download-file' 工具,并提供 'name' 参数,指定要下载的文件名称。

服务器将执行相应的 Jackal Protocol 操作,并将结果通过 JSON-RPC 响应返回给客户端,供 LLM 使用。

信息

分类

数据库与文件