Skip to main content
Glama

form_get_form_layout_schema

Retrieves the form layout schema for a runnable item so you can render or validate its input form.

Instructions

Get form layout schema for runnable item. Get the layout schema for the provided runnable item, given that it exists on the specified endpoint POST /form-service/api/custom/schema-generation/form

Input Schema

NameRequiredDescriptionDefault
bodyYesRunnable item

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

C2.8/5.0
Behavior2/5

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

Annotations already state readOnlyHint=false, idempotentHint=false and openWorldHint=true, so the agent learns this is a non-idempotent, side-effecting-style call. The description adds only the POST path and does not explain why a 'get' is non-read-only, what the server generates, or what to expect on failure. It does not contradict the annotations, but it does little beyond them.

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?

Only three lines, but the first sentence ('Get form layout schema for runnable item') is fully restated by the second ('Get the layout schema for the provided runnable item'). That duplication wastes the most valuable front-loaded position.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The body is a nested object of substantial complexity and there is no output schema, yet the description never explains what a layout schema contains, how it relates to the runnable item, or what the caller gets back. For a non-idempotent, open-world call, this leaves too much implicit.

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 baseline is 3. The description contributes only the notion that the body is a 'runnable item', which mildly clarifies intent, but no detail on which nested fields (inputBindings, inputParameters, endpointLink) matter.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb+resource: retrieve the layout schema for a runnable item, tied to the schema-generation endpoint. It does not, however, distinguish it from the many related siblings (form_generate_json_schema, form_generate_elements_runnable_item, form_get_json_object_schema), so an agent cannot tell from the text alone which schema tool it needs.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The only conditional is the tautological 'given that it exists on the specified endpoint'. There is no guidance on when to prefer this over the sibling schema-generation tools, nor any exclusions or prerequisites.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools