Getting started
View repository
Getting started / Cursor connectionRead source ↗

Connecting Cursor to Zetaris

Open this repository as the Cursor workspace and allow its terminal to run the repository scripts. Cursor reads the root AGENTS.md, which sets the connection, SQL, and permission rules for this repository.

1. Purpose

Use Cursor to inspect a Zetaris instance, run Lightning SQL, or work through a data recipe. It checks the connection before starting your goal.

Repository and shared-instance scope

Use the shared client setup for connection details, API authentication, and troubleshooting. On the event instance, get your team's prefix and permissions first. Inspect existing objects and leave other teams' objects alone.

2. Prerequisites

  • This repository open as the workspace.
  • Access to the Zetaris instance you want to use.
  • Permission for Cursor to run the repository's scripts and reach that instance.

JDBC also needs Java, the Zetaris driver JAR, and your Zetaris user ID and password. REST needs an API key that you create in the Zetaris GUI. See the shared connection settings.

3. Choosing a protocol

Use JDBC or REST based on the work and access you have. The repository's REST runner calls the raw API; the small query_zetaris and check_zetaris helpers use the UI proxy.

4. Connection parameters

Put settings in .env.local, not in a prompt. See the connection settings and authentication steps.

5. JDBC starter prompt

Copy the JDBC starter prompt after setting up the driver and .env.local.

6. REST starter prompt

6.1 Create an API key

Follow the shared API key steps.

6.2 Starter prompt

Set up .env.local, then copy the REST starter prompt.

6.3 Local or Zetaris Cloud

Use the REST URL and organisation ID for your instance from the shared settings.

6.4 Fetch the OpenAPI specification

Fetch the spec with Basic authentication using the shared instructions.

7. Verification

The shared guide explains the SELECT 1, REST endpoint, and instance-list checks. Cursor runs the read-only preflight before it starts your goal.

8. Usage rules

Follow root AGENTS.md: start with read-only SQL, send one statement per call, keep multi-table COMPILE USL intact, and wait for your go-ahead before creating anything.

9. Troubleshooting

See shared troubleshooting. It covers JDBC setup, REST authentication and organisation IDs, and missing Lightning databases.

Built from the repository documentation. Use your own account and team names on the shared instance.