readme-forge-mcp

Name: readme-forge-mcp
Author: ryudi84

本地服务

github.com/ryudi84开发工具135 周前更新

代码仓库

关于 readme-forge-mcp

readme-forge-mcp 根据项目元数据生成 README.md，内容包含徽章和章节，适合编写项目文档的开发者。

主要功能

01生成完整的 README.md
02添加徽章和章节

适用场景

01为项目起草 README.md
02根据项目元数据创建文档

MCP 相关

它向 MCP 客户端提供 README 生成工具。

配置

本地服务的配置在各客户端中通用，复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置

{
  "mcpServers": {
    "ryudi84-readme-forge": {
      "command": "npx",
      "args": [
        "-y",
        "readme-forge-mcp"
      ]
    }
  }
}

启动命令npx -y readme-forge-mcp

本地服务需要在你的电脑上安装运行环境（如 Node.js 18+）。各客户端的配置文件位置不同，请参考客户端文档。

安装包

npmreadme-forge-mcp1.0.1stdio

工具

收录的工具列表 · 更新于 3 周前

参数	类型	必填	说明
author	string	否	作者姓名
license	string	否	许可证类型
tagline	string	否	简短标语／描述
features	string	否	逗号分隔的功能列表
tech_stack	string	否	逗号分隔的技术
description	string	否	详细描述
install_cmd	string	否	安装命令
project_name	string	是	项目名称

详细介绍

readme-forge-mcp

根据项目元数据生成 README.md。

自动生成带徽章和章节的专业 README。

快速开始

npx readme-forge-mcp

Claude Desktop / Cursor / Windsurf

添加到 MCP 配置中：

{
  "mcpServers": {
    "readme": {
      "command": "npx",
      "args": ["-y", "readme-forge-mcp"]
    }
  }
}

工具（1）

工具	描述
`generate_readme`	为项目生成完整的 README.md。

示例

生成 README：

{
  "tool": "readme_generate",
  "arguments": {"name": "my-project"}
}

从源代码构建

git clone https://github.com/ryudi84/sovereign-mcp-servers
cd sovereign-mcp-servers/readme-forge
npm install && npm run build
npm start

Sovereign MCP 套件的一部分

这是 Sovereign 构建的 34 个 MCP 服务之一，包含 121 个工具。

类别	服务
Web 与 SEO	web-scraper, seo-analyzer, meta-forge
开发者工具	github-stats, code-quality, api-tester, api-forge
数据与编码	json-forge, base64-forge, hash-forge, regex-lab
生成器	uuid-forge, password-forge, lorem-forge, landing-forge
DevOps	env-forge, cron-forge, ip-calc, diff-forge
前端	color-forge, gradient-forge, shadow-forge
内容	markdown-forge, readme-forge, changelog-forge
元工具	mcp-forge（可根据规范构建 MCP 服务！）