Skip to main content
Glama

Add text widget

add_text_widget

Add a rich-text widget to a page. The body accepts Markdown. Position, width, and height use sensible defaults.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
textNoBody text. Markdown is rendered: # / ## / ### headings, - and 1. lists, **bold**, *italic*, ~~strike~~, `code`, > quotes, ``` fences and [links](url). Plain prose works too — it becomes paragraphs. Defaults to empty.
page_idYesPage ID the widget will be placed on, from list_pages.
client_idYesClient ID the report belongs to (from list_clients).
source_idYesReport ID the widget belongs to (from list_reports).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNoThe text widget that was added — widget_id, plus the stored row with the defaults the server filled in (position, width, height).
successYesTrue when the call succeeded.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • changedInput schema / properties / text / description
      Previous value: -"Plain-text content. Defaults to empty."New value: +"Body text. Markdown is rendered: # / ## / ### headings, - and 1. lists, **bold**, *italic*, ~~strike~~, `code`, > quotes, ``` fences and [links](url). Plain prose works too — it becomes paragraphs. Defaults to empty."
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • changedOutput schema / properties / success / description
      Previous value: -"True when the call succeeded. A failure comes back as an error result instead."New value: +"True when the call succeeded."
  2. First observed

TDQS

A4.1/5.0
Behavior3/5

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

Annotations contribute readOnlyHint=false and destructiveHint=false, so the description is not required to re-state that this is a mutating but non-destructive operation. The description adds useful behavior context: Markdown is rendered and position/width/height have sensible defaults. It does not disclose side effects such as creation behavior, response contents, or permission requirements, so it stays at a moderate score.

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 with no filler. The primary purpose is front-loaded, and the Markdown capability and default-layout behavior are stated efficiently.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple create operation with a fully documented input schema and an output schema present, the description covers the essential behavior: what is added, what content format is supported, and the fact that layout defaults require no parameters. Nothing critical is missing.

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%, so the schema already thoroughly documents text, page_id, client_id, and source_id. The description adds little beyond repeating Markdown support and mentioning layout defaults that are not actual parameters. This is a solid baseline 3.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description uses a specific verb-resource pair ('Add a rich-text widget to a page') and explicitly mentions Markdown support, which differentiates it from sibling add_*_widget tools. The scope is immediately clear.

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?

The description gives clear context for when to use this tool: when adding a rich-text/Markdown widget to a page. It does not explicitly name alternatives or exclusion conditions, but the rich-text and Markdown cues are enough to route an agent correctly among the widget-add siblings.

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.

Resources