Neurovault Tools

Configuration File: neurovault_tools.json Tool Type: Local Tools Count: 4

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

Available Tools

NeuroVault_get_collection (Type: BaseRESTTool)

Get detailed metadata for a specific NeuroVault neuroimaging collection by its ID. Returns study …

NeuroVault_get_collection tool specification

Tool Information:

  • Name: NeuroVault_get_collection

  • Type: BaseRESTTool

  • Description: Get detailed metadata for a specific NeuroVault neuroimaging collection by its ID. Returns study details including title, DOI, authors, journal, imaging parameters (scanner, pulse sequence, field strength), study design information (number of subjects, experimental conditions), and number of statistical map images. Use collection IDs from NeuroVault_list_collections or NeuroVault website. Example: collection 457 is the Human Connectome Project overview with 48 brain images.

Parameters:

  • collection_id (integer) (required) NeuroVault collection ID number. Examples: 457 (Human Connectome Project), 1952 (BrainPedia with 6573 images)

Example Usage:

query = {
    "name": "NeuroVault_get_collection",
    "arguments": {
        "collection_id": 10
    }
}
result = tu.run(query)

NeuroVault_get_image (Type: BaseRESTTool)

Get detailed metadata for a specific brain statistical map image in NeuroVault by image ID. Retur…

NeuroVault_get_image tool specification

Tool Information:

  • Name: NeuroVault_get_image

  • Type: BaseRESTTool

  • Description: Get detailed metadata for a specific brain statistical map image in NeuroVault by image ID. Returns comprehensive information including map type (T/Z/F map), cognitive paradigm and contrast annotations from Cognitive Atlas, analysis level, modality, and file download URL (NIfTI format). Use image IDs from NeuroVault_list_collection_images. Example: image 3128 is a Z map of ‘emotion processing fMRI task paradigm’ showing FACES minus SHAPES contrast from the Human Connectome Project.

Parameters:

  • image_id (integer) (required) NeuroVault image ID. Examples: 3128 (HCP emotion task Z map), 946 (pain T map)

Example Usage:

query = {
    "name": "NeuroVault_get_image",
    "arguments": {
        "image_id": 10
    }
}
result = tu.run(query)

NeuroVault_list_collection_images (Type: BaseRESTTool)

List all statistical map images in a specific NeuroVault collection. Returns image metadata inclu…

NeuroVault_list_collection_images tool specification

Tool Information:

  • Name: NeuroVault_list_collection_images

  • Type: BaseRESTTool

  • Description: List all statistical map images in a specific NeuroVault collection. Returns image metadata including name, map type (T map, Z map, F map, etc.), cognitive paradigm/contrast annotations, and file download URLs. Use this to explore what brain maps are available in a study collection before downloading. Example: collection 457 (Human Connectome Project) has 48 images covering emotion, gambling, language, motor, relational, social, and working memory tasks.

Parameters:

  • collection_id (integer) (required) NeuroVault collection ID. Example: 457 (Human Connectome Project)

  • limit ([‘integer’, ‘null’]) (optional) Maximum number of images to return (default 10, max 100)

  • offset ([‘integer’, ‘null’]) (optional) Number of images to skip for pagination (default 0)

Example Usage:

query = {
    "name": "NeuroVault_list_collection_images",
    "arguments": {
        "collection_id": 10
    }
}
result = tu.run(query)

NeuroVault_list_collections (Type: BaseRESTTool)

List and browse neuroimaging statistical map collections from NeuroVault. Returns collections of …

NeuroVault_list_collections tool specification

Tool Information:

  • Name: NeuroVault_list_collections

  • Type: BaseRESTTool

  • Description: List and browse neuroimaging statistical map collections from NeuroVault. Returns collections of brain images (fMRI, PET, EEG) contributed by researchers worldwide. Each collection contains metadata about the study, DOI, authors, and imaging parameters. NeuroVault hosts over 16,000 collections with 650,000+ brain images. Use limit and offset for pagination. Use this to discover available neuroimaging datasets for meta-analysis or to find specific studies.

Parameters:

  • limit ([‘integer’, ‘null’]) (optional) Maximum number of collections to return per page (default 10, max 100). Example: 10

  • offset ([‘integer’, ‘null’]) (optional) Number of collections to skip for pagination (default 0). Example: 20 to get page 3 with limit=10

  • format ([‘string’, ‘null’]) (optional) Response format. Must be ‘json’. Default: ‘json’

Example Usage:

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