Skip to main content
Glama

QualityKit AI audit

qualitykit.ai_audit

Audits a Next.js site for AI discoverability, scoring crawlability, extractability, entity clarity, citation readiness, and structured understanding with evidence-based findings.

Instructions

AI discoverability audit: crawlability, extractability, entity clarity, citation readiness, structured understanding, topical coverage. Heuristic scores with evidence — no citation guarantees.

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.ai_audit"
  }
}

Input Schema

NameRequiredDescriptionDefault
siteUrlNo
projectRootYesAbsolute path to the website repository root
includeRenderedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.0

TDQS

B3/5.0
Behavior3/5

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

With no annotations supplied, the description carries the full burden, and it does add one genuinely useful disclosure: results are 'heuristic scores with evidence — no citation guarantees', which tells the agent the output is advisory and non-authoritative. However, it never states that the operation is read-only/non-mutating, nor whether it fetches the live site or only reads the repository, nor any cost or runtime characteristics of a crawl.

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?

Two sentences, front-loaded with the core purpose and followed by a scope list and an honest caveat; nothing is padding. The six-item dimension list is dense but each item conveys scope, though it could be tightened.

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?

There is no output schema, so the description must carry return-value context, and it does so only at a high level (dimension scores with evidence). Combined with an unexplained siteUrl/includeRendered pair and no statement of read-only behavior, the definition is adequate but leaves meaningful gaps for a three-parameter audit tool.

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

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 33% — projectRoot is documented in the schema, but siteUrl (uri format) and includeRendered are bare. The description never mentions any parameter, so it does not compensate for the gap; an agent cannot tell from this text that passing siteUrl triggers live fetching or that includeRendered enables rendered-DOM analysis.

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 gives a specific verb+resource (an 'AI discoverability audit') and enumerates six concrete dimensions — crawlability, extractability, entity clarity, citation readiness, structured understanding, topical coverage — so an agent knows exactly what is produced. It does not explicitly distinguish itself from the general sibling 'qualitykit.audit' or 'seo.audit', leaving the agent to infer the AI-discoverability specialization from the name alone.

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

Usage Guidelines2/5

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

There is no when-to-use guidance: nothing states that this should be run instead of qualitykit.audit or seo.audit, no prerequisites, and no indication of when a siteUrl-driven crawl is appropriate versus a repo-only analysis. Usage is only implied by the phrase 'AI discoverability audit'.

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