Skip to main content
Glama

prepare_service_setup

Prepare 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.

Input Schema

NameRequiredDescriptionDefault
modeNocustomer runs the service on the cluster (the default); existing adopts one already there.
nameYesThe 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.
regionNoPhysical region. Defaults to the cluster's policy.
cluster_idYesCluster id (UUID) the service runs on.
parametersNoPackage parameters by name, as whole numbers (for example storage_gib, instances). Omitted ones take the package's defaults.
consumer_idsYesConsumer binding ids (UUIDs) the service is for, from bind_service_consumer or list_service_consumers.
data_boundaryNoData boundary. Defaults to the cluster's policy.
secret_referencesNoPackage secret inputs by name, each a credential grant id (UUID). Secret values are never accepted.
package_version_idYesPackage version id (UUID) from list_service_packages.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Goes well beyond annotations (non-readonly, non-destructive, non-idempotent). States 'Nothing is deployed', explains what the returned plan contains (package, cluster, consumers, parameters, cluster room), how defaults resolve (region/data boundary from cluster policy or 'unspecified'; parameters from package), and the required permission.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two dense sentences plus a short permission note. Front-loads purpose, then the return/confirmation behavior, then defaults, then the human-review step. No filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 9-param, mutation-like preparation tool with no output schema, the description covers purpose, return content, default resolution, absence of side effects, downstream dependency, and required permission. Everything an agent needs to invoke it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents all 9 parameters in detail (including enums, UUIDs, and defaults). The description adds default-resolution semantics at a high level but does not provide per-parameter meaning beyond what the schema offers. Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource: 'Prepare the review of a new managed service' and identifies itself as 'step one of `ankra services setup`'. Clearly distinguishes it from the sibling confirm_service_setup by naming it as the tool whose digest this produces.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicit workflow guidance: it is 'step one', it returns a plan that confirm_service_setup needs, and it instructs 'Show the plan to the user before confirming'. Also discloses the permission prerequisite ('Requires applications.deploy').

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources