UIP-Agent-Tool

uip agent tool verwaltet Toolressourcen für ein Agent-Projekt. Tools sind die Call-outs des Agents für das externe Verhalten: Integration Service-Connectors, Orchestrator-Prozesse, andere Agents, API-Workflows, Process Orchestration-Flows und IXP-Fähigkeiten. Jeder Eintrag in den Toolressourcen des Agents entspricht einer Aktion, die der Agent aufrufen kann.

Das Verb add schreibt lokal auf den Datenträger; discover und connect rufen die Integration Service (IS)-API auf und erfordern daher eine aktive CLI-Sitzung (uip login). list und remove sind rein lokal.

Zusammenfassung

uip agent tool add      <name> [--type <type>]
                               [--description <desc>]
                               [--connector <key>] [--connector-url <url>]
                               [--object-name <name>]
                               [--connection-id <id>]
                               [--method <method>]
                               [--process-name <name>] [--folder-path <path>]
                               [--path <dir>]
uip agent tool discover  --connector <key> [--connection-id <id>]
uip agent tool connect   <name> --connection-id <id> [--path <dir>]
uip agent tool list                                  [--path <dir>]
uip agent tool remove    <name>                      [--path <dir>]

Alle Unterbefehle berücksichtigen die globalen Optionen (--output, --output-filter, --log-level, --log-file). Austrittscodes folgen dem Standardvertrag.

Gültige Tooltypen sind: integration, process, agent, apiWorkflow, processOrchestration, ixp.

UIP-Agent-Tool hinzufügen

Fügen Sie dem Agent eine Toolressource hinzu.

Argumente

• <name> (erforderlich) – Name des Tools, auf den der Agent verweist.

Optionen

Markieren	Standard	Erforderlich	Zweck
--type <type>	integration wenn --connector vorhanden ist; andernfalls erforderlich	Bedingt	Tooltyp. Einer von integration, process, agent, apiWorkflow, processOrchestration, ixp.
--description <desc>	–		Freitextbeschreibung.
--connector <key>	–	ja für integration	Connector-Schlüssel (z. B. uipath-slack).
--connector-url <url>	–		Connector-Basis-URL (nur Integration Service-Tools).
--object-name <name>	–		Ressourcen-/Objektname vom IS-Connector (z. B. message). Wenn sie zusammen mit --connector festgelegt wird, wechselt add zum vollständigen IS-Metadatenpfad, der die Integration Service-API aufruft und userProfile/debug_overwrites.json schreiben kann.
--connection-id <id>	–		Verbindungs-ID, die an dieses Tool gebunden werden soll. Aktiviert zusammen mit --object-name den verbindungsbewussten debug_overwrites.json -Schreib.
--method <method>	POST		HTTP-Methode für den Toolvorgang.
--process-name <name>	–		Orchestrator-Prozessname, der zu binden ist. Erforderlich für die Tooltypen process, agent, apiWorkflow, processOrchestration .
--folder-path <path>	–		Orchestrator-Ordnerpfad, in dem der Prozess bereitgestellt wird.
--path <path>	.		Pfad zum Agent-Projektverzeichnis.

Required flag combinations

• integration Tools erfordern --connector.
• Wenn --connector ohne --type angegeben wird, ist der Typ standardmäßig integration.
• Wenn sowohl --connector als --object-name für ein Integrationstool angegeben werden, durchläuft der Befehl den IS-Metadatenpfad und erfordert eine angemeldete Sitzung.

Beispiele

# Process tool bound to an Orchestrator process
uip agent tool add InvoiceLookup \
  --type process \
  --process-name Invoices \
  --folder-path Shared \
  --path ./my-agent

# Integration Service tool, discovered via IS (requires login)
uip agent tool add SlackSender \
  --connector uipath-slack \
  --object-name message \
  --connection-id a1b2c3d4-0000-0000-0000-000000000610

# Integration tool without IS metadata (local only)
uip agent tool add SlackSender --connector uipath-slack

Datenform (--output json)

Einfacher Pfad (Prozess, Agent oder Integration ohne IS-Metadaten):

{
  "Code": "AgentToolAdd",
  "Data": {
    "Status": "Tool added and bound to Orchestrator process",
    "Name": "InvoiceLookup",
    "Type": "process",
    "Id": "a1b2c3d4-0000-0000-0000-000000000601",
    "ProcessName": "Invoices",
    "FolderPath": "Shared"
  }
}

ProcessName und FolderPath sind nur vorhanden, wenn --process-name übergeben wurde. Ohne Prozessbindung ist Status stattdessen "Tool added" .

IS-Metadatenpfad (--connector + --object-name):

{
  "Code": "AgentToolAdd",
  "Data": {
    "Status": "Integration tool added with IS metadata",
    "Name": "SlackSender",
    "Type": "integration",
    "Id": "a1b2c3d4-0000-0000-0000-000000000605",
    "ConnectorKey": "uipath-slack",
    "ObjectName": "message",
    "ConnectionBound": true
  }
}

Erkennung des UIP-Agententools

Die von einem Integration Service-Connector verfügbar gemachten Vorgänge entdecken. Ruft die IS-API auf; Anmeldung erforderlich.

Optionen

Markieren	Standard	Erforderlich	Zweck
--connector <key>	–	ja	Connector-Schlüssel.
--connection-id <id>	–		Verbindungs-ID für die Mandantenerkennung.

Beispiel

uip agent tool discover --connector uipath-slack

Datenform (--output json)

{
  "Code": "AgentToolDiscover",
  "Data": [
    {
      "Name": "sendMessage",
      "DisplayName": "Send Message",
      "Type": "integration",
      "ObjectName": "message"
    }
  ]
}

Leere Connectors geben Data: { "Message": "No tools found for this connector" } zurück.

Verbindung mit dem UIP-Agent-Tool herstellen

Binden Sie eine Verbindung mit einem bereits hinzugefügten Integrationstool. Ruft die IS-API auf; Anmeldung erforderlich.

Argumente

• <name> (erforderlich) – Der Name des Tools, der aktualisiert werden soll.

Optionen

Markieren	Standard	Erforderlich	Zweck
--connection-id <id>	–	ja	Zu bindende Verbindungs-ID.
--path <path>	.		Pfad zum Agent-Projektverzeichnis.

Beispiel

uip agent tool connect SlackSender \
  --connection-id a1b2c3d4-0000-0000-0000-000000000610 \
  --path ./my-agent

Datenform (--output json)

{
  "Code": "AgentToolConnect",
  "Data": {
    "Status": "Connection bound to tool",
    "Tool": "SlackSender",
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000610"
  }
}

Liste der UIP-Agent-Tools

Listen Sie die für den Agent konfigurierten Tools auf.

Optionen

Markieren	Standard	Zweck
--path <path>	.	Pfad zum Agent-Projektverzeichnis.

Beispiel

uip agent tool list --path ./my-agent

Datenform (--output json)

{
  "Code": "AgentToolList",
  "Data": [
    {
      "Name": "InvoiceLookup",
      "Type": "process",
      "Id": "a1b2c3d4-0000-0000-0000-000000000601",
      "Enabled": true
    }
  ]
}

Leere Projekte geben Data: { "Message": "No tools configured" } zurück.

UIP-Agent-Tool entfernen

Eine Toolressource entfernen.

Argumente

• <name> (erforderlich) – Name oder ID des Tools.

Optionen

Markieren	Standard	Zweck
--path <path>	.	Pfad zum Agent-Projektverzeichnis.

Beispiel

uip agent tool remove InvoiceLookup --path ./my-agent

Datenform (--output json)

{
  "Code": "AgentToolRemove",
  "Data": {
    "Status": "Tool removed",
    "Name": "InvoiceLookup"
  }
}

Ein fehlendes Tool schlägt mit Tool "<name>" not found und Exitcode 1 fehl.

Zugehörig

• uip agent context – RAG-Kontextressourcen.
• uip agent escalation – HITL-/Eskalationsressourcen.
• uip agent validate – Nach Batch-Bearbeitungen erneut ausführen.

Siehe auch

• Konzepte: Fähigkeiten – wie Tools im Fähigkeitsmodell auftauchen.
• Authentifizierung – Sitzungen, die von discover und dem IS-fähigen add -Pfad verwendet werden.
• Globale Optionen, Exitcodes.