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

ghl-mcp-server-v2

by zackscriven

ghl_kb_crawler_status

Read-onlyIdempotent

Fetches crawl or training progress for a specified operation, or the latest run, so you can poll discoverWebsite and trainDiscoveredUrls tasks and monitor status counts.

Instructions

Get crawling status for the latest operation Fetches crawl/train progress for a specific operation, or the latest operation when operationId is omitted. WHEN TO USE: use this when you need to poll a discoverWebsite or trainDiscoveredUrls run; do not use it to start a crawl or train pages. RETURNS: aggregated counts by status plus detailed operation information. Endpoint: GET /knowledge-bases/crawler/status (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": {
      "locationId": "<locationId>",
      "knowledgeBaseId": "<knowledgeBaseId>"
    },
    "name": "ghl_kb_crawler_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
locationIdYesLocation ID as string
operationIdNooperation id as string (optional - gets latest if not provided)
knowledgeBaseIdYesknowledge base id

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv2.1.0
    • changedInput schema / properties / knowledgeBaseId / example
      Previous value: -"jjkkxftgvbhjmn,"New value: +"RXzAdYGknD2phAoln3Jl"
    • changedInput schema / properties / operationId / description
      Previous value: -"operation id as string"New value: +"operation id as string (optional - gets latest if not provided)"
    • changedInput schema / properties / operationId / example
      Previous value: -1New value: +"688b640bcb02d498102a13f0"
    • changedInput schema / required
      Previous value: -[
      -  "locationId",
      -  "operationId",
      -  "knowledgeBaseId"
      -]New value: +[
      +  "locationId",
      +  "knowledgeBaseId"
      +]
  2. First observedv2.0.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the description is not burdened with the safety profile. It adds real context beyond that: the required Sub-Account (location) token, the knowledge-bases.readonly OAuth scope, and the fact that the call is a polling read. It stops short of any rate-limit or retry/backoff guidance for polling loops.

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 front-loaded with labeled WHEN TO USE and RETURNS blocks, and every block carries information. The opening line 'Get crawling status for the latest operation' is slightly redundant with the sentence that follows it, a minor duplication in an otherwise tight definition.

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 3-param read-only tool with no output schema, the description covers the necessary ground: what it returns (aggregated status counts plus operation detail), the auth requirement, the OAuth scope, and how it differs from the discover/train siblings. An agent can call it correctly without opening anything else.

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%, so all three parameters are documented in the schema, including operationId as optional. The description restates the operationId omission semantic ('latest operation when operationId is omitted'), which is useful but largely duplicates what the schema already says, so 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+resource ('Get crawling status') and scopes it to a specific or latest operation. The second sentence plus the WHEN TO USE line separates it from ghl_kb_crawler_discover and ghl_kb_crawler_train, which start the very jobs this tool reports on.

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?

Explicit when-to-use (polling a discoverWebsite or trainDiscoveredUrls run) and explicit when-not-to-use ('do not use it to start a crawl or train pages'), which routes the agent to the sibling mutation tools. Nothing about tool selection 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