Skip to content
Back to search

xiaoyaosearch

小遥搜索,听懂你的话、看懂你的图,用AI找到本地任何文件。让搜索像聊天一样简单。XiaoyaoSearch: Understands your words, reads your images, finds any local file with AI. Making search as easy as chatting.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/dtsola/xiaoyaosearch with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/dtsola/xiaoyaosearch'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/dtsola--xiaoyaosearch/badge.svg)](/listings/dtsola--xiaoyaosearch)

HTML

<a href="/listings/dtsola--xiaoyaosearch"><img src="/api/listings/dtsola--xiaoyaosearch/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 793 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # 小遥搜索 XiaoyaoSearch
  2. [English Version](README_EN.md) | 简体中文
  3. ![小遥搜索](docs/产品文档/产品截图/小遥搜索.png)
  4. ## 📖 项目简介
  5. ![小遥搜索](docs/产品文档/logo/logo_256x256.png)
  6. 小遥搜索是一款专为知识工作者、内容创作者和技术开发者设计的跨平台本地桌面应用(Windows/MacOS/Linux)。通过集成的AI模型,支持语音输入(30秒内)、文本输入、图片输入等多种方式,将用户的查询转换为语义进行智能搜索,实现对本地文件的深度检索。
  7. ## ⭐️ 重要说明
  8. - 本项目采用**双授权模式**:[AGPL-3.0](LICENSE) 开源协议(免费,修改需同等开源)+ 商业授权(可闭源商用),详见[开源协议与商业授权](#-开源协议与商业授权)章节
  9. - 本项目完全通过Vibe Coding实现,提供所有源码及开发文档(上下文)供大家交流学习
  10. ![开发文档](docs/产品文档/产品截图/开发文档.png)
  11. ## 作者介绍
  12. <p align="center">
  13. <img src="docs/产品文档/产品截图/author-avatar.jpg" alt="dtsola" width="120" height="120" style="border-radius: 50%;">
  14. </p>
  15. <p align="center">
  16. <b>dtsola</b> — IT架构师 | 一人公司实践者
  17. </p>
  18. <p align="center">
  19. 🌐 <a href="https://www.dtsola.com">个人站点</a> &nbsp;|&nbsp;
  20. 📺 <a href="https://space.bilibili.com/736015">B站</a> &nbsp;|&nbsp;
  21. 💬 微信:dtsola(技术交流 | 商务合作)
  22. </p>
  23. <p align="center">
  24. <img src="docs/产品文档/产品截图/个人二维码.png" alt="微信二维码" width="120">
  25. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  26. <img src="docs/运营文档/开发者交流群图.png" alt="开发者交流群" width="120">
  27. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  28. <img src="docs/运营文档/用户交流群图.png" alt="用户交流群" width="120">
  29. </p>
  30. <p align="center">
  31. <small>微信联系 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 开发者交流群 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 用户交流群</small>
  32. </p>
  33. ### ✨ 核心特性
  34. - **🎤 多模态输入**:支持语音录音、文本输入、图片上传
  35. - **🔍 深度检索**:支持视频(mp4、avi)、音频(mp3、wav)、文档(txt、markdown、office、pdf)的内容和文件名搜索
  36. - **🧠 AI增强**:集成BGE-M3、FasterWhisper、CN-CLIP、OLLAMA等先进AI模型
  37. - **☁️ 云端大模型**:支持OpenAI/DeepSeek/阿里云等兼容API,与本地模型自由切换(v1.3.0)
  38. - **☁️ 云端嵌入模型**:支持OpenAI/DeepSeek/阿里云等嵌入API,提升搜索质量(v1.6.0)
  39. - **📚 专业术语库**:支持术语扩展和同义词匹配,专业领域搜索召回率提升60%(v1.9.0)
  40. - **⚡ 高性能**:基于Faiss向量搜索和Whoosh全文搜索的混合检索架构
  41. - **🔒 隐私可控**:本地运行默认数据不上传,支持云端API选项,性能与隐私权衡由您选择
  42. - **🎨 Notion温暖明亮设计**:采用 Notion 温暖明亮设计风格,建立完整设计系统规范,视觉舒适度提升67%(v2.0.0)
  43. - **系统字体栈**:零网络依赖,最优性能,字体加载 < 10ms
  44. - **Lucide Icons**:1000+ 图标,统一视觉语言
  45. - **精致多层阴影**:4-5层阴影堆叠,增强视觉层次感
  46. - **🤖 AI生态集成**:
  47. - **MCP 服务器支持**:支持 Model Context Protocol,可被 Claude Desktop 连接进行本地文件智能搜索(v1.4.0)
  48. - **Agent Skills 支持**:为 Claude Code、VS Code、Cursor 等 AI 助手提供标准化工具调用能力(v1.5.0)
  49. ## 📖 核心界面
  50. ### 搜索界面
  51. #### 主界面
  52. ![搜索界面](docs/产品文档/产品截图/搜索界面-主界面.png)
  53. #### 通过文本搜索
  54. ![通过文本搜索](docs/产品文档/产品截图/搜索界面-文本搜索.png)
  55. #### 通过语音搜索
  56. ![通过语音搜索](docs/产品文档/产品截图/搜索界面-语音搜索.png)
  57. #### 通过图片搜索
  58. ![通过图片搜索](docs/产品文档/产品截图/搜索界面-图片搜索.png)
  59. ### 索引管理界面
  60. ![索引管理界面](docs/产品文档/产品截图/索引管理界面.png)
  61. ### 设置界面
  62. ![设置界面](docs/产品文档/产品截图/设置界面.png)
  63. ### 术语库管理界面(v2.0.0)
  64. ![术语库管理界面](docs/产品文档/产品截图/术语库管理界面.png)
  65. ## 🏗️ 技术架构
  66. ### 系统架构图
  67. ![系统架构](docs/产品文档/产品截图/系统架构.png)
  68. ### 技术栈
  69. **前端技术**
  70. - **框架**: Electron + Vue 3 + TypeScript
  71. - **UI库**: Ant Design Vue
  72. - **状态管理**: Pinia
  73. - **构建工具**: Vite
  74. **后端技术**
  75. - **框架**: Python 3.10 + FastAPI + Uvicorn
  76. - **AI模型**: BGE-M3 + FasterWhisper + CN-CLIP + Ollama
  77. - **搜索引擎**: Faiss (向量搜索) + Whoosh (全文搜索)
  78. - **数据库**: SQLite + 索引文件
  79. ### 项目结构
  80. ```
  81. xiaoyaosearch/
  82. ├── backend/ # 后端服务 (Python FastAPI)
  83. │ ├── app/ # 应用核心代码
  84. │ │ ├── api/ # API路由层
  85. │ │ ├── core/ # 核心配置
  86. │ │ ├── models/ # 数据模型
  87. │ │ ├── services/ # 业务服务
  88. │ │ ├── schemas/ # 数据模式
  89. │ │ └── utils/ # 工具函数
  90. │ ├── requirements.txt # Python依赖
  91. │ ├── main.py # 应用入口
  92. │ └── .env # 环境变量
  93. ├── frontend/ # 前端应用 (Electron + Vue3)
  94. │ ├── src/ # 源代码
  95. │ │ ├── main/ # Electron主进程
  96. │ │ ├── preload/ # 预加载脚本
  97. │ │ └── renderer/ # Vue渲染进程
  98. │ ├── out/ # 构建输出
  99. │ ├── dist-electron/ # 打包输出
  100. │ ├── resources/ # 应用资源
  101. │ ├── package.json # Node.js依赖
  102. │ └── electron-builder.yml # 打包配置
  103. ├── docs/ # 项目文档
  104. │ ├── 00-mrd.md # 市场调研
  105. │ ├── 01-prd.md # 产品需求
  106. │ ├── 02-原型.md # 产品原型
  107. │ ├── 03-技术方案.md # 技术方案
  108. │ ├── 04-开发任务清单.md # 开发任务
  109. │ ├── 05-开发排期表.md # 开发排期
  110. │ ├── 开发进度.md # 进度跟踪
  111. │ ├── 接口文档.md # API文档
  112. │ ├── 数据库设计文档.md # 数据库设计
  113. │ └── 高保真原型/ # UI原型
  114. ├── data/ # 数据目录
  115. │ ├── database/ # SQLite数据库
  116. │ ├── indexes/ # 搜索索引
  117. │ │ ├── faiss/ # 向量索引
  118. │ │ └── whoosh/ # 全文索引
  119. │ ├── models/ # 模型文件
  120. │ └── logs/ # 日志文件
  121. ├── .claude/ # Claude助手配置
  122. ├── LICENSE # 开源协议(AGPL-3.0)
  123. ├── README.md # 项目说明(中文版)
  124. └── README_EN.md # 项目说明(英文版)
  125. ```
  126. ## 🚀 快速开始
  127. ### 方式一:整合包部署(推荐普通用户)
  128. > **适用人群**:非开发者、希望快速体验小遥搜索的用户
  129. > **支持平台**:仅支持 Windows
  130. > **部署难度**:⭐ 简单(一键安装)
  131. #### 下载整合包
  132. 从百度网盘下载最新的 Windows 整合包:
  133. - 链接:https://pan.baidu.com/s/1lDaWjMCRXIT-Sqx9UFjerg?pwd=37ed
  134. - 提取码:37ed
  135. 请选择最新版本下载(如 `XiaoyaoSearch-Windows-v1.1.1.zip`)
  136. #### 安装步骤
  137. **1. 解压整合包**
  138. 将下载的压缩包解压到任意目录(建议不要包含中文路径)
  139. **2. 运行环境准备脚本**
  140. 双击运行 `scripts/setup.bat`,脚本会自动完成以下操作:
  141. - 解压 Python 嵌入式运行时
  142. - 安装后端 Python 依赖
  143. - 安装前端 Node 依赖
  144. - 生成配置文件
  145. - 创建数据目录
  146. > **RTX 50 系显卡用户**:如果您使用 RTX 50 系显卡,请运行 `scripts/setup_rtx50显卡.bat`,该脚本会安装支持 CUDA 12.8 的 PyTorch 版本以获得最佳性能。
  147. **3. 安装 Ollama**
  148. 双击运行 `runtime\ollama\OllamaSetup.exe`,按提示完成安装。
  149. 安装完成后,打开命令行运行:
  150. ```bash
  151. ollama serve
  152. ollama pull qwen2.5:1.5b
  153. ```
  154. **4. 下载 AI 模型**
  155. 从百度网盘下载默认模型:
  156. - 链接:https://pan.baidu.com/s/1jRcTztvjf8aiExUh6oayVg
  157. - 提取码:ycr5
  158. 将模型解压到对应目录:
  159. - `data\models\embedding\BAAI\bge-m3\` - 嵌入模型
  160. - `data\models\cn-clip\` - 视觉模型
  161. - `data\models\faster-whisper\` - 语音识别模型
  162. **5. 启动应用**
  163. 双击运行 `scripts/startup.bat`,脚本会:
  164. - 启动后端服务
  165. - 启动前端服务
  166. **详细文档**:[整合包部署指南](docs/部署文档/整合包部署指南.md)
  167. ---
  168. ### 方式二:开发者部署
  169. > **适用人群**:开发者、希望参与项目贡献的用户
  170. > **支持平台**:Windows / macOS / Linux
  171. > **部署难度**:⭐⭐⭐ 需要开发环境
  172. #### 环境要求
  173. - **操作系统**: Windows / macOS / Linux
  174. - **Python**: 3.10.11+(https://www.python.org/downloads/)
  175. - **Node.js**: 21.x+(https://nodejs.org/en/download)
  176. - **内存**: 建议16GB 以上
  177. - **显卡**: 建议RTX3060 6GB以上
  178. #### 安装步骤
  179. **1. 克隆项目**
  180. ```bash
  181. git clone https://github.com/dtsola/xiaoyaosearch.git
  182. cd xiaoyaosearch
  183. ```
  184. **2. 后端部署**
  185. ```shell
  186. # 进入后端目录
  187. cd backend
  188. # 安装依赖包(默认CPU版本的推理引擎)
  189. pip install -r requirements.txt
  190. # 安装faster-whisper
  191. pip install faster-whisper
  192. # 启用CUDA(可选,注意:cuda版本需根据环境确定)
  193. pip uninstall torch torchaudio torchvision
  194. # RTX 40 系及更早显卡(CUDA 12.1)
  195. pip install torch==2.1.0+cu121 torchaudio==2.1.0+cu121 torchvision==0.16.0+cu121 --index-url https://download.pytorch.org/whl/cu121
  196. # RTX 50 系显卡(CUDA 12.8)
  197. pip install torch==2.10.0+cu128 torchaudio==2.10.0+cu128 torchvision==0.25.0+cu128 --index-url https://download.pytorch.org/whl/cu128
  198. ```
  199. **安装ffmpeg**:
  200. https://ffmpeg.org/download.html
  201. **安装ollama**:
  202. https://ollama.com/
  203. **配置 `.env` 文件**:
  204. ```env
  205. # 数据配置
  206. FAISS_INDEX_PATH=../data/indexes/faiss
  207. WHOOSH_INDEX_PATH=../data/indexes/whoosh
  208. DATABASE_PATH=../data/database/xiaoyao_search.db
  209. # API配置
  210. API_HOST=127.0.0.1
  211. API_PORT=8000
  212. API_RELOAD=true
  213. # 日志配置
  214. LOG_LEVEL=info
  215. LOG_FILE=../data/logs/app.log
  216. ```
  217. **准备模型**:
  218. 系统默认模型说明:
  219. - ollama:qwen2.5:1.5b
  220. - 嵌入模型:BAAI/bge-m3
  221. - 语音识别模型:Systran/faster-whisper-base
  222. - 视觉模型:OFA-Sys/chinese-clip-vit-base-patch16
  223. 注意:建议先准备默认模型,先成功启动应用后,再更换模型。
  224. ollama模型:
  225. ollama pull qwen2.5:1.5b (根据情况自行选择)
  226. 所有模型下载地址:(百度盘)
  227. 链接: https://pan.baidu.com/s/1jRcTztvjf8aiExUh6oayVg?pwd=ycr5 提取码: ycr5
  228. 嵌入模型:
  229. - 模型根目录:data/models/embedding
  230. - 将下载的模型直接解压放入到根目录即可,以下是对应关系
  231. - data/models/embedding/BAAI/bge-m3
  232. - data/models/embedding/BAAI/bge-small-zh
  233. - data/models/embedding/BAAI/bge-large-zh
  234. 语音识别模型:
  235. - 模型根目录:data/models/faster-whisper
  236. - 将下载的模型直接解压放入到根目录即可,以下是对应关系
  237. - data/models/faster-whisper/Systran/faster-whisper-base
  238. - data/models/faster-whisper/Systran/faster-whisper-small
  239. - data/models/faster-whisper/Systran/faster-whisper-medium
  240. - data/models/faster-whisper/Systran/faster-whisper-large-v3
  241. 视觉模型:
  242. - 模型根目录:data/models/cn-clip
  243. - 将下载的模型直接解压放入到根目录即可,以下是对应关系
  244. - data/models/cn-clip/OFA-Sys/chinese-clip-vit-base-patch16
  245. - data/models/cn-clip/OFA-Sys/chinese-clip-vit-large-patch14
  246. **启动后端服务**:
  247. ```shell
  248. # 使用内置配置启动
  249. python main.py
  250. # 或使用uvicorn启动
  251. uvicorn main:app --host 127.0.0.1 --port 8000 --reload
  252. ```
  253. #### 3. 前端部署
  254. ```shell
  255. # 进入前端目录
  256. cd frontend
  257. # 安装依赖
  258. npm install
  259. # 启动开发服务器
  260. npm run dev
  261. ```
  262. ---
  263. ## 🔄 版本升级指南
  264. 当需要升级到新版本时,请参考 [版本升级指南](docs/技术文档/版本升级指南.md),轻松保留您的索引数据和配置。
  265. ---
  266. ## 🤝 如何共享代码
  267. 感谢你对小遥搜索的关注!我们欢迎任何形式的贡献,无论是代码、文档、Bug 修复还是新功能建议。
  268. ### 贡献方式
  269. #### 方式一:提交 Pull Request(推荐)
  270. **步骤 1:Fork 项目**
  271. 1. 访问 [xiaoyaosearch](https://github.com/dtsola/xiaoyaosearch) 仓库
  272. 2. 点击右上角的 "Fork" 按钮,将项目 Fork 到你的 GitHub 账户
  273. **步骤 2:克隆到本地**
  274. ```bash
  275. git clone https://github.com/<你的用户名>/xiaoyaosearch.git
  276. cd xiaoyaosearch
  277. ```
  278. **步骤 3:创建功能分支**
  279. ```bash
  280. git checkout -b feature/你的功能名称
  281. # 或
  282. git checkout -b fix/问题描述
  283. ```
  284. **步骤 4:进行开发**
  285. - 按照项目代码规范进行开发
  286. - 确保代码有适当的注释
  287. - 运行测试确保功能正常
  288. **步骤 5:提交代码**
  289. ```bash
  290. git add .
  291. git commit -m "feat(scope): 简洁描述你的改动"
  292. ```
  293. 提交格式规范:
  294. - `feat`: 新功能
  295. - `fix`: Bug 修复
  296. - `docs`: 文档更新
  297. - `style`: 代码格式调整
  298. - `refactor`: 代码重构
  299. - `perf`: 性能优化
  300. - `test`: 测试相关
  301. - `chore`: 构建/工具链相关
  302. **步骤 6:推送到 GitHub**
  303. ```bash
  304. git push origin feature/你的功能名称
  305. ```
  306. **步骤 7:创建 Pull Request**
  307. 1. 访问你 Fork 的仓库页面
  308. 2. 点击 "Compare & pull request" 按钮
  309. 3. 填写 PR 描述:
  310. - 标题:简洁说明改动内容
  311. - 描述:详细说明改动原因、实现方式、测试结果
  312. 4. 等待维护者审核
  313. #### 方式二:提交 Issue
  314. 如果你发现了 Bug 或有功能建议:
  315. 1. 访问 [Issues](https://github.com/dtsola/xiaoyaosearch/issues) 页面
  316. 2. 点击 "New Issue"
  317. 3. 选择合适的 Issue 模板
  318. 4. 详细描述问题或建议
  319. ### 代码规范
  320. #### 前端规范
  321. - 组件命名:PascalCase(如 `SearchPanel.vue`)
  322. - 变量/函数:camelCase(如 `searchResults`)
  323. - 常量:UPPER_SNAKE_CASE(如 `MAX_FILE_SIZE`)
  324. - 代码注释:使用中文
  325. #### 后端规范
  326. - 文件命名:snake_case(如 `search_service.py`)
  327. - 类名:PascalCase(如 `SearchService`)
  328. - 函数/变量:snake_case(如 `search_files`)
  329. - 常量:UPPER_SNAKE_CASE(如 `MAX_RESULTS`)
  330. - 代码注释:使用中文
  331. ### 贡献指南
  332. - ✅ 遵循项目的代码规范
  333. - ✅ 保持代码简洁,避免过度设计
  334. - ✅ 添加适当的错误处理
  335. - ✅ 确保代码有适当的测试
  336. - ✅ 更新相关文档
  337. ### 获取帮助
  338. - 💬 微信:dtsola(请备注 "小遥搜索贡献")
  339. - 📧 邮件:通过官网 https://www.dtsola.com 联系
  340. - 📺 B站:https://space.bilibili.com/736015
  341. ### 贡献者权益
  342. - 📝 你的名字将出现在项目贡献者列表中
  343. - 🌟 你的改动将帮助成千上万的用户
  344. - 🤝 加入独立开发者社区,交流学习
  345. - 🎁 优秀贡献者可获得项目周边礼品
  346. ---
  347. **让我们一起打造更好的本地搜索体验!** 🚀
  348. ## 产品路线图
  349. [产品路线图](ROADMAP.md)
  350. ## 数据源插件列表
  351. 小遥搜索支持**插件化架构**,可通过插件扩展多种数据源:
  352. ### 支持的数据源类型
  353. | 类型 | 说明 | 状态 |
  354. |------|------|------|
  355. | 📁 本地文件 | 系统内置,无需配置 | ✅ 已实现 |
  356. | ☁️ 语雀 | 阿里语雀知识库 | ✅ 已实现 |
  357. | ☁️ 飞书 | 飞书文档(元数据块解析) | ✅ 已实现 |
  358. | ☁️ 钉钉 | 钉钉文档(.xyddjson 元数据文件) | ✅ 已实现 |
  359. | ☁️ Notion | Notion 笔记 | 📋 计划中 |
  360. | 🔗 GitHub | 代码仓库和 Wiki | 📋 计划中 |
  361. | 🔗 GitLab | GitLab 代码仓库 | 📋 计划中 |
  362. ### 完整列表
  363. 查看完整的数据源插件列表(13种类型):
  364. **📖 [数据源插件列表](docs/技术文档/数据源插件列表.md)** | [English Version](docs/技术文档/数据源插件列表_EN.md)
  365. ### 开发插件
  366. 想要开发新的数据源插件?
  367. **📖 [插件开发文档](docs/技术文档/插件开发文档.md)**
  368. ---
  369. ## 🔥 MCP 服务器支持
  370. 小遥搜索现已支持 **Model Context Protocol (MCP)**,可被 Claude Desktop 等 AI 应用连接,进行本地文件智能搜索。
  371. ### 什么是 MCP?
  372. MCP (Model Context Protocol) 是 Anthropic 推出的开源协议,允许 AI 应用(如 Claude Desktop)连接到本地数据源。通过 MCP,Claude 可以直接搜索和访问您的本地文件,提供更智能的问答和帮助。
  373. ### Agent Skills 支持
  374. 小遥搜索现已支持 **Agent Skills**,为 Claude Code、VS Code、Cursor 等 AI 助手提供标准化的 MCP 工具调用能力。
  375. **安装 Skill**:
  376. ```bash
  377. # 项目级别
  378. cp -r skills/ .claude/skills/
  379. # 或全局级别
  380. cp -r skills/ ~/.claude/skills/
  381. ```
  382. 安装后,AI 助手可自动发现小遥搜索的 MCP 工具,并提供正确使用指导。
  383. ### MCP 客户端配置
  384. 小遥搜索 MCP 服务器使用 **HTTP 传输协议**,任何支持 HTTP MCP 的客户端都可以连接。
  385. #### Claude Code CLI 配置
  386. 官方命令行工具,快速配置:
  387. ```bash
  388. # 添加 HTTP MCP 服务器
  389. claude mcp add --transport http xiaoyao-search http://127.0.0.1:8000/mcp
  390. # 检查 MCP 是否添加成功(确保 MCP 已经启动的前提下,运行下面命令)
  391. claude mcp list
  392. ```
  393. #### 其他支持 MCP 的客户端
  394. 任何支持 MCP 协议的客户端都可以连接到:`http://127.0.0.1:8000/mcp`
  395. **基本配置模板**:
  396. ```json
  397. {
  398. "name": "xiaoyao-search",
  399. "url": "http://127.0.0.1:8000/mcp",
  400. "type": "sse"
  401. }
  402. ```
  403. **常用客户端配置示例**:
  404. - **Cline (VSCode 插件)**: 在 VSCode 设置中搜索 `cline.mcpServers`,添加上述配置
  405. - **Cursor**: 在 Cursor 设置的 MCP 服务器配置中添加上述配置
  406. - **其他 MCP 客户端**: 参考客户端文档,使用 SSE 传输方式连接
  407. ### 支持的搜索工具
  408. | 工具名称 | 说明 | AI 模型 |
  409. |---------|------|---------|
  410. | semantic_search | 语义搜索,支持自然语言查询理解 | BGE-M3 |
  411. | fulltext_search | 全文搜索,支持精确关键词匹配和中文分词 | Whoosh |
  412. | voice_search | 语音搜索,支持语音输入转文本后搜索 | FasterWhisper |
  413. | image_search | 图像搜索,支持图片上传查找相似内容 | CN-CLIP |
  414. | hybrid_search | 混合搜索,结合语义和全文搜索的优势 | BGE-M3 + Whoosh |
  415. ### 使用示例
  416. 配置完成后,您可以在 Claude Desktop 中进行以下操作:
  417. **语义搜索**:
  418. ```
  419. 用户:帮我找一下关于异步编程的文档
  420. Claude:[调用 semantic_search 工具] 找到 5 个相关文档...
  421. ```
  422. **全文搜索**:
  423. ```
  424. 用户:搜索包含 "async def" 的代码文件
  425. Claude:[调用 fulltext_search 工具] 找到 3 个代码文件...
  426. ```
  427. **图像搜索**:
  428. ```
  429. 用户:[上传图片] 找找类似的图表
  430. Claude:[调用 image_search 工具] 找到 2 个相似的图表...
  431. ```
  432. ### 验证 MCP 连接
  433. 访问健康检查端点验证 MCP 服务状态:
  434. ```bash
  435. curl http://127.0.0.1:8000/mcp/health
  436. ```
  437. 返回示例:
  438. ```json
  439. {
  440. "status": "enabled",
  441. "server": "fastmcp",
  442. "tools_count": 5,
  443. "tools": ["semantic_search", "fulltext_search", "voice_search", "image_search", "hybrid_search"]
  444. }
  445. ```
  446. ### 配置选项
  447. 在 `backend/.env` 中配置 MCP 服务:
  448. ```bash
  449. # MCP 服务器配置
  450. MCP_SSE_ENABLED=true # 是否启用 MCP SSE 服务
  451. MCP_SERVER_NAME=xiaoyao-search # 服务器名称
  452. MCP_DEFAULT_LIMIT=20 # 默认结果数量
  453. MCP_DEFAULT_THRESHOLD=0.5 # 默认相似度阈值
  454. MCP_VOICE_ENABLED=true # 是否启用语音搜索
  455. ```
  456. ### 技术实现
  457. - **协议实现**:使用 [fastmcp](https://github.com/PrefectHQ/fastmcp) 框架
  458. - **传输方式**:HTTP SSE (Server-Sent Events)
  459. - **架构模式**:FastAPI 集成,共享 AI 模型和搜索服务
  460. - **内存优化**:单一进程,模型只加载一次,节省 4-6GB 内存
  461. ### 详细文档
  462. - [MCP PRD](docs/特性开发/mcp/mcp-01-prd.md) - 产品需求文档
  463. - [MCP 技术方案](docs/特性开发/mcp/mcp-03-技术方案.md) - 技术实现方案
  464. - [MCP 官方文档](https://modelcontextprotocol.io/) - MCP 协议规范
  465. ---
  466. ## 项目贡献者
  467. 感谢以下人员为本项目做出的贡献:
  468. <p align="center">
  469. <a href="https://github.com/luojiyin1987">
  470. <img src="https://avatars.githubusercontent.com/u/6524977?v=4" width="80" height="80" style="border-radius: 50%;">
  471. </a>
  472. &nbsp;&nbsp;&nbsp;&nbsp;
  473. <a href="https://github.com/jidingliu">
  474. <img src="https://avatars.githubusercontent.com/u/26623206?v=4" width="80" height="80" style="border-radius: 50%;">
  475. </a>
  476. </p>
  477. <p align="center">
  478. <a href="https://github.com/luojiyin1987">@luojiyin1987</a>
  479. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  480. <a href="https://github.com/jidingliu">@jidingliu</a>
  481. </p>
  482. ---
  483. ## 📄 开源协议与商业授权
  484. 本项目采用**双授权(Dual Licensing)**模式:开源协议 + 商业授权。您可以根据自身情况自由选择其中一种方式使用本项目。
  485. ### 方式一:开源协议(AGPL-3.0)— 免费 ✅
  486. 本项目以 [AGPL-3.0-or-later](LICENSE) 协议开源,您可以免费使用、修改和分发,但需遵守以下核心义务:
  487. - ✅ 允许个人学习、研究、修改和分发(包括商业环境中的内部使用)
  488. - ⚠️ 分发修改后的版本时,必须以 AGPL-3.0 同等协议开源全部修改内容
  489. - ⚠️ 若基于修改版本提供网络服务(SaaS),必须向网络用户公开修改后的完整源码
  490. - ⚠️ 必须保留原始版权声明和协议副本
  491. **简单来说**:只要您能接受以同等协议开源您的修改,AGPL-3.0 就是完全免费的,欢迎自由使用。
  492. ### 方式二:商业授权 — 付费 💼
  493. 如果您无法履行 AGPL-3.0 的开源义务,可以购买商业授权获得更灵活的权利:
  494. - ✅ 豁免 AGPL-3.0 开源义务,修改版本可闭源
  495. - ✅ 可将本软件集成到商业产品中对外销售或分发
  496. - ✅ 可基于本软件提供 SaaS 服务而无需公开源码
  497. - ✅ 可获得优先技术支持
  498. - ✅ 可洽谈定制化开发
  499. **商业授权联系方式**:
  500. - 网站:https://www.dtsola.com
  501. - 微信:dtsola(备注:小遥搜索商业授权)
  502. ### ❓ 如何选择
  503. | 使用场景 | 推荐方式 |
  504. |---------|---------|
  505. | 个人学习、研究、日常使用 | AGPL-3.0(免费) |
  506. | 修改后仅自用,不分发、不提供服务 | AGPL-3.0(免费) |
  507. | 修改并分发,且愿意同等开源 | AGPL-3.0(免费) |
  508. | 企业内部使用(可接受开源义务) | AGPL-3.0(免费) |
  509. | 需要闭源修改 | 商业授权 |
  510. | 集成到商业产品中对外销售 | 商业授权 |
  511. | 提供 SaaS 服务且不愿公开源码 | 商业授权 |
  512. | 需要优先技术支持或定制开发 | 商业授权 |
  513. ---
  514. ## 📝 版本更新日志
  515. ### v2.0.0 (2026-04-24) - UI视觉系统升级版 🎨
  516. **核心升级**:
  517. - ✅ **Notion温暖明亮设计风格**:纯白背景 + 品牌蓝色 + 温暖中性灰,视觉舒适度提升 67%
  518. - ✅ **系统字体栈**:零网络依赖,最优性能,字体加载 < 10ms
  519. - ✅ **Lucide Icons 图标系统**:1000+ 图标,统一视觉语言
  520. - ✅ **完整设计系统规范**:CSS Variables + Design Tokens,确保设计一致性
  521. - ✅ **精致多层阴影**:4-5层阴影堆叠,增强视觉层次感
  522. - ✅ **响应式设计**:完美适配桌面端、平板端、移动端
  523. - ✅ **所有页面 UI 升级**:10个页面/组件全面升级
  524. **详细文档**:[v2.0.0 版本更新说明](docs/产品文档/版本更新文档/v2.0.0-UI&UX-界面升级.md)
  525. ---
  526. ### v1.9.0 (2026-04-12) - 搜索优化版
  527. **核心优化**:
  528. - ✅ **术语扩展时机优化**:术语扩展移至LLM增强之前,基于原始用户输入匹配
  529. - ✅ **职责分离**:术语库(专业同义词)vs LLM(通用查询优化)各司其职
  530. - ✅ **智能合并**:扩展词自动去重,避免重复搜索
  531. - ✅ **并发控制**:基于CPU核心数的智能并发控制(CPU核心数×2)
  532. - ✅ **召回率提升**:专业术语场景召回率提升60%
  533. **详细文档**:[v1.9.0 版本更新说明](docs/产品文档/版本更新文档/v1.9.0-搜索优化-术语库支持.md)
  534. ### v1.8.0 (2026-04-08) - 钉钉文档支持
  535. **新增功能**:
  536. - ✅ 钉钉文档数据源支持(配合钉钉导出工具)
  537. - ✅ 元数据文件解析(.xyddjson格式)
  538. - ✅ 原文链接跳转功能
  539. **详细文档**:[v1.8.0 版本更新说明](docs/产品文档/版本更新文档/v1.8.0-钉钉文档+知识库支持.md)
  540. ### v1.7.0 (2026-03-31) - 飞书文档支持
  541. **新增功能**:
  542. - ✅ 飞书文档数据源支持
  543. - ✅ 元数据块解析
  544. - ✅ 原文链接跳转功能
  545. ### v1.6.0 (2026-03-26) - 云端嵌入模型
  546. **新增功能**:
  547. - ✅ 云端嵌入模型调用能力
  548. - ✅ 本地/云端互斥切换
  549. - ✅ 批量文本嵌入优化
  550. ### v1.5.0 (2026-03-20) - Agent Skills
  551. **新增功能**:
  552. - ✅ MCP Agent Skills 支持
  553. - ✅ 为 Claude Code/VS Code/Cursor 提供工具调用能力
  554. ### v1.4.0 (2026-03-15) - MCP 服务器支持
  555. **新增功能**:
  556. - ✅ MCP 协议支持
  557. - ✅ 可被 Claude Desktop 连接
  558. - ✅ SSE 传输方式
  559. ### v1.3.0 (2026-03-10) - OpenAI 云端模型
  560. **新增功能**:
  561. - ✅ OpenAI 兼容云端大模型
  562. - ✅ 动态表单配置
  563. - ✅ API 密钥加密存储
  564. ### v1.2.0 (2026-03-05) - 插件化架构
  565. **新增功能**:
  566. - ✅ 插件化架构框架
  567. - ✅ 语雀知识库数据源
  568. ### v1.1.0 (2026-02-28) - i18n 国际化
  569. **新增功能**:
  570. - ✅ 中英文双语支持
  571. - ✅ i18n 框架集成
  572. ### v1.0.0 (2026-02-20) - MVP 版本
  573. **核心功能**:
  574. - ✅ 多模态搜索(文本/语音/图像)
  575. - ✅ 本地文件深度检索
  576. - ✅ BGE-M3 + FasterWhisper + CN-CLIP
  577. - ✅ Faiss + Whoosh 混合搜索
  578. ---

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.