Skip to main content
Glama

audit_index

Audit your search index against source data to find missing items, orphaned entries, and duplicates. Get file paths and remediation suggestions for each issue.

Instructions

Audit search index against source data with 0% tolerance. Reports missing items, orphaned entries, and duplicates with detailed file paths and remediation suggestions. Validates 100% of source data.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sourcesNoData sources to audit (default: all)
max_itemsNoMax items to list per category (default: 100, use 0 for unlimited)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv3.0.8

TDQS

B3.2/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. It discloses scope and output behavior (0% tolerance, 100% validation, remediation suggestions implying no auto-fix), but never states that the operation is read-only, whether it has side effects, or any cost/runtime characteristics.

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 sentences, front-loaded with the core purpose and scope. Mostly efficient, though 'with 0% tolerance' and 'Validates 100% of source data' restate the same strictness idea.

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

Completeness4/5

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

For a two-optional-parameter audit tool with no output schema and no annotations, the description explains what categories of results it returns (missing, orphaned, duplicates, file paths, remediation). Only the mutation/side-effect question remains open.

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

Parameters3/5

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 both optional parameters (sources with enum values, max_items with its 0-for-unlimited semantics). The description adds no parameter meaning beyond that, which is the correct baseline here.

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 (audit) and resource (search index) and enumerates the findings it produces: missing items, orphaned entries, duplicates. It is clearly distinct from index-building siblings, though it never explicitly contrasts itself with rebuild_index.

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 explicit when-to-use guidance and no named alternative. The natural relationship to the sibling rebuild_index (audit detects issues, rebuild fixes them) is left entirely to inference.

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