> ## 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 工具

> 按领域列出 Square Cloud MCP 服务器的 49 个工具，以及每个工具所需的权限范围。

MCP 服务器共有 49 个工具。客户端只能看到其密钥的[权限范围](https://docs.squarecloud.app/zh/mcp/permissions-and-safety.md#权限范围)涵盖的工具。工具通过 ID、确切名称或主机名指定应用，通过 ID 或名称指定数据库。每个工具都返回 JSON，包含 `ok`、`summary`，并在出现失败或需要你处理时包含 `code`。

所有工具都会[立即执行](https://docs.squarecloud.app/zh/mcp/permissions-and-safety.md#所有更改都会立即执行)。删除应用或数据库以及恢复 snapshot 时，会先创建一个[安全 snapshot](https://docs.squarecloud.app/zh/mcp/permissions-and-safety.md#删除与恢复)。

## 应用

| 工具 | 功能 | 权限范围 |
| - | - | - |
| `list_applications` | 列出你的应用（ID、名称、语言、是否运行、域名），每页 100 个。 | `apps:read` |
| `get_application_status` | 单个应用的实时状态：CPU、RAM、运行时间、地址、自定义域名、内存配额和自动重启。 | `apps:read` |
| `get_all_applications_status` | 一次调用即可查看你的每个应用是否在运行。 | `apps:read` |
| `get_application_logs` | 单个应用的最新日志，大约最后 4,000 个字符。 | `apps:read` |
| `get_deployments` | 单个应用的 Git 部署历史（GitHub App 或 webhook）：commit、分支、结果、耗时，以及失败部署的错误。 | `apps:read` |
| `get_metrics_history` | 单个应用或数据库的 CPU 和 RAM 历史，包括平均值、峰值和最新值。时间范围为 24 小时，Pro 和 Enterprise 为 7 天（应用仅限 512 MB 及以上）。 | `apps:read` 或 `databases:read` |
| `start_application` | 启动已停止的应用。 | `apps:control` |
| `stop_application` | 停止正在运行的应用。 | `apps:control` |
| `restart_application` | 重启应用，同时应用文件和配置的更改。 | `apps:control` |
| `create_application` | 从入门模板（Node.js、Python、静态网站、Go、Rust、Elixir、.NET、PHP 或 Ruby）创建并部署新应用，可附带你的初始文件。 | `apps:write` |
| `upload_application` | 用你已有项目的 zip（以 base64 发送，最大 1 MB）创建并部署新应用。[配置文件](https://docs.squarecloud.app/zh/getting-started/config-file.md) `squarecloud.app` 必须位于 zip 的根目录，而不是某个文件夹中。 | `apps:write` |
| `commit_application` | 向现有应用发送新版本，可以是文本文件或 zip（最大 1 MB），放入你选择的文件夹（默认为根目录）。同名文件会被替换，其他内容不会被删除。不会重启应用；使用 `snapshot` 时会先创建一个 snapshot。 | `files:write`（使用 `snapshot` 时还需要 `snapshots:write`） |
| `delete_application` | 删除单个应用，并先创建安全 snapshot。 | `apps:write` |

## 文件和配置

| 工具 | 功能 | 权限范围 |
| - | - | - |
| `list_files` | 列出应用的一个文件夹。 | `files:read` |
| `read_file` | 逐页读取最大 10 MB 的文本文件。 | `files:read` |
| `search_files` | 在应用的文件中搜索文本或正则表达式，跳过 `node_modules`、`.git`、构建输出、锁文件和二进制文件。 | `files:read` |
| `create_file` | 写入一个包含完整内容的文件（最大 128 KB），并创建所需的文件夹。会替换已存在的文件。 | `files:write` |
| `edit_file` | 替换现有文件的内容（最大 128 KB）。 | `files:write` |
| `patch_file` | 通过精确的查找替换编辑最大 10 MB 的文件。只要有一处编辑不匹配，就不会写入任何内容。 | `files:write` |
| `rename_file` | 重命名或移动文件或文件夹。 | `files:write` |
| `delete_file` | 删除文件或文件夹。拒绝删除应用根目录、配置文件和 `.env` 文件。 | `files:write` |
| `edit_config_file` | 逐字段更改[配置文件](https://docs.squarecloud.app/zh/getting-started/config-file.md)：显示名称、描述、内存、自动重启、子域名、`MAIN` 和 `START`。 | `files:write` |

文件更改会在下次重启时生效。在配置文件中，内存和子域名会立即生效，`MAIN` 和 `START` 在下次重启时生效。

## 环境变量

| 工具 | 功能 | 权限范围 |
| - | - | - |
| `list_env_vars` | 列出应用环境变量的名称，从不列出其值。 | `envs:read` |
| `set_env_vars` | 在一次调用中添加、更改或删除变量，可选择同时重启。 | `envs:write`（使用 `restart` 时还需要 `apps:control`） |

## Snapshot

| 工具 | 功能 | 权限范围 |
| - | - | - |
| `list_snapshots` | 单个应用或数据库的 snapshot，最新的在前。不指定目标时，返回账户概览，包括仍保留 snapshot 的已删除应用。 | `snapshots:read` |
| `create_snapshot` | 为单个应用或数据库创建 snapshot。计入你套餐的每日 snapshot 上限。 | `snapshots:write` |
| `restore_snapshot` | 先为现有应用或数据库的当前状态创建 snapshot，再将其恢复到某个 snapshot。 | `snapshots:write` |

## 数据库

| 工具 | 功能 | 权限范围 |
| - | - | - |
| `list_databases` | 列出你的数据库（ID、名称、引擎、RAM、主机、端口、是否运行）。 | `databases:read` |
| `create_database` | 创建数据库（Standard 及以上套餐），最多需要大约 90 秒。使用 `connect_to_app` 时，还会将连接 URL 和证书文件写入某个应用。 | `databases:write`（使用 `connect_to_app` 时还需要 `databases:credentials` 和 `envs:write`） |
| `start_database` | 启动已停止的数据库。 | `databases:write` |
| `stop_database` | 停止正在运行的数据库。使用它的应用会失去连接，直到它再次启动。 | `databases:write` |
| `update_database` | 更改数据库的 RAM，实时生效。 | `databases:write` |
| `connect_database` | 将现有数据库连接到应用：轮换其密码，将新的 URL 和证书写入该应用，并更新使用它的其他应用。 | `databases:credentials` 和 `envs:write` |
| `rotate_database_credentials` | 轮换数据库的密码或 TLS 证书，并列出它更新了哪些应用。 | `databases:credentials` 和 `envs:write` |
| `delete_database` | 删除单个数据库及其数据，并先创建安全 snapshot。 | `databases:write` |

## 域名和网络

网络工具适用于网站（带有域名的应用），时间窗口最长 7 天。

| 工具 | 功能 | 权限范围 |
| - | - | - |
| `list_account_domains` | 所有应用的所有域名：`squareweb.app` 地址和自定义域名，每页 100 个。 | `apps:read` |
| `list_dns_records` | 应用的自定义域名需要创建的 DNS 记录及其状态。 | `apps:read` |
| `set_custom_domain` | 连接、替换或移除应用的自定义域名，并返回需要创建的 DNS 记录。 | `apps:write` |
| `purge_network_cache` | 一次调用清除最多 50 个应用的边缘缓存。 | `apps:write` |
| `get_network_analytics` | 边缘流量：请求数、访问量和字节数，可按国家/地区、路径、来源、设备等细分。 | `apps:read` |
| `get_network_errors` | 按状态码、路径和方法统计的边缘 HTTP 错误。默认为 5xx，可按需查询 4xx。 | `apps:read` |
| `get_network_performance` | 首字节时间和源站响应时间（p50、p95、p99）以及最慢的路径。限 Pro 和 Enterprise。 | `apps:read` |
| `get_network_logs` | 最近 40 个边缘请求，IP 地址已遮盖。限 Pro 和 Enterprise。 | `apps:read` |

## Workspace

| 工具 | 功能 | 权限范围 |
| - | - | - |
| `list_workspaces` | 你拥有或所属的 workspace，包括成员和共享应用。只读：其他工具只能访问你自己的应用。 | `workspaces:manage` |

## 帮助和状态

这些工具只需要 `mcp` 权限范围。

| 工具 | 功能 | 权限范围 |
| - | - | - |
| `get_platform_knowledge` | Square Cloud 自己关于限制、套餐、错误代码和设置的参考资料。 | `mcp` |
| `search_help_center` | 搜索[帮助中心](https://help.squarecloud.app)或读取其中的一篇文章。 | `mcp` |
| `list_help_center` | 按分类列出帮助中心的所有文章。 | `mcp` |
| `get_platform_status` | Square Cloud 各项服务及其所依赖提供商的状态。 | `mcp` |
| `get_discord_status` | Discord 自身的状态和 API 延迟，用于区分 Discord 故障和机器人问题。 | `mcp` |

## 有意不提供的功能

| 不可用 | 原因 | 替代方式 |
| - | - | - |
| 下载 snapshot | 带签名的链接包含你的代码和环境变量，它会出现在对话中，并到达 AI 模型的提供商手中。 | 在控制面板中下载。 |
| 下载数据库证书 | 原因相同：证书会经由模型离开 Square Cloud。 | 在控制面板中下载。 |
| 账户活动 | 它会显示你账户的 IP 地址和设备。 | 查看你的[活动记录](https://squarecloud.app/zh/dashboard/activity)。 |


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