Markdownlint MCP Server

🚀 markdownlint-MCP-服務器

本項目是一個模型上下文協議（MCP）服務器實現，可通過markdownlint驗證Markdown內容，同時提供MCP協議支持。它能有效保障Markdown內容的規範性，還可與AI/LLM集成，助力Markdown內容的生成與驗證。

🚀 快速開始

本服務器可作為命令行工具或庫使用，還能與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協議。