mcp-confluent

mcp-汇合

一个 MCP 服务器实现，使 AI 助手能够与 Confluent Cloud REST API 交互。该服务器允许 Claude Desktop 和 Goose CLI 等 AI 工具通过自然语言交互来管理 Kafka 主题、连接器和 Flink SQL 语句。

演示

Goose 命令行界面

克劳德桌面

目录

• mcp-汇合
  • 演示
    • Goose 命令行界面
    • 克劳德桌面
  • 目录
  • 用户指南
    • 入门
    • 配置
    • 环境变量参考
    • 用法
    • 配置 Claude 桌面
    • 配置 Goose CLI
  • 开发者指南
    • 项目结构
    • 构建和运行
    • 测试
      • MCP 检查器
    • 添加新工具
    • 生成类型
    • 贡献

用户指南

入门

1. **创建.env文件：**将示例.env文件结构（如下所示）复制到项目根目录中名为.env的新文件中。
2. **填充.env文件：**填写 Confluent Cloud 环境所需的值。有关每个变量的详细信息，请参阅配置部分。
3. 安装 Node.js （如果尚未安装）
   • 我们建议使用NVM （Node 版本管理器）来管理 Node.js 版本
   • 安装并使用 Node.js：
   nvm install 22 nvm use 22

配置

在项目的根目录中创建一个.env文件，其配置如下：

环境变量参考

用法

此 MCP 服务器设计用于与各种 MCP 客户端配合使用，例如 Claude Desktop 或 Goose CLI/Desktop。具体配置和交互方式取决于您使用的客户端。但一般步骤如下：

1. **构建：**按照开发者指南中的说明从源代码构建并运行服务器。这通常涉及：
   • 安装依赖项（ npm install ）
   • 构建项目（ npm run build或npm run dev ）
2. **配置您的 MCP 客户端：**每个客户端都有其自身的方式来指定 MCP 服务器的地址和所需的凭据。您需要配置您的客户端（例如 Claude、Goose）以连接到该服务器运行的地址（可能是带有特定端口的localhost ）。服务器运行的端口可以通过环境变量进行配置。
3. **启动 MCP 客户端：**将客户端配置为连接到 MCP 服务器后，即可启动 MCP 客户端。启动时，它会在本地创建一个 MCP 服务器实例。该实例将负责管理数据模式并代表您与 Confluent Cloud 进行交互。
4. **通过客户端与 Confluent 交互：**客户端连接后，您可以使用客户端界面与 Confluent Cloud 资源进行交互。客户端会向 MCP 服务器发送请求，然后 MCP 服务器会代表您与 Confluent Cloud 进行交互。

配置 Claude 桌面

有关安装 Claude Desktop 和 MCP 服务器的更多详细信息，请参阅此处。

要配置 Claude Desktop 以使用此 MCP 服务器：

1. 打开 Claude 桌面配置
   • 在 Mac 上： ~/Library/Application Support/Claude/claude_desktop_config.json
   • 在 Windows 上： %APPDATA%\Claude\claude_desktop_config.json
2. 编辑配置文件
   • 在您喜欢的文本编辑器中打开配置文件
   • 使用以下方法之一添加或修改配置：
   { "mcpServers": { "confluent": { "command": "node", "args": [ "/path/to/confluent-mcp-server/dist/index.js", "--env-file", "/path/to/confluent-mcp-server/.env", ] } } }
   { "mcpServers": { "confluent": { "command": "npx", "args": [ "-y" "@confluentinc/mcp-confluent", "-e", "/path/to/confluent-mcp-server/.env" ] } } }

   将/path/to/confluent-mcp-server/替换为您安装此 MCP 服务器的实际路径。

3. 重启Claude桌面
   • 关闭并重新打开 Claude Desktop 以使更改生效
   • Claude Desktop 启动时，MCP 服务器将自动启动

现在，Claude Desktop 将配置为使用您的本地 MCP 服务器进行 Confluent 交互。

配置 Goose CLI

有关如何安装 Goose CLI 的详细说明，请参阅此处。

安装后，请按照以下步骤操作：

1. 运行配置命令：
   goose configure
2. 按照交互式提示进行操作：
   • 选择Add extension
   • 选择Command-line Extension
   • 输入mcp-confluent作为扩展名称
   • 选择以下配置方法之一：
   node /path/to/confluent-mcp-server/dist/index.js --env-file /path/to/confluent-mcp-server/.env
   npx -y @confluentinc/mcp-confluent -e /path/to/confluent-mcp-server/.env

将/path/to/confluent-mcp-server/替换为您安装此 MCP 服务器的实际路径。

开发者指南

项目结构

构建和运行

1. 安装依赖项：
   npm install
2. 开发模式（注意变化）：
   npm run dev
   此命令将 TypeScript 代码编译为 JavaScript，并在src/目录中检测到更改时自动重建。
3. 生产构建（一次性编译）：
   npm run build
4. 启动服务器：
   npm run start

测试

MCP 检查器

要测试 MCP 服务器，您可以使用MCP Inspector ，这是一个用于测试和调试 MCP 服务器的交互式开发工具。

添加新工具

1. 向枚举类ToolName添加一个新枚举。
2. 将您的新工具添加到ToolFactory类中的处理程序映射中。
3. 创建一个新文件，导出扩展BaseToolHandler类。
   1. 实现基类的handle方法。
   2. 实现基类的getToolConfig方法。
4. 一旦满意，就将其添加到index.ts中的enabledTools集合中。

生成类型

贡献

欢迎通过 Github Issues 提交 Bug 报告和反馈。贡献指南请参阅CONTRIBUTING.md