Skip to main content
Glama

Get Alert Settings

get_alert_settings
Read-onlyIdempotent

Retrieve workspace email-alert settings: enabled status, digest cadence, plan floor, and available cadence options. Use before updating alerts to choose a valid cadence and after to confirm changes.

Instructions

Get the account's email-alert settings: enabled, cadenceMinutes (the digest interval in effect), minIntervalMinutes (the fastest cadence the plan allows), and availableCadences (the subset of 15, 30, 60, 120, 180, 240, 720, 1440 at or above that floor). cadenceMinutes is never reported below the floor, even if a faster value was saved before a plan downgrade. Call it before update_alert_settings to pick a value from availableCadences, and after it to confirm what applied. Read-only; the digests themselves are sent by the platform on that cadence.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_alert_settings"
  }
}

Input Schema

NameRequiredDescriptionDefault
workspaceIdNoWorkspace to act in: an id from list_workspaces. Omit to use the default workspace. Use the same workspaceId for every call about the same workspace, since ids from one workspace do not exist in another

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv1.6.0
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / workspaceId
      Added value: +{
      +  "description": "Workspace to act in: an id from list_workspaces. Omit to use the default workspace. Use the same workspaceId for every call about the same workspace, since ids from one workspace do not exist in another",
      +  "type": "string"
      +}
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • addedOutput schema / properties / result / additionalProperties
      Added value: +true
    • removedOutput schema / properties / result / description
      Removed value: -"{ enabled, cadenceMinutes, minIntervalMinutes, availableCadences }: the cadence in effect, the plan floor, and the cadences you may pick."
    • addedOutput schema / properties / result / properties
      Added value: +{
      +  "availableCadences": {
      +    "description": "Cadences, in minutes, that update_alert_settings accepts on this plan",
      +    "items": {
      +      "type": "integer"
      +    },
      +    "type": "array"
      +  },
      +  "cadenceMinutes": {
      +    "description": "Digest interval in effect, in minutes",
      +    "type": "integer"
      +  },
      +  "enabled": {
      +    "description": "Whether mention digest emails are sent",
      +    "type": "boolean"
      +  },
      +  "minIntervalMinutes": {
      +    "description": "Fastest cadence the plan allows, in minutes",
      +    "type": "integer"
      +  }
      +}
    • addedOutput schema / properties / result / required
      Added value: +[
      +  "enabled",
      +  "cadenceMinutes",
      +  "minIntervalMinutes",
      +  "availableCadences"
      +]
    • addedOutput schema / properties / result / type
      Added value: +"object"
    • addedOutput schema / required
      Added value: +[
      +  "result"
      +]
  2. Changed1 schema field changedv0.1.1
    • changedOutput schema / properties / result / description
      Previous value: -"The alert settings: enabled flag, cadence in minutes, the plan's fastest allowed cadence, and available cadence options."New value: +"{ enabled, cadenceMinutes, minIntervalMinutes, availableCadences }: the cadence in effect, the plan floor, and the cadences you may pick."
  3. First observedv0.1.0

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare readOnlyHint and idempotentHint, so the safety profile is covered, yet the description still adds substantive behavior: cadenceMinutes is clamped to the plan floor even when a faster value was previously saved after a downgrade. It also clarifies the platform, not the caller, sends the digests on that cadence, which prevents a wrong assumption about who triggers delivery.

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?

It is front-loaded with the resource and the returned fields, then closes with the call-ordering advice and read-only note. Every sentence carries information, though the dense parenthetical field explanations make it read as a single wall of text rather than scannable structure.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a single-parameter read tool with a full output schema and complete annotations, the description covers everything an agent needs: what is returned, the plan-floor semantics that make cadenceMinutes surprising, and when to call relative to the update sibling.

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 coverage is 100% for the single workspaceId parameter, including default-workspace behavior and cross-workspace id caveats, so the schema carries this burden fully. The description never mentions workspaceId and adds no semantics beyond it; a baseline 3 is appropriate when the schema already does the work.

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?

The description names a specific verb and resource ('Get the account's email-alert settings') and then enumerates exactly what comes back (enabled, cadenceMinutes, minIntervalMinutes, availableCadences). An agent can distinguish it immediately from update_alert_settings without opening either schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives explicit sequencing guidance: call before update_alert_settings to pick a valid value from availableCadences, and after it to confirm what applied. That names the alternative sibling and the condition that selects it, leaving nothing to inference.

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