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

ghl-mcp-server-v2

by zackscriven

ghl_calendar_appointment_note_update

Idempotent

Updates the body of an existing note on a calendar appointment, letting you correct or revise appointment notes using the appointment ID and note ID.

Instructions

Update Note Endpoint: PUT /calendars/appointments/{appointmentId}/notes/{noteId} (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.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": {
      "appointmentId": "<appointmentId>",
      "noteId": "<noteId>",
      "body": "<body>"
    },
    "name": "ghl_calendar_appointment_note_update"
  }
}

Input Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv2.1.0
    • addedInput schema / properties / appointmentId / example
      Added value: +"ocQHyuzHvysMo5N5VsXc"
    • addedInput schema / properties / body / properties / userId / description
      Added value: +"User ID of the note author"
    • addedInput schema / properties / body / title
      Added value: +"NotesDTO"
  2. First observedv2.0.0

TDQS

B3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, destructiveHint=false, and openWorldHint=true, and the description is consistent with PUT/idempotent semantics. It adds genuinely useful operational context not in the annotations — the required OAuth scope calendars/events.write and the v3 version header — but does not say whether the note body is fully replaced or merged, or whether userId can be changed.

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 terse lines with the verb first and the endpoint, version header, and scope each on their own line; nothing is padded. It is lean to the point of under-specification, but structurally sound and 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 3-parameter, single-endpoint mutation with full schema coverage, no output schema, and annotations covering the safety profile, the description supplies the missing operational details an agent needs to actually invoke it: HTTP method, path, API version header, and OAuth scope. The remaining gap — partial vs full note replacement — is minor for this tool's complexity.

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 the nested NotesDTO body with its own field descriptions, so the schema carries the parameter burden. The description only restates appointmentId/noteId as path parameters via the URL template and adds no semantics about the maxLength-5000 body or the optional userId author field.

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

Purpose3/5

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

The title 'Update Note' plus the PUT template /calendars/appointments/{appointmentId}/notes/{noteId} makes clear this updates an existing note on a specific appointment. However, it does not distinguish this from the adjacent ghl_calendar_appointment_note_create / _delete / _list tools, so the agent must infer that this is the in-place modification variant rather than a new 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?

No guidance on when to use this instead of _create, _delete, or ghl_contact_update_note, and no preconditions stated beyond the OAuth scope. The agent must derive selection rules from the name alone.

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