Foyer Docs

Set up Foyer

Install the GitHub App, the CLI, and the MCP server.

Three install surfaces, one URL. Pick the ones you need.

1. GitHub App (start here — fastest)

Install on a repo so every PR gets a merge-readiness comment automatically.

Install URL: api.getfoyer.dev/auth/github/install

Open that URL in a browser. After GitHub finishes the install, you're redirected back to Foyer. Every PR on installed repos gets a merge-readiness comment automatically — no per-PR action required.

2. CLI (local pre-PR review)

Run the same review locally before you push. Authenticates via RFC 8628 device-code flow — no token copy-paste.

npm i -g @getfoyer/cli
foyer login

Verify:

foyer status

Should print your org and token expiry. Exits 0 on a valid token, 2 if the token is missing or rejected.

See the CLI reference for the full command list.

3. MCP (wire Foyer into your agent)

Add Foyer as an MCP server so your agent can pull review context, plan artifacts, and blockers directly.

Run foyer login first so a token exists at ~/.foyer/credentials. Then for Claude Code:

claude mcp add foyer \
    --scope user \
    --env FOYER_API_URL=https://api.getfoyer.dev \
    --env FOYER_TOKEN="$(jq -r .token ~/.foyer/credentials)" \
    -- npx -y @getfoyer/mcp@latest

Why the jq? Reading the token from the file at install time strips any trailing newline. The newline-in-token footgun produces a -32000 MCP JSON-RPC error that's painful to debug.

For other MCP clients, see the MCP install page.

Verify: in Claude Code run /mcp, look for foyer in green.