Skip to content

A Nostr MCP server that allows to interact with Nostr, enabling posting notes, and more.

License

Notifications You must be signed in to change notification settings

AbdelStark/nostr-mcp

Repository files navigation

🌐 Nostr MCP Server

A Model Context Protocol (MCP) server that enables AI models to interact with Nostr, allowing them to post notes and interact with the freedom of speech protocol.

Censorship resistance matters, even for LLMs.

smithery badge TypeScript MCP Nostr

BTW, you should join Nostr now!

🚀 Features

  • 📝 Post notes to 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

👷‍♂️ TODOs

  • Add support for multiple simultaneous connections
  • Implement stdin transport mode (configurable via environment variable)

📋 Prerequisites

  • Node.js 18+

🛠️ 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
  1. Install dependencies:
npm install
  1. 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

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

🔗 Resources

📬 Contact

Feel free to follow me if you'd like, using my public key:

npub1hr6v96g0phtxwys4x0tm3khawuuykz6s28uzwtj5j0zc7lunu99snw2e29

Or just scan this QR code to find me:

Nostr Public Key QR Code


Made with ❤️ for the Nostr community

About

A Nostr MCP server that allows to interact with Nostr, enabling posting notes, and more.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published