Unpaywall MCP Server
Unpaywall MCP-Server
Ein MCP-Server (Model Context Protocol), der Unpaywall-Tools bereitstellt, damit KI-Clients:
Metadaten per DOI abrufen
Artikeltitel durchsuchen
Die besten OA-Volltext-Links abrufen
Text aus OA-PDFs herunterladen und extrahieren können
Schnellstart (npx)
Fügen Sie dies Ihrer MCP-Client-Konfiguration hinzu (Beispiel Claude Desktop):
{
"mcpServers": {
"unpaywall": {
"command": "npx",
"args": ["-y", "unpaywall-mcp"],
"env": { "UNPAYWALL_EMAIL": "you@example.com" }
}
}
}Testen Sie dann die Tools: unpaywall_search_titles, unpaywall_get_fulltext_links, unpaywall_fetch_pdf_text.
Sie müssen dieses Repository nicht klonen oder npm install ausführen — npx kümmert sich beim ersten Aufruf um das Abrufen und Zwischenspeichern.
Related MCP server: ScholarScope MCP
Anforderungen
Node.js 18+ (für
npx)Eine E-Mail-Adresse für Unpaywall- / OpenAlex-Anfragen (von Unpaywall erforderlich, wird für den OpenAlex-Polite-Pool verwendet).
Lokale Entwicklung (nur für Mitwirkende)
Endbenutzer sollten die obige npx-Konfiguration verwenden. Mitwirkende, die aus dem Quellcode bauen:
npm install
npm run build
UNPAYWALL_EMAIL=you@example.com npm start # stdio transport, as required by MCP clientsHot-Run (ohne Build-Schritt):
UNPAYWALL_EMAIL=you@example.com npm run devTools
unpaywall_get_by_doi
Beschreibung: Ruft Unpaywall-Metadaten für eine DOI ab
Eingabeschema:
doi(string, erforderlich): z. B.10.1038/nphys1170email(string, optional): überschreibtUNPAYWALL_EMAIL, falls angegeben
Ausgabe: JSON-Antwort von Unpaywall
unpaywall_search_titles
Beschreibung: Durchsucht Artikeltitel und gibt Unpaywall-artige OA-Metadaten für jeden Treffer zurück (50 Ergebnisse/Seite)
Eingabeschema:
query(string, erforderlich): Titelsucheis_oa(boolean, optional): wenn true, nur OA-Ergebnisse; wenn false, nur geschlossene; weglassen für allepage(integer >= 1, optional): Seitennummeremail(string, optional): überschreibtUNPAYWALL_EMAIL
Ausgabe: JSON, das dem Unpaywall-Suchformat entspricht —
results[].responseist ein DOI-artiger Datensatz (doi,title,is_oa,oa_status,best_oa_location,oa_locations), mitscoreundsnippetpro Ergebnis._source: "openalex"markiert den Upstream.Hinweis: Unterstützt durch den
/works-Endpunkt von OpenAlex, da Unpaywalls eigenes/v2/searchseit der Überarbeitung im Mai 2025 HTTP 500 zurückgibt. Unpaywall fungiert jetzt als Unterroutine von OpenAlex, daher ist dies das kanonische moderne Äquivalent.
unpaywall_get_fulltext_links
Beschreibung: Gibt die beste OA-PDF-URL und Open-URL für eine DOI sowie alle OA-Standorte zurück
Eingabeschema:
doi(string, erforderlich)email(string, optional): überschreibtUNPAYWALL_EMAIL
Ausgabe: JSON mit den Feldern:
best_pdf_url,best_open_url,best_oa_location,oa_locationsund ausgewählten Metadaten
unpaywall_fetch_pdf_text
Beschreibung: Lädt Text aus dem besten OA-PDF für eine DOI herunter und extrahiert ihn, oder von einer bereitgestellten
pdf_urlEingabeschema:
pdf_url(string, optional): direkte PDF-URL (hat Vorrang)doi(string, optional): wird verwendet, um das beste OA-PDF aufzulösen, falls keinepdf_urlbereitgestellt wurdeemail(string, optional): erforderlich, wenndoiverwendet wird und keineUNPAYWALL_EMAIL-Umgebungsvariable gesetzt isttruncate_chars(integer >= 1000, optional): maximale Anzahl der zurückzugebenden Zeichen des extrahierten Textes (Standard 20000)
Ausgabe: JSON mit
text(möglicherweise gekürzt),length_chars,truncated,pdf_urlund PDF-Metadaten
Tipps für LLM-Prompts (MCP)
Wenn Sie diesen Server von einem MCP-fähigen LLM-Client aus verwenden, bitten Sie das Modell:
Suchen und dann abrufen: Verwenden Sie
unpaywall_search_titlesmit einem prägnanten Titel-Ausdruck; wählen Sie ein Ergebnis aus; rufen Sie dannunpaywall_get_fulltext_linksoderunpaywall_fetch_pdf_textfür die gewählte DOI auf.OA bevorzugen: Übergeben Sie
is_oa: truebei Suchen, wenn Sie nur Open-Access-Ergebnisse wünschen.Größe kontrollieren: Setzen Sie
truncate_charsinunpaywall_fetch_pdf_text(Standard 20000) und fassen Sie lange Texte zusammen, bevor Sie fortfahren.Resilient sein: Wenn die beste PDF-URL fehlt, greifen Sie auf
best_open_urlzurück und extrahieren Sie Inhalte von der Landingpage (außerhalb dieses Servers).Ratenbegrenzungen respektieren: Lassen Sie bei vielen Anfragen Zeit zwischen den Aufrufen; verwenden Sie frühere Antworten wieder, anstatt denselben Aufruf zu wiederholen.
Gute Benutzeranweisungen für das LLM:
"Finde 3 OA-Arbeiten über 'foundation models in biomedicine', extrahiere dann die Einleitung der besten Arbeit und fasse sie zusammen."
"Suche nach 'Graph Neural Networks survey 2024', filtere nach Möglichkeit auf OA, rufe dann den PDF-Text ab und erstelle eine Zusammenfassung mit 10 Stichpunkten."
Beispiel-Tool-Call-Payloads
Je nach MCP-Client unterscheidet sich die Struktur; die Kern-Payloads sind:
// Search titles
{
"name": "unpaywall_search_titles",
"arguments": {
"query": "graph neural networks survey",
"is_oa": true,
"page": 1
}
}// Get best OA links for a DOI
{
"name": "unpaywall_get_fulltext_links",
"arguments": {
"doi": "10.48550/arXiv.1812.08434"
}
}// Fetch and extract PDF text (by DOI)
{
"name": "unpaywall_fetch_pdf_text",
"arguments": {
"doi": "10.48550/arXiv.1812.08434",
"truncate_chars": 20000
}
}Konfiguration in einem MCP-Client
Empfohlene (No-Build) Konfiguration für Claude Desktop unter Verwendung von npm/npx:
{
"mcpServers": {
"unpaywall": {
"command": "npx",
"args": ["-y", "unpaywall-mcp"],
"env": {
"UNPAYWALL_EMAIL": "you@example.com"
}
}
}
}Alternative (lokales Repo) Konfiguration unter Verwendung des kompilierten dist:
{
"mcpServers": {
"unpaywall": {
"command": "node",
"args": ["/absolute/path/to/dist/index.js"],
"env": {
"UNPAYWALL_EMAIL": "you@example.com"
}
}
}
}Nach dem Hinzufügen bitten Sie Ihren Client, die Tools aufzulisten und zu testen:
unpaywall_search_titlesmit einerqueryunpaywall_get_fulltext_linksmit einerdoiunpaywall_fetch_pdf_textmit einerdoi(oderpdf_url)
Hinweise
Respektieren Sie die Ratenbegrenzungen und Nutzungsrichtlinien von Unpaywall: https://unpaywall.org/products/api
Der Server verwendet stdio-Transport und
@modelcontextprotocol/sdk.Setzen Sie
UNPAYWALL_EMAILoder übergeben Sieemailpro Aufruf, damit Unpaywall Sie bezüglich der Nutzung kontaktieren kann.
Maintainer: Veröffentlichung auf npm
# 1) Build the project (also runs automatically on publish)
npm run build
# 2) Bump version (choose patch/minor/major)
npm version patch
# 3) Publish (ensure you are logged in: npm login)
npm publish --access public
# 4) Tag a release on GitHub (optional, recommended)Benutzer können dann ihren MCP-Client mit npx -y unpaywall-mcp wie oben gezeigt konfigurieren. Kein Klonen oder Build erforderlich.
Available Tools
4 toolsunpaywall_fetch_pdf_textA
Download and extract text from best OA PDF for a DOI, or from a provided PDF URL.
| Name | Required | Description | Default |
|---|---|---|---|
| doi | No | DOI string or DOI URL. Used if pdf_url is not provided. | |
| pdf_url | No | Direct PDF URL to download and parse (takes precedence over DOI). | |
| No | Email to identify requests to Unpaywall (required when resolving via DOI). | ||
| truncate_chars | No | Max characters of extracted text to return (default 20000). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions key behaviors like downloading, extracting text, and precedence rules, but lacks details on error handling, rate limits, authentication needs (beyond the email parameter), or what 'best OA PDF' means. This provides basic context but is incomplete for a tool with potential external dependencies.
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 a single, efficient sentence that front-loads the core purpose ('Download and extract text') and includes essential qualifiers. Every word earns its place, with no wasted text, making it highly concise and well-structured.
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?
Given no annotations and no output schema, the description provides basic purpose and parameter context but lacks completeness. It doesn't explain return values (e.g., text format, error responses) or behavioral details like rate limits, which are important for a tool interacting with external services. This is adequate but has clear gaps for effective agent use.
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 fully documents all parameters. The description adds no additional semantic meaning beyond what's in the schema (e.g., it doesn't explain format details or usage nuances). This meets the baseline for high schema coverage but doesn't enhance parameter understanding.
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 clearly states the action ('Download and extract text') and the resource ('best OA PDF for a DOI, or from a provided PDF URL'), making the purpose understandable. However, it doesn't explicitly differentiate from sibling tools like 'unpaywall_get_fulltext_links' which might provide links rather than extracted text, so it misses full sibling distinction.
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?
The description implies usage by mentioning alternatives ('DOI, or from a provided PDF URL') and precedence rules ('pdf_url takes precedence over DOI'), but it doesn't explicitly state when to use this tool vs. siblings like 'unpaywall_get_by_doi' or provide clear exclusions. This leaves some ambiguity in tool selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
unpaywall_get_by_doiA
Fetch Unpaywall metadata for a DOI (accepts DOI, DOI URL, or 'doi:' prefix). Requires an email address via env UNPAYWALL_EMAIL or the optional 'email' argument.
| Name | Required | Description | Default |
|---|---|---|---|
| doi | Yes | DOI string or DOI URL, e.g. 10.1038/nphys1170 or https://doi.org/10.1038/nphys1170 | |
| No | Email to identify your requests to Unpaywall (optional override) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden. It discloses key behavioral traits: the tool requires an email address (via env or argument) for identification to Unpaywall, implying authentication needs. However, it lacks details on rate limits, error handling, or response format, leaving gaps in behavioral context.
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 appropriately sized and front-loaded, with two sentences that efficiently convey purpose, input formats, and requirements without any wasted words. Every sentence adds essential information, making it highly concise and well-structured.
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?
Given the tool's moderate complexity (2 parameters, no output schema, no annotations), the description is adequate but incomplete. It covers authentication needs and input formats but lacks details on output (metadata structure), error cases, or performance constraints, which would be helpful for an AI agent.
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 both parameters thoroughly. The description adds minimal value beyond the schema by mentioning the 'doi:' prefix as an accepted format and noting the email requirement, but does not provide additional syntax or usage details for parameters.
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 clearly states the specific action ('Fetch Unpaywall metadata') and resource ('for a DOI'), distinguishing it from sibling tools like fetching PDF text or searching titles. It specifies the exact input formats accepted (DOI, DOI URL, or 'doi:' prefix), making the purpose unambiguous.
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?
The description provides clear context on when to use this tool (for fetching metadata by DOI) and mentions an alternative (using the 'email' argument vs. env variable), but does not explicitly state when not to use it or differentiate from siblings like 'unpaywall_get_fulltext_links' beyond the metadata focus.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
unpaywall_get_fulltext_linksA
Given a DOI, return best open-access links (best PDF URL and open URL) plus Unpaywall locations metadata.
| Name | Required | Description | Default |
|---|---|---|---|
| doi | Yes | DOI string or DOI URL | |
| No | Email to identify your requests to Unpaywall (optional override) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It describes what the tool returns (links and metadata) but does not mention rate limits, authentication needs (though 'email' is optional), error handling, or data freshness. It adds basic context but lacks details on operational traits like performance or constraints.
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 a single, efficient sentence that front-loads the core functionality ('return best open-access links') and includes key details (PDF URL, open URL, metadata) without waste. Every word earns its place, making it highly concise and well-structured.
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?
Given the tool's moderate complexity (2 parameters, no output schema, no annotations), the description is reasonably complete. It specifies the input (DOI) and output (links and metadata), but without an output schema, it could benefit from more detail on return values (e.g., structure or examples). It covers the essentials but has minor gaps in output clarification.
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 both parameters ('doi' as required string and 'email' as optional override). The description adds no additional meaning beyond what the schema provides, such as format examples or usage tips for parameters. Baseline 3 is appropriate when schema does the heavy lifting.
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 clearly states the specific action ('return best open-access links') and resource ('given a DOI'), distinguishing it from siblings like 'unpaywall_fetch_pdf_text' (which extracts text) and 'unpaywall_search_titles' (which searches titles). It explicitly mentions the output includes 'best PDF URL and open URL' plus metadata, making the purpose highly specific and differentiated.
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?
The description implies usage context by specifying 'given a DOI' for retrieving open-access links, but it does not explicitly state when to use this tool versus alternatives like 'unpaywall_get_by_doi' (which might return different data) or 'unpaywall_fetch_pdf_text' (which focuses on text extraction). It provides clear context but lacks explicit exclusions or named alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
unpaywall_search_titlesA
Search Unpaywall for article titles matching a query. Supports optional is_oa filter and pagination (50 results per page).
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Title search query (supports phrase, boolean operators per Unpaywall docs) | |
| is_oa | No | If true, only return OA results; if false, only closed; omit for all | |
| page | No | Page number (50 results per page) | |
| No | Email to identify your requests to Unpaywall (optional override) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions 'Supports optional is_oa filter and pagination (50 results per page)', which provides useful operational context about filtering capabilities and pagination behavior. However, it doesn't address important behavioral aspects like rate limits, authentication requirements (beyond the optional email parameter), error conditions, or what the search results actually contain.
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 extremely concise (two sentences) and front-loaded with the core purpose. Every sentence earns its place: the first establishes what the tool does, and the second provides key operational context about filters and pagination. There's zero waste or redundancy.
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 search tool with 4 parameters, 100% schema coverage, and no output schema, the description provides adequate but minimal context. It covers the basic purpose and mentions key operational features (filtering, pagination), but doesn't explain what the search results contain, how comprehensive the search is, or any limitations. Given the lack of annotations and output schema, more completeness would be helpful for an AI agent.
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?
With 100% schema description coverage, the input schema already fully documents all 4 parameters. The description adds minimal value beyond what's in the schema - it mentions the optional is_oa filter and pagination (50 results per page), but these are already clearly documented in the parameter descriptions. The baseline score of 3 is appropriate when the schema does the heavy lifting.
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 clearly states the action ('Search Unpaywall for article titles matching a query') and specifies the resource ('article titles'), making the purpose immediately understandable. However, it doesn't explicitly differentiate this tool from its siblings (unpaywall_fetch_pdf_text, unpaywall_get_by_doi, unpaywall_get_fulltext_links), which appear to have different functions but could potentially overlap in some search contexts.
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?
The description implies usage context through 'Search Unpaywall for article titles matching a query' and mentions optional filters/pagination, but doesn't explicitly state when to use this tool versus alternatives like unpaywall_get_by_doi (for DOI-based lookups) or unpaywall_get_fulltext_links (for link retrieval). No explicit when-not-to-use guidance or prerequisite information is provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
4 tool updates
- First observed
unpaywall_fetch_pdf_text - First observed
unpaywall_get_by_doi - First observed
unpaywall_get_fulltext_links - First observed
unpaywall_search_titles
TDQS
Scored across 4 tools
Each tool has a clearly distinct purpose: fetching PDF text, retrieving metadata, getting fulltext links, and searching titles. There is no overlap in functionality, making it easy for an agent to select the right tool for a specific task.
All tools follow a consistent 'unpaywall_verb_noun' pattern, such as unpaywall_fetch_pdf_text and unpaywall_search_titles. This uniformity enhances readability and predictability across the toolset.
With 4 tools, the server is well-scoped for handling Unpaywall-related operations, covering key actions like metadata retrieval, text extraction, link fetching, and title search without being overly sparse or bloated.
The toolset covers essential CRUD-like operations for accessing open-access content, including fetching, searching, and retrieving links. A minor gap might be the lack of update or delete tools, but this is reasonable given the server's read-only nature for external data.
Maintenance
Related MCP Connectors
Unpaywall MCP — open-access lookup for scholarly papers (free, no key)
Academic literature search, retrieval, and private library management on top of OpenAlex.
Find research papers and arXiv preprints, and get an abstract and free full text from a DOI or id.
Scrape arXiv, OpenAlex and Crossref papers by author, topic, journal or DOI. Pay per row.
Related MCP Servers
- AlicenseCqualityFmaintenanceEnables real-time search and retrieval of academic paper information from multiple sources, providing access to paper metadata, abstracts, and full-text content when available, with structured data responses for integration with AI models that support tool/function calling.3116AGPL 3.0
- AlicenseAqualityDmaintenanceEnables academic research through the OpenAlex API, allowing users to search for papers, authors, and institutions, retrieve citations, and fetch full-text content when available. Perfect for building intelligent research assistants that can explore academic literature and related works.87MIT
- AlicenseAqualityDmaintenanceEnables querying open-access availability of scholarly articles via Unpaywall API, including DOI lookup, title search, and citation export.417 PyPIMIT
- FlicenseAqualityDmaintenanceEnables looking up free-to-read versions of scholarly papers by DOI and searching article titles for Open Access matches via the Unpaywall API.21-