Notepad++ MCP Server

# 📚 Complete Documentation Index **Central hub for all notepadpp-mcp documentation** --- ## 🎯 **Quick Navigation** ### **New to the Project?** 1. Start with [README.md](../README.md) - Project overview 2. See [Installation Guide](#installation) - Get started 3. Review [Repository Protection](#repository-protection) - Stay safe ### **Want to Contribute?** 1. Read [CONTRIBUTING.md](../CONTRIBUTING.md) - Guidelines 2. Setup [Branch Protection](#branch-protection) - Workflow 3. Check [Development Guides](#development) - Best practices ### **Need Help?** 1. Check [Troubleshooting](#troubleshooting) - Common issues 2. See [API Documentation](#api-docs) - Tool reference 3. Review [Security](#security) - Report issues --- ## 📖 **Documentation Structure** ``` docs/ ├── repository-protection/ 🛡️ Git, GitHub, backup & AI workflow │ ├── README.md → Protection strategy hub │ ├── BRANCH_PROTECTION_SETTINGS.md → GitHub setup (5 min) │ ├── BRANCH_STRATEGY_AND_AI_WORKFLOW.md → AI collaboration │ └── BACKUP_AND_RECOVERY_GUIDE.md → Recovery procedures │ ├── glama-platform/ 🏆 Glama.ai Gold Status & platform integration │ ├── README.md → Platform documentation hub │ ├── GOLD_STATUS_ACHIEVEMENT.md → Original 85/100 certification │ ├── GOLD_STATUS_UPDATE_2025_10_08.md → Enhanced 90/100 status │ ├── CI_CD_GLAMA_OPTIMIZATION_GUIDE.md → Quality optimization │ ├── GLAMA_AI_OPTIMIZATION_SUMMARY.md → Achievements │ ├── GLAMA_AI_PLATFORM.md → Platform overview │ ├── GLAMA_INTEGRATION.md → Integration steps │ ├── GLAMA_GITHUB_APP_SETUP.md → GitHub App setup │ ├── GLAMA_AI_CRITICISM_ANALYSIS.md → Feedback analysis │ ├── GLAMA_AI_RESCAN_GUIDE.md → Rescan procedures │ └── GLAMA_RESCAN_EMAIL.txt → Support templates │ ├── notepadpp/ 📝 Complete Notepad++ reference (NEW!) │ ├── README.md → Notepad++ documentation hub │ ├── NOTEPADPP_COMPLETE_GUIDE.md → History, features, config (15+ pages) │ ├── PLUGIN_ECOSYSTEM_COMPREHENSIVE.md → 1,400+ plugins (12+ pages) │ ├── COMMUNITY_AND_SUPPORT.md → Community & help (10+ pages) │ └── NOTEPADPP_COLOR_FIX_2025_10_08.md → White-on-white fix │ ├── development/ 💻 Development guides & best practices (NEW!) │ ├── README.md → Development documentation hub │ ├── AI_DEVELOPMENT_RULES.md → AI collaboration guidelines │ ├── AI_DEVELOPMENT_TOOLS_COMPARISON.md → Tool comparisons │ ├── DEBUGGING_LESSONS_LEARNED.md → Real-world debugging │ ├── DEVELOPMENT_PAIN_POINTS.md → Challenges & solutions │ ├── PYTHON_SNIPPETS_USAGE_GUIDE.md → Reusable patterns │ ├── SYSTEMATIC_PROJECT_UPDATES.md → Update procedures │ ├── PYTHON_DEPENDENCY_HELL_FIX.md ⚠️ → Python 3.13 catastrophe fix │ ├── MCP_SYNC_DEBUGGING_GUIDE.md ⭐ → File sync debugging (1,896 files!) │ └── SYNC_HEALTH_INTEGRATION.md ✨ → Health monitoring integration │ ├── mcp-technical/ 🔧 MCP server technical docs (NEW!) │ ├── README.md → MCP technical documentation hub │ ├── CLAUDE_DESKTOP_DEBUGGING.md → Claude Desktop debugging │ ├── MCP_PRODUCTION_CHECKLIST.md → Production readiness │ ├── TROUBLESHOOTING_FASTMCP_2.12.md → FastMCP issues │ ├── CONTAINERIZATION_GUIDELINES.md → Docker deployment │ └── MONITORING_STACK_DEPLOYMENT.md → Observability │ ├── mcpb-packaging/ 📦 MCPB distribution (NEW!) │ ├── README.md → MCPB packaging hub │ ├── MCPB_BUILDING_GUIDE.md → Complete guide (1,900+ lines) │ └── MCPB_IMPLEMENTATION_SUMMARY.md → Our implementation │ ├── DOCUMENTATION_INDEX.md 📚 This file - Complete doc index ├── ORGANIZATION_SUMMARY.md 📋 Documentation organization log │ src/notepadpp_mcp/docs/ ├── README.md 📘 Complete API documentation ├── PRD.md 📋 Product requirements ├── PLUGIN_ECOSYSTEM.md 🔌 Plugin integration (1,400+) └── examples/ 💡 Configuration examples scripts/ ├── README.md 🔧 Scripts documentation ├── build-mcpb-package.ps1 📦 MCPB builder └── backup-repo.ps1 💾 Repository backup ``` --- ## 🛡️ **Repository Protection & AI Workflow** **Location**: `docs/repository-protection/` ### **Purpose** Complete strategy for protecting your repository while allowing AI to experiment safely. ### **Documents** #### **1. Protection Hub** 📄 [README.md](repository-protection/README.md) **Central index for all protection documentation** - Overview of all protection layers - Quick setup (15 minutes) - Usage scenarios - Emergency contacts #### **2. Branch Protection Settings** 📄 [BRANCH_PROTECTION_SETTINGS.md](repository-protection/BRANCH_PROTECTION_SETTINGS.md) **5-minute GitHub setup guide** - Exact settings to enable - Visual checklist - Verification tests - **Priority: HIGH** - Do this first! #### **3. Branch Strategy & AI Workflow** 📄 [BRANCH_STRATEGY_AND_AI_WORKFLOW.md](repository-protection/BRANCH_STRATEGY_AND_AI_WORKFLOW.md) **Safe AI collaboration guide** - Three-branch strategy (main/develop/experimental) - AI playground on feature/experimental - PR workflow for production - Examples of safe AI prompts #### **4. Backup & Recovery Guide** 📄 [BACKUP_AND_RECOVERY_GUIDE.md](repository-protection/BACKUP_AND_RECOVERY_GUIDE.md) **Multi-layer protection strategy** - 5 layers of protection - Automated backup script - Git reflog (90-day time machine) - Emergency recovery scenarios --- ## 🏆 **Glama.ai Platform & Gold Status** **Location**: `docs/glama-platform/` ### **Purpose** Complete documentation for achieving, maintaining, and enhancing Gold Status on Glama.ai MCP Directory. ### **Documents** #### **1. Platform Hub** 📄 [README.md](glama-platform/README.md) **Central index for all Glama.ai documentation** - Gold Status journey (85/100 → 90/100) - Quick start paths - Quality checklist - Rescan procedures #### **2. Gold Status Achievement** 📄 [GOLD_STATUS_ACHIEVEMENT.md](glama-platform/GOLD_STATUS_ACHIEVEMENT.md) **Original Gold Status certification** (September 30, 2025) - Score: 85/100 (Gold Tier) - Category breakdowns - Major achievements - Production readiness checklist #### **3. Gold Status Update** 📄 [GOLD_STATUS_UPDATE_2025_10_08.md](glama-platform/GOLD_STATUS_UPDATE_2025_10_08.md) **Enhanced Gold++ Status** (October 8, 2025) - Score: ~90/100 (Gold++ Tier) - New features (+6 tools) - MCPB packaging - Plugin ecosystem integration #### **4. CI/CD & Glama Optimization Guide** 📄 [CI_CD_GLAMA_OPTIMIZATION_GUIDE.md](glama-platform/CI_CD_GLAMA_OPTIMIZATION_GUIDE.md) **Complete quality optimization strategy** - CI/CD pipeline setup - Quality automation - Scoring optimization - **Priority: HIGH** for quality improvement #### **5. Platform Integration** 📄 [GLAMA_INTEGRATION.md](glama-platform/GLAMA_INTEGRATION.md) **Step-by-step platform integration** - Adding server to Glama.ai - Configuration requirements - Best practices #### **6. GitHub App Setup** 📄 [GLAMA_GITHUB_APP_SETUP.md](glama-platform/GLAMA_GITHUB_APP_SETUP.md) **Glama.ai GitHub App installation** - Installation steps - Repository permissions - Webhook configuration #### **7. Additional Resources** - 📄 [Platform Overview](glama-platform/GLAMA_AI_PLATFORM.md) - What is Glama.ai - 📄 [Optimization Summary](glama-platform/GLAMA_AI_OPTIMIZATION_SUMMARY.md) - Metrics & achievements - 📄 [Criticism Analysis](glama-platform/GLAMA_AI_CRITICISM_ANALYSIS.md) - Platform feedback - 📄 [Rescan Guide](glama-platform/GLAMA_AI_RESCAN_GUIDE.md) - Trigger rescans - 📄 [Rescan Email Template](glama-platform/GLAMA_RESCAN_EMAIL.txt) - Support contact --- ## 📝 **Notepad++ Reference Documentation** **Location**: `docs/notepadpp/` ### **Purpose** Complete reference documentation for Notepad++ - history, features, plugins, and community. ### **Documents** #### **1. Notepad++ Complete Guide** ⭐ 📄 [NOTEPADPP_COMPLETE_GUIDE.md](notepadpp/NOTEPADPP_COMPLETE_GUIDE.md) **15+ page comprehensive reference** covering: - History & evolution (2003-2025, 22 years) - Core features (editing, syntax, search) - Technical architecture (Scintilla, Win32 API) - Configuration deep dive (stylers.xml, config.xml) - Recent changes (v8.5-8.7) - Comparison with alternatives - Best practices by user type #### **2. Plugin Ecosystem Guide** 📄 [PLUGIN_ECOSYSTEM_COMPREHENSIVE.md](notepadpp/PLUGIN_ECOSYSTEM_COMPREHENSIVE.md) **12+ page plugin reference** covering: - 1,400+ official plugins - 8 plugin categories - Top 50 plugins ranked - Installation methods - Plugin development - Security & signing #### **3. Community & Support** 📄 [COMMUNITY_AND_SUPPORT.md](notepadpp/COMMUNITY_AND_SUPPORT.md) **10+ page community guide** covering: - Official channels (forum, GitHub, docs) - Reddit (15k members), Stack Overflow (10k questions) - Getting help procedures - Contributing guidelines - 100M+ users worldwide #### **4. Color Fix Documentation** 📄 [NOTEPADPP_COLOR_FIX_2025_10_08.md](notepadpp/NOTEPADPP_COLOR_FIX_2025_10_08.md) **White-on-white text fix**: - Problem diagnosis - Configuration fix - Verification steps --- ## 💻 **Development Documentation** **Location**: `docs/development/` ### **Purpose** Development guides, best practices, and lessons learned from building notepadpp-mcp. ### **Documents** #### **1. AI Development Rules** 📄 [AI_DEVELOPMENT_RULES.md](development/AI_DEVELOPMENT_RULES.md) Guidelines for AI-assisted development and code quality standards. #### **2. AI Development Tools Comparison** 📄 [AI_DEVELOPMENT_TOOLS_COMPARISON.md](development/AI_DEVELOPMENT_TOOLS_COMPARISON.md) Comparison of Windsurf, Cursor, and Claude Code for development. #### **3. Debugging Lessons Learned** 📄 [DEBUGGING_LESSONS_LEARNED.md](development/DEBUGGING_LESSONS_LEARNED.md) Real-world debugging experiences and solutions. #### **4. Development Pain Points** 📄 [DEVELOPMENT_PAIN_POINTS.md](development/DEVELOPMENT_PAIN_POINTS.md) Challenges encountered and how we overcame them. #### **5. Python Snippets Usage Guide** 📄 [PYTHON_SNIPPETS_USAGE_GUIDE.md](development/PYTHON_SNIPPETS_USAGE_GUIDE.md) Reusable Python code patterns for FastMCP and Windows API. #### **6. Systematic Project Updates** 📄 [SYSTEMATIC_PROJECT_UPDATES.md](development/SYSTEMATIC_PROJECT_UPDATES.md) Structured approach to maintaining the project. #### **7. Python Dependency Hell Fix** ⚠️ **CRITICAL** 📄 [PYTHON_DEPENDENCY_HELL_FIX.md](development/PYTHON_DEPENDENCY_HELL_FIX.md) **The Great Python 3.13 Catastrophe**: - How Python 3.13 broke all MCP servers - Quick fix (version constraints) - Copy-paste solutions - "Dependency hell was not invented on a whim!" #### **8. MCP Sync Debugging Guide** ⭐ **NEW!** 📄 [MCP_SYNC_DEBUGGING_GUIDE.md](development/MCP_SYNC_DEBUGGING_GUIDE.md) **Comprehensive debugging guide for file sync issues**: - Silent failure diagnosis (advanced-memory-mcp case study) - Structured logging implementation - Health check tools - Progress monitoring - Stall detection - Automatic recovery - Testing strategies - **Based on real-world debugging of 1,896-file sync failure** #### **9. Sync Health Integration Guide** ✨ **NEW!** 📄 [SYNC_HEALTH_INTEGRATION.md](development/SYNC_HEALTH_INTEGRATION.md) **Practical integration guide**: - Quick start (5 minutes) - Complete code examples - Testing strategies - Production monitoring - Prometheus integration - Real-world examples - Best practices & anti-patterns --- ## 🔧 **MCP Technical Documentation** **Location**: `docs/mcp-technical/` ### **Purpose** Technical guides for MCP server development, deployment, and troubleshooting. ### **Documents** #### **1. Claude Desktop Debugging** 📄 [CLAUDE_DESKTOP_DEBUGGING.md](mcp-technical/CLAUDE_DESKTOP_DEBUGGING.md) Debug MCP servers in Claude Desktop - log files, common errors, stdio issues. #### **2. MCP Production Checklist** 📄 [MCP_PRODUCTION_CHECKLIST.md](mcp-technical/MCP_PRODUCTION_CHECKLIST.md) Comprehensive production readiness checklist for MCP servers. #### **3. FastMCP 2.12 Troubleshooting** 📄 [TROUBLESHOOTING_FASTMCP_2.12.md](mcp-technical/TROUBLESHOOTING_FASTMCP_2.12.md) FastMCP-specific issues, version compatibility, and solutions. #### **4. Containerization Guidelines** 📄 [CONTAINERIZATION_GUIDELINES.md](mcp-technical/CONTAINERIZATION_GUIDELINES.md) Docker and containerization best practices for MCP servers. #### **5. Monitoring Stack Deployment** 📄 [MONITORING_STACK_DEPLOYMENT.md](mcp-technical/MONITORING_STACK_DEPLOYMENT.md) Production monitoring, logging, and observability setup. --- ## 📦 **MCPB Packaging & Distribution** **Location**: `docs/mcpb-packaging/` ### **Purpose** Complete guide to professional MCP server packaging and distribution. ### **Documents** #### **1. MCPB Building Guide** ⭐ **ESSENTIAL** 📄 [MCPB_BUILDING_GUIDE.md](mcpb-packaging/MCPB_BUILDING_GUIDE.md) **1,900+ line comprehensive guide** covering: - MCPB vs DXT migration - Manifest configuration - Build process & automation - GitHub Actions CI/CD - User configuration patterns - Security & signing - Troubleshooting - **Read time**: 2-3 hours #### **2. MCPB Implementation Summary** 📄 [MCPB_IMPLEMENTATION_SUMMARY.md](mcpb-packaging/MCPB_IMPLEMENTATION_SUMMARY.md) **Our implementation status**: - ✅ Package built (0.19 MB) - ✅ GitHub Actions configured - ✅ 26 tools registered - ✅ User configuration working - ✅ Production ready #### **3. PyPI Publishing Guide** ✨ **NEW!** 📄 [PYPI_PUBLISHING_GUIDE.md](mcpb-packaging/PYPI_PUBLISHING_GUIDE.md) **Complete PyPI publishing walkthrough**: - Account creation & 2FA setup - API token generation - Package building & testing - Upload to Test PyPI & Production - Version management & updates - Automation with GitHub Actions --- ## 📘 **API & Development Documentation** **Location**: `src/notepadpp_mcp/docs/` ### **Complete API Documentation** 📄 [src/notepadpp_mcp/docs/README.md](../src/notepadpp_mcp/docs/README.md) **Comprehensive MCP server guide**: - All 26 tools documented - Usage examples - Configuration - Architecture ### **Product Requirements Document** 📄 [src/notepadpp_mcp/docs/PRD.md](../src/notepadpp_mcp/docs/PRD.md) **Vision and roadmap**: - Business objectives - Feature requirements - Implementation phases - Success metrics ### **Plugin Ecosystem Guide** 📄 [src/notepadpp_mcp/docs/PLUGIN_ECOSYSTEM.md](../src/notepadpp_mcp/docs/PLUGIN_ECOSYSTEM.md) **Integration with 1,400+ official plugins**: - Plugin discovery - Installation automation - Command execution - Future roadmap --- ## 🔧 **Scripts & Automation** **Location**: `scripts/` ### **Scripts Documentation** 📄 [scripts/README.md](../scripts/README.md) Overview of all automation scripts. ### **MCPB Package Builder** 📄 `scripts/build-mcpb-package.ps1` **Builds production MCPB package**: ```powershell .\scripts\build-mcpb-package.ps1 -NoSign ``` ### **Repository Backup** 📄 `scripts/backup-repo.ps1` **Creates complete repository backup**: ```powershell .\scripts\backup-repo.ps1 ``` --- ## 🎯 **Common Tasks** ### **Setup & Installation** | Task | Document | Time | |------|----------|------| | Install package | [README.md](../README.md) | 5 min | | Enable protection | [Branch Protection](repository-protection/BRANCH_PROTECTION_SETTINGS.md) | 5 min | | Setup backups | [Backup Guide](repository-protection/BACKUP_AND_RECOVERY_GUIDE.md) | 5 min | | Build MCPB | [Scripts README](../scripts/README.md) | 2 min | ### **Development Workflow** | Task | Document | Reference | |------|----------|-----------| | Branch strategy | [Branch Strategy](repository-protection/BRANCH_STRATEGY_AND_AI_WORKFLOW.md) | Workflow | | AI collaboration | [Branch Strategy](repository-protection/BRANCH_STRATEGY_AND_AI_WORKFLOW.md) | AI Prompts | | Create release | [MCPB Guide](MCPB_BUILDING_GUIDE.md) | Releases | | Run tests | [API Docs](../src/notepadpp_mcp/docs/README.md) | Testing | ### **Troubleshooting** | Issue | Document | Section | |-------|----------|---------| | Can't push to main | [Branch Protection](repository-protection/BRANCH_PROTECTION_SETTINGS.md) | Common Issues | | Lost work | [Backup Guide](repository-protection/BACKUP_AND_RECOVERY_GUIDE.md) | Recovery | | Build fails | [MCPB Guide](MCPB_BUILDING_GUIDE.md) | Troubleshooting | | Tool errors | [API Docs](../src/notepadpp_mcp/docs/README.md) | Tools | --- ## 📚 **Reading Paths** ### **Path 1: Quick Start (15 minutes)** 1. [README.md](../README.md) - Overview (5 min) 2. [Branch Protection](repository-protection/BRANCH_PROTECTION_SETTINGS.md) - Setup (5 min) 3. [Backup Script](../scripts/README.md) - Run backup (5 min) **Result**: Protected and ready to develop! ✅ --- ### **Path 2: Developer Onboarding (1 hour)** 1. [README.md](../README.md) - Overview 2. [CONTRIBUTING.md](../CONTRIBUTING.md) - Guidelines 3. [Repository Protection](repository-protection/README.md) - Strategy 4. [API Documentation](../src/notepadpp_mcp/docs/README.md) - Tools 5. [PRD](../src/notepadpp_mcp/docs/PRD.md) - Vision **Result**: Ready to contribute! ✅ --- ### **Path 3: AI Collaboration Setup (30 minutes)** 1. [Branch Strategy](repository-protection/BRANCH_STRATEGY_AND_AI_WORKFLOW.md) - Workflow 2. [Branch Protection](repository-protection/BRANCH_PROTECTION_SETTINGS.md) - Setup 3. [Backup Guide](repository-protection/BACKUP_AND_RECOVERY_GUIDE.md) - Safety **Result**: Safe AI experimentation enabled! ✅ --- ### **Path 4: MCPB Distribution (2 hours)** 1. [MCPB Building Guide](MCPB_BUILDING_GUIDE.md) - Complete guide 2. [Implementation Summary](MCPB_IMPLEMENTATION_SUMMARY.md) - Status 3. [Scripts README](../scripts/README.md) - Build process 4. [CI/CD Guide](CI_CD_GLAMA_OPTIMIZATION_GUIDE.md) - Automation **Result**: Ready to distribute! ✅ --- ## 🆘 **Getting Help** ### **Documentation Issues** If you find errors or missing information: 1. **Check**: Is there a newer version of the doc? 2. **Search**: Use GitHub search for related info 3. **Ask**: Create an issue with `documentation` label 4. **Fix**: Submit PR with corrections ### **Technical Issues** 1. **Check**: Relevant troubleshooting section 2. **Search**: GitHub issues for similar problems 3. **Debug**: Enable verbose logging 4. **Report**: Create detailed issue ### **Contact** - **GitHub Issues**: https://github.com/sandraschi/notepadpp-mcp/issues - **Pull Requests**: https://github.com/sandraschi/notepadpp-mcp/pulls - **Discussions**: https://github.com/sandraschi/notepadpp-mcp/discussions --- ## 📊 **Documentation Statistics** | Category | Files | Pages | Status | |----------|-------|-------|--------| | Repository Protection | 4 | 150+ | ✅ Complete | | MCPB Packaging | 3 | 100+ | ✅ Complete | | API Documentation | 4 | 80+ | ✅ Complete | | Platform Integration | 3 | 60+ | ✅ Complete | | Scripts | 2 | 10+ | ✅ Complete | | **Total** | **18** | **420+** | ✅ Complete | --- ## 🎯 **Next Steps** Based on what you need: ### **I'm New Here** → Read [README.md](../README.md) → Setup [Branch Protection](repository-protection/BRANCH_PROTECTION_SETTINGS.md) → Run [Backup Script](../scripts/README.md) ### **I Want to Develop** → Read [CONTRIBUTING.md](../CONTRIBUTING.md) → Review [Branch Strategy](repository-protection/BRANCH_STRATEGY_AND_AI_WORKFLOW.md) → Check [API Docs](../src/notepadpp_mcp/docs/README.md) ### **I Want to Release** → Read [MCPB Guide](MCPB_BUILDING_GUIDE.md) → Run [Build Script](../scripts/README.md) → Follow [CI/CD Guide](CI_CD_GLAMA_OPTIMIZATION_GUIDE.md) ### **I Need Help** → Check [Repository Protection](repository-protection/README.md) → See [Backup Guide](repository-protection/BACKUP_AND_RECOVERY_GUIDE.md) → Create [GitHub Issue](https://github.com/sandraschi/notepadpp-mcp/issues) --- *Documentation Index* *Created: October 8, 2025* *Last Updated: October 10, 2025* *Total Pages: 420+* *Total Documents: 18* *Status: Complete* *Coverage: 100%* **Everything you need to know about notepadpp-mcp!** 📚✨