Skip to content
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
2 changes: 2 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ on:
- 'SECURITY.md'
- 'AGENTS.md'
- 'CLAUDE.md'
- 'server.json'
pull_request:
branches:
- main
Expand All @@ -35,6 +36,7 @@ on:
- 'SECURITY.md'
- 'AGENTS.md'
- 'CLAUDE.md'
- 'server.json'
env:
GOTESTCMD: "go test -timeout 1200s --tags \"sqlite_stackql\" -v ./..."
TESTSCRIPT: "test/deprecated/python/main.py"
Expand Down
92 changes: 92 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
[stars]: https://img.shields.io/github/stars/stackql/stackql?style=flat-square "GitHub Stars"
[forks]: https://img.shields.io/github/forks/stackql/stackql?style=flat-square "GitHub Forks"
[contributors]: https://img.shields.io/github/contributors/stackql/stackql?style=flat-square "Contributors"
[mcpregistrybadge]: https://img.shields.io/badge/MCP%20Registry-io.github.stackql%2Fstackql--mcp-blue?style=flat-square "MCP Registry"
<!-- github links -->
[issues]: https://github.com/stackql/stackql/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBUG%5D
[features]: https://github.com/stackql/stackql/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=%5BFEATURE%5D
Expand All @@ -36,6 +37,8 @@
[lightmodeterm]: /docs/images/stackql-dark-term.gif#gh-light-mode-only
<!-- misc links -->
[twitter]: https://twitter.com/stackql
[mcpregistry]: https://registry.modelcontextprotocol.io/?search=stackql
[mcpdocs]: https://stackql.io/docs

<!-- language: lang-none -->
<div align="center">
Expand All @@ -44,6 +47,7 @@
![platforms]
![license]
![build]
[![MCP Registry][mcpregistrybadge]][mcpregistry]
![stars]
![forks]
![contributors]
Expand Down Expand Up @@ -83,6 +87,7 @@
<summary>Contents</summary>
<ol>
<li><a href="#about-the-project">About The Project</a></li>
<li><a href="#mcp-server">MCP Server</a></li>
<li><a href="#installation">Installation</a></li>
<li><a href="#usage">Usage</a></li>
<!-- <li><a href="#roadmap">Roadmap</a></li> -->
Expand Down Expand Up @@ -139,6 +144,93 @@ More detailed design documentation can be found in the [here][designdocs].

</details>

## MCP Server

StackQL is an [MCP](https://modelcontextprotocol.io) server - SQL over 40+ cloud and SaaS providers for AI agents. Point any MCP-capable client (Claude, VS Code, Cursor, etc.) at StackQL and it can query and provision cloud resources using SQL.

Run it over stdio:

```sh
stackql mcp --mcp.server.type=stdio
```

StackQL MCP is published to the [Official MCP Registry][mcpregistry] as `io.github.stackql/stackql-mcp` and distributed via npm, PyPI, Docker, a GitHub Action and `.mcpb` bundles. Pick an install vector and add the matching block to your MCP client config:

<details>
<summary><b>npm (npx)</b></summary>

```json
{
"mcpServers": {
"stackql": {
"command": "npx",
"args": ["-y", "@stackql/mcp-server"]
}
}
}
```

</details>

<details>
<summary><b>PyPI (uvx)</b></summary>

```json
{
"mcpServers": {
"stackql": {
"command": "uvx",
"args": ["stackql-mcp-server"]
}
}
}
```

</details>

<details>
<summary><b>Docker</b></summary>

```json
{
"mcpServers": {
"stackql": {
"command": "docker",
"args": ["run", "-i", "--rm", "stackql/stackql-mcp"]
}
}
}
```

</details>

<details>
<summary><b>.mcpb bundle</b></summary>

> Download the bundle for your platform from the [latest release](https://github.com/stackql/stackql/releases/latest) and install it in your MCP client (one-click in clients that support `.mcpb`).

- `stackql-mcp-linux-x64.mcpb`
- `stackql-mcp-linux-arm64.mcpb`
- `stackql-mcp-windows-x64.mcpb`
- `stackql-mcp-darwin-universal.mcpb`

</details>

<details>
<summary><b>GitHub Actions</b></summary>

> Wire StackQL MCP into agentic CI workflows. Defaults to `read_only` mode, the safe default for CI.

```yaml
- uses: stackql/setup-stackql-mcp@v1
with:
mode: read_only
```

</details>

For client-specific setup, authentication and server modes, see the [full MCP install and usage docs][mcpdocs].

## Installation

StackQL is available for Windows, MacOS, Linux, Docker, GitHub Actions and more. See the installation instructions below for your platform.
Expand Down
68 changes: 68 additions & 0 deletions server.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
{
"$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
"name": "io.github.stackql/stackql-mcp",
"title": "StackQL MCP Server",
"description": "SQL-native query and provisioning engine for cloud infrastructure, served over MCP.",
"websiteUrl": "https://stackql.io",
"repository": {
"url": "https://github.com/stackql/stackql",
"source": "github"
},
"version": "0.10.500.2",
"packages": [
{
"registryType": "mcpb",
"identifier": "https://github.com/stackql/stackql/releases/download/v0.10.500/stackql-mcp-linux-x64.mcpb",
"version": "0.10.500",
"fileSha256": "6615737747156b1a8413a976afb23af2e7eec29ebc98a6f0a0f65d1b153c44be",
"transport": { "type": "stdio" }
},
{
"registryType": "mcpb",
"identifier": "https://github.com/stackql/stackql/releases/download/v0.10.500/stackql-mcp-linux-arm64.mcpb",
"version": "0.10.500",
"fileSha256": "594bedbabc3096dc3563c907724e845ce0b61a67de4b3fed4158b40c0363786c",
"transport": { "type": "stdio" }
},
{
"registryType": "mcpb",
"identifier": "https://github.com/stackql/stackql/releases/download/v0.10.500/stackql-mcp-windows-x64.mcpb",
"version": "0.10.500",
"fileSha256": "d2ce895e88f9c6b557df07073158629808f56d75598f3a701164d65506b791b0",
"transport": { "type": "stdio" }
},
{
"registryType": "mcpb",
"identifier": "https://github.com/stackql/stackql/releases/download/v0.10.500/stackql-mcp-darwin-universal.mcpb",
"version": "0.10.500",
"fileSha256": "4eed70af5cfa67295ae0b42fa3a6dca71ac9acabd0d67914fd96ad1247a9b4cc",
"transport": { "type": "stdio" }
},
{
"registryType": "oci",
"identifier": "docker.io/stackql/stackql-mcp:0.10.500",
"transport": { "type": "stdio" }
},
{
"registryType": "npm",
"registryBaseUrl": "https://registry.npmjs.org",
"identifier": "@stackql/mcp-server",
"version": "0.10.500",
"transport": { "type": "stdio" }
},
{
"registryType": "pypi",
"registryBaseUrl": "https://pypi.org",
"identifier": "stackql-mcp-server",
"version": "0.10.500",
"transport": { "type": "stdio" }
}
],
"_meta": {
"io.modelcontextprotocol.registry/publisher-provided": {
"tool": "stackql-mcpb-packaging",
"homepage": "https://stackql.io",
"documentation": "https://stackql.io/docs"
}
}
}
Loading