docs: agent refactor#8524
Conversation
dosubot
Bot
added
the
size:XXL
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThis update restructures and consolidates the documentation for agent components. It removes outdated or redundant agent documentation, introduces a new comprehensive guide for agents, updates links throughout related documents, and reorganizes detailed agent component descriptions under the "Bundles" section. Sidebar navigation is also updated to reflect these changes. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs
participant Sidebar
User->>Docs: Accesses agent documentation
Docs-->>User: Serves new consolidated agents guide (agents.md)
User->>Sidebar: Navigates via sidebar
Sidebar-->>User: Shows single "Agents" entry
User->>Docs: Follows updated internal links
Docs-->>User: Serves relevant, updated or expanded documentation sections
Suggested labels
✨ Finishing Touches🧪 Generate Unit Tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
github-actions
Bot
removed
the
documentation
|
|
||
| If the component you want to use as a tool doesn't have a **Tool Mode** button, add `tool_mode=True` to one of the component's inputs, and connect the new **Toolset** output to the agent's **Tools** input. | ||
|
|
||
| Langflow supports **Tool Mode** for the following data types: |
There was a problem hiding this comment.
@edwinjosechittilappilly Confirm this please
github-actions
Bot
added
the
documentation
|
|
||
| 7. The new agent's actions can be edited to help the agent understand how to use it. | ||
| Click <Icon name="SlidersHorizontal" aria-hidden="true"/> **Edit Tools** to modify its `name`, `description`, or `enabled` metadata. | ||
| For example, the default tool name is `Agent`. Edit the name to `Agent-gpt-41`, and edit the description to `Use the gpt-4.1 model for complex problem solving`. The connected agent will understand that this is the `gpt-4.1` agent, and will use it for tasks requiring a larger context window. |
There was a problem hiding this comment.
@edwinjosechittilappilly This is the bug that I reported, where the connected agent as tool displays potentially incorrect information.
|
Build successful! ✅ |
github-actions
Bot
added
documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
docs/docs/Sample-Flows/sequential-agent.md (1)
54-54: Hyphenate “problem-solving” and confirm link update.Change “problem solving” to “problem-solving” and ensure the link accurately points to
/agents.🧰 Tools
🪛 LanguageTool
[grammar] ~54-~54: This noun or verb “problem-solving” is spelled with a hyphen.
Context: ...our own multi-agent flow, see Create a problem solving agent.(PROBLEM_SOLVE_HYPHEN)
docs/docs/Components/components-agents.md (1)
23-24: Suggestion: Add comma for clarity.Consider adding a comma after the image to improve readability:
-  - For a multi-agent example see [Create a flow with an agent](/agents). + , + For a multi-agent example, see [Create a flow with an agent](/agents).🧰 Tools
🪛 LanguageTool
[uncategorized] ~24-~24: Possible missing comma found.
Context: ...ow-simple-agent.png) For a multi-agent example see [Create a flow with an agent](/agen...(AI_HYDRA_LEO_MISSING_COMMA)
docs/docs/Agents/agents.md (2)
96-98: Consistency: Hyphenate “problem-solving.”The term “problem solving” should use a hyphen to match noun usage:
- description to `Use the gpt-4.1 model for complex problem solving`. + description to `Use the gpt-4.1 model for complex problem-solving`.🧰 Tools
🪛 LanguageTool
[grammar] ~97-~97: This noun or verb “problem-solving” is spelled with a hyphen.
Context: ...nt-gpt-41, and edit the description toUse the gpt-4.1 model for complex problem solving`. The connected agent will understand t...(PROBLEM_SOLVE_HYPHEN)
200-202: Suggestion: Add comma before “so.”Insert a comma before “so” to correctly separate clauses:
- pane. this code so the custom component can be used as a tool. + pane. this code, so the custom component can be used as a tool.🧰 Tools
🪛 LanguageTool
[uncategorized] ~201-~201: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...de=Trueto theMessageTextInput` input so the custom component can be used as a t...(COMMA_COMPOUND_SENTENCE_2)
docs/docs/Components/components-bundles.md (2)
18-18: Grammar: Add missing comma.Insert a comma after “CrewAI” to separate clauses:
- This component represents an Agent of CrewAI allowing for the creation of specialized AI agents... + This component represents an Agent of CrewAI, allowing for the creation of specialized AI agents...🧰 Tools
🪛 LanguageTool
[uncategorized] ~18-~18: Possible missing comma found.
Context: ... This component represents an Agent of CrewAI allowing for the creation of specialize...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~18-~18: A comma might be missing here.
Context: ...n of specialized AI agents with defined roles goals and capabilities within a crew. ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
188-188: Grammar: Insert comma after “Agent.”Separate the clause for clarity:
- Task and its associated Agent allowing for the definition of sequential tasks... + Task and its associated Agent, allowing for the definition of sequential tasks...🧰 Tools
🪛 LanguageTool
[uncategorized] ~188-~188: A comma might be missing here.
Context: ...reates a CrewAI Task and its associated Agent allowing for the definition of sequenti...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (8)
docs/static/img/agent-component.pngis excluded by!**/*.pngdocs/static/img/agent-example-add-chat.pngis excluded by!**/*.pngdocs/static/img/agent-example-add-tools.pngis excluded by!**/*.pngdocs/static/img/agent-example-agent-as-tool.pngis excluded by!**/*.pngdocs/static/img/agent-example-run-flow-as-tool.pngis excluded by!**/*.pngdocs/static/img/tool-calling-agent-add-chat.pngis excluded by!**/*.pngdocs/static/img/tool-calling-agent-as-tool.pngis excluded by!**/*.pngdocs/static/img/tool-calling-agent-component.pngis excluded by!**/*.png
📒 Files selected for processing (10)
docs/docs/Agents/agent-tool-calling-agent-component.md(0 hunks)docs/docs/Agents/agents-overview.md(0 hunks)docs/docs/Agents/agents.md(1 hunks)docs/docs/Components/components-agents.md(2 hunks)docs/docs/Components/components-bundles.md(1 hunks)docs/docs/Components/components-tools.md(1 hunks)docs/docs/Get-Started/get-started-quickstart.md(1 hunks)docs/docs/Sample-Flows/sequential-agent.md(1 hunks)docs/docs/Starter-Projects/starter-projects-simple-agent.md(1 hunks)docs/sidebars.js(1 hunks)
💤 Files with no reviewable changes (2)
- docs/docs/Agents/agents-overview.md
- docs/docs/Agents/agent-tool-calling-agent-component.md
🧰 Additional context used
🪛 LanguageTool
docs/docs/Sample-Flows/sequential-agent.md
[grammar] ~54-~54: This noun or verb “problem-solving” is spelled with a hyphen.
Context: ...our own multi-agent flow, see Create a problem solving agent.
(PROBLEM_SOLVE_HYPHEN)
docs/docs/Get-Started/get-started-quickstart.md
[grammar] ~187-~187: Make sure that ‘use to’ is correct. For habitual actions in the past or to mean ‘accustomed to’, use “used to”.
Context: ...tabase the brain that Agents use to make decisions. Publish this flow as a...
(USE_TO_VERB)
docs/docs/Components/components-agents.md
[uncategorized] ~24-~24: Possible missing comma found.
Context: ...ow-simple-agent.png) For a multi-agent example see [Create a flow with an agent](/agen...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/docs/Agents/agents.md
[grammar] ~97-~97: This noun or verb “problem-solving” is spelled with a hyphen.
Context: ...nt-gpt-41, and edit the description to Use the gpt-4.1 model for complex problem solving`. The connected agent will understand t...
(PROBLEM_SOLVE_HYPHEN)
[uncategorized] ~201-~201: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...de=Trueto theMessageTextInput` input so the custom component can be used as a t...
(COMMA_COMPOUND_SENTENCE_2)
docs/docs/Components/components-bundles.md
[uncategorized] ~18-~18: Possible missing comma found.
Context: ... This component represents an Agent of CrewAI allowing for the creation of specialize...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~18-~18: A comma might be missing here.
Context: ...n of specialized AI agents with defined roles goals and capabilities within a crew. ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~188-~188: A comma might be missing here.
Context: ...reates a CrewAI Task and its associated Agent allowing for the definition of sequenti...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build-and-deploy
🔇 Additional comments (8)
docs/docs/Get-Started/get-started-quickstart.md (1)
187-187: Update Agents link to consolidated documentation.The reference now points to
/agentsinstead of the old overview page, aligning with the new structure.🧰 Tools
🪛 LanguageTool
[grammar] ~187-~187: Make sure that ‘use to’ is correct. For habitual actions in the past or to mean ‘accustomed to’, use “used to”.
Context: ...tabase the brain that Agents use to make decisions. Publish this flow as a...(USE_TO_VERB)
docs/docs/Components/components-tools.md (1)
28-28: Update example link to new Agents guide.The example now correctly references the consolidated Agents page anchor
/agents#make-any-component-a-tool.docs/sidebars.js (1)
73-73: Consolidate Agents sidebar entries.Replaced separate overview and tool-calling entries with a single
"Agents/agents"item to match the new documentation file.docs/docs/Starter-Projects/starter-projects-simple-agent.md (1)
6-6: Simplify reference to Agent component.Updated terminology and link to use the unified
[Agent](/agents)component instead of the old tool-calling agent.docs/docs/Components/components-agents.md (3)
24-24: Approve updated multi-agent link.The updated link correctly points to the consolidated Agents documentation at
/agents.🧰 Tools
🪛 LanguageTool
[uncategorized] ~24-~24: Possible missing comma found.
Context: ...ow-simple-agent.png) For a multi-agent example see [Create a flow with an agent](/agen...(AI_HYDRA_LEO_MISSING_COMMA)
32-32: Approve updated Agent documentation link.This link now accurately directs users to the new unified Agents guide at
/agents.
43-43: Approve clarification of optionaltoolsinput.Adding “This field is optional and can be empty” clearly conveys that the tools list may be omitted.
docs/docs/Agents/agents.md (1)
8-15: LGTM: Clear introduction and component overview.The new Agents guide concisely explains the purpose and capabilities of the Agent component.
github-actions
Bot
added
documentation
aimurphy
left a comment
aimurphy
left a comment
There was a problem hiding this comment.
Left some ideas for you to consider about how the content is organized.
github-actions
Bot
added
documentation
|
Build successful! ✅ |
Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
github-actions
Bot
added
documentation
|
Build successful! ✅ |
github-actions
Bot
removed
the
documentation
This comment was marked as outdated.
This comment was marked as outdated.
github-actions
Bot
added
documentation
|
Build successful! ✅ |
github-actions
Bot
added
documentation
|
Build successful! ✅ |
edwinjosechittilappilly
left a comment
edwinjosechittilappilly
left a comment
There was a problem hiding this comment.
Approving with a small change.
github-actions
Bot
added
documentation
|
Build successful! ✅ |
* changes-from-1.5 * initial-content * Apply suggestions from code review Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> * breakout-tools-config * Apply suggestions from code review Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> * docs-review * fix-broken-links * Apply suggestions from code review --------- Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
* changes-from-1.5 * initial-content * Apply suggestions from code review Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> * breakout-tools-config * Apply suggestions from code review Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> * docs-review * fix-broken-links * Apply suggestions from code review --------- Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
3 participants
Refresh agent documentation content. Preview build
Summary by CodeRabbit