Skip to main content
Glama

beaconed_products_update

Idempotent

Update specific fields of an existing Beaconed product by ID. Send only the fields you want to change, such as title, status, tags, or SEO metadata.

Instructions

PATCH /api/v1/products/{id} — update a product's fields. Only include fields you want to change.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesProduct UUID
tagsNoComma-separated product tags
titleNoProduct title
handleNoURL-friendly product handle
imagesNoProduct images
statusNoProduct status
vendorNoVendor / brand name
og_titleNoOpen Graph title for social media
meta_titleNoSEO meta title
descriptionNoProduct description (HTML)
external_idNoYour system product ID — used for idempotency on create
product_typeNoProduct type / category
og_descriptionNoOpen Graph description for social media
meta_descriptionNoSEO meta description

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.0.3

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare idempotentHint=true and destructiveHint=false, so the safety profile is covered. The description adds the partial-update behavior ('Only include fields you want to change'), which is valuable beyond annotations but not extensive.

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 zero waste; the core purpose and usage guidance are front-loaded. Every word 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?

Complete for a simple update tool: schema covers all parameters, annotations cover idempotence and non-destructiveness, and the description clarifies partial-update semantics. No output schema is needed since return value is not specified.

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% with descriptions for all 14 fields, so the schema does the heavy lifting. The description adds a general partial-update principle but no specific parameter details beyond schema.

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?

Description states a clear action (update), the resource (product fields), and the PATCH method, distinguishing it from create/list/sync siblings. The partial-update instruction further clarifies scope.

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 provides clear context that this tool updates an existing product's fields and explicitly instructs to include only changed fields. It does not explicitly name alternatives or when not to use, but the partial-update guidance strongly implies usage intent.

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