sync_memory

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

With no annotations provided, the description carries the full behavioral burden. It discloses that sync is manual and that offline writes are queued and pushed, which is helpful. However, it does not explain what happens on pull (e.g., overwrite vs merge), how conflicts are handled, or any side effects, leaving a notable gap for a sync operation.

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 two concise sentences. The first sentence front-loads the purpose and parameter format, and the second provides usage context. Every word contributes to understanding, with no redundancy or filler.

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 single-parameter tool with an output schema, the description covers the essentials: what it does, when to use it, and the parameter meaning. It doesn't mention prerequisites like GitHub authentication or conflict resolution, but given the tool's simplicity and the presence of an output schema, it's sufficiently complete for correct invocation.

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 schema only defines 'direction' as a string with a default and no description. The description adds meaning by enumerating allowed values ('pull|push|both') and implying their effects through the offline-write context. This compensates for the 0% schema coverage, though it doesn't elaborate on each direction's exact behavior.

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's function: 'Manual sync with GitHub', and specifies the direction parameter values. This distinguishes it from sibling tools like recall or search_memory, which are about retrieval. However, it doesn't explicitly contrast with a specific alternative, so it stops short of a perfect score.

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 provides a concrete use context: 'Useful after working offline' and explains that offline writes are queued locally and pushed. This gives clear guidance on when to invoke the tool. It doesn't mention alternatives for cases where sync isn't needed, but the context is sufficiently explicit.

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