UiPath Documentation
uipath-cli
latest
false
Wichtig :
Dieser Inhalt wurde maschinell übersetzt. Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.

UiPath-CLI-Benutzerhandbuch

UIP-MCP

uip mcp macht die CLI als Modellkontextprotokollserver verfügbar, sodass MCP-fähige Clients (Claude Desktop, Cursor, VS Code MCP-Hosts usw.) einen beliebigen uip -Unterbefehl als Tool aufrufen können.

Hinweis:

Fähigkeiten sind der Hauptpfad, um KI-Codierungsagenten die Verwendung der UiPath CLI beizubringen – siehe uip skills und Fähigkeiten. MCP wird als Alternative für Clients bereitgestellt, die keine Fähigkeiten unterstützen oder einen MCP-Stil-Aufruf für Tools bevorzugen. Wenn Ihr Agent Fähigkeiten unterstützt, bevorzugen Sie Fähigkeiten.

Zusammenfassung

uip mcp serve
uip mcp serve

uip mcp serve berücksichtigt die globalen Optionen (--output, --output-filter, --log-level, --log-file) für den Serverprozess selbst; Das Tool, das es den Clients zur Verfügung stellt, akzeptiert jede CLI-Befehlszeichenfolge und gibt das kombinierte Element „stdout/stderr“ zurück. Austrittscodes folgen dem Standardvertrag.

UIP-MCP-Server

Startet den MCP-Server auf Studio (JSON-RPC durch Newline-Delimited). Es gibt keinen Netzwerk-Listener, keinen HTTP-Transport und keine Portkonfiguration – Studio ist der einzige unterstützte Transport in 1.x.

Argumente

Keine.

Optionen

None. The server runs until the stdio transport is closed by the client (usually when the host application quits).

Verhalten

  • Der Server gibt ein einzelnes Tool an, run_command, das ein Argument verwendet:
    • command (string) – Der auszuführende CLI-Befehl ohne das Präfix uip . Beispiel: "login status --output json".
  • Der Server listet jeden installierten uip -Unterbefehl beim Start auf und enthält einen gerenderten Befehlskatalog in der Beschreibung des MCP-Tools. Die Unterbefehle mcp und help werden von diesem Katalog ausgeschlossen – der Client kann den Server nicht auffordern, einen anderen MCP-Server zu starten.
  • Bei jedem run_command -Aufruf führt die CLI den angeforderten Befehl in einem untergeordneten Aufruf aus und gibt den kombinierten Standardwert „stdout/stderr“ zurück. Wenn das untergeordnete Element einen Wert ungleich Null beendet oder wenn es einen Fehlerumschlag mit einem Null-Exitcode in standardisierter Reihenfolge geschrieben hat (ein seltener Fall, in dem ein Befehl einen Fehler meldet, ohne den Exitcode zu ändern), wird das Ergebnis als isError: true gekennzeichnet und es wird ein Error (exit code N): vorangestellt .

Beispiel (Starten des Servers über eine Shell – normalerweise startet Ihr MCP-Client dies für Sie):

uip mcp serve
uip mcp serve

Konfigurieren eines MCP-Clients

Alle Konfigurationen verwenden denselben Befehl/jede Argumente. Der Servername (uipath unten) ist beliebig.

Claude Desktop – Bearbeiten Sie claude_desktop_config.json:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "uipath": {
      "command": "uip",
      "args": ["mcp", "serve"]
    }
  }
}
{
  "mcpServers": {
    "uipath": {
      "command": "uip",
      "args": ["mcp", "serve"]
    }
  }
}

Starten Sie Claude Desktop nach dem Speichern neu.

Claude Code – über die CLI hinzufügen:

claude mcp add uipath -- uip mcp serve
claude mcp add uipath -- uip mcp serve

Cursor – Bearbeiten Sie .cursor/mcp.json (projekt-lokal) oder die globale MCP-Konfiguration des Cursors:

{
  "mcpServers": {
    "uipath": {
      "command": "uip",
      "args": ["mcp", "serve"]
    }
  }
}
{
  "mcpServers": {
    "uipath": {
      "command": "uip",
      "args": ["mcp", "serve"]
    }
  }
}

VS-Code.vscode/mcp.json bearbeiten:

{
  "servers": {
    "uipath": {
      "command": "uip",
      "args": ["mcp", "serve"]
    }
  }
}
{
  "servers": {
    "uipath": {
      "command": "uip",
      "args": ["mcp", "serve"]
    }
  }
}

Lebenszyklus

Der MCP-Server hat keinen eigenständigen Stoppbefehl. Er ist ein untergeordneter Prozess des MCP-Clients und wird beendet, wenn:

  • Der Client schließt die Studio-Verbindung,
  • Die Hostanwendung wird beendet oder
  • entfernen Sie den Servereintrag aus der Konfiguration des Clients und laden Sie neu.

Authentifizierung und Mandantenkontext

uip mcp serve verwaltet keine Anmeldeinformationen. Jeder run_command -Aufruf liest dieselbe gespeicherte Sitzung wie eine interaktive Shell – Sie müssen also uip login separat ausgeführt haben, bevor Sie den Agent auffordern, Befehle aufzurufen, die eine Authentifizierung erfordern. Wenn keine Sitzung vorhanden ist, enthält das Toolergebnis die übliche AuthenticationError -Nutzlast (siehe Austrittscodes).

Datenform

Toolergebnisse folgen dem MCP-Tool-Aufrufvertrag. Bei Erfolg:

{
  "content": [
    { "type": "text", "text": "<combined stdout/stderr>" }
  ],
  "isError": false
}
{
  "content": [
    { "type": "text", "text": "<combined stdout/stderr>" }
  ],
  "isError": false
}

Bei einem Fehler wird isError zu true und text wird mit dem Präfix Error (exit code N): vorangestellt. Der innere Text ist die normale CLI-Ausgabe (JSON, wenn der Aufrufer --output json angefordert hat, andernfalls das Standardformat).

Überlegungen

  • Fordern Sie immer JSON innerhalb von MCP-Aufrufen an. Übergeben Sie --output json in der command -Zeichenfolge, damit der Agent strukturierte Daten anstelle von Tabellen erhält.
  • Keine Filterung destruktive Befehle. Das run_command -Tool kann jeden uip -Unterbefehl aufrufen, einschließlich logout, tools uninstall und Tools, die den Orchestrator-Status ändern. Behandeln Sie den MCP-Server als authentifizierte Shell und Scopes des Agents entsprechend.
  • help und mcp sind im Katalog ausgeblendet , können aber dennoch vom Client aufgerufen werden. Nichts verhindert, dass mcp serve rekursiv durch ein anderes run_command aufgerufen wird; Dies ist in der Praxis ein No-OP, da der äußere Server Studio steuert.
  • uip skills – Der primäre KI-Integrationspfad.
  • Fähigkeiten – warum Fähigkeiten für die Erneuerung von Agents dem unformatierten MCP-Zugriff vorzuziehen sind.
  • Authentifizierung – Die Sitzung run_command erbt diese.
  • Globale Optionen--output json innerhalb von MCP-Aufrufen.

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support

Möchten Sie lernen? UiPath Academy

Haben Sie Fragen? UiPath-Forum

Auf dem neuesten Stand bleiben