- Home
- MCP servers
- Lightning Wallet
Lightning Wallet
- typescript
5
GitHub Stars
typescript
Language
4 months ago
First Indexed
2 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"lightningfaucet-lightning-wallet-mcp": {
"command": "npx",
"args": [
"lightning-wallet-mcp"
],
"env": {
"LIGHTNING_WALLET_API_KEY": "your-api-key-here"
}
}
}
}You can empower your AI agents with a Bitcoin wallet powered by the Lightning Wallet MCP Server. This MCP server lets agents send and receive Bitcoin via the Lightning Network, enabling autonomous microtransactions and real-time payments between operators and agents with clear budgets and observability.
How to use
Use this MCP server to register operators and create agents, fund wallets, and perform Lightning or USDC-based payments through automated API calls. You can pay for paid APIs, transfer funds between agents, and receive real-time event notifications via webhooks. All payments, budgets, and analytics are designed to help you manage spending while maintaining security and transparency.
How to install
Prerequisites: You need Node.js installed on your system. Ensure you have a compatible npm or npx setup.
# Install the MCP package globally or run via npx in your project
# The following examples assume you will run the MCP via npx from your project context
Additional setup and configuration
This MCP server can run in a local, self-hosted mode using a standard Node.js environment. You can choose to register the MCP server without an API key, or supply a pre-configured API key to authenticate with the service.
{
"mcpServers": {
"lightning-wallet": {
"command": "npx",
"args": ["lightning-wallet-mcp"]
}
}
}
Security and best practices
- Never expose API keys in code repositories. Use environment variables and secret management. - Set budget limits to prevent excessive spending. - Use operator keys for payments and keep the operator credentials secure. - Verify webhook signatures using the HMAC secret provided during webhook registration. - Regularly review transactions and analytics to detect unusual activity.
Troubleshooting and notes
If you need to recover an operator or rotate API keys, use the built-in recovery and key rotation tools. Ensure webhooks are reachable and verify their signatures to maintain trust in event notifications.
Available tools
get_info
Get service status, version, and supported features.
decode_invoice
Decode a BOLT11 invoice to reveal amount, destination, and expiry.
whoami
Identify whether you are operating as the operator or an agent and provide current context.
check_balance
Check the current Lightning balance in satoshis.
get_rate_limits
View current rate limit status and remaining requests.
pay_l402_api
Access paid APIs using the L402 or X402 protocol with automatic detection.
pay_invoice
Pay a BOLT11 Lightning invoice.
keysend
Send a payment directly to a node pubkey without an invoice.
pay_lightning_address
Pay to a Lightning address in user@domain format.
create_invoice
Generate an invoice to receive payments.
get_invoice_status
Check if a previously created invoice has been paid.
get_transactions
View the transaction history.
export_transactions
Export transactions in JSON or CSV format.
lnurl_auth
Authenticate to a service using LNURL-auth.
claim_lnurl_withdraw
Claim funds from an LNURL-withdraw link.
register_operator
Create a new operator account.
recover_account
Recover an account using a recovery code.
rotate_api_key
Generate a new API key with a cooldown on withdrawals.
get_deposit_invoice
Create an invoice to fund the operator account.
withdraw
Withdraw funds to an external Lightning destination.
set_operator_key
Switch to operator credentials.
create_agent
Create an agent under the operator.
list_agents
List all agents under the operator.
fund_agent
Transfer sats from operator to an agent.
transfer_to_agent
Move sats between agents or from operator to an agent.
sweep_agent
Sweep funds from an agent back to the operator.
deactivate_agent
Temporarily disable an agent.
reactivate_agent
Re-enable a deactivated agent.
delete_agent
Permanently delete an agent and return balance to the operator.
get_budget_status
Get an agent's budget limit and current spending.
set_budget
Set or update an agent's spending limit.
get_agent_analytics
Get usage analytics for an agent over a selected period.
set_agent_credentials
Switch to agent credentials.
register_webhook
Register a URL to receive event notifications.
list_webhooks
List all registered webhooks.
delete_webhook
Delete a registered webhook.
test_webhook
Send a test event to verify webhook connectivity.