Skip to main content
Glama
hanhsienlei

au-opendata-mcp

by hanhsienlei

Get Dataset

get_dataset

Retrieve a dataset's full metadata and list of resource files, including whether each file is queryable, so you can choose resource IDs for previews or SQL queries.

Instructions

Get one dataset's full metadata and its list of resources (files).

Each resource reports queryable: "yes" means query_resource will work on it, "no" gives the reason (wrong format, or too large), "unknown" means the size could not be determined in advance. Use the resource_id of a queryable resource with preview_resource and query_resource.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
portalNoThe portal the dataset came from.data.gov.au
dataset_idYesThe dataset name/id from search_datasets.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It does disclose a meaningful behavioral trait of the output: the `queryable` field's three states and what each means for downstream calls. However it says nothing about permissions, rate limits, or cost, and an output schema already exists.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads the purpose in one sentence, then uses a tight second block to explain the `queryable` states and the follow-up calls. Every sentence earns its place with no filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists so return values needn't be re-explained, and the description covers the one output field an agent must act on (`queryable`) plus the routing to preview/query. Minor gap: no mention of the portal parameter's default or multi-portal behavior.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so both parameters are already documented, making 3 the baseline. The description adds only that dataset_id comes from search_datasets; it says nothing about the portal parameter or its default.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: 'Get one dataset's full metadata and its list of resources (files).' This clearly distinguishes it from siblings like search_datasets (list/search), preview_resource and query_resource (operate on resources).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly routes the agent downstream: use the resource_id of a queryable resource with preview_resource and query_resource. It also implies the entry point by noting dataset_id comes from search_datasets. No explicit 'when not to use' statement, but the chaining guidance is clear.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.