Skip to content

docs: decouple workflow diagram from agent-tasks MCP, add README control loop#69

Merged
LanNguyenSi merged 1 commit intomasterfrom
docs/workflow-diagram-decouple
May 6, 2026
Merged

docs: decouple workflow diagram from agent-tasks MCP, add README control loop#69
LanNguyenSi merged 1 commit intomasterfrom
docs/workflow-diagram-decouple

Conversation

@LanNguyenSi
Copy link
Copy Markdown
Owner

Summary

  • The workflow lifecycle stateDiagram in docs/for-agents.md is now anchored on the four step kinds the workflows: schema actually defines (branch, review_subagent, ci_gate, merge). Previous version leaked agent-tasks MCP verbs (task_start) and task-status state names (open / in_progress / done) that an agent without that MCP cannot resolve.
  • A new "If you use agent-tasks MCP" footnote below the diagram maps the harness lifecycle markers to concrete MCP verbs as one example integration. Other task systems (linear / jira / github projects) get a one-line acknowledgement.
  • Root README.md gains a control-loop flowchart ("What harness does": Declare → Apply → Enforce → Record → Observe, with a refine edge back to Declare) that both audiences read identically without any audience-specific verbs.

Why

User caught the leak right after PR #68 landed: "der workflow lifecycle nutzt agent-tasks mcp. das werden nur agents verstehen, die agent-tasks mcp connected sind oder nicht?". harness does not depend on agent-tasks; the docs should not silently assume otherwise.

Refs agent-tasks 051e5d77.

Scope cut

  • Docs-only. No source, no schema, no test changes.
  • for-humans.md untouched.
  • The policy/ledger sequenceDiagram in for-agents.md untouched (it never named an agent-tasks verb).
  • No new task-system integration examples beyond the agent-tasks footnote and the one-line linear/jira/github-projects acknowledgement.

Test plan

  • git diff --stat master..docs/workflow-diagram-decouple shows exactly 3 files: CHANGELOG, README, docs/for-agents.md.
  • State names in the new stateDiagram match WorkflowStep.kind exactly (src/schema/workflows.ts).
  • No agent-tasks verbs leak outside the explicitly-marked footnote.
  • README diagram uses no MCP-binding-specific token.
  • 711 / 711 tests still green.
  • No em-dashes in new prose.
  • Reviewed by subagent against rigorous 8-point checklist; ship-it verdict.

…rol loop

The workflow lifecycle stateDiagram in for-agents.md now reads
against the four step kinds the workflows: schema actually defines
(branch / review_subagent / ci_gate / merge) instead of agent-tasks
MCP-specific verbs (task_start, open / in_progress / done). A new
"If you use agent-tasks MCP" footnote below the diagram maps the
lifecycle markers to concrete MCP verbs as one example integration.
Other task systems fit the same lifecycle.

Plus: root README gains a control-loop flowchart ("What harness
does": declare, apply, enforce, record, observe, refine) that both
audiences read identically without audience-specific verbs. The
README + docs now ship four mermaid diagrams total.

Refs agent-tasks 051e5d77.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@LanNguyenSi LanNguyenSi merged commit 4452543 into master May 6, 2026
1 check passed
@LanNguyenSi LanNguyenSi mentioned this pull request May 6, 2026
10 tasks
LanNguyenSi added a commit that referenced this pull request May 6, 2026
Bump package.json 0.6.0 -> 0.7.0. Roll up CHANGELOG [Unreleased]
into [0.7.0] - 2026-05-06 with a one-paragraph headline plus
operator note. PR refs (#65, #66, #67, #68, #69) added to each
entry. README now references v0.7.0 in the prose and gains a
status checklist row for the workflows-as-data + session-export +
docs-split set. Two version-pinned tests bumped to match the new
binary header.

Theme: workflows-as-data and full-session audit forensics. No
schema bump (still version: 1); all new manifest fields are
additive and parse identically against 0.6.0 manifests.

Refs agent-tasks 1fe55885.

Co-authored-by: Lan Nguyen Si <nguyen-si@publicplan.de>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants