Skip to main content
Glama
Sign In
Ferret

Ferret

by ferret-project
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Log an odometer / hour-meter reading

record_reading

Logs an item's current counter reading, such as odometer miles or engine hours, so usage-based maintenance can be rescheduled.

Instructions

Records what an item's counter says now — a car's odometer, a mower's or generator's engine hours, a furnace's run hours — in the item's usageUnit (set it with update_item first: miles, km, hours or cycles). Maintenance by use on that item ("every 5,000 miles") is rescheduled from it. Use it when the person mentions a reading; when they've just done the maintenance, give the reading to complete_maintenance instead.

Input Schema

NameRequiredDescriptionDefault
idYesThe item's id (one with a usageUnit), from search_inventory
noteNoAnything worth noting with the reading
valueYesWhat the counter says now, in the item's usageUnit
readOnNoWhen it was read, yyyy-mm-dd; today if left out

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.1.1
    • changedInput schema / properties / id / description
      Previous value: -"The item"New value: +"The item's id (one with a usageUnit), from search_inventory"
    • addedInput schema / properties / note / description
      Added value: +"Anything worth noting with the reading"
    • addedInput schema / properties / readOn / description
      Added value: +"When it was read, yyyy-mm-dd; today if left out"
    • addedInput schema / properties / value / description
      Added value: +"What the counter says now, in the item's usageUnit"
  2. First observedv0.1.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations only declare this is a non-destructive write within a closed world; the description adds the real side effect — usage-based maintenance ("every 5,000 miles") is rescheduled from the reading — plus the prerequisite that the item must already have a usageUnit. It stops short of covering edge cases such as a reading lower than the previous one or what happens if usageUnit is missing.

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 tight sentences: what it does, what it affects downstream, then when to use it versus the alternative. The verb and the routing constraint are front-loaded, and the unit examples earn their space by preventing unit confusion.

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 four-parameter write tool with no output schema, the description covers purpose, prerequisite, side effect, and sibling routing. Only minor gaps remain — no mention of validation behavior for decreasing readings or the response shape after logging.

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 coverage is 100%, so the baseline is 3; the description adds genuine value by enumerating the possible unit values (miles, km, hours, cycles) that the schema leaves as an open string, and by tying `value` to the item's configured unit rather than a free-form number.

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 and resource ("Records what an item's counter says now") and anchors it with concrete instances (car odometer, mower/generator engine hours, furnace run hours). It is clearly distinguishable from sibling write tools like update_item or complete_maintenance.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives an explicit positive trigger ("Use it when the person mentions a reading") and an explicit alternative with its condition ("when they've just done the maintenance, give the reading to complete_maintenance instead"). It also names the prerequisite tool (update_item) needed to set usageUnit.

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