@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/README.md +42 -1
- package/build/debug.d.ts +3 -0
- package/build/debug.d.ts.map +1 -0
- package/build/debug.js +292 -0
- package/build/debug.js.map +1 -0
- package/build/index.js +16 -10
- package/build/index.js.map +1 -1
- package/build/services/springboot-docs.d.ts.map +1 -1
- package/build/services/springboot-docs.js +174 -15
- package/build/services/springboot-docs.js.map +1 -1
- package/package.json +11 -3
- package/.github/workflows/publish.yml +0 -64
- package/CHANGELOG.md +0 -82
- package/CHANGELOG_v1.2.0.md +0 -71
- package/CONTRIBUTING.md +0 -215
- package/EXAMPLES.md +0 -186
- package/EXAMPLES_FR.md +0 -186
- package/INSTALL.md +0 -123
- package/INSTALL_FR.md +0 -123
- package/JETBRAINS_SETUP.md +0 -171
- package/README_FR.md +0 -219
- package/RELEASE_NOTES_v1.1.0.md +0 -106
- package/RELEASE_NOTES_v1.2.0.md +0 -138
- package/TROUBLESHOOTING.md +0 -163
- package/claude_desktop_config.json +0 -7
- package/diagnostic.sh +0 -55
- package/docs/index.html +0 -147
- package/guid.md +0 -92
- package/publish.sh +0 -130
- package/setup-jetbrains.sh +0 -164
- package/src/index.ts +0 -287
- package/src/services/springboot-docs.ts +0 -615
- package/src/tools/index.ts +0 -144
- package/test-jetbrains.sh +0 -125
- package/test.sh +0 -64
- package/tsconfig.json +0 -24
package/RELEASE_NOTES_v1.2.0.md
DELETED
|
@@ -1,138 +0,0 @@
|
|
|
1
|
-
# 🚀 Spring Documentation MCP Server v1.2.0 - Support JetBrains IDEs
|
|
2
|
-
|
|
3
|
-
## 🎉 Nouveautés de la version 1.2.0
|
|
4
|
-
|
|
5
|
-
### ✨ Support complet des IDEs JetBrains
|
|
6
|
-
|
|
7
|
-
Votre serveur MCP Spring Documentation est maintenant compatible avec **tous les IDEs JetBrains** :
|
|
8
|
-
|
|
9
|
-
- ✅ **IntelliJ IDEA** (Ultimate & Community)
|
|
10
|
-
- ✅ **WebStorm**
|
|
11
|
-
- ✅ **PyCharm** (Professional & Community)
|
|
12
|
-
- ✅ **PhpStorm**
|
|
13
|
-
- ✅ **RubyMine**
|
|
14
|
-
- ✅ **CLion**
|
|
15
|
-
- ✅ **GoLand**
|
|
16
|
-
- ✅ **Rider**
|
|
17
|
-
- ✅ **DataGrip**
|
|
18
|
-
- ✅ **Android Studio**
|
|
19
|
-
|
|
20
|
-
## 🛠️ Installation et Configuration
|
|
21
|
-
|
|
22
|
-
### 1. Mise à jour du package (si déjà installé)
|
|
23
|
-
|
|
24
|
-
```bash
|
|
25
|
-
npm update -g @enokdev/springdocs-mcp
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
### 2. Configuration automatique JetBrains
|
|
29
|
-
|
|
30
|
-
```bash
|
|
31
|
-
cd /path/to/springdocs-mcp
|
|
32
|
-
./setup-jetbrains.sh
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
### 3. Vérification de la configuration
|
|
36
|
-
|
|
37
|
-
```bash
|
|
38
|
-
./test-jetbrains.sh
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
## 🎯 Utilisation dans vos IDEs
|
|
42
|
-
|
|
43
|
-
### Claude Desktop
|
|
44
|
-
✅ **Déjà configuré** - Continuez à utiliser comme avant
|
|
45
|
-
|
|
46
|
-
### VS Code
|
|
47
|
-
✅ **Déjà configuré** - Extension Claude avec MCP
|
|
48
|
-
|
|
49
|
-
### JetBrains IDEs (NOUVEAU!)
|
|
50
|
-
🆕 **Nouvellement supporté** :
|
|
51
|
-
|
|
52
|
-
1. **Installer le plugin Claude** dans votre IDE JetBrains
|
|
53
|
-
2. **Redémarrer l'IDE** après la configuration automatique
|
|
54
|
-
3. **Tester** avec une question Spring dans le chat Claude
|
|
55
|
-
|
|
56
|
-
## 💬 Exemples d'utilisation JetBrains
|
|
57
|
-
|
|
58
|
-
### Dans IntelliJ IDEA
|
|
59
|
-
```
|
|
60
|
-
Vous: "Quels sont les projets Spring pour la sécurité ?"
|
|
61
|
-
Claude: [Utilise search_spring_projects("security")]
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
### Dans WebStorm
|
|
65
|
-
```
|
|
66
|
-
Vous: "Comment créer une API REST avec Spring Boot ?"
|
|
67
|
-
Claude: [Utilise get_spring_guide("gs-rest-service")]
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
### Dans GoLand
|
|
71
|
-
```
|
|
72
|
-
Vous: "Documentation Spring Boot pour les microservices"
|
|
73
|
-
Claude: [Utilise search_spring_concepts("microservices")]
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
## 🔧 Tous vos outils MCP Spring disponibles
|
|
77
|
-
|
|
78
|
-
1. **search_spring_docs** - Recherche documentation
|
|
79
|
-
2. **search_spring_projects** - Projets Spring ecosystem
|
|
80
|
-
3. **get_spring_project** - Détails d'un projet
|
|
81
|
-
4. **get_all_spring_guides** - Liste des guides
|
|
82
|
-
5. **get_spring_guide** - Contenu guide complet
|
|
83
|
-
6. **get_spring_reference** - Documentation référence
|
|
84
|
-
7. **search_spring_concepts** - Concepts Spring Boot
|
|
85
|
-
|
|
86
|
-
## 📍 Où utiliser maintenant
|
|
87
|
-
|
|
88
|
-
| Environnement | Status | Configuration |
|
|
89
|
-
|---------------|--------|---------------|
|
|
90
|
-
| **Claude Desktop** | ✅ Actif | `claude_desktop_config.json` |
|
|
91
|
-
| **VS Code** | ✅ Actif | Extension Claude |
|
|
92
|
-
| **IntelliJ IDEA** | 🆕 Nouveau | Plugin Claude + XML config |
|
|
93
|
-
| **WebStorm** | 🆕 Nouveau | Plugin Claude + XML config |
|
|
94
|
-
| **GoLand** | 🆕 Nouveau | Plugin Claude + XML config |
|
|
95
|
-
| **PyCharm** | 🆕 Nouveau | Plugin Claude + XML config |
|
|
96
|
-
| **Autres JetBrains** | 🆕 Nouveau | Plugin Claude + XML config |
|
|
97
|
-
|
|
98
|
-
## 🔄 Migration depuis v1.1.1
|
|
99
|
-
|
|
100
|
-
**Aucune action requise** pour vos configurations existantes :
|
|
101
|
-
- ✅ Claude Desktop continue de fonctionner
|
|
102
|
-
- ✅ VS Code continue de fonctionner
|
|
103
|
-
- 🆕 JetBrains IDEs maintenant supportés en plus
|
|
104
|
-
|
|
105
|
-
## 🛠️ Dépannage
|
|
106
|
-
|
|
107
|
-
### JetBrains IDEs
|
|
108
|
-
Si les outils n'apparaissent pas :
|
|
109
|
-
|
|
110
|
-
1. **Vérifier le plugin Claude** est installé
|
|
111
|
-
2. **Redémarrer l'IDE** complètement
|
|
112
|
-
3. **Vérifier la configuration** : `./test-jetbrains.sh`
|
|
113
|
-
4. **Consulter** `JETBRAINS_SETUP.md` pour les détails
|
|
114
|
-
|
|
115
|
-
### Claude Desktop / VS Code
|
|
116
|
-
Si problème existant :
|
|
117
|
-
|
|
118
|
-
1. **Consulter** `TROUBLESHOOTING.md`
|
|
119
|
-
2. **Exécuter** `./diagnostic.sh`
|
|
120
|
-
|
|
121
|
-
## 🎊 Profitez de votre Spring Documentation
|
|
122
|
-
|
|
123
|
-
Vous avez maintenant accès à **toute la documentation Spring** dans **tous vos environnements de développement** !
|
|
124
|
-
|
|
125
|
-
- 📚 **Documentation complète** Spring Boot + écosystème
|
|
126
|
-
- 🛠️ **7 outils MCP puissants**
|
|
127
|
-
- 🌐 **Support multi-plateforme** (Claude Desktop, VS Code, JetBrains)
|
|
128
|
-
- ⚡ **Accès instantané** à spring.io/projects et guides
|
|
129
|
-
|
|
130
|
-
---
|
|
131
|
-
|
|
132
|
-
**🔗 Liens utiles :**
|
|
133
|
-
- 📖 [Documentation complète](README.md)
|
|
134
|
-
- 🛠️ [Configuration JetBrains](JETBRAINS_SETUP.md)
|
|
135
|
-
- 🔧 [Dépannage](TROUBLESHOOTING.md)
|
|
136
|
-
- 📦 [npm Package](https://www.npmjs.com/package/@enokdev/springdocs-mcp)
|
|
137
|
-
|
|
138
|
-
**Made with ❤️ by [EnokDev](https://github.com/tky0065)**
|
package/TROUBLESHOOTING.md
DELETED
|
@@ -1,163 +0,0 @@
|
|
|
1
|
-
# 🔧 Guide de Dépannage - Spring Documentation MCP Server
|
|
2
|
-
|
|
3
|
-
## 🚨 Problème : Les outils MCP n'apparaissent pas dans Claude Desktop
|
|
4
|
-
|
|
5
|
-
### ✅ Vérifications de base
|
|
6
|
-
|
|
7
|
-
1. **Vérifier l'installation du package**
|
|
8
|
-
```bash
|
|
9
|
-
npm list -g @enokdev/springdocs-mcp
|
|
10
|
-
```
|
|
11
|
-
Devrait afficher : `@enokdev/springdocs-mcp@1.1.1`
|
|
12
|
-
|
|
13
|
-
2. **Vérifier la commande globale**
|
|
14
|
-
```bash
|
|
15
|
-
which springdocs-mcp
|
|
16
|
-
```
|
|
17
|
-
Devrait afficher : `/opt/homebrew/bin/springdocs-mcp`
|
|
18
|
-
|
|
19
|
-
3. **Tester le serveur localement**
|
|
20
|
-
```bash
|
|
21
|
-
echo '{"jsonrpc": "2.0", "id": 1, "method": "tools/list", "params": {}}' | springdocs-mcp
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
### 🔧 Solutions étape par étape
|
|
25
|
-
|
|
26
|
-
#### Solution 1 : Configuration Claude Desktop (Recommandée)
|
|
27
|
-
|
|
28
|
-
**Fichier :** `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
29
|
-
|
|
30
|
-
```json
|
|
31
|
-
{
|
|
32
|
-
"mcpServers": {
|
|
33
|
-
"spring-docs": {
|
|
34
|
-
"command": "/opt/homebrew/bin/springdocs-mcp"
|
|
35
|
-
}
|
|
36
|
-
}
|
|
37
|
-
}
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
#### Solution 2 : Configuration alternative (Développement)
|
|
41
|
-
|
|
42
|
-
```json
|
|
43
|
-
{
|
|
44
|
-
"mcpServers": {
|
|
45
|
-
"spring-docs": {
|
|
46
|
-
"command": "node",
|
|
47
|
-
"args": ["/path/to/springdocs-mcp/build/index.js"]
|
|
48
|
-
}
|
|
49
|
-
}
|
|
50
|
-
}
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
#### Solution 3 : Réinstallation complète
|
|
54
|
-
|
|
55
|
-
```bash
|
|
56
|
-
# Désinstaller
|
|
57
|
-
npm uninstall -g @enokdev/springdocs-mcp
|
|
58
|
-
|
|
59
|
-
# Nettoyer le cache
|
|
60
|
-
npm cache clean --force
|
|
61
|
-
|
|
62
|
-
# Réinstaller
|
|
63
|
-
npm install -g @enokdev/springdocs-mcp
|
|
64
|
-
|
|
65
|
-
# Vérifier
|
|
66
|
-
springdocs-mcp --help
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
### 🔍 Diagnostic automatique
|
|
70
|
-
|
|
71
|
-
Utilisez le script de diagnostic :
|
|
72
|
-
|
|
73
|
-
```bash
|
|
74
|
-
./diagnostic.sh
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
### 📋 Checklist de dépannage
|
|
78
|
-
|
|
79
|
-
- [ ] Package installé globalement
|
|
80
|
-
- [ ] Lien symbolique existe dans `/opt/homebrew/bin/`
|
|
81
|
-
- [ ] Fichier exécutable avec permissions correctes
|
|
82
|
-
- [ ] Configuration JSON valide (pas de virgules en trop)
|
|
83
|
-
- [ ] Chemin absolu utilisé dans la configuration
|
|
84
|
-
- [ ] Claude Desktop redémarré après modification config
|
|
85
|
-
|
|
86
|
-
### 🚫 Erreurs communes
|
|
87
|
-
|
|
88
|
-
#### JSON invalide
|
|
89
|
-
❌ **Problème :**
|
|
90
|
-
```json
|
|
91
|
-
{
|
|
92
|
-
"mcpServers": {
|
|
93
|
-
"spring-docs": {
|
|
94
|
-
"command": "springdocs-mcp"
|
|
95
|
-
}, // <- virgule en trop
|
|
96
|
-
}
|
|
97
|
-
}
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
✅ **Solution :**
|
|
101
|
-
```json
|
|
102
|
-
{
|
|
103
|
-
"mcpServers": {
|
|
104
|
-
"spring-docs": {
|
|
105
|
-
"command": "springdocs-mcp"
|
|
106
|
-
}
|
|
107
|
-
}
|
|
108
|
-
}
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
#### Chemin relatif
|
|
112
|
-
❌ **Problème :**
|
|
113
|
-
```json
|
|
114
|
-
{
|
|
115
|
-
"mcpServers": {
|
|
116
|
-
"spring-docs": {
|
|
117
|
-
"command": "springdocs-mcp" // <- peut ne pas être trouvé
|
|
118
|
-
}
|
|
119
|
-
}
|
|
120
|
-
}
|
|
121
|
-
```
|
|
122
|
-
|
|
123
|
-
✅ **Solution :**
|
|
124
|
-
```json
|
|
125
|
-
{
|
|
126
|
-
"mcpServers": {
|
|
127
|
-
"spring-docs": {
|
|
128
|
-
"command": "/opt/homebrew/bin/springdocs-mcp" // <- chemin absolu
|
|
129
|
-
}
|
|
130
|
-
}
|
|
131
|
-
}
|
|
132
|
-
```
|
|
133
|
-
|
|
134
|
-
### 🔄 Redémarrage requis
|
|
135
|
-
|
|
136
|
-
Après modification de la configuration :
|
|
137
|
-
|
|
138
|
-
1. **Fermer complètement Claude Desktop**
|
|
139
|
-
2. **Attendre 5 secondes**
|
|
140
|
-
3. **Relancer Claude Desktop**
|
|
141
|
-
4. **Vérifier la présence des outils dans le menu**
|
|
142
|
-
|
|
143
|
-
### 📍 Emplacements des fichiers
|
|
144
|
-
|
|
145
|
-
- **Configuration Claude Desktop :** `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
146
|
-
- **Executable global :** `/opt/homebrew/bin/springdocs-mcp`
|
|
147
|
-
- **Package installé :** `/opt/homebrew/lib/node_modules/@enokdev/springdocs-mcp/`
|
|
148
|
-
|
|
149
|
-
### 🆘 Si rien ne fonctionne
|
|
150
|
-
|
|
151
|
-
1. **Vérifier les logs de Claude Desktop** (si disponibles)
|
|
152
|
-
2. **Tester avec une configuration minimale**
|
|
153
|
-
3. **Utiliser le mode développement avec chemin absolu**
|
|
154
|
-
4. **Contacter le support ou ouvrir une issue GitHub**
|
|
155
|
-
|
|
156
|
-
### 📞 Support
|
|
157
|
-
|
|
158
|
-
- **GitHub Issues :** https://github.com/tky0065/springdocs-mcp/issues
|
|
159
|
-
- **npm Package :** https://www.npmjs.com/package/@enokdev/springdocs-mcp
|
|
160
|
-
|
|
161
|
-
---
|
|
162
|
-
|
|
163
|
-
**Note :** Ce serveur MCP fournit 7 outils pour explorer la documentation Spring. Une fois configuré correctement, vous devriez voir apparaître les outils Spring dans l'interface Claude Desktop.
|
package/diagnostic.sh
DELETED
|
@@ -1,55 +0,0 @@
|
|
|
1
|
-
#!/bin/bash
|
|
2
|
-
|
|
3
|
-
echo "🔍 Diagnostic du serveur MCP Spring Documentation"
|
|
4
|
-
echo "================================================="
|
|
5
|
-
echo
|
|
6
|
-
|
|
7
|
-
echo "📦 Vérification de l'installation npm..."
|
|
8
|
-
npm list -g @enokdev/springdocs-mcp 2>/dev/null || echo "❌ Package non installé globalement"
|
|
9
|
-
echo
|
|
10
|
-
|
|
11
|
-
echo "🔗 Vérification du lien symbolique..."
|
|
12
|
-
if [ -L "/opt/homebrew/bin/springdocs-mcp" ]; then
|
|
13
|
-
echo "✅ Lien symbolique existe: $(readlink /opt/homebrew/bin/springdocs-mcp)"
|
|
14
|
-
else
|
|
15
|
-
echo "❌ Lien symbolique manquant"
|
|
16
|
-
fi
|
|
17
|
-
echo
|
|
18
|
-
|
|
19
|
-
echo "📂 Vérification du fichier executable..."
|
|
20
|
-
if [ -x "/opt/homebrew/lib/node_modules/@enokdev/springdocs-mcp/build/index.js" ]; then
|
|
21
|
-
echo "✅ Fichier exécutable existe"
|
|
22
|
-
else
|
|
23
|
-
echo "❌ Fichier exécutable manquant ou non exécutable"
|
|
24
|
-
fi
|
|
25
|
-
echo
|
|
26
|
-
|
|
27
|
-
echo "🏗️ Vérification du shebang..."
|
|
28
|
-
head -1 /opt/homebrew/lib/node_modules/@enokdev/springdocs-mcp/build/index.js | grep -q "#!/usr/bin/env node" && echo "✅ Shebang correct" || echo "❌ Shebang incorrect"
|
|
29
|
-
echo
|
|
30
|
-
|
|
31
|
-
echo "🔄 Test de la commande directe..."
|
|
32
|
-
echo '{"jsonrpc": "2.0", "id": 1, "method": "initialize", "params": {"protocolVersion": "2024-11-05", "capabilities": {}, "clientInfo": {"name": "test", "version": "1.0.0"}}}' | timeout 5s /opt/homebrew/bin/springdocs-mcp 2>&1 | head -5 || echo "❌ Timeout ou erreur"
|
|
33
|
-
echo
|
|
34
|
-
|
|
35
|
-
echo "📋 Configuration Claude Desktop actuelle:"
|
|
36
|
-
echo "$(cat ~/Library/Application\ Support/Claude/claude_desktop_config.json 2>/dev/null || echo '❌ Fichier de configuration non trouvé')"
|
|
37
|
-
echo
|
|
38
|
-
|
|
39
|
-
echo "💡 Configuration recommandée pour Claude Desktop:"
|
|
40
|
-
cat << 'EOF'
|
|
41
|
-
{
|
|
42
|
-
"mcpServers": {
|
|
43
|
-
"spring-docs": {
|
|
44
|
-
"command": "/opt/homebrew/bin/springdocs-mcp"
|
|
45
|
-
}
|
|
46
|
-
}
|
|
47
|
-
}
|
|
48
|
-
EOF
|
|
49
|
-
echo
|
|
50
|
-
|
|
51
|
-
echo "🔧 Pour résoudre les problèmes potentiels:"
|
|
52
|
-
echo "1. Redémarrer Claude Desktop complètement"
|
|
53
|
-
echo "2. Vérifier que la configuration JSON est valide"
|
|
54
|
-
echo "3. Utiliser le chemin absolu: /opt/homebrew/bin/springdocs-mcp"
|
|
55
|
-
echo "4. Si nécessaire, réinstaller: npm uninstall -g @enokdev/springdocs-mcp && npm install -g @enokdev/springdocs-mcp"
|
package/docs/index.html
DELETED
|
@@ -1,147 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="UTF-8">
|
|
5
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<title>Spring Documentation MCP Server</title>
|
|
7
|
-
<style>
|
|
8
|
-
* { margin: 0; padding: 0; box-sizing: border-box; }
|
|
9
|
-
body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif; line-height: 1.6; color: #333; }
|
|
10
|
-
.container { max-width: 1200px; margin: 0 auto; padding: 0 20px; }
|
|
11
|
-
header { background: linear-gradient(135deg, #6fa8dc, #4285f4); color: white; padding: 60px 0; text-align: center; }
|
|
12
|
-
h1 { font-size: 3rem; margin-bottom: 20px; }
|
|
13
|
-
.subtitle { font-size: 1.5rem; opacity: 0.9; }
|
|
14
|
-
.hero { padding: 80px 0; text-align: center; background: #f8f9fa; }
|
|
15
|
-
.feature-grid { display: grid; grid-template-columns: repeat(auto-fit, minmax(300px, 1fr)); gap: 30px; margin: 60px 0; }
|
|
16
|
-
.feature { background: white; padding: 30px; border-radius: 8px; box-shadow: 0 2px 10px rgba(0,0,0,0.1); }
|
|
17
|
-
.feature h3 { color: #4285f4; margin-bottom: 15px; }
|
|
18
|
-
.install-section { background: #2d3748; color: white; padding: 60px 0; }
|
|
19
|
-
.code-block { background: #1a202c; padding: 20px; border-radius: 8px; margin: 20px 0; overflow-x: auto; }
|
|
20
|
-
.code-block code { color: #68d391; font-family: 'Monaco', 'Consolas', monospace; }
|
|
21
|
-
.tools-section { padding: 60px 0; }
|
|
22
|
-
.tool { border-left: 4px solid #4285f4; padding: 20px; margin: 20px 0; background: #f8f9fa; }
|
|
23
|
-
footer { background: #2d3748; color: white; padding: 40px 0; text-align: center; }
|
|
24
|
-
.btn { display: inline-block; background: #4285f4; color: white; padding: 12px 24px; text-decoration: none; border-radius: 6px; margin: 10px; }
|
|
25
|
-
.btn:hover { background: #3367d6; }
|
|
26
|
-
</style>
|
|
27
|
-
</head>
|
|
28
|
-
<body>
|
|
29
|
-
<header>
|
|
30
|
-
<div class="container">
|
|
31
|
-
<h1>🌱 Spring Documentation MCP Server</h1>
|
|
32
|
-
<p class="subtitle">Access the complete Spring ecosystem directly in Claude Desktop</p>
|
|
33
|
-
</div>
|
|
34
|
-
</header>
|
|
35
|
-
|
|
36
|
-
<section class="hero">
|
|
37
|
-
<div class="container">
|
|
38
|
-
<h2>The Complete Spring Documentation at Your Fingertips</h2>
|
|
39
|
-
<p>A public Model Context Protocol server that provides instant access to Spring Boot documentation, guides, and the entire Spring ecosystem.</p>
|
|
40
|
-
<a href="#install" class="btn">Get Started</a>
|
|
41
|
-
<a href="https://github.com/tky0065/springdocs-mcp" class="btn">View on GitHub</a>
|
|
42
|
-
</div>
|
|
43
|
-
</section>
|
|
44
|
-
|
|
45
|
-
<section class="container">
|
|
46
|
-
<div class="feature-grid">
|
|
47
|
-
<div class="feature">
|
|
48
|
-
<h3>🌐 Complete Spring Ecosystem</h3>
|
|
49
|
-
<p>Access all Spring projects: Boot, Security, Data, Cloud, and more. Get detailed project information and documentation.</p>
|
|
50
|
-
</div>
|
|
51
|
-
<div class="feature">
|
|
52
|
-
<h3>📚 Comprehensive Guides</h3>
|
|
53
|
-
<p>Browse and access hundreds of Spring guides organized by category. Perfect for learning and reference.</p>
|
|
54
|
-
</div>
|
|
55
|
-
<div class="feature">
|
|
56
|
-
<h3>🔍 Intelligent Search</h3>
|
|
57
|
-
<p>Search across documentation, concepts, and guides with intelligent fallback mechanisms.</p>
|
|
58
|
-
</div>
|
|
59
|
-
<div class="feature">
|
|
60
|
-
<h3>⚡ 7 Powerful Tools</h3>
|
|
61
|
-
<p>Seven specialized MCP tools for exploring every aspect of Spring development.</p>
|
|
62
|
-
</div>
|
|
63
|
-
<div class="feature">
|
|
64
|
-
<h3>🔧 Easy Integration</h3>
|
|
65
|
-
<p>Simple one-command installation and configuration with Claude Desktop.</p>
|
|
66
|
-
</div>
|
|
67
|
-
<div class="feature">
|
|
68
|
-
<h3>💡 Built-in Knowledge</h3>
|
|
69
|
-
<p>Integrated knowledge base of Spring Boot concepts and best practices.</p>
|
|
70
|
-
</div>
|
|
71
|
-
</div>
|
|
72
|
-
</section>
|
|
73
|
-
|
|
74
|
-
<section class="install-section" id="install">
|
|
75
|
-
<div class="container">
|
|
76
|
-
<h2>Quick Installation</h2>
|
|
77
|
-
<div class="code-block">
|
|
78
|
-
<code>npm install -g @enokdev/springdocs-mcp</code>
|
|
79
|
-
</div>
|
|
80
|
-
<p>Then add to your Claude Desktop configuration:</p>
|
|
81
|
-
<div class="code-block">
|
|
82
|
-
<code>{
|
|
83
|
-
"mcpServers": {
|
|
84
|
-
"spring-docs": {
|
|
85
|
-
"command": "springdocs-mcp"
|
|
86
|
-
}
|
|
87
|
-
}
|
|
88
|
-
}</code>
|
|
89
|
-
</div>
|
|
90
|
-
</div>
|
|
91
|
-
</section>
|
|
92
|
-
|
|
93
|
-
<section class="tools-section">
|
|
94
|
-
<div class="container">
|
|
95
|
-
<h2>Available Tools</h2>
|
|
96
|
-
<div class="tool">
|
|
97
|
-
<h3>search_spring_docs</h3>
|
|
98
|
-
<p>Search through Spring Boot documentation with keywords and filters.</p>
|
|
99
|
-
</div>
|
|
100
|
-
<div class="tool">
|
|
101
|
-
<h3>search_spring_projects</h3>
|
|
102
|
-
<p>Find Spring projects by category or functionality (Security, Data, Cloud, etc.)</p>
|
|
103
|
-
</div>
|
|
104
|
-
<div class="tool">
|
|
105
|
-
<h3>get_spring_project</h3>
|
|
106
|
-
<p>Get detailed information about a specific Spring project.</p>
|
|
107
|
-
</div>
|
|
108
|
-
<div class="tool">
|
|
109
|
-
<h3>get_all_spring_guides</h3>
|
|
110
|
-
<p>Browse all available Spring guides with optional category filtering.</p>
|
|
111
|
-
</div>
|
|
112
|
-
<div class="tool">
|
|
113
|
-
<h3>get_spring_guide</h3>
|
|
114
|
-
<p>Retrieve the complete content of a specific Spring guide.</p>
|
|
115
|
-
</div>
|
|
116
|
-
<div class="tool">
|
|
117
|
-
<h3>get_spring_reference</h3>
|
|
118
|
-
<p>Access specific sections of the Spring Boot reference documentation.</p>
|
|
119
|
-
</div>
|
|
120
|
-
<div class="tool">
|
|
121
|
-
<h3>search_spring_concepts</h3>
|
|
122
|
-
<p>Explore Spring Boot concepts with detailed explanations and examples.</p>
|
|
123
|
-
</div>
|
|
124
|
-
</div>
|
|
125
|
-
</section>
|
|
126
|
-
|
|
127
|
-
<section class="hero">
|
|
128
|
-
<div class="container">
|
|
129
|
-
<h2>Example Usage</h2>
|
|
130
|
-
<p>Once installed, ask Claude:</p>
|
|
131
|
-
<ul style="text-align: left; display: inline-block; margin-top: 20px;">
|
|
132
|
-
<li><em>"What Spring projects are available for security?"</em></li>
|
|
133
|
-
<li><em>"Show me the guide for creating a REST API with Spring Boot"</em></li>
|
|
134
|
-
<li><em>"How do I configure Spring Security?"</em></li>
|
|
135
|
-
<li><em>"Explain Spring Boot auto-configuration"</em></li>
|
|
136
|
-
</ul>
|
|
137
|
-
</div>
|
|
138
|
-
</section>
|
|
139
|
-
|
|
140
|
-
<footer>
|
|
141
|
-
<div class="container">
|
|
142
|
-
<p>© 2025 Spring Documentation MCP Server by <a href="https://github.com/tky0065" style="color: #68d391;">EnokDev</a> | MIT License</p>
|
|
143
|
-
<p>Access the complete Spring ecosystem directly in Claude Desktop</p>
|
|
144
|
-
</div>
|
|
145
|
-
</footer>
|
|
146
|
-
</body>
|
|
147
|
-
</html>
|
package/guid.md
DELETED
|
@@ -1,92 +0,0 @@
|
|
|
1
|
-
# 🚀 Serveur MCP Spring Boot Documentation
|
|
2
|
-
|
|
3
|
-
## En TypeScript
|
|
4
|
-
https://github.com/modelcontextprotocol/typescript-sdk
|
|
5
|
-
|
|
6
|
-
## 📖 Vue d'ensemble
|
|
7
|
-
|
|
8
|
-
Ce projet implémente un serveur MCP (Model Context Protocol) en **TypeScript** qui permet d'accéder facilement à la documentation officielle de Spring Boot. Le serveur récupère et formate le contenu depuis `docs.spring.io` et l'expose via une interface MCP standardisée.
|
|
9
|
-
|
|
10
|
-
Utilise aussi https://spring.io/projects
|
|
11
|
-
|
|
12
|
-
### 🎯 Objectifs
|
|
13
|
-
|
|
14
|
-
- ✅ Fournir un accès programmatique à la documentation Spring Boot
|
|
15
|
-
- ✅ Supporter le protocole MCP 2025-06-18
|
|
16
|
-
- ✅ Convertir le HTML en format Markdown lisible
|
|
17
|
-
- ✅ Offrir une interface simple et bien documentée
|
|
18
|
-
|
|
19
|
-
Ce serveur MCP (Model Context Protocol) permet d'accéder à la documentation officielle de Spring Boot via une interface standardisée, **maintenant disponible pour un usage public** comme Context7 !
|
|
20
|
-
|
|
21
|
-
## 🛠️ Fonctionnalités
|
|
22
|
-
|
|
23
|
-
### Outils disponibles
|
|
24
|
-
|
|
25
|
-
1. **`search_spring_docs`** - Recherche dans la documentation avec des mots-clés
|
|
26
|
-
2. **`get_spring_guide`** - Récupère un guide Spring Boot complet
|
|
27
|
-
3. **`get_spring_reference`** - Accède aux sections de la documentation de référence
|
|
28
|
-
4. **`search_spring_concepts`** - Recherche des concepts par catégorie
|
|
29
|
-
|
|
30
|
-
### Catégories de concepts supportées
|
|
31
|
-
|
|
32
|
-
- **Core** : Auto-configuration, Profiles, Properties
|
|
33
|
-
- **Web** : Spring MVC, Serveurs intégrés
|
|
34
|
-
- **Data** : Spring Data JPA, Migration de base de données
|
|
35
|
-
- **Security** : Spring Security
|
|
36
|
-
- **Testing** : Test Slices, annotations de test
|
|
37
|
-
- **Production** : Actuator, monitoring
|
|
38
|
-
|
|
39
|
-
## 🚀 Installation et utilisation
|
|
40
|
-
|
|
41
|
-
### 1. Installation des dépendances
|
|
42
|
-
```bash
|
|
43
|
-
npm install
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
### 2. Compilation
|
|
47
|
-
```bash
|
|
48
|
-
npm run build
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
### 3. Test du serveur
|
|
52
|
-
```bash
|
|
53
|
-
npm start
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
### 4. Configuration avec Claude Desktop
|
|
57
|
-
|
|
58
|
-
Copiez la configuration suivante dans votre fichier `claude_desktop_config.json` :
|
|
59
|
-
|
|
60
|
-
**macOS** : `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
61
|
-
**Windows** : `%APPDATA%\Claude\claude_desktop_config.json`
|
|
62
|
-
|
|
63
|
-
```json
|
|
64
|
-
{
|
|
65
|
-
"mcpServers": {
|
|
66
|
-
"springboot-docs": {
|
|
67
|
-
"command": "node",
|
|
68
|
-
"args": ["/Users/yacoubakone/Documents/dev/springdocsmcp/build/index.js"]
|
|
69
|
-
}
|
|
70
|
-
}
|
|
71
|
-
}
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
## 📝 Exemples d'utilisation
|
|
75
|
-
|
|
76
|
-
Une fois configuré avec Claude Desktop, vous pouvez utiliser des requêtes comme :
|
|
77
|
-
|
|
78
|
-
- "Recherche dans la documentation Spring Boot sur les API REST"
|
|
79
|
-
- "Récupère le guide gs-rest-service"
|
|
80
|
-
- "Explique le concept d'auto-configuration dans Spring Boot"
|
|
81
|
-
- "Montre-moi la documentation sur Spring Security"
|
|
82
|
-
|
|
83
|
-
## 🏗️ Architecture du projet
|
|
84
|
-
|
|
85
|
-
```
|
|
86
|
-
src/
|
|
87
|
-
├── index.ts # Point d'entrée principal du serveur MCP
|
|
88
|
-
├── services/
|
|
89
|
-
│ └── springboot-docs.ts # Service de récupération de documentation
|
|
90
|
-
└── tools/
|
|
91
|
-
└── index.ts # Définitions des outils MCP exposés
|
|
92
|
-
```
|