Skip to main content
Glama

Read the AI Shelf

read_ai_shelf
Read-onlyIdempotent

Read how AI answers recommend products for an ecommerce project: which products and merchants hold the "shelf" when buyers ask for a product category. Call it first with no target to get the catalog: categories with product counts, and up to 200 products with their category ids (products_omitted counts the rest). Then call it again with target_kind and target_id for one category or product: product visibility, share of shelf, average position, first-position win rate, the answer counts they rest on, when it was measured, and the holders (your products, competitors, merchants) with their best rank. unavailable no_product_catalog means the project has no product catalog, which is normal for non-ecommerce brands; use read_visibility_overview for brand mentions instead.

Input Schema

NameRequiredDescriptionDefault
target_idNoA category or product id from the catalog this tool returns without a target; pass together with target_kind.
project_idYesA project id that list_projects returned.
target_kindNoPass together with target_id: whether it names a category or a product.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / properties / project_id / description
      Added value: +"A project id that list_projects returned."
    • addedInput schema / properties / target_id / description
      Added value: +"A category or product id from the catalog this tool returns without a target; pass together with target_kind."
    • addedInput schema / properties / target_kind / description
      Added value: +"Pass together with target_id: whether it names a category or a product."
  2. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already declare this as a safe, read-only, idempotent, closed-world tool. The description adds substantial behavioral context beyond that: the two-step catalog/target workflow, return fields such as share of shelf and first-position win rate, product omission counts, and the meaning of the no_product_catalog error.

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 description is front-loaded with purpose and then explains the two call modes and error case. It is dense but every sentence contributes useful information; it could be slightly more scannable, but there is no wasted filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema, so the description carries the burden of explaining return values. It does so thoroughly for both the no-target catalog call and the targeted call, including metrics, holders, measurement timing, and an error semantic, making it complete for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema already documents all three parameters. The description still adds useful semantics by explaining that target_id should come from the catalog returned without a target and that target_kind/target_id must be passed together, though it does not add much beyond the schema for project_id.

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 states a specific verb and resource: reading AI answer shelf recommendations for products and merchants in an ecommerce project. It clearly separates this from related visibility tools by naming read_visibility_overview for brand mentions, so an agent can distinguish it from siblings.

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

Usage Guidelines5/5

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

It gives explicit sequencing: call first with no target to get the catalog, then call again with target_kind and target_id for a category or product. It also states the alternative for non-ecommerce brands when no_product_catalog is unavailable, which is exactly the when-not guidance an agent needs.

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