AI README Manager
/install ai-readme-manager
\r \r
AI README Manager\r
\r
Manages AI_README.md files that document your project's conventions for AI assistants. Gives your agent persistent memory of project rules across every session and every iteration.\r
\r
Setup\r
\r Before this skill works, you must register the MCP server with OpenClaw:\r \r Option 1: CLI (Recommended)\r \r On macOS/Linux:\r
openclaw mcp set ai-readme-manager '{"command":"npx","args":["[email protected]"]}'\r
```\r
\r
On Windows (cmd):\r
```cmd\r
openclaw mcp set ai-readme-manager "{\"command\":\"npx\",\"args\":[\"[email protected]\"]}"\r
```\r
\r
**Option 2: Edit config file**\r
\r
Add to `~/.openclaw/openclaw.json`:\r
```json\r
{\r
"mcp": {\r
"servers": {\r
"ai-readme-manager": {\r
"command": "npx",\r
"args": ["[email protected]"]\r
}\r
}\r
}\r
}\r
```\r
\r
Then restart OpenClaw and verify with `openclaw mcp list`.\r
\r
## When to use\r
\r
Call `get_context_for_file` before any code-related task — editing, creating, or reviewing files in a project.\r
\r
## Tools available\r
\r
- `get_context_for_file` — get relevant project conventions for a specific file path\r
- `init_ai_readme` — initialize and populate empty AI_README files in a project\r
- `update_ai_readme` — record new conventions or architectural decisions\r
- `validate_ai_readmes` — check quality and token efficiency of all AI_README files\r
- `compress_ai_readme` — remove filler language from an AI_README file to reduce token footprint\r
- `discover_ai_readmes` — scan and list all AI_README files in a project\r
\r
## Instructions\r
\r
### MCP: ai-readme-manager\r
\r
Before any code-related task, ALWAYS call `get_context_for_file(projectRoot, path)` first.\r
If `get_context_for_file` reports empty or missing AI_README files, call `init_ai_readme(projectRoot)` to initialize them.\r
If the user's request or your plan conflicts with AI_README conventions (including during planning), STOP and call `update_ai_readme` to resolve the conflict before proceeding.\r
When establishing new conventions or making architectural decisions, call `update_ai_readme` to record them.\r
If AI_README is missing a convention that is already used in 2+ files, call `update_ai_readme` to record it.\r
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install ai-readme-manager - After installation, invoke the skill by name or use
/ai-readme-manager - Provide required inputs per the skill's parameter spec and get structured output
What is AI README Manager?
Manages AI_README.md files so AI agents remember your project conventions across every session. It is an AI Agent Skill for Claude Code / OpenClaw, with 178 downloads so far.
How do I install AI README Manager?
Run "/install ai-readme-manager" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is AI README Manager free?
Yes, AI README Manager is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does AI README Manager support?
AI README Manager is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created AI README Manager?
It is built and maintained by Draco.Cheng (@draco-cheng); the current version is v1.3.4.