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

ghl-mcp-server-v2

by zackscriven

ghl_kb_list

Read-onlyIdempotent

List knowledge bases for a GoHighLevel location with optional name search and cursor pagination, so you can see which knowledge bases exist before retrieving or creating one.

Instructions

Lists knowledge bases for a location (paginated via limit/lastKnowledgeBaseId) — distinct from ghl_kb_faq_list, which lists FAQ entries inside one knowledge base. Get all knowledge bases for a location by location Id (paginated) Lists knowledge bases for a sub-account (location), with optional name search and cursor pagination. WHEN TO USE: use this when you need to see which knowledge bases exist; use getKnowledgeBaseById for one; use createKnowledgeBase to add one. RETURNS: a page of knowledge bases, activeCount, hasMore, and lastKnowledgeBaseId for the next page. Endpoint: GET /knowledge-bases/ (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.readonly Pagination params: limit, lastKnowledgeBaseId — pass them to page through full result sets.

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": {
      "locationId": "<locationId>"
    },
    "name": "ghl_kb_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of knowledge bases to return
queryNosearch query for knowledge base name
locationIdYesThe location ID to retrieve knowledge bases for
lastKnowledgeBaseIdNoID of the last knowledge base from the previous page (for pagination)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv2.1.0
    • addedInput schema / properties / locationId / description
      Added value: +"The location ID to retrieve knowledge bases for"
    • addedInput schema / properties / locationId / example
      Added value: +"qIyivCmsuEOSnyoFYEej"
    • addedInput schema / properties / query / example
      Added value: +"bot training"
  2. First observedv2.0.0

TDQS

A4.5/5.0
Behavior5/5

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

Beyond the readOnly/idempotent annotations, it discloses the auth requirement (Sub-Account/location token), the OAuth scope (knowledge-bases.readonly), the endpoint and API version, and the pagination contract. That is exactly the operational context annotations cannot carry.

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?

Content is front-loaded and the WHEN TO USE / RETURNS blocks are scannable, but the core fact is restated three times ('Lists knowledge bases for a location', 'Get all knowledge bases for a location', 'Lists knowledge bases for a sub-account'), which bloats the definition without adding meaning.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description supplies the return shape (knowledge bases, activeCount, hasMore, lastKnowledgeBaseId) and the full paging loop, plus auth and scope. An agent has everything needed to call and paginate 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 coverage is 100%, so all four parameters are already documented with types, defaults and examples. The description only reiterates limit/lastKnowledgeBaseId for paging and mentions name search, adding little syntax or format detail beyond the schema, so the baseline 3 applies.

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?

States a specific verb and resource ('Lists knowledge bases for a location') and explicitly contrasts with ghl_kb_faq_list, which the agent could otherwise confuse with this tool. Scope (per-location) and pagination model are named in the first sentence.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The 'WHEN TO USE' block states the selecting condition ('see which knowledge bases exist') and names both alternatives, getKnowledgeBaseById for a single record and createKnowledgeBase for adding one. No inference is required to route between them.

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