Skip to content

Comments

fix(docs): stale docs after v1.0.8#95

Open
ramonclaudio wants to merge 1 commit intotobi:mainfrom
ramonclaudio:fix/stale-docs
Open

fix(docs): stale docs after v1.0.8#95
ramonclaudio wants to merge 1 commit intotobi:mainfrom
ramonclaudio:fix/stale-docs

Conversation

@ramonclaudio
Copy link

@ramonclaudio ramonclaudio commented Feb 2, 2026

v1.0.8 shipped a bunch of renames and removals but the docs didn't follow. Went through mcp.ts, store.ts, qmd.ts, llm.ts, and collections.ts line by line and fixed everything that was wrong.

mcp-setup.md had the old tool name structured_search (now query, mcp.ts:244), wrong param name on get (path should be file, mcp.ts:367), a ghost full param that doesn't exist, and missing fromLine/maxLines. collection was a string, now it's a collections array (mcp.ts:313). Also missing the expand search type.

README.md listed 3 dead MCP tools (qmd_search, qmd_vector_search, qmd_deep_search). Only qmd_query exists now. HTTP section said "two endpoints" but POST /query was missing. Reranker section said rankAndSort() but the code uses rankAll() (llm.ts:1054). Said "Top 30" but RERANK_CANDIDATE_LIMIT = 40 (store.ts:227). Score table had "LLM 0-10 rating / score / 10" which isn't how rankAll() works. Schema listed collections and path_contexts tables that get DROP TABLE'd on init (store.ts:636-637). Env vars table was missing XDG_CONFIG_HOME and NO_COLOR.

docs/SYNTAX.md had a "q" param in the API example that doesn't exist anywhere in mcp.ts.

CLAUDE.md still had qmd context check (removed in 262c7d3), was missing 4 collection subcommands (show, update-cmd, include, exclude), and said "Qwen3" instead of qmd-query-expansion-1.7B.

Changes

  • skills/qmd/references/mcp-setup.md: tool rename, param fixes, added expand type (+5/-3)
  • README.md: dead tool names, missing endpoint, reranker, schema, env vars (+22/-15)
  • docs/SYNTAX.md: removed ghost q param (+4/-12)
  • CLAUDE.md: removed dead cmd, added missing subcommands, fixed model name (+6/-5)

Test plan

  • mcp-setup.md params match mcp.ts tool schemas
  • README tool list matches registerTool() calls
  • README schema matches store.ts CREATE TABLE statements

@ramonclaudio ramonclaudio changed the title fix(docs): align MCP tool docs and help text with actual code fix(docs): align mcp-setup.md tool params with mcp.ts Feb 20, 2026
@ramonclaudio ramonclaudio changed the title fix(docs): align mcp-setup.md tool params with mcp.ts fix(docs): align MCP tool docs with actual code Feb 20, 2026
@ramonclaudio ramonclaudio changed the title fix(docs): align MCP tool docs with actual code fix(docs): align docs with v1.0.8 code Feb 20, 2026
@ramonclaudio ramonclaudio changed the title fix(docs): align docs with v1.0.8 code fix(docs): stale docs after v1.0.8 Feb 20, 2026
@ramonclaudio
Copy link
Author

cc: @tobi

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