Skip to content

Commit 4950c7f

Browse files
yotsudaclaude
andcommitted
Simplify README setup with Register-Pwsh* cmdlets, fix tool name and gitignore
- Replace manual MCP config instructions with Register-PwshToClaudeCode/Desktop - Add "For other MCP clients" guidance using Get-MCPProxyPath -Escape - Fix architecture table: start_powershell_console → start_console - Add PlatyPS help XML to gitignore Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 013f440 commit 4950c7f

2 files changed

Lines changed: 25 additions & 45 deletions

File tree

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -444,8 +444,9 @@ Tests/test*.ps1
444444
Tests/Temp*.ps1
445445
deployRelease.bat
446446

447-
# PlatyPS auto-generated module help file
447+
# PlatyPS auto-generated files
448448
PowerShell.MCP/PlatyPS/en-US/PowerShell.MCP.md
449+
PowerShell.MCP/PlatyPS/en-US/*.xml
449450

450451
slack*.txt
451452

README.md

Lines changed: 23 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Four tools provide maximum flexibility with minimum complexity:
108108

109109
| Tool | Purpose |
110110
|------|---------|
111-
| `start_powershell_console` | Launch a persistent console for the MCP client |
111+
| `start_console` | Launch a persistent console for the MCP client |
112112
| `get_current_location` | Get current directory and available drives |
113113
| `invoke_expression` | Execute any PowerShell command or CLI tool |
114114
| `wait_for_completion` | Wait for long-running commands to complete |
@@ -144,25 +144,16 @@ Install-PSResource PowerShell.MCP
144144

145145
**For Claude Code:**
146146
```powershell
147-
# Run in PowerShell (pwsh)
148-
claude mcp add PowerShell -s user -- "$(Get-MCPProxyPath)"
147+
Register-PwshToClaudeCode
149148
```
150149

151-
**For Claude Desktop** — Edit `%APPDATA%\Claude\claude_desktop_config.json`:
150+
**For Claude Desktop:**
152151
```powershell
153-
# Run in PowerShell (pwsh)
154-
Get-MCPProxyPath -Escape # Example output: C:\\Users\\YourName\\...\\PowerShell.MCP\\...\\PowerShell.MCP.Proxy.exe
155-
```
156-
Paste the output into `claude_desktop_config.json` (replace the example path below with your actual output):
157-
```json
158-
{
159-
"mcpServers": {
160-
"PowerShell": {
161-
"command": "C:\\Users\\YourName\\...\\PowerShell.MCP\\...\\PowerShell.MCP.Proxy.exe"
162-
}
163-
}
164-
}
152+
Register-PwshToClaudeDesktop
165153
```
154+
155+
**For other MCP clients:** Run `Get-MCPProxyPath -Escape` to get the JSON-escaped executable path, then add it to your client's configuration file manually.
156+
166157
#### 4. Restart your MCP client
167158

168159
</details>
@@ -184,30 +175,24 @@ sudo apt-get install -y powershell
184175

185176
#### 2. Install PowerShell.MCP, set permissions, and configure your MCP client
186177

187-
**For Claude Code:**
188178
```powershell
189179
# Run in PowerShell (pwsh)
190180
Install-PSResource PowerShell.MCP
191181
chmod +x "$(Get-MCPProxyPath)"
192-
claude mcp add PowerShell -s user -- "$(Get-MCPProxyPath)"
193182
```
194183

195-
**For Claude Desktop** — Edit `~/.config/Claude/claude_desktop_config.json`:
184+
**For Claude Code:**
196185
```powershell
197-
# Run in PowerShell (pwsh)
198-
Get-MCPProxyPath -Escape # Example output: /home/YourName/.../PowerShell.MCP/.../PowerShell.MCP.Proxy
186+
Register-PwshToClaudeCode
199187
```
200-
Paste the output into `claude_desktop_config.json` (replace the example path below with your actual output):
201-
```json
202-
{
203-
"mcpServers": {
204-
"PowerShell": {
205-
"command": "/home/YourName/.../PowerShell.MCP/.../PowerShell.MCP.Proxy"
206-
}
207-
}
208-
}
188+
189+
**For Claude Desktop:**
190+
```powershell
191+
Register-PwshToClaudeDesktop
209192
```
210193

194+
**For other MCP clients:** Run `Get-MCPProxyPath -Escape` to get the JSON-escaped executable path, then add it to your client's configuration file manually.
195+
211196
#### 3. Restart your MCP client
212197

213198
</details>
@@ -228,30 +213,24 @@ brew install --cask powershell
228213

229214
#### 2. Install PowerShell.MCP, set permissions, and configure your MCP client
230215

231-
**For Claude Code:**
232216
```powershell
233217
# Run in PowerShell (pwsh)
234218
Install-PSResource PowerShell.MCP
235219
chmod +x "$(Get-MCPProxyPath)"
236-
claude mcp add PowerShell -s user -- "$(Get-MCPProxyPath)"
237220
```
238221

239-
**For Claude Desktop** — Edit `~/Library/Application Support/Claude/claude_desktop_config.json`:
222+
**For Claude Code:**
240223
```powershell
241-
# Run in PowerShell (pwsh)
242-
Get-MCPProxyPath -Escape # Example output: /Users/YourName/.../PowerShell.MCP/.../PowerShell.MCP.Proxy
224+
Register-PwshToClaudeCode
243225
```
244-
Paste the output into `claude_desktop_config.json` (replace the example path below with your actual output):
245-
```json
246-
{
247-
"mcpServers": {
248-
"PowerShell": {
249-
"command": "/Users/YourName/.../PowerShell.MCP/.../PowerShell.MCP.Proxy"
250-
}
251-
}
252-
}
226+
227+
**For Claude Desktop:**
228+
```powershell
229+
Register-PwshToClaudeDesktop
253230
```
254231

232+
**For other MCP clients:** Run `Get-MCPProxyPath -Escape` to get the JSON-escaped executable path, then add it to your client's configuration file manually.
233+
255234
#### 3. Restart your MCP client
256235

257236
</details>

0 commit comments

Comments
 (0)