<div align="center">
  <a href="https://xmcp.dev">
    <picture>
      <source media="(prefers-color-scheme: dark)" srcset="https://assets.basehub.com/bf7c3bb1/303b8a62053c9d86ca3b972b5597ab5c/x.png">
      <img alt="xmcp logo" src="https://assets.basehub.com/bf7c3bb1/303b8a62053c9d86ca3b972b5597ab5c/x.png" height="128">
    </picture>
  </a>
  <h1>xmcp</h1>

<a href="https://basement.studio"><img alt="xmcp logo" src="https://img.shields.io/badge/MADE%20BY%20basement.studio-000000.svg?style=for-the-badge&labelColor=000"></a>
<a href="https://www.npmjs.com/package/create-xmcp-app"><img alt="NPM version" src="https://img.shields.io/npm/v/xmcp.svg?style=for-the-badge&labelColor=000000"></a>
<a href="https://github.com/basementstudio/xmcp/blob/main/license.md"><img alt="License" src="https://img.shields.io/npm/l/xmcp.svg?style=for-the-badge&labelColor=000000"></a>

</div>

# create-xmcp-app

The easiest way to get started with `xmcp` is by using `create-xmcp-app`. This CLI tool allows you to scaffold a template project with all the necessary files and dependencies to get you up and running quickly.

## Usage

```bash
npx create-xmcp-app@latest
```

You will be asked for the project name and then guided through a series of prompts to configure your project.

To scaffold without installing dependencies:

```bash
npx create-xmcp-app@latest my-app --skip-install
```

## Options

- `-y, --yes`: Skip all confirmation prompts and use defaults
- `--use-npm`: Use npm as package manager (default)
- `--use-yarn`: Use yarn as package manager
- `--use-pnpm`: Use pnpm as package manager
- `--use-bun`: Use bun as package manager
- `--skip-install`: Skip installing dependencies
- `--http`: Enable HTTP transport
- `--stdio`: Enable STDIO transport
- `--ui`: Initialize with MCP App template (non-tailwind)
- `--ui-kit`: Initialize with MCP App template and @xmcp-dev/ui starter files
- `--tailwind, --tw`: Use Tailwind CSS (only with MCP App template)

Use `--ui-kit` when you want the MCP App template to start with
`@xmcp-dev/ui`, Tailwind, a schema-driven `renderJson` tool, and a small
handwritten React MCP App. The generated config enables tools and resources,
including the `skill://xmcp-ui/schema-reference` resource used by the renderer
tool description. You can also select **MCP App with UI kit** in the
interactive template prompt. The starter places `globals.css` at the project
root, matching the Tailwind MCP App template. It includes shadcn CLI configuration,
package imports, and shared theme styles, so you can run
`pnpm dlx shadcn@latest add button card dialog` from the generated project.

## Getting Started

- Visit [xmcp.dev](https://xmcp.dev) to learn more about the project.
- Visit [xmcp.dev/docs](https://xmcp.dev/docs) to view the full documentation.

## License

This project is licensed under the MIT License - see the [LICENSE](<[LICENSE](https://github.com/basementstudio/xmcp/blob/main/license.md)>) file for details.
