Skip to main content
Glama

crossref-mcp-server

Search Works

crossref_search_works
Read-only

Searches the Crossref works index (~188M records) by free text and/or structured filters. The generic query matches loosely across all fields; scope precisely with the field-specific parameters queryTitle, queryAuthor, and queryContainerTitle, or resolve a known citation to its DOI with queryBibliographic — all combine with each other and with query. Use the filter parameter for structured filtering (object with hyphen-separated Crossref keys). Sort options: relevance, score, is-referenced-by-count, published, deposited, indexed, created. Each work returns at most authorLimit authors (25 by default) with authorCount reporting the full deposited total, since a single page of large-collaboration papers can carry tens of thousands of author entries; crossref_get_work pages the whole author list for any DOI whose list was cut. Funding acknowledgements with their award numbers, license terms, and registered full-text links come back only when fields names funder, license, or link, in the entry shapes crossref_get_work uses; each work then carries at most 25 funders, with funderCount the full deposited total. Post-publication updates ride each work as Crossref records them: updatedBy names each correction, retraction, expression of concern, or new version issued against it, and updateTo the works it is itself a notice for — an absent updatedBy does not mean the work was never updated. Set facets to count the matching works per value of a field — per publication year, publisher, type, funder, affiliation, ORCID, and more — over the whole match set in the same call; rows: 0 returns the counts alone. Offset-based paging is capped at ~10K results; use cursor="*" to start cursor-based deep paging, then pass the nextCursor value from each response to continue. A walk with a query term and no sort runs by relevance, one with filters only in Crossref registration order. The walk ends on the page where nextCursor is absent — that page also carries a notice saying the list is exhausted. Cursor and offset cannot be combined.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "crossref_search_works"
  }
}

Input Schema

NameRequiredDescriptionDefault
rowsNoNumber of results to return per page (default 20): 0–500 per call when fields names abstract or author, or is omitted or empty, which selects every field but funder, license, and link; 0–200 when fields names funder, license, or link, whatever else it names; 0–1000 when fields names none of those five. A value above 500 under the first kind of selection returns 500 and says so in notice, and one above 200 under the second returns 200 the same way — on an offset page the notice also names the offset that continues after the records returned. 0 returns no works, only totalResults and any facets, and does not advance a cursor walk.
sortNoSort field. Omitted, an offset page with a query term is ranked by relevance, and so is a cursor walk with one (sent as score). The publication-date sorts (published, published-print, published-online) work with offset paging only — Crossref refuses them alongside cursor; every other sort works with either.
orderNoSort direction (asc or desc). Applies only alongside sort; without one it has no effect.
queryNoFree-text search query, e.g. "CRISPR gene editing" or "climate change adaptation"
cursorNoCursor token for deep paging. Pass "*" to start cursor-based paging (required past ~10K results), then pass the nextCursor value from each response until a response omits it, which means the list is exhausted. A walk with a query term runs by relevance unless sort is set; a walk with filters only runs in Crossref registration order. Relevance scores shift slightly between identical requests, so a relevance walk can repeat or skip a record at a page boundary — sort:"created" walks every match without repeats. Cannot be combined with offset, or with a publication-date sort (published, published-print, published-online), which Crossref does not walk by cursor.
facetsNoValue counts over the whole match set — the records totalResults counts, not just this page — keyed by facet name, each set to "*" or a number of values. Crossref returns the values with the highest counts, at most 1000 per facet; a facet whose values reach its limit may have more, and notice names it. Example: {"published":"*","publisher-name":10} counts works per publication year and for the 10 publishers with the most. Pair with rows: 0 for the counts alone.
fieldsNoFields to return (reduces payload). Names are case-sensitive, and each fills one output field: DOI → doi, title → title, type → type, author → authors and authorCount, published / published-print / published-online → published, approved → approved, container-title → containerTitle and containerTitles, event → event, publisher → publisher, member → memberId, is-referenced-by-count → isReferencedByCount, score → score, abstract → abstract, volume → volume, issue → issue, page → page, article-number → articleNumber, ISSN → issn, updated-by → updatedBy, update-to → updateTo, funder → funders and funderCount, license → licenses, link → links. Omitted or empty, every name but funder, license, and link is selected; those three are returned only when named here. A work's funders are capped at the first 25, with funderCount the deposited total. A grant record carries no funders: its funder sits under its project, a field a works list cannot select. A selected field absent from a work means the record does not deposit it. DOI is always returned whether or not it is listed here, so every result stays resolvable by crossref_get_work, which also returns a work's whole funder list and the fields this list does not cover (references, relations, and the rest of the record).
filterNoStructured filter object using Crossref hyphen-separated keys. All values must be strings. Boolean flag keys (has-abstract, has-references, has-full-text) require string values "true" or "false". Dissertations, and most standards, deposit their date as an approval date rather than a publication date, which the pub-date filters (from-pub-date, until-pub-date) do not read — bound them by date with from-approved-date and until-approved-date. Example: {"type":"journal-article","has-abstract":"true","from-pub-date":"2023-01-01"}
offsetNoZero-based result offset for offset-based paging. Cannot be used with cursor. Capped at ~10K: offset + rows cannot pass it, so a page that would returns the rows that fit and says so in notice, and an offset at or past it is refused. Use cursor for deeper paging. A search with filters only and no sort has no fixed order: identical requests can order its records differently, so successive offsets can repeat or skip one — sort:"created" with order:"asc" holds the order.
queryTitleNoMatch against work titles only, e.g. "Array programming with NumPy".
authorLimitNoMaximum number of authors to return per work (1–500 per call, default 25; a larger value, up to 100000, applies 500 and says so in notice). Ordinary records fit under the default; large-collaboration papers deposit thousands, and a page of them is large enough to exhaust a client context. Each work reports its full deposited total as authorCount — call crossref_get_work with that work doi to page the authors this cap left out.
queryAuthorNoMatch against author names only, e.g. "Charles R. Harris".
queryBibliographicNoWhole-citation match to resolve a known reference to its DOI. Combine title, author, year, and container into one string, e.g. "Watson Crick molecular structure of nucleic acids Nature 1953".
queryContainerTitleNoMatch against the container title (journal or book name) only, e.g. "Nature".

Output Schema

NameRequiredDescriptionDefault
capNoThe per-work author cap applied to this page. Absent when no list was cut.
errorNoPresent when the call failed. Absent on success.
worksNoMatching works. Empty when nothing matched the query, when an offset runs past the end of the results, or on the page that ends a cursor walk — the notice enrichment says which — and on every page requested with rows: 0.
facetsNoOne entry per facet requested, in the order requested. Counts cover every record totalResults counts, not just this page, so every page of a cursor walk carries the same ones. A work that deposits no value for the facet is in no count, and one that carries several (several affiliations, a retraction that is also an erratum) is in each. Absent when facets was not set or was empty.
noticeNoGuidance on an empty page, naming which of its three causes applies: a query nothing matched, an offset past the end of a list that did match, or a cursor walk that has reached the end of the list. A rows: 0 page names only the first, and beside a cursor says that the page does not advance the walk. On a page carrying records, present when authorLimit cut at least one work's author list or the 25-funder cap one work's funder list, naming how many and the route to the rest; when a grant row lacks the title a selection of both type and title asked for, naming crossref_get_work as the route to it; or when every query term and filter value was supplied blank, so the page lists the whole index unfiltered. On any page, present when rows or authorLimit was above its per-call cap, naming the value requested and the cap applied — for rows under a fields selection naming funder, license, or link, also the caps a selection without them takes; under one naming abstract or author, also that one naming neither takes rows up to 1000; on an offset page with records remaining, also the offset that continues after the records returned. On an offset page where offset + rows would pass the ~10K offset ceiling, present naming the rows requested and the rows that fit and were applied, and, when records remain past the ceiling, cursor as the route to them. Present when a facets count was above 1000, naming the count requested and the 1000 applied, and when a facet returned as many values as its limit, naming the facet and the route to the values it may have left out. A page needing more than one caveat carries them all in this one string.
returnedNoNumber of records returned in this response
truncatedNoTrue when at least one work on this page had its author list cut by authorLimit. Absent when every work on the page carries its full deposited author list.
nextCursorNoCursor token to pass as cursor on the next call to continue a cursor walk. Present only on a page requested with cursor that returned works: absent once the walk reaches the end of the list, and on a rows: 0 page, which does not advance it.
totalResultsNoTotal matching records in Crossref

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changed
    • changedInput schema / properties / fields / description
      Previous value: -"Fields to return (reduces payload). Names are case-sensitive, and each fills one output field: DOI → doi, title → title, type → type, author → authors and authorCount, published / published-print / published-online → published, approved → approved, container-title → containerTitle and containerTitles, event → event, publisher → publisher, member → memberId, is-referenced-by-count → isReferencedByCount, score → score, abstract → abstract, volume → volume, issue → issue, page → page, article-number → articleNumber, ISSN → issn, updated-by → updatedBy, update-to → updateTo. A selected field absent from a work means the record does not deposit it. DOI is always returned whether or not it is listed here, so every result stays resolvable by crossref_get_work, which also returns the fields this list does not cover (license, funder, references, and the rest of the record)."New value: +"Fields to return (reduces payload). Names are case-sensitive, and each fills one output field: DOI → doi, title → title, type → type, author → authors and authorCount, published / published-print / published-online → published, approved → approved, container-title → containerTitle and containerTitles, event → event, publisher → publisher, member → memberId, is-referenced-by-count → isReferencedByCount, score → score, abstract → abstract, volume → volume, issue → issue, page → page, article-number → articleNumber, ISSN → issn, updated-by → updatedBy, update-to → updateTo, funder → funders and funderCount, license → licenses, link → links. Omitted or empty, every name but funder, license, and link is selected; those three are returned only when named here. A work's funders are capped at the first 25, with funderCount the deposited total. A grant record carries no funders: its funder sits under its project, a field a works list cannot select. A selected field absent from a work means the record does not deposit it. DOI is always returned whether or not it is listed here, so every result stays resolvable by crossref_get_work, which also returns a work's whole funder list and the fields this list does not cover (references, relations, and the rest of the record)."
    • changedInput schema / properties / fields / items / enum
      Previous value: -[
      -  "DOI",
      -  "title",
      -  "type",
      -  "author",
      -  "published",
      -  "published-print",
      -  "published-online",
      -  "approved",
      -  "container-title",
      -  "event",
      -  "publisher",
      -  "member",
      -  "is-referenced-by-count",
      -  "score",
      -  "abstract",
      -  "volume",
      -  "issue",
      -  "page",
      -  "article-number",
      -  "ISSN",
      -  "updated-by",
      -  "update-to"
      -]New value: +[
      +  "DOI",
      +  "title",
      +  "type",
      +  "author",
      +  "published",
      +  "published-print",
      +  "published-online",
      +  "approved",
      +  "container-title",
      +  "event",
      +  "publisher",
      +  "member",
      +  "is-referenced-by-count",
      +  "score",
      +  "abstract",
      +  "volume",
      +  "issue",
      +  "page",
      +  "article-number",
      +  "ISSN",
      +  "updated-by",
      +  "update-to",
      +  "funder",
      +  "license",
      +  "link"
      +]
    • changedInput schema / properties / rows / description
      Previous value: -"Number of results to return per page (default 20): 0–500 per call when fields names abstract or author, or is omitted or empty, which selects every field; 0–1000 when fields names neither. A value above 500 under the first kind of selection returns 500 and says so in notice — on an offset page the notice also names the offset that continues after the records returned. 0 returns no works, only totalResults and any facets, and does not advance a cursor walk."New value: +"Number of results to return per page (default 20): 0–500 per call when fields names abstract or author, or is omitted or empty, which selects every field but funder, license, and link; 0–200 when fields names funder, license, or link, whatever else it names; 0–1000 when fields names none of those five. A value above 500 under the first kind of selection returns 500 and says so in notice, and one above 200 under the second returns 200 the same way — on an offset page the notice also names the offset that continues after the records returned. 0 returns no works, only totalResults and any facets, and does not advance a cursor walk."
    • changedOutput schema / properties / error / properties / data / properties / reason / description
      Previous value: -"Machine-readable failure mode. Declared by this tool: `rate_limited`: Crossref answered HTTP 429 and the limit did not clear inside the retry budget. `upstream_unavailable`: Crossref was unreachable, returned a 5xx status, or served an HTML error page instead of JSON. `malformed_response`: Crossref returned HTTP 200 with a body that is not valid JSON, or with facet counts in a shape this server does not read. `request_timeout`: Crossref did not respond within CROSSREF_TIMEOUT_MS, or answered HTTP 408/504. `unknown_filter`: Crossref rejected a filter key it does not recognize (filter-not-available). `sort_cursor_conflict`: A publication-date sort (published, published-print, published-online) was combined with cursor paging, which Crossref refuses. `invalid_cursor`: Crossref did not recognize the cursor token (HTTP 404 cursor-invalid). `invalid_parameter`: Crossref rejected a parameter value (a filter value of the wrong type or form), or answered HTTP 400 with a body that did not parse. `cursor_offset_conflict`: Both cursor and offset were supplied in the same request. `offset_too_large`: The requested offset is at or past the ~10K limit Crossref puts on offset + rows, so no page of any size starts there. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `rate_limited`: Crossref answered HTTP 429 and the limit did not clear inside the retry budget, or answered it to the single-attempt published-version lookup on a preprint. `upstream_unavailable`: Crossref was unreachable, returned a 5xx status, or served an HTML error page instead of JSON. `malformed_response`: Crossref returned HTTP 200 with a body that is not valid JSON, or with facet counts in a shape this server does not read. `request_timeout`: Crossref did not respond within CROSSREF_TIMEOUT_MS, did not answer before the 25 s request deadline (CROSSREF_TIMEOUT_MS when longer) that bounds every retry, or answered HTTP 408/504. `unknown_filter`: Crossref rejected a filter key it does not recognize (filter-not-available). `sort_cursor_conflict`: A publication-date sort (published, published-print, published-online) was combined with cursor paging, which Crossref refuses. `invalid_cursor`: Crossref did not recognize the cursor token (HTTP 404 cursor-invalid). `invalid_parameter`: Crossref rejected a parameter value (a filter value of the wrong type or form), or answered HTTP 400 with a body that did not parse. `cursor_offset_conflict`: Both cursor and offset were supplied in the same request. `offset_too_large`: The requested offset is at or past the ~10K limit Crossref puts on offset + rows, so no page of any size starts there. Other values are possible when a failure originates below the handler."
    • changedOutput schema / properties / notice / description
      Previous value: -"Guidance on an empty page, naming which of its three causes applies: a query nothing matched, an offset past the end of a list that did match, or a cursor walk that has reached the end of the list. A rows: 0 page names only the first, and beside a cursor says that the page does not advance the walk. On a page carrying records, present when authorLimit cut at least one work list, naming how many and the route to the rest, or when every query term and filter value was supplied blank, so the page lists the whole index unfiltered. On any page, present when rows or authorLimit was above its per-call cap, naming the value requested and the cap applied — for rows under a fields selection naming abstract or author, also that one naming neither takes rows up to 1000; on an offset page with records remaining, also the offset that continues after the records returned. On an offset page where offset + rows would pass the ~10K offset ceiling, present naming the rows requested and the rows that fit and were applied, and, when records remain past the ceiling, cursor as the route to them. Present when a facets count was above 1000, naming the count requested and the 1000 applied, and when a facet returned as many values as its limit, naming the facet and the route to the values it may have left out. A page needing more than one caveat carries them all in this one string."New value: +"Guidance on an empty page, naming which of its three causes applies: a query nothing matched, an offset past the end of a list that did match, or a cursor walk that has reached the end of the list. A rows: 0 page names only the first, and beside a cursor says that the page does not advance the walk. On a page carrying records, present when authorLimit cut at least one work's author list or the 25-funder cap one work's funder list, naming how many and the route to the rest; when a grant row lacks the title a selection of both type and title asked for, naming crossref_get_work as the route to it; or when every query term and filter value was supplied blank, so the page lists the whole index unfiltered. On any page, present when rows or authorLimit was above its per-call cap, naming the value requested and the cap applied — for rows under a fields selection naming funder, license, or link, also the caps a selection without them takes; under one naming abstract or author, also that one naming neither takes rows up to 1000; on an offset page with records remaining, also the offset that continues after the records returned. On an offset page where offset + rows would pass the ~10K offset ceiling, present naming the rows requested and the rows that fit and were applied, and, when records remain past the ceiling, cursor as the route to them. Present when a facets count was above 1000, naming the count requested and the 1000 applied, and when a facet returned as many values as its limit, naming the facet and the route to the values it may have left out. A page needing more than one caveat carries them all in this one string."
    • addedOutput schema / properties / works / items / properties / funderCount
      Added value: +{
      +  "description": "Total number of funding acknowledgements deposited for this work, before the 25-funder cap. Greater than the length of funders when the cap cut the list; pass the doi of this work to crossref_get_work for the whole list.",
      +  "type": "number"
      +}
    • addedOutput schema / properties / works / items / properties / funders
      Added value: +{
      +  "description": "Funding acknowledgements, in deposited order, capped at the first 25. Present only when fields names funder, and omitted when the record deposits none.",
      +  "items": {
      +    "additionalProperties": false,
      +    "description": "Funding assertion",
      +    "properties": {
      +      "award": {
      +        "description": "Grant or award numbers",
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "doi": {
      +        "description": "Funder DOI — the Crossref Funder Registry entry this assertion resolved to",
      +        "type": "string"
      +      },
      +      "name": {
      +        "description": "Funder name as deposited. Absent when the publisher asserted the funder by identifier alone, where ror carries it instead.",
      +        "type": "string"
      +      },
      +      "ror": {
      +        "description": "ROR identifier for the funding organization, when the deposit carries one. It is the whole identity of an assertion deposited without a name.",
      +        "type": "string"
      +      }
      +    },
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / works / items / properties / licenses
      Added value: +{
      +  "description": "License terms, in deposited order. Present only when fields names license, and omitted when the record deposits none.",
      +  "items": {
      +    "additionalProperties": false,
      +    "description": "License entry",
      +    "properties": {
      +      "contentVersion": {
      +        "description": "Content version (vor, am, tdm, unspecified)",
      +        "type": "string"
      +      },
      +      "delayInDays": {
      +        "description": "Embargo delay in days from publication date",
      +        "type": "number"
      +      },
      +      "start": {
      +        "description": "License start date-time as deposited by the publisher",
      +        "type": "string"
      +      },
      +      "url": {
      +        "description": "License URL",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "url"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / works / items / properties / links
      Added value: +{
      +  "description": "Registered full-text links, in deposited order. Present only when fields names link, and omitted when the record deposits none.",
      +  "items": {
      +    "additionalProperties": false,
      +    "description": "Registered full-text link",
      +    "properties": {
      +      "contentType": {
      +        "description": "MIME type of linked content",
      +        "type": "string"
      +      },
      +      "contentVersion": {
      +        "description": "Content version of the linked manuscript as deposited (e.g. vor, am)",
      +        "type": "string"
      +      },
      +      "intendedApplication": {
      +        "description": "Intended use (text-mining, similarity-checking, etc.)",
      +        "type": "string"
      +      },
      +      "url": {
      +        "description": "Full-text URL",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "url"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • changedOutput schema / properties / works / items / properties / title / description
      Previous value: -"Work title"New value: +"Work title. A grant deposits none: its project titles sit in a field a works list cannot select, and crossref_get_work returns them."
  2. Changed10 schema fields changed
    • addedInput schema / properties / facets
      Added value: +{
      +  "additionalProperties": {
      +    "anyOf": [
      +      {
      +        "const": "",
      +        "type": "string"
      +      },
      +      {
      +        "const": "*",
      +        "type": "string"
      +      },
      +      {
      +        "maximum": 9007199254740991,
      +        "minimum": 1,
      +        "type": "integer"
      +      },
      +      {
      +        "description": "A number of values written as a decimal string, e.g. \"10\"",
      +        "pattern": "^[1-9]\\d*$",
      +        "type": "string"
      +      }
      +    ],
      +    "description": "\"*\" for up to 1000 values, or a number of values; a number above 1000 is applied as 1000"
      +  },
      +  "description": "Value counts over the whole match set — the records totalResults counts, not just this page — keyed by facet name, each set to \"*\" or a number of values. Crossref returns the values with the highest counts, at most 1000 per facet; a facet whose values reach its limit may have more, and notice names it. Example: {\"published\":\"*\",\"publisher-name\":10} counts works per publication year and for the 10 publishers with the most. Pair with rows: 0 for the counts alone.",
      +  "propertyNames": {
      +    "description": "Crossref facet name",
      +    "enum": [
      +      "affiliation",
      +      "license",
      +      "container-title",
      +      "publisher-name",
      +      "link-application",
      +      "orcid",
      +      "update-type",
      +      "published",
      +      "funder-name",
      +      "archive",
      +      "type-name",
      +      "relation-type",
      +      "ror-id",
      +      "issn",
      +      "source",
      +      "journal-issue",
      +      "category-name",
      +      "assertion",
      +      "assertion-group",
      +      "journal-volume",
      +      "funder-doi"
      +    ],
      +    "type": "string"
      +  },
      +  "type": "object"
      +}
    • changedInput schema / properties / offset / description
      Previous value: -"Zero-based result offset for offset-based paging. Cannot be used with cursor. Capped at ~10K: offset + rows cannot pass it, so a page that would returns the rows that fit and says so in notice, and an offset at or past it is refused. Use cursor for deeper paging."New value: +"Zero-based result offset for offset-based paging. Cannot be used with cursor. Capped at ~10K: offset + rows cannot pass it, so a page that would returns the rows that fit and says so in notice, and an offset at or past it is refused. Use cursor for deeper paging. A search with filters only and no sort has no fixed order: identical requests can order its records differently, so successive offsets can repeat or skip one — sort:\"created\" with order:\"asc\" holds the order."
    • changedInput schema / properties / rows / description
      Previous value: -"Number of results to return per page (1–250 per call, default 20; 1–600 when fields names neither abstract nor author — an omitted or empty fields selects every field, both included). A larger value, up to 1000, returns the cap that applies and says so in notice — on an offset page the notice also names the offset that continues after the records returned."New value: +"Number of results to return per page (default 20): 0–500 per call when fields names abstract or author, or is omitted or empty, which selects every field; 0–1000 when fields names neither. A value above 500 under the first kind of selection returns 500 and says so in notice — on an offset page the notice also names the offset that continues after the records returned. 0 returns no works, only totalResults and any facets, and does not advance a cursor walk."
    • changedInput schema / properties / rows / minimum
      Previous value: -1New value: +0
    • changedOutput schema / properties / error / properties / data / properties / reason / description
      Previous value: -"Machine-readable failure mode. Declared by this tool: `rate_limited`: Crossref answered HTTP 429 and the limit did not clear inside the retry budget. `upstream_unavailable`: Crossref was unreachable, returned a 5xx status, or served an HTML error page instead of JSON. `malformed_response`: Crossref returned HTTP 200 with a body that is not valid JSON. `request_timeout`: Crossref did not respond within CROSSREF_TIMEOUT_MS, or answered HTTP 408/504. `unknown_filter`: Crossref rejected a filter key it does not recognize (filter-not-available). `sort_cursor_conflict`: A publication-date sort (published, published-print, published-online) was combined with cursor paging, which Crossref refuses. `invalid_cursor`: Crossref did not recognize the cursor token (HTTP 404 cursor-invalid). `invalid_parameter`: Crossref rejected a parameter value (a filter value of the wrong type or form), or answered HTTP 400 with a body that did not parse. `cursor_offset_conflict`: Both cursor and offset were supplied in the same request. `offset_too_large`: The requested offset is at or past the ~10K limit Crossref puts on offset + rows, so no page of any size starts there. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `rate_limited`: Crossref answered HTTP 429 and the limit did not clear inside the retry budget. `upstream_unavailable`: Crossref was unreachable, returned a 5xx status, or served an HTML error page instead of JSON. `malformed_response`: Crossref returned HTTP 200 with a body that is not valid JSON, or with facet counts in a shape this server does not read. `request_timeout`: Crossref did not respond within CROSSREF_TIMEOUT_MS, or answered HTTP 408/504. `unknown_filter`: Crossref rejected a filter key it does not recognize (filter-not-available). `sort_cursor_conflict`: A publication-date sort (published, published-print, published-online) was combined with cursor paging, which Crossref refuses. `invalid_cursor`: Crossref did not recognize the cursor token (HTTP 404 cursor-invalid). `invalid_parameter`: Crossref rejected a parameter value (a filter value of the wrong type or form), or answered HTTP 400 with a body that did not parse. `cursor_offset_conflict`: Both cursor and offset were supplied in the same request. `offset_too_large`: The requested offset is at or past the ~10K limit Crossref puts on offset + rows, so no page of any size starts there. Other values are possible when a failure originates below the handler."
    • addedOutput schema / properties / facets
      Added value: +{
      +  "description": "One entry per facet requested, in the order requested. Counts cover every record totalResults counts, not just this page, so every page of a cursor walk carries the same ones. A work that deposits no value for the facet is in no count, and one that carries several (several affiliations, a retraction that is also an erratum) is in each. Absent when facets was not set or was empty.",
      +  "items": {
      +    "additionalProperties": false,
      +    "description": "One facet",
      +    "properties": {
      +      "name": {
      +        "description": "Facet name, as requested",
      +        "enum": [
      +          "affiliation",
      +          "license",
      +          "container-title",
      +          "publisher-name",
      +          "link-application",
      +          "orcid",
      +          "update-type",
      +          "published",
      +          "funder-name",
      +          "archive",
      +          "type-name",
      +          "relation-type",
      +          "ror-id",
      +          "issn",
      +          "source",
      +          "journal-issue",
      +          "category-name",
      +          "assertion",
      +          "assertion-group",
      +          "journal-volume",
      +          "funder-doi"
      +        ],
      +        "type": "string"
      +      },
      +      "values": {
      +        "description": "The values with the highest counts, highest first; a tie is ordered by value, descending, as Crossref sends it. Empty when no matching work carries the facet.",
      +        "items": {
      +          "additionalProperties": false,
      +          "description": "One facet value",
      +          "properties": {
      +            "count": {
      +              "description": "Matching works that carry this value",
      +              "type": "number"
      +            },
      +            "value": {
      +              "description": "The value as Crossref indexes it — a year for published, a name for publisher-name or affiliation, an ORCID or ROR URL for orcid or ror-id",
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "value",
      +            "count"
      +          ],
      +          "type": "object"
      +        },
      +        "type": "array"
      +      }
      +    },
      +    "required": [
      +      "name",
      +      "values"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • changedOutput schema / properties / nextCursor / description
      Previous value: -"Cursor token to pass as cursor on the next call to continue a cursor walk. Present only on a page requested with cursor, and absent once the walk reaches the end of the list."New value: +"Cursor token to pass as cursor on the next call to continue a cursor walk. Present only on a page requested with cursor that returned works: absent once the walk reaches the end of the list, and on a rows: 0 page, which does not advance it."
    • changedOutput schema / properties / notice / description
      Previous value: -"Guidance on an empty page, naming which of its three causes applies: a query nothing matched, an offset past the end of a list that did match, or a cursor walk that has reached the end of the list. On a page carrying records, present when authorLimit cut at least one work list, naming how many and the route to the rest, or when every query term and filter value was supplied blank, so the page lists the whole index unfiltered. On any page, present when rows or authorLimit was above its per-call cap, naming the value requested and the cap applied — for rows under a fields selection, also the other cap (250 with abstract or author selected, 600 with neither) and how it is reached; on an offset page with records remaining, also the offset that continues after the records returned. On an offset page where offset + rows would pass the ~10K offset ceiling, present naming the rows requested and the rows that fit and were applied, and, when records remain past the ceiling, cursor as the route to them. A page needing more than one caveat carries them all in this one string."New value: +"Guidance on an empty page, naming which of its three causes applies: a query nothing matched, an offset past the end of a list that did match, or a cursor walk that has reached the end of the list. A rows: 0 page names only the first, and beside a cursor says that the page does not advance the walk. On a page carrying records, present when authorLimit cut at least one work list, naming how many and the route to the rest, or when every query term and filter value was supplied blank, so the page lists the whole index unfiltered. On any page, present when rows or authorLimit was above its per-call cap, naming the value requested and the cap applied — for rows under a fields selection naming abstract or author, also that one naming neither takes rows up to 1000; on an offset page with records remaining, also the offset that continues after the records returned. On an offset page where offset + rows would pass the ~10K offset ceiling, present naming the rows requested and the rows that fit and were applied, and, when records remain past the ceiling, cursor as the route to them. Present when a facets count was above 1000, naming the count requested and the 1000 applied, and when a facet returned as many values as its limit, naming the facet and the route to the values it may have left out. A page needing more than one caveat carries them all in this one string."
    • changedOutput schema / properties / works / description
      Previous value: -"Matching works. Empty when nothing matched the query, when an offset runs past the end of the results, or on the page that ends a cursor walk — the notice enrichment says which."New value: +"Matching works. Empty when nothing matched the query, when an offset runs past the end of the results, or on the page that ends a cursor walk — the notice enrichment says which — and on every page requested with rows: 0."
    • changedOutput schema / properties / works / items / properties / abstract / description
      Previous value: -"Abstract when present in the indexed record — the text of the publisher’s JATS deposit, with markup removed and character references decoded; each section heading of a structured abstract is followed by a colon (\"Objectives: …\") unless it already ends in a period, colon, question mark, or exclamation mark, and the \"Abstract\" heading a deposit opens with is dropped; numeric JATS superscripts retain caret notation (10^{16}, GeV^2), a link keeps its tag only where its href holds an address the text it wraps does not already carry, and each formula appears once — MathML as the TeX annotation it carries, otherwise written out linearly (x_i, A^{−1}, √(m), (a+b)/c), and TeX deposited beside MathML in whichever notation comes first. Omitted when the deposit holds no text."New value: +"Abstract when present in the indexed record — the text of the publisher’s JATS deposit, with markup removed and character references decoded; each section heading of a structured abstract is followed by a colon (\"Objectives: …\") unless it already ends in a period, colon, question mark, or exclamation mark, a heading whose section holds no text (a figure-only \"Graphical Abstract\") is dropped, the \"Abstract\" heading a deposit opens with is dropped, and the items of one list are joined by \"; \" unless an item already ends in a period, comma, semicolon, colon, question mark, or exclamation mark; numeric JATS superscripts retain caret notation (10^{16}, GeV^2), a link keeps its tag only where its href holds an address the text it wraps does not already carry, and each formula appears once — MathML as the TeX annotation it carries, otherwise written out linearly (x_i, A^{−1}, √(m), (a+b)/c), and TeX deposited beside MathML in whichever notation comes first. Omitted when the deposit holds no text."
  3. Changed8 schema fields changed
    • changedInput schema / properties / fields / description
      Previous value: -"Fields to return (reduces payload). Names are case-sensitive, and each fills one output field: DOI → doi, title → title, type → type, author → authors and authorCount, published / published-print / published-online → published, container-title → containerTitle and containerTitles, publisher → publisher, member → memberId, is-referenced-by-count → isReferencedByCount, score → score, abstract → abstract, volume → volume, issue → issue, page → page, article-number → articleNumber, ISSN → issn, updated-by → updatedBy, update-to → updateTo. A selected field absent from a work means the record does not deposit it. DOI is always returned whether or not it is listed here, so every result stays resolvable by crossref_get_work, which also returns the fields this list does not cover (license, funder, references, and the rest of the record)."New value: +"Fields to return (reduces payload). Names are case-sensitive, and each fills one output field: DOI → doi, title → title, type → type, author → authors and authorCount, published / published-print / published-online → published, approved → approved, container-title → containerTitle and containerTitles, event → event, publisher → publisher, member → memberId, is-referenced-by-count → isReferencedByCount, score → score, abstract → abstract, volume → volume, issue → issue, page → page, article-number → articleNumber, ISSN → issn, updated-by → updatedBy, update-to → updateTo. A selected field absent from a work means the record does not deposit it. DOI is always returned whether or not it is listed here, so every result stays resolvable by crossref_get_work, which also returns the fields this list does not cover (license, funder, references, and the rest of the record)."
    • changedInput schema / properties / fields / items / enum
      Previous value: -[
      -  "DOI",
      -  "title",
      -  "type",
      -  "author",
      -  "published",
      -  "published-print",
      -  "published-online",
      -  "container-title",
      -  "publisher",
      -  "member",
      -  "is-referenced-by-count",
      -  "score",
      -  "abstract",
      -  "volume",
      -  "issue",
      -  "page",
      -  "article-number",
      -  "ISSN",
      -  "updated-by",
      -  "update-to"
      -]New value: +[
      +  "DOI",
      +  "title",
      +  "type",
      +  "author",
      +  "published",
      +  "published-print",
      +  "published-online",
      +  "approved",
      +  "container-title",
      +  "event",
      +  "publisher",
      +  "member",
      +  "is-referenced-by-count",
      +  "score",
      +  "abstract",
      +  "volume",
      +  "issue",
      +  "page",
      +  "article-number",
      +  "ISSN",
      +  "updated-by",
      +  "update-to"
      +]
    • changedInput schema / properties / filter / description
      Previous value: -"Structured filter object using Crossref hyphen-separated keys. All values must be strings. Boolean flag keys (has-abstract, has-references, has-full-text) require string values \"true\" or \"false\". Example: {\"type\":\"journal-article\",\"has-abstract\":\"true\",\"from-pub-date\":\"2023-01-01\"}"New value: +"Structured filter object using Crossref hyphen-separated keys. All values must be strings. Boolean flag keys (has-abstract, has-references, has-full-text) require string values \"true\" or \"false\". Dissertations, and most standards, deposit their date as an approval date rather than a publication date, which the pub-date filters (from-pub-date, until-pub-date) do not read — bound them by date with from-approved-date and until-approved-date. Example: {\"type\":\"journal-article\",\"has-abstract\":\"true\",\"from-pub-date\":\"2023-01-01\"}"
    • changedInput schema / properties / rows / description
      Previous value: -"Number of results to return per page (1–250 per call, default 20). A larger value, up to 1000, returns 250 and says so in notice — on an offset page the notice also names the offset that continues after the records returned."New value: +"Number of results to return per page (1–250 per call, default 20; 1–600 when fields names neither abstract nor author — an omitted or empty fields selects every field, both included). A larger value, up to 1000, returns the cap that applies and says so in notice — on an offset page the notice also names the offset that continues after the records returned."
    • changedOutput schema / properties / notice / description
      Previous value: -"Guidance on an empty page, naming which of its three causes applies: a query nothing matched, an offset past the end of a list that did match, or a cursor walk that has reached the end of the list. On a page carrying records, present when authorLimit cut at least one work list, naming how many and the route to the rest, or when every query term and filter value was supplied blank, so the page lists the whole index unfiltered. On any page, present when rows or authorLimit was above its per-call cap, naming the value requested and the cap applied — on an offset page with records remaining, also the offset that continues after the records returned. On an offset page where offset + rows would pass the ~10K offset ceiling, present naming the rows requested and the rows that fit and were applied, and, when records remain past the ceiling, cursor as the route to them. A page needing more than one caveat carries them all in this one string."New value: +"Guidance on an empty page, naming which of its three causes applies: a query nothing matched, an offset past the end of a list that did match, or a cursor walk that has reached the end of the list. On a page carrying records, present when authorLimit cut at least one work list, naming how many and the route to the rest, or when every query term and filter value was supplied blank, so the page lists the whole index unfiltered. On any page, present when rows or authorLimit was above its per-call cap, naming the value requested and the cap applied — for rows under a fields selection, also the other cap (250 with abstract or author selected, 600 with neither) and how it is reached; on an offset page with records remaining, also the offset that continues after the records returned. On an offset page where offset + rows would pass the ~10K offset ceiling, present naming the rows requested and the rows that fit and were applied, and, when records remain past the ceiling, cursor as the route to them. A page needing more than one caveat carries them all in this one string."
    • changedOutput schema / properties / works / items / properties / abstract / description
      Previous value: -"Abstract when present in the indexed record — the text of the publisher’s JATS deposit, with markup removed and character references decoded; numeric JATS superscripts retain caret notation (10^{16}, GeV^2), a link keeps its tag only where its href holds an address the text it wraps does not already carry, and each formula appears once — MathML as the TeX annotation it carries, otherwise written out linearly (x_i, A^{−1}, √(m), (a+b)/c), and TeX deposited beside MathML in whichever notation comes first"New value: +"Abstract when present in the indexed record — the text of the publisher’s JATS deposit, with markup removed and character references decoded; each section heading of a structured abstract is followed by a colon (\"Objectives: …\") unless it already ends in a period, colon, question mark, or exclamation mark, and the \"Abstract\" heading a deposit opens with is dropped; numeric JATS superscripts retain caret notation (10^{16}, GeV^2), a link keeps its tag only where its href holds an address the text it wraps does not already carry, and each formula appears once — MathML as the TeX annotation it carries, otherwise written out linearly (x_i, A^{−1}, √(m), (a+b)/c), and TeX deposited beside MathML in whichever notation comes first. Omitted when the deposit holds no text."
    • addedOutput schema / properties / works / items / properties / approved
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Date the work was approved, as deposited — the only date most dissertations and standards carry, and one some reports carry beside their publication date. Never read into published, which stays absent on a record that deposits no publication date. A component Crossref records as unknown is omitted, and so is every component below it. Omitted when the record deposits none.",
      +  "properties": {
      +    "day": {
      +      "description": "Day of month",
      +      "type": "number"
      +    },
      +    "month": {
      +      "description": "Month (1–12)",
      +      "type": "number"
      +    },
      +    "year": {
      +      "description": "Year",
      +      "type": "number"
      +    }
      +  },
      +  "type": "object"
      +}
    • addedOutput schema / properties / works / items / properties / event
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Conference or meeting the work was presented at, as a proceedings record deposits it: name, acronym, location, and dates, each where deposited. Omitted when the record deposits none.",
      +  "properties": {
      +    "acronym": {
      +      "description": "Event acronym, where deposited",
      +      "type": "string"
      +    },
      +    "end": {
      +      "additionalProperties": false,
      +      "description": "Last day of the event. A component Crossref records as unknown is omitted, and so is every component below it.",
      +      "properties": {
      +        "day": {
      +          "description": "Day of month",
      +          "type": "number"
      +        },
      +        "month": {
      +          "description": "Month (1–12)",
      +          "type": "number"
      +        },
      +        "year": {
      +          "description": "Year",
      +          "type": "number"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "location": {
      +      "description": "Where the event was held, as deposited",
      +      "type": "string"
      +    },
      +    "name": {
      +      "description": "Event name as deposited",
      +      "type": "string"
      +    },
      +    "start": {
      +      "additionalProperties": false,
      +      "description": "First day of the event. A component Crossref records as unknown is omitted, and so is every component below it.",
      +      "properties": {
      +        "day": {
      +          "description": "Day of month",
      +          "type": "number"
      +        },
      +        "month": {
      +          "description": "Month (1–12)",
      +          "type": "number"
      +        },
      +        "year": {
      +          "description": "Year",
      +          "type": "number"
      +        }
      +      },
      +      "type": "object"
      +    }
      +  },
      +  "type": "object"
      +}
  4. Changed9 schema fields changed
    • changedInput schema / properties / fields / description
      Previous value: -"Fields to return (reduces payload). Names are case-sensitive, and each fills one output field: DOI → doi, title → title, type → type, author → authors and authorCount, published / published-print / published-online → published, container-title → containerTitle, publisher → publisher, is-referenced-by-count → isReferencedByCount, score → score, abstract → abstract, volume → volume, issue → issue, page → page, article-number → articleNumber, ISSN → issn, updated-by → updatedBy, update-to → updateTo. A selected field absent from a work means the record does not deposit it. DOI is always returned whether or not it is listed here, so every result stays resolvable by crossref_get_work, which also returns the fields this list does not cover (license, funder, references, and the rest of the record)."New value: +"Fields to return (reduces payload). Names are case-sensitive, and each fills one output field: DOI → doi, title → title, type → type, author → authors and authorCount, published / published-print / published-online → published, container-title → containerTitle and containerTitles, publisher → publisher, member → memberId, is-referenced-by-count → isReferencedByCount, score → score, abstract → abstract, volume → volume, issue → issue, page → page, article-number → articleNumber, ISSN → issn, updated-by → updatedBy, update-to → updateTo. A selected field absent from a work means the record does not deposit it. DOI is always returned whether or not it is listed here, so every result stays resolvable by crossref_get_work, which also returns the fields this list does not cover (license, funder, references, and the rest of the record)."
    • changedInput schema / properties / fields / items / enum
      Previous value: -[
      -  "DOI",
      -  "title",
      -  "type",
      -  "author",
      -  "published",
      -  "published-print",
      -  "published-online",
      -  "container-title",
      -  "publisher",
      -  "is-referenced-by-count",
      -  "score",
      -  "abstract",
      -  "volume",
      -  "issue",
      -  "page",
      -  "article-number",
      -  "ISSN",
      -  "updated-by",
      -  "update-to"
      -]New value: +[
      +  "DOI",
      +  "title",
      +  "type",
      +  "author",
      +  "published",
      +  "published-print",
      +  "published-online",
      +  "container-title",
      +  "publisher",
      +  "member",
      +  "is-referenced-by-count",
      +  "score",
      +  "abstract",
      +  "volume",
      +  "issue",
      +  "page",
      +  "article-number",
      +  "ISSN",
      +  "updated-by",
      +  "update-to"
      +]
    • changedInput schema / properties / offset / description
      Previous value: -"Zero-based result offset for offset-based paging. Cannot be used with cursor. Capped at ~10K; use cursor for deeper paging."New value: +"Zero-based result offset for offset-based paging. Cannot be used with cursor. Capped at ~10K: offset + rows cannot pass it, so a page that would returns the rows that fit and says so in notice, and an offset at or past it is refused. Use cursor for deeper paging."
    • changedInput schema / properties / rows / description
      Previous value: -"Number of results to return per page (1–100 per call, default 20). A larger value, up to 1000, returns 100 and says so in notice — on an offset page the notice also names the offset that continues after the records returned."New value: +"Number of results to return per page (1–250 per call, default 20). A larger value, up to 1000, returns 250 and says so in notice — on an offset page the notice also names the offset that continues after the records returned."
    • changedOutput schema / properties / error / properties / data / properties / reason / description
      Previous value: -"Machine-readable failure mode. Declared by this tool: `rate_limited`: Crossref answered HTTP 429 and the limit did not clear inside the retry budget. `upstream_unavailable`: Crossref was unreachable, returned a 5xx status, or served an HTML error page instead of JSON. `malformed_response`: Crossref returned HTTP 200 with a body that is not valid JSON. `request_timeout`: Crossref did not respond within CROSSREF_TIMEOUT_MS, or answered HTTP 408/504. `unknown_filter`: Crossref rejected a filter key it does not recognize (filter-not-available). `sort_cursor_conflict`: A publication-date sort (published, published-print, published-online) was combined with cursor paging, which Crossref refuses. `invalid_cursor`: Crossref did not recognize the cursor token (HTTP 404 cursor-invalid). `invalid_parameter`: Crossref rejected a parameter value (a filter value of the wrong type or form), or answered HTTP 400 with a body that did not parse. `cursor_offset_conflict`: Both cursor and offset were supplied in the same request. `offset_too_large`: The requested offset exceeds the ~10K Crossref limit for offset-based paging. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `rate_limited`: Crossref answered HTTP 429 and the limit did not clear inside the retry budget. `upstream_unavailable`: Crossref was unreachable, returned a 5xx status, or served an HTML error page instead of JSON. `malformed_response`: Crossref returned HTTP 200 with a body that is not valid JSON. `request_timeout`: Crossref did not respond within CROSSREF_TIMEOUT_MS, or answered HTTP 408/504. `unknown_filter`: Crossref rejected a filter key it does not recognize (filter-not-available). `sort_cursor_conflict`: A publication-date sort (published, published-print, published-online) was combined with cursor paging, which Crossref refuses. `invalid_cursor`: Crossref did not recognize the cursor token (HTTP 404 cursor-invalid). `invalid_parameter`: Crossref rejected a parameter value (a filter value of the wrong type or form), or answered HTTP 400 with a body that did not parse. `cursor_offset_conflict`: Both cursor and offset were supplied in the same request. `offset_too_large`: The requested offset is at or past the ~10K limit Crossref puts on offset + rows, so no page of any size starts there. Other values are possible when a failure originates below the handler."
    • changedOutput schema / properties / notice / description
      Previous value: -"Guidance on an empty page, naming which of its three causes applies: a query nothing matched, an offset past the end of a list that did match, or a cursor walk that has reached the end of the list. On a page carrying records, present when authorLimit cut at least one work list, naming how many and the route to the rest, or when every query term and filter value was supplied blank, so the page lists the whole index unfiltered. On any page, present when rows or authorLimit was above its per-call cap, naming the value requested and the cap applied — on an offset page with records remaining, also the offset that continues after the records returned, with the smaller rows that still fit when a full page there would pass the ~10K offset ceiling. A page needing more than one caveat carries them all in this one string."New value: +"Guidance on an empty page, naming which of its three causes applies: a query nothing matched, an offset past the end of a list that did match, or a cursor walk that has reached the end of the list. On a page carrying records, present when authorLimit cut at least one work list, naming how many and the route to the rest, or when every query term and filter value was supplied blank, so the page lists the whole index unfiltered. On any page, present when rows or authorLimit was above its per-call cap, naming the value requested and the cap applied — on an offset page with records remaining, also the offset that continues after the records returned. On an offset page where offset + rows would pass the ~10K offset ceiling, present naming the rows requested and the rows that fit and were applied, and, when records remain past the ceiling, cursor as the route to them. A page needing more than one caveat carries them all in this one string."
    • changedOutput schema / properties / works / items / properties / containerTitle / description
      Previous value: -"Journal or container name"New value: +"Journal or container name — the first entry of containerTitles"
    • addedOutput schema / properties / works / items / properties / containerTitles
      Added value: +{
      +  "description": "Every container title the record deposits, in deposited order. A book chapter or proceedings paper often deposits two: the series, then the book or volume. Omitted when the record deposits none.",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / works / items / properties / memberId
      Added value: +{
      +  "description": "Crossref member ID of the publisher that holds this DOI now — pass to crossref_get_member for its record. The DOI's prefix names the member that registered the prefix, which for a transferred title is a former publisher. Omitted when the record deposits no member.",
      +  "type": "number"
      +}
  5. Changed1 schema field changed
    • changedOutput schema / properties / works / items / properties / abstract / description
      Previous value: -"Abstract when present in the indexed record — the text of the publisher’s JATS deposit, with markup removed and character references decoded; a link keeps its tag only where its href holds an address the text it wraps does not already carry, and each formula appears once — MathML as the TeX annotation it carries, otherwise written out linearly (x_i, A^{−1}, √(m), (a+b)/c), and TeX deposited beside MathML in whichever notation comes first"New value: +"Abstract when present in the indexed record — the text of the publisher’s JATS deposit, with markup removed and character references decoded; numeric JATS superscripts retain caret notation (10^{16}, GeV^2), a link keeps its tag only where its href holds an address the text it wraps does not already carry, and each formula appears once — MathML as the TeX annotation it carries, otherwise written out linearly (x_i, A^{−1}, √(m), (a+b)/c), and TeX deposited beside MathML in whichever notation comes first"
  6. Changed12 schema fields changed
    • changedInput schema / properties / authorLimit / description
      Previous value: -"Maximum number of authors to return per work (1–500, default 25). Ordinary records fit under the default; large-collaboration papers deposit thousands, and a page of them is large enough to exhaust a client context. Each work reports its full deposited total as authorCount — call crossref_get_work with that work doi to page the authors this cap left out."New value: +"Maximum number of authors to return per work (1–500 per call, default 25; a larger value, up to 100000, applies 500 and says so in notice). Ordinary records fit under the default; large-collaboration papers deposit thousands, and a page of them is large enough to exhaust a client context. Each work reports its full deposited total as authorCount — call crossref_get_work with that work doi to page the authors this cap left out."
    • changedInput schema / properties / authorLimit / maximum
      Previous value: -500New value: +100000
    • changedInput schema / properties / cursor / description
      Previous value: -"Cursor token for deep paging. Pass \"*\" to start cursor-based paging (required past ~10K results), then pass the nextCursor value from each response until a response omits it, which means the list is exhausted. Cannot be combined with offset, or with a publication-date sort (published, published-print, published-online), which Crossref does not walk by cursor."New value: +"Cursor token for deep paging. Pass \"*\" to start cursor-based paging (required past ~10K results), then pass the nextCursor value from each response until a response omits it, which means the list is exhausted. A walk with a query term runs by relevance unless sort is set; a walk with filters only runs in Crossref registration order. Relevance scores shift slightly between identical requests, so a relevance walk can repeat or skip a record at a page boundary — sort:\"created\" walks every match without repeats. Cannot be combined with offset, or with a publication-date sort (published, published-print, published-online), which Crossref does not walk by cursor."
    • changedInput schema / properties / fields / description
      Previous value: -"Fields to return (reduces payload). Names are case-sensitive, and each fills one output field: DOI → doi, title → title, type → type, author → authors and authorCount, published / published-print / published-online → published, container-title → containerTitle, publisher → publisher, is-referenced-by-count → isReferencedByCount, score → score, abstract → abstract, volume → volume, issue → issue, page → page, article-number → articleNumber, ISSN → issn. A selected field absent from a work means the record does not deposit it. DOI is always returned whether or not it is listed here, so every result stays resolvable by crossref_get_work, which also returns the fields this list does not cover (license, funder, references, and the rest of the record)."New value: +"Fields to return (reduces payload). Names are case-sensitive, and each fills one output field: DOI → doi, title → title, type → type, author → authors and authorCount, published / published-print / published-online → published, container-title → containerTitle, publisher → publisher, is-referenced-by-count → isReferencedByCount, score → score, abstract → abstract, volume → volume, issue → issue, page → page, article-number → articleNumber, ISSN → issn, updated-by → updatedBy, update-to → updateTo. A selected field absent from a work means the record does not deposit it. DOI is always returned whether or not it is listed here, so every result stays resolvable by crossref_get_work, which also returns the fields this list does not cover (license, funder, references, and the rest of the record)."
    • changedInput schema / properties / fields / items / enum
      Previous value: -[
      -  "DOI",
      -  "title",
      -  "type",
      -  "author",
      -  "published",
      -  "published-print",
      -  "published-online",
      -  "container-title",
      -  "publisher",
      -  "is-referenced-by-count",
      -  "score",
      -  "abstract",
      -  "volume",
      -  "issue",
      -  "page",
      -  "article-number",
      -  "ISSN"
      -]New value: +[
      +  "DOI",
      +  "title",
      +  "type",
      +  "author",
      +  "published",
      +  "published-print",
      +  "published-online",
      +  "container-title",
      +  "publisher",
      +  "is-referenced-by-count",
      +  "score",
      +  "abstract",
      +  "volume",
      +  "issue",
      +  "page",
      +  "article-number",
      +  "ISSN",
      +  "updated-by",
      +  "update-to"
      +]
    • changedInput schema / properties / order / description
      Previous value: -"Sort direction (asc or desc)"New value: +"Sort direction (asc or desc). Applies only alongside sort; without one it has no effect."
    • changedInput schema / properties / rows / description
      Previous value: -"Number of results to return per page (1–100, default 20)"New value: +"Number of results to return per page (1–100 per call, default 20). A larger value, up to 1000, returns 100 and says so in notice — on an offset page the notice also names the offset that continues after the records returned."
    • changedInput schema / properties / rows / maximum
      Previous value: -100New value: +1000
    • changedInput schema / properties / sort / description
      Previous value: -"Sort field. The publication-date sorts (published, published-print, published-online) work with offset paging only — Crossref refuses them alongside cursor; every other sort works with either."New value: +"Sort field. Omitted, an offset page with a query term is ranked by relevance, and so is a cursor walk with one (sent as score). The publication-date sorts (published, published-print, published-online) work with offset paging only — Crossref refuses them alongside cursor; every other sort works with either."
    • changedOutput schema / properties / notice / description
      Previous value: -"Guidance on an empty page, naming which of its three causes applies: a query nothing matched, an offset past the end of a list that did match, or a cursor walk that has reached the end of the list. On a page carrying records, present when authorLimit cut at least one work list, naming how many and the route to the rest, or when every query term and filter value was supplied blank, so the page lists the whole index unfiltered. A page needing more than one caveat carries them all in this one string."New value: +"Guidance on an empty page, naming which of its three causes applies: a query nothing matched, an offset past the end of a list that did match, or a cursor walk that has reached the end of the list. On a page carrying records, present when authorLimit cut at least one work list, naming how many and the route to the rest, or when every query term and filter value was supplied blank, so the page lists the whole index unfiltered. On any page, present when rows or authorLimit was above its per-call cap, naming the value requested and the cap applied — on an offset page with records remaining, also the offset that continues after the records returned, with the smaller rows that still fit when a full page there would pass the ~10K offset ceiling. A page needing more than one caveat carries them all in this one string."
    • addedOutput schema / properties / works / items / properties / updateTo
      Added value: +{
      +  "description": "Works this record is an update notice for, in the entry shape updatedBy uses and in deposited order. Omitted when the record is not registered as a notice.",
      +  "items": {
      +    "additionalProperties": false,
      +    "description": "Update link",
      +    "properties": {
      +      "doi": {
      +        "description": "DOI on the other side of the link: the notice, in updatedBy; the updated work, in updateTo. It is this work's own DOI when the update was made to this record in place.",
      +        "type": "string"
      +      },
      +      "recordId": {
      +        "description": "Retraction Watch record ID. Present only on retraction-watch entries.",
      +        "type": "string"
      +      },
      +      "source": {
      +        "description": "Who recorded the link: publisher, or retraction-watch for an entry Crossref carries from the Retraction Watch database",
      +        "type": "string"
      +      },
      +      "type": {
      +        "description": "Crossref update type as deposited: correction, erratum, corrigendum, addendum, retraction, withdrawal, expression_of_concern, new_version, new_edition, or another code",
      +        "type": "string"
      +      },
      +      "updated": {
      +        "additionalProperties": false,
      +        "description": "Date the update was issued",
      +        "properties": {
      +          "day": {
      +            "description": "Day of month",
      +            "type": "number"
      +          },
      +          "month": {
      +            "description": "Month (1–12)",
      +            "type": "number"
      +          },
      +          "year": {
      +            "description": "Year",
      +            "type": "number"
      +          }
      +        },
      +        "type": "object"
      +      }
      +    },
      +    "required": [
      +      "doi",
      +      "type",
      +      "source"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / works / items / properties / updatedBy
      Added value: +{
      +  "description": "Update notices Crossref records against this work — corrections, errata, retractions, expressions of concern, withdrawals, new versions — in deposited order. Entries are never merged: the same notice DOI can appear once per source, typed differently by each. Omitted when none is recorded, which does not mean the work was never updated: coverage depends on publisher and Retraction Watch deposits.",
      +  "items": {
      +    "additionalProperties": false,
      +    "description": "Update link",
      +    "properties": {
      +      "doi": {
      +        "description": "DOI on the other side of the link: the notice, in updatedBy; the updated work, in updateTo. It is this work's own DOI when the update was made to this record in place.",
      +        "type": "string"
      +      },
      +      "recordId": {
      +        "description": "Retraction Watch record ID. Present only on retraction-watch entries.",
      +        "type": "string"
      +      },
      +      "source": {
      +        "description": "Who recorded the link: publisher, or retraction-watch for an entry Crossref carries from the Retraction Watch database",
      +        "type": "string"
      +      },
      +      "type": {
      +        "description": "Crossref update type as deposited: correction, erratum, corrigendum, addendum, retraction, withdrawal, expression_of_concern, new_version, new_edition, or another code",
      +        "type": "string"
      +      },
      +      "updated": {
      +        "additionalProperties": false,
      +        "description": "Date the update was issued",
      +        "properties": {
      +          "day": {
      +            "description": "Day of month",
      +            "type": "number"
      +          },
      +          "month": {
      +            "description": "Month (1–12)",
      +            "type": "number"
      +          },
      +          "year": {
      +            "description": "Year",
      +            "type": "number"
      +          }
      +        },
      +        "type": "object"
      +      }
      +    },
      +    "required": [
      +      "doi",
      +      "type",
      +      "source"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
  7. Changed1 schema field changed
    • changedOutput schema / properties / works / items / properties / abstract / description
      Previous value: -"Abstract when present in the indexed record — the text of the publisher’s JATS deposit, with markup removed and character references decoded; a link keeps its tag only where its href holds an address the text it wraps does not already carry, and a formula the deposit encodes more than once appears once, in the first notation deposited"New value: +"Abstract when present in the indexed record — the text of the publisher’s JATS deposit, with markup removed and character references decoded; a link keeps its tag only where its href holds an address the text it wraps does not already carry, and each formula appears once — MathML as the TeX annotation it carries, otherwise written out linearly (x_i, A^{−1}, √(m), (a+b)/c), and TeX deposited beside MathML in whichever notation comes first"
  8. Changed23 schema fields changed
    • changedInput schema / properties / cursor / description
      Previous value: -"Cursor token for deep paging. Pass \"*\" to start cursor-based paging (required past ~10K results), then pass the nextCursor value from each response until a response omits it, which means the list is exhausted. Cannot be combined with offset."New value: +"Cursor token for deep paging. Pass \"*\" to start cursor-based paging (required past ~10K results), then pass the nextCursor value from each response until a response omits it, which means the list is exhausted. Cannot be combined with offset, or with a publication-date sort (published, published-print, published-online), which Crossref does not walk by cursor."
    • changedInput schema / properties / fields / description
      Previous value: -"Fields to return (reduces payload). Names are case-sensitive. Useful set: DOI, title, author, published, type, is-referenced-by-count, abstract, container-title, publisher, score. DOI is always returned whether or not it is listed here, so every result stays resolvable by crossref_get_work."New value: +"Fields to return (reduces payload). Names are case-sensitive, and each fills one output field: DOI → doi, title → title, type → type, author → authors and authorCount, published / published-print / published-online → published, container-title → containerTitle, publisher → publisher, is-referenced-by-count → isReferencedByCount, score → score, abstract → abstract, volume → volume, issue → issue, page → page, article-number → articleNumber, ISSN → issn. A selected field absent from a work means the record does not deposit it. DOI is always returned whether or not it is listed here, so every result stays resolvable by crossref_get_work, which also returns the fields this list does not cover (license, funder, references, and the rest of the record)."
    • addedInput schema / properties / fields / items / description
      Added value: +"Crossref select name"
    • addedInput schema / properties / fields / items / enum
      Added value: +[
      +  "DOI",
      +  "title",
      +  "type",
      +  "author",
      +  "published",
      +  "published-print",
      +  "published-online",
      +  "container-title",
      +  "publisher",
      +  "is-referenced-by-count",
      +  "score",
      +  "abstract",
      +  "volume",
      +  "issue",
      +  "page",
      +  "article-number",
      +  "ISSN"
      +]
    • changedInput schema / properties / filter / description
      Previous value: -"Structured filter object using Crossref hyphen-separated keys. All values must be strings. Boolean flag keys (has-abstract, has-references, has-full-text) require string values \"true\" or \"false\". Example: {\"type\":\"journal-article\",\"has-abstract\":\"true\",\"from-pub-date\":\"2023-01-01\",\"directory\":\"DOAJ\"}"New value: +"Structured filter object using Crossref hyphen-separated keys. All values must be strings. Boolean flag keys (has-abstract, has-references, has-full-text) require string values \"true\" or \"false\". Example: {\"type\":\"journal-article\",\"has-abstract\":\"true\",\"from-pub-date\":\"2023-01-01\"}"
    • addedInput schema / properties / offset / maximum
      Added value: +9007199254740991
    • changedInput schema / properties / offset / type
      Previous value: -"number"New value: +"integer"
    • addedInput schema / properties / order / anyOf
      Added value: +[
      +  {
      +    "const": "",
      +    "type": "string"
      +  },
      +  {
      +    "description": "Sort direction",
      +    "enum": [
      +      "asc",
      +      "desc"
      +    ],
      +    "type": "string"
      +  }
      +]
    • removedInput schema / properties / order / enum
      Removed value: -[
      -  "asc",
      -  "desc"
      -]
    • removedInput schema / properties / order / type
      Removed value: -"string"
    • changedInput schema / properties / rows / type
      Previous value: -"number"New value: +"integer"
    • addedInput schema / properties / sort / anyOf
      Added value: +[
      +  {
      +    "const": "",
      +    "type": "string"
      +  },
      +  {
      +    "description": "Crossref sort field",
      +    "enum": [
      +      "relevance",
      +      "score",
      +      "is-referenced-by-count",
      +      "published",
      +      "published-print",
      +      "published-online",
      +      "deposited",
      +      "indexed",
      +      "created",
      +      "updated",
      +      "references-count"
      +    ],
      +    "type": "string"
      +  }
      +]
    • changedInput schema / properties / sort / description
      Previous value: -"Sort field"New value: +"Sort field. The publication-date sorts (published, published-print, published-online) work with offset paging only — Crossref refuses them alongside cursor; every other sort works with either."
    • removedInput schema / properties / sort / enum
      Removed value: -[
      -  "relevance",
      -  "score",
      -  "is-referenced-by-count",
      -  "published",
      -  "published-print",
      -  "published-online",
      -  "deposited",
      -  "indexed",
      -  "created",
      -  "updated",
      -  "references-count"
      -]
    • removedInput schema / properties / sort / type
      Removed value: -"string"
    • changedOutput schema / properties / error / properties / data / properties / reason / description
      Previous value: -"Machine-readable failure mode. Declared by this tool: `rate_limited`: Crossref answered HTTP 429 and the limit did not clear inside the retry budget. `upstream_unavailable`: Crossref was unreachable, returned a 5xx status, or served an HTML error page instead of JSON. `malformed_response`: Crossref returned HTTP 200 with a body that is not valid JSON. `request_timeout`: Crossref did not respond within CROSSREF_TIMEOUT_MS, or answered HTTP 408/504. `cursor_offset_conflict`: Both cursor and offset were supplied in the same request. `offset_too_large`: The requested offset exceeds the ~10K Crossref limit for offset-based paging. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `rate_limited`: Crossref answered HTTP 429 and the limit did not clear inside the retry budget. `upstream_unavailable`: Crossref was unreachable, returned a 5xx status, or served an HTML error page instead of JSON. `malformed_response`: Crossref returned HTTP 200 with a body that is not valid JSON. `request_timeout`: Crossref did not respond within CROSSREF_TIMEOUT_MS, or answered HTTP 408/504. `unknown_filter`: Crossref rejected a filter key it does not recognize (filter-not-available). `sort_cursor_conflict`: A publication-date sort (published, published-print, published-online) was combined with cursor paging, which Crossref refuses. `invalid_cursor`: Crossref did not recognize the cursor token (HTTP 404 cursor-invalid). `invalid_parameter`: Crossref rejected a parameter value (a filter value of the wrong type or form), or answered HTTP 400 with a body that did not parse. `cursor_offset_conflict`: Both cursor and offset were supplied in the same request. `offset_too_large`: The requested offset exceeds the ~10K Crossref limit for offset-based paging. Other values are possible when a failure originates below the handler."
    • changedOutput schema / properties / error / properties / data / properties / reason / examples
      Previous value: -[
      -  "rate_limited",
      -  "upstream_unavailable",
      -  "malformed_response",
      -  "request_timeout",
      -  "cursor_offset_conflict",
      -  "offset_too_large"
      -]New value: +[
      +  "rate_limited",
      +  "upstream_unavailable",
      +  "malformed_response",
      +  "request_timeout",
      +  "unknown_filter",
      +  "sort_cursor_conflict",
      +  "invalid_cursor",
      +  "invalid_parameter",
      +  "cursor_offset_conflict",
      +  "offset_too_large"
      +]
    • changedOutput schema / properties / notice / description
      Previous value: -"Guidance on an empty page, naming which of its three causes applies: a query nothing matched, an offset past the end of a list that did match, or a cursor walk that has reached the end of the list. On a page carrying records, present only when authorLimit cut at least one work list, naming how many and the route to the rest."New value: +"Guidance on an empty page, naming which of its three causes applies: a query nothing matched, an offset past the end of a list that did match, or a cursor walk that has reached the end of the list. On a page carrying records, present when authorLimit cut at least one work list, naming how many and the route to the rest, or when every query term and filter value was supplied blank, so the page lists the whole index unfiltered. A page needing more than one caveat carries them all in this one string."
    • addedOutput schema / properties / works / items / properties / articleNumber
      Added value: +{
      +  "description": "Article number, deposited by journals that number articles instead of paging them",
      +  "type": "string"
      +}
    • addedOutput schema / properties / works / items / properties / issn
      Added value: +{
      +  "description": "ISSN(s) of the containing journal",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / works / items / properties / issue
      Added value: +{
      +  "description": "Issue of the container the work appears in",
      +  "type": "string"
      +}
    • addedOutput schema / properties / works / items / properties / page
      Added value: +{
      +  "description": "Page range as deposited, e.g. \"357-362\"",
      +  "type": "string"
      +}
    • addedOutput schema / properties / works / items / properties / volume
      Added value: +{
      +  "description": "Volume of the container the work appears in",
      +  "type": "string"
      +}
  9. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Beyond readOnlyHint and openWorldHint, it discloses the index size, default relevance behavior, sort compatibility with cursor paging, offset cap around 10K, cursor exhaustion via missing nextCursor, author and funder caps with counts, facet behavior, and update semantics. These are substantial operational details that the annotations do not provide.

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?

The description is a dense single paragraph, but it is front-loaded with purpose and then sequences query, filters, sorting, caps, facets, and paging in a logical order. It is long and overlaps with the detailed schema, but most sentences carry operational value for a complex search tool.

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 14 parameters, nested filter and facets objects, an output schema, and open-world read-only annotations, the description covers the important operational edges: paging limits, cursor behavior, field selection, facet counting, author and funder caps, and update fields. Nothing essential for correct invocation appears missing.

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 description coverage is 100%, so the baseline is 3. The description still adds inter-parameter meaning: it explains loose query versus precise field-specific queries, queryBibliographic for citation resolution, that these combine, and how cursor and offset cannot be combined. It repeats several schema-documented details, so it is not a 5.

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?

The description opens with a specific verb and resource: searches the Crossref works index (~188M records) by free text and/or structured filters. It distinguishes the generic query from field-specific query parameters and from crossref_get_work for full author paging and fields this list does not cover.

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?

It gives explicit selection guidance: generic query for loose matching, queryTitle/queryAuthor/queryContainerTitle for precise scoping, queryBibliographic for citation-to-DOI resolution, and filter for structured filtering. It also names crossref_get_work as the alternative when authors are capped or fields such as funders are needed.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.