Skip to main content
Glama

Delimit Docs Validate

delimit_docs_validate
Read-onlyIdempotent

Checks documentation quality and completeness as a CI gate, surfacing missing READMEs, undocumented functions, and broken internal links.

Instructions

Validate documentation quality and completeness.

When to use: as a CI gate to surface missing READMEs, undocumented public functions, and broken internal markdown links. When NOT to use: to generate fresh API reference (use delimit_docs_generate).

Sibling contrast: delimit_docs_generate writes; this validates existing docs.

Side effects: read-only inspection. Calls backends.ui_bridge.docs_validate.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
targetNoProject path. Default "." (cwd)..

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv4.7.9
    • changedInput schema / properties / target / description
      Previous value: -"Project path."New value: +"Project path. Default \".\" (cwd)."
  2. Changed1 schema field changedv4.5.5
    • addedInput schema / properties / target / description
      Added value: +"Project path."
  3. First observedv0.1.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, so the bar for additional disclosure is lower. The description adds useful context by stating 'Side effects: read-only inspection' and naming the underlying backend call, which goes beyond the structured metadata.

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?

The description is short, front-loaded with the core purpose, and organized by use case, exclusions, sibling contrast, and side effects. Every section serves a clear decision-making purpose for an agent.

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

Completeness5/5

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

For a simple one-optional-parameter validation tool with an output schema and strong annotations, the description covers why, when, when not, and what side effects to expect. Nothing essential is missing.

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 single optional 'target' parameter is fully documented in the schema. The description does not add parameter-level detail, but the baseline of 3 is appropriate since the schema already carries the semantic load.

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?

Description opens with a specific verb and resource: 'Validate documentation quality and completeness.' It explicitly contrasts with delimit_docs_generate, making the tool's purpose unambiguous and distinguished from its sibling.

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

Usage Guidelines5/5

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

Provides explicit when-to-use guidance ('as a CI gate to surface missing READMEs, undocumented public functions, and broken internal markdown links') and when-not-to-use guidance with a named alternative. The sibling contrast further clarifies the division of labor.

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

Deploy Server

Other Tools