mcp-framework/docs/getting-started.md

49 lines
1.3 KiB
Markdown
Raw Normal View History

# Installation et utilisation type
## Installation
```bash
go get gitea.lclr.dev/AI/mcp-framework
```
## CLI de scaffold
Pour initialiser un projet MCP depuis un dossier vide, sans écrire de runner Go :
```bash
go install gitea.lclr.dev/AI/mcp-framework/cmd/mcp-framework@latest
mcp-framework scaffold init \
--target ./my-mcp \
--module example.com/my-mcp \
--binary my-mcp \
--profiles dev,prod
```
Puis dans le projet généré :
```bash
cd my-mcp
go mod tidy
go run ./cmd/my-mcp help
```
## Utilisation type
2026-05-02 10:07:34 +00:00
Un flux complet côté application :
1. Déclarer `mcp.toml` à la racine du module.
2. Lancer `mcp-framework generate` pour produire le package `mcpgen`.
3. Déclarer les sous-commandes communes via `bootstrap` si l'application utilise le bootstrap CLI.
4. Résoudre le profil actif avec `cli`.
5. Charger la config versionnée avec `config`.
6. Lire les secrets avec `secretstore` ou `mcpgen.OpenSecretStore`.
7. Charger le manifest runtime avec `mcpgen.LoadManifest`.
8. Exécuter l'auto-update avec `mcpgen.RunUpdate` ou `update.Run`.
9. Exécuter `doctor` pour diagnostiquer la configuration locale et brancher des checks métier.
Pour vérifier que le code généré est synchronisé avec le manifeste :
```bash
mcp-framework generate --check
```