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

ghl-mcp-server-v2

by zackscriven

ghl_user_update

Idempotent

Update user details such as role, permissions, and contact information for a specified GoHighLevel user via PUT /users/{userId}.

Instructions

KNOWN ISSUE: the official spec omits userId from this operation's path-parameter list (only the GET sibling declares it, despite all three sharing the same {userId} path template), so this tool currently has no input field for userId and calls will fail with a missing-path-parameter error until the generator (src/registry.ts) is patched to infer path params from the URL template. Tracked in this file's notes. Update User Endpoint: PUT /users/{userId} (Version header: v3; source: v3/users-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: users.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": {
      "userId": "<userId>",
      "body": "<body>"
    },
    "name": "ghl_user_update"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
userIdYesPath parameter (inferred from the URL template; the official spec omits its declaration).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.1.0
    • changedInput schema / properties / body / properties / permissions / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "adwordsReportingEnabled": {
      -        "default": false,
      -        "description": "Whether AdWords reporting is enabled for this user",
      -        "example": false,
      -        "type": "boolean"
      -      },
      -      "affiliateManagerEnabled": {
      -        "default": true,
      -        "description": "Whether the affiliate manager is enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "agentReportingEnabled": {
      -        "default": true,
      -        "description": "Whether agent reporting is enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "appointmentsEnabled": {
      -        "default": true,
      -        "description": "Whether appointments are enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "assignedDataOnly": {
      -        "default": false,
      -        "description": "Whether the user can only access data assigned to them",
      -        "example": false,
      -        "type": "boolean"
      -      },
      -      "attributionsReportingEnabled": {
      -        "default": false,
      -        "description": "Whether attributions reporting is enabled for this user",
      -        "example": false,
      -        "type": "boolean"
      -      },
      -      "bloggingEnabled": {
      -        "default": true,
      -        "description": "Whether blogging is enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "botService": {
      -        "default": false,
      -        "description": "Whether the bot service is enabled for this user",
      -        "example": false,
      -        "type": "boolean"
      -      },
      -      "bulkRequestsEnabled": {
      -        "default": true,
      -        "description": "Whether bulk requests are enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "campaignsEnabled": {
      -        "default": true,
      -        "description": "Whether campaigns are enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "campaignsReadOnly": {
      -        "default": false,
      -        "description": "Whether campaigns are in read-only mode for this user",
      -        "example": false,
      -        "type": "boolean"
      -      },
      -      "cancelSubscriptionEnabled": {
      -        "default": true,
      -        "description": "Whether cancelling subscriptions is enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "communitiesEnabled": {
      -        "default": true,
      -        "description": "Whether communities are enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "contactsEnabled": {
      -        "default": true,
      -        "description": "Whether contacts are enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "contentAiEnabled": {
      -        "default": true,
      -        "description": "Whether Content AI is enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "conversationsEnabled": {
      -        "default": true,
      -        "description": "Whether conversations are enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "dashboardStatsEnabled": {
      -        "default": true,
      -        "description": "Whether dashboard statistics are enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "exportPaymentsEnabled": {
      -        "default": true,
      -        "description": "Whether exporting payments is enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "facebookAdsReportingEnabled": {
      -        "default": false,
      -        "description": "Whether Facebook Ads reporting is enabled for this user",
      -        "example": false,
      -        "type": "boolean"
      -      },
      -      "funnelsEnabled": {
      -        "default": true,
      -        "description": "Whether funnels are enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "invoiceEnabled": {
      -        "default": true,
      -        "description": "Whether invoices are enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "leadValueEnabled": {
      -        "default": true,
      -        "description": "Whether lead value features are enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "marketingEnabled": {
      -        "default": true,
      -        "description": "Whether marketing features are enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "membershipEnabled": {
      -        "default": false,
      -        "description": "Whether membership features are enabled for this user",
      -        "example": false,
      -        "type": "boolean"
      -      },
      -      "onlineListingsEnabled": {
      -        "default": true,
      -        "description": "Whether online listings are enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "opportunitiesEnabled": {
      -        "default": true,
      -        "description": "Whether opportunities are enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "paymentsEnabled": {
      -        "default": true,
      -        "description": "Whether payments are enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "phoneCallEnabled": {
      -        "default": true,
      -        "description": "Whether phone calls are enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "recordPaymentEnabled": {
      -        "default": true,
      -        "description": "Whether recording payments is enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "refundsEnabled": {
      -        "default": true,
      -        "description": "Whether refunds are enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "reviewsEnabled": {
      -        "default": true,
      -        "description": "Whether reviews are enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "settingsEnabled": {
      -        "default": true,
      -        "description": "Whether settings are enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "socialPlanner": {
      -        "default": true,
      -        "description": "Whether the social planner is enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "tagsEnabled": {
      -        "default": true,
      -        "description": "Whether tags are enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "triggersEnabled": {
      -        "default": true,
      -        "description": "Whether triggers are enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "websitesEnabled": {
      -        "default": false,
      -        "description": "Whether websites are enabled for this user",
      -        "example": false,
      -        "type": "boolean"
      -      },
      -      "workflowsEnabled": {
      -        "default": true,
      -        "description": "Whether workflows are enabled for this user",
      -        "example": true,
      -        "type": "boolean"
      -      },
      -      "workflowsReadOnly": {
      -        "default": false,
      -        "description": "Whether workflows are in read-only mode for this user",
      -        "example": true,
      -        "type": "boolean"
      -      }
      -    },
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "adwordsReportingEnabled": {
      +        "default": false,
      +        "description": "Whether AdWords reporting is enabled for this user",
      +        "example": false,
      +        "type": "boolean"
      +      },
      +      "affiliateManagerEnabled": {
      +        "default": true,
      +        "description": "Whether the affiliate manager is enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "agentReportingEnabled": {
      +        "default": true,
      +        "description": "Whether agent reporting is enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "appointmentsEnabled": {
      +        "default": true,
      +        "description": "Whether appointments are enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "assignedDataOnly": {
      +        "default": false,
      +        "description": "Whether the user can only access data assigned to them",
      +        "example": false,
      +        "type": "boolean"
      +      },
      +      "attributionsReportingEnabled": {
      +        "default": false,
      +        "description": "Whether attributions reporting is enabled for this user",
      +        "example": false,
      +        "type": "boolean"
      +      },
      +      "bloggingEnabled": {
      +        "default": true,
      +        "description": "Whether blogging is enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "botService": {
      +        "default": false,
      +        "description": "Whether the bot service is enabled for this user",
      +        "example": false,
      +        "type": "boolean"
      +      },
      +      "bulkRequestsEnabled": {
      +        "default": true,
      +        "description": "Whether bulk requests are enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "campaignsEnabled": {
      +        "default": true,
      +        "description": "Whether campaigns are enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "campaignsReadOnly": {
      +        "default": false,
      +        "description": "Whether campaigns are in read-only mode for this user",
      +        "example": false,
      +        "type": "boolean"
      +      },
      +      "cancelSubscriptionEnabled": {
      +        "default": true,
      +        "description": "Whether cancelling subscriptions is enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "communitiesEnabled": {
      +        "default": true,
      +        "description": "Whether communities are enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "contactsEnabled": {
      +        "default": true,
      +        "description": "Whether contacts are enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "contentAiEnabled": {
      +        "default": true,
      +        "description": "Whether Content AI is enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "conversationsEnabled": {
      +        "default": true,
      +        "description": "Whether conversations are enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "dashboardStatsEnabled": {
      +        "default": true,
      +        "description": "Whether dashboard statistics are enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "exportPaymentsEnabled": {
      +        "default": true,
      +        "description": "Whether exporting payments is enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "facebookAdsReportingEnabled": {
      +        "default": false,
      +        "description": "Whether Facebook Ads reporting is enabled for this user",
      +        "example": false,
      +        "type": "boolean"
      +      },
      +      "funnelsEnabled": {
      +        "default": true,
      +        "description": "Whether funnels are enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "invoiceEnabled": {
      +        "default": true,
      +        "description": "Whether invoices are enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "leadValueEnabled": {
      +        "default": true,
      +        "description": "Whether lead value features are enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "marketingEnabled": {
      +        "default": true,
      +        "description": "Whether marketing features are enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "membershipEnabled": {
      +        "default": false,
      +        "description": "Whether membership features are enabled for this user",
      +        "example": false,
      +        "type": "boolean"
      +      },
      +      "onlineListingsEnabled": {
      +        "default": true,
      +        "description": "Whether online listings are enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "opportunitiesEnabled": {
      +        "default": true,
      +        "description": "Whether opportunities are enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "paymentsEnabled": {
      +        "default": true,
      +        "description": "Whether payments are enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "phoneCallEnabled": {
      +        "default": true,
      +        "description": "Whether phone calls are enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "recordPaymentEnabled": {
      +        "default": true,
      +        "description": "Whether recording payments is enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "refundsEnabled": {
      +        "default": true,
      +        "description": "Whether refunds are enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "reviewsEnabled": {
      +        "default": true,
      +        "description": "Whether reviews are enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "settingsEnabled": {
      +        "default": true,
      +        "description": "Whether settings are enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "socialPlanner": {
      +        "default": true,
      +        "description": "Whether the social planner is enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "tagsEnabled": {
      +        "default": true,
      +        "description": "Whether tags are enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "triggersEnabled": {
      +        "default": true,
      +        "description": "Whether triggers are enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "websitesEnabled": {
      +        "default": false,
      +        "description": "Whether websites are enabled for this user",
      +        "example": false,
      +        "type": "boolean"
      +      },
      +      "workflowsEnabled": {
      +        "default": true,
      +        "description": "Whether workflows are enabled for this user",
      +        "example": true,
      +        "type": "boolean"
      +      },
      +      "workflowsReadOnly": {
      +        "default": false,
      +        "description": "Whether workflows are in read-only mode for this user",
      +        "example": true,
      +        "type": "boolean"
      +      }
      +    },
      +    "title": "PermissionsDto",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / title
      Added value: +"UpdateUserDto"
  2. First observedv2.0.0

TDQS

B3.2/5.0
Behavior3/5

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

It adds real behavior beyond the annotations: token tier requirements and the exact OAuth scope needed for a users.write mutation, which annotations (readOnlyHint=false, idempotentHint=true, destructiveHint=false) do not cover. However, the opening 'KNOWN ISSUE' block is stale and self-contradicting — it claims the tool has no userId input and that calls will fail, while the input schema does declare a required userId 'inferred from the URL template' — which actively misleads an agent about whether the tool is callable.

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

Conciseness2/5

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

The most prominent content is an internal bug report about src/registry.ts that is irrelevant to invocation and now factually wrong. The genuinely useful facts — endpoint, version header, token requirement, scope — are buried after it, violating front-loading.

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

Completeness3/5

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

Auth, endpoint and scope are covered and the rich schema explains the body, so an agent has enough to attempt the call. But for a mutation tool with no output schema, the description should clarify what a successful update returns or whether partial updates are supported, and instead spends its space on the stale defect note.

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%, so the deeply documented body fields and the userId path parameter already carry their own semantics; baseline 3 applies. The description adds nothing about parameter semantics beyond the inaccurate claim about userId being absent.

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 names the resource and the operation explicitly ('Update User', 'PUT /users/{userId}'), which cleanly separates it from ghl_user_get, ghl_user_create and ghl_user_delete. It stops short of saying which user attributes are mutable or how this differs from ghl_user_get_by_location, so it is clear but not fully differentiated.

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?

Prerequisites are stated well ('Requires an Agency or Sub-Account token', 'OAuth scopes: users.write'), which tells an agent whether it is authorized. There is no guidance on when to choose this over the sibling update paths (e.g. ghl_user_get_by_location or ghl_contact_update) and no exclusion conditions.

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