使用说明

项目简介

Algorand Agent MCP Server 是一个符合 Model Context Protocol (MCP) 标准的服务器实现,专门为 AI 助手(如 Claude Desktop, Cursor 等支持 MCP 协议的客户端)提供与 Algorand 区块链进行交互的桥梁。通过此服务器,AI 助手可以安全、便捷地访问 Algorand 区块链的各种功能,实现智能化的区块链应用集成。

主要功能点

  • 账户管理:创建、恢复和管理 Algorand 账户。
  • 交易处理:创建、签名和提交交易到 Algorand 区块链。
  • 资产操作:创建、修改、转移、选择加入/退出、冻结和销毁 Algorand 标准资产 (ASA)。
  • 智能合约管理:部署、更新和与智能合约进行交互,支持 ABI 方法调用和裸合约调用。
  • 多网络支持:兼容 Algorand LocalNet, TestNet 和 MainNet 三个网络环境。
  • LocalNet 资金分配器:在 LocalNet 环境下,方便地为账户提供测试资金。
  • 区块链浏览器集成:生成 Lora Explorer 链接,方便查看交易、账户、资产和应用信息。
  • 网络配置管理:允许客户端切换和查询当前使用的 Algorand 网络。

安装步骤

  1. 克隆仓库
    git clone https://github.com/gabrielkuettel/algorand-agent.git
    cd algorand-agent
  2. 安装依赖 确保您已安装 'pnpm'。如果未安装,请先安装 pnpm
    pnpm install
  3. 构建项目 (可选,开发模式可跳过)
    pnpm build

服务器配置

MCP 客户端需要配置以下 JSON 格式信息以连接到 Algorand Agent MCP Server。

{
  "serverName": "algorand-mcp",
  "command": "pnpm",
  "args": [
    "dev"
  ],
  "transport": "stdio",
  "capabilities": {
    "tools": [
      "mcp__generate_account",
      "mcp__account_get_information",
      "mcp__account_from_mnemonic",
      "mcp__dispenser_ensure_funded",
      "mcp__explorer_get_url",
      "mcp__send_payment",
      "mcp__asset_create",
      "mcp__asset_config",
      "mcp__asset_transfer",
      "mcp__asset_opt_in",
      "mcp__asset_opt_out",
      "mcp__asset_freeze",
      "mcp__asset_destroy",
      "mcp__app_call_method-call",
      "mcp__app_create_method_call",
      "mcp__app_update_method_call",
      "mcp__app_delete_method_call",
      "mcp__app_call",
      "mcp__app_create",
      "mcp__app_update",
      "mcp__app_delete",
      "mcp__set_network",
      "mcp__get_network"
    ],
    "resources": [
      "network-current",
      "network-list",
      "network-localnet",
      "network-testnet",
      "network-mainnet"
    ]
  }
}

配置参数说明:

  • 'serverName': 服务器名称,设置为 '"algorand-mcp"'。
  • 'command': 启动服务器的命令,设置为 '"pnpm"'。
  • 'args': 传递给启动命令的参数。
    • 开发模式: '["dev"]' 运行 'pnpm dev' 启动开发服务器。
    • 生产模式 (构建后): 可以尝试 '["start"]',运行 'pnpm start' 启动生产服务器 (需要先执行 'pnpm build')。
  • 'transport': 通信传输协议,设置为 '"stdio"' (标准输入输出)。
  • 'capabilities': 声明服务器提供的功能。
    • 'tools': 服务器注册的所有工具列表,客户端可以通过这些工具调用 Algorand 区块链功能。
    • 'resources': 服务器提供的所有资源列表,客户端可以读取这些资源获取 Algorand 网络信息。

基本使用方法

  1. 启动服务器 根据上述配置,在项目根目录下运行 'pnpm dev' (开发模式) 或 'pnpm start' (生产模式,需先构建)。服务器将在标准输入输出流中等待 MCP 客户端的连接和请求。

  2. 配置 MCP 客户端 在支持 MCP 协议的客户端(例如 Claude Desktop, Cursor),按照客户端的指引配置 MCP 服务器连接,填入上述提供的 JSON 配置信息。

  3. 通过客户端调用工具和访问资源 连接成功后,您可以通过 MCP 客户端的界面或指令,使用服务器提供的各项工具,例如生成 Algorand 账户、发送交易、查询账户信息等。客户端会将您的指令转换为 MCP 请求发送到服务器,服务器处理请求后将结果返回给客户端。

请参考各个工具的 'description' 字段了解其具体功能和使用方法。例如,使用 'mcp__send_payment' 工具可以发送 Algorand 支付交易。

信息

分类

网页与API