@enokdev/springdocs-mcp 1.1.0

package/.github/workflows/publish.yml

@@ -0,0 +1,64 @@
+name: Publish to npm
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+          registry-url: 'https://registry.npmjs.org'
+          
+      - name: Install dependencies
+        run: npm ci
+        
+      - name: Build
+        run: npm run build
+        
+      - name: Test
+        run: npm test
+        
+      - name: Publish to npm
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          
+      - name: Create GitHub Release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: Release ${{ github.ref }}
+          body: |
+            ## Changes in this release
+            
+            - Check the [CHANGELOG.md](CHANGELOG.md) for details
+            
+            ## Installation
+            
+            ```bash
+            npm install -g @springdocs/mcp-server
+            ```
+            
+            ## Configuration for Claude Desktop
+            
+            ```json
+            {
+              "mcpServers": {
+                "spring-docs": {
+                  "command": "springdocs-mcp"
+                }
+              }
+            }
+            ```
+          draft: false
+          prerelease: false

package/CHANGELOG.md

@@ -0,0 +1,82 @@
+# Changelog - Spring Boot MCP Server
+
+Toutes les modifications notables de ce projet seront documentées dans ce fichier.
+
+Le format est basé sur [Keep a Changelog](https://keepachangelog.com/fr/1.0.0/),
+et ce projet adhère au [versioning sémantique](https://semver.org/spec/v2.0.0.html).
+
+## [1.1.0] - 2025-08-21
+
+### ✨ Ajouté
+- **Support complet de spring.io/projects** - Accès à tous les projets Spring (Security, Data, Cloud, etc.)
+- **Nouvel outil `search_spring_projects`** - Recherche parmi tous les projets Spring disponibles
+- **Nouvel outil `get_spring_project`** - Récupération des détails complets d'un projet Spring spécifique
+- **Nouvel outil `get_all_spring_guides`** - Liste tous les guides Spring avec filtrage par catégorie
+- **Base de connaissances étendue** - Projets Spring populaires intégrés pour un fallback robuste
+- **Documentation enrichie** - Guides d'exemples pratiques (EXAMPLES.md)
+- **Guide de contribution** - Documentation pour les développeurs (CONTRIBUTING.md)
+
+### 🔧 Amélioré
+- **Couverture documentaire élargie** - Passage de 4 à 7 outils MCP
+- **Robustesse du service** - Mécanismes de fallback pour les projets et guides populaires
+- **Performance des requêtes** - Optimisation du parsing HTML et conversion Markdown
+- **Tests étendus** - Script de test mis à jour avec tous les nouveaux outils
+
+### 📚 Sources de documentation ajoutées
+- `https://spring.io/projects` - Catalogue complet des projets Spring
+- `https://spring.io/guides` - Collection étendue de guides pratiques
+- Base de connaissances des projets populaires (Boot, Security, Data, Cloud, etc.)
+
+### 🛠️ Outils MCP (7 au total)
+1. `search_spring_docs` - Recherche dans la documentation Spring Boot *(existant)*
+2. `search_spring_projects` - **NOUVEAU** - Recherche de projets Spring
+3. `get_spring_project` - **NOUVEAU** - Détails d'un projet Spring
+4. `get_all_spring_guides` - **NOUVEAU** - Liste des guides Spring
+5. `get_spring_guide` - Récupération d'un guide spécifique *(existant)*
+6. `get_spring_reference` - Documentation de référence *(existant)*
+7. `search_spring_concepts` - Recherche de concepts *(existant)*
+
+## [1.0.0] - 2025-08-21
+
+### ✨ Version initiale
+- **Serveur MCP fonctionnel** - Implémentation complète du protocole Model Context Protocol
+- **4 outils de base** - Accès à la documentation Spring Boot essentielle
+- **Architecture TypeScript** - Code moderne avec types stricts
+- **Configuration Claude Desktop** - Intégration prête à l'emploi
+- **Tests automatisés** - Script de validation des fonctionnalités
+- **Documentation complète** - README avec instructions d'installation et usage
+
+### 🛠️ Outils MCP de base
+1. `search_spring_docs` - Recherche dans la documentation Spring Boot
+2. `get_spring_guide` - Récupération d'un guide spécifique
+3. `get_spring_reference` - Documentation de référence
+4. `search_spring_concepts` - Recherche de concepts Spring Boot
+
+### 📚 Sources de documentation initiales
+- Documentation Spring Boot officielle
+- Guides Spring.io sélectionnés
+- Base de connaissances des concepts Spring Boot
+
+### 🔧 Fonctionnalités techniques
+- Transport stdio pour communication MCP
+- Parsing HTML avec Cheerio
+- Conversion Markdown avec Turndown
+- Gestion d'erreurs robuste
+- Support des requêtes JSON-RPC 2.0
+
+---
+
+## Format des versions
+
+- **MAJOR** : Changements incompatibles de l'API
+- **MINOR** : Nouvelles fonctionnalités compatibles
+- **PATCH** : Corrections de bugs compatibles
+
+## Types de changements
+
+- `✨ Ajouté` pour les nouvelles fonctionnalités
+- `🔧 Amélioré` pour les modifications de fonctionnalités existantes
+- `🐛 Corrigé` pour les corrections de bugs
+- `❌ Supprimé` pour les fonctionnalités supprimées
+- `⚠️ Déprécié` pour les fonctionnalités bientôt supprimées
+- `🔒 Sécurité` pour les corrections de vulnérabilités

package/CONTRIBUTING.md

@@ -0,0 +1,215 @@
+# Guide de Contribution - Spring Boot MCP Server
+
+Merci de votre intérêt pour contribuer au projet Spring Boot MCP Server ! Ce guide vous aidera à comprendre comment participer au développement.
+
+## 🛠️ Configuration de l'environnement de développement
+
+### Prérequis
+- Node.js >= 18.0.0
+- npm >= 8.0.0
+- TypeScript >= 5.0.0
+- Git
+
+### Installation
+```bash
+# Cloner le repository
+git clone <votre-fork>
+cd springdocsmcp
+
+# Installer les dépendances
+npm install
+
+# Compiler le projet
+npm run build
+
+# Exécuter les tests
+./test.sh
+```
+
+## 📝 Structure du projet
+
+```
+springdocsmcp/
+├── src/
+│   ├── index.ts              # Point d'entrée du serveur MCP
+│   ├── services/
+│   │   └── springboot-docs.ts # Service de documentation Spring Boot
+│   └── tools/
+│       └── index.ts          # Définitions des outils MCP
+├── build/                    # Fichiers compilés TypeScript
+├── package.json              # Configuration npm
+├── tsconfig.json            # Configuration TypeScript
+└── README.md                # Documentation principale
+```
+
+## 🔧 Développement
+
+### Scripts disponibles
+- `npm run build` - Compile le TypeScript
+- `npm run dev` - Mode développement avec rechargement automatique
+- `npm run test` - Exécute les tests (ou utilisez `./test.sh`)
+- `npm run lint` - Vérifie le style de code
+
+### Ajouter un nouvel outil
+
+1. **Définir l'outil dans `src/tools/index.ts`** :
+```typescript
+export const NOUVEAU_OUTIL: Tool = {
+  name: "nouveau_outil",
+  description: "Description de votre nouvel outil",
+  inputSchema: {
+    type: "object",
+    properties: {
+      parametre: {
+        type: "string",
+        description: "Description du paramètre"
+      }
+    },
+    required: ["parametre"]
+  }
+};
+```
+
+2. **Implémenter la logique dans `src/services/springboot-docs.ts`** :
+```typescript
+public async nouveauOutil(parametre: string): Promise<string> {
+  // Votre logique ici
+  return "Résultat de l'outil";
+}
+```
+
+3. **Ajouter le gestionnaire dans `src/index.ts`** :
+```typescript
+case "nouveau_outil":
+  const result = await this.docsService.nouveauOutil(args.parametre);
+  return { content: [{ type: "text", text: result }] };
+```
+
+### Ajouter une nouvelle source de documentation
+
+1. **Étendre le service** dans `src/services/springboot-docs.ts`
+2. **Ajouter les nouvelles URLs** dans les constantes
+3. **Implémenter les méthodes de parsing** spécifiques
+4. **Tester avec le script de test**
+
+## 🧪 Tests
+
+### Tests automatisés
+Exécutez le script de test pour vérifier que tous les outils fonctionnent :
+```bash
+./test.sh
+```
+
+### Tests manuels
+Testez individuellement avec des requêtes JSON-RPC :
+```bash
+echo '{"jsonrpc": "2.0", "id": 1, "method": "tools/call", "params": {"name": "search_spring_docs", "arguments": {"query": "test"}}}' | node build/index.js
+```
+
+### Tests d'intégration
+Testez avec Claude Desktop en ajoutant la configuration MCP et en utilisant les outils dans une conversation.
+
+## 📋 Standards de code
+
+### Style TypeScript
+- Utilisez des types stricts
+- Préférez `interface` pour les objets
+- Documentez les fonctions publiques avec JSDoc
+- Utilisez `async/await` pour les opérations asynchrones
+
+### Nommage
+- Fonctions et variables : `camelCase`
+- Classes : `PascalCase`
+- Constantes : `UPPER_SNAKE_CASE`
+- Fichiers : `kebab-case.ts`
+
+### Gestion d'erreurs
+```typescript
+try {
+  // Opération risquée
+} catch (error) {
+  console.error('Erreur détaillée:', error);
+  throw new Error('Message d'erreur utilisateur');
+}
+```
+
+## 🐛 Signalement de bugs
+
+### Template de bug report
+```markdown
+**Description du bug**
+Description claire et concise du problème.
+
+**Étapes pour reproduire**
+1. Étape 1
+2. Étape 2
+3. Voir l'erreur
+
+**Comportement attendu**
+Ce qui devrait se passer.
+
+**Environnement**
+- OS: [ex: macOS 14.0]
+- Node.js: [ex: 18.17.0]
+- Version du serveur: [ex: 1.0.0]
+
+**Logs d'erreur**
+```
+Logs ou messages d'erreur
+```
+
+## ✨ Demandes de fonctionnalités
+
+### Template de feature request
+```markdown
+**Fonctionnalité désirée**
+Description claire de la fonctionnalité.
+
+**Problème résolu**
+Quel problème cette fonctionnalité résoudrait-elle ?
+
+**Solution proposée**
+Description de votre solution idéale.
+
+**Alternatives considérées**
+Autres solutions que vous avez envisagées.
+```
+
+## 🔄 Processus de contribution
+
+1. **Fork** le repository
+2. **Créez une branche** pour votre fonctionnalité (`git checkout -b feature/nouvelle-fonctionnalite`)
+3. **Committez** vos changements (`git commit -am 'Ajoute nouvelle fonctionnalité'`)
+4. **Poussez** vers la branche (`git push origin feature/nouvelle-fonctionnalite`)
+5. **Créez une Pull Request**
+
+### Checklist pour les Pull Requests
+- [ ] Le code compile sans erreur (`npm run build`)
+- [ ] Les tests passent (`./test.sh`)
+- [ ] La documentation est mise à jour si nécessaire
+- [ ] Les nouveaux outils sont documentés
+- [ ] Le code suit les standards du projet
+
+## 📚 Ressources utiles
+
+- [Documentation MCP](https://modelcontextprotocol.io/docs)
+- [Spécification MCP](https://spec.modelcontextprotocol.io/)
+- [Documentation Spring Boot](https://docs.spring.io/spring-boot/docs/current/reference/html/)
+- [TypeScript Handbook](https://www.typescriptlang.org/docs/)
+
+## 🤝 Code de conduite
+
+Nous nous engageons à créer un environnement accueillant et inclusif pour tous. Merci de :
+- Être respectueux et professionnel
+- Accepter les critiques constructives
+- Se concentrer sur ce qui est le mieux pour la communauté
+- Faire preuve d'empathie envers les autres
+
+## 📞 Contact
+
+Pour toute question ou discussion, n'hésitez pas à :
+- Ouvrir une issue sur GitHub
+- Participer aux discussions
+- Contacter les mainteneurs
+
+Merci pour votre contribution ! 🎉

package/DEPLOYMENT.md

@@ -0,0 +1,205 @@
+# 🚀 Guide de déploiement public - Spring Documentation MCP Server
+
+## ✅ État actuel du projet
+
+Votre serveur MCP Spring Documentation est **prêt pour la publication publique** ! 
+
+### 📦 Configuration npm
+- ✅ **Package scope**: `@enokdev/springdocs-mcp`
+- ✅ **Accès public**: Configuré pour publication publique
+- ✅ **Version**: 1.1.0
+- ✅ **Scripts**: Build, test, publication automatique
+- ✅ **Dependencies**: Toutes les dépendances nécessaires
+- ✅ **Binary**: `springdocs-mcp` pour installation globale
+
+### 📚 Documentation complète
+- ✅ **README.md**: Documentation principale avec badges
+- ✅ **INSTALL.md**: Guide d'installation pour utilisateurs finaux
+- ✅ **EXAMPLES.md**: Exemples d'utilisation pratiques
+- ✅ **CONTRIBUTING.md**: Guide pour contributeurs
+- ✅ **CHANGELOG.md**: Historique des versions
+- ✅ **PUBLISHING.md**: Guide de publication
+- ✅ **docs/index.html**: Site web de documentation
+- ✅ **LICENSE**: Licence MIT
+
+### 🔧 Infrastructure
+- ✅ **GitHub Actions**: Workflow de publication automatique
+- ✅ **Tests**: Script de validation fonctionnelle
+- ✅ **Build**: Compilation TypeScript optimisée
+- ✅ **NPM ignore**: Fichiers exclus de la publication
+
+## 🚀 Étapes pour rendre public
+
+### 1. **Préparer le repository GitHub**
+
+```bash
+# Initialiser Git si pas encore fait
+git init
+git add .
+git commit -m "Ready for public release v1.1.0"
+
+# Créer un repository public sur GitHub
+# Nom suggéré: springdocs-mcp
+# Description: "Spring Documentation MCP Server for Claude Desktop"
+
+# Connecter le repository local
+git remote add origin https://github.com/tky0065/springdocs-mcp.git
+git branch -M main
+git push -u origin main
+```
+
+### 2. **Configurer npm pour publication**
+
+```bash
+# Créer un compte npm (si pas encore fait)
+npm adduser
+
+# Ou se connecter
+npm login
+
+# Vérifier l'authentification
+npm whoami
+```
+
+### 3. **Publication sur npm**
+
+```bash
+# Test final
+npm run build
+npm test
+
+# Publication
+npm publish --access public
+```
+
+### 4. **Création du tag et release GitHub**
+
+```bash
+# Créer un tag de version
+git tag v1.1.0
+git push origin v1.1.0
+
+# La GitHub Action va automatiquement créer une release
+```
+
+## 🌐 Après publication
+
+### Installation utilisateur
+Les utilisateurs pourront installer avec :
+
+```bash
+npm install -g @enokdev/springdocs-mcp
+```
+
+### Configuration Claude Desktop
+Configuration simple :
+
+```json
+{
+  "mcpServers": {
+    "spring-docs": {
+      "command": "springdocs-mcp"
+    }
+  }
+}
+```
+
+## 📈 Promotion et visibilité
+
+### 1. **Documentation officielle**
+- Ajouter à la documentation MCP d'Anthropic
+- Soumettre aux registres MCP communautaires
+
+### 2. **Communauté Spring**
+- Annoncer sur les forums Spring Boot
+- Partager sur Reddit r/SpringBoot
+- Poster sur Stack Overflow avec tag spring-boot
+
+### 3. **Réseaux sociaux**
+- LinkedIn avec hashtags #SpringBoot #Claude #MCP
+- Twitter/X mention @springboot
+- Dev.to article de présentation
+
+### 4. **GitHub**
+- Ajouter aux listes "Awesome MCP"
+- Topics: `mcp`, `spring-boot`, `claude`, `documentation`
+
+## 🔄 Maintenance continue
+
+### Monitoring
+- GitHub Issues pour support utilisateur
+- npm downloads statistics
+- Feedback et feature requests
+
+### Mises à jour
+- Suivre les versions Spring Boot
+- Améliorer les outils MCP
+- Ajouter de nouvelles sources de documentation
+
+## 📊 Métriques de succès
+
+### Adoption
+- Downloads npm
+- GitHub stars
+- Issues/feedback utilisateurs
+
+### Usage
+- Nombre d'utilisateurs Claude Desktop
+- Fréquence d'utilisation des outils
+- Requêtes de documentation populaires
+
+## 🎯 Roadmap future
+
+### Version 1.2.0
+- Support Spring Boot 3.2+
+- Nouveaux projets Spring
+- Amélioration des performances
+
+### Version 1.3.0
+- Support multi-langues
+- Cache intelligent
+- Analytics d'usage
+
+## 🤝 Contribution communautaire
+
+### Ouverture
+- Issues templates
+- Pull request guidelines
+- Code of conduct
+- Contributor recognition
+
+### Gouvernance
+- Maintenance collaborative
+- Revue de code
+- Tests automatisés
+- Documentation collaborative
+
+---
+
+## 🎉 Commandes de publication rapide
+
+```bash
+# Vérifications finales
+npm run build
+npm test
+npm pack --dry-run
+
+# Publication
+npm version patch  # ou minor/major selon les changements
+git add .
+git commit -m "Release v$(node -p "require('./package.json').version")"
+git tag "v$(node -p "require('./package.json').version")"
+git push origin main --tags
+npm publish --access public
+```
+
+## 🌟 Impact attendu
+
+Une fois publié, votre serveur MCP permettra à **tous les développeurs utilisant Claude Desktop** d'avoir un accès instantané à :
+
+- 📚 **Toute la documentation Spring**
+- 🔍 **Recherche intelligente** dans l'écosystème Spring
+- 💡 **Apprentissage interactif** avec Claude
+- ⚡ **Développement accéléré** Spring Boot
+
+**🚀 Votre contribution va révolutionner l'accès à la documentation Spring pour la communauté des développeurs !**