Skip to main content
Glama

Check the deck

deck_check
Read-only

Lint an MDX slide deck to catch invalid YAML, broken includes, missing media, MDX/JSX errors, glossary and merge-conflict issues before rendering.

Instructions

Lint the deck: invalid YAML, unknown or mistyped frontmatter keys, unknown layouts/backgrounds/themes/transitions, MDX that does not compile (with file:line), JSX components that are not built in / in src/components.tsx / imported, broken src: includes, missing images and videos, glossary problems, code-fence options, and unresolved merge conflicts (code merge-conflict: settle them with deck_resolve). Errors break the deck; fix them before rendering.

Input Schema

NameRequiredDescriptionDefault
dirNoDeck folder (contains deck.mdx). Absolute, or relative to the server's folder. Default: the server's folder.
compileNoCompile every slide's MDX (default true).

Output Schema

NameRequiredDescriptionDefault
okYes
errorsYes
slidesYes
warningsYes
diagnosticsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.6

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already establish readOnlyHint=true and openWorldHint=false, so safety is covered. The description adds valuable behavioral detail: the full taxonomy of what gets linted and the severity model ('Errors break the deck') implied by the checks. Return format is deferred to the 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.

Conciseness4/5

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

Front-loaded with 'Lint the deck:' and organized as a single dense enumeration of check categories followed by a severity/action sentence. The list is long and run-on but each item defines scope, so it earns its place; slightly better separation would help readability.

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?

Given an output schema exists, the description needn't explain return values, and annotations cover the read-only profile. It fully documents the lint coverage and the fix-before-render expectation. Minor gap: no mention of how to scope the lint (dir) or disable compilation, though the schema covers that.

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 100%, so both `dir` and `compile` are already documented in the schema. The description doesn't mention either parameter directly; 'MDX that does not compile' hints at the compile toggle but adds no syntax or default detail beyond the schema. Baseline 3 is appropriate.

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+resource ('Lint the deck') and enumerates the exact check categories (YAML, frontmatter keys, layouts, MDX compile errors, JSX imports, src: includes, media, glossary, code fences, merge conflicts). This clearly separates it from siblings like deck_build, deck_preview, or deck_conflicts.

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?

Gives clear context: 'Errors break the deck; fix them before rendering,' which implies running this before deck_render/deck_build. It also routes merge-conflict resolution to deck_resolve. No explicit when-not-to-use guidance against deck_build or deck_conflicts, but the usage context is clear.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.