Mgnify Tools

Configuration File: mgnify_tools.json Tool Type: Local Tools Count: 2

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

Available Tools

MGnify_list_analyses (Type: MGnifyAnalysesTool)

List analyses associated with a study accession (taxonomic/functional outputs). Use to enumerate …

MGnify_list_analyses tool specification

Tool Information:

  • Name: MGnify_list_analyses

  • Type: MGnifyAnalysesTool

  • Description: List analyses associated with a study accession (taxonomic/functional outputs). Use to enumerate available processed results for programmatic retrieval.

Parameters:

  • study_accession (string) (required) MGnify study accession (e.g., ‘MGYS00000001’).

  • size (integer) (optional) Number of records per page (1–100).

Example Usage:

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

MGnify_search_studies (Type: MGnifyStudiesTool)

Search MGnify metagenomics/microbiome studies by biome or keyword. Returns study accessions (MGYS…

MGnify_search_studies tool specification

Tool Information:

  • Name: MGnify_search_studies

  • Type: MGnifyStudiesTool

  • Description: Search MGnify metagenomics/microbiome studies by biome or keyword. Returns study accessions (MGYS…), names, bioproject IDs, biome names, and analysis counts. Use to find datasets from specific environments (e.g., gut microbiome, soil, ocean) before retrieving analyses or taxonomy. Example: biome=’root:Host-associated’ returns gut, skin, and oral studies.

Parameters:

  • biome (string) (optional) Biome identifier (e.g., ‘root:Host-associated’).

  • search (string) (optional) Keyword to search in study titles/descriptions.

  • size (integer) (optional) Number of records per page (1–100).

Example Usage:

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