mcp-medic 1.0.2 → 1.0.3
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 +11 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,6 +8,9 @@ Diagnose broken MCP (Model Context Protocol) server configs before they break yo
|
|
|
8
8
|
|
|
9
9
|
`mcp-medic` validates MCP server configurations, executes full protocol initialization handshakes across stdio/SSE/HTTP transports, checks all exposed tool JSON schemas against standard specifications, and simulates sample calls — providing actionable suggestions and CI-ready exit codes.
|
|
10
10
|
|
|
11
|
+
> [!NOTE]
|
|
12
|
+
> **Naming & Installation**: The npm package for this tool is **`mcp-medic`** (`npx mcp-medic` / `npm i -g mcp-medic`). While this GitHub repository is named `mcp-doctor`, an unrelated older package already occupies the npm name `mcp-doctor` (different author). Users who want this tool must install **`mcp-medic`**, not `mcp-doctor`.
|
|
13
|
+
|
|
11
14
|
## Why this exists
|
|
12
15
|
|
|
13
16
|
A broken MCP server config usually doesn't fail loudly — it fails as your agent silently missing a tool, retrying a handshake forever, or getting a malformed schema it can't reason about. Those bugs are miserable to track down after the fact. `mcp-medic` catches them at the config level, before an agent ever touches the server: it actually connects (real `initialize` handshake, real `tools/list`), so "the config parses" and "the server actually works" are checked together, in CI, with a real exit code.
|
|
@@ -43,6 +46,8 @@ This is the whole point (a real handshake, not a schema guess) — but it means
|
|
|
43
46
|
|
|
44
47
|
## Quick Start
|
|
45
48
|
|
|
49
|
+
> **Preferred invocation**: Run `npx mcp-medic` (the npm package is `mcp-medic`, not `mcp-doctor`).
|
|
50
|
+
|
|
46
51
|
```bash
|
|
47
52
|
# Run against auto-discovered configs in current project / Claude Desktop
|
|
48
53
|
npx mcp-medic
|
|
@@ -195,6 +200,7 @@ The `security.*` checks are heuristic — they pattern-match on what a server *d
|
|
|
195
200
|
- **`security.*` checks are heuristic pattern-matching**, not a security audit — see the note above. They can both miss real issues and flag benign configs (e.g. a legitimate local dev server on plain `http://`).
|
|
196
201
|
- **Fleet commands (`check-all`, `diff`) are newer and less battle-tested** than `check`/`watch` — the core check pipeline they're built on is the same, but edge cases in glob matching or drift diffing are more likely.
|
|
197
202
|
- **The VS Code extension and community check packages are not shipped/published** — see the sections above.
|
|
203
|
+
- **npm README sync**: Latest docs live on GitHub main; npm README updates on the next publish.
|
|
198
204
|
- **First run via `npx`** pays a one-time cost to resolve and download the package; once installed (or on a warm npx cache), `--help`/`--version` return in well under 100ms.
|
|
199
205
|
|
|
200
206
|
---
|
|
@@ -205,6 +211,11 @@ The `security.*` checks are heuristic — they pattern-match on what a server *d
|
|
|
205
211
|
- 📋 See [CONTRIBUTING.md](./CONTRIBUTING.md) before opening a PR
|
|
206
212
|
- 📝 [CHANGELOG](./CHANGELOG.md)
|
|
207
213
|
|
|
214
|
+
> [!NOTE]
|
|
215
|
+
> **Repository Metadata (GitHub Settings)**: The GitHub repository About description and topics must be configured directly in repository settings (cannot be set from repository files):
|
|
216
|
+
> - **Description**: `Diagnose broken MCP server configs before they break your agent. npm: mcp-medic`
|
|
217
|
+
> - **Topics**: `mcp`, `model-context-protocol`, `cli`, `diagnostics`, `linter`, `claude`, `vscode`, `security`, `ci`
|
|
218
|
+
|
|
208
219
|
## Governance, Stability & Security
|
|
209
220
|
|
|
210
221
|
- 🏛️ [Governance & Project Sustainability](./GOVERNANCE.md)
|