Skip to main content

Tutorials

Learning-oriented guides for newcomers

Available Guidesโ€‹

This section contains tutorials documentation following the Diataxis framework.

Tutorials are learning-oriented and help newcomers get started:

  • Take the reader through a process step by step
  • Focus on learning by doing
  • Ensure the reader succeeds in accomplishing something
  • Build confidence through success

๐Ÿ” Research-Driven Architectureโ€‹

All tutorials now feature research-driven workflows that query your live environment instead of relying on static analysis alone:

  • Cascading Source Hierarchy: Project Files โ†’ Knowledge Graph โ†’ Environment Resources โ†’ Web Search
  • Confidence Scoring: Every result includes a 0-1 confidence score
  • Live Infrastructure Detection: Automatically discovers Docker, Kubernetes, OpenShift, Podman, Ansible
  • Red Hat Ecosystem Support: First-class support for OpenShift (oc), Podman, and Ansible
  • ADR Validation: Check if documented decisions match actual implementation

๐Ÿง  Context File - Your Project's Memoryโ€‹

Every tutorial teaches you to use .mcp-server-context.md - the auto-generated file that tracks your progress, patterns, and decisions:

  • ๐Ÿ’ก In Tutorial 1: Learn to track your progress with @.mcp-server-context.md
  • ๐Ÿ”„ In Tutorial 2: Resume work seamlessly by reviewing past analysis
  • ๐ŸŽฏ In Tutorial 3: Master advanced decision-making with pattern analysis

Just use @.mcp-server-context.md in your AI assistant to access your project's living memory!

Key Research-Driven Toolsโ€‹

  • perform_research: Ask questions about your project and get confidence-scored answers
  • validate_adr: Validate a single ADR against live infrastructure
  • validate_all_adrs: Batch validate all ADRs with environment checks
  • analyze_deployment_progress: Research-enhanced deployment readiness analysis
  • generate_deployment_guidance: Infrastructure-aware deployment recommendations

Contentsโ€‹

Getting Startedโ€‹

Specialized Workflowsโ€‹

Example ADRs from Our Codebaseโ€‹