xdebug-mcp/README.md
thibaud-leclere 8137f4045f docs: add install.sh and README.md
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-12 10:55:12 +02:00

79 lines
1.9 KiB
Markdown

# xdebug-mcp
Serveur MCP pour analyser des fichiers de profiling Xdebug (format cachegrind).
## Prérequis
- Un fichier de profiling Xdebug (`.gz` ou texte brut) généré avec `xdebug.mode=profile`
- Optionnel : `make` + Go (pour la compilation locale)
## Sommaire
- [Prérequis](#prérequis)
- [À quoi sert ce serveur MCP ?](#à-quoi-sert-ce-serveur-mcp-)
- [Installation](#installation)
- [Utilisation avec un client MCP](#utilisation-avec-un-client-mcp)
- [Documentation](#documentation)
## À quoi sert ce serveur MCP ?
`xdebug-mcp` permet à un client MCP d'analyser des fichiers de profiling Xdebug sans outil externe :
- analyse globale d'un profil : stats générales et top N fonctions par coût inclusif ;
- liste des appelants d'une fonction donnée, triés par coût décroissant ;
- liste des appelés d'une fonction donnée, triés par coût décroissant.
## Installation
### Option principale : script d'installation
Installer la dernière release publique et lancer l'assistant de configuration :
```sh
curl -fsSL https://get.lclr.dev/mcp/xdebug/install.sh | bash
```
### Option alternative : binaire de la dernière release
Télécharger le binaire adapté à votre OS depuis la page des releases publiques :
https://forge.lclr.dev/AI/xdebug-mcp/releases
Puis le rendre exécutable (Linux/macOS) :
```sh
chmod +x /absolute/path/to/xdebug-mcp
```
### Option alternative : compilation locale
```sh
make build
```
Binaire généré : `build/xdebug-mcp` (ou `build/xdebug-mcp-linux-amd64` selon la cible).
## Utilisation avec un client MCP
### Claude Code CLI
```sh
claude mcp add xdebug-mcp -- /absolute/path/to/xdebug-mcp mcp
```
### Configuration JSON
```json
{
"mcpServers": {
"xdebug-mcp": {
"command": "/absolute/path/to/xdebug-mcp",
"args": ["mcp"]
}
}
}
```
## Documentation
- [Référence des outils MCP](docs/tools.md)