# README Generator

> Use this tool when you need to automatically generate professional README.md files for your projects, saving time and effort in creating well-formatted documentation. It analyzes project directories, extracts metadata, and detects technologies to create comprehensive READMEs with badges, emojis, and installation instructions. Ideal for developers working with multiple programming languages, this tool streamlines documentation creation and supports configurable project structure analysis and directory formatting.

Canonical page: https://skillsregistry.net/skills/jojoslice-readme-generator  
JSON: https://api.skillsregistry.net/v1/skills/jojoslice-readme-generator

## Description

A README generator MCP server that automatically analyzes project directories to create well-formatted, professional README.md files with badges, emojis, and comprehensive sections. The server provides four tools: reading project structure with configurable depth and ignore patterns, reading individual files, analyzing projects to extract metadata from package.json and detect technologies (Node.js, TypeScript, Python, Rust, Go, Java, Docker), and generating complete READMs with installation instructions, usage examples, project structure visualization, and dependency listings. Built with TypeScript and the MCP SDK, it supports multiple programming languages and automatically formats directory structures, making it useful for developers who want to quickly generate professional documentation for their projects without manual formatting.

## Trust

- **Trust score (0–1):** 0.98
- **Verification tier:** verified
- **Last scanned:** 2026-09-28

## Facts

- **Version:** 1.0.0
- **Skill type:** atomic
- **Execution layer:** mcp-remote
- **Runtime environment:** api
- **Category:** cloud-infra
- **Updated:** 2026-09-28

## Source

- **Source listing:** [PulseMCP](https://www.pulsemcp.com/servers/jojoslice-readme-generator)
- **Repository:** <https://github.com/jojoslice/readme-gen-mcp-server>

## Use it

Resolve this record through the SkillsRegistry MCP server (no auth, read-only):

```
claude mcp add --transport http --scope user skillsregistry https://api.skillsregistry.net/mcp
```

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_skill",
    "arguments": {
      "slug": "jojoslice-readme-generator"
    }
  }
}
```

REST: `GET https://api.skillsregistry.net/v1/skills/jojoslice-readme-generator` · pull for local use: `GET https://api.skillsregistry.net/v1/skills/jojoslice-readme-generator/pull`

---
SkillsRegistry indexes agent skills from public registries and GitHub. Skills we have analysed are scanned with Circle-IR and scored on six dimensions; each listing states its scan coverage. More: https://skillsregistry.net/llms.txt