- 复制 reader-digest-flow skill 到 skills/ 目录(含 SKILL.md + references/) - README 新增 Agent Skill 章节说明供 Agent 使用的工作流
15 KiB
Reader Digest Flow Reference
Purpose
Concrete operational checklist for the reader-digest-flow skill.
Default Operating Model
Layering
readerlayer:- FreshRSS pull
- extraction
- summary/filter/payload generation
- selected-article summary capability
- OpenClaw / skill layer:
- public digest generation
- internal review digest generation
- Hugo publishing
- chat reporting
- user confirmation handling
- calling selected-article summaries
- IMA upload orchestration
- Hugo layer:
- public digest browsing and archive only
- IMA layer:
- long-term storage for selected article notes only
Hard rules
- Do not upload the full digest to IMA.
- Upload only explicitly user-selected articles to IMA.
- Do not generate a digest without a real payload.
- Generate two views from the same payload: a public digest for Hugo and an internal review digest for chat/operator workflow.
- Do not expose internal review states or operator-facing labels in the public digest.
- Do not re-fetch original URLs for selected summaries; use existing extracted text.
- If the main pipeline fails, inspect the run first; when
inspect_resume_plansaysrecommended_action=resume, continue via the async resume job path instead of stopping immediately. - Always branch on reader's top-level reconciled
status; treatstatus_sourceandstate_conflictonly as explanatory metadata. - Prefer
ARTICLE_SUMMARY_*for selected article summarization, with fallback to mainLLM_*only if needed. - Actively report progress after each completed phase.
Step-by-step checklist
1. Run reader pipeline
Use the formal MCP workflow path as the default production route. Prefer MCP run/status/result operations over direct path stitching. Only fall back to CLI or direct file inspection for debug / manual troubleshooting.
Formal production startup sequence:
start_freshrss_pipeline_jobget_freshrss_pipeline_job_statusget_freshrss_pipeline_job_result- after success, continue with
run_idviaget_run_status/get_delivery_payload/get_run_report
If the main pipeline job ends in failed:
- inspect the linked run with
get_run_status - call
inspect_resume_plan(run_id) - if
recommended_action=resume, continue with:start_resume_jobget_resume_job_statusget_resume_job_result
- if
recommended_action=read_terminal_result, continue from the terminal run result - if
recommended_action=start_new_run, stop and report the failure
Treat the old synchronous run_freshrss_openclaw_pipeline as debug / light validation / fallback only.
Project root:
/home/ubuntu/zhu/github/reader
Default behavior for a normal production run:
- if the user did not specify a count, randomly choose a limit between 5 and 10 items for that run
- run with mark-read enabled
- do not enable
debug_artifacts - only skip mark-read if the user explicitly says the run is debug, test, or validation
- only enable
debug_artifactsif the user explicitly says the run is debug, test, validation, or troubleshooting
Typical artifacts to inspect after a successful run:
outputs/freshrss/rerun/<run-id>/candidates/openclaw-delivery-payload.json
outputs/freshrss/rerun/<run-id>/candidates/digest-brief.json
outputs/freshrss/rerun/<run-id>/run-report.json
outputs/freshrss/rerun/<run-id>/extracted/item-XX.extracted.json
Notes:
digest-brief.jsonis the preferred input for public digest generation.- It is a lighter public-only view and currently includes only
keepcandidates. - If
digest-brief.jsonis missing, fall back toopenclaw-delivery-payload.json. - If the synchronous MCP wrapper times out but a real reader run was still created, do not discard the run; continue from run truth using
list_runs,get_run_report, andget_delivery_payload.
⚠️ Output path divergence when run from Feishu context:
When triggered via MCP from inside a Feishu session, the extracted files may be written to an MCP-managed temp path instead of outputs/freshrss/rerun/<run-id>/extracted/. Verify the actual output path from the pipeline result before continuing to Phase 5/6. If the project-relative path doesn't exist, use the MCP result's extracted_path directly or copy the files to the expected project location.
2. Generate digest markdown
Generate two output views from the same run, preferably in one model call:
- a public digest for Hugo / public readers
- an internal review digest for chat / operator workflow
Input preference:
- public digest: prefer
candidates/digest-brief.json - internal review digest: use
candidates/openclaw-delivery-payload.json
Recommended generation pattern:
- Pass the public brief and the full payload as two explicitly labeled input blocks.
- Ask the model to return both outputs in one response.
- Prefer a structured response shape (for example JSON with
public_digest_markdownandinternal_review_digest_markdown) when post-processing is needed.
Before publishing, persist the generated digest artifacts back into the same reader run directory:
outputs/freshrss/rerun/<run-id>/digest/public_digest.md
outputs/freshrss/rerun/<run-id>/digest/internal_review_digest.md
outputs/freshrss/rerun/<run-id>/digest/combined.json
Then write only the public digest into Hugo here:
/home/ubuntu/zhu/apps/hugo-site/content/daily/YYYY-MM-DD/index.md
Recommended public-digest front matter:
+++
title = "AI 日报 · YYYY-MM-DD"
date = YYYY-MM-DDTHH:MM:SS+08:00
summary = "当日日报摘要"
+++
Recommended public digest structure:
今日概览今日重点趋势观察延伸阅读
Public digest constraints:
- Use only the public brief view when present.
- Keep public wording free of internal workflow language.
- Optimize for concise public readability with solid information density.
- For each
今日重点item, add one short editor-style sentence explaining why the item matters in today's digest (for example:这篇内容更值得关注的原因在于……). - Prefer rendering highlight points as a short public label such as
值得关注:followed by one bullet per line. - Article numbering: MUST use
1.2.3.(Arabic numeral + period). Do NOT use① ② ③,一、二、三,第一条or any other variant. - All four sections are required. Missing any one is a format violation.
- Hugo digest must include ALL keep articles from
digest-brief.json. The IMA deposition subset is a separate downstream step.
Recommended internal review digest structure:
今日候选概况已入选重点待你确认建议沉淀到 IMA原始候选清单
Internal review digest constraints:
- Do not show
rankvalues. - Replace machine states with Chinese labels such as
已入选/待确认/暂不纳入. - For
已入选重点, include a fuller summary plus a short judgment paragraph. - For
待你确认, include a fuller summary, reason, and recommendation. - Keep it readable as an operator review draft, not a raw payload dump.
- Feishu compatibility: never use markdown tables in the digest report.
When delivered via Feishu, a single table forces the whole message to plain
text. Use lists and sections instead. See
references/feishu-format-notes.md.
3. Publish Hugo
Publish only the public digest to Hugo. Treat Hugo publication as the default continuation of a successful normal daily digest run. Do not ask for a second confirmation before generating/writing the public digest and publishing it, unless the user explicitly requests not to publish to Hugo.
⚠️ Hugo redeploy: always use foreground terminal, never background+notify_on_complete.
The Hugo redeploy runs via ./redeploy.sh and completes in ~10 seconds. Do NOT use terminal(background=true, notify_on_complete=true) for this step — the Gateway will push the raw Docker build output (compiler logs, layered build output, nginx config) to Feishu as a notification. This output is machine-readable, not human-readable, and the user has explicitly said this is noise.
Correct approach:
# ✅ Foreground terminal with adequate timeout
cmd = "cd /home/ubuntu/zhu/apps/hugo-site && ./redeploy.sh"
result = terminal(cmd, timeout=120)
# Then verify 200 OK on the detail page
Wrong approach (DO NOT use):
# ❌ Background + notify sends raw build logs to Feishu
terminal("cd /home/ubuntu/zhu/apps/hugo-site && ./redeploy.sh", background=True, notify_on_complete=True)
This rule only applies to Hugo redeploy (fast, deterministic output). For long-running Reader pipeline jobs (>60s), background + notify_on_complete is still appropriate since the output is meaningful content (article summaries, pipeline stats).
-
Pre-check: verify Hugo content directory exists
ls -d /home/ubuntu/zhu/apps/hugo-site/content/daily/ 2>/dev/null || mkdir -p /home/ubuntu/zhu/apps/hugo-site/content/daily/If the entire
content/directory is missing, create it before proceeding. Do not assume the Hugo site has a standard structure. -
write the public digest markdown to:
/home/ubuntu/zhu/apps/hugo-site/content/daily/YYYY-MM-DD/index.md
-
redeploy Hugo immediately after writing:
cd /home/ubuntu/zhu/apps/hugo-site && ./redeploy.sh
-
verify all three URLs before continuing:
http://127.0.0.1:14322/http://127.0.0.1:14322/daily/http://127.0.0.1:14322/daily/YYYY-MM-DD/
Expected verification targets:
- homepage works
/daily/works/daily/YYYY-MM-DD/works
4. Report digest in chat
Provide the internal review digest in chat and ask which articles should be retained.
Hard reporting rule:
- do not send only article titles
- for each article, include at least a one-sentence summary and a short recommendation / judgment so the user can decide without reopening the source
- Feishu: avoid markdown tables entirely. Use lists with headings.
5. Generate selected article summaries
Only do this after the user explicitly confirms which articles to retain.
Preferred MCP path:
start_article_summary_jobget_article_summary_job_statusget_article_summary_job_result
Expected inputs:
extracted_pathselected_ids⚠️ item_id 前缀注意: Thecandidatesarray IDs usecand:sha256:xxxformat, but individual extracted item files usesha256:xxx(nocand:prefix). When passingselected_idsto article-summary tools, strip thecand:prefix. If the ID doesn't match, the summary tool won't find the article.
Path resolution for article-summary:
After a pipeline run via MCP (Feishu context), the extracted files may live at an MCP-managed temp path, not the expected outputs/freshrss/rerun/<run-id>/extracted/. Before calling generate_article_summaries or start_article_summary_job, verify the extracted path exists. If not, use the run_id from the pipeline result to locate the actual output directory through get_run_report, or copy the files from the MCP-managed path.
Single-item rule:
- when
extracted_pathisoutputs/freshrss/rerun/<run-id>/extracted/item-XX.extracted.json, call one summary job per file - in that case,
selected_idsshould contain only the matching singleitem_id - if the candidate ID came from the delivery payload, strip the
cand:prefix before passing it
Recommended output layout:
outputs/freshrss/single_summaries/YYYY-MM-DD/- async job state:
outputs/freshrss/article_summary_jobs/<job_id>/
Recommended production sequence:
- call
start_article_summary_job - poll
get_article_summary_job_statusuntilstatusbecomessuccessorfailed - on success, call
get_article_summary_job_resultand continue downstream fromwritten_paths
Hard fallback rule:
- If the async MCP job path returns timeout / transport failure / job-launch failure (for example MCP timeout while the reader article-summary workflow itself is still healthy), do not treat that as article-summary business failure.
- Immediately retry through the local reader environment under
/home/ubuntu/zhu/github/readerusing the project.venv, calling the article-summary workflow directly. - The production goal is successful generation of the selected-article Markdown files; async MCP job is preferred, but local
.venvexecution is the required fallback path.
Synchronous helper:
generate_article_summariesremains available for debug / light validation only, not as the default production path.
CLI fallback:
python scripts/run_article_summaries.py \
--extracted outputs/freshrss/rerun/<run-id>/extracted/item-01.extracted.json \
--ids <item_id_without_cand_prefix> \
--output-dir outputs/freshrss/single_summaries/YYYY-MM-DD
6. Upload selected summaries to IMA
Upload only the generated markdown files for the selected articles. Once the user has selected the articles to retain, treat that selection itself as the authorization to continue the IMA deposition step; do not ask for a second confirmation about uploading into the knowledge base.
⚠️ IMA upload 500 retry: Always wrap IMA uploads in a retry loop.
IMA's OpenAPI may return HTTP 500 on the first attempt. If the first upload fails, wait ~3 seconds and retry. Normally the second attempt succeeds. If cos-upload.cjs is used (for CDN-backed uploads), check subprocess stderr even when exit code is 0 — an HTTP error in the upload service may still produce exit code 0.
Hard execution rules before upload:
- reformat/check the generated markdown into IMA-facing final content
- normalize the final upload filename to
<文章标题>.md - do not use internal temp names such as
ima-*,item-*,summary-*, or English slug filenames as the final uploaded object name - if the knowledge base already contains the same filename, append a timestamp suffix before
.md - if local work needs internal temp names, create a final upload copy with the user-facing title before calling IMA APIs
Default target knowledge base:
daily- Read
IMA_DAILY_KNOWLEDGE_BASE_ID/IMA_DAILY_KNOWLEDGE_BASE_NAMEfrom reader.env - Verify the configured target at runtime before upload
- If the configured target is unavailable, resolve by name
daily; if still absent, createdaily
Hard rules recap
- Never generate a digest from placeholder or example data when a real run is expected.
- For normal runs, mark processed FreshRSS items as read unless the user explicitly requested a debug/test/validation run.
- Public digest goes to Hugo; internal review digest goes to chat; neither full digest goes to IMA.
- Only explicitly user-selected articles go to IMA.
- All daily IMA deposition must go directly into the IMA knowledge-base path as Markdown knowledge items (
media_type=7), not through the IMA notes path. - Uploading to IMA notes, or creating notes first and then linking them into a knowledge base, does not count as SOP completion.
- Selected article summaries use extracted text, not live refetch.
- Prefer
ARTICLE_SUMMARY_*for selected article summarization. - Final IMA upload filenames must use user-facing article titles, not internal slugs or workflow temp names.