Skip to content

Commit 8fc243c

Browse files
jgravelleclaude
andcommitted
Update README for v0.2.8: new features, _meta envelope, doc cleanup
- _meta example now shows tokens_saved, cost_avoided, total_cost_avoided - Recent Updates section covering v0.2.2 through v0.2.8 - Security section updated with specific hardening details - Documentation links pruned (removed deleted files) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent b8582f5 commit 8fc243c

1 file changed

Lines changed: 34 additions & 13 deletions

File tree

README.md

Lines changed: 34 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,30 @@ search_text: { "repo": "owner/repo", "query": "TODO" }
211211
| `get_repo_outline` | High-level repo overview |
212212
| `invalidate_cache` | Remove cached index |
213213

214-
All tool responses include a `_meta` envelope with timing and metadata.
214+
Every tool response includes a `_meta` envelope with timing, token savings, and cost avoided:
215+
216+
```json
217+
"_meta": {
218+
"timing_ms": 4.3,
219+
"tokens_saved": 48153,
220+
"total_tokens_saved": 1280837,
221+
"cost_avoided": { "claude_opus": 0.24, "gpt5_latest": 0.08 },
222+
"total_cost_avoided": { "claude_opus": 6.40, "gpt5_latest": 2.24 }
223+
}
224+
```
225+
226+
`total_tokens_saved` and `total_cost_avoided` accumulate across all tool calls and persist to `~/.code-index/_savings.json`.
227+
228+
---
229+
230+
## Recent Updates
231+
232+
**v0.2.8** — Estimated cost avoided added to every `_meta` response (`cost_avoided`, `total_cost_avoided`)
233+
**v0.2.7** — Security fix: `.claude/` excluded from sdist; structural CI guardrails prevent credential bundling
234+
**v0.2.5** — Path traversal hardening in `IndexStore`; `jcodemunch-mcp --help` now works
235+
**v0.2.4** — Live token savings counter (`tokens_saved`, `total_tokens_saved` in every `_meta`)
236+
**v0.2.3** — Google Gemini Flash support (`GOOGLE_API_KEY`); auto-selects between Anthropic and Gemini
237+
**v0.2.2** — PHP language support
215238

216239
---
217240

@@ -235,11 +258,11 @@ See LANGUAGE_SUPPORT.md for full semantics.
235258

236259
Built-in protections:
237260

238-
- Path traversal prevention
239-
- Symlink escape protection
240-
- Secret file exclusion (`.env`, `*.pem`, etc.)
241-
- Binary detection
242-
- Configurable file size limits
261+
- Path traversal prevention (owner/name sanitization + `_safe_content_path` enforcement)
262+
- Symlink escape protection
263+
- Secret file exclusion (`.env`, `*.pem`, etc.)
264+
- Binary detection
265+
- Configurable file size limits
243266

244267
See SECURITY.md for details.
245268

@@ -278,13 +301,11 @@ See SECURITY.md for details.
278301

279302
## Documentation
280303

281-
- USER_GUIDE.md
282-
- ARCHITECTURE.md
283-
- SPEC.md
284-
- SECURITY.md
285-
- SYMBOL_SPEC.md
286-
- CACHE_SPEC.md
287-
- LANGUAGE_SUPPORT.md
304+
- USER_GUIDE.md
305+
- ARCHITECTURE.md
306+
- SPEC.md
307+
- SECURITY.md
308+
- LANGUAGE_SUPPORT.md
288309

289310
---
290311

0 commit comments

Comments
 (0)