@enokdev/springdocs-mcp 1.1.1 → 1.2.1

package/CHANGELOG.md

@@ -1,82 +0,0 @@
-# Changelog - Spring Boot MCP Server
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [1.1.0] - 2025-08-21
-
-### ✨ Added
-- **Complete spring.io/projects support** - Access to all Spring projects (Security, Data, Cloud, etc.)
-- **New `search_spring_projects` tool** - Search among all available Spring projects
-- **New `get_spring_project` tool** - Retrieve complete details of a specific Spring project
-- **New `get_all_spring_guides` tool** - List all Spring guides with category filtering
-- **Extended knowledge base** - Popular Spring projects integrated for robust fallback
-- **Enhanced documentation** - Practical examples guide (EXAMPLES.md)
-- **Contribution guide** - Developer documentation (CONTRIBUTING.md)
-
-### 🔧 Improved
-- **Expanded documentation coverage** - From 4 to 7 MCP tools
-- **Service robustness** - Fallback mechanisms for popular projects and guides
-- **Query performance** - Optimized HTML parsing and Markdown conversion
-- **Extended testing** - Updated test script with all new tools
-
-### 📚 Added Documentation Sources
-- `https://spring.io/projects` - Complete catalog of Spring projects
-- `https://spring.io/guides` - Extended collection of practical guides
-- Popular projects knowledge base (Boot, Security, Data, Cloud, etc.)
-
-### 🛠️ MCP Tools (7 total)
-1. `search_spring_docs` - Search Spring Boot documentation *(existing)*
-2. `search_spring_projects` - **NEW** - Search Spring projects
-3. `get_spring_project` - **NEW** - Spring project details
-4. `get_all_spring_guides` - **NEW** - List Spring guides
-5. `get_spring_guide` - Retrieve specific guide *(existing)*
-6. `get_spring_reference` - Reference documentation *(existing)*
-7. `search_spring_concepts` - Search concepts *(existing)*
-
-## [1.0.0] - 2025-08-21
-
-### ✨ Initial Release
-- **Functional MCP server** - Complete Model Context Protocol implementation
-- **4 basic tools** - Access to essential Spring Boot documentation
-- **TypeScript architecture** - Modern code with strict types
-- **Claude Desktop configuration** - Ready-to-use integration
-- **Automated testing** - Functionality validation script
-- **Complete documentation** - README with installation and usage instructions
-
-### 🛠️ Basic MCP Tools
-1. `search_spring_docs` - Search Spring Boot documentation
-2. `get_spring_guide` - Retrieve specific guide
-3. `get_spring_reference` - Reference documentation
-4. `search_spring_concepts` - Search Spring Boot concepts
-
-### 📚 Initial Documentation Sources
-- Official Spring Boot documentation
-- Selected Spring.io guides
-- Spring Boot concepts knowledge base
-
-### 🔧 Technical Features
-- stdio transport for MCP communication
-- HTML parsing with Cheerio
-- Markdown conversion with Turndown
-- Robust error handling
-- JSON-RPC 2.0 request support
-
----
-
-## Version Format
-
-- **MAJOR**: Incompatible API changes
-- **MINOR**: Backward-compatible new features
-- **PATCH**: Backward-compatible bug fixes
-
-## Types of Changes
-
-- `✨ Added` for new features
-- `🔧 Improved` for changes to existing functionality
-- `🐛 Fixed` for bug fixes
-- `❌ Removed` for removed features
-- `⚠️ Deprecated` for soon-to-be removed features
-- `🔒 Security` for vulnerability fixes

package/CONTRIBUTING.md

@@ -1,215 +0,0 @@
-# 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/EXAMPLES_FR.md

@@ -1,186 +0,0 @@
-# Exemples d'utilisation du serveur MCP Spring Documentation
-
-Ce fichier contient des exemples pratiques d'utilisation du serveur MCP Spring Documentation avec Claude Desktop.
-
-## 🚀 Scénarios d'utilisation
-
-### 1. Découverte des projets Spring
-
-**Question à Claude :**
-> "Quels sont les projets Spring disponibles pour la sécurité ?"
-
-**Outils utilisés :** `search_spring_projects`
-**Résultat :** Liste des projets Spring Security avec descriptions
-
----
-
-### 2. Apprentissage d'un nouveau projet Spring
-
-**Question à Claude :**
-> "Peux-tu m'expliquer le projet Spring Cloud ?"
-
-**Outils utilisés :** `get_spring_project`
-**Résultat :** Documentation complète de Spring Cloud
-
----
-
-### 3. Exploration des guides par domaine
-
-**Question à Claude :**
-> "Montre-moi tous les guides Spring Boot pour le développement web"
-
-**Outils utilisés :** `get_all_spring_guides`
-**Résultat :** Liste des guides web avec liens et descriptions
-
----
-
-### 4. Résolution d'un problème spécifique
-
-**Question à Claude :**
-> "Comment créer une API REST avec Spring Boot ?"
-
-**Outils utilisés :** `search_spring_docs`, `get_spring_guide`
-**Résultat :** Guide détaillé et documentation de référence
-
----
-
-### 5. Compréhension des concepts
-
-**Question à Claude :**
-> "Explique-moi l'auto-configuration dans Spring Boot"
-
-**Outils utilisés :** `search_spring_concepts`
-**Résultat :** Explication détaillée avec exemples
-
----
-
-## 🎯 Exemples de requêtes spécifiques
-
-### Recherche de documentation
-```
-Utilisateur: "Comment configurer Spring Security ?"
-Claude utilise: search_spring_docs("Spring Security configuration")
-```
-
-### Exploration de projets
-```
-Utilisateur: "Quels sont les projets Spring pour les données ?"
-Claude utilise: search_spring_projects("data")
-```
-
-### Guides spécialisés
-```
-Utilisateur: "Guides Spring Boot pour les tests"
-Claude utilise: get_all_spring_guides(category="Testing")
-```
-
-### Documentation de référence
-```
-Utilisateur: "Documentation Spring Boot pour la sécurité web"
-Claude utilise: get_spring_reference("security", "web")
-```
-
-### Concepts avancés
-```
-Utilisateur: "Qu'est-ce que Spring Actuator ?"
-Claude utilise: search_spring_concepts("actuator", "production")
-```
-
----
-
-## 💡 Conseils d'utilisation optimale
-
-### 1. Soyez spécifique dans vos questions
-- ❌ "Spring Boot"
-- ✅ "Comment configurer une base de données avec Spring Boot ?"
-
-### 2. Utilisez des mots-clés pertinents
-- ❌ "Aide"
-- ✅ "REST API", "JPA", "Security", "Testing"
-
-### 3. Explorez par domaine
-- "Projets Spring pour le cloud"
-- "Guides Spring Boot pour les microservices"
-- "Documentation Spring Security"
-
-### 4. Demandez des exemples pratiques
-- "Montre-moi un exemple de contrôleur REST"
-- "Comment tester une application Spring Boot ?"
-- "Configuration d'une base de données H2"
-
----
-
-## 🔧 Workflows recommandés
-
-### Workflow 1: Découverte d'un nouveau domaine
-1. **Rechercher les projets** → `search_spring_projects("domaine")`
-2. **Explorer un projet** → `get_spring_project("nom-projet")`
-3. **Trouver des guides** → `get_all_spring_guides(category="Domaine")`
-4. **Lire un guide spécifique** → `get_spring_guide("guide-id")`
-
-### Workflow 2: Résolution d'un problème
-1. **Rechercher dans la doc** → `search_spring_docs("problème")`
-2. **Comprendre les concepts** → `search_spring_concepts("concept")`
-3. **Consulter la référence** → `get_spring_reference("section")`
-4. **Suivre un guide pratique** → `get_spring_guide("guide-id")`
-
-### Workflow 3: Apprentissage structuré
-1. **Concepts de base** → `search_spring_concepts("core")`
-2. **Guides pour débutants** → `get_all_spring_guides(category="Getting Started")`
-3. **Documentation de référence** → `get_spring_reference("web")`
-4. **Projets avancés** → `search_spring_projects("advanced")`
-
----
-
-## 🌟 Cas d'usage avancés
-
-### Développement d'une API REST complète
-```
-1. "Quels sont les guides pour créer une API REST ?"
-2. "Montre-moi le guide pour créer un service REST"
-3. "Comment sécuriser une API REST avec Spring Security ?"
-4. "Documentation sur les tests d'API REST"
-5. "Concepts de production pour les API REST"
-```
-
-### Migration vers Spring Boot 3
-```
-1. "Quels sont les projets Spring compatibles avec Boot 3 ?"
-2. "Guide de migration Spring Boot 2 vers 3"
-3. "Nouvelles fonctionnalités Spring Boot 3"
-4. "Documentation de référence Spring Boot 3"
-```
-
-### Architecture microservices
-```
-1. "Projets Spring pour les microservices"
-2. "Guides Spring Cloud"
-3. "Concepts de configuration distribuée"
-4. "Documentation Spring Cloud Gateway"
-```
-
----
-
-## 📖 Types de réponses attendues
-
-### Listes de résultats (search_*)
-- Titres des ressources
-- Descriptions courtes
-- URLs directes
-- Types de contenu
-
-### Contenu détaillé (get_*)
-- Documentation complète en Markdown
-- Exemples de code
-- Configuration
-- Bonnes pratiques
-
-### Concepts (search_spring_concepts)
-- Définitions claires
-- Exemples concrets
-- Mots-clés associés
-- Cas d'usage
-
----
-
-*Ce serveur MCP vous donne accès à l'ensemble de l'écosystème Spring directement dans Claude Desktop !*

package/INSTALL_FR.md

@@ -1,123 +0,0 @@
-# 📦 Spring Documentation MCP Server - Installation publique
-
-Serveur MCP public pour accéder à toute la documentation Spring Boot et l'écosystème Spring complet.
-
-## 🚀 Installation rapide
-
-### Via npm (recommandé)
-```bash
-npm install -g @enokdev/springdocs-mcp
-```
-
-### Via npx (sans installation)
-```bash
-npx @enokdev/springdocs-mcp
-```
-
-## ⚡ Configuration Claude Desktop
-
-### 1. Installation globale
-```bash
-npm install -g @enokdev/springdocs-mcp
-```
-
-### 2. Configuration Claude Desktop
-Ajoutez ceci à votre `claude_desktop_config.json` :
-
-```json
-{
-  "mcpServers": {
-    "spring-docs": {
-      "command": "springdocs-mcp"
-    }
-  }
-}
-```
-
-### 3. Localisation du fichier de configuration
-- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
-- **Windows**: `%APPDATA%\\Claude\\claude_desktop_config.json`
-- **Linux**: `~/.config/Claude/claude_desktop_config.json`
-
-## 🛠️ Configuration avancée
-
-### Avec chemin spécifique
-```json
-{
-  "mcpServers": {
-    "spring-docs": {
-      "command": "node",
-      "args": ["/path/to/global/node_modules/@enokdev/springdocs-mcp/build/index.js"]
-    }
-  }
-}
-```
-
-### Avec npx (sans installation globale)
-```json
-{
-  "mcpServers": {
-    "spring-docs": {
-      "command": "npx",
-      "args": ["@enokdev/springdocs-mcp"]
-    }
-  }
-}
-```
-
-## 🔧 Outils disponibles
-
-Une fois configuré, vous aurez accès à 7 outils dans Claude Desktop :
-
-1. **`search_spring_docs`** - Recherche dans la documentation Spring Boot
-2. **`search_spring_projects`** - Recherche de projets Spring
-3. **`get_spring_project`** - Détails d'un projet Spring
-4. **`get_all_spring_guides`** - Liste des guides Spring
-5. **`get_spring_guide`** - Contenu d'un guide spécifique
-6. **`get_spring_reference`** - Documentation de référence
-7. **`search_spring_concepts`** - Recherche de concepts Spring Boot
-
-## 💡 Exemples d'utilisation
-
-Une fois installé, demandez à Claude :
-
-- *"Quels sont les projets Spring disponibles pour la sécurité ?"*
-- *"Montre-moi le guide pour créer une API REST avec Spring Boot"*
-- *"Comment configurer Spring Security ?"*
-- *"Explique-moi l'auto-configuration dans Spring Boot"*
-
-## 🔄 Mise à jour
-
-```bash
-npm update -g @enokdev/springdocs-mcp
-```
-
-## 🆘 Dépannage
-
-### Vérifier l'installation
-```bash
-springdocs-mcp --version
-```
-
-### Test manual
-```bash
-echo '{"jsonrpc": "2.0", "id": 1, "method": "tools/list", "params": {}}' | springdocs-mcp
-```
-
-### Réinstallation
-```bash
-npm uninstall -g @enokdev/springdocs-mcp
-npm install -g @enokdev/springdocs-mcp
-```
-
-## 📚 Sources de documentation
-
-Ce serveur accède à :
-- **spring.io/projects** - Tous les projets Spring
-- **spring.io/guides** - Guides pratiques
-- **docs.spring.io** - Documentation de référence
-- **Base de connaissances intégrée** - Concepts Spring Boot
-
----
-
-**🌟 Profitez de l'accès complet à l'écosystème Spring directement dans Claude Desktop !**