sync_offline_catalog

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

Without annotations, the description must disclose behavioral traits, but it only says 'write' a catalog, lacking details on file creation, side effects, or required permissions. It doesn't mention whether it modifies the project or what happens to existing catalogs.

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 concise but under-specified, lacking necessary details for a tool with two parameters and no schema coverage. It's not wastefully verbose, but it's too brief to be helpful.

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?

With no annotations, no output schema, and 0% schema parameter coverage, the description must provide context, but it only offers a vague phrase. It fails to explain what the catalog contains, how 'root' is used, or the behavior of 'refresh', making the tool difficult to use 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?

Schema coverage is 0%, and the description does not explain the 'root' or 'refresh' parameters. The description adds no meaning beyond the parameter names themselves.

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 the tool writes a project-local catalog of icon names for offline lookup, which is a specific action. It distinguishes from sibling tools like import_icon or search_icons by focusing on creating a local catalog for offline access. However, it doesn't clarify the catalog's exact format or location.

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 mentions the use case for offline or repeat lookup, implying when it's useful, but doesn't explicitly contrast with alternatives like search_icons or import_icon. There's no guidance on when not to use it.

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