Skip to content

docs: add Windows cmd /c npx workaround to server READMEs #3466

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
r266-tech wants to merge 1 commit into from
Closed

docs: add Windows cmd /c npx workaround to server READMEs #3466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions src/everything/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,23 @@ Add to your `claude_desktop_config.json`:
}
```

> **Windows users:** On Windows, `npx` is a `.cmd` batch file shim that cannot be executed directly by `child_process.spawn()`. Use `cmd /c` as the command instead:
>
> ```json
> {
> "mcpServers": {
> "everything": {
> "command": "cmd",
> "args": [
> "/c", "npx",
> "-y",
> "@modelcontextprotocol/server-everything"
> ]
> }
> }
> }
> ```

## Usage with VS Code

For quick installation, use of of the one-click install buttons below...
Expand Down Expand Up @@ -62,6 +79,23 @@ Alternatively, you can add the configuration to a file called `.vscode/mcp.json`
}
```

> **Windows users:** On Windows, `npx` is a `.cmd` batch file shim that cannot be executed directly by `child_process.spawn()`. Use `cmd /c` as the command instead:
>
> ```json
> {
> "servers": {
> "everything": {
> "command": "cmd",
> "args": [
> "/c", "npx",
> "-y",
> "@modelcontextprotocol/server-everything"
> ]
> }
> }
> }
> ```

## Running from source with [HTTP+SSE Transport](https://modelcontextprotocol.io/specification/2024-11-05/basic/transports#http-with-sse) (deprecated as of [2025-03-26](https://modelcontextprotocol.io/specification/2025-03-26/basic/transports))

```shell
Expand Down
37 changes: 37 additions & 0 deletions src/filesystem/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,25 @@ Note: all directories must be mounted to `/projects` by default.
}
```

> **Windows users:** On Windows, `npx` is a `.cmd` batch file shim that cannot be executed directly by `child_process.spawn()`. Use `cmd /c` as the command instead:
>
> ```json
> {
> "mcpServers": {
> "filesystem": {
> "command": "cmd",
> "args": [
> "/c", "npx",
> "-y",
> "@modelcontextprotocol/server-filesystem",
> "C:\\Users\\username\\Desktop",
> "C:\\path\\to\\other\\allowed\\dir"
> ]
> }
> }
> }
> ```

## Usage with VS Code

For quick installation, click the installation buttons below...
Expand Down Expand Up @@ -308,6 +327,24 @@ Note: all directories must be mounted to `/projects` by default.
}
```

> **Windows users:** On Windows, `npx` is a `.cmd` batch file shim that cannot be executed directly by `child_process.spawn()`. Use `cmd /c` as the command instead:
>
> ```json
> {
> "servers": {
> "filesystem": {
> "command": "cmd",
> "args": [
> "/c", "npx",
> "-y",
> "@modelcontextprotocol/server-filesystem",
> "${workspaceFolder}"
> ]
> }
> }
> }
> ```

## Build

Docker build:
Expand Down
54 changes: 54 additions & 0 deletions src/memory/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,23 @@ Add this to your claude_desktop_config.json:
}
```

> **Windows users:** On Windows, `npx` is a `.cmd` batch file shim that cannot be executed directly by `child_process.spawn()`. Use `cmd /c` as the command instead:
>
> ```json
> {
> "mcpServers": {
> "memory": {
> "command": "cmd",
> "args": [
> "/c", "npx",
> "-y",
> "@modelcontextprotocol/server-memory"
> ]
> }
> }
> }
> ```

#### NPX with custom setting

The server can be configured using the following environment variables:
Expand All @@ -180,6 +197,26 @@ The server can be configured using the following environment variables:
}
```

> **Windows users:** On Windows, `npx` is a `.cmd` batch file shim that cannot be executed directly by `child_process.spawn()`. Use `cmd /c` as the command instead:
>
> ```json
> {
> "mcpServers": {
> "memory": {
> "command": "cmd",
> "args": [
> "/c", "npx",
> "-y",
> "@modelcontextprotocol/server-memory"
> ],
> "env": {
> "MEMORY_FILE_PATH": "C:\\path\\to\\custom\\memory.jsonl"
> }
> }
> }
> }
> ```

- `MEMORY_FILE_PATH`: Path to the memory storage JSONL file (default: `memory.jsonl` in the server directory)

# VS Code Installation Instructions
Expand Down Expand Up @@ -216,6 +253,23 @@ Alternatively, you can add the configuration to a file called `.vscode/mcp.json`
}
```

> **Windows users:** On Windows, `npx` is a `.cmd` batch file shim that cannot be executed directly by `child_process.spawn()`. Use `cmd /c` as the command instead:
>
> ```json
> {
> "servers": {
> "memory": {
> "command": "cmd",
> "args": [
> "/c", "npx",
> "-y",
> "@modelcontextprotocol/server-memory"
> ]
> }
> }
> }
> ```

#### Docker

```json
Expand Down
34 changes: 34 additions & 0 deletions src/sequentialthinking/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,23 @@ Add this to your `claude_desktop_config.json`:
}
```

> **Windows users:** On Windows, `npx` is a `.cmd` batch file shim that cannot be executed directly by `child_process.spawn()`. Use `cmd /c` as the command instead:
>
> ```json
> {
> "mcpServers": {
> "sequential-thinking": {
> "command": "cmd",
> "args": [
> "/c", "npx",
> "-y",
> "@modelcontextprotocol/server-sequential-thinking"
> ]
> }
> }
> }
> ```

#### docker

```json
Expand Down Expand Up @@ -114,6 +131,23 @@ For NPX installation:
}
```

> **Windows users:** On Windows, `npx` is a `.cmd` batch file shim that cannot be executed directly by `child_process.spawn()`. Use `cmd /c` as the command instead:
>
> ```json
> {
> "servers": {
> "sequential-thinking": {
> "command": "cmd",
> "args": [
> "/c", "npx",
> "-y",
> "@modelcontextprotocol/server-sequential-thinking"
> ]
> }
> }
> }
> ```

For Docker installation:

```json
Expand Down