Skip to content

Commit 0b818f2

Browse files
chore(mcp): document remote server in README.md
1 parent 12bd79f commit 0b818f2

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
@@ -128,6 +128,32 @@ over time, you can manually enable or disable certain capabilities:
128128
--resource=cards,accounts --operation=read --tag=kyc --no-tool=create_cards
129129
```
130130

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

133159
```js

0 commit comments

Comments
 (0)