Runbook

Field	Type	Behavior	Description
name	string	OUTPUT_ONLY	Resource name (runbooks/{id})
display_name	string		Human-readable name for the runbook
description	string		Short description of what the runbook is for
text	string		The full runbook content with instructions for the agent
connections	RunbookConnection[]		Connections and tools available to the agent while executing this runbook
session_name	string		Agent session that created or manages this runbook (agents/{agent}/sessions/{session})
create_time	timestamp	OUTPUT_ONLY	When the runbook was created
update_time	timestamp	OUTPUT_ONLY	When the runbook was last modified
delete_time	timestamp	OUTPUT_ONLY	When the runbook was soft-deleted (null if active)

Example

{
  "name": "runbooks/high-error-rate-triage",
  "displayName": "High Error Rate Triage",
  "description": "Steps for triaging elevated error rates on production services",
  "text": "1. Query the database for recent deployments.\n2. Check HTTP error rates via Prometheus.\n3. If a recent deploy correlates, escalate to the owning team.",
  "connections": [
    {
      "name": "connections/prod-postgres",
      "enabledTools": ["TOOL_POSTGRES_QUERY"]
    },
    {
      "name": "connections/prod-prometheus",
      "enabledTools": ["TOOL_PROMQL_QUERY", "TOOL_PROMQL_QUERY_RANGE"]
    }
  ],
  "createTime": "2024-08-10T09:00:00Z",
  "updateTime": "2024-08-10T09:00:00Z"
}

Runbook Connection

Field	Type	Description
name	string	Resource name of the connection (connections/{id})
enabled_tools	Tool[]	Which tools from this connection the agent may use (e.g. TOOL_POSTGRES_QUERY, TOOL_HTTP_REQUEST)