Skip to main content
Glama

komga_series

Destructive

Query and manage Komga series, books, collections, metadata, and read progress through 16 actions, with dry-run previews for write operations until confirmed.

Instructions

komga_series covers the series toolset (16 operations). Auth is the X-API-Key header, or HTTP basic auth from KOMGA_USERNAME and KOMGA_PASSWORD. Self-hosted Komga only. action help with target returns one action's parameters. Writes need confirm set to the boolean true and KOMGA_ALLOW_WRITES=true. Omit confirm for a dry-run preview that sends nothing. Destructive, credential, or exposure actions add an extra warning in the preview and here: delete, scan, analyze, refresh, trash empty, user or role changes, API key create or revoke, password change, settings, session, and claim. Actions: delete_file, delete_read_progress, get, get_alphabetical_groups, get_books, get_collections, get_latest, get_new, get_series_id, get_updated, patch_metadata, post_analyze, post_list, post_list_alphabetical_groups, post_metadata_refresh, post_read_progress.

Input Schema

NameRequiredDescriptionDefault
bodyNoJSON body for the Komga operation. Secrets are redacted in output.
queryNoOpenAPI query parameters.
actionYesKomga operation to call, or help.
paramsNoOpenAPI path parameters, such as seriesId.
targetNoWith action help, the action whose parameters to describe.
confirmNoSet to the boolean true to execute the write. Omit this field for a dry-run preview. false and the string true are rejected.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior5/5

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

Annotations already declare destructiveHint=true and readOnlyHint=false, yet the description adds substantial context beyond them: the auth mechanism (X-API-Key or basic auth env vars), the self-hosted-only constraint, the double gate for writes, the no-op dry-run preview, and an explicit list of actions that trigger extra warnings. This is exactly the extra behavioral detail the annotations cannot convey.

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

Conciseness4/5

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

Dense but front-loaded: auth and write-safety come before the action enumeration, which suits a 16-operation dispatcher. There is minor redundancy ('in the preview and here') and the action list is long, but every clause carries operational information.

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?

With no output schema, the description compensates by explaining the `help` action as the discovery path for per-action parameters. It does not describe return shapes for read actions or pagination, which a dispatch tool of this breadth could note, but the core call-time requirements (auth, confirm gate, params/query/body) are all covered.

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, but the description adds cross-parameter meaning the schema cannot: `target` is only meaningful together with `action: help`, and `confirm` omission specifically means a preview that sends nothing. The mapping of `params`/`query`/`body` to path/query/body is left to the schema.

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 states it is the series toolset covering 16 operations and enumerates every action, so an agent can tell it apart from komga_books/komga_collections by resource scope. The opening verb phrase ('covers the series toolset') is a bit abstract and never explicitly routes against named siblings, but the action list makes the resource domain unambiguous.

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

Usage Guidelines4/5

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

It gives clear workflow guidance: use `action help` with `target` to discover an action's parameters, omit `confirm` for a dry-run, and set both `confirm: true` and KOMGA_ALLOW_WRITES=true to execute. It also flags which action families are destructive. It stops short of saying when to prefer a sibling tool (e.g. komga_books for book-level queries).

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