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

ghl-mcp-server-v2

by zackscriven

ghl_kb_faq_update

Idempotent

Update the question or answer of an existing knowledge base FAQ. Use it to revise wording on a saved FAQ, while create adds new FAQs and delete removes them.

Instructions

Update an existing knowledge base FAQ Updates the question and/or answer of an existing FAQ. WHEN TO USE: use this when you need to change wording on a FAQ you already have; use create to add a new FAQ; use delete to remove one. RETURNS: whether the update succeeded. Endpoint: PUT /knowledge-bases/faqs/{id} (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.write

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": {
      "id": "<id>",
      "body": "<body>"
    },
    "name": "ghl_kb_faq_update"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesfaq ID as string
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.1.0
    • addedInput schema / properties / body / title
      Added value: +"UpdateFaqBodyDTO"
  2. First observedv2.0.0

TDQS

A4.3/5.0
Behavior4/5

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

Adds context beyond the annotations: it discloses the Sub-Account (location) token requirement and the knowledge-bases.write OAuth scope, which are exactly the prerequisites an agent needs before attempting a mutation. It also states the return shape. One ambiguity remains: 'question and/or answer' implies partial updates while the schema requires both fields, and no behavior is given for a non-existent id.

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?

Front-loaded and organized into labeled WHEN TO USE / RETURNS segments that scan quickly. The endpoint plus '(Version header: v3; source: v3/knowledge-base-v3.json)' trailing metadata is useful-but-noisy implementation detail that dilutes an otherwise tight definition.

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?

With no output schema, the RETURNS line correctly tells the agent to expect a success indicator, and auth/scoping is covered. For a nested-body mutation tool this is nearly complete; only error behavior on a bad id is 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 description coverage is 100% and both the id and the nested body fields carry their own examples and descriptions, so the schema does the heavy lifting. The description adds only the vague 'question and/or answer' framing, which actually sits slightly at odds with the required-both schema.

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 ('Update an existing knowledge base FAQ') and immediately narrows to what is changeable ('the question and/or answer'). Sibling tools ghl_kb_faq_create and ghl_kb_faq_delete are explicitly named as the alternatives, so the agent can route without opening schemas.

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 line gives the exact trigger ('change wording on a FAQ you already have') and names both sibling alternatives with their selecting conditions (create for new, delete for removal). Nothing is left to inference.

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