Skip to main content
Glama

Read Automation Policy

readAutomationPolicy
Read-onlyIdempotent

Read an automation's whole Policy before answering anything about it: every question by section, with its id (the field id updateConfigField takes), key, type, answer and who gave it; counts.questions as the Policy screen's header counts them (required_open is what still blocks a run) apart from the module's pre-filled module_defaults; answers proposed by interviews and waiting for review; accepted and pending process-context notes; the interviews assigned; and pending_apply, the structural answers and notes not yet written into an Agent. running says whether the automation runs on live work: there a changed answer reaches its Agents from their next run, so name the question, its current answer and the new one, and change it only after the user says yes. A question whose bindings include structural changes how the Agents run; propose the matching Agent change too. Never invent an answer for a question shown as open. Give the user the full URLs in urls.

Input Schema

NameRequiredDescriptionDefault
automation_idYesAutomation ID
include_hiddenNoAlso list the questions a person hid, under hidden_fields. Defaults to false.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.3/5.0
Behavior5/5

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

Annotations already cover read-only/idempotent/non-destructive, and the description adds substantial context on top: the meaning of `running` (live work, answers reach Agents from their next run), the `structural` binding implication, the ban on inventing answers for open questions, and the instruction to surface full URLs. None of this is derivable from the structured fields.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads the purpose well, but the body is one dense run-on with heavily chained clauses (counts, module_defaults, pending_apply, running, bindings) that is hard to scan. Every element is arguably relevant, yet it would benefit from being broken into shorter, structured sentences.

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?

There is no output schema, so the description carries the full burden of describing return values — and it does so field by field, including nested concepts like counts.questions, module_defaults, pending_apply and urls. An agent has everything needed to call it and interpret the result.

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 automation_id and include_hidden are already documented, and the enum on include_hidden is self-explanatory. The description explains the returned `id` field's link to updateConfigField but says nothing about the two input parameters beyond what the schema provides.

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 ('Read an automation's whole Policy') and then enumerates the return payload by name — questions by section, counts.questions, module_defaults, pending_apply, urls — which lets an agent distinguish it from getAutomation, getAutomationCurrent and readAutomationDashboardData without opening a schema.

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?

Gives a clear trigger ('before answering anything about it') and conditional rules for the running case ('change it only after the user says yes') plus the structural-bindings follow-up. It does not name an alternative sibling to use instead, so it stops short of full when/when-not routing.

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