clover-mcp

get_customer

Read-only

Retrieve a single customer by ID from Clover POS, with optional addresses or orders. Requires CUSTOMERS_R permission.

Instructions

Return a single customer by ID.

Pass include=["addresses"] or include=["orders"] to opt in to optional fields. Cards are never returned. Requires CUSTOMERS_R.

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": {
      "customer_id": "<customer_id>"
    },
    "name": "get_customer"
  }
}

Input Schema

Name	Required	Description	Default
`include`	No
`customer_id`	Yes

Output Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.7.0Aug 7, 2026

TDQS

A4.5/5.0

Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, which signal a safe read operation. The description adds valuable behavioral context beyond annotations: 'Cards are never returned' and 'Requires CUSTOMERS_R', which inform the agent about data exclusion and permission requirements. This is a meaningful addition beyond the structured metadata.

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 three sentences of minimal length, front-loaded with the primary purpose, and every sentence adds specific information: purpose, parameter usage, and constraints. No wasted words.

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

Completeness5/5

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

For a two-parameter get-by-ID tool with an output schema present, the description covers the purpose, parameter usage, data exclusions, and authorization requirement. It is sufficiently complete for an agent to correctly select and invoke the tool without needing additional clarification.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has no descriptions for either parameter (0% coverage), so the description must compensate. It clarifies customer_id's purpose implicitly via the tool's purpose, and explicitly explains include with concrete examples ('include=["addresses"] or include=["orders"]') and the concept of opting into optional fields. This adds useful meaning beyond the raw 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 opens with 'Return a single customer by ID,' a specific verb+resource+scope statement that clearly distinguishes this from list/search tools. It unambiguously identifies the operation and the key identifier.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context on when to use the tool: when you have a customer ID and want a single customer. It also gives usage details like the include parameter for optional fields and the required CUSTOMERS_R permission, but it does not explicitly name alternative tools or state when not to use it.

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

Deploy Server