andre/crewAI
1
0
Fork 0
mirror of https://github.com/crewAIInc/crewAI.git synced 2026-01-10 00:28:31 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

adjust aop to amp docs lang (#4179)
Some checks failed
CodeQL Advanced / Analyze (actions) (push) Has been cancelled
Details
CodeQL Advanced / Analyze (python) (push) Has been cancelled
Details
Check Documentation Broken Links / Check broken links (push) Has been cancelled
Details
Notify Downstream / notify-downstream (push) Has been cancelled
Details
Mark stale issues and pull requests / stale (push) Has been cancelled
Details

Browse Source 
* adjust aop to amp docs lang

* whoop no print
This commit is contained in:
Lorenze Jay
2026-01-05 15:30:21 -08:00
committed by GitHub
parent f8deb0fd18
commit 25c0c030ce
203 changed files with 5176 additions and 2715 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/en/mcp/dsl-integration.mdx
View File

@@ -10,7 +10,9 @@ mode: "wide"
CrewAI's MCP DSL (Domain Specific Language) integration provides the **simplest way** to connect your agents to MCP (Model Context Protocol) servers. Just add an `mcps` field to your agent and CrewAI handles all the complexity automatically.
<Info>
This is the **recommended approach** for most MCP use cases. For advanced scenarios requiring manual connection management, see [MCPServerAdapter](/en/mcp/overview#advanced-mcpserveradapter).
This is the **recommended approach** for most MCP use cases. For advanced
scenarios requiring manual connection management, see
[MCPServerAdapter](/en/mcp/overview#advanced-mcpserveradapter).
</Info>
## Basic Usage
@@ -60,9 +62,9 @@ Use the `#` syntax to select specific tools from a server:
"https://mcp.exa.ai/mcp?api_key=your_key#web_search_exa"
```
### CrewAI AOP Marketplace
### CrewAI AMP Marketplace
Access tools from the CrewAI AOP marketplace:
Access tools from the CrewAI AMP marketplace:
```python
# Full service with all tools
@@ -97,7 +99,7 @@ multi_source_agent = Agent(
"https://mcp.exa.ai/mcp?api_key=your_exa_key&profile=research",
"https://weather.api.com/mcp#get_current_conditions",
# CrewAI AOP marketplace
# CrewAI AMP marketplace
"crewai-amp:financial-insights",
"crewai-amp:academic-research#pubmed_search",
"crewai-amp:market-intelligence#competitor_analysis"
@@ -319,6 +321,7 @@ agent = Agent(
### Common Issues
**No tools discovered:**
```python
# Check your MCP server URL and authentication
# Verify the server is running and accessible
@@ -326,6 +329,7 @@ mcps=["https://mcp.example.com/mcp?api_key=valid_key"]
```
**Connection timeouts:**
```python
# Server may be slow or overloaded
# CrewAI will log warnings and continue with other servers
@@ -333,6 +337,7 @@ mcps=["https://mcp.example.com/mcp?api_key=valid_key"]
```
**Authentication failures:**
```python
# Verify API keys and credentials
# Check server documentation for required parameters

63
docs/en/mcp/overview.mdx
View File

@@ -1,6 +1,6 @@
---
title: 'MCP Servers as Tools in CrewAI'
description: 'Learn how to integrate MCP servers as tools in your CrewAI agents using the `crewai-tools` library.'
title: "MCP Servers as Tools in CrewAI"
description: "Learn how to integrate MCP servers as tools in your CrewAI agents using the `crewai-tools` library."
icon: plug
mode: "wide"
---
@@ -17,7 +17,7 @@ Use the `mcps` field directly on agents for seamless MCP tool integration. The D
#### String-Based References (Quick Setup)
Perfect for remote HTTPS servers and CrewAI AOP marketplace:
Perfect for remote HTTPS servers and CrewAI AMP marketplace:
```python
from crewai import Agent
@@ -29,7 +29,7 @@ agent = Agent(
mcps=[
"https://mcp.exa.ai/mcp?api_key=your_key", # External MCP server
"https://api.weather.com/mcp#get_forecast", # Specific tool from server
"crewai-amp:financial-data", # CrewAI AOP marketplace
"crewai-amp:financial-data", # CrewAI AMP marketplace
"crewai-amp:research-tools#pubmed_search" # Specific AMP tool
]
)
@@ -87,6 +87,7 @@ We currently support the following transport mechanisms:
- **Streamable HTTPS**: for remote servers (flexible, potentially bi-directional communication over HTTPS, often utilizing SSE for server-to-client streams)
## Video Tutorial
Watch this video tutorial for a comprehensive guide on MCP integration with CrewAI:
<iframe
@@ -203,7 +204,7 @@ mcps=[
]
```
#### CrewAI AOP Marketplace
#### CrewAI AMP Marketplace
```python
mcps=[
@@ -373,6 +374,7 @@ Each transport type supports specific configuration options:
### Common Parameters
All transport types support:
- **`tool_filter`**: Filter function to control which tools are available. Can be:
- `None` (default): All tools are available
- Static filter: Created with `create_static_tool_filter()` for allow/block lists
@@ -423,6 +425,7 @@ agent = Agent(
```
All connection errors are handled gracefully:
- **Connection failures**: Logged as warnings, agent continues with available tools
- **Timeout errors**: Connections timeout after 30 seconds (configurable)
- **Authentication errors**: Logged clearly for debugging
@@ -484,6 +487,7 @@ with MCPServerAdapter(server_params, connect_timeout=60) as mcp_tools:
)
# ... rest of your crew setup ...
```
This general pattern shows how to integrate tools. For specific examples tailored to each transport, refer to the detailed guides below.
## Filtering Tools
@@ -570,6 +574,7 @@ When a crew class is decorated with `@CrewBase`, the adapter lifecycle is manage
- If `mcp_server_params` is not defined, `get_mcp_tools()` simply returns an empty list, allowing the same code paths to run with or without MCP configured.
This makes it safe to call `get_mcp_tools()` from multiple agent methods or selectively enable MCP per environment.
</Tip>
### Connection Timeout Configuration
@@ -636,7 +641,8 @@ class CrewWithCustomTimeout:
href="/en/mcp/dsl-integration"
color="#3B82F6"
>
**Recommended**: Use the simple `mcps=[]` field syntax for effortless MCP integration.
**Recommended**: Use the simple `mcps=[]` field syntax for effortless MCP
integration.
</Card>
<Card
title="Stdio Transport"
@@ -644,15 +650,12 @@ class CrewWithCustomTimeout:
href="/en/mcp/stdio"
color="#10B981"
>
Connect to local MCP servers via standard input/output. Ideal for scripts and local executables.
Connect to local MCP servers via standard input/output. Ideal for scripts
and local executables.
</Card>
<Card
title="SSE Transport"
icon="wifi"
href="/en/mcp/sse"
color="#F59E0B"
>
Integrate with remote MCP servers using Server-Sent Events for real-time data streaming.
<Card title="SSE Transport" icon="wifi" href="/en/mcp/sse" color="#F59E0B">
Integrate with remote MCP servers using Server-Sent Events for real-time
data streaming.
</Card>
<Card
title="Streamable HTTP Transport"
@@ -660,7 +663,8 @@ class CrewWithCustomTimeout:
href="/en/mcp/streamable-http"
color="#8B5CF6"
>
Utilize flexible Streamable HTTP for robust communication with remote MCP servers.
Utilize flexible Streamable HTTP for robust communication with remote MCP
servers.
</Card>
<Card
title="Connecting to Multiple Servers"
@@ -668,7 +672,8 @@ class CrewWithCustomTimeout:
href="/en/mcp/multiple-servers"
color="#EF4444"
>
Aggregate tools from several MCP servers simultaneously using a single adapter.
Aggregate tools from several MCP servers simultaneously using a single
adapter.
</Card>
<Card
title="Security Considerations"
@@ -676,27 +681,28 @@ class CrewWithCustomTimeout:
href="/en/mcp/security"
color="#DC2626"
>
Review important security best practices for MCP integration to keep your agents safe.
Review important security best practices for MCP integration to keep your
agents safe.
</Card>
</CardGroup>
Checkout this repository for full demos and examples of MCP integration with CrewAI! 👇
<Card
title="GitHub Repository"
icon="github"
href="https://github.com/tonykipkemboi/crewai-mcp-demo"
target="_blank"
title="GitHub Repository"
icon="github"
href="https://github.com/tonykipkemboi/crewai-mcp-demo"
target="_blank"
>
CrewAI MCP Demo
CrewAI MCP Demo
</Card>
## Staying Safe with MCP
<Warning>
Always ensure that you trust an MCP Server before using it.
</Warning>
<Warning>Always ensure that you trust an MCP Server before using it.</Warning>
#### Security Warning: DNS Rebinding Attacks
SSE transports can be vulnerable to DNS rebinding attacks if not properly secured.
To prevent this:
@@ -709,6 +715,7 @@ Without these protections, attackers could use DNS rebinding to interact with lo
For more details, see the [Anthropic's MCP Transport Security docs](https://modelcontextprotocol.io/docs/concepts/transports#security-considerations).
### Limitations
* **Supported Primitives**: Currently, `MCPServerAdapter` primarily supports adapting MCP `tools`.
Other MCP primitives like `prompts` or `resources` are not directly integrated as CrewAI components through this adapter at this time.
* **Output Handling**: The adapter typically processes the primary text output from an MCP tool (e.g., `.content[0].text`). Complex or multi-modal outputs might require custom handling if not fitting this pattern.
- **Supported Primitives**: Currently, `MCPServerAdapter` primarily supports adapting MCP `tools`.
Other MCP primitives like `prompts` or `resources` are not directly integrated as CrewAI components through this adapter at this time.
- **Output Handling**: The adapter typically processes the primary text output from an MCP tool (e.g., `.content[0].text`). Complex or multi-modal outputs might require custom handling if not fitting this pattern.