herramienta de agente de UIP

Sintaxis y opciones para la `herramienta de agente de uip`, que gestiona los recursos de herramientas en un proyecto de agente, incluidos los conectores, los procesos y los flujos de trabajo de API.

uip agent tool gestiona los recursos de herramientas en un proyecto de agente. Las herramientas son las llamadas del agente al comportamiento externo: conectores de Integration Service, procesos de Orchestrator, otros agentes, flujos de trabajo de API, flujos de orquestación de procesos y habilidades de Extracción y Procesamiento Inteligentes (IXP). Cada entrada en los recursos de herramientas del agente corresponde a una acción que el agente puede invocar.

El verbo add escribe en el disco localmente; discover y connect llaman a la API de Integration Service (IS) y, por lo tanto, requieren una sesión CLI activa (uip login). list y remove son puramente locales.

Sinopsis

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

Todos los subcomandos respetan las opciones globales (--output, --output-filter, --log-level, --log-file). Los códigos de salida siguen el contrato estándar.

Los tipos de herramientas válidos son: integration, process, agent, apiWorkflow, processOrchestration, ixp.

Añadir herramienta de agente de UIP

Añade un recurso de herramienta al agente.

Argumentos

• <name> obligatorio) : nombre de la herramienta, referenciado por el agente.

Opciones

Marca	Predeterminado	Obligatorio	Propósito
--type <type>	integration cuando --connector está presente; de lo contrario es necesario	Condicional	Tipo de herramienta. Uno de integration, process, agent, apiWorkflow, processOrchestration, ixp.
--description <desc>	—		Descripción de texto libre.
--connector <key>	—	Sí para integration	Clave del conector (por ejemplo, uipath-slack).
--connector-url <url>	—		URL base del conector (solo herramientas de Integration Service).
--object-name <name>	—		Nombre del recurso/objeto del conector IS (por ejemplo, message). Cuando se establece junto con --connector, add cambia a la ruta completa de metadatos de IS, que llama a la API de Integration Service y puede escribir userProfile/debug_overwrites.json.
--connection-id <id>	—		ID de conexión para vincular a esta herramienta. Junto con --object-name, habilita la escritura con reconocimiento de conexión debug_overwrites.json .
--method <method>	POST		Método HTTP para la operación de la herramienta.
--process-name <name>	—		Nombre del proceso de Orchestrator para vincular. Requerido por los tipos de herramientas process, agent, apiWorkflow, processOrchestration .
--folder-path <path>	—		Ruta de la carpeta de Orchestrator donde se implementa el proceso.
--path <path>	.		Ruta al directorio del proyecto del agente.

Combinaciones de marcadores necesarias

• Las herramientas integration requieren --connector.
• Cuando --connector se da sin --type, el tipo predeterminado es integration.
• Cuando tanto --connector como --object-name se proporcionan en una herramienta de integración, el comando pasa por la ruta de metadatos de IS y requiere una sesión iniciada.

Ejemplos

# 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

Forma de datos (--json de salida)

Ruta simple (proceso, agente o integración sin metadatos de 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 y FolderPath solo están presentes cuando se pasó --process-name . Sin una vinculación de proceso, Status es "Tool added" en su lugar.

Ruta de metadatos de 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
  }
}

descubrimiento de la herramienta del agente de uip

Descubre las operaciones expuestas por un conector de Integration Service. Llama a la API de IS; requiere inicio de sesión.

Opciones

Marca	Predeterminado	Obligatorio	Propósito
--connector <key>	—	Sí	Clave del conector.
--connection-id <id>	—		ID de conexión para el descubrimiento de tenant.

Ejemplo

uip agent tool discover --connector uipath-slack

Forma de datos (--json de salida)

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

Los conectores vacíos devuelven Data: { "Message": "No tools found for this connector" }.

conexión de la herramienta del agente de uip

Vincula una conexión a una herramienta de integración ya añadida. Llama a la API de IS; requiere inicio de sesión.

Argumentos

• <name> (obligatorio) : nombre de la herramienta que se actualizará.

Opciones

Marca	Predeterminado	Obligatorio	Propósito
--connection-id <id>	—	Sí	ID de conexión a vincular.
--path <path>	.		Ruta al directorio del proyecto del agente.

Ejemplo

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

Forma de datos (--json de salida)

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

lista de herramientas del agente de uip

Enumera las herramientas configuradas en el agente.

Opciones

Marca	Predeterminado	Propósito
--path <path>	.	Ruta al directorio del proyecto del agente.

Ejemplo

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

Forma de datos (--json de salida)

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

Los proyectos vacíos devuelven Data: { "Message": "No tools configured" }.

Herramienta de agente de uip eliminar

Eliminar un recurso de herramienta.

Argumentos

• <name> obligatorio) : nombre o ID de la herramienta.

Opciones

Marca	Predeterminado	Propósito
--path <path>	.	Ruta al directorio del proyecto del agente.

Ejemplo

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

Forma de datos (--json de salida)

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

Una herramienta faltante falla con Tool "<name>" not found y el código de salida 1.

Relacionado

• uip agent context — Recursos de contexto RAG.
• uip agent escalation — Recursos HITL/escalada.
• uip agent validate : volver a ejecutar después de ediciones por lotes.

Ver también

• Conceptos: habilidades : cómo surgen las herramientas en el modelo de habilidad.
• Autenticación : sesiones utilizadas por discover y la ruta add compatible con IS.
• Opciones globales, códigos de salida.