sync_knowledge_now

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

No annotations are provided, so the description should disclose behavioral traits beyond a simple mutation indication. It labels itself as [mutation] but does not detail side effects, permissions needed, or potential impacts (e.g., performance). This is insufficient for a mutation tool without annotations.

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 extremely concise: a single phrase that conveys the purpose and key action. No redundant information, every word serves a purpose.

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 parameters and no output schema, the description covers the essential information: what it does, that it's a manual override, and that it's a mutation. It lacks some context like prerequisites or result expectations, but overall it is fairly complete for a simple 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?

The tool has zero parameters with full schema coverage. According to guidelines, baseline is 4. The description adds no parameter-level detail but that is compensated by the absence of parameters.

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 verb 'sync' and the resource 'learned facts to Vector Store', with a specific action of forcing immediate synchronization. It distinguishes from other sibling knowledge tools like get_knowledge_processing_status or update_knowledge_file.

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 that sync normally happens automatically, implying use when immediate sync is desired. However, it does not provide explicit guidance on when not to use or compare to alternatives, leaving usage context implied rather than explicit.

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