Skip to content

Commit 0be73c2

Browse files
Merge pull request #13 from keboola/KAB-881-add-cursor-set-up
KAB-881: add set up instructions for Cursor AI
2 parents 3bbc609 + 381bbd9 commit 0be73c2

File tree

1 file changed

+57
-3
lines changed

1 file changed

+57
-3
lines changed

README.md

Lines changed: 57 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Keboola MCP Server
22

3-
[![CI](https://github.com/jordanburger/keboola-mcp-server/actions/workflows/ci.yml/badge.svg)](https://github.com/jordanburger/keboola-mcp-server/actions/workflows/ci.yml)
4-
[![codecov](https://codecov.io/gh/jordanburger/keboola-mcp-server/branch/main/graph/badge.svg)](https://codecov.io/gh/jordanburger/keboola-mcp-server)
3+
[![CI](https://github.com/keboola/keboola-mcp-server/actions/workflows/ci.yml/badge.svg)](https://github.com/keboola/keboola-mcp-server/actions/workflows/ci.yml)
4+
[![codecov](https://codecov.io/gh/keboola/keboola-mcp-server/branch/main/graph/badge.svg)](https://codecov.io/gh/keboola/keboola-mcp-server)
55
<a href="https://glama.ai/mcp/servers/72mwt1x862"><img width="380" height="200" src="https://glama.ai/mcp/servers/72mwt1x862/badge" alt="Keboola Explorer Server MCP server" /></a>
66
[![smithery badge](https://smithery.ai/badge/keboola-mcp-server)](https://smithery.ai/server/keboola-mcp-server)
77

@@ -29,7 +29,7 @@ npx -y @smithery/cli install keboola-mcp-server --client claude
2929
First, clone the repository and create a virtual environment:
3030

3131
```bash
32-
git clone https://github.com/jordanburger/keboola-mcp-server.git
32+
git clone https://github.com/keboola/keboola-mcp-server.git
3333
cd keboola-mcp-server
3434
python3 -m venv .venv
3535
source .venv/bin/activate
@@ -116,6 +116,60 @@ If you encounter connection issues:
116116
4. Confirm the virtual environment is properly activated and all dependencies are installed
117117
5. Make sure the PYTHONPATH points to the `src` directory
118118

119+
## Cursor AI Setup
120+
121+
To use this server with Cursor AI, you have two options for configuring the transport method: Server-Sent Events (SSE) or Standard I/O (stdio).
122+
123+
1. Create or edit the Cursor AI configuration file:
124+
- Location: `~/.cursor/mcp.json`
125+
126+
2. Add one of the following configurations (or both) based on your preferred transport method:
127+
128+
### Option 1: Using Server-Sent Events (SSE)
129+
130+
```json
131+
{
132+
"mcpServers": {
133+
"keboola": {
134+
"url": "http://localhost:8000/sse?storage_token=YOUR_STORAGE_TOKEN&snowflake_account=YOUR_ACCOUNT&snowflake_user=YOUR_USER&snowflake_password=YOUR_PASSWORD&snowflake_database=YOUR_DATABASE&snowflake_schema=YOUR_SCHEMA&snowflake_warehouse=YOUR_WAREHOUSE"
135+
}
136+
}
137+
}
138+
```
139+
140+
### Option 2: Using Standard I/O (stdio)
141+
142+
```json
143+
{
144+
"mcpServers": {
145+
"keboola": {
146+
"command": "/path/to/keboola-mcp-server/venv/bin/python",
147+
"args": [
148+
"-m",
149+
"keboola_mcp_server.cli",
150+
"--transport",
151+
"stdio"
152+
],
153+
"env": {
154+
"KBC_STORAGE_TOKEN": "your-keboola-storage-token",
155+
"KBC_SNOWFLAKE_ACCOUNT": "your-snowflake-account",
156+
"KBC_SNOWFLAKE_USER": "your-snowflake-user",
157+
"KBC_SNOWFLAKE_PASSWORD": "your-snowflake-password",
158+
"KBC_SNOWFLAKE_DATABASE": "your-snowflake-database",
159+
"KBC_SNOWFLAKE_SCHEMA": "your-snowflake-schema",
160+
"KBC_SNOWFLAKE_WAREHOUSE": "your-snowflake-warehouse"
161+
}
162+
}
163+
}
164+
}
165+
```
166+
167+
Replace all placeholder values (YOUR_*) with your actual Keboola and Snowflake credentials. These can be obtained from your Keboola project's Read Only Snowflake Workspace.
168+
169+
After updating the configuration:
170+
1. Restart Cursor AI
171+
2. The MCP server should be automatically detected and available for use
172+
119173
## Available Tools
120174

121175
The server provides the following tools for interacting with Keboola Connection:

0 commit comments

Comments
 (0)