Skip to main content
Glama
gura105

Operational Ontology

traverse_customer_orders

Follow the Customer-to-Order link customerOrders to retrieve linked orders for a customer or the customer for an order, using a source instance from get or search.

Instructions

Traverse the Customer → Order link "customerOrders" (one-to-many). Pass an instance returned by get or search; its properties are a snapshot, not authority. Direction is inferred from source.type; an explicit direction must agree.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sourceYes
directionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.4.0
    • removedInput schema / properties / direction / default
      Removed value: -"forward"
    • removedInput schema / properties / pk
      Removed value: -{
      -  "type": "string"
      -}
    • addedInput schema / properties / source
      Added value: +{
      +  "properties": {
      +    "pk": {
      +      "type": "string"
      +    },
      +    "properties": {
      +      "additionalProperties": {},
      +      "propertyNames": {
      +        "type": "string"
      +      },
      +      "type": "object"
      +    },
      +    "type": {
      +      "enum": [
      +        "Customer",
      +        "Order"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "type",
      +    "pk",
      +    "properties"
      +  ],
      +  "type": "object"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "pk"
      -]New value: +[
      +  "source"
      +]
  2. First observedv0.1.0

TDQS

A4.1/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It usefully discloses that the instance's properties are a snapshot and not authoritative, and that direction is inferred from source.type. It omits other behavioral facts an agent would want: what the traversal returns, whether it re-reads current state, and any pagination or permission behavior.

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?

Three dense sentences with no filler; the link identity and cardinality are front-loaded, followed by the input provenance and the direction rule.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

No output schema and no annotations, and the description never states what a traversal yields (presumably a list of related Orders) or its size/pagination behavior. It adequately covers inputs and direction semantics but leaves the return side underspecified for a nested-object tool.

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 0%, so the description must compensate, and it does: it explains the origin of `source` (from get/search), that its properties are a snapshot, and the direction-inference rule plus the constraint that an explicit direction must agree with source.type. This is substantive meaning the schema does not encode.

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 (traverse) and a precisely named resource (the Customer → Order link "customerOrders"), including its one-to-many cardinality. An agent can distinguish this from sibling traversal tools like traverse_order_products or traverse_order_notes without opening the schema.

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?

Tells the agent where the required `source` must come from (an instance returned by get or search) and how direction is resolved. It does not explicitly contrast with get_order/search_order alternatives, so it stops short of full when/when-not guidance.

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