User Manual

awaberry MCP Server-Client

Verbinden Sie einen MCP-Client mit dem awaBerry MCP-Server – Konfigurationshandbuch für KI-Agenten und Entwicklungswerkzeuge, die das Model Context Protocol...

awaberry MCP Server client

Zusammenfassung

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 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 Interaktion mit Remote-Geräten über natürliche Sprache oder direkte Tool-Aufrufe.

Beschreibung

Anmeldeinformationen abrufen.

Der Zugriff auf die awaBerry-Plattform über einen MCP-Server erfolgt über den Projektschlüssel und das Projektgeheimnis. Richten Sie entweder eigene Projekte für Ihre Geräte ein oder erhalten Sie die Anmeldeinformationen.

Eigenes Projekt erstellen

Ein Konto unter app.awaberry.com und ein mit awaBerry Remote verbundenes Gerät.

  1. Registrieren Sie sich unter awaberry Remote.
  2. Fügen Sie ein oder mehrere Geräte hinzu.
  3. Erstellen Sie ein neues Projekt im Abschnitt awaBerry Agentic.
  4. Registrieren Sie Ihre Geräte beim Projekt.
  5. Kopieren Sie Ihren Projektschlüssel und Ihr Geheimnis aus den Projekteinstellungen.

Lesen Sie mehr über awaBerry unter www.awaberry.com

Empfangene Projektanmeldeinformationen

Sie haben einen Projektschlüssel und ein Projektgeheimnis erhalten, z. B. über die IT Ihres Unternehmens oder einen Freund.

Demo-Zugang

  • Projekt Schlüssel: demokey
  • Projekt Geheimnis: demosecret
  • Name des Geräts: demodevice

Funktionen

Werkzeuge

Der awaBerry mcp besteht aus den folgenden Werkzeugen:

connect_to_device

Stellt eine Verbindung zu einem Remote-Gerät (Mac, Linux, Windows oder Docker) her, das in Ihrem awaBerry-Projekt registriert ist.

  • Parameter:
    • projectKey (optional): Authentifizierungsschlüssel des Projekts (standardmäßig AWABERRY_PROJECT_KEY Umgebungsvariable).
    • projectSecret (optional): Authentifizierungsgeheimnis des Projekts (standardmäßig AWABERRY_PROJECT_SECRET Umgebungsvariable).
    • deviceName (erforderlich): Name des Geräts, zu dem eine Verbindung hergestellt werden soll.
  • Rückgabewerte:
    • sessionToken (string): Authentifizierungstoken für die Sitzung.
    • status (string): Verbindungsstatus ("connected" oder "notconnected").
    • deviceuuid (string): Eindeutiger Identifikator für das Gerät.

Das sessionToken ist ab Verbindungsbeginn 30 Minuten gültig.

execute_terminal_command

Führt Terminalbefehle auf einem verbundenen Gerät aus, um Dateien zu verwalten, Datenbanken zu verbinden und Terminalbefehle in einer persistenten, lang laufenden Terminalsitzung auszuführen.

Beim erneuten Verbinden mit dem Gerät ist der letzte Zustand des Terminals verfügbar – dies ermöglicht auch den Start von lang laufenden Befehlen und den Erhalt der Ergebnisse, sobald diese verfügbar sind.

  • Parameter:
    • sessionToken (erforderlich): Sitzungstoken von der Geräteeinwahl.
    • deviceuuid (erforderlich): Geräte-UUID, auf der der Befehl ausgeführt werden soll.
    • command (erforderlich): Terminalbefehl, der ausgeführt werden soll.
  • Rückgabewerte:
    • success (boolean): Gibt an, ob der Befehl zur Ausführung akzeptiert wurde.
    • result.commandResult (string): Ausgabe des Befehls.
    • result.lastCommandEndedOnTerminal (boolean): Gibt an, ob der Befehlsprozess abgeschlossen ist.

Installation

Voraussetzungen

Download

Öffnen Sie ein Terminal und erstellen Sie optional einen Ordner für den awaBerry mcp Server


# optional
cd $HOME
mkdir awaberry
cd awaberry 

# Klonen Sie das Repository
git clone https://github.com/awaberry/mcp_server_awaberry.git
cd mcp_server_awaberry

# Abhängigkeiten installieren
npm install

PWD
# gibt den absoluten Pfad zu mcp_server_awaberry aus, der für die spätere Konfiguration benötigt wird

Einrichtung eines awaBerry MCP Servers in Unternehmensumgebungen

Bitte lesen Sie die Datei MCPSERVER.md für die Einrichtungsanweisungen eines awaBerry MCP Servers in lokalen Umgebungen oder als Cloudflare Worker.

Einrichtung in Claude Desktop

Um awaBerry mit Claude Desktop zu verwenden, fügen Sie die Serverkonfiguration zu Ihrer Datei claude_desktop_config.json hinzu.

  • Unter macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Unter Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "awaberry": {
      "command": "node",
      "args": [
        "/absolute/path/to/mcp_server_awaberry/mcp_server_awaberry/mcpclients/start-awaberry-mcp.js"
      ]
      
    }
  }
}

Wichtig: Ersetzen Sie /absolute/path/to/mcp_server_awaberry durch den tatsächlichen absoluten Pfad zu Ihrer Installation (z. B. /Users/username/projects/mcp_server_awaberry).

Konfiguration des MCP Servers und der Anmeldeinformationen

Fügen Sie dem awaBerry MCP Server die folgenden Konfigurationen hinzu

Um die Server-URL, den Projektschlüssel und das Projektgeheimnis einzurichten, kopieren Sie die Datei awaberry-config.json.example nach awaberry-config.json.

Geben Sie in einem Terminal ein


  cd /absolute/path/to/mcp_server_awaberry/mcp_server_awaberry/mcpclients
  cp awaberry-config.json.example awaberry-config.json

Bearbeiten Sie die Datei awaberry-config.json.


{
  "serverUrl": "",
  "env": {
    "AWABERRY_PROJECT_KEY": "",
    "AWABERRY_PROJECT_SECRET": ""
  }
}

Wichtig: Ersetzen Sie - serverUrl: durch den Server, den Ihr IT-Team für Sie installiert hat, oder Ihren lokalen MCP-Server. Starten Sie Ihren lokalen MCP-Server wie folgt:

Für die Verbindung über einen lokalen MCP-Server verwenden Sie http://localhost:3000/mcp. Um den MCP-Server zu starten, geben Sie in einem Terminal ein


  cd /absolute/path/to/mcp_server_awaberry/mcp_server_awaberry/
   npm run start:mcp:json

Um das MCP-Server-Log zu überwachen, öffnen Sie ein weiteres Terminal und geben Sie ein


  cd /absolute/path/to/mcp_server_awaberry/mcp_server_awaberry/
  tail -f activitylog.log
  • AWABERRY_PROJECT_KEY: der empfangene Projektschlüssel für ein awaBerry Agentic Projekt
  • AWABERRY_PROJECT_SECRET: das empfangene Projektgeheimnis.

Anwendungsbeispiele

Nach der Konfiguration starten Sie Claude Desktop neu und interagieren Sie mit Ihren Geräten über natürliche Sprache:

  • Verbindung zu einem Gerät herstellen:

    Verbinde mich mit meinem Gerät "laptop-macos"

  • Dateien auflisten:

    Zeige mir alle Dateien in meinem Home-Verzeichnis

  • Eine Datei lesen:

    Lese den Inhalt der Datei

  • Komplexe Befehle ausführen:

    Finde alle Textdateien, die in den letzten 7 Tagen in meinem Home-Verzeichnis geändert wurden

  • Skripte ausführen:

    Führe das Backup-Skript unter ~/scripts/backup.sh aus

Protokollierung

Alle Aktivitäten werden in activitylog.log im Stammverzeichnis des Projekts protokolliert. Die Protokolle umfassen:

  • Tool-Aufrufe mit Zeitstempeln
  • Verbindungsversuche und Ergebnisse
  • Befehlsausführungen und Ausgaben
  • Fehler und Warnungen

Beispiel für Protokollausgabe:


2025-01-15 10:30:45 [INFO]: 📥 [Tool] connect_to_device aufgerufen
2025-01-15 10:30:45 [INFO]: 📋 [Tool] Gerätename: laptop-macos
2025-01-15 10:30:46 [INFO]: ✅ [Tool] connect_to_device erfolgreich - Sitzung: a1b2c3d4...

Ratenbegrenzungen

Ratenbegrenzungen werden von der awaberry-Plattform durchgesetzt:

  • Verbindungsversuche: Nach Bedarf.
  • Befehlsausführungen: Basierend auf der Planstufe von awaBerry.

Überprüfen Sie Ihre Pläne unter awaberry Agentic für spezifische Limits.

Fehlerbehebung

Server startet nicht

  • Stellen Sie sicher, dass Node.js >= 18 installiert ist: node --version
  • Überprüfen Sie, ob alle Abhängigkeiten installiert sind: npm install
  • Stellen Sie sicher, dass der Dateipfad in claude_desktop_config.json absolut und korrekt ist.
  • Prüfen Sie auf Syntaxfehler in der Konfigurations-JSON-Datei.

Verbindung schlägt fehl

  • Erlauben Sie Claude Desktop, Anfragen an awaBerry auszuführen, falls es um Berechtigungen bittet.
  • Überprüfen Sie, ob Ihr Projektschlüssel und Ihr Projektgeheimnis in den Umgebungsvariablen korrekt sind.
  • Stellen Sie sicher, dass der Gerätename exakt übereinstimmt (Groß-/Kleinschreibung wird beachtet).
  • Stellen Sie sicher, dass das Gerät online und mit awaberry verbunden ist.
  • Überprüfen Sie activitylog.log auf detaillierte Fehlermeldungen.
  • Bestätigen Sie, dass das Gerät in Ihrem awaBerry-Projekt registriert ist.

Befehle werden nicht ausgeführt

  • Prüfen Sie, ob das Gerät noch verbunden ist.
  • Stellen Sie sicher, dass die Befehlssyntax für das Zielbetriebssystem korrekt ist.
  • Überprüfen Sie die Befehlsausgabe in activitylog.log.
  • Prüfen Sie die Geräteberechtigungen für den Befehl, den Sie ausführen möchten.

Claude Desktop zeigt den MCP-Server nicht an

  • Starten Sie Claude Desktop nach der Änderung der Konfigurationsdatei neu.
  • Überprüfen Sie die JSON-Syntax in claude_desktop_config.json.
  • Stellen Sie sicher, dass der Dateipfad Schrägstriche (/) oder korrekt maskierte Backslashes (\) verwendet.
  • Suchen Sie nach Fehlern in den Protokollen von Claude Desktop.

Sicherheitsüberlegungen

  • Speichern Sie Ihren AWABERRY_PROJECT_KEY und AWABERRY_PROJECT_SECRET sicher.
  • Übergeben Sie niemals Anmeldeinformationen an die Versionskontrolle.
  • Verwenden Sie Umgebungsvariablen für sensible Konfigurationen.
  • Sitzungstoken sind temporär und laufen automatisch ab.
  • Die gesamte Kommunikation mit awaberry-Servern erfolgt über HTTPS.

Lizenz

MIT

Mitwirkung

Beiträge sind willkommen! Bitte reichen Sie einen Pull Request ein oder kontaktieren Sie uns.

Support

Für Dokumentation und Fragen: