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

ghl-mcp-server-v2

by zackscriven

ghl_calendar_appointment_note_list

Read-onlyIdempotent

Fetch paginated notes for a specific calendar appointment by appointment ID, using limit and offset to page through results.

Instructions

Get Notes Get Appointment Notes Endpoint: GET /calendars/appointments/{appointmentId}/notes (Version header: v3; source: v3/calendars-v3.json) OAuth scopes: calendars/events.readonly Pagination params: limit, offset — pass them to page through full result sets.

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": {
      "limit": "<limit>",
      "offset": "<offset>",
      "appointmentId": "<appointmentId>"
    },
    "name": "ghl_calendar_appointment_note_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitYesLimit of notes to fetch
offsetYesOffset of notes to fetch
appointmentIdYesAppointment ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.1.0
    • addedInput schema / properties / appointmentId / example
      Added value: +"ocQHyuzHvysMo5N5VsXc"
  2. First observedv2.0.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive), so the bar is lower; the description adds genuinely useful context beyond them — the required OAuth scope calendars/events.readonly, the v3 version header, and that limit/offset drive pagination of a full result set. It stops short of describing ordering or what a note record contains.

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?

Short and front-loaded with the resource, followed by endpoint, scope, and pagination in a compact block. 'Get Notes' duplicates the title and the source-file token is filler, but nothing bloats the definition.

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 three-parameter read-only list tool with full schema coverage and no output schema, the description supplies the endpoint, auth scope, and pagination intent an agent needs. The remaining gaps (result ordering, the schema's max limit of 20, what fields a note has) are minor.

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 coverage is 100%, so the schema already documents all three parameters. The description only adds that limit and offset are pagination parameters meant to be used together, which is marginal value beyond 'Limit of notes to fetch' / 'Offset of notes to fetch'. 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 name plus 'Get Appointment Notes' and the endpoint path GET /calendars/appointments/{appointmentId}/notes make it unambiguous that this reads notes attached to a specific appointment. It is clearly distinguishable from the sibling note_create/update/delete tools, though the prose never explicitly contrasts with them.

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?

Usage is only implied by the endpoint shape — an agent must infer this is the read path for appointment notes. The description does instruct how to page ('pass them to page through full result sets'), but it never states when to choose this over alternatives such as ghl_calendar_appointment_get or how to obtain the appointmentId.

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