Skip to main content
Glama

SOS Inventory MCP by usefulapi

List reference data

sosinventory_list_reference_data
Read-only

List a configuration or reference table: locations, channels, classes, departments, payment terms, tax codes, sales reps, ship methods, payment methods, priorities, order stages, price tiers, units of measure, users (id, name, email), accounts, custom fields, warranties, bins, workers, work centers, jobs, lots or serial numbers. Use it to find the ids and names that the create tools reference. GET /api/v2/{type}.

Input Schema

NameRequiredDescriptionDefault
typeYesWhich table to list (the API endpoint name).
queryNoFree-text filter (supported by some tables, e.g. job, lot, serial).
startNo1-based row number to start at (default 1). Pass next_start from the previous reply to read the next page.
max_resultsNoRows per call, 1-200 (default 50).

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?

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is covered elsewhere. The description adds the underlying endpoint (GET /api/v2/{type}) and hints at return fields ("users (id, name, email)"), but says nothing about result shape for other tables, page sizing behavior, or what happens with an unsupported query filter.

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?

Front-loaded with the purpose and the usage rule in the first two clauses; the long enumeration duplicates the enum but earns some of its length by translating slugs into human-readable table names. Slightly verbose but no filler sentences.

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?

With no output schema, the description should carry return-value expectations; it only partially does (user fields shown, other tables unspecified), though the pagination contract lives in the schema. For a simple read-only list tool this is nearly complete, with the return shape being the one real omission.

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 four parameters are already documented in the schema, including the next_start paging convention and the 1-200 max_results range. The description only adds that type values are the API endpoint names and that ids/names are what callers need, which is marginal over 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?

States a specific verb and resource ("List a configuration or reference table") and expands the enum slugs into readable table names (terms → payment terms, uom → units of measure), so an agent can map a natural-language entity to a type. It does not explicitly distinguish itself from the entity-specific siblings (list_customers, list_items, list_vendors), which is the remaining gap.

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?

"Use it to find the ids and names that the create tools reference" gives a concrete selection rule tied to the create_* siblings. It stops short of stating exclusions, e.g. whether to use this instead of list_customers/list_items for account-like tables.

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.