Skip to main content
Glama

Update object type

update_object
DestructiveIdempotent

Rename or reconfigure a custom object type by key — change its label, plural, blurb, icon, shared-write mode, enabled flag, or display_field (the data key holding a record's display name; null resets to the 'name' default) — and/or set its sidebar-menu visibility (show_in_menu: navigation only — true pins the object into the web app's menu, false removes its menu row while the object stays fully usable everywhere else). A BUILT-IN object's identity is code-defined, so on a built-in key only two changes apply, alone or together: enabled and show_in_menu. enabled:false turns the object OFF for the whole workspace — its records vanish from every surface and the generic verbs refuse it until it's turned back on (nothing is deleted) — so it needs a preview call, then confirm:true; enabled:true turns it back on with no confirm. describe_schema's switchable says which objects have a switch (foundational objects and a feature's parts don't, and say so). Returns the updated object definition (a built-in or menu-only change returns the key + what changed).

When to use: When an admin wants to change a custom object's label, plural, blurb, icon, shared-write mode, or enabled flag — or its sidebar-menu visibility (show_in_menu, navigation only: the object stays fully usable off the menu). For a built-in object only enabled (off needs a confirm) and show_in_menu apply.

Example: Rename the Property object to Listing.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyYesThe object's stable key (from describe_schema). On a built-in key only enabled and/or show_in_menu apply; any other change is refused.
iconNoA key from Capable's curated object-icon set (e.g. landmark, factory, handshake, flask); an unknown key is rejected with suggestions. Null clears back to the neutral default.
blurbNoNew one-sentence description of the object; null clears it.
labelNoNew singular display name. The key does not change.
pluralNoNew plural display name for lists and the menu.
sharedNotrue lets any non-viewer edit every record of this object; false lets only the record's owner, admins and managers edit it.
confirmNoRequired (true) to turn a BUILT-IN object off: the first enabled:false call answers with a preview instead. Not needed for anything else.
enabledNofalse turns the object off — it leaves the schema and menu and the generic verbs refuse it, records kept; true turns it back on. On a built-in key, false needs confirm:true (the first call previews); custom objects switch as before.
show_in_menuNoWhether the object appears in the web app's sidebar menu — an explicit per-object override of the bounded default. NAVIGATION only: it never changes what you or the app can do with the object (that's `enabled`). Composes with the other args on a custom key; on a built-in key it composes only with enabled.
display_fieldNoThe data key holding a record's display name (a lowercase field key); null resets to the "name" default.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyNo
noteNo
labelNo
objectNo
updatedNo
requires_confirmNo
records_affected_noteNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Far exceeds the annotations (readOnlyHint=false, destructiveHint=true, idempotentHint=true). It discloses that enabled:false is workspace-wide, hides records from every surface, causes generic verbs to refuse the object, deletes nothing, and requires a preview call followed by confirm:true on built-ins, while enabled:true needs no confirm. It also states built-in identity is code-defined and what the return value contains.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded and organized into description / when-to-use / example, but the opening paragraph is a dense run-on with stacked em-dash asides, and the 'When to use' section largely repeats content already stated above and again in the schema field descriptions. Sentences earn their place individually, but the total is longer than needed.

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 10-parameter mutation tool with an output schema present, the description covers everything an agent needs: key sourcing, built-in vs custom behavior, the confirm/preview flow, composability, and reversibility. Return values need not be explained since an output schema exists.

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 100%, so the baseline is 3; the description still adds cross-parameter semantics the schema does not, notably the composability rule ('composes with the other args on a custom key; on a built-in key it composes only with enabled') and the show_in_menu-is-navigation-only vs enabled distinction. Much of the per-field text, however, restates the schema.

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?

Opens with a specific verb+resource+scope: 'Rename or reconfigure a custom object type by key', then enumerates every mutable aspect (label, plural, blurb, icon, shared-write, enabled, display_field, show_in_menu). This cleanly distinguishes it from siblings like update_field, update_pipeline, define_object and archive_object.

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 explicit 'When to use' section plus the built-in-vs-custom restriction ('on a built-in key only two changes apply') and the preview-then-confirm requirement give strong when-to-use and when-not guidance. It points to describe_schema for the key and switchability, but does not name alternative tools for adjacent operations (e.g. field changes vs object changes), leaving a small gap.

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