关键词

代码分析大型语言模型IDE集成代码库查询Gemini

使用说明

项目简介

DeepView MCP (Model Context Protocol) 服务器旨在帮助开发者使用大型语言模型（如 Gemini）分析和理解大型代码库。它通过 MCP 协议与 IDE（如 Cursor 和 Windsurf）集成，允许用户在 IDE 中直接查询代码库相关问题，利用 Gemini 的强大上下文理解能力。

主要功能点

  • 代码库加载: 从单个文本文件加载整个代码库，方便大型项目分析。
  • 代码库查询: 通过集成的 'deepview' 工具，用户可以使用自然语言提问关于代码库的问题，并获得 Gemini 模型生成的答案。
  • IDE 集成: 兼容支持 MCP 协议的 IDE，如 Cursor 和 Windsurf，实现无缝集成。
  • Gemini 模型选择: 允许用户通过命令行参数配置使用的 Gemini 模型。

安装步骤

  1. 环境准备: 确保已安装 Python 3.13 或更高版本。
  2. 安装 DeepView MCP: 使用 pip 命令安装 'deepview-mcp' 包： 
    pip install deepview-mcp
  3. Gemini API 密钥: 前往 Google AI Studio 获取 Gemini API 密钥，并将其设置为环境变量 'GEMINI_API_KEY'。

服务器配置

为了在 MCP 客户端（例如 Cursor 或 Windsurf）中使用 DeepView MCP 服务器，您需要配置服务器连接信息。在 IDE 的 MCP 配置中，添加一个新的 MCP 服务器，并按照以下 JSON 格式填写配置信息。请根据您的实际安装路径修改 'command' 和 'args' 字段。

{
  "mcpServers": {
    "deepview": {
      "command": "/path/to/deepview-mcp",  // DeepView MCP 服务器的启动命令路径。如果 deepview-mcp 命令在您的 PATH 环境变量中，则可以直接使用 "deepview-mcp"。
      "args": ["/path/to/codebase.txt"], // 启动命令的参数，指定代码库文件路径。您可以替换为您自己的代码库文件路径，或者在查询时再指定。
      "env": {
        "GEMINI_API_KEY": "your_gemini_api_key" //  Gemini API 密钥需要通过环境变量传递。请确保您已正确设置 GEMINI_API_KEY 环境变量。
      }
    }
  }
}

参数说明:

  • 'command': 指向 'deepview-mcp' 命令行工具的路径。安装 'deepview-mcp' 包后，该命令通常已添加到您的 Python 环境的 Scripts 目录中。您可以使用 'which deepview-mcp' (Linux/macOS) 或 'where deepview-mcp' (Windows) 命令查找其具体路径。
  • 'args': 传递给 'deepview-mcp' 命令的参数。
    • '/path/to/codebase.txt': 可选参数，指定代码库文件的路径。如果在此处指定，服务器启动时将预加载该代码库。您也可以在后续的查询请求中指定代码库文件。
  • 'env': 环境变量配置。
    • 'GEMINI_API_KEY': 必须设置 Gemini API 密钥。请替换 '"your_gemini_api_key"' 为您实际的 API 密钥。

基本使用方法

  1. 准备代码库文件: DeepView MCP 需要将代码库打包成一个文本文件。您可以使用 repomix 工具将代码仓库转换为单个文本文件。
    • 安装 repomix: 确保您已安装 Node.js (版本 18.17.0 或更高)，然后运行 'npm install -g repomix' 安装 repomix。
    • 使用 repomix: 在您的代码仓库根目录运行 'npx repomix'，即可生成默认的 'repomix-output.xml' 代码库文件。您也可以通过配置文件 'repomix.config.json' 自定义打包规则。
  2. 启动 MCP 服务器: DeepView MCP 服务器通常由 MCP 客户端（如 IDE）自动启动，您无需手动运行。当您在 IDE 中配置并启用 DeepView MCP 服务器后，IDE 会根据配置信息启动服务器。
  3. 在 IDE 中查询: 在支持 MCP 协议的 IDE (如 Cursor 或 Windsurf) 中，您可以使用集成的 DeepView MCP 功能，通过自然语言提问关于代码库的问题。IDE 会将问题发送给 DeepView MCP 服务器，服务器调用 Gemini 模型进行分析，并将结果返回给 IDE。
  4. 使用 'deepview' 工具: DeepView MCP 服务器提供名为 'deepview' 的工具。该工具接受以下参数：
    • 'question' (必选): 您要提出的关于代码库的问题。
    • 'codebase_file' (可选): 代码库文件路径。如果服务器启动时未指定代码库文件，或者您想查询不同的代码库，可以在此处指定。

示例查询: 在 IDE 中，您可能会看到一个输入框，允许您调用 'deepview' 工具并输入问题，例如：

{
  "tool_call": {
    "tool_name": "deepview",
    "parameters": {
      "question": "这段代码库的主要目的是什么？",
      "codebase_file": "/path/to/your/codebase.txt" // 可选，如果服务器启动时已加载代码库，则可以省略
    }
  }
}

服务器将返回 Gemini 模型对您问题的回答。

通过以上步骤，您就可以使用 DeepView MCP 服务器在 IDE 中方便地分析和查询大型代码库了。

信息

分类

开发者工具

访问项目