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

ghl-mcp-server-v2

by zackscriven

ghl_kb_update_knowledge_base

Idempotent

Update an existing knowledge base’s name or description using its ID so you can rename or re-describe it as its scope changes.

Instructions

Update a knowledge base Updates the name and/or description of an existing knowledge base. WHEN TO USE: use this when you need to rename or re-describe a knowledge base; use createKnowledgeBase to add one; use deleteKnowledgeBase to remove one. RETURNS: whether the update succeeded. Endpoint: PUT /knowledge-bases/{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_update_knowledge_base"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesThe unique identifier of the knowledge base to update
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv2.1.0
    • addedInput schema / properties / body / properties / description / example
      Added value: +"An updated description for this knowledge base"
    • addedInput schema / properties / body / properties / name / example
      Added value: +"My Updated Knowledge Base"
    • addedInput schema / properties / body / title
      Added value: +"UpdateKnowledgeBaseDTO"
    • addedInput schema / properties / id / description
      Added value: +"The unique identifier of the knowledge base to update"
    • addedInput schema / properties / id / example
      Added value: +"ve9EPM428h8vShlRW1KT"
  2. First observedv2.0.0

TDQS

A4.6/5.0
Behavior5/5

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

Beyond the annotations (readOnlyHint=false, idempotentHint=true, destructiveHint=false), the description discloses the auth requirement (Sub-Account/location token), the required OAuth scope (knowledge-bases.write), the HTTP verb and path, and the version header. It also states the return shape, which the tool lacks an output schema for.

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?

Labeled sections (WHEN TO USE, RETURNS, endpoint/auth metadata) make it easy to scan and the actionable guidance is front-loaded. The opening line restates the tool title verbatim before the more useful sentence, which is minor redundancy but not wasteful overall.

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?

Covers everything an agent needs for a 2-parameter nested mutation: what is mutable, how to authenticate, which scope applies, what endpoint is hit, sibling alternatives, and the success signal. With no output schema present, the RETURNS line fills the remaining gap.

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%, so both the 'id' and the nested body fields are already documented in the schema. The description's 'name and/or description' phrasing usefully confirms that partial updates are allowed, but adds no syntax, format, or constraint detail beyond the schema baseline.

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 a knowledge base') and immediately narrows scope to 'the name and/or description of an existing knowledge base', so the agent knows exactly which fields are mutable. It is clearly distinguishable from the kb create/delete siblings named in the same paragraph.

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 names the trigger condition ('rename or re-describe') and routes to createKnowledgeBase for adds and deleteKnowledgeBase for removals. Both alternatives and exclusions are spelled out, leaving nothing 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