Skip to main content
Glama
@hyperstar/mcp

@hyperstar/mcp

Official

Update Form

update_form

Replace a workspace form's fields, name, and guide text while preserving immutable snapshots for links already sent.

Instructions

Replace a workspace form configuration. Sent links retain immutable snapshots.

Input Schema

NameRequiredDescriptionDefault
nameYes
fieldsYes
form_idYes
guide_textYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.0

TDQS

C2.4/5.0
Behavior1/5

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

The description says 'Replace a workspace form configuration,' which implies overwriting existing configuration, while the annotations declare destructiveHint=false. That is an inconsistency. The sentence about sent links retaining immutable snapshots is useful context, but the replace/destructive mismatch is a direct behavioral conflict.

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?

Two short sentences, front-loaded with the operation and then the important snapshot behavior. There is no wasted wording.

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 tool has a nontrivial nested schema with four required top-level parameters and an enum-constrained fields array, plus no output schema. The description is far too sparse to prepare an agent for that complexity, especially with 0% schema description coverage.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% and the description mentions none of the four required parameters: form_id, name, guide_text, or the nested fields array. It adds no meaning about the required form identifier, field definitions, limits, or enum-constrained field types.

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: 'Replace a workspace form configuration.' This is clear enough to distinguish it from list/get/create/delete form siblings, though it does not explicitly name those alternatives.

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 word 'Replace' implies this is for changing an existing form, but the description gives no explicit when-to-use guidance, prerequisites, or comparison to create_form/delete_form. An agent must infer the context.

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