返回 MCP 目录
public公开dns本地运行

Journal RAG

一个基于检索增强生成(RAG)的日记系统,支持按日期和主题组织日记,并提供语义搜索功能,可与AI代理连接增强交互。

article

README

🚀 期刊 RAG 系统

本项目提供了用于实现期刊检索增强生成(RAG)系统的代码,该代码对应于在 https://dev.to/lord_magus/supercharging-my-vs-code-ai-agent-with-local-rag-25n8 上发布的期刊内容,助力用户高效开展期刊相关的检索与生成工作。

🚀 快速开始

日记记录

您可以在 journal/YYYY/MM/ 目录结构中添加每日日记条目。需要注意的是,目前 journal/ 目录中的 .md 文件是用于测试索引和查询功能的 AI 生成示例文件。

RAG 搜索

使用自然语言查询对日记进行语义搜索,操作步骤如下:

source .venv/bin/activate
python .tech/code/scripts/rag_search.py

上述命令会递归索引所有日记条目,并允许您使用自然语言查询进行语义搜索。有关详细安装步骤,请参阅 install_instructions.md

MCP 服务器

此仓库还包含一个 MCP 服务器的代码,该服务器可将日记 RAG 系统连接到 AI 代理以增强交互。有关设置和连接 MCP 服务器的详细说明,请参阅 install_instructions.md

📚 详细文档

目录结构

该项目以日记为核心,将技术组件隐藏起来进行组织,具体结构如下:

/
├── README.md                 # 项目概述
├── journal/                  # 日记条目
│   ├── 2025/                 # 按年份分类
│   │   └── 04/               # 月份
│   │       ├── 18.md         # 每日日记
│   │       └── 19.md
│   └── topics/               # 主题条目(未来用途)
├── code/                     # 代码和脚本
│   ├── mcp/                  # MCP 服务器代码
│   │   └── journal_rag_mcp.py
│   ├── scripts/              # Python 脚本
│   │   └── rag_search.py
│   └── data/                 # 数据存储(如向量数据库)
│       └── chroma_db/        # 向量数据库(示例)
└── .venv/                    # Python 虚拟环境
help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端