Skip to main content
Glama

List preventive maintenance plans

upkeep_list_preventive_maintenance
Read-only

List preventive maintenance (PM) templates, the recurring work that generates scheduled work orders, with their schedules. Filter by text, asset, location, assignee, team or priority. Pages are 1-based. GET /pm.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number from 1 (default 1).
teamNoOnly records for this team id.
assetNoOnly records for this asset id.
searchNoText to find in the PM's name or description.
assigneeNoOnly records for this assigned user id.
locationNoOnly records for this location id.
priorityNoPriority: 0 none/lowest, 1 low, 2 medium, 3 high.
page_sizeNoPMs per page, 1-100 (default 25).
include_schedulesNoAlso return each PM's schedules.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is covered. The description contributes real behavioral detail beyond the annotations: 1-based paging, the GET /pm endpoint, and that schedules are only returned when requested. It does not mention pagination totals or default page size, leaving some gaps.

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 sentences, front-loaded with what the resource is, then filters, then paging rule, then the upstream endpoint. Every sentence carries information an agent can act on; nothing is repeated verbatim from the schema.

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 read-only list tool with 9 optional params and no output schema, the description covers purpose, filters and paging adequately. Missing are response-shape hints (totals, ordering, default page size) that an agent would need to iterate pages, though these are minor for a list call.

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. The description still adds value by naming the filterable dimensions (text, asset, location, assignee, team, priority) and stating pages are 1-based, which reinforces the schema's exclusiveMinimum constraint. It doesn't add format detail beyond the schema, so not a 5.

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?

Specific verb (List) plus a precise resource (preventive maintenance templates that generate scheduled work orders) with their schedules. The parenthetical explanation distinguishes PMs from the sibling upkeep_list_work_orders by clarifying PMs are the recurring templates, not the generated orders.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied by the filter list and the endpoint reference, but there is no explicit when-to-use / when-not-to-use guidance nor a pointer to the sibling (e.g. upkeep_list_work_orders for instances vs. templates). The agent must infer the split from the description alone.

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.