Skip to main content
Glama

QualityKit audit

qualitykit.audit

Scans a Next.js codebase to inventory routes and check technical SEO, metadata, content, schema, and links, separating defects from opportunities.

Instructions

Primary audit: route inventory, technical SEO, metadata, content, schema, links. Separates defects from opportunities. Optional rendered HTML via includeRendered+siteUrl.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "projectRoot": "<projectRoot>"
    },
    "name": "qualitykit.audit"
  }
}

Input Schema

NameRequiredDescriptionDefault
siteUrlNo
projectRootYesAbsolute path to the website repository root
includeRenderedNoFetch rendered HTML when siteUrl is provided

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.0

TDQS

A3.5/5.0
Behavior3/5

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

With no annotations, the description must carry the behavioral burden, and it does disclose two meaningful traits: results are partitioned into defects versus opportunities, and rendered HTML is only fetched when includeRendered and siteUrl are both supplied. It does not state that the operation is read-only/non-mutating, give any indication of runtime or cost (a full site crawl plus optional rendering is expensive), or describe result structure beyond the defect/opportunity split.

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

Conciseness4/5

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

Three short sentences, front-loaded with the core purpose and ending with the optional-mode caveat; no filler. The telegraphic list style ('route inventory, technical SEO, metadata, content, schema, links') is dense but readable and appropriate for a definition of this size.

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 three-parameter, no-output-schema, no-annotation audit tool, the definition covers scope, result classification, and the optional rendering path, which is most of what is needed to invoke it. It is still thin on operational expectations: no hint of whether it writes anything, how long a full audit takes, or what an agent should do with the defect/opportunity split afterwards.

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 67%, with projectRoot and includeRendered already documented in the schema, but siteUrl has no description there. The description compensates by stating the coupling — rendered HTML requires both includeRendered and siteUrl — which is a genuine conditional relationship not expressed in the schema, and the schema's own 'Fetch rendered HTML when siteUrl is provided' note only partly encodes.

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?

The description states a specific verb and resource ('Primary audit') and enumerates the six areas covered (route inventory, technical SEO, metadata, content, schema, links), so an agent knows exactly what surface it inspects. The word 'Primary' implicitly distinguishes it from a secondary/ai_audit variant, but that sibling is never named, so differentiation relies on inference.

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?

'Primary audit' implies this is the default first call versus alternatives, which gives implied rather than explicit usage guidance. There is no statement of when not to use it, no prerequisites (e.g. an existing project profile), and no routing to qualitykit.ai_audit or seo.audit despite those being natural alternatives.

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