Skip to content

Commit 354aef4

Browse files
Claudeclaude
authored andcommitted
docs: expand pro setup guide with complete tool reference
Lists all 30+ tools organized by category: session lifecycle, memory creation, retrieval, threads, multi-agent coordination, knowledge graph, analytics, document indexing, transcripts, and cache management. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 745a0f5 commit 354aef4

1 file changed

Lines changed: 77 additions & 6 deletions

File tree

docs/pro-setup-guide.md

Lines changed: 77 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -99,20 +99,91 @@ All tables have Row Level Security enabled with service role access only.
9999

100100
## Pro tools
101101

102-
With pro activated, these tools persist to Supabase with semantic search:
102+
All tools work in both free and pro tiers. In free tier, data is stored locally in `.gitmem/`. In pro tier, data persists to Supabase with semantic vector search via embeddings.
103+
104+
### Session lifecycle
105+
106+
| Tool | What it does |
107+
|------|-------------|
108+
| `session_start` | Loads last session context, open threads, recent decisions |
109+
| `session_refresh` | Re-surface institutional context mid-session (after compaction) |
110+
| `session_close` | Persists session reflection, learnings, and compliance |
111+
112+
### Memory creation
113+
114+
| Tool | What it does |
115+
|------|-------------|
116+
| `create_learning` | Store a scar, win, or pattern (with embedding in pro) |
117+
| `create_decision` | Log a decision with rationale and alternatives |
118+
| `record_scar_usage` | Track when a scar was surfaced and how it was applied |
119+
120+
### Retrieval
103121

104122
| Tool | What it does |
105123
|------|-------------|
106-
| `session_start` | Loads context from last session, open threads, recent decisions |
107-
| `session_close` | Persists session reflection and learnings |
108124
| `recall` | Semantic search for relevant scars before taking action |
109-
| `create_learning` | Store a scar, win, or pattern with embedding |
110-
| `create_decision` | Log a decision with rationale |
125+
| `confirm_scars` | Acknowledge recalled scars as APPLYING, N_A, or REFUTED |
126+
| `reflect_scars` | End-of-session scar reflection (how each was handled) |
111127
| `search` | Search institutional memory by keyword or semantics |
112128
| `log` | Browse recent learnings chronologically |
129+
130+
### Threads
131+
132+
| Tool | What it does |
133+
|------|-------------|
113134
| `create_thread` | Track unresolved work across sessions |
114135
| `list_threads` | View open threads |
115-
| `confirm_scars` | Acknowledge recalled scars before proceeding |
136+
| `resolve_thread` | Mark a thread as resolved |
137+
| `promote_suggestion` | Promote a suggested thread to an open thread |
138+
| `dismiss_suggestion` | Dismiss a suggested thread |
139+
| `cleanup_threads` | Triage threads by lifecycle health (active/cooling/dormant) |
140+
141+
### Multi-agent coordination
142+
143+
| Tool | What it does |
144+
|------|-------------|
145+
| `prepare_context` | Generate compact memory payload for sub-agent injection |
146+
| `absorb_observations` | Capture and persist findings from sub-agents |
147+
148+
### Knowledge graph
149+
150+
| Tool | What it does |
151+
|------|-------------|
152+
| `graph_traverse` | Traverse knowledge graph connections (connected_to, produced_by, provenance, stats) |
153+
| `archive_learning` | Archive a scar/win/pattern (excluded from recall, preserved for audit) |
154+
155+
### Analytics and diagnostics
156+
157+
| Tool | What it does |
158+
|------|-------------|
159+
| `analyze` | Session analytics and insights (summary, reflections, blindspots) |
160+
| `health` | Show write health for the current session |
161+
| `contribute_feedback` | Submit feedback about gitmem |
162+
163+
### Document indexing
164+
165+
| Tool | What it does |
166+
|------|-------------|
167+
| `index_docs` | Index a directory of markdown files for semantic search |
168+
| `search_docs` | Search indexed documentation |
169+
170+
### Transcripts (pro only)
171+
172+
| Tool | What it does |
173+
|------|-------------|
174+
| `save_transcript` | Save a session transcript |
175+
| `get_transcript` | Retrieve a saved transcript |
176+
| `search_transcripts` | Search across saved transcripts |
177+
178+
### Cache management
179+
180+
| Tool | What it does |
181+
|------|-------------|
182+
| `gitmem-cache-status` | Show local search cache status |
183+
| `gitmem-cache-health` | Compare local cache against remote Supabase |
184+
| `gitmem-cache-flush` | Force reload cache from Supabase |
185+
186+
Most tools also have short aliases (`gm-scar`, `gm-search`, `gm-threads`, etc.) for faster invocation.
116187

117188
## Deactivation
118189

0 commit comments

Comments
 (0)