使用说明
项目简介
Stellar MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在为大型语言模型 (LLM) 应用提供与 Stellar 区块链(包括 Stellar Classic 和 Soroban 智能合约平台)进行交互的能力。通过此服务器,LLM 可以执行账户管理、资产操作、支付处理、交易历史查询以及与 Soroban 智能合约互动等区块链操作。
主要功能点
- 账户管理: 创建新的 Stellar 账户,查询账户余额,为测试账户充值。
- 资产操作: 发行新的 Stellar 资产,设置资产的信任线。
- 支付处理: 在 Stellar 网络上进行支付交易。
- 交易历史: 查询账户的交易历史记录。
- 智能合约: 构建和优化 Soroban 智能合约。
- 支持 Stellar Classic 和 Soroban: 全面支持 Stellar 区块链的经典网络和最新的智能合约平台。
安装步骤
- 克隆仓库: 首先,将 'stellar-mcp' 仓库克隆到本地。
git clone https://github.com/syronlabs/stellar-mcp.git cd stellar-mcp - 安装依赖: 使用 npm 安装项目依赖。
npm install - 构建项目: 构建 TypeScript 代码。
npm run build - 配置环境变量: 创建 '.env' 文件,并配置 Stellar 服务器 URL。你需要根据你的需求选择 Stellar Testnet、Public 或 Futurenet 的 Horizon 服务器 URL。例如,使用 Testnet:
STELLAR_SERVER_URL=https://horizon-testnet.stellar.org
服务器配置
MCP 客户端需要配置 'mcpServers' 来连接 Stellar MCP Server。以下是不同场景的配置示例,你需要将这些配置添加到你的 MCP 客户端配置中(例如 Cursor, Windsurf, Claude Desktop 的配置文件)。
本地运行配置 (Local):
{ "mcpServers": { "stellar-mcp": { "command": "node", // 运行服务器的命令,这里使用 Node.js "args": ["your/path/stellar-mcp/dist/index.js"] // 服务器入口文件路径,请替换为你的实际路径 } } }
NPX 运行配置 (NPX):
{ "mcpServers": { "stellar-mcp": { "command": "npx", // 运行服务器的命令,使用 npx 直接运行 npm 包 "args": ["-y", "stellar-mcp"] // npx 参数,-y 表示自动确认安装, stellar-mcp 是包名 } } }
Docker 运行配置 (Docker):
{ "mcpServers": { "stellar": { "command": "docker", // 运行服务器的命令,使用 docker "args": [ "run", // docker run 命令 "-i", // 保持STDIN开放 "--rm", // 容器退出时自动删除 "--init", // 使用 init 进程 "-e", // 设置环境变量 "STELLAR_SERVER_URL=<STELLAR_URL_VALUE>", // 设置 Stellar 服务器 URL 环境变量,请替换为你的 Stellar 服务器 URL "stellar-mcp" // Docker 镜像名称 ] } } }
基本使用方法
-
启动服务器: 根据你的部署方式选择启动命令。
- 开发模式: 'npm run start:dev'
- 生产模式: 'npm run start:prod'
-
配置 MCP 客户端: 将上述 服务器配置 部分提供的 JSON 配置添加到你的 MCP 客户端设置中,并确保 'command' 和 'args' 配置正确指向 Stellar MCP Server 的启动方式。
-
使用 LLM 调用工具: 在支持 MCP 协议的 LLM 应用中,你可以通过自然语言指令调用 Stellar MCP Server 提供的工具,例如:
- "创建一个新的 Stellar 账户" (对应 'stellar_create_account' 工具)
- "查询账户 {账户公钥} 的余额" (对应 'stellar_balance' 工具,需要替换 {账户公钥} 为实际的公钥)
- "构建并优化我的 Soroban 合约" (对应 'soroban_build_and_optimize' 工具)
具体的工具和参数信息可以参考仓库 README.md 文件中 "🛠️ Tools" 部分的描述。
-
调试 (可选): 可以使用 MCP Inspector 调试工具监控 LLM 和 Stellar MCP Server 之间的交互,命令如下:
npx @modelcontextprotocol/inspector node <your/path>/stellar-mcp npm run start:prod然后访问 'http://localhost:5173' 查看 Inspector 界面。
信息
分类
网页与API