Skip to main content
Glama
brilliantdirectories

brilliant-directories-mcp

Official
by brilliantdirectories
OverviewSchemaSourceRelated ServersDiscussions(1)Admin
JavaScript
Remote

getWidget

Read-onlyIdempotent

Fetch a single widget record by widget_id to view metadata or restore HTML/CSS/JS with include_code=1 for editing or auditing. Read-only.

Instructions

Get a single widget - Fetch a single widget record by widget_id. Read-only.

Lean-by-default keep-list: returns only widget_id, widget_name, widget_type, short_code, date_updated, revision_timestamp, is_default. The code fields (widget_data, widget_style, widget_javascript) are stripped — restore with include_code=1.

Use when: you have a widget_id (from listWidgets or admin) and want the widget's SOURCE code to edit or audit. To preview the rendered widget on the front-end, embed it on a page via [widget=Name] shortcode and view the page.

Required: widget_id (path parameter).

See also: listWidgets (enumerate), updateWidget (modify).

Returns: { status: "success", message: [{...record}] } - the message array contains 1 record with all widget fields (widget_data = HTML, widget_style = CSS, widget_javascript = JS, plus metadata).

For the full field list, see listWidgets.

Input Schema

NameRequiredDescriptionDefault
widget_idYes
include_codeNoOpt in to return `widget_data`, `widget_style`, `widget_javascript` (the HTML/CSS/JS). Default stripped. Needed before `updateWidget` edits to the code.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv6.58.0
    • addedInput schema / properties / include_code
      Added value: +{
+  "default": 0,
+  "description": "Opt in to return `widget_data`, `widget_style`, `widget_javascript` (the HTML/CSS/JS). Default stripped. Needed before `updateWidget` edits to the code.",
+  "enum": [
+    0,
+    1
+  ],
+  "type": "integer"
+}
  2. Addedv6.55.39
  3. Removedv6.55.19
  4. Addedv6.49.4
  5. Removedv6.48.1
  6. Addedv6.0.19
  7. Removedv6.0.18
  8. Addedv6.0.7
  9. Removed
  10. First observedv1.0.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive), and the description adds genuinely new behavior: a lean-by-default keep-list, the specific fields stripped (`widget_data`/`widget_style`/`widget_javascript`), and the `include_code=1` restore path. It loses a point because the later 'Returns' block says the message array contains 'all widget fields' including the code fields, which conflicts with the lean-by-default claim and could mislead an agent about what it actually gets.

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?

It is front-loaded with the essential operation and keep-list before the routing guidance, and each block is short. It is longer than strictly necessary, and the trailing 'Returns' paragraph partly repeats and partly contradicts the keep-list rather than adding new information.

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?

With no output schema, the description takes on the return-value burden and does so, including the `{ status, message: [...] }` envelope shape and the meaning of the code fields. Required param, default behavior, and sibling routing are all present, so an agent has everything needed to call it correctly.

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

Parameters4/5

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

Schema coverage is only 50% (`widget_id` has no schema description), and the description compensates by marking it required and identifying it as a path parameter. It also reinforces `include_code`'s default-stripped behavior and ties it to the `updateWidget` edit workflow, adding meaning beyond the enum's own description.

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?

The description opens with a specific verb+resource ('Fetch a single widget record by `widget_id`') and immediately distinguishes itself from `listWidgets` (enumerate), `updateWidget` (modify), and `renderWidget` (preview via shortcode). An agent can select this tool without opening any schema.

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

Usage Guidelines5/5

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

It gives an explicit 'Use when' condition (you hold a `widget_id` and need SOURCE code to edit or audit) and an explicit exclusion with an alternative path for the rendered-preview case (embed via `[widget=Name]` shortcode). 'See also' names the adjacent siblings with their roles.

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

Deploy Server

Other Tools