Notepad++ MCP Server

# 💻 Development Documentation **Guides, best practices, and lessons learned for developing notepadpp-mcp** --- ## 📚 **Documentation Index** ### **1. AI Development Rules** 📄 [AI_DEVELOPMENT_RULES.md](AI_DEVELOPMENT_RULES.md) **Guidelines for AI-assisted development** - Best practices for working with AI - Code quality standards - Testing requirements - Documentation expectations --- ### **2. AI Development Tools Comparison** 📄 [AI_DEVELOPMENT_TOOLS_COMPARISON.md](AI_DEVELOPMENT_TOOLS_COMPARISON.md) **Comparison of AI coding assistants** - Windsurf vs Cursor vs Claude Code - Feature comparisons - Strengths and weaknesses - Use case recommendations --- ### **3. Debugging Lessons Learned** 📄 [DEBUGGING_LESSONS_LEARNED.md](DEBUGGING_LESSONS_LEARNED.md) **Real-world debugging experiences** - Common issues encountered - Solutions that worked - Debugging strategies - Troubleshooting tips --- ### **4. Development Pain Points** 📄 [DEVELOPMENT_PAIN_POINTS.md](DEVELOPMENT_PAIN_POINTS.md) **Challenges and how we overcame them** - Technical challenges - Solutions implemented - Lessons learned - Best practices evolved --- ### **5. Python Snippets Usage Guide** 📄 [PYTHON_SNIPPETS_USAGE_GUIDE.md](PYTHON_SNIPPETS_USAGE_GUIDE.md) **Reusable Python code patterns** - Common code snippets - FastMCP patterns - Windows API integration - Error handling patterns --- ### **6. Systematic Project Updates** 📄 [SYSTEMATIC_PROJECT_UPDATES.md](SYSTEMATIC_PROJECT_UPDATES.md) **Structured approach to project maintenance** - Update procedures - Version management - Dependency updates - Documentation synchronization --- ### **7. Python Dependency Hell Fix** ⚠️ **CRITICAL** 📄 [PYTHON_DEPENDENCY_HELL_FIX.md](PYTHON_DEPENDENCY_HELL_FIX.md) **The Great Python 3.13 Catastrophe of October 2025** - How Python 3.13 broke all MCP servers - The fix (version constraints) - Quick reference card - "Dependency hell was not invented on a whim!" --- ## 🎯 **Purpose** This directory contains **development-focused documentation** including: ✅ **Best Practices** - How to develop quality MCP servers ✅ **AI Collaboration** - Working effectively with AI assistants ✅ **Debugging** - Real-world problem solving ✅ **Code Patterns** - Reusable Python snippets ✅ **Lessons Learned** - Avoiding common pitfalls ✅ **Project Management** - Systematic updates and maintenance --- ## 👥 **Target Audience** - **MCP Server Developers** - Building similar servers - **AI-Assisted Developers** - Using AI for coding - **Python Developers** - FastMCP applications - **Contributors** - Want to contribute to this project - **Learners** - Understanding development practices --- ## 🔧 **Key Topics Covered** ### **AI-Assisted Development** - Rules for effective AI collaboration - Tool comparisons (Windsurf, Cursor, Claude) - Best practices for prompts - Code review with AI ### **Python & FastMCP** - FastMCP 2.12+ patterns - Windows API integration - Async/await best practices - Error handling decorators ### **Quality & Testing** - Test-driven development - Mocking Windows API - CI/CD integration - Coverage reporting ### **Project Management** - Systematic updates - Version control - Documentation maintenance - Dependency management --- ## 📋 **Quick Reference** | Need | Document | Time | |------|----------|------| | **AI guidelines** | [AI Development Rules](AI_DEVELOPMENT_RULES.md) | 10 min | | **Tool choice** | [Tools Comparison](AI_DEVELOPMENT_TOOLS_COMPARISON.md) | 15 min | | **Debug help** | [Debugging Lessons](DEBUGGING_LESSONS_LEARNED.md) | 10 min | | **Python patterns** | [Python Snippets](PYTHON_SNIPPETS_USAGE_GUIDE.md) | 15 min | | **Update process** | [Project Updates](SYSTEMATIC_PROJECT_UPDATES.md) | 10 min | | **Dependency fix** | [Dependency Hell Fix](PYTHON_DEPENDENCY_HELL_FIX.md) | 5 min | --- ## 🏆 **Development Quality** **This documentation reflects**: - ✅ Real-world experience from building notepadpp-mcp - ✅ Lessons learned achieving Gold Status (85/100 → 90/100) - ✅ Best practices for MCP server development - ✅ Effective AI collaboration techniques - ✅ Production-ready code patterns --- ## 🔗 **Related Documentation** - [Repository Protection](../repository-protection/README.md) - Safe development workflow - [MCP Technical](../mcp-technical/README.md) - MCP server specifics - [MCPB Packaging](../mcpb-packaging/README.md) - Distribution - [Main Documentation Index](../DOCUMENTATION_INDEX.md) - All docs --- *Development Documentation* *Location: `docs/development/`* *Files: 7* *Focus: Best practices & lessons learned* *Target: Developers & Contributors* **Learn from our development journey!** 💻✨