Skip to main content
Glama

Get service instance

get_service_instance
Read-only

Read one managed service (the twin of ankra services get): its deployment state; its health as the platform last observed it; its readiness, with the evidence of the canary that connects with the generated credentials; its consumers; and its connection - the cluster-internal endpoints and the Kubernetes Secret holding its credentials, by name and keys only, never a credential value. Use it to follow a setup until the service is serving, and for the generation and consumer ids a retirement needs. A retirement whose outcome is retired released the name; its data_disposal says whether the service's data may remain (data_kept, unconfirmed) and kept_data names the volumes, the cluster, when Ankra last looked and the Ankra CLI commands to inspect or erase them. Never report such a service as plainly deleted, and say kept_data is what Ankra saw then, not now. Read-only.

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>"
    },
    "name": "get_service_instance"
  }
}

Input Schema

NameRequiredDescriptionDefault
instance_idYesService instance id (UUID) from list_service_instances.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior5/5

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

Beyond readOnlyHint it discloses that credentials are surfaced only by Secret name and keys, never values, and it explains retirement outcome semantics: a retired outcome released the name, data_disposal can be data_kept/unconfirmed, and kept_data is a point-in-time snapshot with CLI commands to inspect or erase. It even instructs how to phrase the result ('never report such a service as plainly deleted').

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

Conciseness3/5

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

The purpose is front-loaded, but the body is a long semicolon-chained run-on that mixes the getter's return contents with retire-specific field semantics that arguably belong to get_service_retirement. Sentences do not easily parse and the most actionable caveats are buried at the end.

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 carries the full burden, and it does enumerate the returned sections plus the retirement fields (data_disposal, kept_data volumes, cluster, observation time). An agent knows what it will receive and how to interpret the sensitive and historical parts.

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?

The single instance_id parameter is fully documented in the schema, including that it comes from list_service_instances, so the description adds nothing further about parameter meaning or format. Baseline 3 applies when schema coverage is 100%.

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

Purpose4/5

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

It opens with a specific verb and resource ('Read one managed service') and then enumerates what the read returns: deployment state, health, readiness with canary evidence, consumers, and connection endpoints/Secret. The overlap with sibling readers like get_service_retirement and get_services is not explicitly disambiguated, keeping it from a 5.

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?

It gives concrete usage contexts: follow a setup until the service is serving, and collect the generation/consumer ids a retirement needs. It does not name an alternative tool or state a when-not condition (e.g., use list_service_instances to enumerate, get_service_retirement for the retirement record itself).

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.