UiPath Documentation
uipath-cli
latest
false
Guia do usuário da UiPath CLI
Importante :
Este conteúdo foi traduzido com auxílio de tradução automática. A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

HubDoAgente da UIP

Sintaxe e opções para o "uip agenthub mcp", que registra e gerencia servidores MCP do AgentHub — as ferramentas codificadas e os agentes de pouco código podem chamar.

uip agenthub gerencia o UiPath AgentHub: registros de servidor MCP (Protocolo de contexto do modelo) e suas ferramentas, além de registros de agente remotos A2A (agente a agente). Um servidor MCP do AgentHub é um recurso nomeado e com escopo de pasta que expõe um conjunto de ferramentas chamáveis para agentes codificados e de pouco código — não deve ser confundido com o próprio protocolo de conexão MCP, que é como um cliente realmente invoca essas ferramentas no runtime.

Esse recurso abrange duas páginas:

  • Esta página — conceitos e mcp (registro, listar, atualizar, excluir servidores MCP).
  • mcp-tools e remote-a2a-agent — gerencie as ferramentas anexadas a um servidor MCP e registros de agentes A2A remotos.

Conceitos​

  • O tipo de servidor é corrigido na criação e imutável posteriormente. Oito tipos nomeados existem no enum de tipos (uipath, command, coded, selfhosted, remote, process-assistant, platform, swagger), cada um mapeado para um valor numérico de conexão ( 0 a 7, respectivamente). Apenas seis das oito têm uma folha mcp create <type> em funcionamento: uipath, coded, command, remote, platform, swagger. selfhosted e process-assistant aparecem no tipo enum, nos tipos aceitos do mcp template e até têm exemplos funcionados no próprio texto de ajuda deste comando — mas não há subcomando mcp create selfhosted ou mcp create process-assistant registrado em qualquer lugar na origem . A tentativa de qualquer um falha como um comando desconhecido. mcp update <slug> despacha pelo tipo existente do servidor (buscado da API), portanto, não tem essa lacuna — mas só pode atualizar um servidor que foi criado de alguma outra forma para esses dois tipos.
  • Contexto da pasta. Os recursos do AgentHub têm o escopo de pasta do Orchestrator. Passe --folder-key <guid> ou --folder-path <path> em cada verbo; mcp list também aceita --all-folders para enumerar todas as pastas que o chamador pode ver (pasta por pasta, desduplicada por campo de dados dinâmico+pasta, com falhas por pasta — mais comumente "sem permissão do AgentHub nessa pasta" — ingerida e apareciam como avisos em vez de anular toda a lista). mcp create e mcp delete falham hardware antes de qualquer chamada de rede se nenhuma pasta for resolvida; mcp list/mcp get não impõem esse lado do cliente, mesmo que a própria descrição de mcp list diga que um contexto de pasta é necessário — omitir ambos provavelmente ainda falhará no lado do servidor.
  • Modos de entrada em criar/atualizar: exatamente um dos sinalizadores --file, --body ou escalar. Passar mais de uma origem é um erro ConflictingInput do lado do cliente; passar nenhum é MissingInput. --print-schema em curto-requisitos ou verbo para imprimir a forma JSON esperada do tipo em vez de escrever qualquer coisa — uma maneira rápida de ver o que --file/--body precisa antes de criá-lo manualmente. --dry-run curtos-requisitos para imprimir o plano de transformação resolvido (verbo HTTP, destino, carga resolvida) sem chamar a API.
  • update no servidor existente por padrão escalar; --file/--body substitui totalmente. No modo escalar, apenas os sinalizadores que você passar mudam — o restante dos campos do servidor buscado são preservados, incluindo o selectedToolNames existente de um servidor platform quando --tool é omitido. O campo type em si é imutável: incluí-lo em uma carga --file/--body é um erro do lado do cliente, não um no-op silencioso.

Resumo​

uip agenthub mcp list [--type <type>] [--status <s>] [--name <substr>] [--limit <n>] [--offset <n>] [--folder-key <key> | --folder-path <path> | --all-folders]
uip agenthub mcp get <slug> [--folder-key <key> | --folder-path <path>]
uip agenthub mcp create <uipath|coded|command|remote|platform|swagger> [type-specific options] [--file <path> | --body <json> | scalars] [--print-schema] [--dry-run]
uip agenthub mcp update <slug> [type-specific options] [--file <path> | --body <json> | scalars] [--print-schema] [--dry-run]
uip agenthub mcp template <type>
uip agenthub mcp delete <slug> -y [--dry-run]
uip agenthub mcp refresh-tools <slug> --folder-key <key> [--dry-run]
uip agenthub mcp list [--type <type>] [--status <s>] [--name <substr>] [--limit <n>] [--offset <n>] [--folder-key <key> | --folder-path <path> | --all-folders]
uip agenthub mcp get <slug> [--folder-key <key> | --folder-path <path>]
uip agenthub mcp create <uipath|coded|command|remote|platform|swagger> [type-specific options] [--file <path> | --body <json> | scalars] [--print-schema] [--dry-run]
uip agenthub mcp update <slug> [type-specific options] [--file <path> | --body <json> | scalars] [--print-schema] [--dry-run]
uip agenthub mcp template <type>
uip agenthub mcp delete <slug> -y [--dry-run]
uip agenthub mcp refresh-tools <slug> --folder-key <key> [--dry-run]

lista de mcp do agenthub do uip​

Listar registros de servidor MCP. Os filtros (--type, --status, --name) e a paginação (--limit/--offset) são aplicados no lado do cliente, pois a API subjacente retorna uma matriz mesclada.

Opções​

LongValorPadrãoDescription
--type <kind>uipath|command|coded|selfhosted|remote|process-assistant|platform|swagger—Filtra por tipo de servidor. Os valores inválidos falham no lado do cliente antes de qualquer chamada de API.
--status <s>String—Filtra por status. Correspondido com o enum de status numérico como uma string bruta.
--name <substr>String—Correspondência de substring que não diferencia maiúsculas de minúsculas no nome do servidor.
--limit <number>Número inteiro50Tamanho da página
--offset <number>Número inteiro0Deslocamento de linha.
--folder-key <key>GUID—Pasta do Orchestrator. mutuamente exclusivo com --all-folders.
--folder-path <path>String—Nome de exibição da pasta ou caminho totalmente qualificado, resolvido em uma chave por meio do SDK do Orchestrator.
--all-foldersBandeiradesativadaEntime cada pasta que o chamador pode ver. mutuamente exclusivo com --folder-key/--folder-path.
--login-validity <minutes>Número inteiro—Substitua o tempo de vida do token de login interativo para esta chamada.

Exemplo​

uip agenthub mcp list --folder-path Shared --type uipath --name invoice
uip agenthub mcp list --folder-path Shared --type uipath --name invoice

Formato dos dados (--output json)​

{
  "Code": "AgentHubMcpList",
  "Data": {
    "items": [{ "slug": "invoice-mcp", "name": "Invoice MCP", "type": 0, "status": 0 }],
    "total": 1,
    "count": 1
  }
}
{
  "Code": "AgentHubMcpList",
  "Data": {
    "items": [{ "slug": "invoice-mcp", "name": "Invoice MCP", "type": 0, "status": 0 }],
    "total": 1,
    "count": 1
  }
}

Obtenção de uip agenthub mcp​

Obtenha um servidor MCP por campo de dados dinâmico canônico. Sem fallback de pesquisa por nome — passe o campo de dados dinâmico exato de mcp list.

Argumentos​

NameRequiredFinalidade
<slug>simCampo de dados dinâmico do servidor MCP canônico.

Opções​

LongValorDescription
--folder-key <key> / --folder-path <path>GUID/stringContexto da pasta.
--login-validity <minutes>Número inteiroSubstituição de vida útil do token.

Exemplo​

uip agenthub mcp get invoice-mcp
uip agenthub mcp get invoice-mcp

Formato dos dados (--output json)​

{ "Code": "AgentHubMcpGet", "Data": { "slug": "invoice-mcp", "name": "Invoice MCP", "type": 0 } }
{ "Code": "AgentHubMcpGet", "Data": { "slug": "invoice-mcp", "name": "Invoice MCP", "type": 0 } }

criação de mcp do agenthub do uip​

Crie um servidor MCP. Um subcomando por tipo — uipath, coded, command, remote, platform, swagger (consulte Conceitos para os dois nomes de tipos que existem no enum, mas não têm folha create em funcionamento) . Todos os seis compartilham --name, --slug (o padrão é um --name com campos de dados dinâmicos), --description, --version, mais --file/--body/--print-schema/--dry-run e opções de pasta. Requer uma pasta resolvível — falha antes de qualquer chamada de rede.

Opções específicas do tipo​

TipoOpções extrasObservações
uipathnenhumCarga: { server: {name, slug, description, version}, tools: [] }. As ferramentas são adicionadas posteriormente por meio de mcp-tools.
coded--process-key <key>Apoiado por um processo do Orchestrator. --folder-key funciona como o folderKey da carga.
command--command <cmd>, --arg <arg> (repetível), --env <key=value> (repetível)Inicia um binário local. arguments é a lista associada de --arg (separada por espaço); environmentVariables é um objeto com strings JSON construído a partir de pares --env.
remote--uri <uri>, --header <key=value> (repetível), --use-relayheaders é um objeto com strings JSON de pares --header.
platform--service <name>, --tool <name> (repetível)O Payload aninha escalares sob server, com selectedToolNames ao lado.
swagger--spec-url <url>, --use-relay, --filter <expr> (repetível, reservado)Cria por meio de um ponto de extremidade de API específico do Swagger separado.

Exemplos​

uip agenthub mcp create uipath --name InvoiceMcp --slug invoice-mcp
uip agenthub mcp create command --name LocalMcp --slug local-mcp --command npx --arg @some/server
uip agenthub mcp create remote --name RemoteMcp --slug remote-mcp --uri https://example/mcp
uip agenthub mcp create uipath --name InvoiceMcp --slug invoice-mcp
uip agenthub mcp create command --name LocalMcp --slug local-mcp --command npx --arg @some/server
uip agenthub mcp create remote --name RemoteMcp --slug remote-mcp --uri https://example/mcp

Formato dos dados (--output json)​

{ "Code": "AgentHubMcpCreate", "Data": { "slug": "invoice-mcp", "name": "InvoiceMcp" } }
{ "Code": "AgentHubMcpCreate", "Data": { "slug": "invoice-mcp", "name": "InvoiceMcp" } }

--print-schema retorna Code: "AgentHubMcpTemplate" com o Esquema JSON do tipo em vez de criar qualquer coisa. --dry-run retorna Code: "DryRun" com o plano de transformação resolvido.

Atualização de mcp do agenthub do uiip​

Atualize um servidor MCP. Envios pelo tipo existente do servidor (buscado primeiro) — as mesmas opções específicas de tipo que create são todas registradas em update , independentemente do tipo real do destino, mas apenas as relevantes para o tipo buscado são mescladas.

Argumentos​

NameRequiredFinalidade
<slug>simCampo de dados dinâmico do servidor MCP canônico.

Opções​

Mesmos sinalizadores específicos de tipo como create (--name, --description, --version, --process-key, --command, --arg, --env, --uri, --header, --use-relay, --service, --tool, --spec-url), mais --file/--body/--print-schema/--dry-run e opções de pasta. type é imutável — incluí-lo em uma carga --file/--body é um erro do lado do cliente.

Exemplo​

uip agenthub mcp update invoice-mcp --name InvoiceMcp
uip agenthub mcp update invoice-mcp --name InvoiceMcp

Formato dos dados (--output json)​

{ "Code": "AgentHubMcpUpdate", "Data": { "slug": "invoice-mcp", "name": "InvoiceMcp" } }
{ "Code": "AgentHubMcpUpdate", "Data": { "slug": "invoice-mcp", "name": "InvoiceMcp" } }

modelo de mcp do agenthub do uiip​

Emita um esqueleto JSON pronto para editar para um tipo de servidor — um comando de referência estático e independente de conector (sem opções de pasta).

Argumentos​

NameRequiredFinalidade
<type>simUma destas opções: uipath, coded, command, selfhosted, remote, process-assistant, platform, swagger (todos os 8, incluindo os dois sem folha create em funcionamento). swagger-mcp também é aceito, normalizado para swagger.

Exemplo​

uip agenthub mcp template uipath
uip agenthub mcp template uipath

Formato dos dados (--output json)​

{ "Code": "AgentHubMcpTemplate", "Data": { "server": { "name": "uipath-mcp", "description": "", "version": "1.0.0", "isActive": true }, "tools": [] } }
{ "Code": "AgentHubMcpTemplate", "Data": { "server": { "name": "uipath-mcp", "description": "", "version": "1.0.0", "isActive": true }, "tools": [] } }

Exclusão do uiip agenthub mcp​

Exclua um servidor MCP por campo de dados dinâmico. Destrutivo — requer -y/--yes. Requer uma pasta resolvida.

Argumentos​

NameRequiredFinalidade
<slug>simCampo de dados dinâmico do servidor MCP canônico.

Opções​

LongDescription
-y, --yesNecessário confirmar. A CLI nunca solicita.
--dry-runImprimir o plano de transformação sem excluir.

Exemplo​

uip agenthub mcp delete invoice-mcp -y
uip agenthub mcp delete invoice-mcp -y

Formato dos dados (--output json)​

{ "Code": "AgentHubMcpDelete", "Data": { "slug": "invoice-mcp", "deleted": true } }
{ "Code": "AgentHubMcpDelete", "Data": { "slug": "invoice-mcp", "deleted": true } }

ferramentas de atualização do uip agenthub mcp​

Obtenha novamente as ferramentas de um servidor de sua origem ativa (o esquema de um processo, um ponto de extremidade remoto/swagger etc.).

Argumentos​

NameRequiredFinalidade
<slug>simCampo de dados dinâmico do servidor MCP canônico.

Opções​

LongDescription
--folder-key <key> / --folder-path <path>Um é necessário — o ponto de extremidade de atualização tem o escopo de pasta (/mcp/{folderKey}/{slug}/refresh-tools). A falta de ambos falha com um erro explícito antes de qualquer pesquisa.
--dry-runImprimir o plano de transformação sem atualizar.

O comportamento difere por tipo de servidor: coded/command atualizações retornam um assíncrono runtimeId (HTTP 202, status: "Started"); remote/swagger/platform atualizam de forma síncrona (status: "Refreshed", toolCount); Os servidores uipath e selfhosted são rejeitados localmente — suas ferramentas são criadas manualmente, não derivadas — com uma dica NextCommand apontando para mcp-tools create-resource.

Exemplo​

uip agenthub mcp refresh-tools remote-mcp --folder-key f1f2f3f4-0000-0000-0000-000000000001
uip agenthub mcp refresh-tools remote-mcp --folder-key f1f2f3f4-0000-0000-0000-000000000001

Formato dos dados (--output json)​

{ "Code": "AgentHubMcpRefreshTools", "Data": { "status": "Refreshed", "toolCount": 3 } }
{ "Code": "AgentHubMcpRefreshTools", "Data": { "status": "Refreshed", "toolCount": 3 } }

Em vez disso, respostas assíncronas (202) retornam { "runtimeId": "...", "status": "Started" }.

Veja também​

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte

Quer aprender? Academia UiPath

Tem perguntas? Fórum do UiPath

Fique por dentro das novidades