Skip to main content
Glama

runbook

Read-onlyIdempotent

Generate an operational runbook from service facts covering alerts, diagnostics, remediation, rollback, escalation and verification, with explicit placeholders for missing inputs.

Instructions

Generate an operational runbook from service facts: alerts, diagnostic steps, remediation, rollback, escalation and verification. Template with explicit placeholders for what the caller did not provide.

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": {
      "service": "<service>",
      "owner": "<owner>",
      "alerts": "<alerts>",
      "diagnostics": "<diagnostics>",
      "remediation": "<remediation>"
    },
    "name": "runbook"
  }
}

Input Schema

NameRequiredDescriptionDefault
ownerYes
alertsYes
serviceYes
rollbackNo
dashboardsNo
escalationNo
diagnosticsYes
remediationYes

Output Schema

NameRequiredDescriptionDefault
kindNo
missingNo
markdownNo
nextToolsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.5.0
    • removedInput schema / properties / alerts / items / additionalProperties
      Removed value: -false
    • changedInput schema / required
      Previous value: -[
      -  "service",
      -  "owner",
      -  "alerts",
      -  "diagnostics",
      -  "remediation",
      -  "rollback",
      -  "escalation",
      -  "dashboards"
      -]New value: +[
      +  "service",
      +  "owner",
      +  "alerts",
      +  "diagnostics",
      +  "remediation"
      +]
  2. First observedv0.4.1

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already establish readOnly, idempotent, non-destructive behavior, and the description adds one genuinely useful trait: missing inputs become explicit placeholders rather than being invented. It does not disclose output format details, length limits, or whether verification content is derived or templated.

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?

Two sentences, front-loaded with the core action and outputs, second sentence covering the placeholder behavior. Nothing is redundant.

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?

An output schema exists, so return values need not be explained, and the description covers the generator's scope adequately. The gap is that 'verification' is listed as an output but has no corresponding input, and per-parameter constraints for the zero-coverage schema go unaddressed.

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 0% across 8 parameters, so the description carries the burden and only names five of them loosely (alerts, diagnostics, remediation, rollback, escalation). It says nothing about 'service', 'owner', or 'dashboards', nor about the alerts object's name/meaning/threshold structure or the URI constraint on dashboards.

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?

States a specific verb and resource ('Generate an operational runbook') and enumerates the exact sections produced (alerts, diagnostics, remediation, rollback, escalation, verification). No sibling tool in the list produces a runbook, so the agent can distinguish it immediately.

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?

Implied usage only: the caller should have service facts and wants a runbook. No explicit when-to-use, when-not-to-use, or pointer to an alternative sibling such as postmortem or implementation_plan for adjacent tasks.

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