twelvebit Analytics

Change an alert

update_alert

DestructiveIdempotent

Change an alert's trigger, channel, target or custom text (subject, message), or turn it on or off with enabled. Get the id from list_alerts. When you change the channel, send a new target too.

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": {
      "alert_id": "<alert_id>"
    },
    "name": "update_alert"
  }
}

Input Schema

Name	Required	Description
`site`	No	Site domain (example.com), id or public id (tb_…). Optional with a site key, or when the account has one site.
`target`	No
`channel`	No
`enabled`	No
`message`	No	New custom message; null or an empty string for the default.
`subject`	No	New custom subject; null or an empty string for the default.
`trigger`	No
`alert_id`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedOct 23, 2026

TDQS

A4.1/5.0

Behavior4/5

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

Annotations already declare destructiveHint=true, idempotentHint=true, and openWorldHint=true, so safety is covered. The description adds the valuable cross-field rule that changing the channel requires a new target, which is behavioral context beyond the annotations. It doesn't clarify partial-update semantics or permission requirements, but the annotation coverage lowers the bar.

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?

Three short sentences, front-loaded with the field enumeration, followed by the id prerequisite and the conditional rule. No wasted text.

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 an 8-param mutation tool with no output schema, the description covers the modifiable fields, the id source, and the key dependency. Minor gaps remain around partial-update behavior and permissions, but the essentials for correct invocation are present.

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 description coverage is only 38% (target, channel, enabled, trigger undocumented in schema), but the description names all of these fields and explains the channel→target coupling, compensating for the gap. It adds real meaning beyond the sparse schema.

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 (change) and resource (alert) and enumerates exactly which fields can be modified (trigger, channel, target, subject, message, enabled). It is clearly distinguishable from create_alert and delete_alert by verb, though it doesn't explicitly name those siblings.

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?

'Get the id from list_alerts' gives a concrete prerequisite and routes the agent to the correct sibling. 'When you change the channel, send a new target too' provides a conditional dependency that would otherwise be missed. No explicit when-not guidance, but the usage context is clear.

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

All twelvebit Analytics tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?