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 establish the safe read-only, non-open-world profile, and the description adds genuinely useful behavioral context beyond them: it discloses that 'steps' and 'recipes' are large and require a two-step retrieval pattern to avoid oversized responses. It doesn't discuss truncation or formatting of returned content, which would earn 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?

Three sentences, front-loaded with the purpose, then the topic enumeration, then the operational caveat about large topics. No filler and every clause carries information.

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?

With no output schema, the description usefully explains what comes back (a section list vs. a section's content) and how to navigate the large topics. It is nearly complete for a docs-retrieval tool; only the fallback behavior for an unknown section key is unspecified.

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 only 50%, and the enum values for `topic` carry no schema descriptions; the description compensates by defining all four topic values. It also clarifies the intended interaction pattern for `section` (omit to list sections, supply a key to fetch one) beyond the schema's example.

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 enumerates exactly what each topic contains, so an agent knows precisely what knowledge it retrieves. It is clearly distinguishable from sibling doc tools like get_widget_docs and describe_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 explicit procedural guidance: for the large 'steps' and 'recipes' topics, call without `section` to get the section list and then request one section. It does not, however, say when to prefer this tool over sibling documentation tools, so it stops short of full when/when-not coverage.

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.