mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-05 06:59:23 +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>
258 lines
6.8 KiB
Plaintext
258 lines
6.8 KiB
Plaintext
---
|
||
title: "Ferramentas & Integrações"
|
||
description: "Conecte apps externos e gerencie ferramentas internas que seus agentes podem usar."
|
||
icon: "wrench"
|
||
mode: "wide"
|
||
---
|
||
|
||
## Visão geral
|
||
|
||
Ferramentas & Integrações é o hub central para conectar aplicações de terceiros e gerenciar ferramentas internas que seus agentes podem usar em tempo de execução.
|
||
|
||
<Frame>
|
||

|
||
</Frame>
|
||
|
||
## Explorar
|
||
|
||
<Tabs>
|
||
<Tab title="Integrações" icon="plug">
|
||
|
||
## Aplicativos para Agentes (Integrações)
|
||
|
||
Conecte aplicações empresariais (por exemplo, Gmail, Google Drive, HubSpot, Slack) via OAuth para habilitar ações de agentes.
|
||
|
||
{" "}
|
||
<Steps>
|
||
<Step title="Conectar">
|
||
Clique em <b>Conectar</b> no app desejado e conclua o OAuth.
|
||
</Step>
|
||
<Step title="Configurar">
|
||
Ajuste escopos, gatilhos e ações disponíveis conforme necessário.
|
||
</Step>
|
||
<Step title="Usar em Agentes">
|
||
Os serviços conectados ficam disponíveis como ferramentas para seus agentes.
|
||
</Step>
|
||
</Steps>
|
||
|
||
{" "}
|
||
<Frame></Frame>
|
||
|
||
### Conectar sua conta
|
||
|
||
1. Acesse <Link href="https://app.crewai.com/crewai_plus/connectors">Integrações</Link>
|
||
2. Clique em <b>Conectar</b> no serviço desejado
|
||
3. Conclua o fluxo OAuth e conceda os escopos
|
||
4. Copie seu Token Enterprise em <Link href="https://app.crewai.com/crewai_plus/settings/integrations">Configurações de Integração</Link>
|
||
|
||
{" "}
|
||
<Frame>
|
||

|
||
</Frame>
|
||
|
||
### Instalar ferramentas de integração
|
||
|
||
Para usar as integrações localmente, instale a versão mais recente do pacote `crewai-tools`.
|
||
|
||
```bash
|
||
uv add crewai-tools
|
||
```
|
||
|
||
### Configuração de variável de ambiente
|
||
|
||
{" "}
|
||
<Note>
|
||
Para usar integrações com `Agent(apps=[])`, você deve definir a variável de
|
||
ambiente `CREWAI_PLATFORM_INTEGRATION_TOKEN` com seu Enterprise Token.
|
||
</Note>
|
||
|
||
```bash
|
||
export CREWAI_PLATFORM_INTEGRATION_TOKEN="seu_enterprise_token"
|
||
```
|
||
|
||
Ou adicione ao seu arquivo `.env`:
|
||
|
||
```
|
||
CREWAI_PLATFORM_INTEGRATION_TOKEN=seu_enterprise_token
|
||
```
|
||
|
||
### Exemplo de uso
|
||
|
||
{" "}
|
||
<Tip>
|
||
Use a nova abordagem simplificada para integrar aplicativos empresariais.
|
||
Simplesmente especifique o aplicativo e suas ações diretamente na configuração
|
||
do Agent.
|
||
</Tip>
|
||
|
||
```python
|
||
from crewai import Agent, Task, Crew
|
||
|
||
# Crie um agente com capacidades do Gmail
|
||
email_agent = Agent(
|
||
role="Gerente de Email",
|
||
goal="Gerenciar e organizar comunicações por email",
|
||
backstory="Assistente de IA especializado em gestão de emails",
|
||
apps=['gmail', 'gmail/send_email'] # Usando nome canônico 'gmail'
|
||
)
|
||
|
||
email_task = Task(
|
||
description="Criar e enviar follow-up para john@example.com sobre a atualização do projeto",
|
||
agent=email_agent,
|
||
expected_output="Confirmação de envio do email com sucesso"
|
||
)
|
||
|
||
crew = Crew(agents=[email_agent], tasks=[email_task])
|
||
crew.kickoff()
|
||
```
|
||
|
||
### Filtrando ferramentas
|
||
|
||
```python
|
||
from crewai import Agent, Task, Crew
|
||
|
||
# Crie agente com ações específicas do Gmail apenas
|
||
gmail_agent = Agent(
|
||
role="Gerente de Gmail",
|
||
goal="Gerenciar comunicações e notificações no Gmail",
|
||
backstory="Assistente de IA para coordenação de emails",
|
||
apps=['gmail/fetch_emails'] # Usando nome canônico com ação específica
|
||
)
|
||
|
||
notification_task = Task(
|
||
description="Encontrar o email de john@example.com",
|
||
agent=gmail_agent,
|
||
expected_output="Email encontrado de john@example.com"
|
||
)
|
||
|
||
crew = Crew(agents=[gmail_agent], tasks=[notification_task])
|
||
```
|
||
|
||
Em um crew implantado, você pode especificar quais ações ficam disponíveis em cada integração na página de configurações do serviço.
|
||
|
||
{" "}
|
||
<Frame>
|
||

|
||
</Frame>
|
||
|
||
### Implantações com escopo (organizações multiusuário)
|
||
|
||
Você pode escopar cada integração para um usuário específico (por exemplo, usar a conta Gmail de um usuário).
|
||
|
||
{" "}
|
||
<Tip>
|
||
Útil quando diferentes equipes/usuários precisam manter o acesso a dados
|
||
isolado.
|
||
</Tip>
|
||
|
||
Use `user_bearer_token` para escopar a autenticação ao usuário solicitante. Se o usuário não estiver logado, o crew não usará integrações conectadas; caso contrário, usa o token padrão configurado na implantação.
|
||
|
||
{" "}
|
||
<Frame></Frame>
|
||
|
||
{" "}
|
||
<div id="catalog"></div>
|
||
### Catálogo
|
||
|
||
#### Comunicação & Colaboração
|
||
|
||
- Gmail — Gerenciamento de emails e rascunhos
|
||
- Slack — Notificações e alertas do workspace
|
||
- Microsoft — Integração com Office 365 e Teams
|
||
|
||
#### Gestão de Projetos
|
||
|
||
- Jira — Rastreamento de issues e projetos
|
||
- ClickUp — Gestão de tarefas e produtividade
|
||
- Asana — Coordenação de tarefas de equipe
|
||
- Notion — Páginas e bancos de dados
|
||
- Linear — Gestão de bugs e projetos de software
|
||
- GitHub — Repositórios e issues
|
||
|
||
#### CRM
|
||
|
||
- Salesforce — Contas e oportunidades
|
||
- HubSpot — Pipeline de vendas e contatos
|
||
- Zendesk — Tickets de suporte
|
||
|
||
#### Negócios & Finanças
|
||
|
||
- Stripe — Pagamentos e clientes
|
||
- Shopify — E‑commerce e produtos
|
||
|
||
#### Produtividade & Armazenamento
|
||
|
||
- Google Sheets — Sincronização de planilhas
|
||
- Google Calendar — Eventos e agenda
|
||
- Box — Armazenamento de arquivos
|
||
|
||
…e mais por vir!
|
||
|
||
</Tab>
|
||
<Tab title="Ferramentas Internas" icon="toolbox">
|
||
|
||
## Ferramentas Internas
|
||
|
||
Crie ferramentas localmente, publique no Repositório de Ferramentas da CrewAI AMP e use nos seus agentes.
|
||
|
||
{" "}
|
||
<Tip>
|
||
Antes de executar os comandos abaixo, faça login na sua conta CrewAI AMP:
|
||
```bash crewai login ```
|
||
</Tip>
|
||
|
||
{" "}
|
||
<Frame>
|
||

|
||
</Frame>
|
||
|
||
{" "}
|
||
<Steps>
|
||
<Step title="Criar">
|
||
Criar uma nova ferramenta localmente. ```bash crewai tool create your-tool```
|
||
</Step>
|
||
<Step title="Publicar">
|
||
Publicar a ferramenta no Repositório de Ferramentas. ```bash crewai tool
|
||
publish ```
|
||
</Step>
|
||
<Step title="Instalar">
|
||
Instalar a ferramenta do Repositório de Ferramentas. ```bash crewai tool
|
||
install your-tool ```
|
||
</Step>
|
||
</Steps>
|
||
|
||
Gerenciar:
|
||
|
||
- Nome e descrição
|
||
- Visibilidade (Privado / Público)
|
||
- Variáveis de ambiente necessárias
|
||
- Histórico de versões e downloads
|
||
- Acesso por equipe e função
|
||
|
||
{" "}
|
||
<Frame>
|
||

|
||
</Frame>
|
||
|
||
</Tab>
|
||
</Tabs>
|
||
|
||
## Relacionados
|
||
|
||
<CardGroup cols={2}>
|
||
<Card
|
||
title="Repositório de Ferramentas"
|
||
href="/pt-BR/enterprise/guides/tool-repository"
|
||
icon="toolbox"
|
||
>
|
||
Publique e instale ferramentas para ampliar as capacidades dos seus crews.
|
||
</Card>
|
||
<Card
|
||
title="Automação com Webhook"
|
||
href="/pt-BR/enterprise/guides/webhook-automation"
|
||
icon="bolt"
|
||
>
|
||
Automatize fluxos e integre com plataformas e serviços externos.
|
||
</Card>
|
||
</CardGroup>
|