Skip to main content
Glama

komga_readlists

Destructive

Manage Komga readlists by retrieving, creating, updating, or deleting them, with dry-run previews and confirmation for write operations.

Instructions

komga_readlists covers the readlists toolset (5 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, get, get_id, patch, post.

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

B3.3/5.0
Behavior4/5

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

With destructiveHint=true and readOnlyHint=false already declared, the description still adds real value: auth mechanism (X-API-Key or basic auth env vars), the confirm/dry-run contract, that writes require KOMGA_ALLOW_WRITES=true, that secrets are redacted in output, and that destructive/credential actions get an extra preview warning. This is well beyond what annotations convey.

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 auth and write-safety rules are front-loaded, which is good, but the middle sentences are dense and the destructive-action enumeration lists operations (scan, analyze, trash empty, settings, session, claim) that are not in this tool's action enum, which reads as boilerplate and can mislead. The action list is tacked on at the end.

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 destructive 6-parameter dispatcher with nested body/query/params objects and no output schema, the description covers auth, the write gate, dry-run behavior, and discovery via help — enough for an agent to call it safely. What remains thin is per-action semantics, but the help action is offered as the escape hatch for that.

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 description coverage is 100% and the confirm and target fields are documented in the schema itself, so the description's restatement of confirm semantics adds little. It does clarify the help+target pairing and note that body secrets are redacted, but the mapping of query/params fields to specific actions is not explained beyond pointing at the help action.

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

Purpose3/5

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

The description identifies the resource ('readlists toolset') and enumerates the actions (delete, get, get_id, patch, post), so an agent knows it dispatches Komga readlist operations. However, the opening sentence largely restates the tool name and never says what a readlist actually is or how these operations differ meaningfully from komga_collections or komga_books.

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 concrete procedural guidance: use action help with target to discover an action's parameters, writes require confirm:true plus KOMGA_ALLOW_WRITES, and omitting confirm yields a dry-run. What it does not do is say when to choose this tool over its siblings; the routing decision to komga_readlists vs komga_collections is left entirely to the reader.

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