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
- 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.
1.1 KiB
1.1 KiB
Connect Claude Code
Auth: bearer token. Prereq: familiar deployed over HTTPS (see deployment).
Claude Code speaks HTTP MCP with custom headers directly. Add the server:
claude mcp add --transport http familiar https://familiar.yourdomain.tld/mcp \
--header "Authorization: Bearer <your-token>"
<your-token>is yourFAMILIAR_HTTP_TOKEN.- Use the full URL including the
FAMILIAR_HTTP_PATH(default/mcp).
Check it:
claude mcp list # familiar should show as connected
Then ask Claude Code to call ping, or "what's Tritanium worth in Jita?".
To scope it to the current project instead of your user config, add --scope project (writes a .mcp.json in the repo). Remove it with claude mcp remove familiar.
Troubleshooting
- 401 — the token is wrong or missing; re-run
claude mcp addwith the correctAuthorizationheader. - Hangs / times out — your reverse proxy is likely buffering; set
proxy_buffering off;and a long read timeout (see deployment).