snippets_sync

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

With annotations already declaring readOnlyHint=false and destructiveHint=false, the description adds the important side effect that nodes using affected config profiles will be restarted. This is a significant behavioral disclosure beyond the structured annotations, though it does not cover timing or reversibility.

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 front-loaded and short, but the first two sentences are largely redundant: 'Sync snippet to affected config profiles' and 'Trigger the sync of a snippet to all config profiles that reference it' say the same thing. The third sentence adds necessary value.

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 one-parameter sync operation with no output schema and annotations covering safety, the description is nearly complete: it states the action, its scope, and the node-restart side effect. The main omission is any explanation of the required 'name' parameter or sync timing.

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 0% for the single required parameter 'name'. The description implies the parameter identifies a snippet but does not clarify the expected format, naming rules, or what name refers to beyond that implication.

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 verb ('sync') and resource ('snippet to affected config profiles'), and explains the effect on nodes. It is clear what the tool does, but it does not distinguish itself from sibling sync actions such as shared_lists_sync or node_plugins_sync.

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 describes what the tool does but gives no explicit guidance on when to use it versus alternatives. There is no mention of prerequisites, exclusions, or related tools like snippets_update or shared_lists_sync.

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