uidx MCP server
Commit 14 Nov 2026Memungkinkan AI agent dan manusia untuk berkolaborasi dalam merancang dan mengedit visual workspace menggunakan file JSX yang dapat di-diff secara langsung di dalam repositori proyek.
Juga dikenal sebagai uidxkit/uidx
- Stars
- 13
- Tools
- —
- Unduhan, 30 hari
- —
- Versi terbaru
- —
- Commit terakhir
- 14 Nov 2026
- Lisensi
- MIT
Apa itu uidx MCP?
Memungkinkan AI agent dan manusia untuk berkolaborasi dalam merancang dan mengedit visual workspace menggunakan file JSX yang dapat di-diff secara langsung di dalam repositori proyek.
Ringkasan dibuat dari README proyek
Tentang uidx MCP server
uidx memungkinkan developer dan AI agent untuk merancang visual workspace secara langsung di dalam repositori aplikasi Anda. Dengan menginstal @uidxkit/uidx sebagai local development dependency, Anda dapat mengelola desain melalui file JSX yang dapat di-diff dan disimpan di dalam folder .uidx. Pendekatan ini memungkinkan Anda untuk melakukan versioning pada aset desain, font, dan layout bersamaan dengan kode aplikasi Anda menggunakan Git.
User berinteraksi dengan sistem melalui local viewer dan canvas yang tersinkronisasi dengan file di dalam proyek. Setup ini berjalan di mesin Anda dan tidak memerlukan layanan desain hosted atau LLM untuk sinkronisasi canvas. Untuk menghubungkan AI client, Anda dapat menggunakan file .mcp.json yang dihasilkan untuk menjalankan script uidx:mcp, yang berfungsi sebagai stdio bridge ke project server yang sedang berjalan. Setup ini memungkinkan tool eksternal untuk memeriksa dan mengedit file desain yang sama dengan yang digunakan manusia di visual inspector.
Apa yang bisa Anda lakukan dengannya
- 1Collaborative design editingAI agent dapat memodifikasi file desain di repositori Anda untuk memperbarui layout atau style.
- 2Version controlled design systemsDeveloper dapat mengelola komponen, varian, dan design token menggunakan workflow Git standar.
- 3Visual workspace managementAnda dapat membuat halaman baru dan menyesuaikan layout menggunakan visual canvas dan inspector.
Ditulis berdasarkan README proyek. Setiap use case diperiksa terhadap kutipan dari README tersebut.
Pengecekan otomatis
Berjalan 14 Nov 2026Laporan lengkap →Belum diverifikasi. Sebuah server memerlukan skor 80, tidak ada temuan serius, dan data yang cukup untuk kami periksa. Cara kerja checks · Yang perlu diperbaiki untuk menambah poin
- Source repository terhubung dan dapat dijangkauuidxkit/uidx is public and reachablegithub.com/uidxkit/uidx ↗Lolos
- Nama paket mencantumkan repositori ini sebagai sumbernyaTidak diperiksa
- Provenance build (atestasi Sigstore)Tidak diperiksa
- Lisensi open source (OSI)MITspdx.org/licenses/MIT.html ↗Lolos
- Ada commit atau release dalam satu tahun terakhirLast commit or release 2026-11-14github.com/uidxkit/uidx ↗Lolos
- OpenSSF ScorecardTidak diperiksa
- Nama package tidak mirip dengan package populerTidak diperiksa
- Tidak ada advisory kritis pada paket atau dependensinyaTidak diperiksa
- Tidak ada instruksi tersembunyi untuk model0 tool descriptions and the README read; no override phrases, credential paths or hidden charactersLolos
- Tools yang bersifat destruktif telah diberi labelTidak diperiksa
- Endpoint remote merespons handshake MCPTidak diperiksa
README
Lihat di GitHubWorkflow illustration: one design, shared by the canvas, your files, and your tools.
What is UIDX?
UIDX brings a design canvas into your application's repository. Install
@uidxkit/uidx as a local development dependency, run npm run uidx, and
work on designs stored in your project's .uidx/ folder.
A .uidx file combines Markdown describing a design's purpose with a declarative
node tree describing its appearance. Edit the canvas and the file updates. Edit
the file and the canvas follows. Changes produce focused text diffs you can
review in a pull request.
- A visual workspace. Create pages, draw shapes, edit text, and adjust layout and styling from the canvas and inspector.
- Reusable design systems. Components, instances, variants, slots, and design tokens share a document namespace.
- Your project owns the files. Keep designs, assets, and fonts next to your application and version them with Git.
- A shared workflow for people and agents. The CLI and MCP bridge let external tools inspect and edit the same files the viewer uses.
- Local by default. The viewer and project server run on your machine. Canvas synchronization does not require an LLM or a hosted design service.
UIDX is an early release. The file format and APIs may change before 1.0. It is a design workspace; it does not render your application's existing UI components as Storybook stories.
Install
Requires Node.js 22.19 or newer. Node 24 is recommended.
Run these commands inside your application's repository:
npm install --save-dev @uidxkit/uidx
npm run uidx
Installation adds the uidx and uidx:mcp scripts and creates .uidx/ when it
doesn't exist. Existing scripts, configuration, and designs are preserved.
The CLI, server, viewer, WASM, and bundled fonts live in your project's
node_modules; a global UIDX installation is not required.
Recent npm versions do not run a package's install script until you approve
it, and warn with install scripts not yet covered by allowScripts. Nothing is
lost: the first npx uidx dev performs the same setup itself and says so, or
approve the script with npm install-scripts approve @uidxkit/uidx and
reinstall. To set up explicitly, run npx --no-install uidx init. If your
project already uses a script named uidx, choose another with
npx --no-install uidx init --script design, then run npm run design.
Your design workspace
your-project/
├── package.json # @uidxkit/uidx devDependency and npm scripts
├── .mcp.json # connection for MCP clients
├── src/
└── .uidx/
├── config.json # project settings
├── uidx.json # document name, page patterns, and asset patterns
├── welcome.uidx # initial page for a new workspace
├── assets/
└── fonts/
Open the viewer, click New page, give it a name, and start designing. New
pages are saved in your design folder and appear in the overview. Commit your
project's .uidx/ files alongside application code.
Configuration
Set the shared viewer and MCP port in .uidx/config.json:
{
"port": 4400
}
Restart npm run uidx after changing it. Use npm run uidx -- --port 4500 for a
one-time override. If the requested port is busy, UIDX tries the next available
one and reports its actual address. Configuration currently uses JSON.
The separate .uidx/uidx.json manifest controls which files belong to the document:
{
"id": "my-project",
"files": ["**/*.uidx"],
"assets": ["assets/**"]
}
CLI and MCP
npm run uidx starts the local viewer, file synchronization server, and MCP HTTP
endpoint on one port. MCP clients use the generated .mcp.json to launch
npm run --silent uidx:mcp, a stdio bridge to that running project server.
npx --no-install uidx status
npx --no-install uidx check
npx --no-install uidx fmt --check
The CLI also supports reading, creating, editing, and rendering pages. See the CLI guide and agent architecture.
Documentation
- Drawing icons and custom graphics
- Fonts
- Property vocabulary
- Architecture decisions
- Release guide
- Changelog
Contributing and license
Bug reports, documentation improvements, and pull requests are welcome.
See Contributing for development setup and checks.
Follow the Code of Conduct and report vulnerabilities through
the security policy. Changes to main are merged by the owner.
UIDX is MIT licensed. Third-party code and fonts retain their respective licenses.
Pertanyaan tentang uidx MCP
Bagaimana cara menginstal UIDX di proyek saya?
Instal sebagai local development dependency menggunakan npm install --save-dev @uidxkit/uidx dan kemudian jalankan npm run uidx.
Apakah UIDX memerlukan layanan desain hosted atau LLM untuk sinkronisasi?
Tidak, viewer dan project server berjalan secara lokal di mesin Anda dan tidak memerlukan LLM atau layanan hosted untuk sinkronisasi canvas.
Bisakah saya menggunakan UIDX dengan AI agent?
Ya, MCP bridge memungkinkan tool dan agent eksternal untuk memeriksa dan mengedit file desain yang sama dengan yang digunakan oleh visual canvas.
Apa saja persyaratan sistem untuk UIDX?
Anda memerlukan Node.js versi 22.19 atau yang lebih baru, meskipun Node 24 lebih direkomendasikan.