Skip to main content
Glama
ghl-mcp-server-v2

ghl-mcp-server-v2

by zackscriven

ghl_object_update_schema

Idempotent

Updates a custom or standard object schema by key or ID, setting labels, description, and searchable fields to control how records are displayed and searched.

Instructions

Renamed from the auto-generated 'ghl_object_update_custom' for clarity and to pair with ghl_object_get_schema_by_key. Update Object Schema By Key / Id Update Custom Object Schema or standard object's like contact, opportunity, business searchable fields. To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0 Endpoint: PUT /objects/{key} (Version header: v3; source: v3/objects-v3.json) OAuth scopes: objects/schema.write

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>",
      "body": "<body>"
    },
    "name": "ghl_object_update_schema"
  }
}

Input Schema

NameRequiredDescriptionDefault
keyYeskey of the custom or standard object. For custom objects, the key must include the prefix “custom_objects.”. This key can be found on the Object Details page under Settings in the UI.
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.1.0
    • changedInput schema / properties / body / properties / labels / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "plural": {
      -        "description": "Plural name of the custom object",
      -        "example": "Cars",
      -        "type": "string"
      -      },
      -      "singular": {
      -        "description": "Singular name of the custom object",
      -        "example": "Car",
      -        "type": "string"
      -      }
      -    },
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "plural": {
      +        "description": "Plural name of the custom object",
      +        "example": "Cars",
      +        "type": "string"
      +      },
      +      "singular": {
      +        "description": "Singular name of the custom object",
      +        "example": "Car",
      +        "type": "string"
      +      }
      +    },
      +    "title": "CustomObjectLabelUpdateDto",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / title
      Added value: +"UpdateCustomObjectSchemaDTO"
  2. First observedv2.0.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is covered. The description adds useful behavioral context beyond annotations: the PUT endpoint, version header, and required OAuth scope objects/schema.write. It does not explain partial-update behavior or response shape, so it is strong but not complete.

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?

The description is reasonably sized and includes useful endpoint and OAuth information. However, it opens with a rename-history note and repeats the title 'Update Object Schema By Key / Id', which do not directly help an agent invoke the tool. The actionable content is present but not ideally front-loaded.

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 complex nested schema, the description supplies the endpoint, required OAuth scope, documentation link, and scope of the update. The input schema carries the detailed field semantics and required body properties. It lacks explicit response/return behavior and partial-update semantics, but given the rich schema and annotations, it is mostly complete.

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 parameter meanings are already documented in the input schema. The description adds that the key may target custom or standard objects and gives examples of standard object types, but it does not add syntax or format details beyond the schema. Baseline 3 is appropriate.

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: update an object schema by key/id. It explicitly says it updates custom object schemas or standard object searchable fields, and names the paired sibling ghl_object_get_schema_by_key. An agent can distinguish this from create/get/list object tools without opening the schema.

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 description gives clear context for when this tool applies: updating an existing schema's labels, description, or searchable fields. It references pairing with ghl_object_get_schema_by_key, but it does not explicitly state when not to use it or name the create/read alternatives. The usage context is clear but lacks explicit exclusions.

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

Deploy Server

Other Tools