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

ghl-mcp-server-v2

by zackscriven

ghl_calendar_appointment_note_create

Create a note on a GoHighLevel calendar appointment by specifying the appointment ID and note body, so teams can record context or follow-up details directly on the event.

Instructions

Create Note Endpoint: POST /calendars/appointments/{appointmentId}/notes (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>",
      "body": "<body>"
    },
    "name": "ghl_calendar_appointment_note_create"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
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

C2.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, openWorldHint=true, idempotentHint=false, destructiveHint=false, so the safety profile is covered. The description adds useful context the annotations don't: the required OAuth scope calendars/events.write and the API version/source header. It does not describe error behavior for missing appointments or response shape.

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 first and the endpoint/scope metadata below. No wasted prose, though the raw JSON source filename is marginal boilerplate.

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 mutation tool with annotations and a fully documented nested schema, the auth scope and endpoint are covered. Gaps remain on failure modes and whether the note author defaults to the caller, which an agent would need given no output schema.

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 baseline is 3; the description adds no parameter meaning beyond naming appointmentId in the path template and confirming body is the payload. The nested NotesDTO fields (body, userId) are documented in schema only.

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?

"Create Note" alone is close to tautology, but the endpoint line (POST /calendars/appointments/{appointmentId}/notes) clarifies the resource is a note attached to a calendar appointment. It does not explicitly distinguish itself from siblings like ghl_contact_create_note or ghl_object_create_note, so the reader must infer the scope from the raw path.

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 statement of when to use this versus the note_list/note_update/note_delete siblings or contact/object note tools, and no prerequisites beyond the OAuth scope. The usage has to be inferred entirely from the endpoint name.

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