Skip to main content
Glama

Set alert template

set_alert_template
DestructiveIdempotent

Requires the write scope or higher. Sets or clears one alert message template on a monitor; every other template is kept (read-modify-write). The template is validated for allowed variables before saving, and an empty template resets that entry to the built-in default. Event types: 'down', 'recovery', 'fail', 'every-run', 'success', 'started', 'blocked', 'note', 'expiring'. The template argument lists the variables.

Input Schema

NameRequiredDescriptionDefault
idYesMonitor UUID.
causeNoOptional cause for a per-cause override (e.g. 'silence', 'overrun', 'never_started', 'stalled', 'runaway', 'upstream'; 'cert' or 'domain' for 'expiring'). Omitted or empty: an event-type-wide template.
templateYesTemplate text with {variable} placeholders; an empty string resets to the default. Variables: {check_name}, {event}, {status}, {cause}, {last_ping}, {schedule}, {incident_url}, {run_url}, {branch}, {commit}, {actor}, {failing_stage}, {duration}, {latency}, {status_code}, {url}, {last_step}, {step_count}, {run_duration}, {body}, {detail}, {title}, {reminder}, {open_for}, {subject}, {expires_in}, {expires_at}, {issuer}, {registrar}, {monitors}. {failing_stage}: CI only (GitLab; GitHub workflow_job). {body}: the ping's text. {title}: the run's title. {reminder}, {open_for}: a reminder's number and age. {subject} to {monitors}: 'expiring' only.
event_typeYesEvent type: 'down', 'recovery', 'fail', 'every-run', 'success', 'started', 'blocked', 'note', 'expiring'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / cause / description
      Previous value: -"Optional cause for a per-cause override (e.g. 'silence', 'overrun', 'never_started', 'stalled', 'runaway', 'upstream'). Omitted or empty: an event-type-wide template."New value: +"Optional cause for a per-cause override (e.g. 'silence', 'overrun', 'never_started', 'stalled', 'runaway', 'upstream'; 'cert' or 'domain' for 'expiring'). Omitted or empty: an event-type-wide template."
    • changedInput schema / properties / event_type / description
      Previous value: -"Event type: 'down', 'recovery', 'fail', 'every-run', 'success', 'started', 'blocked', 'note'."New value: +"Event type: 'down', 'recovery', 'fail', 'every-run', 'success', 'started', 'blocked', 'note', 'expiring'."
    • changedInput schema / properties / template / description
      Previous value: -"Template text with {variable} placeholders; an empty string resets to the built-in default. Variables: {check_name}, {event}, {status}, {cause}, {last_ping}, {schedule}, {incident_url}, {run_url}, {branch}, {commit}, {actor}, {failing_stage}, {duration}, {latency}, {status_code}, {url}, {last_step}, {step_count}, {run_duration}, {body}, {detail}, {title}, {reminder}, {open_for}. {failing_stage}: CI only (GitLab; GitHub with workflow_job). {body}: the triggering ping's text (a 'blocked' or 'note' reason). {title}: the run's title, for 'fail', 'stalled' and 'overrun' when the run is identified. {reminder}, {open_for}: a reminder's number and how long its incident has been open, else empty."New value: +"Template text with {variable} placeholders; an empty string resets to the default. Variables: {check_name}, {event}, {status}, {cause}, {last_ping}, {schedule}, {incident_url}, {run_url}, {branch}, {commit}, {actor}, {failing_stage}, {duration}, {latency}, {status_code}, {url}, {last_step}, {step_count}, {run_duration}, {body}, {detail}, {title}, {reminder}, {open_for}, {subject}, {expires_in}, {expires_at}, {issuer}, {registrar}, {monitors}. {failing_stage}: CI only (GitLab; GitHub workflow_job). {body}: the ping's text. {title}: the run's title. {reminder}, {open_for}: a reminder's number and age. {subject} to {monitors}: 'expiring' only."
  2. Changed1 schema field changed
    • changedInput schema / properties / template / description
      Previous value: -"Template text with {variable} placeholders; an empty string resets to the built-in default. Variables: {check_name}, {event}, {status}, {cause}, {last_ping}, {schedule}, {incident_url}, {run_url}, {branch}, {commit}, {actor}, {failing_stage}, {duration}, {latency}, {status_code}, {url}, {last_step}, {step_count}, {run_duration}, {body}, {detail}, {title}. {failing_stage}: CI only; GitLab, GitHub when the webhook subscribes to workflow_job, not Jenkins. {body} is the triggering ping's text, which carries a 'blocked' or 'note' reason. {title} is the run's title (its /start body or /title), filled for 'fail', 'stalled' and 'overrun' when the run is identified; else empty."New value: +"Template text with {variable} placeholders; an empty string resets to the built-in default. Variables: {check_name}, {event}, {status}, {cause}, {last_ping}, {schedule}, {incident_url}, {run_url}, {branch}, {commit}, {actor}, {failing_stage}, {duration}, {latency}, {status_code}, {url}, {last_step}, {step_count}, {run_duration}, {body}, {detail}, {title}, {reminder}, {open_for}. {failing_stage}: CI only (GitLab; GitHub with workflow_job). {body}: the triggering ping's text (a 'blocked' or 'note' reason). {title}: the run's title, for 'fail', 'stalled' and 'overrun' when the run is identified. {reminder}, {open_for}: a reminder's number and how long its incident has been open, else empty."
  3. Changed2 schema fields changed
    • changedInput schema / properties / cause / description
      Previous value: -"Optional cause for a per-cause override (e.g. 'silence', 'overrun', 'never_started', 'stalled', 'runaway', 'upstream'). Omit or leave empty for an event-type-wide template."New value: +"Optional cause for a per-cause override (e.g. 'silence', 'overrun', 'never_started', 'stalled', 'runaway', 'upstream'). Omitted or empty: an event-type-wide template."
    • changedInput schema / properties / template / description
      Previous value: -"Template text with {variable} placeholders. Empty string resets to the built-in default."New value: +"Template text with {variable} placeholders; an empty string resets to the built-in default. Variables: {check_name}, {event}, {status}, {cause}, {last_ping}, {schedule}, {incident_url}, {run_url}, {branch}, {commit}, {actor}, {failing_stage}, {duration}, {latency}, {status_code}, {url}, {last_step}, {step_count}, {run_duration}, {body}, {detail}, {title}. {failing_stage}: CI only; GitLab, GitHub when the webhook subscribes to workflow_job, not Jenkins. {body} is the triggering ping's text, which carries a 'blocked' or 'note' reason. {title} is the run's title (its /start body or /title), filled for 'fail', 'stalled' and 'overrun' when the run is identified; else empty."
  4. Changed1 schema field changed
    • changedInput schema / properties / cause / description
      Previous value: -"Optional cause for a per-cause override (e.g. 'silence', 'overrun', 'never_started', 'stalled', 'runaway'). Omit or leave empty for an event-type-wide template."New value: +"Optional cause for a per-cause override (e.g. 'silence', 'overrun', 'never_started', 'stalled', 'runaway', 'upstream'). Omit or leave empty for an event-type-wide template."
  5. First observed

TDQS

A4.3/5.0
Behavior5/5

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

Goes well beyond annotations: declares that other templates are preserved (read-modify-write), that the template is validated against allowed variables before saving, that an empty string resets to built-in default, and that write scope is required. This meaningfully contextualizes the destructiveHint=true by showing the blast radius is limited to one entry.

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?

Front-loaded with the scope requirement and the core mutation semantics, and the sentences are dense with useful information. The enumeration of event types duplicates the schema's event_type field, which is the only real waste.

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?

For a destructive, idempotent 4-parameter mutation with no output schema, it covers permissions, side effects, validation, and reset behavior. It leaves the return value and the failure behavior on invalid variables implicit, which is the only gap.

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, cause, template and event_type are already documented in detail, including the allowed variable list and enum-style event types. The description restates the event-type list and 'the template argument lists the variables' without adding syntax or format guidance beyond the schema, so the baseline 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?

States a specific verb and resource ('Sets or clears one alert message template on a monitor') and immediately adds the read-modify-write scope, which makes it distinguishable from get_alert_templates and update_monitor. An agent knows exactly what single thing this call mutates.

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?

It gives a clear precondition ('Requires the write scope or higher') and an explicit behavioral fork: an empty template resets to the built-in default, so the agent knows both the set and clear cases are handled here. It does not name a sibling for reading templates first (get_alert_templates) or state when not to use it, so it stops short of full routing guidance.

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.