使用说明

项目简介

mcp-confluent 是一个基于 Model Context Protocol (MCP) 构建的服务器实现，旨在为大型语言模型 (LLM) 客户端提供与 Confluent Kafka 和 Confluent Cloud REST API 交互的能力。它充当 LLM 客户端和 Confluent Cloud 之间的桥梁，允许 LLM 通过标准化的 MCP 协议访问和操作 Confluent Cloud 的资源。

主要功能点

资源访问: 允许 LLM 客户端安全访问 Confluent Cloud 中的 Kafka 主题、连接器、Schema Registry 等资源数据。
工具集成: 提供一系列预定义的工具，使 LLM 能够调用 Confluent Cloud API 执行特定操作，例如查询 Kafka 集群信息、管理连接器等。
标准化接口: 遵循 MCP 协议标准，通过 JSON-RPC 与客户端通信，确保与各种 MCP 客户端的兼容性。
易于配置: 通过环境变量进行配置，方便用户根据自身 Confluent Cloud 环境进行定制。
客户端支持: 提供与 Claude Desktop 和 Goose CLI 等流行 MCP 客户端的集成指南。

安装步骤

环境准备: 确保已安装 Node.js (推荐版本 22) 和 npm。推荐使用 NVM (Node Version Manager) 管理 Node.js 版本。
```
nvm install 22
nvm use 22
```

获取代码: 从 GitHub 仓库克隆代码到本地。

git clone https://github.com/confluentinc/mcp-confluent.git
cd mcp-confluent

安装依赖: 在项目根目录下运行 npm install 安装项目依赖。
```
npm install
```
配置环境变量: 复制 '.env' 文件示例并创建 '.env' 文件，根据您的 Confluent Cloud 环境填写必要的配置信息。
```
cp .env.example .env
# 编辑 .env 文件，填入您的 Confluent Cloud 凭证和连接信息
vi .env
```
需要配置的环境变量包括：
- 'BOOTSTRAP_SERVERS': Kafka 集群的 Bootstrap 服务器地址。
- 'KAFKA_API_KEY': Kafka 集群 API 密钥。
- 'KAFKA_API_SECRET': Kafka 集群 API 密钥Secret。
- 'KAFKA_REST_ENDPOINT': Kafka REST API 端点。
- 'CONFLUENT_CLOUD_API_KEY': Confluent Cloud API 密钥。
- 'CONFLUENT_CLOUD_API_SECRET': Confluent Cloud API 密钥 Secret。
- 'SCHEMA_REGISTRY_API_KEY': Schema Registry API 密钥。
- 'SCHEMA_REGISTRY_API_SECRET': Schema Registry API 密钥 Secret。
- 'CONFIG_PATH': (可选) 配置文件路径，用于会话持久化 (未来功能)。
构建项目: 运行 npm run build 或 npm run dev 构建项目。
```
npm run build
```
启动服务器: 运行 npm run start 启动 MCP 服务器。
```
npm run start
```
服务器默认通过 Stdio 协议与客户端通信。

服务器配置

要将此 MCP 服务器配置到 MCP 客户端（如 Claude Desktop 或 Goose CLI），您需要提供服务器的启动命令及其参数。以下是配置示例，请根据您的实际安装路径进行调整：

Claude Desktop 配置 (claude_desktop_config.json):

{
  "mcpServers": {
    "confluent": {
      "command": "node",
      "args": [
        "--env-file",
        "/path/to/mcp-confluent/.env",
        "/path/to/mcp-confluent/dist/index.js"
      ]
    }
  }
}

Goose CLI 配置 (goose configure 命令):

选择 "Add extension" -> "Command-line Extension" -> "mcp-confluent"，然后在配置命令时输入：

node --env-file /path/to/mcp-confluent/.env /path/to/mcp-confluent/dist/index.js

参数说明:

'command': MCP 服务器的启动命令，这里使用 'node' 运行 Node.js 程序。
'args': 启动命令的参数列表：
- '--env-file /path/to/mcp-confluent/.env': 指定环境变量配置文件路径。请替换为实际的 '.env' 文件路径。
- '/path/to/mcp-confluent/dist/index.js': 指定 MCP 服务器入口文件路径。请替换为实际的 'dist/index.js' 文件路径。

基本使用方法

启动 MCP 服务器: 按照上述安装步骤启动 mcp-confluent 服务器。
配置 MCP 客户端: 根据您使用的 MCP 客户端（如 Claude Desktop、Goose CLI）的文档，配置连接到本地运行的 mcp-confluent 服务器。
使用 MCP 客户端: 通过 MCP 客户端的界面，您可以利用 mcp-confluent 服务器提供的工具和资源与 Confluent Cloud 进行交互。具体操作取决于您使用的 MCP 客户端的功能。

关键词