LogoFindMcp
Logo of nostr-mcp

nostr-mcp

Nostr MCP server enables AI models to interact with Nostr, post notes, and engage with the decentralized social network.

Introduction

Nostr MCP Server

A Model Context Protocol (MCP) server that enables AI models to interact with the Nostr network, allowing them to post notes and engage with the freedom of speech protocol. Censorship resistance matters, even for LLMs.

šŸš€ Features
  • šŸ“ Post notes to the Nostr network
  • šŸ”Œ Connect to multiple relays
  • šŸ¤– MCP-compliant API for AI integration
  • šŸ’ø Send Lightning zaps to Nostr users (WIP)
  • šŸ“” Server-Sent Events (SSE) support for real-time communication
šŸ› ļø Installation
Installing via Smithery

To install Nostr MCP Server for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @AbdelStark/nostr-mcp --client claude
Manual Installation
  1. Clone the repository:

    git clone https://github.com/AbdelStark/nostr-mcp
    cd nostr-mcp
  2. Install dependencies:

    npm install
  3. Create a .env file:

    šŸ’” You can copy the .env.example file and modify it as needed.

    # Log level (debug, info, warn, error)
    LOG_LEVEL=debug
    # Node environment (development, production)
    NODE_ENV=development
    # List of Nostr relays to connect to
    NOSTR_RELAYS=wss://relay.damus.io,wss://relay.primal.net,wss://nos.lol
    # Your Nostr private key (starts with nsec)
    NOSTR_NSEC_KEY=your_nsec_key_here
    # Server mode (stdio or sse)
    SERVER_MODE=sse
    # Port for SSE mode
    PORT=9000
🚦 Usage
Starting the Server
# Development mode with hot reload
npm run dev
 
# Production mode
npm start
Available Tools

post_note

Posts a new note to the Nostr network.

Example input:

{
  "content": "Hello from Nostr! šŸ‘‹"
}

send_zap

Sends a Lightning zap to a Nostr user.

Example input:

{
  "nip05Address": "user@domain.com",
  "amount": 1000
}
šŸ”§ Development
Project Structure
nostr-mcp/
ā”œā”€ā”€ src/
│   ā”œā”€ā”€ index.ts        # Main server entry point
│   ā”œā”€ā”€ nostr-client.ts # Nostr client implementation
│   └── types.ts        # TypeScript type definitions
ā”œā”€ā”€ .env               # Environment configuration
└── tsconfig.json     # TypeScript configuration
Running Tests
npm test
šŸ¤ Contributing
  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Newsletter

Join the Community

Subscribe to our newsletter for the latest news and updates