Identify failing hygiene checks in a local repository to reveal specific gaps in README, license, package description, TypeScript config, tests, and GitHub Actions.
Return only the failing hygiene checks for a local repository.
| Name | Required | Description | Default |
|---|---|---|---|
| root | Yes | Absolute path to the repository root |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the burden of behavioral disclosure. It states the tool returns only failing checks, which implies filtering behavior, but it does not disclose whether the tool performs any analysis, requires network access, or has side effects. The filtering behavior is a useful addition, but more context (e.g., what happens if no checks fail) would improve transparency.
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?
The description is a single, front-loaded sentence with no wasted words. It immediately states the scope ('failing hygiene checks') and the target ('local repository'), making it easy to parse.
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 simple tool with one parameter and no output schema, the description is mostly adequate. However, it does not explain what constitutes a 'hygiene check' or what the return format looks like, which could leave an agent uncertain about how to interpret the results. The sibling tool 'score_repo' suggests a broader context that is not fully addressed.
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 schema already documents the 'root' parameter as an absolute path. The description adds no additional meaning beyond the schema, so the baseline 3 is appropriate.
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 states a specific verb ('Return') and resource ('failing hygiene checks for a local repository'), which clearly distinguishes it from the sibling tool 'score_repo'. It could be slightly more explicit about what 'hygiene checks' entails, but the core purpose is clear.
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 a local repository and contrasts with 'score_repo' by focusing on failing checks rather than a score. However, it does not explicitly state when to prefer this tool over 'score_repo' or provide exclusions, leaving some inference to the agent.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.