T
lightning-mcp
...
Created 1/30/2025byAbdelStark
Language:
TypeScript
Stars:
3
Forks:
1
π 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
.env
file:
π‘ You can copy the
.env.example
file 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
Last updated: 3/1/2025
Publisher info
AβΏdel β/21M
Building Starknet. Bitcoin minimalist. Freedom tech maxi. npub1hr6v96g0phtxwys4x0tm3khawuuykz6s28uzwtj5j0zc7lunu99snw2e29
676
followers9
following144
repos