Skip to main content
Glama

get_form

Read-only

A site's own form: the draft being worked on, what is published on the site, the starter HTML and CSS to begin from, the parts a form needs (data-help values) and the tags it may use. available says whether the plan can save one.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "product_id": "<product_id>"
    },
    "name": "get_form"
  }
}

Input Schema

NameRequiredDescriptionDefault
product_idYesThe site's id (a uuid), from list_products.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.1/5.0
Behavior4/5

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

Annotations already mark it read-only and closed-world, so the safety profile is covered. The description adds substantial value beyond that by enumerating what is returned – draft vs published versions, starter HTML/CSS, data-help values for form parts, usable tags – and flags the `available` field indicating whether the plan can save a form, which the annotations do not disclose.

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

Conciseness4/5

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

A single dense sentence with no filler, though the appended clause about `available` sits at the end rather than being integrated. Slightly list-like grammar but every element earns its place by naming returned content.

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

Completeness3/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 sketches the return payload, but it omits how this relates to sibling retrieval and modification tools (get_form_fields, save_form, publish_form), leaving an agent to infer the workflow. Adequate but incomplete for a tool in a crowded form-management family.

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?

Only one parameter (product_id) and schema coverage is 100%, with the schema already explaining it is the site's uuid from list_products. The description adds nothing about the parameter, so the baseline 3 applies.

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

Purpose3/5

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

The description reads as a noun phrase listing returned content ('the draft being worked on, what is published...') rather than stating a verb+resource, so the actual action (fetch a site's form definition) is only implied, aided by the annotation title 'Get the form's HTML and CSS'. It does not distinguish itself from siblings like get_form_fields or check_form, which an agent would need to tell apart.

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?

No statement of when to use this versus get_form_fields, check_form, save_form, publish_form, or use_simple_form. The only implicit cue is that it covers a form's HTML/CSS and available content, but no conditions or alternatives are named.

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