pub(crate) fn workflow_plan_common_sections() -> String {
let allowed_step_ids = crate::workflow_plan::ALLOWED_WORKFLOW_STEP_IDS.join(", ");
let teaching_library = workflow_plan_teaching_library_sections();
format!(
concat!(
"Allowed step ids: {}.\n",
"Plan invariants:\n",
"- execution_target must be automation_v2\n",
"- workspace_root must be a non-empty absolute path\n",
"- do not invent unsupported step ids\n",
"- keep the graph minimal but sufficient\n",
"- steps must form a valid DAG\n",
"- input_refs and depends_on must reference existing steps\n",
"WorkflowPlan.step schema:\n",
"- each step must use fields: step_id, kind, objective, agent_role, depends_on, input_refs, output_contract; metadata is optional\n",
"- do not use alternate keys like id, type, label, or config as the primary step schema\n",
"- input_refs must be objects shaped like {{\"from_step_id\":\"...\",\"alias\":\"...\"}}\n",
"- output_contract must be either null or {{\"kind\":\"structured_json|report_markdown|text_summary|urls|citations|brief|review|review_summary|approval_gate|code_patch\",\"validator\":\"structured_json|generic_artifact|research_brief|review_decision|code_patch\"}}\n",
"- use `code_patch` for code-editing steps that should be judged by patch/apply/test behavior rather than a prose summary\n",
"- when a research brief step needs current web coverage, set metadata.builder.web_research_expected to true; set it to false when local/file research is enough\n",
"- when the request names connector-backed sources or `allowed_mcp_servers` is non-empty, plan MCP-backed steps instead of inventing hidden capabilities or defaulting to generic web search\n",
"{}",
),
allowed_step_ids,
teaching_library
)
}
fn workflow_plan_teaching_library_sections() -> String {
concat!(
"Teaching library:\n",
"- explain: summarize the plan, why the steps exist, and what output each produces\n",
"- objections: call out missing inputs, unsafe assumptions, or missing connectors\n",
"- proof points: cite evidence sources, validation checks, or artifacts that will prove success\n",
"- connector-backed work: prefer the selected MCP inventory for source-specific systems such as Reddit, GitHub issues, Slack, or Jira, and clarify when no relevant connector is available\n",
"- code changes: prefer `code_patch` plus an inspect -> patch -> apply -> test -> repair loop, and reserve `write` for brand-new files\n",
"- monitor-pattern plans: when the user describes a recurring awareness task (checking email, watching for changes, monitoring a data source, scanning for new items), generate a triage-first plan\n",
" - first step must be an `assess` step that uses MCP tools to check the data source and outputs structured JSON: {\"has_work\": true/false, \"summary\": \"...\", \"items\": [...]}\n",
" - set metadata.triage_gate: true on the assess step so the engine skips downstream nodes when has_work is false\n",
" - subsequent steps depend on the assess step and can be as complex as needed; do not limit the plan to two steps\n",
" - the assess step should use a cheap model: set metadata.builder.triage_model: true\n",
" - do not add a triage step for non-recurring or non-awareness tasks\n",
)
.to_string()
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn workflow_plan_common_sections_include_teaching_library() {
let sections = workflow_plan_common_sections();
assert!(sections.contains("Teaching library:"));
assert!(sections.contains("explain: summarize the plan"));
assert!(sections.contains("proof points"));
assert!(sections.contains("connector-backed work"));
assert!(sections.contains("code_patch"));
assert!(sections.contains("inspect -> patch -> apply -> test -> repair"));
assert!(sections.contains("reserve `write` for brand-new files"));
assert!(sections.contains("monitor-pattern plans"));
assert!(sections.contains("assess"));
assert!(sections.contains("triage_gate"));
}
}