markdownlint-mcp-server

markdownlint-mcp-server

markdownlint 的模型上下文协议（MCP）服务实现，可根据 markdownlint 规则验证 Markdown 内容。

功能

• 使用 markdownlint 验证 Markdown 内容
• 提供对 markdownlint 规则的访问
• 支持自定义配置
• 实现 MCP 协议，以便与 AI/LLM 集成
• Cursor 可使用它验证生成的 Markdown

安装

npm install markdownlint-mcp-server

使用方法

作为 CLI 使用

markdownlint-mcp-server

服务将启动，并通过 stdio 监听 MCP 协议消息。

作为库使用

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

const server = markdownlintMcpServer();
// Use the server with your preferred MCP transport

与 Cursor 集成

Cursor 可使用此 MCP 服务验证其生成的 Markdown：

1. 启动 MCP 服务
2. Cursor 将连接到该服务
3. 生成 Markdown 内容时，Cursor 将：
   • 将内容发送到 validate 工具
   • 检查是否存在 lint 错误
   • 使用验证结果改进其 Markdown 生成
   • 确保最终输出符合 markdownlint 规则

示例工作流：

// Cursor's markdown generation process
const markdown = generateMarkdown();
const validation = await validateMarkdown(markdown);
if (!validation.isValid) {
  // Use the validation errors to improve markdown generation
  // The errors provide detailed information about what needs to be fixed
  console.log('Markdown validation errors:', validation.errors);
  // Cursor can use this information to adjust its generation
}
return markdown;

验证结果包含所发现问题的详细信息：

• 问题所在的行号
• 规则说明和信息
• 错误详情和上下文
• 受影响文本的范围

API

此服务提供两个工具：

1. validate - 验证 Markdown 内容

   {
     content: string;      // The markdown content to validate
     config?: object;      // Optional markdownlint configuration
   }
   

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

   {}  // No parameters needed
   

配置

此服务使用基于 markdownlint 推荐规则的默认配置。使用 validate 工具时，可以通过提供自定义配置来覆盖这些规则。

开发

构建

npm run build

项目结构

• src/
  • index.ts - 主服务实现
  • config.ts - markdownlint 默认配置
  • types.ts - 共享类型和架构
  • validation.ts - Markdown 验证逻辑
  • bin.ts - CLI 入口点

CI/CD

此项目使用 GitHub Actions 进行持续集成和部署：

• CI 流水线：每次推送和拉取请求时运行

  • 在 Node.js 18.x 和 20.x 上测试
  • 构建项目
  • 运行类型检查

• 发布流水线：发布新版本时运行

  • 构建项目
  • 发布到 npm

创建新版本：

1. 更新 package.json 中的版本
2. 在 GitHub 上创建新版本
3. 发布工作流将自动发布到 npm

许可证

MIT