Skip to main content
Glama

Set format

set_format
DestructiveIdempotent

Record 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

NameRequiredDescriptionDefault
titleNoThe title (exact title preferred; an ambiguous partial match returns candidates with ids instead of guessing)
formatNoBooks: print, ebook, audiobook or ereader. Games: physical or digital.
storesNoMovies, shows, anime, albums: where a Digital copy lives, from the lists above (kept only with Digital in formats)
editionNoMovies, shows, anime, albums: an edition note such as "Criterion" or "2014 remaster" (80 characters max); an empty string clears it
formatsNoMovies, shows, anime, albums, books: the physical/digital formats owned, from the lists above
item_idNoLibrary item id (UUID), as shown by get_details. When given, title is ignored and the row is addressed exactly.
seasonsNoShows 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.
platformNoGames only: one platform, e.g. PS5. Same as platforms with one entry; prefer platforms.
platformsNoGames only: every platform they have or play it on, e.g. ["PS5", "PC"]. Replaces the saved list; an empty list clears it.
media_typeNoType of media. Defaults to book. Podcasts, manga and comics take want_to_own only.
want_to_ownNoAny kind: true puts it on Want to own, false takes it off. Independent of status and of what they own.
hours_playedNoGames only: hours they have played it, e.g. 42.5. null clears it.
want_formatsNoAny 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_labelNoMovies: "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_spineNoWith edition_label "criterion": which known release, when a movie has more than one (its own number, or the box set it is in).
full_completionNoGames only: true when they did everything in it (100%), not just reached the credits; false takes the mark off. Status stays played.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / edition_label
      Added value: +{
      +  "description": "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.",
      +  "type": "string"
      +}
    • addedInput schema / properties / edition_spine
      Added value: +{
      +  "description": "With edition_label \"criterion\": which known release, when a movie has more than one (its own number, or the box set it is in).",
      +  "type": "number"
      +}
  2. Changed1 schema field changed
    • addedInput schema / properties / full_completion
      Added value: +{
      +  "description": "Games only: true when they did everything in it (100%), not just reached the credits; false takes the mark off. Status stays played.",
      +  "type": "boolean"
      +}
  3. Changed5 schema fields changed
    • changedInput schema / properties / formats / description
      Previous value: -"Movies, shows, anime, albums: the physical/digital formats owned, from the lists above"New value: +"Movies, shows, anime, albums, books: the physical/digital formats owned, from the lists above"
    • changedInput schema / properties / media_type / description
      Previous value: -"Type of media. Defaults to book."New value: +"Type of media. Defaults to book. Podcasts, manga and comics take want_to_own only."
    • changedInput schema / properties / media_type / enum
      Previous value: -[
      -  "book",
      -  "movie",
      -  "show",
      -  "anime",
      -  "album",
      -  "game"
      -]New value: +[
      +  "book",
      +  "movie",
      +  "show",
      +  "anime",
      +  "album",
      +  "game",
      +  "podcast",
      +  "manga",
      +  "comic"
      +]
    • addedInput schema / properties / want_formats
      Added value: +{
      +  "description": "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.",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / properties / want_to_own
      Added value: +{
      +  "description": "Any kind: true puts it on Want to own, false takes it off. Independent of status and of what they own.",
      +  "type": "boolean"
      +}
  4. Changed2 schema fields changed
    • changedInput schema / properties / platform / description
      Previous value: -"Games only: the platform they play it on, e.g. PS5, Switch, PC"New value: +"Games only: one platform, e.g. PS5. Same as platforms with one entry; prefer platforms."
    • addedInput schema / properties / platforms
      Added value: +{
      +  "description": "Games only: every platform they have or play it on, e.g. [\"PS5\", \"PC\"]. Replaces the saved list; an empty list clears it.",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
  5. Changed1 schema field changed
    • addedInput schema / properties / hours_played
      Added value: +{
      +  "description": "Games only: hours they have played it, e.g. 42.5. null clears it.",
      +  "type": [
      +    "number",
      +    "null"
      +  ]
      +}
  6. Changed1 schema field changed
    • addedInput schema / properties / seasons
      Added value: +{
      +  "description": "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.",
      +  "items": {
      +    "minimum": 0,
      +    "type": "integer"
      +  },
      +  "type": "array"
      +}
  7. Changed10 schema fields changed
    • addedInput schema / properties / edition
      Added value: +{
      +  "description": "Movies, shows, anime, albums: an edition note such as \"Criterion\" or \"2014 remaster\" (80 characters max); an empty string clears it",
      +  "type": "string"
      +}
    • changedInput schema / properties / format / description
      Previous value: -"How the user read it"New value: +"Books: print, ebook, audiobook or ereader. Games: physical or digital."
    • changedInput schema / properties / format / enum
      Previous value: -[
      -  "print",
      -  "ebook",
      -  "audiobook",
      -  "ereader"
      -]New value: +[
      +  "print",
      +  "ebook",
      +  "audiobook",
      +  "ereader",
      +  "physical",
      +  "digital"
      +]
    • addedInput schema / properties / formats
      Added value: +{
      +  "description": "Movies, shows, anime, albums: the physical/digital formats owned, from the lists above",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / properties / item_id
      Added value: +{
      +  "description": "Library item id (UUID), as shown by get_details. When given, title is ignored and the row is addressed exactly.",
      +  "type": "string"
      +}
    • addedInput schema / properties / media_type
      Added value: +{
      +  "description": "Type of media. Defaults to book.",
      +  "enum": [
      +    "book",
      +    "movie",
      +    "show",
      +    "anime",
      +    "album",
      +    "game"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / platform
      Added value: +{
      +  "description": "Games only: the platform they play it on, e.g. PS5, Switch, PC",
      +  "type": "string"
      +}
    • addedInput schema / properties / stores
      Added value: +{
      +  "description": "Movies, shows, anime, albums: where a Digital copy lives, from the lists above (kept only with Digital in formats)",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • changedInput schema / properties / title / description
      Previous value: -"The book title (partial match supported)"New value: +"The title (exact title preferred; an ambiguous partial match returns candidates with ids instead of guessing)"
    • changedInput schema / required
      Previous value: -[
      -  "title",
      -  "format"
      -]New value: +[]
  8. Added

TDQS

A3.9/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations declare destructiveHint=true and idempotentHint=true, and the description earns real credit beyond that: it spells out exactly what is destroyed ('formats and stores replace the saved lists; an empty list clears them'), an implicit side effect ('adding an owned copy in a wanted format takes it off Want to own'), and an explicit non-effect ('never change a status because of it'). These are precisely the behavioral facts an agent needs before mutating stored state.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The single most important rule (ownership is separate from status) is correctly front-loaded, but the rest is one long undivided block in which critical rules about want_to_own and want_formats arrive only at the very end. The media-type-by-media-type enumeration is efficient per line yet dense and hard to scan; paragraph breaks or a bulleted structure would improve it without adding length.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 16-parameter mutation tool with no output schema, the description covers the semantic relationships an agent most needs across every supported media type, plus replace/clear semantics for the list fields. Remaining gaps (title-versus-item_id resolution behavior, error handling, what the response contains) are covered by the schema or are minor for a setter tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3; the description goes beyond it by enumerating the actual permitted values for the free-string array parameters (formats, stores) that the schema leaves vague as 'from the lists above'. It also clarifies the format-versus-formats distinction for books and that stores are 'kept only with Digital in formats' – meaning the schema could not have been applied correctly without this text.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific verb and resource: 'Record how the user has or consumes an item, and whether they want to own it,' and immediately scopes what the tool covers per media type. It is clearly a per-media-type metadata writer, though it never names a sibling it is not (e.g. set, edit_item, add_item), so an agent must infer differentiation from the field vocabulary alone.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives strong per-kind guidance ('Books (the default media_type): ...', 'Games: format = physical or digital ...', 'Podcasts, manga and comics take want_to_own only'), which tells an agent what to supply for each case. But there is no explicit when-to-use-this-versus-another-tool guidance against the large sibling set, and the default media_type=book is only stated in the body, not front-loaded as a routing rule.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources