Skip to main content
Glama

Get a Dataset's Data Contract

get_contract
Read-onlyIdempotent

The full data contract of one dataset (kind='topic') or lookup table (kind='dimension'): the machine-readable document, in the Open Data Contract Standard (ODCS) v3.2 format, that defines its columns, keys, units, quality checks, source, and limitations. fmt='yaml' (default) returns the document as published; fmt='json' returns it parsed. It is long (often 10 to 50 KB); describe_dataset gives the same schema in a smaller, query-ready form.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "name": "<name>"
    },
    "name": "get_contract"
  }
}

Input Schema

NameRequiredDescriptionDefault
fmtNo'yaml' (default, as published) or 'json' (parsed).yaml
kindNo'topic' (a dataset, default) or 'dimension' (a lookup table).topic
nameYesDataset name (e.g. 'act_scores', or its full key 'education/gosa/act_scores') or lookup table name.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • removedInput schema / properties / main_topic
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "string"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "default": null,
      -  "description": "Optional subject-area consistency check. Omit: globally unique topic names and full keys identify the dataset on their own.",
      -  "enum": [
      -    "census",
      -    "education",
      -    "health",
      -    "immigration",
      -    null
      -  ],
      -  "title": "Main Topic"
      -}
  2. Changed5 schema fields changed
    • addedInput schema / properties / main_topic / anyOf
      Added value: +[
      +  {
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / main_topic / default
      Previous value: -"education"New value: +null
    • changedInput schema / properties / main_topic / description
      Previous value: -"Subject area: 'education' (the default), 'census', or 'immigration'. A dataset's key starts with it."New value: +"Optional subject-area consistency check. Omit: globally unique topic names and full keys identify the dataset on their own."
    • changedInput schema / properties / main_topic / enum
      Previous value: -[
      -  "census",
      -  "education",
      -  "immigration"
      -]New value: +[
      +  "census",
      +  "education",
      +  "health",
      +  "immigration",
      +  null
      +]
    • removedInput schema / properties / main_topic / type
      Removed value: -"string"
  3. Changed1 schema field changed
    • changedInput schema / properties / name / description
      Previous value: -"Dataset name (e.g. 'act_scores') or lookup table name."New value: +"Dataset name (e.g. 'act_scores', or its full key 'education/gosa/act_scores') or lookup table name."
  4. Changed7 schema fields changed
    • addedInput schema / properties / fmt / description
      Added value: +"'yaml' (default, as published) or 'json' (parsed)."
    • addedInput schema / properties / fmt / enum
      Added value: +[
      +  "yaml",
      +  "json"
      +]
    • addedInput schema / properties / kind / description
      Added value: +"'topic' (a dataset, default) or 'dimension' (a lookup table)."
    • addedInput schema / properties / kind / enum
      Added value: +[
      +  "topic",
      +  "dimension"
      +]
    • addedInput schema / properties / main_topic / description
      Added value: +"Subject area: 'education' (the default), 'census', or 'immigration'. A dataset's key starts with it."
    • addedInput schema / properties / main_topic / enum
      Added value: +[
      +  "census",
      +  "education",
      +  "immigration"
      +]
    • addedInput schema / properties / name / description
      Added value: +"Dataset name (e.g. 'act_scores') or lookup table name."
  5. First observed

TDQS

A4.3/5.0
Behavior4/5

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

The annotations already establish read-only, idempotent, non-destructive behavior. The description adds useful context beyond annotations: the document is long (often 10 to 50 KB), yaml returns the document as published, and json returns it parsed, which helps an agent anticipate payload size and format.

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 front-loaded with the core purpose and then efficiently covers content, formats, size, and the smaller alternative. Every sentence earns its place, with no redundant or filler text.

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 output schema exists, the description need not explain return values. It covers what the document contains, the two formats, expected size, and the key alternative, making it complete enough for an agent to call the tool correctly.

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 the schema already fully documents the three parameters. The description repeats the meaning of kind and fmt but adds little or no semantic detail beyond what the schema provides, so the baseline of 3 is appropriate.

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 states a specific verb and resource: returning the full data contract of one dataset or lookup table, with the exact standard and format (ODCS v3.2). It clearly distinguishes the tool from its sibling describe_dataset by explaining that the latter gives a smaller, query-ready schema.

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 clear usage context: use this for the full machine-readable document, and use describe_dataset when a smaller schema is sufficient. It also explains the yaml/json format choice, though it does not explicitly compare against all relevant siblings like describe_dimension or get_dimension.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources