Skip to content

README_ZH.md

Latest commit

 

History

History
309 lines (221 loc) · 9.03 KB

README_ZH.md

File metadata and controls

309 lines (221 loc) · 9.03 KB
Raw
logo

chatmcp

跨平台 MacOS | Windows | Linux | iOS | Android | Web AI 聊天客户端

English | 简体中文 | Türkçe

安装

平台 链接 说明
macOS Release
Windows Release
Linux Release 请参见下方“Linux 运行环境需求” ¹
iOS TestFlight
Android Release
Web GitHub Pages 完全在浏览器中运行，使用本地存储保存聊天记录和设置 ²

¹ 提示：请参见下方“Linux 运行环境需求（Ubuntu 22.04 与 24.04）”。

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

预览

Artifact Display Thinking Mode Generate Image LaTeX Support HTML Preview Mermaid Diagram mcp workflow mcp inmemory MCP Tools LLM Provider MCP Stdio MCP SSE

数据同步

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

Data sync

使用方法

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

# uvx
brew install uv

# npx
brew install node

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
  • 其他：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
  • Ubuntu 24.04：
sudo apt install -y libfuse2 libgtk-3-0 libegl1 libgles2 libgl1-mesa-dri libglx-mesa0 libx11-6 xdg-utils libsqlite3-0

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

  1. 在"设置"页面配置您的 LLM API 密钥和端点
  2. 从"MCP 服务器"页面安装 MCP 服务器
  3. 与 MCP 服务器开始对话

  • stdio mcp server

  • sse mcp server

调试

  • logs & data

macOS:

~/Library/Application Support/ChatMcp

Windows:

%APPDATA%\ChatMcp

Linux:

~/.local/share/ChatMcp

Mobile:

  • Application Documents Directory

reset app can use this command

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 pub get
flutter run -d macos

必要的代码格式化与 Pre-commit Hook

为确保团队代码风格一致，本仓库在每次提交（commit）前强制执行 Dart 格式化。

  • 仓库内提供了版本化的 Git 钩子：.githooks/pre-commit
  • 在提交时会运行 dart format .，并重新 git add 变更的文件，然后执行只检查不输出的步骤，确保没有未格式化的文件。
  • 如果存在未格式化的文件，提交会在本地被阻止；此外，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，使其在提交操作时继承最新的环境变量。

CI 校验：

  • GitHub Actions 工作流 check-format 会在 push/PR 时运行 dart format --output=none --set-exit-if-changed .，若有未格式化文件则任务失败。

政策：

  • 请不要绕过 hooks（例如使用 --no-verify）。即使绕过，本次 PR 也会在 CI 中失败，仍需格式化后再提交。

Web版本开发和部署

本地开发

# 安装依赖
flutter pub get

# 本地运行Web版本
flutter run -d chrome
# 或者指定端口
flutter run -d chrome --web-port 8080

构建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 目录中，可以部署到任何静态网站托管服务。

Android 签名配置

如果您需要构建发布版本的 Android 应用，请配置签名：

# 生成签名密钥
./scripts/create_keystore.sh

# 验证签名配置
./scripts/verify_signing.sh

# 构建签名的 APK
flutter build apk --release

# 构建签名的 App Bundle（推荐用于 Google Play）
flutter build appbundle --release

详细的签名配置说明请参考：Android 签名配置指南

功能特性

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

欢迎提交任何功能建议，您可以在 Issues 中提交您的想法或错误报告。

MCP 服务器市场

您可以从 MCP 服务器市场安装 MCP 服务器。MCP 服务器市场是 MCP 服务器的集合，您可以用它来与不同的数据进行对话。

您也可以在 MCP 服务器市场 中添加新的 MCP 服务器。

创建 mcp_server_market 的 fork 并添加您的 MCP 服务器到 mcp_server_market.json 文件的末尾。

{
    "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，也能帮助其他用户做出明智的决定。

致谢

许可证

本项目采用 Apache License 2.0 许可证。

Star History