Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md and enhance project dependencies #3

Merged
merged 1 commit into from
Jan 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 57 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,84 @@
# Keboola MCP Server


[![codecov](https://codecov.io/gh/jordanrburger/keboola-mcp-server/branch/master/graph/badge.svg?token=4JMT6ZBZMO)](https://codecov.io/gh/jordanrburger/keboola-mcp-server)

[![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)
[![codecov](https://codecov.io/gh/jordanburger/keboola-mcp-server/branch/main/graph/badge.svg)](https://codecov.io/gh/jordanburger/keboola-mcp-server)
<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>

A Model Context Protocol (MCP) server for interacting with Keboola Connection. This server provides tools for listing and accessing data from Keboola Storage API.

## Installation

Install from source:
First, clone the repository and create a virtual environment:

```bash
pip install .
git clone https://github.com/jordanburger/keboola-mcp-server.git
cd keboola-mcp-server
python3 -m venv .venv
source .venv/bin/activate
```

For development:
Install the package in development mode:

```bash
pip install -e ".[dev]"
pip3 install -e .
```

## Usage

The server requires a Keboola Storage API token to be set in the environment:
For development dependencies:

```bash
export KBC_STORAGE_TOKEN=your-token
pip3 install -e ".[dev]"
```

Optional environment variables:
- `KBC_STORAGE_API_URL`: Keboola Storage API URL (defaults to https://connection.keboola.com)
- `KBC_LOG_LEVEL`: Logging level (defaults to INFO)
## Claude Desktop Setup

To use this server with Claude Desktop, follow these steps:

1. Create or edit the Claude Desktop configuration file:
- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`

2. Add the following configuration (adjust paths according to your setup):

```json
{
"mcpServers": {
"keboola": {
"command": "/path/to/keboola-mcp-server/.venv/bin/python",
"args": [
"-m",
"keboola_mcp_server.cli",
"--log-level",
"DEBUG",
"--api-url",
"https://connection.YOUR_REGION.keboola.com"
],
"env": {
"KBC_STORAGE_TOKEN": "your-keboola-storage-token",
"PYTHONPATH": "/path/to/keboola-mcp-server/src"
}
}
}
}
```

Run the server:
Replace:
- `/path/to/keboola-mcp-server` with your actual path to the cloned repository
- `your-keboola-storage-token` with your Keboola Storage API token
- `YOUR_REGION` with your Keboola region (e.g., `north-europe.azure`, `connection`, etc.)

```bash
keboola-mcp-server
```
3. After updating the configuration:
- Completely quit Claude Desktop (don't just close the window)
- Restart Claude Desktop
- Look for the hammer icon in the bottom right corner, indicating the server is connected

Or with custom options:
### Troubleshooting

```bash
keboola-mcp-server --transport stdio --log-level DEBUG --api-url https://connection.north-europe.azure.keboola.com
```
If you encounter connection issues:
1. Check the logs in Claude Desktop for any error messages
2. Verify your Keboola Storage API token is correct
3. Ensure all paths in the configuration are absolute paths
4. Confirm the virtual environment is properly activated and all dependencies are installed
5. Make sure the PYTHONPATH points to the `src` directory

## Available Tools

Expand Down
Loading
Loading