@enokdev/springdocs-mcp 1.1.0 → 1.1.1

package/README_FR.md

@@ -0,0 +1,219 @@
+# 📚 Spring Documentation MCP Server
+
+[![npm version](https://badge.fury.io/js/@enokdev%2Fspringdocs-mcp.svg)](https://badge.fury.io/js/@enokdev%2Fspringdocs-mcp)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Node.js](https://img.shields.io/badge/Node.js-18+-green.svg)](https://nodejs.org/)
+[![GitHub](https://img.shields.io/badge/GitHub-tky0065/springdocs--mcp-blue.svg)](https://github.com/tky0065/springdocs-mcp)
+
+A public **Model Context Protocol (MCP)** server that provides access to the complete Spring Boot documentation and Spring ecosystem directly in Claude Desktop.
+
+## 🚀 Quick Installation
+
+```bash
+npm install -g @enokdev/springdocs-mcp
+```
+
+Then add to your `claude_desktop_config.json`:
+```json
+{
+  "mcpServers": {
+    "spring-docs": {
+      "command": "springdocs-mcp"
+    }
+  }
+}
+```
+
+## ✨ Features
+
+- 🌐 **Complete access** to spring.io/projects (all Spring projects)
+- 📖 **Practical guides** spring.io/guides with filtering
+- 📚 **Reference documentation** docs.spring.io
+- � **Recherche intelligente** dans tout l'écosystème Spring
+- 💡 **Base de connaissances** intégrée des concepts Spring Boot
+- ⚡ **7 outils MCP** pour une exploration complète
+
+## 🛠️ Utilisation
+
+### Démarrage du serveur
+
+```bash
+npm start
+```
+
+ou
+
+```bash
+node build/index.js
+```
+
+## 🛠️ Outils disponibles
+
+Le serveur MCP propose **7 outils** pour explorer la documentation Spring :
+
+### 1. `search_spring_docs`
+Recherche dans la documentation Spring Boot avec des mots-clés.
+
+**Paramètres :**
+- `query` (string, requis) : Mots-clés à rechercher
+- `docType` (string, optionnel) : Type de documentation (`guides`, `reference`, `api`, `all`)
+- `limit` (number, optionnel) : Nombre maximum de résultats (défaut: 10)
+
+### 2. `search_spring_projects`
+Recherche parmi tous les projets Spring disponibles sur spring.io/projects.
+
+**Paramètres :**
+- `query` (string, requis) : Mots-clés à rechercher dans les projets Spring
+- `limit` (number, optionnel) : Nombre maximum de projets à retourner (défaut: 10)
+
+### 3. `get_spring_project`
+Récupère les détails complets d'un projet Spring spécifique.
+
+**Paramètres :**
+- `projectName` (string, requis) : Nom du projet Spring (ex: `spring-boot`, `spring-security`)
+
+### 4. `get_all_spring_guides`
+Récupère la liste de tous les guides Spring disponibles, optionnellement filtrés par catégorie.
+
+**Paramètres :**
+- `category` (string, optionnel) : Catégorie de guides à filtrer
+- `limit` (number, optionnel) : Nombre maximum de guides (défaut: 20)
+
+### 5. `get_spring_guide`
+Récupère le contenu complet d'un guide Spring Boot spécifique.
+
+**Paramètres :**
+- `guideId` (string, requis) : Identifiant du guide (ex: `gs-rest-service`)
+
+### 6. `get_spring_reference`
+Récupère une section spécifique de la documentation de référence Spring Boot.
+
+**Paramètres :**
+- `section` (string, requis) : Section de la documentation (ex: `web`, `data`, `security`)
+- `subsection` (string, optionnel) : Sous-section pour une recherche plus précise
+
+### 7. `search_spring_concepts`
+Recherche des concepts Spring Boot par catégorie avec explications détaillées.
+
+**Paramètres :**
+- `concept` (string, requis) : Concept à rechercher (ex: `auto-configuration`)
+- `category` (string, optionnel) : Catégorie (`core`, `web`, `data`, `security`, `testing`, `production`)
+
+## � Sources de documentation
+
+Ce serveur MCP accède aux sources de documentation Spring suivantes :
+
+- **🌟 [spring.io/projects](https://spring.io/projects)** - Tous les projets Spring (Boot, Security, Data, Cloud, etc.)
+- **📖 [spring.io/guides](https://spring.io/guides)** - Guides pratiques et tutoriels
+- **📚 [docs.spring.io](https://docs.spring.io)** - Documentation de référence officielle
+- **🔧 API Documentation** - Documentation des classes et méthodes
+- **💡 Base de connaissances intégrée** - Concepts et bonnes pratiques Spring Boot
+
+## �🔧 Configuration avec Claude Desktop
+
+Pour utiliser ce serveur avec Claude Desktop, ajoutez la configuration suivante dans votre fichier `claude_desktop_config.json` :
+
+```json
+{
+  "mcpServers": {
+    "springboot-docs": {
+      "command": "node",
+      "args": ["/chemin/absolu/vers/springdocsmcp/build/index.js"]
+    }
+  }
+}
+```
+
+### Localisation du fichier de configuration
+
+- **macOS** : `~/Library/Application Support/Claude/claude_desktop_config.json`
+- **Windows** : `%APPDATA%\\Claude\\claude_desktop_config.json`
+
+## 📚 Exemples d'utilisation
+
+### Recherche générale
+```
+Recherche "REST API" dans la documentation Spring Boot
+```
+
+### Recherche de projets Spring
+```
+Trouve des projets Spring liés à "security"
+```
+
+### Détails d'un projet spécifique
+```
+Montre-moi les détails du projet "spring-boot"
+```
+
+### Liste des guides par catégorie
+```
+Quels sont les guides Spring pour la catégorie "Web" ?
+```
+
+### Récupération d'un guide spécifique
+```
+Récupère le guide "gs-rest-service"
+```
+
+### Exploration des concepts
+```
+Explique le concept "auto-configuration" dans Spring Boot
+```
+
+## 🏗️ Architecture
+
+Le projet est organisé comme suit :
+
+```
+src/
+├── index.ts              # Point d'entrée principal
+├── services/
+│   └── springboot-docs.ts # Service de récupération de documentation
+└── tools/
+    └── index.ts          # Définitions des outils MCP
+```
+
+### Composants principaux
+
+- **SpringBootMCPServer** : Serveur MCP principal qui gère les requêtes
+- **SpringBootDocsService** : Service pour récupérer et traiter la documentation
+- **ToolDefinitions** : Définitions des outils exposés via MCP
+
+## 🔒 Sécurité
+
+- Le serveur accède uniquement aux ressources publiques de `docs.spring.io`
+- Aucune donnée sensible n'est stockée ou transmise
+- Toutes les requêtes HTTP sont en lecture seule
+
+## 🐛 Dépannage
+
+### Erreurs courantes
+
+1. **"Cannot find module"** : Vérifiez que `npm install` a été exécuté
+2. **"Serveur non démarré"** : Vérifiez que la compilation avec `npm run build` s'est bien passée
+3. **"Documentation non trouvée"** : Vérifiez votre connexion internet
+
+### Logs
+
+Le serveur écrit ses logs sur `stderr` pour éviter d'interférer avec le protocole MCP sur `stdout`.
+
+## 🤝 Contribution
+
+Les contributions sont les bienvenues ! N'hésitez pas à :
+
+1. Forker le projet
+2. Créer une branche pour votre fonctionnalité
+3. Commiter vos changements
+4. Pousser vers la branche
+5. Ouvrir une Pull Request
+
+## 📄 Licence
+
+Ce projet est sous licence MIT. Voir le fichier `LICENSE` pour plus de détails.
+
+## 🔗 Ressources utiles
+
+- [Documentation Spring Boot](https://docs.spring.io/spring-boot/docs/current/reference/html/)
+- [Model Context Protocol](https://modelcontextprotocol.io/)
+- [SDK MCP TypeScript](https://github.com/modelcontextprotocol/typescript-sdk)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@enokdev/springdocs-mcp",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Public MCP server for accessing Spring Boot documentation and the complete Spring ecosystem",
   "type": "module",
   "main": "build/index.js",

package/DEPLOYMENT.md

@@ -1,205 +0,0 @@
-# 🚀 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 !**

package/PUBLICATION_ENOKDEV.md

@@ -1,170 +0,0 @@
-# 🚀 Guide de publication pour EnokDev (@enokdev)
-
-## 📋 Informations de publication
-
-- **GitHub**: https://github.com/tky0065
-- **npm**: https://www.npmjs.com/~enokdev
-- **Package**: `@enokdev/springdocs-mcp`
-- **Repository**: `tky0065/springdocs-mcp`
-
-## ⚡ Commandes de publication rapide
-
-### 1. Préparer le repository GitHub
-
-```bash
-# Dans votre dossier de projet
-cd /Users/yacoubakone/Documents/dev/springdocsmcp
-
-# Initialiser Git (si pas encore fait)
-git init
-git add .
-git commit -m "Initial release: Spring Documentation MCP Server v1.1.0"
-
-# Créer le repository sur GitHub avec le nom: springdocs-mcp
-# Description: "Spring Documentation MCP Server for Claude Desktop - Access the complete Spring ecosystem in Claude"
-
-# 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. Publication sur npm
-
-```bash
-# Se connecter à npm avec votre compte enokdev
-npm login
-# Username: enokdev
-# Password: [votre mot de passe]
-# Email: [votre email]
-
-# Vérifier la connexion
-npm whoami
-# Doit afficher: enokdev
-
-# Compilation et test final
-npm run build
-npm test
-
-# Publication
-npm publish --access public
-```
-
-### 3. Créer une 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 pour les utilisateurs
-
-```bash
-npm install -g @enokdev/springdocs-mcp
-```
-
-### Configuration Claude Desktop
-
-```json
-{
-  "mcpServers": {
-    "spring-docs": {
-      "command": "springdocs-mcp"
-    }
-  }
-}
-```
-
-## 📈 Promotion
-
-### 1. Réseaux sociaux
-- **LinkedIn**: Post avec hashtags #SpringBoot #Claude #MCP #OpenSource
-- **Twitter/X**: Mention @springboot et @anthropicai
-- **GitHub**: Ajouter aux topics: `mcp`, `spring-boot`, `claude`, `documentation`
-
-### 2. Communautés
-- **Reddit**: r/SpringBoot, r/java, r/programming
-- **Dev.to**: Article de présentation
-- **Stack Overflow**: Répondre aux questions Spring Boot avec votre outil
-
-### 3. Documentation officielle
-- **MCP Registry**: Soumettre à la liste officielle MCP
-- **Awesome Lists**: Ajouter aux listes "Awesome MCP" sur GitHub
-
-## 🔗 Liens utiles
-
-- **Package npm**: https://www.npmjs.com/package/@enokdev/springdocs-mcp
-- **Repository GitHub**: https://github.com/tky0065/springdocs-mcp
-- **Documentation**: https://tky0065.github.io/springdocs-mcp
-- **Issues**: https://github.com/tky0065/springdocs-mcp/issues
-
-## 📊 Métriques à suivre
-
-- Downloads npm: https://npm-stat.com/charts.html?package=@enokdev/springdocs-mcp
-- GitHub stars et forks
-- Issues et pull requests
-- Feedback utilisateurs
-
-## 🔄 Mises à jour futures
-
-```bash
-# Pour publier une mise à jour
-npm version patch  # ou minor/major
-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
-```
-
-## 🎯 Script de publication automatique
-
-```bash
-#!/bin/bash
-# publish.sh
-
-set -e
-
-echo "🔍 Vérifications pré-publication..."
-npm run build
-npm test
-
-echo "📝 Mise à jour de version..."
-npm version patch
-
-echo "📤 Envoi vers GitHub..."
-git push origin main --tags
-
-echo "📦 Publication sur npm..."
-npm publish --access public
-
-echo "✅ Publication terminée!"
-echo "Package: https://www.npmjs.com/package/@enokdev/springdocs-mcp"
-echo "GitHub: https://github.com/tky0065/springdocs-mcp"
-```
-
----
-
-## 🎉 Message de lancement suggéré
-
-```markdown
-🚀 Nouveau package npm: @enokdev/springdocs-mcp
-
-Un serveur MCP qui donne accès à TOUTE la documentation Spring (Boot, Security, Data, Cloud...) directement dans Claude Desktop !
-
-✨ 7 outils MCP pour explorer l'écosystème Spring
-📚 Accès instantané à spring.io/projects + guides + docs
-🔍 Recherche intelligente dans toute la documentation
-⚡ Installation en une commande: npm install -g @enokdev/springdocs-mcp
-
-Perfect pour tous les développeurs Spring utilisant Claude ! 
-
-#SpringBoot #Claude #MCP #OpenSource #Documentation
-```
-
-**🌟 Votre serveur MCP sera bientôt disponible pour toute la communauté des développeurs Spring !**