mcp-framework/README.md

55 lines
2 KiB
Markdown
Raw Normal View History

2026-04-13 13:33:48 +00:00
# mcp-framework
`mcp-framework` est une bibliothèque Go pour construire des binaires MCP robustes, sans imposer un runtime lourd.
2026-04-13 13:33:48 +00:00
## Le principal à savoir
- Le framework fournit des briques réutilisables : config locale, secrets, résolution CLI, manifeste projet, et auto-update.
- Il peut être utilisé de manière modulaire (package par package) ou avec un bootstrap CLI prêt à l'emploi.
- Il inclut un générateur de squelette (`mcp-framework scaffold init`) pour démarrer un nouveau binaire MCP rapidement.
2026-05-02 09:46:47 +00:00
- Il peut générer la glue Go dérivée d'un manifeste racine (`mcp-framework generate`).
- Toute la documentation détaillée est maintenant organisée dans `docs/` par grandes parties.
2026-04-13 13:53:53 +00:00
## Démarrage rapide
Installer le framework dans un projet Go existant :
2026-04-13 13:53:53 +00:00
```bash
go get gitea.lclr.dev/AI/mcp-framework
```
Initialiser un nouveau projet MCP depuis un dossier vide :
2026-04-14 13:59:18 +00:00
```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
```
## Documentation
- Vue d'ensemble : [docs/README.md](docs/README.md)
- Installation et usage type : [docs/getting-started.md](docs/getting-started.md)
- Packages : [docs/packages.md](docs/packages.md)
- Bootstrap CLI : [docs/bootstrap-cli.md](docs/bootstrap-cli.md)
- Manifeste `mcp.toml` : [docs/manifest.md](docs/manifest.md)
2026-05-02 09:46:47 +00:00
- Génération depuis `mcp.toml` : [docs/generate.md](docs/generate.md)
- Scaffolding : [docs/scaffolding.md](docs/scaffolding.md)
- Config JSON : [docs/config.md](docs/config.md)
- Secrets : [docs/secrets.md](docs/secrets.md)
- Helpers CLI : [docs/cli-helpers.md](docs/cli-helpers.md)
- Auto-update : [docs/auto-update.md](docs/auto-update.md)
- Exemple minimal : [docs/minimal-example.md](docs/minimal-example.md)
- Limites actuelles : [docs/limitations.md](docs/limitations.md)