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

ghl-mcp-server-v2

by zackscriven

ghl_location_upload_file_custom_fields

Uploads a file to a location's custom field using multipart/form-data, associating it with the specified custom field ID.

Instructions

File upload — body is multipart/form-data (the file plus its associated customField id/name), not JSON. The spec has no application/json alternative for this op. Uploads File to customFields Endpoint: POST /locations/{locationId}/customFields/upload (Version header: v3; source: v3/locations-v3.json) OAuth scopes: locations/customFields.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": {
      "locationId": "<locationId>",
      "body": "<body>"
    },
    "name": "ghl_location_upload_file_custom_fields"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
locationIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv2.1.0
    • addedInput schema / properties / body / properties / id / anyOf
      Added value: +[
      +  {
      +    "description": "Id(Contact Id/Opportunity Id/Custom Field Id)",
      +    "example": "aWdODOBVOlH1RUFKWQke",
      +    "type": "string"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "filePath": {
      +        "type": "string"
      +      },
      +      "filename": {
      +        "type": "string"
      +      },
      +      "mimeType": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "filePath"
      +    ],
      +    "type": "object"
      +  }
      +]
    • removedInput schema / properties / body / properties / id / example
      Removed value: -"aWdODOBVOlH1RUFKWQke"
    • removedInput schema / properties / body / properties / id / type
      Removed value: -"string"
    • addedInput schema / properties / body / properties / maxFiles / anyOf
      Added value: +[
      +  {
      +    "description": "Max number of files",
      +    "example": "15",
      +    "type": "string"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "filePath": {
      +        "type": "string"
      +      },
      +      "filename": {
      +        "type": "string"
      +      },
      +      "mimeType": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "filePath"
      +    ],
      +    "type": "object"
      +  }
      +]
    • removedInput schema / properties / body / properties / maxFiles / example
      Removed value: -"15"
    • removedInput schema / properties / body / properties / maxFiles / type
      Removed value: -"string"
    • addedInput schema / properties / body / title
      Added value: +"FileUploadBody"
  2. First observedv2.0.0

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint=false, idempotentHint=false, destructiveHint=false, openWorldHint=true). The description adds real context beyond them: the mandatory multipart/form-data encoding, the absence of a JSON variant, the API version header, and the required OAuth scope locations/customFields.write. It stops short of describing failure modes or what happens on repeat uploads.

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?

Short and front-loaded with the highest-value fact (multipart, not JSON), plus endpoint and scope metadata. The line break after the first clause is a formatting artifact, but no sentence is pure filler.

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 nested-object upload with no output schema, the description supplies endpoint, encoding, version header, and auth scope — enough to invoke correctly. Missing only response shape and overwrite/idempotency behavior, which annotations partly signal.

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 coverage is 50%; locationId carries no description at all in the schema. The description partially compensates by clarifying that the body contains the file plus its associated customField id/name, which sharpens the ambiguous "Id(Contact Id/Opportunity Id/Custom Field Id)" schema text. It still says nothing about maxFiles or the filePath/filename/mimeType upload format.

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?

States a specific verb and resource ("Uploads File to customFields") plus the exact endpoint POST /locations/{locationId}/customFields/upload. It does not distinguish itself from adjacent upload tools like ghl_media_upload_file or ghl_form_upload_custom_files, leaving ambiguity about which upload path to choose.

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

Usage Guidelines2/5

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

Gives no when-to-use guidance or sibling alternatives, despite many upload-related tools in the sibling list. The only usage-adjacent detail is that the body must be multipart/form-data with no JSON alternative, which is a format constraint rather than routing guidance.

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