使用说明

项目简介

Lightning MCP 是一个开源项目,它充当比特币闪电网络和模型上下文协议(MCP)之间的桥梁。它允许 AI 智能体和软件系统通过标准化的 MCP 接口无缝发送和接收比特币闪电网络支付。该项目旨在为 AI 应用集成比特币支付能力提供安全、可扩展的上下文服务框架。

主要功能点

  • 闪电网络集成: 提供创建发票、支付发票、查询支付状态、获取钱包和通道余额、管理通道(列出、打开、关闭)等全面的闪电网络操作工具。
  • MCP 接口: 实现了模型上下文协议(MCP)服务端接口,允许 AI 智能体通过 MCP 协议调用闪电网络的功能。
  • 多后端支持: 目前支持 LND (Lightning Network Daemon),并计划支持 Core Lightning 和 Eclair 等其他闪电网络节点实现。
  • 安全: 支持 TLS 加密和多种身份验证机制(macaroons, tokens, API keys)。
  • 易于部署: 提供 Docker 支持和详细的配置选项,方便用户快速部署和使用。

安装步骤

  1. 克隆仓库

    git clone https://github.com/LNAgents/lightning-mcp.git
    cd lightning-mcp
  2. 创建并激活虚拟环境

    python -m venv env
    source env/bin/activate   # Linux/macOS
    env\Scripts\activate  # Windows
  3. 安装依赖

    pip install -r requirements.txt
  4. 配置闪电网络节点连接 复制并编辑配置文件 'config.json',根据你使用的闪电网络节点 (目前主要支持 LND) 配置连接信息,例如 LND 节点的 RPC 服务器地址、TLS 证书路径和 macaroon 文件路径。

    cp config.example.json config.json
    # 编辑 config.json
  5. 运行服务器

    python -m lightning_mcp.server.mcp_server

    或者使用 Docker 部署:

    docker build -t lightning-mcp .
    docker run -p 8000:8000 -v $(pwd)/config.json:/app/config.json lightning-mcp

服务器配置 (MCP 客户端)

以下为 MCP 客户端连接 Lightning MCP 服务器时 'config.json' 文件的配置示例,请根据实际情况修改:

{
  "serverName": "Lightning-MCP-Server",
  "command": "python",
  "args": [
    "-m",
    "lightning_mcp.server.mcp_server"
  ],
  "transport": "sse",
  "baseURL": "http://localhost:8080/sse"
}

配置参数说明:

  • 'serverName': MCP 服务器的名称,可以自定义。
  • 'command': 启动 MCP 服务器的命令,这里使用 'python'。
  • 'args': 启动命令的参数,'-m lightning_mcp.server.mcp_server' 表示运行 'lightning_mcp.server.mcp_server.py' 模块。
  • 'transport': MCP 客户端与服务器通信的传输协议,这里使用 'sse' (Server-Sent Events)。
  • 'baseURL': MCP 服务器的 SSE 基地址,根据服务器实际运行地址和端口修改。例如,如果服务器运行在 'localhost:8080',则为 'http://localhost:8080/sse'。

注意: 请确保 MCP 客户端能够访问到 Lightning MCP 服务器的网络地址。

基本使用方法

服务器启动后,MCP 客户端可以通过配置的 'baseURL' 与 Lightning MCP 服务器建立连接,并调用服务器提供的 MCP 工具来执行闪电网络操作。

例如,客户端可以调用 'lightning/createInvoice' 工具创建闪电网络发票,或调用 'lightning/payInvoice' 工具支付闪电网络发票。

具体的工具列表和使用方法可以参考仓库的 README.md 文件。

信息

分类

商业系统