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

ghl-mcp-server-v2

by zackscriven

ghl_custom_menu_create

Creates a company-level custom menu link in GoHighLevel with icon, URL, visibility, open mode, and role settings; requires an agency token.

Instructions

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only for all custom-menus ops. Create Custom Menu Link Creates a new custom menu for a company. Requires authentication and proper permissions. For Icon Usage Details please refer to https://doc.clickup.com/8631005/d/h/87cpx-243696/d60fa70db6b92b2 Endpoint: POST /custom-menus/ (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": {
      "body": "<body>"
    },
    "name": "ghl_custom_menu_create"
  }
}

Input Schema

NameRequiredDescriptionDefault
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 / 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"
      -      }
      -    },
      -    "required": [
      -      "name",
      -      "fontFamily"
      -    ],
      -    "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"
      +      }
      +    },
      +    "required": [
      +      "name",
      +      "fontFamily"
      +    ],
      +    "title": "IconSchema",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / title
      Added value: +"CreateCustomMenuDTO"
  2. First observedv2.0.0

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, openWorldHint=true, idempotentHint=false, and destructiveHint=false, so the description does not need to restate safety basics. It adds valuable context beyond annotations: Agency-Access-Only security, agency-level token requirement, OAuth scope custom-menu-link.write, HTTP endpoint, and version header. It does not discuss duplicate handling or error behavior, 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 most important constraint, the agency-level token requirement, is front-loaded, but it is repeated at the top and near the end of the description. There is also some vague filler such as "Requires authentication and proper permissions," and the endpoint/source information is useful but contributes to a somewhat cluttered structure. It is not excessively long, but several sentences could be tightened.

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 create operation with fully described nested input parameters and annotations covering safety traits, the description supplies the critical missing operational context: agency-token requirement, OAuth scope, endpoint, and icon documentation. There is no output schema, but the description does not need to explain return values. It could mention sibling differentiation or duplicate behavior, but overall it is complete enough to call 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 the nested body fields are fully documented in the schema. The description adds only the icon usage documentation link, which is useful for the icon object but does not otherwise clarify field interactions such as locations applying only when showOnLocation=true and showToAllLocations=false. With the schema already carrying parameter semantics, baseline 3 is appropriate.

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?

The description gives a clear verb and resource: "Creates a new custom menu for a company." It distinguishes creation from sibling operations such as ghl_custom_menu_update, ghl_custom_menu_get_by_id, ghl_custom_menu_list, and ghl_custom_menu_delete through the word "new" and the create-specific endpoint. However, it does not explicitly contrast this tool with those siblings, so it falls short of a 5.

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?

Usage is implied by "Creates a new custom menu," and the description gives important prerequisites such as an agency-level token and the custom-menu-link.write OAuth scope. It does not explicitly say when to choose this tool over ghl_custom_menu_update or ghl_custom_menu_list, nor does it state exclusions or post-creation behavior. This is adequate context but not full when/when-not guidance.

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