Skip to main content
Glama

shopify_list_metafield_definitions

List declared metafield definitions for a given owner type, such as product or customer, to view custom field schemas.

Instructions

List declared metafield definitions for a given owner type.

Args: owner_type (required): One of: PRODUCT, CUSTOMER, ORDER, VARIANT, COLLECTION, SHOP. limit: Maximum definitions to return (1-250).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
owner_typeNo
limitNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior2/5

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

No annotations are provided, so the description must carry the behavioral burden. It does not disclose that this is a read-only operation, nor does it mention any constraints like pagination, rate limits, or idempotency. The required claim discrepancy further reduces transparency.

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, with only two relevant sentences. It is front-loaded with the main action and resource, and the parameter details are clearly separated.

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

Completeness3/5

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

The tool is simple and has an output schema, so the description does not need to detail return values. However, it is missing information about sorting, pagination, error handling, and the fact that owner_type is optional. The required claim error makes it incomplete.

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 description adds meaning beyond the schema by listing allowed values for owner_type and the range for limit. However, it incorrectly marks owner_type as required, contradicting the schema. Schema coverage is 0%, so additional semantic context is needed, and this error undermines reliability.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states the specific action 'List' and resource 'declared metafield definitions' for a given owner type, which is clear. However, it claims owner_type is required while the schema marks it as optional with a default of null, causing ambiguity.

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

Usage Guidelines2/5

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

No guidance on when to use this tool versus sibling tools like shopify_get_metafields or shopify_update_metafield. No explicit when/when-not context is provided.

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/RPasquale/lightbulb-mcp'

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