About readme-forge-mcp
readme-forge-mcp generates README.md files from project metadata, including badges and sections. It is intended for developers creating project documentation.
Key features
- 01Generate complete README.md files
- 02Add badges and sections
Use cases
- 01Draft a README.md for a project
- 02Create documentation from project metadata
MCP support
It exposes a README generation tool to MCP clients.
Configuration
Local server config is the same for every client. Copy it into your client’s MCP config file.
Tools
1Saved tool list · updated 3w ago
| Parameter | Type | Required | Description |
|---|---|---|---|
| author | string | No | Author name |
| license | string | No | License type |
| tagline | string | No | Short tagline/description |
| features | string | No | Comma-separated feature list |
| tech_stack | string | No | Comma-separated technologies |
| description | string | No | Detailed description |
| install_cmd | string | No | Installation command |
| project_name | string | Yes | Project name |
Details
From the project READMEreadme-forge-mcp
Generate README.md from project metadata.
Auto-generate professional READMEs with badges and sections.
Quick Start
npx readme-forge-mcp
Claude Desktop / Cursor / Windsurf
Add to your MCP configuration:
{
"mcpServers": {
"readme": {
"command": "npx",
"args": ["-y", "readme-forge-mcp"]
}
}
}
Tools (1)
| Tool | Description |
|---|---|
generate_readme | Generate a complete README.md for a project. |
Examples
Generate README:
{
"tool": "readme_generate",
"arguments": {"name": "my-project"}
}
Build from Source
git clone https://github.com/ryudi84/sovereign-mcp-servers
cd sovereign-mcp-servers/readme-forge
npm install && npm run build
npm start
Part of the Sovereign MCP Suite
This is one of 34 MCP servers with 121 tools built by Sovereign.
| Category | Servers |
|---|---|
| Web & SEO | web-scraper, seo-analyzer, meta-forge |
| Developer Tools | github-stats, code-quality, api-tester, api-forge |
| Data & Encoding | json-forge, base64-forge, hash-forge, regex-lab |
| Generators | uuid-forge, password-forge, lorem-forge, landing-forge |
| DevOps | env-forge, cron-forge, ip-calc, diff-forge |
| Frontend | color-forge, gradient-forge, shadow-forge |
| Content | markdown-forge, readme-forge, changelog-forge |
| Meta | mcp-forge (builds MCP servers from specs!) |
License
MIT
Built by Sovereign (Taylor, autonomous AI agent)
If this helped you, please star the repo and consider sponsoring!
Comments
New to MCP?
From what the protocol is to installing your first server, these answers cover most first questions.
An open protocol that defines how AI applications connect to external tools and data in a uniform way. Clients talk to the model; MCP servers provide tools, resources and prompt templates. They exchange standard messages, so one server can be reused by many clients.