Skip to main content
Glama
Sign In
ghl-api-mcp

ghl-api-mcp

by S5-labs
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Local

search_docs

Search GoHighLevel API documentation by keywords, endpoint names, or concepts to find relevant sections and endpoints.

Instructions

Search GoHighLevel API docs with keyword matching across endpoints and section content.

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": {
      "query": "<query>"
    },
    "name": "search_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of results to return (default: 8).
queryYesKeywords, endpoint name, scope, or concept to find.
whitelabel_domainNoOptional whitelabel API domain or base URL to use when rendering endpoint URLs.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.5/5.0
Behavior3/5

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

The description mentions 'keyword matching across endpoints and section content' hinting at the scope but lacks details on search behavior (e.g., case sensitivity, full-text vs partial match). No annotations are present to fill this gap.

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?

The description is a single efficient sentence that states the core functionality. It is front-loaded and to the point, though slightly more detail could be included without becoming verbose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description does not mention what the tool returns (e.g., a list of matching documents, excerpts, or URLs). Given no output schema, this omission leaves the agent uncertain about the result format, reducing completeness.

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?

All three parameters (limit, query, whitelabel_domain) have descriptions in the schema (100% coverage). The tool description adds no additional parameter information, meeting the baseline of 3 for high schema coverage.

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?

The description clearly states the tool's purpose: searching GoHighLevel API docs by keyword. It distinguishes from sibling tools like get_document, list_docs, etc., which do not perform keyword search.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for keyword-based search but does not explicitly state when to use this tool over alternatives like list_docs or get_endpoint_details. No exclusions or when-not-to-use guidance provided.

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