fix: sync doc with extraction scope, remove boundary violation, add ProviderRegistryPort #5

Merged

hurui200320 merged 1 commit from fix/doc-sync into master 2026-05-22 03:25:52 +00:00

Conversation 0 Commits 1 Files changed 22 +4040 -457

hurui200320 commented 2026-05-21 06:52:40 +00:00

Member

Copy link

Summary

This PR addresses documentation gaps and code issues identified after the LLM-assisted extraction of cleveractors-core from cleveragents-core.

When the library was extracted, the LLM failed to properly scope it. Three categories of problems were found and fixed here:

1. A file that belongs to the host (acms/index.py) was copied into the library in violation of ADR-001.
2. A port (ProviderRegistryPort) was referenced in docs but never implemented, leaving graphs unable to resolve LLM agents at execution time.
3. Nine design documents covering the actor abstraction, YAML schema, compiler, and preprocessing pipeline existed in cleveragents-core but had no equivalent here.

The PR has been squashed to a single commit and all review feedback has been addressed (see review responses below).

---

Changes

Documentation fixes (post-review)

• docs/reference/actors_schema.md: Added provider field to LLM Actor and GRAPH Actor required fields; added full provider field definition with description, common values, and ADR-005 cross-reference; added provider to all YAML examples; added missing provider validation error message.
• docs/reference/actor_config.md: Added provider alongside model in basic structure and hierarchical graph examples; fixed error message to match actual validator output; added missing provider error case.

Boundary fix — acms/index.py deleted

src/cleveractors/acms/index.py contained ACMSIndex, FileTraversalEngine, IndexEntry, FileType, and TierLevel. ADR-001 is explicit:

cleveractors.acms — Pure UKO vocabulary data; the indexer / storage / strategy runtime stays in cleveragents-core.

The implementation is bound to the CLI use case of cleveragents-core and has no relationship to actor YAML parsing or LangGraph compilation. It already exists in cleveragents-core at cleveragents/acms/index.py; it is deleted here and all re-exports removed from acms/__init__.py.

ProviderRegistryPort — new port

New file src/cleveractors/ports/provider_registry.py, following the same structural-typing pattern as ToolRegistryPort (ADR-002):

@runtime_checkable
class ProviderRegistryPort(Protocol):
    def get(self, provider: str, model: str) -> Agent | None: ...

Returns Agent (the library's own minimal ABC) rather than BaseChatModel to avoid coupling to a specific LangChain version. Host applications wrap their concrete models in an Agent subclass and return it from get().

Compiler — actor/compiler.py

_map_node now accepts actor_provider/actor_model as defaults and merges them into AGENT node metadata via setdefault, so per-node config values still take precedence. compile_actor passes config.provider/config.model through.

Node executor — langgraph/nodes.py

Node.__init__ gains an optional provider_registry: ProviderRegistryPort | None = None parameter. _execute_agent resolution order is:

1. Pre-resolved agents dict — existing behaviour, unchanged.
2. provider_registry.get(provider, model) using values from node metadata — new; allows hosts to supply LLM models without pre-building an agents dict.
3. Graceful synthetic "Agent {provider}/{model} not found" response — fallback format now matches ADR-005 specification.

BDD coverage — features/ (7 scenarios, 30 steps)

New scenarios beyond the original ProviderRegistryPort happy-path test:

• Graceful fallback when provider_registry.get() returns None
• Graceful fallback when no provider_registry is supplied
• Pre-resolved agents dict takes precedence over provider registry
• Assertion strengthened to verify stub agent response content (not just message role)

Documentation

Doc	Content
docs/adr/ADR-003-actor-abstraction-definition.md	Ported from cleveragents-core ADR-031
docs/adr/ADR-004-jinja2-yaml-template-preprocessing.md	Ported from cleveragents-core ADR-032
docs/adr/ADR-005-provider-registry-protocol.md	New ADR for ProviderRegistryPort
docs/reference/actors_schema.md	Full YAML schema reference
docs/reference/actor_compiler.md	Compilation pipeline and error types
docs/reference/actor_config.md	Practical authoring guide
docs/reference/actor_hierarchy.md	Per-node LSP bindings, tool-source refs
docs/reference/actors_examples.md	Comprehensive YAML examples
docs/api/actor.md	Full public API reference
mkdocs.yml	Nav extended with all new docs

Quality gates

nox -e lint       ✅ PASS
nox -e typecheck  ✅ PASS (0 errors, 0 warnings)
nox -e unit_tests ✅ PASS (7 scenarios, 30 steps)
nox -e coverage_report ✅ PASS

Checklist

• acms/index.py boundary violation removed
• ProviderRegistryPort protocol created and wired into the node executor
• ADR-003, ADR-004, ADR-005 written and cross-linked
• Five reference docs written and linked
• API reference written and linked
• mkdocs.yml nav updated
• provider field added to reference docs (post-review fix)
• Fallback message format matches ADR-005 spec (post-review fix)
• # type: ignore directive removed from smoke_steps.py (post-review fix)
• BDD assertion strengthened to verify agent response content (post-review fix)
• New BDD scenarios for fallback, no-registry, and agents-dict precedence (post-review fix)
• Commit squashed with ISSUES CLOSED: #4 footer
• Move acms/index.py back into cleveragents-core if needed — tracked separately; the file already exists there

CLOSE #4

## Summary This PR addresses documentation gaps and code issues identified after the LLM-assisted extraction of `cleveractors-core` from `cleveragents-core`. When the library was extracted, the LLM failed to properly scope it. Three categories of problems were found and fixed here: 1. A file that belongs to the host (`acms/index.py`) was copied into the library in violation of ADR-001. 2. A port (`ProviderRegistryPort`) was referenced in docs but never implemented, leaving graphs unable to resolve LLM agents at execution time. 3. Nine design documents covering the actor abstraction, YAML schema, compiler, and preprocessing pipeline existed in `cleveragents-core` but had no equivalent here. The PR has been squashed to a single commit and all review feedback has been addressed (see review responses below). --- ## Changes ### Documentation fixes (post-review) - **`docs/reference/actors_schema.md`**: Added `provider` field to LLM Actor and GRAPH Actor required fields; added full `provider` field definition with description, common values, and ADR-005 cross-reference; added `provider` to all YAML examples; added missing `provider` validation error message. - **`docs/reference/actor_config.md`**: Added `provider` alongside `model` in basic structure and hierarchical graph examples; fixed error message to match actual validator output; added missing `provider` error case. ### Boundary fix — `acms/index.py` deleted `src/cleveractors/acms/index.py` contained `ACMSIndex`, `FileTraversalEngine`, `IndexEntry`, `FileType`, and `TierLevel`. ADR-001 is explicit: > `cleveractors.acms` — Pure UKO vocabulary data; **the indexer / storage / strategy runtime stays in cleveragents-core.** The implementation is bound to the CLI use case of `cleveragents-core` and has no relationship to actor YAML parsing or LangGraph compilation. It already exists in `cleveragents-core` at `cleveragents/acms/index.py`; it is deleted here and all re-exports removed from `acms/__init__.py`. ### `ProviderRegistryPort` — new port New file `src/cleveractors/ports/provider_registry.py`, following the same structural-typing pattern as `ToolRegistryPort` (ADR-002): ```python @runtime_checkable class ProviderRegistryPort(Protocol): def get(self, provider: str, model: str) -> Agent | None: ... ``` Returns `Agent` (the library's own minimal ABC) rather than `BaseChatModel` to avoid coupling to a specific LangChain version. Host applications wrap their concrete models in an `Agent` subclass and return it from `get()`. ### Compiler — `actor/compiler.py` `_map_node` now accepts `actor_provider`/`actor_model` as defaults and merges them into AGENT node `metadata` via `setdefault`, so per-node config values still take precedence. `compile_actor` passes `config.provider`/`config.model` through. ### Node executor — `langgraph/nodes.py` `Node.__init__` gains an optional `provider_registry: ProviderRegistryPort | None = None` parameter. `_execute_agent` resolution order is: 1. Pre-resolved `agents` dict — existing behaviour, unchanged. 2. `provider_registry.get(provider, model)` using values from node `metadata` — new; allows hosts to supply LLM models without pre-building an agents dict. 3. Graceful synthetic `"Agent {provider}/{model} not found"` response — fallback format now matches ADR-005 specification. ### BDD coverage — `features/` (7 scenarios, 30 steps) New scenarios beyond the original ProviderRegistryPort happy-path test: - Graceful fallback when `provider_registry.get()` returns `None` - Graceful fallback when no `provider_registry` is supplied - Pre-resolved agents dict takes precedence over provider registry - Assertion strengthened to verify stub agent response content (not just message role) ### Documentation | Doc | Content | |-----|---------| | `docs/adr/ADR-003-actor-abstraction-definition.md` | Ported from `cleveragents-core` ADR-031 | | `docs/adr/ADR-004-jinja2-yaml-template-preprocessing.md` | Ported from `cleveragents-core` ADR-032 | | `docs/adr/ADR-005-provider-registry-protocol.md` | New ADR for `ProviderRegistryPort` | | `docs/reference/actors_schema.md` | Full YAML schema reference | | `docs/reference/actor_compiler.md` | Compilation pipeline and error types | | `docs/reference/actor_config.md` | Practical authoring guide | | `docs/reference/actor_hierarchy.md` | Per-node LSP bindings, tool-source refs | | `docs/reference/actors_examples.md` | Comprehensive YAML examples | | `docs/api/actor.md` | Full public API reference | | `mkdocs.yml` | Nav extended with all new docs | ### Quality gates ``` nox -e lint ✅ PASS nox -e typecheck ✅ PASS (0 errors, 0 warnings) nox -e unit_tests ✅ PASS (7 scenarios, 30 steps) nox -e coverage_report ✅ PASS ``` ## Checklist - [x] `acms/index.py` boundary violation removed - [x] `ProviderRegistryPort` protocol created and wired into the node executor - [x] ADR-003, ADR-004, ADR-005 written and cross-linked - [x] Five reference docs written and linked - [x] API reference written and linked - [x] `mkdocs.yml` nav updated - [x] `provider` field added to reference docs (post-review fix) - [x] Fallback message format matches ADR-005 spec (post-review fix) - [x] `# type: ignore` directive removed from smoke_steps.py (post-review fix) - [x] BDD assertion strengthened to verify agent response content (post-review fix) - [x] New BDD scenarios for fallback, no-registry, and agents-dict precedence (post-review fix) - [x] Commit squashed with `ISSUES CLOSED: #4` footer - [ ] Move `acms/index.py` back into `cleveragents-core` if needed — tracked separately; the file already exists there CLOSE #4

hurui200320 self-assigned this 2026-05-21 06:52:40 +00:00

hurui200320 added a new dependency 2026-05-21 06:55:28 +00:00

#4 Design doc gaps and boundary violations in cleveractors-core

hurui200320 force-pushed fix/doc-sync from 7084e175a2 to 6d24090ee0 2026-05-21 08:07:01 +00:00 Compare

hurui200320 changed title from WIP: Sync doc with extraction scope, remove boundary violation, add ProviderRegistryPort to fix: sync doc with extraction scope, remove boundary violation, add ProviderRegistryPort 2026-05-21 08:08:16 +00:00

hurui200320 added the

Type

Documentation

label 2026-05-21 08:09:00 +00:00

hurui200320 referenced this pull request 2026-05-21 08:09:42 +00:00

Design doc gaps and boundary violations in cleveractors-core #4

hurui200320 force-pushed fix/doc-sync from 6d24090ee0 to 7084e175a2 2026-05-21 08:23:56 +00:00 Compare

hurui200320 force-pushed fix/doc-sync from 7084e175a2 to 4870db2806 2026-05-21 08:36:30 +00:00 Compare

hurui200320 force-pushed fix/doc-sync from 4870db2806 to 1265efc751 2026-05-21 08:42:35 +00:00 Compare

hurui200320 referenced this pull request 2026-05-21 08:59:24 +00:00

Clever Actors only accepts GRAPH actors, not LLM actors. #2

hurui200320 force-pushed fix/doc-sync from 1265efc751 to 15e81e58f1 2026-05-21 10:10:48 +00:00 Compare

hurui200320 merged commit 15e81e58f1 into master 2026-05-22 03:25:52 +00:00

hurui200320 deleted branch fix/doc-sync 2026-05-22 03:25:52 +00:00

CoreRasurae referenced this pull request 2026-06-08 23:13:51 +00:00

feat(registry): extend TemplateType and integrate PackageReference into template system #35

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels

  

auto/blocked-by-deps

PR blocked by an open issue dependency. Operator must close the dep (or remove the dependency link) before the merge driver can act. Auto-cleared by merge_drive when no open deps remain.

  

auto/ci-timeout

Most recent merge cycle hit CI timeout. Driver excludes this PR while last merge_cycle row is < 30 min old; label persists thereafter as visible history.

  

auto/claimed-implementer

Currently being processed by an implementer worker.

  

auto/claimed-merge

Currently being processed by the merge driver.

  

auto/claimed-reviewer

Currently being processed by a reviewer worker.

  

auto/driver-down

Merge driver heartbeat stale; pipeline halted. Closed automatically on next clean tick.

  

auto/invariant-violation

Detected master commit violating the strict merge invariant. Tracked as an issue (not a PR label); kept here for label completeness.

  

auto/last-attempt-tier-0

In-cycle escalation: most recent attempt ran at the Tier 0 slot (`tier-0`). Slot's model defined in .opencode/models/tiers.yaml.

  

auto/last-attempt-tier-1

In-cycle escalation: most recent attempt ran at the Tier 1 slot (`tier-1`). Slot's model defined in .opencode/models/tiers.yaml.

  

auto/last-attempt-tier-2

In-cycle escalation: most recent attempt ran at the Tier 2 slot (`tier-2`). Slot's model defined in .opencode/models/tiers.yaml. Gated behind IMPLEMENTER_ESCALATION_TIER2_ENABLED.

  

auto/last-attempt-tier-min

In-cycle escalation: most recent attempt ran at the Tier -1 slot (`tier-min`). Slot's model defined in .opencode/models/tiers.yaml. Suffix is ``-min`` (not ``--1``) so the Forgejo UI reads naturally.

  

Automation Tracking

Tracking issues used by the AI Automation system for agents to communicate and report.

  

auto/needs-conflict-resolution

Rebase conflict needs LLM conflict-resolver.

  

auto/needs-implementer

Failing CI needs implementer attention.

  

auto/postmortem

Documenting a driver incident or rollback.

  

auto/ready-to-merge

Reviewer has APPROVED this PR and no later REQUEST_CHANGES is outstanding. The merge driver requires this label to even consider a PR for merging. Set by the reviewer worker on APPROVE; cleared on REQUEST_CHANGES.

  

auto/restart-throttled

Train repeatedly lost master-tempo races. Driver excludes via merge_cycle until cooldown elapses; label persists as visible history.

  

auto/revert

Revert PR backing out an invariant violation. Fast-tracked through the merge driver.

  

auto/sentinel

Sentinel PR duplicated from upstream into a personal fork by tools/duplicate_prs_to_fork.py for pipeline testing. Lives only in the fork; the canonical pipeline never sees it.

  

auto/stale-inactivity

No implementer activity for N days. Flagged for human review. Auto-cleared on next push to head branch.

  

auto/unstable

Repeatedly fails on current master (>= 3 ci-fail-on-rebased-sha releases in 12 h). Excluded from driver until human triage.

  

Blocked

A ticket in a blocked state and unable to complete until some other task is completed first.

  

Bounty

$100

A bounty of $100 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$1000

A bounty of $1000 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$10000

A bounty of $10000 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$20

A bounty of $20 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$2000

A bounty of $2000 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$250

A bounty of $250 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$50

A bounty of $50 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$500

A bounty of $500 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$5000

A bounty of $5000 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$750

A bounty of $750 for any open-source contributor who provides a MR that solves this issue

  

MoSCoW

Could have

Could have feature in order to satisfy the epic/legendary.

  

MoSCoW

Must have

Must have feature in order to satisfy the epic/legendary.

  

MoSCoW

Should have

Should have feature in order to satisfy the epic/legendary.

  

Needs Feedback

There are questions in the ticket that can not be completed until the project owner provides clarity.

  

Points

1

1 man-hours worth of work for an expert with no learning curve.

  

Points

13

13 man-hours worth of work for an expert with no learning curve.

  

Points

2

2 man-hours worth of work for an expert with no learning curve.

  

Points

21

21 man-hours worth of work for an expert with no learning curve.

  

Points

3

3 man-hours worth of work for an expert with no learning curve.

  

Points

34

34 man-hours worth of work for an expert with no learning curve.

  

Points

5

5 man-hours worth of work for an expert with no learning curve.

  

Points

55

55 man-hours worth of work for an expert with no learning curve.

  

Points

8

8 man-hours worth of work for an expert with no learning curve.

  

Points

88

88 man-hours worth of work for an expert with no learning curve.

  

Priority

Backlog

This ticket has backlogged priority and is not to be worked on yet

  

Priority

CI Blocker

Critical priority issue that blocks CI/CD pipeline and prevents PR merges

  

Priority

Critical

The priority is critical

  

Priority

High

The priority is high

  

Priority

Low

The priority is low

  

Priority

Medium

The priority is medium

  

Signed-off: Owner

When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.

  

Signed-off: Scrum Master

When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.

  

Signed-off: Tech Lead

When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.

  

Spike

A ticket for learning a tool or technology that is needed to be able to do future planning and design.

  

State

Completed

The ticket has been fully implemented, completed, and merged with the source code. This label should only be applied once a ticket is closed.

  

State

Duplicate

A ticket that represents the same content as an existing ticket.

  

State

In Progress

A ticket that is actively being developed.

  

State

In Review

A ticket that has had some code completed to implement but is waiting to pass peer review and is not yet merged in.

  

State

Paused

This ticket's work started but wasn't finished. It's on hold (likely in a feature branch) and will be resumed later, either due to a blocker or a delay.

  

State

Unverified

All new tickets start in this state. A developer may set it to show the ticket is unverified. This means we haven't agreed to work on it. It will either move to a verified state or be closed as wontdo.

  

State

Verified

The issue has been verified by a developer as legitimate. It will be worked on and verified tickets are now considered part of the backlog.

  

State

Wont Do

This ticket has been decided it wont be done. This may mean the bug has been determined to not be real (cant verify) or the feature is one we have decided we dont want to adopt.

  

Type

Automation

Any edits or discussion about the AI automated coding system.

  

Type

Bug

Something that doesnt work as intended.

  

Type

Discussion

Anytime a ticket represents a discussion about a subject and doesnt fall into one of the other categories.

  

Type

Documentation

An error or improvement needed in the documentation.

  

Type

Epic

Any first tier epic. That is, an epic which contains only issues as children and will not have sub-epics.

  

Type

Feature

Some new functionality not present.

  

Type

Legendary

A type of Epic which will contain other Epics.

  

Type

Refactor

A code change that restructures existing code without changing its external behavior.

  

Type

Support

Someone needs help using the project.

  

Type

Task

A generic task that doesnt fit into the other type categories.

  

Type

Testing

Work exclusively focusing on fixing or expanding testing.

No labels

auto/blocked-by-deps

auto/ci-timeout

auto/claimed-implementer

auto/claimed-merge

auto/claimed-reviewer

auto/driver-down

auto/invariant-violation

auto/last-attempt-tier-0

auto/last-attempt-tier-1

auto/last-attempt-tier-2

auto/last-attempt-tier-min

Automation Tracking

auto/needs-conflict-resolution

auto/needs-implementer

auto/postmortem

auto/ready-to-merge

auto/restart-throttled

auto/revert

auto/sentinel

auto/stale-inactivity

auto/unstable

Blocked

Bounty

$100

Bounty

$1000

Bounty

$10000

Bounty

$20

Bounty

$2000

Bounty

$250

Bounty

$50

Bounty

$500

Bounty

$5000

Bounty

$750

MoSCoW

Could have

MoSCoW

Must have

MoSCoW

Should have

Needs Feedback

Points

1

Points

13

Points

2

Points

21

Points

3

Points

34

Points

5

Points

55

Points

8

Points

88

Priority

Backlog

Priority

CI Blocker

Priority

Critical

Priority

High

Priority

Low

Priority

Medium

Signed-off: Owner

Signed-off: Scrum Master

Signed-off: Tech Lead

Spike

State

Completed

State

Duplicate

State

In Progress

State

In Review

State

Paused

State

Unverified

State

Verified

State

Wont Do

Type

Automation

Type

Bug

Type

Discussion

Type

Documentation

Type

Epic

Type

Feature

Type

Legendary

Type

Refactor

Type

Support

Type

Task

Type

Testing

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

hurui200320

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Blocks

#4 Design doc gaps and boundary violations in cleveractors-core

cleveragents/cleveractors-core

Reference

cleveragents/cleveractors-core!5

No description provided.