katana-markdown-linter

A markdownlint-compatible Rust engine, kml CLI, formatter, safe fixer, editor server, and agent-ready MCP server.

Installation | CLI Usage | Library API | Editor Integration | MCP Server

What is kml

katana-markdown-linter is a fast Markdown lint engine for technical writing, specification documents, and AI-agent-assisted documentation workflows.

The project shares the KatanA visual identity, but keeps a standalone boundary: the crate, CLI, wrappers, editor server, and MCP server do not depend on KatanA Desktop.

Features

• markdownlint-compatible checks for the active upstream rule catalog
• Safe fixes for low-risk rule violations and explicit opt-in unsafe fixes
• Formatter mode for layout normalization without changing author intent
• Embeddable Rust API for applications that need linting or fixing in-process
• kml CLI with JSON output, stdin support, ignore handling, and statistics
• Editor integration through a stdio Language Server Protocol server
• MCP server for agents and tools that need structured lint access
• Multi-channel distribution through Cargo, GitHub Releases, npm, PyPI, and Homebrew

Library API

Use the crate directly when embedding linting into another Rust application.

• lint(content, options)
• fix(content, options)
• available_rules()
• localized_available_rules(language_code)
• implemented_rules()
• missing_rules()
• rule_catalog()
• localized_rule_catalog(language_code)
• resolve_locale_code(language_code)
• resolve_locale_code_or(language_code, fallback)
• localized_rule_description(rule_id, fallback_description, language_code)
• supported_locales()
• upstream::get_rule_documentation(rule_id, locale)
• MarkdownLintConfig
• MarkdownLintConfig::schema()
• MarkdownLintConfig::to_lint_options()

available_rules() returns canonical English metadata. For user-facing rule catalogs, call localized_available_rules(language_code), localized_rule_catalog(language_code), RuleMeta::localized_description(...), or localized_rule_description(...) so applications can pass UI language codes without reimplementing kml's fallback policy.

Locale is #[non_exhaustive] from v0.6.0. Consumers that match on Locale should include a wildcard arm and prefer resolve_locale_code(...) or resolve_locale_code_or(...) for UI language strings. Rule descriptions and rule Markdown documentation are localized for en, ja, zh-CN, zh-TW, ko, pt, fr, de, es, and it.

Mi

... View full README on GitHub