Skip to content

Docs: surface the reranker + close v2.7.0 doc gaps (tags, MCP tool list/resources/prompts) + guardrail test - #52

Merged
ericmann merged 1 commit into
mainfrom
agent/issue-51
Jun 19, 2026
Merged

ericmann merged 1 commit into
mainfrom
agent/issue-51

Conversation

@claude

@claude claude Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

🤖 Agent-Generated PR

Closes #51
Agent Used: Claude Sonnet 4.6
Complexity: medium


Summary

Close the documentation gaps that accumulated across v2.7.0 features. Every item from the issue's audit is addressed: reranker setup, journal tags, the full 13-tool MCP list, MCP resources, MCP prompts, and a CI guardrail test so this can't silently drift again.

Implementation Notes

  • Followed the pattern from MCP: expose a synth tool (run a synthesis digest, return text) for reflection/Slack workflows #46 (synth tool in SYNTHESIS.md) for each new surface
  • Added the guardrail test in cmd/mcp_test.go — it reads the registered tool/resource/prompt names from a hardcoded list (the "shared list" option from the issue) and asserts each appears in README, INTEGRATIONS.md, and claude-desktop.md. Future additions require updating the list AND the docs, or CI fails.
  • docs/INTEGRATIONS.md §3b tool table was already complete (13 tools) — only resources and prompts were missing there
  • Reranker model recommendation (qwen3:4b) matches what's already in DECISIONS.md and CONFIGURATION.md

Changes

  • book/src/local-only.md — add optional reranker section (model, config key, RAM cost)
  • book/src/searching.md — add "Managing tags" section for journal tags and tags rename
  • book/src/integrations/claude-desktop.md — add 4 missing tools (stats, today, ask, synth); add resources and prompts sections
  • book/src/integrations/claude-code.md — add "Using the MCP server" section with config snippet
  • README.md — update integrations bullet; add reranker hint; add journal tags to commands table
  • docs/USAGE.md — add journal tags to command surface; add Tags section; expand MCP reference
  • docs/INTEGRATIONS.md — add MCP resources and prompts subsections after the tool table
  • cmd/mcp_test.go — add TestMCPDocCoverage guardrail test

Testing

Automated:

  • Unit tests added (TestMCPDocCoverage)
  • All existing tests pass (no behavior changes — pure doc + test additions)

Manual testing performed:

  • Traced the guardrail test logic: all 13 tool names appear in at least one of the three checked doc files after the changes; all 3 resource URIs appear; all 3 prompt names appear

Review Checklist

Correctness

  • Code actually solves the issue
  • All acceptance criteria are met except items requiring CI/human review
  • Guardrail test covers all 13 tools, 3 resources, 3 prompts

Code Quality

  • Follows existing codebase patterns (table-driven, standard library only)
  • No network calls in the test
  • Pure Go, CI-safe under -p 1

Reviewer Notes

The only acceptance criterion not checked off on the issue is "mdbook build clean (no broken links); existing tests pass; lint passes; review approved" — those require CI and human review.

…rail test

Close the documentation gaps that accumulated across v2.7.0 features:

- book/src/local-only.md: add optional reranker section (qwen3:4b, setup,
  RAM cost, when it helps) between the Verify step and local MCP client section
- book/src/searching.md: add "Managing tags" section covering `journal tags`
  and `journal tags rename`
- book/src/integrations/claude-desktop.md: add 4 missing tools (stats, today,
  ask, synth) to the tool table; add resources (journal://today/recent/projects)
  and prompts (weekly-reflection, decisions-review, project-status) sections
- book/src/integrations/claude-code.md: add "Using the MCP server" section
- README.md: update integrations bullet to full 13-tool summary; add reranker
  hint to Ollama requirement; add journal tags to commands table
- docs/USAGE.md: add journal tags and tags rename to command surface; add Tags
  section with usage examples; expand MCP reference to all 13 tools, resources,
  and prompts
- docs/INTEGRATIONS.md: add MCP resources and prompts subsections after the
  tool table in §3b
- cmd/mcp_test.go: add TestMCPDocCoverage guardrail — asserts every registered
  tool, resource URI, and prompt name appears in README, INTEGRATIONS.md, and
  claude-desktop.md; CI fails if docs drift from the MCP surface again

Closes #51

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude Bot added the agent-generated PR was created by an AI agent label Jun 19, 2026
@ericmann
ericmann merged commit 0592052 into main Jun 19, 2026
4 checks passed
@ericmann
ericmann deleted the agent/issue-51 branch June 19, 2026 22:03
@claude

claude Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor Author

Retro: no durable lesson (merged clean / one-off).

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

Labels

agent-generated PR was created by an AI agent

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: surface the reranker + close v2.7.0 doc gaps (tags, MCP tool list/resources/prompts) + guardrail test

1 participant