Skip to main content
Glama

Get a widget's properties

appsmith_get_widget

Retrieve a single widget's current properties from an Appsmith page without loading the full layout, making it easy to inspect values before making edits.

Instructions

Returns one widget's properties from a page, without dumping the whole layout. Use this to see current values before editing.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageIdYesPage id.
widgetNameYesWidget name as shown in the editor, e.g. spoa.
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral disclosure burden. It states it's read-only (returns properties), but doesn't disclose return format, whether widgetName must be unique across pages, how errors surface for non-existent widgets, or whether it requires the page to be published vs draft state. For a read operation with no annotations, minimal risk, but even basic output behavior is undocumented.

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 sentences, zero waste. The first sentence states purpose and differentiation; the second provides concrete usage guidance. Efficient and front-loaded.

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

Completeness3/5

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

For a simple 2-param read tool with 100% schema coverage, this is largely adequate. However, with no output schema and no annotations, the description could usefully note what a typical response looks like or confirm it's a safe non-mutating call. The 'without dumping the whole layout' note adds value over sibling get_page, but completeness for an unannotated tool could be stronger.

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 documents both parameters fully. widgetName has a helpful example ('spoa') and explanation. The description adds the purpose of retrieving values 'before editing' but no additional param detail beyond the schema. Baseline 3 is appropriate since schema covers everything.

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 specific verb+resource: 'Returns one widget's properties from a page'. Clearly distinguishes from get_page ('without dumping the whole layout') and related sibling tools like update_widget, clone_widget. States the exact scope of what it retrieves.

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?

Description implies usage context ('Use this to see current values before editing'), suggesting it pairs with update_widget. However, it doesn't explicitly state when NOT to use it (e.g., when get_page is more appropriate for whole layout inspection), nor name alternative tools explicitly. The before-editing hint is useful but not comprehensive.

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/Davidgraciano/appsmith-mcp'

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