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>
350 lines
10 KiB
Plaintext
350 lines
10 KiB
Plaintext
---
|
|
title: تكامل MCP DSL
|
|
description: تعلم كيفية استخدام صياغة DSL البسيطة في CrewAI لدمج خوادم MCP مباشرة مع وكلائك باستخدام حقل mcps.
|
|
icon: code
|
|
mode: "wide"
|
|
---
|
|
|
|
## نظرة عامة
|
|
|
|
يوفر تكامل MCP DSL (لغة المجال المحددة) في CrewAI **الطريقة الأبسط** لربط وكلائك بخوادم MCP (بروتوكول سياق النموذج). ما عليك سوى إضافة حقل `mcps` إلى وكيلك وسيتعامل CrewAI مع كل التعقيدات تلقائياً.
|
|
|
|
<Info>
|
|
هذا هو **النهج الموصى به** لمعظم حالات استخدام MCP. للسيناريوهات المتقدمة
|
|
التي تتطلب إدارة اتصال يدوية، راجع
|
|
[MCPServerAdapter](/ar/mcp/overview#advanced-mcpserveradapter).
|
|
</Info>
|
|
|
|
## الاستخدام الأساسي
|
|
|
|
أضف خوادم MCP إلى وكيلك باستخدام حقل `mcps`:
|
|
|
|
```python
|
|
from crewai import Agent
|
|
|
|
agent = Agent(
|
|
role="Research Assistant",
|
|
goal="Help with research and analysis tasks",
|
|
backstory="Expert assistant with access to advanced research tools",
|
|
mcps=[
|
|
"https://mcp.exa.ai/mcp?api_key=your_key&profile=research"
|
|
]
|
|
)
|
|
|
|
# MCP tools are now automatically available!
|
|
# No need for manual connection management or tool configuration
|
|
```
|
|
|
|
## تنسيقات المراجع المدعومة
|
|
|
|
### خوادم MCP البعيدة الخارجية
|
|
|
|
```python
|
|
# Basic HTTPS server
|
|
"https://api.example.com/mcp"
|
|
|
|
# Server with authentication
|
|
"https://mcp.exa.ai/mcp?api_key=your_key&profile=your_profile"
|
|
|
|
# Server with custom path
|
|
"https://services.company.com/api/v1/mcp"
|
|
```
|
|
|
|
### اختيار أدوات محددة
|
|
|
|
استخدم صياغة `#` لاختيار أدوات محددة من خادم:
|
|
|
|
```python
|
|
# Get only the forecast tool from weather server
|
|
"https://weather.api.com/mcp#get_forecast"
|
|
|
|
# Get only the search tool from Exa
|
|
"https://mcp.exa.ai/mcp?api_key=your_key#web_search_exa"
|
|
```
|
|
|
|
### تكاملات MCP المتصلة
|
|
|
|
اربط خوادم MCP من كتالوج CrewAI أو أحضر خوادمك الخاصة. بمجرد الاتصال في حسابك، أشر إليها بالمعرف المختصر:
|
|
|
|
```python
|
|
# Connected MCP with all tools
|
|
"snowflake"
|
|
|
|
# Specific tool from a connected MCP
|
|
"stripe#list_invoices"
|
|
|
|
# Multiple connected MCPs
|
|
mcps=[
|
|
"snowflake",
|
|
"stripe",
|
|
"github"
|
|
]
|
|
```
|
|
|
|
## مثال كامل
|
|
|
|
إليك مثالاً كاملاً يستخدم خوادم MCP متعددة:
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew, Process
|
|
|
|
# Create agent with multiple MCP sources
|
|
multi_source_agent = Agent(
|
|
role="Multi-Source Research Analyst",
|
|
goal="Conduct comprehensive research using multiple data sources",
|
|
backstory="""Expert researcher with access to web search, weather data,
|
|
financial information, and academic research tools""",
|
|
mcps=[
|
|
# External MCP servers
|
|
"https://mcp.exa.ai/mcp?api_key=your_exa_key&profile=research",
|
|
"https://weather.api.com/mcp#get_current_conditions",
|
|
|
|
# Connected MCPs from catalog
|
|
"snowflake",
|
|
"stripe#list_invoices",
|
|
"github#search_repositories"
|
|
]
|
|
)
|
|
|
|
# Create comprehensive research task
|
|
research_task = Task(
|
|
description="""Research the impact of AI agents on business productivity.
|
|
Include current weather impacts on remote work, financial market trends,
|
|
and recent academic publications on AI agent frameworks.""",
|
|
expected_output="""Comprehensive report covering:
|
|
1. AI agent business impact analysis
|
|
2. Weather considerations for remote work
|
|
3. Financial market trends related to AI
|
|
4. Academic research citations and insights
|
|
5. Competitive landscape analysis""",
|
|
agent=multi_source_agent
|
|
)
|
|
|
|
# Create and execute crew
|
|
research_crew = Crew(
|
|
agents=[multi_source_agent],
|
|
tasks=[research_task],
|
|
process=Process.sequential,
|
|
verbose=True
|
|
)
|
|
|
|
result = research_crew.kickoff()
|
|
print(f"Research completed with {len(multi_source_agent.mcps)} MCP data sources")
|
|
```
|
|
|
|
## تسمية الأدوات والتنظيم
|
|
|
|
يتعامل CrewAI تلقائياً مع تسمية الأدوات لمنع التعارضات:
|
|
|
|
```python
|
|
# Original MCP server has tools: "search", "analyze"
|
|
# CrewAI creates tools: "mcp_exa_ai_search", "mcp_exa_ai_analyze"
|
|
|
|
agent = Agent(
|
|
role="Tool Organization Demo",
|
|
goal="Show how tool naming works",
|
|
backstory="Demonstrates automatic tool organization",
|
|
mcps=[
|
|
"https://mcp.exa.ai/mcp?api_key=key", # Tools: mcp_exa_ai_*
|
|
"https://weather.service.com/mcp", # Tools: weather_service_com_*
|
|
"snowflake" # Tools: snowflake_*
|
|
]
|
|
)
|
|
|
|
# Each server's tools get unique prefixes based on the server name
|
|
# This prevents naming conflicts between different MCP servers
|
|
```
|
|
|
|
## معالجة الأخطاء والمرونة
|
|
|
|
صُمم MCP DSL ليكون متيناً وسهل الاستخدام:
|
|
|
|
### التعامل الأنيق مع فشل الخادم
|
|
|
|
```python
|
|
agent = Agent(
|
|
role="Resilient Researcher",
|
|
goal="Research despite server issues",
|
|
backstory="Experienced researcher who adapts to available tools",
|
|
mcps=[
|
|
"https://primary-server.com/mcp", # Primary data source
|
|
"https://backup-server.com/mcp", # Backup if primary fails
|
|
"https://unreachable-server.com/mcp", # Will be skipped with warning
|
|
"snowflake" # Connected MCP from catalog
|
|
]
|
|
)
|
|
|
|
# Agent will:
|
|
# 1. Successfully connect to working servers
|
|
# 2. Log warnings for failing servers
|
|
# 3. Continue with available tools
|
|
# 4. Not crash or hang on server failures
|
|
```
|
|
|
|
### حماية المهلة الزمنية
|
|
|
|
جميع عمليات MCP لها مهلات زمنية مدمجة:
|
|
|
|
- **مهلة الاتصال**: 10 ثوانٍ
|
|
- **مهلة تنفيذ الأداة**: 30 ثانية
|
|
- **مهلة الاكتشاف**: 15 ثانية
|
|
|
|
```python
|
|
# These servers will timeout gracefully if unresponsive
|
|
mcps=[
|
|
"https://slow-server.com/mcp", # Will timeout after 10s if unresponsive
|
|
"https://overloaded-api.com/mcp" # Will timeout if discovery takes > 15s
|
|
]
|
|
```
|
|
|
|
## ميزات الأداء
|
|
|
|
### التخزين المؤقت التلقائي
|
|
|
|
تُخزن مخططات الأدوات مؤقتاً لمدة 5 دقائق لتحسين الأداء:
|
|
|
|
```python
|
|
# First agent creation - discovers tools from server
|
|
agent1 = Agent(role="First", goal="Test", backstory="Test",
|
|
mcps=["https://api.example.com/mcp"])
|
|
|
|
# Second agent creation (within 5 minutes) - uses cached tool schemas
|
|
agent2 = Agent(role="Second", goal="Test", backstory="Test",
|
|
mcps=["https://api.example.com/mcp"]) # Much faster!
|
|
```
|
|
|
|
### الاتصالات حسب الطلب
|
|
|
|
تُنشأ اتصالات الأدوات فقط عند استخدام الأدوات فعلياً:
|
|
|
|
```python
|
|
# Agent creation is fast - no MCP connections made yet
|
|
agent = Agent(
|
|
role="On-Demand Agent",
|
|
goal="Use tools efficiently",
|
|
backstory="Efficient agent that connects only when needed",
|
|
mcps=["https://api.example.com/mcp"]
|
|
)
|
|
|
|
# MCP connection is made only when a tool is actually executed
|
|
# This minimizes connection overhead and improves startup performance
|
|
```
|
|
|
|
## التكامل مع الميزات الموجودة
|
|
|
|
تعمل أدوات MCP بسلاسة مع ميزات CrewAI الأخرى:
|
|
|
|
```python
|
|
from crewai.tools import BaseTool
|
|
|
|
class CustomTool(BaseTool):
|
|
name: str = "custom_analysis"
|
|
description: str = "Custom analysis tool"
|
|
|
|
def _run(self, **kwargs):
|
|
return "Custom analysis result"
|
|
|
|
agent = Agent(
|
|
role="Full-Featured Agent",
|
|
goal="Use all available tool types",
|
|
backstory="Agent with comprehensive tool access",
|
|
|
|
# All tool types work together
|
|
tools=[CustomTool()], # Custom tools
|
|
apps=["gmail", "slack"], # Platform integrations
|
|
mcps=[ # MCP servers
|
|
"https://mcp.exa.ai/mcp?api_key=key",
|
|
"snowflake"
|
|
],
|
|
|
|
verbose=True,
|
|
max_iter=15
|
|
)
|
|
```
|
|
|
|
## أفضل الممارسات
|
|
|
|
### 1. استخدم أدوات محددة عند الإمكان
|
|
|
|
```python
|
|
# Good - only get the tools you need
|
|
mcps=["https://weather.api.com/mcp#get_forecast"]
|
|
|
|
# Less efficient - gets all tools from server
|
|
mcps=["https://weather.api.com/mcp"]
|
|
```
|
|
|
|
### 2. تعامل مع المصادقة بأمان
|
|
|
|
```python
|
|
import os
|
|
|
|
# Store API keys in environment variables
|
|
exa_key = os.getenv("EXA_API_KEY")
|
|
exa_profile = os.getenv("EXA_PROFILE")
|
|
|
|
agent = Agent(
|
|
role="Secure Agent",
|
|
goal="Use MCP tools securely",
|
|
backstory="Security-conscious agent",
|
|
mcps=[f"https://mcp.exa.ai/mcp?api_key={exa_key}&profile={exa_profile}"]
|
|
)
|
|
```
|
|
|
|
### 3. خطط لفشل الخادم
|
|
|
|
```python
|
|
# Always include backup options
|
|
mcps=[
|
|
"https://primary-api.com/mcp", # Primary choice
|
|
"https://backup-api.com/mcp", # Backup option
|
|
"snowflake" # Connected MCP fallback
|
|
]
|
|
```
|
|
|
|
### 4. استخدم أدواراً وصفية للوكلاء
|
|
|
|
```python
|
|
agent = Agent(
|
|
role="Weather-Enhanced Market Analyst",
|
|
goal="Analyze markets considering weather impacts",
|
|
backstory="Financial analyst with access to weather data for agricultural market insights",
|
|
mcps=[
|
|
"https://weather.service.com/mcp#get_forecast",
|
|
"stripe#list_invoices"
|
|
]
|
|
)
|
|
```
|
|
|
|
## استكشاف الأخطاء وإصلاحها
|
|
|
|
### المشاكل الشائعة
|
|
|
|
**لم يتم اكتشاف أدوات:**
|
|
|
|
```python
|
|
# Check your MCP server URL and authentication
|
|
# Verify the server is running and accessible
|
|
mcps=["https://mcp.example.com/mcp?api_key=valid_key"]
|
|
```
|
|
|
|
**انتهاء مهلة الاتصال:**
|
|
|
|
```python
|
|
# Server may be slow or overloaded
|
|
# CrewAI will log warnings and continue with other servers
|
|
# Check server status or try backup servers
|
|
```
|
|
|
|
**فشل المصادقة:**
|
|
|
|
```python
|
|
# Verify API keys and credentials
|
|
# Check server documentation for required parameters
|
|
# Ensure query parameters are properly URL encoded
|
|
```
|
|
|
|
## متقدم: MCPServerAdapter
|
|
|
|
للسيناريوهات المعقدة التي تتطلب إدارة اتصال يدوية، استخدم فئة `MCPServerAdapter` من `crewai-tools`. استخدام مدير سياق Python (تعليمة `with`) هو النهج الموصى به لأنه يتعامل تلقائياً مع بدء وإيقاف الاتصال بخادم MCP.
|