aural-ui 4.1.0 → 4.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -1
- package/dist/index.cjs +90 -90
- package/dist/index.js +90 -90
- package/package.json +8 -3
package/README.md
CHANGED
|
@@ -114,6 +114,13 @@ aural-ui update
|
|
|
114
114
|
|
|
115
115
|
The **aural-ui MCP server** exposes the design system by reading from aural-ui source (components, icons, source and story files). No Storybook process is required.
|
|
116
116
|
|
|
117
|
+
### Run the MCP server locally
|
|
118
|
+
|
|
119
|
+
1. Copy [`mcp/.env.example`](mcp/.env.example) to `mcp/.env` and fill in the values (Google OAuth client, redirect URL, issuer base URL, JWT secret). That file is the canonical list of variables; it stays next to the server code so it does not drift.
|
|
120
|
+
2. From the repo root: `npx tsx mcp/src/index.ts` (listens on port `3000` by default).
|
|
121
|
+
|
|
122
|
+
For OAuth flow details, see [`mcp/docs/auth.md`](mcp/docs/auth.md).
|
|
123
|
+
|
|
117
124
|
### Setup in Cursor
|
|
118
125
|
|
|
119
126
|
Add the server in `.cursor/mcp.json` (or Cursor Settings → MCP). Start the MCP server first (e.g. `npx tsx mcp/src/index.ts` from the aural-ui repo root, or run the Docker image), then point Cursor at the streamable HTTP endpoint:
|
|
@@ -131,7 +138,7 @@ Add the server in `.cursor/mcp.json` (or Cursor Settings → MCP). Start the MCP
|
|
|
131
138
|
|
|
132
139
|
The server identifies as **aural-ui** so agents match user phrases like "add aural-ui btn". Use the same URL when the server runs in Docker or elsewhere (e.g. `http://your-host:3000/mcp`).
|
|
133
140
|
|
|
134
|
-
- **Config:**
|
|
141
|
+
- **Config:** Non-secret defaults and limits live in `mcp/src/lib/env.ts`. OAuth and JWT values must come from the environment; for local dev, use `mcp/.env` (start from [`mcp/.env.example`](mcp/.env.example)).
|
|
135
142
|
|
|
136
143
|
**HTTP / Docker:** When running the MCP server over HTTP (e.g. in Docker):
|
|
137
144
|
- **GET /health** — Returns `200` and `{ "ok": true, "server": "aural-ui" }` for load balancers and orchestrators (no MCP session required).
|