Push changes to Overleaf

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

Annotations only flag it as non-read-only, destructive, non-idempotent and open-world; the description adds substantial context beyond that: the server re-checks and rebases onto collaborator pushes, conflicting edits are refused with both versions reported and no work lost, and pending commits from an earlier refused push ride along. It also discloses that the effect is immediate and public and that only the chosen project is pushed.

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?

Front-loaded with the core action, then prerequisites, then conflict behavior, then return values. Nearly every sentence carries load, though the multi-clause sentences make it denser than strictly necessary.

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 mutation tool with no output schema, the description covers the essentials: prerequisites (show_diff, compile_project), conflict/refusal semantics, what is preserved on failure, scoping, and the return value ('the new commit hash and the diff that was published, or reports that there was nothing to push'). Nothing an agent needs to invoke it safely is missing.

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 coverage is 100%, so the baseline is 3, but the description adds meaning beyond the schema: commitMessage labels the single commit formed from pending edits, while commits already queued from an earlier refused push keep their own messages and go out with it. It also implies project scoping via 'Only the chosen project is pushed.'

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?

States a specific verb and resource ('Publish every pending local edit to Overleaf as one commit') and explicitly positions itself against siblings with 'the only tool that changes the project collaborators see.' An agent can distinguish it from sync_project, replace_text, and write_file without opening any schema.

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?

Names prerequisites and ordering explicitly: 'Call show_diff first, and compile_project when the edit could break the build.' It also describes the conflict outcome that tells the agent when a push will be refused, giving both when-to-use and what-happens-next guidance.

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