Skip to main content
Glama

Log maintenance

log_maintenance

Log a cleaning or maintenance job against a piece of equipment. A task that takes the thing apart opens a calibration epoch, and every recipe locked before it is read through that epoch's offset — so record the offset here if you counted the clicks while reassembling, which is the one moment anybody actually knows it. Any task in the maintenance vocabulary can be logged against a grinder or machine it belongs to — including one the maker advises against, because the log records what was done. Read each piece of equipment's tasks, their intervals and their due state from list_grinders and list_machines.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
noteNoOptional — what you did, and anything that surprised you
taskYesWhich maintenance job was performed
detailsNoFields specific to this task. Which ones a task takes is published as details_fields on each task; a burr clean takes none
evidenceNoOne line recording what the measurement rested on, e.g. "Counted 6 clicks coarser at reassembly."
guide_idNoOptional — the id of the maintenance guide that was followed. Must be a guide for this task
equipment_idYesThe ID of that piece of equipment
offset_valueNoThe correction, if you measured it now: clicks to ADD to a pre-clean reading to get the same grind today, signed along the collar's own number direction. Omit it and the epoch stays unmeasured, which is a state the app shows rather than a zero it assumes
performed_atNoWhen it was done (ISO 8601 or YYYY-MM-DD HH:MM:SS, UTC). Defaults to now; backdating is fine
disturbs_zeroNoWhether this job disturbed the reference the stored numbers are read against — for a burr clean, whether the burrs actually came out. Defaults to the task's own answer; send 0 for a wipe-down that left the collar alone
offset_sourceNoHow the offset was arrived at: pull (a reference shot), counted (clicks counted at reassembly), typed (asserted directly)
equipment_kindYesWhich kind of equipment this job was done on

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
entryYes
dedupedYes
messageYes
entry_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed12 schema fields changed
    • changedInput schema / properties / details / description
      Previous value: -"Fields specific to this task. Which ones a task takes is published as details_fields in the task catalog on list_grinders; a burr clean takes none"New value: +"Fields specific to this task. Which ones a task takes is published as details_fields on each task; a burr clean takes none"
    • changedInput schema / properties / equipment_kind / enum
      Previous value: -[
      -  "grinder"
      -]New value: +[
      +  "grinder",
      +  "machine"
      +]
    • addedInput schema / properties / guide_id
      Added value: +{
      +  "description": "Optional — the id of the maintenance guide that was followed. Must be a guide for this task",
      +  "type": "string"
      +}
    • changedInput schema / properties / task / enum
      Previous value: -[
      -  "burr_clean"
      -]New value: +[
      +  "burr_clean",
      +  "backflush_water",
      +  "backflush_detergent",
      +  "descale",
      +  "group_gasket_replace",
      +  "shower_screen_clean",
      +  "shower_screen_replace",
      +  "group_head_wipe",
      +  "basket_portafilter_soak",
      +  "steam_wand_purge",
      +  "steam_wand_soak",
      +  "drip_tray_clean",
      +  "water_tank_clean",
      +  "water_filter_replace",
      +  "boiler_water_change",
      +  "lever_piston_seal_replace",
      +  "lever_lubricate",
      +  "milk_system_clean",
      +  "professional_service",
      +  "builtin_grinder_burr_clean",
      +  "builtin_grinder_burr_replace",
      +  "grinder_quick_clean",
      +  "grinder_cleaning_tablets",
      +  "burr_replace",
      +  "hopper_clean",
      +  "grounds_cup_clean",
      +  "bearing_lubricate",
      +  "gasket_seal_replace",
      +  "idle_rinse",
      +  "water_wash",
      +  "dishwasher",
      +  "filter_prime",
      +  "softener_regenerate",
      +  "other"
      +]
    • addedOutput schema / properties / deduped
      Added value: +{
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / entry / properties / details / additionalProperties
      Added value: +true
    • addedOutput schema / properties / entry / properties / details / properties
      Added value: +{
      +  "filter_id": {
      +    "type": "string"
      +  },
      +  "label": {
      +    "type": "string"
      +  },
      +  "product": {
      +    "type": "string"
      +  }
      +}
    • addedOutput schema / properties / entry / properties / details / required
      Added value: +[]
    • changedOutput schema / properties / entry / properties / details / type
      Previous value: -"null"New value: +[
      +  "null",
      +  "object"
      +]
    • addedOutput schema / properties / entry / properties / guide_id
      Added value: +{
      +  "type": [
      +    "null",
      +    "string"
      +  ]
      +}
    • changedOutput schema / properties / entry / required
      Previous value: -[
      -  "id",
      -  "equipment_kind",
      -  "equipment_id",
      -  "task",
      -  "performed_at",
      -  "disturbs_zero",
      -  "note",
      -  "offset_value",
      -  "offset_source",
      -  "offset_at",
      -  "evidence",
      -  "details",
      -  "details_version",
      -  "created_at",
      -  "details_known"
      -]New value: +[
      +  "id",
      +  "equipment_kind",
      +  "equipment_id",
      +  "task",
      +  "performed_at",
      +  "disturbs_zero",
      +  "note",
      +  "offset_value",
      +  "offset_source",
      +  "offset_at",
      +  "evidence",
      +  "details",
      +  "details_version",
      +  "created_at",
      +  "guide_id",
      +  "details_known"
      +]
    • changedOutput schema / required
      Previous value: -[
      -  "entry_id",
      -  "entry",
      -  "message"
      -]New value: +[
      +  "entry_id",
      +  "entry",
      +  "deduped",
      +  "message"
      +]
  2. Changed2 schema fields changed
    • addedOutput schema / properties / entry / properties / details_known
      Added value: +{
      +  "type": "boolean"
      +}
    • changedOutput schema / properties / entry / required
      Previous value: -[
      -  "id",
      -  "equipment_kind",
      -  "equipment_id",
      -  "task",
      -  "performed_at",
      -  "disturbs_zero",
      -  "note",
      -  "offset_value",
      -  "offset_source",
      -  "offset_at",
      -  "evidence",
      -  "details",
      -  "details_version",
      -  "created_at"
      -]New value: +[
      +  "id",
      +  "equipment_kind",
      +  "equipment_id",
      +  "task",
      +  "performed_at",
      +  "disturbs_zero",
      +  "note",
      +  "offset_value",
      +  "offset_source",
      +  "offset_at",
      +  "evidence",
      +  "details",
      +  "details_version",
      +  "created_at",
      +  "details_known"
      +]
  3. Added

TDQS

A4.2/5.0
Behavior4/5

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

Annotations mark this as a non-read-only, non-destructive, non-idempotent write, and the description adds substantial domain behavior beyond that: disassembly opens a calibration epoch, locked recipes are re-read through the epoch offset, and omitting offset_value leaves the epoch unmeasured rather than zero. It doesn't spell out reversibility or duplicate-log behavior, but the added context is well above the annotation baseline.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The purpose is front-loaded and the first sentence is efficient, but the middle sentences are prose-heavy with filler ('which is the one moment anybody actually knows it') and take multiple reads to parse the epoch mechanics. It is adequately sized for a complex domain but not tightly written.

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?

With an output schema present, return values need not be described. The description covers the epoch/offset model, the vocabulary scope, task-specific details fields, and the read-prerequisite tools, which is substantial for an 11-parameter tool. Remaining gaps (e.g. duplicate logs, guide_id mismatches) are minor.

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, but the description adds genuine meaning: it explains why offset_value is available at this moment (reassembly), how disturbs_zero relates to a wipe-down that leaves the collar alone, and the unmeasured-epoch default. This contextualizes the numeric and enum parameters beyond their schema text.

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 opening sentence gives a specific verb and resource: 'Log a cleaning or maintenance job against a piece of equipment.' It is distinct from siblings like list_maintenance_due (read due state) and set_maintenance_offset (write an offset directly), and the follow-on sentences further clarify scope. An agent can identify the operation 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?

It routes the agent to list_grinders and list_machines to read tasks, intervals and due state before logging, which establishes the read-then-write workflow. It also clarifies that any vocabulary task may be logged, even maker-discouraged ones. It does not explicitly contrast use against set_maintenance_offset or set_maintenance_schedule, but context is largely clear.

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