UiPath Documentation
uipath-cli
latest
false
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.

Guia do usuário da UiPath CLI

UIP MCP

uip mcp a CLI como um servidor de protocolo de contexto do modelo , permitindo que os clientes sensíveis ao MCP (hosts Claude Desktop, Cursor, VS Code MCP, etc.) invoquem qualquer subcomando uip como uma ferramenta.

Observação:

As habilidades são o principal caminho para ensinar agentes de codificação de IA a usar a UiPath CLI — consulte uip skills e Habilidades. O MCP é fornecido como uma alternativa para clientes que não oferecem suporte a habilidades ou que preferem a invocação de ferramentas no estilo de MCP. Se seu agente for compatível com habilidades, prefira habilidades.

Resumo

uip mcp serve
uip mcp serve

uip mcp serve honra as opções globais (--output, --output-filter, --log-level, --log-file) para o próprio processo do servidor; a ferramenta que expõe para os clientes aceita qualquer string de comando da CLI e retorna seu stdout/stderr combinado. Os códigos de saída seguem o contrato padrão.

serviço uip mcp

Inicia o servidor MCP no estdio (JSON-RPC delimitado por nova linha). Não há receptor de rede, nenhum transporte HTTP e nenhuma configuração de porta — o stdio é o único transporte compatível com o 1.x.

Argumentos

Nenhum.

Opções

Nenhum. O servidor é executado até que o transporte stdio seja fechado pelo cliente (geralmente quando o aplicativo do host é encerrado).

Comportamento

  • O servidor anuncia uma única ferramenta, run_command, que aceita um argumento:
    • command string) — O comando da CLI a ser executado, sem o prefixo uip . Exemplo: "login status --output json".
  • O servidor enumera cada subcomando uip instalado na inicialização e inclui um catálogo de comando renderizado na descrição da ferramenta MCP. Os subcomandos mcp e help são excluídos desse catálogo — o cliente não pode pedir ao servidor para iniciar outro servidor MCP.
  • Em run_command chamada, a CLI executa o comando solicitado em uma invocação de filho e retorna o stdout/stderr combinado. Se o filho sair diferente de zero ou se ele gravou um envelope de erro no stderr com um código de saída zero (um caso raro em que um comando relata falha sem alterar o código de saída), o resultado será sinalizado isError: true e prefixado com Error (exit code N):.

Exemplo (iniciando o servidor a partir de um shell — normalmente seu cliente MCP inicia isso para você):

uip mcp serve
uip mcp serve

Configuração de um cliente MCP

Todas as configurações usam o mesmo comando/argumentos. O nome do servidor (uipath abaixo) é arbitrário.

Claude Desktop — editar claude_desktop_config.json:

  • MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "uipath": {
      "command": "uip",
      "args": ["mcp", "serve"]
    }
  }
}
{
  "mcpServers": {
    "uipath": {
      "command": "uip",
      "args": ["mcp", "serve"]
    }
  }
}

Reinicie o Claude Desktop depois de salvar.

Claude Code — adicione por meio de sua CLI:

claude mcp add uipath -- uip mcp serve
claude mcp add uipath -- uip mcp serve

Cursor — edite .cursor/mcp.json (projeto-local) ou a configuração global de MCP do Cursor:

{
  "mcpServers": {
    "uipath": {
      "command": "uip",
      "args": ["mcp", "serve"]
    }
  }
}
{
  "mcpServers": {
    "uipath": {
      "command": "uip",
      "args": ["mcp", "serve"]
    }
  }
}

Código do VS — editar .vscode/mcp.json:

{
  "servers": {
    "uipath": {
      "command": "uip",
      "args": ["mcp", "serve"]
    }
  }
}
{
  "servers": {
    "uipath": {
      "command": "uip",
      "args": ["mcp", "serve"]
    }
  }
}

Ciclo de vida

O servidor MCP não tem comando de parada independente. Ele reside como um processo filho do cliente MCP e sai quando:

  • o cliente encerra a conexão do Studio,
  • o aplicativo do host será encerrado ou
  • você remove a entrada do servidor da configuração do cliente e recarrega.

Autenticação e contexto do tenant

uip mcp serve não gerencia credenciais. Cada invocação de run_command lê a mesma sessão armazenada que um shell interativo faria — então você deve ter executado uip login separadamente antes de pedir ao agente para chamar comandos que exigem autenticação. Se não existir nenhuma sessão, o resultado da ferramenta conterá a carga útil AuthenticationError habitual (consulte Códigos de saída).

Formato dos dados

Os resultados da ferramenta seguem o contrato de chamada de ferramenta do MCP. No sucesso:

{
  "content": [
    { "type": "text", "text": "<combined stdout/stderr>" }
  ],
  "isError": false
}
{
  "content": [
    { "type": "text", "text": "<combined stdout/stderr>" }
  ],
  "isError": false
}

Na falha, isError é true e text tem o prefixo Error (exit code N):. O texto interno é a saída normal da CLI (JSON se o chamador solicitou --output json, caso contrário, o formato padrão).

Considerações

  • Sempre solicite JSON de dentro de chamadas MCP. Passe --output json na string command para que o agente receba dados estruturados em vez de tabelas.
  • Sem filtragem de comandos destrutivos. A ferramenta pode invocar qualquer subcomando run_command , incluindo uip , tools uninstall e ferramentas que alteram logout estado do Orchestrator. Trate o servidor MCP como um shell autenticado e restrinja o agente adequadamente.
  • help e mcp estão ocultos do catálogo , mas ainda podem ser invocados pelo cliente. Nada impede que mcp serve seja chamado recursivamente por meio de outro run_command; na prática, esta é uma operação sem operação porque o servidor externo controla o Studio.
  • uip skills — caminho de integração de IA principal.
  • Habilidades — por que as habilidades são preferidas ao acesso ao MCP bruto para ergonomia do agente.
  • Autenticação — a sessão run_command herda.
  • Opções globais--output json dentro de chamadas MCP.

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