sync_to_github

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

With no annotations, the description carries the full burden. It does disclose that this is a mutating, remote-publishing operation and that configuration has no default (so a misconfigured call will fail). It omits auth requirements, whether a branch is created, and any reversibility/force-push semantics.

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 short sentences, front-loaded with the action and followed by the configuration sourcing. No filler, though the second sentence is split rather awkwardly across lines.

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?

An output schema exists, so return values need not be described. For a mutation tool with no annotations, the description covers the config-sourcing prerequisite but leaves auth, branch behavior, and failure semantics unstated – adequate but with clear gaps.

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%, so the description must compensate. It addresses only `remote` (and partially, via the env-var fallback) while `branch` and `message` are left entirely undocumented in both schema and prose, leaving two of three parameters semantically undefined.

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 clear effect chain – snapshot, commit, push to the operator's own repository – with a specific resource (GitHub repo). It does not, however, distinguish itself from the sibling sync_snapshot, which an agent might reasonably confuse it with.

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 explains the prerequisites for use (target from `remote`/ZYXEL_SYNC_REMOTE, directory from ZYXEL_SYNC_DIR, no built-in defaults), which is genuinely useful context. But it never says when to pick this over alternatives such as sync_snapshot or backup_config, so usage is only implied.

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