proofscan 0.1.0 → 0.1.1

package/README.md

@@ -14,27 +14,29 @@ proofscan provides visibility into MCP (Model Context Protocol) server communica
 ## Installation
 
 ```bash
-npm install
-npm run build
-npm link  # Makes 'proofscan' available globally
+npm install -g proofscan
 ```
 
-Or run directly:
+Or run without installing:
 
 ```bash
-node dist/cli.js --help
+npx proofscan --help
 ```
 
+## CLI Commands
+
+The CLI is available as both `pfscan` (short) and `proofscan` (full).
+
 ## Quickstart
 
 ### 1. Initialize Configuration
 
 ```bash
 # Create config in OS-standard location
-proofscan config init
+pfscan config init
 
 # Check where config is stored
-proofscan config path
+pfscan config path
 ```
 
 ### 2. Import MCP Server from mcp.so / Claude Desktop
@@ -43,31 +45,31 @@ Copy the `mcpServers` JSON from mcp.so or Claude Desktop settings and import via
 
 ```bash
 # Full mcpServers format
-echo '{ "mcpServers": { "time": { "command": "uvx", "args": ["mcp-server-time"] } } }' | proofscan connectors import --from mcpServers --stdin
+echo '{ "mcpServers": { "time": { "command": "uvx", "args": ["mcp-server-time"] } } }' | pfscan connectors import --from mcpServers --stdin
 
 # Or just the server definition (requires --name)
-echo '{ "command": "uvx", "args": ["mcp-server-time"] }' | proofscan connectors import --from mcpServers --stdin --name time
+echo '{ "command": "uvx", "args": ["mcp-server-time"] }' | pfscan connectors import --from mcpServers --stdin --name time
 
 # Import from file
-proofscan connectors import --from mcpServers --file ./servers.json
+pfscan connectors import --from mcpServers --file ./servers.json
 ```
 
 ### 3. List Connectors
 
 ```bash
-proofscan connectors list
+pfscan connectors list
 ```
 
 ### 4. Scan a Connector
 
 ```bash
-proofscan scan start --id time
+pfscan scan start --id time
 ```
 
 ### 5. View Events
 
 ```bash
-proofscan monitor tail --id time --last 20
+pfscan monitor tail --id time --last 20
 ```
 
 ## Commands
@@ -83,37 +85,37 @@ proofscan monitor tail --id time --last 20
 ### Config
 
 ```bash
-proofscan config path                    # Show config file path
-proofscan config init [--force]          # Initialize config
-proofscan config show                    # Show config (secrets masked)
-proofscan config validate                # Validate config
+pfscan config path                    # Show config file path
+pfscan config init [--force]          # Initialize config
+pfscan config show                    # Show config (secrets masked)
+pfscan config validate                # Validate config
 ```
 
 ### Connectors
 
 ```bash
-proofscan connectors list                        # List all connectors
-proofscan connectors show --id <id>              # Show connector details
-proofscan connectors add --id <id> --stdio "cmd" # Add stdio connector
-proofscan connectors enable --id <id>            # Enable connector
-proofscan connectors disable --id <id>           # Disable connector
-proofscan connectors remove --id <id>            # Remove connector
+pfscan connectors list                        # List all connectors
+pfscan connectors show --id <id>              # Show connector details
+pfscan connectors add --id <id> --stdio "cmd" # Add stdio connector
+pfscan connectors enable --id <id>            # Enable connector
+pfscan connectors disable --id <id>           # Disable connector
+pfscan connectors remove --id <id>            # Remove connector
 
 # Import from mcpServers format
-proofscan connectors import --from mcpServers --stdin
-proofscan connectors import --from mcpServers --file <path> [--name <id>]
+pfscan connectors import --from mcpServers --stdin
+pfscan connectors import --from mcpServers --file <path> [--name <id>]
 ```
 
 ### Scan
 
 ```bash
-proofscan scan start --id <id> [--timeout <sec>]
+pfscan scan start --id <id> [--timeout <sec>]
 ```
 
 ### Monitor
 
 ```bash
-proofscan monitor tail --id <id> [--last <N>]
+pfscan monitor tail --id <id> [--last <N>]
 ```
 
 ## Config File Format
@@ -169,22 +171,22 @@ Each event contains:
 
 ```bash
 # Initialize
-$ proofscan config init
+$ pfscan config init
 ✓ Config created at: /home/user/.config/proofscan/config.json
 
 # Import a server
 $ echo '{"mcpServers":{"time":{"command":"uvx","args":["mcp-server-time"]}}}' \
-  | proofscan connectors import --from mcpServers --stdin
+  | pfscan connectors import --from mcpServers --stdin
 ✓ Imported 1 connector(s): time
 
 # List connectors
-$ proofscan connectors list
+$ pfscan connectors list
 ID    Enabled  Type   Command/URL
 -----------------------------------
 time  yes      stdio  uvx mcp-server-time
 
 # Scan the server
-$ proofscan scan start --id time
+$ pfscan scan start --id time
 Scanning connector: time...
 ✓ Scan successful!
   Connector: time
@@ -193,7 +195,7 @@ Scanning connector: time...
   Events recorded: 8
 
 # View events
-$ proofscan monitor tail --id time --last 5
+$ pfscan monitor tail --id time --last 5
 Recent events for 'time' (last 5):
 
 Time     Dir Status Kind         Summary
@@ -210,7 +212,7 @@ Time     Dir Status Kind         Summary
 Add `--json` for machine-readable output:
 
 ```bash
-$ proofscan connectors list --json
+$ pfscan connectors list --json
 [
   {
     "ID": "time",
@@ -220,7 +222,7 @@ $ proofscan connectors list --json
   }
 ]
 
-$ proofscan scan start --id time --json
+$ pfscan scan start --id time --json
 {
   "success": true,
   "connector_id": "time",
@@ -266,14 +268,14 @@ proofscan accepts several JSON formats for import:
 Failures are always recorded as events. Even if a scan fails, you can inspect what happened:
 
 ```bash
-$ proofscan scan start --id broken-server
+$ pfscan scan start --id broken-server
 Scanning connector: broken-server...
 ✗ Scan failed!
   Connector: broken-server
   Error: Initialize failed: Request timeout for method: initialize
   Events recorded: 3
 
-$ proofscan monitor tail --id broken-server --last 5
+$ pfscan monitor tail --id broken-server --last 5
 Time     Dir Status Kind         Summary
 ----------------------------------------------------------------------
 10:35:01 →   transport    [connect_attempt]

package/dist/cli.js

@@ -14,9 +14,9 @@ function getConfigPath() {
     return resolveConfigPath({ configPath: globalConfigPath });
 }
 program
-    .name('proofscan')
+    .name('pfscan')
     .description('MCP Server scanner - eliminate black boxes by capturing JSON-RPC from connection to tools/list')
-    .version('0.1.0')
+    .version('0.1.1')
     .option('-c, --config <path>', 'Path to config file')
     .option('--json', 'Output in JSON format')
     .option('-v, --verbose', 'Verbose output')

package/dist/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA;;;GAGG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EACL,mBAAmB,EACnB,uBAAuB,EACvB,iBAAiB,EACjB,oBAAoB,GACrB,MAAM,qBAAqB,CAAC;AAE7B,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,+BAA+B;AAC/B,IAAI,gBAAoC,CAAC;AAEzC,SAAS,aAAa;IACpB,OAAO,iBAAiB,CAAC,EAAE,UAAU,EAAE,gBAAgB,EAAE,CAAC,CAAC;AAC7D,CAAC;AAED,OAAO;KACJ,IAAI,CAAC,WAAW,CAAC;KACjB,WAAW,CAAC,gGAAgG,CAAC;KAC7G,OAAO,CAAC,OAAO,CAAC;KAChB,MAAM,CAAC,qBAAqB,EAAE,qBAAqB,CAAC;KACpD,MAAM,CAAC,QAAQ,EAAE,uBAAuB,CAAC;KACzC,MAAM,CAAC,eAAe,EAAE,gBAAgB,CAAC;KACzC,IAAI,CAAC,WAAW,EAAE,CAAC,WAAW,EAAE,EAAE;IACjC,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC;IAChC,gBAAgB,GAAG,IAAI,CAAC,MAAM,CAAC;IAC/B,gBAAgB,CAAC;QACf,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,OAAO,EAAE,IAAI,CAAC,OAAO;KACtB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEL,kBAAkB;AAClB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC,CAAC;AACvD,OAAO,CAAC,UAAU,CAAC,uBAAuB,CAAC,aAAa,CAAC,CAAC,CAAC;AAC3D,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC;AACrD,OAAO,CAAC,UAAU,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC,CAAC;AAExD,gBAAgB;AAChB,OAAO,CAAC,KAAK,EAAE,CAAC"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA;;;GAGG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EACL,mBAAmB,EACnB,uBAAuB,EACvB,iBAAiB,EACjB,oBAAoB,GACrB,MAAM,qBAAqB,CAAC;AAE7B,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,+BAA+B;AAC/B,IAAI,gBAAoC,CAAC;AAEzC,SAAS,aAAa;IACpB,OAAO,iBAAiB,CAAC,EAAE,UAAU,EAAE,gBAAgB,EAAE,CAAC,CAAC;AAC7D,CAAC;AAED,OAAO;KACJ,IAAI,CAAC,QAAQ,CAAC;KACd,WAAW,CAAC,gGAAgG,CAAC;KAC7G,OAAO,CAAC,OAAO,CAAC;KAChB,MAAM,CAAC,qBAAqB,EAAE,qBAAqB,CAAC;KACpD,MAAM,CAAC,QAAQ,EAAE,uBAAuB,CAAC;KACzC,MAAM,CAAC,eAAe,EAAE,gBAAgB,CAAC;KACzC,IAAI,CAAC,WAAW,EAAE,CAAC,WAAW,EAAE,EAAE;IACjC,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC;IAChC,gBAAgB,GAAG,IAAI,CAAC,MAAM,CAAC;IAC/B,gBAAgB,CAAC;QACf,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,OAAO,EAAE,IAAI,CAAC,OAAO;KACtB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEL,kBAAkB;AAClB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC,CAAC;AACvD,OAAO,CAAC,UAAU,CAAC,uBAAuB,CAAC,aAAa,CAAC,CAAC,CAAC;AAC3D,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC;AACrD,OAAO,CAAC,UAAU,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC,CAAC;AAExD,gBAAgB;AAChB,OAAO,CAAC,KAAK,EAAE,CAAC"}

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "proofscan",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "MCP Server scanner - eliminate black boxes by capturing JSON-RPC from connection to tools/list",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": {
-    "proofscan": "./dist/cli.js"
+    "proofscan": "./dist/cli.js",
+    "pfscan": "./dist/cli.js"
   },
   "files": [
     "dist",