simple local rag

MCP数据服务

提供方 dataML007

数据服务 stdio · 本地进程 API Key 社区 / 第三方
查看接入方式

一个多模态检索增强生成(RAG)系统,集成了FAISS向量数据库,提供Streamlit前端、FastAPI后端和MCP服务器集成,支持文档上传、问答和对话记忆功能。

一句话选型结论

按资料字段整理

simple local rag 属于数据服务类 MCP 服务器,stdio · 本地进程,API Key,有可直接执行的安装命令。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类数据服务 传输方式stdio · 本地进程 鉴权API Key 部署方式本地部署
GitHub 星标 0 仓库热度,无公开仓库时显示未标注
工具数 3 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

数据服务
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量3暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

适用场景

检索增强生成Python本地部署问答系统文档管理向量数据库对话AI

安装与配置

stdio · 本地进程 API Key
客户端在本机拉起子进程,数据不出本机
python -m app.main

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    stdio 服务在本地起进程,需要先装好 Python,再按安装命令拉取依赖。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后客户端会列出约 3 个工具,随便调一个只读工具确认能返回结果。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
数据库查询

用自然语言查库、取数,不用手写 SQL。

数据同步与清洗

把多来源数据拉到一处做整理。

报表取数

按口径快速拉出统计结果。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 资料标注 3 个工具,职责相对集中,接入后不容易误操作。
  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 使用前要准备好API Key对应的凭据,并按最小权限配置。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在数据服务场景里让模型直接调用外部能力的人。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 完全不想在本地装环境的人。
  • 不方便管理密钥或第三方授权的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
simple local rag当前 3 stdio · 本地进程 本地部署 有 2026-05-17
Memory 9d25f64e 9 未标注 未标注 无 2026-05-17
Getzep MCP 9 stdio · 本地进程 本地部署 有 2026-05-17
anything-llm 未标注 stdio · 本地进程 本地部署 有 2026-04-11
Prisma MCP Server 未标注 stdio · 本地进程 本地部署 有 2026-05-17
Astr Bot 未标注 stdio · 本地进程 本地部署 有 2026-05-17

服务器档案

数据服务
字段来自项目仓库与公开索引,中文说明由本站标注
提供方dataML007上游标注的维护方 dataML007
分类数据服务本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式API Key远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · Python本地安装时用到的包标识与运行时
部署类型本地部署上游给出的部署形态
最近核验2026-05-17上游最后核验时间

详细介绍

9.6 KB
来自项目仓库与上游目录的原文,未做删改

简单的本地RAG系统

一个具有FAISS矢量数据库的多模态检索增强生成(RAG)系统,具有Streamlit前端、FastAPI后端和MCP服务器集成。

📋 目录

  • 特性
  • 建筑
  • 项目结构
  • 安装
  • 配置
  • 用法
  • API终点
  • MCP服务器
  • 对话记忆
  • 技术栈

✨ 特性

  • PDF文档上传:在FAISS矢量数据库中上传PDF文档并建立索引
  • 问答:根据索引文档提问并获得AI支持的答案
  • 对话记忆:保持对话中多个问题的上下文
  • 文档管理:列出并查看所有带有元数据的索引文档
  • MCP服务器:将功能作为MCP工具展示给其他应用程序
  • 永久存储:FAISS索引和元数据保存到磁盘以进行持久化
  • 消息来源:答案包括对源文件的引用

🏗️ 建筑

高级体系结构```

┌─────────────────┐
│ Streamlit UI │ ← User Interface
└────────┬────────┘
│ HTTP REST API
┌────────▼────────┐
│ FastAPI Backend│ ← Main API Server
└────────┬────────┘
│
┌────┴────┐
│ │
┌───▼───┐ ┌──▼──────┐
│ FAISS │ │ OpenAI │
│ Vector│ │ API │
│ Store │ │ │
└───────┘ └─────────┘

┌─────────────────┐
│ MCP Server │ ← External Integration
└─────────────────┘


### 组件详细信息

#### 1.后端(FastAPI)

后端为以下各项提供REST API端点:

- 文件上传和处理
- 文档列表
- 与RAG进行问答
- 会话管理

**关键模块:**

- `main.py`:带有路由处理程序的FastAPI应用程序
- `vector_store.py`:FAISS矢量数据库操作
- `pdf_processor.py`:PDF文本提取和分块
- `rag.py`:使用对话记忆检索增强生成逻辑
- `models.py`:用于请求/响应验证的Pydantic模型

#### 2.前端(Streamlit)

交互式web界面,具有:

- 文档上传界面
- 文档列表查看器
- 带有对话历史记录的聊天界面
- 源属性显示

#### 3.MCP服务器

模型上下文协议服务器公开了三个工具:

- `list_documents`:获取所有索引文档
- `upload_document`:上传并索引新文档
- `ask_question`:查询支持对话的文档

#### 4.矢量存储(FAISS)

- **索引类型**:L2距离与归一化向量(余弦相似度)
- **嵌入模型**:OpenAI `text-embedding-3-small` (1536个维度)
- **存储**:具有元数据的持久磁盘存储

#### 5.RAG管道

1. **文档处理**:

- 从PDF中提取文本
- 拆分为重叠的块(1000个字符,200个重叠)
- 为每个块生成嵌入
- 存储在FAISS索引中

1. **查询处理**:

- 为用户问题生成嵌入
- 在FAISS中搜索相似的块(top-k检索)
- 检索对话历史记录(如果提供了会话_id)
- 使用带有上下文的OpenAI LLM生成答案
- 更新对话历史记录

## 📁 项目结构```
simple_local_rag/
├── backend/
│   ├── app/
│   │   ├── __init__.py
│   │   ├── main.py              # FastAPI application
│   │   ├── models.py            # Pydantic models
│   │   ├── vector_store.py      # FAISS operations
│   │   ├── pdf_processor.py     # PDF processing
│   │   └── rag.py               # RAG logic with memory
│   └── pyproject.toml           # UV dependencies
├── frontend/
│   ├── streamlit_app.py         # Streamlit UI
│   └── requirements.txt         # Frontend dependencies
├── mcp/
│   ├── __init__.py
│   ├── server.py                # MCP server
│   └── pyproject.toml           # MCP dependencies
├── data/
│   ├── uploads/                 # Temporary PDF storage
│   ├── faiss_index.index        # FAISS vector index
│   ├── metadata.json            # Document metadata
│   └── chunks.pkl               # Chunk metadata
├── .env                         # Environment variables (create this)
├── .gitignore
└── README.md

🔧 安装

先决条件

  • Python 3.9或更高版本
  • UV包管理器(从安装 https://github.com/astral-sh/uv)
  • OpenAI API密钥

设置步骤

  1. 克隆或导航到项目目录:```bash
    cd simple_local_rag

1. **安装UV** (如果尚未安装):```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
  1. 创建虚拟环境并安装后端依赖项:```bash
    cd backend
    uv venv
    source .venv/bin/activate # On Windows: .venv\Scripts\activate
    uv pip install -e .
    cd ..

1. **安装前端依赖项**:```bash
cd frontend
uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv pip install -r requirements.txt
cd ..
  1. 安装MCP服务器依赖项 (可选):```bash
    cd mcp
    uv venv
    source .venv/bin/activate # On Windows: .venv\Scripts\activate
    uv pip install -e .
    cd ..

1. **创建 `.env` 文件** 在根目录中:```bash
cp .env.example .env
# Edit .env and add your OpenAI API key

⚙️ 配置

创建一个 .env 根目录中的文件,包含以下变量:```env

OpenAI API Configuration

OPENAI_API_KEY=your_openai_api_key_here

Backend API Configuration

API_HOST=0.0.0.0
API_PORT=8000

Frontend Configuration

STREAMLIT_SERVER_PORT=8501

MCP Server Configuration

MCP_SERVER_PORT=8001


## 🚀 用法

### 启动后端```bash
cd backend
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
python -m app.main

或者直接使用uvicorn:```bash
uvicorn app.main:app --host 0.0.0.0 --port 8000


API将于 `http://localhost:8000`

### 启动前端```bash
cd frontend
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
streamlit run streamlit_app.py

用户界面将在 http://localhost:8501

启动MCP服务器```bash

cd mcp
source .venv/bin/activate # On Windows: .venv\Scripts\activate
python server.py


MCP服务器将在 `http://localhost:8001`

## 📡 API终点

### 健康检查

- **获取** `/health`
- 返回API运行状况

### 上传文档

- **发布** `/upload`
- 上传PDF文件进行索引
- **请求**:多部分表单数据 `file` 领域
- **回应**:文档ID、文件名、块计数

### 列出文件

- **获取** `/documents`
- 获取所有索引文档的列表
- **回应**:包含元数据的文档列表

### 查询文档

- **发布** `/query`
- 询问有关索引文档的问题
- **请求体**:```json
{
"question": "What is the main topic?",
"conversation_id": "optional-conversation-id",
"top_k": 5
}
  • 回应:答案、对话id、相关块、来源

获取对话

  • 获取 /conversation/{conversation_id}
  • 获取完整的对话历史记录
  • 回应:对话中的所有消息

🔌 MCP服务器

MCP服务器公开了三个工具:

1.列表_文档

列出所有带有描述的索引文档。

MCP呼叫示例:```json
{
"tool": "list_documents",
"arguments": {}
}


### 2.上传文件

上传并索引新的PDF文档。

**MCP呼叫示例**:```json
{
"tool": "upload_document",
"arguments": {
"file_path": "/path/to/document.pdf",
"filename": "document.pdf"
}
}

3.提问

询问有关具有对话支持的索引文档的问题。

MCP呼叫示例:```json
{
"tool": "ask_question",
"arguments": {
"question": "What is the main topic?",
"conversation_id": "optional-id",
"top_k": 5
}
}


### MCP HTTP端点

- **获取** `/tools`:获取可用的MCP工具
- **发布** `/tools/call`:执行MCP工具

## 💬 对话记忆

系统通过以下方式维护对话上下文 `conversation_id`:

1. **第一个问题**:没有 `conversation_id` 需要-系统生成一个
1. **后续问题**:使用返回的 `conversation_id` 为了上下文
1. **上下文窗口**:保留最后20条消息(10次交换)
1. **存储**:内存中(可以持久化到生产中的数据库中)

### 示例流程```python
# First question
response1 = ask_question("What is machine learning?")
conversation_id = response1["conversation_id"]

# Follow-up question (maintains context)
response2 = ask_question("Can you give examples?", conversation_id=conversation_id)

# Conversation history includes both questions and answers

🛠️ 技术栈

  • 后端框架:FastAPI
  • 向量数据库:FAISS(CPU版本)
  • 嵌入:OpenAI文本嵌入3-small
  • LLM:OpenAI GPT-4o-mini
  • PDF处理:PyPDF2
  • 前端:流光灯
  • 程序包管理器:紫外线
  • 语言:Python 3.9+

📝 备注

  • 内存限制:对话历史记录存储在内存中。对于生产环境,考虑使用数据库(Redis、PostgreSQL等)
  • 矢量存储:FAISS索引存储在磁盘上,并在重新启动时持续存在
  • 分块策略:文档分为1000个字符块,重叠200个字符
  • 嵌入维度:1536(OpenAI文本嵌入3-small)
  • 错误处理:实现基本错误处理;增强生产使用

🔒 安全注意事项

  • 将API密钥安全地存储在 .env 文件(从不提交版本控制)
  • 为生产部署添加身份验证/授权
  • 验证文件上传(类型、大小限制)
  • 对API端点实施速率限制
  • 在生产环境中使用HTTPS

📚 额外资源

  • FAISS文件
  • FastAPI文档
  • 简化文档
  • OpenAI API文档
  • MCP规范

🤝 贡献

这是一个简单的本地RAG实现。您可以通过以下方式扩展它:

  • 支持更多文档类型(DOCX、TXT等)
  • 高级组块策略
  • 对话的数据库持久性
  • 用户认证
  • 多租户支持
  • 高级检索策略(重新排序、混合搜索)

📄 许可证

本项目按原样提供,用于教育和发展目的。

常见问题

7 问
答案由本站依据条目字段整理,不引用上游原文
simple local rag 怎么安装?

在客户端按下面的安装命令接入:python -m app.main。装完在客户端配置里引用同一个包或端点。

simple local rag 怎么在客户端里配置?

它的传输方式未标注,在客户端 MCP 配置里按官方文档填写启动命令和参数,保存后重启客户端生效。

simple local rag 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

simple local rag 需要 API Key 吗?

资料标注需要API Key认证,使用前准备好对应凭据,并按最小权限配置。

simple local rag 能提供哪些能力?

资料显示约 3 个工具;能力标签包括 检索增强生成、Python、文档处理、问答系统。具体工具清单以官方文档为准。

simple local rag 需要什么运行环境?

运行时为 Python;属于本地进程,需要在本机装好运行环境。

simple local rag 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-05-17。