@enokdev/springdocs-mcp 1.2.0 → 1.2.1

package/CHANGELOG_v1.2.0.md

@@ -1,71 +0,0 @@
-# 🆕 Changelog - Version 1.2.0
-
-## [1.2.0] - 2025-08-21
-
-### ✨ Added - JetBrains IDEs Support
-
-- **🛠️ JetBrains IDEs Integration**: Full support for all JetBrains IDEs
-  - IntelliJ IDEA (Ultimate & Community)
-  - WebStorm
-  - PyCharm (Professional & Community)
-  - PhpStorm, RubyMine, CLion, GoLand, Rider, DataGrip
-  - Android Studio
-
-- **🚀 Automatic Configuration Script**: `setup-jetbrains.sh`
-  - Detects all installed JetBrains IDEs
-  - Creates appropriate configuration files
-  - Works on macOS, Linux, and Windows
-  - Color-coded output and progress indicators
-
-- **📚 JetBrains Documentation**: New `JETBRAINS_SETUP.md`
-  - Complete setup instructions
-  - IDE-specific configurations
-  - Usage examples and troubleshooting
-  - Manual and automatic setup options
-
-- **🔧 Enhanced Scripts**:
-  - `npm run setup-jetbrains` - Configure JetBrains IDEs
-  - `npm run setup-all` - Configure all supported IDEs
-
-### 🔄 Improved
-
-- **📖 Enhanced README**: Added JetBrains configuration section
-- **⚙️ VS Code Settings**: Updated `.vscode/settings.json` with MCP configuration
-- **🛠️ Troubleshooting Guide**: Updated `TROUBLESHOOTING.md` with JetBrains support
-
-### 🎯 Use Cases
-
-Now developers can use the Spring Documentation MCP Server in:
-- **Claude Desktop** - Chat interface
-- **VS Code** - With Claude extension
-- **JetBrains IDEs** - Integrated AI assistance
-- **Command Line** - Direct MCP server access
-
-### 🔧 Technical Details
-
-- Cross-platform configuration detection
-- IDE version-specific setup
-- XML and JSON configuration formats
-- Automatic path resolution for different OS
-
----
-
-## Previous Versions
-
-### [1.1.1] - 2025-08-21
-- 📝 Documentation internationalization (English)
-- 🌍 Public distribution preparation
-
-### [1.1.0] - 2025-08-21
-- ✨ Extended to complete Spring ecosystem
-- 🆕 Added 3 new MCP tools (total: 7 tools)
-- 🌐 Spring.io/projects integration
-
-### [1.0.0] - 2025-08-21
-- 🎉 Initial release
-- 📚 Basic Spring Boot documentation access
-- 🛠️ 4 core MCP tools
-
----
-
-**Full Changelog**: https://github.com/tky0065/springdocs-mcp/compare/v1.1.1...v1.2.0

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.md

@@ -1,186 +0,0 @@
-# Usage Examples - Spring Documentation MCP Server
-
-This file contains practical usage examples for the Spring Documentation MCP Server with Claude Desktop.
-
-## 🚀 Usage Scenarios
-
-### 1. Discovering Spring Projects
-
-**Question to Claude:**
-> "What Spring projects are available for security?"
-
-**Tools used:** `search_spring_projects`
-**Result:** List of Spring Security projects with descriptions
-
----
-
-### 2. Learning a New Spring Project
-
-**Question to Claude:**
-> "Can you explain the Spring Cloud project?"
-
-**Tools used:** `get_spring_project`
-**Result:** Complete Spring Cloud documentation
-
----
-
-### 3. Exploring Guides by Domain
-
-**Question to Claude:**
-> "Show me all Spring Boot guides for web development"
-
-**Tools used:** `get_all_spring_guides`
-**Result:** List of web guides with links and descriptions
-
----
-
-### 4. Solving a Specific Problem
-
-**Question to Claude:**
-> "How do I create a REST API with Spring Boot?"
-
-**Tools used:** `search_spring_docs`, `get_spring_guide`
-**Result:** Detailed guide and reference documentation
-
----
-
-### 5. Understanding Concepts
-
-**Question to Claude:**
-> "Explain Spring Boot auto-configuration to me"
-
-**Tools used:** `search_spring_concepts`
-**Result:** Detailed explanation with examples
-
----
-
-## 🎯 Specific Query Examples
-
-### Documentation Search
-```
-User: "How to configure Spring Security?"
-Claude uses: search_spring_docs("Spring Security configuration")
-```
-
-### Project Exploration
-```
-User: "What are the Spring projects for data?"
-Claude uses: search_spring_projects("data")
-```
-
-### Specialized Guides
-```
-User: "Spring Boot guides for testing"
-Claude uses: get_all_spring_guides(category="Testing")
-```
-
-### Reference Documentation
-```
-User: "Spring Boot documentation for web security"
-Claude uses: get_spring_reference("security", "web")
-```
-
-### Advanced Concepts
-```
-User: "What is Spring Actuator?"
-Claude uses: search_spring_concepts("actuator", "production")
-```
-
----
-
-## 💡 Optimal Usage Tips
-
-### 1. Be Specific in Your Questions
-- ❌ "Spring Boot"
-- ✅ "How to configure a database with Spring Boot?"
-
-### 2. Use Relevant Keywords
-- ❌ "Help"
-- ✅ "REST API", "JPA", "Security", "Testing"
-
-### 3. Explore by Domain
-- "Spring projects for cloud"
-- "Spring Boot guides for microservices"
-- "Spring Security documentation"
-
-### 4. Ask for Practical Examples
-- "Show me an example of a REST controller"
-- "How to test a Spring Boot application?"
-- "H2 database configuration"
-
----
-
-## 🔧 Recommended Workflows
-
-### Workflow 1: Discovering a New Domain
-1. **Search projects** → `search_spring_projects("domain")`
-2. **Explore a project** → `get_spring_project("project-name")`
-3. **Find guides** → `get_all_spring_guides(category="Domain")`
-4. **Read a specific guide** → `get_spring_guide("guide-id")`
-
-### Workflow 2: Problem Solving
-1. **Search documentation** → `search_spring_docs("problem")`
-2. **Understand concepts** → `search_spring_concepts("concept")`
-3. **Consult reference** → `get_spring_reference("section")`
-4. **Follow practical guide** → `get_spring_guide("guide-id")`
-
-### Workflow 3: Structured Learning
-1. **Basic concepts** → `search_spring_concepts("core")`
-2. **Beginner guides** → `get_all_spring_guides(category="Getting Started")`
-3. **Reference documentation** → `get_spring_reference("web")`
-4. **Advanced projects** → `search_spring_projects("advanced")`
-
----
-
-## 🌟 Advanced Use Cases
-
-### Developing a Complete REST API
-```
-1. "What are the guides for creating a REST API?"
-2. "Show me the guide for creating a REST service"
-3. "How to secure a REST API with Spring Security?"
-4. "Documentation on REST API testing"
-5. "Production concepts for REST APIs"
-```
-
-### Migration to Spring Boot 3
-```
-1. "What Spring projects are compatible with Boot 3?"
-2. "Spring Boot 2 to 3 migration guide"
-3. "Spring Boot 3 new features"
-4. "Spring Boot 3 reference documentation"
-```
-
-### Microservices Architecture
-```
-1. "Spring projects for microservices"
-2. "Spring Cloud guides"
-3. "Distributed configuration concepts"
-4. "Spring Cloud Gateway documentation"
-```
-
----
-
-## 📖 Expected Response Types
-
-### Search Results (search_*)
-- Resource titles
-- Short descriptions
-- Direct URLs
-- Content types
-
-### Detailed Content (get_*)
-- Complete documentation in Markdown
-- Code examples
-- Configuration
-- Best practices
-
-### Concepts (search_spring_concepts)
-- Clear definitions
-- Concrete examples
-- Associated keywords
-- Use cases
-
----
-
-*This MCP server gives you access to the entire Spring ecosystem directly in Claude Desktop!*

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 !*