Skip to main content
Glama

Update a grinder

update_grinder
Destructive

Correct a registered grinder — its name, burrs, collar scheme, nominal step, layout, range or notes. Only the keys you send in fields change; send null to clear an optional field (an empty string also clears a text field, but not a number or a closed list). Required fields can be changed but not cleared. fields may be omitted when only reason is sent. setting_scheme, nominal_step and components_spec describe the collar every recorded grind label is read through: call with dry_run first to see which recorded settings would read as a different position, and tell the user before saving. Saving records the change in the grinder's maintenance history; when a locked recipe's setting moves it also opens an unmeasured calibration epoch (set_maintenance_offset resolves it). The collar's current setting is marked assumed when it reads differently, or cleared when the new collar cannot read it, and measured offsets are converted when a click changes worth. Changing direction_convention is a correction — it moves no number, but every finer/coarser said about this grinder was the wrong way round.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fieldsNo
reasonNoOptional note, appended to this record's own notes as an ordinary line. Omit it and nothing is written.
dry_runNotrue: write nothing, and answer with what the edit would do to the settings already recorded (moved[], checked, epoch, position_moved, position_cleared, rescaled_offsets, resigned_offsets, step_ignored, direction_flipped, recipe_count)
grinder_idYesThis account's own grinder number, from list_grinders. Never guess one.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
epochYes
movedYes
statusYes
checkedYes
dry_runYes
messageYes
entry_idYes
grinder_idYes
unreadableYes
moved_countYes
changed_keysYes
recipe_countYes
step_ignoredYes
reads_changedYes
position_movedYes
untranslatableYes
position_clearedYes
rescaled_offsetsYes
resigned_offsetsYes
direction_flippedYes
untranslatable_recipesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / fields / properties / catalog_id
      Added value: +{
      +  "description": "The maintenance catalog model this grinder is; \"none\" if it is not listed; null to unbind. list_grinders proposes one from the name under maintenance.catalog.match",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
  2. Added

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already mark this destructive and non-idempotent, but the description adds substantial behavior beyond them: changes are recorded in the grinder's maintenance history, a locked recipe's setting move opens an unmeasured calibration epoch, the current setting is marked assumed or cleared, measured offsets are converted, and direction_convention is a non-numeric correction. These are exactly the side effects an agent must warn the user about.

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?

Front-loaded with the core action, then the clearing rules, then the collar consequences. Every sentence carries information, but the paragraph is dense and several clauses run long, so it is efficient rather than crisp.

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

Completeness5/5

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

For a mutation tool with history, calibration-epoch, and offset side effects, the description covers the ripple effects thoroughly, and an output schema exists for dry_run's return shape. An agent has everything needed to invoke this safely.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Adds semantics the schema does not carry: null clears an optional field, an empty string clears a text field but not a number or closed list, required fields can be changed but not cleared, and fields may be omitted when only reason is sent. It also explains dry_run's returned keys, going beyond the schema's brief description.

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?

Starts with a specific verb and resource ("Correct a registered grinder") and enumerates exactly which attributes can be changed — name, burrs, collar scheme, nominal step, layout, range or notes. This distinguishes it from register_grinder and the other update_* siblings without needing to open a 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?

Gives a concrete workflow: call with dry_run first to see which recorded settings would shift, and tell the user before saving. Also states fields may be omitted when only reason is sent, and points to set_maintenance_offset for resolving an epoch. It stops short of explicitly naming sibling alternatives (e.g. update_machine) or exclusions, so it is strong context rather than full when/when-not routing.

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.

Resources