Lnd MCP Server

🚀 Lightning Network MCP Server

The Lightning Network MCP Server enables Large Language Model (LLM) agents, such as those running in Goose, to query Lightning node data using natural language. It implements the Model Context Protocol (MCP) specification version 2025-03-26 and is fully compatible with MCP Inspector 1.7.0.

This server connects to your node via gRPC or Lightning Node Connect (LNC) and returns easy-to-read summaries and machine-readable JSON outputs. It is designed to be modular, testable, and extensible to support more types of nodes, such as Core Lightning and Eclair.

For architectural details, see ARCHITECTURE.md.

✨ Features

This system interprets natural language prompts, determines user intent, evaluates domain logic, and queries your Lightning node. Responses are returned in plain text and structured JSON. Currently, it supports basic channel queries, and more extensive features, such as node status, invoices, and routing data, are actively under development.

💻 Usage Examples

Basic Usage

Ask a question in natural language:

Show my channels

Get a human-readable response:

Your node has 5 channels with a total capacity of 0.05000000 BTC (5,000,000 sats).
4 channels are active, and 1 is inactive.

Your channels:
1. ACINQ: 0.02000000 BTC (2,000,000 sats) (active)
2. Bitrefill: 0.01000000 BTC (1,000,000 sats) (active)
3. Other channels...

Get a structured JSON response:

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

🚀 Quick Start

📦 Installation

npm install @modelcontextprotocol/inspector grpcio

Run the Example

# Run the server with default configuration
node scripts/start.js

# Run with a custom configuration file
node scripts/start.js --config config.json

📚 Documentation

Environment Variables

Set the following environment variables to configure the behavior:

• PORT: Specify the port the server listens on (default is 3000).
• LOG_LEVEL: Specify the log level (optional, values are 'debug', 'info', 'warn', 'error').

Configuration File

Create a config.json file to customize settings:

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

⚠️ Important Note

• Ensure the security of TLS certificates to avoid transmitting sensitive data over insecure networks.
• Use strong cipher suites to enhance communication security.
• Regularly update dependencies to prevent known vulnerabilities.

🤝 Contributing

Contributing Code

1. Fork the repository: git clone https://github.com/yourusername/lightning-mcp-server.git
2. Create a feature branch: git checkout -b feature/new-feature
3. Commit your changes: git commit -m "Add new functionality"
4. Push to the remote repository and create a pull request.

Contributing Documentation

• Correct translation errors or inaccurate content.
• Add more examples and usage scenarios.
• Update technical specifications to reflect the latest features.

📄 License

This project is licensed under the Apache License 2.0. For more details, see the LICENSE file.