markdown lint mcp
用于标记、格式化和合规性检查的模型上下文协议（MCP）服务器。
概述
此MCP服务器为AI助手提供了整理、验证和自动修复Markdown文件的能力，以确保符合既定的Markdown标准和最佳实践。
问题
虽然存在许多用于转换各种文件格式的MCP服务器 到 Markdown，没有专门为其设计的MCP服务器 梳理并确保合规性 现有Markdown文件。这在工作流程中造成了一个空白，可以创建或转换Markdown内容，但不能验证其质量和一致性。
解决方案
markdown-lint-mcp 通过提供以下服务弥合这一差距：
- Markdown跳转 使用行业标准规则
- 自动固定 常见的Markdown问题
- 合规性验证 违反既定标准
- 无缝集成 与MCP兼容的AI助手
特性
提供的MCP工具
lint_markdown-分析Markdown文件并返回详细问题fix_markdown-自动修复Markdown问题并返回更正的内容get_configuration-显示当前的linting规则和配置
基于标准的方法
- 用途 标记下线 默认规则集（社区标准）
- 基于 CommonMark规范
- 跟随 GitHub风格的Markdown 惯例
- 支持 全部52条官方markdownint规则
自动固定规则
我们的MCP服务器可以自动修复52条官方markdownint规则中的30条（58%）。这些规则是确定的，可以在没有人为判断的情况下确定：
空格和格式（9条规则）
- MD009 -尾随空间
- MD010 -硬标签
- MD012 -多个连续的空白行
- MD022 -标题周围有空白行
- MD031 -用空白行包围的围栏代码块
- MD032 -由空白行包围的列表
- MD047 -文件应以换行符结尾
- MD058 -空白行包围的表格
- MD027 -区块行情符号后有多个空格
标题格式（6条规则）
- MD018 -哈希后没有空格
- MD019 -哈希后有多个空格
- MD020 -封闭式ATX内部没有空间
- MD021 -封闭ATX内有多个空间
- MD023 -标题从行首开始
- MD026 -标题中的尾随标点符号
列表格式（4条规则）
- MD004 -无序列表样式
- MD005 -列表项缩进一致性
- MD007 -无序列表缩进
- MD030 -列表标记后的空格
链接和文本格式（7条规则）
- MD011 -反向链接语法
- MD034 -使用裸URL
- MD037 -强调内部空间
- MD038 -代码跨度内的空格
- MD039 -链接文本中的空格
- MD049 -强调风格
- MD050 -强烈的风格
高级可修复（4条规则）
- MD014 -命令前的美元符号
- MD044 -专有名称大写
- MD051 -链接片段验证
- MD053 -未使用的参考定义
仅检测规则
以下22条规则（42%）不能自动修复，因为它们需要人工判断、内容理解或风格决策：
结构/内容规则（12条规则）
- MD001 -标题增量（需要了解文档结构）
- MD003 -标题风格一致性（需要风格偏好决策）
- MD013 -行长度（需要内容感知换行）
- MD024 -重复的标题（可能会破坏文档结构/导航）
- MD025 -多个H1（需要了解文档层次结构）
- MD028 -区块引用中的空白行（语义意图模糊）
- MD029 -有序列表编号（样式偏好）
- MD035 -水平规则样式（样式偏好）
- MD036 -强调作为标题（需要语义理解）
- MD041 -第一行H1（可能破坏现有文档结构）
- MD043 -所需标题结构（文件特定要求）
- MD046 -代码块样式（样式首选项）
内容/语言规则（5条规则）
- MD033 -内联HTML（可能是有意/必要的）
- MD040 -代码语言规范（需要代码语言知识）
- MD045 -图像的Alt文本（需要理解图像内容）
- MD059 -描述性链接文本（需要理解上下文/目的）
- MD042 -空链接（可以是占位符或模板）
参考/链接规则（3条规则）
- MD052 -已定义参考链接（可以是外部的或有条件的）
- MD054 -链接/图像样式（样式偏好）
- MD056 -表列计数（可能是有意格式化）
表格规则（2条规则）
- MD055 -桌管样式（样式偏好）
- MD048 -代码围栏样式（样式偏好）
安装
npm install @dougis/markdown-lint-mcp用法
使用克劳德桌面
添加到您的Claude Desktop MCP配置中：
{
"mcpServers": {
"markdownlint": {
"command": "npx",
"args": ["@dougis/markdown-lint-mcp"]
}
}
}与其他MCP客户端
此服务器可与任何兼容MCP的客户端配合使用，包括：
- 克劳德桌面版
- 光标
- 克莱恩
- 支持MCP的VS代码
示例工作流
抓取Markdown文件
User: "Please lint my README.md file and tell me what issues exist"
AI: Uses lint_markdown tool to analyze and report issues修复Markdown问题
User: "Fix all the markdown issues in my documentation files"
AI: Uses fix_markdown tool to automatically correct problems验证合规性
User: "Is my markdown compliant with standard formatting rules?"
AI: Uses lint_markdown to validate and provide compliance status技术方法
- 直接库集成 和
markdownlintnpm包 - 无外部CLI依赖关系 必需的
- 跨平台 支持（Windows、macOS、Linux）
- 单次安装 -不需要额外的工具
- 有效处理 通过API直接调用
开发状态
🚀 生产就绪 -该项目已达到高度成熟，包括：
- ✅ 完成MCP服务器的实施 包含全部52条markdownline规则
- ✅ 全面的测试套件 -82%的覆盖率（42/51条规则，包含完整测试）
- ✅ 522项测试通过 成功率100%
- ✅ 所有优先级1规则都经过全面测试 （11/11关键规则）
- 🔄 最终测试阶段 对于剩余的专门规则
- 📋 已准备好进行社区测试 和反馈
测试覆盖状态
我们的测试套件通过广泛的验证证明了生产质量：
- ✅ 19个测试套件 全部通过
- ✅ 总共522次测试 0次失败
- ✅ 82%的规则覆盖率 （51条规则中有42条经过全面测试）
- ✅ 100%优先级1规则已测试 （所有关键功能）
- ✅ 检测和修复验证 对于所有测试规则
- ✅ 边缘案例和配置测试 实施
剩余工作（占规则的8%）
只有9条专门规则有待测试：
- MD039、MD050、MD051、MD052、MD053、MD055-链接和样式规则
- 规则组合的集成测试
- 使用大文件进行性能测试
贡献
我们欢迎捐款！该项目遵循MCP最佳实践，并保持高代码质量标准。
路线图
- \[x\]✅ 核心MCP服务器实现
- \[x\]✅ 综合测试套件（完成82%）
- \[x\]✅ 生产质量代码，522项测试通过
- \[ \] 🔄 完成剩余的9条规则测试
- \[ \] 📚 增强的文档和示例
- \[ \] 🤝 社区反馈整合
- \[ \] 📦 提交给MCP官方收藏
许可证
MIT许可证-有关详细信息，请参阅许可证文件
相关项目
支持
有关问题、疑问或贡献，请使用GitHub问题页面。