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>
148 lines
6.3 KiB
Plaintext
148 lines
6.3 KiB
Plaintext
---
|
|
title: "Agent Capabilities"
|
|
description: "Understand the five ways to extend CrewAI agents: Tools, MCPs, Apps, Skills, and Knowledge."
|
|
icon: puzzle-piece
|
|
mode: "wide"
|
|
---
|
|
|
|
## Overview
|
|
|
|
CrewAI agents can be extended with **five distinct capability types**, each serving a different purpose. Understanding when to use each one — and how they work together — is key to building effective agents.
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Tools" icon="wrench" href="/en/concepts/tools" color="#3B82F6">
|
|
**Callable functions** — give agents the ability to take action. Web searches, file operations, API calls, code execution.
|
|
</Card>
|
|
<Card title="MCP Servers" icon="plug" href="/en/mcp/overview" color="#8B5CF6">
|
|
**Remote tool servers** — connect agents to external tool servers via the Model Context Protocol. Same effect as tools, but hosted externally.
|
|
</Card>
|
|
<Card title="Apps" icon="grid-2" color="#EC4899">
|
|
**Platform integrations** — connect agents to SaaS apps (Gmail, Slack, Jira, Salesforce) via CrewAI's platform. Runs locally with a platform integration token.
|
|
</Card>
|
|
<Card title="Skills" icon="bolt" href="/en/concepts/skills" color="#F59E0B">
|
|
**Domain expertise** — inject instructions, guidelines, and reference material into agent prompts. Skills tell agents *how to think*.
|
|
</Card>
|
|
<Card title="Knowledge" icon="book" href="/en/concepts/knowledge" color="#10B981">
|
|
**Retrieved facts** — provide agents with data from documents, files, and URLs via semantic search (RAG). Knowledge gives agents *what to know*.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
---
|
|
|
|
## The Key Distinction
|
|
|
|
The most important thing to understand: **these capabilities fall into two categories**.
|
|
|
|
### Action Capabilities (Tools, MCPs, Apps)
|
|
|
|
These give agents the ability to **do things** — call APIs, read files, search the web, send emails. At execution time, all three resolve into the same internal format (`BaseTool` instances) and appear in a unified tool list the agent can call.
|
|
|
|
```python
|
|
from crewai import Agent
|
|
from crewai_tools import SerperDevTool, FileReadTool
|
|
|
|
agent = Agent(
|
|
role="Researcher",
|
|
goal="Find and compile market data",
|
|
backstory="Expert market analyst",
|
|
tools=[SerperDevTool(), FileReadTool()], # Local tools
|
|
mcps=["https://mcp.example.com/sse"], # Remote MCP server tools
|
|
apps=["gmail", "google_sheets"], # Platform integrations
|
|
)
|
|
```
|
|
|
|
### Context Capabilities (Skills, Knowledge)
|
|
|
|
These modify the agent's **prompt** — injecting expertise, instructions, or retrieved data before the agent starts reasoning. They don't give agents new actions; they shape how agents think and what information they have access to.
|
|
|
|
```python
|
|
from crewai import Agent
|
|
|
|
agent = Agent(
|
|
role="Security Auditor",
|
|
goal="Audit cloud infrastructure for vulnerabilities",
|
|
backstory="Expert in cloud security with 10 years of experience",
|
|
skills=["./skills/security-audit"], # Domain instructions
|
|
knowledge_sources=[pdf_source, url_source], # Retrieved facts
|
|
)
|
|
```
|
|
|
|
---
|
|
|
|
## When to Use What
|
|
|
|
| You need... | Use | Example |
|
|
| :------------------------------------------------ | :---------------- | :--------------------------------------- |
|
|
| Agent to search the web | **Tools** | `tools=[SerperDevTool()]` |
|
|
| Agent to call a remote API via MCP | **MCPs** | `mcps=["https://api.example.com/sse"]` |
|
|
| Agent to send emails via Gmail | **Apps** | `apps=["gmail"]` |
|
|
| Agent to follow specific procedures | **Skills** | `skills=["./skills/code-review"]` |
|
|
| Agent to reference company docs | **Knowledge** | `knowledge_sources=[pdf_source]` |
|
|
| Agent to search the web AND follow review guidelines | **Tools + Skills** | Use both together |
|
|
|
|
---
|
|
|
|
## Combining Capabilities
|
|
|
|
In practice, agents often use **multiple capability types together**. Here's a realistic example:
|
|
|
|
```python
|
|
from crewai import Agent
|
|
from crewai_tools import SerperDevTool, FileReadTool, CodeInterpreterTool
|
|
|
|
# A fully-equipped research agent
|
|
researcher = Agent(
|
|
role="Senior Research Analyst",
|
|
goal="Produce comprehensive market analysis reports",
|
|
backstory="Expert analyst with deep industry knowledge",
|
|
|
|
# ACTION: What the agent can DO
|
|
tools=[
|
|
SerperDevTool(), # Search the web
|
|
FileReadTool(), # Read local files
|
|
CodeInterpreterTool(), # Run Python code for analysis
|
|
],
|
|
mcps=["https://data-api.example.com/sse"], # Access remote data API
|
|
apps=["google_sheets"], # Write to Google Sheets
|
|
|
|
# CONTEXT: What the agent KNOWS
|
|
skills=["./skills/research-methodology"], # How to conduct research
|
|
knowledge_sources=[company_docs], # Company-specific data
|
|
)
|
|
```
|
|
|
|
---
|
|
|
|
## Comparison Table
|
|
|
|
| Feature | Tools | MCPs | Apps | Skills | Knowledge |
|
|
| :--- | :---: | :---: | :---: | :---: | :---: |
|
|
| **Gives agent actions** | ✅ | ✅ | ✅ | ❌ | ❌ |
|
|
| **Modifies prompt** | ❌ | ❌ | ❌ | ✅ | ✅ |
|
|
| **Requires code** | Yes | Config only | Config only | Markdown only | Config only |
|
|
| **Runs locally** | Yes | Depends | Yes (with env var) | N/A | Yes |
|
|
| **Needs API keys** | Per tool | Per server | Integration token | No | Embedder only |
|
|
| **Set on Agent** | `tools=[]` | `mcps=[]` | `apps=[]` | `skills=[]` | `knowledge_sources=[]` |
|
|
| **Set on Crew** | ❌ | ❌ | ❌ | `skills=[]` | `knowledge_sources=[]` |
|
|
|
|
---
|
|
|
|
## Deep Dives
|
|
|
|
Ready to learn more about each capability type?
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Tools" icon="wrench" href="/en/concepts/tools">
|
|
Create custom tools, use the 75+ OSS catalog, configure caching and async execution.
|
|
</Card>
|
|
<Card title="MCP Integration" icon="plug" href="/en/mcp/overview">
|
|
Connect to MCP servers via stdio, SSE, or HTTP. Filter tools, configure auth.
|
|
</Card>
|
|
<Card title="Skills" icon="bolt" href="/en/concepts/skills">
|
|
Build skill packages with SKILL.md, inject domain expertise, use progressive disclosure.
|
|
</Card>
|
|
<Card title="Knowledge" icon="book" href="/en/concepts/knowledge">
|
|
Add knowledge from PDFs, CSVs, URLs, and more. Configure embedders and retrieval.
|
|
</Card>
|
|
</CardGroup>
|