Skip to main content
Glama

get_form

Read-only

Retrieve a single form by ID from your Checkout Page account.

Use this tool when you already know the form ID and want to inspect the current configuration.

If the form ID does not exist, returns a 404 error: "Form not found".

Example uses:

  • "Fetch form 6812fe6e9f39b6760576f01c"

  • "Show me the current settings for form X"

  • "Check whether this form is draft, published or archived"

  • "Inspect the fields, files, images, or redirect settings on this form"

For create flows, use create_form. For a direct lookup after creation, pass the returned page id into this tool.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageIdYesThe ID of the form to retrieve. You can get this from `create_form`, the dashboard, or another Checkout Page API response.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYes

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, destructiveHint=false, and openWorldHint=false, so safety is covered structurally. The description adds genuine behavioral context beyond that: the not-found error message and the kinds of state (draft/published/archived) and settings it exposes.

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?

Front-loads the core purpose in one sentence, then usage, then error behavior. The four example uses are somewhat repetitive with the guidance above, costing a little efficiency, but each sentence still earns its place.

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?

Output schema exists, so return values needn't be described. For a single-parameter read tool with full annotation coverage, the purpose, routing, error behavior, and ID sourcing are all covered.

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% and the pageId pattern/description already document format and provenance. The description's only addition is naming `create_form` as a source of the ID, which is marginal beyond the schema.

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 (Retrieve) and resource (a single form by ID), and the phrase 'single form by ID' distinguishes it from list_forms and from the many other get_* siblings that target different resources.

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

Usage Guidelines5/5

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

Explicitly names the condition ('when you already know the form ID and want to inspect the current configuration'), routes create flows to `create_form`, and explains the post-creation lookup path. The 404 case is also covered.

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