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>
2.5 KiB
Report sections — sectioned long-form writing plugin example
For the shared edit → test → packaging check → install workflow, see the existing-example guide.
A compact example of a stateful model tool: the agent writes a 万字-scale
long report section by section with save_section, and a final
section_index=999 call assembles every stored section into one markdown
document. The assembled report is returned as a tool artifact (visible in the
UI) with only a short status summary re-entering the model context, so the
full document never consumes the agent's 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 produces doubled headings across
the whole report. Sections are scoped per user and per thread in the plugin's
own SQLite file — no host database or host-internal imports.
Deployment
Install this directory using the existing trusted Python extension manager.
From backend/:
uv run deerflow extensions install ../examples/deerflow-extension-report-sections --yes
Then set the deployment-owned config on the registered plugin entry before
restarting Gateway. Example configuration:
plugins:
- use: deerflow_extension_report_sections:install
enabled: true
config:
enabled: true
storage_path: /var/lib/deerflow/report-sections.sqlite
The outer enabled controls package loading; config.enabled controls the
tool contribution. Mount a persistent writable directory for storage_path.
The file stores user section data, not deployment settings.
Tool contract
save_section(section_index, title, content):
section_index=0— store the outline (passed through unwrapped on assembly).1..N— store one chapter (keep each call within roughly 1200–2000 characters to stay inside the per-completion output budget; hard cap 24000).999withtitle="__assemble__"— assemble all stored sections intoreport-<topic>.md, delivered as an artifact. Assemblies over 60 KiB are refused with a clear status; the sections remain stored.
The tool result envelope is capped at 64 KiB by the host; this example keeps the model-visible content to one status line and carries the document in the artifact.
Tests
From the DeerFlow checkout root with the backend environment prepared:
uv run --project backend --no-sync python -m pytest backend/tests/test_report_sections_extension.py -q