Skip to main content
Glama

Field Service Business Platform by Doing Work

maintenance_cancelPlan

Cancel a maintenance plan (owner or office). No more renewal invoices. Invoices already sent stay as they are. The plan's open visit due dates are cancelled.

Input Schema

NameRequiredDescriptionDefault
plan_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does disclose concrete downstream effects: renewal invoices stop, already-sent invoices are untouched, and open visit due dates are cancelled. It omits irreversibility/confirmation requirements and what the response looks like, keeping it short of a 5.

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?

Four short sentences, front-loaded with the action, then the consequences in descending importance. Every sentence adds a distinct fact with no filler.

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 one-parameter mutation with no annotations and no output schema, the description covers the important side effects an agent needs before calling it. Missing pieces are the return value shape and whether the cancellation is reversible, both of which matter for a destructive operation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the single plan_id parameter is undocumented in both schema and description; the description never says where the ID comes from (e.g., maintenance_listPlans/getPlan) or what it identifies. The parameter is largely self-evident from its uuid format, so this is a minor gap rather than a severe one.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Specific verb+resource ("Cancel a maintenance plan") with immediate scope of effect, which cleanly separates it from the other maintenance_* siblings (createPlan, getPlan, listPlans, setPrice, setVisits). It does not explicitly name or contrast with a sibling, but none of them is a plausible substitute for cancellation.

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?

"(owner or office)" gives an authorization hint about who may invoke it, which is useful context. However, there is no explicit when-to-use/when-not guidance, no stated prerequisite (e.g., plan must be active, no pending visits), and no mention of an alternative path.

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