Rychlý start — první sběr podkladů za 5 minut

Tento návod vás provede instalací BriefGate, jeho propojením s vaším coding agentem a odesláním prvního požadavku na podklady.

Co budete potřebovat

1. Propojení BriefGate s vaším agentem

Čtyři způsoby propojení, všechny vedou ke stejným 13 nástrojům. První dva nepotřebují žádný API klíč ke zkopírování.

Varianta 0 — hostovaný endpoint, OAuth (doporučeno pro Claude Code a claude.ai):

bash
claude mcp add --transport http briefgate https://mcp.briefgate.dev/mcp

Pak spusťte Claude Code, zadejte /mcp, vyberte briefgate a zvolte Authenticate. Otevře se prohlížeč s dashboardem, kde se přihlásíte a schválíte přístup — nic se neinstaluje, nic se nekopíruje. Dokud to neuděláte, server se hlásí jako nepřihlášený a jeho nástroje nejsou k dispozici. V claude.ai použijte Settings > Connectors > Add custom connector se stejnou URL. Stejně se připojí každý MCP klient, který umí Streamable HTTP a OAuth 2.1.

Varianta 1 — lokální balíček, přihlášení přes zařízení (doporučeno pro Claude Code CLI, když nechcete OAuth přesměrování v prohlížeči, nebo pro skriptovaného terminálového agenta):

bash
claude mcp add briefgate -- npx -y @briefgate/mcp
npx -y @briefgate/mcp login

login vypíše krátký kód a otevře dashboard v prohlížeči; tam přístup schválíte. Získaný API klíč se uloží do ~/.briefgate/credentials.json (adresář v režimu 0700, soubor v režimu 0600) a od té chvíle se používá automaticky — žádnou proměnnou prostředí není třeba nastavovat. Příkazem npx -y @briefgate/mcp logout klíč odstraníte; zároveň se zneplatní i na serveru.

Varianta 2 — lokální balíček, API klíč (pro CI, skripty, nebo když chcete klíč spravovat sami):

bash
claude mcp add briefgate -- npx -y @briefgate/mcp --api-key bg_live_xxxxx

Nebo přidejte ručně do ~/.claude.json (klíč mcpServers v něm platí pro všechny projekty; pro konfiguraci sdílenou s týmem místo toho použijte .mcp.json v kořeni projektu):

json
{
  "mcpServers": {
    "briefgate": {
      "command": "npx",
      "args": ["-y", "@briefgate/mcp"],
      "env": { "BRIEFGATE_API_KEY": "bg_live_xxxxx" }
    }
  }
}

Proměnná BRIEFGATE_API_KEY, pokud je nastavená, má vždy přednost před uloženým přihlašovacím údajem.

Varianta 3 — hostovaný endpoint, API klíč (pro CI nebo klienta, který OAuth přesměrování neumí):

bash
claude mcp add --transport http briefgate https://mcp.briefgate.dev/mcp \
  --header "Authorization: Bearer bg_live_xxxxx"

Pro varianty 2 a 3 získáte klíč v dashboardu na https://app.briefgate.dev/app. Chcete-li si to při vývoji vyzkoušet bez odeslání e-mailu skutečnému klientovi, vytvořte sběr podkladů s "send": false — zůstane jako koncept — a přes GET /v1/intakes/preview (nebo náhled v dashboardu) si prohlédněte přesný předmět a jméno odesílatele, než cokoli odejde; odešlete ho pak přes POST /v1/intakes/:id/send, až budete připraveni.

Po úpravě konfigurace agenta ho restartujte.

2. První sběr podkladů

Následující příklad vytvoří sběr podkladů pro projekt webu restaurace. Vložte ho agentovi do kontextu (nebo zavolejte MCP nástroj define_intake přímo):

json
{
  "project_name": "Bella Napoli — Website",
  "client": {
    "email": "owner@bellanapoli.com",
    "name": "Marco Esposito",
    "language": "cs"
  },
  "items": [
    {
      "key": "logo",
      "label": "Logo restaurace",
      "help": "Nahrajte logo ve formátu SVG nebo PNG s průhledným pozadím. Nejméně 512 px na kratší straně.",
      "type": "image",
      "required": true,
      "constraints": {
        "formats": ["svg", "png"],
        "min_width": 512,
        "transparent_background": true
      }
    },
    {
      "key": "hero_copy",
      "label": "Text do hlavičky",
      "help": "Krátký odstavec (do 400 znaků), který vystihne ducha restaurace. Objeví se v horní části domovské stránky.",
      "type": "longtext",
      "required": true,
      "constraints": {
        "max_chars": 400
      }
    },
    {
      "key": "opening_hours",
      "label": "Otevírací doba",
      "help": "Vaše běžná otevírací doba. Použijte jednoduchý zápis, třeba '12:00-22:00' nebo 'Zavřeno'.",
      "type": "structured",
      "required": true,
      "schema": {
        "type": "object",
        "required": ["mon_fri", "sat", "sun"],
        "properties": {
          "mon_fri": { "type": "string", "example": "12:00-22:00" },
          "sat":     { "type": "string", "example": "12:00-23:00" },
          "sun":     { "type": "string", "example": "13:00-21:00" }
        }
      }
    },
    {
      "key": "photos",
      "label": "Fotky jídla a interiéru",
      "help": "Nahrajte 5 až 15 fotek jídla, interiéru a atmosféry. JPG, PNG nebo HEIC.",
      "type": "file_list",
      "required": true,
      "constraints": {
        "formats": ["jpg", "png", "heic"],
        "min_count": 5,
        "max_count": 15
      }
    }
  ],
  "chase_schedule": "default"
}

Nástroj vrátí:

json
{
  "intake_id": "in_8f3kQmR2",
  "portal_url": "https://p.briefgate.dev/8f3kqmr2",
  "status": "sent",
  "items": [
    { "key": "logo",          "status": "pending" },
    { "key": "hero_copy",     "status": "pending" },
    { "key": "opening_hours", "status": "pending" },
    { "key": "photos",        "status": "pending" }
  ],
  "follow_up": {
    "recommended": "schedule",
    "reason": "No webhook endpoint is registered on this account. Register one if you run a service that can receive HTTPS; otherwise check on a schedule.",
    "webhook": {
      "active_endpoints": 0,
      "events": ["intake.completed", "item.submitted"],
      "register_with": "manage_webhook"
    },
    "schedule": {
      "check_with": "get_intake_status",
      "every_hours": 24,
      "until": "2026-04-08T00:00:00.000Z"
    }
  }
}

BriefGate klientovi okamžitě pošle e-mail s osobním odkazem na portal_url, který nese jednorázový přihlašovací token. API ten token nikdy nevrací, takže samotné portal_url portál neotevře. Stav sběru podkladů se změní na sent. Pole follow_up říká, jak se dozvědět, že je sběr hotový: buď zaregistrujte webhook přes manage_webhook, nebo dotazujte get_intake_status každých follow_up.schedule.every_hours hodin až do follow_up.schedule.until.

3. Co se děje dál

  1. Klientovi přijde e-mail s odkazem na jeho vlastní portál.
  2. Každou položku nahraje nebo vyplní přímo v prohlížeči — bez zakládání účtu.
  3. Jak položky odesílá, BriefGate volá webhooky na váš endpoint (nastavíte je v dashboardu pod Settings > Webhooks).
  4. Když klient sběr podkladů nedokončí, rozešle upomínkový engine automatické e-maily v rytmu, který jste zvolili.
  5. Jakmile jsou odeslané všechny povinné položky, stav sběru podkladů přejde na completed a spustí se závěrečný webhook.

4. Kontrola stavu

Přes MCP (ve vašem agentovi):

Volání: get_intake_status
Argumenty: { "intake_id": "in_8f3kQmR2" }

Přes REST:

bash
curl https://api.briefgate.dev/v1/intakes/in_8f3kQmR2/status \
  -H "Authorization: Bearer bg_live_xxxxx"

Obojí vrátí procento dokončení, stav jednotlivých položek a přehled dosud odeslaných upomínek.

5. Vyzvednutí výsledků

Přes MCP:

Volání: get_intake_results
Argumenty: { "intake_id": "in_8f3kQmR2" }

Přes REST:

bash
curl https://api.briefgate.dev/v1/intakes/in_8f3kQmR2/results \
  -H "Authorization: Bearer bg_live_xxxxx"

Odpověď obsahuje otypovaná data připravená k použití:

Kam dál

Téma Dokument
Kompletní přehled všech 13 MCP nástrojů mcp.md
Všech 12 typů položek a jejich omezení item-types.md
REST API, webhooky a autentizace rest-api.md