35d0dcd6f2
* feat(plugins): add sectioned long-form report writing example A standalone example extension whose save_section model tool stores a 万字-scale report section by section (SQLite, per-user and per-thread) and assembles every section into one markdown document on a final section_index=999 call. The assembled document is returned as a tool artifact with only a short status line re-entering the model context, so the full report never consumes the context budget. Assembly drops a section's leading heading when it restates the section title (models habitually open each section with '# <title>' while the assembler already emits '## <title>'), which otherwise doubles every heading in the document. The outline section passes through unwrapped and keeps its own heading as the document title. * fix(frontend): register report sections in extension catalog * docs(report-sections): correct the test command path --------- Co-authored-by: Willem Jiang <willem.jiang@gmail.com>
3.6 KiB
Develop an extension from an existing example
Start with the smallest example that covers your extension. Each directory is an
independent Python package using the public deerflow-extension-api contract.
| Start here | What it demonstrates |
|---|---|
| Extension example | Middleware, task lifecycle, model observations, services, and HTTP routes. Start here for backend extensions. |
| Conversation bookmarks | A browser page, conversation action, backend actions, packaged resources, and a model tool. Start here for full-stack plugins. |
| Agent teams | Full Agent orchestration. Use this after the basic contribution and lifecycle patterns are familiar. |
Additional examples cover text-list classification, context pruning, advisory screening of fetched content, and sectioned long-form report writing.
Edit, test, check, then install
-
Copy the selected example outside the DeerFlow checkout. Rename its Python package, distribution and
deerflow.extensionsentry point. For a full-stack plugin, also choose its own namespace and browser module name. -
Follow the example's README to configure its dependencies and run its tests. Keep package behavior tests alongside the extension.
-
From the DeerFlow checkout root, prepare the backend environment with
make -C backend install, then check the package:uv run --project backend --no-sync python scripts/check_extension.py /absolute/path/to/your-extensionTo try the checker on an unchanged example:
uv run --project backend --no-sync python scripts/check_extension.py examples/deerflow-extension-bookmarks -
Follow that example's deployment and try-it instructions. Restart Gateway, refresh the browser when applicable, and exercise the installed feature. Use
make extension-upgrade SOURCE=/absolute/path/to/your-extensionto apply later source edits: local installs are snapshots.
What the checker covers
The script builds a wheel in a temporary directory, checks exactly one extension
entry point and its packaged Python module, parses packaged Python syntax, and
checks that the API dependency range accepts this checkout's contract version.
It validates conventional ui_manifest.json resources with the same validator
used by Gateway, including detecting manifests left out of the wheel in flat or
src/ layouts. A custom manifest filename needs an explicit wheel-relative path:
uv run --project backend --no-sync python scripts/check_extension.py /absolute/path/to/your-extension --manifest your_package/resources.json
The build executes the package's build backend, so check trusted sources. The
checker does not import the extension, call install(), install the extension, or
change deployment configuration. Registration/configuration behavior and the
@extension version marker are verified when loading the plugin; continue to run
the package tests and the installed feature after packaging checks pass.