Col Tools#

Configuration File: col_tools.json Tool Type: Local Tools Count: 3

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

Available Tools#

CoL_get_children (Type: BaseRESTTool)#

Get immediate child taxa of a Catalogue of Life taxon through the official tree/{id}/children end…

CoL_get_children tool specification

Tool Information:

  • Name: CoL_get_children

  • Type: BaseRESTTool

  • Description: Get immediate child taxa of a Catalogue of Life taxon through the official tree/{id}/children endpoint. The previous nameusage?parentId form silently ignored the parent and returned the whole Catalogue. Supports exact offset/limit continuation on non-empty pages.

Parameters:

  • parentId (string) (required) CoL ID of the parent taxon whose children to retrieve (e.g., ‘636X2’ for genus Homo, ‘623RM’ for family Felidae). Obtain from CoL_search_species or CoL_get_taxon.

  • limit (integer) (optional) Maximum number of children to return (default 10, max 1000)

  • offset (integer) (optional) Offset for pagination

Example Usage:

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

CoL_get_taxon (Type: BaseRESTTool)#

Get detailed taxonomic information for a specific taxon in the Catalogue of Life by its CoL ID. R…

CoL_get_taxon tool specification

Tool Information:

  • Name: CoL_get_taxon

  • Type: BaseRESTTool

  • Description: Get detailed taxonomic information for a specific taxon in the Catalogue of Life by its CoL ID. Returns full name details, accepted status, classification hierarchy, authorship, publication, and environments. Use CoL_search_species to find the CoL ID first.

Parameters:

  • taxon_id (string) (required) CoL taxon ID (e.g., ‘6MB3T’ for Homo sapiens, ‘64J67’ for Panthera leo). Obtain from CoL_search_species.

Example Usage:

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

CoL_search_species (Type: BaseRESTTool)#

Search the Catalogue of Life (CoL) for species and other taxa by scientific name. CoL is the glob…

CoL_search_species tool specification

Tool Information:

  • Name: CoL_search_species

  • Type: BaseRESTTool

  • Description: Search the Catalogue of Life (CoL) for species and other taxa by scientific name. CoL is the global index of all known species, compiled from 165+ taxonomic databases covering ~2 million species. Returns taxon IDs, accepted names, ranks, classification hierarchy, and taxonomic status. Use rank parameter to filter by taxonomic level (species, genus, family, order, class, phylum, kingdom).

Parameters:

  • q (string) (required) Scientific name to search for (e.g., ‘Homo sapiens’, ‘Panthera leo’, ‘Arabidopsis thaliana’)

  • rank ([‘string’, ‘null’]) (optional) Filter by taxonomic rank: ‘species’, ‘genus’, ‘family’, ‘order’, ‘class’, ‘phylum’, ‘kingdom’

  • limit (integer) (optional) Maximum number of results to return (default 10, max 1000)

  • offset (integer) (optional) Offset for pagination

Example Usage:

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