Skip to main content

๐Ÿ“š Documentation Navigation - Diataxis Framework

Find exactly what you need based on your current goal.

๐Ÿ—๏ธ Documentation Architectureโ€‹


๐ŸŽฏ 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โ€‹

Specialized Learning Pathsโ€‹

๐Ÿ‘จโ€๐ŸŽ“ 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โ€‹

Workflow Solutionsโ€‹

Specific Tasksโ€‹

๐Ÿšจ 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โ€‹

Configuration Referenceโ€‹

Schemas and Formatsโ€‹

  • ADR Templates

    • Standard formats, MADR templates, Y-statements
  • JSON Schemas

    • 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โ€‹

Design Decisionsโ€‹

Advanced Topicsโ€‹

๐Ÿค” Want to understand the bigger picture? Start with Understanding MCP.


๐Ÿงญ Quick Navigationโ€‹

By Experience Levelโ€‹

By Use Caseโ€‹

By Problem Typeโ€‹


๐Ÿ“Š 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.