explaingit

thedecipherist/markdownai

Analysis updated 2026-06-24

33TypeScriptAudience · developerComplexity · 3/5LicenseSetup · easy

TLDR

A Markdown extension and MCP server that resolves directives like @env, @http, @db, and @query at read time so an AI assistant sees live values instead of stale text.

Mindmap

mindmap
  root((MarkdownAI))
    Inputs
      Markdown with directives
      Env values
      Database queries
    Outputs
      Resolved document
      Phase chunks
      MCP responses
    Use Cases
      Live runbooks
      Always-fresh docs
      Phased onboarding
    Tech Stack
      TypeScript
      Node
      MCP
      VS Code
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Write a deployment runbook that resolves live env vars and HTTP probes whenever Claude opens it

USE CASE 2

Split a 20-step runbook into @phase chunks so the model only loads one phase at a time

USE CASE 3

Replace stale snippets in onboarding docs with @db and @query directives that run on read

USE CASE 4

Author docs in VS Code using the MarkdownAI extension and preview the resolved output

What is it built with?

TypeScriptNode.jsMCPVSCode

How does it compare?

thedecipherist/markdownaidavidichalfyorov-wq/openxivkentjuno/kjaudiobook-v1
Stars333333
LanguageTypeScriptTypeScriptTypeScript
Setup difficultyeasyhardhard
Complexity3/55/54/5
Audiencedeveloperresearcherdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 30min

Needs Node.js 18+ and an MCP-capable client like Claude Desktop or VS Code to actually resolve the directives.

MIT license: use, modify, and redistribute freely including for commercial use, as long as you keep the copyright notice.

In plain English

MarkdownAI is a tool for writing live Markdown documents that are meant to be read by an AI assistant like Claude rather than by a browser. The pitch is plain in the tagline, "documentation that cannot lie." Instead of writing a value into a doc and watching it go stale as the underlying code, database, or environment changes, you write small directives like @env, @http, @db, and @query, and those directives are resolved every time the document is rendered. The authors are clear that this is not a template engine in the Jinja or Handlebars sense. The key differences they call out: the consumer is an AI rather than a browser, the directives run when Claude opens the file rather than at build time, and the resolution happens inside an MCP server before Claude ever sees the file. By the time Claude reads the document, the conditional branches are already chosen, the database queries have already run, and the environment values are already substituted, so the assistant does not have to stop and run shell commands to gather basic facts. A second feature called @phase lets a long workflow be split into named chunks that the MCP server hands out one at a time. A 20-step deployment runbook, for example, does not have to load all 20 steps into the AI's context at once. The model reads phase 1, calls next_phase, and only then receives phase 2. The README presents this as a way to keep complex runbooks, debugging guides, or onboarding sequences from flooding the context window, with each transition between phases being explicit. The project ships as an npm package, @markdownai/markdownai, and as a VS Code extension. It requires Node.js 18 or newer, claims 754 passing tests, and is released under the MIT license. The README points to a hosted documentation site and a separate user guide for the full reference, along with a Quick Start section, a directive reference, and a 78-feature user manual stored inside the repo.

Copy-paste prompts

Prompt 1
Set up MarkdownAI as an MCP server in Claude Desktop and write a hello-world doc with an @env directive.
Prompt 2
Convert my current deployment runbook into MarkdownAI @phase chunks so Claude only loads one phase at a time.
Prompt 3
Show me how to write a safe @query directive against a read-only Postgres replica.
Prompt 4
Compare MarkdownAI's directive approach to Jinja templating for a runbook that pulls live HTTP health checks.

Frequently asked questions

What is markdownai?

A Markdown extension and MCP server that resolves directives like @env, @http, @db, and @query at read time so an AI assistant sees live values instead of stale text.

What language is markdownai written in?

Mainly TypeScript. The stack also includes TypeScript, Node.js, MCP.

What license does markdownai use?

MIT license: use, modify, and redistribute freely including for commercial use, as long as you keep the copyright notice.

How hard is markdownai to set up?

Setup difficulty is rated easy, with roughly 30min to a first successful run.

Who is markdownai for?

Mainly developer.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.