francwa
2db3198ef2
Adds YAML specs for the 14 tools that were still description-from-docstring:
filesystem:
- set_path_for_folder, list_folder, analyze_release, probe_media,
move_media, manage_subtitles, create_seed_links, learn
api:
- find_media_imdb_id, find_torrent, get_torrent_by_index,
add_torrent_to_qbittorrent, add_torrent_by_index
language:
- set_language
Each spec follows the established shape (summary / description /
when_to_use / when_not_to_use / next_steps / parameters with
why_needed + example / returns) and the Python function docstring is
slimmed to a one-line pointer.
Registry now reports: 21 tools, 21 with YAML spec, 0 doc-only.
54 lines
1.7 KiB
YAML
54 lines
1.7 KiB
YAML
name: add_torrent_by_index
|
|
|
|
summary: >
|
|
Pick a torrent from the last find_torrent results by index and add
|
|
it to qBittorrent in one call.
|
|
|
|
description: |
|
|
Convenience wrapper that combines get_torrent_by_index +
|
|
add_torrent_to_qbittorrent. Looks up the torrent at the given
|
|
1-based index, extracts its magnet link, and sends it to
|
|
qBittorrent. The result mirrors add_torrent_to_qbittorrent's, with
|
|
the chosen torrent's name appended on success.
|
|
|
|
when_to_use: |
|
|
The default action after find_torrent when the user picks a hit by
|
|
number ("download the second one"). One call, two side effects:
|
|
episodic memory updated + download started.
|
|
|
|
when_not_to_use: |
|
|
- When the user only wants to inspect, not download — use
|
|
get_torrent_by_index.
|
|
- When the magnet comes from outside the search results — use
|
|
add_torrent_to_qbittorrent directly.
|
|
|
|
next_steps: |
|
|
- On status=ok: confirm the download started and end the workflow
|
|
if not already ended.
|
|
- On status=error (not_found): the index is out of range; show the
|
|
available count from episodic memory.
|
|
- On status=error (no_magnet): the search result was malformed —
|
|
suggest re-running find_torrent.
|
|
|
|
parameters:
|
|
index:
|
|
description: 1-based position of the torrent in the last find_torrent results.
|
|
why_needed: |
|
|
Identifies which torrent to add. Out-of-range indices return
|
|
not_found.
|
|
example: 3
|
|
|
|
returns:
|
|
ok:
|
|
description: Torrent was added to qBittorrent.
|
|
fields:
|
|
status: "'ok'"
|
|
message: Confirmation message.
|
|
torrent_name: Name of the torrent that was added.
|
|
|
|
error:
|
|
description: Failed to add.
|
|
fields:
|
|
error: Short error code (not_found, no_magnet, ...).
|
|
message: Human-readable explanation.
|