Skip to main content
Glama

analyze_and_suggest

Analyzes Markdown documents for heading hierarchy, format errors, content issues, and Chinese punctuation problems, then generates a structured report with line-specific suggestions.

Instructions

Analyze a Markdown document and generate modification suggestions.

Performs semantic analysis across six categories:

  1. Heading hierarchy — skipped levels, missing/multiple H1, long titles

  2. Required 公文 sections — expected elements in Chinese government docs

  3. Format issues — broken image references, HTML table problems

  4. Content issues — empty sections, placeholder text, duplicates, long paragraphs

  5. Numbered list continuity — gaps and restarts in ordered lists

  6. Chinese punctuation — half-width marks, missing sentence endings

Generates a structured report at /-修改建议.md with findings organized by category, each showing line numbers, severity, and specific suggestions.

Args: input_path: Absolute path to the input Markdown file.

Returns: Summary string with input path, suggestions file path, and issue count.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
input_pathYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

The description discloses that the tool generates an output file at a specific path with a defined naming convention, and returns a summary string. It also details six analysis categories, providing transparency about the scope of analysis. No annotations are provided, so the description must carry the behavioral burden, which it largely does.

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 well-structured with a brief introductory sentence followed by a bulleted list of analysis categories, and ends with parameter and return documentation. Every sentence earns its place with no redundancy or filler.

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?

Given the tool has only 1 parameter, no annotations, an output schema, and two clearly different sibling tools, the description is complete. It explains what the tool does, what it analyzes, what it produces, and the output format.

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?

The description adds meaning beyond the input schema by specifying the parameter is an absolute path and that the file must be a Markdown file. With schema description coverage at 0%, the description effectively documents the single parameter. A baseline of 4 is appropriate because there is only 1 parameter and the description covers it well.

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 uses a specific verb ('Analyze and generate') and resource ('Markdown document'), clearly distinguishing it from sibling tools that convert to other formats. The six bulleted categories provide a detailed breakdown of what the analysis covers.

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 explicitly states the tool performs semantic analysis and generates a structured report, implying its use case as a quality-check step. It doesn't explicitly mention when not to use it versus alternatives, which is acceptable given the sibling tools have very different purposes (format conversion).

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/fengredrum/md2doc'

If you have feedback or need assistance with the MCP directory API, please join our Discord server