Authentication¶
This guide covers how to protect your markdown-vault-mcp server with authentication. Choose the mode that fits your deployment.
Transport requirement
Authentication only works with HTTP transport (--transport http or sse). It has no effect with --transport stdio.
Auth modes¶
The server supports four authentication modes:
| Mode | When to use | Configuration |
|---|---|---|
| Multi-auth | Mixed clients — e.g. Claude web (OIDC) + Claude Code (bearer token) on the same server | Set both MARKDOWN_VAULT_MCP_BEARER_TOKEN and all four OIDC variables |
| Bearer token | Simple deployments behind a VPN, Docker compose stacks, development | Set MARKDOWN_VAULT_MCP_BEARER_TOKEN only |
| OIDC | Production with user identity, SSO, multi-user access | Set all four OIDC variables only |
| No auth | Local stdio usage, trusted networks | Default (nothing to configure) |
When both bearer token and OIDC are configured, the server accepts either credential — a valid bearer token or a valid OIDC session. This is useful when different clients require different authentication flows against the same vault instance.
Bearer token¶
The simplest way to protect your server. A single static token shared between server and clients.
Setup¶
-
Generate a random token:
-
Set the environment variable:
-
Start the server with HTTP transport:
Client usage¶
Clients must include the token in every request:
When to use bearer token¶
- Deployments behind a VPN or firewall
- Docker compose stacks where services communicate internally
- Development and testing environments
- Any scenario where full OIDC is overkill
See also: examples/bearer-auth.env for a ready-to-use example.
OIDC¶
Full OAuth 2.1 authentication using an external identity provider. Supports user login flows, SSO, and multi-user access control.
How it works¶
The server uses FastMCP's built-in OIDCProxy — no external auth sidecar needed:
- Client connects to the server
- Server redirects to the OIDC provider for login
- Provider authenticates the user and returns a code
- Server exchanges the code for tokens
- Subsequent requests include the JWT
Required variables¶
| Variable | Description |
|---|---|
MARKDOWN_VAULT_MCP_BASE_URL |
Public base URL (e.g. https://mcp.example.com) |
MARKDOWN_VAULT_MCP_OIDC_CONFIG_URL |
OIDC discovery endpoint |
MARKDOWN_VAULT_MCP_OIDC_CLIENT_ID |
Client ID registered with your provider |
MARKDOWN_VAULT_MCP_OIDC_CLIENT_SECRET |
Client secret |
Optional variables¶
| Variable | Default | Description |
|---|---|---|
MARKDOWN_VAULT_MCP_OIDC_JWT_SIGNING_KEY |
ephemeral | JWT signing key — required on Linux/Docker |
MARKDOWN_VAULT_MCP_OIDC_AUDIENCE |
— | Expected JWT audience claim; leave unset if your provider does not set one |
MARKDOWN_VAULT_MCP_OIDC_REQUIRED_SCOPES |
openid |
Comma-separated required scopes |
MARKDOWN_VAULT_MCP_OIDC_VERIFY_ACCESS_TOKEN |
false |
Set true to verify the access token as a JWT instead of the id token; useful for audience-claim validation on JWT access tokens |
JWT signing key on Linux/Docker
Without OIDC_JWT_SIGNING_KEY, FastMCP generates an ephemeral key that invalidates all tokens on restart. Always set a stable key in production:
Long-running sessions
Current MCP clients do not reliably refresh tokens — see Known Limitations. Configure all token lifetimes (access, id, refresh) on your identity provider to cover a full workday (8h+). For simpler deployments, bearer token auth is unaffected by these limitations.
Provider guides¶
For step-by-step setup with specific providers:
For the full OIDC reference (env vars, Docker Compose, subpath deployments, architecture):
Troubleshooting¶
"invalid client" error¶
The client_id and/or redirect_uris in your OIDC provider config don't match the values in your .env file. Verify both sides match exactly.
Tokens invalidated after restart¶
You're missing MARKDOWN_VAULT_MCP_OIDC_JWT_SIGNING_KEY. Without it, FastMCP generates an ephemeral key on each startup. Generate and set a stable key:
Auth has no effect¶
Authentication only works with HTTP transport. If you're using --transport stdio, auth is silently ignored. Switch to --transport http.
Bearer token not working¶
- Verify the env var is set and non-empty (whitespace-only values are ignored)
- Check that clients send
Authorization: Bearer <token>(notBasicor other schemes) - If OIDC is also configured, multi-auth is active — both bearer and OIDC are accepted simultaneously
OIDC redirect fails¶
- Verify
BASE_URLmatches your public URL exactly (including any subpath prefix) - For subpath deployments, see the subpath deployment guide —
BASE_URLmust include the prefix,HTTP_PATHmust not - Check that
redirect_urisin your provider config includes your callback URL (e.g.,https://mcp.example.com/auth/callback)
Session drops after token expiry¶
Symptom: the MCP client works for a period (often ~1 hour), then starts returning 401 errors or stops responding. Restarting the client fixes it temporarily.
Root cause: this is almost always a token lifetime issue, not a server bug. Check three things:
-
id_token lifetime (most common): When using
verify_id_tokenmode (the default for Authelia), the server re-validates the upstreamid_tokenon every request. If your provider'sid_tokenlifetime is shorter than theaccess_tokenlifetime, the session dies at theid_tokenexpiry — even though the access token is still valid. Authelia defaultsid_tokento 1 hour. Fix: setid_tokenlifetime to matchaccess_tokenin your provider config. -
access_token lifetime: If both
id_tokenandaccess_tokenare set correctly but sessions still drop, check that the provider'sexpires_inresponse matches your configured lifetime. -
No refresh token: See Known Limitations below — current MCP clients cannot refresh tokens, so sessions are limited to the token lifetime.
Workaround: configure all token lifetimes on your identity provider to cover a full workday:
# Authelia example
lifespans:
custom:
mcp_long_lived:
access_token: '8h'
id_token: '8h' # must match access_token for verify_id_token mode
refresh_token: '30d'
See the Authelia provider guide for the full configuration.
Opaque access tokens (Authelia)¶
Authelia issues opaque (non-JWT) access tokens. This is handled automatically — the server verifies the id_token instead. No extra configuration needed. See the Authelia guide for details.
Known Limitations: MCP OAuth token refresh¶
Ecosystem-wide issue
The limitations below affect all OAuth-protected MCP servers, not just markdown-vault-mcp. They are caused by issues in the MCP client implementations (Claude Code, Claude.ai, Claude Desktop) and the MCP Python SDK. Check the linked tracking issues for current status.
The problem¶
MCP clients cannot maintain sessions beyond the token lifetime because token refresh does not work. When tokens expire, the session drops and requires manual re-authentication. This affects every provider — Authelia, Keycloak, Google, Slack, Notion, Atlassian, and others.
Why refresh doesn't work¶
Three independent issues prevent token refresh:
| Layer | Issue | Impact |
|---|---|---|
| Claude Code | Stores refresh tokens but never uses them (claude-code#21333) | Refresh tokens are obtained and saved but never sent back to refresh expired access tokens |
| Claude Code | Never requests offline_access scope (claude-code#7744) |
Most OIDC providers won't issue a refresh token without this scope |
| MCP Python SDK | Token refresh deadlocks inside SSE streams (python-sdk#1326) | Even with a valid refresh token, the SDK hangs when attempting refresh during an active stream |
The server-side refresh architecture (FastMCP's OAuthProxy.exchange_refresh_token()) is correctly implemented and would work — but it requires the client to initiate the refresh, which none of the current clients do reliably.
What works today¶
Bearer token auth is unaffected by all of the above. If your deployment allows it (e.g., Claude Code with env vars, or API clients), bearer tokens are the simplest and most reliable option.
Long token lifetimes are the only viable workaround for OIDC. Set all three lifetimes (access, id, refresh) to cover your typical session duration:
access_token: '8h'— covers a workdayid_token: '8h'— must match access_token when usingverify_id_tokenmode (critical for Authelia)refresh_token: '30d'— ready for when clients support refresh- Include
offline_accessin provider-side scopes — no effect today, but will enable refresh when clients are fixed
Tracking¶
These upstream issues are actively tracked:
- anthropics/claude-code#21333 — refresh tokens stored but never used
- anthropics/claude-code#7744 —
offline_accessscope never requested - modelcontextprotocol/python-sdk#1326 — SSE refresh deadlock
When these are resolved, OIDC sessions should persist indefinitely via automatic token refresh with no changes needed to markdown-vault-mcp.