# PRD Generator - Claude Desktop Extension

![PRD Generator Screenshot](images/prd-txt.png)

A simple Claude Desktop Extension (DXT) that generates Product Requirements Documents (PRDs) from README files with a single click.

## Features

- **One-click installation** - No complex setup or configuration files
- **Automatic PRD generation** from README files
- **File system access** - Read README files from any path
- **Time-saving documentation** - Generate structured PRDs in seconds
- **Cross-platform support** - Works on Windows, Mac, and Linux

## What This Extension Does

This extension provides a simple tool that:

1. Reads your project's README file
2. Extracts key information from the content
3. Generates a structured Product Requirements Document
4. Saves you time on documentation tasks

## Prerequisites

- **Claude Desktop** (latest version with DXT support)
- **Node.js** (bundled with Claude Desktop)
- **DXT Toolchain**: `npm install -g @anthropic-ai/dxt`

## Installation

### Option 1: Install Pre-built Extension

1. Download the latest `prd-generator.dxt` file from the releases
2. Open Claude Desktop
3. Go to **Settings > Extensions**
4. Drag the `.dxt` file into the window or click "Upload"
5. Click "Install"
6. Done!

### Option 2: Build from Source

```bash
# Clone the repository
git clone https://github.com/yourusername/prd-generator-dxt.git
cd prd-generator-dxt

# Install dependencies
npm install

# Test the server
npm start

# Package the extension
npx @anthropic-ai/dxt pack
```

## 🛠️ Usage

After installation, you can use the extension in Claude Desktop:

```markdown
Generate a PRD from my README at /path/to/your/readme.md
```

The extension will:

- Read your README file
- Extract the first 5 lines as the project description
- Generate a structured PRD with sections for:
  - Project Overview
  - Description
  - Key Features
  - Technical Requirements
  - Generation timestamp

## Project Structure

```markdown
prd-generator/
├── server/
│   └── index.js          # Main MCP server code
├── manifest.json         # Extension configuration
├── package.json         # Node.js dependencies
├── package-lock.json    # Dependency lock file
└── README.md           # This file
```

## 🔧 Development

### Running Locally

```bash
# Start the MCP server
npm start

# Or run directly
node server/index.js
```

### Building the Extension

```bash
# Package into .dxt file
npx @anthropic-ai/dxt pack
```

### Testing

1. Ensure your server runs without errors
2. Test with a sample README file
3. Verify the generated PRD format

## Generated PRD Format

The extension generates PRDs with the following structure:

```markdown
# Product Requirements Document

## Project Overview
Based on: [README file path]

## Description
[First 5 lines from README]

## Key Features
- Feature extraction from README
- Automated PRD generation
- Time-saving documentation

## Technical Requirements
- Node.js runtime
- File system access
- README file parsing

Generated on: [ISO timestamp]
```

## Contributing

1. Fork the repository
2. Create a feature branch: `git checkout -b feature/amazing-feature`
3. Commit your changes: `git commit -m 'Add amazing feature'`
4. Push to the branch: `git push origin feature/amazing-feature`
5. Open a Pull Request

## Todo / Future Enhancements

- [ ] Support for multiple README formats (rst, txt, etc.)
- [ ] Customizable PRD templates
- [ ] Integration with project management tools
- [ ] Advanced content extraction and analysis
- [ ] Support for configuration files (package.json, etc.)

## 🐛 Known Issues

- Path handling may vary between operating systems
- Large README files might cause performance issues
- Currently only supports UTF-8 encoded files

## 📚 Resources

- [Claude Desktop Extensions Documentation](https://docs.anthropic.com/claude/docs/desktop-extensions)
- [MCP SDK Documentation](https://docs.anthropic.com/claude/docs/mcp)
- [DXT Toolchain Repository](https://github.com/anthropic-ai/dxt)

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

**Note**: This is a basic implementation demonstrating Claude Desktop Extensions. For production use, consider adding error handling, input validation, and more sophisticated README parsing.

## 🚀 Quick Start

1. **Install Claude Desktop** (latest version)
2. **Download** the `.dxt` file
3. **Install** via Settings > Extensions
4. **Test** with: "Generate a PRD from my README at /path/to/readme.md"