🌐 Nostr Mcp Server
Ein Nostr MCP-Server, der die Interaktion mit Nostr ermöglicht, das Posten von Notizen und mehr.
Übersicht
Was ist Nostr MCP?
Nostr MCP ist ein Server, der entwickelt wurde, um Interaktionen mit dem Nostr-Protokoll zu erleichtern. Er ermöglicht es Benutzern, Notizen zu posten, ihre Inhalte zu verwalten und effektiv mit dem Nostr-Ökosystem zu interagieren. Dieser Server fungiert als Brücke und ermöglicht nahtlose Kommunikation und Datenaustausch innerhalb des Nostr-Rahmens, was ihn zu einem unverzichtbaren Werkzeug für Entwickler und Benutzer macht, die an dezentraler Kommunikation interessiert sind.
Funktionen von Nostr MCP
- Benutzerfreundliche Oberfläche: Nostr MCP bietet eine intuitive Oberfläche, die den Prozess des Postens von Notizen und der Verwaltung von Interaktionen vereinfacht.
- Dezentrale Kommunikation: Basierend auf den Prinzipien der Dezentralisierung stellt es sicher, dass Benutzer die Kontrolle über ihre Daten und Interaktionen haben.
- Echtzeit-Updates: Der Server unterstützt Echtzeit-Updates, sodass Benutzer sofortige Benachrichtigungen über ihre Beiträge und Interaktionen erhalten können.
- Open Source: Nostr MCP ist Open Source, was bedeutet, dass jeder zur Entwicklung beitragen kann, um kontinuierliche Verbesserungen und Innovationen zu gewährleisten.
- Unterstützung mehrerer Plattformen: Es ist so konzipiert, dass es auf verschiedenen Plattformen funktioniert, was es einem breiteren Publikum zugänglich macht.
So verwenden Sie Nostr MCP
- Installation: Beginnen Sie damit, das Nostr MCP-Repository von GitHub zu klonen. Befolgen Sie die Installationsanweisungen, die in der README-Datei des Repositories bereitgestellt werden.
- Konfiguration: Konfigurieren Sie die Servereinstellungen gemäß Ihren Anforderungen. Dazu kann die Einrichtung von Benutzerkonten, Berechtigungen und anderen Präferenzen gehören.
- Notizen posten: Nach der Einrichtung können Benutzer direkt über die Oberfläche Notizen posten. Der Prozess ist unkompliziert und benutzerfreundlich.
- Interaktion mit der Community: Nutzen Sie den Server, um mit anderen Benutzern zu interagieren, Einblicke zu teilen und an Diskussionen über Nostr teilzunehmen.
- Beitragen: Als Open-Source-Projekt sind Beiträge willkommen. Benutzer können Probleme melden, Funktionen vorschlagen oder sogar Code beitragen, um die Funktionalität des Servers zu verbessern.
Häufig gestellte Fragen
F: Was ist der Zweck von Nostr MCP?
A: Nostr MCP dient als Server für die Interaktion mit dem Nostr-Protokoll und ermöglicht es Benutzern, Notizen zu posten und an dezentraler Kommunikation teilzunehmen.
F: Ist Nostr MCP kostenlos zu nutzen?
A: Ja, Nostr MCP ist ein Open-Source-Projekt, das kostenlos genutzt und modifiziert werden kann.
F: Wie kann ich zu Nostr MCP beitragen?
A: Sie können beitragen, indem Sie Probleme melden, Funktionen vorschlagen oder Codeverbesserungen über das GitHub-Repository einreichen.
F: Welche Plattformen unterstützt Nostr MCP?
A: Nostr MCP ist so konzipiert, dass es mit mehreren Plattformen kompatibel ist, um eine breite Benutzerbasis zu gewährleisten.
F: Wo finde ich die Dokumentation für Nostr MCP?
A: Die Dokumentation ist normalerweise in der README-Datei des Repositories oder im speziellen Dokumentationsbereich auf der GitHub-Seite des Projekts zu finden.
Detail
🌐 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
- Join Nostr
- Nostr Manifesto
- Nostr Specifications
- Model Context Protocol
- Visual testing tool for MCP servers
- Awesome MCP Servers
- Awesome MCP Clients
- MCP TypeScript SDK
- Nostr Development Kit (NDK)
📬 Contact
Feel free to follow me if you'd like, using my public key:
npub1hr6v96g0phtxwys4x0tm3khawuuykz6s28uzwtj5j0zc7lunu99snw2e29
Or just scan this QR code to find me:
Serverkonfiguration
{
"mcpServers": {
"nostr-mcp": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"ghcr.io/metorial/mcp-container--abdelstark--nostr-mcp--nostr-mcp",
"npm run start"
],
"env": {
"LOG_LEVEL": "log-level",
"NODE_ENV": "node-env",
"NOSTR_RELAYS": "nostr-relays",
"NOSTR_NSEC_KEY": "nostr-nsec-key"
}
}
}
}