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 文件。