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.

  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?

The annotations already indicate this is a write operation (readOnlyHint=false) and not explicitly destructive (destructiveHint=false). The description adds useful domain behavior, such as how programs cut off shots by weight or time and that a machine can mix both program types, but it does not describe side effects like overwriting an existing program or validation failures.

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?

The description is three concise sentences with no filler. The main purpose is front-loaded, and the conditional program-type logic is explained efficiently.

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 registration tool with an output schema and moderate parameter complexity, the description covers the essential distinctions and the core conditional parameter logic. It does not address every edge case, such as whether registering an existing program_number replaces it, but the provided information is sufficient for most correct invocations.

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 71%, and the schema already documents each parameter. The description adds valuable cross-parameter meaning by linking program_type 'volumetric' to target_volume_g and 'timed' to target_time_s, which helps prevent incorrect combinations. It does not add much about volume_source, but the schema handles that.

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 states a specific verb and resource: 'Register a programmed shot button on a machine,' and clarifies the two program types ('volumetric' and 'timed'). This clearly distinguishes it from sibling registration tools like register_machine, register_scale, or register_coffee.

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: when registering a shot program on a machine, and it explains the two modes supported. It does not explicitly name alternative tools or say when not to use it, but the context is strong enough to route an agent correctly.

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