Markdownlint MCP Server

🚀 markdownlint-MCP-Server

A Model Context Protocol (MCP) server implementation that validates Markdown content using markdownlint and provides MCP protocol support.

🚀 Quick Start

This server is designed to validate Markdown content and support the MCP protocol, which can be integrated with AI/LLM for better Markdown generation.

✨ Features

• Validate Markdown content using markdownlint.
• Provide access to markdownlint rules.
• Support custom configuration.
• Implement the MCP protocol for AI/LLM (Large Language Model) integration.
• Can be used for validating Markdown content generated by Cursor.

📦 Installation

npm install markdownlint-mcp-server

💻 Usage Examples

Basic Usage

As a Command-Line Tool

markdownlint-mcp-server

The server will start and listen for MCP protocol messages on stdio.

As a Library

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

const server = markdownlintMcpServer();
// Interact with the server using your chosen MCP transport method.

Advanced Usage

Integration with Cursor

Cursor can utilize this MCP server to validate the Markdown content it generates:

1. Start the MCP server.
2. Cursor will connect to the server.
3. When generating Markdown content, Cursor will:
   • Send the content to the validate tool.
   • Check for any linting errors.
   • Improve its Markdown generation process based on the validation results.
   • Ensure the final output complies with markdownlint rules.

Example workflow:

// Cursor's Markdown generation process
const markdown = generateMarkdown();
const validation = await validateMarkdown(markdown);
if (!validation.isValid) {
  // Use validation errors to improve Markdown generation
  // Error messages provide detailed repair instructions
  console.log('Markdown validation error:', validation.errors);
  // Cursor can use this information to adjust its generation logic
}
return markdown;

The validation results contain detailed information for reporting any issues found:

• Line number where the error occurred.
• Rule description and related information.
• Error details and context.
• Affected text range.

📚 Documentation

API Documentation

The server provides the following two tools:

1. validate - Validate Markdown content

   {
     content: string;      // Markdown content to be validated
     config?: object;      // Optional markdownlint configuration
   }
   

2. rules - Return available markdownlint rules

   {}  // No parameters required
   

Configuration

The server uses the default configuration based on markdownlint recommended rules. You can override these rules by providing a custom configuration when using the validate tool.

Development Process

Build the Project

npm run build

Project Structure

• src/
  • index.ts - Main server implementation file
  • config.ts - Default markdownlint configuration
  • types.ts - Shared type and schema definitions
  • validation.ts - Markdown validation logic
  • bin.ts - CLI entry point

CI/CD Process

The project uses GitHub Actions for continuous integration and delivery:

• CI Pipeline: Runs for each push and pull request

  • Execute tests on Node.js 18.x and 20.x
  • Build the project
  • Perform type checking

• Release Pipeline: Runs when a new version is released

  • Build the project
  • Publish to the npm repository

To create a new version:

1. Update the version number in package.json.
2. Create a new release on GitHub.
3. The release workflow will automatically push to the npm repository.

📄 License

This project is licensed under the MIT License.