Skip to main content
Glama
Lightspeed X-Series MCP

Lightspeed X-Series MCP

by davidboulay

get_product_family

Read-onlyIdempotent

Retrieve a product's variant family: family details, brand, category, tags, and one compact line per variant with ID, name, SKU, price, and active status.

Instructions

The variant family a product belongs to (every colour/size of one item): family details, brand/category/tag names and one compact line per variant (id, variant name, SKU, retail price, active). full=True returns the raw API object (can be very large).

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": {
      "product_id": "<product_id>"
    },
    "name": "get_product_family"
  }
}

Input Schema

NameRequiredDescriptionDefault
fullNo
product_idYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already declare this as a read-only, idempotent, non-destructive operation, and the description adds useful behavioral context by explaining that full=True returns the raw API object and can be very large. It does not mention permissions or rate limits, but the important output-size caveat is clearly disclosed.

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 definition is front-loaded and appropriately sized, with no redundant sentences. The first sentence is dense but still organized around the returned family structure and variant fields.

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?

Given the output schema exists and annotations cover safety, the description supplies enough context about the default compact response and the full raw-object option. The main remaining gap is routing guidance against sibling product-retrieval tools.

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 0%, so the description must carry parameter meaning. It explains the full parameter well, including the raw-object and large-output behavior, but product_id is only inferable from the tool name and is not described in terms of expected format or source.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly identifies the resource as the variant family for one product, including what family details and variant lines are returned. It does not explicitly differentiate itself from sibling tools such as get_product or search_products, so it falls short of a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explains the default compact output and the full=True raw API object behavior, but it gives no guidance on when to use this tool versus get_product, search_products, or list_products. No exclusions or alternative-selection conditions are provided.

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