MCP 服务器开发指南

环境变量配置

以下是运行MCP服务器所需的关键环境变量：

• MCP_API_KEY：用于身份验证的API密钥
• MCP_API_SECRET_KEY：与API密钥对应的私有秘钥
• MCP_CLUSTER_ID：目标集群的唯一标识符
• CONFLUENT_CLOUD_ENDPOINT：Confluent Cloud服务的.endpoint地址

项目结构

/
├── src/                 # 源代码目录
│   ├── confluent/       # Confluent相关代码（API客户端等）
│   ├── tools/           # 工具实现（每个工具单独文件）
│   ├── index.ts         # 服务器主入口点
│   └── ...              # 其他服务器逻辑、公用事业等
├── dist/                # 编译输出目录（TypeScript转为JavaScript）
├── openapi.json         # Confluent Cloud的OpenAPI规范
├── .env                 # 环境变量配置文件（示例 - 应该复制并填写）
├── README.md            # 本文件
└── package.json         # Node.js项目元数据和依赖项

构建与运行

1. 安装依赖：

   npm install
   

2. 开发模式（监控代码变更）：

   npm run dev
   

   该命令将编译TypeScript代码为JavaScript，并在检测到src/目录中的更改时自动重新构建。

3. 生产构建（一次性编译）：

   npm run build
   

4. 启动服务器：

   npm run start
   

测试指南

使用MCP Inspector测试

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

# 确保已经以开发或构建模式运行过项目
npx @modelcontextprotocol/inspector node $PATH_TO_PROJECT/dist/index.js --env-file $PATH_TO_PROJECT/.env

添加新工具

1. 在枚举类ToolName中添加一个新的枚举值。
2. 将新的工具添加到ToolFactory类的句柄映射中。
3. 创建一个新的文件，导出一个继承自BaseToolHandler的新类：
   1. 实现基类的handle方法。
   2. 实现基类的getToolConfig方法。
4. 完成后，在index.ts文件中的enabledTools集合中添加新的工具。

类型生成

# 注意：由于版本7.5.2中存在一个与allOf和required相关的bug，需要使用--empty-objects-unknown标志来避免它
npx openapi-typescript ./openapi.json -o ./src/confluent/openapi-schema.d.ts --empty-objects-unknown

贡献指南

欢迎提交问题报告和技术反馈，请以GitHub Issues的形式提出。有关贡献指南，请参阅CONTRIBUTING.md