Figshare Tools#

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

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

Available Tools#

Figshare_get_article (Type: BaseRESTTool)#

Get detailed metadata for a specific Figshare research output by its article ID. Returns complete…

Figshare_get_article tool specification

Tool Information:

  • Name: Figshare_get_article

  • Type: BaseRESTTool

  • Description: Get detailed metadata for a specific Figshare research output by its article ID. Returns complete information including title, description, authors, DOI, files, categories, tags, funding, license, citation, and download statistics. Use this after searching to get full details about a specific dataset, code package, or figure.

Parameters:

  • article_id (integer) (required) Figshare article ID (numeric, e.g., 14847609, 1000050). Obtain from search results or from Figshare URLs like ‘figshare.com/articles/dataset/name/14847609’.

Example Usage:

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

Figshare_search_articles (Type: FigshareRESTTool)#

Search Figshare research outputs by keyword through the official article search endpoint. Results…

Figshare_search_articles tool specification

Tool Information:

  • Name: Figshare_search_articles

  • Type: FigshareRESTTool

  • Description: Search Figshare research outputs by keyword through the official article search endpoint. Results are explicitly paginated; continue with metadata.next_page while metadata.has_more is true. Figshare does not expose an exact total, so metadata.matches_lower_bound reports a verified lower bound.

Parameters:

  • search_for (string) (required) Keyword search query (e.g., ‘CRISPR knockout RNA-seq’, ‘protein structure cryo-EM’, ‘climate change temperature dataset’)

  • item_type ([‘integer’, ‘null’]) (optional) Filter by item type: 3=dataset, 2=media, 1=figure, 9=code, 7=thesis, 6=book, 5=presentation, 4=paper, 12=journal contribution, 11=poster

  • page_size ([‘integer’, ‘null’]) (optional) Number of results (default 10, max 1000)

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

  • published_since ([‘string’, ‘null’]) (optional) Filter to articles published after this date in format ‘YYYY-MM-DD’ (e.g., ‘2023-01-01’)

Example Usage:

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