code-auditor-mcp 2.6.2 → 3.0.1

package/dist/mcp-tools/workflowGuide.js

@@ -9,34 +9,34 @@ export const WORKFLOW_SCENARIOS = {
         steps: [
             {
                 order: 1,
-                tool: 'start_audit',
-                parameters: { path: '.', analyzers: ['solid', 'dry', 'documentation'], indexFunctions: true, generateCodeMap: true },
+                tool: 'audit',
+                parameters: { action: 'start', path: '.', analyzers: ['solid', 'dry', 'documentation'], indexFunctions: true, generateCodeMap: true },
                 description: 'Start comprehensive background audit and capture jobId'
             },
             {
                 order: 2,
-                tool: 'audit_status',
-                parameters: { jobId: 'job_xxx_xxx' },
+                tool: 'audit',
+                parameters: { action: 'status', jobId: 'job_xxx_xxx' },
                 description: 'Poll until completed and capture resultId'
             },
             {
                 order: 3,
-                tool: 'generate_ai_config',
-                parameters: { tools: ['cursor', 'claude'] },
+                tool: 'config',
+                parameters: { action: 'generate', tools: ['cursor', 'claude'] },
                 description: 'Set up AI tool configurations for the project',
                 condition: 'If you plan to use AI assistants with this project'
             },
             {
                 order: 4,
-                tool: 'search_code',
-                parameters: { query: 'TODO FIXME' },
+                tool: 'search',
+                parameters: { action: 'query', query: 'TODO FIXME' },
                 description: 'Find any outstanding tasks or issues marked in code'
             }
         ],
         tips: [
             'Code maps are generated by default with paginated sections to avoid large responses',
             'The code map shows directory structure, function counts, and documentation quality',
-            'Use get_code_map_section with the returned mapId to view specific sections (overview, files, dependencies, documentation)',
+            'Use code_map.get with the returned mapId to view specific sections (overview, files, dependencies, documentation)',
             'Documentation analysis is included by default to check JSDoc coverage',
             'Functions are automatically indexed for future searches',
             'Search operators become available after indexing'
@@ -48,32 +48,32 @@ export const WORKFLOW_SCENARIOS = {
         steps: [
             {
                 order: 1,
-                tool: 'start_audit',
-                parameters: { path: './src/components', analyzers: ['react', 'documentation'], indexFunctions: true },
+                tool: 'audit',
+                parameters: { action: 'start', path: './src/components', analyzers: ['react', 'documentation'], indexFunctions: true },
                 description: 'Start background audit for components directory'
             },
             {
                 order: 2,
-                tool: 'audit_status',
-                parameters: { jobId: 'job_xxx_xxx' },
+                tool: 'audit',
+                parameters: { action: 'status', jobId: 'job_xxx_xxx' },
                 description: 'Poll to completion before reading result pages'
             },
             {
                 order: 3,
-                tool: 'search_code',
-                parameters: { query: 'entity:component' },
+                tool: 'search',
+                parameters: { action: 'query', query: 'entity:component' },
                 description: 'List all React components in the codebase'
             },
             {
                 order: 4,
-                tool: 'search_code',
-                parameters: { query: 'component:functional hook:useState' },
+                tool: 'search',
+                parameters: { action: 'query', query: 'component:functional hook:useState' },
                 description: 'Find functional components using state'
             },
             {
                 order: 5,
-                tool: 'search_code',
-                parameters: { query: 'prop:onClick' },
+                tool: 'search',
+                parameters: { action: 'query', query: 'prop:onClick' },
                 description: 'Find components accepting onClick handlers'
             }
         ],
@@ -89,40 +89,40 @@ export const WORKFLOW_SCENARIOS = {
         steps: [
             {
                 order: 1,
-                tool: 'audit_health',
-                parameters: { path: './src', threshold: 80, generateCodeMap: true },
+                tool: 'audit',
+                parameters: { action: 'health', path: './src', threshold: 80, generateCodeMap: true },
                 description: 'Quick health check with code map to understand structure and identify issues'
             },
             {
                 order: 2,
-                tool: 'start_audit',
-                parameters: { path: './src', analyzers: ['solid', 'dry', 'documentation'], minSeverity: 'warning' },
+                tool: 'audit',
+                parameters: { action: 'start', path: './src', analyzers: ['solid', 'dry', 'documentation'], minSeverity: 'warning' },
                 description: 'Start detailed background audit if health check shows issues',
                 condition: 'If health score is below threshold'
             },
             {
                 order: 3,
-                tool: 'audit_status',
-                parameters: { jobId: 'job_xxx_xxx' },
+                tool: 'audit',
+                parameters: { action: 'status', jobId: 'job_xxx_xxx' },
                 description: 'Poll until completed and capture resultId',
                 condition: 'After starting detailed audit'
             },
             {
                 order: 4,
-                tool: 'search_code',
-                parameters: { query: 'complexity:8-10' },
+                tool: 'search',
+                parameters: { action: 'query', query: 'complexity:8-10' },
                 description: 'Find high complexity functions that may need refactoring'
             },
             {
                 order: 5,
-                tool: 'find_definition',
-                parameters: { name: 'functionName' },
+                tool: 'search',
+                parameters: { action: 'definition', name: 'functionName' },
                 description: 'Look up specific function definitions during review'
             }
         ],
         tips: [
             'Code maps provide a visual overview of the codebase structure with paginated sections',
-            'Use get_code_map_section to view specific parts (overview, files, dependencies, documentation)',
+            'Use code_map.get to view specific parts (overview, files, dependencies, documentation)',
             'High complexity functions and poor documentation are flagged in the map',
             'Documentation violations are now included by default in all audits',
             'Functions are indexed during audit for fast lookup'
@@ -134,28 +134,28 @@ export const WORKFLOW_SCENARIOS = {
         steps: [
             {
                 order: 1,
-                tool: 'sync_index',
-                parameters: { mode: 'sync' },
+                tool: 'index',
+                parameters: { action: 'sync' },
                 description: 'Ensure index is up to date',
                 condition: 'If you have made recent changes'
             },
             {
                 order: 2,
-                tool: 'search_code',
-                parameters: { query: 'natural language query' },
+                tool: 'search',
+                parameters: { action: 'query', query: 'natural language query' },
                 description: 'Search using natural language (e.g., "validate user input")'
             },
             {
                 order: 3,
-                tool: 'search_code',
-                parameters: { query: 'lang:typescript file:utils' },
+                tool: 'search',
+                parameters: { action: 'query', query: 'lang:typescript file:utils' },
                 description: 'Use operators to filter results'
             }
         ],
         tips: [
             'Natural language search uses synonym expansion',
             'Combine text search with operators for precision',
-            'Use find_definition for exact function lookup'
+            'Use search.definition for exact function lookup'
         ]
     },
     'maintenance': {
@@ -164,32 +164,32 @@ export const WORKFLOW_SCENARIOS = {
         steps: [
             {
                 order: 1,
-                tool: 'start_audit',
-                parameters: { path: '.', analyzers: ['solid', 'dry', 'documentation', 'security'] },
+                tool: 'audit',
+                parameters: { action: 'start', path: '.', analyzers: ['solid', 'dry', 'documentation', 'security'] },
                 description: 'Start full background audit to identify issues'
             },
             {
                 order: 2,
-                tool: 'audit_status',
-                parameters: { jobId: 'job_xxx_xxx' },
+                tool: 'audit',
+                parameters: { action: 'status', jobId: 'job_xxx_xxx' },
                 description: 'Poll until completed and use resultId for paged reads'
             },
             {
                 order: 3,
-                tool: 'search_code',
-                parameters: { query: 'console.log debug' },
+                tool: 'search',
+                parameters: { action: 'query', query: 'console.log debug' },
                 description: 'Find debug statements to remove'
             },
             {
                 order: 4,
-                tool: 'sync_index',
-                parameters: { mode: 'cleanup' },
+                tool: 'index',
+                parameters: { action: 'cleanup' },
                 description: 'Clean up stale entries from deleted files'
             }
         ],
         tips: [
             'Regular audits help maintain code quality',
-            'sync_index cleanup removes entries for deleted files',
+            'index.cleanup removes entries for deleted files',
             'Search for common antipatterns like console.log'
         ]
     },
@@ -199,32 +199,32 @@ export const WORKFLOW_SCENARIOS = {
         steps: [
             {
                 order: 1,
-                tool: 'audit_health',
-                parameters: { path: '.', generateCodeMap: true },
+                tool: 'audit',
+                parameters: { action: 'health', path: '.', generateCodeMap: true },
                 description: 'Generate a code map to understand overall structure and architecture'
             },
             {
                 order: 2,
-                tool: 'search_code',
-                parameters: { query: 'entity:component' },
+                tool: 'search',
+                parameters: { action: 'query', query: 'entity:component' },
                 description: 'List all React components to understand UI architecture'
             },
             {
                 order: 3,
-                tool: 'search_code',
-                parameters: { query: 'depends-on:database deps:prisma' },
+                tool: 'search',
+                parameters: { action: 'query', query: 'depends-on:database deps:prisma' },
                 description: 'Find data access patterns and database usage'
             },
             {
                 order: 4,
-                tool: 'search_code',
-                parameters: { query: 'file:route file:api' },
+                tool: 'search',
+                parameters: { action: 'query', query: 'file:route file:api' },
                 description: 'Locate API endpoints and routing logic'
             }
         ],
         tips: [
             'Code maps show directory structure, complexity, and documentation quality at a glance',
-            'Maps are now paginated - use get_code_map_section to view specific sections',
+            'Maps are now paginated - use code_map.get to view specific sections',
             'Start with the overview section to understand architectural patterns',
             'Use dependency searches to trace data flow',
             'File path searches help locate specific functionality'
@@ -236,36 +236,36 @@ export const WORKFLOW_SCENARIOS = {
         steps: [
             {
                 order: 1,
-                tool: 'start_audit',
-                parameters: { path: '.', analyzers: ['solid'], minSeverity: 'warning', analyzerConcurrency: 2 },
+                tool: 'audit',
+                parameters: { action: 'start', path: '.', analyzers: ['solid'], minSeverity: 'warning', analyzerConcurrency: 2 },
                 description: 'Start a background audit and get a jobId immediately'
             },
             {
                 order: 2,
-                tool: 'audit_status',
-                parameters: { jobId: 'job_xxx_xxx' },
+                tool: 'audit',
+                parameters: { action: 'status', jobId: 'job_xxx_xxx' },
                 description: 'Poll until status is completed and capture resultId',
                 condition: 'Repeat while status is queued or running'
             },
             {
                 order: 3,
-                tool: 'audit_results',
-                parameters: { resultId: 'audit_xxx_xxx', offset: 0, limit: 25 },
+                tool: 'audit',
+                parameters: { action: 'results', resultId: 'audit_xxx_xxx', offset: 0, limit: 25 },
                 description: 'Fetch first page of violations with resultId'
             },
             {
                 order: 4,
-                tool: 'audit_results',
-                parameters: { resultId: 'audit_xxx_xxx', offset: 25, limit: 25 },
+                tool: 'audit',
+                parameters: { action: 'results', resultId: 'audit_xxx_xxx', offset: 25, limit: 25 },
                 description: 'Fetch next pages using offset/limit only',
                 condition: 'When pagination.hasMore is true'
             }
         ],
         tips: [
             'Use minSeverity:"warning" to filter out info-level suggestions',
-            'start_audit is non-blocking; heavy work runs in the background',
-            'audit_status returns resultId only when the run is completed',
-            'audit_results is read-only and never starts a new audit',
+            'audit.start is non-blocking; heavy work runs in the background',
+            'audit.status returns resultId only when the run is completed',
+            'audit.results is read-only and never starts a new audit',
             'Use analyzerConcurrency:2 or 3 for faster runs on large projects',
             'Tune workerCount and maxRetries for large shard-heavy audits'
         ]
@@ -276,32 +276,32 @@ export const WORKFLOW_SCENARIOS = {
         steps: [
             {
                 order: 1,
-                tool: 'audit_health',
-                parameters: { path: '.', generateCodeMap: true },
+                tool: 'audit',
+                parameters: { action: 'health', path: '.', generateCodeMap: true },
                 description: 'Generate a paginated code map during health check'
             },
             {
                 order: 2,
-                tool: 'list_code_map_sections',
-                parameters: { mapId: 'map_xxx_xxx' },
+                tool: 'code_map',
+                parameters: { action: 'list', mapId: 'map_xxx_xxx' },
                 description: 'List all available sections in the generated code map'
             },
             {
                 order: 3,
-                tool: 'get_code_map_section',
-                parameters: { mapId: 'map_xxx_xxx', sectionType: 'overview' },
+                tool: 'code_map',
+                parameters: { action: 'get', mapId: 'map_xxx_xxx', sectionType: 'overview' },
                 description: 'View the overview section for high-level structure and metrics'
             },
             {
                 order: 4,
-                tool: 'get_code_map_section',
-                parameters: { mapId: 'map_xxx_xxx', sectionType: 'files' },
+                tool: 'code_map',
+                parameters: { action: 'get', mapId: 'map_xxx_xxx', sectionType: 'files' },
                 description: 'View detailed file analysis with complexity and documentation scores'
             },
             {
                 order: 5,
-                tool: 'get_code_map_section',
-                parameters: { mapId: 'map_xxx_xxx', sectionType: 'documentation' },
+                tool: 'code_map',
+                parameters: { action: 'get', mapId: 'map_xxx_xxx', sectionType: 'documentation' },
                 description: 'View documentation analysis with specific violations and suggestions'
             }
         ],
@@ -309,7 +309,7 @@ export const WORKFLOW_SCENARIOS = {
             'Code maps are automatically paginated to avoid overwhelming responses',
             'The mapId is returned in the initial audit response for section retrieval',
             'Each section provides focused information: overview (stats), files (detailed analysis), dependencies (imports/exports), documentation (JSDoc violations)',
-            'Use list_code_map_sections to see all available sections and their sizes',
+            'Use code_map.list to see all available sections and their sizes',
             'Code maps are stored in-memory and cleared when the server restarts'
         ]
     },
@@ -319,14 +319,15 @@ export const WORKFLOW_SCENARIOS = {
         steps: [
             {
                 order: 1,
-                tool: 'get_analyzer_config',
-                parameters: {},
+                tool: 'config',
+                parameters: { action: 'get' },
                 description: 'Check current analyzer configurations'
             },
             {
                 order: 2,
-                tool: 'set_analyzer_config',
+                tool: 'config',
                 parameters: {
+                    action: 'set',
                     analyzerName: 'solid',
                     config: {
                         maxUnrelatedResponsibilities: 3,
@@ -339,8 +340,9 @@ export const WORKFLOW_SCENARIOS = {
             },
             {
                 order: 3,
-                tool: 'set_analyzer_config',
+                tool: 'config',
                 parameters: {
+                    action: 'set',
                     analyzerName: 'dry',
                     config: {
                         minLineThreshold: 15,
@@ -352,30 +354,30 @@ export const WORKFLOW_SCENARIOS = {
             },
             {
                 order: 4,
-                tool: 'whitelist_detect',
-                parameters: { path: '.', autoPopulate: false },
+                tool: 'config',
+                parameters: { action: 'whitelist_detect', path: '.', autoPopulate: false },
                 description: 'Detect framework patterns for whitelisting'
             },
             {
                 order: 5,
-                tool: 'whitelist_add',
-                parameters: { name: 'MyContextProvider', type: 'framework-class' },
+                tool: 'config',
+                parameters: { action: 'whitelist_add', name: 'MyContextProvider', type: 'framework-class' },
                 description: 'Add specific exceptions for framework patterns'
             },
             {
                 order: 6,
-                tool: 'start_audit',
-                parameters: { path: '.', analyzers: ['solid', 'dry'] },
-                description: 'Start background audit with new configurations'
+                tool: 'audit',
+                parameters: { action: 'start', path: '.', analyzers: ['solid', 'dry'] },
+                description: 'Re-run audit with new configurations'
             }
         ],
         tips: [
             'Analyzer configs persist across all audit runs',
-            'Use set_analyzer_config once, benefit everywhere',
+            'Use config.set once, benefit everywhere',
             'Project-specific configs override global configs',
             'Context-aware thresholds auto-adjust for component patterns',
             'Combine whitelist and config for fine-grained control',
-            'Use reset_analyzer_config to revert to defaults'
+            'Use config.reset to revert to defaults'
         ]
     },
     'tolerance-configuration': {
@@ -384,20 +386,21 @@ export const WORKFLOW_SCENARIOS = {
         steps: [
             {
                 order: 1,
-                tool: 'start_audit',
-                parameters: { path: '.', analyzers: ['solid'] },
+                tool: 'audit',
+                parameters: { action: 'start', path: '.', analyzers: ['solid'] },
                 description: 'Start initial background audit to see default violations'
             },
             {
                 order: 2,
-                tool: 'get_analyzer_config',
-                parameters: { analyzerName: 'solid' },
+                tool: 'config',
+                parameters: { action: 'get', analyzerName: 'solid' },
                 description: 'Check current SOLID configuration'
             },
             {
                 order: 3,
-                tool: 'set_analyzer_config',
+                tool: 'config',
                 parameters: {
+                    action: 'set',
                     analyzerName: 'solid',
                     config: {
                         maxUnrelatedResponsibilities: 4,
@@ -417,8 +420,9 @@ export const WORKFLOW_SCENARIOS = {
             },
             {
                 order: 4,
-                tool: 'set_analyzer_config',
+                tool: 'config',
                 parameters: {
+                    action: 'set',
                     analyzerName: 'solid',
                     projectPath: '/path/to/project',
                     config: { maxUnrelatedResponsibilities: 5 }
@@ -428,9 +432,9 @@ export const WORKFLOW_SCENARIOS = {
             },
             {
                 order: 5,
-                tool: 'start_audit',
-                parameters: { path: '.', analyzers: ['solid'] },
-                description: 'Start follow-up background audit to validate reduced violations'
+                tool: 'audit',
+                parameters: { action: 'start', path: '.', analyzers: ['solid'] },
+                description: 'Re-run audit to validate reduced violations'
             }
         ],
         tips: [
@@ -439,7 +443,7 @@ export const WORKFLOW_SCENARIOS = {
             'Set checkUnrelatedResponsibilities: false to disable unrelated groups check',
             'Dashboard components get 2x multiplier by default (unless overridden)',
             'Project configs override global configs',
-            'Use get_analyzer_config without params to see all configs'
+            'Use config.get without params to see all configs'
         ]
     },
     'dependency-analysis': {
@@ -448,34 +452,34 @@ export const WORKFLOW_SCENARIOS = {
         steps: [
             {
                 order: 1,
-                tool: 'start_audit',
-                parameters: { path: '.', indexFunctions: true },
+                tool: 'audit',
+                parameters: { action: 'start', path: '.', indexFunctions: true },
                 description: 'Start background audit to ensure functions are indexed with dependency tracking'
             },
             {
                 order: 2,
-                tool: 'search_code',
-                parameters: { query: 'dep:lodash' },
+                tool: 'search',
+                parameters: { action: 'query', query: 'dep:lodash' },
                 description: 'Find all functions using a specific dependency',
                 condition: 'To see impact of updating/removing a package'
             },
             {
                 order: 3,
-                tool: 'search_code',
-                parameters: { query: 'calls:calculateTotal' },
+                tool: 'search',
+                parameters: { action: 'query', query: 'calls:calculateTotal' },
                 description: 'Find all functions that call a specific function',
                 condition: 'To understand impact before refactoring'
             },
             {
                 order: 4,
-                tool: 'search_code',
-                parameters: { query: 'dependents-of:authenticate' },
+                tool: 'search',
+                parameters: { action: 'query', query: 'dependents-of:authenticate' },
                 description: 'Find what depends on a function you want to change'
             },
             {
                 order: 5,
-                tool: 'search_code',
-                parameters: { query: 'unused-imports' },
+                tool: 'search',
+                parameters: { action: 'query', query: 'unused-imports' },
                 description: 'Find and clean up unused imports with improved accuracy'
             }
         ],
@@ -502,17 +506,17 @@ export function getWorkflowGuide(scenario) {
 export function getWorkflowTips() {
     return {
         'general': [
-            'Start audits explicitly with start_audit (no implicit long-running scans)',
-            'Use audit_health for quick checks before detailed analysis',
+            'Start audits explicitly with audit.start (no implicit long-running scans)',
+            'Use audit.health for quick checks before detailed analysis',
             'Documentation analysis is now included by default in all audits',
             'Code maps are generated by default with paginated sections',
             'Combine natural language with operators in search queries',
             'React components are automatically detected in .tsx/.jsx files',
             'Improved TypeScript support with better type-only import detection',
-            'Poll audit_status and use resultId once status is completed',
-            'Audit results are paginated - use audit_results with limit and offset',
+            'Poll audit.status and use resultId once status is completed',
+            'Audit results are paginated - use audit.results with limit and offset',
             'Analyzer configs persist - set once, use everywhere',
-            'Use set_analyzer_config to adjust tolerances for your architecture'
+            'Use config.set to adjust tolerances for your architecture'
         ],
         'search-operators': [
             'entity:component - Find all React components',
@@ -525,35 +529,35 @@ export function getWorkflowTips() {
         'performance': [
             'Index is built during audit, no separate indexing needed',
             'Use specific paths in audit to analyze only changed code',
-            'search_code is fast even on large codebases',
-            'find_definition is optimized for exact name lookup',
+            'search.query is fast even on large codebases',
+            'search.definition is optimized for exact name lookup',
             'For partitioned runs, workerCount scales shard execution across CPU cores',
             'Use shardTimeoutMs and maxRetries to balance resilience vs. latency'
         ],
         'pagination': [
             'Default limit is 50 violations per request (max 100)',
             'Use offset parameter to get subsequent pages',
-            'Run start_audit, then poll audit_status for completion',
-            'When completed, use audit_status.resultId with audit_results',
-            'Example: audit_results(resultId: "...", offset: 25, limit: 25)',
+            'Run audit.start, then poll audit.status for completion',
+            'When completed, use audit.status.resultId with audit.results',
+            'Example: audit.results(resultId: "...", offset: 25, limit: 25)',
             'Cached results expire after 24 hours'
         ],
         'analyzer-config': [
-            'set_analyzer_config persists settings across all audits',
+            'config.set persists settings across all audits',
             'Global configs apply to all projects by default',
             'Project-specific configs override global ones',
             'maxUnrelatedResponsibilities controls component complexity',
             'contextAwareThresholds auto-adjusts for patterns (Dashboard, Form, etc)',
-            'Use get_analyzer_config to check current settings',
-            'reset_analyzer_config reverts to defaults'
+            'Use config.get to check current settings',
+            'config.reset reverts to defaults'
         ],
         'code-maps': [
             'Code maps are paginated automatically to manage response sizes',
-            'Use get_code_map_section with mapId to view specific sections',
+            'Use code_map.get with mapId to view specific sections',
             'Available sections: overview, files, dependencies, documentation',
-            'list_code_map_sections shows all available sections and their sizes',
+            'code_map.list shows all available sections and their sizes',
             'Maps are stored in-memory and cleared on server restart',
-            'generateCodeMap defaults to true in audit and audit_health tools'
+            'generateCodeMap defaults to true in audit and audit.health tools'
         ]
     };
 }