LLM驱动的文件系统助手
此项目是一个MCP(模型上下文协议)服务器,允许您使用自然语言与本地文件系统进行交互。它由Groq LLaMA-3语言模型提供支持,并采用Flask构建了一个简单的基于聊天的web界面。
您可以要求它查找文件、获取文件的详细信息、阅读文件,甚至创建、编辑和删除文件,所有这些都可以通过一个简单的对话式UI完成。
特性
此应用程序满足任务的所有核心要求:
- 文件搜索和路径解析:即使你只知道部分名称或位置,也要让聊天机器人查找文件(例如,“在桌面上查找我的报告”)。
- 元数据检查:获取任何文件的详细信息,包括其完整路径、大小、创建日期、上次修改日期、文件类型和权限。
- 文件I/O操作:服务器提供了一系列文件操作工具:
- 阅读:查看基于文本的文件的内容。
- 创建:使用初始内容创建新文件。
- 编辑:将内容附加到现有文件或完全覆盖它们。
- 删除:通过确认步骤安全删除文件和空文件夹,以防止发生事故。
- LLM编排:使用大型语言模型以简单的英语理解您的命令,并将其映射到正确的文件系统工具。
技术栈
- 后端:Python,Flask
- API有限责任公司希腊:
- 前端:HTML、CSS、JavaScript(无框架)
- 依赖项:
python-dotenv,groq
入门指南
有两种方法可以运行此应用程序:作为独立的可执行文件快速启动,或从源代码进行开发。
选项1:快速启动(独立.exe)
这是让聊天机器人在没有任何开发设置的情况下运行的最简单方法。
- 下载可执行文件:转到项目GitHub存储库的“发布”部分,下载最新版本
.exe文件。 - 创建API密钥文件:在 同一文件夹 你在哪里救了
.exe,有一个文件夹config.内部config,有一个名为.env.你可以在那里找到GROQ API-KEY。 - 添加您的API密钥:打开
.env使用文本编辑器文件,然后添加Groq API密钥,如下所示:```
GROQ_API_KEY='your-groq-api-key-here'
1. **运行应用程序**:双击 `.exe` 文件。将出现一个终端窗口,指示服务器正在运行。
1. **打开聊天界面**:打开您的网络浏览器并导航到 **http://127.0.0.1:5000**。您现在可以开始与您的文件系统聊天了!
### 选项2:开发人员设置(源代码)
按照以下说明从源代码运行应用程序。
#### 先决条件
- Python 3.8+
- Git
#### 安装步骤
1. **克隆存储库**:```sh
git clone [https://github.com/your-username/your-repo-name.git](https://github.com/your-username/your-repo-name.git)
cd your-repo-name
- 创建虚拟环境 (推荐):```sh
For Windows
python -m venv venv
venv\Scripts\activate
For macOS/Linux
python3 -m venv venv
source venv/bin/activate
1. **再进行**A. `requirements.txt` 文件应包含在存储库中。```sh
pip install -r requirements.txt
(如果a requirements.txt 文件不可用,您可以创建一个包含以下内容的文件,然后运行上面的命令):```txt
requirements.txt
flask
groq
python-dotenv
1. **设置API密钥**:
- 创建一个名为的文件夹 `config` 在项目目录的根目录中。
- 内部 `config`,创建一个名为的文件 `.env`.
- 将您的Groq API密钥添加到 `.env` 文件:```
GROQ_API_KEY='your-groq-api-key-here'
- 运行应用程序:
sh python src/app.py
终端将显示Flask服务器正在运行 http://127.0.0.1:5000.
- 访问聊天界面:
打开您的网络浏览器并转到 http://127.0.0.1:5000 开始使用该应用程序。
项目结构
源代码的组织如下,以确保干净和可维护的结构。
