安装

macOS	Windows	Linux	iOS	Android	Web
发布版	发布版	发布版 ¹	TestFlight	发布版	GitHub Pages ²

¹ Linux 注意事项:

• 请参阅下方的 Linux 系统要求，了解在 Ubuntu 22.04 和 24.04 上运行 AppImage/DEB 所需的运行时依赖项
• 使用体验优化：最新版本增加了更好的暗色主题支持，并遵循 XDG 基本目录规范 实现统一的数据存储；同时计划针对 Linux 桌面环境优化 UI 布局
• 已在主要发行版上测试通过：Ubuntu、Fedora、Arch Linux、openSUSE

² 注：Web 版本完全在您的浏览器中运行，聊天记录和设置将保存在本地存储中。

文档

此外，您还可以使用 DeepWiki 获取有关 chatmcp 的更多信息。
DeepWiki 是一个由 AI 驱动的平台，可将任何公开的 GitHub 仓库转化为一个完全交互式、易于理解的维基。它通过分析代码、文档和配置文件，生成清晰的解释、交互式图表，甚至允许与 AI 进行实时问答。

预览

数据同步

ChatMCP 应用程序可以在同一局域网内同步数据

使用方法

请确保您的系统中已安装 uvx 或 npx

MacOS

# uvx
brew install uv

# npx
brew install node 

Linux

# uvx
curl -LsSf https://astral.sh/uv/install.sh | sh

# npx (使用 apt)
sudo apt update
sudo apt install nodejs npm

Linux 系统要求（Ubuntu 22.04 和 24.04）

要在 Ubuntu 及其衍生系统上运行 ChatMCP AppImage/DEB，请安装以下运行时软件包：

• AppImage (FUSE): libfuse2
• GTK 3: libgtk-3-0
• 图形/EGL:
  • Ubuntu 22.04: libegl1-mesa, libgles2, libgl1-mesa-dri, libglx-mesa0
  • Ubuntu 24.04: libegl1, libgles2, libgl1-mesa-dri, libglx-mesa0
• X11 工具和 SQLite: libx11-6, xdg-utils, libsqlite3-0

安装命令如下：

• Ubuntu 22.04：

sudo apt install -y libfuse2 libgtk-3-0 libegl1-mesa libgles2 libgl1-mesa-dri libglx-mesa0 libx11-6 xdg-utils libsqlite3-0 libsqlite3-dev

• Ubuntu 24.04：

sudo apt install -y libfuse2 libgtk-3-0 libegl1 libgles2 libgl1-mesa-dri libglx-mesa0 libx11-6 xdg-utils libsqlite3-0 libsqlite3-dev

可选（推荐）：mesa-vulkan-drivers、mesa-utils（用于 glxinfo 等诊断工具）

1. 在“设置”页面中配置您的 LLM API 密钥和端点
2. 从“MCP 服务器”页面安装 MCP 服务器
3. 与 MCP 服务器聊天

• stdio mcp 服务器

• sse mcp 服务器

数据存储

ChatMCP 遵循各平台的最佳实践进行数据存储：

存储位置

macOS:

~/Library/Application Support/ChatMcp/

Windows:

%APPDATA%\ChatMcp\

Linux:

~/.local/share/ChatMcp/           # 如果设置了 $XDG_DATA_HOME，则优先使用
~/.local/share/run.daodao.chatmcp # Flutter 依赖

移动端：

• 应用程序文档目录

文件结构

所有平台均采用统一的目录结构存储数据：

• logs 文件夹 - 应用程序日志
• chatmcp.db - 主数据库文件，包含聊天记录和消息
• shared_preferences.json - 应用程序设置和偏好
• mcp_server.json - MCP 服务器配置

重置应用数据

要彻底重置应用程序（删除所有聊天记录、设置和配置）：

macOS:

rm -rf ~/Library/Application\ Support/ChatMcp

Windows:

rd /s /q "%APPDATA%\ChatMcp"

Linux:

rm -rf ~/.local/share/ChatMcp
rm -rf ~/.local/share/run.daodao.chatmcp

开发

安装 Flutter

要开发或运行 ChatMCP，您需要先安装 Flutter。
请按照适用于您平台的官方 Flutter 安装指南 进行操作。

• 下载 Flutter

安装完成后，请通过以下命令验证：

flutter --version

强制代码格式化与提交前钩子

为确保所有贡献者保持一致的代码风格，本仓库会在每次提交时强制执行 Dart 代码格式化。

• 仓库在 .githooks/pre-commit 中附带了一个版本化的 Git 钩子。
• 提交时，它会运行 dart format .，重新添加已更改的文件，然后进行无输出检查，以确保没有未格式化的文件。
• 格式不正确的提交将在本地被拒绝；此外，CI 也会使未格式化的 PR 失败。

快速设置（每个克隆只需一次）：

make setup-git-hooks

手动设置（替代方案）：

git config core.hooksPath .githooks
chmod +x .githooks/pre-commit

要求（PATH 中至少需要具备以下之一）：

• Dart SDK，或
• Flutter（内置了 Dart）

示例：

• macOS/Linux（Flutter）：

  export PATH="$PATH:$HOME/flutter/bin"
  which flutter && flutter --version
  which dart && dart --version
  

• macOS/Linux（Dart SDK）：

  export PATH="$PATH:$HOME/dart-sdk/bin"
  which dart && dart --version
  

• Windows（PowerShell）：将 C:\\src\\flutter\\bin（或您的 Flutter 路径）添加到用户/系统 PATH 中。通过以下命令验证：

  where flutter
  where dart
  

IDE 注意：更改 PATH 后，请重启 IDE，以便 VCS 操作（提交）继承更新后的环境。

CI 强制执行：

• 一个名为 check-format 的 GitHub Actions 工作流会在推送/PR 时运行 dart format --output=none --set-exit-if-changed .，如果存在任何未格式化的文件，该工作流将会失败。

政策：

• 请勿绕过钩子（例如使用 --no-verify）。此类更改将在 CI 中失败，并且仍需重新格式化。

克隆并本地运行

# 克隆仓库
git clone https://github.com/daodao97/chatmcp.git
cd chatmcp

# 安装依赖
flutter pub get

# 在 macOS 上运行
flutter run -d macos

# 在 Linux 上运行（需启用 Flutter 桌面支持）
flutter run -d linux

# 构建 Linux 发布版
flutter build linux

Web 版本

本地开发

# 安装依赖
flutter pub get

# 本地运行 Web 版本
flutter run -d chrome
# 或指定端口
flutter run -d chrome --web-port 8080
# 或以 Web 服务器模式运行，供其他浏览器访问。
flutter run -d web-server

构建 Web 版本

# 构建生产版本
flutter build web

# 带基础路径构建（用于部署到子目录）
flutter build web --base-href /chatmcp/

部署到 GitHub Pages

# 1. 构建 Web 版本
flutter build web --base-href /chatmcp/

# 2. 将 build/web 目录内容推送到 gh-pages 分支
# 或使用 GitHub Actions 进行自动部署

构建完成后，文件将位于 build/web 目录中，可部署到任何静态网站托管服务。

功能特性

• 与 MCP 服务器聊天
• MCP 服务器市场
• 自动安装 MCP 服务器
• 支持 SSE MCP 传输
• 自动选择 MCP 服务器
• 聊天历史
• OpenAI LLM 模型
• Claude LLM 模型
• OLLama LLM 模型
• DeepSeek LLM 模型
• RAG
• 更好的 UI 设计
• 黑色/白色主题

欢迎提交所有功能建议，您可以在 Issues 中提出您的想法或报告问题。

MCP 服务器市场

您可以从 MCP 服务器市场安装 MCP 服务器。MCP 服务器市场是一个 MCP 服务器的集合，您可以使用它与不同的数据源进行聊天。

• 您也可以向市场添加新的 MCP 服务器：MCP 服务器市场

请先 fork mcp_server_market，然后在文件末尾的 mcp_server_market.json 中添加您的 MCP 服务器。

{
    "mcpServers": {
        "existing-mcp-servers": {},
        "your-mcp-server": {
              "command": "uvx",
              "args": [
                  "--from",
                  "git+https://github.com/username/your-mcp-server",
                  "your-mcp-server"
            ]
        }
    }
}

随后，您可以向 mcp_server_market 仓库发送 Pull Request，以将您的 MCP 服务器加入市场。PR 合并后，您的 MCP 服务器将立即对其他用户开放。

您的反馈有助于我们改进 chatmcp，并帮助其他用户做出明智的决策。

致谢

• MCP
• mcp-cli

许可证

本项目采用 Apache License 2.0 许可。

星标历史

ChatMCP 快速上手指南

ChatMCP 是一款跨平台 AI 聊天客户端，支持 macOS、Windows、Linux、iOS、Android 及 Web 端。其核心特色是原生集成 MCP (Model Context Protocol)，允许用户轻松连接各类 MCP 服务器以扩展 AI 能力。

1. 环境准备

在开始使用前，请确保系统已安装以下基础依赖之一，用于运行 MCP 服务：

• UVX (推荐): 高性能 Python 包管理工具
• NPX: Node.js 包执行工具

依赖安装命令

macOS

# 安装 uvx
brew install uv

# 或安装 npx (需要 Node.js)
brew install node 

Linux

# 安装 uvx
curl -LsSf https://astral.sh/uv/install.sh | sh

# 或安装 npx (使用 apt)
sudo apt update
sudo apt install nodejs npm

Linux 额外运行时依赖 (Ubuntu 22.04 / 24.04) 若使用 AppImage 或 DEB 安装包，需安装以下图形与系统库：

• Ubuntu 22.04:

  sudo apt install -y libfuse2 libgtk-3-0 libegl1-mesa libgles2 libgl1-mesa-dri libglx-mesa0 libx11-6 xdg-utils libsqlite3-0 libsqlite3-dev
  

• Ubuntu 24.04:

  sudo apt install -y libfuse2 libgtk-3-0 libegl1 libgles2 libgl1-mesa-dri libglx-mesa0 libx11-6 xdg-utils libsqlite3-0 libsqlite3-dev
  

2. 安装步骤

根据你的设备平台选择对应的安装方式：

平台	安装方式
macOS / Windows / Android	访问 GitHub Releases 下载对应安装包
Linux	访问 GitHub Releases 下载 AppImage 或 DEB 包
iOS	通过 TestFlight 加入测试
Web (网页版)	直接访问 GitHub Pages (数据存储在本地浏览器)

3. 基本使用

安装完成后，按照以下三个步骤即可开始使用：

第一步：配置大模型 (LLM)

1. 打开 ChatMCP，进入 设置 (Setting) 页面。
2. 填入你的 LLM API Key 和 Endpoint（支持 OpenAI, Claude, OLLama, DeepSeek 等模型）。

第二步：安装 MCP 服务器

1. 进入 MCP Server 页面。
2. 从 MCP Server Market 中选择需要的服务进行安装，或手动配置 Stdio/SSE 类型的服务器。
   • 示例配置 (Stdio): 指定命令如 uvx 及对应参数。
   • 示例配置 (SSE): 填入 SSE 服务端点 URL。

第三步：开始对话

返回聊天界面，选择已安装的 MCP 服务器即可开始对话。ChatMCP 会自动调用服务器工具来处理你的请求（如读取文件、搜索网络、生成图表等）。

---

附：数据存储位置

如需备份或重置数据，可查找以下路径：

• macOS: ~/Library/Application Support/ChatMcp/
• Windows: %APPDATA%\ChatMcp\
• Linux: ~/.local/share/ChatMcp/

重置数据命令 (慎用，将清空所有记录):

# macOS
rm -rf ~/Library/Application\ Support/ChatMcp

# Windows (PowerShell)
rd /s /q "%APPDATA%\ChatMcp"

# Linux
rm -rf ~/.local/share/ChatMcp
rm -rf ~/.local/share/run.daodao.chatmcp