Skip to main content
Glama

Validate Markdown Manuscript

validate_manuscript

Validates Markdown manuscript syntax and non-standard structure mappings against the compilation contract before Word export to catch formatting issues early.

Instructions

Validate a Markdown manuscript's syntax and non-standard Markdown structure mappings against the compilation contract before export.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "markdown": "<markdown>"
    },
    "name": "validate_manuscript"
  }
}

Input Schema

NameRequiredDescriptionDefault
langNo
formatNo
presetNo
markdownYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3/5.0
Behavior2/5

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

No annotations are provided, so the description must carry the full behavioral burden. It implies a validation/read operation but does not state whether the tool is read-only, whether it has side effects, what kind of errors or warnings it reports, or what prerequisites it requires.

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 definition is a single, front-loaded sentence with no filler. It packs the core action, target, and timing context into one efficient statement.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return values need not be explained in the description. However, with no annotations and three of four parameters undocumented, the description is not complete enough for an agent to understand how lang, format, and preset affect validation.

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?

Schema description coverage is 0%, and the description does not explain the lang, format, or preset parameters at all. It only indirectly implies that the markdown parameter contains the manuscript to validate, leaving most parameter semantics undocumented.

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 states a specific verb and resource: validate a Markdown manuscript's syntax and structure mappings. It also adds the context of validating against the compilation contract before export, which helps distinguish it from a pure compilation tool, though it does not explicitly name compile_markdown or another sibling as the alternative.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'before export' implies when this tool is useful: as a pre-export check. However, it gives no explicit guidance on when not to use it, what to do after validation fails, or how it relates to sibling tools such as compile_markdown.

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