Nostr MCP Server

Created By

MCP-Mirror8 months ago

Mirror of

# nostr

# mcp-server

Overview Content Tools Comments

Content

Nostr MCP Server

A Model Context Protocol (MCP) server that provides Nostr capabilities to LLMs like Claude.

https://github.com/user-attachments/assets/1d2d47d0-c61b-44e2-85be-5985d2a81c64

Features

This server implements seven tools for interacting with the Nostr network:

getProfile: Fetches a user's profile information by public key
getKind1Notes: Fetches text notes (kind 1) authored by a user
getLongFormNotes: Fetches long-form content (kind 30023) authored by a user
getReceivedZaps: Fetches zaps received by a user, including detailed payment information
getSentZaps: Fetches zaps sent by a user, including detailed payment information
getAllZaps: Fetches both sent and received zaps for a user, clearly labeled with direction and totals
searchNips: Search through Nostr Implementation Possibilities (NIPs) with relevance scoring

All tools fully support both hex public keys and npub format, with user-friendly display of Nostr identifiers.

Installation

# Clone the repository
git clone https://github.com/austinkelsay/nostr-mcp-server.git
cd nostr-mcp-server

# Install dependencies
npm install

# Build the project
npm run build

Connecting to Claude for Desktop

Make sure you have Claude for Desktop installed and updated to the latest version.

Configure Claude for Desktop by editing or creating the configuration file:

For macOS:

vim ~/Library/Application\ Support/Claude/claude_desktop_config.json

For Windows:

notepad %AppData%\Claude\claude_desktop_config.json

Add the Nostr server to your configuration:

{
    "mcpServers": {
        "nostr": {
            "command": "node",
            "args": [
                "/ABSOLUTE/PATH/TO/nostr-mcp-server/build/index.js"
            ]
        }
    }
}

Be sure to replace /ABSOLUTE/PATH/TO/ with the actual path to your project.

Restart Claude for Desktop.

Connecting to Cursor

Make sure you have Cursor installed and updated to the latest version.
Configure Cursor by creating or editing the configuration file:

For macOS:
```
vim ~/.cursor/config.json
```
For Windows:
```
notepad %USERPROFILE%\.cursor\config.json
```

Add the Nostr server to your configuration:

{
    "mcpServers": {
        "nostr": {
            "command": "node",
            "args": [
                "/ABSOLUTE/PATH/TO/nostr-mcp-server/build/index.js"
            ]
        }
    }
}

Be sure to replace /ABSOLUTE/PATH/TO/ with the actual path to your project.

Restart Cursor.

Usage in Claude

Once configured, you can ask Claude to use the Nostr tools by making requests like:

"Show me the profile information for npub1qny3tkh0acurzla8x3zy4nhrjz5zd8ne6dvrjehx9n9hr3lnj08qwuzwc8"
"What are the recent posts from npub1qny3tkh0acurzla8x3zy4nhrjz5zd8ne6dvrjehx9n9hr3lnj08qwuzwc8?"
"Show me the long-form articles from npub1qny3tkh0acurzla8x3zy4nhrjz5zd8ne6dvrjehx9n9hr3lnj08qwuzwc8"
"How many zaps has npub1qny3tkh0acurzla8x3zy4nhrjz5zd8ne6dvrjehx9n9hr3lnj08qwuzwc8 received?"
"Show me the zaps sent by npub1qny3tkh0acurzla8x3zy4nhrjz5zd8ne6dvrjehx9n9hr3lnj08qwuzwc8"
"Show me all zaps (both sent and received) for npub1qny3tkh0acurzla8x3zy4nhrjz5zd8ne6dvrjehx9n9hr3lnj08qwuzwc8"
"Search for NIPs about zaps"
"What NIPs are related to long-form content?"
"Show me NIP-23 with full content"

The server automatically handles conversion between npub and hex formats, so you can use either format in your queries. Results are displayed with user-friendly npub identifiers.

Advanced Usage

You can specify custom relays for any query:

"Show me the profile for npub1qny3tkh0acurzla8x3zy4nhrjz5zd8ne6dvrjehx9n9hr3lnj08qwuzwc8 using relay wss://relay.damus.io"

You can also specify the number of notes or zaps to fetch:

"Show me the latest 20 notes from npub1qny3tkh0acurzla8x3zy4nhrjz5zd8ne6dvrjehx9n9hr3lnj08qwuzwc8"

For zap queries, you can enable extra validation and debugging:

"Show me all zaps for npub1qny3tkh0acurzla8x3zy4nhrjz5zd8ne6dvrjehx9n9hr3lnj08qwuzwc8 with validation and debug enabled"

For NIP searches, you can control the number of results and include full content:

"Search for NIPs about zaps with full content"
"Show me the top 5 NIPs about relays"
"What NIPs are related to encryption? Show me 15 results"

Limitations

The server has a default 8-second timeout for queries to prevent hanging
Only public keys in hex format or npub format are supported
Only a subset of relays is used by default

Implementation Details

Native support for npub format using NIP-19 encoding/decoding
NIP-57 compliant zap receipt detection with direction-awareness (sent/received/self)
Advanced bolt11 invoice parsing with payment amount extraction
Smart caching system for improved performance with large volumes of zaps
Total sats calculations for sent/received/self zaps with net balance
Optional NIP-57 validation for ensuring zap receipt integrity
Each tool call creates a fresh connection to the relays, ensuring reliable data retrieval

Troubleshooting

If queries time out, try increasing the QUERY_TIMEOUT value in the source code (currently 8 seconds)
If no data is found, try specifying different relays that might have the data
Check Claude's MCP logs for detailed error information

Default Relays

The server uses the following relays by default:

wss://relay.damus.io
wss://relay.nostr.band
wss://relay.primal.net
wss://nos.lol
wss://relay.current.fyi
wss://nostr.bitcoiner.social

Development

To modify or extend this server:

Edit the relevant file in the project root:
- index.ts: Main server and tool registration
- zap-tools.ts: Zap-related functionality (getSentZaps, getReceivedZaps, getAllZaps)
- nips-tools.ts: NIPs search functionality
Run npm run build to compile
Restart Claude for Desktop or Cursor to pick up your changes