Project status

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

Discloses behavior well beyond the readOnlyHint/openWorldHint annotations: the call performs a pull, that pull only updates the local clone, nothing changes on Overleaf, no local edit is dropped, a conflicting pull does not fail but adds a WARNING and leaves the clone unchanged, and first-time projects get an initial clone so the first report shows nothing pulled. These are exactly the non-obvious side effects an agent must know before calling.

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-loads the purpose and the report contents, then layers usage, side effects, conflict handling, and return format with no filler sentences. Each clause carries distinct information an agent needs.

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?

With no output schema, the description still describes the return shape ('plain name: value lines'), and it covers the pull side effect, conflict outcome, and cold-start clone case. An agent has everything needed to call it correctly and interpret the result.

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 100% and the single 'project' parameter already documents the accepted forms (Overleaf address, 24-character id, registered name, omit for default). The description adds no parameter-level detail, so the baseline 3 applies; the first-time-clone note is behavioral, not parameter semantics.

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 ('Report where one project's local clone stands against Overleaf') and enumerates the exact contents of the report: branch and head commit, pulled commits, unmerged commits, unpushed local commits, uncommitted edits, and the last ten commits. It is clearly distinguishable from siblings and even names show_diff as the tool for reading pending edits themselves.

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?

Gives an explicit trigger ('Call it to learn whether there is anything to push or anything new from a collaborator') and routes the adjacent need to a named alternative ('use show_diff to read the pending edits themselves'). The only thing not spelled out is an outright when-not case, but the alternative tool covers the main ambiguity.

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