DEPRECATED ⚠️

1# ⚠️ DEPRECATED ⚠️
2 
3**Please use [Alby MCP](https://github.com/getAlby/mcp/) instead!** 
4 
5This repository has been deprecated in favor of Alby MCP, which includes all the NWC tools along with additional Lightning tools.
6 
7# NWC MCP Server
8 
9Connect a bitcoin lightning wallet to your LLM using Nostr Wallet Connect ([NWC](https://nwc.dev/) or [NIP-47](https://github.com/nostr-protocol/nips/blob/master/47.md)).
10 
11This MCP server uses the [official MCP TypeScript SDK](https://github.com/modelcontextprotocol/typescript-sdk)
12 
13> See also the [Alby MCP server](https://github.com/getAlby/mcp) which includes additional useful tools.
14 
15## Quick Start
16 
17### Use the Alby-Hosted MCP Server
18 
19If your agent supports SSE (e.g. N8N) or HTTP Streamable transports, you can connect to Alby's MCP server.
20 
21- SSE: `https://mcp.getalby.com/sse`
22- HTTP Streamable: `https://mcp.getalby.com/mcp`
23 
24Both require providing an NWC connection secret as `Bearer` authentication.
25 
26### Add to Claude Desktop
27 
28Add this to your claude_desktop_config.json:
29 
30```json
31{
32  "mcpServers": {
33    "nwc": {
34      "command": "npx",
35      "args": ["-y", "@getalby/nwc-mcp-server"],
36      "env": {
37        "NWC_CONNECTION_STRING": "YOUR NWC CONNECTION STRING HERE"
38      }
39    }
40  }
41}
42```
43 
44### Add to Goose
45 
461. Type `goose configure`
472. Add extension -> Command Line Extension
483. Call it `nwc`
494. What command should be run: `npx -y @getalby/nwc-mcp-server`
505. Timeout: 30
516. Description: no
527. environment variables: yes
538. environment variable name: `NWC_CONNECTION_STRING`
549. environment variable value: `nostr+walletconnect://...` (your NWC connection secret here)
55 
56### Add to Cline
57 
58> Copy the below and paste it into a cline prompt. It should prompt you to update the connection string.
59 
60```json
61Add the following to my MCP servers list:
62 
63"nwc": {
64  "command": "npx",
65  "args": ["-y", "@getalby/nwc-mcp-server"],
66  "env": {
67    "NWC_CONNECTION_STRING": "nostr+walletconnect://..."
68  },
69  "disabled": false,
70  "autoApprove": []
71}
72```
73 
74### Add to N8N via SSE
75 
76You can use the native N8N MCP Client tool connected to an AI agent. Enter your SSE endpoint, set authentication to "Bearer" and paste your NWC connection secret.
77 
78Tested with OpenRouter + anthropic/claude-3.7-sonnet
79 
80See the [N8N workflow](examples/n8n-sse) for a simple example
81 
82### Add to N8N via STDIO (Community Node)
83 
84Currently this MCP server only works via command line (STDIO).
85 
86You can install the [n8n-nodes-mcp](https://github.com/nerding-io/n8n-nodes-mcp) community node and run n8n with tools enabled e.g.
87 
88```bash
89N8N_COMMUNITY_PACKAGES_ALLOW_TOOL_USAGE=true npx n8n
90```
91 
92Create a blank workflow and add an AI agent node. Configure your LLM model and add a new tool "MCP Client" (which will have a cube next to it showing it's a community node).
93 
94Configure the MCP Client by adding a credential with Command Line (STDIO) selected.
95 
96command: `npx`
97arguments: `-y @getalby/nwc-mcp-server`
98environments `NWC_CONNECTION_STRING=nostr+walletconnect://your_key_here` (create the whole line in a text editor and paste it in, since the password field cannot be switched to plaintext)
99 
100See the [N8N paid chat workflow](examples/n8n-paid-chat-stdio) for a full example
101 
102## Modes
103 
104### STDIO
105 
106By default NWC MCP Server runs locally in `STDIO` mode.
107 
108### HTTP
109 
110You can set the following environment variable: `MODE=HTTP` which will enable Streamable HTTP (`http://localhost:3000/mcp`) and SSE (`http://localhost:3000/sse` Note: SSE is deprecated).
111 
112HTTP requires bearer authorization, where the token is a wallet's NWC connection secret.
113 
114## From Source
115 
116### Prerequisites
117 
118- Node.js 20+
119- Yarn
120- A connection string from a lightning wallet that supports NWC
121 
122### Installation
123 
124```bash
125yarn install
126```
127 
128### Building
129 
130```bash
131yarn build
132```
133 
134### Add your NWC connection
135 
136Copy `.env.example` to `.env` and update your connection string
137 
138### Inspect the tools (use/test without an LLM)
139 
140`yarn inspect`
141 
142### Supported Tools
143 
144See the [tools directory](./src/tools)
145