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 for a study with explicit page pagination. Preserves upstream JSON:API links, total…

MGnify_list_analyses tool specification

Tool Information:

  • Name: MGnify_list_analyses

  • Type: MGnifyAnalysesTool

  • Description: List analyses for a study with explicit page pagination. Preserves upstream JSON:API links, total result count, total pages, and next_page.

Parameters:

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

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

  • page (integer) (optional) One-based page number. Continue with metadata.next_page.

Example Usage:

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

MGnify_search_studies (Type: MGnifyStudiesTool)#

Search MGnify studies with explicit page pagination. Preserves upstream JSON:API links and pagina…

MGnify_search_studies tool specification

Tool Information:

  • Name: MGnify_search_studies

  • Type: MGnifyStudiesTool

  • Description: Search MGnify studies with explicit page pagination. Preserves upstream JSON:API links and pagination totals so all matching microbiome studies are reachable.

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).

  • page (integer) (optional) One-based page number. Continue with metadata.next_page.

Example Usage:

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