Skip to main content
Glama
AIWerk

@aiwerk/mcp-server-ghl

by AIWerk

knowledge_base_list

Read-onlyIdempotent

Retrieve FAQs from a knowledge base with pagination. Pass knowledge base ID and optional limit or lastFaqId cursor to fetch pages of entries.

Instructions

Get all FAQs by knowledge base with pagination support

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoLimit the number of FAQs returned
lastFaqIdNoLast FAQ ID for pagination (cursor-based)
locationIdNolocation ID as string Defaults to GHL_LOCATION_ID when omitted.
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 idempotentHint=true, so the safety profile is known. The description adds the pagination behavior, which is not in annotations. However, it does not describe response format or edge cases, so it adds only modest value beyond the annotations.

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

Conciseness5/5

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

The description is a single, focused sentence that front-loads the core purpose. It contains no filler and is immediately clear. Every word earns its place.

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?

Given the schema covers parameter meanings and annotations cover safety, the description is nearly sufficient. It clearly indicates the tool returns all FAQs for a knowledge base with pagination, which is the core intent. The lack of output schema is acceptable for a list operation, and the description does not omit anything critical for an agent to call it 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?

All four parameters are fully described in the schema (100% coverage). The description does not add additional meaning beyond the schema, such as how pagination works or the default for locationId. It relies on the schema for parameter details, which 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 states a specific verb and resource: 'Get all FAQs by knowledge base'. This clearly distinguishes it from sibling tools like knowledge_base_list_all_knowledge_bases_paginated (lists knowledge bases, not FAQs) and knowledge_base_get_knowledge_base_by_id (gets a single knowledge base). The required knowledgeBaseId parameter reinforces that it operates on a specific knowledge base.

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?

The description does not explicitly specify when to use this tool vs alternatives. It mentions pagination support but does not state when to prefer this over other knowledge base tools. It is not misleading, but the guidance is implicit rather than explicit.

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/AIWerk/mcp-server-ghl'

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