Skip to main content
Glama

SOS Inventory MCP by usefulapi

List customers

sosinventory_list_customers
Read-only

List or search customers with contact details, billing/shipping addresses, terms, sales rep and credit-hold flag. Filter by name/notes text, name, email or update time. GET /api/v2/customer.

Input Schema

NameRequiredDescriptionDefault
nameNoMatch on the customer name or full name.
emailNoMatch on the customer email.
queryNoFree-text search over the customer name, full name and notes (use `email` for an email lookup).
startNo1-based row number to start at (default 1). Pass next_start from the previous reply to read the next page.
summaryNotrue (default) = summary records without line items and long sub-lists; false = full records.
max_resultsNoRows per call, 1-200 (default 50).
updated_sinceNoOnly customers created or updated since this local date-time (YYYY-MM-DDTHH:MM:SS).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

The annotations already declare `readOnlyHint: true`, `openWorldHint: true`, and `destructiveHint: false`, so the safety profile is covered. The description adds useful context about the endpoint and returned customer fields, but does not mention pagination behavior or other operational details beyond what the schema provides.

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 plus the endpoint and is front-loaded with the core action and return scope. It contains no redundant or filler text.

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?

The description summarizes the customer fields returned, which is helpful because there is no output schema, and all parameters are covered by the schema. It is nearly complete for a read-only list tool, though it could mention pagination or clarify the distinction from `get_customer`.

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 seven parameters are already documented in the input schema. The description repeats the filtering options at a high level but does not add syntax or behavioral 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 uses a clear verb and resource: 'List or search customers', and specifies the returned data such as contact details, addresses, terms, sales rep and credit-hold flag. It does not explicitly distinguish this tool from the sibling `sosinventory_get_customer`, but the list/search purpose is still clear.

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 implies usage by listing filterable fields such as name, email and update time, but it does not state when to choose this tool over `sosinventory_get_customer` or other siblings. The guidance is sufficient to understand filtering, but alternatives are left implicit.

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.