@enokdev/springdocs-mcp 1.2.0 → 1.2.1

package/INSTALL.md

@@ -1,123 +0,0 @@
-# 📦 Spring Documentation MCP Server - Public Installation
-
-Public MCP server for accessing complete Spring Boot documentation and the Spring ecosystem.
-
-## 🚀 Quick Installation
-
-### Via npm (recommended)
-```bash
-npm install -g @enokdev/springdocs-mcp
-```
-
-### Via npx (without installation)
-```bash
-npx @enokdev/springdocs-mcp
-```
-
-## ⚡ Claude Desktop Configuration
-
-### 1. Global Installation
-```bash
-npm install -g @enokdev/springdocs-mcp
-```
-
-### 2. Claude Desktop Configuration
-Add this to your `claude_desktop_config.json`:
-
-```json
-{
-  "mcpServers": {
-    "spring-docs": {
-      "command": "springdocs-mcp"
-    }
-  }
-}
-```
-
-### 3. Configuration File Location
-- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
-- **Windows**: `%APPDATA%\\Claude\\claude_desktop_config.json`
-- **Linux**: `~/.config/Claude/claude_desktop_config.json`
-
-## 🛠️ Advanced Configuration
-
-### With specific path
-```json
-{
-  "mcpServers": {
-    "spring-docs": {
-      "command": "node",
-      "args": ["/path/to/global/node_modules/@enokdev/springdocs-mcp/build/index.js"]
-    }
-  }
-}
-```
-
-### With npx (without global installation)
-```json
-{
-  "mcpServers": {
-    "spring-docs": {
-      "command": "npx",
-      "args": ["@enokdev/springdocs-mcp"]
-    }
-  }
-}
-```
-
-## 🔧 Available Tools
-
-Once configured, you'll have access to 7 tools in Claude Desktop:
-
-1. **`search_spring_docs`** - Search Spring Boot documentation
-2. **`search_spring_projects`** - Search Spring projects
-3. **`get_spring_project`** - Get Spring project details
-4. **`get_all_spring_guides`** - List Spring guides
-5. **`get_spring_guide`** - Get specific guide content
-6. **`get_spring_reference`** - Get reference documentation
-7. **`search_spring_concepts`** - Search Spring Boot concepts
-
-## 💡 Usage Examples
-
-Once installed, ask Claude:
-
-- *"What Spring projects are available for security?"*
-- *"Show me the guide for creating a REST API with Spring Boot"*
-- *"How do I configure Spring Security?"*
-- *"Explain Spring Boot auto-configuration"*
-
-## 🔄 Updates
-
-```bash
-npm update -g @enokdev/springdocs-mcp
-```
-
-## 🆘 Troubleshooting
-
-### Check installation
-```bash
-springdocs-mcp --version
-```
-
-### Manual test
-```bash
-echo '{"jsonrpc": "2.0", "id": 1, "method": "tools/list", "params": {}}' | springdocs-mcp
-```
-
-### Reinstallation
-```bash
-npm uninstall -g @enokdev/springdocs-mcp
-npm install -g @enokdev/springdocs-mcp
-```
-
-## 📚 Documentation Sources
-
-This server accesses:
-- **spring.io/projects** - All Spring projects
-- **spring.io/guides** - Practical guides
-- **docs.spring.io** - Reference documentation
-- **Built-in knowledge base** - Spring Boot concepts
-
----
-
-**🌟 Enjoy complete access to the Spring ecosystem directly in Claude Desktop!**

package/INSTALL_FR.md

@@ -1,123 +0,0 @@
-# 📦 Spring Documentation MCP Server - Installation publique
-
-Serveur MCP public pour accéder à toute la documentation Spring Boot et l'écosystème Spring complet.
-
-## 🚀 Installation rapide
-
-### Via npm (recommandé)
-```bash
-npm install -g @enokdev/springdocs-mcp
-```
-
-### Via npx (sans installation)
-```bash
-npx @enokdev/springdocs-mcp
-```
-
-## ⚡ Configuration Claude Desktop
-
-### 1. Installation globale
-```bash
-npm install -g @enokdev/springdocs-mcp
-```
-
-### 2. Configuration Claude Desktop
-Ajoutez ceci à votre `claude_desktop_config.json` :
-
-```json
-{
-  "mcpServers": {
-    "spring-docs": {
-      "command": "springdocs-mcp"
-    }
-  }
-}
-```
-
-### 3. Localisation du fichier de configuration
-- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
-- **Windows**: `%APPDATA%\\Claude\\claude_desktop_config.json`
-- **Linux**: `~/.config/Claude/claude_desktop_config.json`
-
-## 🛠️ Configuration avancée
-
-### Avec chemin spécifique
-```json
-{
-  "mcpServers": {
-    "spring-docs": {
-      "command": "node",
-      "args": ["/path/to/global/node_modules/@enokdev/springdocs-mcp/build/index.js"]
-    }
-  }
-}
-```
-
-### Avec npx (sans installation globale)
-```json
-{
-  "mcpServers": {
-    "spring-docs": {
-      "command": "npx",
-      "args": ["@enokdev/springdocs-mcp"]
-    }
-  }
-}
-```
-
-## 🔧 Outils disponibles
-
-Une fois configuré, vous aurez accès à 7 outils dans Claude Desktop :
-
-1. **`search_spring_docs`** - Recherche dans la documentation Spring Boot
-2. **`search_spring_projects`** - Recherche de projets Spring
-3. **`get_spring_project`** - Détails d'un projet Spring
-4. **`get_all_spring_guides`** - Liste des guides Spring
-5. **`get_spring_guide`** - Contenu d'un guide spécifique
-6. **`get_spring_reference`** - Documentation de référence
-7. **`search_spring_concepts`** - Recherche de concepts Spring Boot
-
-## 💡 Exemples d'utilisation
-
-Une fois installé, demandez à Claude :
-
-- *"Quels sont les projets Spring disponibles pour la sécurité ?"*
-- *"Montre-moi le guide pour créer une API REST avec Spring Boot"*
-- *"Comment configurer Spring Security ?"*
-- *"Explique-moi l'auto-configuration dans Spring Boot"*
-
-## 🔄 Mise à jour
-
-```bash
-npm update -g @enokdev/springdocs-mcp
-```
-
-## 🆘 Dépannage
-
-### Vérifier l'installation
-```bash
-springdocs-mcp --version
-```
-
-### Test manual
-```bash
-echo '{"jsonrpc": "2.0", "id": 1, "method": "tools/list", "params": {}}' | springdocs-mcp
-```
-
-### Réinstallation
-```bash
-npm uninstall -g @enokdev/springdocs-mcp
-npm install -g @enokdev/springdocs-mcp
-```
-
-## 📚 Sources de documentation
-
-Ce serveur accède à :
-- **spring.io/projects** - Tous les projets Spring
-- **spring.io/guides** - Guides pratiques
-- **docs.spring.io** - Documentation de référence
-- **Base de connaissances intégrée** - Concepts Spring Boot
-
----
-
-**🌟 Profitez de l'accès complet à l'écosystème Spring directement dans Claude Desktop !**

package/JETBRAINS_SETUP.md

@@ -1,171 +0,0 @@
-# 🚀 Configuration pour IDEs JetBrains
-
-## 📋 IDEs JetBrains supportés
-
-- **IntelliJ IDEA** (Ultimate & Community)
-- **WebStorm**
-- **PyCharm** (Professional & Community)
-- **PhpStorm**
-- **RubyMine**
-- **CLion**
-- **GoLand**
-- **Rider**
-- **DataGrip**
-- **Android Studio**
-
-## ⚙️ Configuration
-
-### Option 1: Via le Plugin Claude (Recommandé)
-
-1. **Installer le plugin Claude** depuis JetBrains Marketplace
-2. **Configurer les serveurs MCP** dans Settings
-
-**Chemin:** `Settings → Tools → Claude → MCP Servers`
-
-**Configuration:**
-```json
-{
-  "spring-docs": {
-    "command": "/opt/homebrew/bin/springdocs-mcp"
-  }
-}
-```
-
-### Option 2: Configuration manuelle
-
-**Fichier de configuration JetBrains:**
-`~/.jetbrains/claude_mcp_config.json`
-
-```json
-{
-  "mcpServers": {
-    "spring-docs": {
-      "command": "/opt/homebrew/bin/springdocs-mcp",
-      "description": "Spring Documentation MCP Server - Access to complete Spring ecosystem",
-      "timeout": 30000
-    }
-  }
-}
-```
-
-### Option 3: Configuration par IDE
-
-#### IntelliJ IDEA
-**Fichier:** `~/.IntelliJIdea/config/options/claude.xml`
-
-```xml
-<application>
-  <component name="ClaudeSettings">
-    <option name="mcpServers">
-      <map>
-        <entry key="spring-docs">
-          <value>
-            <MCPServerConfig>
-              <option name="command" value="/opt/homebrew/bin/springdocs-mcp" />
-              <option name="description" value="Spring Documentation" />
-            </MCPServerConfig>
-          </value>
-        </entry>
-      </map>
-    </option>
-  </component>
-</application>
-```
-
-#### WebStorm
-**Fichier:** `~/.WebStorm/config/options/claude.xml`
-
-#### PyCharm
-**Fichier:** `~/.PyCharm/config/options/claude.xml`
-
-## 🔧 Script d'installation automatique
-
-Créons un script pour configurer automatiquement tous vos IDEs JetBrains :
-
-```bash
-#!/bin/bash
-./setup-jetbrains.sh
-```
-
-## 🎯 Utilisation dans JetBrains IDEs
-
-### 1. Accès via Chat AI
-
-Dans votre IDE JetBrains avec Claude activé :
-
-```
-Quels sont les projets Spring pour la sécurité ?
-```
-
-### 2. Aide contextuelle
-
-Sélectionnez du code Spring et demandez :
-
-```
-Comment améliorer cette configuration Spring Boot ?
-```
-
-### 3. Documentation instantanée
-
-```
-Montre-moi le guide Spring Boot pour les APIs REST
-```
-
-## 🛠️ Outils disponibles dans JetBrains
-
-Tous les 7 outils MCP seront disponibles :
-
-1. **search_spring_docs** - Recherche documentation
-2. **search_spring_projects** - Projets Spring
-3. **get_spring_project** - Détails projet
-4. **get_all_spring_guides** - Liste guides
-5. **get_spring_guide** - Contenu guide
-6. **get_spring_reference** - Référence
-7. **search_spring_concepts** - Concepts
-
-## 📝 Exemples d'utilisation
-
-### Développement Spring Boot dans IntelliJ
-
-```java
-@RestController
-public class UserController {
-    // Demander à Claude : "Montre-moi les meilleures pratiques pour ce contrôleur"
-}
-```
-
-### Configuration dans application.yml
-
-```yaml
-spring:
-  # Demander : "Quelles sont les options de configuration disponibles ?"
-```
-
-## 🔍 Dépannage JetBrains
-
-### Plugin Claude non visible
-1. Vérifier que le plugin est installé
-2. Redémarrer l'IDE
-3. Vérifier les permissions
-
-### MCP Server non connecté
-1. Vérifier le chemin : `/opt/homebrew/bin/springdocs-mcp`
-2. Tester la commande dans le terminal
-3. Vérifier les logs de l'IDE
-
-## 📍 Emplacements des configurations
-
-### macOS
-- **IntelliJ IDEA:** `~/Library/Application Support/JetBrains/IntelliJIdea*/`
-- **WebStorm:** `~/Library/Application Support/JetBrains/WebStorm*/`
-- **PyCharm:** `~/Library/Application Support/JetBrains/PyCharm*/`
-
-### Windows
-- **Tous IDEs:** `%APPDATA%\JetBrains\[IDE_NAME]*\`
-
-### Linux
-- **Tous IDEs:** `~/.config/JetBrains/[IDE_NAME]*/`
-
----
-
-**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

@@ -1,219 +0,0 @@
-# 📚 Spring Documentation MCP Server
-
-[![npm version](https://badge.fury.io/js/@enokdev%2Fspringdocs-mcp.svg)](https://badge.fury.io/js/@enokdev%2Fspringdocs-mcp)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Node.js](https://img.shields.io/badge/Node.js-18+-green.svg)](https://nodejs.org/)
-[![GitHub](https://img.shields.io/badge/GitHub-tky0065/springdocs--mcp-blue.svg)](https://github.com/tky0065/springdocs-mcp)
-
-A public **Model Context Protocol (MCP)** server that provides access to the complete Spring Boot documentation and Spring ecosystem directly in Claude Desktop.
-
-## 🚀 Quick Installation
-
-```bash
-npm install -g @enokdev/springdocs-mcp
-```
-
-Then add to your `claude_desktop_config.json`:
-```json
-{
-  "mcpServers": {
-    "spring-docs": {
-      "command": "springdocs-mcp"
-    }
-  }
-}
-```
-
-## ✨ Features
-
-- 🌐 **Complete access** to spring.io/projects (all Spring projects)
-- 📖 **Practical guides** spring.io/guides with filtering
-- 📚 **Reference documentation** docs.spring.io
-- � **Recherche intelligente** dans tout l'écosystème Spring
-- 💡 **Base de connaissances** intégrée des concepts Spring Boot
-- ⚡ **7 outils MCP** pour une exploration complète
-
-## 🛠️ Utilisation
-
-### Démarrage du serveur
-
-```bash
-npm start
-```
-
-ou
-
-```bash
-node build/index.js
-```
-
-## 🛠️ Outils disponibles
-
-Le serveur MCP propose **7 outils** pour explorer la documentation Spring :
-
-### 1. `search_spring_docs`
-Recherche dans la documentation Spring Boot avec des mots-clés.
-
-**Paramètres :**
-- `query` (string, requis) : Mots-clés à rechercher
-- `docType` (string, optionnel) : Type de documentation (`guides`, `reference`, `api`, `all`)
-- `limit` (number, optionnel) : Nombre maximum de résultats (défaut: 10)
-
-### 2. `search_spring_projects`
-Recherche parmi tous les projets Spring disponibles sur spring.io/projects.
-
-**Paramètres :**
-- `query` (string, requis) : Mots-clés à rechercher dans les projets Spring
-- `limit` (number, optionnel) : Nombre maximum de projets à retourner (défaut: 10)
-
-### 3. `get_spring_project`
-Récupère les détails complets d'un projet Spring spécifique.
-
-**Paramètres :**
-- `projectName` (string, requis) : Nom du projet Spring (ex: `spring-boot`, `spring-security`)
-
-### 4. `get_all_spring_guides`
-Récupère la liste de tous les guides Spring disponibles, optionnellement filtrés par catégorie.
-
-**Paramètres :**
-- `category` (string, optionnel) : Catégorie de guides à filtrer
-- `limit` (number, optionnel) : Nombre maximum de guides (défaut: 20)
-
-### 5. `get_spring_guide`
-Récupère le contenu complet d'un guide Spring Boot spécifique.
-
-**Paramètres :**
-- `guideId` (string, requis) : Identifiant du guide (ex: `gs-rest-service`)
-
-### 6. `get_spring_reference`
-Récupère une section spécifique de la documentation de référence Spring Boot.
-
-**Paramètres :**
-- `section` (string, requis) : Section de la documentation (ex: `web`, `data`, `security`)
-- `subsection` (string, optionnel) : Sous-section pour une recherche plus précise
-
-### 7. `search_spring_concepts`
-Recherche des concepts Spring Boot par catégorie avec explications détaillées.
-
-**Paramètres :**
-- `concept` (string, requis) : Concept à rechercher (ex: `auto-configuration`)
-- `category` (string, optionnel) : Catégorie (`core`, `web`, `data`, `security`, `testing`, `production`)
-
-## � Sources de documentation
-
-Ce serveur MCP accède aux sources de documentation Spring suivantes :
-
-- **🌟 [spring.io/projects](https://spring.io/projects)** - Tous les projets Spring (Boot, Security, Data, Cloud, etc.)
-- **📖 [spring.io/guides](https://spring.io/guides)** - Guides pratiques et tutoriels
-- **📚 [docs.spring.io](https://docs.spring.io)** - Documentation de référence officielle
-- **🔧 API Documentation** - Documentation des classes et méthodes
-- **💡 Base de connaissances intégrée** - Concepts et bonnes pratiques Spring Boot
-
-## �🔧 Configuration avec Claude Desktop
-
-Pour utiliser ce serveur avec Claude Desktop, ajoutez la configuration suivante dans votre fichier `claude_desktop_config.json` :
-
-```json
-{
-  "mcpServers": {
-    "springboot-docs": {
-      "command": "node",
-      "args": ["/chemin/absolu/vers/springdocsmcp/build/index.js"]
-    }
-  }
-}
-```
-
-### Localisation du fichier de configuration
-
-- **macOS** : `~/Library/Application Support/Claude/claude_desktop_config.json`
-- **Windows** : `%APPDATA%\\Claude\\claude_desktop_config.json`
-
-## 📚 Exemples d'utilisation
-
-### Recherche générale
-```
-Recherche "REST API" dans la documentation Spring Boot
-```
-
-### Recherche de projets Spring
-```
-Trouve des projets Spring liés à "security"
-```
-
-### Détails d'un projet spécifique
-```
-Montre-moi les détails du projet "spring-boot"
-```
-
-### Liste des guides par catégorie
-```
-Quels sont les guides Spring pour la catégorie "Web" ?
-```
-
-### Récupération d'un guide spécifique
-```
-Récupère le guide "gs-rest-service"
-```
-
-### Exploration des concepts
-```
-Explique le concept "auto-configuration" dans Spring Boot
-```
-
-## 🏗️ Architecture
-
-Le projet est organisé comme suit :
-
-```
-src/
-├── index.ts              # Point d'entrée principal
-├── services/
-│   └── springboot-docs.ts # Service de récupération de documentation
-└── tools/
-    └── index.ts          # Définitions des outils MCP
-```
-
-### Composants principaux
-
-- **SpringBootMCPServer** : Serveur MCP principal qui gère les requêtes
-- **SpringBootDocsService** : Service pour récupérer et traiter la documentation
-- **ToolDefinitions** : Définitions des outils exposés via MCP
-
-## 🔒 Sécurité
-
-- Le serveur accède uniquement aux ressources publiques de `docs.spring.io`
-- Aucune donnée sensible n'est stockée ou transmise
-- Toutes les requêtes HTTP sont en lecture seule
-
-## 🐛 Dépannage
-
-### Erreurs courantes
-
-1. **"Cannot find module"** : Vérifiez que `npm install` a été exécuté
-2. **"Serveur non démarré"** : Vérifiez que la compilation avec `npm run build` s'est bien passée
-3. **"Documentation non trouvée"** : Vérifiez votre connexion internet
-
-### Logs
-
-Le serveur écrit ses logs sur `stderr` pour éviter d'interférer avec le protocole MCP sur `stdout`.
-
-## 🤝 Contribution
-
-Les contributions sont les bienvenues ! N'hésitez pas à :
-
-1. Forker le projet
-2. Créer une branche pour votre fonctionnalité
-3. Commiter vos changements
-4. Pousser vers la branche
-5. Ouvrir une Pull Request
-
-## 📄 Licence
-
-Ce projet est sous licence MIT. Voir le fichier `LICENSE` pour plus de détails.
-
-## 🔗 Ressources utiles
-
-- [Documentation Spring Boot](https://docs.spring.io/spring-boot/docs/current/reference/html/)
-- [Model Context Protocol](https://modelcontextprotocol.io/)
-- [SDK MCP TypeScript](https://github.com/modelcontextprotocol/typescript-sdk)