Skip to main content
Glama

create_invoice

Generate a BOLT11 invoice to receive Bitcoin Lightning payments, specifying amount in satoshis with optional memo and expiry settings.

Instructions

Create a Lightning invoice to receive a payment. Returns a BOLT11 invoice string to share with the payer.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
amount_satsYesAmount to receive in satoshis
memoNoOptional description/memo for the invoice
expiry_secsNoInvoice expiry time in seconds. Defaults to 3600 (1 hour)

Implementation Reference

  • This function implements the create_invoice tool, which handles invoice creation across multiple Lightning providers (LND, Strike, OpenNode, NWC).
    async def create_invoice(
        amount_sats: int,
        memo: str | None = None,
        expiry_secs: int = 3600,
        wallet: "Union[LndWallet, NWCWallet, OpenNodeWallet, StrikeWallet, None]" = None,
    ) -> str:
        """
        Create a Lightning invoice to receive a payment.
    
        Returns a BOLT11 invoice string that can be shared with a payer.
        The payer can then use pay_invoice to pay it.
    
        Args:
            amount_sats: Amount to receive in satoshis
            memo: Optional description/memo for the invoice
            expiry_secs: Invoice expiry time in seconds. Defaults to 3600 (1 hour)
            wallet: Wallet instance
    
        Returns:
            JSON with invoice details including BOLT11 string to share with payer
        """
        if amount_sats <= 0:
            return json.dumps({
                "success": False,
                "error": "Amount must be greater than 0 sats"
            })
    
        if not wallet:
            return json.dumps({
                "success": False,
                "error": "Wallet not configured. Set LND_REST_HOST+LND_MACAROON_HEX, STRIKE_API_KEY, OPENNODE_API_KEY, or NWC_CONNECTION_STRING environment variable."
            })
    
        try:
            from ..lnd_wallet import LndWallet
            from ..strike_wallet import StrikeWallet
            from ..opennode_wallet import OpenNodeWallet
    
            if isinstance(wallet, LndWallet):
                # Create invoice via LND REST API
                inv_result = await wallet.create_invoice(
                    amount_sats=amount_sats,
                    memo=memo,
                    expiry_secs=expiry_secs,
                )
    
                return json.dumps({
                    "success": True,
                    "provider": "LND",
                    "invoice": {
                        "id": inv_result["invoice_id"],
                        "bolt11": inv_result["bolt11"],
                        "amountSats": inv_result["amount_sats"],
                    },
                    "message": f"Invoice created for {amount_sats} sats. Share the bolt11 string with the payer."
                }, indent=2)
    
            elif isinstance(wallet, StrikeWallet):
                # Create invoice via Strike API
                from decimal import Decimal
                amount_btc = Decimal(amount_sats) / Decimal("100000000")
    
                invoice_request = {
                    "amount": {
                        "currency": "BTC",
                        "amount": str(amount_btc),
                    },
                }
                if memo:
                    invoice_request["description"] = memo
    
                result = await wallet._request("POST", "/invoices", invoice_request)
                invoice_id = result.get("invoiceId")
                bolt11 = result.get("quote") or result.get("lnInvoice")
    
                return json.dumps({
                    "success": True,
                    "provider": "Strike",
                    "invoice": {
                        "id": invoice_id,
                        "bolt11": bolt11,
                        "amountSats": amount_sats,
                        "expiresAt": result.get("expiresAt"),
                    },
                    "message": f"Invoice created for {amount_sats} sats. Share the bolt11 string with the payer."
                }, indent=2)
    
            elif isinstance(wallet, OpenNodeWallet):
                # Create charge via OpenNode API
                charge_request = {
                    "amount": amount_sats,
                    "currency": "satoshis",
                }
                if memo:
                    charge_request["description"] = memo
    
                result = await wallet._request("POST", "/charges", charge_request)
                charge_id = result.get("id")
                bolt11 = (result.get("lightning_invoice") or {}).get("payreq") or result.get("lightning_invoice")
    
                return json.dumps({
                    "success": True,
                    "provider": "OpenNode",
                    "invoice": {
                        "id": charge_id,
                        "bolt11": bolt11,
                        "amountSats": amount_sats,
                    },
                    "message": f"Invoice created for {amount_sats} sats. Share the bolt11 string with the payer."
                }, indent=2)
    
            else:
                # NWC - try make_invoice NIP-47 method
                try:
                    params = {
                        "amount": amount_sats * 1000,  # NWC uses millisats
                        "expiry": expiry_secs,
                    }
                    if memo:
                        params["description"] = memo
    
                    response = await wallet._send_request("make_invoice", params)
    
                    if response.get("error"):
                        error = response["error"]
                        return json.dumps({
                            "success": False,
                            "error": f"Failed to create invoice: {error.get('message', error)}"
                        })
    
                    result = response.get("result", {})
                    return json.dumps({
                        "success": True,
                        "provider": "NWC",
                        "invoice": {
                            "id": result.get("payment_hash"),
                            "bolt11": result.get("invoice"),
                            "amountSats": amount_sats,
                        },
                        "message": f"Invoice created for {amount_sats} sats. Share the bolt11 string with the payer."
                    }, indent=2)
    
                except Exception as e:
                    return json.dumps({
                        "success": False,
                        "error": f"Invoice creation failed: {sanitize_error(str(e))}",
                        "hint": "Not all NWC wallets support invoice creation."
                    })
    
        except Exception as e:
            logger.exception("Error creating invoice")
            return json.dumps({
                "success": False,
                "error": sanitize_error(str(e))
            })
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions the return type (BOLT11 string) but omits critical details: whether this is a read-only or mutating operation, authentication requirements, rate limits, error conditions, or what happens after creation (e.g., invoice lifecycle).

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two concise sentences with zero waste. The first sentence states the purpose, and the second explains the return value. It's front-loaded and efficiently structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a financial tool with no annotations and no output schema, the description is incomplete. It lacks details on authentication, error handling, invoice lifecycle, and how the returned string should be used. Given the complexity of Lightning payments, more context is needed for safe and effective use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema fully documents all parameters. The description adds no additional parameter semantics beyond what's in the schema (e.g., it doesn't explain BOLT11 format constraints or memo usage). Baseline 3 is appropriate when the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific action ('Create a Lightning invoice'), the resource ('to receive a payment'), and the outcome ('Returns a BOLT11 invoice string'). It distinguishes itself from siblings like 'pay_invoice' (which sends payments) and 'check_invoice_status' (which queries status).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., wallet setup), when not to use it (e.g., for on-chain payments), or how it relates to siblings like 'create_l402_challenge' or 'pay_invoice'.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/refined-element/lightning-enable-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server