Tools Reference
Complete reference for all 103 AI tools exposed through the MCP server. Each tool includes its risk level, parameters, and example usage.
Risk Levels
Every tool is classified by risk level. The risk determines which API key scope is required to execute it.
| Risk | Required Scope | Description |
|---|---|---|
read | read / standard / admin | Safe queries. No state changes. |
write | standard / admin | Modifies state (restarts, deploys, sandbox commands). |
destructive | admin only | Irreversible operations. Requires a confirmation token. |
Read Tools (37)
list_apps
List all deployed applications with their status, stack, and resource usage.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number (default: 1) |
per_page | integer | No | Results per page (default: 20, max: 100) |
get_app
Get detailed information about a specific application including domains, environment variable count, deployment status, and resource configuration.
| Parameter | Type | Required | Description |
|---|---|---|---|
app_id | string | Yes | App ID or app name |
get_server_status
Get server health including version, uptime, app count, and Docker connectivity status. No parameters.
list_deployments
List deployment history for an application.
| Parameter | Type | Required | Description |
|---|---|---|---|
app_id | string | Yes | App ID or app name |
get_deployment_logs
Get build logs for a specific deployment.
| Parameter | Type | Required | Description |
|---|---|---|---|
deployment_id | string | Yes | Deployment ID |
get_app_logs
Get recent container logs for a running application.
| Parameter | Type | Required | Description |
|---|---|---|---|
app_id | string | Yes | App ID or app name |
lines | integer | No | Number of lines (default: 200, max: 1000) |
list_databases
List all provisioned databases. No parameters.
list_cron_jobs
List all scheduled cron jobs. No parameters.
list_backups
List all backup records. No parameters.
list_domains
List domains configured for an application.
| Parameter | Type | Required | Description |
|---|---|---|---|
app_id | string | Yes | App ID or app name |
list_alerts
List all alert rules. No parameters.
server_metrics
Get server resource metrics: CPU, memory, disk usage, and network I/O. No parameters.
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.
Write Tools (44)
These tools modify server state. They require an API key with standard or admin scope.
restart_app
Restart an application's container (primary + replicas).
| Parameter | Type | Required | Description |
|---|---|---|---|
app_id | string | Yes | App ID or app name |
deploy_app
Trigger a new deployment for an application.
| Parameter | Type | Required | Description |
|---|---|---|---|
app_id | string | Yes | App ID or app name |
scale_app
Change the replica count for an application.
| Parameter | Type | Required | Description |
|---|---|---|---|
app_id | string | Yes | App ID or app name |
replicas | integer | Yes | Number of replicas (1-50) |
trigger_backup
Trigger a backup job immediately.
| Parameter | Type | Required | Description |
|---|---|---|---|
backup_id | string | Yes | Backup configuration ID |
trigger_cron
Execute a cron job immediately (outside its schedule).
| Parameter | Type | Required | Description |
|---|---|---|---|
cron_id | string | Yes | Cron job ID |
sandbox_exec_command
Execute a command in the app's AI sandbox container. The sandbox is a full Alpine Linux environment with root access, shared network, and writable volumes. 5-minute timeout, 100KB output limit.
| Parameter | Type | Required | Description |
|---|---|---|---|
app_id | string | Yes | App ID or app name |
command | string | Yes | Shell command to execute |
{"name": "sandbox_exec_command", "arguments": {"app_id": "my-app", "command": "curl -s localhost:3000/health"}}sandbox_enabled: true on the app. Enable it in app Settings or 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.
Destructive Tools (16)
Irreversible operations that require an admin-scope API key and a two-step confirmation flow.
confirm_action with that token to proceed. This prevents accidental deletion.delete_app
Delete an application, its containers, and optionally its volumes. Returns a confirmation token.
| Parameter | Type | Required | Description |
|---|---|---|---|
app_id | string | Yes | App ID or app name |
delete_database
Delete a provisioned database. Returns a confirmation token.
| Parameter | Type | Required | Description |
|---|---|---|---|
database_id | string | Yes | Database ID |
confirm_action
Confirm and execute a pending destructive action using the token returned by delete_app or delete_database.
| Parameter | Type | Required | Description |
|---|---|---|---|
token | string | Yes | Confirmation token (single-use, 5-minute TTL) |
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.
Sandbox Tools (5)
These tools interact with the AI sandbox container. All require sandbox_enabled: true on the target app. sandbox_exec_command is documented above under Write Tools. The remaining 4 are read-risk tools.
sandbox_read_file
Read a file from the app's mounted volumes via the sandbox. Returns up to 100KB.
| Parameter | Type | Required | Description |
|---|---|---|---|
app_id | string | Yes | App ID or app name |
path | string | Yes | Absolute file path (e.g., /app/config.yml) |
{"name": "sandbox_read_file", "arguments": {"app_id": "my-app", "path": "/app/package.json"}}sandbox_list_processes
List running processes inside the application container (runs ps aux in the app container, not the sandbox).
| Parameter | Type | Required | Description |
|---|---|---|---|
app_id | string | Yes | App ID or app name |
sandbox_check_connectivity
Test network connectivity from the sandbox. Uses nc for TCP port checks or curl for HTTP.
| Parameter | Type | Required | Description |
|---|---|---|---|
app_id | string | Yes | App ID or app name |
target | string | Yes | Hostname or IP (e.g., db, redis, localhost) |
port | integer | No | Port number. If omitted, uses HTTP (curl). |
{"name": "sandbox_check_connectivity", "arguments": {"app_id": "my-app", "target": "db", "port": 5432}}sandbox_status
Check the sandbox state for an application. Returns whether the sandbox is enabled, running, and its container ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
app_id | string | Yes | App ID or app name |