# UploadKit MCP server

> Provides AI coding assistants with comprehensive knowledge of UploadKit's React components, Next.js scaffolding, and storage configurations.

- Repository: https://github.com/drumst0ck/uploadkit
- Page: https://hostedmcp.org/servers/drumst0ck/uploadkit
- Transport: stdio
- Stars: 3
- License: MIT
- Latest version: 0.3.1

## Install

### Claude Code

```sh
claude mcp add uploadkit -- npx -y @uploadkitdev/mcp
```

### Cursor (`~/.cursor/mcp.json`)

```json
{
  "mcpServers": {
    "uploadkit": {
      "command": "npx",
      "args": [
        "-y",
        "@uploadkitdev/mcp"
      ]
    }
  }
}
```

### VS Code (`.vscode/mcp.json`)

```json
{
  "servers": {
    "uploadkit": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "@uploadkitdev/mcp"
      ]
    }
  }
}
```

### VS Code CLI

```sh
code --add-mcp '{"name":"uploadkit","type":"stdio","command":"npx","args":["-y","@uploadkitdev/mcp"]}'
```

### Claude Desktop (`claude_desktop_config.json`)

```json
{
  "mcpServers": {
    "uploadkit": {
      "command": "npx",
      "args": [
        "-y",
        "@uploadkitdev/mcp"
      ]
    }
  }
}
```

### Codex

```sh
codex mcp add uploadkit -- npx -y @uploadkitdev/mcp
```

### Codex config.toml (`~/.codex/config.toml`)

```toml
[mcp_servers.uploadkit]
command = "npx"
args = ["-y", "@uploadkitdev/mcp"]
```

### Gemini CLI

```sh
gemini mcp add -s user uploadkit npx -- -y @uploadkitdev/mcp
```

### Gemini settings.json (`~/.gemini/settings.json`)

```json
{
  "mcpServers": {
    "uploadkit": {
      "command": "npx",
      "args": [
        "-y",
        "@uploadkitdev/mcp"
      ]
    }
  }
}
```

## Tools (11)

- `list_components`: List every component available in @uploadkitdev/react. Optionally filter by category (classic, dropzone, button, progress, motion, specialty, gallery). Use this before suggesting a component so you pick one that actually exists.
- `get_component`: Return full metadata + a ready-to-paste usage example for a specific UploadKit component.
- `search_components`: Fuzzy-search components by keyword, inspiration, or use case (e.g. "terminal", "apple", "progress ring", "kanban").
- `get_install_command`: Return the install command for UploadKit packages. Defaults to pnpm + the full stack (react + next).
- `scaffold_route_handler`: Generate the file content for a Next.js App Router route handler at app/api/uploadkit/[...uploadkit]/route.ts — with a file router typed to your route name.
- `scaffold_provider`: Return a ready-to-paste snippet that adds <UploadKitProvider> to the Next.js root layout.
- `get_byos_config`: Return environment + handler configuration for Bring-Your-Own-Storage mode with S3, R2, GCS, or Backblaze B2. Credentials never reach the browser.
- `get_quickstart`: Full end-to-end quickstart guide for UploadKit on Next.js.
- `search_docs`: Full-text search across every UploadKit docs page (88+ pages: getting-started, core-concepts, SDK reference, API reference, dashboard, guides). Use this whenever the user asks about UploadKit behaviour, APIs, middleware, webhooks, theming, BYOS, type safety, or any topic not covered by the component tools. Returns ranked matches with title, URL, snippet, and path.
- `get_doc`: Return the full content of a docs page by path (e.g. "core-concepts/byos", "sdk/next/middleware", "api-reference/rest-api"). Use this after search_docs to read a specific page in depth.
- `list_docs`: List every docs page with title, description, URL, and path. Use this to discover what documentation is available before searching.

## FAQ

### How do I install the UploadKit MCP server?

You can run it locally using npx by adding it to your MCP client configuration with the command `npx -y @uploadkitdev/mcp`.

### Does this server require an API key?

No, the server runs locally via npx without requiring any configuration or API keys.

### Can I use this with remote clients like Claude.ai web?

Yes, UploadKit exposes a Streamable HTTP endpoint for clients that cannot spawn npx processes.

### What storage providers can I configure using BYOS?

You can configure Bring Your Own Storage (BYOS) for S3, R2, GCS, or Backblaze B2.
