mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 13:18:10 +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>
189 lines
6.3 KiB
Plaintext
189 lines
6.3 KiB
Plaintext
---
|
|
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
|