generate_prd_from_readme
Convert README files into structured Product Requirements Documents (PRDs) to streamline documentation processes and save time.
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-86 (handler)The main handler logic for the 'generate_prd_from_readme' tool. It reads the README file content using fs.readFile, constructs a PRD markdown template by incorporating parts of the README and fixed sections, and returns it as text content in the expected MCP format.
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}`); } } - server/index.js:30-39 (schema)The input schema defining the expected arguments for the tool: an object with a required 'readme_path' string property.
inputSchema: { type: "object", properties: { readme_path: { type: "string", description: "Path to README file", }, }, required: ["readme_path"], }, - server/index.js:26-43 (registration)The tool registration in the ListTools response, including name, description, and input schema.
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"], }, }, ], }; });