refactor(rfc): rewrite as v0.8.0 contract, not migration plan
Was: "current state → target state" migration narrative Now: "this is what core/agent v0.8.0 IS" API contract 14 sections covering: registration, actions, pipeline, process, status, filesystem, validation, entitlements, MCP aggregator, remote dispatch, JSON, testing, quality gates. Written with full core/go domain context — every example uses the implemented v0.8.0 primitives. Co-Authored-By: Virgil <virgil@lethean.io>
This commit is contained in:
parent
c4a1178ae6
commit
2d2a4116ed
1 changed files with 309 additions and 0 deletions
309
docs/RFC.md
Normal file
309
docs/RFC.md
Normal file
|
|
@ -0,0 +1,309 @@
|
|||
# core/agent API Contract — RFC Specification
|
||||
|
||||
> `dappco.re/go/core/agent` — Agentic dispatch, orchestration, and pipeline management.
|
||||
> An agent should be able to understand core/agent's architecture from this document alone.
|
||||
|
||||
**Status:** v0.8.0
|
||||
**Module:** `dappco.re/go/core/agent`
|
||||
**Depends on:** core/go v0.8.0, go-process v0.7.0
|
||||
|
||||
---
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
core/agent dispatches AI agents (Claude, Codex, Gemini) to work on tasks in sandboxed git worktrees, monitors their progress, verifies output, and manages the merge pipeline.
|
||||
|
||||
core/go provides the primitives. core/agent composes them.
|
||||
|
||||
---
|
||||
|
||||
## 2. Service Registration
|
||||
|
||||
```go
|
||||
func Register(c *core.Core) core.Result {
|
||||
svc := &PrepSubsystem{
|
||||
ServiceRuntime: core.NewServiceRuntime(c, AgentOptions{}),
|
||||
}
|
||||
return core.Result{Value: svc, OK: true}
|
||||
}
|
||||
|
||||
// In main:
|
||||
c := core.New(
|
||||
core.WithService(process.Register),
|
||||
core.WithService(agentic.Register),
|
||||
core.WithService(brain.Register),
|
||||
core.WithService(monitor.Register),
|
||||
core.WithService(mcp.Register),
|
||||
)
|
||||
c.Run()
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. Named Actions — The Capability Map
|
||||
|
||||
All capabilities registered as named Actions during OnStartup. Inspectable, composable, gatable by Entitlements.
|
||||
|
||||
```go
|
||||
func (s *PrepSubsystem) OnStartup(ctx context.Context) core.Result {
|
||||
c := s.Core()
|
||||
|
||||
// Dispatch
|
||||
c.Action("agentic.dispatch", s.handleDispatch)
|
||||
c.Action("agentic.prep", s.handlePrep)
|
||||
c.Action("agentic.status", s.handleStatus)
|
||||
c.Action("agentic.resume", s.handleResume)
|
||||
c.Action("agentic.scan", s.handleScan)
|
||||
|
||||
// Pipeline
|
||||
c.Action("agentic.qa", s.handleQA)
|
||||
c.Action("agentic.auto-pr", s.handleAutoPR)
|
||||
c.Action("agentic.verify", s.handleVerify)
|
||||
c.Action("agentic.ingest", s.handleIngest)
|
||||
c.Action("agentic.poke", s.handlePoke)
|
||||
c.Action("agentic.mirror", s.handleMirror)
|
||||
|
||||
// Forge
|
||||
c.Action("agentic.issue.get", s.handleIssueGet)
|
||||
c.Action("agentic.issue.list", s.handleIssueList)
|
||||
c.Action("agentic.issue.create", s.handleIssueCreate)
|
||||
c.Action("agentic.pr.get", s.handlePRGet)
|
||||
c.Action("agentic.pr.list", s.handlePRList)
|
||||
c.Action("agentic.pr.merge", s.handlePRMerge)
|
||||
|
||||
// Brain
|
||||
c.Action("brain.recall", s.handleBrainRecall)
|
||||
c.Action("brain.remember", s.handleBrainRemember)
|
||||
|
||||
// Completion pipeline
|
||||
c.Task("agent.completion", core.Task{
|
||||
Description: "QA → PR → Verify → Merge",
|
||||
Steps: []core.Step{
|
||||
{Action: "agentic.qa"},
|
||||
{Action: "agentic.auto-pr"},
|
||||
{Action: "agentic.verify"},
|
||||
{Action: "agentic.ingest", Async: true},
|
||||
{Action: "agentic.poke", Async: true},
|
||||
},
|
||||
})
|
||||
|
||||
s.registerCommands(ctx)
|
||||
return core.Result{OK: true}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. Completion Pipeline
|
||||
|
||||
When an agent completes, the Task runs sequentially. Async steps fire without blocking the queue drain.
|
||||
|
||||
```go
|
||||
c.RegisterAction(func(c *core.Core, msg core.Message) core.Result {
|
||||
if ev, ok := msg.(messages.AgentCompleted); ok {
|
||||
opts := core.NewOptions(
|
||||
core.Option{Key: "repo", Value: ev.Repo},
|
||||
core.Option{Key: "workspace", Value: ev.Workspace},
|
||||
)
|
||||
c.PerformAsync("agent.completion", opts)
|
||||
}
|
||||
return core.Result{OK: true}
|
||||
})
|
||||
```
|
||||
|
||||
Steps: QA (build+test) → Auto-PR (git push + Forge API) → Verify (test + merge).
|
||||
Ingest and Poke run async — Poke drains the queue immediately.
|
||||
|
||||
---
|
||||
|
||||
## 5. Process Execution
|
||||
|
||||
All commands via `c.Process()`. No `os/exec`, no `proc.go`, no `ensureProcess()`.
|
||||
|
||||
```go
|
||||
// Git operations
|
||||
func (s *PrepSubsystem) gitCmd(ctx context.Context, dir string, args ...string) core.Result {
|
||||
return s.Core().Process().RunIn(ctx, dir, "git", args...)
|
||||
}
|
||||
|
||||
func (s *PrepSubsystem) gitOK(ctx context.Context, dir string, args ...string) bool {
|
||||
return s.gitCmd(ctx, dir, args...).OK
|
||||
}
|
||||
|
||||
func (s *PrepSubsystem) gitOutput(ctx context.Context, dir string, args ...string) string {
|
||||
r := s.gitCmd(ctx, dir, args...)
|
||||
if !r.OK { return "" }
|
||||
return core.Trim(r.Value.(string))
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 6. Status Management
|
||||
|
||||
Workspace status uses `WriteAtomic` for safe concurrent access + per-workspace mutex for read-modify-write:
|
||||
|
||||
```go
|
||||
// Write
|
||||
s.Core().Fs().WriteAtomic(statusPath, core.JSONMarshalString(status))
|
||||
|
||||
// Read-modify-write with lock
|
||||
s.withLock(wsDir, func() {
|
||||
st := readStatus(wsDir)
|
||||
st.Status = "completed"
|
||||
s.Core().Fs().WriteAtomic(statusPath, core.JSONMarshalString(st))
|
||||
})
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 7. Filesystem
|
||||
|
||||
No `unsafe.Pointer`. Sandboxed by default, unrestricted when needed:
|
||||
|
||||
```go
|
||||
// Sandboxed to workspace
|
||||
f := (&core.Fs{}).New(workspaceDir)
|
||||
|
||||
// Full access when required
|
||||
f := s.Core().Fs().NewUnrestricted()
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 8. Validation and IDs
|
||||
|
||||
```go
|
||||
// Validate input
|
||||
if r := core.ValidateName(input.Repo); !r.OK { return r }
|
||||
safe := core.SanitisePath(userInput)
|
||||
|
||||
// Generate unique identifiers
|
||||
id := core.ID() // "id-42-a3f2b1"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 9. Entitlements
|
||||
|
||||
Actions are gated by `c.Entitled()` — checked automatically in `Action.Run()`.
|
||||
|
||||
For explicit gating with quantity checks:
|
||||
|
||||
```go
|
||||
func (s *PrepSubsystem) handleDispatch(ctx context.Context, opts core.Options) core.Result {
|
||||
// Concurrency limit
|
||||
e := s.Core().Entitled("agentic.concurrency", 1)
|
||||
if !e.Allowed {
|
||||
return core.Result{Value: core.E("dispatch", e.Reason, nil), OK: false}
|
||||
}
|
||||
|
||||
// ... dispatch agent ...
|
||||
|
||||
s.Core().RecordUsage("agentic.dispatch")
|
||||
return core.Result{OK: true}
|
||||
}
|
||||
```
|
||||
|
||||
Enables: SaaS tier gating, usage tracking, workspace isolation.
|
||||
|
||||
---
|
||||
|
||||
## 10. MCP — Action Aggregator
|
||||
|
||||
MCP auto-exposes all registered Actions as tools:
|
||||
|
||||
```go
|
||||
func (s *MCPService) OnStartup(ctx context.Context) core.Result {
|
||||
for _, name := range s.Core().Actions() {
|
||||
action := s.Core().Action(name)
|
||||
s.server.AddTool(mcp.Tool{
|
||||
Name: name,
|
||||
Description: action.Description,
|
||||
InputSchema: schemaFromOptions(action.Schema),
|
||||
Handler: func(ctx context.Context, input map[string]any) (any, error) {
|
||||
r := action.Run(ctx, optionsFromInput(input))
|
||||
if !r.OK { return nil, r.Value.(error) }
|
||||
return r.Value, nil
|
||||
},
|
||||
})
|
||||
}
|
||||
return core.Result{OK: true}
|
||||
}
|
||||
```
|
||||
|
||||
Register an Action → it appears as an MCP tool. No hand-wiring.
|
||||
|
||||
---
|
||||
|
||||
## 11. Remote Dispatch
|
||||
|
||||
Transparent local/remote via `host:action` syntax:
|
||||
|
||||
```go
|
||||
// Local
|
||||
r := c.RemoteAction("agentic.status", ctx, opts)
|
||||
|
||||
// Remote — same API
|
||||
r := c.RemoteAction("charon:agentic.dispatch", ctx, opts)
|
||||
|
||||
// Web3
|
||||
r := c.RemoteAction("snider.lthn:brain.recall", ctx, opts)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 12. JSON Serialisation
|
||||
|
||||
All JSON via Core primitives. No `encoding/json` import.
|
||||
|
||||
```go
|
||||
data := core.JSONMarshalString(status)
|
||||
core.JSONUnmarshal(responseBytes, &result)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 13. Test Strategy
|
||||
|
||||
AX-7: `TestFile_Function_{Good,Bad,Ugly}` — 100% naming compliance target.
|
||||
|
||||
```
|
||||
TestHandlers_CompletionPipeline_Good — QA+PR+Verify succeed, Poke fires
|
||||
TestHandlers_CompletionPipeline_Bad — QA fails, chain stops
|
||||
TestHandlers_CompletionPipeline_Ugly — handler panics, pipeline recovers
|
||||
TestDispatch_Entitlement_Good — entitled workspace dispatches
|
||||
TestDispatch_Entitlement_Bad — denied workspace gets error
|
||||
TestPrep_GitCmd_Good — via c.Process()
|
||||
TestStatus_WriteAtomic_Ugly — concurrent writes don't corrupt
|
||||
TestMCP_ActionAggregator_Good — Actions appear as MCP tools
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 14. Quality Gates (AX Principle 9)
|
||||
|
||||
```bash
|
||||
# No disallowed imports
|
||||
grep -rn '"os/exec"\|"unsafe"\|"encoding/json"\|"fmt"\|"errors"' pkg/**/*.go \
|
||||
| grep -v _test.go
|
||||
|
||||
# Test naming
|
||||
grep "^func Test" pkg/**/*_test.go \
|
||||
| grep -v "Test[A-Z][a-z]*_.*_\(Good\|Bad\|Ugly\)"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Consumer RFCs
|
||||
|
||||
| Package | RFC | Role |
|
||||
|---------|-----|------|
|
||||
| core/go | `core/go/docs/RFC.md` | Primitives — all 21 sections |
|
||||
| go-process | `core/go-process/docs/RFC.md` | Process Action handlers |
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
|
||||
- 2026-03-25: Initial spec — written with full core/go v0.8.0 domain context.
|
||||
Loading…
Add table
Reference in a new issue