{"_id":"@awc-ui/mcp","_rev":"3-6d4df2949e2507628c7ad08c6fa733d9","name":"@awc-ui/mcp","dist-tags":{"beta":"1.0.0-beta.14","latest":"1.0.1"},"versions":{"1.0.0-beta.14":{"name":"@awc-ui/mcp","version":"1.0.0-beta.14","keywords":["awc-ui","mcp","model-context-protocol","ai","components","web-components","design-system","documentation","accessibility"],"license":"MIT","_id":"@awc-ui/mcp@1.0.0-beta.14","maintainers":[{"name":"johnny_ivm","email":"ionut.mitrache@outlook.com"}],"homepage":"https://awc-ui.dev","bugs":{"url":"https://github.com/awc-ui/core/issues"},"bin":{"awc-ui-mcp":"bin/awc-ui-mcp.mjs"},"dist":{"shasum":"cefb2f9dc793636ce0cd492ebd71cd27a9df3d3b","tarball":"https://registry.npmjs.org/@awc-ui/mcp/-/mcp-1.0.0-beta.14.tgz","fileCount":7,"integrity":"sha512-I00A+VZhn6sO8QM1eftKGBNNt4N+N0ztxc4lQhiFdCI5VnpcrSO0mEPjGRDJ1GBGQt/FviwMifNKFe3TtqEhhg==","signatures":[{"sig":"MEQCIG9bpzYo/zK6uzYIqTmaCIEC/W0oNJf7ixRIQ0grps3EAiAEi49nKh5O6ZsAiqksKNvwGEx0A+Xeum9SsSK4aUxgGw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":3206975},"type":"module","_from":"file:/private/tmp/awc-mcp-first-release/awc-ui-mcp-1.0.0-beta.14.tgz","engines":{"node":"^22.13.0 || >=24.0.0"},"scripts":{"test":"node --test tests/*.test.mjs","build":"node scripts/build-catalog.mjs","start":"node bin/awc-ui-mcp.mjs"},"_npmUser":{"name":"johnny_ivm","email":"ionut.mitrache@outlook.com"},"_resolved":"/private/tmp/awc-mcp-first-release/awc-ui-mcp-1.0.0-beta.14.tgz","_integrity":"sha512-I00A+VZhn6sO8QM1eftKGBNNt4N+N0ztxc4lQhiFdCI5VnpcrSO0mEPjGRDJ1GBGQt/FviwMifNKFe3TtqEhhg==","repository":{"url":"git+https://github.com/awc-ui/core.git","type":"git","directory":"packages/mcp"},"_npmVersion":"10.9.4","description":"Offline MCP server for AWC UI Core component discovery, API manuals, and integration guides","directories":{},"_nodeVersion":"22.22.0","dependencies":{"zod":"^4.6.2","@modelcontextprotocol/server":"^2.0.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"@modelcontextprotocol/client":"^2.0.0"},"_npmOperationalInternal":{"tmp":"tmp/mcp_1.0.0-beta.14_1789231172233_0.35087795850541115","host":"s3://npm-registry-packages-npm-production"}},"1.0.0":{"name":"@awc-ui/mcp","version":"1.0.0","keywords":["awc-ui","mcp","model-context-protocol","ai","components","web-components","design-system","documentation","accessibility"],"license":"MIT","_id":"@awc-ui/mcp@1.0.0","maintainers":[{"name":"johnny_ivm","email":"ionut.mitrache@outlook.com"}],"homepage":"https://awc-ui.dev","bugs":{"url":"https://github.com/awc-ui/core/issues"},"bin":{"awc-ui-mcp":"bin/awc-ui-mcp.mjs"},"dist":{"shasum":"26af570be9b4690059b88fe8ae5f4d1bac56cbc7","tarball":"https://registry.npmjs.org/@awc-ui/mcp/-/mcp-1.0.0.tgz","fileCount":7,"integrity":"sha512-eoFKJVcElwC+CuWwO7xHEQi3cy/65+K6vHeh+xatI+USly6C5RH2hgJRJjcxO2u65QlzjL7DenMtqTL17lswrA==","signatures":[{"sig":"MEUCIQDrtYAdOUU1WTL2wlqYnHumWXtZ97qdIKnGKsGOLBgXswIgPXVqLfyongNnX4RMbgGVibO4H6yFq6NmPzUMUwPtRWA=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@awc-ui%2fmcp@1.0.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":3227226},"type":"module","_from":"file:awc-ui-mcp-1.0.0.tgz","engines":{"node":"^22.13.0 || >=24.0.0"},"scripts":{"test":"node --test tests/*.test.mjs","build":"node scripts/build-catalog.mjs","start":"node bin/awc-ui-mcp.mjs"},"_npmUser":{"name":"johnny_ivm","email":"ionut.mitrache@outlook.com"},"_resolved":"/tmp/25a35784ed18f0560eb4a4c30f131c31/awc-ui-mcp-1.0.0.tgz","_integrity":"sha512-eoFKJVcElwC+CuWwO7xHEQi3cy/65+K6vHeh+xatI+USly6C5RH2hgJRJjcxO2u65QlzjL7DenMtqTL17lswrA==","repository":{"url":"git+https://github.com/awc-ui/core.git","type":"git","directory":"packages/mcp"},"_npmVersion":"10.9.8","description":"Offline MCP server for AWC UI Core component discovery, API manuals, and integration guides","directories":{},"_nodeVersion":"22.23.2","dependencies":{"zod":"^4.6.2","@modelcontextprotocol/server":"^2.0.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"@modelcontextprotocol/client":"^2.0.0"},"_npmOperationalInternal":{"tmp":"tmp/mcp_1.0.0_1789298538457_0.03632289248006715","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"_id":"@awc-ui/mcp@1.0.1","bin":{"awc-ui-mcp":"bin/awc-ui-mcp.mjs"},"bugs":{"url":"https://github.com/awc-ui/core/issues"},"dist":{"shasum":"43d4d4ae8c8aafb078bf2317262ced623ac2cded","tarball":"https://registry.npmjs.org/@awc-ui/mcp/-/mcp-1.0.1.tgz","fileCount":7,"integrity":"sha512-qm3hLlr1kD1ZjHOD6RtGvUqBevqkpF5GjuTn78rKm2Q29HpvJegvyNr47AkrniBoJCuK8Wx8lAF9QpzzgcYEWg==","signatures":[{"sig":"MEYCIQCNvVG/0xtaCouk+YtYaCvOAKONNEteg7+UHnJFepTfpQIhAL1oNamSs8A5JIVI0ypsgX8+j786fw1NNkaScvGqq4Pq","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQCMHo9eUgxQJJMDqfCF7TwPTxGiKjUDH8cbilM5gvC3rQIhAKyMG9XgjDBO3d3LUCapTz2UdQAP05k+8FWKJNoLeNwY"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@awc-ui%2fmcp@1.0.1","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":3228091},"name":"@awc-ui/mcp","type":"module","_from":"file:awc-ui-mcp-1.0.1.tgz","engines":{"node":"^22.13.0 || >=24.0.0"},"license":"MIT","scripts":{"test":"node --test tests/*.test.mjs","build":"node scripts/build-catalog.mjs","start":"node bin/awc-ui-mcp.mjs"},"version":"1.0.1","_npmUser":{"name":"johnny_ivm","email":"ionut.mitrache@outlook.com"},"homepage":"https://awc-ui.dev","keywords":["awc-ui","mcp","model-context-protocol","ai","components","web-components","design-system","documentation","accessibility"],"_resolved":"/tmp/d927e595ebb611889336d21d8817cd2c/awc-ui-mcp-1.0.1.tgz","_integrity":"sha512-qm3hLlr1kD1ZjHOD6RtGvUqBevqkpF5GjuTn78rKm2Q29HpvJegvyNr47AkrniBoJCuK8Wx8lAF9QpzzgcYEWg==","repository":{"url":"git+https://github.com/awc-ui/core.git","type":"git","directory":"packages/mcp"},"_npmVersion":"10.9.8","description":"Offline MCP server for AWC UI Core component discovery, API manuals, and integration guides","directories":{},"maintainers":[{"name":"johnny_ivm","email":"ionut.mitrache@outlook.com"}],"_nodeVersion":"22.23.2","dependencies":{"zod":"^4.6.2","@modelcontextprotocol/server":"^2.0.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"@modelcontextprotocol/client":"^2.0.0"},"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/mcp_1.0.1_1790351194035_0.20411562143154405"}}},"time":{"created":"2026-09-12T16:39:32.064Z","modified":"2026-09-25T15:46:34.511Z","1.0.0-beta.14":"2026-09-12T16:39:32.401Z","1.0.0":"2026-09-13T11:22:18.614Z","1.0.1":"2026-09-25T15:46:34.157Z"},"bugs":{"url":"https://github.com/awc-ui/core/issues"},"license":"MIT","homepage":"https://awc-ui.dev","keywords":["awc-ui","mcp","model-context-protocol","ai","components","web-components","design-system","documentation","accessibility"],"repository":{"url":"git+https://github.com/awc-ui/core.git","type":"git","directory":"packages/mcp"},"description":"Offline MCP server for AWC UI Core component discovery, API manuals, and integration guides","maintainers":[{"name":"johnny_ivm","email":"ionut.mitrache@outlook.com"}],"readme":"# AWC UI Core MCP server\n\n`@awc-ui/mcp` gives AI assistants read-only access to Core's component catalog,\nexact API contracts, component manuals, and framework/theming guides. It uses\nthe [official MCP SDK](https://ts.sdk.modelcontextprotocol.io/v2/) over stdio.\nDocumentation is bundled at build time, so the installed server runs offline\nwithout an API key, browser runtime, repository checkout, or Core dependency.\n\n## Connect your assistant\n\nUse Node 22.13+ (22.x), or Node 24+, and choose your assistant below.\n\n### Codex\n\nWith the Codex CLI installed, add the server once:\n\n```sh\ncodex mcp add awc-ui -- npx -y @awc-ui/mcp\n```\n\nRestart Codex after adding it, then use `/mcp` to check the connection. The\ndesktop app and CLI share this configuration.\n\n### Claude Code\n\nRun this from your project folder:\n\n```sh\nclaude mcp add --transport stdio --scope project awc-ui -- npx -y @awc-ui/mcp\n```\n\nThis saves the server in the project's `.mcp.json`. Start Claude Code, approve\nit when prompted, and use `/mcp` to check the connection. Use `--scope user`\ninstead of `--scope project` to make the server available across your projects.\n\n### Other MCP clients\n\nAdd this local stdio server to your assistant's MCP configuration. Your client\nmay use a different outer settings format:\n\n```json\n{\n  \"mcpServers\": {\n    \"awc-ui\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"@awc-ui/mcp\"]\n    }\n  }\n}\n```\n\nThe client starts the server for you; no separate terminal process is needed.\nThe first download needs internet access, then the server serves its bundled\ndocumentation offline.\n\nWithout a version suffix, `npx` uses npm's `latest` tag. Check the server's\nreported `coreVersion` against your installed Core version. If they differ,\nchoose an MCP release with matching bundled documentation; installing the\nlatest MCP does not update Core in your project.\n\nAsk your assistant:\n\n> Use the awc-ui MCP to build a responsive dashboard using only AWC Core\n> components. Read the framework guide and relevant component APIs before\n> implementing, and check that the documentation matches my installed Core.\n\nSee [Building with AI](https://awc-ui.dev/guides/building-with-ai/) for the\ncomplete workflow and optional skills.\n\n## Run from this repository\n\nUse Node 22.13+ (22.x), or Node 24+, and the repository's pnpm version:\n\n```sh\npnpm install\npnpm build:mcp\nnode packages/mcp/bin/awc-ui-mcp.mjs\n```\n\nThe server waits for MCP messages on stdin. It writes protocol messages only\nto stdout; startup failures go to stderr. `--help` prints usage and exits.\n\nConfigure a stdio-capable MCP client with an absolute executable path:\n\n```json\n{\n  \"mcpServers\": {\n    \"awc-ui\": {\n      \"command\": \"node\",\n      \"args\": [\"/absolute/path/to/core/packages/mcp/bin/awc-ui-mcp.mjs\"]\n    }\n  }\n}\n```\n\nThe client must resolve `node` to a supported version. This example is a common\nJSON configuration shape; adapt the outer configuration to your MCP client.\nNo client or global configuration is changed by the package.\n\nA source build uses the current checkout's documentation, which may include\nunreleased changes. Use the published package for a released Core version.\n\n## Tools, resources and prompts\n\n| Tool | Purpose |\n| --- | --- |\n| `search_components` | Search tags, summaries and manual text; ranked results with `limit`, `offset` and `nextOffset`. Empty query lists components. |\n| `get_component` | Read `manual`, structured `api`, or `both` for an exact `md-*` tag. |\n| `list_guides` | Discover framework, SSR, build, token and accessibility guide IDs. |\n| `get_guide` | Read a guide by its advertised ID. |\n\nResources expose the same documentation at `awc://catalog`,\n`awc://components/{tag}/manual`, `awc://components/{tag}/api`, and\n`awc://guides/{id}`. Prompts `awc-ui-build` and `awc-ui-review` accept `task`\nand an optional `framework`.\n\nSearch, component and guide tool responses report the bundled `coreVersion`.\nTreat this as a versioned reference: it does not inspect your dependencies or\nclaim that every documented feature exists in an older installation. Manuals\nare the canonical Markdown; guide snapshots preserve the original MDX source.\nRepository-relative links are source references, not paths on the client.\n\nThe server has no write, shell, arbitrary-file, URL-fetch, or application-data\ntools. AI clients still own their normal editing and execution permissions.\n\n## Maintain and verify\n\n```sh\npnpm test:mcp\npnpm --dir packages/mcp pack --pack-destination /tmp\n```\n\nThe builder regenerates the public custom-elements manifest, bundles each\ncanonical component manual and an explicit guide allowlist, and includes the\nCore version. Missing manuals fail the build. Build/prepack and Turbo inputs\nkeep this snapshot tied to source changes without hand-maintained API copies.\n\nFor an MCP-only release against an already-published Core package, first extract\nthat exact npm tarball and identify its matching Core Git tag. Then set both\ninputs for the build and pack commands, replacing `<core-version>` with the\nversion of that published Core package:\n\n```sh\nexport AWC_MCP_CORE_PACKAGE=/absolute/path/to/extracted/core/package\nexport AWC_MCP_GUIDES_REF=\"v<core-version>\"\npnpm build:mcp\npnpm --filter @awc-ui/mcp test\npnpm --dir packages/mcp pack --pack-destination /tmp\n```\n\nThis uses the published package's APIs and manuals and the matching Git ref's\nframework guides. It rejects mismatched versions. Omitting both inputs retains\nthe normal source build used when Core and MCP ship together.\n\nReusable agent skills are included in Core. Run\n`npx --no-install awc-ui ai-setup --skills` from your app to install them.\nInstalling MCP does not update Core or install skills in your project. See\n[Building with AI](https://awc-ui.dev/guides/building-with-ai/).\n","readmeFilename":"README.md"}