setup_guidance
Initialize workflows and establish structured patterns to enforce disciplined programming practices during the setup phase.
Instructions
Get guidance for the SETUP phase - initialize workflow and establish patterns
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:209-223 (handler)Dispatch handler in the MCP tool call request processor that specifically handles the 'setup_guidance' tool by calling handlePhaseGuidance with the phase name and session manager.// Phase guidance tools (automatically route based on session configuration) case 'setup_guidance': case 'audit_inventory_guidance': case 'compare_analyze_guidance': case 'question_determine_guidance': case 'refactor_guidance': case 'lint_guidance': case 'iterate_guidance': case 'present_guidance': return { content: [{ type: 'text', text: JSON.stringify(await handlePhaseGuidance(name, sessionManager), null, 2) }] };
- src/tools/phaseGuidance.ts:7-11 (schema)Tool schema definition including name, description, and empty input schema for setup_guidance.{ name: 'setup_guidance', description: 'Get guidance for the SETUP phase - initialize workflow and establish patterns', inputSchema: { type: 'object', properties: {} } },
- src/index.ts:144-147 (registration)Registration of phase guidance tools (including setup_guidance) into the main tools array provided to the MCP server.// Phase guidance tools ...createPhaseGuidanceTools(), // Handles both suggestive and directive modes createTestGuidanceTool(), // TEST phase guidance
- src/tools/phaseGuidance.ts:52-65 (handler)Primary handler function for phase guidance tools. For setup_guidance, determines if directive or suggestive mode and delegates to the appropriate guidance provider.export async function handlePhaseGuidance( phaseName: string, sessionManager: SessionManager ): Promise<PhaseGuidance> { const session = sessionManager.getSession(); const isDirectiveMode = session?.workflowConfig !== undefined; // Route to appropriate guidance based on mode if (isDirectiveMode) { return getDirectiveGuidance(phaseName, sessionManager); } else { return getSuggestiveGuidance(phaseName, sessionManager); } }
- src/tools/phaseGuidance.ts:77-110 (helper)Guidance data structure for setup_guidance in suggestive mode, containing phase objectives, instructions, suggested approach, notes, and expected outputs.setup_guidance: { phase: 'SETUP', objective: 'Initialize workflow environment and establish clear file organization patterns', instructions: [ '--- ENVIRONMENT SETUP ---', 'Verify your current working directory', 'Understand the project structure and context', 'Confirm available tools and capabilities', '--- FILE ORGANIZATION PATTERN ---', 'Workflow outputs will be organized in: structured-workflow/{task-name}/', 'This is the default location (customizable via --output-dir)', 'All phase documents will use numbered prefixes: 00-setup, 01-audit, etc.', 'Create your documentation content following this pattern' ], suggestedApproach: [ 'List your current working directory path', 'Identify the main project files relevant to the task', 'Document the default output pattern: structured-workflow/{task-name}/', 'Confirm you understand where documentation will be created' ], importantNotes: [ 'This phase establishes the foundation for organized workflow execution', 'The file pattern shown (structured-workflow/{task-name}/) is the expected location', 'All subsequent phases will follow this numbered documentation pattern', 'Understanding this pattern now prevents confusion later' ], expectedOutput: { workingDirectory: 'Current working directory path', projectContext: 'Brief description of the project', outputPattern: 'Confirmation of structured-workflow/{task-name}/ pattern', toolsAvailable: 'List of available analysis and file tools' }, nextPhase: 'Use audit_inventory_guidance to begin analyzing the codebase' },