Markdownlint MCP Server

🚀 markdownlint-MCP-サーバ

このサーバは、markdownlintを用いてMarkdownコンテンツを検証し、MCP（モデルコンテキストプロトコル）をサポートする実装です。Markdownコンテンツの品質管理や、AI/LLM（大規模言語モデル）との統合に役立ちます。

✨ 主な機能

• markdownlintを使用したMarkdownコンテンツの検証
• markdownlintのルールへのアクセス提供
• カスタム設定のサポート
• AI/LLMとの統合のためのMCPプロトコルの実装
• 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ドキュメント

サーバは以下の2つのツールを提供します。

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ライセンス