Set format
set_formatRecord how the user has or consumes an item, and whether they want to own it. Ownership is separate from status: never change a status because of it. Books (the default media_type): format = how they read it (print, ebook, audiobook or ereader); formats = the copies they own (Hardcover, Paperback, Ebook, Audiobook) with an optional edition. Games: format = physical or digital, platforms (every one they have or play it on), hours_played, and/or full_completion (100% done). Movies, shows, anime and albums: the copies they own, as formats (movie/show/anime: 4K UHD, Blu-ray, DVD, VHS, LaserDisc, Digital; album: Vinyl, CD, Cassette, Digital), stores for a Digital copy (movie/show: Apple TV, Prime Video, Movies Anywhere, Google TV / YouTube, Fandango at Home, Microsoft Store; anime adds Crunchyroll Store; album: Bandcamp, iTunes, Amazon Music, Qobuz, 7digital) and an edition note. formats and stores replace the saved lists; an empty list clears them. Any kind: want_to_own true/false ("Want to own"), optionally want_formats from that kind's formats (games: Physical, Digital); adding an owned copy in a wanted format takes it off Want to own.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "set_format"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| title | No | The title (exact title preferred; an ambiguous partial match returns candidates with ids instead of guessing) | |
| format | No | Books: print, ebook, audiobook or ereader. Games: physical or digital. | |
| stores | No | Movies, shows, anime, albums: where a Digital copy lives, from the lists above (kept only with Digital in formats) | |
| edition | No | Movies, shows, anime, albums: an edition note such as "Criterion" or "2014 remaster" (80 characters max); an empty string clears it | |
| formats | No | Movies, shows, anime, albums, books: the physical/digital formats owned, from the lists above | |
| item_id | No | Library item id (UUID), as shown by get_details. When given, title is ignored and the row is addressed exactly. | |
| seasons | No | Shows only: the season numbers they own (0 = specials), e.g. [1, 2, 3] for seasons 1-3 on DVD. Replaces the saved list; an empty list means the copy is not split by season. | |
| platform | No | Games only: one platform, e.g. PS5. Same as platforms with one entry; prefer platforms. | |
| platforms | No | Games only: every platform they have or play it on, e.g. ["PS5", "PC"]. Replaces the saved list; an empty list clears it. | |
| media_type | No | Type of media. Defaults to book. Podcasts, manga and comics take want_to_own only. | |
| want_to_own | No | Any kind: true puts it on Want to own, false takes it off. Independent of status and of what they own. | |
| hours_played | No | Games only: hours they have played it, e.g. 42.5. null clears it. | |
| want_formats | No | Any kind with formats: the format(s) they want it in, e.g. ["Vinyl"] or ["4K UHD"]; games: Physical or Digital. Implies want_to_own. Replaces the saved list; [] means any format. | |
| edition_label | No | Movies: "criterion" when their copy is the Criterion Collection release; the spine number comes from what is known about the movie (get_details shows it) and the edition note is filled in unless you pass one. An empty string clears it, keeping the note. | |
| edition_spine | No | With edition_label "criterion": which known release, when a movie has more than one (its own number, or the box set it is in). | |
| full_completion | No | Games only: true when they did everything in it (100%), not just reached the credits; false takes the mark off. Status stays played. |