mirror of
https://github.com/modelcontextprotocol/servers.git
synced 2026-04-24 06:45:21 +02:00
docs: add Windows npx wrapper examples
This commit is contained in:
15
README.md
15
README.md
@@ -1600,6 +1600,19 @@ However, running a server on its own isn't very useful, and should instead be co
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
On Windows, wrap `npx` with `cmd /c`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"memory": {
|
||||||
|
"command": "cmd",
|
||||||
|
"args": ["/c", "npx", "-y", "@modelcontextprotocol/server-memory"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
Additional examples of using the Claude Desktop as an MCP client might look like:
|
Additional examples of using the Claude Desktop as an MCP client might look like:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
@@ -1628,6 +1641,8 @@ Additional examples of using the Claude Desktop as an MCP client might look like
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
On Windows, apply the same wrapper to each `npx`-based entry above by changing `"command"` to `"cmd"` and prepending `"/c", "npx"` to the existing `args`. Leave `uvx` entries unchanged.
|
||||||
|
|
||||||
## 🛠️ Creating Your Own Server
|
## 🛠️ Creating Your Own Server
|
||||||
|
|
||||||
Interested in creating your own MCP server? Visit the official documentation at [modelcontextprotocol.io](https://modelcontextprotocol.io/introduction) for comprehensive guides, best practices, and technical details on implementing MCP servers.
|
Interested in creating your own MCP server? Visit the official documentation at [modelcontextprotocol.io](https://modelcontextprotocol.io/introduction) for comprehensive guides, best practices, and technical details on implementing MCP servers.
|
||||||
|
|||||||
@@ -31,6 +31,24 @@ Add to your `claude_desktop_config.json`:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
On Windows, use `cmd /c` to launch `npx`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"everything": {
|
||||||
|
"command": "cmd",
|
||||||
|
"args": [
|
||||||
|
"/c",
|
||||||
|
"npx",
|
||||||
|
"-y",
|
||||||
|
"@modelcontextprotocol/server-everything"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## Usage with VS Code
|
## Usage with VS Code
|
||||||
|
|
||||||
For quick installation, use of of the one-click install buttons below...
|
For quick installation, use of of the one-click install buttons below...
|
||||||
@@ -62,6 +80,19 @@ Alternatively, you can add the configuration to a file called `.vscode/mcp.json`
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
On Windows, use:
|
||||||
|
|
||||||
|
```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))
|
## 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
|
```shell
|
||||||
@@ -103,4 +134,3 @@ npx @modelcontextprotocol/server-everything sse
|
|||||||
```shell
|
```shell
|
||||||
npx @modelcontextprotocol/server-everything streamableHttp
|
npx @modelcontextprotocol/server-everything streamableHttp
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -250,6 +250,26 @@ Note: all directories must be mounted to `/projects` by default.
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
On Windows, use `cmd /c` to launch `npx`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"filesystem": {
|
||||||
|
"command": "cmd",
|
||||||
|
"args": [
|
||||||
|
"/c",
|
||||||
|
"npx",
|
||||||
|
"-y",
|
||||||
|
"@modelcontextprotocol/server-filesystem",
|
||||||
|
"/Users/username/Desktop",
|
||||||
|
"/path/to/other/allowed/dir"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## Usage with VS Code
|
## Usage with VS Code
|
||||||
|
|
||||||
For quick installation, click the installation buttons below...
|
For quick installation, click the installation buttons below...
|
||||||
@@ -308,6 +328,25 @@ Note: all directories must be mounted to `/projects` by default.
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
On Windows, use:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"servers": {
|
||||||
|
"filesystem": {
|
||||||
|
"command": "cmd",
|
||||||
|
"args": [
|
||||||
|
"/c",
|
||||||
|
"npx",
|
||||||
|
"-y",
|
||||||
|
"@modelcontextprotocol/server-filesystem",
|
||||||
|
"${workspaceFolder}"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## Build
|
## Build
|
||||||
|
|
||||||
Docker build:
|
Docker build:
|
||||||
|
|||||||
@@ -159,6 +159,24 @@ Add this to your claude_desktop_config.json:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
On Windows, use `cmd /c` to launch `npx`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"memory": {
|
||||||
|
"command": "cmd",
|
||||||
|
"args": [
|
||||||
|
"/c",
|
||||||
|
"npx",
|
||||||
|
"-y",
|
||||||
|
"@modelcontextprotocol/server-memory"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
#### NPX with custom setting
|
#### NPX with custom setting
|
||||||
|
|
||||||
The server can be configured using the following environment variables:
|
The server can be configured using the following environment variables:
|
||||||
@@ -180,6 +198,27 @@ The server can be configured using the following environment variables:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
On Windows, use:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"memory": {
|
||||||
|
"command": "cmd",
|
||||||
|
"args": [
|
||||||
|
"/c",
|
||||||
|
"npx",
|
||||||
|
"-y",
|
||||||
|
"@modelcontextprotocol/server-memory"
|
||||||
|
],
|
||||||
|
"env": {
|
||||||
|
"MEMORY_FILE_PATH": "/path/to/custom/memory.jsonl"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
- `MEMORY_FILE_PATH`: Path to the memory storage JSONL file (default: `memory.jsonl` in the server directory)
|
- `MEMORY_FILE_PATH`: Path to the memory storage JSONL file (default: `memory.jsonl` in the server directory)
|
||||||
|
|
||||||
# VS Code Installation Instructions
|
# VS Code Installation Instructions
|
||||||
@@ -216,6 +255,24 @@ Alternatively, you can add the configuration to a file called `.vscode/mcp.json`
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
On Windows, use:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"servers": {
|
||||||
|
"memory": {
|
||||||
|
"command": "cmd",
|
||||||
|
"args": [
|
||||||
|
"/c",
|
||||||
|
"npx",
|
||||||
|
"-y",
|
||||||
|
"@modelcontextprotocol/server-memory"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
#### Docker
|
#### Docker
|
||||||
|
|
||||||
```json
|
```json
|
||||||
|
|||||||
@@ -59,6 +59,24 @@ Add this to your `claude_desktop_config.json`:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
On Windows, use `cmd /c` to launch `npx`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"sequential-thinking": {
|
||||||
|
"command": "cmd",
|
||||||
|
"args": [
|
||||||
|
"/c",
|
||||||
|
"npx",
|
||||||
|
"-y",
|
||||||
|
"@modelcontextprotocol/server-sequential-thinking"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
#### docker
|
#### docker
|
||||||
|
|
||||||
```json
|
```json
|
||||||
@@ -114,6 +132,24 @@ For NPX installation:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
On Windows, use:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"servers": {
|
||||||
|
"sequential-thinking": {
|
||||||
|
"command": "cmd",
|
||||||
|
"args": [
|
||||||
|
"/c",
|
||||||
|
"npx",
|
||||||
|
"-y",
|
||||||
|
"@modelcontextprotocol/server-sequential-thinking"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
For Docker installation:
|
For Docker installation:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
|
|||||||
Reference in New Issue
Block a user