Skip to main content
Glama

get_runbook

Read-onlyIdempotent

Fetch a runbook by ID to review covered symptoms and resolution steps for an incident. Read-only lookup helps responders follow the right procedure.

Instructions

Get one runbook: the symptoms it covers and its steps. Read-only.

    An incident's runbook IDs are listed in its incident://<incident_id> resource.
    

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": {
      "runbook_id": "<runbook_id>"
    },
    "name": "get_runbook"
  }
}

Input Schema

NameRequiredDescriptionDefault
runbook_idYese.g. RB-DB-POOL

Output Schema

NameRequiredDescriptionDefault
idYes
stepsYes
titleYes
serviceYes
symptomsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and openWorldHint=false, so 'Read-only' merely restates structured data. The genuinely additive behavior content is the pointer to the incident resource for ID discovery; nothing is said about error behavior for malformed or unknown IDs, but the strict schema pattern mitigates that.

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?

Two short sentences, front-loaded with the primary action and return content, followed by the discovery hint. The standalone 'Read-only.' sentence is redundant against the annotations and is the only wasted token.

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?

A single-parameter read tool with full schema coverage, an output schema and safety annotations; the description covers what is returned and how to get the ID. Nothing an agent needs to invoke it correctly is missing, though failure modes for an unknown ID are unaddressed.

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 coverage is 100% with a pattern and example (RB-DB-POOL), so the baseline is 3. The description goes beyond the schema by explaining the provenance of runbook_id — it comes from an incident://<incident_id> resource — which is real semantic value the schema cannot express.

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 one runbook') and immediately specifies the payload ('the symptoms it covers and its steps'). The resource is distinct from siblings get_ticket and search_logs, though the description does not explicitly contrast with them.

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?

Gives a concrete prerequisite for use: an incident's runbook IDs are listed in its incident://<incident_id> resource, which tells the agent exactly where to obtain a valid ID before calling. It stops short of stating when not to use it or naming an alternative when the ID is unknown.

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

Deploy Server

Other Tools