nostr-mcp

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

29 stars
5 forks
Available MCP Tools 0 tools

Model Context Protocol tools provided by this server

No tools information available for this server.

Check the GitHub repository or documentation for more details.

README

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
NODE_ENV=development
NOSTR_RELAYS=wss://relay.damus.io,wss://relay.primal.net,wss://nos.lol
NOSTR_NSEC_KEY=your_nsec_key_here
SERVER_MODE=sse
PORT=9000

🚦 Usage

Starting the Server

npm run dev

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

Details
Category Communication
Scope cloud
Language TypeScript
License MIT License
OS Support
linux macos windows