Skip to main content

Python browser automation MCP framework for AI Agents

Project description

RootBrowse

Python 浏览器自动化 MCP 框架,为 AI Agent 提供结构化的浏览器交互能力。基于 DrissionPage 构建。

核心特性

  • 直接 xpath 操作 — 不依赖快照式 ref,所有定位直接查实时 DOM,动态页面不失效
  • 区域化拆分 — 将页面 DOM 按语义区块分组,解决复杂页面的信息过载问题
  • 渐进式获取 — get_regions → get_region_summary → match_element → get_element,按需逐步深入
  • run_js 支持 — 绕过 DOM 传输限制,长文本分段提取:innerText.substring(0, 2000)
  • TabManager 实时同步 — 直接委托 DrissionPage.tab_ids(),标签页状态始终准确

安装

pip install rootbrowse

快速开始

from rootbrowse import Browser

# 创建浏览器实例
browser = Browser()
browser.get('https://example.com')

# 获取页面区块
regions = browser.view.get_regions()
print(regions)  # [Region(xpath='/html/body/div[1]', label='容器'), ...]

# 获取区块统计摘要
summary = browser.view.get_region_summary(regions[0].xpath)
print(f"元素数量: {summary.count}")

# 按条件筛选元素
elements = browser.view.match_element(tag='a', text_contains='Python', limit=20)
print(elements)  # [ElementPreview(xpath='...', text='Python 入门', ...), ...]

# 获取完整元素信息
ele = browser.view.get_element(elements[0].xpath)
print(f"点击: {ele.text} -> {ele.attrs['href']}")

# 执行操作
result = browser.act.click(ele.xpath)
print(f"点击结果: {result.success}")

# 使用 run_js 获取长文本(绕过 DOM 限制)
text = browser.run_js("return document.body.innerText.substring(0, 2000)")

# 关闭浏览器
browser.close()

AI 工作流

用户指令
    ↓
get_regions()              → 查看页面有哪些区块(返回 xpath)
get_region_summary(xpath) → 查看区块统计(标签分布、role 分布)
match_element(...)         → 按条件筛选元素(摘要列表)
get_element(xpath)        → 获取元素完整信息
ElementOperator 操作      → 点击、输入、悬停等(使用 xpath)

核心概念

xpath 定位

不再使用快照式 ref,直接用 xpath 操作元素,每次都实时查询 DOM。

# match_element 返回 ElementPreview,含 xpath
elements = browser.view.match_element(tag='a', limit=10)
# [ElementPreview(xpath='/html/body/div[1]/a[1]', text='...'), ...]

# 直接用 xpath 点击
browser.act.click(elements[0].xpath)

run_js 长文本提取

绕过 DOM 传输限制,分段获取无限长度文本:

# 分段提取,规避 MCP token 限制
part1 = browser.run_js("return document.body.innerText.substring(0, 2000)")
part2 = browser.run_js("return document.body.innerText.substring(2000, 5000)")
part3 = browser.run_js("return document.body.innerText.substring(5000, 10000)")

区域化拆分

页面 DOM 有几千个节点,直接给 AI 无法处理。RootBrowse 按语义区块拆分:

页面 DOM
    ↓ 按语义区域分组(header, main, sidebar 等)
    ↓ 过滤噪音(script, style, meta)
    ↓ 统计每个区域的节点数
返回:Region 列表,AI 选择进入哪个区域

渐进式获取

get_regions()           → 看有哪些区块
get_region_summary()     → 看区块统计(tag 分布)
match_element()           → 按条件筛选元素(摘要)
get_element()             → 最后才看完整信息

每一步都返回精简数据,AI 按需逐步深入。

API 概览

Browse — 主入口

browser.get(url)                  # 打开 URL
browser.screenshot(path)           # 截图
browser.save_state(path)          # 保存会话状态
browser.load_state(path)          # 恢复会话状态
browser.run_js(code, args)        # 执行 JavaScript
browser.close()                   # 关闭浏览器

TabManager — 标签页管理

browser.tabs.new_tab(url)         # 新建标签页
browser.tabs.close_tab(index)     # 关闭标签页
browser.tabs.switch_to_tab(index) # 切换标签页
browser.tabs.tabs_count()          # 获取标签页数量
browser.tabs.current_index()      # 获取当前索引

PageScanner — 页面扫描

browser.view.get_regions()                    # 获取区块列表
browser.view.get_region_summary(region_xpath) # 获取区块统计
browser.view.match_element(**filters)         # 筛选元素
browser.view.get_element(xpath)              # 获取完整元素
browser.view.find_element(by, value)         # 精确定位

ElementOperator — 元素操作

browser.act.click(xpath)              # 点击
browser.act.input_by_xpath(xpath, text) # 输入
browser.act.hover(xpath)             # 悬停
browser.act.double_click(xpath)      # 双击
browser.act.right_click(xpath)       # 右键
browser.act.submit(xpath)            # 提交表单
browser.act.clear(xpath)             # 清空输入框
browser.act.send_enter()              # 发送回车

数据类型

类型 说明
Region 页面语义区块 {xpath, label}
Element 可交互元素 {tag, role, text, xpath, attrs}
RegionSummary 区域统计 {count, tag_counts, role_counts, text_preview}
ElementPreview 元素摘要 {xpath, text, attrs_preview}
OperationResult 操作结果 {success, error?, new_url?}

异常

异常 说明
BrowserError 浏览器相关错误
ElementNotFoundError 元素未找到
RegionNotFoundError 区域未找到
TabNotFoundError 标签页未找到
OperationError 操作失败
StateFileError 状态文件错误
PageLoadError 页面加载失败

技术栈

  • 底层引擎: DrissionPage — Python CDP 连接,无需驱动
  • MCP 框架: FastMCP(官方 Python MCP SDK)
  • Python 版本: >= 3.10

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rootbrowse-0.4.0.tar.gz (23.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rootbrowse-0.4.0-py3-none-any.whl (14.2 kB view details)

Uploaded Python 3

File details

Details for the file rootbrowse-0.4.0.tar.gz.

File metadata

  • Download URL: rootbrowse-0.4.0.tar.gz
  • Upload date:
  • Size: 23.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.7

File hashes

Hashes for rootbrowse-0.4.0.tar.gz
Algorithm Hash digest
SHA256 27a9e67b6b74920a8de12fdec4668232ba45723943a62001b9f87aec8b1da6ee
MD5 1f852324f95279b09657c063ef2155ef
BLAKE2b-256 425aa369ebaefbde7ab099f4065f03d3e7020ac1cec0a0109e0b650ee2571e77

See more details on using hashes here.

File details

Details for the file rootbrowse-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: rootbrowse-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 14.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.7

File hashes

Hashes for rootbrowse-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 08c0f81fc01706403499edf1c1978cc8a2a30a30fdc44171d8cc93e7feea7dc2
MD5 212b8118836c5a0de062416341cefffe
BLAKE2b-256 199ef855b2cd21c9a2f59cdfc13f1aeb0028aa1a683c9cc3193eaee11adcc22c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page