Skip to main content
Glama

Get Better Widget Guide

get-widget-guide
Read-onlyIdempotent

Returns a build brief for an interactive widget on an article or landing page, such as a calculator, estimator, converter, quiz or checklist. Pass what is known about the widget. The response lists any details still missing, and once the details are complete it returns the brief with rules for calculation accuracy, form behavior, search visibility, performance and privacy. With format: "page-family" it returns a brief for a family of pages built from the rows of a dataset, such as a CSV or a database table.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formatNoWhat to build: one widget (the default), or a page family, meaning one page for each row of a dataset such as a CSV or a database table.
inputsNoRequired inputs, including units, allowed ranges, and defaults.
resultNoWhat the result shows, explains, and lets the user do next.
userGoalNoWho will use the widget or read each page, and the decision or task it helps them complete.
maxTokensNoMaximum tokens to return. Truncates content to fit. Recommended: 5000-10000.
dataSourceNoPage family: where the rows live, such as a CSV path or a table, and about how many rows there are.
urlPatternNoPage family: the route and slug rule, such as /integrations/[slug].
widgetTypeNoWidget kind: calculator, estimator, converter, generator, quiz, or checklist.
interactionNoHow readers tune inputs and see feedback, including presets, custom controls, direct manipulation, and exact-value entry.
uniqueValueNoPage family: what each page gives a reader that only its row provides, such as its data or a widget filled with its values.
hostFrameworkNoThe host framework and the page or component that will contain the widget.
visualContextNoExisting design tokens, components, or brand reference the widget must match.
transformationNoFormula, scoring rule, conversion, or transformation that produces the result.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and non-openWorld, so the safety profile is covered. The description adds genuine behavior beyond that: an iterative fill-in-the-gaps flow and the contents of the returned brief (calculation accuracy, form behavior, search visibility, performance, privacy rules).

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?

Three sentences, front-loaded with the core purpose, then the interaction model, then the alternate mode. Slightly dense in the final sentence but every clause conveys distinct information with no filler.

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 present, the description must describe the return value, and it does: missing-details list followed by the brief with its rule categories. Combined with 100% schema coverage on 13 parameters, the definition is nearly self-sufficient; only the omission of truncation/response-size behavior (left to the maxTokens schema field) keeps it off a 5.

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% across all 13 parameters, so the schema already carries the parameter documentation. The description reinforces only the `format` enum meaning ('page-family' returns a brief for a family of pages built from dataset rows), which the schema also states. Baseline 3 applies.

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: 'Returns a build brief for an interactive widget on an article or landing page', and enumerates what the brief contains. The resource is unambiguous against sibling guide tools (get-jig-guide, get-motion-guide), but the description never explicitly distinguishes itself from those siblings.

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

Usage Guidelines4/5

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

Gives clear invocation context: 'Pass what is known about the widget', implying partial input is acceptable, and the response tells the caller what is still missing. The page-family mode is scoped with a concrete example. No explicit when-not-to-use or named alternatives are given.

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.