en-US/PowerShell.MCP-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" schema="maml" xmlns="http://msh"> <command:command> <command:details> <command:name>Get-MCPOwner</command:name> <maml:description> <maml:para>Gets information about the MCP client that owns this console.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>MCPOwner</command:noun> </command:details> <maml:description> <maml:para>Returns ownership information for the current PowerShell console, including whether it is owned by an MCP proxy, the proxy's PID, the agent ID, and the client name (e.g., Claude Desktop, Claude Code, VS Code).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-MCPOwner</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <dev:name>PSCustomObject with Owned</dev:name> </dev:type> <maml:description> <maml:para>PSCustomObject with Owned, ProxyPid, AgentId, and ClientName properties.</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <dev:name>System.Management.Automation.PSObject</dev:name> </dev:type> <maml:description> <maml:para>PSCustomObject with Owned, ProxyPid, AgentId, and ClientName properties.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>Get-MCPOwner</maml:para> <maml:para>€</maml:para> <maml:para>Owned : True ProxyPid : 22208 AgentId : cc19706b ClientName : Claude Desktop</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>Get-MCPOwner</maml:para> <maml:para>€</maml:para> <maml:para>Owned : False ProxyPid : AgentId : ClientName :</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-MCPProxyPath</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-PwshToClaudeCode</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-PwshToClaudeDesktop</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AllPwsh</maml:linkText> <command:uri /> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-MCPProxyPath</command:name> <maml:description> <maml:para>Gets the path to the PowerShell.MCP.Proxy executable for the current platform.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>MCPProxyPath</command:noun> </command:details> <maml:description> <maml:para>Returns the full path to the platform-specific PowerShell.MCP.Proxy executable. Use this path in your MCP client configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-MCPProxyPath</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Escape</maml:name> <maml:description> <maml:para>If specified, escapes backslashes for use in JSON configuration files.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Escape</maml:name> <maml:description> <maml:para>If specified, escapes backslashes for use in JSON configuration files.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <dev:name>System.String</dev:name> </dev:type> <maml:description> <maml:para>Full path to the PowerShell.MCP.Proxy executable for the current platform.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>Get-MCPProxyPath Returns: C:\Program Files\PowerShell\7\Modules\PowerShell.MCP\bin\win-x64\PowerShell.MCP.Proxy.exe</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>Get-MCPProxyPath -Escape Returns: C:\\Program Files\\PowerShell\\7\\Modules\\PowerShell.MCP\\bin\\win-x64\\PowerShell.MCP.Proxy.exe</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-MCPOwner</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-PwshToClaudeCode</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-PwshToClaudeDesktop</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AllPwsh</maml:linkText> <command:uri /> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Register-PwshToClaudeCode</command:name> <maml:description> <maml:para>Registers PowerShell.MCP as an MCP server in Claude Code.</maml:para> </maml:description> <command:verb>Register</command:verb> <command:noun>PwshToClaudeCode</command:noun> </command:details> <maml:description> <maml:para>Runs 'claude mcp add pwsh -s user' with the current module's proxy executable path. If a legacy "PowerShell" entry pointing to PowerShell.MCP.Proxy exists, it is removed first.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Register-PwshToClaudeCode</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <dev:name>None. Passes through output from the claude CLI.</dev:name> </dev:type> <maml:description> <maml:para>None.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>Register-PwshToClaudeCode</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-PwshToClaudeDesktop</maml:linkText> <command:uri /> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Register-PwshToClaudeDesktop</command:name> <maml:description> <maml:para>Registers PowerShell.MCP as an MCP server in Claude Desktop.</maml:para> </maml:description> <command:verb>Register</command:verb> <command:noun>PwshToClaudeDesktop</command:noun> </command:details> <maml:description> <maml:para>Adds or updates the 'pwsh' entry in Claude Desktop's claude_desktop_config.json. Existing settings in the file are preserved.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Register-PwshToClaudeDesktop</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <dev:name>System.Object</dev:name> </dev:type> <maml:description> <maml:para>None.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>Registers PowerShell.MCP in Claude Desktop configuration.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-PwshToClaudeCode</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-MCPOwner</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-MCPProxyPath</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-AllPwsh</maml:linkText> <command:uri /> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Stop-AllPwsh</command:name> <maml:description> <maml:para>Stops all pwsh processes to release DLL locks.</maml:para> </maml:description> <command:verb>Stop</command:verb> <command:noun>AllPwsh</command:noun> </command:details> <maml:description> <maml:para>Stops all pwsh processes on the system to release DLL locks. Useful for PowerShell module developers before dotnet build.</maml:para> <maml:para>With -PwshPath: starts a new pwsh session from the specified binary with PowerShell.MCP loaded, then stops all other pwsh processes.</maml:para> <maml:para>WARNING: This stops ALL pwsh processes, including those used by other users or other MCP clients on the same machine.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-AllPwsh</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>PwshPath</maml:name> <maml:description> <maml:para>Path to the pwsh binary to start. If specified, a new session is started from this binary with PowerShell.MCP imported before stopping other processes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Runs the command in a mode that only reports what would happen without performing the actions.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>PwshPath</maml:name> <maml:description> <maml:para>Path to the pwsh binary to start. If specified, a new session is started from this binary with PowerShell.MCP imported before stopping other processes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Runs the command in a mode that only reports what would happen without performing the actions.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1 ---------</maml:title> <maml:introduction> <maml:para>Stop-AllPwsh Stops all pwsh processes. Use before rebuilding a PowerShell module to release DLL locks.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2 ---------</maml:title> <maml:introduction> <maml:para>Stop-AllPwsh -PwshPath (Get-PSOutput) Starts a new session using the built pwsh binary, then stops all other pwsh processes. Use in the PowerShell repository after Start-PSBuild.</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-MCPOwner</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-MCPProxyPath</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-PwshToClaudeCode</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Register-PwshToClaudeDesktop</maml:linkText> <command:uri /> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |