mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-03 14:09:24 +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>
263 lines
6.7 KiB
Plaintext
263 lines
6.7 KiB
Plaintext
---
|
||
title: Tools & Integrations
|
||
description: "Connect external apps and manage internal tools your agents can use."
|
||
icon: "wrench"
|
||
mode: "wide"
|
||
---
|
||
|
||
## Overview
|
||
|
||
Tools & Integrations is the central hub for connecting third‑party apps and managing internal tools that your agents can use at runtime.
|
||
|
||
<Frame>
|
||

|
||
</Frame>
|
||
|
||
## Explore
|
||
|
||
<Tabs>
|
||
<Tab title="Integrations" icon="plug">
|
||
|
||
## Agent Apps (Integrations)
|
||
|
||
Connect enterprise‑grade applications (e.g., Gmail, Google Drive, HubSpot, Slack) via OAuth to enable agent actions.
|
||
|
||
{" "}
|
||
<Steps>
|
||
<Step title="Connect">
|
||
Click <b>Connect</b> on an app and complete OAuth.
|
||
</Step>
|
||
<Step title="Configure">
|
||
Optionally adjust scopes, triggers, and action availability.
|
||
</Step>
|
||
<Step title="Use in Agents">
|
||
Connected services become available as tools for your agents.
|
||
</Step>
|
||
</Steps>
|
||
|
||
{" "}
|
||
<Frame></Frame>
|
||
|
||
### Connect your Account
|
||
|
||
1. Go to <Link href="https://app.crewai.com/crewai_plus/connectors">Integrations</Link>
|
||
2. Click <b>Connect</b> on the desired service
|
||
3. Complete the OAuth flow and grant scopes
|
||
4. Copy your Enterprise Token from <Link href="https://app.crewai.com/crewai_plus/settings/integrations">Integration Settings</Link>
|
||
|
||
{" "}
|
||
<Frame>
|
||

|
||
</Frame>
|
||
|
||
### Install Integration Tools
|
||
|
||
To use the integrations locally, you need to install the latest `crewai-tools` package.
|
||
|
||
```bash
|
||
uv add crewai-tools
|
||
```
|
||
|
||
### Environment Variable Setup
|
||
|
||
{" "}
|
||
<Note>
|
||
To use integrations with `Agent(apps=[])`, you must set the
|
||
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
|
||
Token.
|
||
</Note>
|
||
|
||
```bash
|
||
export CREWAI_PLATFORM_INTEGRATION_TOKEN="your_enterprise_token"
|
||
```
|
||
|
||
Or add it to your `.env` file:
|
||
|
||
```
|
||
CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
|
||
```
|
||
|
||
### Usage Example
|
||
|
||
{" "}
|
||
<Tip>
|
||
Use the new streamlined approach to integrate enterprise apps. Simply specify
|
||
the app and its actions directly in the Agent configuration.
|
||
</Tip>
|
||
|
||
```python
|
||
from crewai import Agent, Task, Crew
|
||
|
||
# Create an agent with Gmail capabilities
|
||
email_agent = Agent(
|
||
role="Email Manager",
|
||
goal="Manage and organize email communications",
|
||
backstory="An AI assistant specialized in email management and communication.",
|
||
apps=['gmail', 'gmail/send_email'] # Using canonical name 'gmail'
|
||
)
|
||
|
||
# Task to send an email
|
||
email_task = Task(
|
||
description="Draft and send a follow-up email to john@example.com about the project update",
|
||
agent=email_agent,
|
||
expected_output="Confirmation that email was sent successfully"
|
||
)
|
||
|
||
# Run the task
|
||
crew = Crew(
|
||
agents=[email_agent],
|
||
tasks=[email_task]
|
||
)
|
||
|
||
# Run the crew
|
||
crew.kickoff()
|
||
```
|
||
|
||
### Filtering Tools
|
||
|
||
```python
|
||
from crewai import Agent, Task, Crew
|
||
|
||
# Create agent with specific Gmail actions only
|
||
gmail_agent = Agent(
|
||
role="Gmail Manager",
|
||
goal="Manage gmail communications and notifications",
|
||
backstory="An AI assistant that helps coordinate gmail communications.",
|
||
apps=['gmail/fetch_emails'] # Using canonical name with specific action
|
||
)
|
||
|
||
notification_task = Task(
|
||
description="Find the email from john@example.com",
|
||
agent=gmail_agent,
|
||
expected_output="Email found from john@example.com"
|
||
)
|
||
|
||
crew = Crew(
|
||
agents=[gmail_agent],
|
||
tasks=[notification_task]
|
||
)
|
||
```
|
||
|
||
On a deployed crew, you can specify which actions are available for each integration from the service settings page.
|
||
|
||
{" "}
|
||
<Frame>
|
||

|
||
</Frame>
|
||
|
||
### Scoped Deployments (multi‑user orgs)
|
||
|
||
You can scope each integration to a specific user. For example, a crew that connects to Google can use a specific user’s Gmail account.
|
||
|
||
{" "}
|
||
<Tip>Useful when different teams/users must keep data access separated.</Tip>
|
||
|
||
Use the `user_bearer_token` to scope authentication to the requesting user. If the user isn’t logged in, the crew won’t use connected integrations. Otherwise it falls back to the default bearer token configured for the deployment.
|
||
|
||
{" "}
|
||
<Frame></Frame>
|
||
|
||
{" "}
|
||
<div id="catalog"></div>
|
||
### Catalog
|
||
|
||
#### Communication & Collaboration
|
||
|
||
- Gmail — Manage emails and drafts
|
||
- Slack — Workspace notifications and alerts
|
||
- Microsoft — Office 365 and Teams integration
|
||
|
||
#### Project Management
|
||
|
||
- Jira — Issue tracking and project management
|
||
- ClickUp — Task and productivity management
|
||
- Asana — Team task and project coordination
|
||
- Notion — Page and database management
|
||
- Linear — Software project and bug tracking
|
||
- GitHub — Repository and issue management
|
||
|
||
#### Customer Relationship Management
|
||
|
||
- Salesforce — CRM account and opportunity management
|
||
- HubSpot — Sales pipeline and contact management
|
||
- Zendesk — Customer support ticket management
|
||
|
||
#### Business & Finance
|
||
|
||
- Stripe — Payment processing and customer management
|
||
- Shopify — E‑commerce store and product management
|
||
|
||
#### Productivity & Storage
|
||
|
||
- Google Sheets — Spreadsheet data synchronization
|
||
- Google Calendar — Event and schedule management
|
||
- Box — File storage and document management
|
||
|
||
…and more to come!
|
||
|
||
</Tab>
|
||
<Tab title="Internal Tools" icon="toolbox">
|
||
|
||
## Internal Tools
|
||
|
||
Create custom tools locally, publish them on CrewAI AMP Tool Repository and use them in your agents.
|
||
|
||
{" "}
|
||
<Tip>
|
||
Before running the commands below, make sure you log in to your CrewAI AMP
|
||
account by running this command: ```bash crewai login ```
|
||
</Tip>
|
||
|
||
{" "}
|
||
<Frame>
|
||

|
||
</Frame>
|
||
|
||
{" "}
|
||
<Steps>
|
||
<Step title="Create">
|
||
Create a new tool locally. ```bash crewai tool create your-tool ```
|
||
</Step>
|
||
<Step title="Publish">
|
||
Publish the tool to the CrewAI AMP Tool Repository. ```bash crewai tool
|
||
publish ```
|
||
</Step>
|
||
<Step title="Install">
|
||
Install the tool from the CrewAI AMP Tool Repository. ```bash crewai tool
|
||
install your-tool ```
|
||
</Step>
|
||
</Steps>
|
||
|
||
Manage:
|
||
|
||
- Name and description
|
||
- Visibility (Private / Public)
|
||
- Required environment variables
|
||
- Version history and downloads
|
||
- Team and role access
|
||
|
||
{" "}
|
||
<Frame></Frame>
|
||
|
||
</Tab>
|
||
</Tabs>
|
||
|
||
## Related
|
||
|
||
<CardGroup cols={2}>
|
||
<Card
|
||
title="Tool Repository"
|
||
href="/en/enterprise/guides/tool-repository#tool-repository"
|
||
icon="toolbox"
|
||
>
|
||
Create, publish, and version custom tools for your organization.
|
||
</Card>
|
||
<Card
|
||
title="Webhook Automation"
|
||
href="/en/enterprise/guides/webhook-automation"
|
||
icon="bolt"
|
||
>
|
||
Automate workflows and integrate with external platforms and services.
|
||
</Card>
|
||
</CardGroup>
|