get_shadcn_registry

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

With no annotations, the description carries full burden and discloses the returned structure ($schema, name, homepage, items[] with details) and a special mapping rule (tokens map to registry:theme). This provides solid behavioral insight beyond the schema, though it could mention side effects or permissions.

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 three well-structured sentences with no redundancy. The first sentence states the core purpose, the second lists return fields, and the third references a sibling tool. Every sentence is necessary and front-loaded.

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?

Given no output schema and no annotations, the description covers the tool's purpose, output structure, and a sibling link. It lacks explicit prerequisites (e.g., workspace must have component specs) but is otherwise sufficient for a straightforward tool.

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 coverage is 100%, but the description adds value by explaining the purpose of each parameter: 'name' as the registry name to embed and 'homepage' used for generating /r/*.json and Open-in-v0 metadata. This goes beyond the schema's brief descriptions.

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 tool builds a 'shadcn registry.json-compatible index' from the workspace, with a specific verb and resource. It also distinguishes itself from the sibling 'get_registry_item' by noting the latter handles single items.

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 usage for building a full registry index and explicitly references an alternative for single items ('For a single item use get_registry_item'). However, it does not fully specify when not to use it or provide more detailed usage context.

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