使用说明

项目简介

Algorand MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器端实现,旨在简化 LLM 应用与 Algorand 区块链的集成。它提供了一系列工具和资源,使 LLM 能够安全、高效地访问和操作 Algorand 区块链数据,执行交易,并管理账户。

主要功能点

  • 完整的 Algorand 区块链交互能力:支持全面的 Algorand 区块链操作。
  • 丰富的账户管理工具:提供账户创建、密钥管理、地址验证等功能。
  • 完善的交易处理功能:支持创建、签名、发送和模拟各种 Algorand 交易类型。
  • 多样的区块链状态查询资源:提供对账户、应用、资产和交易信息的实时和历史查询。
  • 内置安全特性:保障密钥和交易安全。
  • 支持多种 LLM 客户端:兼容 Claude Desktop, Cursor 等支持 MCP 协议的客户端。

安装步骤

  • 通过 NPM 安装 (适用于开发者): 如果您希望自行运行 Algorand MCP Server 实例,可以使用 NPM 进行安装:

    npm install algorand-mcp
  • 通过 Smithery 安装 (适用于所有用户): 对于非开发者用户,推荐通过 Smithery 平台安装和使用:

    1. 访问 Algorand MCP Server on Smithery
    2. 选择您使用的 AI 工具和平台(如 Claude Desktop, Cursor)。
    3. 复制 Smithery 提供的命令或 JSON 配置信息。
    4. 在您的 MCP 客户端中,按照客户端的指引配置并连接 MCP 服务器。

服务器配置

要将 Algorand MCP Server 连接到 MCP 客户端,您需要提供服务器的启动命令和相关参数。以下是一个典型的 JSON 格式配置示例,您需要将其填入 MCP 客户端的服务器配置中:

{
  "serverName": "Algorand MCP Server",
  "command": "algorand-mcp",
  "args": [],
  "platforms": ["claude-desktop", "cursor"],
  "tools": ["*"],
  "resources": ["*"]
}

参数说明:

  • 'serverName': MCP 服务器的自定义名称,方便您在客户端中识别。
  • 'command': 启动 Algorand MCP Server 的命令。如果您通过 'npm install -g algorand-mcp' 全局安装,则可以直接使用 'algorand-mcp' 命令。否则,您可能需要指定到 'node_modules/.bin/algorand-mcp' 的路径。
  • 'args': 传递给启动命令的参数,通常为空数组 '[]',表示无需额外参数。
  • 'platforms': 声明此 MCP 服务器兼容的客户端平台。'["claude-desktop", "cursor"]' 表示此服务器已针对 Claude Desktop 和 Cursor 进行了兼容性测试。您可以根据实际情况调整。'["*"]' 表示兼容所有平台。
  • 'tools': 声明服务器提供的工具。'["*"]' 表示提供所有可用的 Algorand 区块链交互工具。您可以根据需要指定工具名称的数组,例如 '["create_account", "send_raw_transaction"]'。
  • 'resources': 声明服务器提供的资源。'["*"]' 表示提供所有可用的 Algorand 区块链数据资源。您可以根据需要指定资源 URI 的数组,例如 '["algorand://algod/accounts/{address}", "algorand://indexer/assets"]'。

重要提示:

  • 请确保您的 Node.js 环境符合仓库的 Requirements 中指定的版本要求。
  • Windows 用户请注意,如果遇到连接问题,请尝试使用 'C:\Windows\System32\cmd.exe' 作为 'command'。
  • Cursor 客户端目前可能不支持 Resources 功能,请关注 Cursor 的最新更新。

基本使用方法

  1. 启动 MCP 服务器: 根据您的安装方式,通过命令行或 Smithery 启动 Algorand MCP Server。
  2. 配置 MCP 客户端: 在 Claude Desktop, Cursor 等 MCP 客户端中,打开 MCP 服务器配置界面,填入上面提供的 JSON 配置信息。
  3. 连接服务器: 在 MCP 客户端中点击 "连接" 或 "Connect" 按钮,客户端将自动检测并连接到 Algorand MCP Server。
  4. 使用工具和资源: 连接成功后,您就可以在 LLM 应用中通过 MCP 协议调用 Algorand 区块链的各种工具和资源,例如查询账户余额、创建交易、编译 TEAL 代码等。具体工具和资源的使用方法请参考仓库的详细文档和示例。

信息

分类

开发者工具