Skip to main content
Glama

audit_instructions

Audit local instruction files for source topology, duplicates, overlap, owner decisions, and previous-run delta. Read-only by default; optionally save a baseline with update_state.

Instructions

Check local instruction discovery, source topology, exact duplicates/overlap, owner decisions and previous-run delta. Read-only by default; update_state explicitly saves the baseline, never source instructions. No semantic or safety enforcement.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoPath to the repo to audit (default: the MCP server's cwd). Use the absolute path of the project the user is working in.
update_stateNoExplicitly save the current instruction delta baseline; default false.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
filesYes
reviewYes
overallYes
repoPathYes
topologyYes
duplicatesYes
riskSummariesYes
surfaceOverlapsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.5.3
    • addedInput schema / properties / update_state
      Added value: +{
      +  "description": "Explicitly save the current instruction delta baseline; default false.",
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / review
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "delta": {
      +      "additionalProperties": false,
      +      "properties": {
      +        "changed": {
      +          "items": {
      +            "type": "string"
      +          },
      +          "type": "array"
      +        },
      +        "known": {
      +          "items": {
      +            "type": "string"
      +          },
      +          "type": "array"
      +        },
      +        "new": {
      +          "items": {
      +            "type": "string"
      +          },
      +          "type": "array"
      +        },
      +        "resolved": {
      +          "items": {
      +            "type": "string"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "required": [
      +        "new",
      +        "changed",
      +        "resolved",
      +        "known"
      +      ],
      +      "type": "object"
      +    },
      +    "findings": {
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "decision": {
      +            "enum": [
      +              "pending",
      +              "accepted",
      +              "stale"
      +            ],
      +            "type": "string"
      +          },
      +          "evidenceHash": {
      +            "type": "string"
      +          },
      +          "id": {
      +            "type": "string"
      +          },
      +          "kind": {
      +            "enum": [
      +              "duplicate",
      +              "overlap",
      +              "topology"
      +            ],
      +            "type": "string"
      +          },
      +          "paths": {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          "reason": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "id",
      +          "kind",
      +          "paths",
      +          "evidenceHash",
      +          "decision"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "stateUpdated": {
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "findings",
      +    "delta",
      +    "stateUpdated"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / topology
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "canonicalPath": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "files": {
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "byteIdenticalTo": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "evidence": {
      +            "type": "string"
      +          },
      +          "imports": {
      +            "items": {
      +              "additionalProperties": false,
      +              "properties": {
      +                "existsInScan": {
      +                  "type": "boolean"
      +                },
      +                "path": {
      +                  "type": "string"
      +                },
      +                "specifier": {
      +                  "type": "string"
      +                }
      +              },
      +              "required": [
      +                "specifier",
      +                "path",
      +                "existsInScan"
      +              ],
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "isSymlink": {
      +            "type": "boolean"
      +          },
      +          "path": {
      +            "type": "string"
      +          },
      +          "role": {
      +            "enum": [
      +              "canonical",
      +              "import_alias",
      +              "symlink_alias",
      +              "verbatim_mirror",
      +              "contextual_layer",
      +              "local_override"
      +            ],
      +            "type": "string"
      +          },
      +          "sha256": {
      +            "type": "string"
      +          },
      +          "symlinkTarget": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          }
      +        },
      +        "required": [
      +          "path",
      +          "role",
      +          "evidence",
      +          "imports",
      +          "isSymlink",
      +          "symlinkTarget",
      +          "byteIdenticalTo",
      +          "sha256"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "schemaVersion": {
      +      "const": 1,
      +      "type": "number"
      +    },
      +    "sourceStrategy": {
      +      "enum": [
      +        "standalone",
      +        "single_source",
      +        "mixed",
      +        "unresolved"
      +      ],
      +      "type": "string"
      +    },
      +    "warnings": {
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "code": {
      +            "type": "string"
      +          },
      +          "message": {
      +            "type": "string"
      +          },
      +          "path": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "code",
      +          "message",
      +          "path"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "required": [
      +    "schemaVersion",
      +    "canonicalPath",
      +    "sourceStrategy",
      +    "files",
      +    "warnings"
      +  ],
      +  "type": "object"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "repoPath",
      -  "files",
      -  "duplicates",
      -  "surfaceOverlaps",
      -  "riskSummaries",
      -  "overall"
      -]New value: +[
      +  "topology",
      +  "review",
      +  "repoPath",
      +  "files",
      +  "duplicates",
      +  "surfaceOverlaps",
      +  "riskSummaries",
      +  "overall"
      +]
  2. First observedv0.4.0

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does so well: it discloses read-only-by-default behavior, that update_state explicitly saves a baseline, that source instructions are never modified, and that no semantic or safety enforcement is applied (an important scope limit). It does not mention permissions or rate limits, but the core safety/mutation profile is clearly stated.

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

Conciseness5/5

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

Two dense sentences with no filler; the scope of checks is front-loaded and the behavioral caveats follow immediately. Every clause carries information.

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?

An output schema exists, so return values need not be described, and the two-parameter surface is simple. The description covers the mutation semantics and limits adequately; the only real gap is the absence of guidance on choosing this audit over the sibling audits.

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 beyond the schema for update_state: it clarifies what is persisted (the delta baseline) and what is expressly out of scope ('never source instructions'). The path parameter's guidance is left to the schema, which already documents it fully.

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

Purpose5/5

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

States a specific verb ('Check') and enumerates the exact resource surface: local instruction discovery, source topology, duplicates/overlap, owner decisions, and previous-run delta. That enumeration clearly separates it from sibling audits (audit_security, audit_release, audit_cd), so an agent can distinguish it without opening the schema.

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?

Usage is only implied: the enumerated checks tell the agent this is the tool for auditing project instruction files, but there is no explicit when-to-use statement, no prerequisites, and no routing against siblings like audit_security. The agent must infer the trigger condition.

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