Skip to content

CHANGELOG.md

Latest commit

 

History

History
118 lines (84 loc) · 7.04 KB

CHANGELOG.md

File metadata and controls

118 lines (84 loc) · 7.04 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

Unreleased

Changed

  • Connection failures now log actionable hints for common misconfigurations (native TCP port used instead of the HTTP interface, TLS/CLICKHOUSE_SECURE mismatches), and a warning is logged when CLICKHOUSE_PORT is set to a native protocol port (9000/9440). (#102)

0.4.1 - 2026-07-17

Changed

  • Added FastMCP server-level instructions that point agents to official ClickHouse Agent Skills (replacing tool-based advisory guidance).

0.4.0 - 2026-06-03

Added

  • Support for FastMCP OAuth/OIDC auth providers on HTTP/SSE transports via the FASTMCP_SERVER_AUTH environment variable (e.g. Azure Entra, Google, GitHub, WorkOS). Static token, FastMCP OAuth, and disabled mode are now mutually exclusive; configure exactly one. (#171)
  • Official multi-arch Docker images published to GitHub Container Registry on each release: ghcr.io/clickhouse/mcp-clickhouse:vX.Y.Z, :X.Y, and :latest.

Changed

  • /health endpoint is now unauthenticated across all auth modes (previously gated only under static-token mode, which was asymmetric and incompatible with redirect-based OAuth providers). Response bodies trimmed to OK / generic error strings to avoid leaking ClickHouse version information or connection exception details; underlying errors are logged server-side.

Fixed

  • Tool responses now return JSON-encoded strings, avoiding MCP protocol validation errors on successful queries. (#154)
  • Long-running queries no longer block other tool calls. The MCP-facing run_query and run_chdb_select_query tools now await their thread-pool futures asynchronously, so concurrent tool calls are served while a slow query is in flight. (#128)

0.3.0 - 2026-04-14

Added

  • SNI override support via CLICKHOUSE_SNI environment variable for connections behind proxies or load balancers. (#127)
  • Lazy-load chdb to avoid ~80-100 MB memory overhead when the feature is disabled. (#144)
  • Made chdb an optional dependency for Windows compatibility. (#145)
  • Optional write access mode via CLICKHOUSE_WRITE_ACCESS environment variable, with built-in DROP and TRUNCATE protection. (#93)
  • Client config override support through MCP Context session states, enabling dynamic connection switching at runtime. (#115)
  • Custom middleware injection via CLICKHOUSE_MCP_MIDDLEWARE environment variable for hooking into the MCP server lifecycle. Includes an example middleware module. (#114)

0.2.0 - 2026-01-28

Added

  • Basic authentication support for HTTP/SSE transport. (#113)

0.1.13 - 2025-12-16

Added

  • CLICKHOUSE_ROLE support for setting a ClickHouse role on connections. (#103)
  • Paginated list_tables output. (#92)

Changed

  • Switched to OS truststore libraries. (#91)
  • Made query timeout duration configurable. (#89)
  • Explicitly set interface based on secure value. (#87)
  • Switched Docker image to Alpine for smaller footprint. (#86)

0.1.12 - 2025-09-15

Changed

  • Refactored chDB prompt to avoid context-too-large errors. (#75)
  • Upgraded dependencies. (#66)

Added

  • Instructions for running without uv. (#65)
  • Configurable bind host and port via environment variables. (#64)
  • chDB support for local ClickHouse queries. (#51)

0.1.9 - 2025-06-24

Changed

  • Migrated to fastmcp for more active upstream maintenance. (#59)

0.1.8 - 2025-06-16

Added

  • Token-efficient result encoding to reduce context usage. (#55)
  • Dockerfile for containerized deployment. (#54)
  • CLICKHOUSE_PROXY_PATH environment variable for proxy path support. (#52)

0.1.5 - 2025-03-21

Added

  • Tool descriptions for AWS Bedrock compatibility. (#23)
  • Support for parameterized views in list_tables with optimized row counts via system schema.
  • total_rows and column_count fields in list_tables output. (#32)

Fixed

  • Respect server readonly settings and improve query handling. (#35)
  • Ensure .env loaded before config init during mcp dev startup. (#30)
  • Prevent BrokenResourceError by returning structured responses for query errors. (#26)

0.1.3 - 2025-02-20

Added

  • client_name identification header (mcp_clickhouse). (#21)
  • Query timeout and thread pool for SELECT queries. (#20)
  • Gather comments from ClickHouse tables for richer metadata. (#13)
  • PyPI publish GitHub Action. (#19)

Fixed

  • Escape strings and identifiers in generated queries. (#14)

Changed

  • Bundle system certificates as part of the MCP server. (#15)
  • Upgraded to official MCP SDK's FastMCP. (#17)

0.1.1 - 2025-02-20

Added

  • Comprehensive environment configuration handling. (#11)
  • PyPI integration. (#6)

0.1.0 - 2024-12-24

Added

  • Initial release of mcp-clickhouse.
  • MCP server with run_select_query, list_databases, list_tables tools.
  • ClickHouse connection via clickhouse-connect.
  • CI test suite.
  • Apache v2 license.