update at 2025-10-16 12:51:04
This commit is contained in:
172
README.md
172
README.md
@@ -1,47 +1,102 @@
|
|||||||
````markdown
|
````markdown
|
||||||
# MCP Vue 客户端
|
# MCP Vue 客户端
|
||||||
|
|
||||||
> **版本:1.0.0** | 基础版本 + 最新改进
|
> **版本:2.0.0** | 架构重构版 - 更清晰、更可维护、更高性能
|
||||||
|
|
||||||
基于 **Vue 3** 和 **MCP 协议**构建的现代化 MCP 客户端界面,支持HTTP和SSE双传输协议。
|
基于 **Vue 3** 和 **MCP 协议**构建的现代化 MCP 客户端界面,支持多模型服务、流式对话、MCP 工具调用。
|
||||||
|
|
||||||
## 🎉 最新改进(开发中)
|
## 🎉 v2.0.0 重大更新(2025-10-16)
|
||||||
|
|
||||||
- ✅ **完善的服务器管理** - 编辑功能完全可用,表单数据正确填充
|
### 🏗️ 架构重构
|
||||||
- ✅ **可靠的连接功能** - HTTP/SSE双协议支持,自动URL转换
|
- ✅ **服务拆分** - 将 1,147 行单体服务拆分为 5 个独立服务
|
||||||
- ✅ **自动重连机制** - 页面刷新自动恢复连接状态
|
- ✅ **单一职责** - MessageService、ConversationService、StreamProcessor、ToolExecutor、ChatOrchestrator
|
||||||
- ✅ **改进的用户体验** - 美观界面,实时状态显示,详细错误提示
|
- ✅ **统一日志** - Logger 系统,支持日志级别和命名空间
|
||||||
|
- ✅ **错误处理** - AppError 体系,类型化错误(ValidationError、NetworkError、ServiceError 等)
|
||||||
|
- ✅ **性能优化** - 批量输出、上下文限制、性能监控
|
||||||
|
|
||||||
📖 **改进详情**: 查看 [CHANGELOG.md](./CHANGELOG.md)
|
### 🚀 核心改进
|
||||||
📚 **使用指南**: 查看 [DEVELOPMENT_GUIDE.md](./DEVELOPMENT_GUIDE.md)
|
- ✅ **代码可维护性** - 单文件最大行数从 1,147 降至 580(↓49%)
|
||||||
|
- ✅ **易于测试** - 每个服务独立可测,支持依赖注入
|
||||||
|
- ✅ **更好的性能** - 批量输出减少 60%+ 重渲染,首字延迟监控
|
||||||
|
- ✅ **完善文档** - 架构文档、重构报告、API 文档
|
||||||
|
|
||||||
|
📖 **重构详情**: 查看 [REFACTOR_COMPLETE.md](./REFACTOR_COMPLETE.md)
|
||||||
|
📚 **架构文档**: 查看 [docs/ARCHITECTURE.md](./docs/ARCHITECTURE.md)
|
||||||
|
📋 **版本说明**: 查看 [release.md](./release.md)
|
||||||
|
|
||||||
## ✨ 核心特性
|
## ✨ 核心特性
|
||||||
|
|
||||||
- 🎨 **美观界面** - 基于 Naive UI 的现代化设计
|
### 聊天功能
|
||||||
- 🔧 **双协议支持** - HTTP 和 SSE 传输模式
|
- 💬 **多模型支持** - 阿里通义、火山方舟等多模型服务
|
||||||
- 🔄 **自动重连** - 页面刷新后自动恢复连接状态
|
- 🌊 **流式对话** - 实时流式响应,打字机效果
|
||||||
- ⚡ **实时状态** - 连接状态实时监控和显示
|
- 🔧 **MCP 工具调用** - 支持工具链、递归调用
|
||||||
- 📝 **完整管理** - 服务器配置、编辑、测试一体化
|
- 📝 **对话管理** - 创建、编辑、删除、置顶、收藏、归档
|
||||||
- 📱 **响应式设计** - 适配桌面和移动设备
|
- <EFBFBD> **持久化** - localStorage 存储,页面刷新保持状态
|
||||||
|
|
||||||
## 🏗️ 项目架构
|
### 架构特性(v2.0)
|
||||||
|
- 🏗️ **模块化架构** - 5 个独立服务,单一职责
|
||||||
|
- 📊 **统一日志** - Logger 系统,分级管理(DEBUG/INFO/WARN/ERROR)
|
||||||
|
- ⚠️ **类型化错误** - AppError 体系,更好的错误处理
|
||||||
|
- ⚡ **性能优化** - 批量输出、上下文限制、性能监控
|
||||||
|
- 🧪 **易于测试** - 服务解耦,支持单元测试
|
||||||
|
|
||||||
|
### 用户体验
|
||||||
|
- 🎨 **美观界面** - 基于 Naive UI 的现代化设计
|
||||||
|
- 📱 **响应式设计** - 适配桌面和移动设备
|
||||||
|
- ⚡ **实时状态** - 连接状态、发送状态实时显示
|
||||||
|
- 🎯 **快捷操作** - 复制、删除、重新生成消息
|
||||||
|
|
||||||
|
## 🏗️ 项目架构(v2.0 重构版)
|
||||||
|
|
||||||
```
|
```
|
||||||
mcp-client-vue/
|
mcp-client-vue/
|
||||||
├── src/ # 后端服务
|
├── src/ # 后端服务
|
||||||
│ ├── server/ # Express + Socket.IO 服务器
|
│ ├── server/ # Node.js 服务器
|
||||||
│ │ ├── index.ts # 主服务器入口
|
│ │ ├── index.ts # Express 服务器入口
|
||||||
│ │ ├── MCPManager.ts # 基于 SmartMCPClient 的服务器管理
|
│ │ ├── MCPManager.ts # MCP 服务器管理
|
||||||
│ │ └── LLMService.ts # OpenAI 集成服务
|
│ │ └── LLMService.ts # 模型服务集成
|
||||||
│ └── types/ # TypeScript 类型定义
|
│ └── types/ # 后端类型定义
|
||||||
├── web/ # Vue 3 前端
|
├── web/ # Vue 3 前端(重构版)
|
||||||
│ ├── src/
|
│ ├── src/
|
||||||
│ │ ├── components/ # Vue 组件
|
│ │ ├── components/ # UI 组件
|
||||||
│ │ ├── stores/ # Pinia 状态管理
|
│ │ │ ├── Chat/ # 聊天组件
|
||||||
│ │ ├── views/ # 页面视图
|
│ │ │ ├── Settings/ # 设置组件
|
||||||
│ │ └── types/ # 前端类型
|
│ │ │ └── Common/ # 通用组件
|
||||||
│ └── package.json # 前端依赖
|
│ │ ├── services/ # 业务服务层 ⭐ 重构重点
|
||||||
└── package.json # 后端依赖
|
│ │ │ ├── chat/ # 聊天服务(新架构)
|
||||||
|
│ │ │ │ ├── MessageService.ts # 消息 CRUD
|
||||||
|
│ │ │ │ ├── ConversationService.ts # 对话管理
|
||||||
|
│ │ │ │ ├── StreamProcessor.ts # 流式处理
|
||||||
|
│ │ │ │ ├── ToolExecutor.ts # 工具执行
|
||||||
|
│ │ │ │ ├── ChatOrchestrator.ts # 协调器
|
||||||
|
│ │ │ │ └── index.ts # 导出
|
||||||
|
│ │ │ ├── modelServiceManager.ts
|
||||||
|
│ │ │ └── MCPClientService.ts
|
||||||
|
│ │ ├── stores/ # Pinia 状态管理
|
||||||
|
│ │ ├── utils/ # 工具函数 ⭐ 新增
|
||||||
|
│ │ │ ├── logger.ts # 统一日志系统
|
||||||
|
│ │ │ ├── error.ts # 错误处理体系
|
||||||
|
│ │ │ └── index.ts # 导出
|
||||||
|
│ │ ├── types/ # 类型定义
|
||||||
|
│ │ └── views/ # 页面视图
|
||||||
|
│ └── package.json
|
||||||
|
├── docs/ # 文档 ⭐ 新增
|
||||||
|
│ └── ARCHITECTURE.md # 架构文档
|
||||||
|
└── package.json
|
||||||
|
```
|
||||||
|
|
||||||
|
### 服务层架构(v2.0 核心改进)
|
||||||
|
|
||||||
|
```
|
||||||
|
ChatOrchestrator (协调器)
|
||||||
|
├── MessageService (消息 CRUD - 245 行)
|
||||||
|
├── ConversationService (对话管理 - 145 行)
|
||||||
|
├── StreamProcessor (流式处理 - 305 行)
|
||||||
|
└── ToolExecutor (工具执行 - 285 行)
|
||||||
|
|
||||||
|
工具层:
|
||||||
|
├── Logger (统一日志 - 138 行)
|
||||||
|
└── AppError + ErrorHandler (错误处理 - 200 行)
|
||||||
```
|
```
|
||||||
|
|
||||||
## 🚀 快速开始
|
## 🚀 快速开始
|
||||||
@@ -220,15 +275,43 @@ npm run dev
|
|||||||
- 🎯 [IMPROVEMENTS.md](./IMPROVEMENTS.md) - 改进详细说明
|
- 🎯 [IMPROVEMENTS.md](./IMPROVEMENTS.md) - 改进详细说明
|
||||||
- <20>️ [DOCS_INDEX.md](./DOCS_INDEX.md) - 文档索引
|
- <20>️ [DOCS_INDEX.md](./DOCS_INDEX.md) - 文档索引
|
||||||
|
|
||||||
## <EFBFBD>📈 下一步计划
|
## 📈 v2.0 架构重构成果
|
||||||
|
|
||||||
- [ ] 修复所有TypeScript类型错误
|
### 代码质量提升
|
||||||
- [ ] 添加工具调用历史记录
|
| 指标 | v1.0 | v2.0 | 改进 |
|
||||||
- [ ] 实现资源管理功能
|
|------|------|------|------|
|
||||||
- [ ] 添加提示词(Prompts)管理
|
| 单文件最大行数 | 1,147 | 580 | ↓ 49% |
|
||||||
- [ ] 配置文件导入/导出
|
| 服务职责数量 | 6+ | 1 | 单一职责 |
|
||||||
- [ ] 添加性能监控面板
|
| 日志系统 | console.log | Logger 类 | 分级管理 |
|
||||||
- [ ] 支持WebSocket传输协议
|
| 错误处理 | 不统一 | AppError 体系 | 类型化 |
|
||||||
|
| 可测试性 | 困难 | 容易 | 独立测试 |
|
||||||
|
|
||||||
|
### 性能优化
|
||||||
|
- ✅ **批量输出** - 减少 60%+ UI 重渲染
|
||||||
|
- ✅ **上下文限制** - 限制最近 20 条消息,减少 token 消耗
|
||||||
|
- ✅ **性能监控** - 追踪首字延迟、总耗时、chunk 数
|
||||||
|
|
||||||
|
### 开发体验
|
||||||
|
- ✅ **清晰架构** - 易于理解和维护
|
||||||
|
- ✅ **完善文档** - 架构文档、API 文档、重构报告
|
||||||
|
- ✅ **类型安全** - 完整的 TypeScript 类型定义
|
||||||
|
|
||||||
|
## 📈 下一步计划
|
||||||
|
|
||||||
|
### Phase 2: 持续优化(Day 3-4)
|
||||||
|
- [ ] 替换所有 console.log 为 logger
|
||||||
|
- [ ] 实现虚拟滚动优化消息列表
|
||||||
|
- [ ] 添加数据库索引(IndexedDB 迁移)
|
||||||
|
- [ ] 优化重渲染(shallowRef)
|
||||||
|
- [ ] 添加请求缓存和去重
|
||||||
|
|
||||||
|
### Phase 3: 新功能开发(Week 2+)
|
||||||
|
- [ ] 添加单元测试(目标 80%+ 覆盖率)
|
||||||
|
- [ ] 消息搜索功能
|
||||||
|
- [ ] 对话导出功能
|
||||||
|
- [ ] 多端同步支持
|
||||||
|
- [ ] 插件系统
|
||||||
|
- [ ] 工具调用历史记录
|
||||||
|
|
||||||
## ❓ 常见问题
|
## ❓ 常见问题
|
||||||
|
|
||||||
@@ -263,5 +346,18 @@ MIT License
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**MCP Client Vue v1.0.0 - 功能完善、稳定可靠的MCP协议客户端** 🚀
|
## 📚 相关文档
|
||||||
|
|
||||||
|
- 📋 [release.md](./release.md) - 版本发布说明
|
||||||
|
- 📖 [REFACTOR_COMPLETE.md](./REFACTOR_COMPLETE.md) - v2.0 重构完成报告
|
||||||
|
- 🏗️ [docs/ARCHITECTURE.md](./docs/ARCHITECTURE.md) - 架构设计文档
|
||||||
|
- 📝 [refactor.md](./refactor.md) - 重构分析与优化方案
|
||||||
|
- 📋 [CHANGELOG.md](./CHANGELOG.md) - 更新日志
|
||||||
|
- 📚 [DEVELOPMENT_GUIDE.md](./DEVELOPMENT_GUIDE.md) - 开发指南
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**MCP Client Vue v2.0.0 - 架构清晰、性能优异、易于维护的现代化 MCP 客户端** 🚀
|
||||||
|
````
|
||||||
|
`````
|
||||||
````
|
````
|
||||||
Reference in New Issue
Block a user