airy 0.1.2

Airy is an AI tool for interacting with databases.
Documentation 
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

# airy

![Crates.io Version](https://img.shields.io/crates/v/airy)

An AI tool for interacting with databases.

![terminal example](./docs/terminal-example.png)

**Features:**
- Chat with your database in terminal.
- Generate SQL queries.
- Run as a MCP server.

# Installation

Download from [GitHub Releases](https://github.com/tinrab/airy/releases).

Install using Cargo.

```sh
$ cargo install airy
```

# Help

```
Usage: airy [OPTIONS] <COMMAND>

Commands:
  chat
  mcp
  help  Print this message or the help of the given subcommand(s)

Options:
      --openrouter-api-key <OPENROUTER_API_KEY>
          OpenRouter API Key [env: OPENROUTER_API_KEY=]
      --openrouter-base-url <OPENROUTER_BASE_URL>
          OpenRouter Base URL [env: OPENROUTER_BASE_URL=] [default: https://openrouter.ai/api/v1]
      --model <MODEL>
          OpenRouter model ID [env: MODEL=] [default: mistralai/devstral-small:free]
      --max-tokens <MAX_TOKENS>
          Max tokens [default: 1024]
      --mysql-url <MYSQL_URL>
          MySQL URL [env: MYSQL_URL=]
      --postgres-url <POSTGRES_URL>
          PostgreSQL URL [env: POSTGRES_URL=]
  -h, --help
          Print help
  -V, --version
          Print version
```

```
Usage: airy mcp [OPTIONS]

Options:
      --sse          Run as a server using SSE
      --port <PORT>  Set the Port [default: 8080]
  -h, --help         Print help
```

# Development

Set up the dev environment.

```sh
$ just mysql-download-data # downloads test data

$ just docker-up # starts Docker containers
$ just migrate up # runs migrations to the latest version

$ just mysql-load-data # loads data into the database
```

Run chat.

```
$ OPENROUTER_API_KEY=[..] cargo run -- --mysql-url "mysql://employee:abc123456@127.0.0.1:3306/employee" chat
```

You can also provide `OPENROUTER_API_KEY`, `MYSQL_URL` and other arguments as environment variables.

Run MCP server with server-sent events.

```
$ cargo run -- --mysql-url "mysql://employee:abc123456@127.0.0.1:3306/employee" mcp --sse
```

You can test the MCP server with `@modelcontextprotocol/inspector` by connecting to `http://localhost:8080/sse`.