Documentation
¶
Overview ¶
Package main implements abs-mcp, an MCP server and CLI for curating an Audiobookshelf library.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cli implements the abs-mcp command line interface: the cobra commands, flag and config handling, and the MCP server exposing Audiobookshelf library tools to AI clients.
|
Package cli implements the abs-mcp command line interface: the cobra commands, flag and config handling, and the MCP server exposing Audiobookshelf library tools to AI clients. |
|
lib
|
|
|
audioprobe
Package audioprobe reads what an audio file's container says about it, a few kilobytes at a time: which container it really is, whatever its extension says, and whether its audio is locked to a store's player.
|
Package audioprobe reads what an audio file's container says about it, a few kilobytes at a time: which container it really is, whatever its extension says, and whether its audio is locked to a store's player. |
|
audiosample
Package audiosample reads stretches of a book's audio from an Audiobookshelf server: seconds or minutes from anywhere in the book, as mono PCM at the rate asked for, across its files in play order.
|
Package audiosample reads stretches of a book's audio from an Audiobookshelf server: seconds or minutes from anywhere in the book, as mono PCM at the rate asked for, across its files in play order. |
|
audiosample/calibration
command
Command calibration fetches the recordings item_compare_audio is calibrated on into a cache outside the repository, with the manifest the calibration test reads.
|
Command calibration fetches the recordings item_compare_audio is calibrated on into a cache outside the repository, with the manifest the calibration test reads. |
|
sdk
|
|
|
abs
Package abs is a typed client for Audiobookshelf API 2.37.1, generated by pandorest from the definitions in api-defs/audiobookshelf-2.37.1, which were imported from api-defs/audiobookshelf-openapi-2.37.1.json.
|
Package abs is a typed client for Audiobookshelf API 2.37.1, generated by pandorest from the definitions in api-defs/audiobookshelf-2.37.1, which were imported from api-defs/audiobookshelf-openapi-2.37.1.json. |
|
apicheck
command
Command apicheck reports how much of the Audiobookshelf API the API document covers, and fails when a route is missing.
|
Command apicheck reports how much of the Audiobookshelf API the API document covers, and fails when a route is missing. |
|
pandorest
command
Command pandorest generates sdk/abs with github.com/katbyte/pandorest from the Audiobookshelf API document under api-defs, which spec writes by reading the server's own source, because Audiobookshelf publishes no complete one.
|
Command pandorest generates sdk/abs with github.com/katbyte/pandorest from the Audiobookshelf API document under api-defs, which spec writes by reading the server's own source, because Audiobookshelf publishes no complete one. |
|
pandorest/answers
Package answers keeps what a real Audiobookshelf server answers, one file for each operation of the API document, so the document's types can be checked against, and filled from, what the server says rather than what its source suggests.
|
Package answers keeps what a real Audiobookshelf server answers, one file for each operation of the API document, so the document's types can be checked against, and filled from, what the server says rather than what its source suggests. |
|
Package tools defines the MCP tools exposed by abs-mcp, split by the resource they act on (server.go, libraries.go, items.go, ...).
|
Package tools defines the MCP tools exposed by abs-mcp, split by the resource they act on (server.go, libraries.go, items.go, ...). |
Click to show internal directories.
Click to hide internal directories.