Skip to main content
Glama

Share a deck publicly

share_deck

Publishes a deck to AnkiWeb's public shared-deck catalogue after preview and confirmation, so others can find and download it.

Instructions

Publish one of the signed-in user's decks to AnkiWeb's public shared-deck catalogue, under their account. Anyone can then find and download it.

Without confirm, nothing is published: the call checks the deck and the listing against AnkiWeb's limits and returns a preview. Show that preview to the user and get their explicit go-ahead before calling again with confirm: true.

Calling with confirm: true publishes the deck and makes AnkiWeb's declaration on the user's behalf: "I declare that the material I am sharing is entirely my own work, or I have obtained a license from the intellectual property holder(s) to share it here."

With more than one AnkiWeb account stored, the preview names the one it publishes from, and the confirmed call must name it in account.

A deck that is already shared is refused. Needs an AnkiWeb session.

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": "share_deck"
  }
}

Input Schema

NameRequiredDescriptionDefault
deckYesThe deck's id or its exact full name, as list_my_decks gives them.
tagsNoUp to 60 characters in all, joined by spaces.
titleNoThe listing's title, up to 60 characters. Required unless AnkiWeb has one from an earlier share.
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.
confirmNotrue publishes. Only after the user has seen the preview and agreed.
supportUrlNoA page where users can ask about the deck, up to 180 characters.
descriptionNoMarkdown, up to 65000 characters. Required unless AnkiWeb has one from an earlier share.

Output Schema

NameRequiredDescriptionDefault
urlNo
deckYes
tagsYes
titleYes
statusYes`pending` means AnkiWeb accepted the share and is still processing it.
accountNoThe account it publishes from, given when more than one is stored.
problemsYesEach one blocks publishing until it is fixed.
sharedIdNo
supportUrlYes
descriptionYes
sharesPerWeekYes
sharesInLast7DaysYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 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 / account
      Added value: +{
      +  "description": "The account it publishes from, given when more than one is stored.",
      +  "type": "string"
      +}
  2. First observedv0.0.2

TDQS

A4.6/5.0
Behavior4/5

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

Annotations mark this as a non-read-only, open-world, non-idempotent but non-destructive write; the description goes well beyond them by disclosing the dry-run gate, the legal declaration made on the user's behalf, the refusal of already-shared decks, and the auth prerequisite. It does not describe rate limiting or what the preview contains, which keeps it off a 5.

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

Conciseness5/5

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

Front-loads the publish action and the blast radius, then the confirm gate, then edge cases and prerequisites in short separate paragraphs. The quoted declaration is long but is material to the consent step, so it earns its place.

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 an output schema present the return values need no explanation, and annotations plus full schema coverage plus the description of the preview/confirm flow cover nearly everything. The only gap is what the preview itself shows and whether an unpublished preview consumes any state.

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 already 100%, so the baseline is 3, but the description adds real workflow meaning: `confirm` is a consent gate rather than a plain boolean, and `account` only becomes mandatory when more than one AnkiWeb account is stored and must match the account the preview named. `deck`, `title`, `description`, `tags`, and `supportUrl` semantics remain with the schema.

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 and resource — publish one of the signed-in user's decks to AnkiWeb's public shared-deck catalogue under their account — plus the consequence: anyone can find and download it. This is unmistakably distinct from sibling tools like unshare_deck or list_my_shared_decks.

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

Usage Guidelines5/5

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

Gives an explicit two-phase workflow: without `confirm` it only previews, the preview must be shown to the user and approved before calling again with `confirm: true`. It also states the exclusion cases — already-shared decks are refused, multiple stored accounts require naming one in `account`, and an AnkiWeb session is required.

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