convention.sh

Что такое convention.sh?

convention.sh — хостинговый toolkit для обучения кодинговых агентов создавать более согласованный, готовый к продакшену TypeScript. Он предоставляет библиотеку вручную настроенных TypeScript-конвенций, которые агенты могут запрашивать по требованию, вместо статического набора правил размером с промпт.

Основная цель — уменьшить неаккуратный TypeScript-вывод, предоставляя агентам конкретные конвенции — такие как более строгие шаблоны типизации и подходы к runtime-валидации — через стандартный интерфейс.

Ключевые возможности

• Хостинговый MCP-сервер для конвенций: convention.sh работает как хостинговый сервер Model Context Protocol (MCP), который агент может опрашивать для получения нужных фрагментов конвенций.
• Получение фрагментов по требованию (27 конвенций): вместо встраивания стены правил в каждый промпт агенты запрашивают только релевантные фрагменты из библиотеки из 27 конвенций.
• Конвенции для корректности TypeScript: перечисленные конвенции подчеркивают строгую типизацию (избегая any), использование Zod для валидации ненадежного ввода и предпочтение discriminated unions перед опциональными полями.
• Интеграция в модельный контекст через MCP: работает с любым агентом, поддерживающим Standard Model Context Protocol — просто добавьте MCP-эндпоинт в конфигурацию агента.
• Всегда актуально без передеплоев: поскольку конвенции подаются с хостингового MCP-эндпоинта, изменения подхватываются в последующих запросах без переписывания промптов или передеплоя приложения.

Как использовать convention.sh

1. Добавьте MCP-эндпоинт в агента с помощью предоставленной команды в терминале, которая регистрирует хостинговый эндпоинт: claude mcp add conventiondotsh --transport http https://mcp.convention.sh.
2. Запускайте обычные TypeScript-задачи в кодинговом агенте.
3. Пусть агент запрашивает конвенции по мере надобности: во время задачи агент запрашивает конкретные фрагменты конвенций с сервера convention.sh, когда они нужны.

Если вы используете другой агент с поддержкой MCP, настройте его на вызов того же хостингового MCP-эндпоинта от convention.sh.

Сценарии использования

• Рефакторинг TypeScript-модулей в едином стиле: при генерации или обновлении TypeScript-кода запрашивайте конвенции, чтобы агент применял одинаковые шаблоны типизации и валидации ввода.
• Валидация ненадежного ввода в API-обработчиках: используйте конвенции, рекомендующие Zod-валидацию для явной и согласованной проверки ввода.
• Избежание неоднозначности опциональных полей: при проектировании структур данных предпочитайте discriminated unions опциональным полям для ясной обработки вариантов в генерируемом коде.
• Снижение объема промптов в длинных сессиях кодирования: держите промпты агента сфокусированными, запрашивая конкретные фрагменты конвенций только по необходимости.
• Стандартизация вывода агентов в командах: подавайте одни и те же фрагменты конвенций с общего хостингового эндпоинта, чтобы агенты с MCP-интеграцией оставались согласованными на разных машинах (обновления подхватываются в следующих запросах).

FAQ

• Что значит «по требованию» здесь?

  Конвенции подаются через хостинговый MCP-сервер, и агент запрашивает только нужные фрагменты из библиотеки из 27 конвенций во время задачи, а не полный набор правил каждый раз.

• Нужно ли мне что-то строить или хостить самостоятельно?

  Сайт описывает convention.sh как хостинговый MCP-сервер, так что вы просто добавляете эндпоинт в агента, а не хостите библиотеку конвенций сами.

• Как интегрировать с моим кодинговым агентом?

  Используйте поток интеграции MCP: настройте агент с поддержкой MCP на хостинговый эндпоинт https://mcp.convention.sh. На странице приведена примерная команда для добавления MCP-сервера.

• Какие правила TypeScript включены?

  Страница перечисляет примеры конвенций, ориентированных на строгую типизацию (без any), валидацию ненадежного ввода с Zod и предпочтение discriminated unions опциональным полям.

• Нужно ли обновлять промпты при изменении конвенций?

  Нет — поскольку конвенции подаются с хостингового MCP-эндпоинта, агент подхватывает новые правила в следующем запросе без передеплоев или устаревших копий на машинах.

Альтернативы

• Статические списки правил или вики в промптах: можно включать руководства по TypeScript прямо в каждый промпт, но это увеличивает объём промпта и всё равно приводит к неравномерному применению.
• Локальные toolchain линтинга/форматирования (например, TypeScript ESLint): эти инструменты помогают обеспечивать стиль и ловить проблемы постфактум, в то время как convention.sh предоставляет конвенции во время генерации кода через MCP.
• Другие инструменты для retrieval-based контекста агентов: если вы уже используете RAG или tool-based fetching контекста для кодирования, можно построить похожий workflow «запрашивать конвенции по мере надобности», но это потребует самостоятельно поддерживать библиотеку конвенций и логику retrieval.