uxonfly-mcp 0.1.0 → 0.1.2

package/README.md

@@ -42,23 +42,55 @@ Strong opinions. Border-first. Modern SaaS aesthetic (Linear / Stripe / Vercel-a
 
 ## Install option 1 — file (recommended, 30 seconds)
 
-This is the only step you need.
+Download `uxonfly.md` once, then save it with whatever filename your AI tool reads on every session.
 
 ```bash
-# Download the rulebook
 curl -O https://raw.githubusercontent.com/Phanikondru/uxonfly-mcp/main/uxonfly.md
+```
+
+Then rename it per your tool:
 
-# For Claude Code:
+| AI tool | Save as | Location |
+| --- | --- | --- |
+| **Claude Code** | `CLAUDE.md` | project root |
+| **Cursor** | `.cursorrules` | project root |
+| **Windsurf** | `.windsurfrules` | project root |
+| **Gemini CLI** | `GEMINI.md` | project root |
+| **Zed** | `AGENTS.md` | project root |
+| **Google Antigravity** | `AGENTS.md` | project root |
+| **GitHub Copilot** | `copilot-instructions.md` | `.github/` |
+| **Aider** | `CONVENTIONS.md` (then `aider --read CONVENTIONS.md`) | project root |
+| **JetBrains Junie** | `guidelines.md` | `.junie/` |
+| **Any other tool** | `AGENTS.md` | project root (emerging universal convention) |
+
+Example commands:
+
+```bash
+# Claude Code
 mv uxonfly.md CLAUDE.md
 
-# OR for Cursor:
+# Cursor
 mv uxonfly.md .cursorrules
+
+# Windsurf
+mv uxonfly.md .windsurfrules
+
+# Gemini CLI
+mv uxonfly.md GEMINI.md
+
+# Zed / Google Antigravity / any tool using the AGENTS.md convention
+mv uxonfly.md AGENTS.md
+
+# GitHub Copilot
+mkdir -p .github && mv uxonfly.md .github/copilot-instructions.md
+
+# JetBrains Junie
+mkdir -p .junie && mv uxonfly.md .junie/guidelines.md
 ```
 
-Open your AI tool and start prompting. It will read the file before generating
-UI on every session.
+Open your AI tool in that project and start prompting. It reads the file on every session automatically.
 
-That's it. No npm install. No config. No login.
+**That's it. No npm install, no config, no login.** Works with any AI tool that reads project-level context files — which is most of them in 2026.
 
 ---
 
@@ -68,56 +100,72 @@ If you want your AI to invoke specific tools (`get_component`,
 `get_ux_pattern`, `get_tokens`, …) on demand instead of reading the whole
 file every prompt, run UXonFly as a local MCP server.
 
-> **Status**: `uxonfly-mcp` is not yet published to npm. The one-line `npx`
-> install will work after the first publish — until then, use the local-build
-> path below.
+Published to npm as [`uxonfly-mcp`](https://www.npmjs.com/package/uxonfly-mcp).
+MCP is a standard protocol — any MCP-compatible AI tool can load this server
+with the same command: `npx -y uxonfly-mcp`. Only the config location varies
+per tool. Snippets for the most common tools below.
 
-### Install today (local build)
+### Claude Code
 
 ```bash
-git clone https://github.com/Phanikondru/uxonfly-mcp.git
-cd uxonfly-mcp
-npm install
-npm run build
+claude mcp add uxonfly -- npx -y uxonfly-mcp
 ```
 
-Then point your AI tool at the compiled binary using its absolute path.
+### Cursor
 
-**Claude Code:**
+Add to `~/.cursor/mcp.json`:
 
-```bash
-claude mcp add uxonfly -- node /absolute/path/to/uxonfly-mcp/build/index.js
+```json
+{
+  "mcpServers": {
+    "uxonfly": {
+      "command": "npx",
+      "args": ["-y", "uxonfly-mcp"]
+    }
+  }
+}
 ```
 
-**Cursor** — add to `~/.cursor/mcp.json`:
+### Claude Desktop
+
+On macOS, edit `~/Library/Application Support/Claude/claude_desktop_config.json`.
+On Windows, edit `%APPDATA%\Claude\claude_desktop_config.json`.
 
 ```json
 {
   "mcpServers": {
     "uxonfly": {
-      "command": "node",
-      "args": ["/absolute/path/to/uxonfly-mcp/build/index.js"]
+      "command": "npx",
+      "args": ["-y", "uxonfly-mcp"]
     }
   }
 }
 ```
 
-### After the first npm publish (coming soon)
-
-Once `uxonfly-mcp` is on the npm registry, the install collapses to one command.
+### Windsurf
 
-**Claude Code:**
+Add to `~/.codeium/windsurf/mcp_config.json`:
 
-```bash
-claude mcp add uxonfly -- npx -y uxonfly-mcp
+```json
+{
+  "mcpServers": {
+    "uxonfly": {
+      "command": "npx",
+      "args": ["-y", "uxonfly-mcp"]
+    }
+  }
+}
 ```
 
-**Cursor** — `~/.cursor/mcp.json`:
+### VS Code (with MCP support)
+
+Add to `.vscode/mcp.json` in your project root:
 
 ```json
 {
-  "mcpServers": {
+  "servers": {
     "uxonfly": {
+      "type": "stdio",
       "command": "npx",
       "args": ["-y", "uxonfly-mcp"]
     }
@@ -125,6 +173,57 @@ claude mcp add uxonfly -- npx -y uxonfly-mcp
 }
 ```
 
+### Zed
+
+Add to `~/.config/zed/settings.json` under `context_servers`:
+
+```json
+{
+  "context_servers": {
+    "uxonfly": {
+      "command": {
+        "path": "npx",
+        "args": ["-y", "uxonfly-mcp"]
+      }
+    }
+  }
+}
+```
+
+### Any other MCP-compatible tool
+
+MCP is a standard protocol. The command is always the same across tools:
+
+```bash
+npx -y uxonfly-mcp
+```
+
+Gemini CLI, Google Antigravity, JetBrains Junie, and a growing list of other
+editors and agents support MCP. Consult your tool's documentation for where
+to register MCP servers, then use the command above.
+
+### Tools without MCP support
+
+For tools that don't speak MCP yet (Aider, basic terminal LLM CLIs, older
+editors), use **Install option 1** above. The file install works with any AI
+that reads project context files.
+
+### Install from source (contributors)
+
+If you want to run the MCP server from a local clone — for example, to
+modify the base `uxonfly.md` or the server code — build from source and
+point your AI tool at the compiled binary:
+
+```bash
+git clone https://github.com/Phanikondru/uxonfly-mcp.git
+cd uxonfly-mcp
+npm install
+npm run build
+```
+
+Then in your MCP config, replace `npx -y uxonfly-mcp` with
+`node /absolute/path/to/uxonfly-mcp/build/index.js`.
+
 ### Available tools
 
 | Tool | When AI calls it | Returns |
@@ -147,12 +246,7 @@ Point the MCP server at your own version of `uxonfly.md` via the
 `UXONFLY_MD_PATH` environment variable:
 
 ```bash
-# Local build (works today):
-UXONFLY_MD_PATH=/absolute/path/to/your/uxonfly.md \
-  node /absolute/path/to/uxonfly-mcp/build/index.js
-
-# After npm publish:
-UXONFLY_MD_PATH=/absolute/path/to/your/uxonfly.md npx uxonfly-mcp
+UXONFLY_MD_PATH=/absolute/path/to/your/uxonfly.md npx -y uxonfly-mcp
 ```
 
 ---
@@ -187,8 +281,8 @@ Goal: make UXonFly *better* than any one designer's taste alone.
 
 ## About
 
-Built by [phanikondru](https://x.com/Phanikondru) — designer with 4 years
-of production UX experience, building in public.
+Built by **Phanindhra Kondru** — designer with 4 years of production UX
+experience, building in public.
 
 Just trying to build good things. **Design + AI + Code.**
 
@@ -196,7 +290,10 @@ UXonFly was built with Gemini, Cursor, and the rules in `uxonfly.md`
 itself — the same system that ships with this package. The tool eats its
 own dog food.
 
-Follow the project: [@Phanikondru](https://x.com/Phanikondru)
+### Connect
+
+- X: [@Phanikondru](https://x.com/Phanikondru)
+- LinkedIn: [Phanindhra Kondru](https://www.linkedin.com/in/phanindhra-kondru-436220205/)
 
 ---
 

package/build/index.js

@@ -18,6 +18,10 @@ import { fileURLToPath } from "node:url";
 import { dirname, resolve } from "node:path";
 // ─── Load the base system ────────────────────────────────────────────
 const DEFAULT_MD_PATH = resolve(dirname(fileURLToPath(import.meta.url)), "..", "uxonfly.md");
+// Read package version at runtime so serverInfo.version always matches
+// package.json. Prevents drift on future version bumps.
+const PACKAGE_JSON_PATH = resolve(dirname(fileURLToPath(import.meta.url)), "..", "package.json");
+const { version: PACKAGE_VERSION } = JSON.parse(readFileSync(PACKAGE_JSON_PATH, "utf8"));
 function loadSystem() {
     const path = process.env.UXONFLY_MD_PATH ?? DEFAULT_MD_PATH;
     try {
@@ -64,7 +68,7 @@ const notFound = (what) => asText(`[uxonfly] not found: ${what}. Check uxonfly.m
 // ─── Server ──────────────────────────────────────────────────────────
 const server = new McpServer({
     name: "uxonfly-mcp",
-    version: "0.1.0",
+    version: PACKAGE_VERSION,
 });
 // Tool 1 — complete design system
 server.registerTool("get_design_system", {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "uxonfly-mcp",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Designer intelligence for every AI coding session. Production-grade UX. On the fly.",
   "type": "module",
   "bin": {