References

Service Tools

MCP tools for deploying, observing, scaling, renaming, and deleting services on Ink

service_create

Create and deploy a service from a git repository or a prebuilt Docker image. Use host='ink' for Ink-managed repos or host='github' for GitHub repos.

ParameterTypeRequiredDefaultDescription
workspacestringnodefaultWorkspace slug
sourcestringnoreporepo or image
repostringwhen source='repo'Ink repo name from repo_create (or ink/name shortcut), or GitHub owner/repo with host='github'
imagestringwhen source='image'Docker image to deploy
hoststringnoinkGit host: ink or github
branchstringnomainBranch to deploy
namestringnoderivedDisplay name for the service
subdomainstringnoservice nameCustom *.deployink.com subdomain
projectstringnodefaultProject slug
regionsstring[]nous-east-1Deployment region list; currently one region is supported
build_packstringnorailpackrailpack, dockerfile, static, or dockercompose
portsarraynopublic HTTP 3000Named ports. Pass [] for workers with no listening ports
env_varsarraynoEnvironment variables as { key, value }
memorystringno256MiMemory limit from 128Mi through 65536Mi, subject to plan limits
vcpusstringno0.25vCPU limit from 0.1 through 32, subject to plan limits
replicasintegerno1Stateless replicas from 0 to 10. Volume services support at most 1
build_commandstringnoautoCustom build command for railpack
start_commandstringnoautoCustom start command for railpack
publish_directorystringnoStatic output directory such as dist
root_directorystringnoMonorepo subdirectory to build from
dockerfile_pathstringnoDockerfile path relative to root_directory
volume_namestringnoPersistent volume name to attach or reattach
volume_mount_pathstringwith volume_nameAbsolute mount path inside the container
volume_size_giintegerno1Volume size in GiB
health_pathstringnoHTTP readiness path such as /healthz
destroy_timeout_secondsintegerno0Auto-destroy service after completion; max 24 hours

Returns: service_id, name, status, repo, ports, replicas, commit_hash, and message.

service_list

List deployed services, optionally filtered by project.

ParameterTypeRequiredDefaultDescription
workspacestringnodefaultWorkspace slug
projectstringnoProject slug filter

Returns: services with service_id, name, subdomain, project, source, repo or image, status, ports, and replicas.

service_get

Get service details, logs, metrics, environment variables, custom domain state, and attached volumes. This is the primary observability and debugging tool.

Status values include queued, building, deploying, active, failed, cancelled, superseded, crashed, completed, and removed.

ParameterTypeRequiredDefaultDescription
workspacestringnodefaultWorkspace slug
namestringone of name or service_idService name
service_idstringone of name or service_idService ID
projectstringnodefaultProject slug
include_envbooleannofalseInclude environment variables
deploy_log_linesintegerno0Deployment log lines to fetch, max 500
runtime_log_linesintegerno0Runtime log lines to fetch, max 500
metricsstringnoMetrics range: 1h, 6h, 7d, or 30d

Returns: service config, status, ports, logs, metrics, env vars, custom domain, and volume details.

service_update

Update service configuration and redeploy. Only specify fields you want to change. Calling it without configuration changes can also force a redeploy from the current source.

Supports the same deployment configuration fields as service_create, including source, repo, image, host, branch, ports, env_vars, build_pack, memory, vcpus, replicas, commands, monorepo paths, volume fields, and health_path.

ParameterTypeRequiredDefaultDescription
workspacestringnodefaultWorkspace slug
namestringone of name or service_idService name
service_idstringone of name or service_idService ID
projectstringnodefaultProject slug

Returns: service_id, name, status, and message.

service_rename

Rename a service display name without redeploying it.

ParameterTypeRequiredDefaultDescription
workspacestringnodefaultWorkspace slug
namestringone of name or service_idCurrent service name
service_idstringone of name or service_idService ID
new_namestringyesNew display name
projectstringnodefaultProject slug

service_delete

Delete a service and stop its deployment. Attached volumes are detached and retained for 24 hours unless reattached or deleted.

ParameterTypeRequiredDefaultDescription
workspacestringnodefaultWorkspace slug
namestringone of name or service_idService name
service_idstringone of name or service_idService ID
projectstringnodefaultProject slug

Returns: service_id, name, and message.

On this page