Skip to content

docs(memory): add README.md for agent-memory component#1038

Open
ralf003 wants to merge 1 commit into
alibaba:mainfrom
ralf003:docs/memory-readme
Open

docs(memory): add README.md for agent-memory component#1038
ralf003 wants to merge 1 commit into
alibaba:mainfrom
ralf003:docs/memory-readme

Conversation

@ralf003

@ralf003 ralf003 commented Jun 22, 2026

Copy link
Copy Markdown

Summary

Add a comprehensive README.md for the agent-memory component.

What This PR Does

  • Adds src/agent-memory/README.md (342 lines)
  • Covers: project overview, architecture, 19 MCP tools reference, security model, FTS5 BM25 index details, git versioning, configuration, project structure

Verification

  • All 19 tool names verified against source code (grep on tools.rs)
  • Tool parameters verified against #[tool(param)] annotations
  • Security model verified against safe_fs/mod.rs
  • FTS5 index schema verified against index/store.rs
  • Verified on Aliyun Linux test environment

Impact

  • Pure documentation, no code changes
  • Follows copilot-shell/README.md structure

@ralf003 ralf003 requested a review from casparant as a code owner June 22, 2026 07:02
@CLAassistant

CLAassistant commented Jun 22, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants