@k1ssh/qbot-init-project/README.md

Initialize a project for microservices

# qbot-init-project

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

AI Tool that initialize a project for microservices with [Agentico](https://agentico.dev) SDK.

This is a TypeScript-based MCP Tool that creates the structure for a new microservices project managed by [QBot](https://k1s.sh/qbot). It includes the MCP server in case you want to test it locally with Claude Desktop, but usually.

- The tool can be integrated with other tools to create a more complex MCP server. For instance, QBot Engine uses multiple tools to process a single task. Read more about the [QBot Engine](https://k1s.sh/qbot) and the [QBot Tools](https://k1s.sh/qbot/tools).
- A simple MCP server that illustrates the simplicity of the Agentico pattern.

## Features

### Tools
- `InitProject` - creates a new project with a directory structure and configuration files aligned with a `helm` Chart and Kubernetes `kustomize` setup described in the [QBot project](https://k1s.sh/qbot).
  - Takes the project name and an optional environment name to use by default.

### Resources
- Not yet implemented.

### Prompts
- Not yet implemented.

Any feedback or contributions are welcome. Go Rebels! ✊🏻

For more details, visit the [Documentation](https://agentico.dev/docs), the [GitHub repository](https://github.com/agentico/mcp-server) or [npm package page](https://www.npmjs.com/package/@agentico/mcp-server).

With ❤️ from [La Rebelion Labs](https://rebelion.la). 🚀

## Development

Install dependencies:
```bash
npm install
```

Build the server:
```bash
npm run build
```

For development with auto-rebuild:
```bash
npm run watch
```

## Installation

To use with Claude Desktop, add the server config:

On MacOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
On Windows: `%APPDATA%/Claude/claude_desktop_config.json`

You can configure your tool depending on how you want to run it:

### `node`

```json
{
  "mcpServers": {
    "init-project": {
      "command": "node",
      "args": [ "/path/to/init-project/build/index.js" ]      
    }
  }
}
```

### `npx`

Install the package globally:

```bash
npm install -g @k1ssh/qbot-init-project
```

Then, configure the server:

```json
{
  "mcpServers": {
    "init-project": {
      "command": "npx",
      "args": [ "qbot-init-project" ]
    }
  }
}
```

### `bun`

```json
{
  "mcpServers": {
    "init-project": {
      "command": "bun",
      "args": [ "/path/to/init-project/index.ts" ]
    }
  }
}
```

### Debugging

Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector), which is available as a package script:

```bash
npm run inspector
```

The Inspector will provide a URL to access debugging tools in your browser.

## License

This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.

## Acknowledgments

- [Helm](https://helm.sh/)
- [Kubernetes](https://kubernetes.io/)
- [Bitnami](https://bitnami.com/)
- ["La Rebelion" GitHub](https://github.com/la-rebelion/)
- ["La Rebelion" Website](https://rebelion.la/)
- [Agentico](https://agentico.com/)
- [Agentico GitHub](https://github.com/agentico-dev/)
- [K1s](https://k1s.sh/), simplifying Kubernetes for developers.