Skip to main content
Glama

Get a plan

get_plan
Read-only

Retrieve a saved Shopify sync plan by ID to review operations, warnings, and apply status, or list recent plans to find the one you need.

Instructions

Show a sync plan made by plan_sync, before or after it is applied. With plan_id: the plan as plan_sync returned it (totals, ops with field changes, warnings, expiry) plus, once applied, the apply's state and totals; only the first 200 ops are listed and long values are shortened unless full=true, and format="markdown" gives a report to share for review. Without plan_id: the 20 most recent plans (plan_id, createdAt, status, source, target, op count), to find one. To create a plan use plan_sync, to write it use apply_plan, and to follow a running apply use apply_status. Reads only the plans saved by this server, nothing from Shopify.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_plan"
  }
}

Input Schema

NameRequiredDescriptionDefault
fullNoList every op with full values (default: first 200 ops, long values shortened).
formatNo"markdown" returns the plan as a report, to share before applying it.
plan_idNoThe plan to show, as returned by plan_sync. Omit to list the recent plans.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.11.6
    • changedInput schema / properties / full / description
      Previous value: -"Return every op, untruncated."New value: +"List every op with full values (default: first 200 ops, long values shortened)."
    • addedInput schema / properties / plan_id / description
      Added value: +"The plan to show, as returned by plan_sync. Omit to list the recent plans."
  2. Changed1 schema field changedv0.11.4
    • addedInput schema / properties / format
      Added value: +{
      +  "description": "\"markdown\" returns the plan as a report, to share before applying it.",
      +  "enum": [
      +    "json",
      +    "markdown"
      +  ],
      +  "type": "string"
      +}
  3. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, but the description adds real context beyond them: truncation of ops and long values, expiry and warnings in the payload, the post-apply state, and markdown output intended for human review. The closing note that it reads only plans saved by this server and nothing from Shopify is a genuinely useful scope boundary. It stops short of describing rate limits or paging beyond the 200-op cap.

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 parallel "With plan_id / Without plan_id" framing front-loads the branching logic, and the trailing routing sentence is dense but earns its place. It is a single long block with parenthetical asides that could be broken into shorter sentences for faster scanning.

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?

There is no output schema, so the description carries the return-value burden itself, and it does: totals, ops with field changes, warnings, expiry, and applied-state totals. Combined with the sibling routing and the scope caveat, an agent has everything needed to call this correctly.

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 coverage is 100%, and each schema property description already states what full, format, and plan_id do, so the description is largely restating structured data. It adds some meaning by explaining what the no-plan_id list contains (plan_id, createdAt, status, source, target, op count), but that is return-value detail rather than parameter semantics. Baseline 3 applies.

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?

"Show a sync plan made by plan_sync, before or after it is applied" gives a specific verb, resource, and the two operating modes. The description then splits the behavior on the presence or absence of plan_id, so an agent knows exactly which shape of result it will get.

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

Usage Guidelines5/5

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

It routes explicitly to siblings: plan_sync to create, apply_plan to write, apply_status to follow a running apply, and "only the first 200 ops... unless full=true" for volume. It also states the selection rule between the two modes (omit plan_id to browse the 20 most recent plans).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.