Skip to content

Commit a56bf68

Browse files
CSCSoftwareclaude
andcommitted
docs: overhaul auto-setup instructions — add Log Hub, fix tool counts (v1.16.2)
Complete rewrite of CLAUDE_MD_BLOCK in setup.ts: - Add Log Hub section (init, query, HTTP API, Viewer integration) - Add missing query params (modified_before, file_filter, type_filter) - Add task/note summary fields, global_init show_progress - Update tool count 28 → 30, Viewer description includes Logs tab - README: add aidex_log to Available Tools table Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 1ab55ab commit a56bf68

5 files changed

Lines changed: 65 additions & 13 deletions

File tree

.claude/CLAUDE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
MCP Server für persistentes Code-Indexing. Ermöglicht Claude Code schnelle, präzise Suchen statt Grep/Glob.
44

5-
**Version:** 1.16.1 | **Sprachen:** 11 | **Repo:** https://github.com/CSCSoftware/AiDex
5+
**Version:** 1.16.2 | **Sprachen:** 11 | **Repo:** https://github.com/CSCSoftware/AiDex
66

77
## Build & Run
88

@@ -36,7 +36,7 @@ Registriert als MCP Server `aidex` (Prefix: `mcp__aidex__aidex_*`).
3636
**Nach Änderungen:** Build ausführen, dann Claude Code neu starten.
3737
**MCP-Name:** Server muss als `"aidex"` registriert sein → Prefix wird `mcp__aidex__aidex_*`.
3838

39-
## Tools (28)
39+
## Tools (30)
4040

4141
### Suche & Index
4242
| Tool | Beschreibung |

CHANGELOG.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@ All notable changes to AiDex will be documented in this file.
44

55
## [Unreleased]
66

7+
## [1.16.2] - 2026-03-20
8+
9+
### Changed
10+
- **Auto-setup instructions overhaul**: Complete rewrite of the CLAUDE.md/GEMINI.md block installed by `aidex setup`
11+
- Added **Log Hub** section with full usage guide (init, query, HTTP API, Viewer integration)
12+
- Added missing query parameters: `modified_before`, `file_filter`, `type_filter`
13+
- Added `show_progress` for `global_init`
14+
- Added task `summary` field documentation
15+
- Added note `summary` field documentation
16+
- Updated tool count from 28 → 30
17+
- Updated Viewer description to include Logs tab
18+
- Added "Debug my app" to Question → Right Tool table
19+
- **README**: Added `aidex_log` to Available Tools table, updated tool counts to 30
20+
- **Projekt-CLAUDE.md**: Updated tool count to 30
21+
722
## [1.16.1] - 2026-03-20
823

924
### Added

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ Do I want to search code?
303303
- **`contains`**: Finds identifiers containing the term — `render` matches `preRenderSetup`
304304
- **`starts_with`**: Finds identifiers starting with the term — `Update` matches `UpdatePlayer`, `UpdateUI`
305305
306-
### All Tools (29)
306+
### All Tools (30)
307307
308308
| Category | Tools | Purpose |
309309
|----------|-------|---------|
@@ -314,9 +314,10 @@ Do I want to search code?
314314
| Global Search | `aidex_global_init`, `aidex_global_query`, `aidex_global_signatures`, `aidex_global_status`, `aidex_global_refresh` | Search across ALL projects |
315315
| Guidelines | `aidex_global_guideline` | Persistent AI instructions & conventions (key-value, global) |
316316
| Sessions | `aidex_session`, `aidex_note` | Track sessions, leave notes (with searchable history) |
317-
| Tasks | `aidex_task`, `aidex_tasks` | Built-in backlog with priorities, tags, auto-logged history |
317+
| Tasks | `aidex_task`, `aidex_tasks` | Built-in backlog with priorities, tags, summaries, auto-logged history |
318+
| Log Hub | `aidex_log` | Universal log receiver — any program sends logs via HTTP, AI queries them, live in Viewer |
318319
| Screenshots | `aidex_screenshot`, `aidex_windows` | Screen capture with LLM optimization (scale + color reduction, no index needed) |
319-
| Viewer | `aidex_viewer` | Interactive browser UI with file tree, signatures, tasks |
320+
| Viewer | `aidex_viewer` | Interactive browser UI with file tree, signatures, tasks, and live logs |
320321
321322
**11 languages:** C#, TypeScript, JavaScript, Rust, Python, C, C++, Java, Go, PHP, Ruby
322323
@@ -414,6 +415,7 @@ aidex_init({ path: "/path/to/your/project" })
414415
| `aidex_global_signatures` | Search methods/types by name across all projects |
415416
| `aidex_global_refresh` | Update stats and remove stale projects from global DB |
416417
| `aidex_global_guideline` | Store/retrieve AI guidelines and coding conventions (key-value, global) |
418+
| `aidex_log` | Universal log receiver — start HTTP server, query logs, live stream in Viewer |
417419

418420
## Time-based Filtering
419421

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "aidex-mcp",
3-
"version": "1.16.1",
3+
"version": "1.16.2",
44
"mcpName": "io.github.CSCSoftware/aidex",
55
"description": "MCP Server for persistent code indexing. Gives AI assistants (Claude, Gemini, Copilot, Cursor) instant access to your codebase. 50x less context than grep.",
66
"main": "build/index.js",

src/commands/setup.ts

Lines changed: 42 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -98,20 +98,24 @@ Do I want to search code?
9898
| "Explore all files in src/" | \`aidex_signatures pattern="src/**"\` |
9999
| "Project overview" | \`aidex_summary\` + \`aidex_tree\` |
100100
| "What changed recently?" | \`aidex_query term="X" modified_since="2h"\` |
101+
| "What changed before yesterday?" | \`aidex_query term="X" modified_before="1d"\` |
101102
| "What files changed today?" | \`aidex_files path="." modified_since="8h"\` |
103+
| "Only search in src/server/" | \`aidex_query term="X" file_filter="src/server/**"\` |
104+
| "Only method definitions" | \`aidex_query term="X" type_filter=["method"]\` |
102105
| "Have I ever written X?" | \`aidex_global_query term="X" mode="contains"\` |
103106
| "Which project has class Y?" | \`aidex_global_signatures term="Y" kind="class"\` |
104107
| "All indexed projects?" | \`aidex_global_status\` |
105108
| "Store coding convention" | \`aidex_global_guideline action="set"\` |
106109
| "Load review checklist" | \`aidex_global_guideline action="get"\` |
110+
| "Debug my app — see logs" | \`aidex_log action="init"\` + \`aidex_viewer\` |
107111
108112
### Search Modes
109113
110114
- **\`exact\`** (default): Finds only the exact identifier — \`log\` won't match \`catalog\`
111115
- **\`contains\`**: Finds identifiers containing the term — \`render\` matches \`preRenderSetup\`
112116
- **\`starts_with\`**: Finds identifiers starting with the term — \`Update\` matches \`UpdatePlayer\`, \`UpdateUI\`
113117
114-
### All Tools (28)
118+
### All Tools (30)
115119
116120
| Category | Tools | Purpose |
117121
|----------|-------|---------|
@@ -121,10 +125,11 @@ Do I want to search code?
121125
| Cross-Project | \`aidex_link\`, \`aidex_unlink\`, \`aidex_links\`, \`aidex_scan\` | Link dependencies, discover projects |
122126
| Global Search | \`aidex_global_init\`, \`aidex_global_query\`, \`aidex_global_signatures\`, \`aidex_global_status\`, \`aidex_global_refresh\` | Search across ALL projects |
123127
| Guidelines | \`aidex_global_guideline\` | Persistent AI instructions & conventions (key-value, global) |
124-
| Sessions | \`aidex_session\`, \`aidex_note\` | Track sessions, leave notes (with searchable history) |
125-
| Tasks | \`aidex_task\`, \`aidex_tasks\` | Built-in backlog with priorities, tags, auto-logged history |
126-
| Screenshots | \`aidex_screenshot\`, \`aidex_windows\` | Cross-platform screen capture (no index needed) |
127-
| Viewer | \`aidex_viewer\` | Interactive browser UI with file tree, signatures, tasks |
128+
| Sessions | \`aidex_session\`, \`aidex_note\` | Track sessions, leave notes (with searchable history & summaries) |
129+
| Tasks | \`aidex_task\`, \`aidex_tasks\` | Built-in backlog with priorities, tags, summaries, auto-logged history |
130+
| Log Hub | \`aidex_log\` | Universal log receiver — any program sends logs via HTTP, AI queries them, live in Viewer |
131+
| Screenshots | \`aidex_screenshot\`, \`aidex_windows\` | Cross-platform screen capture with LLM optimization (scale + color reduction) |
132+
| Viewer | \`aidex_viewer\` | Interactive browser UI with file tree, signatures, tasks, and live logs |
128133
129134
### Session Notes
130135
@@ -138,26 +143,56 @@ aidex_note({ path: ".", clear: true }) # Clear
138143
\`\`\`
139144
- **Before ending a session:** automatically leave a note about next steps
140145
- **User says "remember for next session: ..."** → write it immediately
146+
- Provide \`summary\` when writing/clearing — the archived note gets a one-sentence description
141147
142148
### Task Backlog
143149
144150
Track TODOs, bugs, and features right next to your code index:
145151
\`\`\`
146-
aidex_task({ path: ".", action: "create", title: "Fix bug", priority: 1, tags: "bug" })
152+
aidex_task({ path: ".", action: "create", title: "Fix bug", priority: 1, tags: "bug", summary: "Short description for backlog overview" })
147153
aidex_task({ path: ".", action: "update", id: 1, status: "done" })
148154
aidex_task({ path: ".", action: "log", id: 1, note: "Root cause found" })
149155
aidex_tasks({ path: ".", status: "active" })
150156
\`\`\`
151157
Priority: 1=high, 2=medium, 3=low | Status: \`backlog → active → done | cancelled\`
158+
Summaries: One-sentence table-of-contents per task — scan the backlog without reading full details.
159+
160+
### Log Hub — Universal Logging
161+
162+
Any program (C#, Python, Node, C++, etc.) can send logs via HTTP POST. The AI queries them, and the user sees them live in the Viewer.
163+
164+
**When to use:** Whenever working on a program that needs debugging, testing, or logging — **proactively offer Log Hub + Viewer**.
165+
166+
\`\`\`
167+
aidex_log({ action: "init" }) # Start server (port 3335)
168+
aidex_log({ action: "init", persist: true, path: "." }) # With DB persistence
169+
aidex_log({ action: "query" }) # Last 50 entries
170+
aidex_log({ action: "query", since: "10m", level: "error" }) # Errors last 10 min
171+
aidex_log({ action: "query", source: "MyApp", contains: "crash" }) # Filtered
172+
aidex_log({ action: "query", consume: true }) # Poll & remove (no duplicates)
173+
aidex_log({ action: "write", message: "Debug started" }) # AI writes entry
174+
aidex_log({ action: "status" }) # Stats
175+
aidex_log({ action: "clear" }) # Clear buffer
176+
aidex_log({ action: "free" }) # Stop server
177+
\`\`\`
178+
179+
**HTTP API** for external programs — just POST to \`http://localhost:3335/log\`:
180+
\`\`\`json
181+
{ "level": "info", "source": "MyApp", "message": "Player spawned", "data": { "x": 10 } }
182+
\`\`\`
183+
Levels: \`debug\`, \`info\`, \`warn\`, \`error\` | Batch: POST array to \`/logs\` | Health: GET \`/health\`
184+
185+
**Viewer integration:** Open \`aidex_viewer({ path: "." })\` — the Logs tab shows a live WebSocket stream with level/source/text filters.
152186
153187
### Global Search (across all projects)
154188
155189
\`\`\`
156190
aidex_global_init({ path: "/path/to/all/repos" }) # Scan & register
157-
aidex_global_init({ path: "...", index_unindexed: true }) # + auto-index small projects
191+
aidex_global_init({ path: "...", index_unindexed: true, show_progress: true }) # Auto-index + browser progress UI
158192
aidex_global_query({ term: "TransparentWindow", mode: "contains" }) # Search everywhere
159193
aidex_global_signatures({ term: "Render", kind: "method" }) # Find methods everywhere
160194
aidex_global_status({ sort: "recent" }) # List all projects
195+
aidex_global_refresh() # Update stats, remove stale
161196
\`\`\`
162197
163198
### Screenshots

0 commit comments

Comments
 (0)