Get product
bsale_get_productOne product by id; expand=[product_type] adds the type. GET /v1/products/{id}.json.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| expand | No | ||
| product_id | Yes |
bsale_get_productOne product by id; expand=[product_type] adds the type. GET /v1/products/{id}.json.
| Name | Required | Description | Default |
|---|---|---|---|
| expand | No | ||
| product_id | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, openWorldHint=true, and destructiveHint=false, so the safety profile is covered. The description adds the endpoint and the effect of expand, but does not mention error behavior, authentication needs, or response format.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is short and front-loaded: it states the core retrieval, then the expand behavior, then the endpoint. Every clause adds useful information with no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple read operation, the description covers the basic purpose and one optional parameter. However, with no output schema and 0% schema description coverage, it leaves gaps around product fields returned and full expand parameter semantics.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
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 identifies the id-based lookup and explains that expand=[product_type] adds the product type, but it does not name product_id directly, document the array constraints, or list other valid expand values.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific retrieval action for a product by id, which clearly distinguishes it from list-style siblings such as bsale_list_products. It could more explicitly contrast with bsale_get_variant or name the tool's role, but the resource and scope are clear.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The phrase 'by id' implies when to use this tool, and the expand note gives a usage hint. However, it does not explicitly state when to use it instead of bsale_list_products or bsale_get_variant, nor does it mention prerequisites.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.