Skip to main content
Glama

Create Shopify Portfolio Snapshot

shopify_portfolio_snapshot
Read-onlyIdempotent

Capture a read-only portfolio snapshot across selected or all configured Shopify stores, with shop identity and product, order, customer, and location counts where permissions allow.

Instructions

Create a read-only operating snapshot across selected stores or every configured store. Includes shop identity and product, order, customer, and location counts when scopes permit.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
storesNoStores to include. Omit this field to include every configured store.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.6.0
    • changedInput schema / properties / stores / maxItems
      Previous value: -10New value: +100
  2. First observedv1.2.0

TDQS

A4.2/5.0
Behavior4/5

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

The annotations already declare readOnlyHint, idempotentHint, openWorldHint, and non-destructive behavior. The description adds valuable context beyond annotations by noting the snapshot is read-only and that counts are included only 'when scopes permit,' which warns the agent about conditional output depending on authorization. No contradiction exists.

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?

Two sentences with no filler. The first sentence establishes the core action and scope, and the second sentence states the snapshot contents and the key scoping caveat. Every sentence earns its place.

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 simple tool with one optional parameter and comprehensive annotations, the description is largely complete. It explains what the output-like snapshot contains and notes the permission sensitivity of the counts. It doesn't describe the exact return format or error behavior, but those are not required given the low complexity and the absence of an output schema.

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?

The input schema already fully documents the single 'stores' parameter, including the omission behavior. The description mentions selected or every configured store, but adds no additional semantic detail about parameter format, aliases, or constraints beyond what the schema provides. Baseline 3 is appropriate because schema coverage is 100%.

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 uses a specific verb and resource: 'Create a read-only operating snapshot' across stores, and elaborates exactly what the snapshot includes (shop identity and product, order, customer, and location counts). This clearly distinguishes it from narrower sibling report tools like shopify_low_stock_report or shopify_catalog_health.

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?

The description clearly indicates this tool is for a portfolio-level overview across selected stores or all configured stores. It doesn't explicitly name sibling alternatives or state when not to use it, but the scope is unambiguous enough for an agent to select it appropriately among the many report-style siblings.

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