> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Ferramentas do MCP da Square Cloud

> As 49 ferramentas do servidor MCP da Square Cloud por área e o escopo de que cada uma precisa.

O servidor MCP tem 49 ferramentas. Um cliente vê apenas as que os [escopos](https://docs.squarecloud.app/pt-br/mcp/permissions-and-safety.md#escopos) da chave dele cobrem. As ferramentas identificam uma aplicação pelo ID, pelo nome exato ou pelo hostname, e um banco de dados pelo ID ou pelo nome. Toda ferramenta responde JSON com `ok`, um `summary` e, quando algo falhou ou precisa de você, um `code`.

Toda ferramenta [roda na hora](https://docs.squarecloud.app/pt-br/mcp/permissions-and-safety.md#toda-mudança-roda-na-hora). Excluir uma aplicação ou um banco de dados e restaurar um snapshot tiram um [snapshot de segurança](https://docs.squarecloud.app/pt-br/mcp/permissions-and-safety.md#exclusões-e-restaurações) antes.

## Aplicações

| Ferramenta | O que faz | Escopo |
| - | - | - |
| `list_applications` | Lista suas aplicações (ID, nome, linguagem, se está rodando, domínio), 100 por página. | `apps:read` |
| `get_application_status` | Status ao vivo de uma aplicação: CPU, RAM, uptime, endereço, domínio personalizado, memória e reinício automático. | `apps:read` |
| `get_all_applications_status` | Se cada uma das suas aplicações está rodando, em uma única chamada. | `apps:read` |
| `get_application_logs` | Os logs mais recentes de uma aplicação, cerca dos últimos 4.000 caracteres. | `apps:read` |
| `get_deployments` | Histórico de deploys via Git (GitHub App ou webhook) de uma aplicação: commit, branch, resultado, duração e o erro de um deploy que falhou. | `apps:read` |
| `get_metrics_history` | Histórico de CPU e RAM de uma aplicação ou de um banco de dados, com valores médio, de pico e mais recente. 24 horas, ou 7 dias no Pro e no Enterprise (numa aplicação, só com 512 MB ou mais). | `apps:read` ou `databases:read` |
| `start_application` | Inicia uma aplicação parada. | `apps:control` |
| `stop_application` | Para uma aplicação em execução. | `apps:control` |
| `restart_application` | Reinicia uma aplicação, o que também aplica mudanças de arquivos e de configuração. | `apps:control` |
| `create_application` | Cria e faz deploy de uma nova aplicação a partir de um modelo inicial (Node.js, Python, site estático, Go, Rust, Elixir, .NET, PHP ou Ruby), opcionalmente com os seus primeiros arquivos. | `apps:write` |
| `upload_application` | Cria e faz deploy de uma nova aplicação a partir de um zip de um projeto que você já tem, enviado em base64 (até 1 MB). O [arquivo de configuração](https://docs.squarecloud.app/pt-br/getting-started/config-file.md) `squarecloud.app` precisa ficar na raiz do zip, não dentro de uma pasta. | `apps:write` |
| `commit_application` | Envia uma nova versão para uma aplicação existente, como arquivos de texto ou como zip (até 1 MB), para uma pasta que você escolhe (a raiz, por padrão). Arquivos com o mesmo nome são substituídos e nada mais é apagado. Não reinicia a aplicação e, com `snapshot`, tira um snapshot antes. | `files:write` (com `snapshot`, também `snapshots:write`) |
| `delete_application` | Exclui uma aplicação, com um snapshot de segurança antes. | `apps:write` |

## Arquivos e configuração

| Ferramenta | O que faz | Escopo |
| - | - | - |
| `list_files` | Lista uma pasta de uma aplicação. | `files:read` |
| `read_file` | Lê um arquivo de texto de até 10 MB, página por página. | `files:read` |
| `search_files` | Busca um texto ou uma expressão regular nos arquivos de uma aplicação, ignorando `node_modules`, `.git`, saída de build, arquivos de lock e binários. | `files:read` |
| `create_file` | Grava um arquivo com o conteúdo completo (até 128 KB), criando as pastas dele. Substitui um arquivo que já existe. | `files:write` |
| `edit_file` | Substitui o conteúdo de um arquivo existente (até 128 KB). | `files:write` |
| `patch_file` | Edita um arquivo de até 10 MB com edições exatas de localizar e substituir. Se uma edição não encontrar o trecho, nada é gravado. | `files:write` |
| `rename_file` | Renomeia ou move um arquivo ou uma pasta. | `files:write` |
| `delete_file` | Exclui um arquivo ou uma pasta. Recusa a raiz da aplicação, o arquivo de configuração e arquivos `.env`. | `files:write` |
| `edit_config_file` | Altera o [arquivo de configuração](https://docs.squarecloud.app/pt-br/getting-started/config-file.md) campo por campo: nome de exibição, descrição, memória, reinício automático, subdomínio, `MAIN` e `START`. | `files:write` |

As mudanças em arquivos valem a partir do próximo reinício. No arquivo de configuração, memória e subdomínio valem na hora, e `MAIN` e `START` no próximo reinício.

## Variáveis de ambiente

| Ferramenta | O que faz | Escopo |
| - | - | - |
| `list_env_vars` | Lista os nomes das variáveis de ambiente de uma aplicação, nunca os valores. | `envs:read` |
| `set_env_vars` | Adiciona, altera ou remove variáveis em uma única chamada, com reinício opcional. | `envs:write` (com `restart`, também `apps:control`) |

## Snapshots

| Ferramenta | O que faz | Escopo |
| - | - | - |
| `list_snapshots` | Snapshots de uma aplicação ou de um banco de dados, do mais novo para o mais antigo. Sem um alvo, uma visão geral da conta, incluindo aplicações excluídas cujos snapshots ainda existem. | `snapshots:read` |
| `create_snapshot` | Tira um snapshot de uma aplicação ou de um banco de dados. Conta para o limite diário de snapshots do seu plano. | `snapshots:write` |
| `restore_snapshot` | Restaura uma aplicação ou um banco de dados existente para um snapshot, depois de um snapshot do estado atual. | `snapshots:write` |

## Bancos de dados

| Ferramenta | O que faz | Escopo |
| - | - | - |
| `list_databases` | Lista seus bancos de dados (ID, nome, engine, RAM, host, porta, se está rodando). | `databases:read` |
| `create_database` | Cria um banco de dados (planos Standard e acima), o que leva até cerca de 90 segundos. Com `connect_to_app`, também grava a URL de conexão e o arquivo de certificado em uma aplicação. | `databases:write` (com `connect_to_app`, também `databases:credentials` e `envs:write`) |
| `start_database` | Inicia um banco de dados parado. | `databases:write` |
| `stop_database` | Para um banco de dados em execução. As aplicações que o usam perdem a conexão até ele iniciar de novo. | `databases:write` |
| `update_database` | Altera a RAM de um banco de dados, aplicada ao vivo. | `databases:write` |
| `connect_database` | Conecta um banco de dados existente a uma aplicação: troca a senha dele, grava a nova URL e o certificado na aplicação e atualiza as outras aplicações que o usam. | `databases:credentials` e `envs:write` |
| `rotate_database_credentials` | Troca a senha ou o certificado TLS de um banco de dados e informa as aplicações que atualizou. | `databases:credentials` e `envs:write` |
| `delete_database` | Exclui um banco de dados e os dados dele, com um snapshot de segurança antes. | `databases:write` |

## Domínios e rede

As ferramentas de rede funcionam em sites (aplicações com um domínio), em janelas de até 7 dias.

| Ferramenta | O que faz | Escopo |
| - | - | - |
| `list_account_domains` | Todos os domínios de todas as aplicações: endereços `squareweb.app` e domínios personalizados, 100 por página. | `apps:read` |
| `list_dns_records` | Os registros DNS a criar para o domínio personalizado de uma aplicação, com o status de cada um. | `apps:read` |
| `set_custom_domain` | Conecta, substitui ou remove o domínio personalizado de uma aplicação e retorna os registros DNS a criar. | `apps:write` |
| `purge_network_cache` | Limpa o cache da borda de até 50 aplicações em uma única chamada. | `apps:write` |
| `get_network_analytics` | Tráfego da borda: requisições, visitas e bytes, com detalhamento por país, caminho, referenciador, dispositivo e mais. | `apps:read` |
| `get_network_errors` | Erros HTTP da borda por código de status, caminho e método. 5xx por padrão, 4xx quando pedido. | `apps:read` |
| `get_network_performance` | Tempo até o primeiro byte e tempo de resposta da origem (p50, p95, p99) e os caminhos mais lentos. Pro e Enterprise. | `apps:read` |
| `get_network_logs` | As 40 requisições mais recentes na borda, com endereços IP mascarados. Pro e Enterprise. | `apps:read` |

## Workspaces

| Ferramenta | O que faz | Escopo |
| - | - | - |
| `list_workspaces` | Os workspaces dos quais você é dono ou participa, com membros e aplicações compartilhadas. Somente leitura: as outras ferramentas alcançam apenas as suas próprias aplicações. | `workspaces:manage` |

## Ajuda e status

Estas ferramentas precisam apenas do escopo `mcp`.

| Ferramenta | O que faz | Escopo |
| - | - | - |
| `get_platform_knowledge` | A referência da própria Square Cloud sobre limites, planos, códigos de erro e configuração. | `mcp` |
| `search_help_center` | Busca na [central de ajuda](https://help.squarecloud.app) ou lê um dos artigos dela. | `mcp` |
| `list_help_center` | Lista todos os artigos da central de ajuda por categoria. | `mcp` |
| `get_platform_status` | O status dos serviços da Square Cloud e dos provedores dos quais eles dependem. | `mcp` |
| `get_discord_status` | O status do próprio Discord e a latência da API dele, para distinguir uma instabilidade do Discord de um problema no bot. | `mcp` |

## O que ficou de fora de propósito

| Não disponível | Por quê | Em vez disso |
| - | - | - |
| Baixar snapshots | O link assinado contém o seu código e as suas variáveis de ambiente, e iria parar na conversa e no provedor do modelo de IA. | Baixe pelo dashboard. |
| Baixar certificados de banco de dados | Pelo mesmo motivo: o certificado sairia da Square Cloud pelo modelo. | Baixe pelo dashboard. |
| Atividade da conta | Ela mostra os endereços IP e os dispositivos da sua conta. | Veja o seu [feed de atividades](https://squarecloud.app/pt-br/dashboard/activity). |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.