auditRepoDependencies

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

With no annotations, the description carries the burden itself and does reveal meaningful behavior: it scans manifests, performs an external POST to OSV, and bypasses the audit UI flag. However, it does not state whether the operation is read-only, what authentication or permissions are required, or what the response contains.

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 deliver the action, target, endpoint, UI parity, and a prerequisite edge case with no filler. The core scanning/audit behavior is front-loaded before secondary orientation.

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?

The tool is moderately complex with four optional-looking parameters and no output schema or annotations. The description gives a clear purpose but omits repoId/ownerPubkey semantics and any return or side-effect expectations, so an agent would need to infer important invocation details.

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 only 50%: branch and packages have descriptions, while repoId and ownerPubkey do not. The description does not compensate for the undocumented identifiers, leaving the key repo reference and possible auth parameter under-specified.

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?

Description uses a specific verb ('Scan') with a concrete resource ('gittr bridge repo’s manifests'), lists example manifest files, and names the exact OSV endpoint. It also anchors the tool's role to the Dependencies tab, giving an agent enough to distinguish it from the many repo/file sibling tools.

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 'Same data as the gittr Dependencies tab' line supplies clear context for when this tool is relevant, and 'Does not require the website audit UI flag' removes a likely prerequisite. It doesn't explicitly name an alternative or a when-not-to-use case, but no sibling appears to provide the same audit capability.

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