Skip to main content
Glama
zackscriven

ghl-mcp-server-v2

by zackscriven

ghl_kb_faq_list

Read-onlyIdempotent

Retrieve all FAQs for a knowledge base with cursor-based pagination. Pass knowledge base ID and location ID to paginate through results.

Instructions

Get all FAQs by knowledge base with pagination support Retrieves FAQs for a knowledge base. Supports pagination using limit and lastFaqId parameters. Endpoint: GET /knowledge-bases/faqs (Version header: v3; source: v3/knowledge-base-v3.json) Pagination params: limit, lastFaqId — pass them to page through full result sets.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoLimit the number of FAQs returned
lastFaqIdNoLast FAQ ID for pagination (cursor-based)
locationIdYeslocation ID as string
knowledgeBaseIdYesknowledge base ID as string
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is clear. The description adds pagination mechanics (limit, lastFaqId) and endpoint details, which is helpful but does not discuss rate limits, authentication, or response format. With annotations covering most behavioral traits, the description adds marginal value.

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 description is four sentences with some redundancy (title repeated), but it remains focused and front-loaded. It efficiently states purpose, retrieval, endpoint, and pagination without unnecessary detail.

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 list operation with pagination, the description covers the main purpose and pagination behavior. It does not mention empty results or response structure, but without an output schema, this is acceptable. Required params are clearly indicated in the schema.

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%, with all parameters described. The description reinforces pagination semantics for limit and lastFaqId but adds little beyond what the schema provides. Baseline 3 is appropriate.

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 clearly states the tool retrieves all FAQs for a knowledge base with pagination support. It uses a specific verb ('Get') and resource ('FAQs by knowledge base'), distinguishing it from sibling tools like create, delete, or update.

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

Usage Guidelines4/5

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

The description provides clear context (listing FAQs for a KB with pagination) but does not explicitly state when not to use it or mention alternatives. It implies usage for retrieving all FAQs, which is reasonable given sibling operations.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/zackscriven/ghl-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server