Skip to main content
Glama
t0knight
by t0knight

get_custom_widget

Retrieve a custom widget's complete source code, default model, events, name, and grid position using its ID. Errors if the widget is not a custom widget.

Instructions

Return a Custom Widget's full source (srcDoc html/css/js), defaultModel, events, name, and grid position. Errors if the id is not a CUSTOM_WIDGET.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
widget_idYes
Behavior3/5

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

With no annotations, the description carries full burden. It discloses error behavior ('Errors if the id is not a CUSTOM_WIDGET') but does not state read-only nature, permissions, or potential side effects. Adequate but could be more explicit.

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?

Single sentence, front-loaded with key return values, no redundant words. Efficient and well-structured.

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 simple get tool with one parameter and no output schema, the description covers return fields and error condition. It omits some detail (e.g., that widget must exist) but is largely complete.

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?

Schema coverage is 0%, but the description does not elaborate on the widget_id parameter beyond its name. It does not specify format, constraints, or source of the ID, leaving the agent to infer from the schema alone.

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 clearly states the verb 'Return' and specifies the exact fields the tool returns: full source, defaultModel, events, name, grid position. It also distinguishes from sibling tools like get_widget and get_widget_schema by focusing on custom widgets and detailed source code.

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

Usage Guidelines2/5

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

No explicit guidance on when to use this tool versus alternatives. The description does not mention specific scenarios or compare with other tools like get_widget or create_custom_widget.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/t0knight/appsmith-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server