Task/actions agents

[aralyekta]

Summary by CodeRabbit

• Documentation
  • Enhanced Actions guide with new sections on scheduling configuration, testing procedures, and action execution history with detailed tracking information.
  • Added comprehensive Agents guide covering agent creation, management, integration, and best practices.
  • Expanded navigation to include new Agents documentation for easier discovery.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Documentation expansion for the Guides section, including enhancements to the Actions guide with scheduling, testing, and history details, introduction of a new Agents guide covering agent creation and management, and corresponding navigation updates in the site configuration.

Changes

Cohort / File(s)	Summary
Documentation Updates guides/actions.mdx, guides/agents.mdx, mint.json	Updated Actions guide with new subsections for scheduling configuration, testing, and Actions History details. Introduced comprehensive new Agents guide covering overview, creation, management, integration examples, and common pitfalls. Added navigation entry for agents guide.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Verify image references (usage-instructions.png) are correct and accessible
• Confirm new Agents guide content for accuracy and completeness
• Check navigation entry in mint.json is properly positioned under Guides group and follows existing structure conventions

Possibly related PRs

• Task/actions #43: Extends the same guides/actions.mdx file with overlapping documentation about scheduling, testing, history, and UI details.
• Add docs for actions #48: Modifies guides/actions.mdx with related documentation updates covering testing, secrets management, and action configuration.

Pre-merge checks

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Task/actions agents' is vague and doesn't clearly convey the main changes. It uses generic task naming convention rather than describing the actual content added (new Agents guide and Actions documentation updates).	Revise the title to be more descriptive of the changes, such as 'Add Agents guide documentation and expand Actions guide' to better reflect the primary changes to documentation.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

guides/actions.mdx (1)

85-103: Structure is clear, but verify Testing section completeness.

The new Scheduling and Testing subsection (lines 85-103) is well-structured with cron examples. However, the Testing paragraph (lines 99-102) appears incomplete—it reads as a continuation of the Usage Instructions section rather than a standalone subsection. Consider adding a subheading **Testing Actions:** to parallel the Scheduling heading for consistency.

 **Testing:**
+**Testing Actions:**
 - Use the "Test Action" button to verify your configuration
   - If required parameters exist, you'll be prompted to provide test values
   - Test results show success status, response data, and execution details

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7122bb6 and b9acd79.

⛔ Files ignored due to path filters (17)

• images/guides/actions/actions-history-details.png is excluded by !**/*.png
• images/guides/actions/actions-history.png is excluded by !**/*.png
• images/guides/actions/actions-page.png is excluded by !**/*.png
• images/guides/actions/scheduling.png is excluded by !**/*.png
• images/guides/actions/usage-instructions-with-test.png is excluded by !**/*.png
• images/guides/actions/usage-instructions.png is excluded by !**/*.png
• images/guides/agents/basic-info.png is excluded by !**/*.png
• images/guides/agents/config.png is excluded by !**/*.png
• images/guides/agents/exec-details.png is excluded by !**/*.png
• images/guides/agents/exec-list.png is excluded by !**/*.png
• images/guides/agents/how-to-use-the-response.png is excluded by !**/*.png
• images/guides/agents/list.png is excluded by !**/*.png
• images/guides/agents/nested-display.png is excluded by !**/*.png
• images/guides/agents/openai-sdk.png is excluded by !**/*.png
• images/guides/agents/scheduling.png is excluded by !**/*.png
• images/guides/agents/selected-tools.png is excluded by !**/*.png
• images/guides/agents/tools-list.png is excluded by !**/*.png

📒 Files selected for processing (3)

• guides/actions.mdx (3 hunks)
• guides/agents.mdx (1 hunks)
• mint.json (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

**/*.mdx

📄 CodeRabbit inference engine (CLAUDE.md)

**/*.mdx: Use MDX format for all documentation files
Use Mintlify components like , , for rich content
Include practical examples and code snippets in documentation
Use images from /images/ directory for visual guides

Files:

• guides/agents.mdx
• guides/actions.mdx

mint.json

📄 CodeRabbit inference engine (CLAUDE.md)

mint.json: Navigation structure is defined in mint.json under the navigation key
mint.json contains all site configuration, navigation, and settings

Files:

• mint.json

🧠 Learnings (3)

📚 Learning: 2025-07-19T21:27:14.098Z

Learnt from: CR
Repo: Gurubase/gurubase-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-19T21:27:14.098Z
Learning: Applies to {guides/integrations/**/*.mdx,integrations/**/*.mdx} : Maintain consistent structure across similar pages (e.g., all integration guides follow the same format)

Applied to files:

• guides/agents.mdx

📚 Learning: 2025-07-19T21:27:14.098Z

Learnt from: CR
Repo: Gurubase/gurubase-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-19T21:27:14.098Z
Learning: Applies to mint.json : Navigation structure is defined in mint.json under the navigation key

Applied to files:

• mint.json

📚 Learning: 2025-07-19T21:27:14.098Z

Learnt from: CR
Repo: Gurubase/gurubase-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-19T21:27:14.098Z
Learning: Applies to mint.json : mint.json contains all site configuration, navigation, and settings

Applied to files:

• mint.json

🔇 Additional comments (10)

guides/actions.mdx (4)

171-171: Accurately describes schedule field addition.

The updated management description now includes schedule information in the actions list, which aligns with the new Scheduling feature introduced in lines 85-98. This change is consistent and helpful for users.

---

185-214: Actions History section is comprehensive and well-structured.

The new Actions History section (lines 185-214) provides clear documentation of the history feature with:

• Frame images for visual context
• Detailed field descriptions (Status, Action Name, Type, Source, etc.)
• Hierarchical detail view explaining Execution Info, Timing, Input/Output Data, and Config Snapshot
• Practical note linking history to debugging and verification workflows

No issues identified. The formatting and content clarity are strong.

---

77-79: Verify image asset /images/guides/actions/usage-instructions.png exists in the repository.

The image reference at line 78 was changed from usage-instructions-with-test.png to usage-instructions.png. Confirm that the new asset exists at /images/guides/actions/usage-instructions.png and accurately reflects the current UI state.

---

256-286: All internal hrefs in the Next Steps CardGroup are valid and properly configured in mint.json. The links to /guides/create-guru, /guides/data-sources, /guides/prompting-your-guru, and /api-reference/introduction all have corresponding entries in the navigation configuration.

mint.json (1)

63-63: Navigation entry for agents guide is correctly positioned.

The new guides/agents entry is properly inserted in the Guides section at line 63, maintaining alphabetical order (after guides/actions, before guides/multi-answer). The entry format is consistent with other navigation items.

guides/agents.mdx (5)

1-4: Frontmatter structure is correct.

The YAML frontmatter provides appropriate title and description for the Agents guide. The description accurately conveys the orchestration and decision-making capabilities.

---

24-32: How Agents Work section mirrors Actions structure well.

The 5-step orchestration system (Trigger check → Tool Selection → Execution → Nested Execution → Response Handling) follows the same conceptual framework as the actions.mdx "How Actions Work" section, which aids consistency. However, the naming and terminology should be verified to ensure they're distinct where appropriate (agents make autonomous decisions; actions execute single tasks).

Verify that the distinction between agent "decision-making" and action "execution" terminology is maintained consistently throughout both guides. The user experience should clearly differentiate these concepts.

---

193-209: Validate OpenAI SDK integration code example.

The Python code example (lines 193-209) demonstrates integration using OpenAI SDK. Ensure:

1. The base URL and model identifier format are correct for Gurubase
2. The user parameter is correctly documented for memory tracking
3. The example is tested and functional

Additionally, consider adding a note about obtaining the agent-specific model ID from the "View Code" button mentioned at line 211.

Verify that the OpenAI SDK integration endpoint and model format are accurate and match the current API specifications. Confirm the example code can be executed successfully with valid credentials.

---

213-227: Common Mistakes section effectively parallels Actions guide.

The 6 mistakes (Vague Trigger Conditions, Inadequate System Prompts, Too Many Tools, Incomplete Usage Instructions, Not Testing Agents, Excessive Nesting Depth, Missing Output Schema) provide practical guidance with ❌/✅ formatting consistent with actions.mdx. The mistakes are well-tailored to agent-specific concerns (system prompts, nesting depth, output schema).

---

229-260: All Next Steps card hrefs are valid and correctly configured in mint.json. The four paths (/guides/actions, /api-reference/introduction, /guides/create-guru, /guides/prompting-your-guru) all exist in the navigation structure and are properly formatted.

[coderabbitai]

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check what images actually exist in the directory
echo "=== Actual files in /images/guides/agents/ ==="
if [ -d "/images/guides/agents/" ]; then
  ls -1 /images/guides/agents/*.png 2>/dev/null | xargs -n1 basename | sort
  echo ""
  echo "Total files: $(ls -1 /images/guides/agents/*.png 2>/dev/null | wc -l)"
else
  echo "Directory does not exist"
fi

echo ""
echo "=== Checking if directory exists ==="
[ -d "/images/guides/agents/" ] && echo "Directory exists" || echo "Directory does not exist"

echo ""
echo "=== Directory structure ==="
find /images/guides/agents/ -type f 2>/dev/null | head -20

Repository: Gurubase/gurubase-docs

Length of output: 229

---

🏁 Script executed:

#!/bin/bash
# Extract all image references from guides/agents.mdx
echo "=== Image references in guides/agents.mdx ==="
if [ -f "guides/agents.mdx" ]; then
  grep -o 'src="/images/guides/agents/[^"]*"' guides/agents.mdx | sed 's/src="\/images\/guides\/agents\///' | sed 's/"$//' | sort | uniq
  echo ""
  echo "Total unique image references: $(grep -o 'src="/images/guides/agents/[^"]*"' guides/agents.mdx | sed 's/src="\/images\/guides\/agents\///' | sed 's/"$//' | sort | uniq | wc -l)"
else
  echo "File guides/agents.mdx not found"
fi

Repository: Gurubase/gurubase-docs

Length of output: 323

---

🏁 Script executed:

#!/bin/bash
# Check the overall images directory structure
echo "=== /images directory structure ==="
if [ -d "/images/" ]; then
  find /images/ -type d | sort
  echo ""
  echo "Total directories in /images/:"
  find /images/ -type d | wc -l
else
  echo "/images/ directory does not exist"
fi

echo ""
echo "=== Search for agent-related PNG files ==="
find . -name "*agent*" -type f 2>/dev/null | grep -i "\.png$"

echo ""
echo "=== Check if guides directory exists ==="
ls -la guides/ 2>/dev/null | head -10

Repository: Gurubase/gurubase-docs

Length of output: 800

---

Create /images/guides/agents/ directory and add all 11 missing image assets.

The /images directory structure does not exist in the repository. The guides/agents.mdx file references 11 image assets from /images/guides/agents/:

• list.png
• basic-info.png
• config.png
• selected-tools.png
• tools-list.png
• how-to-use-the-response.png
• scheduling.png
• exec-list.png
• nested-display.png
• exec-details.png
• openai-sdk.png

None of these files or directories are present. Create the directory structure and add all referenced image assets with exact filenames (case-sensitive).

🤖 Prompt for AI Agents

In guides/agents.mdx around lines 10-12 the document references 11 image assets
under /images/guides/agents/ that do not exist; create the directory
images/guides/agents/ in the repo and add the following image files with exact
case-sensitive filenames: list.png, basic-info.png, config.png,
selected-tools.png, tools-list.png, how-to-use-the-response.png, scheduling.png,
exec-list.png, nested-display.png, exec-details.png, openai-sdk.png; ensure
files are committed and paths match the MDX references exactly so the images
render.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Terminology inconsistency: Duration units differ between Agents and Actions guides.

Lines 155 (Agents) states: "Duration: Execution time in seconds"
Compare to actions.mdx line 198: "Duration: Execution time in milliseconds"

These units should be aligned. Verify which is correct for the actual UI, then update the documentation accordingly.

🤖 Prompt for AI Agents

In guides/agents.mdx around line 155, the "Duration" unit ("Execution time in
seconds") is inconsistent with actions.mdx (which uses milliseconds); check the
actual UI/implementation to confirm whether duration is reported in milliseconds
or seconds and update this line to the correct unit to match the UI; also search
and align other docs (actions.mdx and any related pages) so all guides use the
same unit and add a brief note if the UI displays variable units (e.g., ms for
<1s, s otherwise).