使用说明

项目简介

本项目 'acurast-mcp-server' 是一个基于 Model Context Protocol (MCP) 标准实现的服务器,旨在为 LLM 应用提供与 Acurast 平台交互的桥梁。它允许 LLM 客户端通过标准化的 MCP 协议,安全、可扩展地访问 Acurast 提供的资源和功能,例如部署脚本到 Acurast 网络,以及查询 Acurast 处理器的相关信息。

主要功能点

  • 资源管理:
    • 提供对 Acurast 处理器信息的访问,包括处理器列表和详细信息。
  • 工具执行:
    • 支持在 Acurast 平台上部署脚本。
    • 提供 Prompt 模板,用于审查管理器处理器的性能。
  • Prompt 模板:
    • 内置 Prompt 模板,方便用户快速发起对 Acurast 平台特定功能的查询或操作。
  • 基于标准 MCP 协议:
    • 采用 JSON-RPC over HTTP 协议进行通信,易于集成到各种 LLM 应用中。
  • 可扩展的架构:
    • 基于 '@modelcontextprotocol/sdk' 构建,易于扩展新的资源和工具。

安装步骤

  1. 克隆仓库

    git clone https://github.com/AndreasGassmann/acurast-mcp-server.git
    cd acurast-mcp-server
  2. 安装依赖 确保已安装 Node.js 和 npm。在项目根目录下运行:

    npm install

服务器配置

MCP 客户端需要配置以下信息以连接到此 MCP 服务器。请将以下 JSON 配置添加到您的 MCP 客户端配置中。

{
  "server": {
    "name": "acurast-mcp-server",
    "command": "node",
    "args": ["src/server.ts"]
  }
}

配置参数说明:

  • 'server.name': 服务器的名称,可以自定义,例如 "acurast-mcp-server"。
  • 'server.command': 启动服务器的命令,这里使用 'node' 命令来执行 JavaScript 文件。
  • 'server.args': 'command' 命令的参数,指定服务器入口文件为 'src/server.ts'。

基本使用方法

  1. 启动 MCP 服务器 在项目根目录下,运行以下命令启动服务器:

    npm run start

    服务器默认监听 3000 端口。您应该看到 "MCP Streamable HTTP Server listening on port 3000" 的提示信息。

  2. 使用 MCP 客户端连接服务器 仓库中 'src/client.ts' 提供了一个简单的命令行 MCP 客户端示例。您可以另开一个终端窗口,进入项目根目录,运行客户端:

    npm run client

    客户端启动后,会显示交互式命令提示符 '> '。您可以使用以下命令与服务器交互:

    • 'list-tools': 列出可用的工具。
    • 'call-tool deployScript {"script":"ipfs://your-ipfs-hash"}': 调用 'deployScript' 工具,部署脚本 (请替换 '"ipfs://your-ipfs-hash"' 为实际的 IPFS Hash 或 JavaScript 代码)。
    • 'call-tool review-manager-processors {"managerAddress":"your-manager-address"}': 调用 'review-manager-processors' Prompt,审查指定 manager address 的处理器性能 (请替换 '"your-manager-address"' 为实际的 manager 地址)。
    • 'list-prompts': 列出可用的 Prompt 模板。
    • 'get-prompt review-manager-processors {"managerAddress":"your-manager-address"}': 获取 'review-manager-processors' Prompt 的内容。
    • 'list-resources': 列出可用的资源。
    • 'read-resource https://acurast.com/api/v1/processors': 读取处理器列表资源。
    • 'read-resource https://acurast.com/api/v1/processors/your-processor-id/detail': 读取指定处理器 ID 的详细信息资源 (请替换 '"your-processor-id"' 为实际的处理器 ID)。
    • 'help': 查看客户端帮助信息。
    • 'quit': 退出客户端。

    注意: 'src/client.ts' 客户端仅为演示和测试目的,实际应用中您需要根据您的 LLM 应用选择或开发合适的 MCP 客户端。

预期效果

成功启动服务器和客户端后,您可以通过客户端命令与服务器交互,体验 MCP 服务器提供的资源访问和工具执行功能。例如,调用 'deployScript' 工具可以在服务器端看到脚本部署的日志,读取资源命令可以获取模拟的 Acurast 平台数据。

信息

分类

开发者工具