Skip to main content
Glama

get_contract

Return the authoritative ODCS v3.2 data contract for a topic (kind='topic') or a dimension (kind='dimension') so you can consume the machine-readable schema without cloning the repo. fmt='yaml' (default) returns the document verbatim as text; fmt='json' returns it parsed. Only approved topics and loaded dimensions expose a contract.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fmtNoyaml
kindNotopic
nameYes
main_topicNoeducation

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior3/5

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

With no annotations, the description carries the full burden and does disclose real behavior: fmt='yaml' returns the document verbatim as text while fmt='json' returns it parsed, and contracts are gated on approved topics / loaded dimensions. It does not state what happens when the gate fails (error vs empty), whether any permission is required, or whether the output is cached/versioned, which are meaningful gaps for a no-annotation tool.

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

Conciseness4/5

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

Two sentences, front-loaded with the resource and its primary use, then the fmt semantics and the availability constraint. No filler, though the final constraint sentence is slightly compacted and the fmt/kind semantics are packed into a semicolon clause.

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-value structure need not be explained, and the description covers fmt output modes and the kind switch. The remaining gap is the unstated failure mode when a topic is not approved or a dimension is not loaded, plus the unexplained 'main_topic' parameter.

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 0%, so the description must compensate and it partially does: it defines the two meaningful values of fmt and both values of kind, including the default behavior. It says nothing about the meaning or format of the required 'name' parameter, nor about 'main_topic' (schema default 'education'), leaving half the parameters undocumented anywhere.

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 names a specific verb ('Return') and a precisely scoped resource ('authoritative ODCS v3.2 data contract') and explicitly disambiguates the two supported targets (kind='topic' vs kind='dimension'). It also frames the value proposition against an alternative approach ('without cloning the repo'), so an agent can tell this is the in-band way to fetch the contract document rather than a dataset/dimension description tool.

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

Usage Guidelines3/5

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

It gives a clear motivation ('so you can consume the machine-readable schema without cloning the repo') and one usage boundary ('Only approved topics and loaded dimensions expose a contract'), which implies when the call will fail. However, it never names an alternative sibling (e.g. describe_dimension, get_dimension, describe_dataset) or states when an agent should prefer those over this tool, so routing between near-named siblings is left to inference.

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