Nostr MCP Server

🚀 Nostr Anonymous Posting Server Implementation Guide

This project provides a server for anonymous posting on the Nostr network, offering a range of features to enhance the user experience and ensure data reliability.

🚀 Quick Start

Installation

1. Clone the code repository from the following link:

   git clone https://github.com/your-username/nostr-server.git
   

2. Install the dependencies:

   cd nostr-server
   npm install
   

3. Compile the code:

   npm run build
   

4. Start the server:

   node dist/index.js
   

✨ Features

• Native support for npub format: Encoding and decoding are implemented through the NIP - 19 protocol.
• NIP - 57 compatible zap receipt detection: With direction awareness (sent/received/self).
• Advanced bolt11 invoice parsing: Capable of extracting the amount.
• Intelligent caching system: Optimizes performance for large amounts of zap data.
• Total amount calculation: Provides net balance calculation for sent/received/self zaps.
• Optional NIP - 57 verification: Ensures the integrity of zap receipts.
• Anonymous zap support: Generates lightning invoices for payment.
• Support for multiple target types: Includes profiles, events (note ID), and alternative events (naddr).
• New connection on tool invocation: Each tool call creates a new relay connection to ensure data reliability.

⚠️ Limitations

• Query timeout: The default query timeout is set to 8 seconds.
• PublicKey format: Only public keys in hex or npub format are supported.
• Relay servers: By default, only a subset of relay servers are used.

📚 Documentation

Development Guide

To modify or extend the server:

1. Edit the relevant files in the project root directory:

   • index.ts: Mainly contains server settings and tool registration.
   • zap - tools.ts: Implements zap - related functions (getting sent zaps, received zaps, and all zaps).
   • nips - tools.ts: Implements NIP search functionality.

2. Compile the code:

   npm run build
   

3. Restart the Claude desktop version or Cursor to apply the changes.

Code Structure

• The core server settings and related tools are located in index.ts.
• Zap - related functions are concentrated in zap - tools.ts.
• The NIP search implementation is in nips - tools.ts.

This modular design makes the codebase more maintainable and facilitates the addition of new features.