Skip to main content
Glama

get_automation_docs

Read-only

Read Fieldproxy's automation reference. Topics: 'overview' (rule anatomy), 'triggers' (every trigger type and the {{trigger.*}} data it provides), 'steps' (the step library), 'recipes' (complete working automations). 'steps' and 'recipes' are large: call without section to get their section list, then ask for one section.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topicYes
sectionNoA section key or heading, e.g. 'send_email' or 'dunning'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds behavior the annotations cannot: which topics return oversized payloads and the required two-step enumeration-then-fetch pattern. It doesn't discuss failure modes for bad topic/section keys, which keeps it from a 5.

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?

Four compact sentences with zero filler, front-loaded with the core action before the topic list. The critical two-step retrieval caveat is placed last where it is most actionable.

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 a two-parameter documentation reader with no output schema, the description conveys what each topic returns and how to page through the large ones, which is the essential contextual load. A brief note on what a bare section-list response looks like would make it fully self-sufficient.

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 coverage is 50% and the `topic` property has an enum but no schema-level description, so the description carries real weight by defining what each of the four enum values contains. It also explains that `section` takes a key or heading with examples like 'send_email' and 'dunning', reinforcing the schema text rather than merely repeating it.

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 Fieldproxy's automation reference') and then enumerates the exact coverage of each topic (rule anatomy, trigger types, step library, working recipes). This is unmistakably distinct from the adjacent documentation siblings like get_widget_docs and describe_schema, so an agent can route without opening the 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?

It gives concrete operating guidance: 'steps' and 'recipes' are large, so call without `section` to get the section list, then request one section. That is a clear when/how pattern. It does not, however, say when to prefer this over the other reference tools (get_widget_docs, describe_schema), so it stops short of full alternatives guidance.

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.