Skip to main content
Glama

md-redline

npm version

Markdown仕様書、プロンプト、設計ドキュメント向けのインラインレビューコメントツール。

レンダリングされたドキュメント内のテキストをハイライトしてコメントを残すと、AIエージェントがそれを直接読み取って対応できます。コメントは .md ファイル自体に不可視のHTMLマーカーとして保存されます。サイドカーファイルやデータベース、外部サービスは不要です。Markdownファイルが唯一の信頼できる情報源(ソース・オブ・トゥルース)であり続けます。

組み込みのMCPサーバーを使用すると、エージェントはタスクの途中でレビューを要求し、あなたが Send review をクリックするまで待機できます。あなたがフィードバックを残すと、エージェントは中断したところから作業を再開します。コピー&ペーストやコンテキストの切り替えは不要です。

md-redline screenshot

30秒でわかるレビューワークフロー:

https://github.com/user-attachments/assets/7f493201-3aca-489c-86f0-3a7df454f693

Claude Code、Claude Desktop、Codex CLI、Gemini CLI、およびstdioサーバーをサポートするその他のMCPクライアントで動作します。Sean Groveがspecs are the new codeで論じているように、仕様書はエージェント開発における主要な作業単位になりつつあります。mdr は、そのワークフローにコードレビューに近いレビューツールを提供します。

クイックスタート

前提条件: Node 20以降。

npx md-redline /path/to/spec.md

これにより、必要に応じてローカルアプリが起動し、ブラウザで開かれます。

または、グローバルにインストールします:

npm install -g md-redline
mdr /path/to/spec.md        # Open a file
mdr /path/to/dir             # Open a directory
mdr --stop                   # Stop the running server

md-redline は mdr のエイリアスとしても機能します。

Related MCP server: pad-core

MCPの設定

エージェントがタスクの途中でレビューを要求できるように、MCPサーバーをエージェントに登録します。

Claude Code または Claude Desktop

mdr mcp install                   # register with both clients (default)
mdr mcp install --claude-code     # just Claude Code (via `claude mcp add`)
mdr mcp install --claude-desktop  # just Claude Desktop (JSON config file)

Codex CLI

codex mcp add md-redline -- mdr mcp

Gemini CLI

gemini mcp add --scope user md-redline mdr mcp

--scope user フラグが重要です。Geminiはデフォルトでプロジェクトごとのスコープを使用するため、現在のディレクトリに対してのみ mdr が登録されます。

その他のMCPクライアント

クライアントのMCP設定ファイルに以下のサーバーエントリを追加してください:

{
  "mcpServers": {
    "md-redline": {
      "command": "mdr",
      "args": ["mcp"]
    }
  }
}

前提条件: mdr が PATH に含まれている必要があります(例: npm install -g md-redline)。クライアントがシェルの PATH を継承せずにサブプロセスを生成する場合は、command 値として which mdr で取得した絶対パスを使用してください。

レビューワークフロー

MCPを使用する場合(推奨)

登録後、エージェントにレビューを要求するよう指示します:

"Let me review docs/specs/feature-x.md in mdr before you continue."

エージェントが mdr_request_review を呼び出し、mdr がファイルを開きます。テキストをハイライトしてコメントを残し、Send review をクリックしてください。エージェントはあなたのフィードバックを構造化されたプロンプトとして受け取り、コメントへの対応を開始します。レビューはリクエストごとのオプトイン形式です。エージェントはあなたが要求したときのみ待機します。

MCPを使用しない場合

  1. mdr /path/to/spec.md でMarkdownファイルを開きます。

  2. テキストをハイライトし、インラインコメントを残します。

  3. ハンドオフ用のプロンプトをコピーします。

  4. プロンプトをAIエージェントに貼り付けます。

  5. エージェントがファイルを編集し、フィードバックに対応し、処理したコメントマーカーを削除します。

  6. diffビューで結果を確認します。

オプション: 解決ワークフロー

設定で解決モードを有効にすると、明示的な open(未解決)および resolved(解決済み)状態での人間によるレビューが可能になります。

対象ユーザー

  • ファイルベースのAIエージェントを使用して、ローカルで仕様書、プロンプト、設計ドキュメントを作成している方

  • コミット前や広範なレビューに出す前にドキュメントをレビューするチーム

  • 人間とエージェントの編集ループの中で、プレーンファイルに構造化されたインラインフィードバックを求める方

非目標

  • 共同編集ツールではありません。

  • GitHubのPRレビューの代替ではありません(ファイルがgitにある場合はそちらを使用してください)。

  • 信頼できないコンテンツ向けには設計されていません。これは自身のファイルのためのローカル開発ツールです。

コメントの保存方法

コメントは、参照先のテキストの直前に不可視のHTMLマーカーとしてMarkdown内に直接保存されるため、人間とエージェントの両方が同じファイルで作業できます。

Some text <!-- @comment{
  "id":"uuid",
  "anchor":"highlighted text",
  "text":"Rewrite this section to be clearer.",
  "author":"User",
  "timestamp":"2026-03-26T12:00:00.000Z",
  "replies":[]
} -->highlighted text continues here.

これにより、フィードバックは以下のようになります:

  • プレーンファイルの読み取りを通じてAIエージェントから可視化される

  • Markdownファイルと共にポータブルである

  • 通常のレンダラー(GitHub、VS Codeプレビュー)では不可視である

機能

レビューとコメント

  • レンダリングされたテキストにアンカー付けされたインラインコメント(重複するコメントも含む)

  • スレッド形式の返信と、オプションの open / resolved レビュー状態

  • ドラッグハンドル付きの調整可能なアンカー

  • レンダリング表示、RAW表示、diff表示

  • 1つまたは複数のファイル用のハンドオフプロンプトのコピー

ナビゲーションと編集

  • セッションの永続化とタブコンテキストメニューを備えたマルチタブ編集

  • ファイルエクスプローラー、最近使用したファイル、ネイティブOSのファイルピッカー

  • ドキュメント内検索 (Cmd+F) と一致箇所のナビゲーション

  • スクロールスパイ付きの目次

  • コマンドパレット (Cmd+K)、キーボードショートカット、設定パネル (Cmd+,)

  • リサイズ可能なパネルと右クリックコンテキストメニュー

レンダリングと統合

  • 外部でファイルが変更された際のSSEによるリアルタイムリロード

  • コメント可能なテキストを備えたMermaid図のレンダリング

  • ローカル画像の埋め込みとMarkdownファイル間のクリック可能なリンク

  • カスタマイズ可能なコメントテンプレート

  • 8つのテーマ: Light, Dark, Sepia, Nord, Solarized, GitHub, Rosé Pine, Catppuccin

対応プラットフォーム

  • macOS: 対応

  • Linux: 対応。システムファイルピッカーには zenity が必要です

  • Windows: 対応。システムファイルピッカーはPowerShellを使用します

権限

デフォルトでは、md-redlineはホームディレクトリ内のすべてのMarkdownファイルを読み取ることができます。初めて mdr を実行したとき(または信頼されたルート機能がないバージョンからアップグレードした初回)、ホームフォルダが ~/.md-redline.json の信頼されたルートリストに追加されます。ホームディレクトリ外のファイル(/tmp、マウントされたボリューム、システムパス)を開くには、初回にOSのフォルダピッカー経由で明示的な権限付与が必要です。許可されたフォルダは再起動後も記憶されます。

厳格なフォルダごとのモデルを使用するには、インストール後に一度 mdr --restrict を実行してください。これにより、デフォルトの信頼設定がない ~/.md-redline.json が作成され、その中でファイルを開くたびに各フォルダを明示的に許可することになります。

ファイルの保存には、アトミックな書き込み後のリネームと、mtimeベースの競合検出を使用して、同時編集によるデータ損失を防ぎます。Mermaid SVG出力は、レンダリング前にDOMPurifyでサニタイズされます。md-redlineは信頼できる環境でのみ実行してください。

開発

ソースから

git clone https://github.com/dejuknow/md-redline.git
cd md-redline
npm install
npm run dev

Viteによって出力されたローカルURL(通常は http://localhost:5188)を開きます。

スクリプト

npm run dev          # Start dev server
npm run lint         # Lint
npm test             # Production build + unit tests
npm run test:e2e     # Playwright E2E tests
npm run build        # Production build

エージェント評価

評価ハーネスは、AIエージェントがインラインコメントを正しく読み取り、対処し、削除できるかをテストします。

  • npm run eval:dry は評価フィクスチャを検証します

  • npm run eval は完全な評価ハーネスを実行します

  • 詳細は eval/README.md を参照してください

アーキテクチャ

bin/md-redline             CLI entry point (invoked as `mdr` or `md-redline`)
server/index.ts            Hono server for file I/O, browsing, SSE, and local integrations
src/App.tsx                Main application shell
src/components/            Viewer, sidebar, raw view, diff view, TOC, explorer, settings, etc.
src/hooks/                 State, persistence, selection, file watching, drag handles, tabs
src/lib/comment-parser.ts  Inline comment parsing and mutation helpers
src/markdown/pipeline.ts   Markdown rendering pipeline
eval/                      Eval harness for agent behavior against inline comments
e2e/                       Playwright end-to-end coverage

ライセンス

MIT

Available Tools

6 tools
mdr_add_filesA

Add markdown files to a review session that is already open in mdr (md-redline), without starting a new one. Use it when the reviewer asks for another file mid-review, or when you need to comment on a file the session does not cover yet. Works for sessions from mdr_request_review and mdr_comment alike. The reviewer's mdr tab opens the new files. Returns immediately; carry on with the same sessionId as before. A session that has ended cannot take more files: start a new review instead.

ParametersJSON Schema
NameRequiredDescriptionDefault
filePathsYesAbsolute paths to the markdown files to add. Files the session already covers are skipped.
sessionIdYesThe open session to add the files to.

TDQS

A4.7/5.0
Behavior5/5

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

No annotations are provided, so the description carries the full burden and does so well. It discloses that the tool returns immediately, that the sessionId remains the same, that the reviewer's tab opens the new files, and that ended sessions cannot accept more files. These behavioral details go beyond a simple 'add' statement.

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 five sentences with no wasted words. It front-loads the core operation, then gives usage triggers, compatibility, behavior, and limitations in a logical, efficient progression.

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?

For a two-parameter tool with no annotations and no output schema, the description is complete: it explains what the tool does, when to use it, what side effects occur, and what the agent should do when the session has ended. No critical information is missing.

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 description coverage is 100%, so the schema already documents both sessionId and filePaths. The description adds only mild reinforcement ('same sessionId as before') but no substantive new parameter meaning. Baseline 3 is appropriate.

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 clear action ('Add markdown files to a review session') and specifies the resource and constraint ('already open in mdr... without starting a new one'). It also distinguishes itself by noting compatibility with sessions from mdr_request_review and mdr_comment, so an agent can tell it apart from its siblings.

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

Usage Guidelines5/5

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

The description gives explicit use cases: 'when the reviewer asks for another file mid-review' and 'when you need to comment on a file the session does not cover yet.' It also provides an exclusion and alternative: 'A session that has ended cannot take more files: start a new review instead.'

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

mdr_askA

Ask the user one or more questions anchored to specific text in a file inside an active review session. Each question becomes an inline marker the user sees and can reply to in the md-redline UI. Returns with the reply text as soon as the user has answered every question, or with whatever partial replies exist when they finish the review (Done / Finish review), or empty-handed if the session ends another way. Replies also land in the marker threads on disk, so when this tool returns without reply text you should re-read the file(s) before concluding the user did not answer. Use this when a comment is unclear, or when you hit a planning fork while editing. Prefer asking over guessing when the right answer would meaningfully change your edit.

Only one mdr_ask can be pending per session at a time. If this returns "a previous mdr_ask is still pending", post a reply to the prior question via mdr_comment — pass this same sessionId plus a replies: payload targeting that commentId, which resolves the pending ask in-place without opening a second session — and then retry mdr_ask with your new questions.

ParametersJSON Schema
NameRequiredDescriptionDefault
questionsYes
sessionIdYesSession ID from a previous mdr_comment call, or the sessionId of an active mdr_request_review handoff. Both work: asking a clarifying question about a comment the user left during their own review is the primary use case.

TDQS

A4.8/5.0
Behavior5/5

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

With no annotations provided, the description carries the full disclosure burden and delivers: three distinct return modes (all answered, partial replies on Done/Finish review, empty-handed on other session ends), a side-effect warning that replies land in marker threads on disk with the instruction to re-read files before concluding the user didn't answer, and the one-pending-ask-per-session concurrency constraint with its recovery path.

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?

Every sentence earns its place: purpose, return semantics, disk side-effect warning, usage criteria, then concurrency/error recovery. The opening sentence front-loads the primary purpose, and the longer second paragraph is justified by the subtle pending-ask recovery flow it documents.

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 an async, user-interactive tool with no annotations and no output schema, the description covers purpose, all return cases, side effects, concurrency, and error recovery — remarkably complete. The main gap is that the reply payload shape is never specified ('returns with the reply text' / 'whatever partial replies exist' leaves the structure to inference), which an agent needs to know to consume the result reliably.

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?

Schema coverage is only 50%, so the description must compensate. It adds the anchoring concept behind filePath/anchor and the sessionId reuse-and-retry flow ('pass this same sessionId plus a replies: payload targeting that commentId'). However, contextAfter and contextBefore remain undocumented in both the schema and the description, leaving some parameter meaning to inference.

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 opens with a specific verb-resource pairing: 'Ask the user one or more questions anchored to specific text in a file inside an active review session.' It further explains the inline-marker mechanism, which clearly differentiates it from siblings like mdr_comment (posting replies) and mdr_request_review (starting a review handoff).

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

Usage Guidelines5/5

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

Explicit usage criteria are given: 'Use this when a comment is unclear, or when you hit a planning fork while editing,' plus a decision heuristic: 'Prefer asking over guessing when the right answer would meaningfully change your edit.' It also covers the exclusion case — if a previous mdr_ask is pending, route through mdr_comment with a replies payload targeting that commentId instead of opening a second session.

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

mdr_baselineA

Call this BEFORE you edit markdown files the user will later review in mdr (md-redline). It saves a copy of each file as it is right now so the reviewer's diff can show exactly what you changed. Returns immediately. Include files you are about to create (their folder must already exist); they are saved as empty. Do not call it after you have already edited a file: the copy would already contain your changes. Workflow: mdr_baseline (before editing) -> edit the files -> mdr_request_review. At most 64 files per call. If the reviewer already has a before point for a file from an earlier handoff or review, that one is kept.

ParametersJSON Schema
NameRequiredDescriptionDefault
agentNameNoYour agent name (e.g. "Claude"). Shown in the diff label; longer than 64 characters is cut.
filePathsYesAbsolute paths to the markdown files you are about to edit.

TDQS

A4.3/5.0
Behavior5/5

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

With no annotations provided, the description carries the full behavioral burden and delivers richly: it discloses the empty-file baseline for new files, the folder-must-exist prerequisite, the max 64-file limit, the too-late failure mode, and the keep-earlier-baseline dedup behavior. 'Returns immediately' also sets correct expectations of a non-blocking call. No important behavioral trait is left to inference.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The critical timing instruction is front-loaded as the first clause, and nearly every sentence carries decision-relevant information. It runs slightly long and repeats one schema fact ('At most 64 files per call' mirrors maxItems: 64), which keeps it just short of a 5.

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 two-parameter tool with no output schema and no annotations, the description covers the call decision thoroughly: when to call, what it does, edge cases, constraints, and the follow-on workflow. The only gap is that the return value is described only as 'Returns immediately,' leaving the agent to guess how errors or failures would be reported.

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 description coverage is 100%, with both agentName (including 64-char truncation) and filePaths (absolute paths, files about to edit) already fully documented. The description adds only marginal nuance — files to be created are saved empty and their folder must already exist — but mostly restates schema content. The high-coverage baseline of 3 applies.

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?

States a specific action ('saves a copy of each file') against a specific resource (markdown files) with a clear purpose: so the reviewer's diff shows exactly what changed. The opening clause 'Call this BEFORE you edit markdown files' positions it as a pre-edit snapshot step, and the workflow reference to mdr_request_review distinguishes it from review-stage siblings. The name, timing, and action align without ambiguity.

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?

Gives explicit when-to-use ('BEFORE you edit markdown files the user will later review in mdr') and explicit when-not-to-use ('Do not call it after you have already edited a file'), plus a concrete workflow sequence. It does not explicitly name alternatives for other scenarios, but the when/when-not guidance plus the workflow reference to mdr_request_review makes the call decision practically unambiguous.

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

mdr_commentA

Post YOUR OWN comments into markdown files for the user to read. Use this when the user asks YOU to review a doc and leave feedback on it.

If instead the user wants to review a doc THEMSELVES and have you address what they write ("I want to review X in mdr", "let me review X", "open X so I can comment"), call mdr_request_review, NOT this tool. The word "review" in those requests describes what the user is about to do, not what you should do. This tool writes your comments into their file, which is the opposite of what they asked for.

Returns IMMEDIATELY after posting (never blocks). In the filePaths form the returned sessionId MUST be passed to mdr_wait afterward to block until the user clicks Done — that is a two-tool flow: mdr_comment (post) → mdr_wait (block). This does NOT apply to the sessionId form below, which posts into a session you did not open; mdr_wait rejects user-origin sessions. Skipping mdr_wait leaves a banner on the user's screen until they click Done; you will not see their replies or edits before continuing, and any user feedback will be invisible to you for this turn.

The comments appear as inline markers anchored to specific text, which the user can then address.

Comments are anchored to exact text in the rendered document (not the raw markdown). For text inside Mermaid diagrams or markdown-formatted spans, the renderer will fall back to label/stripped matching.

Include author on each comment/reply identifying yourself (e.g. 'Claude', 'Codex', 'Gemini'). This appears in the mdr UI so the user knows which agent left the feedback.

To reply inside a review the user already has open — the session from an mdr_request_review handoff, or one this tool returned earlier — pass sessionId instead of filePaths. The batch lands in that session and no second tab or banner appears. Use it whenever you are replying as you work rather than posting a fresh review; the filePaths form always opens its own session.

ParametersJSON Schema
NameRequiredDescriptionDefault
repliesNo
commentsNo
filePathsNoAbsolute paths to markdown files to review. Opens a new session. Omit when passing sessionId.
sessionIdNoPost into this existing session instead of opening a new one. Accepts the sessionId of an active mdr_request_review handoff or of a previous mdr_comment call. Mutually exclusive with filePaths.
enableResolveNo

TDQS

A4.7/5.0
Behavior5/5

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

With no annotations provided, the description carries the full burden and succeeds. It discloses non-blocking execution ('Returns IMMEDIATELY'), the required two-tool flow with mdr_wait, mdr_wait's rejection of user-origin sessions, banner and invisible-feedback consequences, the anchoring to rendered text with fallback behavior, and the author attribution requirement. This is rich behavioral context well beyond the basic 'post a comment' semantics.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is long but front-loaded: purpose, trigger, and the key mdr_request_review distinction come first, then critical async/session behavior. Each paragraph carries necessary operational information that an agent must know to call this tool correctly, so the length is justified even though some sentences restate the same core contrast.

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?

Given the tool's complex two-session flow and the absence of an output schema, the description covers the major operational concerns: immediate return, mdr_wait sequencing, user-origin session restrictions, anchor/rendering behavior, and reply handling via sessionId. Minor gaps exist around enableResolve and the exact return value shape, but they are not likely to cause incorrect invocation.

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?

Schema coverage is only 40%, so the description's parameter guidance is valuable. It explains the central filePaths vs sessionId choice, states that filePaths opens a new session while sessionId posts into an existing one, and instructs the agent to include author on each comment/reply. However, it leaves enableResolve and the contextBefore/contextAfter fields unexplained, so it does not fully compensate for the schema gaps.

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 opens with a specific verb and resource: 'Post YOUR OWN comments into markdown files for the user to read.' It also explicitly differentiates the tool from mdr_request_review by explaining when 'review' refers to the user's action rather than the agent's, giving clear sibling distinction.

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

Usage Guidelines5/5

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

Usage criteria are explicit: use when the user asks YOU to review a doc and leave feedback; do not use when the user wants to review themselves. It names the alternative tool (mdr_request_review), gives concrete example phrasings to detect the wrong case, and further distinguishes between the filePaths and sessionId flows with the mdr_wait dependency.

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

mdr_request_reviewA

Open markdown files in mdr (md-redline) so the USER can review them and leave comments for you to address, or continue an existing review session. Use this whenever the user wants to read, review, or comment on a doc themselves, including phrasings like "I want to review X in mdr", "open X so I can comment", or "let me look at X". The user is the reviewer here; you wait and then address what they write. To start a new review, pass filePaths. If you are about to edit or create files the user will review, call mdr_baseline before touching them so the user can see a diff of your changes. Calling it after you have edited does not help: the copy would already include your edits. To continue after addressing a batch of comments, or to re-poll while the user is still reviewing, pass the sessionId from the previous result (without filePaths). If the result says the user has not finished yet, call again with the same sessionId to keep waiting. IMPORTANT: while this tool is waiting (no "batch" or "done" result has arrived yet, or you are between batches), you do not have permission to read, open, edit, or otherwise act on the files under review using other tools. The user is actively writing @comment markers into those files; reading them yourself will surface unsubmitted markers you must not address. Once a "batch" or "done" result arrives you may read/edit the files, but only to address the comments listed in that result — ignore any other @comment markers you encounter in the file.

ParametersJSON Schema
NameRequiredDescriptionDefault
filePathsNoAbsolute paths to markdown files to review (for new sessions).
sessionIdNoSession ID from a previous batch result. Pass this (without filePaths) to wait for the next batch of comments after addressing the previous batch.
enableResolveNoWhether to use the resolve workflow (open/resolved states).

TDQS

A4.8/5.0
Behavior5/5

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

The description discloses critical behavioral traits beyond annotations: the tool blocks the agent from reading/editing files under review while waiting, because the user is actively writing @comment markers. It explains the consequence of ignoring this (surfacing unsubmitted markers) and clarifies that after a 'batch' or 'done' result, the agent may only address comments listed in that result. This is rich, actionable behavioral context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is long but every sentence earns its place given the tool's complexity. It front-loads the core purpose and usage, then covers the critical waiting behavior and post-batch constraints. The structure is logical: purpose → when to use → new vs continue → critical warning → post-result rules. Slightly verbose but justified by the need to prevent misuse.

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's complexity (3 params, no output schema, no annotations), the description is remarkably complete. It covers when to use, how to start/continue, the critical waiting constraint, what happens after results arrive, and the relationship with mdr_baseline. The only minor gap is the exact meaning of enableResolve, but the schema covers that and the description mentions the resolve workflow.

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?

Schema coverage is 100%, so the schema already documents all three parameters. The description adds meaningful context beyond the schema: it explains the relationship between filePaths and sessionId (mutually exclusive usage), and clarifies that sessionId is used to continue after addressing a batch. It also explains the purpose of enableResolve implicitly through the resolve workflow mention, though it doesn't detail the workflow.

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 clearly states the tool's purpose: open markdown files in mdr for the user to review and comment on, or continue an existing review session. It uses specific verbs ('open', 'review', 'comment') and explicitly distinguishes the user as the reviewer while the agent waits and addresses comments. It also differentiates from siblings by naming mdr_baseline and explaining when to use it.

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

Usage Guidelines5/5

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

The description provides explicit when-to-use guidance, including example phrasings like 'I want to review X in mdr' and 'open X so I can comment'. It clearly states when to pass filePaths (new review) vs sessionId (continue/re-poll), and when to call mdr_baseline before editing. It also gives a critical exclusion: do not use other tools on files under review while waiting.

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

mdr_waitA

Block until the user has finished engaging with an mdr_comment session. Call this once after you have posted all your feedback batches via mdr_comment. Returns when the user clicks Done in the mdr UI. If the wait times out (90s), returns {status:"pending"} — call mdr_wait again with the same sessionId to keep waiting. After this returns {status:"done"}, read the file(s) to see the user's replies, deletions, and resolutions.

ParametersJSON Schema
NameRequiredDescriptionDefault
sessionIdYesSession ID returned by mdr_comment.

TDQS

A4.7/5.0
Behavior5/5

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

With no annotations provided, the description carries the full disclosure burden and does so thoroughly: it states that the call blocks, that the timeout is 90 seconds, that a timeout returns {status:'pending'}, that it may be retried, and that a done status should be followed by reading files for user edits. No contradictions with schema or annotations.

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?

Three sentences each carry essential information: purpose, timeout/retry behavior, and post-done follow-up. The most important verb is front-loaded and there is no filler or repetition of schema fields.

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?

For a one-parameter tool with no output schema, the description covers the blocking behavior, both possible return statuses, the retry loop, and the subsequent action of reading files. Nothing an agent needs to invoke and handle this tool correctly is missing.

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 description coverage is 100% and already explains sessionId as 'Session ID returned by mdr_comment.' The tool description reinforces using the same sessionId on retry, a small behavioral addition, but not enough to raise the score above the baseline for fully documented parameters.

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 opens with a specific verb-resource pair: 'Block until the user has finished engaging with an mdr_comment session.' It clearly distinguishes itself from mdr_comment and sibling tools by positioning mdr_wait as the follow-up wait step after feedback batches are posted.

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

Usage Guidelines5/5

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

It gives explicit sequencing: 'Call this once after you have posted all your feedback batches via mdr_comment.' It also specifies the retry pattern on timeout ('call mdr_wait again with the same sessionId') and what to do after done, leaving no ambiguity about when to invoke it.

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

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 2 tool updatesv0.10.0
    • Addedmdr_add_files
    • Addedmdr_baseline
  2. 4 tool updatesv0.9.0
    • Changedmdr_ask1 field changed
      • changedInput schema / properties / sessionId / description
        Previous value: -"Session ID from a previous mdr_review call, or the sessionId of an active mdr_request_review handoff. Both work: asking a clarifying question about a comment the user left during their own review is the primary use case."New value: +"Session ID from a previous mdr_comment call, or the sessionId of an active mdr_request_review handoff. Both work: asking a clarifying question about a comment the user left during their own review is the primary use case."
    • Addedmdr_comment
    • Removedmdr_review
    • Changedmdr_wait1 field changed
      • changedInput schema / properties / sessionId / description
        Previous value: -"Session ID returned by mdr_review."New value: +"Session ID returned by mdr_comment."
  3. 3 tool updatesv0.7.2
    • Addedmdr_ask
    • Addedmdr_review
    • Addedmdr_wait
  4. 3 tool updatesv0.7.1
    • Removedmdr_ask
    • Removedmdr_review
    • Removedmdr_wait
  5. 3 tool updatesv0.5.0
    • Addedmdr_ask
    • Addedmdr_review
    • Addedmdr_wait
  6. 1 tool updatev0.3.2
    • First observedmdr_request_review

TDQS

A4.5/5.0

Scored across 6 tools

Disambiguation4/5

The tools are mostly distinct: mdr_request_review is for user-led review, mdr_comment for agent-led feedback, mdr_ask for questions, and the others each have a clear single purpose. mdr_request_review and mdr_comment could be confused at a glance since both involve 'review', but the descriptions explicitly and thoroughly disambiguate them.

Naming Consistency4/5

All tools share the mdr_ prefix and snake_case convention, which gives a strong cohesive feel. However, the suffixes mix patterns: verb_noun (request_review, add_files), a noun used as verb (baseline), and bare verbs (ask, comment, wait), so the verb_noun pattern is not uniform.

Tool Count5/5

Six tools is well-scoped for a review-collaboration domain. Each tool covers a distinct step in the workflow—starting/continuing reviews, adding files, baselining, asking, commenting, and waiting—without redundancy or bloat.

Completeness5/5

The tool set covers the full lifecycle of both review directions: user reviewing with agent addressing (request_review, baseline, add_files, ask, comment) and agent reviewing for the user (comment, wait). No obvious dead ends or missing operations for the stated purpose.

Maintenance

ActivityActive
ResponsivenessWithin a week

Related MCP Connectors

Related MCP Servers

  • A
    license
    Not graded
    quality
    F
    maintenance
    MCP server for collaborative markdown editing, allowing agents to write documents and humans to comment, with comments fed back as agent input.
    295,457 npm
    MIT