abs_series

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

The description adds substantial behavior beyond the annotations: authentication source, self-hosted-only constraint, write gating via confirm=true plus ABS_ALLOW_WRITES=true, and the dry-run default when confirm is omitted. These are important operational details that an agent would not infer from the annotations alone.

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

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

The description is compact and front-loaded: resource scope, auth, hosting constraint, help behavior, write/dry-run rules, and action enumeration. Every sentence carries operational information without repetition.

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

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

For a six-parameter wrapper with no output schema, the description covers the critical calling constraints: auth, action help, write confirmation, dry-run behavior, and available actions. It stops short of describing return values or error behavior, but the operational essentials are present.

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

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

Schema description coverage is 100%, so the schema already documents all parameters. The description still adds meaningful semantics for confirm (must be boolean true; omit for dry-run; false and string true are rejected) and for target with action help, exceeding the schema baseline.

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

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

The description states that abs_series covers the series toolset with exactly two operations, get_by_id and patch_by_id. This distinguishes it from sibling resource tools such as abs_items and abs_authors, though it does not explicitly gloss what each operation does beyond the action names.

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

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

It gives clear operational context: Authorization Bearer from ABS_API_TOKEN, self-hosted Audiobookshelf only, and how to use action help with target. It also states the write confirmation rule and that omitting confirm produces a dry-run preview. It does not explicitly route between sibling tools, but the series scope is clear.

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