mcp-confluent/.env.example at main · confluentinc/mcp-confluent · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# =============================================================================
# Confluent MCP Server - Environment Configuration (LEGACY)
# =============================================================================
# YAML is now the preferred configuration path; see CONFIGURATION.md and run
# `npx @confluentinc/mcp-confluent --init-config` to bootstrap one.
#
# This file remains supported during the deprecation window for users on the
# legacy env-var-only path. It is also useful as a source of `${VAR}` values
# that a `config.yaml` references via interpolation — that role is long-term
# supported even after the env-var-only config path retires.
#
# Copy this file to .env and fill in the values for your Confluent Cloud
# environment. Only the variables relevant to the tools you want to use need
# to be set.
# =============================================================================

# -----------------------------------------------------------------------------
# Kafka Configuration
# -----------------------------------------------------------------------------
BOOTSTRAP_SERVERS=""
KAFKA_API_KEY=""
KAFKA_API_SECRET=""
KAFKA_REST_ENDPOINT=""
KAFKA_CLUSTER_ID=""
KAFKA_ENV_ID="env-"

# -----------------------------------------------------------------------------
# Flink Configuration
# -----------------------------------------------------------------------------
FLINK_ENV_ID="env-"
FLINK_ORG_ID=""
FLINK_REST_ENDPOINT=""
FLINK_CATALOG_NAME=""
FLINK_DATABASE_NAME=""
FLINK_API_KEY=""
FLINK_API_SECRET=""
FLINK_COMPUTE_POOL_ID="lfcp-"

# -----------------------------------------------------------------------------
# Schema Registry Configuration
# -----------------------------------------------------------------------------
SCHEMA_REGISTRY_API_KEY=""
SCHEMA_REGISTRY_API_SECRET=""
SCHEMA_REGISTRY_ENDPOINT=""

# -----------------------------------------------------------------------------
# Confluent Cloud API (required for cloud management tools)
# -----------------------------------------------------------------------------
CONFLUENT_CLOUD_API_KEY=""
CONFLUENT_CLOUD_API_SECRET=""
CONFLUENT_CLOUD_REST_ENDPOINT="https://api.confluent.cloud"

# -----------------------------------------------------------------------------
# Tableflow Configuration
# -----------------------------------------------------------------------------
TABLEFLOW_API_KEY=""
TABLEFLOW_API_SECRET=""

# -----------------------------------------------------------------------------
# Telemetry / Metrics API (Confluent Cloud)
# Optional. TELEMETRY_API_KEY / TELEMETRY_API_SECRET fall back to
# CONFLUENT_CLOUD_API_KEY / CONFLUENT_CLOUD_API_SECRET when unset.
# TELEMETRY_ENDPOINT defaults to https://api.telemetry.confluent.cloud.
# Set these only when you want to use a separate (e.g. least-privilege,
# metrics-only) API key.
# -----------------------------------------------------------------------------
# TELEMETRY_ENDPOINT="https://api.telemetry.confluent.cloud"
# TELEMETRY_API_KEY=""
# TELEMETRY_API_SECRET=""

# -----------------------------------------------------------------------------
# MCP Server Settings
# -----------------------------------------------------------------------------
# LOG_LEVEL="info"                          # trace, debug, info, warn, error, fatal
# HTTP_PORT=8080                            # Port for HTTP transport
# HTTP_HOST="127.0.0.1"                     # Host to bind for HTTP transport
# HTTP_MCP_ENDPOINT_PATH="/mcp"             # HTTP endpoint path
# SSE_MCP_ENDPOINT_PATH="/sse"              # SSE endpoint path
# SSE_MCP_MESSAGE_ENDPOINT_PATH="/messages" # SSE message endpoint path

# -----------------------------------------------------------------------------
# Anonymous Usage Analytics
# This MCP server's own anonymous-usage opt-out (unrelated to the
# TELEMETRY_* block above, which configures the Confluent Cloud Metrics API).
# See README "Telemetry" section for what is collected.
# -----------------------------------------------------------------------------
# DO_NOT_TRACK=true

# -----------------------------------------------------------------------------
# MCP Server Authentication (required for HTTP/SSE transports)
# Generate a key with: npx @confluentinc/mcp-confluent --generate-key
# -----------------------------------------------------------------------------
# MCP_API_KEY=""
# MCP_AUTH_DISABLED=false                   # WARNING: Only set to true in development
# MCP_ALLOWED_HOSTS="localhost,127.0.0.1"   # DNS rebinding protection