Skip to main content
Glama

lint_markdown_tree

Validates local Markdown files or directories for broken relative links/images, empty links, heading hierarchy, and README issues without fetching external URLs.

Instructions

Lint all Markdown files under a directory (skips node_modules/.git). Local files only. Relative links are checked on disk; external http(s) links are not fetched.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dirPathNoAlias for rootPath.
maxFilesNoMax files (default 50).
rootPathYesDirectory or file to scan.
readmeChecksNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/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 behavioral burden and does so well for a read-only scan tool: it discloses skip patterns (node_modules/.git), that only local files are considered, and that relative links are validated on disk while http(s) links are not fetched. It omits traversal/depth behavior, failure semantics for broken links, and output shape, which keeps it below a 5.

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, each load-bearing: scope, file-access constraint, and link-checking behavior. Front-loaded with the primary action and no filler.

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?

No output schema and no annotations, so the description must stand alone; it covers scope, skip rules, and link-checking semantics adequately. Gaps remain around the readmeChecks flag and maxFiles behavior, which an agent would have to guess from the schema alone.

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 coverage is 75%, so two parameters (readmeChecks, maxFiles) and the dirPath alias are documented only in the schema. The description clarifies that the root target is a directory but adds no meaning for the remaining parameters, so it neither compensates for nor regresses the baseline.

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?

Specific verb (lint) and resource (all Markdown files under a directory), with explicit scope that separates it from the single-file sibling. It does not name lint_markdown directly, so the differentiation is inferred from 'tree' wording rather than stated.

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?

The recursive/all-files framing implies when this tool is appropriate versus a single-file linter, and 'Local files only' bounds the use case. However, it never explicitly names lint_markdown or the condition that should route an agent to it, leaving sibling selection to inference.

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