README Generator

You have an MCP server that analyzes projects and automatically generates polished README files. It detects technologies, scans directory structures, reads configuration metadata, and outputs well-structured documentation you can share with your team or users. This server is designed to integrate seamlessly with MCP-enabled clients to streamline project documentation.

How to use

To use this MCP server, connect it to an MCP-capable client and invoke its tools to explore a project, inspect specific files, analyze the project, and generate a README. The server works with clients that support the MCP workflow and can orchestrate multiple steps—structure reading, file access, analysis, and final README generation—in a smooth, automated sequence.

How to install

Prerequisites you need before installation are Node.js and npm (or an equivalent Node package manager). Ensure you have a working development environment with Internet access.

Install dependencies for the MCP server.

npm install

Build the server to produce an executable runtime.

npm run build

If you are configuring a client for Claude Desktop, add the MCP server configuration to your client settings. The following example shows how a local stdio server is wired up via a path to the built index.

{
  "mcpServers": {
    "readme_generator": {
      "command": "node",
      "args": ["/absolute/path/to/mcp/build/index.js"]
    }
  }
}

Additional setup for developers and clients

Claude Code and Gemini CLIs can be configured to load this MCP server in user scope. You can also run in development mode with TypeScript sources.

# Claude Code CLI (example usage)
# After building
claude mcp add readme-generator --scope user -- node <path-to-project>/build/index.js

# Development mode with TSX
claude mcp add readme-generator --scope user -- npx -y tsx <path-to-project>/src/index.ts

For Gemini CLI, adjust settings similarly to point to the local build or development entry.

{
  "mcpServers": {
    "readme_generator": {
      "command": "node",
      "args": ["<path-to-project>/build/index.js"]
    }
  }
}

Available tools

read_project_structure

Reads the directory structure of a project and returns a tree-like representation up to a configurable depth.

read_file

Reads the contents of a specified file path, enabling targeted inspections like package.json or configuration files.

analyze_project

Analyzes a project to detect technologies, dependencies, scripts, and the overall structure, returning structured metadata.

generate_readme

Generates a complete, formatted README.md for the project based on analysis and detected metadata.