Skip to main content
Glama

Get instance details

get_instance
Read-onlyIdempotent

Get detailed information about a specific instance, including its max runtime and idle stop settings, auto_stop_at (when max runtime will terminate it), stop_reason (why it stopped: user, max_runtime, idle, budget, low_balance, failed or system), its kind (deployment_type: vm, baremetal or container), who runs it (host: "Datacenter" or "Community host"), its firewall (status and rules; null on a container, which has none) and its HTTPS links (links).

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": {
      "id": "<id>"
    },
    "name": "get_instance"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesInstance ID
workspaceNoWorkspace ID (optional: defaults to the authenticated workspace)
environmentNoEnvironment name (optional: defaults to the environment this session acts in)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • removedInput schema / properties / env
      Removed value: -{
      -  "description": "Environment name (optional — defaults to main)",
      -  "type": "string"
      -}
    • addedInput schema / properties / environment
      Added value: +{
      +  "description": "Environment name (optional: defaults to the environment this session acts in)",
      +  "type": "string"
      +}
    • changedInput schema / properties / workspace / description
      Previous value: -"Workspace ID (optional — defaults to authenticated workspace)"New value: +"Workspace ID (optional: defaults to the authenticated workspace)"
  2. First observed

TDQS

B3.4/5.0
Behavior4/5

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

Annotations already establish readOnly, idempotent, non-destructive behavior, yet the description still adds real value: it enumerates stop_reason values (user, max_runtime, idle, budget, low_balance, failed, system) and notes that firewall is null on containers, which are behaviors not visible in the annotations or schema. It does not cover not-found/permission failure modes, but that is a minor omission given the annotation coverage.

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 in the first clause, which is good, but the rest is a single sprawling sentence with nested parentheticals that mixes field names with prose. The information is useful but the field dump format makes it slower to scan than a short structured list would be.

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

Completeness4/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 burden of explaining return values and does so for most fields (max runtime, idle stop, auto_stop_at, stop_reason, deployment_type, host, firewall, links). Only the workspace/environment scoping defaults and error behavior are left entirely to the schema and annotations.

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 id, workspace, and environment are already documented including workspace/environment defaults. The description only says 'a specific instance' and adds no scoping or format meaning beyond the schema; baseline 3 applies.

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?

States a specific verb and resource ('Get detailed information about a specific instance') and enumerates the fields it returns. It does not explicitly distinguish itself from nearby siblings such as instance_status or list_instances, so differentiation is inferred from 'detailed' and 'specific' rather than stated.

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

Usage Guidelines2/5

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

No when-to-use or when-not-to-use guidance is given, and the two closest alternatives (instance_status for state, list_instances for enumeration) are never named. An agent must guess that this is the per-instance detail call rather than a status probe.

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.