使用说明

项目简介

Stellar MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端,旨在为大型语言模型 (LLM) 提供与 Stellar 区块链网络交互的能力。该服务器支持 Stellar Classic 和 Soroban 智能合约,提供账户管理、资产操作、支付处理和交易历史检索等工具,使 LLM 能够安全、便捷地访问和操作 Stellar 区块链上的资源。

主要功能点

  • Stellar 账户管理:创建新的 Stellar 账户、查询账户余额。
  • Stellar 资产操作:创建自定义资产、建立资产信任线。
  • 支付处理:发送 XLM 或自定义资产的支付交易。
  • 交易历史:检索账户的交易历史记录。
  • [WIP] Soroban 智能合约交互:部署和调用 Soroban 智能合约(功能开发中)。

安装步骤

  1. 确保已安装 Node.js 和 npm。
  2. 克隆本仓库到本地。
  3. 在终端中进入仓库目录。
  4. 运行 'npm install' 安装项目依赖。
  5. 在仓库根目录下创建 '.env' 文件,并设置 'STELLAR_SERVER_URL' 环境变量为你的 Stellar Horizon 服务器 URL (例如:'https://horizon-testnet.stellar.org' 用于测试网络)。

服务器配置

要将 Stellar MCP 服务器与 MCP 客户端(如 Cursor、Windsurf 或 Claude Desktop)配合使用,需要在客户端中配置服务器的启动命令。以下是示例配置信息(JSON 格式):

{
    "mcpServers": {
      "stellar-mcp": {
        "command": "node",  // 启动服务器的命令,这里使用 Node.js
        "args": ["path/to/stellar-mcp/dist/index.js"] // 命令参数,指向编译后的服务器入口文件,请根据实际路径调整
      }
    }
}

或者,如果使用 'npx' 全局安装运行:

{
    "mcpServers": {
      "stellar-mcp": {
        "command": "npx",  // 启动服务器的命令,使用 npx
        "args": ["-y", "stellar-mcp"] // 命令参数
      }
    }
}

或者,使用 Docker 镜像运行:

{
  "mcpServers": {
    "stellar": {
      "command": "docker",  // 启动服务器的命令,使用 docker
      "args": ["run", "-i", "--rm", "--init", "-e", "STELLAR_SERVER_URL=<STELLAR_URL_VALUE>", "stellar-mcp"] // 命令参数,通过环境变量设置 STELLAR_SERVER_URL
    }
  }
}

基本使用方法

  1. 编译服务器:运行 'npm run build'。
  2. 启动服务器:运行 'npm run start:prod' (生产模式)。
  3. 在 MCP 客户端中配置上述服务器配置 JSON。
  4. 连接成功后,即可在 MCP 客户端中使用自然语言指令与 Stellar 区块链进行交互。例如,您可以询问:“账户 G... 的余额是多少?” 或 “向账户 P... 支付 100 XLM”。LLM 将利用 Stellar MCP 服务器提供的工具来完成您的请求。

信息

分类

商业系统