email-mcp/README.md

178 lines
4.2 KiB
Markdown
Raw Normal View History

2026-04-10 10:40:46 +00:00
# email-mcp
2026-04-13 16:01:28 +00:00
Serveur MCP local pour lire une boîte mail via IMAP. Le serveur parle le protocole MCP standard sur `stdio`, avec des messages **JSON-RPC 2.0** (`initialize`, `notifications/initialized`, `tools/list`, `tools/call`).
2026-04-10 10:40:46 +00:00
2026-04-13 16:01:28 +00:00
Le binaire sappuie maintenant sur [`mcp-framework`](../mcp-framework) pour :
2026-04-10 12:31:38 +00:00
2026-04-13 16:01:28 +00:00
- la gestion de profils CLI
- le stockage JSON de configuration dans `os.UserConfigDir()`
- le stockage du mot de passe dans le wallet natif de lOS
- le manifeste `mcp.toml`
- lauto-update via `email-mcp update`
2026-04-10 12:31:38 +00:00
2026-04-13 16:01:28 +00:00
## Commandes
2026-04-10 12:31:38 +00:00
2026-04-13 16:01:28 +00:00
- `email-mcp config` : configure un profil IMAP
- `email-mcp setup` : alias de compatibilité vers `config`
- `email-mcp mcp` : lance le serveur MCP sur `stdin/stdout`
2026-04-13 20:33:10 +00:00
- `email-mcp doctor` : diagnostique la configuration locale, le wallet, le manifeste et laccès IMAP
2026-04-13 16:01:28 +00:00
- `email-mcp update` : met à jour le binaire courant depuis la dernière release
- `email-mcp version` : affiche la version du binaire
La commande `email-mcp help` (ou `-h` / `--help`) affiche laide globale.
2026-04-10 12:31:38 +00:00
2026-04-13 16:01:28 +00:00
## Outils MCP
2026-04-10 10:40:46 +00:00
2026-04-13 16:01:28 +00:00
- `list_mailboxes` : lister les boîtes IMAP visibles
- `list_messages` : lister les messages récents dune boîte
- `get_message` : récupérer un message par UID IMAP
2026-04-10 12:31:38 +00:00
## Configuration
2026-04-13 16:01:28 +00:00
La configuration est séparée en deux parties :
2026-04-10 12:31:38 +00:00
2026-04-13 16:01:28 +00:00
- `host` et `username` sont stockés dans `config.json`
- `password` est stocké dans le wallet système
Le profil actif est résolu dans cet ordre :
1. `--profile`
2. `EMAIL_MCP_PROFILE`
3. `current_profile` dans `config.json`
4. `default`
Les credentials IMAP sont résolus ensuite via le résolveur multi-sources du framework (RC3) :
1. `host` : `EMAIL_MCP_HOST` puis `config.json`
2. `username` : `EMAIL_MCP_USERNAME` puis `config.json`
3. `password` : `EMAIL_MCP_PASSWORD` puis secret wallet `imap-password/<profile>`
2026-04-13 16:01:28 +00:00
### Configurer un profil
2026-04-10 12:31:38 +00:00
```sh
2026-04-13 16:01:28 +00:00
./email-mcp config
```
Pour un profil nommé :
```sh
./email-mcp config --profile work
2026-04-10 12:31:38 +00:00
```
Le binaire demande ensuite :
2026-04-13 16:01:28 +00:00
1. lhôte IMAP
2. le nom dutilisateur
2026-04-10 12:31:38 +00:00
3. le mot de passe
2026-04-13 16:01:28 +00:00
Si un mot de passe existe déjà dans le wallet, laisser le champ vide le conserve.
2026-04-10 12:31:38 +00:00
2026-04-13 16:01:28 +00:00
### Lancer le serveur MCP
2026-04-10 12:31:38 +00:00
2026-04-13 16:01:28 +00:00
```sh
./email-mcp mcp
```
2026-04-10 12:31:38 +00:00
2026-04-13 16:01:28 +00:00
Pour un profil nommé :
2026-04-10 12:31:38 +00:00
```sh
2026-04-13 16:01:28 +00:00
./email-mcp mcp --profile work
2026-04-10 12:31:38 +00:00
```
2026-04-13 16:01:28 +00:00
Si aucun credential na été configuré pour le profil résolu, le serveur renvoie lerreur :
2026-04-10 12:31:38 +00:00
```text
2026-04-13 16:01:28 +00:00
credentials not configured; run `email-mcp config`
```
## Auto-update
`email-mcp update` lit `mcp.toml` depuis le répertoire du binaire courant, puis remonte les répertoires parents. Si aucun manifeste nest trouvé, la commande échoue.
```sh
./email-mcp update
```
Le manifeste de ce repo pointe vers lendpoint Gitea :
```toml
[update]
source_name = "email-mcp releases"
base_url = "https://gitea.lclr.dev"
latest_release_url = "https://gitea.lclr.dev/api/v1/repos/AI/email-mcp/releases/latest"
2026-04-10 12:31:38 +00:00
```
2026-04-13 20:33:10 +00:00
## Diagnostic
`email-mcp doctor` vérifie :
- la lisibilité du fichier de configuration
- le profil IMAP résolu
- la disponibilité du wallet système
- la présence du mot de passe stocké
- la validité du manifeste `mcp.toml`
- la connectivité IMAP avec les credentials résolus
```sh
./email-mcp doctor
./email-mcp doctor --profile work
```
La commande retourne un code de sortie non nul si au moins un check échoue.
2026-04-10 12:31:38 +00:00
## Installation
### Claude Code CLI
Ajoute le serveur MCP en pointant vers le binaire et la sous-commande `mcp` :
2026-04-10 10:40:46 +00:00
2026-04-10 12:31:38 +00:00
```sh
claude mcp add email-mcp -- /absolute/path/to/bin/email-mcp mcp
```
2026-04-13 16:01:28 +00:00
La configuration se fait une fois séparément via `email-mcp config`.
2026-04-10 12:31:38 +00:00
### Configuration JSON manuelle
Ajoute le bloc suivant à ta configuration MCP (`~/.claude.json` côté utilisateur, ou `.mcp.json` dans un projet) :
```json
{
"mcpServers": {
"email-mcp": {
"command": "/absolute/path/to/bin/email-mcp",
"args": ["mcp"]
}
}
}
```
2026-04-10 10:40:46 +00:00
2026-04-10 12:51:17 +00:00
## Releases
Une release est générée automatiquement quand tu pousses un tag `v*` sur le repo Gitea.
2026-04-13 16:01:28 +00:00
Les assets publiés sont :
2026-04-10 12:51:17 +00:00
2026-04-13 16:01:28 +00:00
- `build/email-mcp-linux-amd64`
- `mcp.toml`
2026-04-10 12:51:17 +00:00
2026-04-10 12:31:38 +00:00
## Compiler depuis les sources
2026-04-10 10:40:46 +00:00
2026-04-10 12:31:38 +00:00
```sh
make build
```
2026-04-13 16:01:28 +00:00
Le binaire est généré dans `build/email-mcp-<goos>-<goarch>` avec une version injectée depuis `git describe`.
2026-04-10 12:31:38 +00:00
Pour cross-compiler :
2026-04-10 10:40:46 +00:00
2026-04-10 12:31:38 +00:00
```sh
make build GOOS=windows GOARCH=amd64
```
Pour lancer les tests :
2026-04-10 10:40:46 +00:00
2026-04-10 12:31:38 +00:00
```sh
make test
2026-04-10 10:40:46 +00:00
```