Skip to content

KS78: Sync docs — ROADMAP v0.7.5, CHANGELOG, MCP tool count#26

Merged
Liorrr merged 4 commits into
masterfrom
chore/ks78-sync-docs-v2
Jun 18, 2026
Merged

KS78: Sync docs — ROADMAP v0.7.5, CHANGELOG, MCP tool count#26
Liorrr merged 4 commits into
masterfrom
chore/ks78-sync-docs-v2

Conversation

@Liorrr

@Liorrr Liorrr commented Apr 10, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Rewrite docs/ROADMAP.md from stale v0.5.0 to current v0.7.5: 11 crates + CLI workspace, GraphRAG, entity unification, configurable embedding, universal prompt, temporal boost, multiplicative supersession demotion, benchmark scores (19/20 seeded, 5/5 abstention, 3/3 NR, 24.2% LME-S)
  • Add CHANGELOG.md v0.7.5 section covering KS67-KS78 changes
  • Fix MCP tool count 9 to 12 in CONTRIBUTING.md
  • Update MCP tool list to all 12 tools in docs/ARCHITECTURE.md
  • Bump supported version 0.5.x to 0.7.x in SECURITY.md

Test plan

  • Verify only .md files changed (no .rs or .toml)
  • Verify ROADMAP.md header says v0.7.5
  • Verify CHANGELOG.md v0.7.5 section present with KS67-KS78 entries
  • Verify CONTRIBUTING.md says 12 tools
  • Verify ARCHITECTURE.md lists all 12 MCP tools
  • Verify SECURITY.md says 0.7.x

🤖 Generated with Claude Code

- Rewrite docs/ROADMAP.md from stale v0.5.0 to v0.7.5: 11 crates,
  GraphRAG, entity unification, configurable embedding, universal prompt,
  temporal boost, supersession demotion, benchmark scores
- Add CHANGELOG.md v0.7.5 section covering KS67-KS78
- Fix MCP tool count 9 -> 12 in CONTRIBUTING.md
- Update MCP tool list to all 12 tools in docs/ARCHITECTURE.md
- Bump SECURITY.md supported version 0.5.x -> 0.7.x

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

@greptile-apps greptile-apps Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Liorrr has reached the 50-review limit for trial accounts. To continue receiving code reviews, upgrade your plan.

@Liorrr Liorrr left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pr-review Summary

This PR syncs documentation to reflect the v0.7.5 release: a new CHANGELOG entry covering KS61–KS78 milestones, updated CONTRIBUTING.md and SECURITY.md version tables, an ARCHITECTURE.md MCP tool list update, and a full ROADMAP rewrite replacing the v0.5.0–v0.7.0 plan with the actual shipped state. No Rust source code is changed.

The docs are accurate in their high-level descriptions of shipped features. However, all four documents that mention the MCP tool count claim 12 tools, while the authoritative source — the assertion in crates/shrimpk-mcp/src/handler.rs on master — asserts 14 base tools, including entity_search (KS62) and community_summaries (KS64) which are not listed or counted anywhere in this PR.

Confidence Score: 4/5

Four P2 findings (no P1s). Docs-only PR; all findings are factual inaccuracies in tool count across four files. Safe to merge with awareness — no code is affected — but the discrepancy will mislead developers and MCP client authors about the current tool surface.

Findings

Sev File Line Title
P2 docs/ARCHITECTURE.md 665 MCP tool count understated: docs say 12, code has 14
P2 CONTRIBUTING.md 33 MCP tool count in CONTRIBUTING.md also understated (12 vs 14)
P2 docs/ROADMAP.md 55 ROADMAP workspace table also says 12 MCP tools (should be 14)
P2 CHANGELOG.md 22 CHANGELOG entry claims 12 MCP tools; actual base count on master is 14

Changed Files

File Issue
docs/ARCHITECTURE.md Tool count 12→14, missing entity_search + community_summaries
CONTRIBUTING.md Tool count 12→14
docs/ROADMAP.md Tool count 12→14 in workspace table
CHANGELOG.md Tool count 12→14, missing entity_search + community_summaries from Added list
SECURITY.md Version table updated 0.5.x→0.7.x — correct, no issues

Comment thread docs/ARCHITECTURE.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread docs/ROADMAP.md
Comment thread CHANGELOG.md
…maries

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

@Liorrr Liorrr left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pr-review Summary

This PR syncs the ROADMAP, CHANGELOG, CONTRIBUTING.md, SECURITY.md, and docs/ARCHITECTURE.md to reflect features shipped between v0.7.0 and KS78. The prose and structural changes are accurate: the 14-tool MCP list in ARCHITECTURE.md matches the implementation in tools.rs exactly, the SECURITY.md version table and CONTRIBUTING.md tool count are correct, and the ROADMAP workspace crate table is up to date. However, two factual errors affect correctness:

  1. Version mismatch — CHANGELOG and ROADMAP declare v0.7.5 but Cargo.toml [workspace.package] version is still 0.7.0. No Cargo version bump is included in this PR.
  2. Wrong attribution of new MCP toolsconfig_set and persist are credited as newly added in [0.7.5], but both were present in the v0.7.0 nine-tool set (verified against the deleted ROADMAP text and tools.rs). The five genuinely new tools are memory_graph, memory_related, memory_get, entity_search, and community_summaries.

The arithmetic (9 → 14) is correct, but the tool names listed under the management additions are wrong, and the version number is unsupported by Cargo.toml.

Confidence Score: 3/5

Two P1 factual inaccuracies (version number and tool attribution) block merge. One P2 (duplicate tool count entry) is non-blocking.

Severity Count Description
P1 2 Version mismatch (Cargo says 0.7.0); wrong tools credited as new
P2 1 Tool count stated twice (Added + Changed sections)
File Issue
CHANGELOG.md P1 — config_set/persist listed as new but were in v0.7.0
CHANGELOG.md P1 — Version header [0.7.5] not in Cargo.toml
CHANGELOG.md P2 — Tool count duplicated across Added and Changed
docs/ROADMAP.md P1 — v0.7.5 heading contradicts Cargo.toml 0.7.0

Comment thread CHANGELOG.md Outdated
Comment thread CHANGELOG.md Outdated
Comment thread docs/ROADMAP.md Outdated
Comment thread CHANGELOG.md
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

@Liorrr Liorrr left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pr-review Summary (run 2)

This PR syncs documentation for the v0.7.5 docs cycle: it rewrites docs/ROADMAP.md, updates the MCP tool count to 14 across CHANGELOG.md, CONTRIBUTING.md, docs/ARCHITECTURE.md, and docs/ROADMAP.md, and refreshes SECURITY.md supported-versions. Ground truth: crates/shrimpk-mcp/src/tools.rs defines exactly 14 base tools (store, echo, stats, forget, dump, config_show, config_set, persist, status, memory_graph, memory_related, memory_get, entity_search, community_summaries), plus 2 feature-gated multimodal tools (store_image/vision, store_audio/speech). The tool count corrections are accurate.

Confidence Score: 2/5

Two P1 factual issues remain open: a declared-but-unreleased version, and pre-existing tools mis-credited as new.

Status of previous findings

  • P2 tool count = 12 (ARCHITECTURE l.665, CONTRIBUTING l.33, ROADMAP l.55, CHANGELOG l.22): RESOLVED — all four files now state 14, and ROADMAP/ARCHITECTURE list exactly the 14 base tool names.
  • P1 version mismatch (CHANGELOG 0.7.5 vs Cargo 0.7.0): STILL OPEN — Cargo.toml [workspace.package] version is still 0.7.0 on this branch; CLAUDE.md still says v0.7.0. CHANGELOG declares [0.7.5] — 2026-04-10 as a dated release.
  • P1 wrong tools credited as new (config_set, persist): STILL OPEN — CHANGELOG line 20 still lists config_set and persist as Added; both shipped in v0.7.0 (KS7) and appear in this file's own v0.7.0 section (line 182). Internally inconsistent with the "9 to 14" (+5) claim on line 23.
  • P2 tool count stated twice (Added + Changed): N/A — normal changelog structure, not a correctness issue; not re-raised.

New issues

None. The benchmark line (19/20 seeded, 5/5 abstention, 3/3 NR, 24.2% LME-S) and KS sprint attributions match project state.

Findings table

Severity File Line Issue
P1 CHANGELOG.md 9 0.7.5 declared as dated release but Cargo version is 0.7.0 (no bump in PR)
P1 CHANGELOG.md 20 config_set & persist credited as new; both pre-existing since KS7/v0.7.0

Comment thread CHANGELOG.md Outdated
Comment thread CHANGELOG.md Outdated
…ribution

- CHANGELOG/ROADMAP no longer claim v0.7.5 is a dated release (Cargo.toml
  is 0.7.0, no git tag). Mark 0.7.5 as Unreleased / in-progress instead.
- Correct MCP tool attribution: config_set and persist shipped in the
  v0.7.0 nine-tool set, not new in 0.7.5. The 5 genuinely new tools are
  memory_graph, memory_related, memory_get, entity_search,
  community_summaries (9 -> 14).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

@Liorrr Liorrr left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pr-review Summary (run 3)

Final round. Both previously-open P1s are resolved; full diff re-scanned for new issues.

Previous P1 status

  • P1 #1 — Version mismatch: RESOLVED. CHANGELOG.md heading changed from dated [0.7.5] — 2026-04-10 to [0.7.5] — Unreleased. Cargo.toml stays at 0.7.0, so the changelog no longer claims a tagged release that does not exist. ROADMAP echoes this correctly ("Current released version is 0.7.0; v0.7.5 is in development (not yet tagged)").
  • P1 #2 — Wrong tool attribution: RESOLVED. The Added list no longer credits config_set/persist (both shipped in v0.7.0). It now lists the 5 genuinely new tools — memory_graph, memory_related, memory_get, entity_search, community_summaries. Arithmetic is internally consistent (9 → 14, +5).

Ground-truth verification

  • Cross-checked against crates/shrimpk-mcp/src/tools.rs: exactly 14 tools registered. v0.7.0 nine-tool set + the 5 new tools listed in the changelog match the source exactly. ✅
  • Crate count: crates/* expands to 12 directories + cli. ARCHITECTURE.md and ROADMAP.md "12 crates plus a CLI" is accurate; shrimpk-ros2 and shrimpk-viz additions are correct. ✅
  • SECURITY.md supported-version bump (0.5.x → 0.7.x) and CONTRIBUTING.md tool-count (9 → 14) are consistent. ✅

New findings

None.

Confidence Score: 5/5

Both P1s fixed, all tool/crate/version claims verified against source. Recommend merge.

No findings — recommend merge.

@Liorrr
Liorrr merged commit f355b18 into master Jun 18, 2026
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant