Commit Graph

294 Commits

Author SHA1 Message Date
Osinachi Okpara
e9901ac886 Update installation command for MCP Server dependencies 2025-09-08 01:26:10 +01:00
Osinachi Okpara
432849ee32 Apply suggestion from @cubic-dev-ai[bot]
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
2025-09-08 01:11:37 +01:00
Osinachi Okpara
e8405ebc21 Update mcp-server.mdx 2025-09-08 01:10:13 +01:00
Osinachi Okpara
939c633aaa Update docs/customize/mcp-server.mdx
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
2025-09-08 01:06:55 +01:00
Osinachi Okpara
77e98d9fba Merge branch 'main' into add-mcp-server-documentation 2025-09-08 01:02:17 +01:00
Osinachi Okpara
f6ab57367e Add MCP Server documentation
- Create comprehensive MCP Server documentation at docs/customize/mcp-server.mdx
- Add Integration group to navigation in docs.json
- Cover installation, Claude Desktop integration, available tools, and examples
- Address GitHub issue #2933 for missing MCP Server documentation
2025-09-08 00:49:34 +01:00
Magnus Müller
870d72a4a7 Update Qwen model recommendations in documentation to clarify action schema format issues with smaller models. 2025-09-07 16:26:32 -07:00
Magnus Müller
1380b1e903 qwen support 2025-09-07 16:25:15 -07:00
Magnus Müller
73fa4b56db Add Playwright integration example to documentation
This commit adds a new example demonstrating the integration of Playwright with Browser-Use, showcasing how to utilize Playwright for form filling, taking screenshots, and extracting text. The example is linked in the documentation and includes installation instructions and a comprehensive code sample.

- **New Documentation**
- Added a new Playwright integration example in `playwright-integration.mdx`.
- Updated `docs.json` to include the new example in the documentation index.
- Enhanced the `add.mdx` file with references to the Playwright integration example.

This enhances the usability of Browser-Use by providing clear guidance on leveraging Playwright's capabilities alongside it.
2025-09-06 15:13:52 -07:00
Enzo Biondo
1da79ca982 Merge branch 'main' into feat/video-recording 2025-09-06 14:43:33 -03:00
Magnus Müller
719761313c Refactor sensitive data handling across examples
- Updated sensitive_data definitions to remove type annotations for clarity.
- Simplified the structure of sensitive_data in multiple files, ensuring consistency in credential representation.
- Enhanced comments to guide users on the proper use of sensitive data in the context of 2FA and domain-specific credentials.

These changes improve the readability and maintainability of the code while ensuring secure handling of sensitive information.
2025-09-06 07:51:52 -07:00
Magnus Müller
f474e24b28 force-llm-output-after-failure 2025-09-04 17:22:32 -07:00
Magnus Müller
54c7806143 Merge branch 'main' into docs/hooks-update 2025-09-04 08:16:16 -07:00
Magnus Müller
1c269fffe7 Clean up hooks 2025-09-04 08:14:43 -07:00
Magnus Müller
9e04ab19b1 change tool error message from DOM to browser-state 2025-09-02 11:39:13 -07:00
Magnus Müller
4a0e9fe590 prompt guide 2025-09-02 10:58:49 -07:00
Magnus Müller
c57ca023aa Refactor documentation structure and add new sections
- Reformatted JSON structure in `docs.json` for better readability.
- Updated navigation paths for development-related documentation.
- Removed outdated `hooks.mdx` and `mcp-client.mdx` files.
- Added new `get-help.mdx`, `local-setup.mdx`, `contribution-guide.mdx`, and `observability.mdx` files to enhance developer resources.
- Introduced `telemetry.mdx` to clarify data collection practices and opt-out options.
- Updated `mcp-server.mdx` to reflect current capabilities and usage instructions.
2025-09-01 23:36:19 -07:00
Magnus Müller
5967eb48c9 update-sensitive-data-docs 2025-09-01 22:05:02 -07:00
Marian Schneider
0b4f5d3485 docs: updated hooks examples to use timeouts, removed internal API call, and clearer wording 2025-08-31 23:24:22 +02:00
Marian Schneider
6efbfd236c Merge branch 'main' into docs/hooks-update 2025-08-31 17:49:05 +02:00
Marian Schneider
d827aea29b docs: update hooks complex example to work with latest release 2025-08-31 17:34:45 +02:00
Mert Unsal
ea5c6b558e Enable highlights by default 2025-08-31 08:17:23 -07:00
Marian Schneider
ce6b88c26f docs: update hooks basic example to work with latest release 2025-08-31 17:04:35 +02:00
Marian Schneider
b579308c3b docs: update data available in hooks for Playwright removal 2025-08-31 15:38:28 +02:00
mertunsall
6de9261b85 disable highlights by default 2025-08-31 12:46:24 +02:00
Mert Unsal
157d0804cb Merge branch 'main' into correction-in-docs 2025-08-31 00:50:59 +02:00
Enzo Biondo
d6d5fd0fb6 Merge branch 'main' into feat/video-recording 2025-08-27 14:47:05 -03:00
Magnus Müller
7d83d6b332 Update browser parameters documentation to clarify is_local usage and remove deprecated stealth option. Adjust remote browser examples to reflect changes in parameter handling. 2025-08-27 10:06:56 -07:00
krishna
f430e2fc69 Minor documentation changes for consistency. 2025-08-27 20:36:52 +05:30
Magnus Müller
82b241ddbb Linter new line 2025-08-26 18:13:11 -07:00
Magnus Müller
d1c7c675c5 Fix spelling 2025-08-26 17:12:23 -07:00
Magnus Müller
bdadc37349 Remove confusing playwright name from docs 2025-08-26 16:46:10 -07:00
Magnus Müller
78cb7e5466 Remove 25 unused parameters 2025-08-26 16:19:53 -07:00
Magnus Müller
51af27aac5 Rename preload to directly_open_url 2025-08-26 15:15:37 -07:00
EnzoFanAccount
06d0b1e9ba Merge remote-tracking branch 'upstream/main' into feat/video-recording 2025-08-26 18:37:14 -03:00
Magnus Müller
29685aa7ce Merge remote-tracking branch 'origin/main' into rename-controller-to-tools 2025-08-26 13:58:21 -07:00
Magnus Müller
0e947099be docs remote browser 2025-08-26 13:01:30 -07:00
Magnus Müller
caa0e7ef1b Rename controller to tools instances 2025-08-26 11:30:39 -07:00
Magnus Müller
13dd73b23a Update Tool imports in docs, readme, and docstrings 2025-08-26 11:13:27 -07:00
Magnus Müller
09d2d4cf4e docs more examples 2025-08-26 11:00:12 -07:00
Magnus Müller
2a27d8c1bf reorder docs files 2025-08-26 10:29:16 -07:00
Magnus Müller
ce2a727015 Refine tools documentation for clarity and completeness
- Updated the "Add Tools" section to enhance clarity in tool registration instructions and examples.
- Revised the "Remove Tools" section description for better user understanding.
- Improved the "Response" section headings for consistency and clarity in context management.
2025-08-26 10:18:24 -07:00
Magnus Müller
b235e7bfe5 Add new tools documentation and enhance existing sections
- Introduced new documentation for "Available Tools" and "Remove Tools" to provide users with comprehensive guidance on tool management.
- Updated the "Basics" section to clarify the description of tools and included examples for better understanding.
- Enhanced the "Add Tools" section with additional examples to illustrate tool registration and usage.
- Improved the "Response" section by refining examples and clarifying the properties of `ActionResult` for better user comprehension.
2025-08-26 10:08:15 -07:00
Enzo Biondo
8cf26fcb0d Merge branch 'main' into feat/video-recording 2025-08-26 12:26:58 -03:00
Magnus Müller
9f272fab9a Enhance tool documentation with new examples and clarify action registration process
- Added new tools: "get 2fa code" and "send emails" to the basic tools section.
- Updated action registration instructions to simplify usage of the `@controller.action` decorator.
- Clarified return types for tools, allowing both `ActionResult` and simple strings.
- Improved examples for success and error responses, emphasizing the use of `ActionResult` properties.
2025-08-26 08:01:02 -07:00
Magnus Müller
264090e86b Simplify basics 2025-08-26 06:59:39 -07:00
Magnus Müller
9f347ce376 change doc title 2025-08-25 23:49:13 -07:00
Magnus Müller
1d4e1dfa8d Icons 2025-08-25 23:29:58 -07:00
Magnus Müller
6d31af92df Icons 2025-08-25 23:28:34 -07:00
EnzoFanAccount
a41bd90f05 Merge remote-tracking branch 'upstream/main' into feat/video-recording 2025-08-26 03:25:56 -03:00