source/_integrations/music_assistant.markdown (3)

144-144: Fix grammar in description

There's a minor grammatical error in the description.

-  - **Description**: The Music Assistant instance that the searched will be performed upon. Allows for multiple servers to be running.
+  - **Description**: The Music Assistant instance that the search will be performed upon. Allows for multiple servers to be running.

---

185-185: Add missing comma in description

Add a comma after "selected" for better readability.

-  - **Description**: When selected only items marked as favorites will be returned.
+  - **Description**: When selected, only items marked as favorites will be returned.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~185-~185: Possible missing comma found.
Context: ...ional**: Yes. - Description: When selected only items marked as favorites will be ...

(AI_HYDRA_LEO_MISSING_COMMA)

---

200-202: Enhance the order_by parameter documentation

The reference to Developer Tools could be more specific to help users locate the options.

-  - **Description**: Sort the list by this field. The options are numerous so inspect them in the Developer Tools, Actions tab.
+  - **Description**: Sort the list by this field. View available sorting options in the Developer Tools > Services > music_assistant.get_library action.

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

source/_integrations/music_assistant.markdown (3)

138-170: Consider documenting the response format.

The documentation for the music_assistant.search action is well-structured, but it would be helpful to include information about the expected response format. This would help users understand what data they'll receive and how to handle it in their automations.

Consider adding a section like:

- **Example**: `true`
+  - **Example**: `true`
+
+#### Response format
+
+The action returns a dictionary containing search results grouped by media type:
+```yaml
+{
+  "tracks": [...],
+  "albums": [...],
+  "artists": [...],
+  "playlists": [...],
+  "radio": [...]
+}
+```

---

199-202: List available order_by options in the documentation.

Instead of directing users to check Developer Tools for available sorting options, it would be more user-friendly to list them directly in the documentation.

Consider expanding the documentation like:

- **Description**: Sort the list by this field. View available sorting options in the Developer Tools > Actions > music_assistant.get_library action.
+ **Description**: Sort the list by this field. Available options:
+   - For tracks: name, artist, album, duration, year
+   - For albums: name, artist, year
+   - For artists: name
+   - For playlists: name, owner
+   - For radio: name

---

212-220: Enhance the get_queue action documentation.

The documentation for the music_assistant.get_queue action could be more comprehensive. Consider adding:

1. The response format and structure
2. Any optional parameters if they exist
3. Example response payload

Consider expanding the documentation like:

  - **Example**: `media_player.kitchen_speaker`

+ #### Response format
+
+ The action returns the queue details including:
+ ```yaml
+ {
+   "current_item": {...},  # Currently playing item
+   "items": [...],         # List of queued items
+   "total_items": 10,      # Total number of items in queue
+   "current_index": 0      # Index of current item
+ }
+ ```

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro