Skip to content

docs(readme): correct tool count to 14, clarify semantic_query and artifact persistence - #1315

Open
Solaris-star wants to merge 2 commits into
DeusData:mainfrom
Solaris-star:fix/1297-readme-tool-count-and-params
Open

docs(readme): correct tool count to 14, clarify semantic_query and artifact persistence#1315
Solaris-star wants to merge 2 commits into
DeusData:mainfrom
Solaris-star:fix/1297-readme-tool-count-and-params

Conversation

@Solaris-star

Copy link
Copy Markdown

Summary

Fixes #1297

Three factual corrections to the README:

  1. Tool count is 14, not 15 — the server advertises 14 via tools/list (paginated 8 + 6), and the README's own MCP Tools table lists exactly 14 rows. Fixed in the intro, the feature list, the manual-config verify step, and the source-layout comment.

  2. semantic_query is a parameter of search_graph, not a standalone tool — invoking it as a tool returns unknown tool: semantic_query. Reworded the Search section to read "via the semantic_query parameter of search_graph".

  3. The team-shared artifact is opt-inpersistence defaults to false (src/mcp/mcp.c:376), so no .codebase-memory/graph.db.zst is written unless persistence: true is passed explicitly. Clarified the artifact paragraph.

Docs-only change; no code touched.

@Solaris-star
Solaris-star requested a review from DeusData as a code owner July 28, 2026 06:23
…tifact persistence

Three factual corrections flagged in DeusData#1297:

1. Tool count is 14, not 15 — the server advertises 14 via tools/list
   (paginated 8+6), and the README's own MCP Tools table lists 14 rows.
   Fixed in the intro, feature list, manual-config verify step, and the
   source-layout comment.

2. semantic_query is a parameter of search_graph, not a standalone tool —
   calling it as a tool returns 'unknown tool'. Reworded the Search
   section to say 'via the semantic_query parameter of search_graph'.

3. The team-shared artifact is opt-in — persistence defaults to false
   (src/mcp/mcp.c:376), so the artifact is only written when
   'persistence: true' is passed. Clarified the artifact paragraph.

Fixes DeusData#1297

Signed-off-by: Solaris-star <820622658@qq.com>
@Solaris-star
Solaris-star force-pushed the fix/1297-readme-tool-count-and-params branch from 140d572 to 0f985c6 Compare July 28, 2026 06:23
@DeusData DeusData added documentation Improvements or additions to documentation ux/behavior Display bugs, docs, adoption UX priority/normal Standard review queue; useful PR with ordinary maintainer urgency. labels Jul 28, 2026
@DeusData DeusData added this to the 0.9.1-rc milestone Jul 28, 2026
@DeusData

DeusData commented Jul 28, 2026

Copy link
Copy Markdown
Owner

Thank you for the contribution and for grounding the README corrections in the advertised tool list and current persistence default. This is now triaged as a normal-priority documentation correction for 0.9.1-rc. Our community PR queue is currently quite full, so it may take a little time before we can complete the review and, if approved, merge it. We are doing our best to support community contributions and will return with code-grounded feedback as capacity opens.

@DeusData

Copy link
Copy Markdown
Owner

Thank you for this — two of the three corrections here are genuinely good catches, and I would like them.

Keep these, they are right:

  • semantic_query being described as its own tool was misleading; it is a parameter of search_graph, exactly as you say.
  • The artifact section really should say the snapshot is written when indexing with persistence: true — as written it implies every index run produces one.

But the tool count needs to go the other way: it is 15, not 14.

You were matching --help, which is completely fair — except that --help was itself the bug. It listed 14 tools and omitted check_index_coverage, the 15th and the headline feature of the v0.9.1 release, while MCP tools/list correctly returned all 15 the whole time. That is issue #1361, and #1370 fixes it by deriving the help text from the tool registry so the two can no longer drift.

So the README was right and the CLI was lying. Merging the count change would have propagated the defect into the docs — a good illustration of why matching observed output is not always the same as matching truth.

Could you drop the 15 -> 14 hunks and keep the semantic_query and persistence: true corrections? I will merge it as soon as it is updated. If you would rather not spend more time on it, tell me and I will land those two fixes with a Co-Authored-By credit to you.

@Solaris-star

Copy link
Copy Markdown
Author

Thanks for the thorough triage — completely fair. The --help output was indeed the bug, not the README. I'll drop the 15 → 14 hunks and keep only the semantic_query parameter clarification and the persistence: true artifact correction. Will push the update shortly.

Appreciate the offer of Co-Authored-By credit, but happy to make the fix myself since it's a quick trim.

@adfjadfj16-a11y

adfjadfj16-a11y commented Jul 31, 2026 via email

Copy link
Copy Markdown

…ert tool count change

Per maintainer feedback: the --help output was the bug, not the README.
Reverting the 15→14 tool count hunks while keeping the semantic_query
parameter clarification and persistence: true artifact correction.
@DeusData

Copy link
Copy Markdown
Owner

@Solaris-star — a quick clarification so nobody is left waiting on the wrong signal.

The comment above is from another GitHub user, not from this project. No merge decision has been made here, and merges on this repository are only ever performed by the maintainers from this account. Please treat any other "I will merge this immediately" message on your PRs — here or elsewhere — as not binding, whatever it appears to say.

Nothing changes on your side: the plan you described is the right one. Drop the 15 → 14 hunks, keep the semantic_query parameter clarification and the persistence: true artifact correction, and push. Once it is up I will re-read the trimmed diff and take it from there.

One thing to fix while you are pushing: the dco check is currently red on this PR. Each commit needs a Signed-off-by: line matching the commit author, which git commit -s adds for you — for existing commits, git rebase --signoff <base> and a force-push to your branch will do it. That check is required, so it will block the merge even once the content is right.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation priority/normal Standard review queue; useful PR with ordinary maintainer urgency. ux/behavior Display bugs, docs, adoption UX

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README: semantic_query is not a tool, the tool count is 14 not 15, and the team artifact is not written by default

3 participants