mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 05:38:12 +00:00
* feat: adopt directory-based docs versioning with Edge channel 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> * style: resolve linter issues --------- Co-authored-by: Cursor <cursoragent@cursor.com>
364 lines
10 KiB
Plaintext
364 lines
10 KiB
Plaintext
---
|
|
title: Collaboration
|
|
description: How to enable agents to work together, delegate tasks, and communicate effectively within CrewAI teams.
|
|
icon: screen-users
|
|
mode: "wide"
|
|
---
|
|
|
|
## Overview
|
|
|
|
Collaboration in CrewAI enables agents to work together as a team by delegating tasks and asking questions to leverage each other's expertise. When `allow_delegation=True`, agents automatically gain access to powerful collaboration tools.
|
|
|
|
## Quick Start: Enable Collaboration
|
|
|
|
```python
|
|
from crewai import Agent, Crew, Task
|
|
|
|
# Enable collaboration for agents
|
|
researcher = Agent(
|
|
role="Research Specialist",
|
|
goal="Conduct thorough research on any topic",
|
|
backstory="Expert researcher with access to various sources",
|
|
allow_delegation=True, # 🔑 Key setting for collaboration
|
|
verbose=True
|
|
)
|
|
|
|
writer = Agent(
|
|
role="Content Writer",
|
|
goal="Create engaging content based on research",
|
|
backstory="Skilled writer who transforms research into compelling content",
|
|
allow_delegation=True, # 🔑 Enables asking questions to other agents
|
|
verbose=True
|
|
)
|
|
|
|
# Agents can now collaborate automatically
|
|
crew = Crew(
|
|
agents=[researcher, writer],
|
|
tasks=[...],
|
|
verbose=True
|
|
)
|
|
```
|
|
|
|
## How Agent Collaboration Works
|
|
|
|
When `allow_delegation=True`, CrewAI automatically provides agents with two powerful tools:
|
|
|
|
### 1. **Delegate Work Tool**
|
|
Allows agents to assign tasks to teammates with specific expertise.
|
|
|
|
```python
|
|
# Agent automatically gets this tool:
|
|
# Delegate work to coworker(task: str, context: str, coworker: str)
|
|
```
|
|
|
|
### 2. **Ask Question Tool**
|
|
Enables agents to ask specific questions to gather information from colleagues.
|
|
|
|
```python
|
|
# Agent automatically gets this tool:
|
|
# Ask question to coworker(question: str, context: str, coworker: str)
|
|
```
|
|
|
|
## Collaboration in Action
|
|
|
|
Here's a complete example showing agents collaborating on a content creation task:
|
|
|
|
```python
|
|
from crewai import Agent, Crew, Task, Process
|
|
|
|
# Create collaborative agents
|
|
researcher = Agent(
|
|
role="Research Specialist",
|
|
goal="Find accurate, up-to-date information on any topic",
|
|
backstory="""You're a meticulous researcher with expertise in finding
|
|
reliable sources and fact-checking information across various domains.""",
|
|
allow_delegation=True,
|
|
verbose=True
|
|
)
|
|
|
|
writer = Agent(
|
|
role="Content Writer",
|
|
goal="Create engaging, well-structured content",
|
|
backstory="""You're a skilled content writer who excels at transforming
|
|
research into compelling, readable content for different audiences.""",
|
|
allow_delegation=True,
|
|
verbose=True
|
|
)
|
|
|
|
editor = Agent(
|
|
role="Content Editor",
|
|
goal="Ensure content quality and consistency",
|
|
backstory="""You're an experienced editor with an eye for detail,
|
|
ensuring content meets high standards for clarity and accuracy.""",
|
|
allow_delegation=True,
|
|
verbose=True
|
|
)
|
|
|
|
# Create a task that encourages collaboration
|
|
article_task = Task(
|
|
description="""Write a comprehensive 1000-word article about 'The Future of AI in Healthcare'.
|
|
|
|
The article should include:
|
|
- Current AI applications in healthcare
|
|
- Emerging trends and technologies
|
|
- Potential challenges and ethical considerations
|
|
- Expert predictions for the next 5 years
|
|
|
|
Collaborate with your teammates to ensure accuracy and quality.""",
|
|
expected_output="A well-researched, engaging 1000-word article with proper structure and citations",
|
|
agent=writer # Writer leads, but can delegate research to researcher
|
|
)
|
|
|
|
# Create collaborative crew
|
|
crew = Crew(
|
|
agents=[researcher, writer, editor],
|
|
tasks=[article_task],
|
|
process=Process.sequential,
|
|
verbose=True
|
|
)
|
|
|
|
result = crew.kickoff()
|
|
```
|
|
|
|
## Collaboration Patterns
|
|
|
|
### Pattern 1: Research → Write → Edit
|
|
```python
|
|
research_task = Task(
|
|
description="Research the latest developments in quantum computing",
|
|
expected_output="Comprehensive research summary with key findings and sources",
|
|
agent=researcher
|
|
)
|
|
|
|
writing_task = Task(
|
|
description="Write an article based on the research findings",
|
|
expected_output="Engaging 800-word article about quantum computing",
|
|
agent=writer,
|
|
context=[research_task] # Gets research output as context
|
|
)
|
|
|
|
editing_task = Task(
|
|
description="Edit and polish the article for publication",
|
|
expected_output="Publication-ready article with improved clarity and flow",
|
|
agent=editor,
|
|
context=[writing_task] # Gets article draft as context
|
|
)
|
|
```
|
|
|
|
### Pattern 2: Collaborative Single Task
|
|
```python
|
|
collaborative_task = Task(
|
|
description="""Create a marketing strategy for a new AI product.
|
|
|
|
Writer: Focus on messaging and content strategy
|
|
Researcher: Provide market analysis and competitor insights
|
|
|
|
Work together to create a comprehensive strategy.""",
|
|
expected_output="Complete marketing strategy with research backing",
|
|
agent=writer # Lead agent, but can delegate to researcher
|
|
)
|
|
```
|
|
|
|
## Hierarchical Collaboration
|
|
|
|
For complex projects, use a hierarchical process with a manager agent:
|
|
|
|
```python
|
|
from crewai import Agent, Crew, Task, Process
|
|
|
|
# Manager agent coordinates the team
|
|
manager = Agent(
|
|
role="Project Manager",
|
|
goal="Coordinate team efforts and ensure project success",
|
|
backstory="Experienced project manager skilled at delegation and quality control",
|
|
allow_delegation=True,
|
|
verbose=True
|
|
)
|
|
|
|
# Specialist agents
|
|
researcher = Agent(
|
|
role="Researcher",
|
|
goal="Provide accurate research and analysis",
|
|
backstory="Expert researcher with deep analytical skills",
|
|
allow_delegation=False, # Specialists focus on their expertise
|
|
verbose=True
|
|
)
|
|
|
|
writer = Agent(
|
|
role="Writer",
|
|
goal="Create compelling content",
|
|
backstory="Skilled writer who creates engaging content",
|
|
allow_delegation=False,
|
|
verbose=True
|
|
)
|
|
|
|
# Manager-led task
|
|
project_task = Task(
|
|
description="Create a comprehensive market analysis report with recommendations",
|
|
expected_output="Executive summary, detailed analysis, and strategic recommendations",
|
|
agent=manager # Manager will delegate to specialists
|
|
)
|
|
|
|
# Hierarchical crew
|
|
crew = Crew(
|
|
agents=[manager, researcher, writer],
|
|
tasks=[project_task],
|
|
process=Process.hierarchical, # Manager coordinates everything
|
|
manager_llm="gpt-4o", # Specify LLM for manager
|
|
verbose=True
|
|
)
|
|
```
|
|
|
|
## Best Practices for Collaboration
|
|
|
|
### 1. **Clear Role Definition**
|
|
```python
|
|
# ✅ Good: Specific, complementary roles
|
|
researcher = Agent(role="Market Research Analyst", ...)
|
|
writer = Agent(role="Technical Content Writer", ...)
|
|
|
|
# ❌ Avoid: Overlapping or vague roles
|
|
agent1 = Agent(role="General Assistant", ...)
|
|
agent2 = Agent(role="Helper", ...)
|
|
```
|
|
|
|
### 2. **Strategic Delegation Enabling**
|
|
```python
|
|
# ✅ Enable delegation for coordinators and generalists
|
|
lead_agent = Agent(
|
|
role="Content Lead",
|
|
allow_delegation=True, # Can delegate to specialists
|
|
...
|
|
)
|
|
|
|
# ✅ Disable for focused specialists (optional)
|
|
specialist_agent = Agent(
|
|
role="Data Analyst",
|
|
allow_delegation=False, # Focuses on core expertise
|
|
...
|
|
)
|
|
```
|
|
|
|
### 3. **Context Sharing**
|
|
```python
|
|
# ✅ Use context parameter for task dependencies
|
|
writing_task = Task(
|
|
description="Write article based on research",
|
|
agent=writer,
|
|
context=[research_task], # Shares research results
|
|
...
|
|
)
|
|
```
|
|
|
|
### 4. **Clear Task Descriptions**
|
|
```python
|
|
# ✅ Specific, actionable descriptions
|
|
Task(
|
|
description="""Research competitors in the AI chatbot space.
|
|
Focus on: pricing models, key features, target markets.
|
|
Provide data in a structured format.""",
|
|
...
|
|
)
|
|
|
|
# ❌ Vague descriptions that don't guide collaboration
|
|
Task(description="Do some research about chatbots", ...)
|
|
```
|
|
|
|
## Troubleshooting Collaboration
|
|
|
|
### Issue: Agents Not Collaborating
|
|
**Symptoms:** Agents work in isolation, no delegation occurs
|
|
```python
|
|
# ✅ Solution: Ensure delegation is enabled
|
|
agent = Agent(
|
|
role="...",
|
|
allow_delegation=True, # This is required!
|
|
...
|
|
)
|
|
```
|
|
|
|
### Issue: Too Much Back-and-Forth
|
|
**Symptoms:** Agents ask excessive questions, slow progress
|
|
```python
|
|
# ✅ Solution: Provide better context and specific roles
|
|
Task(
|
|
description="""Write a technical blog post about machine learning.
|
|
|
|
Context: Target audience is software developers with basic ML knowledge.
|
|
Length: 1200 words
|
|
Include: code examples, practical applications, best practices
|
|
|
|
If you need specific technical details, delegate research to the researcher.""",
|
|
...
|
|
)
|
|
```
|
|
|
|
### Issue: Delegation Loops
|
|
**Symptoms:** Agents delegate back and forth indefinitely
|
|
```python
|
|
# ✅ Solution: Clear hierarchy and responsibilities
|
|
manager = Agent(role="Manager", allow_delegation=True)
|
|
specialist1 = Agent(role="Specialist A", allow_delegation=False) # No re-delegation
|
|
specialist2 = Agent(role="Specialist B", allow_delegation=False)
|
|
```
|
|
|
|
## Advanced Collaboration Features
|
|
|
|
### Custom Collaboration Rules
|
|
```python
|
|
# Set specific collaboration guidelines in agent backstory
|
|
agent = Agent(
|
|
role="Senior Developer",
|
|
backstory="""You lead development projects and coordinate with team members.
|
|
|
|
Collaboration guidelines:
|
|
- Delegate research tasks to the Research Analyst
|
|
- Ask the Designer for UI/UX guidance
|
|
- Consult the QA Engineer for testing strategies
|
|
- Only escalate blocking issues to the Project Manager""",
|
|
allow_delegation=True
|
|
)
|
|
```
|
|
|
|
### Monitoring Collaboration
|
|
```python
|
|
def track_collaboration(output):
|
|
"""Track collaboration patterns"""
|
|
if "Delegate work to coworker" in output.raw:
|
|
print("🤝 Delegation occurred")
|
|
if "Ask question to coworker" in output.raw:
|
|
print("❓ Question asked")
|
|
|
|
crew = Crew(
|
|
agents=[...],
|
|
tasks=[...],
|
|
step_callback=track_collaboration, # Monitor collaboration
|
|
verbose=True
|
|
)
|
|
```
|
|
|
|
## Memory and Learning
|
|
|
|
Enable agents to remember past collaborations:
|
|
|
|
```python
|
|
agent = Agent(
|
|
role="Content Lead",
|
|
memory=True, # Remembers past interactions
|
|
allow_delegation=True,
|
|
verbose=True
|
|
)
|
|
```
|
|
|
|
With memory enabled, agents learn from previous collaborations and improve their delegation decisions over time.
|
|
|
|
## Next Steps
|
|
|
|
- **Try the examples**: Start with the basic collaboration example
|
|
- **Experiment with roles**: Test different agent role combinations
|
|
- **Monitor interactions**: Use `verbose=True` to see collaboration in action
|
|
- **Optimize task descriptions**: Clear tasks lead to better collaboration
|
|
- **Scale up**: Try hierarchical processes for complex projects
|
|
|
|
Collaboration transforms individual AI agents into powerful teams that can tackle complex, multi-faceted challenges together.
|