Skip to main content
Glama

Metis · Software Engineer — Register Data Dictionary

register_data_dictionary

Record or update the data dictionary for a dataset by specifying variable names, types, labels, and units. Ensures consistent variable definitions across analyses.

Instructions

Record a dataset's data dictionary — one stored entry per variable.

Captures each variable's name, type, label, unique values / factor levels,
and units so future analysis scripts reuse the exact same names and
treatments. Re-registering the same dataset is idempotent: it replaces the
previous dictionary for that dataset (matched on dataset_name + project_id).

Args:
    dataset_name: Name of the dataset, e.g. "hat_cases_2015_2023".
    variables: List of variable entries. Each entry may be a plain string
        (the variable name) or an object with any of: name (required),
        type, label, unique_values, units, notes. Entries without a name
        are skipped.
    project_id: Project this dataset belongs to (default empty string);
        also part of the key used when replacing an existing dictionary.
    dataset_path: Where the dataset lives on disk (default empty string).

Returns:
    A confirmation message with the count of variables recorded for the
    dataset, or an error if none were provided.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
variablesYes
project_idNo
dataset_nameYes
dataset_pathNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

No annotations provided, so the description carries full burden. It discloses that the tool stores per-variable entries, is idempotent (matching on dataset_name+project_id), and returns a confirmation with count or an error. This provides sufficient behavioral insight for an agent.

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?

The description is concise and well-structured: a brief paragraph explaining purpose and behavior, followed by a clear bulleted list of arguments. Every sentence adds value without repetition. No unnecessary elaboration.

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?

Given the tool has 4 parameters (2 required), no annotations, and an output schema (described as returning confirmation or error), the description is complete. It explains what the tool does, how each parameter works, and what to expect as output. No gaps remain.

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

Parameters5/5

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

Schema description coverage is 0%, but the description's 'Args' section adds detailed semantics for each parameter: dataset_name with example, variables with structure (strings or objects with optional fields like name, type, etc.), project_id and dataset_path with defaults and roles. This far exceeds the schema's minimal info.

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?

The description clearly states the tool records a data dictionary for a dataset, listing specific variable attributes (name, type, label, etc.). It distinguishes from sibling tools like 'register_code_artifact' or 'record_dataset_treatment' by focusing on variable metadata. The verb 'Record' is specific and actionable.

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?

The description explains when to use it (to capture variable definitions for reproducibility) and notes idempotency (re-registering replaces). It doesn't explicitly state when not to use it or name alternatives, but the context is clear enough for an agent to infer appropriate use cases.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/SVerITG/Metis'

If you have feedback or need assistance with the MCP directory API, please join our Discord server