Provides AI coding assistants with comprehensive knowledge of UploadKit's React components, Next.js scaffolding, and storage configurations.
Also known as drumst0ck/uploadkit, @uploadkitdev/mcp
- Stars
- 3
- Tools
- 11
- Downloads, 30 days
- —
- Latest version
- 0.3.1
- Last commit
- Nov 4, 2026
- License
- MIT
What is UploadKit MCP?
UploadKit provides AI coding assistants with comprehensive knowledge of UploadKit's React components, Next.js scaffolding, and storage configurations. It exposes 11 tools, such as list_components, get_component, search_components.
Summary generated from the project's README
About UploadKit MCP server
Giving AI coding assistants direct access to UploadKit documentation allows developers to integrate file uploading features into React and Next.js applications more efficiently. This server provides detailed information on over 40 React components, including their categories and usage patterns. It helps users implement specific UI elements like animated dropzones or progress indicators by providing metadata and code examples.
Developers can run this server locally using npx with clients like Claude Code, Cursor, Windsurf, or Zed. It requires no API keys or initial configuration for local use. For web-based clients that cannot execute local commands, a remote HTTP endpoint is available. The toolset includes functions to scaffold Next.js route handlers, wire the UploadKitProvider into layouts, and retrieve specific installation commands for various package managers.
Beyond UI components, the server assists with backend setup by providing configurations for Bring Your Own Storage (BYOS) options such as S3, R2, GCS, or Backblaze B2. It simplifies complex tasks like generating the app/api/uploadkit route handler or setting up end-to-end quickstart guides for Next.js projects.
What you can do with it
- 1Implement specific UI componentsAsk the AI to add a specific styled dropzone or progress component to a webpage.
- 2Configure cloud storage providersRequest the necessary environment variables and handlers for setting up custom storage like Cloudflare R2.
- 3Automate Next.js boilerplate generationHave the assistant generate the required route handler files and provider snippets for a Next.js project.
Written from the project's README. Every use case is checked against a quote from it.
How to install UploadKit MCP
Formats verified 10 Nov 2026Add to CursorAdd to GooseInstall UploadKit MCP in Claude Code
$ claude mcp add uploadkit -- npx -y @uploadkitdev/mcpInstall UploadKit MCP in Cursor
~/.cursor/mcp.json
{
"mcpServers": {
"uploadkit": {
"command": "npx",
"args": [
"-y",
"@uploadkitdev/mcp"
]
}
}
}Install UploadKit MCP in VS Code
.vscode/mcp.json
{
"servers": {
"uploadkit": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@uploadkitdev/mcp"
]
}
}
}Install UploadKit MCP in VS Code CLI
$ code --add-mcp '{"name":"uploadkit","type":"stdio","command":"npx","args":["-y","@uploadkitdev/mcp"]}'Install UploadKit MCP in Claude Desktop
claude_desktop_config.json
{
"mcpServers": {
"uploadkit": {
"command": "npx",
"args": [
"-y",
"@uploadkitdev/mcp"
]
}
}
}Install UploadKit MCP in Codex
$ codex mcp add uploadkit -- npx -y @uploadkitdev/mcpInstall UploadKit MCP in Codex config.toml
~/.codex/config.toml
[mcp_servers.uploadkit] command = "npx" args = ["-y", "@uploadkitdev/mcp"]
Install UploadKit MCP in Gemini CLI
$ gemini mcp add -s user uploadkit npx -- -y @uploadkitdev/mcpInstall UploadKit MCP in Gemini settings.json
~/.gemini/settings.json
{
"mcpServers": {
"uploadkit": {
"command": "npx",
"args": [
"-y",
"@uploadkitdev/mcp"
]
}
}
}Started by HostedMCP on 16 Nov 2026
We ran this command for @uploadkitdev/mcp 0.3.1 in an isolated container with no network and no keys. It answered and listed 11 tools.
UploadKit MCP tools 11
Read from the server with tools/listlist_componentsList 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_componentReturn full metadata + a ready-to-paste usage example for a specific UploadKit component.
search_componentsFuzzy-search components by keyword, inspiration, or use case (e.g. "terminal", "apple", "progress ring", "kanban").
get_install_commandReturn the install command for UploadKit packages. Defaults to pnpm + the full stack (react + next).
scaffold_route_handlerGenerate 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_providerReturn a ready-to-paste snippet that adds <UploadKitProvider> to the Next.js root layout.
get_byos_configReturn environment + handler configuration for Bring-Your-Own-Storage mode with S3, R2, GCS, or Backblaze B2. Credentials never reach the browser.
get_quickstartFull end-to-end quickstart guide for UploadKit on Next.js.
search_docsFull-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_docReturn 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_docsList every docs page with title, description, URL, and path. Use this to discover what documentation is available before searching.
| 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. |
Automated checks
Ran Nov 13, 2026Full report →Passed our automated checks. That is not a security audit: read the code and give the server the narrowest access it needs. How checks work
- Source repository linked and reachablePass
- Open source license (OSI)Pass
- Commit or release in the last yearPass
- Package name not close to a popular packagePass
- Remote endpoint uses HTTPSNot checked
- Destructive tools are labelledPass
- No hidden instructions to the modelPass
- No critical advisory in the package or its dependenciesPass
README
View on GitHub@uploadkitdev/mcp
Model Context Protocol server for UploadKit — gives AI coding assistants (Claude Code, Cursor, Windsurf, Zed) first-class knowledge of the UploadKit SDK.
Your AI now knows:
- Every one of UploadKit's 40+ React components (name, category, inspiration, usage)
- How to scaffold the Next.js route handler
- How to wire
<UploadKitProvider>into the root layout - How to configure BYOS (Bring Your Own Storage) for S3, R2, GCS, or Backblaze B2
- Which install command to run for your package manager
No config. No API key. Runs local via npx.
Remote MCP
For clients that cannot spawn npx (ChatGPT custom connectors, Claude.ai web, Smithery), UploadKit also exposes a Streamable HTTP endpoint:
https://api.uploadkit.dev/api/v1/mcp
Same 11-tool surface, read-only, no auth. Full setup: https://docs.uploadkit.dev/docs/guides/mcp#remote-mcp
Install
Add this to your MCP client config.
Claude Code
{
"mcpServers": {
"uploadkit": {
"command": "npx",
"args": ["-y", "@uploadkitdev/mcp"]
}
}
}
…or run: claude mcp add uploadkit -- npx -y @uploadkitdev/mcp
Cursor
Settings → Features → Model Context Protocol → Add new MCP server:
Name: uploadkit
Command: npx -y @uploadkitdev/mcp
Windsurf / Zed / Continue
Follow your editor's MCP docs. Command is always npx -y @uploadkitdev/mcp.
Tools
| Tool | What it does |
|---|---|
list_components |
List all UploadKit components, filterable by category |
get_component |
Full metadata + usage example for one component |
search_components |
Keyword search across names, descriptions, inspirations |
get_install_command |
Returns the right install command for your package manager |
scaffold_route_handler |
Generates app/api/uploadkit/[...uploadkit]/route.ts |
scaffold_provider |
Snippet to wire <UploadKitProvider> into layout.tsx |
get_byos_config |
Env + handler for S3 / R2 / GCS / B2 |
get_quickstart |
End-to-end Next.js quickstart |
Resources
uploadkit://catalog— JSON of every componentuploadkit://quickstart— Next.js setup walkthrough
Example prompts once installed
"Add an Apple-style animated dropzone to this page."
"Set up UploadKit with Cloudflare R2 BYOS mode."
"What's the difference between
UploadProgressRadialandUploadProgressOrbit?"
"Create a route handler that accepts up to 4 images of 8MB each."
License
MIT
UploadKit MCP questions
How do I add UploadKit MCP to Claude Code?
Run claude mcp add uploadkit -- npx -y @uploadkitdev/mcp in your terminal. Add --scope user to make it available in every project.
How do I add UploadKit MCP to Cursor?
Open ~/.cursor/mcp.json and add the server under mcpServers, using the Cursor config shown in the install section above.
What tools does UploadKit MCP provide?
It exposes 11 tools, including list_components, get_component, search_components, get_install_command, scaffold_route_handler.
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.