ai-readme-manager
Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Instructions
Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.
This server publishes no instructions, or was last inspected before Glama recorded them.
Capabilities
Features and capabilities supported by this server
Protocol revision2025-11-25
| Capability | Details |
|---|---|
| tools | {} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| discover_ai_readmesA | Scan the project and discover all AI_README.md files. Returns an index of all README files with their paths, scopes, and coverage patterns. |
| get_context_for_fileA | ALWAYS CALL THIS FIRST - NO EXCEPTIONS. WHEN TO CALL (check these FIRST before responding):
MANDATORY: Call this tool BEFORE every code-related response. CALL EVERY TIME - EVERY response that involves code/suggestions MUST start with get_context_for_file. CALL EVERY TIME - even if you called it earlier in this conversation. CALL EVERY TIME - even if working on the same file. CALL EVERY TIME - even within the same section/phase - multiple calls are expected and correct. CALL EVERY TIME - context may have changed or sub-directories may have additional conventions. CALL EVERY TIME - when user confirms or selects an option that will result in code changes. What this tool does: Gets AI_README context showing project conventions that MUST be followed. Why it matters:
RECORD DECISIONS: When you make architectural decisions during planning or implementation:
|
| update_ai_readmeA | CALL THIS to record DECISIONS and CONVENTIONS. WHEN TO CALL: A. CONFLICT RESOLUTION — STOP IMMEDIATELY when any of these occur:
B. ARCHITECTURAL DECISIONS (during planning/implementation):
C. IMPLEMENTATION PATTERNS (after writing code):
D. MISSING / UNDOCUMENTED (during get_context or code review):
RULE: If a decision will affect MORE THAN ONE FILE or FUTURE CODE → RECORD IT. WORKFLOW:
Content Rules:
|
| validate_ai_readmesB | Validate all AI_README.md files in a project. Checks token count, structure, and content quality. Returns validation results with suggestions for improvement. |
| compress_ai_readmeA | Compress an AI_README.md file using deterministic filler-language removal (no LLM call). WHEN TO CALL:
WHAT IT DOES (pure text transforms, deterministic):
USE dryRun:true FIRST to preview changes before writing. |
| init_ai_readmeA | Initialize and populate empty AI_README files within a project. When to use:
|
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
TDQS
Scored across 6 tools
Each tool targets a distinct phase of the AI_README lifecycle: discover, initialize, read, update, validate, and compress. However, the get_context_for_file description embeds update_ai_readme instructions and workflow, which blurs the boundary between reading and writing context.
Tool names generally follow a verb_noun pattern and are predictable. Minor inconsistencies exist: singular vs. plural forms (ai_readme vs. ai_readmes) and get_context_for_file does not mention ai_readme like the others do.
Six tools is well-scoped for an AI_README manager. Each tool covers a necessary function—discovery, initialization, context retrieval, updates, validation, and compression—without redundant or extraneous additions.
The tool surface covers the full AI_README lifecycle: discover existing files, initialize missing ones, read context, update conventions, validate quality, and compress content. There are no major dead ends; even maintenance tasks are supported.