AI_README MCP Server

关键词

AI_README上下文管理自动化文档代码规范Monorepo 支持

使用说明内容（Markdown格式）

AI_README MCP Server 使用说明

项目简介

AI_README MCP Server 是一个基于 Model Context Protocol 的后端服务，帮助 AI 助手在编码时自动读取和应用项目中的 AI_README.md 指南。核心功能包括资源（Resources）发现与管理、工具（Tools）注册与执行，以及 Prompt 模板（Prompts）的定义与渲染。服务器通过 JSON-RPC 与 MCP 客户端进行通信，提供会话管理、能力声明，并支持通过多种传输方式进行交互（当前实现示例以标准输入输出传输为主）。

主要功能点

  • 自动发现并管理项目中的 AI_README.md 文件（资源管理）
  • 注册并执行工具：discover_ai_readmes、get_context_for_file、update_ai_readme、validate_ai_readmes、init_ai_readme
  • 根据目标文件路径获取最相关的 AI_README 上下文，并生成可直接使用的提示文本
  • 通过 update_ai_readme 实现对 AI_README 的增删改，含变更追踪与简单校验
  • 支持对多级（多模块/多目录）的 AI_README 进行上下文管理，适合单体项目与 monorepo
  • 支持初始化、验证以及上下文驱动的 AI 输出工作流，提升 AI 的一致性与可控性
  • 与常用 MCP 客户端（如 Claude Code、Cursor、GitHub Copilot 等）集成

安装步骤

  • 依赖安装
    • 克隆仓库后在项目根目录执行安装依赖，例如 npm install
  • 构建与运行
    • 构建打包：运行构建命令（如 npm run build）
    • 启动服务器：可通过以下任意一种方式启动
      • 使用 npx 直接启动：npx ai-readme-mcp@latest
      • 使用本地构建产物启动（先构建再执行 dist/index.js）：node dist/index.js
  • 注意事项
    • 服务器默认通过标准输入/输出（stdio）传输与 MCP 客户端通信（示例中的 StdioServerTransport）
    • 服务器在启动后会输出可用工具列表，客户端应按 MCP 规范通过 JSON-RPC 调用相应接口

服务器配置（给 MCP 客户端的配置示例说明）

MCP 客户端需要配置一个服务器条目，以便与服务器建立连接。以下为配置要点与字段说明（为便于理解，以文本形式描述，非代码片段）：

  • server 名称（name）对应为 ai-readme-mcp，版本从 package.json 获取
  • command 与 args 用于启动服务器的命令和参数
    • command：启动命令，例如 npx
    • args：启动参数，例如 ["-y", "ai-readme-mcp@latest"]，表示使用最新版本并自动确认
  • 该配置用于 MCP 客户端建立连接、发送 JSON-RPC 请求并接收响应
  • 具体示例字段（文本描述，不给出代码块）：
    • server name: "ai-readme-manager"
    • command: "npx"
    • args: ["-y", "ai-readme-mcp@latest"]

基本使用方法、工作流与日常运维建议（简要）

  • 客户端在首次对项目进行上下文获取或初始化 AI_README 时，可通过 get_context_for_file、discover_ai_readmes、init_ai_readme 及 update_ai_readme 等工具完成工作流
  • 通过 validate_ai_readmes 对 AI_README 进行质量检查，确保上下文可用且不冗余
  • 如遇目录重组、增加新模块时，可以重新执行 discover_ai_readmes 以刷新索引
  • 对于多目录/多层级的项目，服务器将根据目录层级自动选择最近且最相关的 AI_README 作为上下文

基本使用示例（简要步骤）

  • 启动后，通过 MCP 客户端请求工具列表
  • 使用 discover_ai_readmes 发现项目中的 AI_README.md 文件及其覆盖模式
  • 使用 get_context_for_file 为具体文件获取相关上下文
  • 使用 init_ai_readme 或 update_ai_readme 初始化/更新 AI_README 内容
  • 使用 validate_ai_readmes 检查所有 AI_README 的质量

提示：以上流程应遵循 MCP 的 JSON-RPC 请求/响应规范，确保请求参数正确、返回结果可解析并用于代入生成的提示文本。

关键词

AI_README, 上下文管理, 自动化文档, 代码规范, Monorepo 支持

分类ID

1

服务器信息

访问项目