Skip to main content
Glama

md_preview

Preview Markdown files in Sublime Text with custom CSS styling, and copy Markdown or formatted content using keyboard shortcuts.

Instructions

Open a Markdown file in Sublime Text. Preview with Ctrl+Shift+M uses this package styles/ CSS + Copy Markdown / Copy Formatted.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesPath to a .md file (absolute or relative to MARKITDOWN_OUTDIR / WORKDIR).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

B3.2/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It discloses the main behavior: opening a file in Sublime Text and using preview-related features. However, it does not mention prerequisites such as Sublime Text being installed, whether the tool blocks or returns immediately, or whether it modifies or creates any files.

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?

The description is short and front-loaded with the primary action. The second sentence provides useful preview context but is somewhat cryptic, especially the phrase 'styles/ CSS + Copy Markdown / Copy Formatted.' Still, there is no wasted padding.

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?

For a single-parameter tool with no output schema, this is reasonably complete for basic invocation. However, it lacks usage routing relative to sibling tools and does not disclose side effects or environment prerequisites, leaving some ambiguity for an agent deciding when and how to call it.

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 the only parameter (path) is already documented with its relative-to MARKITDOWN_OUTDIR / WORKDIR semantics. The tool description adds no additional parameter detail, which is acceptable given the complete schema coverage.

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 clearly states the core action: opening a Markdown file in Sublime Text, and adds detail about preview behavior using package styles/CSS and copy actions. It is specific enough to distinguish from conversion/formatting siblings, though it does not explicitly contrast with them.

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?

The description implies the tool is used for opening/previewing Markdown files, but it gives no explicit when-to-use guidance and no indication of when to prefer alternatives like md_convert, md_format, or md_styles. An agent must infer the appropriate context from the tool name and first sentence.

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