restricted-github-mcp 1.0.0 → 1.0.1

package/README.md

@@ -1,105 +1,48 @@
-# GitHub MCP Server (Controlled)
+# Restricted GitHub MCP Server
 
-Ce serveur implémente le **Model Context Protocol (MCP)** pour permettre à des agents IA (comme Cursor, Claude Desktop, etc.) d'interagir avec GitHub de manière sécurisée et contrôlée.
+Un serveur MCP (Model Context Protocol) spécialisé pour automatiser le workflow Git local vers GitHub. Ce serveur est conçu pour être minimaliste et sécurisé, en limitant les actions possibles à un flux de travail spécifique.
 
-## 🚀 Fonctionnalités
+## 🚀 Fonctionnalités Automatisées
 
-Le serveur expose plusieurs outils (tools) pour manipuler les dépôts GitHub :
+Contrairement aux serveurs GitHub classiques, celui-ci ne propose que deux outils hautement automatisés :
 
-- **`get_file_contents`** : Lire le contenu d'un fichier.
-- **`git_push`** : Créer ou mettre à jour un fichier (Push).
-- **`pull_request_create`** : Créer une Pull Request.
-- **`list_issues`** : Lister les issues et PRs d'un dépôt.
-- **`create_issue_comment`** : Ajouter un commentaire sur une issue ou PR.
+- **`push`** :
+    1. Exécute `git add .` (ajoute tous les fichiers modifiés et nouveaux).
+    2. Crée un commit avec le message fourni.
+    3. Pousse automatiquement vers la branche cible définie dans la configuration.
+- **`pull_request`** :
+    1. Crée une Pull Request sur GitHub.
+    2. Utilise automatiquement la branche de destination (`TARGET_BRANCH`) et la branche de base (`BASE_BRANCH`) configurées.
 
-## 🔒 Sécurité et Contrôle
+## 🛠️ Installation & Utilisation via npx
 
-Le serveur est conçu avec un principe de contrôle strict via des variables d'environnement :
+Une fois publié, ce serveur peut être utilisé sans installation globale :
 
-- **`ALLOWED_REPOS`** : Liste des dépôts (`propriétaire/nom`) que l'agent est autorisé à manipuler.
-- **`ALLOWED_BRANCHES`** : Masques de branches autorisés pour les pushs (ex: `feature/*`, `mcp-*`).
-- **`READ_ONLY`** : Si mis à `true`, toutes les actions d'écriture (push, PR, commentaires) sont désactivées.
-
-## 🛠️ Installation
-
-1.  **Cloner le projet** (ou copier les fichiers).
-2.  **Installer les dépendances** :
-    ```bash
-    npm install
-    ```
-3.  **Configurer l'environnement** :
-    Créez un fichier `.env` à la racine (voir section Configuration ci-dessous).
-
-## ⚙️ Configuration
-
-Créez un fichier `.env` avec les variables suivantes :
-
-```env
-# Votre Token d'accès personnel GitHub (PAT)
-GITHUB_TOKEN=ghp_xxxxxxxxxxxx
-
-# Dépôts autorisés (séparés par des virgules)
-ALLOWED_REPOS=votre-org/votre-repo,un-autre/depot
-
-# Branches autorisées pour le push (supporte *)
-ALLOWED_BRANCHES=main,develop,mcp-*
-
-# Mode lecture seule (true/false)
-READ_ONLY=false
-```
-
-## 🖥️ Utilisation
-
-### Mode Développement
-Pour lancer le serveur directement avec `ts-node` :
 ```bash
-npm start
+npx restricted-github-mcp
 ```
 
-### Build et Production
-Pour compiler en JavaScript :
-```bash
-npm run build
-node dist/index.js
-```
+## ⚙️ Configuration
 
-### Intégration dans Cursor
-Pour utiliser ce serveur dans Cursor :
-1. Allez dans les paramètres de Cursor (Cursor Settings) > MCP.
-2. Ajoutez un nouveau serveur MCP :
-   - **Name** : GitHub Controlled
-   - **Type** : `command`
-   - **Command** : `node "C:/chemin/vers/githubmcp/node_modules/ts-node/dist/bin.js" "C:/chemin/vers/githubmcp/src/index.ts"`
-   - **Environment Variables** : (Vous pouvez aussi les définir ici au lieu du fichier .env)
+Le serveur se configure exclusivement via des variables d'environnement. Ces variables doivent être définies dans votre client MCP (Cursor, Claude Desktop) ou dans un fichier `.env`.
 
-### Intégration dans Claude Desktop
-Ajoutez la configuration suivante dans votre fichier `claude_desktop_config.json` :
+| Variable | Description | Exemple |
+| :--- | :--- | :--- |
+| `GITHUB_TOKEN` | Votre Personal Access Token GitHub (PAT) | `github_pat_...` |
+| `TARGET_REPO` | Le dépôt cible au format `propriétaire/nom` | `MonPseudo/mon-expose` |
+| `TARGET_BRANCH` | La branche sur laquelle le code doit être poussé | `feature/test` |
+| `BASE_BRANCH` | (Optionnel) La branche de destination pour la PR | `main` (défaut) |
+| `READ_ONLY` | (Optionnel) Désactive les actions d'écriture | `false` (défaut) |
 
-```json
-{
-  "mcpServers": {
-    "github-controlled": {
-      "command": "node",
-      "args": [
-        "C:/chemin/vers/githubmcp/node_modules/ts-node/dist/bin.js",
-        "C:/chemin/vers/githubmcp/src/index.ts"
-      ],
-      "env": {
-        "GITHUB_TOKEN": "votre_token",
-        "ALLOWED_REPOS": "org/repo",
-        "ALLOWED_BRANCHES": "mcp-*",
-        "READ_ONLY": "false"
-      }
-    }
-  }
-}
-```
+## 📦 Publication Automatisée
 
-## 🧪 Debugging
-Vous pouvez utiliser l'inspecteur MCP pour tester le serveur localement :
-```bash
-npx @modelcontextprotocol/inspector node dist/index.js
-```
+Ce projet est configuré pour être publié sur npm via **GitHub Actions** à chaque nouvelle "Release" sur le dépôt GitHub.
+
+1. Modifiez la version dans `package.json`.
+2. Poussez votre code sur GitHub.
+3. Créez une nouvelle "Release" sur GitHub.
+4. Le workflow OIDC (Trusted Publishing) s'occupera de la publication sur npm sans jeton statique.
 
 ## 📄 Licence
+
 ISC

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "restricted-github-mcp",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "main": "index.js",
   "type": "module",
   "files": [
@@ -29,7 +29,7 @@
   },
   "devDependencies": {
     "@modelcontextprotocol/inspector": "^0.19.0",
-    "@types/node": "^25.0.10", 
+    "@types/node": "^25.0.10",
     "tsx": "^4.21.0",
     "typescript": "^5.9.3"
   }