Skip to main content
Glama

beaconed_products_create

Create products in Beaconed from external non-Shopify data. Use external_id to prevent duplicate entries.

Instructions

POST /api/v1/products — create a product from external (non-Shopify) data. Use external_id for idempotency.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
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.2/5.0
Behavior4/5

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

Given the annotations only mark idempotentHint=false and destructiveHint=false, the description adds meaningful behavioral context by directing callers to use external_id for idempotency. This clarifies a critical duplicate-prevention behavior without directly contradicting the idempotentHint annotation, since the idempotency is conditional on providing external_id.

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?

The description is two short sentences with no filler: it states the endpoint, the purpose, and the most important invocation tip. The key idempotency guidance is front-loaded and immediately actionable.

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 create tool with 13 optional parameters and no output schema, the description covers the essential selection and invocation context: what is created, from what source, and how to avoid duplicates. It does not describe the return value or behavior on duplicate external_id, but the parameter schema handles most remaining detail.

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%, so all 13 parameters are already documented with descriptions. The only description-level parameter guidance, 'Use external_id for idempotency,' largely repeats what the schema's external_id description already states, so it adds little semantic value beyond the 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?

The description names the specific verb (create), resource (product), and scope (external, non-Shopify data), which clearly separates it from sibling tools like beaconed_products_update and beaconed_products_sync. It also includes the exact endpoint, leaving no ambiguity about what operation is performed.

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 phrase 'from external (non-Shopify) data' gives clear context for when this tool is appropriate, distinguishing it from Shopify-related flows. It does not explicitly list exclusions or name alternatives, so it stops just short of full routing guidance.

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