Rychlý start — první intake 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

Node.js 22 nebo novější — MCP server BriefGate běží na Node.js.
Agenta s podporou MCP — Claude Code, Cursor nebo jakéhokoli klienta, který umí Model Context Protocol.
Účet BriefGate — zaregistrujte se na https://app.briefgate.dev/app a zkopírujte si API klíč z dashboardu.

1. Instalace MCP serveru

bash

npm install -g @briefgate/mcp

Ověření instalace:

bash

briefgate-mcp --version

2. Přidání BriefGate do Claude Code

Máte dvě možnosti, obě vedou ke stejnému výsledku — vyberte si tu, která vám sedí.

Varianta A — Claude Code CLI:

bash

claude mcp add briefgate -- briefgate-mcp --api-key bg_live_xxxxx

Varianta B — ruční konfigurace v ~/.claude/mcp.json:

json

{
  "mcpServers": {
    "briefgate": {
      "command": "briefgate-mcp",
      "args": ["--api-key", "bg_live_xxxxx"]
    }
  }
}

Místo bg_live_xxxxx doplňte svůj skutečný API klíč. Při vývoji používejte klíč bg_test_xxxxx — testovací režim posílá poštu přes sandbox a klientům nikdy nedoručí skutečnou zprávu.

Po úpravě konfiguračního souboru Claude Code restartujte.

3. První intake

Následující příklad vytvoří intake 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": "[email protected]",
    "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?t=Ky7Nn2xQ0pW4vBhLm8sTdRfGjEcAuZoI",
  "status": "sent",
  "items": [
    { "key": "logo",          "status": "pending" },
    { "key": "hero_copy",     "status": "pending" },
    { "key": "opening_hours", "status": "pending" },
    { "key": "photos",        "status": "pending" }
  ]
}

BriefGate klientovi okamžitě pošle e-mail s odkazem portal_url. Stav intake se změní na sent.

4. Co se děje dál

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

5. 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.

6. 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í:

Položky text a longtext vracejí prostý řetězec.
Obrázky a soubory vracejí podepsané URL (platné 24 hodin), rozměry, MIME typ a kontrolní součet.
Položky typu secret vracejí dešifrovaný text v poli value, ale jen při prvním volání (first_reveal: true). Uložte si ho hned — další volání už hodnotu vynechá.
Strukturované položky vracejí ověřený JSON objekt odpovídající schématu, které jste zadali.

Kam dál

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