docs-mcp-server 的项目扩展与二次开发

项目的基础介绍

docs-mcp-server 是一个开源项目，旨在为 AI 编码助手提供一个始终更新的知识库。该项目通过索引第三方文档——即你在代码库中实际使用的库的文档，来解决 AI 助手面临的文档过时问题。它能够从网站、GitHub 仓库、包管理器（如 npm、PyPI）以及本地文件中抓取文档，并通过 Model Context Protocol (MCP) 提供强大的搜索工具。

项目的核心功能

• 实时文档索引：直接从官方源获取最新文档。
• 版本感知搜索：提供与特定库版本相关的答案。
• 准确代码片段：减少 AI 想象的代码，使用官方文档的上下文。
• Web 界面：提供易于使用的搜索和管理文档的 Web 界面。
• 广泛的源兼容性：支持网站抓取、GitHub 仓库、包管理器网站以及本地文件目录。
• 智能处理：自动将文档分割成语义块并生成嵌入。
• 灵活的嵌入模型：支持 OpenAI（包括兼容 API 如 Ollama）、Google Gemini/Vertex AI、Azure OpenAI、AWS Bedrock 等多种模型。
• 强大的混合搜索：结合向量相似度和全文搜索，提高搜索的相关性。
• 本地与隐私：完全在本地机器上运行，保护数据和查询的隐私。
• 免费与开源：为社区构建，由社区维护。

项目使用了哪些框架或库？

项目使用了以下框架或库：

• Node.js：作为 JavaScript 运行环境。
• Express：用于创建 Web 服务器。
• Docker：用于容器化应用程序，简化部署。
• GitHub Actions：用于自动化工作流程。

项目的代码目录及介绍

项目的代码目录如下：

docs-mcp-server/
├── .github/              # GitHub Actions 工作流文件
├── .husky/               # Husky 配置文件
├── db/                   # 数据库迁移文件
├── docs/                 # 项目文档
├── src/                  # 项目源代码
├── .clineignore          # Cline 忽略文件
├── .clinerules           # Cline 规则文件
├── .dockerignore         # Docker 忽略文件
├── .env.example          # 环境变量示例文件
├── .gitignore            # Git 忽略文件
├── .releaserc.json       # Release 配置文件
├── ARCHITECTURE.md       # 项目架构文档
├── CHANGELOG.md          # 更新日志
├── Dockerfile            # Docker 构建文件
├── LICENSE               # 项目许可证
├── README.md             # 项目说明文件
├── biome.json            # 生物群文件
├── commitlint.config.js  # 提交信息验证配置
├── docker-compose.yml    # Docker Compose 配置文件
├── package-lock.json     # 包锁定文件
├── package.json          # 包管理文件
├── postcss.config.cjs    # PostCSS 配置文件
├── tsconfig.json         # TypeScript 配置文件
└── vite.config.ts        # Vite 配置文件

对项目进行扩展或者二次开发的方向

1. 增加新的文档源：可以扩展项目的抓取模块，以支持更多的文档源，如其他包管理器或特定领域的知识库。
2. 改进搜索算法：优化项目的搜索算法，提高搜索的准确性和效率。
3. 集成更多 AI 模型：项目已经支持多种嵌入模型，可以进一步集成更多的模型，以提供更广泛的选择。
4. 扩展 Web 界面：目前项目提供了基础的 Web 界面，可以扩展其功能，提供更丰富的用户体验。
5. 增加权限管理：为项目添加用户权限管理，以支持多用户使用和文档的权限控制。
6. 优化性能：针对大规模文档集，优化性能，减少内存和计算资源的消耗。