docs-mcp-server MCP Server

docs-mcp-server MCP Server

site icon
2025.04.04 0
TypeScript文档管理搜索服务开发效率
docs-mcp-server 是一个基于 Model Context Protocol (MCP) 的服务器,专门用于抓取、处理和搜索第三方软件库和包的文档。它通过从指定URL抓取内容,使用语义分割技术将文档分割成有意义的块,利用OpenAI生成向量嵌入,并将数据存储在SQLite数据库中。服务器结合了 `sqlite-vec` 的高效向量相似性搜索和 FTS5 的全文搜索能力,提供混合搜索结果。支持版本管理,允许存储和查询不同版本的文档(包括无版本内容)。
View on GitHub

Overview

基本能力

产品定位

  • 提供第三方软件库文档的抓取、索引和搜索服务
  • 支持版本化文档管理
  • 结合向量搜索和全文搜索的混合搜索能力

核心功能

  1. 文档抓取与处理
  2. 从指定URL抓取文档内容
  3. 使用语义分割技术分割文档
  4. 生成向量嵌入并存储在SQLite数据库中
  5. 搜索功能
  6. 向量相似性搜索
  7. 全文搜索
  8. 混合搜索结果
  9. 版本管理
  10. 支持不同版本的文档存储
  11. 支持无版本文档
  12. 异步任务管理
  13. 使用 PipelineManager 管理异步抓取任务

适用场景

  • 开发者需要快速查找第三方库文档
  • 需要比较不同版本库文档差异
  • 需要离线访问文档
  • 需要结合语义搜索和全文搜索的场景

工具列表

  1. scrape_docs - 启动文档抓取任务
  2. get_job_status - 获取任务状态
  3. list_jobs - 列出活动/已完成任务
  4. cancel_job - 取消任务
  5. search_docs - 搜索文档
  6. list_libraries - 列出已索引的库
  7. find_version - 查找合适版本
  8. remove_docs - 删除索引文档

常见问题解答

  • 版本处理:支持特定版本、部分版本和无版本文档
  • 搜索时版本匹配:支持精确匹配、部分匹配和范围匹配
  • 无版本文档处理:可以显式搜索无版本文档

使用教程

使用依赖

  1. 安装Node.js环境
  2. 安装Git

安装教程

  1. 克隆仓库
git clone <repository-url>
cd docs-mcp-server
  1. 安装依赖
npm install
  1. 构建项目
npm run build

调试方式

使用MCP Inspector进行调试

npx @modelcontextprotocol/inspector node dist/server.js

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。