Skip to main content
Glama

markdown_to_canvas

Validate markdown from a string or file path and get content prepared for Slack canvases. Use the result with create_canvas() or create_channel_canvas().

Instructions

Validate and prepare markdown content for canvas creation. Accepts a markdown string or a file path, returns the validated content suitable for create_canvas() or create_channel_canvas().

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
contentNoMarkdown string (mutually exclusive with file_path)
file_pathNoPath to a .md file to read (mutually exclusive with content)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.8

TDQS

A4/5.0
Behavior3/5

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

With no annotations provided, the description carries the behavioral burden. It discloses that the tool accepts a markdown string or file path and returns validated content, which is helpful, but it does not explain what validation or preparation actually involves, what happens on invalid input, or whether the returned content is a string or a structured object.

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 two sentences with no filler. It front-loads the core purpose, then states inputs and outputs in a compact, scannable way. Every sentence contributes necessary information for selecting and calling the tool.

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?

For a simple two-parameter helper tool with no output schema, the description is fairly complete: it names accepted inputs, the return value, and the downstream functions that consume the result. It leaves validation rules and error behavior implicit, but an agent can reasonably invoke the tool using the provided guidance.

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 coverage is 100%, so the schema already documents content and file_path with mutually exclusive semantics. The description adds the high-level purpose of both inputs but does not provide additional format, constraint, or usage details beyond the schema, keeping this at the baseline.

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?

The description states a specific verb ('validate and prepare') applied to a clear resource ('markdown content') with an explicit purpose ('for canvas creation'). It distinguishes itself from canvas-creation tools by clarifying it returns prepared content rather than creating anything, and the canvas-specific target separates it from the sibling markdown_to_list.

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?

The description clearly implies when to use the tool: before calling create_canvas() or create_channel_canvas(), by providing content that needs validation and preparation. It does not explicitly state when not to use it or name alternatives like markdown_to_list, so it stops just short of full exclusion guidance.

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