Skip to main content
Glama

@mcpx-digital/md-lint

MCP server that lints local Markdown for broken relative links, heading hierarchy, empty links, and common README issues.

Local files only. Relative targets are checked on disk. External http(s) links are not fetched (no scraping, no network link checks).

Install (MCPX / npx)

npx -y @mcpx-digital/md-lint

Prepared for npm as @mcpx-digital/md-lint. Until published, run from a local clone.

Related MCP server: Claude Writer's Aid MCP

Cursor mcp.json example

{
  "mcpServers": {
    "md-lint": {
      "command": "npx",
      "args": ["-y", "@mcpx-digital/md-lint"]
    }
  }
}

Local clone:

{
  "mcpServers": {
    "md-lint": {
      "command": "node",
      "args": ["/absolute/path/to/md-lint-mcp/index.js"]
    }
  }
}

Tools

Tool

What it does

lint_markdown

Lint one .md file

lint_markdown_tree

Lint Markdown files under a directory

Checks

  • Broken relative links / images (filesystem)

  • Empty link targets or empty link text

  • Heading hierarchy (missing H1, level skips, multiple H1)

  • README heuristics (short/empty, missing install/license keywords, placeholders)

Example prompts

  • “Lint README.md for broken links and heading issues”

  • “Scan docs/ for Markdown problems”

Development

git clone https://github.com/TheoryofShadows/md-lint-mcp.git
cd md-lint-mcp
npm install
npm test
node index.js

Sell / list on MCPX

Suggested listing price: $5.

Install command: npx -y @mcpx-digital/md-lint

License

MIT © TheoryofShadows

Available Tools

2 tools
lint_markdownA

Lint a Markdown file for broken relative links, heading hierarchy, empty links, and common README issues. Local files only. Relative links are checked on disk; external http(s) links are not fetched.

ParametersJSON Schema
NameRequiredDescriptionDefault
filePathYesPath to a .md file.
readmeChecksNoEnable README-specific heuristics (default true for README* names).

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 does disclose meaningful behavior: relative links are resolved on disk and external http(s) links are never fetched, which signals a purely local, network-free operation. It stops short of stating read-only nature, output/exit semantics, or failure behavior for an unreadable path.

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 core purpose and checks, then the scope caveat. Every sentence earns its place with zero filler.

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?

The description covers what is checked and what is not fetched, which is the key scope question. But with no annotations and no output schema, it leaves the result shape and failure behavior unspecified, making it only minimally adequate for correct invocation.

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 both parameters (filePath, readmeChecks) are already documented, including the README default heuristic. The description adds no parameter-level detail beyond what the schema provides, so the baseline 3 is appropriate.

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 (lint) and resource (Markdown file) plus the concrete checks performed: broken relative links, heading hierarchy, empty links, README issues. The single-file scope is clear, though it never explicitly distinguishes itself from the sibling lint_markdown_tree beyond the singular 'file' framing.

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?

'Local files only' and the note that external http(s) links are not fetched implicitly bound when the tool applies. However, there is no explicit contrast with lint_markdown_tree (whole tree/directory), so the agent must infer which tool to pick when both could apply.

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

lint_markdown_treeA

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.

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

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.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 2 tool updatesv0.1.0
    • First observedlint_markdown
    • First observedlint_markdown_tree

TDQS

A3.8/5.0

Scored across 2 tools

Disambiguation5/5

The two tools have clearly distinct targets: one lints a single file, the other recursively lints a directory tree. No overlap or ambiguity exists.

Naming Consistency5/5

Both tool names use the consistent lint_markdown prefix with a clear suffix distinguishing scope. The pattern is predictable and readable.

Tool Count3/5

Two tools cover the core file and directory linting cases, but the count feels slightly thin for the domain; a tool for linting content or configuration might add value.

Completeness4/5

The surface covers linting individual files and directory trees, which are the primary local operations. Minor gaps like linting a list of files or custom configs exist but are not critical.

Maintenance

ActivityMaintained
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers