Skip to content

Commit a4476c3

Browse files
johnkennedy-cmykcursoragent
andcommitted
docs: add Cursor one-click install and client-first setup
- Add 'Add to Cursor' buttons for Firebolt Cloud and Firebolt Core (deeplinks) - Restructure 'Connecting Your LLM' with Cursor first, then VS Code, Claude Desktop - Add VS Code subsection with copy-paste MCP JSON snippet - Add Manual configuration subsection for other MCP clients - Keep FIREBOLT_MCP_DISABLE_RESOURCES callout; note that buttons set it - Use latest tag in Cursor/VS Code/Manual configs for fewer version bumps Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent bd2570a commit a4476c3

1 file changed

Lines changed: 74 additions & 24 deletions

File tree

README.md

Lines changed: 74 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,53 @@ docker run \
8383

8484
### Connecting Your LLM
8585

86-
Once the MCP Server is installed, you can connect various LLM clients.
86+
Once the MCP Server is installed, you can connect various LLM clients. Choose your client below.
8787

88-
Below are integration examples for **Claude Desktop**.
89-
For other clients like **VSCode Copilot Chat** and **Cursor**, please refer to their official documentation.
88+
#### Cursor
89+
90+
Install the Firebolt MCP server in Cursor with one click. You will need to set your credentials in **Cursor Settings > Tools & MCP** (edit the added server or `mcp.json`).
91+
92+
**Firebolt Cloud** (service account):
93+
94+
[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=firebolt&config=eyJjb21tYW5kIjoiZG9ja2VyIiwiYXJncyI6WyJydW4iLCItaSIsIi0tcm0iLCItLW5ldHdvcmsiLCJob3N0IiwiLWUiLCJGSVJFQk9MVF9NQ1BfQ0xJRU5UX0lEIiwiLWUiLCJGSVJFQk9MVF9NQ1BfQ0xJRU5UX1NFQ1JFVCIsIi1lIiwiRklSRUJPTFRfTUNQX0RJU0FCTEVfUkVTT1VSQ0VTIiwiZ2hjci5pby9maXJlYm9sdC1kYi9tY3Atc2VydmVyOmxhdGVzdCJdLCJlbnYiOnsiRklSRUJPTFRfTUNQX0NMSUVOVF9JRCI6InlvdXItY2xpZW50LWlkIiwiRklSRUJPTFRfTUNQX0NMSUVOVF9TRUNSRVQiOiJ5b3VyLWNsaWVudC1zZWNyZXQiLCJGSVJFQk9MVF9NQ1BfRElTQUJMRV9SRVNPVVJDRVMiOiJ0cnVlIn19)
95+
96+
**Firebolt Core** (local or self-hosted):
97+
98+
[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=firebolt-core&config=eyJjb21tYW5kIjoiZG9ja2VyIiwiYXJncyI6WyJydW4iLCItaSIsIi0tcm0iLCItLW5ldHdvcmsiLCJob3N0IiwiLWUiLCJGSVJFQk9MVF9NQ1BfQ09SRV9VUkwiLCItZSIsIkZJUkVCT0xUX01DUF9ESVNBQkxFX1JFU09VUkNFUyIsImdoY3IuaW8vZmlyZWJvbHQtZGIvbWNwLXNlcnZlcjpsYXRlc3QiXSwiZW52Ijp7IkZJUkVCT0xUX01DUF9DT1JFX1VSTCI6Imh0dHA6Ly9sb2NhbGhvc3Q6MzQ3MyIsIkZJUkVCT0xUX01DUF9ESVNBQkxFX1JFU09VUkNFUyI6InRydWUifX0=)
99+
100+
> [!IMPORTANT]
101+
> Cursor does not support MCP resources yet. This MCP server uses resources heavily, so it will not work in Cursor unless resource usage is disabled. The buttons above already set `FIREBOLT_MCP_DISABLE_RESOURCES=true` for you. If you configure manually, you must set this environment variable.
102+
103+
#### VS Code (Copilot Chat)
104+
105+
To integrate MCP with Copilot Chat in VS Code, see the official guide: [Extending Copilot Chat with the Model Context Protocol](https://docs.github.com/en/copilot/customizing-copilot/extending-copilot-chat-with-mcp).
106+
107+
Add the Firebolt MCP server to your MCP configuration (e.g. via Command Palette > **MCP: Open User Configuration**). Example for **Firebolt Cloud** with Docker:
108+
109+
```json
110+
{
111+
"mcpServers": {
112+
"firebolt": {
113+
"command": "docker",
114+
"args": [
115+
"run",
116+
"-i",
117+
"--rm",
118+
"--network", "host",
119+
"-e", "FIREBOLT_MCP_CLIENT_ID",
120+
"-e", "FIREBOLT_MCP_CLIENT_SECRET",
121+
"ghcr.io/firebolt-db/mcp-server:latest"
122+
],
123+
"env": {
124+
"FIREBOLT_MCP_CLIENT_ID": "your-client-id",
125+
"FIREBOLT_MCP_CLIENT_SECRET": "your-client-secret"
126+
}
127+
}
128+
}
129+
}
130+
```
131+
132+
Replace `your-client-id` and `your-client-secret` with your [Firebolt service account](https://docs.firebolt.io/Guides/managing-your-organization/service-accounts.html) credentials.
90133

91134
#### Claude Desktop
92135

@@ -137,7 +180,7 @@ To integrate with Claude Desktop using **Docker**:
137180
}
138181
```
139182

140-
#### Connecting to Firebolt Core
183+
**Connecting to Firebolt Core**
141184

142185
If you are using [Firebolt Core](https://docs.firebolt.io/firebolt-core), you can connect by providing the Core URL instead of service account credentials.
143186

@@ -170,28 +213,35 @@ To integrate with Claude Desktop using **Docker**:
170213

171214
More details: [Claude MCP Quickstart Guide](https://modelcontextprotocol.io/quickstart/user)
172215

173-
#### GitHub Copilot Chat (VSCode)
174-
175-
To integrate MCP with Copilot Chat in VSCode, refer to the official documentation:
176-
177-
👉 [Extending Copilot Chat with the Model Context Protocol](https://docs.github.com/en/copilot/customizing-copilot/extending-copilot-chat-with-mcp)
178-
179-
#### Cursor Editor
180-
181-
To set up MCP in Cursor, follow their guide:
182-
183-
👉 [Cursor Documentation on Model Context Protocol](https://docs.cursor.com/context/model-context-protocol)
184-
185-
> [!IMPORTANT]
186-
> Cursor **does not support MCP resources** yet.
187-
This MCP server uses resources heavily, so **it will not work in Cursor** unless you explicitly disable resource usage.
188-
189-
To make it work, you **must** set the following environment variable:
190-
191-
```
192-
FIREBOLT_MCP_DISABLE_RESOURCES=true
216+
#### Manual configuration (other MCP clients)
217+
218+
For any MCP client that uses a JSON config (e.g. `mcpServers`), you can add the Firebolt server with the following canonical configuration. **Firebolt Cloud** (Docker):
219+
220+
```json
221+
{
222+
"mcpServers": {
223+
"firebolt": {
224+
"command": "docker",
225+
"args": [
226+
"run",
227+
"-i",
228+
"--rm",
229+
"--network", "host",
230+
"-e", "FIREBOLT_MCP_CLIENT_ID",
231+
"-e", "FIREBOLT_MCP_CLIENT_SECRET",
232+
"ghcr.io/firebolt-db/mcp-server:latest"
233+
],
234+
"env": {
235+
"FIREBOLT_MCP_CLIENT_ID": "your-client-id",
236+
"FIREBOLT_MCP_CLIENT_SECRET": "your-client-secret"
237+
}
238+
}
239+
}
240+
}
193241
```
194242

243+
For **Firebolt Core**, use `FIREBOLT_MCP_CORE_URL` (e.g. `http://localhost:3473`) in `env` and pass `-e FIREBOLT_MCP_CORE_URL` in `args` instead of the client ID/secret. For Cursor, also set `FIREBOLT_MCP_DISABLE_RESOURCES=true` in `env` and in `args`.
244+
195245
#### Using SSE Transport
196246

197247
By default, the MCP Server uses STDIO as the transport mechanism.

0 commit comments

Comments
 (0)