docs: 新增 README.md，包含功能介绍、架构说明、安装配置及使用指南
This commit is contained in:
WJZ_P
261
README.md
Normal file
261
README.md
Normal file
@@ -0,0 +1,261 @@
|
||||
# Gemini Skill
|
||||
|
||||
通过 CDP（Chrome DevTools Protocol）操控 Gemini 网页版（gemini.google.com），实现 AI 生图、对话、图片提取等自动化操作。
|
||||
|
||||
## ✨ 功能
|
||||
|
||||
- 🎨 **AI 生图** — 发送 prompt 自动生成图片，支持高清原图下载
|
||||
- 💬 **文本对话** — 与 Gemini 进行多轮对话
|
||||
- 🖼️ **图片上传** — 上传参考图片，基于参考图生成新图
|
||||
- 📥 **图片提取** — 提取会话中的图片，支持 base64 和 CDP 完整尺寸下载
|
||||
- 🔄 **会话管理** — 新建会话、临时会话、切换模型、导航到历史会话
|
||||
- 🧹 **自动去水印** — 下载的图片自动移除 Gemini 水印
|
||||
- 🤖 **MCP Server** — 标准 MCP 协议接口，可被任何 MCP 客户端（如 Claude、CodeBuddy 等）调用
|
||||
|
||||
## 🏗️ 架构
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────┐
|
||||
│ MCP Client (AI) │
|
||||
│ Claude / CodeBuddy / ... │
|
||||
└──────────────────────┬──────────────────────────────┘
|
||||
│ stdio (JSON-RPC)
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────┐
|
||||
│ mcp-server.js (MCP 协议层) │
|
||||
│ 注册所有 MCP 工具，编排调用流程 │
|
||||
└──────────────────────┬──────────────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────┐
|
||||
│ index.js → browser.js (连接层) │
|
||||
│ ensureBrowser() → 自动拉起 Daemon → CDP 直连 │
|
||||
└──────────┬──────────────────────────────┬───────────┘
|
||||
│ HTTP (acquire/status) │ WebSocket (CDP)
|
||||
▼ ▼
|
||||
┌──────────────────────┐ ┌─────────────────────────┐
|
||||
│ Browser Daemon │ │ Chrome / Edge │
|
||||
│ (独立后台进程) │───▶│ gemini.google.com │
|
||||
│ daemon/server.js │ │ │
|
||||
│ ├─ engine.js │ │ Stealth + 反爬检测 │
|
||||
│ ├─ handlers.js │ └─────────────────────────┘
|
||||
│ └─ lifecycle.js │
|
||||
│ 30 分钟惰性销毁 │
|
||||
└──────────────────────┘
|
||||
```
|
||||
|
||||
**核心设计理念：**
|
||||
|
||||
- **Daemon 模式** — 浏览器进程由独立 Daemon 管理，MCP 调用结束后浏览器不关闭，30 分钟无活动才自动释放
|
||||
- **按需自启** — Daemon 未运行时 MCP 工具会自动拉起，无需手动启动
|
||||
- **Stealth 反爬** — 使用 `puppeteer-extra-plugin-stealth` 绕过网站检测
|
||||
- **职责分离** — `mcp-server.js`（协议层）→ `gemini-ops.js`（操作层）→ `browser.js`（连接层）→ `daemon/`（进程管理）
|
||||
|
||||
## 📦 安装
|
||||
|
||||
### 前置条件
|
||||
|
||||
- **Node.js** ≥ 18
|
||||
- **Chrome / Edge / Chromium** — 系统上需安装任一浏览器（或通过 `BROWSER_PATH` 指定路径）
|
||||
- 浏览器需提前 **登录 Google 账号**（Gemini 需要登录才能使用）
|
||||
|
||||
### 安装依赖
|
||||
|
||||
```bash
|
||||
git clone https://github.com/yourname/gemini-skill.git
|
||||
cd gemini-skill
|
||||
npm install
|
||||
```
|
||||
|
||||
## ⚙️ 配置
|
||||
|
||||
所有配置通过环境变量或 `.env` 文件设置。在项目根目录创建 `.env` 文件：
|
||||
|
||||
```env
|
||||
# 浏览器路径（不设则自动检测 Chrome/Edge/Chromium）
|
||||
# BROWSER_PATH=C:\Program Files\Google\Chrome\Application\chrome.exe
|
||||
|
||||
# CDP 远程调试端口（默认 40821）
|
||||
# BROWSER_DEBUG_PORT=40821
|
||||
|
||||
# 是否无头模式（默认 false，首次使用建议关闭以便登录）
|
||||
# BROWSER_HEADLESS=false
|
||||
|
||||
# 图片输出目录（默认 ./gemini-image）
|
||||
# OUTPUT_DIR=./gemini-image
|
||||
|
||||
# Daemon HTTP 端口（默认 40225）
|
||||
# DAEMON_PORT=40225
|
||||
|
||||
# Daemon 闲置超时（毫秒，默认 30 分钟）
|
||||
# DAEMON_TTL_MS=1800000
|
||||
```
|
||||
|
||||
也支持 `.env.development` 文件（优先级高于 `.env`）。
|
||||
|
||||
**配置优先级：** `process.env` > `.env.development` > `.env` > 代码默认值
|
||||
|
||||
## 🚀 使用
|
||||
|
||||
### 方式一：作为 MCP Server（推荐）
|
||||
|
||||
在 MCP 客户端配置文件中添加：
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"gemini": {
|
||||
"command": "node",
|
||||
"args": ["<项目绝对路径>/src/mcp-server.js"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
启动后 AI 即可通过 MCP 协议调用所有工具。
|
||||
|
||||
### 方式二：命令行启动
|
||||
|
||||
```bash
|
||||
# 启动 MCP Server（stdio 模式，供 AI 客户端调用）
|
||||
npm run mcp
|
||||
|
||||
# 单独启动 Browser Daemon（通常不需要，MCP 会自动拉起）
|
||||
npm run daemon
|
||||
|
||||
# 运行 Demo 示例
|
||||
npm run demo
|
||||
```
|
||||
|
||||
### 方式三：作为库调用
|
||||
|
||||
```javascript
|
||||
import { createGeminiSession, disconnect } from './src/index.js';
|
||||
|
||||
const { ops } = await createGeminiSession();
|
||||
|
||||
// 生图
|
||||
const result = await ops.generateImage('画一只可爱的猫咪', { fullSize: true });
|
||||
console.log('图片保存至:', result.filePath);
|
||||
|
||||
// 用完断开（不关浏览器，由 Daemon 继续守护）
|
||||
disconnect();
|
||||
```
|
||||
|
||||
## 🔧 MCP 工具列表
|
||||
|
||||
### 核心生图
|
||||
|
||||
| 工具名 | 说明 | 主要参数 |
|
||||
|--------|------|----------|
|
||||
| `gemini_generate_image` | 完整生图流程（耗时 60~120s） | `prompt`, `newSession`, `referenceImages`, `fullSize`, `timeout` |
|
||||
|
||||
### 会话管理
|
||||
|
||||
| 工具名 | 说明 | 主要参数 |
|
||||
|--------|------|----------|
|
||||
| `gemini_new_chat` | 新建空白对话 | 无 |
|
||||
| `gemini_temp_chat` | 进入临时对话模式 | 无 |
|
||||
| `gemini_navigate_to` | 导航到指定 Gemini URL（如历史会话） | `url`, `timeout` |
|
||||
|
||||
### 模型与对话
|
||||
|
||||
| 工具名 | 说明 | 主要参数 |
|
||||
|--------|------|----------|
|
||||
| `gemini_switch_model` | 切换模型（pro/quick/think） | `model` |
|
||||
| `gemini_send_message` | 发送文本并等待回复（耗时 10~60s） | `message`, `timeout` |
|
||||
|
||||
### 图片操作
|
||||
|
||||
| 工具名 | 说明 | 主要参数 |
|
||||
|--------|------|----------|
|
||||
| `gemini_upload_images` | 上传图片到输入框 | `images` |
|
||||
| `gemini_get_images` | 获取会话中所有图片元信息 | 无 |
|
||||
| `gemini_extract_image` | 提取图片 base64 并保存本地 | `imageUrl` |
|
||||
| `gemini_download_full_size_image` | 下载完整尺寸高清图片 | `index` |
|
||||
|
||||
### 文字回复
|
||||
|
||||
| 工具名 | 说明 | 主要参数 |
|
||||
|--------|------|----------|
|
||||
| `gemini_get_all_text_responses` | 获取所有文字回复 | 无 |
|
||||
| `gemini_get_latest_text_response` | 获取最新一条文字回复 | 无 |
|
||||
|
||||
### 诊断与管理
|
||||
|
||||
| 工具名 | 说明 | 主要参数 |
|
||||
|--------|------|----------|
|
||||
| `gemini_check_login` | 检查 Google 登录状态 | 无 |
|
||||
| `gemini_probe` | 探测页面元素状态 | 无 |
|
||||
| `gemini_reload_page` | 刷新页面 | `timeout` |
|
||||
| `gemini_browser_info` | 获取浏览器连接信息 | 无 |
|
||||
|
||||
## 🔄 Daemon 生命周期
|
||||
|
||||
```
|
||||
首次 MCP 调用
|
||||
│
|
||||
├─ Daemon 未运行 → 自动 spawn（detached + unref）
|
||||
│ → 轮询等待就绪（最多 15s）
|
||||
│
|
||||
├─ GET /browser/acquire → 启动/复用浏览器 + 重置 30 分钟倒计时
|
||||
│
|
||||
├─ MCP 工具执行完毕 → disconnect()（断开 WebSocket，不关浏览器）
|
||||
│
|
||||
├─ 30 分钟内再次调用 → 重置倒计时（续命）
|
||||
│
|
||||
└─ 30 分钟无人使用 → 关闭浏览器 + 关闭 HTTP 服务 + 退出进程
|
||||
（下次调用时自动重新拉起）
|
||||
```
|
||||
|
||||
**Daemon API 端点：**
|
||||
|
||||
| 端点 | 说明 |
|
||||
|------|------|
|
||||
| `GET /browser/acquire` | 获取浏览器连接（会续命） |
|
||||
| `GET /browser/status` | 查询浏览器状态（不续命） |
|
||||
| `POST /browser/release` | 主动销毁浏览器 |
|
||||
| `GET /health` | Daemon 健康检查 |
|
||||
|
||||
## 📁 项目结构
|
||||
|
||||
```
|
||||
gemini-skill/
|
||||
├── src/
|
||||
│ ├── index.js # 统一入口
|
||||
│ ├── mcp-server.js # MCP 协议服务（注册所有工具）
|
||||
│ ├── gemini-ops.js # Gemini 页面操作（核心逻辑）
|
||||
│ ├── operator.js # 底层 DOM 操作封装
|
||||
│ ├── browser.js # 浏览器连接器（面向 Skill）
|
||||
│ ├── config.js # 统一配置中心
|
||||
│ ├── util.js # 工具函数
|
||||
│ ├── watermark-remover.js # 图片去水印（基于 sharp）
|
||||
│ ├── demo.js # 使用示例
|
||||
│ ├── assets/ # 静态资源
|
||||
│ └── daemon/ # Browser Daemon（独立进程）
|
||||
│ ├── server.js # HTTP 微服务入口
|
||||
│ ├── engine.js # 浏览器引擎（launch/connect/terminate）
|
||||
│ ├── handlers.js # API 路由处理器
|
||||
│ └── lifecycle.js # 生命周期控制（惰性销毁倒计时）
|
||||
├── references/ # 参考文档
|
||||
├── SKILL.md # AI 调用规范（MCP 客户端读取）
|
||||
├── package.json
|
||||
└── .env # 环境配置（需自行创建）
|
||||
```
|
||||
|
||||
## ⚠️ 注意事项
|
||||
|
||||
1. **首次使用需登录** — 第一次运行时浏览器会打开 Gemini 页面，请手动完成 Google 账号登录。登录状态会保存在 `userDataDir` 中，后续无需重复登录。
|
||||
|
||||
2. **不要同时运行多个实例** — 同一个 CDP 端口只能有一个浏览器实例，否则会端口冲突。
|
||||
|
||||
3. **Windows Server 注意** — 已内置路径规范化和 Safe Browsing 绕过，但仍建议检查：
|
||||
- Chrome/Edge 已正确安装
|
||||
- 输出目录有写入权限
|
||||
- 防火墙未阻断 localhost 通信
|
||||
|
||||
4. **生图耗时较长** — 通常 60~120 秒，MCP 客户端的 `timeoutMs` 建议设为 ≥ 180000（3 分钟）。
|
||||
|
||||
## 📄 License
|
||||
|
||||
ISC
|
||||
Reference in New Issue
Block a user