docs(memory): add MemoryVision.md + gap analysis and related doc updates

- New MemoryVision.md outlining long-term vision for phase-memory integration in cya (profiles, phases, lifecycle, ports)
- Persisted full Intent-vs-Scope gap analysis in history/
- Updated SCOPE.md to reflect post-MVP reality and MemoryVision direction
- Minor cross-references in AGENTS.md and the CYA-WP-0001 workplan

This lays the foundation for the next workplan (CYA-WP-0002) focused on realizing the MemoryVision.

Refs: MemoryVision.md, history/2026-05-26-CYA-Intent-Scope-Gap-Analysis.md, CYA-WP-0001 T05/T08
This commit is contained in:
2026-05-26 02:42:54 +02:00
parent ece0453f12
commit f93b766e12
5 changed files with 351 additions and 41 deletions

113
SCOPE.md
View File

@@ -2,45 +2,98 @@
## Purpose
`can-you-assist` provides `cya`, a console-native LLM helper for practical
local work. It lets a terminal user ask for help in natural language, gather
relevant local context intentionally, and receive safe, explainable assistance
for command-line, repository, filesystem, note, and text workflows.
`can-you-assist` provides the `cya` command — a console-native, backend-agnostic LLM assistant for practical local work.
It allows users to express intent in natural language from the terminal and receive safe, explainable, context-aware assistance while keeping memory, history, preferences, and adaptation under explicit user control.
## Current Status (Post MVP Slice)
The first narrow implementation slice (CYA-WP-0001) has been delivered. A working `cya` tool now exists that can be installed with `pip install -e .`.
Core capabilities implemented:
- Natural language request handling via a clean Typer CLI.
- Bounded, transparent, non-recursive local context collection (cwd + git + environment + explicit files).
- Genuine rule-based risk classification with mandatory terminal confirmation for anything above "safe".
- Stable `LLMAdapter` Protocol boundary (currently satisfied by a deterministic `FakeLLMAdapter`).
- Strictly minimal explicit no-op ports for future `phase-memory` integration.
- A small orchestrator that coordinates the above.
All LLM interaction flows through the documented adapter seam. No production path bypasses it.
## Owns
- The `cya` command-line user experience.
- Intent parsing and task framing for local shell work.
- Local context collection from the current directory, selected files, stdin,
git state, logs, notes, and user-provided paths.
- Safe command suggestion and explanation workflows.
- Prompt/request orchestration against `llm-connect`.
- Local preference and memory usage through `phase-memory`.
- Transparent configuration and inspectable local state for this assistant.
- The `cya` command-line user experience and argument parsing.
- Intent framing and high-level task classification for console work.
- Local context collection (current directory, git state, selected files, stdin, minimal environment facts).
- Safety layer: rule-based risk assessment + mandatory explicit confirmation flow.
- Orchestration of the request → context → safety → LLM adapter → response pipeline.
- The stable `LLMAdapter` Protocol and the contract for how `cya` talks to LLM backends.
- Explicit, minimal integration points (ports) for `phase-memory`.
- Transparent, inspectable behavior (especially via `--explain-context`).
- User-facing documentation, examples, and safety guarantees for the CLI tool.
## Does Not Own
- Provider-specific LLM clients or vendor credentials; that belongs in
`llm-connect`.
- Long-term memory storage semantics; that belongs in `phase-memory`.
- Global State Hub implementation or workstream indexing.
- Autonomous shell execution without clear user confirmation.
- Hidden, vendor-owned personalization or opaque memory.
- Any specific LLM provider, API client, or model hosting (belongs to `llm-connect`).
- Durable memory storage, preference models, history semantics, or adaptation algorithms (belongs to `phase-memory`).
- Global work tracking, decisions, or cross-repo coordination (belongs to State Hub / custodian).
- Autonomous or background execution of commands without explicit user confirmation.
- Deep repository indexing, embeddings, or large-scale content analysis (explicit non-goal of the first slice).
- Voice, speech, phone-bridge, or non-terminal interfaces (future work).
- Packaging, distribution, or multi-platform installers beyond basic editable install.
- Long-lived conversational REPL or session state (one-shot + very lightweight session only).
## Integrates With
- `llm-connect` for backend-agnostic model access.
- `phase-memory` for user-controlled history, preferences, and adaptation.
- State Hub for work tracking, repo coordination, progress, and decisions.
| Project | Responsibility | Integration Style |
|---------------|-----------------------------------------|------------------------------------|
| `llm-connect` | Provider access, config, token counting, structured responses | Stable `LLMAdapter` Protocol |
| `phase-memory`| User-controlled memory, preferences, history | Explicit thin ports (currently no-op) |
| State Hub | Work tracking, decisions, coordination | HTTP REST (non-runtime) |
## Initial Direction
## MVP Scope (CYA-WP-0001)
The first implementation slice should establish a minimal but real CLI:
What was explicitly in scope for the first slice:
- parse a natural-language request;
- inspect current working-directory context safely;
- produce an explainable command or answer;
- route LLM calls through an adapter boundary shaped for `llm-connect`;
- leave memory hooks explicit but thin until `phase-memory` integration is
ready;
- include tests around command-suggestion safety and context selection.
- A functional `cya` CLI that accepts natural language requests.
- Safe, bounded context collection with full transparency (`--explain-context`).
- Rule-based safety classification as the primary mechanism, with mandatory confirmation.
- A clean, documented adapter boundary for future real LLM backends.
- Strictly minimal memory ports (no hidden state, no local JSON store).
- Basic orchestrator that ties the pieces together.
- Test coverage focused on safety invariants and context rules.
- Clear public boundaries and extension points.
## Explicitly Out of Scope (MVP and Near-Term)
- Any durable or sophisticated memory implementation.
- Real `llm-connect` client (only the contract + fake exists).
- Deep git/repository understanding beyond basic status + log.
- Automatic command execution (even "safe" suggestions).
- Structured editing / patch generation.
- Multi-turn conversation state.
- Cost tracking, token budgeting, or usage dashboards.
- Team/shared memory or collaboration features.
- Plugin system or domain-specific extensions.
## Extension Points (Registered)
- `cya/llm/adapter.py``LLMAdapter` Protocol (the primary seam).
- `cya/memory/__init__.py` — the four explicit ports (`remember_preference`, `recall_preferences`, `forget`, `export_memory`).
- `cya/safety/risk.py` — the `_RULES` table and `classify()` function.
- `cya/context/collector.py` — collection functions and ignore policy.
- `cya/orchestrator.py` — the main coordination entry point.
## Success Criteria (Current Slice)
A new user can:
- Clone the repo, run `pip install -e .`, and successfully use `cya` for 23 realistic tasks after reading only the README.
- Understand exactly what context is being sent via `--explain-context`.
- Trust that dangerous actions will never execute without explicit confirmation.
- See a clear path for how real `llm-connect` and `phase-memory` will plug in later.
Sibling project owners can read the workplan + boundary documentation and know precisely where their packages integrate.
---
**This SCOPE document reflects the state after the CYA-WP-0001 MVP slice.** It is intentionally narrower than the long-term vision in INTENT.md.