Skip to main content
Glama

Get maintenance guides

get_maintenance_guides
Read-onlyIdempotent

Step-by-step maintenance guides: tools, supplies, steps and warnings, in our own words with the maker's documents as sources. With no arguments, every guide for the user's current grinders and machines (and the water filter fitted in each). With guide_ids, those guides; the ids come from maintenance.tasks[].guide.id in list_grinders and list_machines. Ids that match no guide are listed under missing.

Input Schema

NameRequiredDescriptionDefault
guide_idsNoOptional: the guides to fetch. Omit for every guide the user's equipment can use

Output Schema

NameRequiredDescriptionDefault
guidesYes
missingYes
catalog_versionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / guide_ids / description
      Previous value: -"Optional — the guides to fetch. Omit for every guide the user's equipment can use"New value: +"Optional: the guides to fetch. Omit for every guide the user's equipment can use"
  2. Changed1 schema field changed
    • addedOutput schema / properties / guides / items / properties / steps / items / properties / repeat
      Added value: +{
      +  "type": "integer"
      +}
  3. Changed2 schema fields changed
    • addedOutput schema / properties / guides / items / properties / steps / items / properties / anchor
      Added value: +{
      +  "type": "string"
      +}
    • changedOutput schema / properties / guides / items / properties / steps / items / required
      Previous value: -[
      -  "n",
      -  "text",
      -  "source"
      -]New value: +[
      +  "n",
      +  "text",
      +  "source",
      +  "anchor"
      +]
  4. Changed3 schema fields changed
    • removedOutput schema / properties / guides / items / properties / machine_alert / properties / can_disable / type
      Removed value: -"null"
    • removedOutput schema / properties / guides / items / properties / machine_alert / properties / depends_on_setting / type
      Removed value: -"null"
    • removedOutput schema / properties / guides / items / properties / machine_alert / properties / threshold / type
      Removed value: -"null"
  5. Added

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already cover read-only, idempotent, non-destructive, closed-world behavior. The description adds meaningful operational context: default scope, id provenance, unmatched-id reporting under 'missing', and that guide content is synthesized from maker documents.

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 front-loaded sentences with no filler; each sentence carries either mode selection, scope, id provenance, or edge-case behavior. Dense but appropriately sized for a retrieval tool with default and filtered modes.

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?

With an output schema present, the description need not explain the return shape. It covers content type, default scope, id source, and unmatched-id handling, while annotations carry the safety profile, so nothing material is missing for correct invocation.

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?

Schema coverage is 100%, but the description still adds substantial meaning beyond the schema: guide_ids should come from maintenance.tasks[].guide.id in list_grinders and list_machines, omitting the parameter fetches all guides for current equipment, and unmatched ids are reported under 'missing'.

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, enumerates the guide contents (tools, supplies, steps, warnings), and explains both invocation modes. It clearly distinguishes this retrieval tool from scheduling/due-list siblings by naming the sibling tools only as id sources.

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?

Explains the no-argument behavior (all guides for current grinders, machines, and fitted water filters) and the guide_ids behavior, including where ids come from. It does not explicitly compare against siblings such as list_maintenance_due or log_maintenance, nor does it state when not to use this tool.

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