@enokdev/springdocs-mcp 1.1.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/.github/workflows/publish.yml +64 -0
- package/CHANGELOG.md +82 -0
- package/CONTRIBUTING.md +215 -0
- package/DEPLOYMENT.md +205 -0
- package/EXAMPLES.md +186 -0
- package/INSTALL.md +123 -0
- package/LICENSE +21 -0
- package/PUBLICATION_ENOKDEV.md +170 -0
- package/PUBLISHING.md +196 -0
- package/README.md +219 -0
- package/README_ENOKDEV.md +108 -0
- package/RELEASE_NOTES_v1.1.0.md +106 -0
- package/build/index.d.ts +3 -0
- package/build/index.d.ts.map +1 -0
- package/build/index.js +232 -0
- package/build/index.js.map +1 -0
- package/build/services/springboot-docs.d.ts +65 -0
- package/build/services/springboot-docs.d.ts.map +1 -0
- package/build/services/springboot-docs.js +549 -0
- package/build/services/springboot-docs.js.map +1 -0
- package/build/tools/index.d.ts +185 -0
- package/build/tools/index.d.ts.map +1 -0
- package/build/tools/index.js +144 -0
- package/build/tools/index.js.map +1 -0
- package/claude_desktop_config.json +8 -0
- package/docs/index.html +147 -0
- package/guid.md +92 -0
- package/package.json +58 -0
- package/publish.sh +130 -0
- package/src/index.ts +287 -0
- package/src/services/springboot-docs.ts +615 -0
- package/src/tools/index.ts +144 -0
- package/test.sh +64 -0
- package/tsconfig.json +24 -0
package/EXAMPLES.md
ADDED
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
# Exemples d'utilisation du serveur MCP Spring Documentation
|
|
2
|
+
|
|
3
|
+
Ce fichier contient des exemples pratiques d'utilisation du serveur MCP Spring Documentation avec Claude Desktop.
|
|
4
|
+
|
|
5
|
+
## 🚀 Scénarios d'utilisation
|
|
6
|
+
|
|
7
|
+
### 1. Découverte des projets Spring
|
|
8
|
+
|
|
9
|
+
**Question à Claude :**
|
|
10
|
+
> "Quels sont les projets Spring disponibles pour la sécurité ?"
|
|
11
|
+
|
|
12
|
+
**Outils utilisés :** `search_spring_projects`
|
|
13
|
+
**Résultat :** Liste des projets Spring Security avec descriptions
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
### 2. Apprentissage d'un nouveau projet Spring
|
|
18
|
+
|
|
19
|
+
**Question à Claude :**
|
|
20
|
+
> "Peux-tu m'expliquer le projet Spring Cloud ?"
|
|
21
|
+
|
|
22
|
+
**Outils utilisés :** `get_spring_project`
|
|
23
|
+
**Résultat :** Documentation complète de Spring Cloud
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
### 3. Exploration des guides par domaine
|
|
28
|
+
|
|
29
|
+
**Question à Claude :**
|
|
30
|
+
> "Montre-moi tous les guides Spring Boot pour le développement web"
|
|
31
|
+
|
|
32
|
+
**Outils utilisés :** `get_all_spring_guides`
|
|
33
|
+
**Résultat :** Liste des guides web avec liens et descriptions
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
### 4. Résolution d'un problème spécifique
|
|
38
|
+
|
|
39
|
+
**Question à Claude :**
|
|
40
|
+
> "Comment créer une API REST avec Spring Boot ?"
|
|
41
|
+
|
|
42
|
+
**Outils utilisés :** `search_spring_docs`, `get_spring_guide`
|
|
43
|
+
**Résultat :** Guide détaillé et documentation de référence
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
### 5. Compréhension des concepts
|
|
48
|
+
|
|
49
|
+
**Question à Claude :**
|
|
50
|
+
> "Explique-moi l'auto-configuration dans Spring Boot"
|
|
51
|
+
|
|
52
|
+
**Outils utilisés :** `search_spring_concepts`
|
|
53
|
+
**Résultat :** Explication détaillée avec exemples
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## 🎯 Exemples de requêtes spécifiques
|
|
58
|
+
|
|
59
|
+
### Recherche de documentation
|
|
60
|
+
```
|
|
61
|
+
Utilisateur: "Comment configurer Spring Security ?"
|
|
62
|
+
Claude utilise: search_spring_docs("Spring Security configuration")
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### Exploration de projets
|
|
66
|
+
```
|
|
67
|
+
Utilisateur: "Quels sont les projets Spring pour les données ?"
|
|
68
|
+
Claude utilise: search_spring_projects("data")
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Guides spécialisés
|
|
72
|
+
```
|
|
73
|
+
Utilisateur: "Guides Spring Boot pour les tests"
|
|
74
|
+
Claude utilise: get_all_spring_guides(category="Testing")
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Documentation de référence
|
|
78
|
+
```
|
|
79
|
+
Utilisateur: "Documentation Spring Boot pour la sécurité web"
|
|
80
|
+
Claude utilise: get_spring_reference("security", "web")
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Concepts avancés
|
|
84
|
+
```
|
|
85
|
+
Utilisateur: "Qu'est-ce que Spring Actuator ?"
|
|
86
|
+
Claude utilise: search_spring_concepts("actuator", "production")
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
## 💡 Conseils d'utilisation optimale
|
|
92
|
+
|
|
93
|
+
### 1. Soyez spécifique dans vos questions
|
|
94
|
+
- ❌ "Spring Boot"
|
|
95
|
+
- ✅ "Comment configurer une base de données avec Spring Boot ?"
|
|
96
|
+
|
|
97
|
+
### 2. Utilisez des mots-clés pertinents
|
|
98
|
+
- ❌ "Aide"
|
|
99
|
+
- ✅ "REST API", "JPA", "Security", "Testing"
|
|
100
|
+
|
|
101
|
+
### 3. Explorez par domaine
|
|
102
|
+
- "Projets Spring pour le cloud"
|
|
103
|
+
- "Guides Spring Boot pour les microservices"
|
|
104
|
+
- "Documentation Spring Security"
|
|
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"
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
## 🔧 Workflows recommandés
|
|
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")`
|
|
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")`
|
|
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")`
|
|
132
|
+
|
|
133
|
+
---
|
|
134
|
+
|
|
135
|
+
## 🌟 Cas d'usage avancés
|
|
136
|
+
|
|
137
|
+
### Développement d'une API REST complète
|
|
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"
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### Migration vers Spring Boot 3
|
|
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"
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
### Architecture microservices
|
|
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"
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
---
|
|
163
|
+
|
|
164
|
+
## 📖 Types de réponses attendues
|
|
165
|
+
|
|
166
|
+
### Listes de résultats (search_*)
|
|
167
|
+
- Titres des ressources
|
|
168
|
+
- Descriptions courtes
|
|
169
|
+
- URLs directes
|
|
170
|
+
- Types de contenu
|
|
171
|
+
|
|
172
|
+
### Contenu détaillé (get_*)
|
|
173
|
+
- Documentation complète en Markdown
|
|
174
|
+
- Exemples de code
|
|
175
|
+
- Configuration
|
|
176
|
+
- Bonnes pratiques
|
|
177
|
+
|
|
178
|
+
### Concepts (search_spring_concepts)
|
|
179
|
+
- Définitions claires
|
|
180
|
+
- Exemples concrets
|
|
181
|
+
- Mots-clés associés
|
|
182
|
+
- Cas d'usage
|
|
183
|
+
|
|
184
|
+
---
|
|
185
|
+
|
|
186
|
+
*Ce serveur MCP vous donne accès à l'ensemble de l'écosystème Spring directement dans Claude Desktop !*
|
package/INSTALL.md
ADDED
|
@@ -0,0 +1,123 @@
|
|
|
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 !**
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Yacoub Akone
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
# 🚀 Guide de publication pour EnokDev (@enokdev)
|
|
2
|
+
|
|
3
|
+
## 📋 Informations de publication
|
|
4
|
+
|
|
5
|
+
- **GitHub**: https://github.com/tky0065
|
|
6
|
+
- **npm**: https://www.npmjs.com/~enokdev
|
|
7
|
+
- **Package**: `@enokdev/springdocs-mcp`
|
|
8
|
+
- **Repository**: `tky0065/springdocs-mcp`
|
|
9
|
+
|
|
10
|
+
## ⚡ Commandes de publication rapide
|
|
11
|
+
|
|
12
|
+
### 1. Préparer le repository GitHub
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
# Dans votre dossier de projet
|
|
16
|
+
cd /Users/yacoubakone/Documents/dev/springdocsmcp
|
|
17
|
+
|
|
18
|
+
# Initialiser Git (si pas encore fait)
|
|
19
|
+
git init
|
|
20
|
+
git add .
|
|
21
|
+
git commit -m "Initial release: Spring Documentation MCP Server v1.1.0"
|
|
22
|
+
|
|
23
|
+
# Créer le repository sur GitHub avec le nom: springdocs-mcp
|
|
24
|
+
# Description: "Spring Documentation MCP Server for Claude Desktop - Access the complete Spring ecosystem in Claude"
|
|
25
|
+
|
|
26
|
+
# Connecter le repository local
|
|
27
|
+
git remote add origin https://github.com/tky0065/springdocs-mcp.git
|
|
28
|
+
git branch -M main
|
|
29
|
+
git push -u origin main
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### 2. Publication sur npm
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
# Se connecter à npm avec votre compte enokdev
|
|
36
|
+
npm login
|
|
37
|
+
# Username: enokdev
|
|
38
|
+
# Password: [votre mot de passe]
|
|
39
|
+
# Email: [votre email]
|
|
40
|
+
|
|
41
|
+
# Vérifier la connexion
|
|
42
|
+
npm whoami
|
|
43
|
+
# Doit afficher: enokdev
|
|
44
|
+
|
|
45
|
+
# Compilation et test final
|
|
46
|
+
npm run build
|
|
47
|
+
npm test
|
|
48
|
+
|
|
49
|
+
# Publication
|
|
50
|
+
npm publish --access public
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### 3. Créer une release GitHub
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
# Créer un tag de version
|
|
57
|
+
git tag v1.1.0
|
|
58
|
+
git push origin v1.1.0
|
|
59
|
+
|
|
60
|
+
# La GitHub Action va automatiquement créer une release
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## 🌐 Après publication
|
|
64
|
+
|
|
65
|
+
### Installation pour les utilisateurs
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
npm install -g @enokdev/springdocs-mcp
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Configuration Claude Desktop
|
|
72
|
+
|
|
73
|
+
```json
|
|
74
|
+
{
|
|
75
|
+
"mcpServers": {
|
|
76
|
+
"spring-docs": {
|
|
77
|
+
"command": "springdocs-mcp"
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## 📈 Promotion
|
|
84
|
+
|
|
85
|
+
### 1. Réseaux sociaux
|
|
86
|
+
- **LinkedIn**: Post avec hashtags #SpringBoot #Claude #MCP #OpenSource
|
|
87
|
+
- **Twitter/X**: Mention @springboot et @anthropicai
|
|
88
|
+
- **GitHub**: Ajouter aux topics: `mcp`, `spring-boot`, `claude`, `documentation`
|
|
89
|
+
|
|
90
|
+
### 2. Communautés
|
|
91
|
+
- **Reddit**: r/SpringBoot, r/java, r/programming
|
|
92
|
+
- **Dev.to**: Article de présentation
|
|
93
|
+
- **Stack Overflow**: Répondre aux questions Spring Boot avec votre outil
|
|
94
|
+
|
|
95
|
+
### 3. Documentation officielle
|
|
96
|
+
- **MCP Registry**: Soumettre à la liste officielle MCP
|
|
97
|
+
- **Awesome Lists**: Ajouter aux listes "Awesome MCP" sur GitHub
|
|
98
|
+
|
|
99
|
+
## 🔗 Liens utiles
|
|
100
|
+
|
|
101
|
+
- **Package npm**: https://www.npmjs.com/package/@enokdev/springdocs-mcp
|
|
102
|
+
- **Repository GitHub**: https://github.com/tky0065/springdocs-mcp
|
|
103
|
+
- **Documentation**: https://tky0065.github.io/springdocs-mcp
|
|
104
|
+
- **Issues**: https://github.com/tky0065/springdocs-mcp/issues
|
|
105
|
+
|
|
106
|
+
## 📊 Métriques à suivre
|
|
107
|
+
|
|
108
|
+
- Downloads npm: https://npm-stat.com/charts.html?package=@enokdev/springdocs-mcp
|
|
109
|
+
- GitHub stars et forks
|
|
110
|
+
- Issues et pull requests
|
|
111
|
+
- Feedback utilisateurs
|
|
112
|
+
|
|
113
|
+
## 🔄 Mises à jour futures
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
# Pour publier une mise à jour
|
|
117
|
+
npm version patch # ou minor/major
|
|
118
|
+
git add .
|
|
119
|
+
git commit -m "Release v$(node -p "require('./package.json').version")"
|
|
120
|
+
git tag "v$(node -p "require('./package.json').version")"
|
|
121
|
+
git push origin main --tags
|
|
122
|
+
npm publish
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
## 🎯 Script de publication automatique
|
|
126
|
+
|
|
127
|
+
```bash
|
|
128
|
+
#!/bin/bash
|
|
129
|
+
# publish.sh
|
|
130
|
+
|
|
131
|
+
set -e
|
|
132
|
+
|
|
133
|
+
echo "🔍 Vérifications pré-publication..."
|
|
134
|
+
npm run build
|
|
135
|
+
npm test
|
|
136
|
+
|
|
137
|
+
echo "📝 Mise à jour de version..."
|
|
138
|
+
npm version patch
|
|
139
|
+
|
|
140
|
+
echo "📤 Envoi vers GitHub..."
|
|
141
|
+
git push origin main --tags
|
|
142
|
+
|
|
143
|
+
echo "📦 Publication sur npm..."
|
|
144
|
+
npm publish --access public
|
|
145
|
+
|
|
146
|
+
echo "✅ Publication terminée!"
|
|
147
|
+
echo "Package: https://www.npmjs.com/package/@enokdev/springdocs-mcp"
|
|
148
|
+
echo "GitHub: https://github.com/tky0065/springdocs-mcp"
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
---
|
|
152
|
+
|
|
153
|
+
## 🎉 Message de lancement suggéré
|
|
154
|
+
|
|
155
|
+
```markdown
|
|
156
|
+
🚀 Nouveau package npm: @enokdev/springdocs-mcp
|
|
157
|
+
|
|
158
|
+
Un serveur MCP qui donne accès à TOUTE la documentation Spring (Boot, Security, Data, Cloud...) directement dans Claude Desktop !
|
|
159
|
+
|
|
160
|
+
✨ 7 outils MCP pour explorer l'écosystème Spring
|
|
161
|
+
📚 Accès instantané à spring.io/projects + guides + docs
|
|
162
|
+
🔍 Recherche intelligente dans toute la documentation
|
|
163
|
+
⚡ Installation en une commande: npm install -g @enokdev/springdocs-mcp
|
|
164
|
+
|
|
165
|
+
Perfect pour tous les développeurs Spring utilisant Claude !
|
|
166
|
+
|
|
167
|
+
#SpringBoot #Claude #MCP #OpenSource #Documentation
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
**🌟 Votre serveur MCP sera bientôt disponible pour toute la communauté des développeurs Spring !**
|
package/PUBLISHING.md
ADDED
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
# 📦 Guide de publication - Spring Documentation MCP Server
|
|
2
|
+
|
|
3
|
+
Ce guide explique comment publier le serveur MCP pour que tout le monde puisse l'utiliser.
|
|
4
|
+
|
|
5
|
+
## 🚀 Étapes de publication
|
|
6
|
+
|
|
7
|
+
### 1. Préparation du repository GitHub
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# Initialiser Git (si pas déjà fait)
|
|
11
|
+
git init
|
|
12
|
+
git add .
|
|
13
|
+
git commit -m "Initial commit: Spring Documentation MCP Server v1.1.0"
|
|
14
|
+
|
|
15
|
+
# Créer un repository sur GitHub
|
|
16
|
+
# Puis connecter le repository local
|
|
17
|
+
git remote add origin https://github.com/tky0065/springdocs-mcp.git
|
|
18
|
+
git branch -M main
|
|
19
|
+
git push -u origin main
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### 2. Publication sur npm
|
|
23
|
+
|
|
24
|
+
#### A. Créer un compte npm
|
|
25
|
+
```bash
|
|
26
|
+
npm adduser
|
|
27
|
+
# ou
|
|
28
|
+
npm login
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
#### B. Vérifier la configuration
|
|
32
|
+
```bash
|
|
33
|
+
npm whoami
|
|
34
|
+
npm config list
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
#### C. Test avant publication
|
|
38
|
+
```bash
|
|
39
|
+
npm run build
|
|
40
|
+
npm pack --dry-run
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
#### D. Publication
|
|
44
|
+
```bash
|
|
45
|
+
# Publication initiale
|
|
46
|
+
npm publish --access public
|
|
47
|
+
|
|
48
|
+
# Ou pour une mise à jour
|
|
49
|
+
npm version patch # ou minor/major
|
|
50
|
+
npm publish
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### 3. Création d'un registry MCP public
|
|
54
|
+
|
|
55
|
+
#### A. Créer un fichier de registry
|
|
56
|
+
```json
|
|
57
|
+
{
|
|
58
|
+
"name": "@enokdev/springdocs-mcp",
|
|
59
|
+
"description": "Spring Documentation MCP Server for Claude Desktop",
|
|
60
|
+
"version": "1.1.0",
|
|
61
|
+
"homepage": "https://github.com/tky0065/springdocs-mcp",
|
|
62
|
+
"repository": "https://github.com/tky0065/springdocs-mcp.git",
|
|
63
|
+
"author": "EnokDev",
|
|
64
|
+
"license": "MIT",
|
|
65
|
+
"keywords": ["mcp", "spring", "documentation", "claude"],
|
|
66
|
+
"installation": {
|
|
67
|
+
"npm": "@enokdev/springdocs-mcp",
|
|
68
|
+
"github": "tky0065/springdocs-mcp"
|
|
69
|
+
},
|
|
70
|
+
"usage": {
|
|
71
|
+
"command": "springdocs-mcp",
|
|
72
|
+
"config": {
|
|
73
|
+
"mcpServers": {
|
|
74
|
+
"spring-docs": {
|
|
75
|
+
"command": "springdocs-mcp"
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## 🌐 Distribution publique
|
|
84
|
+
|
|
85
|
+
### 1. Via npm (recommandé)
|
|
86
|
+
Les utilisateurs peuvent installer avec :
|
|
87
|
+
```bash
|
|
88
|
+
npm install -g @enokdev/springdocs-mcp
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### 2. Via GitHub Releases
|
|
92
|
+
```bash
|
|
93
|
+
# Créer un tag de version
|
|
94
|
+
git tag v1.1.0
|
|
95
|
+
git push origin v1.1.0
|
|
96
|
+
|
|
97
|
+
# Créer une release sur GitHub avec les binaires
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### 3. Via Docker (optionnel)
|
|
101
|
+
```dockerfile
|
|
102
|
+
FROM node:18-alpine
|
|
103
|
+
WORKDIR /app
|
|
104
|
+
COPY package*.json ./
|
|
105
|
+
RUN npm ci --only=production
|
|
106
|
+
COPY build/ ./build/
|
|
107
|
+
EXPOSE 3000
|
|
108
|
+
CMD ["node", "build/index.js"]
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
## 📋 Liste de vérification avant publication
|
|
112
|
+
|
|
113
|
+
- [ ] ✅ **Code testé** - Tous les outils fonctionnent
|
|
114
|
+
- [ ] ✅ **Documentation complète** - README, INSTALL, EXAMPLES
|
|
115
|
+
- [ ] ✅ **Version mise à jour** - package.json et code source
|
|
116
|
+
- [ ] ✅ **License ajoutée** - MIT License
|
|
117
|
+
- [ ] ✅ **Repository GitHub** - Code source accessible
|
|
118
|
+
- [ ] ✅ **npm configuré** - Accès de publication
|
|
119
|
+
- [ ] ✅ **Keywords optimisés** - Pour la découverte
|
|
120
|
+
- [ ] ✅ **Tests passés** - Script de test fonctionne
|
|
121
|
+
|
|
122
|
+
## 🔧 Configuration pour les utilisateurs
|
|
123
|
+
|
|
124
|
+
### Configuration Claude Desktop simplifiée
|
|
125
|
+
```json
|
|
126
|
+
{
|
|
127
|
+
"mcpServers": {
|
|
128
|
+
"spring-docs": {
|
|
129
|
+
"command": "springdocs-mcp"
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Documentation utilisateur
|
|
136
|
+
Créer des guides pour :
|
|
137
|
+
- Installation rapide
|
|
138
|
+
- Configuration Claude Desktop
|
|
139
|
+
- Exemples d'utilisation
|
|
140
|
+
- Dépannage
|
|
141
|
+
|
|
142
|
+
## 📈 Promotion et visibilité
|
|
143
|
+
|
|
144
|
+
### 1. Soumission aux annuaires MCP
|
|
145
|
+
- Registre officiel MCP (si disponible)
|
|
146
|
+
- Awesome MCP lists sur GitHub
|
|
147
|
+
- Documentation Anthropic
|
|
148
|
+
|
|
149
|
+
### 2. Communication
|
|
150
|
+
- Article de blog
|
|
151
|
+
- Post LinkedIn/Twitter
|
|
152
|
+
- Documentation Spring Boot community
|
|
153
|
+
- Slack/Discord Spring Boot
|
|
154
|
+
|
|
155
|
+
### 3. SEO et découvrabilité
|
|
156
|
+
- Keywords optimisés dans package.json
|
|
157
|
+
- README avec badges
|
|
158
|
+
- Documentation claire
|
|
159
|
+
- Exemples concrets
|
|
160
|
+
|
|
161
|
+
## 🔄 Maintenance continue
|
|
162
|
+
|
|
163
|
+
### 1. Versioning sémantique
|
|
164
|
+
- **PATCH** : Corrections de bugs
|
|
165
|
+
- **MINOR** : Nouvelles fonctionnalités
|
|
166
|
+
- **MAJOR** : Changements incompatibles
|
|
167
|
+
|
|
168
|
+
### 2. Monitoring
|
|
169
|
+
- GitHub issues
|
|
170
|
+
- npm downloads
|
|
171
|
+
- Feedback utilisateurs
|
|
172
|
+
|
|
173
|
+
### 3. Mises à jour
|
|
174
|
+
- Dépendances sécurisées
|
|
175
|
+
- Nouvelles fonctionnalités Spring
|
|
176
|
+
- Améliorations MCP
|
|
177
|
+
|
|
178
|
+
---
|
|
179
|
+
|
|
180
|
+
## 🎯 Commandes de publication rapide
|
|
181
|
+
|
|
182
|
+
```bash
|
|
183
|
+
# Préparation
|
|
184
|
+
npm run build
|
|
185
|
+
npm test
|
|
186
|
+
|
|
187
|
+
# Publication
|
|
188
|
+
npm version minor
|
|
189
|
+
git add .
|
|
190
|
+
git commit -m "Release v$(node -p "require('./package.json').version")"
|
|
191
|
+
git tag "v$(node -p "require('./package.json').version")"
|
|
192
|
+
git push origin main --tags
|
|
193
|
+
npm publish --access public
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
🌟 **Votre serveur MCP sera alors accessible à tous les utilisateurs de Claude Desktop !**
|