Push staged files to git by reference (Large-PR Room)

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

With no annotations, the description carries the full burden and does real work: it discloses the underlying mechanism (Git Data API blobs/tree/commit/ref), the 'Any file size' capability, the branch auto-creation fallback, and crucially the retention side-effect ('Staged rows are kept after the push (retention), never deleted'). It omits auth/permission requirements and error behavior, so it is strong but not complete.

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?

Four compact sentences, each carrying distinct information (mechanism, capacity, branch logic, retention), with the core action front-loaded. No filler or repetition of the title.

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 6-parameter mutation tool with no annotations and no output schema, the description covers mechanism, branch creation, and the retention side-effect that an agent most needs to know. It does not describe the return/response or required permissions, leaving a modest gap but a usable definition overall.

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%, so the baseline is 3; the description adds meaning beyond the schema by explaining base_branch's fallback semantics ('Creates the branch off base_branch (or the default branch) when it does not exist') and tying workspace_id to prior staging plus post-push retention.

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 ('Assemble... write them to a branch') and resource ('files staged in the workspace', 'GitHub Git Data API'), so the agent knows this pushes staged files to git. It does not, however, name or distinguish itself from the closest siblings (workspace_put, workspace_list), so differentiation is inferred rather than stated.

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?

Usage is implied rather than stated: 'files staged in the workspace' tells the agent staging (workspace_put) must precede this, and the base_branch wording explains the create-if-absent case. There is no explicit when-to-use / when-not-to-use guidance or named alternative, so it stops at implied context.

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