mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 05:38:12 +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>
134 lines
5.3 KiB
Plaintext
134 lines
5.3 KiB
Plaintext
---
|
|
title: Transporte Stdio
|
|
description: Aprenda como conectar o CrewAI a servidores MCP locais usando o mecanismo de transporte Stdio (Entrada/Saída Padrão).
|
|
icon: server
|
|
mode: "wide"
|
|
---
|
|
|
|
## Visão Geral
|
|
|
|
O transporte Stdio (Entrada/Saída Padrão) é projetado para conectar o `MCPServerAdapter` a servidores MCP locais que se comunicam por meio de seus fluxos de entrada e saída padrão. Isso é normalmente utilizado quando o servidor MCP é um script ou executável rodando na mesma máquina da sua aplicação CrewAI.
|
|
|
|
## Conceitos-Chave
|
|
|
|
- **Execução Local**: O transporte Stdio gerencia um processo localmente em execução para o servidor MCP.
|
|
- **`StdioServerParameters`**: Esta classe da biblioteca `mcp` é usada para configurar o comando, argumentos e variáveis de ambiente para iniciar o servidor Stdio.
|
|
|
|
## Conectando via Stdio
|
|
|
|
Você pode se conectar a um servidor MCP baseado em Stdio usando duas abordagens principais para gerenciar o ciclo de vida da conexão:
|
|
|
|
### 1. Conexão Totalmente Gerenciada (Recomendado)
|
|
|
|
Usar um context manager do Python (declaração `with`) é a abordagem recomendada. Ela lida automaticamente com o início do processo do servidor MCP e sua finalização quando o contexto é encerrado.
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew, Process
|
|
from crewai_tools import MCPServerAdapter
|
|
from mcp import StdioServerParameters
|
|
import os
|
|
|
|
# Criar um objeto StdioServerParameters
|
|
server_params=StdioServerParameters(
|
|
command="python3",
|
|
args=["servers/your_stdio_server.py"],
|
|
env={"UV_PYTHON": "3.12", **os.environ},
|
|
)
|
|
|
|
with MCPServerAdapter(server_params) as tools:
|
|
print(f"Available tools from Stdio MCP server: {[tool.name for tool in tools]}")
|
|
|
|
# Exemplo: Usando as ferramentas do servidor MCP Stdio em um Agente CrewAI
|
|
pesquisador_local = Agent(
|
|
role="Processador Local de Dados",
|
|
goal="Processar dados usando uma ferramenta local baseada em Stdio.",
|
|
backstory="Uma IA que utiliza scripts locais via MCP para tarefas especializadas.",
|
|
tools=tools,
|
|
reasoning=True,
|
|
verbose=True,
|
|
)
|
|
|
|
processing_task = Task(
|
|
description="Processar o arquivo de dados de entrada 'data.txt' e resumir seu conteúdo.",
|
|
expected_output="Um resumo dos dados processados.",
|
|
agent=pesquisador_local,
|
|
markdown=True
|
|
)
|
|
|
|
data_crew = Crew(
|
|
agents=[pesquisador_local],
|
|
tasks=[processing_task],
|
|
verbose=True,
|
|
process=Process.sequential
|
|
)
|
|
|
|
result = data_crew.kickoff()
|
|
print("\nCrew Task Result (Stdio - Managed):\n", result)
|
|
|
|
```
|
|
|
|
### 2. Ciclo de Vida Manual da Conexão
|
|
|
|
Se você precisa de um controle mais refinado sobre quando o processo do servidor MCP Stdio é iniciado e finalizado, pode gerenciar o ciclo de vida do `MCPServerAdapter` manualmente.
|
|
|
|
<Info>
|
|
Você **DEVE** chamar `mcp_server_adapter.stop()` para garantir que o processo do servidor seja finalizado e os recursos, liberados. Recomenda-se fortemente o uso de um bloco `try...finally`.
|
|
</Info>
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew, Process
|
|
from crewai_tools import MCPServerAdapter
|
|
from mcp import StdioServerParameters
|
|
import os
|
|
|
|
# Criar um objeto StdioServerParameters
|
|
stdio_params=StdioServerParameters(
|
|
command="python3",
|
|
args=["servers/your_stdio_server.py"],
|
|
env={"UV_PYTHON": "3.12", **os.environ},
|
|
)
|
|
|
|
mcp_server_adapter = MCPServerAdapter(server_params=stdio_params)
|
|
try:
|
|
mcp_server_adapter.start() # Inicia manualmente a conexão e o processo do servidor
|
|
tools = mcp_server_adapter.tools
|
|
print(f"Available tools (manual Stdio): {[tool.name for tool in tools]}")
|
|
|
|
# Exemplo: Usando as ferramentas com sua configuração de Agent, Task, Crew
|
|
manual_agent = Agent(
|
|
role="Executor Local de Tarefas",
|
|
goal="Executar uma tarefa local específica usando uma ferramenta Stdio gerenciada manualmente.",
|
|
backstory="Uma IA proficiente em controlar processos locais via MCP.",
|
|
tools=tools,
|
|
verbose=True
|
|
)
|
|
|
|
manual_task = Task(
|
|
description="Executar o comando 'perform_analysis' via ferramenta Stdio.",
|
|
expected_output="Resultados da análise.",
|
|
agent=manual_agent
|
|
)
|
|
|
|
manual_crew = Crew(
|
|
agents=[manual_agent],
|
|
tasks=[manual_task],
|
|
verbose=True,
|
|
process=Process.sequential
|
|
)
|
|
|
|
|
|
result = manual_crew.kickoff() # As entradas reais dependem da sua ferramenta
|
|
print("\nCrew Task Result (Stdio - Manual):\n", result)
|
|
|
|
except Exception as e:
|
|
print(f"An error occurred during manual Stdio MCP integration: {e}")
|
|
finally:
|
|
if mcp_server_adapter and mcp_server_adapter.is_connected: # Verifica se está conectado antes de parar
|
|
print("Stopping Stdio MCP server connection (manual)...")
|
|
mcp_server_adapter.stop() # **Crucial: Assegure que stop seja chamado**
|
|
elif mcp_server_adapter: # Se o adaptador existe mas não está conectado (ex.: start falhou)
|
|
print("Stdio MCP server adapter was not connected. No stop needed or start failed.")
|
|
|
|
```
|
|
|
|
Lembre-se de substituir caminhos e comandos de exemplo pelos detalhes reais do seu servidor Stdio. O parâmetro `env` em `StdioServerParameters` pode ser usado para definir variáveis de ambiente para o processo do servidor, o que pode ser útil para configurar seu comportamento ou fornecer caminhos necessários (como `PYTHONPATH`). |