项目简介

Codex Keeper 是一个基于 Model Context Protocol (MCP) 构建的智能文档管理服务器,旨在为 AI 助手提供结构化的开发知识库访问能力。它允许 AI 助手检索最新的技术文档和最佳实践,辅助开发者进行软件开发工作。通过标准化的 MCP 协议,Codex Keeper 可以无缝集成到各种支持 MCP 协议的 AI 客户端中。

主要功能点

  • 文档管理: 集中管理各种开发文档资源,包括编程语言、框架、库、工具、API、指南、参考文档和标准等。
  • 工具支持: 提供 'list_documentation', 'add_documentation', 'update_documentation', 'search_documentation', 'remove_documentation' 等工具,方便 AI 助手浏览、添加、更新、搜索和移除文档资源。
  • 分类检索: 支持通过预定义的文档类别(如 Frontend, Backend, Language 等)和标签进行文档的分类和检索,提高信息查找效率。
  • 本地缓存: 具备本地文档缓存机制,加速文档访问速度,并支持缓存清理,优化存储空间使用。
  • 标准化接口: 遵循 MCP 协议,通过 JSON-RPC 协议与客户端通信,易于集成和扩展。

安装步骤

Codex Keeper MCP 服务器无需单独安装,因为它以 npm 包的形式发布,并设计为通过 'npx' 命令直接运行。您只需确保您的开发环境中已安装 Node.js (v18 或更高版本) 和 npm,即可通过 MCP 客户端配置直接使用。

服务器配置

为了让 MCP 客户端(例如 Cline/Sonnet)能够连接到 Codex Keeper MCP 服务器,您需要在客户端的配置文件中添加 Codex Keeper 的服务器配置信息。以下是一个典型的配置示例,您只需将这段 JSON 配置添加到您的 MCP 客户端配置中即可:

{
  "aindreyway-codex-keeper": {
    "command": "npx",
    "args": ["-y", "@aindreyway/mcp-codex-keeper@latest"],
    "disabled": false,
    "env": {
      "npm_config_cache_max": "1024000000", // 设置 npm 缓存最大大小为 1GB (1024MB)
      "NODE_OPTIONS": "--max-old-space-size=256" // 限制 Node.js 堆内存大小为 256MB,优化内存使用
    }
  }
}

配置参数说明:

  • 'server name': 'aindreyway-codex-keeper' - 服务器的名称,用于在 MCP 客户端中标识和引用。
  • 'command': 'npx' - 用于启动服务器的命令,'npx' 允许直接运行 npm 包,无需全局安装。
  • 'args': '["-y", "@aindreyway/mcp-codex-keeper@latest"]' - 传递给 'npx' 命令的参数。
    • '-y': 自动确认 'npx' 的安装提示。
    • '@aindreyway/mcp-codex-keeper@latest': 指定要运行的 npm 包及其版本('latest' 表示最新版本)。
  • 'disabled': 'false' - 设置为 'false' 表示启用该服务器配置。
  • 'env': '{...}' - 可选的环境变量配置。
    • 'npm_config_cache_max': 配置 npm 缓存的最大大小,防止缓存占用过多磁盘空间。
    • 'NODE_OPTIONS': 配置 Node.js 运行时选项,'--max-old-space-size' 限制堆内存大小,以控制服务器的内存使用。

基本使用方法

配置完成后,您的 AI 助手即可通过 MCP 协议与 Codex Keeper 服务器进行交互。您可以向 AI 助手发出自然语言指令,例如:

  • "列出所有可用的文档类别"
  • "展示关于 React 的最新文档"
  • "搜索 TypeScript 开发的最佳实践"
  • "添加一篇关于 Node.js 新特性的文档"
  • "更新 Node.js 文档到最新版本"

AI 助手将自动调用 Codex Keeper 服务器提供的工具,检索或管理相关的开发文档信息,并将结果返回给您,从而辅助您的开发工作。

信息

分类

开发者工具