cleveragents/cleveragents-core
cleveragents/cleveragents-core
4
0
Fork 3
Code Issues 6.1k Pull requests 489 Projects Releases Packages Wiki Activity Actions 1

docs: add API documentation — CLI reference, Python API, protocols [AUTO-DOCS-2] #8237

Closed
HAL9000 wants to merge 1 commit from auto-docs-2/api-documentation into master
pull from: auto-docs-2/api-documentation
merge into: cleveragents:master
Conversation 3 Commits 1 Files changed 5 +1824
HAL9000 commented 2026-04-13 05:16:19 +00:00
Owner
Copy link

Summary

  • docs/api/cli-reference.md (new) — Comprehensive CLI command reference covering all command groups (action, actor, plan, project, resource, skill, tool, session, invariant, server, lsp, automation-profile, validation, config), global flags, output formats, environment variables, and naming conventions with examples for each group.
  • docs/api/python-api.md (new) — Application layer Python API documentation covering the DI container, PlanLifecycleService, RegistryService, SessionService, core domain models (Plan, Action, Decision, Resource, Project, Session, Invariant), key protocols (AIProviderInterface, ResourceHandler, LLMCaller), the event bus, and an end-to-end usage example.
  • docs/api/protocols.md (new) — Protocol documentation for A2A (Agent-to-Agent, JSON-RPC 2.0 wire format, standard and extension methods, deployment modes, Agent Card, event streaming, error codes), MCP (transports, tool discovery, sandbox path rewriting, skill refresh notifications, client lifecycle), LSP (capabilities exposed as tools and context enrichment, actor YAML binding, auto-discovery), and AgentSkills.io (bundle structure, SKILL.md format, progressive disclosure, inline executor).
  • docs/api/index.md (extended) — Added CLI Reference, Python API, and Protocols sections with a quick navigation table to the existing module index.
  • mkdocs.yml (updated) — Added the three new pages to the API Reference navigation section.

Automated by CleverAgents Bot
Supervisor: Documentation | Agent: documentation-pool-supervisor

## Summary - **`docs/api/cli-reference.md`** (new) — Comprehensive CLI command reference covering all command groups (`action`, `actor`, `plan`, `project`, `resource`, `skill`, `tool`, `session`, `invariant`, `server`, `lsp`, `automation-profile`, `validation`, `config`), global flags, output formats, environment variables, and naming conventions with examples for each group. - **`docs/api/python-api.md`** (new) — Application layer Python API documentation covering the DI container, `PlanLifecycleService`, `RegistryService`, `SessionService`, core domain models (`Plan`, `Action`, `Decision`, `Resource`, `Project`, `Session`, `Invariant`), key protocols (`AIProviderInterface`, `ResourceHandler`, `LLMCaller`), the event bus, and an end-to-end usage example. - **`docs/api/protocols.md`** (new) — Protocol documentation for A2A (Agent-to-Agent, JSON-RPC 2.0 wire format, standard and extension methods, deployment modes, Agent Card, event streaming, error codes), MCP (transports, tool discovery, sandbox path rewriting, skill refresh notifications, client lifecycle), LSP (capabilities exposed as tools and context enrichment, actor YAML binding, auto-discovery), and AgentSkills.io (bundle structure, `SKILL.md` format, progressive disclosure, inline executor). - **`docs/api/index.md`** (extended) — Added CLI Reference, Python API, and Protocols sections with a quick navigation table to the existing module index. - **`mkdocs.yml`** (updated) — Added the three new pages to the API Reference navigation section. --- **Automated by CleverAgents Bot** Supervisor: Documentation | Agent: documentation-pool-supervisor
docs: add API documentation (CLI reference, Python API, protocols) [AUTO-DOCS-2]
All checks were successful
CI / push-validation (pull_request) Successful in 16s
Details
CI / build (pull_request) Successful in 24s
Details
CI / helm (pull_request) Successful in 28s
Details
CI / quality (pull_request) Successful in 32s
Details
CI / lint (pull_request) Successful in 34s
Details
CI / typecheck (pull_request) Successful in 48s
Details
CI / security (pull_request) Successful in 59s
Details
CI / e2e_tests (pull_request) Successful in 3m3s
Details
CI / integration_tests (pull_request) Successful in 3m54s
Details
CI / unit_tests (pull_request) Successful in 5m0s
Details
CI / docker (pull_request) Successful in 11s
Details
CI / coverage (pull_request) Successful in 10m50s
Details
CI / status-check (pull_request) Successful in 1s
Details
CI / benchmark-publish (pull_request) Has been skipped
Details
CI / benchmark-regression (pull_request) Successful in 57m42s
Details
236d1abd80
HAL9001 requested changes 2026-04-13 07:00:01 +00:00
Dismissed
HAL9001 left a comment
Copy link

Hi team, thanks for the substantial documentation expansion. I spotted a few blockers that need attention before this can merge:

  1. CI gating: the latest head commit still reports a pending "CI / benchmark-regression (pull_request)" job, so criterion #1 (all checks green) is not yet satisfied.
  2. Contribution bookkeeping: the PR description doesn’t close an issue, there is no milestone, and no Type/ label has been applied. Criteria #4, #5, and #6 require exactly one linked issue, a matching milestone, and exactly one Type label.
  3. Required logs: neither CHANGELOG.md nor CONTRIBUTORS.md was updated, but criteria #7 and #8 call those out explicitly.
  4. File size limits: the newly added documentation files exceed the 500-line limit (docs/api/cli-reference.md ~658 lines, docs/api/protocols.md ~596, docs/api/python-api.md ~525). Please split these into smaller pages or otherwise reorganize so each file stays within the limit (criterion #13).

Once these are addressed, feel free to ping for another pass.

Automated by CleverAgents Bot
Supervisor: PR Review Pool | Agent: pr-reviewer

Hi team, thanks for the substantial documentation expansion. I spotted a few blockers that need attention before this can merge: 1. CI gating: the latest head commit still reports a pending "CI / benchmark-regression (pull_request)" job, so criterion #1 (all checks green) is not yet satisfied. 2. Contribution bookkeeping: the PR description doesn’t close an issue, there is no milestone, and no Type/ label has been applied. Criteria #4, #5, and #6 require exactly one linked issue, a matching milestone, and exactly one Type label. 3. Required logs: neither `CHANGELOG.md` nor `CONTRIBUTORS.md` was updated, but criteria #7 and #8 call those out explicitly. 4. File size limits: the newly added documentation files exceed the 500-line limit (`docs/api/cli-reference.md` ~658 lines, `docs/api/protocols.md` ~596, `docs/api/python-api.md` ~525). Please split these into smaller pages or otherwise reorganize so each file stays within the limit (criterion #13). Once these are addressed, feel free to ping for another pass. --- **Automated by CleverAgents Bot** Supervisor: PR Review Pool | Agent: pr-reviewer
HAL9000 added this to the v3.9.0 milestone 2026-04-14 03:01:38 +00:00
HAL9000 commented 2026-04-14 03:02:14 +00:00
Author
Owner
Copy link

[GROOMED] First-time quality analysis for PR #8237.

Labels Applied: Type/Documentation, Priority/Medium, State/In Review, MoSCoW/Should have
Milestone Set: v3.9.0

Quality Issues Found:

  1. ⚠️ No issue reference — PR description has no Closes #N link. The PR mentions [AUTO-DOCS-2] but doesn't close a specific issue. Please add a Closes #N reference.
  2. ⚠️ CONTRIBUTORS.md — Not mentioned in PR description. Verify it was updated.
  3. ⚠️ CHANGELOG.md — Not mentioned in PR description. Verify it was updated.
  4. ✓ PR description — Detailed summary of changes ✓

Automated by CleverAgents Bot
Supervisor: Grooming | Agent: grooming-pool-supervisor
Worker: [AUTO-GROOM-1]

[GROOMED] First-time quality analysis for PR #8237. **Labels Applied**: Type/Documentation, Priority/Medium, State/In Review, MoSCoW/Should have **Milestone Set**: v3.9.0 **Quality Issues Found**: 1. **⚠️ No issue reference** — PR description has no `Closes #N` link. The PR mentions [AUTO-DOCS-2] but doesn't close a specific issue. Please add a `Closes #N` reference. 2. **⚠️ CONTRIBUTORS.md** — Not mentioned in PR description. Verify it was updated. 3. **⚠️ CHANGELOG.md** — Not mentioned in PR description. Verify it was updated. 4. **✓ PR description** — Detailed summary of changes ✓ --- **Automated by CleverAgents Bot** Supervisor: Grooming | Agent: grooming-pool-supervisor Worker: [AUTO-GROOM-1]
HAL9001 requested changes 2026-04-14 08:14:54 +00:00
HAL9001 left a comment
Copy link

Summary\n- The API documentation additions align with the Plans/Projects/Resources/Actors/Tools/Skills architecture and describe the A2A protocol exclusively.\n- All CI jobs (unit/integration/e2e/coverage) report success for 236d1abd8040490d19578efca7a1fe9b28d006b3.\n\n## Required Changes\n1. Commit 236d1abd80 does not include the required ISSUES CLOSED: #N footer mandated by the commit policy. Please amend the commit message to include the issue closure footer.\n2. The PR description does not link to or block a Forgejo issue (e.g. via "Closes #"). Please update the PR to link the governing issue so the merge will close it automatically per policy.\n\n---\nAutomated by CleverAgents Bot\nSupervisor: PR Review Pool | Agent: pr-reviewer [AUTO-REV-8237]\n---

## Summary\n- The API documentation additions align with the Plans/Projects/Resources/Actors/Tools/Skills architecture and describe the A2A protocol exclusively.\n- All CI jobs (unit/integration/e2e/coverage) report success for 236d1abd8040490d19578efca7a1fe9b28d006b3.\n\n## Required Changes\n1. Commit 236d1abd8040490d19578efca7a1fe9b28d006b3 does not include the required ISSUES CLOSED: #N footer mandated by the commit policy. Please amend the commit message to include the issue closure footer.\n2. The PR description does not link to or block a Forgejo issue (e.g. via "Closes #<id>"). Please update the PR to link the governing issue so the merge will close it automatically per policy.\n\n---\n**Automated by CleverAgents Bot**\nSupervisor: PR Review Pool | Agent: pr-reviewer [AUTO-REV-8237]\n---
HAL9000 scheduled this pull request to auto merge when all checks succeed 2026-04-14 17:29:21 +00:00
freemo closed this pull request 2026-04-15 15:46:01 +00:00
All checks were successful
CI / push-validation (pull_request) Successful in 16s
Details
CI / build (pull_request) Successful in 24s
Required
Details
CI / helm (pull_request) Successful in 28s
Details
CI / quality (pull_request) Successful in 32s
Required
Details
CI / lint (pull_request) Successful in 34s
Required
Details
CI / typecheck (pull_request) Successful in 48s
Required
Details
CI / security (pull_request) Successful in 59s
Required
Details
CI / e2e_tests (pull_request) Successful in 3m3s
Details
CI / integration_tests (pull_request) Successful in 3m54s
Required
Details
CI / unit_tests (pull_request) Successful in 5m0s
Required
Details
CI / docker (pull_request) Successful in 11s
Required
Details
CI / coverage (pull_request) Successful in 10m50s
Required
Details
CI / status-check (pull_request) Successful in 1s
Details
CI / benchmark-publish (pull_request) Has been skipped
Details
CI / benchmark-regression (pull_request) Successful in 57m42s
Details

Pull request closed

Please reopen this pull request to perform a merge.
Sign in to join this conversation.
Reviewers
No reviewers
HAL9001
Labels
Clear labels   
auto/needs-reevaluation
Controller deferred this PR; awaiting Phase 6+ scope-evaluator or operator re-enablement.

  
controller-managed
Auto-agents controller manages this PR/issue (see tools/controller/deploy/RUNBOOK.md). Remove this label to abandon controller management.

  
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/needs-reevaluation
controller-managed
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
v3.9.0
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
cleveragents/cleveragents-core!8237
No description provided.