Skip to main content
Glama

Email alert rules

list_alert_rules
Read-onlyIdempotent

The company's email alert rules (delay over N days, arrived, delivered, tracking failed), their scope (all shipments, a tag or a carrier) and how many people get them. Read only: rules are created and changed in the web app (Settings > Notifications). Optional: include_inactive (default false) to add paused rules. Returns: rules[] {id, name, summary, rule_type, delay_days, delay_mode, failure_count, scope, scope_value, is_active, recipients {all_members, members, extra_emails}}.

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": "list_alert_rules"
  }
}

Input Schema

NameRequiredDescriptionDefault
companyNoWhich company to act for: its id, @handle or exact name (see list_companies). Omit for the connection's default company.
include_inactiveNoAlso list paused rules.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, and the description reinforces that mutation happens elsewhere rather than contradicting it. It also adds behavioral context annotations cannot carry: what a rule consists of (type, delay, failure count, scope, recipients) and that inactive rules are excluded by default.

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-loads the resource definition, then the read-only constraint, then optional behavior and the return shape. The trailing Returns clause is long but earns its place because no output schema exists; wording is dense rather than padded.

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?

With no output schema, the description carries the burden of explaining return values and does so field by field, including nested recipient fields. Combined with the read-only explanation and default for include_inactive, an agent has everything needed to call and interpret this tool correctly.

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%, so both parameters are already documented, and the description's note that include_inactive adds paused rules largely restates the schema. The surrounding explanation of what a rule and its scope mean adds modest value but no syntax or format guidance beyond the schema.

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?

Names the specific resource (the company's email alert rules), enumerates the rule types it covers (delay over N days, arrived, delivered, tracking failed), and states the scope and recipient dimensions. No sibling tool deals with alert configuration, so it is immediately distinguishable from list_shipments, list_carriers, and the rest.

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?

Makes the read-only nature explicit and redirects any write intent to the web app (Settings > Notifications), which answers the key 'when to use / when not to use' question for configuration data. It does not name alternative tools, but none of the siblings overlap, so the routing risk is low.

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.