mountly-mcp 0.0.0 → 3.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Jag Reehal
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied. See the License for the specific language governing permissions
+   and limitations under the License.

package/README.md

@@ -1,36 +1,274 @@
 # mountly-mcp
 
-Bridge runtime and build helpers for publishing mountly widgets as MCP Apps `ui://` resources.
+**Build MCP Apps from the components you already have — in React, Vue, or Svelte.**
 
-## Exports
+[MCP Apps](https://github.com/modelcontextprotocol/ext-apps) (SEP-1865) lets an
+MCP server render interactive UI inside Claude, ChatGPT and other hosts. The
+official SDK gives you the protocol and expects you to hand-write the view.
+`mountly-mcp` starts from a component instead:
+
+```ts
+import { createMcpWidget } from "mountly-mcp/vue";
+import Dashboard from "./Dashboard.vue";
+
+(globalThis as { __mountlyMcpWidget__?: unknown }).__mountlyMcpWidget__ =
+  createMcpWidget(Dashboard);
+```
 
-- `runBridge` from `mountly-mcp` (iframe runtime lifecycle)
-- `buildMcpResource` from `mountly-mcp/build` (emit `html` + `.meta.json` sidecar)
-- `createMcpHost` and channel helpers from `mountly-mcp/bridge`
+`mountly-mcp build` turns that into a versioned App manifest containing one or
+many `ui://` resources. `registerMcpApps` installs them into the MCP server your
+application already owns. Your component is unchanged, and the same one can
+keep running on your website.
 
-## Build a resource
+**If you're on React and starting from scratch**, the official
+[`@modelcontextprotocol/ext-apps`](https://www.npmjs.com/package/@modelcontextprotocol/ext-apps)
+skills are the shorter path — this package is worth it when you have existing
+components, a Vite build, or a framework other than React.
+
+The wire protocol is delegated to the official `@modelcontextprotocol/sdk` and
+`@modelcontextprotocol/ext-apps` packages in full, so server transports,
+handshakes, capabilities and message types track the spec rather than a
+reimplementation of it. Both are runtime dependencies of `mountly-mcp`.
+
+## Install
+
+```bash
+npm install mountly-mcp mountly
+npm install mountly-vue        # or mountly-react / mountly-svelte
+```
+
+Install `@modelcontextprotocol/sdk` directly only when your application imports
+its APIs itself, for example to configure a custom HTTP transport. Mountly's
+server entry point does not require a separate SDK install.
+
+## One build, one command
 
 ```ts
-import { buildMcpResource } from "mountly-mcp/build";
-
-await buildMcpResource({
-  entry: "./dist/widget.js",
-  uri: "ui://example/hello",
-  name: "hello-widget",
-  output: "./dist/hello.html",
-  awaitToolResult: true,
+// vite.config.ts
+import vue from "@vitejs/plugin-vue";
+import { mountlyMcpWidget } from "mountly-mcp/vite";
+
+export default defineConfig({
+  plugins: [
+    vue(),
+    mountlyMcpWidget({
+      apps: [
+        {
+          entry: "src/dashboard.ts",
+          uri: "ui://weather-server/dashboard",
+          name: "weather_dashboard",
+          displayModes: ["inline", "fullscreen"],
+          csp: { connectDomains: ["https://api.weather.com"] },
+        },
+        {
+          entry: "src/settings.ts",
+          uri: "ui://weather-server/settings",
+          name: "weather_settings",
+        },
+      ],
+    }),
+  ],
 });
 ```
 
-This writes:
+```bash
+npx mountly-mcp build
+```
+
+Each View is built in an isolated Vite environment and emitted as self-contained
+HTML with a transitional `.meta.json` file. The canonical
+`dist/mountly-mcp.manifest.json` gives build, dev, registration, and CI one
+versioned artifact contract. The original single-View plugin shape and
+`vite build` remain supported.
+
+## One command to develop it
+
+```bash
+npx mountly-mcp dev
+# multi-View project
+npx mountly-mcp dev --app weather_dashboard
+```
 
-- `./dist/hello.html`
-- `./dist/hello.html.meta.json`
+Builds the widget, serves it in a local MCP Apps host, and rebuilds on save.
+Config comes from the plugin already in your vite config.
+
+It's a real host, not a preview: the published official `AppBridge` drives the
+handshake and host behavior, while Mountly supplies two origins and a sandbox
+proxy enforcing the CSP and permissions the App artifact declares. Sample tool
+results come from `mcp.fixtures.json`,
+one button each, so clicking between them exercises the update path:
+
+```json
+{ "annual": { "total": 99 }, "monthly": { "total": 12 } }
+```
+
+Add `--server ./server.js` (a module default-exporting your server) and the
+fixtures become tool _arguments_ instead: the view renders what your handler
+really returns, and the tool calls the view makes itself are routed there too.
+
+## Install into your production server
+
+```ts
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { readMcpAppManifest } from "mountly-mcp/artifact";
+import { registerMcpApps } from "mountly-mcp/server";
+
+const server = new McpServer(
+  { name: "weather-server", version: "1.0.0" },
+  { capabilities: { tools: {}, resources: {} } },
+);
+const { artifacts } = await readMcpAppManifest("dist/mountly-mcp.manifest.json");
+
+await registerMcpApps(server, {
+  views: artifacts.map((artifact) => ({ artifact })),
+  tools: [
+    {
+      name: "get_weather",
+      resourceUri: "ui://weather-server/dashboard",
+      config: {
+        inputSchema: { type: "object", properties: { location: { type: "string" } } },
+      },
+      handler: async ({ location }) => ({ structuredContent: { location, temperature: 72 } }),
+    },
+  ],
+});
+```
+
+Call `registerMcpApps` before connecting the server. Your application retains
+ownership of authentication, transport, prompts, non-UI tools, lifecycle, and
+deployment. Views and tools are independent, so several tools can link to one
+View and app-only tools use `visibility: "app"`. Mountly negotiates the UI
+extension and degrades to text-only model tools for hosts without MCP Apps.
+
+`createMcpAppServer` and `serveStdio` remain as convenience adapters for small
+servers and existing projects.
+
+## Verify in CI
+
+```bash
+npx mountly-mcp verify
+npx mountly-mcp verify --strict
+npx mountly-mcp verify --render --strict
+```
 
-Use these with `mountly-mcp-server`.
+Static verification is deterministic and offline. `--render` additionally
+launches Chromium, waits for the explicit bridge mount state, and rejects Views
+that time out, throw, or mount without content. Errors always fail; advisory
+warnings fail only under `--strict`. The same engine is exported as
+`verifyMcpApps()` from `mountly-mcp/testing` for custom test runners. Install
+Playwright and Chromium for the browser tier.
+
+## Reading tool data in a view
+
+The bridge exposes `mcp`, `toolInput`, `toolResult`, and `hostContext`. React
+and Vue consume those bridge props in their wrapper and expose them through
+hooks/composables, leaving the existing component's props unchanged. Svelte
+receives them directly as component props:
+
+```tsx
+// React
+const result = useToolResult<{ structuredContent?: Quote }>();
+const quote = result?.structuredContent;
+useHostStyles(); // adopt the host's theme variables and fonts
+```
+
+```ts
+// Vue
+const result = useToolResult<{ structuredContent?: Quote }>(); // a ref
+const quote = computed(() => result.value?.structuredContent);
+```
+
+Svelte reads the props directly via `$props()` — see `mountly-mcp/svelte`.
+
+## json-render MCP Apps integration
+
+Mountly now exposes a first-class json-render MCP facade so catalog-driven UIs
+can be shipped as MCP Apps with minimal protocol code:
+
+```ts
+import { createJsonRenderMcpApp } from "mountly-mcp/json-render/mcp";
+import { catalog } from "./catalog.js";
+import { html } from "./dist/app-html.js";
+
+const app = createJsonRenderMcpApp({
+  name: "json-render-dashboard",
+  version: "1.0.0",
+  catalog,
+  html,
+  tool: {
+    name: "render_ui",
+    title: "Render UI",
+    description: "Render an interactive dashboard from a json-render spec.",
+    resourceUri: "ui://json-render-dashboard/view.html",
+  },
+});
+```
+
+For iframe-side React hosts, use `mountly-mcp/json-render/app`:
+
+```tsx
+import { useJsonRenderApp } from "mountly-mcp/json-render/app";
+
+function View() {
+  const { spec, loading, connected, error } = useJsonRenderApp({
+    name: "json-render-dashboard",
+    version: "1.0.0",
+  });
+
+  if (error) return <div>{error.message}</div>;
+  if (!connected || loading || !spec) return <div>Waiting…</div>;
+  return <pre>{JSON.stringify(spec, null, 2)}</pre>;
+}
+```
+
+`buildAppHtml({ title, js, css })` is also exported from
+`mountly-mcp/json-render/app` to generate a self-contained HTML resource.
+
+### Interoperability with `@json-render/mcp`
+
+Mountly's facade is wire-compatible with [`@json-render/mcp`](https://www.npmjs.com/package/@json-render/mcp) in both
+directions, so you can mix the two without a bridge:
+
+- **Tool input** is `{ spec }`, typed from `catalog.zodSchema()`, and the tool
+  description carries `catalog.prompt()` — the model sees the full component
+  vocabulary.
+- **Tool output** carries the spec twice: as JSON in `content[0].text` (the
+  shape `@json-render/mcp`'s iframe hook reads) and as `structuredContent.spec`
+  (what Mountly's own hosts read).
+- **`useJsonRenderApp`** reads either shape, so an iframe built with Mountly
+  renders a `@json-render/mcp` server unchanged, and vice versa.
+
+One deliberate difference: `@json-render/core` 0.19 generates a _strict_ catalog
+schema that requires `visible` and `children` on every element, which rejects
+most first-attempt model output at the SDK's input gate. Mountly accepts the
+catalog schema **or** a looser spec shape, then validates in the handler and
+renders what it can. Drop the loose branch once core relaxes those fields.
+
+## Exports
+
+| Entry                  | What's in it                                             |
+| ---------------------- | -------------------------------------------------------- |
+| `mountly-mcp`          | `runBridge`, spec types re-exported from ext-apps        |
+| `mountly-mcp/react`    | `createMcpWidget` + hooks                                |
+| `mountly-mcp/vue`      | `createMcpWidget` + composables                          |
+| `mountly-mcp/svelte`   | `createMcpWidget` (props-based)                          |
+| `mountly-mcp/vite`     | single- and multi-View `mountlyMcpWidget()` build plugin |
+| `mountly-mcp/artifact` | versioned manifest and App artifact APIs                 |
+| `mountly-mcp/dev`      | `startDevHost()` and in-process server connectivity      |
+| `mountly-mcp/build`    | `buildMcpResource` for other bundlers                    |
+| `mountly-mcp/server`   | `registerMcpApps` plus convenience server adapters       |
+| `mountly-mcp/testing`  | static/browser conformance and report formatting         |
+
+Types use the spec's own names (`McpUiHostContext`, `McpUiDisplayMode`, …) —
+one vocabulary, no translation layer.
+
+## Agent Skill
+
+Ask your coding agent for an MCP App and let it scaffold:
+[`plugins/mountly-mcp/skills/create-mcp-widget`](../../../plugins/mountly-mcp/skills/create-mcp-widget/SKILL.md).
 
 ## See also
 
+- [`docs/examples/mcp-app-demo`](../../../docs/examples/mcp-app-demo) — full demo
+  with a sandbox-proxy preview host and an out-of-process stdio check
 - `docs/how-to-test.md`
-- `examples/mcp-app-demo/README.md`
-

package/dist/artifact/index.d.ts

@@ -0,0 +1,49 @@
+import { LATEST_PROTOCOL_VERSION } from "@modelcontextprotocol/ext-apps";
+import type { McpResourceDeclaration } from "../types.js";
+export declare const MCP_APP_MANIFEST_VERSION: 1;
+export declare const MCP_APP_MANIFEST_FILE = "mountly-mcp.manifest.json";
+export interface McpAppArtifact {
+    /** Developer-facing unique key. */
+    name: string;
+    /** Protocol identity. */
+    uri: string;
+    /** Absolute path to the self-contained View HTML. */
+    htmlPath: string;
+    /** Absolute path to the transitional per-View sidecar. */
+    metaPath: string;
+    declaration: McpResourceDeclaration;
+}
+export interface McpAppManifestEntry {
+    name: string;
+    uri: string;
+    /** Path relative to the manifest, unless explicitly absolute. */
+    html: string;
+    /** Path relative to the manifest, unless explicitly absolute. */
+    meta: string;
+    declaration: McpResourceDeclaration;
+}
+export interface McpAppManifest {
+    formatVersion: typeof MCP_APP_MANIFEST_VERSION;
+    protocolVersion: typeof LATEST_PROTOCOL_VERSION;
+    apps: ReadonlyArray<McpAppManifestEntry>;
+}
+export type ConformanceSeverity = "error" | "warning";
+export interface ConformanceDiagnostic {
+    severity: ConformanceSeverity;
+    code: string;
+    message: string;
+    source?: string;
+}
+export declare class McpAppConformanceError extends Error {
+    readonly diagnostics: ReadonlyArray<ConformanceDiagnostic>;
+    constructor(diagnostics: ReadonlyArray<ConformanceDiagnostic>);
+}
+export declare function inspectMcpResourceDeclaration(value: unknown, source?: string): ReadonlyArray<ConformanceDiagnostic>;
+export declare function parseMcpResourceDeclaration(value: unknown, source?: string): McpResourceDeclaration;
+export declare function readMcpAppArtifact(htmlPath: string, expectedUri?: string): Promise<McpAppArtifact>;
+export declare function writeMcpAppManifest(path: string, artifacts: ReadonlyArray<McpAppArtifact>): Promise<McpAppManifest>;
+export declare function readMcpAppManifest(path: string): Promise<{
+    path: string;
+    manifest: McpAppManifest;
+    artifacts: ReadonlyArray<McpAppArtifact>;
+}>;

package/dist/artifact/index.js

@@ -0,0 +1,21 @@
+import {
+  MCP_APP_MANIFEST_FILE,
+  MCP_APP_MANIFEST_VERSION,
+  McpAppConformanceError,
+  inspectMcpResourceDeclaration,
+  parseMcpResourceDeclaration,
+  readMcpAppArtifact,
+  readMcpAppManifest,
+  writeMcpAppManifest
+} from "../chunk-DKK26TRS.js";
+export {
+  MCP_APP_MANIFEST_FILE,
+  MCP_APP_MANIFEST_VERSION,
+  McpAppConformanceError,
+  inspectMcpResourceDeclaration,
+  parseMcpResourceDeclaration,
+  readMcpAppArtifact,
+  readMcpAppManifest,
+  writeMcpAppManifest
+};
+//# sourceMappingURL=index.js.map

package/dist/artifact/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/bridge/iframe-entry.d.ts

@@ -0,0 +1 @@
+export {};