Skip to main content
Glama

Register a machine program

register_program

Register a programmed shot button on a machine. A program cuts the shot off either by weight (program_type "volumetric", set target_volume_g) or by time (program_type "timed", set target_time_s). One machine can have a mix of both.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
machine_idYes
descriptionNo
program_typeNoCutoff method: "volumetric" (weight) or "timed" (duration). Defaults to volumetric.
target_time_sNoTarget shot duration cutoff in seconds (required for timed programs)
volume_sourceNoConfidence in the stored cutoff value, for either type
program_numberYesProgram number / button index (e.g. 1 or 2)
target_volume_gNoTarget yield cutoff in grams (required for volumetric programs)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
statusYes
messageYes
program_idYes

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "properties": {
      +    "message": {
      +      "type": "string"
      +    },
      +    "program_id": {
      +      "type": "integer"
      +    },
      +    "status": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "status",
      +    "program_id",
      +    "message"
      +  ],
      +  "type": "object"
      +}
  2. Changed3 schema fields changed
    • changedInput schema / properties / description / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "null"
      +]
    • changedInput schema / properties / target_time_s / type
      Previous value: -"number"New value: +[
      +  "number",
      +  "null"
      +]
    • changedInput schema / properties / target_volume_g / type
      Previous value: -"number"New value: +[
      +  "number",
      +  "null"
      +]
  3. Changed5 schema fields changed
    • changedInput schema / properties / program_number / description
      Previous value: -"Program number (e.g. 1 or 2)"New value: +"Program number / button index (e.g. 1 or 2)"
    • addedInput schema / properties / program_type
      Added value: +{
      +  "description": "Cutoff method: \"volumetric\" (weight) or \"timed\" (duration). Defaults to volumetric.",
      +  "enum": [
      +    "volumetric",
      +    "timed"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / target_time_s
      Added value: +{
      +  "description": "Target shot duration cutoff in seconds (required for timed programs)",
      +  "type": "number"
      +}
    • changedInput schema / properties / target_volume_g / description
      Previous value: -"Target yield cutoff in grams"New value: +"Target yield cutoff in grams (required for volumetric programs)"
    • addedInput schema / properties / volume_source / description
      Added value: +"Confidence in the stored cutoff value, for either type"
  4. First observed

TDQS

A4.2/5.0
Behavior3/5

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

Annotations provide no behavioral signals, so the description carries the burden. It adds useful context: programs cut shots off by weight or time, and a machine can mix both types. However, it does not disclose behavior around duplicate program numbers, overwriting, or other registration side effects.

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 short sentences with no filler. The purpose is front-loaded, the mode-specific parameter guidance is compact, and the mixed-mode note adds useful context without repetition.

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 7-parameter tool with an output schema and 71% schema coverage, the description covers the essential mode-selection logic and the mixed-mode rule. It does not address duplicate registration or machine prerequisites, but those are not necessary for basic correct invocation.

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?

The description goes beyond the schema by explicitly linking program_type to the correct target parameter: 'set target_volume_g' for volumetric and 'set target_time_s' for timed. This clarifies the relationship between mutually exclusive parameters and compensates for incomplete schema coverage.

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 description opens with a specific action: 'Register a programmed shot button on a machine', and then defines what a program is. This makes the resource and scope clear, and it is easily distinguished from sibling register_coffee, register_grinder, etc.

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?

The description gives clear context for when to use the tool: registering a shot program on a machine, with two possible modes. It does not explicitly name alternatives or say when not to use it, but the register_* tool family is naturally separated by resource type.

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.

TDQS

B3.4/5.0
Disambiguation4/5

Most tools target a clearly distinct resource and action, and the list/register/update/set tool families are easy to tell apart. The closest pair is diagnose_preview and diagnose_shot, which are well-described but similar enough in name that an agent could select the wrong one.

Naming Consistency4/5

The overwhelming majority of tools follow a consistent verb_noun pattern (list_beans, register_grinder, update_shot, set_active). Minor exceptions like grinder_math and kb_changelog lack the imperative verb prefix, but they are readable and do not create real confusion.

Tool Count2/5

34 tools is above the 25+ threshold and feels heavy even though the domain is fairly rich. The many parallel list_* and register_* tools for beans, grinders, machines, scales, waters, programs, and recipes could plausibly be consolidated or trimmed without losing core capability.

Completeness3/5

The core shot lifecycle is well covered: log, update, delete, diagnose, and list shots, plus bean registration and maintenance tracking. However, most registered entities lack update/delete tools, and get_rule has no corresponding list_rules tool, leaving some obvious workflow gaps that agents must work around.

Resources