MCP Confluent

🚀 MCP Server Development Guide

This guide provides a comprehensive overview of developing an MCP server, including environment variable configuration, project structure, building and running procedures, testing guidelines, and contribution instructions.

🚀 Quick Start

Environment Variable Configuration

The following are the key environment variables required to run the MCP server:

• MCP_API_KEY: API key for authentication
• MCP_API_SECRET_KEY: Private secret key corresponding to the API key
• MCP_CLUSTER_ID: Unique identifier of the target cluster
• CONFLUENT_CLOUD_ENDPOINT: The .endpoint address of the Confluent Cloud service

Project Structure

/
├── src/                 # Source code directory
│   ├── confluent/       # Confluent-related code (API client, etc.)
│   ├── tools/           # Tool implementations (each tool in a separate file)
│   ├── index.ts         # Server main entry point
│   └── ...              # Other server logic, utilities, etc.
├── dist/                # Compilation output directory (TypeScript to JavaScript)
├── openapi.json         # OpenAPI specification for Confluent Cloud
├── .env                 # Environment variable configuration file (example - should be copied and filled)
├── README.md            # This file
└── package.json         # Node.js project metadata and dependencies

Building and Running

1. Install dependencies:

npm install

2. Development mode (monitor code changes):

npm run dev

This command compiles TypeScript code to JavaScript and automatically rebuilds when changes in the src/ directory are detected. 3. Production build (one-time compilation):

npm run build

4. Start the server:

npm run start

💻 Usage Examples

Testing with MCP Inspector

To test the MCP server, you can use MCP Inspector, an interactive development tool for testing and debugging MCP servers.

# Ensure the project has been run in development or build mode
npx @modelcontextprotocol/inspector node $PATH_TO_PROJECT/dist/index.js --env-file $PATH_TO_PROJECT/.env

Adding New Tools

1. Add a new enum value to the ToolName enum class.
2. Add the new tool to the handle mapping of the ToolFactory class.
3. Create a new file and export a new class that inherits from BaseToolHandler:
   1. Implement the handle method of the base class.
   2. Implement the getToolConfig method of the base class.
4. After completion, add the new tool to the enabledTools set in the index.ts file.

Type Generation

# Note: Due to a bug related to allOf and required in version 7.5.2, use the --empty-objects-unknown flag to avoid it
npx openapi-typescript ./openapi.json -o ./src/confluent/openapi-schema.d.ts --empty-objects-unknown

🤝 Contribution Guide

We welcome issue reports and technical feedback. Please submit them in the form of GitHub Issues. For contribution guidelines, please refer to CONTRIBUTING.md