Skip to content

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

Open
Solaris-star wants to merge 1 commit 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 1 commit 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.

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

2 participants