Worms Tools

Configuration File: worms_tools.json Tool Type: Local Tools Count: 5

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

Available Tools

WoRMS_get_classification (Type: WoRMSRESTTool)

Get the full taxonomic classification tree (ranked lineage) for a marine taxon from the World Reg…

WoRMS_get_classification tool specification

Tool Information:

  • Name: WoRMS_get_classification

  • Type: WoRMSRESTTool

  • Description: Get the full taxonomic classification tree (ranked lineage) for a marine taxon from the World Register of Marine Species (WoRMS) by its AphiaID. Returns a nested hierarchy from the top rank (Biota/Kingdom) down to the queried taxon, with the AphiaID, rank, and scientific name at each level (e.g. Kingdom -> Phylum -> … -> Species). This is the canonical post-resolution enrichment used after finding an AphiaID with WoRMS_search_species. No API key required.

Parameters:

  • AphiaID (integer) (required) WoRMS AphiaID of the taxon, e.g. 127160 (Solea solea, common sole). Obtain from WoRMS_search_species.

Example Usage:

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

WoRMS_get_distribution (Type: WoRMSRESTTool)

Get the marine geographic distribution of a taxon from the World Register of Marine Species (WoRM…

WoRMS_get_distribution tool specification

Tool Information:

  • Name: WoRMS_get_distribution

  • Type: WoRMSRESTTool

  • Description: Get the marine geographic distribution of a taxon from the World Register of Marine Species (WoRMS) by its AphiaID. Returns localities mapped to MarineRegions MRGID identifiers, with record status, establishment means (native/introduced), invasiveness, and occurrence status. This is curated marine biogeography not present in GBIF occurrence records. No API key required.

Parameters:

  • AphiaID (integer) (required) WoRMS AphiaID of the taxon, e.g. 127160 (Solea solea). Obtain from WoRMS_search_species.

Example Usage:

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

WoRMS_get_synonyms (Type: WoRMSRESTTool)

Get the taxonomic synonyms (unaccepted names) for a marine taxon from the World Register of Marin…

WoRMS_get_synonyms tool specification

Tool Information:

  • Name: WoRMS_get_synonyms

  • Type: WoRMSRESTTool

  • Description: Get the taxonomic synonyms (unaccepted names) for a marine taxon from the World Register of Marine Species (WoRMS) by its AphiaID. Returns names that resolve to the same valid AphiaID, each with its status (e.g. ‘unaccepted’), unaccept reason, authority, and the valid_AphiaID/valid_name they map to. The name search returns only the matched record, not its full synonymy. No API key required.

Parameters:

  • AphiaID (integer) (required) WoRMS AphiaID of the accepted taxon, e.g. 127160 (Solea solea). Obtain from WoRMS_search_species.

Example Usage:

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

WoRMS_get_vernaculars (Type: WoRMSRESTTool)

Get the vernacular (common) names for a marine taxon from the World Register of Marine Species (W…

WoRMS_get_vernaculars tool specification

Tool Information:

  • Name: WoRMS_get_vernaculars

  • Type: WoRMSRESTTool

  • Description: Get the vernacular (common) names for a marine taxon from the World Register of Marine Species (WoRMS) by its AphiaID, with ISO language codes and language names. Returns multilingual common names (e.g. ‘common sole’/English, ‘Dover sole’/English, ‘gewone tong’/Dutch) not available from the scientific name search. No API key required.

Parameters:

  • AphiaID (integer) (required) WoRMS AphiaID of the taxon, e.g. 127160 (Solea solea). Obtain from WoRMS_search_species.

Example Usage:

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

WoRMS_search_species (Type: WoRMSRESTTool)

Search marine species in World Register of Marine Species

WoRMS_search_species tool specification

Tool Information:

  • Name: WoRMS_search_species

  • Type: WoRMSRESTTool

  • Description: Search marine species in World Register of Marine Species

Parameters:

  • query (string) (required) Species name or search term

  • limit (integer) (optional) Number of results

Example Usage:

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