Skip to content

Commit a9436b7

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

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

packages/mcp-server/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,32 @@ over time, you can manually enable or disable certain capabilities:
126126
--resource=cards,accounts --operation=read --tag=kyc --no-tool=create_cards
127127
```
128128

129+
## Running remotely
130+
131+
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.
132+
133+
Authorization can be provided via the `Authorization` header using the Bearer scheme.
134+
135+
Additionally, authorization can be provided via the following headers:
136+
| Header | Equivalent client option | Security scheme |
137+
| -------------------- | ------------------------ | --------------- |
138+
| `x-benchify-api-key` | `apiKey` | ApiKeyAuth |
139+
140+
A configuration JSON for this server might look like this:
141+
142+
```json
143+
{
144+
"mcpServers": {
145+
"benchify_api": {
146+
"url": "http://localhost:3000", # or wherever the server is hosted
147+
"headers": {
148+
"Authorization": "Bearer <auth value>"
149+
}
150+
}
151+
}
152+
}
153+
```
154+
129155
## Importing the tools and server individually
130156

131157
```js

0 commit comments

Comments
 (0)