Skip to main content
Glama

ActionShip by Teapplix Demo

Get Shipping Rates for Order

teapplix_get_rates_for_order
Read-only

Get shipping rates for an existing Teapplix order. Requires TxnId, From (ship-from address or profile), and a Packages array (each package must include Method; Weight and Dimensions default to the order's stored values if omitted). [DEMO]

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
FromYesShip-from address OR a saved shipping profile — supply exactly one shape.
TxnIdYesTeapplix order ID.
OptionsNoAdvanced, rarely used. Omit unless the user explicitly requests features such as signature confirmation, insurance type, COD, etc.
PackagesYesOne or more packages to rate. Each package must include Method; Weight and Dimensions default to the order's stored values if omitted. All packages must use the same carrier. To compare carriers, prefer a RATESHOP method; otherwise make separate calls per carrier.
ShipDateNoShip date (YYYY-MM-DD). Defaults to today. Interpreted as Pacific timezone.
CustomsDeclarationNoInternational shipments only. Omit unless shipping outside the domestic country. Fields: ReasonForExport, IOssNumber, Items: [{Description, Quantity, Value, Weight, HSTariffNumber, CountryOfOrigin}].

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
RateNoRate for the requested method when it succeeded. Absent means the requested method failed — inspect AltRates for carrier suggestions. For RATESHOP, this is the winning (lowest-cost) candidate.
ZoneNoCarrier zone for the selected rate (e.g. "3").
AltRatesNoCarrier-provided alternate quotes. May appear alongside a successful Rate (carrier suggestions) or without Rate (requested method failed). Items with Error set are methods the carrier could not quote. For RATESHOP, all non-winning evaluated candidates — valid higher-cost quotes and failed methods.
WarningsNooptional warning message, you can safely ignore

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, covering the safety profile. The description adds useful behavioral context: Weight/Dimensions default to the order's stored values, packages must use the same carrier, and the [DEMO] tag hints at operational status. It does not discuss rate response format or potential external API delays, but with the output schema present and read-only annotation, the additional info is sufficient.

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 sentences and front-loaded with the main purpose. It packs essential requirements and a key default behavior without verbosity. The [DEMO] tag is a minor extra but does not hurt clarity. Every word contributes.

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?

Given the tool's complexity (6 parameters, nested objects) and the rich input schema (100% coverage) plus output schema, the description is concise but sufficient. It covers the primary use case and critical behaviors, and the structured schemas fill in the rest. It lacks explicit guidance on alternatives, but that is already addressed in usage guidelines. Overall, it is complete for an agent to invoke correctly in most situations.

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?

Schema description coverage is 100%, so the baseline is 3. The description adds value by summarizing the required parameters and clarifying the defaulting behavior for Weight and Dimensions, which reinforces the schema but also helps the agent identify the core requirements at a glance. The 'From' parameter's dual nature (address or profile) is also echoed. This elevates it above the baseline.

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 starts with a specific verb and resource: 'Get shipping rates for an existing Teapplix order.' This clearly distinguishes it from sibling tools like teapplix_get_rates (which likely handles general rate lookups without an order) and teapplix_purchase_label_for_order. The 'existing order' phrasing sets clear scope.

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 states required inputs (TxnId, From, Packages) and explains package requirements, including the carrier consistency rule and the defaulting behavior for Weight/Dimensions. It does not explicitly name alternative tools or state when not to use it, but the 'existing order' qualifier implies that other rate tools are for non-order contexts. Sibling names provide additional context, but this could be more explicit.

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.

TDQS

A3.9/5.0
Disambiguation4/5

Most tools have clearly distinct purposes (orders, labels, rates, zones, profiles). A few name pairs like manage_tag vs manage_order_tags and set_order_ship_options vs update_order could be confused, but the descriptions explicitly clarify when to use each.

Naming Consistency5/5

All tools share the teapplix_ prefix and follow a consistent verb_noun pattern (e.g., get_orders, create_order, purchase_label, validate_address). The only deviation is the bare 'help' tool, which is conventional and does not disrupt the pattern.

Tool Count4/5

At 28 tools, the server is slightly over the ideal 3-15 range, but the breadth of shipping operations (orders, labels, rates, manifests, tracking, configuration) justifies the count. It is not bloated.

Completeness5/5

The tool surface covers the full order-to-shipping lifecycle: order create/update/retrieve, splitting/merging, label purchase and cancellation, rate quotes, tracking, manifesting, address validation, 3PL submission, and configuration (profiles, warehouses, queues, tags). No significant gaps are apparent.

Resources