Orcid Tools#

Configuration File: orcid_tools.json Tool Type: Local Tools Count: 6

This page contains all tools defined in the orcid_tools.json configuration file.

Available Tools#

ORCID_get_employments (Type: ORCIDTool)#

Get employment and affiliation history for an ORCID researcher. Returns organization names, depar…

ORCID_get_employments tool specification

Tool Information:

  • Name: ORCID_get_employments

  • Type: ORCIDTool

  • Description: Get employment and affiliation history for an ORCID researcher. Returns organization names, departments, roles, and employment date ranges. Use for: verifying academic affiliations, tracing career history, finding current institution.

Parameters:

  • operation (string) (optional) Operation type

  • orcid (string) (required) ORCID iD in format XXXX-XXXX-XXXX-XXXX

Example Usage:

query = {
    "name": "ORCID_get_employments",
    "arguments": {
        "orcid": "example_value"
    }
}
result = tu.run(query)

ORCID_get_fundings (Type: ORCIDTool)#

Get every public funding-summary assertion in every ORCID funding group, including group/summary …

ORCID_get_fundings tool specification

Tool Information:

  • Name: ORCID_get_fundings

  • Type: ORCIDTool

  • Description: Get every public funding-summary assertion in every ORCID funding group, including group/summary indexes, group and summary external IDs, title, funder, type, dates, and URL. Metadata distinguishes funding groups from summaries and confirms no grouped source assertion was silently dropped.

Parameters:

  • operation (string) (optional) Operation type

  • orcid (string) (required) ORCID iD in format XXXX-XXXX-XXXX-XXXX (e.g., ‘0000-0001-5109-3700’)

Example Usage:

query = {
    "name": "ORCID_get_fundings",
    "arguments": {
        "orcid": "example_value"
    }
}
result = tu.run(query)

ORCID_get_peer_reviews (Type: ORCIDTool)#

Get every public peer-review-summary assertion across all ORCID groups and subgroups. Returns gro…

ORCID_get_peer_reviews tool specification

Tool Information:

  • Name: ORCID_get_peer_reviews

  • Type: ORCIDTool

  • Description: Get every public peer-review-summary assertion across all ORCID groups and subgroups. Returns group/subgroup/summary indexes, role, review type, group ID, convening organization, completion date, and URL. Metadata reports all three hierarchy counts and confirms all summaries were returned.

Parameters:

  • operation (string) (optional) Operation type

  • orcid (string) (required) ORCID iD in format XXXX-XXXX-XXXX-XXXX (e.g., ‘0000-0001-5109-3700’)

Example Usage:

query = {
    "name": "ORCID_get_peer_reviews",
    "arguments": {
        "orcid": "example_value"
    }
}
result = tu.run(query)

ORCID_get_profile (Type: ORCIDTool)#

Get the complete public ORCID record after format and ISO 7064 checksum validation. Returns the r…

ORCID_get_profile tool specification

Tool Information:

  • Name: ORCID_get_profile

  • Type: ORCIDTool

  • Description: Get the complete public ORCID record after format and ISO 7064 checksum validation. Returns the raw person and activities-summary objects plus convenience fields. Legacy works_count/employments_count are explicitly group counts; separate group and summary counts prevent grouped assertions from being mistaken for individual works or employments.

Parameters:

  • operation (string) (optional) Operation type

  • orcid (string) (required) ORCID iD in format XXXX-XXXX-XXXX-XXXX (e.g., ‘0000-0002-1825-0097’)

Example Usage:

query = {
    "name": "ORCID_get_profile",
    "arguments": {
        "orcid": "example_value"
    }
}
result = tu.run(query)

ORCID_get_works (Type: ORCIDTool)#

Get every public work-summary assertion for an ORCID researcher. ORCID groups equivalent works fr…

ORCID_get_works tool specification

Tool Information:

  • Name: ORCID_get_works

  • Type: ORCIDTool

  • Description: Get every public work-summary assertion for an ORCID researcher. ORCID groups equivalent works from multiple sources; this wrapper returns every summary in every group (not only the first), with group/summary indexes and group external IDs. Metadata distinguishes work_group_count from work_summary_count and confirms all summaries were returned.

Parameters:

  • operation (string) (optional) Operation type

  • orcid (string) (required) ORCID iD in format XXXX-XXXX-XXXX-XXXX

Example Usage:

query = {
    "name": "ORCID_get_works",
    "arguments": {
        "orcid": "example_value"
    }
}
result = tu.run(query)

ORCID_search_researchers (Type: ORCIDTool)#

Search ORCID expanded-search with strict start/rows controls. Returns names, other names, institu…

ORCID_search_researchers tool specification

Tool Information:

  • Name: ORCID_search_researchers

  • Type: ORCIDTool

  • Description: Search ORCID expanded-search with strict start/rows controls. Returns names, other names, institutions, and checksum-validated ORCID iDs. Metadata exposes total_found, returned, has_more, next_start, and page_complete; continue with next_start while has_more is true. Live family-name:Smith currently has over 24,000 records.

Parameters:

  • operation (string) (optional) Operation type

  • query (string) (required) Search query (e.g., ‘BRCA1 cancer genetics’, ‘Harvard genomics’)

  • start (integer) (optional) Pagination offset (0-based)

  • rows (integer) (optional) Number of results to return

Example Usage:

query = {
    "name": "ORCID_search_researchers",
    "arguments": {
        "query": "example_value"
    }
}
result = tu.run(query)