🌐 Serveur Nostr Mcp
Un serveur Nostr MCP qui permet d'interagir avec Nostr, permettant de publier des notes, et plus encore.
Aperçu
Qu'est-ce que Nostr MCP ?
Nostr MCP est un serveur conçu pour faciliter les interactions avec le protocole Nostr. Il permet aux utilisateurs de publier des notes, de gérer leur contenu et de s'engager efficacement avec l'écosystème Nostr. Ce serveur agit comme un pont, permettant une communication fluide et un échange de données au sein du cadre Nostr, ce qui en fait un outil essentiel pour les développeurs et les utilisateurs intéressés par la communication décentralisée.
Caractéristiques de Nostr MCP
- Interface conviviale : Nostr MCP offre une interface intuitive qui simplifie le processus de publication de notes et de gestion des interactions.
- Communication décentralisée : Basé sur les principes de décentralisation, il garantit que les utilisateurs ont le contrôle sur leurs données et interactions.
- Mises à jour en temps réel : Le serveur prend en charge les mises à jour en temps réel, permettant aux utilisateurs de recevoir des notifications instantanées concernant leurs publications et interactions.
- Open source : Nostr MCP est open-source, ce qui signifie que tout le monde peut contribuer à son développement, garantissant une amélioration et une innovation continues.
- Support multi-plateforme : Il est conçu pour fonctionner sur diverses plateformes, le rendant accessible à un public plus large.
Comment utiliser Nostr MCP
- Installation : Commencez par cloner le dépôt Nostr MCP depuis GitHub. Suivez les instructions d'installation fournies dans le fichier README du dépôt.
- Configuration : Configurez les paramètres du serveur selon vos besoins. Cela peut inclure la configuration des comptes utilisateurs, des autorisations et d'autres préférences.
- Publication de notes : Une fois configuré, les utilisateurs peuvent commencer à publier des notes directement via l'interface. Le processus est simple et convivial.
- Engagement avec la communauté : Utilisez le serveur pour interagir avec d'autres utilisateurs, partager des idées et participer à des discussions liées à Nostr.
- Contribution : En tant que projet open-source, les contributions sont les bienvenues. Les utilisateurs peuvent signaler des problèmes, suggérer des fonctionnalités ou même contribuer du code pour améliorer la fonctionnalité du serveur.
Questions Fréquemment Posées
Q : Quel est le but de Nostr MCP ?
R : Nostr MCP sert de serveur pour interagir avec le protocole Nostr, permettant aux utilisateurs de publier des notes et de s'engager dans une communication décentralisée.
Q : Nostr MCP est-il gratuit à utiliser ?
R : Oui, Nostr MCP est un projet open-source, ce qui le rend gratuit à utiliser et à modifier.
Q : Comment puis-je contribuer à Nostr MCP ?
R : Vous pouvez contribuer en signalant des problèmes, en suggérant des fonctionnalités ou en soumettant des améliorations de code via le dépôt GitHub.
Q : Quelles plateformes Nostr MCP prend-il en charge ?
R : Nostr MCP est conçu pour être compatible avec plusieurs plateformes, garantissant l'accessibilité à un large éventail d'utilisateurs.
Q : Où puis-je trouver la documentation pour Nostr MCP ?
R : La documentation peut généralement être trouvée dans le fichier README du dépôt ou dans la section de documentation dédiée sur la page GitHub du projet.
Détail
🌐 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:
Configuration du serveur
{
"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"
}
}
}
}