Skip to main content
Glama

Download a shared deck

download_shared_deck

Download an AnkiWeb shared deck as an .apkg file to a chosen directory and get the saved file path. Existing files are preserved by saving new downloads under a numbered name.

Instructions

Download a shared deck's .apkg from AnkiWeb to disk and return where it was saved. An existing file is never replaced: the new one gets a numbered name. Works without an AnkiWeb session until AnkiWeb asks for one, which it does after a few downloads; then the signed-in session is used. via says which one the download went through. AnkiWeb licenses shared decks for personal use only.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "deck": "<deck>"
    },
    "name": "download_shared_deck"
  }
}

Input Schema

NameRequiredDescriptionDefault
deckYesThe shared deck's id, or its https://ankiweb.net/shared/info/<id> link.
accountNoOmit unless the user names an AnkiWeb account. Which of the accounts signed in on this machine to act as; a name that is not one is refused with the list.
directoryNoAn absolute path to an existing directory. Defaults to the server's own downloads directory.

Output Schema

NameRequiredDescriptionDefault
viaYes
deckYes
pathYes
bytesYes
filenameYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.0.5
    • addedInput schema / properties / account
      Added value: +{
      +  "description": "Omit unless the user names an AnkiWeb account. Which of the accounts signed in on this machine to act as; a name that is not one is refused with the list.",
      +  "type": "string"
      +}
    • addedOutput schema / properties / via
      Added value: +{
      +  "enum": [
      +    "anonymous",
      +    "session"
      +  ],
      +  "type": "string"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "path",
      -  "filename",
      -  "bytes",
      -  "deck"
      -]New value: +[
      +  "path",
      +  "filename",
      +  "bytes",
      +  "deck",
      +  "via"
      +]
  2. First observedv0.0.2

TDQS

A4/5.0
Behavior4/5

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

Adds real behavior beyond the annotations (readOnlyHint=false, openWorldHint=true, destructiveHint=false): existing files are never overwritten and get a numbered name, anonymous downloads work until AnkiWeb demands a session, and a licensing restriction on personal use. The only missing piece is the `via` value semantics being left implicit as an output field rather than explained.

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?

Four short sentences, each carrying distinct information, with the primary action and overwrite policy front-loaded. The session and licensing sentences are dense but not redundant.

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?

Given a mutation-ish download tool with an output schema and full parameter coverage, the description covers the notable behaviors an agent needs: non-overwrite file naming, session fallback, and licensing constraints. Nothing essential is missing.

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%, so all three parameters (deck id or URL, account name, absolute directory) are already documented in the schema. The description adds no parameter-level detail such as path behavior when `directory` is set, so the baseline 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?

States a specific verb, resource, format and outcome: downloads a shared deck's .apkg from AnkiWeb to disk and returns the saved path. An agent can distinguish it from get_shared_deck or search_shared_decks without opening any schema.

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?

Usage context is implied by the workflow detail (no session needed until AnkiWeb requests one, then the signed-in session is used) and by the account/directory parameters, but the description never says when to prefer this over get_shared_deck or what to do if the user just wants metadata. Alternatives are left to inference.

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