Skip to content

v0.1.0-beta.1

Pre-release
Pre-release

Choose a tag to compare

View all tags
@github-actions github-actions released this 26 Jul 07:22
v0.1.0-beta.1
035106a

⚠️ This is a beta pre-release. The server is functional but has not been fully validated end-to-end across every endpoint. Expect rough edges. Feedback and bug reports are welcome — open an issue.

The first public release of Chartbrew MCP — a Model Context Protocol server that lets AI agents (Claude Code, Cursor, GitHub Copilot, Codex, and any MCP-compatible client) operate Chartbrew through natural language.

✨ Highlights

  • Talk to Chartbrew from any AI agent — list teams, connections, datasets, dashboards, and charts; run live queries; fetch data; and manage secure share policies/tokens for embedding.
  • Runs without Node.js — grab a standalone binary for your platform and point your MCP client at it. No install, no dependencies.
  • Safe by default — ships in restricted (read/query-only) mode; set CHARTBREW_TOOL_MODE=unrestricted to enable create/update/delete.
  • Strictly documented API — implements only Chartbrew's official, documented endpoints.
  • Cross-platform binaries — Windows, Linux, and macOS, x64 + arm64.

📦 Install

Option A — Standalone binary (no Node.js)

  1. Download the archive for your OS/arch from the Assets below (.zip for Windows, .tar.gz for Linux/macOS).
  2. Extract it. On macOS/Linux: chmod +x chartbrew-mcp-*.
  3. Add to your MCP client:
{
  "mcpServers": {
    "chartbrew": {
      "command": "/absolute/path/to/chartbrew-mcp-darwin-arm64",
      "env": {
        "CHARTBREW_API_KEY": "your-api-key",
        "CHARTBREW_API_BASE_URL": "https://api.chartbrew.com",
        "CHARTBREW_TOOL_MODE": "restricted"
      }
    }
  }
}

macOS Gatekeeper: if the unsigned binary is blocked, remove the quarantine flag:
xattr -d com.apple.quarantine chartbrew-mcp-darwin-arm64

Option B — From source (Node.js ≥ 22)

git clone https://github.com/dhavanikgithub/chartbrew-mcp.git
cd chartbrew-mcp
npm install && npm run build
node dist/index.js

🔑 Configuration

Variable Required Description
CHARTBREW_API_KEY Yes Chartbrew API key (Bearer token auth)
CHARTBREW_API_BASE_URL No API base URL — https://api.chartbrew.com for cloud, or your self-hosted URL (default http://localhost:4019)
CHARTBREW_REQUEST_TIMEOUT_MS No Request timeout in ms (default 30000)
CHARTBREW_TOOL_MODE No restricted (default, read-only) or unrestricted (read + write)

Get an API key: How to create API keys in Chartbrew.

🧰 Available tools

Teams · Connections · Datasets · Data Requests · Dashboards · Charts — including list/get/create/update/delete, live queries, data fetch, connection testing, and signed share policies/tokens for secure embedding. See the README for the full list.

⚠️ Known limitations (beta)

  • Not yet validated end-to-end across every endpoint.
  • Variable binding create/update endpoints are not implemented in this version.
  • macOS binaries are unsigned (Gatekeeper warning — see install notes).
  • Some create/update payload fields are inconsistently documented upstream, so payloads are typed as flexible objects.

📋 Assets

Prebuilt binaries + compressed archives for Windows, Linux, macOS (x64 + arm64) are attached below. Prefer the archives for smaller downloads.

Full changelog: see CHANGELOG.md.
Source & docs: github.com/dhavanikgithub/chartbrew-mcp.

Assets 14
Loading