Skip to content

QUICKSTART.md

Latest commit

 

History

History
229 lines (159 loc) · 4.6 KB

QUICKSTART.md

File metadata and controls

229 lines (159 loc) · 4.6 KB
Raw

🚀 Guide de démarrage rapide

Guide pour démarrer avec DroitFrancaisMCP en 5 minutes.

⚡ Installation express

1. Prérequis

2. Installation (3 commandes)

# Cloner et entrer dans le projet
git clone https://github.com/jmtanguy/DroitFrancaisMCP.git
cd DroitFrancaisMCP

# Créer l'environnement virtuel
python3 -m venv .venv && source .venv/bin/activate

# Installer les dépendances (seulement 3 packages !)
pip install -r requirements.txt

3. Configuration (1 minute)

# Copier le template
cp .env.example .env

# Éditer avec vos identifiants PISTE
nano .env

Remplir :

PISTE_CLIENT_ID=votre_client_id
PISTE_CLIENT_SECRET=votre_secret

4. Lancer le serveur

Lancer install.ps1 (Windows) ou install.sh (Mac)

Démarrer Claude Desktop ou Cursor

✅ C'est tout ! Le serveur est prêt.

🎯 Configuration des clients MCP

Claude Desktop

Ajouter dans ~/.config/claude-desktop/claude_desktop_config.json :

{
  "mcpServers": {
    "droit-francais": {
      "command": "/chemin/vers/DroitFrancaisMCP/.venv/bin/python3",
      "args": ["/chemin/vers/DroitFrancaisMCP/droit_francais_MCP.py"]
    }
  }
}

Redémarrer Claude Desktop → Le serveur apparaît !

Cursor

Ajouter dans votre fichier de configuration MCP Cursor (généralement ~/.cursor/mcp.json ou dans les paramètres) :

{
  "mcpServers": {
    "DroitFrancaisMCP": {
      "command": "<PATH_TO_DroitFrancaisMCP>/.venv/bin/python3",
      "args": [
        "-u",
        "<PATH_TO_DroitFrancaisMCP>/droit_francais_MCP.py"
      ],
      "cwd": "<PATH_TO_DroitFrancaisMCP>",
      "env": {
        "PYTHONPATH": "<PATH_TO_DroitFrancaisMCP>",
        "PYTHONUNBUFFERED": "1",
        "PYTHONIOENCODING": "utf-8"
      },
      "envFile": "<PATH_TO_ENV_FILE>",
      "description": "MCP server for French legal research (Légifrance, JudiLibre)",
      "enabled": true
    }
  }
}

💡 Remplacez :

  • <PATH_TO_DroitFrancaisMCP> par le chemin complet vers votre répertoire
  • <PATH_TO_ENV_FILE> par le chemin complet vers votre fichier .env

Redémarrer Cursor → Le serveur apparaît !

🧪 Premier test

Dans Claude Desktop ou Cursor, essayez :

Recherche-moi les articles sur le mariage dans le Code civil

Ou directement avec pytest :

pytest test_api_legifrance.py -v

📚 Commandes utiles

Avec Make (recommandé)

make help          # Voir toutes les commandes
make install-dev   # Installer dépendances dev
make test          # Lancer les tests
make format        # Formater le code
make lint          # Vérifier le code
make security      # Scan de sécurité
make clean         # Nettoyer

Sans Make

# Tests
pytest --cov=. --cov-report=html

# Format
black --line-length 100 .

# Lint
flake8 .

# Sécurité
safety check

🔧 Développement

Structure du projet

DroitFrancaisMCP/
├── droit_francais_MCP.py      # Serveur MCP principal
├── api_legifrance.py           # Client Légifrance
├── api_judilibre.py            # Client JudiLibre
├── requirements.txt            # Dépendances (3 seulement !)
└── .env                        # Configuration (à créer)

Outils disponibles (5)

  1. rechercher_droit_francais() - Recherche Légifrance
  2. obtenir_article() - Article complet
  3. rechercher_jurisprudence_judilibre() - Recherche jurisprudence
  4. obtenir_decision_judilibre() - Décision complète
  5. obtenir_taxonomie_judilibre() - Taxonomies

🐛 Dépannage

Erreur d'import

# Vérifier l'environnement virtuel
which python3  # Doit pointer vers .venv/

# Réinstaller
pip install -r requirements.txt

Erreur d'authentification

# Vérifier .env
cat .env | grep PISTE

# Tester les identifiants sur piste.gouv.fr

Tests qui échouent

# Vérifier les logs
cat droit_francais_mcp.log

# Mode sandbox pour tester sans vrais appels
# Modifier dans le code : sandbox=True

📖 Documentation complète

🆘 Besoin d'aide ?

  1. Consultez la documentation PISTE

Bonne utilisation ! 🎉

Version 1.1.0 - Jean-Michel Tanguy