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

ghl-mcp-server-v2

by zackscriven

ghl_object_create_record

Create a record for a GoHighLevel custom or standard object by specifying the object schema key and field values.

Instructions

SPEC GAP: CreateCustomObjectRecordDto is an empty object schema in v3/objects-v3.json — verified against the raw spec, not an extraction bug. The body property will accept arbitrary JSON; GHL's convention (per external docs linked from this op, not confirmed in this corpus) is a properties object keyed by the object's field keys. Create Record Create a Custom Object Record. Supported Objects business and custom objects. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-376296 Endpoint: POST /objects/{schemaKey}/records (Version header: v3; source: v3/objects-v3.json) OAuth scopes: objects/record.write

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": {
      "schemaKey": "<schemaKey>",
      "body": "<body>"
    },
    "name": "ghl_object_create_record"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
schemaKeyYesThe key of the Custom Object / Standard Object Schema. For custom objects, the key must include the “custom_objects.” prefix, while standard objects use their respective object keys. This information is available on the Custom Objects Details page under Settings.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv2.1.0
    • addedInput schema / properties / body / properties / locationId
      Added value: +{
      +  "description": "Location Id",
      +  "example": "ve9EPM428h8vShlRW1KT",
      +  "type": "string"
      +}
    • addedInput schema / properties / body / properties / properties
      Added value: +{
      +  "additionalProperties": true,
      +  "description": "Properties of the custom object record. Keys are the object field names; values are the field values (string, number, or a monetary { currency, value } object).",
      +  "example": {
      +    "pet_age": 10,
      +    "pet_name": "Cat"
      +  },
      +  "type": "object"
      +}
    • addedInput schema / properties / body / required
      Added value: +[
      +  "locationId",
      +  "properties"
      +]
    • addedInput schema / properties / body / title
      Added value: +"CreateCustomObjectRecordDto"
  2. First observedv2.0.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=false and openWorldHint=true, so the safety profile is covered. The description adds genuinely non-redundant context: the required OAuth scope (objects/record.write), the API version header (v3), and the fact that the upstream DTO is empty so the body accepts arbitrary JSON with a `properties` map convention. That disclosure goes meaningfully beyond the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The essential facts (verb, resource, endpoint, scope, body convention) are present, but the leading paragraph contains maintainer-facing meta-commentary ('verified against the raw spec, not an extraction bug', 'not confirmed in this corpus') that does not help an agent decide or call the tool. The actual purpose statement is buried after the caveat rather than front-loaded.

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

Completeness4/5

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

For a two-parameter mutation with no output schema, the definition covers the endpoint, auth scope, supported object types, body shape ambiguity, and links external docs. What is missing is any statement of what a successful call returns (e.g. the created record id) and whether the operation is location-scoped beyond the locationId body field.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3, but the description earns an extra point by explaining the one thing the schema cannot: that CreateCustomObjectRecordDto is an empty object upstream and the agent should send a `properties` object keyed by field names. It does not restate the schemaKey prefix rule, which the schema already documents well.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource ('Create a Custom Object Record') and gives the concrete endpoint POST /objects/{schemaKey}/records, so an agent can tell this creates a record rather than a schema (ghl_object_create_custom_object) or updates one (ghl_object_update_record). It does not explicitly name the sibling tools it must be distinguished from, so it stops short of a 5.

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?

Usage is only implied by the verb 'Create' plus the note that both business and custom objects are supported. There is no explicit statement of when to use this versus update_record, upsert, or the schema-creation tool, and no prerequisites or exclusions are listed.

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