article
README
🚀 雷电网络 MCP 服务器
雷电网络 MCP 服务器允许大型语言模型(LLM)代理,例如运行在 Goose 中的代理,使用自然语言查询雷电节点数据。它实现了 模型上下文协议 (MCP) 规范版本 2025-03-26,并与 MCP 检查器 1.7.0 完全兼容。该服务器通过 gRPC 或 Lightning Node Connect (LNC) 连接到您的节点,返回可读的摘要和机器可读的 JSON 输出。它采用模块化设计,具备可测试性和可扩展性,以支持额外的节点类型,如 Core 雷电和 Eclair。
🚀 快速开始
连接到 LND 节点
使用默认配置
在项目根目录下创建一个 .env 文件,并添加以下内容:
# 使用 gRPC 的直接连接(推荐)
LND_GRPC_HOST=127.0.0.1
LND_GRPC_PORT=10009
MACAROON_FILE=./macaroon.pem
CERTIFICATE_FILE=./cert.pem
# 或使用 LNC 的远程连接
LNC_SERVER_HOST=127.0.0.1
LNC_SERVER_PORT=8080
使用 credential 提取工具
如果您的设备支持 - lndconnect URL,请运行以下命令:
node scripts/extract-credentials.js "lndconnect://your-node.onion:10009?cert=BASE64CERT&macaroon=BASE64MACAROON"
该脚本将:
- 提取主机、端口、证书和 macaroon。
- 将证书转换为 PEM 格式(所需格式)。
- 保存文件到测试/fixtures 目录。
- 输出需要添加到 .env 文件的配置。
测试 MCP 检查器
要使用官方 MCP 检查器进行测试:
- 安装检查器:
npm install -g @modelcontextprotocol/inspector
- 构建项目:
npm run build
- 运行检查:
LOG_LEVEL=warn npx @modelcontextprotocol/inspector node scripts/inspect.js
✨ 主要特性
- 该系统解析自然语言提示,确定用户意图,评估领域逻辑,并查询您的雷电节点。响应以纯文本和结构化 JSON 格式返回。
- 目前支持基本的频道查询,并正在积极开发更广泛的功能,包括节点状态、发票和路由数据。
💻 使用示例
基础用法
用自然语言提问:
- "我该如何使用 MCP 服务器查询我的雷电钱包余额?"
- "请列出所有与我地址相关的通道。"
注意事项
⚠️ 重要提示
- 目前不支持创建或修改频道的操作。
- 查询范围仅限于您节点的本地数据。
📚 详细文档
兼容性
- MCP 规范版本
2025-03-26 - MCP 检查器版本
1.7.0 - 与 MCP 代理(如鹅)兼容
- 支持 gRPC 直接节点访问
- 支持 LNC 远程安全访问
- 提供 JSON 和自然语言输出格式
架构细节
有关架构细节,请参阅 ARCHITECTURE.md。
贡献指南
有关设置、样式和测试的指导,请参阅 CONTRIBUTING.md。
📄 许可证
Apache License 2.0。查看 LICENSE。
微信扫一扫