Skip to main content
Glama
README.md
# headguard

Paste the headers, get the verdict. headguard is a local forwarding client for the hosted GoLive Check MCP service: it answers `tools/list` on your own machine from the captured tool definitions and forwards every call to the service, returning the results exactly as the service sends them back.

The service itself never fetches anything. You paste in the HTTP response headers from a deployment you already operate — the kind `curl -sI` prints — and it runs seven security checks over them, explains each finding, and hands back copy-paste fixes for the platform whose config you can edit. Nothing is stored locally; this package is a pipe, not an analyser.

## The tools

- **`analyze_headers`** — Check raw HTTP response headers from a deployment you already operate. `headers_raw` is required: the header block, including an optional status line, exactly as `curl -sI` prints it. Optionally name a `platform` (`caddy`, `nginx`, `vercel`, `netlify` or `nextjs`) to get that platform's fix snippet attached, and pass `config_text` so the service can report whether a fix is already present in your config. A `url` field is never fetched.
- **`explain_finding`** — Explain one finding id from the seven (`GLC-HSTS-MISSING`, `GLC-CSP-MISSING`, `GLC-NOSNIFF-MISSING`, `GLC-FRAME-MISSING`, `GLC-REFERRER-MISSING`, `GLC-SERVER-VERSION-LEAK`, `GLC-CORS-WILDCARD-CREDENTIALS`). `id` is required. Returns the id, its severity, why it matters, and an answer page for the CSP and clickjacking findings.
- **`get_fix`** — Return the registry snippet for one finding id and one platform. `id` is required; `platform` selects among `caddy`, `nginx`, `vercel`, `netlify` and `nextjs`. An omitted or unknown platform returns a null fix rather than a guess.
- **`report_feedback`** — Report one finding id and one outcome (`false_positive`, `fix_worked` or `fix_failed`). Both `id` and `outcome` are required. The service records nothing: no file, no counter, no log line.

## Install and run

As an MCP server via npm:

```bash
npx -y @reneturcios/headguard mcp
```

MCP client configuration:

```json
{
  "mcpServers": {
    "headguard": {
      "command": "npx",
      "args": ["-y", "@reneturcios/headguard", "mcp"]
    }
  }
}
```

As a container:

```bash
docker run -i ghcr.io/cloudcorprecords/headguard
docker run --rm ghcr.io/cloudcorprecords/headguard explain_finding '{"id":"GLC-CSP-MISSING"}'
```

## CLI

One binary serves both the command line and the MCP server. Each tool is a subcommand taking a single JSON string with that tool's arguments:

```bash
headguard analyze_headers '{"headers_raw":"HTTP/2 200\nserver: nginx","platform":"nginx"}'
headguard get_fix '{"id":"GLC-HSTS-MISSING","platform":"caddy"}'
headguard report_feedback '{"id":"GLC-FRAME-MISSING","outcome":"fix_worked"}'
headguard --version
```

Exit codes: `0` when the forwarded call succeeds, `1` when the upstream result is an error, and `2` for usage problems such as an unknown subcommand or a malformed JSON argument.

## Configuration

- `GOLIVE_MCP_URL` — Overrides the upstream endpoint. The default is the pinned hosted endpoint, `https://dontdeployonfriday.com/mcp`. (The override variable is a reconstruction added by this rebuild.)

There is deliberately no API-key setting: the upstream record declares no headers, the surface was captured keyless, and headguard never sends an `Authorization` header — or any other credential header — on any request, under any environment.

Upstream failures — a JSON-RPC error from the service, a non-2xx response, an unreadable body, or a request that fails outright — are reported to the caller as an error result whose text starts with `headguard error:`.

## How forwarding works

The first forwarded call opens a session: an `initialize` request (protocol version `2025-03-26`), followed by a `notifications/initialized` notification, then the `tools/call` itself. If the service answers the initialize request with an `Mcp-Session-Id` header, that value is carried on every later request, and the open session is reused for the rest of the process. Replies are accepted either as plain JSON or as server-sent events. Successful results pass through verbatim, including any `isError` flag and any extra fields the service includes.

## Development

```bash
npm install
npm run build   # tsc -> dist/ (dist/cli.js is the bin)
npm test        # tsx --test test/*.test.ts — stubbed upstream, no network
npm run dev     # run the CLI from source
```

The test suite checks the served tool list against the captured surface, exercises the session handshake and its reuse, asserts that no `Authorization` header is ever sent under any environment, and verifies that arguments go upstream untouched and results come back untouched.

## License

MIT — see `LICENSE`. Copyright (c) 2026 Rene Turcios.