mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 13:48:09 +00:00
Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com>
128 lines
5.4 KiB
Plaintext
128 lines
5.4 KiB
Plaintext
---
|
|
title: MultiOn Tool
|
|
description: MultiOnTool은 CrewAI agent가 자연어 지시를 통해 웹을 탐색하고 상호작용할 수 있는 기능을 제공합니다.
|
|
icon: globe
|
|
mode: "wide"
|
|
---
|
|
|
|
## 개요
|
|
|
|
`MultiOnTool`은 [MultiOn](https://docs.multion.ai/welcome)의 웹 브라우징 기능을 래핑하도록 설계되어, CrewAI 에이전트가 자연어 명령을 사용하여 웹 브라우저를 제어할 수 있게 해줍니다. 이 도구는 원활한 웹 브라우징을 지원하여, 동적인 웹 데이터 상호작용 및 웹 기반 작업의 자동화가 필요한 프로젝트에 필수적인 자산이 됩니다.
|
|
|
|
## 설치
|
|
|
|
이 도구를 사용하려면 MultiOn 패키지를 설치해야 합니다:
|
|
|
|
```shell
|
|
uv add multion
|
|
```
|
|
|
|
또한 MultiOn 브라우저 확장 프로그램을 설치하고 API 사용을 활성화해야 합니다.
|
|
|
|
## 시작하는 단계
|
|
|
|
`MultiOnTool`을 효과적으로 사용하려면 다음 단계를 따르세요:
|
|
|
|
1. **CrewAI 설치**: Python 환경에 `crewai[tools]` 패키지가 설치되어 있는지 확인하세요.
|
|
2. **MultiOn 설치 및 사용**: [MultiOn 문서](https://docs.multion.ai/learn/browser-extension)를 참고하여 MultiOn 브라우저 확장 프로그램을 설치하세요.
|
|
3. **API 사용 활성화**: 브라우저의 확장 프로그램 폴더에서 MultiOn 확장 프로그램을 클릭하여(웹 페이지에 떠 있는 MultiOn 아이콘이 아님) 확장 프로그램 설정을 엽니다. API 활성화 토글을 클릭하여 API를 활성화하세요.
|
|
|
|
## 예시
|
|
|
|
다음 예시는 도구를 초기화하고 웹 브라우징 작업을 실행하는 방법을 보여줍니다:
|
|
|
|
```python Code
|
|
from crewai import Agent, Task, Crew
|
|
from crewai_tools import MultiOnTool
|
|
|
|
# Initialize the tool
|
|
multion_tool = MultiOnTool(api_key="YOUR_MULTION_API_KEY", local=False)
|
|
|
|
# Define an agent that uses the tool
|
|
browser_agent = Agent(
|
|
role="Browser Agent",
|
|
goal="Control web browsers using natural language",
|
|
backstory="An expert browsing agent.",
|
|
tools=[multion_tool],
|
|
verbose=True,
|
|
)
|
|
|
|
# Example task to search and summarize news
|
|
browse_task = Task(
|
|
description="Summarize the top 3 trending AI News headlines",
|
|
expected_output="A summary of the top 3 trending AI News headlines",
|
|
agent=browser_agent,
|
|
)
|
|
|
|
# Create and run the crew
|
|
crew = Crew(agents=[browser_agent], tasks=[browse_task])
|
|
result = crew.kickoff()
|
|
```
|
|
|
|
## 매개변수
|
|
|
|
`MultiOnTool`은(는) 초기화 시 다음과 같은 매개변수를 허용합니다:
|
|
|
|
- **api_key**: 선택 사항. MultiOn API 키를 지정합니다. 제공되지 않은 경우, `MULTION_API_KEY` 환경 변수를 찾습니다.
|
|
- **local**: 선택 사항. 에이전트를 로컬 브라우저에서 실행하려면 `True`로 설정합니다. MultiOn 브라우저 확장 프로그램이 설치되어 있고 API 사용이 체크되어 있는지 확인하세요. 기본값은 `False`입니다.
|
|
- **max_steps**: 선택 사항. MultiOn 에이전트가 명령에 대해 수행할 수 있는 최대 단계 수를 설정합니다. 기본값은 `3`입니다.
|
|
|
|
## 사용법
|
|
|
|
`MultiOnTool`을 사용할 때, 에이전트는 도구가 웹 브라우징 동작으로 변환하는 자연어 지시를 제공합니다. 도구는 브라우징 세션 결과와 상태를 함께 반환합니다.
|
|
|
|
```python Code
|
|
# Example of using the tool with an agent
|
|
browser_agent = Agent(
|
|
role="Web Browser Agent",
|
|
goal="Search for and summarize information from the web",
|
|
backstory="An expert at finding and extracting information from websites.",
|
|
tools=[multion_tool],
|
|
verbose=True,
|
|
)
|
|
|
|
# Create a task for the agent
|
|
search_task = Task(
|
|
description="Search for the latest AI news on TechCrunch and summarize the top 3 headlines",
|
|
expected_output="A summary of the top 3 AI news headlines from TechCrunch",
|
|
agent=browser_agent,
|
|
)
|
|
|
|
# Run the task
|
|
crew = Crew(agents=[browser_agent], tasks=[search_task])
|
|
result = crew.kickoff()
|
|
```
|
|
|
|
반환된 상태가 `CONTINUE`인 경우, 에이전트가 실행을 계속하기 위해 동일한 지시를 다시 내리도록 해야 합니다.
|
|
|
|
## 구현 세부사항
|
|
|
|
`MultiOnTool`은 CrewAI의 `BaseTool`의 하위 클래스로 구현됩니다. 이는 MultiOn 클라이언트를 래핑하여 웹 브라우징 기능을 제공합니다:
|
|
|
|
```python Code
|
|
class MultiOnTool(BaseTool):
|
|
"""Tool to wrap MultiOn Browse Capabilities."""
|
|
|
|
name: str = "Multion Browse Tool"
|
|
description: str = """Multion gives the ability for LLMs to control web browsers using natural language instructions.
|
|
If the status is 'CONTINUE', reissue the same instruction to continue execution
|
|
"""
|
|
|
|
# Implementation details...
|
|
|
|
def _run(self, cmd: str, *args: Any, **kwargs: Any) -> str:
|
|
"""
|
|
Run the Multion client with the given command.
|
|
|
|
Args:
|
|
cmd (str): The detailed and specific natural language instruction for web browsing
|
|
*args (Any): Additional arguments to pass to the Multion client
|
|
**kwargs (Any): Additional keyword arguments to pass to the Multion client
|
|
"""
|
|
# Implementation details...
|
|
```
|
|
|
|
## 결론
|
|
|
|
`MultiOnTool`은 CrewAI 에이전트에 웹 브라우징 기능을 통합할 수 있는 강력한 방법을 제공합니다. 에이전트가 자연어 지시를 통해 웹사이트와 상호작용할 수 있게 함으로써, 데이터 수집 및 연구에서 웹 서비스와의 자동화된 상호작용에 이르기까지 웹 기반 작업의 다양한 가능성을 열어줍니다.
|