mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-05-22 16:06:50 +00:00
3e6a34297d
Squashes 25 PR commits onto current main. AppConfig becomes a pure value object with no ambient lookup. Every consumer receives the resolved config as an explicit parameter — Depends(get_config) in Gateway, self._app_config in DeerFlowClient, runtime.context.app_config in agent runs, AppConfig.from_file() at the LangGraph Server registration boundary. Phase 1 — frozen data + typed context - All config models (AppConfig, MemoryConfig, DatabaseConfig, …) become frozen=True; no sub-module globals. - AppConfig.from_file() is pure (no side-effect singleton loaders). - Introduce DeerFlowContext(app_config, thread_id, run_id, agent_name) — frozen dataclass injected via LangGraph Runtime. - Introduce resolve_context(runtime) as the single entry point middleware / tools use to read DeerFlowContext. Phase 2 — pure explicit parameter passing - Gateway: app.state.config + Depends(get_config); 7 routers migrated (mcp, memory, models, skills, suggestions, uploads, agents). - DeerFlowClient: __init__(config=...) captures config locally. - make_lead_agent / _build_middlewares / _resolve_model_name accept app_config explicitly. - RunContext.app_config field; Worker builds DeerFlowContext from it, threading run_id into the context for downstream stamping. - Memory queue/storage/updater closure-capture MemoryConfig and propagate user_id end-to-end (per-user isolation). - Sandbox/skills/community/factories/tools thread app_config. - resolve_context() rejects non-typed runtime.context. - Test suite migrated off AppConfig.current() monkey-patches. - AppConfig.current() classmethod deleted. Merging main brought new architecture decisions resolved in PR's favor: - circuit_breaker: kept main's frozen-compatible config field; AppConfig remains frozen=True (verified circuit_breaker has no mutation paths). - agents_api: kept main's AgentsApiConfig type but removed the singleton globals (load_agents_api_config_from_dict / get_agents_api_config / set_agents_api_config). 8 routes in agents.py now read via Depends(get_config). - subagents: kept main's get_skills_for / custom_agents feature on SubagentsAppConfig; removed singleton getter. registry.py now reads app_config.subagents directly. - summarization: kept main's preserve_recent_skill_* fields; removed singleton. - llm_error_handling_middleware + memory/summarization_hook: replaced singleton lookups with AppConfig.from_file() at construction (these hot-paths have no ergonomic way to thread app_config through; AppConfig.from_file is a pure load). - worker.py + thread_data_middleware.py: DeerFlowContext.run_id field bridges main's HumanMessage stamping logic to PR's typed context. Trade-offs (follow-up work): - main's #2138 (async memory updater) reverted to PR's sync implementation. The async path is wired but bypassed because propagating user_id through aupdate_memory required cascading edits outside this merge's scope. - tests/test_subagent_skills_config.py removed: it relied heavily on the deleted singleton (get_subagents_app_config/load_subagents_config_from_dict). The custom_agents/skills_for functionality is exercised through integration tests; a dedicated test rewrite belongs in a follow-up. Verification: backend test suite — 2560 passed, 4 skipped, 84 failures. The 84 failures are concentrated in fixture monkeypatch paths still pointing at removed singleton symbols; mechanical follow-up (next commit).
157 lines
6.9 KiB
Plaintext
157 lines
6.9 KiB
Plaintext
---
|
|
title: Lead Agent
|
|
description: The Lead Agent is the central executor in a DeerFlow thread. Every conversation, task, and workflow flows through it. Understanding how it works helps you configure it effectively and extend it when needed.
|
|
---
|
|
|
|
import { Callout, Cards, Steps } from "nextra/components";
|
|
|
|
# Lead Agent
|
|
|
|
<Callout type="info" emoji="🧠">
|
|
The Lead Agent is the primary reasoning and orchestration unit in every
|
|
DeerFlow thread. It decides what to do, calls tools, delegates to subagents,
|
|
and returns artifacts.
|
|
</Callout>
|
|
|
|
The Lead Agent is the central executor in a DeerFlow thread. Every conversation, task, and workflow flows through it. Understanding how it works helps you configure it effectively and extend it when needed.
|
|
|
|
## What the Lead Agent does
|
|
|
|
The Lead Agent is responsible for:
|
|
|
|
- receiving user messages and maintaining conversation state,
|
|
- reasoning about what to do next (planning, tool selection, delegation),
|
|
- calling tools — built-in, community, MCP, or skill tools,
|
|
- delegating subtasks to subagents via the `task` tool,
|
|
- managing artifacts (files, outputs, deliverables),
|
|
- updating the todo list in plan mode, and
|
|
- returning final responses or artifacts to the user.
|
|
|
|
The Lead Agent does not hardcode a specific workflow. It uses the model's reasoning to adapt to whatever task the user provides, guided by the system prompt and the skills currently in scope.
|
|
|
|
## Runtime foundation
|
|
|
|
The Lead Agent is built on **LangGraph** and **LangChain Agent** primitives. Specifically:
|
|
|
|
- [`create_agent`](https://python.langchain.com/docs/concepts/agents/) from `langchain.agents` wraps the LLM into a tool-calling agent loop.
|
|
- LangGraph manages the `ThreadState` and provides the checkpointing, streaming, and graph execution model.
|
|
- A **middleware chain** wraps every turn of the agent loop, providing cross-cutting capabilities like memory, summarization, and clarification.
|
|
|
|
## Execution flow
|
|
|
|
<Steps>
|
|
|
|
### Receive message
|
|
|
|
The user message arrives and is added to `ThreadState.messages`. The `ThreadState` holds the full conversation history, any active todo list, accumulated artifacts, and runtime metadata.
|
|
|
|
### Middleware pre-processing
|
|
|
|
Before the model is called, each active middleware has a chance to modify the state. For example, the `MemoryMiddleware` injects persisted memory facts into the system prompt, and the `SummarizationMiddleware` may condense old messages if the token budget is exceeded.
|
|
|
|
### LLM reasoning
|
|
|
|
The model receives the current messages (including system prompt with active skill instructions) and produces either a direct reply or one or more tool call requests.
|
|
|
|
### Tool execution
|
|
|
|
If tool calls are requested, they are dispatched to the appropriate handlers — sandbox tools for file and command work, community tools for web access, or the `task` tool for subagent delegation.
|
|
|
|
### Middleware post-processing
|
|
|
|
After tool results are returned and before the next model call, middlewares run again. The `TitleMiddleware` may generate a thread title on the first exchange, and the `TodoMiddleware` may update the task list.
|
|
|
|
### Loop or respond
|
|
|
|
If the model needs more information (e.g., a tool returned partial results), the loop continues. When the model decides the task is complete, it produces a final message and the loop ends.
|
|
|
|
### State update
|
|
|
|
`ThreadState` is updated with new messages, artifacts, and memory queues. If a checkpointer is configured, the state is persisted.
|
|
|
|
</Steps>
|
|
|
|
## Model selection
|
|
|
|
The Lead Agent resolves which model to use at runtime using the following priority order:
|
|
|
|
1. `model_name` (or `model`) from the per-request configuration, if provided and valid.
|
|
2. The `model` field of the active custom agent's config, if an agent is specified.
|
|
3. The first model in the `models:` list in `config.yaml` (the global default).
|
|
|
|
If the requested model name is not found in the config, the system falls back to the default model and logs a warning.
|
|
|
|
```yaml
|
|
models:
|
|
- name: my-primary-model
|
|
use: langchain_openai:ChatOpenAI
|
|
model: gpt-4o
|
|
api_key: $OPENAI_API_KEY
|
|
request_timeout: 600.0
|
|
max_retries: 2
|
|
supports_vision: true
|
|
|
|
- name: my-fast-model
|
|
use: langchain_openai:ChatOpenAI
|
|
model: gpt-4o-mini
|
|
api_key: $OPENAI_API_KEY
|
|
```
|
|
|
|
The first entry (`my-primary-model`) becomes the default. Any request that does not specify a model, or specifies an unknown model name, will use it.
|
|
|
|
## Thinking mode
|
|
|
|
If the model supports extended thinking (e.g., DeepSeek Reasoner, Doubao with thinking enabled, Anthropic Claude with thinking), the Lead Agent can run in **thinking mode**. In this mode, the model's internal reasoning steps are visible in the response stream.
|
|
|
|
Thinking mode is controlled per-request through the `thinking_enabled` flag. If thinking is enabled but the configured model does not support it, the system falls back gracefully and logs a warning.
|
|
|
|
```yaml
|
|
models:
|
|
- name: deepseek-v3
|
|
use: deerflow.models.patched_deepseek:PatchedChatDeepSeek
|
|
model: deepseek-reasoner
|
|
api_key: $DEEPSEEK_API_KEY
|
|
supports_thinking: true
|
|
when_thinking_enabled:
|
|
extra_body:
|
|
thinking:
|
|
type: enabled
|
|
when_thinking_disabled:
|
|
extra_body:
|
|
thinking:
|
|
type: disabled
|
|
```
|
|
|
|
## Plan mode
|
|
|
|
When `is_plan_mode` is set to `true` in the request configuration, the `TodoMiddleware` is activated. The agent then maintains a structured task list, marking items as `in_progress`, `completed`, or `pending` as it works through a complex task. This provides visibility into the agent's progress for the user.
|
|
|
|
Plan mode is appropriate for complex, multi-step tasks where showing incremental progress is valuable. For simple requests, it is better left disabled to avoid unnecessary overhead.
|
|
|
|
## Custom agents
|
|
|
|
The same Lead Agent runtime powers both the default agent and any custom agents you create. A custom agent differs only in:
|
|
|
|
- its **name** (ASCII slug, auto-derived from `display_name`),
|
|
- its **system prompt** or agent-specific instructions,
|
|
- which **skills** it has access to,
|
|
- which **tool groups** it can use, and
|
|
- which **model** it defaults to.
|
|
|
|
Custom agents are created through the DeerFlow App UI or via the `/api/agents` endpoint. Their configuration is stored in `agents/{name}/config.yaml` relative to the backend directory.
|
|
|
|
<Callout type="tip">
|
|
When a custom agent is selected in a thread, the Lead Agent loads that
|
|
agent's config at runtime. Switching models or skills for a specific agent
|
|
does not require restarting the server.
|
|
</Callout>
|
|
|
|
## Bootstrap mode
|
|
|
|
DeerFlow includes a special **bootstrap mode** for the initial setup of custom agents. When `is_bootstrap: true` is passed in the request config, the Lead Agent runs with a minimal system prompt and only the core setup tools exposed. This is used internally to guide the first-run agent configuration flow.
|
|
|
|
<Cards num={2}>
|
|
<Cards.Card title="Middlewares" href="/docs/harness/middlewares" />
|
|
<Cards.Card title="Tools" href="/docs/harness/tools" />
|
|
</Cards>
|