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服务器自身生成的！🎉