Skip to content

Latest commit

 

History

History
48 lines (39 loc) · 2.74 KB

README.md

File metadata and controls

48 lines (39 loc) · 2.74 KB

keepmind-mcp

A standalone, dependency-free Node.js stdio MCP server over a local KeepMind Markdown memory directory. No Electron or embedding model is required.

Run npx keepmind-mcp --memory-dir /absolute/path/to/memory, or set KEEPMIND_MEMORY_DIR. The search and read_note tools provide keyword search and note reading. Existing sb_* tools also support memory writes and appends. Only point the server at memory that you intend your MCP client to access.

For a source checkout, run node tools/keepmind-mcp.mjs --memory-dir /path/to/memory. Maintainers can package this standalone npm package with npm pack ./tools; publication to npm is required before the bare npx keepmind-mcp command can resolve this release from the registry.

Projects and memory versions

continuity_list and continuity_context resume a project with its revision, decisions, attempts, evidence versions and next step. All writes to existing projects require expectedRevision; a conflict requires reading and reconciling the current state. Decisions remain proposals until reviewed in the desktop app. Models cannot approve decisions, confirm lessons or submit human feedback by passing an actor field. Generic note writes cannot overwrite project records. continuity_get and continuity_context can read permitted native analysis reports and their stale state; MCP cannot run the model analysis or perform human reviews. Literal source quotes are validated, while proposed relationships remain subject to human review and do not establish causality.

Fact reads/search default to mode: "current". Use mode: "history" for labelled archive/proposals, or mode: "asOf", asOf: "YYYY-MM-DD" for dated facts. Undated legacy text remains unverified. sb_remember places fact proposals in the client's default space.

Copy both lib/memory-contract.mjs and lib/continuity.mjs with the server entry point. A single-file copy is no longer sufficient. Full protocol, source status semantics, budgets and recovery: docs/CONTINUITY.md in the app repo.

Encrypted memory

The server defaults to encrypted-only access and cannot read ciphertext while locked. Use the full built KeepMind installation for decryption; a copy of this script alone has no key service. Configure launcher-controlled client scopes, KEEPMIND_MCP_STATE and KEEPMIND_MCP_UNLOCK_FD (a dedicated inherited descriptor at least 3). Supply the passphrase through that descriptor, never through args, environment values, logs, or MCP stdin. See docs/SECURITY-MODEL.md in the app repo. KEEPMIND_MCP_ALLOW_PLAINTEXT=true explicitly permits legacy public/internal plaintext. It never supplies a fallback for failed decryption. Attachments are not served by note tools. Token capture requires the native keychain service.