md-redline
md-redline
마크다운 사양, 프롬프트 및 디자인 문서를 위한 인라인 리뷰 댓글 도구입니다.
렌더링된 문서에서 텍스트를 강조 표시하고 댓글을 남기면, AI 에이전트가 이를 직접 읽고 처리할 수 있습니다. 댓글은 .md 파일 자체에 보이지 않는 HTML 마커로 저장됩니다. 사이드카 파일, 데이터베이스, 외부 서비스가 필요 없습니다. 마크다운 파일이 진실의 원천(source of truth)으로 유지됩니다.
내장된 MCP 서버를 사용하면 에이전트가 작업 중간에 검토를 요청하고 **검토 보내기(Send review)**를 클릭할 때까지 일시 중지할 수 있습니다. 사용자가 피드백을 남기면 에이전트가 중단된 지점부터 작업을 재개합니다. 복사-붙여넣기나 컨텍스트 전환이 필요 없습니다.

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 servermd-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 mcpGemini 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 사용 시 (권장)
등록 후 에이전트에게 검토를 요청하세요:
"계속하기 전에 mdr에서 docs/specs/feature-x.md를 검토해 줘."
에이전트가 mdr_request_review를 호출하면 mdr이 파일을 열고, 사용자가 텍스트를 강조 표시하고 댓글을 남긴 후 **검토 보내기(Send review)**를 클릭합니다. 에이전트는 피드백을 구조화된 프롬프트로 받아 댓글을 처리하기 시작합니다. 검토는 요청 시 선택적으로 진행됩니다. 에이전트는 사용자가 요청할 때만 일시 중지합니다.
MCP 미사용 시
mdr /path/to/spec.md로 마크다운 파일을 엽니다.텍스트를 강조 표시하고 인라인 댓글을 남깁니다.
핸드오프 프롬프트를 복사합니다.
프롬프트를 AI 에이전트에 붙여넣습니다.
에이전트가 파일을 편집하고 피드백을 처리한 뒤 처리된 댓글 마커를 제거합니다.
diff 뷰에서 결과를 검토합니다.
선택 사항: 해결 워크플로우
설정에서 해결 모드를 활성화하여 명시적인 open 및 resolved 상태로 사람의 검토를 진행할 수 있습니다.
대상 사용자
파일 기반 AI 에이전트를 사용하여 로컬에서 사양, 프롬프트 또는 디자인 문서를 작성하는 분들
커밋하거나 더 넓은 범위의 검토를 위해 문서를 보내기 전에 검토하는 팀
일반 파일 내에서 구조화된 인라인 피드백을 원하는 사람 + 에이전트 편집 루프에 있는 모든 분들
비목표
협업형 다중 사용자 편집 도구가 아닙니다.
GitHub PR 리뷰를 대체하지 않습니다(파일이 git에 올라가면 PR 리뷰를 사용하세요).
신뢰할 수 없는 콘텐츠를 위해 설계되지 않았습니다. 본인의 파일을 위한 로컬 개발 도구입니다.
댓글 저장 방식
댓글은 마크다운 내부에 보이지 않는 HTML 마커로, 참조하는 텍스트 바로 앞에 저장되므로 사람과 에이전트 모두 동일한 파일에서 작업할 수 있습니다.
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 에이전트가 확인 가능
마크다운 파일과 함께 이동 가능
일반 렌더러(GitHub, VS Code 미리보기)에서는 보이지 않음
기능
검토 및 댓글
렌더링된 텍스트에 고정된 인라인 댓글 (중첩 댓글 포함)
스레드형 답글 및 선택적
open/resolved검토 상태드래그 핸들로 조정 가능한 앵커
렌더링, 원본 및 diff 뷰
하나 또는 여러 파일에 대한 핸드오프 프롬프트 복사
탐색 및 편집
세션 유지 및 탭 컨텍스트 메뉴를 지원하는 다중 탭 편집
파일 탐색기, 최근 파일 및 기본 OS 파일 선택기
문서 내 찾기 (
Cmd+F) 및 일치 항목 탐색스크롤 스파이가 포함된 목차
명령 팔레트 (
Cmd+K), 키보드 단축키 및 설정 패널 (Cmd+,)크기 조절 가능한 패널 및 우클릭 컨텍스트 메뉴
렌더링 및 통합
외부에서 파일 변경 시 SSE를 통한 실시간 새로고침
댓글 작성이 가능한 텍스트를 포함한 Mermaid 다이어그램 렌더링
로컬 이미지 임베드 및 마크다운 파일 간 클릭 가능한 링크
사용자 정의 가능한 댓글 템플릿
8가지 테마: Light, Dark, Sepia, Nord, Solarized, GitHub, Rosé Pine, Catppuccin
지원 플랫폼
macOS: 지원
Linux: 지원; 시스템 파일 선택기는
zenity필요Windows: 지원; 시스템 파일 선택기는 PowerShell 사용
권한
기본적으로 md-redline은 홈 디렉토리의 모든 마크다운 파일을 읽을 수 있습니다. mdr을 처음 실행할 때(또는 trusted-roots 기능이 없는 버전에서 업그레이드한 후 처음 실행할 때), 홈 폴더가 ~/.md-redline.json의 신뢰할 수 있는 루트 목록에 추가됩니다. 홈 디렉토리 외부의 파일(/tmp, 마운트된 볼륨, 시스템 경로)은 처음 열 때 OS 폴더 선택기를 통해 명시적인 권한 부여가 필요합니다. 부여된 폴더는 재시작 후에도 기억됩니다.
엄격한 폴더별 모델을 사용하려면 설치 후 mdr --restrict를 한 번 실행하세요. 그러면 기본 신뢰가 없는 ~/.md-redline.json이 생성되며, 파일을 처음 열 때마다 각 폴더에 대해 명시적으로 권한을 부여하게 됩니다.
파일 저장은 원자적 쓰기 후 이름 바꾸기(atomic write-then-rename) 및 mtime 기반 충돌 감지를 사용하여 동시 편집으로 인한 데이터 손실을 방지합니다. Mermaid SVG 출력은 렌더링 전 DOMPurify를 통해 살균됩니다. 신뢰할 수 있는 환경에서만 md-redline을 실행하세요.
개발
소스에서 빌드
git clone https://github.com/dejuknow/md-redline.git
cd md-redline
npm install
npm run devVite가 출력하는 로컬 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라이선스
Available Tools
6 toolsmdr_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.
| Name | Required | Description | Default |
|---|---|---|---|
| filePaths | Yes | Absolute paths to the markdown files to add. Files the session already covers are skipped. | |
| sessionId | Yes | The open session to add the files to. |
TDQS
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.
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.
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.
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.
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.
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.
| Name | Required | Description | Default |
|---|---|---|---|
| questions | Yes | ||
| sessionId | Yes | 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. |
TDQS
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.
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.
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.
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.
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.
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.
| Name | Required | Description | Default |
|---|---|---|---|
| agentName | No | Your agent name (e.g. "Claude"). Shown in the diff label; longer than 64 characters is cut. | |
| filePaths | Yes | Absolute paths to the markdown files you are about to edit. |
TDQS
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.
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.
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.
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.
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.
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.
| Name | Required | Description | Default |
|---|---|---|---|
| replies | No | ||
| comments | No | ||
| filePaths | No | Absolute paths to markdown files to review. Opens a new session. Omit when passing sessionId. | |
| sessionId | No | Post 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. | |
| enableResolve | No |
TDQS
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.
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.
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.
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.
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.
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.
| Name | Required | Description | Default |
|---|---|---|---|
| filePaths | No | Absolute paths to markdown files to review (for new sessions). | |
| sessionId | No | Session ID from a previous batch result. Pass this (without filePaths) to wait for the next batch of comments after addressing the previous batch. | |
| enableResolve | No | Whether to use the resolve workflow (open/resolved states). |
TDQS
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.
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.
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.
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.
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.
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.
| Name | Required | Description | Default |
|---|---|---|---|
| sessionId | Yes | Session ID returned by mdr_comment. |
TDQS
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.
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.
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.
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.
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.
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.
2 tool updates
v0.10.0- Added
mdr_add_files - Added
mdr_baseline
4 tool updates
v0.9.0- Changed
mdr_ask1 field changed- changed
Input schema / properties / sessionId / descriptionPrevious 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."
- Added
mdr_comment - Removed
mdr_review - Changed
mdr_wait1 field changed- changed
Input schema / properties / sessionId / descriptionPrevious value: -"Session ID returned by mdr_review."New value: +"Session ID returned by mdr_comment."
3 tool updates
v0.7.2- Added
mdr_ask - Added
mdr_review - Added
mdr_wait
3 tool updates
v0.7.1- Removed
mdr_ask - Removed
mdr_review - Removed
mdr_wait
3 tool updates
v0.5.0- Added
mdr_ask - Added
mdr_review - Added
mdr_wait
1 tool update
v0.3.2- First observed
mdr_request_review
TDQS
Scored across 6 tools
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.
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.
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.
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
Related MCP Connectors
MarkupBase turns AI-generated Markdown and HTML into durable, versioned artifacts that people can review and discuss. Its MCP server lets agents publish new versions, preserve contextual comments, include hosted images, and respond to feedback through secure account-linked identities, creating a clear human review boundary without requiring real-time editing.
Human-in-the-loop document review: an agent pushes a draft, a person comments, the agent revises.
MEOK AGENTS.md Linter MCP — validates the cross-vendor coding-agent spec (Cursor / Claude Code /
Versioned artifact review for people and AI agents, with contextual comments and human control.
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceA local-first markdown review tool with MCP integration, enabling AI and humans to collaboratively annotate documents inline and generate revision prompts.1MIT
- AlicenseNot gradedqualityFmaintenanceMCP server for collaborative markdown editing, allowing agents to write documents and humans to comment, with comments fed back as agent input.295,457 npmMIT
- AlicenseNot gradedqualityDmaintenanceEnables sharing Markdown documents for collaborative review with inline annotations and structured change requests.16 npmMIT
- AlicenseNot gradedqualityCmaintenanceEnables anchored comments in Markdown files that AI agents can propose changes for, with human approval before application, all managed via an MCP server.2MIT