Skip to content

API REFERENCE

MCP tool reference

Discover the tools available to your agent. Find an operation, understand its inputs, and follow its REST reference for response and permission details.

One connection. Scoped access.

Connect to https://app.helicarrier.xyz/mcp using Streamable HTTP. Start with whoami to discover your key’s scope. Visible tools and permitted actions depend on your credentials.

Connect an MCP client →

Find a tool 70 tools

Identity & plans

Identify the authenticated caller and discover the resources and permissions available to a scoped key.

list_plans Read

Discover the available service and database plans before creating or resizing a resource.

Projects & environments

list_projects Read

List projects visible to your account, including their service counts and environment summaries.

get_project Read

Read a project and its services in one environment. Select an environment explicitly when automating a workflow.

list_deleted_services Read

Find services in a project that are still eligible for restoration.

create_project Write

Create a project to organize related services and environments.

list_environments Read

List environments visible to the caller within a project.

Required: projectSlug

Services & configuration

get_service Read

Read a service’s current state, source configuration, plan, and exposed ports.

get_scaling Read

Read the instance floor, autoscaling ceiling, and effective service capacity.

get_dependencies Read

Inspect dependency issues that can prevent a service from starting correctly.

create_service Write

Create a service from a Git repository or container image. Creation queues a deployment and starts a billed resource.

Required: name, projectSlug

update_build_settings Write

Update the build directory, builder, and build or runtime commands for a service.

set_readonly_filesystem Write

Configure a read-only root filesystem for the service’s next deployment.

Required: id, readonlyRootfs

scale_service Write

Set the service’s instance count and, optionally, its autoscaling targets and ceiling.

stop_service Write

Stop a running service. Deploy it again when you are ready to resume.

delete_service Write

Delete a service and place eligible resources within the restoration window.

restore_service Write

Restore an eligible deleted service and redeploy it with its retained configuration.

set_service_image Write

Change a service’s container image and optionally deploy it immediately.

Required: id, image

set_plan Write

Move a service to another available compute plan.

Required: id, planKey

Deployments

list_deployments Read

Read deployment history for a service, newest first, with rollback eligibility and a pagination cursor.

deploy_service Write

Queue a deployment for an existing service. For a Git service, optionally select a one-off branch, tag, or commit.

deploy_upload Write

Create a new service from a base64-encoded source archive. Use reupload to update an existing upload service.

Required: projectSlug, name, archiveBase64

reupload_service Write

Deploy a new source archive to an existing upload service while keeping its identity and configuration.

Required: id, archiveBase64

rollback_service Write

Queue a deployment using a retained image from an earlier release.

Required: id, deploymentId

abort_deploy Write

Request cancellation of a deployment that is still in progress.

Required: deploymentId

set_autodeploy Write

Enable or disable automatic deployments when the tracked Git source changes.

Required: id, enabled

create_deploy_trigger Write

Create or rotate a secret URL that can trigger deployments. The token is shown only once.

delete_deploy_trigger Write

Revoke the service’s current deploy-trigger URL.

Logs & metrics

get_logs Read

Read runtime output from a service. Filter historical logs or read incrementally with a cursor.

get_metrics Read

Read service resource usage over a supported time window.

get_deployment_logs Read

Read build and deployment output, optionally after a previously seen log identifier.

Required: deploymentId

Variables & references

list_env Read

List environment variable names and masked values for a service.

set_env Write

Create or update one environment variable. The running service receives it on its next deployment.

Required: id, key, value

list_references Read

List environment-variable references connecting this service to provider services.

list_env_groups Read

Discover shared environment groups owned by your account.

delete_env Write

Delete an environment variable from a service’s saved configuration.

Required: id, key

add_reference Write

Inject a value from a provider service into a consumer’s environment variable.

Required: id, providerId

Domains & networking

list_domains Read

List the custom domains attached to a service and their current verification state.

list_ports Read

Inspect a service’s primary HTTP port, additional exposed ports, and detected port suggestions.

get_dns_target Read

Get the DNS target to use when connecting a custom domain to this service.

list_dedicated_ips Read

List dedicated outbound addresses held by your account and their attachments.

get_project_dedicated_ip Read

Read the outbound IP attachment inherited by eligible services in this project.

attach_project_dedicated_ip Write

Attach an existing account-owned outbound IP to a project.

Required: slug, ipId

detach_project_dedicated_ip Write

Detach an outbound IP from a project without releasing the purchased address.

get_service_dedicated_ip Read

Read a service’s explicit outbound IP and its project-level fallback.

attach_service_dedicated_ip Write

Attach an existing account-owned outbound IP to a service. A deployment is required to apply it.

Required: id, ipId

detach_service_dedicated_ip Write

Remove a service’s outbound IP override without releasing the address.

add_domain Write

Attach a custom domain to a service, then configure DNS to complete verification.

Required: id, hostname

import_env Write

Import several environment variables into a service in one request.

Required: id, vars

expose_port Write

Expose an additional HTTP port and create a generated hostname for it.

Required: id, port, label

remove_port Write

Remove an additional exposed HTTP port and its generated route.

Required: id, port

remove_domain Write

Remove a custom domain from this service.

Required: id, domainId

set_search_indexing Write

Control search-indexing headers on a service’s generated hostname.

Required: id, enabled

Databases & storage

list_engines Read

Discover supported database engines, versions, and provisioning capabilities.

list_db_extensions Read

Read the curated PostgreSQL extension catalog available during database creation.

get_db_metrics Read

Read engine-specific database metrics, grouped for inspection.

set_storage Write

Change the provisioned storage of a managed database or bucket without changing its compute plan.

Required: id, storageGb

create_database Write

Provision a managed database in a project and environment using a supported engine and plan.

Required: name, engine

get_db_connection Read

Read connection details and credentials for a database you can access. Treat this response as a secret.

list_backups Read

List the backup records for a managed database.

create_backup Write

Start an on-demand backup of a managed database.

restore_backup Write

Restore a selected backup into its database. This overwrites the current database contents.

Required: id, backupId

db_query Write

Run a SQL query against a managed database. Queries can modify data; inspect the response for execution errors.

Required: id, query

rotate_db_credentials Write

Change a managed database’s password and invalidate the previous credential.

Required: id, password

set_db_external_access Write

Enable or disable external connections for a supported database.

Required: id, external

set_db_allowlist Write

Set the source CIDRs allowed to connect to an externally accessible database.

Required: id, allowIps

set_db_tls Write

Enable or disable external TLS for a supported database.

Required: id, tls

Scheduled jobs

get_cron Read

Read a cron service’s schedule, command, and next expected run.

run_cron Write

Queue an immediate run of a cron service without changing its schedule.

update_cron Write

Update a cron service’s schedule or command.

Required: id, schedule

MCP calls use the same resource and permission checks as REST requests.

Understand key scope →