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

ghl-mcp-server-v2

by zackscriven

ghl_custom_menu_update

Idempotent

Modify an existing agency-level custom menu link by ID—URL, title, icon, open mode, role access, and sub-account display—via the GoHighLevel API.

Instructions

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only for all custom-menus ops. Update Custom Menu Link Updates an existing custom menu for a given company. Requires authentication and proper permissions. Endpoint: PUT /custom-menus/{customMenuId} (Version header: v3; source: v3/custom-menus-v3.json) Requires an Agency (company-level) token. OAuth scopes: custom-menu-link.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": {
      "customMenuId": "<customMenuId>",
      "body": "<body>"
    },
    "name": "ghl_custom_menu_update"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
customMenuIdYesID of the custom menu to update

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.1.0
    • changedInput schema / properties / body / properties / icon / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "fontFamily": {
      -        "description": "Font family of the icon",
      -        "enum": [
      -          "fab",
      -          "fas",
      -          "far"
      -        ],
      -        "type": "string"
      -      },
      -      "name": {
      -        "description": "Name of the icon",
      -        "example": "yin-yang",
      -        "type": "string"
      -      }
      -    },
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "fontFamily": {
      +        "description": "Font family of the icon",
      +        "enum": [
      +          "fab",
      +          "fas",
      +          "far"
      +        ],
      +        "type": "string"
      +      },
      +      "name": {
      +        "description": "Name of the icon",
      +        "example": "yin-yang",
      +        "type": "string"
      +      }
      +    },
      +    "title": "IconSchemaOptional",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / title
      Added value: +"UpdateCustomMenuDTO"
  2. First observedv2.0.0

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly=false, idempotent=true, destructive=false), so the description's value-add is the auth/scope requirement, the agency-access-only restriction, and the exact endpoint plus version header — all real operational context an agent cannot get from the annotations. It stops short of describing partial-vs-full replacement semantics for the body.

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 critical constraint is front-loaded, which is good, but the agency-token requirement is stated three times in different words ('REQUIRES AN AGENCY-LEVEL (Company) TOKEN', 'Requires an Agency (company-level) token', plus 'Requires authentication and proper permissions'), and the OpenAPI source-file reference is noise for an agent.

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?

Auth, scope, and endpoint are fully covered, but this is a mutation over an 11-field all-optional nested body with no output schema, and the description never says whether unspecified fields are preserved or cleared, nor what the response contains. That gap matters for calling it correctly.

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% and every body field carries its own description, so the schema carries the parameter burden. The tool description adds nothing about customMenuId format or about how omitted body fields behave, which is the one thing the schema does not answer.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Updates an existing custom menu for a given company'), which distinguishes it from the create/delete/list siblings in the same family. It does not explicitly name those siblings as alternatives, and the redundant 'Update Custom Menu Link' heading restates the name.

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?

The precondition (agency-level/company token, custom-menu-link.write scope) is stated clearly, which implies when the call is permitted. However, there is no explicit guidance on when to choose this over ghl_custom_menu_create or ghl_custom_menu_get_by_id, and no statement of when not to use it.

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