cursor-plugin/tools.yaml at main · cockroachdb/cursor-plugin · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
sources:
  crdb-source:
    type: cockroachdb
    host: ${COCKROACHDB_HOST:localhost}
    port: "${COCKROACHDB_PORT:26257}"
    user: ${COCKROACHDB_USER:root}
    password: ${COCKROACHDB_PASSWORD:}
    database: ${COCKROACHDB_DATABASE:defaultdb}
    maxRetries: 5
    retryBaseDelay: 500ms
    readOnlyMode: true
    enableWriteMode: false
    maxRowLimit: 1000
    queryTimeoutSec: 30
    queryParams:
      sslmode: ${COCKROACHDB_SSLMODE:require}
      application_name: cockroachdb-cursor-plugin

tools:
  cockroachdb-execute-sql:
    type: cockroachdb-execute-sql
    source: crdb-source
    description: |
      Execute ad-hoc SQL statements against a CockroachDB database.
      Use this for any SQL: SELECT queries, DDL statements (CREATE, ALTER, DROP),
      and DML statements (INSERT, UPDATE, DELETE).

  cockroachdb-list-schemas:
    type: cockroachdb-list-schemas
    source: crdb-source
    description: |
      List all schemas in the connected CockroachDB database.
      Returns schema names and metadata. Use this as the first step
      when exploring an unfamiliar database.

  cockroachdb-list-tables:
    type: cockroachdb-list-tables
    source: crdb-source
    description: |
      List all tables in a CockroachDB database with detailed schema information
      including column names, data types, constraints, and indexes.
      Use this to understand table structure before writing queries.