Skip to main content
Glama

Get ORCID Research Resources

orcid_get_research_resources
Read-onlyIdempotent

List allocation proposals for an ORCID researcher, or supply put_code from a summary record to retrieve its actual resource items. Summary is the default view and includes every proposal host, identifiers, access period, and source provenance; hostOrganization remains the first proposal host. Detail adds item names, types, all operators, identifiers, and URLs, paged by item_offset and item_limit (both require put_code); continue at nextItemOffset with the same put_code. Most researchers have no entries; allocation systems such as ACCESS deposit these records.

Input Schema

NameRequiredDescriptionDefault
orcid_idYesORCID iD — bare (0000-0001-2345-6789) or as an orcid.org URI (https://orcid.org/0000-0001-2345-6789). The check digit may be X or x.
put_codeNoProposal put-code from summary mode; selects the full allocation detail.
item_limitNoItems per detail page. Default 25; a larger value returns at most 100 and says so. Requires put_code.
item_offsetNoDetail item offset. Default 0; requires put_code.

Output Schema

NameRequiredDescriptionDefault
viewNoSummary list or selected allocation detail.
errorNoPresent when the call failed. Absent on success.
noticeNoNote when no research resources are found — this section is sparsely populated across ORCID profiles — or when a deprecated iD was served from its primary iD.
orcidIdNoNormalized ORCID iD (bare format).
putCodeNoSelected proposal put-code in detail mode.
orcidUriNoFull ORCID URI.
resourcesNoResearch resources associated with this ORCID iD.
truncatedNoDetail-page indicator: true exactly when the selected resource has allocation items remaining after this page; mirrors itemsTruncated. Absent in summary mode.
resourceCountNoTotal number of research resources returned.
itemLimitNoticeNoNotice when the requested item limit is reduced to the effective maximum of 100.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • changedInput schema / properties / item_limit / description
      Previous value: -"Detail page size, default 50, effective maximum 100; requires put_code."New value: +"Items per detail page. Default 25; a larger value returns at most 100 and says so. Requires put_code."
    • changedInput schema / properties / item_offset / description
      Previous value: -"Detail item offset, default 0; requires put_code."New value: +"Detail item offset. Default 0; requires put_code."
    • removedOutput schema / properties / budgetOverflow
      Removed value: -{
      -  "description": "Explicit exception when an indivisible item or proposal metadata exceeds the 64,000-byte surface budget.",
      -  "type": "string"
      -}
    • changedOutput schema / properties / notice / description
      Previous value: -"Note when no research resources are found — this section is sparsely populated across ORCID profiles."New value: +"Note when no research resources are found — this section is sparsely populated across ORCID profiles — or when a deprecated iD was served from its primary iD."
    • changedOutput schema / properties / resources / items / properties / sources / items / properties / selfAsserted / description
      Previous value: -"True when the asserting party (the assertion origin when recorded, otherwise the source) is the requested ORCID iD; false when a member organization or another ORCID user asserted the item."New value: +"True when the asserting party (the assertion origin when recorded, otherwise the source) is the record's ORCID iD (orcidId); false when a member organization or another ORCID user asserted the item."
  2. Changed18 schema fields changed
    • addedInput schema / properties / item_limit
      Added value: +{
      +  "description": "Detail page size, default 50, effective maximum 100; requires put_code.",
      +  "maximum": 10000,
      +  "minimum": 1,
      +  "type": "integer"
      +}
    • addedInput schema / properties / item_offset
      Added value: +{
      +  "description": "Detail item offset, default 0; requires put_code.",
      +  "maximum": 9007199254740991,
      +  "minimum": 0,
      +  "type": "integer"
      +}
    • addedInput schema / properties / put_code
      Added value: +{
      +  "description": "Proposal put-code from summary mode; selects the full allocation detail.",
      +  "exclusiveMinimum": 0,
      +  "maximum": 9007199254740991,
      +  "type": "integer"
      +}
    • changedOutput schema / anyOf
      Previous value: -[
      -  {
      -    "not": {
      -      "required": [
      -        "error"
      -      ]
      -    },
      -    "required": [
      -      "orcidId",
      -      "orcidUri",
      -      "resourceCount",
      -      "resources"
      -    ]
      -  },
      -  {
      -    "required": [
      -      "error"
      -    ]
      -  }
      -]New value: +[
      +  {
      +    "not": {
      +      "required": [
      +        "error"
      +      ]
      +    },
      +    "required": [
      +      "orcidId",
      +      "orcidUri",
      +      "view",
      +      "resourceCount",
      +      "resources"
      +    ]
      +  },
      +  {
      +    "required": [
      +      "error"
      +    ]
      +  }
      +]
    • addedOutput schema / properties / budgetOverflow
      Added value: +{
      +  "description": "Explicit exception when an indivisible item or proposal metadata exceeds the 64,000-byte surface budget.",
      +  "type": "string"
      +}
    • changedOutput schema / properties / error / properties / data / properties / reason / description
      Previous value: -"Machine-readable failure mode. Declared by this tool: `profile_not_found`: The ORCID iD does not correspond to a registered researcher. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `detail_required`: Item paging arguments are supplied without put_code. `resource_not_found`: The selected allocation detail does not exist or is not public. `profile_not_found`: The ORCID iD does not correspond to a registered researcher. Other values are possible when a failure originates below the handler."
    • changedOutput schema / properties / error / properties / data / properties / reason / examples
      Previous value: -[
      -  "profile_not_found"
      -]New value: +[
      +  "detail_required",
      +  "resource_not_found",
      +  "profile_not_found"
      +]
    • addedOutput schema / properties / itemLimitNotice
      Added value: +{
      +  "description": "Notice when the requested item limit is reduced to the effective maximum of 100.",
      +  "type": "string"
      +}
    • addedOutput schema / properties / putCode
      Added value: +{
      +  "description": "Selected proposal put-code in detail mode.",
      +  "type": "number"
      +}
    • addedOutput schema / properties / resources / items / properties / itemCount
      Added value: +{
      +  "description": "Total deposited allocation items.",
      +  "type": "number"
      +}
    • addedOutput schema / properties / resources / items / properties / itemOffset
      Added value: +{
      +  "description": "Requested detail item offset.",
      +  "type": "number"
      +}
    • addedOutput schema / properties / resources / items / properties / items
      Added value: +{
      +  "description": "Selected page of allocation items in detail mode.",
      +  "items": {
      +    "additionalProperties": false,
      +    "description": "One deposited allocation item.",
      +    "properties": {
      +      "externalIds": {
      +        "description": "Deposited item identifiers.",
      +        "items": {
      +          "additionalProperties": false,
      +          "description": "External identifier for the research resource.",
      +          "properties": {
      +            "relationship": {
      +              "description": "Relationship to the resource (self or part-of).",
      +              "type": "string"
      +            },
      +            "type": {
      +              "description": "Identifier type (e.g. uri, doi, grant_number).",
      +              "type": "string"
      +            },
      +            "url": {
      +              "description": "Resolver URL for this identifier, if available.",
      +              "type": "string"
      +            },
      +            "value": {
      +              "description": "Identifier value.",
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "type",
      +            "value"
      +          ],
      +          "type": "object"
      +        },
      +        "type": "array"
      +      },
      +      "hosts": {
      +        "description": "All item operators in upstream order; missing host details remain unknown.",
      +        "items": {
      +          "additionalProperties": false,
      +          "description": "Hosting organization for the research resource.",
      +          "properties": {
      +            "city": {
      +              "description": "City of the organization.",
      +              "type": "string"
      +            },
      +            "country": {
      +              "description": "Country code of the organization.",
      +              "type": "string"
      +            },
      +            "disambiguatedId": {
      +              "description": "Disambiguated organization ID (e.g. ROR or GRID identifier).",
      +              "type": "string"
      +            },
      +            "disambiguationSource": {
      +              "description": "Source of the disambiguation ID (e.g. ROR, GRID, RINGGOLD).",
      +              "type": "string"
      +            },
      +            "name": {
      +              "description": "Organization name.",
      +              "type": "string"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "type": "array"
      +      },
      +      "name": {
      +        "description": "Allocated resource name.",
      +        "type": "string"
      +      },
      +      "type": {
      +        "description": "Allocated resource type.",
      +        "type": "string"
      +      },
      +      "url": {
      +        "description": "Deposited item URL.",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "hosts",
      +      "externalIds"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / resources / items / properties / itemsTruncated
      Added value: +{
      +  "description": "Whether more allocation items remain after this page.",
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / resources / items / properties / nextItemOffset
      Added value: +{
      +  "description": "First omitted item offset; absent when no items remain.",
      +  "type": "number"
      +}
    • addedOutput schema / properties / resources / items / properties / proposalHosts
      Added value: +{
      +  "description": "All proposal hosts in upstream order; separate from item operators.",
      +  "items": {
      +    "additionalProperties": false,
      +    "description": "Hosting organization for the research resource.",
      +    "properties": {
      +      "city": {
      +        "description": "City of the organization.",
      +        "type": "string"
      +      },
      +      "country": {
      +        "description": "Country code of the organization.",
      +        "type": "string"
      +      },
      +      "disambiguatedId": {
      +        "description": "Disambiguated organization ID (e.g. ROR or GRID identifier).",
      +        "type": "string"
      +      },
      +      "disambiguationSource": {
      +        "description": "Source of the disambiguation ID (e.g. ROR, GRID, RINGGOLD).",
      +        "type": "string"
      +      },
      +      "name": {
      +        "description": "Organization name.",
      +        "type": "string"
      +      }
      +    },
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / resources / items / properties / returnedItemCount
      Added value: +{
      +  "description": "Items returned on this page.",
      +  "type": "number"
      +}
    • addedOutput schema / properties / truncated
      Added value: +{
      +  "description": "Detail-page indicator: true exactly when the selected resource has allocation items remaining after this page; mirrors itemsTruncated. Absent in summary mode.",
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / view
      Added value: +{
      +  "description": "Summary list or selected allocation detail.",
      +  "enum": [
      +    "summary",
      +    "detail"
      +  ],
      +  "type": "string"
      +}
  3. Changed4 schema fields changed
    • changedInput schema / properties / orcid_id / description
      Previous value: -"ORCID iD — bare format (0000-0001-2345-6789) or full URI (https://orcid.org/0000-0001-2345-6789)."New value: +"ORCID iD — bare (0000-0001-2345-6789) or as an orcid.org URI (https://orcid.org/0000-0001-2345-6789). The check digit may be X or x."
    • changedInput schema / properties / orcid_id / pattern
      Previous value: -"^(https?:\\/\\/orcid\\.org\\/)?\\d{4}-\\d{4}-\\d{4}-\\d{3}[\\dX]$"New value: +"^(?:(?:https?:\\/\\/)?(?:www\\.)?orcid\\.org\\/)?\\d{4}-\\d{4}-\\d{4}-\\d{3}[\\dXx]\\/?$"
    • addedOutput schema / properties / resources / items / properties / sources
      Added value: +{
      +  "description": "The party that added this resource to the ORCID record — usually the allocation system that granted it. Empty when ORCID records no source.",
      +  "items": {
      +    "additionalProperties": false,
      +    "description": "A party that asserted this item on the ORCID record.",
      +    "properties": {
      +      "assertionOriginName": {
      +        "description": "Party the source added the item on behalf of, when ORCID records one — usually the researcher, for an item added through a search-and-link tool.",
      +        "type": "string"
      +      },
      +      "name": {
      +        "description": "Name of the person or member organization system that added the item (e.g. a university research information system, Crossref, Scopus - Elsevier). Absent when ORCID records no name.",
      +        "type": "string"
      +      },
      +      "selfAsserted": {
      +        "description": "True when the asserting party (the assertion origin when recorded, otherwise the source) is the requested ORCID iD; false when a member organization or another ORCID user asserted the item.",
      +        "type": "boolean"
      +      }
      +    },
      +    "required": [
      +      "selfAsserted"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • changedOutput schema / properties / resources / items / required
      Previous value: -[
      -  "putCode",
      -  "externalIds"
      -]New value: +[
      +  "putCode",
      +  "externalIds",
      +  "sources"
      +]
  4. Changed6 schema fields changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • addedInput schema / additionalProperties
      Added value: +false
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • addedOutput schema / anyOf
      Added value: +[
      +  {
      +    "not": {
      +      "required": [
      +        "error"
      +      ]
      +    },
      +    "required": [
      +      "orcidId",
      +      "orcidUri",
      +      "resourceCount",
      +      "resources"
      +    ]
      +  },
      +  {
      +    "required": [
      +      "error"
      +    ]
      +  }
      +]
    • addedOutput schema / properties / error
      Added value: +{
      +  "additionalProperties": {},
      +  "description": "Present when the call failed. Absent on success.",
      +  "properties": {
      +    "code": {
      +      "description": "JSON-RPC error code for this failure.",
      +      "maximum": 9007199254740991,
      +      "minimum": -9007199254740991,
      +      "type": "integer"
      +    },
      +    "data": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "reason": {
      +          "description": "Machine-readable failure mode. Declared by this tool: `profile_not_found`: The ORCID iD does not correspond to a registered researcher. Other values are possible when a failure originates below the handler.",
      +          "examples": [
      +            "profile_not_found"
      +          ],
      +          "type": "string"
      +        },
      +        "recovery": {
      +          "additionalProperties": {},
      +          "description": "Actionable next step for the caller.",
      +          "properties": {
      +            "hint": {
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "hint"
      +          ],
      +          "type": "object"
      +        },
      +        "retryable": {
      +          "description": "Whether retrying may succeed.",
      +          "type": "boolean"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "message": {
      +      "description": "Human-readable description of what went wrong.",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "code",
      +    "message"
      +  ],
      +  "type": "object"
      +}
    • removedOutput schema / required
      Removed value: -[
      -  "orcidId",
      -  "orcidUri",
      -  "resourceCount",
      -  "resources"
      -]
  5. Added

TDQS

A4.3/5.0
Behavior4/5

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

The annotations already declare readOnly/idempotent/openWorld, so the description's job is to add operating context, and it does: the default summary contents, the guarantee that hostOrganization is the first proposal host, the detail field set, paging via item_offset/item_limit, the continuation rule at nextItemOffset, and the fact that item_limit is capped at 100 despite the schema's 10000 maximum. It omits auth or error behavior, so it falls short of a 5.

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

Conciseness4/5

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

Purpose and mode selection are front-loaded in the first sentence, and the remaining clauses all carry information (defaults, paging, data source). The semicolon-chained phrasing is dense and could be split for scannability, but there is no filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return shapes need not be restated, and the description covers mode selection, paging, and expectations about sparse data. Given a 4-parameter tool with full schema coverage and annotations, it is nearly complete, though it says nothing about failure or resolution behavior for an invalid orcid_id.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3; the description goes beyond it by stating the dependency semantics, namely that item_offset and item_limit 'both require put_code' and that put_code selects the full detail. It also flags the effective 100-item cap that the schema alone does not convey. These are real added constraints beyond the schema text.

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 names a specific verb ('List allocation proposals') and resource, and immediately distinguishes its two modes: a summary listing versus detail retrieval by put_code. It clearly sets the tool apart from the sibling set (funding, works, affiliations, peer reviews) by naming allocation proposals as the resource.

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

Usage Guidelines4/5

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

The description gives explicit guidance on when to use summary (the default view) versus detail (supply put_code), and how to continue paging with nextItemOffset. It also sets expectations that 'most researchers have no entries'. It does not compare against sibling tools, which keeps it from a 5.

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.