mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 13:48:09 +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>
152 lines
6.4 KiB
Plaintext
152 lines
6.4 KiB
Plaintext
---
|
|
title: نقل SSE
|
|
description: تعلم كيفية ربط CrewAI بخوادم MCP البعيدة باستخدام Server-Sent Events (SSE) للاتصال في الوقت الفعلي.
|
|
icon: wifi
|
|
mode: "wide"
|
|
---
|
|
|
|
## نظرة عامة
|
|
|
|
توفر Server-Sent Events (SSE) طريقة قياسية لخادم الويب لإرسال تحديثات إلى العميل عبر اتصال HTTP واحد طويل الأمد. في سياق MCP، تُستخدم SSE للخوادم البعيدة لبث البيانات (مثل استجابات الأدوات) إلى تطبيق CrewAI في الوقت الفعلي.
|
|
|
|
## المفاهيم الرئيسية
|
|
|
|
- **خوادم بعيدة**: SSE مناسب لخوادم MCP المستضافة عن بُعد.
|
|
- **بث أحادي الاتجاه**: عادةً ما يكون SSE قناة اتصال أحادية الاتجاه من الخادم إلى العميل.
|
|
- **إعداد `MCPServerAdapter`**: لـ SSE، ستوفر عنوان URL الخادم وتحدد نوع النقل.
|
|
|
|
## الاتصال عبر SSE
|
|
|
|
يمكنك الاتصال بخادم MCP المبني على SSE باستخدام نهجين رئيسيين لإدارة دورة حياة الاتصال:
|
|
|
|
### 1. اتصال مُدار بالكامل (الموصى به)
|
|
|
|
استخدام مدير سياق Python (تعليمة `with`) هو النهج الموصى به. يتعامل تلقائياً مع إنشاء وإغلاق الاتصال بخادم MCP SSE.
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew, Process
|
|
from crewai_tools import MCPServerAdapter
|
|
|
|
server_params = {
|
|
"url": "http://localhost:8000/sse", # Replace with your actual SSE server URL
|
|
"transport": "sse"
|
|
}
|
|
|
|
# Using MCPServerAdapter with a context manager
|
|
try:
|
|
with MCPServerAdapter(server_params) as tools:
|
|
print(f"Available tools from SSE MCP server: {[tool.name for tool in tools]}")
|
|
|
|
# Example: Using a tool from the SSE MCP server
|
|
sse_agent = Agent(
|
|
role="Remote Service User",
|
|
goal="Utilize a tool provided by a remote SSE MCP server.",
|
|
backstory="An AI agent that connects to external services via SSE.",
|
|
tools=tools,
|
|
reasoning=True,
|
|
verbose=True,
|
|
)
|
|
|
|
sse_task = Task(
|
|
description="Fetch real-time stock updates for 'AAPL' using an SSE tool.",
|
|
expected_output="The latest stock price for AAPL.",
|
|
agent=sse_agent,
|
|
markdown=True
|
|
)
|
|
|
|
sse_crew = Crew(
|
|
agents=[sse_agent],
|
|
tasks=[sse_task],
|
|
verbose=True,
|
|
process=Process.sequential
|
|
)
|
|
|
|
if tools: # Only kickoff if tools were loaded
|
|
result = sse_crew.kickoff() # Add inputs={'stock_symbol': 'AAPL'} if tool requires it
|
|
print("\nCrew Task Result (SSE - Managed):\n", result)
|
|
else:
|
|
print("Skipping crew kickoff as tools were not loaded (check server connection).")
|
|
|
|
except Exception as e:
|
|
print(f"Error connecting to or using SSE MCP server (Managed): {e}")
|
|
print("Ensure the SSE MCP server is running and accessible at the specified URL.")
|
|
|
|
```
|
|
|
|
<Note>
|
|
استبدل `"http://localhost:8000/sse"` بعنوان URL الفعلي لخادم MCP SSE الخاص بك.
|
|
</Note>
|
|
|
|
### 2. دورة حياة اتصال يدوية
|
|
|
|
إذا كنت بحاجة إلى تحكم أدق، يمكنك إدارة دورة حياة اتصال `MCPServerAdapter` يدوياً.
|
|
|
|
<Info>
|
|
**يجب** عليك استدعاء `mcp_server_adapter.stop()` لضمان إغلاق الاتصال وتحرير الموارد. يُوصى بشدة باستخدام كتلة `try...finally`.
|
|
</Info>
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew, Process
|
|
from crewai_tools import MCPServerAdapter
|
|
|
|
server_params = {
|
|
"url": "http://localhost:8000/sse", # Replace with your actual SSE server URL
|
|
"transport": "sse"
|
|
}
|
|
|
|
mcp_server_adapter = None
|
|
try:
|
|
mcp_server_adapter = MCPServerAdapter(server_params)
|
|
mcp_server_adapter.start()
|
|
tools = mcp_server_adapter.tools
|
|
print(f"Available tools (manual SSE): {[tool.name for tool in tools]}")
|
|
|
|
manual_sse_agent = Agent(
|
|
role="Remote Data Analyst",
|
|
goal="Analyze data fetched from a remote SSE MCP server using manual connection management.",
|
|
backstory="An AI skilled in handling SSE connections explicitly.",
|
|
tools=tools,
|
|
verbose=True
|
|
)
|
|
|
|
analysis_task = Task(
|
|
description="Fetch and analyze the latest user activity trends from the SSE server.",
|
|
expected_output="A summary report of user activity trends.",
|
|
agent=manual_sse_agent
|
|
)
|
|
|
|
analysis_crew = Crew(
|
|
agents=[manual_sse_agent],
|
|
tasks=[analysis_task],
|
|
verbose=True,
|
|
process=Process.sequential
|
|
)
|
|
|
|
result = analysis_crew.kickoff()
|
|
print("\nCrew Task Result (SSE - Manual):\n", result)
|
|
|
|
except Exception as e:
|
|
print(f"An error occurred during manual SSE MCP integration: {e}")
|
|
print("Ensure the SSE MCP server is running and accessible.")
|
|
finally:
|
|
if mcp_server_adapter and mcp_server_adapter.is_connected:
|
|
print("Stopping SSE MCP server connection (manual)...")
|
|
mcp_server_adapter.stop() # **Crucial: Ensure stop is called**
|
|
elif mcp_server_adapter:
|
|
print("SSE MCP server adapter was not connected. No stop needed or start failed.")
|
|
|
|
```
|
|
|
|
## اعتبارات أمان SSE
|
|
|
|
<Warning>
|
|
**هجمات إعادة ربط DNS**: يمكن أن تكون عمليات نقل SSE عرضة لهجمات إعادة ربط DNS إذا لم يكن خادم MCP مؤمناً بشكل صحيح. قد يسمح هذا لمواقع ويب خبيثة بالتفاعل مع خوادم MCP المحلية أو على الشبكة الداخلية.
|
|
</Warning>
|
|
|
|
للتخفيف من هذا الخطر:
|
|
- يجب أن تتحقق تطبيقات خادم MCP من **رؤوس `Origin`** على اتصالات SSE الواردة.
|
|
- عند تشغيل خوادم MCP SSE محلية للتطوير، **اربط فقط بـ `localhost` (`127.0.0.1`)** بدلاً من جميع واجهات الشبكة (`0.0.0.0`).
|
|
- نفّذ **مصادقة مناسبة** لجميع اتصالات SSE إذا كشفت أدوات أو بيانات حساسة.
|
|
|
|
للحصول على نظرة شاملة على أفضل ممارسات الأمان، يرجى الرجوع إلى صفحة [اعتبارات الأمان](./security.mdx) ووثائق [أمان نقل MCP](https://modelcontextprotocol.io/docs/concepts/transports#security-considerations) الرسمية.
|