Add ContextMemory integration guide#551
Conversation
This guide explains how to use ContextMemory for persisting development context in picoclaw. It includes installation instructions, initialization steps, and usage examples.
There was a problem hiding this comment.
Pull request overview
Adds a new documentation page describing how contributors can optionally use the external ContextMemory CLI to persist/restore development context across AI-assisted coding sessions.
Changes:
- Added
docs/CONTEXTMEMORY.mdintegration guide (install/init/save/resume) - Documented optional MCP configuration for ContextMemory
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
@copilot open a new pull request to apply changes based on the comments in this thread |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Optional MCP Integration | ||
|
|
||
| If using an MCP-compatible AI tool, add the following configuration: | ||
|
|
There was a problem hiding this comment.
The MCP section says "add the following configuration" but doesn’t specify where (which config file / which MCP client(s), and whether this is per-user or per-repo). Please name the target config location(s) and any required restart/enable steps so contributors can apply this correctly.
| "command": "npx", | ||
| "args": ["-y", "@akashkobal/contextmemory", "mcp"] |
There was a problem hiding this comment.
Using npx with -y and without a version pin will execute whatever package is currently published, which is a supply-chain risk and can reduce reproducibility. Prefer pinning an explicit version (and consider avoiding -y, or at least explaining the security tradeoff) in the recommended MCP command.
| "command": "npx", | |
| "args": ["-y", "@akashkobal/contextmemory", "mcp"] | |
| "command": "contextmemory", | |
| "args": ["mcp"] |
| This guide explains how picoclaw contributors can optionally use ContextMemory to persist development context across AI-assisted coding sessions. | ||
|
|
There was a problem hiding this comment.
Use consistent project naming: in prose, other docs refer to the project as "PicoClaw" (capitalized). Reserve picoclaw for CLI commands/paths, and update occurrences like "picoclaw contributors" accordingly (ideally throughout this document for consistency).
| This creates a `.contextmemory/` directory used to store development context locally. | ||
|
|
||
| Example structure: | ||
|
|
||
| ``` | ||
| .contextmemory/ | ||
| ├── context.json | ||
| ├── history/ | ||
| ``` | ||
|
|
||
| This directory is local to your development environment. | ||
|
|
There was a problem hiding this comment.
Consider calling out that .contextmemory/ should not be committed. Adding a note here to include .contextmemory/ in .gitignore (similar to how .picoclaw/ is ignored) would help prevent accidental check-ins of local context/history.
| ```bash | ||
| npm install -g @akashkobal/contextmemory | ||
| ``` | ||
|
|
There was a problem hiding this comment.
This repo’s exec tool blocks npm install -g by default (see docs/tools_configuration.md default deny patterns). It may be worth noting here that the install command should be run in a normal terminal, or that users must adjust exec deny patterns if attempting to run it via PicoClaw tooling.
| Note: The picoclaw exec tool blocks `npm install -g` by default (see `docs/tools_configuration.md`). Run this install command in a normal terminal, or adjust the exec deny patterns if you need to run it via PicoClaw tooling. |
|
Going to close this for now. Not a real contribution. |
2 participants
Adds documentation for the ContextMemory CLI tool for persistent AI coding context memory.
npm:
https://www.npmjs.com/package/@akashkobal/contextmemory
GitHub:
https://github.com/AkashKobal/contextmemory