Skip to main content
Glama

Update object type

update_object
DestructiveIdempotent

Admin-only patch of a custom object's label, plural, blurb, icon, shared-write mode, enabled flag or display_field (null resets to name). show_in_menu changes navigation only; hiding a menu row leaves the object usable. Built-in keys accept only enabled and show_in_menu. enabled:false hides records across the workspace and makes generic verbs refuse the object until re-enabled; nothing is deleted. Preview first, then confirm:true to disable; enabling needs no confirmation. describe_schema.switchable identifies objects that allow switching; foundational objects and feature parts do not. Returns the definition, or key and changes for a built-in/menu-only update.

When to use: An admin reconfigures an object type or its menu visibility.

Example: Rename the Property object to Listing.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "key": "<key>"
    },
    "name": "update_object"
  }
}

Input 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: any non-viewer edits every record, even where an admin narrowed edit access; false: each person's edit access applies.
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 after a preview call.
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 the object can do (that is `enabled`). Composes with the other args on a custom key; on a built-in key 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

NameRequiredDescriptionDefault
keyNo
noteNo
labelNo
objectNo
updatedNo
requires_confirmNo
records_affected_noteNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / shared / description
      Previous value: -"true lets any non-viewer edit every record of this object; false lets only the record's owner, admins and managers edit it."New value: +"true: any non-viewer edits every record, even where an admin narrowed edit access; false: each person's edit access applies."
  2. Changed6 schema fields changed
    • removedInput schema / properties / blurb / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedInput schema / properties / blurb / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedInput schema / properties / display_field / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedInput schema / properties / display_field / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedInput schema / properties / icon / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedInput schema / properties / icon / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  3. Changed1 schema field changed
    • removedInput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
  4. Changed4 schema fields changed
    • removedOutput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
    • removedOutput schema / additionalProperties
      Removed value: -{}
    • removedOutput schema / properties / object / additionalProperties
      Removed value: -{}
    • removedOutput schema / properties / object / propertyNames
      Removed value: -{
      -  "type": "string"
      -}
  5. Changed2 schema fields changed
    • changedInput schema / properties / enabled / description
      Previous value: -"false 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."New value: +"false 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 after a preview call."
    • changedInput schema / properties / show_in_menu / description
      Previous value: -"Whether 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."New value: +"Whether 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 the object can do (that is `enabled`). Composes with the other args on a custom key; on a built-in key only with enabled."
  6. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the annotations, the description discloses major behavioral consequences: enabled:false hides records across the workspace and makes generic verbs refuse the object until re-enabled, while nothing is deleted. It also explains the built-in-key restriction, the preview/confirm requirement for disabling built-ins, and that show_in_menu only affects navigation.

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?

The description is dense but appropriately sized for a ten-parameter mutation tool, and the opening sentence front-loads purpose, access level, and scope. Every subsequent sentence adds operational detail about built-ins, disabling, menu visibility, switching, or return values.

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 an output schema present and annotations covering safety/idempotency, the description still supplies the behavioral context an agent needs for this complex tool. It covers access level, mutation scope, built-in restrictions, destructive effects, confirmation workflow, and return shape.

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 already 100%, so the baseline is 3, but the description adds useful semantics beyond the schema: null resets display_field to name, built-in keys accept only enabled and show_in_menu, and describe_schema.switchable identifies objects that allow switching. It does not systematically explain all ten parameters, but it clarifies the most consequential ones.

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 states a specific verb and resource: an admin-only patch of a custom object's metadata and behavior. It distinguishes custom objects from built-in keys and explains that menu visibility is separate from object capability, so an agent can tell what this tool changes and what it does not.

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?

It gives a clear when-to-use line for admins reconfiguring an object type or menu visibility, plus a rename example. It also defines important constraints and workflows, including preview-then-confirm for disabling built-ins, but it does not explicitly compare against nearby alternatives such as define_object or update_workspace.

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