ask-docs

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Ask CrewAI Docs

询问CrewAI文档

Answer CrewAI questions by looking up the official documentation at

docs.crewai.com

通过检索

docs.crewai.com

上的官方文档回答CrewAI相关问题。

When to Use This Skill

何时使用该技能

Use this skill when:

The user asks about a CrewAI feature, parameter, or behavior not covered in detail by the other skills
You need to verify current API syntax, method signatures, or configuration options
The user hits an error and needs troubleshooting guidance from official docs
The question is about a newer or less common CrewAI feature (e.g., telemetry, testing, CLI commands, deployment, enterprise features)
You're unsure whether your knowledge is current — the docs reflect the latest published state

Do NOT use this skill when the question is clearly answered by one of the other skills (getting-started, design-agent, design-task). Those skills contain curated, opinionated guidance. This skill is for filling gaps and verifying details.

符合以下场景时使用该技能：

用户询问的CrewAI功能、参数或运行逻辑未被其他技能详细覆盖
你需要验证当前API语法、方法签名或配置选项的正确性
用户遇到错误，需要官方文档提供的排查指导
问题涉及较新或小众的CrewAI功能（例如遥测、测试、CLI命令、部署、企业级功能）
你不确定自身知识是否为最新版本——文档同步了最新发布的内容

请勿使用该技能当问题已被其他技能（入门、设计Agent、设计任务）明确覆盖时。这些技能包含了经过整理的、可直接落地的指导，本技能仅用于填补信息空白和验证细节。

How to Query the Docs

如何查询文档

Step 1: Fetch the docs index

步骤1：获取文档索引

The CrewAI docs site publishes an

llms.txt

file — a structured index of every documentation page with descriptions. Fetch it first to find the right page:

WebFetch: https://docs.crewai.com/llms.txt

This returns a categorized list of all doc pages in the format:

- [Page Title](https://docs.crewai.com/path/to/page): "Description of what the page covers"

Categories include:

API Reference — REST endpoints (kickoff, status, resume, inputs)
Concepts — agents, crews, tasks, tools, flows, memory, knowledge, LLMs, processes, training, testing
Enterprise — RBAC, SSO, automations, traces, deployment, triggers, integrations
Tools Library — 40+ tools organized by category (AI/ML, automation, cloud, database, files, search, web scraping)
MCP Integration — MCP server setup, transports, DSL, security
Examples & Cookbooks — practical implementations
Learning Paths — tutorials and advanced topics
Observability — monitoring integrations

CrewAI文档站点发布了

llms.txt

文件——这是一个包含所有文档页面及描述的结构化索引。首先拉取该文件以找到匹配的页面：

WebFetch: https://docs.crewai.com/llms.txt

该接口会返回所有文档页面的分类列表，格式如下：

- [页面标题](https://docs.crewai.com/path/to/page): "页面覆盖内容的描述"

分类包括：

API参考 — REST端点（启动、状态查询、恢复、输入参数）
核心概念 — agents、crews、tasks、tools、flows、memory、knowledge、LLMs、processes、training、testing
企业版 — RBAC、SSO、自动化、链路追踪、部署、触发器、集成
工具库 — 按类别划分的40+工具（AI/ML、自动化、云服务、数据库、文件、搜索、网页爬取）
MCP集成 — MCP服务器搭建、传输协议、DSL、安全
示例与实战手册 — 可落地的实现方案
学习路径 — 教程和进阶主题
可观测性 — 监控集成

Step 2: Fetch the relevant page

步骤2：获取对应页面内容

Once you identify the right page from the index, fetch its content:

WebFetch: https://docs.crewai.com/<path-from-index>

从索引中找到匹配的页面后，拉取其内容：

WebFetch: https://docs.crewai.com/<path-from-index>

Step 3: Synthesize and cite

步骤3：内容整合与引用

Combine what you find from the docs with context from the other skills to give a clear, actionable response. Always include the docs URL so the user can read further.

将文档中查询到的内容与其他技能的上下文结合，给出清晰可落地的回答。请始终附上文档URL，方便用户进一步阅读。

Workflow Summary

工作流总结

Understand the user's question — what specific CrewAI concept, API, or behavior are they asking about?
Fetch
llms.txt
— scan the index to find the most relevant page(s)
Fetch the page(s) — retrieve the actual documentation content
Synthesize the answer — combine docs content with context from other skills
Cite the source — include the docs URL in your response

理解用户问题 — 用户询问的具体是哪个CrewAI概念、API或运行逻辑？
拉取
llms.txt
— 扫描索引找到最相关的页面
拉取对应页面 — 获取实际的文档内容
整合生成回答 — 将文档内容与其他技能的上下文结合
标注来源 — 在回答中附上文档URL

For an Even Better Experience

优化使用体验

Users who frequently query CrewAI docs can configure the CrewAI docs MCP server in their coding agent for richer, structured search:

https://docs.crewai.com/mcp

This is optional — the

llms.txt

workflow above works without any setup.

经常查询CrewAI文档的用户可以在编码Agent中配置CrewAI文档MCP服务器，获得更丰富的结构化搜索能力：

https://docs.crewai.com/mcp

该配置为可选项，上文提到的

llms.txt

工作流无需任何前置配置即可运行。

Examples of Good Use Cases

典型适用场景示例

User Question	Why This Skill
"What parameters does `Crew()` accept?"	Specific API reference — docs are authoritative
"How do I set up telemetry in CrewAI?"	Niche feature not covered in other skills
"What's the difference between `Process.sequential` and `Process.hierarchical` ?"	Detailed comparison best sourced from docs
"I'm getting `ValidationError` when using `output_pydantic` "	Troubleshooting — docs may have known issues or caveats
"How do I deploy a CrewAI flow to production?"	Deployment guidance lives in docs, not in design skills
"What CLI commands does `crewai` support?"	CLI reference is a docs concern
"How do I configure memory for a crew?"	Detailed config options beyond what design-agent covers
"What tools are available for web scraping?"	Tools library reference
"How do I set up SSO for CrewAI enterprise?"	Enterprise features live in docs

用户问题	适用该技能的原因
" `Crew()` 接受哪些参数？"	属于特定API参考内容，文档是权威来源
"如何在CrewAI中配置遥测？"	属于未被其他技能覆盖的小众功能
" `Process.sequential` 和 `Process.hierarchical` 的区别是什么？"	细节对比内容的最佳来源是官方文档
"我使用 `output_pydantic` 时遇到了 `ValidationError` "	故障排查场景，文档可能记录了已知问题或注意事项
"如何将CrewAI Flow部署到生产环境？"	部署指导位于文档中，未包含在设计类技能里
" `crewai` 支持哪些CLI命令？"	CLI参考属于文档覆盖范围
"如何为crew配置内存？"	属于超出设计Agent技能覆盖范围的详细配置选项
"有哪些可用的网页爬取工具？"	属于工具库参考内容
"如何为CrewAI企业版配置SSO？"	企业级功能位于文档中