Skip to content

feat: allow DATABRICKS_MCP_CLIENT env var to override product name in user-agent #559

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
j-underdown wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: allow DATABRICKS_MCP_CLIENT env var to override product name in user-agent #559

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 19 additions & 2 deletions databricks-tools-core/databricks_tools_core/identity.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,26 @@
Resources created by the MCP server are also tagged with project metadata
and any freeform tags defined in ``.databricks-ai-dev-kit.yaml``.

Example user-agent string::
The product name can be overridden via the ``DATABRICKS_MCP_CLIENT`` environment
variable. This allows organisations running the MCP server from multiple AI
clients (Claude Code, Codex, Cursor, etc.) to distinguish traffic in Databricks
audit logs and SQL warehouse query history without maintaining a fork.

Example user-agent strings::

databricks-ai-dev-kit/0.1.0 databricks-sdk-py/0.73.0 python/3.11.13 os/darwin auth/pat project/my-repo
my-org-claude-code/0.1.0 databricks-sdk-py/0.73.0 python/3.11.13 os/darwin auth/pat project/my-repo

Setting ``DATABRICKS_MCP_CLIENT`` per client:

Claude Code (``~/.claude.json`` MCP server env block)::

"env": { "DATABRICKS_MCP_CLIENT": "my-org-claude-code" }

Codex (``~/.codex/config.toml``)::

[mcp_servers.databricks.env]
DATABRICKS_MCP_CLIENT = "my-org-codex"

Example config file (``.databricks-ai-dev-kit.yaml`` at repo root)::

Expand All @@ -32,7 +49,7 @@

logger = logging.getLogger(__name__)

PRODUCT_NAME = "databricks-ai-dev-kit"
PRODUCT_NAME = os.environ.get("DATABRICKS_MCP_CLIENT", "databricks-ai-dev-kit")

DESCRIPTION_FOOTER = "Built with Databricks AI Dev Kit"

Expand Down