🤖 AI Development Resources

Welcome to the AI development documentation for the M365 Security & SharePoint Analysis Toolkit!

🎯 Start Here

New to this project? → Read AI Agent Quick Start (15 minutes)

Looking for something specific? → See AI Development Index (Complete navigation)

📚 Core Documentation

Guide	Purpose	When to Read
AI Agent Quick Start	Fast onboarding with practical examples	First time contributing
Copilot Instructions	Complete architecture reference	Need deep understanding
AI Workflow Testing	Testing patterns and strategies	Writing or debugging tests
MCP Tool Patterns	MCP tool development	Building AI integrations
AI Development Index	Navigation hub for all resources	Finding specific information

🚀 Quick Links by Task

• Adding Python Script → Quick Start: Task 1
• Adding PowerShell Function → Quick Start: Task 2
• Processing CSV Files → Quick Start: Task 3
• Generating Excel Reports → Quick Start: Task 4
• Writing Tests → Workflow Testing: Patterns
• Building MCP Tools → MCP Patterns: Structure

🐛 Issue Templates

• AI Development Enhancement - Propose improvements to AI agent support
• Bug Report - Report bugs in the toolkit
• Feature Request - Request new features

⚠️ Important: Do not file empty issue templates. See How to Write Good Enhancement Issues.

🔧 Quick Command Reference

# Install dependencies
pip install -r requirements-dev.txt

# Run tests
python -m pytest tests/ -v --cov=scripts --cov=src

# Format code
black --line-length 120 scripts/ src/

# Lint code
flake8 scripts/ src/ --max-line-length 120

# Run Python script
python scripts/my_script.py --help

# Run PowerShell script
powershell.exe -NoProfile -ExecutionPolicy Bypass -File "scripts/powershell/MyScript.ps1"

📖 Documentation Philosophy

This project is built with AI-first development in mind:

1. Comprehensive Patterns: Every common task has documented patterns
2. Copy-Paste Ready: Examples are production-ready, not pseudocode
3. Error Handling: Common pitfalls are documented with solutions
4. Testing Focus: Every pattern includes testing examples
5. Quick Navigation: Multiple entry points for different needs

🎓 Learning Paths

For Python Developers (55 min)

1. AI Agent Quick Start → Python Tasks
2. Workflow Testing → File I/O Tests
3. Copilot Instructions → Full Reference

For PowerShell Developers (50 min)

1. AI Agent Quick Start → PowerShell Functions
2. Copilot Instructions → PowerShell Patterns

For MCP Tool Developers (80 min)

1. MCP Patterns → Architecture
2. MCP Patterns → All Patterns
3. Workflow Testing → Testing MCP Tools

For Test Engineers (60 min)

1. Workflow Testing → Quick Start
2. Workflow Testing → All Patterns

🆘 Getting Help

• Quick Questions: Check AI Agent Quick Start
• Testing Issues: See Workflow Testing: Troubleshooting
• Architecture Questions: Read Copilot Instructions
• File an Issue: Use AI Development Enhancement template

📊 Documentation Quality

• ✅ Onboarding Time: <15 minutes for common tasks
• ✅ Code Examples: Every pattern has working examples
• ✅ Test Coverage: All patterns have test examples
• ✅ Error Handling: Common errors documented with solutions
• ✅ Cross-Referenced: Easy navigation between related topics

---

🤖 These resources ensure AI agents can quickly understand and contribute to the M365 Security & SharePoint Analysis Toolkit!

For the complete navigation guide, see AI Development Index.