@raeseoklee/mcp-workbench 0.1.0 → 0.1.1

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.
Files changed (2) hide show
  1. package/README.md +57 -0
  2. package/package.json +3 -2
package/README.md ADDED
@@ -0,0 +1,57 @@
1
+ # MCP Workbench
2
+
3
+ **A quality platform for MCP server developers.**
4
+
5
+ Test, inspect, and validate [Model Context Protocol](https://modelcontextprotocol.io) servers — from the command line or in CI.
6
+
7
+ ## Install
8
+
9
+ ```bash
10
+ # Preferred
11
+ npm install -g @raeseoklee/mcp-workbench
12
+
13
+ # Alternative convenience package
14
+ npm install -g mcp-workbench-cli
15
+ ```
16
+
17
+ Both provide the same `mcp-workbench` command.
18
+
19
+ > **Why not `npm install -g mcp-workbench`?**
20
+ > The unscoped name is taken by an unrelated project. See [npm distribution docs](https://github.com/raeseoklee/mcp-workbench/blob/develop/docs/npm-distribution.md) for details.
21
+
22
+ ## Usage
23
+
24
+ ```bash
25
+ # Inspect a server
26
+ mcp-workbench inspect --command node --args "path/to/server.js"
27
+
28
+ # Run a test suite
29
+ mcp-workbench run tests.yaml --verbose
30
+
31
+ # JSON output for CI
32
+ mcp-workbench run tests.yaml --json
33
+ ```
34
+
35
+ ## Features
36
+
37
+ - **`mcp-workbench inspect`** — connect to any MCP server and explore capabilities, tools, resources, and prompts
38
+ - **`mcp-workbench run`** — execute YAML-defined test suites with rich assertions
39
+ - **Assertion engine** — `status`, `jsonpath`, `executionError`, `protocolError`, `contentType`, `count`, `equals`, `schema`, `snapshot`, and more
40
+ - **Transport support** — `stdio`, `streamable-http`, legacy SSE
41
+ - **Client simulator** — inject roots, sampling presets, and elicitation handlers
42
+ - **CI-friendly** — `--json` output, non-zero exit on failure, `--bail` flag
43
+ - **Plugin system** — extend with reporters (`html`, `junit`) and custom commands
44
+
45
+ ## VS Code Extension
46
+
47
+ Install the [MCP Workbench VS Code extension](https://marketplace.visualstudio.com/items?itemName=raeseoklee.mcp-workbench-vscode) for integrated testing and inspection.
48
+
49
+ ## Links
50
+
51
+ - [GitHub](https://github.com/raeseoklee/mcp-workbench)
52
+ - [Full documentation](https://github.com/raeseoklee/mcp-workbench#readme)
53
+ - [VS Code Extension](https://marketplace.visualstudio.com/items?itemName=raeseoklee.mcp-workbench-vscode)
54
+
55
+ ## License
56
+
57
+ [Apache-2.0](https://github.com/raeseoklee/mcp-workbench/blob/develop/LICENSE)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@raeseoklee/mcp-workbench",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "MCP Workbench — test, inspect, and validate MCP servers",
5
5
  "type": "module",
6
6
  "keywords": [
@@ -32,7 +32,8 @@
32
32
  },
33
33
  "main": "./dist/index.js",
34
34
  "files": [
35
- "dist"
35
+ "dist",
36
+ "README.md"
36
37
  ],
37
38
  "scripts": {
38
39
  "build": "node build.mjs",