📖 Complete API Reference
MCP ADR Analysis Server - All available tools, parameters, and usage examples
Version: 2.0.7 | Tools: 37 available | Updated: January 2025
🎯 Quick Navigation
Core Analysis Tools
analyze_project_ecosystem
- Comprehensive project analysisget_architectural_context
- Architectural context extractiondiscover_existing_adrs
- ADR discovery and cataloging
ADR Generation & Management
generate_adrs_from_prd
- Generate ADRs from PRDgenerate_adr_from_decision
- Create ADR from decision datasuggest_adrs
- Suggest missing ADRsgenerate_adr_todo
- Extract TODO items from ADRs
Security & Content Protection
analyze_content_security
- Detect sensitive contentgenerate_content_masking
- Create masking instructionsapply_basic_content_masking
- Apply content maskingvalidate_content_masking
- Validate masking results
Project Health & Scoring
smart_score
- Project health scoring coordinationcompare_adr_progress
- Progress validationdeployment_readiness
- Deployment readiness check
Workflow & Development
troubleshoot_guided_workflow
- Systematic troubleshootingget_workflow_guidance
- Intelligent workflow recommendationsget_development_guidance
- Development roadmap guidance
Research & Documentation
generate_research_questions
- Research question generationcreate_research_template
- Research template creationincorporate_research
- Integrate research findings
Rules & Validation
generate_rules
- Generate architectural rulesvalidate_rules
- Validate code against rulescreate_rule_set
- Create machine-readable rules
Deployment & Operations
smart_git_push
- Security-focused git operationsgenerate_deployment_guidance
- Deployment instructionsanalyze_deployment_progress
- Deployment progress analysis
File Operations
read_file
- Read file contentswrite_file
- Write file contentslist_directory
- List directory contents
System Management
manage_cache
- Cache management operationsconfigure_output_masking
- Output masking configurationcheck_ai_execution_status
- AI execution status check
🔧 Core Analysis Tools
analyze_project_ecosystem
Purpose: Comprehensive recursive project ecosystem analysis with advanced prompting techniques
Use Cases:
- Initial project understanding
- Complete architecture analysis
- Knowledge graph building
- Context establishment for other tools
Parameters:
{
"projectPath": "string (required)",
"enhancedMode": "boolean (default: false)",
"knowledgeEnhancement": "boolean (default: false)",
"learningEnabled": "boolean (default: false)",
"includeEnvironment": "boolean (default: false)",
"recursiveDepth": "string (enum: 'shallow'|'medium'|'deep'|'comprehensive', default: 'medium')",
"conversationContext": "object (optional)",
"strictMode": "boolean (default: true)"
}
Example Usage:
{
"projectPath": ".",
"enhancedMode": true,
"knowledgeEnhancement": true,
"recursiveDepth": "comprehensive",
"includeEnvironment": true
}
Returns: Comprehensive project analysis including technology stack, architecture patterns, and recommendations.
get_architectural_context
Purpose: Get detailed architectural context for specific files or entire project
Parameters:
{
"filePath": "string (optional)",
"projectPath": "string (optional)",
"conversationContext": "object (optional)"
}
Example Usage:
{
"filePath": "src/components/UserService.ts",
"projectPath": "."
}
discover_existing_adrs
Purpose: Discover and catalog existing ADRs in the project
Parameters:
{
"adrDirectory": "string (default: 'docs/adrs')",
"projectPath": "string (optional)",
"conversationContext": "object (optional)"
}
Example Usage:
{
"adrDirectory": "architecture/decisions",
"projectPath": "."
}
📋 ADR Generation & Management
generate_adrs_from_prd
Purpose: Generate Architectural Decision Records from a Product Requirements Document
Parameters:
{
"prdPath": "string (required)",
"adrDirectory": "string (default: 'docs/adrs')",
"templateFormat": "string (enum: 'standard'|'y-statements'|'madr', default: 'standard')",
"projectPath": "string (optional)",
"conversationContext": "object (optional)"
}
Example Usage:
{
"prdPath": "PRD.md",
"adrDirectory": "docs/decisions",
"templateFormat": "madr"
}
generate_adr_from_decision
Purpose: Generate a complete ADR from decision data
Parameters:
{
"decisionData": "object (required)",
"adrDirectory": "string (default: 'docs/adrs')",
"templateFormat": "string (enum: 'standard'|'y-statements'|'madr', default: 'standard')",
"conversationContext": "object (optional)"
}
Example Usage:
{
"decisionData": {
"title": "Database Selection",
"context": "Need to choose primary database",
"decision": "PostgreSQL",
"rationale": "ACID compliance and JSON support",
"consequences": ["Better data integrity", "More complex setup"]
}
}
suggest_adrs
Purpose: Suggest architectural decisions with advanced prompting techniques
Parameters:
{
"projectPath": "string (optional)",
"adrDirectory": "string (default: 'docs/adrs')",
"conversationContext": "object (optional)",
"analysisScope": "string (enum: 'technology'|'architecture'|'security'|'deployment'|'all', default: 'all')",
"maxSuggestions": "number (default: 5)"
}
generate_adr_todo
Purpose: Generate TDD-focused todo.md from existing ADRs with JSON-first approach
Parameters:
{
"adrDirectory": "string (default: 'docs/adrs')",
"todoPath": "string (default: 'TODO.md')",
"todoFormat": "string (enum: 'markdown'|'json'|'both', default: 'both')",
"includePriorities": "boolean (default: true)",
"includeTimestamps": "boolean (default: true)",
"projectPath": "string (optional)",
"conversationContext": "object (optional)"
}
🛡️ Security & Content Protection
analyze_content_security
Purpose: Analyze content for sensitive information using AI-powered detection
Parameters:
{
"content": "string (required)",
"contentType": "string (enum: 'code'|'documentation'|'configuration'|'logs'|'general', default: 'general')",
"userDefinedPatterns": "array of strings (optional)"
}
Example Usage:
{
"content": "const apiKey = 'sk-1234567890abcdef';",
"contentType": "code",
"userDefinedPatterns": ["custom-secret-.*"]
}
generate_content_masking
Purpose: Generate masking instructions for detected sensitive content
Parameters:
{
"content": "string (required)",
"detectedItems": "array of objects (required)",
"maskingStrategy": "string (enum: 'full'|'partial'|'placeholder'|'environment', default: 'full')"
}
apply_basic_content_masking
Purpose: Apply basic content masking (fallback when AI is not available)
Parameters:
{
"content": "string (required)",
"maskingStrategy": "string (enum: 'full'|'partial'|'placeholder', default: 'full')"
}
validate_content_masking
Purpose: Validate that content masking was applied correctly
Parameters:
{
"originalContent": "string (required)",
"maskedContent": "string (required)"
}
configure_custom_patterns
Purpose: Configure custom sensitive patterns for a project
Parameters:
{
"projectPath": "string (required)",
"existingPatterns": "array of strings (optional)"
}
📊 Project Health & Scoring
smart_score
Purpose: Central coordination for project health scoring system
Parameters:
{
"operation": "string (enum: 'recalculate_scores'|'sync_scores'|'diagnose_scores'|'optimize_weights'|'reset_scores'|'get_score_trends'|'get_intent_scores', required)",
"projectPath": "string (optional)",
"components": "array (enum: 'task_completion'|'deployment_readiness'|'architecture_compliance'|'security_posture'|'code_quality'|'all', default: ['all'])",
"forceUpdate": "boolean (default: false)",
"updateSources": "boolean (default: true)"
}
Example Usage:
{
"operation": "recalculate_scores",
"projectPath": ".",
"components": ["deployment_readiness", "security_posture"],
"forceUpdate": true
}
compare_adr_progress
Purpose: Compare TODO.md progress against ADRs and current environment
Parameters:
{
"todoPath": "string (default: 'TODO.md')",
"adrDirectory": "string (default: 'docs/adrs')",
"projectPath": "string (optional)",
"includeEnvironmentCheck": "boolean (default: true)",
"conversationContext": "object (optional)",
"strictMode": "boolean (default: true)"
}
deployment_readiness
Purpose: Comprehensive deployment readiness analysis with zero-tolerance validation
Parameters:
{
"operation": "string (enum: 'check_readiness'|'validate_tests'|'security_scan'|'dependency_audit'|'all', required)",
"projectPath": "string (optional)",
"targetEnvironment": "string (enum: 'development'|'staging'|'production', default: 'production')",
"strictMode": "boolean (default: true)"
}
🔧 Workflow & Development
troubleshoot_guided_workflow
Purpose: Systematic failure analysis with test plan generation
Parameters:
{
"operation": "string (enum: 'analyze_failure'|'generate_test_plan'|'run_diagnostics'|'create_workflow', required)",
"failureInfo": "object (required for analyze_failure and generate_test_plan)",
"projectPath": "string (optional)",
"adrDirectory": "string (default: 'docs/adrs')",
"todoPath": "string (default: 'TODO.md')",
"conversationContext": "object (optional)"
}
Example Usage:
{
"operation": "analyze_failure",
"failureInfo": {
"failureType": "build_failure",
"failureDetails": "TypeScript compilation errors in authentication module",
"context": {
"reproducible": true,
"impact": "high"
}
}
}
get_workflow_guidance
Purpose: Get intelligent workflow guidance and tool recommendations
Parameters:
{
"goal": "string (required)",
"currentPhase": "string (enum: 'planning'|'development'|'testing'|'deployment', optional)",
"projectPath": "string (optional)",
"availableTime": "string (optional)",
"constraints": "array of strings (optional)",
"conversationContext": "object (optional)"
}
get_development_guidance
Purpose: Get comprehensive development guidance that translates architectural decisions into coding tasks
Parameters:
{
"developmentPhase": "string (enum: 'setup'|'implementation'|'testing'|'deployment'|'maintenance', required)",
"projectPath": "string (optional)",
"adrDirectory": "string (default: 'docs/adrs')",
"technologyStack": "array of strings (optional)",
"constraints": "array of strings (optional)",
"conversationContext": "object (optional)"
}
🔍 Research & Documentation
generate_research_questions
Purpose: Generate context-aware research questions and create research tracking system
Parameters:
{
"analysisType": "string (enum: 'technology'|'architecture'|'security'|'performance'|'compliance'|'general', required)",
"context": "string (optional)",
"existingKnowledge": "string (optional)",
"researchScope": "string (enum: 'narrow'|'medium'|'broad', default: 'medium')",
"maxQuestions": "number (default: 5)",
"conversationContext": "object (optional)"
}
create_research_template
Purpose: Create a research template file for documenting findings
Parameters:
{
"title": "string (required)",
"researchType": "string (enum: 'technology'|'architecture'|'security'|'performance'|'compliance'|'general', default: 'general')",
"templatePath": "string (optional)",
"includeMetadata": "boolean (default: true)"
}
incorporate_research
Purpose: Incorporate research findings into architectural decisions
Parameters:
{
"researchPath": "string (required)",
"targetAdr": "string (optional)",
"adrDirectory": "string (default: 'docs/adrs')",
"integrationMode": "string (enum: 'update_existing'|'create_new'|'suggest_changes', default: 'suggest_changes')",
"conversationContext": "object (optional)"
}
📏 Rules & Validation
generate_rules
Purpose: Generate architectural rules from ADRs and code patterns
Parameters:
{
"source": "string (enum: 'adrs'|'code'|'both', default: 'both')",
"adrDirectory": "string (default: 'docs/adrs')",
"projectPath": "string (optional)",
"ruleTypes": "array (enum: 'naming'|'structure'|'dependencies'|'patterns'|'security'|'all', default: ['all'])",
"outputFormat": "string (enum: 'markdown'|'json'|'yaml', default: 'markdown')",
"conversationContext": "object (optional)"
}
validate_rules
Purpose: Validate code against architectural rules
Parameters:
{
"filePath": "string (optional)",
"projectPath": "string (optional)",
"rulesPath": "string (optional)",
"ruleTypes": "array (enum: 'naming'|'structure'|'dependencies'|'patterns'|'security'|'all', default: ['all'])",
"outputFormat": "string (enum: 'detailed'|'summary'|'json', default: 'detailed')",
"conversationContext": "object (optional)"
}
create_rule_set
Purpose: Create machine-readable rule set in JSON/YAML format
Parameters:
{
"name": "string (required)",
"description": "string (optional)",
"rules": "array of objects (required)",
"outputPath": "string (optional)",
"format": "string (enum: 'json'|'yaml', default: 'json')"
}
🚀 Deployment & Operations
smart_git_push
Purpose: AI-driven security-focused git push with credential detection
Parameters:
{
"operation": "string (enum: 'push'|'security_check'|'commit_analysis'|'pre_push_validation', required)",
"projectPath": "string (optional)",
"commitMessage": "string (optional)",
"branch": "string (optional)",
"forceSecurityCheck": "boolean (default: true)",
"conversationContext": "object (optional)"
}
generate_deployment_guidance
Purpose: Generate deployment guidance and instructions from ADRs
Parameters:
{
"adrDirectory": "string (default: 'docs/adrs')",
"targetEnvironment": "string (enum: 'development'|'staging'|'production', required)",
"deploymentType": "string (enum: 'docker'|'kubernetes'|'serverless'|'traditional'|'auto-detect', default: 'auto-detect')",
"includeSecurityChecks": "boolean (default: true)",
"conversationContext": "object (optional)"
}
analyze_deployment_progress
Purpose: Analyze deployment progress and verify completion
Parameters:
{
"analysisType": "string (enum: 'pre_deployment'|'deployment_status'|'post_deployment'|'rollback_analysis', required)",
"targetEnvironment": "string (enum: 'development'|'staging'|'production', optional)",
"deploymentId": "string (optional)",
"projectPath": "string (optional)",
"conversationContext": "object (optional)"
}
📁 File Operations
read_file
Purpose: Read contents of a file
Parameters:
{
"path": "string (required)"
}
write_file
Purpose: Write content to a file
Parameters:
{
"path": "string (required)",
"content": "string (required)"
}
list_directory
Purpose: List contents of a directory
Parameters:
{
"path": "string (required)"
}
⚙️ System Management
manage_cache
Purpose: Manage MCP resource cache operations
Parameters:
{
"action": "string (enum: 'clear'|'stats'|'cleanup'|'invalidate', required)",
"key": "string (required for invalidate action)"
}
configure_output_masking
Purpose: Configure content masking for all MCP outputs
Parameters:
{
"enabled": "boolean (optional)",
"maskingLevel": "string (enum: 'basic'|'standard'|'strict', optional)",
"customPatterns": "array of strings (optional)"
}
check_ai_execution_status
Purpose: Check AI execution configuration and status for debugging
Parameters: None required
Example Usage:
{}
manage_todo_json
Purpose: JSON-first TODO management with consistent LLM interactions
Parameters:
{
"operation": "string (enum: 'create_task'|'update_task'|'delete_task'|'get_tasks'|'get_analytics'|'sync_to_markdown'|'import_from_markdown'|'get_health_score', required)",
"projectPath": "string (optional)",
"todoPath": "string (default: 'TODO.md')",
"task": "object (optional, for create/update operations)",
"taskId": "string (optional, for update/delete operations)"
}
analyze_environment
Purpose: Analyze environment context and provide optimization recommendations
Parameters:
{
"projectPath": "string (optional)",
"environmentType": "string (enum: 'development'|'staging'|'production'|'ci', optional)",
"includeOptimizations": "boolean (default: true)",
"conversationContext": "object (optional)"
}
request_action_confirmation
Purpose: Request confirmation before applying research-based changes
Parameters:
{
"action": "string (required)",
"description": "string (required)",
"risks": "array of strings (optional)",
"benefits": "array of strings (optional)"
}
🎯 Common Usage Patterns
New Project Setup
1. analyze_project_ecosystem (comprehensive analysis)
2. generate_adrs_from_prd (if PRD exists)
3. generate_adr_todo (create implementation tasks)
4. smart_score (establish baseline metrics)
Existing Project Analysis
1. discover_existing_adrs (catalog current decisions)
2. analyze_project_ecosystem (understand current state)
3. suggest_adrs (identify gaps)
4. compare_adr_progress (validate implementation)
Security Review
1. analyze_content_security (scan for sensitive content)
2. generate_content_masking (create protection)
3. smart_git_push (secure deployment)
4. deployment_readiness (final validation)
Troubleshooting
1. troubleshoot_guided_workflow (systematic analysis)
2. check_ai_execution_status (verify AI setup)
3. smart_score (check health metrics)
4. get_workflow_guidance (next steps)
📚 Related Documentation
- Getting Started Guides - Step-by-step usage scenarios
- Usage Guide - Practical examples and workflows
- Architecture Overview - Technical architecture details
- Troubleshooting Guide - Common issues and solutions
Last Updated: January 2025 | MCP ADR Analysis Server v2.0.7