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

ghl-mcp-server-v2

by zackscriven

ghl_custom_menu_list

Read-onlyIdempotent

Fetches custom menu links with name search, location or agency-level filtering, and pagination to browse complete results.

Instructions

REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only for all custom-menus ops. Get Custom Menu Links Fetches a collection of custom menus based on specified criteria. This endpoint allows clients to retrieve custom menu configurations, which may include menu items, categories, and associated metadata. The response can be tailored using query parameters for filtering, sorting, and pagination. Endpoint: GET /custom-menus/ (Version header: v3; source: v3/custom-menus-v3.json) Requires an Agency (company-level) token. OAuth scopes: custom-menu-link.readonly Pagination params: skip, limit — pass them to page through full result sets.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "ghl_custom_menu_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
skipNoNumber of items to skip for pagination
limitNoMaximum number of items to return
queryNoSearch query to filter custom menus by name, supports partial || full names
locationIdNoUnique identifier of the location
showOnCompanyNoFilter to show only agency-level menu links. When omitted, fetches both agency and sub-account menu links. Ignored if locationId is provided

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, so the bar is lower, yet the description adds real value: the Agency-level (Company) token requirement, the custom-menu-link.readonly OAuth scope, and the GET /custom-menus/ endpoint with v3 header. The main weakness is that the auth requirement is stated twice, verbatim, in the same description.

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 auth constraint is front-loaded, which is good, but the agency-token requirement is duplicated in two places and the endpoint/version/source metadata is appended as a trailing block. Roughly a third of the text could be removed without losing information.

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 read-only list tool with no output schema, the description covers auth, scope, endpoint, pagination, and the shape of the returned data. It's nearly complete; only the locationId vs showOnCompany interaction (which lives in the schema) and single-record alternative are unaddressed.

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 coverage is 100%, so the schema already documents all five parameters; the description only adds that skip/limit should be used to page through full result sets. It also claims filtering and sorting are available, but no sort parameter exists, which is mildly misleading, and showOnCompany/query semantics are left entirely to the schema.

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: 'Fetches a collection of custom menus based on specified criteria', and describes the payload (menu items, categories, metadata). It's clearly a collection/list operation, though it never names sibling ghl_custom_menu_get_by_id to distinguish single-record retrieval.

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 context is implied (retrieve menu configurations, page through full result sets with skip/limit) and the agency-token prerequisite is stated. But there's no explicit 'use this instead of ghl_custom_menu_get_by_id when...' routing, and no guidance on when filtering by locationId vs showOnCompany is appropriate.

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