@ottermind/sqlx-pi0.1.21
OtterMind SQLX tools for the Pi coding agent: list datasources, test connections, execute SQL and open local result pages.
Untested on omp
This is a pi package. No one has reported whether it works on omp yet. If you try it, add your result below.
Reports 0
No reports yet.
Readme
@ottermind/sqlx-pi
Native SQLX tools for the Pi coding agent. The extension registers six registerTool tools and
calls the sqlx CLI for each one, so encrypted credentials, TLS policy, worker downloads and local
result pages stay CLI responsibilities.
Install
pi install npm:@ottermind/sqlx-pi
Add -l to install into the project (./.pi/settings.json) instead of the user settings.
Requirements
- Pi 0.86 or later.
@earendil-works/pi-coding-agentandtypeboxare declared as peer dependencies; pi bundles both, andpi installruns npm with--omit=peer, so nothing extra is installed.- The
sqlxCLI 0.1.15 or later. The extension looks forSQLX_BIN, thensqlxonPATH, then the official user-level installation (~/.local/bin/sqlx,%LOCALAPPDATA%\Programs\SQLX\sqlx.exe, orSQLX_INSTALL_DIR), and when none of them exists it installs the CLI itself withnpx -y @ottermind/sqlx@latest --target pi. Installing the package is therefore the only setup step.
Tools
| Tool | Purpose | May modify data |
|---|---|---|
sqlx_datasource_list |
List saved datasources (no secrets) | no |
sqlx_datasource_show |
Show one datasource by UUID or unique name | no |
sqlx_datasource_test |
Test connectivity; executes no SQL | no |
sqlx_datasource_setup |
Start adding a datasource the user finishes in a browser page; returns that page's URL | adds a connection |
sqlx_datasource_setup_status |
Report the outcome of a browser setup; read-only | no |
sqlx_sql_execute |
Execute statements, return the table-shaped result with a preview (full returns every row) |
yes |
sqlx_results_rows |
Read one page of a stored result; read-only | no |
sqlx_sql_view |
Execute once, return a local result-page URL | yes |
sqlx_prefetch |
Download components ahead of a first query (all fetches every one) |
downloads only |
The two execution tools describe the authorization rule themselves: run them only after the user authorized that exact operation and scope. Results are never replayed automatically.
Every tool also declares the same MCP tool annotations as the MCP server (readOnlyHint,
destructiveHint, openWorldHint), which a pi permission extension can use to decide which calls to
confirm. pi gained the annotations field in 0.99.0; an older pi ignores it, so the description rule
above remains the whole of the protection there.
Credentials
Save credentials in the SQLX data directory (sqlx datasource add --connection-stdin, or the local
sqlx ui page). A datasource created with --username-env/--password-env reads environment
variables at execution time, and a harness started from a GUI usually cannot see your shell
environment.
Links
- Repository: https://github.com/OtterMind/sqlx
- Integration guide: https://github.com/OtterMind/sqlx/blob/main/integrations/README.md