Skip to main content
Glama

Metafield Key Check

metafield_key_check
Read-onlyIdempotent

Validate a metafield namespace and key before you define it. FREE.

Shopify metafield namespaces and keys are lowercase alphanumerics and underscores; a capital letter or a dash is rejected at definition time, usually after the rest of the import has already run. Typical input {"namespace": "custom", "key": "Care-Instructions"} returns {"ok": false, "problems": ["key: dashes and capitals are not allowed"], "suggested_key": "care_instructions"}.

Use when designing metafields. Not for the CSV column that carries them — that is product_csv_check. Errors: on invalid, missing, or malformed input this tool never raises a protocol error — it returns {"error": ""}. Every call is read-only and idempotent, so after correcting the input it is always safe to retry.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyYesThe metafield key, e.g. "care_instructions".
namespaceYesThe metafield namespace, e.g. "custom".
value_typeNoThe intended metafield type, echoed back for your record, e.g. "single_line_text_field". Not validated against Shopify's type list, which changes.single_line_text_field

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

TDQS

A4.9/5.0
Behavior5/5

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

The description matches annotations: read-only and idempotent are explicitly stated, and it adds richer behavioral detail: no protocol errors, returns a structured error object, and shows sample success/failure outputs. No contradiction found.

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?

Every sentence contributes meaning: purpose, domain rules, example, usage scope, error behavior, and safety guarantee. The structure is front-loaded and easy to scan, with no wasted content beyond perhaps 'FREE.'

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 simple validator with full schema coverage and a known output schema, the description covers validation context, alternative tools, error handling, and retry safety. It provides enough information to invoke the tool correctly without guessing.

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

Parameters4/5

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

The schema already documents all three parameters. The description goes beyond by explaining validation rules for namespace/key (lowercase, underscores, no capitals/dashes) and what invalid input produces. It does not add much about value_type, but the schema already covers that.

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 opens with a specific verb and resource: 'Validate a metafield namespace and key before you define it.' It clearly distinguishes itself from product_csv_check, and the example shows exactly what the tool does.

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

Usage Guidelines5/5

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

Explicitly says 'Use when designing metafields' and 'Not for the CSV column that carries them — that is product_csv_check.' It also explains error/retry behavior so an agent knows when it is safe to call again.

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.

TDQS

A4.7/5.0
Disambiguation5/5

Each tool serves a distinct purpose (pricing, metafields, payouts, CSV headers, URL handles, variant counts) with no overlap in functionality. Descriptions clearly delineate scope and typical use cases.

Naming Consistency5/5

All tool names follow a consistent snake_case pattern with descriptive noun+verb or compound noun structures (e.g., bulk_price_change, metafield_key_check). No stylistic inconsistencies.

Tool Count5/5

Six tools is a well-scoped set for a Shopify preparation server, covering essential tasks without redundancy or unnecessary bloat. Each tool addresses a specific preparation need.

Completeness5/5

The toolset covers the core preparation workflows: pricing adjustments, metafield validation, payout estimation, CSV format checking, URL handle generation, and variant limit assessment. No obvious gaps for the stated domain.

Resources