Skip to main content
Glama
Sign In

Checkbox

by site.checkbox
OverviewDiscussionsAdmin

Publish renewal terms to the Shopify app block (write)

publish_shopify_terms
Idempotent

WRITE (admin key). Shopify store linked through the Checkbox Shopify app (get_site_status: shopify.connection "app"): publishes the engine-verified renewal terms + consent label for the site's real plan to the Checkbox app block. Read-only on the store except that app-owned metafield (no theme/product/checkout edits); safe to repeat. The merchant still places the "Renewal terms + consent" block once: give them theme_editor_url from the result. Then verify_site. shopify_not_connected: only the merchant can install the app in Shopify and click "Connect to Checkbox". terms_incomplete: follow next_action.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "site": "<site>"
    },
    "name": "publish_shopify_terms"
  }
}

Input Schema

NameRequiredDescriptionDefault
planNoPlan / price id (default: detected).
siteYesSite id (site_…); list_sites shows them.
cancel_urlNoCancellation URL to state (default: detected).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.1/5.0
Behavior4/5

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

Beyond the annotations it adds real behavioral context: admin-key requirement, that the write is limited to an app-owned metafield with no theme/product/checkout edits, and that the merchant must still manually place the block. It also enumerates error states and recovery actions. The 'safe to repeat' clause largely restates idempotentHint=true, which keeps it from 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.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The write/admin-key constraint is front-loaded in the first two words, and the prerequisite, side-effect, and error-handling information follow in a logical order with no filler sentences. The dense parenthetical style (nested quotes, inline tool references) costs a little readability.

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?

There is no output schema, yet the description discloses the key return value an agent must act on (theme_editor_url) plus the next_action field for the incomplete-terms case. Combined with the prerequisite check and the manual merchant step, it covers everything needed to invoke and follow up correctly; only the broader response shape is left implicit.

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 100%, so all three parameters are already documented, including the 'default: detected' behavior for plan and cancel_url. The description only alludes to 'the site's real plan' without adding format, syntax, or resolution-order detail beyond the schema. Baseline 3 is appropriate when the schema carries the parameter burden.

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 opens with a specific verb and resource: it publishes engine-verified renewal terms and a consent label into the Checkbox Shopify app block. It scopes the write precisely (only the app-owned metafield) and names the differentiating follow-up tools (verify_site, get_site_status), so an agent can distinguish it from siblings like verify_site or update_site without opening a 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 states the prerequisite condition clearly (the store must be linked via the Checkbox Shopify app, checked with get_site_status and shopify.connection "app") and gives the post-call path: hand the merchant theme_editor_url, then call verify_site. It also routes two named failure states (shopify_not_connected, terms_incomplete) to their remedies. The only gap is that it never states when *not* to call this instead of another tool.

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

All Checkbox toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources