md-feedback 1.3.20 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -30
- package/dist/mcp-server.js +44 -44
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,15 +7,15 @@
|
|
|
7
7
|
|
|
8
8
|
## What is this?
|
|
9
9
|
|
|
10
|
-
md-feedback is an [MCP](https://modelcontextprotocol.io/) server that lets AI agents (Claude Code, Cursor, and other MCP-compatible clients) read your markdown review annotations, mark memos done, evaluate quality gates, and generate session handoffs — all automatically.
|
|
11
|
-
|
|
12
|
-
Copilot users can use MD Feedback via export flow (`.github/copilot-instructions.md`) even when MCP is not enabled.
|
|
10
|
+
md-feedback is an [MCP](https://modelcontextprotocol.io/) server that lets AI agents (Claude Code, Cursor, and other MCP-compatible clients) read your markdown review annotations, mark memos done, evaluate quality gates, and generate session handoffs — all automatically.
|
|
11
|
+
|
|
12
|
+
Copilot users can use MD Feedback via export flow (`.github/copilot-instructions.md`) even when MCP is not enabled.
|
|
13
13
|
|
|
14
14
|
**This is the MCP server component.** For the VS Code extension, see [MD Feedback on VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=yeominux.md-feedback-vscode).
|
|
15
15
|
|
|
16
16
|
## Quick Start
|
|
17
17
|
|
|
18
|
-
Add to your MCP client config (Claude Code, Cursor, etc.):
|
|
18
|
+
Add to your MCP client config (Claude Code, Cursor, etc.):
|
|
19
19
|
|
|
20
20
|
```json
|
|
21
21
|
{
|
|
@@ -28,8 +28,8 @@ Add to your MCP client config (Claude Code, Cursor, etc.):
|
|
|
28
28
|
}
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
That's it. No install, no setup — `npx` handles everything.
|
|
32
|
-
Prerequisite: Node.js 18+.
|
|
31
|
+
That's it. No install, no setup — `npx` handles everything.
|
|
32
|
+
Prerequisite: Node.js 18+.
|
|
33
33
|
|
|
34
34
|
**Workspace override** — if your MCP client doesn't set `cwd` to the project folder:
|
|
35
35
|
|
|
@@ -44,35 +44,35 @@ Prerequisite: Node.js 18+.
|
|
|
44
44
|
}
|
|
45
45
|
```
|
|
46
46
|
|
|
47
|
-
Resolution order: `--workspace=` CLI arg > `MD_FEEDBACK_WORKSPACE` env > `cwd`
|
|
48
|
-
|
|
49
|
-
Known MCP config file paths:
|
|
50
|
-
- Claude Code: `.claude/mcp.json`
|
|
51
|
-
- Cursor: `.cursor/mcp.json`
|
|
52
|
-
|
|
53
|
-
Windows workspace example:
|
|
54
|
-
```json
|
|
55
|
-
{
|
|
56
|
-
"mcpServers": {
|
|
57
|
-
"md-feedback": {
|
|
58
|
-
"command": "npx",
|
|
59
|
-
"args": ["-y", "md-feedback", "--workspace=C:\\\\work\\\\my-project"]
|
|
60
|
-
}
|
|
61
|
-
}
|
|
62
|
-
}
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
## 27 MCP Tools
|
|
47
|
+
Resolution order: `--workspace=` CLI arg > `MD_FEEDBACK_WORKSPACE` env > `cwd`
|
|
48
|
+
|
|
49
|
+
Known MCP config file paths:
|
|
50
|
+
- Claude Code: `.claude/mcp.json`
|
|
51
|
+
- Cursor: `.cursor/mcp.json`
|
|
52
|
+
|
|
53
|
+
Windows workspace example:
|
|
54
|
+
```json
|
|
55
|
+
{
|
|
56
|
+
"mcpServers": {
|
|
57
|
+
"md-feedback": {
|
|
58
|
+
"command": "npx",
|
|
59
|
+
"args": ["-y", "md-feedback", "--workspace=C:\\\\work\\\\my-project"]
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## 27 MCP Tools
|
|
66
66
|
|
|
67
67
|
| Tool | Description |
|
|
68
68
|
|------|-------------|
|
|
69
|
-
| `get_document_structure` | Full review state: memos, gates, cursor, sections, summary, metrics |
|
|
70
|
-
| `list_documents` | List markdown files in workspace (optionally annotated-only) |
|
|
71
|
-
| `list_annotations` | All annotations with type/status/owner/color |
|
|
72
|
-
| `get_review_status` | Annotation counts and session status |
|
|
69
|
+
| `get_document_structure` | Full review state: memos, gates, cursor, sections, summary, metrics |
|
|
70
|
+
| `list_documents` | List markdown files in workspace (optionally annotated-only) |
|
|
71
|
+
| `list_annotations` | All annotations with type/status/owner/color |
|
|
72
|
+
| `get_review_status` | Annotation counts and session status |
|
|
73
73
|
| `create_annotation` | Create annotation programmatically with anchor search |
|
|
74
74
|
| `respond_to_memo` | Add AI response to an annotation |
|
|
75
|
-
| `update_memo_status` | Update a memo status to open/in_progress/needs_review (terminal statuses are VS Code approval path) |
|
|
75
|
+
| `update_memo_status` | Update a memo status to open/in_progress/needs_review (terminal statuses are VS Code approval path) |
|
|
76
76
|
| `update_cursor` | Set plan cursor position (task ID, step, next action) |
|
|
77
77
|
| `evaluate_gates` | Check if merge/release/implement conditions are met |
|
|
78
78
|
| `export_review` | Export for a specific AI tool format |
|