Skip to content

Commit 3344229

Browse files
chore(mcp): document remote server in README.md
1 parent 1ba1635 commit 3344229

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

packages/mcp-server/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,34 @@ over time, you can manually enable or disable certain capabilities:
121121
--resource=cards,accounts --operation=read --tag=kyc --no-tool=create_cards
122122
```
123123

124+
## Running remotely
125+
126+
Launching the client with `--transport=http` launches the server as a remote server using Streamable HTTP transport. The `--port` setting can choose the port it will run on, and the `--socket` setting allows it to run on a Unix socket.
127+
128+
Authorization can be provided via the `Authorization` header using the Basic or Bearer scheme.
129+
130+
Additionally, authorization can be provided via the following headers:
131+
| Header | Equivalent client option | Security scheme |
132+
| --------------------------- | ------------------------ | ------------------ |
133+
| `x-mux-token-id` | `tokenId` | accessToken |
134+
| `x-mux-token-secret` | `tokenSecret` | accessToken |
135+
| `x-mux-authorization-token` | `authorizationToken` | authorizationToken |
136+
137+
A configuration JSON for this server might look like this:
138+
139+
```json
140+
{
141+
"mcpServers": {
142+
"mux_mux_node_api": {
143+
"url": "http://localhost:3000", # or wherever the server is hosted
144+
"headers": {
145+
"Authorization": "Basic <auth value>"
146+
}
147+
}
148+
}
149+
}
150+
```
151+
124152
## Importing the tools and server individually
125153

126154
```js

0 commit comments

Comments
 (0)