@imenam/mcp-github 1.1.51 → 1.1.53
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/README.md +191 -168
- package/dist/config-server.d.ts.map +1 -1
- package/dist/config-server.js +87 -45
- package/dist/config-server.js.map +1 -1
- package/dist/utils/config.d.ts.map +1 -1
- package/dist/utils/config.js +10 -3
- package/dist/utils/config.js.map +1 -1
- package/dist/utils/env-precedence.d.ts +40 -0
- package/dist/utils/env-precedence.d.ts.map +1 -0
- package/dist/utils/env-precedence.js +52 -0
- package/dist/utils/env-precedence.js.map +1 -0
- package/package.json +2 -1
- package/public/index.html +2085 -980
package/README.md
CHANGED
|
@@ -1,168 +1,191 @@
|
|
|
1
|
-
# Restricted GitHub MCP Server
|
|
2
|
-
|
|
3
|
-
Un serveur MCP (Model Context Protocol) spécialisé pour automatiser le workflow Git local vers GitHub, avec délégation des compilations/tests soit à un serveur distant via SSH, soit directement en local sur la même machine. Conçu pour être minimaliste et sécurisé.
|
|
4
|
-
|
|
5
|
-
## 🚀 Outils disponibles
|
|
6
|
-
|
|
7
|
-
### Git local → GitHub
|
|
8
|
-
|
|
9
|
-
- **`commit`** : Exécute `git add .` puis crée un commit avec le message fourni. *Ne pousse pas vers le remote.*
|
|
10
|
-
- **`push`** : Pousse la branche actuelle vers `TARGET_BRANCH`. *Ne fait pas de commit.*
|
|
11
|
-
- **`commit_and_push`** : Enchaîne `git add .`, commit et push vers `TARGET_BRANCH`.
|
|
12
|
-
- **`pull_request`** : Crée une Pull Request GitHub de `TARGET_BRANCH` vers `BASE_BRANCH`.
|
|
13
|
-
- **`clone`** : Clone `TARGET_REPO` dans `CLONE_DIR/<TARGET_BRANCH>/`. Crée la branche distante si elle n'existe pas encore.
|
|
14
|
-
- **`get_info`** : Affiche la configuration active (dépôt, branches, chemins) sans exposer les secrets.
|
|
15
|
-
- **`get_logs`** : Récupère les dernières lignes du fichier de log serveur. Argument optionnel : `lines` (défaut : 50).
|
|
16
|
-
|
|
17
|
-
### Déploiement & test (serveur distant ou local)
|
|
18
|
-
|
|
19
|
-
Selon la configuration active, ces outils s'exécutent soit sur un serveur distant via SSH, soit directement en local sur la machine du serveur MCP (interrupteur `LOCAL_DEPLOY`).
|
|
20
|
-
|
|
21
|
-
- **`deploy`** : Exécute `git fetch --all`, `git checkout TARGET_BRANCH`, `git pull` dans `SSH_REMOTE_PATH`. Le repo doit être préalablement cloné à cet emplacement (sur le serveur distant, ou en local).
|
|
22
|
-
- **`test`** : Exécute `TEST_COMMAND` (cwd = `SSH_REMOTE_PATH`) et renvoie stdout, stderr et exit code. Stocke la sortie pour `test_logs`.
|
|
23
|
-
- **`test_logs`** : Renvoie la sortie du dernier `test` exécuté sans relancer la commande.
|
|
24
|
-
|
|
25
|
-
> **Mode local (`LOCAL_DEPLOY`)** : quand il est activé, aucune connexion SSH n'est ouverte — la commande est lancée directement dans le shell de la machine, dans le dossier `SSH_REMOTE_PATH` (interprété comme un chemin local). Pratique lorsque le serveur MCP tourne sur le serveur de déploiement lui-même.
|
|
26
|
-
|
|
27
|
-
### Flux typique agent
|
|
28
|
-
|
|
29
|
-
```
|
|
30
|
-
clone → (modifier des fichiers) → commit_and_push → deploy → test
|
|
31
|
-
↑ |
|
|
32
|
-
└─── (corriger) ────────┘ (si exit code ≠ 0)
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
## 🖥️ Interface de Configuration (GUI)
|
|
36
|
-
|
|
37
|
-
Le serveur lance automatiquement une interface graphique au démarrage (si `PROXY_URL` est défini). Elle permet de :
|
|
38
|
-
|
|
39
|
-
- Gérer plusieurs configurations nommées (multi-projets).
|
|
40
|
-
- Sélectionner le dépôt et les branches via des menus déroulants GitHub.
|
|
41
|
-
- Configurer le déploiement **par projet** : serveur SSH (hôte, utilisateur, port, clé privée) et commande de test, ou bascule en **déploiement local** sans SSH.
|
|
42
|
-
- Visualiser la configuration active en temps réel.
|
|
43
|
-
|
|
44
|
-
Le formulaire est organisé en sections repliables : **Dépôt & branches** (toujours dépliée, cœur de l'usage), **Options** et **Déploiement & test** (repliées par défaut, le paramétrage serveur n'étant fait qu'une fois). Activer l'interrupteur **Déployer en local** masque automatiquement les champs de connexion SSH devenus inutiles.
|
|
45
|
-
|
|
46
|
-
> **Proxy dynamique** : La GUI s'enregistre auprès du reverse proxy défini dans `PROXY_URL` et reçoit un port dynamique. Elle est alors accessible
|
|
47
|
-
|
|
48
|
-
## ⚙️ Configuration
|
|
49
|
-
|
|
50
|
-
Les variables **globales** (token, dossiers, proxy) sont définies dans un fichier `.env` ou dans la section `env` du client MCP. Les **paramètres par projet** (dépôt, branches, déploiement SSH ou local…) sont gérés dans l'interface GUI et stockés dans `configs.json`.
|
|
51
|
-
|
|
52
|
-
### Variables GitHub
|
|
53
|
-
|
|
54
|
-
| Variable | Description | Exemple |
|
|
55
|
-
| :--- | :--- | :--- |
|
|
56
|
-
| `GITHUB_TOKEN` | Personal Access Token GitHub (PAT) | `github_pat_...` |
|
|
57
|
-
| `MCP_DATA_DIR` | Dossier contenant `configs.json` (multi-configs) | `./data` |
|
|
58
|
-
| `CLONE_DIR` | Dossier racine dans lequel les branches seront clonées | `./cloned_repos` |
|
|
59
|
-
|
|
60
|
-
> Les configurations par projet (dépôt, branches, mode lecture seule…) sont gérées dans l'interface GUI et stockées dans `configs.json`.
|
|
61
|
-
|
|
62
|
-
### Paramètres de déploiement (outils `deploy` / `test`)
|
|
63
|
-
|
|
64
|
-
Ces paramètres sont définis **par projet** dans l'interface GUI et stockés dans `configs.json` (et non dans le `.env` global). Chaque configuration peut donc viser un serveur — et une clé — différents, ou basculer en mode local.
|
|
65
|
-
|
|
66
|
-
| Paramètre | Description | Exemple |
|
|
67
|
-
| :--- | :--- | :--- |
|
|
68
|
-
| `LOCAL_DEPLOY` | Si activé, exécution locale sans SSH (la machine du serveur MCP) | `false` |
|
|
69
|
-
| `SSH_HOST` | Adresse IP ou hostname du serveur distant | `mon-serveur.example.com` |
|
|
70
|
-
| `SSH_USER` | Utilisateur SSH | `deploy` |
|
|
71
|
-
| `SSH_PORT` | Port SSH (défaut : 22) | `22` |
|
|
72
|
-
| `SSH_KEY_PATH` | Chemin absolu vers la clé privée SSH | `C:/Users/.../.ssh/id_ed25519` |
|
|
73
|
-
| `SSH_REMOTE_PATH` | Chemin du repo (distant en mode SSH, **local** si `LOCAL_DEPLOY`) | `/var/www/mon-projet` |
|
|
74
|
-
| `TEST_COMMAND` | Commande de test à exécuter | `npx tsc --noEmit --pretty` |
|
|
75
|
-
|
|
76
|
-
> En mode local, seuls `SSH_REMOTE_PATH` (qui doit exister sur le disque) et `TEST_COMMAND` sont utilisés ; les champs de connexion SSH sont ignorés.
|
|
77
|
-
|
|
78
|
-
> **Note** : Pour `tsc`, utilisez `--pretty` pour obtenir la sortie complète avec contexte de code (sans cette option, `tsc` passe en format compact une ligne par erreur quand il n'y a pas de TTY).
|
|
79
|
-
|
|
80
|
-
> **Migration** : ces clés peuvent aussi être fournies via le `.env` ou la section `env` du client MCP. Elles ne sont alors lues **qu'une seule fois** au premier démarrage (si `configs.json` n'existe pas encore) pour amorcer la configuration par défaut ; ensuite, c'est la GUI qui fait foi.
|
|
81
|
-
|
|
82
|
-
### Variables GUI / Proxy
|
|
83
|
-
|
|
84
|
-
| Variable | Description | Exemple |
|
|
85
|
-
| :--- | :--- | :--- |
|
|
86
|
-
| `PROXY_URL` | URL du reverse proxy central | `http://localhost:3000` |
|
|
87
|
-
| `
|
|
88
|
-
| `
|
|
89
|
-
| `
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
"
|
|
140
|
-
"
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
```
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
1
|
+
# Restricted GitHub MCP Server
|
|
2
|
+
|
|
3
|
+
Un serveur MCP (Model Context Protocol) spécialisé pour automatiser le workflow Git local vers GitHub, avec délégation des compilations/tests soit à un serveur distant via SSH, soit directement en local sur la même machine. Conçu pour être minimaliste et sécurisé.
|
|
4
|
+
|
|
5
|
+
## 🚀 Outils disponibles
|
|
6
|
+
|
|
7
|
+
### Git local → GitHub
|
|
8
|
+
|
|
9
|
+
- **`commit`** : Exécute `git add .` puis crée un commit avec le message fourni. *Ne pousse pas vers le remote.*
|
|
10
|
+
- **`push`** : Pousse la branche actuelle vers `TARGET_BRANCH`. *Ne fait pas de commit.*
|
|
11
|
+
- **`commit_and_push`** : Enchaîne `git add .`, commit et push vers `TARGET_BRANCH`.
|
|
12
|
+
- **`pull_request`** : Crée une Pull Request GitHub de `TARGET_BRANCH` vers `BASE_BRANCH`.
|
|
13
|
+
- **`clone`** : Clone `TARGET_REPO` dans `CLONE_DIR/<TARGET_BRANCH>/`. Crée la branche distante si elle n'existe pas encore.
|
|
14
|
+
- **`get_info`** : Affiche la configuration active (dépôt, branches, chemins) sans exposer les secrets.
|
|
15
|
+
- **`get_logs`** : Récupère les dernières lignes du fichier de log serveur. Argument optionnel : `lines` (défaut : 50).
|
|
16
|
+
|
|
17
|
+
### Déploiement & test (serveur distant ou local)
|
|
18
|
+
|
|
19
|
+
Selon la configuration active, ces outils s'exécutent soit sur un serveur distant via SSH, soit directement en local sur la machine du serveur MCP (interrupteur `LOCAL_DEPLOY`).
|
|
20
|
+
|
|
21
|
+
- **`deploy`** : Exécute `git fetch --all`, `git checkout TARGET_BRANCH`, `git pull` dans `SSH_REMOTE_PATH`. Le repo doit être préalablement cloné à cet emplacement (sur le serveur distant, ou en local).
|
|
22
|
+
- **`test`** : Exécute `TEST_COMMAND` (cwd = `SSH_REMOTE_PATH`) et renvoie stdout, stderr et exit code. Stocke la sortie pour `test_logs`.
|
|
23
|
+
- **`test_logs`** : Renvoie la sortie du dernier `test` exécuté sans relancer la commande.
|
|
24
|
+
|
|
25
|
+
> **Mode local (`LOCAL_DEPLOY`)** : quand il est activé, aucune connexion SSH n'est ouverte — la commande est lancée directement dans le shell de la machine, dans le dossier `SSH_REMOTE_PATH` (interprété comme un chemin local). Pratique lorsque le serveur MCP tourne sur le serveur de déploiement lui-même.
|
|
26
|
+
|
|
27
|
+
### Flux typique agent
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
clone → (modifier des fichiers) → commit_and_push → deploy → test
|
|
31
|
+
↑ |
|
|
32
|
+
└─── (corriger) ────────┘ (si exit code ≠ 0)
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## 🖥️ Interface de Configuration (GUI)
|
|
36
|
+
|
|
37
|
+
Le serveur lance automatiquement une interface graphique au démarrage (si `PROXY_URL` est défini). Elle permet de :
|
|
38
|
+
|
|
39
|
+
- Gérer plusieurs configurations nommées (multi-projets).
|
|
40
|
+
- Sélectionner le dépôt et les branches via des menus déroulants GitHub.
|
|
41
|
+
- Configurer le déploiement **par projet** : serveur SSH (hôte, utilisateur, port, clé privée) et commande de test, ou bascule en **déploiement local** sans SSH.
|
|
42
|
+
- Visualiser la configuration active en temps réel.
|
|
43
|
+
|
|
44
|
+
Le formulaire est organisé en sections repliables : **Dépôt & branches** (toujours dépliée, cœur de l'usage), **Options** et **Déploiement & test** (repliées par défaut, le paramétrage serveur n'étant fait qu'une fois). Activer l'interrupteur **Déployer en local** masque automatiquement les champs de connexion SSH devenus inutiles.
|
|
45
|
+
|
|
46
|
+
> **Proxy dynamique** : La GUI s'enregistre auprès du reverse proxy défini dans `PROXY_URL` et reçoit un port dynamique. Elle est alors accessible sous le chemin effectivement enregistré — `GUI_PATH` seul par défaut, éventuellement préfixé par `APP_PATH_PREFIX` (voir *Variables GUI / Proxy*). L'enregistrement passe par le client partagé [`@imenam/mcp-gui-interface`](https://www.npmjs.com/package/@imenam/mcp-gui-interface), commun à tous les MCP à interface ; le timeout d'enregistrement est de **1 s** (il était de 5 s avec l'ancien client interne).
|
|
47
|
+
|
|
48
|
+
## ⚙️ Configuration
|
|
49
|
+
|
|
50
|
+
Les variables **globales** (token, dossiers, proxy) sont définies dans un fichier `.env` ou dans la section `env` du client MCP. Les **paramètres par projet** (dépôt, branches, déploiement SSH ou local…) sont gérés dans l'interface GUI et stockés dans `configs.json`.
|
|
51
|
+
|
|
52
|
+
### Variables GitHub
|
|
53
|
+
|
|
54
|
+
| Variable | Description | Exemple |
|
|
55
|
+
| :--- | :--- | :--- |
|
|
56
|
+
| `GITHUB_TOKEN` | Personal Access Token GitHub (PAT) | `github_pat_...` |
|
|
57
|
+
| `MCP_DATA_DIR` | Dossier contenant `configs.json` (multi-configs) | `./data` |
|
|
58
|
+
| `CLONE_DIR` | Dossier racine dans lequel les branches seront clonées | `./cloned_repos` |
|
|
59
|
+
|
|
60
|
+
> Les configurations par projet (dépôt, branches, mode lecture seule…) sont gérées dans l'interface GUI et stockées dans `configs.json`.
|
|
61
|
+
|
|
62
|
+
### Paramètres de déploiement (outils `deploy` / `test`)
|
|
63
|
+
|
|
64
|
+
Ces paramètres sont définis **par projet** dans l'interface GUI et stockés dans `configs.json` (et non dans le `.env` global). Chaque configuration peut donc viser un serveur — et une clé — différents, ou basculer en mode local.
|
|
65
|
+
|
|
66
|
+
| Paramètre | Description | Exemple |
|
|
67
|
+
| :--- | :--- | :--- |
|
|
68
|
+
| `LOCAL_DEPLOY` | Si activé, exécution locale sans SSH (la machine du serveur MCP) | `false` |
|
|
69
|
+
| `SSH_HOST` | Adresse IP ou hostname du serveur distant | `mon-serveur.example.com` |
|
|
70
|
+
| `SSH_USER` | Utilisateur SSH | `deploy` |
|
|
71
|
+
| `SSH_PORT` | Port SSH (défaut : 22) | `22` |
|
|
72
|
+
| `SSH_KEY_PATH` | Chemin absolu vers la clé privée SSH | `C:/Users/.../.ssh/id_ed25519` |
|
|
73
|
+
| `SSH_REMOTE_PATH` | Chemin du repo (distant en mode SSH, **local** si `LOCAL_DEPLOY`) | `/var/www/mon-projet` |
|
|
74
|
+
| `TEST_COMMAND` | Commande de test à exécuter | `npx tsc --noEmit --pretty` |
|
|
75
|
+
|
|
76
|
+
> En mode local, seuls `SSH_REMOTE_PATH` (qui doit exister sur le disque) et `TEST_COMMAND` sont utilisés ; les champs de connexion SSH sont ignorés.
|
|
77
|
+
|
|
78
|
+
> **Note** : Pour `tsc`, utilisez `--pretty` pour obtenir la sortie complète avec contexte de code (sans cette option, `tsc` passe en format compact une ligne par erreur quand il n'y a pas de TTY).
|
|
79
|
+
|
|
80
|
+
> **Migration** : ces clés peuvent aussi être fournies via le `.env` ou la section `env` du client MCP. Elles ne sont alors lues **qu'une seule fois** au premier démarrage (si `configs.json` n'existe pas encore) pour amorcer la configuration par défaut ; ensuite, c'est la GUI qui fait foi.
|
|
81
|
+
|
|
82
|
+
### Variables GUI / Proxy
|
|
83
|
+
|
|
84
|
+
| Variable | Description | Exemple |
|
|
85
|
+
| :--- | :--- | :--- |
|
|
86
|
+
| `PROXY_URL` | URL du reverse proxy central | `http://localhost:3000` |
|
|
87
|
+
| `APP_PATH` | Chemin d'accès via le proxy. Nom canonique, commun à tous les MCP. | `/github-mcp` |
|
|
88
|
+
| `APP_NAME` | Nom affiché dans le proxy. Nom canonique. | `GitHub MCP Config` |
|
|
89
|
+
| `GUI_PATH` | Ancien nom de `APP_PATH`, toujours accepté (utilisé si `APP_PATH` et `PROXY_APP_PATH` sont absents) | `/github-mcp` (défaut) |
|
|
90
|
+
| `GUI_NAME` | Ancien nom de `APP_NAME`, toujours accepté (même ordre de priorité) | `GitHub MCP Config` (défaut) |
|
|
91
|
+
| `APP_PATH_PREFIX` | Préfixe de namespace ajouté au chemin **par défaut** uniquement | `/abc123` → `/abc123/github-mcp` |
|
|
92
|
+
| `AGENT_NAME` | Nom de l'agent affiché dans la GUI | `Agent Zero` |
|
|
93
|
+
| `APP_GROUP` | Section repliable (repliée par défaut) du dashboard proxy dans laquelle placer l'app. Les apps partageant la même valeur sont regroupées ; si non défini, l'app apparaît dans la section « non groupées ». | `Développement` |
|
|
94
|
+
|
|
95
|
+
`APP_PATH` / `APP_NAME` sont les noms canoniques de l'écosystème ; `PROXY_APP_*` puis `GUI_*` restent acceptés, dans cet ordre de priorité décroissante. `APP_PATH_PREFIX` **ne préfixe que le chemin par défaut** : si `APP_PATH` (ou `GUI_PATH`) est renseigné, sa valeur est prise telle quelle, sans préfixe — la saisie manuelle l'emporte. Les chemins sont normalisés (un seul `/` de séparation, pas de `/` final).
|
|
96
|
+
|
|
97
|
+
### L'environnement du process l'emporte sur le `.env`
|
|
98
|
+
|
|
99
|
+
Une variable déjà présente dans l'environnement du process qui lance ce MCP
|
|
100
|
+
(`export` dans un shell, bloc `env` d'une configuration MCP, ou superviseur comme
|
|
101
|
+
`@imenam/mcp-gateway-manager`) **l'emporte sur la même clé du `.env` de ce
|
|
102
|
+
dépôt**. C'est le comportement par défaut de dotenv, et la convention Unix
|
|
103
|
+
habituelle : l'appelant gagne.
|
|
104
|
+
|
|
105
|
+
Le `.env` reste rechargé à chaud — la GUI de configuration l'édite et la valeur
|
|
106
|
+
est reprise sans redémarrer le serveur — mais ce rechargement ne peut plus
|
|
107
|
+
écraser ce que l'appelant a injecté. Concrètement, une ligne
|
|
108
|
+
`APP_GROUP=Développement` dans ce `.env` ne remplace plus un `APP_GROUP` fourni
|
|
109
|
+
par un superviseur : elle ne s'applique que si personne n'en a fourni.
|
|
110
|
+
|
|
111
|
+
Pour changer une variable que l'appelant fournit, changez-la chez l'appelant :
|
|
112
|
+
l'éditer depuis la GUI n'aura aucun effet sur cette clé.
|
|
113
|
+
|
|
114
|
+
## 📝 Journalisation (Logs)
|
|
115
|
+
|
|
116
|
+
- **Windows** : `C:\var\log\restricted-github-mcp\server.log`
|
|
117
|
+
- **Linux/macOS** : `/var/log/restricted-github-mcp/server.log`
|
|
118
|
+
|
|
119
|
+
Le dossier est créé automatiquement. Les logs du processus principal (`[MASTER]`) et de la GUI (`[GUI]`) sont centralisés dans le même fichier.
|
|
120
|
+
|
|
121
|
+
## 🖥️ Exemple de Configuration MCP
|
|
122
|
+
|
|
123
|
+
### Via npx (Recommandé)
|
|
124
|
+
|
|
125
|
+
```json
|
|
126
|
+
{
|
|
127
|
+
"mcpServers": {
|
|
128
|
+
"@imenam/mcp-github": {
|
|
129
|
+
"command": "npx",
|
|
130
|
+
"args": ["-y", "@imenam/mcp-github"],
|
|
131
|
+
"env": {
|
|
132
|
+
"GITHUB_TOKEN": "votre_token_github_ici",
|
|
133
|
+
"CLONE_DIR": "/chemin/vers/dossier-de-clonage",
|
|
134
|
+
"MCP_DATA_DIR": "./data",
|
|
135
|
+
"PROXY_URL": "http://localhost:3000",
|
|
136
|
+
"GUI_PATH": "/github-mcp",
|
|
137
|
+
"GUI_NAME": "GitHub MCP Config",
|
|
138
|
+
"AGENT_NAME": "Mon Agent",
|
|
139
|
+
"SSH_HOST": "mon-serveur.example.com",
|
|
140
|
+
"SSH_USER": "ubuntu",
|
|
141
|
+
"SSH_PORT": "22",
|
|
142
|
+
"SSH_KEY_PATH": "/chemin/vers/.ssh/id_ed25519",
|
|
143
|
+
"SSH_REMOTE_PATH": "/var/www/mon-projet",
|
|
144
|
+
"TEST_COMMAND": "npx tsc --noEmit --pretty"
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
> Les variables `PROXY_URL`, `GUI_*` et `AGENT_NAME` sont optionnelles selon votre usage. Les variables SSH (`SSH_HOST`, `SSH_USER`, `SSH_PORT`, `SSH_KEY_PATH`, `SSH_REMOTE_PATH`, `TEST_COMMAND`) ainsi que `LOCAL_DEPLOY` sont désormais gérées **par projet via la GUI** ; les inclure ici ne sert qu'à amorcer la configuration par défaut au premier démarrage (voir la note Migration ci-dessus).
|
|
152
|
+
|
|
153
|
+
### Via installation locale
|
|
154
|
+
|
|
155
|
+
```json
|
|
156
|
+
{
|
|
157
|
+
"mcpServers": {
|
|
158
|
+
"@imenam/mcp-github": {
|
|
159
|
+
"command": "node",
|
|
160
|
+
"args": ["C:/chemin/vers/gitHubMCP/dist/index.js"],
|
|
161
|
+
"env": {
|
|
162
|
+
"GITHUB_TOKEN": "votre_token_github_ici",
|
|
163
|
+
"CLONE_DIR": "./cloned_repos"
|
|
164
|
+
}
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
}
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
## 🛠️ Installation locale & build
|
|
171
|
+
|
|
172
|
+
```bash
|
|
173
|
+
git clone https://github.com/votre-pseudo/gitHubMCP.git
|
|
174
|
+
cd gitHubMCP
|
|
175
|
+
npm install
|
|
176
|
+
cp .env.example .env
|
|
177
|
+
# Éditez .env avec vos valeurs
|
|
178
|
+
npm run build
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
## 📦 Publication Automatisée
|
|
182
|
+
|
|
183
|
+
Ce projet est configuré pour être publié sur npm via **GitHub Actions** à chaque nouvelle Release :
|
|
184
|
+
|
|
185
|
+
1. Mettez à jour la version dans `package.json`.
|
|
186
|
+
2. Poussez sur GitHub et créez une Release.
|
|
187
|
+
3. Le workflow OIDC publie automatiquement sur npm.
|
|
188
|
+
|
|
189
|
+
## 📄 Licence
|
|
190
|
+
|
|
191
|
+
ISC
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config-server.d.ts","sourceRoot":"","sources":["../src/config-server.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"config-server.d.ts","sourceRoot":"","sources":["../src/config-server.ts"],"names":[],"mappings":"AAwEA;;GAEG;AACH,wBAAsB,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC,CAIzD;AAED,wBAAsB,iBAAiB,kBAwftC"}
|
package/dist/config-server.js
CHANGED
|
@@ -3,6 +3,8 @@ import path from "path";
|
|
|
3
3
|
import fs from "fs";
|
|
4
4
|
import { fileURLToPath } from "url";
|
|
5
5
|
import { Octokit } from "octokit";
|
|
6
|
+
import { NodeSSH } from "node-ssh";
|
|
7
|
+
import { ProxyClient } from "@imenam/mcp-gui-interface";
|
|
6
8
|
import { logToFile } from "./logger.js";
|
|
7
9
|
import { getConfig, updateEnvFile, safeSend, migrateFromLegacyEnv, getAllConfigNames, getConfigByName, saveConfiguration, deleteConfiguration, setCurrentConfiguration, getCurrentConfigName, } from "./utils/config.js";
|
|
8
10
|
const __filename = fileURLToPath(import.meta.url);
|
|
@@ -11,7 +13,15 @@ if (!getConfig().PROXY_URL) {
|
|
|
11
13
|
process.stderr.write('[GUI] PROXY_URL non défini — arrêt.\n');
|
|
12
14
|
process.exit(0);
|
|
13
15
|
}
|
|
14
|
-
|
|
16
|
+
/**
|
|
17
|
+
* Client proxy partagé (`@imenam/mcp-gui-interface`). Il remplace le client
|
|
18
|
+
* dupliqué qui vivait ici : il porte la résolution unifiée des variables
|
|
19
|
+
* (`GUI_PATH` reste accepté, `APP_PATH` a la priorité) et le préfixe
|
|
20
|
+
* `APP_PATH_PREFIX`, et gère le désenregistrement sur le chemin réellement
|
|
21
|
+
* enregistré.
|
|
22
|
+
*/
|
|
23
|
+
let proxyClient = null;
|
|
24
|
+
/** Chemin réellement enregistré (préfixe compris), pour l'affichage. */
|
|
15
25
|
let registeredPath = null;
|
|
16
26
|
/**
|
|
17
27
|
* Tente de s'enregistrer auprès du proxy dynamique.
|
|
@@ -23,53 +33,28 @@ async function tryProxyRegistration() {
|
|
|
23
33
|
logToFile("[GUI] PROXY_URL non défini, utilisation du port par défaut");
|
|
24
34
|
return null;
|
|
25
35
|
}
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
method: "POST",
|
|
34
|
-
headers: { "Content-Type": "application/json" },
|
|
35
|
-
body: JSON.stringify({ path: GUI_PATH, name: GUI_NAME, group }),
|
|
36
|
-
signal: controller.signal,
|
|
37
|
-
});
|
|
38
|
-
clearTimeout(timeoutId);
|
|
39
|
-
if (!response.ok) {
|
|
40
|
-
const errorData = await response.json().catch(() => ({}));
|
|
41
|
-
logToFile(`[GUI] Échec enregistrement proxy: ${errorData.error || response.statusText}`);
|
|
42
|
-
return null;
|
|
43
|
-
}
|
|
44
|
-
const data = await response.json();
|
|
45
|
-
registeredPath = GUI_PATH;
|
|
46
|
-
logToFile(`[GUI] Enregistré auprès du proxy (path: ${GUI_PATH}, port: ${data.port})`);
|
|
47
|
-
return data.port;
|
|
48
|
-
}
|
|
49
|
-
catch (error) {
|
|
50
|
-
const reason = error.name === "AbortError" ? "timeout" : error.message;
|
|
51
|
-
logToFile(`[GUI] Échec enregistrement proxy: ${reason}`);
|
|
36
|
+
// GUI_PATH / GUI_NAME sont le chemin et le nom « naturels » de ce MCP :
|
|
37
|
+
// register() leur applique APP_PATH/APP_NAME puis APP_PATH_PREFIX.
|
|
38
|
+
// APP_GROUP (facultatif) est lu par le client partagé.
|
|
39
|
+
const client = new ProxyClient(PROXY_URL);
|
|
40
|
+
const result = await client.register({ path: GUI_PATH, name: GUI_NAME });
|
|
41
|
+
if (!result.success) {
|
|
42
|
+
logToFile(`[GUI] Échec enregistrement proxy: ${result.error}`);
|
|
52
43
|
return null;
|
|
53
44
|
}
|
|
45
|
+
proxyClient = client;
|
|
46
|
+
registeredPath = result.path ?? GUI_PATH;
|
|
47
|
+
logToFile(`[GUI] Enregistré auprès du proxy (path: ${registeredPath}, port: ${result.port})`);
|
|
48
|
+
return result.port;
|
|
54
49
|
}
|
|
55
50
|
/**
|
|
56
51
|
* Se désenregistre du proxy dynamique (si enregistré).
|
|
57
52
|
*/
|
|
58
53
|
export async function unregisterFromProxy() {
|
|
59
|
-
|
|
60
|
-
if (!PROXY_URL || !registeredPath)
|
|
54
|
+
if (!proxyClient)
|
|
61
55
|
return;
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
method: "DELETE",
|
|
65
|
-
headers: { "Content-Type": "application/json" },
|
|
66
|
-
body: JSON.stringify({ path: registeredPath }),
|
|
67
|
-
});
|
|
68
|
-
logToFile(`[GUI] Désenregistré du proxy (path: ${registeredPath})`);
|
|
69
|
-
}
|
|
70
|
-
catch {
|
|
71
|
-
// Ignorer les erreurs de désenregistrement
|
|
72
|
-
}
|
|
56
|
+
await proxyClient.unregister();
|
|
57
|
+
logToFile("[GUI] Désenregistré du proxy");
|
|
73
58
|
}
|
|
74
59
|
export async function startConfigServer() {
|
|
75
60
|
logToFile("[GUI] Initializing config server...");
|
|
@@ -196,20 +181,32 @@ export async function startConfigServer() {
|
|
|
196
181
|
const includePublic = config.INCLUDE_PUBLIC;
|
|
197
182
|
const includeNotOwned = config.INCLUDE_NOT_OWNED;
|
|
198
183
|
const search = req.query.search;
|
|
184
|
+
const login = user.data.login;
|
|
185
|
+
// La GUI affiche visibilité, langage et date de mise à jour à côté de
|
|
186
|
+
// chaque dépôt : on renvoie donc un objet plutôt que le seul full_name.
|
|
187
|
+
const toRepoSummary = (repo) => ({
|
|
188
|
+
full_name: repo.full_name,
|
|
189
|
+
private: repo.private,
|
|
190
|
+
language: repo.language ?? null,
|
|
191
|
+
updated_at: repo.updated_at ?? null,
|
|
192
|
+
fork: repo.fork ?? false,
|
|
193
|
+
owned: repo.owner?.login === login,
|
|
194
|
+
});
|
|
199
195
|
let accessibleRepos = [];
|
|
200
196
|
if (search && search.length > 0) {
|
|
201
197
|
// Mode Recherche : Utilise l'API de recherche
|
|
202
|
-
const user = await octokit.rest.users.getAuthenticated();
|
|
203
198
|
// Si on n'inclut pas les "non-owned", on restreint la recherche à l'utilisateur actuel
|
|
204
199
|
const query = includeNotOwned
|
|
205
200
|
? `${search} in:name fork:true`
|
|
206
|
-
: `${search} user:${
|
|
201
|
+
: `${search} user:${login} in:name fork:true`;
|
|
207
202
|
const { data: searchResults } = await octokit.rest.search.repos({
|
|
208
203
|
q: query,
|
|
209
204
|
sort: "updated",
|
|
210
205
|
per_page: 10,
|
|
211
206
|
});
|
|
212
|
-
accessibleRepos = searchResults.items
|
|
207
|
+
accessibleRepos = searchResults.items
|
|
208
|
+
.filter(repo => includePublic || repo.private)
|
|
209
|
+
.map(toRepoSummary);
|
|
213
210
|
logToFile(`[GUI] Search for "${search}" found ${accessibleRepos.length} repos`);
|
|
214
211
|
}
|
|
215
212
|
else {
|
|
@@ -220,7 +217,7 @@ export async function startConfigServer() {
|
|
|
220
217
|
sort: "updated",
|
|
221
218
|
per_page: 10,
|
|
222
219
|
});
|
|
223
|
-
accessibleRepos = data.map(
|
|
220
|
+
accessibleRepos = data.map(toRepoSummary);
|
|
224
221
|
logToFile(`[GUI] Default list found ${accessibleRepos.length} repos`);
|
|
225
222
|
}
|
|
226
223
|
res.json(accessibleRepos);
|
|
@@ -266,6 +263,51 @@ export async function startConfigServer() {
|
|
|
266
263
|
res.status(500).json({ error: msg });
|
|
267
264
|
}
|
|
268
265
|
});
|
|
266
|
+
// Vérifie les identifiants SSH tels qu'ils sont saisis dans la GUI, sans
|
|
267
|
+
// qu'il faille d'abord enregistrer la configuration ni redémarrer le serveur.
|
|
268
|
+
app.post("/api/ssh-test", async (req, res) => {
|
|
269
|
+
logToFile("[GUI] POST /api/ssh-test called");
|
|
270
|
+
const config = getConfig();
|
|
271
|
+
const body = req.body ?? {};
|
|
272
|
+
const host = (body.SSH_HOST || config.SSH_HOST || "").trim();
|
|
273
|
+
const username = (body.SSH_USER || config.SSH_USER || "").trim();
|
|
274
|
+
const keyPath = (body.SSH_KEY_PATH || config.SSH_KEY_PATH || "").trim();
|
|
275
|
+
const remotePath = (body.SSH_REMOTE_PATH || config.SSH_REMOTE_PATH || "").trim();
|
|
276
|
+
const port = Number(body.SSH_PORT || config.SSH_PORT || 22) || 22;
|
|
277
|
+
if (!host)
|
|
278
|
+
return res.status(400).json({ error: "L'hôte SSH est vide" });
|
|
279
|
+
if (!username)
|
|
280
|
+
return res.status(400).json({ error: "L'utilisateur SSH est vide" });
|
|
281
|
+
if (!keyPath)
|
|
282
|
+
return res.status(400).json({ error: "Le chemin de la clé privée est vide" });
|
|
283
|
+
if (!fs.existsSync(keyPath)) {
|
|
284
|
+
return res.status(400).json({ error: `Clé SSH introuvable : ${keyPath}` });
|
|
285
|
+
}
|
|
286
|
+
const ssh = new NodeSSH();
|
|
287
|
+
const startedAt = Date.now();
|
|
288
|
+
try {
|
|
289
|
+
await ssh.connect({ host, username, port, privateKeyPath: keyPath });
|
|
290
|
+
const elapsed = Date.now() - startedAt;
|
|
291
|
+
// Si un chemin de projet est renseigné, on vérifie aussi qu'il existe :
|
|
292
|
+
// c'est la cause d'échec la plus fréquente après la clé.
|
|
293
|
+
let pathNote = "";
|
|
294
|
+
if (remotePath) {
|
|
295
|
+
const probe = await ssh.execCommand(`test -d ${JSON.stringify(remotePath)}`);
|
|
296
|
+
pathNote = probe.code === 0
|
|
297
|
+
? " · chemin du projet accessible"
|
|
298
|
+
: " · attention : chemin du projet introuvable";
|
|
299
|
+
}
|
|
300
|
+
logToFile(`[GUI] SSH test OK for ${username}@${host}:${port} in ${elapsed} ms`);
|
|
301
|
+
res.json({ ok: true, message: `Connexion établie · ${elapsed} ms${pathNote}` });
|
|
302
|
+
}
|
|
303
|
+
catch (error) {
|
|
304
|
+
logToFile(`[GUI] SSH test failed for ${username}@${host}:${port}: ${error.message}`);
|
|
305
|
+
res.status(400).json({ error: error.message || "Connexion SSH impossible" });
|
|
306
|
+
}
|
|
307
|
+
finally {
|
|
308
|
+
ssh.dispose();
|
|
309
|
+
}
|
|
310
|
+
});
|
|
269
311
|
app.post("/api/config", async (req, res) => {
|
|
270
312
|
logToFile("[GUI] POST /api/config called");
|
|
271
313
|
const newConfig = req.body;
|
|
@@ -450,7 +492,7 @@ export async function startConfigServer() {
|
|
|
450
492
|
logToFile(`[GUI] Attempting to listen on port ${port}...`);
|
|
451
493
|
const serverListener = app.listen(port, () => {
|
|
452
494
|
const config = getConfig();
|
|
453
|
-
const msg = `[GUI] Config GUI disponible sur http://localhost:${port} - via proxy (${config.PROXY_URL}${config.GUI_PATH})`;
|
|
495
|
+
const msg = `[GUI] Config GUI disponible sur http://localhost:${port} - via proxy (${config.PROXY_URL}${registeredPath ?? config.GUI_PATH})`;
|
|
454
496
|
console.error(msg);
|
|
455
497
|
logToFile(msg);
|
|
456
498
|
});
|