Explainer · Plain-language

Sword Protocol: Definition, Meaning & Examples | CASRAI

SWORD — Simple Web-service Offering Repository Deposit — is a standard protocol that allows one system to deposit content into a repository over the web, automatically and without manual upload. It is the deposit counterpart to harvesting protocols: where harvesting pulls metadata out of repositories, SWORD pushes content and metadata in. SWORD enables machine-to-machine workflows such as publishers depositing accepted manuscripts into institutional repositories, or a CRIS sending outputs to a repository on a researcher's behalf.

CASRAI plain-language explainers — clear answers to recurring research-administration questions

The step most authors miss

Doing CRediT right? Don’t stop at the statement.

A CRediT statement credits you inside one paper. The recognition CRediT was built for happens when those roles are tied to you, persistently. Sign in with your ORCID — free — and claim your CRediT contributions on casrai.org, the home of the standard. They become a verified, portable part of your identity, not a line that disappears into one PDF.

Free: claim your contributions, then export a journal-ready CRediT statement, schema.org structured data, JATS XML, CSV or BibTeX — and preview your public profile. A membership publishes that profile publicly and verifies the journals you serve.

What SWORD does

SWORD is a lightweight protocol for the act of deposit. It lets a "client" system (such as a publishing platform, a CRIS, or an authoring tool) send content — typically a file or package together with its metadata — to a "server" (a repository) using standard web requests, and receive back confirmation and the location of the newly created record. The value is automation. Without SWORD, getting a manuscript or dataset into a repository usually means a person logging in and uploading files by hand. With SWORD, that handover can happen automatically as part of a workflow, reducing effort and error and making it feasible to populate repositories at scale.

SWORD v2 and SWORDv3

The most widely implemented version is SWORD v2, supported by major repository platforms and used in many production deposit pipelines. It built on web standards to define how packages are submitted, updated, and (where permitted) removed. SWORDv3 is a later specification developed with the involvement of COAR (the Confederation of Open Access Repositories) and Jisc. It was designed to reflect how repositories and scholarly communication have evolved — richer content packaging, by-reference deposit, and clearer handling of complex objects — so that deposit remains robust as repository workflows grow more sophisticated.

Typical use cases

Several common workflows rely on SWORD. In publisher-to-repository deposit, a publishing platform can place the accepted or published version of an article directly into an author's institutional repository, supporting open-access compliance without manual rekeying. In CRIS-to-repository deposit, a Current Research Information System captures metadata once and then uses SWORD to push the associated full text into the repository it is paired with. And because the protocol is standardised, a single deposit action can fan out to multiple repositories — for example a subject repository and an institutional one — from one submission.

How SWORD relates to OAI-PMH and COAR Notify

SWORD is best understood alongside other repository protocols, because it solves a different problem. OAI-PMH (the Open Archives Initiative Protocol for Metadata Harvesting) is about harvesting: aggregators pull metadata out of repositories to build discovery services. SWORD is about deposit: pushing content into repositories. They are complementary halves of the metadata-and-content flow. SWORD also sits within the wider movement towards distributed, notification-based scholarly infrastructure. COAR Notify, for instance, uses standardised notifications to link repositories with review and overlay services. Together these standards aim to make repositories active participants in scholarly workflows rather than passive stores.

Key facts

At a glance

Full name: Simple Web-service Offering Repository Deposit (SWORD)
Purpose: Machine-to-machine deposit of content into repositories
Versions: SWORD v2 (widely deployed); SWORDv3 (developed with COAR and Jisc)
Direction: Push content in — the deposit counterpart to harvesting
Use cases: Publisher-to-repository, CRIS-to-repository, single-deposit-to-multiple-repositories
Relations: Complementary to OAI-PMH (harvesting); aligns with COAR Notify

Common misconceptions

What people often get wrong

Often heard: SWORD and OAI-PMH do the same job.

Actually: No — they are opposites in direction. SWORD pushes content and metadata into a repository (deposit), while OAI-PMH pulls metadata out of repositories for aggregators (harvesting). The two are complementary, not interchangeable.

Often heard: SWORD is only for depositing journal articles.

Actually: No — SWORD deposits packages of content and metadata of many kinds, including datasets and other outputs, into any repository that supports the protocol. The article-deposit case is common but not the limit of what SWORD can carry.

Often heard: SWORD requires a person to upload files manually.

Actually: No — the whole point of SWORD is automated, machine-to-machine deposit. It removes the manual upload step so that systems such as publishing platforms and CRISs can populate repositories without human intervention.

Going deeper