@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/DEPLOYMENT.md DELETED
@@ -1,205 +0,0 @@
1
- # 🚀 Guide de déploiement public - Spring Documentation MCP Server
2
-
3
- ## ✅ État actuel du projet
4
-
5
- Votre serveur MCP Spring Documentation est **prêt pour la publication publique** !
6
-
7
- ### 📦 Configuration npm
8
- - ✅ **Package scope**: `@enokdev/springdocs-mcp`
9
- - ✅ **Accès public**: Configuré pour publication publique
10
- - ✅ **Version**: 1.1.0
11
- - ✅ **Scripts**: Build, test, publication automatique
12
- - ✅ **Dependencies**: Toutes les dépendances nécessaires
13
- - ✅ **Binary**: `springdocs-mcp` pour installation globale
14
-
15
- ### 📚 Documentation complète
16
- - ✅ **README.md**: Documentation principale avec badges
17
- - ✅ **INSTALL.md**: Guide d'installation pour utilisateurs finaux
18
- - ✅ **EXAMPLES.md**: Exemples d'utilisation pratiques
19
- - ✅ **CONTRIBUTING.md**: Guide pour contributeurs
20
- - ✅ **CHANGELOG.md**: Historique des versions
21
- - ✅ **PUBLISHING.md**: Guide de publication
22
- - ✅ **docs/index.html**: Site web de documentation
23
- - ✅ **LICENSE**: Licence MIT
24
-
25
- ### 🔧 Infrastructure
26
- - ✅ **GitHub Actions**: Workflow de publication automatique
27
- - ✅ **Tests**: Script de validation fonctionnelle
28
- - ✅ **Build**: Compilation TypeScript optimisée
29
- - ✅ **NPM ignore**: Fichiers exclus de la publication
30
-
31
- ## 🚀 Étapes pour rendre public
32
-
33
- ### 1. **Préparer le repository GitHub**
34
-
35
- ```bash
36
- # Initialiser Git si pas encore fait
37
- git init
38
- git add .
39
- git commit -m "Ready for public release v1.1.0"
40
-
41
- # Créer un repository public sur GitHub
42
- # Nom suggéré: springdocs-mcp
43
- # Description: "Spring Documentation MCP Server for Claude Desktop"
44
-
45
- # Connecter le repository local
46
- git remote add origin https://github.com/tky0065/springdocs-mcp.git
47
- git branch -M main
48
- git push -u origin main
49
- ```
50
-
51
- ### 2. **Configurer npm pour publication**
52
-
53
- ```bash
54
- # Créer un compte npm (si pas encore fait)
55
- npm adduser
56
-
57
- # Ou se connecter
58
- npm login
59
-
60
- # Vérifier l'authentification
61
- npm whoami
62
- ```
63
-
64
- ### 3. **Publication sur npm**
65
-
66
- ```bash
67
- # Test final
68
- npm run build
69
- npm test
70
-
71
- # Publication
72
- npm publish --access public
73
- ```
74
-
75
- ### 4. **Création du tag et release GitHub**
76
-
77
- ```bash
78
- # Créer un tag de version
79
- git tag v1.1.0
80
- git push origin v1.1.0
81
-
82
- # La GitHub Action va automatiquement créer une release
83
- ```
84
-
85
- ## 🌐 Après publication
86
-
87
- ### Installation utilisateur
88
- Les utilisateurs pourront installer avec :
89
-
90
- ```bash
91
- npm install -g @enokdev/springdocs-mcp
92
- ```
93
-
94
- ### Configuration Claude Desktop
95
- Configuration simple :
96
-
97
- ```json
98
- {
99
- "mcpServers": {
100
- "spring-docs": {
101
- "command": "springdocs-mcp"
102
- }
103
- }
104
- }
105
- ```
106
-
107
- ## 📈 Promotion et visibilité
108
-
109
- ### 1. **Documentation officielle**
110
- - Ajouter à la documentation MCP d'Anthropic
111
- - Soumettre aux registres MCP communautaires
112
-
113
- ### 2. **Communauté Spring**
114
- - Annoncer sur les forums Spring Boot
115
- - Partager sur Reddit r/SpringBoot
116
- - Poster sur Stack Overflow avec tag spring-boot
117
-
118
- ### 3. **Réseaux sociaux**
119
- - LinkedIn avec hashtags #SpringBoot #Claude #MCP
120
- - Twitter/X mention @springboot
121
- - Dev.to article de présentation
122
-
123
- ### 4. **GitHub**
124
- - Ajouter aux listes "Awesome MCP"
125
- - Topics: `mcp`, `spring-boot`, `claude`, `documentation`
126
-
127
- ## 🔄 Maintenance continue
128
-
129
- ### Monitoring
130
- - GitHub Issues pour support utilisateur
131
- - npm downloads statistics
132
- - Feedback et feature requests
133
-
134
- ### Mises à jour
135
- - Suivre les versions Spring Boot
136
- - Améliorer les outils MCP
137
- - Ajouter de nouvelles sources de documentation
138
-
139
- ## 📊 Métriques de succès
140
-
141
- ### Adoption
142
- - Downloads npm
143
- - GitHub stars
144
- - Issues/feedback utilisateurs
145
-
146
- ### Usage
147
- - Nombre d'utilisateurs Claude Desktop
148
- - Fréquence d'utilisation des outils
149
- - Requêtes de documentation populaires
150
-
151
- ## 🎯 Roadmap future
152
-
153
- ### Version 1.2.0
154
- - Support Spring Boot 3.2+
155
- - Nouveaux projets Spring
156
- - Amélioration des performances
157
-
158
- ### Version 1.3.0
159
- - Support multi-langues
160
- - Cache intelligent
161
- - Analytics d'usage
162
-
163
- ## 🤝 Contribution communautaire
164
-
165
- ### Ouverture
166
- - Issues templates
167
- - Pull request guidelines
168
- - Code of conduct
169
- - Contributor recognition
170
-
171
- ### Gouvernance
172
- - Maintenance collaborative
173
- - Revue de code
174
- - Tests automatisés
175
- - Documentation collaborative
176
-
177
- ---
178
-
179
- ## 🎉 Commandes de publication rapide
180
-
181
- ```bash
182
- # Vérifications finales
183
- npm run build
184
- npm test
185
- npm pack --dry-run
186
-
187
- # Publication
188
- npm version patch # ou minor/major selon les changements
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
- ## 🌟 Impact attendu
197
-
198
- Une fois publié, votre serveur MCP permettra à **tous les développeurs utilisant Claude Desktop** d'avoir un accès instantané à :
199
-
200
- - 📚 **Toute la documentation Spring**
201
- - 🔍 **Recherche intelligente** dans l'écosystème Spring
202
- - 💡 **Apprentissage interactif** avec Claude
203
- - ⚡ **Développement accéléré** Spring Boot
204
-
205
- **🚀 Votre contribution va révolutionner l'accès à la documentation Spring pour la communauté des développeurs !**
@@ -1,170 +0,0 @@
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 DELETED
@@ -1,196 +0,0 @@
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 !**
package/README_ENOKDEV.md DELETED
@@ -1,108 +0,0 @@
1
- # 🎯 Publication rapide - Instructions pour EnokDev
2
-
3
- ## ✅ Tout est prêt !
4
-
5
- Votre serveur MCP Spring Documentation est configuré et prêt pour la publication publique avec vos informations :
6
-
7
- - **npm**: `@enokdev/springdocs-mcp`
8
- - **GitHub**: `tky0065/springdocs-mcp`
9
- - **Commande**: `springdocs-mcp`
10
-
11
- ## 🚀 Publication en 3 étapes
12
-
13
- ### 1. Créer le repository GitHub
14
-
15
- ```bash
16
- # Aller sur GitHub et créer un nouveau repository public:
17
- # Nom: springdocs-mcp
18
- # Description: Spring Documentation MCP Server for Claude Desktop - Access the complete Spring ecosystem in Claude
19
- ```
20
-
21
- ### 2. Connecter et publier
22
-
23
- ```bash
24
- # Dans votre terminal
25
- cd /Users/yacoubakone/Documents/dev/springdocsmcp
26
-
27
- # Script automatique de publication
28
- ./publish.sh
29
- ```
30
-
31
- **Ou manuellement :**
32
-
33
- ```bash
34
- # Connecter le repository
35
- git remote add origin https://github.com/tky0065/springdocs-mcp.git
36
- git add .
37
- git commit -m "Initial release v1.1.0"
38
- git push -u origin main
39
-
40
- # Se connecter à npm
41
- npm login # avec votre compte enokdev
42
-
43
- # Publier
44
- npm publish --access public
45
- ```
46
-
47
- ### 3. Créer une release
48
-
49
- ```bash
50
- git tag v1.1.0
51
- git push origin v1.1.0
52
- ```
53
-
54
- ## 📦 Après publication
55
-
56
- ### Les utilisateurs pourront installer avec :
57
-
58
- ```bash
59
- npm install -g @enokdev/springdocs-mcp
60
- ```
61
-
62
- ### Configuration Claude Desktop :
63
-
64
- ```json
65
- {
66
- "mcpServers": {
67
- "spring-docs": {
68
- "command": "springdocs-mcp"
69
- }
70
- }
71
- }
72
- ```
73
-
74
- ## 🌟 Liens de votre package
75
-
76
- - **npm package**: https://www.npmjs.com/package/@enokdev/springdocs-mcp
77
- - **GitHub repo**: https://github.com/tky0065/springdocs-mcp
78
- - **Documentation**: https://tky0065.github.io/springdocs-mcp (après publication)
79
- - **Stats**: https://npm-stat.com/charts.html?package=@enokdev/springdocs-mcp
80
-
81
- ## 📱 Message de lancement suggéré
82
-
83
- ```
84
- 🚀 Nouveau: @enokdev/springdocs-mcp
85
-
86
- Un serveur MCP qui donne accès à TOUTE la documentation Spring directement dans Claude Desktop !
87
-
88
- ✨ 7 outils MCP
89
- 📚 Spring Boot + Security + Data + Cloud + tous les projets
90
- 🔍 Recherche intelligente
91
- ⚡ Installation: npm install -g @enokdev/springdocs-mcp
92
-
93
- Perfect pour les développeurs Spring utilisant Claude !
94
-
95
- #SpringBoot #Claude #MCP #OpenSource
96
- ```
97
-
98
- ## 🔧 Maintenance
99
-
100
- Pour publier des mises à jour :
101
-
102
- ```bash
103
- ./publish.sh # Script automatique
104
- ```
105
-
106
- ---
107
-
108
- **🎉 Votre outil va aider toute la communauté des développeurs Spring !**