Skip to main content
Glama

SOS Inventory MCP by usefulapi

Get transaction

sosinventory_get_transaction
Read-only

One transaction of any type by id, with all fields and line items. GET /api/v2/{type}/{id}.

Input Schema

NameRequiredDescriptionDefault
idYesSOS record id (from sosinventory_list_transactions).
typeYesTransaction type (the API endpoint name).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds value beyond that by disclosing the response shape ('all fields and line items'), which matters since there is no output schema, and by giving the concrete endpoint. It stops short of noting any auth scope, rate limits, or whether the payload can be large for certain types.

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?

Two tight sentences, front-loaded with the resource and scope, followed by the endpoint path. No filler or redundancy; every clause carries information.

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 2-parameter read tool with full schema coverage and annotations, the definition covers what is returned ('all fields and line items') in the absence of an output schema. The remaining gap is sibling disambiguation against the type-specific getters, which leaves an agent guessing which of several tools to pick for a sales order or purchase order.

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%: both parameters are documented, and the enum of transaction types is fully enumerated in the schema. The description adds only the phrase 'any type', which does not extend the meaning of the type enum or the id beyond what the schema already provides, so baseline 3 applies.

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 ('One transaction of any type by id, with all fields and line items') and the underlying route, which is more informative than the bare title 'Get transaction'. The 'any type' phrasing implicitly contrasts with the type-specific siblings (get_sales_order, get_purchase_order), but never names them, so an agent must infer the routing itself.

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 only implied: the schema note 'from sosinventory_list_transactions' suggests the listing tool as the source of ids, but the description gives no when-to-use/when-not guidance. Crucially, it never explains when an agent should call this generic getter versus sosinventory_get_sales_order or sosinventory_get_purchase_order for the same record.

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.