mcp-adr-analysis-server 1.1.0

package/dist/src/tools/research-question-tool.js

@@ -0,0 +1,333 @@
+/**
+ * MCP Tool for research question generation
+ * Implements prompt-driven research question generation and task tracking
+ */
+import { McpAdrError } from '../types/index.js';
+/**
+ * Generate research questions and create research tracking system
+ */
+export async function generateResearchQuestions(args) {
+    const { analysisType = 'comprehensive', researchContext, problems, knowledgeGraph, relevantKnowledge, researchQuestions, currentProgress, projectPath = process.cwd(), adrDirectory = 'docs/adrs', } = args;
+    try {
+        const { correlateProblemKnowledge, findRelevantAdrPatterns, generateContextAwareQuestions, createResearchTaskTracking, } = await import('../utils/research-questions.js');
+        switch (analysisType) {
+            case 'correlation': {
+                if (!problems || !knowledgeGraph) {
+                    throw new McpAdrError('Problems and knowledge graph are required for correlation analysis', 'INVALID_INPUT');
+                }
+                const result = await correlateProblemKnowledge(problems, knowledgeGraph);
+                return {
+                    content: [
+                        {
+                            type: 'text',
+                            text: `# Problem-Knowledge Correlation Analysis
+
+${result.instructions}
+
+## AI Correlation Prompt
+
+${result.correlationPrompt}
+
+## Next Steps
+
+1. **Submit the prompt** to an AI agent for comprehensive correlation analysis
+2. **Parse the JSON response** to get problem-knowledge correlations and research opportunities
+3. **Review knowledge gaps** and prioritize research areas
+4. **Use findings** to generate targeted research questions
+
+## Expected Output
+
+The AI will provide:
+- **Correlation Analysis**: Statistical analysis of problem-knowledge relationships
+- **Problem Correlations**: Detailed mapping of problems to knowledge elements
+- **Knowledge Gaps**: Identified gaps in the architectural knowledge graph
+- **Research Opportunities**: Prioritized opportunities for research investigation
+- **Recommendations**: Actionable recommendations for research planning
+
+## Research Planning Benefits
+
+This correlation analysis enables:
+- **Targeted Research**: Focus research on areas with highest impact
+- **Gap Identification**: Discover missing knowledge areas
+- **Priority Setting**: Rank research opportunities by importance
+- **Resource Optimization**: Allocate research resources effectively
+- **Risk Mitigation**: Address high-severity problems through research
+`,
+                        },
+                    ],
+                };
+            }
+            case 'relevance': {
+                if (!researchContext) {
+                    throw new McpAdrError('Research context is required for relevance analysis', 'INVALID_INPUT');
+                }
+                const result = await findRelevantAdrPatterns({
+                    ...researchContext,
+                    constraints: researchContext.constraints || [],
+                    timeline: researchContext.timeline || 'Not specified',
+                }, adrDirectory);
+                return {
+                    content: [
+                        {
+                            type: 'text',
+                            text: `# Relevant ADR and Pattern Discovery
+
+${result.instructions}
+
+## AI Relevance Prompt
+
+${result.relevancePrompt}
+
+## Next Steps
+
+1. **Submit the prompt** to an AI agent for relevance analysis
+2. **Parse the JSON response** to get relevant ADRs and patterns
+3. **Review research implications** and constraints
+4. **Use findings** to inform research question generation
+
+## Expected Output
+
+The AI will provide:
+- **Relevance Analysis**: Statistical analysis of ADR and pattern relevance
+- **Relevant ADRs**: ADRs that directly or indirectly relate to research context
+- **Relevant Patterns**: Architectural patterns applicable to the research
+- **Research Implications**: Constraints, opportunities, dependencies, and conflicts
+- **Research Guidance**: Specific guidance for research approach and methodology
+
+## Research Context Benefits
+
+This relevance analysis provides:
+- **Informed Research**: Research grounded in existing architectural decisions
+- **Constraint Awareness**: Understanding of limitations and boundaries
+- **Opportunity Recognition**: Identification of improvement opportunities
+- **Conflict Avoidance**: Early identification of potential conflicts
+- **Knowledge Leverage**: Building on existing architectural knowledge
+`,
+                        },
+                    ],
+                };
+            }
+            case 'questions': {
+                if (!researchContext || !relevantKnowledge) {
+                    throw new McpAdrError('Research context and relevant knowledge are required for question generation', 'INVALID_INPUT');
+                }
+                const result = await generateContextAwareQuestions({
+                    ...researchContext,
+                    constraints: researchContext.constraints || [],
+                    timeline: researchContext.timeline || 'Not specified',
+                }, relevantKnowledge, projectPath);
+                return {
+                    content: [
+                        {
+                            type: 'text',
+                            text: `# Context-Aware Research Question Generation
+
+${result.instructions}
+
+## AI Question Generation Prompt
+
+${result.questionPrompt}
+
+## Next Steps
+
+1. **Submit the prompt** to an AI agent for comprehensive question generation
+2. **Parse the JSON response** to get structured research questions and plan
+3. **Review research plan** and prioritize questions
+4. **Create research tasks** using the task tracking system
+
+## Expected Output
+
+The AI will provide:
+- **Research Question Generation**: Metadata and quality metrics for generated questions
+- **Primary Questions**: Core research questions with detailed specifications
+- **Secondary Questions**: Supporting questions for comprehensive coverage
+- **Methodological Questions**: Questions about research approach and methodology
+- **Research Plan**: Phased research plan with timelines and dependencies
+- **Quality Assurance**: Quality control and validation approach
+- **Expected Impact**: Anticipated benefits and outcomes of the research
+
+## Research Excellence
+
+This question generation ensures:
+- **Comprehensive Coverage**: All aspects of research topic addressed
+- **Actionable Questions**: Questions that can be answered through research
+- **Context Awareness**: Questions tailored to project and architectural context
+- **Priority Guidance**: Clear prioritization for research execution
+- **Quality Standards**: Built-in quality assurance and validation
+`,
+                        },
+                    ],
+                };
+            }
+            case 'tracking': {
+                if (!researchQuestions) {
+                    throw new McpAdrError('Research questions are required for task tracking', 'INVALID_INPUT');
+                }
+                const result = await createResearchTaskTracking(researchQuestions.map(q => ({
+                    ...q,
+                    complexity: 'medium',
+                    expectedOutcome: 'Research findings and recommendations',
+                    successCriteria: ['Clear findings documented', 'Recommendations provided'],
+                    relatedKnowledge: [],
+                    resources: [],
+                    risks: [],
+                    dependencies: [],
+                })), currentProgress);
+                return {
+                    content: [
+                        {
+                            type: 'text',
+                            text: `# Research Task Tracking System
+
+${result.instructions}
+
+## AI Tracking Prompt
+
+${result.trackingPrompt}
+
+## Next Steps
+
+1. **Submit the prompt** to an AI agent for tracking system creation
+2. **Parse the JSON response** to get comprehensive tracking system
+3. **Implement tracking** in project management tools
+4. **Begin research execution** with regular progress updates
+
+## Expected Output
+
+The AI will provide:
+- **Research Task Tracking**: Overall tracking metadata and configuration
+- **Research Tasks**: Detailed tasks with progress tracking and dependencies
+- **Milestones**: Key milestones and checkpoints for research phases
+- **Risk Management**: Risk identification and mitigation strategies
+- **Progress Metrics**: Quantitative progress measurements and KPIs
+- **Communication Plan**: Stakeholder communication and reporting framework
+- **Quality Assurance**: Quality control and validation processes
+- **Recommendations**: Process and management improvement recommendations
+
+## Research Management
+
+This tracking system enables:
+- **Progress Monitoring**: Real-time visibility into research progress
+- **Risk Management**: Proactive identification and mitigation of risks
+- **Resource Planning**: Effective allocation and utilization of resources
+- **Quality Control**: Consistent quality standards and validation
+- **Stakeholder Communication**: Regular updates and transparent reporting
+`,
+                        },
+                    ],
+                };
+            }
+            case 'comprehensive': {
+                if (!researchContext) {
+                    throw new McpAdrError('Research context is required for comprehensive analysis', 'INVALID_INPUT');
+                }
+                // Generate all components for comprehensive research planning
+                const relevanceResult = await findRelevantAdrPatterns({
+                    ...researchContext,
+                    constraints: researchContext.constraints || [],
+                    timeline: researchContext.timeline || 'Not specified',
+                }, adrDirectory);
+                return {
+                    content: [
+                        {
+                            type: 'text',
+                            text: `# Comprehensive Research Question Generation
+
+This comprehensive analysis will generate a complete research planning system with questions, tracking, and management.
+
+## Research Context
+**Topic**: ${researchContext.topic}
+**Category**: ${researchContext.category}
+**Scope**: ${researchContext.scope}
+**Objectives**: ${researchContext.objectives.join(', ')}
+**Timeline**: ${researchContext.timeline || 'Not specified'}
+
+## Comprehensive Workflow
+
+### 1. **Relevance Analysis** (First Step)
+Identify relevant ADRs and patterns for the research context.
+
+${relevanceResult.instructions}
+
+#### Relevance Analysis Prompt
+${relevanceResult.relevancePrompt}
+
+### 2. **Research Question Generation** (Second Step)
+Generate context-aware research questions based on relevance analysis:
+\`\`\`json
+{
+  "tool": "generate_research_questions",
+  "args": {
+    "analysisType": "questions",
+    "researchContext": ${JSON.stringify(researchContext)},
+    "relevantKnowledge": [results from step 1],
+    "projectPath": "${projectPath}"
+  }
+}
+\`\`\`
+
+### 3. **Task Tracking System** (Third Step)
+Create comprehensive task tracking for research execution:
+\`\`\`json
+{
+  "tool": "generate_research_questions",
+  "args": {
+    "analysisType": "tracking",
+    "researchQuestions": [results from step 2]
+  }
+}
+\`\`\`
+
+### 4. **Problem Correlation** (Optional Fourth Step)
+If problems are identified, correlate them with knowledge graph:
+\`\`\`json
+{
+  "tool": "generate_research_questions",
+  "args": {
+    "analysisType": "correlation",
+    "problems": [identified problems],
+    "knowledgeGraph": [project knowledge graph]
+  }
+}
+\`\`\`
+
+## Expected Outcomes
+
+This comprehensive approach will provide:
+- **Complete Research Framework**: End-to-end research planning and execution
+- **Context-Aware Questions**: Questions tailored to project and architectural context
+- **Systematic Tracking**: Comprehensive task and progress management
+- **Quality Assurance**: Built-in quality control and validation
+- **Risk Management**: Proactive risk identification and mitigation
+- **Stakeholder Communication**: Clear reporting and communication framework
+
+## Research Excellence Standards
+
+All generated research components follow these principles:
+- **Evidence-Based**: Grounded in architectural decisions and project context
+- **Actionable**: Questions and tasks that can be executed effectively
+- **Measurable**: Clear success criteria and progress metrics
+- **Prioritized**: Ranked by impact, effort, and strategic importance
+- **Quality-Focused**: Built-in quality assurance and validation processes
+
+## Implementation Guidance
+
+1. **Start with Relevance**: Understand existing architectural context
+2. **Generate Questions**: Create comprehensive, actionable research questions
+3. **Plan Execution**: Develop detailed task tracking and management
+4. **Monitor Progress**: Use tracking system for regular progress updates
+5. **Ensure Quality**: Apply quality assurance throughout research process
+`,
+                        },
+                    ],
+                };
+            }
+            default:
+                throw new McpAdrError(`Unknown analysis type: ${analysisType}`, 'INVALID_INPUT');
+        }
+    }
+    catch (error) {
+        throw new McpAdrError(`Failed to generate research questions: ${error instanceof Error ? error.message : String(error)}`, 'RESEARCH_QUESTION_ERROR');
+    }
+}
+//# sourceMappingURL=research-question-tool.js.map

package/dist/src/tools/research-question-tool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"research-question-tool.js","sourceRoot":"","sources":["../../../src/tools/research-question-tool.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAAC,IA8C/C;IACC,MAAM,EACJ,YAAY,GAAG,eAAe,EAC9B,eAAe,EACf,QAAQ,EACR,cAAc,EACd,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,WAAW,GAAG,OAAO,CAAC,GAAG,EAAE,EAC3B,YAAY,GAAG,WAAW,GAC3B,GAAG,IAAI,CAAC;IAET,IAAI,CAAC;QACH,MAAM,EACJ,yBAAyB,EACzB,uBAAuB,EACvB,6BAA6B,EAC7B,0BAA0B,GAC3B,GAAG,MAAM,MAAM,CAAC,gCAAgC,CAAC,CAAC;QAEnD,QAAQ,YAAY,EAAE,CAAC;YACrB,KAAK,aAAa,CAAC,CAAC,CAAC;gBACnB,IAAI,CAAC,QAAQ,IAAI,CAAC,cAAc,EAAE,CAAC;oBACjC,MAAM,IAAI,WAAW,CACnB,oEAAoE,EACpE,eAAe,CAChB,CAAC;gBACJ,CAAC;gBAED,MAAM,MAAM,GAAG,MAAM,yBAAyB,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;gBAEzE,OAAO;oBACL,OAAO,EAAE;wBACP;4BACE,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE;;EAElB,MAAM,CAAC,YAAY;;;;EAInB,MAAM,CAAC,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;CA0BzB;yBACY;qBACF;iBACF,CAAC;YACJ,CAAC;YAED,KAAK,WAAW,CAAC,CAAC,CAAC;gBACjB,IAAI,CAAC,eAAe,EAAE,CAAC;oBACrB,MAAM,IAAI,WAAW,CACnB,qDAAqD,EACrD,eAAe,CAChB,CAAC;gBACJ,CAAC;gBAED,MAAM,MAAM,GAAG,MAAM,uBAAuB,CAC1C;oBACE,GAAG,eAAe;oBAClB,WAAW,EAAE,eAAe,CAAC,WAAW,IAAI,EAAE;oBAC9C,QAAQ,EAAE,eAAe,CAAC,QAAQ,IAAI,eAAe;iBACtD,EACD,YAAY,CACb,CAAC;gBAEF,OAAO;oBACL,OAAO,EAAE;wBACP;4BACE,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE;;EAElB,MAAM,CAAC,YAAY;;;;EAInB,MAAM,CAAC,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;CA0BvB;yBACY;qBACF;iBACF,CAAC;YACJ,CAAC;YAED,KAAK,WAAW,CAAC,CAAC,CAAC;gBACjB,IAAI,CAAC,eAAe,IAAI,CAAC,iBAAiB,EAAE,CAAC;oBAC3C,MAAM,IAAI,WAAW,CACnB,8EAA8E,EAC9E,eAAe,CAChB,CAAC;gBACJ,CAAC;gBAED,MAAM,MAAM,GAAG,MAAM,6BAA6B,CAChD;oBACE,GAAG,eAAe;oBAClB,WAAW,EAAE,eAAe,CAAC,WAAW,IAAI,EAAE;oBAC9C,QAAQ,EAAE,eAAe,CAAC,QAAQ,IAAI,eAAe;iBACtD,EACD,iBAAiB,EACjB,WAAW,CACZ,CAAC;gBAEF,OAAO;oBACL,OAAO,EAAE;wBACP;4BACE,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE;;EAElB,MAAM,CAAC,YAAY;;;;EAInB,MAAM,CAAC,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4BtB;yBACY;qBACF;iBACF,CAAC;YACJ,CAAC;YAED,KAAK,UAAU,CAAC,CAAC,CAAC;gBAChB,IAAI,CAAC,iBAAiB,EAAE,CAAC;oBACvB,MAAM,IAAI,WAAW,CACnB,mDAAmD,EACnD,eAAe,CAChB,CAAC;gBACJ,CAAC;gBAED,MAAM,MAAM,GAAG,MAAM,0BAA0B,CAC7C,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;oBAC1B,GAAG,CAAC;oBACJ,UAAU,EAAE,QAAQ;oBACpB,eAAe,EAAE,uCAAuC;oBACxD,eAAe,EAAE,CAAC,2BAA2B,EAAE,0BAA0B,CAAC;oBAC1E,gBAAgB,EAAE,EAAE;oBACpB,SAAS,EAAE,EAAE;oBACb,KAAK,EAAE,EAAE;oBACT,YAAY,EAAE,EAAE;iBACjB,CAAC,CAAC,EACH,eAAe,CAChB,CAAC;gBAEF,OAAO;oBACL,OAAO,EAAE;wBACP;4BACE,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE;;EAElB,MAAM,CAAC,YAAY;;;;EAInB,MAAM,CAAC,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6BtB;yBACY;qBACF;iBACF,CAAC;YACJ,CAAC;YAED,KAAK,eAAe,CAAC,CAAC,CAAC;gBACrB,IAAI,CAAC,eAAe,EAAE,CAAC;oBACrB,MAAM,IAAI,WAAW,CACnB,yDAAyD,EACzD,eAAe,CAChB,CAAC;gBACJ,CAAC;gBAED,8DAA8D;gBAC9D,MAAM,eAAe,GAAG,MAAM,uBAAuB,CACnD;oBACE,GAAG,eAAe;oBAClB,WAAW,EAAE,eAAe,CAAC,WAAW,IAAI,EAAE;oBAC9C,QAAQ,EAAE,eAAe,CAAC,QAAQ,IAAI,eAAe;iBACtD,EACD,YAAY,CACb,CAAC;gBAEF,OAAO;oBACL,OAAO,EAAE;wBACP;4BACE,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE;;;;;aAKP,eAAe,CAAC,KAAK;gBAClB,eAAe,CAAC,QAAQ;aAC3B,eAAe,CAAC,KAAK;kBAChB,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC;gBACvC,eAAe,CAAC,QAAQ,IAAI,eAAe;;;;;;;EAOzD,eAAe,CAAC,YAAY;;;EAG5B,eAAe,CAAC,eAAe;;;;;;;;;yBASR,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC;;sBAElC,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwDhC;yBACY;qBACF;iBACF,CAAC;YACJ,CAAC;YAED;gBACE,MAAM,IAAI,WAAW,CAAC,0BAA0B,YAAY,EAAE,EAAE,eAAe,CAAC,CAAC;QACrF,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,WAAW,CACnB,0CAA0C,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAClG,yBAAyB,CAC1B,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/src/tools/rule-generation-tool.d.ts

@@ -0,0 +1,49 @@
+/**
+ * MCP Tools for rule generation and validation
+ * Implements prompt-driven architectural rule management
+ */
+/**
+ * Generate architectural rules from ADRs and code patterns
+ */
+export declare function generateRules(args: {
+    source?: 'adrs' | 'patterns' | 'both';
+    adrDirectory?: string;
+    projectPath?: string;
+    existingRules?: Array<{
+        id: string;
+        name: string;
+        description: string;
+    }>;
+    outputFormat?: 'json' | 'yaml' | 'both';
+}): Promise<any>;
+/**
+ * Validate code against architectural rules
+ */
+export declare function validateRules(args: {
+    filePath?: string;
+    fileContent?: string;
+    fileName?: string;
+    rules: Array<{
+        id: string;
+        name: string;
+        description: string;
+        pattern: string;
+        severity: string;
+        message: string;
+    }>;
+    validationType?: 'file' | 'function' | 'component' | 'module';
+    reportFormat?: 'summary' | 'detailed' | 'json';
+}): Promise<any>;
+/**
+ * Create machine-readable rule set
+ */
+export declare function createRuleSet(args: {
+    name: string;
+    description?: string;
+    adrRules?: any[];
+    patternRules?: any[];
+    rules?: any[];
+    outputFormat?: 'json' | 'yaml' | 'both';
+    author?: string;
+}): Promise<any>;
+//# sourceMappingURL=rule-generation-tool.d.ts.map

package/dist/src/tools/rule-generation-tool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rule-generation-tool.d.ts","sourceRoot":"","sources":["../../../src/tools/rule-generation-tool.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;GAEG;AACH,wBAAsB,aAAa,CAAC,IAAI,EAAE;IACxC,MAAM,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,CAAC;IACtC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,KAAK,CAAC;QACpB,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC,CAAC;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CACzC,GAAG,OAAO,CAAC,GAAG,CAAC,CA0Nf;AAED;;GAEG;AACH,wBAAsB,aAAa,CAAC,IAAI,EAAE;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,KAAK,CAAC;QACX,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC,CAAC;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC9D,YAAY,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,MAAM,CAAC;CAChD,GAAG,OAAO,CAAC,GAAG,CAAC,CAuHf;AAED;;GAEG;AACH,wBAAsB,aAAa,CAAC,IAAI,EAAE;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC;IACjB,YAAY,CAAC,EAAE,GAAG,EAAE,CAAC;IACrB,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,GAAG,OAAO,CAAC,GAAG,CAAC,CAqIf"}