Prepare service setup
prepare_service_setupPrepare the review of a new managed service (step one of ankra services setup). It records a review and returns its plan - the package, the cluster, the consumers, the parameters and whether the cluster has room for it - with the digest confirm_service_setup needs. Nothing is deployed. The region and data boundary default to the cluster's policy (get_service_cluster_policy), or unspecified when it has not declared one; parameters default to the package's. Show the plan to the user before confirming. Requires applications.deploy.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"package_version_id": "<package_version_id>",
"name": "<name>",
"cluster_id": "<cluster_id>",
"consumer_ids": "<consumer_ids>"
},
"name": "prepare_service_setup"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | customer runs the service on the cluster (the default); existing adopts one already there. | |
| name | Yes | The service's name, which also becomes its namespace: lower-case letters, digits and single hyphens, starting with a letter, at most 36 characters, and not a system namespace. | |
| region | No | Physical region. Defaults to the cluster's policy. | |
| cluster_id | Yes | Cluster id (UUID) the service runs on. | |
| parameters | No | Package parameters by name, as whole numbers (for example storage_gib, instances). Omitted ones take the package's defaults. | |
| consumer_ids | Yes | Consumer binding ids (UUIDs) the service is for, from bind_service_consumer or list_service_consumers. | |
| data_boundary | No | Data boundary. Defaults to the cluster's policy. | |
| secret_references | No | Package secret inputs by name, each a credential grant id (UUID). Secret values are never accepted. | |
| package_version_id | Yes | Package version id (UUID) from list_service_packages. |