📚 MCP ADR Analysis Server Documentation
Welcome to the comprehensive documentation for the MCP ADR Analysis Server. Our documentation follows the Diataxis framework to help you find exactly what you need based on your current goal.
🎯 Not sure where to start? → Use our guided documentation navigator
🚀 Quick Start Paths
🎓 New to MCP or ADRs?
Start here → Your First MCP Analysis Tutorial
- 30-minute hands-on learning experience
- No prior MCP knowledge required
- Creates your first architectural decision record
🛠️ Need to solve a specific problem?
Go here → How-To Guides or Troubleshooting
- Step-by-step solutions for common tasks
- Problem-focused guidance
- Ready-to-use examples
📖 Looking for specific tool information?
Check → Complete API Reference
- All 37 tools documented with examples
- Parameter details and usage patterns
- Quick navigation and search
💡 Want to understand the concepts?
Read → Understanding MCP
- Why MCP matters for architecture work
- How AI-assisted analysis works
- Design principles and philosophy
📋 Documentation Structure
Our documentation is organized using the Diataxis framework for maximum usability:
🎓 Tutorials - Learn by doing
Step-by-step learning experiences that teach concepts through hands-on practice:
- First Steps - Your introduction to MCP analysis
- Existing Projects - Working with established codebases
- Advanced Analysis - Security, deployment, performance
🛠️ How-To Guides - Solve specific problems
Task-oriented guides for accomplishing specific goals:
- Troubleshooting - Fix common issues quickly
- Generate ADRs from PRD - Convert requirements to decisions
- Work with Existing ADRs - Enhance current documentation
- Bootstrap Architecture Docs - Start from scratch
- Deploy Your Own Server - Set up custom instances
📖 Reference - Look up specific information
Comprehensive API documentation and technical specifications:
- Complete API Reference - All tools, parameters, examples
- Usage Examples - Practical tool usage patterns
- Environment Configuration - Setup and configuration details
💡 Explanation - Understand concepts and design
Background information and conceptual understanding:
- Understanding MCP - Core protocol concepts
- Server Architecture - How the server works
- AI Workflow Concepts - AI-assisted architecture
- Framework Design Documents - APE, Reflexion, Knowledge Generation
🎯 Choose Your Path
By Experience Level
- 🆕 Complete Beginner: First Steps Tutorial
- 📚 Some Experience: API Reference + Advanced Tutorial
- 🏆 Expert User: How-To Guides for specific tasks
By Project Type
- 🚀 New Project with Requirements: Generate ADRs from PRD
- 🏗️ Existing Project with ADRs: Work with Existing ADRs
- 📋 No Existing Documentation: Bootstrap Architecture Docs
By Current Need
- 🆘 Having Problems: Troubleshooting Guide
- 🔍 Need Tool Info: Complete API Reference
- 🎓 Want to Learn: Tutorials
- 🧠 Understanding Concepts: Explanation
🆘 Need Help?
Quick Problem Solving
- Error or Issue? → Troubleshooting Guide
- Tool Not Working? → API Reference for correct usage
- Concept Unclear? → MCP Concepts for understanding
Community Support
- GitHub Issues: Report bugs or request features
- Discussions: Share experiences and get community help
- Documentation Feedback: Help us improve these guides
📊 What's New
Recent Improvements
✅ Complete API Reference - All 37 tools now fully documented
✅ Diataxis Framework - Restructured for better navigation
✅ Learning Tutorials - Hands-on learning experiences
✅ Better Problem Solving - Targeted how-to guides
Coming Soon
- 🎥 Video tutorials for complex workflows
- 🔧 Interactive tool explorer
- 📱 Mobile-friendly documentation
- 🌐 Multi-language support
📈 Success Metrics
After using this documentation, you should have:
✅ Clear Understanding - Know what MCP is and how it helps architecture work
✅ Practical Skills - Can run analysis and generate ADRs confidently
✅ Problem-Solving Ability - Can troubleshoot issues and optimize workflows
✅ Reference Knowledge - Know where to find specific tool information quickly
Ready to get started? → Choose your path with our documentation navigator
This documentation is continuously improved based on user feedback and evolving best practices. Contribute improvements or suggest changes.