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

ghl-mcp-server-v2

by zackscriven

ghl_kb_get_knowledge_base_by_id

Read-onlyIdempotent

Retrieves a single knowledge base by its ID, returning its name, metadata, and timestamps for inspection or verification.

Instructions

Get knowledge base by ID Retrieves one knowledge base by id, including name, metadata, and timestamps. WHEN TO USE: use this when you need to inspect a single knowledge base; use listAllKnowledgeBasesPaginated to browse; use updateKnowledgeBase to rename it. RETURNS: success and the knowledge base record. Endpoint: GET /knowledge-bases/{knowledgeBaseId} (Version header: v3; source: v3/knowledge-base-v3.json) Requires a Sub-Account (location) token. OAuth scopes: knowledge-bases.readonly

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": {
      "knowledgeBaseId": "<knowledgeBaseId>"
    },
    "name": "ghl_kb_get_knowledge_base_by_id"
  }
}

Input Schema

NameRequiredDescriptionDefault
knowledgeBaseIdYesThe unique identifier of the knowledge base

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.1.0
    • addedInput schema / properties / knowledgeBaseId / description
      Added value: +"The unique identifier of the knowledge base"
    • addedInput schema / properties / knowledgeBaseId / 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?

Annotations already declare readOnly, idempotent, non-destructive; the description goes further and adds the operational prerequisites an agent cannot infer from annotations: it requires a Sub-Account (location) token and the knowledge-bases.readonly OAuth scope. It also discloses the underlying endpoint, HTTP verb, and API version header, which helps an agent debug auth/version failures.

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, scopes) make it scannable and front-loaded with the highest-value routing information. The opening line duplicates the tool title and the endpoint/source metadata is somewhat verbose, but no sentence is truly dead weight.

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?

For a single-parameter read with no output schema, the description covers everything an agent needs: what is returned ("success and the knowledge base record"), the auth/token requirement, the required scope, and the endpoint. Nothing material is left for the agent to guess.

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% for the single parameter, so the schema already carries the semantics; the description only restates that retrieval is keyed by id and never describes the expected id format. Baseline 3 is appropriate when the schema does the work, but nothing is added here.

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 ("Retrieves one knowledge base by id") and enumerates the returned content (name, metadata, timestamps), so the agent knows exactly what it gets. The HOW section explicitly distinguishes this from the list/browse and rename siblings. Minor wart: the siblings are named in camelCase (listAllKnowledgeBasesPaginated, updateKnowledgeBase) rather than by their registered tool names, but the functional contrast is unambiguous.

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?

A dedicated WHEN TO USE line gives the selecting condition ("inspect a single knowledge base") and names two alternatives with the condition that selects each (browse → list; rename → update). This is the explicit when/when-not/alternative pattern the top band requires.

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