konsol-mcp
Integrates with ClickHouse by applying schema changes and DDL statements via the konsol configuration service.
Publishes konsol configuration as dbt variables and triggers schema application to manage dbt models.
Connects to the konsol Frappe app via Docker by running bench execute inside the Docker stack.
Creates and manages ERPNext connectors and data sources within the konsol app for building data pipelines.
Manages the konsol Frappe app configuration, including dimensions, measures, facts, and schema, through a CLI or MCP interface.
This server does not currently have a deployable release on Glama. Follow the repository's setup instructions to install and configure it for your MCP client, including any required credentials and local dependencies.
konsol-cli
Config-as-code and schema client for the konsol Frappe app.
konsol-cli does two things:
config: export a site's configuration (dimensions, measures, datasets, connectors) to a YAML or JSON file, diff a file against a site, and apply a file to a site.
schema: apply the published configuration to the warehouse, and show its status.
To create, edit, publish or delete one dimension, measure, dataset or connector, use the Frappe Desk or the generic Frappe client frappectl. konsol-cli no longer has commands for that work (konsol#379).
konsol-cli calls these five konsol endpoints, and no others:
Endpoint | HTTP | Used by |
| GET |
|
| POST |
|
| POST |
|
| POST |
|
| GET |
|
Writes are POST because Frappe rolls back a GET request. diff_config_api writes nothing, but the bundle goes in a POST body because it is too large for a query string.
Install
cd konsol_cli
python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"Optional MCP server:
pip install -e ".[mcp]"Related MCP server: Frappe MCP
Two ways to connect
1. Local Docker (default)
Talks to konsol by running bench execute inside your Docker stack.
konsol --compose-file ../repo/docker-compose.yml schema status2. Remote HTTP API
Talks to any running konsol site over the Frappe API. Use this from your laptop against a remote server, in CI, or with MCP.
First, create API keys in Frappe:
Log into the site as an EPM Admin user
Go to User → your user → Settings tab → API Access
Click Generate Keys and save the key + secret
Then run commands:
konsol --backend api \
--url http://localhost:8069 \
--site konsolidat.local \
--api-key YOUR_KEY \
--api-secret YOUR_SECRET \
schema statusWhen connecting to localhost:8069, keep --site set — the CLI sends it as the Host header so Frappe routes to the right site.
Optional config file — copy config.example.toml to ~/.config/konsol/config.toml (connection settings only).
Credentials (pick one, never commit):
cp secrets.example.env ~/.config/konsol/secrets.env && chmod 600 ~/.config/konsol/secrets.env
# or: secrets.example.toml → ~/.config/konsol/secrets.tomlThe CLI loads secrets.env first, then secrets.toml. Shell env vars take precedence.
Grok MCP — configs use ${KONSOL_API_KEY} placeholders. Before starting Grok:
source scripts/load-konsol-secrets.sh # exports vars, does not print them
grok mcp doctor konsolSee .grok/config.toml (project-scoped, safe to commit) — not plaintext secrets.
Commands
# Config (GitOps YAML)
konsol config export -o model.yaml
konsol config diff model.yaml
konsol config apply model.yaml [--publish] [--prune] [--dry-run]
# Schema
konsol schema apply [--run-dbt]
konsol schema statusMCP (AI clients)
Install the optional extra, then add mcp.example.json to your MCP client config (Cursor, Claude Desktop, etc.):
pip install -e ".[mcp]"Set KONSOL_URL, KONSOL_SITE, KONSOL_API_KEY, and KONSOL_API_SECRET in the server env block, then run konsol-mcp (stdio transport).
The server has seven tools. Each one calls only the five endpoints above:
Tool | What it does |
| Export the site configuration as a bundle. |
| Diff a bundle against the site. |
| Apply a bundle ( |
| Apply the published configuration to the warehouse. |
| Show registry counts and build requests. |
| Diff a bundle file, then apply it when |
| Read-only: diff a bundle file and show the schema status. |
The tools for single dimensions, measures, datasets and connectors, and the composites built on them (publish_model_changes, provision_and_test_connector, onboard_new_entity), were removed in v0.11.0.
Debug with the MCP Inspector:
npx @modelcontextprotocol/inspector konsol-mcpEnvironment variables
Variable | Purpose |
|
|
| Frappe site name |
| Site URL for api backend |
| Frappe API key |
| Frappe API secret |
| Path to docker-compose.yml for bench backend |
Docker deploy note
bench get-app installs konsol from git HEAD, not uncommitted files. Commit konsol changes before docker compose build frappe_backend.
Architecture
konsol-cli / konsol-mcp
→ bench execute or HTTP /api/method/konsol.cli_api.<five endpoints>
→ konsol.config_service → Frappe DocTypes
→ publish / apply_schema → dbt vars, ClickHouse DDL, Pipeline Build RequestTests
cd konsol_cli && .venv/bin/python -m pytest tests/ -q
cd repo/docker/frappe/konsol && PYTHONPATH=konsol .venv/bin/python -m pytest konsol/tests/test_config_service.py -qTool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
This server cannot be deployed
Maintenance
Related MCP Connectors
MCP server unifying ERPs, CRMs, APIs and knowledge base for Claude, ChatGPT and Gemini.
MCP server for progressive tool usage at any scale (see https://klavis.ai)
MCP server for AI dialogue using various LLM models via AceDataCloud
Related MCP Servers
- AlicenseBqualityDmaintenanceThis is a TypeScript-based MCP server that provides integration with ERPNext/Frappe API. It enables AI assistants to interact with ERPNext data and functionality through the Model Context Protocol.6131MIT

Frappe MCPofficial
AlicenseNot gradedqualityFmaintenanceAllows Frappe Framework apps to function as MCP servers, exposing Python-defined tools for LLM interaction.171MIT- AlicenseNot gradedqualityDmaintenanceThis MCP server connects ChatGPT to ERPNext, enabling AI-powered business analytics, report generation, and document management.MIT
- AlicenseNot gradedqualityDmaintenanceA unified MCP server for querying and managing multiple database types (PostgreSQL, MySQL, SQL Server, etc.) via natural language through AI assistants.GPL 3.0