mcp-framework/docs/getting-started.md

1.3 KiB

Installation et utilisation type

Installation

go get forge.lclr.dev/AI/mcp-framework

CLI de scaffold

Pour initialiser un projet MCP depuis un dossier vide, sans écrire de runner Go :

go install forge.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é :

cd my-mcp
go mod tidy
go run ./cmd/my-mcp help

Utilisation type

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 :

mcp-framework generate --check