UNPKG

@mcpflow.io/mcp-puppeteer

Version:

Browser automation and web scraping.

258 lines (175 loc) 6.09 kB
# Puppeteer <!-- MCPFlow Packaged MCP --> > 此包由 [MCPFlow](https://mcpflow.io) 打包并发布到npm仓库。 Browser automation and web scraping. ## 安装与使用 直接使用npx运行: ```bash npx @mcpflow.io/mcp-puppeteer ``` 或者先安装后使用: ```bash # 安装 npm install @mcpflow.io/mcp-puppeteer # 使用 npx @mcpflow.io/mcp-puppeteer ``` ## 使用方法 请参考原始仓库的使用说明 ## 工具函数 ### retrieveContext 从AWS知识库中检索上下文信息 **参数:** - `n`: 检索结果数量 - `query`: 检索查询文本 - `knowledgeBaseId`: AWS知识库ID ### performWebSearch 使用Brave Search API进行网络搜索 **参数:** - `count`: 搜索结果数量 - `query`: 搜索查询文本 - `offset`: 分页偏移量 ### performLocalSearch 使用Brave Local Search API进行本地搜索 **参数:** - `count`: 搜索结果数量 - `query`: 本地搜索查询文本 ### generate_image 使用EverArt模型生成图片 **参数:** - `model`: 模型ID - `prompt`: 所需图片的文本描述 - `image_count`: 生成图片数量 ### list_allowed_directories 获取允许访问的目录列表 **参数:** ### search_files 在指定路径下搜索匹配模式的文件 **参数:** - `path`: 搜索根路径 - `pattern`: 搜索模式 - `excludePatterns`: 排除模式 ### get_file_info 获取文件或目录的详细信息 **参数:** - `path`: 文件或目录路径 ### search 在Google Drive中搜索文件 **参数:** - `query`: 搜索查询 ## 原始信息 - **开发者:** modelcontextprotocol - **版本:** 1.0.0 - **许可证:** MIT License - **原始仓库:** [modelcontextprotocol/servers/blob/main/src/puppeteer](https://github.com/modelcontextprotocol/servers/blob/main/src/puppeteer) ## 原始README # Puppeteer A Model Context Protocol server that provides browser automation capabilities using Puppeteer. This server enables LLMs to interact with web pages, take screenshots, and execute JavaScript in a real browser environment. ## Components ### Tools - **puppeteer_navigate** - Navigate to any URL in the browser - Inputs: - `url` (string, required): URL to navigate to - `launchOptions` (object, optional): PuppeteerJS LaunchOptions. Default null. If changed and not null, browser restarts. Example: `{ headless: true, args: ['--user-data-dir="C:/Data"'] }` - `allowDangerous` (boolean, optional): Allow dangerous LaunchOptions that reduce security. When false, dangerous args like `--no-sandbox`, `--disable-web-security` will throw errors. Default false. - **puppeteer_screenshot** - Capture screenshots of the entire page or specific elements - Inputs: - `name` (string, required): Name for the screenshot - `selector` (string, optional): CSS selector for element to screenshot - `width` (number, optional, default: 800): Screenshot width - `height` (number, optional, default: 600): Screenshot height - **puppeteer_click** - Click elements on the page - Input: `selector` (string): CSS selector for element to click - **puppeteer_hover** - Hover elements on the page - Input: `selector` (string): CSS selector for element to hover - **puppeteer_fill** - Fill out input fields - Inputs: - `selector` (string): CSS selector for input field - `value` (string): Value to fill - **puppeteer_select** - Select an element with SELECT tag - Inputs: - `selector` (string): CSS selector for element to select - `value` (string): Value to select - **puppeteer_evaluate** - Execute JavaScript in the browser console - Input: `script` (string): JavaScript code to execute ### Resources The server provides access to two types of resources: 1. **Console Logs** (`console://logs`) - Browser console output in text format - Includes all console messages from the browser 2. **Screenshots** (`screenshot://<name>`) - PNG images of captured screenshots - Accessible via the screenshot name specified during capture ## Key Features - Browser automation - Console log monitoring - Screenshot capabilities - JavaScript execution - Basic web interaction (navigation, clicking, form filling) - Customizable Puppeteer launch options ## Configuration to use Puppeteer Server Here's the Claude Desktop configuration to use the Puppeter server: ### Docker **NOTE** The docker implementation will use headless chromium, where as the NPX version will open a browser window. ```json { "mcpServers": { "puppeteer": { "command": "docker", "args": ["run", "-i", "--rm", "--init", "-e", "DOCKER_CONTAINER=true", "mcp/puppeteer"] } } } ``` ### NPX ```json { "mcpServers": { "puppeteer": { "command": "npx", "args": ["-y", "@modelcontextprotocol/server-puppeteer"] } } } ``` ### Launch Options You can customize Puppeteer's browser behavior in two ways: 1. **Environment Variable**: Set `PUPPETEER_LAUNCH_OPTIONS` with a JSON-encoded string in the MCP configuration's `env` parameter: ```json { "mcpServers": { "mcp-puppeteer": { "command": "npx", "args": ["-y", "@modelcontextprotocol/server-puppeteer"], "env": { "PUPPETEER_LAUNCH_OPTIONS": "{ \"headless\": false, \"executablePath\": \"C:/Program Files/Google/Chrome/Application/chrome.exe\", \"args\": [] }", "ALLOW_DANGEROUS": "true" } } } } ``` 2. **Tool Call Arguments**: Pass `launchOptions` and `allowDangerous` parameters to the `puppeteer_navigate` tool: ```json { "url": "https://example.com", "launchOptions": { "headless": false, "defaultViewport": {"width": 1280, "height": 720} } } ``` ## Build Docker build: ```bash docker build -t mcp/puppeteer -f src/puppeteer/Dockerfile . ``` ## License This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.