Skip to main content
Glama

Read widget

read_widget
Read-only

One widget in full, plus issues — what is still missing before it could go live. Includes its questions, quiz questions and options, quiz tiers and calculator inputs. Which of those are meaningful depends on the kind: questions for lead-magnet and survey, quiz fields for quiz, calculator inputs for calculator, none for popup and announcement-bar. placement says where it shows on a site: popups and bars run on every page, every other kind only where a page embeds it — going live alone does not place it on any page.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectNoA project id from list_projects. Runs this call in that project instead of the connection default.
widgetIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already establish that this is a read-only, non-destructive, non-open-world operation. The description adds meaningful behavior beyond annotations: it explains what `issues` represents, that returned fields vary by widget kind, and how `placement` works for popups, bars, and embed-only widgets.

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?

The description is front-loaded with the core result (`One widget in full, plus issues`) and then supplies only relevant kind-specific and placement context. The sentences are dense but each earns its place by helping interpret the returned widget data.

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 explaining the returned payload, and it does so well by describing the widget contents, `issues`, kind-dependent fields, and placement behavior. The main remaining gap is parameter-level detail, especially for `widgetId`, but the return semantics are otherwise sufficiently covered.

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

Parameters2/5

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

The schema documents the `project` parameter but gives only the name and minLength for the required `widgetId` parameter, resulting in 50% description coverage. The tool description does not mention either parameter, so it fails to compensate for the undocumented `widgetId` semantics.

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?

The description clearly states that this returns one widget in full plus `issues`, including its kind-dependent subobjects. It is specific about the resource and scope, but it does not explicitly distinguish itself from siblings such as `list_widgets` or `read_widget_results`.

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?

Usage is implied through phrases like `issues — what is still missing before it could go live`, suggesting it is useful when checking readiness before publishing. However, there is no explicit when-to-use guidance or comparison to alternative tools.

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.