# DeerFlow

## Docs

- [Code Style Guide](https://mintlify.wiki/bytedance/deer-flow/advanced/code-style.md): Python code style guidelines, Ruff configuration, and formatting standards for DeerFlow development
- [Context Engineering](https://mintlify.wiki/bytedance/deer-flow/advanced/context-engineering.md): Summarization, context management, token limits, and isolated sub-agent contexts
- [Contributing to DeerFlow](https://mintlify.wiki/bytedance/deer-flow/advanced/contributing.md): Learn how to contribute to DeerFlow with development setup, workflow guidelines, and pull request process
- [Debugging Guide](https://mintlify.wiki/bytedance/deer-flow/advanced/debugging.md): Debugging techniques, logging strategies, common issues, and development tools for troubleshooting DeerFlow
- [Middleware Chain](https://mintlify.wiki/bytedance/deer-flow/advanced/middleware-chain.md): Deep dive into DeerFlow's 11-middleware execution pipeline
- [Model Factory](https://mintlify.wiki/bytedance/deer-flow/advanced/model-factory.md): Dynamic model instantiation with reflection, thinking/vision support, and runtime configuration
- [Reflection System](https://mintlify.wiki/bytedance/deer-flow/advanced/reflection-system.md): Dynamic module loading with resolve_variable() and resolve_class()
- [Testing Guide](https://mintlify.wiki/bytedance/deer-flow/advanced/testing.md): Comprehensive guide to test-driven development, running tests, and writing effective tests for DeerFlow
- [Thread State](https://mintlify.wiki/bytedance/deer-flow/advanced/thread-state.md): ThreadState schema, custom reducers, and state management patterns
- [Custom Agents API](https://mintlify.wiki/bytedance/deer-flow/api/gateway/agents.md): Create and manage custom agents with SOUL.md profiles
- [Artifacts API](https://mintlify.wiki/bytedance/deer-flow/api/gateway/artifacts.md): Access and download thread artifacts and generated files
- [MCP API](https://mintlify.wiki/bytedance/deer-flow/api/gateway/mcp.md): Manage Model Context Protocol (MCP) server configurations
- [Memory API](https://mintlify.wiki/bytedance/deer-flow/api/gateway/memory.md): Access and manage global memory data for personalized conversations
- [Models API](https://mintlify.wiki/bytedance/deer-flow/api/gateway/models.md): Query and retrieve available AI models and their configurations
- [Gateway API Overview](https://mintlify.wiki/bytedance/deer-flow/api/gateway/overview.md): Introduction to the DeerFlow Gateway API, authentication, and common patterns
- [Skills API](https://mintlify.wiki/bytedance/deer-flow/api/gateway/skills.md): Manage skills and their enabled status
- [Uploads API](https://mintlify.wiki/bytedance/deer-flow/api/gateway/uploads.md): Upload and manage user files for threads
- [LangGraph Server Overview](https://mintlify.wiki/bytedance/deer-flow/api/langgraph/overview.md): Introduction to DeerFlow's LangGraph Server API for agent interactions
- [Streaming Responses](https://mintlify.wiki/bytedance/deer-flow/api/langgraph/streaming.md): Stream agent responses in real-time using Server-Sent Events
- [Thread Management](https://mintlify.wiki/bytedance/deer-flow/api/langgraph/threads.md): Create and manage conversation threads with the LangGraph API
- [Chat Method](https://mintlify.wiki/bytedance/deer-flow/api/python-client/chat.md): Send a message and receive a complete response
- [Configuration Methods](https://mintlify.wiki/bytedance/deer-flow/api/python-client/configuration.md): Manage models, skills, memory, and files
- [Python Client Overview](https://mintlify.wiki/bytedance/deer-flow/api/python-client/overview.md): Embedded Python client for DeerFlow agent system
- [Stream Method](https://mintlify.wiki/bytedance/deer-flow/api/python-client/streaming.md): Stream conversation events in real-time
- [Built-in Tools](https://mintlify.wiki/bytedance/deer-flow/api/tools/built-in.md): Core agent tools for file presentation, clarification, and image viewing
- [Community Tools](https://mintlify.wiki/bytedance/deer-flow/api/tools/community.md): Third-party integrations for web search, content fetching, and image search
- [Sandbox Tools](https://mintlify.wiki/bytedance/deer-flow/api/tools/sandbox.md): File system and command execution tools for the agent sandbox environment
- [Sub-Agent Tools](https://mintlify.wiki/bytedance/deer-flow/api/tools/sub-agents.md): Delegate complex tasks to specialized sub-agents for isolated context execution
- [Agent System](https://mintlify.wiki/bytedance/deer-flow/concepts/agent-system.md): Lead agent, ThreadState, and middleware chain
- [Architecture](https://mintlify.wiki/bytedance/deer-flow/concepts/architecture.md): DeerFlow system architecture and component overview
- [Memory](https://mintlify.wiki/bytedance/deer-flow/concepts/memory.md): Long-term memory with fact extraction and context management
- [Sandbox](https://mintlify.wiki/bytedance/deer-flow/concepts/sandbox.md): Isolated execution environment with filesystem access
- [Skills](https://mintlify.wiki/bytedance/deer-flow/concepts/skills.md): Extensible capability modules with progressive loading
- [Sub-agents](https://mintlify.wiki/bytedance/deer-flow/concepts/sub-agents.md): Delegate complex tasks to specialized sub-agents
- [Tools](https://mintlify.wiki/bytedance/deer-flow/concepts/tools.md): Built-in tools, MCP integration, and community tools
- [Environment Variables](https://mintlify.wiki/bytedance/deer-flow/configuration/environment-variables.md): Complete reference of environment variables used by DeerFlow for configuration and runtime behavior
- [Memory Configuration](https://mintlify.wiki/bytedance/deer-flow/configuration/memory.md): Configure DeerFlow's memory system for persistent context and personalized agent interactions
- [Models Configuration](https://mintlify.wiki/bytedance/deer-flow/configuration/models.md): Configure LLM models, providers, API keys, and advanced features like thinking and vision support
- [Configuration Overview](https://mintlify.wiki/bytedance/deer-flow/configuration/overview.md): Understanding DeerFlow's configuration system, file locations, and priority order
- [Sandbox Modes](https://mintlify.wiki/bytedance/deer-flow/configuration/sandbox-modes.md): Configure sandbox execution environments - local, Docker, or Kubernetes-based isolation
- [Skills & MCP Configuration](https://mintlify.wiki/bytedance/deer-flow/configuration/skills-and-mcp.md): Configure skills and Model Context Protocol (MCP) servers for extended agent capabilities
- [Docker Deployment](https://mintlify.wiki/bytedance/deer-flow/deployment/docker.md): Deploy DeerFlow using Docker and Docker Compose with production-ready configuration
- [Kubernetes Deployment](https://mintlify.wiki/bytedance/deer-flow/deployment/kubernetes.md): Deploy DeerFlow on Kubernetes with the provisioner service for isolated pod-based sandboxes
- [Production Deployment](https://mintlify.wiki/bytedance/deer-flow/deployment/production.md): Production-ready deployment guide with security, scaling, monitoring, and backup strategies
- [Creating Skills](https://mintlify.wiki/bytedance/deer-flow/guides/creating-skills.md): Extend DeerFlow with custom skills for specialized workflows
- [Custom Tools](https://mintlify.wiki/bytedance/deer-flow/guides/custom-tools.md): Add custom tools to extend DeerFlow's capabilities
- [Docker Setup](https://mintlify.wiki/bytedance/deer-flow/guides/docker-setup.md): Set up DeerFlow using Docker for a consistent development environment
- [File Uploads](https://mintlify.wiki/bytedance/deer-flow/guides/file-uploads.md): Upload and process files in DeerFlow conversations
- [Installation](https://mintlify.wiki/bytedance/deer-flow/guides/installation.md): Install DeerFlow and set up your development environment
- [Local Development](https://mintlify.wiki/bytedance/deer-flow/guides/local-development.md): Run DeerFlow services locally without Docker for maximum control
- [MCP Servers](https://mintlify.wiki/bytedance/deer-flow/guides/mcp-servers.md): Integrate external tools using the Model Context Protocol
- [Plan Mode](https://mintlify.wiki/bytedance/deer-flow/guides/plan-mode.md): Enable task tracking with TodoList for complex multi-step workflows
- [Introduction to DeerFlow](https://mintlify.wiki/bytedance/deer-flow/introduction.md): An open-source super agent harness built on LangGraph that orchestrates sub-agents, memory, and sandboxes to do almost anything
- [Quick Start Guide](https://mintlify.wiki/bytedance/deer-flow/quickstart.md): Get DeerFlow running in minutes with Docker or local development setup
- [Common Issues](https://mintlify.wiki/bytedance/deer-flow/troubleshooting/common-issues.md): Solutions to frequently encountered installation, configuration, and setup problems
- [Model Configuration Issues](https://mintlify.wiki/bytedance/deer-flow/troubleshooting/model-configuration.md): Solutions for API keys, model loading, and LLM provider configuration problems
- [Performance Optimization](https://mintlify.wiki/bytedance/deer-flow/troubleshooting/performance.md): Improve memory usage, context window management, sandbox performance, and scaling
- [Sandbox Errors](https://mintlify.wiki/bytedance/deer-flow/troubleshooting/sandbox-errors.md): Solutions for Docker containers, path mapping, and sandbox execution issues