AI README Manager
by @draco-cheng
Manages AI_README.md files so AI agents remember your project conventions across every session
clawhub install ai-readme-managerπ About This Skill
name: ai-readme-manager description: Manages AI_README.md files so AI agents remember your project conventions across every session version: 1.3.4 metadata: openclaw: install: - kind: node package: ai-readme-mcp bins: [ai-readme-mcp] homepage: https://github.com/Draco-Cheng/ai-readme-mcp emoji: "π"
AI README Manager
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.
Setup
Before this skill works, you must register the MCP server with OpenClaw:
Option 1: CLI (Recommended)
On macOS/Linux:
openclaw mcp set ai-readme-manager '{"command":"npx","args":["ai-readme-mcp@1.3.4"]}'
On Windows (cmd):
openclaw mcp set ai-readme-manager "{\"command\":\"npx\",\"args\":[\"ai-readme-mcp@1.3.4\"]}"
Option 2: Edit config file
Add to ~/.openclaw/openclaw.json:
{
"mcp": {
"servers": {
"ai-readme-manager": {
"command": "npx",
"args": ["ai-readme-mcp@1.3.4"]
}
}
}
}
Then restart OpenClaw and verify with openclaw mcp list.
When to use
Call get_context_for_file before any code-related task β editing, creating, or reviewing files in a project.
Tools available
get_context_for_file β get relevant project conventions for a specific file pathinit_ai_readme β initialize and populate empty AI_README files in a projectupdate_ai_readme β record new conventions or architectural decisionsvalidate_ai_readmes β check quality and token efficiency of all AI_README filescompress_ai_readme β remove filler language from an AI_README file to reduce token footprintdiscover_ai_readmes β scan and list all AI_README files in a projectInstructions
MCP: ai-readme-manager
Before any code-related task, ALWAYS call get_context_for_file(projectRoot, path) first.
If get_context_for_file reports empty or missing AI_README files, call init_ai_readme(projectRoot) to initialize them.
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.
When establishing new conventions or making architectural decisions, call update_ai_readme to record them.
If AI_README is missing a convention that is already used in 2+ files, call update_ai_readme to record it.
β‘ When to Use
Call get_context_for_file before any code-related task β editing, creating, or reviewing files in a project.
βοΈ Configuration
Before this skill works, you must register the MCP server with OpenClaw:
Option 1: CLI (Recommended)
On macOS/Linux:
openclaw mcp set ai-readme-manager '{"command":"npx","args":["ai-readme-mcp@1.3.4"]}'
On Windows (cmd):
openclaw mcp set ai-readme-manager "{\"command\":\"npx\",\"args\":[\"ai-readme-mcp@1.3.4\"]}"
Option 2: Edit config file
Add to ~/.openclaw/openclaw.json:
{
"mcp": {
"servers": {
"ai-readme-manager": {
"command": "npx",
"args": ["ai-readme-mcp@1.3.4"]
}
}
}
}
Then restart OpenClaw and verify with openclaw mcp list.