使用说明

项目简介

该项目 'mcp-server-lnd' 是一个 Model Context Protocol (MCP) 服务器,旨在为大型语言模型 (LLM) 应用提供与 Lightning Network Daemon (LND) 节点安全交互的桥梁。通过 MCP 协议,AI 助手可以调用此服务器提供的工具,安全地执行 LND 命令,从而实现闪电网络的功能集成。

主要功能点

  • MCP 协议兼容: 完全实现了 Model Context Protocol,可以与任何支持 MCP 协议的客户端(如 Block Goose, Claude, OpenAI 应用等)无缝对接。
  • 安全 LND 命令执行: 提供 'executeLndCommand' 工具,允许执行预定义的 LND 命令,并对命令和参数进行白名单和有效性验证,确保安全性。
  • 支持多种 LND 功能: 默认支持多种只读 LND 命令(如获取钱包信息、余额、通道、节点信息等),并可选支持写入命令(如创建发票、支付请求)。
  • Mock 测试支持: 内置 Mock LND 服务器和 MCP Inspector 测试脚本,方便开发者在没有真实 LND 节点的情况下进行测试和开发。
  • 灵活配置: 通过 '.env' 文件配置 LND 节点连接信息和服务器运行参数。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/pblittle/mcp-server-lnd.git
    cd mcp-server-lnd
  2. 安装依赖:
    npm install
  3. 配置环境变量:
    cp .env.template .env
    编辑 '.env' 文件,填入您的 LND 节点的 TLS 证书路径 ('LND_TLS_CERT_PATH')、只读 macaroon 文件路径 ('LND_MACAROON_PATH')、主机地址 ('LND_HOST') 和端口 ('LND_PORT')。

服务器配置

MCP 客户端需要配置以下 JSON 信息才能连接到 'mcp-server-lnd' 服务器:

{
  "serverName": "LND MCP Server",
  "command": "npm",
  "args": ["run", "mcp"]
  // "serverName":  MCP 服务器的名称,可以自定义。
  // "command": 启动 MCP 服务器的命令,通常是仓库的启动脚本,这里使用 npm 运行 package.json 中定义的 mcp 脚本。
  // "args":  启动命令的参数,根据 package.json 中的 scripts 字段 "mcp": "node run.js" 确定。
}

基本使用方法

  1. 启动 MCP 服务器: 在仓库根目录下运行以下命令启动服务器:
    npm run mcp
    或者使用开发模式启动:
    npm run dev
  2. 配置 MCP 客户端: 在您的 MCP 客户端(如 MCP Inspector 或 Block Goose 等)中,按照其指引配置服务器连接,将上述 JSON 配置信息填入,并选择 'stdio' 作为传输协议。
  3. 调用工具: 连接成功后,您可以在 MCP 客户端中看到 'executeLndCommand' 工具。通过调用此工具,并输入合法的 LND 命令和参数,即可与您的 LND 节点进行交互。例如,调用 'getWalletInfo' 命令可以获取 LND 钱包的基本信息。

信息

分类

开发者工具