Skip to main content
Glama
gura105

Operational Ontology

by gura105
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

traverse_order_notes

Navigate the one-to-many orderNotes link to retrieve related Notes for an Order or Orders for a Note by supplying a source instance; direction is inferred or explicitly set.

Instructions

Traverse the Order → Note link "orderNotes" (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": [
+        "Order",
+        "Note"
+      ],
+      "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?

No annotations exist, so the description carries the behavioral burden. It does add a meaningful caveat that source properties are a snapshot and not authority, which is genuinely useful for an agent. But it doesn't disclose whether any data is mutated, authorization constraints, pagination of the one-to-many result, or what the traversal returns. Given no annotations, more behavioral disclosure is warranted, so a 3 is appropriate.

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?

Four short clauses, no wasted words, and the key constraint (snapshot not authority) is front-loaded. Slightly elliptical but efficient.

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 traversal tool with no output schema and no annotations, the description is nearly complete: it explains the link, the source requirement, the snapshot caveat, and direction resolution. The one missing element is what the one-to-many traversal actually returns (a list of Notes) and whether it paginates, which would help an agent use it correctly.

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 is the only place meaning is added. It explains that 'source' must be a full instance (with type/pk/properties), that its properties are a non-authoritative snapshot, and that 'direction' is inferred from source.type unless explicitly provided. This covers the critical semantic for both parameters.

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 resource (the Order→Note link 'orderNotes'), explicitly calls out the one-to-many cardinality, and distinguishes itself from sibling traversal tools by naming the link. An agent can differentiate it from traverse_customer_orders or traverse_order_products immediately.

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 to pass an instance returned by get or search, which is a clear usage precondition. Direction inference rules are also stated. However, it doesn't mention when to prefer this over get/aggregate siblings or any exclusions, keeping it short of a 5.

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

Deploy Server

Other Tools