Skip to content

🧭 docs: Document defaultDeferLoading Agents Setting #762

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
brenwhyte wants to merge 1 commit into
base: main
Choose a base branch
from
Open

🧭 docs: Document defaultDeferLoading Agents Setting #762

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 26 additions & 0 deletions content/docs/configuration/librechat_yaml/object_structure/agents.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ endpoints:
maxToolCallArgBytesByTool:
create_file: 131072
disableBuilder: false
# (optional) When true, MCP tools newly added to an agent in the Agent Builder start with Defer Loading enabled.
# Requires the "deferred_tools" capability; users can still opt out per tool. Defaults to false.
# defaultDeferLoading: false
# (optional) Agent Capabilities available to all users. Omit the ones you wish to exclude. Defaults to list below.
# Opt-in capabilities: "programmatic_tools", "stateful_code_sessions", "run_in_background", and "tool_intents".
# capabilities: ["deferred_tools", "execute_code", "file_search", "web_search", "artifacts", "subagents", "actions", "context", "skills", "memory", "ask_user_question", "tools", "chain", "ocr"]
Expand Down Expand Up @@ -305,6 +308,29 @@ capabilities:

**Note:** This field is optional. If omitted, the default behavior is to include all the capabilities listed in the default.

## defaultDeferLoading

<OptionTable
options={[
[
'defaultDeferLoading',
'Boolean',
'When set to `true`, MCP tools newly added to an agent in the Agent Builder start with Defer Loading enabled.',
'Applies only when the `deferred_tools` capability is enabled. Tools with saved per-tool options and existing agents are unaffected, and users can still opt out per tool.',
],
]}
/>

**Default:** `false`

**Example:**

```yaml filename="endpoints / agents / defaultDeferLoading"
defaultDeferLoading: true
```

**Note:** This field is optional. If omitted, newly added MCP tools start with Defer Loading off, matching the previous behavior.

## statefulCodeSessions

Configures the sharing scopes and optional execution backends for highly experimental stateful Code Interpreter workspaces.
Expand Down
2 changes: 2 additions & 0 deletions content/docs/features/agents.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,8 @@ This is especially useful when an agent has access to many MCP servers with doze

**Note:** The `deferred_tools` capability is enabled by default. It can be toggled via the [`librechat.yaml` agents configuration](/docs/configuration/librechat_yaml/object_structure/agents#capabilities).

**Defaulting Defer Loading on:** Administrators can set [`defaultDeferLoading: true`](/docs/configuration/librechat_yaml/object_structure/agents#defaultdeferloading) so MCP tools newly added to an agent start with Defer Loading already enabled. The setting requires the `deferred_tools` capability, users can still opt out per tool, and existing agents keep their saved choices.

### Activity Groups

Activity groups collapse each contiguous block of Agent reasoning and tool calls under a generated one-line header, making long runs easier to scan. Administrators enable them with `activityLabel` and can use a faster model, another configured endpoint, a custom prompt, and per-run limits. Header generation is a separate model call whose tokens and cost are recorded. See [Agent Activity Groups](/docs/configuration/librechat_yaml/object_structure/shared_endpoint_settings#agent-activity-groups).
Expand Down