关键词

文档注册表AI代码生成版本兼容性上下文提供框架支持

使用说明

项目简介

ODocs (Open Documentation Registry) 致力于解决AI代码生成中的“版本盲区”问题。当前AI编码助手在生成代码时，往往不考虑开发者使用的特定框架和库的版本，导致生成的代码与项目环境不兼容。ODocs通过构建一个版本化的文档注册表，并提供MCP服务器，使得AI助手能够获取与项目所用框架版本精确匹配的文档，从而生成更准确、可用的代码。

核心思想： 为AI编码助手提供版本相关的上下文信息，解决版本不兼容问题。

主要功能点

  • 版本化文档注册表: 集中管理各种框架和库的版本化文档。
  • 框架自动检测: 自动识别项目使用的框架及其版本。
  • 文档向量化检索: 使用向量数据库高效检索相关文档片段，减少Token消耗。
  • MCP 服务器: 通过标准的 Model Context Protocol (MCP) 协议，向AI客户端提供文档上下文服务。
  • AI 助手集成: 计划提供与多种AI助手（如VS Code、GitHub Copilot等）的集成方案。

安装步骤

由于ODocs项目尚在早期开发阶段，具体的安装步骤可能会有所变化。根据仓库 'README.md' 中的信息，目前可能需要从源代码运行。

  1. 克隆仓库: 首先，你需要克隆 ODocs 的 GitHub 仓库到本地：

    git clone https://github.com/odocs-registry/odocs.git
cd odocs

  2. 运行服务器: 根据 'README.md' 示例，可以使用以下命令启动 ODocs 服务器：

    odocs serve

    （注意： 这假设 'odocs' 命令可以直接执行。实际情况可能需要根据项目具体的构建和运行方式进行调整，例如可能需要安装Python环境和依赖，或者使用 'npm' 等包管理器。请关注项目仓库的更新和更详细的文档。）

    启动成功后，你会在终端看到类似以下信息的输出，表明 MCP 服务器已在 'http://localhost:2803/mcp' 运行：

    → API server running at http://localhost:2803/api
→ MCP server running at http://localhost:2803/mcp

服务器配置

MCP 客户端需要配置连接 ODocs MCP 服务器的信息。以下是一个典型的 JSON 格式配置示例，你可以将其提供给 MCP 客户端：

{
  "server_name": "odocs",  // MCP 服务器名称，可以自定义
  "command": "odocs",      // 启动 MCP 服务器的命令 (假设 'odocs' 命令在你的环境中可用)
  "args": ["serve"]       // 启动命令的参数，这里使用 'serve' 启动服务
}

配置参数说明:

  • 'server_name': 为你的 MCP 服务器实例指定一个名称，方便在客户端管理多个服务器连接。
  • 'command': 指定启动 ODocs MCP 服务器的可执行命令。根据 'README.md' 的示例，这里假设直接使用 'odocs' 命令。 请注意，实际命令可能需要根据你的环境和 ODocs 项目的实际情况进行调整。 例如，如果 'odocs' 是一个 Python 脚本，你可能需要配置为 'python odocs.py' 或类似的命令。
  • 'args': 启动命令的参数列表。 '"serve"' 参数指示 ODocs 启动服务器模式。 如果 'odocs' 命令有其他启动参数，你可以在这里添加。

基本使用方法

  1. 启动 ODocs MCP 服务器: 按照安装步骤中的说明启动 ODocs 服务器。
  2. 配置 MCP 客户端: 在你的 MCP 客户端中，配置服务器连接信息，使用上面提供的 JSON 配置示例。
  3. 连接和使用: MCP 客户端会根据配置连接到 'http://localhost:2803/mcp' 的 ODocs MCP 服务器。客户端可以通过 MCP 协议向服务器发送请求，例如请求获取当前项目所用框架版本的文档信息，从而为 AI 编码助手提供上下文。

请注意： 由于 ODocs 项目处于早期开发阶段，具体的使用方法和功能可能会不断完善和变化。建议关注 ODocs 项目的官方文档和更新，以获取最准确的使用信息。

信息

分类

开发者工具

访问项目