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

ghl-mcp-server-v2

by zackscriven

ghl_kb_faq_create

Creates a new question-and-answer FAQ entry in a knowledge base, returning the created FAQ with its server-assigned ID.

Instructions

Create a new FAQ inside knowledge base Creates a new question-and-answer entry in a knowledge base. WHEN TO USE: use this when you need to add a brand-new FAQ; use update to change an existing one; use list to see current FAQs. RETURNS: success and the created FAQ, including its server-assigned id. Endpoint: POST /knowledge-bases/faqs (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": {
      "body": "<body>"
    },
    "name": "ghl_kb_faq_create"
  }
}

Input Schema

NameRequiredDescriptionDefault
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: +"AddFaqDTO"
  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?

Annotations already declare readOnly=false, destructive=false, idempotent=false, openWorld=true, so the safety profile is covered. The description adds genuinely new context: the return value (success plus the created FAQ with a server-assigned id), the required Sub-Account/location token, the knowledge-bases.write OAuth scope, and the concrete endpoint. It stops short of noting that repeated calls create duplicates or any failure conditions, so not a 5.

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?

Well structured and front-loaded with labeled WHEN TO USE / RETURNS sections. However, the first line and the second line say substantially the same thing as the annotation title, so there is a small amount of redundancy that could be trimmed.

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 single nested-body create tool with no output schema, the description covers return shape, auth requirement, scope, and endpoint — enough to call it correctly. It omits prerequisites (the referenced knowledge base must already exist) and duplicate-handling behavior, which keeps it from a 5.

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 every nested field (question, answer, locationId, knowledgeBaseId) carries a description and example, so the schema does the heavy lifting. The description adds nothing about the parameters — no mention of the required knowledgeBaseId or that a location token must match locationId — 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 ("Create a new FAQ inside knowledge base" / "Creates a new question-and-answer entry"), making it immediately distinguishable from the sibling update/list/delete FAQ tools. An agent knows exactly what object is being created.

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 explicitly routes: this tool for a brand-new FAQ, update for changing an existing one, list for viewing current FAQs. Alternatives are named with the condition that selects each, which is exactly what an agent needs to disambiguate within the ghl_kb_faq_* family.

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