sublime_sync

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

With no annotations, the description carries the full burden. It discloses the main behavior (git pull, re-index), mentions the return value (count of rules, parse errors), and hints at a possible cooldown via the force parameter. However, it does not clarify whether the operation is additive or destructive, whether it requires special permissions, or what happens on failure beyond parse errors.

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?

Three concise sentences with no fluff: what it does, when to use it, and what it returns. The information is front-loaded and every sentence earns its place.

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 single-optional-parameter tool with no output schema, the description covers the essential invocation context: action, use case, and return value. It could be slightly more complete about error handling and side effects, but nothing critical is missing for basic usage.

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 description coverage is 100%, so the only parameter (force) is already documented in the schema. The description adds no additional meaning about the parameter, which is acceptable because the schema covers it fully.

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 a specific action ('Sync the Sublime Security rules repository') and a clear consequence ('re-index all rules into the detection database'). It is clearly distinct from sibling tools like sublime_search, sublime_get_rule, and sublime_get_stats, which serve different purposes.

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?

It explicitly says when to use it: 'Run this to pick up newly published rules.' It does not explicitly name alternatives or state when not to use it, but the sibling context makes the intended use clear.

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