get_object_schema
Get object schema details by key including all fields and properties for custom or standard objects
This record as markdown: /tools/ghl/get-object-schema.md
What get_object_schema does on Ghl
AI agents call get_object_schema to retrieve information from Ghl without modifying anything. It is typically the context-gathering step in research, monitoring, and reporting workflows, before the agent takes action elsewhere.
| Parameter | Type | Required | Description |
|---|---|---|---|
key | string | Yes | Object key (e.g., "custom_objects.pet" for custom objects, "contact" for standard objects) |
locationId | string | — | Location ID (uses default if not provided) |
fetchProperties | boolean | — | Whether to fetch all standard/custom fields of the object |
Parameters from the server's own tool schema.
Why get_object_schema is rated Low
This tool retrieves schema information (fields and properties) for objects—a pure data query with no side effects, state changes, or external execution. It is informational in nature, consistent with the Read category.
From the tool's definition Tool name 'get_object_schema' and description 'Get object schema details by key including all fields and properties' indicates a read-only retrieval operation that queries metadata structure without modifying or executing operations.
Attacks that exploit this kind of access
The rule that runs get_object_schema safely
PolicyLayer is an MCP gateway: it sits between your AI agents and Ghl, and checks every tool call against a rule you set before the call runs. Nothing changes on the server itself. For get_object_schema, this is the rule to start with:
get_object_schema is read-only, so it stays allowed. Everything else on the server is denied unless you say otherwise.
The button opens the PolicyLayer dashboard: create your workspace, connect Ghl, apply this rule, and every get_object_schema call is checked against it from then on.
Questions about get_object_schema
Get object schema details by key including all fields and properties for custom or standard objects. It is categorised as a Read tool in the Ghl MCP Server, which means it retrieves data without modifying state.
get_object_schema accepts 3 parameters: key, locationId, fetchProperties. Required: key. The full parameter table on this page comes from the server's own tool schema.
Register the Ghl MCP server in PolicyLayer and add a rule for get_object_schema: allow, deny, rate-limit, or require approval. Point your MCP client at the PolicyLayer proxy URL and the rule is enforced on every call, before it reaches Ghl. Nothing to install.
get_object_schema is a Read tool with low risk. Read-only tools are generally safe to allow by default.
Yes. Add a rate_limit block to the get_object_schema rule in your PolicyLayer policy. For example, setting max: 10 and window: 60 limits the tool to 10 calls per minute. Rate limits are tracked per agent session and reset automatically.
Set action: deny in the PolicyLayer policy for get_object_schema. The AI agent will receive a policy violation error and cannot call the tool. You can also include a reason field to explain why the tool is blocked.
get_object_schema is provided by the Ghl MCP server (ghl-mcp-server). PolicyLayer sits as a proxy in front of this server to enforce policies before tool calls reach the server.
More on Ghl, and thousands of servers like it.
This server
Across the catalogue