lookup-vtex-api

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

With no annotations provided, the description carries the burden of behavioral disclosure. It does disclose that the tool returns endpoints, auth details, and request/response models, which adds meaningful detail. However, it does not mention output format, whether external network access is involved, or any rate limiting or failure behavior.

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 core purpose and then provides the list of supported APIs. Every part earns its place, with no filler or redundancy.

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 single-parameter lookup tool with no output schema, the description adequately explains what the tool returns and the scope of APIs it supports. It could be more complete by noting the expected response format or when it should be preferred over concept/search siblings, but it is sufficient for an agent to invoke it correctly.

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 already describes the single 'api' parameter with 100% coverage, including examples. The description mostly repeats the same API-name list, adding little semantic meaning beyond the schema. The baseline of 3 applies because the schema does the heavy lifting.

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 clearly states the action ('Look up VTEX REST API reference') and the resource (VTEX REST API reference), enumerating the specific API domains covered. This makes it immediately distinguishable from sibling tools like lookup-block-props, scaffold-vtex-app, and search-concepts.

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 description implies the tool is for looking up VTEX API reference information, but it does not explicitly say when to use this tool versus alternatives like search-concepts or explain-concept. There are no exclusions or when-not-to-use conditions, so usage guidance is only implied.

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