nostr-mcp
Categories
Language:
TypeScript
Stars:
14
Forks:
3
π 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.
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
- Clone the repository:
git clone https://github.com/AbdelStark/nostr-mcp
cd nostr-mcp
- Install dependencies:
npm install
- 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
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature
) - Commit your changes (
git commit -m 'Add some amazing feature'
) - Push to the branch (
git push origin feature/amazing-feature
) - Open a Pull Request
π License
This project is licensed under the MIT License - see the LICENSE file for details.
π Resources
-
- [MCP TypeScript SDK](https://github.com/modelcontextprotocol/typescript-sdk)
π¬ Contact
Feel free to follow me if you'd like, using my public key:
npub1hr6v96g0phtxwys4x0tm3khawuuykz6s28uzwtj5j0zc7lunu99snw2e29
Or just scan this QR code to find me:
Made with β€οΈ for the Nostr community
Publisher info
AβΏdel β/21M
Building Starknet. Bitcoin minimalist. Freedom tech maxi. npub1hr6v96g0phtxwys4x0tm3khawuuykz6s28uzwtj5j0zc7lunu99snw2e29