agent-as-a-tutor 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -4
- package/package.json +15 -3
- package/process/_seeds/learning-session.md.seed +0 -44
package/README.md
CHANGED
|
@@ -15,9 +15,10 @@ The open agent skills ecosystem • strict-tutor
|
|
|
15
15
|
|
|
16
16
|
---
|
|
17
17
|
|
|
18
|
-
##
|
|
18
|
+
## Installation into Project Scope via `npx`
|
|
19
19
|
|
|
20
20
|
### Method 1: Using the Standalone CLI (Zero-Dependencies)
|
|
21
|
+
|
|
21
22
|
Another user can install the Strict Tutor directly into their project or folder scope using:
|
|
22
23
|
|
|
23
24
|
```bash
|
|
@@ -32,6 +33,7 @@ npx github:DamPhuQuy/agent-as-a-tutor .
|
|
|
32
33
|
```
|
|
33
34
|
|
|
34
35
|
### Method 2: Using the Official `skills` CLI (`skills.sh`)
|
|
36
|
+
|
|
35
37
|
Because this repository conforms strictly to the open agent skills specification, users can also install it via the popular `skills` CLI:
|
|
36
38
|
|
|
37
39
|
```bash
|
|
@@ -44,18 +46,19 @@ npx skills add DamPhuQuy/agent-as-a-tutor --list
|
|
|
44
46
|
|
|
45
47
|
---
|
|
46
48
|
|
|
47
|
-
##
|
|
49
|
+
## How to Use the Strict Tutor
|
|
48
50
|
|
|
49
51
|
Once installed in a project, start a strict learning session with your AI assistant:
|
|
50
52
|
|
|
51
53
|
```text
|
|
52
54
|
/tutor <keyword or topic>
|
|
53
55
|
```
|
|
56
|
+
|
|
54
57
|
*(e.g., `/tutor raft consensus`, `/tutor virtual memory`, `/tutor event loop`, or `/tutor b-trees`)*
|
|
55
58
|
|
|
56
59
|
---
|
|
57
60
|
|
|
58
|
-
##
|
|
61
|
+
## The 5-Step Understanding Framework
|
|
59
62
|
|
|
60
63
|
1. **Step 1: Intuition & Grounding (The "Why"):** Explain the existential problem in plain English without buzzwords (Quality Gate QG1).
|
|
61
64
|
2. **Step 2: Mental Model & First Principles (The "What"):** Decompose into atomic components and invariants (Quality Gate QG2).
|
|
@@ -65,7 +68,8 @@ Once installed in a project, start a strict learning session with your AI assist
|
|
|
65
68
|
|
|
66
69
|
---
|
|
67
70
|
|
|
68
|
-
##
|
|
71
|
+
## Anti-Cargo-Cult Invariants
|
|
72
|
+
|
|
69
73
|
- **Zero Direct Solutions:** The tutor never provides answers or solution code upfront.
|
|
70
74
|
- **Zero Unearned Praise:** Pure objective feedback based on verified evidence.
|
|
71
75
|
- **Buzzword Interception:** Any ungrounded jargon halts the evaluation and demands explanation in plain terms.
|
package/package.json
CHANGED
|
@@ -1,12 +1,20 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "agent-as-a-tutor",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "Strict Socratic Tutor enforcing the 5-Step Understanding Framework, Anti-Cargo-Culting rules, and Evidence-First Quality Gates for AI Coding Agents.",
|
|
5
5
|
"main": "bin/cli.js",
|
|
6
6
|
"bin": {
|
|
7
|
-
"agent-as-a-tutor": "
|
|
8
|
-
"strict-tutor": "
|
|
7
|
+
"agent-as-a-tutor": "bin/cli.js",
|
|
8
|
+
"strict-tutor": "bin/cli.js"
|
|
9
9
|
},
|
|
10
|
+
"repository": {
|
|
11
|
+
"type": "git",
|
|
12
|
+
"url": "git+https://github.com/DamPhuQuy/Agent-as-a-tutor.git"
|
|
13
|
+
},
|
|
14
|
+
"bugs": {
|
|
15
|
+
"url": "https://github.com/DamPhuQuy/Agent-as-a-tutor/issues"
|
|
16
|
+
},
|
|
17
|
+
"homepage": "https://github.com/DamPhuQuy/Agent-as-a-tutor#readme",
|
|
10
18
|
"scripts": {
|
|
11
19
|
"test": "node bin/cli.js --help"
|
|
12
20
|
},
|
|
@@ -28,6 +36,10 @@
|
|
|
28
36
|
],
|
|
29
37
|
"author": "Phu Quy Dam",
|
|
30
38
|
"license": "MIT",
|
|
39
|
+
"publishConfig": {
|
|
40
|
+
"access": "public",
|
|
41
|
+
"provenance": true
|
|
42
|
+
},
|
|
31
43
|
"engines": {
|
|
32
44
|
"node": ">=18.0.0"
|
|
33
45
|
}
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
# Learning Session: [TOPIC]
|
|
2
|
-
|
|
3
|
-
<learning_session version="1.0" framework="RIPER-5">
|
|
4
|
-
|
|
5
|
-
<!-- Tutor Session State Ledger. Tracks Gate QG1 through QG5 progression. -->
|
|
6
|
-
<session_control>
|
|
7
|
-
<topic>[TOPIC_NAME]</topic>
|
|
8
|
-
<status>IN_PROGRESS</status> <!-- IN_PROGRESS | PAUSED | COMPLETED -->
|
|
9
|
-
<current_step>1</current_step> <!-- 1 | 2 | 3 | 4 | 5 | CERTIFIED -->
|
|
10
|
-
<active_gate>QG1</active_gate> <!-- QG1 | QG2 | QG3 | QG4 | QG5 | COMPLETED -->
|
|
11
|
-
<started_at>[TIMESTAMP]</started_at>
|
|
12
|
-
<last_updated>[TIMESTAMP]</last_updated>
|
|
13
|
-
</session_control>
|
|
14
|
-
|
|
15
|
-
---
|
|
16
|
-
|
|
17
|
-
## 1. Quality Gate Ledger
|
|
18
|
-
|
|
19
|
-
| Gate | Phase | Status | Certified Date | Verified Evidence Summary |
|
|
20
|
-
|---|---|:---:|---|---|
|
|
21
|
-
| **QG1** | Step 1: Intuition & Plain English | `LOCKED` | - | [Pain point and intuition articulated without jargon] |
|
|
22
|
-
| **QG2** | Step 2: Mental Model & Invariants | `LOCKED` | - | [Atomic components and inviolable system rules] |
|
|
23
|
-
| **QG3** | Step 3: Concrete Mechanics & Trace | `LOCKED` | - | [Causal step-by-step trace or minimal implementation] |
|
|
24
|
-
| **QG4** | Step 4: Boundaries & Anti-Cargo-Cult | `LOCKED` | - | [Failure modes, operational costs, anti-patterns] |
|
|
25
|
-
| **QG5** | Step 5: Synthesis & Feynman Transfer | `LOCKED` | - | [Unassisted transfer solution or novice explanation] |
|
|
26
|
-
|
|
27
|
-
---
|
|
28
|
-
|
|
29
|
-
## 2. Inviolable Pedagogical Rules
|
|
30
|
-
- **Zero Direct Solutions:** Tutor never gives the answer or writes the solution code.
|
|
31
|
-
- **Zero Unearned Praise:** Tutor evaluates evidence objectively.
|
|
32
|
-
- **Buzzword Penalty:** Jargon used without causal explanation triggers immediate interception.
|
|
33
|
-
- **Socratic Hint Ladder:** Level 1 (Analogy) -> Level 2 (Constraint) -> Level 3 (Contradiction).
|
|
34
|
-
|
|
35
|
-
---
|
|
36
|
-
|
|
37
|
-
## 3. Session Dialogue & Evidence History
|
|
38
|
-
|
|
39
|
-
### Step 1: Intuition & Grounding
|
|
40
|
-
- **Challenge:** [Prompt given by tutor]
|
|
41
|
-
- **Learner Submission:** [Learner response]
|
|
42
|
-
- **Gate Evaluation:** [PASS / PARTIAL / REJECT + critique]
|
|
43
|
-
|
|
44
|
-
</learning_session>
|