Skip to main content
Glama

List product groups

booqable_list_product_groups
Read-only

List product groups — the catalogue entries (name, SKU, product type, tracking type, pricing). A group holds one or more bookable products (variations). Booqable: GET /api/4/product_groups.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
qNoFree-text search over name/SKU.
tagNoOnly groups carrying this tag.
pageNoPage number (1-based). Default 1.
sortNoSort, comma-separated attributes; prefix with - for descending, e.g. -created_at.
includeNoComma-separated relationships to sideload, e.g. products,photo.
archivedNotrue = only archived, false = only active.
page_sizeNoResults per page, 1-100 (Booqable default 25).
product_typeNoOnly this product type.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds the underlying REST endpoint (GET /api/4/product_groups), which is mild context, but says nothing about pagination limits, default page size behavior, or auth requirements. Adequate but not enriching beyond the annotation.

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?

Three short, front-loaded clauses with no filler: what it lists, the domain definition, and the endpoint. Every sentence earns its place, though the endpoint reference is marginally redundant for an agent that already knows the tool name.

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 read-only list tool with no output schema, the description usefully enumerates the fields a group carries and clarifies the group/product hierarchy. It is missing only filtering/pagination behavior caveats, which is a minor gap given the fully covered schema.

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 eight parameters (q, tag, page, sort, include, archived, page_size, product_type) are already fully documented in the schema. The description adds no parameter-level meaning, so the baseline 3 applies.

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?

States a specific verb+resource ('List product groups') and immediately defines what a group is (catalogue entries with name, SKU, product type, tracking type, pricing). The clause 'A group holds one or more bookable products (variations)' distinguishes it conceptually from the sibling booqable_list_products without the agent needing to open either schema.

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

Usage Guidelines3/5

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

The group-vs-product relationship implies when to reach for this tool, but there is no explicit routing guidance such as 'use booqable_list_products to fetch individual bookable products.' Usage is inferable but not stated, which is the definition of a 3.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.