Skip to main content
Glama

Shopmonkey MCP by usefulapi

Search appointments

shopmonkey_search_appointments
Read-only

Search the appointment calendar by date range, customer, order or technician. Returns appointments with their customer. Shopmonkey: POST /v3/appointment/search.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
skipNoNumber of records to skip, for paging (use with limit).
sortNoSort by start date. Default asc.
endToNoAppointments ending at or before this ISO 8601 date-time.
limitNoMaximum number of records to return.
endFromNoAppointments ending at or after this ISO 8601 date-time.
orderIdNoOnly appointments linked to this order.
startToNoAppointments starting at or before this ISO 8601 date-time.
startFromNoAppointments starting at or after this ISO 8601 date-time.
customerIdNoOnly this customer's appointments.
techniciansNoOnly appointments assigned to these technician (user) ids.
includeUnassignedNoWith technicians, also include unassigned appointments.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so the safe-read profile is covered. The description adds that results include the associated customer, which is useful context, but it says nothing about pagination behavior, default result limits, or whether all supplied filters are ANDed together.

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?

Two functional sentences with the scope and filters front-loaded, followed by the endpoint mapping. The 'Shopmonkey: POST /v3/appointment/search' line is low-value for an agent that never calls HTTP directly, but it is short and does not distract.

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 an 11-parameter read-only search with no output schema, the description covers what is returned (appointments with their customer) and the filter space, and the schema fully documents every parameter including paging and sort. Only the interaction rules between filters and pagination defaults are left unstated, which is a minor gap.

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 all 11 parameters are already documented in the schema, setting the baseline at 3. The description's filter list (date range, customer, order, technician) maps onto some parameters but omits paging (skip/limit), sort, and includeUnassigned, adding no syntax or format detail beyond the schema.

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 names a specific verb and resource ('Search the appointment calendar') and enumerates the filter axes (date range, customer, order, technician). It is clearly distinct from write siblings like shopmonkey_create_appointment, though it never explicitly contrasts itself with the other list/search tools such as shopmonkey_search_customers or shopmonkey_list_orders.

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 implied by the listed filter dimensions: an agent can infer it should use this tool when it has any of those keys. However, there is no explicit when-to-use guidance, no statement of how filters combine, and no mention of alternatives (e.g., get_order or list_customer_orders when appointments are wanted in an order context).

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.