Docs/ Assistente IA/ Referência de Ferramentas

Referência de Ferramentas

Referência completa para todas as 103 ferramentas IA expostas pelo servidor MCP. Cada ferramenta inclui seu nível de risco, parâmetros e exemplo de uso.

Risk Levels

Cada ferramenta é classificada por nível de risco. O risco determina qual escopo de chave API é necessário para executá-la.

RiscoEscopo NecessárioDescrição
readread / standard / adminConsultas seguras. Sem alterações de estado.
writestandard / adminModifica estado (reinícios, deploys, comandos sandbox).
destructivesomente adminOperações irreversíveis. Requer token de confirmação.

Ferramentas de Leitura (37)

list_apps

Listar todas as aplicações implantadas com status, stack e uso de recursos.

ParâmetroTipoObrigatórioDescrição
pageintegerNoNúmero da página (padrão: 1)
per_pageintegerNoResultados por página (padrão: 20, máx: 100)

get_app

Obter informações detalhadas sobre uma aplicação específica incluindo domínios, contagem de variáveis de ambiente, status de deploy e configuração de recursos.

ParâmetroTipoObrigatórioDescrição
app_idstringYesID do app ou nome do app

get_server_status

Obter saúde do servidor incluindo versão, uptime, contagem de apps e status de conectividade Docker. Sem parâmetros.

list_deployments

Listar histórico de deploys para uma aplicação.

ParâmetroTipoObrigatórioDescrição
app_idstringYesID do app ou nome do app

get_deployment_logs

Obter logs de build para um deploy específico.

ParâmetroTipoObrigatórioDescrição
deployment_idstringYesID do deploy

get_app_logs

Obter logs recentes do container para uma aplicação em execução.

ParâmetroTipoObrigatórioDescrição
app_idstringYesID do app ou nome do app
linesintegerNoNúmero de linhas (padrão: 200, máx: 1000)

list_databases

Listar todos os bancos de dados provisionados. Sem parâmetros.

list_cron_jobs

Listar todos os cron jobs agendados. Sem parâmetros.

list_backups

Listar todos os registros de backup. Sem parâmetros.

list_domains

Listar domínios configurados para uma aplicação.

ParâmetroTipoObrigatórioDescrição
app_idstringYesID do app ou nome do app

list_alerts

Listar todas as regras de alerta. Sem parâmetros.

server_metrics

Obter métricas de recursos do servidor: CPU, memória, uso de disco e I/O de rede. Sem parâmetros.

list_database_servers

List all database servers with their status, engine, and version.

get_database_server

Get detailed information about a specific database server. Param: server_id (string, required).

get_db_connection_info

Get connection details (host, port, credentials) for a database server. Param: server_id (string, required).

list_auth_servers

List all authentication servers (Logto instances).

list_realtime_servers

List all realtime servers (Centrifugo instances).

list_function_servers

List all function servers (Deno Deploy instances).

list_mail_domains

List all mail domains and their status.

list_storage_instances

List all file storage instances (MinIO).

list_uptime_checks

List all uptime monitoring checks.

list_nodes

List all registered server nodes in the cluster.

list_projects

List all projects and their resource counts.

Plus 18 more read tools for getting details on individual auth servers, realtime servers, function servers, mail domains, mailboxes, aliases, storage instances, buckets, access keys, usage, uptime checks, incidents, nodes, and project members. All follow the same pattern with a required ID parameter.

Ferramentas de Escrita (44)

Estas ferramentas modificam o estado do servidor. Requerem chave API com escopo standard ou admin.

restart_app

Reiniciar o container de uma aplicação (principal + réplicas).

ParâmetroTipoObrigatórioDescrição
app_idstringYesID do app ou nome do app

deploy_app

Acionar um novo deploy para uma aplicação.

ParâmetroTipoObrigatórioDescrição
app_idstringYesID do app ou nome do app

scale_app

Alterar a contagem de réplicas para uma aplicação.

ParâmetroTipoObrigatórioDescrição
app_idstringYesID do app ou nome do app
replicasintegerYesNúmero de réplicas (1-50)

trigger_backup

Acionar um job de backup imediatamente.

ParâmetroTipoObrigatórioDescrição
backup_idstringYesID de configuração de backup

trigger_cron

Executar um cron job imediatamente (fora do agendamento).

ParâmetroTipoObrigatórioDescrição
cron_idstringYesID do cron job

sandbox_exec_command

Executar um comando no container AI sandbox do app. O sandbox é um ambiente Alpine Linux completo com acesso root, rede compartilhada e volumes graváveis. Timeout de 5 minutos, limite de saída de 100KB.

ParâmetroTipoObrigatórioDescrição
app_idstringYesID do app ou nome do app
commandstringYesComando shell a executar
Example
{"name": "sandbox_exec_command", "arguments": {"app_id": "my-app", "command": "curl -s localhost:3000/health"}}
Note
Requer sandbox_enabled: true no app. Habilite nas Settings do app ou via PATCH /api/v1/apps/:id.

create_database_server

Create a new database server (PostgreSQL, MySQL, MariaDB, or Redis). Params: name, engine, version (optional).

start_* / stop_*

Start or stop database servers, auth servers, realtime servers, and function servers. Each takes a server_id parameter.

create_* (service resources)

Create auth servers, realtime servers, function servers, mail domains, mailboxes, aliases, storage instances, buckets, access keys, uptime checks, nodes, and projects. Each follows the same pattern with resource-specific required parameters.

28 new write tools for creating and managing all service types. All require standard or admin API key scope.

Ferramentas Destrutivas (16)

Operações irreversíveis que requerem uma chave API com escopo admin e um fluxo de confirmação em duas etapas.

Warning
Ferramentas destrutivas não executam imediatamente. Elas retornam um token de confirmação de uso único (válido por 5 minutos). A IA deve então chamar confirm_action com esse token para prosseguir. Isso previne exclusão acidental.

delete_app

Excluir uma aplicação, seus containers e opcionalmente seus volumes. Retorna um token de confirmação.

ParâmetroTipoObrigatórioDescrição
app_idstringYesID do app ou nome do app

delete_database

Excluir um banco de dados provisionado. Retorna um token de confirmação.

ParâmetroTipoObrigatórioDescrição
database_idstringYesID do banco de dados

confirm_action

Confirmar e executar uma ação destrutiva pendente usando o token retornado por delete_app ou delete_database.

ParâmetroTipoObrigatórioDescrição
tokenstringYesToken de confirmação (uso único, TTL de 5 minutos)

delete_* (services)

Delete database servers, auth servers, realtime servers, function servers, mail domains, storage instances, uptime checks, nodes, and projects. All require confirmation and admin API key scope. 9 new destructive tools in total.

Ferramentas do Sandbox (5)

Estas ferramentas interagem com o container AI sandbox. Todas requerem sandbox_enabled: true no app alvo. sandbox_exec_command está documentado acima em Ferramentas de Escrita. As 4 restantes são ferramentas de risco de leitura.

sandbox_read_file

Ler um arquivo dos volumes montados do app via sandbox. Retorna até 100KB.

ParâmetroTipoObrigatórioDescrição
app_idstringYesID do app ou nome do app
pathstringYesCaminho absoluto do arquivo (ex.: /app/config.yml)
Example
{"name": "sandbox_read_file", "arguments": {"app_id": "my-app", "path": "/app/package.json"}}

sandbox_list_processes

Listar processos em execução dentro do container da aplicação (executa ps aux no container do app, não no sandbox).

ParâmetroTipoObrigatórioDescrição
app_idstringYesID do app ou nome do app

sandbox_check_connectivity

Testar conectividade de rede a partir do sandbox. Usa nc para verificações de porta TCP ou curl para HTTP.

ParâmetroTipoObrigatórioDescrição
app_idstringYesID do app ou nome do app
targetstringYesHostname ou IP (ex.: db, redis, localhost)
portintegerNoNúmero da porta. Se omitido, usa HTTP (curl).
Example (TCP)
{"name": "sandbox_check_connectivity", "arguments": {"app_id": "my-app", "target": "db", "port": 5432}}

sandbox_status

Verificar o estado do sandbox para uma aplicação. Retorna se o sandbox está habilitado, rodando e seu ID de container.

ParâmetroTipoObrigatórioDescrição
app_idstringYesID do app ou nome do app