mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-04 06:29:22 +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>
This commit is contained in:
188
docs/edge/en/tools/integration/bedrockinvokeagenttool.mdx
Normal file
188
docs/edge/en/tools/integration/bedrockinvokeagenttool.mdx
Normal file
@@ -0,0 +1,188 @@
|
||||
---
|
||||
title: Bedrock Invoke Agent Tool
|
||||
description: Enables CrewAI agents to invoke Amazon Bedrock Agents and leverage their capabilities within your workflows
|
||||
icon: aws
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `BedrockInvokeAgentTool`
|
||||
|
||||
The `BedrockInvokeAgentTool` enables CrewAI agents to invoke Amazon Bedrock Agents and leverage their capabilities within your workflows.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
uv pip install 'crewai[tools]'
|
||||
```
|
||||
|
||||
## Requirements
|
||||
|
||||
- AWS credentials configured (either through environment variables or AWS CLI)
|
||||
- `boto3` and `python-dotenv` packages
|
||||
- Access to Amazon Bedrock Agents
|
||||
|
||||
## Usage
|
||||
|
||||
Here's how to use the tool with a CrewAI agent:
|
||||
|
||||
```python {2, 4-8}
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools.aws.bedrock.agents.invoke_agent_tool import BedrockInvokeAgentTool
|
||||
|
||||
# Initialize the tool
|
||||
agent_tool = BedrockInvokeAgentTool(
|
||||
agent_id="your-agent-id",
|
||||
agent_alias_id="your-agent-alias-id"
|
||||
)
|
||||
|
||||
# Create a CrewAI agent that uses the tool
|
||||
aws_expert = Agent(
|
||||
role='AWS Service Expert',
|
||||
goal='Help users understand AWS services and quotas',
|
||||
backstory='I am an expert in AWS services and can provide detailed information about them.',
|
||||
tools=[agent_tool],
|
||||
verbose=True
|
||||
)
|
||||
|
||||
# Create a task for the agent
|
||||
quota_task = Task(
|
||||
description="Find out the current service quotas for EC2 in us-west-2 and explain any recent changes.",
|
||||
agent=aws_expert
|
||||
)
|
||||
|
||||
# Create a crew with the agent
|
||||
crew = Crew(
|
||||
agents=[aws_expert],
|
||||
tasks=[quota_task],
|
||||
verbose=2
|
||||
)
|
||||
|
||||
# Run the crew
|
||||
result = crew.kickoff()
|
||||
print(result)
|
||||
```
|
||||
|
||||
## Tool Arguments
|
||||
|
||||
| Argument | Type | Required | Default | Description |
|
||||
|:---------|:-----|:---------|:--------|:------------|
|
||||
| **agent_id** | `str` | Yes | None | The unique identifier of the Bedrock agent |
|
||||
| **agent_alias_id** | `str` | Yes | None | The unique identifier of the agent alias |
|
||||
| **session_id** | `str` | No | timestamp | The unique identifier of the session |
|
||||
| **enable_trace** | `bool` | No | False | Whether to enable trace for debugging |
|
||||
| **end_session** | `bool` | No | False | Whether to end the session after invocation |
|
||||
| **description** | `str` | No | None | Custom description for the tool |
|
||||
|
||||
## Environment Variables
|
||||
|
||||
```bash
|
||||
BEDROCK_AGENT_ID=your-agent-id # Alternative to passing agent_id
|
||||
BEDROCK_AGENT_ALIAS_ID=your-agent-alias-id # Alternative to passing agent_alias_id
|
||||
AWS_REGION=your-aws-region # Defaults to us-west-2
|
||||
AWS_ACCESS_KEY_ID=your-access-key # Required for AWS authentication
|
||||
AWS_SECRET_ACCESS_KEY=your-secret-key # Required for AWS authentication
|
||||
```
|
||||
|
||||
## Advanced Usage
|
||||
|
||||
### Multi-Agent Workflow with Session Management
|
||||
|
||||
```python {2, 4-22}
|
||||
from crewai import Agent, Task, Crew, Process
|
||||
from crewai_tools.aws.bedrock.agents.invoke_agent_tool import BedrockInvokeAgentTool
|
||||
|
||||
# Initialize tools with session management
|
||||
initial_tool = BedrockInvokeAgentTool(
|
||||
agent_id="your-agent-id",
|
||||
agent_alias_id="your-agent-alias-id",
|
||||
session_id="custom-session-id"
|
||||
)
|
||||
|
||||
followup_tool = BedrockInvokeAgentTool(
|
||||
agent_id="your-agent-id",
|
||||
agent_alias_id="your-agent-alias-id",
|
||||
session_id="custom-session-id"
|
||||
)
|
||||
|
||||
final_tool = BedrockInvokeAgentTool(
|
||||
agent_id="your-agent-id",
|
||||
agent_alias_id="your-agent-alias-id",
|
||||
session_id="custom-session-id",
|
||||
end_session=True
|
||||
)
|
||||
|
||||
# Create agents for different stages
|
||||
researcher = Agent(
|
||||
role='AWS Service Researcher',
|
||||
goal='Gather information about AWS services',
|
||||
backstory='I am specialized in finding detailed AWS service information.',
|
||||
tools=[initial_tool]
|
||||
)
|
||||
|
||||
analyst = Agent(
|
||||
role='Service Compatibility Analyst',
|
||||
goal='Analyze service compatibility and requirements',
|
||||
backstory='I analyze AWS services for compatibility and integration possibilities.',
|
||||
tools=[followup_tool]
|
||||
)
|
||||
|
||||
summarizer = Agent(
|
||||
role='Technical Documentation Writer',
|
||||
goal='Create clear technical summaries',
|
||||
backstory='I specialize in creating clear, concise technical documentation.',
|
||||
tools=[final_tool]
|
||||
)
|
||||
|
||||
# Create tasks
|
||||
research_task = Task(
|
||||
description="Find all available AWS services in us-west-2 region.",
|
||||
agent=researcher
|
||||
)
|
||||
|
||||
analysis_task = Task(
|
||||
description="Analyze which services support IPv6 and their implementation requirements.",
|
||||
agent=analyst
|
||||
)
|
||||
|
||||
summary_task = Task(
|
||||
description="Create a summary of IPv6-compatible services and their key features.",
|
||||
agent=summarizer
|
||||
)
|
||||
|
||||
# Create a crew with the agents and tasks
|
||||
crew = Crew(
|
||||
agents=[researcher, analyst, summarizer],
|
||||
tasks=[research_task, analysis_task, summary_task],
|
||||
process=Process.sequential,
|
||||
verbose=2
|
||||
)
|
||||
|
||||
# Run the crew
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
## Use Cases
|
||||
|
||||
### Hybrid Multi-Agent Collaborations
|
||||
- Create workflows where CrewAI agents collaborate with managed Bedrock agents running as services in AWS
|
||||
- Enable scenarios where sensitive data processing happens within your AWS environment while other agents operate externally
|
||||
- Bridge on-premises CrewAI agents with cloud-based Bedrock agents for distributed intelligence workflows
|
||||
|
||||
### Data Sovereignty and Compliance
|
||||
- Keep data-sensitive agentic workflows within your AWS environment while allowing external CrewAI agents to orchestrate tasks
|
||||
- Maintain compliance with data residency requirements by processing sensitive information only within your AWS account
|
||||
- Enable secure multi-agent collaborations where some agents cannot access your organization's private data
|
||||
|
||||
### Seamless AWS Service Integration
|
||||
- Access any AWS service through Amazon Bedrock Actions without writing complex integration code
|
||||
- Enable CrewAI agents to interact with AWS services through natural language requests
|
||||
- Leverage pre-built Bedrock agent capabilities to interact with AWS services like Bedrock Knowledge Bases, Lambda, and more
|
||||
|
||||
### Scalable Hybrid Agent Architectures
|
||||
- Offload computationally intensive tasks to managed Bedrock agents while lightweight tasks run in CrewAI
|
||||
- Scale agent processing by distributing workloads between local CrewAI agents and cloud-based Bedrock agents
|
||||
|
||||
### Cross-Organizational Agent Collaboration
|
||||
- Enable secure collaboration between your organization's CrewAI agents and partner organizations' Bedrock agents
|
||||
- Create workflows where external expertise from Bedrock agents can be incorporated without exposing sensitive data
|
||||
- Build agent ecosystems that span organizational boundaries while maintaining security and data control
|
||||
276
docs/edge/en/tools/integration/crewaiautomationtool.mdx
Normal file
276
docs/edge/en/tools/integration/crewaiautomationtool.mdx
Normal file
@@ -0,0 +1,276 @@
|
||||
---
|
||||
title: CrewAI Run Automation Tool
|
||||
description: Enables CrewAI agents to invoke CrewAI Platform automations and leverage external crew services within your workflows.
|
||||
icon: robot
|
||||
---
|
||||
|
||||
# `InvokeCrewAIAutomationTool`
|
||||
|
||||
The `InvokeCrewAIAutomationTool` provides CrewAI Platform API integration with external crew services. This tool allows you to invoke and interact with CrewAI Platform automations from within your CrewAI agents, enabling seamless integration between different crew workflows.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
uv pip install 'crewai[tools]'
|
||||
```
|
||||
|
||||
## Requirements
|
||||
|
||||
- CrewAI Platform API access
|
||||
- Valid bearer token for authentication
|
||||
- Network access to CrewAI Platform automation endpoints
|
||||
|
||||
## Usage
|
||||
|
||||
Here's how to use the tool with a CrewAI agent:
|
||||
|
||||
```python {2, 4-9}
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import InvokeCrewAIAutomationTool
|
||||
|
||||
# Initialize the tool
|
||||
automation_tool = InvokeCrewAIAutomationTool(
|
||||
crew_api_url="https://data-analysis-crew-[...].crewai.com",
|
||||
crew_bearer_token="your_bearer_token_here",
|
||||
crew_name="Data Analysis Crew",
|
||||
crew_description="Analyzes data and generates insights"
|
||||
)
|
||||
|
||||
# Create a CrewAI agent that uses the tool
|
||||
automation_coordinator = Agent(
|
||||
role='Automation Coordinator',
|
||||
goal='Coordinate and execute automated crew tasks',
|
||||
backstory='I am an expert at leveraging automation tools to execute complex workflows.',
|
||||
tools=[automation_tool],
|
||||
verbose=True
|
||||
)
|
||||
|
||||
# Create a task for the agent
|
||||
analysis_task = Task(
|
||||
description="Execute data analysis automation and provide insights",
|
||||
agent=automation_coordinator,
|
||||
expected_output="Comprehensive data analysis report"
|
||||
)
|
||||
|
||||
# Create a crew with the agent
|
||||
crew = Crew(
|
||||
agents=[automation_coordinator],
|
||||
tasks=[analysis_task],
|
||||
verbose=2
|
||||
)
|
||||
|
||||
# Run the crew
|
||||
result = crew.kickoff()
|
||||
print(result)
|
||||
```
|
||||
|
||||
## Tool Arguments
|
||||
|
||||
| Argument | Type | Required | Default | Description |
|
||||
|:---------|:-----|:---------|:--------|:------------|
|
||||
| **crew_api_url** | `str` | Yes | None | Base URL of the CrewAI Platform automation API |
|
||||
| **crew_bearer_token** | `str` | Yes | None | Bearer token for API authentication |
|
||||
| **crew_name** | `str` | Yes | None | Name of the crew automation |
|
||||
| **crew_description** | `str` | Yes | None | Description of what the crew automation does |
|
||||
| **max_polling_time** | `int` | No | 600 | Maximum time in seconds to wait for task completion |
|
||||
| **crew_inputs** | `dict` | No | None | Dictionary defining custom input schema fields |
|
||||
|
||||
## Environment Variables
|
||||
|
||||
```bash
|
||||
CREWAI_API_URL=https://your-crew-automation.crewai.com # Alternative to passing crew_api_url
|
||||
CREWAI_BEARER_TOKEN=your_bearer_token_here # Alternative to passing crew_bearer_token
|
||||
```
|
||||
|
||||
## Advanced Usage
|
||||
|
||||
### Custom Input Schema with Dynamic Parameters
|
||||
|
||||
```python {2, 4-15}
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import InvokeCrewAIAutomationTool
|
||||
from pydantic import Field
|
||||
|
||||
# Define custom input schema
|
||||
custom_inputs = {
|
||||
"year": Field(..., description="Year to retrieve the report for (integer)"),
|
||||
"region": Field(default="global", description="Geographic region for analysis"),
|
||||
"format": Field(default="summary", description="Report format (summary, detailed, raw)")
|
||||
}
|
||||
|
||||
# Create tool with custom inputs
|
||||
market_research_tool = InvokeCrewAIAutomationTool(
|
||||
crew_api_url="https://state-of-ai-report-crew-[...].crewai.com",
|
||||
crew_bearer_token="your_bearer_token_here",
|
||||
crew_name="State of AI Report",
|
||||
crew_description="Retrieves a comprehensive report on state of AI for a given year and region",
|
||||
crew_inputs=custom_inputs,
|
||||
max_polling_time=15 * 60 # 15 minutes timeout
|
||||
)
|
||||
|
||||
# Create an agent with the tool
|
||||
research_agent = Agent(
|
||||
role="Research Coordinator",
|
||||
goal="Coordinate and execute market research tasks",
|
||||
backstory="You are an expert at coordinating research tasks and leveraging automation tools.",
|
||||
tools=[market_research_tool],
|
||||
verbose=True
|
||||
)
|
||||
|
||||
# Create and execute a task with custom parameters
|
||||
research_task = Task(
|
||||
description="Conduct market research on AI tools market for 2024 in North America with detailed format",
|
||||
agent=research_agent,
|
||||
expected_output="Comprehensive market research report"
|
||||
)
|
||||
|
||||
crew = Crew(
|
||||
agents=[research_agent],
|
||||
tasks=[research_task]
|
||||
)
|
||||
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
### Multi-Stage Automation Workflow
|
||||
|
||||
```python {2, 4-35}
|
||||
from crewai import Agent, Task, Crew, Process
|
||||
from crewai_tools import InvokeCrewAIAutomationTool
|
||||
|
||||
# Initialize different automation tools
|
||||
data_collection_tool = InvokeCrewAIAutomationTool(
|
||||
crew_api_url="https://data-collection-crew-[...].crewai.com",
|
||||
crew_bearer_token="your_bearer_token_here",
|
||||
crew_name="Data Collection Automation",
|
||||
crew_description="Collects and preprocesses raw data"
|
||||
)
|
||||
|
||||
analysis_tool = InvokeCrewAIAutomationTool(
|
||||
crew_api_url="https://analysis-crew-[...].crewai.com",
|
||||
crew_bearer_token="your_bearer_token_here",
|
||||
crew_name="Analysis Automation",
|
||||
crew_description="Performs advanced data analysis and modeling"
|
||||
)
|
||||
|
||||
reporting_tool = InvokeCrewAIAutomationTool(
|
||||
crew_api_url="https://reporting-crew-[...].crewai.com",
|
||||
crew_bearer_token="your_bearer_token_here",
|
||||
crew_name="Reporting Automation",
|
||||
crew_description="Generates comprehensive reports and visualizations"
|
||||
)
|
||||
|
||||
# Create specialized agents
|
||||
data_collector = Agent(
|
||||
role='Data Collection Specialist',
|
||||
goal='Gather and preprocess data from various sources',
|
||||
backstory='I specialize in collecting and cleaning data from multiple sources.',
|
||||
tools=[data_collection_tool]
|
||||
)
|
||||
|
||||
data_analyst = Agent(
|
||||
role='Data Analysis Expert',
|
||||
goal='Perform advanced analysis on collected data',
|
||||
backstory='I am an expert in statistical analysis and machine learning.',
|
||||
tools=[analysis_tool]
|
||||
)
|
||||
|
||||
report_generator = Agent(
|
||||
role='Report Generation Specialist',
|
||||
goal='Create comprehensive reports and visualizations',
|
||||
backstory='I excel at creating clear, actionable reports from complex data.',
|
||||
tools=[reporting_tool]
|
||||
)
|
||||
|
||||
# Create sequential tasks
|
||||
collection_task = Task(
|
||||
description="Collect market data for Q4 2024 analysis",
|
||||
agent=data_collector
|
||||
)
|
||||
|
||||
analysis_task = Task(
|
||||
description="Analyze collected data to identify trends and patterns",
|
||||
agent=data_analyst
|
||||
)
|
||||
|
||||
reporting_task = Task(
|
||||
description="Generate executive summary report with key insights and recommendations",
|
||||
agent=report_generator
|
||||
)
|
||||
|
||||
# Create a crew with sequential processing
|
||||
crew = Crew(
|
||||
agents=[data_collector, data_analyst, report_generator],
|
||||
tasks=[collection_task, analysis_task, reporting_task],
|
||||
process=Process.sequential,
|
||||
verbose=2
|
||||
)
|
||||
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
## Use Cases
|
||||
|
||||
### Distributed Crew Orchestration
|
||||
- Coordinate multiple specialized crew automations to handle complex, multi-stage workflows
|
||||
- Enable seamless handoffs between different automation services for comprehensive task execution
|
||||
- Scale processing by distributing workloads across multiple CrewAI Platform automations
|
||||
|
||||
### Cross-Platform Integration
|
||||
- Bridge CrewAI agents with CrewAI Platform automations for hybrid local-cloud workflows
|
||||
- Leverage specialized automations while maintaining local control and orchestration
|
||||
- Enable secure collaboration between local agents and cloud-based automation services
|
||||
|
||||
### Enterprise Automation Pipelines
|
||||
- Create enterprise-grade automation pipelines that combine local intelligence with cloud processing power
|
||||
- Implement complex business workflows that span multiple automation services
|
||||
- Enable scalable, repeatable processes for data analysis, reporting, and decision-making
|
||||
|
||||
### Dynamic Workflow Composition
|
||||
- Dynamically compose workflows by chaining different automation services based on task requirements
|
||||
- Enable adaptive processing where the choice of automation depends on data characteristics or business rules
|
||||
- Create flexible, reusable automation components that can be combined in various ways
|
||||
|
||||
### Specialized Domain Processing
|
||||
- Access domain-specific automations (financial analysis, legal research, technical documentation) from general-purpose agents
|
||||
- Leverage pre-built, specialized crew automations without rebuilding complex domain logic
|
||||
- Enable agents to access expert-level capabilities through targeted automation services
|
||||
|
||||
## Custom Input Schema
|
||||
|
||||
When defining `crew_inputs`, use Pydantic Field objects to specify the input parameters:
|
||||
|
||||
```python
|
||||
from pydantic import Field
|
||||
|
||||
crew_inputs = {
|
||||
"required_param": Field(..., description="This parameter is required"),
|
||||
"optional_param": Field(default="default_value", description="This parameter is optional"),
|
||||
"typed_param": Field(..., description="Integer parameter", ge=1, le=100) # With validation
|
||||
}
|
||||
```
|
||||
|
||||
## Error Handling
|
||||
|
||||
The tool provides comprehensive error handling for common scenarios:
|
||||
|
||||
- **API Connection Errors**: Network connectivity issues with CrewAI Platform
|
||||
- **Authentication Errors**: Invalid or expired bearer tokens
|
||||
- **Timeout Errors**: Tasks that exceed the maximum polling time
|
||||
- **Task Failures**: Crew automations that fail during execution
|
||||
- **Input Validation Errors**: Invalid parameters passed to automation endpoints
|
||||
|
||||
## API Endpoints
|
||||
|
||||
The tool interacts with two main API endpoints:
|
||||
|
||||
- `POST {crew_api_url}/kickoff`: Starts a new crew automation task
|
||||
- `GET {crew_api_url}/status/{crew_id}`: Checks the status of a running task
|
||||
|
||||
## Notes
|
||||
|
||||
- The tool automatically polls the status endpoint every second until completion or timeout
|
||||
- Successful tasks return the result directly, while failed tasks return error information
|
||||
- Bearer tokens should be kept secure and not hardcoded in production environments
|
||||
- Consider using environment variables for sensitive configuration like bearer tokens
|
||||
- Custom input schemas must be compatible with the target crew automation's expected parameters
|
||||
367
docs/edge/en/tools/integration/mergeagenthandlertool.mdx
Normal file
367
docs/edge/en/tools/integration/mergeagenthandlertool.mdx
Normal file
@@ -0,0 +1,367 @@
|
||||
---
|
||||
title: Merge Agent Handler Tool
|
||||
description: Enables CrewAI agents to securely access third-party integrations like Linear, GitHub, Slack, and more through Merge's Agent Handler platform
|
||||
icon: diagram-project
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
# `MergeAgentHandlerTool`
|
||||
|
||||
The `MergeAgentHandlerTool` enables CrewAI agents to securely access third-party integrations through [Merge's Agent Handler](https://www.merge.dev/products/merge-agent-handler) platform. Agent Handler provides pre-built, secure connectors to popular tools like Linear, GitHub, Slack, Notion, and hundreds more—all with built-in authentication, permissions, and monitoring.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
uv pip install 'crewai[tools]'
|
||||
```
|
||||
|
||||
## Requirements
|
||||
|
||||
- Merge Agent Handler account with a configured Tool Pack
|
||||
- Agent Handler API key
|
||||
- At least one registered user linked to your Tool Pack
|
||||
- Third-party integrations configured in your Tool Pack
|
||||
|
||||
## Getting Started with Agent Handler
|
||||
|
||||
1. **Sign up** for a Merge Agent Handler account at [ah.merge.dev/signup](https://ah.merge.dev/signup)
|
||||
2. **Create a Tool Pack** and configure the integrations you need
|
||||
3. **Register users** who will authenticate with the third-party services
|
||||
4. **Get your API key** from the Agent Handler dashboard
|
||||
5. **Set environment variable**: `export AGENT_HANDLER_API_KEY='your-key-here'`
|
||||
6. **Start building** with the MergeAgentHandlerTool in CrewAI
|
||||
|
||||
## Notes
|
||||
|
||||
- Tool Pack IDs and Registered User IDs can be found in your Agent Handler dashboard or created via API
|
||||
- The tool uses the Model Context Protocol (MCP) for communication with Agent Handler
|
||||
- Session IDs are automatically generated but can be customized for context persistence
|
||||
- All tool calls are logged and auditable through the Agent Handler platform
|
||||
- Tool parameters are dynamically discovered from the Agent Handler API and validated automatically
|
||||
|
||||
## Usage
|
||||
|
||||
### Single Tool Usage
|
||||
|
||||
Here's how to use a specific tool from your Tool Pack:
|
||||
|
||||
```python {2, 4-9}
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import MergeAgentHandlerTool
|
||||
|
||||
# Create a tool for Linear issue creation
|
||||
linear_create_tool = MergeAgentHandlerTool.from_tool_name(
|
||||
tool_name="linear__create_issue",
|
||||
tool_pack_id="134e0111-0f67-44f6-98f0-597000290bb3",
|
||||
registered_user_id="91b2b905-e866-40c8-8be2-efe53827a0aa"
|
||||
)
|
||||
|
||||
# Create a CrewAI agent that uses the tool
|
||||
project_manager = Agent(
|
||||
role='Project Manager',
|
||||
goal='Manage project tasks and issues efficiently',
|
||||
backstory='I am an expert at tracking project work and creating actionable tasks.',
|
||||
tools=[linear_create_tool],
|
||||
verbose=True
|
||||
)
|
||||
|
||||
# Create a task for the agent
|
||||
create_issue_task = Task(
|
||||
description="Create a new high-priority issue in Linear titled 'Implement user authentication' with a detailed description of the requirements.",
|
||||
agent=project_manager,
|
||||
expected_output="Confirmation that the issue was created with its ID"
|
||||
)
|
||||
|
||||
# Create a crew with the agent
|
||||
crew = Crew(
|
||||
agents=[project_manager],
|
||||
tasks=[create_issue_task],
|
||||
verbose=True
|
||||
)
|
||||
|
||||
# Run the crew
|
||||
result = crew.kickoff()
|
||||
print(result)
|
||||
```
|
||||
|
||||
### Loading Multiple Tools from a Tool Pack
|
||||
|
||||
You can load all available tools from your Tool Pack at once:
|
||||
|
||||
```python {2, 4-8}
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import MergeAgentHandlerTool
|
||||
|
||||
# Load all tools from the Tool Pack
|
||||
tools = MergeAgentHandlerTool.from_tool_pack(
|
||||
tool_pack_id="134e0111-0f67-44f6-98f0-597000290bb3",
|
||||
registered_user_id="91b2b905-e866-40c8-8be2-efe53827a0aa"
|
||||
)
|
||||
|
||||
# Create an agent with access to all tools
|
||||
automation_expert = Agent(
|
||||
role='Automation Expert',
|
||||
goal='Automate workflows across multiple platforms',
|
||||
backstory='I can work with any tool in the toolbox to get things done.',
|
||||
tools=tools,
|
||||
verbose=True
|
||||
)
|
||||
|
||||
automation_task = Task(
|
||||
description="Check for any high-priority issues in Linear and post a summary to Slack.",
|
||||
agent=automation_expert
|
||||
)
|
||||
|
||||
crew = Crew(
|
||||
agents=[automation_expert],
|
||||
tasks=[automation_task],
|
||||
verbose=True
|
||||
)
|
||||
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
### Loading Specific Tools Only
|
||||
|
||||
Load only the tools you need:
|
||||
|
||||
```python {2, 4-10}
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import MergeAgentHandlerTool
|
||||
|
||||
# Load specific tools from the Tool Pack
|
||||
selected_tools = MergeAgentHandlerTool.from_tool_pack(
|
||||
tool_pack_id="134e0111-0f67-44f6-98f0-597000290bb3",
|
||||
registered_user_id="91b2b905-e866-40c8-8be2-efe53827a0aa",
|
||||
tool_names=["linear__create_issue", "linear__get_issues", "slack__post_message"]
|
||||
)
|
||||
|
||||
developer_assistant = Agent(
|
||||
role='Developer Assistant',
|
||||
goal='Help developers track and communicate about their work',
|
||||
backstory='I help developers stay organized and keep the team informed.',
|
||||
tools=selected_tools,
|
||||
verbose=True
|
||||
)
|
||||
|
||||
daily_update_task = Task(
|
||||
description="Get all issues assigned to the current user in Linear and post a summary to the #dev-updates Slack channel.",
|
||||
agent=developer_assistant
|
||||
)
|
||||
|
||||
crew = Crew(
|
||||
agents=[developer_assistant],
|
||||
tasks=[daily_update_task],
|
||||
verbose=True
|
||||
)
|
||||
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
## Tool Arguments
|
||||
|
||||
### `from_tool_name()` Method
|
||||
|
||||
| Argument | Type | Required | Default | Description |
|
||||
|:---------|:-----|:---------|:--------|:------------|
|
||||
| **tool_name** | `str` | Yes | None | Name of the specific tool to use (e.g., "linear__create_issue") |
|
||||
| **tool_pack_id** | `str` | Yes | None | UUID of your Agent Handler Tool Pack |
|
||||
| **registered_user_id** | `str` | Yes | None | UUID or origin_id of the registered user |
|
||||
| **base_url** | `str` | No | "https://ah-api.merge.dev" | Base URL for Agent Handler API |
|
||||
| **session_id** | `str` | No | Auto-generated | MCP session ID for maintaining context |
|
||||
|
||||
### `from_tool_pack()` Method
|
||||
|
||||
| Argument | Type | Required | Default | Description |
|
||||
|:---------|:-----|:---------|:--------|:------------|
|
||||
| **tool_pack_id** | `str` | Yes | None | UUID of your Agent Handler Tool Pack |
|
||||
| **registered_user_id** | `str` | Yes | None | UUID or origin_id of the registered user |
|
||||
| **tool_names** | `list[str]` | No | None | Specific tool names to load. If None, loads all available tools |
|
||||
| **base_url** | `str` | No | "https://ah-api.merge.dev" | Base URL for Agent Handler API |
|
||||
|
||||
## Environment Variables
|
||||
|
||||
```bash
|
||||
AGENT_HANDLER_API_KEY=your_api_key_here # Required for authentication
|
||||
```
|
||||
|
||||
## Advanced Usage
|
||||
|
||||
### Multi-Agent Workflow with Different Tool Access
|
||||
|
||||
```python {2, 4-20}
|
||||
from crewai import Agent, Task, Crew, Process
|
||||
from crewai_tools import MergeAgentHandlerTool
|
||||
|
||||
# Create specialized tools for different agents
|
||||
github_tools = MergeAgentHandlerTool.from_tool_pack(
|
||||
tool_pack_id="134e0111-0f67-44f6-98f0-597000290bb3",
|
||||
registered_user_id="91b2b905-e866-40c8-8be2-efe53827a0aa",
|
||||
tool_names=["github__create_pull_request", "github__get_pull_requests"]
|
||||
)
|
||||
|
||||
linear_tools = MergeAgentHandlerTool.from_tool_pack(
|
||||
tool_pack_id="134e0111-0f67-44f6-98f0-597000290bb3",
|
||||
registered_user_id="91b2b905-e866-40c8-8be2-efe53827a0aa",
|
||||
tool_names=["linear__create_issue", "linear__update_issue"]
|
||||
)
|
||||
|
||||
slack_tool = MergeAgentHandlerTool.from_tool_name(
|
||||
tool_name="slack__post_message",
|
||||
tool_pack_id="134e0111-0f67-44f6-98f0-597000290bb3",
|
||||
registered_user_id="91b2b905-e866-40c8-8be2-efe53827a0aa"
|
||||
)
|
||||
|
||||
# Create specialized agents
|
||||
code_reviewer = Agent(
|
||||
role='Code Reviewer',
|
||||
goal='Review pull requests and ensure code quality',
|
||||
backstory='I am an expert at reviewing code changes and providing constructive feedback.',
|
||||
tools=github_tools
|
||||
)
|
||||
|
||||
task_manager = Agent(
|
||||
role='Task Manager',
|
||||
goal='Track and update project tasks based on code changes',
|
||||
backstory='I keep the project board up to date with the latest development progress.',
|
||||
tools=linear_tools
|
||||
)
|
||||
|
||||
communicator = Agent(
|
||||
role='Team Communicator',
|
||||
goal='Keep the team informed about important updates',
|
||||
backstory='I make sure everyone knows what is happening in the project.',
|
||||
tools=[slack_tool]
|
||||
)
|
||||
|
||||
# Create sequential tasks
|
||||
review_task = Task(
|
||||
description="Review all open pull requests in the 'api-service' repository and identify any that need attention.",
|
||||
agent=code_reviewer,
|
||||
expected_output="List of pull requests that need review or have issues"
|
||||
)
|
||||
|
||||
update_task = Task(
|
||||
description="Update Linear issues based on the pull request review findings. Mark completed PRs as done.",
|
||||
agent=task_manager,
|
||||
expected_output="Summary of updated Linear issues"
|
||||
)
|
||||
|
||||
notify_task = Task(
|
||||
description="Post a summary of today's code review and task updates to the #engineering Slack channel.",
|
||||
agent=communicator,
|
||||
expected_output="Confirmation that the message was posted"
|
||||
)
|
||||
|
||||
# Create a crew with sequential processing
|
||||
crew = Crew(
|
||||
agents=[code_reviewer, task_manager, communicator],
|
||||
tasks=[review_task, update_task, notify_task],
|
||||
process=Process.sequential,
|
||||
verbose=True
|
||||
)
|
||||
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
### Custom Session Management
|
||||
|
||||
Maintain context across multiple tool calls using session IDs:
|
||||
|
||||
```python {2, 4-17}
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import MergeAgentHandlerTool
|
||||
|
||||
# Create tools with the same session ID to maintain context
|
||||
session_id = "project-sprint-planning-2024"
|
||||
|
||||
create_tool = MergeAgentHandlerTool(
|
||||
name="linear_create_issue",
|
||||
description="Creates a new issue in Linear",
|
||||
tool_name="linear__create_issue",
|
||||
tool_pack_id="134e0111-0f67-44f6-98f0-597000290bb3",
|
||||
registered_user_id="91b2b905-e866-40c8-8be2-efe53827a0aa",
|
||||
session_id=session_id
|
||||
)
|
||||
|
||||
update_tool = MergeAgentHandlerTool(
|
||||
name="linear_update_issue",
|
||||
description="Updates an existing issue in Linear",
|
||||
tool_name="linear__update_issue",
|
||||
tool_pack_id="134e0111-0f67-44f6-98f0-597000290bb3",
|
||||
registered_user_id="91b2b905-e866-40c8-8be2-efe53827a0aa",
|
||||
session_id=session_id
|
||||
)
|
||||
|
||||
sprint_planner = Agent(
|
||||
role='Sprint Planner',
|
||||
goal='Plan and organize sprint tasks',
|
||||
backstory='I help teams plan effective sprints with well-defined tasks.',
|
||||
tools=[create_tool, update_tool],
|
||||
verbose=True
|
||||
)
|
||||
|
||||
planning_task = Task(
|
||||
description="Create 5 sprint tasks for the authentication feature and set their priorities based on dependencies.",
|
||||
agent=sprint_planner
|
||||
)
|
||||
|
||||
crew = Crew(
|
||||
agents=[sprint_planner],
|
||||
tasks=[planning_task],
|
||||
verbose=True
|
||||
)
|
||||
|
||||
result = crew.kickoff()
|
||||
```
|
||||
|
||||
## Use Cases
|
||||
|
||||
### Unified Integration Access
|
||||
- Access hundreds of third-party tools through a single unified API without managing multiple SDKs
|
||||
- Enable agents to work with Linear, GitHub, Slack, Notion, Jira, Asana, and more from one integration point
|
||||
- Reduce integration complexity by letting Agent Handler manage authentication and API versioning
|
||||
|
||||
### Secure Enterprise Workflows
|
||||
- Leverage built-in authentication and permission management for all third-party integrations
|
||||
- Maintain enterprise security standards with centralized access control and audit logging
|
||||
- Enable agents to access company tools without exposing API keys or credentials in code
|
||||
|
||||
### Cross-Platform Automation
|
||||
- Build workflows that span multiple platforms (e.g., create GitHub issues from Linear tasks, sync Notion pages to Slack)
|
||||
- Enable seamless data flow between different tools in your tech stack
|
||||
- Create intelligent automation that understands context across different platforms
|
||||
|
||||
### Dynamic Tool Discovery
|
||||
- Load all available tools at runtime without hardcoding integration logic
|
||||
- Enable agents to discover and use new tools as they're added to your Tool Pack
|
||||
- Build flexible agents that can adapt to changing tool availability
|
||||
|
||||
### User-Specific Tool Access
|
||||
- Different users can have different tool permissions and access levels
|
||||
- Enable multi-tenant workflows where agents act on behalf of specific users
|
||||
- Maintain proper attribution and permissions for all tool actions
|
||||
|
||||
## Available Integrations
|
||||
|
||||
Merge Agent Handler supports hundreds of integrations across multiple categories:
|
||||
|
||||
- **Project Management**: Linear, Jira, Asana, Monday.com, ClickUp
|
||||
- **Code Management**: GitHub, GitLab, Bitbucket
|
||||
- **Communication**: Slack, Microsoft Teams, Discord
|
||||
- **Documentation**: Notion, Confluence, Google Docs
|
||||
- **CRM**: Salesforce, HubSpot, Pipedrive
|
||||
- **And many more...**
|
||||
|
||||
Visit the [Merge Agent Handler documentation](https://docs.ah.merge.dev/) for a complete list of available integrations.
|
||||
|
||||
## Error Handling
|
||||
|
||||
The tool provides comprehensive error handling:
|
||||
|
||||
- **Authentication Errors**: Invalid or missing API keys
|
||||
- **Permission Errors**: User lacks permission for the requested action
|
||||
- **API Errors**: Issues communicating with Agent Handler or third-party services
|
||||
- **Validation Errors**: Invalid parameters passed to tool methods
|
||||
|
||||
All errors are wrapped in `MergeAgentHandlerToolError` for consistent error handling.
|
||||
76
docs/edge/en/tools/integration/overview.mdx
Normal file
76
docs/edge/en/tools/integration/overview.mdx
Normal file
@@ -0,0 +1,76 @@
|
||||
---
|
||||
title: "Overview"
|
||||
description: "Connect CrewAI agents with external automations and managed AI services"
|
||||
icon: "face-smile"
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
Integration tools let your agents hand off work to other automation platforms and managed AI services. Use them when a workflow needs to invoke an existing CrewAI deployment or delegate specialised tasks to providers such as Amazon Bedrock.
|
||||
|
||||
## **Available Tools**
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Merge Agent Handler Tool" icon="diagram-project" href="/en/tools/integration/mergeagenthandlertool">
|
||||
Securely access hundreds of third-party tools like Linear, GitHub, Slack, and more through Merge's unified API.
|
||||
</Card>
|
||||
|
||||
<Card title="CrewAI Run Automation Tool" icon="robot" href="/en/tools/integration/crewaiautomationtool">
|
||||
Invoke live CrewAI Platform automations, pass custom inputs, and poll for results directly from your agent.
|
||||
</Card>
|
||||
|
||||
<Card title="Bedrock Invoke Agent Tool" icon="aws" href="/en/tools/integration/bedrockinvokeagenttool">
|
||||
Call Amazon Bedrock Agents from your crews, reuse AWS guardrails, and stream responses back into the workflow.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## **Common Use Cases**
|
||||
|
||||
- **Chain automations**: Kick off an existing CrewAI deployment from within another crew or flow
|
||||
- **Enterprise hand-off**: Route tasks to Bedrock Agents that already encapsulate company logic and guardrails
|
||||
- **Hybrid workflows**: Combine CrewAI reasoning with downstream systems that expose their own agent APIs
|
||||
- **Long-running jobs**: Poll external automations and merge the final results back into the current run
|
||||
|
||||
## **Quick Start Example**
|
||||
|
||||
```python
|
||||
from crewai import Agent, Task, Crew
|
||||
from crewai_tools import InvokeCrewAIAutomationTool
|
||||
from crewai_tools.aws.bedrock.agents.invoke_agent_tool import BedrockInvokeAgentTool
|
||||
|
||||
# External automation
|
||||
analysis_automation = InvokeCrewAIAutomationTool(
|
||||
crew_api_url="https://analysis-crew.acme.crewai.com",
|
||||
crew_bearer_token="YOUR_BEARER_TOKEN",
|
||||
crew_name="Analysis Automation",
|
||||
crew_description="Runs the production-grade analysis pipeline",
|
||||
)
|
||||
|
||||
# Managed agent on Bedrock
|
||||
knowledge_router = BedrockInvokeAgentTool(
|
||||
agent_id="bedrock-agent-id",
|
||||
agent_alias_id="prod",
|
||||
)
|
||||
|
||||
automation_strategist = Agent(
|
||||
role="Automation Strategist",
|
||||
goal="Orchestrate external automations and summarise their output",
|
||||
backstory="You coordinate enterprise workflows and know when to delegate tasks to specialised services.",
|
||||
tools=[analysis_automation, knowledge_router],
|
||||
verbose=True,
|
||||
)
|
||||
|
||||
execute_playbook = Task(
|
||||
description="Run the analysis automation and ask the Bedrock agent for executive talking points.",
|
||||
agent=automation_strategist,
|
||||
)
|
||||
|
||||
Crew(agents=[automation_strategist], tasks=[execute_playbook]).kickoff()
|
||||
```
|
||||
|
||||
## **Best Practices**
|
||||
|
||||
- **Secure credentials**: Store API keys and bearer tokens in environment variables or a secrets manager
|
||||
- **Plan for latency**: External automations may take longer—set appropriate polling intervals and timeouts
|
||||
- **Reuse sessions**: Bedrock Agents support session IDs so you can maintain context across multiple tool calls
|
||||
- **Validate responses**: Normalise remote output (JSON, text, status codes) before forwarding it to downstream tasks
|
||||
- **Monitor usage**: Track audit logs in CrewAI Platform or AWS CloudWatch to stay ahead of quota limits and failures
|
||||
Reference in New Issue
Block a user