Skip to main content
Glama

get_design_guide

Read-only

The design guide: how pages, the header and footer, sections and themes work here, and the complete layout language (node types, expressions, components, CSS rules) that define_section and theme files are written in. Call it once before designing anything. With section, returns that theme or custom section's full definition (fields, render tree, CSS) as a worked example. With reference, the full reference the developer docs publish: "components" (every component's props and slots), "scopes" (every field in scope: product, cart, collection, search, account, order, blog), "data" (data sources), or one component's name. Read it before deciding something cannot be done: most of what a theme needs already exists there.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sectionNoA section type from list_section_types, e.g. luxor.footer or custom.banner.
referenceNocomponents, scopes, data, or a component name such as reviews or search-results.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already establish readOnly/not-destructive/closed-world, so the safety profile is covered. The description adds real behavioral context by explaining what each invocation mode yields: with `section`, a worked example with fields, render tree, and CSS; with `reference`, the developer-docs reference broken into components/scopes/data. This goes beyond the annotations without contradicting them.

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?

Front-loads the core purpose, then explains modes and the pre-design invocation rule. It is longer than most tool descriptions but each sentence carries information (what it covers, when to call it, what each param returns). Slight redundancy around the "read it before" framing but overall efficient.

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 read-only, no-output-schema tool with two optional documented parameters, the description is complete: it covers purpose, trigger timing, and the return shape per mode. An agent has everything needed to decide to call it and how to invoke it.

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?

Schema coverage is 100%, so the baseline is 3, but the description meaningfully expands on both parameters: it clarifies that `section` returns a full worked definition (fields, render tree, CSS) and that `reference` accepts components, scopes, data, or a single component name. This adds semantic value beyond the schema's own descriptions.

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 resource (the design guide) and enumerates exactly what it covers: pages, header/footer, sections, themes, and the layout language (node types, expressions, components, CSS rules). It ties itself to the broader workflow by naming define_section and theme files as the things written in this language, distinguishing it from sibling tools like define_section and list_section_types.

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?

"Call it once before designing anything" and "Read it before deciding something cannot be done" give clear timing and trigger conditions. It does not name a competing alternative to route away from, but the placement advice (call first, call before designing) is strong, actionable guidance.

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