Skip to main content
Glama

List automations

list_automations
Read-only

List automations with optional filtering by report or client

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
client_idNoFilter by client ID (from list_clients)
report_idNoFilter by report ID (from list_reports)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNoOne row per automation — id, name, the report it sends, frequency and send time with its timezone, recipients, the template and sender it uses, whether it is paused, and next_run_at.
metaNoPage, limit and total row count.
successYesTrue when the call succeeded.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changed
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • changedOutput schema / properties / meta / description
      Previous value: -"Pagination for the list — page, limit and the total row count."New value: +"Page, limit and total row count."
    • changedOutput schema / properties / meta / properties / limit / description
      Previous value: -"Maximum rows per page."New value: +"Max rows per page."
    • changedOutput schema / properties / meta / properties / page / description
      Previous value: -"Zero-based index of the page returned."New value: +"Page index, zero-based."
    • changedOutput schema / properties / meta / properties / total / description
      Previous value: -"Total rows matching the query across all pages."New value: +"Total rows matching the query."
    • changedOutput schema / properties / success / description
      Previous value: -"True when the call succeeded. A failure comes back as an error result instead."New value: +"True when the call succeeded."
  2. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "data": {
      +      "description": "One row per automation — id, name, the report it sends, frequency and send time with its timezone, recipients, the template and sender it uses, whether it is paused, and next_run_at.",
      +      "items": {},
      +      "type": "array"
      +    },
      +    "meta": {
      +      "additionalProperties": true,
      +      "description": "Pagination for the list — page, limit and the total row count.",
      +      "properties": {
      +        "limit": {
      +          "description": "Maximum rows per page.",
      +          "type": "number"
      +        },
      +        "page": {
      +          "description": "Zero-based index of the page returned.",
      +          "type": "number"
      +        },
      +        "total": {
      +          "description": "Total rows matching the query across all pages.",
      +          "type": "number"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "success": {
      +      "description": "True when the call succeeded. A failure comes back as an error result instead.",
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "success"
      +  ],
      +  "type": "object"
      +}
  3. First observed

TDQS

A4.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safe read-only nature is covered. The description adds the optional-filter behavior, but does not disclose other behavioral details such as default scope when no filters are provided or any response characteristics beyond what the output schema likely conveys.

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?

A single, front-loaded sentence that states the core action and the only relevant nuance (optional filtering). There is no redundant restatement of the title or schema.

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 simple read-only list tool with zero required parameters, an output schema, and full schema coverage, the description plus annotations provide everything an agent needs to select and invoke it 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 description coverage is 100%: both client_id and report_id are already documented as filters, with helpful provenance ('from list_clients', 'from list_reports'). The description reinforces that filtering is optional but adds little meaning 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?

The description names a specific verb and resource ('List automations') and immediately clarifies the optional filtering dimensions (report or client). This cleanly distinguishes it from related siblings like create_automation, update_automation, and get_automation_history.

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?

The description makes clear this is the listing operation for automations with optional filters, which is distinct from the many other list_* tools. It does not explicitly state when not to use it, but the scope is unambiguous and there is no competing list-automations sibling.

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.

Resources