Readme Gen MCP Server

🚀 README Generator MCP Server

Model Context Protocol (MCP)サーバーで、LLMがプロジェクト構造を自動的に分析し、包括的で形式の整ったREADMEファイルを生成できるようにします。このサーバーは、インテリジェントなプロジェクト分析、技術検出、およびREADME生成機能を提供し、開発者が迅速に専門的なドキュメントを作成するのに役立ちます。

🚀 クイックスタート

このMCPサーバーを使用することで、LLMが自動的にプロジェクト構造を分析し、包括的で形式の整ったREADMEファイルを生成できます。以下に、インストール、セットアップ、および使用方法の手順を示します。

✨ 主な機能

• 自動技術検出：Node.js、TypeScript、Python、Rust、Go、Java、Dockerなどを識別します。
• スマートなプロジェクト分析：package.json、依存関係、スクリプト、および設定ファイルからメタデータを抽出します。
• ディレクトリ構造スキャン：構成可能な深さで再帰的にトラバースし、インテリジェントな無視パターンを持ちます。
• 充実したREADME生成：バッジ、絵文字、適切なセクション、およびコードブロックを含む専門的なREADMEを作成します。
• 柔軟なテンプレートシステム：必須およびオプションのセクションを持つ事前定義された構造があります。
• 多言語対応：様々なプログラミング言語およびフレームワークで動作します。

📦 インストール

npm install

🔧 セットアップ

1. サーバーをビルドする

npm run build

2. Claude Desktopを設定する

このサーバーをClaude Desktopの設定ファイルに追加します。

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%\Claude\claude_desktop_config.json Linux: ~/.config/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "readme-generator": {
      "command": "node",
      "args": ["/absolute/path/to/mcp/build/index.js"]
    }
  }
}

3. Claude Desktopを再起動する

設定を追加した後、Claude Desktopを再起動してMCPサーバーを読み込みます。

Claude Code CLI

このMCPサーバーをClaude Code CLIに追加するには、以下のコマンドを実行します。

# ビルド後のnodeで実行
claude mcp add readme-generator --scope user -- node <path-to-project>/build/index.js

# npxとTypeScriptを使用した開発モード
claude mcp add readme-generator --scope user -- npx -y tsx <path-to-project>/src/index.ts

<path-to-project>をこのMCPサーバーの絶対パスに置き換えてください。

スコープオプション:

• --scope user: すべてのプロジェクトで利用可能（推奨）
• --scope project: .mcp.jsonを介してプロジェクト内のすべてのユーザーと共有
• --scope local: 現在のプロジェクトのみ

便利なコマンド:

claude mcp list                    # すべての設定されたサーバーを表示
claude mcp remove readme-generator # サーバーを削除
/mcp                              # Claude Code内でサーバーの状態を表示

Gemini CLI

このMCPサーバーをGemini CLIに追加するには、設定ファイルを編集します。

ファイルの場所: ~/.config/gemini/settings.json

サーバーの設定を追加します。

{
  "mcpServers": {
    "readme-generator": {
      "command": "node",
      "args": ["<path-to-project>/build/index.js"]
    }
  }
}

<path-to-project>をこのMCPサーバーの絶対パスに置き換えてください。

TypeScriptを使用した開発モードの代替案:

{
  "mcpServers": {
    "readme-generator": {
      "command": "npx",
      "args": ["-y", "tsx", "<path-to-project>/src/index.ts"]
    }
  }
}

💻 使用例

基本的な使用法

クイックREADME生成

Claude DesktopでMCPサーバーを設定したら、以下のように質問するだけです。

"/home/user/my-awesome-appのプロジェクトのREADMEを生成してください"

サーバーは以下の処理を行います。

1. プロジェクトディレクトリを分析する
2. 技術（Node.js、Python、Rustなど）を検出する
3. 設定ファイルからメタデータを抽出する
4. 適切なセクションを含む専門的なREADMEを生成する

詳細なプロジェクト分析

プロセスをより細かく制御するには、以下のように質問します。

"/home/user/my-awesome-appのプロジェクトを分析し、見つけたものを教えてください"

分析結果を確認した後、以下のようにREADMEの生成を要求します。

"APIドキュメントとデプロイメントセクションを強調したREADMEを生成してください"

ステップバイステップのワークフロー

カスタマイズが必要な複雑なプロジェクトの場合は、以下の手順を実行します。

1. 構造を探索する

   "/home/user/my-appのプロジェクト構造を深さ4で読み取ってください"
   

2. 特定のファイルを確認する

   "package.jsonを読み取り、利用可能なスクリプトを表示してください"
   

3. 包括的な分析を取得する

   "プロジェクト全体を分析し、検出した技術を教えてください"
   

4. カスタマイズされたREADMEを生成する

   "テストとコントリビューションガイドラインに重点を置いたREADMEを作成してください"
   

実際の例

ユーザー: "/home/user/projects/api-serverにあるTypeScript Express APIプロジェクトがあります。READMEを作成できますか？"

Claude: [MCPサーバーを使用してプロジェクトを分析する]
        "プロジェクトを分析し、以下の内容を見つけました。
        - Express.jsを使用したTypeScript
        - PostgreSQLデータベースの統合
        - Jestによるテスト
        - Dockerの設定

        セットアップ、APIエンドポイント、データベース設定、およびデプロイメントのセクションを含む包括的なREADMEを作成します。"

生成されたREADMEには自動的に以下の内容が含まれます。

• TypeScript、Node.jsなどの適切なバッジ
• package.jsonに基づくインストール手順
• 説明付きのすべての利用可能なnpmスクリプト
• プロジェクト構造の視覚化
• 依存関係と開発依存関係
• 検出された場合のAPI使用例
• Dockerfileが存在する場合のDockerデプロイメント手順

📚 ドキュメント

利用可能なスクリプト

npm run build

TypeScriptをコンパイルし、出力を実行可能にします。

npm run watch

変更を監視し、自動的に再コンパイルします。

npm run prepare

npm publishの前に自動的にビルドを実行します。

利用可能なMCPツール

サーバーはLLM用の4つのツールを提供します。

1. read_project_structure

プロジェクトのディレクトリ構造を読み取り、ツリー状の構造を返します。

例:

{
  "path": "/home/user/my-project",
  "maxDepth": 3
}

2. read_file

特定のファイルの内容を読み取ります。

例:

{
  "path": "/home/user/my-project/package.json"
}

3. analyze_project

プロジェクトディレクトリを分析し、検出された技術、依存関係、スクリプト、およびディレクトリ構造を含む構造化データを返します。

例:

{
  "projectPath": "/home/user/my-project"
}

4. generate_readme

プロジェクトの完全な専門的なREADME.mdファイルを自動的に生成します。

例:

{
  "projectPath": "/home/user/my-project"
}

🔧 技術詳細

1. プロジェクトスキャン：プロジェクトディレクトリを再帰的に読み取ります（node_modules、.git、dist、buildを無視）。
2. 技術検出：設定ファイル（package.json、tsconfig.json、Cargo.tomlなど）に基づいて技術を識別します。
3. メタデータ抽出：package.jsonからスクリプト、依存関係、作者、ライセンスなどの情報を取得します。
4. テンプレート適用：必須およびオプションのセクションを持つ事前定義されたテンプレート構造を使用します。
5. README生成：バッジ、適切なセクション、コードブロック、および専門的なスタイルを含む形式の整ったREADMEを作成します。

📁 プロジェクト構造

mcp/
  package-lock.json
  package.json
  src/
    index.ts
  tsconfig.json

🎨 カスタマイズ

READMEテンプレートを変更する

src/index.ts:12-66のREADME_TEMPLATEを編集して、セクションをカスタマイズします。

const README_TEMPLATE = {
  sections: [
    {
      name: "Project Title",
      description: "The main title/name of the project",
      required: true,
    },
    {
      name: "Your Custom Section",
      description: "Description of what this section should contain",
      required: false,
    },
    // 必要に応じてセクションを追加
  ],
};

技術検出を追加する

src/index.ts:126-214のanalyzeProject関数を拡張して、追加のフレームワークを検出します。

if (files.includes("docker-compose.yml")) {
  detectedTechnologies.push("Docker Compose");
  configFiles.push("docker-compose.yml");
}

変更を加えた後、以下のコマンドで再ビルドします。

npm run build

📚 依存関係

• @modelcontextprotocol/sdk

🔧 開発依存関係

• @types/node
• typescript

🤝 コントリビュート

コントリビューションは大歓迎です！コントリビュートするには以下の手順を実行してください。

1. リポジトリをフォークする
2. 機能ブランチを作成する: git checkout -b feature/my-feature
3. 変更を加えてテストする
4. 変更をコミットする: git commit -m 'Add my feature'
5. ブランチにプッシュする: git push origin feature/my-feature
6. プルリクエストを送信する

📄 ライセンス

このプロジェクトはISCライセンスの下でライセンスされています。

このREADMEはREADME Generator MCP Server自体を使用して生成されました！ 🎉