Shopmonkey MCP Server

list_payments

Retrieve payments from Shopmonkey using filters for work order ID or location, with pagination to manage large result sets.

Instructions

List payments from Shopmonkey. Supports filtering and pagination.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_payments"
  }
}

Input Schema

Name	Required	Description
`skip`	No	Number of records to skip for pagination (default: 0)
`limit`	No	Maximum number of results to return (default: 25)
`orderId`	No	Filter payments by work order ID
`locationId`	No	Filter by location ID. Defaults to SHOPMONKEY_LOCATION_ID env var if set.

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedv1.1.1Sep 8, 2026

removedInput schema / properties / page

Removed value: -{
-  "description": "Page number for pagination (default: 1)",
-  "type": "number"
-}

addedInput schema / properties / skip

Added value: +{
+  "description": "Number of records to skip for pagination (default: 0)",
+  "type": "number"
+}

First observedv1.0.0Mar 26, 2026

TDQS

A3.8/5.0

Behavior3/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It adds that filtering and pagination are supported, which is useful, but it does not mention return format, ordering, or any prerequisites. It also doesn't state that it is read-only, though 'list' implies it.

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

Conciseness5/5

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

The description is two short sentences, front-loading the purpose ('List payments from Shopmonkey') and then adding the key capability. No unnecessary words.

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 simple list tool with fully documented parameters and no output schema, the description is sufficient to understand what the tool does. However, it omits details about the response structure and any limits, but these are not critical for a basic list operation.

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?

The input schema provides descriptions for all four parameters (100% coverage), so the description adds little beyond the general statement of filtering and pagination. The defaults and env var behavior are already in the schema.

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

Purpose5/5

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

The description uses the specific verb 'List' with the resource 'payments' from Shopmonkey, clearly distinguishing it from the sibling tool get_payment (singular). It also notes support for filtering and pagination, which further clarifies its role as a collection-retrieval tool.

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?

The description provides context that the tool supports filtering and pagination, implying it is for retrieving multiple payments with optional constraints. However, it does not explicitly state when to prefer this over get_payment or other list tools, nor does it mention exclusions.

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

Deploy Server