Skip to main content

Documentation Guide

Welcome to the MCP ADR Analysis Server documentation. Our documentation follows the Diataxis framework - a systematic approach to technical documentation organized by user intent.

Documentation Structure​

Tutorials (Learning-Oriented)​

Step-by-step guides that take you through a series of steps to complete a project. Best for newcomers who want to learn by doing.

How-To Guides (Task-Oriented)​

Practical guides that help you accomplish specific tasks. Best for practitioners who know what they want to do.

Reference (Information-Oriented)​

Technical descriptions of the machinery and how to operate it. Best for users who need to look up specific details.

Explanation (Understanding-Oriented)​

Discussions that clarify and illuminate concepts. Best for learners who want to understand the bigger picture.

Quick Start Paths​

New to MCP ADR Analysis Server?​

  1. Read What is MCP? in the README
  2. Follow the First Steps Tutorial
  3. Explore the API Reference

Setting Up for Your Team?​

  1. Review Architecture Overview
  2. Follow the Installation Guide
  3. Configure ADR Aggregator for cross-team visibility

Troubleshooting Issues?​

  1. Check the Troubleshooting Guide
  2. Review MCP Client Compatibility
  3. Search GitHub Issues

About Diataxis​

The Diataxis framework recognizes that documentation serves different purposes for different users at different times:

TypePurposeUser Need
TutorialsLearning"I want to learn"
How-To GuidesGoals"I want to accomplish X"
ReferenceInformation"I need to know about Y"
ExplanationUnderstanding"I want to understand why"

By organizing our documentation this way, we help you find exactly what you need, when you need it.

Contributing to Documentation​

Found an issue or want to improve our docs? See the Contributing Guide for how to submit changes.