convention.sh

Qu'est-ce que convention.sh ?

convention.sh est un toolkit hébergé pour enseigner aux agents de codage à produire un TypeScript plus cohérent et prêt pour la production. Il fournit une bibliothèque de conventions TypeScript affinées manuellement que les agents peuvent récupérer à la demande plutôt que de s'appuyer sur un ensemble de règles statique limité à la taille d'une invite.

L'objectif principal est de réduire les sorties TypeScript approximatives en fournissant aux agents des conventions concrètes — telles que des patterns de typage plus stricts et des approches de validation runtime — livrées via une interface standard.

Fonctionnalités clés

• Serveur MCP hébergé pour les conventions : convention.sh fonctionne comme un serveur Model Context Protocol (MCP) hébergé qu'un agent peut interroger pour obtenir les extraits de conventions nécessaires.
• Récupération d'extraits à la demande (27 conventions) : au lieu d'intégrer un mur de règles dans chaque invite, les agents récupèrent uniquement les extraits pertinents d'une bibliothèque de 27 conventions sur demande.
• Conventions axées sur la correction TypeScript : les conventions listées mettent l'accent sur un typage strict (éviter any), l'utilisation de Zod pour valider les entrées non fiables, et la préférence pour les unions discriminées plutôt que les champs optionnels.
• Intégration dans le contexte du modèle via MCP : compatible avec tout agent supportant le Standard Model Context Protocol en ajoutant simplement le point d'accès MCP dans la configuration de l'agent.
• Toujours à jour sans redéploiement : comme les conventions sont servies depuis le point d'accès MCP hébergé, les changements sont pris en compte lors des requêtes suivantes, sans nécessiter de réécriture d'invite ou de redéploiement d'application.

Comment utiliser convention.sh

1. Ajoutez le point d'accès MCP à votre agent avec la commande terminale fournie, qui enregistre le point d'accès hébergé : claude mcp add conventiondotsh --transport http https://mcp.convention.sh.
2. Lancez vos tâches TypeScript habituelles dans votre agent de codage.
3. Laissez l'agent demander les conventions au besoin : pendant une tâche, l'agent requête les extrait(s) de convention spécifique(s) auprès du serveur convention.sh quand il en a besoin.

Si vous utilisez un agent compatible MCP différent de l'exemple, configurez-le pour appeler le même point d'accès MCP hébergé décrit par convention.sh.

Cas d'usage

• Refactorisation de modules TypeScript avec un style cohérent : lors de la génération ou de la mise à jour de code TypeScript, demandez les conventions pour que l'agent applique les mêmes patterns pour le typage et la validation d'entrée.
• Validation d'entrées non fiables dans les gestionnaires API : utilisez les conventions recommandant la validation Zod pour garder la vérification d'entrée explicite et cohérente.
• Éviter l'ambiguïté des champs optionnels : lors de la conception de formes de données, préférez les unions discriminées aux champs optionnels pour clarifier la gestion des variantes dans le code généré.
• Réduire le gonflement des invites pour des sessions de codage longues : gardez les invites de l'agent focalisées en le laissant récupérer les extraits de conventions spécifiques uniquement quand nécessaire.
• Équipes standardisant la sortie des agents : servez les mêmes extraits de conventions depuis un point d'accès hébergé partagé pour que les agents avec intégration MCP restent alignés entre machines (les mises à jour sont prises en compte à la prochaine requête).

FAQ

• Que signifie « à la demande » ici ? Les conventions sont livrées via un serveur MCP hébergé, et l'agent ne demande que les extrait(s) nécessaires d'une bibliothèque de 27 conventions pendant une tâche, plutôt que de recevoir l'ensemble complet de règles à chaque fois.

• Dois-je construire ou héberger quoi que ce soit moi-même ? Le site décrit convention.sh comme un serveur MCP hébergé, vous ajoutez donc le point d'accès à votre agent plutôt que d'héberger la bibliothèque de conventions vous-même.

• Comment l'intégrer à mon agent de codage ? Utilisez le flux d'intégration MCP : configurez un agent compatible MCP pour utiliser le point d'accès hébergé à https://mcp.convention.sh. La page inclut une commande d'exemple pour ajouter le serveur MCP.

• Quels types de règles TypeScript sont inclus ? La page liste des conventions exemples axées sur un typage strict (pas de any), la validation d'entrées non fiables avec Zod, et la préférence pour les unions discriminées plutôt que les champs optionnels.

• Devrai-je mettre à jour les invites quand les conventions changent ? Non — comme les conventions sont servies depuis le point d'accès MCP hébergé, l'agent récupère les nouvelles règles à la prochaine requête, sans nécessiter de redéploiement ou de copies obsolètes entre machines.

Alternatives

• Listes statiques de règles ou wikis dans les prompts : vous pouvez inclure directement les directives TypeScript dans chaque prompt, mais cela ajoute du volume aux prompts et peut encore mener à une application incohérente.
• Chaînes d’outils de linting/formatage locaux (ex. : TypeScript ESLint) : ces outils aident à imposer le style et à détecter les problèmes après coup, alors que convention.sh fournit les conventions pendant la génération de code via MCP.
• Autres outils de contexte pour agents basés sur la récupération : si vous utilisez déjà RAG ou la récupération de contexte via outils pour le codage, vous pourriez créer un workflow similaire « récupérer les conventions au besoin », mais cela nécessiterait de maintenir vous-même la bibliothèque de conventions et la logique de récupération.