Markdownlint MCP Server

🚀 markdownlint-MCP-服务器

本项目是一个模型上下文协议（MCP）服务器实现，可通过markdownlint验证Markdown内容，同时提供MCP协议支持，为Markdown内容的验证与集成提供了高效的解决方案。

🚀 快速开始

本服务器能通过markdownlint对Markdown内容进行验证，同时支持MCP协议，可与AI/LLM集成，在Cursor生成Markdown内容时也能发挥验证作用。

✨ 主要特性

• 使用markdownlint验证Markdown内容。
• 提供对markdownlint规则的访问权限。
• 支持自定义配置。
• 实现MCP协议以集成AI/LLM（大语言模型）。
• 可用于Cursor生成Markdown内容时的验证。

📦 安装指南

使用以下命令进行安装：

npm install markdownlint-mcp-server

💻 使用示例

基础用法

作为命令行工具

markdownlint-mcp-server

服务器将启动并监听stdio上的MCP协议消息。

作为库使用

import { markdownlintMcpServer } from 'markdownlint-mcp-server';

const server = markdownlintMcpServer();
// 使用您选择的MCP传输方式与服务器进行交互

高级用法

与Cursor集成

Cursor可以利用此MCP服务器来验证其生成的Markdown内容，具体步骤如下：

1. 启动MCP服务器。
2. Cursor将连接到该服务器。
3. 在生成Markdown内容时，Cursor会：
   • 将内容发送到validate工具。
   • 检查是否有任何linting错误。
   • 根据验证结果改进其Markdown生成过程。
   • 确保最终输出符合markdownlint规则。

示例工作流：

// Cursor的Markdown生成流程
const markdown = generateMarkdown();
const validation = await validateMarkdown(markdown);
if (!validation.isValid) {
  // 使用验证错误来改进Markdown生成
  // 错误信息提供详细的修复说明
  console.log('Markdown验证错误:', validation.errors);
  // Cursor可以利用此信息调整其生成逻辑
}
return markdown;

验证结果包含详细的信息，用于报告发现的任何问题：

• 发生错误的位置行号。
• 规则描述和相关信息。
• 错误细节和上下文。
• 受影响的文本范围。

📚 详细文档

API文档

服务器提供以下两个工具：

1. validate - 验证Markdown内容

   {
     content: string;      // 要验证的Markdown内容
     config?: object;      // 可选的markdownlint配置
   }
   

2. rules - 返回可用的markdownlint规则

   {}  // 不需要任何参数
   

配置

服务器基于markdownlint推荐规则使用默认配置。您可以通过提供自定义配置来覆盖这些规则，具体在使用validate工具时进行设置。

开发流程

构建项目

npm run build

项目结构

• src/
  • index.ts - 主服务器实现文件。
  • config.ts - 默认markdownlint配置。
  • types.ts - 共享类型和模式定义。
  • validation.ts - Markdown验证逻辑。
  • bin.ts - CLI入口点。

CI/CD流程

项目使用GitHub Actions进行持续集成和交付：

• CI Pipeline：针对每个推送和拉取请求运行
  • 在Node.js 18.x和20.x上执行测试。
  • 构建项目。
  • 执行类型检查。
• 发布Pipeline：在新版本发布时运行
  • 构建项目。
  • 发布到npm仓库。

要创建新版本：

1. 更新package.json中的版本号。
2. 在GitHub上创建一个新的发布。
3. 发布工作流将自动推送至npm仓库。

📄 许可证

本项目采用MIT协议。