关键词

上下文增强IDE集成代码生成智能助手文档索引

Context Guide 使用说明

项目简介

Context Guide 是一个为 AI 辅助 IDE (如 Cursor IDE) 提供项目上下文的工具。它通过分析项目文档 (Markdown 格式)，构建上下文索引，并提供 MCP 服务器接口，使得 IDE 可以便捷地获取项目相关的上下文信息，从而提升代码生成和智能提示的准确性，减少上下文丢失和幻觉问题。

主要功能点

  • 项目文档上下文索引: 支持将项目文档 (Markdown 文件) 索引化，利用 LlamaIndex 和 ChromaDB 实现高效的 RAG (检索增强生成) 功能，快速检索相关上下文。
  • 智能 Prompt 生成: 根据用户请求，结合项目上下文和可选的技术栈信息，生成富含项目信息的 Prompt，提升代码生成质量。
  • MCP 服务器集成: 内置 MCP (Model Context Protocol) 服务器，通过标准的 JSON-RPC over HTTP 协议与支持 MCP 的 IDE (如 Cursor IDE) 进行集成，提供上下文查询和 Prompt 生成服务。
  • 灵活的项目结构: 支持多种项目文档模板，适应不同类型和规模的项目，方便用户快速初始化项目文档结构。
  • 实时文档监控: 可以监控文档目录的文件变更，自动更新上下文索引，保持上下文信息的实时性。
  • 支持多种技术栈: 针对 React、Node.js、Django、Flask、Vue.js、Spring 等常用技术栈提供专门的上下文增强，提升针对特定技术的代码生成效果。

安装步骤

  1. 安装 Context Guide: 推荐使用 pip 安装，以便快速部署和管理依赖。打开终端，执行以下命令 (推荐安装包含 MCP 支持的版本):

    pip install "context-guide[mcp]"

  2. 初始化项目文档: 在您的项目根目录下，使用 'context-guide init' 命令初始化项目文档结构。您可以根据项目类型选择不同的模板，例如 'standard' (标准模板) 或 'complete' (完整模板)。

    cd your-project-directory
context-guide init --project-type standard

  3. 更新文档内容: 编辑 'docs/' 目录下生成的 Markdown 文件，根据您的项目实际情况填充项目概览、架构、组件、功能等信息。

  4. 更新上下文索引: 执行 'context-guide update' 命令，将项目文档索引化，以便后续的上下文查询和 Prompt 生成。

    context-guide update

服务器配置 (MCP 客户端配置)

为了让 MCP 客户端 (如 Cursor IDE) 连接到 Context Guide MCP 服务器，您需要在客户端中配置服务器连接信息。以下是一个 JSON 格式的配置示例，您需要根据实际情况填写 'command' 和 'args' 字段。

{
  "servers": [
    {
      "name": "Context Guide MCP Server",  // 服务器名称，您可以自定义
      "command": "context-guide",        // 启动服务器的命令，这里假设 context-guide 命令已添加到系统 PATH
      "args": [                           // 启动命令的参数
        "mcp"                             // 指定运行 mcp 服务器模式
      ]
    }
  ]
}

参数注释:

  • '"name"': 服务器的显示名称，在 MCP 客户端中用于标识和选择服务器。
  • '"command"': 启动 Context Guide MCP 服务器的可执行命令。通常情况下，如果您通过 'pip install "context-guide[mcp]"' 安装，并且 Python 的 Scripts 目录已添加到系统 PATH 环境变量，可以直接使用 'context-guide' 命令。
  • '"args"': 传递给 'context-guide' 命令的参数。'"mcp"' 参数指示 Context Guide 运行 MCP 服务器模式。您可以根据需要添加其他参数，例如 '--host' 和 '--port' 来指定服务器监听的地址和端口。 更多参数选项，请参考 'context-guide mcp --help' 命令的输出。

请注意: MCP 客户端 (如 Cursor IDE) 通常需要您手动配置服务器连接信息。请将上述 JSON 配置添加到您的 MCP 客户端配置中，并确保 'command' 和 'args' 配置正确，以便客户端能够成功连接到 Context Guide MCP 服务器。

基本使用方法

  1. 启动 MCP 服务器: 在终端中执行 'context-guide mcp' 命令，启动 Context Guide MCP 服务器。

    context-guide mcp

    服务器默认监听 'http://0.0.0.0:8000'。您可以使用 '--host' 和 '--port' 参数自定义监听地址和端口。

  2. 在 IDE 中使用: 在支持 MCP 协议的 IDE (如 Cursor IDE) 中配置并连接到 Context Guide MCP 服务器后，您可以在 IDE 中发起代码生成或智能提示请求。IDE 将自动通过 MCP 协议与 Context Guide 服务器通信，获取项目上下文信息，并生成更准确、更贴合项目实际情况的代码。

    例如，在 Cursor IDE 中，您可以：

    • 在聊天窗口中提问 "如何实现用户身份验证？"，Context Guide 将返回项目文档中相关的身份验证信息作为上下文。
    • 请求生成代码 "创建一个用户注册表单组件"，Context Guide 将根据项目上下文和技术栈信息，生成更符合项目规范的代码。

  3. 更新文档和索引: 当项目文档发生变更时，您可以执行 'context-guide update' 命令手动更新上下文索引，或者使用 'context-guide serve' 命令启动监控服务，让 Context Guide 自动监控文档变更并实时更新索引。

    context-guide update  # 手动更新索引
context-guide serve   # 启动文档监控服务 (自动更新索引)

通过以上步骤，您就可以利用 Context Guide 为您的 AI 辅助 IDE 提供强大的项目上下文支持，提升开发效率和代码质量。

信息

分类

开发者工具

访问项目