get_module_doc
Retrieve complete structured documentation for any Ansible module, including parameters, examples, and source details, with fallback to Galaxy for uninstalled collections.
Instructions
Get full structured documentation for one module.
Returns: module_name, short_description, params (list with name/type/required/default/choices/description/aliases), examples (raw YAML), is_api_module, doc_source ('local' or 'galaxy'). When doc_source is 'galaxy', also includes doc_version and optionally doc_warning. Falls back to Galaxy if collection is not installed locally. On failure returns {"error": str}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| module_name | Yes | Fully-qualified collection name (e.g. 'ansible.builtin.copy') |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |