Skip to main content
Glama

GoCanvas MCP by usefulapi

Get a GoCanvas form definition

gocanvas_get_form
Read-only

One form definition, including its screens and entries (field ids and labels). Use format 'flat' for the simplest list of fields (what you need to read submissions or create a dispatch), 'nested' (default) for the full structure, 'metadata' or 'minimal' for less.

Input Schema

NameRequiredDescriptionDefault
formatNoDefinition format (default nested).
form_idYesThe form id (from gocanvas_list_forms).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds that the response includes screens and entries with field ids and labels, but says nothing about size/rate behavior or what 'metadata' and 'minimal' actually strip out.

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?

Two tight sentences with the resource stated first and the format guidance front-loaded. The trailing 'or "metadata" or "minimal" for less' is slightly loose but not wasteful.

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 carries the burden of saying what comes back, and it does identify screens and entries with field ids and labels. It is sufficient for a 2-parameter read tool, missing only the distinction between the two sparse formats.

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 100%, so the baseline is 3, but the description genuinely adds meaning: 'flat' is framed as the required shape for reading submissions or creating a dispatch, and 'nested' is confirmed as the full-structure default. The weak spot is 'metadata' or 'minimal' for less', which does not distinguish the two enum values.

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?

States a specific verb and resource: retrieves 'one form definition, including its screens and entries (field ids and labels).' The scope (single definition, contents included) is clear, but the description never names the sibling it complements (gocanvas_list_forms for the id, gocanvas_get_submission for the data).

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

Usage Guidelines3/5

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

'flat' is tied to concrete downstream tasks (read submissions, create a dispatch), which is useful guidance for the format choice. However, there is no explicit statement of when to call this tool versus gocanvas_list_forms or gocanvas_get_submission, so tool-selection guidance remains implied.

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.