feat: add comprehensive documentation for AI Workspace, including architecture, memory model, profiles, services, and security guidelines
This commit is contained in:
61
docs/services.md
Normal file
61
docs/services.md
Normal file
@@ -0,0 +1,61 @@
|
||||
# Services
|
||||
|
||||
The AI Workspace Service Manager provides one profile-aware lifecycle surface for local services.
|
||||
|
||||
## Responsibility
|
||||
|
||||
The service manager starts, stops, checks, and tails logs. It does not merge service responsibilities.
|
||||
|
||||
```text
|
||||
Service Manager → process lifecycle/status/logs
|
||||
MCP Server → read-only context access
|
||||
Connectors → raw evidence capture
|
||||
Agent/Human → memory promotion
|
||||
```
|
||||
|
||||
## Common Commands
|
||||
|
||||
```bash
|
||||
python3 scripts/aiw/services.py status --profile fidelity
|
||||
python3 scripts/aiw/services.py status --profile fidelity --json
|
||||
python3 scripts/aiw/services.py doctor --profile fidelity
|
||||
python3 scripts/aiw/services.py start --profile fidelity
|
||||
python3 scripts/aiw/services.py stop --profile fidelity
|
||||
python3 scripts/aiw/services.py logs aiw-context-mcp --profile fidelity
|
||||
```
|
||||
|
||||
## Service Manifest
|
||||
|
||||
Services are declared per profile:
|
||||
|
||||
```text
|
||||
profiles/<profile>/services.json
|
||||
```
|
||||
|
||||
A service can define:
|
||||
|
||||
- command;
|
||||
- kind;
|
||||
- groups;
|
||||
- dependencies;
|
||||
- restart policy;
|
||||
- doctor checks;
|
||||
- health checks.
|
||||
|
||||
## Current Service Types
|
||||
|
||||
- `process`: long-running command with PID/log tracking.
|
||||
- `app-launcher`: one-shot command that opens an app/helper.
|
||||
- `mcp`: process service exposing an MCP-compatible context server.
|
||||
|
||||
## Runtime Files
|
||||
|
||||
Runtime artifacts are local and ignored:
|
||||
|
||||
```text
|
||||
.aiw/runtime/pids/
|
||||
.aiw/runtime/logs/
|
||||
.aiw/runtime/state/
|
||||
```
|
||||
|
||||
These files are operational state, not project memory.
|
||||
Reference in New Issue
Block a user