Repository navigation
docs(mcp): add mneme-memory README and bump to 0.1.2 - #398
Conversation
The package page had no README at all (npm reports "No README data found"), which is the main discovery surface for a package meant to be found by strangers on npm. Content is English-first with a mirrored Chinese section. Covers: the six tools, the reachable-library prerequisite (external API or dsh-mneme-serve, including the shared-port caveat), mount snippets, config resolution order with the MNEME_* aliases kept for pre-split mounts, the one scope-semantics difference, and the security notes (single-writer API path, plain-HTTP warning, stderr-only logs). The npx example passes `-p mneme-memory` on purpose: the bin name differs from the package name, so a bare npx would try to install a nonexistent package.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configuration
📒 Files selected for processing (3)
Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 0 remain after this review. 📝 WalkthroughWalkthrough新增 ChangesMCP 服务更新
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~4 minutes Change: Other Merge Risk: ⚪ Minimal · up to The setup guidance matches the available UI and implementation evidence, and the release metadata is consistent. No material merge-blocking issue is identified. Pre-merge checks |
 |
| Check name | Status | Explanation |
|---|---|---|
| Description Check |  |
Check skipped - CodeRabbit’s high-level summary is enabled. |
| Title check | |
标题准确概括了主要变更：新增 mneme-memory README，并将版本更新到 0.1.2。标题简洁、具体且与变更内容一致。 |
| Docstring Coverage | |
No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0… |
| Linked Issues check | |
Check skipped because no linked issues were found for this pull request. |
| Out of Scope Changes check | |
Check skipped because no linked issues were found for this pull request. |
✨ Finishing Touches
🧪 Generate unit tests (beta)
- Commit to this branch
- Create a new PR
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Problem
mneme-memoryhad no README at all —npm view mneme-memory readmereturns "No README data found", so the npm page shows only the one-line description. For a package whose entire purpose is being discovered by MCP users on npm, that is the biggest gap on the listing.Change
mcp/README.md: English-first with a mirrored Chinese section (repo bilingual convention).dsh-mneme-servewithout DSH, including the shared-port caveat); mount snippets; config resolution order with theMNEME_*aliases kept for pre-split mounts; the one scope-semantics difference (no session context, explicitagent_scope/workspace_scopeonly); security notes (single-writer API path, plain-HTTP warning, stderr-only logs).0.1.1 → 0.1.2inmcp/package.jsonandmcp/server.json(both version fields), since the README is the reason to republish.Verification
npm pack --dry-runinmcp/: README.md (5.2 kB) now in the tarball, total files 3 → 6.mneme-mcpvs package name (mcp/package.json),DEFAULT_URL=http://127.0.0.1:8790and~/.dsh-mneme/cli.json(mcp/bin/mneme-mcp.mjs:37-38), alias priority (:81-82), plain-HTTP warning and stderr-only logging, and the daemon's stdout listening line / stderr logs (dsh-mneme/bin/dsh-mneme-serve.mjs:8-12).-p mneme-memory: barenpx mneme-mcpwould try to install a nonexistent package (same trap the panel's serve card locks against).Publishing 0.1.2 is a manual step (no workflow covers
mcp/). Paired with #398, which wires the parity lock this README claims into CI.Summary by CodeRabbit