Provides formatted SDK documentation for PubNub's JavaScript SDK, allowing developers to access reference materials for methods like subscribe() and publish() from within Cursor IDE.
Supports PubNub functionality through Node.js, allowing users to publish messages to channels, subscribe to channels, fetch message history, and retrieve presence information.
Offers access to PubNub's Python SDK documentation, enabling users to fetch docs for methods like publish() directly through Cursor IDE.
PubNub Model Context Protocol (MCP)-Server für Cursor IDE
Dieses Repository bietet einen CLI-basierten Model Context Protocol (MCP)-Server, der PubNub SDK-Dokumentation und PubNub API-Ressourcen für LLM-basierte Tools bereitstellt. Dies verbessert die Fähigkeit des LLM AI Agent, die SDKs und APIs von PubNub zu verstehen und mit ihnen zu interagieren.
Merkmale
- MCP-Server, der Tools für die Interaktion mit PubNub über JSON-RPC über STDIN/STDOUT bereitstellt.
- Rufen Sie die offizielle PubNub SDK-Dokumentation (HTML → Markdown) ab für:
- Sprachen: JavaScript, Python, Java, Go, Ruby, Swift, Objective-C, C#, PHP, Rust, Unity, Kotlin, Unreal.
- API-Referenzabschnitte: Konfiguration, Veröffentlichen und Abonnieren, Präsenz, Zugriffsmanager, Kanalgruppen, Speicherung und Wiedergabe, Mobile-Push, Objekte, Dateien, Nachrichtenaktionen, Sonstiges, Funktionen.
- Holen Sie sich konzeptionelle Leitfäden und Anleitungen zu PubNub aus lokalen Markdown-Dateien im
resources
(z. B.pubnub_concepts
,pubnub_features
,pubnub_security
,how_to_send_receive_json
,how_to_encrypt_messages_files
usw.). - Veröffentlichen Sie Nachrichten in PubNub-Kanälen mit
publish_pubnub_message
und geben Sie ein Zeittoken zurück. - Rufen Sie mit
get_pubnub_messages
historische Nachrichten aus einem oder mehreren Kanälen ab und geben Sie Nachrichteninhalte und Metadaten in JSON zurück. - Rufen Sie mit
get_pubnub_presence
Echtzeit-Präsenzinformationen (Belegungszahlen, Abonnenten-UUIDs) für Kanäle und Kanalgruppen ab. - Generieren Sie Schritt-für-Schritt-Anleitungen zum Erstellen einer PubNub-Anwendung, einschließlich Codeausschnitten zum Initialisieren des PubNub SDK in mehreren Sprachen mit
write_pubnub_app
. - Konfiguration von Umgebungsvariablen: unterstützt
PUBNUB_PUBLISH_KEY
undPUBNUB_SUBSCRIBE_KEY
zur Authentifizierung von SDK-Vorgängen. - Konvertiert Remote-HTML-Artikel mithilfe von
jsdom
undturndown
in Markdown für eine konsistente Dokumentationsformatierung. - Eingabevalidierung über Zod-Schemata für alle Werkzeugparameter, wodurch eine robuste Fehlerbehandlung gewährleistet wird.
- Erweiterbare Tooldefinitionen, die das Model Context Protocol SDK (
@modelcontextprotocol/sdk
) mitMcpServer
undStdioServerTransport
nutzen.
Beispiel-Eingabeaufforderungen
- „Schreiben Sie eine PubNub-App, mit der der Benutzer Streaming-Videos mit integriertem Mehrbenutzer-Chat mit PubNub ansehen kann.“
- „Schreiben Sie eine PubNub-App für die On-Demand-Lieferung von Lebensmitteln mit einer Karte.“
- „Schreiben Sie eine PubNub-App, die den Standort eines Pakets in Echtzeit verfolgt.“
- „Schreiben Sie eine PubNub-App, die die Wettervorhersage in Echtzeit anzeigt.“
- „Schreiben Sie eine PubNub-App, mit der Benutzer Multiplayer-Spiele mit Freunden spielen können.“
- „Schreiben Sie eine PubNub-App, die Live-Aktienkurse und Nachrichten-Updates anzeigt.“
- „Schreiben Sie eine PubNub-App, mit der Benutzer Wiedergabelisten erstellen und mit Freunden teilen können.“
- „Erstellen Sie eine PubNub-JavaScript-App, die den Kanal
my_channel
abonniert und Nachrichten in der Konsole protokolliert.“ - „Veröffentlichen Sie eine Nachricht im Kanal
my_channel
mit der NachrichtHello, PubNub!
“.“ - „Zeigen Sie mir die PubNub JavaScript SDK-Dokumentation für
subscribe()
.“ - „Listet alle verfügbaren PubNub-Funktionen auf.“
- „Holen Sie sich die Python SDK-Dokumente für die Methode
publish()
.“ - "Holen Sie den Nachrichtenverlauf für den
test
." - "Rufen Sie Anwesenheitsinformationen (Belegung und UUIDs) für den
test
und diedefault
ab."
Dies erfordert Node.js (>= 18) und npm ( https://nodejs.org/ ). npx
ruft automatisch den neuesten MCP-Server ab und führt ihn aus.
Voraussetzungen
- Node.js (>= 18) und npm
- Cursor-IDE mit MCP-Unterstützung
- (Optional) PubNub-Konto und API-Schlüssel für Live-Beispiele
Installation
Die bevorzugte Methode, den PubNub MCP-Server lokal auszuführen oder ihn über npx zur Cursor IDE hinzuzufügen:
Konfiguration
Der Cursor muss sich im AGENT-MODUS befinden, um MCP-Server verwenden zu können.
Cursor IDE erkennt MCP-Server über eine JSON-Konfigurationsdatei. Konfigurieren Sie den PubNub MCP-Server global oder pro Projekt.
Globale Konfiguration
Bearbeiten oder erstellen Sie ~/.cursor/mcp.json
:
Projektkonfiguration
Erstellen Sie in Ihrem Projektverzeichnis .cursor/mcp.json
:
Docker-basierte Konfiguration
Wenn Sie den MCP-Server lieber über Docker ausführen möchten, legen Sie Ihre PubNub-Schlüssel als Umgebungsvariablen fest:
Konfigurieren Sie dann Ihre ~/.cursor/mcp.json
(oder .cursor/mcp.json
in Ihrem Projekt):
command
gibt die ausführbare Datei zum Starten des MCP-Servers an.args
gibt die an den Befehl zu übergebenden Argumente an.env
legt Umgebungsvariablen für den Serverprozess fest.
Verwendung in der Cursor-IDE
- Starten Sie Cursor IDE neu oder öffnen Sie eine neue Sitzung.
- Öffnen Sie den MCP-Einstellungsbereich und überprüfen Sie, ob der Pubnub -Server unter „Verfügbare Tools und Ressourcen“ aufgeführt ist.
- Rufen Sie im Chat verfügbare Ressourcen auf:
pubnub://docs/javascript
– Fetch PubNub JavaScript SDK-Dokumentationpubnub://docs/python
– Fetch PubNub Python SDK-Dokumentationpubnub://docs/java
– Fetch PubNub Java SDK-Dokumentationpubnub://functions
– Liste der PubNub-Funktionen (statischer Inhalt ausresources/pubnub_functions.md
)
- Genehmigen Sie die Ressourcenausführung, wenn Sie dazu aufgefordert werden, oder aktivieren Sie die automatische Ausführung in den Einstellungen für vertrauenswürdige Ressourcen.
Claude Code
Und die Ausgabe wird sein:
Beispiel-Eingabeaufforderung
Entfernen Sie den MCP-Server mit:
Verwenden von Claude Desktop
Wenn Sie den Docker-basierten MCP-Server in Claude Desktop bevorzugen:
- Stellen Sie sicher, dass Ihre PubNub-Schlüssel in Ihre Shell exportiert werden:
- Fügen Sie im Abschnitt „Tools“ von Claude Desktop ein neues Tool namens „pubnub“ hinzu.
- Setzen Sie den Befehl auf
docker
. - Legen Sie die Argumente fest auf:
Hinweis: Auf manchen Rechnern (z. B. Apple Silicon) müssen Sie möglicherweise die Docker-Plattform angeben. Fügen Sie im Array „Argumente
"run"
--platform linux/arm64
(oder--platform linux/amd64
) ein. Beispiel:
- Speichern Sie die Konfiguration.
Claude Desktop ruft den PubNub MCP-Servercontainer über Docker auf.
Lizenz
Dieses Projekt ist unter der MIT-Lizenz lizenziert. Weitere Informationen finden Sie in der Datei LICENSE .
Fehlerbehebung
- Um MCP-Server verwenden zu können, muss der Agentenmodus aktiviert sein.
- Überprüfen Sie die Installation von Node.js und npm.
- Stellen Sie sicher, dass
index.js
über Ausführungsberechtigung verfügt. - Überprüfen Sie, ob die
command
,args
undenv
korrekt sind. - Überprüfen Sie die Cursor-IDE-Protokolle auf MCP-Startfehler.
Direkte JSON-RPC-Befehlszeilenverwendung
Sie können den MCP-Server direkt über STDIN/STDOUT mit JSON-RPC v2.0 aufrufen. Stellen Sie sicher, dass Ihre PubNub-Schlüssel in der Umgebung festgelegt sind, zum Beispiel:
Sobald der Server läuft (oder einen einmaligen Aufruf verwendet), senden Sie Anfragen, indem Sie JSON in node index.js
weiterleiten. Beispiele:
Schnelle JSON-RPC-Beispiele
Nachfolgend finden Sie vereinfachte JSON-RPC v2.0-Befehlszeilenbeispiele mit STDIN/STDOUT zum Abrufen der PubNub SDK-Dokumentation und Veröffentlichen von Nachrichten.
1) Holen Sie sich die PubNub JavaScript SDK-Dokumentation
2) Veröffentlichen Sie eine Nachricht in einem PubNub-Kanal
You must be authenticated.
remote-capable server
The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.
Tools
Ein CLI-basierter Model Context Protocol-Server, der PubNub SDK-Dokumentation und Funktionsressourcen für LLM-basierte Tools wie Cursor IDE verfügbar macht und es Benutzern ermöglicht, Dokumentation abzurufen und über Eingabeaufforderungen in natürlicher Sprache mit PubNub-Kanälen zu interagieren.
Related MCP Servers
- AsecurityAlicenseAqualityA template for creating and connecting custom tools to Cursor IDE using Model Context Protocol with support for cheerful server responses.Last updated -41PythonMIT License
- -securityFlicense-qualityA simple Model Context Protocol server that enables searching and retrieving relevant documentation snippets from Langchain, Llama Index, and OpenAI official documentation.Last updated -Python
- -securityFlicense-qualityA customized MCP server that enables integration between LLM applications and documentation sources, providing AI-assisted access to LangGraph and Model Context Protocol documentation.Last updated -Python
- AsecurityAlicenseAqualityA Model Context Protocol server that loads multiple OpenAPI specifications and exposes them to LLM-powered IDE integrations, enabling AI to understand and work with your APIs directly in development tools like Cursor.Last updated -72927TypeScriptMIT License