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

ghl-mcp-server-v2

by zackscriven

ghl_opportunity_update

Idempotent

Update an existing GoHighLevel opportunity by ID, including pipeline stage, status, monetary value, forecast details, assigned user, and custom fields.

Instructions

Body accepts pipelineId, name, pipelineStageId, status, monetaryValue, forecastExpectedCloseDate, forecastProbability, assignedTo, and customFields (id-or-key + string/array/object fieldValue variants) — all verified present against UpdateOpportunityDtoV3. Update Opportunity Endpoint: PUT /opportunities/{id} (Version header: v3; source: v3/opportunities-v3.json) OAuth scopes: opportunities.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": {
      "id": "<id>",
      "body": "<body>"
    },
    "name": "ghl_opportunity_update"
  }
}

Input Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.1.0
    • changedInput schema / properties / body / properties / customFields / items / anyOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "fieldValue": {
      -        "description": "Value of the custom field",
      -        "example": "9039160788",
      -        "type": "string"
      -      },
      -      "id": {
      -        "description": "Pass either `id` or `key` of custom field",
      -        "example": "6dvNaf7VhkQ9snc5vnjJ",
      -        "type": "string"
      -      },
      -      "key": {
      -        "description": "Pass either `id` or `key` of custom field",
      -        "example": "my_custom_field",
      -        "type": "string"
      -      }
      -    },
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "fieldValue": {
      -        "description": "Value of the custom field",
      -        "example": [
      -          "test",
      -          "test2"
      -        ],
      -        "items": {
      -          "type": "string"
      -        },
      -        "type": "array"
      -      },
      -      "id": {
      -        "description": "Pass either `id` or `key` of custom field",
      -        "example": "6dvNaf7VhkQ9snc5vnjJ",
      -        "type": "string"
      -      },
      -      "key": {
      -        "description": "Pass either `id` or `key` of custom field",
      -        "example": "my_custom_field",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "id"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "fieldValue": {
      -        "description": "Value of the custom field",
      -        "example": {
      -          "size": 1024,
      -          "url": "https://example.com/file.pdf"
      -        },
      -        "type": "object"
      -      },
      -      "id": {
      -        "description": "Pass either `id` or `key` of custom field",
      -        "example": "6dvNaf7VhkQ9snc5vnjJ",
      -        "type": "string"
      -      },
      -      "key": {
      -        "description": "Pass either `id` or `key` of custom field",
      -        "example": "my_custom_field",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "id"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "fieldValue": {
      +        "description": "Value of the custom field",
      +        "example": "9039160788",
      +        "type": "string"
      +      },
      +      "id": {
      +        "description": "Pass either `id` or `key` of custom field",
      +        "example": "6dvNaf7VhkQ9snc5vnjJ",
      +        "type": "string"
      +      },
      +      "key": {
      +        "description": "Pass either `id` or `key` of custom field",
      +        "example": "my_custom_field",
      +        "type": "string"
      +      }
      +    },
      +    "title": "customFieldsInputStringSchemaV3",
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "fieldValue": {
      +        "description": "Value of the custom field",
      +        "example": [
      +          "test",
      +          "test2"
      +        ],
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "id": {
      +        "description": "Pass either `id` or `key` of custom field",
      +        "example": "6dvNaf7VhkQ9snc5vnjJ",
      +        "type": "string"
      +      },
      +      "key": {
      +        "description": "Pass either `id` or `key` of custom field",
      +        "example": "my_custom_field",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "id"
      +    ],
      +    "title": "customFieldsInputArraySchemaV3",
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "fieldValue": {
      +        "description": "Value of the custom field",
      +        "example": {
      +          "size": 1024,
      +          "url": "https://example.com/file.pdf"
      +        },
      +        "type": "object"
      +      },
      +      "id": {
      +        "description": "Pass either `id` or `key` of custom field",
      +        "example": "6dvNaf7VhkQ9snc5vnjJ",
      +        "type": "string"
      +      },
      +      "key": {
      +        "description": "Pass either `id` or `key` of custom field",
      +        "example": "my_custom_field",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "id"
      +    ],
      +    "title": "customFieldsInputObjectSchemaV3",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / title
      Added value: +"UpdateOpportunityDtoV3"
  2. First observedv2.0.0

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare the mutation is idempotent and non-destructive, so the description's added value is the OAuth scope (opportunities.write), the endpoint/version header, and the provenance note that fields were verified against UpdateOpportunityDtoV3. It does not disclose partial-vs-full update semantics (what happens to omitted fields), which is the main remaining behavioral gap for a PUT.

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 content is dense but poorly front-loaded: it opens mid-sentence with "Body accepts..." before the actual purpose line, burying the verb/resource below the parameter list. Nothing is wasted, but the ordering works against rapid scanning.

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 mutation with no output schema and full annotation coverage, the definition supplies endpoint, auth scope, spec version, and body field provenance — enough to call it correctly. Only the semantics of partial updates remain unaddressed.

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 description coverage is 100% and the nested body is fully documented, so the schema carries the load. The description's enumeration of fields and the customFields id-or-key / string-array-object note largely restates what the schema already specifies, adding no new syntax or constraint detail.

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 the verb and resource plainly ("Update Opportunity") and pins the exact endpoint PUT /opportunities/{id} with version header v3, which unambiguously sets it apart from the status-only and upsert siblings. It never names a sibling explicitly, so differentiation is inferred rather than stated.

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?

There is no explicit when-to-use or when-not-to-use guidance and no named alternative (e.g., ghl_opportunity_update_status for status-only changes, ghl_opportunity_upsert for create-or-update). Usage is only implied by the presence of the full field list and the PUT endpoint.

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