Skip to main content
Glama

HALO Homebridge AI Surfaces

Get an approved Homebridge offer

get_approved_homebridge_offer
Idempotent

Retrieve one enabled exact Homebridge offer by SKU. Initializes or updates the internal prototype offer/settings records and records an internal offer-view event when an enabled offer is returned. Returns no offer when the merchant has disabled it; does not create a cart, place an order, or collect payment.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
skuYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
nameYes
variantYes
categoryYes
quantityYes
availabilityYes
displayPriceYes
purchaseModeYes
configurationYes
checkoutActionYes
requiredDisclosuresYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior1/5

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

The description discloses hidden side effects (initializing/updating internal records and recording an offer-view event) and exclusions (no cart, order, or payment), but it contradicts the idempotentHint annotation. Recording an event on each call suggests repeated identical calls produce additional effects, which conflicts with idempotency. This is an annotation contradiction.

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 compact, using two sentences to cover retrieval, side effects, and exclusions. It is well-structured and front-loads the primary purpose without unnecessary verbosity.

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?

The description covers side effects, disabled-offer behavior, and excluded operations, while the output schema is available for return details. It lacks explicit error scenarios and SKU acquisition context, but for a simple single-parameter read-like tool, it is reasonably complete.

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?

The description maps the single 'sku' parameter to the offer being retrieved, and the schema defines its type and length. It does not add significant detail about SKU format, source, or validation rules, but the parameter is simple and the description provides basic meaning.

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 tool retrieves one enabled exact Homebridge offer by SKU, using a specific verb and resource. It distinguishes itself from sibling tools like catalog, variant, and checkout tools by emphasizing 'exact' and 'enabled' offer retrieval and explicitly excluding cart/order/payment actions.

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 description implies usage for fetching a single exact offer by SKU, but it does not explicitly state when to prefer this tool over siblings such as resolve_homebridge_major_variant or get_homebridge_major_category_catalog. It lacks direct when-to-use/when-not-to-use guidance.

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.

Resources