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.

uip agenthub mcp-tools and remote-a2a-agent

Syntax and options for `uip agenthub mcp-tools`, which manages the tools attached to an AgentHub MCP server, and `uip agenthub remote-a2a-agent`, which manages remote agent-to-agent registrations.

Part of the uip agenthub command family. This page covers mcp-tools (the tools attached to a uipath- or platform-type MCP server) and remote-a2a-agent (agent-to-agent registrations, unrelated to MCP servers). See uip agenthub for shared concepts — server types, folder scoping, input modes.

Resumo

uip agenthub mcp-tools list --mcp <slug> [--name <substr>] [--limit <n>] [--offset <n>]
uip agenthub mcp-tools get --mcp <slug> [<id>] [--name <name>] [--allow-multiple]
uip agenthub mcp-tools create-resource --mcp <slug> --category <category> (--target-name <name> | --target-identifier <guid>) [options...]
uip agenthub mcp-tools create-raw --mcp <slug> --file <path> | --body <json> [options...]
uip agenthub mcp-tools update [<id>] --mcp <slug> [--name <substr>] [--rename <name>] [options...]
uip agenthub mcp-tools delete [<ids...>] --mcp <slug> [--name <substr>] -y
uip agenthub mcp-tools template <resource|raw>
uip agenthub mcp-tools candidates --category <category> [--name <substr>] [--limit <n>] [--offset <n>]
uip agenthub mcp-tools enable --mcp <slug> [--name <name>]...
uip agenthub mcp-tools disable --mcp <slug> [--name <name>]...

uip agenthub remote-a2a-agent list [--name <substr>] [--limit <n>] [--offset <n>]
uip agenthub remote-a2a-agent get <slug>
uip agenthub remote-a2a-agent create --name <name> --slug <slug> [options...]
uip agenthub remote-a2a-agent update <slug> [options...]
uip agenthub remote-a2a-agent delete <slug> -y
uip agenthub remote-a2a-agent refresh-card <slug>
uip agenthub mcp-tools list --mcp <slug> [--name <substr>] [--limit <n>] [--offset <n>]
uip agenthub mcp-tools get --mcp <slug> [<id>] [--name <name>] [--allow-multiple]
uip agenthub mcp-tools create-resource --mcp <slug> --category <category> (--target-name <name> | --target-identifier <guid>) [options...]
uip agenthub mcp-tools create-raw --mcp <slug> --file <path> | --body <json> [options...]
uip agenthub mcp-tools update [<id>] --mcp <slug> [--name <substr>] [--rename <name>] [options...]
uip agenthub mcp-tools delete [<ids...>] --mcp <slug> [--name <substr>] -y
uip agenthub mcp-tools template <resource|raw>
uip agenthub mcp-tools candidates --category <category> [--name <substr>] [--limit <n>] [--offset <n>]
uip agenthub mcp-tools enable --mcp <slug> [--name <name>]...
uip agenthub mcp-tools disable --mcp <slug> [--name <name>]...

uip agenthub remote-a2a-agent list [--name <substr>] [--limit <n>] [--offset <n>]
uip agenthub remote-a2a-agent get <slug>
uip agenthub remote-a2a-agent create --name <name> --slug <slug> [options...]
uip agenthub remote-a2a-agent update <slug> [options...]
uip agenthub remote-a2a-agent delete <slug> -y
uip agenthub remote-a2a-agent refresh-card <slug>

uip agenthub mcp-tools

Manage tools attached to AgentHub MCP servers. Every verb requires --mcp <slug> to identify the parent server. Two tool-authoring paths exist: create-resource (resolve an existing Orchestrator process/agent/API-workflow into a tool via the Resource Catalog Service) and create-raw (a hand-written JSON payload) — both only work against a uipath-type parent server. enable/disable are a separate mechanism specific to platform-type servers, toggling membership in that server's selectedToolNames list rather than creating a distinct tool resource.

uip agenthub mcp-tools list

Opções
LongValorDescription
--mcp <slug>StringRequired. Parent MCP server slug.
--name <substr>StringFilter by name substring.
--limit <number> / --offset <number>Número inteiroPaging.
Exemplo
uip agenthub mcp-tools list --mcp invoice-mcp
uip agenthub mcp-tools list --mcp invoice-mcp
Formato dos dados (--output json)
{ "Code": "AgentHubMcpToolsList", "Data": { "items": [], "total": 0, "count": 0 } }
{ "Code": "AgentHubMcpToolsList", "Data": { "items": [], "total": 0, "count": 0 } }

uip agenthub mcp-tools get

Get one tool by id or by --name lookup.

Argumentos
NameRequiredFinalidade
[id]nãoTool id. Omit when using --name.
Opções
LongValorDescription
--mcp <slug>StringRequired. Parent MCP server slug.
--name <name>StringLookup by name substring. Fails if it matches other than exactly one tool, unless --allow-multiple is passed.
--allow-multipleBandeiraReturn every name match instead of failing on ambiguity.

Passing neither <id> nor --name fails with a NextCommand hint pointing at mcp-tools list.

Exemplo
uip agenthub mcp-tools get --mcp invoice-mcp tool-1
uip agenthub mcp-tools get --mcp invoice-mcp tool-1
Formato dos dados (--output json)
{ "Code": "AgentHubMcpToolsGet", "Data": { "id": "tool-1", "name": "CreateInvoice" } }
{ "Code": "AgentHubMcpToolsGet", "Data": { "id": "tool-1", "name": "CreateInvoice" } }

uip agenthub mcp-tools create-resource / create-raw

Add a tool to a uipath-type MCP server. Requires the parent to actually be uipath-typed — fails with a NextCommand hint (pointing at refresh-tools or mcp-tools enable, depending on the real type) otherwise.

Opções
LongValorAplicávelADescription
--mcp <slug>StringAmbosRequired. Parent MCP server slug (must resolve to a uipath-type server).
--name <name>StringAmbosTool name.
--description <text>StringAmbosTool description.
--target-name <name>Stringcreate-resourceResolve the target by display name via the Resource Catalog Service. Requires --category. Fails as AmbiguousName (with a candidates list) if more than one match, UnknownTarget if none.
--target-identifier <guid>GUIDcreate-resourceExplicit target identifier — skips RCS name resolution. Wins over --target-name if both are given.
--category <category>automation|agent|agentic-process|api-workflowcreate-resourceMaps to an RCS entity-type/sub-type filter pair (automation→Process, agent→Agent, agentic-process→ProcessOrchestration, api-workflow→Api). Required with --target-name.
--target-folder-key <key> / --target-folder-path <path>GUID / stringAmbosFolder of the target resource, when it differs from the MCP server's own folder. An explicit value here always wins over one resolved from an RCS candidate or a payload field.
--input-schema <json> / --output-schema <json> / --metadata <json>JSONAmbosTool schema/metadata. Validated as parseable JSON strings before the call.
--continue-on-error (default) / --fail-fastBandeiraAmbosBatch-failure behavior (registered but not exercised by a single-tool create).
--file <path> / --body <json>path / JSONcreate-raw (required — no scalar mode)Raw tool payload. create-raw has no equivalent scalar-flag input mode; --file/--body is the only way to supply content.
--dry-runBandeiraAmbosPrint the mutation plan without calling the API.
Exemplos
uip agenthub mcp-tools create-resource --mcp invoice-mcp --category automation \
  --target-name InvoiceProcess --folder-key f1f2f3f4-0000-0000-0000-000000000001

uip agenthub mcp-tools create-raw --mcp invoice-mcp --file ./tool.json \
  --folder-key f1f2f3f4-0000-0000-0000-000000000001
uip agenthub mcp-tools create-resource --mcp invoice-mcp --category automation \
  --target-name InvoiceProcess --folder-key f1f2f3f4-0000-0000-0000-000000000001

uip agenthub mcp-tools create-raw --mcp invoice-mcp --file ./tool.json \
  --folder-key f1f2f3f4-0000-0000-0000-000000000001
Formato dos dados (--output json)
{ "Code": "AgentHubMcpToolsCreate", "Data": { "id": "tool-1", "name": "InvoiceProcess" } }
{ "Code": "AgentHubMcpToolsCreate", "Data": { "id": "tool-1", "name": "InvoiceProcess" } }

uip agenthub mcp-tools update

Update one or more tools (via --allow-multiple with a --name match) on a uipath-type server.

Argumentos
NameRequiredFinalidade
[id]nãoTool id. Omit when using --name.
Opções
LongValorDescription
--mcp <slug>StringRequired. Parent MCP server slug.
--name <substr>StringLookup flag (selects which tool to update) — not a rename. Use --rename for that.
--allow-multipleBandeiraApply the update to every --name match instead of failing on ambiguity.
--rename <name>StringNew tool name.
--description <text> / --target-identifier <guid> / --target-folder-key <key> / --target-folder-path <path> / --input-schema <json> / --output-schema <json> / --metadata <json>Same semantics as the create-resource/create-raw fields above.
Exemplos
uip agenthub mcp-tools update tool-1 --mcp invoice-mcp --rename CreateInvoice
uip agenthub mcp-tools update --mcp invoice-mcp --name LegacyTool --rename NewTool
uip agenthub mcp-tools update tool-1 --mcp invoice-mcp --rename CreateInvoice
uip agenthub mcp-tools update --mcp invoice-mcp --name LegacyTool --rename NewTool
Formato dos dados (--output json)
{ "Code": "AgentHubMcpToolsUpdate", "Data": { "id": "tool-1", "name": "NewTool" } }
{ "Code": "AgentHubMcpToolsUpdate", "Data": { "id": "tool-1", "name": "NewTool" } }

A single-id update returns one object; an --allow-multiple update returns an array.

uip agenthub mcp-tools delete

Argumentos
NameRequiredFinalidade
[ids...]nãoTool id(s). Omit when using --name.
Opções
LongDescription
--mcp <slug>Required. Parent MCP server slug.
--name <substr>Lookup by name substring instead of id(s).
--allow-multipleDelete every name match instead of failing on ambiguity.
-y, --yesRequired to confirm. The CLI never prompts.
--dry-runPrint the mutation plan without deleting.
Exemplo
uip agenthub mcp-tools delete --mcp invoice-mcp tool-1 -y
uip agenthub mcp-tools delete --mcp invoice-mcp tool-1 -y
Formato dos dados (--output json)
{ "Code": "AgentHubMcpToolsDelete", "Data": { "ids": ["tool-1"], "deleted": true } }
{ "Code": "AgentHubMcpToolsDelete", "Data": { "ids": ["tool-1"], "deleted": true } }

uip agenthub mcp-tools template

Emit a resource-tool JSON skeleton. No folder options.

Argumentos
NameRequiredFinalidade
<kind>simresource ou raw.
Exemplo
uip agenthub mcp-tools template resource
uip agenthub mcp-tools template resource
Formato dos dados (--output json)
{ "Code": "AgentHubMcpToolsTemplate", "Data": { "type": 0, "name": "resource-tool", "processType": "automation", "targetIdentifier": "resource-id", "targetFolderKey": "folder-guid" } }
{ "Code": "AgentHubMcpToolsTemplate", "Data": { "type": 0, "name": "resource-tool", "processType": "automation", "targetIdentifier": "resource-id", "targetFolderKey": "folder-guid" } }

uip agenthub mcp-tools candidates

List Resource Catalog Service entities eligible for create-resource --target-name/--target-identifier resolution, for one category.

Opções
LongValorRequiredDescription
--category <category>automation|agent|agentic-process|api-workflowsimCandidate source category. Missing/invalid values fail client-side listing the allowed set.
--name <substr>StringnãoFilter candidate name.
--limit <number> / --offset <number>Número inteironãoPaging.

Requires the RCS.Search scope — a 401/invalid-scope error includes an instruction to re-run uip login and retry.

Exemplo
uip agenthub mcp-tools candidates --category automation
uip agenthub mcp-tools candidates --category automation
Formato dos dados (--output json)
{ "Code": "AgentHubMcpToolsCandidates", "Data": { "items": [], "total": 0, "count": 0, "category": "automation" } }
{ "Code": "AgentHubMcpToolsCandidates", "Data": { "items": [], "total": 0, "count": 0, "category": "automation" } }

uip agenthub mcp-tools enable / disable

Toggle tool membership on a platform-type MCP server's selectedToolNames list. Fails if the parent server is not platform-typed.

Opções
LongValorDescription
--mcp <slug>StringRequired. Parent MCP server slug (must be platform-typed).
--name <name>string, repeatableTool name(s) to enable/disable. Alternatively pass --file/--body with a JSON array or single name.
--dry-runBandeiraPrint the mutation plan without calling the API.
Exemplos
uip agenthub mcp-tools enable --mcp orch-mcp --name CreateAsset
uip agenthub mcp-tools disable --mcp orch-mcp --name CreateAsset
uip agenthub mcp-tools enable --mcp orch-mcp --name CreateAsset
uip agenthub mcp-tools disable --mcp orch-mcp --name CreateAsset
Formato dos dados (--output json)
{ "Code": "AgentHubMcpToolsEnable", "Data": { "slug": "orch-mcp", "selectedToolNames": ["CreateAsset"] } }
{ "Code": "AgentHubMcpToolsEnable", "Data": { "slug": "orch-mcp", "selectedToolNames": ["CreateAsset"] } }

disable's equivalent Code is AgentHubMcpToolsDisable; the response reflects selectedToolNames after removal.

uip agenthub remote-a2a-agent

Manage remote agent-to-agent (A2A) registrations — described in source as "Advanced - not exposed in Orchestrator UI." Unrelated to MCP servers; carries its own agent-card metadata (name, description, a card URL or raw card JSON), optional static headers, an Integration Service connection id, and an activation flag. Folder-scoped like the rest of AgentHub.

uip agenthub remote-a2a-agent list

Opções
LongValorDescription
--name <substr>StringFilter by name substring (server-side search param).
--limit <number> / --offset <number>Número inteiroPaging (top/skip on the wire).
Exemplo
uip agenthub remote-a2a-agent list
uip agenthub remote-a2a-agent list
Formato dos dados (--output json)
{ "Code": "AgentHubRemoteA2aAgentList", "Data": { "items": [] } }
{ "Code": "AgentHubRemoteA2aAgentList", "Data": { "items": [] } }

uip agenthub remote-a2a-agent get

Argumentos
NameRequiredFinalidade
<slug>simAgent slug.
Exemplo
uip agenthub remote-a2a-agent get remote-agent
uip agenthub remote-a2a-agent get remote-agent
Formato dos dados (--output json)
{ "Code": "AgentHubRemoteA2aAgentGet", "Data": { "slug": "remote-agent" } }
{ "Code": "AgentHubRemoteA2aAgentGet", "Data": { "slug": "remote-agent" } }

uip agenthub remote-a2a-agent create

Opções
LongValorDescription
--slug <slug> / --name <name> / --description <text>StringCampos de identidade do agente.
--agent-card-url <url>urlAgent card URL.
--agent-card-json <json>JSONRaw agent card JSON, as an alternative to a URL.
--header <key=value>string, repeatableStatic request header. JSON-stringified into headers on the payload.
--connection-id <id>StringIntegration Service connection id.
--use-relayBandeiraRoute requests through UiPath Relay.
--file <path> / --body <json>path / JSONAlternative to scalar flags — same mutually-exclusive input-mode rule as mcp create.
--dry-runBandeiraPrint the mutation plan without calling the API.
Exemplo
uip agenthub remote-a2a-agent create --name RemoteAgent --slug remote-agent
uip agenthub remote-a2a-agent create --name RemoteAgent --slug remote-agent
Formato dos dados (--output json)
{ "Code": "AgentHubRemoteA2aAgentCreate", "Data": { "slug": "remote-agent" } }
{ "Code": "AgentHubRemoteA2aAgentCreate", "Data": { "slug": "remote-agent" } }

uip agenthub remote-a2a-agent update

Same fields as create (minus --slug, which is the positional argument), plus:

LongValorDescription
--is-active <boolean>true|falseActivation state. Rejects any other literal value with an argument-parsing error.
Argumentos
NameRequiredFinalidade
<slug>simAgent slug.
Exemplo
uip agenthub remote-a2a-agent update remote-agent --name RemoteAgent
uip agenthub remote-a2a-agent update remote-agent --name RemoteAgent
Formato dos dados (--output json)
{ "Code": "AgentHubRemoteA2aAgentUpdate", "Data": { "slug": "remote-agent" } }
{ "Code": "AgentHubRemoteA2aAgentUpdate", "Data": { "slug": "remote-agent" } }

uip agenthub remote-a2a-agent delete

Argumentos
NameRequiredFinalidade
<slug>simAgent slug.
Opções
LongDescription
-y, --yesRequired to confirm. The CLI never prompts.
--dry-runPrint the mutation plan without deleting.
Exemplo
uip agenthub remote-a2a-agent delete remote-agent -y
uip agenthub remote-a2a-agent delete remote-agent -y
Formato dos dados (--output json)
{ "Code": "AgentHubRemoteA2aAgentDelete", "Data": { "slug": "remote-agent", "deleted": true } }
{ "Code": "AgentHubRemoteA2aAgentDelete", "Data": { "slug": "remote-agent", "deleted": true } }

uip agenthub remote-a2a-agent refresh-card

Re-fetch and refresh a remote agent's card metadata.

Argumentos
NameRequiredFinalidade
<slug>simAgent slug.
Opções
LongDescription
--dry-runPrint the mutation plan without refreshing.
Exemplo
uip agenthub remote-a2a-agent refresh-card remote-agent
uip agenthub remote-a2a-agent refresh-card remote-agent
Formato dos dados (--output json)
{ "Code": "AgentHubRemoteA2aAgentRefreshCard", "Data": { "slug": "remote-agent" } }
{ "Code": "AgentHubRemoteA2aAgentRefreshCard", "Data": { "slug": "remote-agent" } }

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