Readme Gen MCP Server

🚀 README生成器MCP服務器

一個模型上下文協議（MCP）服務器，可讓大語言模型（LLMs）自動分析項目結構並生成全面、格式規範的README文件。該服務器提供智能項目分析、技術檢測和README生成功能，幫助開發者快速創建專業文檔。

🚀 快速開始

安裝

npm install

配置

1. 構建服務器

npm run build

2. 配置Claude桌面端

將此服務器添加到Claude桌面端的配置文件中：

• 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桌面端

添加配置後，重啟Claude桌面端以加載MCP服務器。

Claude代碼命令行界面（CLI）

要將此MCP服務器添加到Claude代碼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代碼中顯示服務器狀態

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"]
    }
  }
}

✨ 主要特性

• 自動技術檢測：識別Node.js、TypeScript、Python、Rust、Go、Java、Docker等。
• 智能項目分析：從package.json、依賴項、腳本和配置文件中提取元數據。
• 目錄結構掃描：遞歸遍歷，深度可配置，並具有智能忽略模式。
• 豐富的README生成：創建帶有徽章、表情符號、適當章節和代碼塊的專業README。
• 靈活的模板系統：具有必需和可選章節的預定義結構。
• 多語言支持：適用於各種編程語言和框架。

📦 安裝指南

npm install

💻 使用示例

基礎用法

快速生成README

在Claude桌面端配置好MCP服務器後，只需詢問：

"為我位於/home/user/my-awesome-app的項目生成一個README"

服務器將：

1. 分析項目目錄。
2. 檢測技術（Node.js、Python、Rust等）。
3. 從配置文件中提取元數據。
4. 生成一個包含適當章節的專業README。

高級用法

詳細項目分析

如需對流程進行更多控制：

"分析位於/home/user/my-awesome-app的項目，並告訴我你發現了什麼"

查看分析結果後，請求：

"現在生成一個強調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服務器分析項目]
"我已經分析了你的項目，發現：
- 使用TypeScript和Express.js
- 集成了PostgreSQL數據庫
- 使用Jest進行測試
- 有Docker配置

我將創建一個全面的README，包含設置、API端點、數據庫配置和部署等部分。"

生成的README將自動包含：

• 適用於TypeScript、Node.js等的適當徽章。
• 基於package.json的安裝說明。
• 所有可用的npm腳本及其描述。
• 項目結構可視化。
• 依賴項和開發依賴項。
• API使用示例（如果檢測到）。
• Docker部署說明（如果存在Dockerfile）。

📚 詳細文檔

可用腳本

npm run build

編譯TypeScript並使輸出可執行。

npm run watch

監視更改並自動重新編譯。

npm run prepare

在npm publish之前自動運行構建。

可用的MCP工具

服務器為大語言模型提供了四個工具：

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"
}

🔧 技術細節

項目掃描

遞歸讀取項目目錄（忽略node_modules、.git、dist、build）。

技術檢測

根據配置文件（package.json、tsconfig.json、Cargo.toml等）識別技術。

元數據提取

從package.json中提取信息，包括腳本、依賴項、作者、許可證。

模板應用

使用具有必需和可選章節的預定義模板結構。

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: "項目標題",
      description: "項目的主要標題/名稱",
      required: true,
    },
    {
      name: "您的自定義章節",
      description: "此章節應包含的內容描述",
      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 '添加我的功能'。
5. 推送到分支：git push origin feature/my-feature。
6. 提交拉取請求。

📄 許可證

本項目採用ISC許可證。

本README是使用README生成器MCP服務器自身生成的！🎉