@enokdev/springdocs-mcp 1.2.0 → 1.2.2

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/INSTALL_FR.md DELETED
@@ -1,123 +0,0 @@
1
- # 📦 Spring Documentation MCP Server - Installation publique
2
-
3
- Serveur MCP public pour accéder à toute la documentation Spring Boot et l'écosystème Spring complet.
4
-
5
- ## 🚀 Installation rapide
6
-
7
- ### Via npm (recommandé)
8
- ```bash
9
- npm install -g @enokdev/springdocs-mcp
10
- ```
11
-
12
- ### Via npx (sans installation)
13
- ```bash
14
- npx @enokdev/springdocs-mcp
15
- ```
16
-
17
- ## ⚡ Configuration Claude Desktop
18
-
19
- ### 1. Installation globale
20
- ```bash
21
- npm install -g @enokdev/springdocs-mcp
22
- ```
23
-
24
- ### 2. Configuration Claude Desktop
25
- Ajoutez ceci à votre `claude_desktop_config.json` :
26
-
27
- ```json
28
- {
29
- "mcpServers": {
30
- "spring-docs": {
31
- "command": "springdocs-mcp"
32
- }
33
- }
34
- }
35
- ```
36
-
37
- ### 3. Localisation du fichier de configuration
38
- - **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
39
- - **Windows**: `%APPDATA%\\Claude\\claude_desktop_config.json`
40
- - **Linux**: `~/.config/Claude/claude_desktop_config.json`
41
-
42
- ## 🛠️ Configuration avancée
43
-
44
- ### Avec chemin spécifique
45
- ```json
46
- {
47
- "mcpServers": {
48
- "spring-docs": {
49
- "command": "node",
50
- "args": ["/path/to/global/node_modules/@enokdev/springdocs-mcp/build/index.js"]
51
- }
52
- }
53
- }
54
- ```
55
-
56
- ### Avec npx (sans installation globale)
57
- ```json
58
- {
59
- "mcpServers": {
60
- "spring-docs": {
61
- "command": "npx",
62
- "args": ["@enokdev/springdocs-mcp"]
63
- }
64
- }
65
- }
66
- ```
67
-
68
- ## 🔧 Outils disponibles
69
-
70
- Une fois configuré, vous aurez accès à 7 outils dans Claude Desktop :
71
-
72
- 1. **`search_spring_docs`** - Recherche dans la documentation Spring Boot
73
- 2. **`search_spring_projects`** - Recherche de projets Spring
74
- 3. **`get_spring_project`** - Détails d'un projet Spring
75
- 4. **`get_all_spring_guides`** - Liste des guides Spring
76
- 5. **`get_spring_guide`** - Contenu d'un guide spécifique
77
- 6. **`get_spring_reference`** - Documentation de référence
78
- 7. **`search_spring_concepts`** - Recherche de concepts Spring Boot
79
-
80
- ## 💡 Exemples d'utilisation
81
-
82
- Une fois installé, demandez à Claude :
83
-
84
- - *"Quels sont les projets Spring disponibles pour la sécurité ?"*
85
- - *"Montre-moi le guide pour créer une API REST avec Spring Boot"*
86
- - *"Comment configurer Spring Security ?"*
87
- - *"Explique-moi l'auto-configuration dans Spring Boot"*
88
-
89
- ## 🔄 Mise à jour
90
-
91
- ```bash
92
- npm update -g @enokdev/springdocs-mcp
93
- ```
94
-
95
- ## 🆘 Dépannage
96
-
97
- ### Vérifier l'installation
98
- ```bash
99
- springdocs-mcp --version
100
- ```
101
-
102
- ### Test manual
103
- ```bash
104
- echo '{"jsonrpc": "2.0", "id": 1, "method": "tools/list", "params": {}}' | springdocs-mcp
105
- ```
106
-
107
- ### Réinstallation
108
- ```bash
109
- npm uninstall -g @enokdev/springdocs-mcp
110
- npm install -g @enokdev/springdocs-mcp
111
- ```
112
-
113
- ## 📚 Sources de documentation
114
-
115
- Ce serveur accède à :
116
- - **spring.io/projects** - Tous les projets Spring
117
- - **spring.io/guides** - Guides pratiques
118
- - **docs.spring.io** - Documentation de référence
119
- - **Base de connaissances intégrée** - Concepts Spring Boot
120
-
121
- ---
122
-
123
- **🌟 Profitez de l'accès complet à l'écosystème Spring directement dans Claude Desktop !**
@@ -1,171 +0,0 @@
1
- # 🚀 Configuration pour IDEs JetBrains
2
-
3
- ## 📋 IDEs JetBrains supportés
4
-
5
- - **IntelliJ IDEA** (Ultimate & Community)
6
- - **WebStorm**
7
- - **PyCharm** (Professional & Community)
8
- - **PhpStorm**
9
- - **RubyMine**
10
- - **CLion**
11
- - **GoLand**
12
- - **Rider**
13
- - **DataGrip**
14
- - **Android Studio**
15
-
16
- ## ⚙️ Configuration
17
-
18
- ### Option 1: Via le Plugin Claude (Recommandé)
19
-
20
- 1. **Installer le plugin Claude** depuis JetBrains Marketplace
21
- 2. **Configurer les serveurs MCP** dans Settings
22
-
23
- **Chemin:** `Settings → Tools → Claude → MCP Servers`
24
-
25
- **Configuration:**
26
- ```json
27
- {
28
- "spring-docs": {
29
- "command": "/opt/homebrew/bin/springdocs-mcp"
30
- }
31
- }
32
- ```
33
-
34
- ### Option 2: Configuration manuelle
35
-
36
- **Fichier de configuration JetBrains:**
37
- `~/.jetbrains/claude_mcp_config.json`
38
-
39
- ```json
40
- {
41
- "mcpServers": {
42
- "spring-docs": {
43
- "command": "/opt/homebrew/bin/springdocs-mcp",
44
- "description": "Spring Documentation MCP Server - Access to complete Spring ecosystem",
45
- "timeout": 30000
46
- }
47
- }
48
- }
49
- ```
50
-
51
- ### Option 3: Configuration par IDE
52
-
53
- #### IntelliJ IDEA
54
- **Fichier:** `~/.IntelliJIdea/config/options/claude.xml`
55
-
56
- ```xml
57
- <application>
58
- <component name="ClaudeSettings">
59
- <option name="mcpServers">
60
- <map>
61
- <entry key="spring-docs">
62
- <value>
63
- <MCPServerConfig>
64
- <option name="command" value="/opt/homebrew/bin/springdocs-mcp" />
65
- <option name="description" value="Spring Documentation" />
66
- </MCPServerConfig>
67
- </value>
68
- </entry>
69
- </map>
70
- </option>
71
- </component>
72
- </application>
73
- ```
74
-
75
- #### WebStorm
76
- **Fichier:** `~/.WebStorm/config/options/claude.xml`
77
-
78
- #### PyCharm
79
- **Fichier:** `~/.PyCharm/config/options/claude.xml`
80
-
81
- ## 🔧 Script d'installation automatique
82
-
83
- Créons un script pour configurer automatiquement tous vos IDEs JetBrains :
84
-
85
- ```bash
86
- #!/bin/bash
87
- ./setup-jetbrains.sh
88
- ```
89
-
90
- ## 🎯 Utilisation dans JetBrains IDEs
91
-
92
- ### 1. Accès via Chat AI
93
-
94
- Dans votre IDE JetBrains avec Claude activé :
95
-
96
- ```
97
- Quels sont les projets Spring pour la sécurité ?
98
- ```
99
-
100
- ### 2. Aide contextuelle
101
-
102
- Sélectionnez du code Spring et demandez :
103
-
104
- ```
105
- Comment améliorer cette configuration Spring Boot ?
106
- ```
107
-
108
- ### 3. Documentation instantanée
109
-
110
- ```
111
- Montre-moi le guide Spring Boot pour les APIs REST
112
- ```
113
-
114
- ## 🛠️ Outils disponibles dans JetBrains
115
-
116
- Tous les 7 outils MCP seront disponibles :
117
-
118
- 1. **search_spring_docs** - Recherche documentation
119
- 2. **search_spring_projects** - Projets Spring
120
- 3. **get_spring_project** - Détails projet
121
- 4. **get_all_spring_guides** - Liste guides
122
- 5. **get_spring_guide** - Contenu guide
123
- 6. **get_spring_reference** - Référence
124
- 7. **search_spring_concepts** - Concepts
125
-
126
- ## 📝 Exemples d'utilisation
127
-
128
- ### Développement Spring Boot dans IntelliJ
129
-
130
- ```java
131
- @RestController
132
- public class UserController {
133
- // Demander à Claude : "Montre-moi les meilleures pratiques pour ce contrôleur"
134
- }
135
- ```
136
-
137
- ### Configuration dans application.yml
138
-
139
- ```yaml
140
- spring:
141
- # Demander : "Quelles sont les options de configuration disponibles ?"
142
- ```
143
-
144
- ## 🔍 Dépannage JetBrains
145
-
146
- ### Plugin Claude non visible
147
- 1. Vérifier que le plugin est installé
148
- 2. Redémarrer l'IDE
149
- 3. Vérifier les permissions
150
-
151
- ### MCP Server non connecté
152
- 1. Vérifier le chemin : `/opt/homebrew/bin/springdocs-mcp`
153
- 2. Tester la commande dans le terminal
154
- 3. Vérifier les logs de l'IDE
155
-
156
- ## 📍 Emplacements des configurations
157
-
158
- ### macOS
159
- - **IntelliJ IDEA:** `~/Library/Application Support/JetBrains/IntelliJIdea*/`
160
- - **WebStorm:** `~/Library/Application Support/JetBrains/WebStorm*/`
161
- - **PyCharm:** `~/Library/Application Support/JetBrains/PyCharm*/`
162
-
163
- ### Windows
164
- - **Tous IDEs:** `%APPDATA%\JetBrains\[IDE_NAME]*\`
165
-
166
- ### Linux
167
- - **Tous IDEs:** `~/.config/JetBrains/[IDE_NAME]*/`
168
-
169
- ---
170
-
171
- **Note:** La disponibilité exacte dépend de la version du plugin Claude pour JetBrains. Consultez la documentation officielle du plugin pour les détails spécifiques à votre IDE.
package/README_FR.md DELETED
@@ -1,219 +0,0 @@
1
- # 📚 Spring Documentation MCP Server
2
-
3
- [![npm version](https://badge.fury.io/js/@enokdev%2Fspringdocs-mcp.svg)](https://badge.fury.io/js/@enokdev%2Fspringdocs-mcp)
4
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5
- [![Node.js](https://img.shields.io/badge/Node.js-18+-green.svg)](https://nodejs.org/)
6
- [![GitHub](https://img.shields.io/badge/GitHub-tky0065/springdocs--mcp-blue.svg)](https://github.com/tky0065/springdocs-mcp)
7
-
8
- A public **Model Context Protocol (MCP)** server that provides access to the complete Spring Boot documentation and Spring ecosystem directly in Claude Desktop.
9
-
10
- ## 🚀 Quick Installation
11
-
12
- ```bash
13
- npm install -g @enokdev/springdocs-mcp
14
- ```
15
-
16
- Then add to your `claude_desktop_config.json`:
17
- ```json
18
- {
19
- "mcpServers": {
20
- "spring-docs": {
21
- "command": "springdocs-mcp"
22
- }
23
- }
24
- }
25
- ```
26
-
27
- ## ✨ Features
28
-
29
- - 🌐 **Complete access** to spring.io/projects (all Spring projects)
30
- - 📖 **Practical guides** spring.io/guides with filtering
31
- - 📚 **Reference documentation** docs.spring.io
32
- - � **Recherche intelligente** dans tout l'écosystème Spring
33
- - 💡 **Base de connaissances** intégrée des concepts Spring Boot
34
- - ⚡ **7 outils MCP** pour une exploration complète
35
-
36
- ## 🛠️ Utilisation
37
-
38
- ### Démarrage du serveur
39
-
40
- ```bash
41
- npm start
42
- ```
43
-
44
- ou
45
-
46
- ```bash
47
- node build/index.js
48
- ```
49
-
50
- ## 🛠️ Outils disponibles
51
-
52
- Le serveur MCP propose **7 outils** pour explorer la documentation Spring :
53
-
54
- ### 1. `search_spring_docs`
55
- Recherche dans la documentation Spring Boot avec des mots-clés.
56
-
57
- **Paramètres :**
58
- - `query` (string, requis) : Mots-clés à rechercher
59
- - `docType` (string, optionnel) : Type de documentation (`guides`, `reference`, `api`, `all`)
60
- - `limit` (number, optionnel) : Nombre maximum de résultats (défaut: 10)
61
-
62
- ### 2. `search_spring_projects`
63
- Recherche parmi tous les projets Spring disponibles sur spring.io/projects.
64
-
65
- **Paramètres :**
66
- - `query` (string, requis) : Mots-clés à rechercher dans les projets Spring
67
- - `limit` (number, optionnel) : Nombre maximum de projets à retourner (défaut: 10)
68
-
69
- ### 3. `get_spring_project`
70
- Récupère les détails complets d'un projet Spring spécifique.
71
-
72
- **Paramètres :**
73
- - `projectName` (string, requis) : Nom du projet Spring (ex: `spring-boot`, `spring-security`)
74
-
75
- ### 4. `get_all_spring_guides`
76
- Récupère la liste de tous les guides Spring disponibles, optionnellement filtrés par catégorie.
77
-
78
- **Paramètres :**
79
- - `category` (string, optionnel) : Catégorie de guides à filtrer
80
- - `limit` (number, optionnel) : Nombre maximum de guides (défaut: 20)
81
-
82
- ### 5. `get_spring_guide`
83
- Récupère le contenu complet d'un guide Spring Boot spécifique.
84
-
85
- **Paramètres :**
86
- - `guideId` (string, requis) : Identifiant du guide (ex: `gs-rest-service`)
87
-
88
- ### 6. `get_spring_reference`
89
- Récupère une section spécifique de la documentation de référence Spring Boot.
90
-
91
- **Paramètres :**
92
- - `section` (string, requis) : Section de la documentation (ex: `web`, `data`, `security`)
93
- - `subsection` (string, optionnel) : Sous-section pour une recherche plus précise
94
-
95
- ### 7. `search_spring_concepts`
96
- Recherche des concepts Spring Boot par catégorie avec explications détaillées.
97
-
98
- **Paramètres :**
99
- - `concept` (string, requis) : Concept à rechercher (ex: `auto-configuration`)
100
- - `category` (string, optionnel) : Catégorie (`core`, `web`, `data`, `security`, `testing`, `production`)
101
-
102
- ## � Sources de documentation
103
-
104
- Ce serveur MCP accède aux sources de documentation Spring suivantes :
105
-
106
- - **🌟 [spring.io/projects](https://spring.io/projects)** - Tous les projets Spring (Boot, Security, Data, Cloud, etc.)
107
- - **📖 [spring.io/guides](https://spring.io/guides)** - Guides pratiques et tutoriels
108
- - **📚 [docs.spring.io](https://docs.spring.io)** - Documentation de référence officielle
109
- - **🔧 API Documentation** - Documentation des classes et méthodes
110
- - **💡 Base de connaissances intégrée** - Concepts et bonnes pratiques Spring Boot
111
-
112
- ## �🔧 Configuration avec Claude Desktop
113
-
114
- Pour utiliser ce serveur avec Claude Desktop, ajoutez la configuration suivante dans votre fichier `claude_desktop_config.json` :
115
-
116
- ```json
117
- {
118
- "mcpServers": {
119
- "springboot-docs": {
120
- "command": "node",
121
- "args": ["/chemin/absolu/vers/springdocsmcp/build/index.js"]
122
- }
123
- }
124
- }
125
- ```
126
-
127
- ### Localisation du fichier de configuration
128
-
129
- - **macOS** : `~/Library/Application Support/Claude/claude_desktop_config.json`
130
- - **Windows** : `%APPDATA%\\Claude\\claude_desktop_config.json`
131
-
132
- ## 📚 Exemples d'utilisation
133
-
134
- ### Recherche générale
135
- ```
136
- Recherche "REST API" dans la documentation Spring Boot
137
- ```
138
-
139
- ### Recherche de projets Spring
140
- ```
141
- Trouve des projets Spring liés à "security"
142
- ```
143
-
144
- ### Détails d'un projet spécifique
145
- ```
146
- Montre-moi les détails du projet "spring-boot"
147
- ```
148
-
149
- ### Liste des guides par catégorie
150
- ```
151
- Quels sont les guides Spring pour la catégorie "Web" ?
152
- ```
153
-
154
- ### Récupération d'un guide spécifique
155
- ```
156
- Récupère le guide "gs-rest-service"
157
- ```
158
-
159
- ### Exploration des concepts
160
- ```
161
- Explique le concept "auto-configuration" dans Spring Boot
162
- ```
163
-
164
- ## 🏗️ Architecture
165
-
166
- Le projet est organisé comme suit :
167
-
168
- ```
169
- src/
170
- ├── index.ts # Point d'entrée principal
171
- ├── services/
172
- │ └── springboot-docs.ts # Service de récupération de documentation
173
- └── tools/
174
- └── index.ts # Définitions des outils MCP
175
- ```
176
-
177
- ### Composants principaux
178
-
179
- - **SpringBootMCPServer** : Serveur MCP principal qui gère les requêtes
180
- - **SpringBootDocsService** : Service pour récupérer et traiter la documentation
181
- - **ToolDefinitions** : Définitions des outils exposés via MCP
182
-
183
- ## 🔒 Sécurité
184
-
185
- - Le serveur accède uniquement aux ressources publiques de `docs.spring.io`
186
- - Aucune donnée sensible n'est stockée ou transmise
187
- - Toutes les requêtes HTTP sont en lecture seule
188
-
189
- ## 🐛 Dépannage
190
-
191
- ### Erreurs courantes
192
-
193
- 1. **"Cannot find module"** : Vérifiez que `npm install` a été exécuté
194
- 2. **"Serveur non démarré"** : Vérifiez que la compilation avec `npm run build` s'est bien passée
195
- 3. **"Documentation non trouvée"** : Vérifiez votre connexion internet
196
-
197
- ### Logs
198
-
199
- Le serveur écrit ses logs sur `stderr` pour éviter d'interférer avec le protocole MCP sur `stdout`.
200
-
201
- ## 🤝 Contribution
202
-
203
- Les contributions sont les bienvenues ! N'hésitez pas à :
204
-
205
- 1. Forker le projet
206
- 2. Créer une branche pour votre fonctionnalité
207
- 3. Commiter vos changements
208
- 4. Pousser vers la branche
209
- 5. Ouvrir une Pull Request
210
-
211
- ## 📄 Licence
212
-
213
- Ce projet est sous licence MIT. Voir le fichier `LICENSE` pour plus de détails.
214
-
215
- ## 🔗 Ressources utiles
216
-
217
- - [Documentation Spring Boot](https://docs.spring.io/spring-boot/docs/current/reference/html/)
218
- - [Model Context Protocol](https://modelcontextprotocol.io/)
219
- - [SDK MCP TypeScript](https://github.com/modelcontextprotocol/typescript-sdk)
@@ -1,106 +0,0 @@
1
- # 🎉 Spring Boot MCP Server v1.1.0 - Mise à jour majeure
2
-
3
- ## 🚀 Améliorations apportées
4
-
5
- Votre serveur MCP Spring Boot Documentation a été considérablement amélioré ! Voici ce qui a été ajouté :
6
-
7
- ### ✨ Nouvelles fonctionnalités principales
8
-
9
- #### 1. **Support complet de l'écosystème Spring**
10
- - ✅ Accès à **spring.io/projects** - Tous les projets Spring (Security, Data, Cloud, etc.)
11
- - ✅ Extension de **spring.io/guides** - Catalogue complet des guides
12
- - ✅ Intégration enrichie avec la documentation officielle
13
-
14
- #### 2. **3 nouveaux outils MCP** (Total : 7 outils)
15
- - 🆕 **`search_spring_projects`** - Recherche parmi tous les projets Spring
16
- - 🆕 **`get_spring_project`** - Détails complets d'un projet Spring
17
- - 🆕 **`get_all_spring_guides`** - Liste de tous les guides avec filtrage
18
-
19
- #### 3. **Base de connaissances étendue**
20
- - 📚 Projets Spring populaires intégrés (fallback robuste)
21
- - 🔍 Guides Spring organisés par catégories
22
- - 🎯 Recherche intelligente avec mécanismes de secours
23
-
24
- ## 🛠️ Outils disponibles (7 au total)
25
-
26
- | Outil | Description | Nouveau |
27
- |-------|-------------|---------|
28
- | `search_spring_docs` | Recherche dans la documentation Spring Boot | ⭐ |
29
- | `search_spring_projects` | **Recherche de projets Spring** | 🆕 |
30
- | `get_spring_project` | **Détails d'un projet Spring** | 🆕 |
31
- | `get_all_spring_guides` | **Liste des guides Spring** | 🆕 |
32
- | `get_spring_guide` | Contenu d'un guide spécifique | ⭐ |
33
- | `get_spring_reference` | Documentation de référence | ⭐ |
34
- | `search_spring_concepts` | Recherche de concepts Spring Boot | ⭐ |
35
-
36
- ## 📋 Tests rapides
37
-
38
- Testez les nouvelles fonctionnalités avec ces exemples :
39
-
40
- ```bash
41
- # Test des nouveaux outils
42
- ./test.sh
43
-
44
- # Ou individuellement :
45
- echo '{"jsonrpc": "2.0", "id": 1, "method": "tools/call", "params": {"name": "search_spring_projects", "arguments": {"query": "security"}}}' | node build/index.js
46
- ```
47
-
48
- ## 🔧 Configuration Claude Desktop
49
-
50
- Votre configuration reste la même dans `claude_desktop_config.json` :
51
-
52
- ```json
53
- {
54
- "mcpServers": {
55
- "springboot-docs": {
56
- "command": "node",
57
- "args": ["/Users/yacoubakone/Documents/dev/springdocsmcp/build/index.js"]
58
- }
59
- }
60
- }
61
- ```
62
-
63
- ## 📚 Documentation mise à jour
64
-
65
- - ✅ **README.md** - Documentation principale mise à jour
66
- - ✅ **EXAMPLES.md** - Guide d'exemples pratiques
67
- - ✅ **CONTRIBUTING.md** - Guide pour les développeurs
68
- - ✅ **CHANGELOG.md** - Historique des versions
69
- - ✅ **test.sh** - Script de test étendu
70
-
71
- ## 🌟 Exemples d'utilisation avec Claude
72
-
73
- Maintenant vous pouvez demander à Claude :
74
-
75
- ### Découverte de projets
76
- > "Quels sont les projets Spring disponibles pour la sécurité ?"
77
-
78
- ### Exploration de l'écosystème
79
- > "Montre-moi tous les projets Spring liés aux données"
80
-
81
- ### Guides spécialisés
82
- > "Quels sont les guides Spring Boot pour le développement web ?"
83
-
84
- ### Détails de projets
85
- > "Peux-tu m'expliquer le projet Spring Cloud ?"
86
-
87
- ## 🎯 Couverture documentaire
88
-
89
- Votre serveur MCP accède maintenant à :
90
-
91
- - 🌐 **Tous les projets Spring** (Boot, Security, Data, Cloud, Integration, etc.)
92
- - 📖 **Guides complets** avec filtrage par catégorie
93
- - 📚 **Documentation de référence** Spring Boot
94
- - 🔧 **API Documentation**
95
- - 💡 **Base de connaissances** enrichie
96
-
97
- ## ✅ État du projet
98
-
99
- - ✅ **Compilation réussie** (version 1.1.0)
100
- - ✅ **Tests passés** (7 outils fonctionnels)
101
- - ✅ **Documentation complète**
102
- - ✅ **Prêt pour la production**
103
-
104
- ---
105
-
106
- 🎉 **Votre serveur MCP Spring Boot Documentation est maintenant un outil complet pour explorer tout l'écosystème Spring !**