📚 Documentation Navigation - Diataxis Framework
Find exactly what you need based on your current goal.
🎯 What do you want to do right now?
🎓 I want to LEARN → Tutorials
"Teach me how to use this step-by-step"
When to use: You're new to MCP or architectural decision records, want to understand concepts through hands-on practice.
🛠️ I want to SOLVE → How-To Guides
"Help me fix this specific problem"
When to use: You have a specific issue, error, or task you need to accomplish right now.
📖 I want to LOOK UP → Reference
"What are the exact parameters for this tool?"
When to use: You know what tool you want to use but need exact syntax, parameters, or options.
💡 I want to UNDERSTAND → Explanation
"Why does this work this way?"
When to use: You want to understand the deeper concepts, design decisions, and architectural principles.
🎓 Tutorials
Learning-oriented • Step-by-step • Safe to experiment
Start here if you're new to MCP ADR Analysis or want to build your skills systematically.
Getting Started Series
- 30 minutes • Beginner
- Install server, run first analysis, create your first ADR
Working with Existing Projects
- 45 minutes • Beginner
- Analyze codebases with existing architecture, discover implicit decisions
- 60 minutes • Intermediate
- Security scanning, deployment readiness, performance analysis
Specialized Learning Paths
- 90 minutes • Intermediate
- End-to-end security analysis and ADR generation workflow
- 60 minutes • Advanced
- Multi-developer ADR processes, review workflows, knowledge sharing
👨🎓 New to architectural decision records? Start with Your First MCP Analysis
🛠️ How-To Guides
Problem-solving • Goal-oriented • Real scenarios
Use these when you need to solve a specific problem or accomplish a particular task.
Common Problems
- Fix installation problems, resolve errors, diagnose issues
- Detect sensitive content, configure masking, secure deployments
- Validate production readiness, run final checks, create deployment plans
Workflow Solutions
- Convert existing documentation, preserve history, establish new processes
- Automate ADR validation, enforce architectural rules, track compliance
- Multi-repository setups, federated decision tracking, governance workflows
Specific Tasks
Generate ADRs from Requirements
- Convert PRD documents, structure decisions, maintain traceability
- Monitor ADR implementation, identify blockers, report status
- Define architectural constraints, validate compliance, enforce standards
🚨 Having an issue right now? Check Troubleshooting first.
📖 Reference
Information-oriented • Systematic • Comprehensive
Complete documentation for when you need exact details about tools, parameters, and APIs.
Complete API Documentation
- Complete API Reference 📋
- All 37 tools with parameters, examples, and usage patterns
- Quick navigation and search functionality
- Common usage patterns and workflows
Tool Categories
- Project analysis, context extraction, ecosystem understanding
- ADR creation, TODO generation, documentation synthesis
- Content scanning, masking, credential detection
- Progress tracking, rule validation, deployment readiness
Configuration Reference
- All configuration options, default values, environment setup
- Claude Desktop, Cursor, other MCP clients setup
Schemas and Formats
- Standard formats, MADR templates, Y-statements
- Tool parameters, response formats, data structures
🔍 Looking for a specific tool? Use the API Reference search.
💡 Explanation
Understanding-oriented • Conceptual • Background
Deep-dive into concepts, design decisions, and the "why" behind the architecture.
Core Concepts
- What is Model Context Protocol, how it works, why it matters
Architectural Decision Records
- ADR principles, best practices, decision-making frameworks
- How AI enhances architectural analysis, human-AI collaboration
Design Decisions
- Why we chose this design, tradeoffs, alternative approaches
- Principles behind tool organization, naming, parameter design
- Threat model, protection strategies, privacy considerations
Advanced Topics
- How we build and maintain project understanding over time
- APE, Knowledge Generation, Reflexion frameworks explained
- How the server handles large projects, optimization strategies
🤔 Want to understand the bigger picture? Start with Understanding MCP.
🧭 Quick Navigation
By Experience Level
- New to MCP: First Steps Tutorial → MCP Concepts
- New to ADRs: ADR Philosophy → Generate Your First ADR
- Experienced User: API Reference → Advanced Techniques
By Use Case
- Personal Projects: First Steps → Existing Projects
- Team Projects: Team Collaboration → Large Team Scaling
- Enterprise: Security Workflow → CI/CD Integration
By Problem Type
- Installation/Setup: Troubleshooting
- Security Concerns: Security Analysis
- Performance Issues: Performance Design
- Integration Questions: CI/CD Integration
📊 Documentation Quality Metrics
This documentation follows the Diataxis framework for maximum usability:
- ✅ Tutorials: Learn by doing with safe, guided practice
- ✅ How-To Guides: Solve real problems with proven solutions
- ✅ Reference: Look up exact information quickly and reliably
- ✅ Explanation: Understand concepts and design decisions deeply
Quick Feedback
Found what you needed? Missing something important? Improve this documentation
Can't find what you need? Search the complete API reference or file an issue to help us improve the documentation.