Retrieve props, descriptions, and usage examples for any VTEX IO Store Framework block. Get the block details you need to configure it correctly.
Look up the props, description, and usage examples for any VTEX IO Store Framework block (e.g. rich-text, flex-layout.row, shelf, image, info-card)
| Name | Required | Description | Default |
|---|---|---|---|
| blockName | Yes | Name of the VTEX IO block to look up (e.g. "rich-text", "flex-layout.row", "shelf", "image") |
Changes observed during successful MCP inspections.
v0.1.5Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
There are no annotations, so the description must carry the full burden of behavioral disclosure. It implies a read-only operation through the verb 'look up,' but it does not explicitly state that it is non-mutating, requires no special permissions, or has no side effects. The description does not contradict any annotations (none exist), but it leaves safety details to inference.
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 a single, front-loaded sentence that states the action and object immediately. It includes useful examples without padding. Every word earns its place, and it avoids redundancy with the schema.
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 lookup tool with one parameter and no output schema, the description adequately conveys the type of information returned (props, description, usage examples). It does not describe the output structure or format, but for this purpose the content is likely sufficient. A minor gap is the lack of clarification on whether the output is a JSON object or free text.
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?
The schema description coverage is 100% and the blockName parameter already includes examples in its description. The tool description adds no additional parameter semantics beyond the examples already present in the schema. It neither clarifies formatting, constraints, nor edge cases, so it stays at the baseline.
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 uses a specific verb ('Look up') and a clear resource ('props, description, and usage examples for any VTEX IO Store Framework block'), with concrete examples. This distinguishes it from sibling tools like lookup-vtex-api, which targets API endpoints rather than store framework blocks, even though that differentiation is not explicit.
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?
No guidance is given on when to use this tool versus alternatives. The description does not mention when not to use it, nor does it reference the sibling lookup-vtex-api or other tools. An agent must infer the appropriate context from the name and examples alone, which is insufficient given the sibling set.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.