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

ghl-mcp-server-v2

by zackscriven

ghl_custom_menu_get_by_id

Read-onlyIdempotent

Retrieve a single custom menu configuration by ID, including menu items, categories, and metadata. Requires an agency-level token for access.

Instructions

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only for all custom-menus ops. Get Custom Menu Link Fetches a single custom menus based on id. This endpoint allows clients to retrieve custom menu configurations, which may include menu items, categories, and associated metadata Endpoint: GET /custom-menus/{customMenuId} (Version header: v3; source: v3/custom-menus-v3.json) Requires an Agency (company-level) token. OAuth scopes: custom-menu-link.readonly

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

Input Schema

NameRequiredDescriptionDefault
customMenuIdYesUnique identifier of the custom menu

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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 readOnly/idempotent/non-destructive, and the description goes beyond them by disclosing the agency-level (Company) token requirement, the exact OAuth scope (custom-menu-link.readonly), the HTTP endpoint, and the v3 version header — real call-blocking context. It does not cover error behavior or what happens on an unknown id.

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 core sentence is front-loaded and clear, but the agency-token requirement is repeated three times (opening line, standalone sentence, and implicitly in the scope note), which wastes space on a one-parameter tool. The endpoint/version metadata is useful but padding-heavy.

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 simple read-by-id with a single fully documented parameter, this is nearly complete: auth level, scope, endpoint, and a summary of the returned payload are all present. With no output schema, more detail on the response shape would help, but nothing essential to invoking it is missing.

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?

Only one parameter and schema coverage is 100%, so the schema already documents customMenuId as the unique identifier. The description adds nothing about id format (e.g., the UUID shown in the schema example) or where to obtain it, so the baseline 3 applies.

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 states a specific verb and resource: it fetches a single custom menu by id, and it names the returned content (menu items, categories, metadata). It is clearly distinct from the write siblings (ghl_custom_menu_create/update/delete), though it never explicitly points at ghl_custom_menu_list as the enumeration alternative.

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 'fetches a single custom menus based on id', which tells the agent this is a by-id lookup rather than a listing. The agency-token prerequisite is a useful selection gate, but no explicit when-to-use/when-not-to-use or alternative-naming guidance is given.

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