Files
familiar/doc/clients/README.md
T
Latte df9e06a3e7
CI / lint (pull_request) Successful in 55s
docker / lint (pull_request) Successful in 56s
CI / test (pull_request) Successful in 1m6s
docker / test (pull_request) Successful in 1m4s
CI / publish (pull_request) Has been skipped
docker / docker (pull_request) Failing after 1m11s
docs: deployment guide + per-client setup + connect matrix
- doc/deployment.md: run familiar as a remote MCP server — secure defaults,
  bearer vs OAuth modes, the full env-var reference, one-time login / token-store
  provisioning, the published images, docker compose, and TLS reverse-proxy
  blocks for nginx (proxy_buffering off + long read timeout), Caddy, and Traefik.
- doc/clients/: one page per client with exact working steps — Claude Code,
  VS Code (.vscode/mcp.json with a masked token input, and the workspace
  .mcp.json header gotcha), Mistral Le Chat, Claude Desktop + Cowork (mcp-remote
  bridge, per-OS config paths), and Claude web (oauth mode + external IdP, with
  "use Desktop + bearer" as the simpler alternative). Plus a clients/ index.
- README: a "Connect a client" matrix (client -> auth -> guide) and a compact
  "Deploy with Docker" section linking to doc/deployment.md; oauth mode noted.
- doc/README.md index: rows for Deployment and Client setup.
- doc/getting-started.md: pointer from the HTTPS quickstart to the full docs.
- CLAUDE.md: FAMILIAR_AUTH_MODE / FAMILIAR_OAUTH_* / FAMILIAR_ALLOW_INSECURE_BIND
  and /healthz in the transport note; the split ci.yml / docker.yml workflows.

Deployment docs live under the existing doc/ tree (the repo uses doc/, not a
separate docs/) to keep a single documentation directory.
2026-07-04 19:26:33 +02:00

961 B

Connect a client

Exact steps to point each MCP client at a familiar server deployed over HTTPS (see deployment first). Most clients use a bearer token (FAMILIAR_HTTP_TOKEN); only the claude.ai web connector needs OAuth.

Client Auth Guide
Claude Code Bearer claude-code.md
VS Code (Copilot) Bearer vscode.md
Mistral Le Chat Bearer mistral.md
Claude Desktop Bearer (via mcp-remote) claude-desktop.md
Claude Cowork Bearer (via mcp-remote) claude-cowork.md
Claude web (claude.ai) OAuth 2.1 (external IdP) claude-web.md

Bearer works everywhere except the claude.ai web connector, which requires OAuth 2.1 with Dynamic Client Registration. If you're a Claude user who doesn't want to run an IdP, use the Desktop app with a bearer token instead.