MCP Confluent

🚀 MCP服務器開發指南

本指南旨在幫助開發者搭建和運行MCP服務器，詳細介紹了環境變量配置、項目結構、構建與運行步驟、測試方法以及貢獻方式。

🚀 快速開始

要快速啟動MCP服務器，需完成環境變量配置、安裝依賴、構建項目並啟動服務器。以下是簡要步驟：

1. 配置環境變量，可參考.env文件示例。
2. 安裝項目依賴：npm install
3. 進行生產構建：npm run build
4. 啟動服務器：npm run start

✨ 主要特性

• 環境變量管理：通過配置關鍵環境變量，實現身份驗證和目標集群指定。
• 清晰的項目結構：源代碼、編譯輸出、配置文件等各部分組織明確。
• 靈活的構建與運行方式：支持開發模式和生產構建，方便不同場景使用。
• 豐富的測試手段：可使用MCP Inspector進行測試，也能添加新工具進行功能擴展。

📦 安裝指南

安裝依賴

在項目根目錄下執行以下命令安裝項目所需的依賴：

npm install

開發模式

若要在開發過程中即時監控代碼變更並自動重新構建，可執行以下命令：

npm run dev

此命令會將TypeScript代碼編譯為JavaScript，並在檢測到src/目錄中的更改時自動重新構建。

生產構建

進行一次性編譯，將TypeScript代碼轉換為JavaScript，可執行以下命令：

npm run build

啟動服務器

完成構建後，啟動MCP服務器，執行以下命令：

npm run start

💻 使用示例

基礎用法

配置環境變量

以下是運行MCP服務器所需的關鍵環境變量：

項目結構

/
├── src/                 # 源代碼目錄
│   ├── confluent/       # Confluent相關代碼（API客戶端等）
│   ├── tools/           # 工具實現（每個工具單獨文件）
│   ├── index.ts         # 服務器主入口點
│   └── ...              # 其他服務器邏輯、公用事業等
├── dist/                # 編譯輸出目錄（TypeScript轉為JavaScript）
├── openapi.json         # Confluent Cloud的OpenAPI規範
├── .env                 # 環境變量配置文件（示例 - 應該複製並填寫）
├── README.md            # 本文件
└── package.json         # Node.js項目元數據和依賴項

高級用法

使用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