Skip to main content
Glama
ni-c

audiobookshelf-mcp

by ni-c
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Get media progress

get_media_progress
Read-onlyIdempotent

Retrieve the current user's listening progress for any book or podcast episode, including position, percentage, and completion status. Returns an error if the item hasn't been started.

Instructions

The listening progress of the current user for one book or podcast episode: position, percentage and whether it is finished. Returns a 404 error when the item has never been started.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
detailNo"compact" (default) returns a projection with the fields that matter for browsing; "full" returns the raw Audiobookshelf object including audio files, tracks and chapters, which is very large.
episode_idNoPodcast episode id — required for podcast episodes, omitted for books
library_item_idYesLibrary item id, as returned by list_library_items or search_library

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
truncatedNoPresent only when the answer was shortened to fit the budget.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.4.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • addedInput schema / properties / episode_id / maxLength
      Added value: +128
    • addedInput schema / properties / library_item_id / maxLength
      Added value: +128
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": true,
+  "properties": {
+    "truncated": {
+      "additionalProperties": false,
+      "description": "Present only when the answer was shortened to fit the budget.",
+      "properties": {
+        "dropped_entries": {
+          "additionalProperties": {
+            "type": "number"
+          },
+          "propertyNames": {
+            "type": "string"
+          },
+          "type": "object"
+        },
+        "follow_up": {
+          "type": "string"
+        },
+        "reason": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "reason",
+        "dropped_entries",
+        "follow_up"
+      ],
+      "type": "object"
+    }
+  },
+  "type": "object"
+}
  2. First observedv0.1.1

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare read-only and idempotent behavior, but the description adds the specific 404 error response for unstarted items, which is not covered by annotations. This extra error-case detail improves transparency beyond the metadata.

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

Conciseness5/5

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

Two sentences, tightly worded, no redundancy. Efficiently conveys the resource, scope, and error behavior without extraneous detail.

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

Completeness5/5

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

For a simple read-only query, the description covers what the tool does, what it returns, and a key error case. Given the presence of an output schema and clear parameter descriptions, this is sufficient for an agent to call the tool correctly.

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

Parameters3/5

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

Schema coverage is 100% for all three parameters, each with clear descriptions (e.g., library_item_id as returned by list_library_items, episode_id for podcasts, detail enum). The tool description adds no additional parameter semantics beyond the schema, so the baseline of 3 applies.

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

Purpose5/5

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

Clearly states the resource (listening progress for the current user), the specific target (one book or podcast episode), and the returned data (position, percentage, finished status). Also mentions the 404 error case for unstarted items, leaving no ambiguity about the tool's core function.

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?

The description implies usage for checking a single item's progress but does not explicitly contrast with sibling tools like list_items_in_progress or set_media_progress. Without naming alternatives or conditions, an agent might not know when to choose this over similar progress-related tools.

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

Deploy Server

Other Tools