Lnd MCP Server

🚀 ライトニングネットワークMCPサーバー

ライトニングネットワークMCPサーバーは、大型言語モデル（LLM）エージェント（例えば、Goose で動作するエージェント）が自然言語でライトニングノードデータを照会できるようにします。このサーバーは Model Context Protocol (MCP) 仕様バージョン 2025-03-26 を実装しており、MCP Inspector 1.7.0 と完全に互換性があります。

このサーバーは、gRPCまたはLightning Node Connect (LNC) を通じてあなたのノードに接続し、読みやすい要約と機械可読のJSON出力を返します。モジュール性、テスト可能性、拡張性を持つように設計されており、Core LightningやEclairなどのさまざまなタイプのノードをサポートすることができます。

アーキテクチャの詳細については、ARCHITECTURE.md を参照してください。

✨ 主な機能

このシステムは自然言語のプロンプトを解釈し、ユーザーの意図を特定し、ドメインロジックを評価して、あなたのライトニングノードを照会します。応答は純粋なテキストと構造化されたJSON形式で返されます。現在は基本的なチャネル照会をサポートしており、ノードの状態、請求書、ルーティングデータなどのより幅広い機能も積極的に開発中です。

💻 使用例

基本的な使用法

自然言語で質問をする例：

表示我的渠道

人間が読みやすい応答を得る例：

您的节点有 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"
    },
    ...
  ]
}

🚀 クイックスタート

📦 インストール

依存関係をインストールします。

npm install @modelcontextprotocol/inspector grpcio

実行例

# デフォルト設定でサーバーを起動
node scripts/start.js

# カスタム設定ファイルを使用して起動
node scripts/start.js --config config.json

📚 ドキュメント

環境変数

以下の環境変数を設定することで、動作を構成できます。

• PORT：サーバーがリッスンするポートを指定します（デフォルトは 3000）
• LOG_LEVEL：ログレベルを指定します（オプションで、'debug'、'info'、'warn'、'error' のいずれか）

設定ファイル

config.json ファイルを作成して、カスタム設定を行うことができます。

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

🔧 セキュリティに関する注意事項

• TLS証明書の安全性を確保し、不安全なネットワークでの機密データの転送を避けてください。
• 強力なパスワードキットを使用して、通信の安全性を強化してください。
• 依存関係を定期的に更新して、既知の脆弱性の影響を防いでください。

🤝 プロジェクトへの貢献

コードの貢献

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 ファイルを参照してください。