Skip to main content
Glama

Run full docs audit

run_full_audit

Audits documentation against a local or GitHub codebase, checks structure, docs, cross-references, and env drift, then returns findings and fix patches in Markdown and JSON.

Instructions

Run the full multi-step docs audit pipeline: structure → docs → cross-check → env drift → issues → fix patches. Returns markdown report + structured JSON. Also updates audit://report/latest.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "run_full_audit"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNoAbsolute or relative local path to a git checkout
formatNoResponse formatboth
githubNoGitHub repo as owner/repo or https://github.com/owner/repo (public repos via GitHub API)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.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 carries the full burden, and it does disclose two important traits: the tool mutates a resource ('Also updates audit://report/latest') and its return shape ('markdown report + structured JSON'). It does not disclose whether the audit writes files or patches to the checkout, expected runtime for a six-stage pipeline, GitHub API rate-limit exposure for public repos, or error/partial-failure behavior — significant gaps for an unannotated potentially long-running tool.

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?

Three short sentences, front-loaded with the pipeline and its stages, then returns, then side effect. No filler; every clause carries information an agent needs before invoking.

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 zero-required-param, no-output-schema orchestration tool, the definition covers the stage sequence, return format, and side effect. It omits the practical prerequisites (must supply path or github), cost/duration expectations, and whether the repo is modified, which are what an agent most needs to decide whether to call this at all.

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% and each parameter is documented in the schema, so baseline 3 applies. The description adds no meaning beyond the schema — it never clarifies that path and github are alternative input modes or how format interacts with the pipeline stages.

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?

Names a specific verb+resource ('Run the full multi-step docs audit pipeline') and enumerates the six stages, which implicitly maps to the sibling step tools (fetch_repo_structure, cross_check_snippets, analyze_open_issues, generate_fix_patch). An agent can tell this is the orchestrating composite rather than a single-stage tool, though the contrast is never stated explicitly.

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 by the adjective 'full' — an agent can infer this is the all-in-one alternative to calling individual stage tools, but there is no explicit 'use this when / use X instead when' statement and no note that this is the expensive option. No prerequisites are mentioned (notably that at least one of path or github must be supplied despite zero required parameters).

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