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

ghl-mcp-server-v2

by zackscriven

ghl_contact_update_note

Idempotent

Update an existing contact note by specifying the contact ID, note ID, and updated body fields such as title, color, pin status, or author. Use it to revise note content in GoHighLevel.

Instructions

Update Note Endpoint: PUT /contacts/{contactId}/notes/{id} (Version header: v3; source: v3/contacts-v3.json) OAuth scopes: contacts.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": {
      "contactId": "<contactId>",
      "id": "<id>",
      "body": "<body>"
    },
    "name": "ghl_contact_update_note"
  }
}

Input Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.1.0
    • addedInput schema / properties / body / title
      Added value: +"UpdateNoteDTO"
  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?

Annotations already declare the safety profile (readOnlyHint=false, idempotentHint=true, destructiveHint=false). The description adds genuinely useful context — the required OAuth scope 'contacts.write' and the v3 API version — but is silent on whether omitted body fields are preserved or cleared, which is the key behavioral question for a partial-update endpoint.

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?

Three short lines with the action front-loaded and no filler. The endpoint/source metadata is compact and skimmable, though the 'source: v3/contacts-v3.json' provenance is of marginal value to an agent.

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?

For a three-parameter, nested-body mutation with full schema coverage and no output schema, the description covers the transport-level facts (verb, path, version, scope). It stops short of the update semantics — partial vs full replacement, and what the response contains — that an agent would need to call it confidently.

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%, including per-field descriptions inside the nested UpdateNoteDTO, so the parameters are already fully documented. The description adds nothing beyond naming the path and body shape, so baseline 3 applies.

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 gives a specific verb and resource ('Update Note') plus the underlying PUT endpoint with both path parameters, which makes the operation unambiguous. It does not, however, differentiate itself from near-neighbours such as ghl_contact_create_note or ghl_object_update_note.

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?

There is no guidance on when to use this versus creating a new note, deleting one, or updating a note on a custom object. The only contextual cue is the OAuth scope, which implies a write operation but not a decision rule.

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