> ## 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.

# Square Cloud MCP tools

> The 49 tools of the Square Cloud MCP server by area and the scope each one needs.

The MCP server has 49 tools. A client sees only the ones its key's [scopes](https://docs.squarecloud.app/en/mcp/permissions-and-safety.md#scopes) cover. Tools name an application by its ID, exact name or hostname, and a database by its ID or name. Every tool answers JSON with `ok`, a `summary` and, when something failed or needs you, a `code`.

Every tool [runs at once](https://docs.squarecloud.app/en/mcp/permissions-and-safety.md#every-change-runs-at-once). Deleting an application or a database and restoring a snapshot take a [safety snapshot](https://docs.squarecloud.app/en/mcp/permissions-and-safety.md#deletions-and-restores) first.

## Applications

| Tool | What it does | Scope |
| - | - | - |
| `list_applications` | Lists your applications (ID, name, language, running or not, domain), 100 per page. | `apps:read` |
| `get_application_status` | Live status of one application: CPU, RAM, uptime, address, custom domain, memory and automatic restart. | `apps:read` |
| `get_all_applications_status` | Whether each of your applications is running, in one call. | `apps:read` |
| `get_application_logs` | The latest logs of one application, about the last 4,000 characters. | `apps:read` |
| `get_deployments` | Git deploy history (GitHub App or webhook) of one application: commit, branch, result, duration and the error of a failed deploy. | `apps:read` |
| `get_metrics_history` | CPU and RAM history of one application or database, with average, peak and latest values. 24 hours, or 7 days on Pro and Enterprise (for an application, only one with 512 MB or more). | `apps:read` or `databases:read` |
| `start_application` | Starts a stopped application. | `apps:control` |
| `stop_application` | Stops a running application. | `apps:control` |
| `restart_application` | Restarts an application, which also applies file and configuration changes. | `apps:control` |
| `create_application` | Creates and deploys a new application from a starter (Node.js, Python, static site, Go, Rust, Elixir, .NET, PHP or Ruby), optionally with your first files. | `apps:write` |
| `upload_application` | Creates and deploys a new application from a zip of a project you already have, sent as base64 (up to 1 MB). The [configuration file](https://docs.squarecloud.app/en/getting-started/config-file.md) `squarecloud.app` must sit at the root of the zip, not inside a folder. | `apps:write` |
| `commit_application` | Sends a new version to an existing application, as text files or as a zip (up to 1 MB), into a folder you choose (the root by default). Files with the same name are replaced and nothing else is deleted. It doesn't restart the application, and with `snapshot` it takes a snapshot first. | `files:write` (with `snapshot`, also `snapshots:write`) |
| `delete_application` | Deletes one application, with a safety snapshot first. | `apps:write` |

## Files and configuration

| Tool | What it does | Scope |
| - | - | - |
| `list_files` | Lists one folder of an application. | `files:read` |
| `read_file` | Reads a text file of up to 10 MB, page by page. | `files:read` |
| `search_files` | Searches an application's files for text or a regular expression, skipping `node_modules`, `.git`, build output, lock files and binaries. | `files:read` |
| `create_file` | Writes a file with its full content (up to 128 KB), creating its folders. Replaces a file that already exists. | `files:write` |
| `edit_file` | Replaces the content of an existing file (up to 128 KB). | `files:write` |
| `patch_file` | Edits a file of up to 10 MB with exact find-and-replace edits. If one edit doesn't match, nothing is written. | `files:write` |
| `rename_file` | Renames or moves a file or folder. | `files:write` |
| `delete_file` | Deletes a file or folder. Refuses the application root, the configuration file and `.env` files. | `files:write` |
| `edit_config_file` | Changes the [configuration file](https://docs.squarecloud.app/en/getting-started/config-file.md) field by field: display name, description, memory, automatic restart, subdomain, `MAIN` and `START`. | `files:write` |

File changes take effect on the next restart. In the configuration file, memory and subdomain apply at once, and `MAIN` and `START` on the next restart.

## Environment variables

| Tool | What it does | Scope |
| - | - | - |
| `list_env_vars` | Lists the names of an application's environment variables, never their values. | `envs:read` |
| `set_env_vars` | Adds, changes or removes variables in one call, with an optional restart. | `envs:write` (with `restart`, also `apps:control`) |

## Snapshots

| Tool | What it does | Scope |
| - | - | - |
| `list_snapshots` | Snapshots of one application or database, newest first. Without a target, an overview of the account, including deleted applications whose snapshots remain. | `snapshots:read` |
| `create_snapshot` | Takes a snapshot of one application or database. Counts toward your plan's daily snapshot limit. | `snapshots:write` |
| `restore_snapshot` | Restores an existing application or database to a snapshot, after a snapshot of its current state. | `snapshots:write` |

## Databases

| Tool | What it does | Scope |
| - | - | - |
| `list_databases` | Lists your databases (ID, name, engine, RAM, host, port, running or not). | `databases:read` |
| `create_database` | Creates a database (Standard plans and above), which takes up to about 90 seconds. With `connect_to_app`, it also writes the connection URL and the certificate file into an application. | `databases:write` (with `connect_to_app`, also `databases:credentials` and `envs:write`) |
| `start_database` | Starts a stopped database. | `databases:write` |
| `stop_database` | Stops a running database. The applications that use it lose their connection until it starts again. | `databases:write` |
| `update_database` | Changes a database's RAM, applied live. | `databases:write` |
| `connect_database` | Connects an existing database to an application: rotates its password, writes the new URL and certificate into the application, and updates the other applications that use it. | `databases:credentials` and `envs:write` |
| `rotate_database_credentials` | Rotates a database's password or TLS certificate and names the applications it updated. | `databases:credentials` and `envs:write` |
| `delete_database` | Deletes one database and its data, with a safety snapshot first. | `databases:write` |

## Domains and network

The network tools work on websites (applications with a domain), over windows of up to 7 days.

| Tool | What it does | Scope |
| - | - | - |
| `list_account_domains` | Every domain of every application: `squareweb.app` addresses and custom domains, 100 per page. | `apps:read` |
| `list_dns_records` | The DNS records to create for an application's custom domain, with their status. | `apps:read` |
| `set_custom_domain` | Connects, replaces or removes an application's custom domain and returns the DNS records to create. | `apps:write` |
| `purge_network_cache` | Purges the edge cache of up to 50 applications in one call. | `apps:write` |
| `get_network_analytics` | Edge traffic: requests, visits and bytes, with breakdowns by country, path, referrer, device and more. | `apps:read` |
| `get_network_errors` | Edge HTTP errors by status code, path and method. 5xx by default, 4xx on request. | `apps:read` |
| `get_network_performance` | Time to first byte and origin response time (p50, p95, p99) and the slowest paths. Pro and Enterprise. | `apps:read` |
| `get_network_logs` | The 40 latest edge requests, with masked IP addresses. Pro and Enterprise. | `apps:read` |

## Workspaces

| Tool | What it does | Scope |
| - | - | - |
| `list_workspaces` | The workspaces you own or belong to, with members and shared applications. Read-only: the other tools reach only your own applications. | `workspaces:manage` |

## Help and status

These tools need only the `mcp` scope.

| Tool | What it does | Scope |
| - | - | - |
| `get_platform_knowledge` | Square Cloud's own reference on limits, plans, error codes and setup. | `mcp` |
| `search_help_center` | Searches the [help center](https://help.squarecloud.app) or reads one of its articles. | `mcp` |
| `list_help_center` | Lists every help center article by category. | `mcp` |
| `get_platform_status` | The status of Square Cloud's services and of the providers they rely on. | `mcp` |
| `get_discord_status` | Discord's own status and API latency, to tell a Discord outage from a bot problem. | `mcp` |

## Left out on purpose

| Not available | Why | Instead |
| - | - | - |
| Downloading snapshots | The signed link holds your code and environment variables, and it would land in the conversation and with the AI model's provider. | Download it from the dashboard. |
| Downloading database certificates | Same reason: the certificate would leave Square Cloud through the model. | Download it from the dashboard. |
| Account activity | It shows the IP addresses and devices of your account. | See your [activity feed](https://squarecloud.app/en/dashboard/activity). |


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