outil d’agent uip

Syntaxe et options de `uip agent tool`, qui gère les ressources d'outils sur un projet d'agent, y compris les connecteurs, les processus et les workflows d'API.

uip agent tool gère les ressources d'outils sur un projet d'agent. Les outils sont les appels de l'agent au comportement externe: connecteurs Integration Service, processus Orchestrator, autres agents, workflows d'API, flux d'orchestration de processus et compétences IXP. Chaque entrée dans les ressources de l'outil de l'agent correspond à une action que l'agent peut invoquer.

Le verbe add écrit sur le disque localement; discover et connect appellent l'API Integration Service et nécessitent donc une session CLI active (uip login). list et remove sont purement locaux.

Synthèse

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>]

Toutes les sous-commandes respectent les options globales (--output, --output-filter, --log-level, --log-file). Les codes de sortie suivent le contrat standard.

Les types d’outils valides sont: integration, process, agent, apiWorkflow, processOrchestration, ixp.

ajout d'outil d'agent uip

Ajoutez une ressource d’outil à l’agent.

Arguments

• <name> (requis) : le nom de l’outil, référencé par l’agent.

Options

Drapeau	Default	Requis	Objectif
--type <type>	integration lorsque --connector est présent; sinon requis	Conditionnel	Type d’outil. L'un des integration, process, agent, apiWorkflow, processOrchestration, ixp.
--description <desc>	—		Description en texte libre.
--connector <key>	—	oui pour integration	Clé du connecteur (par exemple, uipath-slack).
--connector-url <url>	—		URL de base du connecteur (outils Integration Service uniquement).
--object-name <name>	—		Nom de la ressource/objet du connecteur IS (par exemple, message). Lorsque ce paramètre est défini avec --connector, add bascule vers le chemin de métadonnées IS complet, qui appelle l’API Integration Service et peut écrire userProfile/debug_overwrites.json.
--connection-id <id>	—		ID de connexion pour lier à cet outil. Avec --object-name, active l'écriture de debug_overwrites.json selon la connexion.
--method <method>	POST		Méthode HTTP pour l'opération de l'outil.
--process-name <name>	—		Nom du processus Orchestrator à lier. Requis par les types d'outils process, agent, apiWorkflow et processOrchestration .
--folder-path <path>	—		Chemin du dossier Orchestrator dans lequel le processus est déployé.
--path <path>	.		Chemin d’accès au répertoire du projet d’agent.

Combinaisons d'indicateurs requises

• Les outils integration nécessitent --connector.
• Lorsque la valeur --connector est indiquée sans --type, la valeur par défaut est integration.
• Lorsque les paramètres --connector et --object-name sont indiqués sur un outil d'intégration, la commande parcourt le chemin des métadonnées IS et nécessite une session connectée.

Exemples

# 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

Format des données (--sortie json)

Chemin simple (processus, agent ou intégration sans métadonnées IS):

{
  "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 et FolderPath ne sont présents que lorsque --process-name a été transmis. Sans liaison de processus, Status est "Tool added" à la place.

Chemin des métadonnées IS (--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
  }
}

Découverte d’un outil d’agent uip

Découvrez les opérations exposées par un connecteur Integration Service. Appelle l’API IS; nécessite une connexion.

Options

Drapeau	Default	Requis	Objectif
--connector <key>	—	oui	Clé du connecteur.
--connection-id <id>	—		ID de connexion pour la découverte de locataires.

Exemple

uip agent tool discover --connector uipath-slack

Format des données (--sortie json)

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

Les connecteurs vides renvoient Data: { "Message": "No tools found for this connector" }.

connexion à l'outil d'agent uip

Liez une connexion à un outil d'intégration déjà ajouté. Appelle l’API IS; nécessite une connexion.

Arguments

• <name> (requis) : le nom de l’outil à mettre à jour.

Options

Drapeau	Default	Requis	Objectif
--connection-id <id>	—	oui	ID de connexion à lier.
--path <path>	.		Chemin d’accès au répertoire du projet d’agent.

Exemple

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

Format des données (--sortie json)

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

liste des outils d’agent uip

Énumérez les outils configurés sur l’agent.

Options

Drapeau	Default	Objectif
--path <path>	.	Chemin d’accès au répertoire du projet d’agent.

Exemple

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

Format des données (--sortie json)

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

Les projets vides renvoient Data: { "Message": "No tools configured" }.

Suppression de l’outil d’agent uip

Supprimez une ressource d’outil.

Arguments

• <name> (requis) : le nom ou l’ID de l’outil.

Options

Drapeau	Default	Objectif
--path <path>	.	Chemin d’accès au répertoire du projet d’agent.

Exemple

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

Format des données (--sortie json)

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

Un outil manquant échoue avec Tool "<name>" not found et le code de sortie 1.

Associé

• uip agent context — Ressources de contexte RAG.
• uip agent escalation — HITL/ressources d'escalade.
• uip agent validate — réexécuté après les modifications par lots.

Voir également

• Concepts: compétences - comment les outils apparaissent dans le modèle de compétence.
• Authentification — sessions utilisées par discover et le chemin d'accès add compatible IS.
• Options globales, codes de sortie.