3aee9bc840
* feat: Add --append flag to parsePRD command - Fixes #207 * chore: format * chore: implement tests to core logic and commands * feat: implement MCP for append flag of parse_prd tool * fix: append not considering existing tasks * chore: fix tests --------- Co-authored-by: Kresna Sucandra <kresnasucandra@gmail.com>
118 lines
3.5 KiB
JavaScript
118 lines
3.5 KiB
JavaScript
/**
|
|
* tools/parsePRD.js
|
|
* Tool to parse PRD document and generate tasks
|
|
*/
|
|
|
|
import { z } from 'zod';
|
|
import {
|
|
getProjectRootFromSession,
|
|
handleApiResult,
|
|
createErrorResponse
|
|
} from './utils.js';
|
|
import { parsePRDDirect } from '../core/task-master-core.js';
|
|
import {
|
|
resolveProjectPaths,
|
|
findPRDDocumentPath,
|
|
resolveTasksOutputPath
|
|
} from '../core/utils/path-utils.js';
|
|
|
|
/**
|
|
* Register the parsePRD tool with the MCP server
|
|
* @param {Object} server - FastMCP server instance
|
|
*/
|
|
export function registerParsePRDTool(server) {
|
|
server.addTool({
|
|
name: 'parse_prd',
|
|
description:
|
|
"Parse a Product Requirements Document (PRD) text file to automatically generate initial tasks. Reinitializing the project is not necessary to run this tool. It is recommended to run parse-prd after initializing the project and creating/importing a prd.txt file in the project root's scripts/ directory.",
|
|
parameters: z.object({
|
|
input: z
|
|
.string()
|
|
.optional()
|
|
.default('scripts/prd.txt')
|
|
.describe('Absolute path to the PRD document file (.txt, .md, etc.)'),
|
|
numTasks: z
|
|
.string()
|
|
.optional()
|
|
.describe(
|
|
'Approximate number of top-level tasks to generate (default: 10). As the agent, if you have enough information, ensure to enter a number of tasks that would logically scale with project complexity. Avoid entering numbers above 50 due to context window limitations.'
|
|
),
|
|
output: z
|
|
.string()
|
|
.optional()
|
|
.describe(
|
|
'Output path for tasks.json file (default: tasks/tasks.json)'
|
|
),
|
|
force: z
|
|
.boolean()
|
|
.optional()
|
|
.describe('Allow overwriting an existing tasks.json file.'),
|
|
append: z
|
|
.boolean()
|
|
.optional()
|
|
.describe(
|
|
'Append new tasks to existing tasks.json instead of overwriting'
|
|
),
|
|
projectRoot: z
|
|
.string()
|
|
.describe('The directory of the project. Must be absolute path.')
|
|
}),
|
|
execute: async (args, { log, session }) => {
|
|
try {
|
|
log.info(`Parsing PRD with args: ${JSON.stringify(args)}`);
|
|
|
|
// Get project root from args or session
|
|
const rootFolder =
|
|
args.projectRoot || getProjectRootFromSession(session, log);
|
|
|
|
if (!rootFolder) {
|
|
return createErrorResponse(
|
|
'Could not determine project root. Please provide it explicitly or ensure your session contains valid root information.'
|
|
);
|
|
}
|
|
|
|
// Resolve input (PRD) and output (tasks.json) paths using the utility
|
|
const { projectRoot, prdPath, tasksJsonPath } = resolveProjectPaths(
|
|
rootFolder,
|
|
args,
|
|
log
|
|
);
|
|
|
|
// Check if PRD path was found (resolveProjectPaths returns null if not found and not provided)
|
|
if (!prdPath) {
|
|
return createErrorResponse(
|
|
'No PRD document found or provided. Please ensure a PRD file exists (e.g., PRD.md) or provide a valid input file path.'
|
|
);
|
|
}
|
|
|
|
// Call the direct function with fully resolved paths
|
|
const result = await parsePRDDirect(
|
|
{
|
|
projectRoot: projectRoot,
|
|
input: prdPath,
|
|
output: tasksJsonPath,
|
|
numTasks: args.numTasks,
|
|
force: args.force,
|
|
append: args.append
|
|
},
|
|
log,
|
|
{ session }
|
|
);
|
|
|
|
if (result.success) {
|
|
log.info(`Successfully parsed PRD: ${result.data.message}`);
|
|
} else {
|
|
log.error(
|
|
`Failed to parse PRD: ${result.error?.message || 'Unknown error'}`
|
|
);
|
|
}
|
|
|
|
return handleApiResult(result, log, 'Error parsing PRD');
|
|
} catch (error) {
|
|
log.error(`Error in parse-prd tool: ${error.message}`);
|
|
return createErrorResponse(error.message);
|
|
}
|
|
}
|
|
});
|
|
}
|