From 63d5eb94a8802e48292eda95a66ec327ceb0fc32 Mon Sep 17 00:00:00 2001 From: Ivan Koptiev Date: Fri, 18 Apr 2025 13:37:33 +0300 Subject: [PATCH] docs: update README with environment variable details and SSE support 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. --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6e0c4d3..c260069 100644 --- a/README.md +++ b/README.md @@ -103,10 +103,14 @@ To integrate with Claude Desktop using **Docker**: "run", "-i", "--rm", - "-e", "FIREBOLT_MCP_CLIENT_ID=your-client-id", - "-e", "FIREBOLT_MCP_CLIENT_SECRET=your-client-secret", + "-e", "FIREBOLT_MCP_CLIENT_ID", + "-e", "FIREBOLT_MCP_CLIENT_SECRET", "ghcr.io/firebolt-db/mcp-server:0.2.1" - ] + ], + "env": { + "FIREBOLT_MCP_CLIENT_ID": "your-client-id", + "FIREBOLT_MCP_CLIENT_SECRET": "your-client-secret" + } } } } @@ -145,6 +149,15 @@ To set up MCP in Cursor, follow their guide: 👉 [Cursor Documentation on Model Context Protocol](https://docs.cursor.com/context/model-context-protocol) +#### Using SSE Transport + +By default, the MCP Server uses STDIO as the transport mechanism. +However, Server-Sent Events (SSE) are also supported and require additional configuration. + +To enable SSE, set the `--transport` CLI flag (or the `FIREBOLT_MCP_SERVER_TRANSPORT` environment variable) to `sse`. + +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). + ## Architecture Firebolt MCP Server implements the [Model Context Protocol](https://modelcontextprotocol.io/introduction), providing: