# NitroStack ⚡

**The enterprise-grade framework for building production-ready MCP servers with TypeScript.**

[![Website](https://img.shields.io/badge/Website-nitrostack.ai-blue?style=for-the-badge&logo=none)](https://nitrostack.ai)
[![Docs](https://img.shields.io/badge/Docs-docs.nitrostack.ai-brightgreen?style=for-the-badge&logo=none)](https://docs.nitrostack.ai)
[![Blog](https://img.shields.io/badge/Blog-blog.nitrostack.ai-orange?style=for-the-badge&logo=none)](https://blog.nitrostack.ai)
[![License](https://img.shields.io/badge/License-Apache%202.0-red?style=for-the-badge&logo=none)](https://opensource.org/licenses/Apache-2.0)

NitroStack is a powerful, decoupled toolkit designed to let you build, test, and ship Model Context Protocol (MCP) servers with minimal ceremony and maximum reliability.

---

## ⚡ Ecosystem Structure

NitroStack is modular. Install only what you need:

| Package | Purpose | Installation |
|:---|:---|:---|
| **[`@nitrostack/core`](./packages/core)** | **The Framework** - Decorators, dependency injection, and server logic. | `npm install @nitrostack/core` |
| **[`@nitrostack/cli`](./packages/cli)** | **The Tooling** - Scaffolding, dev server, and code generators. | `npm install -g @nitrostack/cli` |
| **[`@nitrostack/widgets`](./packages/widgets)** | **The UI** - React SDK for building interactive tool outputs. | `npm install @nitrostack/widgets` |

---

## 🚀 Quick Start in 30 Seconds

The fastest way to get started is by using the CLI to scaffold a new project.

### 1. Install Global CLI
```bash
npm install -g @nitrostack/cli
```

### 2. Scaffold Your Server
```bash
nitrostack-cli init my-server
```

![nitrocli init](assets/gif/nitrocli.gif)

### 3. Start Development
```bash
cd my-server
npm install
npm run dev
```

---

## 🎨 NitroStudio

NitroStudio is a desktop application for testing and debugging MCP servers. Simply open your project in the Studio—**it handles running the development server for you internally.**

![NitroStudio](assets/gif/nitrostudio-main.gif)

**[Download NitroStudio](https://nitrostack.ai/studio)**

- **Real-time testing**: Execute tools and inspect request/response payloads.

  ![Real-time testing](assets/gif/nitrostudio-testing.gif)

- **AI Chat**: Interact with your MCP server using a built-in AI assistant.

  ![AI Chat](assets/gif/nitrostudio-chat.gif)

- **Widget Preview**: Instantly visualize your interactive UI components.

---

## 📖 Learn More

- **[Official Documentation](https://docs.nitrostack.ai)** - Deep dives into server concepts, decorators, and implementation guides.
- **[Tutorials & Blog](https://blog.nitrostack.ai)** - Step-by-step guides for complex integrations and architectural patterns.
- **[Community & Support](https://nitrostack.ai/support)** - Get help from the team and other developers.

## 🤝 Contributing

We love contributions! Whether it's a bug fix, new feature, or documentation improvement, please check out our [Contributing Guide](./CONTRIBUTING.md) and [Architecture Overview](./ARCHITECTURE.md) to get started.

---

Built with ⚡ by the **NitroStack Team**.