Documentation Guide
Welcome to the MCP ADR Analysis Server documentation. This documentation follows the Diataxis framework, a systematic approach to technical documentation organized by user intent.
Version: 2.14.12 | Last reviewed: 2026-09-16
Quick start paths
New to the project?
- Read What is MCP? in the README
- Follow the First Steps tutorial
- Browse the API Reference
Setting up for your team?
- Review the Architecture Overview
- Follow the Installation Guide
- Configure MCP clients for your team
- (Optional) Enable the ADR Aggregator for cross-team visibility
Troubleshooting?
- Check the Troubleshooting Guide
- Review MCP Client Compatibility
- Search GitHub Issues
Tutorials (learning-oriented)
Step-by-step guides that walk you through a task from start to finish. Start here if you are new.
| Tutorial | Description |
|---|---|
| First Steps | Your first ADR analysis with the MCP server |
| Existing Projects | Integrate with an existing codebase |
| Advanced Analysis | Deep architectural analysis techniques |
| Security-Focused Workflow | Security-first development patterns |
| Team Collaboration | Working with teams on architectural decisions |
How-to guides (task-oriented)
Practical recipes for specific tasks. Use these when you know what you want to accomplish.
Getting started
| Guide | Description |
|---|---|
| Installation | Detailed installation instructions |
| MCP Client Setup | Configure Claude, Cursor, Cline, and other clients |
| VS Code Integration | Set up Cline, Continue, and native MCP in VS Code |
| Workflow Guidance | Development workflow and getting started |
| Prompting Guide | Effective prompts for the MCP server |
ADR management
| Guide | Description |
|---|---|
| Generate ADRs from PRD | New projects with a PRD.md |
| Work with Existing ADRs | Projects that already have ADRs |
| Bootstrap Architecture Docs | Projects without any ADRs |
| Interactive ADR Planning | Plan ADRs interactively |
| ADR Aggregator Integration | Cross-team ADR visibility |
Analysis and security
| Guide | Description |
|---|---|
| Security Analysis | Security analysis and content protection |
| Deployment Readiness | Validate deployment readiness |
| Research Integration | Research integration workflows |
Configuration and customization
| Guide | Description |
|---|---|
| Custom Rules | Custom rules and patterns |
| LLM Context File | Configure the server context file for LLM referencing |
| Server Context File | How the .mcp-server-context.md file works |
| Validated Patterns | Implement validated patterns |
| Validated Patterns with Live Sources | Use validated patterns with live authoritative sources |
| Dynamic Pattern Configuration | Dynamic pattern configuration system |
Development and CI/CD
| Guide | Description |
|---|---|
| Tool Development | Build new MCP tools |
| Testing Guide | Testing strategy and patterns |
| Performance Testing | Performance testing procedures |
| CI/CD Integration | Integrate with CI/CD pipelines |
| Large Team Scaling | Scale for large teams |
Publishing and deployment
| Guide | Description |
|---|---|
| Deploy Your Own Server | NPM publishing and deployment |
| Push Tags to NPM | Publishing workflow for npm |
| CE-MCP Migration Playbook | Migrate to CE-MCP execution mode |
| Contributing | How to contribute to the project |
Advanced frameworks
| Guide | Description |
|---|---|
| APE Implementation Strategy | Automatic Prompt Engineering implementation |
| APE Usage Guide | Using the APE framework |
| Reflexion Implementation | Reflexion framework implementation |
| Reflexion Usage Guide | Using the Reflexion framework |
| Knowledge Generation | Knowledge generation framework usage |
| Hybrid DAG Bootstrap | Hybrid DAG bootstrap validation loop |
| Tool Context Documentation | Tool context documentation system |
| Troubleshooting | Common issues and solutions |
Reference (information-oriented)
Technical specifications and lookup tables. Use these when you need exact details.
API and tools
| Reference | Description |
|---|---|
| API Reference | Complete tool documentation |
| Comprehensive API Reference | Extended API documentation with examples |
| API Documentation | API documentation overview |
| Usage Examples | Practical usage examples |
| Tool Surface Map | Map of all tool capabilities |
Tool categories
| Reference | Description |
|---|---|
| Analysis Tools | Code analysis tool specifications |
| Generation Tools | ADR and code generation tools |
| Security Tools | Security and content masking tools |
| Validation Tools | ADR and deployment validation tools |
Configuration
| Reference | Description |
|---|---|
| Environment Config | Environment variables and settings |
| MCP Client Config | MCP client configuration reference |
| Glossary | Terms and definitions |
| Mermaid Diagrams | Mermaid diagram reference |
Explanation (understanding-oriented)
Conceptual discussions that clarify the architecture and design decisions.
Architecture
| Explanation | Description |
|---|---|
| Architecture Overview | System design and components |
| Server Architecture | Detailed server internals |
| MCP Architecture Flow | Request and response flow |
| MCP Concepts | Understanding the Model Context Protocol |
| Tool Design | Tool design philosophy |
AI and analysis
| Explanation | Description |
|---|---|
| AI Architecture Concepts | AI integration patterns |
| AI Workflow Concepts | AI-powered workflow orchestration |
| Prompt Engineering | Prompt engineering techniques |
| Self-Learning Architecture | Adaptive analysis system |
Frameworks and design
| Explanation | Description |
|---|---|
| APE Framework Design | Automatic Prompt Engineering framework |
| Reflexion Framework Design | Reflexion framework design |
| Knowledge Generation Design | Knowledge generation framework |
| Knowledge Graph | Session and tool-usage tracker |
| Context File Coverage | How .mcp-server-context.md covers all tools |
Security and performance
| Explanation | Description |
|---|---|
| Security Philosophy | Security design principles |
| Performance Design | Performance optimization approach |
| ADR Philosophy | ADR philosophy and methodological pragmatism |
Other documentation
| Document | Description |
|---|---|
| DESIGN_DOC.md | Software Design Document (arc42) |
| ADRs | Architectural Decision Records (24 decisions) |
| CHANGELOG | Release history |
| RELEASES | Release policy and pipeline |
| SECURITY | Security policy and vulnerability reporting |
About Diataxis
The Diataxis framework organizes documentation by user intent:
| Type | Purpose | User need |
|---|---|---|
| Tutorials | Learning | "I want to learn" |
| How-to guides | Goals | "I want to accomplish X" |
| Reference | Information | "I need to know about Y" |
| Explanation | Understanding | "I want to understand why" |
Contributing to documentation
Found an issue or want to improve the docs? See the Contributing Guide.