From 910ed716d9e65bf9cce51c3f646a5d319f69f62c Mon Sep 17 00:00:00 2001 From: Tony Kipkemboi Date: Wed, 21 May 2025 10:58:13 -0400 Subject: [PATCH] Reasoning docs update (#2871) * Add MCP integration documentation and update enterprise docs * Update MCP integration docs with code syntax improvements * Standardize documentation structure and add reasoning docs --- docs/concepts/agents.mdx | 2 +- docs/concepts/cli.mdx | 2 +- docs/concepts/collaboration.mdx | 2 +- docs/concepts/crews.mdx | 2 +- docs/concepts/event-listener.mdx | 4 ++-- docs/concepts/flows.mdx | 2 +- docs/concepts/knowledge.mdx | 2 +- docs/concepts/llms.mdx | 7 ++++--- docs/concepts/memory.mdx | 2 +- docs/concepts/planning.mdx | 4 ++-- docs/concepts/processes.mdx | 3 ++- docs/concepts/reasoning.mdx | 17 ++++++++++++----- docs/concepts/tasks.mdx | 4 ++-- docs/concepts/testing.mdx | 2 +- docs/concepts/tools.mdx | 4 +--- docs/concepts/training.mdx | 2 +- docs/docs.json | 1 + 17 files changed, 35 insertions(+), 27 deletions(-) diff --git a/docs/concepts/agents.mdx b/docs/concepts/agents.mdx index 4234e6428..fb992ba0a 100644 --- a/docs/concepts/agents.mdx +++ b/docs/concepts/agents.mdx @@ -21,7 +21,7 @@ Think of an agent as a specialized team member with specific skills, expertise, CrewAI Enterprise includes a Visual Agent Builder that simplifies agent creation and configuration without writing code. Design your agents visually and test them in real-time. -![Visual Agent Builder Screenshot](../images/enterprise/crew-studio-quickstart) +![Visual Agent Builder Screenshot](/images/enterprise/crew-studio-interface.png) The Visual Agent Builder enables: - Intuitive agent configuration with form-based interfaces diff --git a/docs/concepts/cli.mdx b/docs/concepts/cli.mdx index e8f3d3088..f66d04b44 100644 --- a/docs/concepts/cli.mdx +++ b/docs/concepts/cli.mdx @@ -4,7 +4,7 @@ description: Learn how to use the CrewAI CLI to interact with CrewAI. icon: terminal --- -# CrewAI CLI Documentation +## Overview The CrewAI CLI provides a set of commands to interact with CrewAI, allowing you to create, train, run, and manage crews & flows. diff --git a/docs/concepts/collaboration.mdx b/docs/concepts/collaboration.mdx index 63e59cb97..bfe87df04 100644 --- a/docs/concepts/collaboration.mdx +++ b/docs/concepts/collaboration.mdx @@ -4,7 +4,7 @@ description: Exploring the dynamics of agent collaboration within the CrewAI fra icon: screen-users --- -## Collaboration Fundamentals +## Overview Collaboration in CrewAI is fundamental, enabling agents to combine their skills, share information, and assist each other in task execution, embodying a truly cooperative ecosystem. diff --git a/docs/concepts/crews.mdx b/docs/concepts/crews.mdx index 8ebefff2f..4e4c2eeff 100644 --- a/docs/concepts/crews.mdx +++ b/docs/concepts/crews.mdx @@ -4,7 +4,7 @@ description: Understanding and utilizing crews in the crewAI framework with comp icon: people-group --- -## What is a Crew? +## Overview A crew in crewAI represents a collaborative group of agents working together to achieve a set of tasks. Each crew defines the strategy for task execution, agent collaboration, and the overall workflow. diff --git a/docs/concepts/event-listener.mdx b/docs/concepts/event-listener.mdx index 95726e23a..c97fbe06a 100644 --- a/docs/concepts/event-listener.mdx +++ b/docs/concepts/event-listener.mdx @@ -4,7 +4,7 @@ description: 'Tap into CrewAI events to build custom integrations and monitoring icon: spinner --- -# Event Listeners +## Overview CrewAI provides a powerful event system that allows you to listen for and react to various events that occur during the execution of your Crew. This feature enables you to build custom integrations, monitoring solutions, logging systems, or any other functionality that needs to be triggered based on CrewAI's internal events. @@ -21,7 +21,7 @@ When specific actions occur in CrewAI (like a Crew starting execution, an Agent CrewAI Enterprise provides a built-in Prompt Tracing feature that leverages the event system to track, store, and visualize all prompts, completions, and associated metadata. This provides powerful debugging capabilities and transparency into your agent operations. -![Prompt Tracing Dashboard](../images/enterprise/prompt-tracing.png) +![Prompt Tracing Dashboard](/images/enterprise/traces-overview.png) With Prompt Tracing you can: - View the complete history of all prompts sent to your LLM diff --git a/docs/concepts/flows.mdx b/docs/concepts/flows.mdx index 80a0abc13..9d868ca5e 100644 --- a/docs/concepts/flows.mdx +++ b/docs/concepts/flows.mdx @@ -4,7 +4,7 @@ description: Learn how to create and manage AI workflows using CrewAI Flows. icon: arrow-progress --- -## Introduction +## Overview CrewAI Flows is a powerful feature designed to streamline the creation and management of AI workflows. Flows allow developers to combine and coordinate coding tasks and Crews efficiently, providing a robust framework for building sophisticated AI automations. diff --git a/docs/concepts/knowledge.mdx b/docs/concepts/knowledge.mdx index a5ecd2542..01b8e82bc 100644 --- a/docs/concepts/knowledge.mdx +++ b/docs/concepts/knowledge.mdx @@ -4,7 +4,7 @@ description: What is knowledge in CrewAI and how to use it. icon: book --- -## What is Knowledge? +## Overview Knowledge in CrewAI is a powerful system that allows AI agents to access and utilize external information sources during their tasks. Think of it as giving your agents a reference library they can consult while working. diff --git a/docs/concepts/llms.mdx b/docs/concepts/llms.mdx index eb2bf38ee..7802c4964 100644 --- a/docs/concepts/llms.mdx +++ b/docs/concepts/llms.mdx @@ -4,9 +4,10 @@ description: 'A comprehensive guide to configuring and using Large Language Mode icon: 'microchip-ai' --- - - CrewAI integrates with multiple LLM providers through LiteLLM, giving you the flexibility to choose the right model for your specific use case. This guide will help you understand how to configure and use different LLM providers in your CrewAI projects. - +## Overview + +CrewAI integrates with multiple LLM providers through LiteLLM, giving you the flexibility to choose the right model for your specific use case. This guide will help you understand how to configure and use different LLM providers in your CrewAI projects. + ## What are LLMs? diff --git a/docs/concepts/memory.mdx b/docs/concepts/memory.mdx index 43f5918e4..df9e34ac9 100644 --- a/docs/concepts/memory.mdx +++ b/docs/concepts/memory.mdx @@ -4,7 +4,7 @@ description: Leveraging memory systems in the CrewAI framework to enhance agent icon: database --- -## Introduction to Memory Systems in CrewAI +## Overview The crewAI framework introduces a sophisticated memory system designed to significantly enhance the capabilities of AI agents. This system comprises `short-term memory`, `long-term memory`, `entity memory`, and `contextual memory`, each serving a unique purpose in aiding agents to remember, diff --git a/docs/concepts/planning.mdx b/docs/concepts/planning.mdx index c92d64ebe..6161a6dbb 100644 --- a/docs/concepts/planning.mdx +++ b/docs/concepts/planning.mdx @@ -1,10 +1,10 @@ --- title: Planning description: Learn how to add planning to your CrewAI Crew and improve their performance. -icon: brain +icon: ruler-combined --- -## Introduction +## Overview The planning feature in CrewAI allows you to add planning capability to your crew. When enabled, before each Crew iteration, all Crew information is sent to an AgentPlanner that will plan the tasks step by step, and this plan will be added to each task description. diff --git a/docs/concepts/processes.mdx b/docs/concepts/processes.mdx index ee3ed72b2..6daa67a0f 100644 --- a/docs/concepts/processes.mdx +++ b/docs/concepts/processes.mdx @@ -4,7 +4,8 @@ description: Detailed guide on workflow management through processes in CrewAI, icon: bars-staggered --- -## Understanding Processes +## Overview + Processes orchestrate the execution of tasks by agents, akin to project management in human teams. These processes ensure tasks are distributed and executed efficiently, in alignment with a predefined strategy. diff --git a/docs/concepts/reasoning.mdx b/docs/concepts/reasoning.mdx index 316af8732..0f7644d9a 100644 --- a/docs/concepts/reasoning.mdx +++ b/docs/concepts/reasoning.mdx @@ -1,12 +1,14 @@ --- -title: "Agent Reasoning" +title: Reasoning +description: "Learn how to enable and use agent reasoning to improve task execution." +icon: brain --- -# Agent Reasoning +## Overview Agent reasoning is a feature that allows agents to reflect on a task and create a plan before execution. This helps agents approach tasks more methodically and ensures they're ready to perform the assigned work. -## How to Use Agent Reasoning +## Usage To enable reasoning for an agent, simply set `reasoning=True` when creating the agent: @@ -35,8 +37,13 @@ This process helps the agent break down complex tasks into manageable steps and ## Configuration Options -- `reasoning` (bool): Enable or disable reasoning (default: False) -- `max_reasoning_attempts` (int, optional): Maximum number of attempts to refine the plan before proceeding with execution. If None (default), the agent will continue refining until it's ready. + + Enable or disable reasoning + + + + Maximum number of attempts to refine the plan before proceeding with execution. If None (default), the agent will continue refining until it's ready. + ## Example diff --git a/docs/concepts/tasks.mdx b/docs/concepts/tasks.mdx index b88d52a92..89e290b30 100644 --- a/docs/concepts/tasks.mdx +++ b/docs/concepts/tasks.mdx @@ -4,7 +4,7 @@ description: Detailed guide on managing and creating tasks within the CrewAI fra icon: list-check --- -## Overview of a Task +## Overview In the CrewAI framework, a `Task` is a specific assignment completed by an `Agent`. @@ -15,7 +15,7 @@ Tasks within CrewAI can be collaborative, requiring multiple agents to work toge CrewAI Enterprise includes a Visual Task Builder in Crew Studio that simplifies complex task creation and chaining. Design your task flows visually and test them in real-time without writing code. -![Task Builder Screenshot](../images/enterprise/crew-studio-quickstart.png) +![Task Builder Screenshot](/images/enterprise/crew-studio-interface.png) The Visual Task Builder enables: - Drag-and-drop task creation diff --git a/docs/concepts/testing.mdx b/docs/concepts/testing.mdx index ec6edda02..61d08e0e9 100644 --- a/docs/concepts/testing.mdx +++ b/docs/concepts/testing.mdx @@ -4,7 +4,7 @@ description: Learn how to test your CrewAI Crew and evaluate their performance. icon: vial --- -## Introduction +## Overview Testing is a crucial part of the development process, and it is essential to ensure that your crew is performing as expected. With crewAI, you can easily test your crew and evaluate its performance using the built-in testing capabilities. diff --git a/docs/concepts/tools.mdx b/docs/concepts/tools.mdx index d5f9d9cfc..1f04836ad 100644 --- a/docs/concepts/tools.mdx +++ b/docs/concepts/tools.mdx @@ -4,7 +4,7 @@ description: Understanding and leveraging tools within the CrewAI framework for icon: screwdriver-wrench --- -## Introduction +## Overview CrewAI tools empower agents with capabilities ranging from web searching and data analysis to collaboration and delegating tasks among coworkers. This documentation outlines how to create, integrate, and leverage these tools within the CrewAI framework, including a new focus on collaboration tools. @@ -18,8 +18,6 @@ enabling everything from simple searches to complex interactions and effective t CrewAI Enterprise provides a comprehensive Tools Repository with pre-built integrations for common business systems and APIs. Deploy agents with enterprise tools in minutes instead of days. -![Tools Repository Screenshot](../images/enterprise/tools-repository.png) - The Enterprise Tools Repository includes: - Pre-built connectors for popular enterprise systems - Custom tool creation interface diff --git a/docs/concepts/training.mdx b/docs/concepts/training.mdx index 549763fde..2784c87db 100644 --- a/docs/concepts/training.mdx +++ b/docs/concepts/training.mdx @@ -4,7 +4,7 @@ description: Learn how to train your CrewAI agents by giving them feedback early icon: dumbbell --- -## Introduction +## Overview The training feature in CrewAI allows you to train your AI agents using the command-line interface (CLI). By running the command `crewai train -n `, you can specify the number of iterations for the training process. diff --git a/docs/docs.json b/docs/docs.json index 6146cb7d4..c669739dd 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -74,6 +74,7 @@ "concepts/collaboration", "concepts/training", "concepts/memory", + "concepts/reasoning", "concepts/planning", "concepts/testing", "concepts/cli",