Skip to main content
Glama

sb_api_call

Destructive

Execute Store Builder API operations by operation ID or custom route, with dry-run safety and response shaping through field selection, list capping, and offset.

Instructions

Call an operation from sb_api_find (id), or a route the catalog lacks (method+path); dry run by default. pick selects fields, max_items caps lists, item_offset skips items. Lists over 60 KB say so.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoOperation id from sb_api_find, e.g. "get:/api/sites/{siteID}/menus"
bodyNo
pathNoBare platform path, e.g. "/api/sites/{siteId}/published"; {siteId} defaults to SB_SITE
pickNo
queryNo
methodNoWith path, when id is absent: GET|HEAD|POST|PUT|PATCH|DELETE
dry_runNoDefaults to true. Pass false to actually send.
max_itemsNo
item_offsetNoOffset within this response, after API paging. Reads only.
path_paramsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.63.0
    • addedInput schema / properties / item_offset
      Added value: +{
      +  "description": "Offset within this response, after API paging. Reads only.",
      +  "minimum": 0,
      +  "type": "integer"
      +}
    • addedInput schema / properties / method
      Added value: +{
      +  "description": "With path, when id is absent: GET|HEAD|POST|PUT|PATCH|DELETE",
      +  "type": "string"
      +}
    • addedInput schema / properties / path
      Added value: +{
      +  "description": "Bare platform path, e.g. \"/api/sites/{siteId}/published\"; {siteId} defaults to SB_SITE",
      +  "type": "string"
      +}
    • removedInput schema / required
      Removed value: -[
      -  "id"
      -]
  2. First observedv0.1.4

TDQS

A4.3/5.0
Behavior4/5

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

The description adds 'dry run by default' which is crucial context given destructiveHint=true, and the note about lists over 60 KB is a useful behavioral quirk. It goes beyond the annotations by clarifying the default safety behavior. However, it doesn't describe what happens when dry_run is false (actual side effects) or how openWorldHint affects external systems, so it's not fully transparent.

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, front-loaded with the core purpose and the dry-run default, followed by a compact explanation of the key parameters. Every sentence serves a purpose and there is no redundancy or filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with 10 parameters and no output schema, the description is relatively short. It covers the primary decision (id vs method+path) and the dry-run default, but omits guidance on query, body, path_params, and how they interact. The 60 KB note is a minor quirk, not a comprehensive description of response behavior. While essential information is present, the overall completeness for such a complex tool is only adequate.

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?

The description explains pick (field selection), max_items (capitalization), item_offset (item skipping), and the id vs method+path distinction. This adds value especially for pick and max_items which lack schema descriptions. With only 50% schema coverage, the description compensates for some but not all parameters; query, body, and path_params are left unexplained, which is a gap but not severe given the tool's general purpose.

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 clearly states the two modes of operation: using an operation id from sb_api_find, or providing a method+path for routes the catalog lacks. This distinguishes it from the sibling sb_api_find and other tools, and the specific phrasing leaves no ambiguity about what the tool does.

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 explicitly explains when to use id (when you have an operation from sb_api_find) and when to use method+path (routes the catalog lacks). This gives clear decision context. However, it doesn't explicitly mention alternatives or say when not to use this tool (e.g., for other operations that belong to different siblings), so it misses the exclusionary guidance that would earn a 5.

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