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>
235 lines
7.3 KiB
Plaintext
235 lines
7.3 KiB
Plaintext
---
|
|
title: Integração DSL MCP
|
|
description: Aprenda a usar a sintaxe DSL simples do CrewAI para integrar servidores MCP diretamente com seus agentes usando o campo mcps.
|
|
icon: code
|
|
mode: "wide"
|
|
---
|
|
|
|
## Visão Geral
|
|
|
|
A integração DSL (Domain Specific Language) MCP do CrewAI oferece a **forma mais simples** de conectar seus agentes aos servidores MCP (Model Context Protocol). Basta adicionar um campo `mcps` ao seu agente e o CrewAI cuida de toda a complexidade automaticamente.
|
|
|
|
<Info>
|
|
Esta é a **abordagem recomendada** para a maioria dos casos de uso de MCP.
|
|
Para cenários avançados que requerem gerenciamento manual de conexão, veja
|
|
[MCPServerAdapter](/pt-BR/mcp/overview#advanced-mcpserveradapter).
|
|
</Info>
|
|
|
|
## Uso Básico
|
|
|
|
Adicione servidores MCP ao seu agente usando o campo `mcps`:
|
|
|
|
```python
|
|
from crewai import Agent
|
|
|
|
agent = Agent(
|
|
role="Assistente de Pesquisa",
|
|
goal="Ajudar com tarefas de pesquisa e análise",
|
|
backstory="Assistente especialista com acesso a ferramentas avançadas de pesquisa",
|
|
mcps=[
|
|
"https://mcp.exa.ai/mcp?api_key=sua_chave&profile=pesquisa"
|
|
]
|
|
)
|
|
|
|
# As ferramentas MCP agora estão automaticamente disponíveis!
|
|
# Não é necessário gerenciamento manual de conexão ou configuração de ferramentas
|
|
```
|
|
|
|
## Formatos de Referência Suportados
|
|
|
|
### Servidores MCP Remotos Externos
|
|
|
|
```python
|
|
# Servidor HTTPS básico
|
|
"https://api.example.com/mcp"
|
|
|
|
# Servidor com autenticação
|
|
"https://mcp.exa.ai/mcp?api_key=sua_chave&profile=seu_perfil"
|
|
|
|
# Servidor com caminho personalizado
|
|
"https://services.company.com/api/v1/mcp"
|
|
```
|
|
|
|
### Seleção de Ferramentas Específicas
|
|
|
|
Use a sintaxe `#` para selecionar ferramentas específicas de um servidor:
|
|
|
|
```python
|
|
# Obter apenas a ferramenta de previsão do servidor meteorológico
|
|
"https://weather.api.com/mcp#get_forecast"
|
|
|
|
# Obter apenas a ferramenta de busca do Exa
|
|
"https://mcp.exa.ai/mcp?api_key=sua_chave#web_search_exa"
|
|
```
|
|
|
|
### Integrações MCP Conectadas
|
|
|
|
Conecte servidores MCP do catálogo CrewAI ou traga os seus próprios. Uma vez conectados em sua conta, referencie-os pelo slug:
|
|
|
|
```python
|
|
# MCP conectado com todas as ferramentas
|
|
"snowflake"
|
|
|
|
# Ferramenta específica de um MCP conectado
|
|
"stripe#list_invoices"
|
|
|
|
# Múltiplos MCPs conectados
|
|
mcps=[
|
|
"snowflake",
|
|
"stripe",
|
|
"github"
|
|
]
|
|
```
|
|
|
|
## Exemplo Completo
|
|
|
|
Aqui está um exemplo completo usando múltiplos servidores MCP:
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew, Process
|
|
|
|
# Criar agente com múltiplas fontes MCP
|
|
agente_multi_fonte = Agent(
|
|
role="Analista de Pesquisa Multi-Fonte",
|
|
goal="Conduzir pesquisa abrangente usando múltiplas fontes de dados",
|
|
backstory="""Pesquisador especialista com acesso a busca web, dados meteorológicos,
|
|
informações financeiras e ferramentas de pesquisa acadêmica""",
|
|
mcps=[
|
|
# Servidores MCP externos
|
|
"https://mcp.exa.ai/mcp?api_key=sua_chave_exa&profile=pesquisa",
|
|
"https://weather.api.com/mcp#get_current_conditions",
|
|
|
|
# MCPs conectados do catálogo
|
|
"snowflake",
|
|
"stripe#list_invoices",
|
|
"github#search_repositories"
|
|
]
|
|
)
|
|
|
|
# Criar tarefa de pesquisa abrangente
|
|
tarefa_pesquisa = Task(
|
|
description="""Pesquisar o impacto dos agentes de IA na produtividade empresarial.
|
|
Incluir impactos climáticos atuais no trabalho remoto, tendências do mercado financeiro,
|
|
e publicações acadêmicas recentes sobre frameworks de agentes de IA.""",
|
|
expected_output="""Relatório abrangente cobrindo:
|
|
1. Análise do impacto dos agentes de IA nos negócios
|
|
2. Considerações climáticas para trabalho remoto
|
|
3. Tendências do mercado financeiro relacionadas à IA
|
|
4. Citações e insights de pesquisa acadêmica
|
|
5. Análise do cenário competitivo""",
|
|
agent=agente_multi_fonte
|
|
)
|
|
|
|
# Criar e executar crew
|
|
crew_pesquisa = Crew(
|
|
agents=[agente_multi_fonte],
|
|
tasks=[tarefa_pesquisa],
|
|
process=Process.sequential,
|
|
verbose=True
|
|
)
|
|
|
|
resultado = crew_pesquisa.kickoff()
|
|
print(f"Pesquisa concluída com {len(agente_multi_fonte.mcps)} fontes de dados MCP")
|
|
```
|
|
|
|
## Recursos Principais
|
|
|
|
- 🔄 **Descoberta Automática de Ferramentas**: Ferramentas são descobertas e integradas automaticamente
|
|
- 🏷️ **Prevenção de Colisão de Nomes**: Nomes de servidor são prefixados aos nomes das ferramentas
|
|
- ⚡ **Otimizado para Performance**: Conexões sob demanda com cache de esquemas
|
|
- 🛡️ **Resiliência a Erros**: Tratamento gracioso de servidores indisponíveis
|
|
- ⏱️ **Proteção por Timeout**: Timeouts integrados previnem conexões travadas
|
|
- 📊 **Integração Transparente**: Funciona perfeitamente com recursos existentes do CrewAI
|
|
|
|
## Tratamento de Erros
|
|
|
|
A integração DSL MCP é projetada para ser resiliente:
|
|
|
|
```python
|
|
agente = Agent(
|
|
role="Agente Resiliente",
|
|
goal="Continuar trabalhando apesar de problemas no servidor",
|
|
backstory="Agente que lida graciosamente com falhas",
|
|
mcps=[
|
|
"https://servidor-confiavel.com/mcp", # Vai funcionar
|
|
"https://servidor-inalcancavel.com/mcp", # Será ignorado graciosamente
|
|
"https://servidor-lento.com/mcp", # Timeout gracioso
|
|
"snowflake" # MCP conectado do catálogo
|
|
]
|
|
)
|
|
# O agente usará ferramentas de servidores funcionais e registrará avisos para os que falharem
|
|
```
|
|
|
|
## Recursos de Performance
|
|
|
|
### Cache Automático
|
|
|
|
Esquemas de ferramentas são cacheados por 5 minutos para melhorar a performance:
|
|
|
|
```python
|
|
# Primeira criação de agente - descobre ferramentas do servidor
|
|
agente1 = Agent(role="Primeiro", goal="Teste", backstory="Teste",
|
|
mcps=["https://api.example.com/mcp"])
|
|
|
|
# Segunda criação de agente (dentro de 5 minutos) - usa esquemas cacheados
|
|
agente2 = Agent(role="Segundo", goal="Teste", backstory="Teste",
|
|
mcps=["https://api.example.com/mcp"]) # Muito mais rápido!
|
|
```
|
|
|
|
### Conexões Sob Demanda
|
|
|
|
Conexões de ferramentas são estabelecidas apenas quando as ferramentas são realmente usadas:
|
|
|
|
```python
|
|
# Criação do agente é rápida - nenhuma conexão MCP feita ainda
|
|
agente = Agent(
|
|
role="Agente Sob Demanda",
|
|
goal="Usar ferramentas eficientemente",
|
|
backstory="Agente eficiente que conecta apenas quando necessário",
|
|
mcps=["https://api.example.com/mcp"]
|
|
)
|
|
|
|
# Conexão MCP é feita apenas quando uma ferramenta é realmente executada
|
|
# Isso minimiza o overhead de conexão e melhora a performance de inicialização
|
|
```
|
|
|
|
## Melhores Práticas
|
|
|
|
### 1. Use Ferramentas Específicas Quando Possível
|
|
|
|
```python
|
|
# Bom - obter apenas as ferramentas necessárias
|
|
mcps=["https://weather.api.com/mcp#get_forecast"]
|
|
|
|
# Menos eficiente - obter todas as ferramentas do servidor
|
|
mcps=["https://weather.api.com/mcp"]
|
|
```
|
|
|
|
### 2. Lidar com Autenticação de Forma Segura
|
|
|
|
```python
|
|
import os
|
|
|
|
# Armazenar chaves API em variáveis de ambiente
|
|
exa_key = os.getenv("EXA_API_KEY")
|
|
exa_profile = os.getenv("EXA_PROFILE")
|
|
|
|
agente = Agent(
|
|
role="Agente Seguro",
|
|
goal="Usar ferramentas MCP com segurança",
|
|
backstory="Agente consciente da segurança",
|
|
mcps=[f"https://mcp.exa.ai/mcp?api_key={exa_key}&profile={exa_profile}"]
|
|
)
|
|
```
|
|
|
|
### 3. Planejar para Falhas de Servidor
|
|
|
|
```python
|
|
# Sempre incluir opções de backup
|
|
mcps=[
|
|
"https://api-principal.com/mcp", # Escolha principal
|
|
"https://api-backup.com/mcp", # Opção de backup
|
|
"snowflake" # Fallback MCP conectado
|
|
]
|
|
```
|