Lnd Mcp Server

🚀 闪电网络MCP服务器

闪电网络MCP服务器允许大型语言模型（LLM）代理，例如运行在 Goose 中的代理，使用自然语言查询闪电节点数据。它实现了 Model Context Protocol (MCP) 规范版本 2025-03-26，并且与MCP Inspector 1.7.0完全兼容。该服务器为用户提供了便捷的方式来获取闪电节点数据，无论是用于开发测试还是实际业务应用，都具有很高的实用价值。

🚀 快速开始

安装依赖项

npm install @modelcontextprotocol/inspector grpcio

运行示例

# 使用默认配置运行服务器
node scripts/start.js

# 使用自定义配置文件运行
node scripts/start.js --config config.json

✨ 主要特性

• 自然语言查询：该系统能够解释自然语言提示，确定用户意图，评估领域逻辑，并查询您的闪电节点。响应以纯文本和结构化JSON返回。
• 多连接方式：通过gRPC或Lightning Node Connect (LNC) 连接至您的节点，并返回易于阅读的摘要和机器可读的JSON输出。
• 可扩展性：设计上具有模块化、可测试性和可扩展性，以支持更多类型的节点，如Core Lightning和Eclair。
• 功能持续开发：当前支持基本的通道查询，并正在积极开发更广泛的功能，如节点状态、发票和路由数据。

💻 使用示例

基础用法

用自然语言提问：

显示我的渠道

获得人类可读的响应：

您的节点有 5 个渠道，总容量为 0.05000000 BTC（5,000,000 sats）。
4 个渠道是活跃的，1 个是非活跃的。

您的渠道：
1. ACINQ：0.02000000 BTC（2,000,000 sats）（活跃）
2. Bitrefill：0.01000000 BTC（1,000,000 sats）（活跃）
3. 其他渠道...

结构化JSON响应：

{
"channels": [
{
"id": "channel_id_1",
"capacity": "0.02000000 BTC",
"state": "active"
},
...
]
}

📚 详细文档

配置指南

环境变量

设置以下环境变量以配置行为：

• PORT：指定服务器监听的端口（默认值为 3000）
• LOG_LEVEL：指定日志级别（可选，值为 'debug'、'info'、'warn'、'error'）

配置文件

创建一个 config.json 文件以自定义设置：

{
"server": {
"port": 3001,
"host": "localhost"
},
"logging": {
"level": "debug"
}
}

架构细节

有关架构细节，请参见 ARCHITECTURE.md。

🔧 技术细节

该服务器实现了 Model Context Protocol (MCP) 规范版本 2025-03-26，并完全兼容MCP Inspector 1.7.0。它通过gRPC或Lightning Node Connect (LNC) 连接至您的节点，在设计上注重模块化、可测试性和可扩展性，以支持更多类型的节点。

🤝 项目贡献

贡献代码

1. 叉取仓库：git clone https://github.com/yourusername/lightning-mcp-server.git
2. 创建功能分支：git checkout -b feature/new-feature
3. 提交更改：git commit -m "Add new functionality"
4. 推送至远程仓库并创建拉取请求。

贡献文档

• 修正翻译错误或不准确的内容。
• 增加更多示例和使用场景说明。
• 更新技术规格以反映最新功能。

📄 许可证

项目采用 Apache License 2.0，详细信息请参阅 LICENSE 文件。

⚠️ 重要提示

• 确保TLS证书的安全性，避免在不安全的网络中传输敏感数据。
• 使用强密码套件来增强通信安全性。
• 定期更新依赖项以防止已知漏洞的影响。