使用说明
项目简介
Codebase Expert 是一个将任意代码库转换为AI可理解和可搜索的知识库的工具。它通过扫描代码、提取上下文、使用 memvid 技术编码为视频记忆,并构建搜索索引。作为一个 Model Context Protocol (MCP) 服务器,它允许大型语言模型 (LLM) 客户端直接查询和交互这个代码知识库,实现AI驱动的代码理解、语义搜索和问答。
主要功能点
- 代码库知识化: 将整个代码库(包括代码文件、结构、Git历史、依赖等)整合成一个AI友好的知识库。
- 上下文增强: 在知识库中包含丰富的项目上下文信息,提高LLM理解能力。
- 语义搜索: 支持通过自然语言或关键词进行代码和上下文的语义搜索。
- AI问答: 允许LLM直接就代码库内容提问并获得基于知识库的回答。
- MCP 工具提供: 通过标准 MCP 协议向 LLM 客户端提供上述功能作为可调用工具。
- 自动生成: MCP服务器模式下,如果知识库不存在,会自动生成。
安装步骤
- 下载脚本: 下载 'codebase_expert.py' 脚本到本地。
- 安装依赖: 脚本在首次运行时会自动检查并安装必要的Python库,主要是 'memvid' 和 'mcp'。您也可以手动安装:
('watchdog' 用于文件变更监控,非必需但推荐)。pip install memvid mcp watchdog
服务器配置(供MCP客户端使用)
为了让 MCP 客户端(如 Claude Desktop)连接并使用 Codebase Expert 作为工具,需要在客户端的 MCP 配置中添加如下信息。这不是需要您手动执行的代码,而是配置示例的说明:
- 服务器名称: 为此 MCP 服务器指定一个名称,例如 'codebase-expert'。
- 启动命令 (command): 执行 Codebase Expert 脚本的Python解释器路径,通常是 'python' 或您虚拟环境中的 Python 路径。
- 命令参数 (args): 传递给 Python 解释器的参数列表,至少包括脚本文件的绝对路径和启动服务器的命令 'serve'。例如:'/absolute/path/to/codebase_expert.py', 'serve'。请务必使用脚本的绝对路径。
- 工作目录 (cwd): 设置服务器启动时的工作目录。这应该设置为您希望 Codebase Expert 分析的项目根目录的路径。
这些信息通常以 JSON 格式配置在 MCP 客户端的设置文件中。配置完成后,MCP 客户端启动时会运行 Codebase Expert 脚本的 'serve' 命令,并与其建立连接。
基本使用方法(通过MCP客户端与服务器交互)
配置完成后,您的 MCP 客户端(例如 LLM 界面)将能够识别并调用 Codebase Expert 提供的工具。您可以通过客户端的界面或指令来触发这些工具:
- 查询代码: 使用客户端与 Codebase Expert 的搜索工具交互,输入搜索关键词或短语。
- 提问: 直接向 LLM 提问有关代码库的问题,LLM 会调用 Codebase Expert 的问答工具来查找答案。
- 获取上下文: 使用客户端调用获取上下文的工具,指定您感兴趣的主题(如 "authentication system", "database layer")。
- 查看项目信息: 调用获取项目信息工具,了解代码库的基本统计数据和结构。
- 生成/更新知识库: LLM 可能会自动调用或您可以通过客户端手动触发知识库生成工具,特别是在初次使用或代码库有较大变动后。
信息
分类
开发者工具