ferramenta de agente de uip

Sintaxe e opções para a "ferramenta de agente uip", que gerencia recursos de ferramentas em um projeto de agente, incluindo conectores, processos e fluxos de trabalho de API.

uip agent tool gerencia recursos de ferramentas em um projeto de agente. As ferramentas são chamadas do agente para comportamento externo: conectores do Integration Service, processos do Orchestrator, outros agentes, fluxos de trabalho de API, fluxos do Process Orchestration e habilidades de IXP. Cada entrada nos recursos de ferramenta do agente corresponde a uma ação que o agente pode invocar.

O add grava no disco localmente; discover e connect chamam a API do Integration Service (IS) e, portanto, exigem uma sessão de CLI ativa (uip login). list e remove são puramente locais.

Resumo

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 os subcomandos respeitam as opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato padrão.

Os tipos de ferramentas válidos são: integration, process, agent, apiWorkflow, processOrchestration, ixp.

adição da ferramenta do agente uip

Adicione um recurso de ferramenta ao agente.

Argumentos

• <name> necessário) — Nome da ferramenta, referenciado pelo agente.

Opções

Bandeira	Padrão	Required	Finalidade
--type <type>	integration --connector estiver presente; caso contrário, necessário	Condicional	Tipo de ferramenta. Uma destas opções: integration, process, agent, apiWorkflow, processOrchestration, ixp.
--description <desc>	—		Descrição em texto livre.
--connector <key>	—	sim para integration	Chave do conector (por exemplo, uipath-slack).
--connector-url <url>	—		URL de base do conector (apenas ferramentas do Integration Service).
--object-name <name>	—		Nome do recurso/objeto do conector IS (por exemplo, message). Quando definido junto com --connector, add muda para o caminho completo de metadados IS, que chama a API do Integration Service e pode escrever userProfile/debug_overwrites.json.
--connection-id <id>	—		ID da conexão para vincular a esta ferramenta. Juntamente com --object-name, habilita a gravação debug_overwrites.json com reconhecimento de conexão.
--method <method>	POST		Método HTTP para a operação da ferramenta.
--process-name <name>	—		Nome do processo do Orchestrator para vincular. Exigido por process, agent, apiWorkflow, processOrchestration tipos de ferramenta.
--folder-path <path>	—		Caminho da pasta do Orchestrator onde o processo é implantado.
--path <path>	.		Caminho para o diretório do projeto do agente.

Combinações de sinalizadores exigidas

• integration ferramentas exigem --connector.
• Quando --connector é fornecido sem --type, o tipo assume como padrão integration.
• Quando --connector e --object-name são fornecidos em uma ferramenta de integração, o comando passa pelo caminho de metadados IS e requer uma sessão conectada.

Exemplos

# 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

Formato dos dados (--output json)

Caminho simples (processo, agente ou integração sem metadados 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 e FolderPath só estarão presentes quando --process-name for passado. Sem uma associação de processo, Status é "Tool added" em vez disso.

Caminho de metadados 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
  }
}

descoberta da ferramenta do agente uip

Descubra as operações expostas por um conector do Integration Service. Chama a API IS; requer logon.

Opções

Bandeira	Padrão	Required	Finalidade
--connector <key>	—	sim	Chave do conector.
--connection-id <id>	—		ID de conexão para a descoberta de tenants.

Exemplo

uip agent tool discover --connector uipath-slack

Formato dos dados (--output json)

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

Os conectores vazios retornam Data: { "Message": "No tools found for this connector" }.

conexão da ferramenta do agente uip

Associe uma conexão a uma ferramenta de integração já adicionada. Chama a API IS; requer logon.

Argumentos

• <name> necessário) — Nome da ferramenta a atualizar.

Opções

Bandeira	Padrão	Required	Finalidade
--connection-id <id>	—	sim	ID de conexão a ser vinculada.
--path <path>	.		Caminho para o diretório do projeto do agente.

Exemplo

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

Formato dos dados (--output json)

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

lista de ferramentas do agente uip

Enumerar as ferramentas configuradas no agente.

Opções

Bandeira	Padrão	Finalidade
--path <path>	.	Caminho para o diretório do projeto do agente.

Exemplo

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

Formato dos dados (--output json)

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

Os projetos vazios retornam Data: { "Message": "No tools configured" }.

remoção da ferramenta do agente uip

Remova um recurso de ferramenta.

Argumentos

• <name> necessário) — Nome ou ID da ferramenta.

Opções

Bandeira	Padrão	Finalidade
--path <path>	.	Caminho para o diretório do projeto do agente.

Exemplo

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

Formato dos dados (--output json)

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

Uma ferramenta ausente falha com Tool "<name>" not found e código de saída 1.

Relacionado

• uip agent context — Recursos de contexto de RAG.
• uip agent escalation — HITL / recursos de escalonamento.
• uip agent validate — executar novamente após edições em lote.

Veja também

• Conceitos: habilidades — como as ferramentas aparecem no modelo de habilidades.
• Autenticação — sessões usadas por discover e o caminho add com reconhecimento de IS.
• Opções globais, Códigos de saída.