APIbase

HDX Dataset Detail

hdx.datasets.detail

Read-onlyIdempotent

Retrieve complete metadata for one HDX dataset by ID or URL slug, including description, organization, locations, tags, license, update frequency, and downloadable resources.

Instructions

Get full metadata for a single HDX dataset by id or URL slug: description, publishing organization, covered locations, tags, update frequency, license, source, and the full list of downloadable resources (name, format, download URL, size). Use hdx.dataset_search first to find a dataset id. Data: HDX CKAN Action API (data.humdata.org), no auth required.

Input Schema

Name	Required	Description	Default
`id`	Yes	HDX dataset id or URL slug (e.g. "hdx-hapi-som")

Output Schema

Name	Required	Description	Default
`error`	No	Present only when the call failed. Includes error code, message, request_id, and any provider-specific extras.
`result`	No	Tool response payload. Shape varies per tool — consult the tool description and inputSchema. May be an object, array, string, or number depending on the upstream provider response.

Schema Changelog

Changes observed during successful MCP inspections.

Addedv2.2.0Oct 29, 2026

TDQS

A4.3/5.0

Behavior4/5

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

Annotations already cover read-only/idempotent/non-destructive behavior; the description adds value by naming the upstream API (HDX CKAN Action API) and explicitly stating that no auth is required. It also discloses the return content beyond the schema.

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?

Three sentences with no filler: the action and payload are front-loaded, the field list is compact, and source/auth details are confined to the closing sentence.

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

Completeness5/5

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

For a single-parameter read tool with an output schema and comprehensive annotations, the description covers source, authentication, return-field expectations, and how to obtain the id. Nothing needed for correct invocation is missing; the minor sibling-name typo is the only blemish.

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?

The only parameter is fully documented in the schema as 'HDX dataset id or URL slug', and the description merely repeats 'by id or URL slug'. With 100% schema coverage, the description adds no extra parameter-level meaning beyond the search-first workflow.

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?

Description uses a specific verb and resource ('Get full metadata for a single HDX dataset') and enumerates the exact fields and resource attributes returned. It clearly distinguishes from hdx.datasets.search and similar catalog-detail tools by scope ('single').

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?

It gives an explicit prerequisite workflow: use the search sibling first to find a dataset id. It does not spell out exclusions or when to prefer alternatives, and the referenced name 'hdx.dataset_search' is slightly mistyped relative to the sibling 'hdx.datasets.search'.

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

Deploy Server