The AI-Native Device Platform
User Manual

awaBerry | MCP Server Dokumentation

awaBerry MCP Serverdokumentation — integrieren Sie die Fähigkeiten von awaBerry-Geräten mit dem Model Context Protocol in jeden MCP-kompatiblen KI-Agenten...

awaBerry MCP Server Dokumentation

Zusammenfassung

Der awaBerry MCP Server ist eine robuste Lösung für die sichere Fernverwaltung von Geräten, die es Entwicklern ermöglicht, sich mit verschiedenen Geräten (Mac, Linux, Windows, Docker) innerhalb eines awaBerry-Projekts zu verbinden und mit ihnen zu interagieren. Er unterstützt JSON-basierte Implementierungen für interne Netzwerke und Cloudflare Worker-Bereitstellungen für globale Reichweite. Der Server stellt über seine createMcpServer-Funktion wesentliche Werkzeuge wie connect_to_device, execute_terminal_command und Werkzeuge zur Interaktion mit PostgreSQL-Datenbanken bereit. Der mcpclient ermöglicht sicheren Terminalzugriff und Befehlsausführung, während Cloudflare Workers Firewall-umgehende Fernsteuerungsfunktionen über einen HTTP-Endpunkt bieten. Das gesamte System ist für Automatisierung und Integration in agentische Umgebungen konzipiert und wird durch umfassende Testverfahren unterstützt.

Cloudflare Worker Implementierung des MCP Servers

Der bereitgestellte Code implementiert einen MCP (Model Context Protocol) Server als Cloudflare Worker. Er ermöglicht die sichere Fernverwaltung von Geräten über awaBerry Remote, erlaubt Verbindungen zu Geräten, die Ausführung von Terminalbefehlen und Dateiübertragungen ohne direkte SSH/SCP- oder Firewall-Konfigurationen. Der Server stellt zwei Hauptwerkzeuge bereit: connect_to_device für die Einrichtung einer persistenten Terminalsitzung und execute_terminal_command für die Ausführung von Shell-Befehlen auf dem verbundenen Gerät. Er verwaltet API-Interaktionen mit agentic.awaberry.net für Projekt- und Gerätemanagement, Sitzungsinitiierung und Befehlsausführung, einschließlich Polling des Verbindungsstatus und robuster Fehlerbehandlung. Der Cloudflare Worker fungiert als HTTP-Endpunkt /mcp, verarbeitet eingehende MCP-Anfragen und leitet Antworten über eine benutzerdefinierte Transportschicht weiter.

awaberry MCP Server Client

Der awaBerry MCP Server Client ermöglicht den sicheren Zugriff und die Verwaltung von Remote-Geräten (Mac, Linux, Windows, Docker), die in einem awaBerry-Projekt registriert sind. Er ermöglicht es Entwicklern, sich mit Geräten zu verbinden, Terminalbefehle auszuführen und persistente Terminalsitzungen mithilfe von Projektschlüsseln, Geheimnissen und Sitzungstoken zu verwalten. Der Client integriert sich in Umgebungen wie Claude Desktop und bietet robuste Funktionen für Automatisierung und Remote-Geräteinteraktion durch natürliche Sprache oder direkte Tool-Aufrufe.

awaberry MCP Server Implementierungen

Dieses Handbuch beschreibt die Einrichtung und das Testen von awaBerry MCP Server Implementierungen. Es behandelt Voraussetzungen wie Node.js und Git und erklärt zwei primäre Servertypen: JSON-basiert für Unternehmensintranets/Clouds (mit Verweisen auf mcpserver/awaBerryAgenticMcpServerHttpJson.js und Cloudflare Worker-Bereitstellung über cloudflare/worker/awaberrymcpserver/README.md). Testverfahren umfassen Methodentests für Projektanmeldeinformationen (test/methodtest/README.md) und dedizierte MCP-Servertests für JSON- und Stdio-Modi unter Verwendung der Befehle npm run start:mcp:json/stdio und npm run test:mcp:json/stdio.

awaBerry Testleitfaden

Dieser Leitfaden bietet umfassende Verfahren für lokale Integrationstests von awaBerry-Komponenten, die HTTP-Serverfunktionalität, MCP-Client- und Serverinteraktionen sowie Kernagentenmethoden wie Geräteverbindung und Befehlsausführung abdecken. Tests beinhalten die Konfiguration von Umgebungsvariablen (`projectKey`, `projectSecret`, `deviceName`, `mcpServerUrl`), um sichere Verbindungen herzustellen und Remote-Befehle (z. B. 'date') auf konfigurierten Geräten auszuführen. Die Validierung stellt die ordnungsgemäße Sitzungsinitialisierung, Tool-Auflistung, Gerätekonnektivität und zuverlässige Befehlsausführung über verschiedene Transportmechanismen, einschließlich JSON/HTTP und Standard I/O, sicher.

Beschreibung

Der awaBerry MCP Server bietet ein umfassendes Framework für die Fernverwaltung von Geräten und Automatisierung. Er steht auf GitHub zum Download und zur Mitarbeit zur Verfügung: https://github.com/awaberry/mcp_server_awaberry.

MCP Client (mcpclient)

Der awaBerry MCP Server Client (mcpclient) bietet sicheren Zugriff und Verwaltung für Remote-Geräte (Mac, Linux, Windows, Docker), die in einem awaBerry-Projekt registriert sind. Er ermöglicht es Entwicklern, sich zu verbinden, Terminalbefehle auszuführen und persistente Terminalsitzungen mithilfe von Projektschlüsseln, Geheimnissen und Sitzungstoken zu verwalten. Seine Integration in Umgebungen wie Claude Desktop bietet robuste Funktionen für Automatisierung und Remote-Interaktion durch natürliche Sprache oder direkte Tool-Aufrufe.

MCP Server Implementierungen (mcpserver, mcpserver/awaberryagenticmcpserver, mcpserver/awaberryagenticmcpserverhttpjson)

Das Kernmodul awaBerryAgenticMcpServer.js exportiert eine createMcpServer-Funktion, die einen MCP-Server initialisiert, der persistente Verbindungen verwaltet und wichtige Werkzeuge bereitstellt. Zu diesen Werkzeugen gehören connect_to_device für sichere Terminalverbindungen, execute_terminal_command für die Ausführung von Shell-Befehlen, execute_database_command_postgres für die SQL-Ausführung und describe_database_schema_postgres für die Schemabeschaffung.
Die Dokumentation von mcpserver beschreibt die Einrichtung und das Testen von JSON-basierten Servern, die für Unternehmensintranets/Clouds geeignet sind und oft über mcpserver/awaBerryAgenticMcpServerHttpJson.js referenziert werden. Dieses HTTP/JSON-Modul richtet einen Express.js-Server mit einem POST-Endpunkt /mcp ein, der Streaming-Interaktionen über @modelcontextprotocol/sdk/server/streamableHttp.js verarbeitet und eine isolierte Sitzungsverwaltung gewährleistet.

Cloudflare Worker Bereitstellung (cloudflare)

Eine MCP Server Implementierung als Cloudflare Worker ermöglicht die sichere Fernverwaltung von Geräten über awaBerry Remote. Dieser Worker ermöglicht Verbindungen zu Geräten, die Ausführung von Terminalbefehlen und Dateiübertragungen ohne direkte SSH/SCP- oder komplexe Firewall-Konfigurationen. Er stellt die Werkzeuge connect_to_device und execute_terminal_command bereit und verwaltet API-Interaktionen mit agentic.awaberry.net für Projekt-, Geräte- und Sitzungsverwaltung und fungiert als HTTP-Endpunkt unter /mcp.

Testverfahren (test/httpservertest, test/mcpclients, test/mcpservertest, test/methodtest)

Das Projekt umfasst umfassende Tests. test/mcpservertest deckt eine gründliche Validierung sowohl der JSON/HTTP- als auch der Standard-I/O (Stdio)-Transportmechanismen ab und prüft Sitzungsinitialisierung, Tool-Auflistung, Geräteverbindung und Terminalbefehlsausführung. test/httpservertest beschreibt speziell das Testen der HTTP-Serverkomponente durch Starten eines lokalen Servers und Verwendung eines Client-Skripts zum Senden von execute-Befehlen. test/mcpclients beschreibt ein Testskript (testStartAwaberryMcp.js), das eine vollständige Testsequenz orchestriert, einschließlich Protokollsitzungsinitialisierung, Tool-Auflistung, sicherer Geräteverbindung und Remote-Befehlsausführung. Schließlich konzentriert sich test/methodtest auf die Ausführung lokaler Integrationstests für die Methoden connectToDevice und executeCommand unter Verwendung des awaBerry Connect-Agenten, der Voraussetzungen, Umgebungseinrichtung und detaillierte Anweisungen zum Testen der Konnektivität, Befehlsausführung und Verwaltung langlaufender Befehle abdeckt.

Navigate ← awaBerry For Developers Main Page