Skip to main content
Glama

Prepare service retirement

prepare_service_retirement
Destructive

Prepare the retirement of a managed service (step one of ankra services delete). It records a review and returns everything the retirement removes - the stack, the namespace and any objects in it the service did not create, and every volume claim with the reclaim policy that decides its data - and what it keeps, with the digest confirm_service_retirement needs. Nothing is removed. acknowledge_data_loss must be true: retiring a service deletes its data, and no export is offered. Requires applications.deploy and stacks.delete.

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": {
      "instance_id": "<instance_id>",
      "expected_generation": "<expected_generation>",
      "disconnect_consumer_ids": "<disconnect_consumer_ids>",
      "acknowledge_data_loss": "<acknowledge_data_loss>"
    },
    "name": "prepare_service_retirement"
  }
}

Input Schema

NameRequiredDescriptionDefault
instance_idYesService instance id (UUID) from list_service_instances.
expected_generationYesThe instance generation the user reviewed, from get_service_instance.
acknowledge_data_lossYesMust be true: the user accepts that the service's data is deleted.
disconnect_consumer_idsYesExactly the service's consumer binding ids (from get_service_instance), each once: the consumers that lose the service. Required; an empty list only when it has none.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already flag destructiveHint=true, but the description goes well beyond them by stating 'Nothing is removed' at this stage, that data deletion happens on confirmation with no export offered, and that applications.deploy and stacks.delete permissions are required. It also discloses the return payload's shape (stack, namespace, foreign objects, volume claims with reclaim policy), which is exactly the behavior an agent needs before invoking a destructive-adjacent tool.

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

Conciseness4/5

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

It is front-loaded with the purpose and the lifecycle step, then flows into returns, safety, and permissions with no filler sentences. The middle sentence is long and dash-chained, which costs a little readability, but every clause carries information.

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?

With no output schema, the description must describe what comes back, and it does so precisely — including the digest needed downstream. It also covers the destructive consequence, the permission prerequisites, and the fact that nothing is mutated yet, which is complete for a four-required-parameter confirmation-gate tool.

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

Parameters4/5

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

Schema description coverage is 100%, so the baseline is 3, and the description earns an increment by explaining why acknowledge_data_loss must be true ('retiring a service deletes its data, and no export is offered') — context the schema's one-line field note does not supply. The remaining parameters (instance_id, expected_generation, disconnect_consumer_ids) are left to the schema, which is acceptable at full coverage.

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?

The description names a specific verb and resource ('Prepare the retirement of a managed service') and pins its position in the lifecycle ('step one of `ankra services delete`'), which separates it cleanly from confirm_service_retirement and prepare_service_disconnection. It also enumerates what the call returns, so an agent knows this is a review-producing preview rather than the deletion itself.

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

Usage Guidelines4/5

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

The two-step flow is explicit: this is step one, and its output includes 'the digest confirm_service_retirement needs', which routes the agent to the correct successor tool. What is missing is an explicit when-not clause (e.g., do not call this when the user has not reviewed the instance, or what to do if the digest is rejected), so it stops just short of full alternative coverage.

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.