Add docs for actions

[aralyekta]

Summary by CodeRabbit

• Documentation
  • Updated Actions documentation to reflect expanded capabilities including Python code execution alongside API calls.
  • Restructured action creation workflow with clearer terminology and improved step-by-step guidance.
  • Added comprehensive Python code execution constraints, capabilities, and examples.
  • Enhanced secrets management guidance throughout documentation.
  • Improved testing and results documentation for both action types.

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

[coderabbitai]

Walkthrough

Comprehensive rewrite of the Actions guide documentation to support both Python code execution and API call actions. Updates include restructured workflow steps (Basic Information, Action Type Configuration, Usage Instructions), renamed terminology (Condition Prompt → When to Trigger This Action), expanded parameter configuration guidance, new Python execution constraints documentation, and integrated secret management guidance throughout.

Changes

Cohort / File(s)

Change Summary

Actions Guide Rewrite guides/actions.mdx

Expands Actions functionality from API calls only to include Python code execution. Reorganizes three-step workflow with new naming conventions. Documents Python execution environment constraints (isolation, whitelisted libraries, runtime limits). Adds dedicated sections for Python Code Actions, API Call Actions, and testing procedures. Replaces "Common Mistakes to Avoid" with "Secrets Management" topic covering encryption, retrieval, and naming conflicts. Updates parameter and API configuration sections with standardized naming, usage examples, and environment variable support. Removes API-only limitation references and enhances implementation guidance.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

• Content accuracy verification: Ensure all terminology changes (Condition Prompt → When to Trigger This Action, API Call and Response → Execution/Response Handling) are applied consistently across the entire document
• Completeness of new sections: Verify Python execution constraints section includes accurate library whitelisting, runtime limits, and isolation details
• Example validity: Review all new code snippets and configuration examples for accuracy and practical applicability
• Secret management guidance: Confirm encryption, retrieval, and conflict-handling instructions align with actual product behavior
• Cross-references: Validate that all internal document links and references remain accurate after section reorganization

Possibly related PRs

• Task/actions #43: Directly related expansion/rewrite of the same Actions guide that transitions from API-only documentation to dual support for Python code execution and API calls with restructured workflow steps.

Pre-merge checks

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Add docs for actions' is vague and generic. While it describes adding documentation, it doesn't convey what specific aspects of actions are being documented or what the substantive changes are.	Consider a more specific title that highlights the main change, such as 'Document Python code execution and API call actions' or 'Update actions documentation with Python code support.'

✅ 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: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ef30e0c and 22e82b3.

⛔ Files ignored due to path filters (13)

• images/guides/actions/actions-page.png is excluded by !**/*.png
• images/guides/actions/api-call-settings-1.png is excluded by !**/*.png
• images/guides/actions/api-call-settings-2.png is excluded by !**/*.png
• images/guides/actions/basic-action-fields.png is excluded by !**/*.png
• images/guides/actions/parameters.png is excluded by !**/*.png
• images/guides/actions/python.png is excluded by !**/*.png
• images/guides/actions/secrets.png is excluded by !**/*.png
• images/guides/actions/stage1-1.png is excluded by !**/*.png
• images/guides/actions/stage1-2.png is excluded by !**/*.png
• images/guides/actions/stage2-1.png is excluded by !**/*.png
• images/guides/actions/stage2-2.png is excluded by !**/*.png
• images/guides/actions/stage2-3.png is excluded by !**/*.png
• images/guides/actions/usage-instructions-with-test.png is excluded by !**/*.png

📒 Files selected for processing (1)

• guides/actions.mdx (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.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/actions.mdx

🔇 Additional comments (6)

guides/actions.mdx (6)

1-26: Well-structured overview with clear action type categorization.

The expanded description and new visual framing effectively communicate the dual capabilities (Python Code and API Call). The introduction clearly sets expectations for users.

---

37-87: Excellent restructuring with clear parameter guidance for both action types.

The new 3-step structure is logical and well-organized. The distinction between API parameter syntax ({parameter_name}) and Python environment variable access (os.environ.get()) is clearly explained. Testing instructions provide practical value.

---

88-148: Comprehensive action type documentation with clear examples.

Both Python Code and API Call subsections provide clear configuration guidance with practical constraints and examples. The Python example effectively demonstrates both parameter and secret access patterns, though the naming (GUESS + TEST) might benefit from a brief explanatory comment for clarity.

---

149-195: Clear action management and comprehensive secrets documentation.

The Managing Actions section is concise and actionable. The new Secrets Management section effectively centralizes guidance with strong security context (AES-256 encryption, masking). The cross-reference between action disabling and secret deletion (lines 167, 190) provides important operational clarity.

---

10-12: All image assets verified and present.

Verification confirms all 12 image references in guides/actions.mdx (lines 10-12, 40-41, 52-53, 59-60, 78-79, 98-99, 128-129, 132-133, 152-153, 162-163, 174-175, 182-183) exist in the images/guides/actions/ directory. No issues found.

---

196-240: All internal links verified and properly formatted.

Verification confirms all four Next Steps links are valid (api-reference/introduction, guides/create-guru, guides/data-sources, guides/prompting-your-guru). The Common Mistakes section provides clear, actionable guidance with good ❌/✅ contrasts, and the Next Steps section properly uses MDX CardGroup and Card components per documentation guidelines. No issues identified.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Fix terminology inconsistency in step 1 description.

Line 31 uses "Condition Prompt Evaluation" but the new field is called "When to Trigger This Action" (introduced on line 56). Update for consistency.

-1. **Condition Prompt Evaluation**: The Guru checks if the user's question matches your defined conditions (based on **When to Trigger This Action**)
+1. **When to Trigger This Action**: The Guru checks if the user's question matches your defined conditions

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	## How Actions Work
	Actions use an intelligent trigger system:
	1. **Condition Prompt Evaluation**: The Guru checks if the user's question matches your defined conditions (based on **Condition Prompt**)
	1. **Condition Prompt Evaluation**: The Guru checks if the user's question matches your defined conditions (based on **When to Trigger This Action**)
	2. **Parameter Extraction**: Parameters are extracted from the user's question based on your descriptions
	3. **Execution Decision**: The action runs only if all required parameters can be extracted (or have default values)
	4. **API Call and Response**: The configured API call is made, and the **Usage Prompt** instructs the AI how to use the response
	4. **Execution**: Python code runs in an isolated container, or an API call is made to the configured endpoint
	5. **Response Handling**: The **Usage Instructions** guide the AI on how to interpret and present the results
	## How Actions Work
	Actions use an intelligent trigger system:
	1. **When to Trigger This Action**: The Guru checks if the user's question matches your defined conditions
	2. **Parameter Extraction**: Parameters are extracted from the user's question based on your descriptions
	3. **Execution Decision**: The action runs only if all required parameters can be extracted (or have default values)
	4. **Execution**: Python code runs in an isolated container, or an API call is made to the configured endpoint
	5. **Response Handling**: The **Usage Instructions** guide the AI on how to interpret and present the results

🤖 Prompt for AI Agents

In guides/actions.mdx around lines 27 to 36, the step title "Condition Prompt
Evaluation" is inconsistent with the new field name "When to Trigger This
Action"; update the text in step 1 to use the exact new field name ("When to
Trigger This Action") so wording matches line 56, and make any inline
parenthetical reference consistent (e.g., replace "based on **When to Trigger
This Action**" with the same phrasing used elsewhere).