Skip to content

Commit 8f18889

Browse files
committed
Restoring README style and prettier-ignoring it in future
1 parent db92c69 commit 8f18889

File tree

2 files changed

+34
-22
lines changed

2 files changed

+34
-22
lines changed

.prettierignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
pnpm-lock.yaml
1+
pnpm-lock.yaml
2+
README.md

README.md

Lines changed: 32 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,10 @@ All the most popular MCP clients (Claude Desktop, Cursor & Windsurf) use the fol
2323
"mcpServers": {
2424
"remote-example": {
2525
"command": "npx",
26-
"args": ["mcp-remote", "https://remote.mcp.server/sse"]
26+
"args": [
27+
"mcp-remote",
28+
"https://remote.mcp.server/sse"
29+
]
2730
}
2831
}
2932
}
@@ -38,11 +41,16 @@ To bypass authentication, or to emit custom headers on all requests to your remo
3841
"mcpServers": {
3942
"remote-example": {
4043
"command": "npx",
41-
"args": ["mcp-remote", "https://remote.mcp.server/sse", "--header", "Authorization: Bearer ${AUTH_TOKEN}"],
44+
"args": [
45+
"mcp-remote",
46+
"https://remote.mcp.server/sse",
47+
"--header",
48+
"Authorization: Bearer ${AUTH_TOKEN}"
49+
],
4250
"env": {
4351
"AUTH_TOKEN": "..."
4452
}
45-
}
53+
},
4654
}
4755
}
4856
```
@@ -66,7 +74,7 @@ To bypass authentication, or to emit custom headers on all requests to your remo
6674

6775
### Flags
6876

69-
- If `npx` is producing errors, consider adding `-y` as the first argument to auto-accept the installation of the `mcp-remote` package.
77+
* If `npx` is producing errors, consider adding `-y` as the first argument to auto-accept the installation of the `mcp-remote` package.
7078

7179
```json
7280
"command": "npx",
@@ -77,7 +85,7 @@ To bypass authentication, or to emit custom headers on all requests to your remo
7785
]
7886
```
7987

80-
- To force `npx` to always check for an updated version of `mcp-remote`, add the `@latest` flag:
88+
* To force `npx` to always check for an updated version of `mcp-remote`, add the `@latest` flag:
8189

8290
```json
8391
"args": [
@@ -86,7 +94,7 @@ To bypass authentication, or to emit custom headers on all requests to your remo
8694
]
8795
```
8896

89-
- To change which port `mcp-remote` listens for an OAuth redirect (by default `3334`), add an additional argument after the server URL. Note that whatever port you specify, if it is unavailable an open port will be chosen at random.
97+
* To change which port `mcp-remote` listens for an OAuth redirect (by default `3334`), add an additional argument after the server URL. Note that whatever port you specify, if it is unavailable an open port will be chosen at random.
9098

9199
```json
92100
"args": [
@@ -96,7 +104,7 @@ To bypass authentication, or to emit custom headers on all requests to your remo
96104
]
97105
```
98106

99-
- To change which host `mcp-remote` registers as the OAuth callback URL (by default `localhost`), add the `--host` flag.
107+
* To change which host `mcp-remote` registers as the OAuth callback URL (by default `localhost`), add the `--host` flag.
100108

101109
```json
102110
"args": [
@@ -107,7 +115,7 @@ To bypass authentication, or to emit custom headers on all requests to your remo
107115
]
108116
```
109117

110-
- To allow HTTP connections in trusted private networks, add the `--allow-http` flag. Note: This should only be used in secure private networks where traffic cannot be intercepted.
118+
* To allow HTTP connections in trusted private networks, add the `--allow-http` flag. Note: This should only be used in secure private networks where traffic cannot be intercepted.
111119

112120
```json
113121
"args": [
@@ -117,7 +125,7 @@ To bypass authentication, or to emit custom headers on all requests to your remo
117125
]
118126
```
119127

120-
- To enable detailed debugging logs, add the `--debug` flag. This will write verbose logs to `~/.mcp-auth/{server_hash}_debug.log` with timestamps and detailed information about the auth process, connections, and token refreshing.
128+
* To enable detailed debugging logs, add the `--debug` flag. This will write verbose logs to `~/.mcp-auth/{server_hash}_debug.log` with timestamps and detailed information about the auth process, connections, and token refreshing.
121129

122130
```json
123131
"args": [
@@ -181,8 +189,8 @@ npx mcp-remote https://example.remote/server --static-oauth-client-info '@/Users
181189

182190
In order to add an MCP server to Claude Desktop you need to edit the configuration file located at:
183191

184-
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
185-
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
192+
* macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
193+
* Windows: `%APPDATA%\Claude\claude_desktop_config.json`
186194

187195
If it does not exist yet, [you may need to enable it under Settings > Developer](https://modelcontextprotocol.io/quickstart/user#2-add-the-filesystem-mcp-server).
188196

@@ -204,16 +212,16 @@ As of version `0.48.0`, Cursor supports unauthed SSE servers directly. If your M
204212

205213
For instructions on building & deploying remote MCP servers, including acting as a valid OAuth client, see the following resources:
206214

207-
- https://developers.cloudflare.com/agents/guides/remote-mcp-server/
215+
* https://developers.cloudflare.com/agents/guides/remote-mcp-server/
208216

209217
In particular, see:
210218

211-
- https://github.com/cloudflare/workers-oauth-provider for defining an MCP-comlpiant OAuth server in Cloudflare Workers
212-
- https://github.com/cloudflare/agents/tree/main/examples/mcp for defining an `McpAgent` using the [`agents`](https://npmjs.com/package/agents) framework.
219+
* https://github.com/cloudflare/workers-oauth-provider for defining an MCP-comlpiant OAuth server in Cloudflare Workers
220+
* https://github.com/cloudflare/agents/tree/main/examples/mcp for defining an `McpAgent` using the [`agents`](https://npmjs.com/package/agents) framework.
213221

214222
For more information about testing these servers, see also:
215223

216-
- https://developers.cloudflare.com/agents/guides/test-remote-mcp-server/
224+
* https://developers.cloudflare.com/agents/guides/test-remote-mcp-server/
217225

218226
Know of more resources you'd like to share? Please add them to this Readme and send a PR!
219227

@@ -248,10 +256,13 @@ this might look like:
248256

249257
```json
250258
{
251-
"mcpServers": {
259+
"mcpServers": {
252260
"remote-example": {
253261
"command": "npx",
254-
"args": ["mcp-remote", "https://remote.mcp.server/sse"],
262+
"args": [
263+
"mcp-remote",
264+
"https://remote.mcp.server/sse"
265+
],
255266
"env": {
256267
"NODE_EXTRA_CA_CERTS": "{your CA certificate file path}.pem"
257268
}
@@ -262,10 +273,10 @@ this might look like:
262273

263274
### Check the logs
264275

265-
- [Follow Claude Desktop logs in real-time](https://modelcontextprotocol.io/docs/tools/debugging#debugging-in-claude-desktop)
266-
- MacOS / Linux:<br/>`tail -n 20 -F ~/Library/Logs/Claude/mcp*.log`
267-
- For bash on WSL:<br/>`tail -n 20 -f "C:\Users\YourUsername\AppData\Local\Claude\Logs\mcp.log"`
268-
- Powershell: <br/>`Get-Content "C:\Users\YourUsername\AppData\Local\Claude\Logs\mcp.log" -Wait -Tail 20`
276+
* [Follow Claude Desktop logs in real-time](https://modelcontextprotocol.io/docs/tools/debugging#debugging-in-claude-desktop)
277+
* MacOS / Linux:<br/>`tail -n 20 -F ~/Library/Logs/Claude/mcp*.log`
278+
* For bash on WSL:<br/>`tail -n 20 -f "C:\Users\YourUsername\AppData\Local\Claude\Logs\mcp.log"`
279+
* Powershell: <br/>`Get-Content "C:\Users\YourUsername\AppData\Local\Claude\Logs\mcp.log" -Wait -Tail 20`
269280

270281
## Debugging
271282

0 commit comments

Comments
 (0)