Available Tools
The Widget Builder MCP Server provides the following tools that AI assistants can use to manage your widgets.
Widget Management
list_widgets
List all custom widgets for your account. Returns a summary of each widget including GUID, title, active status, and timestamps.
Parameters: None
Returns: Array of widgets with guid, title, isActive, updateTimestamp, and createTimestamp.
Required scope: widgets:read
get_widget
Get full details of a specific widget by its GUID. Includes the Handlebars template, form field definitions, variables, translations, and API configuration.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
guid | string | Yes | The widget's unique identifier |
Required scope: widgets:read
create_widget
Create a new widget with a title and optional Handlebars HTML template, form fields, variables, and translations.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
title | string | Yes | The widget title |
template | string | No | Handlebars HTML template |
form | array | No | Form field definitions (editor settings) |
variables | array | No | Widget variables for interactive state |
translations | object | No | Translation key-value pairs per language |
isActive | boolean | No | Whether the widget is immediately active (default: false) |
Required scope: widgets:write
update_widget
Update an existing widget. Only provided fields are updated — omitted fields remain unchanged.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
guid | string | Yes | The widget's unique identifier |
title | string | No | New widget title |
template | string | No | Updated Handlebars template |
form | array | No | Updated form fields |
variables | array | No | Updated variables |
translations | object | No | Updated translations |
isActive | boolean | No | Activate or deactivate the widget |
Required scope: widgets:write
delete_widget
Permanently delete a widget by its GUID. This action cannot be undone.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
guid | string | Yes | The widget's unique identifier |
Required scope: widgets:write
Built-in Widgets
list_builtin_widgets
List all built-in widgets that are activated for your account. Returns GUID, version, title, and icon for each built-in widget.
Parameters: None
Required scope: widgets:read
get_builtin_widget
Get full details of a built-in widget by its GUID, including the HTML template, form fields, variables, translations, and API configuration.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
guid | string | Yes | The built-in widget's unique identifier |
Required scope: widgets:read
Template Rendering
test_render
Test-render a Handlebars template server-side without a browser. Returns the rendered HTML output and any compilation errors. You can render an existing widget by GUID or provide a raw template string.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
guid | string | No | Widget GUID to render (optional if template is provided) |
template | string | No | Raw Handlebars template string (optional if guid is provided) |
data | object | No | Sample data context for template rendering |
settings | object | No | Sample settings values for template rendering |
Required scope: render
Use test_render to validate templates before creating or updating widgets. This helps catch Handlebars syntax errors early.
Documentation
get_widget_guide
Retrieve the complete widget building guide. This includes documentation on Handlebars syntax, all available helpers with examples, form field types, variables, translations, Tailwind CSS usage, and a complete example widget.
Parameters: None
Required scope: None (available to all authenticated tokens)
Permission Scopes
Each API token has one or more permission scopes that control which tools it can access:
| Scope | Tools |
|---|---|
widgets:read | list_widgets, get_widget, list_builtin_widgets, get_builtin_widget |
widgets:write | create_widget, update_widget, delete_widget |
render | test_render |
| (no scope needed) | get_widget_guide |
By default, new tokens are created with all three scopes: widgets:read, widgets:write, and render.
Built-in Prompts
The MCP Server also provides guided prompts that walk AI assistants through multi-step workflows:
create_widget
A guided workflow for creating a new widget from scratch. The AI assistant will:
- Read the widget building guide
- Gather your requirements (data structure, desired layout)
- Build the HTML template with Handlebars and Tailwind CSS
- Test-render the template to validate it
- Create the widget in your account
improve_widget
A guided workflow for improving an existing widget. Provide a widget GUID and the AI assistant will:
- Retrieve the widget's current template and configuration
- Review it against best practices
- Suggest specific improvements
- Test-render the updated template
- Apply the changes
Next steps
Ready to try it out? Ask your AI assistant to:
- "List my widgets"
- "Create a weather widget that shows the current temperature"
- "Improve my KPI Dashboard widget"