Skip to content

Commit 34ea0a5

Browse files
authored
docs: update README with environment variable details and SSE support (#17)
Revised the README to include changes in environment variable formatting for better clarity. Added a new section explaining Server-Sent Events (SSE) transport configuration and usage, including relevant CLI flags and environment variables.
1 parent 2cf5db9 commit 34ea0a5

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,14 @@ To integrate with Claude Desktop using **Docker**:
103103
"run",
104104
"-i",
105105
"--rm",
106-
"-e", "FIREBOLT_MCP_CLIENT_ID=your-client-id",
107-
"-e", "FIREBOLT_MCP_CLIENT_SECRET=your-client-secret",
106+
"-e", "FIREBOLT_MCP_CLIENT_ID",
107+
"-e", "FIREBOLT_MCP_CLIENT_SECRET",
108108
"ghcr.io/firebolt-db/mcp-server:0.2.1"
109-
]
109+
],
110+
"env": {
111+
"FIREBOLT_MCP_CLIENT_ID": "your-client-id",
112+
"FIREBOLT_MCP_CLIENT_SECRET": "your-client-secret"
113+
}
110114
}
111115
}
112116
}
@@ -145,6 +149,15 @@ To set up MCP in Cursor, follow their guide:
145149

146150
👉 [Cursor Documentation on Model Context Protocol](https://docs.cursor.com/context/model-context-protocol)
147151

152+
#### Using SSE Transport
153+
154+
By default, the MCP Server uses STDIO as the transport mechanism.
155+
However, Server-Sent Events (SSE) are also supported and require additional configuration.
156+
157+
To enable SSE, set the `--transport` CLI flag (or the `FIREBOLT_MCP_SERVER_TRANSPORT` environment variable) to `sse`.
158+
159+
Optionally, you can specify the address the server should listen on by setting the `--transport-sse-listen-address` CLI flag (or the `FIREBOLT_MCP_TRANSPORT_SSE_LISTEN_ADDRESS` environment variable).
160+
148161
## Architecture
149162

150163
Firebolt MCP Server implements the [Model Context Protocol](https://modelcontextprotocol.io/introduction), providing:

0 commit comments

Comments
 (0)