pushToBridge

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

With no annotations, the description carries the full burden, and it discloses the auth requirement ('REQUIRES signing with privkey'), destructive deletion behavior ('removes files or whole folders'), and the default of allowTreeShrink. It stops short of describing the commit/response behavior, but covers key traits.

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?

Two sentences, front-loaded with core function and auth, followed by optional behavior. No wasted words.

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?

Description covers the essential push, auth, delete, and tree-shrink semantics. It lacks output/return behavior and conflict handling, but with 8 params and no annotations, it gives adequate context for selecting and invoking the tool.

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 baseline is 3. The description emphasizes privkey requirement and clarifies deletedPaths and allowTreeShrink interaction, but most param meaning is already in schema, so limited additional value.

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 'Push files to git server' with a specific verb and resource. It also notes the signing requirement and optional deletion behavior, distinguishing it from read-only sibling tools like bridgeListRefs and getFile.

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?

The description implies usage for pushing files to a git repo and notes the requirement for privkey signing. It does not explicitly exclude alternatives, but the unique 'push' operation among siblings provides clear context. The deletion and tree-shrink behavior gives additional guidance on when to use these options.

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