@enokdev/springdocs-mcp 1.1.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,82 +1,82 @@
1
1
  # Changelog - Spring Boot MCP Server
2
2
 
3
- Toutes les modifications notables de ce projet seront documentées dans ce fichier.
3
+ All notable changes to this project will be documented in this file.
4
4
 
5
- Le format est basé sur [Keep a Changelog](https://keepachangelog.com/fr/1.0.0/),
6
- et ce projet adhère au [versioning sémantique](https://semver.org/spec/v2.0.0.html).
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
8
  ## [1.1.0] - 2025-08-21
9
9
 
10
- ### ✨ Ajouté
11
- - **Support complet de spring.io/projects** - Accès à tous les projets Spring (Security, Data, Cloud, etc.)
12
- - **Nouvel outil `search_spring_projects`** - Recherche parmi tous les projets Spring disponibles
13
- - **Nouvel outil `get_spring_project`** - Récupération des détails complets d'un projet Spring spécifique
14
- - **Nouvel outil `get_all_spring_guides`** - Liste tous les guides Spring avec filtrage par catégorie
15
- - **Base de connaissances étendue** - Projets Spring populaires intégrés pour un fallback robuste
16
- - **Documentation enrichie** - Guides d'exemples pratiques (EXAMPLES.md)
17
- - **Guide de contribution** - Documentation pour les développeurs (CONTRIBUTING.md)
18
-
19
- ### 🔧 Amélioré
20
- - **Couverture documentaire élargie** - Passage de 4 à 7 outils MCP
21
- - **Robustesse du service** - Mécanismes de fallback pour les projets et guides populaires
22
- - **Performance des requêtes** - Optimisation du parsing HTML et conversion Markdown
23
- - **Tests étendus** - Script de test mis à jour avec tous les nouveaux outils
24
-
25
- ### 📚 Sources de documentation ajoutées
26
- - `https://spring.io/projects` - Catalogue complet des projets Spring
27
- - `https://spring.io/guides` - Collection étendue de guides pratiques
28
- - Base de connaissances des projets populaires (Boot, Security, Data, Cloud, etc.)
29
-
30
- ### 🛠️ Outils MCP (7 au total)
31
- 1. `search_spring_docs` - Recherche dans la documentation Spring Boot *(existant)*
32
- 2. `search_spring_projects` - **NOUVEAU** - Recherche de projets Spring
33
- 3. `get_spring_project` - **NOUVEAU** - Détails d'un projet Spring
34
- 4. `get_all_spring_guides` - **NOUVEAU** - Liste des guides Spring
35
- 5. `get_spring_guide` - Récupération d'un guide spécifique *(existant)*
36
- 6. `get_spring_reference` - Documentation de référence *(existant)*
37
- 7. `search_spring_concepts` - Recherche de concepts *(existant)*
10
+ ### ✨ Added
11
+ - **Complete spring.io/projects support** - Access to all Spring projects (Security, Data, Cloud, etc.)
12
+ - **New `search_spring_projects` tool** - Search among all available Spring projects
13
+ - **New `get_spring_project` tool** - Retrieve complete details of a specific Spring project
14
+ - **New `get_all_spring_guides` tool** - List all Spring guides with category filtering
15
+ - **Extended knowledge base** - Popular Spring projects integrated for robust fallback
16
+ - **Enhanced documentation** - Practical examples guide (EXAMPLES.md)
17
+ - **Contribution guide** - Developer documentation (CONTRIBUTING.md)
18
+
19
+ ### 🔧 Improved
20
+ - **Expanded documentation coverage** - From 4 to 7 MCP tools
21
+ - **Service robustness** - Fallback mechanisms for popular projects and guides
22
+ - **Query performance** - Optimized HTML parsing and Markdown conversion
23
+ - **Extended testing** - Updated test script with all new tools
24
+
25
+ ### 📚 Added Documentation Sources
26
+ - `https://spring.io/projects` - Complete catalog of Spring projects
27
+ - `https://spring.io/guides` - Extended collection of practical guides
28
+ - Popular projects knowledge base (Boot, Security, Data, Cloud, etc.)
29
+
30
+ ### 🛠️ MCP Tools (7 total)
31
+ 1. `search_spring_docs` - Search Spring Boot documentation *(existing)*
32
+ 2. `search_spring_projects` - **NEW** - Search Spring projects
33
+ 3. `get_spring_project` - **NEW** - Spring project details
34
+ 4. `get_all_spring_guides` - **NEW** - List Spring guides
35
+ 5. `get_spring_guide` - Retrieve specific guide *(existing)*
36
+ 6. `get_spring_reference` - Reference documentation *(existing)*
37
+ 7. `search_spring_concepts` - Search concepts *(existing)*
38
38
 
39
39
  ## [1.0.0] - 2025-08-21
40
40
 
41
- ### ✨ Version initiale
42
- - **Serveur MCP fonctionnel** - Implémentation complète du protocole Model Context Protocol
43
- - **4 outils de base** - Accès à la documentation Spring Boot essentielle
44
- - **Architecture TypeScript** - Code moderne avec types stricts
45
- - **Configuration Claude Desktop** - Intégration prête à l'emploi
46
- - **Tests automatisés** - Script de validation des fonctionnalités
47
- - **Documentation complète** - README avec instructions d'installation et usage
48
-
49
- ### 🛠️ Outils MCP de base
50
- 1. `search_spring_docs` - Recherche dans la documentation Spring Boot
51
- 2. `get_spring_guide` - Récupération d'un guide spécifique
52
- 3. `get_spring_reference` - Documentation de référence
53
- 4. `search_spring_concepts` - Recherche de concepts Spring Boot
54
-
55
- ### 📚 Sources de documentation initiales
56
- - Documentation Spring Boot officielle
57
- - Guides Spring.io sélectionnés
58
- - Base de connaissances des concepts Spring Boot
59
-
60
- ### 🔧 Fonctionnalités techniques
61
- - Transport stdio pour communication MCP
62
- - Parsing HTML avec Cheerio
63
- - Conversion Markdown avec Turndown
64
- - Gestion d'erreurs robuste
65
- - Support des requêtes JSON-RPC 2.0
41
+ ### ✨ Initial Release
42
+ - **Functional MCP server** - Complete Model Context Protocol implementation
43
+ - **4 basic tools** - Access to essential Spring Boot documentation
44
+ - **TypeScript architecture** - Modern code with strict types
45
+ - **Claude Desktop configuration** - Ready-to-use integration
46
+ - **Automated testing** - Functionality validation script
47
+ - **Complete documentation** - README with installation and usage instructions
48
+
49
+ ### 🛠️ Basic MCP Tools
50
+ 1. `search_spring_docs` - Search Spring Boot documentation
51
+ 2. `get_spring_guide` - Retrieve specific guide
52
+ 3. `get_spring_reference` - Reference documentation
53
+ 4. `search_spring_concepts` - Search Spring Boot concepts
54
+
55
+ ### 📚 Initial Documentation Sources
56
+ - Official Spring Boot documentation
57
+ - Selected Spring.io guides
58
+ - Spring Boot concepts knowledge base
59
+
60
+ ### 🔧 Technical Features
61
+ - stdio transport for MCP communication
62
+ - HTML parsing with Cheerio
63
+ - Markdown conversion with Turndown
64
+ - Robust error handling
65
+ - JSON-RPC 2.0 request support
66
66
 
67
67
  ---
68
68
 
69
- ## Format des versions
69
+ ## Version Format
70
70
 
71
- - **MAJOR** : Changements incompatibles de l'API
72
- - **MINOR** : Nouvelles fonctionnalités compatibles
73
- - **PATCH** : Corrections de bugs compatibles
71
+ - **MAJOR**: Incompatible API changes
72
+ - **MINOR**: Backward-compatible new features
73
+ - **PATCH**: Backward-compatible bug fixes
74
74
 
75
- ## Types de changements
75
+ ## Types of Changes
76
76
 
77
- - `✨ Ajouté` pour les nouvelles fonctionnalités
78
- - `🔧 Amélioré` pour les modifications de fonctionnalités existantes
79
- - `🐛 Corrigé` pour les corrections de bugs
80
- - `❌ Supprimé` pour les fonctionnalités supprimées
81
- - `⚠️ Déprécié` pour les fonctionnalités bientôt supprimées
82
- - `🔒 Sécurité` pour les corrections de vulnérabilités
77
+ - `✨ Added` for new features
78
+ - `🔧 Improved` for changes to existing functionality
79
+ - `🐛 Fixed` for bug fixes
80
+ - `❌ Removed` for removed features
81
+ - `⚠️ Deprecated` for soon-to-be removed features
82
+ - `🔒 Security` for vulnerability fixes
@@ -0,0 +1,71 @@
1
+ # 🆕 Changelog - Version 1.2.0
2
+
3
+ ## [1.2.0] - 2025-08-21
4
+
5
+ ### ✨ Added - JetBrains IDEs Support
6
+
7
+ - **🛠️ JetBrains IDEs Integration**: Full support for all JetBrains IDEs
8
+ - IntelliJ IDEA (Ultimate & Community)
9
+ - WebStorm
10
+ - PyCharm (Professional & Community)
11
+ - PhpStorm, RubyMine, CLion, GoLand, Rider, DataGrip
12
+ - Android Studio
13
+
14
+ - **🚀 Automatic Configuration Script**: `setup-jetbrains.sh`
15
+ - Detects all installed JetBrains IDEs
16
+ - Creates appropriate configuration files
17
+ - Works on macOS, Linux, and Windows
18
+ - Color-coded output and progress indicators
19
+
20
+ - **📚 JetBrains Documentation**: New `JETBRAINS_SETUP.md`
21
+ - Complete setup instructions
22
+ - IDE-specific configurations
23
+ - Usage examples and troubleshooting
24
+ - Manual and automatic setup options
25
+
26
+ - **🔧 Enhanced Scripts**:
27
+ - `npm run setup-jetbrains` - Configure JetBrains IDEs
28
+ - `npm run setup-all` - Configure all supported IDEs
29
+
30
+ ### 🔄 Improved
31
+
32
+ - **📖 Enhanced README**: Added JetBrains configuration section
33
+ - **⚙️ VS Code Settings**: Updated `.vscode/settings.json` with MCP configuration
34
+ - **🛠️ Troubleshooting Guide**: Updated `TROUBLESHOOTING.md` with JetBrains support
35
+
36
+ ### 🎯 Use Cases
37
+
38
+ Now developers can use the Spring Documentation MCP Server in:
39
+ - **Claude Desktop** - Chat interface
40
+ - **VS Code** - With Claude extension
41
+ - **JetBrains IDEs** - Integrated AI assistance
42
+ - **Command Line** - Direct MCP server access
43
+
44
+ ### 🔧 Technical Details
45
+
46
+ - Cross-platform configuration detection
47
+ - IDE version-specific setup
48
+ - XML and JSON configuration formats
49
+ - Automatic path resolution for different OS
50
+
51
+ ---
52
+
53
+ ## Previous Versions
54
+
55
+ ### [1.1.1] - 2025-08-21
56
+ - 📝 Documentation internationalization (English)
57
+ - 🌍 Public distribution preparation
58
+
59
+ ### [1.1.0] - 2025-08-21
60
+ - ✨ Extended to complete Spring ecosystem
61
+ - 🆕 Added 3 new MCP tools (total: 7 tools)
62
+ - 🌐 Spring.io/projects integration
63
+
64
+ ### [1.0.0] - 2025-08-21
65
+ - 🎉 Initial release
66
+ - 📚 Basic Spring Boot documentation access
67
+ - 🛠️ 4 core MCP tools
68
+
69
+ ---
70
+
71
+ **Full Changelog**: https://github.com/tky0065/springdocs-mcp/compare/v1.1.1...v1.2.0
package/EXAMPLES.md CHANGED
@@ -1,186 +1,186 @@
1
- # Exemples d'utilisation du serveur MCP Spring Documentation
1
+ # Usage Examples - Spring Documentation MCP Server
2
2
 
3
- Ce fichier contient des exemples pratiques d'utilisation du serveur MCP Spring Documentation avec Claude Desktop.
3
+ This file contains practical usage examples for the Spring Documentation MCP Server with Claude Desktop.
4
4
 
5
- ## 🚀 Scénarios d'utilisation
5
+ ## 🚀 Usage Scenarios
6
6
 
7
- ### 1. Découverte des projets Spring
7
+ ### 1. Discovering Spring Projects
8
8
 
9
- **Question à Claude :**
10
- > "Quels sont les projets Spring disponibles pour la sécurité ?"
9
+ **Question to Claude:**
10
+ > "What Spring projects are available for security?"
11
11
 
12
- **Outils utilisés :** `search_spring_projects`
13
- **Résultat :** Liste des projets Spring Security avec descriptions
12
+ **Tools used:** `search_spring_projects`
13
+ **Result:** List of Spring Security projects with descriptions
14
14
 
15
15
  ---
16
16
 
17
- ### 2. Apprentissage d'un nouveau projet Spring
17
+ ### 2. Learning a New Spring Project
18
18
 
19
- **Question à Claude :**
20
- > "Peux-tu m'expliquer le projet Spring Cloud ?"
19
+ **Question to Claude:**
20
+ > "Can you explain the Spring Cloud project?"
21
21
 
22
- **Outils utilisés :** `get_spring_project`
23
- **Résultat :** Documentation complète de Spring Cloud
22
+ **Tools used:** `get_spring_project`
23
+ **Result:** Complete Spring Cloud documentation
24
24
 
25
25
  ---
26
26
 
27
- ### 3. Exploration des guides par domaine
27
+ ### 3. Exploring Guides by Domain
28
28
 
29
- **Question à Claude :**
30
- > "Montre-moi tous les guides Spring Boot pour le développement web"
29
+ **Question to Claude:**
30
+ > "Show me all Spring Boot guides for web development"
31
31
 
32
- **Outils utilisés :** `get_all_spring_guides`
33
- **Résultat :** Liste des guides web avec liens et descriptions
32
+ **Tools used:** `get_all_spring_guides`
33
+ **Result:** List of web guides with links and descriptions
34
34
 
35
35
  ---
36
36
 
37
- ### 4. Résolution d'un problème spécifique
37
+ ### 4. Solving a Specific Problem
38
38
 
39
- **Question à Claude :**
40
- > "Comment créer une API REST avec Spring Boot ?"
39
+ **Question to Claude:**
40
+ > "How do I create a REST API with Spring Boot?"
41
41
 
42
- **Outils utilisés :** `search_spring_docs`, `get_spring_guide`
43
- **Résultat :** Guide détaillé et documentation de référence
42
+ **Tools used:** `search_spring_docs`, `get_spring_guide`
43
+ **Result:** Detailed guide and reference documentation
44
44
 
45
45
  ---
46
46
 
47
- ### 5. Compréhension des concepts
47
+ ### 5. Understanding Concepts
48
48
 
49
- **Question à Claude :**
50
- > "Explique-moi l'auto-configuration dans Spring Boot"
49
+ **Question to Claude:**
50
+ > "Explain Spring Boot auto-configuration to me"
51
51
 
52
- **Outils utilisés :** `search_spring_concepts`
53
- **Résultat :** Explication détaillée avec exemples
52
+ **Tools used:** `search_spring_concepts`
53
+ **Result:** Detailed explanation with examples
54
54
 
55
55
  ---
56
56
 
57
- ## 🎯 Exemples de requêtes spécifiques
57
+ ## 🎯 Specific Query Examples
58
58
 
59
- ### Recherche de documentation
59
+ ### Documentation Search
60
60
  ```
61
- Utilisateur: "Comment configurer Spring Security ?"
62
- Claude utilise: search_spring_docs("Spring Security configuration")
61
+ User: "How to configure Spring Security?"
62
+ Claude uses: search_spring_docs("Spring Security configuration")
63
63
  ```
64
64
 
65
- ### Exploration de projets
65
+ ### Project Exploration
66
66
  ```
67
- Utilisateur: "Quels sont les projets Spring pour les données ?"
68
- Claude utilise: search_spring_projects("data")
67
+ User: "What are the Spring projects for data?"
68
+ Claude uses: search_spring_projects("data")
69
69
  ```
70
70
 
71
- ### Guides spécialisés
71
+ ### Specialized Guides
72
72
  ```
73
- Utilisateur: "Guides Spring Boot pour les tests"
74
- Claude utilise: get_all_spring_guides(category="Testing")
73
+ User: "Spring Boot guides for testing"
74
+ Claude uses: get_all_spring_guides(category="Testing")
75
75
  ```
76
76
 
77
- ### Documentation de référence
77
+ ### Reference Documentation
78
78
  ```
79
- Utilisateur: "Documentation Spring Boot pour la sécurité web"
80
- Claude utilise: get_spring_reference("security", "web")
79
+ User: "Spring Boot documentation for web security"
80
+ Claude uses: get_spring_reference("security", "web")
81
81
  ```
82
82
 
83
- ### Concepts avancés
83
+ ### Advanced Concepts
84
84
  ```
85
- Utilisateur: "Qu'est-ce que Spring Actuator ?"
86
- Claude utilise: search_spring_concepts("actuator", "production")
85
+ User: "What is Spring Actuator?"
86
+ Claude uses: search_spring_concepts("actuator", "production")
87
87
  ```
88
88
 
89
89
  ---
90
90
 
91
- ## 💡 Conseils d'utilisation optimale
91
+ ## 💡 Optimal Usage Tips
92
92
 
93
- ### 1. Soyez spécifique dans vos questions
93
+ ### 1. Be Specific in Your Questions
94
94
  - ❌ "Spring Boot"
95
- - ✅ "Comment configurer une base de données avec Spring Boot ?"
95
+ - ✅ "How to configure a database with Spring Boot?"
96
96
 
97
- ### 2. Utilisez des mots-clés pertinents
98
- - ❌ "Aide"
97
+ ### 2. Use Relevant Keywords
98
+ - ❌ "Help"
99
99
  - ✅ "REST API", "JPA", "Security", "Testing"
100
100
 
101
- ### 3. Explorez par domaine
102
- - "Projets Spring pour le cloud"
103
- - "Guides Spring Boot pour les microservices"
104
- - "Documentation Spring Security"
101
+ ### 3. Explore by Domain
102
+ - "Spring projects for cloud"
103
+ - "Spring Boot guides for microservices"
104
+ - "Spring Security documentation"
105
105
 
106
- ### 4. Demandez des exemples pratiques
107
- - "Montre-moi un exemple de contrôleur REST"
108
- - "Comment tester une application Spring Boot ?"
109
- - "Configuration d'une base de données H2"
106
+ ### 4. Ask for Practical Examples
107
+ - "Show me an example of a REST controller"
108
+ - "How to test a Spring Boot application?"
109
+ - "H2 database configuration"
110
110
 
111
111
  ---
112
112
 
113
- ## 🔧 Workflows recommandés
113
+ ## 🔧 Recommended Workflows
114
114
 
115
- ### Workflow 1: Découverte d'un nouveau domaine
116
- 1. **Rechercher les projets** → `search_spring_projects("domaine")`
117
- 2. **Explorer un projet** → `get_spring_project("nom-projet")`
118
- 3. **Trouver des guides** → `get_all_spring_guides(category="Domaine")`
119
- 4. **Lire un guide spécifique** → `get_spring_guide("guide-id")`
115
+ ### Workflow 1: Discovering a New Domain
116
+ 1. **Search projects** → `search_spring_projects("domain")`
117
+ 2. **Explore a project** → `get_spring_project("project-name")`
118
+ 3. **Find guides** → `get_all_spring_guides(category="Domain")`
119
+ 4. **Read a specific guide** → `get_spring_guide("guide-id")`
120
120
 
121
- ### Workflow 2: Résolution d'un problème
122
- 1. **Rechercher dans la doc** → `search_spring_docs("problème")`
123
- 2. **Comprendre les concepts** → `search_spring_concepts("concept")`
124
- 3. **Consulter la référence** → `get_spring_reference("section")`
125
- 4. **Suivre un guide pratique** → `get_spring_guide("guide-id")`
121
+ ### Workflow 2: Problem Solving
122
+ 1. **Search documentation** → `search_spring_docs("problem")`
123
+ 2. **Understand concepts** → `search_spring_concepts("concept")`
124
+ 3. **Consult reference** → `get_spring_reference("section")`
125
+ 4. **Follow practical guide** → `get_spring_guide("guide-id")`
126
126
 
127
- ### Workflow 3: Apprentissage structuré
128
- 1. **Concepts de base** → `search_spring_concepts("core")`
129
- 2. **Guides pour débutants** → `get_all_spring_guides(category="Getting Started")`
130
- 3. **Documentation de référence** → `get_spring_reference("web")`
131
- 4. **Projets avancés** → `search_spring_projects("advanced")`
127
+ ### Workflow 3: Structured Learning
128
+ 1. **Basic concepts** → `search_spring_concepts("core")`
129
+ 2. **Beginner guides** → `get_all_spring_guides(category="Getting Started")`
130
+ 3. **Reference documentation** → `get_spring_reference("web")`
131
+ 4. **Advanced projects** → `search_spring_projects("advanced")`
132
132
 
133
133
  ---
134
134
 
135
- ## 🌟 Cas d'usage avancés
135
+ ## 🌟 Advanced Use Cases
136
136
 
137
- ### Développement d'une API REST complète
137
+ ### Developing a Complete REST API
138
138
  ```
139
- 1. "Quels sont les guides pour créer une API REST ?"
140
- 2. "Montre-moi le guide pour créer un service REST"
141
- 3. "Comment sécuriser une API REST avec Spring Security ?"
142
- 4. "Documentation sur les tests d'API REST"
143
- 5. "Concepts de production pour les API REST"
139
+ 1. "What are the guides for creating a REST API?"
140
+ 2. "Show me the guide for creating a REST service"
141
+ 3. "How to secure a REST API with Spring Security?"
142
+ 4. "Documentation on REST API testing"
143
+ 5. "Production concepts for REST APIs"
144
144
  ```
145
145
 
146
- ### Migration vers Spring Boot 3
146
+ ### Migration to Spring Boot 3
147
147
  ```
148
- 1. "Quels sont les projets Spring compatibles avec Boot 3 ?"
149
- 2. "Guide de migration Spring Boot 2 vers 3"
150
- 3. "Nouvelles fonctionnalités Spring Boot 3"
151
- 4. "Documentation de référence Spring Boot 3"
148
+ 1. "What Spring projects are compatible with Boot 3?"
149
+ 2. "Spring Boot 2 to 3 migration guide"
150
+ 3. "Spring Boot 3 new features"
151
+ 4. "Spring Boot 3 reference documentation"
152
152
  ```
153
153
 
154
- ### Architecture microservices
154
+ ### Microservices Architecture
155
155
  ```
156
- 1. "Projets Spring pour les microservices"
157
- 2. "Guides Spring Cloud"
158
- 3. "Concepts de configuration distribuée"
159
- 4. "Documentation Spring Cloud Gateway"
156
+ 1. "Spring projects for microservices"
157
+ 2. "Spring Cloud guides"
158
+ 3. "Distributed configuration concepts"
159
+ 4. "Spring Cloud Gateway documentation"
160
160
  ```
161
161
 
162
162
  ---
163
163
 
164
- ## 📖 Types de réponses attendues
164
+ ## 📖 Expected Response Types
165
165
 
166
- ### Listes de résultats (search_*)
167
- - Titres des ressources
168
- - Descriptions courtes
169
- - URLs directes
170
- - Types de contenu
166
+ ### Search Results (search_*)
167
+ - Resource titles
168
+ - Short descriptions
169
+ - Direct URLs
170
+ - Content types
171
171
 
172
- ### Contenu détaillé (get_*)
173
- - Documentation complète en Markdown
174
- - Exemples de code
172
+ ### Detailed Content (get_*)
173
+ - Complete documentation in Markdown
174
+ - Code examples
175
175
  - Configuration
176
- - Bonnes pratiques
176
+ - Best practices
177
177
 
178
178
  ### Concepts (search_spring_concepts)
179
- - Définitions claires
180
- - Exemples concrets
181
- - Mots-clés associés
182
- - Cas d'usage
179
+ - Clear definitions
180
+ - Concrete examples
181
+ - Associated keywords
182
+ - Use cases
183
183
 
184
184
  ---
185
185
 
186
- *Ce serveur MCP vous donne accès à l'ensemble de l'écosystème Spring directement dans Claude Desktop !*
186
+ *This MCP server gives you access to the entire Spring ecosystem directly in Claude Desktop!*