Skip to main content
Glama
AbbottDevelopments

Shopmonkey MCP Server

update_appointment

Modify or reschedule existing appointments in Shopmonkey by updating details like date, time, customer information, and work order links.

Instructions

Update or reschedule an existing appointment.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe appointment ID to update
customerIdNoCustomer ID for the appointment
vehicleIdNoVehicle ID for the appointment
orderIdNoWork order ID to link to
startDateNoNew start date/time (ISO 8601 format)
endDateNoNew end date/time (ISO 8601 format)
titleNoAppointment title or summary
notesNoAdditional notes

Implementation Reference

  • Handler function for 'update_appointment' which sends a PATCH request to the shopmonkey API.
    async update_appointment(args) {
      if (!args.id) return { content: [{ type: 'text', text: 'Error: id is required' }], isError: true };
      const body = pickFields(args, UPDATE_FIELDS);
      const data = await shopmonkeyRequest<Appointment>('PATCH', `/appointment/${sanitizePathParam(String(args.id))}`, body);
      return { content: [{ type: 'text', text: JSON.stringify(data, null, 2) }] };
    },
  • Input schema definition for the 'update_appointment' tool.
    {
      name: 'update_appointment',
      description: 'Update or reschedule an existing appointment.',
      inputSchema: {
        type: 'object' as const,
        properties: {
          id: { type: 'string', description: 'The appointment ID to update' },
          customerId: { type: 'string', description: 'Customer ID for the appointment' },
          vehicleId: { type: 'string', description: 'Vehicle ID for the appointment' },
          orderId: { type: 'string', description: 'Work order ID to link to' },
          startDate: { type: 'string', description: 'New start date/time (ISO 8601 format)' },
          endDate: { type: 'string', description: 'New end date/time (ISO 8601 format)' },
          title: { type: 'string', description: 'Appointment title or summary' },
          notes: { type: 'string', description: 'Additional notes' },
        },
        required: ['id'],
      },
    },
Behavior2/5

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

No annotations provided, so description carries full burden. States mutation intent ('update') but lacks behavioral details: partial vs full replacement semantics, validation rules for parameter combinations (e.g., vehicleId/customerId consistency), idempotency, error handling for invalid IDs, or return value structure.

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

Conciseness3/5

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

Single sentence is efficient and front-loaded, wasting no words. However, for an 8-parameter mutation tool with zero annotations and no output schema, the description is inappropriately brief—undersized for the complexity rather than optimally concise.

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

Completeness2/5

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

For a mutation tool with 8 parameters and no annotations/output schema, the description is insufficient. Lacks: explanation of partial update behavior, linking logic between orderId/vehicleId/customerId, return value documentation, and side effect disclosure.

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 has 100% description coverage, establishing baseline 3. Description adds minimal semantic context: 'reschedule' loosely implies date fields without explicitly mapping to startDate/endDate parameters. Does not explain parameter interactions or why only 'id' is required while other fields are optional.

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?

States specific verbs ('update', 'reschedule') and resource ('appointment'). Distinguishes from create_appointment by specifying 'existing' and from get/list tools by specifying mutation. However, does not clarify the relationship between 'update' and 'reschedule' (synonyms or distinct behaviors?) nor distinguish from sibling update tools (update_customer, update_vehicle).

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?

Implies prerequisite by stating 'existing appointment' but provides no explicit guidance on when to use this vs create_appointment, nor how to obtain the required ID (via get_appointment or list_appointments). No alternatives or prerequisites mentioned.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/AbbottDevelopments/shopmonkey-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server