Skip to main content
Glama

Describe the product schema

aalto_describe_schema
Read-onlyIdempotent

Lists every standard and custom field Aalto stores for products, valid statuses and product types, and the CSV import format. Call before building an import file or a batch of writes.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

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

Input Schema

NameRequiredDescriptionDefault
collection_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world behavior. The description adds useful context about what information is returned, including custom fields, statuses, product types, and CSV import format, which matters because there is no output schema.

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?

Two tightly written sentences with zero waste. The output description is front-loaded, followed immediately by the call condition.

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 description adequately explains the tool's return categories despite no output schema, but it omits all information about the sole parameter. For a schema-discovery tool, leaving collection_id unexplained is a meaningful gap even though the parameter is optional.

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

Parameters2/5

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

The single optional collection_id parameter has 0% schema description coverage, and the description never mentions it. An agent cannot tell from the definition whether collection_id scopes the schema to a collection or what happens when it is omitted.

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?

States a specific verb ("Lists") and the exact resources returned: standard/custom product fields, statuses, product types, and CSV import format. It is clearly differentiated from siblings like aalto_create_products or aalto_import_preview.

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?

Explicitly says when to call it: "before building an import file or a batch of writes." It does not name when not to use it or point to an alternative, but the usage context is clear and actionable.

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