Cln MCP

🚀 Core Lightning MCP Server

Core Lightning MCP Server 是一个基于 Rust 的 gRPC 服务器，它为 Core Lightning 节点提供了标准化接口。该服务器实现了 MCP（Model Context Protocol）规范，允许使用大语言模型（LLM）控制 Core Lightning 节点。

🚀 快速开始

你可以按照以下步骤安装和配置 Core Lightning MCP Server。

📦 安装指南

选项 1：从发布版本安装（推荐）

1. 从 最新发布版本 下载适合你平台的二进制文件。
2. 解压归档文件：

   # 对于 Linux/macOS
   tar -xzf cln-mcp-<platform>.tar.gz
   
   # 对于 Windows
   # 使用你喜欢的解压缩工具
   

3. 使二进制文件可执行（仅适用于 Linux/macOS）：

   chmod +x cln-mcp
   

选项 2：从源代码安装

前提条件

• Rust 1.80 或更高版本
• 协议缓冲区编译器（protoc）
• Core Lightning（启用 gRPC）
• MCP 客户端（Claude、Goose 等）

协议缓冲区编译器（protoc）

Ubuntu/Debian：

sudo apt-get update
sudo apt-get install -y protobuf-compiler

macOS：

brew install protobuf

Windows：

choco install protoc

验证安装：

protoc --version  # 应显示 3.0.0 或更高版本

1. 克隆仓库：

git clone https://github.com/adi2011/cln-mcp.git
cd cln-mcp

2. 构建项目：

cargo build --release

📚 详细文档

配置

可以使用命令行参数配置服务器：

cln-mcp [OPTIONS]

Options:
  --certs-dir <path>    证书目录的路径
  --node-address <url>  节点地址（默认：https://localhost:9736）
  --help                显示帮助信息

TLS 证书设置

在运行 CLN 时添加 --grpc-port（默认：9736）选项，它将自动生成适当的 mTLS 证书。

将以下 PEM 文件从 Lightning 目录复制到单独的目录：

• ca.pem：CA 证书
• client.pem：客户端证书
• client-key.pem：客户端私钥

Claude 设置

• 安装 Claude
• 转到设置 -> 开发者
• 编辑配置

   {
       "mcpServers" : {
           "cln-mcp" : {
               "command": "cln-mcp 的路径"（例如："/Users/MyPC/cln-mcp/target/release/cln-mcp" 或从发布版本解压的可执行文件）,
               "args": [
                   "--certs-dir",
                   "证书的路径"（例如："/Users/MyPC/cln-mcp/certs"）
               ]
           }
       }
   }

• 重启 Claude

🔮 未来目标

[ ] 使其能够推导 RPC 调用的参数
[ ] 选择最合适、最有用的 RPC 以实现最大效用
[ ] 扩展对 LND 的支持
[ ] 托管多个服务器以提高效率

这是一个正在进行的项目。我们欢迎代码审查、拉取请求和基于使用情况提出的问题。

📄 许可证

本项目采用 MIT 许可证。详情请见 LICENSE 文件。