Eol Tools

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

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

Available Tools

EOL_get_collection (Type: EOLTool)

Get a curated collection from the Encyclopedia of Life. EOL collections are user-curated lists of…

EOL_get_collection tool specification

Tool Information:

  • Name: EOL_get_collection

  • Type: EOLTool

  • Description: Get a curated collection from the Encyclopedia of Life. EOL collections are user-curated lists of species pages organized by theme (e.g., endangered species, invasive species, species of a region). Returns collection name, description, and member items with their page IDs. Supports pagination and filtering by object type (taxa, articles, etc.).

Parameters:

  • collection_id (integer) (required) EOL collection ID. Example: 176 (Fingertip Fauna), 6 (a sample collection).

  • page (integer) (optional) Page number for paginated results.

  • per_page (integer) (optional) Number of items per page (max 500).

  • filter (string) (optional) Filter items by type: ‘taxa’, ‘text’, ‘image’, ‘sound’, ‘video’, ‘collection’, ‘community’, ‘user’. Leave empty for all types.

Example Usage:

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

EOL_get_hierarchy_entry (Type: EOLTool)

Get taxonomy hierarchy (classification tree) for a species from a specific classification system …

EOL_get_hierarchy_entry tool specification

Tool Information:

  • Name: EOL_get_hierarchy_entry

  • Type: EOLTool

  • Description: Get taxonomy hierarchy (classification tree) for a species from a specific classification system in the Encyclopedia of Life. Returns ancestors (full lineage from root to species), children taxa, synonyms, and source classification (NCBI, GBIF, ITIS, Catalogue of Life). Use EOL_get_page first to find hierarchy_entry_id values from the classifications list. Example: 70872770 is the NCBI hierarchy entry for Homo sapiens, showing the complete lineage from root through Primates to species level.

Parameters:

  • hierarchy_entry_id (integer) (required) EOL hierarchy entry ID from a specific classification system. Get this from EOL_get_page ‘classifications’ field. Examples: 70872770 (Homo sapiens in NCBI), 86685972 (Homo sapiens in GBIF), 147191154 (Homo sapiens in ITIS).

Example Usage:

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

EOL_get_page (Type: EOLTool)

Get detailed species/taxon information from an Encyclopedia of Life (EOL) page. Returns scientifi…

EOL_get_page tool specification

Tool Information:

  • Name: EOL_get_page

  • Type: EOLTool

  • Description: Get detailed species/taxon information from an Encyclopedia of Life (EOL) page. Returns scientific name, common names in multiple languages, synonyms, images with URLs, text descriptions, and available taxonomy classifications from multiple sources (NCBI, GBIF, ITIS, Catalogue of Life). Use EOL_search_species first to get page_id. Example: page_id 327955 for Homo sapiens, 583954 for Arabidopsis thaliana, 328672 for Panthera leo.

Parameters:

  • page_id (integer) (required) EOL page identifier. Get this from EOL_search_species. Examples: 327955 (Homo sapiens), 583954 (Arabidopsis thaliana), 328672 (Panthera leo), 1045608 (Apis mellifera).

  • images_per_page (integer) (optional) Number of image data objects to return (0-75).

  • texts_per_page (integer) (optional) Number of text description objects to return (0-75).

  • common_names (boolean) (optional) Include vernacular/common names in multiple languages.

  • synonyms (boolean) (optional) Include taxonomic synonyms.

  • details (boolean) (optional) Include detailed data object information (media, descriptions).

Example Usage:

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

EOL_search_species (Type: EOLTool)

Search the Encyclopedia of Life (EOL) for species and taxa by name. Returns matching EOL page IDs…

EOL_search_species tool specification

Tool Information:

  • Name: EOL_search_species

  • Type: EOLTool

  • Description: Search the Encyclopedia of Life (EOL) for species and taxa by name. Returns matching EOL page IDs, scientific names, and name variants. Use this to find EOL page IDs for detailed lookups with EOL_get_page. Supports exact matching. EOL aggregates data from hundreds of biodiversity databases. Example: searching ‘Homo sapiens’ returns page ID 327955.

Parameters:

  • query (string) (required) Search string for species or taxon name. Supports scientific names, common names, and partial matches. Examples: ‘Homo sapiens’, ‘Arabidopsis thaliana’, ‘Panthera leo’, ‘honey bee’.

  • page (integer) (optional) Page number for paginated results (1-based).

  • exact (boolean) (optional) If true, only return exact name matches.

Example Usage:

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