- AI_README MCP Server
AI_README MCP Server
AI_README MCP Server is a Model Context Protocol (MCP) server that helps AI assistants understand your project conventions through dedicated AI_README.md guide files. It automatically discovers, routes, and manages these files so AI can generate consistent, high-quality code that matches your team's standards.
Works with: GitHub Copilot (VSCode 1.102+), Claude Code, Cursor, and other MCP-compatible AI tools.
Overview
AI_README MCP Server
MCP server for managing AI_README.md files - provides context to AI assistants about project conventions.
Tech Stack
- TypeScript (ES2022, Node16 modules, strict mode)
- MCP SDK (
@modelcontextprotocol/sdk) - Zod for schema validation
- tsup for bundling
- tsx for testing
Architecture
src/index.ts- MCP server entry, tool registrationsrc/tools/- Tool implementations (discover, getContext, update, validate, init)src/core/- Core logic (scanner, router, updater, validator, detector)src/types/- TypeScript interfaces and types
Coding Conventions
- ESM-only (
"type": "module",.jsextensions in imports) - Zod schemas for input validation, exported alongside tools
- Tool functions return structured objects, server wraps as JSON
- Prefer
fs-extraover native fs - Use
globpackage for file pattern matching
Cross-directory dependencies
- Tools in
src/tools/import core modules fromsrc/core/ - Types exported from
src/types/index.tsused everywhere
Server Config
{
"mcpServers": {
"ai-readme-manager": {
"command": "npx",
"args": [
"-y",
"ai-readme-mcp@latest"
]
}
}
}Project Info
Created At
3 months agoUpdated At
3 months agoAuthor Name
Draco ChengStar
-Language
-License
-Tags
Recommend Servers
View AllMcp Server Chatsum
@chatmcp
summarize chat message
typescript
a year ago
Gpt Scrambler
2 days ago
Test
@modelcontextprotocol
test
6 months ago