Skip to main content
Glama

Pause instance

pause_instance
Idempotent

Pause an instance: stops it and its billing lease. Data is archived, not deleted.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesInstance (agent) id, as returned by create_instance or list_instances.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesInstance (agent) id.
nameYesDisplay name.
tierYesHosting plan id.
a2aUrlYesA2A JSON-RPC endpoint for the instance, or null if A2A is not enabled.
domainYesCustomer-owned domain serving the instance, or null.
engineYesRuntime engine id (e.g. hermes).
statusYesLifecycle status (e.g. running, stopped).
createdAtYesISO timestamp when the instance was created.
endpointUrlYesPublic HTTPS endpoint for the instance, or null if not yet assigned.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "a2aUrl": {
      +      "description": "A2A JSON-RPC endpoint for the instance, or null if A2A is not enabled.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "createdAt": {
      +      "description": "ISO timestamp when the instance was created.",
      +      "type": "string"
      +    },
      +    "domain": {
      +      "description": "Customer-owned domain serving the instance, or null.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "endpointUrl": {
      +      "description": "Public HTTPS endpoint for the instance, or null if not yet assigned.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "engine": {
      +      "description": "Runtime engine id (e.g. hermes).",
      +      "type": "string"
      +    },
      +    "id": {
      +      "description": "Instance (agent) id.",
      +      "type": "string"
      +    },
      +    "name": {
      +      "description": "Display name.",
      +      "type": "string"
      +    },
      +    "status": {
      +      "description": "Lifecycle status (e.g. running, stopped).",
      +      "type": "string"
      +    },
      +    "tier": {
      +      "description": "Hosting plan id.",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "id",
      +    "name",
      +    "engine",
      +    "tier",
      +    "status",
      +    "endpointUrl",
      +    "a2aUrl",
      +    "domain",
      +    "createdAt"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations only provide idempotentHint and openWorldHint, so the description carries the burden of explaining the operation's real-world effect. It adds valuable context that data is archived rather than deleted and that billing stops, which goes beyond the schema and annotations.

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?

The description is one tight sentence with no filler. It front-loads the action and immediately follows with the most important behavioral qualifier about data retention.

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 single-parameter tool with a clear annotation profile and an output schema, this description is complete. It states the action, the billing impact, and the data retention behavior, leaving no critical gap for an agent to call 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%, and the single 'id' parameter is already well described as an instance id from create_instance or list_instances. The description adds no additional parameter meaning, so the baseline of 3 applies.

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 uses a specific verb and resource ('Pause an instance') and clearly states the effect: stopping the instance and its billing lease. It also distinguishes itself from deletion by saying data is archived, not deleted, which helps an agent tell it apart from delete_instance without opening schemas.

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

Usage Guidelines3/5

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

The description implies usage context: pause when you want to stop billing while preserving data. However, it does not explicitly name alternatives like resume_instance or delete_instance or state when not to use this tool, leaving some routing to inference.

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.