Unleash MCP

🚀 Unleash MCP Server

An implementation of the Model Context Protocol (MCP) server integrated with the Unleash feature toggle system.

📚 Table of Contents

• Requirements
• Installation
• Architecture
• Configuration
• Development
• Contributing
• License

📋 Requirements

• Node.js (v18 or higher)
• TypeScript (v5.0 or higher)
• Access to an Unleash server instance

📦 Installation

# Install dependencies
npm i

🏗️ Architecture

The Unleash MCP server acts as a bridge between LLM applications and the Unleash feature flag system:

+----------------+      +-------------------+      +----------------+
|                |      |                   |      |                |
|  LLM App       | <--> |  Unleash MCP      | <--> |  Unleash API   |
|  (MCP Client)  |      |  Server           |      |  Server        |
|                |      |                   |      |                |
+----------------+      +-------------------+      +----------------+

⚙️ Configuration

Project Structure

unleash-mcp-server/
├── src/
│   ├── index.ts              # Main entry point
│   ├── server.ts             # Server implementation
│   ├── config.ts             # Configuration handling
│   ├── transport/            # MCP transport implementation
│   │   ├── http.ts           # HTTP/SSE transport
│   │   └── stdio.ts          # STDIO transport
│   ├── unleash/              # Unleash API client implementation
│   │   ├── unleash-client.ts # Main Unleash client
│   │   ├── get-feature-flag.ts
│   │   └── get-feature-flag.ts
│   ├── mcp-transport.ts      # MCP transport abstraction layer
│   └── server.ts             # Server main logic
├── package.json              # Project dependencies and scripts
└── README.md                 # Project documentation

💻 Development

Coding Standards

1. File Naming: Use lowercase letters and hyphens (-), e.g., server.ts.
2. Directory Structure: Follow a clear hierarchical structure, such as src/config and src/transport.
3. Code Style: Adopt consistent indentation (4 spaces) and code formatting.

Build

# Install dependencies
npm install

# Start the development server
npm start

🤝 Contributing

Contributions are welcome! Feel free to submit a Pull Request.

🌟 Support the Project

If you find this project helpful, please consider supporting my development!

Scan the QR code above or click here to buy a coffee for this project.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.