Skip to content

Commit b0292ff

Browse files
committed
f - Document ldk-server-mcp in the workspace
Replace exhaustive tool listing with a pointer to tools/list to avoid the maintenance burden of keeping the README in sync with every new RPC. Co-Authored-By: HAL 9000
1 parent 9b37e65 commit b0292ff

1 file changed

Lines changed: 1 addition & 62 deletions

File tree

ldk-server-mcp/README.md

Lines changed: 1 addition & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -89,71 +89,10 @@ Add to your Claude Code MCP settings (`.claude/settings.json`):
8989

9090
## Available Tools
9191

92-
The server exposes 37 unary LDK Server RPCs as MCP tools.
92+
All unary LDK Server RPCs are exposed as MCP tools. Use `tools/list` to discover the current set.
9393

9494
Streaming RPCs such as `subscribe_events` and non-RPC HTTP endpoints such as `metrics` are not exposed as tools.
9595

96-
### Node
97-
| Tool | Description |
98-
|------|-------------|
99-
| `get_node_info` | Retrieve node info including node_id, sync status, and best block |
100-
| `get_balances` | Retrieve an overview of all known balances (on-chain and Lightning) |
101-
102-
### On-chain
103-
| Tool | Description |
104-
|------|-------------|
105-
| `onchain_receive` | Generate a new on-chain Bitcoin funding address |
106-
| `onchain_send` | Send an on-chain Bitcoin payment to an address |
107-
108-
### Payments
109-
| Tool | Description |
110-
|------|-------------|
111-
| `bolt11_receive` | Create a BOLT11 Lightning invoice to receive a payment |
112-
| `bolt11_receive_for_hash` | Create a BOLT11 Lightning invoice for a specific payment hash |
113-
| `bolt11_claim_for_hash` | Manually claim a BOLT11 payment for a specific payment hash |
114-
| `bolt11_fail_for_hash` | Manually fail a BOLT11 payment for a specific payment hash |
115-
| `bolt11_receive_via_jit_channel` | Create a BOLT11 Lightning invoice to receive via an LSPS2 JIT channel |
116-
| `bolt11_receive_variable_amount_via_jit_channel` | Create a variable-amount BOLT11 Lightning invoice to receive via an LSPS2 JIT channel |
117-
| `bolt11_send` | Pay a BOLT11 Lightning invoice |
118-
| `bolt12_receive` | Create a BOLT12 offer for receiving Lightning payments |
119-
| `bolt12_send` | Pay a BOLT12 Lightning offer |
120-
| `spontaneous_send` | Send a spontaneous (keysend) payment to a Lightning node |
121-
| `unified_send` | Send a payment given a BIP 21 URI or BIP 353 Human-Readable Name |
122-
123-
### Channels
124-
| Tool | Description |
125-
|------|-------------|
126-
| `open_channel` | Open a new Lightning channel with a remote node |
127-
| `close_channel` | Cooperatively close a Lightning channel |
128-
| `force_close_channel` | Force close a Lightning channel unilaterally |
129-
| `list_channels` | List all known Lightning channels |
130-
| `update_channel_config` | Update forwarding fees and CLTV delta for a channel |
131-
| `splice_in` | Increase a channel's balance by splicing in on-chain funds |
132-
| `splice_out` | Decrease a channel's balance by splicing out to on-chain |
133-
134-
### Payment History
135-
| Tool | Description |
136-
|------|-------------|
137-
| `list_payments` | List all payments (supports pagination via page_token) |
138-
| `get_payment_details` | Get details of a specific payment by its ID |
139-
| `list_forwarded_payments` | List all forwarded payments (supports pagination via page_token) |
140-
141-
### Peers
142-
| Tool | Description |
143-
|------|-------------|
144-
| `connect_peer` | Connect to a Lightning peer without opening a channel |
145-
| `disconnect_peer` | Disconnect from a Lightning peer |
146-
| `list_peers` | List all known Lightning peers |
147-
148-
### Utilities
149-
| Tool | Description |
150-
|------|-------------|
151-
| `decode_invoice` | Decode a BOLT11 invoice and return its parsed fields |
152-
| `decode_offer` | Decode a BOLT12 offer and return its parsed fields |
153-
| `sign_message` | Sign a message with the node's secret key |
154-
| `verify_signature` | Verify a signature against a message and public key |
155-
| `export_pathfinding_scores` | Export the pathfinding scores used by the Lightning router |
156-
15796
## MCP Protocol
15897

15998
- **Protocol version**: `2025-11-25`

0 commit comments

Comments
 (0)