Skip to main content
Glama
Achindra2003

Zoho Inventory Connector

by Achindra2003

get_sales_order

Read-onlyIdempotent

Fetch a single sales order by ID, reference number, or order number to view line items, shipped quantities, packages, and masked customer contact.

Instructions

One sales order with line items, shipped quantities, packages and (masked) customer contact. Give exactly one identifier.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
salesorder_idNoZoho salesorder_id.
reference_numberNoStorefront / Razorpay order or payment ID.
salesorder_numberNoe.g. SO-00101.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dateYes
notesYes
totalYes
statusYes
customerYes
packagesYes
line_itemsYes
paid_statusYes
customer_nameYes
last_modifiedYes
salesorder_idYes
shipped_statusYes
delivery_methodYes
invoiced_statusYes
reference_numberNoOften the storefront / Razorpay order or payment ID.
shipping_addressYes
salesorder_numberYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, covering the safety profile. The description adds useful context: the response includes line items and masked customer contact. Beyond that, it doesn't disclose auth requirements, error behavior for failed lookups, or rate limits, so it adds moderate value on top of solid annotations.

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?

Two tight sentences, front-loaded with what is returned and followed by the input constraint. No filler.

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?

An output schema exists, so return-value explanation isn't required, and annotations carry the safety profile. Combined with a summary of returned fields and the one-identifier constraint, this is nearly complete; the only gap is an explicit sibling routing statement.

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 the schema fully documents the three identifier parameters. The description's 'Give exactly one identifier' reinforces exclusivity but adds no format or syntax detail beyond what the schema provides; baseline 3 applies.

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?

States a specific verb (get) and resource (sales order) and enumerates the returned content (line items, shipped quantities, packages, masked customer contact), clearly distinguishing this single-record fetch from sibling list_sales_orders and search_sales_orders.

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 instruction 'Give exactly one identifier' implies usage as a single-record lookup, and the contrast with list/search siblings is discernible from the name. It does not explicitly state when not to use it or name the human-readable alternative, but the constraint is clear.

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