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

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

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
guidesYes
missingYes
catalog_versionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedOutput schema / properties / guides / items / properties / steps / items / properties / repeat
      Added value: +{
      +  "type": "integer"
      +}
  2. 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"
      +]
  3. 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"
  4. Added

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare the safe read-only and idempotent profile, so the description's job is supplementary. It adds genuinely useful behavior: unmatched ids are surfaced under 'missing', and the content's provenance ('our own words with the maker's documents as sources') is disclosed. It stops short of 5 only because it does not discuss scope limits like per-guide size or pagination.

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?

The first sentence front-loads what the tool returns, followed by the two invocation modes. It is efficient with no filler, though the first sentence is dense with enumerated content types and the id-provenance clause is packed into the second sentence.

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, return values need not be explained, and the description covers both call modes, the id source, and the 'missing' edge case. Nothing an agent needs to call it correctly is absent.

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 goes further by explaining where the ids originate (maintenance.tasks[].guide.id from list_grinders and list_machines) and by restating the omit-for-all behavior in domain terms. That provenance meaningfully exceeds the 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 description states a specific verb and resource — step-by-step maintenance guides — and enumerates exactly what they contain (tools, supplies, steps, warnings, and that content is authored in-house with maker documents as sources). An agent can tell it apart from siblings like list_maintenance_due 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 clearly distinguishes the two invocation modes: no arguments returns every guide for the user's current grinders, machines, and fitted water filters, while guide_ids fetches specific guides. It does not name explicit alternatives (e.g., list_maintenance_due) or when-not-to-use cases, so it stops short of a 5.

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