Get Endpoint Coverage

Immutable Catalog Entry

This descriptor comes from the active versioned Portal catalog.

READghl.get_endpoint_coverage

• Contract tier: agent_ready
• Risk: read
• Catalog version: 2026-07-12.2
• Descriptor hash: 90683173751c67f8c84ecbac741c1e2e65fd2327af2f4f913d703805dae13dab

Use this to inspect how GHL API endpoints, local helpers, and composite workflows map to native MCP tools. Results are deterministic and paginated from the provider-owned manifest; this does not contact GoHighLevel.

Request Body

{
  "jsonrpc": "2.0",
  "id": "ghl-get-endpoint-coverage-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.get_endpoint_coverage",
    "arguments": {
      "limit": 1,
      "cursor": 1,
      "status": "mapped",
      "category": "category_example",
      "include_hidden": false
    }
  }
}

Arguments Schema

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 250,
      "minimum": 1,
      "description": "Maximum coverage entries to return. Defaults to 50 and is capped at 250."
    },
    "cursor": {
      "type": "integer",
      "minimum": 0,
      "description": "Zero-based result offset returned by the previous nextCursor value."
    },
    "status": {
      "enum": [
        "mapped",
        "local",
        "composite",
        "documented_without_endpoint_metadata"
      ],
      "type": "string",
      "description": "Optional exact endpoint-coverage status filter."
    },
    "category": {
      "type": "string",
      "description": "Optional exact manifest category slug, such as contacts, calendars, or media_storage."
    },
    "include_hidden": {
      "type": "boolean",
      "description": "When true, include hidden tenant-admin and cross-tenant tools. Defaults to false."
    }
  },
  "additionalProperties": false
}

Output Schema

{
  "type": "object",
  "required": [
    "ok",
    "data",
    "error",
    "meta"
  ],
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Whether the GHL MCP operation completed successfully."
    },
    "data": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "array",
          "items": {}
        },
        {
          "type": "string"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "description": "Tool-specific GHL or local navigation result when ok is true."
    },
    "meta": {
      "type": "object",
      "description": "Safe execution, routing, and timing metadata.",
      "additionalProperties": true
    },
    "error": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ],
      "description": "Safe error details when ok is false; credential values are never returned."
    }
  },
  "description": "Normalized GHL MCP response envelope.",
  "additionalProperties": false
}

Code Examples

cURL

curl -X POST 'https://portal.madpanda3d.com/api/mcp' \
  -H 'Authorization: Bearer mad_live_***' \
  -H 'Content-Type: application/json' \
  -d '{
  "jsonrpc": "2.0",
  "id": "ghl-get-endpoint-coverage-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.get_endpoint_coverage",
    "arguments": {
      "limit": 1,
      "cursor": 1,
      "status": "mapped",
      "category": "category_example",
      "include_hidden": false
    }
  }
}'

Node.js

const response = await fetch('https://portal.madpanda3d.com/api/mcp', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer mad_live_***',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "jsonrpc": "2.0",
  "id": "ghl-get-endpoint-coverage-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.get_endpoint_coverage",
    "arguments": {
      "limit": 1,
      "cursor": 1,
      "status": "mapped",
      "category": "category_example",
      "include_hidden": false
    }
  }
}),
});
const data = await response.json();
console.log(data);

Python

import requests

url = 'https://portal.madpanda3d.com/api/mcp'
headers = {
    'Authorization': 'Bearer mad_live_***',
    'Content-Type': 'application/json',
}
payload = {
  "jsonrpc": "2.0",
  "id": "ghl-get-endpoint-coverage-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.get_endpoint_coverage",
    "arguments": {
      "limit": 1,
      "cursor": 1,
      "status": "mapped",
      "category": "category_example",
      "include_hidden": false
    }
  }
}
response = requests.post(url, headers=headers, json=payload, timeout=60)
print(response.json())

Example Responses

200 Success

{
  "ok": true,
  "message": "Tool ghl.get_endpoint_coverage executed successfully.",
  "note": "Response shape varies by MCP tool. Inspect live responses for exact fields."
}

502 Upstream Error

{
  "ok": false,
  "classification": "upstream_http_error",
  "message": "Upstream MCP returned a non-success status."
}