Skip to main content
Glama

place_widget

Display markdown, tables, charts, metrics, status lists, or live architecture maps on the mcp-screen browser canvas so terminal agents can show visual output and return a widget ID.

Instructions

Show something to the human on their mcp-screen canvas (a browser tab next to the terminal). Returns the widget id. Widget kinds and their data:

  • markdown {markdown}

  • text {text} (monospace log/output)

  • table {columns: string[], rows: cell[][]} (sortable; row clicks become the widget selection)

  • chart {type: "bar"|"line", labels: string[], values: number[], unit?, linkTo?: tableId} (bar clicks become the selection and filter the linked table)

  • metric {value, label?, delta?}

  • kv {items: {key: value}}

  • status-list {items: [{label, status: "ok"|"fail"|"pending"|"unknown", detail?}]}

  • livemap {root?, nodes: [{id, label, globs: string[], layer?, description?}], edges: [{from, to, label?}]} (architecture diagram; file edits matching a node's globs light it up live)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
hNoHeight in grid rows, 1-4.
wNoWidth in grid columns, 1-4.
idNoOptional stable id, e.g. "ci-failures".
dataYesPayload matching the kind (see description).
kindYes
titleYes
sourceNoOptional live source, re-run server-side every intervalMs with no LLM. {type:"command", argv:[...], cwd?, parse?:"json"|"text"} (no shell) | {type:"url", url, parse?} | {type:"mcp", tool, arguments?} (wrap mode only). NOTHING runs until the human clicks Approve on the canvas; approved sources go on a persistent allow-list. Output must match the widget data shape (or be text for markdown/text/metric).
intervalMsNoRefresh interval for a live source, min 2000, default 30000.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior5/5

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

With no annotations, the description carries the behavioral burden and does so well: it discloses that live sources re-run server-side with no LLM, that 'NOTHING runs until the human clicks Approve on the canvas,' that approved sources go on a persistent allow-list, that livemap nodes light up on matching file edits, and that source output must match the widget data shape. These are non-obvious, high-consequence behaviors the schema does not express.

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?

Purpose and return value are front-loaded in one sentence, then a tight bulleted payload catalogue follows. It is long, but nearly every line is load-bearing for an 8-kind polymorphic tool; only the parentheticals (e.g. 'sortable', 'monospace log/output') shade into extra detail.

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?

For a complex, nested, no-annotation tool this covers the essentials: kinds, payload shapes, live-source gating, refresh interval, and the returned id. It omits secondary behavior an agent might need — default layout/size handling for h/w/w, whether an existing id collides or updates, and any widget-count limits — but nothing that blocks a correct call.

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

Parameters5/5

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

The schema's `data` field is a bare 'Payload matching the kind (see description)' pointer, so the description is the only place the per-kind payload contracts are defined (table columns/rows, chart type/labels/values/linkTo, metric, kv, status-list statuses, livemap nodes/globs/edges). At 75% coverage with 8 params and deep nesting, this compensates fully for the schema gap.

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 ('Show something to the human on their mcp-screen canvas') and the return value ('Returns the widget id'), which clearly frames this as the creation/display tool. The eight-item widget-kind list reinforces that this is the create path. It never explicitly names or contrasts with update_widget or read_widget, so sibling differentiation is left implicit.

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 rather than stated: the widget-kind catalogue tells the agent what it can render, and the first sentence implies 'use this when you want the human to see something.' There is no explicit statement of when to prefer place_widget over update_widget, post_report, or ask_user, and no stated exclusions.

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