Skip to content
Back to search

mcp-ui

基于MCP(Model Context Protocol)的智能聊天应用,支持Web和桌面环境。集成OpenAI/Anthropic API,提供MCP服务器的所有工具能力。简洁现代的UI设计,支持跨平台部署。

Safety scan

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

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/bitshift-byte--mcp-ui/badge.svg)](/listings/bitshift-byte--mcp-ui)

HTML

<a href="/listings/bitshift-byte--mcp-ui"><img src="/api/listings/bitshift-byte--mcp-ui/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 · 256 lines

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

  1. # MCP 聊天应用
  2. 基于 Model Context Protocol 的智能聊天应用,支持Web和桌面环境。
  3. ## 项目介绍
  4. MCP聊天应用是一个基于Vue.js构建的现代化聊天界面,支持通过Model Context Protocol (MCP)与各种服务和工具进行交互。MCP是Anthropic推出的开放协议标准,允许AI模型直接调用诸如数据库、文件系统、浏览器自动化、第三方mcp服务等。
  5. 本应用同时支持Web端和桌面端(基于Electron),并且集成了OpenAI和Anthropic两种主流大模型服务。
  6. ## 应用界面展示
  7. ![应用界面概览](./image/截屏2025-04-09%2000.38.13.png)
  8. ![聊天功能展示](./image/截屏2025-04-09%2000.38.31.png)
  9. ![模型配置界面](./image/截屏2025-04-09%2000.38.53.png)
  10. ![环境配置示例](./image/截屏2025-04-09%2000.38.13.png)
  11. ![应用启动界面](./image/截屏2025-04-09%2000.39.07.png)
  12. ![构建后的应用](./image/截屏2025-04-09%2000.39.24.png)
  13. ![模型设置界面](./image/截屏2025-04-09%2000.39.38.png)
  14. ## 核心功能特点
  15. - **简洁现代**的聊天界面设计
  16. - **MCP协议支持**:与外部工具和服务进行无缝交互
  17. - **多模型支持**:兼容OpenAI和Anthropic两种API格式
  18. - **自定义配置**:可配置API密钥、基础URL和模型选项
  19. - **可扩展架构**:支持添加自定义工具和服务
  20. - **桌面应用**:提供跨平台(Windows/Mac/Linux)桌面体验
  21. - **浏览器自动化**:支持AI控制浏览器执行任务
  22. - **本地服务**:集成MCP后端服务提供强大功能
  23. ## 系统要求
  24. - **Node.js**: v16.0.0+
  25. - **npm**: v8.0.0+
  26. - **现代浏览器**:Chrome, Firefox, Safari, Edge最新版本
  27. - **操作系统**:Windows 10+, macOS 10.15+, Ubuntu 20.04+(桌面版)
  28. ## 快速开始
  29. ### 安装依赖
  30. ```bash
  31. npm install
  32. ```
  33. ### 配置环境变量(非必要)
  34. 复制`.env.example`文件到`.env`,并填入必要的API密钥和配置:
  35. ```bash
  36. cp .env.example .env
  37. ```
  38. 编辑`.env`文件设置以下内容:
  39. ```
  40. VITE_API_KEY=your_api_key_here
  41. VITE_MODEL_PROVIDER=openai # 或 anthropic
  42. MCP_SERVER_PORT=3001 # MCP服务器端口
  43. ```
  44. ### 启动应用
  45. #### Web应用开发模式
  46. ```bash
  47. # 启动前端开发服务器
  48. npm run dev
  49. # 在另一个终端启动MCP后端服务
  50. npm run mcp:server
  51. ```
  52. #### 桌面应用开发模式
  53. ```bash
  54. # 启动Electron应用
  55. npm run electron:dev
  56. # 在另一个终端启动MCP后端服务
  57. npm run mcp:server
  58. ```
  59. ### 运行应用
  60. #### Web应用
  61. ```bash
  62. npm run dev
  63. # 在另一个终端启动MCP后端服务
  64. npm run mcp:server
  65. ```
  66. #### 桌面应用
  67. ```bash
  68. # 启动Electron应用
  69. npm run electron:dev
  70. # 在另一个终端启动MCP后端服务
  71. npm run mcp:server
  72. ```
  73. ### 构建应用
  74. #### Web应用构建
  75. ```bash
  76. npm run build
  77. ```
  78. #### 桌面应用构建
  79. ```bash
  80. # 构建所有平台版本
  81. npm run electron:build
  82. # 构建特定平台版本
  83. npm run electron:buildwin # Windows
  84. npm run electron:buildmac # macOS
  85. npm run electron:buildlinux # Linux
  86. ```
  87. ## 详细使用说明
  88. ### 配置模型设置
  89. 1. 打开应用后,点击右上角的⚙️设置图标
  90. 2. 在设置面板中配置:
  91. - **模型提供商**:选择OpenAI或Anthropic
  92. - **API密钥**:输入对应服务的API密钥
  93. - **API基础URL**:可选,如使用自定义API端点或代理服务
  94. - **模型**:选择要使用的具体模型
  95. - **自定义模型**:添加和管理自定义模型配置
  96. ### 使用聊天功能
  97. - 在底部输入框中输入问题或命令
  98. - 点击发送按钮或按回车键发送消息
  99. - 使用工具功能获取实时信息或执行任务(如浏览网页、查询数据等)
  100. - 支持Markdown格式和代码高亮显示
  101. ### MCP工具使用
  102. 本应用集成了以下MCP工具:
  103. - **浏览器自动化**:AI可控制浏览器访问网页、提取信息
  104. - **天气查询**:获取实时天气信息
  105. - **新闻搜索**:检索最新新闻内容
  106. - **文件操作**:读取和写入文件(桌面版)
  107. 通过聊天界面直接请求AI使用这些工具,无需额外操作。
  108. ## 项目架构
  109. ### 目录结构
  110. - `src/` - 前端源代码
  111. - `components/` - Vue组件
  112. - `services/` - API服务
  113. - `composables/` - Vue组合式函数
  114. - `utils/` - 工具函数
  115. - `styles/` - CSS样式文件
  116. - `assets/` - 静态资源
  117. - `electron/` - Electron桌面应用代码
  118. - `config/` - 应用配置文件
  119. - `mcp_server.js` - MCP后端服务
  120. - `public/` - 静态资源目录
  121. ### 关键技术栈
  122. - **前端**:Vue 3, TypeScript, Vite
  123. - **API集成**:OpenAI API, Anthropic API
  124. - **MCP协议**:@modelcontextprotocol/sdk
  125. - **桌面应用**:Electron
  126. - **服务端**:Express, Node.js
  127. ## 开发指南
  128. ### 添加新的MCP工具
  129. 1. 在`mcp_server.js`中的工具定义部分添加新工具描述
  130. 2. 实现对应的工具处理逻辑
  131. 3. 重启MCP服务器以应用更改
  132. 示例:
  133. ```javascript
  134. // 添加新工具定义
  135. const tools = [
  136. {
  137. name: "my_new_tool",
  138. description: "这是一个新工具的描述",
  139. parameters: {
  140. type: "object",
  141. properties: {
  142. param1: { type: "string", description: "参数1的描述" }
  143. },
  144. required: ["param1"]
  145. }
  146. },
  147. // 其他工具...
  148. ];
  149. // 实现工具处理逻辑
  150. app.post('/mcp/tools/call', async (req, res) => {
  151. // ...
  152. if (toolName === "my_new_tool") {
  153. const result = await handleMyNewTool(arguments);
  154. return res.json({ result });
  155. }
  156. // ...
  157. });
  158. ```
  159. ### 自定义UI组件
  160. 修改或创建`src/components/`目录下的Vue组件以定制UI。
  161. ## 部署指南
  162. ### Web应用部署
  163. 1. 运行`npm run build`生成生产环境代码
  164. 2. 将`dist`目录部署到任何静态Web服务器
  165. 3. 确保MCP后端服务正确配置并运行
  166. ### 桌面应用分发
  167. 1. 运行对应平台的构建命令
  168. 2. 在`dist_electron`目录找到构建好的安装包
  169. 3. 分发安装包给用户
  170. ## 故障排除
  171. - **API连接问题**:检查API密钥和网络连接
  172. - **MCP服务失败**:查看服务器日志,确保相关依赖已安装
  173. - **UI显示异常**:清除浏览器缓存,检查控制台错误
  174. - **工具调用失败**:检查MCP后端日志,确保工具正确配置
  175. ## 相关资源
  176. - [Model Context Protocol 文档](https://mcplab.cc/zh/docs/getstarted/quickstart/client)
  177. - [OpenAI API 文档](https://platform.openai.com/docs/api-reference)
  178. - [Anthropic Claude API](https://www.anthropic.com/api)
  179. - [Vue.js 文档](https://vuejs.org/)
  180. - [Electron 文档](https://www.electronjs.org/docs)
  181. ## 贡献指南
  182. 欢迎提交Pull Request或Issue来改进这个项目。贡献前请先查看现有Issues和项目路线图。
  183. ## 许可证
  184. MIT

Ratings and comments

Sign in to rate this skill.

Sign in

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