Openneuro Tools

Configuration File: openneuro_tools.json Tool Type: Local Tools Count: 7

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

Available Tools

OpenNeuro_advanced_search (Type: OpenNeuroTool)

Faceted search across all OpenNeuro datasets plus the archive-wide total participant count. Retur…

OpenNeuro_advanced_search tool specification

Tool Information:

• Name: OpenNeuro_advanced_search

• Type: OpenNeuroTool

• Description: Faceted search across all OpenNeuro datasets plus the archive-wide total participant count. Returns participantCount (total number of subjects across the whole OpenNeuro archive) and advancedSearch with pageInfo.count (number of datasets matching the facet filters) and a best-effort list of matching dataset IDs. Pass any combination of flat facet arguments (species, sex, diagnosis, modality, tasks, keywords, scannerManufacturers, tracerNames, studyDomains, ageRange, subjectCountRange, authors, bodyParts, bidsDatasetType, tracerRadionuclides); omit all to count the whole archive. Note: some matched datasets are not anonymously readable, so a few edges may be omitted, but the counts remain accurate.

Parameters:

• species ([‘string’, ‘null’]) (optional) Species facet (e.g., ‘human’)

• sex ([‘string’, ‘null’]) (optional) Participant sex facet (e.g., ‘Male’, ‘Female’)

• diagnosis ([‘string’, ‘null’]) (optional) Clinical diagnosis facet

• modality ([‘string’, ‘null’]) (optional) Imaging modality facet (e.g., ‘MRI’, ‘EEG’, ‘PET’)

• tasks ([‘string’, ‘null’]) (optional) Task name facet

• keywords ([‘array’, ‘null’]) (optional) Keyword facets (list of strings)

• scannerManufacturers ([‘string’, ‘null’]) (optional) Scanner manufacturer facet (e.g., ‘Siemens’)

• tracerNames ([‘string’, ‘null’]) (optional) PET tracer name facet

• tracerRadionuclides ([‘string’, ‘null’]) (optional) PET tracer radionuclide facet

• studyDomains ([‘string’, ‘null’]) (optional) Study domain facet

• bodyParts ([‘string’, ‘null’]) (optional) Body part facet

• authors ([‘string’, ‘null’]) (optional) Author name facet

• bidsDatasetType ([‘string’, ‘null’]) (optional) BIDS dataset type facet (e.g., ‘raw’, ‘derivative’)

• ageRange ([‘array’, ‘null’]) (optional) Participant age range as [min, max]

• subjectCountRange ([‘array’, ‘null’]) (optional) Subject-count range as [min, max]

• first ([‘integer’, ‘null’]) (optional) Number of matching datasets to return (default 10, max 25)

Example Usage:

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

OpenNeuro_get_dataset (Type: OpenNeuroTool)

Get detailed information about a specific neuroimaging dataset on OpenNeuro by its dataset ID (e….

OpenNeuro_get_dataset tool specification

Tool Information:

• Name: OpenNeuro_get_dataset

• Type: OpenNeuroTool

• Description: Get detailed information about a specific neuroimaging dataset on OpenNeuro by its dataset ID (e.g., ‘ds000114’, ‘ds000224’). Returns full metadata including modalities, tasks, subject list, BIDS version, authors, DOI, README, and download statistics.

Parameters:

• datasetId (string) (required) OpenNeuro dataset ID (e.g., ‘ds000114’, ‘ds000224’, ‘ds003097’)

Example Usage:

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

OpenNeuro_get_dataset_snapshots (Type: OpenNeuroTool)

Get all version snapshots of a specific dataset on OpenNeuro. Returns the snapshot id, tag, and c…

OpenNeuro_get_dataset_snapshots tool specification

Tool Information:

• Name: OpenNeuro_get_dataset_snapshots

• Type: OpenNeuroTool

• Description: Get all version snapshots of a specific dataset on OpenNeuro. Returns the snapshot id, tag, and creation date for every published version of the dataset. For per-snapshot summary statistics (modalities, subjects, file counts), use OpenNeuro_get_dataset, which returns the latest snapshot’s summary.

Parameters:

• datasetId (string) (required) OpenNeuro dataset ID (e.g., ‘ds000114’)

Example Usage:

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

OpenNeuro_get_snapshot_files (Type: OpenNeuroTool)

List the files in a specific version (snapshot) of an OpenNeuro dataset, with direct keyless down…

OpenNeuro_get_snapshot_files tool specification

Tool Information:

• Name: OpenNeuro_get_snapshot_files

• Type: OpenNeuroTool

• Description: List the files in a specific version (snapshot) of an OpenNeuro dataset, with direct keyless download URLs for each file. Unlike OpenNeuro_get_dataset (which returns only metadata), this returns the actual file manifest needed to retrieve the imaging data: filename, size in bytes, directory flag, and one or more object download URLs. Requires the dataset ID and a snapshot tag (get available tags from OpenNeuro_get_dataset_snapshots).

Parameters:

• datasetId (string) (required) OpenNeuro dataset ID (e.g., ‘ds000001’)

• tag (string) (required) Snapshot tag / version, as returned by OpenNeuro_get_dataset_snapshots (e.g., ‘00006’)

Example Usage:

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

OpenNeuro_get_snapshot_validation (Type: OpenNeuroTool)

Get BIDS validation results for a specific version (snapshot) of an OpenNeuro dataset. Returns wh…

OpenNeuro_get_snapshot_validation tool specification

Tool Information:

• Name: OpenNeuro_get_snapshot_validation

• Type: OpenNeuroTool

• Description: Get BIDS validation results for a specific version (snapshot) of an OpenNeuro dataset. Returns whether the dataset passes the BIDS validator and how many errors/warnings it has, via two fields: issuesStatus (a deduplicated summary count of errors and warnings) and validation (raw validator error/warning counts). Use this to assess dataset quality/validity before downloading. Requires the dataset ID and a snapshot tag (from OpenNeuro_get_dataset_snapshots).

Parameters:

• datasetId (string) (required) OpenNeuro dataset ID (e.g., ‘ds000001’)

• tag (string) (required) Snapshot tag / version (e.g., ‘00006’)

Example Usage:

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

OpenNeuro_list_datasets (Type: OpenNeuroTool)

List publicly available neuroimaging datasets on OpenNeuro. OpenNeuro hosts 1000+ BIDS-formatted …

OpenNeuro_list_datasets tool specification

Tool Information:

• Name: OpenNeuro_list_datasets

• Type: OpenNeuroTool

• Description: List publicly available neuroimaging datasets on OpenNeuro. OpenNeuro hosts 1000+ BIDS-formatted brain imaging datasets (fMRI, MRI, EEG, MEG, PET). Returns dataset metadata including modalities, subject counts, file counts, download statistics. Supports cursor-based pagination. Use after parameter for next page.

Parameters:

• first ([‘integer’, ‘null’]) (optional) Number of datasets to return (default 10, max 25)

• after ([‘string’, ‘null’]) (optional) Cursor for pagination - use endCursor from previous response

Example Usage:

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

OpenNeuro_search_by_modality (Type: OpenNeuroTool)

Search OpenNeuro neuroimaging datasets filtered by imaging modality. Supported modalities include…

OpenNeuro_search_by_modality tool specification

Tool Information:

• Name: OpenNeuro_search_by_modality

• Type: OpenNeuroTool

• Description: Search OpenNeuro neuroimaging datasets filtered by imaging modality. Supported modalities include: ‘MRI’ (structural and functional MRI), ‘EEG’ (electroencephalography), ‘iEEG’ (intracranial EEG), ‘MEG’ (magnetoencephalography), ‘PET’ (positron emission tomography). Returns dataset IDs, names, creation dates, and total count of matching datasets. OpenNeuro hosts 1600+ BIDS-formatted brain imaging datasets.

Parameters:

• modality (string) (required) Imaging modality to filter by. Options: ‘MRI’, ‘EEG’, ‘iEEG’, ‘MEG’, ‘PET’.

• first ([‘integer’, ‘null’]) (optional) Number of datasets to return (default 10, max 25)

Example Usage:

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

Navigation

• Available Tools - Back to Tools Overview

• Tool Loading Tutorial - Loading Local Tools