🌐 Lightning Network MCP Server
Ligthning Network MCP server.
What is Lightning Network MCP Server?
Lightning Network MCP Server is a Model Context Protocol (MCP) server that enables AI models to interact with the Lightning Network, allowing them to pay invoices.
How to use Lightning Network MCP Server?
To use the server, you can install it via Smithery or manually clone the repository, install dependencies, and configure the environment variables. Start the server in development or production mode to begin using its features.
Key features of Lightning Network MCP Server?
- 📝 Pay invoices on the Lightning Network
- 🤖 MCP-compliant API for AI integration
Use cases of Lightning Network MCP Server?
- Enabling AI models to make payments on the Lightning Network.
- Facilitating invoice payments for decentralized applications.
- Integrating with various AI services that require payment functionalities.
FAQ from Lightning Network MCP Server?
- Can I use this server for any AI model?
Yes! The server is designed to be compatible with any AI model that can utilize the MCP protocol.
- Is there a specific version of Node.js required?
Yes, Node.js version 18 or higher is required to run the server.
- How can I contribute to the project?
You can fork the repository, create a feature branch, and submit a pull request with your changes.
🌐 Lightning Network MCP Server
A Model Context Protocol (MCP) server that enables AI models to interact with Lightning Network, allowing them to pay invoices.
🚀 Features
- 📝 Pay invoices on Lightning Network
- 🤖 MCP-compliant API for AI integration
👷♂️ TODOs
- Add support for multiple Lightning Network backends
- Implement stdin transport mode (configurable via environment variable)
📋 Prerequisites
- Node.js 18+
🛠️ Installation
Installing via Smithery
To install Lightning Network MCP Server for Claude Desktop automatically via Smithery:
npx -y @smithery/cli install @AbdelStark/lightning-mcp --client claude
Manual Installation
- Clone the repository:
git clone https://github.com/AbdelStark/lightning-mcp
cd lightning-mcp
- Install dependencies:
npm install
- Create a
.envfile:
💡 You can copy the
.env.examplefile and modify it as needed.
# Bitcoin Lightning Network
## lnbits information
BITCOIN_LNBITS_NODE_URL="https://demo.lnbits.com"
BITCOIN_LNBITS_ADMIN_KEY="..."
BITCOIN_LNBITS_READ_KEY="..."
🚦 Usage
Starting the Server
# Development mode with hot reload
npm run dev
# Production mode
npm start
Available Tools
pay_invoice
Pays an invoice on the Lightning Network.
Example input:
{
"content": "lnbc20n1pneh8papp5x0syxmdqffcltfk8mqp00qc6j4kf5elkmr5pws9gm242mw9n0ejsdqqcqzzsxqyz5vqrzjqvueefmrckfdwyyu39m0lf24sqzcr9vcrmxrvgfn6empxz7phrjxvrttncqq0lcqqyqqqqlgqqqqqqgq2qsp563lg29qthfwgynluv7fvaq5d6y2hfdl383elgc6q68lccfzvpvfs9qxpqysgq2n6yhvs8aeugvrkcx8yjzdrqqmvp237500gxkrk0fe6d6crwpvlp96uvq9z2dfeetv5n23xpjlavgf0fgy4ch980mpv2rcsjasg2hqqpalykyc"
}
🔧 Development
Project Structure
lightning-mcp/
├── src/
│ ├── index.ts # Main server entry point
│ ├── lnbits-client.ts # Lightning Network client implementation
│ └── types.ts # TypeScript type definitions
├── .env # Environment configuration
└── tsconfig.json # TypeScript configuration
Running Tests
npm test
🤝 Contributing
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
📜 License
This project is licensed under the MIT License - see the LICENSE file for details.
🔗 Resources
- Lnbits repository
- Lnbits demo
- Model Context Protocol
- Visual testing tool for MCP servers
- Awesome MCP Servers
- Awesome MCP Clients
- MCP TypeScript SDK
📬 Contact
Feel free to follow me if you’d like, using my public key:
npub1hr6v96g0phtxwys4x0tm3khawuuykz6s28uzwtj5j0zc7lunu99snw2e29
Or just scan this QR code to find me:
Made with ❤️ for the Bitcoin community
