Skip to content

docs: add OAuth headers section #427

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

docs: add OAuth headers section #427

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
15c13a4
add oauth headers sections
ruggishop Oct 8, 2025
940fb4f
update copy
ruggishop Oct 9, 2025
ae7f41e
tweak copy for clarity
ruggishop Oct 9, 2025
5638de0
add trailing period
ruggishop Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions pages/docs/configuration/librechat_yaml/object_structure/mcp_servers.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ mcpServers:
['stderr', 'String or Stream or Number', '(Optional, `stdio` type only) How to handle `stderr` of the child process. Defaults to `"inherit"`.', 'stderr: "inherit"'],
['customUserVars', 'Object', '(Optional) Defines custom variables that users can set for this MCP server, allowing for per-user credentials or configurations (e.g., API keys). These variables can then be referenced in `headers` or `env` fields.', 'customUserVars:\n API_KEY:\n title: "API Key"\n description: "Your personal API key."'],
['oauth', 'Object', '(Optional) OAuth2 configuration for authenticating with the MCP server. When configured, users will be prompted to authenticate via OAuth flow.', 'oauth:\n authorization_url: "https://example.com/oauth/authorize"\n token_url: "https://example.com/oauth/token"'],
['oauth_headers', 'Object', '(Optional) Map of header names and values to be used for OAuth requests (e.g., when registering a new client). Each key-value pair represents a header name and its corresponding value.', 'oauth_headers:\n X-Custom-Header-1: "custom_value_1"\n X-Custom-Header-2: "custom_value_2"'],
['startup', 'Boolean', '(Optional) When set to false, this MCP server will not be connected at application startup.', 'startup: false'],
]}
/>
Expand Down Expand Up @@ -306,6 +307,24 @@ mcpServers:
code_challenge_methods_supported: ["S256", "plain"]
```

#### `oauth_headers`

- **Type:** Object (Optional)
- **Description:** Headers specifically for OAuth flow requests. These headers are **only** used during the OAuth authentication flow (client registration, token exchange, etc.) and **not** during regular MCP server communication.
- **Common Use Cases:**
- Adding authentication to DCR endpoints (e.g., `Authorization: Bearer ${DCR_API_KEY}`)
- Including custom provider-specific headers required for OAuth flows
- Setting content-type or other headers needed for OAuth token endpoints
- **Key Differences from `headers`:**
- **`headers`**: Used for regular MCP server requests (tool calls, server communication) after authentication is complete
- **`oauth_headers`**: Used exclusively during OAuth authentication flows (client registration, token requests)
- **Example:**
```yaml
oauth_headers:
Authorization: "Bearer ${DCR_API_KEY}"
X-Custom-Header: "custom_value"
```

#### `startup`

- **Type:** Boolean (Optional)
Expand Down Expand Up @@ -438,6 +457,8 @@ oauth-api-server:
client_secret: your_client_secret
redirect_uri: http://localhost:3080/oauth/callback
scope: "read execute"
oauth_headers:
X-Custom-Header: "custom_value"
```

### MCP Server with Server Instructions
Expand Down