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

ghl-mcp-server-v2

by zackscriven

ghl_kb_faq_list

Read-onlyIdempotent

Lists FAQs in a knowledge base with pagination and optional question search, returning entries, total count, and next-page cursor for browsing existing Q&A records.

Instructions

Get all FAQs by knowledge base with pagination support Retrieves Q&A entries for a knowledge base, with cursor or offset pagination and optional question search. WHEN TO USE: use this when you need to list existing FAQs; use create to add one; use update or delete to change or remove a single FAQ. RETURNS: the FAQ list, total count, lastFaqId for the next page, and whether more results exist. Endpoint: GET /knowledge-bases/faqs (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.readonly Pagination params: limit, lastFaqId, offset — 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": {
      "knowledgeBaseId": "<knowledgeBaseId>",
      "locationId": "<locationId>"
    },
    "name": "ghl_kb_faq_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoLimit the number of FAQs returned
offsetNoNumber of FAQs to skip (offset-based pagination)
searchNoSearch query to filter FAQs by question (case-insensitive contains match)
lastFaqIdNoLast FAQ ID for pagination (cursor-based)
locationIdYeslocation ID as string
knowledgeBaseIdYesknowledge base ID as string

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.1.0
    • addedInput schema / properties / offset
      Added value: +{
      +  "default": 0,
      +  "description": "Number of FAQs to skip (offset-based pagination)",
      +  "example": 0,
      +  "type": "number"
      +}
    • addedInput schema / properties / search
      Added value: +{
      +  "description": "Search query to filter FAQs by question (case-insensitive contains match)",
      +  "example": "pricing",
      +  "type": "string"
      +}
  2. First observedv2.0.0

TDQS

A4.8/5.0
Behavior5/5

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

Beyond the readOnly/idempotent annotations, the description discloses the auth requirement (Sub-Account/location token), the required OAuth scope (knowledge-bases.readonly), the HTTP endpoint and version header, and the pagination mechanics. The RETURNS block names the concrete response fields (total count, lastFaqId, hasMore), which goes well past what the annotations convey.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The labeled structure (WHEN TO USE / RETURNS / endpoint / scopes) is easy to scan and front-loads purpose. However, the first two lines say the same thing ('Get all FAQs by knowledge base with pagination support' vs. 'Retrieves Q&A entries for a knowledge base, with cursor or offset pagination'), and the annotation title repeats it a third time, so a sentence could be cut.

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?

For a six-parameter read-list tool with no output schema, the description covers everything an agent needs: purpose, alternatives, auth, scopes, pagination strategy, and return fields. Nothing material is left to inference.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is already 100%, so the baseline is 3; the description earns an extra point by grouping the three pagination parameters (limit, lastFaqId, offset) and stating their purpose as paging through full result sets, plus flagging that search is an optional question filter. It stops short of explaining when to prefer cursor (lastFaqId) over offset pagination, which is the one semantic gap left.

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?

The description states a specific verb and resource ('Get all FAQs'), the required scoping dimension ('by knowledge base'), and explicitly names the sibling operations (create/update/delete) it is not. An agent can distinguish it from ghl_kb_faq_create, ghl_kb_faq_update, and ghl_kb_faq_delete without inspecting any schema.

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 gives an explicit trigger ('when you need to list existing FAQs') and routes the other CRUD cases to their respective siblings. There is no ambiguity about which of the FAQ tools to select for a given intent.

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