docs: deployment guide + per-client setup + connect matrix
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
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.
This commit is contained in:
12 files changed
+367
-28
No files matched your search
@@ -0,0 +1,18 @@
|
||||
# Connect a client
|
||||
|
||||
Exact steps to point each MCP client at a familiar server deployed over HTTPS
|
||||
(see [deployment](../deployment.md) 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](claude-code.md) |
|
||||
| VS Code (Copilot) | Bearer | [vscode.md](vscode.md) |
|
||||
| Mistral Le Chat | Bearer | [mistral.md](mistral.md) |
|
||||
| Claude Desktop | Bearer (via `mcp-remote`) | [claude-desktop.md](claude-desktop.md) |
|
||||
| Claude Cowork | Bearer (via `mcp-remote`) | [claude-cowork.md](claude-cowork.md) |
|
||||
| Claude web (claude.ai) | OAuth 2.1 (external IdP) | [claude-web.md](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.
|
||||
@@ -0,0 +1,28 @@
|
||||
# Connect Claude Code
|
||||
|
||||
**Auth:** bearer token. **Prereq:** familiar deployed over HTTPS (see [deployment](../deployment.md)).
|
||||
|
||||
Claude Code speaks HTTP MCP with custom headers directly. Add the server:
|
||||
|
||||
```bash
|
||||
claude mcp add --transport http familiar https://familiar.yourdomain.tld/mcp \
|
||||
--header "Authorization: Bearer <your-token>"
|
||||
```
|
||||
|
||||
- `<your-token>` is your `FAMILIAR_HTTP_TOKEN`.
|
||||
- Use the full URL including the `FAMILIAR_HTTP_PATH` (default `/mcp`).
|
||||
|
||||
Check it:
|
||||
|
||||
```bash
|
||||
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 add` with the correct `Authorization` header.
|
||||
- **Hangs / times out** — your reverse proxy is likely buffering; set `proxy_buffering off;` and a long read timeout (see [deployment](../deployment.md#tls-reverse-proxy)).
|
||||
@@ -0,0 +1,9 @@
|
||||
# Connect Claude Cowork
|
||||
|
||||
**Auth:** bearer token, via a local bridge.
|
||||
|
||||
Cowork shares Claude Desktop's connector plumbing, so the setup is identical: bridge the remote HTTP server to a local stdio command with `mcp-remote` so the `Authorization: Bearer <token>` header gets forwarded.
|
||||
|
||||
Follow **[Connect Claude Desktop](claude-desktop.md)** — the same `claude_desktop_config.json` entry (the `npx mcp-remote … --header "Authorization: Bearer <token>"` block) applies. After editing, restart Cowork.
|
||||
|
||||
If you've configured it once for Desktop on the same machine, Cowork picks up the same config.
|
||||
@@ -0,0 +1,38 @@
|
||||
# Connect Claude Desktop
|
||||
|
||||
**Auth:** bearer token, via a local bridge. **Prereq:** familiar deployed over HTTPS (see [deployment](../deployment.md)), plus Node.js (`npx`) on the machine running Claude Desktop.
|
||||
|
||||
Claude Desktop's **Connectors** UI can add a remote MCP URL but **cannot attach a bearer header**. So bridge the remote HTTP server to a local stdio command with [`mcp-remote`](https://www.npmjs.com/package/mcp-remote), which forwards the `Authorization` header.
|
||||
|
||||
Edit `claude_desktop_config.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"familiar": {
|
||||
"command": "npx",
|
||||
"args": [
|
||||
"-y",
|
||||
"mcp-remote",
|
||||
"https://familiar.yourdomain.tld/mcp",
|
||||
"--header",
|
||||
"Authorization: Bearer <your-token>"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Config file location:
|
||||
|
||||
- **macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
|
||||
- **Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
|
||||
- **Linux:** `~/.config/Claude/claude_desktop_config.json`
|
||||
|
||||
Restart Claude Desktop fully (quit, not just close the window). familiar appears in the tools/plug icon.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- **Server fails to start** — ensure Node.js is installed and `npx` is on PATH; the first run downloads `mcp-remote`.
|
||||
- **401** — fix the token in the `--header` argument, then restart.
|
||||
- **Want native (no bridge)?** Only the OAuth path is header-free, and Desktop's connector is happiest with bearer via this bridge — keep `mcp-remote` unless you've set up [oauth mode](claude-web.md).
|
||||
@@ -0,0 +1,39 @@
|
||||
# Connect Claude web (claude.ai)
|
||||
|
||||
**Auth:** OAuth 2.1 only. **Prereq:** familiar in `oauth` mode behind HTTPS, plus an external identity provider.
|
||||
|
||||
The claude.ai custom-connector flow speaks **OAuth 2.1 with Dynamic Client Registration (DCR)** and does **not** accept a static bearer token. familiar itself is only a **resource server** — it validates JWTs and advertises where to authenticate, but it is **not** an authorization server and does no DCR. So Claude web needs an external IdP that supports DCR (e.g. **Authentik** or **Keycloak**) sitting in front.
|
||||
|
||||
> **Simpler alternative:** if you don't want to run an IdP, use the **Claude Desktop** app with a bearer token instead — see [Connect Claude Desktop](claude-desktop.md). Bearer is easier for every client except the claude.ai web connector.
|
||||
|
||||
## 1. Set up the IdP (external)
|
||||
|
||||
On your IdP, create an application/provider for familiar that:
|
||||
|
||||
- issues **JWT access tokens** signed with a key published at a **JWKS** endpoint,
|
||||
- sets the token **audience** to familiar's public URL (the resource),
|
||||
- supports **Dynamic Client Registration** so claude.ai can register itself.
|
||||
|
||||
Note the issuer URL and (optionally) the JWKS URL.
|
||||
|
||||
## 2. Configure familiar in oauth mode
|
||||
|
||||
```bash
|
||||
FAMILIAR_AUTH_MODE=oauth
|
||||
FAMILIAR_OAUTH_ISSUER=https://idp.yourdomain.tld/application/o/familiar/
|
||||
FAMILIAR_OAUTH_RESOURCE=https://familiar.yourdomain.tld
|
||||
# FAMILIAR_OAUTH_AUDIENCE defaults to the resource URL; override if your IdP differs.
|
||||
# FAMILIAR_OAUTH_JWKS_URI is discovered from the issuer's OIDC metadata if unset.
|
||||
```
|
||||
|
||||
No `FAMILIAR_HTTP_TOKEN` is needed in oauth mode. familiar serves the discovery document at `https://familiar.yourdomain.tld/.well-known/oauth-protected-resource/mcp`, and unauthenticated MCP calls return `401` with a `WWW-Authenticate: Bearer` header pointing at your issuer.
|
||||
|
||||
## 3. Add the connector
|
||||
|
||||
In claude.ai: **Settings → Connectors → Add custom connector**, URL `https://familiar.yourdomain.tld/mcp`. Claude discovers your IdP from the metadata, registers via DCR, and runs the OAuth login. Approve familiar's scopes and you're connected.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- **"couldn't connect" immediately** — familiar isn't in `oauth` mode, or `FAMILIAR_OAUTH_RESOURCE`/`ISSUER` are unset; the metadata endpoint must return 200.
|
||||
- **Login loops / invalid token** — audience mismatch: your IdP's token `aud` must equal `FAMILIAR_OAUTH_RESOURCE` (or your `FAMILIAR_OAUTH_AUDIENCE`).
|
||||
- **DCR fails** — the IdP doesn't have Dynamic Client Registration enabled; claude.ai requires it.
|
||||
@@ -0,0 +1,17 @@
|
||||
# Connect Mistral Le Chat
|
||||
|
||||
**Auth:** bearer token. **Prereq:** familiar deployed over HTTPS (see [deployment](../deployment.md)).
|
||||
|
||||
Mistral's [chat.mistral.ai](https://chat.mistral.ai) supports remote MCP servers with a bearer token natively.
|
||||
|
||||
1. Open **Intelligence → Connectors → Add custom connector**.
|
||||
2. **URL:** `https://familiar.yourdomain.tld/mcp` (include the `FAMILIAR_HTTP_PATH`, default `/mcp`).
|
||||
3. **Authentication:** choose **Bearer Token** and paste your `FAMILIAR_HTTP_TOKEN`.
|
||||
4. Save, then enable the connector in a conversation.
|
||||
|
||||
Ask Le Chat to call `ping`, or "compare Plex prices across trade hubs".
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- **401 / connector won't enable** — wrong or missing token; re-check the Bearer Token value.
|
||||
- **Timeouts** — reverse-proxy buffering; set `proxy_buffering off;` and a long read timeout (see [deployment](../deployment.md#tls-reverse-proxy)).
|
||||
@@ -0,0 +1,38 @@
|
||||
# Connect VS Code (Copilot / MCP)
|
||||
|
||||
**Auth:** bearer token. **Prereq:** familiar deployed over HTTPS (see [deployment](../deployment.md)).
|
||||
|
||||
VS Code's MCP support reads an **`http`** server entry with custom headers. Put it in **`.vscode/mcp.json`** (per-workspace) or your user `mcp.json`.
|
||||
|
||||
> ⚠️ Use **`.vscode/mcp.json`**, not a workspace-root **`.mcp.json`**. The workspace `.mcp.json` format ignores `headers`, so the bearer token never gets sent and you'll get a silent 401. This is a known VS Code quirk.
|
||||
|
||||
`.vscode/mcp.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"inputs": [
|
||||
{
|
||||
"id": "familiar_token",
|
||||
"type": "promptString",
|
||||
"description": "familiar bearer token",
|
||||
"password": true
|
||||
}
|
||||
],
|
||||
"servers": {
|
||||
"familiar": {
|
||||
"type": "http",
|
||||
"url": "https://familiar.yourdomain.tld/mcp",
|
||||
"headers": {
|
||||
"Authorization": "Bearer ${input:familiar_token}"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
On first use VS Code prompts for the token (masked, thanks to `password: true`) and reuses it. Start the server from the MCP view or the `MCP: List Servers` command, then use it from Copilot Chat's agent mode.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- **Silent 401 / "no tools"** — you're almost certainly in a root `.mcp.json`; move the config to `.vscode/mcp.json` so `headers` is honored.
|
||||
- **401 after entering a token** — wrong token; clear it via `MCP: Reset Cached Tokens` (or restart) and re-enter.
|
||||
Reference in new issue
Block a user