Skip to content

Align README and command help text with current behavior - #98

Open
Chebaleomkar wants to merge 1 commit into
supermemoryai:mainfrom
Chebaleomkar:docs/readme-accuracy
Open

Chebaleomkar wants to merge 1 commit into
supermemoryai:mainfrom
Chebaleomkar:docs/readme-accuracy

Conversation

@Chebaleomkar

Copy link
Copy Markdown
Contributor

Fixes #97

Problem

Several README sections still describe behavior from before recall moved to direct mode and containers were unified. The Features table and example output describe first-message project knowledge and advisory recall; the config comments describe what autoRecallEveryPrompt, maxMemories, and maxProjectMemories used to do. Two user-facing strings in code had drifted too. #97 has the full list with code references.

Fix

Docs and help text only. No behavior changes.

README

  • Features table: "Context injection" becomes Profile injection (the first message gets the profile only), and "Reasoned recall" becomes Direct recall, the default mode, with a pointer to recallMode: "advisory".
  • Example output: replaced the sections that are never produced with the two real blocks, the first-message [SUPERMEMORY] profile block and the direct-recall <supermemory-context> block, copied from context.ts and recall.ts.
  • In-chat commands: /supermemory-init is the index alias, not install.
  • LLM-agent Step 1: lists everything install actually does (5 commands, tui.jsonc, config defaults).
  • Direct Recall: notes that setting recallDirective without recallMode selects advisory mode.
  • Tool table: search takes limit?, list defaults to 20, and search without a scope searches both scopes.
  • Config reference:
    • maxMemories is the per-search limit (direct recall injects at most 5).
    • maxProjectMemories feeds compaction.
    • autoRecallEveryPrompt is shown as a legacy, commented-out switch.
    • filterPrompt is documented, including that the plugin applies it to Supermemory settings.
    • The captureEveryNTurns default is stated.
    • recallMode default is direct.
  • Container tag selection: documents the full precedence getProjectTag uses, so users know a Claude Code or Cursor project config overrides projectContainerTag.
  • SUPERMEMORY_DEBUG: describes what it actually does. Logs are always written.

Code strings

  • src/cli.ts: the generated /supermemory-login command no longer claims a fixed port 19877. The callback port is random.
  • src/services/memory-tool.ts: the tool's help output lists limit? for search, matching what the mode accepts.

Testing

The headless-setup text (create ~/.config/opencode/supermemory.jsonc) is intentionally unchanged, because it's correct once #92 lands.

- Features table and example output described first-message project
  knowledge and advisory recall; the plugin injects the profile on the
  first message and uses direct recall by default.
- In-chat commands: /supermemory-init is the index alias, not install.
- Config comments: autoRecallEveryPrompt is a legacy recallMode switch,
  maxMemories is the per-search limit, maxProjectMemories only feeds
  compaction; document filterPrompt and the captureEveryNTurns default.
- Tool table: search accepts limit and searches both scopes by default.
- Document the full project-container precedence and what
  SUPERMEMORY_DEBUG does.
- /supermemory-login no longer claims a fixed port; tool help lists
  search's limit arg.
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.

README describes recall and config behavior the plugin no longer has

1 participant