generate_prd_from_readme
Generate a structured Product Requirements Document (PRD) from a README file by providing its path, automating documentation creation.
Instructions
Generate a PRD from a README file
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| readme_path | Yes | Path to README file |
Implementation Reference
- server/index.js:49-89 (handler)The main handler for the 'generate_prd_from_readme' tool. Reads a README file from the given path and generates a PRD template with basic project overview, description (first 5 lines), key features, technical requirements, and generation timestamp. Throws an error if the README file cannot be read.
if (name === "generate_prd_from_readme") { try { const readmeContent = await fs.readFile(args.readme_path, "utf-8"); const prdTemplate = ` # Product Requirements Document ## Project Overview Based on: ${args.readme_path} ## Description ${readmeContent.split("\n").slice(0, 5).join("\n")} ## 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: ${new Date().toISOString()} `; return { content: [ { type: "text", text: prdTemplate, }, ], }; } catch (error) { throw new Error(`Failed to read README: ${error.message}`); } } throw new Error(`Unknown tool: ${name}`); }); - server/index.js:30-39 (schema)Input schema for the 'generate_prd_from_readme' tool. Requires one parameter: 'readme_path' (string) specifying the path to the README file.
inputSchema: { type: "object", properties: { readme_path: { type: "string", description: "Path to README file", }, }, required: ["readme_path"], }, - server/index.js:24-43 (registration)Registration of the 'generate_prd_from_readme' tool via ListToolsRequestSchema handler. The tool is named 'generate_prd_from_readme' with description 'Generate a PRD from a README file'.
server.setRequestHandler(ListToolsRequestSchema, async () => { return { tools: [ { name: "generate_prd_from_readme", description: "Generate a PRD from a README file", inputSchema: { type: "object", properties: { readme_path: { type: "string", description: "Path to README file", }, }, required: ["readme_path"], }, }, ], }; });