Skip to main content
Glama

contribos_check

Review your local branch against repo rules and history before submitting: check scope, tests, changelog, AI policy, and explanation coverage to avoid common contribution issues.

Instructions

Pre-submit review of the local branch against the repo's rules and history: scope versus similar past changes, tests, changelog, sign-off, debug leftovers, AI policy, and whether the contributor's own explanation covers the change, AI-disclosure trailers, competing PRs, and (with verify_test) whether the test fails without the fix. Do not write the explanation for the user.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
baseNobranch the work started from (default: auto-detect)
pathNolocal checkout.
issueNoissue number, to look for competing PRs
ai_noteNohow AI was used, e.g. 'Claude Code: drafted the test'
explanationNothe contributor's own explanation, as text
verify_testNotest command to run with and without the fix
explain_fileNoor a file holding it

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations the description carries the full burden, and it does disclose real behavior: the enumerated check domains, the conditional verify_test behavior ('whether the test fails without the fix'), and a constraint on the agent's own output. It never states whether the tool is read-only, whether it mutates the checkout, or how failures surface, which leaves notable gaps.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Purpose is front-loaded, but the body is one long comma-chained sentence listing a dozen checks, which is hard to scan. Every clause is substantive, yet the structure is a run-on rather than a prioritized list.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 7-parameter tool with no output schema and no annotations, the description covers the check surface well but omits return shape, side effects, and safety profile. It is adequate to call the tool, but an agent cannot predict what it gets back or whether the working tree is touched.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

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 by tying parameters to intent: issue maps to 'competing PRs', verify_test to the fail-without-fix check, ai_note/explanation to AI-disclosure and contributor-explanation evaluation. Only 'path' and 'base' are left purely to the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource: a pre-submit review of the local branch against the repo's rules and history. It enumerates the checks concretely (scope, tests, changelog, sign-off, AI policy, competing PRs), so an agent knows what the tool does. It does not, however, differentiate itself from the sibling contribos_review.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'Pre-submit review' implies the moment to use it, and 'Do not write the explanation for the user' is a useful boundary. But no alternative is named and neither contribos_review nor contribos_brief is contrasted, so the agent must infer which sibling applies.

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