@dean0x/showme
Advanced tools
+1
-1
| { | ||
| "name": "@dean0x/showme", | ||
| "version": "0.2.0", | ||
| "version": "0.2.1", | ||
| "description": "MCP server providing ShowFile and ShowDiff tools for VS Code integration with syntax highlighting", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.js", |
+21
-63
@@ -30,4 +30,4 @@ # ShowMe MCP Server | ||
| |------|---------|---------| | ||
| | `ShowFile` | Opens file(s) in VS Code | `ShowFile({ path: "README.md" })` | | ||
| | `ShowDiff` | Opens git diff in VS Code | `ShowDiff({ base: "main" })` | | ||
| | `ShowFile` | Opens file(s) in VS Code | `ShowFile({ files: ["README.md"] })` | | ||
| | `ShowDiff` | Shows changes since last commit | `ShowDiff({ files: ["src/index.ts"] })` | | ||
@@ -80,5 +80,4 @@ ## Installation | ||
| **Parameters:** | ||
| - `path` (string, optional) - Single file path relative to workspace | ||
| - `paths` (string[], optional) - Multiple file paths to open as tabs | ||
| - `line_highlight` (number, optional) - Line number to jump to (single file only) | ||
| - `files` (string[], required) - Files to open in VS Code | ||
| - `line` (number, optional) - Line number to jump to (only applies to first file) | ||
@@ -88,58 +87,33 @@ **Examples:** | ||
| // Single file | ||
| await ShowFile({ path: "src/index.ts" }) | ||
| await ShowFile({ files: ["src/index.ts"] }) | ||
| // Single file with line highlight | ||
| await ShowFile({ path: "src/utils.ts", line_highlight: 42 }) | ||
| // Single file with line number | ||
| await ShowFile({ files: ["src/utils.ts"], line: 42 }) | ||
| // Multiple files | ||
| await ShowFile({ paths: ["src/index.ts", "package.json", "README.md"] }) | ||
| // Multiple files as tabs | ||
| await ShowFile({ files: ["src/index.ts", "package.json", "README.md"] }) | ||
| ``` | ||
| ### `ShowDiff` | ||
| Display git diffs with rich visualization. | ||
| Display git diffs showing all changes since the last commit (HEAD vs working directory). | ||
| **Parameters:** | ||
| - `base` (string, optional) - Base commit, branch, or tag | ||
| - `target` (string, optional) - Target commit, branch, or tag | ||
| - `files` (string[], optional) - Specific files to include in diff | ||
| - `staged` (boolean, optional) - Show only staged changes | ||
| - `unstaged` (boolean, optional) - Show only unstaged changes | ||
| - `files` (string[], optional) - Specific files to show diff for. If not provided, shows all changed files. | ||
| **Examples:** | ||
| ```typescript | ||
| // Working directory changes | ||
| // Show all changes since last commit | ||
| await ShowDiff({}) | ||
| // Compare with branch | ||
| await ShowDiff({ base: "main" }) | ||
| // Show changes for specific file | ||
| await ShowDiff({ files: ["src/index.ts"] }) | ||
| // Compare commits | ||
| await ShowDiff({ base: "HEAD~2", target: "HEAD" }) | ||
| // Single file diff (side-by-side view) | ||
| await ShowDiff({ | ||
| base: "HEAD~1", | ||
| target: "HEAD", | ||
| files: ["src/index.ts"] | ||
| }) | ||
| // Multiple file diffs (opens each in separate tab) | ||
| await ShowDiff({ | ||
| base: "main", | ||
| // Show changes for multiple files (opens each in separate tab) | ||
| await ShowDiff({ | ||
| files: ["src/index.ts", "package.json", "README.md"] | ||
| }) | ||
| ``` | ||
| // Show only staged changes | ||
| await ShowDiff({ staged: true }) | ||
| **Note:** ShowDiff always compares HEAD to the working directory, showing all uncommitted changes (both staged and unstaged). | ||
| // Show only unstaged changes | ||
| await ShowDiff({ unstaged: true }) | ||
| // Staged changes for specific files | ||
| await ShowDiff({ | ||
| staged: true, | ||
| files: ["src/index.ts", "package.json"] | ||
| }) | ||
| ``` | ||
| ## CLI Usage (Testing) | ||
@@ -165,13 +139,5 @@ | ||
| ```bash | ||
| # Show working directory changes | ||
| # Show all changes since last commit | ||
| showme diff | ||
| # Show diff from specific branch | ||
| showme diff --base main | ||
| showme diff -b feature-branch | ||
| # Compare two commits/branches | ||
| showme diff --base HEAD~1 --target HEAD | ||
| showme diff -b v1.0.0 -t v1.1.0 | ||
| # Show diff for specific files | ||
@@ -181,12 +147,4 @@ showme diff --files src/index.ts src/utils.ts | ||
| # Show only staged changes | ||
| showme diff --staged | ||
| showme diff -s | ||
| # Show only unstaged changes | ||
| showme diff --unstaged | ||
| showme diff -u | ||
| # Staged changes for specific files | ||
| showme diff --staged -f src/index.ts README.md | ||
| # Show diff for multiple files | ||
| showme diff -f src/index.ts README.md package.json | ||
| ``` | ||
@@ -193,0 +151,0 @@ |
113871
-0.72%277
-13.17%