Skip to content

docs: sync docs with current implementation and remaining backlog #102

@maehwasoo

Description

@maehwasoo

Doc location

  • README.md
  • docs/01-overview.md
  • docs/03-plan.md

What’s wrong / missing?

  • README.md read-tools list is missing get_vault_tree, while the tool is implemented and exposed in MCP.
  • docs/01-overview.md still has Read-first tools (planned): TBD and Write tools (planned): TBD even though the current tool surface is already documented as implemented in the same file and in docs/reference/mcp-tools.md.
  • docs/03-plan.md is still valid as the repo TODO tracker, but remaining items are spread across sections and not easy to scan as a current backlog snapshot.
  • Current docs should make a clear boundary between “implemented now” and “remaining backlog” to avoid drift/confusion.

Suggested fix (optional)

  • Add get_vault_tree to the read-tools list in README.md.
  • Replace TBD planned placeholders in docs/01-overview.md with explicit status text aligned to current implementation.
  • Keep docs/03-plan.md (per AGENTS guidance) and add a short “remaining backlog” summary near the top with currently open items:
    • user-configurable exclusions / blocked-path events
    • pause/resume UX decision
    • throttling/rate limiting beyond batch size
    • full schema validation expansion in frontmatter_validate
    • read_note pagination token/perf follow-ups
    • privacy docs + opt-in options
    • cross-process single-writer lock for indexer

Metadata

Metadata

Assignees

Labels

docsImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions