fetch_rule_readme
Retrieve complete README documentation for compliance rules to understand usage instructions, prerequisites, and implementation steps for proper workflow integration.
Instructions
Retrieve README documentation for a specific rule by name.
Fetches the complete README documentation for a rule, providing detailed information about the rule's purpose, usage instructions, prerequisites, and implementation steps. This is useful for understanding how to properly use a rule in workflows.
Args: name (str): The exact name of the rule to retrieve README for
Returns: - readmeText (str): Complete README documentation as readable text - ruleName (str): Name of the rule for reference - error (str): Error message if retrieval fails or README not available
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| readmeText | No | ||
| ruleName | No | ||
| error | No |