diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index cbd03ea..6848e4c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -24,7 +24,8 @@ jobs: - uses: actions/setup-node@v6 with: - node-version: "20" + node-version: "22" + cache: npm - run: npm ci @@ -71,12 +72,17 @@ jobs: - uses: actions/setup-node@v6 with: - node-version: "20" + node-version: "22" + cache: npm - - run: npm install + - run: npm ci - run: npm run build + - name: Validate TypeDoc links + if: runner.os == 'Linux' && matrix.name == 'Linux x64' + run: npm exec typedoc -- --treatValidationWarningsAsErrors --emit none + - run: npm run examples:build - name: Verify generated schemas are up-to-date @@ -97,9 +103,32 @@ jobs: - name: Build MCPB bundle (pdf-server) if: runner.os == 'Linux' && matrix.name == 'Linux x64' - run: npx -y @anthropic-ai/mcpb pack + run: node build-mcpb.mjs working-directory: examples/pdf-server + - name: Smoke-test MCPB bundle starts + if: runner.os == 'Linux' && matrix.name == 'Linux x64' + run: | + unzip -q pdf-server.mcpb -d .mcpb-smoke + node .mcpb-smoke/dist/index.js --stdio < /dev/null 2>&1 | tee /tmp/mcpb-smoke.log + grep -q "Ready" /tmp/mcpb-smoke.log + working-directory: examples/pdf-server + + dependency-isolation: + name: Dependency isolation + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v6 + + - uses: actions/setup-node@v6 + with: + node-version: "22" + cache: npm + + - run: npm ci + + - run: npm run test:dependency-isolation + e2e: runs-on: ubuntu-latest steps: @@ -111,14 +140,17 @@ jobs: - uses: actions/setup-node@v6 with: - node-version: "20" + node-version: "22" + cache: npm - uses: astral-sh/setup-uv@v7 - run: npm ci + # Headless runs without a channel use chromium-headless-shell, so the + # full Chromium build (about 165 MB) would only be downloaded, never run. - name: Install Playwright browsers - run: npx playwright install --with-deps chromium + run: npx playwright install --with-deps --only-shell chromium - name: Run E2E tests run: npx playwright test --reporter=list @@ -147,13 +179,18 @@ jobs: shell: wsl-bash {0} run: | sudo apt-get update - curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash - + curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash - sudo apt-get install -y nodejs + # The checkout lives on the Windows drive, which WSL reaches over 9P; + # writing node_modules there is what makes this job slow (npm ci alone + # took about 3 minutes). Copy the tree onto the distro's ext4 filesystem + # first, as Microsoft's WSL guidance recommends for anything I/O heavy. - name: Build and test in WSL shell: wsl-bash {0} run: | - npm install + cp -r "$(pwd)" ~/ext-apps && cd ~/ext-apps + npm ci npm run build npm run examples:build npm test @@ -182,7 +219,7 @@ jobs: steps: - uses: actions/setup-node@v6 with: - node-version: "20" + node-version: "22" - name: Create test project and install from git shell: bash diff --git a/.github/workflows/docs-preview.yml b/.github/workflows/docs-preview.yml new file mode 100644 index 0000000..3a170cd --- /dev/null +++ b/.github/workflows/docs-preview.yml @@ -0,0 +1,65 @@ +name: Docs Preview + +on: + pull_request: + types: [opened, synchronize, reopened, closed] + paths: + - "docs/**" + - "src/**" + - "README.md" + - "typedoc.config.mjs" + - "scripts/typedoc-*.mjs" + - ".github/workflows/docs-preview.yml" + +permissions: + contents: read + pull-requests: write + +concurrency: + group: docs-preview-${{ github.event.pull_request.number }} + cancel-in-progress: true + +jobs: + build-and-deploy: + # Refuse to run for fork PRs β€” forks do not have access to the Cloudflare + # secrets, so deploys would fail anyway. + if: >- + github.event.action != 'closed' && + github.event.pull_request.head.repo.full_name == github.repository + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v6 + + - uses: actions/setup-node@v6 + with: + node-version: "22" + cache: npm + + - run: npm ci + + - run: npm run build + + - run: npm run docs + + - name: Deploy preview + uses: modelcontextprotocol/actions/cloudflare-pages-preview/deploy@main + with: + directory: docs + project-name: mcp-ext-apps-docs-preview + api-token: ${{ secrets.CF_PAGES_PREVIEW_API_TOKEN }} + account-id: ${{ secrets.CF_PAGES_PREVIEW_ACCOUNT_ID }} + comment-title: "πŸ“– Docs Preview Deployed" + comment-marker: "" + + cleanup: + if: >- + github.event.action == 'closed' && + github.event.pull_request.head.repo.full_name == github.repository + runs-on: ubuntu-latest + steps: + - uses: modelcontextprotocol/actions/cloudflare-pages-preview/cleanup@main + with: + project-name: mcp-ext-apps-docs-preview + api-token: ${{ secrets.CF_PAGES_PREVIEW_API_TOKEN }} + account-id: ${{ secrets.CF_PAGES_PREVIEW_ACCOUNT_ID }} + comment-marker: "" diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 7232571..a046c29 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -16,8 +16,9 @@ jobs: - uses: oven-sh/setup-bun@v2 - uses: actions/setup-node@v6 with: - node-version: "20" - - run: npm install + node-version: "22" + cache: npm + - run: npm ci - run: npm run build - run: npm run docs - uses: peaceiris/actions-gh-pages@v4 diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml index d969585..ed36c15 100644 --- a/.github/workflows/npm-publish.yml +++ b/.github/workflows/npm-publish.yml @@ -42,6 +42,10 @@ jobs: - run: npm ci - run: npm test + # All publish jobs depend directly on [build, test] (not on each other) so + # they all enter "waiting for approval" together and can be approved in a + # single "Review deployments" click. + publish: runs-on: ubuntu-latest if: github.event_name == 'release' @@ -88,7 +92,7 @@ jobs: runs-on: ubuntu-latest if: github.event_name == 'release' environment: Release - needs: [publish] + needs: [build, test] permissions: contents: read @@ -108,6 +112,7 @@ jobs: - cohort-heatmap-server - customer-segmentation-server - debug-server + - lazy-auth-server - map-server - pdf-server - scenario-modeler-server @@ -134,8 +139,18 @@ jobs: - name: Build example run: npm run build --workspace examples/${{ matrix.example }} + - name: Determine npm tag + id: npm-tag + run: | + VERSION=$(node -p "require('./package.json').version") + if [[ "$VERSION" == *"-"* ]]; then + echo "tag=--tag beta" >> $GITHUB_OUTPUT + else + echo "tag=" >> $GITHUB_OUTPUT + fi + - name: Publish example - run: npm publish --workspace examples/${{ matrix.example }} --provenance --access public + run: npm publish --workspace examples/${{ matrix.example }} --provenance --access public ${{ steps.npm-tag.outputs.tag }} env: NODE_AUTH_TOKEN: ${{ secrets.NPM_SECRET }} @@ -143,7 +158,7 @@ jobs: runs-on: ubuntu-latest if: github.event_name == 'release' environment: Release - needs: [publish-examples] + needs: [build, test] permissions: contents: write @@ -159,12 +174,8 @@ jobs: cache: npm - run: npm ci - - name: Build pdf-server - run: npm run build --workspace examples/pdf-server - - - name: Pack MCPB bundle - run: npx -y @anthropic-ai/mcpb pack - working-directory: examples/pdf-server + - name: Build pdf-server + MCPB bundle + run: npm run build:mcpb --workspace examples/pdf-server - name: Upload MCPB to release run: gh release upload "${{ github.event.release.tag_name }}" examples/pdf-server/*.mcpb --clobber diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 5f1d3ac..478c5b8 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -34,6 +34,7 @@ jobs: ./examples/cohort-heatmap-server \ ./examples/customer-segmentation-server \ ./examples/debug-server \ + ./examples/lazy-auth-server \ ./examples/map-server \ ./examples/pdf-server \ ./examples/scenario-modeler-server \ diff --git a/.github/workflows/update-snapshots.yml b/.github/workflows/update-snapshots.yml index be7cd8b..182f01a 100644 --- a/.github/workflows/update-snapshots.yml +++ b/.github/workflows/update-snapshots.yml @@ -16,10 +16,14 @@ permissions: jobs: update-snapshots: - # Run on workflow_dispatch OR when someone comments "/update-snapshots" on a PR + # Run on workflow_dispatch OR when a maintainer comments "/update-snapshots" on a PR. + # author_association check prevents arbitrary commenters from triggering a job with + # contents:write that pushes a [skip ci] commit to the PR branch. if: > github.event_name == 'workflow_dispatch' || - (github.event.issue.pull_request && contains(github.event.comment.body, '/update-snapshots')) + (github.event.issue.pull_request && + contains(github.event.comment.body, '/update-snapshots') && + contains(fromJSON('["OWNER", "MEMBER", "COLLABORATOR"]'), github.event.comment.author_association)) runs-on: ubuntu-latest steps: - name: Get PR branch @@ -59,7 +63,8 @@ jobs: - uses: actions/setup-node@v6 with: - node-version: "20" + node-version: "22" + cache: npm - uses: astral-sh/setup-uv@v7 diff --git a/.gitignore b/.gitignore index abb7660..5b5486b 100644 --- a/.gitignore +++ b/.gitignore @@ -15,4 +15,6 @@ __pycache__/ *.pyc # MCPB bundles (built artifacts) -*.mcpb \ No newline at end of file +*.mcpb +.mcpb-stage/ +.mcpb-smoke/ \ No newline at end of file diff --git a/.husky/pre-commit b/.husky/pre-commit index 942f085..ae5b3c7 100644 --- a/.husky/pre-commit +++ b/.husky/pre-commit @@ -14,8 +14,16 @@ if grep -E '"resolved": "https?://' package-lock.json | grep -v registry.npmjs.o exit 1 fi +# Capture staged files so we only re-stage what the user intended to commit +# (avoids sweeping unrelated WIP into the commit). --diff-filter=d skips +# deletions so the xargs git add below doesn't fail on removed paths. +STAGED=$(git diff --name-only --cached --diff-filter=d) + npm run build:all npm run prettier:fix -# Stage any files reformatted by prettier (generated files, source, docs, etc.) -git diff --name-only --diff-filter=M | xargs -r git add +# Re-stage originally-staged files (prettier may have reformatted them) +echo "$STAGED" | xargs -r git add + +# Also stage generated files (regenerated by build:all from spec.types.ts) +git add src/generated/ diff --git a/.npmrc b/.npmrc new file mode 100644 index 0000000..214c29d --- /dev/null +++ b/.npmrc @@ -0,0 +1 @@ +registry=https://registry.npmjs.org/ diff --git a/.prettierignore b/.prettierignore index 6d5fc6f..c51df7b 100644 --- a/.prettierignore +++ b/.prettierignore @@ -5,4 +5,5 @@ examples/basic-server-*/**/*.tsx examples/quickstart/**/*.ts **/vendor/** **/.build/** +**/.claude/** SKILL.md diff --git a/AGENTS.md b/AGENTS.md index 41997da..219b947 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -39,7 +39,10 @@ npm test # Check JSDoc comment syntax and `{@link}` references npm exec typedoc -- --treatValidationWarningsAsErrors --emit none -# Regenerate package-lock.json (especially on setups w/ custom npm registry) +# Regenerate package-lock.json +# Note: repo .npmrc pins registry to npmjs.org, so a plain `npm i` is safe even +# if your global npm config points elsewhere. The Docker step below is optional +# β€” it locks linux-amd64 optionalDependencies (sharp, rollup, bun) for CI. rm -fR package-lock.json node_modules && \ docker run --rm -it --platform linux/amd64 -v $PWD:/src:rw -w /src node:latest npm i && \ rm -fR node_modules && \ @@ -57,8 +60,8 @@ rm -fR package-lock.json node_modules && \ ### Key Source Files -- `src/app.ts` - `App` class extends MCP Protocol, handles guest initialization, tool calls, messaging -- `src/app-bridge.ts` - `AppBridge` class for hosts, proxies MCP requests, sends tool input/results to guests +- `src/app.ts` - `App` subclasses `Protocol` from `@modelcontextprotocol/client`, handles View initialization, tool calls, and messaging +- `src/app-bridge.ts` - `AppBridge` subclasses `Protocol` from `@modelcontextprotocol/client` for the iframe channel and proxies through a separate outer `Client` - `src/server/index.ts` - Helpers for MCP servers to register tools/resources with UI metadata - `src/types.ts` - Protocol types re-exported from `spec.types.ts` and Zod schemas from `generated/schema.ts` (auto-generated during build) - `src/message-transport.ts` - `PostMessageTransport` for iframe communication @@ -67,12 +70,12 @@ rm -fR package-lock.json node_modules && \ ### Protocol Flow ``` -View (App) <--PostMessageTransport--> Host (AppBridge) <--MCP Client--> MCP Server +View (App/Protocol) <--PostMessageTransport--> Host (AppBridge/Protocol) <--separate MCP Client--> MCP Server ``` 1. Host creates iframe with view HTML 2. View creates `App` instance and calls `connect()` with `PostMessageTransport` -3. View sends `ui/initialize` request, receives host capabilities and context +3. View sends `ui/initialize` (the only handshake on the iframe channel) and receives authoritative Apps capabilities and context 4. Host sends `sendToolInput()` with tool arguments after initialization 5. View can call server tools via `app.callServerTool()` or send messages via `app.sendMessage()` 6. Host sends `sendToolResult()` when tool execution completes diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7ca6368..e28dcd1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,6 +27,14 @@ We welcome contributions to the MCP Apps SDK! This document outlines the process - Provide a clear description of changes - **Keep "Allow edits by maintainers" checked** when opening your PR β€” this lets maintainers rebase your branch and lets the [`/update-snapshots` workflow](#updating-snapshots-in-ci) push updated screenshots to it +## Examples Policy + +The examples in `examples/` are maintained by the core team. **We do not accept pull requests that add new example servers from outside contributors.** Each example carries an ongoing maintenance cost β€” keeping it building, tested, and up to date with SDK changes β€” so we are deliberate about what we add. + +If you have an idea for an example that would provide significant educational value, please [open an issue](https://github.com/modelcontextprotocol/ext-apps/issues) describing what the example would demonstrate and why it would be useful, and maintainers will evaluate the request. + +PRs that add new examples without a prior approved issue may be closed. + ## Running Examples Start the development environment with hot reloading: @@ -494,7 +502,7 @@ Alternatively, use the [workflow dispatch](https://github.com/modelcontextprotoc ## Code of Conduct -This project follows our [Code of Conduct](CODE_OF_CONDUCT.md). Please review it before contributing. +This project follows our [Code of Conduct](https://github.com/modelcontextprotocol/.github/blob/main/CODE_OF_CONDUCT.md). Please review it before contributing. ## Reporting Issues @@ -531,40 +539,17 @@ Before publishing releases, ensure the following are configured: ### Publishing a Release -Releases are published automatically via GitHub Actions when a GitHub Release is created. - -#### Steps to publish: - -1. **Update the version** in `package.json`: +1. **Bump the version** across the root and all workspace packages: ```bash - # For a regular release - npm version patch # or minor, or major - - # For a beta release - npm version prerelease --preid=beta + npm run bump -- minor # or: patch | major | prerelease --preid=beta | 1.7.0 ``` -2. **Commit the version bump** (if not done by `npm version`): + Commit and open a PR with a grouped changelog in the body (see prior `chore: bump …` PRs for the format). - ```bash - git add package.json - git commit -m "Bump version to X.Y.Z" - git push origin main - ``` +2. **Merge the PR**, then [draft a GitHub Release](https://github.com/modelcontextprotocol/ext-apps/releases/new) β€” create a `vX.Y.Z` tag on `main`, paste the changelog, publish. -3. **Create a GitHub Release**: - - Go to [Releases](https://github.com/modelcontextprotocol/ext-apps/releases) - - Click "Draft a new release" - - Create a new tag matching the version (e.g., `v0.1.0`) - - Set the target branch (usually `main`) - - Write release notes describing the changes - - Click "Publish release" - -4. **Monitor the workflow**: - - The [npm-publish workflow](https://github.com/modelcontextprotocol/ext-apps/actions/workflows/npm-publish.yml) will trigger automatically - - It runs build and test jobs before publishing - - On success, the package is published to npm with provenance +3. **Approve the deployment** β€” publishing the Release triggers the [npm-publish workflow](https://github.com/modelcontextprotocol/ext-apps/actions/workflows/npm-publish.yml); all publish jobs wait together for a single "Review deployments" approval. #### npm Tags @@ -588,7 +573,7 @@ To release a patch for an older version: ### Testing Pre-releases -Every commit and PR automatically publishes a preview package via [pkg-pr-new](https://github.com/pkg-pr-new/pkg-pr-new). Check the PR comments or workflow logs for the install command. +Every commit and PR automatically publishes a preview package via [pkg-pr-new](https://github.com/stackblitz-labs/pkg.pr.new). Check the PR comments or workflow logs for the install command. --- diff --git a/README.md b/README.md index 73125c4..ab4004d 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,17 @@
- MCP Apps - MCP Apps + + + + MCP Apps +

MCP Apps

Build interactive UIs for MCP tools β€” charts, forms, dashboards β€” that render inline in Claude, ChatGPT and any other compliant chat client.

Why Β· - Quickstart + Quickstart Β· API Docs Β· @@ -86,6 +89,8 @@ it will guide you through the rest. Goose Postman MCPJam + mcp-use + Alpic Playground

> [!NOTE] @@ -117,12 +122,36 @@ resources: ## Getting Started +Requires Node.js 20+. The base MCP SDK packages are `^2.0.0` peers of +`ext-apps` (`@modelcontextprotocol/core` is a required peer that `client` already depends on, so npm installs it for you). + +For a View or host: + ```bash -npm install -S @modelcontextprotocol/ext-apps +npm install -S @modelcontextprotocol/ext-apps \ + @modelcontextprotocol/client@^2.0.0 \ + zod@^4.2.0 ``` +For an MCP server, add the server package (and, for HTTP transports, the Node +and Express adapters): + +```bash +npm install -S @modelcontextprotocol/ext-apps \ + @modelcontextprotocol/client@^2.0.0 \ + @modelcontextprotocol/server@^2.0.0 \ + @modelcontextprotocol/node@^2.0.0 \ + @modelcontextprotocol/express@^2.0.0 \ + zod@^4.2.0 +``` + +The wire protocol is unchanged between `ext-apps` 1.x and 2.x: a 2.x View works +in a 1.x host and a 2.x host renders 1.x Views. See the +[migration guide](https://apps.extensions.modelcontextprotocol.io/api/documents/migrate-to-v2.html) +when upgrading from 1.x. + **New here?** Start with the -[Quickstart Guide](https://apps.extensions.modelcontextprotocol.io/api/documents/Quickstart.html) +[Quickstart Guide](https://apps.extensions.modelcontextprotocol.io/api/documents/quickstart.html) to build your first MCP App. ## Using the SDK @@ -136,7 +165,7 @@ UI metadata. | `@modelcontextprotocol/ext-apps` | Build interactive Views (App class, PostMessageTransport) | [API Docs β†’](https://apps.extensions.modelcontextprotocol.io/api/modules/app.html) | | `@modelcontextprotocol/ext-apps/react` | React hooks for Views (useApp, useHostStyles, etc.) | [API Docs β†’](https://apps.extensions.modelcontextprotocol.io/api/modules/_modelcontextprotocol_ext-apps_react.html) | | `@modelcontextprotocol/ext-apps/app-bridge` | Embed and communicate with Views in your chat client | [API Docs β†’](https://apps.extensions.modelcontextprotocol.io/api/modules/app-bridge.html) | -| `@modelcontextprotocol/ext-apps/server` | Register tools and resources on your MCP server | [API Docs β†’](https://apps.extensions.modelcontextprotocol.io/api/modules/server.html) | +| `@modelcontextprotocol/ext-apps/server` | Register tools and resources on your MCP server | [API Docs β†’](https://apps.extensions.modelcontextprotocol.io/api/modules/server-helpers.html) | There's no _supported_ host implementation in this repo (beyond the [examples/basic-host](https://github.com/modelcontextprotocol/ext-apps/tree/main/examples/basic-host) @@ -243,7 +272,7 @@ point your client at a local build: ## Resources -- [Quickstart Guide](https://apps.extensions.modelcontextprotocol.io/api/documents/Quickstart.html) +- [Quickstart Guide](https://apps.extensions.modelcontextprotocol.io/api/documents/quickstart.html) - [API Documentation](https://apps.extensions.modelcontextprotocol.io/api/) - [Specification (2026-01-26)](https://github.com/modelcontextprotocol/ext-apps/blob/main/specification/2026-01-26/apps.mdx) ([Draft](https://github.com/modelcontextprotocol/ext-apps/blob/main/specification/draft/apps.mdx)) diff --git a/build.bun.ts b/build.bun.ts index 0e53418..61361e6 100644 --- a/build.bun.ts +++ b/build.bun.ts @@ -1,9 +1,18 @@ #!/usr/bin/env bun import { $ } from "bun"; +import { cpSync, mkdirSync, rmSync } from "node:fs"; + +// Avoid publishing artifacts left behind by an earlier build or branch. +rmSync("dist", { recursive: true, force: true }); // Run TypeScript compiler for type declarations await $`tsc`; +// Copy schema.json (tsc is emitDeclarationOnly, Bun.build doesn't emit JSON assets). +// Needed for the "./schema.json" package export. +mkdirSync("dist/src/generated", { recursive: true }); +cpSync("src/generated/schema.json", "dist/src/generated/schema.json"); + const isDevelopment = Bun.env.NODE_ENV === "development"; // Build all JavaScript/TypeScript files @@ -25,10 +34,20 @@ function buildJs( }); } +// Peer dependencies stay external in the standard entry points so consumers +// share one base MCP SDK and Zod instance. The *-with-deps entry points keep +// bundling these dependencies for standalone browser use. +const PEER_EXTERNALS = [ + "@modelcontextprotocol/client", + "@modelcontextprotocol/core", + "@modelcontextprotocol/server", + "zod", +]; + await Promise.all([ buildJs("src/app.ts", { outdir: "dist/src", - external: ["@modelcontextprotocol/sdk"], + external: PEER_EXTERNALS, }), buildJs("src/app.ts", { outdir: "dist/src", @@ -36,19 +55,19 @@ await Promise.all([ }), buildJs("src/app-bridge.ts", { outdir: "dist/src", - external: ["@modelcontextprotocol/sdk"], + external: PEER_EXTERNALS, }), buildJs("src/react/index.tsx", { outdir: "dist/src/react", - external: ["react", "react-dom", "@modelcontextprotocol/sdk"], + external: ["react", "react-dom", ...PEER_EXTERNALS], }), buildJs("src/react/index.tsx", { outdir: "dist/src/react", - external: ["react", "react-dom", "@modelcontextprotocol/sdk"], + external: ["react", "react-dom"], naming: { entry: "react-with-deps.js" }, }), buildJs("src/server/index.ts", { outdir: "dist/src/server", - external: ["@modelcontextprotocol/sdk"], + external: PEER_EXTERNALS, }), ]); diff --git a/docs/authorization.md b/docs/authorization.md index 59fc26c..df7adc6 100644 --- a/docs/authorization.md +++ b/docs/authorization.md @@ -150,7 +150,7 @@ registerAppTool( "get_account_balance", { description: "Get account balance", - inputSchema: { accountId: z.string() }, + inputSchema: z.object({ accountId: z.string() }), }, async ({ accountId }) => { if (!authInfo) { diff --git a/docs/mcp-theme.css b/docs/mcp-theme.css index 8dd2041..d786e55 100644 --- a/docs/mcp-theme.css +++ b/docs/mcp-theme.css @@ -2,21 +2,23 @@ * MCP Apps custom theme β€” aligns TypeDoc styling with modelcontextprotocol.io */ -@import url('https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap'); +@import url("https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap"); /* ------------------------------------------------------------------ */ /* Fonts */ /* ------------------------------------------------------------------ */ :root { - --font-family-text: 'Inter', -apple-system, BlinkMacSystemFont, 'Segoe UI', sans-serif; - --font-family-code: 'JetBrains Mono', ui-monospace, SFMono-Regular, Menlo, Consolas, monospace; + --font-family-text: + "Inter", -apple-system, BlinkMacSystemFont, "Segoe UI", sans-serif; + --font-family-code: + "JetBrains Mono", ui-monospace, SFMono-Regular, Menlo, Consolas, monospace; } body { - font-family: var(--font-family-text); - -webkit-font-smoothing: antialiased; - -moz-osx-font-smoothing: grayscale; + font-family: var(--font-family-text); + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; } /* ------------------------------------------------------------------ */ @@ -24,12 +26,12 @@ body { /* ------------------------------------------------------------------ */ :root { - --light-color-background: #ffffff; - --light-color-background-secondary: #f9fafb; - --light-color-background-navbar: #ffffff; - --light-color-accent: #e5e7eb; - --light-color-text: #111827; - --light-color-text-aside: #6b7280; + --light-color-background: #ffffff; + --light-color-background-secondary: #f9fafb; + --light-color-background-navbar: #ffffff; + --light-color-accent: #e5e7eb; + --light-color-text: #111827; + --light-color-text-aside: #6b7280; } /* ------------------------------------------------------------------ */ @@ -37,12 +39,12 @@ body { /* ------------------------------------------------------------------ */ :root { - --dark-color-background: #0f1117; - --dark-color-background-secondary: #161b22; - --dark-color-background-navbar: #0f1117; - --dark-color-accent: #30363d; - --dark-color-text: #f0f6fc; - --dark-color-text-aside: #8b949e; + --dark-color-background: #0f1117; + --dark-color-background-secondary: #161b22; + --dark-color-background-navbar: #0f1117; + --dark-color-accent: #30363d; + --dark-color-text: #f0f6fc; + --dark-color-text-aside: #8b949e; } /* ------------------------------------------------------------------ */ @@ -50,32 +52,55 @@ body { /* ------------------------------------------------------------------ */ :root { - --dim-toolbar-contents-height: 3.5rem; + --dim-toolbar-contents-height: 3.5rem; } .tsd-page-toolbar { - backdrop-filter: blur(12px); - -webkit-backdrop-filter: blur(12px); + backdrop-filter: blur(12px); + -webkit-backdrop-filter: blur(12px); } @media (prefers-color-scheme: light) { - .tsd-page-toolbar { - background-color: rgba(255, 255, 255, 0.85); - } + .tsd-page-toolbar { + background-color: rgba(255, 255, 255, 0.85); + } } @media (prefers-color-scheme: dark) { - .tsd-page-toolbar { - background-color: rgba(15, 17, 23, 0.75); - } + .tsd-page-toolbar { + background-color: rgba(15, 17, 23, 0.75); + } } -:root[data-theme='light'] .tsd-page-toolbar { - background-color: rgba(255, 255, 255, 0.85); +:root[data-theme="light"] .tsd-page-toolbar { + background-color: rgba(255, 255, 255, 0.85); } -:root[data-theme='dark'] .tsd-page-toolbar { - background-color: rgba(15, 17, 23, 0.75); +:root[data-theme="dark"] .tsd-page-toolbar { + background-color: rgba(15, 17, 23, 0.75); +} + +/* ------------------------------------------------------------------ */ +/* Theme-aware logo (rewritten from README by mcpstyle plugin) */ +/* ------------------------------------------------------------------ */ + +/* Explicit theme selection via TypeDoc switcher β€” takes precedence */ +:root[data-theme="light"] .mcp-logo-dark, +:root[data-theme="dark"] .mcp-logo-light { + display: none; +} + +/* "OS" mode (data-theme='os') follows prefers-color-scheme */ +@media (prefers-color-scheme: light) { + :root[data-theme="os"] .mcp-logo-dark { + display: none; + } +} + +@media (prefers-color-scheme: dark) { + :root[data-theme="os"] .mcp-logo-light { + display: none; + } } /* ------------------------------------------------------------------ */ @@ -83,66 +108,68 @@ body { /* ------------------------------------------------------------------ */ .tsd-navigation a { - padding: 0.375rem 0.75rem; - font-size: 0.875rem; - line-height: 1.5; - border-radius: 0.75rem; - color: var(--color-text-aside); - transition: background-color 0.15s ease, color 0.15s ease; + padding: 0.375rem 0.75rem; + font-size: 0.875rem; + line-height: 1.5; + border-radius: 0.75rem; + color: var(--color-text-aside); + transition: + background-color 0.15s ease, + color 0.15s ease; } .tsd-navigation a:hover:not(.current) { - background-color: rgba(107, 114, 128, 0.05); - color: var(--color-text); + background-color: rgba(107, 114, 128, 0.05); + color: var(--color-text); } .tsd-navigation a.current { - background-color: rgba(107, 114, 128, 0.15); - color: var(--color-text); - font-weight: 700; + background-color: rgba(107, 114, 128, 0.15); + color: var(--color-text); + font-weight: 700; } /* Group headers (Documents, Security, API Documentation) */ .tsd-accordion-summary > h3 { - font-weight: 600; - font-size: 0.875rem; - letter-spacing: 0.01em; + font-weight: 600; + font-size: 0.875rem; + letter-spacing: 0.01em; } .site-menu { - padding: 1.25rem 0; + padding: 1.25rem 0; } @media (prefers-color-scheme: dark) { - .tsd-navigation a { - color: var(--color-text-aside); - } + .tsd-navigation a { + color: var(--color-text-aside); + } - .tsd-navigation a:hover:not(.current) { - background-color: rgba(229, 231, 235, 0.05); - color: var(--color-text); - } + .tsd-navigation a:hover:not(.current) { + background-color: rgba(229, 231, 235, 0.05); + color: var(--color-text); + } - .tsd-navigation a.current { - background-color: rgba(229, 231, 235, 0.15); - color: var(--color-text); - font-weight: 700; - } + .tsd-navigation a.current { + background-color: rgba(229, 231, 235, 0.15); + color: var(--color-text); + font-weight: 700; + } } -:root[data-theme='dark'] .tsd-navigation a { - color: var(--color-text-aside); +:root[data-theme="dark"] .tsd-navigation a { + color: var(--color-text-aside); } -:root[data-theme='dark'] .tsd-navigation a:hover:not(.current) { - background-color: rgba(229, 231, 235, 0.05); - color: var(--color-text); +:root[data-theme="dark"] .tsd-navigation a:hover:not(.current) { + background-color: rgba(229, 231, 235, 0.05); + color: var(--color-text); } -:root[data-theme='dark'] .tsd-navigation a.current { - background-color: rgba(229, 231, 235, 0.15); - color: var(--color-text); - font-weight: 700; +:root[data-theme="dark"] .tsd-navigation a.current { + background-color: rgba(229, 231, 235, 0.15); + color: var(--color-text); + font-weight: 700; } /* ------------------------------------------------------------------ */ @@ -150,21 +177,21 @@ body { /* ------------------------------------------------------------------ */ .tsd-typography { - line-height: 1.6; + line-height: 1.6; } .tsd-panel.tsd-typography h1 { - margin-top: 0; - padding-bottom: 0.4em; + margin-top: 0; + padding-bottom: 0.4em; } .tsd-panel.tsd-typography h2 { - margin-top: 2rem; - padding-bottom: 0.3em; + margin-top: 2rem; + padding-bottom: 0.3em; } .tsd-panel.tsd-typography h3 { - margin-top: 1.75rem; + margin-top: 1.75rem; } /* ------------------------------------------------------------------ */ @@ -173,17 +200,17 @@ body { code, pre { - font-family: var(--font-family-code); - font-size: 1em; + font-family: var(--font-family-code); + font-size: 1em; } .tsd-typography pre { - padding: 1rem 1.25rem; - border: 1px solid var(--color-accent); + padding: 1rem 1.25rem; + border: 1px solid var(--color-accent); } /* Inline code */ .tsd-typography code:not(pre code) { - padding: 0.15em 0.35em; - font-size: 1em; + padding: 0.15em 0.35em; + font-size: 1em; } diff --git a/docs/migrate-to-2.md b/docs/migrate-to-2.md new file mode 100644 index 0000000..f9341d0 --- /dev/null +++ b/docs/migrate-to-2.md @@ -0,0 +1,130 @@ +--- +title: Migrate to v2 +group: Getting Started +description: Upgrade from ext-apps 1.x to 2.x β€” new base MCP SDK peer packages, API changes for Views and hosts, and what stays wire-compatible. +--- + +# Migrating from ext-apps 1.x to 2.x + +ext-apps 2.x is built on the base MCP TypeScript SDK 2.x, which replaced the +single `@modelcontextprotocol/sdk` package with `@modelcontextprotocol/client`, +`server`, `core`, `node` and `express`. The MCP Apps wire protocol did not +change; the breaking changes are in dependencies and in the TypeScript API. + +## Host compatibility + +The `ui/*` messages exchanged over the iframe channel are byte-identical to +1.x. A 2.x View runs in a 1.x host and a 2.x host renders 1.x Views. The only +host-side deltas are in error responses (see below). + +## What stays the same + +`App` / `AppBridge` constructors, the `on*` setters, `addEventListener`, +`callServerTool`, `readServerResource`, `registerAppResource`, the React hooks +and the `_meta.ui.resourceUri` handling are unchanged. Published `.d.ts` files +now resolve under `moduleResolution: NodeNext` / `Node16` without workarounds +(#705). + +## Peer dependencies by role + +| Role | Install | +| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| View author | `@modelcontextprotocol/ext-apps`, `@modelcontextprotocol/client@^2.0.0`, `zod@^4.2.0` (+ `react`/`react-dom` for `./react`) | +| Host author | same as View author | +| MCP server author | View author packages + `@modelcontextprotocol/server@^2.0.0`; for HTTP transports also `@modelcontextprotocol/node@^2.0.0` (`NodeStreamableHTTPServerTransport`) and `@modelcontextprotocol/express@^2.0.0` (`createMcpExpressApp`, which peers on `express`) | +| CDN / `*-with-deps` | nothing extra: `./app-with-deps` and `./react-with-deps` bundle client, core and zod (about 25% larger than the 1.x bundles) | + +`@modelcontextprotocol/client` is a required peer (`App` and `AppBridge` extend +its `Protocol` class); `@modelcontextprotocol/core` is a required peer that `client` already depends on, so npm installs it without you listing it; +`@modelcontextprotocol/server` stays optional and is only needed for the +`./server` helpers. Node.js 20+ is required. + +## Breaking changes + +- **Peer packages.** `@modelcontextprotocol/sdk@^1` is replaced by the split + 2.x packages above, all at `^2.0.0`. Remove the 1.x package from your + project: the two SDKs share no classes or types (a 1.x `McpError` or + `Client` cannot be passed to 2.x code), even though they speak the same + wire protocol. +- **zod 3 dropped.** The peer range is `zod@^4.2.0`. Tool schemas must + implement Standard JSON Schema (`~standard.jsonSchema`): zod 4.2+, ArkType, + Valibot. zod 4.0 and 4.1 do not expose `~standard.jsonSchema` and are + rejected too. Raw zod shapes (`{ q: z.string() }`) still work with + `registerAppTool` but are deprecated; wrap them with `z.object({...})`. +- **`App` / `AppBridge` extend `Protocol` from `@modelcontextprotocol/client`.** + `ProtocolWithEvents` is gone; use the SDK's `Protocol`. The `AppRequest`, + `AppNotification` and `AppResult` unions are kept as deprecated type + aliases (nothing in 2.x consumes them) and will be removed in 3.0. +- **Handler context.** Custom request handlers, `registerAppTool` callbacks + (server) and `app.registerTool` callbacks (View) receive the SDK 2.x + context: `extra.signal` β†’ `extra.mcpReq.signal`, `extra.requestId` β†’ + `extra.mcpReq.id`; `extra.sessionId` is unchanged and `extra.authInfo` + moved to `extra.http?.authInfo`. +- **`setRequestHandler` / `setNotificationHandler` take method names.** + `app.setRequestHandler(SomeRequestSchema, handler)` becomes + `app.setRequestHandler("some/method", { params: SomeParamsSchema }, (params, ctx) => …)` + for custom methods (the handler receives the parsed params); the two-argument + `setRequestHandler("tools/call", handler)` form exists only for spec-defined + method names. The 1.x `(Schema, handler)` form still works on `App` and + `AppBridge` as a deprecated overload: it logs a one-time warning, hands the + handler the whole `{ method, params }` message as before, and gives request + handlers a 1.x-shaped `extra` (`signal`, `requestId`, `sessionId`, `_meta`, + `sendRequest`, `sendNotification`, `authInfo`; exported as + `LegacyRequestHandlerExtra`). It will be removed in 3.0. +- **Double-registration guard covers the SDK's own handlers.** Registering a + handler for `notifications/progress` or `notifications/cancelled` (which + the base `Protocol` already owns) now throws `already registered`, as + `ping` and the `on*`-owned methods did in 1.x. Use `addEventListener` or + the SDK's progress callbacks instead of replacing these. +- **Errors.** Remote JSON-RPC errors are `ProtocolError` (numeric `code`); + local conditions are `SdkError` with a string `code`: request timeout β†’ + `"REQUEST_TIMEOUT"`, connection closed β†’ `"CONNECTION_CLOSED"`. Cancelling a + request with an `AbortSignal` also rejects with `"REQUEST_TIMEOUT"` (the + message is the abort reason). Messages no longer carry the `MCP error N:` + prefix. + A resource-not-found reply that carries `data.uri` arrives as + `ResourceNotFoundError` (a `ProtocolError` subclass, `code` `-32602`, with a + `.uri` getter). + +## Host-side wire deltas + +Observed when a 2.x `AppBridge` answers a View; a 1.x View sees these too. + +| Situation | 1.x host | 2.x host | +| --------------------------------------------------------- | ------------------------------ | --------------------------------------------------- | +| A handler throws `-32002` (resource not found) | `error.code: -32002` | `error.code: -32602` (the SDK never emits `-32002`) | +| Invalid params on a `ui/*` request | `-32603` with a zod issue dump | `-32602 Invalid params for : …` | +| Error message text | `MCP error -32602: …` prefix | plain message | +| `tools/call` to an unknown tool through a 2.x `McpServer` | `result.isError: true` | JSON-RPC error `-32602` (`callServerTool` rejects) | + +## `schema.json` + +The published `./schema.json` export is regenerated from the 2.x core schemas: + +- `McpUiToolResultNotification.params.structuredContent` is any JSON value (was + `type: "object"`). +- `McpUiToolResultNotification.params._meta` documents + `io.modelcontextprotocol/serverInfo` and no longer lists `progressToken` / + `related-task` (both still pass through). +- `McpUiHostContext.toolInfo.tool.outputSchema` is a loose object (only + `$schema` is documented); `inputSchema.properties` values are now typed as + JSON values. +- A recursive JSON-value definition (`__schema0`) is added under the `$defs` of + `McpUiHostContext`, `McpUiHostContextChangedNotification` and + `McpUiInitializeResult`. + +## Checklist + +1. `npm uninstall @modelcontextprotocol/sdk` and install the packages for your + role from the table above. +2. Replace `sdk/...` imports with the split packages (`sdk/server/mcp.js` β†’ + `@modelcontextprotocol/server`, `sdk/server/streamableHttp.js` β†’ + `NodeStreamableHTTPServerTransport` from `@modelcontextprotocol/node`, + `sdk/server/stdio.js` β†’ `@modelcontextprotocol/server/stdio`, hand-written + Express routing β†’ `createMcpExpressApp` from `@modelcontextprotocol/express`, + `sdk/types.js` β†’ `@modelcontextprotocol/client` or `server` for the types, + `@modelcontextprotocol/core` for the zod schemas). +3. Wrap raw zod shapes with `z.object({...})`. +4. Update custom handlers to the `extra.mcpReq.*` context and method-keyed + `setRequestHandler` calls. +5. Replace `McpError` / numeric-code checks with `ProtocolError` / `SdkError`. diff --git a/docs/migrate_from_openai_apps.md b/docs/migrate_from_openai_apps.md index d91281b..22d5d9f 100644 --- a/docs/migrate_from_openai_apps.md +++ b/docs/migrate_from_openai_apps.md @@ -66,7 +66,7 @@ The server-side changes involve updating metadata structure and using helper fun #### Before (OpenAI) ```typescript -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; +import { McpServer } from "@modelcontextprotocol/server"; import { z } from "zod"; function createServer() { @@ -78,7 +78,7 @@ function createServer() { { title: "Shopping Cart", description: "Display the user's shopping cart", - inputSchema: { userId: z.string() }, + inputSchema: z.object({ userId: z.string() }), annotations: { readOnlyHint: true }, _meta: { "openai/outputTemplate": "ui://view/cart.html", @@ -126,7 +126,7 @@ function createServer() { #### After (MCP Apps) ```typescript -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; +import { McpServer } from "@modelcontextprotocol/server"; import { registerAppTool, registerAppResource, @@ -144,7 +144,7 @@ function createServer() { { title: "Shopping Cart", description: "Display the user's shopping cart", - inputSchema: { userId: z.string() }, + inputSchema: z.object({ userId: z.string() }), annotations: { readOnlyHint: true }, _meta: { ui: { resourceUri: "ui://view/cart.html" } }, }, diff --git a/docs/overview.md b/docs/overview.md index 28f5b23..8eda95d 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -56,7 +56,11 @@ flowchart LR - **Host** β€” The chat client (e.g., Claude Desktop) that connects to servers, embeds Views in iframes, and proxies communication between them. - **View** β€” The UI running inside a sandboxed iframe. It receives tool data from the Host and can call server tools or send messages back to the chat. -The View acts as an MCP client, the Host acts as a proxy, and the Server is a standard MCP server. +The View's `App` and the Host's `AppBridge` both subclass the `Protocol` class +exported by `@modelcontextprotocol/client` for the iframe channel. A separate outer `Client` connects +the Host to the actual MCP Server. Keeping those two connections separate +preserves the Apps-only iframe handshake and prevents iframe capabilities from +leaking into the server connection. ## Lifecycle @@ -93,7 +97,7 @@ sequenceDiagram ``` 1. **Discovery** β€” The Host learns about tools and their UI resources when connecting to the server. -2. **Initialization** β€” When a UI tool is called, the Host renders the iframe. The View sends `ui/initialize` and receives host context (theme, capabilities, container dimensions). This handshake ensures the View is ready before receiving data. +2. **Initialization** β€” When a UI tool is called, the Host renders the iframe. The View sends `ui/initialize` (the only handshake on the iframe channel) and receives host context (theme, capabilities, container dimensions). `ui/initialize` is authoritative for Apps capabilities and identity, and `ui/notifications/initialized` is the public View-ready signal. 3. **Data delivery** β€” The Host sends tool arguments and, once available, tool results to the View. Results include both `content` (text for the model's context) and optionally `structuredContent` (data optimized for UI rendering). This separation lets servers provide rich data to the UI without bloating the model's context. 4. **Interactive phase** β€” The user interacts with the View. The View can call tools, send messages, or update context. 5. **Teardown** β€” Before unmounting, the Host notifies the View so it can save state or release resources. diff --git a/docs/patterns.md b/docs/patterns.md index 87a6d82..884de26 100644 --- a/docs/patterns.md +++ b/docs/patterns.md @@ -19,7 +19,7 @@ registerAppTool( "update-quantity", { description: "Update item quantity in cart", - inputSchema: { itemId: z.string(), quantity: z.number() }, + inputSchema: z.object({ itemId: z.string(), quantity: z.number() }), _meta: { ui: { resourceUri: "ui://shop/cart.html", @@ -127,14 +127,14 @@ registerAppTool( { title: "Read Data Bytes", description: "Load binary data in chunks", - inputSchema: { + inputSchema: z.object({ id: z.string().describe("Resource identifier"), offset: z.number().min(0).default(0).describe("Byte offset"), byteCount: z .number() .default(MAX_CHUNK_BYTES) .describe("Bytes to read"), - }, + }), outputSchema: DataChunkSchema, // Hidden from model - only callable by the App _meta: { ui: { visibility: ["app"] } }, @@ -281,10 +281,7 @@ server.registerResource( ```ts source="./patterns.tsx#binaryBlobResourceClient" -const result = await app.request( - { method: "resources/read", params: { uri: `video://${videoId}` } }, - ReadResourceResultSchema, -); +const result = await app.readServerResource({ uri: `video://${videoId}` }); const content = result.contents[0]; if (!content || !("blob" in content)) { diff --git a/docs/patterns.tsx b/docs/patterns.tsx index 6b87692..bb9eaa4 100644 --- a/docs/patterns.tsx +++ b/docs/patterns.tsx @@ -17,16 +17,12 @@ import { randomUUID } from "node:crypto"; import type { CallToolResult, ReadResourceResult, -} from "@modelcontextprotocol/sdk/types.js"; -import { ReadResourceResultSchema } from "@modelcontextprotocol/sdk/types.js"; +} from "@modelcontextprotocol/server"; import type { McpUiHostContext } from "../src/types.js"; import { useEffect, useState } from "react"; import { useApp } from "../src/react/index.js"; import { registerAppTool } from "../src/server/index.js"; -import { - McpServer, - ResourceTemplate, -} from "@modelcontextprotocol/sdk/server/mcp.js"; +import { McpServer, ResourceTemplate } from "@modelcontextprotocol/server"; import { z } from "zod"; /** @@ -117,14 +113,14 @@ function chunkedDataServer(server: McpServer) { { title: "Read Data Bytes", description: "Load binary data in chunks", - inputSchema: { + inputSchema: z.object({ id: z.string().describe("Resource identifier"), offset: z.number().min(0).default(0).describe("Byte offset"), byteCount: z .number() .default(MAX_CHUNK_BYTES) .describe("Bytes to read"), - }, + }), outputSchema: DataChunkSchema, // Hidden from model - only callable by the App _meta: { ui: { visibility: ["app"] } }, @@ -252,10 +248,7 @@ function binaryBlobResourceServer( */ async function binaryBlobResourceClient(app: App, videoId: string) { //#region binaryBlobResourceClient - const result = await app.request( - { method: "resources/read", params: { uri: `video://${videoId}` } }, - ReadResourceResultSchema, - ); + const result = await app.readServerResource({ uri: `video://${videoId}` }); const content = result.contents[0]; if (!content || !("blob" in content)) { diff --git a/docs/quickstart.md b/docs/quickstart.md index 3e00796..a021912 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -21,7 +21,7 @@ This tutorial assumes you've built an MCP server before and are comfortable with We'll use the [MCP TypeScript SDK](https://github.com/modelcontextprotocol/typescript-sdk) to build the server. -You'll also need Node.js 18+. +You'll also need Node.js 20+. ## 1. Set up the project @@ -37,7 +37,7 @@ Install the dependencies you'll need: ```bash npm init -y -npm install @modelcontextprotocol/ext-apps @modelcontextprotocol/sdk express cors +npm install @modelcontextprotocol/ext-apps @modelcontextprotocol/client@^2.0.0 @modelcontextprotocol/server@^2.0.0 @modelcontextprotocol/node@^2.0.0 @modelcontextprotocol/express@^2.0.0 zod@^4.2.0 express cors npm install -D typescript vite vite-plugin-singlefile @types/express @types/cors @types/node tsx concurrently cross-env ``` @@ -59,6 +59,7 @@ npm pkg set scripts.start='concurrently --raw "cross-env NODE_ENV=development IN ```json source="../examples/quickstart/tsconfig.json" { "compilerOptions": { + "types": ["node", "vite/client"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", @@ -87,6 +88,7 @@ npm pkg set scripts.start='concurrently --raw "cross-env NODE_ENV=development IN ```json source="../examples/quickstart/tsconfig.server.json" { "compilerOptions": { + "types": ["node"], "target": "ES2022", "lib": ["ES2022"], "module": "NodeNext", @@ -178,9 +180,10 @@ import { registerAppTool, RESOURCE_MIME_TYPE, } from "@modelcontextprotocol/ext-apps/server"; -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; +import { McpServer } from "@modelcontextprotocol/server"; import fs from "node:fs/promises"; import path from "node:path"; +import { z } from "zod"; const DIST_DIR = path.join(import.meta.dirname, "dist"); @@ -205,7 +208,7 @@ export function createServer(): McpServer { { title: "Get Time", description: "Returns the current server time.", - inputSchema: {}, + inputSchema: z.object({}), _meta: { ui: { resourceUri } }, // Links this tool to its UI resource }, async () => { @@ -240,10 +243,10 @@ export function createServer(): McpServer { ```ts source="../examples/quickstart/main.ts" -import { createMcpExpressApp } from "@modelcontextprotocol/sdk/server/express.js"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; -import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { createMcpExpressApp } from "@modelcontextprotocol/express"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; +import type { McpServer } from "@modelcontextprotocol/server"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; import cors from "cors"; import type { Request, Response } from "express"; import { createServer } from "./server.js"; @@ -263,7 +266,7 @@ export async function startStreamableHTTPServer( app.all("/mcp", async (req: Request, res: Response) => { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); diff --git a/docs/testing-mcp-apps.md b/docs/testing-mcp-apps.md index df1396c..a8eb333 100644 --- a/docs/testing-mcp-apps.md +++ b/docs/testing-mcp-apps.md @@ -28,6 +28,10 @@ The [`basic-host`](https://github.com/modelcontextprotocol/ext-apps/tree/main/ex cd examples/basic-host ``` + The root install runs the package build, including type-checking the + documentation snippets against the pinned base MCP SDK 2.x packages. Do + not bypass a failed build before testing the host. + 2. Start basic-host, pointing it to your MCP server: ```bash diff --git a/examples/basic-host/package.json b/examples/basic-host/package.json index 828579b..cefe9d5 100644 --- a/examples/basic-host/package.json +++ b/examples/basic-host/package.json @@ -1,7 +1,7 @@ { "homepage": "https://github.com/modelcontextprotocol/ext-apps/tree/main/examples/basic-host", "name": "@modelcontextprotocol/ext-apps-basic-host", - "version": "1.2.0", + "version": "2.0.0", "type": "module", "scripts": { "build": "tsc --noEmit && concurrently \"cross-env INPUT=index.html vite build\" \"cross-env INPUT=sandbox.html vite build\"", @@ -11,11 +11,11 @@ "dev": "cross-env NODE_ENV=development concurrently \"npm run watch\" \"npm run serve\"" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", "react": "^19.2.0", "react-dom": "^19.2.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "devDependencies": { "@types/express": "^5.0.0", @@ -29,7 +29,6 @@ "prettier": "^3.6.2", "typescript": "^5.9.3", "vite": "^6.0.0", - "vite-plugin-singlefile": "^2.3.0", - "vitest": "^3.2.4" + "vite-plugin-singlefile": "^2.3.0" } } diff --git a/examples/basic-host/src/implementation.ts b/examples/basic-host/src/implementation.ts index 36ecee0..5f680ff 100644 --- a/examples/basic-host/src/implementation.ts +++ b/examples/basic-host/src/implementation.ts @@ -1,8 +1,12 @@ import { RESOURCE_MIME_TYPE, getToolUiResourceUri, type McpUiSandboxProxyReadyNotification, AppBridge, PostMessageTransport, type McpUiResourceCsp, type McpUiResourcePermissions, buildAllowAttribute, type McpUiUpdateModelContextRequest, type McpUiMessageRequest } from "@modelcontextprotocol/ext-apps/app-bridge"; -import { Client } from "@modelcontextprotocol/sdk/client/index.js"; -import { SSEClientTransport } from "@modelcontextprotocol/sdk/client/sse.js"; -import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"; -import type { CallToolResult, Resource, Tool } from "@modelcontextprotocol/sdk/types.js"; +import { + Client, + SSEClientTransport, + StreamableHTTPClientTransport, + type CallToolResult, + type Resource, + type Tool, +} from "@modelcontextprotocol/client"; import { getTheme, onThemeChange } from "./theme"; import { HOST_STYLE_VARIABLES } from "./host-styles"; @@ -306,6 +310,28 @@ export function newAppBridge( appBridge.sendHostContextChange({ theme: newTheme }); }); + // Per spec, the host SHOULD notify the view when container dimensions + // change. A ResizeObserver on the iframe covers window resize, layout + // shifts, and the inline↔fullscreen panel toggle (which React applies + // a tick after onrequestdisplaymode returns β€” sending containerDimensions + // alongside displayMode there would race the layout). Height stays + // flexible (maxHeight) so the view can keep driving it via sendSizeChanged. + const iframeResizeObserver = new ResizeObserver(([entry]) => { + const width = Math.round(entry.contentRect.width); + if (width > 0) { + appBridge.sendHostContextChange({ + containerDimensions: { width, maxHeight: 6000 }, + }); + } + }); + iframeResizeObserver.observe(iframe); + // AppBridge inherits Protocol's onclose hook β€” chain disposal there. + const prevOnclose = appBridge.onclose; + appBridge.onclose = () => { + iframeResizeObserver.disconnect(); + prevOnclose?.(); + }; + // Register all handlers before calling connect(). The view can start // sending requests immediately after the initialization handshake, so any // handlers registered after connect() might miss early requests. diff --git a/examples/basic-host/src/index.tsx b/examples/basic-host/src/index.tsx index 3d488a7..00c0d52 100644 --- a/examples/basic-host/src/index.tsx +++ b/examples/basic-host/src/index.tsx @@ -1,5 +1,5 @@ import { getToolUiResourceUri, McpUiToolMetaSchema } from "@modelcontextprotocol/ext-apps/app-bridge"; -import type { Tool } from "@modelcontextprotocol/sdk/types.js"; +import type { Tool } from "@modelcontextprotocol/client"; import { Component, type ErrorInfo, type ReactNode, StrictMode, Suspense, use, useEffect, useMemo, useRef, useState } from "react"; import { createRoot } from "react-dom/client"; import { callTool, connectToServer, hasAppHtml, initializeApp, loadSandboxProxy, log, newAppBridge, type ServerInfo, type ToolCallInfo, type ModelContext, type AppMessage } from "./implementation"; diff --git a/examples/basic-host/tsconfig.json b/examples/basic-host/tsconfig.json index 9d7c3bc..3c143ca 100644 --- a/examples/basic-host/tsconfig.json +++ b/examples/basic-host/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "vite/client"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", diff --git a/examples/basic-server-preact/main.ts b/examples/basic-server-preact/main.ts index 7642632..ffdff52 100644 --- a/examples/basic-server-preact/main.ts +++ b/examples/basic-server-preact/main.ts @@ -4,10 +4,10 @@ * Or: node dist/index.js [--stdio] */ -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; -import { createMcpExpressApp } from "@modelcontextprotocol/sdk/server/express.js"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { createMcpExpressApp } from "@modelcontextprotocol/express"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; +import type { McpServer } from "@modelcontextprotocol/server"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; import cors from "cors"; import type { Request, Response } from "express"; import { createServer } from "./server.js"; @@ -27,7 +27,7 @@ export async function startStreamableHTTPServer( app.all("/mcp", async (req: Request, res: Response) => { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); diff --git a/examples/basic-server-preact/package.json b/examples/basic-server-preact/package.json index d01e437..60aa40d 100644 --- a/examples/basic-server-preact/package.json +++ b/examples/basic-server-preact/package.json @@ -1,11 +1,11 @@ { "name": "@modelcontextprotocol/server-basic-preact", - "version": "1.2.0", + "version": "2.0.0", "type": "module", "description": "Basic MCP App Server example using Preact", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", "directory": "examples/basic-server-preact" }, "license": "MIT", @@ -24,12 +24,15 @@ "prepublishOnly": "npm run build" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", "preact": "^10.0.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "devDependencies": { "@preact/preset-vite": "^2.0.0", diff --git a/examples/basic-server-preact/server.ts b/examples/basic-server-preact/server.ts index bf14ea5..dfec94a 100644 --- a/examples/basic-server-preact/server.ts +++ b/examples/basic-server-preact/server.ts @@ -1,8 +1,12 @@ -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import type { CallToolResult, ReadResourceResult } from "@modelcontextprotocol/sdk/types.js"; +import { + McpServer, + type CallToolResult, + type ReadResourceResult, +} from "@modelcontextprotocol/server"; import fs from "node:fs/promises"; import path from "node:path"; import { registerAppTool, registerAppResource, RESOURCE_MIME_TYPE } from "@modelcontextprotocol/ext-apps/server"; +import { z } from "zod"; // Works both from source (server.ts) and compiled (dist/server.js) const DIST_DIR = import.meta.filename.endsWith(".ts") ? path.join(import.meta.dirname, "dist") @@ -28,7 +32,7 @@ export function createServer(): McpServer { { title: "Get Time", description: "Returns the current server time as an ISO 8601 string.", - inputSchema: {}, + inputSchema: z.object({}), _meta: { ui: { resourceUri } }, // Links this tool to its UI resource }, async (): Promise => { diff --git a/examples/basic-server-preact/src/mcp-app.tsx b/examples/basic-server-preact/src/mcp-app.tsx index a8bdc68..351a8ec 100644 --- a/examples/basic-server-preact/src/mcp-app.tsx +++ b/examples/basic-server-preact/src/mcp-app.tsx @@ -8,7 +8,7 @@ import { applyHostStyleVariables, type McpUiHostContext, } from "@modelcontextprotocol/ext-apps"; -import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js"; +import type { CallToolResult } from "@modelcontextprotocol/client"; import { useCallback, useEffect, useState } from "preact/hooks"; import { render } from "preact"; import styles from "./mcp-app.module.css"; diff --git a/examples/basic-server-preact/tsconfig.json b/examples/basic-server-preact/tsconfig.json index 32182d9..9bf9389 100644 --- a/examples/basic-server-preact/tsconfig.json +++ b/examples/basic-server-preact/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "vite/client"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", diff --git a/examples/basic-server-preact/tsconfig.server.json b/examples/basic-server-preact/tsconfig.server.json index 05ddd8e..27eb28f 100644 --- a/examples/basic-server-preact/tsconfig.server.json +++ b/examples/basic-server-preact/tsconfig.server.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node"], "target": "ES2022", "lib": ["ES2022"], "module": "NodeNext", diff --git a/examples/basic-server-react/main.ts b/examples/basic-server-react/main.ts index ec187b6..21c5e18 100644 --- a/examples/basic-server-react/main.ts +++ b/examples/basic-server-react/main.ts @@ -4,10 +4,10 @@ * Or: node dist/index.js [--stdio] */ -import { createMcpExpressApp } from "@modelcontextprotocol/sdk/server/express.js"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; -import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { createMcpExpressApp } from "@modelcontextprotocol/express"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; +import type { McpServer } from "@modelcontextprotocol/server"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; import cors from "cors"; import type { Request, Response } from "express"; import { createServer } from "./server.js"; @@ -27,7 +27,7 @@ export async function startStreamableHTTPServer( app.all("/mcp", async (req: Request, res: Response) => { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); diff --git a/examples/basic-server-react/package.json b/examples/basic-server-react/package.json index c828a85..ea51a8a 100644 --- a/examples/basic-server-react/package.json +++ b/examples/basic-server-react/package.json @@ -1,11 +1,11 @@ { "name": "@modelcontextprotocol/server-basic-react", - "version": "1.2.0", + "version": "2.0.0", "type": "module", "description": "Basic MCP App Server example using React", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", "directory": "examples/basic-server-react" }, "license": "MIT", @@ -34,13 +34,16 @@ "prepublishOnly": "npm run build" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", "react": "^19.2.0", "react-dom": "^19.2.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "devDependencies": { "@types/cors": "^2.8.19", diff --git a/examples/basic-server-react/server.ts b/examples/basic-server-react/server.ts index 23f6dda..d77c908 100644 --- a/examples/basic-server-react/server.ts +++ b/examples/basic-server-react/server.ts @@ -1,8 +1,12 @@ import { registerAppResource, registerAppTool, RESOURCE_MIME_TYPE } from "@modelcontextprotocol/ext-apps/server"; -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import type { CallToolResult, ReadResourceResult } from "@modelcontextprotocol/sdk/types.js"; +import { + McpServer, + type CallToolResult, + type ReadResourceResult, +} from "@modelcontextprotocol/server"; import fs from "node:fs/promises"; import path from "node:path"; +import { z } from "zod"; // Works both from source (server.ts) and compiled (dist/server.js) const DIST_DIR = import.meta.filename.endsWith(".ts") @@ -29,7 +33,7 @@ export function createServer(): McpServer { { title: "Get Time", description: "Returns the current server time as an ISO 8601 string.", - inputSchema: {}, + inputSchema: z.object({}), _meta: { ui: { resourceUri } }, // Links this tool to its UI resource }, async (): Promise => { diff --git a/examples/basic-server-react/src/mcp-app.tsx b/examples/basic-server-react/src/mcp-app.tsx index 6bb5540..2b5fbef 100644 --- a/examples/basic-server-react/src/mcp-app.tsx +++ b/examples/basic-server-react/src/mcp-app.tsx @@ -3,7 +3,7 @@ */ import type { App, McpUiHostContext } from "@modelcontextprotocol/ext-apps"; import { useApp } from "@modelcontextprotocol/ext-apps/react"; -import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js"; +import type { CallToolResult } from "@modelcontextprotocol/client"; import { StrictMode, useCallback, useEffect, useState } from "react"; import { createRoot } from "react-dom/client"; import styles from "./mcp-app.module.css"; diff --git a/examples/basic-server-react/tsconfig.json b/examples/basic-server-react/tsconfig.json index fc3c210..3ecbdad 100644 --- a/examples/basic-server-react/tsconfig.json +++ b/examples/basic-server-react/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "vite/client"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", diff --git a/examples/basic-server-react/tsconfig.server.json b/examples/basic-server-react/tsconfig.server.json index 05ddd8e..27eb28f 100644 --- a/examples/basic-server-react/tsconfig.server.json +++ b/examples/basic-server-react/tsconfig.server.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node"], "target": "ES2022", "lib": ["ES2022"], "module": "NodeNext", diff --git a/examples/basic-server-solid/main.ts b/examples/basic-server-solid/main.ts index c8d9de2..095ef8d 100644 --- a/examples/basic-server-solid/main.ts +++ b/examples/basic-server-solid/main.ts @@ -4,10 +4,10 @@ * Or: node dist/index.js [--stdio] */ -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; -import { createMcpExpressApp } from "@modelcontextprotocol/sdk/server/express.js"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; +import { createMcpExpressApp } from "@modelcontextprotocol/express"; +import type { McpServer } from "@modelcontextprotocol/server"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; import cors from "cors"; import type { Request, Response } from "express"; import { createServer } from "./server.js"; @@ -27,7 +27,7 @@ export async function startStreamableHTTPServer( app.all("/mcp", async (req: Request, res: Response) => { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); diff --git a/examples/basic-server-solid/package.json b/examples/basic-server-solid/package.json index f6e182a..b3ca909 100644 --- a/examples/basic-server-solid/package.json +++ b/examples/basic-server-solid/package.json @@ -1,11 +1,11 @@ { "name": "@modelcontextprotocol/server-basic-solid", - "version": "1.2.0", + "version": "2.0.0", "type": "module", "description": "Basic MCP App Server example using Solid", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", "directory": "examples/basic-server-solid" }, "license": "MIT", @@ -24,12 +24,15 @@ "prepublishOnly": "npm run build" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", "solid-js": "1.9.10", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "devDependencies": { "@types/cors": "^2.8.19", @@ -40,7 +43,7 @@ "typescript": "^5.9.3", "vite": "^6.0.0", "vite-plugin-singlefile": "^2.3.0", - "vite-plugin-solid": "^2.0.0" + "vite-plugin-solid": "^2.11.12" }, "types": "dist/server.d.ts", "exports": { diff --git a/examples/basic-server-solid/server.ts b/examples/basic-server-solid/server.ts index 2ed2d93..addb522 100644 --- a/examples/basic-server-solid/server.ts +++ b/examples/basic-server-solid/server.ts @@ -1,8 +1,12 @@ -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import type { CallToolResult, ReadResourceResult } from "@modelcontextprotocol/sdk/types.js"; +import { + McpServer, + type CallToolResult, + type ReadResourceResult, +} from "@modelcontextprotocol/server"; import fs from "node:fs/promises"; import path from "node:path"; import { registerAppTool, registerAppResource, RESOURCE_MIME_TYPE } from "@modelcontextprotocol/ext-apps/server"; +import { z } from "zod"; // Works both from source (server.ts) and compiled (dist/server.js) const DIST_DIR = import.meta.filename.endsWith(".ts") ? path.join(import.meta.dirname, "dist") @@ -28,7 +32,7 @@ export function createServer(): McpServer { { title: "Get Time", description: "Returns the current server time as an ISO 8601 string.", - inputSchema: {}, + inputSchema: z.object({}), _meta: { ui: { resourceUri } }, // Links this tool to its UI resource }, async (): Promise => { diff --git a/examples/basic-server-solid/src/mcp-app.tsx b/examples/basic-server-solid/src/mcp-app.tsx index 66d47f3..2d78b7b 100644 --- a/examples/basic-server-solid/src/mcp-app.tsx +++ b/examples/basic-server-solid/src/mcp-app.tsx @@ -8,7 +8,7 @@ import { applyHostStyleVariables, type McpUiHostContext, } from "@modelcontextprotocol/ext-apps"; -import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js"; +import type { CallToolResult } from "@modelcontextprotocol/client"; import { createEffect, createSignal, onMount, Show } from "solid-js"; import { render } from "solid-js/web"; import styles from "./mcp-app.module.css"; diff --git a/examples/basic-server-solid/tsconfig.json b/examples/basic-server-solid/tsconfig.json index 84f0efe..bb13a01 100644 --- a/examples/basic-server-solid/tsconfig.json +++ b/examples/basic-server-solid/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "vite/client"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", diff --git a/examples/basic-server-solid/tsconfig.server.json b/examples/basic-server-solid/tsconfig.server.json index 05ddd8e..27eb28f 100644 --- a/examples/basic-server-solid/tsconfig.server.json +++ b/examples/basic-server-solid/tsconfig.server.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node"], "target": "ES2022", "lib": ["ES2022"], "module": "NodeNext", diff --git a/examples/basic-server-svelte/main.ts b/examples/basic-server-svelte/main.ts index 6c50a25..734ec0c 100644 --- a/examples/basic-server-svelte/main.ts +++ b/examples/basic-server-svelte/main.ts @@ -4,10 +4,10 @@ * Or: node dist/index.js [--stdio] */ -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; -import { createMcpExpressApp } from "@modelcontextprotocol/sdk/server/express.js"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { createMcpExpressApp } from "@modelcontextprotocol/express"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; +import type { McpServer } from "@modelcontextprotocol/server"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; import cors from "cors"; import type { Request, Response } from "express"; import { createServer } from "./server.js"; @@ -27,7 +27,7 @@ export async function startStreamableHTTPServer( app.all("/mcp", async (req: Request, res: Response) => { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); diff --git a/examples/basic-server-svelte/package.json b/examples/basic-server-svelte/package.json index 5378658..19fe4c9 100644 --- a/examples/basic-server-svelte/package.json +++ b/examples/basic-server-svelte/package.json @@ -1,11 +1,11 @@ { "name": "@modelcontextprotocol/server-basic-svelte", - "version": "1.2.0", + "version": "2.0.0", "type": "module", "description": "Basic MCP App Server example using Svelte", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", "directory": "examples/basic-server-svelte" }, "license": "MIT", @@ -24,12 +24,15 @@ "prepublishOnly": "npm run build" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", "svelte": "^5.0.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "devDependencies": { "@sveltejs/vite-plugin-svelte": "^5.0.0", diff --git a/examples/basic-server-svelte/server.ts b/examples/basic-server-svelte/server.ts index da603ca..9414285 100644 --- a/examples/basic-server-svelte/server.ts +++ b/examples/basic-server-svelte/server.ts @@ -1,8 +1,12 @@ -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import type { CallToolResult, ReadResourceResult } from "@modelcontextprotocol/sdk/types.js"; +import { + McpServer, + type CallToolResult, + type ReadResourceResult, +} from "@modelcontextprotocol/server"; import fs from "node:fs/promises"; import path from "node:path"; import { registerAppTool, registerAppResource, RESOURCE_MIME_TYPE } from "@modelcontextprotocol/ext-apps/server"; +import { z } from "zod"; // Works both from source (server.ts) and compiled (dist/server.js) const DIST_DIR = import.meta.filename.endsWith(".ts") ? path.join(import.meta.dirname, "dist") @@ -28,7 +32,7 @@ export function createServer(): McpServer { { title: "Get Time", description: "Returns the current server time as an ISO 8601 string.", - inputSchema: {}, + inputSchema: z.object({}), _meta: { ui: { resourceUri } }, // Links this tool to its UI resource }, async (): Promise => { diff --git a/examples/basic-server-svelte/src/App.svelte b/examples/basic-server-svelte/src/App.svelte index fde128d..cabcc31 100644 --- a/examples/basic-server-svelte/src/App.svelte +++ b/examples/basic-server-svelte/src/App.svelte @@ -7,7 +7,7 @@ import { applyHostStyleVariables, type McpUiHostContext, } from "@modelcontextprotocol/ext-apps"; -import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js"; +import type { CallToolResult } from "@modelcontextprotocol/client"; function extractTime(result: CallToolResult): string { const { text } = result.content?.find((c) => c.type === "text")!; diff --git a/examples/basic-server-svelte/tsconfig.json b/examples/basic-server-svelte/tsconfig.json index 5edb66a..4fd3cd7 100644 --- a/examples/basic-server-svelte/tsconfig.json +++ b/examples/basic-server-svelte/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "vite/client"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", diff --git a/examples/basic-server-svelte/tsconfig.server.json b/examples/basic-server-svelte/tsconfig.server.json index 05ddd8e..27eb28f 100644 --- a/examples/basic-server-svelte/tsconfig.server.json +++ b/examples/basic-server-svelte/tsconfig.server.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node"], "target": "ES2022", "lib": ["ES2022"], "module": "NodeNext", diff --git a/examples/basic-server-vanillajs/main.ts b/examples/basic-server-vanillajs/main.ts index 286fa34..4de7331 100644 --- a/examples/basic-server-vanillajs/main.ts +++ b/examples/basic-server-vanillajs/main.ts @@ -4,10 +4,10 @@ * Or: node dist/index.js [--stdio] */ -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; -import { createMcpExpressApp } from "@modelcontextprotocol/sdk/server/express.js"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; +import { createMcpExpressApp } from "@modelcontextprotocol/express"; +import type { McpServer } from "@modelcontextprotocol/server"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; import cors from "cors"; import type { Request, Response } from "express"; import { createServer } from "./server.js"; @@ -27,7 +27,7 @@ export async function startStreamableHTTPServer( app.all("/mcp", async (req: Request, res: Response) => { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); diff --git a/examples/basic-server-vanillajs/package.json b/examples/basic-server-vanillajs/package.json index cdcc2ed..ebfebbb 100644 --- a/examples/basic-server-vanillajs/package.json +++ b/examples/basic-server-vanillajs/package.json @@ -1,11 +1,11 @@ { "name": "@modelcontextprotocol/server-basic-vanillajs", - "version": "1.2.0", + "version": "2.0.0", "type": "module", "description": "Basic MCP App Server example using vanilla JavaScript", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", "directory": "examples/basic-server-vanillajs" }, "license": "MIT", @@ -24,11 +24,14 @@ "prepublishOnly": "npm run build" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "devDependencies": { "@types/cors": "^2.8.19", diff --git a/examples/basic-server-vanillajs/server.ts b/examples/basic-server-vanillajs/server.ts index 5b2daf7..693d861 100644 --- a/examples/basic-server-vanillajs/server.ts +++ b/examples/basic-server-vanillajs/server.ts @@ -1,6 +1,9 @@ import { registerAppResource, registerAppTool, RESOURCE_MIME_TYPE } from "@modelcontextprotocol/ext-apps/server"; -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import type { CallToolResult, ReadResourceResult } from "@modelcontextprotocol/sdk/types.js"; +import { + McpServer, + type CallToolResult, + type ReadResourceResult, +} from "@modelcontextprotocol/server"; import fs from "node:fs/promises"; import path from "node:path"; import { z } from "zod"; @@ -29,7 +32,7 @@ export function createServer(): McpServer { { title: "Get Time", description: "Returns the current server time as an ISO 8601 string.", - inputSchema: {}, + inputSchema: z.object({}), outputSchema: z.object({ time: z.string(), }), diff --git a/examples/basic-server-vanillajs/src/mcp-app.ts b/examples/basic-server-vanillajs/src/mcp-app.ts index c3168c2..6b5084a 100644 --- a/examples/basic-server-vanillajs/src/mcp-app.ts +++ b/examples/basic-server-vanillajs/src/mcp-app.ts @@ -8,7 +8,7 @@ import { applyHostStyleVariables, type McpUiHostContext, } from "@modelcontextprotocol/ext-apps"; -import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js"; +import type { CallToolResult } from "@modelcontextprotocol/client"; import "./global.css"; import "./mcp-app.css"; diff --git a/examples/basic-server-vanillajs/tsconfig.json b/examples/basic-server-vanillajs/tsconfig.json index 535267b..b028ff5 100644 --- a/examples/basic-server-vanillajs/tsconfig.json +++ b/examples/basic-server-vanillajs/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "vite/client"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", diff --git a/examples/basic-server-vanillajs/tsconfig.server.json b/examples/basic-server-vanillajs/tsconfig.server.json index 05ddd8e..27eb28f 100644 --- a/examples/basic-server-vanillajs/tsconfig.server.json +++ b/examples/basic-server-vanillajs/tsconfig.server.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node"], "target": "ES2022", "lib": ["ES2022"], "module": "NodeNext", diff --git a/examples/basic-server-vue/main.ts b/examples/basic-server-vue/main.ts index 669a071..d774269 100644 --- a/examples/basic-server-vue/main.ts +++ b/examples/basic-server-vue/main.ts @@ -4,10 +4,10 @@ * Or: node dist/index.js [--stdio] */ -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; -import { createMcpExpressApp } from "@modelcontextprotocol/sdk/server/express.js"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { createMcpExpressApp } from "@modelcontextprotocol/express"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; +import type { McpServer } from "@modelcontextprotocol/server"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; import cors from "cors"; import type { Request, Response } from "express"; import { createServer } from "./server.js"; @@ -27,7 +27,7 @@ export async function startStreamableHTTPServer( app.all("/mcp", async (req: Request, res: Response) => { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); diff --git a/examples/basic-server-vue/package.json b/examples/basic-server-vue/package.json index 5f4ebcd..858dd89 100644 --- a/examples/basic-server-vue/package.json +++ b/examples/basic-server-vue/package.json @@ -1,11 +1,11 @@ { "name": "@modelcontextprotocol/server-basic-vue", - "version": "1.2.0", + "version": "2.0.0", "type": "module", "description": "Basic MCP App Server example using Vue", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", "directory": "examples/basic-server-vue" }, "license": "MIT", @@ -24,12 +24,15 @@ "prepublishOnly": "npm run build" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", "vue": "^3.5.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "devDependencies": { "@types/cors": "^2.8.19", diff --git a/examples/basic-server-vue/server.ts b/examples/basic-server-vue/server.ts index 5aa72de..9adb911 100644 --- a/examples/basic-server-vue/server.ts +++ b/examples/basic-server-vue/server.ts @@ -1,8 +1,12 @@ -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import type { CallToolResult, ReadResourceResult } from "@modelcontextprotocol/sdk/types.js"; +import { + McpServer, + type CallToolResult, + type ReadResourceResult, +} from "@modelcontextprotocol/server"; import fs from "node:fs/promises"; import path from "node:path"; import { registerAppTool, registerAppResource, RESOURCE_MIME_TYPE } from "@modelcontextprotocol/ext-apps/server"; +import { z } from "zod"; // Works both from source (server.ts) and compiled (dist/server.js) const DIST_DIR = import.meta.filename.endsWith(".ts") ? path.join(import.meta.dirname, "dist") @@ -28,7 +32,7 @@ export function createServer(): McpServer { { title: "Get Time", description: "Returns the current server time as an ISO 8601 string.", - inputSchema: {}, + inputSchema: z.object({}), _meta: { ui: { resourceUri } }, // Links this tool to its UI resource }, async (): Promise => { diff --git a/examples/basic-server-vue/src/App.vue b/examples/basic-server-vue/src/App.vue index 196ad64..a45c262 100644 --- a/examples/basic-server-vue/src/App.vue +++ b/examples/basic-server-vue/src/App.vue @@ -7,7 +7,7 @@ import { applyHostStyleVariables, type McpUiHostContext, } from "@modelcontextprotocol/ext-apps"; -import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js"; +import type { CallToolResult } from "@modelcontextprotocol/client"; function extractTime(result: CallToolResult): string { const { text } = result.content?.find((c) => c.type === "text")!; diff --git a/examples/basic-server-vue/tsconfig.json b/examples/basic-server-vue/tsconfig.json index 5edb66a..4fd3cd7 100644 --- a/examples/basic-server-vue/tsconfig.json +++ b/examples/basic-server-vue/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "vite/client"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", diff --git a/examples/basic-server-vue/tsconfig.server.json b/examples/basic-server-vue/tsconfig.server.json index 05ddd8e..27eb28f 100644 --- a/examples/basic-server-vue/tsconfig.server.json +++ b/examples/basic-server-vue/tsconfig.server.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node"], "target": "ES2022", "lib": ["ES2022"], "module": "NodeNext", diff --git a/examples/budget-allocator-server/main.ts b/examples/budget-allocator-server/main.ts index cc488f0..02c03cb 100644 --- a/examples/budget-allocator-server/main.ts +++ b/examples/budget-allocator-server/main.ts @@ -4,10 +4,10 @@ * Or: node dist/index.js [--stdio] */ -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; -import { createMcpExpressApp } from "@modelcontextprotocol/sdk/server/express.js"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { createMcpExpressApp } from "@modelcontextprotocol/express"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; +import type { McpServer } from "@modelcontextprotocol/server"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; import cors from "cors"; import type { Request, Response } from "express"; import { createServer } from "./server.js"; @@ -27,7 +27,7 @@ export async function startStreamableHTTPServer( app.all("/mcp", async (req: Request, res: Response) => { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); diff --git a/examples/budget-allocator-server/package.json b/examples/budget-allocator-server/package.json index 43acad8..6e41622 100644 --- a/examples/budget-allocator-server/package.json +++ b/examples/budget-allocator-server/package.json @@ -1,11 +1,11 @@ { "name": "@modelcontextprotocol/server-budget-allocator", - "version": "1.2.0", + "version": "2.0.0", "type": "module", "description": "Budget allocator MCP App Server with interactive visualization", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", "directory": "examples/budget-allocator-server" }, "license": "MIT", @@ -26,12 +26,14 @@ "serve": "bun --watch main.ts" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "chart.js": "^4.4.0", "cors": "^2.8.5", "express": "^5.1.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "devDependencies": { "@types/cors": "^2.8.19", diff --git a/examples/budget-allocator-server/server.ts b/examples/budget-allocator-server/server.ts index e522918..01f5dbf 100755 --- a/examples/budget-allocator-server/server.ts +++ b/examples/budget-allocator-server/server.ts @@ -4,11 +4,11 @@ * Provides budget configuration, 24 months of historical allocation data, * and industry benchmarks by company stage. */ -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import type { - CallToolResult, - ReadResourceResult, -} from "@modelcontextprotocol/sdk/types.js"; +import { + McpServer, + type CallToolResult, + type ReadResourceResult, +} from "@modelcontextprotocol/server"; import fs from "node:fs/promises"; import path from "node:path"; import { z } from "zod"; @@ -269,8 +269,8 @@ export function createServer(): McpServer { { title: "Get Budget Data", description: - "Returns budget configuration with 24 months of historical allocations and industry benchmarks by company stage", - inputSchema: {}, + "Returns budget configuration with 24 months of historical allocations and industry benchmarks by company stage. The widget is interactive and exposes tools for reading/modifying allocations, adjusting budgets, and comparing against industry benchmarks.", + inputSchema: z.object({}), outputSchema: BudgetDataResponseSchema, _meta: { ui: { resourceUri } }, }, diff --git a/examples/budget-allocator-server/src/mcp-app.ts b/examples/budget-allocator-server/src/mcp-app.ts index 4e8c62d..a9bae12 100644 --- a/examples/budget-allocator-server/src/mcp-app.ts +++ b/examples/budget-allocator-server/src/mcp-app.ts @@ -3,6 +3,7 @@ */ import { App, type McpUiHostContext } from "@modelcontextprotocol/ext-apps"; import { Chart, registerables } from "chart.js"; +import { z } from "zod"; import "./global.css"; import "./mcp-app.css"; @@ -626,6 +627,295 @@ function handleHostContextChanged(ctx: McpUiHostContext) { app.onhostcontextchanged = handleHostContextChanged; +// Register tools for model interaction +app.registerTool( + "get-allocations", + { + title: "Get Budget Allocations", + description: + "Get the current budget allocations including total budget, percentages, and amounts per category", + }, + async () => { + if (!state.config) { + return { + content: [ + { type: "text" as const, text: "Error: Configuration not loaded" }, + ], + isError: true, + }; + } + + const allocations: Record = {}; + for (const category of state.config.categories) { + const percent = state.allocations.get(category.id) ?? 0; + allocations[category.id] = { + percent, + amount: (percent / 100) * state.totalBudget, + }; + } + + const result = { + totalBudget: state.totalBudget, + currency: state.config.currency, + currencySymbol: state.config.currencySymbol, + selectedStage: state.selectedStage, + allocations, + categories: state.config.categories.map((c) => ({ + id: c.id, + name: c.name, + color: c.color, + })), + }; + + return { + content: [ + { type: "text" as const, text: JSON.stringify(result, null, 2) }, + ], + structuredContent: result, + }; + }, +); + +app.registerTool( + "set-allocation", + { + title: "Set Category Allocation", + description: "Set the allocation percentage for a specific budget category", + inputSchema: z.object({ + categoryId: z + .string() + .describe( + "Category ID (e.g., 'marketing', 'engineering', 'operations', 'sales', 'rd')", + ), + percent: z + .number() + .min(0) + .max(100) + .describe("Allocation percentage (0-100)"), + }), + }, + async (args) => { + if (!state.config) { + return { + content: [ + { type: "text" as const, text: "Error: Configuration not loaded" }, + ], + isError: true, + }; + } + + const category = state.config.categories.find( + (c) => c.id === args.categoryId, + ); + if (!category) { + return { + content: [ + { + type: "text" as const, + text: `Error: Category "${args.categoryId}" not found. Available: ${state.config.categories.map((c) => c.id).join(", ")}`, + }, + ], + isError: true, + }; + } + + handleSliderChange(args.categoryId, args.percent); + + // Also update the slider UI + const slider = document.querySelector( + `.slider-row[data-category-id="${args.categoryId}"] .slider`, + ) as HTMLInputElement | null; + if (slider) { + slider.value = String(args.percent); + } + + const amount = (args.percent / 100) * state.totalBudget; + return { + content: [ + { + type: "text" as const, + text: `Set ${category.name} allocation to ${args.percent.toFixed(1)}% (${state.config.currencySymbol}${amount.toLocaleString()})`, + }, + ], + }; + }, +); + +app.registerTool( + "set-total-budget", + { + title: "Set Total Budget", + description: "Set the total budget amount", + inputSchema: z.object({ + amount: z.number().positive().describe("Total budget amount"), + }), + }, + async (args) => { + if (!state.config) { + return { + content: [ + { type: "text" as const, text: "Error: Configuration not loaded" }, + ], + isError: true, + }; + } + + state.totalBudget = args.amount; + + // Update the budget selector if this amount is a preset + const budgetSelector = document.getElementById( + "budget-selector", + ) as HTMLSelectElement | null; + if (budgetSelector) { + const option = Array.from(budgetSelector.options).find( + (opt) => parseInt(opt.value) === args.amount, + ); + if (option) { + budgetSelector.value = String(args.amount); + } + } + + updateAllSliderAmounts(); + updateStatusBar(); + updateComparisonSummary(); + + return { + content: [ + { + type: "text" as const, + text: `Total budget set to ${state.config.currencySymbol}${args.amount.toLocaleString()}`, + }, + ], + }; + }, +); + +app.registerTool( + "set-company-stage", + { + title: "Set Company Stage", + description: + "Set the company stage for benchmark comparison (e.g., 'Seed', 'Series A', 'Series B', 'Growth')", + inputSchema: z.object({ + stage: z.string().describe("Company stage ID"), + }), + }, + async (args) => { + if (!state.analytics) { + return { + content: [ + { type: "text" as const, text: "Error: Analytics not loaded" }, + ], + isError: true, + }; + } + + if (!state.analytics.stages.includes(args.stage)) { + return { + content: [ + { + type: "text" as const, + text: `Error: Stage "${args.stage}" not found. Available: ${state.analytics.stages.join(", ")}`, + }, + ], + isError: true, + }; + } + + state.selectedStage = args.stage; + + // Update the stage selector UI + const stageSelector = document.getElementById( + "stage-selector", + ) as HTMLSelectElement | null; + if (stageSelector) { + stageSelector.value = args.stage; + } + + // Update all badges and summary + if (state.config) { + for (const category of state.config.categories) { + updatePercentileBadge(category.id); + } + updateComparisonSummary(); + } + + return { + content: [ + { + type: "text" as const, + text: `Company stage set to "${args.stage}"`, + }, + ], + }; + }, +); + +app.registerTool( + "get-benchmark-comparison", + { + title: "Get Benchmark Comparison", + description: + "Compare current allocations against industry benchmarks for the selected stage", + }, + async () => { + if (!state.config || !state.analytics) { + return { + content: [{ type: "text" as const, text: "Error: Data not loaded" }], + isError: true, + }; + } + + const benchmark = state.analytics.benchmarks.find( + (b) => b.stage === state.selectedStage, + ); + if (!benchmark) { + return { + content: [ + { + type: "text" as const, + text: `Error: No benchmark data for stage "${state.selectedStage}"`, + }, + ], + isError: true, + }; + } + + const comparison: Record< + string, + { current: number; p25: number; p50: number; p75: number; status: string } + > = {}; + + for (const category of state.config.categories) { + const current = state.allocations.get(category.id) ?? 0; + const benchmarkData = benchmark.categoryBenchmarks[category.id]; + let status = "within range"; + if (current < benchmarkData.p25) status = "below p25"; + else if (current > benchmarkData.p75) status = "above p75"; + + comparison[category.id] = { + current, + p25: benchmarkData.p25, + p50: benchmarkData.p50, + p75: benchmarkData.p75, + status, + }; + } + + const result = { + stage: state.selectedStage, + comparison, + }; + + return { + content: [ + { type: "text" as const, text: JSON.stringify(result, null, 2) }, + ], + structuredContent: result, + }; + }, +); + // Handle theme changes window .matchMedia("(prefers-color-scheme: dark)") diff --git a/examples/budget-allocator-server/tsconfig.json b/examples/budget-allocator-server/tsconfig.json index 535267b..b028ff5 100644 --- a/examples/budget-allocator-server/tsconfig.json +++ b/examples/budget-allocator-server/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "vite/client"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", diff --git a/examples/budget-allocator-server/tsconfig.server.json b/examples/budget-allocator-server/tsconfig.server.json index 05ddd8e..27eb28f 100644 --- a/examples/budget-allocator-server/tsconfig.server.json +++ b/examples/budget-allocator-server/tsconfig.server.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node"], "target": "ES2022", "lib": ["ES2022"], "module": "NodeNext", diff --git a/examples/cohort-heatmap-server/main.ts b/examples/cohort-heatmap-server/main.ts index d59903b..8b33603 100644 --- a/examples/cohort-heatmap-server/main.ts +++ b/examples/cohort-heatmap-server/main.ts @@ -4,10 +4,10 @@ * Or: node dist/index.js [--stdio] */ -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; -import { createMcpExpressApp } from "@modelcontextprotocol/sdk/server/express.js"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { createMcpExpressApp } from "@modelcontextprotocol/express"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; +import type { McpServer } from "@modelcontextprotocol/server"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; import cors from "cors"; import type { Request, Response } from "express"; import { createServer } from "./server.js"; @@ -27,7 +27,7 @@ export async function startStreamableHTTPServer( app.all("/mcp", async (req: Request, res: Response) => { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); diff --git a/examples/cohort-heatmap-server/package.json b/examples/cohort-heatmap-server/package.json index 6ef4122..7e2d2e2 100644 --- a/examples/cohort-heatmap-server/package.json +++ b/examples/cohort-heatmap-server/package.json @@ -1,11 +1,11 @@ { "name": "@modelcontextprotocol/server-cohort-heatmap", - "version": "1.2.0", + "version": "2.0.0", "type": "module", "description": "Cohort heatmap MCP App Server for retention analysis", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", "directory": "examples/cohort-heatmap-server" }, "license": "MIT", @@ -26,13 +26,15 @@ "serve": "bun --watch main.ts" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", "react": "^19.2.0", "react-dom": "^19.2.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "devDependencies": { "@types/cors": "^2.8.19", diff --git a/examples/cohort-heatmap-server/server.ts b/examples/cohort-heatmap-server/server.ts index 6d07144..129e2dc 100644 --- a/examples/cohort-heatmap-server/server.ts +++ b/examples/cohort-heatmap-server/server.ts @@ -1,5 +1,7 @@ -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import type { ReadResourceResult } from "@modelcontextprotocol/sdk/types.js"; +import { + McpServer, + type ReadResourceResult, +} from "@modelcontextprotocol/server"; import fs from "node:fs/promises"; import path from "node:path"; import { z } from "zod"; @@ -178,8 +180,8 @@ export function createServer(): McpServer { title: "Get Cohort Retention Data", description: "Returns cohort retention heatmap data showing customer retention over time by signup month", - inputSchema: GetCohortDataInputSchema.shape, - outputSchema: CohortDataSchema.shape, + inputSchema: GetCohortDataInputSchema, + outputSchema: CohortDataSchema, _meta: { ui: { resourceUri } }, }, async ({ metric, periodType, cohortCount, maxPeriods }) => { diff --git a/examples/cohort-heatmap-server/tsconfig.json b/examples/cohort-heatmap-server/tsconfig.json index fc3c210..3ecbdad 100644 --- a/examples/cohort-heatmap-server/tsconfig.json +++ b/examples/cohort-heatmap-server/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "vite/client"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", diff --git a/examples/cohort-heatmap-server/tsconfig.server.json b/examples/cohort-heatmap-server/tsconfig.server.json index 05ddd8e..27eb28f 100644 --- a/examples/cohort-heatmap-server/tsconfig.server.json +++ b/examples/cohort-heatmap-server/tsconfig.server.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node"], "target": "ES2022", "lib": ["ES2022"], "module": "NodeNext", diff --git a/examples/customer-segmentation-server/main.ts b/examples/customer-segmentation-server/main.ts index 130076c..c788757 100644 --- a/examples/customer-segmentation-server/main.ts +++ b/examples/customer-segmentation-server/main.ts @@ -4,10 +4,10 @@ * Or: node dist/index.js [--stdio] */ -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; -import { createMcpExpressApp } from "@modelcontextprotocol/sdk/server/express.js"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { createMcpExpressApp } from "@modelcontextprotocol/express"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; +import type { McpServer } from "@modelcontextprotocol/server"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; import cors from "cors"; import type { Request, Response } from "express"; import { createServer } from "./server.js"; @@ -27,7 +27,7 @@ export async function startStreamableHTTPServer( app.all("/mcp", async (req: Request, res: Response) => { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); diff --git a/examples/customer-segmentation-server/package.json b/examples/customer-segmentation-server/package.json index 2ff4260..bac3b89 100644 --- a/examples/customer-segmentation-server/package.json +++ b/examples/customer-segmentation-server/package.json @@ -1,11 +1,11 @@ { "name": "@modelcontextprotocol/server-customer-segmentation", - "version": "1.2.0", + "version": "2.0.0", "type": "module", "description": "Customer segmentation MCP App Server with filtering", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", "directory": "examples/customer-segmentation-server" }, "license": "MIT", @@ -26,12 +26,14 @@ "serve": "bun --watch main.ts" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "chart.js": "^4.4.0", "cors": "^2.8.5", "express": "^5.1.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "devDependencies": { "@types/cors": "^2.8.19", diff --git a/examples/customer-segmentation-server/server.ts b/examples/customer-segmentation-server/server.ts index 244415d..7cc1c1f 100644 --- a/examples/customer-segmentation-server/server.ts +++ b/examples/customer-segmentation-server/server.ts @@ -1,8 +1,8 @@ -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import type { - CallToolResult, - ReadResourceResult, -} from "@modelcontextprotocol/sdk/types.js"; +import { + McpServer, + type CallToolResult, + type ReadResourceResult, +} from "@modelcontextprotocol/server"; import fs from "node:fs/promises"; import path from "node:path"; import { z } from "zod"; @@ -100,8 +100,8 @@ export function createServer(): McpServer { title: "Get Customer Data", description: "Returns customer data with segment information for visualization. Optionally filter by segment.", - inputSchema: GetCustomerDataInputSchema.shape, - outputSchema: GetCustomerDataOutputSchema.shape, + inputSchema: GetCustomerDataInputSchema, + outputSchema: GetCustomerDataOutputSchema, _meta: { ui: { resourceUri } }, }, async ({ segment }): Promise => { diff --git a/examples/customer-segmentation-server/tsconfig.json b/examples/customer-segmentation-server/tsconfig.json index 535267b..b028ff5 100644 --- a/examples/customer-segmentation-server/tsconfig.json +++ b/examples/customer-segmentation-server/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "vite/client"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", diff --git a/examples/customer-segmentation-server/tsconfig.server.json b/examples/customer-segmentation-server/tsconfig.server.json index 05ddd8e..27eb28f 100644 --- a/examples/customer-segmentation-server/tsconfig.server.json +++ b/examples/customer-segmentation-server/tsconfig.server.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node"], "target": "ES2022", "lib": ["ES2022"], "module": "NodeNext", diff --git a/examples/debug-server/main.ts b/examples/debug-server/main.ts index 3c89a97..9fb0825 100644 --- a/examples/debug-server/main.ts +++ b/examples/debug-server/main.ts @@ -4,10 +4,10 @@ * Or: node dist/index.js [--stdio] */ -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; -import { createMcpExpressApp } from "@modelcontextprotocol/sdk/server/express.js"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { createMcpExpressApp } from "@modelcontextprotocol/express"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; +import type { McpServer } from "@modelcontextprotocol/server"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; import cors from "cors"; import type { Request, Response } from "express"; import { createServer } from "./server.js"; @@ -27,7 +27,7 @@ export async function startStreamableHTTPServer( app.all("/mcp", async (req: Request, res: Response) => { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); diff --git a/examples/debug-server/package.json b/examples/debug-server/package.json index f3041e6..e28f4d3 100644 --- a/examples/debug-server/package.json +++ b/examples/debug-server/package.json @@ -1,11 +1,11 @@ { "name": "@modelcontextprotocol/server-debug", - "version": "1.2.0", + "version": "2.0.0", "type": "module", "description": "Debug MCP App Server for testing all SDK capabilities", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", "directory": "examples/debug-server" }, "license": "MIT", @@ -34,9 +34,11 @@ "prepublishOnly": "npm run build" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", - "zod": "^4.1.13" + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", + "zod": "^4.2.0" }, "devDependencies": { "@types/cors": "^2.8.19", diff --git a/examples/debug-server/server.ts b/examples/debug-server/server.ts index fd3452a..068f94d 100644 --- a/examples/debug-server/server.ts +++ b/examples/debug-server/server.ts @@ -3,11 +3,11 @@ import { registerAppTool, RESOURCE_MIME_TYPE, } from "@modelcontextprotocol/ext-apps/server"; -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import type { - CallToolResult, - ReadResourceResult, -} from "@modelcontextprotocol/sdk/types.js"; +import { + McpServer, + type CallToolResult, + type ReadResourceResult, +} from "@modelcontextprotocol/server"; import fs from "node:fs/promises"; import { appendFileSync } from "node:fs"; import path from "node:path"; diff --git a/examples/debug-server/tsconfig.json b/examples/debug-server/tsconfig.json index 535267b..b028ff5 100644 --- a/examples/debug-server/tsconfig.json +++ b/examples/debug-server/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "vite/client"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", diff --git a/examples/debug-server/tsconfig.server.json b/examples/debug-server/tsconfig.server.json index 05ddd8e..27eb28f 100644 --- a/examples/debug-server/tsconfig.server.json +++ b/examples/debug-server/tsconfig.server.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node"], "target": "ES2022", "lib": ["ES2022"], "module": "NodeNext", diff --git a/examples/integration-server/main.ts b/examples/integration-server/main.ts index c45787e..9a42842 100644 --- a/examples/integration-server/main.ts +++ b/examples/integration-server/main.ts @@ -4,10 +4,10 @@ * Or: node dist/index.js [--stdio] */ -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; -import { createMcpExpressApp } from "@modelcontextprotocol/sdk/server/express.js"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { createMcpExpressApp } from "@modelcontextprotocol/express"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; +import type { McpServer } from "@modelcontextprotocol/server"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; import cors from "cors"; import type { Request, Response } from "express"; import { createServer } from "./server.js"; @@ -27,7 +27,7 @@ export async function startStreamableHTTPServer( app.all("/mcp", async (req: Request, res: Response) => { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); diff --git a/examples/integration-server/package.json b/examples/integration-server/package.json index 2320948..7e04f4a 100644 --- a/examples/integration-server/package.json +++ b/examples/integration-server/package.json @@ -1,6 +1,6 @@ { "name": "integration-server", - "version": "1.2.0", + "version": "2.0.0", "private": true, "type": "module", "scripts": { @@ -15,13 +15,16 @@ "serve": "bun --watch main.ts" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", "react": "^19.2.0", "react-dom": "^19.2.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "devDependencies": { "@types/cors": "^2.8.19", diff --git a/examples/integration-server/server.ts b/examples/integration-server/server.ts index e44689d..346f4f7 100644 --- a/examples/integration-server/server.ts +++ b/examples/integration-server/server.ts @@ -3,11 +3,11 @@ import { registerAppTool, RESOURCE_MIME_TYPE, } from "@modelcontextprotocol/ext-apps/server"; -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import type { - CallToolResult, - ReadResourceResult, -} from "@modelcontextprotocol/sdk/types.js"; +import { + McpServer, + type CallToolResult, + type ReadResourceResult, +} from "@modelcontextprotocol/server"; import fs from "node:fs/promises"; import path from "node:path"; import { z } from "zod"; @@ -33,7 +33,7 @@ export function createServer(): McpServer { { title: "Get Time", description: "Returns the current server time.", - inputSchema: {}, + inputSchema: z.object({}), outputSchema: z.object({ time: z.string(), }), @@ -72,7 +72,7 @@ export function createServer(): McpServer { ); // Sample downloadable resource β€” used to demo ResourceLink in ui/download-file - server.resource( + server.registerResource( SAMPLE_DOWNLOAD_URI, SAMPLE_DOWNLOAD_URI, { diff --git a/examples/integration-server/src/mcp-app.tsx b/examples/integration-server/src/mcp-app.tsx index 7f0b18c..281a356 100644 --- a/examples/integration-server/src/mcp-app.tsx +++ b/examples/integration-server/src/mcp-app.tsx @@ -3,7 +3,7 @@ */ import type { App, McpUiHostContext } from "@modelcontextprotocol/ext-apps"; import { useApp } from "@modelcontextprotocol/ext-apps/react"; -import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js"; +import type { CallToolResult } from "@modelcontextprotocol/client"; import { StrictMode, useCallback, useEffect, useState } from "react"; import { createRoot } from "react-dom/client"; import styles from "./mcp-app.module.css"; diff --git a/examples/integration-server/tsconfig.json b/examples/integration-server/tsconfig.json index fc3c210..3ecbdad 100644 --- a/examples/integration-server/tsconfig.json +++ b/examples/integration-server/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "vite/client"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", diff --git a/examples/integration-server/tsconfig.server.json b/examples/integration-server/tsconfig.server.json index 05ddd8e..27eb28f 100644 --- a/examples/integration-server/tsconfig.server.json +++ b/examples/integration-server/tsconfig.server.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node"], "target": "ES2022", "lib": ["ES2022"], "module": "NodeNext", diff --git a/examples/lazy-auth-server/README.md b/examples/lazy-auth-server/README.md new file mode 100644 index 0000000..f2e7545 --- /dev/null +++ b/examples/lazy-auth-server/README.md @@ -0,0 +1,105 @@ +# Example: Lazy Auth Server + +An MCP App example demonstrating **lazy (on-demand) auth**: the server connects and lists tools without any authentication, and only asks for OAuth when a _protected_ tool is actually called β€” by answering `401` with a `WWW-Authenticate` header. A public MCP App renders an "Auth me" button; clicking it calls a protected tool via [`callServerTool`](https://apps.extensions.modelcontextprotocol.io/api/classes/app.App.html#callservertool). The host sees the 401, runs the OAuth flow, retries, and the result renders inline. + +The embedded OAuth authorization server is a deliberately minimal mock (HS256 JWTs, stateless auth codes, auto-approve consent page) so the whole flow runs from a single process with no external dependencies. It is **not** a production authorization server. + +## Tools + +| Tool | Auth | Description | +| ------------------- | ------------- | ----------------------------------------------------------------------------------------------------- | +| `show_auth_button` | public | Renders buttons: "Auth me" (calls `get_secret`), "Revoke token" (calls `revoke_auth_token`) | +| `get_secret` | **protected** | Returns secret data (requires Bearer token) | +| `revoke_auth_token` | **protected** | Revokes the caller's **entire auth session** (access + refresh token) β†’ forces full re-auth | +| `elicit_url` | public | URL elicitation via `elicitInput` (blocks until the elicitation completes) | +| `elicit_by_error` | public | URL elicitation via the `-32042` (`UrlElicitationRequired`) error; succeeds on retry after completion | + +## Getting Started + +```bash +npm install +npm start +# β†’ MCP endpoint at http://localhost:3097/mcp +``` + +To test with a remote MCP host, expose the server through a public tunnel (see [Testing MCP Apps](../../docs/testing-mcp-apps.md)) and set `PUBLIC_URL` to the tunnel URL so OAuth metadata and callback URLs use it: + +```bash +PUBLIC_URL=https:// npm start +``` + +This example is HTTP-only (no stdio mode): the lazy-auth flow relies on HTTP status codes and OAuth endpoints. + +## Environment Variables + +| Var | Required | Description | +| --------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `JWT_SECRET` | recommended | 32+ byte secret for HS256 signing (`openssl rand -hex 32`). A dev-only default is used if unset. | +| `PORT` | no | Local port (default 3097) | +| `PUBLIC_URL` | non-local | Public base URL of the server (e.g. your tunnel URL). Required for non-localhost deployments; client-supplied `Host` headers are only trusted for loopback hosts | +| `ACCESS_TOKEN_TTL_SECONDS` | no | Default access-token lifetime (default **30**, short on purpose so you can watch the host's refresh flow kick in) | +| `REFRESH_TOKEN_TTL_SECONDS` | no | Default refresh-token lifetime (default **300**). Between the access and refresh TTLs, calls succeed via silent refresh; past it, a full re-auth is required | +| `REACTIVE_AUTH_ONLY` | no | Set `1` to remove auth metadata from the root `/.well-known/oauth-*` paths so hosts can't discover auth preemptively β€” discovery then only happens via the 401 | + +### Per-connection token lifetimes + +The short defaults are great for watching the refresh flow, but slow or automated clients may want tokens that survive a whole session. Any client can request a different access-token lifetime by connecting to a TTL-scoped MCP endpoint path (capped at 24 hours): + +``` +https:///ttl/3600/mcp ← tokens for this connection live 1 hour +``` + +This works through [RFC 8707 resource indicators](https://www.rfc-editor.org/rfc/rfc8707): MCP hosts send the MCP server URL as the `resource` parameter in OAuth authorization and token requests, and this server issues tokens for that grant with the lifetime encoded in the path (refresh tokens are extended to at least match). The TTL is a _path_ segment rather than a query param because hosts canonicalize resource indicators and strip query strings. Each TTL endpoint also enforces its value as a maximum token age, so connecting to a path with a _lower_ TTL than a token's issued lifetime forces the refresh flow. To exercise the full **re-auth** flow, call the `revoke_auth_token` tool. + +## Mounting under a base path + +`createApp()` can also be mounted inside another Express app, so an existing server can host this example at a sub-path of its own origin: + +```ts +import { createApp } from "@modelcontextprotocol/server-lazy-auth"; + +hostApp.use("/lazy-auth", createApp()); +// β†’ MCP endpoint at https:///lazy-auth/mcp +``` + +All advertised URLs (OAuth metadata, `WWW-Authenticate` `resource_metadata`, PRM `resource`, elicitation callbacks) include the mount path automatically, derived from Express's `req.baseUrl`. When `PUBLIC_URL` is set, it must include the mount path (e.g. `https://example.com/lazy-auth`). + +One thing the mounted app cannot do for itself: [RFC 8414](https://www.rfc-editor.org/rfc/rfc8414#section-3) / [RFC 9728](https://www.rfc-editor.org/rfc/rfc9728) put well-known discovery documents at the _root_ of the origin with the path inserted after the well-known prefix (`/.well-known/oauth-authorization-server/lazy-auth`), and MCP SDK clients only try that insertion form. The host app must rewrite those root paths into the mount before its other routes: + +```ts +hostApp.use((req, _res, next) => { + const m = req.url.match( + /^\/\.well-known\/(oauth-authorization-server|oauth-protected-resource)\/lazy-auth(\/.*)?$/, + ); + if (m) req.url = `/lazy-auth/.well-known/${m[1]}${m[2] ?? ""}`; + next(); +}); +``` + +Rewriting into the mount (rather than calling the sub-app directly) keeps `req.baseUrl` β€” and therefore every advertised URL β€” consistent. + +## How It Works + +1. **Connect without auth** β€” `initialize`, `tools/list`, and public tool calls succeed with no `Authorization` header. +2. **Protected tool β†’ 401** β€” when `get_secret` or `revoke_auth_token` is called without a (valid) Bearer token, the server responds `401` with `WWW-Authenticate: Bearer resource_metadata="…/auth/prm"`. +3. **Discovery** β€” the host follows `resource_metadata` to the protected-resource metadata (RFC 9728), which points at the authorization server metadata (RFC 8414). +4. **OAuth flow** β€” the host runs the authorization-code + PKCE flow against the mock `/authorize` and `/token` endpoints (a small consent page keeps the popup visible). +5. **Retry** β€” the host retries the tool call with the Bearer token and the secret renders inline in the app. +6. **Refresh + revocation** β€” access tokens expire after 30 seconds and refresh tokens after 5 minutes by default, so all three states are easy to observe: direct success (<30s), silent refresh (30s–5min), and full re-auth (>5min). Connections can request different lifetimes via the `/ttl//mcp` endpoint path (see [Per-connection token lifetimes](#per-connection-token-lifetimes)), and `revoke_auth_token` invalidates the whole session immediately. + +The two `elicit_*` tools demonstrate the complementary pattern of [URL elicitation](https://modelcontextprotocol.io/specification/draft/client/elicitation), where the server asks the user to open a URL (e.g. to complete sign-in) either by blocking inside the tool call (`elicit_url`) or by failing with the `-32042` error and succeeding on retry (`elicit_by_error`). + +## Architecture + +- **Stateless auth codes** β€” grant details are encoded _inside_ the authorization code as a 5-minute JWT, so nothing needs to be stored between requests. +- **Short-lived tokens** β€” access tokens default to a **30 second** TTL and refresh tokens to **5 minutes**: first `get_secret` succeeds β†’ wait >30s β†’ next call 401s β†’ host refreshes β†’ retry succeeds β†’ wait >5min β†’ full re-auth. Per-connection overrides via the `/ttl//mcp` endpoint path. +- **HS256** β€” a single shared secret; no key-pair persistence. +- **Per-request MCP server** β€” each `/mcp` request gets a fresh `McpServer` + `StreamableHTTPServerTransport` (stateless, no session IDs). +- **Session revocation** β€” all tokens from one OAuth session share a `sid` claim; `revoke_auth_token` adds the sid to an in-memory revocation list checked by both token verification and the refresh grant. + +## Key Files + +- [`server.ts`](server.ts) - OAuth endpoints, discovery metadata, and the MCP server with public + protected tools +- [`main.ts`](main.ts) - HTTP entry point +- [`mcp-app.html`](mcp-app.html) / [`src/mcp-app.ts`](src/mcp-app.ts) - Public app with the "Auth me" button +- [`secret-app.html`](secret-app.html) / [`src/secret-app.ts`](src/secret-app.ts) - Protected app rendered for `get_secret` diff --git a/examples/lazy-auth-server/main.ts b/examples/lazy-auth-server/main.ts new file mode 100644 index 0000000..a96f34c --- /dev/null +++ b/examples/lazy-auth-server/main.ts @@ -0,0 +1,42 @@ +/** + * Entry point for running the Lazy Auth demo MCP server. + * Run with: npx mcp-server-lazy-auth + * Or: node dist/index.js + * + * This example is HTTP-only (no stdio mode): the lazy-auth flow it demonstrates + * relies on HTTP status codes (401 + WWW-Authenticate) and OAuth endpoints. + * + * To test with a remote MCP host, expose the server through a public tunnel + * and set PUBLIC_URL to the tunnel URL so OAuth metadata and callback URLs + * use it (see docs/testing-mcp-apps.md in the repository root). + */ +import { createApp, PORT } from "./server.js"; + +async function main() { + const app = createApp(); + + const httpServer = app.listen(PORT, (err) => { + if (err) { + console.error("Failed to start server:", err); + process.exit(1); + } + console.log( + `Lazy Auth demo MCP server listening on http://localhost:${PORT}/mcp`, + ); + console.log( + ` Tools: show_auth_button, get_secret [PROTECTED], revoke_auth_token [PROTECTED], elicit_url, elicit_by_error`, + ); + }); + + const shutdown = () => { + console.log("\nShutting down..."); + httpServer.close(() => process.exit(0)); + }; + process.on("SIGINT", shutdown); + process.on("SIGTERM", shutdown); +} + +main().catch((e) => { + console.error(e); + process.exit(1); +}); diff --git a/examples/lazy-auth-server/mcp-app.html b/examples/lazy-auth-server/mcp-app.html new file mode 100644 index 0000000..7040f15 --- /dev/null +++ b/examples/lazy-auth-server/mcp-app.html @@ -0,0 +1,27 @@ + + + + + + + Lazy Auth Demo + + +
+

Public App

+

+ No auth was needed to render this view. Click below to invoke the + protected + get_secret tool β€” the host will run the OAuth flow on 401 + and retry. +

+
+ + + +
+
+
+ + + diff --git a/examples/lazy-auth-server/package.json b/examples/lazy-auth-server/package.json new file mode 100644 index 0000000..dbd4601 --- /dev/null +++ b/examples/lazy-auth-server/package.json @@ -0,0 +1,53 @@ +{ + "name": "@modelcontextprotocol/server-lazy-auth", + "version": "2.0.0", + "type": "module", + "description": "MCP App example demonstrating lazy (on-demand) OAuth: public tools work unauthenticated, protected tools return 401 + WWW-Authenticate so the host runs the OAuth flow only when needed", + "repository": { + "type": "git", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", + "directory": "examples/lazy-auth-server" + }, + "license": "MIT", + "main": "dist/server.js", + "files": [ + "dist" + ], + "scripts": { + "build": "tsc --noEmit && cross-env INPUT=mcp-app.html vite build && cross-env INPUT=secret-app.html vite build && tsc -p tsconfig.server.json && bun build server.ts --outdir dist --target node && bun build main.ts --outfile dist/index.js --target node --external \"./server.js\" --banner \"#!/usr/bin/env node\"", + "watch": "concurrently \"cross-env INPUT=mcp-app.html vite build --watch\" \"cross-env INPUT=secret-app.html vite build --watch\"", + "serve": "bun --watch main.ts", + "start": "cross-env NODE_ENV=development npm run build && npm run serve", + "dev": "cross-env NODE_ENV=development concurrently \"npm run watch\" \"npm run serve\"", + "prepublishOnly": "npm run build" + }, + "dependencies": { + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", + "cors": "^2.8.5", + "express": "^5.1.0", + "jose": "^6.0.0", + "zod": "^4.2.0" + }, + "devDependencies": { + "@types/cors": "^2.8.19", + "@types/express": "^5.0.0", + "@types/node": "22.10.0", + "concurrently": "^9.2.1", + "cross-env": "^10.1.0", + "typescript": "^5.9.3", + "vite": "^6.0.0", + "vite-plugin-singlefile": "^2.3.0" + }, + "types": "dist/server.d.ts", + "exports": { + ".": { + "types": "./dist/server.d.ts", + "default": "./dist/server.js" + } + }, + "bin": { + "mcp-server-lazy-auth": "dist/index.js" + } +} diff --git a/examples/lazy-auth-server/secret-app.html b/examples/lazy-auth-server/secret-app.html new file mode 100644 index 0000000..b2ab00b --- /dev/null +++ b/examples/lazy-auth-server/secret-app.html @@ -0,0 +1,16 @@ + + + + + + + Lazy Auth Demo β€” Secret + + +
+

Protected App

+
Waiting for secret data…
+
+ + + diff --git a/examples/lazy-auth-server/server.ts b/examples/lazy-auth-server/server.ts new file mode 100644 index 0000000..5240008 --- /dev/null +++ b/examples/lazy-auth-server/server.ts @@ -0,0 +1,1134 @@ +/** + * Lazy Auth demo MCP server. + * + * Demonstrates "lazy" (on-demand) OAuth for MCP servers and Apps: + * + * - The server connects without authentication: `initialize`, `tools/list`, + * and public tool calls all succeed with no Bearer token. + * - Protected tools (`get_secret`, `revoke_auth_token`) return 401 with a + * `WWW-Authenticate` header pointing at protected-resource metadata, so the + * host only runs the OAuth flow when a protected tool is actually called. + * - The `show_auth_button` MCP App is public; clicking its button calls the + * protected `get_secret` tool via `callServerTool`. The host sees the 401, + * runs OAuth, retries, and the result renders inline. + * + * The embedded OAuth authorization server is intentionally minimal and + * stateless (HS256 JWTs, auth codes encoded as short-lived JWTs) so the demo + * can run anywhere with a single env var. It is NOT a production AS. + */ +import { + registerAppResource, + registerAppTool, + RESOURCE_MIME_TYPE, +} from "@modelcontextprotocol/ext-apps/server"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; +import { + McpServer, + UrlElicitationRequiredError, + type CallToolResult, + type ReadResourceResult, +} from "@modelcontextprotocol/server"; +import cors from "cors"; +import express, { type Express, type Request, type Response } from "express"; +import { SignJWT, jwtVerify } from "jose"; +import crypto from "node:crypto"; +import fs from "node:fs/promises"; +import path from "node:path"; +import { fileURLToPath } from "node:url"; +import { z } from "zod"; + +// Works both from source (server.ts) and compiled (dist/server.js). Derived +// from import.meta.url rather than import.meta.filename/dirname, which are +// undefined in some module-VM contexts (e.g. importing this package from +// jest). +const SERVER_FILE = fileURLToPath(import.meta.url); +const DIST_DIR = SERVER_FILE.endsWith(".ts") + ? path.join(path.dirname(SERVER_FILE), "dist") + : path.dirname(SERVER_FILE); + +// ─── Config ────────────────────────────────────────────────────────────────── + +export const PORT = parseInt(process.env.PORT ?? "3097", 10); +const JWT_SECRET = new TextEncoder().encode( + process.env.JWT_SECRET ?? + "dev-insecure-secret-do-not-use-in-production-" + "x".repeat(20), +); +const PROTECTED_TOOLS = new Set(["get_secret", "revoke_auth_token"]); +// Token lifetimes. Defaults are deliberately short so the host's refresh flow +// (30s–5min after auth) and full re-auth (>5min) are easy to observe in a demo. +// Slow or automated clients can request longer-lived tokens per connection by +// connecting to a TTL-scoped endpoint path (/ttl//mcp) β€” see +// ttlFromResource() and the README. +const ACCESS_TOKEN_TTL_SECONDS = parseInt( + process.env.ACCESS_TOKEN_TTL_SECONDS ?? "30", + 10, +); +const REFRESH_TOKEN_TTL_SECONDS = parseInt( + process.env.REFRESH_TOKEN_TTL_SECONDS ?? "300", + 10, +); +// Cap on per-connection `?token_ttl_s=` requests. +const MAX_TOKEN_TTL_SECONDS = 86400; +// When true: root well-known PRM returns *stub* metadata WITHOUT authorization_servers, +// and root well-known AS is 404. Hosts probing well-known on connect see "resource has +// PRM but no auth configured" β†’ connect without OAuth. Real PRM (with authorization_servers) +// is only at /auth/prm, reachable via WWW-Authenticate on 401. Default false = standard. +const REACTIVE_AUTH_ONLY = process.env.REACTIVE_AUTH_ONLY === "1"; + +/** Hostname is localhost / a loopback address (URL-style, so IPv6 keeps its brackets). */ +function isLoopbackHostname(hostname: string): boolean { + return ( + ["localhost", "127.0.0.1", "[::1]"].includes(hostname) || + hostname.endsWith(".localhost") + ); +} + +/** + * Resolve the public base URL for this deployment. + * + * Precedence: the PUBLIC_URL env var, then the request's Host header (loopback + * hosts only), then http://localhost:PORT. Host / X-Forwarded-* headers naming + * non-loopback hosts are deliberately NOT trusted β€” a client could spoof them + * to make OAuth metadata and callback URLs point at a host it controls. + * Non-localhost deployments (e.g. behind a public tunnel) must set PUBLIC_URL + * explicitly. + */ +function resolvePublicUrl(req?: Request): URL { + // Mount path when this app is mounted inside another Express app + // (e.g. app.use("/lazy-auth", createApp())). Empty when standalone. + // PUBLIC_URL, when set, must already include any mount path. + const basePath = req?.baseUrl ?? ""; + const envUrl = process.env.PUBLIC_URL; + if (envUrl) return new URL(envUrl.endsWith("/") ? envUrl : envUrl + "/"); + const host = req?.headers.host; + if (host) { + try { + const url = new URL(`http://${host}${basePath}/`); + if (isLoopbackHostname(url.hostname)) return url; + } catch { + // Malformed Host header β†’ fall through to the localhost default. + } + } + return new URL(`http://localhost:${PORT}${basePath}/`); +} + +/** Public base URL as a string with no trailing slash (may include a base path). */ +function publicBaseHref(req?: Request): string { + const href = resolvePublicUrl(req).href; + return href.endsWith("/") ? href.slice(0, -1) : href; +} + +/** OAuth issuer. In REACTIVE_AUTH_ONLY mode, uses a /auth subpath so root well-known 404s. + * Otherwise uses the public base URL (origin + any mount path). */ +const ISSUER_SUFFIX = REACTIVE_AUTH_ONLY ? "/auth" : ""; +function resolveIssuer(req?: Request): string { + return publicBaseHref(req) + ISSUER_SUFFIX; +} + +// ─── Mock OAuth (HS256, stateless codes) ───────────────────────────────────── + +interface CodePayload { + client_id: string; + redirect_uri: string; + code_challenge?: string; + code_challenge_method?: string; + scope?: string; + /** Requested access-token TTL, from `?token_ttl_s=` on the resource indicator. */ + token_ttl_s?: number; +} + +/** Validate + cap a raw TTL value (from a path segment or query param). */ +function parseTtlSeconds(raw: string | undefined): number | undefined { + const ttl = parseInt(raw ?? "", 10); + return Number.isFinite(ttl) && ttl > 0 + ? Math.min(ttl, MAX_TOKEN_TTL_SECONDS) + : undefined; +} + +/** + * Extract the requested access-token TTL from a resource indicator (RFC 8707). + * + * MCP hosts send `resource=` β€” the URL the client connected + * to β€” in authorization and token requests. Clients opt into a non-default + * token lifetime by connecting to a TTL-scoped MCP endpoint path: + * + * /ttl//mcp (e.g. /ttl/3600/mcp for 1-hour tokens) + * + * The TTL lives in the PATH because hosts canonicalize resource indicators and + * strip query strings (verified against real hosts), so `?token_ttl_s=` query + * params would never reach this server's OAuth endpoints. The query param is + * still honored as a fallback for clients that preserve it. + */ +function ttlFromResource(resource: string | undefined): number | undefined { + if (!resource) return undefined; + try { + const url = new URL(resource); + const pathMatch = url.pathname.match(/\/ttl\/(\d+)\/mcp$/); + return ( + parseTtlSeconds(pathMatch?.[1]) ?? + parseTtlSeconds(url.searchParams.get("token_ttl_s") ?? undefined) + ); + } catch { + return undefined; + } +} + +interface AuthInfo { + token: string; + sub: string; + sid: string; +} + +// ─── Session revocation ─────────────────────────────────────────────────────── +// +// Each OAuth session (authorize β†’ code β†’ tokens) gets a single `sid`; all access & +// refresh tokens in that session carry it. Revoking the sid invalidates both β†’ host +// must do a full re-OAuth (refresh grant also fails). +// +// Storage is an in-memory Map, which is fine for a single-process demo server. If +// you deploy this to a multi-instance/serverless environment, back it with a +// shared store instead. + +const revokedSids = new Map(); // sid β†’ unix GC time +// Revoked-sid entries need only outlive the longest token TTL; add small clock-skew grace. +const REVOCATION_GC_TTL_SECONDS = + Math.max( + ACCESS_TOKEN_TTL_SECONDS, + REFRESH_TOKEN_TTL_SECONDS, + MAX_TOKEN_TTL_SECONDS, + ) + 10; + +function revokeSession(sid: string): void { + revokedSids.set( + sid, + Math.floor(Date.now() / 1000) + REVOCATION_GC_TTL_SECONDS, + ); + const now = Math.floor(Date.now() / 1000); + for (const [k, gc] of revokedSids) if (gc < now) revokedSids.delete(k); +} + +function isSessionRevoked(sid: string | undefined): boolean { + if (!sid) return false; + return revokedSids.has(sid); +} + +async function signAccessToken( + sub: string, + scope: string, + sid: string, + issuer: string, + audience: string, + ttlSeconds: number = ACCESS_TOKEN_TTL_SECONDS, +): Promise { + return new SignJWT({ sub, scope, sid }) + .setProtectedHeader({ alg: "HS256" }) + .setIssuedAt() + .setIssuer(issuer) + .setAudience(audience) + .setExpirationTime(`${ttlSeconds}s`) + .sign(JWT_SECRET); +} + +async function signRefreshToken( + sub: string, + scope: string, + sid: string, + issuer: string, + ttlSeconds: number = REFRESH_TOKEN_TTL_SECONDS, + accessTtlSeconds?: number, +): Promise { + // access_ttl_s carries the grant's requested access-token TTL forward so + // refreshed access tokens keep the same lifetime as the original. + return new SignJWT({ + sub, + scope, + sid, + typ: "refresh", + ...(accessTtlSeconds !== undefined + ? { access_ttl_s: accessTtlSeconds } + : {}), + }) + .setProtectedHeader({ alg: "HS256" }) + .setIssuedAt() + .setIssuer(issuer) + .setExpirationTime(`${ttlSeconds}s`) + .sign(JWT_SECRET); +} + +async function verifyRefreshToken( + token: string, + issuer: string, +): Promise< + | { sub: string; scope: string; sid: string; accessTtlSeconds?: number } + | undefined +> { + try { + const { payload } = await jwtVerify(token, JWT_SECRET, { issuer }); + if (payload.typ !== "refresh") return undefined; + const sid = payload.sid as string | undefined; + if (isSessionRevoked(sid)) return undefined; // session revoked β†’ refresh fails + return { + sub: payload.sub ?? "", + scope: (payload.scope as string) ?? "", + sid: sid ?? "", + accessTtlSeconds: + typeof payload.access_ttl_s === "number" + ? payload.access_ttl_s + : undefined, + }; + } catch { + return undefined; + } +} + +/** Encode grant details inside the code itself (5min expiry) β€” no server storage. */ +async function signAuthCode( + payload: CodePayload, + issuer: string, +): Promise { + return new SignJWT({ ...payload, typ: "code" }) + .setProtectedHeader({ alg: "HS256" }) + .setIssuedAt() + .setJti(crypto.randomUUID()) + .setIssuer(issuer) + .setExpirationTime("5m") + .sign(JWT_SECRET); +} + +// Authorization codes are single-use (RFC 6749 Β§4.1.2): remember redeemed code +// IDs until the code's own 5-minute expiry makes replay impossible anyway. +const redeemedCodeJtis = new Map(); // jti β†’ unix GC time + +async function verifyAuthCode( + code: string, + issuer: string, +): Promise { + try { + const { payload } = await jwtVerify(code, JWT_SECRET, { issuer }); + if (payload.typ !== "code" || !payload.jti) return undefined; + const now = Math.floor(Date.now() / 1000); + for (const [k, gc] of redeemedCodeJtis) + if (gc < now) redeemedCodeJtis.delete(k); + if (redeemedCodeJtis.has(payload.jti)) return undefined; // already redeemed + redeemedCodeJtis.set(payload.jti, now + 5 * 60 + 10); + return payload as unknown as CodePayload; + } catch { + return undefined; + } +} + +async function verifyAccessToken( + token: string, + issuer: string, + maxAgeSeconds?: number, +): Promise { + try { + const { payload } = await jwtVerify(token, JWT_SECRET, { issuer }); + if (payload.typ === "code" || payload.typ === "refresh") return undefined; // only plain access tokens + const sid = payload.sid as string | undefined; + if (isSessionRevoked(sid)) return undefined; // session revoked + // Per-connection TTL override (?token_ttl_s= on the MCP URL): treat tokens + // older than maxAgeSeconds as expired even though their exp claim is still + // in the future. Lets one deployment serve both long-TTL (default) and + // short-TTL (refresh-flow testing) connections. + if (maxAgeSeconds !== undefined && typeof payload.iat === "number") { + const ageSeconds = Math.floor(Date.now() / 1000) - payload.iat; + if (ageSeconds > maxAgeSeconds) return undefined; + } + return { token, sub: payload.sub ?? "", sid: sid ?? "" }; + } catch { + return undefined; + } +} + +function escapeHtml(s: string) { + return s.replace( + /[&<>"']/g, + (c) => + ({ "&": "&", "<": "<", ">": ">", '"': """, "'": "'" })[ + c + ]!, + ); +} + +/** + * This demo AS has no client registry, so it can't check redirect URIs against + * pre-registered values. At minimum, only allow https targets (or http on + * loopback for local development hosts) so the consent page never links to, + * or redirects the authorization code to, an unexpected scheme. + */ +function isAllowedRedirectUri(redirectUri: string): boolean { + try { + const url = new URL(redirectUri); + if (url.protocol === "https:") return true; + return url.protocol === "http:" && isLoopbackHostname(url.hostname); + } catch { + return false; + } +} + +async function handleAuthorize(req: Request, res: Response) { + const { + client_id, + redirect_uri, + state, + code_challenge, + code_challenge_method, + scope, + approved, + resource, + } = req.query as Record; + if (!redirect_uri) { + res.status(400).json({ + error: "invalid_request", + error_description: "Missing redirect_uri", + }); + return; + } + if (!isAllowedRedirectUri(redirect_uri)) { + res.status(400).json({ + error: "invalid_request", + error_description: "redirect_uri must use https (or http on localhost)", + }); + return; + } + // PKCE is mandatory (the MCP auth spec requires it of clients, and this AS + // only advertises S256). Rejecting up front keeps stolen-code attacks out of + // the demo even though it has no real data to protect. + if (!code_challenge || code_challenge_method !== "S256") { + res.status(400).json({ + error: "invalid_request", + error_description: "PKCE with S256 code_challenge is required", + }); + return; + } + const issuer = resolveIssuer(req); + + if (approved !== "1") { + // Show consent page. Keeps the OAuth popup visible so users can see the flow. + const approveUrl = new URL(publicBaseHref(req) + "/authorize"); + for (const [k, v] of Object.entries(req.query)) + if (v) approveUrl.searchParams.set(k, String(v)); + approveUrl.searchParams.set("approved", "1"); + const denyUrl = new URL(redirect_uri); + denyUrl.searchParams.set("error", "access_denied"); + if (state) denyUrl.searchParams.set("state", state); + res.type("text/html").send(/*html*/ ` +Authorize + + +
+

πŸ”‘ Mock Authorization

+

An application is requesting access:

+
Client
${escapeHtml(client_id ?? "(none)")}
+
Scope
${escapeHtml(scope ?? "(default)")}
+
Redirect
${escapeHtml(redirect_uri)}
+
+Approve +Deny +
+
+ +`); + return; + } + + // Per-grant token TTL, requested via `?token_ttl_s=` on the resource + // indicator (the MCP URL the host is authorizing for). Encoded into the + // auth code so /token can issue tokens with the requested lifetime. + const tokenTtl = ttlFromResource(resource); + const code = await signAuthCode( + { + client_id, + redirect_uri, + code_challenge, + code_challenge_method, + scope, + ...(tokenTtl !== undefined ? { token_ttl_s: tokenTtl } : {}), + }, + issuer, + ); + const redirectUrl = new URL(redirect_uri); + redirectUrl.searchParams.set("code", code); + if (state) redirectUrl.searchParams.set("state", state); + console.log( + `[auth] issued code for client_id=${client_id}` + + (tokenTtl !== undefined ? ` (token_ttl_s=${tokenTtl})` : ""), + ); + res.redirect(redirectUrl.href); +} + +async function handleToken(req: Request, res: Response) { + const { grant_type, code, code_verifier, refresh_token, resource } = req.body; + const issuer = resolveIssuer(req); + const audience = resolvePublicUrl(req).href; + + if (grant_type === "refresh_token") { + const refreshClaims = await verifyRefreshToken(refresh_token, issuer); + if (!refreshClaims) { + console.log(`[auth] refresh rejected (invalid/revoked)`); + res.status(400).json({ + error: "invalid_grant", + error_description: "Refresh token invalid or revoked", + }); + return; + } + // Refreshed access tokens keep the grant's requested TTL: prefer the + // resource indicator on this request, else the TTL carried in the refresh + // token, else the default. + const accessTtl = + ttlFromResource(resource) ?? + refreshClaims.accessTtlSeconds ?? + ACCESS_TOKEN_TTL_SECONDS; + const access_token = await signAccessToken( + refreshClaims.sub, + refreshClaims.scope, + refreshClaims.sid, + issuer, + audience, + accessTtl, + ); + console.log( + `[auth] refreshed access token (sid=${refreshClaims.sid}, ttl=${accessTtl}s)`, + ); + res.json({ + access_token, + token_type: "Bearer", + expires_in: accessTtl, + scope: refreshClaims.scope, + refresh_token, + }); + return; + } + if (grant_type !== "authorization_code") { + res.status(400).json({ error: "unsupported_grant_type" }); + return; + } + const stored = await verifyAuthCode(code, issuer); + if (!stored) { + res.status(400).json({ + error: "invalid_grant", + error_description: "Invalid or expired code", + }); + return; + } + // PKCE verification (challenges are always present β€” /authorize requires them). + if (!code_verifier) { + res.status(400).json({ + error: "invalid_grant", + error_description: "Missing code_verifier", + }); + return; + } + const hash = crypto + .createHash("sha256") + .update(code_verifier) + .digest("base64url"); + if (hash !== stored.code_challenge) { + res.status(400).json({ + error: "invalid_grant", + error_description: "PKCE verification failed", + }); + return; + } + // RFC 6749 Β§4.1.3 redirect_uri binding: if the client includes redirect_uri + // in the token request it must match the one from the authorization request. + // (OAuth 2.1 clients may omit it and rely on PKCE, which is enforced above.) + if (req.body.redirect_uri && req.body.redirect_uri !== stored.redirect_uri) { + res.status(400).json({ + error: "invalid_grant", + error_description: "redirect_uri does not match authorization request", + }); + return; + } + const scope = stored.scope ?? "read:secret"; + const sid = crypto.randomBytes(16).toString("hex"); // new session per authorization_code grant + // Per-grant TTL: prefer the resource indicator on this request (RFC 8707), + // else the TTL encoded in the auth code at /authorize, else the default. + // Refresh tokens must outlive the access tokens they can mint. + const accessTtl = + ttlFromResource(resource) ?? stored.token_ttl_s ?? ACCESS_TOKEN_TTL_SECONDS; + const refreshTtl = Math.max(REFRESH_TOKEN_TTL_SECONDS, accessTtl); + const access_token = await signAccessToken( + "mock-user-123", + scope, + sid, + issuer, + audience, + accessTtl, + ); + const refresh = await signRefreshToken( + "mock-user-123", + scope, + sid, + issuer, + refreshTtl, + accessTtl, + ); + console.log( + `[auth] exchanged code β†’ token (client_id=${stored.client_id}, scope=${scope}, sid=${sid}, access_ttl=${accessTtl}s, refresh_ttl=${refreshTtl}s)`, + ); + res.json({ + access_token, + token_type: "Bearer", + expires_in: accessTtl, + scope, + refresh_token: refresh, + }); +} + +// ─── Elicitation state (module-level β€” survives across SHTTP requests) ────── +// +// Streamable HTTP creates a fresh McpServer per request, so state must live at +// module scope. This is fine for a single-process demo server; back it with a +// shared store if you deploy multiple instances. + +/** elicitationIds the user has completed via /elicitation-callback */ +const completedElicitations = new Set(); +/** elicit_by_error: remember the last-issued eid so retries can check it */ +let lastIssuedElicitationId: string | undefined; + +// ─── MCP Server ────────────────────────────────────────────────────────────── + +/** + * Creates a new MCP server instance with tools and resources registered. + * + * @param authInfo - Verified Bearer token info, if the request carried one. + * @param req - The inbound HTTP request (used to resolve the public URL). + */ +export function createServer(authInfo?: AuthInfo, req?: Request): McpServer { + const server = new McpServer({ name: "Lazy Auth Demo", version: "1.0.0" }); + + const buttonUri = "ui://lazy-auth/mcp-app.html"; + registerAppTool( + server, + "show_auth_button", + { + title: "Show Auth Button", + description: + "Public tool: shows a button that triggers the protected get_secret tool.", + inputSchema: z.object({}), + _meta: { ui: { resourceUri: buttonUri } }, + }, + async (): Promise => ({ + content: [{ type: "text", text: "ok" }], + }), + ); + registerAppResource( + server, + buttonUri, + buttonUri, + { mimeType: RESOURCE_MIME_TYPE }, + async (): Promise => { + const html = await fs.readFile( + path.join(DIST_DIR, "mcp-app.html"), + "utf-8", + ); + return { + contents: [ + { uri: buttonUri, mimeType: RESOURCE_MIME_TYPE, text: html }, + ], + }; + }, + ); + + const secretUri = "ui://lazy-auth/secret-app.html"; + registerAppTool( + server, + "get_secret", + { + title: "Get Secret", + description: + "Protected tool: returns secret data. Requires authentication.", + inputSchema: z.object({}), + _meta: { ui: { resourceUri: secretUri } }, + }, + async (): Promise => { + if (!authInfo) { + return { + isError: true, + content: [{ type: "text", text: "Authentication required." }], + }; + } + const secret = { + subject: authInfo.sub, + secret: "the-answer-is-42", + issuedAt: new Date().toISOString(), + }; + return { + content: [{ type: "text", text: JSON.stringify(secret, null, 2) }], + }; + }, + ); + registerAppResource( + server, + secretUri, + secretUri, + { mimeType: RESOURCE_MIME_TYPE }, + async (): Promise => { + const html = await fs.readFile( + path.join(DIST_DIR, "secret-app.html"), + "utf-8", + ); + return { + contents: [ + { uri: secretUri, mimeType: RESOURCE_MIME_TYPE, text: html }, + ], + }; + }, + ); + + server.registerTool( + "revoke_auth_token", + { + title: "Revoke Auth Token", + description: + "Protected tool: revokes the caller's entire auth session (access + refresh token).", + inputSchema: z.object({}), + }, + async (): Promise => { + if (!authInfo) { + return { + isError: true, + content: [{ type: "text", text: "Authentication required." }], + }; + } + revokeSession(authInfo.sid); + console.log( + `[auth] revoked session sid=${authInfo.sid} (total revoked sessions: ${revokedSids.size})`, + ); + return { + content: [ + { + type: "text", + text: `Session revoked (sid: ${authInfo.sid}). Access + refresh token invalid β†’ full re-auth required.`, + }, + ], + }; + }, + ); + + // ── Elicitation test tools ──────────────────────────────────────────────── + // Public tools β€” no auth. Used to exercise a host's URL-elicitation flow + // end-to-end over Streamable HTTP. + + const base = publicBaseHref(req); + const callbackUrl = (eid: string) => + `${base}/elicitation-callback?id=${encodeURIComponent(eid)}`; + + server.registerTool( + "elicit_url", + { + title: "Elicit URL (session-callback)", + description: + "URL elicitation via elicitInput. Blocks until the client accepts; sends ElicitCompleteNotification before returning.", + inputSchema: z.object({}), + }, + async (_args, extra): Promise => { + const eid = crypto.randomUUID(); + // Defer notifier creation β€” checks client capabilities which throws if + // client doesn't advertise elicitation. Create lazily after elicitInput + // succeeds (implies client supports it). + console.log(`[elicit_url] eid=${eid} β€” blocking on elicitInput`); + const result = await server.server.elicitInput( + { + mode: "url", + url: callbackUrl(eid), + message: "Please open this URL to continue.", + elicitationId: eid, + }, + { relatedRequestId: extra.mcpReq.id, timeout: 300_000 }, + ); + // Send completion notification before returning β€” lands on the same SSE + // stream as this tool response. For Streamable HTTP this is the ONLY + // window where the server can push a notification (stream closes right + // after). The notification is optional per spec β€” skip if the client + // doesn't support it. + try { + const notifier = server.server.createElicitationCompletionNotifier(eid); + await notifier(); + console.log( + `[elicit_url] eid=${eid} β€” notified, result=${result.action}`, + ); + } catch (e) { + console.log( + `[elicit_url] eid=${eid} β€” notify skipped: ${e instanceof Error ? e.message : e}, result=${result.action}`, + ); + } + return { + content: [ + { type: "text", text: `elicit_url: ${JSON.stringify(result)}` }, + ], + }; + }, + ); + + server.registerTool( + "elicit_by_error", + { + title: "Elicit by -32042 Error", + description: + "Throws UrlElicitationRequiredError (-32042). Client must open the URL, then retry. On retry, if the last-issued elicitationId was completed, sends ElicitCompleteNotification and succeeds.", + inputSchema: z.object({}), + }, + async (): Promise => { + // Retry path: check if the user completed the elicitation we last issued. + // Module-level state survives across Streamable HTTP requests in a single + // process. Checking ANY completed eid (not just last-issued) would be more + // forgiving, but last-issued is the stricter real-world pattern hosts must + // handle. + if ( + lastIssuedElicitationId && + completedElicitations.has(lastIssuedElicitationId) + ) { + const eid = lastIssuedElicitationId; + completedElicitations.delete(eid); + lastIssuedElicitationId = undefined; + // Send notification DURING this (retry) tool call β€” only window where + // the Streamable HTTP stream is open. The notification is optional per + // spec β€” createElicitationCompletionNotifier throws if the client + // doesn't advertise the capability, but the tool still succeeds. + try { + const notifier = + server.server.createElicitationCompletionNotifier(eid); + await notifier(); + console.log( + `[elicit_by_error] eid=${eid} β€” completed on retry, notified`, + ); + } catch (e) { + console.log( + `[elicit_by_error] eid=${eid} β€” completed on retry, notify skipped: ${e instanceof Error ? e.message : e}`, + ); + } + return { + content: [ + { + type: "text", + text: `Auth completed (${eid}). Tool succeeded on retry.`, + }, + ], + }; + } + const eid = crypto.randomUUID(); + lastIssuedElicitationId = eid; + console.log(`[elicit_by_error] eid=${eid} β€” throwing -32042`); + throw new UrlElicitationRequiredError([ + { + mode: "url", + url: callbackUrl(eid), + message: + "This tool requires authentication. Please open the link to continue.", + elicitationId: eid, + }, + ]); + }, + ); + + return server; +} + +// ─── Express app ───────────────────────────────────────────────────────────── + +/** + * Creates the Express app: OAuth endpoints, discovery metadata, and the /mcp + * endpoint with lazy (401-triggered) auth on protected tools. + */ +export function createApp(): Express { + const app = express(); + // Wildcard CORS is deliberate: browser-based MCP hosts connect to this demo + // from arbitrary origins and must read WWW-Authenticate to drive the lazy + // auth flow. There are no cookies or ambient credentials to protect β€” all + // auth is an explicit Bearer header, and /token is a credential-less PKCE + // exchange β€” so cross-origin reads expose nothing a direct request wouldn't. + app.use(cors({ exposedHeaders: ["WWW-Authenticate"] })); + app.use(express.json()); + app.use(express.urlencoded({ extended: true })); + + // Request tracing: log every inbound request (incl. query params) so we can + // see what hosts probe during connect and what they send through OAuth. + app.use((req, _res, next) => { + const ua = (req.headers["user-agent"] ?? "").slice(0, 80); + const auth = req.headers.authorization ? "[Bearer]" : "[no-auth]"; + const query = Object.keys(req.query).length + ? ` query=${JSON.stringify(req.query)}` + : ""; + console.log(`[req] ${req.method} ${req.path} ${auth}${query} ua=${ua}`); + next(); + }); + + // OAuth endpoints + app.get("/authorize", handleAuthorize); + app.post("/token", handleToken); + + // OAuth discovery metadata. In REACTIVE_AUTH_ONLY mode, PRM + AS are kept off the + // ROOT /.well-known paths so MCP hosts can't proactively probe them and trigger + // preemptive auth during connection β€” discovery is purely reactive: + // 401 β†’ WWW-Authenticate β†’ PRM β†’ AS β†’ OAuth flow. + const PRM_PATH = "/auth/prm"; + + function buildAsMetadata(req: Request) { + const base = publicBaseHref(req); + return { + issuer: resolveIssuer(req), // subpath issuer β†’ well-known at /.well-known/.../auth + authorization_endpoint: `${base}/authorize`, + token_endpoint: `${base}/token`, + response_types_supported: ["code"], + grant_types_supported: ["authorization_code", "refresh_token"], + code_challenge_methods_supported: ["S256"], + token_endpoint_auth_methods_supported: ["none"], + scopes_supported: ["read:secret"], + client_id_metadata_document_supported: true, + }; + } + + // AS metadata: serve at the issuer's well-known location. + // - REACTIVE_AUTH_ONLY: only at /.well-known/.../auth (subpath); root 404s. + // - Default: also at root /.well-known/... (standard; some hosts probe this on connect). + if (ISSUER_SUFFIX) { + // Per RFC 8414 Β§3: issuer /auth β†’ /.well-known/oauth-authorization-server/auth + app.get( + `/.well-known/oauth-authorization-server${ISSUER_SUFFIX}`, + (req, res) => res.json(buildAsMetadata(req)), + ); + // RFC 8615 style (well-known between host and path): + app.get( + `${ISSUER_SUFFIX}/.well-known/oauth-authorization-server`, + (req, res) => res.json(buildAsMetadata(req)), + ); + } + if (!REACTIVE_AUTH_ONLY) { + // Default mode: full AS metadata at root well-known (standard). + app.get("/.well-known/oauth-authorization-server", (req, res) => + res.json(buildAsMetadata(req)), + ); + } + + // PRM: full version at custom path (referenced via WWW-Authenticate on 401). + function buildPrm(req: Request, includeAuth: boolean, resourcePath = "/mcp") { + const base = publicBaseHref(req); + return { + resource: `${base}${resourcePath}`, + ...(includeAuth + ? { + authorization_servers: [resolveIssuer(req)], + scopes_supported: ["read:secret"], + bearer_methods_supported: ["header"], + } + : {}), + }; + } + /** Resource path for a TTL-scoped MCP endpoint, validating the TTL segment. */ + function ttlResourcePath(rawTtl: string): string | undefined { + const ttl = parseTtlSeconds(rawTtl); + return ttl !== undefined ? `/ttl/${ttl}/mcp` : undefined; + } + app.get(PRM_PATH, (req, res) => res.json(buildPrm(req, true))); + app.get(`${PRM_PATH}/ttl/:ttl`, (req, res) => { + const resourcePath = ttlResourcePath(String(req.params.ttl)); + if (!resourcePath) { + res.status(404).json({ error: "invalid_ttl" }); + return; + } + res.json(buildPrm(req, true, resourcePath)); + }); + // Root + path-dependent well-known PRM: in REACTIVE mode these 404 so hosts don't + // interpret their presence as "server has OAuth". In default mode, full PRM. + if (!REACTIVE_AUTH_ONLY) { + app.get("/.well-known/oauth-protected-resource", (req, res) => + res.json(buildPrm(req, true)), + ); + app.get("/.well-known/oauth-protected-resource/mcp", (req, res) => + res.json(buildPrm(req, true)), + ); + // Well-known PRM for TTL-scoped MCP endpoints (RFC 9728 derives this URL + // from the resource path, so each TTL path has its own). + app.get( + "/.well-known/oauth-protected-resource/ttl/:ttl/mcp", + (req, res) => { + const resourcePath = ttlResourcePath(String(req.params.ttl)); + if (!resourcePath) { + res.status(404).json({ error: "invalid_ttl" }); + return; + } + res.json(buildPrm(req, true, resourcePath)); + }, + ); + } + + // /register: some MCP hosts fall through to OAuth dynamic client registration (RFC 7591) + // when all well-known probes 404. We don't support it β€” return a proper OAuth error so + // the host concludes "auth not available here" and connects without OAuth, instead of + // treating a generic 404 as a connection failure. + app.post("/register", (_req, res) => { + res.status(400).json({ + error: "invalid_request", + error_description: + "Dynamic client registration is not supported. This server uses per-tool auth triggered via WWW-Authenticate on 401.", + }); + }); + + // MCP endpoint handler, shared by the default and TTL-scoped paths. + // pathTtl (from /ttl//mcp) doubles as the acceptance window for + // Bearer tokens: tokens older than it are rejected even if their issued + // lifetime was longer. + async function handleMcp( + req: Request, + res: Response, + pathTtl: number | undefined, + ) { + const base = publicBaseHref(req); + const resourceMetadataUrl = + pathTtl !== undefined + ? `${base}${PRM_PATH}/ttl/${pathTtl}` + : `${base}${PRM_PATH}`; + + const body = req.body; + const messages = Array.isArray(body) ? body : body ? [body] : []; + const needsAuth = messages.some( + (msg: { method?: string; params?: { name?: string } }) => + msg?.method === "tools/call" && + PROTECTED_TOOLS.has(msg.params?.name ?? ""), + ); + + // Acceptance window: the path TTL, else the `?token_ttl_s=` query param + // (fallback for clients that preserve query strings). + const tokenMaxAgeSeconds = + pathTtl ?? parseTtlSeconds(String(req.query.token_ttl_s ?? "")); + + let authInfo: AuthInfo | undefined; + const authHeader = req.headers.authorization; + if (authHeader?.startsWith("Bearer ")) { + authInfo = await verifyAccessToken( + authHeader.slice(7), + resolveIssuer(req), + tokenMaxAgeSeconds, + ); + if (!authInfo && needsAuth) { + console.log(`[mcp] 401: invalid token for protected tool`); + res + .status(401) + .set( + "WWW-Authenticate", + `Bearer error="invalid_token", error_description="The access token is invalid", resource_metadata="${resourceMetadataUrl}"`, + ) + .json({ + error: "invalid_token", + error_description: "The access token is invalid", + }); + return; + } + } else if (needsAuth) { + console.log(`[mcp] 401: no token for protected tool`); + res + .status(401) + .set( + "WWW-Authenticate", + `Bearer resource_metadata="${resourceMetadataUrl}"`, + ) + .json({ + error: "invalid_token", + error_description: "Authorization required", + }); + return; + } + + const server = createServer(authInfo, req); + const transport = new NodeStreamableHTTPServerTransport({ + sessionIdGenerator: undefined, + }); + res.on("close", () => { + transport.close().catch(() => {}); + server.close().catch(() => {}); + }); + + try { + await server.connect(transport); + await transport.handleRequest(req, res, req.body); + } catch (error) { + console.error("[mcp] Error:", error); + if (!res.headersSent) { + res.status(500).json({ + jsonrpc: "2.0", + error: { code: -32603, message: "Internal server error" }, + id: null, + }); + } + } + } + + // Default MCP endpoint (default token TTLs). + app.all("/mcp", (req: Request, res: Response) => + handleMcp(req, res, undefined), + ); + // TTL-scoped MCP endpoint: tokens for connections made through this path are + // issued with (and limited to) the requested lifetime, e.g. /ttl/3600/mcp. + app.all("/ttl/:ttl/mcp", (req: Request, res: Response) => { + const pathTtl = parseTtlSeconds(String(req.params.ttl)); + if (pathTtl === undefined) { + res.status(404).json({ error: "invalid_ttl" }); + return; + } + return handleMcp(req, res, pathTtl); + }); + + // Elicitation callback β€” marks an eid as completed. Module-level state; + // the next elicit_by_error retry reads it. Minimal confirmation page so + // the popup shows something. + app.get("/elicitation-callback", (req, res) => { + const id = String(req.query.id ?? ""); + if (!id) { + res.status(400).type("text/plain").send("missing ?id="); + return; + } + completedElicitations.add(id); + console.log( + `[callback] eid=${id} completed (total: ${completedElicitations.size})`, + ); + res + .type("text/html") + .send( + `Done` + + `` + + `

βœ“ Elicitation completed

` + + `

${escapeHtml(id)}

` + + `

You can close this tab. The tool will succeed on the next retry.

`, + ); + }); + + // Simple landing page + app.get("/", (req, res) => { + const base = publicBaseHref(req); + res + .type("text/plain") + .send( + `Lazy Auth Demo β€” MCP server\n\n` + + ` MCP endpoint: ${base}/mcp\n` + + ` ${base}/ttl//mcp (custom token TTL, e.g. /ttl/3600/mcp)\n` + + ` AS metadata: ${base}/.well-known/oauth-authorization-server${ISSUER_SUFFIX}\n` + + ` PRM metadata: ${base}${PRM_PATH}\n\n` + + `Tools:\n` + + ` - show_auth_button (public)\n` + + ` - get_secret (protected, requires Bearer token)\n` + + ` - revoke_auth_token (protected, revokes caller's auth session)\n` + + ` - elicit_url (public, URL elicitation via elicitInput)\n` + + ` - elicit_by_error (public, URL elicitation via -32042 error)\n`, + ); + }); + + return app; +} diff --git a/examples/lazy-auth-server/src/global.css b/examples/lazy-auth-server/src/global.css new file mode 100644 index 0000000..54a9860 --- /dev/null +++ b/examples/lazy-auth-server/src/global.css @@ -0,0 +1,100 @@ +:root { + color-scheme: light dark; + + /* + * Fallbacks for host style variables used by this app. + * The host may provide these (and many more) via the host context. + */ + --color-text-primary: light-dark(#1f2937, #f3f4f6); + --color-text-inverse: light-dark(#f3f4f6, #1f2937); + --color-text-info: light-dark(#1d4ed8, #60a5fa); + --color-background-primary: light-dark(#ffffff, #1a1a1a); + --color-background-inverse: light-dark(#1a1a1a, #ffffff); + --color-background-info: light-dark(#eff6ff, #1e3a5f); + --color-ring-primary: light-dark(#3b82f6, #60a5fa); + --border-radius-md: 6px; + --border-width-regular: 1px; + --font-sans: + ui-sans-serif, system-ui, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", + "Segoe UI Symbol", "Noto Color Emoji"; + --font-mono: + ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", + "Courier New", monospace; + --font-weight-normal: 400; + --font-weight-bold: 700; + --font-text-md-size: 1rem; + --font-text-md-line-height: 1.5; + --font-heading-3xl-size: 2.25rem; + --font-heading-3xl-line-height: 1.1; + --font-heading-2xl-size: 1.875rem; + --font-heading-2xl-line-height: 1.2; + --font-heading-xl-size: 1.5rem; + --font-heading-xl-line-height: 1.25; + --font-heading-lg-size: 1.25rem; + --font-heading-lg-line-height: 1.3; + --font-heading-md-size: 1rem; + --font-heading-md-line-height: 1.4; + --font-heading-sm-size: 0.875rem; + --font-heading-sm-line-height: 1.4; + + /* Spacing derived from host typography */ + --spacing-unit: var(--font-text-md-size); + --spacing-xs: calc(var(--spacing-unit) * 0.25); + --spacing-sm: calc(var(--spacing-unit) * 0.5); + --spacing-md: var(--spacing-unit); + --spacing-lg: calc(var(--spacing-unit) * 1.5); + + /* App accent color (customize for your brand) */ + --color-accent: #2563eb; + --color-text-on-accent: #ffffff; +} + +* { + box-sizing: border-box; +} + +html, +body { + font-family: var(--font-sans); + font-size: var(--font-text-md-size); + font-weight: var(--font-weight-normal); + line-height: var(--font-text-md-line-height); + color: var(--color-text-primary); +} + +h1 { + font-size: var(--font-heading-3xl-size); + line-height: var(--font-heading-3xl-line-height); +} +h2 { + font-size: var(--font-heading-2xl-size); + line-height: var(--font-heading-2xl-line-height); +} +h3 { + font-size: var(--font-heading-xl-size); + line-height: var(--font-heading-xl-line-height); +} +h4 { + font-size: var(--font-heading-lg-size); + line-height: var(--font-heading-lg-line-height); +} +h5 { + font-size: var(--font-heading-md-size); + line-height: var(--font-heading-md-line-height); +} +h6 { + font-size: var(--font-heading-sm-size); + line-height: var(--font-heading-sm-line-height); +} + +code, +pre, +kbd { + font-family: var(--font-mono); + font-size: 1em; +} + +b, +strong { + font-weight: var(--font-weight-bold); +} diff --git a/examples/lazy-auth-server/src/mcp-app.css b/examples/lazy-auth-server/src/mcp-app.css new file mode 100644 index 0000000..800b224 --- /dev/null +++ b/examples/lazy-auth-server/src/mcp-app.css @@ -0,0 +1,82 @@ +.main { + width: 100%; + max-width: 480px; + box-sizing: border-box; + + > * { + margin-top: 0; + margin-bottom: 0; + } + + > * + * { + margin-top: var(--spacing-md); + } +} + +.actions { + display: flex; + flex-wrap: wrap; + gap: var(--spacing-sm); + /* Keep a long press on or near the buttons from starting text selection + or raising the iOS callout menu instead of a click. */ + -webkit-user-select: none; + user-select: none; + -webkit-touch-callout: none; +} + +button { + /* Match the consent page's 56px tap targets (server.ts .btn). */ + min-height: 56px; + min-width: 56px; + padding: var(--spacing-sm) var(--spacing-md); + border: none; + border-radius: var(--border-radius-md); + color: var(--color-text-on-accent); + font-weight: var(--font-weight-bold); + background-color: var(--color-accent); + cursor: pointer; + /* Suppress the double-tap-to-zoom gesture so a tap resolves to a click + immediately instead of waiting to see if a second tap follows. */ + touch-action: manipulation; + -webkit-tap-highlight-color: transparent; + + &:disabled { + opacity: 0.5; + cursor: not-allowed; + } + + &:active:not(:disabled) { + filter: brightness(0.85); + } + + &:hover:not(:disabled) { + background-color: color-mix( + in srgb, + var(--color-accent) 85%, + var(--color-background-inverse) + ); + } + + &:focus-visible { + outline: calc(var(--border-width-regular) * 2) solid + var(--color-ring-primary); + outline-offset: var(--border-width-regular); + } +} + +.result { + padding: var(--spacing-sm) var(--spacing-md); + border: var(--border-width-regular) solid + color-mix(in srgb, var(--color-text-primary) 25%, transparent); + border-radius: var(--border-radius-md); + font-family: var(--font-mono); + font-size: 0.875em; + white-space: pre-wrap; + word-break: break-word; +} + +.error { + color: var(--color-text-danger, light-dark(#b91c1c, #f87171)); + white-space: pre-wrap; + word-break: break-word; +} diff --git a/examples/lazy-auth-server/src/mcp-app.ts b/examples/lazy-auth-server/src/mcp-app.ts new file mode 100644 index 0000000..f959d71 --- /dev/null +++ b/examples/lazy-auth-server/src/mcp-app.ts @@ -0,0 +1,126 @@ +/** + * @file Public app view: buttons that call the protected tools. + * + * The view itself renders without auth. Clicking "Auth me" calls the protected + * `get_secret` tool via `callServerTool`; the host receives a 401 from the + * server, runs the OAuth flow, retries the call, and the result renders here. + */ +import { + App, + applyDocumentTheme, + applyHostFonts, + applyHostStyleVariables, + type McpUiHostContext, +} from "@modelcontextprotocol/ext-apps"; +import "./global.css"; +import "./mcp-app.css"; + +const mainEl = document.querySelector(".main") as HTMLElement; +const authBtn = document.getElementById("auth-btn") as HTMLButtonElement; +const revokeBtn = document.getElementById("revoke-btn") as HTMLButtonElement; +const fullscreenBtn = document.getElementById( + "fullscreen-btn", +) as HTMLButtonElement; +const outputEl = document.getElementById("output")!; + +function handleHostContextChanged(ctx: McpUiHostContext) { + if (ctx.theme) { + applyDocumentTheme(ctx.theme); + } + if (ctx.styles?.variables) { + applyHostStyleVariables(ctx.styles.variables); + } + if (ctx.styles?.css?.fonts) { + applyHostFonts(ctx.styles.css.fonts); + } + if (ctx.safeAreaInsets) { + mainEl.style.paddingTop = `${ctx.safeAreaInsets.top}px`; + mainEl.style.paddingRight = `${ctx.safeAreaInsets.right}px`; + mainEl.style.paddingBottom = `${ctx.safeAreaInsets.bottom}px`; + mainEl.style.paddingLeft = `${ctx.safeAreaInsets.left}px`; + } +} + +const app = new App( + { name: "Lazy Auth Demo", version: "1.0.0" }, + { availableDisplayModes: ["inline", "fullscreen"] }, +); + +// The host echoes the result of the originating `show_auth_button` call; nothing to render. +app.ontoolresult = () => {}; +app.onerror = console.error; +app.onhostcontextchanged = handleHostContextChanged; + +function renderOutput(text: string, isError: boolean) { + const div = document.createElement("div"); + div.className = isError ? "error" : "result"; + div.textContent = text; + outputEl.replaceChildren(div); +} + +/** + * Calls a (protected) server tool. The interesting part happens on the host: + * the server answers 401 + WWW-Authenticate, the host runs the OAuth flow, + * then retries the call and returns the result here. + * + * The default MCP request timeout is 60s; the OAuth flow involves a human + * approving a consent page, which can easily take longer. Use a generous + * timeout so the pending call survives the sign-in round trip. + */ +const AUTH_FLOW_TIMEOUT_MS = 5 * 60_000; + +async function callTool(name: string) { + outputEl.replaceChildren(); + try { + console.info(`Calling ${name} tool...`); + const result = await app.callServerTool( + { name, arguments: {} }, + { timeout: AUTH_FLOW_TIMEOUT_MS }, + ); + const text = + result.content?.find((c) => c.type === "text")?.text ?? "(no content)"; + renderOutput(text, result.isError === true); + } catch (e) { + renderOutput(String(e instanceof Error ? e.message : e), true); + } +} + +authBtn.addEventListener("click", async () => { + authBtn.disabled = true; + try { + await callTool("get_secret"); + } finally { + authBtn.disabled = false; + } +}); + +revokeBtn.addEventListener("click", async () => { + revokeBtn.disabled = true; + try { + await callTool("revoke_auth_token"); + } finally { + revokeBtn.disabled = false; + } +}); + +let displayMode = "inline"; +fullscreenBtn.addEventListener("click", async () => { + fullscreenBtn.disabled = true; + try { + const next = displayMode === "fullscreen" ? "inline" : "fullscreen"; + const { mode } = await app.requestDisplayMode({ mode: next }); + displayMode = mode; + } catch (e) { + console.warn("Display mode not supported:", e); + } finally { + fullscreenBtn.disabled = false; + } +}); + +app.connect().then(() => { + const ctx = app.getHostContext(); + if (ctx) { + handleHostContextChanged(ctx); + displayMode = ctx.displayMode ?? "inline"; + } +}); diff --git a/examples/lazy-auth-server/src/secret-app.ts b/examples/lazy-auth-server/src/secret-app.ts new file mode 100644 index 0000000..aeb6857 --- /dev/null +++ b/examples/lazy-auth-server/src/secret-app.ts @@ -0,0 +1,57 @@ +/** + * @file Protected app view: renders the result of the `get_secret` tool. + * + * This view is only reached after the host has completed the OAuth flow + * (the tool call that produces it requires a Bearer token). + */ +import { + App, + applyDocumentTheme, + applyHostFonts, + applyHostStyleVariables, + type McpUiHostContext, +} from "@modelcontextprotocol/ext-apps"; +import "./global.css"; +import "./mcp-app.css"; + +const mainEl = document.querySelector(".main") as HTMLElement; +const outputEl = document.getElementById("output")!; + +function handleHostContextChanged(ctx: McpUiHostContext) { + if (ctx.theme) { + applyDocumentTheme(ctx.theme); + } + if (ctx.styles?.variables) { + applyHostStyleVariables(ctx.styles.variables); + } + if (ctx.styles?.css?.fonts) { + applyHostFonts(ctx.styles.css.fonts); + } + if (ctx.safeAreaInsets) { + mainEl.style.paddingTop = `${ctx.safeAreaInsets.top}px`; + mainEl.style.paddingRight = `${ctx.safeAreaInsets.right}px`; + mainEl.style.paddingBottom = `${ctx.safeAreaInsets.bottom}px`; + mainEl.style.paddingLeft = `${ctx.safeAreaInsets.left}px`; + } +} + +const app = new App({ name: "Lazy Auth Demo (Secret)", version: "1.0.0" }); + +app.onerror = console.error; +app.onhostcontextchanged = handleHostContextChanged; + +app.ontoolresult = (result) => { + const text = + result.content?.find((c) => c.type === "text")?.text ?? "(no content)"; + const div = document.createElement("div"); + div.className = result.isError ? "error" : "result"; + div.textContent = text; + outputEl.replaceChildren(div); +}; + +app.connect().then(() => { + const ctx = app.getHostContext(); + if (ctx) { + handleHostContextChanged(ctx); + } +}); diff --git a/examples/lazy-auth-server/tsconfig.json b/examples/lazy-auth-server/tsconfig.json new file mode 100644 index 0000000..d6a42ce --- /dev/null +++ b/examples/lazy-auth-server/tsconfig.json @@ -0,0 +1,20 @@ +{ + "compilerOptions": { + "types": ["node", "vite/client"], + "target": "ESNext", + "lib": ["ESNext", "DOM", "DOM.Iterable"], + "module": "ESNext", + "moduleResolution": "bundler", + "allowImportingTsExtensions": true, + "resolveJsonModule": true, + "isolatedModules": true, + "verbatimModuleSyntax": true, + "noEmit": true, + "strict": true, + "skipLibCheck": true, + "noUnusedLocals": true, + "noUnusedParameters": true, + "noFallthroughCasesInSwitch": true + }, + "include": ["src", "server.ts", "main.ts"] +} diff --git a/examples/lazy-auth-server/tsconfig.server.json b/examples/lazy-auth-server/tsconfig.server.json new file mode 100644 index 0000000..27eb28f --- /dev/null +++ b/examples/lazy-auth-server/tsconfig.server.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "types": ["node"], + "target": "ES2022", + "lib": ["ES2022"], + "module": "NodeNext", + "moduleResolution": "NodeNext", + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "./dist", + "rootDir": ".", + "strict": true, + "skipLibCheck": true, + "esModuleInterop": true, + "resolveJsonModule": true + }, + "include": ["server.ts"] +} diff --git a/examples/lazy-auth-server/vite.config.ts b/examples/lazy-auth-server/vite.config.ts new file mode 100644 index 0000000..6ff6d99 --- /dev/null +++ b/examples/lazy-auth-server/vite.config.ts @@ -0,0 +1,24 @@ +import { defineConfig } from "vite"; +import { viteSingleFile } from "vite-plugin-singlefile"; + +const INPUT = process.env.INPUT; +if (!INPUT) { + throw new Error("INPUT environment variable is not set"); +} + +const isDevelopment = process.env.NODE_ENV === "development"; + +export default defineConfig({ + plugins: [viteSingleFile()], + build: { + sourcemap: isDevelopment ? "inline" : undefined, + cssMinify: !isDevelopment, + minify: !isDevelopment, + + rollupOptions: { + input: INPUT, + }, + outDir: "dist", + emptyOutDir: false, + }, +}); diff --git a/examples/map-server/README.md b/examples/map-server/README.md index 4c4de5f..e1e044a 100644 --- a/examples/map-server/README.md +++ b/examples/map-server/README.md @@ -122,7 +122,7 @@ Vanilla TypeScript app that: - [`server.ts`](server.ts) - MCP server with geocode and show-map tools - [`mcp-app.html`](mcp-app.html) / [`src/mcp-app.ts`](src/mcp-app.ts) - CesiumJS globe UI -- [`server-utils.ts`](server-utils.ts) - HTTP server utilities +- [`main.ts`](main.ts) - HTTP and stdio server utilities ## Notes diff --git a/examples/map-server/main.ts b/examples/map-server/main.ts index f91f57b..8038394 100644 --- a/examples/map-server/main.ts +++ b/examples/map-server/main.ts @@ -4,10 +4,10 @@ * Or: node dist/index.js [--stdio] */ -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; -import { createMcpExpressApp } from "@modelcontextprotocol/sdk/server/express.js"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { createMcpExpressApp } from "@modelcontextprotocol/express"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; +import type { McpServer } from "@modelcontextprotocol/server"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; import cors from "cors"; import type { Request, Response } from "express"; import { createServer } from "./server.js"; @@ -27,7 +27,7 @@ export async function startStreamableHTTPServer( app.all("/mcp", async (req: Request, res: Response) => { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); diff --git a/examples/map-server/mcp-app.html b/examples/map-server/mcp-app.html index 473eb50..b19eed4 100644 --- a/examples/map-server/mcp-app.html +++ b/examples/map-server/mcp-app.html @@ -1,72 +1,90 @@ - + - - - + + + CesiumJS Globe - - + +
Loading globe...
- + diff --git a/examples/map-server/package.json b/examples/map-server/package.json index 0c7b528..cc4585f 100644 --- a/examples/map-server/package.json +++ b/examples/map-server/package.json @@ -1,11 +1,11 @@ { "name": "@modelcontextprotocol/server-map", - "version": "1.2.0", + "version": "2.0.0", "type": "module", "description": "MCP App Server example with CesiumJS 3D globe and geocoding", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", "directory": "examples/map-server" }, "license": "MIT", @@ -26,11 +26,14 @@ "serve": "bun --watch main.ts" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "devDependencies": { "@types/cors": "^2.8.19", diff --git a/examples/map-server/server.ts b/examples/map-server/server.ts index 540d35c..5767d46 100644 --- a/examples/map-server/server.ts +++ b/examples/map-server/server.ts @@ -5,11 +5,11 @@ * - geocode: Search for places using OpenStreetMap Nominatim * - show-map: Display an interactive 3D globe at a given location */ -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import type { - CallToolResult, - ReadResourceResult, -} from "@modelcontextprotocol/sdk/types.js"; +import { + McpServer, + type CallToolResult, + type ReadResourceResult, +} from "@modelcontextprotocol/server"; import fs from "node:fs/promises"; import path from "node:path"; import { z } from "zod"; @@ -147,8 +147,8 @@ export function createServer(): McpServer { { title: "Show Map", description: - "Display an interactive world map zoomed to a specific bounding box. Use the GeoCode tool to find the bounding box of a location.", - inputSchema: { + "Display an interactive world map zoomed to a specific bounding box. Use the GeoCode tool to find the bounding box of a location. The widget is interactive and exposes tools for navigation (fly to locations) and querying the current view.", + inputSchema: z.object({ west: z .number() .optional() @@ -173,7 +173,7 @@ export function createServer(): McpServer { .string() .optional() .describe("Optional label to display on the map"), - }, + }), _meta: { ui: { resourceUri } }, }, async ({ west, south, east, north, label }): Promise => ({ @@ -196,13 +196,13 @@ export function createServer(): McpServer { title: "Geocode", description: "Search for places using OpenStreetMap. Returns coordinates and bounding boxes for up to 5 matches.", - inputSchema: { + inputSchema: z.object({ query: z .string() .describe( "Place name or address to search for (e.g., 'Paris', 'Golden Gate Bridge', '1600 Pennsylvania Ave')", ), - }, + }), }, async ({ query }): Promise => { try { diff --git a/examples/map-server/src/mcp-app.ts b/examples/map-server/src/mcp-app.ts index 1475d81..d3090c7 100644 --- a/examples/map-server/src/mcp-app.ts +++ b/examples/map-server/src/mcp-app.ts @@ -6,7 +6,8 @@ * a navigate-to tool for the host to control navigation. */ import { App } from "@modelcontextprotocol/ext-apps"; -import type { ContentBlock } from "@modelcontextprotocol/sdk/spec.types.js"; +import type { ContentBlock } from "@modelcontextprotocol/client"; +import { z } from "zod"; // TypeScript declaration for Cesium loaded from CDN // eslint-disable-next-line @typescript-eslint/no-explicit-any @@ -397,6 +398,17 @@ async function initCesium(): Promise { // CesiumJS sets image-rendering: pixelated by default which looks bad on scaled displays // Setting to "auto" allows the browser to apply smooth interpolation cesiumViewer.canvas.style.imageRendering = "auto"; + // Prevent touch events from propagating to the parent scroll view. + // CesiumJS uses pointer events internally, which don't suppress native + // scroll gesture recognition on touch devices. Explicit non-passive touch + // listeners with preventDefault() are needed. + for (const eventName of ["touchstart", "touchmove"] as const) { + cesiumViewer.canvas.addEventListener( + eventName, + (e: TouchEvent) => e.preventDefault(), + { passive: false }, + ); + } // Note: DO NOT set resolutionScale = devicePixelRatio here! // When useBrowserRecommendedResolution: false, Cesium already uses devicePixelRatio. // Setting resolutionScale = devicePixelRatio would double the scaling (e.g., 2x2=4x on Retina) @@ -548,6 +560,76 @@ function setViewToBoundingBox(cesiumViewer: any, bbox: BoundingBox): void { ); } +/** + * Fly camera to view a bounding box with animation + */ +function flyToBoundingBox( + cesiumViewer: any, + bbox: BoundingBox, + duration = 2, +): Promise { + return new Promise((resolve) => { + const { destination, centerLon, centerLat, height } = + calculateDestination(bbox); + + log.info("flyTo destination:", centerLon, centerLat, "height:", height); + + cesiumViewer.camera.flyTo({ + destination, + orientation: { + heading: 0, + pitch: Cesium.Math.toRadians(-90), // Look straight down + roll: 0, + }, + duration, + complete: () => { + log.info( + "flyTo complete, camera height:", + cesiumViewer.camera.positionCartographic.height, + ); + resolve(); + }, + cancel: () => { + log.warn("flyTo cancelled"); + resolve(); + }, + }); + }); +} + +// Label element for displaying location info +let labelElement: HTMLDivElement | null = null; + +/** + * Set or clear the label displayed on the map + */ +function setLabel(text?: string): void { + if (!labelElement) { + labelElement = document.createElement("div"); + labelElement.style.cssText = ` + position: absolute; + top: 10px; + left: 10px; + background: rgba(0, 0, 0, 0.7); + color: white; + padding: 8px 12px; + border-radius: 4px; + font-family: sans-serif; + font-size: 14px; + z-index: 100; + pointer-events: none; + `; + document.body.appendChild(labelElement); + } + + if (text) { + labelElement.textContent = text; + labelElement.style.display = "block"; + } else { + labelElement.style.display = "none"; + } +} + /** * Wait for globe tiles to finish loading */ @@ -623,6 +705,16 @@ function updateFullscreenButton(): void { // Show button only if fullscreen is available btn.style.display = canFullscreen ? "flex" : "none"; + // Position button respecting safe area insets + const insets = context?.safeAreaInsets; + btn.style.top = `${10 + (insets?.top ?? 0)}px`; + btn.style.right = `${10 + (insets?.right ?? 0)}px`; + + // Always show button on touch devices (hover doesn't work on mobile) + if (context?.deviceCapabilities?.touch) { + btn.style.opacity = canFullscreen ? "0.7" : "0"; + } + // Toggle icons based on current mode const isFullscreen = currentDisplayMode === "fullscreen"; expandIcon.style.display = isFullscreen ? "none" : "block"; @@ -718,8 +810,8 @@ app.onhostcontextchanged = (params) => { ); } - // Update button if available modes changed - if (params.availableDisplayModes) { + // Update button if available modes or safe area changed + if (params.availableDisplayModes || params.safeAreaInsets) { updateFullscreenButton(); } }; @@ -780,57 +872,110 @@ app.ontoolinput = async (params) => { } }; -/* - Register tools for the model to interact w/ this component - Needs https://github.com/modelcontextprotocol/ext-apps/pull/72 -*/ -// app.registerTool( -// "navigate-to", -// { -// title: "Navigate To", -// description: "Navigate the globe to a new bounding box location", -// inputSchema: z.object({ -// west: z.number().describe("Western longitude (-180 to 180)"), -// south: z.number().describe("Southern latitude (-90 to 90)"), -// east: z.number().describe("Eastern longitude (-180 to 180)"), -// north: z.number().describe("Northern latitude (-90 to 90)"), -// duration: z -// .number() -// .optional() -// .describe("Animation duration in seconds (default: 2)"), -// label: z.string().optional().describe("Optional label to display"), -// }), -// }, -// async (args) => { -// if (!viewer) { -// return { -// content: [ -// { type: "text" as const, text: "Error: Viewer not initialized" }, -// ], -// isError: true, -// }; -// } +// Register tools for the model to interact with this component +app.registerTool( + "navigate-to", + { + title: "Navigate To", + description: "Navigate the globe to a new bounding box location", + inputSchema: z.object({ + west: z.number().describe("Western longitude (-180 to 180)"), + south: z.number().describe("Southern latitude (-90 to 90)"), + east: z.number().describe("Eastern longitude (-180 to 180)"), + north: z.number().describe("Northern latitude (-90 to 90)"), + duration: z + .number() + .optional() + .describe("Animation duration in seconds (default: 2)"), + label: z.string().optional().describe("Optional label to display"), + }), + }, + async (args) => { + if (!viewer) { + return { + content: [ + { type: "text" as const, text: "Error: Viewer not initialized" }, + ], + isError: true, + }; + } -// const bbox: BoundingBox = { -// west: args.west, -// south: args.south, -// east: args.east, -// north: args.north, -// }; + const bbox: BoundingBox = { + west: args.west, + south: args.south, + east: args.east, + north: args.north, + }; -// await flyToBoundingBox(viewer, bbox, args.duration ?? 2); -// setLabel(args.label); + await flyToBoundingBox(viewer, bbox, args.duration ?? 2); + setLabel(args.label); -// return { -// content: [ -// { -// type: "text" as const, -// text: `Navigated to: W:${bbox.west.toFixed(4)}, S:${bbox.south.toFixed(4)}, E:${bbox.east.toFixed(4)}, N:${bbox.north.toFixed(4)}${args.label ? ` (${args.label})` : ""}`, -// }, -// ], -// }; -// }, -// ); + return { + content: [ + { + type: "text" as const, + text: `Navigated to: W:${bbox.west.toFixed(4)}, S:${bbox.south.toFixed(4)}, E:${bbox.east.toFixed(4)}, N:${bbox.north.toFixed(4)}${args.label ? ` (${args.label})` : ""}`, + }, + ], + }; + }, +); + +app.registerTool( + "get-current-view", + { + title: "Get Current View", + description: + "Get the current camera position and bounding box visible on the globe", + }, + async () => { + if (!viewer) { + return { + content: [ + { type: "text" as const, text: "Error: Viewer not initialized" }, + ], + isError: true, + }; + } + + const camera = viewer.camera; + const positionCartographic = camera.positionCartographic; + const latitude = Cesium.Math.toDegrees(positionCartographic.latitude); + const longitude = Cesium.Math.toDegrees(positionCartographic.longitude); + const height = positionCartographic.height; + + // Get the visible bounding box + const rectangle = viewer.camera.computeViewRectangle(); + let bbox = null; + if (rectangle) { + bbox = { + west: Cesium.Math.toDegrees(rectangle.west), + south: Cesium.Math.toDegrees(rectangle.south), + east: Cesium.Math.toDegrees(rectangle.east), + north: Cesium.Math.toDegrees(rectangle.north), + }; + } + + const viewData = { + camera: { + latitude, + longitude, + height, + }, + bbox, + }; + + return { + content: [ + { + type: "text" as const, + text: JSON.stringify(viewData, null, 2), + }, + ], + structuredContent: viewData, + }; + }, +); // Handle tool result - extract viewUUID and restore persisted view if available app.ontoolresult = async (result) => { diff --git a/examples/map-server/tsconfig.json b/examples/map-server/tsconfig.json index 535267b..b028ff5 100644 --- a/examples/map-server/tsconfig.json +++ b/examples/map-server/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "vite/client"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", diff --git a/examples/map-server/tsconfig.server.json b/examples/map-server/tsconfig.server.json index 05ddd8e..27eb28f 100644 --- a/examples/map-server/tsconfig.server.json +++ b/examples/map-server/tsconfig.server.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node"], "target": "ES2022", "lib": ["ES2022"], "module": "NodeNext", diff --git a/examples/pdf-server/README.md b/examples/pdf-server/README.md index 5b518d5..2bee370 100644 --- a/examples/pdf-server/README.md +++ b/examples/pdf-server/README.md @@ -149,6 +149,20 @@ bun examples/pdf-server/main.ts ./local.pdf https://arxiv.org/pdf/2401.00001.pdf bun examples/pdf-server/main.ts --stdio ./papers/ ``` +### Additional Flags + +- `--debug` β€” Enable verbose server-side logging. +- `--enable-interact` β€” Enable the `interact` tool in HTTP mode (see [Deployment](#deployment)). Not needed for stdio. +- `--writeable-uploads-root` β€” Allow saving annotated PDFs back to files under client roots named `uploads` (Claude Desktop mounts attachments there; writes are refused by default). + +## Deployment + +The `interact` tool relies on an in-memory command queue (server enqueues β†’ viewer polls). This constrains how the server can be deployed: + +- **stdio** (Claude Desktop) β€” `interact` is always enabled. The server runs as a single long-lived process, so the in-memory queue works. +- **HTTP, single instance** β€” Pass `--enable-interact` to opt in. Works as long as all requests land on the same process. +- **HTTP, stateless / multi-instance** β€” `interact` will not work. Commands enqueued on one instance are invisible to viewers polling another. Leave the flag off; the tool will not be registered. + ## Security: Client Roots MCP clients may advertise **roots** β€” `file://` URIs pointing to directories on the client's file system. The server uses these to allow access to local files under those directories. @@ -174,34 +188,159 @@ When roots are ignored the server logs: ## Tools -| Tool | Visibility | Purpose | -| ---------------- | ---------- | -------------------------------------- | -| `list_pdfs` | Model | List available local files and origins | -| `display_pdf` | Model + UI | Display interactive viewer | -| `read_pdf_bytes` | App only | Stream PDF data in chunks | +| Tool | Visibility | Purpose | +| ---------------- | ---------- | ------------------------------------------------------------------- | +| `list_pdfs` | Model | List available local files and origins | +| `display_pdf` | Model + UI | Display interactive viewer | +| `interact`ΒΉ | Model | Navigate, annotate, search, extract pages, fill forms, save to file | +| `read_pdf_bytes` | App only | Stream PDF data in chunks | +| `save_pdf` | App only | Save annotated PDF back to local file | + +ΒΉ stdio only by default; in HTTP mode requires `--enable-interact` β€” see [Deployment](#deployment). + +## Example Prompts + +After the model calls `display_pdf`, it receives the `viewUUID` and a description of all capabilities. Here are example prompts and follow-ups that exercise annotation features: + +### Annotating + +> **User:** Show me the Attention Is All You Need paper +> +> _Model calls `display_pdf` β†’ viewer opens_ +> +> **User:** Highlight the title and add an APPROVED stamp on the first page. +> +> _Model calls `interact` with `highlight_text` for the title and `add_annotations` with a stamp_ + +> **User:** Can you annotate this PDF? Mark important sections for me. +> +> _Model calls `interact` with `get_text` to read content first, then `add_annotations` with highlights/notes_ + +> **User:** Add a note on page 1 saying "Key contribution" at position (200, 500), and highlight the abstract. +> +> _Model calls `interact` with `add_annotations` containing a `note` and either `highlight_text` or a `highlight` annotation_ + +### Navigation & Search + +> **User:** Search for "self-attention" in the paper. +> +> _Model calls `interact` with action `search`, query `"self-attention"`_ + +> **User:** Go to page 5. +> +> _Model calls `interact` with action `navigate`, page `5`_ + +### Page Extraction + +> **User:** Give me the text of pages 1–3. +> +> _Model calls `interact` with action `get_text`, intervals `[{start:1, end:3}]`_ + +> **User:** Take a screenshot of the first page. +> +> _Model calls `interact` with action `get_screenshot`, page `1`_ + +### Stamps & Form Filling + +> **User:** Stamp this document as CONFIDENTIAL on every page. +> +> _Model calls `interact` with `add_annotations` containing `stamp` annotations on each page_ + +> **User:** Fill in the "Name" field with "Alice" and "Date" with "2026-02-26". +> +> _Model calls `interact` with action `fill_form`, fields `[{name:"Name", value:"Alice"}, {name:"Date", value:"2026-02-26"}]`_ + +### Saving + +> **User:** Save the annotated version as `/docs/contract-signed.pdf`. +> +> _Model calls `interact` with action `save_as`, path `/docs/contract-signed.pdf`. Fails if the file exists; pass `overwrite: true` to replace. The target path must be under a mounted directory root._ + +> **User:** Save my changes back to the file. +> +> _Model calls `interact` with action `save_as`, `overwrite: true` (no `path`). Overwrites the original β€” same writability gate as the viewer's save button. Only works for local files; remote PDFs need an explicit `path`._ + +## Testing + +### E2E Tests (Playwright) + +```bash +# Run annotation E2E tests (renders annotations in a real browser) +npx playwright test tests/e2e/pdf-annotations.spec.ts + +# Run all PDF server tests +npx playwright test -g "PDF Server" +``` + +### API Prompt Discovery Tests + +These tests verify that Claude can discover and use annotation capabilities by calling the Anthropic Messages API with the tool schemas. They are **disabled by default** β€” skipped unless `ANTHROPIC_API_KEY` is set: + +```bash +ANTHROPIC_API_KEY=sk-ant-... npx playwright test tests/e2e/pdf-annotations-api.spec.ts +``` + +The API tests simulate a conversation where `display_pdf` has already been called, then send a follow-up user message and verify the model uses annotation actions (or at least the `interact` tool). Three scenarios are tested: + +| Scenario | User prompt | Expected model behavior | +| -------------------- | ----------------------------------------------------------------- | ------------------------------------------ | +| Direct annotation | "Highlight the title and add an APPROVED stamp" | Uses `highlight_text` or `add_annotations` | +| Capability discovery | "Can you annotate this PDF?" | Uses interact or mentions annotations | +| Specific notes | "Add a note saying 'Key contribution' and highlight the abstract" | Uses `interact` tool | ## Architecture ``` -server.ts # MCP server + tools -main.ts # CLI entry point +server.ts # MCP server + tools +main.ts # CLI entry point src/ -└── mcp-app.ts # Interactive viewer UI (PDF.js) +β”œβ”€β”€ mcp-app.ts # Interactive viewer UI (PDF.js) +β”œβ”€β”€ pdf-annotations.ts # Annotation types, diff model, PDF import/export +└── pdf-annotations.test.ts # Unit tests for annotation module ``` ## Key Patterns Shown -| Pattern | Implementation | -| ----------------- | ------------------------------------------- | -| App-only tools | `_meta: { ui: { visibility: ["app"] } }` | -| Chunked responses | `hasMore` + `offset` pagination | -| Model context | `app.updateModelContext()` | -| Display modes | `app.requestDisplayMode()` | -| External links | `app.openLink()` | -| View persistence | `viewUUID` + localStorage | -| Theming | `applyDocumentTheme()` + CSS `light-dark()` | +| Pattern | Implementation | +| ----------------------------- | -------------------------------------------------------------- | +| App-only tools | `_meta: { ui: { visibility: ["app"] } }` | +| Chunked responses | `hasMore` + `offset` pagination | +| Model context | `app.updateModelContext()` | +| Display modes | `app.requestDisplayMode()` | +| External links | `app.openLink()` | +| View persistence | `viewUUID` + localStorage | +| Theming | `applyDocumentTheme()` + CSS `light-dark()` | +| Annotations | DOM overlays synced with proper PDF annotation dicts | +| Annotation import | Load existing PDF annotations via PDF.js `getAnnotations()` | +| Diff-based persistence | localStorage stores only additions/removals vs PDF baseline | +| Proper PDF export | pdf-lib low-level API creates real `/Type /Annot` dictionaries | +| Save to file | App-only `save_pdf` tool writes annotated bytes back to disk | +| Dirty flag | `*` prefix on title when unsaved local changes exist | +| Command queue | Server enqueues β†’ client polls + processes | +| File download | `app.downloadFile()` for annotated PDF | +| Floating panel with anchoring | Magnetic corner-snapping panel for annotation list | +| Drag, resize, rotate | Interactive annotation handles with undo/redo | +| Keyboard shortcuts | Ctrl+Z/Y (undo/redo), Ctrl+S (save), Ctrl+F (search), ⌘Enter | + +### Annotation Types + +Supported annotation types (synced with PDF.js): + +| Type | Properties | PDF Subtype | +| --------------- | ------------------------------------------------------------------ | ------------ | +| `highlight` | `rects`, `color?`, `content?` | `/Highlight` | +| `underline` | `rects`, `color?` | `/Underline` | +| `strikethrough` | `rects`, `color?` | `/StrikeOut` | +| `note` | `x`, `y`, `content`, `color?` | `/Text` | +| `rectangle` | `x`, `y`, `width`, `height`, `color?`, etc. | `/Square` | +| `circle` | `x`, `y`, `width`, `height`, `color?`, etc. | `/Circle` | +| `line` | `x1`, `y1`, `x2`, `y2`, `color?` | `/Line` | +| `freetext` | `x`, `y`, `content`, `fontSize?`, `color?` | `/FreeText` | +| `stamp` | `x`, `y`, `label`, `color?`, `rotation?` | `/Stamp` | +| `image` | `x`, `y`, `width`, `height`, `imageData?`/`imageUrl?`, `rotation?` | `/Stamp` | ## Dependencies -- `pdfjs-dist`: PDF rendering (frontend only) +- `pdfjs-dist`: PDF rendering and annotation import (frontend only) +- `pdf-lib`: Client-side PDF modification β€” creates proper PDF annotation dictionaries for export - `@modelcontextprotocol/ext-apps`: MCP Apps SDK diff --git a/examples/pdf-server/build-mcpb.mjs b/examples/pdf-server/build-mcpb.mjs new file mode 100644 index 0000000..2917334 --- /dev/null +++ b/examples/pdf-server/build-mcpb.mjs @@ -0,0 +1,71 @@ +#!/usr/bin/env node +/** + * Build a self-contained .mcpb bundle for pdf-server. + * + * `mcpb pack` zips whatever is on disk; in this monorepo all runtime deps + * are hoisted to the root node_modules, so packing in-place produces a + * bundle with no pdfjs-dist/ajv/etc. that crashes in Claude Desktop. + * + * This script stages dist/ + manifest into a clean temp dir, runs a fresh + * non-workspace `npm install --omit=dev --omit=optional` (the polyfill in + * dist/pdfjs-polyfill.js makes @napi-rs/canvas's ~130MB of native binaries + * unnecessary), syncs the manifest version to package.json, then packs. + */ + +import { + cpSync, + rmSync, + mkdirSync, + readFileSync, + writeFileSync, +} from "node:fs"; +import { execSync } from "node:child_process"; +import { fileURLToPath } from "node:url"; +import path from "node:path"; + +const here = path.dirname(fileURLToPath(import.meta.url)); +const stage = path.join(here, ".mcpb-stage"); +const out = path.join(here, "pdf-server.mcpb"); + +const pkg = JSON.parse(readFileSync(path.join(here, "package.json"), "utf8")); +const manifest = JSON.parse( + readFileSync(path.join(here, "manifest.json"), "utf8"), +); +manifest.version = pkg.version; + +rmSync(stage, { recursive: true, force: true }); +mkdirSync(stage); + +for (const f of ["dist", "icon.png", "README.md", ".mcpbignore"]) { + cpSync(path.join(here, f), path.join(stage, f), { recursive: true }); +} +writeFileSync( + path.join(stage, "manifest.json"), + JSON.stringify(manifest, null, 2), +); +// The bundle must ship the ext-apps build from this checkout, not whatever +// the registry has: pack the repo root and point the staged manifest at it. +const repoRoot = path.resolve(here, "..", ".."); +const packed = JSON.parse( + execSync( + "npm pack --json --ignore-scripts --pack-destination " + + JSON.stringify(stage), + { + cwd: repoRoot, + encoding: "utf8", + }, + ).replace(/^[^[]*/, ""), +); +pkg.dependencies["@modelcontextprotocol/ext-apps"] = + "file:./" + packed[0].filename; +writeFileSync(path.join(stage, "package.json"), JSON.stringify(pkg, null, 2)); + +const run = (cmd) => execSync(cmd, { cwd: stage, stdio: "inherit" }); +run( + "npm install --omit=dev --omit=optional --no-audit --no-fund --no-package-lock " + + "--registry=https://registry.npmjs.org/", +); +run(`npx -y @anthropic-ai/mcpb pack . ${JSON.stringify(out)}`); + +rmSync(stage, { recursive: true, force: true }); +console.log(`\nβœ… ${path.relative(process.cwd(), out)}`); diff --git a/examples/pdf-server/grid-cell.png b/examples/pdf-server/grid-cell.png index 5acd222..0e6e571 100644 Binary files a/examples/pdf-server/grid-cell.png and b/examples/pdf-server/grid-cell.png differ diff --git a/examples/pdf-server/main.ts b/examples/pdf-server/main.ts index 2ff4979..bb7b57f 100644 --- a/examples/pdf-server/main.ts +++ b/examples/pdf-server/main.ts @@ -6,10 +6,10 @@ import fs from "node:fs"; import path from "node:path"; -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; -import { createMcpExpressApp } from "@modelcontextprotocol/sdk/server/express.js"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { createMcpExpressApp } from "@modelcontextprotocol/express"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; +import type { McpServer } from "@modelcontextprotocol/server"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; import cors from "cors"; import type { Request, Response } from "express"; import { @@ -20,8 +20,10 @@ import { pathToFileUrl, fileUrlToPath, allowedLocalFiles, + cliLocalFiles, DEFAULT_PDF, allowedLocalDirs, + writeFlags, } from "./server.js"; /** @@ -37,7 +39,7 @@ export async function startStreamableHTTPServer( app.all("/mcp", async (req: Request, res: Response) => { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); @@ -93,17 +95,33 @@ function parseArgs(): { urls: string[]; stdio: boolean; useClientRoots: boolean; + enableInteract: boolean; + debug: boolean; } { const args = process.argv.slice(2); const urls: string[] = []; let stdio = false; let useClientRoots = false; + let enableInteract = false; + let debug = false; for (const arg of args) { if (arg === "--stdio") { stdio = true; } else if (arg === "--use-client-roots") { useClientRoots = true; + } else if (arg === "--enable-interact") { + // Force-enable interact for HTTP mode. Only use when running a + // single long-lived server process (e.g. the e2e test harness) β€” + // the command queue is in-memory per-process, so stateless + // multi-instance deployments will drop commands. + enableInteract = true; + } else if (arg === "--debug") { + debug = true; + } else if (arg === "--writeable-uploads-root") { + // Claude Desktop mounts attachments under a dir root named "uploads"; + // by default we refuse to write there. This flag opts back in. + writeFlags.allowUploadsRoot = true; } else if (!arg.startsWith("-")) { // Convert local paths to file:// URLs, normalize arxiv URLs let url = arg; @@ -124,11 +142,13 @@ function parseArgs(): { urls: urls.length > 0 ? urls : [DEFAULT_PDF], stdio, useClientRoots, + enableInteract, + debug, }; } async function main() { - const { urls, stdio, useClientRoots } = parseArgs(); + const { urls, stdio, useClientRoots, enableInteract, debug } = parseArgs(); // Register local files in whitelist for (const url of urls) { @@ -138,6 +158,7 @@ async function main() { const s = fs.statSync(filePath); if (s.isFile()) { allowedLocalFiles.add(filePath); + cliLocalFiles.add(filePath); console.error(`[pdf-server] Registered local file: ${filePath}`); } else if (s.isDirectory()) { allowedLocalDirs.add(filePath); @@ -153,10 +174,20 @@ async function main() { if (stdio) { // stdio β†’ client is local (e.g. Claude Desktop), roots are safe - await startStdioServer(() => createServer({ useClientRoots: true })); + await startStdioServer(() => + createServer({ enableInteract: true, useClientRoots: true, debug }), + ); } else { // HTTP β†’ client is remote, only honour roots with explicit opt-in - await startStreamableHTTPServer(() => createServer({ useClientRoots })); + if (!useClientRoots) { + console.error( + "[pdf-server] Client roots are ignored (default for remote transports). " + + "Pass --use-client-roots to allow the client to expose local directories.", + ); + } + await startStreamableHTTPServer(() => + createServer({ useClientRoots, enableInteract, debug }), + ); } } diff --git a/examples/pdf-server/manifest.json b/examples/pdf-server/manifest.json index 47c6bbc..f4b897e 100644 --- a/examples/pdf-server/manifest.json +++ b/examples/pdf-server/manifest.json @@ -1,7 +1,7 @@ { "manifest_version": "0.3", "name": "@modelcontextprotocol/server-pdf", - "display_name": "PDF (By Anthropic)", + "display_name": "pdf-viewer", "version": "1.0.1", "description": "Read and interact with PDF files using an interactive viewer with search, navigation, and text extraction", "author": { @@ -34,8 +34,8 @@ "description": "Display an interactive PDF viewer with search and navigation" }, { - "name": "read_pdf_bytes", - "description": "Read a range of bytes from a PDF file (max 512KB per request)" + "name": "interact", + "description": "Interact with a PDF viewer: annotate, navigate, search, extract text/screenshots, fill forms" } ], "keywords": ["pdf", "documents", "viewer", "reading"], diff --git a/examples/pdf-server/mcp-app.html b/examples/pdf-server/mcp-app.html index c18345d..cf1545a 100644 --- a/examples/pdf-server/mcp-app.html +++ b/examples/pdf-server/mcp-app.html @@ -19,6 +19,16 @@

An error occurred

+ + + @@ -107,12 +143,31 @@ - -
-
- -
-
+ +
+ +
+
+ +
+
+
+
+
+
+ + +
diff --git a/examples/pdf-server/package.json b/examples/pdf-server/package.json index 069b33b..c8d9cf8 100644 --- a/examples/pdf-server/package.json +++ b/examples/pdf-server/package.json @@ -1,11 +1,11 @@ { "name": "@modelcontextprotocol/server-pdf", - "version": "1.2.0", + "version": "2.0.0", "type": "module", "description": "MCP server for loading and extracting text from PDF files with chunked pagination and interactive viewer", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", "directory": "examples/pdf-server" }, "license": "MIT", @@ -14,22 +14,27 @@ "dist" ], "scripts": { - "build": "tsc --noEmit && cross-env INPUT=mcp-app.html vite build && tsc -p tsconfig.server.json && bun build server.ts --outdir dist --target node --external pdfjs-dist && bun build main.ts --outfile dist/index.js --target node --external \"./server.js\" --external pdfjs-dist --banner \"#!/usr/bin/env node\"", + "build": "tsc --noEmit && cross-env INPUT=mcp-app.html vite build && tsc -p tsconfig.server.json && bun build pdfjs-polyfill.ts --outdir dist --target node && bun build server.ts --outdir dist --target node --external pdfjs-dist --external \"./pdfjs-polyfill.js\" && bun build main.ts --outfile dist/index.js --target node --external \"./server.js\" --external pdfjs-dist --banner \"#!/usr/bin/env node\"", "watch": "cross-env INPUT=mcp-app.html vite build --watch", - "serve": "bun --watch main.ts", + "serve": "bun --watch main.ts --enable-interact", "serve:stdio": "bun main.ts --stdio", "start": "cross-env NODE_ENV=development npm run build && npm run serve", "start:stdio": "cross-env NODE_ENV=development npm run build 1>&2 && npm run serve:stdio", "dev": "cross-env NODE_ENV=development concurrently \"npm run watch\" \"npm run serve\"", - "prepublishOnly": "npm run build" + "prepublishOnly": "npm run build", + "build:mcpb": "npm run build && node build-mcpb.mjs" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@cantoo/pdf-lib": "^2.6.5", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", "pdfjs-dist": "^5.0.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "devDependencies": { "@types/cors": "^2.8.19", diff --git a/examples/pdf-server/pdfjs-polyfill.ts b/examples/pdf-server/pdfjs-polyfill.ts new file mode 100644 index 0000000..80e1705 --- /dev/null +++ b/examples/pdf-server/pdfjs-polyfill.ts @@ -0,0 +1,26 @@ +/** + * Stub polyfills for pdfjs-dist's legacy build under Node.js. + * + * pdfjs-dist/legacy/build/pdf.mjs eagerly does `new DOMMatrix()` at module + * scope. Its own polyfill loads `@napi-rs/canvas` (an optionalDependency), + * but `npx` / fresh installs frequently miss the platform-native binary + * (npm optional-deps bug, see https://github.com/npm/cli/issues/4828), + * so the import crashes before our server code runs. + * + * The server only uses pdfjs for text/metadata/form-field extraction β€” + * never canvas rendering β€” so no-op stubs are sufficient and avoid + * shipping ~130MB of native binaries we don't need. + * + * MUST be a separate ESM module imported before pdfjs-dist (and kept + * `--external` in the bun bundle) so it executes before pdfjs's + * module-level initializer. Inlined body code would run too late + * because static imports are hoisted. + */ + +/* eslint-disable @typescript-eslint/no-explicit-any */ +const g = globalThis as any; + +// Only stub if missing β€” let a real @napi-rs/canvas (or jsdom) win. +g.DOMMatrix ??= class DOMMatrix {}; +g.ImageData ??= class ImageData {}; +g.Path2D ??= class Path2D {}; diff --git a/examples/pdf-server/plugin/.claude-plugin/plugin.json b/examples/pdf-server/plugin/.claude-plugin/plugin.json deleted file mode 100644 index f7442e7..0000000 --- a/examples/pdf-server/plugin/.claude-plugin/plugin.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "name": "pdf-research", - "version": "0.1.0", - "description": "Read, navigate, and analyze PDF documents β€” academic papers, reports, and local files. Uses a local PDF MCP server for interactive viewing and text extraction.", - "author": { - "name": "Anthropic" - } -} diff --git a/examples/pdf-server/plugin/.mcp.json b/examples/pdf-server/plugin/.mcp.json deleted file mode 100644 index f81cdb2..0000000 --- a/examples/pdf-server/plugin/.mcp.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "mcpServers": { - "pdf": { - "command": "npx", - "args": ["@modelcontextprotocol/server-pdf", "--stdio"] - } - } -} diff --git a/examples/pdf-server/plugin/CONNECTORS.md b/examples/pdf-server/plugin/CONNECTORS.md deleted file mode 100644 index 39def09..0000000 --- a/examples/pdf-server/plugin/CONNECTORS.md +++ /dev/null @@ -1,16 +0,0 @@ -# Connectors - -## Local MCP Server - -This plugin uses a **local MCP server** instead of a remote connector. -The PDF server runs on your machine via `npx`. - -| Category | Server | How it runs | -| ---------- | ---------------------------------- | -------------------------------------- | -| PDF viewer | `@modelcontextprotocol/server-pdf` | Local stdio via `npx` (auto-installed) | - -### Requirements - -- Node.js >= 18 -- Internet access for remote PDFs (arXiv, bioRxiv, etc.) -- No API keys or authentication needed diff --git a/examples/pdf-server/plugin/README.md b/examples/pdf-server/plugin/README.md deleted file mode 100644 index 32a80ab..0000000 --- a/examples/pdf-server/plugin/README.md +++ /dev/null @@ -1,40 +0,0 @@ -# PDF Research Plugin - -Read and analyze PDF documents using a local MCP server. Designed for -academic paper review, document analysis, and research workflows. - -## What It Does - -- **Open PDFs** from local files, arXiv, bioRxiv, and other academic sources -- **Interactive viewer** with search, navigation, and zoom -- **AI-powered analysis** -- summarize, extract key points, compare papers - -## Commands - -| Command | What it does | -| ------------------------- | ---------------------- | -| `/pdf-research:read` | Open a PDF for reading | -| `/pdf-research:summarize` | Summarize a document | - -## How It Works - -This plugin uses a **local MCP server** (`@modelcontextprotocol/server-pdf`) -that runs on your machine via `npx`. No API keys or remote services needed -- -the PDF server starts automatically when the plugin loads. - -This is different from other knowledge-work plugins which use remote HTTP -connectors. The local server pattern enables offline PDF access and avoids -the need for a remote deployment. - -## Requirements - -- Node.js >= 18 -- Internet for remote PDFs (arXiv, etc.) - -## Supported PDF Sources - -- Local files (file paths in your working directory) -- [arXiv](https://arxiv.org) papers -- [bioRxiv](https://biorxiv.org) / [medRxiv](https://medrxiv.org) preprints -- [chemRxiv](https://chemrxiv.org), [Zenodo](https://zenodo.org), [OSF](https://osf.io) -- [HAL Science](https://hal.science), [SSRN](https://ssrn.com) diff --git a/examples/pdf-server/plugin/commands/read.md b/examples/pdf-server/plugin/commands/read.md deleted file mode 100644 index 39817bc..0000000 --- a/examples/pdf-server/plugin/commands/read.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -description: Open a PDF for reading and analysis ---- - -# Read PDF - -Open a PDF document for interactive reading. Accepts local file paths, -arXiv URLs, or other academic paper URLs. - -## Instructions - -1. If the user provides a URL or file path, call `display_pdf` with that URL -2. If no URL given, call `list_pdfs` first to show available documents -3. After displaying, offer to summarize, extract key points, or answer questions - -## Supported Sources - -- Local files (drag-and-drop or file path) -- arXiv papers (arxiv.org/abs/... or arxiv.org/pdf/...) -- bioRxiv, medRxiv, chemRxiv preprints -- Zenodo, OSF, HAL, SSRN diff --git a/examples/pdf-server/plugin/commands/summarize.md b/examples/pdf-server/plugin/commands/summarize.md deleted file mode 100644 index 62ee4ba..0000000 --- a/examples/pdf-server/plugin/commands/summarize.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -description: Summarize the current PDF or a new document ---- - -# Summarize PDF - -Generate a structured summary of a PDF document. - -## Instructions - -1. If a PDF is already displayed, work with it -2. If user provides a new URL/path, call `display_pdf` first -3. Read through the document and produce: - - **Title and authors** (if academic paper) - - **Key findings** (3-5 bullet points) - - **Methodology** (brief summary) - - **Conclusions** - - **Relevance** β€” what makes this paper notable - -## Notes - -- For long documents, focus on abstract, introduction, and conclusion sections -- Ask the user which sections they care most about if the doc is very long diff --git a/examples/pdf-server/plugin/skills/pdf-reading/SKILL.md b/examples/pdf-server/plugin/skills/pdf-reading/SKILL.md deleted file mode 100644 index 2e79917..0000000 --- a/examples/pdf-server/plugin/skills/pdf-reading/SKILL.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: pdf-reading -description: Read and navigate PDF documents using the local PDF server. Reference this when the user wants to open, read, search, or interact with any PDF file or academic paper. ---- - -# PDF Reading - -You have access to a local PDF server that provides interactive document viewing. - -## Available Tools - -- **list_pdfs** -- Show available PDFs. Call with no arguments. -- **display_pdf** -- Open a PDF in the interactive viewer. - - `url` (string): URL or local file path - - `page` (number, optional): Starting page number - -## How to Use - -**When the user mentions a PDF, paper, or document:** -1. If they give a URL or path, call `display_pdf` directly -2. If they say "open the paper" without specifying, call `list_pdfs` to show options -3. After displaying, offer to summarize, extract data, answer questions - -**arXiv shortcuts:** -- `arxiv.org/abs/2301.12345` is auto-converted to the PDF URL -- Users can just say "open arxiv 2301.12345" - -**Supported remote sources:** -arXiv, bioRxiv, medRxiv, chemRxiv, Zenodo, OSF, HAL Science, SSRN - -## Best Practices - -- Always display the PDF before trying to analyze it -- For multi-page documents, ask which section the user cares about -- When comparing papers, display them one at a time and note key differences diff --git a/examples/pdf-server/screenshot.png b/examples/pdf-server/screenshot.png index bdb8f17..fd87f8f 100644 Binary files a/examples/pdf-server/screenshot.png and b/examples/pdf-server/screenshot.png differ diff --git a/examples/pdf-server/server.test.ts b/examples/pdf-server/server.test.ts index 4ea1ecf..0b2a5eb 100644 --- a/examples/pdf-server/server.test.ts +++ b/examples/pdf-server/server.test.ts @@ -1,13 +1,28 @@ import { describe, it, expect, beforeEach, afterEach, spyOn } from "bun:test"; +import fs from "node:fs"; +import os from "node:os"; import path from "node:path"; +import { Client, InMemoryTransport } from "@modelcontextprotocol/client"; +import { getDocument } from "pdfjs-dist/legacy/build/pdf.mjs"; +import { PDFDocument } from "@cantoo/pdf-lib"; +import { makeRandomJpeg } from "../../tests/helpers/range-counting-server"; import { createPdfCache, createServer, + extractFormSchema, + PdfCacheRangeTransport, + MAX_CHUNK_BYTES, validateUrl, isAncestorDir, allowedLocalFiles, allowedLocalDirs, pathToFileUrl, + startFileWatch, + stopFileWatch, + cliLocalFiles, + isWritablePath, + writeFlags, + viewSourcePaths, CACHE_INACTIVITY_TIMEOUT_MS, CACHE_MAX_LIFETIME_MS, CACHE_MAX_PDF_SIZE_BYTES, @@ -61,6 +76,72 @@ describe("PDF Cache with Timeouts", () => { }); }); + describe("byte-cap LRU eviction", () => { + const tenBytes = new Uint8Array(10); + + async function fill(cache: PdfCache, url: string): Promise { + const m = spyOn(globalThis, "fetch").mockResolvedValueOnce( + new Response(tenBytes, { status: 200 }), + ); + try { + await cache.readPdfRange(url, 0, 1024); + } finally { + m.mockRestore(); + } + } + + it("evicts least-recently-used entry when total exceeds cap", async () => { + const cache = createPdfCache(25); + try { + await fill(cache, "https://arxiv.org/pdf/a"); + await fill(cache, "https://arxiv.org/pdf/b"); + expect(cache.getCacheSize()).toBe(2); + + // Touch A so B becomes least-recently-used + await cache.readPdfRange("https://arxiv.org/pdf/a", 0, 1); + + // Inserting C (10B) pushes total to 30 > 25 β†’ evict LRU (B) + await fill(cache, "https://arxiv.org/pdf/c"); + expect(cache.getCacheSize()).toBe(2); + + // A and C still served from cache; B re-fetches + const m = spyOn(globalThis, "fetch").mockResolvedValue( + new Response(tenBytes, { status: 200 }), + ); + try { + await cache.readPdfRange("https://arxiv.org/pdf/a", 0, 1); + await cache.readPdfRange("https://arxiv.org/pdf/c", 0, 1); + expect(m).toHaveBeenCalledTimes(0); + await cache.readPdfRange("https://arxiv.org/pdf/b", 0, 1); + expect(m).toHaveBeenCalledTimes(1); + } finally { + m.mockRestore(); + } + } finally { + cache.clearCache(); + } + }); + + it("evicts multiple entries if a single insert exceeds the cap", async () => { + const cache = createPdfCache(25); + try { + await fill(cache, "https://arxiv.org/pdf/a"); + await fill(cache, "https://arxiv.org/pdf/b"); + const big = spyOn(globalThis, "fetch").mockResolvedValueOnce( + new Response(new Uint8Array(20), { status: 200 }), + ); + try { + await cache.readPdfRange("https://arxiv.org/pdf/big", 0, 1024); + } finally { + big.mockRestore(); + } + expect(cache.getCacheSize()).toBe(1); + } finally { + cache.clearCache(); + } + }); + }); + describe("readPdfRange caching behavior", () => { const testUrl = "https://arxiv.org/pdf/test-pdf"; const testData = new Uint8Array([0x25, 0x50, 0x44, 0x46]); // %PDF header @@ -213,6 +294,266 @@ describe("PDF Cache with Timeouts", () => { // through manual testing or E2E tests. }); +describe("PdfCacheRangeTransport", () => { + it("accumulates ranges larger than MAX_CHUNK_BYTES into one onDataRange call", async () => { + const big = MAX_CHUNK_BYTES * 2 + 100; + const reads: Array<[number, number]> = []; + const t = new PdfCacheRangeTransport("u", big, async (_u, off, n) => { + reads.push([off, n]); + return { + data: new Uint8Array(Math.min(n, MAX_CHUNK_BYTES)), + totalBytes: big, + }; + }); + const delivered: Array<[number, number]> = []; + t.addRangeListener((begin: number, chunk: Uint8Array) => + delivered.push([begin, chunk.length]), + ); + t.requestDataRange(0, big); + await new Promise((r) => setTimeout(r, 10)); + // pdf.js's reader is keyed by the original begin and removed after one + // delivery, so deliver() must call onDataRange exactly once with the + // accumulated buffer β€” multiple calls would throw inside pdfjs. + expect(delivered).toEqual([[0, big]]); + expect(reads).toEqual([ + [0, MAX_CHUNK_BYTES], + [MAX_CHUNK_BYTES, MAX_CHUNK_BYTES], + [MAX_CHUNK_BYTES * 2, 100], + ]); + }); + + it("rejects .failed when a range fetch errors instead of hanging", async () => { + const t = new PdfCacheRangeTransport("u", 1000, async () => { + throw new Error("network down"); + }); + t.requestDataRange(0, 100); + await expect( + Promise.race([ + t.failed, + new Promise((r) => setTimeout(() => r("timeout"), 200)), + ]), + ).rejects.toThrow("network down"); + }); + + it("rejects .failed on zero-length response (would otherwise spin)", async () => { + const t = new PdfCacheRangeTransport("u", 1000, async () => ({ + data: new Uint8Array(0), + totalBytes: 1000, + })); + t.requestDataRange(0, 100); + await expect(t.failed).rejects.toThrow(/empty range/); + }); + + it("getDocument resolves on a >1MB PDF when readPdfRange clamps to MAX_CHUNK_BYTES", async () => { + // pdfjs coalesces adjacent missing chunks into one requestDataRange that + // can exceed MAX_CHUNK_BYTES. deliver() must accumulate clamped reads and + // hand pdfjs a single onDataRange(begin, fullBuffer). This test fails if + // deliver() either truncates or calls onDataRange more than once per + // requestDataRange (pdf.mjs _onReceiveData matches by exact begin). + const d = await PDFDocument.create(); + const img = await d.embedJpg(makeRandomJpeg(1_100_000)); + const page = d.addPage([612, 792]); + page.drawImage(img, { x: 36, y: 36, width: 540, height: 720 }); + const bytes = await d.save(); + expect(bytes.length).toBeGreaterThan(2 * MAX_CHUNK_BYTES); + + const readClamped: PdfCache["readPdfRange"] = async (_u, off, n) => { + const len = Math.min(n, MAX_CHUNK_BYTES, bytes.length - off); + return { data: bytes.slice(off, off + len), totalBytes: bytes.length }; + }; + // Record the spans pdfjs actually requests so the test fails fast if it + // never asks for >MAX_CHUNK_BYTES (i.e. can't go vacuously green). + const spans: number[] = []; + class RecordingTransport extends PdfCacheRangeTransport { + override requestDataRange(begin: number, end: number): void { + spans.push(end - begin); + super.requestDataRange(begin, end); + } + } + const transport = new RecordingTransport( + "mem://big", + bytes.length, + readClamped, + ); + + const orHang = (p: Promise, what: string): Promise => + Promise.race([ + p, + transport.failed, + new Promise((_, rej) => + setTimeout(() => rej(new Error(`${what} hung`)), 5000), + ), + ]); + + const doc = await orHang( + getDocument({ + range: transport, + length: bytes.length, + disableAutoFetch: true, + disableStream: true, + rangeChunkSize: 64 * 1024, + }).promise, + "getDocument", + ); + const p1 = await orHang(doc.getPage(1), "getPage"); + // getPage() alone doesn't decode the image XObject; getOperatorList() does, + // which is what triggers the >512KB coalesced range request. + await orHang(p1.getOperatorList(), "getOperatorList"); + expect(Math.max(...spans)).toBeGreaterThan(MAX_CHUNK_BYTES); + doc.destroy(); + }); +}); + +describe("display_pdf transport-error handling", () => { + it("returns (does not hang) when range fetches fail mid-load", async () => { + // First fetch = the 1-byte size probe β†’ 206 with Content-Range so + // display_pdf gets totalBytes. Every subsequent fetch (made by + // PdfCacheRangeTransport via readPdfRange) rejects, which must surface + // through transport.failed β†’ orFail() β†’ outer catch, not hang. + let calls = 0; + const mockFetch = spyOn(globalThis, "fetch").mockImplementation( + async () => { + if (calls++ === 0) { + return new Response(new Uint8Array(1), { + status: 206, + headers: { "Content-Range": "bytes 0-0/50000" }, + }); + } + throw new Error("network down"); + }, + ); + + const server = createServer(); + const client = new Client({ name: "t", version: "1" }); + const [ct, st] = InMemoryTransport.createLinkedPair(); + await Promise.all([server.connect(st), client.connect(ct)]); + + try { + const result = await Promise.race([ + client.callTool({ + name: "display_pdf", + arguments: { url: "https://arxiv.org/pdf/err-test" }, + }), + new Promise((_, rej) => + setTimeout( + () => rej(new Error("display_pdf hung on transport error")), + 3000, + ), + ), + ]); + expect(result.isError).toBeFalsy(); + const sc = result.structuredContent as { formFields?: unknown }; + expect(sc.formFields).toBeUndefined(); + expect(calls).toBeGreaterThan(1); + } finally { + mockFetch.mockRestore(); + await client.close(); + await server.close(); + } + }); +}); + +describe("extractFormSchema field-tree handling", () => { + async function schemaFor(bytes: Uint8Array) { + const doc = await getDocument({ data: bytes }).promise; + try { + const fo = (await doc.getFieldObjects()) as Parameters< + typeof extractFormSchema + >[1]; + return await extractFormSchema(doc, fo); + } finally { + doc.destroy(); + } + } + + it("handles pdf-lib separated field/widget structure", async () => { + const d = await PDFDocument.create(); + const form = d.getForm(); + d.addPage([612, 792]); + form + .createTextField("alpha") + .addToPage(d.getPage(0), { x: 50, y: 700, width: 200, height: 20 }); + form + .createCheckBox("agree") + .addToPage(d.getPage(0), { x: 50, y: 660, width: 20, height: 20 }); + form + .createDropdown("choice") + .addToPage(d.getPage(0), { x: 50, y: 620, width: 100, height: 20 }); + + const schema = await schemaFor(await d.save()); + expect(schema).not.toBeNull(); + expect(schema!.properties.alpha).toEqual({ + type: "string", + title: "alpha", + }); + expect(schema!.properties.agree).toEqual({ + type: "boolean", + title: "agree", + }); + expect(schema!.properties.choice.type).toBe("string"); + }); + + it("handles fields with multiple widgets across pages", async () => { + const d = await PDFDocument.create(); + const form = d.getForm(); + d.addPage([612, 792]); + d.addPage([612, 792]); + const tf = form.createTextField("shared"); + tf.addToPage(d.getPage(0), { x: 50, y: 700, width: 200, height: 20 }); + tf.addToPage(d.getPage(1), { x: 50, y: 700, width: 200, height: 20 }); + + const schema = await schemaFor(await d.save()); + expect(schema?.properties.shared).toEqual({ + type: "string", + title: "shared", + }); + }); + + it("skips container nodes and finds leaf fields (W-9 style)", async () => { + const bytes = fs.readFileSync( + path.join(__dirname, "../../tests/helpers/assets/fw9.pdf"), + ); + const doc = await getDocument({ data: new Uint8Array(bytes) }).promise; + try { + const fo = (await doc.getFieldObjects()) as Parameters< + typeof extractFormSchema + >[1]; + // Container nodes (no leaf type) should not crash extraction + expect(fo!["topmostSubform[0]"]).toBeDefined(); + // Schema is null for W-9 (mechanical names), but extraction must not throw + const schema = await extractFormSchema(doc, fo); + expect(schema).toBeNull(); + } finally { + doc.destroy(); + } + }); + + it("returns null when no AcroForm present", async () => { + const d = await PDFDocument.create(); + d.addPage([612, 792]); + const schema = await schemaFor(await d.save()); + expect(schema).toBeNull(); + }); +}); + +describe("validateUrl loopback HTTP allow (PDF_SERVER_ALLOW_LOOPBACK_HTTP)", () => { + it("rejects http://127.0.0.1 by default", () => { + expect(validateUrl("http://127.0.0.1:9999/x.pdf").valid).toBe(false); + }); + + it("accepts http://127.0.0.1 only when the env gate is set, and never non-loopback http", () => { + const prev = process.env.PDF_SERVER_ALLOW_LOOPBACK_HTTP; + process.env.PDF_SERVER_ALLOW_LOOPBACK_HTTP = "1"; + try { + expect(validateUrl("http://127.0.0.1:9999/x.pdf").valid).toBe(true); + expect(validateUrl("http://169.254.169.254/").valid).toBe(false); + } finally { + if (prev === undefined) delete process.env.PDF_SERVER_ALLOW_LOOPBACK_HTTP; + else process.env.PDF_SERVER_ALLOW_LOOPBACK_HTTP = prev; + } + }); +}); + describe("validateUrl with MCP roots (allowedLocalDirs)", () => { const savedFiles = new Set(allowedLocalFiles); const savedDirs = new Set(allowedLocalDirs); @@ -446,3 +787,1031 @@ describe("createServer useClientRoots option", () => { server.close(); }); }); + +describe("isWritablePath", () => { + let savedFiles: Set; + let savedDirs: Set; + let savedCli: Set; + let savedAllowUploadsRoot: boolean; + + beforeEach(() => { + savedFiles = new Set(allowedLocalFiles); + savedDirs = new Set(allowedLocalDirs); + savedCli = new Set(cliLocalFiles); + allowedLocalFiles.clear(); + allowedLocalDirs.clear(); + cliLocalFiles.clear(); + savedAllowUploadsRoot = writeFlags.allowUploadsRoot; + writeFlags.allowUploadsRoot = false; + }); + + afterEach(() => { + allowedLocalFiles.clear(); + allowedLocalDirs.clear(); + cliLocalFiles.clear(); + for (const x of savedFiles) allowedLocalFiles.add(x); + for (const x of savedDirs) allowedLocalDirs.add(x); + for (const x of savedCli) cliLocalFiles.add(x); + writeFlags.allowUploadsRoot = savedAllowUploadsRoot; + }); + + it("nothing is writable when no roots and no CLI files", () => { + expect(isWritablePath("/any/path/file.pdf")).toBe(false); + }); + + it("CLI file is writable", () => { + allowedLocalFiles.add("/tmp/explicit.pdf"); + cliLocalFiles.add("/tmp/explicit.pdf"); + expect(isWritablePath("/tmp/explicit.pdf")).toBe(true); + }); + + it("MCP file root is NOT writable", () => { + allowedLocalFiles.add("/tmp/uploaded.pdf"); // from refreshRoots, no CLI + expect(isWritablePath("/tmp/uploaded.pdf")).toBe(false); + }); + + it("file under a directory root at any depth is writable", () => { + allowedLocalDirs.add("/home/user/docs"); + expect(isWritablePath("/home/user/docs/file.pdf")).toBe(true); + expect(isWritablePath("/home/user/docs/sub/deep/file.pdf")).toBe(true); + }); + + it("the directory root itself is NOT writable", () => { + allowedLocalDirs.add("/home/user/docs"); + expect(isWritablePath("/home/user/docs")).toBe(false); + }); + + it("MCP file root stays read-only even when under a directory root", () => { + // Client sent BOTH the directory and a file inside it as roots. + // The explicit file-root is the stronger signal: treat as upload. + allowedLocalDirs.add("/home/user/docs"); + allowedLocalFiles.add("/home/user/docs/uploaded.pdf"); + expect(isWritablePath("/home/user/docs/uploaded.pdf")).toBe(false); + // Siblings not sent as file roots remain writable + expect(isWritablePath("/home/user/docs/other.pdf")).toBe(true); + }); + + it("CLI file wins even if also in allowedLocalFiles", () => { + // CLI file added to both sets (main.ts does this) + allowedLocalFiles.add("/tmp/cli.pdf"); + cliLocalFiles.add("/tmp/cli.pdf"); + expect(isWritablePath("/tmp/cli.pdf")).toBe(true); + }); + + it("file outside any directory root is not writable", () => { + allowedLocalDirs.add("/home/user/docs"); + expect(isWritablePath("/home/user/other/file.pdf")).toBe(false); + expect(isWritablePath("/home/user/docsevil/file.pdf")).toBe(false); + }); + + it("dir root named 'uploads' is read-only by default", () => { + // Claude Desktop mounts the conversation's attachment drop folder as a + // directory root literally named 'uploads'. The attached PDF lives + // directly under it. + allowedLocalDirs.add("/var/folders/xy/T/claude/uploads"); + expect(isWritablePath("/var/folders/xy/T/claude/uploads/Form.pdf")).toBe( + false, + ); + // Deep nesting under the uploads root β€” still the same root, still no. + expect( + isWritablePath("/var/folders/xy/T/claude/uploads/sub/deep.pdf"), + ).toBe(false); + }); + + it("uploads-root guard matches basename, not substring", () => { + allowedLocalDirs.add("/home/user/my-uploads"); // contains 'uploads' but β‰  + allowedLocalDirs.add("/home/user/uploads-archive"); + expect(isWritablePath("/home/user/my-uploads/f.pdf")).toBe(true); + expect(isWritablePath("/home/user/uploads-archive/f.pdf")).toBe(true); + }); + + it("--writeable-uploads-root opts back in", () => { + allowedLocalDirs.add("/var/folders/xy/T/claude/uploads"); + writeFlags.allowUploadsRoot = true; + expect(isWritablePath("/var/folders/xy/T/claude/uploads/Form.pdf")).toBe( + true, + ); + }); + + it("CLI file under an uploads root is still writable", () => { + // Explicit CLI intent beats the uploads-basename heuristic. + allowedLocalDirs.add("/tmp/uploads"); + allowedLocalFiles.add("/tmp/uploads/explicit.pdf"); + cliLocalFiles.add("/tmp/uploads/explicit.pdf"); + expect(isWritablePath("/tmp/uploads/explicit.pdf")).toBe(true); + }); +}); + +describe("file watching", () => { + let tmpDir: string; + let tmpFile: string; + const uuid = "test-watch-uuid"; + + // Long-poll timeout is 30s β€” tests that poll must complete sooner. + const pollWithTimeout = async ( + client: Client, + timeoutMs = 5000, + ): Promise<{ type: string; mtimeMs?: number }[]> => { + const result = await Promise.race([ + client.callTool({ + name: "poll_pdf_commands", + arguments: { viewUUID: uuid }, + }), + new Promise((_, reject) => + setTimeout(() => reject(new Error("poll timeout")), timeoutMs), + ), + ]); + return ( + ((result as { structuredContent?: { commands?: unknown[] } }) + .structuredContent?.commands as { type: string; mtimeMs?: number }[]) ?? + [] + ); + }; + + beforeEach(() => { + tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "pdf-watch-")); + tmpFile = path.join(tmpDir, "test.pdf"); + fs.writeFileSync(tmpFile, Buffer.from("%PDF-1.4\n%test\n")); + allowedLocalFiles.add(tmpFile); + cliLocalFiles.add(tmpFile); // save_pdf test needs write scope + }); + + afterEach(() => { + stopFileWatch(uuid); + allowedLocalFiles.delete(tmpFile); + cliLocalFiles.delete(tmpFile); + fs.rmSync(tmpDir, { recursive: true, force: true }); + }); + + it("enqueues file_changed after external write", async () => { + const server = createServer({ enableInteract: true }); + const client = new Client({ name: "t", version: "1" }); + const [ct, st] = InMemoryTransport.createLinkedPair(); + await Promise.all([server.connect(st), client.connect(ct)]); + + startFileWatch(uuid, tmpFile); + await new Promise((r) => setTimeout(r, 50)); // let watcher settle + + fs.writeFileSync(tmpFile, Buffer.from("%PDF-1.4\n%changed\n")); + + const cmds = await pollWithTimeout(client); + expect(cmds).toHaveLength(1); + expect(cmds[0].type).toBe("file_changed"); + expect(cmds[0].mtimeMs).toBeGreaterThan(0); + + await client.close(); + await server.close(); + }); + + it("debounces rapid writes into one command", async () => { + const server = createServer({ enableInteract: true }); + const client = new Client({ name: "t", version: "1" }); + const [ct, st] = InMemoryTransport.createLinkedPair(); + await Promise.all([server.connect(st), client.connect(ct)]); + + startFileWatch(uuid, tmpFile); + await new Promise((r) => setTimeout(r, 50)); + + fs.writeFileSync(tmpFile, Buffer.from("%PDF-1.4\n%a\n")); + fs.writeFileSync(tmpFile, Buffer.from("%PDF-1.4\n%b\n")); + fs.writeFileSync(tmpFile, Buffer.from("%PDF-1.4\n%c\n")); + + const cmds = await pollWithTimeout(client); + expect(cmds).toHaveLength(1); + + await client.close(); + await server.close(); + }); + + it("stopFileWatch prevents further commands", async () => { + const server = createServer({ enableInteract: true }); + const client = new Client({ name: "t", version: "1" }); + const [ct, st] = InMemoryTransport.createLinkedPair(); + await Promise.all([server.connect(st), client.connect(ct)]); + + startFileWatch(uuid, tmpFile); + await new Promise((r) => setTimeout(r, 50)); + stopFileWatch(uuid); + + fs.writeFileSync(tmpFile, Buffer.from("%PDF-1.4\n%x\n")); + + // Debounce window + margin β€” no event should fire + await new Promise((r) => setTimeout(r, 300)); + + // Poll should block (long-poll) β†’ timeout here means no command was queued + await expect(pollWithTimeout(client, 500)).rejects.toThrow("poll timeout"); + + await client.close(); + await server.close(); + }); + + it("save_pdf returns mtimeMs in structuredContent", async () => { + const server = createServer({ enableInteract: true }); + const client = new Client({ name: "t", version: "1" }); + const [ct, st] = InMemoryTransport.createLinkedPair(); + await Promise.all([server.connect(st), client.connect(ct)]); + + const before = fs.statSync(tmpFile).mtimeMs; + // Ensure mtime will differ on coarse-granularity filesystems + await new Promise((r) => setTimeout(r, 10)); + + const r = await client.callTool({ + name: "save_pdf", + arguments: { + url: tmpFile, + data: Buffer.from("%PDF-1.4\nnew").toString("base64"), + }, + }); + expect(r.isError).toBeFalsy(); + const sc = r.structuredContent as { filePath: string; mtimeMs: number }; + expect(sc.filePath).toBe(tmpFile); + expect(sc.mtimeMs).toBeGreaterThanOrEqual(before); + + await client.close(); + await server.close(); + }); + + it("save_pdf refuses file roots from MCP client (not CLI)", async () => { + // Simulate: file is readable (in allowedLocalFiles via refreshRoots) + // but NOT in cliLocalFiles β€” it came from the client, not a CLI arg. + cliLocalFiles.delete(tmpFile); + + const server = createServer({ enableInteract: true }); + const client = new Client({ name: "t", version: "1" }); + const [ct, st] = InMemoryTransport.createLinkedPair(); + await Promise.all([server.connect(st), client.connect(ct)]); + + const original = fs.readFileSync(tmpFile); + const r = await client.callTool({ + name: "save_pdf", + arguments: { + url: tmpFile, + data: Buffer.from("%PDF-1.4\nshould-not-write").toString("base64"), + }, + }); + expect(r.isError).toBe(true); + const text = (r.content as { text: string }[])[0].text; + expect(text).toContain("read-only"); + // Verify the file was NOT modified + expect(fs.readFileSync(tmpFile)).toEqual(original); + + await client.close(); + await server.close(); + }); + + it("save_pdf allows files under a directory root", async () => { + // File is under a mounted directory root β€” but NOT itself a file root + // (a file root, even under a mounted dir, is read-only per isWritablePath). + cliLocalFiles.delete(tmpFile); + allowedLocalFiles.delete(tmpFile); + allowedLocalDirs.add(tmpDir); + + const server = createServer({ enableInteract: true }); + const client = new Client({ name: "t", version: "1" }); + const [ct, st] = InMemoryTransport.createLinkedPair(); + await Promise.all([server.connect(st), client.connect(ct)]); + + const r = await client.callTool({ + name: "save_pdf", + arguments: { + url: tmpFile, + data: Buffer.from("%PDF-1.4\nvia-dir-root").toString("base64"), + }, + }); + expect(r.isError).toBeFalsy(); + expect(fs.readFileSync(tmpFile, "utf8")).toBe("%PDF-1.4\nvia-dir-root"); + + allowedLocalDirs.delete(tmpDir); + await client.close(); + await server.close(); + }); + + // fs.watch on a file that gets replaced via rename: on macOS (kqueue) + // the watcher reliably fires a "rename" event which our re-attach logic + // handles. On Linux (inotify), a watcher on the old inode often gets no + // event at all β€” inotify watches inodes, and the rename just atomically + // swaps the directory entry to a NEW inode. Directory-level watching + // would fix this but isn't what we do. Skip on non-darwin. + it.skipIf(process.platform !== "darwin")( + "detects atomic rename (macOS kqueue only)", + async () => { + const server = createServer({ enableInteract: true }); + const client = new Client({ name: "t", version: "1" }); + const [ct, st] = InMemoryTransport.createLinkedPair(); + await Promise.all([server.connect(st), client.connect(ct)]); + + startFileWatch(uuid, tmpFile); + await new Promise((r) => setTimeout(r, 50)); + + // Simulate vim/vscode: write to temp, rename over original + const tmpWrite = tmpFile + ".swp"; + fs.writeFileSync(tmpWrite, Buffer.from("%PDF-1.4\n%atomic\n")); + fs.renameSync(tmpWrite, tmpFile); + + const cmds = await pollWithTimeout(client); + expect(cmds).toHaveLength(1); + expect(cmds[0].type).toBe("file_changed"); + + await client.close(); + await server.close(); + }, + ); +}); + +describe("interact tool", () => { + // Helper: connected server+client pair with interact enabled. + // Command queues are MODULE-LEVEL (shared across server instances), so each + // test uses a distinct viewUUID to avoid cross-test interference. + async function connect() { + const server = createServer({ enableInteract: true }); + const client = new Client({ name: "t", version: "1" }); + const [ct, st] = InMemoryTransport.createLinkedPair(); + await Promise.all([server.connect(st), client.connect(ct)]); + return { server, client }; + } + + // Helper: poll with an outer deadline so a failing test doesn't hang for the + // full 30s long-poll. Safe ONLY when a command is already enqueued β€” poll + // then returns after the 200ms batch window. + async function poll(client: Client, uuid: string, timeoutMs = 2000) { + const result = await Promise.race([ + client.callTool({ + name: "poll_pdf_commands", + arguments: { viewUUID: uuid }, + }), + new Promise((_, reject) => + setTimeout(() => reject(new Error("poll timeout")), timeoutMs), + ), + ]); + return ((result as { structuredContent?: { commands?: unknown[] } }) + .structuredContent?.commands ?? []) as Array>; + } + + function firstText(r: Awaited>): string { + return (r.content as Array<{ type: string; text: string }>)[0].text; + } + + it("enqueue β†’ poll roundtrip delivers the command", async () => { + const { server, client } = await connect(); + const uuid = "test-interact-roundtrip"; + + const r = await client.callTool({ + name: "interact", + arguments: { viewUUID: uuid, action: "navigate", page: 5 }, + }); + expect(r.isError).toBeFalsy(); + expect(firstText(r)).toContain("Queued"); + expect(firstText(r)).toContain("page 5"); + + // Core mechanism: the viewer polls for what the model enqueued. + const cmds = await poll(client, uuid); + expect(cmds).toHaveLength(1); + expect(cmds[0].type).toBe("navigate"); + expect(cmds[0].page).toBe(5); + + await client.close(); + await server.close(); + }); + + it("navigate without `page` returns isError with a helpful message", async () => { + const { server, client } = await connect(); + + const r = await client.callTool({ + name: "interact", + arguments: { viewUUID: "test-err-nav", action: "navigate" }, + }); + expect(r.isError).toBe(true); + expect(firstText(r)).toContain("navigate"); + expect(firstText(r)).toContain("page"); + + await client.close(); + await server.close(); + }); + + it("fill_form without `fields` returns isError with a helpful message", async () => { + const { server, client } = await connect(); + + const r = await client.callTool({ + name: "interact", + arguments: { viewUUID: "test-err-fill", action: "fill_form" }, + }); + expect(r.isError).toBe(true); + expect(firstText(r)).toContain("fill_form"); + expect(firstText(r)).toContain("fields"); + + await client.close(); + await server.close(); + }); + + it("add_annotations without `annotations` returns isError with a helpful message", async () => { + const { server, client } = await connect(); + + const r = await client.callTool({ + name: "interact", + arguments: { viewUUID: "test-err-ann", action: "add_annotations" }, + }); + expect(r.isError).toBe(true); + expect(firstText(r)).toContain("add_annotations"); + expect(firstText(r)).toContain("annotations"); + + await client.close(); + await server.close(); + }); + + it("isolates command queues across distinct viewUUIDs", async () => { + const { server, client } = await connect(); + const uuidA = "test-isolate-A"; + const uuidB = "test-isolate-B"; + + await client.callTool({ + name: "interact", + arguments: { viewUUID: uuidA, action: "navigate", page: 3 }, + }); + await client.callTool({ + name: "interact", + arguments: { viewUUID: uuidB, action: "search", query: "quantum" }, + }); + + const cmdsA = await poll(client, uuidA); + expect(cmdsA).toHaveLength(1); + expect(cmdsA[0].type).toBe("navigate"); + expect(cmdsA[0].page).toBe(3); + + const cmdsB = await poll(client, uuidB); + expect(cmdsB).toHaveLength(1); + expect(cmdsB[0].type).toBe("search"); + expect(cmdsB[0].query).toBe("quantum"); + + await client.close(); + await server.close(); + }); + + // SKIPPED: the unknown-UUID path enters the long-poll branch and blocks for + // the full LONG_POLL_TIMEOUT_MS (30s, module-local const, not configurable). + // The handler does dequeue [] at the end, so the return value IS + // {commands: []} β€” but there's no fast path to reach it without waiting. + // See the `stopFileWatch prevents further commands` test above for indirect + // coverage of the same blocking behaviour. + it.skip("poll with unknown viewUUID returns {commands: []} after long-poll", () => {}); + + it("fill_form passes all fields through when viewFieldNames is not registered", async () => { + const { server, client } = await connect(); + // Fresh UUID never seen by display_pdf β†’ viewFieldNames.get(uuid) is + // undefined β†’ the known-fields guard (`knownFields && !knownFields.has()`) + // is falsy for every field β†’ everything is enqueued. + const uuid = "test-fillform-passthrough"; + + const r = await client.callTool({ + name: "interact", + arguments: { + viewUUID: uuid, + action: "fill_form", + fields: [ + { name: "anything", value: "goes" }, + { name: "unchecked", value: true }, + ], + }, + }); + expect(r.isError).toBeFalsy(); + expect(firstText(r)).toContain("Filled 2 field(s)"); + // No rejection complaint β€” the registry has no entry for this UUID + expect(firstText(r)).not.toContain("Unknown"); + + const cmds = await poll(client, uuid); + expect(cmds).toHaveLength(1); + expect(cmds[0].type).toBe("fill_form"); + const fields = cmds[0].fields as Array<{ name: string; value: unknown }>; + expect(fields).toHaveLength(2); + expect(fields.map((f) => f.name).sort()).toEqual(["anything", "unchecked"]); + + // Note: the "registered β†’ reject unknown" branch needs viewFieldNames + // populated, which only happens inside display_pdf (requires a real PDF). + // That map isn't exported, so the rejection path is covered by e2e only. + + await client.close(); + await server.close(); + }); + + // SECURITY: resolveImageAnnotation must not read arbitrary local files. + // The model controls imageUrl; without validation it's an exfil primitive + // (readFile β†’ base64 β†’ iframe β†’ get_screenshot reads it back). + describe("add_annotations image: imageUrl validation", () => { + let savedDirs: Set; + beforeEach(() => { + savedDirs = new Set(allowedLocalDirs); + allowedLocalDirs.clear(); + }); + afterEach(() => { + allowedLocalDirs.clear(); + for (const d of savedDirs) allowedLocalDirs.add(d); + }); + + it("rejects local path outside allowed roots", async () => { + const { server, client } = await connect(); + // Whitelist a harmless temp dir; target a path clearly outside it. + allowedLocalDirs.add(os.tmpdir()); + const target = path.join(os.homedir(), ".ssh", "id_rsa"); + const r = await client.callTool({ + name: "interact", + arguments: { + viewUUID: "sec-local", + action: "add_annotations", + annotations: [{ type: "image", id: "i1", page: 1, imageUrl: target }], + }, + }); + expect(r.isError).toBe(true); + expect(firstText(r)).toContain("imageUrl rejected"); + await client.close(); + await server.close(); + }); + + it("rejects http:// URL (SSRF)", async () => { + const { server, client } = await connect(); + const r = await client.callTool({ + name: "interact", + arguments: { + viewUUID: "sec-http", + action: "add_annotations", + annotations: [ + { + type: "image", + id: "i1", + page: 1, + imageUrl: "http://169.254.169.254/latest/meta-data/", + }, + ], + }, + }); + expect(r.isError).toBe(true); + expect(firstText(r)).toContain("imageUrl rejected"); + await client.close(); + await server.close(); + }); + + it("accepts path under an allowed dir (reaches readFile)", async () => { + const { server, client } = await connect(); + const dir = fs.mkdtempSync(path.join(os.tmpdir(), "pdf-imgurl-")); + allowedLocalDirs.add(dir); + // Minimal valid PNG (1x1 transparent): 8-byte sig + IHDR + IDAT + IEND. + const png = Buffer.from( + "89504E470D0A1A0A0000000D49484452000000010000000108060000001F15C4890000000A49444154789C6360000000000200015E9AFE400000000049454E44AE426082", + "hex", + ); + const imgPath = path.join(dir, "sig.png"); + fs.writeFileSync(imgPath, png); + try { + const r = await client.callTool({ + name: "interact", + arguments: { + viewUUID: "sec-ok", + action: "add_annotations", + annotations: [ + { type: "image", id: "i1", page: 1, imageUrl: imgPath }, + ], + }, + }); + // No security rejection; readFile succeeds; command enqueued. + expect(r.isError).toBeFalsy(); + const cmds = await poll(client, "sec-ok"); + expect(cmds).toHaveLength(1); + expect(cmds[0].type).toBe("add_annotations"); + const anns = cmds[0].annotations as Array>; + // validateUrl passed β†’ readFile ran β†’ imageData populated. + expect(typeof anns[0].imageData).toBe("string"); + expect((anns[0].imageData as string).length).toBeGreaterThan(0); + } finally { + fs.rmSync(dir, { recursive: true, force: true }); + } + await client.close(); + await server.close(); + }); + }); + + describe("save_as", () => { + // Roundtrip tests need: writable scope, kick off interact WITHOUT awaiting + // (it blocks until the view replies), poll β†’ submit β†’ await. The poll() + // call also registers the uuid in viewsPolled, satisfying + // ensureViewerIsPolling β€” without it interact would hang ~8s and fail. + + let tmpDir: string; + let savedDirs: Set; + + beforeEach(() => { + tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "pdf-saveas-")); + savedDirs = new Set(allowedLocalDirs); + allowedLocalDirs.add(tmpDir); // make tmpDir a directory root β†’ writable + }); + + afterEach(() => { + allowedLocalDirs.clear(); + for (const x of savedDirs) allowedLocalDirs.add(x); + viewSourcePaths.clear(); + fs.rmSync(tmpDir, { recursive: true, force: true }); + }); + + it("no path, no source tracked β†’ tells model to provide a path", async () => { + // Fresh UUID never seen by display_pdf β†’ viewSourcePaths has no entry. + // Same condition as a remote (https://) PDF or a stale viewUUID. + const { server, client } = await connect(); + const r = await client.callTool({ + name: "interact", + arguments: { viewUUID: "saveas-nosource", action: "save_as" }, + }); + expect(r.isError).toBe(true); + expect(firstText(r)).toContain("no local source file"); + expect(firstText(r)).toContain("Provide an explicit `path`"); + await client.close(); + await server.close(); + }); + + it("no path, source tracked, overwrite omitted β†’ asks for confirmation", async () => { + const { server, client } = await connect(); + const source = path.join(tmpDir, "original.pdf"); + fs.writeFileSync(source, "%PDF-1.4\noriginal"); + viewSourcePaths.set("saveas-noconfirm", source); + + const r = await client.callTool({ + name: "interact", + arguments: { viewUUID: "saveas-noconfirm", action: "save_as" }, + }); + expect(r.isError).toBe(true); + expect(firstText(r)).toContain("overwrites the original"); + expect(firstText(r)).toContain(source); + expect(firstText(r)).toContain("overwrite: true"); + // Nothing enqueued, file untouched + expect(fs.readFileSync(source, "utf8")).toBe("%PDF-1.4\noriginal"); + await client.close(); + await server.close(); + }); + + it("no path, source not writable β†’ same gate as save button", async () => { + const { server, client } = await connect(); + // Source outside any directory root β†’ isWritablePath false β†’ save button + // would be hidden in the viewer. save_as should refuse for the same reason. + const outside = path.join(os.tmpdir(), "saveas-outside.pdf"); + fs.writeFileSync(outside, "x"); + viewSourcePaths.set("saveas-buttongate", outside); + + try { + const r = await client.callTool({ + name: "interact", + arguments: { + viewUUID: "saveas-buttongate", + action: "save_as", + overwrite: true, + }, + }); + expect(r.isError).toBe(true); + expect(firstText(r)).toContain("not writable"); + expect(firstText(r)).toContain("save button is hidden"); + } finally { + fs.rmSync(outside, { force: true }); + } + await client.close(); + await server.close(); + }); + + it("no path, overwrite: true β†’ roundtrip overwrites the original", async () => { + const { server, client } = await connect(); + const uuid = "saveas-original"; + const source = path.join(tmpDir, "report.pdf"); + fs.writeFileSync(source, "%PDF-1.4\noriginal contents"); + viewSourcePaths.set(uuid, source); + + const interactPromise = client.callTool({ + name: "interact", + arguments: { viewUUID: uuid, action: "save_as", overwrite: true }, + }); + + const cmds = await poll(client, uuid); + expect(cmds).toHaveLength(1); + expect(cmds[0].type).toBe("save_as"); + await client.callTool({ + name: "submit_save_data", + arguments: { + requestId: cmds[0].requestId as string, + data: Buffer.from("%PDF-1.4\nannotated").toString("base64"), + }, + }); + + const r = await interactPromise; + expect(r.isError).toBeFalsy(); + expect(firstText(r)).toContain(source); + expect(fs.readFileSync(source, "utf8")).toBe("%PDF-1.4\nannotated"); + + await client.close(); + await server.close(); + }); + + it("rejects non-absolute path", async () => { + const { server, client } = await connect(); + const r = await client.callTool({ + name: "interact", + arguments: { + viewUUID: "saveas-rel", + action: "save_as", + path: "relative.pdf", + }, + }); + expect(r.isError).toBe(true); + expect(firstText(r)).toContain("absolute"); + await client.close(); + await server.close(); + }); + + it("rejects non-writable path", async () => { + const { server, client } = await connect(); + // Path outside any directory root β†’ not writable. Validation is sync, + // so nothing is enqueued and the queue stays empty. + const r = await client.callTool({ + name: "interact", + arguments: { + viewUUID: "saveas-nowrite", + action: "save_as", + path: "/somewhere/else/out.pdf", + }, + }); + expect(r.isError).toBe(true); + expect(firstText(r)).toContain("not under a mounted directory root"); + await client.close(); + await server.close(); + }); + + it("rejects existing file when overwrite is false (default)", async () => { + const { server, client } = await connect(); + const target = path.join(tmpDir, "exists.pdf"); + fs.writeFileSync(target, "old contents"); + + const r = await client.callTool({ + name: "interact", + arguments: { + viewUUID: "saveas-exists", + action: "save_as", + path: target, + }, + }); + expect(r.isError).toBe(true); + expect(firstText(r)).toContain("already exists"); + expect(firstText(r)).toContain("overwrite: true"); + // Existence check is sync β€” nothing enqueued, file untouched. + expect(fs.readFileSync(target, "utf8")).toBe("old contents"); + await client.close(); + await server.close(); + }); + + it("full roundtrip: enqueue β†’ poll β†’ submit β†’ file written", async () => { + const { server, client } = await connect(); + const uuid = "saveas-roundtrip"; + const target = path.join(tmpDir, "out.pdf"); + const pdfBytes = "%PDF-1.4\nfake-annotated-contents\n%%EOF"; + + // interact blocks in waitForSaveData until submit_save_data resolves it + const interactPromise = client.callTool({ + name: "interact", + arguments: { viewUUID: uuid, action: "save_as", path: target }, + }); + + // Viewer polls β†’ receives the save_as command with a requestId + const cmds = await poll(client, uuid); + expect(cmds).toHaveLength(1); + expect(cmds[0].type).toBe("save_as"); + const requestId = cmds[0].requestId as string; + expect(typeof requestId).toBe("string"); + + // Viewer submits bytes + const submit = await client.callTool({ + name: "submit_save_data", + arguments: { + requestId, + data: Buffer.from(pdfBytes).toString("base64"), + }, + }); + expect(submit.isError).toBeFalsy(); + + // interact now unblocks with success + const r = await interactPromise; + expect(r.isError).toBeFalsy(); + expect(firstText(r)).toContain("Saved"); + expect(firstText(r)).toContain(target); + expect(fs.readFileSync(target, "utf8")).toBe(pdfBytes); + + await client.close(); + await server.close(); + }); + + it("overwrite: true replaces an existing file", async () => { + const { server, client } = await connect(); + const uuid = "saveas-overwrite"; + const target = path.join(tmpDir, "replace.pdf"); + fs.writeFileSync(target, "old contents"); + + const interactPromise = client.callTool({ + name: "interact", + arguments: { + viewUUID: uuid, + action: "save_as", + path: target, + overwrite: true, + }, + }); + + const cmds = await poll(client, uuid); + const requestId = cmds[0].requestId as string; + await client.callTool({ + name: "submit_save_data", + arguments: { + requestId, + data: Buffer.from("%PDF-1.4\nnew").toString("base64"), + }, + }); + + const r = await interactPromise; + expect(r.isError).toBeFalsy(); + expect(fs.readFileSync(target, "utf8")).toBe("%PDF-1.4\nnew"); + + await client.close(); + await server.close(); + }); + + it("propagates viewer-reported errors to the model", async () => { + const { server, client } = await connect(); + const uuid = "saveas-viewerr"; + const target = path.join(tmpDir, "wontwrite.pdf"); + + const interactPromise = client.callTool({ + name: "interact", + arguments: { viewUUID: uuid, action: "save_as", path: target }, + }); + + const cmds = await poll(client, uuid); + // Viewer hit an error building bytes β†’ reports it instead of timing out + await client.callTool({ + name: "submit_save_data", + arguments: { + requestId: cmds[0].requestId as string, + error: "pdf-lib choked on a comb field", + }, + }); + + const r = await interactPromise; + expect(r.isError).toBe(true); + expect(firstText(r)).toContain("pdf-lib choked on a comb field"); + expect(fs.existsSync(target)).toBe(false); + + await client.close(); + await server.close(); + }); + + it("submit_save_data with unknown requestId returns isError", async () => { + const { server, client } = await connect(); + const r = await client.callTool({ + name: "submit_save_data", + arguments: { requestId: "never-created", data: "AAAA" }, + }); + expect(r.isError).toBe(true); + expect(firstText(r)).toContain("No pending request"); + await client.close(); + await server.close(); + }); + }); + + describe("viewer liveness", () => { + // get_screenshot/get_text fail fast when the iframe never polled, instead + // of waiting 45s for a viewer that isn't there. Reproduces the case where + // the host goes idle before the iframe reaches startPolling(). + + it("get_screenshot fails fast when viewer never polled", async () => { + const { server, client } = await connect(); + const uuid = "never-polled-screenshot"; + + const started = Date.now(); + const r = await client.callTool({ + name: "interact", + arguments: { viewUUID: uuid, action: "get_screenshot", page: 1 }, + }); + const elapsed = Date.now() - started; + + expect(r.isError).toBe(true); + expect(firstText(r)).toContain("never connected"); + expect(firstText(r)).toContain(uuid); + expect(firstText(r)).toContain("display_pdf again"); // recovery hint + // Fast-fail bound (~8s grace), well under the 45s page-data timeout. + // 15s upper bound leaves slack for CI scheduling. + expect(elapsed).toBeLessThan(15_000); + + await client.close(); + await server.close(); + }, 20_000); + + it("get_screenshot waits full timeout when viewer polled then went silent", async () => { + // Viewer polled once (proving it mounted) then hung on a heavy render. + // The grace check passes, so we fall through to the 45s page-data wait β€” + // verified here by racing against a 12s deadline that should NOT win. + const { server, client } = await connect(); + const uuid = "polled-then-silent"; + + // Viewer's first poll: drain whatever's there so it returns fast. + // Enqueue a trivial command first so poll returns via the batch-wait + // path (~200ms) instead of blocking on the 30s long-poll. + await client.callTool({ + name: "interact", + arguments: { viewUUID: uuid, action: "navigate", page: 1 }, + }); + await poll(client, uuid); + + // Now get_screenshot β€” viewer has polled, so no fast-fail. But viewer + // never calls submit_page_data β†’ should wait beyond the grace period. + const outcome = await Promise.race([ + client + .callTool({ + name: "interact", + arguments: { viewUUID: uuid, action: "get_screenshot", page: 1 }, + }) + .then(() => "completed" as const), + new Promise<"still-waiting">((r) => + setTimeout(() => r("still-waiting"), 12_000), + ), + ]); + + expect(outcome).toBe("still-waiting"); + + await client.close(); + await server.close(); + }, 20_000); + + it("get_screenshot succeeds when viewer polls during grace window", async () => { + // Model calls interact before the viewer has polled β€” but the viewer + // shows up within the grace period and completes the roundtrip. + const { server, client } = await connect(); + const uuid = "late-arriving-viewer"; + + const interactPromise = client.callTool({ + name: "interact", + arguments: { viewUUID: uuid, action: "get_screenshot", page: 1 }, + }); + + // Viewer connects 500ms late β€” well inside the grace window. + await new Promise((r) => setTimeout(r, 500)); + const cmds = await poll(client, uuid); + const getPages = cmds.find((c) => c.type === "get_pages"); + expect(getPages).toBeDefined(); + + // Viewer responds with the page data. + await client.callTool({ + name: "submit_page_data", + arguments: { + requestId: getPages!.requestId as string, + pages: [ + { page: 1, image: Buffer.from("fake-jpeg").toString("base64") }, + ], + }, + }); + + const r = await interactPromise; + expect(r.isError).toBeFalsy(); + expect((r.content as Array<{ type: string }>)[0].type).toBe("image"); + + await client.close(); + await server.close(); + }, 15_000); + + it("batch step failure: 1:1 content, no isError, ERROR-prefixed slot", async () => { + // LocalAgentMode SDK 2.1.87 collapses isError:true results to a bare + // string of content[0].text β€” drops images from earlier successful + // steps. So we don't set isError on a step failure: each command gets + // one content slot, the failed one starts with "ERROR", and the batch + // stops there. content.length tells the model how far it got. + const { server, client } = await connect(); + const uuid = "batch-error-ordering"; + + const r = await client.callTool({ + name: "interact", + arguments: { + viewUUID: uuid, + commands: [ + { action: "navigate", page: 3 }, // succeeds β†’ "Queued: ..." + { action: "get_screenshot", page: 1 }, // never-polled β†’ fast-fail + { action: "navigate", page: 5 }, // never reached + ], + }, + }); + + // Not isError β€” that would trigger the SDK flatten + expect(r.isError).toBeFalsy(); + const content = r.content as Array<{ type: string; text?: string }>; + // Stopped at step 2; step 3 never ran + expect(content).toHaveLength(2); + // Slot 0: step 1's success, untouched + expect(content[0].text).toContain("Queued"); + expect(content[0].text).not.toMatch(/^ERROR/); + // Slot 1: step 2's failure, ERROR-prefixed with the actual message + expect(content[1].text).toMatch(/^ERROR/); + expect(content[1].text).toContain("2/3"); + expect(content[1].text).toContain("get_screenshot"); + expect(content[1].text).toContain("never connected"); + + await client.close(); + await server.close(); + }, 15_000); + }); +}); diff --git a/examples/pdf-server/server.ts b/examples/pdf-server/server.ts index 0f835b7..e67cd47 100644 --- a/examples/pdf-server/server.ts +++ b/examples/pdf-server/server.ts @@ -13,18 +13,56 @@ import { randomUUID } from "crypto"; import fs from "node:fs"; import path from "node:path"; -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import type { Server } from "@modelcontextprotocol/sdk/server/index.js"; import { registerAppResource, registerAppTool, RESOURCE_MIME_TYPE, } from "@modelcontextprotocol/ext-apps/server"; import { - RootsListChangedNotificationSchema, + McpServer, type CallToolResult, + type ElicitResult, + type PrimitiveSchemaDefinition, type ReadResourceResult, -} from "@modelcontextprotocol/sdk/types.js"; + type Server, +} from "@modelcontextprotocol/server"; +// Stub DOMMatrix/ImageData/Path2D before pdfjs-dist loads β€” its legacy +// build instantiates DOMMatrix at module scope and the @napi-rs/canvas +// polyfill is unreliable under npx. See ./pdfjs-polyfill.ts for details. +import "./pdfjs-polyfill.js"; +import { + getDocument, + PDFDataRangeTransport, + VerbosityLevel, + version as PDFJS_VERSION, +} from "pdfjs-dist/legacy/build/pdf.mjs"; +import type { PDFDocumentProxy } from "pdfjs-dist/types/src/display/api.js"; + +/** + * PDF Standard-14 fonts from CDN. Used by both server and viewer so we + * declare a single well-known origin in CSP connectDomains. + * + * pdf.js in Node defaults to NodeStandardFontDataFactory (fs.readFile) which + * can't fetch URLs, so we pass {@link FetchStandardFontDataFactory} alongside. + * The browser viewer uses the DOM factory by default and just needs the URL. + */ +export const STANDARD_FONT_DATA_URL = `https://unpkg.com/pdfjs-dist@${PDFJS_VERSION}/standard_fonts/`; +const STANDARD_FONT_ORIGIN = "https://unpkg.com"; + +/** pdf.js font factory that uses fetch() instead of fs.readFile. */ +class FetchStandardFontDataFactory { + baseUrl: string | null; + constructor({ baseUrl = null }: { baseUrl?: string | null }) { + this.baseUrl = baseUrl; + } + async fetch({ filename }: { filename: string }): Promise { + if (!this.baseUrl) throw new Error("standardFontDataUrl not provided"); + const url = `${this.baseUrl}${filename}`; + const res = await globalThis.fetch(url); + if (!res.ok) throw new Error(`Failed to fetch ${url}: ${res.status}`); + return new Uint8Array(await res.arrayBuffer()); + } +} import { z } from "zod"; // ============================================================================= @@ -44,17 +82,442 @@ export const CACHE_MAX_LIFETIME_MS = 60_000; // 60 seconds /** Max size for cached PDFs (defensive limit to prevent memory exhaustion) */ export const CACHE_MAX_PDF_SIZE_BYTES = 50 * 1024 * 1024; // 50MB -/** Allowed local file paths (populated from CLI args) */ +/** Max total bytes across all cache entries; oldest evicted first when exceeded. */ +export const CACHE_MAX_TOTAL_BYTES = 256 * 1024 * 1024; // 256MB + +/** Allowed local file paths (CLI args + file roots β€” read access). */ export const allowedLocalFiles = new Set(); -/** Allowed local directories (populated from MCP roots) */ +/** Allowed local directories (CLI args + directory roots β€” read access). */ export const allowedLocalDirs = new Set(); +/** + * Subset of allowedLocalFiles that came from CLI args (not MCP roots). + * Only these individual files are writable. File roots from the client + * are uploaded copies in ad-hoc hidden folders β€” treat as read-only. + * Directory roots are mounted folders; files UNDER them are writable. + */ +export const cliLocalFiles = new Set(); + +/** + * Write-permission flags. Object wrapper (not a bare `let`) so main.ts can + * mutate via the exported binding without re-import gymnastics β€” same + * pattern as the Sets above. + */ +export const writeFlags = { + /** + * Claude Desktop mounts its per-conversation drop folder as a directory + * root whose basename is literally `uploads`. Files in there are one-shot + * copies the client doesn't expect us to overwrite. Default: read-only. + * `--writeable-uploads-root` flips this for local testing. + */ + allowUploadsRoot: false, +}; + +/** + * Saving is allowed iff: + * (a) the file was passed as a CLI arg β€” the user explicitly named it + * when starting the server, so overwriting is clearly intentional; OR + * (b) the file is STRICTLY UNDER a directory root at any depth + * (isAncestorDir excludes rel === "", so the root itself never + * counts), AND the client did not ALSO send it as a file root. + * A file root is the client's way of saying "here's an upload" β€” + * treat that signal as authoritative even when the path happens + * to fall inside a mounted directory. + * + * EXCEPTION to (b): a dir root whose basename is `uploads` is treated + * as read-only unless `writeFlags.allowUploadsRoot` is set. This is how + * Claude Desktop surfaces attached files β€” writing back to them + * surprises the user (the attachment doesn't update). + * + * With no directory roots and no CLI files, nothing is writable. + */ +export function isWritablePath(resolved: string): boolean { + if (cliLocalFiles.has(resolved)) return true; + // MCP file root β†’ always read-only, regardless of ancestry + if (allowedLocalFiles.has(resolved)) return false; + return [...allowedLocalDirs].some((dir) => { + if (!isAncestorDir(dir, resolved)) return false; + if (!writeFlags.allowUploadsRoot && path.basename(dir) === "uploads") { + return false; + } + return true; + }); +} + // Works both from source (server.ts) and compiled (dist/server.js) const DIST_DIR = import.meta.filename.endsWith(".ts") ? path.join(import.meta.dirname, "dist") : import.meta.dirname; +// ============================================================================= +// Command Queue (shared across stateless server instances) +// ============================================================================= + +/** Commands expire after this many ms if never polled */ +const COMMAND_TTL_MS = 60_000; // 60 seconds + +/** Periodic sweep interval to drop stale queues */ +const SWEEP_INTERVAL_MS = 30_000; // 30 seconds + +/** Fixed batch window: when commands are present, wait this long before returning to let more accumulate */ +const POLL_BATCH_WAIT_MS = 200; +const LONG_POLL_TIMEOUT_MS = 30_000; // Max time to hold a long-poll request open + +// ============================================================================= +// Interact Tool Input Schemas (runtime validators) +// ============================================================================= +// +// Annotation structure docs live in src/pdf-annotations.ts (the TS +// interfaces) and in the interact tool description. The inputSchema +// for `annotations` accepts z.record(z.any()) to keep the model-facing +// API forgiving; adding strict validation here would be a behavior change. + +const FormField = z.object({ + name: z.string(), + value: z.union([z.string(), z.boolean()]), +}); + +const PageInterval = z.object({ + start: z.number().min(1).optional(), + end: z.number().min(1).optional(), +}); + +// ============================================================================= +// Command Queue β€” wire protocol shared with the viewer +// ============================================================================= + +// PdfCommand is the single source of truth for what flows through the +// poll queue. Defined once in src/commands.ts; both sides import it. +// (`import type` β†’ no pdf-lib bundled into the server.) +import type { PdfCommand } from "./src/commands.js"; +export type { PdfCommand }; + +// ============================================================================= +// Pending get_pages Requests (request-response bridge via client) +// ============================================================================= + +// Keep well under the MCP SDK's DEFAULT_REQUEST_TIMEOUT_MSEC (60s) so we +// reject first and return a real error instead of the client cancelling us. +const GET_PAGES_TIMEOUT_MS = 45_000; + +/** + * Grace period for the viewer's first poll. If interact() arrives before the + * iframe has ever polled, we wait this long for it to show up (iframe mount + + * PDF load + startPolling). If no poll comes, the viewer almost certainly + * never rendered β€” failing fast beats a silent 45s hang. + */ +const VIEWER_FIRST_POLL_GRACE_MS = 8_000; + +interface PageDataEntry { + page: number; + text?: string; + image?: string; // base64 PNG +} + +const pendingPageRequests = new Map< + string, + (data: PageDataEntry[] | Error) => void +>(); + +/** + * Wait for the viewer to render and submit page data. + * Rejects on timeout or when the interact request is aborted upstream. + */ +function waitForPageData( + requestId: string, + signal?: AbortSignal, +): Promise { + return new Promise((resolve, reject) => { + const settle = (v: PageDataEntry[] | Error) => { + clearTimeout(timer); + signal?.removeEventListener("abort", onAbort); + pendingPageRequests.delete(requestId); + v instanceof Error ? reject(v) : resolve(v); + }; + const onAbort = () => settle(new Error("interact request cancelled")); + const timer = setTimeout( + () => settle(new Error("Timeout waiting for page data from viewer")), + GET_PAGES_TIMEOUT_MS, + ); + signal?.addEventListener("abort", onAbort); + pendingPageRequests.set(requestId, settle); + }); +} + +/** + * Wait for the viewer's first poll_pdf_commands call. + * + * Called before waitForPageData() / waitForSaveData() so a viewer that never + * mounted fails in ~8s with a specific message instead of a generic 45s + * "Timeout waiting for ..." that gives no hint why. + * + * Intentionally does NOT touch pollWaiters: piggybacking on that single-slot + * Map races with poll_pdf_commands' batch-wait branch (which never cancels the + * prior waiter) and with concurrent interact calls (which would overwrite each + * other). A plain check loop on viewsPolled is stateless β€” multiple callers + * can wait independently and all observe the same add() when it happens. + */ +async function ensureViewerIsPolling(uuid: string): Promise { + const deadline = Date.now() + VIEWER_FIRST_POLL_GRACE_MS; + while (!viewsPolled.has(uuid)) { + if (Date.now() >= deadline) { + throw new Error( + `Viewer never connected for viewUUID ${uuid} (no poll within ${VIEWER_FIRST_POLL_GRACE_MS / 1000}s). ` + + `The iframe likely failed to mount β€” this happens when the conversation ` + + `goes idle before the viewer finishes loading. Call display_pdf again to get a fresh viewUUID.`, + ); + } + await new Promise((r) => setTimeout(r, 100)); + } +} + +// ============================================================================= +// Pending save_as Requests (request-response bridge via client) +// ============================================================================= +// +// Same shape as get_pages: model's interact call blocks while the viewer +// builds annotated bytes and posts them back. Reuses GET_PAGES_TIMEOUT_MS +// (45s) β€” generous because pdf-lib reflow on a large doc can take seconds. + +const pendingSaveRequests = new Map void>(); + +/** + * Wait for the viewer to build annotated PDF bytes and submit them as base64. + * Rejects on timeout, abort, or when the viewer reports an error. + */ +function waitForSaveData( + requestId: string, + signal?: AbortSignal, +): Promise { + return new Promise((resolve, reject) => { + const settle = (v: string | Error) => { + clearTimeout(timer); + signal?.removeEventListener("abort", onAbort); + pendingSaveRequests.delete(requestId); + v instanceof Error ? reject(v) : resolve(v); + }; + const onAbort = () => settle(new Error("interact request cancelled")); + const timer = setTimeout( + () => settle(new Error("Timeout waiting for PDF bytes from viewer")), + GET_PAGES_TIMEOUT_MS, + ); + signal?.addEventListener("abort", onAbort); + pendingSaveRequests.set(requestId, settle); + }); +} + +const pendingStateRequests = new Map void>(); + +/** + * Wait for the viewer to report its current state (page, zoom, selection, …) + * as a JSON string. Same timeout/abort semantics as waitForSaveData. + */ +function waitForViewerState( + requestId: string, + signal?: AbortSignal, +): Promise { + return new Promise((resolve, reject) => { + const settle = (v: string | Error) => { + clearTimeout(timer); + signal?.removeEventListener("abort", onAbort); + pendingStateRequests.delete(requestId); + v instanceof Error ? reject(v) : resolve(v); + }; + const onAbort = () => settle(new Error("interact request cancelled")); + const timer = setTimeout( + () => settle(new Error("Timeout waiting for viewer state")), + GET_PAGES_TIMEOUT_MS, + ); + signal?.addEventListener("abort", onAbort); + pendingStateRequests.set(requestId, settle); + }); +} + +interface QueueEntry { + commands: PdfCommand[]; + /** Timestamp of the most recent enqueue or dequeue */ + lastActivity: number; +} + +const commandQueues = new Map(); + +/** Waiters for long-poll: resolve callback wakes up a blocked poll_pdf_commands */ +const pollWaiters = new Map void>(); + +/** + * viewUUIDs that have been polled at least once. A view missing from this set + * means the iframe never reached startPolling() β€” usually because it wasn't + * mounted yet, or ontoolresult threw before the poll loop started. Used to + * fail fast in get_screenshot/get_text instead of waiting the full 45s for + * a viewer that was never there. + */ +const viewsPolled = new Set(); + +/** + * Resolved local file path per viewer UUID, for save_as without an explicit + * target. Only set for local files (remote PDFs have nothing to overwrite). + * Populated during display_pdf, cleared by the heartbeat sweep. + * + * Exported for tests. + */ +export const viewSourcePaths = new Map(); + +/** Valid form field names per viewer UUID (populated during display_pdf) */ +const viewFieldNames = new Map>(); + +/** + * Active fs.watch per view. Only created for local files when interact is + * enabled (stdio). Watcher is re-established on `rename` events to survive + * atomic writes (vim/vscode write-to-tmp-then-rename changes the inode). + */ +interface ViewFileWatch { + filePath: string; + watcher: fs.FSWatcher; + lastMtimeMs: number; + debounce: ReturnType | null; +} +const viewFileWatches = new Map(); + +/** + * Per-view heartbeat. THIS is what the sweep iterates β€” not commandQueues. + * + * Why not commandQueues: display_pdf populates viewFieldNames/ + * viewFileWatches but never touches commandQueues (only enqueueCommand does, + * and it's triply gated). And dequeueCommands deletes the entry on every poll, + * so even when it exists the sweep's TTL window is ~200ms wide. Net effect: + * the sweep found nothing and the aux maps leaked every display_pdf call. + * viewFileWatches entries hold an fs.StatWatcher (FD + timer) β€” slow FD + * exhaustion on HTTP --enable-interact. + */ +const viewLastActivity = new Map(); + +/** Register or refresh the heartbeat for a view. */ +function touchView(uuid: string): void { + viewLastActivity.set(uuid, Date.now()); +} + +function pruneStaleQueues(): void { + const now = Date.now(); + for (const [uuid, lastActivity] of viewLastActivity) { + if (now - lastActivity > COMMAND_TTL_MS) { + viewLastActivity.delete(uuid); + commandQueues.delete(uuid); + viewFieldNames.delete(uuid); + viewsPolled.delete(uuid); + viewSourcePaths.delete(uuid); + stopFileWatch(uuid); + } + } +} + +// Periodic sweep so abandoned views don't leak +setInterval(pruneStaleQueues, SWEEP_INTERVAL_MS).unref(); + +function enqueueCommand(viewUUID: string, command: PdfCommand): void { + let entry = commandQueues.get(viewUUID); + if (!entry) { + entry = { commands: [], lastActivity: Date.now() }; + commandQueues.set(viewUUID, entry); + } + entry.commands.push(command); + entry.lastActivity = Date.now(); + touchView(viewUUID); + + // Wake up any long-polling request waiting for this viewUUID + const waiter = pollWaiters.get(viewUUID); + if (waiter) { + pollWaiters.delete(viewUUID); + waiter(); + } +} + +function dequeueCommands(viewUUID: string): PdfCommand[] { + // Poll is activity β€” keep the view alive even when the queue is empty + // (the common case: viewer polls every ~30s with nothing to receive). + touchView(viewUUID); + const entry = commandQueues.get(viewUUID); + if (!entry) return []; + const commands = entry.commands; + commandQueues.delete(viewUUID); + return commands; +} + +// ============================================================================= +// File Watching (local files, stdio only) +// ============================================================================= + +const FILE_WATCH_DEBOUNCE_MS = 150; + +export function startFileWatch(viewUUID: string, filePath: string): void { + const resolved = path.resolve(filePath); + let stat: fs.Stats; + try { + stat = fs.statSync(resolved); + } catch { + return; // vanished between validation and here + } + + // Replace any existing watcher for this view + stopFileWatch(viewUUID); + + const entry: ViewFileWatch = { + filePath: resolved, + watcher: null as unknown as fs.FSWatcher, + lastMtimeMs: stat.mtimeMs, + debounce: null, + }; + + const onEvent = (eventType: string): void => { + if (entry.debounce) clearTimeout(entry.debounce); + entry.debounce = setTimeout(() => { + entry.debounce = null; + let s: fs.Stats; + try { + s = fs.statSync(resolved); + } catch { + return; // gone mid-atomic-write; next rename will re-attach + } + if (s.mtimeMs === entry.lastMtimeMs) return; // spurious / already sent + entry.lastMtimeMs = s.mtimeMs; + enqueueCommand(viewUUID, { type: "file_changed", mtimeMs: s.mtimeMs }); + }, FILE_WATCH_DEBOUNCE_MS); + + // Atomic saves replace the inode β€” old watcher stops firing. Re-attach. + if (eventType === "rename") { + try { + entry.watcher.close(); + } catch { + /* already closed */ + } + try { + entry.watcher = fs.watch(resolved, onEvent); + } catch { + // File removed, not replaced. Leave closed; pruneStaleQueues cleans up. + } + } + }; + + try { + entry.watcher = fs.watch(resolved, onEvent); + } catch { + return; // fs.watch unsupported (e.g. some network filesystems) + } + viewFileWatches.set(viewUUID, entry); +} + +export function stopFileWatch(viewUUID: string): void { + const entry = viewFileWatches.get(viewUUID); + if (!entry) return; + if (entry.debounce) clearTimeout(entry.debounce); + try { + entry.watcher.close(); + } catch { + /* ignore */ + } + viewFileWatches.delete(viewUUID); +} + // ============================================================================= // URL Validation & Normalization // ============================================================================= @@ -175,10 +638,19 @@ export function validateUrl(url: string): { // Remote URL - require HTTPS try { const parsed = new URL(url); - if (parsed.protocol !== "https:") { - return { valid: false, error: `Only HTTPS URLs are allowed: ${url}` }; + if (parsed.protocol === "https:") return { valid: true }; + // Loopback HTTP is opt-in (test fixtures, local dev). Off by default so a + // remotely-deployed server can't be made to probe its own internal ports. + if ( + process.env.PDF_SERVER_ALLOW_LOOPBACK_HTTP && + parsed.protocol === "http:" && + (parsed.hostname === "127.0.0.1" || + parsed.hostname === "localhost" || + parsed.hostname === "[::1]") + ) { + return { valid: true }; } - return { valid: true }; + return { valid: false, error: `Only HTTPS URLs are allowed: ${url}` }; } catch { return { valid: false, error: `Invalid URL: ${url}` }; } @@ -230,8 +702,11 @@ export interface PdfCache { * - CACHE_INACTIVITY_TIMEOUT_MS of no access (resets on each access) * - CACHE_MAX_LIFETIME_MS from creation (absolute timeout) */ -export function createPdfCache(): PdfCache { +export function createPdfCache( + maxTotalBytes: number = CACHE_MAX_TOTAL_BYTES, +): PdfCache { const cache = new Map(); + let totalBytes = 0; /** Delete a cache entry and clear its timers */ function deleteCacheEntry(url: string): void { @@ -239,6 +714,7 @@ export function createPdfCache(): PdfCache { if (entry) { clearTimeout(entry.inactivityTimer); clearTimeout(entry.maxLifetimeTimer); + totalBytes -= entry.data.length; cache.delete(url); } } @@ -254,6 +730,10 @@ export function createPdfCache(): PdfCache { deleteCacheEntry(url); }, CACHE_INACTIVITY_TIMEOUT_MS); + // Move to end of insertion order so size-cap eviction is LRU. + cache.delete(url); + cache.set(url, entry); + return entry.data; } @@ -262,6 +742,12 @@ export function createPdfCache(): PdfCache { // Clear any existing entry first deleteCacheEntry(url); + // Evict least-recently-used entries until under the byte cap. + for (const oldest of cache.keys()) { + if (totalBytes + data.length <= maxTotalBytes) break; + deleteCacheEntry(oldest); + } + const entry: CacheEntry = { data, createdAt: Date.now(), @@ -274,6 +760,7 @@ export function createPdfCache(): PdfCache { }; cache.set(url, entry); + totalBytes += data.length; } /** Slice a cached or freshly-fetched full body to the requested range. */ @@ -398,6 +885,61 @@ export function createPdfCache(): PdfCache { }; } +/** + * pdf.js range transport backed by {@link PdfCache.readPdfRange}. Lets + * getDocument() fetch only the byte ranges it needs (xref, /AcroForm dict) + * instead of the whole file. With disableAutoFetch, a PDF without form + * fields is opened with ~5% of bytes fetched. + * + * pdf.js has no upstream error channel on PDFDataRangeTransport (its + * `abort()` is a no-op stub it calls *on* us, not the other way). Callers + * must `Promise.race` their pdf.js awaits against {@link failed}, which + * rejects on the first fetch error. + */ +export class PdfCacheRangeTransport extends PDFDataRangeTransport { + /** Rejects on the first range-fetch error; never resolves. */ + readonly failed: Promise; + private fail!: (e: unknown) => void; + + constructor( + private url: string, + length: number, + private readPdfRange: PdfCache["readPdfRange"], + ) { + super(length, null); + this.failed = new Promise((_, reject) => { + this.fail = reject; + }); + // Don't crash the process if no one is racing yet. + this.failed.catch(() => {}); + } + + override requestDataRange(begin: number, end: number): void { + void this.deliver(begin, end).catch((e) => this.fail(e)); + } + + /** + * pdf.js coalesces adjacent missing chunks into one unbounded request, but + * readPdfRange clamps each call to MAX_CHUNK_BYTES. Its reader is keyed by + * the original `begin` and removed after one delivery, so we must accumulate + * slices and call onDataRange exactly once with the full buffer. + */ + private async deliver(begin: number, end: number): Promise { + const buf = new Uint8Array(end - begin); + let off = 0; + while (off < buf.length) { + const want = Math.min(buf.length - off, MAX_CHUNK_BYTES); + const { data } = await this.readPdfRange(this.url, begin + off, want); + if (data.length === 0) { + throw new Error(`empty range at ${begin + off} for ${this.url}`); + } + buf.set(data.subarray(0, Math.min(data.length, buf.length - off)), off); + off += data.length; + } + this.onDataRange(begin, buf); + } +} + // ============================================================================= // MCP Roots // ============================================================================= @@ -439,11 +981,259 @@ async function refreshRoots(server: Server): Promise { } } +// ============================================================================= +// PDF Form Field Extraction +// ============================================================================= + +/** + * Extract form fields from a PDF and build an elicitation schema. + * Returns null if the PDF has no form fields. + */ +/** Shape of field objects returned by pdfjs-dist's getFieldObjects(). */ +interface PdfJsFieldObject { + type: string; + name: string; + editable: boolean; + exportValues?: string; + items?: Array<{ exportValue: string; displayValue: string }>; +} + +/** Detailed info about a form field, including its location on the page. */ +interface FormFieldInfo { + name: string; + type: string; + page: number; + label?: string; + /** Bounding box in model coordinates (top-left origin) */ + x: number; + y: number; + width: number; + height: number; + /** Radio button export value (buttonValue) β€” distinguishes widgets that share a field name. */ + exportValue?: string; + /** Dropdown/listbox option values, as seen in the widget's `options` array. */ + options?: string[]; +} + +/** + * Open `url` via {@link PdfCacheRangeTransport} and return form metadata. + * Uses `disableAutoFetch` so PDFs without an AcroForm are probed with only + * the trailer/xref/catalog (~5-25% of bytes); PDFs with forms still walk + * every page via {@link extractFormFieldInfo} but those are typically small. + * All errors (including range-fetch failures surfaced via + * {@link PdfCacheRangeTransport.failed}) resolve to empty results. + */ +async function probeFormFields( + url: string, + totalBytes: number, + readPdfRange: PdfCache["readPdfRange"], +): Promise<{ + formSchema: Awaited>; + fieldInfo: FormFieldInfo[]; +}> { + // Assigned sequentially below so a throw in extractFormFieldInfo (no per-page + // guard, unlike extractFormSchema) doesn't discard an already-computed schema. + let formSchema: Awaited> = null; + let fieldInfo: FormFieldInfo[] = []; + try { + const transport = new PdfCacheRangeTransport(url, totalBytes, readPdfRange); + const orFail = (p: Promise): Promise => + Promise.race([p, transport.failed]); + const pdfDoc = await orFail( + getDocument({ + range: transport, + length: totalBytes, + disableAutoFetch: true, + disableStream: true, + rangeChunkSize: 64 * 1024, + standardFontDataUrl: STANDARD_FONT_DATA_URL, + StandardFontDataFactory: FetchStandardFontDataFactory, + verbosity: VerbosityLevel.ERRORS, + }).promise, + ); + try { + const fieldObjects = (await orFail(pdfDoc.getFieldObjects())) as Record< + string, + PdfJsFieldObject[] + > | null; + if (fieldObjects && Object.keys(fieldObjects).length > 0) { + formSchema = await orFail(extractFormSchema(pdfDoc, fieldObjects)); + fieldInfo = await orFail(extractFormFieldInfo(pdfDoc)); + } + } finally { + pdfDoc.destroy(); + } + } catch { + // Non-fatal β€” return whatever was assigned before the throw. + } + return { formSchema, fieldInfo }; +} + +/** + * Extract detailed form field info (name, type, page, bounding box, label) + * from a PDF. Bounding boxes are converted to model coordinates (top-left origin). + */ +async function extractFormFieldInfo( + pdfDoc: PDFDocumentProxy, +): Promise { + const fields: FormFieldInfo[] = []; + for (let i = 1; i <= pdfDoc.numPages; i++) { + const page = await pdfDoc.getPage(i); + const pageHeight = page.getViewport({ scale: 1.0 }).height; + const annotations = await page.getAnnotations(); + for (const ann of annotations) { + // Only include form widgets (annotationType 20) + if (ann.annotationType !== 20) continue; + if (!ann.rect) continue; + + const fieldName = ann.fieldName || ""; + const fieldType = ann.fieldType || "unknown"; + + // PDF rect is [x1, y1, x2, y2] in bottom-left origin + const x1 = Math.min(ann.rect[0], ann.rect[2]); + const y1 = Math.min(ann.rect[1], ann.rect[3]); + const x2 = Math.max(ann.rect[0], ann.rect[2]); + const y2 = Math.max(ann.rect[1], ann.rect[3]); + const width = x2 - x1; + const height = y2 - y1; + + // Convert to model coords (top-left origin): modelY = pageHeight - pdfY - height + const modelY = pageHeight - y2; + + // Choice widgets (combo/listbox) carry `options` as + // [{exportValue, displayValue}]. Expose export values β€” that's + // what fill_form needs. + let options: string[] | undefined; + if (Array.isArray(ann.options) && ann.options.length > 0) { + options = ann.options + .map((o: { exportValue?: string }) => o?.exportValue) + .filter((v: unknown): v is string => typeof v === "string"); + } + + fields.push({ + name: fieldName, + type: fieldType, + page: i, + x: Math.round(x1), + y: Math.round(modelY), + width: Math.round(width), + height: Math.round(height), + ...(ann.alternativeText ? { label: ann.alternativeText } : undefined), + // Radio: buttonValue is the per-widget export value β€” the only + // thing distinguishing three `size [Btn]` lines from each other. + ...(ann.radioButton && ann.buttonValue != null + ? { exportValue: String(ann.buttonValue) } + : undefined), + ...(options?.length ? { options } : undefined), + }); + } + } + + return fields; +} + +export async function extractFormSchema( + pdfDoc: PDFDocumentProxy, + fieldObjects: Record | null, +): Promise<{ + type: "object"; + properties: Record; + required?: string[]; +} | null> { + if (!fieldObjects || Object.keys(fieldObjects).length === 0) { + return null; + } + + const properties: Record = {}; + for (const [name, fields] of Object.entries(fieldObjects)) { + // pdfjs returns the full field-tree array: for separated structures + // (pdf-lib) the typed widget is at [1+] behind a container at [0]; for + // merged/leaf entries (W-9, most authoring tools) it's at [0]. Pick the + // first entry that actually has a field type. + const field = fields.find((f) => f.type) ?? fields[0]; + if (!field.editable) continue; + + switch (field.type) { + case "text": + properties[name] = { type: "string", title: name }; + break; + case "checkbox": + properties[name] = { type: "boolean", title: name }; + break; + case "radiobutton": { + const options = fields + .map((f) => f.exportValues) + .filter((v): v is string => !!v && v !== "Off"); + properties[name] = + options.length > 0 + ? { type: "string", title: name, enum: options } + : { type: "string", title: name }; + break; + } + case "combobox": + case "listbox": { + const items = field.items?.map((i) => i.exportValue).filter(Boolean); + properties[name] = + items && items.length > 0 + ? { type: "string", title: name, enum: items } + : { type: "string", title: name }; + break; + } + // Skip "button" (push buttons) and unknown types + } + } + + // Collect alternativeText labels from per-page annotations + // (getFieldObjects doesn't include them) + const fieldLabels = new Map(); + try { + for (let i = 1; i <= pdfDoc.numPages; i++) { + const page = await pdfDoc.getPage(i); + const annotations = await page.getAnnotations(); + for (const ann of annotations) { + if (ann.fieldName && ann.alternativeText) { + fieldLabels.set(ann.fieldName, ann.alternativeText); + } + } + } + } catch { + // ignore + } + + // Use labels as titles where available + for (const [name, prop] of Object.entries(properties)) { + const label = fieldLabels.get(name); + if (label) { + prop.title = label; + } + } + + // If any editable field has a mechanical name (no human-readable label), + // elicitation would be confusing β€” return null to skip it. + const hasMechanicalNames = Object.keys(properties).some((name) => { + if (fieldLabels.has(name)) return false; + return /[[\]().]/.test(name) || /^[A-Z0-9_]+$/.test(name); + }); + + if (Object.keys(properties).length === 0) return null; + if (hasMechanicalNames) return null; + + return { type: "object", properties }; +} + // ============================================================================= // MCP Server Factory // ============================================================================= export interface CreateServerOptions { + /** + * Enable the `interact` tool and related command-queue infrastructure + * (in-memory command queue, `poll_pdf_commands`, `submit_page_data`). + * Only suitable for single-instance deployments (e.g. stdio transport). + * Defaults to false β€” server exposes only `list_pdfs` and `display_pdf` (read-only). + */ + enableInteract?: boolean; + /** * Whether to honour MCP roots sent by the client. * @@ -463,10 +1253,24 @@ export interface CreateServerOptions { * @default false */ useClientRoots?: boolean; + + /** + * Emit debug metadata to the viewer (currently: allowed roots shown + * in a floating bubble). Toggled by the `--debug` CLI flag. + */ + debug?: boolean; } +// Module-level singletons so they survive across createServer() calls β€” in +// stateless HTTP deployments a fresh server is created per request, and +// per-instance caches are discarded immediately. +const sharedPdfCache = createPdfCache(); +let cachedAppHtml: string | undefined; + export function createServer(options: CreateServerOptions = {}): McpServer { - const { useClientRoots = false } = options; + const { enableInteract = false, useClientRoots = false } = options; + const debug = options.debug ?? false; + const disableInteract = !enableInteract; const server = new McpServer({ name: "PDF Server", version: "2.0.0" }); if (useClientRoots) { @@ -475,44 +1279,78 @@ export function createServer(options: CreateServerOptions = {}): McpServer { refreshRoots(server.server); }; server.server.setNotificationHandler( - RootsListChangedNotificationSchema, + "notifications/roots/list_changed", async () => { await refreshRoots(server.server); }, ); - } else { - console.error( - "[pdf-server] Client roots are ignored (default for remote transports). " + - "Pass --use-client-roots to allow the client to expose local directories.", - ); } - // Create session-local cache (isolated per server instance) - const { readPdfRange } = createPdfCache(); + const { readPdfRange } = sharedPdfCache; // Tool: list_pdfs - List available PDFs - server.tool( + server.registerTool( "list_pdfs", - "List available PDFs that can be displayed", - {}, + { + description: "List available PDFs that can be displayed", + inputSchema: z.object({}), + }, async (): Promise => { - const pdfs: Array<{ url: string; type: "local" | "remote" }> = []; + const seen = new Set(); + const localFiles: string[] = []; + const addLocal = (filePath: string) => { + const url = pathToFileUrl(filePath); + if (seen.has(url)) return; + seen.add(url); + localFiles.push(url); + }; - // Add local files - for (const filePath of allowedLocalFiles) { - pdfs.push({ url: pathToFileUrl(filePath), type: "local" }); - } + // Explicitly registered files (CLI args + file roots) + for (const filePath of allowedLocalFiles) addLocal(filePath); + + // Walk directory roots for *.pdf files + const WALK_MAX_DEPTH = 8; + const WALK_MAX_FILES = 500; + let truncated = false; + const walk = async (dir: string, depth: number): Promise => { + if (depth > WALK_MAX_DEPTH || localFiles.length >= WALK_MAX_FILES) { + truncated ||= localFiles.length >= WALK_MAX_FILES; + return; + } + let entries; + try { + entries = await fs.promises.readdir(dir, { withFileTypes: true }); + } catch { + return; // unreadable β€” skip silently + } + for (const e of entries) { + if (localFiles.length >= WALK_MAX_FILES) { + truncated = true; + return; + } + // Skip dotfiles/dirs and common noise + if (e.name.startsWith(".") || e.name === "node_modules") continue; + const full = path.join(dir, e.name); + if (e.isDirectory()) { + await walk(full, depth + 1); + } else if (e.isFile() && /\.pdf$/i.test(e.name)) { + addLocal(full); + } + } + }; + for (const dir of allowedLocalDirs) await walk(dir, 0); // Build text const parts: string[] = []; - if (pdfs.length > 0) { - parts.push( - `Available PDFs:\n${pdfs.map((p) => `- ${p.url} (${p.type})`).join("\n")}`, - ); + if (localFiles.length > 0) { + const header = truncated + ? `Available PDFs (showing first ${WALK_MAX_FILES}):` + : `Available PDFs:`; + parts.push(`${header}\n${localFiles.map((u) => `- ${u}`).join("\n")}`); } if (allowedLocalDirs.size > 0) { parts.push( - `Allowed local directories (from client roots):\n${[...allowedLocalDirs].map((d) => `- ${d}`).join("\n")}\nAny PDF file under these directories can be displayed.`, + `Allowed local directories:\n${[...allowedLocalDirs].map((d) => `- ${d}`).join("\n")}\nAny PDF file under these directories can be displayed.`, ); } parts.push( @@ -522,8 +1360,9 @@ export function createServer(options: CreateServerOptions = {}): McpServer { return { content: [{ type: "text", text: parts.join("\n\n") }], structuredContent: { - localFiles: pdfs.filter((p) => p.type === "local").map((p) => p.url), + localFiles, allowedDirectories: [...allowedLocalDirs], + truncated, }, }; }, @@ -535,8 +1374,9 @@ export function createServer(options: CreateServerOptions = {}): McpServer { "read_pdf_bytes", { title: "Read PDF Bytes", - description: "Read a range of bytes from a PDF (max 512KB per request)", - inputSchema: { + description: + "Read a range of bytes from a PDF (max 512KB per request). The model should NOT call this tool directly.", + inputSchema: z.object({ url: z.string().describe("PDF URL or local file path"), offset: z.number().min(0).default(0).describe("Byte offset"), byteCount: z @@ -545,7 +1385,7 @@ export function createServer(options: CreateServerOptions = {}): McpServer { .max(MAX_CHUNK_BYTES) .default(MAX_CHUNK_BYTES) .describe("Bytes to read"), - }, + }), outputSchema: z.object({ url: z.string(), bytes: z.string().describe("Base64 encoded bytes"), @@ -613,27 +1453,85 @@ export function createServer(options: CreateServerOptions = {}): McpServer { "display_pdf", { title: "Display PDF", - description: `Display an interactive PDF viewer. + description: disableInteract + ? `Show and render a PDF in a read-only viewer. -Accepts: -- Local files explicitly added to the server (use list_pdfs to see available files) -- Local files under directories provided by the client as MCP roots -- Any remote PDF accessible via HTTPS`, - inputSchema: { +Use this tool when the user wants to view or read a PDF. The renderer displays the document for viewing. The widget exposes app-registered tools for page navigation, text extraction, searching, and zoom control. + +Accepts local files (use list_pdfs), client MCP root directories, or any HTTPS URL.` + : `Open a PDF in an interactive viewer. Call this ONCE per PDF. + +**All follow-up actions go through the \`interact\` tool** with the returned viewUUID β€” annotating, signing, stamping, filling forms, navigating, searching, extracting text/screenshots. Calling display_pdf again creates a SEPARATE viewer with a different viewUUID β€” interact calls using the new UUID will not reach the viewer the user already sees. + +Returns a viewUUID in structuredContent. Pass it to \`interact\`: +- add_annotations, update_annotations, remove_annotations, highlight_text +- fill_form (fill PDF form fields) +- navigate, search, find, search_navigate, zoom +- get_text, get_screenshot, get_viewer_state (extract content / read selection & current page) +- save_as (write annotated PDF to disk) + +Accepts local files (use list_pdfs), client MCP root directories, or any HTTPS URL. +Set \`elicit_form_inputs\` to true to prompt the user to fill form fields before display.`, + inputSchema: z.object({ url: z .string() .default(DEFAULT_PDF) .describe("PDF URL or local file path"), page: z.number().min(1).default(1).describe("Initial page"), - }, + ...(disableInteract + ? {} + : { + elicit_form_inputs: z + .boolean() + .default(false) + .describe( + "If true and the PDF has form fields, prompt the user to fill them before displaying", + ), + }), + }), outputSchema: z.object({ + viewUUID: z + .string() + .describe( + "UUID for this viewer instance" + + (disableInteract ? "" : " β€” pass to interact tool"), + ), url: z.string(), initialPage: z.number(), totalBytes: z.number(), + formFieldValues: z + .record(z.string(), z.union([z.string(), z.boolean()])) + .optional() + .describe("Form field values filled by the user via elicitation"), + formFields: z + .array( + z.object({ + name: z.string(), + type: z.string(), + page: z.number(), + label: z.string().optional(), + x: z.number(), + y: z.number(), + width: z.number(), + height: z.number(), + exportValue: z + .string() + .optional() + .describe("Radio button value β€” pass this to fill_form"), + options: z + .array(z.string()) + .optional() + .describe("Dropdown/listbox option values"), + }), + ) + .optional() + .describe( + "Form fields with bounding boxes in model coordinates (top-left origin)", + ), }), _meta: { ui: { resourceUri: RESOURCE_URI } }, }, - async ({ url, page }): Promise => { + async ({ url, page, elicit_form_inputs }): Promise => { const normalized = isArxivUrl(url) ? normalizeArxivUrl(url) : url; const validation = validateUrl(normalized); @@ -646,21 +1544,1364 @@ Accepts: // Probe file size so the client can set up range transport without an extra fetch const { totalBytes } = await readPdfRange(normalized, 0, 1); + const uuid = randomUUID(); + // Start the heartbeat now so the sweep can clean up viewFieldNames/ + // viewFileWatches even if no interact calls ever happen. + if (!disableInteract) touchView(uuid); + + // Check writability (governs save button; see isWritablePath doc). + // Also requires OS-level W_OK so we don't lie on read-only mounts. + let writable = false; + let debugResolved: string | undefined; // only used when --debug + if (isFileUrl(normalized) || isLocalPath(normalized)) { + const localPath = isFileUrl(normalized) + ? fileUrlToPath(normalized) + : decodeURIComponent(normalized); + const resolved = path.resolve(localPath); + debugResolved = resolved; + if (!disableInteract) viewSourcePaths.set(uuid, resolved); + if (isWritablePath(resolved)) { + try { + await fs.promises.access(resolved, fs.constants.W_OK); + writable = true; + } catch { + // Not writable β€” leave false + } + } + // Watch for external changes (stdio only β€” needs the poll channel) + if (!disableInteract) { + startFileWatch(uuid, localPath); + } + } + + const { formSchema, fieldInfo } = await probeFormFields( + normalized, + totalBytes, + readPdfRange, + ); + if (formSchema) { + viewFieldNames.set(uuid, new Set(Object.keys(formSchema.properties))); + } + if (fieldInfo.length > 0 && !viewFieldNames.has(uuid)) { + viewFieldNames.set( + uuid, + new Set(fieldInfo.map((f) => f.name).filter(Boolean)), + ); + } + + // Elicit form field values if requested and client supports it + let formFieldValues: Record | undefined; + let elicitResult: ElicitResult | undefined; + if (elicit_form_inputs && formSchema) { + const clientCaps = server.server.getClientCapabilities(); + if (clientCaps?.elicitation?.form) { + try { + elicitResult = await server.server.elicitInput({ + message: `Please fill in the PDF form fields for "${normalized.split("/").pop() || normalized}":`, + requestedSchema: formSchema, + }); + if (elicitResult.action === "accept" && elicitResult.content) { + formFieldValues = {}; + for (const [k, v] of Object.entries(elicitResult.content)) { + if (typeof v === "string" || typeof v === "boolean") { + formFieldValues[k] = v; + } + } + // Queue fill_form command so the viewer picks it up + enqueueCommand(uuid, { + type: "fill_form", + fields: Object.entries(formFieldValues).map( + ([name, value]) => ({ name, value }), + ), + }); + } + } catch (err) { + // Elicitation failed β€” continue without form values + console.error("[pdf-server] Form elicitation failed:", err); + } + } + } + + const contentParts: Array<{ type: "text"; text: string }> = [ + { + type: "text", + text: disableInteract + ? `Displaying PDF: ${normalized}` + : `PDF opened. viewUUID: ${uuid} + +β†’ To annotate, sign, stamp, fill forms, navigate, extract, or save to a file: call \`interact\` with this viewUUID. +β†’ DO NOT call display_pdf again β€” that spawns a separate viewer with a different viewUUID; your interact calls would target the new empty one, not the one the user is looking at. + +URL: ${normalized}`, + }, + ]; + + if (formFieldValues && Object.keys(formFieldValues).length > 0) { + const fieldSummary = Object.entries(formFieldValues) + .map( + ([name, value]) => + ` ${name}: ${typeof value === "boolean" ? (value ? "checked" : "unchecked") : value}`, + ) + .join("\n"); + contentParts.push({ + type: "text", + text: `\nUser-provided form field values:\n${fieldSummary}`, + }); + } else if ( + elicit_form_inputs && + elicitResult && + elicitResult.action !== "accept" + ) { + contentParts.push({ + type: "text", + text: `\nForm elicitation was ${elicitResult.action}d by the user.`, + }); + } + + // Include detailed form field info so the model can locate and fill fields + if (fieldInfo.length > 0) { + // Group by page + const byPage = new Map(); + for (const f of fieldInfo) { + let list = byPage.get(f.page); + if (!list) { + list = []; + byPage.set(f.page, list); + } + list.push(f); + } + const lines: string[] = [ + `\nForm fields (${fieldInfo.length})${disableInteract ? "" : " β€” use fill_form with {name, value}"}:`, + ]; + for (const [pg, fields] of [...byPage.entries()].sort( + (a, b) => a[0] - b[0], + )) { + lines.push(` Page ${pg}:`); + for (const f of fields) { + const label = f.label ? ` "${f.label}"` : ""; + const nameStr = f.name || "(unnamed)"; + // Radio: = tells the model what value to pass. + // Dropdown: options:[...] lists valid choices. + const exportSuffix = f.exportValue ? `=${f.exportValue}` : ""; + const optsSuffix = f.options + ? ` options:[${f.options.join(", ")}]` + : ""; + lines.push( + ` ${nameStr}${exportSuffix}${label} [${f.type}] at (${f.x},${f.y}) ${f.width}Γ—${f.height}${optsSuffix}`, + ); + } + } + contentParts.push({ type: "text", text: lines.join("\n") }); + } else { + // Fallback to simple field name listing if detailed info unavailable + const fieldNames = viewFieldNames.get(uuid); + if (fieldNames && fieldNames.size > 0) { + contentParts.push({ + type: "text", + text: `\nForm fields${disableInteract ? "" : " available for fill_form"}: ${[...fieldNames].join(", ")}`, + }); + } + } return { - content: [{ type: "text", text: `Displaying PDF: ${normalized}` }], + content: contentParts, structuredContent: { + viewUUID: uuid, url: normalized, initialPage: page, totalBytes, + ...(formFieldValues ? { formFieldValues } : {}), + ...(fieldInfo.length > 0 ? { formFields: fieldInfo } : {}), }, _meta: { - viewUUID: randomUUID(), + viewUUID: uuid, + interactEnabled: !disableInteract, + writable, + // Debug: viewer renders this in a floating bubble (--debug flag). + ...(debug + ? { + _debug: { + resolved: debugResolved, + writable, + isWritablePath: debugResolved + ? isWritablePath(debugResolved) + : undefined, + cliLocalFiles: [...cliLocalFiles], + allowedLocalFiles: [...allowedLocalFiles], + allowedLocalDirs: [...allowedLocalDirs], + }, + } + : {}), }, }; }, ); + if (!disableInteract) { + // Schema for a single interact command (used in commands array) + const InteractCommandSchema = z.object({ + action: z + .enum([ + "navigate", + "search", + "find", + "search_navigate", + "zoom", + "add_annotations", + "update_annotations", + "remove_annotations", + "highlight_text", + "fill_form", + "get_text", + "get_screenshot", + "get_viewer_state", + "save_as", + ]) + .describe("Action to perform"), + page: z + .number() + .min(1) + .optional() + .describe( + "Page number (for navigate, highlight_text, get_screenshot, get_text)", + ), + query: z + .string() + .optional() + .describe("Search text (for search / find / highlight_text)"), + matchIndex: z + .number() + .min(0) + .optional() + .describe("Match index (for search_navigate)"), + scale: z + .number() + .min(0.5) + .max(3.0) + .optional() + .describe("Zoom scale, 1.0 = 100% (for zoom)"), + annotations: z + .array(z.record(z.string(), z.any())) + .optional() + .describe( + "Annotation objects (see types in description). Each needs: id, type, page. For update_annotations only id+type are required.", + ), + ids: z + .array(z.string()) + .optional() + .describe("Annotation IDs (for remove_annotations)"), + color: z + .string() + .optional() + .describe("Color override (for highlight_text)"), + content: z + .string() + .optional() + .describe("Tooltip/note content (for highlight_text)"), + fields: z + .array(FormField) + .optional() + .describe( + "Form fields to fill (for fill_form): { name, value } where value is string or boolean", + ), + intervals: z + .array(PageInterval) + .optional() + .describe( + "Page ranges for get_text. Each has optional start/end. [{start:1,end:5}], [{}] = all pages. Max 20 pages.", + ), + path: z + .string() + .optional() + .describe( + "Target file path for save_as. Absolute path or file:// URL. Omit to overwrite the original file (requires overwrite: true).", + ), + overwrite: z + .boolean() + .optional() + .describe("Overwrite if file exists (for save_as). Default false."), + }); + + type InteractCommand = z.infer; + type ContentPart = + | { type: "text"; text: string } + | { type: "image"; data: string; mimeType: string }; + + /** + * Resolve an image annotation: fetch imageUrl β†’ imageData if needed, + * auto-detect dimensions, and set defaults for x/y. + * + * SECURITY: imageUrl is model-controlled. It must pass the same + * validateUrl() gate as display_pdf/save_pdf β€” otherwise the model + * can request `{imageUrl:"/Users/x/.ssh/id_rsa"}`, we'd readFile it, + * base64 the bytes, ship them to the iframe, and get_screenshot (or + * any future echo path) reads them back. Throws on rejection so the + * tool result carries the error; silent skip hides the attack attempt. + */ + async function resolveImageAnnotation( + ann: Record, + ): Promise { + // Fetch image data from URL if no imageData provided + if (!ann.imageData && ann.imageUrl) { + const url = String(ann.imageUrl); + // Same gate as every other local/remote read in this server. + // Local: must be in allowedLocalFiles or under allowedLocalDirs. + // Remote: must be https://. + const check = validateUrl(url); + if (!check.valid) { + throw new Error( + `imageUrl rejected by validateUrl: ${check.error ?? url}`, + ); + } + let imgBytes: Uint8Array; + if (url.startsWith("https://")) { + const resp = await fetch(url); + if (!resp.ok) throw new Error(`HTTP ${resp.status} for ${url}`); + imgBytes = new Uint8Array(await resp.arrayBuffer()); + } else { + // validateUrl already confirmed this path is under an allowed root. + const filePath = isFileUrl(url) + ? fileUrlToPath(url) + : decodeURIComponent(url); + imgBytes = await fs.promises.readFile(path.resolve(filePath)); + } + ann.imageData = Buffer.from(imgBytes).toString("base64"); + } + + // Auto-detect mimeType from magic bytes if not set + if (ann.imageData && !ann.mimeType) { + const bytes = Buffer.from(ann.imageData, "base64"); + if ( + bytes[0] === 0x89 && + bytes[1] === 0x50 && + bytes[2] === 0x4e && + bytes[3] === 0x47 + ) { + ann.mimeType = "image/png"; + } else { + ann.mimeType = "image/jpeg"; + } + } + + // Auto-detect dimensions from image if not specified + if (ann.imageData && (ann.width == null || ann.height == null)) { + const dims = detectImageDimensions( + Buffer.from(ann.imageData, "base64"), + ); + if (dims) { + const maxWidth = 200; // default max width in PDF points + const aspectRatio = dims.height / dims.width; + ann.width = ann.width ?? Math.min(dims.width, maxWidth); + ann.height = ann.height ?? ann.width * aspectRatio; + } else { + ann.width = ann.width ?? 200; + ann.height = ann.height ?? 200; + } + } + + // Default position if not specified + ann.x = ann.x ?? 72; + ann.y = ann.y ?? 72; + } + + /** + * Detect image dimensions from PNG or JPEG bytes. + */ + function detectImageDimensions( + bytes: Buffer, + ): { width: number; height: number } | null { + // PNG: width at offset 16 (4 bytes BE), height at offset 20 (4 bytes BE) + if ( + bytes[0] === 0x89 && + bytes[1] === 0x50 && + bytes[2] === 0x4e && + bytes[3] === 0x47 + ) { + if (bytes.length >= 24) { + const width = bytes.readUInt32BE(16); + const height = bytes.readUInt32BE(20); + return { width, height }; + } + } + // JPEG: scan for SOF0/SOF2 markers (0xFF 0xC0 / 0xFF 0xC2) + if (bytes[0] === 0xff && bytes[1] === 0xd8) { + let offset = 2; + while (offset < bytes.length - 8) { + if (bytes[offset] !== 0xff) break; + const marker = bytes[offset + 1]; + if (marker === 0xc0 || marker === 0xc2) { + const height = bytes.readUInt16BE(offset + 5); + const width = bytes.readUInt16BE(offset + 7); + return { width, height }; + } + const segLen = bytes.readUInt16BE(offset + 2); + offset += 2 + segLen; + } + } + return null; + } + + /** Process a single interact command. Returns content parts and an isError flag. */ + async function processInteractCommand( + uuid: string, + cmd: InteractCommand, + signal?: AbortSignal, + ): Promise<{ content: ContentPart[]; isError?: boolean }> { + const { + action, + page, + query, + matchIndex, + scale, + annotations, + ids, + color, + content, + fields, + intervals, + path: savePath, + overwrite, + } = cmd; + + let description: string; + switch (action) { + case "navigate": + if (page == null) + return { + content: [{ type: "text", text: "navigate requires `page`" }], + isError: true, + }; + enqueueCommand(uuid, { type: "navigate", page }); + description = `navigate to page ${page}`; + break; + case "search": + if (!query) + return { + content: [{ type: "text", text: "search requires `query`" }], + isError: true, + }; + enqueueCommand(uuid, { type: "search", query }); + description = `search for "${query}"`; + break; + case "find": + if (!query) + return { + content: [{ type: "text", text: "find requires `query`" }], + isError: true, + }; + enqueueCommand(uuid, { type: "find", query }); + description = `find "${query}" (silent)`; + break; + case "search_navigate": + if (matchIndex == null) + return { + content: [ + { + type: "text", + text: "search_navigate requires `matchIndex`", + }, + ], + isError: true, + }; + enqueueCommand(uuid, { type: "search_navigate", matchIndex }); + description = `go to match #${matchIndex}`; + break; + case "zoom": + if (scale == null) + return { + content: [{ type: "text", text: "zoom requires `scale`" }], + isError: true, + }; + enqueueCommand(uuid, { type: "zoom", scale }); + description = `zoom to ${Math.round(scale * 100)}%`; + break; + case "add_annotations": + if (!annotations || annotations.length === 0) + return { + content: [ + { + type: "text", + text: "add_annotations requires `annotations` array", + }, + ], + isError: true, + }; + // Resolve image annotations: fetch imageUrl β†’ imageData, auto-detect dimensions. + // Rejection (path not allowed, not https, fetch failed) surfaces as + // a tool error so the model sees it β€” don't silently skip. + try { + for (const ann of annotations) { + if ((ann as any).type === "image") { + await resolveImageAnnotation(ann as any); + } + } + } catch (err) { + return { + content: [ + { + type: "text", + text: `add_annotations: ${err instanceof Error ? err.message : String(err)}`, + }, + ], + isError: true, + }; + } + enqueueCommand(uuid, { + type: "add_annotations", + // resolveImageAnnotation populates optional x/y/width/height; + // input is validated as Record[] so this cast is + // the wire-protocol promise, not a compiler guarantee. + annotations: annotations as Extract< + PdfCommand, + { type: "add_annotations" } + >["annotations"], + }); + description = `add ${annotations.length} annotation(s)`; + break; + case "update_annotations": + if (!annotations || annotations.length === 0) + return { + content: [ + { + type: "text", + text: "update_annotations requires `annotations` array", + }, + ], + isError: true, + }; + enqueueCommand(uuid, { + type: "update_annotations", + annotations: annotations as Extract< + PdfCommand, + { type: "update_annotations" } + >["annotations"], + }); + description = `update ${annotations.length} annotation(s)`; + break; + case "remove_annotations": + if (!ids || ids.length === 0) + return { + content: [ + { + type: "text", + text: "remove_annotations requires `ids` array", + }, + ], + isError: true, + }; + enqueueCommand(uuid, { type: "remove_annotations", ids }); + description = `remove ${ids.length} annotation(s)`; + break; + case "highlight_text": { + if (!query) + return { + content: [ + { type: "text", text: "highlight_text requires `query`" }, + ], + isError: true, + }; + const id = `ht_${Date.now()}_${Math.random().toString(36).slice(2, 8)}`; + enqueueCommand(uuid, { + type: "highlight_text", + id, + query, + page, + color, + content, + }); + description = `highlight text "${query}"${page ? ` on page ${page}` : ""}`; + break; + } + case "fill_form": { + if (!fields || fields.length === 0) + return { + content: [ + { type: "text", text: "fill_form requires `fields` array" }, + ], + isError: true, + }; + const knownFields = viewFieldNames.get(uuid); + const validFields: typeof fields = []; + const unknownNames: string[] = []; + for (const f of fields) { + if (knownFields && !knownFields.has(f.name)) { + unknownNames.push(f.name); + } else { + validFields.push(f); + } + } + if (validFields.length > 0) { + enqueueCommand(uuid, { type: "fill_form", fields: validFields }); + } + const parts: string[] = []; + if (validFields.length > 0) { + parts.push( + `Filled ${validFields.length} field(s): ${validFields.map((f) => f.name).join(", ")}`, + ); + } + if (unknownNames.length > 0) { + parts.push(`Unknown field(s) skipped: ${unknownNames.join(", ")}`); + // Only list valid names when the model got something wrong β€” + // display_pdf already returned the full field info on open. + if (knownFields && knownFields.size > 0) { + parts.push(`Valid field names: ${[...knownFields].join(", ")}`); + } + } + description = parts.join(". "); + if (unknownNames.length > 0 && validFields.length === 0) { + return { + content: [{ type: "text", text: description }], + isError: true, + }; + } + break; + } + case "get_text": { + const resolvedIntervals = + intervals ?? (page ? [{ start: page, end: page }] : [{}]); + + const requestId = randomUUID(); + + enqueueCommand(uuid, { + type: "get_pages", + requestId, + intervals: resolvedIntervals, + getText: true, + getScreenshots: false, + }); + + let pageData: PageDataEntry[]; + try { + await ensureViewerIsPolling(uuid); + pageData = await waitForPageData(requestId, signal); + } catch (err) { + return { + content: [ + { + type: "text", + text: `Error: ${err instanceof Error ? err.message : String(err)}`, + }, + ], + isError: true, + }; + } + + const textParts: ContentPart[] = []; + for (const entry of pageData) { + if (entry.text != null) { + textParts.push({ + type: "text", + text: `--- Page ${entry.page} ---\n${entry.text}`, + }); + } + } + if (textParts.length === 0) { + textParts.push({ type: "text", text: "No text content returned" }); + } + return { content: textParts }; + } + case "get_screenshot": { + if (page == null) + return { + content: [ + { type: "text", text: "get_screenshot requires `page`" }, + ], + isError: true, + }; + + const requestId = randomUUID(); + + enqueueCommand(uuid, { + type: "get_pages", + requestId, + intervals: [{ start: page, end: page }], + getText: false, + getScreenshots: true, + }); + + let pageData: PageDataEntry[]; + try { + await ensureViewerIsPolling(uuid); + pageData = await waitForPageData(requestId, signal); + } catch (err) { + return { + content: [ + { + type: "text", + text: `Error: ${err instanceof Error ? err.message : String(err)}`, + }, + ], + isError: true, + }; + } + + const entry = pageData[0]; + if (entry?.image) { + return { + content: [ + { + type: "image", + data: entry.image, + mimeType: "image/jpeg", + }, + ], + }; + } + return { + content: [{ type: "text", text: "No screenshot returned" }], + isError: true, + }; + } + case "save_as": { + const saveErr = (text: string) => ({ + content: [{ type: "text" as const, text }], + isError: true as const, + }); + + let resolved: string; + if (savePath) { + // Explicit target. Same path normalisation as save_pdf β€” but NOT + // validateUrl(), which fails on non-existent files. + const filePath = isFileUrl(savePath) + ? fileUrlToPath(savePath) + : isLocalPath(savePath) + ? decodeURIComponent(savePath) + : null; + if (!filePath) + return saveErr( + "save_as: path must be an absolute local path or file:// URL", + ); + resolved = path.resolve(filePath); + if (!isWritablePath(resolved)) + return saveErr( + `save_as refused: ${resolved} is not under a mounted ` + + `directory root. Only paths under directory roots ` + + `(or files passed as CLI args) are writable.`, + ); + if (!overwrite && fs.existsSync(resolved)) + return saveErr( + `File already exists: ${resolved}. ` + + `Set overwrite: true to replace it, or choose a different path.`, + ); + } else { + // No target β†’ overwrite the original. Same gate as the viewer's + // save button: isWritablePath + OS-level W_OK (so we don't try + // on read-only mounts). Remote PDFs have no source path stored. + const source = viewSourcePaths.get(uuid); + if (!source) + return saveErr( + "save_as: no `path` given and this viewer has no local source " + + "file to overwrite (it's a remote URL, or the viewUUID is " + + "stale/unknown). Provide an explicit `path`.", + ); + if (!overwrite) + return saveErr( + `save_as: omitting \`path\` overwrites the original ` + + `(${source}). Set overwrite: true to confirm.`, + ); + if (!isWritablePath(source)) + return saveErr( + `save_as refused: ${source} is not writable (the viewer's ` + + `save button is hidden for the same reason).`, + ); + try { + await fs.promises.access(source, fs.constants.W_OK); + } catch { + return saveErr( + `save_as refused: ${source} is not writable at the OS level ` + + `(read-only mount or insufficient permissions).`, + ); + } + resolved = source; + } + + const requestId = randomUUID(); + enqueueCommand(uuid, { type: "save_as", requestId }); + let data: string; + try { + await ensureViewerIsPolling(uuid); + data = await waitForSaveData(requestId, signal); + } catch (err) { + return saveErr( + `save_as failed: ${err instanceof Error ? err.message : String(err)}`, + ); + } + try { + const bytes = Buffer.from(data, "base64"); + await fs.promises.writeFile(resolved, bytes); + return { + content: [ + { + type: "text", + text: `Saved annotated PDF to ${resolved} (${bytes.length} bytes)`, + }, + ], + }; + } catch (err) { + return saveErr( + `save_as: failed to write ${resolved}: ${err instanceof Error ? err.message : String(err)}`, + ); + } + } + case "get_viewer_state": { + const requestId = randomUUID(); + enqueueCommand(uuid, { type: "get_viewer_state", requestId }); + let state: string; + try { + await ensureViewerIsPolling(uuid); + state = await waitForViewerState(requestId, signal); + } catch (err) { + return { + content: [ + { + type: "text", + text: `Error: ${err instanceof Error ? err.message : String(err)}`, + }, + ], + isError: true, + }; + } + return { content: [{ type: "text", text: state }] }; + } + default: + return { + content: [{ type: "text", text: `Unknown action: ${action}` }], + isError: true, + }; + } + return { + content: [{ type: "text", text: `Queued: ${description}` }], + }; + } + + // Tool: interact - Interact with an existing PDF viewer + server.registerTool( + "interact", + { + title: "Interact with PDF", + description: `Interact with a PDF viewer: annotate, navigate, search, extract text/screenshots, fill forms. +IMPORTANT: viewUUID must be the exact UUID returned by display_pdf (e.g. "a1b2c3d4-..."). Do NOT use arbitrary strings. + +**BATCHING**: Send multiple commands in one call via \`commands\` array. Commands run sequentially; results are returned in the same order, one content item per command. If a command fails, the batch stops there and that command's slot contains text starting with \`ERROR\` β€” content.length tells you how far it got. TIP: End with \`get_screenshot\` to verify your changes. + +**ANNOTATION** β€” add_annotations with array of annotation objects. Each needs: id (unique string), type, page (1-indexed). + +**COORDINATE SYSTEM**: PDF points (1pt = 1/72in), origin at page TOP-LEFT corner. X increases rightward, Y increases downward. +- US Letter = 612Γ—792pt. Margins: topβ‰ˆy=50, bottomβ‰ˆy=742, leftβ‰ˆx=72, rightβ‰ˆx=540, centerβ‰ˆ(306, 396). +- Rectangle/circle/stamp x,y is the TOP-LEFT corner. To place a 200Γ—30 box at the TOP of the page: x=72, y=50, width=200, height=30. +- For highlights/underlines, each rect's y is the TOP of the highlighted region. + +Annotation types: +β€’ highlight: rects:[{x,y,width,height}], color?, content? β€’ underline: rects:[{x,y,w,h}], color? +β€’ strikethrough: rects:[{x,y,w,h}], color? β€’ note: x, y, content, color? +β€’ rectangle: x, y, width, height, color?, fillColor?, rotation? β€’ circle: x, y, width, height, color?, fillColor? +β€’ line: x1, y1, x2, y2, color? β€’ freetext: x, y, content, fontSize?, color? +β€’ stamp: x, y, label (any text, e.g. APPROVED, DRAFT, CONFIDENTIAL), color?, rotation? +β€’ image: imageUrl (required), x?, y?, width?, height?, mimeType?, rotation?, aspect? β€” places an image (signature, logo, etc.) on the page. Pass a local file path or HTTPS URL (NO data: URIs, NO base64). Width/height auto-detected if omitted. Users can also drag & drop images directly onto the viewer. + +TIP: For text annotations, prefer highlight_text (auto-finds text) over manual rects. + +Example β€” add a signature image and a stamp, then screenshot to verify: +\`\`\`json +{"viewUUID":"…","commands":[ + {"action":"add_annotations","annotations":[ + {"id":"sig1","type":"image","page":1,"x":72,"y":700,"imageUrl":"/path/to/signature.png"}, + {"id":"s1","type":"stamp","page":1,"x":300,"y":400,"label":"APPROVED"} + ]}, + {"action":"get_screenshot","page":1} +]} +\`\`\` + +β€’ highlight_text: auto-find and highlight text (query, page?, color?, content?) +β€’ update_annotations: partial update (id+type required) β€’ remove_annotations: remove by ids + +**NAVIGATION**: navigate (page), search (query), find (query, silent), search_navigate (matchIndex), zoom (scale 0.5–3.0) + +**TEXT/SCREENSHOTS**: +β€’ get_text: extract text from pages. Optional \`page\` for single page, or \`intervals\` for ranges [{start?,end?}]. Max 20 pages. +β€’ get_screenshot: capture a single page as PNG image. Requires \`page\`. +β€’ get_viewer_state: snapshot of the live viewer β€” JSON {currentPage, pageCount, zoom, displayMode, selectedAnnotationIds, selection:{text,contextBefore,contextAfter,boundingRect}|null}. Use this to read what the user has selected or which page they're on. + +**FORMS** β€” fill_form: fill fields with \`fields\` array of {name, value}. + +**SAVE** β€” save_as: write the annotated PDF (annotations + form values) to a file. Pass \`path\` (absolute path or file://) for a new location, or omit \`path\` to overwrite the original. Set \`overwrite: true\` to replace an existing file (always required when omitting \`path\`).`, + inputSchema: z.object({ + viewUUID: z + .string() + .describe( + "The viewUUID of the PDF viewer (from display_pdf result)", + ), + // Single-command mode (backwards-compatible) + action: z + .enum([ + "navigate", + "search", + "find", + "search_navigate", + "zoom", + "add_annotations", + "update_annotations", + "remove_annotations", + "highlight_text", + "fill_form", + "get_text", + "get_screenshot", + "get_viewer_state", + "save_as", + ]) + .optional() + .describe( + "Action to perform (for single command). Use `commands` array for batching.", + ), + page: z + .number() + .min(1) + .optional() + .describe( + "Page number (for navigate, highlight_text, get_screenshot, get_text)", + ), + query: z + .string() + .optional() + .describe("Search text (for search / find / highlight_text)"), + matchIndex: z + .number() + .min(0) + .optional() + .describe("Match index (for search_navigate)"), + scale: z + .number() + .min(0.5) + .max(3.0) + .optional() + .describe("Zoom scale, 1.0 = 100% (for zoom)"), + annotations: z + .array(z.record(z.string(), z.any())) + .optional() + .describe( + "Annotation objects (see types in description). Each needs: id, type, page. For update_annotations only id+type are required.", + ), + ids: z + .array(z.string()) + .optional() + .describe("Annotation IDs (for remove_annotations)"), + color: z + .string() + .optional() + .describe("Color override (for highlight_text)"), + content: z + .string() + .optional() + .describe("Tooltip/note content (for highlight_text)"), + fields: z + .array(FormField) + .optional() + .describe( + "Form fields to fill (for fill_form): { name, value } where value is string or boolean", + ), + intervals: z + .array(PageInterval) + .optional() + .describe( + "Page ranges for get_text. Each has optional start/end. [{start:1,end:5}], [{}] = all pages. Max 20 pages.", + ), + path: z + .string() + .optional() + .describe( + "Target file path for save_as. Absolute path or file:// URL. Omit to overwrite the original file (requires overwrite: true).", + ), + overwrite: z + .boolean() + .optional() + .describe("Overwrite if file exists (for save_as). Default false."), + // Batch mode + commands: z + .array(InteractCommandSchema) + .optional() + .describe( + "Array of commands to execute sequentially. More efficient than separate calls. Tip: end with get_pages+getScreenshots to verify changes.", + ), + }), + }, + async ( + { + viewUUID: uuid, + action, + page, + query, + matchIndex, + scale, + annotations, + ids, + color, + content, + fields, + intervals, + path: savePath, + overwrite, + commands, + }, + extra, + ): Promise => { + // Build the list of commands to process + const commandList: InteractCommand[] = commands + ? commands + : action + ? [ + { + action, + page, + query, + matchIndex, + scale, + annotations, + ids, + color, + content, + fields, + intervals, + path: savePath, + overwrite, + }, + ] + : []; + + if (commandList.length === 0) { + return { + content: [ + { + type: "text", + text: "No action or commands specified. Provide either `action` (single command) or `commands` (batch).", + }, + ], + isError: true, + }; + } + + // 1:1 content array β€” content[i] is the result of commands[i]. + // + // For multi-step batches we do NOT set isError on a step failure: + // LocalAgentMode SDK 2.1.87 collapses isError:true results to a + // bare string of content[0].text, which would drop any images + // from earlier successful steps. Instead, the failed step's slot + // is text starting with "ERROR", and the batch stops there β€” the + // model reads content.length to see how far it got. + // + // Single-command calls have no prior results to lose, so they + // keep isError:true. The SDK's flatten-to-content[0].text is + // exactly the ERROR text we want it to see. + const allContent: ContentPart[] = []; + let failedAt = -1; + const t0 = Date.now(); + + for (let i = 0; i < commandList.length; i++) { + const result = await processInteractCommand( + uuid, + commandList[i], + extra.mcpReq.signal, + ); + if (result.isError) { + const errText = result.content + .map((c) => (c.type === "text" ? c.text : null)) + .filter((t) => t != null) + .join(" β€” "); + // Normalize the prefix β€” processInteractCommand's catch blocks + // are inconsistent ("Error: ...", "add_annotations: ...", etc.) + const stripped = errText.replace(/^error:\s*/i, ""); + allContent.push({ + type: "text", + text: + commandList.length > 1 + ? `ERROR at step ${i + 1}/${commandList.length} (${commandList[i].action}): ${stripped}` + : `ERROR: ${stripped}`, + }); + failedAt = i; + console.error( + `[interact] uuid=${uuid} step ${i + 1}/${commandList.length} ` + + `(${commandList[i].action}) failed after ${Date.now() - t0}ms: ${stripped}`, + ); + break; + } + // Squash multi-part successes (e.g. get_text returning multiple + // text blocks) into one slot so 1:1 indexing holds. Preserve a + // lone image as-is β€” that's the screenshot the model wants. + if (result.content.length === 1) { + allContent.push(result.content[0]); + } else { + const texts = result.content + .map((c) => (c.type === "text" ? c.text : null)) + .filter((t) => t != null); + allContent.push({ type: "text", text: texts.join("\n") }); + } + } + + return { + content: allContent, + // isError flattens to a string in some SDKs, losing the array + // shape. Only set it when there was never going to be an array + // β€” single command, no positional contract to break. + ...(failedAt >= 0 && commandList.length === 1 + ? { isError: true } + : {}), + }; + }, + ); + + // Tool: submit_page_data (app-only) - Client submits rendered page data + registerAppTool( + server, + "submit_page_data", + { + title: "Submit Page Data", + description: + "Submit rendered page data for a get_pages request (used by viewer). The model should NOT call this tool directly.", + inputSchema: z.object({ + requestId: z + .string() + .describe("The request ID from the get_pages command"), + pages: z + .array( + z.object({ + page: z.number(), + text: z.string().optional(), + image: z.string().optional().describe("Base64 PNG image data"), + }), + ) + .describe("Page data entries"), + }), + _meta: { ui: { visibility: ["app"] } }, + }, + async ({ requestId, pages }): Promise => { + const settle = pendingPageRequests.get(requestId); + if (settle) { + settle(pages); + return { + content: [ + { type: "text", text: `Submitted ${pages.length} page(s)` }, + ], + }; + } + return { + content: [ + { type: "text", text: `No pending request for ${requestId}` }, + ], + isError: true, + }; + }, + ); + + // Tool: submit_save_data (app-only) - Viewer submits annotated PDF bytes + registerAppTool( + server, + "submit_save_data", + { + title: "Submit Save Data", + description: + "Submit annotated PDF bytes for a save_as request (used by viewer). The model should NOT call this tool directly.", + inputSchema: z.object({ + requestId: z + .string() + .describe("The request ID from the save_as command"), + data: z.string().optional().describe("Base64-encoded PDF bytes"), + error: z + .string() + .optional() + .describe("Error message if the viewer failed to build bytes"), + }), + _meta: { ui: { visibility: ["app"] } }, + }, + async ({ requestId, data, error }): Promise => { + const settle = pendingSaveRequests.get(requestId); + if (!settle) { + return { + content: [ + { type: "text", text: `No pending request for ${requestId}` }, + ], + isError: true, + }; + } + if (error || !data) { + settle(new Error(error || "Viewer returned no data")); + } else { + settle(data); + } + return { content: [{ type: "text", text: "Submitted" }] }; + }, + ); + + // Tool: submit_viewer_state (app-only) - Viewer reports its live state + registerAppTool( + server, + "submit_viewer_state", + { + title: "Submit Viewer State", + description: + "Submit a viewer-state snapshot for a get_viewer_state request (used by viewer). The model should NOT call this tool directly.", + inputSchema: z.object({ + requestId: z + .string() + .describe("The request ID from the get_viewer_state command"), + state: z + .string() + .optional() + .describe("JSON-encoded viewer state snapshot"), + error: z + .string() + .optional() + .describe("Error message if the viewer failed to read state"), + }), + _meta: { ui: { visibility: ["app"] } }, + }, + async ({ requestId, state, error }): Promise => { + const settle = pendingStateRequests.get(requestId); + if (!settle) { + return { + content: [ + { type: "text", text: `No pending request for ${requestId}` }, + ], + isError: true, + }; + } + if (error || !state) { + settle(new Error(error || "Viewer returned no state")); + } else { + settle(state); + } + return { content: [{ type: "text", text: "Submitted" }] }; + }, + ); + + // Tool: poll_pdf_commands (app-only) - Poll for pending commands + registerAppTool( + server, + "poll_pdf_commands", + { + title: "Poll PDF Commands", + description: + "Poll for pending commands for a PDF viewer. The model should NOT call this tool directly.", + inputSchema: z.object({ + viewUUID: z.string().describe("The viewUUID of the PDF viewer"), + }), + _meta: { ui: { visibility: ["app"] } }, + }, + async ({ viewUUID: uuid }): Promise => { + viewsPolled.add(uuid); + // If commands are already queued, wait briefly to let more accumulate + if (commandQueues.has(uuid)) { + await new Promise((r) => setTimeout(r, POLL_BATCH_WAIT_MS)); + } else { + // Long-poll: wait for commands to arrive or timeout + await new Promise((resolve) => { + const timer = setTimeout(() => { + pollWaiters.delete(uuid); + resolve(); + }, LONG_POLL_TIMEOUT_MS); + // Cancel any existing waiter for this uuid + const prev = pollWaiters.get(uuid); + if (prev) prev(); + pollWaiters.set(uuid, () => { + clearTimeout(timer); + resolve(); + }); + }); + // After waking, wait briefly for batching + if (commandQueues.has(uuid)) { + await new Promise((r) => setTimeout(r, POLL_BATCH_WAIT_MS)); + } + } + const commands = dequeueCommands(uuid); + return { + content: [{ type: "text", text: `${commands.length} command(s)` }], + structuredContent: { commands }, + }; + }, + ); + } // end if (!disableInteract) + + // Tool: save_pdf (app-only) - Save annotated PDF back to local file + registerAppTool( + server, + "save_pdf", + { + title: "Save PDF", + description: + "Save annotated PDF bytes back to a local file. The model should NOT call this tool directly β€” use interact with action: save_as instead.", + inputSchema: z.object({ + url: z.string().describe("Original PDF URL or local file path"), + data: z.string().describe("Base64-encoded PDF bytes"), + }), + outputSchema: z.object({ + filePath: z.string(), + mtimeMs: z.number(), + }), + _meta: { ui: { visibility: ["app"] } }, + }, + async ({ url, data }): Promise => { + const validation = validateUrl(url); + if (!validation.valid) { + return { + content: [{ type: "text", text: validation.error! }], + isError: true, + }; + } + const filePath = isFileUrl(url) + ? fileUrlToPath(url) + : isLocalPath(url) + ? decodeURIComponent(url) + : null; + if (!filePath) { + return { + content: [ + { type: "text", text: "Save is only supported for local files" }, + ], + isError: true, + }; + } + const resolved = path.resolve(filePath); + // Enforce the same write scope the display_pdf writable flag uses. + // The viewer hides the save button for non-writable files, but we + // must not trust the client: a direct save_pdf call should also refuse. + if (!isWritablePath(resolved)) { + return { + content: [ + { + type: "text", + text: + "Save refused: file is not under a mounted directory root " + + "and was not passed as a CLI argument. MCP file roots are " + + "read-only (typically uploaded copies the client doesn't " + + "expect to change).", + }, + ], + isError: true, + }; + } + try { + const bytes = Buffer.from(data, "base64"); + await fs.promises.writeFile(resolved, bytes); + const { mtimeMs } = await fs.promises.stat(resolved); + // Don't suppress file_changed here β€” the saving viewer will recognise + // its own mtime, while other viewers on the same file correctly get + // notified that their content is stale. + return { + content: [{ type: "text", text: `Saved to ${filePath}` }], + structuredContent: { filePath: resolved, mtimeMs }, + }; + } catch (err) { + return { + content: [ + { + type: "text", + text: `Failed to save: ${err instanceof Error ? err.message : String(err)}`, + }, + ], + isError: true, + }; + } + }, + ); + // Resource: UI HTML registerAppResource( server, @@ -668,13 +2909,30 @@ Accepts: RESOURCE_URI, { mimeType: RESOURCE_MIME_TYPE }, async (): Promise => { - const html = await fs.promises.readFile( + const html = (cachedAppHtml ??= await fs.promises.readFile( path.join(DIST_DIR, "mcp-app.html"), "utf-8", - ); + )); return { contents: [ - { uri: RESOURCE_URI, mimeType: RESOURCE_MIME_TYPE, text: html }, + { + uri: RESOURCE_URI, + mimeType: RESOURCE_MIME_TYPE, + text: html, + _meta: { + ui: { + permissions: { clipboardWrite: {} }, + csp: { + // pdf.js loads the Standard-14 fonts TWO ways: + // - fetch()s the .ttf bytes β†’ connect-src + // - creates FontFace('name', 'url(...)') β†’ font-src + // resourceDomains maps to font-src; we need both. + connectDomains: [STANDARD_FONT_ORIGIN], + resourceDomains: [STANDARD_FONT_ORIGIN], + }, + }, + }, + }, ], }; }, diff --git a/examples/pdf-server/src/annotation-panel.ts b/examples/pdf-server/src/annotation-panel.ts new file mode 100644 index 0000000..9fd4457 --- /dev/null +++ b/examples/pdf-server/src/annotation-panel.ts @@ -0,0 +1,1177 @@ +/** + * Annotation Panel β€” floating/docked sidebar showing all annotations and + * form fields, grouped by page in accordion sections. Handles panel + * positioning, resize, drag-to-reposition, per-item cards, and the + * reset/clear-all actions. + * + * All coupling to mcp-app.ts flows through {@link PanelDeps} supplied to + * {@link initAnnotationPanel}. Shared Maps/Sets come from viewer-state.ts. + */ + +import type * as pdfjsLib from "pdfjs-dist"; +import type { McpUiHostContext } from "@modelcontextprotocol/ext-apps"; +import type { PdfAnnotationDef } from "./pdf-annotations.js"; +import { + type TrackedAnnotation, + annotationMap, + formFieldValues, + pdfBaselineFormValues, + selectedAnnotationIds, + fieldNameToIds, + fieldNameToPage, + fieldNameToLabel, + fieldNameToOrder, + undoStack, + redoStack, + searchBarEl, + formLayerEl, +} from "./viewer-state.js"; + +const log = { + error: console.error.bind(console, "[PDF-VIEWER]"), +}; + +// ============================================================================= +// Panel DOM Elements +// ============================================================================= + +/** Floating panel container. Exported β€” mcp-app.ts reads .classList. */ +export const annotationsPanelEl = document.getElementById("annotation-panel")!; +/** Scrollable list of accordion sections. Exported β€” selectAnnotation queries it. */ +export const annotationsPanelListEl = document.getElementById( + "annotation-panel-list", +)!; +const annotationsPanelCountEl = document.getElementById( + "annotation-panel-count", +)!; +const annotationsPanelCloseBtn = document.getElementById( + "annotation-panel-close", +) as HTMLButtonElement; +const annotationsPanelResetBtn = document.getElementById( + "annotation-panel-reset", +) as HTMLButtonElement; +const annotationsPanelClearAllBtn = document.getElementById( + "annotation-panel-clear-all", +) as HTMLButtonElement; +const annotationsBtn = document.getElementById( + "annotations-btn", +) as HTMLButtonElement; +const annotationsBadgeEl = document.getElementById( + "annotations-badge", +) as HTMLElement; + +// ============================================================================= +// Panel State (exported β€” mcp-app.ts reads .open, writes .openAccordionSection) +// ============================================================================= + +/** Which corner the floating panel is anchored to. */ +type PanelCorner = "top-right" | "top-left" | "bottom-right" | "bottom-left"; + +export const panelState = { + /** Whether the panel is currently visible. Read by search open/close + debug. */ + open: false, + /** Which accordion section is open (e.g. "page-3"). Written by selectAnnotation. */ + openAccordionSection: null as string | null, +}; + +/** null = user hasn't manually toggled; true/false = manual preference */ +let annotationPanelUserPref: boolean | null = null; +/** Whether the user has ever interacted with accordion sections (prevents auto-open after explicit collapse). */ +let accordionUserInteracted = false; +let floatingPanelCorner: PanelCorner = "top-right"; + +// ============================================================================= +// Dependencies injected by mcp-app.ts +// ============================================================================= + +/** + * Callbacks and live-state getters supplied by mcp-app.ts. Scalars like + * `currentPage` and `pdfDocument` are reassigned throughout mcp-app.ts; + * a getter here avoids wrapping every one of their ~100 use sites. + */ +export interface PanelDeps { + // Live scalar state (read-only from panel's side) + state: () => { + currentPage: number; + isDirty: boolean; + pdfDocument: pdfjsLib.PDFDocumentProxy | null; + pdfBaselineAnnotations: PdfAnnotationDef[]; + // eslint-disable-next-line @typescript-eslint/no-explicit-any + cachedFieldObjects: Record | null; + searchOpen: boolean; + }; + // Callbacks into mcp-app.ts + renderPage: () => void; + goToPage: (page: number) => void; + selectAnnotation: (id: string | null) => void; + persistAnnotations: () => void; + removeAnnotation: (id: string) => void; + requestFitToContent: () => void; + updatePageContext: () => void; + setFocusedField: (name: string | null) => void; + // App bridge + sendMessage: (msg: { + role: "user"; + content: Array<{ type: "text"; text: string }>; + }) => Promise; + getHostContext: () => McpUiHostContext | undefined; +} + +let deps!: PanelDeps; + +// ============================================================================= +// Floating panel positioning +// ============================================================================= + +/** Get inset margins for the floating panel (safe area + padding). */ +function getFloatingPanelInsets(): { + top: number; + right: number; + bottom: number; + left: number; +} { + const insets = { top: 4, right: 4, bottom: 4, left: 4 }; + const ctx = deps.getHostContext(); + if (ctx?.safeAreaInsets) { + insets.top += ctx.safeAreaInsets.top; + insets.right += ctx.safeAreaInsets.right; + insets.bottom += ctx.safeAreaInsets.bottom; + insets.left += ctx.safeAreaInsets.left; + } + return insets; +} + +/** Position the floating panel based on its anchored corner. */ +export function applyFloatingPanelPosition(): void { + const el = annotationsPanelEl; + // Reset all position props + el.style.top = ""; + el.style.bottom = ""; + el.style.left = ""; + el.style.right = ""; + + const insets = getFloatingPanelInsets(); + + // When search bar is visible and panel is anchored top-right, offset below it + const searchBarExtra = + deps.state().searchOpen && floatingPanelCorner === "top-right" + ? searchBarEl.offsetHeight + 2 + : 0; + + const isRight = floatingPanelCorner.includes("right"); + const isBottom = floatingPanelCorner.includes("bottom"); + + if (isBottom) { + el.style.bottom = `${insets.bottom}px`; + } else { + el.style.top = `${insets.top + searchBarExtra}px`; + } + if (isRight) { + el.style.right = `${insets.right}px`; + } else { + el.style.left = `${insets.left}px`; + } + + // Update resize handle position based on anchorage + updateResizeHandlePosition(); +} + +/** Position the resize handle on the correct edge based on panel anchorage. */ +function updateResizeHandlePosition(): void { + const resizeHandle = document.getElementById("annotation-panel-resize"); + if (!resizeHandle) return; + const isRight = floatingPanelCorner.includes("right"); + if (isRight) { + // Panel is on the right β†’ resize handle on the left edge + resizeHandle.style.left = "-3px"; + resizeHandle.style.right = ""; + } else { + // Panel is on the left β†’ resize handle on the right edge + resizeHandle.style.left = ""; + resizeHandle.style.right = "-3px"; + } +} + +/** Auto-dock the floating panel to the opposite side if it overlaps selected annotations. */ +export function autoDockPanel(): void { + const panelRect = annotationsPanelEl.getBoundingClientRect(); + let overlaps = false; + for (const selId of selectedAnnotationIds) { + const tracked = annotationMap.get(selId); + if (!tracked) continue; + for (const el of tracked.elements) { + const elRect = el.getBoundingClientRect(); + // Check overlap + if ( + panelRect.left < elRect.right && + panelRect.right > elRect.left && + panelRect.top < elRect.bottom && + panelRect.bottom > elRect.top + ) { + overlaps = true; + break; + } + } + if (overlaps) break; + } + if (overlaps) { + // Swap left ↔ right + if (floatingPanelCorner.includes("right")) { + floatingPanelCorner = floatingPanelCorner.replace( + "right", + "left", + ) as PanelCorner; + } else { + floatingPanelCorner = floatingPanelCorner.replace( + "left", + "right", + ) as PanelCorner; + } + applyFloatingPanelPosition(); + } +} + +export function setAnnotationPanelOpen(open: boolean): void { + panelState.open = open; + annotationsBtn.classList.toggle("active", open); + updateAnnotationsBadge(); + + // Always use floating panel (both inline and fullscreen) + annotationsPanelEl.classList.toggle("floating", true); + annotationsPanelEl.style.display = open ? "" : "none"; + if (open) { + applyFloatingPanelPosition(); + renderAnnotationPanel(); + } + deps.requestFitToContent(); +} + +function toggleAnnotationPanel(): void { + annotationPanelUserPref = !panelState.open; + try { + localStorage.setItem( + "pdf-annotation-panel", + annotationPanelUserPref ? "open" : "closed", + ); + } catch { + /* ignore */ + } + setAnnotationPanelOpen(annotationPanelUserPref); +} + +// ============================================================================= +// Field & item state helpers +// ============================================================================= + +/** + * Derived state of a form field relative to the PDF baseline. + * Not stored β€” computed on demand by comparing formFieldValues to + * pdfBaselineFormValues. + */ +type FieldState = + | "unchanged" // current === baseline (came from the PDF, untouched) + | "modified" // baseline exists but current differs + | "cleared" // baseline exists but current is absent/empty + | "added"; // no baseline β€” user-filled or fill_form + +function fieldState(name: string): FieldState { + const cur = formFieldValues.get(name); + const base = pdfBaselineFormValues.get(name); + if (base === undefined) return "added"; + if (cur === undefined || cur === "" || cur === false) return "cleared"; + return cur === base ? "unchanged" : "modified"; +} + +/** All field names that should appear in the panel: current βˆͺ baseline. + * Cleared baseline fields remain visible (crossed out) so they can be + * reverted individually. */ +function panelFieldNames(): Set { + return new Set([...formFieldValues.keys(), ...pdfBaselineFormValues.keys()]); +} + +/** Baseline annotations the user has deleted. Shown crossed-out in the panel + * (mirroring cleared form fields) so they can be reverted, and so save knows + * to strip their refs from /Annots. */ +function removedBaselineAnnotations(): PdfAnnotationDef[] { + return deps + .state() + .pdfBaselineAnnotations.filter((a) => !annotationMap.has(a.id)); +} + +/** Total count of annotations + form fields for the sidebar badge. + * Uses the union so cleared baseline items still contribute. */ +function sidebarItemCount(): number { + return ( + annotationMap.size + + removedBaselineAnnotations().length + + panelFieldNames().size + ); +} + +export function updateAnnotationsBadge(): void { + const count = sidebarItemCount(); + if (count > 0 && !panelState.open) { + annotationsBadgeEl.textContent = String(count); + annotationsBadgeEl.style.display = ""; + } else { + annotationsBadgeEl.style.display = "none"; + } + // Show/hide the toolbar button based on whether items exist + annotationsBtn.style.display = count > 0 ? "" : "none"; + // Auto-close panel when all items are gone + if (count === 0 && panelState.open) { + setAnnotationPanelOpen(false); + } +} + +// ============================================================================= +// Label / preview helpers +// ============================================================================= + +/** Human-readable label for an annotation type (used in sidebar). */ +export function getAnnotationLabel(def: PdfAnnotationDef): string { + switch (def.type) { + case "highlight": + return "Highlight"; + case "underline": + return "Underline"; + case "strikethrough": + return "Strikethrough"; + case "note": + return "Note"; + case "freetext": + return "Text"; + case "rectangle": + return "Rectangle"; + case "stamp": + return `Stamp: ${def.label}`; + case "circle": + return "Circle"; + case "line": + return "Line"; + case "image": + return "Image"; + case "imported": + return `${def.subtype} (from PDF)`; + } +} + +/** Preview text for an annotation (shown after the label). */ +export function getAnnotationPreview(def: PdfAnnotationDef): string { + switch (def.type) { + case "note": + case "freetext": + return def.content || ""; + case "highlight": + return def.content || ""; + case "stamp": + return ""; + case "image": + return ""; + default: + return ""; + } +} + +export function getAnnotationColor(def: PdfAnnotationDef): string { + if ("color" in def && def.color) return def.color; + switch (def.type) { + case "highlight": + return "rgba(255, 255, 0, 0.7)"; + case "underline": + return "#ff0000"; + case "strikethrough": + return "#ff0000"; + case "note": + return "#f5a623"; + case "rectangle": + return "#0066cc"; + case "freetext": + return "#333"; + case "stamp": + return "#cc0000"; + case "circle": + return "#0066cc"; + case "line": + return "#333"; + case "image": + return "#999"; + case "imported": + return "#666"; + } +} + +/** Return a human-readable label for a form field name. */ +export function getFormFieldLabel(name: string): string { + // Prefer the PDF's TU (alternativeText) if available + const alt = fieldNameToLabel.get(name); + if (alt) return alt; + // If the name looks mechanical (contains brackets, dots, or is all-caps with underscores), + // just show "Field" as a generic fallback + if (/[[\]().]/.test(name) || /^[A-Z0-9_]+$/.test(name)) { + return "Field"; + } + return name; +} + +function getAnnotationY(def: PdfAnnotationDef): number { + if ("y" in def && typeof def.y === "number") return def.y; + if ("rects" in def && def.rects.length > 0) return def.rects[0].y; + // LineAnnotation has only x1/y1/x2/y2 β€” sort by the higher endpoint + // (higher internal-y = closer to page top). + if ("y1" in def) return Math.max(def.y1, def.y2); + return 0; +} + +// ============================================================================= +// Panel rendering +// ============================================================================= + +export function renderAnnotationPanel(): void { + if (!panelState.open) return; + + annotationsPanelCountEl.textContent = String(sidebarItemCount()); + annotationsPanelResetBtn.disabled = !deps.state().isDirty; + annotationsPanelClearAllBtn.disabled = sidebarItemCount() === 0; + + // Group annotations by page, sorted by Y position within each page + const byPage = new Map(); + for (const tracked of annotationMap.values()) { + const page = tracked.def.page; + if (!byPage.has(page)) byPage.set(page, []); + byPage.get(page)!.push(tracked); + } + + // Removed baseline annotations: still listed (crossed-out) so they can be + // reverted before save strips them from the file. + const removedByPage = new Map(); + for (const def of removedBaselineAnnotations()) { + if (!removedByPage.has(def.page)) removedByPage.set(def.page, []); + removedByPage.get(def.page)!.push(def); + } + + // Group form fields by page β€” iterate the UNION so cleared baseline + // fields remain visible (crossed out) with a per-item revert button. + const fieldsByPage = new Map(); + for (const name of panelFieldNames()) { + const page = fieldNameToPage.get(name) ?? 1; + if (!fieldsByPage.has(page)) fieldsByPage.set(page, []); + fieldsByPage.get(page)!.push(name); + } + // Sort fields by their intrinsic document order within each page + for (const names of fieldsByPage.values()) { + names.sort( + (a, b) => (fieldNameToOrder.get(a) ?? 0) - (fieldNameToOrder.get(b) ?? 0), + ); + } + + // Collect all pages that have annotations or form fields + const allPages = new Set([ + ...byPage.keys(), + ...removedByPage.keys(), + ...fieldsByPage.keys(), + ]); + const sortedPages = [...allPages].sort((a, b) => a - b); + + // Sort annotations within each page by Y position (descending = top-first in PDF coords) + for (const annotations of byPage.values()) { + annotations.sort((a, b) => getAnnotationY(b.def) - getAnnotationY(a.def)); + } + + annotationsPanelListEl.innerHTML = ""; + + const { currentPage } = deps.state(); + + // Auto-open section for current page only on first render (before user interaction) + if (panelState.openAccordionSection === null && !accordionUserInteracted) { + if (allPages.has(currentPage)) { + panelState.openAccordionSection = `page-${currentPage}`; + } else if (sortedPages.length > 0) { + panelState.openAccordionSection = `page-${sortedPages[0]}`; + } + } + + for (const pageNum of sortedPages) { + const sectionKey = `page-${pageNum}`; + const isOpen = panelState.openAccordionSection === sectionKey; + const annotations = byPage.get(pageNum) ?? []; + const removed = removedByPage.get(pageNum) ?? []; + const fields = fieldsByPage.get(pageNum) ?? []; + const itemCount = annotations.length + removed.length + fields.length; + + appendAccordionSection( + `Page ${pageNum} (${itemCount})`, + sectionKey, + isOpen, + pageNum === currentPage, + (body) => { + // Form fields first + for (const name of fields) { + body.appendChild(createFormFieldCard(name)); + } + // Then annotations + for (const tracked of annotations) { + body.appendChild(createAnnotationCard(tracked)); + } + // Then removed baseline annotations (crossed-out, revertable) + for (const def of removed) { + body.appendChild(createRemovedAnnotationCard(def)); + } + }, + ); + } +} + +function appendAccordionSection( + title: string, + sectionKey: string, + isOpen: boolean, + isCurrent: boolean, + populateBody: (body: HTMLElement) => void, +): void { + const header = document.createElement("div"); + header.className = + "annotation-section-header" + + (isCurrent ? " current-page" : "") + + (isOpen ? " open" : ""); + + const titleSpan = document.createElement("span"); + titleSpan.textContent = title; + header.appendChild(titleSpan); + + const chevron = document.createElement("span"); + chevron.className = "annotation-section-chevron"; + chevron.textContent = isOpen ? "β–Ό" : "β–Ά"; + header.appendChild(chevron); + + header.addEventListener("click", () => { + accordionUserInteracted = true; + const opening = panelState.openAccordionSection !== sectionKey; + panelState.openAccordionSection = opening ? sectionKey : null; + renderAnnotationPanel(); + // Navigate to the page when expanding a page section + if (opening) { + const pageMatch = sectionKey.match(/^page-(\d+)$/); + if (pageMatch) { + deps.goToPage(Number(pageMatch[1])); + } + } + }); + + annotationsPanelListEl.appendChild(header); + + const body = document.createElement("div"); + body.className = "annotation-section-body" + (isOpen ? " open" : ""); + if (isOpen) { + populateBody(body); + } + annotationsPanelListEl.appendChild(body); +} + +const TRASH_SVG = ``; +const REVERT_SVG = ``; + +function createAnnotationCard(tracked: TrackedAnnotation): HTMLElement { + const def = tracked.def; + const card = document.createElement("div"); + card.className = + "annotation-card" + (selectedAnnotationIds.has(def.id) ? " selected" : ""); + card.dataset.annotationId = def.id; + + const row = document.createElement("div"); + row.className = "annotation-card-row"; + + // Color swatch + const swatch = document.createElement("div"); + swatch.className = "annotation-card-swatch"; + swatch.style.background = getAnnotationColor(def); + row.appendChild(swatch); + + // Type label + const typeLabel = document.createElement("span"); + typeLabel.className = "annotation-card-type"; + typeLabel.textContent = getAnnotationLabel(def); + row.appendChild(typeLabel); + + // Preview text + const preview = getAnnotationPreview(def); + if (preview) { + const previewEl = document.createElement("span"); + previewEl.className = "annotation-card-preview"; + previewEl.textContent = preview; + row.appendChild(previewEl); + } + + // Delete button + const deleteBtn = document.createElement("button"); + deleteBtn.className = "annotation-card-delete"; + deleteBtn.title = "Delete annotation"; + deleteBtn.innerHTML = TRASH_SVG; + deleteBtn.addEventListener("click", (e) => { + e.stopPropagation(); + deps.removeAnnotation(def.id); + deps.persistAnnotations(); + }); + row.appendChild(deleteBtn); + + // Expand chevron (only for annotations with content) + const hasContent = "content" in def && def.content; + if (hasContent) { + const expand = document.createElement("span"); + expand.className = "annotation-card-expand"; + expand.textContent = "β–Ό"; + row.appendChild(expand); + } + + card.appendChild(row); + + // Expandable content area + if (hasContent) { + const contentEl = document.createElement("div"); + contentEl.className = "annotation-card-content"; + contentEl.textContent = (def as { content: string }).content; + card.appendChild(contentEl); + } + + // Click handler: select + expand/collapse + navigate to page + pulse annotation + card.addEventListener("click", () => { + if (hasContent) { + card.classList.toggle("expanded"); + } + if (def.page !== deps.state().currentPage) { + deps.goToPage(def.page); + setTimeout(() => { + deps.selectAnnotation(def.id); + pulseAnnotation(def.id); + }, 300); + } else { + deps.selectAnnotation(def.id); + pulseAnnotation(def.id); + if (tracked.elements.length > 0) { + tracked.elements[0].scrollIntoView({ + behavior: "smooth", + block: "center", + }); + } + } + }); + + // Hover handler: pulse annotation on PDF + card.addEventListener("mouseenter", () => { + if (def.page === deps.state().currentPage) { + pulseAnnotation(def.id); + } + }); + + // Double-click handler: send message to modify annotation + card.addEventListener("dblclick", (e) => { + e.stopPropagation(); + // Select this annotation + update model context before sending message + deps.selectAnnotation(def.id); + const label = getAnnotationLabel(def); + const previewText = getAnnotationPreview(def); + const desc = previewText ? `${label}: ${previewText}` : label; + void deps + .sendMessage({ + role: "user", + content: [{ type: "text", text: `update ${desc}: ` }], + }) + .catch(log.error); + }); + + return card; +} + +/** + * Card for a baseline annotation the user deleted: crossed-out, no select/ + * navigate (it has no DOM on the page anymore), revert button puts it back + * into `annotationMap` so it renders again and save leaves it in the file. + */ +function createRemovedAnnotationCard(def: PdfAnnotationDef): HTMLElement { + const card = document.createElement("div"); + card.className = "annotation-card annotation-card-cleared"; + card.dataset.annotationId = def.id; + + const row = document.createElement("div"); + row.className = "annotation-card-row"; + + const swatch = document.createElement("div"); + swatch.className = "annotation-card-swatch annotation-card-swatch-cleared"; + swatch.innerHTML = ``; + row.appendChild(swatch); + + const typeLabel = document.createElement("span"); + typeLabel.className = "annotation-card-type"; + typeLabel.textContent = getAnnotationLabel(def); + row.appendChild(typeLabel); + + const preview = getAnnotationPreview(def); + if (preview) { + const previewEl = document.createElement("span"); + previewEl.className = "annotation-card-preview"; + previewEl.textContent = preview; + row.appendChild(previewEl); + } + + const revertBtn = document.createElement("button"); + revertBtn.className = "annotation-card-delete"; + revertBtn.title = "Restore annotation from file"; + revertBtn.innerHTML = REVERT_SVG; + revertBtn.addEventListener("click", (e) => { + e.stopPropagation(); + annotationMap.set(def.id, { def: { ...def }, elements: [] }); + updateAnnotationsBadge(); + renderAnnotationPanel(); + deps.renderPage(); + deps.persistAnnotations(); + }); + row.appendChild(revertBtn); + + card.appendChild(row); + return card; +} + +/** Revert one field to its PDF-stored baseline value. */ +function revertFieldToBaseline(name: string): void { + const base = pdfBaselineFormValues.get(name); + if (base === undefined) return; + formFieldValues.set(name, base); + // Remove our storage override β†’ widget falls back to PDF's /V = baseline + const { pdfDocument } = deps.state(); + if (pdfDocument) { + const ids = fieldNameToIds.get(name); + if (ids) for (const id of ids) pdfDocument.annotationStorage.remove(id); + } +} + +function createFormFieldCard(name: string): HTMLElement { + const state = fieldState(name); + const value = formFieldValues.get(name); + const baseValue = pdfBaselineFormValues.get(name); + + const card = document.createElement("div"); + card.className = "annotation-card"; + if (state === "cleared") card.classList.add("annotation-card-cleared"); + + const row = document.createElement("div"); + row.className = "annotation-card-row"; + + // Swatch: solid blue normally; crossed-out for cleared baseline fields + const swatch = document.createElement("div"); + swatch.className = "annotation-card-swatch"; + if (state === "cleared") { + swatch.classList.add("annotation-card-swatch-cleared"); + swatch.innerHTML = ``; + } else { + swatch.style.background = "#4a90d9"; + } + // Subtle modified marker + if (state === "modified") swatch.title = "Modified from file"; + row.appendChild(swatch); + + // Field label + const nameEl = document.createElement("span"); + nameEl.className = "annotation-card-type"; + nameEl.textContent = getFormFieldLabel(name); + row.appendChild(nameEl); + + // Value preview: show current, or struck-out baseline when cleared + const shown = state === "cleared" ? baseValue : value; + const displayValue = + typeof shown === "boolean" ? (shown ? "checked" : "unchecked") : shown; + if (displayValue) { + const valueEl = document.createElement("span"); + valueEl.className = "annotation-card-preview"; + valueEl.textContent = displayValue; + row.appendChild(valueEl); + } + + // Action button: revert for modified/cleared baseline fields, trash otherwise + const isRevertable = state === "modified" || state === "cleared"; + const actionBtn = document.createElement("button"); + actionBtn.className = "annotation-card-delete"; + actionBtn.title = isRevertable + ? "Revert to value stored in file" + : "Clear field"; + actionBtn.innerHTML = isRevertable ? REVERT_SVG : TRASH_SVG; + actionBtn.addEventListener("click", (e) => { + e.stopPropagation(); + if (isRevertable) { + revertFieldToBaseline(name); + } else { + formFieldValues.delete(name); + clearFieldInStorage(name); + } + updateAnnotationsBadge(); + renderAnnotationPanel(); + deps.renderPage(); + deps.persistAnnotations(); + }); + row.appendChild(actionBtn); + + // Click handler: navigate to page and focus form input + card.addEventListener("click", () => { + const fieldPage = fieldNameToPage.get(name) ?? 1; + // Auto-expand the page's accordion section + panelState.openAccordionSection = `page-${fieldPage}`; + const focusField = () => { + const input = formLayerEl.querySelector( + `[name="${CSS.escape(name)}"]`, + ) as HTMLElement | null; + if (input) { + input.focus(); + input.scrollIntoView({ behavior: "smooth", block: "center" }); + } + }; + if (fieldPage !== deps.state().currentPage) { + deps.goToPage(fieldPage); + setTimeout(focusField, 300); + } else { + focusField(); + } + }); + + // Double-click handler: send message to fill field + card.addEventListener("dblclick", (e) => { + e.stopPropagation(); + // Focus field + update model context before sending message + deps.setFocusedField(name); + deps.updatePageContext(); + const fieldLabel = getFormFieldLabel(name); + void deps + .sendMessage({ + role: "user", + content: [{ type: "text", text: `update ${fieldLabel}: ` }], + }) + .catch(log.error); + }); + + card.appendChild(row); + return card; +} + +function pulseAnnotation(id: string): void { + const tracked = annotationMap.get(id); + if (!tracked) return; + for (const el of tracked.elements) { + el.classList.remove("annotation-pulse"); + // Force reflow to restart animation + void el.offsetWidth; + el.classList.add("annotation-pulse"); + el.addEventListener( + "animationend", + () => { + el.classList.remove("annotation-pulse"); + }, + { once: true }, + ); + } +} + +/** Toggle the `.selected` class on every card to match selectedAnnotationIds. */ +export function syncSidebarSelection(): void { + for (const card of annotationsPanelListEl.querySelectorAll( + ".annotation-card", + )) { + const cardId = (card as HTMLElement).dataset.annotationId; + card.classList.toggle( + "selected", + !!cardId && selectedAnnotationIds.has(cardId), + ); + } +} + +// ============================================================================= +// Reset / Clear +// ============================================================================= + +/** Remove the DOM elements backing every annotation and clear the map. */ +function clearAnnotationMap(): void { + for (const [, tracked] of annotationMap) { + for (const el of tracked.elements) el.remove(); + } + annotationMap.clear(); +} + +/** + * Push a field's defaultValue (/DV) into annotationStorage so the widget + * renders cleared. annotationStorage.remove() only drops our override β€” + * the widget reverts to the PDF's /V (the stored value), not /DV. + * + * Widget IDs come from page.getAnnotations(); field metadata (types, + * defaultValue) comes from getFieldObjects(). We match them by field name. + */ +function clearFieldInStorage(name: string): void { + const { pdfDocument, cachedFieldObjects } = deps.state(); + if (!pdfDocument) return; + const ids = fieldNameToIds.get(name); + if (!ids) return; + const storage = pdfDocument.annotationStorage; + const meta = cachedFieldObjects?.[name]; + // defaultValue is per-field, not per-widget β€” take from first non-parent entry + const dv = + meta?.find((f) => f.defaultValue != null)?.defaultValue ?? + meta?.[0]?.defaultValue ?? + ""; + const type = meta?.find((f) => f.type)?.type; + // Radio: per-widget BOOLEANS, never a string. pdf.js's + // RadioButtonWidgetAnnotation render() has inverted string coercion (see + // setFieldInStorage), so writing the same string to every widget checks + // the wrong one. {value:false} on all = nothing selected. + if (type === "radiobutton") { + for (const id of ids) storage.setValue(id, { value: false }); + return; + } + const clearValue = type === "checkbox" ? (dv ?? "Off") : (dv ?? ""); + for (const id of ids) storage.setValue(id, { value: clearValue }); +} + +/** + * Revert to what's in the PDF file: restore baseline annotations, restore + * baseline form values, discard all user edits. Result: diff is empty, clean. + * + * Form fields: remove ALL storage overrides β€” every field reverts to the + * PDF's /V (which IS baseline). We can't skip baseline-named fields: if the + * user edited one, our override is in storage under that name, and skipping + * it leaves the widget showing the stale edit. + */ +function resetToBaseline(): void { + clearAnnotationMap(); + const { pdfDocument, pdfBaselineAnnotations } = deps.state(); + for (const def of pdfBaselineAnnotations) { + annotationMap.set(def.id, { def: { ...def }, elements: [] }); + } + + if (pdfDocument) { + const storage = pdfDocument.annotationStorage; + for (const name of new Set([ + ...formFieldValues.keys(), + ...pdfBaselineFormValues.keys(), + ])) { + const ids = fieldNameToIds.get(name); + if (ids) for (const id of ids) storage.remove(id); + } + } + formFieldValues.clear(); + for (const [name, value] of pdfBaselineFormValues) { + formFieldValues.set(name, value); + } + + undoStack.length = 0; + redoStack.length = 0; + selectedAnnotationIds.clear(); + + updateAnnotationsBadge(); + deps.persistAnnotations(); // diff is now empty β†’ setDirty(false) + deps.renderPage(); + renderAnnotationPanel(); +} + +/** + * Remove everything, including annotations and form values that came from + * the PDF file. Result: diff is non-empty (baseline items are "removed"), + * dirty β€” saving writes a stripped PDF. + * + * Form fields: annotationStorage.remove() only drops our override, so the + * widget reverts to the PDF's stored /V. To actually CLEAR we must push + * each field's defaultValue (/DV) β€” which is what the PDF's own Reset + * button would do. + * + * Note: baseline annotations are still baked into the canvas appearance + * stream β€” we can only remove them from our overlay and the panel. Saving + * will omit them from the output (getAnnotatedPdfBytes skips baseline). + */ +function clearAllItems(): void { + clearAnnotationMap(); + + for (const name of new Set([ + ...formFieldValues.keys(), + ...pdfBaselineFormValues.keys(), + ])) { + clearFieldInStorage(name); + } + formFieldValues.clear(); + + undoStack.length = 0; + redoStack.length = 0; + selectedAnnotationIds.clear(); + + updateAnnotationsBadge(); + deps.persistAnnotations(); + deps.renderPage(); + renderAnnotationPanel(); +} + +// ============================================================================= +// Init +// ============================================================================= + +export function initAnnotationPanel(panelDeps: PanelDeps): void { + deps = panelDeps; + + // Restore user preference + try { + const pref = localStorage.getItem("pdf-annotation-panel"); + if (pref === "open") annotationPanelUserPref = true; + else if (pref === "closed") annotationPanelUserPref = false; + } catch { + /* ignore */ + } + + // Restore saved panel width + try { + const savedWidth = localStorage.getItem("pdf-annotation-panel-width"); + if (savedWidth) { + const w = parseInt(savedWidth, 10); + if (w >= 120) { + annotationsPanelEl.style.width = `${w}px`; + } + } + } catch { + /* ignore */ + } + + // Resize handle β€” direction-aware based on anchorage + const resizeHandle = document.getElementById("annotation-panel-resize")!; + resizeHandle.addEventListener("mousedown", (e) => { + e.preventDefault(); + resizeHandle.classList.add("dragging"); + const startX = e.clientX; + const startWidth = annotationsPanelEl.offsetWidth; + const isRight = floatingPanelCorner.includes("right"); + + const onMouseMove = (ev: MouseEvent) => { + const dx = ev.clientX - startX; + // If panel is on the right, dragging left (negative dx) increases width + // If panel is on the left, dragging right (positive dx) increases width + const newWidth = Math.max(120, startWidth + (isRight ? -dx : dx)); + annotationsPanelEl.style.width = `${newWidth}px`; + }; + const onMouseUp = () => { + resizeHandle.classList.remove("dragging"); + document.removeEventListener("mousemove", onMouseMove); + document.removeEventListener("mouseup", onMouseUp); + try { + localStorage.setItem( + "pdf-annotation-panel-width", + String(annotationsPanelEl.offsetWidth), + ); + } catch { + /* ignore */ + } + deps.requestFitToContent(); + }; + document.addEventListener("mousemove", onMouseMove); + document.addEventListener("mouseup", onMouseUp); + }); + + // Floating panel drag-to-reposition + const panelHeader = annotationsPanelEl.querySelector( + ".annotation-panel-header", + ) as HTMLElement; + if (panelHeader) { + panelHeader.addEventListener("mousedown", (e) => { + if (!annotationsPanelEl.classList.contains("floating")) return; + // Ignore clicks on buttons within header + if ((e.target as HTMLElement).closest("button")) return; + e.preventDefault(); + const startX = e.clientX; + const startY = e.clientY; + const container = annotationsPanelEl.parentElement!; + const containerRect = container.getBoundingClientRect(); + let moved = false; + + // Temporarily position absolutely during drag + const panelRect = annotationsPanelEl.getBoundingClientRect(); + let curLeft = panelRect.left - containerRect.left; + let curTop = panelRect.top - containerRect.top; + + // Switch to left/top positioning for free drag + annotationsPanelEl.style.right = ""; + annotationsPanelEl.style.bottom = ""; + annotationsPanelEl.style.left = `${curLeft}px`; + annotationsPanelEl.style.top = `${curTop}px`; + annotationsPanelEl.style.transition = "none"; + annotationsPanelEl.classList.add("dragging"); + + const onMouseMove = (ev: MouseEvent) => { + const dx = ev.clientX - startX; + const dy = ev.clientY - startY; + if (Math.abs(dx) > 3 || Math.abs(dy) > 3) moved = true; + const newLeft = Math.max( + 0, + Math.min( + curLeft + dx, + containerRect.width - annotationsPanelEl.offsetWidth, + ), + ); + const newTop = Math.max( + 0, + Math.min( + curTop + dy, + containerRect.height - annotationsPanelEl.offsetHeight, + ), + ); + annotationsPanelEl.style.left = `${newLeft}px`; + annotationsPanelEl.style.top = `${newTop}px`; + }; + + const onMouseUp = () => { + document.removeEventListener("mousemove", onMouseMove); + document.removeEventListener("mouseup", onMouseUp); + annotationsPanelEl.classList.remove("dragging"); + annotationsPanelEl.style.transition = ""; + + if (!moved) return; + + // Snap to nearest corner (magnetic anchor) + const finalRect = annotationsPanelEl.getBoundingClientRect(); + const cx = finalRect.left + finalRect.width / 2 - containerRect.left; + const cy = finalRect.top + finalRect.height / 2 - containerRect.top; + const midX = containerRect.width / 2; + const midY = containerRect.height / 2; + + const isRight = cx > midX; + const isBottom = cy > midY; + floatingPanelCorner = isBottom + ? isRight + ? "bottom-right" + : "bottom-left" + : isRight + ? "top-right" + : "top-left"; + + applyFloatingPanelPosition(); + try { + localStorage.setItem("pdf-panel-corner", floatingPanelCorner); + } catch { + /* ignore */ + } + }; + + document.addEventListener("mousemove", onMouseMove); + document.addEventListener("mouseup", onMouseUp); + }); + } + + // Restore saved corner + try { + const saved = localStorage.getItem("pdf-panel-corner"); + if ( + saved && + ["top-right", "top-left", "bottom-right", "bottom-left"].includes(saved) + ) { + floatingPanelCorner = saved as PanelCorner; + } + } catch { + /* ignore */ + } + + // Toggle button + annotationsBtn.addEventListener("click", toggleAnnotationPanel); + annotationsPanelCloseBtn.addEventListener("click", toggleAnnotationPanel); + annotationsPanelResetBtn.addEventListener("click", resetToBaseline); + annotationsPanelClearAllBtn.addEventListener("click", clearAllItems); + + updateAnnotationsBadge(); +} diff --git a/examples/pdf-server/src/commands.ts b/examples/pdf-server/src/commands.ts new file mode 100644 index 0000000..6d27edf --- /dev/null +++ b/examples/pdf-server/src/commands.ts @@ -0,0 +1,70 @@ +/** + * PdfCommand β€” the wire protocol between server and viewer. + * + * The server enqueues these via the `interact` tool; the viewer polls + * `poll_pdf_commands` and receives them as `structuredContent.commands`. + * + * This file is the single source of truth for the command shape. Both + * `server.ts` (which enqueues) and `mcp-app.ts` (which consumes) import + * from here β€” a new command variant must be added exactly once. + * + * Uses `import type` so neither side pulls pdf-lib into its bundle. + */ + +import type { PdfAnnotationDef } from "./pdf-annotations.js"; + +/** Single form field assignment, as sent by `fill_form`. */ +export interface FormFieldFill { + name: string; + value: string | boolean; +} + +/** + * Partial annotation update: `id` + `type` pin the target, everything + * else is optional. Server validates shape; viewer merges into existing. + */ +export type PdfAnnotationPatch = Partial & { + id: string; + type: PdfAnnotationDef["type"]; +}; + +/** Page range for text/screenshot extraction. Omitted bound = open-ended. */ +export interface PageInterval { + start?: number; + end?: number; +} + +/** + * Commands the server can send to the viewer via the poll queue. + * Adding a variant here means adding a `case` in both the server's + * `interact` handler (to enqueue) and the viewer's `processCommands` + * (to execute). + */ +export type PdfCommand = + | { type: "navigate"; page: number } + | { type: "search"; query: string } + | { type: "find"; query: string } + | { type: "search_navigate"; matchIndex: number } + | { type: "zoom"; scale: number } + | { type: "add_annotations"; annotations: PdfAnnotationDef[] } + | { type: "update_annotations"; annotations: PdfAnnotationPatch[] } + | { type: "remove_annotations"; ids: string[] } + | { + type: "highlight_text"; + id: string; + query: string; + page?: number; + color?: string; + content?: string; + } + | { type: "fill_form"; fields: FormFieldFill[] } + | { + type: "get_pages"; + requestId: string; + intervals: PageInterval[]; + getText: boolean; + getScreenshots: boolean; + } + | { type: "save_as"; requestId: string } + | { type: "get_viewer_state"; requestId: string } + | { type: "file_changed"; mtimeMs: number }; diff --git a/examples/pdf-server/src/mcp-app.css b/examples/pdf-server/src/mcp-app.css index 008b22a..a87dbcd 100644 --- a/examples/pdf-server/src/mcp-app.css +++ b/examples/pdf-server/src/mcp-app.css @@ -13,10 +13,7 @@ --text200: light-dark(#999999, #888888); /* Shadows */ - --shadow-page: light-dark( - 0 2px 8px rgba(0, 0, 0, 0.15), - 0 2px 8px rgba(0, 0, 0, 0.4) - ); + --shadow-page-color: light-dark(rgba(0 0 0 / 0.15), rgba(0 0 0 / 0.4)); --selection-bg: light-dark(rgba(0, 0, 255, 0.3), rgba(100, 150, 255, 0.4)); } @@ -103,13 +100,14 @@ body { display: flex; align-items: center; justify-content: space-between; - padding: 0.5rem 1rem; + padding: 0.5rem 0.5rem; background: var(--bg000); border-bottom: 1px solid var(--bg200); flex-shrink: 0; - gap: 0.5rem; - height: 48px; + gap: 0.25rem 0.5rem; + min-height: 48px; box-sizing: border-box; + flex-wrap: wrap; } .toolbar-left { @@ -222,17 +220,24 @@ body { /* Single Page Canvas Container */ .canvas-container { flex: 1; - overflow: visible; + overflow-x: auto; /* Allow horizontal scrolling when zoomed in inline mode */ + overflow-y: visible; display: flex; justify-content: center; align-items: flex-start; padding: 1rem; background: var(--bg200); + /* JS owns pinch (inline pinch-in β†’ fullscreen). pan-x/pan-y keeps native + * scrolling; the fullscreen rule below repeats this with a comment on the + * iOS-Safari preventDefault backstop. */ + touch-action: pan-x pan-y; } .page-wrapper { position: relative; - box-shadow: var(--shadow-page); + box-shadow: + 0 1px 4px var(--shadow-page-color), + 0 4px 16px var(--shadow-page-color); background: white; } @@ -261,7 +266,6 @@ body { --min-font-size-inv: calc(1 / var(--min-font-size, 1)); } - .text-layer :is(span, br) { color: transparent; position: absolute; @@ -306,16 +310,48 @@ body { overflow: hidden; /* No scrolling on main - only canvas-container scrolls */ border-radius: 0; border: none; - padding: 0 !important; /* Ignore safe area insets in fullscreen */ + padding: 0 !important; /* Background extends edge-to-edge */ +} + +.main.fullscreen .toolbar { + /* Hosts wrap fullscreen in their own header (title + close), which already + * clears the top safe-area β€” so no --safe-top here, only sides. */ + padding: 0.25rem calc(0.5rem + var(--safe-right, 0px)) 0.25rem + calc(0.5rem + var(--safe-left, 0px)); + min-height: 40px; + /* Inline can wrap (narrow chat bubble); fullscreen has the width, and + * wrapping would double the bar height + desync the search-bar offset. */ + flex-wrap: nowrap; +} + +.main.fullscreen .search-bar { + /* -1px overlaps the toolbar border so the dropdown looks attached. */ + top: 39px; + right: calc(var(--safe-right, 0px) - 1px); } .main.fullscreen .viewer { min-height: 0; /* Allow flex item to shrink below content size */ } +.main.fullscreen .viewer-body { + min-height: 0; +} + .main.fullscreen .canvas-container { min-height: 0; /* Allow flex item to shrink below content size */ overflow: auto; /* Scroll within the document area only */ + /* Let JS own pinch-zoom (we re-render the PDF, not the viewport). + * pan-x pan-y keeps native scrolling/panning working. iOS Safari only + * partially honours this β€” preventDefault on touchmove backs it up. */ + touch-action: pan-x pan-y; + /* Keep the page clear of host overlays (chat input, home indicator). + * computeFitScale subtracts padding, so fit-to-page lands above these. + * The container background still extends edge-to-edge (.main.fullscreen + * has padding:0). Top inset is on the toolbar; the rest land here. */ + padding-bottom: calc(1rem + var(--safe-bottom, 0px)); + padding-left: calc(1rem + var(--safe-left, 0px)); + padding-right: calc(1rem + var(--safe-right, 0px)); } /* Search Button */ @@ -408,6 +444,376 @@ body { cursor: not-allowed; } +/* Annotation Layer */ +.annotation-layer { + position: absolute; + left: 0; + top: 0; + right: 0; + bottom: 0; + pointer-events: none; + z-index: 3; /* above text-layer (z-index: 2) so notes are clickable */ +} + +.annotation-highlight { + position: absolute; + background: rgba(255, 255, 0, 0.35); + mix-blend-mode: multiply; + border-radius: 1px; + pointer-events: auto; + cursor: pointer; +} + +.annotation-underline { + position: absolute; + border-bottom: 2px solid #ff0000; + box-sizing: border-box; + pointer-events: auto; + cursor: pointer; +} + +.annotation-strikethrough { + position: absolute; + box-sizing: border-box; + pointer-events: auto; + cursor: pointer; +} +.annotation-strikethrough::after { + content: ""; + position: absolute; + left: 0; + right: 0; + top: 50%; + border-top: 2px solid #ff0000; +} + +.annotation-note { + position: absolute; + width: 20px; + height: 20px; + cursor: pointer; + pointer-events: auto; +} +.annotation-note::after { + content: ""; + display: block; + width: 16px; + height: 16px; + margin: 2px; + background: currentColor; + -webkit-mask: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16' fill='black'%3E%3Cpath d='M3 1a1 1 0 0 0-1 1v12a1 1 0 0 0 1 1h10a1 1 0 0 0 1-1V5l-4-4H3zm7 1.5L13.5 6H11a1 1 0 0 1-1-1V2.5zM5 8.5h6v1H5v-1zm0 2.5h4v1H5v-1z'/%3E%3C/svg%3E") no-repeat center / contain; + mask: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16' fill='black'%3E%3Cpath d='M3 1a1 1 0 0 0-1 1v12a1 1 0 0 0 1 1h10a1 1 0 0 0 1-1V5l-4-4H3zm7 1.5L13.5 6H11a1 1 0 0 1-1-1V2.5zM5 8.5h6v1H5v-1zm0 2.5h4v1H5v-1z'/%3E%3C/svg%3E") no-repeat center / contain; +} +.annotation-note .annotation-tooltip { + display: none; + position: absolute; + bottom: 100%; + left: 0; + background: var(--bg000, #fff); + color: var(--text000, #000); + border: 1px solid var(--bg200, #ccc); + border-radius: 4px; + padding: 4px 8px; + font-size: 0.8rem; + white-space: pre-wrap; + max-width: 200px; + z-index: 100; /* Must float above all sibling annotation elements */ + pointer-events: none; + box-shadow: 0 2px 6px rgba(0, 0, 0, 0.2); +} +.annotation-note:hover .annotation-tooltip { + display: block; +} + +/* When hovering a note, raise the entire annotation layer above the form + layer so the tooltip isn't clipped by the z-index:4 form overlay. */ +.annotation-layer:has(.annotation-note:hover) { + z-index: 5; +} + +.annotation-rectangle { + position: absolute; + border: 2px solid #0066cc; + box-sizing: border-box; + pointer-events: auto; + cursor: grab; + user-select: none; +} + +.annotation-circle { + position: absolute; + border: 2px solid #0066cc; + border-radius: 50%; + box-sizing: border-box; + pointer-events: auto; + cursor: grab; + user-select: none; +} + +.annotation-line { + position: absolute; + height: 0; + border-top: 2px solid #333; + pointer-events: auto; + cursor: grab; + user-select: none; +} + +.annotation-freetext { + position: absolute; + font-family: Helvetica, Arial, sans-serif; + white-space: pre-wrap; + pointer-events: auto; + cursor: grab; + user-select: none; +} + +.annotation-stamp { + position: absolute; + font-family: Helvetica, Arial, sans-serif; + font-weight: bold; + font-size: 24px; + border: 3px solid currentColor; + padding: 4px 12px; + opacity: 0.6; + text-transform: uppercase; + white-space: nowrap; + pointer-events: auto; + cursor: grab; + user-select: none; +} + +.annotation-image { + position: absolute; + pointer-events: auto; + cursor: grab; + user-select: none; +} + +/* Annotation imported verbatim from the PDF (Stamp/Ink/etc. via + * annotationCanvasMap). The body is the rasterized appearance canvas; + * if pdf.js didn't divert it (no hasOwnCanvas), the box stays transparent + * over the main-canvas pixel and just captures clicks. */ +.annotation-imported { + position: absolute; + pointer-events: auto; + cursor: grab; + user-select: none; +} +.annotation-imported:hover { + outline: 1px dashed var(--accent, #2563eb); + outline-offset: 1px; +} + +/* Selection visuals */ +.annotation-selected { + outline: 2px solid var(--accent, #2563eb); + outline-offset: 2px; + z-index: 10; +} + +.annotation-handle { + position: absolute; + width: 8px; + height: 8px; + background: white; + border: 2px solid var(--accent, #2563eb); + border-radius: 50%; + z-index: 11; + pointer-events: auto; +} +.annotation-handle.nw { top: -5px; left: -5px; cursor: nwse-resize; } +.annotation-handle.ne { top: -5px; right: -5px; cursor: nesw-resize; } +.annotation-handle.sw { bottom: -5px; left: -5px; cursor: nesw-resize; } +.annotation-handle.se { bottom: -5px; right: -5px; cursor: nwse-resize; } + +.annotation-handle-rotate { + position: absolute; + top: -20px; + left: 50%; + transform: translateX(-50%); + width: 10px; + height: 10px; + background: white; + border: 2px solid var(--accent, #2563eb); + border-radius: 50%; + z-index: 11; + pointer-events: auto; + cursor: grab; +} + +.annotation-card.selected { + background: var(--accent-bg, rgba(37, 99, 235, 0.08)); + border-left-color: var(--accent, #2563eb); +} + +.annotation-dragging { + cursor: grabbing !important; +} + +@media (prefers-color-scheme: dark) { + .annotation-highlight { + background: rgba(255, 255, 0, 0.3); + mix-blend-mode: screen; + } +} + +/* Save / Download Buttons */ +.save-btn, +.download-btn { + display: flex; + align-items: center; + justify-content: center; + width: 32px; + height: 32px; + border: 1px solid var(--bg200); + border-radius: 4px; + background: var(--bg000); + color: var(--text000); + cursor: pointer; + font-size: 1rem; + transition: all 0.15s ease; +} + +.save-btn:hover:not(:disabled), +.download-btn:hover:not(:disabled) { + background: var(--bg100); + border-color: var(--bg300); +} + +.save-btn:disabled, +.download-btn:disabled { + opacity: 0.4; + cursor: not-allowed; +} + +/* + * Confirmation Dialog + * + * Styled to match the host's native dialogs (e.g. the downloadFile prompt). + * Uses host-provided CSS variables (set via applyHostStyleVariables) with + * local fallbacks so it still looks reasonable in standalone dev. + */ +.confirm-dialog { + position: fixed; + inset: 0; + z-index: 1000; + display: flex; + align-items: center; + justify-content: center; + background: light-dark(rgba(0, 0, 0, 0.4), rgba(0, 0, 0, 0.6)); + font-family: var(--font-sans, inherit); +} + +.confirm-box { + background: var(--color-background-primary, var(--bg000)); + border-radius: var(--border-radius-xl, 20px); + padding: 1.75rem; + min-width: 360px; + max-width: 520px; + box-shadow: var(--shadow-lg, 0 20px 50px rgba(0, 0, 0, 0.3)); +} + +.confirm-title { + font-weight: var(--font-weight-bold, 700); + font-size: var(--font-heading-md-size, 1.5rem); + line-height: var(--font-heading-md-line-height, 1.25); + margin-bottom: 0.5rem; + color: var(--color-text-primary, var(--text000)); +} + +.confirm-body { + font-size: var(--font-text-md-size, 1rem); + line-height: var(--font-text-md-line-height, 1.5); + color: var(--color-text-secondary, var(--text100)); + margin-bottom: 1.5rem; + word-break: break-word; +} + +/* Optional monospace detail box (filename, path, etc.) */ +.confirm-detail { + font-family: var(--font-mono, ui-monospace, monospace); + font-size: var(--font-text-sm-size, 0.9rem); + padding: 0.75rem 1rem; + margin-bottom: 1.5rem; + border: var(--border-width-regular, 1px) solid + var(--color-border-secondary, var(--bg200)); + border-radius: var(--border-radius-md, 8px); + background: var(--color-background-secondary, var(--bg100)); + color: var(--color-text-primary, var(--text000)); + word-break: break-all; +} + +.confirm-detail:empty { + display: none; +} + +.confirm-buttons { + display: flex; + gap: 0.75rem; + justify-content: flex-end; +} + +.confirm-btn { + padding: 0.625rem 1.25rem; + border: var(--border-width-regular, 1px) solid + var(--color-border-primary, var(--bg200)); + border-radius: var(--border-radius-md, 8px); + background: var(--color-background-primary, var(--bg000)); + color: var(--color-text-primary, var(--text000)); + cursor: pointer; + font: inherit; + font-size: var(--font-text-md-size, 0.95rem); + font-weight: var(--font-weight-medium, 500); +} + +.confirm-btn:hover { + background: var(--color-background-secondary, var(--bg100)); +} + +.confirm-btn-primary { + /* Host's native primary buttons use inverse colors (dark bg, light text) */ + background: var(--color-background-inverse, var(--text000)); + border-color: var(--color-background-inverse, var(--text000)); + color: var(--color-text-inverse, var(--bg000)); +} + +.confirm-btn-primary:hover { + /* .confirm-btn:hover above would otherwise reset background */ + background: var(--color-background-inverse, var(--text000)); + filter: brightness(1.15); +} + +/* Form Layer (PDF.js AnnotationLayer for interactive form widgets) */ +#form-layer { + position: absolute; + left: 0; + top: 0; + right: 0; + bottom: 0; + z-index: 4; /* above annotation-layer (z-index: 3) so form inputs are clickable */ +} + +/* + * PDF.js AnnotationLayer renders interactive form inputs on top of the canvas. + * When the widget is transparent the canvas's static appearance bleeds through, + * causing double-text (the widget font never matches the PDF's font metrics). + * Fix: force widgets opaque. PDF.js also reads the annotation's /BC entry and + * writes it as an inline `background-color` on the element (typically + * `transparent` for unstyled forms) β€” inline style beats any selector, hence + * !important. + */ +#form-layer .textWidgetAnnotation :is(input, textarea), +#form-layer .choiceWidgetAnnotation select { + background-image: none !important; + background-color: light-dark(#fff, #2a2a2a) !important; +} + +#form-layer select option:checked { + background: light-dark(#d0e0ff, #335); +} + + /* Highlight Layer */ .highlight-layer { position: absolute; @@ -442,6 +848,346 @@ body { } } +/* Viewer Body (flex row for canvas + panel) */ +.viewer-body { + display: flex; + flex: 1; + min-height: 0; + overflow: visible; + position: relative; /* Anchor for floating annotation panel */ +} + +/* Annotations Toolbar Button */ +.annotations-btn { + display: flex; + align-items: center; + justify-content: center; + width: 32px; + height: 32px; + border: 1px solid var(--bg200); + border-radius: 4px; + background: var(--bg000); + color: var(--text000); + cursor: pointer; + font-size: 1rem; + transition: all 0.15s ease; + position: relative; +} +.annotations-btn:hover { + background: var(--bg100); + border-color: var(--bg300); +} +.annotations-btn.active { + background: var(--bg200); + border-color: var(--bg300); +} + +.annotations-badge { + position: absolute; + top: -4px; + right: -4px; + min-width: 16px; + height: 16px; + background: var(--accent, #2563eb); + color: #fff; + font-size: 0.65rem; + font-weight: 600; + border-radius: 8px; + display: flex; + align-items: center; + justify-content: center; + padding: 0 3px; + line-height: 1; +} + +/* Annotation Side Panel */ +.annotation-panel { + width: 500px; + min-width: 180px; + max-width: 50vw; + background: var(--bg000); + border-left: 1px solid var(--bg200); + display: flex; + flex-direction: column; + overflow: hidden; + position: relative; +} + +/* Resize handle on left edge */ +.annotation-panel-resize { + position: absolute; + left: -3px; + top: 0; + bottom: 0; + width: 6px; + cursor: col-resize; + z-index: 10; +} +.annotation-panel-resize:hover, +.annotation-panel-resize.dragging { + background: var(--text100); + opacity: 0.3; +} + +.annotation-panel-header { + display: flex; + align-items: center; + justify-content: space-between; + padding: 0.5rem 0.75rem; + border-bottom: 1px solid var(--bg200); + flex-shrink: 0; +} + +.annotation-panel-title { + font-size: 0.85rem; + font-weight: 600; + color: var(--text000); +} + +.annotation-panel-header-actions { + display: flex; + align-items: center; + gap: 4px; +} + +.annotation-panel-reset, +.annotation-panel-clear-all { + border: none; + background: transparent; + color: var(--text100); + cursor: pointer; + border-radius: 4px; + padding: 4px; + display: flex; + align-items: center; + justify-content: center; +} +.annotation-panel-reset:hover { + color: var(--text000); + background: var(--bg100); +} +.annotation-panel-clear-all:hover { + color: #e74c3c; + background: var(--bg100); +} +.annotation-panel-reset:disabled, +.annotation-panel-clear-all:disabled { + opacity: 0.4; + cursor: not-allowed; +} + +.annotation-panel-close { + display: flex; + align-items: center; + justify-content: center; + width: 24px; + height: 24px; + border: none; + border-radius: 4px; + background: transparent; + color: var(--text100); + cursor: pointer; + font-size: 0.8rem; + transition: all 0.15s ease; +} +.annotation-panel-close:hover { + background: var(--bg100); + color: var(--text000); +} + +.annotation-panel-list { + flex: 1; + overflow-y: auto; + padding: 0.25rem 0; +} + +/* Floating annotation panel (used in both inline and fullscreen) */ +.annotation-panel.floating { + position: absolute; + z-index: 20; + border: 1px solid var(--bg200); + border-radius: 6px; + box-shadow: 0 2px 8px rgba(0, 0, 0, 0.15); + max-height: 60%; + width: 135px; + transition: top 0.15s ease, left 0.15s ease, right 0.15s ease, bottom 0.15s ease; +} +.annotation-panel.floating .annotation-panel-header { + cursor: grab; +} +.annotation-panel.floating.dragging .annotation-panel-header { + cursor: grabbing; +} + +/* Accordion section headers */ +.annotation-section-header { + font-size: 0.7rem; + font-weight: 600; + color: var(--text100); + padding: 0.3rem 0.6rem; + text-transform: uppercase; + letter-spacing: 0.03em; + cursor: pointer; + display: flex; + align-items: center; + justify-content: space-between; + border-bottom: 1px solid var(--bg200); + user-select: none; + transition: background 0.1s ease; +} +.annotation-section-header:hover { + background: var(--bg100); +} +.annotation-section-header.current-page { + color: var(--text000); +} +.annotation-section-header.open { + color: var(--text000); +} +.annotation-section-chevron { + font-size: 0.55rem; + transition: transform 0.15s ease; +} +.annotation-section-body { + display: none; +} +.annotation-section-body.open { + display: block; +} + +/* Legacy page group headers (fullscreen mode) */ +.annotation-page-group { + font-size: 0.75rem; + font-weight: 600; + color: var(--text100); + padding: 0.5rem 0.75rem 0.25rem; + text-transform: uppercase; + letter-spacing: 0.03em; +} +.annotation-page-group.current-page { + color: var(--text000); +} + +/* Annotation cards */ +.annotation-card { + display: flex; + flex-direction: column; + padding: 0.4rem 0.75rem; + cursor: pointer; + transition: background 0.1s ease; + border-left: 3px solid transparent; +} +.annotation-card:hover { + background: var(--bg100); +} +.annotation-card.highlighted { + background: var(--bg100); + border-left-color: var(--text100); +} + +.annotation-card-row { + display: flex; + align-items: center; + gap: 0.4rem; + min-height: 24px; +} + +.annotation-card-swatch { + width: 10px; + height: 10px; + border-radius: 2px; + flex-shrink: 0; + border: 1px solid rgba(0, 0, 0, 0.15); +} + +/* Swatch for baseline items the user cleared β€” outlined with a cross + instead of solid fill, so the panel still shows "this existed in the + file and you removed it" rather than vanishing. */ +.annotation-card-swatch-cleared { + background: transparent; + border-color: #4a90d9; + display: flex; + align-items: center; + justify-content: center; +} + +.annotation-card-cleared .annotation-card-type, +.annotation-card-cleared .annotation-card-preview { + opacity: 0.55; + text-decoration: line-through; +} + +.annotation-card-type { + font-size: 0.7rem; + color: var(--text200); + text-transform: uppercase; + letter-spacing: 0.03em; + flex-shrink: 0; +} + +.annotation-card-preview { + flex: 1; + min-width: 0; + font-size: 0.8rem; + color: var(--text000); + white-space: nowrap; + overflow: hidden; + text-overflow: ellipsis; +} + +.annotation-card-delete { + flex-shrink: 0; + margin-left: auto; + background: none; + border: none; + padding: 2px; + cursor: pointer; + color: var(--text200); + opacity: 0; + transition: opacity 0.1s ease, color 0.1s ease; + display: flex; + align-items: center; +} +.annotation-card:hover .annotation-card-delete { + opacity: 1; +} +.annotation-card-delete:hover { + color: #d32f2f; +} + +.annotation-card-expand { + flex-shrink: 0; + font-size: 0.65rem; + color: var(--text200); + transition: transform 0.15s ease; +} +.annotation-card.expanded .annotation-card-expand { + transform: rotate(180deg); +} + +.annotation-card-content { + display: none; + font-size: 0.8rem; + color: var(--text100); + padding: 0.25rem 0 0.25rem 14px; + white-space: pre-wrap; + word-break: break-word; + line-height: 1.4; +} +.annotation-card.expanded .annotation-card-content { + display: block; +} + +/* Pulse animation for annotation elements on PDF */ +@keyframes annotation-pulse { + 0% { box-shadow: 0 0 0 0 rgba(255, 165, 0, 0.6); } + 70% { box-shadow: 0 0 0 8px rgba(255, 165, 0, 0); } + 100% { box-shadow: 0 0 0 0 rgba(255, 165, 0, 0); } +} +.annotation-pulse { + animation: annotation-pulse 0.6s ease-out 2; +} + /* Loading Indicator (pie) */ .loading-indicator { display: inline-flex; @@ -468,3 +1214,36 @@ body { .loading-indicator.error .loading-indicator-arc { stroke: #e74c3c; } + + +/* Compact toolbar on narrow screens */ +@media (max-width: 480px) { + .toolbar-left { + display: none; + } + .toolbar { + justify-content: center; + } + .nav-btn, + .zoom-btn, + .search-btn, + .fullscreen-btn { + width: 28px; + height: 28px; + font-size: 0.85rem; + } + .page-input { + width: 40px; + padding: 0.2rem 0.3rem; + font-size: 0.8rem; + } + .total-pages, + .zoom-level { + font-size: 0.75rem; + min-width: 36px; + } + .toolbar-center, + .toolbar-right { + gap: 0.2rem; + } +} \ No newline at end of file diff --git a/examples/pdf-server/src/mcp-app.ts b/examples/pdf-server/src/mcp-app.ts index 4278d92..45e0c74 100644 --- a/examples/pdf-server/src/mcp-app.ts +++ b/examples/pdf-server/src/mcp-app.ts @@ -12,36 +12,177 @@ import { applyDocumentTheme, applyHostStyleVariables, } from "@modelcontextprotocol/ext-apps"; -import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js"; -import type { ContentBlock } from "@modelcontextprotocol/sdk/spec.types.js"; +import type { + CallToolResult, + ContentBlock, +} from "@modelcontextprotocol/client"; +import { z } from "zod"; import * as pdfjsLib from "pdfjs-dist"; -import { TextLayer } from "pdfjs-dist"; +import { AnnotationLayer, AnnotationMode, TextLayer } from "pdfjs-dist"; +import "pdfjs-dist/web/pdf_viewer.css"; +import { + type PdfAnnotationDef, + type Rect, + type RectangleAnnotation, + type CircleAnnotation, + type LineAnnotation, + type StampAnnotation, + type ImageAnnotation, + type ImportedAnnotation, + type NoteAnnotation, + type FreetextAnnotation, + cssColorToRgb, + serializeDiff, + deserializeDiff, + mergeAnnotations, + computeDiff, + isDiffEmpty, + buildAnnotatedPdfBytes, + parseAnnotationRef, + importPdfjsAnnotation, + uint8ArrayToBase64, + convertFromModelCoords, + convertToModelCoords, +} from "./pdf-annotations.js"; +import { + type TrackedAnnotation, + type EditEntry, + annotationMap, + formFieldValues, + pdfBaselineFormValues, + selectedAnnotationIds, + fieldNameToIds, + fieldNameToPage, + fieldNameToLabel, + fieldNameToOrder, + undoStack, + redoStack, + searchBarEl, + formLayerEl, +} from "./viewer-state.js"; +import { + panelState, + annotationsPanelEl, + annotationsPanelListEl, + renderAnnotationPanel, + updateAnnotationsBadge, + setAnnotationPanelOpen, + applyFloatingPanelPosition, + autoDockPanel, + initAnnotationPanel, + syncSidebarSelection, + getFormFieldLabel, + getAnnotationLabel, + getAnnotationPreview, + getAnnotationColor, +} from "./annotation-panel.js"; import "./global.css"; import "./mcp-app.css"; const MAX_MODEL_CONTEXT_LENGTH = 15000; -const MAX_MODEL_CONTEXT_UPDATE_IMAGE_DIMENSION = 768; // Max screenshot dimension // Configure PDF.js worker pdfjsLib.GlobalWorkerOptions.workerSrc = new URL( "pdfjs-dist/build/pdf.worker.mjs", import.meta.url, ).href; +// PDF Standard-14 fonts from CDN (requires unpkg.com in CSP connectDomains). +// Pinned to the bundled pdfjs-dist version so font glyph indices match. +const STANDARD_FONT_DATA_URL = `https://unpkg.com/pdfjs-dist@${pdfjsLib.version}/standard_fonts/`; + const log = { info: console.log.bind(console, "[PDF-VIEWER]"), error: console.error.bind(console, "[PDF-VIEWER]"), }; +/** + * Resolve an ImageAnnotation to a src string safe for ``. + * Returns the parsed-and-reserialized URL (`URL.href`) rather than the + * raw input so CodeQL's taint tracker recognises the sanitisation barrier + * (js/xss, js/client-side-unvalidated-url-redirection). Blocks + * `javascript:` / `vbscript:` etc. The server normally resolves + * imageUrl β†’ imageData before enqueueing; the imageUrl branch here is + * defense-in-depth for the server-side fetch-failure fallback. + */ +function safeImageSrc(def: { + imageData?: string; + mimeType?: string; + imageUrl?: string; +}): string | undefined { + if (def.imageData) { + return `data:${def.mimeType || "image/png"};base64,${def.imageData}`; + } + if (!def.imageUrl) return undefined; + try { + const parsed = new URL(def.imageUrl, document.baseURI); + if ( + parsed.protocol === "https:" || + parsed.protocol === "http:" || + parsed.protocol === "data:" || + parsed.protocol === "blob:" + ) { + return parsed.href; + } + } catch { + // fall through + } + return undefined; +} + // State let pdfDocument: pdfjsLib.PDFDocumentProxy | null = null; let currentPage = 1; let totalPages = 0; let scale = 1.0; +const ZOOM_MIN = 0.5; +const ZOOM_MAX = 3.0; let pdfUrl = ""; let pdfTitle: string | undefined; let viewUUID: string | undefined; +let interactEnabled = false; +/** Server-reported writability of the underlying file (fs.access W_OK). */ +let fileWritable = false; let currentRenderTask: { cancel: () => void } | null = null; +// Shared annotation state (annotationMap, formFieldValues, selectedAnnotationIds, +// undoStack, redoStack, fieldNameTo*) lives in ./viewer-state.ts β€” imported above. + +/** Cache loaded HTMLImageElement instances by annotation ID for canvas painting. */ +const imageCache = new Map(); + +/** Annotations imported from the PDF file (baseline for diff computation). */ +let pdfBaselineAnnotations: PdfAnnotationDef[] = []; +/** Pages whose native annotations have already been imported into the baseline. */ +const baselineScannedPages = new Set(); +/** Native-annotation ids the user deleted (from restored localStorage diff) β€” + * the lazy per-page scan must NOT re-add these to annotationMap. */ +const restoredRemovedIds = new Set(); + +// Dirty flag β€” tracks unsaved local changes +let isDirty = false; +/** Whether we're currently restoring annotations (suppress dirty flag). */ +let isRestoring = false; +/** Once the save button is shown, it stays visible (possibly disabled) until reload. */ +let saveBtnEverShown = false; +/** True between save_pdf call and resolution; suppresses file_changed handling. */ +let saveInProgress = false; +/** mtime returned by our most recent successful save_pdf. Compare against + * incoming file_changed.mtimeMs to suppress our own write's echo. */ +let lastSavedMtime: number | null = null; +/** Incremented on every reload. Fetches/preloads from an older generation are + * discarded β€” prevents stale rangeCache entries and stale page renders. */ +let loadGeneration = 0; + +let focusedFieldName: string | null = null; + +// Radio widget annotation ID β†’ its export value (buttonValue). pdf.js +// creates without setting .value, so target.value +// defaults to "on"; this map lets the input listener report the real value. +const radioButtonValues = new Map(); +// Cached result of doc.getFieldObjects() β€” needed for AnnotationLayer reset button support +// eslint-disable-next-line @typescript-eslint/no-explicit-any +let cachedFieldObjects: Record | null = null; + // DOM Elements const mainEl = document.querySelector(".main") as HTMLElement; const loadingEl = document.getElementById("loading")!; @@ -65,7 +206,7 @@ const fullscreenBtn = document.getElementById( ) as HTMLButtonElement; const searchBtn = document.getElementById("search-btn") as HTMLButtonElement; searchBtn.innerHTML = ``; -const searchBarEl = document.getElementById("search-bar")!; +// searchBarEl β†’ imported from ./viewer-state.js const searchInputEl = document.getElementById( "search-input", ) as HTMLInputElement; @@ -80,6 +221,22 @@ const searchCloseBtn = document.getElementById( "search-close-btn", ) as HTMLButtonElement; const highlightLayerEl = document.getElementById("highlight-layer")!; +const annotationLayerEl = document.getElementById("annotation-layer")!; +const pageWrapperEl = document.querySelector(".page-wrapper") as HTMLElement; +// formLayerEl β†’ imported from ./viewer-state.js +const saveBtn = document.getElementById("save-btn") as HTMLButtonElement; +const downloadBtn = document.getElementById( + "download-btn", +) as HTMLButtonElement; +const confirmDialogEl = document.getElementById( + "confirm-dialog", +) as HTMLDivElement; +const confirmTitleEl = document.getElementById("confirm-title")!; +const confirmBodyEl = document.getElementById("confirm-body")!; +const confirmDetailEl = document.getElementById("confirm-detail")!; +const confirmButtonsEl = document.getElementById("confirm-buttons")!; + +// Annotation Panel DOM Elements & state β†’ ./annotation-panel.ts (imported above) // Search state interface SearchMatch { @@ -109,13 +266,126 @@ const loadingIndicatorArc = loadingIndicatorEl.querySelector( // Track current display mode let currentDisplayMode: "inline" | "fullscreen" = "inline"; +// Whether the user has manually zoomed (disables auto fit-to-width) +let userHasZoomed = false; + +/** + * Compute the scale that best fits the PDF page to the container. + * Returns null only when the container hasn't laid out yet. + * + * Inline mode: fit-to-WIDTH capped at 1.0. We shrink to fit a narrow chat + * column but don't blow up past natural size β€” the iframe sizes itself to + * the page via sendSizeChanged, so growing past 1.0 would just make the + * iframe huge. + * + * Fullscreen mode: fit-to-PAGE capped at ZOOM_MAX. The whole page is visible + * without scrolling (min of width-fit and height-fit). On a wide screen this + * typically lands well above 1.0; on a phone in portrait, width is the + * tighter constraint and it degrades to fit-to-width. + */ +async function computeFitScale(): Promise { + if (!pdfDocument) return null; + + try { + const page = await pdfDocument.getPage(currentPage); + const naturalViewport = page.getViewport({ scale: 1.0 }); + const pageWidth = naturalViewport.width; + const pageHeight = naturalViewport.height; + + const container = canvasContainerEl as HTMLElement; + const containerStyle = getComputedStyle(container); + const padX = + parseFloat(containerStyle.paddingLeft) + + parseFloat(containerStyle.paddingRight); + const padY = + parseFloat(containerStyle.paddingTop) + + parseFloat(containerStyle.paddingBottom); + const availableWidth = container.clientWidth - padX; + const availableHeight = container.clientHeight - padY; + + if (availableWidth <= 0 || pageWidth <= 0) return null; + + const widthFit = availableWidth / pageWidth; + if (currentDisplayMode !== "fullscreen") { + return Math.min(1.0, widthFit); + } + // Fullscreen: fit the WHOLE page. If height isn't measurable yet + // (early layout) fall back to width-fit. + const heightFit = + availableHeight > 0 && pageHeight > 0 + ? availableHeight / pageHeight + : widthFit; + return Math.min(ZOOM_MAX, widthFit, heightFit); + } catch { + return null; + } +} + +/** + * Re-apply the auto-fit scale if the user hasn't taken over zoom. Runs on + * container resize (ResizeObserver) and display-mode transitions. + * + * The ResizeObserver path is the load-bearing one. Hosts disagree on + * what they send and when: + * - basic-host sends containerDimensions only at init, never on resize + * - Claude Desktop resizes the iframe and sends displayMode, but the + * iframe element may not have its new size yet when the message lands + * The observer fires after the iframe has actually laid out at the new + * size, so clientWidth is fresh. The hostContextChanged hooks are kept + * as a fast path / belt-and-suspenders. + */ +async function refitScale(): Promise { + if (!pdfDocument || userHasZoomed) return; + const fitScale = await computeFitScale(); + if (fitScale !== null && Math.abs(fitScale - scale) > 0.01) { + scale = fitScale; + log.info("Refit scale:", scale); + renderPage(); + } +} + +// Refit when the container actually changes size. In INLINE mode this is +// gated to width-GROWTH only β€” renderPage() β†’ requestFitToContent() β†’ host +// resizes iframe to the (smaller) page width would otherwise re-trigger the +// observer and walk the scale down to ZOOM_MIN. In FULLSCREEN +// requestFitToContent early-returns so there's no loop, and fit-to-page +// needs height changes too (rotation, browser chrome on mobile). +let lastContainerW = 0; +let lastContainerH = 0; +/** One-shot: refit on the next resize even if it's a shrink in inline mode. + * Set on fullscreenβ†’inline so the page snaps to the new (smaller) width + * once the host has actually resized the iframe β€” the inline `grewW` gate + * would otherwise swallow that shrink. */ +let forceNextResizeRefit = false; +const containerResizeObserver = new ResizeObserver(([entry]) => { + const { width: w, height: h } = entry.contentRect; + const grewW = w > lastContainerW + 1; + const changed = + Math.abs(w - lastContainerW) > 1 || Math.abs(h - lastContainerH) > 1; + lastContainerW = w; + lastContainerH = h; + if (forceNextResizeRefit && changed) { + forceNextResizeRefit = false; + refitScale(); + } else if (currentDisplayMode === "fullscreen" ? changed : grewW) { + refitScale(); + } +}); +containerResizeObserver.observe(canvasContainerEl as HTMLElement); + /** * Request the host to resize the app to fit the current PDF page. * Only applies in inline mode - fullscreen mode uses scrolling. */ function requestFitToContent() { - if (currentDisplayMode === "fullscreen") { - return; // Fullscreen uses scrolling + // Read the host's current state, not our cached currentDisplayMode. + // currentDisplayMode defaults to "inline" and handleHostContextChanged + // only updates it `if (ctx.displayMode)` β€” if the host omits the field + // or the update lands one tick late, the cached value lies. We've seen + // this measure a near-empty pageWrapper (~85px = toolbar + padding) and + // shrink a fullscreen iframe to a sliver. + if (app.getHostContext()?.displayMode === "fullscreen") { + return; } const canvasHeight = canvasEl.height; @@ -124,13 +394,9 @@ function requestFitToContent() { } // Get actual element dimensions - const canvasContainerEl = document.querySelector( - ".canvas-container", - ) as HTMLElement; - const pageWrapperEl = document.querySelector(".page-wrapper") as HTMLElement; const toolbarEl = document.querySelector(".toolbar") as HTMLElement; - if (!canvasContainerEl || !toolbarEl || !pageWrapperEl) { + if (!toolbarEl) { return; } @@ -148,7 +414,20 @@ function requestFitToContent() { const totalHeight = toolbarHeight + paddingTop + pageWrapperHeight + paddingBottom + BUFFER; - app.sendSizeChanged({ height: totalHeight }); + // In inline mode (this function early-returns for fullscreen) the side panel is hidden + const totalWidth = pageWrapperEl.offsetWidth + BUFFER; + + // pageWrapper measuring β‰ˆ 0 means the canvas hasn't laid out yet (early + // render, hidden ancestor, etc). Sending toolbar-height-only would shrink + // the iframe to a sliver. The next renderPage() will measure correctly. + if (pageWrapperHeight < toolbarHeight) { + log.info( + `requestFitToContent: pageWrapper ${pageWrapperHeight}px < toolbar ${toolbarHeight}px β€” skipping`, + ); + return; + } + + app.sendSizeChanged({ width: totalWidth, height: totalHeight }); } // --- Search Functions --- @@ -194,6 +473,46 @@ function performSearch(query: string) { goToPage(match.pageNum); } } + + // Update model context with search results + updatePageContext(); +} + +/** + * Silent search: populate matches and report via model context + * without opening the search bar or rendering highlights. + */ +function performSilentSearch(query: string) { + allMatches = []; + currentMatchIndex = -1; + searchQuery = query; + + if (!query) { + updatePageContext(); + return; + } + + const lowerQuery = query.toLowerCase(); + for (let pageNum = 1; pageNum <= totalPages; pageNum++) { + const pageText = pageTextCache.get(pageNum); + if (!pageText) continue; + const lowerText = pageText.toLowerCase(); + let startIdx = 0; + while (true) { + const idx = lowerText.indexOf(lowerQuery, startIdx); + if (idx === -1) break; + allMatches.push({ pageNum, index: idx, length: query.length }); + startIdx = idx + 1; + } + } + + if (allMatches.length > 0) { + const idx = allMatches.findIndex((m) => m.pageNum >= currentPage); + currentMatchIndex = idx >= 0 ? idx : 0; + } + + log.info(`Silent search "${query}": ${allMatches.length} matches`); + updatePageContext(); } function renderHighlights() { @@ -325,6 +644,9 @@ function openSearch() { searchBarEl.style.display = "flex"; updateSearchUI(); searchInputEl.focus(); + if (panelState.open && annotationsPanelEl.classList.contains("floating")) { + applyFloatingPanelPosition(); + } // Text extraction is handled by the background preloader } @@ -332,6 +654,9 @@ function closeSearch() { if (!searchOpen) return; searchOpen = false; searchBarEl.style.display = "none"; + if (panelState.open && annotationsPanelEl.classList.contains("floating")) { + applyFloatingPanelPosition(); + } searchQuery = ""; searchInputEl.value = ""; allMatches = []; @@ -402,10 +727,156 @@ function showViewer() { viewerEl.style.display = "flex"; } +// --------------------------------------------------------------------------- +// Confirm dialog +// --------------------------------------------------------------------------- + +interface ConfirmButton { + label: string; + primary?: boolean; +} + +let activeConfirmResolve: ((i: number) => void) | null = null; + +/** + * In-app confirmation overlay. Resolves to the clicked button index, the + * cancel index on Escape, or `-1` if pre-empted by another dialog. Callers + * should treat anything but the expected button index as "cancel". + * + * Button ordering follows the host's native convention: Cancel first, + * primary action last. + * + * @param detail Optional monospace string shown in a bordered box (e.g. + * a filename), matching the host's native dialog style. + */ +function showConfirmDialog( + title: string, + body: string, + buttons: ConfirmButton[], + detail?: string, +): Promise { + // Pre-empt any open dialog: resolve it as cancelled + if (activeConfirmResolve) { + activeConfirmResolve(-1); + activeConfirmResolve = null; + } + + // Escape β†’ first non-primary button (native Cancel-first ordering) + const nonPrimary = buttons.findIndex((b) => !b.primary); + const escIndex = nonPrimary >= 0 ? nonPrimary : buttons.length - 1; + + confirmTitleEl.textContent = title; + confirmBodyEl.textContent = body; + confirmDetailEl.textContent = detail ?? ""; + confirmButtonsEl.innerHTML = ""; + confirmDialogEl.style.display = "flex"; + + return new Promise((resolve) => { + activeConfirmResolve = resolve; + + const done = (i: number): void => { + if (activeConfirmResolve !== resolve) return; // already pre-empted + activeConfirmResolve = null; + confirmDialogEl.style.display = "none"; + document.removeEventListener("keydown", onKey, true); + resolve(i); + }; + + const onKey = (e: KeyboardEvent): void => { + if (e.key === "Escape") { + e.preventDefault(); + e.stopPropagation(); + done(escIndex); + } + }; + document.addEventListener("keydown", onKey, true); + + buttons.forEach((btn, i) => { + const el = document.createElement("button"); + el.textContent = btn.label; + el.className = btn.primary + ? "confirm-btn confirm-btn-primary" + : "confirm-btn"; + el.addEventListener("click", () => done(i)); + confirmButtonsEl.appendChild(el); + if (btn.primary) setTimeout(() => el.focus(), 0); + }); + }); +} + +function setDirty(dirty: boolean): void { + if (isDirty === dirty) return; + isDirty = dirty; + updateTitleDisplay(); + updateSaveBtn(); +} + +function updateSaveBtn(): void { + if (!fileWritable) { + saveBtn.style.display = "none"; + return; + } + if (isDirty) { + saveBtn.style.display = ""; + saveBtn.disabled = false; + saveBtnEverShown = true; + } else if (saveBtnEverShown) { + saveBtn.style.display = ""; + saveBtn.disabled = true; + } else { + saveBtn.style.display = "none"; + } +} + +function updateTitleDisplay(): void { + const display = pdfTitle || pdfUrl; + titleEl.textContent = (isDirty ? "* " : "") + display; + titleEl.title = pdfUrl; +} + +/** + * Debug overlay: fixed-position bubble, bottom-left. Pretty-printed JSON + * dump of whatever the server stuffed into `_meta._debug`. Tooltips inside + * sandboxed iframes are unreliable; this survives the cross-origin barrier + * and shows up in screenshots. + */ +function showDebugBubble(debug: unknown): void { + const bubble = document.createElement("div"); + const base = + "position:fixed;bottom:8px;left:8px;z-index:99999;" + + "background:rgba(20,20,30,0.92);color:#cfe;padding:8px 12px;" + + "font:11px/1.4 monospace;border-radius:6px;" + + "box-shadow:0 2px 8px rgba(0,0,0,0.4);white-space:pre;cursor:pointer;" + + "transition:max-width 0.15s ease;"; + // Collapsed: clip to 60vw. Hover: expand to fit full paths (up to ~96vw), + // scrollable both axes in case the JSON is tall. + const collapsed = + base + + "max-width:60vw;max-height:40vh;overflow:hidden;text-overflow:ellipsis;"; + const expanded = + base + "max-width:calc(100vw - 32px);max-height:80vh;overflow:auto;"; + bubble.style.cssText = collapsed; + // Latch expanded on click so hover-collapse doesn't fight text selection. + let pinned = false; + bubble.onmouseenter = () => { + bubble.style.cssText = expanded; + }; + bubble.onmouseleave = () => { + if (!pinned) bubble.style.cssText = collapsed; + }; + bubble.onclick = () => { + pinned = true; + bubble.style.cssText = expanded; + }; + bubble.ondblclick = () => bubble.remove(); + bubble.title = "Click: pin open β€’ Double-click: dismiss"; + bubble.textContent = "🐞 " + JSON.stringify(debug, null, 2); + document.body.appendChild(bubble); +} + function updateControls() { // Show URL with CSS ellipsis, full URL as tooltip, clickable to open - titleEl.textContent = pdfUrl; - titleEl.title = pdfUrl; + updateTitleDisplay(); titleEl.style.textDecoration = "underline"; titleEl.style.cursor = "pointer"; titleEl.onclick = () => app.openLink({ url: pdfUrl }); @@ -511,6 +982,50 @@ function findSelectionInText( return undefined; } +/** + * Format search results with excerpts for model context. + * Limits to first 20 matches to avoid overwhelming the context. + */ +function formatSearchResults(): string { + const MAX_RESULTS = 20; + const EXCERPT_RADIUS = 40; // characters around the match + + const lines: string[] = []; + const totalMatchCount = allMatches.length; + const currentIdx = currentMatchIndex >= 0 ? currentMatchIndex : -1; + + lines.push( + `\nSearch: "${searchQuery}" (${totalMatchCount} match${totalMatchCount !== 1 ? "es" : ""} across ${new Set(allMatches.map((m) => m.pageNum)).size} page${new Set(allMatches.map((m) => m.pageNum)).size !== 1 ? "s" : ""})`, + ); + + const displayed = allMatches.slice(0, MAX_RESULTS); + for (let i = 0; i < displayed.length; i++) { + const match = displayed[i]; + const pageText = pageTextCache.get(match.pageNum) || ""; + const start = Math.max(0, match.index - EXCERPT_RADIUS); + const end = Math.min( + pageText.length, + match.index + match.length + EXCERPT_RADIUS, + ); + const before = pageText.slice(start, match.index).replace(/\n/g, " "); + const matched = pageText.slice(match.index, match.index + match.length); + const after = pageText + .slice(match.index + match.length, end) + .replace(/\n/g, " "); + const prefix = start > 0 ? "..." : ""; + const suffix = end < pageText.length ? "..." : ""; + const current = i === currentIdx ? " (current)" : ""; + lines.push( + ` [${i}] p.${match.pageNum}, offset ${match.index}${current}: ${prefix}${before}Β«${matched}Β»${after}${suffix}`, + ); + } + if (totalMatchCount > MAX_RESULTS) { + lines.push(` ... and ${totalMatchCount - MAX_RESULTS} more matches`); + } + + return lines.join("\n"); +} + // Extract text from current page and update model context async function updatePageContext() { if (!pdfDocument) return; @@ -547,15 +1062,79 @@ async function updatePageContext() { selection, ); + // Get page dimensions in PDF points for model context + const viewport = page.getViewport({ scale: 1.0 }); + const pageWidthPt = Math.round(viewport.width); + const pageHeightPt = Math.round(viewport.height); + // Build context with tool ID for multi-tool disambiguation const toolId = app.getHostContext()?.toolInfo?.id; const header = [ `PDF viewer${toolId ? ` (${toolId})` : ""}`, + viewUUID ? `viewUUID: ${viewUUID}` : null, pdfTitle ? `"${pdfTitle}"` : pdfUrl, `Current Page: ${currentPage}/${totalPages}`, - ].join(" | "); + `Page size: ${pageWidthPt}Γ—${pageHeightPt}pt (coordinates: origin at top-left, Y increases downward)`, + ] + .filter(Boolean) + .join(" | "); - const contextText = `${header}\n\nPage content:\n${content}`; + // Include search status if active + let searchSection = ""; + if (searchOpen && searchQuery && allMatches.length > 0) { + searchSection = formatSearchResults(); + } else if (searchOpen && searchQuery) { + searchSection = `\nSearch: "${searchQuery}" (no matches found)`; + } + + // Include annotation details if any exist + let annotationSection = ""; + if (annotationMap.size > 0) { + const onThisPage = [...annotationMap.values()].filter( + (t) => t.def.page === currentPage, + ); + annotationSection = `\nAnnotations: ${onThisPage.length} on this page, ${annotationMap.size} total`; + if (formFieldValues.size > 0) { + annotationSection += ` | ${formFieldValues.size} form field(s) filled`; + } + // List annotations on current page with their coordinates (in model space) + if (onThisPage.length > 0) { + annotationSection += + "\nAnnotations on this page (visible in screenshot):"; + for (const t of onThisPage) { + const d = convertToModelCoords(t.def, pageHeightPt); + const selected = selectedAnnotationIds.has(d.id) ? " (SELECTED)" : ""; + if ("rects" in d && d.rects.length > 0) { + const r = d.rects[0]; + annotationSection += `\n [${d.id}] ${d.type} at (${Math.round(r.x)},${Math.round(r.y)}) ${Math.round(r.width)}x${Math.round(r.height)}${selected}`; + } else if ("x" in d && "y" in d) { + annotationSection += `\n [${d.id}] ${d.type} at (${Math.round(d.x)},${Math.round(d.y)})${selected}`; + } + } + } + } + + // Include focused field or selected annotation info + let focusSection = ""; + if (selectedAnnotationIds.size > 0) { + const ids = [...selectedAnnotationIds]; + const descs = ids.map((selId) => { + const tracked = annotationMap.get(selId); + if (!tracked) return selId; + return `[${selId}] (${tracked.def.type})`; + }); + focusSection = `\nSelected: ${descs.join(", ")}`; + } + if (focusedFieldName) { + const label = getFormFieldLabel(focusedFieldName); + const value = formFieldValues.get(focusedFieldName); + focusSection += `\nFocused field: "${label}" (name="${focusedFieldName}")`; + if (value !== undefined) { + focusSection += ` = ${JSON.stringify(value)}`; + } + } + + const contextText = `${header}${searchSection}${annotationSection}${focusSection}\n\nPage content:\n${content}`; // Build content array with text and optional screenshot const contentBlocks: ContentBlock[] = [{ type: "text", text: contextText }]; @@ -563,34 +1142,15 @@ async function updatePageContext() { // Add screenshot if host supports image content if (app.getHostCapabilities()?.updateModelContext?.image) { try { - // Scale down to reduce token usage (tokens depend on dimensions) - const sourceCanvas = canvasEl; - const scale = Math.min( - 1, - MAX_MODEL_CONTEXT_UPDATE_IMAGE_DIMENSION / - Math.max(sourceCanvas.width, sourceCanvas.height), - ); - const targetWidth = Math.round(sourceCanvas.width * scale); - const targetHeight = Math.round(sourceCanvas.height * scale); - - const tempCanvas = document.createElement("canvas"); - tempCanvas.width = targetWidth; - tempCanvas.height = targetHeight; - const ctx = tempCanvas.getContext("2d"); - if (ctx) { - ctx.drawImage(sourceCanvas, 0, 0, targetWidth, targetHeight); - const dataUrl = tempCanvas.toDataURL("image/png"); - const base64Data = dataUrl.split(",")[1]; - if (base64Data) { - contentBlocks.push({ - type: "image", - data: base64Data, - mimeType: "image/png", - }); - log.info( - `Added screenshot to model context (${targetWidth}x${targetHeight})`, - ); - } + // Render offscreen with ENABLE_STORAGE so filled form fields are visible + const base64Data = await renderPageOffscreen(currentPage); + if (base64Data) { + contentBlocks.push({ + type: "image", + data: base64Data, + mimeType: "image/jpeg", + }); + log.info("Added screenshot to model context"); } } catch (err) { log.info("Failed to capture screenshot:", err); @@ -603,6 +1163,2115 @@ async function updatePageContext() { } } +// ============================================================================= +// Annotation Rendering +// ============================================================================= + +/** + * Convert PDF coordinates (bottom-left origin) to screen coordinates + * relative to the page wrapper. PDF.js viewport handles rotation and scale. + */ +function pdfRectToScreen( + rect: Rect, + viewport: { width: number; height: number; scale: number }, +): { left: number; top: number; width: number; height: number } { + const s = viewport.scale; + // PDF origin is bottom-left, screen origin is top-left + const left = rect.x * s; + const top = viewport.height - (rect.y + rect.height) * s; + const width = rect.width * s; + const height = rect.height * s; + return { left, top, width, height }; +} + +function pdfPointToScreen( + x: number, + y: number, + viewport: { width: number; height: number; scale: number }, +): { left: number; top: number } { + const s = viewport.scale; + return { left: x * s, top: viewport.height - y * s }; +} + +/** Convert a screen-space delta (pixels) to a PDF-space delta. */ +function screenToPdfDelta(dx: number, dy: number): { dx: number; dy: number } { + return { dx: dx / scale, dy: -dy / scale }; +} + +// ============================================================================= +// Undo / Redo +// ============================================================================= + +function pushEdit(entry: EditEntry): void { + undoStack.push(entry); + redoStack.length = 0; +} + +function undo(): void { + const entry = undoStack.pop(); + if (!entry) return; + redoStack.push(entry); + applyEdit(entry, true); +} + +function redo(): void { + const entry = redoStack.pop(); + if (!entry) return; + undoStack.push(entry); + applyEdit(entry, false); +} + +function applyEdit(entry: EditEntry, reverse: boolean): void { + const state = reverse ? entry.before : entry.after; + if (entry.type === "add") { + if (reverse) { + removeAnnotation(entry.id, true); + } else { + addAnnotation(state!, true); + } + } else if (entry.type === "remove") { + if (reverse) { + addAnnotation(state!, true); + } else { + removeAnnotation(entry.id, true); + } + } else { + if (state) { + const tracked = annotationMap.get(entry.id); + if (tracked) { + tracked.def = { ...state }; + } else { + annotationMap.set(entry.id, { def: { ...state }, elements: [] }); + } + } + renderAnnotationsForPage(currentPage); + renderAnnotationPanel(); + } + persistAnnotations(); +} + +// ============================================================================= +// Selection +// ============================================================================= + +/** + * Select annotation(s). Pass null to deselect all. + * If additive is true, toggle the given id without clearing existing selection. + */ +function selectAnnotation(id: string | null, additive = false): void { + if (!additive) { + // Clear all existing selection visuals + for (const prevId of selectedAnnotationIds) { + const tracked = annotationMap.get(prevId); + if (tracked) { + for (const el of tracked.elements) { + el.classList.remove("annotation-selected"); + } + } + } + // Remove handles + for (const h of annotationLayerEl.querySelectorAll( + ".annotation-handle, .annotation-handle-rotate", + )) { + h.remove(); + } + selectedAnnotationIds.clear(); + } + + if (id) { + if (additive && selectedAnnotationIds.has(id)) { + // Toggle off + selectedAnnotationIds.delete(id); + const tracked = annotationMap.get(id); + if (tracked) { + for (const el of tracked.elements) { + el.classList.remove("annotation-selected"); + } + } + } else { + selectedAnnotationIds.add(id); + } + } + + // Apply selection visuals + handles on all selected + // Only show handles when exactly one annotation is selected + for (const selId of selectedAnnotationIds) { + const tracked = annotationMap.get(selId); + if (tracked) { + for (const el of tracked.elements) { + el.classList.add("annotation-selected"); + } + if (selectedAnnotationIds.size === 1) { + showHandles(tracked); + } + } + } + + // Auto-expand the accordion section for the selected annotation's page + if (id) { + const tracked = annotationMap.get(id); + if (tracked) { + panelState.openAccordionSection = `page-${tracked.def.page}`; + } + } + + // Re-render the panel so accordion sections open/close to match selection + renderAnnotationPanel(); + + // Scroll the selected card into view in the sidebar + if (id) { + const card = annotationsPanelListEl.querySelector( + `.annotation-card[data-annotation-id="${id}"]`, + ); + if (card) { + card.scrollIntoView({ behavior: "smooth", block: "nearest" }); + } + } + + // Sync sidebar + syncSidebarSelection(); + // Auto-dock floating panel away from selected annotation + if ( + selectedAnnotationIds.size > 0 && + annotationsPanelEl.classList.contains("floating") && + panelState.open + ) { + autoDockPanel(); + } + // Update model context with selection info + updatePageContext(); +} + +/** Types that support resize handles (need width/height). */ +const RESIZABLE_TYPES = new Set(["rectangle", "circle", "image"]); +/** Types that support rotation. */ +const ROTATABLE_TYPES = new Set(["rectangle", "stamp", "image"]); + +function showHandles(tracked: TrackedAnnotation): void { + const def = tracked.def; + if (tracked.elements.length === 0) return; + if (!RESIZABLE_TYPES.has(def.type) && !ROTATABLE_TYPES.has(def.type)) return; + + const el = tracked.elements[0]; + + // Resize handles (corners) for types with width/height + if (RESIZABLE_TYPES.has(def.type) && "width" in def && "height" in def) { + for (const corner of ["nw", "ne", "sw", "se"] as const) { + const handle = document.createElement("div"); + handle.className = `annotation-handle ${corner}`; + handle.dataset.corner = corner; + const isImagePreserve = + def.type === "image" && + ((def as ImageAnnotation).aspect ?? "preserve") === "preserve"; + handle.title = isImagePreserve + ? "Drag to resize (Shift for free resize)" + : "Drag to resize (Shift to keep proportions)"; + setupResizeHandle(handle, tracked, corner); + el.appendChild(handle); + } + } + + // Rotate handle for rotatable types + if (ROTATABLE_TYPES.has(def.type)) { + const handle = document.createElement("div"); + handle.className = "annotation-handle-rotate"; + handle.title = "Drag to rotate"; + setupRotateHandle(handle, tracked); + el.appendChild(handle); + } +} + +// ============================================================================= +// Drag (move) +// ============================================================================= + +const DRAGGABLE_TYPES = new Set([ + "rectangle", + "circle", + "line", + "freetext", + "stamp", + "note", + "image", + // "imported" is draggable in the UI but the move does NOT persist to the + // PDF on save (addAnnotationDicts skips it). Resize/rotate stay disabled + // β€” the appearance bitmap would just stretch. + "imported", +]); + +function setupAnnotationInteraction( + el: HTMLElement, + tracked: TrackedAnnotation, +): void { + // Click to select (Shift+click for additive multi-select) + el.addEventListener("mousedown", (e) => { + // Ignore if clicking on a handle + if ( + (e.target as HTMLElement).classList.contains("annotation-handle") || + (e.target as HTMLElement).classList.contains("annotation-handle-rotate") + ) { + return; + } + e.stopPropagation(); + selectAnnotation(tracked.def.id, e.shiftKey); + + // Start drag for draggable types (only single-select) + if (DRAGGABLE_TYPES.has(tracked.def.type) && !e.shiftKey) { + startDrag(e, tracked); + } + }); + + // Double-click to send message to modify annotation (same as sidebar card) + el.addEventListener("dblclick", (e) => { + e.stopPropagation(); + selectAnnotation(tracked.def.id); + const label = getAnnotationLabel(tracked.def); + const previewText = getAnnotationPreview(tracked.def); + const desc = previewText ? `${label}: ${previewText}` : label; + void app + .sendMessage({ + role: "user", + content: [{ type: "text", text: `update ${desc}: ` }], + }) + .catch(log.error); + }); +} + +function startDrag(e: MouseEvent, tracked: TrackedAnnotation): void { + const def = tracked.def; + const startX = e.clientX; + const startY = e.clientY; + const beforeDef = { ...def } as PdfAnnotationDef; + let moved = false; + + // Store original element positions + const originalPositions = tracked.elements.map((el) => ({ + left: parseFloat(el.style.left), + top: parseFloat(el.style.top), + })); + + document.body.style.cursor = "grabbing"; + for (const el of tracked.elements) { + el.classList.add("annotation-dragging"); + } + + const onMouseMove = (ev: MouseEvent) => { + const dx = ev.clientX - startX; + const dy = ev.clientY - startY; + if (Math.abs(dx) > 2 || Math.abs(dy) > 2) moved = true; + // Move elements directly for smooth feedback + for (let i = 0; i < tracked.elements.length; i++) { + tracked.elements[i].style.left = `${originalPositions[i].left + dx}px`; + tracked.elements[i].style.top = `${originalPositions[i].top + dy}px`; + } + }; + + const onMouseUp = (ev: MouseEvent) => { + document.removeEventListener("mousemove", onMouseMove); + document.removeEventListener("mouseup", onMouseUp); + document.body.style.cursor = ""; + for (const el of tracked.elements) { + el.classList.remove("annotation-dragging"); + } + + if (!moved) return; + + const dx = ev.clientX - startX; + const dy = ev.clientY - startY; + const pdfDelta = screenToPdfDelta(dx, dy); + + // Apply move to def + applyMoveToDef( + tracked.def as PdfAnnotationDef & { x: number; y: number }, + pdfDelta.dx, + pdfDelta.dy, + ); + + const afterDef = { ...tracked.def } as PdfAnnotationDef; + pushEdit({ + type: "update", + id: def.id, + before: beforeDef, + after: afterDef, + }); + persistAnnotations(); + // Re-render to get correct positions + renderAnnotationsForPage(currentPage); + // Re-select to show handles + selectAnnotation(def.id); + }; + + document.addEventListener("mousemove", onMouseMove); + document.addEventListener("mouseup", onMouseUp); +} + +function applyMoveToDef( + def: PdfAnnotationDef & { x?: number; y?: number }, + dx: number, + dy: number, +): void { + if (def.type === "line") { + def.x1 += dx; + def.y1 += dy; + def.x2 += dx; + def.y2 += dy; + } else if ("x" in def && "y" in def) { + def.x! += dx; + def.y! += dy; + } +} + +// ============================================================================= +// Resize (rectangle, circle, image) +// ============================================================================= + +function setupResizeHandle( + handle: HTMLElement, + tracked: TrackedAnnotation, + corner: "nw" | "ne" | "sw" | "se", +): void { + handle.addEventListener("mousedown", (e) => { + e.stopPropagation(); + e.preventDefault(); + + const def = tracked.def as + | RectangleAnnotation + | CircleAnnotation + | ImageAnnotation; + const beforeDef = { ...def }; + const startX = e.clientX; + const startY = e.clientY; + const aspectRatio = beforeDef.height / beforeDef.width; + + const onMouseMove = (ev: MouseEvent) => { + const dxScreen = ev.clientX - startX; + const dyScreen = ev.clientY - startY; + const pdfD = screenToPdfDelta(dxScreen, dyScreen); + + // Reset to before state then apply delta + let newX = beforeDef.x; + let newY = beforeDef.y; + let newW = beforeDef.width; + let newH = beforeDef.height; + + // In PDF coords: x goes right, y goes up + if (corner.includes("w")) { + newX += pdfD.dx; + newW -= pdfD.dx; + } else { + newW += pdfD.dx; + } + if (corner.includes("s")) { + newY += pdfD.dy; + newH -= pdfD.dy; + } else { + newH += pdfD.dy; + } + + // Constrain aspect ratio: + // - For images: preserve by default (Shift to ignore), unless aspect="ignore" + // - For other shapes: Shift to preserve + const isImage = def.type === "image"; + const imageAspect = isImage + ? ((def as ImageAnnotation).aspect ?? "preserve") + : undefined; + const constrainAspect = isImage + ? imageAspect === "preserve" + ? !ev.shiftKey // preserve by default, Shift to free-resize + : ev.shiftKey // ignore by default, Shift to constrain + : ev.shiftKey; // non-image: Shift to constrain + + if (constrainAspect) { + // Use the wider dimension to drive the other + const candidateH = newW * aspectRatio; + newH = candidateH; + // Adjust origin for corners that anchor at bottom/left + if (corner.includes("s")) { + newY = beforeDef.y + beforeDef.height - newH; + } + if (corner.includes("w")) { + // width changed by resize, x was already adjusted above + } + } + + // Enforce minimum size + if (newW < 5) { + newW = 5; + } + if (newH < 5) { + newH = 5; + } + + def.x = newX; + def.y = newY; + def.width = newW; + def.height = newH; + + // Re-render for live feedback + renderAnnotationsForPage(currentPage); + selectAnnotation(def.id); + }; + + const onMouseUp = () => { + document.removeEventListener("mousemove", onMouseMove); + document.removeEventListener("mouseup", onMouseUp); + + const afterDef = { ...def }; + pushEdit({ + type: "update", + id: def.id, + before: beforeDef, + after: afterDef, + }); + persistAnnotations(); + }; + + document.addEventListener("mousemove", onMouseMove); + document.addEventListener("mouseup", onMouseUp); + }); +} + +// ============================================================================= +// Rotate (stamp, rectangle) +// ============================================================================= + +function setupRotateHandle( + handle: HTMLElement, + tracked: TrackedAnnotation, +): void { + handle.addEventListener("mousedown", (e) => { + e.stopPropagation(); + e.preventDefault(); + + const def = tracked.def as + | StampAnnotation + | RectangleAnnotation + | ImageAnnotation; + const beforeDef = { ...def }; + const el = tracked.elements[0]; + const rect = el.getBoundingClientRect(); + const centerX = rect.left + rect.width / 2; + const centerY = rect.top + rect.height / 2; + + const onMouseMove = (ev: MouseEvent) => { + const angle = Math.atan2(ev.clientY - centerY, ev.clientX - centerX); + // Convert to degrees, offset so 0 = pointing up + let degrees = (angle * 180) / Math.PI + 90; + // Normalize + if (degrees < 0) degrees += 360; + if (degrees > 360) degrees -= 360; + // Snap to 15-degree increments when close + const snapped = Math.round(degrees / 15) * 15; + if (Math.abs(degrees - snapped) < 3) degrees = snapped; + + def.rotation = Math.round(degrees); + renderAnnotationsForPage(currentPage); + selectAnnotation(def.id); + }; + + const onMouseUp = () => { + document.removeEventListener("mousemove", onMouseMove); + document.removeEventListener("mouseup", onMouseUp); + + const afterDef = { ...def }; + pushEdit({ + type: "update", + id: def.id, + before: beforeDef, + after: afterDef, + }); + persistAnnotations(); + }; + + document.addEventListener("mousemove", onMouseMove); + document.addEventListener("mouseup", onMouseUp); + }); +} + +/** + * Paint annotations for a page onto a 2D canvas context. + * Used to include annotations in screenshots sent to the model. + */ +function paintAnnotationsOnCanvas( + ctx: CanvasRenderingContext2D, + pageNum: number, + viewport: { width: number; height: number; scale: number }, +): void { + for (const tracked of annotationMap.values()) { + const def = tracked.def; + if (def.page !== pageNum) continue; + + const color = getAnnotationColor(def); + + switch (def.type) { + case "highlight": + ctx.save(); + ctx.globalAlpha = 0.35; + ctx.fillStyle = def.color || "rgba(255, 255, 0, 1)"; + for (const rect of def.rects) { + const s = pdfRectToScreen(rect, viewport); + ctx.fillRect(s.left, s.top, s.width, s.height); + } + ctx.restore(); + break; + + case "underline": + ctx.save(); + ctx.strokeStyle = color; + ctx.lineWidth = 2; + for (const rect of def.rects) { + const s = pdfRectToScreen(rect, viewport); + ctx.beginPath(); + ctx.moveTo(s.left, s.top + s.height); + ctx.lineTo(s.left + s.width, s.top + s.height); + ctx.stroke(); + } + ctx.restore(); + break; + + case "strikethrough": + ctx.save(); + ctx.strokeStyle = color; + ctx.lineWidth = 2; + for (const rect of def.rects) { + const s = pdfRectToScreen(rect, viewport); + const midY = s.top + s.height / 2; + ctx.beginPath(); + ctx.moveTo(s.left, midY); + ctx.lineTo(s.left + s.width, midY); + ctx.stroke(); + } + ctx.restore(); + break; + + case "note": { + const pos = pdfPointToScreen(def.x, def.y, viewport); + ctx.save(); + ctx.fillStyle = color; + ctx.globalAlpha = 0.8; + ctx.fillRect(pos.left, pos.top - 16, 16, 16); + ctx.restore(); + break; + } + + case "rectangle": { + const s = pdfRectToScreen( + { x: def.x, y: def.y, width: def.width, height: def.height }, + viewport, + ); + ctx.save(); + if (def.rotation) { + const cx = s.left + s.width / 2; + const cy = s.top + s.height / 2; + ctx.translate(cx, cy); + ctx.rotate((def.rotation * Math.PI) / 180); + ctx.translate(-cx, -cy); + } + if (def.fillColor) { + ctx.globalAlpha = 0.3; + ctx.fillStyle = def.fillColor; + ctx.fillRect(s.left, s.top, s.width, s.height); + } + ctx.globalAlpha = 1; + ctx.strokeStyle = color; + ctx.lineWidth = 2; + ctx.strokeRect(s.left, s.top, s.width, s.height); + ctx.restore(); + break; + } + + case "freetext": { + const pos = pdfPointToScreen(def.x, def.y, viewport); + ctx.save(); + ctx.fillStyle = color; + ctx.font = `${(def.fontSize || 12) * viewport.scale}px Helvetica, Arial, sans-serif`; + ctx.fillText(def.content, pos.left, pos.top); + ctx.restore(); + break; + } + + case "stamp": { + const pos = pdfPointToScreen(def.x, def.y, viewport); + ctx.save(); + ctx.translate(pos.left, pos.top); + if (def.rotation) ctx.rotate((def.rotation * Math.PI) / 180); + ctx.strokeStyle = color; + ctx.fillStyle = color; + ctx.lineWidth = 3; + ctx.globalAlpha = 0.6; + ctx.font = `bold ${24 * viewport.scale}px Helvetica, Arial, sans-serif`; + const metrics = ctx.measureText(def.label); + const pad = 8 * viewport.scale; + ctx.strokeRect( + -pad, + -24 * viewport.scale - pad, + metrics.width + pad * 2, + 24 * viewport.scale + pad * 2, + ); + ctx.fillText(def.label, 0, 0); + ctx.restore(); + break; + } + + case "circle": { + const s = pdfRectToScreen( + { x: def.x, y: def.y, width: def.width, height: def.height }, + viewport, + ); + ctx.save(); + if (def.fillColor) { + ctx.globalAlpha = 0.3; + ctx.fillStyle = def.fillColor; + ctx.beginPath(); + ctx.ellipse( + s.left + s.width / 2, + s.top + s.height / 2, + s.width / 2, + s.height / 2, + 0, + 0, + Math.PI * 2, + ); + ctx.fill(); + } + ctx.globalAlpha = 1; + ctx.strokeStyle = color; + ctx.lineWidth = 2; + ctx.beginPath(); + ctx.ellipse( + s.left + s.width / 2, + s.top + s.height / 2, + s.width / 2, + s.height / 2, + 0, + 0, + Math.PI * 2, + ); + ctx.stroke(); + ctx.restore(); + break; + } + + case "line": { + const p1 = pdfPointToScreen(def.x1, def.y1, viewport); + const p2 = pdfPointToScreen(def.x2, def.y2, viewport); + ctx.save(); + ctx.strokeStyle = color; + ctx.lineWidth = 2; + ctx.beginPath(); + ctx.moveTo(p1.left, p1.top); + ctx.lineTo(p2.left, p2.top); + ctx.stroke(); + ctx.restore(); + break; + } + + case "image": { + const s = pdfRectToScreen( + { x: def.x, y: def.y, width: def.width, height: def.height }, + viewport, + ); + // Try to draw from cache + const cachedImg = imageCache.get(def.id); + if (cachedImg) { + ctx.save(); + if (def.rotation) { + const cx = s.left + s.width / 2; + const cy = s.top + s.height / 2; + ctx.translate(cx, cy); + ctx.rotate((def.rotation * Math.PI) / 180); + ctx.translate(-cx, -cy); + } + ctx.drawImage(cachedImg, s.left, s.top, s.width, s.height); + ctx.restore(); + } else { + // Load image asynchronously into cache for next paint + const src = safeImageSrc(def); + if (src) { + const img = new Image(); + img.onload = () => { + imageCache.set(def.id, img); + }; + img.src = src; + } + // Draw placeholder border + ctx.save(); + ctx.strokeStyle = "#999"; + ctx.lineWidth = 1; + ctx.setLineDash([4, 4]); + ctx.strokeRect(s.left, s.top, s.width, s.height); + ctx.restore(); + } + break; + } + + case "imported": { + const s = pdfRectToScreen( + { x: def.x, y: def.y, width: def.width, height: def.height }, + viewport, + ); + const bmp = annotationCanvasMap.get(def.pdfjsId); + ctx.save(); + if (bmp) { + ctx.drawImage(bmp, s.left, s.top, s.width, s.height); + } else { + ctx.strokeStyle = "#666"; + ctx.lineWidth = 1; + ctx.setLineDash([3, 3]); + ctx.strokeRect(s.left, s.top, s.width, s.height); + } + ctx.restore(); + break; + } + } + } +} + +function renderAnnotationsForPage(pageNum: number): void { + // Clear existing annotation elements + annotationLayerEl.innerHTML = ""; + + // Remove tracked element refs for all annotations + for (const tracked of annotationMap.values()) { + tracked.elements = []; + } + + if (!pdfDocument) return; + + // Get viewport for coordinate conversion + const vp = { + width: parseFloat(annotationLayerEl.style.width) || 0, + height: parseFloat(annotationLayerEl.style.height) || 0, + scale, + }; + if (vp.width === 0 || vp.height === 0) return; + + for (const tracked of annotationMap.values()) { + const def = tracked.def; + if (def.page !== pageNum) continue; + + const elements = renderAnnotation(def, vp); + tracked.elements = elements; + for (const el of elements) { + // Set up selection + drag/resize/rotate interactions + setupAnnotationInteraction(el, tracked); + annotationLayerEl.appendChild(el); + } + // Restore selection state after re-render + if (selectedAnnotationIds.has(def.id)) { + for (const el of elements) { + el.classList.add("annotation-selected"); + } + if (selectedAnnotationIds.size === 1) { + showHandles(tracked); + } + } + } + + // Refresh panel to update current-page highlighting + renderAnnotationPanel(); +} + +function renderAnnotation( + def: PdfAnnotationDef, + viewport: { width: number; height: number; scale: number }, +): HTMLElement[] { + switch (def.type) { + case "highlight": { + // Force translucency: def.color is an opaque hex (e.g. "#ffff00"), which + // would override the rgba()/mix-blend-mode in CSS and hide the text. + const rgb = def.color ? cssColorToRgb(def.color) : null; + const bg = rgb + ? `rgba(${Math.round(rgb.r * 255)}, ${Math.round(rgb.g * 255)}, ${Math.round(rgb.b * 255)}, 0.35)` + : undefined; + return renderRectsAnnotation( + def.rects, + "annotation-highlight", + viewport, + bg ? { background: bg } : {}, + ); + } + case "underline": + return renderRectsAnnotation( + def.rects, + "annotation-underline", + viewport, + def.color ? { borderBottomColor: def.color } : {}, + ); + case "strikethrough": + return renderRectsAnnotation( + def.rects, + "annotation-strikethrough", + viewport, + {}, + def.color, + ); + case "note": + return [renderNoteAnnotation(def, viewport)]; + case "rectangle": + return [renderRectangleAnnotation(def, viewport)]; + case "freetext": + return [renderFreetextAnnotation(def, viewport)]; + case "stamp": + return [renderStampAnnotation(def, viewport)]; + case "circle": + return [renderCircleAnnotation(def, viewport)]; + case "line": + return [renderLineAnnotation(def, viewport)]; + case "image": + return [renderImageAnnotation(def, viewport)]; + case "imported": + return [renderImportedAnnotation(def, viewport)]; + } +} + +function renderRectsAnnotation( + rects: Rect[], + className: string, + viewport: { width: number; height: number; scale: number }, + extraStyles: Record, + strikeColor?: string, +): HTMLElement[] { + return rects.map((rect) => { + const screen = pdfRectToScreen(rect, viewport); + const el = document.createElement("div"); + el.className = className; + el.style.left = `${screen.left}px`; + el.style.top = `${screen.top}px`; + el.style.width = `${screen.width}px`; + el.style.height = `${screen.height}px`; + for (const [k, v] of Object.entries(extraStyles)) { + (el.style as unknown as Record)[k] = v; + } + if (strikeColor) { + // Set color for the ::after pseudo-element via CSS custom property + el.style.setProperty("--strike-color", strikeColor); + el.querySelector("::after"); // no-op, style via CSS instead + // Actually use inline style on a child element for the line + const line = document.createElement("div"); + line.style.position = "absolute"; + line.style.left = "0"; + line.style.right = "0"; + line.style.top = "50%"; + line.style.borderTop = `2px solid ${strikeColor}`; + el.appendChild(line); + } + return el; + }); +} + +function renderNoteAnnotation( + def: NoteAnnotation, + viewport: { width: number; height: number; scale: number }, +): HTMLElement { + const pos = pdfPointToScreen(def.x, def.y, viewport); + const el = document.createElement("div"); + el.className = "annotation-note"; + el.style.left = `${pos.left}px`; + el.style.top = `${pos.top - 20}px`; // offset up so note icon is at the point + if (def.color) el.style.color = def.color; + + const tooltip = document.createElement("div"); + tooltip.className = "annotation-tooltip"; + tooltip.textContent = def.content; + el.appendChild(tooltip); + + return el; +} + +function renderRectangleAnnotation( + def: RectangleAnnotation, + viewport: { width: number; height: number; scale: number }, +): HTMLElement { + const screen = pdfRectToScreen( + { x: def.x, y: def.y, width: def.width, height: def.height }, + viewport, + ); + const el = document.createElement("div"); + el.className = "annotation-rectangle"; + el.style.left = `${screen.left}px`; + el.style.top = `${screen.top}px`; + el.style.width = `${screen.width}px`; + el.style.height = `${screen.height}px`; + if (def.color) el.style.borderColor = def.color; + if (def.fillColor) el.style.backgroundColor = def.fillColor; + if (def.rotation) { + el.style.transform = `rotate(${def.rotation}deg)`; + el.style.transformOrigin = "center center"; + } + return el; +} + +function renderFreetextAnnotation( + def: FreetextAnnotation, + viewport: { width: number; height: number; scale: number }, +): HTMLElement { + const pos = pdfPointToScreen(def.x, def.y, viewport); + const el = document.createElement("div"); + el.className = "annotation-freetext"; + el.style.left = `${pos.left}px`; + el.style.top = `${pos.top}px`; + el.style.fontSize = `${(def.fontSize || 12) * viewport.scale}px`; + if (def.color) el.style.color = def.color; + el.textContent = def.content; + return el; +} + +function renderStampAnnotation( + def: StampAnnotation, + viewport: { width: number; height: number; scale: number }, +): HTMLElement { + const pos = pdfPointToScreen(def.x, def.y, viewport); + const el = document.createElement("div"); + el.className = "annotation-stamp"; + el.style.left = `${pos.left}px`; + el.style.top = `${pos.top}px`; + el.style.fontSize = `${24 * viewport.scale}px`; + if (def.color) el.style.color = def.color; + if (def.rotation) { + el.style.transform = `rotate(${def.rotation}deg)`; + el.style.transformOrigin = "center center"; + } + el.textContent = def.label; + return el; +} + +function renderCircleAnnotation( + def: CircleAnnotation, + viewport: { width: number; height: number; scale: number }, +): HTMLElement { + const screen = pdfRectToScreen( + { x: def.x, y: def.y, width: def.width, height: def.height }, + viewport, + ); + const el = document.createElement("div"); + el.className = "annotation-circle"; + el.style.left = `${screen.left}px`; + el.style.top = `${screen.top}px`; + el.style.width = `${screen.width}px`; + el.style.height = `${screen.height}px`; + if (def.color) el.style.borderColor = def.color; + if (def.fillColor) el.style.backgroundColor = def.fillColor; + return el; +} + +function renderLineAnnotation( + def: LineAnnotation, + viewport: { width: number; height: number; scale: number }, +): HTMLElement { + const p1 = pdfPointToScreen(def.x1, def.y1, viewport); + const p2 = pdfPointToScreen(def.x2, def.y2, viewport); + const dx = p2.left - p1.left; + const dy = p2.top - p1.top; + const length = Math.sqrt(dx * dx + dy * dy); + const angle = Math.atan2(dy, dx); + + const el = document.createElement("div"); + el.className = "annotation-line"; + el.style.left = `${p1.left}px`; + el.style.top = `${p1.top}px`; + el.style.width = `${length}px`; + el.style.transform = `rotate(${angle}rad)`; + el.style.transformOrigin = "0 0"; + if (def.color) el.style.borderColor = def.color; + return el; +} + +function renderImageAnnotation( + def: ImageAnnotation, + viewport: { width: number; height: number; scale: number }, +): HTMLElement { + const screen = pdfRectToScreen( + { x: def.x, y: def.y, width: def.width, height: def.height }, + viewport, + ); + const el = document.createElement("div"); + el.className = "annotation-image"; + el.style.left = `${screen.left}px`; + el.style.top = `${screen.top}px`; + el.style.width = `${screen.width}px`; + el.style.height = `${screen.height}px`; + if (def.rotation) { + el.style.transform = `rotate(${def.rotation}deg)`; + el.style.transformOrigin = "center center"; + } + + const imgSrc = safeImageSrc(def); + if (imgSrc) { + const img = document.createElement("img"); + img.src = imgSrc; + img.style.width = "100%"; + img.style.height = "100%"; + img.style.display = "block"; + img.style.pointerEvents = "none"; + img.draggable = false; + el.appendChild(img); + } + return el; +} + +/** + * Per-annotation appearance bitmaps from page.render(). Keyed by pdf.js + * annotation id (e.g. "118R"). Populated for the current page only β€” + * cleared at the start of each renderPage(). + */ +const annotationCanvasMap = new Map(); + +function renderImportedAnnotation( + def: ImportedAnnotation, + viewport: { width: number; height: number; scale: number }, +): HTMLElement { + const screen = pdfRectToScreen( + { x: def.x, y: def.y, width: def.width, height: def.height }, + viewport, + ); + const el = document.createElement("div"); + el.className = "annotation-imported"; + el.style.left = `${screen.left}px`; + el.style.top = `${screen.top}px`; + el.style.width = `${screen.width}px`; + el.style.height = `${screen.height}px`; + el.title = `${def.subtype} (from PDF)`; + + // page.render() may or may not have produced a separate canvas for this + // annotation (hasOwnCanvas depends on the PDF's flags). When it did, use + // it as a pixel-faithful body; when it didn't, the appearance is on the + // main canvas already, so leave the box transparent β€” it still captures + // clicks for select/delete. + const canvas = annotationCanvasMap.get(def.pdfjsId); + if (canvas) { + canvas.style.width = "100%"; + canvas.style.height = "100%"; + canvas.style.display = "block"; + canvas.style.pointerEvents = "none"; + el.appendChild(canvas); + } + return el; +} + +// ============================================================================= +// Annotation CRUD +// ============================================================================= + +function addAnnotation(def: PdfAnnotationDef, skipUndo = false): void { + // Remove existing if same id (without pushing to undo) + removeAnnotation(def.id, true); + annotationMap.set(def.id, { def, elements: [] }); + if (!skipUndo) { + pushEdit({ type: "add", id: def.id, before: null, after: { ...def } }); + } + // Re-render if on current page + if (def.page === currentPage) { + renderAnnotationsForPage(currentPage); + } + updateAnnotationsBadge(); + renderAnnotationPanel(); +} + +function updateAnnotation( + update: Partial & { id: string; type: string }, + skipUndo = false, +): void { + const tracked = annotationMap.get(update.id); + if (!tracked) return; + + const before = { ...tracked.def } as PdfAnnotationDef; + + // Merge partial update into existing def + const merged = { ...tracked.def, ...update } as PdfAnnotationDef; + tracked.def = merged; + + if (!skipUndo) { + pushEdit({ type: "update", id: update.id, before, after: { ...merged } }); + } + + // Re-render if on current page + if (merged.page === currentPage) { + renderAnnotationsForPage(currentPage); + } + renderAnnotationPanel(); +} + +function removeAnnotation(id: string, skipUndo = false): void { + const tracked = annotationMap.get(id); + if (!tracked) return; + if (!skipUndo) { + pushEdit({ type: "remove", id, before: { ...tracked.def }, after: null }); + } + for (const el of tracked.elements) el.remove(); + annotationMap.delete(id); + selectedAnnotationIds.delete(id); + updateAnnotationsBadge(); + renderAnnotationPanel(); +} +// ============================================================================= +// Annotation Panel β†’ extracted to ./annotation-panel.ts +// ============================================================================= + +// ============================================================================= +// highlight_text Command +// ============================================================================= + +function handleHighlightText(cmd: { + id: string; + query: string; + page?: number; + color?: string; + content?: string; +}): void { + const pagesToSearch: number[] = []; + if (cmd.page) { + pagesToSearch.push(cmd.page); + } else { + // Search all pages that have cached text + for (const [pageNum, text] of pageTextCache) { + if (text.toLowerCase().includes(cmd.query.toLowerCase())) { + pagesToSearch.push(pageNum); + } + } + } + + let annotationIndex = 0; + for (const pageNum of pagesToSearch) { + // Find text positions using the text layer DOM if on current page, + // otherwise create approximate rects from text cache positions + const rects = findTextRects(cmd.query, pageNum); + if (rects.length > 0) { + const id = + pagesToSearch.length > 1 + ? `${cmd.id}_p${pageNum}_${annotationIndex++}` + : cmd.id; + addAnnotation({ + type: "highlight", + id, + page: pageNum, + rects, + color: cmd.color, + content: cmd.content, + }); + } + } +} + +/** + * Find text in a page and return PDF-coordinate rects. + * Uses the TextLayer DOM when the page is currently rendered, + * otherwise falls back to approximate character-based positioning. + */ +function findTextRects(query: string, pageNum: number): Rect[] { + if (pageNum !== currentPage) { + // For non-current pages, create approximate rects from page dimensions + // The text will be properly positioned when the user navigates to that page + return findTextRectsFromCache(query, pageNum); + } + + // Use text layer DOM for current page + const spans = Array.from( + textLayerEl.querySelectorAll("span"), + ) as HTMLElement[]; + if (spans.length === 0) return findTextRectsFromCache(query, pageNum); + + const lowerQuery = query.toLowerCase(); + const rects: Rect[] = []; + const wrapperEl = textLayerEl.parentElement!; + const wrapperRect = wrapperEl.getBoundingClientRect(); + + for (const span of spans) { + const text = span.textContent || ""; + if (text.length === 0) continue; + const lowerText = text.toLowerCase(); + + let pos = 0; + while (true) { + const idx = lowerText.indexOf(lowerQuery, pos); + if (idx === -1) break; + pos = idx + 1; + + const textNode = span.firstChild; + if (!textNode || textNode.nodeType !== Node.TEXT_NODE) continue; + + try { + const range = document.createRange(); + range.setStart(textNode, idx); + range.setEnd(textNode, Math.min(idx + lowerQuery.length, text.length)); + const clientRects = range.getClientRects(); + + for (let ri = 0; ri < clientRects.length; ri++) { + const r = clientRects[ri]; + // Convert screen coords back to PDF coords + const screenLeft = r.left - wrapperRect.left; + const screenTop = r.top - wrapperRect.top; + const pdfX = screenLeft / scale; + const pdfHeight = r.height / scale; + const pdfWidth = r.width / scale; + const pageHeight = parseFloat(annotationLayerEl.style.height) / scale; + const pdfY = pageHeight - (screenTop + r.height) / scale; + rects.push({ + x: pdfX, + y: pdfY, + width: pdfWidth, + height: pdfHeight, + }); + } + } catch { + // Range API errors with stale nodes + } + } + } + + return rects; +} + +function findTextRectsFromCache(query: string, pageNum: number): Rect[] { + const text = pageTextCache.get(pageNum); + if (!text) return []; + const lowerText = text.toLowerCase(); + const lowerQuery = query.toLowerCase(); + const idx = lowerText.indexOf(lowerQuery); + if (idx === -1) return []; + + // Text exists in the cache but the text-layer DOM for this page isn't + // rendered yet β€” we can't compute accurate rects. Returning a placeholder + // would persist wrong coordinates; return empty and let the caller skip. + return []; +} + +// ============================================================================= +// get_pages β€” Offscreen rendering for model analysis +// ============================================================================= + +const MAX_GET_PAGES = 20; +const SCREENSHOT_MAX_DIM = 768; // Max pixel dimension for screenshots + +/** + * Expand intervals into a sorted deduplicated list of page numbers, + * clamped to [1, totalPages]. + */ +function expandIntervals( + intervals: Array<{ start?: number; end?: number }>, +): number[] { + const pages = new Set(); + for (const iv of intervals) { + const s = Math.max(1, iv.start ?? 1); + const e = Math.min(totalPages, iv.end ?? totalPages); + for (let p = s; p <= e; p++) pages.add(p); + } + return [...pages].sort((a, b) => a - b); +} + +/** + * Render a single page to an offscreen canvas and return base64 JPEG. + * Does not affect the visible canvas or text layer. + */ +async function renderPageOffscreen(pageNum: number): Promise { + if (!pdfDocument) throw new Error("No PDF loaded"); + const page = await pdfDocument.getPage(pageNum); + const baseViewport = page.getViewport({ scale: 1.0 }); + + // Scale down to fit within SCREENSHOT_MAX_DIM + const maxDim = Math.max(baseViewport.width, baseViewport.height); + const renderScale = + maxDim > SCREENSHOT_MAX_DIM ? SCREENSHOT_MAX_DIM / maxDim : 1.0; + const viewport = page.getViewport({ scale: renderScale }); + + const canvas = document.createElement("canvas"); + const dpr = 1; // No retina scaling for model screenshots + canvas.width = viewport.width * dpr; + canvas.height = viewport.height * dpr; + const ctx = canvas.getContext("2d")!; + ctx.scale(dpr, dpr); + + // Render with ENABLE_STORAGE so filled form fields appear on the canvas + // eslint-disable-next-line @typescript-eslint/no-explicit-any + await (page.render as any)({ + canvasContext: ctx, + viewport, + annotationMode: AnnotationMode.ENABLE_STORAGE, + annotationStorage: pdfDocument.annotationStorage, + }).promise; + + // Paint annotations on top so the model can see them + paintAnnotationsOnCanvas(ctx, pageNum, { + width: viewport.width, + height: viewport.height, + scale: renderScale, + }); + + // Extract base64 JPEG (much smaller than PNG, well within body limits) + const dataUrl = canvas.toDataURL("image/jpeg", 0.85); + return dataUrl.split(",")[1]; +} + +/** + * Snapshot the live viewer for `interact({action:"get_viewer_state"})`. + * + * Selection is read from `window.getSelection()` at call time β€” no caching; + * if the user navigated away or nothing is selected, `selection` is `null`. + * `boundingRect` is in model coords (PDF points, origin top-left, y-down) so + * it can be fed straight back into `add_annotations`. + */ +async function handleGetViewerState(requestId: string): Promise { + const CONTEXT_CHARS = 200; + + let selection: { + text: string; + contextBefore: string; + contextAfter: string; + boundingRect: { x: number; y: number; width: number; height: number }; + } | null = null; + + const sel = window.getSelection(); + const selectedText = sel?.toString().replace(/\s+/g, " ").trim(); + if (sel && selectedText && sel.rangeCount > 0) { + // Only treat it as a PDF selection if it lives inside the text layer of + // the rendered page (not the toolbar, search box, etc.). + const range = sel.getRangeAt(0); + const anchor = + range.commonAncestorContainer.nodeType === Node.ELEMENT_NODE + ? (range.commonAncestorContainer as Element) + : range.commonAncestorContainer.parentElement; + if (anchor && textLayerEl.contains(anchor)) { + // Context: locate selection in the page's extracted text and slice + // Β±CONTEXT_CHARS around it. Falls back to empty strings if fuzzy + // match fails (still return text + rect β€” they're the load-bearing + // bits). + const pageText = pageTextCache.get(currentPage) ?? ""; + const loc = findSelectionInText(pageText, selectedText); + const contextBefore = loc + ? pageText.slice(Math.max(0, loc.start - CONTEXT_CHARS), loc.start) + : ""; + const contextAfter = loc + ? pageText.slice(loc.end, loc.end + CONTEXT_CHARS) + : ""; + + // Single bounding box, page-relative model coords. getBoundingClientRect + // is viewport-relative; subtract the page-wrapper origin then divide by + // scale β†’ PDF points (top-left origin, y-down β€” matches the coord + // system documented in the interact tool description). + const r = range.getBoundingClientRect(); + const origin = pageWrapperEl.getBoundingClientRect(); + const round = (n: number) => Math.round(n * 100) / 100; + selection = { + text: selectedText, + contextBefore, + contextAfter, + boundingRect: { + x: round((r.left - origin.left) / scale), + y: round((r.top - origin.top) / scale), + width: round(r.width / scale), + height: round(r.height / scale), + }, + }; + } + } + + const state = { + currentPage, + pageCount: totalPages, + zoom: Math.round(scale * 100), + displayMode: currentDisplayMode, + selectedAnnotationIds: [...selectedAnnotationIds], + selection, + }; + + await app.callServerTool({ + name: "submit_viewer_state", + arguments: { requestId, state: JSON.stringify(state, null, 2) }, + }); +} + +/** + * Collect text and/or screenshots for a set of page intervals. + * Shared by the server-driven `get_pages` command (via handleGetPages) + * and the app-registered `get_text` / `get_screenshot` tools. + */ +async function collectPageData( + intervals: Array<{ start?: number; end?: number }>, + getText: boolean, + getScreenshots: boolean, +): Promise> { + const allPages = expandIntervals(intervals); + const pages = allPages.slice(0, MAX_GET_PAGES); + + log.info( + `collectPageData: ${pages.length} pages (${pages[0]}..${pages[pages.length - 1]}), text=${getText}, screenshots=${getScreenshots}`, + ); + + const results: Array<{ + page: number; + text?: string; + image?: string; + }> = []; + + for (const pageNum of pages) { + const entry: { page: number; text?: string; image?: string } = { + page: pageNum, + }; + + if (getText) { + // Use cached text if available, otherwise extract on the fly + let text = pageTextCache.get(pageNum); + if (text == null && pdfDocument) { + try { + const pg = await pdfDocument.getPage(pageNum); + const tc = await pg.getTextContent(); + text = (tc.items as Array<{ str?: string }>) + .map((item) => item.str || "") + .join(" "); + pageTextCache.set(pageNum, text); + } catch (err) { + log.error( + `collectPageData: text extraction failed for page ${pageNum}:`, + err, + ); + text = ""; + } + } + entry.text = text ?? ""; + } + + if (getScreenshots) { + try { + entry.image = await renderPageOffscreen(pageNum); + } catch (err) { + log.error( + `collectPageData: screenshot failed for page ${pageNum}:`, + err, + ); + } + } + + results.push(entry); + } + + return results; +} + +async function handleGetPages(cmd: { + requestId: string; + intervals: Array<{ start?: number; end?: number }>; + getText: boolean; + getScreenshots: boolean; +}): Promise { + const results = await collectPageData( + cmd.intervals, + cmd.getText, + cmd.getScreenshots, + ); + + // Submit results back to server + try { + await app.callServerTool({ + name: "submit_page_data", + arguments: { requestId: cmd.requestId, pages: results }, + }); + log.info( + `get_pages: submitted ${results.length} page(s) for ${cmd.requestId}`, + ); + } catch (err) { + log.error("get_pages: failed to submit results:", err); + } +} + +// ============================================================================= +// Annotation Persistence +// ============================================================================= + +/** Storage key for annotations β€” uses toolInfo.id (available early) with viewUUID fallback */ +function annotationStorageKey(): string | null { + const toolId = app.getHostContext()?.toolInfo?.id; + if (toolId) return `pdf-annot:${toolId}`; + if (viewUUID) return `${viewUUID}:annotations`; + return null; +} + +/** + * Import one page's native annotations into the baseline. Called lazily from + * renderPage() so we don't walk every page (and pull most of the file via + * range requests) before the user sees anything. Idempotent per page. + */ +function scanPageBaselineAnnotations( + pageNum: number, + annotations: unknown[], +): void { + if (baselineScannedPages.has(pageNum)) return; + baselineScannedPages.add(pageNum); + let imported = 0; + for (let i = 0; i < annotations.length; i++) { + // Isolate each annotation: a malformed one must not bubble up to the + // caller's form-layer try in renderPage() (which would skip + // AnnotationLayer.render and hide form widgets for the whole page). + try { + const ann = annotations[i] as { + annotationType?: number; + subtype?: string; + name?: string; + rect?: number[]; + }; + const def = importPdfjsAnnotation(ann, pageNum, i); + if (def) { + pdfBaselineAnnotations.push(def); + imported++; + if (!annotationMap.has(def.id) && !restoredRemovedIds.has(def.id)) { + annotationMap.set(def.id, { def, elements: [] }); + } + } else if (ann.annotationType !== 20) { + // Widget (type 20) is expected to be skipped; anything else we + // don't import will still be painted by page.render() onto the + // canvas as unselectable pixels. Log so we can diagnose + // "ghost annotations" (visible but not in panel, not clickable). + log.info( + `[WARN] Baseline: skipped PDF annotation on page ${pageNum}`, + `type=${ann.annotationType}`, + `subtype=${ann.subtype ?? "?"}`, + `name=${ann.name ?? "?"}`, + `rect=${ann.rect ? JSON.stringify(ann.rect) : "none"}`, + ); + } + } catch (err) { + log.info(`Baseline: page ${pageNum} annotation import failed`, err); + } + } + if (imported > 0) { + try { + updateAnnotationsBadge(); + renderAnnotationPanel(); + } catch (err) { + log.info(`Baseline: page ${pageNum} panel update failed`, err); + } + } +} + +function persistAnnotations(): void { + // Compute diff relative to PDF baseline + const currentAnnotations: PdfAnnotationDef[] = []; + for (const tracked of annotationMap.values()) { + currentAnnotations.push(tracked.def); + } + const diff = computeDiff( + pdfBaselineAnnotations, + currentAnnotations, + formFieldValues, + pdfBaselineFormValues, + ); + + // computeDiff only sees baseline ids from pages we've already scanned. + // Carry forward restored tombstones for unvisited pages so the first + // persist after restore doesn't drop them. Once every page is scanned the + // baseline is complete and computeDiff is authoritative on its own β€” + // dropping the carry-forward then also stops a stale id (no longer in the + // file) from pinning dirty=true forever. + if (baselineScannedPages.size < totalPages) { + for (const id of restoredRemovedIds) { + if (!annotationMap.has(id) && !diff.removed.includes(id)) { + diff.removed.push(id); + } + } + } + + // Dirty tracks whether there are unsaved changes. Undoing back to baseline + // yields an empty diff β†’ clean again β†’ save button disables. + if (!isRestoring) setDirty(!isDiffEmpty(diff)); + + const key = annotationStorageKey(); + if (!key) return; + try { + localStorage.setItem(key, serializeDiff(diff)); + } catch { + // localStorage may be full or unavailable + } +} + +function restoreAnnotations(): void { + const key = annotationStorageKey(); + if (!key) return; + isRestoring = true; + try { + const raw = localStorage.getItem(key); + if (!raw) return; + + // Try new diff-based format first + const diff = deserializeDiff(raw); + + // Merge baseline + diff. The loop below is add-only, so we MUST also + // delete: the per-page baseline scan re-seeds annotationMap with every + // native id it encounters β€” including ones in diff.removed. Without the + // deletes here AND the restoredRemovedIds tombstones below, the zombie + // survives, and the next persistAnnotations() sees it in currentIds β†’ + // computeDiff produces removed=[] β†’ the deletion is permanently lost. + const merged = mergeAnnotations(pdfBaselineAnnotations, diff); + for (const def of merged) { + if (!annotationMap.has(def.id)) { + annotationMap.set(def.id, { def, elements: [] }); + } + } + for (const id of diff.removed) { + annotationMap.delete(id); + // Tombstone so the lazy per-page baseline scan (which runs AFTER this + // restore) doesn't resurrect it. + restoredRemovedIds.add(id); + } + + // Restore form fields + for (const [k, v] of Object.entries(diff.formFields)) { + formFieldValues.set(k, v); + } + + // If we have user changes (diff is not empty), mark dirty + if ( + diff.added.length > 0 || + diff.removed.length > 0 || + Object.keys(diff.formFields).length > 0 + ) { + setDirty(true); + } + log.info( + `Restored ${annotationMap.size} annotations (${diff.added.length} added, ${diff.removed.length} removed), ${formFieldValues.size} form fields`, + ); + } catch { + // Parse error or unavailable + } finally { + isRestoring = false; + } +} + +// ============================================================================= +// PDF.js Form Field Name β†’ ID Mapping +// ============================================================================= + +/** + * Normalise a raw form field value into our string|boolean model. + * Returns null for empty/unfilled/button values so they don't clutter the + * panel or count as baseline. + * + * `type` is from getFieldObjects() (which knows field types); `raw` is + * preferably from page.getAnnotations().fieldValue (which is what the + * widget actually renders). A PDF can have the field-dict /V out of sync + * with the widget β€” AnnotationLayer trusts the widget, so we must too. + */ +function normaliseFieldValue( + type: string | undefined, + raw: unknown, +): string | boolean | null { + if (type === "button") return null; + // Checkbox/radio: fieldValue is the export string (e.g. "Yes"), "Off" = unset + if (type === "checkbox") { + return raw != null && raw !== "" && raw !== "Off" ? true : null; + } + if (type === "radiobutton") { + return raw != null && raw !== "" && raw !== "Off" ? String(raw) : null; + } + // Text/choice: fieldValue may be a string or an array of selections + if (Array.isArray(raw)) { + const joined = raw.filter(Boolean).join(", "); + return joined || null; + } + if (raw == null || raw === "") return null; + return String(raw); +} + +/** + * Build mapping from field names (used by fill_form) to widget annotation IDs + * (used by annotationStorage). + * + * CRITICAL: getFieldObjects() returns field-dictionary IDs (the /T tree), + * but annotationStorage is keyed by WIDGET annotation IDs (what + * page.getAnnotations() returns). The two differ for PDFs where fields and + * their widget /Kids are separate objects. Using the wrong key makes all + * storage writes silently miss. + */ +async function buildFieldNameMap( + doc: pdfjsLib.PDFDocumentProxy, +): Promise { + let pushedToStorage = false; + fieldNameToIds.clear(); + radioButtonValues.clear(); + fieldNameToPage.clear(); + fieldNameToLabel.clear(); + fieldNameToOrder.clear(); + cachedFieldObjects = null; + pdfBaselineFormValues.clear(); + + // getFieldObjects() gives us types, current values (/V), and defaults (/DV). + // We DON'T use its .id β€” that's the field dict ref, not the widget annot ref. + try { + cachedFieldObjects = + ((await doc.getFieldObjects()) as Record | null) ?? null; + } catch { + // getFieldObjects may fail on some PDFs + } + + // No AcroForm β†’ nothing to map. Skip the per-page widget walk so form-free + // PDFs (the common large case) don't pull every page after first paint. + // getFieldObjects() itself only reads the catalog/AcroForm dict via range + // transport, so this gate is cheap. + if (!cachedFieldObjects || Object.keys(cachedFieldObjects).length === 0) { + return false; + } + + // Scan every page's widget annotations to collect the CORRECT storage keys, + // plus labels, pages, positions, AND fieldValue (what the widget renders + // β€” which can differ from getFieldObjects().value if the PDF is internally + // inconsistent, e.g. after a pdf-lib setText silently failed). + const fieldPositions: Array<{ name: string; page: number; y: number }> = []; + const widgetFieldValues = new Map(); + for (let pageNum = 1; pageNum <= doc.numPages; pageNum++) { + let annotations; + try { + const page = await doc.getPage(pageNum); + annotations = await page.getAnnotations(); + } catch { + continue; + } + for (const ann of annotations) { + // eslint-disable-next-line @typescript-eslint/no-explicit-any + const a = ann as any; + if (!a.fieldName || !a.id) continue; + + // Widget annotation ID β€” this is what annotationStorage keys by + const ids = fieldNameToIds.get(a.fieldName) ?? []; + ids.push(a.id); + fieldNameToIds.set(a.fieldName, ids); + + // Radio buttons: pdf.js creates WITHOUT setting + // .value, so reading target.value gives the HTML default "on". + // Remember each widget's export value so the input listener can + // report it instead. + if (a.radioButton && a.buttonValue != null) { + radioButtonValues.set(a.id, String(a.buttonValue)); + } + + if (!fieldNameToPage.has(a.fieldName)) { + fieldNameToPage.set(a.fieldName, pageNum); + } + if (a.alternativeText) { + fieldNameToLabel.set(a.fieldName, a.alternativeText); + } + if (a.rect) { + fieldPositions.push({ name: a.fieldName, page: pageNum, y: a.rect[3] }); + } + // Capture the value the widget will actually render. First widget wins + // (radio groups share the field's /V so they all match anyway). + if (!widgetFieldValues.has(a.fieldName) && a.fieldValue !== undefined) { + widgetFieldValues.set(a.fieldName, a.fieldValue); + } + } + } + + // Ordering: page ascending, then Y descending (top-to-bottom on page) + fieldPositions.sort((a, b) => a.page - b.page || b.y - a.y); + const seen = new Set(); + let idx = 0; + for (const fp of fieldPositions) { + if (!seen.has(fp.name)) { + seen.add(fp.name); + fieldNameToOrder.set(fp.name, idx++); + } + } + + // Import baseline values AND remap cachedFieldObjects to widget IDs. + // + // Baseline: prefer the widget's fieldValue (what AnnotationLayer renders) + // over getFieldObjects().value. A PDF can have the field-dict /V out of + // sync with the widget β€” if we import the field-dict value, the panel + // disagrees with what's on screen. + // + // Remap: pdf.js _bindResetFormAction (the PDF's in-document Reset button) + // iterates this structure, using .id to key storage and find DOM elements + // via [data-element-id=...]. Both use WIDGET ids. pdf-lib's save splits + // merged field+widget objects, so we rebuild with widget ids. + if (cachedFieldObjects) { + const remapped: Record = {}; + for (const [name, fieldArr] of Object.entries(cachedFieldObjects)) { + const widgetIds = fieldNameToIds.get(name); + if (!widgetIds) continue; // no widget β†’ not rendered anyway + + // Type comes from getFieldObjects (widget annot data doesn't have it). + // Value: prefer the AcroForm field-tree value over the widget's + // fieldValue. pdf-lib's save() can leave a page widget pointing at a + // stale /V while the field tree has the new one (seen with comb text + // fields), and getAnnotations() reads the widget. If the two disagree + // we push the field-tree value into annotationStorage so the rendered + // input matches what's actually in /AcroForm. + const type = fieldArr.find((f) => f.type)?.type; + const fieldTreeRaw = fieldArr.find((f) => f.value != null)?.value; + const widgetRaw = widgetFieldValues.get(name); + const raw = fieldTreeRaw ?? widgetRaw; + const v = normaliseFieldValue(type, raw); + if (v !== null) { + pdfBaselineFormValues.set(name, v); + // Seed current state from baseline so the panel shows it. A + // restored localStorage diff (applied in restoreAnnotations) will + // overwrite specific fields the user changed. + if (!formFieldValues.has(name)) formFieldValues.set(name, v); + // Widget out of sync with field tree β†’ force storage so + // AnnotationLayer renders the field-tree value, not the stale + // widget. (syncFormValuesToStorage skips baseline==current.) + if (fieldTreeRaw != null && fieldTreeRaw !== widgetRaw) { + setFieldInStorage(name, v); + pushedToStorage = true; + } + } + + // Skip parent entries with no concrete id (radio groups: the /T tree + // has a parent with the export value, plus one child per widget). + const concrete = fieldArr.filter((f) => f.id && f.type); + remapped[name] = widgetIds.map((wid, i) => ({ + ...(concrete[i] ?? concrete[0] ?? fieldArr[0]), + id: wid, + })); + } + cachedFieldObjects = remapped; + } + + log.info(`Built field name map: ${fieldNameToIds.size} fields`); + return pushedToStorage; +} + +/** + * Set one form field's value in pdf.js's annotationStorage, in the format + * AnnotationLayer expects to READ when it re-renders. + * + * Radio buttons need per-widget booleans: pdf.js's RadioButtonWidgetAnnotation + * render() has inverted string coercion (`value !== buttonValue` β†’ true for + * every NON-matching widget), so a string value on all widgets checks the + * first rendered one and clears the rest regardless of what you asked for. + * Match pdf.js's own change handler instead: `{value: true}` on the widget + * whose buttonValue matches, `{value: false}` on the siblings. + * + * Also patches the live DOM element for the current page so the user sees the + * change without waiting for a full re-render. + */ +function setFieldInStorage(name: string, value: string | boolean): void { + if (!pdfDocument) return; + const ids = fieldNameToIds.get(name); + if (!ids) return; + const storage = pdfDocument.annotationStorage; + + // Radio group: at least one widget ID has a buttonValue recorded. + const isRadio = ids.some((id) => radioButtonValues.has(id)); + if (isRadio) { + const want = String(value); + for (const id of ids) { + const checked = radioButtonValues.get(id) === want; + storage.setValue(id, { value: checked }); + const el = formLayerEl.querySelector( + `input[data-element-id="${id}"]`, + ) as HTMLInputElement | null; + if (el) el.checked = checked; + } + return; + } + + // Text / checkbox / select: same value on every widget (a field can have + // multiple widget annotations sharing one /V). + const storageValue = typeof value === "boolean" ? value : String(value); + for (const id of ids) { + storage.setValue(id, { value: storageValue }); + const el = formLayerEl.querySelector(`[data-element-id="${id}"]`) as + | HTMLInputElement + | HTMLSelectElement + | HTMLTextAreaElement + | null; + if (!el) continue; + if (el instanceof HTMLInputElement && el.type === "checkbox") { + el.checked = !!value; + } else { + el.value = String(value); + } + } +} + +/** Sync formFieldValues into pdfDocument.annotationStorage so AnnotationLayer renders pre-filled values. + * Skips values that match the PDF's baseline β€” those are already in storage + * in pdf.js's native format (which may differ from our string/bool repr, + * e.g. checkbox stores "Yes" not `true`). Overwriting with our normalised + * form can break the Reset button's ability to restore defaults. */ +function syncFormValuesToStorage(): void { + if (!pdfDocument || fieldNameToIds.size === 0) return; + for (const [name, value] of formFieldValues) { + if (pdfBaselineFormValues.get(name) === value) continue; + setFieldInStorage(name, value); + } +} + +// ============================================================================= +// PDF Save / Download with Annotations +// ============================================================================= + +/** Build annotated PDF bytes from the current state. */ +async function getAnnotatedPdfBytes(): Promise { + if (!pdfDocument) throw new Error("No PDF loaded"); + const fullBytes = await pdfDocument.getData(); + + // Only export user-added annotations; baseline ones are already in the PDF + const annotations: PdfAnnotationDef[] = []; + const baselineIds = new Set(pdfBaselineAnnotations.map((a) => a.id)); + for (const tracked of annotationMap.values()) { + if (!baselineIds.has(tracked.def.id)) { + annotations.push(tracked.def); + } + } + + // Baseline annotations the user deleted: strip their refs from /Annots so + // they don't reappear on reload. Include restored tombstones for pages we + // haven't scanned yet β€” those ids aren't in pdfBaselineAnnotations but the + // ref is still parseable from the id string. Ids without a recoverable ref + // (page-index fallback) can't be removed by-ref and are skipped. + const removedIds = new Set(); + for (const a of pdfBaselineAnnotations) { + if (!annotationMap.has(a.id)) removedIds.add(a.id); + } + for (const id of restoredRemovedIds) { + if (!annotationMap.has(id)) removedIds.add(id); + } + const removedRefs = [...removedIds] + .map(parseAnnotationRef) + .filter((r): r is NonNullable => r !== null); + + // Only write fields that actually changed vs. what's already in the PDF. + // Unchanged fields are no-ops at best, and at worst trip pdf-lib edge + // cases (max-length text, missing /Yes appearance, …) on fields the user + // never touched β€” which, before the per-field catch in + // buildAnnotatedPdfBytes, aborted every subsequent field. + // + // Fields the user cleared (present in baseline, absent from formFieldValues + // after clearAllItems()) still need an explicit "" / false so pdf-lib + // overwrites the original /V instead of leaving it intact. + const formFieldsOut = new Map(); + for (const [name, value] of formFieldValues) { + if (pdfBaselineFormValues.get(name) !== value) { + formFieldsOut.set(name, value); + } + } + for (const [name, baselineValue] of pdfBaselineFormValues) { + if (!formFieldValues.has(name)) { + formFieldsOut.set(name, typeof baselineValue === "boolean" ? false : ""); + } + } + return buildAnnotatedPdfBytes( + fullBytes as Uint8Array, + annotations, + formFieldsOut, + removedRefs, + ); +} + +async function savePdf(): Promise { + if (!pdfDocument || !isDirty || saveInProgress) return; + + const fileName = + pdfUrl + .replace(/^(file|computer):\/\//, "") + .split(/[/\\]/) + .pop() || pdfUrl; + const choice = await showConfirmDialog( + "Save PDF", + "Overwrite this file with your annotations and form edits?", + [{ label: "Cancel" }, { label: "Save", primary: true }], + fileName, + ); + if (choice !== 1) return; + + saveInProgress = true; + saveBtn.disabled = true; + saveBtn.title = "Saving..."; + + try { + const pdfBytes = await getAnnotatedPdfBytes(); + const base64 = uint8ArrayToBase64(pdfBytes); + + const result = await app.callServerTool({ + name: "save_pdf", + arguments: { url: pdfUrl, data: base64 }, + }); + + if (result.isError) { + log.error("Save failed:", result.content); + saveBtn.disabled = false; // let user retry + } else { + log.info("PDF saved"); + // Record mtime so we recognize our own write in file_changed + const sc = result.structuredContent as { mtimeMs?: number } | undefined; + lastSavedMtime = sc?.mtimeMs ?? null; + + const key = annotationStorageKey(); + if (key) { + try { + localStorage.removeItem(key); + } catch { + /* ignore */ + } + } + // Reload from the bytes we just wrote. The previous approach (rebase + // baselines but keep the old pdfDocument) drifts: subsequent renders + // still rasterize stripped annotations from the old bytes, and the + // field/widget split that pdf-lib's save can create isn't reflected + // until reload anyway. Reload makes "what you see = what's on disk" + // an invariant. (file_changed echo is suppressed by lastSavedMtime.) + await reloadPdf(); + } + } catch (err) { + log.error("Save failed:", err); + saveBtn.disabled = false; + } finally { + saveInProgress = false; + saveBtn.title = "Save to file (overwrites original)"; + } +} + +async function downloadAnnotatedPdf(): Promise { + if (!pdfDocument) return; + downloadBtn.disabled = true; + downloadBtn.title = "Preparing download..."; + + try { + const pdfBytes = await getAnnotatedPdfBytes(); + + const hasEdits = annotationMap.size > 0 || formFieldValues.size > 0; + const baseName = (pdfTitle || "document").replace(/\.pdf$/i, ""); + const fileName = hasEdits ? `${baseName} - edited.pdf` : `${baseName}.pdf`; + + const base64 = uint8ArrayToBase64(pdfBytes); + + if (app.getHostCapabilities()?.downloadFile) { + const { isError } = await app.downloadFile({ + contents: [ + { + type: "resource", + resource: { + uri: `file:///${fileName}`, + mimeType: "application/pdf", + blob: base64, + }, + }, + ], + }); + if (isError) { + log.info("Download was cancelled or denied by host"); + } + } else { + // Fallback: create blob URL and trigger download + const blob = new Blob([pdfBytes.buffer as ArrayBuffer], { + type: "application/pdf", + }); + const url = URL.createObjectURL(blob); + const a = document.createElement("a"); + a.href = url; + a.download = fileName; + document.body.appendChild(a); + a.click(); + document.body.removeChild(a); + URL.revokeObjectURL(url); + } + } catch (err) { + log.error("Download error:", err); + } finally { + downloadBtn.disabled = false; + downloadBtn.title = "Download PDF"; + } +} + // Render state - prevents concurrent renders let isRendering = false; let pendingPage: number | null = null; @@ -640,9 +3309,19 @@ async function renderPage() { // Set display size in CSS pixels canvasEl.style.width = `${viewport.width}px`; canvasEl.style.height = `${viewport.height}px`; + // Drop any pinch preview transform in the same frame as the canvas + // resize so the size handoff is atomic. + pageWrapperEl.style.transform = ""; - // Scale context for retina - ctx.scale(dpr, dpr); + // Retina: pass dpr via page.render's `transform` (NOT ctx.scale). + // pdf.js sizes per-annotation canvases as + // width = rectW * outputScaleX * viewport.scale + // and outputScaleX is read from transform[0] (defaults to 1). A bare + // ctx.scale(dpr,dpr) leaves outputScaleX at 1, so the + // annotationCanvasMap canvases get a half-sized backing store on + // retina while their internal setTransform IS dpr-aware β†’ the + // appearance renders 2Γ— too big into a 1Γ— buffer β†’ cropped/shifted. + const dprTransform = dpr !== 1 ? [dpr, 0, 0, dpr, 0, 0] : undefined; // Clear and setup text layer textLayerEl.innerHTML = ""; @@ -651,11 +3330,29 @@ async function renderPage() { // Set --scale-factor so CSS font-size/transform rules work correctly. textLayerEl.style.setProperty("--scale-factor", `${scale}`); - // Render canvas - track the task so we can cancel it + // Render canvas - track the task so we can cancel it. + // + // annotationCanvasMap: pdf.js diverts annotations whose appearance needs + // its own bitmap (Stamp/Ink/FreeText/etc. with hasOwnCanvas) into + // per-id canvases instead of compositing onto the main canvas. + // renderImportedAnnotation() pulls from this map so those annotations + // become movable DOM elements with pixel-faithful visuals β€” instead of + // unselectable canvas pixels (the old "ghost annotation" problem) or + // our lossy text-label re-render. + annotationCanvasMap.clear(); // eslint-disable-next-line @typescript-eslint/no-explicit-any const renderTask = (page.render as any)({ canvasContext: ctx, viewport, + transform: dprTransform, + annotationCanvasMap, + // isEditing forces hasOwnCanvas=true for stamps regardless of /F + // NoRotate (StampAnnotation.mustBeViewedWhenEditing in pdf.worker). + // Without this, stamps without NoRotate composite onto the main canvas + // and deleting the "imported" overlay leaves an unclickable pixel + // behind. Other markup types still gate on noRotate; for those the + // overlay stays a transparent click-box (delete is UI-only until save). + isEditing: true, }); currentRenderTask = renderTask; @@ -698,15 +3395,132 @@ async function renderPage() { pageTextCache.set(pageToRender, items.join("")); } - // Size highlight layer to match canvas + // Size overlay layers to match canvas highlightLayerEl.style.width = `${viewport.width}px`; highlightLayerEl.style.height = `${viewport.height}px`; + annotationLayerEl.style.width = `${viewport.width}px`; + annotationLayerEl.style.height = `${viewport.height}px`; + + // Render PDF.js AnnotationLayer for interactive form widgets + formLayerEl.innerHTML = ""; + formLayerEl.style.width = `${viewport.width}px`; + formLayerEl.style.height = `${viewport.height}px`; + // Set CSS custom properties so AnnotationLayer font-size rules work correctly + formLayerEl.style.setProperty("--scale-factor", `${scale}`); + formLayerEl.style.setProperty("--total-scale-factor", `${scale}`); + try { + const annotations = await page.getAnnotations(); + // Lazy baseline import β€” piggyback on the annotations we just fetched + // for this page instead of walking all pages upfront. + scanPageBaselineAnnotations(pageToRender, annotations); + if (annotations.length > 0) { + const linkService = { + getDestinationHash: () => "#", + getAnchorUrl: () => "#", + addLinkAttributes: () => {}, + isPageVisible: () => true, + isPageCached: () => true, + externalLinkEnabled: true, + }; + // eslint-disable-next-line @typescript-eslint/no-explicit-any + const annotationLayer = new AnnotationLayer({ + div: formLayerEl, + page, + viewport, + annotationStorage: pdfDocument.annotationStorage, + linkService, + accessibilityManager: null, + annotationCanvasMap: null, + annotationEditorUIManager: null, + structTreeLayer: null, + commentManager: null, + } as any); + // eslint-disable-next-line @typescript-eslint/no-explicit-any + // Only feed Widgets (form fields) here. Markup annotations are + // owned by #annotation-layer; letting AnnotationLayer create + //
elements for them in #form-layer adds invisible + // pointer-events:auto boxes that steal clicks from our overlays. + const widgetAnns = annotations.filter( + (a: { subtype?: string }) => a.subtype === "Widget", + ); + await annotationLayer.render({ + annotations: widgetAnns, + div: formLayerEl, + page, + viewport, + renderForms: true, + linkService, + annotationStorage: pdfDocument.annotationStorage, + fieldObjects: cachedFieldObjects, + } as any); + + // Fix combo reset: pdf.js's resetform handler sets all + // option.selected = (option.value === defaultFieldValue), and + // defaultFieldValue is typically null β€” nothing matches. On a + // non-multiple is only the first option; join them all + // so save can select() the full set on a PDFOptionList. + value = Array.from(target.selectedOptions, (o) => o.value).join(","); + } else { + value = target.value; + } + formFieldValues.set(fieldName, value); + updateAnnotationsBadge(); + renderAnnotationPanel(); + persistAnnotations(); +}); + +// Track form field focus: deselect annotations + sync model context +formLayerEl.addEventListener( + "focusin", + (e) => { + const target = e.target as HTMLInputElement | HTMLSelectElement; + const fieldName = target.name; + if (!fieldName) return; + // Focusing a form field deselects any selected annotations + if (selectedAnnotationIds.size > 0) { + selectAnnotation(null); + } + focusedFieldName = fieldName; + updatePageContext(); + }, + true, +); + +// Handle form reset: PDF.js dispatches "resetform" on each field element +formLayerEl.addEventListener( + "resetform", + (e) => { + const target = e.target as HTMLInputElement | HTMLSelectElement; + const fieldName = target?.name; + if (fieldName && formFieldValues.has(fieldName)) { + formFieldValues.delete(fieldName); + } + // Debounce the UI update since resetform fires per-element + if (!resetFormDebounceTimer) { + resetFormDebounceTimer = setTimeout(() => { + resetFormDebounceTimer = null; + updateAnnotationsBadge(); + renderAnnotationPanel(); + persistAnnotations(); + }, 50); + } + }, + true, +); +let resetFormDebounceTimer: ReturnType | null = null; + +// Clear focused field on blur +formLayerEl.addEventListener( + "focusout", + () => { + if (focusedFieldName) { + focusedFieldName = null; + updatePageContext(); + } + }, + true, +); + +initAnnotationPanel({ + state: () => ({ + currentPage, + isDirty, + pdfDocument, + pdfBaselineAnnotations, + cachedFieldObjects, + searchOpen, + }), + renderPage, + goToPage, + selectAnnotation, + persistAnnotations, + removeAnnotation, + requestFitToContent, + updatePageContext, + setFocusedField: (name) => { + focusedFieldName = name; + }, + sendMessage: (msg) => app.sendMessage(msg), + getHostContext: () => app.getHostContext(), +}); // Search input events searchInputEl.addEventListener("input", () => { @@ -871,8 +3824,134 @@ pageInputEl.addEventListener("keydown", (e) => { } }); +// Mousedown on text layer directly deselects annotations (catches cases where +// annotation mousedown stopPropagation prevents bubbling to canvasContainerEl) +textLayerEl.addEventListener("mousedown", () => { + if (selectedAnnotationIds.size > 0) selectAnnotation(null); + if (focusedFieldName) { + focusedFieldName = null; + updatePageContext(); + } +}); + +// Click on empty area / text layer to deselect annotations and blur fields +canvasContainerEl.addEventListener("mousedown", (e) => { + const target = e.target as HTMLElement; + // Deselect if clicking on container, canvas, page wrapper, or text layer content + if ( + target === canvasContainerEl || + target === canvasEl || + target.classList?.contains("page-wrapper") || + target.closest(".text-layer") + ) { + if (selectedAnnotationIds.size > 0) { + selectAnnotation(null); + } + if (focusedFieldName) { + focusedFieldName = null; + updatePageContext(); + } + } +}); + // Keyboard navigation document.addEventListener("keydown", (e) => { + // Delete/Backspace to delete selected annotations + if ( + (e.key === "Delete" || e.key === "Backspace") && + selectedAnnotationIds.size > 0 + ) { + // Don't delete if user is typing in an input + if ( + document.activeElement instanceof HTMLInputElement || + document.activeElement instanceof HTMLTextAreaElement || + document.activeElement instanceof HTMLSelectElement + ) { + return; + } + e.preventDefault(); + const ids = [...selectedAnnotationIds]; + selectAnnotation(null); + for (const id of ids) { + removeAnnotation(id); + } + persistAnnotations(); + return; + } + + // Ctrl/Cmd+Z: undo, Ctrl/Cmd+Shift+Z: redo + if ((e.ctrlKey || e.metaKey) && e.key === "z") { + // Don't intercept when typing in inputs + if ( + document.activeElement instanceof HTMLInputElement || + document.activeElement instanceof HTMLTextAreaElement + ) { + return; + } + e.preventDefault(); + if (e.shiftKey) { + redo(); + } else { + undo(); + } + return; + } + + // Ctrl/Cmd+C: copy selected annotations + if ((e.ctrlKey || e.metaKey) && e.key === "c" && !e.shiftKey) { + if ( + document.activeElement instanceof HTMLInputElement || + document.activeElement instanceof HTMLTextAreaElement + ) { + return; + } + if (selectedAnnotationIds.size > 0) { + e.preventDefault(); + copySelectedAnnotations(); + } + return; + } + + // Ctrl/Cmd+X: cut selected annotations (copy + delete) + if ((e.ctrlKey || e.metaKey) && e.key === "x" && !e.shiftKey) { + if ( + document.activeElement instanceof HTMLInputElement || + document.activeElement instanceof HTMLTextAreaElement + ) { + return; + } + if (selectedAnnotationIds.size > 0) { + e.preventDefault(); + copySelectedAnnotations().then((copied) => { + if (copied) { + const ids = [...selectedAnnotationIds]; + selectAnnotation(null); + for (const id of ids) { + removeAnnotation(id); + } + persistAnnotations(); + } + }); + } + return; + } + + // Ctrl/Cmd+S: save (for local files) + if ((e.ctrlKey || e.metaKey) && e.key === "s") { + e.preventDefault(); + if (fileWritable && isDirty) { + savePdf(); + } + return; + } + + // Ctrl/Cmd+Enter: toggle fullscreen + if ((e.ctrlKey || e.metaKey) && e.key === "Enter") { + e.preventDefault(); + toggleFullscreen(); + return; + } + // Ctrl/Cmd+F: open our search if closed; if already focused, pass through to browser find if ((e.ctrlKey || e.metaKey) && e.key === "f") { if (!searchOpen) { @@ -890,9 +3969,15 @@ document.addEventListener("keydown", (e) => { return; } - // Don't handle nav shortcuts when search input is focused + // Don't handle nav shortcuts when an input element is focused if (document.activeElement === searchInputEl) return; if (document.activeElement === pageInputEl) return; + if ( + document.activeElement instanceof HTMLInputElement || + document.activeElement instanceof HTMLTextAreaElement || + document.activeElement instanceof HTMLSelectElement + ) + return; // Ctrl/Cmd+0 to reset zoom if ((e.ctrlKey || e.metaKey) && e.key === "0") { @@ -903,7 +3988,10 @@ document.addEventListener("keydown", (e) => { switch (e.key) { case "Escape": - if (searchOpen) { + if (selectedAnnotationIds.size > 0) { + selectAnnotation(null); + e.preventDefault(); + } else if (searchOpen) { closeSearch(); e.preventDefault(); } else if (currentDisplayMode === "fullscreen") { @@ -941,6 +4029,13 @@ document.addEventListener("selectionchange", () => { selectionUpdateTimeout = setTimeout(() => { const sel = window.getSelection(); const text = sel?.toString().trim(); + if (text) { + // Any text selection deselects annotations and blurs fields + if (selectedAnnotationIds.size > 0) selectAnnotation(null); + if (focusedFieldName) { + focusedFieldName = null; + } + } if (text && text.length > 2) { log.info("Selection changed:", text.slice(0, 50)); updatePageContext(); @@ -948,6 +4043,104 @@ document.addEventListener("selectionchange", () => { }, 300); }); +// --- Pinch zoom (fullscreen only) --- +// +// Covers two input paths: +// 1. wheel + ctrlKey β†’ trackpad pinch on macOS Safari/Chrome/FF and +// Windows precision touchpads. The browser synthesizes +// these on pinch; deltaY < 0 is zoom-in. +// 2. two-finger touch β†’ mobile Safari / Chrome Android. We track the +// distance between the two touches and scale by the +// ratio against the initial distance. +// +// Both paths apply a CSS transform to .page-wrapper for live feedback (GPU, +// no canvas re-render per frame), then commit to a real renderPage() once +// the gesture settles. renderPage() is heavy (PDF.js page.render β†’ canvas, +// TextLayer, AnnotationLayer all rebuilt) β€” way too slow for touchmove. + +/** Scale at gesture start. The CSS transform is relative to the rendered + * canvas, so previewScale / pinchStartScale is what we paint. */ +let pinchStartScale = 1.0; +/** What we'd commit to if the gesture ended right now. */ +let previewScale = 1.0; +/** Debounce timer β€” wheel events have no end event, so we wait for quiet. */ +let pinchSettleTimer: ReturnType | null = null; +/** computeFitScale() snapshot at gesture start (async β€” may be null briefly). */ +let fitScaleAtPinchStart: number | null = null; +/** Guards against firing toggleFullscreen() once per wheel event during a + * single inline pinch-in gesture. */ +let modeTransitionInFlight = false; + +function beginPinch() { + pinchStartScale = scale; + previewScale = scale; + // Seed synchronously when we can (at fit ⇔ !userHasZoomed) so the very + // first updatePinch already has the right floor β€” avoids a one-frame + // jitter when the async computeFitScale resolves mid-gesture. + fitScaleAtPinchStart = userHasZoomed ? null : scale; + void computeFitScale().then((s) => (fitScaleAtPinchStart = s)); + // transform-origin matches the flex layout's anchor (justify-content: + // center, align-items: flex-start) so the preview and the committed + // canvas grow from the same point β€” otherwise the page jumps on release. + pageWrapperEl.style.transformOrigin = "50% 0"; +} + +/** Fit-to-page floor for fullscreen (committed scale never goes below this). + * The preview is allowed to overshoot down to 0.75Γ—fit for rubber-band + * feedback; release below 0.9Γ—fit exits to inline, otherwise snaps to fit. */ +function pinchFitFloor(): number | null { + return currentDisplayMode === "fullscreen" ? fitScaleAtPinchStart : null; +} + +function updatePinch(nextScale: number) { + const fit = pinchFitFloor(); + // Rubber-band: preview may dip to 0.75Γ—fit so the user sees the page pull + // away as they pinch out. Committed scale is clamped to fit in commitPinch. + const previewFloor = fit !== null ? fit * 0.75 : ZOOM_MIN; + previewScale = Math.min(ZOOM_MAX, Math.max(previewFloor, nextScale)); + // Transform is RELATIVE to the rendered canvas (which sits at + // pinchStartScale), so a previewScale equal to pinchStartScale β†’ ratio 1. + pageWrapperEl.style.transform = `scale(${previewScale / pinchStartScale})`; + zoomLevelEl.textContent = `${Math.round(previewScale * 100)}%`; +} + +function commitPinch() { + const fit = pinchFitFloor(); + // Pinched out past fit (page visibly pulled away) β†’ exit fullscreen. + // Only when the gesture *started* near fit, so a single big pinch-out + // from deep zoom lands at fit instead of ejecting unexpectedly. + if ( + fit !== null && + pinchStartScale <= fit * 1.05 && + previewScale < fit * 0.9 + ) { + pageWrapperEl.style.transform = ""; + userHasZoomed = false; // let refitScale() size the inline view + forceNextResizeRefit = true; // ResizeObserver inline path ignores shrinks + modeTransitionInFlight = true; + void toggleFullscreen().finally(() => { + setTimeout(() => (modeTransitionInFlight = false), 250); + }); + return; + } + // Committed scale never below fit in fullscreen β€” overshoot snaps back. + const target = + fit !== null + ? Math.max(fit, previewScale) + : Math.max(ZOOM_MIN, previewScale); + if (Math.abs(target - scale) < 0.01) { + // Snap-back / dead-zone β€” no re-render needed. + pageWrapperEl.style.transform = ""; + zoomLevelEl.textContent = `${Math.round(scale * 100)}%`; + return; + } + userHasZoomed = true; + scale = target; + // renderPage clears the transform in the same frame as the canvas + // resize (after its first await) so there's no snap-back. + renderPage().then(scrollSelectionIntoView); +} + // Horizontal scroll/swipe to change pages (disabled when zoomed) let horizontalScrollAccumulator = 0; const SCROLL_THRESHOLD = 50; @@ -957,13 +4150,55 @@ canvasContainerEl.addEventListener( (event) => { const e = event as WheelEvent; + // Trackpad pinch arrives as wheel with ctrlKey set (Chrome/FF/Edge on + // macOS+Windows, Safari on macOS). MUST check before the deltaX/deltaY + // comparison below β€” pinch deltas come through on deltaY. + if (e.ctrlKey) { + e.preventDefault(); + if (currentDisplayMode !== "fullscreen") { + // Inline: pinch-in (deltaY<0) is a request to go fullscreen. + // Pinch-out is ignored β€” nothing smaller than inline. + if (e.deltaY < 0 && !modeTransitionInFlight) { + modeTransitionInFlight = true; + void toggleFullscreen().finally(() => { + // Hold the latch through the settle window so the tail of the + // gesture doesn't immediately start zooming the new fullscreen + // view (or, worse, re-toggle). + setTimeout(() => (modeTransitionInFlight = false), 250); + }); + } + return; + } + if (modeTransitionInFlight) return; // swallow gesture tail post-toggle + if (pinchSettleTimer === null) beginPinch(); + // exp(-deltaY * k) makes equal-magnitude in/out deltas inverse β€” + // pinch out then back lands where you started. Clamp per event so a + // physical mouse wheel (deltaY β‰ˆ Β±100/notch) doesn't slam to the + // limit; trackpad pinch deltas are ~Β±1-10 so the clamp is a no-op. + const d = Math.max(-25, Math.min(25, e.deltaY)); + updatePinch(previewScale * Math.exp(-d * 0.01)); + if (pinchSettleTimer) clearTimeout(pinchSettleTimer); + // 200ms β€” slow trackpad pinches can leave >150ms gaps between wheel + // events, which would commit-then-restart and feel steppy. + pinchSettleTimer = setTimeout(() => { + pinchSettleTimer = null; + commitPinch(); + }, 200); + return; + } + // Only intercept horizontal scroll, let vertical scroll through if (Math.abs(e.deltaX) <= Math.abs(e.deltaY)) return; - // When zoomed, let natural panning happen (no page changes) - if (scale > 1.0) return; + // If the page overflows horizontally, let native panning handle it + // (no page changes). Checking actual overflow rather than `scale > 1.0` + // because fullscreen fit-scale is often >100% with the page still fully + // visible β€” we want swipe-to-page there. +1 absorbs sub-pixel rounding. + if (canvasContainerEl.scrollWidth > canvasContainerEl.clientWidth + 1) { + return; + } - // At 100% zoom, handle page navigation + // No horizontal overflow β†’ swipe changes pages. e.preventDefault(); horizontalScrollAccumulator += e.deltaX; if (horizontalScrollAccumulator > SCROLL_THRESHOLD) { @@ -977,6 +4212,77 @@ canvasContainerEl.addEventListener( { passive: false }, ); +// Two-finger touch pinch. We listen on the container (not page-wrapper) +// because the wrapper transforms during the gesture and would shift the +// touch target out from under the fingers. +let touchStartDist = 0; + +function touchDist(t: TouchList): number { + const dx = t[0].clientX - t[1].clientX; + const dy = t[0].clientY - t[1].clientY; + return Math.hypot(dx, dy); +} + +canvasContainerEl.addEventListener( + "touchstart", + (event) => { + const e = event as TouchEvent; + if (e.touches.length !== 2) return; + // No preventDefault here β€” keep iOS Safari happy. We block native + // pinch-zoom via touch-action CSS + preventDefault on touchmove. + touchStartDist = touchDist(e.touches); + if (touchStartDist > 0) beginPinch(); + }, + { passive: true }, +); + +canvasContainerEl.addEventListener( + "touchmove", + (event) => { + const e = event as TouchEvent; + if (e.touches.length !== 2 || touchStartDist === 0) return; + e.preventDefault(); // stop the browser zooming the whole viewport + const ratio = touchDist(e.touches) / touchStartDist; + if (currentDisplayMode !== "fullscreen") { + // Inline: a clear pinch-in means "go fullscreen". 1.15Γ— threshold + // avoids triggering on jittery two-finger taps/scrolls. + if (ratio > 1.15 && !modeTransitionInFlight) { + modeTransitionInFlight = true; + touchStartDist = 0; // end this gesture; fullscreen will refit + pageWrapperEl.style.transform = ""; + void toggleFullscreen().finally(() => { + setTimeout(() => (modeTransitionInFlight = false), 250); + }); + } + return; + } + updatePinch(pinchStartScale * ratio); + }, + { passive: false }, +); + +canvasContainerEl.addEventListener("touchend", (event) => { + const e = event as TouchEvent; + // Gesture ends when we drop below two fingers. e.touches is the + // REMAINING set β€” lifting one of two leaves length 1. + if (touchStartDist === 0 || e.touches.length >= 2) return; + touchStartDist = 0; + if (currentDisplayMode !== "fullscreen") { + // Inline pinch that didn't cross the threshold β€” discard preview. + pageWrapperEl.style.transform = ""; + return; + } + commitPinch(); +}); + +canvasContainerEl.addEventListener("touchcancel", () => { + if (touchStartDist === 0) return; + touchStartDist = 0; + // Cancelled (call, app-switch) β†’ revert, don't commit a half-gesture. + pageWrapperEl.style.transform = ""; + zoomLevelEl.textContent = `${Math.round(scale * 100)}%`; +}); + // Parse tool result function parseToolResult(result: CallToolResult): { url: string; @@ -1021,6 +4327,7 @@ async function fetchChunk( begin: number, end: number, ): Promise { + const gen = loadGeneration; // capture before any await const cacheKey = `${url}:${begin}-${end}`; const cached = rangeCache.get(cacheKey); if (cached) return cached; @@ -1054,6 +4361,12 @@ async function fetchChunk( bytes[i] = binaryString.charCodeAt(i); } + // PDF was reloaded while this fetch was in flight β€” don't poison the + // cache with bytes from the old generation's offsets. + if (gen !== loadGeneration) { + throw new Error("Fetch cancelled β€” PDF was reloaded"); + } + const entry: RangeResult = { bytes, totalBytes: chunk.totalBytes }; rangeCache.set(cacheKey, entry); return entry; @@ -1112,25 +4425,119 @@ async function fetchRange( return entry; } +/** + * Reload the current PDF from disk, discarding all in-memory edits and caches. + * Preserves currentPage (clamped). Does not stop/restart the poll loop. + */ +async function reloadPdf(): Promise { + log.info("Reloading PDF from disk"); + showLoading("Reloading..."); + + // Invalidate all in-flight fetches and the preloader + loadGeneration++; + + // Drop byte cache β€” file contents changed, everything is stale. + // In-flight requests will check loadGeneration before re-populating. + rangeCache.clear(); + inflightRequests.clear(); + + // Cancel active render and destroy the old document + currentRenderTask?.cancel(); + currentRenderTask = null; + const oldDoc = pdfDocument; + pdfDocument = null; + await oldDoc?.destroy().catch(() => {}); + + // Clear per-document edit/display state + for (const [, t] of annotationMap) for (const el of t.elements) el.remove(); + annotationMap.clear(); + formFieldValues.clear(); + imageCache.clear(); + selectedAnnotationIds.clear(); + undoStack.length = 0; + redoStack.length = 0; + pdfBaselineAnnotations = []; + baselineScannedPages.clear(); + restoredRemovedIds.clear(); + pdfBaselineFormValues.clear(); + pageTextCache.clear(); + pageTextItemsCache.clear(); + allMatches = []; + currentMatchIndex = -1; + focusedFieldName = null; + fieldNameToIds.clear(); + radioButtonValues.clear(); + fieldNameToLabel.clear(); + fieldNameToOrder.clear(); + cachedFieldObjects = null; + + // Drop persisted localStorage diff β€” disk is now the source of truth + const key = annotationStorageKey(); + if (key) { + try { + localStorage.removeItem(key); + } catch { + /* ignore */ + } + } + + // Reset save-button state machine + saveBtnEverShown = false; + lastSavedMtime = null; + isDirty = false; + updateTitleDisplay(); + updateSaveBtn(); + + // Reset preload indicators + pagesLoaded = 0; + preloadErrors = []; + loadingIndicatorEl.classList.remove("error"); + loadingIndicatorEl.style.display = "none"; + + try { + const { document, totalBytes } = await loadPdfProgressively(pdfUrl); + pdfDocument = document; + totalPages = document.numPages; + currentPage = Math.max(1, Math.min(currentPage, totalPages)); + log.info("PDF reloaded:", totalPages, "pages,", totalBytes, "bytes"); + + showViewer(); + // Render immediately β€” baseline-annotation scan now happens per-page + // inside renderPage(); buildFieldNameMap below early-returns when no + // AcroForm is present. See same pattern in the initial-load path. + await renderPage(); + + const seeded = await buildFieldNameMap(document); + syncFormValuesToStorage(); + if (seeded) await renderPage(); + updateAnnotationsBadge(); + renderAnnotationPanel(); + + renderPage(); + startPreloading(); + } catch (err) { + log.error("Reload failed:", err); + showError(err instanceof Error ? err.message : String(err)); + } +} + /** * Load PDF progressively using PDFDataRangeTransport. * PDF.js will request ranges as needed to render pages. */ -async function loadPdfProgressively( - urlToLoad: string, - fileSizeBytes: number, -): Promise<{ +async function loadPdfProgressively(urlToLoad: string): Promise<{ document: pdfjsLib.PDFDocumentProxy; totalBytes: number; }> { - const fileTotalBytes = fileSizeBytes; - log.info(`PDF file size: ${(fileTotalBytes / 1024) | 0} KB`); - class AppRangeTransport extends pdfjsLib.PDFDataRangeTransport { requestDataRange(begin: number, end: number) { fetchRange(urlToLoad, begin, end) .then((result) => { - this.onDataRange(begin, result.bytes); + // PDF.js transfers the ArrayBuffer to its worker, detaching it. + // Pass a copy so the rangeCache entry stays valid for re-requests + // (iOS/WKWebView re-requests ranges under memory pressure and + // throws "Buffer is already detached" on the cached original). + this.onDataRange(begin, result.bytes.slice()); }) .catch((err: unknown) => { log.error(`Error fetching range ${begin}-${end}:`, err); @@ -1138,10 +4545,29 @@ async function loadPdfProgressively( } } + // Probe current file size via a live read_pdf_bytes call. Don't trust the + // totalBytes from the display_pdf result: that's baked into conversation + // history, so if the user saved the PDF (annotations/form fields) and + // reloaded the conversation, the host replays a stale value. A mismatch + // makes pdf.js fail every chunk with an opaque "Bad end offset: N". + const { totalBytes: fileTotalBytes } = await fetchChunk(urlToLoad, 0, 1); + if (!Number.isInteger(fileTotalBytes) || fileTotalBytes <= 0) { + throw new Error(`Invalid totalBytes (${fileTotalBytes}) from server`); + } + log.info(`PDF file size: ${(fileTotalBytes / 1024) | 0} KB`); + // Create transport with total file size, no initial data β€” PDF.js will request what it needs const transport = new AppRangeTransport(fileTotalBytes, null); - const loadingTask = pdfjsLib.getDocument({ range: transport }); + const loadingTask = pdfjsLib.getDocument({ + range: transport, + standardFontDataUrl: STANDARD_FONT_DATA_URL, + // Only fetch ranges renderPage()/getFieldObjects() actually ask for. + // Without these pdfjs background-prefetches the whole file regardless of + // the per-page lazy scans below. + disableAutoFetch: true, + disableStream: true, + }); try { const document = await loadingTask.promise; @@ -1201,16 +4627,25 @@ function scheduleSearchRefresh() { async function startPreloading() { if (!pdfDocument) return; + const gen = loadGeneration; log.info("Starting background preload of", totalPages, "pages"); for (let i = 1; i <= totalPages; i++) { + if (gen !== loadGeneration) { + log.info("Preload aborted β€” PDF reloaded"); + return; + } if (pageTextCache.has(i)) { pagesLoaded++; updateLoadingIndicator(); continue; } - // Yield to interactive navigation - while (preloadPaused) await new Promise((r) => setTimeout(r, 50)); + // Yield to interactive navigation. Re-check gen inside the wait so + // teardown doesn't spin here forever if it fires mid-pause. + while (preloadPaused && gen === loadGeneration) { + await new Promise((r) => setTimeout(r, 50)); + } + if (gen !== loadGeneration) return; try { const page = await pdfDocument.getPage(i); @@ -1250,6 +4685,10 @@ app.ontoolresult = async (result: CallToolResult) => { // Note: pageCount may not be accurate until document loads totalPages = parsed.pageCount || 1; viewUUID = result._meta?.viewUUID ? String(result._meta.viewUUID) : undefined; + interactEnabled = result._meta?.interactEnabled === true; + fileWritable = result._meta?.writable === true; + // Debug bubble: server only emits _debug when --debug is set. + if (result._meta?._debug !== undefined) showDebugBubble(result._meta._debug); // Restore saved page or use initial page const savedPage = loadSavedPage(); @@ -1262,10 +4701,7 @@ app.ontoolresult = async (result: CallToolResult) => { try { // Use progressive loading - document available as soon as initial data arrives - const { document, totalBytes } = await loadPdfProgressively( - pdfUrl, - parsed.totalBytes, - ); + const { document, totalBytes } = await loadPdfProgressively(pdfUrl); pdfDocument = document; totalPages = document.numPages; @@ -1281,12 +4717,69 @@ app.ontoolresult = async (result: CallToolResult) => { loadingIndicatorEl.style.display = "none"; showViewer(); + downloadBtn.style.display = app.getHostCapabilities()?.downloadFile + ? "" + : "none"; + + // Compute fit + render IMMEDIATELY for fast first paint. The canvas is + // unsized until renderPage() runs β€” anything async between showViewer() + // and here makes the empty viewer visible. The annotation/form scans + // below are O(numPages) and do NOT block the canvas (page.render only + // needs canvasContext+viewport), so they run after. + const fitScale = await computeFitScale(); + if (fitScale !== null) { + scale = fitScale; + log.info("Initial fit scale:", scale); + } + // Restore any persisted user diff BEFORE first render so the per-page + // baseline scan inside renderPage() can honour the removed-id tombstones + // and not resurrect annotations the user deleted last session. + // restoreAnnotations is sync (localStorage read) so first paint is not + // delayed. + restoreAnnotations(); + await renderPage(); + + // Build field name β†’ annotation ID mapping for form filling + const seeded = await buildFieldNameMap(document); + // Pre-populate annotationStorage from restored formFieldValues + syncFormValuesToStorage(); + // buildFieldNameMap may have pushed AcroForm-tree values into storage + // (when the page widget's /V is stale vs the field dict β€” pdf-lib's save + // can leave them split). The first renderPage above ran BEFORE that, so + // the form layer shows the stale widget value. Re-render so it picks up + // storage. Only when something was actually seeded β€” most PDFs don't hit + // this and the extra render would be pure waste. + if (seeded) await renderPage(); + + updateAnnotationsBadge(); + // Save button visibility driven by setDirty()/updateSaveBtn(); + // restoreAnnotations() may have just flipped it via setDirty(true). + updateSaveBtn(); + + // Re-render to overlay PDF-baseline annotations + restored form values. + // For PDFs with neither, the canvas is identical β†’ no flicker. renderPage(); // Start background preloading of all pages for text extraction startPreloading(); + + // Start polling for commands now that we have viewUUID + if (viewUUID && interactEnabled) { + startPolling(); + } else { + log.info("Interact disabled on server β€” skipping poll_pdf_commands loop"); + } } catch (err) { log.error("Error loading PDF:", err); showError(err instanceof Error ? err.message : String(err)); + // Poll anyway. The server's interact tool has no way to know we choked β€” + // without a poll it waits 45s on every get_screenshot against this + // viewUUID. handleGetPages already null-guards pdfDocument, so a failed + // load just means empty page data β†’ server returns "No screenshot + // returned" (fast, actionable) instead of "Timeout waiting for page data + // from viewer" (slow, opaque). + if (viewUUID && interactEnabled) { + startPolling(); + } } }; @@ -1295,6 +4788,305 @@ app.onerror = (err: unknown) => { showError(err instanceof Error ? err.message : String(err)); }; +// ============================================================================= +// Command Queue Polling +// ============================================================================= + +// PdfCommand is the wire protocol between server and viewer. +// Single source of truth in ./commands.ts β€” adding a new command +// variant there forces a matching `case` below. +import type { PdfCommand } from "./commands.js"; + +/** Get page height in PDF points (for coordinate conversion). */ +async function getPageHeight(pageNum: number): Promise { + if (!pdfDocument) return 792; // US Letter fallback + const page = await pdfDocument.getPage(pageNum); + return page.getViewport({ scale: 1.0 }).height; +} + +/** + * Process a batch of commands from the server queue + */ +async function processCommands(commands: PdfCommand[]): Promise { + if (commands.length === 0) return; + + for (const cmd of commands) { + log.info("Processing command:", cmd.type, cmd); + switch (cmd.type) { + case "navigate": + if (cmd.page >= 1 && cmd.page <= totalPages) { + goToPage(cmd.page); + } + break; + case "search": + openSearch(); + searchInputEl.value = cmd.query; + performSearch(cmd.query); + break; + case "find": + performSilentSearch(cmd.query); + break; + case "search_navigate": + if ( + allMatches.length > 0 && + cmd.matchIndex >= 0 && + cmd.matchIndex < allMatches.length + ) { + currentMatchIndex = cmd.matchIndex; + const match = allMatches[cmd.matchIndex]; + if (match.pageNum !== currentPage) { + goToPage(match.pageNum); + } + renderHighlights(); + updateSearchUI(); + updatePageContext(); + } + break; + case "zoom": + if (cmd.scale >= 0.5 && cmd.scale <= 3.0) { + scale = cmd.scale; + renderPage(); + } + break; + case "add_annotations": + // Per-def isolation. If convertFromModelCoords or addAnnotation throws + // for one def (bad shape, NaN coords), the rest still apply β€” and + // critically, a get_pages later in this batch still runs. Without + // this, a single bad annotation makes the whole batch throw out of + // processCommands, the iframe never reaches submit_page_data, and the + // server's interact() waits the full 45s for a reply that never comes. + for (const def of cmd.annotations) { + try { + const pageHeight = await getPageHeight(def.page); + addAnnotation(convertFromModelCoords(def, pageHeight)); + } catch (err) { + log.error(`add_annotations: failed for id=${def.id}:`, err); + } + } + break; + case "update_annotations": + for (const update of cmd.annotations) { + const existing = annotationMap.get(update.id); + if (!existing) { + log.error( + `update_annotations: id=${update.id} not found β€” skipping`, + ); + continue; + } + try { + // The model sends model coords (y-down, y = top-left). existing.def + // is internal coords (y-up, y = bottom-left). For rect/circle/image + // the converted internal y = pageHeight - modelY - height β€” a function + // of BOTH y AND height. If the model patches only {height}, we must + // still rewrite internal y to keep the top fixed; otherwise the + // bottom stays fixed and the top shifts. Same coupling applies to + // {page} changes across differently-sized pages. + // + // Fix: round-trip through model space. Convert existing to model + // coords, spread the patch on top (all-model now), convert back. + // convertToModelCoords is self-inverse (pdf-annotations.ts:192) so + // unchanged fields pass through unmolested. + const srcPageH = await getPageHeight(existing.def.page); + const existingModel = convertToModelCoords(existing.def, srcPageH); + const mergedModel = { + ...existingModel, + ...update, + } as PdfAnnotationDef; + const dstPageH = + update.page != null && update.page !== existing.def.page + ? await getPageHeight(update.page) + : srcPageH; + const mergedInternal = convertFromModelCoords( + mergedModel, + dstPageH, + ); + // Pass the FULL merged def. updateAnnotation() already merges over + // the tracked def, so passing everything is correct and avoids the + // "only copy back Object.keys(update)" loop that caused the bug. + updateAnnotation(mergedInternal); + } catch (err) { + log.error(`update_annotations: failed for id=${update.id}:`, err); + } + } + break; + case "remove_annotations": + for (const id of cmd.ids) { + removeAnnotation(id); + } + // Re-render annotation layer since elements were removed + renderAnnotationsForPage(currentPage); + break; + case "highlight_text": + handleHighlightText(cmd); + break; + case "fill_form": + for (const field of cmd.fields) { + formFieldValues.set(field.name, field.value); + if (!fieldNameToIds.has(field.name)) { + log.info(`fill_form: no annotation IDs for field "${field.name}"`); + } + setFieldInStorage(field.name, field.value); + } + // Re-render to show updated form values (handles fields on other pages) + renderPage(); + // Update sidebar badge and panel to reflect new form field values + updateAnnotationsBadge(); + renderAnnotationPanel(); + break; + case "get_pages": + // Await so the next poll doesn't start until submit_page_data has + // been SENT. The host (Claude Desktop/Nest) serializes iframeβ†’server + // tool calls β€” if we re-poll immediately, submit_page_data queues + // behind the 30s long-poll and interact times out. Awaiting costs a + // few seconds of poll gap, but interact is blocked in waitForPageData + // anyway so no commands are lost. + try { + await handleGetPages(cmd); + } catch (err) { + log.error("get_pages failed β€” submitting empty result:", err); + await app + .callServerTool({ + name: "submit_page_data", + arguments: { requestId: cmd.requestId, pages: [] }, + }) + .catch(() => {}); + } + break; + case "save_as": + // Same await-before-next-poll discipline as get_pages β€” submit must + // be SENT before we re-poll, or it queues behind the 30s long-poll. + try { + const pdfBytes = await getAnnotatedPdfBytes(); + const base64 = uint8ArrayToBase64(pdfBytes); + await app.callServerTool({ + name: "submit_save_data", + arguments: { requestId: cmd.requestId, data: base64 }, + }); + log.info(`save_as: submitted ${pdfBytes.length} bytes`); + } catch (err) { + log.error("save_as: failed to build bytes β€” submitting error:", err); + await app + .callServerTool({ + name: "submit_save_data", + arguments: { + requestId: cmd.requestId, + error: err instanceof Error ? err.message : String(err), + }, + }) + .catch(() => {}); + } + break; + case "get_viewer_state": + // Same await-before-next-poll discipline as get_pages/save_as. + try { + await handleGetViewerState(cmd.requestId); + } catch (err) { + log.error("get_viewer_state failed β€” submitting error:", err); + await app + .callServerTool({ + name: "submit_viewer_state", + arguments: { + requestId: cmd.requestId, + error: err instanceof Error ? err.message : String(err), + }, + }) + .catch(() => {}); + } + break; + case "file_changed": { + // Skip our own save_pdf echo: either save is still in flight, or the + // event's mtime matches what save_pdf just returned. + if (saveInProgress) { + log.info("file_changed: save in progress, ignoring"); + break; + } + if ( + lastSavedMtime !== null && + Math.abs(cmd.mtimeMs - lastSavedMtime) < 1 + ) { + log.info("file_changed: matches our last save, ignoring"); + lastSavedMtime = null; // one-shot + break; + } + + if (!isDirty) { + await reloadPdf(); + } else { + const choice = await showConfirmDialog( + "File changed on disk", + "The PDF was modified outside this viewer, but you have unsaved " + + "edits. Keeping your edits may cause rendering errors when " + + "scrolling to pages that haven't loaded yet.", + [ + { label: "Discard & reload" }, + { label: "Keep my edits", primary: true }, + ], + ); + if (choice === 0) { + await reloadPdf(); + } + } + break; + } + } + } + + // Persist after processing batch β€” but only if anything mutated. + // get_pages / save_as / file_changed are read-only; writing localStorage + // and recomputing the diff for them is wasted work. + if ( + commands.some( + (c) => + c.type !== "get_pages" && + c.type !== "save_as" && + c.type !== "file_changed", + ) + ) { + persistAnnotations(); + } +} + +let polling = false; + +function startPolling(): void { + if (polling) return; + polling = true; + pollLoop(); +} + +async function pollLoop(): Promise { + while (polling && viewUUID) { + try { + const result = await app.callServerTool({ + name: "poll_pdf_commands", + arguments: { viewUUID }, + }); + if (result.isError) { + // Tool not found or server rejected β€” stop polling entirely rather + // than spin on a non-recoverable error result (which doesn't throw). + log.error("poll_pdf_commands error β€” stopping poll loop:", result); + polling = false; + return; + } + const commands = + (result.structuredContent as { commands?: PdfCommand[] })?.commands || + []; + if (commands.length > 0) { + log.info(`Received ${commands.length} command(s)`); + await processCommands(commands); + } + } catch (err) { + log.error("Poll error:", err); + // Back off on error to avoid tight error loops + await new Promise((r) => setTimeout(r, 2000)); + } + } +} + +function stopPolling(): void { + polling = false; +} + function handleHostContextChanged(ctx: McpUiHostContext) { log.info("Host context changed:", ctx); @@ -1308,41 +5100,786 @@ function handleHostContextChanged(ctx: McpUiHostContext) { applyHostStyleVariables(ctx.styles.variables); } - // Apply safe area insets + // Apply safe area insets β€” set CSS custom properties for use in both + // inline mode (padding on .main) and fullscreen mode (padding on .toolbar) if (ctx.safeAreaInsets) { - mainEl.style.paddingTop = `${ctx.safeAreaInsets.top}px`; - mainEl.style.paddingRight = `${ctx.safeAreaInsets.right}px`; - mainEl.style.paddingBottom = `${ctx.safeAreaInsets.bottom}px`; - mainEl.style.paddingLeft = `${ctx.safeAreaInsets.left}px`; + const { top, right, bottom, left } = ctx.safeAreaInsets; + mainEl.style.setProperty("--safe-top", `${top}px`); + mainEl.style.setProperty("--safe-right", `${right}px`); + mainEl.style.setProperty("--safe-bottom", `${bottom}px`); + mainEl.style.setProperty("--safe-left", `${left}px`); + mainEl.style.paddingTop = `${top}px`; + mainEl.style.paddingRight = `${right}px`; + mainEl.style.paddingBottom = `${bottom}px`; + mainEl.style.paddingLeft = `${left}px`; } - // Log containerDimensions for debugging - if (ctx.containerDimensions) { - log.info("Container dimensions:", ctx.containerDimensions); - } - - // Handle display mode changes + // Display-mode handling MUST run before the fit-to-width recompute below. + // Toggling .fullscreen flips `padding: 0 !important` on mainEl, which + // changes how much width the canvas-container actually gets. Measuring + // before the class lands sees the wrong padding. if (ctx.displayMode) { const wasFullscreen = currentDisplayMode === "fullscreen"; currentDisplayMode = ctx.displayMode as "inline" | "fullscreen"; const isFullscreen = currentDisplayMode === "fullscreen"; mainEl.classList.toggle("fullscreen", isFullscreen); log.info(isFullscreen ? "Fullscreen mode enabled" : "Inline mode"); - // When exiting fullscreen, request resize to fit content - if (wasFullscreen && !isFullscreen && pdfDocument) { - requestFitToContent(); + // Re-apply panel layout for new display mode + if (panelState.open) { + setAnnotationPanelOpen(true); + } + if (!isFullscreen) { + // Fullscreen zoom level is meaningless inline β€” always refit on exit, + // however it was triggered (pinch, button, host Escape/Γ—). + userHasZoomed = false; + // The iframe shrink lands after this handler; let the ResizeObserver + // do one refit on that shrink (its inline branch normally ignores + // shrinks to avoid a requestFitToContent feedback loop). + forceNextResizeRefit = true; + } + if (wasFullscreen !== isFullscreen) { + // Fast-path refit (computeFitScale reads displayMode). The iframe may + // not have its final size yet β€” the ResizeObserver one-shot above + // covers the inline-shrink case once it does. + void refitScale(); } updateFullscreenButton(); } + + // ResizeObserver on canvasContainerEl drives refit on actual size change; + // ctx.containerDimensions is logged for debugging but isn't load-bearing. + if (ctx.containerDimensions) { + log.info("Container dimensions changed:", ctx.containerDimensions); + } } +app.onteardown = async () => { + log.info("App is being torn down"); + stopPolling(); + // Bump loadGeneration so startPreloading's gen check fails and the + // loop exits on its next iteration (reuses the reload-abort mechanism). + loadGeneration++; + if (searchDebounceTimer) { + clearTimeout(searchDebounceTimer); + searchDebounceTimer = null; + } + if (pinchSettleTimer) { + clearTimeout(pinchSettleTimer); + pinchSettleTimer = null; + } + containerResizeObserver.disconnect(); + return {}; +}; + app.onhostcontextchanged = handleHostContextChanged; +// ============================================================================= +// App-registered tools β€” 1:1 with the server's `interact` commands. +// +// Each tool constructs the matching PdfCommand and dispatches through +// processCommands(), so the command-handling logic lives in exactly one +// place. The server-side `interact` tool remains for hosts that don't +// support app-registered tools. +// ============================================================================= + +/** Shared zod shapes mirroring server.ts interact schema. */ +const FormFieldSchema = z.object({ + name: z.string(), + value: z.union([z.string(), z.boolean()]), +}); +const PageIntervalSchema = z.object({ + start: z.number().min(1).optional(), + end: z.number().min(1).optional(), +}); + +/** Dispatch a command via processCommands and return a text result. */ +async function runCommand( + cmd: PdfCommand, + okText: string | (() => string), +): Promise { + if (!pdfDocument) { + return { + content: [{ type: "text" as const, text: "Error: No document loaded" }], + isError: true, + }; + } + await processCommands([cmd]); + const text = typeof okText === "function" ? okText() : okText; + return { content: [{ type: "text" as const, text }] }; +} + +app.registerTool( + "get-document-info", + { + title: "Get Document Info", + description: + "Get information about the current PDF document including title, current page, total pages, and zoom level", + }, + async () => { + if (!pdfDocument) { + return { + content: [{ type: "text" as const, text: "Error: No document loaded" }], + isError: true, + }; + } + const info = { + title: pdfTitle || "Untitled", + url: pdfUrl, + currentPage, + totalPages, + scale, + displayMode: currentDisplayMode, + }; + return { + content: [{ type: "text" as const, text: JSON.stringify(info, null, 2) }], + structuredContent: info, + }; + }, +); + +app.registerTool( + "navigate", + { + title: "Navigate", + description: "Jump to a specific page in the document", + inputSchema: z.object({ + page: z.number().int().min(1).describe("Page number (1-indexed)"), + }), + }, + async ({ page }) => { + if (pdfDocument && (page < 1 || page > totalPages)) { + return { + content: [ + { + type: "text" as const, + text: `Error: Page ${page} out of range (1-${totalPages})`, + }, + ], + isError: true, + }; + } + return runCommand( + { type: "navigate", page }, + `Navigated to page ${page}/${totalPages}`, + ); + }, +); + +app.registerTool( + "search", + { + title: "Search", + description: + "Search for text and highlight matches in the viewer UI. Opens the search bar and jumps to the first match.", + inputSchema: z.object({ + query: z.string().describe("Text to search for"), + }), + }, + async ({ query }) => + runCommand( + { type: "search", query }, + () => `Searched for "${query}": ${allMatches.length} match(es)`, + ), +); + +app.registerTool( + "find", + { + title: "Find", + description: + "Silent search β€” locate matches without opening the search UI. Use before search_navigate.", + inputSchema: z.object({ + query: z.string().describe("Text to search for"), + }), + }, + async ({ query }) => + runCommand( + { type: "find", query }, + () => `Found ${allMatches.length} match(es) for "${query}"`, + ), +); + +app.registerTool( + "search_navigate", + { + title: "Search Navigate", + description: + "Jump to the Nth search match (0-indexed). Call search or find first.", + inputSchema: z.object({ + matchIndex: z.number().int().min(0).describe("Match index (0-indexed)"), + }), + }, + async ({ matchIndex }) => { + if (allMatches.length === 0) { + return { + content: [ + { + type: "text" as const, + text: "Error: No search results. Call search or find first.", + }, + ], + isError: true, + }; + } + if (matchIndex >= allMatches.length) { + return { + content: [ + { + type: "text" as const, + text: `Error: matchIndex ${matchIndex} out of range (0-${allMatches.length - 1})`, + }, + ], + isError: true, + }; + } + return runCommand( + { type: "search_navigate", matchIndex }, + `Jumped to match ${matchIndex + 1}/${allMatches.length} on page ${allMatches[matchIndex].pageNum}`, + ); + }, +); + +app.registerTool( + "zoom", + { + title: "Zoom", + description: "Set the zoom scale for the document", + inputSchema: z.object({ + scale: z + .number() + .min(0.5) + .max(3.0) + .describe("Zoom scale, 1.0 = 100% (range: 0.5-3.0)"), + }), + }, + async ({ scale }) => + runCommand( + { type: "zoom", scale }, + `Zoom set to ${Math.round(scale * 100)}%`, + ), +); + +app.registerTool( + "add_annotations", + { + title: "Add Annotations", + description: + "Add one or more annotations (highlight, note, rectangle, circle, line, stamp, image, freetext). Each needs id, type, page, and type-specific geometry.", + inputSchema: z.object({ + annotations: z + .array(z.record(z.string(), z.any())) + .min(1) + .describe( + "Annotation objects. Each needs: id, type, page, plus type-specific fields (x, y, width, height, rects, color, content, etc.)", + ), + }), + }, + async ({ annotations }) => + runCommand( + { + type: "add_annotations", + annotations: annotations as PdfAnnotationDef[], + }, + `Added ${annotations.length} annotation(s)`, + ), +); + +app.registerTool( + "update_annotations", + { + title: "Update Annotations", + description: + "Patch existing annotations by id. Only id and type are required; other fields are merged.", + inputSchema: z.object({ + annotations: z + .array(z.record(z.string(), z.any())) + .min(1) + .describe("Partial annotation objects. Each needs: id, type."), + }), + }, + async ({ annotations }) => + runCommand( + { + type: "update_annotations", + annotations: annotations as Extract< + PdfCommand, + { type: "update_annotations" } + >["annotations"], + }, + `Updated ${annotations.length} annotation(s)`, + ), +); + +app.registerTool( + "remove_annotations", + { + title: "Remove Annotations", + description: "Delete annotations by id", + inputSchema: z.object({ + ids: z.array(z.string()).min(1).describe("Annotation IDs to remove"), + }), + }, + async ({ ids }) => + runCommand( + { type: "remove_annotations", ids }, + `Removed ${ids.length} annotation(s)`, + ), +); + +app.registerTool( + "highlight_text", + { + title: "Highlight Text", + description: + "Auto-locate text and add a highlight annotation. Searches the document (or a specific page) and highlights the first match.", + inputSchema: z.object({ + query: z.string().describe("Text to locate and highlight"), + page: z + .number() + .int() + .min(1) + .optional() + .describe("Restrict search to this page"), + color: z.string().optional().describe("Highlight color (CSS color)"), + content: z.string().optional().describe("Tooltip/note content"), + }), + }, + async ({ query, page, color, content }) => { + const id = `ht_${Date.now()}_${Math.random().toString(36).slice(2, 8)}`; + return runCommand( + { type: "highlight_text", id, query, page, color, content }, + `Highlighted "${query}"${page ? ` on page ${page}` : ""} (id: ${id})`, + ); + }, +); + +app.registerTool( + "fill_form", + { + title: "Fill Form", + description: "Fill PDF form fields by name", + inputSchema: z.object({ + fields: z + .array(FormFieldSchema) + .min(1) + .describe( + "Form fields: { name, value } where value is string or boolean", + ), + }), + }, + async ({ fields }) => + runCommand( + { type: "fill_form", fields }, + `Filled ${fields.length} field(s): ${fields.map((f) => f.name).join(", ")}`, + ), +); + +app.registerTool( + "get_text", + { + title: "Get Text", + description: + "Extract text from one or more pages. Returns one text block per page.", + inputSchema: z.object({ + page: z + .number() + .int() + .min(1) + .optional() + .describe("Single page (shorthand for intervals: [{start:N, end:N}])"), + intervals: z + .array(PageIntervalSchema) + .optional() + .describe( + "Page ranges. Each has optional start/end. [{start:1,end:5}], [{}] = all pages. Max 20 pages.", + ), + }), + }, + async ({ page, intervals }) => { + if (!pdfDocument) { + return { + content: [{ type: "text" as const, text: "Error: No document loaded" }], + isError: true, + }; + } + const resolved = intervals ?? (page ? [{ start: page, end: page }] : [{}]); + const data = await collectPageData(resolved, true, false); + const parts = data + .filter((e) => e.text != null) + .map((e) => ({ + type: "text" as const, + text: `--- Page ${e.page} ---\n${e.text}`, + })); + return { + content: + parts.length > 0 + ? parts + : [{ type: "text" as const, text: "No text content returned" }], + structuredContent: { pages: data }, + }; + }, +); + +app.registerTool( + "get_screenshot", + { + title: "Get Screenshot", + description: "Render a page to a JPEG image for visual analysis", + inputSchema: z.object({ + page: z.number().int().min(1).describe("Page number to render"), + }), + }, + async ({ page }) => { + if (!pdfDocument) { + return { + content: [{ type: "text" as const, text: "Error: No document loaded" }], + isError: true, + }; + } + const data = await collectPageData( + [{ start: page, end: page }], + false, + true, + ); + const entry = data[0]; + if (entry?.image) { + return { + content: [ + { + type: "image" as const, + data: entry.image, + mimeType: "image/jpeg", + }, + ], + }; + } + return { + content: [ + { + type: "text" as const, + text: `Error: screenshot failed for page ${page}`, + }, + ], + isError: true, + }; + }, +); + // Connect to host -app.connect().then(() => { - log.info("Connected to host"); - const ctx = app.getHostContext(); - if (ctx) { - handleHostContextChanged(ctx); +app + .connect() + .then(() => { + log.info("Connected to host"); + const ctx = app.getHostContext(); + if (ctx) { + handleHostContextChanged(ctx); + } + // Restore annotations early using toolInfo.id (available before tool result) + restoreAnnotations(); + updateAnnotationsBadge(); + }) + .catch((err: unknown) => { + // ui/initialize failed or transport rejected. Without a catch this is an + // unhandled rejection β€” iframe shows blank, server times out on every + // interact call with no clue why. + log.error("Failed to connect to host:", err); + showError( + `Failed to connect to host: ${err instanceof Error ? err.message : String(err)}`, + ); + }); + +// Debug helper: dump all annotation state. Run in DevTools console as +// `__pdfDebug()` to diagnose ghost annotations (visible on canvas but not +// in panel / not selectable). Returns a copy-pasteable JSON object. +(window as unknown as { __pdfDebug: () => unknown }).__pdfDebug = () => { + const out = { + annotationMap: [...annotationMap.entries()].map(([id, t]) => ({ + id, + type: t.def.type, + page: t.def.page, + hasElements: t.elements.length, + // Trim imageData β€” can be megabytes of base64 + def: + t.def.type === "image" + ? { ...t.def, imageData: t.def.imageData ? "" : undefined } + : t.def, + })), + pdfBaselineAnnotations: pdfBaselineAnnotations.map((d) => ({ + id: d.id, + type: d.type, + page: d.page, + })), + annotationLayerChildren: [...annotationLayerEl.children].map((el) => ({ + tag: el.tagName, + class: el.className, + })), + formLayerChildren: [...formLayerEl.children].map((el) => ({ + tag: el.tagName, + class: el.className, + })), + localStorageKey: annotationStorageKey(), + localStorageRaw: (() => { + const k = annotationStorageKey(); + if (!k) return null; + const raw = localStorage.getItem(k); + if (!raw) return null; + // Parse and trim imageData + try { + const d = JSON.parse(raw); + if (Array.isArray(d.added)) { + d.added = d.added.map((a: { imageData?: string }) => + a.imageData ? { ...a, imageData: "" } : a, + ); + } + return d; + } catch { + return { parseError: true, length: raw.length }; + } + })(), + // PDF.js's own annotationStorage β€” where editor stamps live. + // Keys like "pdfjs_internal_editor_*" are PDF.js's built-in annotation + // editor; those are invisible to our annotationMap tracking. + pdfJsAnnotationStorage: (() => { + if (!pdfDocument) return null; + // eslint-disable-next-line @typescript-eslint/no-explicit-any + const storage = pdfDocument.annotationStorage as any; + const all = storage.getAll?.() ?? storage._storage ?? new Map(); + const entries = + all instanceof Map ? [...all.entries()] : Object.entries(all); + // eslint-disable-next-line @typescript-eslint/no-explicit-any + return entries.map(([k, v]: [string, any]) => ({ + key: k, + ctor: v?.constructor?.name, + annotationType: v?.annotationType, + hasBitmap: Boolean(v?.bitmap), + value: v?.value, + })); + })(), + // All localStorage keys that look like ours β€” per-tool-call keys mean + // old sessions' annotations won't restore under the current key. + allPdfAnnotKeys: Object.keys(localStorage).filter( + (k) => k.includes("pdf-annot") || k.includes(":annotations"), + ), + currentPage, + isDirty, + panelOpen: panelState.open, + }; + console.log(JSON.stringify(out, null, 2)); + // Also expose internals on window for interactive poking + // eslint-disable-next-line @typescript-eslint/no-explicit-any + const w = window as any; + w.__pdf = { pdfDocument, annotationMap, annotationLayerEl, formLayerEl }; + console.log( + "β†’ internals exposed as window.__pdf.{pdfDocument, annotationMap, ...}", + ); + return out; +}; + +// ============================================================================= +// Image from File (shared by drag-drop and paste) +// ============================================================================= + +/** + * Create an image annotation from a File/Blob at the given screen position. + * If no position is given, places the image at the center of the current page. + */ +function addImageFromFile( + file: File | Blob, + screenX?: number, + screenY?: number, +): void { + const reader = new FileReader(); + reader.onload = () => { + const dataUrl = reader.result as string; + const base64 = dataUrl.split(",")[1]; + const mimeType = + file.type || (base64.startsWith("/9j/") ? "image/jpeg" : "image/png"); + + const img = new Image(); + img.onload = () => { + const maxWidth = 200; // PDF points + const aspectRatio = img.naturalHeight / img.naturalWidth; + const width = Math.min(img.naturalWidth, maxWidth); + const height = width * aspectRatio; + + // Convert screen position to PDF internal coords, or default to page center + let pdfX: number; + let pdfInternalY: number; + if (screenX != null && screenY != null) { + pdfX = screenX / scale; + pdfInternalY = (containerHtmlEl.clientHeight - screenY) / scale; + } else { + // Center on the visible page area + const pageW = containerHtmlEl.clientWidth / scale; + const pageH = containerHtmlEl.clientHeight / scale; + pdfX = pageW / 2 - width / 2; + pdfInternalY = pageH / 2 + height / 2; + } + + const id = `img_${Date.now()}_${Math.random().toString(36).slice(2, 8)}`; + const def: ImageAnnotation = { + type: "image", + id, + page: currentPage, + x: pdfX, + y: pdfInternalY, + width, + height, + imageData: base64, + mimeType, + }; + + // Downscale if base64 data is too large (> ~300KB) + if (base64.length > 400_000) { + const canvas = document.createElement("canvas"); + const maxDim = 800; + let w = img.naturalWidth; + let h = img.naturalHeight; + if (w > maxDim || h > maxDim) { + const ratio = Math.min(maxDim / w, maxDim / h); + w = Math.round(w * ratio); + h = Math.round(h * ratio); + } + canvas.width = w; + canvas.height = h; + const ctx = canvas.getContext("2d")!; + ctx.drawImage(img, 0, 0, w, h); + const quality = mimeType === "image/jpeg" ? 0.7 : undefined; + const downscaledUrl = canvas.toDataURL(mimeType, quality); + def.imageData = downscaledUrl.split(",")[1]; + } + + addAnnotation(def); + selectAnnotation(def.id); + persistAnnotations(); + }; + img.src = dataUrl; + }; + reader.readAsDataURL(file); +} + +// ============================================================================= +// Image Drag & Drop +// ============================================================================= + +const containerHtmlEl = canvasContainerEl as HTMLElement; +containerHtmlEl.addEventListener("dragover", (e: DragEvent) => { + e.preventDefault(); + e.stopPropagation(); + if (e.dataTransfer) e.dataTransfer.dropEffect = "copy"; +}); + +containerHtmlEl.addEventListener("drop", async (e: DragEvent) => { + e.preventDefault(); + e.stopPropagation(); + if (!e.dataTransfer?.files.length) return; + + const containerRect = containerHtmlEl.getBoundingClientRect(); + const dropX = e.clientX - containerRect.left; + const dropY = e.clientY - containerRect.top; + + for (const file of e.dataTransfer.files) { + if (!file.type.startsWith("image/")) continue; + addImageFromFile(file, dropX, dropY); } }); + +// ============================================================================= +// Clipboard: Copy / Cut / Paste +// ============================================================================= + +/** Clipboard format identifier so we can recognize our own data on paste. */ +const CLIPBOARD_FORMAT = "pdf-annotations/v1"; + +/** Copy selected annotations to clipboard as JSON. Returns true if anything was copied. */ +async function copySelectedAnnotations(): Promise { + if (selectedAnnotationIds.size === 0) return false; + const defs: PdfAnnotationDef[] = []; + for (const id of selectedAnnotationIds) { + const tracked = annotationMap.get(id); + if (tracked) defs.push({ ...tracked.def }); + } + if (defs.length === 0) return false; + + const payload = JSON.stringify({ + format: CLIPBOARD_FORMAT, + annotations: defs, + }); + try { + await navigator.clipboard.writeText(payload); + return true; + } catch { + return false; + } +} + +/** Try to parse clipboard text as our annotation format. */ +function parseAnnotationClipboard(text: string): PdfAnnotationDef[] | null { + try { + const parsed = JSON.parse(text); + if ( + parsed?.format === CLIPBOARD_FORMAT && + Array.isArray(parsed.annotations) + ) { + return parsed.annotations; + } + } catch { + // Not our format + } + return null; +} + +/** Paste annotations or images from clipboard. */ +function handlePaste(e: ClipboardEvent): void { + // Don't intercept paste in inputs + if ( + document.activeElement instanceof HTMLInputElement || + document.activeElement instanceof HTMLTextAreaElement || + document.activeElement instanceof HTMLSelectElement + ) { + return; + } + + const clipboardData = e.clipboardData; + if (!clipboardData) return; + + // Check for image files first + for (const item of clipboardData.items) { + if (item.type.startsWith("image/")) { + e.preventDefault(); + const file = item.getAsFile(); + if (file) addImageFromFile(file); + return; + } + } + + // Check for text that might be our annotation format + const text = clipboardData.getData("text/plain"); + if (!text) return; + + const annotations = parseAnnotationClipboard(text); + if (!annotations || annotations.length === 0) return; + + e.preventDefault(); + + // Paste with new IDs and a slight offset so they don't overlap originals + const offset = 10; // PDF points + selectAnnotation(null); + for (const def of annotations) { + def.id = `paste_${Date.now()}_${Math.random().toString(36).slice(2, 8)}`; + def.page = currentPage; + if ("x" in def && typeof def.x === "number") def.x += offset; + if ("y" in def && typeof def.y === "number") def.y += offset; + if ("rects" in def && Array.isArray(def.rects)) { + for (const r of def.rects) { + r.x += offset; + r.y += offset; + } + } + addAnnotation(def); + selectAnnotation(def.id, true); + } + persistAnnotations(); +} + +document.addEventListener("paste", handlePaste); diff --git a/examples/pdf-server/src/pdf-annotations.test.ts b/examples/pdf-server/src/pdf-annotations.test.ts new file mode 100644 index 0000000..40e63ff --- /dev/null +++ b/examples/pdf-server/src/pdf-annotations.test.ts @@ -0,0 +1,1886 @@ +import { describe, it, expect, beforeAll } from "bun:test"; +import { + emptyDiff, + isDiffEmpty, + serializeDiff, + deserializeDiff, + mergeAnnotations, + computeDiff, + cssColorToRgb, + defaultColor, + importPdfjsAnnotation, + buildAnnotatedPdfBytes, + parseAnnotationRef, + base64ToUint8Array, + uint8ArrayToBase64, + convertFromModelCoords, + convertToModelCoords, + type PdfAnnotationDef, + type AnnotationDiff, +} from "./pdf-annotations"; +import { + PDFDocument, + PDFDict, + PDFName, + PDFArray, + PDFNumber, +} from "@cantoo/pdf-lib"; + +// ============================================================================= +// Diff Model +// ============================================================================= + +describe("AnnotationDiff model", () => { + describe("emptyDiff", () => { + it("creates a diff with no changes", () => { + const diff = emptyDiff(); + expect(diff.added).toEqual([]); + expect(diff.removed).toEqual([]); + expect(diff.formFields).toEqual({}); + }); + }); + + describe("isDiffEmpty", () => { + it("returns true for empty diff", () => { + expect(isDiffEmpty(emptyDiff())).toBe(true); + }); + + it("returns false when there are added annotations", () => { + const diff = emptyDiff(); + diff.added.push({ + type: "note", + id: "n1", + page: 1, + x: 100, + y: 200, + content: "test", + }); + expect(isDiffEmpty(diff)).toBe(false); + }); + + it("returns false when there are removed annotations", () => { + const diff = emptyDiff(); + diff.removed.push("pdf-5-0"); + expect(isDiffEmpty(diff)).toBe(false); + }); + + it("returns false when there are form field values", () => { + const diff = emptyDiff(); + diff.formFields["name"] = "John"; + expect(isDiffEmpty(diff)).toBe(false); + }); + }); + + describe("serializeDiff / deserializeDiff", () => { + it("round-trips an empty diff", () => { + const diff = emptyDiff(); + const json = serializeDiff(diff); + const restored = deserializeDiff(json); + expect(restored).toEqual(diff); + }); + + it("round-trips a diff with all fields populated", () => { + const diff: AnnotationDiff = { + added: [ + { + type: "highlight", + id: "h1", + page: 1, + rects: [{ x: 72, y: 700, width: 200, height: 12 }], + color: "#ff0000", + }, + ], + removed: ["pdf-5-0", "pdf-8-0"], + formFields: { name: "Alice", agree: true }, + }; + const json = serializeDiff(diff); + const restored = deserializeDiff(json); + expect(restored).toEqual(diff); + }); + + it("returns empty diff for invalid JSON", () => { + expect(deserializeDiff("not json")).toEqual(emptyDiff()); + }); + + it("returns empty diff for JSON with wrong structure", () => { + expect(deserializeDiff('{"foo": "bar"}')).toEqual(emptyDiff()); + }); + + it("handles missing fields gracefully", () => { + const result = deserializeDiff('{"added": []}'); + expect(result.added).toEqual([]); + expect(result.removed).toEqual([]); + expect(result.formFields).toEqual({}); + }); + }); +}); + +// ============================================================================= +// Merge Logic +// ============================================================================= + +describe("mergeAnnotations", () => { + const pdfNote: PdfAnnotationDef = { + type: "note", + id: "pdf-5-0", + page: 1, + x: 100, + y: 200, + content: "Original note", + }; + + const pdfHighlight: PdfAnnotationDef = { + type: "highlight", + id: "pdf-8-0", + page: 1, + rects: [{ x: 72, y: 700, width: 200, height: 12 }], + }; + + const userStamp: PdfAnnotationDef = { + type: "stamp", + id: "s1", + page: 1, + x: 300, + y: 400, + label: "APPROVED", + }; + + it("returns PDF annotations unchanged when diff is empty", () => { + const merged = mergeAnnotations([pdfNote, pdfHighlight], emptyDiff()); + expect(merged).toEqual([pdfNote, pdfHighlight]); + }); + + it("filters out removed PDF annotations", () => { + const diff: AnnotationDiff = { + added: [], + removed: ["pdf-5-0"], + formFields: {}, + }; + const merged = mergeAnnotations([pdfNote, pdfHighlight], diff); + expect(merged).toEqual([pdfHighlight]); + }); + + it("includes added annotations", () => { + const diff: AnnotationDiff = { + added: [userStamp], + removed: [], + formFields: {}, + }; + const merged = mergeAnnotations([pdfNote], diff); + expect(merged).toHaveLength(2); + expect(merged).toContainEqual(pdfNote); + expect(merged).toContainEqual(userStamp); + }); + + it("added annotations with same ID as PDF annotation override the PDF one", () => { + const modifiedNote: PdfAnnotationDef = { + ...pdfNote, + content: "Modified note", + }; + const diff: AnnotationDiff = { + added: [modifiedNote], + removed: [], + formFields: {}, + }; + const merged = mergeAnnotations([pdfNote, pdfHighlight], diff); + expect(merged).toHaveLength(2); + const note = merged.find((a) => a.id === "pdf-5-0"); + expect(note).toBeDefined(); + expect((note as any).content).toBe("Modified note"); + }); + + it("handles both additions and removals", () => { + const diff: AnnotationDiff = { + added: [userStamp], + removed: ["pdf-5-0"], + formFields: {}, + }; + const merged = mergeAnnotations([pdfNote, pdfHighlight], diff); + expect(merged).toHaveLength(2); + expect(merged.map((a) => a.id).sort()).toEqual(["pdf-8-0", "s1"]); + }); + + it("returns only added annotations when all PDF annotations are removed", () => { + const diff: AnnotationDiff = { + added: [userStamp], + removed: ["pdf-5-0", "pdf-8-0"], + formFields: {}, + }; + const merged = mergeAnnotations([pdfNote, pdfHighlight], diff); + expect(merged).toEqual([userStamp]); + }); + + it("handles empty PDF annotations with additions", () => { + const diff: AnnotationDiff = { + added: [userStamp], + removed: [], + formFields: {}, + }; + const merged = mergeAnnotations([], diff); + expect(merged).toEqual([userStamp]); + }); +}); + +// ============================================================================= +// computeDiff +// ============================================================================= + +describe("computeDiff", () => { + const pdfNote: PdfAnnotationDef = { + type: "note", + id: "pdf-5-0", + page: 1, + x: 100, + y: 200, + content: "Original", + }; + const pdfHighlight: PdfAnnotationDef = { + type: "highlight", + id: "pdf-8-0", + page: 1, + rects: [{ x: 72, y: 700, width: 200, height: 12 }], + }; + + it("produces empty diff when nothing changed", () => { + const diff = computeDiff( + [pdfNote, pdfHighlight], + [pdfNote, pdfHighlight], + new Map(), + ); + expect(diff.added).toEqual([]); + expect(diff.removed).toEqual([]); + expect(diff.formFields).toEqual({}); + }); + + it("detects added annotations", () => { + const userStamp: PdfAnnotationDef = { + type: "stamp", + id: "s1", + page: 1, + x: 300, + y: 400, + label: "DRAFT", + }; + const diff = computeDiff([pdfNote], [pdfNote, userStamp], new Map()); + expect(diff.added).toEqual([userStamp]); + expect(diff.removed).toEqual([]); + }); + + it("detects removed annotations", () => { + const diff = computeDiff( + [pdfNote, pdfHighlight], + [pdfHighlight], + new Map(), + ); + expect(diff.removed).toEqual(["pdf-5-0"]); + expect(diff.added).toEqual([]); + }); + + it("captures modification of a USER-ADDED annotation (id not in baseline)", () => { + // User adds a stamp, then edits its label. The stamp's id was never + // in the baseline β†’ it stays in `added` with its latest content. + const editedStamp: PdfAnnotationDef = { + type: "stamp", + id: "user-s1", + page: 1, + x: 300, + y: 400, + label: "FINAL", // was "DRAFT" originally, now edited + }; + const diff = computeDiff([pdfNote], [pdfNote, editedStamp], new Map()); + expect(diff.added).toEqual([editedStamp]); + expect(diff.added[0]).toMatchObject({ label: "FINAL" }); + }); + + it("KNOWN LIMITATION: in-place edit of a baseline annotation is lost", () => { + // Editing a PDF-native note's content: same id as baseline, different + // content. computeDiff is id-set based β€” same-id β†’ neither added nor + // removed. The edit vanishes on reload. + // + // Viewer mitigation: addAnnotation() always removeAnnotation(id) first, + // so the common UI path is remove+add. But updateAnnotation() mutates + // in place β€” if the interact tool's update_annotations edits a baseline + // annotation, that edit won't survive a page reload. + const editedNote: PdfAnnotationDef = { + ...pdfNote, + content: "Edited by user", + }; + const diff = computeDiff( + [pdfNote, pdfHighlight], + [editedNote, pdfHighlight], + new Map(), + ); + expect(diff.added).toEqual([]); + expect(diff.removed).toEqual([]); + // If this starts FAILING, the limitation was fixed β€” update expectations. + }); + + it("captures form field values", () => { + const fields = new Map([ + ["name", "Alice"], + ["agree", true], + ]); + const diff = computeDiff([pdfNote], [pdfNote], fields); + expect(diff.formFields).toEqual({ name: "Alice", agree: true }); + }); + + it("omits form fields matching baseline", () => { + const baseline = new Map([ + ["name", "Alice"], + ["agree", true], + ]); + const fields = new Map([ + ["name", "Alice"], // unchanged + ["agree", false], // changed + ["email", "a@b"], // new + ]); + const diff = computeDiff([], [], fields, baseline); + expect(diff.formFields).toEqual({ agree: false, email: "a@b" }); + }); + + it("records fields cleared from baseline", () => { + const baseline = new Map([["name", "Alice"]]); + const fields = new Map(); // cleared + const diff = computeDiff([], [], fields, baseline); + expect(diff.formFields).toEqual({ name: "" }); + }); + + it("produces empty diff when all form values match baseline", () => { + const baseline = new Map([ + ["name", "Alice"], + ["agree", true], + ]); + const diff = computeDiff([], [], new Map(baseline), baseline); + expect(diff.formFields).toEqual({}); + expect(isDiffEmpty(diff)).toBe(true); + }); + + it("round-trips through mergeAnnotations", () => { + const userStamp: PdfAnnotationDef = { + type: "stamp", + id: "s1", + page: 1, + x: 300, + y: 400, + label: "FINAL", + }; + const current = [pdfHighlight, userStamp]; // removed pdfNote, added stamp + const diff = computeDiff([pdfNote, pdfHighlight], current, new Map()); + + // Merging back should produce the current set + const merged = mergeAnnotations([pdfNote, pdfHighlight], diff); + expect(merged.map((a) => a.id).sort()).toEqual( + current.map((a) => a.id).sort(), + ); + }); + + // Backs the post-computeDiff union step in mcp-app.ts persistAnnotations / + // getAnnotatedPdfBytes: with the lazy per-page baseline scan, computeDiff + // alone cannot produce `removed` for natives on pages not yet visited, so + // callers must union restoredRemovedIds. These tests pin the contract those + // call sites depend on. + describe("partial baseline (lazy-scan tombstone preservation)", () => { + const tombstoned = "pdf-5-0"; + const userNote: PdfAnnotationDef = { + type: "note", + id: "u1", + page: 1, + x: 10, + y: 10, + content: "unrelated edit", + }; + + /** Mirrors the union loop in mcp-app.ts persistAnnotations. */ + function unionRestored( + diff: AnnotationDiff, + restored: Iterable, + currentIds: Set, + ): void { + for (const id of restored) { + if (!currentIds.has(id) && !diff.removed.includes(id)) { + diff.removed.push(id); + } + } + } + + it("computeDiff alone drops tombstones for unscanned pages; the union step preserves them", () => { + const baseline: PdfAnnotationDef[] = []; // page with the native not yet scanned + const current = [userNote]; + const diff = computeDiff(baseline, current, new Map()); + expect(diff.removed).toEqual([]); // proves the union step is load-bearing + + unionRestored(diff, [tombstoned], new Set(current.map((a) => a.id))); + + expect(diff.removed).toEqual([tombstoned]); + expect(isDiffEmpty(diff)).toBe(false); + expect(deserializeDiff(serializeDiff(diff)).removed).toEqual([ + tombstoned, + ]); + }); + + it("a tombstone the user re-added is excluded from the union", () => { + const reAdded: PdfAnnotationDef = { + type: "note", + id: tombstoned, + page: 3, + x: 0, + y: 0, + content: "back", + }; + const current = [userNote, reAdded]; + const diff = computeDiff([], current, new Map()); + unionRestored(diff, [tombstoned], new Set(current.map((a) => a.id))); + expect(diff.removed).toEqual([]); + }); + + it("union does not duplicate ids once the page is scanned and computeDiff produces them", () => { + const native: PdfAnnotationDef = { + type: "note", + id: tombstoned, + page: 3, + x: 0, + y: 0, + content: "native", + }; + const diff = computeDiff([native], [userNote], new Map()); + expect(diff.removed).toEqual([tombstoned]); + unionRestored(diff, [tombstoned], new Set([userNote.id])); + expect(diff.removed).toEqual([tombstoned]); + }); + + it("removedRefs from restored tombstones parse for buildAnnotatedPdfBytes; non-ref ids are skipped", () => { + const restored = new Set(["pdf-5-0", "pdf-12R", "pdf-2-idx-7"]); + const removedRefs = [...restored] + .map(parseAnnotationRef) + .filter((r): r is NonNullable => r !== null); + expect(removedRefs).toEqual([ + { objectNumber: 5, generationNumber: 0 }, + { objectNumber: 12, generationNumber: 0 }, + ]); + }); + }); +}); + +// ============================================================================= +// Color Conversion +// ============================================================================= + +describe("cssColorToRgb", () => { + it("parses 6-digit hex", () => { + expect(cssColorToRgb("#ff0000")).toEqual({ r: 1, g: 0, b: 0 }); + expect(cssColorToRgb("#00ff00")).toEqual({ r: 0, g: 1, b: 0 }); + expect(cssColorToRgb("#0000ff")).toEqual({ r: 0, g: 0, b: 1 }); + }); + + it("parses 3-digit hex", () => { + expect(cssColorToRgb("#f00")).toEqual({ r: 1, g: 0, b: 0 }); + expect(cssColorToRgb("#0f0")).toEqual({ r: 0, g: 1, b: 0 }); + }); + + it("parses 8-digit hex (ignores alpha)", () => { + const result = cssColorToRgb("#ff000080"); + expect(result).toEqual({ r: 1, g: 0, b: 0 }); + }); + + it("parses rgb()", () => { + expect(cssColorToRgb("rgb(255, 0, 0)")).toEqual({ r: 1, g: 0, b: 0 }); + expect(cssColorToRgb("rgb(128, 128, 128)")).toEqual({ + r: 128 / 255, + g: 128 / 255, + b: 128 / 255, + }); + }); + + it("parses rgba()", () => { + expect(cssColorToRgb("rgba(255, 128, 0, 0.5)")).toEqual({ + r: 1, + g: 128 / 255, + b: 0, + }); + }); + + it("returns null for invalid input", () => { + expect(cssColorToRgb("not-a-color")).toBeNull(); + expect(cssColorToRgb("")).toBeNull(); + expect(cssColorToRgb("red")).toBeNull(); + }); + + it("is case-insensitive for hex", () => { + expect(cssColorToRgb("#FF0000")).toEqual({ r: 1, g: 0, b: 0 }); + expect(cssColorToRgb("#aaBBcc")).toEqual({ + r: 0xaa / 255, + g: 0xbb / 255, + b: 0xcc / 255, + }); + }); +}); + +describe("defaultColor", () => { + it("returns yellow for highlights", () => { + expect(defaultColor("highlight")).toBe("#ffff00"); + }); + + it("returns red for underline and strikethrough", () => { + expect(defaultColor("underline")).toBe("#ff0000"); + expect(defaultColor("strikethrough")).toBe("#ff0000"); + }); + + it("returns distinct colors for each type", () => { + const types: PdfAnnotationDef["type"][] = [ + "highlight", + "underline", + "strikethrough", + "note", + "rectangle", + "freetext", + "stamp", + "image", + ]; + const colors = types.map(defaultColor); + // At minimum underline and strikethrough share the same color + const unique = new Set(colors); + expect(unique.size).toBeGreaterThanOrEqual(5); + }); +}); + +// ============================================================================= +// PDF.js Annotation Import +// ============================================================================= + +describe("importPdfjsAnnotation", () => { + it("imports a highlight annotation", () => { + const ann = { + annotationType: 9, + ref: { num: 5, gen: 0 }, + rect: [72, 700, 272, 712], + // pdf.js emits a FLAT Float32Array, not nested arrays. + quadPoints: new Float32Array([72, 712, 272, 712, 72, 700, 272, 700]), + color: new Uint8ClampedArray([255, 255, 0]), + contentsObj: { str: "Important" }, + }; + const result = importPdfjsAnnotation(ann, 1, 0); + expect(result).not.toBeNull(); + expect(result!.type).toBe("highlight"); + expect(result!.id).toBe("pdf-5-0"); + expect(result!.page).toBe(1); + expect((result as any).rects).toHaveLength(1); + expect((result as any).content).toBe("Important"); + expect((result as any).color).toBe("#ffff00"); + }); + + it("imports a multi-line highlight (multiple quads β†’ multiple rects)", () => { + // Regression: the parser iterated quadPoints as if nested; pdf.js's + // flat array yielded numbers, so rects stayed empty and import bailed. + const ann = { + annotationType: 9, + ref: { num: 8, gen: 0 }, + quadPoints: new Float32Array([ + // line 1 + 72, 712, 272, 712, 72, 700, 272, 700, + // line 2 + 72, 698, 200, 698, 72, 686, 200, 686, + ]), + color: new Uint8ClampedArray([255, 255, 0]), + }; + const result = importPdfjsAnnotation(ann, 1, 0); + expect(result).not.toBeNull(); + expect(result!.type).toBe("highlight"); + expect((result as any).rects).toHaveLength(2); + expect((result as any).rects[0]).toEqual({ + x: 72, + y: 700, + width: 200, + height: 12, + }); + expect((result as any).rects[1]).toEqual({ + x: 72, + y: 686, + width: 128, + height: 12, + }); + }); + + it("falls back to ann.rect when quadPoints is absent", () => { + const ann = { + annotationType: 9, + ref: { num: 9, gen: 0 }, + rect: [72, 700, 272, 712], + color: new Uint8ClampedArray([255, 255, 0]), + }; + const result = importPdfjsAnnotation(ann, 1, 0); + expect(result).not.toBeNull(); + expect((result as any).rects).toHaveLength(1); + }); + + it("imports an underline annotation", () => { + const ann = { + annotationType: 10, + ref: { num: 6, gen: 0 }, + rect: [72, 700, 272, 712], + // pdf.js emits a FLAT Float32Array, not nested arrays. + quadPoints: new Float32Array([72, 712, 272, 712, 72, 700, 272, 700]), + color: new Uint8ClampedArray([255, 0, 0]), + }; + const result = importPdfjsAnnotation(ann, 1, 0); + expect(result).not.toBeNull(); + expect(result!.type).toBe("underline"); + expect(result!.id).toBe("pdf-6-0"); + }); + + it("imports a strikethrough annotation", () => { + const ann = { + annotationType: 12, + ref: { num: 7, gen: 0 }, + rect: [72, 700, 272, 712], + // pdf.js emits a FLAT Float32Array, not nested arrays. + quadPoints: new Float32Array([72, 712, 272, 712, 72, 700, 272, 700]), + color: new Uint8ClampedArray([255, 0, 0]), + }; + const result = importPdfjsAnnotation(ann, 2, 0); + expect(result).not.toBeNull(); + expect(result!.type).toBe("strikethrough"); + expect(result!.page).toBe(2); + }); + + it("imports an unsupported subtype as 'imported' (placement only)", () => { + // annotationType 15 = Ink, not in PDFJS_TYPE_MAP. We keep it as a + // placement-only "imported" record so it's listed in the panel and + // rendered from annotationCanvasMap instead of being dropped. + const ann = { + annotationType: 15, + subtype: "Ink", + id: "200R", + rect: [100, 200, 180, 260], + }; + const result = importPdfjsAnnotation(ann, 3, 0); + expect(result).not.toBeNull(); + expect(result!.type).toBe("imported"); + expect(result!.page).toBe(3); + expect((result as any).pdfjsId).toBe("200R"); + expect((result as any).subtype).toBe("Ink"); + expect((result as any).width).toBeCloseTo(80); + expect((result as any).height).toBeCloseTo(60); + }); + + it("imports an appearance-stream stamp as 'imported' (not text-label)", () => { + // A Stamp with hasAppearance carries a custom visual (e.g. an image + // signature) that our text-label StampAnnotation can't reproduce. + const ann = { + annotationType: 13, + subtype: "Stamp", + id: "118R", + rect: [420, 760, 514, 792], + hasAppearance: true, + contentsObj: { str: "DRAFT" }, + }; + const result = importPdfjsAnnotation(ann, 1, 0); + expect(result!.type).toBe("imported"); + expect((result as any).pdfjsId).toBe("118R"); + expect((result as any).subtype).toBe("Stamp"); + }); + + it("computeDiff: 'imported' present in both baseline and current β†’ no diff", () => { + const imp: PdfAnnotationDef = { + type: "imported", + id: "pdf-118R", + page: 1, + x: 420, + y: 760, + width: 94, + height: 32, + pdfjsId: "118R", + subtype: "Stamp", + }; + const diff = computeDiff([imp], [imp], new Map()); + expect(diff.added).toHaveLength(0); + expect(diff.removed).toHaveLength(0); + }); + + it("computeDiff: deleting an 'imported' annotation lists it in removed", () => { + const imp: PdfAnnotationDef = { + type: "imported", + id: "pdf-118R", + page: 1, + x: 420, + y: 760, + width: 94, + height: 32, + pdfjsId: "118R", + subtype: "Stamp", + }; + const diff = computeDiff([imp], [], new Map()); + expect(diff.removed).toEqual(["pdf-118R"]); + }); + + it("imports a note (Text) annotation", () => { + const ann = { + annotationType: 1, + ref: { num: 10, gen: 0 }, + rect: [100, 400, 124, 424], + contentsObj: { str: "Remember this" }, + color: new Uint8ClampedArray([245, 166, 35]), + }; + const result = importPdfjsAnnotation(ann, 1, 0); + expect(result).not.toBeNull(); + expect(result!.type).toBe("note"); + expect(result!.id).toBe("pdf-10-0"); + const note = result as any; + expect(note.x).toBe(100); + expect(note.y).toBe(424); // y + height + expect(note.content).toBe("Remember this"); + }); + + it("imports a rectangle (Square) annotation", () => { + const ann = { + annotationType: 5, + ref: { num: 12, gen: 0 }, + rect: [50, 300, 250, 400], + color: new Uint8ClampedArray([0, 102, 204]), + }; + const result = importPdfjsAnnotation(ann, 1, 0); + expect(result).not.toBeNull(); + expect(result!.type).toBe("rectangle"); + const rect = result as any; + expect(rect.x).toBe(50); + expect(rect.y).toBe(300); + expect(rect.width).toBe(200); + expect(rect.height).toBe(100); + }); + + it("imports a freetext annotation", () => { + const ann = { + annotationType: 3, + ref: { num: 15, gen: 0 }, + rect: [100, 500, 300, 520], + contentsObj: { str: "Hello World" }, + color: new Uint8ClampedArray([51, 51, 51]), + fontSize: 14, + }; + const result = importPdfjsAnnotation(ann, 1, 0); + expect(result).not.toBeNull(); + expect(result!.type).toBe("freetext"); + const ft = result as any; + expect(ft.content).toBe("Hello World"); + expect(ft.fontSize).toBe(14); + }); + + it("imports a stamp annotation", () => { + const ann = { + annotationType: 13, + ref: { num: 20, gen: 0 }, + rect: [200, 600, 350, 640], + name: "APPROVED", + color: new Uint8ClampedArray([204, 0, 0]), + }; + const result = importPdfjsAnnotation(ann, 1, 0); + expect(result).not.toBeNull(); + expect(result!.type).toBe("stamp"); + expect((result as any).label).toBe("APPROVED"); + }); + + it("returns null for unsupported types (LINK=2)", () => { + const ann = { + annotationType: 2, + ref: { num: 30, gen: 0 }, + rect: [0, 0, 100, 20], + }; + expect(importPdfjsAnnotation(ann, 1, 0)).toBeNull(); + }); + + it("returns null for form widgets (type 20)", () => { + const ann = { + annotationType: 20, + ref: { num: 31, gen: 0 }, + rect: [0, 0, 100, 20], + }; + expect(importPdfjsAnnotation(ann, 1, 0)).toBeNull(); + }); + + it("generates fallback ID when ref is missing", () => { + const ann = { + annotationType: 1, + rect: [100, 400, 124, 424], + contentsObj: { str: "No ref" }, + }; + const result = importPdfjsAnnotation(ann, 3, 7); + expect(result).not.toBeNull(); + expect(result!.id).toBe("pdf-3-7"); + }); + + it("uses ann.id when ref is missing but id exists", () => { + const ann = { + annotationType: 1, + id: "custom-id", + rect: [100, 400, 124, 424], + contentsObj: { str: "With id" }, + }; + const result = importPdfjsAnnotation(ann, 1, 0); + expect(result).not.toBeNull(); + expect(result!.id).toBe("pdf-custom-id"); + }); + + it("handles null color gracefully", () => { + const ann = { + annotationType: 5, + ref: { num: 40, gen: 0 }, + rect: [50, 300, 250, 400], + color: null, + }; + const result = importPdfjsAnnotation(ann, 1, 0); + expect(result).not.toBeNull(); + expect((result as any).color).toBeUndefined(); + }); + + it("handles highlight without quadPoints (uses rect)", () => { + const ann = { + annotationType: 9, + ref: { num: 50, gen: 0 }, + rect: [72, 700, 272, 712], + color: new Uint8ClampedArray([255, 255, 0]), + }; + const result = importPdfjsAnnotation(ann, 1, 0); + expect(result).not.toBeNull(); + expect(result!.type).toBe("highlight"); + expect((result as any).rects).toHaveLength(1); + expect((result as any).rects[0]).toEqual({ + x: 72, + y: 700, + width: 200, + height: 12, + }); + }); +}); + +// ============================================================================= +// Base64 Helpers +// ============================================================================= + +describe("base64 helpers", () => { + it("round-trips uint8array through base64", () => { + const original = new Uint8Array([0, 1, 2, 255, 128, 64]); + const base64 = uint8ArrayToBase64(original); + const restored = base64ToUint8Array(base64); + expect(restored).toEqual(original); + }); + + it("handles empty array", () => { + const empty = new Uint8Array(0); + const base64 = uint8ArrayToBase64(empty); + expect(base64).toBe(""); + expect(base64ToUint8Array(base64)).toEqual(empty); + }); + + it("produces valid base64", () => { + const data = new Uint8Array([72, 101, 108, 108, 111]); // "Hello" + const base64 = uint8ArrayToBase64(data); + expect(base64).toBe("SGVsbG8="); + }); +}); + +// ============================================================================= +// PDF Annotation Dict Creation (integration test with pdf-lib) +// ============================================================================= + +describe("parseAnnotationRef", () => { + it("parses pdf-- ids", () => { + expect(parseAnnotationRef("pdf-118-0")).toEqual({ + objectNumber: 118, + generationNumber: 0, + }); + expect(parseAnnotationRef("pdf-5-2")).toEqual({ + objectNumber: 5, + generationNumber: 2, + }); + }); + it("parses pdf-R ids (pdf.js string id, gen=0)", () => { + expect(parseAnnotationRef("pdf-118R")).toEqual({ + objectNumber: 118, + generationNumber: 0, + }); + }); + it("returns null for page-index fallback ids", () => { + expect(parseAnnotationRef("pdf-1-idx-3")).toBeNull(); + expect(parseAnnotationRef("user-abc")).toBeNull(); + }); +}); + +describe("buildAnnotatedPdfBytes", () => { + let blankPdfBytes: Uint8Array; + + // Create a minimal blank PDF for testing + beforeAll(async () => { + const doc = await PDFDocument.create(); + doc.addPage([612, 792]); // US Letter + blankPdfBytes = await doc.save(); + }); + + it("returns valid PDF bytes for empty annotations", async () => { + const result = await buildAnnotatedPdfBytes(blankPdfBytes, [], new Map()); + expect(result).toBeInstanceOf(Uint8Array); + expect(result.length).toBeGreaterThan(0); + + // Verify it's a valid PDF (starts with %PDF) + const header = String.fromCharCode(...result.slice(0, 5)); + expect(header).toBe("%PDF-"); + }); + + it("strips removedRefs entries from each page's /Annots array", async () => { + // Seed: add two highlights, save, capture their object refs. + const seeded = await buildAnnotatedPdfBytes( + blankPdfBytes, + [ + { + type: "highlight", + id: "h1", + page: 1, + rects: [{ x: 72, y: 700, width: 100, height: 12 }], + color: "#ffff00", + }, + { + type: "highlight", + id: "h2", + page: 1, + rects: [{ x: 72, y: 680, width: 100, height: 12 }], + color: "#ffff00", + }, + ], + new Map(), + ); + const seededDoc = await PDFDocument.load(seeded); + const annots = seededDoc.getPage(0).node.Annots()!; + expect(annots.size()).toBe(2); + const ref0 = annots.get(0) as unknown as { + objectNumber: number; + generationNumber: number; + }; + + // Now remove the first one by ref. + const stripped = await buildAnnotatedPdfBytes(seeded, [], new Map(), [ + { + objectNumber: ref0.objectNumber, + generationNumber: ref0.generationNumber, + }, + ]); + const strippedDoc = await PDFDocument.load(stripped); + const remaining = strippedDoc.getPage(0).node.Annots(); + expect(remaining?.size() ?? 0).toBe(1); + }); + + it("removedRefs ignores refs not present in /Annots", async () => { + const out = await buildAnnotatedPdfBytes(blankPdfBytes, [], new Map(), [ + { objectNumber: 9999, generationNumber: 0 }, + ]); + const doc = await PDFDocument.load(out); + expect(doc.getPage(0).node.Annots()?.size() ?? 0).toBe(0); + }); + + it("adds highlight annotation to PDF", async () => { + const annotations: PdfAnnotationDef[] = [ + { + type: "highlight", + id: "h1", + page: 1, + rects: [{ x: 72, y: 700, width: 200, height: 12 }], + color: "#ffff00", + content: "Important text", + }, + ]; + + const result = await buildAnnotatedPdfBytes( + blankPdfBytes, + annotations, + new Map(), + ); + + // Load result and check annotations exist + const doc = await PDFDocument.load(result); + const page = doc.getPages()[0]; + const annots = page.node.Annots(); + expect(annots).toBeDefined(); + expect(annots!.size()).toBeGreaterThanOrEqual(1); + }); + + it("adds note annotation to PDF", async () => { + const annotations: PdfAnnotationDef[] = [ + { + type: "note", + id: "n1", + page: 1, + x: 100, + y: 500, + content: "This is a note", + color: "#f5a623", + }, + ]; + + const result = await buildAnnotatedPdfBytes( + blankPdfBytes, + annotations, + new Map(), + ); + const doc = await PDFDocument.load(result); + const page = doc.getPages()[0]; + const annots = page.node.Annots(); + expect(annots).toBeDefined(); + expect(annots!.size()).toBeGreaterThanOrEqual(1); + }); + + it("adds rectangle annotation to PDF", async () => { + const annotations: PdfAnnotationDef[] = [ + { + type: "rectangle", + id: "r1", + page: 1, + x: 50, + y: 300, + width: 200, + height: 100, + color: "#0066cc", + fillColor: "#e0e8ff", + }, + ]; + + const result = await buildAnnotatedPdfBytes( + blankPdfBytes, + annotations, + new Map(), + ); + const doc = await PDFDocument.load(result); + const page = doc.getPages()[0]; + const annots = page.node.Annots(); + expect(annots).toBeDefined(); + }); + + it("saves rectangle stroke and fill colors in PDF dict", async () => { + const annotations: PdfAnnotationDef[] = [ + { + type: "rectangle", + id: "r1", + page: 1, + x: 50, + y: 300, + width: 200, + height: 100, + color: "#ff0000", + fillColor: "#00ff00", + }, + ]; + + const result = await buildAnnotatedPdfBytes( + blankPdfBytes, + annotations, + new Map(), + ); + const doc = await PDFDocument.load(result); + const page = doc.getPages()[0]; + const annots = page.node.Annots()!; + const annotRef = annots.get(annots.size() - 1); + const annotDict = doc.context.lookup(annotRef) as PDFDict; + + // Check /C (stroke color) = [1, 0, 0] for #ff0000 + const cArr = annotDict.get(PDFName.of("C")) as PDFArray; + expect(cArr).toBeDefined(); + expect((cArr.get(0) as PDFNumber).asNumber()).toBe(1); // r + expect((cArr.get(1) as PDFNumber).asNumber()).toBe(0); // g + expect((cArr.get(2) as PDFNumber).asNumber()).toBe(0); // b + + // Check /IC (fill color) = [0, 1, 0] for #00ff00 + const icArr = annotDict.get(PDFName.of("IC")) as PDFArray; + expect(icArr).toBeDefined(); + expect((icArr.get(0) as PDFNumber).asNumber()).toBe(0); // r + expect((icArr.get(1) as PDFNumber).asNumber()).toBe(1); // g + expect((icArr.get(2) as PDFNumber).asNumber()).toBe(0); // b + }); + + it("adds freetext annotation to PDF", async () => { + const annotations: PdfAnnotationDef[] = [ + { + type: "freetext", + id: "ft1", + page: 1, + x: 72, + y: 600, + content: "Hello World", + fontSize: 16, + color: "#333333", + }, + ]; + + const result = await buildAnnotatedPdfBytes( + blankPdfBytes, + annotations, + new Map(), + ); + const doc = await PDFDocument.load(result); + const annots = doc.getPages()[0].node.Annots(); + expect(annots).toBeDefined(); + }); + + it("adds stamp annotation with appearance stream", async () => { + const annotations: PdfAnnotationDef[] = [ + { + type: "stamp", + id: "s1", + page: 1, + x: 200, + y: 400, + label: "DRAFT", + color: "#cc0000", + }, + ]; + + const result = await buildAnnotatedPdfBytes( + blankPdfBytes, + annotations, + new Map(), + ); + const doc = await PDFDocument.load(result); + const annots = doc.getPages()[0].node.Annots(); + expect(annots).toBeDefined(); + }); + + it("saves stamp color in both /C and appearance stream", async () => { + const annotations: PdfAnnotationDef[] = [ + { + type: "stamp", + id: "s1", + page: 1, + x: 200, + y: 400, + label: "OK", + color: "#00ff00", + }, + ]; + + const result = await buildAnnotatedPdfBytes( + blankPdfBytes, + annotations, + new Map(), + ); + const doc = await PDFDocument.load(result); + const annots = doc.getPages()[0].node.Annots()!; + const annotRef = annots.get(annots.size() - 1); + const annotDict = doc.context.lookup(annotRef) as PDFDict; + + // Check /C color + const cArr = annotDict.get(PDFName.of("C")) as PDFArray; + expect(cArr).toBeDefined(); + expect((cArr.get(0) as PDFNumber).asNumber()).toBe(0); + expect((cArr.get(1) as PDFNumber).asNumber()).toBe(1); + expect((cArr.get(2) as PDFNumber).asNumber()).toBe(0); + + // Check appearance stream exists and contains the color + const ap = annotDict.get(PDFName.of("AP")) as PDFDict; + expect(ap).toBeDefined(); + const nRef = ap.get(PDFName.of("N")); + expect(nRef).toBeDefined(); + }); + + it("saves stamp rotation via appearance stream matrix", async () => { + const annotations: PdfAnnotationDef[] = [ + { + type: "stamp", + id: "s1", + page: 1, + x: 200, + y: 400, + label: "TILTED", + color: "#cc0000", + rotation: 45, + }, + ]; + + const result = await buildAnnotatedPdfBytes( + blankPdfBytes, + annotations, + new Map(), + ); + const doc = await PDFDocument.load(result); + const annots = doc.getPages()[0].node.Annots()!; + const annotRef = annots.get(annots.size() - 1); + const annotDict = doc.context.lookup(annotRef) as PDFDict; + + // Verify the appearance stream has a /Matrix with rotation + const ap = annotDict.get(PDFName.of("AP")) as PDFDict; + expect(ap).toBeDefined(); + const nRef = ap.get(PDFName.of("N")); + const apStream = doc.context.lookup(nRef) as any; + expect(apStream).toBeDefined(); + // The stream's dict should have a Matrix entry for rotation + const streamDict = apStream.dict || apStream; + const matrix = streamDict.get(PDFName.of("Matrix")); + expect(matrix).toBeDefined(); + }); + + it("adds multiple annotations of different types", async () => { + const annotations: PdfAnnotationDef[] = [ + { + type: "highlight", + id: "h1", + page: 1, + rects: [{ x: 72, y: 700, width: 200, height: 12 }], + }, + { + type: "note", + id: "n1", + page: 1, + x: 100, + y: 500, + content: "A note", + }, + { + type: "rectangle", + id: "r1", + page: 1, + x: 50, + y: 300, + width: 100, + height: 50, + }, + { + type: "stamp", + id: "s1", + page: 1, + x: 200, + y: 400, + label: "FINAL", + }, + ]; + + const result = await buildAnnotatedPdfBytes( + blankPdfBytes, + annotations, + new Map(), + ); + const doc = await PDFDocument.load(result); + const annots = doc.getPages()[0].node.Annots(); + expect(annots).toBeDefined(); + expect(annots!.size()).toBeGreaterThanOrEqual(4); + }); + + it("skips annotations with invalid page numbers", async () => { + const annotations: PdfAnnotationDef[] = [ + { + type: "note", + id: "n1", + page: 99, // page doesn't exist + x: 100, + y: 500, + content: "Ghost note", + }, + ]; + + const result = await buildAnnotatedPdfBytes( + blankPdfBytes, + annotations, + new Map(), + ); + const doc = await PDFDocument.load(result); + const annots = doc.getPages()[0].node.Annots(); + // Should have no annotations since page 99 doesn't exist + expect(annots?.size() ?? 0).toBe(0); + }); + + it("produces a valid re-loadable PDF", async () => { + const annotations: PdfAnnotationDef[] = [ + { + type: "highlight", + id: "h1", + page: 1, + rects: [{ x: 72, y: 700, width: 200, height: 12 }], + color: "#ffff00", + }, + { + type: "stamp", + id: "s1", + page: 1, + x: 300, + y: 400, + label: "APPROVED", + }, + ]; + + const bytes = await buildAnnotatedPdfBytes( + blankPdfBytes, + annotations, + new Map(), + ); + + // Should be able to load the result again + const doc = await PDFDocument.load(bytes); + expect(doc.getPageCount()).toBe(1); + + // Should be able to save it again + const bytes2 = await doc.save(); + expect(bytes2.length).toBeGreaterThan(0); + }); + + describe("form field persistence", () => { + // One fixture with every field type we support. pdf-lib's addOptionToPage + // writes radio buttonValues as numeric index strings ("0","1","2"), which + // is the stress case β€” the viewer stores those, but .select() wants labels. + let formPdfBytes: Uint8Array; + beforeAll(async () => { + const doc = await PDFDocument.create(); + const page = doc.addPage([612, 792]); + const form = doc.getForm(); + form.createTextField("name").addToPage(page, { x: 10, y: 700 }); + form.createCheckBox("agree").addToPage(page, { x: 10, y: 660 }); + const dd = form.createDropdown("country"); + dd.addOptions(["USA", "UK", "Canada"]); + dd.addToPage(page, { x: 10, y: 620 }); + const rg = form.createRadioGroup("size"); + rg.addOptionToPage("small", page, { x: 10, y: 580 }); + rg.addOptionToPage("medium", page, { x: 50, y: 580 }); + rg.addOptionToPage("large", page, { x: 90, y: 580 }); + formPdfBytes = await doc.save(); + }); + + it("writes text, checkbox, dropdown, and radio (by label) in one pass", async () => { + const out = await buildAnnotatedPdfBytes( + formPdfBytes, + [], + new Map([ + ["name", "Alice"], + ["agree", true], + ["country", "Canada"], + ["size", "medium"], + ]), + ); + const form = (await PDFDocument.load(out)).getForm(); + expect(form.getTextField("name").getText()).toBe("Alice"); + expect(form.getCheckBox("agree").isChecked()).toBe(true); + expect(form.getDropdown("country").getSelected()).toEqual(["Canada"]); + expect(form.getRadioGroup("size").getSelected()).toBe("medium"); + }); + + it("maps numeric radio buttonValue to option label by index", async () => { + // The viewer stores what pdf.js reports as buttonValue ("2"), not the + // label. Save must translate or the radio is silently dropped. + const out = await buildAnnotatedPdfBytes( + formPdfBytes, + [], + new Map([["size", "2"]]), + ); + const form = (await PDFDocument.load(out)).getForm(); + expect(form.getRadioGroup("size").getSelected()).toBe("large"); + }); + + it("leaves radio unset when value is neither label nor valid index", async () => { + const out = await buildAnnotatedPdfBytes( + formPdfBytes, + [], + new Map([["size", "bogus"]]), + ); + const form = (await PDFDocument.load(out)).getForm(); + expect(form.getRadioGroup("size").getSelected()).toBeUndefined(); + }); + + it("skips unknown field names without throwing", async () => { + const out = await buildAnnotatedPdfBytes( + formPdfBytes, + [], + new Map([ + ["nonexistent", "x"], + ["name", "kept"], + ]), + ); + const form = (await PDFDocument.load(out)).getForm(); + expect(form.getTextField("name").getText()).toBe("kept"); + }); + + it("a field that throws on write does not abort subsequent fields", async () => { + // Regression for #577: the per-field try/catch was dropped, so the + // first throwing field bubbled to the outer catch and silently dropped + // every field after it. setText() throws when value exceeds maxLength. + const doc = await PDFDocument.create(); + const page = doc.addPage([612, 792]); + const form = doc.getForm(); + const limited = form.createTextField("limited"); + limited.setMaxLength(2); + limited.addToPage(page, { x: 10, y: 700 }); + form.createTextField("after").addToPage(page, { x: 10, y: 660 }); + const fixture = await doc.save(); + + const out = await buildAnnotatedPdfBytes( + fixture, + [], + new Map([ + ["limited", "way too long"], // throws + ["after", "kept"], + ]), + ); + + const saved = (await PDFDocument.load(out)).getForm(); + expect(saved.getTextField("after").getText()).toBe("kept"); + // The throwing field is left at whatever pdf-lib could do with it β€” + // we only assert it didn't poison "after". + }); + + it("radio misclassified as PDFCheckBox: string value selects the matching widget", async () => { + // Some PDFs (e.g. IRS/third-party forms) omit the /Ff Radio bit, so + // pdf-lib hands us a PDFCheckBox. The viewer stored pdf.js's + // buttonValue ("0"/"1"), not a boolean β€” check() would always pick + // the first widget. setButtonGroupValue writes /V + per-widget /AS + // directly so the chosen widget sticks. + const doc = await PDFDocument.create(); + const page = doc.addPage([612, 792]); + const form = doc.getForm(); + const rg = form.createRadioGroup("Gender"); + rg.addOptionToPage("Male", page, { x: 10, y: 700 }); + rg.addOptionToPage("Female", page, { x: 60, y: 700 }); + // pdf-lib's addOptionToPage writes widget on-values "0","1". Clear the + // Radio flag (bit 16) so the reloaded form classifies it as checkbox. + // eslint-disable-next-line @typescript-eslint/no-explicit-any + (rg.acroField as any).clearFlag(1 << 15); + const fixture = await doc.save(); + + // Sanity: reload sees it as PDFCheckBox now. + const reForm = (await PDFDocument.load(fixture)).getForm(); + // eslint-disable-next-line @typescript-eslint/no-explicit-any + const reField = reForm.getFieldMaybe("Gender") as any; + expect(reField?.constructor?.name).toBe("PDFCheckBox"); + + const out = await buildAnnotatedPdfBytes( + fixture, + [], + new Map([["Gender", "1"]]), + ); + + const saved = await PDFDocument.load(out); + // eslint-disable-next-line @typescript-eslint/no-explicit-any + const acro = (saved.getForm().getFieldMaybe("Gender") as any).acroField; + const v = acro.dict.get(PDFName.of("V")); + expect(v).toBeInstanceOf(PDFName); + expect((v as PDFName).decodeText()).toBe("1"); + // Second widget /AS is the on-state, first is /Off. + const widgets = acro.getWidgets(); + expect(widgets[0].getAppearanceState()?.decodeText()).toBe("Off"); + expect(widgets[1].getAppearanceState()?.decodeText()).toBe("1"); + }); + }); +}); + +// ============================================================================= +// Coordinate Conversion (model ↔ internal PDF coords) +// ============================================================================= + +describe("coordinate conversion", () => { + const PAGE_HEIGHT = 792; // US Letter + + it("round-trips a rectangle annotation", () => { + const original: PdfAnnotationDef = { + type: "rectangle", + id: "r1", + page: 1, + x: 72, + y: 50, + width: 200, + height: 30, + }; + const converted = convertFromModelCoords(original, PAGE_HEIGHT); + const restored = convertToModelCoords(converted, PAGE_HEIGHT); + expect(restored).toEqual(original); + }); + + it("round-trips a circle annotation", () => { + const original: PdfAnnotationDef = { + type: "circle", + id: "c1", + page: 1, + x: 100, + y: 200, + width: 50, + height: 50, + }; + const converted = convertFromModelCoords(original, PAGE_HEIGHT); + const restored = convertToModelCoords(converted, PAGE_HEIGHT); + expect(restored).toEqual(original); + }); + + it("round-trips a note annotation", () => { + const original: PdfAnnotationDef = { + type: "note", + id: "n1", + page: 1, + x: 100, + y: 100, + content: "Hello", + }; + const converted = convertFromModelCoords(original, PAGE_HEIGHT); + const restored = convertToModelCoords(converted, PAGE_HEIGHT); + expect(restored).toEqual(original); + }); + + it("round-trips a freetext annotation", () => { + const original: PdfAnnotationDef = { + type: "freetext", + id: "ft1", + page: 1, + x: 72, + y: 50, + content: "Test", + fontSize: 14, + }; + const converted = convertFromModelCoords(original, PAGE_HEIGHT); + const restored = convertToModelCoords(converted, PAGE_HEIGHT); + expect(restored).toEqual(original); + }); + + it("round-trips a stamp annotation", () => { + const original: PdfAnnotationDef = { + type: "stamp", + id: "s1", + page: 1, + x: 200, + y: 50, + label: "DRAFT", + }; + const converted = convertFromModelCoords(original, PAGE_HEIGHT); + const restored = convertToModelCoords(converted, PAGE_HEIGHT); + expect(restored).toEqual(original); + }); + + it("round-trips a line annotation", () => { + const original: PdfAnnotationDef = { + type: "line", + id: "l1", + page: 1, + x1: 72, + y1: 50, + x2: 540, + y2: 742, + }; + const converted = convertFromModelCoords(original, PAGE_HEIGHT); + const restored = convertToModelCoords(converted, PAGE_HEIGHT); + expect(restored).toEqual(original); + }); + + it("round-trips a highlight annotation", () => { + const original: PdfAnnotationDef = { + type: "highlight", + id: "h1", + page: 1, + rects: [ + { x: 72, y: 50, width: 200, height: 12 }, + { x: 72, y: 70, width: 150, height: 12 }, + ], + }; + const converted = convertFromModelCoords(original, PAGE_HEIGHT); + const restored = convertToModelCoords(converted, PAGE_HEIGHT); + expect(restored).toEqual(original); + }); + + it("round-trips an underline annotation", () => { + const original: PdfAnnotationDef = { + type: "underline", + id: "u1", + page: 1, + rects: [{ x: 72, y: 100, width: 200, height: 12 }], + }; + const converted = convertFromModelCoords(original, PAGE_HEIGHT); + const restored = convertToModelCoords(converted, PAGE_HEIGHT); + expect(restored).toEqual(original); + }); + + it("round-trips a strikethrough annotation", () => { + const original: PdfAnnotationDef = { + type: "strikethrough", + id: "st1", + page: 1, + rects: [{ x: 72, y: 100, width: 200, height: 12 }], + }; + const converted = convertFromModelCoords(original, PAGE_HEIGHT); + const restored = convertToModelCoords(converted, PAGE_HEIGHT); + expect(restored).toEqual(original); + }); + + it("converts rectangle y from model to PDF coords correctly", () => { + // Model: y=50 means near top of page, height=30 + // PDF: y should be near bottom of the rect in PDF coords = 792 - 50 - 30 = 712 + const model: PdfAnnotationDef = { + type: "rectangle", + id: "r1", + page: 1, + x: 72, + y: 50, + width: 200, + height: 30, + }; + const pdf = convertFromModelCoords(model, PAGE_HEIGHT); + expect(pdf.type).toBe("rectangle"); + expect((pdf as any).y).toBe(712); // 792 - 50 - 30 + expect((pdf as any).x).toBe(72); // x unchanged + }); + + it("converts note y from model to PDF coords correctly", () => { + // Model: y=100 means 100pt from top + // PDF: y = 792 - 100 = 692 + const model: PdfAnnotationDef = { + type: "note", + id: "n1", + page: 1, + x: 100, + y: 100, + content: "Test", + }; + const pdf = convertFromModelCoords(model, PAGE_HEIGHT); + expect((pdf as any).y).toBe(692); + }); + + it("converts line endpoints from model to PDF coords correctly", () => { + const model: PdfAnnotationDef = { + type: "line", + id: "l1", + page: 1, + x1: 72, + y1: 50, + x2: 540, + y2: 742, + }; + const pdf = convertFromModelCoords(model, PAGE_HEIGHT); + expect((pdf as any).y1).toBe(742); // 792 - 50 + expect((pdf as any).y2).toBe(50); // 792 - 742 + }); + + it("preserves non-coordinate fields during conversion", () => { + const original: PdfAnnotationDef = { + type: "rectangle", + id: "r1", + page: 2, + x: 72, + y: 50, + width: 200, + height: 30, + color: "#ff0000", + fillColor: "#00ff00", + rotation: 45, + }; + const converted = convertFromModelCoords(original, PAGE_HEIGHT); + expect(converted.id).toBe("r1"); + expect(converted.page).toBe(2); + expect((converted as any).color).toBe("#ff0000"); + expect((converted as any).fillColor).toBe("#00ff00"); + expect((converted as any).rotation).toBe(45); + }); + + it("round-trips an image annotation", () => { + const original: PdfAnnotationDef = { + type: "image", + id: "img1", + page: 1, + x: 72, + y: 50, + width: 200, + height: 150, + imageData: "iVBORw0KGgo=", + mimeType: "image/png", + }; + const converted = convertFromModelCoords(original, PAGE_HEIGHT); + const restored = convertToModelCoords(converted, PAGE_HEIGHT); + expect(restored).toEqual(original); + }); + + it("converts image y from model to PDF coords correctly", () => { + // Same as rectangle: y = pageHeight - y - height + const model: PdfAnnotationDef = { + type: "image", + id: "img1", + page: 1, + x: 72, + y: 50, + width: 200, + height: 100, + }; + const pdf = convertFromModelCoords(model, PAGE_HEIGHT); + expect((pdf as any).y).toBe(642); // 792 - 50 - 100 + expect((pdf as any).x).toBe(72); + }); +}); + +// ============================================================================= +// Image Annotation PDF Creation +// ============================================================================= + +describe("image annotation PDF creation", () => { + let blankPdfBytes: Uint8Array; + + beforeAll(async () => { + const doc = await PDFDocument.create(); + doc.addPage([612, 792]); + blankPdfBytes = await doc.save(); + }); + + // Create a minimal valid 1x1 PNG for testing + function createMinimalPng(): string { + // 1x1 red pixel PNG (minimal valid PNG) + const pngBytes = new Uint8Array([ + 0x89, + 0x50, + 0x4e, + 0x47, + 0x0d, + 0x0a, + 0x1a, + 0x0a, // PNG signature + 0x00, + 0x00, + 0x00, + 0x0d, + 0x49, + 0x48, + 0x44, + 0x52, // IHDR chunk + 0x00, + 0x00, + 0x00, + 0x01, + 0x00, + 0x00, + 0x00, + 0x01, // 1x1 + 0x08, + 0x02, + 0x00, + 0x00, + 0x00, + 0x90, + 0x77, + 0x53, + 0xde, // 8-bit RGB + 0x00, + 0x00, + 0x00, + 0x0c, + 0x49, + 0x44, + 0x41, + 0x54, // IDAT chunk + 0x08, + 0xd7, + 0x63, + 0xf8, + 0xcf, + 0xc0, + 0x00, + 0x00, // compressed data + 0x00, + 0x02, + 0x00, + 0x01, + 0xe2, + 0x21, + 0xbc, + 0x33, // CRC + 0x00, + 0x00, + 0x00, + 0x00, + 0x49, + 0x45, + 0x4e, + 0x44, // IEND chunk + 0xae, + 0x42, + 0x60, + 0x82, + ]); + return uint8ArrayToBase64(pngBytes); + } + + it("adds image annotation as Stamp with appearance stream", async () => { + const pngData = createMinimalPng(); + const annotations: PdfAnnotationDef[] = [ + { + type: "image", + id: "img1", + page: 1, + x: 72, + y: 300, + width: 200, + height: 150, + imageData: pngData, + mimeType: "image/png", + }, + ]; + + const result = await buildAnnotatedPdfBytes( + blankPdfBytes, + annotations, + new Map(), + ); + const doc = await PDFDocument.load(result); + const page = doc.getPages()[0]; + const annots = page.node.Annots(); + expect(annots).toBeDefined(); + expect(annots!.size()).toBeGreaterThanOrEqual(1); + + // Verify it's a Stamp subtype + const annotRef = annots!.get(annots!.size() - 1); + const annotDict = doc.context.lookup(annotRef) as PDFDict; + expect(annotDict.get(PDFName.of("Subtype"))).toEqual(PDFName.of("Stamp")); + + // Verify it has an appearance stream + const ap = annotDict.get(PDFName.of("AP")) as PDFDict; + expect(ap).toBeDefined(); + expect(ap.get(PDFName.of("N"))).toBeDefined(); + }); + + it("produces a valid re-loadable PDF with image annotation", async () => { + const pngData = createMinimalPng(); + const annotations: PdfAnnotationDef[] = [ + { + type: "image", + id: "img1", + page: 1, + x: 72, + y: 300, + width: 200, + height: 150, + imageData: pngData, + }, + ]; + + const bytes = await buildAnnotatedPdfBytes( + blankPdfBytes, + annotations, + new Map(), + ); + // Should be able to load the result again + const doc = await PDFDocument.load(bytes); + expect(doc.getPageCount()).toBe(1); + // Should be able to save it again + const bytes2 = await doc.save(); + expect(bytes2.length).toBeGreaterThan(0); + }); + + it("skips appearance stream when no imageData", async () => { + const annotations: PdfAnnotationDef[] = [ + { + type: "image", + id: "img1", + page: 1, + x: 72, + y: 300, + width: 200, + height: 150, + imageUrl: "https://example.com/image.png", + }, + ]; + + const result = await buildAnnotatedPdfBytes( + blankPdfBytes, + annotations, + new Map(), + ); + const doc = await PDFDocument.load(result); + const page = doc.getPages()[0]; + const annots = page.node.Annots(); + expect(annots).toBeDefined(); + + // No AP dict since no imageData + const annotRef = annots!.get(annots!.size() - 1); + const annotDict = doc.context.lookup(annotRef) as PDFDict; + expect(annotDict.get(PDFName.of("AP"))).toBeUndefined(); + }); +}); diff --git a/examples/pdf-server/src/pdf-annotations.ts b/examples/pdf-server/src/pdf-annotations.ts new file mode 100644 index 0000000..201fe8d --- /dev/null +++ b/examples/pdf-server/src/pdf-annotations.ts @@ -0,0 +1,1295 @@ +/** + * PDF Annotation Helpers + * + * Pure functions for annotation persistence (diff-based model), + * color conversion, and PDF annotation dict creation using pdf-lib. + * + * The diff-based model stores only changes relative to the PDF's + * native annotations: additions, removals, and modifications. + * This keeps localStorage small and preserves round-trip fidelity. + */ + +import { + PDFDocument, + PDFDict, + PDFName, + PDFArray, + PDFNumber, + PDFString, + PDFHexString, + StandardFonts, + PDFTextField, + PDFCheckBox, + PDFDropdown, + PDFOptionList, + PDFRadioGroup, + type PDFForm, +} from "@cantoo/pdf-lib"; + +// ============================================================================= +// Types +// ============================================================================= + +export interface Rect { + x: number; + y: number; + width: number; + height: number; +} + +export interface AnnotationBase { + id: string; + page: number; +} + +export interface HighlightAnnotation extends AnnotationBase { + type: "highlight"; + rects: Rect[]; + color?: string; + content?: string; +} + +export interface UnderlineAnnotation extends AnnotationBase { + type: "underline"; + rects: Rect[]; + color?: string; +} + +export interface StrikethroughAnnotation extends AnnotationBase { + type: "strikethrough"; + rects: Rect[]; + color?: string; +} + +export interface NoteAnnotation extends AnnotationBase { + type: "note"; + x: number; + y: number; + content: string; + color?: string; +} + +export interface RectangleAnnotation extends AnnotationBase { + type: "rectangle"; + x: number; + y: number; + width: number; + height: number; + color?: string; + fillColor?: string; + rotation?: number; +} + +export interface CircleAnnotation extends AnnotationBase { + type: "circle"; + x: number; + y: number; + width: number; + height: number; + color?: string; + fillColor?: string; +} + +export interface LineAnnotation extends AnnotationBase { + type: "line"; + x1: number; + y1: number; + x2: number; + y2: number; + color?: string; +} + +export interface FreetextAnnotation extends AnnotationBase { + type: "freetext"; + x: number; + y: number; + content: string; + fontSize?: number; + color?: string; +} + +export interface StampAnnotation extends AnnotationBase { + type: "stamp"; + x: number; + y: number; + label: string; + color?: string; + rotation?: number; +} + +export interface ImageAnnotation extends AnnotationBase { + type: "image"; + x: number; + y: number; + width: number; + height: number; + imageData?: string; + imageUrl?: string; + mimeType?: string; + rotation?: number; + aspect?: "preserve" | "ignore"; +} + +/** + * An annotation that already exists in the loaded PDF and that we render + * verbatim from its appearance stream (via pdf.js's annotationCanvasMap) + * rather than re-modeling it with one of our shape types. + * + * Covers two cases: + * - subtypes we don't model (Ink, Polygon, Caret, FileAttachment, …) + * - subtypes we *could* model but whose appearance carries information + * our model would drop (e.g. Stamp with an image signature) + * + * The rasterized canvas is supplied at render time by mcp-app.ts; this + * struct only carries placement and identity. Coords are PDF user-space + * (origin bottom-left), matching the other rect-shaped types. + */ +export interface ImportedAnnotation extends AnnotationBase { + type: "imported"; + x: number; + y: number; + width: number; + height: number; + /** pdf.js getAnnotations() id (e.g. "118R") β€” key into annotationCanvasMap. */ + pdfjsId: string; + /** Original PDF /Subtype (e.g. "Stamp", "Ink") for the panel label. */ + subtype: string; +} + +export type PdfAnnotationDef = + | HighlightAnnotation + | UnderlineAnnotation + | StrikethroughAnnotation + | NoteAnnotation + | RectangleAnnotation + | CircleAnnotation + | LineAnnotation + | FreetextAnnotation + | StampAnnotation + | ImageAnnotation + | ImportedAnnotation; + +// ============================================================================= +// Coordinate Conversion (model ↔ internal PDF coords) +// ============================================================================= + +/** + * Convert annotation coordinates from model space (top-left origin, Y↓) + * to internal PDF space (bottom-left origin, Y↑). + * + * Call this when receiving coordinates from the model via add/update_annotations. + */ +export function convertFromModelCoords( + def: PdfAnnotationDef, + pageHeight: number, +): PdfAnnotationDef { + switch (def.type) { + case "highlight": + case "underline": + case "strikethrough": + return { + ...def, + rects: def.rects.map((r) => ({ + ...r, + y: pageHeight - r.y - r.height, + })), + }; + case "note": + case "freetext": + case "stamp": + return { ...def, y: pageHeight - def.y }; + case "rectangle": + case "circle": + case "image": + case "imported": + return { ...def, y: pageHeight - def.y - def.height }; + case "line": + return { + ...def, + y1: pageHeight - def.y1, + y2: pageHeight - def.y2, + }; + } +} + +/** + * Convert annotation coordinates from internal PDF space (bottom-left origin, Y↑) + * to model space (top-left origin, Y↓). + * + * Call this when presenting coordinates to the model (e.g. in context strings). + */ +export function convertToModelCoords( + def: PdfAnnotationDef, + pageHeight: number, +): PdfAnnotationDef { + // The conversion is its own inverse (same formula flips both ways) + return convertFromModelCoords(def, pageHeight); +} + +// ============================================================================= +// Diff-Based Persistence Model +// ============================================================================= + +/** + * Represents changes relative to the PDF's native annotations. + * Only this diff is stored in localStorage, keeping it small. + */ +export interface AnnotationDiff { + /** Annotations created by the user (not in the original PDF) */ + added: PdfAnnotationDef[]; + /** PDF annotation ref strings that the user deleted */ + removed: string[]; + /** Form field values the user filled in */ + formFields: Record; +} + +/** Create an empty diff */ +export function emptyDiff(): AnnotationDiff { + return { added: [], removed: [], formFields: {} }; +} + +/** Check if a diff has any changes */ +export function isDiffEmpty(diff: AnnotationDiff): boolean { + return ( + diff.added.length === 0 && + diff.removed.length === 0 && + Object.keys(diff.formFields).length === 0 + ); +} + +/** Serialize diff to JSON string for localStorage */ +export function serializeDiff(diff: AnnotationDiff): string { + return JSON.stringify(diff); +} + +/** Deserialize diff from JSON string. Returns empty diff on error. */ +export function deserializeDiff(json: string): AnnotationDiff { + try { + const parsed = JSON.parse(json); + return { + added: Array.isArray(parsed.added) ? parsed.added : [], + removed: Array.isArray(parsed.removed) ? parsed.removed : [], + formFields: + parsed.formFields && typeof parsed.formFields === "object" + ? parsed.formFields + : {}, + }; + } catch { + return emptyDiff(); + } +} + +/** + * Merge PDF-native annotations with user diff to produce the final annotation set. + * + * @param pdfAnnotations - Annotations imported from the PDF file + * @param diff - User's local changes (additions, removals) + * @returns Merged annotation list + */ +export function mergeAnnotations( + pdfAnnotations: PdfAnnotationDef[], + diff: AnnotationDiff, +): PdfAnnotationDef[] { + const removedSet = new Set(diff.removed); + + // Start with PDF annotations, filtering out removed ones + const merged = pdfAnnotations.filter((a) => !removedSet.has(a.id)); + + // Add user-created annotations + // If an added annotation has the same ID as a PDF annotation, the added one wins + const addedIds = new Set(diff.added.map((a) => a.id)); + const result = merged.filter((a) => !addedIds.has(a.id)); + result.push(...diff.added); + + return result; +} + +/** + * Compute a diff given the PDF-native annotations and the current full set. + * + * @param pdfAnnotations - Original annotations from the PDF + * @param currentAnnotations - Current full annotation set (after user edits) + * @param formFields - Current form field values + * @returns The diff to persist + */ +export function computeDiff( + pdfAnnotations: PdfAnnotationDef[], + currentAnnotations: PdfAnnotationDef[], + formFields: Map, + baselineFormFields?: Map, +): AnnotationDiff { + const pdfIds = new Set(pdfAnnotations.map((a) => a.id)); + const currentIds = new Set(currentAnnotations.map((a) => a.id)); + + // Added: in current but not in PDF + const added = currentAnnotations.filter((a) => !pdfIds.has(a.id)); + + // Removed: in PDF but not in current + const removed = pdfAnnotations + .filter((a) => !currentIds.has(a.id)) + .map((a) => a.id); + + // Form fields: only values that differ from what's already in the PDF. + // Without a baseline, every filled field is a user edit (back-compat). + const formFieldsObj: Record = {}; + for (const [k, v] of formFields) { + if (baselineFormFields?.get(k) === v) continue; + formFieldsObj[k] = v; + } + // Fields present in baseline but cleared in current are also a change + if (baselineFormFields) { + for (const [k, v] of baselineFormFields) { + if (!formFields.has(k) && v !== "" && v !== false) { + formFieldsObj[k] = formFields.get(k) ?? ""; + } + } + } + + return { added, removed, formFields: formFieldsObj }; +} + +// ============================================================================= +// Color Conversion +// ============================================================================= + +/** + * Parse a CSS color string to normalized RGB values (0-1 range). + * Supports hex (#rgb, #rrggbb, #rrggbbaa) and rgb()/rgba() notation. + */ +export function cssColorToRgb( + color: string, +): { r: number; g: number; b: number } | null { + // Parse hex colors + const hex = color.match(/^#([0-9a-f]{3,8})$/i); + if (hex) { + let h = hex[1]; + if (h.length === 3) h = h[0] + h[0] + h[1] + h[1] + h[2] + h[2]; + return { + r: parseInt(h.slice(0, 2), 16) / 255, + g: parseInt(h.slice(2, 4), 16) / 255, + b: parseInt(h.slice(4, 6), 16) / 255, + }; + } + // Parse rgb/rgba + const rgbMatch = color.match(/rgba?\(\s*(\d+)\s*,\s*(\d+)\s*,\s*(\d+)/); + if (rgbMatch) { + return { + r: parseInt(rgbMatch[1]) / 255, + g: parseInt(rgbMatch[2]) / 255, + b: parseInt(rgbMatch[3]) / 255, + }; + } + return null; +} + +/** Default colors for each annotation type */ +export function defaultColor(type: PdfAnnotationDef["type"]): string { + switch (type) { + case "highlight": + return "#ffff00"; + case "underline": + case "strikethrough": + return "#ff0000"; + case "note": + return "#f5a623"; + case "rectangle": + case "circle": + return "#0066cc"; + case "line": + return "#333333"; + case "freetext": + return "#333333"; + case "stamp": + return "#cc0000"; + case "image": + case "imported": + return "#00000000"; + } +} + +// ============================================================================= +// PDF Annotation Dict Creation (pdf-lib low-level API) +// ============================================================================= + +/** + * Create a PDF color array [r, g, b] from a CSS color string. + * Falls back to the default color for the annotation type. + */ +function makePdfColor( + context: PDFDocument["context"], + cssColor: string | undefined, + annotType: PdfAnnotationDef["type"], +): PDFArray { + const rgb = cssColorToRgb(cssColor || defaultColor(annotType)); + const { r, g, b } = rgb || { r: 0, g: 0, b: 0 }; + const arr = PDFArray.withContext(context); + arr.push(PDFNumber.of(r)); + arr.push(PDFNumber.of(g)); + arr.push(PDFNumber.of(b)); + return arr; +} + +/** Create a PDF /Rect array [x1, y1, x2, y2] */ +function makePdfRect( + context: PDFDocument["context"], + x: number, + y: number, + width: number, + height: number, +): PDFArray { + const arr = PDFArray.withContext(context); + arr.push(PDFNumber.of(x)); + arr.push(PDFNumber.of(y)); + arr.push(PDFNumber.of(x + width)); + arr.push(PDFNumber.of(y + height)); + return arr; +} + +/** + * Create /QuadPoints array for markup annotations (Highlight, Underline, StrikeOut). + * Each rect β†’ 8 numbers: x1,y1 (top-left), x2,y2 (top-right), x3,y3 (bottom-left), x4,y4 (bottom-right) + * PDF spec order: top-left, top-right, bottom-left, bottom-right + */ +function makeQuadPoints( + context: PDFDocument["context"], + rects: Rect[], +): PDFArray { + const arr = PDFArray.withContext(context); + for (const r of rects) { + const x1 = r.x; + const y1 = r.y; + const x2 = r.x + r.width; + const y2 = r.y + r.height; + // QuadPoints order: top-left, top-right, bottom-left, bottom-right + arr.push(PDFNumber.of(x1)); + arr.push(PDFNumber.of(y2)); // top-left + arr.push(PDFNumber.of(x2)); + arr.push(PDFNumber.of(y2)); // top-right + arr.push(PDFNumber.of(x1)); + arr.push(PDFNumber.of(y1)); // bottom-left + arr.push(PDFNumber.of(x2)); + arr.push(PDFNumber.of(y1)); // bottom-right + } + return arr; +} + +/** Compute bounding box of an array of rects */ +function boundingBox(rects: Rect[]): { + x: number; + y: number; + w: number; + h: number; +} { + if (rects.length === 0) return { x: 0, y: 0, w: 0, h: 0 }; + let minX = Infinity, + minY = Infinity, + maxX = -Infinity, + maxY = -Infinity; + for (const r of rects) { + minX = Math.min(minX, r.x); + minY = Math.min(minY, r.y); + maxX = Math.max(maxX, r.x + r.width); + maxY = Math.max(maxY, r.y + r.height); + } + return { x: minX, y: minY, w: maxX - minX, h: maxY - minY }; +} + +/** + * Detect image MIME type from magic bytes. + */ +function detectImageMimeType(bytes: Uint8Array): "image/png" | "image/jpeg" { + // PNG magic: 0x89 0x50 0x4E 0x47 + if ( + bytes[0] === 0x89 && + bytes[1] === 0x50 && + bytes[2] === 0x4e && + bytes[3] === 0x47 + ) { + return "image/png"; + } + // JPEG magic: 0xFF 0xD8 + return "image/jpeg"; +} + +/** + * Add proper PDF annotation objects to a pdf-lib PDFDocument. + * Creates /Type /Annot dictionaries with correct /Subtype for each annotation type. + * These are real PDF annotations, editable in Acrobat/Preview. + */ +export async function addAnnotationDicts( + pdfDoc: PDFDocument, + annotations: PdfAnnotationDef[], +): Promise { + const context = pdfDoc.context; + const pages = pdfDoc.getPages(); + + for (const def of annotations) { + // "imported" annotations are already in the source PDF β€” never + // re-serialize them. Deletion is handled by buildAnnotatedPdfBytes' + // removedRefs strip; moving an imported annotation is still UI-only. + if (def.type === "imported") continue; + + const pageIdx = def.page - 1; + if (pageIdx < 0 || pageIdx >= pages.length) continue; + const page = pages[pageIdx]; + + const dict = PDFDict.withContext(context); + dict.set(PDFName.of("Type"), PDFName.of("Annot")); + + // Set /F (flags) = 4 (Print) so annotations print + dict.set(PDFName.of("F"), PDFNumber.of(4)); + + const color = makePdfColor( + context, + "color" in def ? def.color : undefined, + def.type, + ); + + switch (def.type) { + case "highlight": + case "underline": + case "strikethrough": { + const subtypeMap = { + highlight: "Highlight", + underline: "Underline", + strikethrough: "StrikeOut", + }; + dict.set(PDFName.of("Subtype"), PDFName.of(subtypeMap[def.type])); + + const bb = boundingBox(def.rects); + dict.set( + PDFName.of("Rect"), + makePdfRect(context, bb.x, bb.y, bb.w, bb.h), + ); + dict.set(PDFName.of("QuadPoints"), makeQuadPoints(context, def.rects)); + dict.set(PDFName.of("C"), color); + + if (def.type === "highlight" && "content" in def && def.content) { + dict.set(PDFName.of("Contents"), PDFHexString.fromText(def.content)); + } + break; + } + + case "note": { + dict.set(PDFName.of("Subtype"), PDFName.of("Text")); + // Note icon is 24x24 points + dict.set( + PDFName.of("Rect"), + makePdfRect(context, def.x, def.y - 24, 24, 24), + ); + dict.set(PDFName.of("Contents"), PDFHexString.fromText(def.content)); + dict.set(PDFName.of("C"), color); + dict.set(PDFName.of("Name"), PDFName.of("Note")); + // Open = false (collapsed by default) + dict.set(PDFName.of("Open"), context.obj(false)); + break; + } + + case "rectangle": + case "circle": { + dict.set( + PDFName.of("Subtype"), + PDFName.of(def.type === "rectangle" ? "Square" : "Circle"), + ); + dict.set( + PDFName.of("Rect"), + makePdfRect(context, def.x, def.y, def.width, def.height), + ); + dict.set(PDFName.of("C"), color); + + // Border style + const bs = PDFDict.withContext(context); + bs.set(PDFName.of("Type"), PDFName.of("Border")); + bs.set(PDFName.of("W"), PDFNumber.of(2)); + bs.set(PDFName.of("S"), PDFName.of("S")); // Solid + dict.set(PDFName.of("BS"), bs); + + if (def.fillColor) { + const fc = cssColorToRgb(def.fillColor); + if (fc) { + const icArr = PDFArray.withContext(context); + icArr.push(PDFNumber.of(fc.r)); + icArr.push(PDFNumber.of(fc.g)); + icArr.push(PDFNumber.of(fc.b)); + dict.set(PDFName.of("IC"), icArr); + } + } + break; + } + + case "line": { + dict.set(PDFName.of("Subtype"), PDFName.of("Line")); + // Rect is bounding box of the line + const lx = Math.min(def.x1, def.x2); + const ly = Math.min(def.y1, def.y2); + const lw = Math.abs(def.x2 - def.x1); + const lh = Math.abs(def.y2 - def.y1); + dict.set( + PDFName.of("Rect"), + makePdfRect(context, lx, ly, lw || 1, lh || 1), + ); + // Line endpoints + const lineArr = PDFArray.withContext(context); + lineArr.push(PDFNumber.of(def.x1)); + lineArr.push(PDFNumber.of(def.y1)); + lineArr.push(PDFNumber.of(def.x2)); + lineArr.push(PDFNumber.of(def.y2)); + dict.set(PDFName.of("L"), lineArr); + dict.set(PDFName.of("C"), color); + break; + } + + case "freetext": { + dict.set(PDFName.of("Subtype"), PDFName.of("FreeText")); + const fontSize = def.fontSize || 12; + // Estimate text dimensions + const textWidth = def.content.length * fontSize * 0.6; + const textHeight = fontSize * 1.4; + dict.set( + PDFName.of("Rect"), + makePdfRect( + context, + def.x, + def.y - textHeight, + textWidth, + textHeight, + ), + ); + dict.set(PDFName.of("Contents"), PDFHexString.fromText(def.content)); + + // Default appearance string (DA) β€” required for FreeText + const rgb = cssColorToRgb(def.color || defaultColor("freetext")); + const { r, g, b } = rgb || { r: 0, g: 0, b: 0 }; + dict.set( + PDFName.of("DA"), + PDFString.of(`${r} ${g} ${b} rg /Helv ${fontSize} Tf`), + ); + break; + } + + case "stamp": { + dict.set(PDFName.of("Subtype"), PDFName.of("Stamp")); + const fontSize = 24; + // Match CSS padding: 4px top/bottom, 12px left/right + const padX = 12; + const padY = 4; + + dict.set(PDFName.of("C"), color); + + // Use a non-standard /Name so viewers like Preview.app don't + // substitute their own built-in stamp graphic + dict.set(PDFName.of("Name"), PDFName.of("#custom")); + dict.set(PDFName.of("Contents"), PDFHexString.fromText(def.label)); + + // Create a simple appearance stream so the stamp text is visible + const font = await pdfDoc.embedFont(StandardFonts.HelveticaBold); + const actualTextWidth = font.widthOfTextAtSize(def.label, fontSize); + const apRectW = actualTextWidth + padX * 2; + const apRectH = fontSize + padY * 2; + + // Set rect to match appearance stream dimensions + dict.set( + PDFName.of("Rect"), + makePdfRect(context, def.x, def.y - apRectH, apRectW, apRectH), + ); + + // Build appearance stream content matching the CSS rendering: + // - 3pt border stroke + // - 0.6 opacity + // - text baseline positioned to visually center in the box + const rgb = cssColorToRgb(def.color || defaultColor("stamp")); + const { r, g, b } = rgb || { r: 0.8, g: 0, b: 0 }; + // Font descent β‰ˆ 20% of font size for Helvetica + const descent = fontSize * 0.2; + const textBaselineY = padY + descent; + const streamContent = [ + `/GS0 gs`, // match CSS opacity: 0.6 + `${r} ${g} ${b} RG`, // stroke color + `${r} ${g} ${b} rg`, // fill color + `3 w`, // line width (matches CSS border: 3px) + `1.5 1.5 ${apRectW - 3} ${apRectH - 3} re S`, // border rect inset by half line width + `BT`, + `/F1 ${fontSize} Tf`, + `${padX} ${textBaselineY} Td`, + `(${def.label.replace(/[()\\]/g, "\\$&")}) Tj`, + `ET`, + ].join("\n"); + + // Compute rotation matrix if specified + let rotationMatrix: number[] | undefined; + if (def.rotation) { + const rad = (def.rotation * Math.PI) / 180; + const cos = Math.cos(rad); + const sin = Math.sin(rad); + // Rotation matrix around the center of the bounding box + const cx = apRectW / 2; + const cy = apRectH / 2; + // Translate to origin, rotate, translate back: [cos sin -sin cos tx ty] + const tx = cx - cos * cx + sin * cy; + const ty = cy - sin * cx - cos * cy; + rotationMatrix = [cos, sin, -sin, cos, tx, ty]; + } + + // Create ExtGState for opacity (ca = fill opacity, CA = stroke opacity) + const gsDict = PDFDict.withContext(context); + gsDict.set(PDFName.of("Type"), PDFName.of("ExtGState")); + gsDict.set(PDFName.of("ca"), PDFNumber.of(0.6)); + gsDict.set(PDFName.of("CA"), PDFNumber.of(0.6)); + const gsRef = context.register(gsDict); + + // Build Resources dict with Font and ExtGState + const stampResDict = PDFDict.withContext(context); + const fontResDict = PDFDict.withContext(context); + fontResDict.set(PDFName.of("F1"), font.ref); + stampResDict.set(PDFName.of("Font"), fontResDict); + const gsResDict = PDFDict.withContext(context); + gsResDict.set(PDFName.of("GS0"), gsRef); + stampResDict.set(PDFName.of("ExtGState"), gsResDict); + + // Create the appearance stream + const apStream = context.flateStream(streamContent, { + Type: "XObject", + Subtype: "Form", + BBox: [0, 0, apRectW, apRectH], + ...(rotationMatrix ? { Matrix: rotationMatrix } : {}), + }); + + // Attach Resources to the stream dict + const apStreamDict = (apStream as any).dict || apStream; + apStreamDict.set(PDFName.of("Resources"), stampResDict); + + const apRef = context.register(apStream); + + // Create AP dictionary + const apDict = PDFDict.withContext(context); + apDict.set(PDFName.of("N"), apRef); + dict.set(PDFName.of("AP"), apDict); + break; + } + + case "image": { + dict.set(PDFName.of("Subtype"), PDFName.of("Stamp")); + dict.set( + PDFName.of("Rect"), + makePdfRect(context, def.x, def.y, def.width, def.height), + ); + dict.set(PDFName.of("Name"), PDFName.of("Image")); + + if (def.imageData) { + // Detect mime type from magic bytes or use provided mimeType + const imgBytes = base64ToUint8Array(def.imageData); + const mime = def.mimeType || detectImageMimeType(imgBytes); + const embeddedImage = + mime === "image/jpeg" + ? await pdfDoc.embedJpg(imgBytes) + : await pdfDoc.embedPng(imgBytes); + + const imgW = def.width; + const imgH = def.height; + + // Build appearance stream that draws the image + const streamContent = `q ${imgW} 0 0 ${imgH} 0 0 cm /Img Do Q`; + + // Compute rotation matrix if specified + let rotationMatrix: number[] | undefined; + if (def.rotation) { + const rad = (def.rotation * Math.PI) / 180; + const cos = Math.cos(rad); + const sin = Math.sin(rad); + const cx = imgW / 2; + const cy = imgH / 2; + const tx = cx - cos * cx + sin * cy; + const ty = cy - sin * cx - cos * cy; + rotationMatrix = [cos, sin, -sin, cos, tx, ty]; + } + + // Create Resources dict with XObject containing the image + const xObjDict = PDFDict.withContext(context); + xObjDict.set(PDFName.of("Img"), embeddedImage.ref); + const resDict = PDFDict.withContext(context); + resDict.set(PDFName.of("XObject"), xObjDict); + + const apStream = context.flateStream(streamContent, { + Type: "XObject", + Subtype: "Form", + BBox: [0, 0, imgW, imgH], + ...(rotationMatrix ? { Matrix: rotationMatrix } : {}), + }); + + // Attach Resources to the stream dict + const apStreamDict = (apStream as any).dict || apStream; + apStreamDict.set(PDFName.of("Resources"), resDict); + + const apRef = context.register(apStream); + + const apDict = PDFDict.withContext(context); + apDict.set(PDFName.of("N"), apRef); + dict.set(PDFName.of("AP"), apDict); + } + break; + } + } + + // Register the annotation dict and add to page + const annotRef = context.register(dict); + page.node.addAnnot(annotRef); + } +} + +/** + * Select a radio-style button group by widget on-value, bypassing pdf-lib's + * type-level guards. Used when pdf-lib classifies a radio as `PDFCheckBox` + * (PDF lacks the /Ff Radio bit) β€” `check()` would always pick the first + * widget. Mirrors `PDFAcroRadioButton.setValue` minus its `onValues` throw. + */ +function setButtonGroupValue( + field: PDFCheckBox | PDFRadioGroup, + onValue: string, +): void { + const acro = field.acroField; + const off = PDFName.of("Off"); + const widgets = acro.getWidgets(); + // Match by PDFName identity (pdf-lib interns names) β€” the viewer stored + // pdf.js's buttonValue, which IS the widget's /AP /N on-state name. + let target = onValue && onValue !== "Off" ? PDFName.of(onValue) : off; + if ( + target !== off && + !widgets.some((w: { getOnValue(): PDFName | undefined }) => { + return w.getOnValue() === target; + }) + ) { + // No widget has this on-state β€” leave as-is rather than corrupt /V. + return; + } + acro.dict.set(PDFName.of("V"), target); + for (const w of widgets) { + const on = (w as { getOnValue(): PDFName | undefined }).getOnValue(); + (w as { setAppearanceState(s: PDFName): void }).setAppearanceState( + on === target ? target : off, + ); + } +} + +/** + * Recover the PDF object reference from an annotation id assigned by + * `makeAnnotationId`. Handles both `pdf--` (from `ann.ref`) and + * `pdf-R` (from pdf.js's string `ann.id`, gen always 0). Returns null for + * page-index fallback ids β€” those have no stable ref to remove by. + */ +export function parseAnnotationRef( + id: string, +): { objectNumber: number; generationNumber: number } | null { + let m = /^pdf-(\d+)-(\d+)$/.exec(id); + if (m) return { objectNumber: +m[1], generationNumber: +m[2] }; + m = /^pdf-(\d+)R$/.exec(id); + if (m) return { objectNumber: +m[1], generationNumber: 0 }; + return null; +} + +/** + * Build annotated PDF bytes from the original document. + * Applies user annotations and form fills, removes baseline annotations the + * user deleted, returns Uint8Array of the new PDF. + */ +export async function buildAnnotatedPdfBytes( + pdfBytes: Uint8Array, + annotations: PdfAnnotationDef[], + formFields: Map, + removedRefs: { objectNumber: number; generationNumber: number }[] = [], +): Promise { + const pdfDoc = await PDFDocument.load(pdfBytes, { ignoreEncryption: true }); + + // Strip baseline annotations the user deleted. We match on object number + + // generation against each page's /Annots array entries (PDFRef). We don't + // know which page they were on, so scan every page β€” /Annots arrays are + // small and this only runs at save time. + if (removedRefs.length > 0) { + const wanted = new Set( + removedRefs.map((r) => `${r.objectNumber} ${r.generationNumber}`), + ); + for (const page of pdfDoc.getPages()) { + const annots = page.node.Annots(); + if (!annots) continue; + // Walk backwards so .remove(idx) doesn't shift unprocessed entries. + for (let i = annots.size() - 1; i >= 0; i--) { + const ref = annots.get(i) as { + objectNumber?: number; + generationNumber?: number; + }; + if ( + ref?.objectNumber !== undefined && + wanted.has(`${ref.objectNumber} ${ref.generationNumber ?? 0}`) + ) { + annots.remove(i); + } + } + } + } + + // Add proper PDF annotation objects + await addAnnotationDicts(pdfDoc, annotations); + + // Apply form fills. Dispatch on actual field type β€” getTextField(name) throws + // for dropdowns/radios, so we look up the generic field and instanceof it. + // Each field is wrapped in its own try/catch: pdf-lib can throw on + // length-constrained text, radios whose buttonValue maps to neither label + // nor index, checkboxes missing a /Yes appearance, etc. One bad field must + // not abort the rest of the loop (regressed in #577 when the inner catch + // was dropped along with the type-specific getters). + if (formFields.size > 0) { + let form: PDFForm | undefined; + try { + form = pdfDoc.getForm(); + } catch { + // No AcroForm in this PDF + } + if (form) { + for (const [name, value] of formFields) { + try { + const field = form.getFieldMaybe(name); + if (!field) continue; + + if (field instanceof PDFCheckBox) { + const widgets = field.acroField.getWidgets(); + if (typeof value === "string" && widgets.length > 1) { + // Multi-widget "checkbox" with a string value = pdf-lib + // misclassified a radio group (PDF lacks the /Ff Radio flag). + // The viewer stored pdf.js's buttonValue (the widget's on-state + // name, e.g. "0"/"1"); check()/uncheck() would hit the FIRST + // widget regardless. Write /V and per-widget /AS directly. + setButtonGroupValue(field, value); + } else { + // Single-widget (real) checkbox. Viewer normally stores boolean, + // but be liberal: any truthy non-"Off" string counts as checked. + const on = + value === true || + (typeof value === "string" && value !== "" && value !== "Off"); + if (on) field.check(); + else field.uncheck(); + } + } else if (field instanceof PDFRadioGroup) { + // The viewer stores pdf.js's buttonValue, which for PDFs with an + // /Opt array is a numeric index ("0","1","2") rather than the + // option label pdf-lib's select() expects. Try the label first, + // then fall back to indexing into getOptions(). + const opts = field.getOptions(); + const s = String(value); + if (opts.includes(s)) { + field.select(s); + } else { + const idx = Number(s); + if (Number.isInteger(idx) && idx >= 0 && idx < opts.length) { + field.select(opts[idx]); + } + // else: value is neither label nor index β€” leave unset + } + } else if (field instanceof PDFDropdown) { + // select() auto-enables edit mode for values outside getOptions(), + // so this works for both enumerated and free-text combos. + field.select(String(value)); + } else if (field instanceof PDFOptionList) { + // Viewer stores multiselect listboxes as a comma-joined string + // (pdf.js's annotationStorage value for /Ch is string|string[]; + // our Map flattens arrays). Only select + // values that are actually in the option list β€” pdf-lib throws + // on unknowns and there's no edit-mode fallback like Dropdown. + const opts = field.getOptions(); + const wanted = String(value) + .split(",") + .map((s) => s.trim()) + .filter((s) => opts.includes(s)); + if (wanted.length > 0) field.select(wanted); + else field.clear(); + } else if (field instanceof PDFTextField) { + field.setText(String(value)); + } + // PDFButton, PDFSignature: no fill_form support yet + } catch (err) { + // Skip this field; carry on with the rest. Surfacing per-field + // failures is the caller's job (see fill_form result), not save's. + console.warn(`buildAnnotatedPdfBytes: skipped field "${name}":`, err); + } + } + // Some PDFs ship widgets with no on-state appearance stream (no + // /AP/N/). pdf-lib's check()/select()/setText() set /V and /AS + // but don't synthesize the missing appearance, so other readers + // (Preview, Acrobat) show the field as if unchanged. This generates a + // default appearance for any field marked dirty above. + try { + form.updateFieldAppearances(); + } catch (err) { + console.warn("buildAnnotatedPdfBytes: updateFieldAppearances:", err); + } + } + } + + return pdfDoc.save(); +} + +// ============================================================================= +// PDF.js Annotation Import +// ============================================================================= + +/** + * PDF.js annotation type constants (from AnnotationType enum). + * We only import types we support. + */ +const PDFJS_TYPE_MAP: Record = { + 1: "note", // TEXT + 3: "freetext", // FREETEXT + 4: "line", // LINE + 5: "rectangle", // SQUARE + 6: "circle", // CIRCLE + 9: "highlight", // HIGHLIGHT + 10: "underline", // UNDERLINE + 12: "strikethrough", // STRIKEOUT + 13: "stamp", // STAMP +}; + +/** + * Convert a PDF.js annotation color array [r, g, b] (0-255) to CSS hex string. + */ +function pdfjsColorToHex( + color: Uint8ClampedArray | number[] | null | undefined, +): string | undefined { + if (!color || color.length < 3) return undefined; + const r = Math.round(color[0]); + const g = Math.round(color[1]); + const b = Math.round(color[2]); + const hex = ((r << 16) | (g << 8) | b).toString(16).padStart(6, "0"); + return `#${hex}`; +} + +/** + * Convert a PDF.js annotation rect [x1, y1, x2, y2] to our Rect format. + */ +function pdfjsRectToRect(rect: number[]): Rect { + return { + x: Math.min(rect[0], rect[2]), + y: Math.min(rect[1], rect[3]), + width: Math.abs(rect[2] - rect[0]), + height: Math.abs(rect[3] - rect[1]), + }; +} + +/** + * Build a stable annotation ID from pdf.js annotation data. + * Uses the annotation's ref (PDF object reference) if available, + * otherwise falls back to page + index. + */ +function makeAnnotationId( + // eslint-disable-next-line @typescript-eslint/no-explicit-any + ann: any, + pageNum: number, + index: number, +): string { + if (ann.ref) { + return `pdf-${ann.ref.num}-${ann.ref.gen}`; + } + if (ann.id) { + return `pdf-${ann.id}`; + } + return `pdf-${pageNum}-${index}`; +} + +/** + * Convert a single PDF.js annotation object to our PdfAnnotationDef format. + * Returns null for unsupported annotation types. + */ +// eslint-disable-next-line @typescript-eslint/no-explicit-any +export function importPdfjsAnnotation( + ann: any, + pageNum: number, + index: number, +): PdfAnnotationDef | null { + // Skip form widgets (they're handled separately by AnnotationLayer) and + // auxiliary types that aren't user-visible markup: + // 2 = Link (navigational, AnnotationLayer handles the click target) + // 16 = Popup (the speech-bubble UI for a parent annotation, not content) + if ( + ann.annotationType === 20 || + ann.annotationType === 2 || + ann.annotationType === 16 + ) { + return null; + } + + const id = makeAnnotationId(ann, pageNum, index); + const color = pdfjsColorToHex(ann.color); + const ourType = PDFJS_TYPE_MAP[ann.annotationType]; + + // Anything we don't model β€” and stamps whose visual is an appearance + // stream we can't reproduce as a text label β€” are kept as "imported": + // a placement-only record that the renderer fills with the rasterized + // appearance from pdf.js's annotationCanvasMap. This keeps Ink, Polygon, + // image-signature stamps, etc. visible AND selectable in our layer. + const importAsBitmap = !ourType || (ourType === "stamp" && ann.hasAppearance); + if (importAsBitmap) { + if (!ann.rect) return null; + const r = pdfjsRectToRect(ann.rect); + return { + type: "imported", + id, + page: pageNum, + x: r.x, + y: r.y, + width: r.width, + height: r.height, + pdfjsId: String(ann.id ?? ""), + subtype: String(ann.subtype ?? `type${ann.annotationType}`), + }; + } + + switch (ourType) { + case "highlight": + case "underline": + case "strikethrough": { + // pdf.js emits quadPoints as a FLAT Float32Array [x1,y1,...,x4,y4, …] + // (8 numbers per quad), NOT as nested arrays. Iterating it yields + // numbers, so the old `for (const qp of …) if (qp.length>=8)` never + // matched and every quad-based annotation was dropped (#506). + const rects: Rect[] = []; + const qp = ann.quadPoints as ArrayLike | undefined; + if (qp && qp.length >= 8) { + for (let i = 0; i + 8 <= qp.length; i += 8) { + const xs = [qp[i], qp[i + 2], qp[i + 4], qp[i + 6]]; + const ys = [qp[i + 1], qp[i + 3], qp[i + 5], qp[i + 7]]; + const minX = Math.min(...xs); + const minY = Math.min(...ys); + rects.push({ + x: minX, + y: minY, + width: Math.max(...xs) - minX, + height: Math.max(...ys) - minY, + }); + } + } + if (rects.length === 0 && ann.rect) { + rects.push(pdfjsRectToRect(ann.rect)); + } + if (rects.length === 0) return null; + + const base = { id, page: pageNum, rects, color }; + if (ourType === "highlight") { + return { + ...base, + type: "highlight", + content: ann.contentsObj?.str || ann.contents || undefined, + }; + } + return { ...base, type: ourType } as PdfAnnotationDef; + } + + case "note": { + if (!ann.rect) return null; + const rect = pdfjsRectToRect(ann.rect); + return { + type: "note", + id, + page: pageNum, + x: rect.x, + y: rect.y + rect.height, // PDF.js rect y is bottom; note uses top point + content: ann.contentsObj?.str || ann.contents || "", + color, + }; + } + + case "rectangle": + case "circle": { + if (!ann.rect) return null; + const rect = pdfjsRectToRect(ann.rect); + return { + type: ourType, + id, + page: pageNum, + x: rect.x, + y: rect.y, + width: rect.width, + height: rect.height, + color, + } as PdfAnnotationDef; + } + + case "line": { + // PDF.js LineAnnotation provides lineCoordinates [x1, y1, x2, y2] + if (ann.lineCoordinates && ann.lineCoordinates.length >= 4) { + return { + type: "line", + id, + page: pageNum, + x1: ann.lineCoordinates[0], + y1: ann.lineCoordinates[1], + x2: ann.lineCoordinates[2], + y2: ann.lineCoordinates[3], + color, + }; + } + if (!ann.rect) return null; + const lineRect = pdfjsRectToRect(ann.rect); + return { + type: "line", + id, + page: pageNum, + x1: lineRect.x, + y1: lineRect.y, + x2: lineRect.x + lineRect.width, + y2: lineRect.y + lineRect.height, + color, + }; + } + + case "freetext": { + if (!ann.rect) return null; + const rect = pdfjsRectToRect(ann.rect); + return { + type: "freetext", + id, + page: pageNum, + x: rect.x, + y: rect.y + rect.height, + content: ann.contentsObj?.str || ann.contents || "", + fontSize: ann.fontSize || 12, + color, + }; + } + + case "stamp": { + if (!ann.rect) return null; + const rect = pdfjsRectToRect(ann.rect); + return { + type: "stamp", + id, + page: pageNum, + x: rect.x, + y: rect.y + rect.height, + label: ann.name || ann.contentsObj?.str || ann.contents || "STAMP", + color, + }; + } + } + + return null; +} + +/** + * Convert base64 string to Uint8Array. + */ +export function base64ToUint8Array(base64: string): Uint8Array { + const binary = atob(base64); + const bytes = new Uint8Array(binary.length); + for (let i = 0; i < binary.length; i++) { + bytes[i] = binary.charCodeAt(i); + } + return bytes; +} + +/** + * Convert Uint8Array to base64 string. + */ +export function uint8ArrayToBase64(bytes: Uint8Array): string { + let binary = ""; + for (let i = 0; i < bytes.length; i++) { + binary += String.fromCharCode(bytes[i]); + } + return btoa(binary); +} diff --git a/examples/pdf-server/src/viewer-state.ts b/examples/pdf-server/src/viewer-state.ts new file mode 100644 index 0000000..0c5399b --- /dev/null +++ b/examples/pdf-server/src/viewer-state.ts @@ -0,0 +1,50 @@ +/** + * Shared mutable state between mcp-app.ts and annotation-panel.ts. + * + * Only containers (Map/Set/Array) and DOM refs live here β€” both modules + * mutate their CONTENTS, never reassign the binding. Scalars that cross + * the boundary use getter callbacks (see annotation-panel.ts PanelDeps) + * to avoid wrapping every `currentPage` read in mcp-app.ts. + */ + +import type { PdfAnnotationDef } from "./pdf-annotations.js"; + +export interface TrackedAnnotation { + def: PdfAnnotationDef; + elements: HTMLElement[]; +} + +export interface EditEntry { + type: "update" | "add" | "remove"; + id: string; + before: PdfAnnotationDef | null; + after: PdfAnnotationDef | null; +} + +// Annotation state +export const annotationMap = new Map(); +export const formFieldValues = new Map(); +/** Form field values stored in the PDF file itself (baseline for diff computation). */ +export const pdfBaselineFormValues = new Map(); + +// Selection & interaction state +export const selectedAnnotationIds = new Set(); + +// Undo/Redo +export const undoStack: EditEntry[] = []; +export const redoStack: EditEntry[] = []; + +// PDF.js form field name β†’ annotation IDs mapping (for annotationStorage) +export const fieldNameToIds = new Map(); +// PDF.js form field name β†’ page number mapping +export const fieldNameToPage = new Map(); +// PDF.js form field name β†’ human-readable label (from PDF TU / alternativeText) +export const fieldNameToLabel = new Map(); +// PDF.js form field name β†’ intrinsic order index (page, then top-to-bottom Y position) +export const fieldNameToOrder = new Map(); + +// Shared DOM refs (read by both modules) +export const searchBarEl = document.getElementById("search-bar")!; +export const formLayerEl = document.getElementById( + "form-layer", +) as HTMLDivElement; diff --git a/examples/pdf-server/tsconfig.json b/examples/pdf-server/tsconfig.json index 0501827..2fe7e62 100644 --- a/examples/pdf-server/tsconfig.json +++ b/examples/pdf-server/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "vite/client", "bun"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", diff --git a/examples/pdf-server/tsconfig.server.json b/examples/pdf-server/tsconfig.server.json index 05ddd8e..27eb28f 100644 --- a/examples/pdf-server/tsconfig.server.json +++ b/examples/pdf-server/tsconfig.server.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node"], "target": "ES2022", "lib": ["ES2022"], "module": "NodeNext", diff --git a/examples/qr-server/package.json b/examples/qr-server/package.json index 197a672..425728e 100644 --- a/examples/qr-server/package.json +++ b/examples/qr-server/package.json @@ -1,6 +1,6 @@ { "name": "@modelcontextprotocol/server-qr", - "version": "1.2.0", + "version": "2.0.0", "private": true, "scripts": { "start": "uv run server.py", @@ -8,6 +8,6 @@ "build": "echo 'No build step needed for Python server'" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0" + "@modelcontextprotocol/ext-apps": "^2.0.0" } } diff --git a/examples/qr-server/server.py b/examples/qr-server/server.py index d282d1a..c1c302e 100755 --- a/examples/qr-server/server.py +++ b/examples/qr-server/server.py @@ -26,7 +26,7 @@ VIEW_URI = "ui://qr-server/view.html" HOST = os.environ.get("HOST", "0.0.0.0") # 0.0.0.0 for Docker compatibility PORT = int(os.environ.get("PORT", "3001")) -mcp = FastMCP("QR Code Server", stateless_http=True) +mcp = FastMCP("QR Code Server", stateless_http=True, host=HOST, port=PORT) # Embedded View HTML for self-contained usage (uv run or unbundled) EMBEDDED_VIEW_HTML = """ diff --git a/examples/quickstart/main.ts b/examples/quickstart/main.ts index 06895a4..7f370a8 100644 --- a/examples/quickstart/main.ts +++ b/examples/quickstart/main.ts @@ -1,7 +1,7 @@ -import { createMcpExpressApp } from "@modelcontextprotocol/sdk/server/express.js"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; -import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { createMcpExpressApp } from "@modelcontextprotocol/express"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; +import type { McpServer } from "@modelcontextprotocol/server"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; import cors from "cors"; import type { Request, Response } from "express"; import { createServer } from "./server.js"; @@ -21,7 +21,7 @@ export async function startStreamableHTTPServer( app.all("/mcp", async (req: Request, res: Response) => { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); diff --git a/examples/quickstart/package.json b/examples/quickstart/package.json index da90115..57f8444 100644 --- a/examples/quickstart/package.json +++ b/examples/quickstart/package.json @@ -1,12 +1,12 @@ { "name": "@modelcontextprotocol/quickstart", - "version": "1.2.0", + "version": "2.0.0", "type": "module", "private": true, "description": "Quickstart MCP App Server example", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", "directory": "examples/quickstart" }, "license": "MIT", @@ -15,16 +15,19 @@ "start": "concurrently --raw \"cross-env NODE_ENV=development INPUT=mcp-app.html vite build --watch\" \"tsx watch main.ts\"" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", - "express": "^5.1.0" + "express": "^5.1.0", + "zod": "^4.2.0" }, "devDependencies": { "@types/cors": "^2.8.19", - "concurrently": "^9.2.1", "@types/express": "^5.0.0", "@types/node": "22.19.5", + "concurrently": "^9.2.1", "cross-env": "^10.1.0", "tsx": "^4.21.0", "typescript": "^5.9.3", diff --git a/examples/quickstart/server.ts b/examples/quickstart/server.ts index eb3c3b1..611d0f0 100644 --- a/examples/quickstart/server.ts +++ b/examples/quickstart/server.ts @@ -3,9 +3,10 @@ import { registerAppTool, RESOURCE_MIME_TYPE, } from "@modelcontextprotocol/ext-apps/server"; -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; +import { McpServer } from "@modelcontextprotocol/server"; import fs from "node:fs/promises"; import path from "node:path"; +import { z } from "zod"; const DIST_DIR = path.join(import.meta.dirname, "dist"); @@ -30,7 +31,7 @@ export function createServer(): McpServer { { title: "Get Time", description: "Returns the current server time.", - inputSchema: {}, + inputSchema: z.object({}), _meta: { ui: { resourceUri } }, // Links this tool to its UI resource }, async () => { diff --git a/examples/quickstart/tsconfig.json b/examples/quickstart/tsconfig.json index 6c553b5..d6a42ce 100644 --- a/examples/quickstart/tsconfig.json +++ b/examples/quickstart/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "vite/client"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", diff --git a/examples/quickstart/tsconfig.server.json b/examples/quickstart/tsconfig.server.json index 7e65f5f..72552e2 100644 --- a/examples/quickstart/tsconfig.server.json +++ b/examples/quickstart/tsconfig.server.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node"], "target": "ES2022", "lib": ["ES2022"], "module": "NodeNext", diff --git a/examples/say-server/package.json b/examples/say-server/package.json index 555de75..cc12249 100644 --- a/examples/say-server/package.json +++ b/examples/say-server/package.json @@ -1,11 +1,11 @@ { "name": "@modelcontextprotocol/server-say", - "version": "1.2.0", + "version": "2.0.0", "private": true, "description": "Streaming TTS MCP App Server with karaoke-style text highlighting", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", "directory": "examples/say-server" }, "license": "MIT", @@ -15,6 +15,6 @@ "build": "echo 'No build step needed for Python server'" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0" + "@modelcontextprotocol/ext-apps": "^2.0.0" } } diff --git a/examples/scenario-modeler-server/main.ts b/examples/scenario-modeler-server/main.ts index dbd3ab6..cc20e63 100644 --- a/examples/scenario-modeler-server/main.ts +++ b/examples/scenario-modeler-server/main.ts @@ -4,10 +4,10 @@ * Or: node dist/index.js [--stdio] */ -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; -import { createMcpExpressApp } from "@modelcontextprotocol/sdk/server/express.js"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { createMcpExpressApp } from "@modelcontextprotocol/express"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; +import type { McpServer } from "@modelcontextprotocol/server"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; import cors from "cors"; import type { Request, Response } from "express"; import { createServer } from "./server.js"; @@ -27,7 +27,7 @@ export async function startStreamableHTTPServer( app.all("/mcp", async (req: Request, res: Response) => { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); diff --git a/examples/scenario-modeler-server/package.json b/examples/scenario-modeler-server/package.json index 8584889..e6f37c0 100644 --- a/examples/scenario-modeler-server/package.json +++ b/examples/scenario-modeler-server/package.json @@ -1,11 +1,11 @@ { "name": "@modelcontextprotocol/server-scenario-modeler", - "version": "1.2.0", + "version": "2.0.0", "type": "module", "description": "Financial scenario modeling MCP App Server", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", "directory": "examples/scenario-modeler-server" }, "license": "MIT", @@ -26,14 +26,16 @@ "serve": "bun --watch main.ts" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "chart.js": "^4.4.0", "cors": "^2.8.5", "express": "^5.1.0", "react": "^19.2.0", "react-dom": "^19.2.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "devDependencies": { "@types/cors": "^2.8.19", diff --git a/examples/scenario-modeler-server/server.ts b/examples/scenario-modeler-server/server.ts index b59851c..c5fa05d 100644 --- a/examples/scenario-modeler-server/server.ts +++ b/examples/scenario-modeler-server/server.ts @@ -3,11 +3,11 @@ import { registerAppResource, registerAppTool, } from "@modelcontextprotocol/ext-apps/server"; -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import type { - CallToolResult, - ReadResourceResult, -} from "@modelcontextprotocol/sdk/types.js"; +import { + McpServer, + type CallToolResult, + type ReadResourceResult, +} from "@modelcontextprotocol/server"; import fs from "node:fs/promises"; import path from "node:path"; import { z } from "zod"; @@ -305,8 +305,8 @@ export function createServer(): McpServer { title: "Get Scenario Data", description: "Returns SaaS scenario templates and optionally computes custom projections for given inputs", - inputSchema: GetScenarioDataInputSchema.shape, - outputSchema: GetScenarioDataOutputSchema.shape, + inputSchema: GetScenarioDataInputSchema, + outputSchema: GetScenarioDataOutputSchema, _meta: { ui: { resourceUri } }, }, async (args: { diff --git a/examples/scenario-modeler-server/tsconfig.json b/examples/scenario-modeler-server/tsconfig.json index fc3c210..3ecbdad 100644 --- a/examples/scenario-modeler-server/tsconfig.json +++ b/examples/scenario-modeler-server/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "vite/client"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", diff --git a/examples/scenario-modeler-server/tsconfig.server.json b/examples/scenario-modeler-server/tsconfig.server.json index 05ddd8e..27eb28f 100644 --- a/examples/scenario-modeler-server/tsconfig.server.json +++ b/examples/scenario-modeler-server/tsconfig.server.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node"], "target": "ES2022", "lib": ["ES2022"], "module": "NodeNext", diff --git a/examples/shadertoy-server/main.ts b/examples/shadertoy-server/main.ts index ac8f6ad..7e388f0 100644 --- a/examples/shadertoy-server/main.ts +++ b/examples/shadertoy-server/main.ts @@ -4,10 +4,10 @@ * Or: node dist/index.js [--stdio] */ -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; -import { createMcpExpressApp } from "@modelcontextprotocol/sdk/server/express.js"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { createMcpExpressApp } from "@modelcontextprotocol/express"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; +import type { McpServer } from "@modelcontextprotocol/server"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; import cors from "cors"; import type { Request, Response } from "express"; import { createServer } from "./server.js"; @@ -27,7 +27,7 @@ export async function startStreamableHTTPServer( app.all("/mcp", async (req: Request, res: Response) => { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); diff --git a/examples/shadertoy-server/package.json b/examples/shadertoy-server/package.json index e6968dc..aec56c6 100644 --- a/examples/shadertoy-server/package.json +++ b/examples/shadertoy-server/package.json @@ -1,11 +1,11 @@ { "name": "@modelcontextprotocol/server-shadertoy", - "version": "1.2.0", + "version": "2.0.0", "type": "module", "description": "MCP App Server example for rendering ShaderToy-compatible GLSL shaders", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", "directory": "examples/shadertoy-server" }, "license": "MIT", @@ -24,11 +24,13 @@ "prepublishOnly": "npm run build" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "devDependencies": { "@types/cors": "^2.8.19", diff --git a/examples/shadertoy-server/server.ts b/examples/shadertoy-server/server.ts index a4bfe9e..50c27bc 100644 --- a/examples/shadertoy-server/server.ts +++ b/examples/shadertoy-server/server.ts @@ -3,11 +3,11 @@ import { registerAppTool, RESOURCE_MIME_TYPE, } from "@modelcontextprotocol/ext-apps/server"; -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import type { - CallToolResult, - ReadResourceResult, -} from "@modelcontextprotocol/sdk/types.js"; +import { + McpServer, + type CallToolResult, + type ReadResourceResult, +} from "@modelcontextprotocol/server"; import fs from "node:fs/promises"; import path from "node:path"; import { z } from "zod"; @@ -63,7 +63,9 @@ LIMITATIONS - Do NOT use: - VR features (mainVR not available) For procedural noise: - float hash(vec2 p) { return fract(sin(dot(p,vec2(127.1,311.7)))*43758.5453); }`; + float hash(vec2 p) { return fract(sin(dot(p,vec2(127.1,311.7)))*43758.5453); } + +The widget is interactive and exposes tools for updating shader source code and querying compilation status. Compilation errors are sent to model context automatically.`; const DEFAULT_FRAGMENT_SHADER = `void mainImage(out vec4 fragColor, in vec2 fragCoord) { vec2 uv = fragCoord / iResolution.xy; diff --git a/examples/shadertoy-server/src/mcp-app.css b/examples/shadertoy-server/src/mcp-app.css index 0449ea5..0d5b6f1 100644 --- a/examples/shadertoy-server/src/mcp-app.css +++ b/examples/shadertoy-server/src/mcp-app.css @@ -1,4 +1,5 @@ -html, body { +html, +body { margin: 0; width: 100%; height: 100%; @@ -23,6 +24,7 @@ html, body { width: 100%; height: 100%; display: block; + touch-action: none; } #canvas.hidden { @@ -68,7 +70,9 @@ html, body { display: none; /* Hidden by default, shown when fullscreen available */ align-items: center; justify-content: center; - transition: background 0.2s, opacity 0.2s; + transition: + background 0.2s, + opacity 0.2s; opacity: 0; /* Initially invisible, shown on View hover */ z-index: 100; } diff --git a/examples/shadertoy-server/src/mcp-app.ts b/examples/shadertoy-server/src/mcp-app.ts index 546de5a..7cbb849 100644 --- a/examples/shadertoy-server/src/mcp-app.ts +++ b/examples/shadertoy-server/src/mcp-app.ts @@ -7,6 +7,7 @@ import { applyHostStyleVariables, applyDocumentTheme, } from "@modelcontextprotocol/ext-apps"; +import { z } from "zod"; import "./global.css"; import "./mcp-app.css"; import ShaderToyLite, { @@ -39,7 +40,8 @@ const log = { // Get element references const mainEl = document.querySelector(".main") as HTMLElement; const canvas = document.getElementById("canvas") as HTMLCanvasElement; -const codePreview = document.getElementById("code-preview") as HTMLPreElement; +// TODO: code-preview streaming toggle was removed when ontoolinputpartial was +// dropped during app-tool refactor β€” element still exists in HTML, restore if needed const fullscreenBtn = document.getElementById( "fullscreen-btn", ) as HTMLButtonElement; @@ -100,6 +102,39 @@ fullscreenBtn.addEventListener("click", toggleFullscreen); // ShaderToyLite instance let shaderToy: ShaderToyLiteInstance | null = null; +// Track current shader sources +let currentShaderSources: ShaderInput = { + fragmentShader: "", +}; + +// Track compilation status +interface CompilationStatus { + success: boolean; + errors: string[]; + timestamp: number; +} +let lastCompilationStatus: CompilationStatus = { + success: true, + errors: [], + timestamp: Date.now(), +}; + +// Intercept console.error to capture shader compilation errors +const originalConsoleError = console.error.bind(console); +const capturedErrors: string[] = []; +console.error = (...args: unknown[]) => { + originalConsoleError(...args); + // Capture shader compilation errors + const message = args.map((arg) => String(arg)).join(" "); + if ( + message.includes("Shader compilation failed") || + message.includes("Program initialization failed") || + message.includes("Failed to compile") + ) { + capturedErrors.push(message); + } +}; + // Create app instance const app = new App({ name: "ShaderToy Renderer", version: "1.0.0" }); @@ -111,35 +146,18 @@ app.onteardown = async () => { return {}; }; -app.ontoolinputpartial = (params) => { - // Show code preview, hide canvas - codePreview.classList.add("visible"); - canvas.classList.add("hidden"); - const code = params.arguments?.fragmentShader; - codePreview.textContent = typeof code === "string" ? code : ""; - codePreview.scrollTop = codePreview.scrollHeight; -}; - -app.ontoolinput = (params) => { - log.info("Received shader input"); - - // Hide code preview, show canvas - codePreview.classList.remove("visible"); - canvas.classList.remove("hidden"); - - if (!isShaderInput(params.arguments)) { - log.error("Invalid tool input"); - return; - } - - const { fragmentShader, common, bufferA, bufferB, bufferC, bufferD } = - params.arguments; +// Helper function to compile shader and update status +function compileAndUpdateStatus(input: ShaderInput): void { + // Clear captured errors before compilation + capturedErrors.length = 0; // Initialize ShaderToyLite if needed if (!shaderToy) { shaderToy = new ShaderToyLite("canvas"); } + const { fragmentShader, common, bufferA, bufferB, bufferC, bufferD } = input; + // Set common code (shared across all shaders) shaderToy.setCommon(common || ""); @@ -167,6 +185,45 @@ app.ontoolinput = (params) => { }); shaderToy.play(); + + // Update compilation status + const hasErrors = capturedErrors.length > 0; + lastCompilationStatus = { + success: !hasErrors, + errors: [...capturedErrors], + timestamp: Date.now(), + }; + + // Store current sources + currentShaderSources = { ...input }; + + // Send compilation status to model context if there are errors + if (hasErrors) { + app + .updateModelContext({ + content: [ + { + type: "text", + text: `Shader compilation failed:\n${capturedErrors.join("\n")}`, + }, + ], + structuredContent: { + compilationStatus: lastCompilationStatus, + }, + }) + .catch((err) => log.error("Failed to update model context:", err)); + } +} + +app.ontoolinput = (params) => { + log.info("Received shader input"); + + if (!isShaderInput(params.arguments)) { + log.error("Invalid tool input"); + return; + } + + compileAndUpdateStatus(params.arguments); log.info("Setup complete"); }; @@ -174,6 +231,97 @@ app.onerror = log.error; app.onhostcontextchanged = handleHostContextChanged; +// Register tool: set-shader-source +app.registerTool( + "set-shader-source", + { + title: "Set Shader Source", + description: + "Update the shader source code. Compiles and runs the new shader immediately.", + inputSchema: z.object({ + fragmentShader: z + .string() + .describe("The main fragment shader source code (mainImage function)"), + common: z + .string() + .optional() + .describe("Common code shared across all shaders"), + bufferA: z + .string() + .optional() + .describe("Buffer A shader source (for multi-pass rendering)"), + bufferB: z + .string() + .optional() + .describe("Buffer B shader source (for multi-pass rendering)"), + bufferC: z + .string() + .optional() + .describe("Buffer C shader source (for multi-pass rendering)"), + bufferD: z + .string() + .optional() + .describe("Buffer D shader source (for multi-pass rendering)"), + }), + }, + async (args) => { + log.info("set-shader-source tool called"); + + compileAndUpdateStatus(args); + + const result = lastCompilationStatus.success + ? "Shader compiled and running successfully." + : `Shader compilation failed:\n${lastCompilationStatus.errors.join("\n")}`; + + return { + content: [{ type: "text" as const, text: result }], + structuredContent: { + success: lastCompilationStatus.success, + errors: lastCompilationStatus.errors, + timestamp: lastCompilationStatus.timestamp, + }, + }; + }, +); + +// Register tool: get-shader-info +app.registerTool( + "get-shader-info", + { + title: "Get Shader Info", + description: "Get the current shader source code and compilation status.", + }, + async () => { + log.info("get-shader-info tool called"); + + const hasShader = currentShaderSources.fragmentShader.length > 0; + const isPlaying = shaderToy?.isPlaying() ?? false; + + let statusText = ""; + if (!hasShader) { + statusText = "No shader loaded."; + } else if (lastCompilationStatus.success) { + statusText = `Shader is ${isPlaying ? "running" : "paused"}.`; + } else { + statusText = `Shader has compilation errors:\n${lastCompilationStatus.errors.join("\n")}`; + } + + return { + content: [ + { + type: "text" as const, + text: `${statusText}\n\nCurrent fragment shader:\n${currentShaderSources.fragmentShader || "(none)"}`, + }, + ], + structuredContent: { + sources: currentShaderSources, + compilationStatus: lastCompilationStatus, + isPlaying, + }, + }; + }, +); + // Pause/resume shader based on visibility const observer = new IntersectionObserver((entries) => { entries.forEach((entry) => { diff --git a/examples/shadertoy-server/tsconfig.json b/examples/shadertoy-server/tsconfig.json index 535267b..b028ff5 100644 --- a/examples/shadertoy-server/tsconfig.json +++ b/examples/shadertoy-server/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "vite/client"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", diff --git a/examples/shadertoy-server/tsconfig.server.json b/examples/shadertoy-server/tsconfig.server.json index 05ddd8e..27eb28f 100644 --- a/examples/shadertoy-server/tsconfig.server.json +++ b/examples/shadertoy-server/tsconfig.server.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node"], "target": "ES2022", "lib": ["ES2022"], "module": "NodeNext", diff --git a/examples/sheet-music-server/main.ts b/examples/sheet-music-server/main.ts index 8b143a7..d7bf3a0 100644 --- a/examples/sheet-music-server/main.ts +++ b/examples/sheet-music-server/main.ts @@ -4,10 +4,10 @@ * Or: node dist/index.js [--stdio] */ -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; -import { createMcpExpressApp } from "@modelcontextprotocol/sdk/server/express.js"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { createMcpExpressApp } from "@modelcontextprotocol/express"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; +import type { McpServer } from "@modelcontextprotocol/server"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; import cors from "cors"; import type { Request, Response } from "express"; import { createServer } from "./server.js"; @@ -27,7 +27,7 @@ export async function startStreamableHTTPServer( app.all("/mcp", async (req: Request, res: Response) => { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); diff --git a/examples/sheet-music-server/package.json b/examples/sheet-music-server/package.json index da7fb5d..85ca6bb 100644 --- a/examples/sheet-music-server/package.json +++ b/examples/sheet-music-server/package.json @@ -1,11 +1,11 @@ { "name": "@modelcontextprotocol/server-sheet-music", - "version": "1.2.0", + "version": "2.0.0", "type": "module", "description": "MCP App Server for rendering and playing sheet music from ABC notation", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", "directory": "examples/sheet-music-server" }, "license": "MIT", @@ -24,12 +24,14 @@ "prepublishOnly": "npm run build" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "abcjs": "^6.4.4", "cors": "^2.8.5", "express": "^5.1.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "devDependencies": { "@types/cors": "^2.8.19", diff --git a/examples/sheet-music-server/server.ts b/examples/sheet-music-server/server.ts index cfd319b..be7214a 100644 --- a/examples/sheet-music-server/server.ts +++ b/examples/sheet-music-server/server.ts @@ -1,8 +1,8 @@ -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import type { - CallToolResult, - ReadResourceResult, -} from "@modelcontextprotocol/sdk/types.js"; +import { + McpServer, + type CallToolResult, + type ReadResourceResult, +} from "@modelcontextprotocol/server"; import fs from "node:fs/promises"; import path from "node:path"; import { z } from "zod"; diff --git a/examples/sheet-music-server/tsconfig.json b/examples/sheet-music-server/tsconfig.json index 535267b..b028ff5 100644 --- a/examples/sheet-music-server/tsconfig.json +++ b/examples/sheet-music-server/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "vite/client"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", diff --git a/examples/sheet-music-server/tsconfig.server.json b/examples/sheet-music-server/tsconfig.server.json index 05ddd8e..27eb28f 100644 --- a/examples/sheet-music-server/tsconfig.server.json +++ b/examples/sheet-music-server/tsconfig.server.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node"], "target": "ES2022", "lib": ["ES2022"], "module": "NodeNext", diff --git a/examples/system-monitor-server/main.ts b/examples/system-monitor-server/main.ts index 365a560..c55c799 100644 --- a/examples/system-monitor-server/main.ts +++ b/examples/system-monitor-server/main.ts @@ -4,10 +4,10 @@ * Or: node dist/index.js [--stdio] */ -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; -import { createMcpExpressApp } from "@modelcontextprotocol/sdk/server/express.js"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; +import { createMcpExpressApp } from "@modelcontextprotocol/express"; +import type { McpServer } from "@modelcontextprotocol/server"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; import cors from "cors"; import type { Request, Response } from "express"; import { createServer } from "./server.js"; @@ -27,7 +27,7 @@ export async function startStreamableHTTPServer( app.all("/mcp", async (req: Request, res: Response) => { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); diff --git a/examples/system-monitor-server/package.json b/examples/system-monitor-server/package.json index 43df852..2dc3ef1 100644 --- a/examples/system-monitor-server/package.json +++ b/examples/system-monitor-server/package.json @@ -1,11 +1,11 @@ { "name": "@modelcontextprotocol/server-system-monitor", - "version": "1.2.0", + "version": "2.0.0", "type": "module", "description": "System monitor MCP App Server with real-time stats", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", "directory": "examples/system-monitor-server" }, "license": "MIT", @@ -26,13 +26,15 @@ "serve": "bun --watch main.ts" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "chart.js": "^4.4.0", "cors": "^2.8.5", "express": "^5.1.0", - "systeminformation": "^5.27.11", - "zod": "^4.1.13" + "systeminformation": "^5.31.6", + "zod": "^4.2.0" }, "devDependencies": { "@types/cors": "^2.8.19", diff --git a/examples/system-monitor-server/server.ts b/examples/system-monitor-server/server.ts index 8fac5f2..a17bcf6 100644 --- a/examples/system-monitor-server/server.ts +++ b/examples/system-monitor-server/server.ts @@ -3,11 +3,11 @@ import { registerAppResource, registerAppTool, } from "@modelcontextprotocol/ext-apps/server"; -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import type { - CallToolResult, - ReadResourceResult, -} from "@modelcontextprotocol/sdk/types.js"; +import { + McpServer, + type CallToolResult, + type ReadResourceResult, +} from "@modelcontextprotocol/server"; import fs from "node:fs/promises"; import os from "node:os"; import path from "node:path"; @@ -135,8 +135,8 @@ export function createServer(): McpServer { title: "Get System Info", description: "Returns system information, including hostname, platform, CPU info, and memory.", - inputSchema: {}, - outputSchema: SystemInfoSchema.shape, + inputSchema: z.object({}), + outputSchema: SystemInfoSchema, _meta: { ui: { resourceUri } }, }, (): CallToolResult => { @@ -156,8 +156,8 @@ export function createServer(): McpServer { title: "Poll System Stats", description: "Returns dynamic system metrics for polling: per-core CPU timing, memory usage, and uptime. App-only.", - inputSchema: {}, - outputSchema: PollStatsSchema.shape, + inputSchema: z.object({}), + outputSchema: PollStatsSchema, _meta: { ui: { visibility: ["app"] } }, }, async (): Promise => { diff --git a/examples/system-monitor-server/tsconfig.json b/examples/system-monitor-server/tsconfig.json index 535267b..b028ff5 100644 --- a/examples/system-monitor-server/tsconfig.json +++ b/examples/system-monitor-server/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "vite/client"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", diff --git a/examples/system-monitor-server/tsconfig.server.json b/examples/system-monitor-server/tsconfig.server.json index 05ddd8e..27eb28f 100644 --- a/examples/system-monitor-server/tsconfig.server.json +++ b/examples/system-monitor-server/tsconfig.server.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node"], "target": "ES2022", "lib": ["ES2022"], "module": "NodeNext", diff --git a/examples/threejs-server/main.ts b/examples/threejs-server/main.ts index 13a2084..ef16e26 100644 --- a/examples/threejs-server/main.ts +++ b/examples/threejs-server/main.ts @@ -4,10 +4,10 @@ * Or: node dist/index.js [--stdio] */ -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; -import { createMcpExpressApp } from "@modelcontextprotocol/sdk/server/express.js"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; +import { createMcpExpressApp } from "@modelcontextprotocol/express"; +import type { McpServer } from "@modelcontextprotocol/server"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; import cors from "cors"; import type { Request, Response } from "express"; import { createServer } from "./server.js"; @@ -27,7 +27,7 @@ export async function startStreamableHTTPServer( app.all("/mcp", async (req: Request, res: Response) => { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); diff --git a/examples/threejs-server/package.json b/examples/threejs-server/package.json index c9fa8c3..68864d9 100644 --- a/examples/threejs-server/package.json +++ b/examples/threejs-server/package.json @@ -1,11 +1,11 @@ { "name": "@modelcontextprotocol/server-threejs", - "version": "1.2.0", + "version": "2.0.0", "type": "module", "description": "Three.js 3D visualization MCP App Server", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", "directory": "examples/threejs-server" }, "license": "MIT", @@ -26,14 +26,17 @@ "serve": "bun --watch main.ts" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", "react": "^19.2.0", "react-dom": "^19.2.0", "three": "^0.181.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "devDependencies": { "@types/cors": "^2.8.19", diff --git a/examples/threejs-server/server.ts b/examples/threejs-server/server.ts index ae320df..0a13c19 100644 --- a/examples/threejs-server/server.ts +++ b/examples/threejs-server/server.ts @@ -8,8 +8,10 @@ import { registerAppResource, registerAppTool, } from "@modelcontextprotocol/ext-apps/server"; -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import type { ReadResourceResult } from "@modelcontextprotocol/sdk/types.js"; +import { + McpServer, + type ReadResourceResult, +} from "@modelcontextprotocol/server"; import fs from "node:fs/promises"; import path from "node:path"; import { z } from "zod"; @@ -161,7 +163,7 @@ export function createServer(): McpServer { title: "Show Three.js Scene", description: "Render an interactive 3D scene with custom Three.js code. Supports transparent backgrounds (alpha: true) for seamless host UI integration. Available globals: THREE, OrbitControls, EffectComposer, RenderPass, UnrealBloomPass, canvas, width, height.", - inputSchema: { + inputSchema: z.object({ code: z .string() .default(DEFAULT_THREEJS_CODE) @@ -172,7 +174,7 @@ export function createServer(): McpServer { .positive() .default(400) .describe("Height in pixels"), - }, + }), outputSchema: z.object({ success: z.boolean(), }), @@ -192,7 +194,7 @@ export function createServer(): McpServer { { title: "Learn Three.js", description: "Get documentation and examples for using the Three.js View", - inputSchema: {}, + inputSchema: z.object({}), }, async () => { return { diff --git a/examples/threejs-server/src/global.css b/examples/threejs-server/src/global.css index c969ccc..1542cec 100644 --- a/examples/threejs-server/src/global.css +++ b/examples/threejs-server/src/global.css @@ -92,6 +92,16 @@ body { opacity: 0.7; } +/* Always show button on touch devices */ +.threejs-container.touch-device .fullscreen-btn.available { + opacity: 0.7; +} + +/* In fullscreen, canvas goes edge-to-edge; only the button respects safe area */ +.threejs-container.fullscreen { + padding: 0 !important; +} + /* Fullscreen mode: swap icons and remove border radius */ .threejs-container.fullscreen .fullscreen-btn .expand-icon { display: none; diff --git a/examples/threejs-server/src/mcp-app-wrapper.tsx b/examples/threejs-server/src/mcp-app-wrapper.tsx index f9dd263..44fee0c 100644 --- a/examples/threejs-server/src/mcp-app-wrapper.tsx +++ b/examples/threejs-server/src/mcp-app-wrapper.tsx @@ -5,10 +5,11 @@ * props to the actual view component. */ import type { App, McpUiHostContext } from "@modelcontextprotocol/ext-apps"; -import { useApp, useHostStyles } from "@modelcontextprotocol/ext-apps/react"; -import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js"; -import { StrictMode, useState, useEffect } from "react"; +import { useApp } from "@modelcontextprotocol/ext-apps/react"; +import type { CallToolResult } from "@modelcontextprotocol/client"; +import { StrictMode, useState, useCallback, useEffect, useRef } from "react"; import { createRoot } from "react-dom/client"; +import { z } from "zod"; import ThreeJSApp from "./threejs-app.tsx"; import "./global.css"; @@ -16,6 +17,20 @@ import "./global.css"; // Types // ============================================================================= +/** + * Scene state tracked for view interaction tools. + */ +export interface SceneState { + /** Current Three.js code */ + code: string | null; + /** Canvas height */ + height: number; + /** Last error message if any */ + error: string | null; + /** Whether the scene is currently rendering */ + isRendering: boolean; +} + /** * Props passed to the view component. * This interface can be reused for other views. @@ -31,6 +46,105 @@ export interface ViewProps> { toolResult: CallToolResult | null; /** Host context (theme, dimensions, locale, etc.) */ hostContext: McpUiHostContext | null; + /** Call a tool on the MCP server */ + callServerTool: App["callServerTool"]; + /** Send a message to the host's chat */ + sendMessage: App["sendMessage"]; + /** Request the host to open a URL */ + openLink: App["openLink"]; + /** Send log messages to the host */ + sendLog: App["sendLog"]; + /** Callback to report scene errors */ + onSceneError: (error: string | null) => void; + /** Callback to report scene is rendering */ + onSceneRendering: (isRendering: boolean) => void; +} + +// ============================================================================= +// Widget Interaction Tools +// ============================================================================= + +/** + * Registers widget interaction tools on the App instance. + * These tools allow the model to interact with the Three.js scene. + */ +function registerWidgetTools( + app: App, + sceneStateRef: React.RefObject, + setToolInputs: (args: Record) => void, +): void { + // Tool: set-scene-source - Update the scene source/configuration + app.registerTool( + "set-scene-source", + { + title: "Set Scene Source", + description: + "Update the Three.js scene source code. The code will be executed in a sandboxed environment with access to THREE, OrbitControls, EffectComposer, RenderPass, UnrealBloomPass, canvas, width, and height.", + inputSchema: z.object({ + code: z.string().describe("JavaScript code to render the 3D scene"), + height: z + .number() + .int() + .positive() + .optional() + .describe("Height in pixels (optional, defaults to current)"), + }), + outputSchema: z.object({ + success: z.boolean(), + code: z.string(), + height: z.number(), + }), + }, + async (args) => { + sceneStateRef.current.code = args.code; + if (args.height !== undefined) { + sceneStateRef.current.height = args.height; + } + sceneStateRef.current.error = null; + setToolInputs({ code: args.code, height: sceneStateRef.current.height }); + + const result = { + success: true, + code: args.code, + height: sceneStateRef.current.height, + }; + + return { + content: [{ type: "text" as const, text: JSON.stringify(result) }], + structuredContent: result, + }; + }, + ); + + // Tool: get-scene-info - Get current scene state and any errors + app.registerTool( + "get-scene-info", + { + title: "Get Scene Info", + description: + "Get the current Three.js scene state including source code, dimensions, rendering status, and any errors.", + outputSchema: z.object({ + code: z.string().nullable(), + height: z.number(), + error: z.string().nullable(), + isRendering: z.boolean(), + }), + }, + async () => { + const state = sceneStateRef.current; + const result = { + code: state.code, + height: state.height, + error: state.error, + isRendering: state.isRendering, + }; + + return { + content: [{ type: "text" as const, text: JSON.stringify(result) }], + structuredContent: result, + }; + }, + ); } // ============================================================================= @@ -48,14 +162,38 @@ function McpAppWrapper() { const [toolResult, setToolResult] = useState(null); const [hostContext, setHostContext] = useState(null); + // Scene state for widget interaction tools + const sceneStateRef = useRef({ + code: null, + height: 400, + error: null, + isRendering: false, + }); + + // Reference to app for tools to access updateModelContext + const appRef = useRef(null); + const { app, error } = useApp({ appInfo: { name: "Three.js View", version: "1.0.0" }, - capabilities: {}, + capabilities: { tools: {} }, onAppCreated: (app) => { + appRef.current = app; + + // Register widget interaction tools before connect() + registerWidgetTools(app, sceneStateRef, setToolInputs); + // Complete tool input (streaming finished) app.ontoolinput = (params) => { - setToolInputs(params.arguments as Record); + const args = params.arguments as Record; + setToolInputs(args); setToolInputsPartial(null); + // Update scene state from tool input + if (typeof args.code === "string") { + sceneStateRef.current.code = args.code; + } + if (typeof args.height === "number") { + sceneStateRef.current.height = args.height; + } }; // Partial tool input (streaming in progress) app.ontoolinputpartial = (params) => { @@ -66,14 +204,39 @@ function McpAppWrapper() { setToolResult(params as CallToolResult); }; // Host context changes (theme, dimensions, etc.) + // Note: we handle styles here instead of using useHostStyles, + // because useHostStyles overwrites onhostcontextchanged. app.onhostcontextchanged = (params) => { + const root = document.documentElement; + if (params.theme) { + root.setAttribute("data-theme", params.theme); + root.style.colorScheme = params.theme; + } + if (params.styles?.variables) { + for (const [k, v] of Object.entries(params.styles.variables)) { + if (v !== undefined) root.style.setProperty(k, v as string); + } + } setHostContext((prev) => ({ ...prev, ...params })); }; }, }); - // Apply host styling (theme, CSS variables, fonts) - useHostStyles(app); + // Apply initial host styles + useEffect(() => { + if (!app) return; + const ctx = app.getHostContext(); + const root = document.documentElement; + if (ctx?.theme) { + root.setAttribute("data-theme", ctx.theme); + root.style.colorScheme = ctx.theme; + } + if (ctx?.styles?.variables) { + for (const [k, v] of Object.entries(ctx.styles.variables)) { + if (v !== undefined) root.style.setProperty(k, v as string); + } + } + }, [app]); // Get initial host context after connection useEffect(() => { @@ -85,6 +248,53 @@ function McpAppWrapper() { } }, [app]); + // Memoized callbacks that forward to app methods + const callServerTool = useCallback( + (params, options) => app!.callServerTool(params, options), + [app], + ); + const sendMessage = useCallback( + (params, options) => app!.sendMessage(params, options), + [app], + ); + const openLink = useCallback( + (params, options) => app!.openLink(params, options), + [app], + ); + const sendLog = useCallback( + (params) => app!.sendLog(params), + [app], + ); + + // Callback for scene to report errors + const onSceneError = useCallback((sceneError: string | null) => { + sceneStateRef.current.error = sceneError; + + // Send errors to model context for awareness + if (sceneError && appRef.current) { + void appRef.current + .updateModelContext({ + content: [ + { + type: "text" as const, + text: `Three.js Scene Error: ${sceneError}`, + }, + ], + structuredContent: { + type: "scene_error", + error: sceneError, + timestamp: new Date().toISOString(), + }, + }) + .catch(() => {}); + } + }, []); + + // Callback for scene to report rendering state + const onSceneRendering = useCallback((isRendering: boolean) => { + sceneStateRef.current.isRendering = isRendering; + }, []); + if (error) { return
Error: {error.message}
; } @@ -100,6 +310,12 @@ function McpAppWrapper() { toolInputsPartial={toolInputsPartial} toolResult={toolResult} hostContext={hostContext} + callServerTool={callServerTool} + sendMessage={sendMessage} + openLink={openLink} + sendLog={sendLog} + onSceneError={onSceneError} + onSceneRendering={onSceneRendering} /> ); } diff --git a/examples/threejs-server/src/threejs-app.tsx b/examples/threejs-server/src/threejs-app.tsx index 2359316..966bd64 100644 --- a/examples/threejs-server/src/threejs-app.tsx +++ b/examples/threejs-server/src/threejs-app.tsx @@ -85,6 +85,7 @@ function LoadingShimmer({ height, code }: { height: number; code?: string }) { display: "flex", flexDirection: "column", overflow: "hidden", + touchAction: "none", background: "linear-gradient(135deg, var(--color-background-secondary, light-dark(#f0f0f5, #2a2a3c)) 0%, var(--color-background-tertiary, light-dark(#e5e5ed, #1e1e2e)) 100%)", }} @@ -199,6 +200,12 @@ export default function ThreeJSApp({ toolInputs, toolInputsPartial, hostContext, + callServerTool: _callServerTool, + sendMessage: _sendMessage, + openLink: _openLink, + sendLog: _sendLog, + onSceneError, + onSceneRendering, }: ThreeJSAppProps) { const [error, setError] = useState(null); const [currentDisplayMode, setCurrentDisplayMode] = useState< @@ -226,6 +233,8 @@ export default function ThreeJSApp({ const canFullscreen = hostContext?.availableDisplayModes?.includes("fullscreen") ?? false; const isFullscreen = currentDisplayMode === "fullscreen"; + const dims = hostContext?.containerDimensions; + const hostHeight = dims && "height" in dims ? dims.height : 0; // Sync display mode from host context useEffect(() => { @@ -272,25 +281,60 @@ export default function ThreeJSApp({ return () => observer.disconnect(); }, []); + // Track container width for resize handling + const [containerWidth, setContainerWidth] = useState(0); + + useEffect(() => { + if (!containerRef.current) return; + const observer = new ResizeObserver((entries) => { + const w = Math.round(entries[0].contentRect.width); + if (w > 0) setContainerWidth(w); + }); + observer.observe(containerRef.current); + return () => observer.disconnect(); + }, []); + useEffect(() => { if (!code || !canvasRef.current || !containerRef.current) return; + // Prevent touch events from propagating to the parent scroll view. + // Three.js OrbitControls uses pointer events, which don't suppress native + // scroll gesture recognition on touch devices. + const canvas = canvasRef.current; + const preventDefault = (e: TouchEvent) => e.preventDefault(); + canvas.addEventListener("touchstart", preventDefault, { passive: false }); + canvas.addEventListener("touchmove", preventDefault, { passive: false }); + // Cleanup previous animation animControllerRef.current?.cleanup(); animControllerRef.current = createAnimationController(); setError(null); - const width = containerRef.current.offsetWidth || 800; + onSceneError(null); + onSceneRendering(true); + + const w = containerWidth || containerRef.current.offsetWidth || 800; + const h = isFullscreen && hostHeight > 0 ? hostHeight : height; executeThreeCode( code, canvasRef.current, - width, - height, + w, + h, animControllerRef.current.visibilityAwareRAF, - ).catch((e) => setError(e instanceof Error ? e.message : "Unknown error")); + ).catch((e) => { + const msg = e instanceof Error ? e.message : "Unknown error"; + setError(msg); + onSceneError(msg); + onSceneRendering(false); + }); - return () => animControllerRef.current?.cleanup(); - }, [code, height]); + return () => { + canvas.removeEventListener("touchstart", preventDefault); + canvas.removeEventListener("touchmove", preventDefault); + animControllerRef.current?.cleanup(); + onSceneRendering(false); + }; + }, [code, height, containerWidth, isFullscreen, hostHeight]); if (isStreaming || !code) { return ( @@ -303,7 +347,7 @@ export default function ThreeJSApp({ return (
0 ? hostHeight : height, + borderRadius: isFullscreen ? 0 : "var(--border-radius-lg, 8px)", display: "block", + touchAction: "none", }} /> {error &&
Error: {error}
} @@ -321,6 +366,10 @@ export default function ThreeJSApp({ className={`fullscreen-btn${canFullscreen ? " available" : ""}`} title={isFullscreen ? "Exit fullscreen" : "Toggle fullscreen"} onClick={toggleFullscreen} + style={{ + top: 10 + (safeAreaInsets?.top ?? 0), + right: 10 + (safeAreaInsets?.right ?? 0), + }} > { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); diff --git a/examples/transcript-server/package.json b/examples/transcript-server/package.json index d20fc04..46a8f98 100644 --- a/examples/transcript-server/package.json +++ b/examples/transcript-server/package.json @@ -1,11 +1,11 @@ { "name": "@modelcontextprotocol/server-transcript", - "version": "1.2.0", + "version": "2.0.0", "type": "module", "description": "MCP App Server for live speech transcription", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", "directory": "examples/transcript-server" }, "license": "MIT", @@ -24,11 +24,13 @@ "prepublishOnly": "npm run build" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "devDependencies": { "@types/cors": "^2.8.19", diff --git a/examples/transcript-server/server.ts b/examples/transcript-server/server.ts index 56bf88d..863eb29 100644 --- a/examples/transcript-server/server.ts +++ b/examples/transcript-server/server.ts @@ -1,8 +1,8 @@ -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import type { - CallToolResult, - ReadResourceResult, -} from "@modelcontextprotocol/sdk/types.js"; +import { + McpServer, + type CallToolResult, + type ReadResourceResult, +} from "@modelcontextprotocol/server"; import fs from "node:fs/promises"; import path from "node:path"; import { @@ -10,6 +10,7 @@ import { registerAppResource, RESOURCE_MIME_TYPE, } from "@modelcontextprotocol/ext-apps/server"; +import { z } from "zod"; // Works both from source (server.ts) and compiled (dist/server.js) const DIST_DIR = import.meta.filename.endsWith(".ts") ? path.join(import.meta.dirname, "dist") @@ -33,7 +34,7 @@ export function createServer(): McpServer { title: "Transcribe Speech", description: "Opens a live speech transcription interface using the Web Speech API.", - inputSchema: {}, + inputSchema: z.object({}), _meta: { ui: { resourceUri } }, }, async (): Promise => { diff --git a/examples/transcript-server/tsconfig.json b/examples/transcript-server/tsconfig.json index 535267b..00e4801 100644 --- a/examples/transcript-server/tsconfig.json +++ b/examples/transcript-server/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "vite/client", "dom-speech-recognition"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", diff --git a/examples/transcript-server/tsconfig.server.json b/examples/transcript-server/tsconfig.server.json index 05ddd8e..27eb28f 100644 --- a/examples/transcript-server/tsconfig.server.json +++ b/examples/transcript-server/tsconfig.server.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node"], "target": "ES2022", "lib": ["ES2022"], "module": "NodeNext", diff --git a/examples/video-resource-server/main.ts b/examples/video-resource-server/main.ts index 082fa5a..1983373 100644 --- a/examples/video-resource-server/main.ts +++ b/examples/video-resource-server/main.ts @@ -4,10 +4,10 @@ * Or: node dist/index.js [--stdio] */ -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; -import { createMcpExpressApp } from "@modelcontextprotocol/sdk/server/express.js"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; +import { createMcpExpressApp } from "@modelcontextprotocol/express"; +import type { McpServer } from "@modelcontextprotocol/server"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; import cors from "cors"; import type { Request, Response } from "express"; import { createServer } from "./server.js"; @@ -27,7 +27,7 @@ export async function startStreamableHTTPServer( app.all("/mcp", async (req: Request, res: Response) => { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); diff --git a/examples/video-resource-server/package.json b/examples/video-resource-server/package.json index 2027332..4a7a61f 100644 --- a/examples/video-resource-server/package.json +++ b/examples/video-resource-server/package.json @@ -1,11 +1,11 @@ { "name": "@modelcontextprotocol/server-video-resource", - "version": "1.2.0", + "version": "2.0.0", "type": "module", "description": "MCP App Server demonstrating video resources served as base64 blobs", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", "directory": "examples/video-resource-server" }, "license": "MIT", @@ -24,11 +24,14 @@ "prepublishOnly": "npm run build" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "devDependencies": { "@types/cors": "^2.8.19", diff --git a/examples/video-resource-server/server.ts b/examples/video-resource-server/server.ts index 2cb317e..8ae6240 100644 --- a/examples/video-resource-server/server.ts +++ b/examples/video-resource-server/server.ts @@ -12,11 +12,9 @@ import { import { McpServer, ResourceTemplate, -} from "@modelcontextprotocol/sdk/server/mcp.js"; -import type { - CallToolResult, - ReadResourceResult, -} from "@modelcontextprotocol/sdk/types.js"; + type CallToolResult, + type ReadResourceResult, +} from "@modelcontextprotocol/server"; import fs from "node:fs/promises"; import path from "node:path"; import { z } from "zod"; @@ -135,14 +133,14 @@ Available videos: ${Object.entries(VIDEO_LIBRARY) .map(([id, v]) => `- ${id}: ${v.description}`) .join("\n")}`, - inputSchema: { + inputSchema: z.object({ videoId: z .enum(Object.keys(VIDEO_LIBRARY) as [string, ...string[]]) .default("bunny-1mb") .describe( `Video ID to play. Available: ${Object.keys(VIDEO_LIBRARY).join(", ")}`, ), - }, + }), outputSchema: z.object({ videoUri: z.string(), description: z.string(), diff --git a/examples/video-resource-server/src/mcp-app.ts b/examples/video-resource-server/src/mcp-app.ts index 88ed913..2a3f8f9 100644 --- a/examples/video-resource-server/src/mcp-app.ts +++ b/examples/video-resource-server/src/mcp-app.ts @@ -5,7 +5,7 @@ * The video is served as a base64 blob and converted to a data URI for playback. */ import { App, type McpUiHostContext } from "@modelcontextprotocol/ext-apps"; -import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js"; +import type { CallToolResult } from "@modelcontextprotocol/client"; import "./global.css"; import "./mcp-app.css"; diff --git a/examples/video-resource-server/tsconfig.json b/examples/video-resource-server/tsconfig.json index 535267b..b028ff5 100644 --- a/examples/video-resource-server/tsconfig.json +++ b/examples/video-resource-server/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "vite/client"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", diff --git a/examples/video-resource-server/tsconfig.server.json b/examples/video-resource-server/tsconfig.server.json index 05ddd8e..27eb28f 100644 --- a/examples/video-resource-server/tsconfig.server.json +++ b/examples/video-resource-server/tsconfig.server.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node"], "target": "ES2022", "lib": ["ES2022"], "module": "NodeNext", diff --git a/examples/wiki-explorer-server/main.ts b/examples/wiki-explorer-server/main.ts index cc7b3a2..bfeeffb 100644 --- a/examples/wiki-explorer-server/main.ts +++ b/examples/wiki-explorer-server/main.ts @@ -4,10 +4,10 @@ * Or: node dist/index.js [--stdio] */ -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; -import { createMcpExpressApp } from "@modelcontextprotocol/sdk/server/express.js"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; +import { createMcpExpressApp } from "@modelcontextprotocol/express"; +import type { McpServer } from "@modelcontextprotocol/server"; +import { NodeStreamableHTTPServerTransport } from "@modelcontextprotocol/node"; import cors from "cors"; import type { Request, Response } from "express"; import { createServer } from "./server.js"; @@ -27,7 +27,7 @@ export async function startStreamableHTTPServer( app.all("/mcp", async (req: Request, res: Response) => { const server = createServer(); - const transport = new StreamableHTTPServerTransport({ + const transport = new NodeStreamableHTTPServerTransport({ sessionIdGenerator: undefined, }); diff --git a/examples/wiki-explorer-server/package.json b/examples/wiki-explorer-server/package.json index f084b00..52304cf 100644 --- a/examples/wiki-explorer-server/package.json +++ b/examples/wiki-explorer-server/package.json @@ -1,11 +1,11 @@ { "name": "@modelcontextprotocol/server-wiki-explorer", - "version": "1.2.0", + "version": "2.0.0", "type": "module", "description": "Wikipedia link explorer MCP App Server with graph visualization", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps", + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git", "directory": "examples/wiki-explorer-server" }, "license": "MIT", @@ -26,12 +26,15 @@ "serve": "bun --watch main.ts" }, "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cheerio": "^1.0.0", "cors": "^2.8.5", "express": "^5.1.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "devDependencies": { "@types/cors": "^2.8.19", diff --git a/examples/wiki-explorer-server/server.ts b/examples/wiki-explorer-server/server.ts index fe2e89b..8bc4eb7 100644 --- a/examples/wiki-explorer-server/server.ts +++ b/examples/wiki-explorer-server/server.ts @@ -3,11 +3,11 @@ import { registerAppResource, registerAppTool, } from "@modelcontextprotocol/ext-apps/server"; -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import type { - CallToolResult, - ReadResourceResult, -} from "@modelcontextprotocol/sdk/types.js"; +import { + McpServer, + type CallToolResult, + type ReadResourceResult, +} from "@modelcontextprotocol/server"; import * as cheerio from "cheerio"; import fs from "node:fs/promises"; import path from "node:path"; @@ -86,7 +86,7 @@ export function createServer(): McpServer { { title: "Get First-Degree Links", description: - "Returns all Wikipedia pages that the given page links to directly.", + "Returns all Wikipedia pages that the given page links to directly. The widget is interactive and exposes tools for exploring the graph (expanding nodes to see their links), searching for articles, and querying visible nodes.", inputSchema: z.object({ url: z .string() diff --git a/examples/wiki-explorer-server/src/mcp-app.css b/examples/wiki-explorer-server/src/mcp-app.css index 8f6f024..ea13ac2 100644 --- a/examples/wiki-explorer-server/src/mcp-app.css +++ b/examples/wiki-explorer-server/src/mcp-app.css @@ -1,6 +1,7 @@ #graph { width: 100%; height: 100vh; + touch-action: none; } #popup { diff --git a/examples/wiki-explorer-server/src/mcp-app.ts b/examples/wiki-explorer-server/src/mcp-app.ts index 7d95cb8..9833d9c 100644 --- a/examples/wiki-explorer-server/src/mcp-app.ts +++ b/examples/wiki-explorer-server/src/mcp-app.ts @@ -2,7 +2,8 @@ * Wiki Explorer - Force-directed graph visualization of Wikipedia link networks */ import { App, type McpUiHostContext } from "@modelcontextprotocol/ext-apps"; -import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js"; +import type { CallToolResult } from "@modelcontextprotocol/client"; +import { z } from "zod"; import { forceCenter, forceCollide, @@ -111,6 +112,18 @@ const graph = new ForceGraph(container) }) .graphData(graphData); +// Prevent touch events from propagating to the parent scroll view. +// force-graph uses pointer events, which don't suppress native scroll gesture +// recognition on touch devices. +const graphCanvas = container.querySelector("canvas"); +if (graphCanvas) { + for (const eventName of ["touchstart", "touchmove"] as const) { + graphCanvas.addEventListener(eventName, (e) => e.preventDefault(), { + passive: false, + }); + } +} + // Handle window resize function handleResize() { const { width, height } = container.getBoundingClientRect(); @@ -385,6 +398,346 @@ function handleHostContextChanged(ctx: McpUiHostContext) { app.onhostcontextchanged = handleHostContextChanged; +// ============================================================================= +// Widget Interaction Tools +// ============================================================================= + +// Tool: Search for a Wikipedia article and navigate to it +app.registerTool( + "search-article", + { + title: "Search Article", + description: + "Search for a Wikipedia article and add it to the graph as the new starting point", + inputSchema: z.object({ + query: z.string().describe("Search query for Wikipedia article"), + }), + }, + async (args) => { + const { query } = args as { query: string }; + + // Construct Wikipedia search URL that redirects to the article + const searchUrl = `https://en.wikipedia.org/wiki/Special:Search?go=Go&search=${encodeURIComponent(query)}`; + + // Use the server tool to fetch the article + const result = await app.callServerTool({ + name: "get-first-degree-links", + arguments: { url: searchUrl }, + }); + + const response = result.structuredContent as unknown as ToolResponse; + if (response && response.page) { + // Clear existing graph and start fresh with this article + graphData.nodes = []; + graphData.links = []; + initialUrl = response.page.url; + addNode(response.page.url, response.page.title, "default", { + x: 0, + y: 0, + }); + graph.warmupTicks(100); + handleToolResultData(result); + graph.centerAt(0, 0, 500); + + return { + content: [ + { + type: "text" as const, + text: `Navigated to article: ${response.page.title}`, + }, + ], + structuredContent: { + success: true, + article: response.page, + linksFound: response.links?.length ?? 0, + }, + }; + } + + return { + content: [ + { type: "text" as const, text: `Could not find article for: ${query}` }, + ], + structuredContent: { + success: false, + error: "Article not found", + }, + }; + }, +); + +// Tool: Get information about the currently displayed article +app.registerTool( + "get-current-article", + { + title: "Get Current Article", + description: + "Get information about the currently selected or initial article in the graph", + }, + async () => { + const currentUrl = selectedNodeUrl || initialUrl; + + if (!currentUrl) { + return { + content: [ + { type: "text" as const, text: "No article is currently selected" }, + ], + structuredContent: { + hasSelection: false, + article: null, + }, + }; + } + + const node = graphData.nodes.find((n) => n.url === currentUrl); + + if (!node) { + return { + content: [ + { + type: "text" as const, + text: "Selected article not found in graph", + }, + ], + structuredContent: { + hasSelection: false, + article: null, + }, + }; + } + + return { + content: [ + { + type: "text" as const, + text: `Current article: ${node.title}\nURL: ${node.url}\nState: ${node.state}`, + }, + ], + structuredContent: { + hasSelection: true, + article: { + url: node.url, + title: node.title, + state: node.state, + isExpanded: node.state === "expanded", + hasError: node.state === "error", + errorMessage: node.errorMessage, + }, + }, + }; + }, +); + +// Tool: Highlight a specific node in the graph +app.registerTool( + "highlight-node", + { + title: "Highlight Node", + description: + "Highlight and center on a specific node in the graph by title or URL", + inputSchema: z.object({ + identifier: z + .string() + .describe("The title or URL of the node to highlight"), + }), + }, + async (args) => { + const { identifier } = args as { identifier: string }; + const lowerIdentifier = identifier.toLowerCase(); + + // Find node by title (case-insensitive partial match) or exact URL + const node = graphData.nodes.find( + (n) => + n.url === identifier || n.title.toLowerCase().includes(lowerIdentifier), + ); + + if (!node) { + return { + content: [ + { type: "text" as const, text: `Node not found: ${identifier}` }, + ], + structuredContent: { + success: false, + error: "Node not found in graph", + availableNodes: graphData.nodes.map((n) => n.title), + }, + }; + } + + // Center on the node and select it + selectedNodeUrl = node.url; + if (node.x !== undefined && node.y !== undefined) { + graph.centerAt(node.x, node.y, 500); + graph.zoom(2, 500); + } + + return { + content: [ + { type: "text" as const, text: `Highlighted node: ${node.title}` }, + ], + structuredContent: { + success: true, + node: { + url: node.url, + title: node.title, + state: node.state, + }, + }, + }; + }, +); + +// Tool: Expand a node to show its linked pages +app.registerTool( + "expand-node", + { + title: "Expand Node", + description: + "Expand a node to fetch and display all Wikipedia pages it links to. This is the core way to explore the graph.", + inputSchema: z.object({ + identifier: z.string().describe("The title or URL of the node to expand"), + }), + }, + async (args) => { + const { identifier } = args as { identifier: string }; + const lowerIdentifier = identifier.toLowerCase(); + + // Find node by title (case-insensitive partial match) or exact URL + const node = graphData.nodes.find( + (n) => + n.url === identifier || n.title.toLowerCase().includes(lowerIdentifier), + ); + + if (!node) { + return { + content: [ + { type: "text" as const, text: `Node not found: ${identifier}` }, + ], + structuredContent: { + success: false, + error: "Node not found in graph", + availableNodes: graphData.nodes.map((n) => n.title), + }, + }; + } + + if (node.state === "expanded") { + return { + content: [ + { + type: "text" as const, + text: `Node "${node.title}" is already expanded`, + }, + ], + structuredContent: { + success: true, + alreadyExpanded: true, + node: { url: node.url, title: node.title }, + }, + }; + } + + if (node.state === "error") { + return { + content: [ + { + type: "text" as const, + text: `Node "${node.title}" has an error: ${node.errorMessage}`, + }, + ], + structuredContent: { + success: false, + error: node.errorMessage, + }, + }; + } + + try { + // Fetch the linked pages using the server tool + const result = await app.callServerTool({ + name: "get-first-degree-links", + arguments: { url: node.url }, + }); + + graph.warmupTicks(0); + handleToolResultData(result); + + const response = result.structuredContent as unknown as ToolResponse; + const linksAdded = response?.links?.length ?? 0; + + // Center on the expanded node + if (node.x !== undefined && node.y !== undefined) { + graph.centerAt(node.x, node.y, 500); + } + + return { + content: [ + { + type: "text" as const, + text: `Expanded "${node.title}" - found ${linksAdded} linked articles`, + }, + ], + structuredContent: { + success: true, + node: { url: node.url, title: node.title }, + linksAdded, + }, + }; + } catch (e) { + setNodeState(node.url, "error", "Request failed"); + updateGraph(); + return { + content: [ + { + type: "text" as const, + text: `Failed to expand "${node.title}": ${e instanceof Error ? e.message : String(e)}`, + }, + ], + structuredContent: { + success: false, + error: String(e), + }, + }; + } + }, +); + +// Tool: Get list of currently visible nodes in the graph +app.registerTool( + "get-visible-nodes", + { + title: "Get Visible Nodes", + description: "Get a list of all nodes currently visible in the graph", + }, + async () => { + const nodes = graphData.nodes.map((n) => ({ + url: n.url, + title: n.title, + state: n.state, + isExpanded: n.state === "expanded", + hasError: n.state === "error", + })); + + const expandedCount = nodes.filter((n) => n.isExpanded).length; + const errorCount = nodes.filter((n) => n.hasError).length; + + return { + content: [ + { + type: "text" as const, + text: `Graph contains ${nodes.length} nodes:\n${nodes.map((n) => `- ${n.title} (${n.state})`).join("\n")}`, + }, + ], + structuredContent: { + totalNodes: nodes.length, + expandedNodes: expandedCount, + errorNodes: errorCount, + nodes, + }, + }; + }, +); + // Connect to host app.connect().then(() => { const ctx = app.getHostContext(); diff --git a/examples/wiki-explorer-server/tsconfig.json b/examples/wiki-explorer-server/tsconfig.json index 535267b..b028ff5 100644 --- a/examples/wiki-explorer-server/tsconfig.json +++ b/examples/wiki-explorer-server/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "vite/client"], "target": "ESNext", "lib": ["ESNext", "DOM", "DOM.Iterable"], "module": "ESNext", diff --git a/examples/wiki-explorer-server/tsconfig.server.json b/examples/wiki-explorer-server/tsconfig.server.json index 05ddd8e..27eb28f 100644 --- a/examples/wiki-explorer-server/tsconfig.server.json +++ b/examples/wiki-explorer-server/tsconfig.server.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node"], "target": "ES2022", "lib": ["ES2022"], "module": "NodeNext", diff --git a/package-lock.json b/package-lock.json index 4e028f5..0189ca2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,19 +1,25 @@ { "name": "@modelcontextprotocol/ext-apps", - "version": "1.2.0", + "version": "2.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@modelcontextprotocol/ext-apps", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "workspaces": [ "examples/*" ], + "dependencies": { + "@standard-schema/spec": "^1.1.0" + }, "devDependencies": { "@boneskull/typedoc-plugin-mermaid": "^0.2.0", - "@modelcontextprotocol/sdk": "1.25.2", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/core": "2.0.0", + "@modelcontextprotocol/sdk": "1.30.0", + "@modelcontextprotocol/server": "2.0.0", "@playwright/test": "1.57.0", "@types/bun": "^1.3.2", "@types/node": "20.19.27", @@ -28,6 +34,7 @@ "electron-to-chromium": "1.5.267", "esbuild": "^0.25.12", "express": "^5.1.0", + "ext-apps-v1": "npm:@modelcontextprotocol/ext-apps@1.7.5", "husky": "^9.1.7", "nodemon": "^3.1.0", "playwright": "1.57.0", @@ -35,21 +42,29 @@ "prettier": "^3.6.2", "react": "^19.2.0", "react-dom": "^19.2.0", - "sharp": "^0.34.5", + "sharp": "^0.35.3", "ts-to-zod": "^5.1.0", "tsx": "^4.21.0", "typedoc": "^0.28.14", "typedoc-github-theme": "^0.4.0", "typescript": "^5.9.3", - "zod": "^4.1.13" + "zod": "^4.2.0" + }, + "engines": { + "node": ">=20" }, "peerDependencies": { - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "^2.0.0", + "@modelcontextprotocol/core": "^2.0.0", + "@modelcontextprotocol/server": "^2.0.0", "react": "^17.0.0 || ^18.0.0 || ^19.0.0", "react-dom": "^17.0.0 || ^18.0.0 || ^19.0.0", - "zod": "^3.25.0 || ^4.0.0" + "zod": "^4.2.0" }, "peerDependenciesMeta": { + "@modelcontextprotocol/server": { + "optional": true + }, "react": { "optional": true }, @@ -60,13 +75,13 @@ }, "examples/basic-host": { "name": "@modelcontextprotocol/ext-apps-basic-host", - "version": "1.2.0", + "version": "2.0.0", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", "react": "^19.2.0", "react-dom": "^19.2.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "devDependencies": { "@types/express": "^5.0.0", @@ -80,8 +95,7 @@ "prettier": "^3.6.2", "typescript": "^5.9.3", "vite": "^6.0.0", - "vite-plugin-singlefile": "^2.3.0", - "vitest": "^3.2.4" + "vite-plugin-singlefile": "^2.3.0" } }, "examples/basic-host/node_modules/@types/node": { @@ -103,15 +117,18 @@ }, "examples/basic-server-preact": { "name": "@modelcontextprotocol/server-basic-preact", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", "preact": "^10.0.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "bin": { "mcp-server-basic-preact": "dist/index.js" @@ -147,16 +164,19 @@ }, "examples/basic-server-react": { "name": "@modelcontextprotocol/server-basic-react", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", "react": "^19.2.0", "react-dom": "^19.2.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "bin": { "mcp-server-basic-react": "dist/index.js" @@ -194,15 +214,18 @@ }, "examples/basic-server-solid": { "name": "@modelcontextprotocol/server-basic-solid", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", "solid-js": "1.9.10", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "bin": { "mcp-server-basic-solid": "dist/index.js" @@ -216,7 +239,7 @@ "typescript": "^5.9.3", "vite": "^6.0.0", "vite-plugin-singlefile": "^2.3.0", - "vite-plugin-solid": "^2.0.0" + "vite-plugin-solid": "^2.11.12" } }, "examples/basic-server-solid/node_modules/@types/node": { @@ -238,15 +261,18 @@ }, "examples/basic-server-svelte": { "name": "@modelcontextprotocol/server-basic-svelte", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", "svelte": "^5.0.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "bin": { "mcp-server-basic-svelte": "dist/index.js" @@ -282,14 +308,17 @@ }, "examples/basic-server-vanillajs": { "name": "@modelcontextprotocol/server-basic-vanillajs", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "bin": { "mcp-server-basic-vanillajs": "dist/index.js" @@ -324,15 +353,18 @@ }, "examples/basic-server-vue": { "name": "@modelcontextprotocol/server-basic-vue", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", "vue": "^3.5.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "bin": { "mcp-server-basic-vue": "dist/index.js" @@ -368,15 +400,17 @@ }, "examples/budget-allocator-server": { "name": "@modelcontextprotocol/server-budget-allocator", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "chart.js": "^4.4.0", "cors": "^2.8.5", "express": "^5.1.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "bin": { "mcp-budget-allocator-server": "dist/index.js" @@ -411,16 +445,18 @@ }, "examples/cohort-heatmap-server": { "name": "@modelcontextprotocol/server-cohort-heatmap", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", "react": "^19.2.0", "react-dom": "^19.2.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "bin": { "mcp-cohort-heatmap-server": "dist/index.js" @@ -458,15 +494,17 @@ }, "examples/customer-segmentation-server": { "name": "@modelcontextprotocol/server-customer-segmentation", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "chart.js": "^4.4.0", "cors": "^2.8.5", "express": "^5.1.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "bin": { "mcp-customer-segmentation-server": "dist/index.js" @@ -501,12 +539,14 @@ }, "examples/debug-server": { "name": "@modelcontextprotocol/server-debug", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", - "zod": "^4.1.13" + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", + "zod": "^4.2.0" }, "bin": { "mcp-server-debug": "dist/index.js" @@ -542,15 +582,18 @@ "license": "MIT" }, "examples/integration-server": { - "version": "1.2.0", + "version": "2.0.0", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", "react": "^19.2.0", "react-dom": "^19.2.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "bin": { "mcp-integration-server": "dist/index.js" @@ -585,16 +628,63 @@ "dev": true, "license": "MIT" }, - "examples/map-server": { - "name": "@modelcontextprotocol/server-map", - "version": "1.2.0", + "examples/lazy-auth-server": { + "name": "@modelcontextprotocol/server-lazy-auth", + "version": "2.0.0", "license": "MIT", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", - "zod": "^4.1.13" + "jose": "^6.0.0", + "zod": "^4.2.0" + }, + "bin": { + "mcp-server-lazy-auth": "dist/index.js" + }, + "devDependencies": { + "@types/cors": "^2.8.19", + "@types/express": "^5.0.0", + "@types/node": "22.10.0", + "concurrently": "^9.2.1", + "cross-env": "^10.1.0", + "typescript": "^5.9.3", + "vite": "^6.0.0", + "vite-plugin-singlefile": "^2.3.0" + } + }, + "examples/lazy-auth-server/node_modules/@types/node": { + "version": "22.10.0", + "resolved": "https://registry.npmjs.org/@types/node/-/node-22.10.0.tgz", + "integrity": "sha512-XC70cRZVElFHfIUB40FgZOBbgJYFKKMa5nb9lxcwYstFG/Mi+/Y0bGS+rs6Dmhmkpq4pnNiLiuZAbc02YCOnmA==", + "dev": true, + "license": "MIT", + "dependencies": { + "undici-types": "~6.20.0" + } + }, + "examples/lazy-auth-server/node_modules/undici-types": { + "version": "6.20.0", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.20.0.tgz", + "integrity": "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg==", + "dev": true, + "license": "MIT" + }, + "examples/map-server": { + "name": "@modelcontextprotocol/server-map", + "version": "2.0.0", + "license": "MIT", + "dependencies": { + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", + "cors": "^2.8.5", + "express": "^5.1.0", + "zod": "^4.2.0" }, "bin": { "mcp-map-server": "dist/index.js" @@ -629,15 +719,19 @@ }, "examples/pdf-server": { "name": "@modelcontextprotocol/server-pdf", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@cantoo/pdf-lib": "^2.6.5", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", "pdfjs-dist": "^5.0.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "bin": { "mcp-pdf-server": "dist/index.js" @@ -672,20 +766,23 @@ }, "examples/qr-server": { "name": "@modelcontextprotocol/server-qr", - "version": "1.2.0", + "version": "2.0.0", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0" + "@modelcontextprotocol/ext-apps": "^2.0.0" } }, "examples/quickstart": { "name": "@modelcontextprotocol/quickstart", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", - "express": "^5.1.0" + "express": "^5.1.0", + "zod": "^4.2.0" }, "devDependencies": { "@types/cors": "^2.8.19", @@ -711,25 +808,27 @@ }, "examples/say-server": { "name": "@modelcontextprotocol/server-say", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0" + "@modelcontextprotocol/ext-apps": "^2.0.0" } }, "examples/scenario-modeler-server": { "name": "@modelcontextprotocol/server-scenario-modeler", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "chart.js": "^4.4.0", "cors": "^2.8.5", "express": "^5.1.0", "react": "^19.2.0", "react-dom": "^19.2.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "bin": { "mcp-scenario-modeler-server": "dist/index.js" @@ -767,14 +866,16 @@ }, "examples/shadertoy-server": { "name": "@modelcontextprotocol/server-shadertoy", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "bin": { "mcp-shadertoy-server": "dist/index.js" @@ -809,15 +910,17 @@ }, "examples/sheet-music-server": { "name": "@modelcontextprotocol/server-sheet-music", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "abcjs": "^6.4.4", "cors": "^2.8.5", "express": "^5.1.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "bin": { "mcp-sheet-music-server": "dist/index.js" @@ -852,16 +955,18 @@ }, "examples/system-monitor-server": { "name": "@modelcontextprotocol/server-system-monitor", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "chart.js": "^4.4.0", "cors": "^2.8.5", "express": "^5.1.0", - "systeminformation": "^5.27.11", - "zod": "^4.1.13" + "systeminformation": "^5.31.6", + "zod": "^4.2.0" }, "bin": { "mcp-system-monitor-server": "dist/index.js" @@ -896,17 +1001,20 @@ }, "examples/threejs-server": { "name": "@modelcontextprotocol/server-threejs", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", "react": "^19.2.0", "react-dom": "^19.2.0", "three": "^0.181.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "bin": { "mcp-threejs-server": "dist/index.js" @@ -945,14 +1053,16 @@ }, "examples/transcript-server": { "name": "@modelcontextprotocol/server-transcript", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "bin": { "mcp-transcript-server": "dist/index.js" @@ -988,14 +1098,17 @@ }, "examples/video-resource-server": { "name": "@modelcontextprotocol/server-video-resource", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cors": "^2.8.5", "express": "^5.1.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "bin": { "mcp-video-resource-server": "dist/index.js" @@ -1030,15 +1143,18 @@ }, "examples/wiki-explorer-server": { "name": "@modelcontextprotocol/server-wiki-explorer", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "dependencies": { - "@modelcontextprotocol/ext-apps": "^1.0.0", - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/express": "2.0.0", + "@modelcontextprotocol/ext-apps": "^2.0.0", + "@modelcontextprotocol/node": "2.0.0", + "@modelcontextprotocol/server": "2.0.0", "cheerio": "^1.0.0", "cors": "^2.8.5", "express": "^5.1.0", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "bin": { "mcp-wiki-explorer-server": "dist/index.js" @@ -1073,13 +1189,13 @@ "license": "MIT" }, "node_modules/@babel/code-frame": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.28.6.tgz", - "integrity": "sha512-JYgintcMjRiCvS8mMECzaEn+m3PfoQiyqukOMCCVQtoJGYJw8j/8LBJEiqkHLkfwCcs74E3pbAUFNg7d9VNJ+Q==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.29.7.tgz", + "integrity": "sha512-Aup7aUOfpbAUg2ROOJN6Iw5f9DMBlzu0mIkm/malLQFN/YQgO48wCj0Kxa3sEHJvPVFg7siR+qRInwXd2qhQKw==", "dev": true, "license": "MIT", "dependencies": { - "@babel/helper-validator-identifier": "^7.28.5", + "@babel/helper-validator-identifier": "^7.29.7", "js-tokens": "^4.0.0", "picocolors": "^1.1.1" }, @@ -1088,9 +1204,9 @@ } }, "node_modules/@babel/compat-data": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.28.6.tgz", - "integrity": "sha512-2lfu57JtzctfIrcGMz992hyLlByuzgIk58+hhGCxjKZ3rWI82NnVLjXcaTqkI2NvlcvOskZaiZ5kjUALo3Lpxg==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.29.7.tgz", + "integrity": "sha512-locTkQyKvwIEgBzVrn8693ebc97F2U8ZHjbXwDXJ5Fn2TCpNwTlKcaKLkdHop5c/icOFE7qt7Q9JC5hnKNa6Gg==", "dev": true, "license": "MIT", "engines": { @@ -1098,21 +1214,21 @@ } }, "node_modules/@babel/core": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.28.6.tgz", - "integrity": "sha512-H3mcG6ZDLTlYfaSNi0iOKkigqMFvkTKlGUYlD8GW7nNOYRrevuA46iTypPyv+06V3fEmvvazfntkBU34L0azAw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.29.7.tgz", + "integrity": "sha512-RgHBCvtjbOK2gXSNBNIkNoEc9qoVEtau3hj8gEqKQuL3HZAibKarWFEI3Lfm6EYKkLalOh8eSrj9b+ch9H/VBA==", "dev": true, "license": "MIT", "dependencies": { - "@babel/code-frame": "^7.28.6", - "@babel/generator": "^7.28.6", - "@babel/helper-compilation-targets": "^7.28.6", - "@babel/helper-module-transforms": "^7.28.6", - "@babel/helpers": "^7.28.6", - "@babel/parser": "^7.28.6", - "@babel/template": "^7.28.6", - "@babel/traverse": "^7.28.6", - "@babel/types": "^7.28.6", + "@babel/code-frame": "^7.29.7", + "@babel/generator": "^7.29.7", + "@babel/helper-compilation-targets": "^7.29.7", + "@babel/helper-module-transforms": "^7.29.7", + "@babel/helpers": "^7.29.7", + "@babel/parser": "^7.29.7", + "@babel/template": "^7.29.7", + "@babel/traverse": "^7.29.7", + "@babel/types": "^7.29.7", "@jridgewell/remapping": "^2.3.5", "convert-source-map": "^2.0.0", "debug": "^4.1.0", @@ -1139,14 +1255,14 @@ } }, "node_modules/@babel/generator": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.28.6.tgz", - "integrity": "sha512-lOoVRwADj8hjf7al89tvQ2a1lf53Z+7tiXMgpZJL3maQPDxh0DgLMN62B2MKUOFcoodBHLMbDM6WAbKgNy5Suw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.29.7.tgz", + "integrity": "sha512-DkXD5OJQaAQIdZ1bt3UZdEnHAn9Imd3IVBdX03UFe+ony9Ojw5pzr9YVKGDY1jt+Gcn/FnGkNf8r+Vj5NOJWtQ==", "dev": true, "license": "MIT", "dependencies": { - "@babel/parser": "^7.28.6", - "@babel/types": "^7.28.6", + "@babel/parser": "^7.29.7", + "@babel/types": "^7.29.7", "@jridgewell/gen-mapping": "^0.3.12", "@jridgewell/trace-mapping": "^0.3.28", "jsesc": "^3.0.2" @@ -1169,14 +1285,14 @@ } }, "node_modules/@babel/helper-compilation-targets": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.28.6.tgz", - "integrity": "sha512-JYtls3hqi15fcx5GaSNL7SCTJ2MNmjrkHXg4FSpOA/grxK8KwyZ5bubHsCq8FXCkua6xhuaaBit+3b7+VZRfcA==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.29.7.tgz", + "integrity": "sha512-wem6WaBj4NaVYVdNhLPPVacES6ZJ+KBBfSkTMD3YZxbP3rm3Di85tJU5ljaUNhaOynt+Aj0xruhYuzQBt8n71g==", "dev": true, "license": "MIT", "dependencies": { - "@babel/compat-data": "^7.28.6", - "@babel/helper-validator-option": "^7.27.1", + "@babel/compat-data": "^7.29.7", + "@babel/helper-validator-option": "^7.29.7", "browserslist": "^4.24.0", "lru-cache": "^5.1.1", "semver": "^6.3.1" @@ -1196,9 +1312,9 @@ } }, "node_modules/@babel/helper-globals": { - "version": "7.28.0", - "resolved": "https://registry.npmjs.org/@babel/helper-globals/-/helper-globals-7.28.0.tgz", - "integrity": "sha512-+W6cISkXFa1jXsDEdYA8HeevQT/FULhxzR99pxphltZcVaugps53THCeiWA8SguxxpSp3gKPiuYfSWopkLQ4hw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-globals/-/helper-globals-7.29.7.tgz", + "integrity": "sha512-3nQVUAtvkKH9zahfWgw96Jc/uFOmjACE1kQz82E2lqWmHBgjzbNlsC22nuQTfahmWeQtTq5nQ/4Nnd2A1wj4zA==", "dev": true, "license": "MIT", "engines": { @@ -1206,29 +1322,29 @@ } }, "node_modules/@babel/helper-module-imports": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.28.6.tgz", - "integrity": "sha512-l5XkZK7r7wa9LucGw9LwZyyCUscb4x37JWTPz7swwFE/0FMQAGpiWUZn8u9DzkSBWEcK25jmvubfpw2dnAMdbw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.29.7.tgz", + "integrity": "sha512-ejHwrQQYcm9xnTivShn2IDOlIzInN34AXskvq9QicvCtEzq1Vzclu/tKF8Jq1Cg8JG2GL6/EmjgsCT7lXepE3g==", "dev": true, "license": "MIT", "dependencies": { - "@babel/traverse": "^7.28.6", - "@babel/types": "^7.28.6" + "@babel/traverse": "^7.29.7", + "@babel/types": "^7.29.7" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-module-transforms": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.28.6.tgz", - "integrity": "sha512-67oXFAYr2cDLDVGLXTEABjdBJZ6drElUSI7WKp70NrpyISso3plG9SAGEF6y7zbha/wOzUByWWTJvEDVNIUGcA==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.29.7.tgz", + "integrity": "sha512-UPUVSyXbOh627KiCIGQSgwWzGeBKLkaJ9PJEdrngIwMSzxLR4jS4+f1f1jb7VzBbg8nFLaYotvVPFCTqdrmTAg==", "dev": true, "license": "MIT", "dependencies": { - "@babel/helper-module-imports": "^7.28.6", - "@babel/helper-validator-identifier": "^7.28.5", - "@babel/traverse": "^7.28.6" + "@babel/helper-module-imports": "^7.29.7", + "@babel/helper-validator-identifier": "^7.29.7", + "@babel/traverse": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1248,27 +1364,27 @@ } }, "node_modules/@babel/helper-string-parser": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.27.1.tgz", - "integrity": "sha512-qMlSxKbpRlAridDExk92nSobyDdpPijUq2DW6oDnUqd0iOGxmQjyqhMIihI9+zv4LPyZdRje2cavWPbCbWm3eA==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.29.7.tgz", + "integrity": "sha512-Pb5ijPrZ89GDH8223L4UP8i6QApWxs04RbPQJTeWDV0/keR2E36MeKnyr6LYmUUvqRRI+Iv87SuF1W6ErINzYw==", "license": "MIT", "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-validator-identifier": { - "version": "7.28.5", - "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.28.5.tgz", - "integrity": "sha512-qSs4ifwzKJSV39ucNjsvc6WVHs6b7S03sOh2OcHF9UHfVPqWWALUsNUVzhSBiItjRZoLHx7nIarVjqKVusUZ1Q==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.29.7.tgz", + "integrity": "sha512-qehxGkRj55h/ff8EMaJ+cYhyaKlHIxqYDn682wQD7RNp9UujOQsHog2uS0r2vzr4pW+sXf90NeeayjcNaX3fFg==", "license": "MIT", "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-validator-option": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-validator-option/-/helper-validator-option-7.27.1.tgz", - "integrity": "sha512-YvjJow9FxbhFFKDSuFnVCe2WxXk1zWc22fFePVNEaWJEu8IrZVlda6N0uHwzZrUM1il7NC9Mlp4MaJYbYd9JSg==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-option/-/helper-validator-option-7.29.7.tgz", + "integrity": "sha512-N9ZErrD+yW5geCDtBqnOoxmR8+tNKiGuxKlDpuJxfsqpa2dFcexaziGAE/qoHLiDDreVNMupxGmSoNlyvsA3gw==", "dev": true, "license": "MIT", "engines": { @@ -1276,26 +1392,26 @@ } }, "node_modules/@babel/helpers": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.28.6.tgz", - "integrity": "sha512-xOBvwq86HHdB7WUDTfKfT/Vuxh7gElQ+Sfti2Cy6yIWNW05P8iUslOVcZ4/sKbE+/jQaukQAdz/gf3724kYdqw==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.29.7.tgz", + "integrity": "sha512-1k2lAGRMfHTcwuNYcCNUmaUffmQv8KWMfh2iJUUeRlwlwH4FdNG7mfPI10NPfLHJFThE4Tyr4mv7kTNZOiPuBg==", "dev": true, "license": "MIT", "dependencies": { - "@babel/template": "^7.28.6", - "@babel/types": "^7.28.6" + "@babel/template": "^7.29.7", + "@babel/types": "^7.29.7" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/parser": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.28.6.tgz", - "integrity": "sha512-TeR9zWR18BvbfPmGbLampPMW+uW1NZnJlRuuHso8i87QZNq2JRF9i6RgxRqtEq+wQGsS19NNTWr2duhnE49mfQ==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.29.7.tgz", + "integrity": "sha512-hnORnjP/1P/zFEndoeX+n+t1RwWRJiJpM/jO7FW32Kn9r5+sJB2JWOdYo4L6k78j15eCwY3Gm/7364B1EMwtNg==", "license": "MIT", "dependencies": { - "@babel/types": "^7.28.6" + "@babel/types": "^7.29.7" }, "bin": { "parser": "bin/babel-parser.js" @@ -1389,33 +1505,33 @@ } }, "node_modules/@babel/template": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.28.6.tgz", - "integrity": "sha512-YA6Ma2KsCdGb+WC6UpBVFJGXL58MDA6oyONbjyF/+5sBgxY/dwkhLogbMT2GXXyU84/IhRw/2D1Os1B/giz+BQ==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.29.7.tgz", + "integrity": "sha512-puq+Gf35oI24FeN11LkoUQFqv9uwNeWpxXZi/Ji3rRIoKAzKnxRaZ+Gkj0vKS9ZCiTESfng1N9LyOyXvo+m+Gg==", "dev": true, "license": "MIT", "dependencies": { - "@babel/code-frame": "^7.28.6", - "@babel/parser": "^7.28.6", - "@babel/types": "^7.28.6" + "@babel/code-frame": "^7.29.7", + "@babel/parser": "^7.29.7", + "@babel/types": "^7.29.7" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/traverse": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.28.6.tgz", - "integrity": "sha512-fgWX62k02qtjqdSNTAGxmKYY/7FSL9WAS1o2Hu5+I5m9T0yxZzr4cnrfXQ/MX0rIifthCSs6FKTlzYbJcPtMNg==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.29.7.tgz", + "integrity": "sha512-EhlfNQtZ+NK22w5BM61ciuiq1m58ed33Wr1Xan//ZRTy6hgjnwyCffRYwzsGXdASJSUJ1guZILsErh1eQcl+zw==", "dev": true, "license": "MIT", "dependencies": { - "@babel/code-frame": "^7.28.6", - "@babel/generator": "^7.28.6", - "@babel/helper-globals": "^7.28.0", - "@babel/parser": "^7.28.6", - "@babel/template": "^7.28.6", - "@babel/types": "^7.28.6", + "@babel/code-frame": "^7.29.7", + "@babel/generator": "^7.29.7", + "@babel/helper-globals": "^7.29.7", + "@babel/parser": "^7.29.7", + "@babel/template": "^7.29.7", + "@babel/types": "^7.29.7", "debug": "^4.3.1" }, "engines": { @@ -1423,13 +1539,13 @@ } }, "node_modules/@babel/types": { - "version": "7.28.6", - "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.28.6.tgz", - "integrity": "sha512-0ZrskXVEHSWIqZM/sQZ4EV3jZJXRkio/WCxaqKZP1g//CEWEPSfeZFcms4XeKBCHU0ZKnIkdJeU/kF+eRp5lBg==", + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.29.7.tgz", + "integrity": "sha512-4zBIxpPzowiZpusoFkyGVwakdRJUyuH5PxQ/PrqghfdFWWasvnCdPfQXHrenDai+gyLARulZjZowCOj6fjT4pA==", "license": "MIT", "dependencies": { - "@babel/helper-string-parser": "^7.27.1", - "@babel/helper-validator-identifier": "^7.28.5" + "@babel/helper-string-parser": "^7.29.7", + "@babel/helper-validator-identifier": "^7.29.7" }, "engines": { "node": ">=6.9.0" @@ -1454,6 +1570,21 @@ } } }, + "node_modules/@cantoo/pdf-lib": { + "version": "2.6.5", + "resolved": "https://registry.npmjs.org/@cantoo/pdf-lib/-/pdf-lib-2.6.5.tgz", + "integrity": "sha512-3eMHEaqKHt/G/q+6QjT06A3lz0S/a8x3+myiSN7FNeL3uWcedO0lpfs6TWofa4C03Z1wz3tWeHoa4CsI7DrTSA==", + "license": "MIT", + "dependencies": { + "@pdf-lib/standard-fonts": "^1.0.0", + "@pdf-lib/upng": "^1.0.1", + "color": "^4.2.3", + "crypto-js": "^4.2.0", + "node-html-better-parser": ">=1.4.0", + "pako": "^1.0.11", + "tslib": ">=2" + } + }, "node_modules/@clack/core": { "version": "1.0.0-alpha.4", "resolved": "https://registry.npmjs.org/@clack/core/-/core-1.0.0-alpha.4.tgz", @@ -1485,9 +1616,9 @@ "license": "Apache-2.0" }, "node_modules/@emnapi/runtime": { - "version": "1.8.1", - "resolved": "https://registry.npmjs.org/@emnapi/runtime/-/runtime-1.8.1.tgz", - "integrity": "sha512-mehfKSMWjjNol8659Z8KxEMrdSJDDot5SXMq00dM8BN4o+CLNXQ0xH2V7EchNHV4RmbZLmmPdEaXZc5H2FXmDg==", + "version": "1.11.2", + "resolved": "https://registry.npmjs.org/@emnapi/runtime/-/runtime-1.11.2.tgz", + "integrity": "sha512-kyOl3X0DuTiT1h2ft8r2fYO8JYtU9a9Xis/zBSiGArNaagCOWx90N1k2wxp18czFDH+OgcWGb5ZP/XMt3dcyPA==", "dev": true, "license": "MIT", "optional": true, @@ -1959,9 +2090,9 @@ } }, "node_modules/@hono/node-server": { - "version": "1.19.7", - "resolved": "https://registry.npmjs.org/@hono/node-server/-/node-server-1.19.7.tgz", - "integrity": "sha512-vUcD0uauS7EU2caukW8z5lJKtoGMokxNbJtBiwHgpqxEXokaHCBkQUmCHhjFB1VUTWdqj25QoMkMKzgjq+uhrw==", + "version": "1.19.14", + "resolved": "https://registry.npmjs.org/@hono/node-server/-/node-server-1.19.14.tgz", + "integrity": "sha512-GwtvgtXxnWsucXvbQXkRgqksiH2Qed37H9xHZocE5sA3N8O8O8/8FA3uclQXxXVzc9XBZuEOMK7+r02FmSpHtw==", "license": "MIT", "engines": { "node": ">=18.14.1" @@ -1971,9 +2102,9 @@ } }, "node_modules/@img/colour": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/@img/colour/-/colour-1.0.0.tgz", - "integrity": "sha512-A5P/LfWGFSl6nsckYtjw9da+19jB8hkJ6ACTGcDfEJ0aE+l2n2El7dsVM7UVHZQ9s2lmYMWlrS21YLy2IR1LUw==", + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@img/colour/-/colour-1.1.0.tgz", + "integrity": "sha512-Td76q7j57o/tLVdgS746cYARfSyxk8iEfRxewL9h4OMzYhbW4TAcppl0mT4eyqXddh6L/jwoM75mo7ixa/pCeQ==", "dev": true, "license": "MIT", "engines": { @@ -1981,9 +2112,9 @@ } }, "node_modules/@img/sharp-darwin-arm64": { - "version": "0.34.5", - "resolved": "https://registry.npmjs.org/@img/sharp-darwin-arm64/-/sharp-darwin-arm64-0.34.5.tgz", - "integrity": "sha512-imtQ3WMJXbMY4fxb/Ndp6HBTNVtWCUI0WdobyheGf5+ad6xX8VIDO8u2xE4qc/fr08CKG/7dDseFtn6M6g/r3w==", + "version": "0.35.3", + "resolved": "https://registry.npmjs.org/@img/sharp-darwin-arm64/-/sharp-darwin-arm64-0.35.3.tgz", + "integrity": "sha512-RMnFX7YQsMoh7lWfcM4NEHHymBX/rLuKNPVM84XE9ONPcaSCDgE7CHIHpSgPcO2xcRthgBy1HfNO319mwhIAkg==", "cpu": [ "arm64" ], @@ -1994,19 +2125,19 @@ "darwin" ], "engines": { - "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + "node": ">=20.9.0" }, "funding": { "url": "https://opencollective.com/libvips" }, "optionalDependencies": { - "@img/sharp-libvips-darwin-arm64": "1.2.4" + "@img/sharp-libvips-darwin-arm64": "1.3.2" } }, "node_modules/@img/sharp-darwin-x64": { - "version": "0.34.5", - "resolved": "https://registry.npmjs.org/@img/sharp-darwin-x64/-/sharp-darwin-x64-0.34.5.tgz", - "integrity": "sha512-YNEFAF/4KQ/PeW0N+r+aVVsoIY0/qxxikF2SWdp+NRkmMB7y9LBZAVqQ4yhGCm/H3H270OSykqmQMKLBhBJDEw==", + "version": "0.35.3", + "resolved": "https://registry.npmjs.org/@img/sharp-darwin-x64/-/sharp-darwin-x64-0.35.3.tgz", + "integrity": "sha512-Xo+5uFBtLN0BKqieTxiFzFPQAUlBbbH5iBKyRX/z1JrbnYsHTfKJnUfL8+p2TPXr1pXqao4eeL4Rl144uDpK9w==", "cpu": [ "x64" ], @@ -2017,19 +2148,39 @@ "darwin" ], "engines": { - "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + "node": ">=20.9.0" }, "funding": { "url": "https://opencollective.com/libvips" }, "optionalDependencies": { - "@img/sharp-libvips-darwin-x64": "1.2.4" + "@img/sharp-libvips-darwin-x64": "1.3.2" + } + }, + "node_modules/@img/sharp-freebsd-wasm32": { + "version": "0.35.3", + "resolved": "https://registry.npmjs.org/@img/sharp-freebsd-wasm32/-/sharp-freebsd-wasm32-0.35.3.tgz", + "integrity": "sha512-lUxcqWIj2wMQ9BrwNjngcr1gWUr5xgaGThBRqPPalIC2n67Cqj1uPh8NnA/ZhAg8hUbKl+kVHKwgUIwe6ZYPrg==", + "dev": true, + "license": "Apache-2.0", + "optional": true, + "os": [ + "freebsd" + ], + "dependencies": { + "@img/sharp-wasm32": "0.35.3" + }, + "engines": { + "node": ">=20.9.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" } }, "node_modules/@img/sharp-libvips-darwin-arm64": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/@img/sharp-libvips-darwin-arm64/-/sharp-libvips-darwin-arm64-1.2.4.tgz", - "integrity": "sha512-zqjjo7RatFfFoP0MkQ51jfuFZBnVE2pRiaydKJ1G/rHZvnsrHAOcQALIi9sA5co5xenQdTugCvtb1cuf78Vf4g==", + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-darwin-arm64/-/sharp-libvips-darwin-arm64-1.3.2.tgz", + "integrity": "sha512-9J6ypZFpQBj4YnePGoq/S38w6nz+vqg5WZLrLGY4YuSemdMq47GMLBPO42MzwdGwpg/agZ7xzZcFHa48xlywfg==", "cpu": [ "arm64" ], @@ -2044,9 +2195,9 @@ } }, "node_modules/@img/sharp-libvips-darwin-x64": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/@img/sharp-libvips-darwin-x64/-/sharp-libvips-darwin-x64-1.2.4.tgz", - "integrity": "sha512-1IOd5xfVhlGwX+zXv2N93k0yMONvUlANylbJw1eTah8K/Jtpi15KC+WSiaX/nBmbm2HxRM1gZ0nSdjSsrZbGKg==", + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-darwin-x64/-/sharp-libvips-darwin-x64-1.3.2.tgz", + "integrity": "sha512-m2pW1n6cns9VaubNwsZ+c3CRYjxNQWgJ5gPlnL1nbBcpkBvFm6SCFN5o0psFHI8w9n11NKhFkeEDns98tiqbEw==", "cpu": [ "x64" ], @@ -2061,9 +2212,9 @@ } }, "node_modules/@img/sharp-libvips-linux-arm": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-arm/-/sharp-libvips-linux-arm-1.2.4.tgz", - "integrity": "sha512-bFI7xcKFELdiNCVov8e44Ia4u2byA+l3XtsAj+Q8tfCwO6BQ8iDojYdvoPMqsKDkuoOo+X6HZA0s0q11ANMQ8A==", + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-arm/-/sharp-libvips-linux-arm-1.3.2.tgz", + "integrity": "sha512-1eMLzy92I4J6rmi4mAT8yC3HxOtniyGELlzGbNMLLeqe052ahFQ0h6LFq+lh5DsDIdYViIDst08abvSbcEdLXQ==", "cpu": [ "arm" ], @@ -2078,9 +2229,9 @@ } }, "node_modules/@img/sharp-libvips-linux-arm64": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-arm64/-/sharp-libvips-linux-arm64-1.2.4.tgz", - "integrity": "sha512-excjX8DfsIcJ10x1Kzr4RcWe1edC9PquDRRPx3YVCvQv+U5p7Yin2s32ftzikXojb1PIFc/9Mt28/y+iRklkrw==", + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-arm64/-/sharp-libvips-linux-arm64-1.3.2.tgz", + "integrity": "sha512-dqVSFynCox4C/J8kT16V7SIFAns0IjgLwkvYT7p8LQVmJ5OS5b6tI9IGflxTeuBS//zXeFIUbwt5dwxyZ17cnA==", "cpu": [ "arm64" ], @@ -2095,9 +2246,9 @@ } }, "node_modules/@img/sharp-libvips-linux-ppc64": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-ppc64/-/sharp-libvips-linux-ppc64-1.2.4.tgz", - "integrity": "sha512-FMuvGijLDYG6lW+b/UvyilUWu5Ayu+3r2d1S8notiGCIyYU/76eig1UfMmkZ7vwgOrzKzlQbFSuQfgm7GYUPpA==", + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-ppc64/-/sharp-libvips-linux-ppc64-1.3.2.tgz", + "integrity": "sha512-3z0NHDxD6n5I9gc05U1eW1AyRm+Gznzq3naMrthPNqE6oYykcogW0l/jfpJdjYnuNl8R7yI9pNbE1XiUeyq0Aw==", "cpu": [ "ppc64" ], @@ -2112,9 +2263,9 @@ } }, "node_modules/@img/sharp-libvips-linux-riscv64": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-riscv64/-/sharp-libvips-linux-riscv64-1.2.4.tgz", - "integrity": "sha512-oVDbcR4zUC0ce82teubSm+x6ETixtKZBh/qbREIOcI3cULzDyb18Sr/Wcyx7NRQeQzOiHTNbZFF1UwPS2scyGA==", + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-riscv64/-/sharp-libvips-linux-riscv64-1.3.2.tgz", + "integrity": "sha512-bsb4rI+NldGOsXuej2r8OdSS8+zXDVaCWxyWrcv6kneTOlgAHtZABRzBBCwdsPiD90J4myNJuHpg6kA20ImW/w==", "cpu": [ "riscv64" ], @@ -2129,9 +2280,9 @@ } }, "node_modules/@img/sharp-libvips-linux-s390x": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-s390x/-/sharp-libvips-linux-s390x-1.2.4.tgz", - "integrity": "sha512-qmp9VrzgPgMoGZyPvrQHqk02uyjA0/QrTO26Tqk6l4ZV0MPWIW6LTkqOIov+J1yEu7MbFQaDpwdwJKhbJvuRxQ==", + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-s390x/-/sharp-libvips-linux-s390x-1.3.2.tgz", + "integrity": "sha512-/ABshyj8gCpyIrNXnHn4LorDJ0HHm1VhXPBlxZ8zAtfVPAaSafXPGn+sUSIRiwaSBy0mmFjSjiXI5mkcwdChKQ==", "cpu": [ "s390x" ], @@ -2146,9 +2297,9 @@ } }, "node_modules/@img/sharp-libvips-linux-x64": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-x64/-/sharp-libvips-linux-x64-1.2.4.tgz", - "integrity": "sha512-tJxiiLsmHc9Ax1bz3oaOYBURTXGIRDODBqhveVHonrHJ9/+k89qbLl0bcJns+e4t4rvaNBxaEZsFtSfAdquPrw==", + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linux-x64/-/sharp-libvips-linux-x64-1.3.2.tgz", + "integrity": "sha512-ITPEtgffGJ0S6G9dRyw/366tJQqFRcHWPHhC+Stpg3Z8AEMrDrTr2lhdz4f/Y/HMbRh//7Z5mBzEpVdi62Oc3w==", "cpu": [ "x64" ], @@ -2163,9 +2314,9 @@ } }, "node_modules/@img/sharp-libvips-linuxmusl-arm64": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linuxmusl-arm64/-/sharp-libvips-linuxmusl-arm64-1.2.4.tgz", - "integrity": "sha512-FVQHuwx1IIuNow9QAbYUzJ+En8KcVm9Lk5+uGUQJHaZmMECZmOlix9HnH7n1TRkXMS0pGxIJokIVB9SuqZGGXw==", + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linuxmusl-arm64/-/sharp-libvips-linuxmusl-arm64-1.3.2.tgz", + "integrity": "sha512-zE9EdiUzUmg5mDT5a1rk5fYJ6GWPloTwWBYDS14naqHsL+EaMpDj1AWnpLgh3u0YCORv2Tt50wrcrpYqkP97Kw==", "cpu": [ "arm64" ], @@ -2180,9 +2331,9 @@ } }, "node_modules/@img/sharp-libvips-linuxmusl-x64": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linuxmusl-x64/-/sharp-libvips-linuxmusl-x64-1.2.4.tgz", - "integrity": "sha512-+LpyBk7L44ZIXwz/VYfglaX/okxezESc6UxDSoyo2Ks6Jxc4Y7sGjpgU9s4PMgqgjj1gZCylTieNamqA1MF7Dg==", + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/@img/sharp-libvips-linuxmusl-x64/-/sharp-libvips-linuxmusl-x64-1.3.2.tgz", + "integrity": "sha512-m0lrLiUt+lBYnCFr8qV/65yMR4E/c7/wf78I5eKTdkEakFAlZ9QlzEM3QIhhAwVeUhLAHLcCq7a7Vszq/oFNZQ==", "cpu": [ "x64" ], @@ -2197,9 +2348,9 @@ } }, "node_modules/@img/sharp-linux-arm": { - "version": "0.34.5", - "resolved": "https://registry.npmjs.org/@img/sharp-linux-arm/-/sharp-linux-arm-0.34.5.tgz", - "integrity": "sha512-9dLqsvwtg1uuXBGZKsxem9595+ujv0sJ6Vi8wcTANSFpwV/GONat5eCkzQo/1O6zRIkh0m/8+5BjrRr7jDUSZw==", + "version": "0.35.3", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-arm/-/sharp-linux-arm-0.35.3.tgz", + "integrity": "sha512-affVWCTLooy8TSxbDx2qkzuDeaWLNVBA+P//FNBirHsXpP2fuBhk5AuboYUnrDnzoXes8GFjpTx0SBFOCRg+FA==", "cpu": [ "arm" ], @@ -2210,19 +2361,19 @@ "linux" ], "engines": { - "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + "node": ">=20.9.0" }, "funding": { "url": "https://opencollective.com/libvips" }, "optionalDependencies": { - "@img/sharp-libvips-linux-arm": "1.2.4" + "@img/sharp-libvips-linux-arm": "1.3.2" } }, "node_modules/@img/sharp-linux-arm64": { - "version": "0.34.5", - "resolved": "https://registry.npmjs.org/@img/sharp-linux-arm64/-/sharp-linux-arm64-0.34.5.tgz", - "integrity": "sha512-bKQzaJRY/bkPOXyKx5EVup7qkaojECG6NLYswgktOZjaXecSAeCWiZwwiFf3/Y+O1HrauiE3FVsGxFg8c24rZg==", + "version": "0.35.3", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-arm64/-/sharp-linux-arm64-0.35.3.tgz", + "integrity": "sha512-QgKDspHPnrU+GQ55XPhGwyhC8acLVOOSyAvo1oVfFmrIXLkDNmGWzAfDZ4xK8oSA1qBQrALcHX0G5UZni/SuFQ==", "cpu": [ "arm64" ], @@ -2233,19 +2384,19 @@ "linux" ], "engines": { - "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + "node": ">=20.9.0" }, "funding": { "url": "https://opencollective.com/libvips" }, "optionalDependencies": { - "@img/sharp-libvips-linux-arm64": "1.2.4" + "@img/sharp-libvips-linux-arm64": "1.3.2" } }, "node_modules/@img/sharp-linux-ppc64": { - "version": "0.34.5", - "resolved": "https://registry.npmjs.org/@img/sharp-linux-ppc64/-/sharp-linux-ppc64-0.34.5.tgz", - "integrity": "sha512-7zznwNaqW6YtsfrGGDA6BRkISKAAE1Jo0QdpNYXNMHu2+0dTrPflTLNkpc8l7MUP5M16ZJcUvysVWWrMefZquA==", + "version": "0.35.3", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-ppc64/-/sharp-linux-ppc64-0.35.3.tgz", + "integrity": "sha512-sMd8rDxmpLOwv/7N44klFjOD5DUO7FLdjiXDI0hoxYaf7Ar262dQIEkosE98bps+5HPLtp/EvNqeqQtOycP/IA==", "cpu": [ "ppc64" ], @@ -2256,19 +2407,19 @@ "linux" ], "engines": { - "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + "node": ">=20.9.0" }, "funding": { "url": "https://opencollective.com/libvips" }, "optionalDependencies": { - "@img/sharp-libvips-linux-ppc64": "1.2.4" + "@img/sharp-libvips-linux-ppc64": "1.3.2" } }, "node_modules/@img/sharp-linux-riscv64": { - "version": "0.34.5", - "resolved": "https://registry.npmjs.org/@img/sharp-linux-riscv64/-/sharp-linux-riscv64-0.34.5.tgz", - "integrity": "sha512-51gJuLPTKa7piYPaVs8GmByo7/U7/7TZOq+cnXJIHZKavIRHAP77e3N2HEl3dgiqdD/w0yUfiJnII77PuDDFdw==", + "version": "0.35.3", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-riscv64/-/sharp-linux-riscv64-0.35.3.tgz", + "integrity": "sha512-0Eob78yjlYPfL5vMNWAW55l3R9Y6BQS/gOfe0ZcP9mEz9ohhKSt4im1hayiknXgf8AWrFqMvJcKIdmLmEe7yeQ==", "cpu": [ "riscv64" ], @@ -2279,19 +2430,19 @@ "linux" ], "engines": { - "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + "node": ">=20.9.0" }, "funding": { "url": "https://opencollective.com/libvips" }, "optionalDependencies": { - "@img/sharp-libvips-linux-riscv64": "1.2.4" + "@img/sharp-libvips-linux-riscv64": "1.3.2" } }, "node_modules/@img/sharp-linux-s390x": { - "version": "0.34.5", - "resolved": "https://registry.npmjs.org/@img/sharp-linux-s390x/-/sharp-linux-s390x-0.34.5.tgz", - "integrity": "sha512-nQtCk0PdKfho3eC5MrbQoigJ2gd1CgddUMkabUj+rBevs8tZ2cULOx46E7oyX+04WGfABgIwmMC0VqieTiR4jg==", + "version": "0.35.3", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-s390x/-/sharp-linux-s390x-0.35.3.tgz", + "integrity": "sha512-KgAxQ0DxpNOq1rG2t5cgTgShJFGSuU7XO45cqC+1NVOuZnP6tlgZRuSYOfNupGkHID0o3cJOsw4DVeJpMovcGw==", "cpu": [ "s390x" ], @@ -2302,19 +2453,19 @@ "linux" ], "engines": { - "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + "node": ">=20.9.0" }, "funding": { "url": "https://opencollective.com/libvips" }, "optionalDependencies": { - "@img/sharp-libvips-linux-s390x": "1.2.4" + "@img/sharp-libvips-linux-s390x": "1.3.2" } }, "node_modules/@img/sharp-linux-x64": { - "version": "0.34.5", - "resolved": "https://registry.npmjs.org/@img/sharp-linux-x64/-/sharp-linux-x64-0.34.5.tgz", - "integrity": "sha512-MEzd8HPKxVxVenwAa+JRPwEC7QFjoPWuS5NZnBt6B3pu7EG2Ge0id1oLHZpPJdn3OQK+BQDiw9zStiHBTJQQQQ==", + "version": "0.35.3", + "resolved": "https://registry.npmjs.org/@img/sharp-linux-x64/-/sharp-linux-x64-0.35.3.tgz", + "integrity": "sha512-8pqvxubL2PGdhlPy6GLqzDYMUjyRmKAwKHYKixpdJYBUK7PJ0C029XdsnpFIdgRZG68fZiGdHVWcKPvtiPB4cA==", "cpu": [ "x64" ], @@ -2325,19 +2476,19 @@ "linux" ], "engines": { - "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + "node": ">=20.9.0" }, "funding": { "url": "https://opencollective.com/libvips" }, "optionalDependencies": { - "@img/sharp-libvips-linux-x64": "1.2.4" + "@img/sharp-libvips-linux-x64": "1.3.2" } }, "node_modules/@img/sharp-linuxmusl-arm64": { - "version": "0.34.5", - "resolved": "https://registry.npmjs.org/@img/sharp-linuxmusl-arm64/-/sharp-linuxmusl-arm64-0.34.5.tgz", - "integrity": "sha512-fprJR6GtRsMt6Kyfq44IsChVZeGN97gTD331weR1ex1c1rypDEABN6Tm2xa1wE6lYb5DdEnk03NZPqA7Id21yg==", + "version": "0.35.3", + "resolved": "https://registry.npmjs.org/@img/sharp-linuxmusl-arm64/-/sharp-linuxmusl-arm64-0.35.3.tgz", + "integrity": "sha512-Vz0iQjzzcSX3HCbfwFfCSG/9SCIqyO0mH2sXyiHaAYfBk0cRsCWXRyQYX0ovCK/PAQBbTzQ0dsPQHh5MAFL59w==", "cpu": [ "arm64" ], @@ -2348,19 +2499,19 @@ "linux" ], "engines": { - "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + "node": ">=20.9.0" }, "funding": { "url": "https://opencollective.com/libvips" }, "optionalDependencies": { - "@img/sharp-libvips-linuxmusl-arm64": "1.2.4" + "@img/sharp-libvips-linuxmusl-arm64": "1.3.2" } }, "node_modules/@img/sharp-linuxmusl-x64": { - "version": "0.34.5", - "resolved": "https://registry.npmjs.org/@img/sharp-linuxmusl-x64/-/sharp-linuxmusl-x64-0.34.5.tgz", - "integrity": "sha512-Jg8wNT1MUzIvhBFxViqrEhWDGzqymo3sV7z7ZsaWbZNDLXRJZoRGrjulp60YYtV4wfY8VIKcWidjojlLcWrd8Q==", + "version": "0.35.3", + "resolved": "https://registry.npmjs.org/@img/sharp-linuxmusl-x64/-/sharp-linuxmusl-x64-0.35.3.tgz", + "integrity": "sha512-6O1NPKcDVj9QEdg7Hx549EX8U0rp6yXQERqru6yRN7fGBn32UvIRJUlWnk+8xDCiG76hXVBbX82NZ/ZKr0euIg==", "cpu": [ "x64" ], @@ -2371,39 +2522,56 @@ "linux" ], "engines": { - "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + "node": ">=20.9.0" }, "funding": { "url": "https://opencollective.com/libvips" }, "optionalDependencies": { - "@img/sharp-libvips-linuxmusl-x64": "1.2.4" + "@img/sharp-libvips-linuxmusl-x64": "1.3.2" } }, "node_modules/@img/sharp-wasm32": { - "version": "0.34.5", - "resolved": "https://registry.npmjs.org/@img/sharp-wasm32/-/sharp-wasm32-0.34.5.tgz", - "integrity": "sha512-OdWTEiVkY2PHwqkbBI8frFxQQFekHaSSkUIJkwzclWZe64O1X4UlUjqqqLaPbUpMOQk6FBu/HtlGXNblIs0huw==", - "cpu": [ - "wasm32" - ], + "version": "0.35.3", + "resolved": "https://registry.npmjs.org/@img/sharp-wasm32/-/sharp-wasm32-0.35.3.tgz", + "integrity": "sha512-cZ0XkcYGpHZkqW6iCkqTcmUC0CD9DhD5d/qeZlZkfRBn6GnHniZXLUo5+9xw8Iv76YE6LQFN9YNBlKREcCG76w==", "dev": true, "license": "Apache-2.0 AND LGPL-3.0-or-later AND MIT", "optional": true, "dependencies": { - "@emnapi/runtime": "^1.7.0" + "@emnapi/runtime": "^1.11.1" }, "engines": { - "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + "node": ">=20.9.0" + }, + "funding": { + "url": "https://opencollective.com/libvips" + } + }, + "node_modules/@img/sharp-webcontainers-wasm32": { + "version": "0.35.3", + "resolved": "https://registry.npmjs.org/@img/sharp-webcontainers-wasm32/-/sharp-webcontainers-wasm32-0.35.3.tgz", + "integrity": "sha512-2rnq7bX3NzeR2T4YWgz8qiG4h3TSdMe+vN1iQXpJleSJ3SM5zQ8Fy2SyyXAWlbxpEZ2Y+Z4u1BePgJEYbSy80Q==", + "cpu": [ + "wasm32" + ], + "dev": true, + "license": "Apache-2.0", + "optional": true, + "dependencies": { + "@img/sharp-wasm32": "0.35.3" + }, + "engines": { + "node": ">=20.9.0" }, "funding": { "url": "https://opencollective.com/libvips" } }, "node_modules/@img/sharp-win32-arm64": { - "version": "0.34.5", - "resolved": "https://registry.npmjs.org/@img/sharp-win32-arm64/-/sharp-win32-arm64-0.34.5.tgz", - "integrity": "sha512-WQ3AgWCWYSb2yt+IG8mnC6Jdk9Whs7O0gxphblsLvdhSpSTtmu69ZG1Gkb6NuvxsNACwiPV6cNSZNzt0KPsw7g==", + "version": "0.35.3", + "resolved": "https://registry.npmjs.org/@img/sharp-win32-arm64/-/sharp-win32-arm64-0.35.3.tgz", + "integrity": "sha512-4bPwFdMbeC4JQ8L8LOyWp6nsHcboP5fxkp6iPOXz2Vg49R42TuMs2whkJ5OAP4/Ul035qOzy0AecOF9VOscn4w==", "cpu": [ "arm64" ], @@ -2414,16 +2582,16 @@ "win32" ], "engines": { - "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + "node": ">=20.9.0" }, "funding": { "url": "https://opencollective.com/libvips" } }, "node_modules/@img/sharp-win32-ia32": { - "version": "0.34.5", - "resolved": "https://registry.npmjs.org/@img/sharp-win32-ia32/-/sharp-win32-ia32-0.34.5.tgz", - "integrity": "sha512-FV9m/7NmeCmSHDD5j4+4pNI8Cp3aW+JvLoXcTUo0IqyjSfAZJ8dIUmijx1qaJsIiU+Hosw6xM5KijAWRJCSgNg==", + "version": "0.35.3", + "resolved": "https://registry.npmjs.org/@img/sharp-win32-ia32/-/sharp-win32-ia32-0.35.3.tgz", + "integrity": "sha512-r53mXsBN6lFUDiST764SvgwUdHAqM4rPAiDzAmf4fLoB6X/rkfyTrLCg6+g17wJJiCmB3JYgHuUldCWUIRFSXw==", "cpu": [ "ia32" ], @@ -2434,16 +2602,16 @@ "win32" ], "engines": { - "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + "node": "^20.9.0" }, "funding": { "url": "https://opencollective.com/libvips" } }, "node_modules/@img/sharp-win32-x64": { - "version": "0.34.5", - "resolved": "https://registry.npmjs.org/@img/sharp-win32-x64/-/sharp-win32-x64-0.34.5.tgz", - "integrity": "sha512-+29YMsqY2/9eFEiW93eqWnuLcWcufowXewwSNIT6UwZdUUCrM3oFjMWH/Z6/TMmb4hlFenmfAVbpWeup2jryCw==", + "version": "0.35.3", + "resolved": "https://registry.npmjs.org/@img/sharp-win32-x64/-/sharp-win32-x64-0.35.3.tgz", + "integrity": "sha512-D4y1vNeZrIIJCN+uHaWVtH86B+aCrdMYYjicy9pXHvbGZeGYLLSd3wdVuC37FxVXlU1ARsk84eKWfWMXGYEqvA==", "cpu": [ "x64" ], @@ -2454,7 +2622,7 @@ "win32" ], "engines": { - "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + "node": ">=20.9.0" }, "funding": { "url": "https://opencollective.com/libvips" @@ -2511,64 +2679,93 @@ "integrity": "sha512-M5UknZPHRu3DEDWoipU6sE8PdkZ6Z/S+v4dD+Ke8IaNlpdSQah50lz1KtcFBa2vsdOnwbbnxJwVM4wty6udA5w==", "license": "MIT" }, - "node_modules/@modelcontextprotocol/ext-apps": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/@modelcontextprotocol/ext-apps/-/ext-apps-1.0.0.tgz", - "integrity": "sha512-d5vGKBhWkRoa3xlKOynF8kd+sTSY2D3QSjTMCs46/ddOUOSn5e/E0SaShixFm7H7mNlj4uY0RuU0jAsPM/0qwA==", - "hasInstallScript": true, + "node_modules/@modelcontextprotocol/client": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@modelcontextprotocol/client/-/client-2.0.0.tgz", + "integrity": "sha512-8f1OghQ2rjzIOfqgUCP+8GiUWqRs89njoWLNqAe8kWmDePv3s1fZXseej+QXemssEuuOvLLmLO/kqM3IQHtISw==", "license": "MIT", - "workspaces": [ - "examples/*" - ], - "optionalDependencies": { - "@oven/bun-darwin-aarch64": "^1.2.21", - "@oven/bun-darwin-x64": "^1.2.21", - "@oven/bun-darwin-x64-baseline": "^1.2.21", - "@oven/bun-linux-aarch64": "^1.2.21", - "@oven/bun-linux-aarch64-musl": "^1.2.21", - "@oven/bun-linux-x64": "^1.2.21", - "@oven/bun-linux-x64-baseline": "^1.2.21", - "@oven/bun-linux-x64-musl": "^1.2.21", - "@oven/bun-linux-x64-musl-baseline": "^1.2.21", - "@oven/bun-windows-x64": "^1.2.21", - "@oven/bun-windows-x64-baseline": "^1.2.21", - "@rollup/rollup-darwin-arm64": "^4.53.3", - "@rollup/rollup-darwin-x64": "^4.53.3", - "@rollup/rollup-linux-arm64-gnu": "^4.53.3", - "@rollup/rollup-linux-x64-gnu": "^4.53.3", - "@rollup/rollup-win32-arm64-msvc": "^4.53.3", - "@rollup/rollup-win32-x64-msvc": "^4.53.3" + "dependencies": { + "@modelcontextprotocol/core": "2.0.0", + "cross-spawn": "^7.0.5", + "eventsource": "^3.0.2", + "eventsource-parser": "^3.0.0", + "jose": "^6.1.3", + "pkce-challenge": "^5.0.0", + "zod": "^4.2.0" + }, + "engines": { + "node": ">=20" + } + }, + "node_modules/@modelcontextprotocol/core": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@modelcontextprotocol/core/-/core-2.0.0.tgz", + "integrity": "sha512-pJCEwGG7Lfr/+PQp9ZTwKXNeO5wzbfKL7H3MYpCorM4oFBoQrdjnBgEoqG+RjhsvS1FKrDbKux+M1HhlnGWqcA==", + "license": "MIT", + "dependencies": { + "zod": "^4.2.0" + }, + "engines": { + "node": ">=20" + } + }, + "node_modules/@modelcontextprotocol/express": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@modelcontextprotocol/express/-/express-2.0.0.tgz", + "integrity": "sha512-Snlr8j9FR9LcVvEJPF7qJ7d5zTL4Bes2dk7RcacN9eSZ7OLohwxqhEvWu1+UxELyScgLbLLOdeVEGdwKI1iwVQ==", + "license": "MIT", + "dependencies": { + "cors": "^2.8.5" + }, + "engines": { + "node": ">=20" }, "peerDependencies": { - "@modelcontextprotocol/sdk": "^1.24.0", - "react": "^17.0.0 || ^18.0.0 || ^19.0.0", - "react-dom": "^17.0.0 || ^18.0.0 || ^19.0.0", - "zod": "^3.25.0 || ^4.0.0" - }, - "peerDependenciesMeta": { - "react": { - "optional": true - }, - "react-dom": { - "optional": true - } + "@modelcontextprotocol/server": "^2.0.0", + "express": "^4.18.0 || ^5.0.0" } }, + "node_modules/@modelcontextprotocol/ext-apps": { + "resolved": "", + "link": true + }, "node_modules/@modelcontextprotocol/ext-apps-basic-host": { "resolved": "examples/basic-host", "link": true }, + "node_modules/@modelcontextprotocol/node": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@modelcontextprotocol/node/-/node-2.0.0.tgz", + "integrity": "sha512-Y4hAC2XdGDUdDOCbLDOCA4+aL3NUldjsOWlDL/YwpAxrPhRm1xHd7lZ+mLacvZ9t3PaH28wgNoaLQGrIk1P2pg==", + "license": "MIT", + "dependencies": { + "@hono/node-server": "^1.19.9" + }, + "engines": { + "node": ">=20" + }, + "peerDependencies": { + "@modelcontextprotocol/server": "^2.0.0", + "hono": "^4.11.4" + }, + "peerDependenciesMeta": { + "hono": { + "optional": true + } + } + }, "node_modules/@modelcontextprotocol/quickstart": { "resolved": "examples/quickstart", "link": true }, "node_modules/@modelcontextprotocol/sdk": { - "version": "1.25.2", - "resolved": "https://registry.npmjs.org/@modelcontextprotocol/sdk/-/sdk-1.25.2.tgz", - "integrity": "sha512-LZFeo4F9M5qOhC/Uc1aQSrBHxMrvxett+9KLHt7OhcExtoiRN9DKgbZffMP/nxjutWDQpfMDfP3nkHI4X9ijww==", + "version": "1.30.0", + "resolved": "https://registry.npmjs.org/@modelcontextprotocol/sdk/-/sdk-1.30.0.tgz", + "integrity": "sha512-xKd8OIzlqNzcqcNumGAa6g+PW2kjD5vrpcKOnfldAUPP3j7lnqMPwlTXQm8gF+UwH72z0lqaRbjr9hqGz0eITA==", + "dev": true, "license": "MIT", "dependencies": { - "@hono/node-server": "^1.19.7", + "@hono/node-server": "^1.19.9 || ^2.0.5", "ajv": "^8.17.1", "ajv-formats": "^3.0.1", "content-type": "^1.0.5", @@ -2576,14 +2773,15 @@ "cross-spawn": "^7.0.5", "eventsource": "^3.0.2", "eventsource-parser": "^3.0.0", - "express": "^5.0.1", - "express-rate-limit": "^7.5.0", - "jose": "^6.1.1", + "express": "^5.2.1", + "express-rate-limit": "^8.2.1", + "hono": "^4.11.4", + "jose": "^6.1.3", "json-schema-typed": "^8.0.2", "pkce-challenge": "^5.0.0", "raw-body": "^3.0.0", "zod": "^3.25 || ^4.0", - "zod-to-json-schema": "^3.25.0" + "zod-to-json-schema": "^3.25.1" }, "engines": { "node": ">=18" @@ -2601,6 +2799,19 @@ } } }, + "node_modules/@modelcontextprotocol/server": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@modelcontextprotocol/server/-/server-2.0.0.tgz", + "integrity": "sha512-YhHWdHfpFMQfd0prsEnxKeS3Qz3ytIGmsS0sth4KDjnacIT7hxk6hXHkJ9KysxlkvTM+WZAtQbbcUhdoP4Hvtw==", + "license": "MIT", + "dependencies": { + "@modelcontextprotocol/core": "2.0.0", + "zod": "^4.2.0" + }, + "engines": { + "node": ">=20" + } + }, "node_modules/@modelcontextprotocol/server-basic-preact": { "resolved": "examples/basic-server-preact", "link": true @@ -2641,6 +2852,10 @@ "resolved": "examples/debug-server", "link": true }, + "node_modules/@modelcontextprotocol/server-lazy-auth": { + "resolved": "examples/lazy-auth-server", + "link": true + }, "node_modules/@modelcontextprotocol/server-map": { "resolved": "examples/map-server", "link": true @@ -2970,9 +3185,9 @@ } }, "node_modules/@oclif/core/node_modules/brace-expansion": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", - "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.1.2.tgz", + "integrity": "sha512-w5JZcKgdhDOgOwm8H+KgbosopHMuGcl6qbulwjtz3SM7I7P3yW1eAjzMPLrIE+NQ9vjgANKHWeMHnrT0OXW1oA==", "dev": true, "license": "MIT", "dependencies": { @@ -2980,13 +3195,13 @@ } }, "node_modules/@oclif/core/node_modules/minimatch": { - "version": "9.0.5", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", - "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", + "version": "9.0.9", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.9.tgz", + "integrity": "sha512-OBwBN9AL4dqmETlpS2zasx+vTeWclWzkblfZk7KTA5j3jeOONz/tRCnZomUyvNg83wL5Zv9Ss6HMJXAgL8R2Yg==", "dev": true, "license": "ISC", "dependencies": { - "brace-expansion": "^2.0.1" + "brace-expansion": "^2.0.2" }, "engines": { "node": ">=16 || 14 >=14.17" @@ -3002,6 +3217,7 @@ "cpu": [ "arm64" ], + "dev": true, "license": "MIT", "optional": true, "os": [ @@ -3015,6 +3231,7 @@ "cpu": [ "x64" ], + "dev": true, "license": "MIT", "optional": true, "os": [ @@ -3028,6 +3245,7 @@ "cpu": [ "x64" ], + "dev": true, "license": "MIT", "optional": true, "os": [ @@ -3041,6 +3259,7 @@ "cpu": [ "arm64" ], + "dev": true, "license": "MIT", "optional": true, "os": [ @@ -3054,6 +3273,7 @@ "cpu": [ "arm64" ], + "dev": true, "license": "MIT", "optional": true, "os": [ @@ -3067,6 +3287,7 @@ "cpu": [ "x64" ], + "dev": true, "license": "MIT", "optional": true, "os": [ @@ -3080,6 +3301,7 @@ "cpu": [ "x64" ], + "dev": true, "license": "MIT", "optional": true, "os": [ @@ -3093,6 +3315,7 @@ "cpu": [ "x64" ], + "dev": true, "license": "MIT", "optional": true, "os": [ @@ -3106,6 +3329,7 @@ "cpu": [ "x64" ], + "dev": true, "license": "MIT", "optional": true, "os": [ @@ -3133,6 +3357,7 @@ "cpu": [ "x64" ], + "dev": true, "license": "MIT", "optional": true, "os": [ @@ -3146,12 +3371,31 @@ "cpu": [ "x64" ], + "dev": true, "license": "MIT", "optional": true, "os": [ "win32" ] }, + "node_modules/@pdf-lib/standard-fonts": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@pdf-lib/standard-fonts/-/standard-fonts-1.0.0.tgz", + "integrity": "sha512-hU30BK9IUN/su0Mn9VdlVKsWBS6GyhVfqjwl1FjZN4TxP6cCw0jP2w7V3Hf5uX7M0AZJ16vey9yE0ny7Sa59ZA==", + "license": "MIT", + "dependencies": { + "pako": "^1.0.6" + } + }, + "node_modules/@pdf-lib/upng": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@pdf-lib/upng/-/upng-1.0.1.tgz", + "integrity": "sha512-dQK2FUMQtowVP00mtIksrlZhdFXQZPC+taih1q4CvPZ5vqdxR/LKBaFg0oAfzd1GlHZXXSPdQfzQnt+ViGvEIQ==", + "license": "MIT", + "dependencies": { + "pako": "^1.0.10" + } + }, "node_modules/@playwright/test": { "version": "1.57.0", "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.57.0.tgz", @@ -3253,9 +3497,9 @@ } }, "node_modules/@rollup/rollup-android-arm-eabi": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.56.0.tgz", - "integrity": "sha512-LNKIPA5k8PF1+jAFomGe3qN3bbIgJe/IlpDBwuVjrDKrJhVWywgnJvflMt/zkbVNLFtF1+94SljYQS6e99klnw==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.60.1.tgz", + "integrity": "sha512-d6FinEBLdIiK+1uACUttJKfgZREXrF0Qc2SmLII7W2AD8FfiZ9Wjd+rD/iRuf5s5dWrr1GgwXCvPqOuDquOowA==", "cpu": [ "arm" ], @@ -3267,9 +3511,9 @@ ] }, "node_modules/@rollup/rollup-android-arm64": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.56.0.tgz", - "integrity": "sha512-lfbVUbelYqXlYiU/HApNMJzT1E87UPGvzveGg2h0ktUNlOCxKlWuJ9jtfvs1sKHdwU4fzY7Pl8sAl49/XaEk6Q==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.60.1.tgz", + "integrity": "sha512-YjG/EwIDvvYI1YvYbHvDz/BYHtkY4ygUIXHnTdLhG+hKIQFBiosfWiACWortsKPKU/+dUwQQCKQM3qrDe8c9BA==", "cpu": [ "arm64" ], @@ -3281,12 +3525,13 @@ ] }, "node_modules/@rollup/rollup-darwin-arm64": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.56.0.tgz", - "integrity": "sha512-EgxD1ocWfhoD6xSOeEEwyE7tDvwTgZc8Bss7wCWe+uc7wO8G34HHCUH+Q6cHqJubxIAnQzAsyUsClt0yFLu06w==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.60.1.tgz", + "integrity": "sha512-mjCpF7GmkRtSJwon+Rq1N8+pI+8l7w5g9Z3vWj4T7abguC4Czwi3Yu/pFaLvA3TTeMVjnu3ctigusqWUfjZzvw==", "cpu": [ "arm64" ], + "dev": true, "license": "MIT", "optional": true, "os": [ @@ -3294,12 +3539,13 @@ ] }, "node_modules/@rollup/rollup-darwin-x64": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.56.0.tgz", - "integrity": "sha512-1vXe1vcMOssb/hOF8iv52A7feWW2xnu+c8BV4t1F//m9QVLTfNVpEdja5ia762j/UEJe2Z1jAmEqZAK42tVW3g==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.60.1.tgz", + "integrity": "sha512-haZ7hJ1JT4e9hqkoT9R/19XW2QKqjfJVv+i5AGg57S+nLk9lQnJ1F/eZloRO3o9Scy9CM3wQ9l+dkXtcBgN5Ew==", "cpu": [ "x64" ], + "dev": true, "license": "MIT", "optional": true, "os": [ @@ -3307,9 +3553,9 @@ ] }, "node_modules/@rollup/rollup-freebsd-arm64": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.56.0.tgz", - "integrity": "sha512-bof7fbIlvqsyv/DtaXSck4VYQ9lPtoWNFCB/JY4snlFuJREXfZnm+Ej6yaCHfQvofJDXLDMTVxWscVSuQvVWUQ==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.60.1.tgz", + "integrity": "sha512-czw90wpQq3ZsAVBlinZjAYTKduOjTywlG7fEeWKUA7oCmpA8xdTkxZZlwNJKWqILlq0wehoZcJYfBvOyhPTQ6w==", "cpu": [ "arm64" ], @@ -3321,9 +3567,9 @@ ] }, "node_modules/@rollup/rollup-freebsd-x64": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.56.0.tgz", - "integrity": "sha512-KNa6lYHloW+7lTEkYGa37fpvPq+NKG/EHKM8+G/g9WDU7ls4sMqbVRV78J6LdNuVaeeK5WB9/9VAFbKxcbXKYg==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.60.1.tgz", + "integrity": "sha512-KVB2rqsxTHuBtfOeySEyzEOB7ltlB/ux38iu2rBQzkjbwRVlkhAGIEDiiYnO2kFOkJp+Z7pUXKyrRRFuFUKt+g==", "cpu": [ "x64" ], @@ -3335,9 +3581,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm-gnueabihf": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.56.0.tgz", - "integrity": "sha512-E8jKK87uOvLrrLN28jnAAAChNq5LeCd2mGgZF+fGF5D507WlG/Noct3lP/QzQ6MrqJ5BCKNwI9ipADB6jyiq2A==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.60.1.tgz", + "integrity": "sha512-L+34Qqil+v5uC0zEubW7uByo78WOCIrBvci69E7sFASRl0X7b/MB6Cqd1lky/CtcSVTydWa2WZwFuWexjS5o6g==", "cpu": [ "arm" ], @@ -3349,9 +3595,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm-musleabihf": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.56.0.tgz", - "integrity": "sha512-jQosa5FMYF5Z6prEpTCCmzCXz6eKr/tCBssSmQGEeozA9tkRUty/5Vx06ibaOP9RCrW1Pvb8yp3gvZhHwTDsJw==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.60.1.tgz", + "integrity": "sha512-n83O8rt4v34hgFzlkb1ycniJh7IR5RCIqt6mz1VRJD6pmhRi0CXdmfnLu9dIUS6buzh60IvACM842Ffb3xd6Gg==", "cpu": [ "arm" ], @@ -3363,12 +3609,13 @@ ] }, "node_modules/@rollup/rollup-linux-arm64-gnu": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.56.0.tgz", - "integrity": "sha512-uQVoKkrC1KGEV6udrdVahASIsaF8h7iLG0U0W+Xn14ucFwi6uS539PsAr24IEF9/FoDtzMeeJXJIBo5RkbNWvQ==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.60.1.tgz", + "integrity": "sha512-Nql7sTeAzhTAja3QXeAI48+/+GjBJ+QmAH13snn0AJSNL50JsDqotyudHyMbO2RbJkskbMbFJfIJKWA6R1LCJQ==", "cpu": [ "arm64" ], + "dev": true, "license": "MIT", "optional": true, "os": [ @@ -3376,9 +3623,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm64-musl": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.56.0.tgz", - "integrity": "sha512-vLZ1yJKLxhQLFKTs42RwTwa6zkGln+bnXc8ueFGMYmBTLfNu58sl5/eXyxRa2RarTkJbXl8TKPgfS6V5ijNqEA==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.60.1.tgz", + "integrity": "sha512-+pUymDhd0ys9GcKZPPWlFiZ67sTWV5UU6zOJat02M1+PiuSGDziyRuI/pPue3hoUwm2uGfxdL+trT6Z9rxnlMA==", "cpu": [ "arm64" ], @@ -3390,9 +3637,9 @@ ] }, "node_modules/@rollup/rollup-linux-loong64-gnu": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-gnu/-/rollup-linux-loong64-gnu-4.56.0.tgz", - "integrity": "sha512-FWfHOCub564kSE3xJQLLIC/hbKqHSVxy8vY75/YHHzWvbJL7aYJkdgwD/xGfUlL5UV2SB7otapLrcCj2xnF1dg==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-gnu/-/rollup-linux-loong64-gnu-4.60.1.tgz", + "integrity": "sha512-VSvgvQeIcsEvY4bKDHEDWcpW4Yw7BtlKG1GUT4FzBUlEKQK0rWHYBqQt6Fm2taXS+1bXvJT6kICu5ZwqKCnvlQ==", "cpu": [ "loong64" ], @@ -3404,9 +3651,9 @@ ] }, "node_modules/@rollup/rollup-linux-loong64-musl": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-musl/-/rollup-linux-loong64-musl-4.56.0.tgz", - "integrity": "sha512-z1EkujxIh7nbrKL1lmIpqFTc/sr0u8Uk0zK/qIEFldbt6EDKWFk/pxFq3gYj4Bjn3aa9eEhYRlL3H8ZbPT1xvA==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-musl/-/rollup-linux-loong64-musl-4.60.1.tgz", + "integrity": "sha512-4LqhUomJqwe641gsPp6xLfhqWMbQV04KtPp7/dIp0nzPxAkNY1AbwL5W0MQpcalLYk07vaW9Kp1PBhdpZYYcEw==", "cpu": [ "loong64" ], @@ -3418,9 +3665,9 @@ ] }, "node_modules/@rollup/rollup-linux-ppc64-gnu": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.56.0.tgz", - "integrity": "sha512-iNFTluqgdoQC7AIE8Q34R3AuPrJGJirj5wMUErxj22deOcY7XwZRaqYmB6ZKFHoVGqRcRd0mqO+845jAibKCkw==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.60.1.tgz", + "integrity": "sha512-tLQQ9aPvkBxOc/EUT6j3pyeMD6Hb8QF2BTBnCQWP/uu1lhc9AIrIjKnLYMEroIz/JvtGYgI9dF3AxHZNaEH0rw==", "cpu": [ "ppc64" ], @@ -3432,9 +3679,9 @@ ] }, "node_modules/@rollup/rollup-linux-ppc64-musl": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-musl/-/rollup-linux-ppc64-musl-4.56.0.tgz", - "integrity": "sha512-MtMeFVlD2LIKjp2sE2xM2slq3Zxf9zwVuw0jemsxvh1QOpHSsSzfNOTH9uYW9i1MXFxUSMmLpeVeUzoNOKBaWg==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-musl/-/rollup-linux-ppc64-musl-4.60.1.tgz", + "integrity": "sha512-RMxFhJwc9fSXP6PqmAz4cbv3kAyvD1etJFjTx4ONqFP9DkTkXsAMU4v3Vyc5BgzC+anz7nS/9tp4obsKfqkDHg==", "cpu": [ "ppc64" ], @@ -3446,9 +3693,9 @@ ] }, "node_modules/@rollup/rollup-linux-riscv64-gnu": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.56.0.tgz", - "integrity": "sha512-in+v6wiHdzzVhYKXIk5U74dEZHdKN9KH0Q4ANHOTvyXPG41bajYRsy7a8TPKbYPl34hU7PP7hMVHRvv/5aCSew==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.60.1.tgz", + "integrity": "sha512-QKgFl+Yc1eEk6MmOBfRHYF6lTxiiiV3/z/BRrbSiW2I7AFTXoBFvdMEyglohPj//2mZS4hDOqeB0H1ACh3sBbg==", "cpu": [ "riscv64" ], @@ -3460,9 +3707,9 @@ ] }, "node_modules/@rollup/rollup-linux-riscv64-musl": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.56.0.tgz", - "integrity": "sha512-yni2raKHB8m9NQpI9fPVwN754mn6dHQSbDTwxdr9SE0ks38DTjLMMBjrwvB5+mXrX+C0npX0CVeCUcvvvD8CNQ==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.60.1.tgz", + "integrity": "sha512-RAjXjP/8c6ZtzatZcA1RaQr6O1TRhzC+adn8YZDnChliZHviqIjmvFwHcxi4JKPSDAt6Uhf/7vqcBzQJy0PDJg==", "cpu": [ "riscv64" ], @@ -3474,9 +3721,9 @@ ] }, "node_modules/@rollup/rollup-linux-s390x-gnu": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.56.0.tgz", - "integrity": "sha512-zhLLJx9nQPu7wezbxt2ut+CI4YlXi68ndEve16tPc/iwoylWS9B3FxpLS2PkmfYgDQtosah07Mj9E0khc3Y+vQ==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.60.1.tgz", + "integrity": "sha512-wcuocpaOlaL1COBYiA89O6yfjlp3RwKDeTIA0hM7OpmhR1Bjo9j31G1uQVpDlTvwxGn2nQs65fBFL5UFd76FcQ==", "cpu": [ "s390x" ], @@ -3488,12 +3735,13 @@ ] }, "node_modules/@rollup/rollup-linux-x64-gnu": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.56.0.tgz", - "integrity": "sha512-MVC6UDp16ZSH7x4rtuJPAEoE1RwS8N4oK9DLHy3FTEdFoUTCFVzMfJl/BVJ330C+hx8FfprA5Wqx4FhZXkj2Kw==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.60.1.tgz", + "integrity": "sha512-77PpsFQUCOiZR9+LQEFg9GClyfkNXj1MP6wRnzYs0EeWbPcHs02AXu4xuUbM1zhwn3wqaizle3AEYg5aeoohhg==", "cpu": [ "x64" ], + "dev": true, "license": "MIT", "optional": true, "os": [ @@ -3501,9 +3749,9 @@ ] }, "node_modules/@rollup/rollup-linux-x64-musl": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.56.0.tgz", - "integrity": "sha512-ZhGH1eA4Qv0lxaV00azCIS1ChedK0V32952Md3FtnxSqZTBTd6tgil4nZT5cU8B+SIw3PFYkvyR4FKo2oyZIHA==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.60.1.tgz", + "integrity": "sha512-5cIATbk5vynAjqqmyBjlciMJl1+R/CwX9oLk/EyiFXDWd95KpHdrOJT//rnUl4cUcskrd0jCCw3wpZnhIHdD9w==", "cpu": [ "x64" ], @@ -3515,9 +3763,9 @@ ] }, "node_modules/@rollup/rollup-openbsd-x64": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-openbsd-x64/-/rollup-openbsd-x64-4.56.0.tgz", - "integrity": "sha512-O16XcmyDeFI9879pEcmtWvD/2nyxR9mF7Gs44lf1vGGx8Vg2DRNx11aVXBEqOQhWb92WN4z7fW/q4+2NYzCbBA==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openbsd-x64/-/rollup-openbsd-x64-4.60.1.tgz", + "integrity": "sha512-cl0w09WsCi17mcmWqqglez9Gk8isgeWvoUZ3WiJFYSR3zjBQc2J5/ihSjpl+VLjPqjQ/1hJRcqBfLjssREQILw==", "cpu": [ "x64" ], @@ -3529,9 +3777,9 @@ ] }, "node_modules/@rollup/rollup-openharmony-arm64": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.56.0.tgz", - "integrity": "sha512-LhN/Reh+7F3RCgQIRbgw8ZMwUwyqJM+8pXNT6IIJAqm2IdKkzpCh/V9EdgOMBKuebIrzswqy4ATlrDgiOwbRcQ==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.60.1.tgz", + "integrity": "sha512-4Cv23ZrONRbNtbZa37mLSueXUCtN7MXccChtKpUnQNgF010rjrjfHx3QxkS2PI7LqGT5xXyYs1a7LbzAwT0iCA==", "cpu": [ "arm64" ], @@ -3543,12 +3791,13 @@ ] }, "node_modules/@rollup/rollup-win32-arm64-msvc": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.56.0.tgz", - "integrity": "sha512-kbFsOObXp3LBULg1d3JIUQMa9Kv4UitDmpS+k0tinPBz3watcUiV2/LUDMMucA6pZO3WGE27P7DsfaN54l9ing==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.60.1.tgz", + "integrity": "sha512-i1okWYkA4FJICtr7KpYzFpRTHgy5jdDbZiWfvny21iIKky5YExiDXP+zbXzm3dUcFpkEeYNHgQ5fuG236JPq0g==", "cpu": [ "arm64" ], + "dev": true, "license": "MIT", "optional": true, "os": [ @@ -3556,9 +3805,9 @@ ] }, "node_modules/@rollup/rollup-win32-ia32-msvc": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.56.0.tgz", - "integrity": "sha512-vSSgny54D6P4vf2izbtFm/TcWYedw7f8eBrOiGGecyHyQB9q4Kqentjaj8hToe+995nob/Wv48pDqL5a62EWtg==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.60.1.tgz", + "integrity": "sha512-u09m3CuwLzShA0EYKMNiFgcjjzwqtUMLmuCJLeZWjjOYA3IT2Di09KaxGBTP9xVztWyIWjVdsB2E9goMjZvTQg==", "cpu": [ "ia32" ], @@ -3570,9 +3819,9 @@ ] }, "node_modules/@rollup/rollup-win32-x64-gnu": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-gnu/-/rollup-win32-x64-gnu-4.56.0.tgz", - "integrity": "sha512-FeCnkPCTHQJFbiGG49KjV5YGW/8b9rrXAM2Mz2kiIoktq2qsJxRD5giEMEOD2lPdgs72upzefaUvS+nc8E3UzQ==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-gnu/-/rollup-win32-x64-gnu-4.60.1.tgz", + "integrity": "sha512-k+600V9Zl1CM7eZxJgMyTUzmrmhB/0XZnF4pRypKAlAgxmedUA+1v9R+XOFv56W4SlHEzfeMtzujLJD22Uz5zg==", "cpu": [ "x64" ], @@ -3584,12 +3833,13 @@ ] }, "node_modules/@rollup/rollup-win32-x64-msvc": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.56.0.tgz", - "integrity": "sha512-H8AE9Ur/t0+1VXujj90w0HrSOuv0Nq9r1vSZF2t5km20NTfosQsGGUXDaKdQZzwuLts7IyL1fYT4hM95TI9c4g==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.60.1.tgz", + "integrity": "sha512-lWMnixq/QzxyhTV6NjQJ4SFo1J6PvOX8vUx5Wb4bBPsEb+8xZ89Bz6kOXpfXj9ak9AHTQVQzlgzBEc1SyM27xQ==", "cpu": [ "x64" ], + "dev": true, "license": "MIT", "optional": true, "os": [ @@ -3645,10 +3895,16 @@ "dev": true, "license": "MIT" }, + "node_modules/@standard-schema/spec": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@standard-schema/spec/-/spec-1.1.0.tgz", + "integrity": "sha512-l2aFy5jALhniG5HgqrD6jXLi/rUWrKvqN/qJx6yoJsgKhblVd+iqqU4RCXavm/jPityDo5TCvKMnpjKnOriy0w==", + "license": "MIT" + }, "node_modules/@sveltejs/acorn-typescript": { - "version": "1.0.8", - "resolved": "https://registry.npmjs.org/@sveltejs/acorn-typescript/-/acorn-typescript-1.0.8.tgz", - "integrity": "sha512-esgN+54+q0NjB0Y/4BomT9samII7jGwNy/2a3wNZbT2A2RpmXsXwUt24LvLhx6jUq2gVk4cWEvcRO6MFQbOfNA==", + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/@sveltejs/acorn-typescript/-/acorn-typescript-1.0.10.tgz", + "integrity": "sha512-4WfKk68eTih+MiJD4fSbxN7E8kVBmTMPWHUPYjvl2N0rMs53YLTT8/YjKU5Dtnz5LqDjl7LEw4U7lXR2W3J5WA==", "license": "MIT", "peerDependencies": { "acorn": "^8.9.0" @@ -3767,17 +4023,6 @@ "bun-types": "1.3.6" } }, - "node_modules/@types/chai": { - "version": "5.2.3", - "resolved": "https://registry.npmjs.org/@types/chai/-/chai-5.2.3.tgz", - "integrity": "sha512-Mw558oeA9fFbv65/y4mHtXDs9bPnFMZAL/jxdPFUpOHHIXX91mcgEHbS5Lahr+pwZFR8A7GQleRWeI6cGFC2UA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/deep-eql": "*", - "assertion-error": "^2.0.1" - } - }, "node_modules/@types/connect": { "version": "3.4.38", "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.38.tgz", @@ -3798,13 +4043,6 @@ "@types/node": "*" } }, - "node_modules/@types/deep-eql": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/@types/deep-eql/-/deep-eql-4.0.2.tgz", - "integrity": "sha512-c9h9dVVMigMPc4bwTvC5dxqtqJZwQPePsWjPlpSOnojbor6pGqdk541lfA7AqFQr5pB1BRdq0juY9db81BwyFw==", - "dev": true, - "license": "MIT" - }, "node_modules/@types/dom-speech-recognition": { "version": "0.0.7", "resolved": "https://registry.npmjs.org/@types/dom-speech-recognition/-/dom-speech-recognition-0.0.7.tgz", @@ -3948,6 +4186,12 @@ "meshoptimizer": "~0.22.0" } }, + "node_modules/@types/trusted-types": { + "version": "2.0.7", + "resolved": "https://registry.npmjs.org/@types/trusted-types/-/trusted-types-2.0.7.tgz", + "integrity": "sha512-ScaPdn1dQczgbl0QFTeTOmVHFULt394XJgOQNoyVhZ6r2vLnMLJfBPd53SB52T/3G36VI1/g2MZaX0cwDuXsfw==", + "license": "MIT" + }, "node_modules/@types/unist": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/@types/unist/-/unist-3.0.3.tgz", @@ -4010,131 +4254,6 @@ "vue": "^3.2.25" } }, - "node_modules/@vitest/expect": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-3.2.4.tgz", - "integrity": "sha512-Io0yyORnB6sikFlt8QW5K7slY4OjqNX9jmJQ02QDda8lyM6B5oNgVWoSoKPac8/kgnCUzuHQKrSLtu/uOqqrig==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/chai": "^5.2.2", - "@vitest/spy": "3.2.4", - "@vitest/utils": "3.2.4", - "chai": "^5.2.0", - "tinyrainbow": "^2.0.0" - }, - "funding": { - "url": "https://opencollective.com/vitest" - } - }, - "node_modules/@vitest/mocker": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-3.2.4.tgz", - "integrity": "sha512-46ryTE9RZO/rfDd7pEqFl7etuyzekzEhUbTW3BvmeO/BcCMEgq59BKhek3dXDWgAj4oMK6OZi+vRr1wPW6qjEQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@vitest/spy": "3.2.4", - "estree-walker": "^3.0.3", - "magic-string": "^0.30.17" - }, - "funding": { - "url": "https://opencollective.com/vitest" - }, - "peerDependencies": { - "msw": "^2.4.9", - "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0" - }, - "peerDependenciesMeta": { - "msw": { - "optional": true - }, - "vite": { - "optional": true - } - } - }, - "node_modules/@vitest/mocker/node_modules/estree-walker": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", - "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/estree": "^1.0.0" - } - }, - "node_modules/@vitest/pretty-format": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-3.2.4.tgz", - "integrity": "sha512-IVNZik8IVRJRTr9fxlitMKeJeXFFFN0JaB9PHPGQ8NKQbGpfjlTx9zO4RefN8gp7eqjNy8nyK3NZmBzOPeIxtA==", - "dev": true, - "license": "MIT", - "dependencies": { - "tinyrainbow": "^2.0.0" - }, - "funding": { - "url": "https://opencollective.com/vitest" - } - }, - "node_modules/@vitest/runner": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-3.2.4.tgz", - "integrity": "sha512-oukfKT9Mk41LreEW09vt45f8wx7DordoWUZMYdY/cyAk7w5TWkTRCNZYF7sX7n2wB7jyGAl74OxgwhPgKaqDMQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@vitest/utils": "3.2.4", - "pathe": "^2.0.3", - "strip-literal": "^3.0.0" - }, - "funding": { - "url": "https://opencollective.com/vitest" - } - }, - "node_modules/@vitest/snapshot": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-3.2.4.tgz", - "integrity": "sha512-dEYtS7qQP2CjU27QBC5oUOxLE/v5eLkGqPE0ZKEIDGMs4vKWe7IjgLOeauHsR0D5YuuycGRO5oSRXnwnmA78fQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@vitest/pretty-format": "3.2.4", - "magic-string": "^0.30.17", - "pathe": "^2.0.3" - }, - "funding": { - "url": "https://opencollective.com/vitest" - } - }, - "node_modules/@vitest/spy": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-3.2.4.tgz", - "integrity": "sha512-vAfasCOe6AIK70iP5UD11Ac4siNUNJ9i/9PZ3NKx07sG6sUxeag1LWdNrMWeKKYBLlzuK+Gn65Yd5nyL6ds+nw==", - "dev": true, - "license": "MIT", - "dependencies": { - "tinyspy": "^4.0.3" - }, - "funding": { - "url": "https://opencollective.com/vitest" - } - }, - "node_modules/@vitest/utils": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-3.2.4.tgz", - "integrity": "sha512-fB2V0JFrQSMsCo9HiSq3Ezpdv4iYaXRG1Sx8edX3MwxfyNn83mKiGzOcH+Fkxt4MHxr3y42fQi1oeAInqgX2QA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@vitest/pretty-format": "3.2.4", - "loupe": "^3.1.4", - "tinyrainbow": "^2.0.0" - }, - "funding": { - "url": "https://opencollective.com/vitest" - } - }, "node_modules/@vue/compiler-core": { "version": "3.5.27", "resolved": "https://registry.npmjs.org/@vue/compiler-core/-/compiler-core-3.5.27.tgz", @@ -4288,9 +4407,9 @@ } }, "node_modules/acorn": { - "version": "8.15.0", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.15.0.tgz", - "integrity": "sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==", + "version": "8.16.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.16.0.tgz", + "integrity": "sha512-UVJyE9MttOsBQIDKw1skb9nAwQuR5wuGD3+82K6JgJlm/Y+KI92oNsMNGZCYdDsVtRHSak0pcV5Dno5+4jh9sw==", "license": "MIT", "bin": { "acorn": "bin/acorn" @@ -4300,9 +4419,10 @@ } }, "node_modules/ajv": { - "version": "8.17.1", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz", - "integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==", + "version": "8.20.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.20.0.tgz", + "integrity": "sha512-Thbli+OlOj+iMPYFBVBfJ3OmCAnaSyNn4M1vz9T6Gka5Jt9ba/HIR56joy65tY6kx/FCF5VXNB819Y7/GUrBGA==", + "dev": true, "license": "MIT", "dependencies": { "fast-deep-equal": "^3.1.3", @@ -4319,6 +4439,7 @@ "version": "3.0.1", "resolved": "https://registry.npmjs.org/ajv-formats/-/ajv-formats-3.0.1.tgz", "integrity": "sha512-8iUql50EUR+uUcdRQ3HDqa6EVyo3docL8g5WJ3FNcWmu62IbkGUue/pEyLBW8VGKKucTPgqeks4fIU1DA4yowQ==", + "dev": true, "license": "MIT", "dependencies": { "ajv": "^8.0.0" @@ -4409,24 +4530,14 @@ "license": "Python-2.0" }, "node_modules/aria-query": { - "version": "5.3.2", - "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.3.2.tgz", - "integrity": "sha512-COROpnaoap1E2F000S62r6A60uHZnmlvomhfyT2DlTcrY1OrBKn2UhH7qn5wTC9zMvD0AY7csdPSNwKP+7WiQw==", + "version": "5.3.1", + "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.3.1.tgz", + "integrity": "sha512-Z/ZeOgVl7bcSYZ/u/rh0fOpvEpq//LZmdbkXyc7syVzjPAhfOa9ebsdTSjEBDU4vs5nC98Kfduj1uFo0qyET3g==", "license": "Apache-2.0", "engines": { "node": ">= 0.4" } }, - "node_modules/assertion-error": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-2.0.1.tgz", - "integrity": "sha512-Izi8RQcffqCeNVgFigKli1ssklIbpHnCYc6AknXGYoB6grJqyeby7jv12JUQgmTAnIDnbck1uxksT4dzN3PWBA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - } - }, "node_modules/async": { "version": "3.2.6", "resolved": "https://registry.npmjs.org/async/-/async-3.2.6.tgz", @@ -4444,9 +4555,9 @@ } }, "node_modules/babel-plugin-jsx-dom-expressions": { - "version": "0.40.3", - "resolved": "https://registry.npmjs.org/babel-plugin-jsx-dom-expressions/-/babel-plugin-jsx-dom-expressions-0.40.3.tgz", - "integrity": "sha512-5HOwwt0BYiv/zxl7j8Pf2bGL6rDXfV6nUhLs8ygBX+EFJXzBPHM/euj9j/6deMZ6wa52Wb2PBaAV5U/jKwIY1w==", + "version": "0.40.6", + "resolved": "https://registry.npmjs.org/babel-plugin-jsx-dom-expressions/-/babel-plugin-jsx-dom-expressions-0.40.6.tgz", + "integrity": "sha512-v3P1MW46Lm7VMpAkq0QfyzLWWkC8fh+0aE5Km4msIgDx5kjenHU0pF2s+4/NH8CQn/kla6+Hvws+2AF7bfV5qQ==", "dev": true, "license": "MIT", "dependencies": { @@ -4484,17 +4595,17 @@ } }, "node_modules/babel-preset-solid": { - "version": "1.9.10", - "resolved": "https://registry.npmjs.org/babel-preset-solid/-/babel-preset-solid-1.9.10.tgz", - "integrity": "sha512-HCelrgua/Y+kqO8RyL04JBWS/cVdrtUv/h45GntgQY+cJl4eBcKkCDV3TdMjtKx1nXwRaR9QXslM/Npm1dxdZQ==", + "version": "1.9.12", + "resolved": "https://registry.npmjs.org/babel-preset-solid/-/babel-preset-solid-1.9.12.tgz", + "integrity": "sha512-LLqnuKVDlKpyBlMPcH6qEvs/wmS9a+NczppxJ3ryS/c0O5IiSFOIBQi9GzyiGDSbcJpx4Gr87jyFTos1MyEuWg==", "dev": true, "license": "MIT", "dependencies": { - "babel-plugin-jsx-dom-expressions": "^0.40.3" + "babel-plugin-jsx-dom-expressions": "^0.40.6" }, "peerDependencies": { "@babel/core": "^7.0.0", - "solid-js": "^1.9.10" + "solid-js": "^1.9.12" }, "peerDependenciesMeta": { "solid-js": { @@ -4510,13 +4621,16 @@ "license": "MIT" }, "node_modules/baseline-browser-mapping": { - "version": "2.9.18", - "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.9.18.tgz", - "integrity": "sha512-e23vBV1ZLfjb9apvfPk4rHVu2ry6RIr2Wfs+O324okSidrX7pTAnEJPCh/O5BtRlr7QtZI7ktOP3vsqr7Z5XoA==", + "version": "2.11.1", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.11.1.tgz", + "integrity": "sha512-HYXq73DDpCtNzOmrFsm9eSwCvWCql0RzqjpDzXN9EadiLJ4DNat0nsZ/Bzmy+Ud12mb4/zKDY0cQ805ZzN+i0A==", "dev": true, "license": "Apache-2.0", "bin": { - "baseline-browser-mapping": "dist/cli.js" + "baseline-browser-mapping": "dist/cli.cjs" + }, + "engines": { + "node": ">=6.0.0" } }, "node_modules/bezier-js": { @@ -4544,20 +4658,20 @@ } }, "node_modules/body-parser": { - "version": "2.2.2", - "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-2.2.2.tgz", - "integrity": "sha512-oP5VkATKlNwcgvxi0vM0p/D3n2C3EReYVX+DNYs5TjZFn/oQt2j+4sVJtSMr18pdRr8wjTcBl6LoV+FUwzPmNA==", + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-2.3.0.tgz", + "integrity": "sha512-2cGmJupaNgg+QUwVLAucDuWuoMZ6EX9iHDRswZ5lsNYEmwPaRknMPCLZz07yTzVq/83p4o/wzbDZbBrTvGGTIw==", "license": "MIT", "dependencies": { "bytes": "^3.1.2", - "content-type": "^1.0.5", + "content-type": "^2.0.0", "debug": "^4.4.3", - "http-errors": "^2.0.0", - "iconv-lite": "^0.7.0", + "http-errors": "^2.0.1", + "iconv-lite": "^0.7.2", "on-finished": "^2.4.1", - "qs": "^6.14.1", - "raw-body": "^3.0.1", - "type-is": "^2.0.1" + "qs": "^6.15.2", + "raw-body": "^3.0.2", + "type-is": "^2.1.0" }, "engines": { "node": ">=18" @@ -4567,6 +4681,19 @@ "url": "https://opencollective.com/express" } }, + "node_modules/body-parser/node_modules/content-type": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/content-type/-/content-type-2.0.0.tgz", + "integrity": "sha512-j/O/d7GcZCyNl7/hwZAb606rzqkyvaDctLmckbxLzHvFBzTJHuGEdodATcP3yIRoDrLHkIATJuvzbFlp/ki2cQ==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, "node_modules/body-parser/node_modules/iconv-lite": { "version": "0.7.2", "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.7.2.tgz", @@ -4590,9 +4717,9 @@ "license": "ISC" }, "node_modules/brace-expansion": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz", - "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", + "version": "1.1.16", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.16.tgz", + "integrity": "sha512-IDw48K2/2kRkg9LdJxurvq3lV3aBgq0REY89duEqFRthjlPdXHKMj7EnQOXVckxzgisinf3nHfrcE2FufFLXMw==", "dev": true, "license": "MIT", "dependencies": { @@ -4614,9 +4741,9 @@ } }, "node_modules/browserslist": { - "version": "4.28.1", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.28.1.tgz", - "integrity": "sha512-ZC5Bd0LgJXgwGqUknZY/vkUQ04r8NXnJZ3yYi4vDmSiZmC/pdSN0NbNRPxZpbtO4uAfDUAFffO8IZoM3Gj8IkA==", + "version": "4.28.7", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.28.7.tgz", + "integrity": "sha512-JxV13hNrFxqjOc8alRbq9dK1MM79NEXYpma2B2J4wAtpWS5zIEIKqWPGCl7N4o7Uc7B7itylh7SuDujATRyyTw==", "dev": true, "funding": [ { @@ -4634,11 +4761,11 @@ ], "license": "MIT", "dependencies": { - "baseline-browser-mapping": "^2.9.0", - "caniuse-lite": "^1.0.30001759", - "electron-to-chromium": "^1.5.263", - "node-releases": "^2.0.27", - "update-browserslist-db": "^1.2.0" + "baseline-browser-mapping": "^2.10.44", + "caniuse-lite": "^1.0.30001806", + "electron-to-chromium": "^1.5.393", + "node-releases": "^2.0.51", + "update-browserslist-db": "^1.2.3" }, "bin": { "browserslist": "cli.js" @@ -4647,6 +4774,34 @@ "node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7" } }, + "node_modules/browserslist/node_modules/caniuse-lite": { + "version": "1.0.30001806", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001806.tgz", + "integrity": "sha512-72Cuvd95zbSYPKq6Fhg8eDJRlzgWDf7/mtoZv6Qe/DYNCEBdNxoA3+rZAU2ZhGCpZlns3EssFavaZomckT5Uuw==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/caniuse-lite" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "CC-BY-4.0" + }, + "node_modules/browserslist/node_modules/electron-to-chromium": { + "version": "1.5.395", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.395.tgz", + "integrity": "sha512-7zt9Aw+SrmxLWLN0zhaTWZQiCdryLVrYTq5R7iZakLvi2UQPYMMsROYV/2qVCzMeCiSXHwKOU+sZ4zOVVlrtKA==", + "dev": true, + "license": "ISC" + }, "node_modules/bun": { "version": "1.3.10", "resolved": "https://registry.npmjs.org/bun/-/bun-1.3.10.tgz", @@ -4701,16 +4856,6 @@ "node": ">= 0.8" } }, - "node_modules/cac": { - "version": "6.7.14", - "resolved": "https://registry.npmjs.org/cac/-/cac-6.7.14.tgz", - "integrity": "sha512-b6Ilus+c3RrdDk+JhLKUAQfzzgLEPy6wcXqS7f/xe1EETvsDP6GORG7SFuOs6cID5YkqchW/LXZbX5bc8j7ZcQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, "node_modules/call-bind-apply-helpers": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz", @@ -4774,23 +4919,6 @@ "node": ">=12" } }, - "node_modules/chai": { - "version": "5.3.3", - "resolved": "https://registry.npmjs.org/chai/-/chai-5.3.3.tgz", - "integrity": "sha512-4zNhdJD/iOjSH0A05ea+Ke6MU5mmpQcbQsSOkgdaUMJ9zTlDTD/GYlwohmIE2u0gaxHYiVHEn1Fw9mZ/ktJWgw==", - "dev": true, - "license": "MIT", - "dependencies": { - "assertion-error": "^2.0.1", - "check-error": "^2.1.1", - "deep-eql": "^5.0.1", - "loupe": "^3.1.0", - "pathval": "^2.0.0" - }, - "engines": { - "node": ">=18" - } - }, "node_modules/chalk": { "version": "4.1.2", "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", @@ -4833,16 +4961,6 @@ "pnpm": ">=8" } }, - "node_modules/check-error": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/check-error/-/check-error-2.1.3.tgz", - "integrity": "sha512-PAJdDJusoxnwm1VwW07VWwUN1sl7smmC3OKggvndJFadxxDRyFJBX/ggnu/KE4kQAB7a3Dp8f/YXC1FlUprWmA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 16" - } - }, "node_modules/cheerio": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/cheerio/-/cheerio-1.1.2.tgz", @@ -5036,11 +5154,23 @@ "node": ">=6" } }, + "node_modules/color": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/color/-/color-4.2.3.tgz", + "integrity": "sha512-1rXeuUUiGGrykh+CeBdu5Ie7OJwinCgQY0bc7GCRxy5xVHy+moaqkpL/jqQq0MtQOeYcrqEz4abc5f0KtU7W4A==", + "license": "MIT", + "dependencies": { + "color-convert": "^2.0.1", + "color-string": "^1.9.0" + }, + "engines": { + "node": ">=12.5.0" + } + }, "node_modules/color-convert": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", - "dev": true, "license": "MIT", "dependencies": { "color-name": "~1.1.4" @@ -5053,9 +5183,18 @@ "version": "1.1.4", "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", - "dev": true, "license": "MIT" }, + "node_modules/color-string": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/color-string/-/color-string-1.9.1.tgz", + "integrity": "sha512-shrVawQFojnZv6xM40anx4CkoDP+fZsw/ZerEMsW/pyzsRbElpsL/DBVW7q3ExxwusdNXI3lXpuhEZkzs8p5Eg==", + "license": "MIT", + "dependencies": { + "color-name": "^1.0.0", + "simple-swizzle": "^0.2.2" + } + }, "node_modules/colorette": { "version": "2.0.20", "resolved": "https://registry.npmjs.org/colorette/-/colorette-2.0.20.tgz", @@ -5071,15 +5210,15 @@ "license": "MIT" }, "node_modules/concurrently": { - "version": "9.2.1", - "resolved": "https://registry.npmjs.org/concurrently/-/concurrently-9.2.1.tgz", - "integrity": "sha512-fsfrO0MxV64Znoy8/l1vVIjjHa29SZyyqPgQBwhiDcaW8wJc2W3XWVOGx4M3oJBnv/zdUZIIp1gDeS98GzP8Ng==", + "version": "9.2.4", + "resolved": "https://registry.npmjs.org/concurrently/-/concurrently-9.2.4.tgz", + "integrity": "sha512-TZ0CEhyzvFjgtAvHTusDMgj7wNdihCh7LLLrzdUOXIhdlnL2JBBGA9eJxR24rtqgmdjh3OA3hrN1rCHj6HM8qA==", "dev": true, "license": "MIT", "dependencies": { "chalk": "4.1.2", "rxjs": "7.8.2", - "shell-quote": "1.8.3", + "shell-quote": "1.9.0", "supports-color": "8.1.1", "tree-kill": "1.2.2", "yargs": "17.7.2" @@ -5187,6 +5326,12 @@ "node": ">= 8" } }, + "node_modules/crypto-js": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/crypto-js/-/crypto-js-4.2.0.tgz", + "integrity": "sha512-KALDyEYgpY+Rlob/iriUtjV6d5Eq+Y191A5g4UqLAi8CyGP9N1+FdVbkc1SxKc2r4YAYqG8JzO2KGL+AizD70Q==", + "license": "MIT" + }, "node_modules/css-select": { "version": "5.2.2", "resolved": "https://registry.npmjs.org/css-select/-/css-select-5.2.2.tgz", @@ -5473,16 +5618,6 @@ } } }, - "node_modules/deep-eql": { - "version": "5.0.2", - "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-5.0.2.tgz", - "integrity": "sha512-h5k/5U50IJJFpzfL6nO9jaaumfjO/f2NjK/oYB2Djzm4p9L+3T9qWpZqZ2hAbLPuuYq9wrU08WQyBTL5GbPk5Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, "node_modules/deepmerge": { "version": "4.3.1", "resolved": "https://registry.npmjs.org/deepmerge/-/deepmerge-4.3.1.tgz", @@ -5513,9 +5648,9 @@ } }, "node_modules/devalue": { - "version": "5.6.2", - "resolved": "https://registry.npmjs.org/devalue/-/devalue-5.6.2.tgz", - "integrity": "sha512-nPRkjWzzDQlsejL1WVifk5rvcFi/y1onBRxjaFMjZeR9mFpqu2gmAZ9xUB9/IEanEP/vBtGeGganC/GO1fmufg==", + "version": "5.8.1", + "resolved": "https://registry.npmjs.org/devalue/-/devalue-5.8.1.tgz", + "integrity": "sha512-4CXDYRBGqN+57wVJkuXBYmpAVUSg3L6JAQa/DFqm238G73E1wuyc/JhGQJzN7vUf/CMphYau2zXbfWzDR5aTEw==", "license": "MIT" }, "node_modules/dom-serializer": { @@ -5688,13 +5823,6 @@ "node": ">= 0.4" } }, - "node_modules/es-module-lexer": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.7.0.tgz", - "integrity": "sha512-jEQoCwk8hyb2AZziIOLhDqpm5+2ww5uIE6lkO/6jcOCusfk6LhMHpXXfBLXTZ7Ydyt0j4VoUQv6uGNYbdW+kBA==", - "dev": true, - "license": "MIT" - }, "node_modules/es-object-atoms": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.1.tgz", @@ -5785,12 +5913,20 @@ "license": "MIT" }, "node_modules/esrap": { - "version": "2.2.2", - "resolved": "https://registry.npmjs.org/esrap/-/esrap-2.2.2.tgz", - "integrity": "sha512-zA6497ha+qKvoWIK+WM9NAh5ni17sKZKhbS5B3PoYbBvaYHZWoS33zmFybmyqpn07RLUxSmn+RCls2/XF+d0oQ==", + "version": "2.2.11", + "resolved": "https://registry.npmjs.org/esrap/-/esrap-2.2.11.tgz", + "integrity": "sha512-gPdx+I+BjYEinNMQaBXFjbaJVyoPMU4ZODg5mE+M4DqVG9VusAVHHjcBX+zqyITlI0DIARwDMMzZwAWj36dRoQ==", "license": "MIT", "dependencies": { "@jridgewell/sourcemap-codec": "^1.4.15" + }, + "peerDependencies": { + "@typescript-eslint/types": "^8.2.0" + }, + "peerDependenciesMeta": { + "@typescript-eslint/types": { + "optional": true + } } }, "node_modules/estree-walker": { @@ -5836,16 +5972,6 @@ "node": ">=18.0.0" } }, - "node_modules/expect-type": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/expect-type/-/expect-type-1.3.0.tgz", - "integrity": "sha512-knvyeauYhqjOYvQ66MznSMs83wmHrCycNEN6Ao+2AeYEfxUIkuiVxdEa1qlGEPK+We3n0THiDciYSsCcgW/DoA==", - "dev": true, - "license": "Apache-2.0", - "engines": { - "node": ">=12.0.0" - } - }, "node_modules/express": { "version": "5.2.1", "resolved": "https://registry.npmjs.org/express/-/express-5.2.1.tgz", @@ -5890,10 +6016,15 @@ } }, "node_modules/express-rate-limit": { - "version": "7.5.1", - "resolved": "https://registry.npmjs.org/express-rate-limit/-/express-rate-limit-7.5.1.tgz", - "integrity": "sha512-7iN8iPMDzOMHPUYllBEsQdWVB6fPDMPqwjBaFrgr4Jgr/+okjvzAy+UHlYYL/Vs0OsOrMkwS6PJDkFlJwoxUnw==", + "version": "8.7.0", + "resolved": "https://registry.npmjs.org/express-rate-limit/-/express-rate-limit-8.7.0.tgz", + "integrity": "sha512-hOwV7WOxXfjRpAM1DSJWZDXx3GhplwD8IfwuwvogD8i1Qnkgosw/H45s4ZnFAUHDAhPjlY9hLBvJhKmGMyY26g==", + "dev": true, "license": "MIT", + "dependencies": { + "debug": "^4.4.3", + "ip-address": "^10.2.0" + }, "engines": { "node": ">= 16" }, @@ -5904,16 +6035,49 @@ "express": ">= 4.11" } }, + "node_modules/ext-apps-v1": { + "name": "@modelcontextprotocol/ext-apps", + "version": "1.7.5", + "resolved": "https://registry.npmjs.org/@modelcontextprotocol/ext-apps/-/ext-apps-1.7.5.tgz", + "integrity": "sha512-TjPH2S2y5UEGKhmI6+XGFuqfqOV4ppe1x6DA3txnUaEWkgtA4G5vo14jGKFZmegdkZ1H4QMLyujLvoU1BEdnAg==", + "dev": true, + "license": "MIT", + "workspaces": [ + "examples/*" + ], + "dependencies": { + "@standard-schema/spec": "^1.1.0" + }, + "engines": { + "node": ">=20" + }, + "peerDependencies": { + "@modelcontextprotocol/sdk": "^1.29.0", + "react": "^17.0.0 || ^18.0.0 || ^19.0.0", + "react-dom": "^17.0.0 || ^18.0.0 || ^19.0.0", + "zod": "^3.25.0 || ^4.0.0" + }, + "peerDependenciesMeta": { + "react": { + "optional": true + }, + "react-dom": { + "optional": true + } + } + }, "node_modules/fast-deep-equal": { "version": "3.1.3", "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", + "dev": true, "license": "MIT" }, "node_modules/fast-uri": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.1.0.tgz", - "integrity": "sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA==", + "version": "3.1.7", + "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.1.7.tgz", + "integrity": "sha512-dOvZVzjdZdz7phd9v6jCbwxrBW3fK6n8Rc0CtdmM4bumzMnxywBYhuph6J819RRw/ku+rLbelwfMunktuzVVHg==", + "dev": true, "funding": [ { "type": "github", @@ -5944,9 +6108,9 @@ } }, "node_modules/filelist/node_modules/brace-expansion": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", - "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.1.2.tgz", + "integrity": "sha512-w5JZcKgdhDOgOwm8H+KgbosopHMuGcl6qbulwjtz3SM7I7P3yW1eAjzMPLrIE+NQ9vjgANKHWeMHnrT0OXW1oA==", "dev": true, "license": "MIT", "dependencies": { @@ -5954,9 +6118,9 @@ } }, "node_modules/filelist/node_modules/minimatch": { - "version": "5.1.6", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz", - "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==", + "version": "5.1.9", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.9.tgz", + "integrity": "sha512-7o1wEA2RyMP7Iu7GNba9vc0RWWGACJOCZBJX2GJWip0ikV+wcOsgVuY9uE8CPiyQhkGFSlhuSkZPavN7u1c2Fw==", "dev": true, "license": "ISC", "dependencies": { @@ -6247,11 +6411,10 @@ } }, "node_modules/hono": { - "version": "4.11.6", - "resolved": "https://registry.npmjs.org/hono/-/hono-4.11.6.tgz", - "integrity": "sha512-ofIiiHyl34SV6AuhE3YT2mhO5HRWokce+eUYE82TsP6z0/H3JeJcjVWEMSIAiw2QkjDOEpES/lYsg8eEbsLtdw==", + "version": "4.12.31", + "resolved": "https://registry.npmjs.org/hono/-/hono-4.12.31.tgz", + "integrity": "sha512-zJIHFrl6bq3RDd2YusFNCDlM8qUprxKswyi/OPzPyzKDdyBXDqWx8bZlZ7R+saTdSTatUmb3O7K4SspGPaEOQg==", "license": "MIT", - "peer": true, "engines": { "node": ">=16.9.0" } @@ -6260,7 +6423,6 @@ "version": "2.3.3", "resolved": "https://registry.npmjs.org/html-entities/-/html-entities-2.3.3.tgz", "integrity": "sha512-DV5Ln36z34NNTDgnz0EWGBLZENelNAtkiFA4kyNOG2tDI6Mz1uSWiq1wAKdyjnJwyDiDO7Fa2SO1CTxPXL8VxA==", - "dev": true, "license": "MIT" }, "node_modules/htmlparser2": { @@ -6389,6 +6551,16 @@ "node": ">=12" } }, + "node_modules/ip-address": { + "version": "10.7.0", + "resolved": "https://registry.npmjs.org/ip-address/-/ip-address-10.7.0.tgz", + "integrity": "sha512-BGFsyJd5mpXp3rK6jIdADLNgpJUK1jnjzvYF8lK+VyDab9JAmqN0YOKDdP17HlgKb2+ehPgDc8EtnRLbGCAMhA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 12" + } + }, "node_modules/ipaddr.js": { "version": "1.9.1", "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.9.1.tgz", @@ -6398,6 +6570,12 @@ "node": ">= 0.10" } }, + "node_modules/is-arrayish": { + "version": "0.3.4", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.3.4.tgz", + "integrity": "sha512-m6UrgzFVUYawGBh1dUsWR5M2Clqic9RVXC/9f8ceNlv2IcO9j9J/z8UoCLPqtsPBFNzEpfR3xftohbfqDx8EQA==", + "license": "MIT" + }, "node_modules/is-binary-path": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz", @@ -6574,12 +6752,14 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "dev": true, "license": "MIT" }, "node_modules/json-schema-typed": { "version": "8.0.2", "resolved": "https://registry.npmjs.org/json-schema-typed/-/json-schema-typed-8.0.2.tgz", "integrity": "sha512-fQhoXdcvc3V28x7C7BMs4P5+kNlgUURe2jmUT1T//oBRMDrqy1QPelJimwZGo7Hg9VPV3EQV5Bnq4hbFy2vetA==", + "dev": true, "license": "BSD-2-Clause" }, "node_modules/json5": { @@ -6639,10 +6819,20 @@ } }, "node_modules/linkify-it": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.0.tgz", - "integrity": "sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==", + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.2.tgz", + "integrity": "sha512-ONTm2jCMAVZjgQa/Fy1kScXsuOoF5NPTsoFBdE1KVIZ2vAh/r9+Bqo+0jINCBYnavTPQZz38QzFTme79ENoN3Q==", "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/puzrin" + }, + { + "type": "github", + "url": "https://github.com/sponsors/markdown-it" + } + ], "license": "MIT", "dependencies": { "uc.micro": "^2.0.0" @@ -6729,9 +6919,9 @@ "license": "MIT" }, "node_modules/lodash-es": { - "version": "4.17.23", - "resolved": "https://registry.npmjs.org/lodash-es/-/lodash-es-4.17.23.tgz", - "integrity": "sha512-kVI48u3PZr38HdYz98UmfPnXl2DXrpdctLrFLCd3kOx1xUkOmpFPx7gCWWM5MPkL/fD8zb+Ph0QzjGFs4+hHWg==", + "version": "4.18.1", + "resolved": "https://registry.npmjs.org/lodash-es/-/lodash-es-4.18.1.tgz", + "integrity": "sha512-J8xewKD/Gk22OZbhpOVSwcs60zhd95ESDwezOFuA3/099925PdHJ7OFHNTGtajL3AlZkykD32HykiMo+BIBI8A==", "dev": true, "license": "MIT" }, @@ -6827,13 +7017,6 @@ "url": "https://github.com/chalk/wrap-ansi?sponsor=1" } }, - "node_modules/loupe": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/loupe/-/loupe-3.2.1.tgz", - "integrity": "sha512-CdzqowRJCeLU72bHvWqwRBBlLcMEtIvGrlvef74kMnV2AolS9Y8xUv1I0U/MNAWMhBlKIoyuEgoJ0t/bbwHbLQ==", - "dev": true, - "license": "MIT" - }, "node_modules/lru-cache": { "version": "5.1.1", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", @@ -6861,15 +7044,25 @@ } }, "node_modules/markdown-it": { - "version": "14.1.0", - "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.1.0.tgz", - "integrity": "sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg==", + "version": "14.3.0", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.3.0.tgz", + "integrity": "sha512-RCEsPjR+sr0x+AuYp601tKTkgFG4YEPLCzHST3cQ/fhlJkqAkz1L2/Qbp1j9qw5SBwQHFBoW8+hoN5xssOF0Tw==", "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/puzrin" + }, + { + "type": "github", + "url": "https://github.com/sponsors/markdown-it" + } + ], "license": "MIT", "dependencies": { "argparse": "^2.0.1", - "entities": "^4.4.0", - "linkify-it": "^5.0.0", + "entities": "^4.5.0", + "linkify-it": "^5.0.2", "mdurl": "^2.0.0", "punycode.js": "^2.3.1", "uc.micro": "^2.1.0" @@ -6991,9 +7184,9 @@ } }, "node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz", + "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==", "dev": true, "license": "ISC", "dependencies": { @@ -7010,9 +7203,9 @@ "license": "MIT" }, "node_modules/nanoid": { - "version": "3.3.11", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz", - "integrity": "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==", + "version": "3.3.12", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.12.tgz", + "integrity": "sha512-ZB9RH/39qpq5Vu6Y+NmUaFhQR6pp+M2Xt76XBnEwDaGcVAqhlvxrl3B2bKS5D3NH3QR76v3aSrKaF/Kiy7lEtQ==", "funding": [ { "type": "github", @@ -7036,6 +7229,15 @@ "node": ">= 0.6" } }, + "node_modules/node-html-better-parser": { + "version": "1.5.8", + "resolved": "https://registry.npmjs.org/node-html-better-parser/-/node-html-better-parser-1.5.8.tgz", + "integrity": "sha512-t/wAKvaTSKco43X+yf9+76RiMt18MtMmzd4wc7rKj+fWav6DV4ajDEKdWlLzSE8USDF5zr/06uGj0Wr/dGAFtw==", + "license": "MIT", + "dependencies": { + "html-entities": "^2.3.2" + } + }, "node_modules/node-html-parser": { "version": "6.1.13", "resolved": "https://registry.npmjs.org/node-html-parser/-/node-html-parser-6.1.13.tgz", @@ -7048,11 +7250,14 @@ } }, "node_modules/node-releases": { - "version": "2.0.27", - "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.27.tgz", - "integrity": "sha512-nmh3lCkYZ3grZvqcCH+fjmQ7X+H0OeZgP40OierEaAptX4XofMh5kwNbWh7lBduUzCcV/8kZ+NDLCwm2iorIlA==", + "version": "2.0.51", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.51.tgz", + "integrity": "sha512-wRNIrw4DmVLKQlbgOMdkMx27Wrpzes2hh5Jtbi2bjPd+4wJstWIqP5A+lscnqbm0xxmT5Bpg8Lec5ItEBwx6BQ==", "dev": true, - "license": "MIT" + "license": "MIT", + "engines": { + "node": ">=18" + } }, "node_modules/nodemon": { "version": "3.1.11", @@ -7186,6 +7391,12 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/pako": { + "version": "1.0.11", + "resolved": "https://registry.npmjs.org/pako/-/pako-1.0.11.tgz", + "integrity": "sha512-4hLB8Py4zZce5s4yd9XzopqwVv/yGNhV1Bl8NTmCq1763HeK2+EwVTv+leGeL13Dnh2wfbqowVPXCIO0z4taYw==", + "license": "(MIT AND Zlib)" + }, "node_modules/parse5": { "version": "7.3.0", "resolved": "https://registry.npmjs.org/parse5/-/parse5-7.3.0.tgz", @@ -7254,32 +7465,15 @@ } }, "node_modules/path-to-regexp": { - "version": "8.3.0", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-8.3.0.tgz", - "integrity": "sha512-7jdwVIRtsP8MYpdXSwOS0YdD0Du+qOoF/AEPIt88PcCFrZCzx41oxku1jD88hZBwbNUIEfpqvuhjFaMAqMTWnA==", + "version": "8.4.1", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-8.4.1.tgz", + "integrity": "sha512-fvU78fIjZ+SBM9YwCknCvKOUKkLVqtWDVctl0s7xIqfmfb38t2TT4ZU2gHm+Z8xGwgW+QWEU3oQSAzIbo89Ggw==", "license": "MIT", "funding": { "type": "opencollective", "url": "https://opencollective.com/express" } }, - "node_modules/pathe": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz", - "integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==", - "dev": true, - "license": "MIT" - }, - "node_modules/pathval": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/pathval/-/pathval-2.0.1.tgz", - "integrity": "sha512-//nshmD55c46FuFw26xV/xFAaB5HF9Xdap7HJBBnrKdAd6/GxDBaNA1870O79+9ueg61cZLSVc+OaFlfmObYVQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 14.16" - } - }, "node_modules/pdfjs-dist": { "version": "5.4.530", "resolved": "https://registry.npmjs.org/pdfjs-dist/-/pdfjs-dist-5.4.530.tgz", @@ -7299,9 +7493,9 @@ "license": "ISC" }, "node_modules/picomatch": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", - "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "version": "2.3.2", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.2.tgz", + "integrity": "sha512-V7+vQEJ06Z+c5tSye8S+nHUfI51xoXIXjHQ99cQtKUkQqqO1kO/KCJUfZXuB47h/YBlDhah2H3hdUGXn8ie0oA==", "dev": true, "license": "MIT", "engines": { @@ -7368,9 +7562,9 @@ } }, "node_modules/postcss": { - "version": "8.5.6", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.6.tgz", - "integrity": "sha512-3Ybi1tAuwAP9s0r1UQ2J4n5Y0G05bJkpUIO0/bI9MhwmD70S5aTWbXGBwxHrelT+XM1k6dM0pk+SwNkpTRN7Pg==", + "version": "8.5.15", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.15.tgz", + "integrity": "sha512-FfR8sjd4em2T6fb3I2MwAJU7HWVMr9zba+enmQeeWFfCbm+UOC/0X4DS8XtpUTMwWMGbjKYP7xjfNekzyGmB3A==", "funding": [ { "type": "opencollective", @@ -7387,7 +7581,7 @@ ], "license": "MIT", "dependencies": { - "nanoid": "^3.3.11", + "nanoid": "^3.3.12", "picocolors": "^1.1.1", "source-map-js": "^1.2.1" }, @@ -7452,9 +7646,9 @@ } }, "node_modules/qs": { - "version": "6.14.1", - "resolved": "https://registry.npmjs.org/qs/-/qs-6.14.1.tgz", - "integrity": "sha512-4EK3+xJl8Ts67nLYNwqw/dsFVnCf+qR7RgXSK9jEEm9unao3njwMDdmsdvoKBKHzxd7tCYz5e5M+SnMjdtXGQQ==", + "version": "6.15.2", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.15.2.tgz", + "integrity": "sha512-Rzq0KEyX/w/tEybncDgdkZrJgVUsUMk3xjh3t5bv3S1HTAtg+uOYt72+ZfwiQwKdysThkTBdL/rTi6HDmX9Ddw==", "license": "BSD-3-Clause", "dependencies": { "side-channel": "^1.1.0" @@ -7564,6 +7758,7 @@ "version": "2.0.2", "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "dev": true, "license": "MIT", "engines": { "node": ">=0.10.0" @@ -7604,9 +7799,9 @@ "license": "MIT" }, "node_modules/rollup": { - "version": "4.56.0", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.56.0.tgz", - "integrity": "sha512-9FwVqlgUHzbXtDg9RCMgodF3Ua4Na6Gau+Sdt9vyCN4RhHfVKX2DCHy3BjMLTDd47ITDhYAnTwGulWTblJSDLg==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.60.1.tgz", + "integrity": "sha512-VmtB2rFU/GroZ4oL8+ZqXgSA38O6GR8KSIvWmEFv63pQ0G6KaBH9s07PO8XTXP4vI+3UJUEypOfjkGfmSBBR0w==", "dev": true, "license": "MIT", "dependencies": { @@ -7620,31 +7815,31 @@ "npm": ">=8.0.0" }, "optionalDependencies": { - "@rollup/rollup-android-arm-eabi": "4.56.0", - "@rollup/rollup-android-arm64": "4.56.0", - "@rollup/rollup-darwin-arm64": "4.56.0", - "@rollup/rollup-darwin-x64": "4.56.0", - "@rollup/rollup-freebsd-arm64": "4.56.0", - "@rollup/rollup-freebsd-x64": "4.56.0", - "@rollup/rollup-linux-arm-gnueabihf": "4.56.0", - "@rollup/rollup-linux-arm-musleabihf": "4.56.0", - "@rollup/rollup-linux-arm64-gnu": "4.56.0", - "@rollup/rollup-linux-arm64-musl": "4.56.0", - "@rollup/rollup-linux-loong64-gnu": "4.56.0", - "@rollup/rollup-linux-loong64-musl": "4.56.0", - "@rollup/rollup-linux-ppc64-gnu": "4.56.0", - "@rollup/rollup-linux-ppc64-musl": "4.56.0", - "@rollup/rollup-linux-riscv64-gnu": "4.56.0", - "@rollup/rollup-linux-riscv64-musl": "4.56.0", - "@rollup/rollup-linux-s390x-gnu": "4.56.0", - "@rollup/rollup-linux-x64-gnu": "4.56.0", - "@rollup/rollup-linux-x64-musl": "4.56.0", - "@rollup/rollup-openbsd-x64": "4.56.0", - "@rollup/rollup-openharmony-arm64": "4.56.0", - "@rollup/rollup-win32-arm64-msvc": "4.56.0", - "@rollup/rollup-win32-ia32-msvc": "4.56.0", - "@rollup/rollup-win32-x64-gnu": "4.56.0", - "@rollup/rollup-win32-x64-msvc": "4.56.0", + "@rollup/rollup-android-arm-eabi": "4.60.1", + "@rollup/rollup-android-arm64": "4.60.1", + "@rollup/rollup-darwin-arm64": "4.60.1", + "@rollup/rollup-darwin-x64": "4.60.1", + "@rollup/rollup-freebsd-arm64": "4.60.1", + "@rollup/rollup-freebsd-x64": "4.60.1", + "@rollup/rollup-linux-arm-gnueabihf": "4.60.1", + "@rollup/rollup-linux-arm-musleabihf": "4.60.1", + "@rollup/rollup-linux-arm64-gnu": "4.60.1", + "@rollup/rollup-linux-arm64-musl": "4.60.1", + "@rollup/rollup-linux-loong64-gnu": "4.60.1", + "@rollup/rollup-linux-loong64-musl": "4.60.1", + "@rollup/rollup-linux-ppc64-gnu": "4.60.1", + "@rollup/rollup-linux-ppc64-musl": "4.60.1", + "@rollup/rollup-linux-riscv64-gnu": "4.60.1", + "@rollup/rollup-linux-riscv64-musl": "4.60.1", + "@rollup/rollup-linux-s390x-gnu": "4.60.1", + "@rollup/rollup-linux-x64-gnu": "4.60.1", + "@rollup/rollup-linux-x64-musl": "4.60.1", + "@rollup/rollup-openbsd-x64": "4.60.1", + "@rollup/rollup-openharmony-arm64": "4.60.1", + "@rollup/rollup-win32-arm64-msvc": "4.60.1", + "@rollup/rollup-win32-ia32-msvc": "4.60.1", + "@rollup/rollup-win32-x64-gnu": "4.60.1", + "@rollup/rollup-win32-x64-msvc": "4.60.1", "fsevents": "~2.3.2" } }, @@ -7687,9 +7882,9 @@ "license": "MIT" }, "node_modules/semver": { - "version": "7.7.3", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.3.tgz", - "integrity": "sha512-SdsKMrI9TdgjdweUSR9MweHA4EJ8YxHn8DFaDisvhVlUOe4BF1tLD7GAj0lIqWVl+dPb/rExr0Btby5loQm20Q==", + "version": "7.8.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.5.tgz", + "integrity": "sha512-Y7/KDsb8LjooZpwaqGyulO6DQlksgCncchHGk+sZIY4SBvUocMBEFH5Ur1fI4dV+Jvl0w6cjvucaIi40puRioA==", "dev": true, "license": "ISC", "bin": { @@ -7772,48 +7967,53 @@ "license": "ISC" }, "node_modules/sharp": { - "version": "0.34.5", - "resolved": "https://registry.npmjs.org/sharp/-/sharp-0.34.5.tgz", - "integrity": "sha512-Ou9I5Ft9WNcCbXrU9cMgPBcCK8LiwLqcbywW3t4oDV37n1pzpuNLsYiAV8eODnjbtQlSDwZ2cUEeQz4E54Hltg==", + "version": "0.35.3", + "resolved": "https://registry.npmjs.org/sharp/-/sharp-0.35.3.tgz", + "integrity": "sha512-ej0zVHuZGHCiABXcNxeYhpRnPNPAcvbG8RMdBAhDAxLKkCRVSpK3Iyu7qbqw3JMzoj0REeM6f3tJLtVwl0023Q==", "dev": true, - "hasInstallScript": true, "license": "Apache-2.0", "dependencies": { - "@img/colour": "^1.0.0", + "@img/colour": "^1.1.0", "detect-libc": "^2.1.2", - "semver": "^7.7.3" + "semver": "^7.8.5" }, "engines": { - "node": "^18.17.0 || ^20.3.0 || >=21.0.0" + "node": ">=20.9.0" }, "funding": { "url": "https://opencollective.com/libvips" }, "optionalDependencies": { - "@img/sharp-darwin-arm64": "0.34.5", - "@img/sharp-darwin-x64": "0.34.5", - "@img/sharp-libvips-darwin-arm64": "1.2.4", - "@img/sharp-libvips-darwin-x64": "1.2.4", - "@img/sharp-libvips-linux-arm": "1.2.4", - "@img/sharp-libvips-linux-arm64": "1.2.4", - "@img/sharp-libvips-linux-ppc64": "1.2.4", - "@img/sharp-libvips-linux-riscv64": "1.2.4", - "@img/sharp-libvips-linux-s390x": "1.2.4", - "@img/sharp-libvips-linux-x64": "1.2.4", - "@img/sharp-libvips-linuxmusl-arm64": "1.2.4", - "@img/sharp-libvips-linuxmusl-x64": "1.2.4", - "@img/sharp-linux-arm": "0.34.5", - "@img/sharp-linux-arm64": "0.34.5", - "@img/sharp-linux-ppc64": "0.34.5", - "@img/sharp-linux-riscv64": "0.34.5", - "@img/sharp-linux-s390x": "0.34.5", - "@img/sharp-linux-x64": "0.34.5", - "@img/sharp-linuxmusl-arm64": "0.34.5", - "@img/sharp-linuxmusl-x64": "0.34.5", - "@img/sharp-wasm32": "0.34.5", - "@img/sharp-win32-arm64": "0.34.5", - "@img/sharp-win32-ia32": "0.34.5", - "@img/sharp-win32-x64": "0.34.5" + "@img/sharp-darwin-arm64": "0.35.3", + "@img/sharp-darwin-x64": "0.35.3", + "@img/sharp-freebsd-wasm32": "0.35.3", + "@img/sharp-libvips-darwin-arm64": "1.3.2", + "@img/sharp-libvips-darwin-x64": "1.3.2", + "@img/sharp-libvips-linux-arm": "1.3.2", + "@img/sharp-libvips-linux-arm64": "1.3.2", + "@img/sharp-libvips-linux-ppc64": "1.3.2", + "@img/sharp-libvips-linux-riscv64": "1.3.2", + "@img/sharp-libvips-linux-s390x": "1.3.2", + "@img/sharp-libvips-linux-x64": "1.3.2", + "@img/sharp-libvips-linuxmusl-arm64": "1.3.2", + "@img/sharp-libvips-linuxmusl-x64": "1.3.2", + "@img/sharp-linux-arm": "0.35.3", + "@img/sharp-linux-arm64": "0.35.3", + "@img/sharp-linux-ppc64": "0.35.3", + "@img/sharp-linux-riscv64": "0.35.3", + "@img/sharp-linux-s390x": "0.35.3", + "@img/sharp-linux-x64": "0.35.3", + "@img/sharp-linuxmusl-arm64": "0.35.3", + "@img/sharp-linuxmusl-x64": "0.35.3", + "@img/sharp-webcontainers-wasm32": "0.35.3", + "@img/sharp-win32-arm64": "0.35.3", + "@img/sharp-win32-ia32": "0.35.3", + "@img/sharp-win32-x64": "0.35.3" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + } } }, "node_modules/shebang-command": { @@ -7838,9 +8038,9 @@ } }, "node_modules/shell-quote": { - "version": "1.8.3", - "resolved": "https://registry.npmjs.org/shell-quote/-/shell-quote-1.8.3.tgz", - "integrity": "sha512-ObmnIF4hXNg1BqhnHmgbDETF8dLPCggZWBjkQfhZpbszZnYur5DUljTcCHii5LC3J5E0yeO/1LIMyH+UvHQgyw==", + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/shell-quote/-/shell-quote-1.9.0.tgz", + "integrity": "sha512-Iov+JwFv/2HcTpcwNMKd8+IWNb8tboQJNQTkAY/LLVK7gGH9jy+LGkVqPxfekHl+yMmiqXszdGWXgkfml7hjqA==", "dev": true, "license": "MIT", "engines": { @@ -7922,13 +8122,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/siginfo": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/siginfo/-/siginfo-2.0.0.tgz", - "integrity": "sha512-ybx0WO1/8bSBLEWXZvEd7gMW3Sn3JFlW3TvX1nREbDLRNQNaeNN8WK0meBwPdAaOI7TtRRRJn/Es1zhrrCHu7g==", - "dev": true, - "license": "ISC" - }, "node_modules/signal-exit": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz", @@ -7952,6 +8145,15 @@ "kolorist": "^1.6.0" } }, + "node_modules/simple-swizzle": { + "version": "0.2.4", + "resolved": "https://registry.npmjs.org/simple-swizzle/-/simple-swizzle-0.2.4.tgz", + "integrity": "sha512-nAu1WFPQSMNr2Zn9PGSZK9AGn4t/y97lEm+MXTtUDwfP0ksAIX4nO+6ruD9Jwut4C49SB1Ws+fbXsm/yScWOHw==", + "license": "MIT", + "dependencies": { + "is-arrayish": "^0.3.1" + } + }, "node_modules/simple-update-notifier": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/simple-update-notifier/-/simple-update-notifier-2.0.0.tgz", @@ -8070,13 +8272,6 @@ "node": ">=16" } }, - "node_modules/stackback": { - "version": "0.0.2", - "resolved": "https://registry.npmjs.org/stackback/-/stackback-0.0.2.tgz", - "integrity": "sha512-1XMJE5fQo1jGH6Y/7ebnwPOBEkIEnT4QF32d5R1+VXdXveM0IBMJt8zfaxX1P3QhVwrYe+576+jkANtSS2mBbw==", - "dev": true, - "license": "MIT" - }, "node_modules/statuses": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.2.tgz", @@ -8086,13 +8281,6 @@ "node": ">= 0.8" } }, - "node_modules/std-env": { - "version": "3.10.0", - "resolved": "https://registry.npmjs.org/std-env/-/std-env-3.10.0.tgz", - "integrity": "sha512-5GS12FdOZNliM5mAOxFRg7Ir0pWz8MdpYm6AY6VPkGpbA7ZzmbzNcBJQ0GPvvyWgcY7QAhCgf9Uy89I03faLkg==", - "dev": true, - "license": "MIT" - }, "node_modules/string-width": { "version": "4.2.3", "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", @@ -8157,26 +8345,6 @@ "url": "https://github.com/chalk/strip-ansi?sponsor=1" } }, - "node_modules/strip-literal": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/strip-literal/-/strip-literal-3.1.0.tgz", - "integrity": "sha512-8r3mkIM/2+PpjHoOtiAW8Rg3jJLHaV7xPwG+YRGrv6FP0wwk/toTpATxWYOW0BKdWwl82VT2tFYi5DlROa0Mxg==", - "dev": true, - "license": "MIT", - "dependencies": { - "js-tokens": "^9.0.1" - }, - "funding": { - "url": "https://github.com/sponsors/antfu" - } - }, - "node_modules/strip-literal/node_modules/js-tokens": { - "version": "9.0.1", - "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-9.0.1.tgz", - "integrity": "sha512-mxa9E9ITFOt0ban3j6L5MpjwegGz6lBQmM1IJkWeBZGcMxto50+eWdjC/52xDbS2vy0k7vIMK0Fe2wfL9OQSpQ==", - "dev": true, - "license": "MIT" - }, "node_modules/supports-color": { "version": "8.1.1", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", @@ -8194,22 +8362,23 @@ } }, "node_modules/svelte": { - "version": "5.48.2", - "resolved": "https://registry.npmjs.org/svelte/-/svelte-5.48.2.tgz", - "integrity": "sha512-VPWD+UyoSFZ7Nxix5K/F8yWiKWOiROkLlWYXOZReE0TUycw+58YWB3D6lAKT+57xmN99wRX4H3oZmw0NPy7y3Q==", + "version": "5.56.1", + "resolved": "https://registry.npmjs.org/svelte/-/svelte-5.56.1.tgz", + "integrity": "sha512-eArsJmvl3xZVuTYD852PzIEdg2wgDdIZ1NEsIPbzAukHwi284B18No4nK2rCO9AwsWUDza4Cjvmoa4HaojTl5g==", "license": "MIT", "dependencies": { "@jridgewell/remapping": "^2.3.4", "@jridgewell/sourcemap-codec": "^1.5.0", - "@sveltejs/acorn-typescript": "^1.0.5", + "@sveltejs/acorn-typescript": "^1.0.10", "@types/estree": "^1.0.5", + "@types/trusted-types": "^2.0.7", "acorn": "^8.12.1", - "aria-query": "^5.3.1", + "aria-query": "5.3.1", "axobject-query": "^4.1.0", "clsx": "^2.1.1", - "devalue": "^5.6.2", + "devalue": "^5.8.1", "esm-env": "^1.2.1", - "esrap": "^2.2.1", + "esrap": "^2.2.9", "is-reference": "^3.0.3", "locate-character": "^3.0.0", "magic-string": "^0.30.11", @@ -8220,9 +8389,9 @@ } }, "node_modules/systeminformation": { - "version": "5.30.6", - "resolved": "https://registry.npmjs.org/systeminformation/-/systeminformation-5.30.6.tgz", - "integrity": "sha512-LEIyK1aEv5P3BhAPW3swdlIyCihxwEq/Gki+kcONieU4PIeRCSLDuGkk0Va/56PSBgjVgEksOM88dmY6YqOyfQ==", + "version": "5.31.7", + "resolved": "https://registry.npmjs.org/systeminformation/-/systeminformation-5.31.7.tgz", + "integrity": "sha512-/8NC53e5nP9nmhn42/ncdOkyJnOoue/Vy+tJOyUGd1Yv66G069wK4rrziwhrqDETgk78CudTQupw5z19S5uoZw==", "license": "MIT", "os": [ "darwin", @@ -8463,13 +8632,6 @@ "integrity": "sha512-k/CjiZ80bYss6Qs7/ex1TBlPD11whT9oKfT8oTGiHa34W4JRd1NiH/Tr1DbHWQ2/vMUypxksLnF2CfmlmM5XFQ==", "license": "MIT" }, - "node_modules/tinybench": { - "version": "2.9.0", - "resolved": "https://registry.npmjs.org/tinybench/-/tinybench-2.9.0.tgz", - "integrity": "sha512-0+DUvqWMValLmha6lr4kD8iAMK1HzV0/aKnCtWb9v9641TnP/MFb7Pc2bxoxQjTXAErryXVgUOfv2YqNllqGeg==", - "dev": true, - "license": "MIT" - }, "node_modules/tinycolor2": { "version": "1.6.0", "resolved": "https://registry.npmjs.org/tinycolor2/-/tinycolor2-1.6.0.tgz", @@ -8477,13 +8639,6 @@ "dev": true, "license": "MIT" }, - "node_modules/tinyexec": { - "version": "0.3.2", - "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-0.3.2.tgz", - "integrity": "sha512-KQQR9yN7R5+OSwaK0XQoj22pwHoTlgYqmUscPYoknOoWCWfj/5/ABTMRi69FrKU5ffPVh5QcFikpWJI/P1ocHA==", - "dev": true, - "license": "MIT" - }, "node_modules/tinyglobby": { "version": "0.2.15", "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.15.tgz", @@ -8520,9 +8675,9 @@ } }, "node_modules/tinyglobby/node_modules/picomatch": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", - "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.4.tgz", + "integrity": "sha512-QP88BAKvMam/3NxH6vj2o21R6MjxZUAd6nlwAS/pnGvN9IVLocLHxGYIzFhg6fUQ+5th6P4dv4eW9jX3DSIj7A==", "dev": true, "license": "MIT", "engines": { @@ -8532,36 +8687,6 @@ "url": "https://github.com/sponsors/jonschlinkert" } }, - "node_modules/tinypool": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/tinypool/-/tinypool-1.1.1.tgz", - "integrity": "sha512-Zba82s87IFq9A9XmjiX5uZA/ARWDrB03OHlq+Vw1fSdt0I+4/Kutwy8BP4Y/y/aORMo61FQ0vIb5j44vSo5Pkg==", - "dev": true, - "license": "MIT", - "engines": { - "node": "^18.0.0 || >=20.0.0" - } - }, - "node_modules/tinyrainbow": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-2.0.0.tgz", - "integrity": "sha512-op4nsTR47R6p0vMUUoYl/a+ljLFVtlfaXkLQmqfLR1qHma1h/ysYk4hEXZ880bf2CYgTskvTa/e196Vd5dDQXw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=14.0.0" - } - }, - "node_modules/tinyspy": { - "version": "4.0.4", - "resolved": "https://registry.npmjs.org/tinyspy/-/tinyspy-4.0.4.tgz", - "integrity": "sha512-azl+t0z7pw/z958Gy9svOTuzqIk6xq+NSheJzn5MMWtWTFywIacg2wUlzKFGtt3cthx0r2SxMK0yzJOR0IES7Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=14.0.0" - } - }, "node_modules/to-regex-range": { "version": "5.0.1", "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", @@ -8661,7 +8786,6 @@ "version": "2.8.1", "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", - "dev": true, "license": "0BSD" }, "node_modules/tsutils": { @@ -9205,17 +9329,34 @@ } }, "node_modules/type-is": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/type-is/-/type-is-2.0.1.tgz", - "integrity": "sha512-OZs6gsjF4vMp32qrCbiVSkrFmXtG/AZhY3t0iAMrMBiAZyV9oALtXO8hsrHbMXF9x6L3grlFuwW2oAz7cav+Gw==", + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/type-is/-/type-is-2.1.0.tgz", + "integrity": "sha512-faYHw0anBbc/kWF3zFTEnxSFOAGUX9GFbOBthvDdLsIlEoWOFOtS0zgCiQYwIskL9iGXZL3kAXD8OoZ4GmMATA==", "license": "MIT", "dependencies": { - "content-type": "^1.0.5", + "content-type": "^2.0.0", "media-typer": "^1.1.0", "mime-types": "^3.0.0" }, "engines": { - "node": ">= 0.6" + "node": ">= 18" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/type-is/node_modules/content-type": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/content-type/-/content-type-2.0.0.tgz", + "integrity": "sha512-j/O/d7GcZCyNl7/hwZAb606rzqkyvaDctLmckbxLzHvFBzTJHuGEdodATcP3yIRoDrLHkIATJuvzbFlp/ki2cQ==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" } }, "node_modules/typedoc": { @@ -9256,9 +9397,9 @@ } }, "node_modules/typedoc/node_modules/brace-expansion": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", - "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.1.2.tgz", + "integrity": "sha512-w5JZcKgdhDOgOwm8H+KgbosopHMuGcl6qbulwjtz3SM7I7P3yW1eAjzMPLrIE+NQ9vjgANKHWeMHnrT0OXW1oA==", "dev": true, "license": "MIT", "dependencies": { @@ -9266,13 +9407,13 @@ } }, "node_modules/typedoc/node_modules/minimatch": { - "version": "9.0.5", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", - "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", + "version": "9.0.9", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.9.tgz", + "integrity": "sha512-OBwBN9AL4dqmETlpS2zasx+vTeWclWzkblfZk7KTA5j3jeOONz/tRCnZomUyvNg83wL5Zv9Ss6HMJXAgL8R2Yg==", "dev": true, "license": "ISC", "dependencies": { - "brace-expansion": "^2.0.1" + "brace-expansion": "^2.0.2" }, "engines": { "node": ">=16 || 14 >=14.17" @@ -9310,9 +9451,9 @@ "license": "MIT" }, "node_modules/undici": { - "version": "7.18.2", - "resolved": "https://registry.npmjs.org/undici/-/undici-7.18.2.tgz", - "integrity": "sha512-y+8YjDFzWdQlSE9N5nzKMT3g4a5UBX1HKowfdXh0uvAnTaqqwqB92Jt4UXBAeKekDs5IaDKyJFR4X1gYVCgXcw==", + "version": "7.28.0", + "resolved": "https://registry.npmjs.org/undici/-/undici-7.28.0.tgz", + "integrity": "sha512-cRZYrTDwWznlnRiPjggAGxZXanty6M8RV1ff8Wm4LWXBp7/IG8v5DnOm74DtUBp9OONpK75YlPnIjQqX0dBDtA==", "license": "MIT", "engines": { "node": ">=20.18.1" @@ -9375,9 +9516,9 @@ } }, "node_modules/vite": { - "version": "6.4.1", - "resolved": "https://registry.npmjs.org/vite/-/vite-6.4.1.tgz", - "integrity": "sha512-+Oxm7q9hDoLMyJOYfUYBuHQo+dkAloi33apOPP56pzj+vsdJDzr+j1NISE5pyaAuKL4A3UD34qd0lx5+kfKp2g==", + "version": "6.4.3", + "resolved": "https://registry.npmjs.org/vite/-/vite-6.4.3.tgz", + "integrity": "sha512-NTKlcQjlAK7MlQoyb6LgaqHc8sso/pVyUJYWMws3jg21uTJw/LddqIFPcPqP6PzpgbIcZyKI85sFE4HBrQDA8A==", "dev": true, "license": "MIT", "dependencies": { @@ -9449,29 +9590,6 @@ } } }, - "node_modules/vite-node": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-3.2.4.tgz", - "integrity": "sha512-EbKSKh+bh1E1IFxeO0pg1n4dvoOTt0UDiXMd/qn++r98+jPO1xtJilvXldeuQ8giIB5IkpjCgMleHMNEsGH6pg==", - "dev": true, - "license": "MIT", - "dependencies": { - "cac": "^6.7.14", - "debug": "^4.4.1", - "es-module-lexer": "^1.7.0", - "pathe": "^2.0.3", - "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0" - }, - "bin": { - "vite-node": "vite-node.mjs" - }, - "engines": { - "node": "^18.0.0 || ^20.0.0 || >=22.0.0" - }, - "funding": { - "url": "https://opencollective.com/vitest" - } - }, "node_modules/vite-plugin-singlefile": { "version": "2.3.0", "resolved": "https://registry.npmjs.org/vite-plugin-singlefile/-/vite-plugin-singlefile-2.3.0.tgz", @@ -9490,9 +9608,9 @@ } }, "node_modules/vite-plugin-solid": { - "version": "2.11.10", - "resolved": "https://registry.npmjs.org/vite-plugin-solid/-/vite-plugin-solid-2.11.10.tgz", - "integrity": "sha512-Yr1dQybmtDtDAHkii6hXuc1oVH9CPcS/Zb2jN/P36qqcrkNnVPsMTzQ06jyzFPFjj3U1IYKMVt/9ZqcwGCEbjw==", + "version": "2.11.12", + "resolved": "https://registry.npmjs.org/vite-plugin-solid/-/vite-plugin-solid-2.11.12.tgz", + "integrity": "sha512-FgjPcx2OwX9h6f28jli7A4bG7PP3te8uyakE5iqsmpq3Jqi1TWLgSroC9N6cMfGRU2zXsl4Q6ISvTr2VL0QHpA==", "dev": true, "license": "MIT", "dependencies": { @@ -9506,7 +9624,7 @@ "peerDependencies": { "@testing-library/jest-dom": "^5.16.6 || ^5.17.0 || ^6.*", "solid-js": "^1.7.2", - "vite": "^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0" + "vite": "^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0" }, "peerDependenciesMeta": { "@testing-library/jest-dom": { @@ -9515,9 +9633,9 @@ } }, "node_modules/vite-prerender-plugin": { - "version": "0.5.12", - "resolved": "https://registry.npmjs.org/vite-prerender-plugin/-/vite-prerender-plugin-0.5.12.tgz", - "integrity": "sha512-EiwhbMn+flg14EysbLTmZSzq8NGTxhytgK3bf4aGRF1evWLGwZiHiUJ1KZDvbxgKbMf2pG6fJWGEa3UZXOnR1g==", + "version": "0.5.13", + "resolved": "https://registry.npmjs.org/vite-prerender-plugin/-/vite-prerender-plugin-0.5.13.tgz", + "integrity": "sha512-IKSpYkzDBsKAxa05naRbj7GvNVMSdww/Z/E89oO3xndz+gWnOBOKOAbEXv7qDhktY/j3vHgJmoV1pPzqU2tx9g==", "dev": true, "license": "MIT", "dependencies": { @@ -9529,7 +9647,7 @@ "stack-trace": "^1.0.0-pre2" }, "peerDependencies": { - "vite": "5.x || 6.x || 7.x" + "vite": "5.x || 6.x || 7.x || 8.x" } }, "node_modules/vite/node_modules/fdir": { @@ -9551,9 +9669,9 @@ } }, "node_modules/vite/node_modules/picomatch": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", - "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.4.tgz", + "integrity": "sha512-QP88BAKvMam/3NxH6vj2o21R6MjxZUAd6nlwAS/pnGvN9IVLocLHxGYIzFhg6fUQ+5th6P4dv4eW9jX3DSIj7A==", "dev": true, "license": "MIT", "engines": { @@ -9583,92 +9701,6 @@ } } }, - "node_modules/vitest": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/vitest/-/vitest-3.2.4.tgz", - "integrity": "sha512-LUCP5ev3GURDysTWiP47wRRUpLKMOfPh+yKTx3kVIEiu5KOMeqzpnYNsKyOoVrULivR8tLcks4+lga33Whn90A==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/chai": "^5.2.2", - "@vitest/expect": "3.2.4", - "@vitest/mocker": "3.2.4", - "@vitest/pretty-format": "^3.2.4", - "@vitest/runner": "3.2.4", - "@vitest/snapshot": "3.2.4", - "@vitest/spy": "3.2.4", - "@vitest/utils": "3.2.4", - "chai": "^5.2.0", - "debug": "^4.4.1", - "expect-type": "^1.2.1", - "magic-string": "^0.30.17", - "pathe": "^2.0.3", - "picomatch": "^4.0.2", - "std-env": "^3.9.0", - "tinybench": "^2.9.0", - "tinyexec": "^0.3.2", - "tinyglobby": "^0.2.14", - "tinypool": "^1.1.1", - "tinyrainbow": "^2.0.0", - "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0", - "vite-node": "3.2.4", - "why-is-node-running": "^2.3.0" - }, - "bin": { - "vitest": "vitest.mjs" - }, - "engines": { - "node": "^18.0.0 || ^20.0.0 || >=22.0.0" - }, - "funding": { - "url": "https://opencollective.com/vitest" - }, - "peerDependencies": { - "@edge-runtime/vm": "*", - "@types/debug": "^4.1.12", - "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", - "@vitest/browser": "3.2.4", - "@vitest/ui": "3.2.4", - "happy-dom": "*", - "jsdom": "*" - }, - "peerDependenciesMeta": { - "@edge-runtime/vm": { - "optional": true - }, - "@types/debug": { - "optional": true - }, - "@types/node": { - "optional": true - }, - "@vitest/browser": { - "optional": true - }, - "@vitest/ui": { - "optional": true - }, - "happy-dom": { - "optional": true - }, - "jsdom": { - "optional": true - } - } - }, - "node_modules/vitest/node_modules/picomatch": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", - "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/jonschlinkert" - } - }, "node_modules/vue": { "version": "3.5.27", "resolved": "https://registry.npmjs.org/vue/-/vue-3.5.27.tgz", @@ -9727,23 +9759,6 @@ "node": ">= 8" } }, - "node_modules/why-is-node-running": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/why-is-node-running/-/why-is-node-running-2.3.0.tgz", - "integrity": "sha512-hUrmaWBdVDcxvYqnyh09zunKzROWjbZTiNy8dBEjkS7ehEDQibXJ7XvlmtbwuTclUiIyN+CyXQD4Vmko8fNm8w==", - "dev": true, - "license": "MIT", - "dependencies": { - "siginfo": "^2.0.0", - "stackback": "0.0.2" - }, - "bin": { - "why-is-node-running": "cli.js" - }, - "engines": { - "node": ">=8" - } - }, "node_modules/widest-line": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-3.1.0.tgz", @@ -9829,9 +9844,9 @@ "license": "ISC" }, "node_modules/yaml": { - "version": "2.8.2", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.2.tgz", - "integrity": "sha512-mplynKqc1C2hTVYxd0PU2xQAc22TI1vShAYGksCCfxbn/dFwnHTNi1bvYsBTkhdUNtGIf5xNOg938rrSSYvS9A==", + "version": "2.8.3", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.3.tgz", + "integrity": "sha512-AvbaCLOO2Otw/lW5bmh9d/WEdcDFdQp2Z2ZUH3pX9U2ihyUY0nvLv7J6TrWowklRGPYbB/IuIMfYgxaCPg5Bpg==", "dev": true, "license": "ISC", "bin": { @@ -9889,12 +9904,13 @@ } }, "node_modules/zod-to-json-schema": { - "version": "3.25.1", - "resolved": "https://registry.npmjs.org/zod-to-json-schema/-/zod-to-json-schema-3.25.1.tgz", - "integrity": "sha512-pM/SU9d3YAggzi6MtR4h7ruuQlqKtad8e9S0fmxcMi+ueAK5Korys/aWcV9LIIHTVbj01NdzxcnXSN+O74ZIVA==", + "version": "3.25.2", + "resolved": "https://registry.npmjs.org/zod-to-json-schema/-/zod-to-json-schema-3.25.2.tgz", + "integrity": "sha512-O/PgfnpT1xKSDeQYSCfRI5Gy3hPf91mKVDuYLUHZJMiDFptvP41MSnWofm8dnCm0256ZNfZIM7DSzuSMAFnjHA==", + "dev": true, "license": "ISC", "peerDependencies": { - "zod": "^3.25 || ^4" + "zod": "^3.25.28 || ^4" } } } diff --git a/package.json b/package.json index 5c06a2d..c86efa9 100644 --- a/package.json +++ b/package.json @@ -2,13 +2,16 @@ "name": "@modelcontextprotocol/ext-apps", "repository": { "type": "git", - "url": "https://github.com/modelcontextprotocol/ext-apps" + "url": "git+https://github.com/modelcontextprotocol/ext-apps.git" }, "homepage": "https://github.com/modelcontextprotocol/ext-apps", - "version": "1.2.0", + "version": "2.0.0", "license": "MIT", "description": "MCP Apps SDK β€” Enable MCP servers to display interactive user interfaces in conversational clients.", "type": "module", + "engines": { + "node": ">=20" + }, "main": "./dist/src/app.js", "exports": { ".": { @@ -50,7 +53,8 @@ "build": "npm run generate:schemas && npm run sync:snippets && node scripts/run-bun.mjs build.bun.ts && node scripts/link-self.mjs", "prepack": "npm run build", "build:all": "npm run examples:build", - "test": "bun test src", + "test": "bun test src examples", + "test:dependency-isolation": "npm run build && node scripts/check-dependency-isolation.mjs", "test:e2e": "playwright test", "test:e2e:update": "playwright test --update-snapshots", "test:e2e:ui": "playwright test --ui", @@ -64,21 +68,27 @@ "prepare": "npm run build && husky", "docs": "typedoc", "docs:watch": "typedoc --watch", - "generate:screenshots": "npm run build:all && docker run --rm -e EXAMPLE -v $(pwd):/work -w /work mcr.microsoft.com/playwright:v1.57.0-noble sh -c 'apt-get update -qq && apt-get install -qq -y python3-venv curl > /dev/null && curl -LsSf https://astral.sh/uv/install.sh | sh && export PATH=\"$HOME/.local/bin:$PATH\" && npm i -g bun && npm ci && npx playwright test tests/e2e/generate-grid-screenshots.spec.ts'", + "generate:screenshots": "npm run build:all && docker run --rm -e EXAMPLE -e GENERATE_SCREENSHOTS=1 -v $(pwd):/work -w /work mcr.microsoft.com/playwright:v1.57.0-noble sh -c 'apt-get update -qq && apt-get install -qq -y python3-venv curl > /dev/null && curl -LsSf https://astral.sh/uv/install.sh | sh && export PATH=\"$HOME/.local/bin:$PATH\" && npm i -g bun && npm ci && npx playwright test tests/e2e/generate-grid-screenshots.spec.ts'", "prettier": "prettier -u \"**/*.{js,jsx,ts,tsx,mjs,json,md,yml,yaml}\" --check", "prettier:fix": "prettier -u \"**/*.{js,jsx,ts,tsx,mjs,json,md,yml,yaml}\" --write", "check:versions": "node scripts/check-versions.mjs", + "bump": "node scripts/bump-version.mjs", "update-lock:docker": "rm -rf node_modules package-lock.json examples/*/node_modules && docker run --rm --platform linux/amd64 -v $(pwd):/work -w /work -e HOME=/tmp node:latest npm i --registry=https://registry.npmjs.org/ --ignore-scripts && rm -rf node_modules examples/*/node_modules && npm i --registry=https://registry.npmjs.org/" }, "author": "Olivier Chafik", + "//interop": "The @modelcontextprotocol/sdk 1.x and ext-apps-v1 devDependencies exist only for src/interop-v1.test.ts, which runs the published 1.7.5 package against this build. The library does not use them.", "devDependencies": { "@boneskull/typedoc-plugin-mermaid": "^0.2.0", - "@modelcontextprotocol/sdk": "1.25.2", + "@modelcontextprotocol/client": "2.0.0", + "@modelcontextprotocol/core": "2.0.0", + "@modelcontextprotocol/sdk": "1.30.0", + "@modelcontextprotocol/server": "2.0.0", "@playwright/test": "1.57.0", "@types/bun": "^1.3.2", + "@types/node": "20.19.27", "@types/react": "^19.2.2", "@types/react-dom": "^19.2.2", - "@types/node": "20.19.27", + "bun": "^1.2.21", "caniuse-lite": "1.0.30001763", "cheerio": "1.1.2", "concurrently": "^9.2.1", @@ -87,6 +97,7 @@ "electron-to-chromium": "1.5.267", "esbuild": "^0.25.12", "express": "^5.1.0", + "ext-apps-v1": "npm:@modelcontextprotocol/ext-apps@1.7.5", "husky": "^9.1.7", "nodemon": "^3.1.0", "playwright": "1.57.0", @@ -94,22 +105,26 @@ "prettier": "^3.6.2", "react": "^19.2.0", "react-dom": "^19.2.0", - "sharp": "^0.34.5", + "sharp": "^0.35.3", "ts-to-zod": "^5.1.0", "tsx": "^4.21.0", "typedoc": "^0.28.14", "typedoc-github-theme": "^0.4.0", "typescript": "^5.9.3", - "bun": "^1.2.21", - "zod": "^4.1.13" + "zod": "^4.2.0" }, "peerDependencies": { - "@modelcontextprotocol/sdk": "^1.24.0", + "@modelcontextprotocol/client": "^2.0.0", + "@modelcontextprotocol/core": "^2.0.0", + "@modelcontextprotocol/server": "^2.0.0", "react": "^17.0.0 || ^18.0.0 || ^19.0.0", "react-dom": "^17.0.0 || ^18.0.0 || ^19.0.0", - "zod": "^3.25.0 || ^4.0.0" + "zod": "^4.2.0" }, "peerDependenciesMeta": { + "@modelcontextprotocol/server": { + "optional": true + }, "react": { "optional": true }, @@ -121,7 +136,9 @@ "seroval": "1.4.1", "seroval-plugins": "1.4.2", "solid-js": "1.9.10", - "@hono/node-server": "1.19.7", "@types/node": "20.19.27" + }, + "dependencies": { + "@standard-schema/spec": "^1.1.0" } } diff --git a/playwright.config.ts b/playwright.config.ts index 1453521..ecf1e13 100644 --- a/playwright.config.ts +++ b/playwright.config.ts @@ -2,6 +2,13 @@ import { defineConfig, devices } from "@playwright/test"; export default defineConfig({ testDir: "./tests/e2e", + // Exclude the screenshot generation spec from default runs. + // It writes examples/*/grid-cell.png as a side effect and is meant to be + // invoked only via `npm run generate:screenshots` (which sets + // GENERATE_SCREENSHOTS=1 to bypass this ignore). + testIgnore: process.env.GENERATE_SCREENSHOTS + ? [] + : ["**/generate-grid-screenshots.spec.ts"], fullyParallel: true, forbidOnly: !!process.env.CI, retries: process.env.CI ? 2 : 0, @@ -23,6 +30,7 @@ export default defineConfig({ ...devices["Desktop Chrome"], // Use default Chromium everywhere for consistent screenshot rendering // Run `npm run test:e2e:docker` locally for CI-identical results + ...(process.env.PW_CHANNEL ? { channel: process.env.PW_CHANNEL } : {}), }, }, ], @@ -39,6 +47,10 @@ export default defineConfig({ env: { ...process.env, EXAMPLE: process.env.EXAMPLE ?? "", + // Let pdf-server fetch from the http://127.0.0.1 range-counting fixture + // (validateUrl rejects loopback HTTP unless this is set). Scoped to this + // server's check only β€” does not touch Node's TLS verification. + PDF_SERVER_ALLOW_LOOPBACK_HTTP: "1", }, }, // Snapshot configuration diff --git a/plugins/mcp-apps/skills/add-app-to-server/SKILL.md b/plugins/mcp-apps/skills/add-app-to-server/SKILL.md index 02d09a4..5a473f0 100644 --- a/plugins/mcp-apps/skills/add-app-to-server/SKILL.md +++ b/plugins/mcp-apps/skills/add-app-to-server/SKILL.md @@ -77,13 +77,28 @@ Before writing any code, analyze the server's existing tools and determine which ## Step 2: Add Dependencies ```bash -npm install @modelcontextprotocol/ext-apps +npm install @modelcontextprotocol/ext-apps @modelcontextprotocol/client@^2.0.0 @modelcontextprotocol/server@^2.0.0 zod@^4.2.0 npm install -D vite vite-plugin-singlefile ``` -Plus framework-specific dependencies if needed (e.g., `react`, `react-dom`, `@vitejs/plugin-react` for React). +Plus framework-specific dependencies if needed (e.g., `react`, `react-dom`, `@vitejs/plugin-react` for React), and `@modelcontextprotocol/node` / `@modelcontextprotocol/express` if the server uses HTTP transports. -Use `npm install` to add dependencies rather than manually writing version numbers. This lets npm resolve the latest compatible versions. Never specify version numbers from memory. +ext-apps 2.x requires the split base MCP SDK packages at `^2.0.0` +(`@modelcontextprotocol/core` comes in transitively). Existing servers that +still import `@modelcontextprotocol/sdk` v1 must migrate those imports and +handler schemas before adding the App integration: + +| SDK v1 (`@modelcontextprotocol/sdk`) | SDK v2 | +|---|---| +| `sdk/server/mcp.js` (`McpServer`) | `@modelcontextprotocol/server` | +| `sdk/server/streamableHttp.js` (`StreamableHTTPServerTransport`) | `NodeStreamableHTTPServerTransport` from `@modelcontextprotocol/node` | +| Express wiring by hand | `createMcpExpressApp` from `@modelcontextprotocol/express` | +| `sdk/server/stdio.js` | `@modelcontextprotocol/server/stdio` | +| `sdk/types.js` types (`CallToolResult`, …) | `@modelcontextprotocol/client` or `@modelcontextprotocol/server` | +| `sdk/types.js` zod schemas (`CallToolResultSchema`, …) | `@modelcontextprotocol/core` | +| Raw zod shapes: `inputSchema: { q: z.string() }` | `inputSchema: z.object({ q: z.string() })` | +| `extra.signal` in tool callbacks | `extra.mcpReq.signal` | +| `setRequestHandler(SomeRequestSchema, handler)` | `setRequestHandler("some/method", { params: ParamsSchema }, handler)` (the 2-arg form is only for spec methods such as `"tools/call"`) | ## Step 3: Set Up the Build Pipeline @@ -146,10 +161,14 @@ Transform plain MCP tools into App tools with UI. **Before** (plain MCP tool): ```typescript -server.tool("my-tool", { param: z.string() }, async (args) => { - const data = await fetchData(args.param); - return { content: [{ type: "text", text: JSON.stringify(data) }] }; -}); +server.registerTool( + "my-tool", + { inputSchema: z.object({ param: z.string() }) }, + async ({ param }) => { + const data = await fetchData(param); + return { content: [{ type: "text", text: JSON.stringify(data) }] }; + }, +); ``` **After** (App tool with UI): @@ -158,17 +177,22 @@ import { registerAppTool, registerAppResource, RESOURCE_MIME_TYPE } from "@model const resourceUri = "ui://my-tool/mcp-app.html"; -registerAppTool(server, "my-tool", { - description: "Shows data with an interactive UI", - inputSchema: { param: z.string() }, - _meta: { ui: { resourceUri } }, -}, async (args) => { - const data = await fetchData(args.param); - return { - content: [{ type: "text", text: JSON.stringify(data) }], // text fallback for non-UI hosts - structuredContent: { data }, // structured data for the UI - }; -}); +registerAppTool( + server, + "my-tool", + { + description: "Shows data with an interactive UI", + inputSchema: z.object({ param: z.string() }), + _meta: { ui: { resourceUri } }, + }, + async ({ param }) => { + const data = await fetchData(param); + return { + content: [{ type: "text", text: JSON.stringify(data) }], // text fallback for non-UI hosts + structuredContent: { data }, // structured data for the UI + }; + }, +); ``` Key guidance: @@ -187,17 +211,21 @@ import path from "node:path"; const resourceUri = "ui://my-tool/mcp-app.html"; -registerAppResource(server, { - uri: resourceUri, - name: "My Tool UI", - mimeType: RESOURCE_MIME_TYPE, -}, async () => { - const html = await fs.readFile( - path.resolve(import.meta.dirname, "dist", "mcp-app.html"), - "utf-8", - ); - return { contents: [{ uri: resourceUri, mimeType: RESOURCE_MIME_TYPE, text: html }] }; -}); +registerAppResource( + server, + "My Tool UI", + resourceUri, + {}, + async () => { + const html = await fs.readFile( + path.resolve(import.meta.dirname, "dist", "mcp-app.html"), + "utf-8", + ); + return { + contents: [{ uri: resourceUri, mimeType: RESOURCE_MIME_TYPE, text: html }], + }; + }, +); ``` If multiple tools share the same UI, they can reference the same `resourceUri` and the same resource registration. @@ -271,25 +299,32 @@ registerAppTool(server, "poll-data", { }); ``` -The UI calls these via `app.callServerTool("poll-data", {})`. +The UI calls these via +`app.callServerTool({ name: "poll-data", arguments: {} })`. ### CSP Configuration If the UI needs to load external resources (fonts, APIs, CDNs), declare the domains: ```typescript -registerAppResource(server, { - uri: resourceUri, - name: "My Tool UI", - mimeType: RESOURCE_MIME_TYPE, - _meta: { - ui: { - connectDomains: ["api.example.com"], // fetch/XHR targets - resourceDomains: ["cdn.example.com"], // scripts, styles, images - frameDomains: ["embed.example.com"], // nested iframes +registerAppResource(server, "My Tool UI", resourceUri, {}, async () => ({ + contents: [ + { + uri: resourceUri, + mimeType: RESOURCE_MIME_TYPE, + text: html, + _meta: { + ui: { + csp: { + connectDomains: ["https://api.example.com"], // fetch/XHR targets + resourceDomains: ["https://cdn.example.com"], // scripts, styles, images + frameDomains: ["https://embed.example.com"], // nested iframes + }, + }, + }, }, - }, -}, async () => { /* ... */ }); + ], +})); ``` ### Streaming Partial Input @@ -326,7 +361,14 @@ server.server.oninitialized = () => { }, appToolHandler); } else { // Text-only client β€” register plain tool - server.tool("my-tool", "Shows data", { param: z.string() }, plainToolHandler); + server.registerTool( + "my-tool", + { + description: "Shows data", + inputSchema: z.object({ param: z.string() }), + }, + plainToolHandler, + ); } }; ``` diff --git a/plugins/mcp-apps/skills/convert-web-app/SKILL.md b/plugins/mcp-apps/skills/convert-web-app/SKILL.md index 5db2d94..8fb7fa0 100644 --- a/plugins/mcp-apps/skills/convert-web-app/SKILL.md +++ b/plugins/mcp-apps/skills/convert-web-app/SKILL.md @@ -115,19 +115,22 @@ Create a new MCP server with tool and resource registration. This wraps the exis ### Dependencies ```bash -npm install @modelcontextprotocol/ext-apps @modelcontextprotocol/sdk zod +npm install @modelcontextprotocol/ext-apps @modelcontextprotocol/client@^2.0.0 @modelcontextprotocol/server@^2.0.0 zod@^4.2.0 npm install -D tsx vite vite-plugin-singlefile ``` -Use `npm install` to add dependencies rather than manually writing version numbers. This lets npm resolve the latest compatible versions. Never specify version numbers from memory. +Use `npm install` so the package manager resolves versions; ext-apps 2.x needs +the split base MCP SDK packages at `^2.0.0` (`@modelcontextprotocol/core` comes +in transitively). Do not add the legacy `@modelcontextprotocol/sdk` v1 package +or substitute unpublished local packages. ### Server Code Create `server.ts`: ```typescript -import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; -import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; +import { McpServer } from "@modelcontextprotocol/server"; +import { StdioServerTransport } from "@modelcontextprotocol/server/stdio"; import { registerAppTool, registerAppResource, RESOURCE_MIME_TYPE } from "@modelcontextprotocol/ext-apps/server"; import fs from "node:fs/promises"; import path from "node:path"; @@ -140,7 +143,9 @@ const resourceUri = "ui://my-app/mcp-app.html"; // Register the tool β€” inputSchema maps to the app's data sources registerAppTool(server, "show-app", { description: "Displays the app with the given parameters", - inputSchema: { query: z.string().describe("The search query") }, + inputSchema: z.object({ + query: z.string().describe("The search query"), + }), _meta: { ui: { resourceUri } }, }, async (args) => { // Process args server-side if needed @@ -151,19 +156,29 @@ registerAppTool(server, "show-app", { }); // Register the HTML resource -registerAppResource(server, { - uri: resourceUri, - name: "My App UI", - mimeType: RESOURCE_MIME_TYPE, - // Add CSP domains from Step 2 if needed: - // _meta: { ui: { connectDomains: ["api.example.com"], resourceDomains: ["cdn.example.com"] } }, -}, async () => { - const html = await fs.readFile( - path.resolve(import.meta.dirname, "dist", "mcp-app.html"), - "utf-8", - ); - return { contents: [{ uri: resourceUri, mimeType: RESOURCE_MIME_TYPE, text: html }] }; -}); +registerAppResource( + server, + "My App UI", + resourceUri, + {}, + async () => { + const html = await fs.readFile( + path.resolve(import.meta.dirname, "dist", "mcp-app.html"), + "utf-8", + ); + return { + contents: [ + { + uri: resourceUri, + mimeType: RESOURCE_MIME_TYPE, + text: html, + // Add CSP domains from Step 2 if needed: + // _meta: { ui: { csp: { connectDomains: ["https://api.example.com"], resourceDomains: ["https://cdn.example.com"] } } }, + }, + ], + }; + }, +); // Start the server const transport = new StdioServerTransport(); @@ -310,7 +325,10 @@ const data = await fetch("/api/data").then(r => r.json()); // After (hybrid): async function fetchData(): Promise { if (isMcpApp) { - const result = await app.callServerTool("fetch-data", {}); + const result = await app.callServerTool({ + name: "fetch-data", + arguments: {}, + }); return result.structuredContent; } return fetch("/api/data").then(r => r.json()); @@ -437,7 +455,8 @@ registerAppTool(server, "refresh-data", { }); ``` -The UI calls these via `app.callServerTool("refresh-data", {})`. +The UI calls these via +`app.callServerTool({ name: "refresh-data", arguments: {} })`. ### Streaming Partial Input diff --git a/plugins/mcp-apps/skills/create-mcp-app/SKILL.md b/plugins/mcp-apps/skills/create-mcp-app/SKILL.md index 5bd1219..d73dc90 100644 --- a/plugins/mcp-apps/skills/create-mcp-app/SKILL.md +++ b/plugins/mcp-apps/skills/create-mcp-app/SKILL.md @@ -110,11 +110,14 @@ See `/tmp/mcp-ext-apps/docs/patterns.md` for detailed recipes: **Always** use `npm install` to add dependencies rather than manually writing version numbers: ```bash -npm install @modelcontextprotocol/ext-apps @modelcontextprotocol/sdk zod express cors +npm install @modelcontextprotocol/ext-apps @modelcontextprotocol/client@^2.0.0 @modelcontextprotocol/server@^2.0.0 @modelcontextprotocol/node@^2.0.0 @modelcontextprotocol/express@^2.0.0 zod@^4.2.0 express cors npm install -D typescript vite vite-plugin-singlefile concurrently cross-env @types/node @types/express @types/cors ``` -This lets npm resolve the latest compatible versions. **Never** specify version numbers from memory. +ext-apps 2.x requires the split base MCP SDK packages (`@modelcontextprotocol/client`, +`server`, `node`, `express`) at `^2.0.0`; `@modelcontextprotocol/core` comes in +transitively. Do not add the legacy `@modelcontextprotocol/sdk` v1 package or +substitute unpublished local packages. ### TypeScript Server Execution diff --git a/scripts/bump-version.mjs b/scripts/bump-version.mjs new file mode 100644 index 0000000..65c878f --- /dev/null +++ b/scripts/bump-version.mjs @@ -0,0 +1,47 @@ +#!/usr/bin/env node +/** + * Bump the version in the root package.json and sync all workspace packages + * to the same version. + * + * Usage: + * node scripts/bump-version.mjs patch + * node scripts/bump-version.mjs minor + * node scripts/bump-version.mjs major + * node scripts/bump-version.mjs 1.4.0 + * node scripts/bump-version.mjs prerelease --preid=beta + * + * Writes the new version to stdout (logs go to stderr). + */ + +import { execSync } from "node:child_process"; +import { readFileSync } from "node:fs"; + +const args = process.argv.slice(2); +if (!args[0]) { + console.error( + "Usage: node scripts/bump-version.mjs [--preid=]", + ); + process.exit(1); +} + +const exec = (cmd) => + execSync(cmd, { stdio: ["inherit", "pipe", "inherit"] }) + .toString() + .trim(); + +const pkgName = JSON.parse(readFileSync("package.json", "utf-8")).name; + +const newVersion = exec( + `npm version ${args.join(" ")} --no-git-tag-version`, +).replace(/^v/, ""); +exec(`npm pkg set version=${newVersion} --workspaces`); + +// Keep workspace dependency ranges compatible (needed on major bumps) +const [major, minor] = newVersion.split("."); +exec(`npm pkg set "dependencies.${pkgName}=^${major}.${minor}.0" --workspaces`); + +// Sync package-lock.json so `npm ci` doesn't reject the release PR +exec("npm install --package-lock-only --ignore-scripts"); + +console.error(`Bumped root + workspaces to ${newVersion}`); +console.log(newVersion); diff --git a/scripts/check-dependency-isolation.mjs b/scripts/check-dependency-isolation.mjs new file mode 100644 index 0000000..3809224 --- /dev/null +++ b/scripts/check-dependency-isolation.mjs @@ -0,0 +1,209 @@ +import { execFileSync } from "node:child_process"; +import { + mkdtempSync, + mkdirSync, + readdirSync, + readFileSync, + rmSync, + writeFileSync, +} from "node:fs"; +import { tmpdir } from "node:os"; +import { join, resolve } from "node:path"; + +const root = resolve(import.meta.dirname, ".."); +const packageJson = JSON.parse( + readFileSync(join(root, "package.json"), "utf8"), +); +const client = "@modelcontextprotocol/client"; +const server = "@modelcontextprotocol/server"; + +// App and AppBridge extend the client package's Protocol class, so client is +// a required peer for every consumer. The server helpers are only needed by +// server authors, so server stays optional: View-only consumers must not have +// it installed or bundled. +for (const role of [client, server]) { + if (!packageJson.peerDependencies?.[role]) { + throw new Error(`${role} must remain a peer dependency`); + } +} +if (packageJson.peerDependenciesMeta?.[client]?.optional) { + throw new Error(`${client} must be a required peer dependency`); +} +if (packageJson.peerDependenciesMeta?.[server]?.optional !== true) { + throw new Error(`${server} must be an optional peer dependency`); +} + +/** + * Exact version for a synthetic consumer dependency. Read from + * devDependencies so the consumers exercise the same SDK version the + * repository tests against; the check would silently drift if a range were + * allowed here. + */ +function exactDevDependency(name) { + const version = packageJson.devDependencies?.[name]; + if (!/^\d+\.\d+\.\d+(-[0-9A-Za-z.-]+)?$/.test(version ?? "")) { + throw new Error( + `devDependencies["${name}"] must be an exact version, got ${JSON.stringify(version)}`, + ); + } + return version; +} + +/** Exact version of a package as installed in this repository's node_modules. */ +function installedVersion(name) { + return JSON.parse( + readFileSync(join(root, "node_modules", name, "package.json"), "utf8"), + ).version; +} + +const temporaryRoot = mkdtempSync(join(tmpdir(), "ext-apps-role-peers-")); +try { + // Minimal environment: nothing inherited from the caller's npm config + // (registry overrides, auth tokens, npm_config_* set by an outer `npm run`) + // can leak into the synthetic consumers. + const npmEnvironment = { + PATH: process.env.PATH ?? process.env.Path, + HOME: process.env.HOME ?? process.env.USERPROFILE, + npm_config_cache: join(temporaryRoot, "npm-cache"), + }; + const packDestination = join(temporaryRoot, "pack"); + mkdirSync(packDestination); + // `npm pack` runs the package's `prepare` script even with --ignore-scripts + // (pacote's directory fetcher), and its output can pollute stdout, so do not + // rely on `--json`: locate the tarball on disk instead. + execFileSync( + "npm", + ["pack", "--ignore-scripts", "--pack-destination", packDestination], + { cwd: root, stdio: "pipe", env: npmEnvironment }, + ); + const tarballs = readdirSync(packDestination).filter((name) => + name.endsWith(".tgz"), + ); + if (tarballs.length !== 1) { + throw new Error(`expected exactly one tarball, found ${tarballs}`); + } + const tarball = join(packDestination, tarballs[0]); + + const consumers = [ + { + // View / host author: ext-apps + client (+ react for the hooks entry). + name: "app-only", + dependencies: { + "@types/node": exactDevDependency("@types/node"), + "@types/react": installedVersion("@types/react"), + [client]: exactDevDependency(client), + "@modelcontextprotocol/ext-apps": `file:${tarball}`, + react: installedVersion("react"), + }, + absent: server, + // server must be neither installed (it is an optional peer) nor bundled. + mustNotInstall: true, + entry: + 'import { App } from "@modelcontextprotocol/ext-apps"; import { AppBridge } from "@modelcontextprotocol/ext-apps/app-bridge"; import { useApp } from "@modelcontextprotocol/ext-apps/react"; console.log(App, AppBridge, useApp);', + }, + { + // Server author: ext-apps + server. npm auto-installs client as a + // required peer (its types back the shared wire types), but the server + // entry must not pull it into a runtime bundle. + name: "server-only", + dependencies: { + "@types/node": exactDevDependency("@types/node"), + "@modelcontextprotocol/ext-apps": `file:${tarball}`, + [server]: exactDevDependency(server), + }, + absent: client, + mustNotInstall: false, + entry: + 'import { registerAppTool } from "@modelcontextprotocol/ext-apps/server"; console.log(registerAppTool);', + }, + ]; + + for (const consumer of consumers) { + const directory = join(temporaryRoot, consumer.name); + mkdirSync(directory); + writeFileSync( + join(directory, "package.json"), + JSON.stringify({ + private: true, + type: "module", + dependencies: consumer.dependencies, + }), + ); + execFileSync( + "npm", + [ + "install", + "--ignore-scripts", + "--package-lock=false", + "--no-audit", + "--no-fund", + ], + { cwd: directory, stdio: "inherit", env: npmEnvironment }, + ); + + if (consumer.mustNotInstall) { + const absentPath = join( + directory, + "node_modules", + ...consumer.absent.split("/"), + "package.json", + ); + try { + readFileSync(absentPath); + throw new Error( + `${consumer.name} unexpectedly installed ${consumer.absent}`, + ); + } catch (error) { + if (error?.code !== "ENOENT") throw error; + } + } + + writeFileSync(join(directory, "entry.ts"), consumer.entry); + writeFileSync( + join(directory, "tsconfig.json"), + JSON.stringify({ + compilerOptions: { + jsx: "react-jsx", + lib: ["ES2020", "DOM"], + module: "ESNext", + moduleResolution: "bundler", + noEmit: true, + skipLibCheck: false, + strict: true, + target: "ES2020", + }, + include: ["entry.ts"], + }), + ); + execFileSync( + process.execPath, + [join(root, "node_modules", "typescript", "bin", "tsc")], + { cwd: directory, stdio: "inherit" }, + ); + + const metafile = join(directory, "bundle-meta.json"); + execFileSync( + join(root, "node_modules", ".bin", "esbuild"), + [ + "entry.ts", + "--bundle", + "--platform=browser", + "--outfile=bundle.js", + `--metafile=${metafile}`, + ], + { cwd: directory, stdio: "inherit" }, + ); + const bundleInputs = Object.keys( + JSON.parse(readFileSync(metafile, "utf8")).inputs, + ).join("\n"); + if (bundleInputs.includes(`/node_modules/${consumer.absent}/`)) { + throw new Error( + `${consumer.name} unexpectedly bundled ${consumer.absent}`, + ); + } + } +} finally { + rmSync(temporaryRoot, { recursive: true, force: true }); +} + +console.log("Role peer dependency isolation checks passed."); diff --git a/scripts/generate-schemas.ts b/scripts/generate-schemas.ts index 858ab91..0ff9f04 100644 --- a/scripts/generate-schemas.ts +++ b/scripts/generate-schemas.ts @@ -8,19 +8,26 @@ * * ts-to-zod is a powerful tool but has limitations that require post-processing: * - * ### 1. Zod Import Path (keep standard `"zod"` for version agnosticism) + * ### 1. Zod Import Path (`"zod"` β†’ `"zod/v4"`) * - * ts-to-zod generates `import { z } from "zod"` which works with both - * Zod v3.25+ and v4. We keep this standard import to support both versions. + * ts-to-zod generates `import { z } from "zod"`. We rewrite this to + * `import { z } from "zod/v4"` because the generated schemas compose with + * schemas imported from `@modelcontextprotocol/core`, which the SDK + * constructs via `zod/v4`. Mixing schemas from the v3 and v4 APIs at runtime + * fails with errors like `keyValidator._parse is not a function` (v3 internals + * calling into v4 objects, or vice versa). The `zod/v4` subpath is exported by + * both zod 3.25+ and zod 4.x, so the peerDependency range is preserved. * * ### 2. External Type References (`z.any()` β†’ actual schemas) * * **Problem**: ts-to-zod cannot resolve types imported from external packages. * When it encounters types like `ContentBlock`, `CallToolResult`, `Implementation`, - * `RequestId`, and `Tool` from `@modelcontextprotocol/sdk`, it generates `z.any()` - * as a placeholder. + * `RequestId`, and `Tool` (imported by spec.types.ts from + * `@modelcontextprotocol/client`), it generates `z.any()` as a placeholder. * - * **Solution**: Import the schemas from MCP SDK and remove the z.any() placeholders. + * **Solution**: Import the corresponding Zod schemas from + * `@modelcontextprotocol/core` (the role-neutral package both client and + * server re-export) and remove the z.any() placeholders. * * ### 3. Index Signatures (`z.record().and()` β†’ `z.object().passthrough()`) * @@ -179,14 +186,16 @@ async function generateJsonSchema() { * Post-process generated schemas for project compatibility. */ function postProcess(content: string): string { - // 1. Add MCP SDK schema imports (keep standard zod import for v3/v4 compatibility) + // 1. Rewrite to zod/v4 and add MCP SDK schema imports. + // zod/v4 aligns with the SDK's own zod import β€” composing v3 and v4 + // schema instances throws at parse time. See header comment for details. const mcpImports = EXTERNAL_TYPE_SCHEMAS.join(",\n "); content = content.replace( 'import { z } from "zod";', - `import { z } from "zod"; + `import { z } from "zod/v4"; import { ${mcpImports}, -} from "@modelcontextprotocol/sdk/types.js";`, +} from "@modelcontextprotocol/core";`, ); // 2. Remove z.any() placeholders for external types (now imported from MCP SDK) @@ -257,7 +266,12 @@ function replaceRecordAndWithPassthrough(content: string): string { * Post-process generated integration tests. */ function postProcessTests(content: string): string { - // Keep standard zod import for v3/v4 compatibility + // Rewrite to zod/v4 so z.infer matches the v4 schemas in schema.ts. + content = content.replace( + 'import { z } from "zod";', + 'import { z } from "zod/v4";', + ); + content = content.replace( "// Generated by ts-to-zod", `// Generated by ts-to-zod diff --git a/scripts/link-self.mjs b/scripts/link-self.mjs index 41051bf..c1f79cc 100644 --- a/scripts/link-self.mjs +++ b/scripts/link-self.mjs @@ -5,10 +5,12 @@ * so examples always type-check against the latest local types. * See: https://github.com/npm/feedback/discussions/774 */ -import { cpSync, existsSync } from "fs"; +import { cpSync, existsSync, lstatSync } from "fs"; const target = "node_modules/@modelcontextprotocol/ext-apps"; if (!existsSync(target)) process.exit(0); +// If target is a symlink (e.g. to the repo root), dist is already current. +if (lstatSync(target).isSymbolicLink()) process.exit(0); cpSync("dist", `${target}/dist`, { recursive: true }); cpSync("package.json", `${target}/package.json`); diff --git a/scripts/typedoc-plugin-base-sdk-links.mjs b/scripts/typedoc-plugin-base-sdk-links.mjs new file mode 100644 index 0000000..6098918 --- /dev/null +++ b/scripts/typedoc-plugin-base-sdk-links.mjs @@ -0,0 +1,16 @@ +/** + * Resolve module-local links inherited from the base MCP SDK declarations. + * + * TypeDoc's externalSymbolLinkMappings handles package-qualified symbols, but + * the base SDK writes this particular reference as `index.inputRequired`. + */ + +const BASE_SDK_DOCS = "https://ts.sdk.modelcontextprotocol.io/v2/"; + +/** @param {import("typedoc").Application} app */ +export function load(app) { + app.converter.addUnknownSymbolResolver((ref) => { + const name = ref.symbolReference?.path?.map((part) => part.path).join("."); + if (name === "index.inputRequired") return BASE_SDK_DOCS; + }); +} diff --git a/scripts/typedoc-plugin-mcpstyle.mjs b/scripts/typedoc-plugin-mcpstyle.mjs index bcd40f7..aea65bc 100644 --- a/scripts/typedoc-plugin-mcpstyle.mjs +++ b/scripts/typedoc-plugin-mcpstyle.mjs @@ -4,6 +4,9 @@ * - Moves custom.css to load last so overrides win the cascade * - Replaces breadcrumbs with the document group name (e.g. "Security") * - Marks the current sidebar nav link for CSS highlighting + * - Rewrites the README logo to a pair of theme-tagged s so + * the logo follows the TypeDoc theme switcher (data-theme), not just the + * OS prefers-color-scheme media query */ import { Renderer } from "typedoc"; @@ -38,6 +41,17 @@ export function load(app) { ); } + // The README logo uses with prefers-color-scheme, which follows + // the OS setting and ignores the TypeDoc theme switcher (data-theme attr). + // Rewrite it as two tags β€” CSS in mcp-theme.css picks the correct + // one based on both data-theme and prefers-color-scheme (for "OS" mode). + page.contents = page.contents.replace( + /\s*\s*\s*]*)>\s*<\/picture>/, + (_, darkSrc, lightSrc, imgAttrs) => + `` + + ``, + ); + // Inject script to mark the current sidebar nav link with a "current" class. // TypeDoc does not natively add this class for document pages. // The sidebar is populated asynchronously from compressed navigation data, diff --git a/specification/draft/apps.mdx b/specification/draft/apps.mdx index e7c343b..f2523f2 100644 --- a/specification/draft/apps.mdx +++ b/specification/draft/apps.mdx @@ -289,6 +289,7 @@ When `_meta.ui` is present on **both**, the content-item value takes precedence. style-src 'self' 'unsafe-inline'; img-src 'self' data:; media-src 'self' data:; + object-src 'none'; connect-src 'none'; ``` @@ -506,16 +507,32 @@ If the Host is a web page, it MUST wrap the View and communicate with it through ### Standard MCP Messages -UI iframes can use the following subset of standard MCP protocol messages: +UI iframes can use the following subset of standard MCP protocol messages. + +Note that `tools/call` and `tools/list` flow **bidirectionally**: +- **App β†’ Host β†’ Server**: Apps call server tools (requires host `serverTools` capability) +- **Host β†’ App**: Host calls app-registered tools (requires app `tools` capability) **Tools:** -- `tools/call` - Execute a tool on the MCP server +- `tools/call` - Execute a tool (bidirectional) + - **App β†’ Host**: Call server tool via host proxy + - **Host β†’ App**: Call app-registered tool +- `tools/list` - List available tools (bidirectional) + - **App β†’ Host**: List server tools + - **Host β†’ App**: List app-registered tools +- `notifications/tools/list_changed` - Notify when tool list changes (bidirectional) + - **Server β†’ Host β†’ App**: Server tools changed + - **App β†’ Host**: App-registered tools changed **Resources:** - `resources/read` - Read resource content +**Sampling:** + +- `sampling/createMessage` - Request an LLM completion from the host (uses the standard MCP [`CreateMessageRequest`](https://modelcontextprotocol.io/specification/2025-11-25/client/sampling) / `CreateMessageResult` types, including SEP-1577 `tools` / `toolChoice` / `tool_use` content blocks). The host has full discretion over model selection and SHOULD apply rate limiting, cost controls, and user approval (human-in-the-loop). Apps MUST check `hostCapabilities.sampling` before sending this request, and `hostCapabilities.sampling.tools` before including `tools` in the request params. + **Notifications:** - `notifications/message` - Log messages to host @@ -531,8 +548,8 @@ When the View sends an `ui/initialize` request to the Host, it MUST include its ```typescript interface McpUiAppCapabilities { - /** Experimental features (structure TBD). */ - experimental?: {}; + /** Experimental features keyed by identifier. */ + experimental?: Record; /** App exposes MCP-style tools that the host can call. */ tools?: { /** App supports tools/list_changed notifications. */ @@ -643,9 +660,25 @@ Example: They describe the features and capabilities that the Host supports. ```typescript +/** Content block modalities that the host supports for a given capability. */ +interface SupportedContentBlockModalities { + /** Host supports text content blocks. */ + text?: {}; + /** Host supports image content blocks. */ + image?: {}; + /** Host supports audio content blocks. */ + audio?: {}; + /** Host supports resource content blocks. */ + resource?: {}; + /** Host supports resource link content blocks. */ + resourceLink?: {}; + /** Host supports structured content. */ + structuredContent?: {}; +} + interface HostCapabilities { - /** Experimental features (structure TBD). */ - experimental?: {}; + /** Experimental features keyed by identifier. */ + experimental?: Record; /** Host supports opening external URLs. */ openLinks?: {}; /** Host supports file downloads via ui/download-file. */ @@ -683,6 +716,21 @@ interface HostCapabilities { baseUriDomains?: string[]; }; }; + /** + * Host accepts context updates (ui/update-model-context) to be included in + * the model's context for future turns. + */ + updateModelContext?: SupportedContentBlockModalities; + /** Host supports receiving content messages (ui/message) from the view. */ + message?: SupportedContentBlockModalities; + /** + * Host supports LLM sampling (sampling/createMessage) from the view. + * Mirrors MCP ClientCapabilities.sampling so hosts can pass it through. + */ + sampling?: { + /** Host supports tool use via `tools` and `toolChoice` params (SEP-1577). */ + tools?: {}; + }; } ``` @@ -1188,6 +1236,95 @@ Host behavior: - If multiple updates are received before the next user message, Host SHOULD only send the last update to the model - MAY display context updates to the user +#### Requests (Host β†’ App) + +When Apps declare the `tools` capability, the Host can send standard MCP tool requests to the App: + +`tools/call` - Execute an App-registered tool + +```typescript +// Request (Host β†’ App) +{ + jsonrpc: "2.0", + id: 1, + method: "tools/call", + params: { + name: string, // Name of app-registered tool to execute + arguments?: object // Tool arguments (validated against inputSchema) + } +} + +// Success Response (App β†’ Host) +{ + jsonrpc: "2.0", + id: 1, + result: { + content: Array, // Result for model context + structuredContent?: object, // Optional structured data for UI + isError?: boolean, // True if tool execution failed + _meta?: object // Optional metadata + } +} + +// Error Response +{ + jsonrpc: "2.0", + id: 1, + error: { + code: number, + message: string + } +} +``` + +**App Behavior:** +- Apps MUST implement `oncalltool` handler if they declare `tools` capability +- Apps SHOULD validate tool names and arguments +- Apps MAY use `app.registerTool()` SDK helper for automatic validation +- Apps SHOULD return `isError: true` for tool execution failures + +`tools/list` - List App-registered tools + +```typescript +// Request (Host β†’ App) +{ + jsonrpc: "2.0", + id: 2, + method: "tools/list", + params: { + cursor?: string // Optional pagination cursor + } +} + +// Response (App β†’ Host) +{ + jsonrpc: "2.0", + id: 2, + result: { + tools: Array, // List of available tools + nextCursor?: string // Pagination cursor if more tools exist + } +} +``` + +**Tool Structure** (identical to [core MCP `Tool`](https://modelcontextprotocol.io/specification/2025-11-25/server/tools#tool)): +```typescript +interface Tool { + name: string; // Unique tool identifier + title?: string; // Display name + description?: string; // Human-readable description + inputSchema: object; // JSON Schema for arguments + outputSchema?: object; // JSON Schema for structuredContent + annotations?: ToolAnnotations; // MCP tool annotations (e.g., readOnlyHint) + _meta?: object; +} +``` + +**App Behavior:** +- Apps MUST implement `onlisttools` handler if they declare `tools` capability +- Apps SHOULD return complete tool metadata including schemas +- Apps MAY filter tools based on context or permissions + #### Notifications (Host β†’ View) `ui/notifications/tool-input` - Host MUST send this notification with the complete tool arguments after the View's initialize request completes. @@ -1285,9 +1422,11 @@ Host MUST send this notification if the tool execution was cancelled, for any re } ``` -Host MUST send this notification before tearing down the UI resource, for any reason, including user action, resource re-allocation, etc. The Host MAY specify the reason. +Host MUST send this notification before tearing down the UI resource, for any reason, including user action, view-initiated teardown, resource re-allocation, etc. The Host MAY specify the reason. Host SHOULD wait for a response before tearing down the resource (to prevent data loss). +#### Notifications (View β†’ Host) + `ui/notifications/size-changed` - View's size changed ```typescript @@ -1303,6 +1442,22 @@ Host SHOULD wait for a response before tearing down the resource (to prevent dat The View SHOULD send this notification when rendered content body size changes (e.g. using ResizeObserver API to report up to date size). +`ui/notifications/request-teardown` - View requests host to tear it down + +```typescript +{ + jsonrpc: "2.0", + method: "ui/notifications/request-teardown", + params: {} +} +``` + +The View MAY send this notification to request that the host tear it down. This enables View-initiated teardown flows (e.g., user clicks a "Done" button in the View). + +**Host behavior:** +- Host MAY defer or ignore the teardown request. +- If the Host accepts the request, it MUST follow the graceful termination process by sending `ui/resource-teardown` to the View. The Host SHOULD wait for a response before tearing down the resource (to prevent data loss). + `ui/notifications/host-context-changed` - Host context has changed ```typescript @@ -1455,19 +1610,24 @@ sequenceDiagram end ``` -#### 4. Cleanup +#### 4. Teardown + +The Host can tear down Views. Views may request teardown by sending `ui/notifications/request-teardown` to the Host. In any case, the Host MUST send `ui/resource-teardown` to allow the View to terminate gracefully. ```mermaid sequenceDiagram participant H as Host participant UI as View (iframe) + opt View-initiated teardown + UI ->> H: ui/notifications/request-teardown + end H ->> UI: ui/resource-teardown UI --> UI: Graceful termination UI -->> H: ui/resource-teardown response H -x H: Tear down iframe and listeners ``` -Note: Cleanup may be triggered at any point in the lifecycle following View initialization. +Note: Teardown may be triggered at any point in the lifecycle following View initialization. #### Key Differences from Pre-SEP MCP-UI: @@ -1576,6 +1736,446 @@ This pattern enables interactive, self-updating views. Note: Tools with `visibility: ["app"]` are hidden from the agent but remain callable by apps via `tools/call`. This enables UI-only interactions (refresh buttons, form submissions) without exposing implementation details to the model. See the Visibility section under Resource Discovery for details. +### App-Provided Tools + +Apps can register their own tools that hosts and agents can call, making apps **introspectable and accessible** to the model. This complements the existing capability where apps call server tools (via host proxy). + +#### Motivation: Semantic Introspection + +Without tool registration, apps are opaque to the model: +- The host renders the app in a sandboxed iframe and has no guaranteed access to its internals β€” apps may embed further cross-origin iframes (via `frameDomains`), and even where same-origin, DOM access is not part of the host↔app contract +- The model therefore cannot query app state or discover what operations the app supports + +With tool registration, apps expose a semantic interface: +- The model discovers available operations via `tools/list` +- The model queries app state via tools (e.g., `get_board_state`) +- The model executes actions via tools (e.g., `make_move`) +- Apps return structured data rather than relying on the host to interpret rendered output + +This is *pull*-based and complements the *push*-based [`ui/update-model-context`](#uiupdate-model-context) request already defined in this spec (and analogous mechanisms elsewhere, e.g. OAI Apps SDK's [`setWidgetState()`](https://developers.openai.com/apps-sdk/reference/sdk#setwidgetstate)). Push lets an app proactively keep the model's context current; pull lets the agent query and command the app on demand. Apps may use either or both. + +#### App Tool Registration + +Apps register tools using the SDK's `registerTool()` method: + +```typescript +import { App } from '@modelcontextprotocol/ext-apps'; +import { z } from 'zod'; + +const app = new App( + { name: "TicTacToe", version: "1.0.0" }, + { tools: { listChanged: true } } // Declare tool capability +); + +// Register a tool with schema validation +const moveTool = app.registerTool( + "tictactoe_move", + { + description: "Make a move in the tic-tac-toe game", + inputSchema: z.object({ + position: z.number().int().min(0).max(8), + player: z.enum(['X', 'O']) + }), + outputSchema: z.object({ + board: z.array(z.string()).length(9), + winner: z.enum(['X', 'O', 'draw', null]).nullable() + }), + annotations: { + readOnlyHint: false // This tool has side effects + } + }, + async (params) => { + // Validate and execute move + const newBoard = makeMove(params.position, params.player); + const winner = checkWinner(newBoard); + + return { + content: [{ + type: "text", + text: `Move made at position ${params.position}` + }], + structuredContent: { + board: newBoard, + winner + } + }; + } +); + +await app.connect(new PostMessageTransport(window.parent)); +``` + +**Registration Options:** + +| Field | Type | Required | Description | +|-------|------|----------|-------------| +| `name` | string | Yes | Unique tool identifier | +| `description` | string | No | Human-readable description for agent | +| `inputSchema` | [Standard Schema](https://standardschema.dev/) | No | Validates arguments; serialized to JSON Schema for `tools/list` | +| `outputSchema` | [Standard Schema](https://standardschema.dev/) | No | Validates `structuredContent` | +| `annotations` | ToolAnnotations | No | MCP tool hints (e.g., `readOnlyHint`) | +| `_meta` | object | No | Custom metadata | + +Apps can also implement tool handling manually without the SDK: + +```javascript +app.oncalltool = async (params, extra) => { + if (params.name === "tictactoe_move") { + // Manual validation + if (typeof params.arguments?.position !== 'number') { + throw new Error("Invalid position"); + } + + // Execute tool + const newBoard = makeMove(params.arguments.position, params.arguments.player); + + return { + content: [{ type: "text", text: "Move made" }], + structuredContent: { board: newBoard } + }; + } + + throw new Error(`Unknown tool: ${params.name}`); +}; + +app.onlisttools = async () => { + return { + tools: [ + { + name: "tictactoe_move", + description: "Make a move in the game", + inputSchema: { + type: "object", + properties: { + position: { type: "number", minimum: 0, maximum: 8 }, + player: { type: "string", enum: ["X", "O"] } + }, + required: ["position", "player"] + } + } + ] + }; +}; +``` + +#### Tool Lifecycle + +Registered tools support dynamic lifecycle management: + +**Enable/Disable:** + +```typescript +const tool = app.registerTool("my_tool", config, callback); + +// Disable tool (hide from tools/list) +tool.disable(); + +// Re-enable tool +tool.enable(); +``` + +When a tool is disabled/enabled, the app automatically sends `notifications/tools/list_changed` (if the app declared `listChanged: true` capability). + +**Update:** + +```typescript +// Update tool description or schema +tool.update({ + description: "New description", + inputSchema: newSchema +}); +``` + +Updates also trigger `notifications/tools/list_changed`. + +**Remove:** + +```typescript +// Permanently remove tool +tool.remove(); +``` + +#### Long-Running App Tools + +App tools are bounded by the app's render lifecycle. For work that may outlive a single render, app `tools/call` MAY be task-augmented per [core MCP Tasks](https://modelcontextprotocol.io/specification/2025-11-25/basic/utilities/tasks); hosts proxy the `tasks/*` methods to the app exactly as they proxy `tools/call`. Because the iframe can be torn down at any time, apps SHOULD delegate long-lived work to the server (via `callServerTool()`) and return the server's task handle, so the host can continue polling the server after teardown. + +#### Schema Validation + +The SDK validates input and output against any [Standard Schema](https://standardschema.dev/)–compatible library (Zod, ArkType, Valibot, …). Examples below use Zod: + +**Input Validation:** + +```typescript +app.registerTool( + "search", + { + inputSchema: z.object({ + query: z.string().min(1).max(100), + limit: z.number().int().positive().default(10) + }) + }, + async (params) => { + // params.query is guaranteed to be a string (1-100 chars) + // params.limit is guaranteed to be a positive integer (default 10) + return performSearch(params.query, params.limit); + } +); +``` + +If the host sends invalid arguments, the tool automatically returns an error before the callback is invoked. + +**Output Validation:** + +```typescript +app.registerTool( + "get_status", + { + outputSchema: z.object({ + status: z.enum(['ready', 'busy', 'error']), + timestamp: z.string().datetime() + }) + }, + async () => { + return { + content: [{ type: "text", text: "Status retrieved" }], + structuredContent: { + status: 'ready', + timestamp: new Date().toISOString() + } + }; + } +); +``` + +If the callback returns data that doesn't match `outputSchema`, the tool returns an error. + +#### Complete Example: Introspectable Tic-Tac-Toe + +This example demonstrates how apps expose semantic interfaces through tools: + +```typescript +import { App } from '@modelcontextprotocol/ext-apps'; +import { z } from 'zod'; + +// Game state +let board: Array<'X' | 'O' | null> = Array(9).fill(null); +let currentPlayer: 'X' | 'O' = 'X'; +let moveHistory: number[] = []; + +const app = new App( + { name: "TicTacToe", version: "1.0.0" }, + { tools: { listChanged: true } } +); + +// Agent can query semantic state directly +app.registerTool( + "get_board_state", + { + description: "Get current game state including board, current player, and winner", + outputSchema: z.object({ + board: z.array(z.enum(['X', 'O', null])).length(9), + currentPlayer: z.enum(['X', 'O']), + winner: z.enum(['X', 'O', 'draw', null]).nullable(), + moveHistory: z.array(z.number()) + }) + }, + async () => { + return { + content: [{ + type: "text", + text: `Board: ${board.map(c => c || '-').join('')}, Player: ${currentPlayer}` + }], + structuredContent: { + board, + currentPlayer, + winner: checkWinner(board), + moveHistory + } + }; + } +); + +// Agent can execute moves +app.registerTool( + "make_move", + { + description: "Place a piece at the specified position", + inputSchema: z.object({ + position: z.number().int().min(0).max(8) + }), + annotations: { readOnlyHint: false } + }, + async ({ position }) => { + if (board[position] !== null) { + return { + content: [{ type: "text", text: "Position already taken" }], + isError: true + }; + } + + board[position] = currentPlayer; + moveHistory.push(position); + const winner = checkWinner(board); + currentPlayer = currentPlayer === 'X' ? 'O' : 'X'; + + return { + content: [{ + type: "text", + text: `Player ${board[position]} moved to position ${position}` + + (winner ? `. ${winner} wins!` : '') + }], + structuredContent: { + board, + currentPlayer, + winner, + moveHistory + } + }; + } +); + +// Agent can reset game +app.registerTool( + "reset_game", + { + description: "Reset the game board to initial state", + annotations: { readOnlyHint: false } + }, + async () => { + board = Array(9).fill(null); + currentPlayer = 'X'; + moveHistory = []; + + return { + content: [{ type: "text", text: "Game reset" }], + structuredContent: { board, currentPlayer, moveHistory } + }; + } +); + +await app.connect(new PostMessageTransport(window.parent)); + +function checkWinner(board: Array<'X' | 'O' | null>): 'X' | 'O' | 'draw' | null { + const lines = [ + [0, 1, 2], [3, 4, 5], [6, 7, 8], // rows + [0, 3, 6], [1, 4, 7], [2, 5, 8], // columns + [0, 4, 8], [2, 4, 6] // diagonals + ]; + + for (const [a, b, c] of lines) { + if (board[a] && board[a] === board[b] && board[a] === board[c]) { + return board[a]; + } + } + + return board.every(cell => cell !== null) ? 'draw' : null; +} +``` + +**Agent Interaction:** + +```typescript +// 1. Discover available operations +const { tools } = await bridge.sendListTools({}); +// β†’ ["get_board_state", "make_move", "reset_game"] + +// 2. Query semantic state (not visual/DOM) +const state = await bridge.sendCallTool({ + name: "get_board_state", + arguments: {} +}); +// β†’ { board: [null, null, null, ...], currentPlayer: 'X', winner: null } + +// 3. Execute actions based on semantic understanding +if (state.structuredContent.board[4] === null) { + await bridge.sendCallTool({ + name: "make_move", + arguments: { position: 4 } + }); +} + +// 4. Query updated state +const newState = await bridge.sendCallTool({ + name: "get_board_state", + arguments: {} +}); +// β†’ { board: [null, null, null, null, 'X', null, ...], currentPlayer: 'O', ... } +``` + +The agent interacts with the app through semantic operations rather than visual interpretation. + +#### Tool Flow Directions + +**Existing Flow (unchanged): App β†’ Host β†’ Server** + +Apps call server tools (proxied by host): + +```typescript +// App calls server tool +const result = await app.callServerTool("get_weather", { location: "NYC" }); +``` + +Requires host `serverTools` capability. + +**New Flow: Host/Agent β†’ App** + +Host/Agent calls app-registered tools: + +```typescript +// Host calls app tool +const result = await bridge.sendCallTool({ + name: "tictactoe_move", + arguments: { position: 4 } +}); +``` + +Requires app `tools` capability. + +**Key Distinction:** + +| Aspect | Server Tools | App Tools | +|--------|-------------|-----------| +| **Lifetime** | Persistent (server process) | Ephemeral (while app loaded) | +| **Source** | MCP Server | App JavaScript | +| **Trust** | Trusted | Sandboxed (untrusted) | +| **Discovery** | Server `tools/list` | App `tools/list` (when app declares capability) | +| **When Available** | Always | Only while app is loaded | + +#### Use Cases + +**Introspection:** Agent queries app state semantically β€” the app's DOM is not exposed to the host or model + +**Voice mode:** Agent drives app interactions programmatically based on voice commands + +**Accessibility:** Structured state and operations more accessible than visual rendering + +**Complex workflows:** Agent discovers available operations and coordinates multi-step interactions + +**Stateful apps:** Apps expose operations (move, reset, query) rather than pushing state updates via messages + +#### Security Implications + +App tools run in **sandboxed iframes** (untrusted). See Security Implications section for detailed mitigations. + +Key considerations: +- App tools could provide misleading descriptions +- Tool namespacing needed to avoid conflicts with server tools +- Resource limits (max tools, execution timeouts) +- Audit trail for app tool invocations +- User confirmation for tools with side effects + +#### Relation to WebMCP + +This feature is inspired by [WebMCP](https://github.com/webmachinelearning/webmcp) (W3C incubation), which proposes allowing web pages to register JavaScript functions as tools via `navigator.modelContext.registerTool()`. + +Key differences: +- **WebMCP**: General web pages, browser API, manifest-based discovery +- **This spec**: MCP Apps, standard MCP messages, capability-based negotiation + +Similar to WebMCP but without turning the App (embedded page) into an MCP server - apps register tools within the App/Host architecture. + +See [ext-apps#35](https://github.com/modelcontextprotocol/ext-apps/issues/35) for discussion. + ### Client\<\>Server Capability Negotiation Clients and servers negotiate MCP Apps support through the standard MCP extensions capability mechanism (defined in SEP-1724). @@ -1646,15 +2246,104 @@ if (uiCap?.mimeTypes?.includes(RESOURCE_MIME_TYPE)) { - Tools MUST return meaningful content array even when UI is available - Servers MAY register different tool variants based on host capabilities +#### App (Guest UI) Capabilities + +Apps advertise their capabilities in the `ui/initialize` request to the host. When an app supports tool registration, it includes the `tools` capability: + +```json +{ + "method": "ui/initialize", + "params": { + "appInfo": { + "name": "TicTacToe", + "version": "1.0.0" + }, + "appCapabilities": { + "tools": { + "listChanged": true + } + } + } +} +``` + +The host responds with its own capabilities, including support for proxying server tools: + +```json +{ + "result": { + "hostInfo": { + "name": "claude-desktop", + "version": "1.0.0" + }, + "hostCapabilities": { + "serverTools": { + "listChanged": true + }, + "openLinks": {}, + "logging": {} + } + } +} +``` + +**App Capability: `tools`** + +When present, the app can register tools that the host and agent can call. + +- `listChanged` (boolean, optional): If `true`, the app will send `notifications/tools/list_changed` when tools are added, removed, or modified + +**Host Capability: `serverTools`** + +When present, the host can proxy calls from the app to MCP server tools. + +- `listChanged` (boolean, optional): If `true`, the host will send `notifications/tools/list_changed` when server tools change + +These capabilities are independent - an app can have one, both, or neither. + +**TypeScript Types:** + +```typescript +interface McpUiAppCapabilities { + tools?: { + listChanged?: boolean; + }; +} + +interface McpUiHostCapabilities { + serverTools?: { + listChanged?: boolean; + }; + openLinks?: {}; + logging?: {}; +} +``` + ### Extensibility -This specification defines the Minimum Viable Product (MVP) for MCP Apps. Future extensions may include: +This specification defines the Minimum Viable Product (MVP) for MCP Apps. + +**Included in MVP:** + +- **App-Provided Tools:** Apps can register tools via `app.registerTool()` that agents can call + - Bidirectional tool flow (Apps consume server tools AND provide app tools) + - Full lifecycle management (enable/disable/update/remove) + - Schema validation via [Standard Schema](https://standardschema.dev/) (Zod, ArkType, Valibot, …) + - Tool list change notifications **Content Types (deferred from MVP):** - `externalUrl`: Embed external web applications (e.g., `text/uri-list`) -**Advanced Features (see Future Considerations):** +**Advanced Tool Features (future extensions):** + +- Tool namespacing standards and conventions +- Standardized permission model specifications +- Tool categories/tags for organization +- Cross-app tool composition +- Tool marketplace/discovery mechanisms + +**Other Advanced Features (see Future Considerations):** - Support multiple UI resources in a tool response - State persistence and restoration @@ -1692,7 +2381,7 @@ This proposal synthesizes feedback from the UI CWG and MCP-UI community, host im - Reuses existing MCP infrastructure (type definitions, error handling, timeouts) - UI developers can use standard MCP SDK (`@modelcontextprotocol/sdk`) or alternatives -- Automatic compatibility with future MCP features (long-running tools, sampling, etc.) +- Automatic compatibility with core MCP features (Tasks for long-running calls, sampling, etc.) - Better auditability through structured JSON-RPC messages - Reduces maintenance burden (no parallel protocol to evolve) @@ -1754,6 +2443,37 @@ This proposal synthesizes feedback from the UI CWG and MCP-UI community, host im - **Boolean `private` flag:** Simpler but less flexible; doesn't express model-only tools. - **Flat `ui/visibility` key:** Rejected in favor of nested structure for consistency with future `_meta.ui` fields. +#### 6. App Tool Registration Support + +**Decision:** Enable Apps to register tools using standard MCP `tools/call` and `tools/list` messages, making tools flow bidirectionally between Apps and Hosts. + +**Rationale:** + +- **Semantic introspection:** Apps expose state and operations in a structured, machine-readable form. Hosts have no guaranteed DOM access into an app (which may itself nest cross-origin frames via `frameDomains`), so a tool surface is the only reliable introspection path +- **Protocol reuse:** Reuses existing MCP tool infrastructure (`tools/call`, `tools/list`, `notifications/tools/list_changed`) instead of inventing new message types +- **WebMCP alignment:** Brings WebMCP's vision of "JavaScript functions as tools" to MCP Apps while staying MCP-native +- **Agent-driven interaction:** Agents can pull app state and issue commands on demand, complementing push-style [`ui/update-model-context`](#uiupdate-model-context) +- **Bidirectional symmetry:** Apps act as both MCP clients (calling server tools) and MCP servers (providing app tools), creating clean architectural symmetry +- **Use case coverage:** Enables interactive games, stateful forms, complex workflows, and reusable widgets + +**Alternatives considered:** + +- **Custom app-action API:** Rejected because it would duplicate MCP's existing tool infrastructure and create parallel protocol semantics. Using standard `tools/call` means automatic compatibility with future MCP features and better ecosystem integration. +- **Server-side proxy tools:** Apps could expose operations by having the server register proxy tools that communicate back to the app. Rejected because it doesn't leverage the app's JavaScript execution environment, adds unnecessary round-trips, and couples app functionality to server implementation. +- **Resources instead of tools:** Apps could expose state via `resources/read` rather than tools. Rejected because resources have wrong semantics (passive data retrieval vs. active operations), don't support parameters well, and don't convey operational intent. + +**Security implications:** + +Apps are forward-deployed emanations of server tools, running in the client context. Hosts should consider how to handle tool call approval: + +- Per-app-instance approval (confirm each time a specific app instance calls a tool) +- Per-server approval (approve all apps from a trusted server) +- Per-tool approval (approve based on tool semantics and annotations) +- Clear attribution showing which app instance is calling a tool +- Audit trails for app tool calls + +See [Security Implications: App-Provided Tools Security](#5-app-provided-tools-security) for detailed considerations. + ### Backward Compatibility The proposal builds on the existing core protocol. There are no incompatibilities. @@ -1846,6 +2566,83 @@ const allowAttribute = allowList.join(' '); - Host SHOULD warn users when UI requires external domain access - Host MAY implement global domain allowlists/blocklists +#### 5. App-Provided Tools Security + +Apps can register their own tools that agents can call. Apps are forward-deployed emanations of server tools, running in the client context. Hosts need to decide how to handle approval for app tool calls. + +**Approval Considerations:** + +App-provided tools introduce additional approval considerations: + +- **Tool description accuracy:** Apps may describe tools in ways that don't fully capture side effects +- **Namespace conflicts:** Apps could register tools with names conflicting with server tools +- **Resource consumption:** Apps could register many tools or implement slow callbacks +- **Data validation:** Tool results should match declared schemas +- **Semantic clarity:** Tool operations should be clear from their descriptions + +**Approval Granularity:** + +Hosts have discretion in how they handle app tool call approval: + +1. **Per-app-instance approval:** Confirm each time a specific app instance's tool is called +2. **Per-server approval:** Trust all apps from servers the user has approved +3. **Per-tool approval:** Approve based on tool annotations (e.g., `readOnlyHint`) +4. **Hybrid approaches:** Combine strategies (e.g., auto-approve read-only tools from trusted servers) + +**Host Protections:** + +Hosts SHOULD implement the following protections for app-provided tools: + +1. **Clear Attribution:** + - Display tool source in agent's tool list (e.g., "Tool from TicTacToe App") + - Visually distinguish app tools from server tools in UI + - Show app name and version in tool call confirmations + +2. **User Confirmation:** + - Require explicit user approval for tools with `readOnlyHint: false` + - Consider auto-approving tools with `readOnlyHint: true` after review + - Implement per-app permission settings (always allow, always deny, ask) + +3. **Namespace Management:** + - Recommend or enforce tool name prefixes (e.g., `app:move`, `tictactoe:move`) + - Prevent apps from registering tool names that conflict with server tools + - Document namespace conventions for app developers + +4. **Resource Limits:** + - Limit maximum number of tools per app (recommended: 50) + - Enforce execution timeouts for tool callbacks (recommended: 30 seconds) + - Limit tool result sizes (recommended: 10 MB) + - Throttle `tools/list_changed` notifications to prevent spam + +5. **Audit Trail:** + - Log all app tool registrations with timestamps + - Log all app tool calls with arguments and results + - Provide audit interface for users to review app tool activity + +6. **Result Validation:** + - Validate tool results match declared schemas + - Sanitize result content before displaying to user or agent + - Reject results that appear malicious (e.g., phishing content) + +**Permission Model:** + +Hosts MAY implement different permission levels based on tool annotations: + +| Annotation | Recommended Permission | Example | +|---------------------|------------------------|-------------------| +| `readOnlyHint: true`| Auto-approve (with caution) | `get_board_state()` | +| `readOnlyHint: false` | User confirmation required | `make_move()` | +| No annotation | User confirmation required (safe default) | Any tool | + +**App Tool Lifecycle:** + +App tools MUST be tied to the app's lifecycle: + +- Tools become available once the app advertises the `tools` capability in `ui/initialize` and the host issues `tools/list`; subsequent changes are signaled via `notifications/tools/list_changed` +- Tools automatically disappear when app iframe is torn down +- Hosts MUST NOT persist app tool registrations across sessions +- Calling a tool from a closed app MUST return an error + ### Other risks - **Social engineering:** UI can still display misleading content. Hosts should clearly indicate sandboxed UI boundaries. diff --git a/src/app-bridge.examples.ts b/src/app-bridge.examples.ts index b613451..47ad623 100644 --- a/src/app-bridge.examples.ts +++ b/src/app-bridge.examples.ts @@ -7,15 +7,11 @@ * @module */ -import { Client } from "@modelcontextprotocol/sdk/client/index.js"; -import type { Transport } from "@modelcontextprotocol/sdk/shared/transport.js"; -import { - CallToolResult, - CallToolResultSchema, - ListResourcesResultSchema, - ReadResourceResultSchema, - ListPromptsResultSchema, -} from "@modelcontextprotocol/sdk/types.js"; +import { Client, type Transport } from "@modelcontextprotocol/client"; +import type { + CreateMessageRequest, + CreateMessageResult, +} from "@modelcontextprotocol/server"; import { AppBridge, PostMessageTransport } from "./app-bridge.js"; import type { McpUiDisplayMode } from "./types.js"; @@ -221,13 +217,34 @@ function AppBridge_oncalltool_forwardToServer( bridge.oncalltool = async (params, extra) => { return mcpClient.request( { method: "tools/call", params }, - CallToolResultSchema, - { signal: extra.signal }, + { signal: extra.mcpReq.signal }, ); }; //#endregion AppBridge_oncalltool_forwardToServer } +/** + * Example: Forward sampling requests to your LLM provider. + */ +function AppBridge_oncreatesamplingmessage_forwardToLlm( + bridge: AppBridge, + myLlmProvider: { + complete: ( + params: CreateMessageRequest["params"], + opts: { signal: AbortSignal }, + ) => Promise; + }, +) { + //#region AppBridge_oncreatesamplingmessage_forwardToLlm + bridge.oncreatesamplingmessage = async (params, extra) => { + // Apply rate limiting, user approval, cost controls here + return await myLlmProvider.complete(params, { + signal: extra.mcpReq.signal, + }); + }; + //#endregion AppBridge_oncreatesamplingmessage_forwardToLlm +} + /** * Example: Forward list resources requests to the MCP server. */ @@ -239,8 +256,7 @@ function AppBridge_onlistresources_returnResources( bridge.onlistresources = async (params, extra) => { return mcpClient.request( { method: "resources/list", params }, - ListResourcesResultSchema, - { signal: extra.signal }, + { signal: extra.mcpReq.signal }, ); }; //#endregion AppBridge_onlistresources_returnResources @@ -257,8 +273,7 @@ function AppBridge_onreadresource_returnResource( bridge.onreadresource = async (params, extra) => { return mcpClient.request( { method: "resources/read", params }, - ReadResourceResultSchema, - { signal: extra.signal }, + { signal: extra.mcpReq.signal }, ); }; //#endregion AppBridge_onreadresource_returnResource @@ -275,8 +290,7 @@ function AppBridge_onlistprompts_returnPrompts( bridge.onlistprompts = async (params, extra) => { return mcpClient.request( { method: "prompts/list", params }, - ListPromptsResultSchema, - { signal: extra.signal }, + { signal: extra.mcpReq.signal }, ); }; //#endregion AppBridge_onlistprompts_returnPrompts @@ -422,10 +436,10 @@ async function AppBridge_sendToolResult_afterExecution( args: Record, ) { //#region AppBridge_sendToolResult_afterExecution - const result = await mcpClient.request( - { method: "tools/call", params: { name: "get_weather", arguments: args } }, - CallToolResultSchema, - ); + const result = await mcpClient.request({ + method: "tools/call", + params: { name: "get_weather", arguments: args }, + }); bridge.sendToolResult(result); //#endregion AppBridge_sendToolResult_afterExecution } diff --git a/src/app-bridge.test.ts b/src/app-bridge.test.ts index adbe62c..a87b0e7 100644 --- a/src/app-bridge.test.ts +++ b/src/app-bridge.test.ts @@ -1,26 +1,19 @@ -import { describe, it, expect, beforeEach, afterEach } from "bun:test"; -import { InMemoryTransport } from "@modelcontextprotocol/sdk/inMemory.js"; -import type { Client } from "@modelcontextprotocol/sdk/client/index.js"; -import type { ServerCapabilities } from "@modelcontextprotocol/sdk/types.js"; -import { - EmptyResultSchema, - ListPromptsResultSchema, - ListResourcesResultSchema, - ListResourceTemplatesResultSchema, - PromptListChangedNotificationSchema, - ReadResourceResultSchema, - ResourceListChangedNotificationSchema, - ToolListChangedNotificationSchema, -} from "@modelcontextprotocol/sdk/types.js"; +import { describe, it, expect, beforeEach, afterEach, spyOn } from "bun:test"; +import { Client, InMemoryTransport } from "@modelcontextprotocol/client"; +import { Server, type ServerCapabilities } from "@modelcontextprotocol/server"; +import { z } from "zod/v4"; -import { App } from "./app"; +import { App } from "./app.js"; +import { LATEST_PROTOCOL_VERSION } from "./types.js"; import { AppBridge, + buildAllowAttribute, getToolUiResourceUri, isToolVisibilityModelOnly, isToolVisibilityAppOnly, + McpUiOpenLinkResultSchema, type McpUiHostCapabilities, -} from "./app-bridge"; +} from "./app-bridge.js"; /** Wait for pending microtasks to complete */ const flush = () => new Promise((resolve) => setTimeout(resolve, 0)); @@ -31,17 +24,27 @@ const flush = () => new Promise((resolve) => setTimeout(resolve, 0)); */ function createMockClient( serverCapabilities: ServerCapabilities = {}, -): Pick { +): Pick< + Client, + | "getServerCapabilities" + | "request" + | "notification" + | "setNotificationHandler" +> { return { getServerCapabilities: () => serverCapabilities, request: async () => ({}) as never, notification: async () => {}, + setNotificationHandler: () => {}, }; } const testHostInfo = { name: "TestHost", version: "1.0.0" }; const testAppInfo = { name: "TestApp", version: "1.0.0" }; const testHostCapabilities: McpUiHostCapabilities = { + experimental: { + "com.example/host-extension": { version: 1 }, + }, openLinks: {}, serverTools: {}, logging: {}, @@ -82,6 +85,53 @@ describe("App <-> AppBridge integration", () => { expect(initializedFired).toBe(true); }); + it("sends only the Apps handshake on the wire and gates the Apps-ready callback", async () => { + const methods: string[] = []; + let releaseAppsInitialized!: () => void; + let reachedAppsInitialized!: () => void; + const appsInitializedGate = new Promise((resolve) => { + releaseAppsInitialized = resolve; + }); + const reachedGate = new Promise((resolve) => { + reachedAppsInitialized = resolve; + }); + const originalSend = appTransport.send.bind(appTransport); + appTransport.send = async (message, options) => { + if ("method" in message) methods.push(message.method); + if ( + "method" in message && + message.method === "ui/notifications/initialized" + ) { + reachedAppsInitialized(); + await appsInitializedGate; + } + return originalSend(message, options); + }; + + let singularCalls = 0; + let listenerCalls = 0; + bridge.oninitialized = () => singularCalls++; + bridge.addEventListener("initialized", () => listenerCalls++); + + await bridge.connect(bridgeTransport); + const connecting = app.connect(appTransport); + await reachedGate; + + expect(methods).toEqual([ + "ui/initialize", + "ui/notifications/initialized", + ]); + expect(bridge.getAppVersion()).toEqual(testAppInfo); + expect(singularCalls).toBe(0); + expect(listenerCalls).toBe(0); + + releaseAppsInitialized(); + await connecting; + + expect(singularCalls).toBe(1); + expect(listenerCalls).toBe(1); + }); + it("App receives host info and capabilities after connect", async () => { await bridge.connect(bridgeTransport); await app.connect(appTransport); @@ -91,10 +141,16 @@ describe("App <-> AppBridge integration", () => { const hostCaps = app.getHostCapabilities(); expect(hostCaps).toEqual(testHostCapabilities); + expect(bridge.getCapabilities()).toEqual(testHostCapabilities); }); it("Bridge receives app info and capabilities after initialization", async () => { - const appCapabilities = { tools: { listChanged: true } }; + const appCapabilities = { + experimental: { + "com.example/app-extension": { version: 1 }, + }, + tools: { listChanged: true }, + }; app = new App(testAppInfo, appCapabilities, { autoResize: false }); await bridge.connect(bridgeTransport); @@ -514,12 +570,37 @@ describe("App <-> AppBridge integration", () => { }; await app.connect(appTransport); - await expect( + expect( app.updateModelContext({ content: [{ type: "text", text: "Test" }], }), ).rejects.toThrow("Context update failed"); }); + + it("app.requestTeardown allows host to initiate teardown flow", async () => { + const events: string[] = []; + + bridge.onrequestteardown = async () => { + events.push("teardown-requested"); + await bridge.teardownResource({}); + events.push("teardown-complete"); + }; + + app.onteardown = async () => { + events.push("persist-unsaved-state"); + return {}; + }; + + await app.connect(appTransport); + await app.requestTeardown(); + await flush(); + + expect(events).toEqual([ + "teardown-requested", + "persist-unsaved-state", + "teardown-complete", + ]); + }); }); describe("App -> Host requests", () => { @@ -586,6 +667,30 @@ describe("App <-> AppBridge integration", () => { expect(result.isError).toBe(true); }); + + it("rejects invalid params for a custom ui request", async () => { + bridge.onopenlink = async () => ({}); + await app.connect(appTransport); + + await expect( + app.request( + { + method: "ui/open-link", + params: { url: 42 }, + }, + McpUiOpenLinkResultSchema, + ), + ).rejects.toThrow(); + }); + + it("rejects invalid results from a custom ui handler", async () => { + bridge.onopenlink = async () => ({ isError: "yes" }) as never; + await app.connect(appTransport); + + await expect( + app.openLink({ url: "https://example.com" }), + ).rejects.toThrow(); + }); }); describe("deprecated method aliases", () => { @@ -622,7 +727,7 @@ describe("App <-> AppBridge integration", () => { // Attempting to connect again with a different transport should throw const [, secondBridgeTransport] = InMemoryTransport.createLinkedPair(); - await expect(bridge.connect(secondBridgeTransport)).rejects.toThrow( + expect(bridge.connect(secondBridgeTransport)).rejects.toThrow( "AppBridge is already connected", ); }); @@ -633,7 +738,7 @@ describe("App <-> AppBridge integration", () => { // Attempting to connect again should throw const [secondAppTransport] = InMemoryTransport.createLinkedPair(); - await expect(app.connect(secondAppTransport)).rejects.toThrow( + expect(app.connect(secondAppTransport)).rejects.toThrow( "App is already connected", ); }); @@ -643,7 +748,7 @@ describe("App <-> AppBridge integration", () => { await app.connect(appTransport); // Should throw regardless of whether it's the same or a different transport - await expect(bridge.connect(bridgeTransport)).rejects.toThrow( + expect(bridge.connect(bridgeTransport)).rejects.toThrow( "AppBridge is already connected", ); }); @@ -655,15 +760,1069 @@ describe("App <-> AppBridge integration", () => { await app.connect(appTransport); // Bridge can send ping via the protocol's request method - const result = await bridge.request( - { method: "ping", params: {} }, - EmptyResultSchema, - ); + const result = await bridge.request({ method: "ping", params: {} }); expect(result).toEqual({}); }); }); + describe("App tool registration", () => { + beforeEach(async () => { + app = new App( + testAppInfo, + { tools: { listChanged: true } }, + { autoResize: false }, + ); + await bridge.connect(bridgeTransport); + }); + + it("registerTool creates a registered tool", async () => { + const InputSchema = z.object({ name: z.string() }); + const OutputSchema = z.object({ greeting: z.string() }); + + const tool = app.registerTool( + "greet", + { + title: "Greet User", + description: "Greets a user by name", + inputSchema: InputSchema, + outputSchema: OutputSchema, + }, + async (args: any) => ({ + content: [{ type: "text" as const, text: `Hello, ${args.name}!` }], + structuredContent: { greeting: `Hello, ${args.name}!` }, + }), + ); + + expect(tool.title).toBe("Greet User"); + expect(tool.description).toBe("Greets a user by name"); + expect(tool.enabled).toBe(true); + }); + + it("registered tool can be enabled and disabled", async () => { + await app.connect(appTransport); + + const tool = app.registerTool( + "test-tool", + { + description: "Test tool", + }, + async (_extra: any) => ({ content: [] }), + ); + + expect(tool.enabled).toBe(true); + + tool.disable(); + expect(tool.enabled).toBe(false); + + tool.enable(); + expect(tool.enabled).toBe(true); + }); + + it("registered tool can be updated", async () => { + await app.connect(appTransport); + + const tool = app.registerTool( + "test-tool", + { + description: "Original description", + }, + async (_extra: any) => ({ content: [] }), + ); + + expect(tool.description).toBe("Original description"); + + tool.update({ description: "Updated description" }); + expect(tool.description).toBe("Updated description"); + }); + + it("registered tool can be removed", async () => { + await app.connect(appTransport); + + const tool = app.registerTool( + "test-tool", + { + description: "Test tool", + }, + async (_extra: any) => ({ content: [] }), + ); + + tool.remove(); + // Tool should no longer be registered (internal check) + }); + + it("registerTool throws on duplicate name", () => { + app.registerTool("dup", {}, async () => ({ content: [] })); + expect(() => + app.registerTool("dup", {}, async () => ({ content: [] })), + ).toThrow(/already registered/); + }); + + it("enable/disable/update/remove pre-connect do not throw", () => { + const tool = app.registerTool("t", {}, async () => ({ content: [] })); + expect(() => tool.disable()).not.toThrow(); + expect(() => tool.enable()).not.toThrow(); + expect(() => tool.update({ description: "x" })).not.toThrow(); + expect(() => tool.remove()).not.toThrow(); + }); + + it("callback without inputSchema receives extra as first arg", async () => { + await app.connect(appTransport); + let receivedExtra: any; + app.registerTool("noargs", {}, async (extra: any) => { + receivedExtra = extra; + return { content: [] }; + }); + await bridge.callTool({ name: "noargs", arguments: {} }); + expect(receivedExtra).toBeDefined(); + expect(receivedExtra.mcpReq.signal).toBeInstanceOf(AbortSignal); + }); + + it("isError result skips output schema validation", async () => { + await app.connect(appTransport); + app.registerTool( + "errs", + { outputSchema: z.object({ ok: z.boolean() }) }, + async () => ({ + content: [{ type: "text" as const, text: "boom" }], + isError: true, + }), + ); + const res = await bridge.callTool({ name: "errs", arguments: {} }); + expect(res.isError).toBe(true); + expect(res.structuredContent).toBeUndefined(); + }); + + it("stale handle remove() does not delete a re-registered tool", async () => { + const t1 = app.registerTool("phoenix", {}, async () => ({ content: [] })); + t1.remove(); + app.registerTool("phoenix", {}, async () => ({ content: [] })); + t1.remove(); + await app.connect(appTransport); + const list = await bridge.listTools({}); + expect(list.tools.map((t) => t.name)).toContain("phoenix"); + }); + + it("host omitting arguments defaults to empty object", async () => { + await app.connect(appTransport); + let received: unknown; + app.registerTool( + "noargs2", + { inputSchema: z.object({}) }, + async (args) => { + received = args; + return { content: [] }; + }, + ); + await bridge.callTool({ name: "noargs2" }); + expect(received).toEqual({}); + }); + + it("update({inputSchema}) is honored by handler validation", async () => { + await app.connect(appTransport); + const tool = app.registerTool( + "evolving", + { inputSchema: z.object({ a: z.string() }) }, + async (args: any) => ({ + content: [{ type: "text" as const, text: JSON.stringify(args) }], + }), + ); + expect( + bridge.callTool({ name: "evolving", arguments: { a: 123 } }), + ).rejects.toThrow(/Invalid input/); + tool.update({ inputSchema: z.object({ a: z.number() }) }); + const result = await bridge.callTool({ + name: "evolving", + arguments: { a: 123 }, + }); + expect(result.content[0]).toEqual({ type: "text", text: '{"a":123}' }); + }); + + it("tool throws error when disabled and called", async () => { + await app.connect(appTransport); + + const tool = app.registerTool( + "test-tool", + { + description: "Test tool", + }, + async (_extra: any) => ({ content: [] }), + ); + + tool.disable(); + + const mockExtra = { + signal: new AbortController().signal, + requestId: "test", + sendNotification: async () => {}, + sendRequest: async () => ({}), + } as any; + + expect((tool.handler as any)(mockExtra)).rejects.toThrow( + "Tool test-tool is disabled", + ); + }); + + it("tool validates input schema", async () => { + const InputSchema = z.object({ name: z.string() }); + + const tool = app.registerTool( + "greet", + { + inputSchema: InputSchema, + }, + async (args: any) => ({ + content: [{ type: "text" as const, text: `Hello, ${args.name}!` }], + }), + ); + + // Create a mock RequestHandlerExtra + const mockExtra = { + signal: new AbortController().signal, + requestId: "test", + sendNotification: async () => {}, + sendRequest: async () => ({}), + } as any; + + // Valid input should work + expect( + (tool.handler as any)({ name: "Alice" }, mockExtra), + ).resolves.toBeDefined(); + + // Invalid input should fail + expect( + (tool.handler as any)({ invalid: "field" }, mockExtra), + ).rejects.toThrow("Invalid input for tool greet"); + }); + + it("tool validates output schema", async () => { + const OutputSchema = z.object({ greeting: z.string() }); + + const tool = app.registerTool( + "greet", + { + outputSchema: OutputSchema, + }, + async (_extra: any) => ({ + content: [{ type: "text" as const, text: "Hello!" }], + structuredContent: { greeting: "Hello!" }, + }), + ); + + // Create a mock RequestHandlerExtra + const mockExtra = { + signal: new AbortController().signal, + requestId: "test", + sendNotification: async () => {}, + sendRequest: async () => ({}), + } as any; + + // Valid output should work + expect((tool.handler as any)(mockExtra)).resolves.toBeDefined(); + }); + + it("tool enable/disable/update/remove trigger sendToolListChanged", async () => { + await app.connect(appTransport); + + const tool = app.registerTool( + "test-tool", + { + description: "Test tool", + }, + async (_extra: any) => ({ content: [] }), + ); + + // The methods should not throw when connected + expect(() => tool.disable()).not.toThrow(); + expect(() => tool.enable()).not.toThrow(); + expect(() => tool.update({ description: "Updated" })).not.toThrow(); + expect(() => tool.remove()).not.toThrow(); + }); + }); + + describe("AppBridge -> App tool requests", () => { + beforeEach(async () => { + await bridge.connect(bridgeTransport); + }); + + it("bridge.callTool calls app.oncalltool handler", async () => { + // App needs tool capabilities to handle tool calls + const appCapabilities = { tools: {} }; + app = new App(testAppInfo, appCapabilities, { autoResize: false }); + + const receivedCalls: unknown[] = []; + + app.oncalltool = async (params) => { + receivedCalls.push(params); + return { + content: [{ type: "text", text: `Executed: ${params.name}` }], + }; + }; + + await app.connect(appTransport); + + const result = await bridge.callTool({ + name: "test-tool", + arguments: { foo: "bar" }, + }); + + expect(receivedCalls).toHaveLength(1); + expect(receivedCalls[0]).toMatchObject({ + name: "test-tool", + arguments: { foo: "bar" }, + }); + expect(result.content).toEqual([ + { type: "text", text: "Executed: test-tool" }, + ]); + }); + + it("bridge.listTools calls app.onlisttools handler", async () => { + // App needs tool capabilities to handle tool list requests + const appCapabilities = { tools: {} }; + app = new App(testAppInfo, appCapabilities, { autoResize: false }); + + const receivedCalls: unknown[] = []; + + app.onlisttools = async (params, _extra) => { + receivedCalls.push(params); + return { + tools: [ + { + name: "tool1", + description: "First tool", + inputSchema: { type: "object", properties: {} }, + }, + { + name: "tool2", + description: "Second tool", + inputSchema: { type: "object", properties: {} }, + }, + { + name: "tool3", + description: "Third tool", + inputSchema: { type: "object", properties: {} }, + }, + ], + }; + }; + + await app.connect(appTransport); + + const result = await bridge.listTools({}); + + expect(receivedCalls).toHaveLength(1); + expect(result.tools).toHaveLength(3); + expect(result.tools[0].name).toBe("tool1"); + expect(result.tools[1].name).toBe("tool2"); + expect(result.tools[2].name).toBe("tool3"); + }); + }); + + describe("App tool capabilities", () => { + it("App with tool capabilities can handle tool calls", async () => { + const appCapabilities = { tools: { listChanged: true } }; + app = new App(testAppInfo, appCapabilities, { autoResize: false }); + + const receivedCalls: unknown[] = []; + app.oncalltool = async (params) => { + receivedCalls.push(params); + return { + content: [{ type: "text", text: "Success" }], + }; + }; + + await bridge.connect(bridgeTransport); + await app.connect(appTransport); + + await bridge.callTool({ + name: "test-tool", + arguments: {}, + }); + + expect(receivedCalls).toHaveLength(1); + }); + + it("registered tool is invoked via oncalltool", async () => { + const appCapabilities = { tools: { listChanged: true } }; + app = new App(testAppInfo, appCapabilities, { autoResize: false }); + + const tool = app.registerTool( + "greet", + { + description: "Greets user", + inputSchema: z.object({ name: z.string() }), + }, + async (args: any) => ({ + content: [{ type: "text" as const, text: `Hello, ${args.name}!` }], + }), + ); + + app.oncalltool = async (params, extra) => { + if (params.name === "greet") { + return await (tool.handler as any)(params.arguments || {}, extra); + } + throw new Error(`Unknown tool: ${params.name}`); + }; + + await bridge.connect(bridgeTransport); + await app.connect(appTransport); + + const result = await bridge.callTool({ + name: "greet", + arguments: { name: "Alice" }, + }); + + expect(result.content).toEqual([{ type: "text", text: "Hello, Alice!" }]); + }); + }); + + describe("Automatic request handlers", () => { + beforeEach(async () => { + await bridge.connect(bridgeTransport); + }); + + describe("oncalltool automatic handler", () => { + it("automatically calls registered tool without manual oncalltool setup", async () => { + const appCapabilities = { tools: { listChanged: true } }; + app = new App(testAppInfo, appCapabilities, { autoResize: false }); + + // Register a tool + app.registerTool( + "greet", + { + description: "Greets user", + inputSchema: z.object({ name: z.string() }), + }, + async (args: any) => ({ + content: [{ type: "text" as const, text: `Hello, ${args.name}!` }], + }), + ); + + await app.connect(appTransport); + + // Call the tool through bridge - should work automatically + const result = await bridge.callTool({ + name: "greet", + arguments: { name: "Bob" }, + }); + + expect(result.content).toEqual([{ type: "text", text: "Hello, Bob!" }]); + }); + + it("throws error when calling non-existent tool", async () => { + const appCapabilities = { tools: { listChanged: true } }; + app = new App(testAppInfo, appCapabilities, { autoResize: false }); + + // Register a tool to initialize handlers + app.registerTool("existing-tool", {}, async (_args: any) => ({ + content: [], + })); + + await app.connect(appTransport); + + // Try to call a tool that doesn't exist + expect( + bridge.callTool({ + name: "nonexistent", + arguments: {}, + }), + ).rejects.toThrow("Tool nonexistent not found"); + }); + + it("handles multiple registered tools correctly", async () => { + const appCapabilities = { tools: { listChanged: true } }; + app = new App(testAppInfo, appCapabilities, { autoResize: false }); + + // Register multiple tools + app.registerTool( + "add", + { + description: "Add two numbers", + inputSchema: z.object({ a: z.number(), b: z.number() }), + }, + async (args: any) => ({ + content: [ + { + type: "text" as const, + text: `Result: ${args.a + args.b}`, + }, + ], + structuredContent: { result: args.a + args.b }, + }), + ); + + app.registerTool( + "multiply", + { + description: "Multiply two numbers", + inputSchema: z.object({ a: z.number(), b: z.number() }), + }, + async (args: any) => ({ + content: [ + { + type: "text" as const, + text: `Result: ${args.a * args.b}`, + }, + ], + structuredContent: { result: args.a * args.b }, + }), + ); + + await app.connect(appTransport); + + // Call first tool + const addResult = await bridge.callTool({ + name: "add", + arguments: { a: 5, b: 3 }, + }); + expect(addResult.content).toEqual([ + { type: "text", text: "Result: 8" }, + ]); + + // Call second tool + const multiplyResult = await bridge.callTool({ + name: "multiply", + arguments: { a: 5, b: 3 }, + }); + expect(multiplyResult.content).toEqual([ + { type: "text", text: "Result: 15" }, + ]); + }); + + it("respects tool enable/disable state", async () => { + const appCapabilities = { tools: { listChanged: true } }; + app = new App(testAppInfo, appCapabilities, { autoResize: false }); + + const tool = app.registerTool( + "test-tool", + { + description: "Test tool", + }, + async (_args: any) => ({ + content: [{ type: "text" as const, text: "Success" }], + }), + ); + + await app.connect(appTransport); + + // Should work when enabled + expect( + bridge.callTool({ name: "test-tool", arguments: {} }), + ).resolves.toBeDefined(); + + // Disable tool + tool.disable(); + + // Should throw when disabled + expect( + bridge.callTool({ name: "test-tool", arguments: {} }), + ).rejects.toThrow("Tool test-tool is disabled"); + }); + + it("validates input schema through automatic handler", async () => { + const appCapabilities = { tools: { listChanged: true } }; + app = new App(testAppInfo, appCapabilities, { autoResize: false }); + + app.registerTool( + "strict-tool", + { + description: "Requires specific input", + inputSchema: z.object({ + required: z.string(), + optional: z.number().optional(), + }) as any, + }, + async (args: any) => ({ + content: [{ type: "text" as const, text: `Got: ${args.required}` }], + }), + ); + + await app.connect(appTransport); + + // Valid input should work + expect( + bridge.callTool({ + name: "strict-tool", + arguments: { required: "hello" }, + }), + ).resolves.toBeDefined(); + + // Invalid input should fail + expect( + bridge.callTool({ + name: "strict-tool", + arguments: { wrong: "field" }, + }), + ).rejects.toThrow("Invalid input for tool strict-tool"); + }); + + it("validates output schema through automatic handler", async () => { + const appCapabilities = { tools: { listChanged: true } }; + app = new App(testAppInfo, appCapabilities, { autoResize: false }); + + app.registerTool( + "validated-output", + { + description: "Has output validation", + outputSchema: z.object({ + status: z.enum(["success", "error"]), + }) as any, + }, + async (_args: any) => ({ + content: [{ type: "text" as const, text: "Done" }], + structuredContent: { status: "success" }, + }), + ); + + await app.connect(appTransport); + + // Valid output should work + const result = await bridge.callTool({ + name: "validated-output", + arguments: {}, + }); + expect(result).toBeDefined(); + }); + + it("works after tool is removed and re-registered", async () => { + const appCapabilities = { tools: { listChanged: true } }; + app = new App(testAppInfo, appCapabilities, { autoResize: false }); + + const tool = app.registerTool( + "dynamic-tool", + {}, + async (_args: any) => ({ + content: [{ type: "text" as const, text: "Version 1" }], + }), + ); + + await app.connect(appTransport); + + // First version + let result = await bridge.callTool({ + name: "dynamic-tool", + arguments: {}, + }); + expect(result.content).toEqual([{ type: "text", text: "Version 1" }]); + + // Remove tool + tool.remove(); + + // Should fail after removal + expect( + bridge.callTool({ name: "dynamic-tool", arguments: {} }), + ).rejects.toThrow("Tool dynamic-tool not found"); + + // Re-register with different behavior + app.registerTool("dynamic-tool", {}, async (_args: any) => ({ + content: [{ type: "text" as const, text: "Version 2" }], + })); + + // Should work with new version + result = await bridge.callTool({ + name: "dynamic-tool", + arguments: {}, + }); + expect(result.content).toEqual([{ type: "text", text: "Version 2" }]); + }); + }); + + describe("onlisttools automatic handler", () => { + it("automatically returns list of registered tool names", async () => { + const appCapabilities = { tools: { listChanged: true } }; + app = new App(testAppInfo, appCapabilities, { autoResize: false }); + + // Register some tools + app.registerTool("tool1", {}, async (_args: any) => ({ + content: [], + })); + app.registerTool("tool2", {}, async (_args: any) => ({ + content: [], + })); + app.registerTool("tool3", {}, async (_args: any) => ({ + content: [], + })); + + await app.connect(appTransport); + + const result = await bridge.listTools({}); + + expect(result.tools).toHaveLength(3); + expect(result.tools.map((t) => t.name)).toContain("tool1"); + expect(result.tools.map((t) => t.name)).toContain("tool2"); + expect(result.tools.map((t) => t.name)).toContain("tool3"); + }); + + it("emits core MCP Tool fields (title, outputSchema only when provided)", async () => { + const appCapabilities = { tools: { listChanged: true } }; + app = new App(testAppInfo, appCapabilities, { autoResize: false }); + + app.registerTool( + "with-output", + { + title: "With Output", + description: "has structured output", + outputSchema: z.object({ ok: z.boolean() }), + }, + async () => ({ + content: [], + structuredContent: { ok: true }, + }), + ); + app.registerTool( + "no-output", + { description: "no structured output" }, + async () => ({ content: [] }), + ); + + await app.connect(appTransport); + const result = await bridge.listTools({}); + const byName = Object.fromEntries(result.tools.map((t) => [t.name, t])); + + expect(byName["with-output"].title).toBe("With Output"); + expect(byName["with-output"].inputSchema).toBeDefined(); + expect(byName["with-output"].outputSchema).toBeDefined(); + // outputSchema is optional in core MCP β€” omitted when not declared + expect(byName["no-output"]).not.toHaveProperty("outputSchema"); + expect(byName["no-output"].inputSchema).toBeDefined(); + }); + + it("accepts any Standard Schema implementation, not only zod", async () => { + // Hand-rolled StandardSchemaWithJSON β€” proves registerTool has no + // zod-specific runtime path. Any library implementing the spec + // (ArkType, Valibot, …) works the same way. + type Point = { x: number; y: number }; + const PointSchema = { + "~standard": { + version: 1 as const, + vendor: "test", + types: undefined as + | undefined + | { readonly input: Point; readonly output: Point }, + validate: (v: unknown) => + typeof v === "object" && + v !== null && + typeof (v as any).x === "number" && + typeof (v as any).y === "number" + ? { value: v as { x: number; y: number } } + : { issues: [{ message: "expected {x:number,y:number}" }] }, + jsonSchema: { + input: () => ({ + type: "object", + properties: { x: { type: "number" }, y: { type: "number" } }, + required: ["x", "y"], + }), + output: () => ({ + type: "object", + properties: { x: { type: "number" }, y: { type: "number" } }, + }), + }, + }, + }; + + const appCapabilities = { tools: { listChanged: true } }; + app = new App(testAppInfo, appCapabilities, { autoResize: false }); + app.registerTool( + "translate", + { inputSchema: PointSchema, outputSchema: PointSchema }, + async ({ x, y }) => ({ + content: [], + structuredContent: { x: x + 1, y: y + 1 }, + }), + ); + await app.connect(appTransport); + + const list = await bridge.listTools({}); + expect(list.tools[0].inputSchema).toEqual({ + type: "object", + properties: { x: { type: "number" }, y: { type: "number" } }, + required: ["x", "y"], + }); + expect(list.tools[0].outputSchema).toBeDefined(); + + const ok = await bridge.callTool({ + name: "translate", + arguments: { x: 1, y: 2 }, + }); + expect(ok.structuredContent).toEqual({ x: 2, y: 3 }); + + expect( + bridge.callTool({ name: "translate", arguments: { x: "bad" } }), + ).rejects.toThrow(/Invalid input for tool translate/); + }); + + it("rejects listTools when a tool schema does not implement Standard JSON Schema", async () => { + const appCapabilities = { tools: { listChanged: true } }; + app = new App(testAppInfo, appCapabilities, { autoResize: false }); + app.registerTool( + "broken", + { + inputSchema: { + "~standard": { + version: 1 as const, + vendor: "mystery", + validate: () => ({ value: {} }), + }, + }, + }, + async () => ({ content: [] }), + ); + await app.connect(appTransport); + + expect(bridge.listTools({})).rejects.toThrow( + /does not implement Standard JSON Schema/, + ); + }); + + it("returns empty list when no tools registered", async () => { + const appCapabilities = { tools: { listChanged: true } }; + app = new App(testAppInfo, appCapabilities, { autoResize: false }); + + // Register a tool to ensure handlers are initialized + const dummyTool = app.registerTool("dummy", {}, async () => ({ + content: [], + })); + + await app.connect(appTransport); + + // Remove the tool after connecting + dummyTool.remove(); + + const result = await bridge.listTools({}); + + expect(result.tools).toEqual([]); + }); + + it("updates list when tools are added", async () => { + const appCapabilities = { tools: { listChanged: true } }; + app = new App(testAppInfo, appCapabilities, { autoResize: false }); + + await app.connect(appTransport); + + // Register then remove a tool to initialize handlers + const dummy = app.registerTool("init", {}, async () => ({ + content: [], + })); + dummy.remove(); + + // Initially no tools + let result = await bridge.listTools({}); + expect(result.tools).toEqual([]); + + // Add a tool + app.registerTool("new-tool", {}, async (_args: any) => ({ + content: [], + })); + + // Should now include the new tool + result = await bridge.listTools({}); + expect(result.tools.map((t) => t.name)).toEqual(["new-tool"]); + + // Add another tool + app.registerTool("another-tool", {}, async (_args: any) => ({ + content: [], + })); + + // Should now include both tools + result = await bridge.listTools({}); + expect(result.tools).toHaveLength(2); + expect(result.tools.map((t) => t.name)).toContain("new-tool"); + expect(result.tools.map((t) => t.name)).toContain("another-tool"); + }); + + it("updates list when tools are removed", async () => { + const appCapabilities = { tools: { listChanged: true } }; + app = new App(testAppInfo, appCapabilities, { autoResize: false }); + + const tool1 = app.registerTool("tool1", {}, async (_args: any) => ({ + content: [], + })); + const tool2 = app.registerTool("tool2", {}, async (_args: any) => ({ + content: [], + })); + app.registerTool("tool3", {}, async (_args: any) => ({ + content: [], + })); + + await app.connect(appTransport); + + // Initially all three tools + let result = await bridge.listTools({}); + expect(result.tools).toHaveLength(3); + + // Remove one tool + tool2.remove(); + + // Should now have two tools + result = await bridge.listTools({}); + expect(result.tools).toHaveLength(2); + expect(result.tools.map((t) => t.name)).toContain("tool1"); + expect(result.tools.map((t) => t.name)).toContain("tool3"); + expect(result.tools.map((t) => t.name)).not.toContain("tool2"); + + // Remove another tool + tool1.remove(); + + // Should now have one tool + result = await bridge.listTools({}); + expect(result.tools.map((t) => t.name)).toEqual(["tool3"]); + }); + + it("only includes enabled tools in list", async () => { + const appCapabilities = { tools: { listChanged: true } }; + app = new App(testAppInfo, appCapabilities, { autoResize: false }); + + app.registerTool("enabled-tool", {}, async (_args: any) => ({ + content: [], + })); + const tool2 = app.registerTool( + "disabled-tool", + {}, + async (_args: any) => ({ + content: [], + }), + ); + + await app.connect(appTransport); + + // Disable one tool after connecting + tool2.disable(); + + const result = await bridge.listTools({}); + + // Only enabled tool should be in the list + expect(result.tools).toHaveLength(1); + expect(result.tools.map((t) => t.name)).toContain("enabled-tool"); + expect(result.tools.map((t) => t.name)).not.toContain("disabled-tool"); + }); + }); + + describe("Integration: automatic handlers with tool lifecycle", () => { + it("handles complete tool lifecycle: register -> call -> update -> call -> remove", async () => { + const appCapabilities = { tools: { listChanged: true } }; + app = new App(testAppInfo, appCapabilities, { autoResize: false }); + + await app.connect(appTransport); + + // Register tool + const tool = app.registerTool( + "counter", + { + description: "A counter tool", + }, + async (_args: any) => ({ + content: [{ type: "text" as const, text: "Count: 1" }], + structuredContent: { count: 1 }, + }), + ); + + // List should include the tool + let listResult = await bridge.listTools({}); + expect(listResult.tools.map((t) => t.name)).toContain("counter"); + + // Call the tool + let callResult = await bridge.callTool({ + name: "counter", + arguments: {}, + }); + expect(callResult.content).toEqual([ + { type: "text", text: "Count: 1" }, + ]); + + // Update tool description + tool.update({ description: "An updated counter tool" }); + + // Should still be callable + callResult = await bridge.callTool({ + name: "counter", + arguments: {}, + }); + expect(callResult).toBeDefined(); + + // Remove tool + tool.remove(); + + // Should no longer be in list + listResult = await bridge.listTools({}); + expect(listResult.tools.map((t) => t.name)).not.toContain("counter"); + + // Should no longer be callable + expect( + bridge.callTool({ name: "counter", arguments: {} }), + ).rejects.toThrow("Tool counter not found"); + }); + + it("multiple apps can have separate tool registries", async () => { + const appCapabilities = { tools: { listChanged: true } }; + + // Create two separate apps + const app1 = new App( + { name: "App1", version: "1.0.0" }, + appCapabilities, + { autoResize: false }, + ); + const app2 = new App( + { name: "App2", version: "1.0.0" }, + appCapabilities, + { autoResize: false }, + ); + + // Create separate transports for each app + const [app1Transport, bridge1Transport] = + InMemoryTransport.createLinkedPair(); + const [app2Transport, bridge2Transport] = + InMemoryTransport.createLinkedPair(); + + const bridge1 = new AppBridge( + createMockClient() as Client, + testHostInfo, + testHostCapabilities, + ); + const bridge2 = new AppBridge( + createMockClient() as Client, + testHostInfo, + testHostCapabilities, + ); + + // Register different tools in each app + app1.registerTool("app1-tool", {}, async (_args: any) => ({ + content: [{ type: "text" as const, text: "From App1" }], + })); + + app2.registerTool("app2-tool", {}, async (_args: any) => ({ + content: [{ type: "text" as const, text: "From App2" }], + })); + + await bridge1.connect(bridge1Transport); + await bridge2.connect(bridge2Transport); + await app1.connect(app1Transport); + await app2.connect(app2Transport); + + // Each app should only see its own tools + const list1 = await bridge1.listTools({}); + expect(list1.tools.map((t) => t.name)).toEqual(["app1-tool"]); + + const list2 = await bridge2.listTools({}); + expect(list2.tools.map((t) => t.name)).toEqual(["app2-tool"]); + + // Each app should only be able to call its own tools + expect( + bridge1.callTool({ name: "app1-tool", arguments: {} }), + ).resolves.toBeDefined(); + + expect( + bridge1.callTool({ name: "app2-tool", arguments: {} }), + ).rejects.toThrow("Tool app2-tool not found"); + + // Clean up + await app1Transport.close(); + await bridge1Transport.close(); + await app2Transport.close(); + await bridge2Transport.close(); + }); + }); + }); + describe("AppBridge without MCP client (manual handlers)", () => { let app: App; let bridge: AppBridge; @@ -712,6 +1871,43 @@ describe("App <-> AppBridge integration", () => { expect(result.content).toEqual(resultContent); }); + it("oncreatesamplingmessage setter registers handler for sampling/createMessage requests", async () => { + // Re-create bridge with sampling capability so App's capability check passes + bridge = new AppBridge(null, testHostInfo, { + ...testHostCapabilities, + sampling: { tools: {} }, + }); + + const receivedParams: unknown[] = []; + bridge.oncreatesamplingmessage = async (params) => { + receivedParams.push(params); + return { + role: "assistant", + content: { type: "text", text: "Hello from the model" }, + model: "test-model", + stopReason: "endTurn", + }; + }; + + await bridge.connect(bridgeTransport); + await app.connect(appTransport); + + expect(app.getHostCapabilities()?.sampling?.tools).toEqual({}); + + const result = await app.createSamplingMessage({ + messages: [{ role: "user", content: { type: "text", text: "Hi" } }], + maxTokens: 50, + }); + + expect(receivedParams).toHaveLength(1); + expect(receivedParams[0]).toMatchObject({ maxTokens: 50 }); + expect(result.model).toEqual("test-model"); + expect(result.content).toEqual({ + type: "text", + text: "Hello from the model", + }); + }); + it("ondownloadfile setter registers handler for ui/download-file requests", async () => { const downloadParams = { contents: [ @@ -746,7 +1942,7 @@ describe("App <-> AppBridge integration", () => { await bridge.connect(bridgeTransport); await app.connect(appTransport); - await expect( + expect( // @ts-expect-error intentionally testing wrong usage app.callServerTool("my_tool"), ).rejects.toThrow( @@ -755,6 +1951,269 @@ describe("App <-> AppBridge integration", () => { ); }); + describe("pre-handshake guard (claude-ai-mcp#149)", () => { + const guardMsg = + /called before connect\(\) completed the ui\/initialize handshake/; + let warnSpy: ReturnType>; + + beforeEach(() => { + warnSpy = spyOn(console, "warn").mockImplementation(() => {}); + }); + afterEach(() => { + warnSpy.mockRestore(); + }); + + const warnings = () => warnSpy.mock.calls.map((c) => String(c[0])); + + it("callServerTool warns when called before connect() completes", async () => { + bridge.oncalltool = async () => ({ content: [] }); + await bridge.connect(bridgeTransport); + + const connecting = app.connect(appTransport); + // Handshake is in flight; _initializedSent is still false. + await app.callServerTool({ name: "t", arguments: {} }).catch(() => {}); + + const appSide = warnings().filter((m) => guardMsg.test(m)); + expect(appSide).toHaveLength(1); + expect(appSide[0]).toContain("App.callServerTool()"); + + await connecting; + }); + + it("callServerTool does not warn after connect() resolves", async () => { + bridge.oncalltool = async () => ({ content: [] }); + await bridge.connect(bridgeTransport); + await app.connect(appTransport); + + await app.callServerTool({ name: "t", arguments: {} }); + + expect(warnings()).toEqual([]); + }); + + it("sendMessage and readServerResource also warn before handshake", async () => { + await app.sendMessage({ role: "user", content: [] }).catch(() => {}); + await app.readServerResource({ uri: "test://r" }).catch(() => {}); + + const appSide = warnings().filter((m) => guardMsg.test(m)); + expect(appSide).toHaveLength(2); + expect(appSide[0]).toContain("App.sendMessage()"); + expect(appSide[1]).toContain("App.readServerResource()"); + }); + + it("throws instead of warning when strict: true", async () => { + const strictApp = new App( + testAppInfo, + {}, + { autoResize: false, strict: true }, + ); + + await expect( + strictApp.callServerTool({ name: "t", arguments: {} }), + ).rejects.toThrow(guardMsg); + expect(warnings()).toEqual([]); + }); + + describe("late handler registration", () => { + const lateMsg = + /handler registered after connect\(\) completed the ui\/initialize handshake/; + + it("warns when ontoolresult is set after connect() resolves", async () => { + await bridge.connect(bridgeTransport); + await app.connect(appTransport); + + app.ontoolresult = () => {}; + + expect(warnings()).toHaveLength(1); + expect(warnings()[0]).toMatch(lateMsg); + expect(warnings()[0]).toContain('"toolresult"'); + }); + + it("warns when addEventListener('toolinput', …) is called after connect()", async () => { + await bridge.connect(bridgeTransport); + await app.connect(appTransport); + + app.addEventListener("toolinput", () => {}); + + expect(warnings()).toHaveLength(1); + expect(warnings()[0]).toContain('"toolinput"'); + }); + + it("does not warn for handlers set before connect()", async () => { + app.ontoolinput = () => {}; + app.addEventListener("toolresult", () => {}); + + await bridge.connect(bridgeTransport); + await app.connect(appTransport); + + expect(warnings()).toEqual([]); + }); + + it("does not warn for hostcontextchanged (repeating event)", async () => { + await bridge.connect(bridgeTransport); + await app.connect(appTransport); + + app.onhostcontextchanged = () => {}; + app.addEventListener("hostcontextchanged", () => {}); + + expect(warnings()).toEqual([]); + }); + + it("does not warn when clearing a handler (set to undefined)", async () => { + app.ontoolinput = () => {}; + await bridge.connect(bridgeTransport); + await app.connect(appTransport); + + app.ontoolinput = undefined; + + expect(warnings()).toEqual([]); + }); + + it("does not warn on re-registration when a handler existed pre-connect", async () => { + const h = () => {}; + app.addEventListener("toolresult", h); + await bridge.connect(bridgeTransport); + await app.connect(appTransport); + + // React-style: useEffect cleanup removes, dep change re-adds. + app.removeEventListener("toolresult", h); + app.addEventListener("toolresult", () => {}); + + expect(warnings().filter((m) => lateMsg.test(m))).toEqual([]); + }); + + it("warns once for the first late registration, not on subsequent ones", async () => { + await bridge.connect(bridgeTransport); + await app.connect(appTransport); + + app.addEventListener("toolinput", () => {}); + app.addEventListener("toolinput", () => {}); + app.addEventListener("toolinput", () => {}); + + const late = warnings().filter((m) => lateMsg.test(m)); + expect(late).toHaveLength(1); + expect(late[0]).toContain('"toolinput"'); + }); + + it("tracks first-handler per event independently", async () => { + app.addEventListener("toolinput", () => {}); + await bridge.connect(bridgeTransport); + await app.connect(appTransport); + + app.addEventListener("toolinput", () => {}); // had pre-connect handler β†’ silent + app.addEventListener("toolresult", () => {}); // first reg, late β†’ warns + + const late = warnings().filter((m) => lateMsg.test(m)); + expect(late).toHaveLength(1); + expect(late[0]).toContain('"toolresult"'); + }); + + it("throws instead of warning when strict: true", async () => { + const [strictAppT, strictBridgeT] = + InMemoryTransport.createLinkedPair(); + const strictBridge = new AppBridge( + createMockClient() as Client, + testHostInfo, + testHostCapabilities, + ); + const strictApp = new App( + testAppInfo, + {}, + { autoResize: false, strict: true }, + ); + // Pre-connect registration for toolcancelled β€” later swap must not throw. + strictApp.addEventListener("toolcancelled", () => {}); + + await strictBridge.connect(strictBridgeT); + await strictApp.connect(strictAppT); + + expect(() => { + strictApp.ontoolresult = () => {}; + }).toThrow(lateMsg); + expect(() => { + strictApp.addEventListener("toolinput", () => {}); + }).toThrow(lateMsg); + // Swapping a handler that existed pre-connect is allowed under strict. + expect(() => { + strictApp.addEventListener("toolcancelled", () => {}); + }).not.toThrow(); + expect(warnings().filter((m) => lateMsg.test(m))).toEqual([]); + }); + }); + + it("AppBridge warns on a second ui/initialize (View double-mount)", async () => { + await bridge.connect(bridgeTransport); + await app.connect(appTransport); + expect(warnings()).toEqual([]); + + // Simulate a second View instance re-running the handshake. + appTransport.send({ + jsonrpc: "2.0", + id: 99, + method: "ui/initialize", + params: { + protocolVersion: LATEST_PROTOCOL_VERSION, + appInfo: testAppInfo, + appCapabilities: {}, + }, + }); + await flush(); + + const doubleInit = warnings().filter((m) => + /second ui\/initialize/.test(m), + ); + expect(doubleInit).toHaveLength(1); + }); + + it("close() stops further notification delivery (StrictMode cleanup relies on this)", async () => { + const received: unknown[] = []; + app.addEventListener("toolresult", (r) => received.push(r)); + await bridge.connect(bridgeTransport); + await app.connect(appTransport); + + await bridge.sendToolResult({ + content: [{ type: "text", text: "before" }], + }); + expect(received).toHaveLength(1); + + await app.close(); + + await bridge + .sendToolResult({ content: [{ type: "text", text: "after" }] }) + .catch(() => {}); + expect(received).toHaveLength(1); + }); + + it("AppBridge warns on tools/call from a View that skipped the handshake", async () => { + bridge.oncalltool = async () => ({ content: [] }); + await bridge.connect(bridgeTransport); + + // Simulate a hand-rolled View (no SDK, no handshake) sending tools/call. + await appTransport.start(); + appTransport.send({ + jsonrpc: "2.0", + id: 1, + method: "tools/call", + params: { name: "t", arguments: {} }, + }); + await flush(); + + expect(warnings()).toHaveLength(1); + expect(warnings()[0]).toContain( + "received 'tools/call' before ui/notifications/initialized", + ); + }); + + it("AppBridge does not warn after initialized is received", async () => { + bridge.oncalltool = async () => ({ content: [] }); + await bridge.connect(bridgeTransport); + await app.connect(appTransport); + + await app.callServerTool({ name: "t", arguments: {} }); + + expect(warnings()).toEqual([]); + }); + }); + it("onlistresources setter registers handler for resources/list requests", async () => { const requestParams = {}; const resources = [{ uri: "test://resource", name: "Test" }]; @@ -769,10 +2228,10 @@ describe("App <-> AppBridge integration", () => { await app.connect(appTransport); // App sends resources/list request via the protocol's request method - const result = await app.request( - { method: "resources/list", params: requestParams }, - ListResourcesResultSchema, - ); + const result = await app.request({ + method: "resources/list", + params: requestParams, + }); expect(receivedRequests).toHaveLength(1); expect(receivedRequests[0]).toMatchObject(requestParams); @@ -813,10 +2272,10 @@ describe("App <-> AppBridge integration", () => { await bridge.connect(bridgeTransport); await app.connect(appTransport); - const result = await app.request( - { method: "resources/read", params: requestParams }, - ReadResourceResultSchema, - ); + const result = await app.request({ + method: "resources/read", + params: requestParams, + }); expect(receivedRequests).toHaveLength(1); expect(receivedRequests[0]).toMatchObject(requestParams); @@ -864,10 +2323,10 @@ describe("App <-> AppBridge integration", () => { await bridge.connect(bridgeTransport); await app.connect(appTransport); - const result = await app.request( - { method: "resources/templates/list", params: requestParams }, - ListResourceTemplatesResultSchema, - ); + const result = await app.request({ + method: "resources/templates/list", + params: requestParams, + }); expect(receivedRequests).toHaveLength(1); expect(receivedRequests[0]).toMatchObject(requestParams); @@ -887,10 +2346,10 @@ describe("App <-> AppBridge integration", () => { await bridge.connect(bridgeTransport); await app.connect(appTransport); - const result = await app.request( - { method: "prompts/list", params: requestParams }, - ListPromptsResultSchema, - ); + const result = await app.request({ + method: "prompts/list", + params: requestParams, + }); expect(receivedRequests).toHaveLength(1); expect(receivedRequests[0]).toMatchObject(requestParams); @@ -899,9 +2358,13 @@ describe("App <-> AppBridge integration", () => { it("sendToolListChanged sends notification to app", async () => { const receivedNotifications: unknown[] = []; - app.setNotificationHandler(ToolListChangedNotificationSchema, (n) => { - receivedNotifications.push(n.params); - }); + bridge.oncalltool = async () => ({ content: [] }); + app.setNotificationHandler( + "notifications/tools/list_changed", + (notification) => { + receivedNotifications.push(notification.params); + }, + ); await bridge.connect(bridgeTransport); await app.connect(appTransport); @@ -914,9 +2377,13 @@ describe("App <-> AppBridge integration", () => { it("sendResourceListChanged sends notification to app", async () => { const receivedNotifications: unknown[] = []; - app.setNotificationHandler(ResourceListChangedNotificationSchema, (n) => { - receivedNotifications.push(n.params); - }); + bridge.onlistresources = async () => ({ resources: [] }); + app.setNotificationHandler( + "notifications/resources/list_changed", + (notification) => { + receivedNotifications.push(notification.params); + }, + ); await bridge.connect(bridgeTransport); await app.connect(appTransport); @@ -929,9 +2396,13 @@ describe("App <-> AppBridge integration", () => { it("sendPromptListChanged sends notification to app", async () => { const receivedNotifications: unknown[] = []; - app.setNotificationHandler(PromptListChangedNotificationSchema, (n) => { - receivedNotifications.push(n.params); - }); + bridge.onlistprompts = async () => ({ prompts: [] }); + app.setNotificationHandler( + "notifications/prompts/list_changed", + (notification) => { + receivedNotifications.push(notification.params); + }, + ); await bridge.connect(bridgeTransport); await app.connect(appTransport); @@ -944,6 +2415,184 @@ describe("App <-> AppBridge integration", () => { }); }); +describe("AppBridge outer v2 Client proxy", () => { + let outerClient: Client; + let outerServer: Server; + let outerClientTransport: InMemoryTransport; + let outerServerTransport: InMemoryTransport; + let outerInitializeCount: number; + + beforeEach(async () => { + [outerClientTransport, outerServerTransport] = + InMemoryTransport.createLinkedPair(); + outerInitializeCount = 0; + const originalSend = outerClientTransport.send.bind(outerClientTransport); + outerClientTransport.send = async (message, options) => { + if ("method" in message && message.method === "initialize") { + outerInitializeCount++; + } + return originalSend(message, options); + }; + + outerServer = new Server( + { name: "ActualServer", version: "1.0.0" }, + { + capabilities: { + tools: { listChanged: true }, + resources: { listChanged: true }, + prompts: { listChanged: true }, + }, + supportedProtocolVersions: ["2025-11-25"], + }, + ); + outerServer.setRequestHandler("tools/call", async (request) => ({ + content: [ + { + type: "text", + text: `outer:${request.params.name}`, + }, + ], + })); + + outerClient = new Client( + { name: "HostOuterClient", version: "1.0.0" }, + { + capabilities: {}, + versionNegotiation: { mode: "legacy" }, + supportedProtocolVersions: ["2025-11-25"], + }, + ); + await outerServer.connect(outerServerTransport); + await outerClient.connect(outerClientTransport); + }); + + afterEach(async () => { + await outerClient.close().catch(() => {}); + await outerServer.close().catch(() => {}); + }); + + it("proxies through the outer Client without reconnecting it", async () => { + const bridge = new AppBridge( + outerClient, + testHostInfo, + testHostCapabilities, + ); + const app = new App(testAppInfo, {}, { autoResize: false }); + let [appTransport, bridgeTransport] = InMemoryTransport.createLinkedPair(); + + await bridge.connect(bridgeTransport); + await app.connect(appTransport); + expect( + await app.callServerTool({ name: "first", arguments: {} }), + ).toMatchObject({ + content: [{ type: "text", text: "outer:first" }], + }); + expect(outerInitializeCount).toBe(1); + + await app.close(); + await bridge.close(); + [appTransport, bridgeTransport] = InMemoryTransport.createLinkedPair(); + await bridge.connect(bridgeTransport); + await app.connect(appTransport); + + expect( + await app.callServerTool({ name: "second", arguments: {} }), + ).toMatchObject({ + content: [{ type: "text", text: "outer:second" }], + }); + expect(outerInitializeCount).toBe(1); + expect(outerClient.getServerVersion()).toMatchObject({ + name: "ActualServer", + version: "1.0.0", + }); + + await app.close(); + await bridge.close(); + }); + + it("propagates View cancellation to the actual outer Server", async () => { + let started!: () => void; + let aborted!: () => void; + const startedPromise = new Promise((resolve) => { + started = resolve; + }); + const abortedPromise = new Promise((resolve) => { + aborted = resolve; + }); + outerServer.setRequestHandler("tools/call", async (_request, context) => { + started(); + await new Promise((resolve) => { + context.mcpReq.signal.addEventListener( + "abort", + () => { + aborted(); + resolve(); + }, + { once: true }, + ); + }); + return { content: [] }; + }); + + const bridge = new AppBridge( + outerClient, + testHostInfo, + testHostCapabilities, + ); + const app = new App(testAppInfo, {}, { autoResize: false }); + const [appTransport, bridgeTransport] = + InMemoryTransport.createLinkedPair(); + await bridge.connect(bridgeTransport); + await app.connect(appTransport); + + const controller = new AbortController(); + const result = app.callServerTool( + { name: "cancel-me", arguments: {} }, + { signal: controller.signal }, + ); + await startedPromise; + controller.abort("test cancellation"); + await abortedPromise; + await expect(result).rejects.toThrow(); + + await app.close(); + await bridge.close(); + }); + + it("forwards outer list-changed notifications to the App", async () => { + const bridge = new AppBridge( + outerClient, + testHostInfo, + testHostCapabilities, + ); + const app = new App(testAppInfo, {}, { autoResize: false }); + const [appTransport, bridgeTransport] = + InMemoryTransport.createLinkedPair(); + const received: string[] = []; + app.setNotificationHandler("notifications/tools/list_changed", () => { + received.push("tools"); + }); + app.setNotificationHandler("notifications/resources/list_changed", () => { + received.push("resources"); + }); + app.setNotificationHandler("notifications/prompts/list_changed", () => { + received.push("prompts"); + }); + + await bridge.connect(bridgeTransport); + await app.connect(appTransport); + await outerServer.sendToolListChanged(); + await outerServer.sendResourceListChanged(); + await outerServer.sendPromptListChanged(); + await flush(); + + expect(received).toEqual(["tools", "resources", "prompts"]); + + await app.close(); + await bridge.close(); + }); +}); + describe("getToolUiResourceUri", () => { describe("new nested format (_meta.ui.resourceUri)", () => { it("extracts resourceUri from _meta.ui.resourceUri", () => { @@ -1196,4 +2845,288 @@ describe("isToolVisibilityAppOnly", () => { expect(isToolVisibilityAppOnly(tool)).toBe(false); }); }); + + describe("addEventListener / removeEventListener", () => { + let app: App; + let bridge: AppBridge; + let appTransport: InMemoryTransport; + let bridgeTransport: InMemoryTransport; + + beforeEach(async () => { + [appTransport, bridgeTransport] = InMemoryTransport.createLinkedPair(); + app = new App(testAppInfo, {}, { autoResize: false }); + bridge = new AppBridge( + createMockClient() as Client, + testHostInfo, + testHostCapabilities, + ); + await bridge.connect(bridgeTransport); + }); + + afterEach(async () => { + await appTransport.close(); + await bridgeTransport.close(); + }); + + it("App.addEventListener fires multiple listeners for the same event", async () => { + const a: unknown[] = []; + const b: unknown[] = []; + app.addEventListener("hostcontextchanged", (p) => a.push(p)); + app.addEventListener("hostcontextchanged", (p) => b.push(p)); + + await app.connect(appTransport); + bridge.setHostContext({ theme: "dark" }); + await flush(); + + expect(a).toEqual([{ theme: "dark" }]); + expect(b).toEqual([{ theme: "dark" }]); + }); + + it("App notification setters replace (DOM onclick model)", async () => { + const a: unknown[] = []; + const b: unknown[] = []; + const first = (p: unknown) => a.push(p); + app.ontoolinput = first; + expect(app.ontoolinput).toBe(first); + app.ontoolinput = (p) => b.push(p); + + await app.connect(appTransport); + await bridge.sendToolInput({ arguments: { x: 1 } }); + await flush(); + + // Second assignment replaced the first (like el.onclick) + expect(a).toEqual([]); + expect(b).toEqual([{ arguments: { x: 1 } }]); + }); + + it("App notification setter coexists with addEventListener", async () => { + const a: unknown[] = []; + const b: unknown[] = []; + app.ontoolinput = (p) => a.push(p); + app.addEventListener("toolinput", (p) => b.push(p)); + + await app.connect(appTransport); + await bridge.sendToolInput({ arguments: { x: 1 } }); + await flush(); + + // Both the on* handler and addEventListener listener fire + expect(a).toEqual([{ arguments: { x: 1 } }]); + expect(b).toEqual([{ arguments: { x: 1 } }]); + }); + + it("App notification getter returns the on* handler", () => { + expect(app.ontoolinput).toBeUndefined(); + const handler = () => {}; + app.ontoolinput = handler; + expect(app.ontoolinput).toBe(handler); + }); + + it("App notification setter can be cleared with undefined", async () => { + const a: unknown[] = []; + app.ontoolinput = (p) => a.push(p); + expect(app.ontoolinput).toBeDefined(); + app.ontoolinput = undefined; + + await app.connect(appTransport); + await bridge.sendToolInput({ arguments: { x: 1 } }); + await flush(); + + expect(a).toEqual([]); + expect(app.ontoolinput).toBeUndefined(); + }); + + it("App.removeEventListener stops a listener from firing", async () => { + const a: unknown[] = []; + const listener = (p: unknown) => a.push(p); + app.addEventListener("toolinput", listener); + app.removeEventListener("toolinput", listener); + + await app.connect(appTransport); + await bridge.sendToolInput({ arguments: {} }); + await flush(); + + expect(a).toEqual([]); + }); + + it("App merges hostcontext before listeners fire", async () => { + let seen: unknown; + app.addEventListener("hostcontextchanged", () => { + seen = app.getHostContext(); + }); + + await app.connect(appTransport); + bridge.setHostContext({ theme: "dark" }); + await flush(); + + expect(seen).toEqual({ theme: "dark" }); + }); + + it("AppBridge.addEventListener fires multiple listeners", async () => { + let a = 0; + let b = 0; + bridge.addEventListener("initialized", () => a++); + bridge.addEventListener("initialized", () => b++); + + await app.connect(appTransport); + + expect(a).toBe(1); + expect(b).toBe(1); + }); + + it("on* request setters have replace semantics (no throw)", () => { + app.onteardown = async () => ({}); + expect(() => { + app.onteardown = async () => ({}); + }).not.toThrow(); + }); + + it("on* request setters have getters", () => { + expect(app.onteardown).toBeUndefined(); + const handler = async () => ({}); + app.onteardown = handler; + expect(app.onteardown).toBe(handler); + }); + + it("direct setRequestHandler throws when called twice", () => { + const bridge2 = new AppBridge( + createMockClient() as Client, + testHostInfo, + testHostCapabilities, + ); + const params = z.object({}); + bridge2.setRequestHandler("test/method", { params }, () => ({})); + expect(() => { + bridge2.setRequestHandler("test/method", { params }, () => ({})); + }).toThrow(/already registered/); + }); + + it("direct setRequestHandler cannot silently replace an on* host handler", () => { + const bridge2 = new AppBridge( + createMockClient() as Client, + testHostInfo, + testHostCapabilities, + ); + bridge2.onopenlink = async () => ({}); + expect(() => { + bridge2.setRequestHandler( + "ui/open-link", + { params: z.object({}) }, + () => ({}), + ); + }).toThrow(/already registered/); + }); + + it("direct setNotificationHandler throws for event-mapped methods", () => { + const bridge2 = new AppBridge( + createMockClient() as Client, + testHostInfo, + testHostCapabilities, + ); + bridge2.onsizechange = () => {}; + expect(() => { + bridge2.setNotificationHandler( + "ui/notifications/size-changed", + { params: z.object({}) }, + () => {}, + ); + }).toThrow(/already registered/); + }); + + it("removeRequestHandler releases the method so an on* setter can re-register", () => { + const bridge2 = new AppBridge( + createMockClient() as Client, + testHostInfo, + testHostCapabilities, + ); + bridge2.removeRequestHandler("tools/call"); + expect(() => { + bridge2.setRequestHandler("tools/call", async () => ({ content: [] })); + }).not.toThrow(); + expect(() => { + bridge2.oncalltool = async () => ({ content: [] }); + }).not.toThrow(); + }); + + it("oncreatesamplingmessage has a getter, replace semantics, and a replace warning", () => { + const bridge2 = new AppBridge( + createMockClient() as Client, + testHostInfo, + testHostCapabilities, + ); + expect(bridge2.oncreatesamplingmessage).toBeUndefined(); + const first = async () => ({ + role: "assistant" as const, + content: { type: "text" as const, text: "" }, + model: "m", + }); + bridge2.oncreatesamplingmessage = first; + expect(bridge2.oncreatesamplingmessage).toBe(first); + + const warn = spyOn(console, "warn").mockImplementation(() => {}); + try { + expect(() => { + bridge2.oncreatesamplingmessage = first; + }).not.toThrow(); + expect(warn).toHaveBeenCalledWith( + expect.stringContaining("oncreatesamplingmessage handler replaced"), + ); + } finally { + warn.mockRestore(); + } + + bridge2.oncreatesamplingmessage = undefined; + expect(bridge2.oncreatesamplingmessage).toBeUndefined(); + }); + }); +}); + +describe("buildAllowAttribute", () => { + describe("returns empty string", () => { + it("when permissions is undefined", () => { + expect(buildAllowAttribute(undefined)).toBe(""); + }); + + it("when permissions object is empty", () => { + expect(buildAllowAttribute({})).toBe(""); + }); + }); + + describe("returns a single permission directive", () => { + it("when only camera is set", () => { + expect(buildAllowAttribute({ camera: {} })).toBe("camera"); + }); + + it("when only microphone is set", () => { + expect(buildAllowAttribute({ microphone: {} })).toBe("microphone"); + }); + + it("when only geolocation is set", () => { + expect(buildAllowAttribute({ geolocation: {} })).toBe("geolocation"); + }); + + it("when only clipboardWrite is set, maps to clipboard-write", () => { + expect(buildAllowAttribute({ clipboardWrite: {} })).toBe( + "clipboard-write", + ); + }); + }); + + describe("returns multiple directives joined with '; '", () => { + it("when camera and microphone are set", () => { + expect(buildAllowAttribute({ camera: {}, microphone: {} })).toBe( + "camera; microphone", + ); + }); + + it("when all permissions are set", () => { + expect( + buildAllowAttribute({ + camera: {}, + microphone: {}, + geolocation: {}, + clipboardWrite: {}, + }), + ).toBe("camera; microphone; geolocation; clipboard-write"); + }); + }); }); diff --git a/src/app-bridge.ts b/src/app-bridge.ts index 014420e..1ac4db4 100644 --- a/src/app-bridge.ts +++ b/src/app-bridge.ts @@ -1,50 +1,53 @@ -import { Client } from "@modelcontextprotocol/sdk/client/index.js"; -import { Transport } from "@modelcontextprotocol/sdk/shared/transport.js"; -import { - CallToolRequest, - CallToolRequestSchema, - CallToolResult, - CallToolResultSchema, - EmptyResult, - Implementation, - ListPromptsRequest, - ListPromptsRequestSchema, - ListPromptsResult, - ListPromptsResultSchema, - ListResourcesRequest, - ListResourcesRequestSchema, - ListResourcesResult, - ListResourcesResultSchema, - ListResourceTemplatesRequest, - ListResourceTemplatesRequestSchema, - ListResourceTemplatesResult, - ListResourceTemplatesResultSchema, - LoggingMessageNotification, - LoggingMessageNotificationSchema, - PingRequest, - PingRequestSchema, - PromptListChangedNotification, - PromptListChangedNotificationSchema, - ReadResourceRequest, - ReadResourceRequestSchema, - ReadResourceResult, - ReadResourceResultSchema, - ResourceListChangedNotification, - ResourceListChangedNotificationSchema, - Tool, - ToolListChangedNotification, - ToolListChangedNotificationSchema, -} from "@modelcontextprotocol/sdk/types.js"; import { Protocol, - ProtocolOptions, - RequestOptions, -} from "@modelcontextprotocol/sdk/shared/protocol.js"; + type BaseContext, + type Client, + type ProtocolOptions, + type CallToolRequest, + type CallToolResult, + type CreateMessageRequest, + type CreateMessageResult, + type CreateMessageResultWithTools, + type EmptyResult, + type Implementation, + type JSONRPCRequest, + type ListPromptsRequest, + type ListPromptsResult, + type ListResourcesRequest, + type ListResourcesResult, + type ListResourceTemplatesRequest, + type ListResourceTemplatesResult, + type ListToolsRequest, + type LoggingMessageNotification, + type PingRequest, + type PromptListChangedNotification, + type ReadResourceRequest, + type ReadResourceResult, + type RequestOptions, + type ResourceListChangedNotification, + type Result, + type Tool, + type ToolListChangedNotification, + type Transport, +} from "@modelcontextprotocol/client"; +import { + EmptyResultSchema, + LoggingMessageNotificationSchema, +} from "@modelcontextprotocol/core"; +import { EventDispatcher, MethodRegistry } from "./events.js"; +import { + toModernArgs, + type LegacyNotificationHandlerSetter, + type LegacyRequestHandlerSetter, +} from "./legacy-handlers.js"; +import type { ZodLiteral, ZodObject, ZodType } from "zod/v4"; + +type MethodSchema = ZodObject<{ + method: ZodLiteral; + params: ZodType; +}>; import { - type AppNotification, - type AppRequest, - type AppResult, type McpUiSandboxResourceReadyNotification, type McpUiSizeChangedNotification, type McpUiToolCancelledNotification, @@ -63,30 +66,39 @@ import { McpUiInitializeRequest, McpUiInitializeRequestSchema, McpUiInitializeResult, + McpUiInitializeResultSchema, McpUiMessageRequest, McpUiMessageRequestSchema, McpUiMessageResult, + McpUiMessageResultSchema, McpUiOpenLinkRequest, McpUiOpenLinkRequestSchema, McpUiOpenLinkResult, + McpUiOpenLinkResultSchema, McpUiDownloadFileRequest, McpUiDownloadFileRequestSchema, McpUiDownloadFileResult, + McpUiDownloadFileResultSchema, McpUiResourceTeardownRequest, McpUiResourceTeardownResultSchema, + McpUiRequestTeardownNotification, + McpUiRequestTeardownNotificationSchema, McpUiSandboxProxyReadyNotification, McpUiSandboxProxyReadyNotificationSchema, McpUiSizeChangedNotificationSchema, McpUiRequestDisplayModeRequest, McpUiRequestDisplayModeRequestSchema, McpUiRequestDisplayModeResult, + McpUiRequestDisplayModeResultSchema, McpUiResourcePermissions, McpUiToolMeta, -} from "./types"; -export * from "./types"; -export { RESOURCE_URI_META_KEY, RESOURCE_MIME_TYPE } from "./app"; -import { RESOURCE_URI_META_KEY } from "./app"; -export { PostMessageTransport } from "./message-transport"; +} from "./types.js"; +export * from "./types.js"; +export { RESOURCE_URI_META_KEY, RESOURCE_MIME_TYPE } from "./constants.js"; +import { RESOURCE_URI_META_KEY } from "./constants.js"; + +type UntypedHandlerSetter = (this: unknown, ...args: unknown[]) => void; +export { PostMessageTransport } from "./message-transport.js"; /** * Extract UI resource URI from tool metadata. @@ -193,10 +205,10 @@ export function buildAllowAttribute( * * @property hostContext - Optional initial host context to provide to the view * - * @see `ProtocolOptions` from @modelcontextprotocol/sdk for available options + * @see `ProtocolOptions` from @modelcontextprotocol/client for available options * @see {@link McpUiHostContext `McpUiHostContext`} for the hostContext structure */ -export type HostOptions = ProtocolOptions & { +export type HostOptions = Omit & { hostContext?: McpUiHostContext; }; @@ -211,24 +223,36 @@ export const SUPPORTED_PROTOCOL_VERSIONS = [LATEST_PROTOCOL_VERSION]; /** * Extra metadata passed to request handlers. * - * This type represents the additional context provided by the `Protocol` class - * when handling requests, including abort signals and session information. - * It is extracted from the MCP SDK's request handler signature. + * This type represents the additional context (`BaseContext`) provided by the + * base MCP SDK `Protocol` when handling requests. * * @internal */ -type RequestHandlerExtra = Parameters< - Parameters[1] ->[1]; +type RequestHandlerExtra = BaseContext; + +/** + * Maps DOM-style event names to their notification `params` types. + * + * Used by {@link AppBridge `AppBridge`} to provide type-safe + * `addEventListener` / `removeEventListener` and singular `on*` handler + * support. + */ +export type AppBridgeEventMap = { + sizechange: McpUiSizeChangedNotification["params"]; + sandboxready: McpUiSandboxProxyReadyNotification["params"]; + initialized: McpUiInitializedNotification["params"]; + requestteardown: McpUiRequestTeardownNotification["params"]; + loggingmessage: LoggingMessageNotification["params"]; +}; /** * Host-side bridge for communicating with a single View ({@link app!App `App`}). * - * `AppBridge` extends the MCP SDK's `Protocol` class and acts as a proxy between - * the host application and a view running in an iframe. When an MCP client - * is provided to the constructor, it automatically forwards MCP server capabilities - * (tools, resources, prompts) to the view. It also handles the initialization - * handshake. + * `AppBridge` extends the base MCP SDK's public `Protocol` class and acts as a + * proxy between the host application and a view running in an iframe. When a + * separate MCP client is provided to the constructor, it automatically forwards + * MCP server capabilities (tools, resources, prompts) to the view. It also + * handles the Apps initialization handshake. * * ## Architecture * @@ -278,14 +302,197 @@ type RequestHandlerExtra = Parameters< * await bridge.connect(transport); * ``` */ -export class AppBridge extends Protocol< - AppRequest, - AppNotification, - AppResult -> { +export class AppBridge extends Protocol { private _appCapabilities?: McpUiAppCapabilities; private _hostContext: McpUiHostContext = {}; private _appInfo?: Implementation; + private _initializedReceived = false; + private readonly _registeredEvents = new Set(); + private readonly _events = new EventDispatcher(); + private readonly _methods = new MethodRegistry(); + + // ── Handler registration with double-set protection ───────────────── + // + // The base SDK `Protocol` silently replaces an existing handler. The four + // overrides below restore the v1 behaviour: a direct `setRequestHandler` / + // `setNotificationHandler` for a method that already has a handler throws, + // so a stray registration cannot silently replace a host's `on*` handler + // (for example the URL allow-listing in `onopenlink`) or disconnect + // `addEventListener` listeners. They are arrow-function class fields rather + // than prototype methods so that `Protocol`'s constructor β€” which registers + // its own ping/cancelled/progress handlers before our fields initialize β€” + // hits the base implementation and skips tracking. + + /** + * Registers a request handler. Throws if a handler for the same method has + * already been registered β€” use the `on*` setter for replace semantics. + * + * @throws {Error} if a handler for this method is already registered. + */ + override setRequestHandler: LegacyRequestHandlerSetter< + Protocol["setRequestHandler"] + > = (...args: unknown[]) => { + const [method, ...rest] = toModernArgs("request", args) ?? args; + this._methods.claim(method as string, "setRequestHandler"); + (super.setRequestHandler as unknown as UntypedHandlerSetter).call( + this, + method, + ...rest, + ); + }; + + /** + * Registers a notification handler. Throws if a handler for the same method + * has already been registered β€” use the `on*` setter (replace semantics) or + * `addEventListener` (multi-listener) for mapped events. + * + * @throws {Error} if a handler for this method is already registered. + */ + override setNotificationHandler: LegacyNotificationHandlerSetter< + Protocol["setNotificationHandler"] + > = (...args: unknown[]) => { + const [method, ...rest] = toModernArgs("notification", args) ?? args; + this._methods.claim(method as string, "setNotificationHandler"); + (super.setNotificationHandler as unknown as UntypedHandlerSetter).call( + this, + method, + ...rest, + ); + }; + + override removeRequestHandler: Protocol["removeRequestHandler"] = + (method: string) => { + this._methods.release(method); + super.removeRequestHandler(method); + }; + + override removeNotificationHandler: Protocol["removeNotificationHandler"] = + (method: string) => { + this._methods.release(method); + super.removeNotificationHandler(method); + }; + + /** + * Register a request handler with replace semantics, bypassing the + * double-set protection of {@link setRequestHandler `setRequestHandler`}. + * Used by the `on*` request-handler setters. + */ + protected replaceRequestHandler: Protocol["setRequestHandler"] = + (method: string, ...rest: unknown[]) => { + this._methods.replace(method); + (super.setRequestHandler as unknown as UntypedHandlerSetter).call( + this, + method, + ...rest, + ); + }; + + /** + * The base MCP SDK calls this hook for every standard and custom request + * handler registration. AppBridge uses it to preserve the existing warning + * when a View calls host methods before `ui/notifications/initialized`, + * without adding overload-forwarding adapters around `setRequestHandler`. + * `ui/initialize` and `ping` are exempt because they are valid before the + * Apps-ready gate. This wraps registered callbacks, not JSON-RPC dispatch. + * + * @see {@link https://github.com/anthropics/claude-ai-mcp/issues/149 claude-ai-mcp#149} + */ + protected override _wrapHandler( + method: string, + handler: (request: JSONRPCRequest, context: BaseContext) => Promise, + ): (request: JSONRPCRequest, context: BaseContext) => Promise { + const wrapped = super._wrapHandler(method, handler); + if (method === "ui/initialize" || method === "ping") { + return wrapped; + } + return async (request, context) => { + if (!this._initializedReceived) { + console.warn( + `[ext-apps] AppBridge received '${method}' before ` + + `ui/notifications/initialized. The View is calling host ` + + `methods before completing the handshake; it should await ` + + `app.connect() first.`, + ); + } + return wrapped(request, context); + }; + } + + private readonly eventSchemas: { + [K in keyof AppBridgeEventMap]: MethodSchema; + } = { + sizechange: McpUiSizeChangedNotificationSchema, + sandboxready: McpUiSandboxProxyReadyNotificationSchema, + initialized: McpUiInitializedNotificationSchema, + requestteardown: McpUiRequestTeardownNotificationSchema, + loggingmessage: LoggingMessageNotificationSchema, + }; + + protected setEventHandler( + event: K, + handler: ((params: AppBridgeEventMap[K]) => void) | undefined, + ): void { + this._ensureEventSlot(event); + this._events.setHandler(event, handler); + } + + protected getEventHandler( + event: K, + ): ((params: AppBridgeEventMap[K]) => void) | undefined { + return this._events.getHandler(event); + } + + addEventListener( + event: K, + handler: (params: AppBridgeEventMap[K]) => void, + ): void { + this._ensureEventSlot(event); + this._events.addEventListener(event, handler); + } + + removeEventListener( + event: K, + handler: (params: AppBridgeEventMap[K]) => void, + ): void { + this._events.removeEventListener(event, handler); + } + + private _ensureEventSlot(event: K): void { + if (this._registeredEvents.has(event)) return; + const schema = this.eventSchemas[event]; + if (!schema) throw new Error(`Unknown event: ${String(event)}`); + + const dispatch = (params: AppBridgeEventMap[K]) => { + if (event === "initialized") this._initializedReceived = true; + this._events.dispatch(event, params); + }; + + if (event === "loggingmessage") { + this.setNotificationHandler("notifications/message", (notification) => { + dispatch(notification.params as AppBridgeEventMap[K]); + }); + } else { + this.setNotificationHandler( + schema.shape.method.value, + { params: schema.shape.params }, + (params) => dispatch(params as AppBridgeEventMap[K]), + ); + } + this._registeredEvents.add(event); + } + + protected warnIfRequestHandlerReplaced( + name: string, + previous: unknown, + next: unknown, + ): void { + if (previous && next) { + console.warn( + `[MCP Apps] ${name} handler replaced. ` + + `Previous handler will no longer be called.`, + ); + } + } /** * Create a new AppBridge instance. @@ -295,8 +502,8 @@ export class AppBridge extends Protocol< * between the View and the server. When `null`, you must register handlers * manually using the {@link oncalltool `oncalltool`}, {@link onlistresources `onlistresources`}, etc. setters. * @param _hostInfo - Host application identification (name and version) - * @param _capabilities - Features and capabilities the host supports - * @param options - Configuration options (inherited from Protocol) + * @param _hostCapabilities - Features and capabilities the host supports + * @param options - Configuration options (`ProtocolOptions` from the base MCP SDK plus `hostContext`) * * @example With MCP client (automatic forwarding) * ```ts source="./app-bridge.examples.ts#AppBridge_constructor_withMcpClient" @@ -323,28 +530,73 @@ export class AppBridge extends Protocol< constructor( private _client: Client | null, private _hostInfo: Implementation, - private _capabilities: McpUiHostCapabilities, + private _hostCapabilities: McpUiHostCapabilities, options?: HostOptions, ) { super(options); + this._methods.replace("notifications/cancelled"); + this._methods.replace("notifications/progress"); + + this._ensureEventSlot("initialized"); this._hostContext = options?.hostContext || {}; - this.setRequestHandler(McpUiInitializeRequestSchema, (request) => - this._oninitialize(request), + this.replaceRequestHandler( + "ui/initialize", + { + params: McpUiInitializeRequestSchema.shape.params, + result: McpUiInitializeResultSchema, + }, + (params) => this._onAppsInitialize(params), ); - this.setRequestHandler(PingRequestSchema, (request, extra) => { + this.replaceRequestHandler("ping", (request, extra) => { this.onping?.(request.params, extra); return {}; }); // Default handler for requestDisplayMode - returns current mode from host context. // Hosts can override this by setting bridge.onrequestdisplaymode = ... - this.setRequestHandler(McpUiRequestDisplayModeRequestSchema, (request) => { - const currentMode = this._hostContext.displayMode ?? "inline"; - return { mode: currentMode }; - }); + this.replaceRequestHandler( + "ui/request-display-mode", + { + params: McpUiRequestDisplayModeRequestSchema.shape.params, + result: McpUiRequestDisplayModeResultSchema, + }, + () => { + const currentMode = this._hostContext.displayMode ?? "inline"; + return { mode: currentMode }; + }, + ); + } + + /** @internal */ + protected buildContext(ctx: BaseContext): BaseContext { + return ctx; + } + + /** + * Verify that the view supports the capability required for the given request method. + * @internal + */ + protected assertCapabilityForMethod(_method: string): void { + // Host-to-view requests are not capability-gated. + } + + /** + * Verify that a request handler is registered and supported for the given method. + * @internal + */ + protected assertRequestHandlerCapability(_method: string): void { + // Host handler registration is not capability-gated. + } + + /** + * Verify that the host supports the capability required for the given notification method. + * @internal + */ + protected assertNotificationCapability(_method: string): void { + // Host notifications are not capability-gated. } /** @@ -440,13 +692,19 @@ export class AppBridge extends Protocol< * * @see {@link McpUiSizeChangedNotification `McpUiSizeChangedNotification`} for the notification type * @see {@link app!App.sendSizeChanged `App.sendSizeChanged`} - the View method that sends these notifications + * @deprecated Use {@link addEventListener `addEventListener("sizechange", handler)`} instead β€” it composes with other listeners and supports cleanup via {@link removeEventListener `removeEventListener`}. */ + get onsizechange(): + | ((params: McpUiSizeChangedNotification["params"]) => void) + | undefined { + return this.getEventHandler("sizechange"); + } set onsizechange( - callback: (params: McpUiSizeChangedNotification["params"]) => void, + callback: + | ((params: McpUiSizeChangedNotification["params"]) => void) + | undefined, ) { - this.setNotificationHandler(McpUiSizeChangedNotificationSchema, (n) => - callback(n.params), - ); + this.setEventHandler("sizechange", callback); } /** @@ -464,8 +722,7 @@ export class AppBridge extends Protocol< * ```typescript * bridge.onsandboxready = async () => { * const resource = await mcpClient.request( - * { method: "resources/read", params: { uri: "ui://my-app" } }, - * ReadResourceResultSchema + * { method: "resources/read", params: { uri: "ui://my-app" } } * ); * * bridge.sendSandboxResourceReady({ @@ -478,13 +735,19 @@ export class AppBridge extends Protocol< * @internal * @see {@link McpUiSandboxProxyReadyNotification `McpUiSandboxProxyReadyNotification`} for the notification type * @see {@link sendSandboxResourceReady `sendSandboxResourceReady`} for sending content to the sandbox + * @deprecated Use {@link addEventListener `addEventListener("sandboxready", handler)`} instead β€” it composes with other listeners and supports cleanup via {@link removeEventListener `removeEventListener`}. */ + get onsandboxready(): + | ((params: McpUiSandboxProxyReadyNotification["params"]) => void) + | undefined { + return this.getEventHandler("sandboxready"); + } set onsandboxready( - callback: (params: McpUiSandboxProxyReadyNotification["params"]) => void, + callback: + | ((params: McpUiSandboxProxyReadyNotification["params"]) => void) + | undefined, ) { - this.setNotificationHandler(McpUiSandboxProxyReadyNotificationSchema, (n) => - callback(n.params), - ); + this.setEventHandler("sandboxready", callback); } /** @@ -503,13 +766,19 @@ export class AppBridge extends Protocol< * * @see {@link McpUiInitializedNotification `McpUiInitializedNotification`} for the notification type * @see {@link sendToolInput `sendToolInput`} for sending tool arguments to the View + * @deprecated Use {@link addEventListener `addEventListener("initialized", handler)`} instead β€” it composes with other listeners and supports cleanup via {@link removeEventListener `removeEventListener`}. */ + get oninitialized(): + | ((params?: McpUiInitializedNotification["params"]) => void) + | undefined { + return this.getEventHandler("initialized"); + } set oninitialized( - callback: (params: McpUiInitializedNotification["params"]) => void, + callback: + | ((params?: McpUiInitializedNotification["params"]) => void) + | undefined, ) { - this.setNotificationHandler(McpUiInitializedNotificationSchema, (n) => - callback(n.params), - ); + this.setEventHandler("initialized", callback); } /** @@ -546,16 +815,32 @@ export class AppBridge extends Protocol< * @see {@link McpUiMessageRequest `McpUiMessageRequest`} for the request type * @see {@link McpUiMessageResult `McpUiMessageResult`} for the result type */ + private _onmessage?: ( + params: McpUiMessageRequest["params"], + extra: RequestHandlerExtra, + ) => Promise; + get onmessage() { + return this._onmessage; + } set onmessage( - callback: ( - params: McpUiMessageRequest["params"], - extra: RequestHandlerExtra, - ) => Promise, + callback: + | (( + params: McpUiMessageRequest["params"], + extra: RequestHandlerExtra, + ) => Promise) + | undefined, ) { - this.setRequestHandler( - McpUiMessageRequestSchema, - async (request, extra) => { - return callback(request.params, extra); + this.warnIfRequestHandlerReplaced("onmessage", this._onmessage, callback); + this._onmessage = callback; + this.replaceRequestHandler( + "ui/message", + { + params: McpUiMessageRequestSchema.shape.params, + result: McpUiMessageResultSchema, + }, + async (params, extra) => { + if (!this._onmessage) throw new Error("No onmessage handler set"); + return this._onmessage(params, extra); }, ); } @@ -603,16 +888,32 @@ export class AppBridge extends Protocol< * @see {@link McpUiOpenLinkRequest `McpUiOpenLinkRequest`} for the request type * @see {@link McpUiOpenLinkResult `McpUiOpenLinkResult`} for the result type */ + private _onopenlink?: ( + params: McpUiOpenLinkRequest["params"], + extra: RequestHandlerExtra, + ) => Promise; + get onopenlink() { + return this._onopenlink; + } set onopenlink( - callback: ( - params: McpUiOpenLinkRequest["params"], - extra: RequestHandlerExtra, - ) => Promise, + callback: + | (( + params: McpUiOpenLinkRequest["params"], + extra: RequestHandlerExtra, + ) => Promise) + | undefined, ) { - this.setRequestHandler( - McpUiOpenLinkRequestSchema, - async (request, extra) => { - return callback(request.params, extra); + this.warnIfRequestHandlerReplaced("onopenlink", this._onopenlink, callback); + this._onopenlink = callback; + this.replaceRequestHandler( + "ui/open-link", + { + params: McpUiOpenLinkRequestSchema.shape.params, + result: McpUiOpenLinkResultSchema, + }, + async (params, extra) => { + if (!this._onopenlink) throw new Error("No onopenlink handler set"); + return this._onopenlink(params, extra); }, ); } @@ -659,20 +960,78 @@ export class AppBridge extends Protocol< * @see {@link McpUiDownloadFileRequest `McpUiDownloadFileRequest`} for the request type * @see {@link McpUiDownloadFileResult `McpUiDownloadFileResult`} for the result type */ + private _ondownloadfile?: ( + params: McpUiDownloadFileRequest["params"], + extra: RequestHandlerExtra, + ) => Promise; + get ondownloadfile() { + return this._ondownloadfile; + } set ondownloadfile( - callback: ( - params: McpUiDownloadFileRequest["params"], - extra: RequestHandlerExtra, - ) => Promise, + callback: + | (( + params: McpUiDownloadFileRequest["params"], + extra: RequestHandlerExtra, + ) => Promise) + | undefined, ) { - this.setRequestHandler( - McpUiDownloadFileRequestSchema, - async (request, extra) => { - return callback(request.params, extra); + this.warnIfRequestHandlerReplaced( + "ondownloadfile", + this._ondownloadfile, + callback, + ); + this._ondownloadfile = callback; + this.replaceRequestHandler( + "ui/download-file", + { + params: McpUiDownloadFileRequestSchema.shape.params, + result: McpUiDownloadFileResultSchema, + }, + async (params, extra) => { + if (!this._ondownloadfile) + throw new Error("No ondownloadfile handler set"); + return this._ondownloadfile(params, extra); }, ); } + /** + * Register a handler for app-initiated teardown request notifications from the view. + * + * The view sends `ui/notifications/request-teardown` when it wants the host to tear it down. + * If the host decides to proceed, it should send + * `ui/resource-teardown` (via {@link teardownResource `teardownResource`}) to allow + * the view to perform gracefull termination, then unmount the iframe after the view responds. + * + * @example + * ```typescript + * bridge.onrequestteardown = async (params) => { + * console.log("App requested teardown"); + * // Initiate teardown to allow the app to persist unsaved state + * // Alternatively, the callback can early return to prevent teardown + * await bridge.teardownResource({}); + * // Now safe to unmount the iframe + * iframe.remove(); + * }; + * ``` + * + * @see {@link McpUiRequestTeardownNotification `McpUiRequestTeardownNotification`} for the notification type + * @see {@link teardownResource `teardownResource`} for initiating teardown + * @deprecated Use {@link addEventListener `addEventListener("requestteardown", handler)`} instead β€” it composes with other listeners and supports cleanup via {@link removeEventListener `removeEventListener`}. + */ + get onrequestteardown(): + | ((params: McpUiRequestTeardownNotification["params"]) => void) + | undefined { + return this.getEventHandler("requestteardown"); + } + set onrequestteardown( + callback: + | ((params: McpUiRequestTeardownNotification["params"]) => void) + | undefined, + ) { + this.setEventHandler("requestteardown", callback); + } + /** * Register a handler for display mode change requests from the view. * @@ -705,16 +1064,37 @@ export class AppBridge extends Protocol< * @see {@link McpUiRequestDisplayModeRequest `McpUiRequestDisplayModeRequest`} for the request type * @see {@link McpUiRequestDisplayModeResult `McpUiRequestDisplayModeResult`} for the result type */ + private _onrequestdisplaymode?: ( + params: McpUiRequestDisplayModeRequest["params"], + extra: RequestHandlerExtra, + ) => Promise; + get onrequestdisplaymode() { + return this._onrequestdisplaymode; + } set onrequestdisplaymode( - callback: ( - params: McpUiRequestDisplayModeRequest["params"], - extra: RequestHandlerExtra, - ) => Promise, + callback: + | (( + params: McpUiRequestDisplayModeRequest["params"], + extra: RequestHandlerExtra, + ) => Promise) + | undefined, ) { - this.setRequestHandler( - McpUiRequestDisplayModeRequestSchema, - async (request, extra) => { - return callback(request.params, extra); + this.warnIfRequestHandlerReplaced( + "onrequestdisplaymode", + this._onrequestdisplaymode, + callback, + ); + this._onrequestdisplaymode = callback; + this.replaceRequestHandler( + "ui/request-display-mode", + { + params: McpUiRequestDisplayModeRequestSchema.shape.params, + result: McpUiRequestDisplayModeResultSchema, + }, + async (params, extra) => { + if (!this._onrequestdisplaymode) + throw new Error("No onrequestdisplaymode handler set"); + return this._onrequestdisplaymode(params, extra); }, ); } @@ -730,10 +1110,10 @@ export class AppBridge extends Protocol< * This uses the standard MCP logging notification format, not a UI-specific * message type. * - * @param callback - Handler that receives logging params - * - `params.level` - Log level: "debug" | "info" | "notice" | "warning" | "error" | "critical" | "alert" | "emergency" - * - `params.logger` - Optional logger name/identifier - * - `params.data` - Log message and optional structured data + * The handler receives `LoggingMessageNotification["params"]`: + * - `level` β€” "debug" | "info" | "notice" | "warning" | "error" | "critical" | "alert" | "emergency" + * - `logger` β€” optional logger name/identifier + * - `data` β€” log message and optional structured data * * @example * ```ts source="./app-bridge.examples.ts#AppBridge_onloggingmessage_handleLog" @@ -744,16 +1124,19 @@ export class AppBridge extends Protocol< * ); * }; * ``` + * @deprecated Use {@link addEventListener `addEventListener("loggingmessage", handler)`} instead β€” it composes with other listeners and supports cleanup via {@link removeEventListener `removeEventListener`}. */ + get onloggingmessage(): + | ((params: LoggingMessageNotification["params"]) => void) + | undefined { + return this.getEventHandler("loggingmessage"); + } set onloggingmessage( - callback: (params: LoggingMessageNotification["params"]) => void, + callback: + | ((params: LoggingMessageNotification["params"]) => void) + | undefined, ) { - this.setNotificationHandler( - LoggingMessageNotificationSchema, - async (notification) => { - callback(notification.params); - }, - ); + this.setEventHandler("loggingmessage", callback); } /** @@ -782,16 +1165,37 @@ export class AppBridge extends Protocol< * * @see {@link McpUiUpdateModelContextRequest `McpUiUpdateModelContextRequest`} for the request type */ + private _onupdatemodelcontext?: ( + params: McpUiUpdateModelContextRequest["params"], + extra: RequestHandlerExtra, + ) => Promise; + get onupdatemodelcontext() { + return this._onupdatemodelcontext; + } set onupdatemodelcontext( - callback: ( - params: McpUiUpdateModelContextRequest["params"], - extra: RequestHandlerExtra, - ) => Promise, + callback: + | (( + params: McpUiUpdateModelContextRequest["params"], + extra: RequestHandlerExtra, + ) => Promise) + | undefined, ) { - this.setRequestHandler( - McpUiUpdateModelContextRequestSchema, - async (request, extra) => { - return callback(request.params, extra); + this.warnIfRequestHandlerReplaced( + "onupdatemodelcontext", + this._onupdatemodelcontext, + callback, + ); + this._onupdatemodelcontext = callback; + this.replaceRequestHandler( + "ui/update-model-context", + { + params: McpUiUpdateModelContextRequestSchema.shape.params, + result: EmptyResultSchema, + }, + async (params, extra) => { + if (!this._onupdatemodelcontext) + throw new Error("No onupdatemodelcontext handler set"); + return this._onupdatemodelcontext(params, extra); }, ); } @@ -813,26 +1217,100 @@ export class AppBridge extends Protocol< * bridge.oncalltool = async (params, extra) => { * return mcpClient.request( * { method: "tools/call", params }, - * CallToolResultSchema, - * { signal: extra.signal }, + * { signal: extra.mcpReq.signal }, * ); * }; * ``` * - * @see `CallToolRequest` from @modelcontextprotocol/sdk for the request type - * @see `CallToolResult` from @modelcontextprotocol/sdk for the result type + * @see `CallToolRequest` from @modelcontextprotocol/client for the request type + * @see `CallToolResult` from @modelcontextprotocol/client for the result type */ + private _oncalltool?: ( + params: CallToolRequest["params"], + extra: RequestHandlerExtra, + ) => Promise; + get oncalltool() { + return this._oncalltool; + } set oncalltool( - callback: ( - params: CallToolRequest["params"], - extra: RequestHandlerExtra, - ) => Promise, + callback: + | (( + params: CallToolRequest["params"], + extra: RequestHandlerExtra, + ) => Promise) + | undefined, ) { - this.setRequestHandler(CallToolRequestSchema, async (request, extra) => { - return callback(request.params, extra); + this.warnIfRequestHandlerReplaced("oncalltool", this._oncalltool, callback); + this._oncalltool = callback; + this.replaceRequestHandler("tools/call", async (request, extra) => { + if (!this._oncalltool) throw new Error("No oncalltool handler set"); + return this._oncalltool(request.params, extra); }); } + /** + * Register a handler for LLM sampling requests from the view. + * + * The view sends standard MCP `sampling/createMessage` requests to obtain + * LLM completions via the host's model connection. The host has full + * discretion over which model to use and SHOULD apply rate limiting, + * cost controls, and user approval (human-in-the-loop) before sampling. + * + * Hosts that register this handler SHOULD advertise `sampling` (and + * `sampling.tools` if tool-calling is supported) in + * {@link McpUiHostCapabilities `McpUiHostCapabilities`}. + * + * @param callback - Handler that receives `CreateMessageRequest` params and + * returns a `CreateMessageResult` (or `CreateMessageResultWithTools` when + * `params.tools` was provided) + * - `params` - Standard MCP sampling params (messages, maxTokens, tools, etc.) + * - `extra` - Request metadata (abort signal, session info) + * + * @example Forward to your LLM provider + * ```ts source="./app-bridge.examples.ts#AppBridge_oncreatesamplingmessage_forwardToLlm" + * bridge.oncreatesamplingmessage = async (params, extra) => { + * // Apply rate limiting, user approval, cost controls here + * return await myLlmProvider.complete(params, { + * signal: extra.mcpReq.signal, + * }); + * }; + * ``` + * + * @see `CreateMessageRequest` from @modelcontextprotocol/client for the request type + * @see `CreateMessageResult` / `CreateMessageResultWithTools` from @modelcontextprotocol/client for result types + */ + private _oncreatesamplingmessage?: ( + params: CreateMessageRequest["params"], + extra: RequestHandlerExtra, + ) => Promise; + get oncreatesamplingmessage() { + return this._oncreatesamplingmessage; + } + set oncreatesamplingmessage( + callback: + | (( + params: CreateMessageRequest["params"], + extra: RequestHandlerExtra, + ) => Promise) + | undefined, + ) { + this.warnIfRequestHandlerReplaced( + "oncreatesamplingmessage", + this._oncreatesamplingmessage, + callback, + ); + this._oncreatesamplingmessage = callback; + this.replaceRequestHandler( + "sampling/createMessage", + async (request, extra) => { + if (!this._oncreatesamplingmessage) { + throw new Error("No oncreatesamplingmessage handler set"); + } + return this._oncreatesamplingmessage(request.params, extra); + }, + ); + } + /** * Notify the view that the MCP server's tool list has changed. * @@ -845,12 +1323,12 @@ export class AppBridge extends Protocol< * @example * ```typescript * // In your MCP client notification handler: - * mcpClient.setNotificationHandler(ToolListChangedNotificationSchema, () => { + * mcpClient.setNotificationHandler("notifications/tools/list_changed", () => { * bridge.sendToolListChanged(); * }); * ``` * - * @see `ToolListChangedNotification` from @modelcontextprotocol/sdk for the notification type + * @see `ToolListChangedNotification` from @modelcontextprotocol/client for the notification type */ sendToolListChanged(params: ToolListChangedNotification["params"] = {}) { return this.notification({ @@ -876,27 +1354,40 @@ export class AppBridge extends Protocol< * bridge.onlistresources = async (params, extra) => { * return mcpClient.request( * { method: "resources/list", params }, - * ListResourcesResultSchema, - * { signal: extra.signal }, + * { signal: extra.mcpReq.signal }, * ); * }; * ``` * - * @see `ListResourcesRequest` from @modelcontextprotocol/sdk for the request type - * @see `ListResourcesResult` from @modelcontextprotocol/sdk for the result type + * @see `ListResourcesRequest` from @modelcontextprotocol/client for the request type + * @see `ListResourcesResult` from @modelcontextprotocol/client for the result type */ + private _onlistresources?: ( + params: ListResourcesRequest["params"], + extra: RequestHandlerExtra, + ) => Promise; + get onlistresources() { + return this._onlistresources; + } set onlistresources( - callback: ( - params: ListResourcesRequest["params"], - extra: RequestHandlerExtra, - ) => Promise, + callback: + | (( + params: ListResourcesRequest["params"], + extra: RequestHandlerExtra, + ) => Promise) + | undefined, ) { - this.setRequestHandler( - ListResourcesRequestSchema, - async (request, extra) => { - return callback(request.params, extra); - }, + this.warnIfRequestHandlerReplaced( + "onlistresources", + this._onlistresources, + callback, ); + this._onlistresources = callback; + this.replaceRequestHandler("resources/list", async (request, extra) => { + if (!this._onlistresources) + throw new Error("No onlistresources handler set"); + return this._onlistresources(request.params, extra); + }); } /** @@ -916,25 +1407,41 @@ export class AppBridge extends Protocol< * bridge.onlistresourcetemplates = async (params, extra) => { * return mcpClient.request( * { method: "resources/templates/list", params }, - * ListResourceTemplatesResultSchema, - * { signal: extra.signal } + * { signal: extra.mcpReq.signal } * ); * }; * ``` * - * @see `ListResourceTemplatesRequest` from @modelcontextprotocol/sdk for the request type - * @see `ListResourceTemplatesResult` from @modelcontextprotocol/sdk for the result type + * @see `ListResourceTemplatesRequest` from @modelcontextprotocol/client for the request type + * @see `ListResourceTemplatesResult` from @modelcontextprotocol/client for the result type */ + private _onlistresourcetemplates?: ( + params: ListResourceTemplatesRequest["params"], + extra: RequestHandlerExtra, + ) => Promise; + get onlistresourcetemplates() { + return this._onlistresourcetemplates; + } set onlistresourcetemplates( - callback: ( - params: ListResourceTemplatesRequest["params"], - extra: RequestHandlerExtra, - ) => Promise, + callback: + | (( + params: ListResourceTemplatesRequest["params"], + extra: RequestHandlerExtra, + ) => Promise) + | undefined, ) { - this.setRequestHandler( - ListResourceTemplatesRequestSchema, + this.warnIfRequestHandlerReplaced( + "onlistresourcetemplates", + this._onlistresourcetemplates, + callback, + ); + this._onlistresourcetemplates = callback; + this.replaceRequestHandler( + "resources/templates/list", async (request, extra) => { - return callback(request.params, extra); + if (!this._onlistresourcetemplates) + throw new Error("No onlistresourcetemplates handler set"); + return this._onlistresourcetemplates(request.params, extra); }, ); } @@ -956,27 +1463,40 @@ export class AppBridge extends Protocol< * bridge.onreadresource = async (params, extra) => { * return mcpClient.request( * { method: "resources/read", params }, - * ReadResourceResultSchema, - * { signal: extra.signal }, + * { signal: extra.mcpReq.signal }, * ); * }; * ``` * - * @see `ReadResourceRequest` from @modelcontextprotocol/sdk for the request type - * @see `ReadResourceResult` from @modelcontextprotocol/sdk for the result type + * @see `ReadResourceRequest` from @modelcontextprotocol/client for the request type + * @see `ReadResourceResult` from @modelcontextprotocol/client for the result type */ + private _onreadresource?: ( + params: ReadResourceRequest["params"], + extra: RequestHandlerExtra, + ) => Promise; + get onreadresource() { + return this._onreadresource; + } set onreadresource( - callback: ( - params: ReadResourceRequest["params"], - extra: RequestHandlerExtra, - ) => Promise, + callback: + | (( + params: ReadResourceRequest["params"], + extra: RequestHandlerExtra, + ) => Promise) + | undefined, ) { - this.setRequestHandler( - ReadResourceRequestSchema, - async (request, extra) => { - return callback(request.params, extra); - }, + this.warnIfRequestHandlerReplaced( + "onreadresource", + this._onreadresource, + callback, ); + this._onreadresource = callback; + this.replaceRequestHandler("resources/read", async (request, extra) => { + if (!this._onreadresource) + throw new Error("No onreadresource handler set"); + return this._onreadresource(request.params, extra); + }); } /** @@ -991,12 +1511,12 @@ export class AppBridge extends Protocol< * @example * ```typescript * // In your MCP client notification handler: - * mcpClient.setNotificationHandler(ResourceListChangedNotificationSchema, () => { + * mcpClient.setNotificationHandler("notifications/resources/list_changed", () => { * bridge.sendResourceListChanged(); * }); * ``` * - * @see `ResourceListChangedNotification` from @modelcontextprotocol/sdk for the notification type + * @see `ResourceListChangedNotification` from @modelcontextprotocol/client for the notification type */ sendResourceListChanged( params: ResourceListChangedNotification["params"] = {}, @@ -1024,23 +1544,38 @@ export class AppBridge extends Protocol< * bridge.onlistprompts = async (params, extra) => { * return mcpClient.request( * { method: "prompts/list", params }, - * ListPromptsResultSchema, - * { signal: extra.signal }, + * { signal: extra.mcpReq.signal }, * ); * }; * ``` * - * @see `ListPromptsRequest` from @modelcontextprotocol/sdk for the request type - * @see `ListPromptsResult` from @modelcontextprotocol/sdk for the result type + * @see `ListPromptsRequest` from @modelcontextprotocol/client for the request type + * @see `ListPromptsResult` from @modelcontextprotocol/client for the result type */ + private _onlistprompts?: ( + params: ListPromptsRequest["params"], + extra: RequestHandlerExtra, + ) => Promise; + get onlistprompts() { + return this._onlistprompts; + } set onlistprompts( - callback: ( - params: ListPromptsRequest["params"], - extra: RequestHandlerExtra, - ) => Promise, + callback: + | (( + params: ListPromptsRequest["params"], + extra: RequestHandlerExtra, + ) => Promise) + | undefined, ) { - this.setRequestHandler(ListPromptsRequestSchema, async (request, extra) => { - return callback(request.params, extra); + this.warnIfRequestHandlerReplaced( + "onlistprompts", + this._onlistprompts, + callback, + ); + this._onlistprompts = callback; + this.replaceRequestHandler("prompts/list", async (request, extra) => { + if (!this._onlistprompts) throw new Error("No onlistprompts handler set"); + return this._onlistprompts(request.params, extra); }); } @@ -1056,12 +1591,12 @@ export class AppBridge extends Protocol< * @example * ```typescript * // In your MCP client notification handler: - * mcpClient.setNotificationHandler(PromptListChangedNotificationSchema, () => { + * mcpClient.setNotificationHandler("notifications/prompts/list_changed", () => { * bridge.sendPromptListChanged(); * }); * ``` * - * @see `PromptListChangedNotification` from @modelcontextprotocol/sdk for the notification type + * @see `PromptListChangedNotification` from @modelcontextprotocol/client for the notification type */ sendPromptListChanged(params: PromptListChangedNotification["params"] = {}) { return this.notification({ @@ -1070,46 +1605,6 @@ export class AppBridge extends Protocol< }); } - /** - * Verify that the guest supports the capability required for the given request method. - * @internal - */ - assertCapabilityForMethod(method: AppRequest["method"]): void { - // TODO - } - - /** - * Verify that a request handler is registered and supported for the given method. - * @internal - */ - assertRequestHandlerCapability(method: AppRequest["method"]): void { - // TODO - } - - /** - * Verify that the host supports the capability required for the given notification method. - * @internal - */ - assertNotificationCapability(method: AppNotification["method"]): void { - // TODO - } - - /** - * Verify that task creation is supported for the given request method. - * @internal - */ - protected assertTaskCapability(_method: string): void { - throw new Error("Tasks are not supported in MCP Apps"); - } - - /** - * Verify that task handler is supported for the given method. - * @internal - */ - protected assertTaskHandlerCapability(_method: string): void { - throw new Error("Task handlers are not supported in MCP Apps"); - } - /** * Get the host capabilities passed to the constructor. * @@ -1118,20 +1613,29 @@ export class AppBridge extends Protocol< * @see {@link McpUiHostCapabilities `McpUiHostCapabilities`} for the capabilities structure */ getCapabilities(): McpUiHostCapabilities { - return this._capabilities; + return this._hostCapabilities; } /** * Handle the ui/initialize request from the guest. * @internal */ - private async _oninitialize( - request: McpUiInitializeRequest, + private async _onAppsInitialize( + params: McpUiInitializeRequest["params"], ): Promise { - const requestedVersion = request.params.protocolVersion; + const requestedVersion = params.protocolVersion; - this._appCapabilities = request.params.appCapabilities; - this._appInfo = request.params.appInfo; + if (this._appInfo !== undefined) { + console.warn( + "[ext-apps] AppBridge received a second ui/initialize. The View may " + + "be double-mounting (e.g. React StrictMode in dev) without closing " + + "the previous App instance. Responding normally; the latest " + + "appInfo/appCapabilities replace the previous values.", + ); + } + + this._appCapabilities = params.appCapabilities; + this._appInfo = params.appInfo; const protocolVersion = SUPPORTED_PROTOCOL_VERSIONS.includes( requestedVersion, @@ -1294,10 +1798,10 @@ export class AppBridge extends Protocol< * * @example * ```ts source="./app-bridge.examples.ts#AppBridge_sendToolResult_afterExecution" - * const result = await mcpClient.request( - * { method: "tools/call", params: { name: "get_weather", arguments: args } }, - * CallToolResultSchema, - * ); + * const result = await mcpClient.request({ + * method: "tools/call", + * params: { name: "get_weather", arguments: args }, + * }); * bridge.sendToolResult(result); * ``` * @@ -1413,6 +1917,32 @@ export class AppBridge extends Protocol< /** @deprecated Use {@link teardownResource `teardownResource`} instead */ sendResourceTeardown: AppBridge["teardownResource"] = this.teardownResource; + /** + * Call a tool on the view. + * + * Sends a `tools/call` request to the view and returns the result. + * + * @param params - Tool call parameters (name and arguments) + * @param options - Request options (timeout, abort signal, etc.) + * @returns Promise resolving to the tool call result + */ + callTool(params: CallToolRequest["params"], options?: RequestOptions) { + return this.request({ method: "tools/call", params }, options); + } + + /** + * List tools available on the view. + * + * Sends a `tools/list` request to the view and returns the result. + * + * @param params - List tools parameters (may include cursor for pagination) + * @param options - Request options (timeout, abort signal, etc.) + * @returns Promise resolving to the list of tools + */ + listTools(params: ListToolsRequest["params"], options?: RequestOptions) { + return this.request({ method: "tools/list", params }, options); + } + /** * Connect to the view via transport and optionally set up message forwarding. * @@ -1473,6 +2003,7 @@ export class AppBridge extends Protocol< "AppBridge is already connected. Call close() before connecting again.", ); } + this._initializedReceived = false; if (this._client) { // When a client was passed to the constructor, automatically forward // MCP requests/notifications between the view and the server @@ -1485,13 +2016,12 @@ export class AppBridge extends Protocol< this.oncalltool = async (params, extra) => { return this._client!.request( { method: "tools/call", params }, - CallToolResultSchema, - { signal: extra.signal }, + { signal: extra.mcpReq.signal }, ); }; if (serverCapabilities.tools.listChanged) { this._client.setNotificationHandler( - ToolListChangedNotificationSchema, + "notifications/tools/list_changed", (n) => this.sendToolListChanged(n.params), ); } @@ -1500,27 +2030,24 @@ export class AppBridge extends Protocol< this.onlistresources = async (params, extra) => { return this._client!.request( { method: "resources/list", params }, - ListResourcesResultSchema, - { signal: extra.signal }, + { signal: extra.mcpReq.signal }, ); }; this.onlistresourcetemplates = async (params, extra) => { return this._client!.request( { method: "resources/templates/list", params }, - ListResourceTemplatesResultSchema, - { signal: extra.signal }, + { signal: extra.mcpReq.signal }, ); }; this.onreadresource = async (params, extra) => { return this._client!.request( { method: "resources/read", params }, - ReadResourceResultSchema, - { signal: extra.signal }, + { signal: extra.mcpReq.signal }, ); }; if (serverCapabilities.resources.listChanged) { this._client.setNotificationHandler( - ResourceListChangedNotificationSchema, + "notifications/resources/list_changed", (n) => this.sendResourceListChanged(n.params), ); } @@ -1529,23 +2056,21 @@ export class AppBridge extends Protocol< this.onlistprompts = async (params, extra) => { return this._client!.request( { method: "prompts/list", params }, - ListPromptsResultSchema, - { signal: extra.signal }, + { signal: extra.mcpReq.signal }, ); }; if (serverCapabilities.prompts.listChanged) { this._client.setNotificationHandler( - PromptListChangedNotificationSchema, + "notifications/prompts/list_changed", (n) => this.sendPromptListChanged(n.params), ); } } } - // MCP-UI specific handlers are registered by the host component - // after the proxy is created. The standard MCP initialization - // (via oninitialized callback set in constructor) handles the ready signal. - + // Protocol.connect only wires the transport β€” no MCP handshake happens on + // the iframe channel. The View drives ui/initialize; + // ui/notifications/initialized remains the public View-ready signal. return super.connect(transport); } } diff --git a/src/app.examples.ts b/src/app.examples.ts index 1d12c5b..7d475ef 100644 --- a/src/app.examples.ts +++ b/src/app.examples.ts @@ -7,11 +7,8 @@ * @module */ -import type { Tool } from "@modelcontextprotocol/sdk/types.js"; -import type { - McpServer, - ToolCallback, -} from "@modelcontextprotocol/sdk/server/mcp.js"; +import type { SamplingMessage, Tool } from "@modelcontextprotocol/client"; +import type { McpServer, ToolCallback } from "@modelcontextprotocol/server"; import { App, PostMessageTransport, @@ -303,7 +300,23 @@ function App_onlisttools_returnTools(app: App) { //#region App_onlisttools_returnTools app.onlisttools = async (params, extra) => { return { - tools: ["greet", "calculate", "format"], + tools: [ + { + name: "greet", + description: "Greet the user", + inputSchema: { type: "object" as const }, + }, + { + name: "calculate", + description: "Perform a calculation", + inputSchema: { type: "object" as const }, + }, + { + name: "format", + description: "Format text", + inputSchema: { type: "object" as const }, + }, + ], }; }; //#endregion App_onlisttools_returnTools @@ -330,6 +343,54 @@ async function App_callServerTool_fetchWeather(app: App) { //#endregion App_callServerTool_fetchWeather } +/** + * Example: Simple LLM completion via host sampling. + */ +async function App_createSamplingMessage_simple(app: App) { + //#region App_createSamplingMessage_simple + const result = await app.createSamplingMessage({ + messages: [ + { + role: "user", + content: { type: "text", text: "Summarize this in one line." }, + }, + ], + maxTokens: 100, + }); + console.log(result.content); + //#endregion App_createSamplingMessage_simple +} + +/** + * Example: Agentic loop with tools (requires host sampling.tools capability). + */ +async function App_createSamplingMessage_withTools( + app: App, + messages: SamplingMessage[], +) { + //#region App_createSamplingMessage_withTools + if (!app.getHostCapabilities()?.sampling?.tools) return; + + const result = await app.createSamplingMessage({ + messages, + maxTokens: 1024, + tools: [ + { + name: "get_weather", + description: "Get the current weather", + inputSchema: { + type: "object", + properties: { city: { type: "string" } }, + }, + }, + ], + }); + if (result.stopReason === "toolUse") { + // result.content may be an array containing tool_use blocks + } + //#endregion App_createSamplingMessage_withTools +} + /** * Example: Read a video resource and play it. */ diff --git a/src/app.test.ts b/src/app.test.ts new file mode 100644 index 0000000..8420e81 --- /dev/null +++ b/src/app.test.ts @@ -0,0 +1,381 @@ +import { afterEach, describe, expect, it } from "bun:test"; +import { + InMemoryTransport, + Server, + type JSONRPCMessage, +} from "@modelcontextprotocol/server"; +import { z } from "zod/v4"; + +import { App } from "./app.js"; +import { + LATEST_PROTOCOL_VERSION, + McpUiInitializeRequestSchema, + McpUiInitializeResultSchema, + McpUiInitializedNotificationSchema, +} from "./types.js"; + +type ConnectedPair = { + app: App; + server: Server; + sentByApp: JSONRPCMessage[]; + appsInitialized: Promise; +}; + +async function connectPair( + app = new App( + { name: "view-app", version: "1.0.0" }, + { tools: { listChanged: true } }, + { autoResize: false }, + ), +): Promise { + const server = new Server( + { name: "inner-mcp-server", version: "0.0.0" }, + { + capabilities: { resources: {}, tools: {} }, + }, + ); + const [appTransport, serverTransport] = InMemoryTransport.createLinkedPair(); + const sentByApp: JSONRPCMessage[] = []; + const send = appTransport.send.bind(appTransport); + appTransport.send = async (message, options) => { + sentByApp.push(message); + await send(message, options); + }; + + let resolveAppsInitialized!: () => void; + const appsInitialized = new Promise((resolve) => { + resolveAppsInitialized = resolve; + }); + + server.setRequestHandler( + "ui/initialize", + { + params: McpUiInitializeRequestSchema.shape.params, + result: McpUiInitializeResultSchema, + }, + (params) => { + expect(params.protocolVersion).toBe(LATEST_PROTOCOL_VERSION); + return { + protocolVersion: LATEST_PROTOCOL_VERSION, + hostCapabilities: { openLinks: {} }, + hostInfo: { name: "apps-host", version: "2.0.0" }, + hostContext: { theme: "dark" as const, locale: "en-US" }, + }; + }, + ); + server.setNotificationHandler( + "ui/notifications/initialized", + { params: McpUiInitializedNotificationSchema.shape.params }, + () => resolveAppsInitialized(), + ); + server.setRequestHandler("tools/call", (request) => ({ + content: [{ type: "text", text: `called ${request.params.name}` }], + })); + server.setRequestHandler("resources/read", (request) => ({ + contents: [{ uri: request.params.uri, text: "resource body" }], + })); + server.setRequestHandler("resources/list", () => ({ + resources: [{ uri: "test://resource", name: "Test resource" }], + })); + server.setRequestHandler("sampling/createMessage", () => ({ + model: "test-model", + role: "assistant", + content: { type: "text", text: "sampled" }, + })); + + await server.connect(serverTransport); + await app.connect(appTransport); + await appsInitialized; + + return { app, server, sentByApp, appsInitialized }; +} + +const connected: Array> = []; + +afterEach(async () => { + await Promise.all( + connected + .splice(0) + .flatMap(({ app, server }) => [app.close(), server.close()]), + ); +}); + +describe("App base MCP SDK v2 Protocol migration", () => { + it("performs only the Apps handshake β€” no MCP initialize on the wire", async () => { + const pair = await connectPair(); + connected.push(pair); + + const lifecycleMethods = pair.sentByApp + .filter( + (message): message is JSONRPCMessage & { method: string } => + "method" in message, + ) + .map((message) => message.method) + .filter((method) => + [ + "initialize", + "notifications/initialized", + "ui/initialize", + "ui/notifications/initialized", + ].includes(method), + ); + + // The filter above includes the core MCP lifecycle methods, so this + // equality also proves no `initialize`/`notifications/initialized` was sent + // β€” the wire contract deployed v1 hosts depend on. + expect(lifecycleMethods).toEqual([ + "ui/initialize", + "ui/notifications/initialized", + ]); + }); + + it("uses ui/initialize as the authority for Apps host state", async () => { + const pair = await connectPair(); + connected.push(pair); + + expect(pair.app.getHostVersion()).toEqual({ + name: "apps-host", + version: "2.0.0", + }); + expect(pair.app.getHostCapabilities()).toEqual({ openLinks: {} }); + expect(pair.app.getHostContext()).toEqual({ + theme: "dark", + locale: "en-US", + }); + }); + + it("preserves registered App tools with the base MCP SDK v2 Client handler context", async () => { + const pair = await connectPair(); + connected.push(pair); + let receivedSignal: AbortSignal | undefined; + + pair.app.registerTool( + "greet", + { description: "Greets a person" }, + async (extra) => { + receivedSignal = extra.mcpReq.signal; + return { content: [{ type: "text", text: "hello" }] }; + }, + ); + + const listed = await pair.server.request({ + method: "tools/list", + params: {}, + }); + const result = await pair.server.request({ + method: "tools/call", + params: { name: "greet", arguments: {} }, + }); + + expect(listed.tools.map((tool) => tool.name)).toEqual(["greet"]); + expect(result.content).toEqual([{ type: "text", text: "hello" }]); + expect(receivedSignal).toBeInstanceOf(AbortSignal); + }); + + it("uses base MCP SDK v2 method-keyed sends for standard MCP requests", async () => { + const pair = await connectPair(); + connected.push(pair); + + const toolResult = await pair.app.callServerTool({ + name: "refresh", + arguments: {}, + }); + const resource = await pair.app.readServerResource({ + uri: "test://resource", + }); + const resources = await pair.app.listServerResources(); + const sample = await pair.app.createSamplingMessage({ + messages: [{ role: "user", content: { type: "text", text: "hello" } }], + maxTokens: 20, + }); + + expect(toolResult.content).toEqual([ + { type: "text", text: "called refresh" }, + ]); + expect(resource.contents[0]).toEqual({ + uri: "test://resource", + text: "resource body", + }); + expect(resources.resources.map(({ uri }) => uri)).toEqual([ + "test://resource", + ]); + expect(sample.content).toEqual({ type: "text", text: "sampled" }); + }); + + it("preserves reconnect behavior after close", async () => { + const first = await connectPair(); + await first.app.close(); + await first.server.close(); + + const second = await connectPair(first.app); + connected.push(second); + + expect(second.app.getHostVersion()).toEqual({ + name: "apps-host", + version: "2.0.0", + }); + }); + + it("preserves auto-resize setup after Apps initialization", async () => { + const app = new App( + { name: "view-app", version: "1.0.0" }, + {}, + { autoResize: true }, + ); + let setupCalls = 0; + app.setupSizeChangedNotifications = () => { + setupCalls += 1; + return () => {}; + }; + + const pair = await connectPair(app); + connected.push(pair); + + expect(setupCalls).toBe(1); + }); + + it("preserves strict late-handler timing errors", async () => { + const app = new App( + { name: "view-app", version: "1.0.0" }, + {}, + { autoResize: false, strict: true }, + ); + const pair = await connectPair(app); + connected.push(pair); + + expect(() => { + app.ontoolinput = () => {}; + }).toThrow(/handler registered after connect/); + }); + + it("direct setRequestHandler throws when a handler is already registered", async () => { + const pair = await connectPair(); + connected.push(pair); + const params = z.object({}); + let handledBy = 0; + + pair.app.setRequestHandler("test/method", { params }, () => { + handledBy = 1; + return {}; + }); + expect(() => { + pair.app.setRequestHandler("test/method", { params }, () => { + handledBy = 2; + return {}; + }); + }).toThrow(/already registered/); + + await pair.server.request( + { method: "test/method", params: {} }, + z.object({}), + ); + expect(handledBy).toBe(1); + }); + + it("direct setRequestHandler throws for methods owned by the App itself", async () => { + const pair = await connectPair(); + connected.push(pair); + expect(() => { + pair.app.setRequestHandler("ping", () => ({})); + }).toThrow(/already registered/); + }); + + it("removeRequestHandler releases the method for re-registration", async () => { + const pair = await connectPair(); + connected.push(pair); + const params = z.object({}); + let handledBy = 0; + + pair.app.setRequestHandler("test/method", { params }, () => { + handledBy = 1; + return {}; + }); + pair.app.removeRequestHandler("test/method"); + pair.app.setRequestHandler("test/method", { params }, () => { + handledBy = 2; + return {}; + }); + + await pair.server.request( + { method: "test/method", params: {} }, + z.object({}), + ); + expect(handledBy).toBe(2); + }); + + it("direct setNotificationHandler throws when a handler is already registered", async () => { + const pair = await connectPair(); + connected.push(pair); + const calls: number[] = []; + const params = z.object({}); + + pair.app.setNotificationHandler("test/notification", { params }, () => { + calls.push(1); + }); + expect(() => { + pair.app.setNotificationHandler("test/notification", { params }, () => { + calls.push(2); + }); + }).toThrow(/already registered/); + await pair.server.notification({ + method: "test/notification", + params: {}, + }); + + expect(calls).toEqual([1]); + }); + + it("direct setNotificationHandler throws for event-mapped methods (listener first)", () => { + const app = new App( + { name: "view-app", version: "1.0.0" }, + {}, + { autoResize: false }, + ); + app.addEventListener("toolinput", () => {}); + expect(() => { + app.setNotificationHandler( + "ui/notifications/tool-input", + { params: z.object({}) }, + () => {}, + ); + }).toThrow(/already registered/); + }); + + it("event registration throws when a direct handler already owns the method", () => { + const app = new App( + { name: "view-app", version: "1.0.0" }, + {}, + { autoResize: false }, + ); + app.setNotificationHandler( + "ui/notifications/tool-input", + { params: z.object({}) }, + () => {}, + ); + expect(() => { + app.ontoolinput = () => {}; + }).toThrow(/already registered/); + expect(() => { + app.addEventListener("toolinput", () => {}); + }).toThrow(/already registered/); + }); + + it("on* request setters keep replace semantics", async () => { + const pair = await connectPair(); + connected.push(pair); + let handledBy = 0; + pair.app.onteardown = async () => { + handledBy = 1; + return {}; + }; + pair.app.onteardown = async () => { + handledBy = 2; + return {}; + }; + await pair.server.request( + { method: "ui/resource-teardown", params: {} }, + z.object({}), + ); + expect(handledBy).toBe(2); + }); +}); diff --git a/src/app.ts b/src/app.ts index 92db481..89c6c35 100644 --- a/src/app.ts +++ b/src/app.ts @@ -1,29 +1,45 @@ import { - type RequestOptions, Protocol, - ProtocolOptions, -} from "@modelcontextprotocol/sdk/shared/protocol.js"; - + type BaseContext, + type ProtocolOptions, + type RequestOptions, + type CallToolRequest, + type CallToolResult, + type CreateMessageRequest, + type CreateMessageResult, + type CreateMessageResultWithTools, + type Implementation, + type ListResourcesRequest, + type ListResourcesResult, + type ListToolsRequest, + type ListToolsResult, + type LoggingMessageNotification, + type ReadResourceRequest, + type ReadResourceResult, + type Tool, + type ToolAnnotations, + type ToolListChangedNotification, + type Transport, +} from "@modelcontextprotocol/client"; +import { EmptyResultSchema } from "@modelcontextprotocol/core"; +export { RESOURCE_MIME_TYPE, RESOURCE_URI_META_KEY } from "./constants.js"; +import { EventDispatcher, MethodRegistry } from "./events.js"; import { - CallToolRequest, - CallToolRequestSchema, - CallToolResult, - CallToolResultSchema, - EmptyResultSchema, - Implementation, - ListResourcesRequest, - ListResourcesResult, - ListResourcesResultSchema, - ListToolsRequest, - ListToolsRequestSchema, - LoggingMessageNotification, - PingRequestSchema, - ReadResourceRequest, - ReadResourceResult, - ReadResourceResultSchema, -} from "@modelcontextprotocol/sdk/types.js"; -import { AppNotification, AppRequest, AppResult } from "./types"; -import { PostMessageTransport } from "./message-transport"; + toModernArgs, + type LegacyNotificationHandlerSetter, + type LegacyRequestHandlerSetter, +} from "./legacy-handlers.js"; +export type { + LegacyMethodSchema, + LegacyNotificationHandler, + LegacyNotificationHandlerSetter, + LegacyRequestHandler, + LegacyRequestHandlerExtra, + LegacyRequestHandlerSetter, +} from "./legacy-handlers.js"; +export { EventDispatcher } from "./events.js"; + +import { PostMessageTransport } from "./message-transport.js"; import { LATEST_PROTOCOL_VERSION, McpUiAppCapabilities, @@ -44,6 +60,8 @@ import { McpUiResourceTeardownRequest, McpUiResourceTeardownRequestSchema, McpUiResourceTeardownResult, + McpUiResourceTeardownResultSchema, + McpUiRequestTeardownNotification, McpUiSizeChangedNotification, McpUiToolCancelledNotification, McpUiToolCancelledNotificationSchema, @@ -55,93 +73,60 @@ import { McpUiToolResultNotificationSchema, McpUiRequestDisplayModeRequest, McpUiRequestDisplayModeResultSchema, -} from "./types"; -import { Transport } from "@modelcontextprotocol/sdk/shared/transport.js"; +} from "./types.js"; +import { + StandardSchemaV1, + standardSchemaToJsonSchema, + validateStandardSchema, +} from "./standard-schema.js"; +import { z, type ZodLiteral, type ZodObject, type ZodType } from "zod/v4"; -export { PostMessageTransport } from "./message-transport"; -export * from "./types"; +type UntypedHandlerSetter = (this: unknown, ...args: unknown[]) => void; + +type MethodSchema = ZodObject<{ + method: ZodLiteral; + params: ZodType; +}>; + +function mergeAppCapabilities( + base: McpUiAppCapabilities, + additional: McpUiAppCapabilities, +): McpUiAppCapabilities { + const result = { ...base, ...additional }; + if (additional.experimental !== undefined) { + result.experimental = { + ...base.experimental, + ...additional.experimental, + }; + } + if (additional.tools !== undefined) { + result.tools = { ...base.tools, ...additional.tools }; + } + return result; +} + +export type { + StandardSchemaV1, + StandardSchemaWithJSON, +} from "./standard-schema.js"; + +export { PostMessageTransport } from "./message-transport.js"; +export * from "./types.js"; export { applyHostStyleVariables, applyHostFonts, getDocumentTheme, applyDocumentTheme, -} from "./styles"; - -/** - * Metadata key for associating a UI resource URI with a tool. - * - * MCP servers include this key in tool definition metadata (via `tools/list`) - * to indicate which UI resource should be displayed when the tool is called. - * When hosts see a tool with this metadata, they fetch and render the - * corresponding {@link App `App`}. - * - * **Note**: This constant is provided for reference and backwards compatibility. - * Server developers should use {@link server-helpers!registerAppTool `registerAppTool`} - * with the `_meta.ui.resourceUri` format instead. Host developers must check both - * formats for compatibility. - * - * @example Modern format (server-side, not in Apps) - * ```ts source="./app.examples.ts#RESOURCE_URI_META_KEY_modernFormat" - * // Preferred: Use registerAppTool with nested ui.resourceUri - * registerAppTool( - * server, - * "weather", - * { - * description: "Get weather forecast", - * _meta: { - * ui: { resourceUri: "ui://weather/forecast" }, - * }, - * }, - * handler, - * ); - * ``` - * - * @example Legacy format (deprecated, for backwards compatibility) - * ```ts source="./app.examples.ts#RESOURCE_URI_META_KEY_legacyFormat" - * // Deprecated: Direct use of RESOURCE_URI_META_KEY - * server.registerTool( - * "weather", - * { - * description: "Get weather forecast", - * _meta: { - * [RESOURCE_URI_META_KEY]: "ui://weather/forecast", - * }, - * }, - * handler, - * ); - * ``` - * - * @example How hosts check for this metadata (must support both formats) - * ```ts source="./app.examples.ts#RESOURCE_URI_META_KEY_hostSide" - * // Hosts should check both modern and legacy formats - * const meta = tool._meta; - * const uiMeta = meta?.ui as McpUiToolMeta | undefined; - * const legacyUri = meta?.[RESOURCE_URI_META_KEY] as string | undefined; - * const uiUri = uiMeta?.resourceUri ?? legacyUri; - * if (typeof uiUri === "string" && uiUri.startsWith("ui://")) { - * // Fetch the resource and display the UI - * } - * ``` - */ -export const RESOURCE_URI_META_KEY = "ui/resourceUri"; - -/** - * MIME type for MCP UI resources. - * - * Identifies HTML content as an MCP App UI resource. - * - * Used by {@link server-helpers!registerAppResource `registerAppResource`} as the default MIME type for app resources. - */ -export const RESOURCE_MIME_TYPE = "text/html;profile=mcp-app"; +} from "./styles.js"; /** * Options for configuring {@link App `App`} behavior. * - * Extends `ProtocolOptions` from the MCP SDK with `App`-specific configuration. + * Extends `ProtocolOptions` from the base MCP SDK with `App`-specific configuration. * - * @see `ProtocolOptions` from @modelcontextprotocol/sdk for inherited options + * @see `ProtocolOptions` from @modelcontextprotocol/client for inherited options */ -type AppOptions = ProtocolOptions & { +export type AppOptions = Omit & { /** * Automatically report size changes to the host using `ResizeObserver`. * @@ -152,19 +137,119 @@ type AppOptions = ProtocolOptions & { * @default true */ autoResize?: boolean; + /** + * Throw on detected misuse instead of logging a console warning. + * + * Currently this affects calling host-bound methods (e.g. + * {@link App.callServerTool `callServerTool`}, {@link App.sendMessage `sendMessage`}) + * before {@link App.connect `connect`} has completed the `ui/initialize` + * handshake. With `strict: false` (default) a `console.warn` is emitted; + * with `strict: true` an `Error` is thrown. + * + * @remarks Throwing will become the default in a future release. + * @default false + */ + strict?: boolean; + /** + * Allow code paths that require CSP `unsafe-eval` (e.g. `new Function()`). + * + * Views typically run under a strict CSP without `unsafe-eval`. Zod's JIT + * object parser uses `new Function()` and throws on the first message parse + * under such a policy. By default (`allowUnsafeEval: false`) the + * {@link App `App`} constructor sets `z.config({ jitless: true })` so the + * SDK works out of the box under the spec's default CSP. Set + * `allowUnsafeEval: true` to skip that and keep the faster JIT path when + * the host's CSP permits `unsafe-eval`. + * + * @default false + */ + allowUnsafeEval?: boolean; }; -type RequestHandlerExtra = Parameters< - Parameters[1] ->[1]; +type RequestHandlerExtra = BaseContext; + +/** + * Result of an app-registered tool callback. When `Out` is provided, + * `structuredContent` is required and typed (unless `isError: true`). + */ +export type AppToolResult< + Out extends StandardSchemaV1 | undefined = undefined, +> = Out extends StandardSchemaV1 + ? + | (CallToolResult & { + structuredContent: StandardSchemaV1.InferOutput; + isError?: false; + }) + | (CallToolResult & { isError: true }) + : CallToolResult; + +/** + * Callback for an app-registered tool. When `In` is provided, `args` is the + * validated/parsed input; when `In` is `undefined`, the callback receives only + * `extra`. When `Out` is provided, the return's `structuredContent` is typed. + * + * Mirrors `ToolCallback` from `@modelcontextprotocol/server` but is + * parameterized over {@link StandardSchemaV1} instead of zod, so any + * Standard-Schema-compatible library (Zod, ArkType, Valibot, …) can be used. + */ +export type AppToolCallback< + In extends StandardSchemaV1 | undefined = undefined, + Out extends StandardSchemaV1 | undefined = undefined, +> = In extends StandardSchemaV1 + ? ( + args: StandardSchemaV1.InferOutput, + extra: RequestHandlerExtra, + ) => AppToolResult | Promise> + : ( + extra: RequestHandlerExtra, + ) => AppToolResult | Promise>; + +/** + * Handle returned by {@link App.registerTool}. Mirrors `RegisteredTool` from + * `@modelcontextprotocol/server` but stores + * {@link StandardSchemaV1} schemas. + */ +export type RegisteredAppTool = { + title?: string; + description?: string; + inputSchema?: StandardSchemaV1; + outputSchema?: StandardSchemaV1; + annotations?: ToolAnnotations; + _meta?: Record; + enabled: boolean; + enable(): void; + disable(): void; + remove(): void; + update(updates: Partial>): void; + /** @internal */ + handler: ( + args: unknown, + extra: RequestHandlerExtra, + ) => Promise; +}; + +/** + * Maps DOM-style event names to their notification `params` types. + * + * Used by {@link App `App`} and its composed {@link EventDispatcher} to + * provide type-safe `addEventListener` / `removeEventListener` and singular + * `on*` handler support. + */ +export type AppEventMap = { + toolinput: McpUiToolInputNotification["params"]; + toolinputpartial: McpUiToolInputPartialNotification["params"]; + toolresult: McpUiToolResultNotification["params"]; + toolcancelled: McpUiToolCancelledNotification["params"]; + hostcontextchanged: McpUiHostContextChangedNotification["params"]; +}; /** * Main class for MCP Apps to communicate with their host. * * The `App` class provides a framework-agnostic way to build interactive MCP Apps - * that run inside host applications. It extends the MCP SDK's `Protocol` class and - * handles the connection lifecycle, initialization handshake, and bidirectional - * communication with the host. + * that run inside host applications. It extends the base MCP SDK's public + * `Protocol` class, composes an {@link EventDispatcher}, and adds the Apps + * handshake, lifecycle, and high-level APIs. * * ## Architecture * @@ -177,28 +262,30 @@ type RequestHandlerExtra = Parameters< * 1. **Create**: Instantiate App with info and capabilities * 2. **Connect**: Call `connect()` to establish transport and perform handshake * 3. **Interactive**: Send requests, receive notifications, call tools - * 4. **Cleanup**: Host sends teardown request before unmounting + * 4. **Teardown**: Host sends teardown request before unmounting * - * ## Inherited Methods + * ## Protocol and event methods * - * As a subclass of `Protocol`, `App` inherits key methods for handling communication: + * From the base MCP SDK's `Protocol`, `App` provides: * - `setRequestHandler()` - Register handlers for requests from host * - `setNotificationHandler()` - Register handlers for notifications from host * - * @see `Protocol` from @modelcontextprotocol/sdk for all inherited methods + * From its composed {@link EventDispatcher}, `App` also provides: + * - `addEventListener()` - Append a listener for a notification event (multi-listener) + * - `removeEventListener()` - Remove a previously added listener * - * ## Notification Setters + * ## Notification Setters (DOM-model `on*` handlers) * - * For common notifications, the `App` class provides convenient setter properties - * that simplify handler registration: + * For common notifications, the `App` class provides getter/setter properties + * that follow DOM-model replace semantics (like `el.onclick`): * - `ontoolinput` - Complete tool arguments from host * - `ontoolinputpartial` - Streaming partial tool arguments * - `ontoolresult` - Tool execution results * - `ontoolcancelled` - Tool execution was cancelled by user or host * - `onhostcontextchanged` - Host context changes (theme, locale, etc.) * - * These setters are convenience wrappers around `setNotificationHandler()`. - * Both patterns work; use whichever fits your coding style better. + * Assigning replaces the previous handler; assigning `undefined` clears it. + * Use `addEventListener` to attach multiple listeners without replacing. * * @example Basic usage with PostMessageTransport * ```ts source="./app.examples.ts#App_basicUsage" @@ -215,16 +302,233 @@ type RequestHandlerExtra = Parameters< * await app.connect(); * ``` */ -export class App extends Protocol { +export class App extends Protocol { private _hostCapabilities?: McpUiHostCapabilities; private _hostInfo?: Implementation; private _hostContext?: McpUiHostContext; + private _registeredTools: { [name: string]: RegisteredAppTool } = {}; + private _initializedSent = false; + private readonly _registeredEvents = new Set(); + private readonly _events = new EventDispatcher(); + private readonly _methods = new MethodRegistry(); + + // ── Handler registration with double-set protection ───────────────── + // + // The base SDK `Protocol` silently replaces an existing handler. The four + // overrides below restore the v1 behaviour: a direct `setRequestHandler` / + // `setNotificationHandler` for a method that already has a handler throws, + // so a stray registration cannot silently disconnect `on*` handlers or + // `addEventListener` listeners. They are arrow-function class fields rather + // than prototype methods so that `Protocol`'s constructor β€” which registers + // its own ping/cancelled/progress handlers before our fields initialize β€” + // hits the base implementation and skips tracking. + + /** + * Registers a request handler. Throws if a handler for the same method has + * already been registered β€” use the `on*` setter for replace semantics. + * + * @throws {Error} if a handler for this method is already registered. + */ + override setRequestHandler: LegacyRequestHandlerSetter< + Protocol["setRequestHandler"] + > = (...args: unknown[]) => { + const [method, ...rest] = toModernArgs("request", args) ?? args; + this._methods.claim(method as string, "setRequestHandler"); + (super.setRequestHandler as unknown as UntypedHandlerSetter).call( + this, + method, + ...rest, + ); + }; + + /** + * Registers a notification handler. Throws if a handler for the same method + * has already been registered β€” use the `on*` setter (replace semantics) or + * `addEventListener` (multi-listener) for mapped events. + * + * @throws {Error} if a handler for this method is already registered. + */ + override setNotificationHandler: LegacyNotificationHandlerSetter< + Protocol["setNotificationHandler"] + > = (...args: unknown[]) => { + const [method, ...rest] = toModernArgs("notification", args) ?? args; + this._methods.claim(method as string, "setNotificationHandler"); + (super.setNotificationHandler as unknown as UntypedHandlerSetter).call( + this, + method, + ...rest, + ); + }; + + override removeRequestHandler: Protocol["removeRequestHandler"] = + (method: string) => { + this._methods.release(method); + super.removeRequestHandler(method); + }; + + override removeNotificationHandler: Protocol["removeNotificationHandler"] = + (method: string) => { + this._methods.release(method); + super.removeNotificationHandler(method); + }; + + /** + * Register a request handler with replace semantics, bypassing the + * double-set protection of {@link setRequestHandler `setRequestHandler`}. + * Used by the `on*` request-handler setters. + */ + protected replaceRequestHandler: Protocol["setRequestHandler"] = + (method: string, ...rest: unknown[]) => { + this._methods.replace(method); + (super.setRequestHandler as unknown as UntypedHandlerSetter).call( + this, + method, + ...rest, + ); + }; + + /** + * Warn if a host-bound method is called before {@link connect `connect`} has + * completed the `ui/initialize` β†’ `ui/notifications/initialized` handshake. + * + * Calling these methods early can race the handshake on strict hosts and + * leave the iframe permanently hidden. See + * {@link https://github.com/anthropics/claude-ai-mcp/issues/61 claude-ai-mcp#61} / + * {@link https://github.com/anthropics/claude-ai-mcp/issues/149 #149}. + * + * @remarks This will become a thrown `Error` in a future minor release. + */ + private _assertInitialized(method: string): void { + if (this._initializedSent) return; + const msg = + `[ext-apps] App.${method}() called before connect() completed the ` + + `ui/initialize handshake. Await app.connect() before calling this ` + + `method, or move data loading to an ontoolresult handler.`; + if (this.options?.strict) { + throw new Error(msg); + } + // TODO(next-minor): make `strict: true` the default. + console.warn(`${msg}. This will throw in a future release.`); + } + + private readonly eventSchemas: { + [K in keyof AppEventMap]: MethodSchema; + } = { + toolinput: McpUiToolInputNotificationSchema, + toolinputpartial: McpUiToolInputPartialNotificationSchema, + toolresult: McpUiToolResultNotificationSchema, + toolcancelled: McpUiToolCancelledNotificationSchema, + hostcontextchanged: McpUiHostContextChangedNotificationSchema, + }; + + /** + * Events the host typically sends once, shortly after the handshake. + * Registering a handler for one of these *after* {@link connect `connect`} + * resolves risks missing the notification entirely. + */ + private static readonly ONE_SHOT_EVENTS: ReadonlySet = + new Set(["toolinput", "toolinputpartial", "toolresult", "toolcancelled"]); + + /** + * One-shot events that have had at least one handler registered (via `on*` + * setter or `addEventListener`) at any point. Once an event is in this set, + * subsequent late registrations are not flagged β€” only the *first* handler + * matters for the missed-notification race, and re-registration (e.g. React + * `useEffect` cleanup β†’ re-add on dep change) is a legitimate pattern. + */ + private readonly _everHadListener = new Set(); + + /** + * Warn (or throw under `strict`) when the *first* handler for a one-shot + * event is registered after the `ui/initialize` β†’ `ui/notifications/initialized` + * handshake has completed. The host may have already fired the notification + * by then. Subsequent registrations for the same event are not flagged. + * + * Mirrors {@link _assertInitialized `_assertInitialized`} (the outbound-side guard). + */ + private _assertHandlerTiming(event: keyof AppEventMap): void { + if (!App.ONE_SHOT_EVENTS.has(event) || this._everHadListener.has(event)) { + return; + } + this._everHadListener.add(event); + if (!this._initializedSent) return; + const msg = + `[ext-apps] "${String(event)}" handler registered after connect() ` + + `completed the ui/initialize handshake. The host may have already sent ` + + `this notification. Register handlers before calling app.connect().`; + if (this.options?.strict) { + throw new Error(msg); + } + console.warn(msg); + } + + protected setEventHandler( + event: K, + handler: ((params: AppEventMap[K]) => void) | undefined, + ): void { + if (handler) this._assertHandlerTiming(event); + this._ensureEventSlot(event); + this._events.setHandler(event, handler); + } + + addEventListener( + event: K, + handler: (params: AppEventMap[K]) => void, + ): void { + this._assertHandlerTiming(event); + this._ensureEventSlot(event); + this._events.addEventListener(event, handler); + } + + removeEventListener( + event: K, + handler: (params: AppEventMap[K]) => void, + ): void { + this._events.removeEventListener(event, handler); + } + + private _ensureEventSlot(event: K): void { + if (this._registeredEvents.has(event)) return; + const schema = this.eventSchemas[event]; + if (!schema) throw new Error(`Unknown event: ${String(event)}`); + this.setNotificationHandler( + schema.shape.method.value, + { params: schema.shape.params }, + (params) => { + const eventParams = params as AppEventMap[K]; + if (event === "hostcontextchanged") { + this._hostContext = { ...this._hostContext, ...eventParams }; + } + this._events.dispatch(event, eventParams); + }, + ); + this._registeredEvents.add(event); + } + + protected getEventHandler( + event: K, + ): ((params: AppEventMap[K]) => void) | undefined { + return this._events.getHandler(event); + } + + protected warnIfRequestHandlerReplaced( + name: string, + previous: unknown, + next: unknown, + ): void { + if (previous && next) { + console.warn( + `[MCP Apps] ${name} handler replaced. ` + + `Previous handler will no longer be called.`, + ); + } + } /** * Create a new MCP App instance. * * @param _appInfo - App identification (name and version) - * @param _capabilities - Features and capabilities this app provides + * @param _appCapabilities - Features and capabilities this app provides * @param options - Configuration options including `autoResize` behavior * * @example @@ -238,19 +542,206 @@ export class App extends Protocol { */ constructor( private _appInfo: Implementation, - private _capabilities: McpUiAppCapabilities = {}, + private _appCapabilities: McpUiAppCapabilities = {}, private options: AppOptions = { autoResize: true }, ) { super(options); + // Claim the handlers the base Protocol constructor installed so a direct + // setNotificationHandler cannot silently replace them either. + this._methods.replace("notifications/cancelled"); + this._methods.replace("notifications/progress"); - this.setRequestHandler(PingRequestSchema, (request) => { + if (!options.allowUnsafeEval) { + z.config({ jitless: true }); + } + + this.replaceRequestHandler("ping", (request) => { console.log("Received ping:", request.params); return {}; }); - // Set up default handler to update _hostContext when notifications arrive. - // Users can override this by setting onhostcontextchanged. - this.onhostcontextchanged = () => {}; + // Eagerly register hostcontextchanged so the owner-side context merge runs + // even if the user never assigns a handler or adds a listener. + this.setEventHandler("hostcontextchanged", undefined); + } + + /** @internal */ + protected buildContext(ctx: BaseContext): BaseContext { + return ctx; + } + + private registerAppCapabilities(capabilities: McpUiAppCapabilities): void { + if (this.transport) { + throw new Error( + "Cannot register capabilities after transport is established", + ); + } + this._appCapabilities = mergeAppCapabilities( + this._appCapabilities, + capabilities, + ); + } + + registerTool< + OutputArgs extends undefined | StandardSchemaV1 = undefined, + InputArgs extends undefined | StandardSchemaV1 = undefined, + >( + name: string, + config: { + title?: string; + description?: string; + inputSchema?: InputArgs; + outputSchema?: OutputArgs; + annotations?: ToolAnnotations; + _meta?: Record; + }, + cb: AppToolCallback, + ): RegisteredAppTool { + if (this._registeredTools[name]) { + throw new Error(`Tool ${name} is already registered`); + } + const app = this; + const notify = () => { + if (app._initializedSent && app._appCapabilities.tools?.listChanged) { + void app.sendToolListChanged(); + } + }; + // Arity is fixed at registration time even if inputSchema is later + // update()d, since cb's signature can't change. + const cbTakesArgs = config.inputSchema !== undefined; + const registeredTool: RegisteredAppTool = { + title: config.title, + description: config.description, + inputSchema: config.inputSchema, + outputSchema: config.outputSchema, + annotations: config.annotations, + _meta: config._meta, + enabled: true, + enable(): void { + this.enabled = true; + notify(); + }, + disable(): void { + this.enabled = false; + notify(); + }, + update(updates) { + Object.assign(this, updates); + notify(); + }, + remove() { + if (app._registeredTools[name] !== registeredTool) return; + delete app._registeredTools[name]; + notify(); + }, + handler: async (rawArgs, extra) => { + if (!registeredTool.enabled) { + throw new Error(`Tool ${name} is disabled`); + } + let result: CallToolResult; + if (cbTakesArgs) { + const schema = registeredTool.inputSchema; + const parsedArgs = schema + ? await validateStandardSchema( + schema, + rawArgs ?? {}, + `Invalid input for tool ${name}: `, + ) + : (rawArgs ?? {}); + result = await ( + cb as AppToolCallback + )(parsedArgs, extra); + } else { + result = await (cb as AppToolCallback)( + extra, + ); + } + if (registeredTool.outputSchema && !result.isError) { + result.structuredContent = (await validateStandardSchema( + registeredTool.outputSchema, + result.structuredContent, + `Invalid output for tool ${name}: `, + )) as CallToolResult["structuredContent"]; + } + return result; + }, + }; + + this._registeredTools[name] = registeredTool; + + // Auto-register tools capability so setRequestHandler's capability check + // passes. Mirrors McpServer.registerTool behavior β€” callers shouldn't need + // to declare { tools: {} } in the constructor just to use registerTool. + // Only do this pre-connect; post-connect the capability was already + // advertised (or wasn't) and can't change. + if (!this._appCapabilities.tools && !this.transport) { + this.registerAppCapabilities({ tools: { listChanged: true } }); + } + + this.ensureToolHandlersInitialized(); + notify(); + return registeredTool; + } + + private _toolHandlersInitialized = false; + private ensureToolHandlersInitialized(): void { + if (this._toolHandlersInitialized) { + return; + } + this._toolHandlersInitialized = true; + + this.oncalltool = async (params, extra) => { + const tool = this._registeredTools[params.name]; + if (!tool) { + throw new Error(`Tool ${params.name} not found`); + } + return tool.handler(params.arguments, extra); + }; + this.onlisttools = async (_params, _extra) => { + const tools: Tool[] = await Promise.all( + Object.entries(this._registeredTools) + .filter(([_, tool]) => tool.enabled) + .map(async ([name, tool]) => { + const result: Tool = { + name, + title: tool.title, + description: tool.description, + inputSchema: (tool.inputSchema + ? await standardSchemaToJsonSchema(tool.inputSchema, "input") + : { + type: "object" as const, + properties: {}, + }) as Tool["inputSchema"], + }; + // outputSchema is optional in core MCP β€” only emit when the app + // provided one, otherwise hosts would assume structuredContent. + if (tool.outputSchema) { + result.outputSchema = (await standardSchemaToJsonSchema( + tool.outputSchema, + "output", + )) as Tool["outputSchema"]; + } + if (tool.annotations) { + result.annotations = tool.annotations; + } + if (tool._meta) { + result._meta = tool._meta; + } + return result; + }), + ); + return { tools }; + }; + } + + async sendToolListChanged( + params: ToolListChangedNotification["params"] = {}, + ): Promise { + this._assertInitialized("sendToolListChanged"); + await this.notification({ + method: "notifications/tools/list_changed", + params, + }); } /** @@ -338,13 +829,12 @@ export class App extends Protocol { * sends a tool's complete arguments. This is sent after a tool call begins * and before the tool result is available. * - * This setter is a convenience wrapper around `setNotificationHandler()` that - * automatically handles the notification schema and extracts the params for you. + * Assigning replaces the previous handler; assigning `undefined` clears it. + * Use {@link addEventListener `addEventListener`} to attach multiple listeners + * without replacing. * * Register handlers before calling {@link connect `connect`} to avoid missing notifications. * - * @param callback - Function called with the tool input params ({@link McpUiToolInputNotification.params `McpUiToolInputNotification.params`}) - * * @example * ```ts source="./app.examples.ts#App_ontoolinput_setter" * // Register before connecting to ensure no notifications are missed @@ -355,15 +845,20 @@ export class App extends Protocol { * await app.connect(); * ``` * - * @see {@link setNotificationHandler `setNotificationHandler`} for the underlying method + * @deprecated Use {@link addEventListener `addEventListener("toolinput", handler)`} instead β€” it composes with other listeners and supports cleanup via {@link removeEventListener `removeEventListener`}. * @see {@link McpUiToolInputNotification `McpUiToolInputNotification`} for the notification structure */ + get ontoolinput(): + | ((params: McpUiToolInputNotification["params"]) => void) + | undefined { + return this.getEventHandler("toolinput"); + } set ontoolinput( - callback: (params: McpUiToolInputNotification["params"]) => void, + callback: + | ((params: McpUiToolInputNotification["params"]) => void) + | undefined, ) { - this.setNotificationHandler(McpUiToolInputNotificationSchema, (n) => - callback(n.params), - ); + this.setEventHandler("toolinput", callback); } /** @@ -378,13 +873,12 @@ export class App extends Protocol { * (e.g., the last item in an array may be truncated). Use partial data only * for preview UI, not for critical operations. * - * This setter is a convenience wrapper around `setNotificationHandler()` that - * automatically handles the notification schema and extracts the params for you. + * Assigning replaces the previous handler; assigning `undefined` clears it. + * Use {@link addEventListener `addEventListener`} to attach multiple listeners + * without replacing. * * Register handlers before calling {@link connect `connect`} to avoid missing notifications. * - * @param callback - Function called with each partial tool input update ({@link McpUiToolInputPartialNotification.params `McpUiToolInputPartialNotification.params`}) - * * @example Progressive rendering of tool arguments * ```ts source="./app.examples.ts#App_ontoolinputpartial_progressiveRendering" * const codePreview = document.querySelector("#code-preview")!; @@ -403,16 +897,21 @@ export class App extends Protocol { * }; * ``` * - * @see {@link setNotificationHandler `setNotificationHandler`} for the underlying method + * @deprecated Use {@link addEventListener `addEventListener("toolinputpartial", handler)`} instead β€” it composes with other listeners and supports cleanup via {@link removeEventListener `removeEventListener`}. * @see {@link McpUiToolInputPartialNotification `McpUiToolInputPartialNotification`} for the notification structure * @see {@link ontoolinput `ontoolinput`} for the complete tool input handler */ + get ontoolinputpartial(): + | ((params: McpUiToolInputPartialNotification["params"]) => void) + | undefined { + return this.getEventHandler("toolinputpartial"); + } set ontoolinputpartial( - callback: (params: McpUiToolInputPartialNotification["params"]) => void, + callback: + | ((params: McpUiToolInputPartialNotification["params"]) => void) + | undefined, ) { - this.setNotificationHandler(McpUiToolInputPartialNotificationSchema, (n) => - callback(n.params), - ); + this.setEventHandler("toolinputpartial", callback); } /** @@ -422,13 +921,12 @@ export class App extends Protocol { * sends the result of a tool execution. This is sent after the tool completes * on the MCP server, allowing your app to display the results or update its state. * - * This setter is a convenience wrapper around `setNotificationHandler()` that - * automatically handles the notification schema and extracts the params for you. + * Assigning replaces the previous handler; assigning `undefined` clears it. + * Use {@link addEventListener `addEventListener`} to attach multiple listeners + * without replacing. * * Register handlers before calling {@link connect `connect`} to avoid missing notifications. * - * @param callback - Function called with the tool result ({@link McpUiToolResultNotification.params `McpUiToolResultNotification.params`}) - * * @example Display tool execution results * ```ts source="./app.examples.ts#App_ontoolresult_displayResults" * app.ontoolresult = (params) => { @@ -440,16 +938,21 @@ export class App extends Protocol { * }; * ``` * - * @see {@link setNotificationHandler `setNotificationHandler`} for the underlying method + * @deprecated Use {@link addEventListener `addEventListener("toolresult", handler)`} instead β€” it composes with other listeners and supports cleanup via {@link removeEventListener `removeEventListener`}. * @see {@link McpUiToolResultNotification `McpUiToolResultNotification`} for the notification structure * @see {@link ontoolinput `ontoolinput`} for the initial tool input handler */ + get ontoolresult(): + | ((params: McpUiToolResultNotification["params"]) => void) + | undefined { + return this.getEventHandler("toolresult"); + } set ontoolresult( - callback: (params: McpUiToolResultNotification["params"]) => void, + callback: + | ((params: McpUiToolResultNotification["params"]) => void) + | undefined, ) { - this.setNotificationHandler(McpUiToolResultNotificationSchema, (n) => - callback(n.params), - ); + this.setEventHandler("toolresult", callback); } /** @@ -460,13 +963,12 @@ export class App extends Protocol { * including user action, sampling error, classifier intervention, or other * interruptions. Apps should update their state and display appropriate feedback. * - * This setter is a convenience wrapper around `setNotificationHandler()` that - * automatically handles the notification schema and extracts the params for you. + * Assigning replaces the previous handler; assigning `undefined` clears it. + * Use {@link addEventListener `addEventListener`} to attach multiple listeners + * without replacing. * * Register handlers before calling {@link connect `connect`} to avoid missing notifications. * - * @param callback - Function called when tool execution is cancelled. Receives optional cancellation reason β€” see {@link McpUiToolCancelledNotification.params `McpUiToolCancelledNotification.params`}. - * * @example Handle tool cancellation * ```ts source="./app.examples.ts#App_ontoolcancelled_handleCancellation" * app.ontoolcancelled = (params) => { @@ -475,16 +977,21 @@ export class App extends Protocol { * }; * ``` * - * @see {@link setNotificationHandler `setNotificationHandler`} for the underlying method + * @deprecated Use {@link addEventListener `addEventListener("toolcancelled", handler)`} instead β€” it composes with other listeners and supports cleanup via {@link removeEventListener `removeEventListener`}. * @see {@link McpUiToolCancelledNotification `McpUiToolCancelledNotification`} for the notification structure * @see {@link ontoolresult `ontoolresult`} for successful tool completion */ + get ontoolcancelled(): + | ((params: McpUiToolCancelledNotification["params"]) => void) + | undefined { + return this.getEventHandler("toolcancelled"); + } set ontoolcancelled( - callback: (params: McpUiToolCancelledNotification["params"]) => void, + callback: + | ((params: McpUiToolCancelledNotification["params"]) => void) + | undefined, ) { - this.setNotificationHandler(McpUiToolCancelledNotificationSchema, (n) => - callback(n.params), - ); + this.setEventHandler("toolcancelled", callback); } /** @@ -495,17 +1002,17 @@ export class App extends Protocol { * other environmental updates. Apps should respond by updating their UI * accordingly. * - * This setter is a convenience wrapper around `setNotificationHandler()` that - * automatically handles the notification schema and extracts the params for you. + * Assigning replaces the previous handler; assigning `undefined` clears it. + * Use {@link addEventListener `addEventListener`} to attach multiple listeners + * without replacing. * * Notification params are automatically merged into the internal host context - * before the callback is invoked. This means {@link getHostContext `getHostContext`} will - * return the updated values even before your callback runs. + * before any handler or listener fires. This means + * {@link getHostContext `getHostContext`} will return the updated values even + * before your callback runs. * * Register handlers before calling {@link connect `connect`} to avoid missing notifications. * - * @param callback - Function called with the updated host context - * * @example Respond to theme changes * ```ts source="./app.examples.ts#App_onhostcontextchanged_respondToTheme" * app.onhostcontextchanged = (ctx) => { @@ -517,21 +1024,21 @@ export class App extends Protocol { * }; * ``` * - * @see {@link setNotificationHandler `setNotificationHandler`} for the underlying method + * @deprecated Use {@link addEventListener `addEventListener("hostcontextchanged", handler)`} instead β€” it composes with other listeners and supports cleanup via {@link removeEventListener `removeEventListener`}. * @see {@link McpUiHostContextChangedNotification `McpUiHostContextChangedNotification`} for the notification structure * @see {@link McpUiHostContext `McpUiHostContext`} for the full context structure */ + get onhostcontextchanged(): + | ((params: McpUiHostContextChangedNotification["params"]) => void) + | undefined { + return this.getEventHandler("hostcontextchanged"); + } set onhostcontextchanged( - callback: (params: McpUiHostContextChangedNotification["params"]) => void, + callback: + | ((params: McpUiHostContextChangedNotification["params"]) => void) + | undefined, ) { - this.setNotificationHandler( - McpUiHostContextChangedNotificationSchema, - (n) => { - // Merge the partial update into the stored context - this._hostContext = { ...this._hostContext, ...n.params }; - callback(n.params); - }, - ); + this.setEventHandler("hostcontextchanged", callback); } /** @@ -544,8 +1051,7 @@ export class App extends Protocol { * The handler can be sync or async. The host will wait for the returned promise * to resolve before proceeding with teardown. * - * This setter is a convenience wrapper around `setRequestHandler()` that - * automatically handles the request schema. + * Assigning replaces the previous handler; assigning `undefined` clears it. * * Register handlers before calling {@link connect `connect`} to avoid missing requests. * @@ -562,18 +1068,35 @@ export class App extends Protocol { * }; * ``` * - * @see {@link setRequestHandler `setRequestHandler`} for the underlying method * @see {@link McpUiResourceTeardownRequest `McpUiResourceTeardownRequest`} for the request structure */ + private _onteardown?: ( + params: McpUiResourceTeardownRequest["params"], + extra: RequestHandlerExtra, + ) => McpUiResourceTeardownResult | Promise; + get onteardown() { + return this._onteardown; + } set onteardown( - callback: ( - params: McpUiResourceTeardownRequest["params"], - extra: RequestHandlerExtra, - ) => McpUiResourceTeardownResult | Promise, + callback: + | (( + params: McpUiResourceTeardownRequest["params"], + extra: RequestHandlerExtra, + ) => McpUiResourceTeardownResult | Promise) + | undefined, ) { - this.setRequestHandler( - McpUiResourceTeardownRequestSchema, - (request, extra) => callback(request.params, extra), + this.warnIfRequestHandlerReplaced("onteardown", this._onteardown, callback); + this._onteardown = callback; + this.replaceRequestHandler( + "ui/resource-teardown", + { + params: McpUiResourceTeardownRequestSchema.shape.params, + result: McpUiResourceTeardownResultSchema, + }, + (params, extra) => { + if (!this._onteardown) throw new Error("No onteardown handler set"); + return this._onteardown(params, extra); + }, ); } @@ -586,8 +1109,7 @@ export class App extends Protocol { * * The app must declare tool capabilities in the constructor to use this handler. * - * This setter is a convenience wrapper around `setRequestHandler()` that - * automatically handles the request schema and extracts the params for you. + * Assigning replaces the previous handler; assigning `undefined` clears it. * * Register handlers before calling {@link connect `connect`} to avoid missing requests. * @@ -605,18 +1127,28 @@ export class App extends Protocol { * throw new Error(`Unknown tool: ${params.name}`); * }; * ``` - * - * @see {@link setRequestHandler `setRequestHandler`} for the underlying method */ + private _oncalltool?: ( + params: CallToolRequest["params"], + extra: RequestHandlerExtra, + ) => Promise; + get oncalltool() { + return this._oncalltool; + } set oncalltool( - callback: ( - params: CallToolRequest["params"], - extra: RequestHandlerExtra, - ) => Promise, + callback: + | (( + params: CallToolRequest["params"], + extra: RequestHandlerExtra, + ) => Promise) + | undefined, ) { - this.setRequestHandler(CallToolRequestSchema, (request, extra) => - callback(request.params, extra), - ); + this.warnIfRequestHandlerReplaced("oncalltool", this._oncalltool, callback); + this._oncalltool = callback; + this.replaceRequestHandler("tools/call", (request, extra) => { + if (!this._oncalltool) throw new Error("No oncalltool handler set"); + return this._oncalltool(request.params, extra); + }); } /** @@ -628,65 +1160,103 @@ export class App extends Protocol { * * The app must declare tool capabilities in the constructor to use this handler. * - * This setter is a convenience wrapper around `setRequestHandler()` that - * automatically handles the request schema and extracts the params for you. + * Assigning replaces the previous handler; assigning `undefined` clears it. * * Register handlers before calling {@link connect `connect`} to avoid missing requests. * - * @param callback - Async function that returns tool names as strings (simplified - * from full `ListToolsResult` with `Tool` objects). Registration is always - * allowed; capability validation occurs when handlers are invoked. + * @param callback - Async function that returns a {@link ListToolsResult `ListToolsResult`}. + * Registration is always allowed; capability validation occurs when handlers + * are invoked. * * @example Return available tools * ```ts source="./app.examples.ts#App_onlisttools_returnTools" * app.onlisttools = async (params, extra) => { * return { - * tools: ["greet", "calculate", "format"], + * tools: [ + * { + * name: "greet", + * description: "Greet the user", + * inputSchema: { type: "object" as const }, + * }, + * { + * name: "calculate", + * description: "Perform a calculation", + * inputSchema: { type: "object" as const }, + * }, + * { + * name: "format", + * description: "Format text", + * inputSchema: { type: "object" as const }, + * }, + * ], * }; * }; * ``` * - * @see {@link setRequestHandler `setRequestHandler`} for the underlying method * @see {@link oncalltool `oncalltool`} for handling tool execution */ + private _onlisttools?: ( + params: ListToolsRequest["params"], + extra: RequestHandlerExtra, + ) => Promise; + get onlisttools() { + return this._onlisttools; + } set onlisttools( - callback: ( - params: ListToolsRequest["params"], - extra: RequestHandlerExtra, - ) => Promise<{ tools: string[] }>, + callback: + | (( + params: ListToolsRequest["params"], + extra: RequestHandlerExtra, + ) => Promise) + | undefined, ) { - this.setRequestHandler(ListToolsRequestSchema, (request, extra) => - callback(request.params, extra), + this.warnIfRequestHandlerReplaced( + "onlisttools", + this._onlisttools, + callback, ); + this._onlisttools = callback; + this.replaceRequestHandler("tools/list", (request, extra) => { + if (!this._onlisttools) throw new Error("No onlisttools handler set"); + return this._onlisttools(request.params, extra); + }); } /** * Verify that the host supports the capability required for the given request method. * @internal */ - assertCapabilityForMethod(method: AppRequest["method"]): void { - // TODO + protected override assertCapabilityForMethod(method: string): void { + switch (method) { + case "sampling/createMessage": + if (!this._hostCapabilities?.sampling) { + throw new Error( + `Host does not support sampling (required for ${method})`, + ); + } + break; + } } /** * Verify that the app declared the capability required for the given request method. * @internal */ - assertRequestHandlerCapability(method: AppRequest["method"]): void { + protected override assertRequestHandlerCapability(method: string): void { switch (method) { case "tools/call": case "tools/list": - if (!this._capabilities.tools) { + if (!this._appCapabilities.tools) { throw new Error( `Client does not support tool capability (required for ${method})`, ); } return; - case "ping": - case "ui/resource-teardown": - return; default: - throw new Error(`No handler for method ${method} registered`); + // `ping`, `ui/*`, and custom (vendor-prefixed) methods need no + // declared capability. The base SDK explicitly supports custom + // request handlers via the `{ params, result }` form. + return; } } @@ -694,26 +1264,10 @@ export class App extends Protocol { * Verify that the app supports the capability required for the given notification method. * @internal */ - assertNotificationCapability(method: AppNotification["method"]): void { + protected override assertNotificationCapability(_method: string): void { // TODO } - /** - * Verify that task creation is supported for the given request method. - * @internal - */ - protected assertTaskCapability(_method: string): void { - throw new Error("Tasks are not supported in MCP Apps"); - } - - /** - * Verify that task handler is supported for the given method. - * @internal - */ - protected assertTaskHandlerCapability(_method: string): void { - throw new Error("Task handlers are not supported in MCP Apps"); - } - /** * Call a tool on the originating MCP server (proxied through the host). * @@ -753,6 +1307,7 @@ export class App extends Protocol { params: CallToolRequest["params"], options?: RequestOptions, ): Promise { + this._assertInitialized("callServerTool"); if (typeof params === "string") { throw new Error( `callServerTool() expects an object as its first argument, but received a string ("${params}"). ` + @@ -761,8 +1316,14 @@ export class App extends Protocol { } return await this.request( { method: "tools/call", params }, - CallToolResultSchema, - options, + { + // Hosts may interpose long-running or user-interactive steps before the + // tool result arrives. Opting in here lets a host heartbeat keep the + // request alive past the default timeout; callers can still override. + onprogress: () => {}, + resetTimeoutOnProgress: true, + ...options, + }, ); } @@ -810,11 +1371,8 @@ export class App extends Protocol { params: ReadResourceRequest["params"], options?: RequestOptions, ): Promise { - return await this.request( - { method: "resources/read", params }, - ReadResourceResultSchema, - options, - ); + this._assertInitialized("readServerResource"); + return await this.request({ method: "resources/read", params }, options); } /** @@ -857,9 +1415,86 @@ export class App extends Protocol { params?: ListResourcesRequest["params"], options?: RequestOptions, ): Promise { + this._assertInitialized("listServerResources"); + return await this.request({ method: "resources/list", params }, options); + } + + /** + * Request an LLM completion from the host (standard MCP `sampling/createMessage`). + * + * Enables the app to use the host's model connection for completions. The host + * has full discretion over which model to select and MAY modify or reject the + * request (human-in-the-loop). Check {@link getHostCapabilities `getHostCapabilities`}`()?.sampling` + * before calling β€” hosts without this capability will reject the request. + * + * This method reuses the stock MCP `CreateMessageRequest` shape. When `params.tools` + * is provided, the result is parsed with the extended schema that permits + * `stopReason: "toolUse"` and array content containing `tool_use` blocks. + * + * @param params - Standard MCP `CreateMessageRequest` params (messages, maxTokens, + * systemPrompt, temperature, modelPreferences, tools, toolChoice, etc.) + * @param options - Request options (timeout, abort signal) + * @returns `CreateMessageResult` (single content block) or `CreateMessageResultWithTools` + * (array content, may include `tool_use` blocks) depending on whether `tools` was set + * + * @throws {Error} If the host rejects the request or does not support sampling + * @throws {Error} If the request times out or the connection is lost + * + * @example Simple completion + * ```ts source="./app.examples.ts#App_createSamplingMessage_simple" + * const result = await app.createSamplingMessage({ + * messages: [ + * { + * role: "user", + * content: { type: "text", text: "Summarize this in one line." }, + * }, + * ], + * maxTokens: 100, + * }); + * console.log(result.content); + * ``` + * + * @example Agentic loop with tools + * ```ts source="./app.examples.ts#App_createSamplingMessage_withTools" + * if (!app.getHostCapabilities()?.sampling?.tools) return; + * + * const result = await app.createSamplingMessage({ + * messages, + * maxTokens: 1024, + * tools: [ + * { + * name: "get_weather", + * description: "Get the current weather", + * inputSchema: { + * type: "object", + * properties: { city: { type: "string" } }, + * }, + * }, + * ], + * }); + * if (result.stopReason === "toolUse") { + * // result.content may be an array containing tool_use blocks + * } + * ``` + * + * @see `CreateMessageRequest` from @modelcontextprotocol/client for the request type + * @see `CreateMessageResult` / `CreateMessageResultWithTools` from @modelcontextprotocol/client for result types + */ + async createSamplingMessage( + params: CreateMessageRequest["params"] & { tools?: undefined }, + options?: RequestOptions, + ): Promise; + async createSamplingMessage( + params: CreateMessageRequest["params"], + options?: RequestOptions, + ): Promise; + async createSamplingMessage( + params: CreateMessageRequest["params"], + options?: RequestOptions, + ): Promise { + this._assertInitialized("createSamplingMessage"); return await this.request( - { method: "resources/list", params }, - ListResourcesResultSchema, + { method: "sampling/createMessage", params }, options, ); } @@ -915,6 +1550,7 @@ export class App extends Protocol { * @see {@link McpUiMessageRequest `McpUiMessageRequest`} for request structure */ sendMessage(params: McpUiMessageRequest["params"], options?: RequestOptions) { + this._assertInitialized("sendMessage"); return this.request( { method: "ui/message", @@ -1008,6 +1644,7 @@ export class App extends Protocol { params: McpUiUpdateModelContextRequest["params"], options?: RequestOptions, ) { + this._assertInitialized("updateModelContext"); return this.request( { method: "ui/update-model-context", @@ -1044,6 +1681,7 @@ export class App extends Protocol { * @see {@link McpUiOpenLinkResult `McpUiOpenLinkResult`} for result structure */ openLink(params: McpUiOpenLinkRequest["params"], options?: RequestOptions) { + this._assertInitialized("openLink"); return this.request( { method: "ui/open-link", @@ -1124,6 +1762,7 @@ export class App extends Protocol { params: McpUiDownloadFileRequest["params"], options?: RequestOptions, ) { + this._assertInitialized("downloadFile"); return this.request( { method: "ui/download-file", @@ -1134,6 +1773,50 @@ export class App extends Protocol { ); } + /** + * Request the host to tear down this app. + * + * Apps call this method to request that the host tear them down. The host + * decides whether to proceed - if approved, the host will send + * `ui/resource-teardown` to allow the app to perform gracefull termination before being + * unmounted. This piggybacks on the existing teardown mechanism, ensuring + * the app only needs a single shutdown procedure (via {@link onteardown `onteardown`}) + * regardless of whether the teardown was initiated by the app or the host. + * + * This is a fire-and-forget notification - no response is expected. + * If the host approves, the app will receive a `ui/resource-teardown` + * request via the {@link onteardown `onteardown`} handler to persist unsaved state. + * + * @param params - Empty params object (reserved for future use) + * @returns Promise that resolves when the notification is sent + * + * @example App-initiated teardown after user action + * ```typescript + * // User clicks "Done" button in the app + * async function handleDoneClick() { + * // Request the host to tear down the app + * await app.requestTeardown(); + * // If host approves, onteardown handler will be called for termination + * } + * + * // Set up teardown handler (called for both app-initiated and host-initiated teardown) + * app.onteardown = async () => { + * await saveState(); + * closeConnections(); + * return {}; + * }; + * ``` + * + * @see {@link McpUiRequestTeardownNotification `McpUiRequestTeardownNotification`} for notification structure + * @see {@link onteardown `onteardown`} for the graceful termination handler + */ + requestTeardown(params: McpUiRequestTeardownNotification["params"] = {}) { + return this.notification({ + method: "ui/notifications/request-teardown", + params, + }); + } + /** * Request a change to the display mode. * @@ -1164,6 +1847,7 @@ export class App extends Protocol { params: McpUiRequestDisplayModeRequest["params"], options?: RequestOptions, ) { + this._assertInitialized("requestDisplayMode"); return this.request( { method: "ui/request-display-mode", @@ -1244,24 +1928,22 @@ export class App extends Protocol { scheduled = false; const html = document.documentElement; - // Measure actual content size by temporarily overriding html sizing. - // Width uses fit-content so content wraps at the host-provided width. + // Measure actual content height by temporarily overriding html sizing. // Height uses max-content because fit-content would clamp to the viewport // height when content is taller than the iframe, causing internal scrolling. - const originalWidth = html.style.width; + // + // Width uses window.innerWidth instead of measuring via fit-content. + // Setting html.style.width to fit-content forces a synchronous reflow at + // 0px width for responsive apps (whose content derives width from the + // container rather than having intrinsic width). This causes the browser + // to clamp scrollLeft on any horizontal scroll containers to 0, permanently + // destroying their scroll positions. const originalHeight = html.style.height; - html.style.width = "fit-content"; html.style.height = "max-content"; - const rect = html.getBoundingClientRect(); - html.style.width = originalWidth; + const height = Math.ceil(html.getBoundingClientRect().height); html.style.height = originalHeight; - // Compensate for scrollbar width on Linux/Windows where scrollbars consume space. - // On systems with overlay scrollbars (macOS), this will be 0. - const scrollbarWidth = window.innerWidth - html.clientWidth; - - const width = Math.ceil(rect.width + scrollbarWidth); - const height = Math.ceil(rect.height); + const width = Math.ceil(window.innerWidth); // Only send if size actually changed (prevents feedback loops from style changes) if (width !== lastWidth || height !== lastHeight) { @@ -1328,14 +2010,19 @@ export class App extends Protocol { "App is already connected. Call close() before connecting again.", ); } - await super.connect(transport); + this._initializedSent = false; try { + // Protocol.connect only wires the transport β€” no MCP handshake. The + // ui/initialize request below is the sole negotiation on this channel, + // matching the v1 wire behavior deployed hosts expect. + await super.connect(transport); + const result = await this.request( { method: "ui/initialize", params: { - appCapabilities: this._capabilities, + appCapabilities: this._appCapabilities, appInfo: this._appInfo, protocolVersion: LATEST_PROTOCOL_VERSION, }, @@ -1355,6 +2042,7 @@ export class App extends Protocol { await this.notification({ method: "ui/notifications/initialized", }); + this._initializedSent = true; if (this.options?.autoResize) { this.setupSizeChangedNotifications(); diff --git a/src/constants.ts b/src/constants.ts new file mode 100644 index 0000000..c879a03 --- /dev/null +++ b/src/constants.ts @@ -0,0 +1,66 @@ +/** + * Metadata key for associating a UI resource URI with a tool. + * + * MCP servers include this key in tool definition metadata (via `tools/list`) + * to indicate which UI resource should be displayed when the tool is called. + * When hosts see a tool with this metadata, they fetch and render the + * corresponding {@link app!App `App`}. + * + * **Note**: This constant is provided for reference and backwards compatibility. + * Server developers should use {@link server-helpers!registerAppTool `registerAppTool`} + * with the `_meta.ui.resourceUri` format instead. Host developers must check both + * formats for compatibility. + * + * @example Modern format (server-side, not in Apps) + * ```ts source="./app.examples.ts#RESOURCE_URI_META_KEY_modernFormat" + * // Preferred: Use registerAppTool with nested ui.resourceUri + * registerAppTool( + * server, + * "weather", + * { + * description: "Get weather forecast", + * _meta: { + * ui: { resourceUri: "ui://weather/forecast" }, + * }, + * }, + * handler, + * ); + * ``` + * + * @example Legacy format (deprecated, for backwards compatibility) + * ```ts source="./app.examples.ts#RESOURCE_URI_META_KEY_legacyFormat" + * // Deprecated: Direct use of RESOURCE_URI_META_KEY + * server.registerTool( + * "weather", + * { + * description: "Get weather forecast", + * _meta: { + * [RESOURCE_URI_META_KEY]: "ui://weather/forecast", + * }, + * }, + * handler, + * ); + * ``` + * + * @example How hosts check for this metadata (must support both formats) + * ```ts source="./app.examples.ts#RESOURCE_URI_META_KEY_hostSide" + * // Hosts should check both modern and legacy formats + * const meta = tool._meta; + * const uiMeta = meta?.ui as McpUiToolMeta | undefined; + * const legacyUri = meta?.[RESOURCE_URI_META_KEY] as string | undefined; + * const uiUri = uiMeta?.resourceUri ?? legacyUri; + * if (typeof uiUri === "string" && uiUri.startsWith("ui://")) { + * // Fetch the resource and display the UI + * } + * ``` + */ +export const RESOURCE_URI_META_KEY = "ui/resourceUri"; + +/** + * MIME type for MCP UI resources. + * + * Identifies HTML content as an MCP App UI resource. + * + * Used by {@link server-helpers!registerAppResource `registerAppResource`} as the default MIME type for app resources. + */ +export const RESOURCE_MIME_TYPE = "text/html;profile=mcp-app"; diff --git a/src/events.test.ts b/src/events.test.ts new file mode 100644 index 0000000..60e7c35 --- /dev/null +++ b/src/events.test.ts @@ -0,0 +1,82 @@ +import { describe, expect, it, spyOn } from "bun:test"; + +import { EventDispatcher } from "./events.js"; + +type TestEventMap = { + change: { value: number }; +}; + +describe("EventDispatcher", () => { + it("replaces the singular handler", () => { + const dispatcher = new EventDispatcher(); + const calls: string[] = []; + const first = () => calls.push("first"); + const second = () => calls.push("second"); + const warn = spyOn(console, "warn").mockImplementation(() => {}); + + try { + dispatcher.setHandler("change", first); + dispatcher.setHandler("change", second); + + expect(dispatcher.getHandler("change")).toBe(second); + dispatcher.dispatch("change", { value: 1 }); + expect(calls).toEqual(["second"]); + } finally { + warn.mockRestore(); + } + }); + + it("dispatches the singular handler before listeners in insertion order", () => { + const dispatcher = new EventDispatcher(); + const calls: string[] = []; + + dispatcher.setHandler("change", () => calls.push("handler")); + dispatcher.addEventListener("change", () => calls.push("listener-1")); + dispatcher.addEventListener("change", () => calls.push("listener-2")); + + dispatcher.dispatch("change", { value: 1 }); + + expect(calls).toEqual(["handler", "listener-1", "listener-2"]); + }); + + it("uses a listener snapshot when a listener is removed during dispatch", () => { + const dispatcher = new EventDispatcher(); + const calls: string[] = []; + const second = () => calls.push("second"); + const first = () => { + calls.push("first"); + dispatcher.removeEventListener("change", second); + }; + + dispatcher.addEventListener("change", first); + dispatcher.addEventListener("change", second); + + dispatcher.dispatch("change", { value: 1 }); + dispatcher.dispatch("change", { value: 2 }); + + expect(calls).toEqual(["first", "second", "first"]); + }); + + it("warns only when one singular handler replaces another", () => { + const dispatcher = new EventDispatcher(); + const warn = spyOn(console, "warn").mockImplementation(() => {}); + const first = () => {}; + const second = () => {}; + + try { + dispatcher.setHandler("change", first); + dispatcher.setHandler("change", undefined); + dispatcher.setHandler("change", first); + expect(warn).not.toHaveBeenCalled(); + + dispatcher.setHandler("change", second); + + expect(warn).toHaveBeenCalledTimes(1); + expect(String(warn.mock.calls[0]?.[0])).toContain( + "onchange handler replaced", + ); + } finally { + warn.mockRestore(); + } + }); +}); diff --git a/src/events.ts b/src/events.ts new file mode 100644 index 0000000..aa2e862 --- /dev/null +++ b/src/events.ts @@ -0,0 +1,132 @@ +/** + * Per-event state: a singular `on*` handler (replace semantics) plus an + * ordered listener array (`addEventListener` semantics). + */ +interface EventSlot { + onHandler?: ((params: T) => void) | undefined; + listeners: ((params: T) => void)[]; +} + +/** + * Protocol-independent DOM-style event fan-out. + * + * Owners perform event-specific state updates before calling + * {@link dispatch}. Dispatch then invokes the singular handler followed by a + * snapshot of listeners in insertion order. + * + * @typeParam EventMap - Maps event names to their listener parameter types. + */ +export class EventDispatcher> { + private readonly _eventSlots = new Map(); + + /** Set, replace, or clear the singular handler for an event. */ + setHandler( + event: K, + handler: ((params: EventMap[K]) => void) | undefined, + ): void { + const slot = this._ensureEventSlot(event); + if (slot.onHandler && handler) { + console.warn( + `[MCP Apps] on${String(event)} handler replaced. ` + + `Use addEventListener("${String(event)}", …) to add multiple listeners without replacing.`, + ); + } + slot.onHandler = handler; + } + + /** Get the singular handler for an event, if one is set. */ + getHandler( + event: K, + ): ((params: EventMap[K]) => void) | undefined { + return (this._eventSlots.get(event) as EventSlot | undefined) + ?.onHandler; + } + + /** Add a listener. Listeners run in insertion order after the handler. */ + addEventListener( + event: K, + handler: (params: EventMap[K]) => void, + ): void { + this._ensureEventSlot(event).listeners.push(handler); + } + + /** Remove the first matching listener, if present. */ + removeEventListener( + event: K, + handler: (params: EventMap[K]) => void, + ): void { + const slot = this._eventSlots.get(event) as + | EventSlot + | undefined; + if (!slot) return; + const idx = slot.listeners.indexOf(handler); + if (idx !== -1) slot.listeners.splice(idx, 1); + } + + /** + * Dispatch an event to its singular handler and a listener snapshot. + * Listener mutations during dispatch take effect on the next dispatch. + */ + dispatch(event: K, params: EventMap[K]): void { + const slot = this._eventSlots.get(event) as + | EventSlot + | undefined; + if (!slot) return; + slot.onHandler?.(params); + for (const l of [...slot.listeners]) l(params); + } + + private _ensureEventSlot( + event: K, + ): EventSlot { + let slot = this._eventSlots.get(event) as + | EventSlot + | undefined; + if (!slot) { + slot = { listeners: [] }; + this._eventSlots.set(event, slot as EventSlot); + } + return slot; + } +} + +/** + * Tracks which JSON-RPC methods already have a handler registered through the + * owning `App` / `AppBridge`, so a second direct `setRequestHandler` / + * `setNotificationHandler` call for the same method throws instead of + * silently replacing the first handler (the base SDK `Protocol` replaces). + * + * The `on*` setters use {@link replace} for DOM-style replace semantics, and + * `removeRequestHandler` / `removeNotificationHandler` use {@link release}. + * + * @internal + */ +export class MethodRegistry { + private readonly _methods = new Set(); + + /** Claim `method`. Throws if a handler is already registered for it. */ + claim(method: string, via: string): void { + if (this._methods.has(method)) { + throw new Error( + `Handler for "${method}" already registered (via ${via}). ` + + `Use addEventListener() to attach multiple listeners, ` + + `or the on* setter for replace semantics.`, + ); + } + this._methods.add(method); + } + + /** Claim `method` with replace semantics (never throws). */ + replace(method: string): void { + this._methods.add(method); + } + + /** Release `method` so it can be claimed again. */ + release(method: string): void { + this._methods.delete(method); + } + + has(method: string): boolean { + return this._methods.has(method); + } +} diff --git a/src/generated/schema.json b/src/generated/schema.json index 522f159..246ed7d 100644 --- a/src/generated/schema.json +++ b/src/generated/schema.json @@ -9,10 +9,19 @@ "type": "object", "properties": { "experimental": { - "description": "Experimental features (structure TBD).", + "description": "Experimental features keyed by identifier.", "type": "object", - "properties": {}, - "additionalProperties": false + "propertyNames": { + "type": "string" + }, + "additionalProperties": { + "type": "object", + "propertyNames": { + "type": "string" + }, + "additionalProperties": {}, + "description": "Experimental features keyed by identifier." + } }, "tools": { "description": "App exposes MCP-style tools that the host can call.", @@ -231,6 +240,9 @@ "mimeType": { "type": "string" }, + "size": { + "type": "number" + }, "annotations": { "type": "object", "properties": { @@ -295,10 +307,19 @@ "type": "object", "properties": { "experimental": { - "description": "Experimental features (structure TBD).", + "description": "Experimental features keyed by identifier.", "type": "object", - "properties": {}, - "additionalProperties": false + "propertyNames": { + "type": "string" + }, + "additionalProperties": { + "type": "object", + "propertyNames": { + "type": "string" + }, + "additionalProperties": {}, + "description": "Experimental features keyed by identifier." + } }, "openLinks": { "description": "Host supports opening external URLs.", @@ -498,6 +519,19 @@ } }, "additionalProperties": false + }, + "sampling": { + "description": "Host supports LLM sampling (sampling/createMessage) from the view.\nMirrors the MCP `ClientCapabilities.sampling` shape so hosts can pass it through.", + "type": "object", + "properties": { + "tools": { + "description": "Host supports tool use via `tools` and `toolChoice` parameters.", + "type": "object", + "properties": {}, + "additionalProperties": false + } + }, + "additionalProperties": false } }, "additionalProperties": false @@ -580,7 +614,9 @@ "propertyNames": { "type": "string" }, - "additionalProperties": {} + "additionalProperties": { + "$ref": "#/$defs/__schema0" + } }, "required": { "type": "array", @@ -595,25 +631,10 @@ "outputSchema": { "type": "object", "properties": { - "type": { - "type": "string", - "const": "object" - }, - "properties": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "required": { - "type": "array", - "items": { - "type": "string" - } + "$schema": { + "type": "string" } }, - "required": ["type"], "additionalProperties": {} }, "annotations": { @@ -1270,7 +1291,40 @@ } }, "required": ["method", "params"], - "additionalProperties": false + "additionalProperties": false, + "$defs": { + "__schema0": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + }, + { + "type": "object", + "propertyNames": { + "type": "string" + }, + "additionalProperties": { + "$ref": "#/$defs/__schema0" + } + }, + { + "type": "array", + "items": { + "$ref": "#/$defs/__schema0" + } + } + ] + } + } }, "McpUiHostContext": { "$schema": "https://json-schema.org/draft/2020-12/schema", @@ -1343,7 +1397,9 @@ "propertyNames": { "type": "string" }, - "additionalProperties": {} + "additionalProperties": { + "$ref": "#/$defs/__schema0" + } }, "required": { "type": "array", @@ -1358,25 +1414,10 @@ "outputSchema": { "type": "object", "properties": { - "type": { - "type": "string", - "const": "object" - }, - "properties": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "required": { - "type": "array", - "items": { - "type": "string" - } + "$schema": { + "type": "string" } }, - "required": ["type"], "additionalProperties": {} }, "annotations": { @@ -2028,7 +2069,40 @@ "additionalProperties": false } }, - "additionalProperties": {} + "additionalProperties": {}, + "$defs": { + "__schema0": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + }, + { + "type": "object", + "propertyNames": { + "type": "string" + }, + "additionalProperties": { + "$ref": "#/$defs/__schema0" + } + }, + { + "type": "array", + "items": { + "$ref": "#/$defs/__schema0" + } + } + ] + } + } }, "McpUiHostCss": { "$schema": "https://json-schema.org/draft/2020-12/schema", @@ -2521,10 +2595,19 @@ "type": "object", "properties": { "experimental": { - "description": "Experimental features (structure TBD).", + "description": "Experimental features keyed by identifier.", "type": "object", - "properties": {}, - "additionalProperties": false + "propertyNames": { + "type": "string" + }, + "additionalProperties": { + "type": "object", + "propertyNames": { + "type": "string" + }, + "additionalProperties": {}, + "description": "Experimental features keyed by identifier." + } }, "tools": { "description": "App exposes MCP-style tools that the host can call.", @@ -2635,10 +2718,19 @@ "type": "object", "properties": { "experimental": { - "description": "Experimental features (structure TBD).", + "description": "Experimental features keyed by identifier.", "type": "object", - "properties": {}, - "additionalProperties": false + "propertyNames": { + "type": "string" + }, + "additionalProperties": { + "type": "object", + "propertyNames": { + "type": "string" + }, + "additionalProperties": {}, + "description": "Experimental features keyed by identifier." + } }, "openLinks": { "description": "Host supports opening external URLs.", @@ -2838,6 +2930,19 @@ } }, "additionalProperties": false + }, + "sampling": { + "description": "Host supports LLM sampling (sampling/createMessage) from the view.\nMirrors the MCP `ClientCapabilities.sampling` shape so hosts can pass it through.", + "type": "object", + "properties": { + "tools": { + "description": "Host supports tool use via `tools` and `toolChoice` parameters.", + "type": "object", + "properties": {}, + "additionalProperties": false + } + }, + "additionalProperties": false } }, "additionalProperties": false, @@ -2913,7 +3018,9 @@ "propertyNames": { "type": "string" }, - "additionalProperties": {} + "additionalProperties": { + "$ref": "#/$defs/__schema0" + } }, "required": { "type": "array", @@ -2928,25 +3035,10 @@ "outputSchema": { "type": "object", "properties": { - "type": { - "type": "string", - "const": "object" - }, - "properties": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "required": { - "type": "array", - "items": { - "type": "string" - } + "$schema": { + "type": "string" } }, - "required": ["type"], "additionalProperties": {} }, "annotations": { @@ -3608,7 +3700,40 @@ "hostCapabilities", "hostContext" ], - "additionalProperties": {} + "additionalProperties": {}, + "$defs": { + "__schema0": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + }, + { + "type": "object", + "propertyNames": { + "type": "string" + }, + "additionalProperties": { + "$ref": "#/$defs/__schema0" + } + }, + { + "type": "array", + "items": { + "$ref": "#/$defs/__schema0" + } + } + ] + } + } }, "McpUiInitializedNotification": { "$schema": "https://json-schema.org/draft/2020-12/schema", @@ -3829,6 +3954,9 @@ "mimeType": { "type": "string" }, + "size": { + "type": "number" + }, "annotations": { "type": "object", "properties": { @@ -4074,6 +4202,23 @@ "required": ["mode"], "additionalProperties": {} }, + "McpUiRequestTeardownNotification": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "type": "object", + "properties": { + "method": { + "type": "string", + "const": "ui/notifications/request-teardown" + }, + "params": { + "type": "object", + "properties": {}, + "additionalProperties": false + } + }, + "required": ["method"], + "additionalProperties": false + }, "McpUiResourceCsp": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", @@ -5251,6 +5396,12 @@ ], "description": "Tool visibility scope - who can access the tool." } + }, + "csp": { + "not": {} + }, + "permissions": { + "not": {} } }, "additionalProperties": false @@ -5269,26 +5420,52 @@ "_meta": { "type": "object", "properties": { - "progressToken": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "integer", - "minimum": -9007199254740991, - "maximum": 9007199254740991 - } - ] - }, - "io.modelcontextprotocol/related-task": { + "io.modelcontextprotocol/serverInfo": { "type": "object", "properties": { - "taskId": { + "name": { + "type": "string" + }, + "title": { + "type": "string" + }, + "icons": { + "type": "array", + "items": { + "type": "object", + "properties": { + "src": { + "type": "string" + }, + "mimeType": { + "type": "string" + }, + "sizes": { + "type": "array", + "items": { + "type": "string" + } + }, + "theme": { + "type": "string", + "enum": ["light", "dark"] + } + }, + "required": ["src"], + "additionalProperties": false + } + }, + "version": { + "type": "string" + }, + "websiteUrl": { + "type": "string" + }, + "description": { "type": "string" } }, - "required": ["taskId"], + "required": ["name", "version"], "additionalProperties": false } }, @@ -5481,6 +5658,9 @@ "mimeType": { "type": "string" }, + "size": { + "type": "number" + }, "annotations": { "type": "object", "properties": { @@ -5611,13 +5791,7 @@ ] } }, - "structuredContent": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, + "structuredContent": {}, "isError": { "type": "boolean" } @@ -5842,6 +6016,9 @@ "mimeType": { "type": "string" }, + "size": { + "type": "number" + }, "annotations": { "type": "object", "properties": { diff --git a/src/generated/schema.test.ts b/src/generated/schema.test.ts index 47e5978..57d989f 100644 --- a/src/generated/schema.test.ts +++ b/src/generated/schema.test.ts @@ -1,7 +1,7 @@ // Generated by ts-to-zod // Integration tests verifying schemas match TypeScript types // Run: npm run generate:schemas -import { z } from "zod"; +import { z } from "zod/v4"; import * as spec from "../spec.types.js"; import * as generated from "./schema.js"; @@ -91,6 +91,10 @@ export type McpUiSupportedContentBlockModalitiesSchemaInferredType = z.infer< typeof generated.McpUiSupportedContentBlockModalitiesSchema >; +export type McpUiRequestTeardownNotificationSchemaInferredType = z.infer< + typeof generated.McpUiRequestTeardownNotificationSchema +>; + export type McpUiHostCapabilitiesSchemaInferredType = z.infer< typeof generated.McpUiHostCapabilitiesSchema >; @@ -255,6 +259,12 @@ expectType( expectType( {} as spec.McpUiSupportedContentBlockModalities, ); +expectType( + {} as McpUiRequestTeardownNotificationSchemaInferredType, +); +expectType( + {} as spec.McpUiRequestTeardownNotification, +); expectType( {} as McpUiHostCapabilitiesSchemaInferredType, ); diff --git a/src/generated/schema.ts b/src/generated/schema.ts index 88797b5..214b227 100644 --- a/src/generated/schema.ts +++ b/src/generated/schema.ts @@ -1,7 +1,7 @@ // Generated by ts-to-zod // Post-processed for Zod v3/v4 compatibility and MCP SDK integration // Run: npm run generate:schemas -import { z } from "zod"; +import { z } from "zod/v4"; import { ContentBlockSchema, CallToolResultSchema, @@ -10,7 +10,7 @@ import { RequestIdSchema, ResourceLinkSchema, ToolSchema, -} from "@modelcontextprotocol/sdk/types.js"; +} from "@modelcontextprotocol/core"; /** * @description Color theme preference for the host environment. @@ -478,16 +478,34 @@ export const McpUiSupportedContentBlockModalitiesSchema = z.object({ .describe("Host supports structured content."), }); +/** + * @description Notification for app-initiated teardown request (View -> Host). + * Views send this to request that the host tear them down. The host decides + * whether to proceed - if approved, the host will send + * `ui/resource-teardown` to allow the view to perform cleanup before being + * unmounted. + * @see {@link app.App.requestTeardown} for the app method that sends this + */ +export const McpUiRequestTeardownNotificationSchema = z.object({ + method: z.literal("ui/notifications/request-teardown"), + params: z.object({}).optional(), +}); + /** * @description Capabilities supported by the host application. * @see {@link McpUiInitializeResult `McpUiInitializeResult`} for the initialization result that includes these capabilities */ export const McpUiHostCapabilitiesSchema = z.object({ - /** @description Experimental features (structure TBD). */ + /** @description Experimental features keyed by identifier. */ experimental: z - .object({}) + .record( + z.string(), + z + .record(z.string(), z.any()) + .describe("Experimental features keyed by identifier."), + ) .optional() - .describe("Experimental features (structure TBD)."), + .describe("Experimental features keyed by identifier."), /** @description Host supports opening external URLs. */ openLinks: z .object({}) @@ -545,6 +563,24 @@ export const McpUiHostCapabilitiesSchema = z.object({ message: McpUiSupportedContentBlockModalitiesSchema.optional().describe( "Host supports receiving content messages (ui/message) from the view.", ), + /** + * @description Host supports LLM sampling (sampling/createMessage) from the view. + * Mirrors the MCP `ClientCapabilities.sampling` shape so hosts can pass it through. + */ + sampling: z + .object({ + /** @description Host supports tool use via `tools` and `toolChoice` parameters. */ + tools: z + .object({}) + .optional() + .describe( + "Host supports tool use via `tools` and `toolChoice` parameters.", + ), + }) + .optional() + .describe( + "Host supports LLM sampling (sampling/createMessage) from the view.\nMirrors the MCP `ClientCapabilities.sampling` shape so hosts can pass it through.", + ), }); /** @@ -552,11 +588,16 @@ export const McpUiHostCapabilitiesSchema = z.object({ * @see {@link McpUiInitializeRequest `McpUiInitializeRequest`} for the initialization request that includes these capabilities */ export const McpUiAppCapabilitiesSchema = z.object({ - /** @description Experimental features (structure TBD). */ + /** @description Experimental features keyed by identifier. */ experimental: z - .object({}) + .record( + z.string(), + z + .record(z.string(), z.any()) + .describe("Experimental features keyed by identifier."), + ) .optional() - .describe("Experimental features (structure TBD)."), + .describe("Experimental features keyed by identifier."), /** @description App exposes MCP-style tools that the host can call. */ tools: z .object({ @@ -680,7 +721,6 @@ export const McpUiToolVisibilitySchema = z export const McpUiToolMetaSchema = z.object({ /** * URI of the UI resource to display for this tool, if any. - * This is converted to `_meta["ui/resourceUri"]`. * * @example * ```ts @@ -699,6 +739,17 @@ export const McpUiToolMetaSchema = z.object({ .describe( 'Who can access this tool. Default: ["model", "app"]\n- "model": Tool visible to and callable by the agent\n- "app": Tool callable by the app from this server only', ), + /** + * `csp` belongs on the UI **resource** (see {@link McpUiResourceMeta}), + * not the tool. Hosts read it from the `resources/read` content item + * (with `resources/list` entry as fallback) and ignore it here. + */ + csp: z.never().optional(), + /** + * `permissions` belongs on the UI **resource** (see {@link McpUiResourceMeta}), + * not the tool. Hosts ignore it here. + */ + permissions: z.never().optional(), }); /** diff --git a/src/interop-v1.test.ts b/src/interop-v1.test.ts new file mode 100644 index 0000000..31dbfa1 --- /dev/null +++ b/src/interop-v1.test.ts @@ -0,0 +1,379 @@ +/** + * Cross-version interop against the *published* 1.x package. + * + * `ext-apps-v1` is an npm alias for `@modelcontextprotocol/ext-apps@1.7.5` + * (built on `@modelcontextprotocol/sdk` 1.x). Each pairing wires a real + * `App` to a real `AppBridge` of the other major over an in-memory duplex, + * with the bridge fronting a real MCP `Client`+`McpServer` of its own SDK + * generation, and asserts the observable outcomes. Complements + * `wire-compat.test.ts`, which replays hand-shaped 1.x JSON instead. + */ +import { describe, it, expect, beforeAll, afterAll } from "bun:test"; +import { readFileSync } from "node:fs"; +import { + Client as ClientV2, + InMemoryTransport as InMemoryTransportV2, + ProtocolError, + type Transport, +} from "@modelcontextprotocol/client"; +import { EmptyResultSchema as EmptyResultSchemaV2 } from "@modelcontextprotocol/core"; +import { McpServer as McpServerV2 } from "@modelcontextprotocol/server"; +import { Client as ClientV1 } from "@modelcontextprotocol/sdk/client/index.js"; +import { InMemoryTransport as InMemoryTransportV1 } from "@modelcontextprotocol/sdk/inMemory.js"; +import { McpServer as McpServerV1 } from "@modelcontextprotocol/sdk/server/mcp.js"; +import { Protocol as ProtocolV1 } from "@modelcontextprotocol/sdk/shared/protocol.js"; +import { + EmptyResultSchema as EmptyResultSchemaV1, + McpError, +} from "@modelcontextprotocol/sdk/types.js"; +import { App as AppV1 } from "ext-apps-v1"; +import { AppBridge as AppBridgeV1 } from "ext-apps-v1/app-bridge"; +import { z } from "zod/v4"; + +import { App as AppV2 } from "./app.js"; +import { AppBridge as AppBridgeV2 } from "./app-bridge.js"; + +const flush = () => new Promise((resolve) => setTimeout(resolve, 5)); + +/** In-memory duplex. Structurally a `Transport` for both SDK generations. */ +function createDuplex(): [Transport, Transport] { + const make = () => { + let closed = false; + const t: Transport & { peer?: typeof t } = { + async start() {}, + async send(message) { + // Serialize like a real transport so each side parses plain JSON. + t.peer?.onmessage?.(JSON.parse(JSON.stringify(message))); + }, + async close() { + if (closed) return; + closed = true; + t.onclose?.(); + await t.peer?.close(); + }, + }; + return t; + }; + const [a, b] = [make(), make()]; + a.peer = b; + b.peer = a; + return [a, b]; +} + +/** One SDK generation's MCP pieces, as used by the App side or the host side. */ +const sdkV1 = { + Client: ClientV1, + McpServer: McpServerV1, + InMemoryTransport: InMemoryTransportV1, + EmptyResultSchema: EmptyResultSchemaV1, + error: (code: number, message: string): Error => new McpError(code, message), +}; +const sdkV2 = { + Client: ClientV2, + McpServer: McpServerV2, + InMemoryTransport: InMemoryTransportV2, + EmptyResultSchema: EmptyResultSchemaV2, + error: (code: number, message: string): Error => + new ProtocolError(code, message), +}; + +const pairings = [ + { + name: "2.x App with 1.x AppBridge (sdk 1.x host)", + App: AppV2 as any, + AppBridge: AppBridgeV1 as any, + view: sdkV2, + host: sdkV1, + // sdk 1.x reports a Zod params failure as InternalError. + invalidParamsCode: -32603, + // sdk 1.x forwards a handler-thrown -32002 unchanged. + handlerThrown32002Code: -32002, + // McpServer 1.x answers an unknown tool with an isError result. + unknownToolRejects: false, + }, + { + name: "1.x App with 2.x AppBridge (sdk 2.x host)", + App: AppV1 as any, + AppBridge: AppBridgeV2 as any, + view: sdkV1, + host: sdkV2, + invalidParamsCode: -32602, + // SDK 2.x never emits -32002 on the wire (see wire-compat.test.ts). + handlerThrown32002Code: -32602, + // McpServer 2.x answers an unknown tool with a JSON-RPC error. + unknownToolRejects: true, + }, +]; + +const hostInfo = { name: "TestHost", version: "9.9.9" }; +const appInfo = { name: "TestView", version: "1.2.3" }; +const hostCapabilities = { + openLinks: {}, + serverTools: {}, + serverResources: {}, + logging: {}, + updateModelContext: {}, +}; +const hostContext = { theme: "dark", displayMode: "inline", locale: "en-US" }; + +it("pits 2.x against the published 1.x package, not against itself", () => { + const v1PackageJson = JSON.parse( + readFileSync( + new URL("../../package.json", import.meta.resolve("ext-apps-v1")), + "utf8", + ), + ); + expect(v1PackageJson).toMatchObject({ + name: "@modelcontextprotocol/ext-apps", + version: "1.7.5", + }); + // 1.x classes extend the sdk-1 Protocol; 2.x classes do not. + expect(AppV1.prototype).toBeInstanceOf(ProtocolV1); + expect(AppBridgeV1.prototype).toBeInstanceOf(ProtocolV1); + expect(AppV2.prototype).not.toBeInstanceOf(ProtocolV1); + expect(AppBridgeV2.prototype).not.toBeInstanceOf(ProtocolV1); +}); + +// The tests in each pairing share one connected App/AppBridge fixture and run +// in file order (bun does not randomize); later tests assume earlier ones +// left the pair connected. +describe.each(pairings)("$name", (pairing) => { + const { view, host } = pairing; + let server: any, client: any, bridge: any, app: any; + const events: string[] = []; + const record = (name: string) => (params?: unknown) => { + events.push(`${name}:${JSON.stringify(params ?? null)}`); + }; + const drain = () => events.splice(0); + // Captured inside oninitialized: the bridge must have processed + // ui/initialize before ui/notifications/initialized arrives. + let appVersionAtInitialized: unknown = "not-fired"; + let hostAbortReason: unknown; + + beforeAll(async () => { + server = new host.McpServer({ name: "TestServer", version: "1.0.0" }); + server.registerTool( + "echo", + { inputSchema: z.object({ a: z.number() }) }, + async ({ a }: { a: number }) => ({ + content: [{ type: "text", text: `echo ${a}` }], + }), + ); + server.registerTool("boom", { inputSchema: z.object({}) }, async () => { + throw new Error("tool exploded"); + }); + server.registerResource( + "res", + "test://res", + { mimeType: "text/plain" }, + async (uri: URL) => ({ + contents: [{ uri: uri.href, mimeType: "text/plain", text: "hello" }], + }), + ); + const [clientTransport, serverTransport] = + host.InMemoryTransport.createLinkedPair(); + await server.connect(serverTransport); + client = new host.Client({ name: "HostOuterClient", version: "1.0.0" }); + await client.connect(clientTransport); + + bridge = new pairing.AppBridge(client, hostInfo, hostCapabilities, { + hostContext, + }); + app = new pairing.App( + appInfo, + { tools: { listChanged: true } }, + { + autoResize: false, + }, + ); + bridge.oninitialized = () => { + appVersionAtInitialized = bridge.getAppVersion(); + }; + for (const name of ["onsizechange", "onloggingmessage"]) { + bridge[name] = record(`bridge.${name}`); + } + for (const name of ["onmessage", "onupdatemodelcontext"]) { + bridge[name] = async (params: unknown) => { + record(`bridge.${name}`)(params); + return {}; + }; + } + bridge.onopenlink = (params: { url: string }, extra: any) => { + record("bridge.onopenlink")(params); + if (params.url !== "https://slow") return {}; + // Hang until the view cancels; sdk 1.x passes `extra.signal`, 2.x `extra.mcpReq.signal`. + const signal: AbortSignal = extra.signal ?? extra.mcpReq.signal; + return new Promise((_resolve, reject) => { + signal.addEventListener("abort", () => { + hostAbortReason = signal.reason; + reject(new Error("aborted")); + }); + }); + }; + for (const name of [ + "ontoolinput", + "ontoolresult", + "ontoolcancelled", + "onhostcontextchanged", + ]) { + app[name] = record(`app.${name}`); + } + app.onteardown = async (params: unknown) => { + record("app.onteardown")(params); + return {}; + }; + }); + + afterAll(async () => { + await app?.close().catch(() => {}); + await bridge?.close().catch(() => {}); + await client?.close().catch(() => {}); + await server?.close().catch(() => {}); + }); + + it("completes ui/initialize and delivers initialized in order", async () => { + const [appTransport, bridgeTransport] = createDuplex(); + // Tap the raw ui/initialize result so an additive key on the 2.x side + // (which the getters below would not surface) still fails here. + let initializeResult: unknown; + const send = bridgeTransport.send.bind(bridgeTransport); + bridgeTransport.send = async (message, options) => { + if ("result" in message && "id" in message && message.id === 0) { + initializeResult = message.result; + } + await send(message, options); + }; + await bridge.connect(bridgeTransport); + await app.connect(appTransport); + await flush(); + + expect(app.getHostContext()).toEqual(hostContext); + expect(app.getHostCapabilities()).toEqual(hostCapabilities); + expect(app.getHostVersion()).toEqual(hostInfo); + expect(bridge.getAppCapabilities()).toEqual({ + tools: { listChanged: true }, + }); + expect(appVersionAtInitialized).toEqual(appInfo); + expect(initializeResult).toEqual({ + protocolVersion: "2026-01-26", + hostCapabilities, + hostInfo, + hostContext, + }); + }); + + it("delivers host-to-view notifications", async () => { + bridge.sendToolInput({ arguments: { location: "NYC" } }); + bridge.sendToolResult({ content: [{ type: "text", text: "sunny" }] }); + bridge.sendToolCancelled({ reason: "user" }); + bridge.setHostContext({ theme: "light" }); + await flush(); + + expect(drain()).toEqual([ + 'app.ontoolinput:{"arguments":{"location":"NYC"}}', + 'app.ontoolresult:{"content":[{"type":"text","text":"sunny"}]}', + 'app.ontoolcancelled:{"reason":"user"}', + 'app.onhostcontextchanged:{"theme":"light"}', + ]); + expect(app.getHostContext()).toEqual({ ...hostContext, theme: "light" }); + }); + + it("round-trips view-to-host requests and notifications", async () => { + const message = { role: "user", content: [{ type: "text", text: "hi" }] }; + expect(await app.sendMessage(message)).toEqual({}); + expect(await app.openLink({ url: "https://example.com" })).toEqual({}); + expect(await app.requestDisplayMode({ mode: "fullscreen" })).toEqual({ + mode: "inline", + }); + bridge.onrequestdisplaymode = async (params: { mode: string }) => params; + expect(await app.requestDisplayMode({ mode: "fullscreen" })).toEqual({ + mode: "fullscreen", + }); + const context = { content: [{ type: "text", text: "ctx" }] }; + expect(await app.updateModelContext(context)).toEqual({}); + await app.sendLog({ level: "info", data: { m: "hello" } }); + await app.sendSizeChanged({ width: 320, height: 240 }); + await flush(); + + expect(drain()).toEqual([ + `bridge.onmessage:${JSON.stringify(message)}`, + 'bridge.onopenlink:{"url":"https://example.com"}', + `bridge.onupdatemodelcontext:${JSON.stringify(context)}`, + 'bridge.onloggingmessage:{"level":"info","data":{"m":"hello"}}', + 'bridge.onsizechange:{"width":320,"height":240}', + ]); + }); + + it("proxies tools/call and resources/read to the real MCP server", async () => { + expect( + await app.callServerTool({ name: "echo", arguments: { a: 1 } }), + ).toEqual({ content: [{ type: "text", text: "echo 1" }] }); + expect( + await app.callServerTool({ name: "boom", arguments: {} }), + ).toMatchObject({ + isError: true, + content: [{ type: "text", text: "tool exploded" }], + }); + const unknown = app.callServerTool({ name: "nope", arguments: {} }); + if (pairing.unknownToolRejects) { + await expect(unknown).rejects.toMatchObject({ code: -32602 }); + } else { + expect(await unknown).toMatchObject({ isError: true }); + } + expect(await app.readServerResource({ uri: "test://res" })).toEqual({ + contents: [{ uri: "test://res", mimeType: "text/plain", text: "hello" }], + }); + }); + + it("propagates JSON-RPC errors with the expected codes", async () => { + const raw = (method: string, params: unknown) => + app.request({ method, params }, view.EmptyResultSchema); + await expect(raw("ui/does-not-exist", {})).rejects.toMatchObject({ + code: -32601, + }); + await expect(raw("ui/open-link", { url: 42 })).rejects.toMatchObject({ + code: pairing.invalidParamsCode, + }); + bridge.onreadresource = async () => { + throw host.error(-32002, "Resource not found (host-thrown -32002)"); + }; + const notFound = app.readServerResource({ uri: "test://missing" }); + await expect(notFound).rejects.toMatchObject({ + code: pairing.handlerThrown32002Code, + message: expect.stringContaining( + "Resource not found (host-thrown -32002)", + ), + }); + }); + + it("cancels an in-flight request via AbortSignal on both ends", async () => { + const controller = new AbortController(); + const pending = app.openLink( + { url: "https://slow" }, + { signal: controller.signal }, + ); + await flush(); + controller.abort("user-cancelled"); + await expect(pending).rejects.toMatchObject({ + message: expect.stringContaining("user-cancelled"), + }); + await flush(); + expect(String(hostAbortReason)).toContain("user-cancelled"); + drain(); + }); + + it("tears down, then closes both ends", async () => { + expect(await bridge.teardownResource({})).toEqual({}); + expect(drain()).toEqual(["app.onteardown:{}"]); + + const closed: string[] = []; + app.onclose = () => closed.push("app"); + bridge.onclose = () => closed.push("bridge"); + await app.close(); + await flush(); + expect(closed.sort()).toEqual(["app", "bridge"]); + await expect(app.openLink({ url: "https://after-close" })).rejects.toThrow( + "Not connected", + ); + }); +}); diff --git a/src/legacy-handlers.test.ts b/src/legacy-handlers.test.ts new file mode 100644 index 0000000..0ef36d6 --- /dev/null +++ b/src/legacy-handlers.test.ts @@ -0,0 +1,145 @@ +import { afterEach, beforeEach, describe, expect, it, spyOn } from "bun:test"; +import { InMemoryTransport, Server } from "@modelcontextprotocol/server"; +import { z } from "zod/v4"; + +import { App } from "./app.js"; +import { AppBridge } from "./app-bridge.js"; +import { + McpUiInitializeRequestSchema, + McpUiInitializeResultSchema, + McpUiInitializedNotificationSchema, + McpUiResourceTeardownRequestSchema, + McpUiToolInputNotificationSchema, + McpUiSizeChangedNotificationSchema, + McpUiOpenLinkRequestSchema, +} from "./types.js"; + +const CustomRequestSchema = z.object({ + method: z.literal("test/echo"), + params: z.object({ text: z.string() }), +}); + +const CustomNotificationSchema = z.object({ + method: z.literal("test/ping"), + params: z.object({ n: z.number() }), +}); + +let warn: ReturnType; +beforeEach(() => { + warn = spyOn(console, "warn").mockImplementation(() => {}); +}); +afterEach(() => warn.mockRestore()); + +describe("1.x setRequestHandler(Schema, handler) on App", () => { + it("registers a custom request and hands the handler the whole message plus a 1.x extra", async () => { + const app = new App({ name: "a", version: "1" }, {}, { autoResize: false }); + const server = new Server( + { name: "s", version: "1" }, + { capabilities: {} }, + ); + server.setRequestHandler( + "ui/initialize", + { + params: McpUiInitializeRequestSchema.shape.params, + result: McpUiInitializeResultSchema, + }, + () => ({ + protocolVersion: "2026-01-26", + hostCapabilities: {}, + hostInfo: { name: "h", version: "1" }, + hostContext: {}, + }), + ); + server.setNotificationHandler( + "ui/notifications/initialized", + { params: McpUiInitializedNotificationSchema.shape.params }, + () => {}, + ); + + let seen: unknown; + let seenExtra: { signal: AbortSignal; requestId: unknown } | undefined; + app.setRequestHandler(CustomRequestSchema, (request, extra) => { + seen = request; + seenExtra = extra; + return { echoed: request.params.text }; + }); + + const [at, st] = InMemoryTransport.createLinkedPair(); + await server.connect(st); + await app.connect(at); + + const result = await server.request( + { method: "test/echo", params: { text: "hi" } }, + z.object({ echoed: z.string() }), + ); + + expect(result).toEqual({ echoed: "hi" }); + expect(seen).toEqual({ method: "test/echo", params: { text: "hi" } }); + expect(seenExtra?.signal).toBeInstanceOf(AbortSignal); + expect(seenExtra?.requestId).toBeDefined(); + expect(warn).toHaveBeenCalledTimes(1); + expect(String(warn.mock.calls[0][0])).toContain( + 'setRequestHandler("test/echo", { params: Schema.shape.params }, handler)', + ); + + await app.close(); + await server.close(); + }); + + it("still throws for a method an on* setter already owns", () => { + const app = new App({ name: "a", version: "1" }, {}, { autoResize: false }); + app.onteardown = async () => ({}); + expect(() => + app.setRequestHandler( + McpUiResourceTeardownRequestSchema, + async () => ({}), + ), + ).toThrow(/already registered/); + }); + + it("still throws for an event-mapped notification", () => { + const app = new App({ name: "a", version: "1" }, {}, { autoResize: false }); + app.ontoolinput = () => {}; + expect(() => + app.setNotificationHandler(McpUiToolInputNotificationSchema, () => {}), + ).toThrow(/already registered/); + }); +}); + +describe("1.x setNotificationHandler(Schema, handler) on AppBridge", () => { + it("registers a custom notification and hands the handler the whole message", async () => { + const bridge = new AppBridge(null, { name: "h", version: "1" }, {}); + // A bare Server stands in for the View: unlike Client, connect() sends no + // MCP initialize, matching what a real App does on this channel. + const view = new Server({ name: "v", version: "1" }, { capabilities: {} }); + let seen: unknown; + bridge.setNotificationHandler(CustomNotificationSchema, (n) => { + seen = n; + }); + + const [bt, vt] = InMemoryTransport.createLinkedPair(); + await bridge.connect(bt); + await view.connect(vt); + await view.notification({ method: "test/ping", params: { n: 3 } }); + await new Promise((r) => setTimeout(r, 10)); + + expect(seen).toEqual({ method: "test/ping", params: { n: 3 } }); + await view.close(); + await bridge.close(); + }); + + it("still throws for a method an on* setter already owns", () => { + const bridge = new AppBridge(null, { name: "h", version: "1" }, {}); + bridge.onsizechange = () => {}; + expect(() => + bridge.setNotificationHandler( + McpUiSizeChangedNotificationSchema, + () => {}, + ), + ).toThrow(/already registered/); + bridge.onopenlink = async () => ({}); + expect(() => + bridge.setRequestHandler(McpUiOpenLinkRequestSchema, async () => ({})), + ).toThrow(/already registered/); + }); +}); diff --git a/src/legacy-handlers.ts b/src/legacy-handlers.ts new file mode 100644 index 0000000..237b8eb --- /dev/null +++ b/src/legacy-handlers.ts @@ -0,0 +1,121 @@ +import type { BaseContext, RequestId } from "@modelcontextprotocol/client"; +import type { ZodLiteral, ZodObject, ZodType } from "zod/v4"; + +/** + * A whole-message Zod schema (`method` literal plus `params`), as accepted by + * the 1.x `setRequestHandler(Schema, handler)` forms. + */ +export type LegacyMethodSchema = ZodObject<{ + method: ZodLiteral; + params: ZodType; +}>; + +/** + * The `extra` argument 1.x request handlers received. + * + * @deprecated Use the 2.x `BaseContext` (`extra.mcpReq.signal`, `extra.mcpReq.id`). + */ +export type LegacyRequestHandlerExtra = { + signal: AbortSignal; + requestId: RequestId; + sessionId?: string; + _meta?: BaseContext["mcpReq"]["_meta"]; + sendRequest: BaseContext["mcpReq"]["send"]; + sendNotification: BaseContext["mcpReq"]["notify"]; + authInfo?: NonNullable["authInfo"]; +}; + +/** @deprecated Use `setRequestHandler("method", { params, result }, (params, ctx) => …)`. */ +export type LegacyRequestHandler = ( + request: S["_output"], + extra: LegacyRequestHandlerExtra, +) => unknown; + +/** @deprecated Use `setNotificationHandler("method", { params }, (params) => …)`. */ +export type LegacyNotificationHandler = ( + notification: S["_output"], +) => void | Promise; + +/** + * `setRequestHandler` with the 1.x `(Schema, handler)` form kept as a + * deprecated overload next to the 2.x forms in `Modern`. + */ +export type LegacyRequestHandlerSetter = Modern & { + /** + * @deprecated 1.x form. Pass the method name and `{ params }` instead; + * removed in 3.0. + */ + ( + schema: S, + handler: LegacyRequestHandler, + ): void; +}; + +/** `setNotificationHandler` counterpart of {@link LegacyRequestHandlerSetter}. */ +export type LegacyNotificationHandlerSetter = Modern & { + /** + * @deprecated 1.x form. Pass the method name and `{ params }` instead; + * removed in 3.0. + */ + ( + schema: S, + handler: LegacyNotificationHandler, + ): void; +}; + +/** + * Arguments for the 2.x three-argument `setRequestHandler` / + * `setNotificationHandler` form. + */ +type ModernArgs = [ + method: string, + schemas: { params: ZodType }, + handler: (params: unknown, ctx: BaseContext) => unknown, +]; + +const warned = new Set(); + +/** + * Translate a 1.x `(Schema, handler)` registration into the 2.x + * `(method, { params }, handler)` form, or return `undefined` when the call + * is already in the 2.x form. The 1.x handler receives the reassembled + * `{ method, params }` message and, for requests, a 1.x-shaped `extra`. + */ +export function toModernArgs( + kind: "request" | "notification", + args: unknown[], +): ModernArgs | undefined { + const [first, handler] = args; + const shape = (first as Partial | undefined)?.shape; + if (typeof shape?.method?.value !== "string") return undefined; + const method = shape.method.value; + const setter = + kind === "request" ? "setRequestHandler" : "setNotificationHandler"; + if (!warned.has(setter)) { + warned.add(setter); + console.warn( + `[ext-apps] ${setter}(Schema, handler) is deprecated; use ` + + `${setter}("${method}", { params: Schema.shape.params }, handler).`, + ); + } + const call = handler as (...a: unknown[]) => unknown; + return [ + method, + { params: shape.params }, + kind === "request" + ? (params, ctx) => call({ method, params }, legacyExtra(ctx)) + : (params) => call({ method, params }), + ]; +} + +function legacyExtra(ctx: BaseContext): LegacyRequestHandlerExtra { + return { + signal: ctx.mcpReq.signal, + requestId: ctx.mcpReq.id, + sessionId: ctx.sessionId, + _meta: ctx.mcpReq._meta, + sendRequest: ctx.mcpReq.send, + sendNotification: ctx.mcpReq.notify, + authInfo: ctx.http?.authInfo, + }; +} diff --git a/src/message-transport.test.ts b/src/message-transport.test.ts new file mode 100644 index 0000000..e2518cc --- /dev/null +++ b/src/message-transport.test.ts @@ -0,0 +1,390 @@ +import { describe, it, expect, beforeEach, afterEach, mock } from "bun:test"; +import type { JSONRPCMessage } from "@modelcontextprotocol/client"; + +import { PostMessageTransport } from "./message-transport.js"; + +/** + * Minimal `window` stub for bun's DOM-less test environment. + * + * Captures listeners registered via `addEventListener` so tests can dispatch + * fake `MessageEvent`-like objects directly. We deliberately avoid pulling in + * jsdom/happy-dom β€” this file tests the transport's contract, not the browser. + */ +type Listener = (event: MessageEvent) => void; + +function createFakeWindow() { + const listeners = new Map>(); + return { + addEventListener(type: string, listener: Listener) { + if (!listeners.has(type)) listeners.set(type, new Set()); + listeners.get(type)!.add(listener); + }, + removeEventListener(type: string, listener: Listener) { + listeners.get(type)?.delete(listener); + }, + /** Test helper: invoke all listeners for `type` with the given event. */ + dispatch(type: string, event: unknown) { + listeners.get(type)?.forEach((l) => l(event as MessageEvent)); + }, + /** Test helper: how many listeners are registered for `type`? */ + listenerCount(type: string) { + return listeners.get(type)?.size ?? 0; + }, + }; +} + +/** + * A valid JSON-RPC request payload. Used by most happy-path tests. + * Kept deliberately minimal β€” we care that *a* valid message is delivered, + * not about exercising every JSON-RPC shape (that's the schema's job). + */ +const validRequest: JSONRPCMessage = { + jsonrpc: "2.0", + id: 1, + method: "ping", +}; + +describe("PostMessageTransport", () => { + let fakeWindow: ReturnType; + let trustedSource: object; + let untrustedSource: object; + + /** Stand-in for the target window (e.g. window.parent or iframe.contentWindow). */ + let targetPostMessage: ReturnType; + let eventTarget: { postMessage: typeof targetPostMessage }; + + // The transport logs liberally at debug/error level. Silence during tests + // so failures are readable; restore afterwards so we don't leak state. + let restoreConsole: () => void; + + beforeEach(() => { + fakeWindow = createFakeWindow(); + (globalThis as { window?: unknown }).window = fakeWindow; + + // Distinct object identities β€” the transport compares with `!==`. + trustedSource = { id: "trusted" }; + untrustedSource = { id: "untrusted" }; + + targetPostMessage = mock(() => {}); + eventTarget = { postMessage: targetPostMessage }; + + const origDebug = console.debug; + const origError = console.error; + console.debug = () => {}; + console.error = () => {}; + restoreConsole = () => { + console.debug = origDebug; + console.error = origError; + }; + }); + + afterEach(() => { + restoreConsole(); + delete (globalThis as { window?: unknown }).window; + }); + + /** Create and start a transport wired to the shared fakes. */ + async function createStartedTransport() { + const transport = new PostMessageTransport( + eventTarget as unknown as Window, + trustedSource as MessageEventSource, + ); + await transport.start(); + return transport; + } + + // ========================================================================== + // Source validation β€” the security boundary at this layer. + // The transport validates `event.source` (window identity), not `event.origin`. + // Origin checks live in the sandbox proxy relay between the two endpoints + // (see examples/basic-host/src/sandbox.ts). Here, source===contentWindow is + // the narrower check; the app side can't know its sandbox's origin anyway. + // ========================================================================== + describe("source validation", () => { + it("delivers messages from the configured eventSource", async () => { + const transport = await createStartedTransport(); + const received: JSONRPCMessage[] = []; + transport.onmessage = (msg) => received.push(msg); + + fakeWindow.dispatch("message", { + source: trustedSource, + data: validRequest, + }); + + expect(received).toEqual([validRequest]); + }); + + it("drops messages from a different source", async () => { + const transport = await createStartedTransport(); + const received: JSONRPCMessage[] = []; + const errors: Error[] = []; + transport.onmessage = (msg) => received.push(msg); + transport.onerror = (err) => errors.push(err); + + fakeWindow.dispatch("message", { + source: untrustedSource, + data: validRequest, + }); + + // The message is silently dropped β€” neither delivered nor surfaced as + // an error. An attacker flooding us with forged messages should not be + // able to DoS the error handler. + expect(received).toEqual([]); + expect(errors).toEqual([]); + }); + + it("drops messages with a null source", async () => { + // Some browser-injected messages (extensions, devtools) arrive with + // source === null. These must not reach the protocol layer. + const transport = await createStartedTransport(); + const received: JSONRPCMessage[] = []; + transport.onmessage = (msg) => received.push(msg); + + fakeWindow.dispatch("message", { + source: null, + data: validRequest, + }); + + expect(received).toEqual([]); + }); + + it("continues delivering trusted messages after dropping an untrusted one", async () => { + // Regression guard: a rejected message must not break the listener or + // close the transport. + const transport = await createStartedTransport(); + const received: JSONRPCMessage[] = []; + transport.onmessage = (msg) => received.push(msg); + + fakeWindow.dispatch("message", { + source: untrustedSource, + data: validRequest, + }); + fakeWindow.dispatch("message", { + source: trustedSource, + data: validRequest, + }); + + expect(received).toEqual([validRequest]); + }); + }); + + // ========================================================================== + // Message format validation. + // Three paths: valid β†’ onmessage, non-JSON-RPC β†’ silent, malformed β†’ onerror. + // ========================================================================== + describe("message format validation", () => { + it("delivers valid JSON-RPC requests via onmessage", async () => { + const transport = await createStartedTransport(); + const received: JSONRPCMessage[] = []; + transport.onmessage = (msg) => received.push(msg); + + fakeWindow.dispatch("message", { + source: trustedSource, + data: { jsonrpc: "2.0", id: 42, method: "tools/call" }, + }); + + expect(received).toHaveLength(1); + expect(received[0]).toMatchObject({ id: 42, method: "tools/call" }); + }); + + it("delivers valid JSON-RPC notifications via onmessage", async () => { + const transport = await createStartedTransport(); + const received: JSONRPCMessage[] = []; + transport.onmessage = (msg) => received.push(msg); + + fakeWindow.dispatch("message", { + source: trustedSource, + data: { jsonrpc: "2.0", method: "notifications/initialized" }, + }); + + expect(received).toHaveLength(1); + expect(received[0]).toMatchObject({ + method: "notifications/initialized", + }); + }); + + it("silently ignores non-JSON-RPC payloads", async () => { + // Real iframes receive all sorts of ambient postMessage traffic: + // React DevTools, browser extensions, ad frames. These must not crash + // the transport or surface as protocol errors. + const transport = await createStartedTransport(); + const received: JSONRPCMessage[] = []; + const errors: Error[] = []; + transport.onmessage = (msg) => received.push(msg); + transport.onerror = (err) => errors.push(err); + + fakeWindow.dispatch("message", { + source: trustedSource, + data: { type: "react-devtools-hook", payload: {} }, + }); + fakeWindow.dispatch("message", { source: trustedSource, data: "hello" }); + fakeWindow.dispatch("message", { source: trustedSource, data: null }); + fakeWindow.dispatch("message", { source: trustedSource, data: 42 }); + + expect(received).toEqual([]); + expect(errors).toEqual([]); + }); + + it("calls onerror for malformed messages claiming to be JSON-RPC", async () => { + // `jsonrpc: "2.0"` but missing required fields β€” this IS a protocol + // violation worth surfacing, unlike ambient noise. + const transport = await createStartedTransport(); + const received: JSONRPCMessage[] = []; + const errors: Error[] = []; + transport.onmessage = (msg) => received.push(msg); + transport.onerror = (err) => errors.push(err); + + fakeWindow.dispatch("message", { + source: trustedSource, + data: { jsonrpc: "2.0" }, // no id/method/result β€” invalid + }); + + expect(received).toEqual([]); + expect(errors).toHaveLength(1); + expect(errors[0]).toBeInstanceOf(Error); + }); + + it("does not throw when onerror is unset and a malformed message arrives", async () => { + const transport = await createStartedTransport(); + transport.onmessage = () => {}; + // onerror deliberately left unset + + expect(() => + fakeWindow.dispatch("message", { + source: trustedSource, + data: { jsonrpc: "2.0" }, + }), + ).not.toThrow(); + }); + + it("does not throw when onmessage is unset and a valid message arrives", async () => { + await createStartedTransport(); + // onmessage deliberately left unset β€” may happen briefly during wiring + + expect(() => + fakeWindow.dispatch("message", { + source: trustedSource, + data: validRequest, + }), + ).not.toThrow(); + }); + }); + + // ========================================================================== + // send() + // ========================================================================== + describe("send()", () => { + it("posts the message to the configured eventTarget with '*' origin", async () => { + const transport = await createStartedTransport(); + + const msg: JSONRPCMessage = { + jsonrpc: "2.0", + id: 7, + method: "ui/initialize", + }; + await transport.send(msg); + + expect(targetPostMessage).toHaveBeenCalledTimes(1); + expect(targetPostMessage).toHaveBeenCalledWith(msg, "*"); + }); + + it("posts multiple messages in order", async () => { + const transport = await createStartedTransport(); + + const a: JSONRPCMessage = { jsonrpc: "2.0", id: 1, method: "a" }; + const b: JSONRPCMessage = { jsonrpc: "2.0", id: 2, method: "b" }; + await transport.send(a); + await transport.send(b); + + expect(targetPostMessage).toHaveBeenCalledTimes(2); + expect(targetPostMessage.mock.calls[0][0]).toEqual(a); + expect(targetPostMessage.mock.calls[1][0]).toEqual(b); + }); + }); + + // ========================================================================== + // Lifecycle: start() / close() + // ========================================================================== + describe("lifecycle", () => { + it("start() registers a message listener on window", async () => { + const transport = new PostMessageTransport( + eventTarget as unknown as Window, + trustedSource as MessageEventSource, + ); + + expect(fakeWindow.listenerCount("message")).toBe(0); + await transport.start(); + expect(fakeWindow.listenerCount("message")).toBe(1); + }); + + it("close() removes the message listener", async () => { + const transport = await createStartedTransport(); + + expect(fakeWindow.listenerCount("message")).toBe(1); + await transport.close(); + expect(fakeWindow.listenerCount("message")).toBe(0); + }); + + it("messages dispatched after close() are not delivered", async () => { + const transport = await createStartedTransport(); + const received: JSONRPCMessage[] = []; + transport.onmessage = (msg) => received.push(msg); + + await transport.close(); + fakeWindow.dispatch("message", { + source: trustedSource, + data: validRequest, + }); + + expect(received).toEqual([]); + }); + + it("close() invokes onclose when set", async () => { + const transport = await createStartedTransport(); + const onclose = mock(() => {}); + transport.onclose = onclose; + + await transport.close(); + + expect(onclose).toHaveBeenCalledTimes(1); + }); + + it("close() does not throw when onclose is unset", async () => { + const transport = await createStartedTransport(); + // onclose deliberately left unset + + expect(transport.close()).resolves.toBeUndefined(); + }); + + it("two transports listen independently", async () => { + // Host scenario: multiple iframes, each with its own transport. + // Each transport must only accept messages from its own iframe. + const sourceA = { id: "iframe-a" }; + const sourceB = { id: "iframe-b" }; + + const transportA = new PostMessageTransport( + eventTarget as unknown as Window, + sourceA as unknown as MessageEventSource, + ); + const transportB = new PostMessageTransport( + eventTarget as unknown as Window, + sourceB as unknown as MessageEventSource, + ); + await transportA.start(); + await transportB.start(); + + const receivedA: JSONRPCMessage[] = []; + const receivedB: JSONRPCMessage[] = []; + transportA.onmessage = (msg) => receivedA.push(msg); + transportB.onmessage = (msg) => receivedB.push(msg); + + fakeWindow.dispatch("message", { source: sourceA, data: validRequest }); + + expect(receivedA).toHaveLength(1); + expect(receivedB).toHaveLength(0); + + await transportA.close(); + await transportB.close(); + }); + }); +}); diff --git a/src/message-transport.ts b/src/message-transport.ts index dded704..afc85e9 100644 --- a/src/message-transport.ts +++ b/src/message-transport.ts @@ -1,12 +1,11 @@ -import { +import { JSONRPCMessageSchema } from "@modelcontextprotocol/core"; +import type { JSONRPCMessage, - JSONRPCMessageSchema, MessageExtraInfo, -} from "@modelcontextprotocol/sdk/types.js"; -import { Transport, TransportSendOptions, -} from "@modelcontextprotocol/sdk/shared/transport.js"; +} from "@modelcontextprotocol/client"; +import { TOOL_INPUT_PARTIAL_METHOD } from "./spec.types.js"; /** * JSON-RPC transport using `window.postMessage` for iframe↔parent communication. @@ -123,7 +122,11 @@ export class PostMessageTransport implements Transport { * @param options - Optional send options (currently unused) */ async send(message: JSONRPCMessage, options?: TransportSendOptions) { - console.debug("Sending message", message); + // Skip debug log for high-frequency streaming notifications β€” these + // can fire dozens of times per second and flood the console. + if ((message as { method?: string }).method !== TOOL_INPUT_PARTIAL_METHOD) { + console.debug("Sending message", message); + } this.eventTarget.postMessage(message, "*"); } diff --git a/src/react/index.tsx b/src/react/index.tsx index e76e197..9693fb1 100644 --- a/src/react/index.tsx +++ b/src/react/index.tsx @@ -31,7 +31,7 @@ * } * ``` */ -export * from "./useApp"; -export * from "./useAutoResize"; -export * from "./useDocumentTheme"; -export * from "./useHostStyles"; +export * from "./useApp.js"; +export * from "./useAutoResize.js"; +export * from "./useDocumentTheme.js"; +export * from "./useHostStyles.js"; diff --git a/src/react/useApp.tsx b/src/react/useApp.tsx index d6dcfbb..a8e1a09 100644 --- a/src/react/useApp.tsx +++ b/src/react/useApp.tsx @@ -1,20 +1,27 @@ import { useEffect, useState } from "react"; -import { Implementation } from "@modelcontextprotocol/sdk/types.js"; -import { Client } from "@modelcontextprotocol/sdk/client"; -import { App, McpUiAppCapabilities, PostMessageTransport } from "../app"; -export * from "../app"; +import type { Implementation } from "@modelcontextprotocol/client"; +import { + App, + AppOptions, + McpUiAppCapabilities, + PostMessageTransport, +} from "../app.js"; +export * from "../app.js"; /** * Options for configuring the {@link useApp `useApp`} hook. * - * Note: This interface does NOT expose {@link App `App`} options like `autoResize`. - * The hook creates the `App` with default options (`autoResize: true`). If you - * need custom `App` options, create the `App` manually instead of using this hook. + * The `autoResize` and `strict` options are forwarded to the underlying + * {@link App `App`} instance. For other {@link AppOptions `AppOptions`}, + * create the `App` manually instead of using this hook. * * @see {@link useApp `useApp`} for the hook that uses these options * @see {@link useAutoResize `useAutoResize`} for manual auto-resize control with custom `App` options */ -export interface UseAppOptions { +export interface UseAppOptions extends Pick< + AppOptions, + "autoResize" | "strict" +> { /** App identification (name and version) */ appInfo: Implementation; /** @@ -121,6 +128,8 @@ export function useApp({ appInfo, capabilities, onAppCreated, + autoResize = true, + strict, }: UseAppOptions): AppState { const [app, setApp] = useState(null); const [isConnected, setIsConnected] = useState(false); @@ -128,6 +137,7 @@ export function useApp({ useEffect(() => { let mounted = true; + let appInstance: App | undefined; async function connect() { try { @@ -135,18 +145,24 @@ export function useApp({ window.parent, window.parent, ); - const app = new App(appInfo, capabilities); + appInstance = new App(appInfo, capabilities, { autoResize, strict }); // Register handlers BEFORE connecting - onAppCreated?.(app); + onAppCreated?.(appInstance); - await app.connect(transport); + await appInstance.connect(transport); - if (mounted) { - setApp(app); - setIsConnected(true); - setError(null); + if (!mounted) { + // Unmounted during the handshake (e.g. React StrictMode dev + // double-invoke). Close so the abandoned transport's window + // `message` listener doesn't keep receiving host postMessages + // alongside the second mount's instance. + void appInstance.close(); + return; } + setApp(appInstance); + setIsConnected(true); + setError(null); } catch (error) { if (mounted) { setApp(null); @@ -162,6 +178,7 @@ export function useApp({ return () => { mounted = false; + void appInstance?.close(); }; }, []); // Intentionally not including options to avoid reconnection diff --git a/src/react/useAutoResize.ts b/src/react/useAutoResize.ts index 78217d6..66af07e 100644 --- a/src/react/useAutoResize.ts +++ b/src/react/useAutoResize.ts @@ -1,5 +1,5 @@ import { useEffect, RefObject } from "react"; -import { App } from "../app"; +import { App } from "../app.js"; /** * React hook that automatically reports UI size changes to the host. diff --git a/src/react/useDocumentTheme.ts b/src/react/useDocumentTheme.ts index 2fdfcc2..3dc851e 100644 --- a/src/react/useDocumentTheme.ts +++ b/src/react/useDocumentTheme.ts @@ -1,6 +1,6 @@ import { useEffect, useState } from "react"; -import { getDocumentTheme } from "../styles"; -import { McpUiTheme } from "../types"; +import { getDocumentTheme } from "../styles.js"; +import { McpUiTheme } from "../types.js"; /** * React hook that provides the current document theme reactively. diff --git a/src/react/useHostStyles.ts b/src/react/useHostStyles.ts index 72247f7..d8376a0 100644 --- a/src/react/useHostStyles.ts +++ b/src/react/useHostStyles.ts @@ -1,11 +1,11 @@ import { useEffect, useRef } from "react"; -import { App } from "../app"; +import { App } from "../app.js"; import { applyDocumentTheme, applyHostFonts, applyHostStyleVariables, -} from "../styles"; -import { McpUiHostContext } from "../types"; +} from "../styles.js"; +import { McpUiHostContext } from "../types.js"; /** * React hook that applies host style variables and theme as CSS custom properties. @@ -77,7 +77,7 @@ export function useHostStyleVariables( return; } - app.onhostcontextchanged = (params) => { + const listener = (params: McpUiHostContext) => { if (params.theme) { applyDocumentTheme(params.theme); } @@ -85,6 +85,8 @@ export function useHostStyleVariables( applyHostStyleVariables(params.styles.variables); } }; + app.addEventListener("hostcontextchanged", listener); + return () => app.removeEventListener("hostcontextchanged", listener); }, [app]); } @@ -145,11 +147,13 @@ export function useHostFonts( return; } - app.onhostcontextchanged = (params) => { + const listener = (params: McpUiHostContext) => { if (params.styles?.css?.fonts) { applyHostFonts(params.styles.css.fonts); } }; + app.addEventListener("hostcontextchanged", listener); + return () => app.removeEventListener("hostcontextchanged", listener); }, [app]); } diff --git a/src/server/index.examples.ts b/src/server/index.examples.ts index d583ae8..9ceebce 100644 --- a/src/server/index.examples.ts +++ b/src/server/index.examples.ts @@ -9,17 +9,14 @@ import * as crypto from "node:crypto"; import * as fs from "node:fs/promises"; -import type { - McpServer, - ToolCallback, - ReadResourceCallback, -} from "@modelcontextprotocol/sdk/server/mcp.js"; +import type { McpServer, ToolCallback } from "@modelcontextprotocol/server"; import { z } from "zod"; import { registerAppTool, registerAppResource, getUiCapability, RESOURCE_MIME_TYPE, + type ReadResourceCallback, } from "./index.js"; // Stubs for external functions used in examples @@ -74,7 +71,7 @@ function registerAppTool_basicUsage(server: McpServer) { { title: "Get Weather", description: "Get current weather for a location", - inputSchema: { location: z.string() }, + inputSchema: z.object({ location: z.string() }), _meta: { ui: { resourceUri: "ui://weather/view.html" }, }, @@ -122,7 +119,7 @@ function registerAppTool_appOnlyVisibility(server: McpServer) { "update-quantity", { description: "Update item quantity in cart", - inputSchema: { itemId: z.string(), quantity: z.number() }, + inputSchema: z.object({ itemId: z.string(), quantity: z.number() }), _meta: { ui: { resourceUri: "ui://shop/cart.html", diff --git a/src/server/index.test.ts b/src/server/index.test.ts index 1853cc0..489d0b0 100644 --- a/src/server/index.test.ts +++ b/src/server/index.test.ts @@ -6,8 +6,14 @@ import { RESOURCE_MIME_TYPE, getUiCapability, EXTENSION_ID, -} from "./index"; -import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; +} from "./index.js"; +import { + InMemoryTransport, + McpServer as RealMcpServer, + type McpServer, +} from "@modelcontextprotocol/server"; +import { Client } from "@modelcontextprotocol/client"; +import { z } from "zod/v4"; describe("registerAppTool", () => { it("should pass through config to server.registerTool", () => { @@ -197,6 +203,119 @@ describe("registerAppTool", () => { }); }); +describe("registerAppTool schema forms", () => { + /** Registers tools on a fresh server, then connects a client to it. */ + async function connect(register: (server: RealMcpServer) => void) { + const server = new RealMcpServer({ name: "test", version: "0.0.0" }); + register(server); + const client = new Client({ name: "client", version: "0.0.0" }); + const [clientTransport, serverTransport] = + InMemoryTransport.createLinkedPair(); + await server.connect(serverTransport); + await client.connect(clientTransport); + return client; + } + + it("accepts a z.object() input schema and validates arguments", async () => { + const client = await connect((server) => + registerAppTool( + server, + "greet", + { + inputSchema: z.object({ name: z.string() }), + _meta: { ui: { resourceUri: "ui://greet/view.html" } }, + }, + async ({ name }) => ({ + content: [{ type: "text", text: `hello ${name}` }], + }), + ), + ); + + const { tools } = await client.listTools(); + expect(tools).toHaveLength(1); + expect(tools[0].inputSchema).toMatchObject({ + type: "object", + properties: { name: { type: "string" } }, + }); + expect(tools[0]._meta).toMatchObject({ + ui: { resourceUri: "ui://greet/view.html" }, + [RESOURCE_URI_META_KEY]: "ui://greet/view.html", + }); + + const result = await client.callTool({ + name: "greet", + arguments: { name: "world" }, + }); + expect(result.content).toEqual([{ type: "text", text: "hello world" }]); + + const invalid = await client.callTool({ + name: "greet", + arguments: { name: 42 }, + }); + expect(invalid.isError).toBe(true); + }); + + it("accepts a raw zod shape (deprecated form) and wraps it with z.object()", async () => { + const client = await connect((server) => + registerAppTool( + server, + "greet", + { + inputSchema: { name: z.string() }, + outputSchema: { greeting: z.string() }, + _meta: { ui: { resourceUri: "ui://greet/view.html" } }, + }, + async ({ name }) => ({ + content: [{ type: "text", text: `hello ${name}` }], + structuredContent: { greeting: `hello ${name}` }, + }), + ), + ); + + const { tools } = await client.listTools(); + expect(tools[0].inputSchema).toMatchObject({ + type: "object", + properties: { name: { type: "string" } }, + }); + expect(tools[0].outputSchema).toMatchObject({ + type: "object", + properties: { greeting: { type: "string" } }, + }); + + const result = await client.callTool({ + name: "greet", + arguments: { name: "world" }, + }); + expect(result.structuredContent).toEqual({ greeting: "hello world" }); + + const invalid = await client.callTool({ + name: "greet", + arguments: { name: 42 }, + }); + expect(invalid.isError).toBe(true); + }); + + it("accepts the raw-shape form without an input schema", async () => { + const client = await connect((server) => + registerAppTool( + server, + "ping", + { + outputSchema: { ok: z.boolean() }, + _meta: { ui: { resourceUri: "ui://ping/view.html" } }, + }, + async () => ({ + content: [{ type: "text", text: "pong" }], + structuredContent: { ok: true }, + }), + ), + ); + + const result = await client.callTool({ name: "ping", arguments: {} }); + expect(result.structuredContent).toEqual({ ok: true }); + }); +}); + describe("registerAppResource", () => { it("should register a resource with default MIME type", () => { let capturedName: string | undefined; diff --git a/src/server/index.ts b/src/server/index.ts index 87209ef..5fad055 100644 --- a/src/server/index.ts +++ b/src/server/index.ts @@ -32,45 +32,76 @@ */ import { - RESOURCE_URI_META_KEY, - RESOURCE_MIME_TYPE, McpUiResourceCsp, McpUiResourceMeta, McpUiToolMeta, McpUiClientCapabilities, -} from "../app.js"; +} from "../spec.types.js"; +import { RESOURCE_URI_META_KEY, RESOURCE_MIME_TYPE } from "../constants.js"; import type { - BaseToolCallback, + CallToolResult, + ClientCapabilities, + InputRequiredResult, McpServer, + ReadResourceResult, RegisteredTool, ResourceMetadata, + ServerContext, + StandardSchemaWithJSON, + ToolAnnotations, ToolCallback, ReadResourceCallback as _ReadResourceCallback, RegisteredResource, -} from "@modelcontextprotocol/sdk/server/mcp.js"; -import type { - AnySchema, - ZodRawShapeCompat, -} from "@modelcontextprotocol/sdk/server/zod-compat.js"; -import type { - ClientCapabilities, - ReadResourceResult, - ToolAnnotations, -} from "@modelcontextprotocol/sdk/types.js"; +} from "@modelcontextprotocol/server"; +import type { z } from "zod/v4"; // Re-exports for convenience export { RESOURCE_URI_META_KEY, RESOURCE_MIME_TYPE }; export type { ResourceMetadata, ToolCallback }; +/** + * A plain `{ field: z.string() }` record accepted by the deprecated raw-shape + * form of {@link registerAppTool `registerAppTool`}; the SDK auto-wraps it with `z.object()`. + * + * @deprecated Wrap with `z.object({...})` instead. + */ +export type ZodRawShape = Record; + +/** + * {@link ToolCallback `ToolCallback`} variant used when `inputSchema` is a {@link ZodRawShape `ZodRawShape`}. + * Mirrors the callback type of the SDK's deprecated `registerTool` overload. + * + * @deprecated Wrap with `z.object({...})` instead and use {@link ToolCallback `ToolCallback`}. + */ +export type LegacyToolCallback = + Args extends ZodRawShape + ? ( + args: z.infer>, + ctx: ServerContext, + ) => + | CallToolResult + | InputRequiredResult + | Promise + : ( + ctx: ServerContext, + ) => + | CallToolResult + | InputRequiredResult + | Promise; + /** * Base tool configuration matching the standard MCP server tool options. * Extended by {@link McpUiAppToolConfig `McpUiAppToolConfig`} to add UI metadata requirements. + * + * `inputSchema`/`outputSchema` accept any Standard JSON Schema (zod v4, ArkType, + * Valibot, ...). A raw zod shape (`{ field: z.string() }`) is still accepted for + * backward compatibility but deprecated. */ export interface ToolConfig { title?: string; description?: string; - inputSchema?: ZodRawShapeCompat | AnySchema; - outputSchema?: ZodRawShapeCompat | AnySchema; + inputSchema?: ZodRawShape | StandardSchemaWithJSON; + outputSchema?: ZodRawShape | StandardSchemaWithJSON; annotations?: ToolAnnotations; _meta?: Record; } @@ -156,7 +187,7 @@ export interface McpUiAppResourceConfig extends ResourceMetadata { * { * title: "Get Weather", * description: "Get current weather for a location", - * inputSchema: { location: z.string() }, + * inputSchema: z.object({ location: z.string() }), * _meta: { * ui: { resourceUri: "ui://weather/view.html" }, * }, @@ -196,7 +227,7 @@ export interface McpUiAppResourceConfig extends ResourceMetadata { * "update-quantity", * { * description: "Update item quantity in cart", - * inputSchema: { itemId: z.string(), quantity: z.number() }, + * inputSchema: z.object({ itemId: z.string(), quantity: z.number() }), * _meta: { * ui: { * resourceUri: "ui://shop/cart.html", @@ -214,8 +245,8 @@ export interface McpUiAppResourceConfig extends ResourceMetadata { * @see {@link registerAppResource `registerAppResource`} to register the HTML resource referenced by the tool */ export function registerAppTool< - OutputArgs extends ZodRawShapeCompat | AnySchema, - InputArgs extends undefined | ZodRawShapeCompat | AnySchema = undefined, + OutputArgs extends StandardSchemaWithJSON, + InputArgs extends StandardSchemaWithJSON | undefined = undefined, >( server: Pick, name: string, @@ -224,6 +255,31 @@ export function registerAppTool< outputSchema?: OutputArgs; }, cb: ToolCallback, +): RegisteredTool; +/** + * @deprecated Wrap with `z.object({...})` instead. Raw-shape form: + * `inputSchema`/`outputSchema` may be a plain `{ field: z.string() }` record; + * the SDK auto-wraps it with `z.object()`. + */ +export function registerAppTool< + InputArgs extends ZodRawShape, + OutputArgs extends ZodRawShape | StandardSchemaWithJSON | undefined = + undefined, +>( + server: Pick, + name: string, + config: McpUiAppToolConfig & { + inputSchema?: InputArgs; + outputSchema?: OutputArgs; + }, + cb: LegacyToolCallback, +): RegisteredTool; +export function registerAppTool( + server: Pick, + name: string, + config: McpUiAppToolConfig, + // Widest callback shape accepted by either overload above. + cb: (...args: never[]) => unknown, ): RegisteredTool { // Normalize metadata for backward compatibility: // - If _meta.ui.resourceUri is set, also set the legacy flat key @@ -241,7 +297,16 @@ export function registerAppTool< normalizedMeta = { ...meta, ui: { ...uiMeta, resourceUri: legacyUri } }; } - return server.registerTool(name, { ...config, _meta: normalizedMeta }, cb); + // The public overloads above guarantee `config`/`cb` match one of the SDK's + // own registerTool overloads; the union-typed implementation cannot select + // between them, so widen for the forwarding call. + return server.registerTool( + name, + { ...config, _meta: normalizedMeta } as Parameters< + McpServer["registerTool"] + >[1], + cb as ToolCallback, + ); } export type McpUiReadResourceResult = ReadResourceResult & { @@ -401,10 +466,6 @@ export const EXTENSION_ID = "io.modelcontextprotocol/ui"; * This helper retrieves the capability object from the `extensions` field * where MCP Apps advertises its support. * - * Note: The `clientCapabilities` parameter extends the SDK's `ClientCapabilities` - * type with an `extensions` field (pending SEP-1724). Once `extensions` is added - * to the SDK, this can use `ClientCapabilities` directly. - * * @param clientCapabilities - The client capabilities from the initialize response * @returns The MCP Apps capability settings, or `undefined` if not supported * @@ -439,10 +500,7 @@ export const EXTENSION_ID = "io.modelcontextprotocol/ui"; * ``` */ export function getUiCapability( - clientCapabilities: - | (ClientCapabilities & { extensions?: Record }) - | null - | undefined, + clientCapabilities: ClientCapabilities | null | undefined, ): McpUiClientCapabilities | undefined { if (!clientCapabilities) { return undefined; diff --git a/src/spec.types.ts b/src/spec.types.ts index 8e0e2eb..0c45396 100644 --- a/src/spec.types.ts +++ b/src/spec.types.ts @@ -18,7 +18,7 @@ import type { RequestId, ResourceLink, Tool, -} from "@modelcontextprotocol/sdk/types.js"; +} from "@modelcontextprotocol/client"; /** * Current protocol version supported by this SDK. @@ -163,8 +163,8 @@ export interface McpUiOpenLinkResult { /** @description True if the host failed to open the URL (e.g., due to security policy). */ isError?: boolean; /** - * Index signature required for MCP SDK `Protocol` class compatibility. - * Note: The generated schema uses passthrough() to allow additional properties. + * Additional result properties are preserved for protocol extensibility. + * The generated schema uses passthrough() to allow them. */ [key: string]: unknown; } @@ -195,8 +195,8 @@ export interface McpUiDownloadFileResult { /** @description True if the download failed (e.g., user cancelled or host denied). */ isError?: boolean; /** - * Index signature required for MCP SDK `Protocol` class compatibility. - * Note: The generated schema uses passthrough() to allow additional properties. + * Additional result properties are preserved for protocol extensibility. + * The generated schema uses passthrough() to allow them. */ [key: string]: unknown; } @@ -223,8 +223,8 @@ export interface McpUiMessageResult { /** @description True if the host rejected or failed to deliver the message. */ isError?: boolean; /** - * Index signature required for MCP SDK `Protocol` class compatibility. - * Note: The generated schema uses passthrough() to allow additional properties. + * Additional result properties are preserved for protocol extensibility. + * The generated schema uses passthrough() to allow them. */ [key: string]: unknown; } @@ -454,7 +454,7 @@ export interface McpUiResourceTeardownRequest { */ export interface McpUiResourceTeardownResult { /** - * Index signature required for MCP SDK `Protocol` class compatibility. + * Additional result properties are preserved for protocol extensibility. */ [key: string]: unknown; } @@ -474,13 +474,26 @@ export interface McpUiSupportedContentBlockModalities { structuredContent?: {}; } +/** + * @description Notification for app-initiated teardown request (View -> Host). + * Views send this to request that the host tear them down. The host decides + * whether to proceed - if approved, the host will send + * `ui/resource-teardown` to allow the view to perform cleanup before being + * unmounted. + * @see {@link app.App.requestTeardown} for the app method that sends this + */ +export interface McpUiRequestTeardownNotification { + method: "ui/notifications/request-teardown"; + params?: {}; +} + /** * @description Capabilities supported by the host application. * @see {@link McpUiInitializeResult `McpUiInitializeResult`} for the initialization result that includes these capabilities */ export interface McpUiHostCapabilities { - /** @description Experimental features (structure TBD). */ - experimental?: {}; + /** @description Experimental features keyed by identifier. */ + experimental?: Record; /** @description Host supports opening external URLs. */ openLinks?: {}; /** @description Host supports file downloads via ui/download-file. */ @@ -508,6 +521,14 @@ export interface McpUiHostCapabilities { updateModelContext?: McpUiSupportedContentBlockModalities; /** @description Host supports receiving content messages (ui/message) from the view. */ message?: McpUiSupportedContentBlockModalities; + /** + * @description Host supports LLM sampling (sampling/createMessage) from the view. + * Mirrors the MCP `ClientCapabilities.sampling` shape so hosts can pass it through. + */ + sampling?: { + /** @description Host supports tool use via `tools` and `toolChoice` parameters. */ + tools?: {}; + }; } /** @@ -515,8 +536,8 @@ export interface McpUiHostCapabilities { * @see {@link McpUiInitializeRequest `McpUiInitializeRequest`} for the initialization request that includes these capabilities */ export interface McpUiAppCapabilities { - /** @description Experimental features (structure TBD). */ - experimental?: {}; + /** @description Experimental features keyed by identifier. */ + experimental?: Record; /** @description App exposes MCP-style tools that the host can call. */ tools?: { /** @description App supports tools/list_changed notifications. */ @@ -556,8 +577,8 @@ export interface McpUiInitializeResult { /** @description Rich context about the host environment. */ hostContext: McpUiHostContext; /** - * Index signature required for MCP SDK `Protocol` class compatibility. - * Note: The generated schema uses passthrough() to allow additional properties. + * Additional result properties are preserved for protocol extensibility. + * The generated schema uses passthrough() to allow them. */ [key: string]: unknown; } @@ -731,7 +752,7 @@ export interface McpUiRequestDisplayModeResult { /** @description The display mode that was actually set. May differ from requested if not supported. */ mode: McpUiDisplayMode; /** - * Index signature required for MCP SDK `Protocol` class compatibility. + * Additional result properties are preserved for protocol extensibility. * Note: The generated schema uses passthrough() to allow additional properties. */ [key: string]: unknown; @@ -748,7 +769,6 @@ export type McpUiToolVisibility = "model" | "app"; export interface McpUiToolMeta { /** * URI of the UI resource to display for this tool, if any. - * This is converted to `_meta["ui/resourceUri"]`. * * @example * ```ts @@ -762,6 +782,17 @@ export interface McpUiToolMeta { * - "app": Tool callable by the app from this server only */ visibility?: McpUiToolVisibility[]; + /** + * `csp` belongs on the UI **resource** (see {@link McpUiResourceMeta}), + * not the tool. Hosts read it from the `resources/read` content item + * (with `resources/list` entry as fallback) and ignore it here. + */ + csp?: never; + /** + * `permissions` belongs on the UI **resource** (see {@link McpUiResourceMeta}), + * not the tool. Hosts ignore it here. + */ + permissions?: never; } /** @@ -800,6 +831,8 @@ export const TOOL_CANCELLED_METHOD: McpUiToolCancelledNotification["method"] = "ui/notifications/tool-cancelled"; export const HOST_CONTEXT_CHANGED_METHOD: McpUiHostContextChangedNotification["method"] = "ui/notifications/host-context-changed"; +export const REQUEST_TEARDOWN_METHOD: McpUiRequestTeardownNotification["method"] = + "ui/notifications/request-teardown"; export const RESOURCE_TEARDOWN_METHOD: McpUiResourceTeardownRequest["method"] = "ui/resource-teardown"; export const INITIALIZE_METHOD: McpUiInitializeRequest["method"] = diff --git a/src/standard-schema.ts b/src/standard-schema.ts new file mode 100644 index 0000000..a06864a --- /dev/null +++ b/src/standard-schema.ts @@ -0,0 +1,71 @@ +import type { + StandardJSONSchemaV1, + StandardSchemaV1, + StandardTypedV1, +} from "@standard-schema/spec"; + +import type { StandardSchemaWithJSON } from "@modelcontextprotocol/client"; + +/** + * A schema that implements both Standard Schema (validation) and Standard JSON + * Schema (serialization). Zod v4, ArkType, and Valibot (via + * `@valibot/to-json-schema`) all satisfy this. Re-exported from the SDK so + * View authors can import it alongside {@link app!App `App`}. + * + * @see https://standardschema.dev/ + */ +export type { + StandardJSONSchemaV1, + StandardSchemaV1, + StandardSchemaWithJSON, + StandardTypedV1, +}; + +/** JSON-Schema target draft used for tool input/output schemas (matches core MCP). */ +const TARGET = { target: "draft-2020-12" } as const; + +/** + * Serialize a Standard Schema to JSON Schema for the given direction. + * + * Requires `~standard.jsonSchema` (zod v4, ArkType, Valibot, …); schemas + * without it throw. + */ +export async function standardSchemaToJsonSchema( + schema: StandardSchemaV1, + io: "input" | "output", +): Promise> { + const std = schema["~standard"] as Partial< + StandardSchemaWithJSON["~standard"] + >; + if (std.jsonSchema) { + return std.jsonSchema[io](TARGET); + } + throw new Error( + `Schema (vendor: ${std.vendor}) does not implement Standard JSON Schema (~standard.jsonSchema). ` + + `Use a library that does (zod v4, ArkType, Valibot) or wrap your schema accordingly.`, + ); +} + +/** + * Validate a value against a Standard Schema. Returns the parsed value on + * success or throws with a formatted issue list (optionally prefixed). + */ +export async function validateStandardSchema( + schema: S, + value: unknown, + errorPrefix = "", +): Promise> { + const result = await schema["~standard"].validate(value); + if (result.issues) { + const msg = result.issues + .map((i) => { + const path = i.path + ?.map((p) => (typeof p === "object" ? p.key : p)) + .join("."); + return path ? `${path}: ${i.message}` : i.message; + }) + .join("; "); + throw new Error(errorPrefix + msg); + } + return result.value; +} diff --git a/src/styles.ts b/src/styles.ts index ad900e2..895073b 100644 --- a/src/styles.ts +++ b/src/styles.ts @@ -1,4 +1,4 @@ -import { McpUiStyles, McpUiTheme } from "./types"; +import { McpUiStyles, McpUiTheme } from "./types.js"; /** * Get the current document theme from the root HTML element. diff --git a/src/types.ts b/src/types.ts index 739da6f..e4ed629 100644 --- a/src/types.ts +++ b/src/types.ts @@ -9,6 +9,55 @@ * @see `generated/schema.test.ts` for compile-time verification */ +import type { + CallToolRequest, + CallToolResult, + CreateMessageRequest, + CreateMessageResult, + CreateMessageResultWithTools, + EmptyResult, + ListPromptsRequest, + ListPromptsResult, + ListResourceTemplatesRequest, + ListResourceTemplatesResult, + ListResourcesRequest, + ListResourcesResult, + ListToolsRequest, + ListToolsResult, + LoggingMessageNotification, + PingRequest, + PromptListChangedNotification, + ReadResourceRequest, + ReadResourceResult, + ResourceListChangedNotification, + ToolListChangedNotification, +} from "@modelcontextprotocol/client"; +import type { + McpUiDownloadFileRequest, + McpUiDownloadFileResult, + McpUiHostContextChangedNotification, + McpUiInitializeRequest, + McpUiInitializeResult, + McpUiInitializedNotification, + McpUiMessageRequest, + McpUiMessageResult, + McpUiOpenLinkRequest, + McpUiOpenLinkResult, + McpUiRequestDisplayModeRequest, + McpUiRequestDisplayModeResult, + McpUiRequestTeardownNotification, + McpUiResourceTeardownRequest, + McpUiResourceTeardownResult, + McpUiSandboxProxyReadyNotification, + McpUiSandboxResourceReadyNotification, + McpUiSizeChangedNotification, + McpUiToolCancelledNotification, + McpUiToolInputNotification, + McpUiToolInputPartialNotification, + McpUiToolResultNotification, + McpUiUpdateModelContextRequest, +} from "./spec.types.js"; + // Re-export all types from spec.types.ts export { LATEST_PROTOCOL_VERSION, @@ -23,6 +72,7 @@ export { TOOL_RESULT_METHOD, TOOL_CANCELLED_METHOD, HOST_CONTEXT_CHANGED_METHOD, + REQUEST_TEARDOWN_METHOD, RESOURCE_TEARDOWN_METHOD, INITIALIZE_METHOD, INITIALIZED_METHOD, @@ -52,6 +102,7 @@ export { type McpUiHostContextChangedNotification, type McpUiResourceTeardownRequest, type McpUiResourceTeardownResult, + type McpUiRequestTeardownNotification, type McpUiHostCapabilities, type McpUiAppCapabilities, type McpUiInitializeRequest, @@ -67,32 +118,6 @@ export { type McpUiClientCapabilities, } from "./spec.types.js"; -// Import types needed for protocol type unions (not re-exported, just used internally) -import type { - McpUiInitializeRequest, - McpUiOpenLinkRequest, - McpUiDownloadFileRequest, - McpUiMessageRequest, - McpUiUpdateModelContextRequest, - McpUiResourceTeardownRequest, - McpUiRequestDisplayModeRequest, - McpUiHostContextChangedNotification, - McpUiToolInputNotification, - McpUiToolInputPartialNotification, - McpUiToolResultNotification, - McpUiToolCancelledNotification, - McpUiSandboxResourceReadyNotification, - McpUiInitializedNotification, - McpUiSizeChangedNotification, - McpUiSandboxProxyReadyNotification, - McpUiInitializeResult, - McpUiOpenLinkResult, - McpUiDownloadFileResult, - McpUiMessageResult, - McpUiResourceTeardownResult, - McpUiRequestDisplayModeResult, -} from "./spec.types.js"; - // Re-export all schemas from generated/schema.ts (already PascalCase) export { McpUiThemeSchema, @@ -118,6 +143,7 @@ export { McpUiHostContextChangedNotificationSchema, McpUiResourceTeardownRequestSchema, McpUiResourceTeardownResultSchema, + McpUiRequestTeardownNotificationSchema, McpUiHostCapabilitiesSchema, McpUiAppCapabilitiesSchema, McpUiInitializeRequestSchema, @@ -132,36 +158,11 @@ export { McpUiToolMetaSchema, } from "./generated/schema.js"; -// Re-export SDK types used in protocol type unions -import { - CallToolRequest, - CallToolResult, - EmptyResult, - ListPromptsRequest, - ListPromptsResult, - ListResourcesRequest, - ListResourcesResult, - ListResourceTemplatesRequest, - ListResourceTemplatesResult, - ListToolsRequest, - ListToolsResult, - LoggingMessageNotification, - PingRequest, - PromptListChangedNotification, - ReadResourceRequest, - ReadResourceResult, - ResourceListChangedNotification, - ToolListChangedNotification, -} from "@modelcontextprotocol/sdk/types.js"; - /** - * All request types in the MCP Apps protocol. + * Union of every request an {@link app!App `App`} may send or receive. * - * Includes: - * - MCP UI requests (initialize, open-link, message, resource-teardown, request-display-mode) - * - MCP server requests forwarded from the app (tools/call, tools/list, resources/list, - * resources/templates/list, resources/read, prompts/list) - * - Protocol requests (ping) + * @deprecated 1.x fed this to the SDK's `Protocol` generics; SDK 2.x derives + * request types from the method name, so nothing consumes it anymore. */ export type AppRequest = | McpUiInitializeRequest @@ -177,20 +178,13 @@ export type AppRequest = | ListResourceTemplatesRequest | ReadResourceRequest | ListPromptsRequest + | CreateMessageRequest | PingRequest; /** - * All notification types in the MCP Apps protocol. + * Union of every notification an {@link app!App `App`} may send or receive. * - * Host to app: - * - Tool lifecycle (input, input-partial, result, cancelled) - * - Host context changes - * - MCP list changes (tools, resources, prompts) - * - Sandbox resource ready - * - * App to host: - * - Initialized, size-changed, sandbox-proxy-ready - * - Logging messages + * @deprecated See {@link AppRequest}. */ export type AppNotification = // Sent to app @@ -207,10 +201,13 @@ export type AppNotification = | McpUiInitializedNotification | McpUiSizeChangedNotification | McpUiSandboxProxyReadyNotification + | McpUiRequestTeardownNotification | LoggingMessageNotification; /** - * All result types in the MCP Apps protocol. + * Union of every result an {@link app!App `App`} may send or receive. + * + * @deprecated See {@link AppRequest}. */ export type AppResult = | McpUiInitializeResult @@ -225,4 +222,6 @@ export type AppResult = | ListResourceTemplatesResult | ReadResourceResult | ListPromptsResult + | CreateMessageResult + | CreateMessageResultWithTools | EmptyResult; diff --git a/src/wire-compat.test.ts b/src/wire-compat.test.ts new file mode 100644 index 0000000..762ac77 --- /dev/null +++ b/src/wire-compat.test.ts @@ -0,0 +1,576 @@ +/** + * Cross-version wire compatibility. + * + * Replays JSON-RPC messages captured from ext-apps 1.7.x (built on + * `@modelcontextprotocol/sdk` 1.x) through the 2.x `App` and `AppBridge` over + * a raw in-memory transport, and asserts what 2.x emits back. The MCP Apps + * wire protocol is meant to be unchanged across the major bump; the few + * host-side error deltas are pinned here so they stay deliberate. + */ +import { describe, it, expect, afterEach } from "bun:test"; +import { + Client, + InMemoryTransport, + ProtocolError, + type JSONRPCMessage, + type Transport, +} from "@modelcontextprotocol/client"; +import { McpServer } from "@modelcontextprotocol/server"; +import { z } from "zod/v4"; + +import { App } from "./app.js"; +import { + AppBridge, + type McpUiHostCapabilities, + type McpUiHostContext, +} from "./app-bridge.js"; +import { LATEST_PROTOCOL_VERSION } from "./types.js"; + +/** Wait for pending microtasks/timers to complete. */ +const flush = () => new Promise((resolve) => setTimeout(resolve, 5)); + +/** + * One end of a raw in-memory channel. The 2.x side gets `transport`; the test + * plays the role of the 1.x peer by calling `inject()` with captured JSON and + * reading `sent` to see exactly what 2.x put on the wire. + */ +function createRawChannel() { + const sent: JSONRPCMessage[] = []; + let closed = false; + const transport: Transport = { + async start() {}, + async send(message) { + // Serialize like a real transport would so we assert on plain JSON. + sent.push(JSON.parse(JSON.stringify(message))); + }, + async close() { + if (closed) return; + closed = true; + transport.onclose?.(); + }, + }; + return { + transport, + sent, + /** Deliver a raw message (as the 1.x peer would have sent it). */ + inject(message: unknown) { + transport.onmessage?.(message as JSONRPCMessage); + }, + /** Messages sent after the given index. */ + since(index: number) { + return sent.slice(index); + }, + }; +} + +const hostInfo = { name: "TestHost", version: "9.9.9" }; +const hostCapabilities: McpUiHostCapabilities = { + openLinks: {}, + serverTools: {}, + serverResources: {}, + logging: {}, + updateModelContext: {}, +}; +const hostContext: McpUiHostContext = { + theme: "dark", + displayMode: "inline", + locale: "en-US", +}; + +/** Shaped like ext-apps 1.7.x View traffic (sdk-1 key order, 0-based numeric ids); not a recorded capture. */ +const v1View = { + initialize: { + method: "ui/initialize", + params: { + appCapabilities: { tools: { listChanged: true } }, + appInfo: { name: "TestView", version: "1.2.3" }, + protocolVersion: "2026-01-26", + }, + jsonrpc: "2.0", + id: 0, + }, + initialized: { method: "ui/notifications/initialized", jsonrpc: "2.0" }, + callTool: { + method: "tools/call", + params: { name: "echo", arguments: { a: 1 }, _meta: { progressToken: 6 } }, + jsonrpc: "2.0", + id: 6, + }, + readResource: { + method: "resources/read", + params: { uri: "test://x" }, + jsonrpc: "2.0", + id: 12, + }, + toolsListResult: (id: number) => ({ + result: { + tools: [ + { + name: "viewtool", + description: "view tool", + inputSchema: { + type: "object", + properties: { x: { type: "number" } }, + }, + }, + ], + }, + jsonrpc: "2.0", + id, + }), +}; + +/** Shaped like ext-apps 1.7.x AppBridge traffic (sdk 1.x); not a recorded capture. */ +const v1Host = { + initializeResult: (id: number) => ({ + result: { + protocolVersion: "2026-01-26", + hostCapabilities, + hostInfo, + hostContext, + }, + jsonrpc: "2.0", + id, + }), + toolInput: { + method: "ui/notifications/tool-input", + params: { arguments: { location: "NYC" } }, + jsonrpc: "2.0", + }, + callToolResult: (id: number) => ({ + result: { content: [{ type: "text", text: "echo 1" }] }, + jsonrpc: "2.0", + id, + }), + /** McpServer 1.x reports an unknown tool as an isError result, not an error. */ + callToolUnknownResult: (id: number) => ({ + result: { + content: [ + { type: "text", text: "MCP error -32602: Tool nope not found" }, + ], + isError: true, + }, + jsonrpc: "2.0", + id, + }), + resourceNotFoundError: (id: number) => ({ + jsonrpc: "2.0", + id, + error: { + code: -32002, + message: "MCP error -32002: Resource not found (host-thrown -32002)", + }, + }), + toolsList: { method: "tools/list", jsonrpc: "2.0", id: 0 }, + callViewTool: { + method: "tools/call", + params: { name: "viewtool", arguments: { x: 7 } }, + jsonrpc: "2.0", + id: 1, + }, +}; + +describe("wire compatibility: 2.x AppBridge with a 1.x View", () => { + let bridge: AppBridge; + + afterEach(async () => { + await bridge?.close().catch(() => {}); + }); + + async function connectBridge() { + const channel = createRawChannel(); + bridge = new AppBridge(null, hostInfo, hostCapabilities, { hostContext }); + await bridge.connect(channel.transport); + return channel; + } + + async function handshake() { + const channel = await connectBridge(); + let initialized = 0; + bridge.oninitialized = () => { + initialized++; + }; + channel.inject(v1View.initialize); + await flush(); + channel.inject(v1View.initialized); + await flush(); + return { channel, initialized: () => initialized }; + } + + it("sends nothing on connect: no MCP initialize toward the View", async () => { + const channel = await connectBridge(); + await flush(); + expect(channel.sent).toEqual([]); + }); + + it("answers a 1.x ui/initialize with the 1.x result shape and same id", async () => { + const channel = await connectBridge(); + channel.inject(v1View.initialize); + await flush(); + + expect(channel.sent).toEqual([ + { + jsonrpc: "2.0", + id: 0, + result: { + protocolVersion: LATEST_PROTOCOL_VERSION, + hostCapabilities, + hostInfo, + hostContext, + }, + }, + ]); + expect(bridge.getAppCapabilities()).toEqual({ + tools: { listChanged: true }, + }); + expect(bridge.getAppVersion()).toEqual({ + name: "TestView", + version: "1.2.3", + }); + }); + + it("accepts ui/notifications/initialized without params", async () => { + const { channel, initialized } = await handshake(); + expect(initialized()).toBe(1); + // Only the initialize response went out; the notification gets no reply + // and the bridge never starts an MCP handshake of its own. + expect(channel.sent).toHaveLength(1); + expect(channel.sent.some((m) => "method" in m)).toBe(false); + }); + + it("answers a 1.x tools/call request through oncalltool", async () => { + const { channel } = await handshake(); + bridge.oncalltool = async (params) => ({ + content: [{ type: "text", text: `echo ${params.arguments?.a}` }], + }); + const mark = channel.sent.length; + channel.inject(v1View.callTool); + await flush(); + + expect(channel.since(mark)).toEqual([ + { + jsonrpc: "2.0", + id: 6, + result: { content: [{ type: "text", text: "echo 1" }] }, + }, + ]); + }); + + it("re-encodes a handler-thrown -32002 as -32602 without the MCP error prefix", async () => { + // Documented host-side delta: SDK 2.x never emits -32002 on the wire. + const { channel } = await handshake(); + bridge.onreadresource = async () => { + throw new ProtocolError( + -32002, + "Resource not found (host-thrown -32002)", + ); + }; + const mark = channel.sent.length; + channel.inject(v1View.readResource); + await flush(); + + const [reply] = channel.since(mark); + expect(reply).toMatchObject({ + jsonrpc: "2.0", + id: 12, + error: { code: -32602 }, + }); + const message = (reply as { error: { message: string } }).error.message; + expect(message).toBe("Resource not found (host-thrown -32002)"); + expect(message).not.toMatch(/^MCP error/); + }); + + it("rejects invalid params on a ui/* request with -32602", async () => { + const { channel } = await handshake(); + bridge.onopenlink = async () => ({}); + const mark = channel.sent.length; + channel.inject({ + method: "ui/open-link", + params: { url: 42 }, + jsonrpc: "2.0", + id: 14, + }); + await flush(); + + expect(channel.since(mark)).toHaveLength(1); + expect(channel.since(mark)[0]).toMatchObject({ + jsonrpc: "2.0", + id: 14, + error: { code: -32602 }, + }); + }); + + it("lists and calls View tools with 1.x-shaped responses", async () => { + const { channel } = await handshake(); + const mark = channel.sent.length; + const listPromise = bridge.listTools({}); + await flush(); + + const [listRequest] = channel.since(mark) as Array<{ + id: number; + method: string; + }>; + expect(listRequest).toMatchObject({ jsonrpc: "2.0", method: "tools/list" }); + channel.inject(v1View.toolsListResult(listRequest.id)); + const list = await listPromise; + expect(list.tools.map((t) => t.name)).toEqual(["viewtool"]); + + const callPromise = bridge.callTool({ + name: "viewtool", + arguments: { x: 7 }, + }); + await flush(); + const [callRequest] = channel.since(mark + 1) as Array<{ id: number }>; + expect(callRequest).toMatchObject({ + jsonrpc: "2.0", + method: "tools/call", + params: { name: "viewtool", arguments: { x: 7 } }, + }); + channel.inject({ + result: { content: [{ type: "text", text: "view got 7" }] }, + jsonrpc: "2.0", + id: callRequest.id, + }); + expect(await callPromise).toEqual({ + content: [{ type: "text", text: "view got 7" }], + }); + }); + + it("only ever emits jsonrpc 2.0 messages, never an initialize request", async () => { + const { channel } = await handshake(); + bridge.oncalltool = async () => ({ content: [] }); + channel.inject(v1View.callTool); + bridge.sendToolInput({ arguments: { q: "x" } }); + bridge.sendToolResult({ content: [] }); + await flush(); + + for (const message of channel.sent) { + expect(message.jsonrpc).toBe("2.0"); + } + const methods = channel.sent + .filter((m): m is JSONRPCMessage & { method: string } => "method" in m) + .map((m) => m.method); + expect(methods).toEqual([ + "ui/notifications/tool-input", + "ui/notifications/tool-result", + ]); + expect(methods).not.toContain("initialize"); + expect(methods).not.toContain("notifications/initialized"); + }); +}); + +describe("wire compatibility: 2.x App with a 1.x host", () => { + let app: App; + + afterEach(async () => { + await app?.close().catch(() => {}); + }); + + /** Connect the App and answer its ui/initialize the way a 1.x host did. */ + async function handshake( + capabilities: ConstructorParameters[1] = {}, + setup: (app: App) => void = () => {}, + ) { + const channel = createRawChannel(); + app = new App({ name: "TestView", version: "1.2.3" }, capabilities, { + autoResize: false, + }); + setup(app); + const connected = app.connect(channel.transport); + await flush(); + + const [initialize] = channel.sent as Array<{ id: number }>; + channel.inject(v1Host.initializeResult(initialize.id)); + await connected; + await flush(); + return { channel, initialize }; + } + + it("sends a 1.x-compatible ui/initialize and ui/notifications/initialized", async () => { + const { channel } = await handshake({ tools: { listChanged: true } }); + + expect(channel.sent).toEqual([ + { + jsonrpc: "2.0", + id: 0, + method: "ui/initialize", + params: { + protocolVersion: LATEST_PROTOCOL_VERSION, + appInfo: { name: "TestView", version: "1.2.3" }, + appCapabilities: { tools: { listChanged: true } }, + }, + }, + { jsonrpc: "2.0", method: "ui/notifications/initialized" }, + ]); + expect(app.getHostContext()).toEqual(hostContext); + expect(app.getHostCapabilities()).toEqual(hostCapabilities); + expect(app.getHostVersion()).toEqual(hostInfo); + }); + + it("delivers a 1.x notification with sdk-1 key order to ontoolinput", async () => { + const received: unknown[] = []; + const { channel } = await handshake({}, (app) => { + app.ontoolinput = (params) => { + received.push(params); + }; + }); + channel.inject(v1Host.toolInput); + await flush(); + expect(received).toEqual([{ arguments: { location: "NYC" } }]); + }); + + it("resolves callServerTool from a 1.x tools/call response", async () => { + const { channel } = await handshake(); + const mark = channel.sent.length; + const promise = app.callServerTool({ name: "echo", arguments: { a: 1 } }); + await flush(); + + const [request] = channel.since(mark) as Array<{ id: number }>; + expect(request).toMatchObject({ + jsonrpc: "2.0", + method: "tools/call", + params: { + name: "echo", + arguments: { a: 1 }, + _meta: { progressToken: request.id }, + }, + }); + channel.inject(v1Host.callToolResult(request.id)); + expect(await promise).toEqual({ + content: [{ type: "text", text: "echo 1" }], + }); + }); + + it("passes through a 1.x isError tool result unchanged", async () => { + const { channel } = await handshake(); + const mark = channel.sent.length; + const promise = app.callServerTool({ name: "nope", arguments: {} }); + await flush(); + const [request] = channel.since(mark) as Array<{ id: number }>; + channel.inject(v1Host.callToolUnknownResult(request.id)); + expect(await promise).toEqual({ + content: [ + { type: "text", text: "MCP error -32602: Tool nope not found" }, + ], + isError: true, + }); + }); + + it("surfaces a 1.x -32002 error as a ProtocolError with code -32002", async () => { + const { channel } = await handshake(); + const mark = channel.sent.length; + const promise = app.readServerResource({ uri: "test://x" }); + await flush(); + const [request] = channel.since(mark) as Array<{ id: number }>; + channel.inject(v1Host.resourceNotFoundError(request.id)); + + const error = await promise.then( + () => undefined, + (e: unknown) => e, + ); + expect(error).toBeInstanceOf(ProtocolError); + expect((error as ProtocolError).code).toBe(-32002); + expect((error as ProtocolError).message).toContain( + "Resource not found (host-thrown -32002)", + ); + }); + + it("answers 1.x tools/list (no params) and tools/call requests from the host", async () => { + const { channel } = await handshake({ tools: { listChanged: true } }); + app.registerTool( + "viewtool", + { description: "view tool", inputSchema: z.object({ x: z.number() }) }, + async ({ x }) => ({ + content: [{ type: "text", text: `view got ${x}` }], + }), + ); + await flush(); + const mark = channel.sent.length; + + channel.inject(v1Host.toolsList); + await flush(); + const [listReply] = channel.since(mark) as unknown as Array<{ + result: { tools: Array<{ name: string; inputSchema: unknown }> }; + }>; + expect(listReply).toMatchObject({ jsonrpc: "2.0", id: 0 }); + expect(listReply.result.tools).toHaveLength(1); + expect(listReply.result.tools[0]).toMatchObject({ + name: "viewtool", + description: "view tool", + inputSchema: { + type: "object", + properties: { x: { type: "number" } }, + required: ["x"], + }, + }); + + channel.inject(v1Host.callViewTool); + await flush(); + expect(channel.since(mark + 1)).toEqual([ + { + jsonrpc: "2.0", + id: 1, + result: { content: [{ type: "text", text: "view got 7" }] }, + }, + ]); + }); +}); + +describe("AppBridge proxy over a default (modern era) 2.x Client/Server", () => { + let client: Client; + let server: McpServer; + let app: App; + let bridge: AppBridge; + + afterEach(async () => { + await app?.close().catch(() => {}); + await bridge?.close().catch(() => {}); + await client?.close().catch(() => {}); + await server?.close().catch(() => {}); + }); + + it("forwards tools/call and tools/list_changed with default negotiation", async () => { + server = new McpServer({ name: "ActualServer", version: "1.0.0" }); + server.registerTool( + "echo", + { inputSchema: z.object({ a: z.number() }) }, + async ({ a }) => ({ content: [{ type: "text", text: `echo ${a}` }] }), + ); + const [clientTransport, serverTransport] = + InMemoryTransport.createLinkedPair(); + await server.connect(serverTransport); + + client = new Client({ name: "HostOuterClient", version: "1.0.0" }); + await client.connect(clientTransport); + expect(client.getServerCapabilities()?.tools).toEqual({ + listChanged: true, + }); + + bridge = new AppBridge(client, hostInfo, hostCapabilities, { + hostContext, + }); + app = new App( + { name: "TestView", version: "1.2.3" }, + {}, + { + autoResize: false, + }, + ); + const listChanged: string[] = []; + app.setNotificationHandler("notifications/tools/list_changed", () => { + listChanged.push("tools"); + }); + const [appTransport, bridgeTransport] = + InMemoryTransport.createLinkedPair(); + await bridge.connect(bridgeTransport); + await app.connect(appTransport); + + expect( + await app.callServerTool({ name: "echo", arguments: { a: 1 } }), + ).toMatchObject({ content: [{ type: "text", text: "echo 1" }] }); + + server.sendToolListChanged(); + await flush(); + expect(listChanged).toEqual(["tools"]); + }); +}); diff --git a/tests/e2e/pdf-annotations-api.spec.ts b/tests/e2e/pdf-annotations-api.spec.ts new file mode 100644 index 0000000..5e63237 --- /dev/null +++ b/tests/e2e/pdf-annotations-api.spec.ts @@ -0,0 +1,333 @@ +/** + * PDF Annotation β€” Claude API prompt discovery tests + * + * Tests that Claude can discover and use PDF annotation capabilities + * when given the display_pdf result and interact tool descriptions. + * + * These tests call the Anthropic API directly and are DISABLED by default. + * To enable: + * ANTHROPIC_API_KEY=sk-ant-... npx playwright test tests/e2e/pdf-annotations-api.spec.ts + */ + +import { test, expect } from "@playwright/test"; + +const API_KEY = process.env.ANTHROPIC_API_KEY; + +// Skip all tests if no API key +test.skip(!API_KEY, "Set ANTHROPIC_API_KEY to run API prompt tests"); +test.setTimeout(60000); + +// Tool definitions matching the PDF server's registered tools +const TOOLS = [ + { + name: "display_pdf", + description: + "Display a PDF in an interactive viewer. Returns a viewUUID for subsequent interact calls.", + input_schema: { + type: "object" as const, + properties: { + url: { + type: "string", + description: "URL or path to the PDF file", + default: "https://arxiv.org/pdf/1706.03762", + }, + page: { + type: "number", + description: "Initial page to display (1-indexed)", + minimum: 1, + }, + }, + }, + }, + { + name: "interact", + description: `Interact with a PDF viewer: annotate, navigate, search, extract pages, fill forms. + +**ANNOTATION** β€” You can add visual annotations to any page. Use add_annotations with an array of annotation objects. +Each annotation needs: id (unique string), type, page (1-indexed). +Coordinates use PDF points (72 dpi), bottom-left origin. + +Annotation types: +β€’ highlight: rects:[{x,y,width,height}], color?, content? β€” semi-transparent overlay on text regions +β€’ underline: rects:[{x,y,width,height}], color? β€” underline below text +β€’ strikethrough: rects:[{x,y,width,height}], color? β€” line through text +β€’ note: x, y, content, color? β€” sticky note icon with tooltip +β€’ rectangle: x, y, width, height, color?, fillColor? β€” outlined/filled box +β€’ freetext: x, y, content, fontSize?, color? β€” arbitrary text label +β€’ stamp: x, y, label (APPROVED|DRAFT|CONFIDENTIAL|FINAL|VOID|REJECTED), color?, rotation? β€” stamp overlay + +Example β€” add a highlight and a stamp on page 1: +\`\`\`json +{"action":"add_annotations","viewUUID":"…","annotations":[ + {"id":"h1","type":"highlight","page":1,"rects":[{"x":72,"y":700,"width":200,"height":12}]}, + {"id":"s1","type":"stamp","page":1,"x":300,"y":500,"label":"APPROVED","color":"green","rotation":-15} +]} +\`\`\` + +**HIGHLIGHT TEXT** β€” highlight_text: auto-find and highlight text by query. Requires \`query\`. Optional: page, color, content. + +**ANNOTATION MANAGEMENT**: +β€’ update_annotations: partial update (id+type required). β€’ remove_annotations: remove by ids. + +**NAVIGATION & SEARCH**: +β€’ navigate: go to page (requires \`page\`) +β€’ search: highlight matches in UI (requires \`query\`). Results in model context. +β€’ find: silent search, no UI change (requires \`query\`). Results in model context. +β€’ search_navigate: jump to match (requires \`matchIndex\`) +β€’ zoom: set scale 0.5–3.0 (requires \`scale\`) + +**PAGE EXTRACTION** β€” get_pages: extract text/screenshots from page ranges without navigating. \`intervals\` = [{start?,end?}], e.g. [{}] for all. \`getText\` (default true), \`getScreenshots\` (default false). Max 20 pages. + +**FORMS** β€” fill_form: fill fields with \`fields\` array of {name, value}.`, + input_schema: { + type: "object" as const, + required: ["viewUUID", "action"], + properties: { + viewUUID: { + type: "string", + description: + "The viewUUID of the PDF viewer (from display_pdf result)", + }, + action: { + type: "string", + enum: [ + "navigate", + "search", + "find", + "search_navigate", + "zoom", + "add_annotations", + "update_annotations", + "remove_annotations", + "highlight_text", + "fill_form", + "get_pages", + ], + description: "Action to perform", + }, + page: { + type: "number", + minimum: 1, + description: "Page number (for navigate, highlight_text)", + }, + query: { + type: "string", + description: "Search text (for search / find / highlight_text)", + }, + matchIndex: { + type: "number", + minimum: 0, + description: "Match index (for search_navigate)", + }, + scale: { + type: "number", + minimum: 0.5, + maximum: 3.0, + description: "Zoom scale (for zoom)", + }, + annotations: { + type: "array", + description: + "Annotation objects for add_annotations or update_annotations", + items: { type: "object" }, + }, + ids: { + type: "array", + items: { type: "string" }, + description: "Annotation IDs (for remove_annotations)", + }, + color: { + type: "string", + description: "Color override (for highlight_text)", + }, + content: { + type: "string", + description: "Tooltip/note content (for highlight_text)", + }, + fields: { + type: "array", + items: { type: "object" }, + description: "Form fields (for fill_form)", + }, + intervals: { + type: "array", + items: { type: "object" }, + description: "Page ranges for get_pages", + }, + getText: { + type: "boolean", + description: "Include text (for get_pages, default true)", + }, + getScreenshots: { + type: "boolean", + description: "Include screenshots (for get_pages, default false)", + }, + }, + }, + }, +]; + +// Simulated display_pdf result the model would see after calling display_pdf +const DISPLAY_PDF_RESULT_TEXT = `Displaying PDF (viewUUID: abc-123-def): https://arxiv.org/pdf/1706.03762. + +Use the \`interact\` tool with this viewUUID. Available actions: +- navigate: go to a page +- search / find: search text (search highlights in UI, find is silent) +- search_navigate: jump to a search match by index +- zoom: set zoom level (0.5–3.0) +- add_annotations: add highlights, underlines, strikethroughs, notes, rectangles, freetext, stamps (APPROVED/DRAFT/CONFIDENTIAL/FINAL/VOID/REJECTED) +- update_annotations: partially update existing annotations +- remove_annotations: remove annotations by ID +- highlight_text: find text by query and highlight it automatically +- fill_form: fill PDF form fields +- get_pages: extract text and/or screenshots from page ranges without navigating`; + +/** + * Conversation history simulating: user asked to display a PDF, model called + * display_pdf, and the tool returned the result above. + */ +const AFTER_DISPLAY_PDF = [ + { + role: "user" as const, + content: "Show me the Attention Is All You Need paper", + }, + { + role: "assistant" as const, + content: [ + { + type: "tool_use" as const, + id: "toolu_display_1", + name: "display_pdf", + input: { url: "https://arxiv.org/pdf/1706.03762" }, + }, + ], + }, + { + role: "user" as const, + content: [ + { + type: "tool_result" as const, + tool_use_id: "toolu_display_1", + content: DISPLAY_PDF_RESULT_TEXT, + }, + ], + }, +]; + +/** Call the Anthropic Messages API and return parsed response. */ +async function callClaude( + messages: Array<{ role: string; content: unknown }>, +): Promise<{ + toolUses: Array<{ name: string; input: Record }>; + textBlocks: Array<{ text: string }>; +}> { + const response = await fetch("https://api.anthropic.com/v1/messages", { + method: "POST", + headers: { + "Content-Type": "application/json", + "x-api-key": API_KEY!, + "anthropic-version": "2023-06-01", + }, + body: JSON.stringify({ + model: "claude-sonnet-4-20250514", + max_tokens: 1024, + tools: TOOLS, + messages, + }), + }); + + expect(response.ok, `API error ${response.status}`).toBe(true); + const result = await response.json(); + + return { + toolUses: result.content.filter( + (c: { type: string }) => c.type === "tool_use", + ), + textBlocks: result.content.filter( + (c: { type: string }) => c.type === "text", + ), + }; +} + +/** Check if any tool call uses an annotation-related interact action. */ +function usesAnnotationAction( + toolUses: Array<{ name: string; input: Record }>, +): boolean { + return toolUses.some( + (tu) => + tu.name === "interact" && + ["add_annotations", "highlight_text", "update_annotations"].includes( + tu.input.action as string, + ), + ); +} + +/** Check if any tool call uses the interact tool. */ +function usesInteract( + toolUses: Array<{ name: string; input: Record }>, +): boolean { + return toolUses.some((tu) => tu.name === "interact"); +} + +/** Check if text mentions annotation capabilities. */ +function mentionsAnnotations(textBlocks: Array<{ text: string }>): boolean { + const text = textBlocks + .map((t) => t.text) + .join(" ") + .toLowerCase(); + return ( + text.includes("annotati") || + text.includes("highlight") || + text.includes("stamp") || + text.includes("add_annotations") || + text.includes("mark up") + ); +} + +test.describe("PDF Annotation β€” API prompt discovery", () => { + test("model uses highlight_text when asked to highlight the title", async () => { + const { toolUses } = await callClaude([ + ...AFTER_DISPLAY_PDF, + { + role: "user", + content: + "Please highlight the title and add an APPROVED stamp on the first page.", + }, + ]); + + expect(toolUses.length).toBeGreaterThan(0); + expect(usesAnnotationAction(toolUses)).toBe(true); + }); + + test("model discovers annotation capabilities when asked 'can you annotate?'", async () => { + const { toolUses, textBlocks } = await callClaude([ + ...AFTER_DISPLAY_PDF, + { + role: "user", + content: "Can you annotate this PDF? Mark important sections for me.", + }, + ]); + + // Model should either use annotations directly or acknowledge it can + const discovers = + usesAnnotationAction(toolUses) || + usesInteract(toolUses) || + mentionsAnnotations(textBlocks); + expect(discovers).toBe(true); + }); + + test("model uses add_annotations or get_pages when asked to add notes", async () => { + const { toolUses } = await callClaude([ + ...AFTER_DISPLAY_PDF, + { + role: "user", + content: + "Add a note on page 1 saying 'Key contribution' at position (200, 500), and highlight the abstract.", + }, + ]); + + expect(toolUses.length).toBeGreaterThan(0); + // Model should use interact (either to annotate directly or to read first) + expect(usesInteract(toolUses)).toBe(true); + }); +}); diff --git a/tests/e2e/pdf-annotations.spec.ts b/tests/e2e/pdf-annotations.spec.ts new file mode 100644 index 0000000..af67bb7 --- /dev/null +++ b/tests/e2e/pdf-annotations.spec.ts @@ -0,0 +1,406 @@ +import { test, expect, type Page } from "@playwright/test"; + +// Increase timeout for these tests β€” PDF loading from arxiv can be slow +test.setTimeout(120000); + +/** + * PDF Annotation E2E Tests + * + * Tests the annotation capabilities of the PDF server through the basic-host UI. + * Verifies that annotations can be added, rendered, and interacted with. + */ + +/** Wait for the MCP App to load inside nested iframes. */ +async function waitForAppLoad(page: Page) { + const outerFrame = page.frameLocator("iframe").first(); + await expect(outerFrame.locator("iframe")).toBeVisible({ timeout: 30000 }); +} + +/** Get the app frame locator (nested: sandbox > app) */ +function getAppFrame(page: Page) { + return page.frameLocator("iframe").first().frameLocator("iframe").first(); +} + +/** Load the PDF server and call display_pdf with the default PDF. */ +async function loadPdfServer(page: Page) { + await page.goto("/?theme=hide"); + await expect(page.locator("select").first()).toBeEnabled({ timeout: 30000 }); + await page.locator("select").first().selectOption({ label: "PDF Server" }); + await page.click('button:has-text("Call Tool")'); + await waitForAppLoad(page); +} + +/** + * Extract the viewUUID from the display_pdf result panel. + * The tool result is displayed as JSON in a collapsible panel. + */ +async function extractViewUUID(page: Page): Promise { + // Wait for the Tool Result panel to appear β€” it contains "πŸ“€ Tool Result" + const resultPanel = page.locator('text="πŸ“€ Tool Result"').first(); + await expect(resultPanel).toBeVisible({ timeout: 30000 }); + + // The result preview shows the first 100 chars including "viewUUID: ..." + // Click to expand the result panel to see the full JSON + await resultPanel.click(); + + // Wait for the expanded result content to appear + const resultContent = page.locator("pre").last(); + await expect(resultContent).toBeVisible({ timeout: 5000 }); + + const resultText = (await resultContent.textContent()) ?? ""; + + // Extract viewUUID from the JSON result + // The text content includes: "PDF opened. viewUUID: " + const match = resultText.match(/viewUUID["\s:]+([a-f0-9-]{36})/); + if (!match) { + throw new Error( + `Could not extract viewUUID from result: ${resultText.slice(0, 200)}`, + ); + } + return match[1]; +} + +/** + * Call the interact tool with the given input JSON. + * Selects the interact tool from the dropdown, fills the input, and clicks Call Tool. + */ +async function callInteract(page: Page, input: Record) { + // Select "interact" in the tool dropdown (second select on the page) + const toolSelect = page.locator("select").nth(1); + await toolSelect.selectOption("interact"); + + // Fill the input textarea with the JSON + const inputTextarea = page.locator("textarea"); + await inputTextarea.fill(JSON.stringify(input)); + + // Click "Call Tool" + await page.click('button:has-text("Call Tool")'); +} + +/** Wait for the PDF canvas to render (ensures the page is ready for annotations). */ +async function waitForPdfCanvas(page: Page) { + const appFrame = getAppFrame(page); + await expect(appFrame.locator("canvas").first()).toBeVisible({ + timeout: 30000, + }); + // Wait a bit for fonts and text layer to stabilize + await page.waitForTimeout(2000); +} + +test.describe("PDF Server - Annotations", () => { + test("display_pdf result includes viewUUID and interactEnabled meta", async ({ + page, + }) => { + await loadPdfServer(page); + + // Wait for result to appear + const resultPanel = page.locator('text="πŸ“€ Tool Result"').first(); + await expect(resultPanel).toBeVisible({ timeout: 30000 }); + + // Expand the result panel + await resultPanel.click(); + const resultContent = page.locator("pre").last(); + await expect(resultContent).toBeVisible({ timeout: 5000 }); + const resultText = (await resultContent.textContent()) ?? ""; + + // The result should carry the viewUUID and interact flag in _meta / structuredContent + // (interact action list lives in the tool description, not the runtime result). + expect(resultText).toContain("viewUUID"); + expect(resultText).toContain("interactEnabled"); + expect(resultText).toContain("PDF opened"); + }); + + test("interact tool is available in tool dropdown", async ({ page }) => { + await loadPdfServer(page); + + // Verify the interact tool is available in the tool dropdown + const toolSelect = page.locator("select").nth(1); + const options = await toolSelect.locator("option").allTextContents(); + expect(options).toContain("interact"); + }); + + test("add_annotations renders highlight on the page", async ({ page }) => { + await loadPdfServer(page); + await waitForPdfCanvas(page); + + const viewUUID = await extractViewUUID(page); + + // Add a highlight annotation on page 1 + await callInteract(page, { + viewUUID, + action: "add_annotations", + annotations: [ + { + id: "test-highlight-1", + type: "highlight", + page: 1, + rects: [{ x: 72, y: 700, width: 300, height: 14 }], + color: "rgba(255, 255, 0, 0.4)", + }, + ], + }); + + // Wait for the interact result + await page.waitForTimeout(1000); + + // Verify the annotation appears in the annotation layer inside the app frame + const appFrame = getAppFrame(page); + const annotationLayer = appFrame.locator("#annotation-layer"); + await expect(annotationLayer).toBeVisible({ timeout: 5000 }); + + // Check that a highlight annotation element was rendered + const highlightEl = appFrame.locator(".annotation-highlight"); + await expect(highlightEl.first()).toBeVisible({ timeout: 5000 }); + // Regression: highlight must be translucent (not opaque hex), so text + // underneath remains readable. + await expect(highlightEl.first()).toHaveCSS( + "background-color", + /rgba\(255, 255, 0, 0\.35\)/, + ); + }); + + test("add_annotations renders multiple annotation types", async ({ + page, + }) => { + await loadPdfServer(page); + await waitForPdfCanvas(page); + + const viewUUID = await extractViewUUID(page); + + // Add multiple annotation types at once + await callInteract(page, { + viewUUID, + action: "add_annotations", + annotations: [ + { + id: "test-highlight", + type: "highlight", + page: 1, + rects: [{ x: 72, y: 700, width: 300, height: 14 }], + color: "rgba(255, 255, 0, 0.4)", + }, + { + id: "test-note", + type: "note", + page: 1, + x: 400, + y: 600, + content: "Important finding!", + color: "#ffeb3b", + }, + { + id: "test-stamp", + type: "stamp", + page: 1, + x: 300, + y: 400, + label: "APPROVED", + color: "#4caf50", + rotation: -15, + }, + { + id: "test-freetext", + type: "freetext", + page: 1, + x: 100, + y: 300, + content: "See section 3.2", + fontSize: 14, + color: "#1976d2", + }, + { + id: "test-rect", + type: "rectangle", + page: 1, + x: 50, + y: 200, + width: 500, + height: 100, + color: "#f44336", + }, + ], + }); + + await page.waitForTimeout(1500); + + const appFrame = getAppFrame(page); + + // Verify each annotation type is rendered + await expect(appFrame.locator(".annotation-highlight").first()).toBeVisible( + { + timeout: 5000, + }, + ); + await expect(appFrame.locator(".annotation-note").first()).toBeVisible({ + timeout: 5000, + }); + await expect(appFrame.locator(".annotation-stamp").first()).toBeVisible({ + timeout: 5000, + }); + await expect(appFrame.locator(".annotation-freetext").first()).toBeVisible({ + timeout: 5000, + }); + await expect(appFrame.locator(".annotation-rectangle").first()).toBeVisible( + { timeout: 5000 }, + ); + }); + + test("remove_annotations removes annotation from DOM", async ({ page }) => { + await loadPdfServer(page); + await waitForPdfCanvas(page); + + const viewUUID = await extractViewUUID(page); + + // Add an annotation + await callInteract(page, { + viewUUID, + action: "add_annotations", + annotations: [ + { + id: "to-remove", + type: "highlight", + page: 1, + rects: [{ x: 72, y: 700, width: 300, height: 14 }], + }, + ], + }); + + await page.waitForTimeout(1000); + + const appFrame = getAppFrame(page); + await expect(appFrame.locator(".annotation-highlight").first()).toBeVisible( + { + timeout: 5000, + }, + ); + + // Remove the annotation + await callInteract(page, { + viewUUID, + action: "remove_annotations", + ids: ["to-remove"], + }); + + await page.waitForTimeout(1000); + + // Verify the annotation is gone + await expect(appFrame.locator(".annotation-highlight")).toHaveCount(0, { + timeout: 5000, + }); + }); + + test("highlight_text finds and highlights text", async ({ page }) => { + await loadPdfServer(page); + await waitForPdfCanvas(page); + + const viewUUID = await extractViewUUID(page); + + // Use highlight_text to find and highlight "Attention" in the PDF + await callInteract(page, { + viewUUID, + action: "highlight_text", + query: "Attention", + color: "rgba(0, 200, 255, 0.4)", + }); + + await page.waitForTimeout(2000); + + const appFrame = getAppFrame(page); + // highlight_text creates highlight annotations, so we should see at least one + await expect(appFrame.locator(".annotation-highlight").first()).toBeVisible( + { + timeout: 10000, + }, + ); + }); +}); + +/** + * Read the most recent interact result text from the basic-host UI. + * Waits for the result-panel count to reach `expectedCount` first β€” + * `callInteract` doesn't block, so `.last()` would otherwise race to the + * previous (display_pdf) panel. + */ +async function readLastToolResult( + page: Page, + expectedCount: number, +): Promise { + const panels = page.locator('text="πŸ“€ Tool Result"'); + await expect(panels).toHaveCount(expectedCount, { timeout: 30000 }); + await panels.last().click(); + const pre = page.locator("pre").last(); + await expect(pre).toBeVisible({ timeout: 5000 }); + return (await pre.textContent()) ?? ""; +} + +/** Unwrap basic-host's `CallToolResult` JSON to the first text block. */ +function unwrapTextResult(raw: string): string { + const parsed = JSON.parse(raw) as { + content?: { type: string; text?: string }[]; + }; + const block = parsed.content?.find((c) => c.type === "text"); + if (!block?.text) throw new Error(`No text block in: ${raw.slice(0, 200)}`); + return block.text; +} + +test.describe("PDF Server - get_viewer_state", () => { + test("returns page/zoom/mode and selection:null when nothing is selected", async ({ + page, + }) => { + await loadPdfServer(page); + await waitForPdfCanvas(page); + + const viewUUID = await extractViewUUID(page); + + await callInteract(page, { viewUUID, action: "get_viewer_state" }); + const raw = await readLastToolResult(page, 2); + const state = JSON.parse(unwrapTextResult(raw)); + + expect(state.currentPage).toBe(1); + expect(state.pageCount).toBeGreaterThan(1); + expect(typeof state.zoom).toBe("number"); + expect(state.displayMode).toBe("inline"); + expect(state.selection).toBeNull(); + expect(Array.isArray(state.selectedAnnotationIds)).toBe(true); + }); + + test("returns selected text and bounding rect when text-layer text is selected", async ({ + page, + }) => { + await loadPdfServer(page); + await waitForPdfCanvas(page); + + const viewUUID = await extractViewUUID(page); + const app = getAppFrame(page); + + // Programmatically select the contents of the first text-layer span. + const selectedText = await app + .locator("#text-layer span") + .first() + .evaluate((span) => { + const range = span.ownerDocument.createRange(); + range.selectNodeContents(span); + const sel = span.ownerDocument.defaultView!.getSelection()!; + sel.removeAllRanges(); + sel.addRange(range); + return sel.toString().replace(/\s+/g, " ").trim(); + }); + expect(selectedText.length).toBeGreaterThan(0); + + await callInteract(page, { viewUUID, action: "get_viewer_state" }); + const raw = await readLastToolResult(page, 2); + const state = JSON.parse(unwrapTextResult(raw)); + + expect(state.currentPage).toBe(1); + expect(state.selection).not.toBeNull(); + expect(state.selection.text).toContain(selectedText); + expect(state.selection.boundingRect).toEqual( + expect.objectContaining({ + x: expect.any(Number), + y: expect.any(Number), + width: expect.any(Number), + height: expect.any(Number), + }), + ); + }); +}); diff --git a/tests/e2e/pdf-incremental-load.spec.ts b/tests/e2e/pdf-incremental-load.spec.ts new file mode 100644 index 0000000..52a99ee --- /dev/null +++ b/tests/e2e/pdf-incremental-load.spec.ts @@ -0,0 +1,271 @@ +import { test, expect, type Page } from "@playwright/test"; +import { + startRangeServer, + type RangeServer, +} from "../helpers/range-counting-server"; + +/** + * Regression guard for incremental PDF loading. + * + * Asserts that display_pdf does not pull the entire file before the viewer + * starts streaming, that form schema is still returned in the initial response, + * and that no byte range is fetched server-side more than once. + * + * The "noforms <30%" test is the load-bearing regression check: it fails on the + * pre-range-transport implementation (which downloads 100% during display_pdf + * for form analysis) and passes once form extraction uses range transport. + */ + +test.setTimeout(120_000); + +let rangeServer: RangeServer; + +test.beforeAll(async () => { + rangeServer = await startRangeServer(); +}); + +test.afterAll(async () => { + await rangeServer.close(); +}); + +test.beforeEach(() => { + rangeServer.resetStats(); +}); + +function getAppFrame(page: Page) { + return page.frameLocator("iframe").first().frameLocator("iframe").first(); +} + +async function waitForAppLoad(page: Page) { + const outerFrame = page.frameLocator("iframe").first(); + await expect(outerFrame.locator("iframe")).toBeVisible({ timeout: 30_000 }); +} + +/** + * Load basic-host, select PDF Server, call display_pdf with a custom URL. + * Resolves once the tool result panel appears (server-side display_pdf done); + * does NOT wait for the viewer iframe β€” call waitForAppLoad separately so + * byte-count assertions can isolate server-side fetches from viewer fetches. + */ +async function displayPdf(page: Page, url: string) { + await page.goto("/?theme=hide"); + await expect(page.locator("select").first()).toBeEnabled({ timeout: 30_000 }); + await page.locator("select").first().selectOption({ label: "PDF Server" }); + await page.locator("textarea").fill(JSON.stringify({ url })); + await page.click('button:has-text("Call Tool")'); + await expect(page.locator('text="πŸ“€ Tool Result"').first()).toBeVisible({ + timeout: 30_000, + }); +} + +/** Read and parse the most recent tool result's structuredContent. */ +async function readStructuredContent( + page: Page, +): Promise> { + const resultPanel = page.locator('text="πŸ“€ Tool Result"').first(); + await expect(resultPanel).toBeVisible({ timeout: 30_000 }); + await resultPanel.click(); + const pre = page.locator("pre").last(); + await expect(pre).toBeVisible({ timeout: 5_000 }); + const raw = (await pre.textContent()) ?? "{}"; + const parsed = JSON.parse(raw) as { structuredContent?: object }; + return (parsed.structuredContent ?? {}) as Record; +} + +async function waitForFirstPageRendered(page: Page) { + const canvas = getAppFrame(page).locator("canvas").first(); + await expect(canvas).toBeVisible({ timeout: 30_000 }); + await expect + .poll(async () => canvas.evaluate((c: HTMLCanvasElement) => c.width)) + .toBeGreaterThan(0); +} + +test.describe("PDF Server β€” incremental loading", () => { + test("display_pdf on a form PDF returns form fields in initial response", async ({ + page, + }) => { + await displayPdf(page, `${rangeServer.baseUrl}/forms.pdf`); + await waitForAppLoad(page); + const sc = await readStructuredContent(page); + const fields = sc.formFields as Array<{ name: string }> | undefined; + expect(fields?.map((f) => f.name).sort()).toEqual([ + "city", + "email", + "name", + "notes", + "phone", + ]); + }); + + test("display_pdf on a no-forms PDF stays under byte budget and bounded overlap", async ({ + page, + }) => { + const fileSize = rangeServer.fileSizes["/noforms.pdf"]; + await displayPdf(page, `${rangeServer.baseUrl}/noforms.pdf`); + + // Measure before the viewer iframe loads so the count reflects only the + // server-side display_pdf range fetches. + expect(rangeServer.stats().totalBytesServed).toBeLessThan(fileSize * 0.3); + + await waitForAppLoad(page); + const sc = await readStructuredContent(page); + expect(sc.formFields).toBeUndefined(); + + await waitForFirstPageRendered(page); + // Server-side display_pdf and the viewer each open the document + // independently, so the xref/trailer/catalog is fetched twice (β‰ˆ25%). + // This guards against the pre-range-transport behavior where the server + // alone pulled 100% (then 200% with the double-parse), giving overlap >> + // file size once the viewer also loaded. + expect(rangeServer.stats().overlapBytes).toBeLessThan(fileSize * 0.5); + }); + + test("first page renders under stall, then page 2 renders the >512KB image after release", async ({ + page, + }) => { + const fileSize = rangeServer.fileSizes["/noforms.pdf"]; + // Allow ~40% through (header + trailer/xref + page-1 content) then stall. + // The 1.1MB image stream referenced only by pages 2+ is the bulk. + const budget = Math.floor(fileSize * 0.4); + await displayPdf( + page, + `${rangeServer.baseUrl}/noforms.pdf?stallAfterBytes=${budget}`, + ); + await waitForAppLoad(page); + await waitForFirstPageRendered(page); + expect(rangeServer.stats().totalBytesServed).toBeLessThan(fileSize); + + rangeServer.release(); + const app = getAppFrame(page); + await app.locator("#next-btn").click(); + await expect(app.locator("#page-input")).toHaveValue("2", { + timeout: 30_000, + }); + // Page 2 references the ~1.1MB embedded JPEG. Rendering it exercises the + // viewer's range transport on a >MAX_CHUNK_BYTES object after the stall + // is released. (The server-side PdfCacheRangeTransport accumulate-once + // path is covered by the unit test in server.test.ts; on noforms.pdf + // display_pdf bails at the empty getFieldObjects() check before touching + // the image stream, so this test does not exercise it.) + await waitForFirstPageRendered(page); + expect(rangeServer.stats().totalBytesServed).toBeGreaterThan( + fileSize * 0.9, + ); + }); +}); + +// Kept in this spec because the test needs an HTTP-served PDF and the +// range-counting fixture is the convenient place; it does not use any +// byte-accounting features. +test.describe("PDF Server β€” annotation tombstone preservation", () => { + // FIXME(https://github.com/modelcontextprotocol/ext-apps/issues/642): + // basic-host doesn't replay the cached tool result on inner-iframe reload, + // and a fresh display_pdf call gets a new toolId β†’ new storage key, so the + // restore-from-localStorage path can't be reached. The fix itself is covered + // by the computeDiff/serializeDiff contract tests in + // src/pdf-annotations.test.ts. + test.fixme("deleted native annotation tombstone survives a persist before its page is scanned", async ({ + page, + }) => { + // Regression for the lazy baseline scan: restoredRemovedIds must be + // unioned into persistAnnotations() and getAnnotatedPdfBytes() so a + // delete on page 2 isn't silently dropped when an unrelated edit on + // page 1 triggers a persist before page 2 has been re-scanned. + + await displayPdf(page, `${rangeServer.baseUrl}/with-native-annot.pdf`); + await waitForAppLoad(page); + await waitForFirstPageRendered(page); + const sc = await readStructuredContent(page); + const viewUUID = sc.viewUUID as string; + expect(viewUUID).toBeTruthy(); + + const app = getAppFrame(page); + + // 1. Go to page 2, open the panel, delete the native annotation via UI. + await app.locator("#next-btn").click(); + await expect(app.locator("#page-input")).toHaveValue("2"); + await app.locator("#annotations-btn").click(); + const nativeCard = app.locator( + '.annotation-card[data-annotation-id^="pdf-"]', + ); + await expect(nativeCard).toBeVisible({ timeout: 10_000 }); + const nativeId = await nativeCard.getAttribute("data-annotation-id"); + expect(nativeId).toMatch(/^pdf-\d+R?$/); + await nativeCard.locator(".annotation-card-delete").click(); + // Deleting a native annotation re-renders the card as a crossed-out + // tombstone (annotation-panel.ts createRemovedAnnotationCard) with the + // same data-annotation-id β€” it doesn't disappear from the DOM. + await expect(nativeCard).toHaveClass(/annotation-card-cleared/); + + // 2. Back to page 1 so the post-reload viewer restores there (page 2 + // must stay unscanned until the very end). + await app.locator("#page-input").fill("1"); + await app.locator("#page-input").press("Enter"); + await expect(app.locator("#page-input")).toHaveValue("1"); + + // 3. Capture the annotation localStorage key and confirm the delete was + // persisted. + const storageKey = await app + .locator("body") + .evaluate( + () => + Object.keys(localStorage).find( + (k) => k.startsWith("pdf-annot:") || k.endsWith(":annotations"), + ) ?? null, + ); + expect(storageKey).toBeTruthy(); + const diffBefore = await app + .locator("body") + .evaluate((_, k) => localStorage.getItem(k), storageKey!); + expect(JSON.parse(diffBefore!).removed).toContain(nativeId); + + // 4. Reload the inner viewer iframe ONLY (basic-host keeps the same + // cached tool result β†’ same viewUUID/toolId β†’ same storage key). + // restoreAnnotations() now seeds restoredRemovedIds from localStorage + // while the lazy scan has only seen page 1. + await app.locator("body").evaluate(() => location.reload()); + await waitForFirstPageRendered(page); + await expect(app.locator("#page-input")).toHaveValue("1"); + + // 5. Trigger persistAnnotations() via an unrelated edit on page 1 β€” the + // bug scenario: page 2 has not been scanned yet. + const toolSelect = page.locator("select").nth(1); + await toolSelect.selectOption("interact"); + await page.locator("textarea").fill( + JSON.stringify({ + viewUUID, + action: "add_annotations", + annotations: [ + { + id: "probe-on-page-1", + type: "highlight", + page: 1, + rects: [{ x: 50, y: 700, width: 100, height: 12 }], + }, + ], + }), + ); + await page.click('button:has-text("Call Tool")'); + await expect( + app.locator('[data-annotation-id="probe-on-page-1"]'), + ).toHaveCount(1, { timeout: 10_000 }); + + // 6. Load-bearing assertion: the persisted diff still carries the + // tombstone. Pre-fix, computeDiff() over the page-1-only baseline + // yielded removed=[], overwriting it. + const diffAfter = await app + .locator("body") + .evaluate((_, k) => localStorage.getItem(k), storageKey!); + const removedAfter: string[] = JSON.parse(diffAfter!).removed; + expect(removedAfter).toContain(nativeId); + + // 7. Belt-and-suspenders: navigate to page 2 (lazy scan now sees the + // native annotation) and confirm the panel shows it as a cleared + // tombstone, not a live (resurrected) card. + await app.locator("#next-btn").click(); + await expect(app.locator("#page-input")).toHaveValue("2"); + await expect( + app.locator(`.annotation-card[data-annotation-id="${nativeId}"]`), + ).toHaveClass(/annotation-card-cleared/); + }); +}); diff --git a/tests/e2e/pdf-viewer-zoom.spec.ts b/tests/e2e/pdf-viewer-zoom.spec.ts new file mode 100644 index 0000000..574809b --- /dev/null +++ b/tests/e2e/pdf-viewer-zoom.spec.ts @@ -0,0 +1,198 @@ +import { test, expect, type Page } from "@playwright/test"; + +/** + * PDF Viewer zoom + fullscreen-fit tests. + * + * Covers: + * - Inline β†’ fullscreen refits the page (the cramped inline scale is dropped) + * - Trackpad pinch (wheel + ctrlKey) zooms the page in fullscreen + * - Pinch zoom is ignored in inline mode + */ + +test.setTimeout(120000); + +function getAppFrame(page: Page) { + return page.frameLocator("iframe").first().frameLocator("iframe").first(); +} + +async function loadPdfServer(page: Page) { + await page.goto("/?theme=hide"); + await expect(page.locator("select").first()).toBeEnabled({ timeout: 30000 }); + await page.locator("select").first().selectOption({ label: "PDF Server" }); + await page.click('button:has-text("Call Tool")'); + // Wait for nested app iframe to mount + const outer = page.frameLocator("iframe").first(); + await expect(outer.locator("iframe")).toBeVisible({ timeout: 30000 }); +} + +async function waitForPdfRender(page: Page) { + const app = getAppFrame(page); + // Canvas reports a non-zero CSS width once renderPage() has sized it. + // toBeVisible alone isn't enough β€” the canvas exists at 0Γ—0 before + // first paint, so a fast test would race the render. + await expect + .poll( + async () => { + const w = await app + .locator("#pdf-canvas") + .evaluate((el: HTMLCanvasElement) => parseFloat(el.style.width)); + return w > 0 ? w : 0; + }, + { timeout: 30000 }, + ) + .toBeGreaterThan(0); +} + +/** Read the current zoom level (e.g. "65%") and return the integer percent. */ +async function readZoomPercent(page: Page): Promise { + const text = await getAppFrame(page).locator("#zoom-level").textContent(); + const m = text?.match(/(\d+)%/); + if (!m) throw new Error(`Unexpected zoom-level text: ${text}`); + return parseInt(m[1], 10); +} + +test.describe("PDF Viewer β€” fullscreen fit + pinch zoom", () => { + test("entering fullscreen drops the inline shrink-to-fit scale", async ({ + page, + }) => { + // Start narrow so the initial fit-to-width lands below 100%. + // The default arxiv PDF is ~612pt wide; a 500px iframe forces a + // fit scale around 60-70%. + await page.setViewportSize({ width: 500, height: 800 }); + await loadPdfServer(page); + await waitForPdfRender(page); + const app = getAppFrame(page); + + // Initial fit-to-width measures container.clientWidth immediately after + // showViewer() flips display:flex; under CI load the reflow can lag, so + // poll until the shrink-to-fit scale has actually applied. + await expect + .poll(() => readZoomPercent(page), { timeout: 5000 }) + .toBeLessThan(100); + const inlineZoom = await readZoomPercent(page); + + // Widen + give plenty of height, then enter fullscreen. Fullscreen uses + // fit-to-PAGE (whole page visible), so the resulting zoom is whichever + // axis is tighter. We just assert it's higher than the cramped inline + // value AND that the page actually fits without scrolling. + await page.setViewportSize({ width: 1400, height: 1000 }); + await app.locator("#fullscreen-btn").click(); + await expect(app.locator(".main.fullscreen")).toBeVisible({ + timeout: 5000, + }); + + await expect + .poll(() => readZoomPercent(page), { timeout: 5000 }) + .toBeGreaterThan(inlineZoom); + + // Whole page visible β†’ no scroll inside the canvas-container. + const overflows = await app + .locator(".canvas-container") + .evaluate( + (el: HTMLElement) => + el.scrollHeight > el.clientHeight + 2 || + el.scrollWidth > el.clientWidth + 2, + ); + expect(overflows).toBe(false); + }); + + test("trackpad pinch (wheel + ctrlKey) zooms in fullscreen", async ({ + page, + }) => { + await page.setViewportSize({ width: 1400, height: 800 }); + await loadPdfServer(page); + await waitForPdfRender(page); + const app = getAppFrame(page); + + // Go fullscreen first β€” pinch is fullscreen-only. + await app.locator("#fullscreen-btn").click(); + await expect(app.locator(".main.fullscreen")).toBeVisible({ + timeout: 5000, + }); + // Let the entering-fullscreen fit-to-page refit settle. + await page.waitForTimeout(500); + const before = await readZoomPercent(page); + + // Dispatch a synthetic trackpad pinch-OUT on the canvas-container. + // ctrlKey:true is what Chrome/FF/Edge/Safari emit for trackpad pinch; + // deltaY > 0 = zoom out. We pinch out so we don't hit ZOOM_MAX. + // Can't use page.mouse.wheel β€” it doesn't expose ctrlKey. + await app.locator(".canvas-container").evaluate((el) => { + el.dispatchEvent( + new WheelEvent("wheel", { + deltaY: 50, + ctrlKey: true, + bubbles: true, + cancelable: true, + }), + ); + }); + + // The viewer applies a CSS transform live, then commits to a real + // renderPage() after a 150ms settle timer. exp(-50/100) β‰ˆ 0.607. + await expect + .poll(() => readZoomPercent(page), { timeout: 5000 }) + .toBeLessThan(before * 0.8); + + // The CSS transform should be cleared once committed (so the canvas + // isn't double-scaled β€” the new render IS the new scale). + await expect + .poll( + () => + app + .locator(".page-wrapper") + .evaluate((el: HTMLElement) => el.style.transform), + { timeout: 5000 }, + ) + .toBe(""); + }); + + test("trackpad pinch-in while inline enters fullscreen", async ({ page }) => { + await page.setViewportSize({ width: 1400, height: 800 }); + await loadPdfServer(page); + await waitForPdfRender(page); + const app = getAppFrame(page); + + await expect(app.locator(".main.fullscreen")).toHaveCount(0); + + await app.locator(".canvas-container").evaluate((el) => { + el.dispatchEvent( + new WheelEvent("wheel", { + deltaY: -50, + ctrlKey: true, + bubbles: true, + cancelable: true, + }), + ); + }); + + // Pinch-in should request fullscreen, not zoom the inline view. + await expect(app.locator(".main.fullscreen")).toHaveCount(1, { + timeout: 5000, + }); + }); + + test("trackpad pinch-out while inline is a no-op", async ({ page }) => { + await page.setViewportSize({ width: 1400, height: 800 }); + await loadPdfServer(page); + await waitForPdfRender(page); + const app = getAppFrame(page); + + const before = await readZoomPercent(page); + + await app.locator(".canvas-container").evaluate((el) => { + el.dispatchEvent( + new WheelEvent("wheel", { + deltaY: 50, // pinch-out + ctrlKey: true, + bubbles: true, + cancelable: true, + }), + ); + }); + + await page.waitForTimeout(300); + expect(await readZoomPercent(page)).toBe(before); + await expect(app.locator(".main.fullscreen")).toHaveCount(0); + }); +}); diff --git a/tests/e2e/security.spec.ts b/tests/e2e/security.spec.ts index 273e8cc..8fb94e3 100644 --- a/tests/e2e/security.spec.ts +++ b/tests/e2e/security.spec.ts @@ -290,8 +290,10 @@ test.describe("Origin Validation Infrastructure", () => { const outerIframe = page.locator("iframe").first(); const outerSandbox = await outerIframe.getAttribute("sandbox"); - // Outer frame should NOT have allow-same-origin (different origin from host) - // This ensures the sandbox cannot access host window properties + // Outer frame should NOT have allow-top-navigation (prevents navigating the host page). + // Isolation from the host comes from the separate origin (sandbox runs on port 8081 + // vs host's 8080), not from omitting allow-same-origin β€” the outer frame has it + // (see implementation.ts:167). expect(outerSandbox).not.toContain("allow-top-navigation"); // The app should still function despite the restrictions @@ -313,36 +315,27 @@ test.describe("Cross-App Message Injection Protection", () => { test("app rejects messages from sources other than its parent", async ({ page, }) => { - // Capture any "unknown source" rejection logs - const rejectionLogs: string[] = []; - page.on("console", (msg) => { - const text = msg.text(); - if ( - text.includes("unknown source") || - text.includes("Ignoring message") - ) { - rejectionLogs.push(text); - } - }); + // Capture rejection logs from message-transport.ts (console.debug) + const rejectionLogs = captureConsoleLogs( + page, + /Ignoring message from unknown source/, + ); await loadServer(page, "Integration Test Server"); + await expect(getAppFrame(page).locator("body")).toBeVisible(); - const appFrame = getAppFrame(page); - await expect(appFrame.locator("body")).toBeVisible(); - - // Try to inject a message from the page context (simulating cross-app attack) - // This simulates what would happen if another app tried to postMessage to this app - await page.evaluate(() => { - // Get reference to the inner app iframe - const outerIframe = document.querySelector("iframe"); - if (!outerIframe?.contentWindow) return; - - const innerIframe = outerIframe.contentDocument?.querySelector("iframe"); - if (!innerIframe?.contentWindow) return; - - // Try to send a fake JSON-RPC message (simulating malicious app) - // This should be rejected because event.source won't match window.parent - innerIframe.contentWindow.postMessage( + // window.frames[] IS cross-origin accessible per HTML spec (unlike + // contentDocument, which is null across the 8080β†’8081 boundary β€” see the + // test above at "sandbox cross-origin boundary prevents direct frame + // access"). This is the real attack path from the threat model comment: a + // malicious sibling app can reach + // window.parent.parent.frames[victimIdx].frames[0].postMessage(...) + // and the message WILL be delivered. PostMessageTransport's event.source + // check is the only defense. + const injected = await page.evaluate(() => { + const victim = (window.frames[0] as Window | undefined)?.frames?.[0]; + if (!victim) return "UNREACHABLE"; + victim.postMessage( { jsonrpc: "2.0", result: { content: [{ type: "text", text: "Injected!" }] }, @@ -350,23 +343,19 @@ test.describe("Cross-App Message Injection Protection", () => { }, "*", ); + return "POSTED"; }); - // Wait for message to be processed - await page.waitForTimeout(500); + // Sentinel β€” if frames[] traversal ever breaks (e.g. frame hierarchy + // changes), the test FAILS here instead of passing vacuously. The previous + // version of this test used contentDocument?.querySelector() which + // silently short-circuited to undefined and never posted anything. + expect(injected).toBe("POSTED"); - // The injected message should have been rejected - // (it won't cause visible harm even if not logged, but ideally we see rejection) - // The app should still be functional (not corrupted by the injection) - await expect(appFrame.locator("body")).toBeVisible(); - - // Verify legitimate communication still works after attempted injection - const sendMessageBtn = appFrame.locator('button:has-text("Send Message")'); - if (await sendMessageBtn.isVisible()) { - await sendMessageBtn.click(); - await page.waitForTimeout(300); - // If we get here without errors, the app wasn't corrupted - } + // Assert PostMessageTransport rejected it (event.source !== window.parent) + await expect + .poll(() => rejectionLogs.length, { timeout: 2000 }) + .toBeGreaterThan(0); }); test("PostMessageTransport is configured with source validation", async ({ diff --git a/tests/e2e/servers.spec.ts-snapshots/debug-server.png b/tests/e2e/servers.spec.ts-snapshots/debug-server.png index c1fc4ad..2b902e3 100644 Binary files a/tests/e2e/servers.spec.ts-snapshots/debug-server.png and b/tests/e2e/servers.spec.ts-snapshots/debug-server.png differ diff --git a/tests/helpers/assets/fw9.pdf b/tests/helpers/assets/fw9.pdf new file mode 100644 index 0000000..c5eb646 Binary files /dev/null and b/tests/helpers/assets/fw9.pdf differ diff --git a/tests/helpers/range-counting-server.ts b/tests/helpers/range-counting-server.ts new file mode 100644 index 0000000..6f0dcd7 --- /dev/null +++ b/tests/helpers/range-counting-server.ts @@ -0,0 +1,254 @@ +/** + * HTTP test fixture serving programmatically-generated PDFs with byte-range + * accounting. Used by pdf-incremental-load.spec.ts to assert that display_pdf + * doesn't pull the whole file before the viewer starts streaming. + * + * Plain HTTP on loopback β€” playwright.config.ts sets + * PDF_SERVER_ALLOW_LOOPBACK_HTTP=1 so validateUrl accepts http://127.0.0.1. + */ +import http from "node:http"; +import type { AddressInfo } from "node:net"; +import { + PDFDocument, + PDFName, + PDFString, + StandardFonts, +} from "@cantoo/pdf-lib"; + +export interface RangeServerStats { + /** Total bytes written across all responses (sum of slice lengths). */ + totalBytesServed: number; + /** Bytes that were served more than once for the same path. */ + overlapBytes: number; +} + +export interface RangeServer { + port: number; + baseUrl: string; + /** Map of served path β†’ byte length. */ + fileSizes: Record; + stats(): RangeServerStats; + resetStats(): void; + /** Resolve any requests currently stalled by ?stallAfterBytes=N. */ + release(): void; + close(): Promise; +} + +const LOREM = + "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod " + + "tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim " + + "veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea " + + "commodo consequat. "; + +async function buildNoFormsPdf(): Promise { + const doc = await PDFDocument.create(); + const font = await doc.embedFont(StandardFonts.Helvetica); + // Page 1 is text-only (small) so first paint needs minimal bytes. Pages 2+ + // each reference a large embedded JPEG so the bulk of the file is in image + // streams page 1 doesn't need. The stallAfterBytes test holds those back + // and asserts page 1 still renders. The image is >MAX_CHUNK_BYTES (512KB) + // so rendering page 2 also exercises the viewer's >512KB range path. + const big = await doc.embedJpg(makeRandomJpeg(1_100 * 1024)); + const page1 = doc.addPage([612, 792]); + for (let line = 0; line < 30; line++) { + page1.drawText(`1.${line + 1} ${LOREM}`, { + x: 36, + y: 760 - line * 22, + size: 10, + font, + }); + } + for (let p = 1; p < 20; p++) { + const page = doc.addPage([612, 792]); + page.drawImage(big, { x: 36, y: 200, width: 540, height: 540 }); + page.drawText(`Page ${p + 1}`, { x: 36, y: 760, size: 10, font }); + } + return doc.save(); +} + +/** Minimal valid JPEG with `len` bytes of incompressible scan data. */ +export function makeRandomJpeg(len: number): Uint8Array { + // SOI, APP0 (JFIF), SOF0 (baseline 8x8 1-component), DHT (minimal), + // SOS, , EOI. pdf-lib only needs to parse the headers + // to embed; the scan data is opaque. + const header = Uint8Array.from([ + 0xff, 0xd8, 0xff, 0xe0, 0x00, 0x10, 0x4a, 0x46, 0x49, 0x46, 0x00, 0x01, + 0x01, 0x00, 0x00, 0x01, 0x00, 0x01, 0x00, 0x00, 0xff, 0xc0, 0x00, 0x0b, + 0x08, 0x00, 0x08, 0x00, 0x08, 0x01, 0x01, 0x11, 0x00, 0xff, 0xc4, 0x00, + 0x14, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xda, 0x00, 0x08, 0x01, + 0x01, 0x00, 0x00, 0x3f, 0x00, + ]); + const scan = new Uint8Array(len); + for (let i = 0; i < len; i++) scan[i] = (i * 1103515245 + 12345) & 0xff; + // Avoid 0xFF in scan data so we don't accidentally form a marker. + for (let i = 0; i < len; i++) if (scan[i] === 0xff) scan[i] = 0xfe; + const eoi = Uint8Array.from([0xff, 0xd9]); + const out = new Uint8Array(header.length + scan.length + eoi.length); + out.set(header, 0); + out.set(scan, header.length); + out.set(eoi, header.length + scan.length); + return out; +} + +/** + * Two pages, page 1 text-only, page 2 carries one native /Text (sticky-note) + * annotation. Used by the tombstone-preservation e2e: the viewer's lazy + * baseline scan must not have visited page 2 when persistAnnotations runs. + */ +async function buildWithNativeAnnotPdf(): Promise { + const doc = await PDFDocument.create(); + const font = await doc.embedFont(StandardFonts.Helvetica); + const page1 = doc.addPage([612, 792]); + page1.drawText("Page 1 β€” no native annotations here.", { + x: 36, + y: 740, + size: 12, + font, + }); + const page2 = doc.addPage([612, 792]); + page2.drawText("Page 2 β€” has one native /Text annot.", { + x: 36, + y: 740, + size: 12, + font, + }); + const annotRef = doc.context.register( + doc.context.obj({ + Type: "Annot", + Subtype: "Text", + Rect: [100, 700, 120, 720], + Contents: PDFString.of("native sticky note"), + Open: false, + Name: "Comment", + }), + ); + page2.node.set(PDFName.of("Annots"), doc.context.obj([annotRef])); + return doc.save(); +} + +async function buildFormsPdf(): Promise { + const doc = await PDFDocument.create(); + const form = doc.getForm(); + for (let p = 0; p < 2; p++) doc.addPage([612, 792]); + const [page1] = doc.getPages(); + const fields = ["name", "email", "phone", "city", "notes"]; + fields.forEach((name, i) => { + const f = form.createTextField(name); + f.addToPage(page1, { x: 100, y: 650 - i * 60, width: 300, height: 24 }); + }); + return doc.save(); +} + +export async function startRangeServer(): Promise { + if (process.env.NODE_ENV === "production") { + throw new Error( + "range-counting-server is a test fixture; refusing to start with NODE_ENV=production", + ); + } + const files: Record = { + "/noforms.pdf": await buildNoFormsPdf(), + "/forms.pdf": await buildFormsPdf(), + "/with-native-annot.pdf": await buildWithNativeAnnotPdf(), + }; + const fileSizes = Object.fromEntries( + Object.entries(files).map(([k, v]) => [k, v.length]), + ); + + // Per-path hit count per byte, for overlap accounting. + const hitCounts: Record = {}; + const initHits = () => { + for (const [k, v] of Object.entries(files)) { + hitCounts[k] = new Uint8Array(v.length); + } + }; + initHits(); + + let totalBytesServed = 0; + let releaseResolve: (() => void) | undefined; + let releasePromise = new Promise((r) => (releaseResolve = r)); + + const server = http.createServer(async (req, res) => { + const url = new URL(req.url ?? "/", "http://127.0.0.1"); + const body = files[url.pathname]; + if (!body) { + res.writeHead(404).end(); + return; + } + + const stallAfterBytes = url.searchParams.get("stallAfterBytes"); + const total = body.length; + const range = req.headers.range; + + let begin = 0; + let end = total; // exclusive + let status = 200; + if (range) { + const m = /^bytes=(\d+)-(\d*)$/.exec(range); + if (m) { + begin = parseInt(m[1], 10); + end = m[2] ? parseInt(m[2], 10) + 1 : total; + begin = Math.min(begin, total); + end = Math.min(end, total); + status = 206; + } + } + + // Stall once N bytes have already been served β€” lets pdfjs read the + // header/trailer/xref (scattered across the file) before blocking the + // bulk content streams. + if (stallAfterBytes !== null) { + if (totalBytesServed >= parseInt(stallAfterBytes, 10)) { + await releasePromise; + } + } + + const slice = body.subarray(begin, end); + totalBytesServed += slice.length; + const hits = hitCounts[url.pathname]; + for (let i = begin; i < end; i++) hits[i]++; + + const headers: Record = { + "Content-Type": "application/pdf", + "Accept-Ranges": "bytes", + "Content-Length": String(slice.length), + }; + if (status === 206) { + headers["Content-Range"] = `bytes ${begin}-${end - 1}/${total}`; + } + res.writeHead(status, headers); + res.end(slice); + }); + + await new Promise((resolve) => server.listen(0, resolve)); + const port = (server.address() as AddressInfo).port; + + return { + port, + baseUrl: `http://127.0.0.1:${port}`, + fileSizes, + stats() { + let overlapBytes = 0; + for (const hits of Object.values(hitCounts)) { + for (let i = 0; i < hits.length; i++) if (hits[i] > 1) overlapBytes++; + } + return { totalBytesServed, overlapBytes }; + }, + resetStats() { + totalBytesServed = 0; + initHits(); + // Unblock any handlers parked on the previous stall before re-arming, + // otherwise they hold sockets open forever and close() hangs. + releaseResolve?.(); + releasePromise = new Promise((r) => (releaseResolve = r)); + }, + release() { + releaseResolve?.(); + }, + close() { + releaseResolve?.(); + server.closeAllConnections?.(); + return new Promise((resolve) => server.close(() => resolve())); + }, + }; +} diff --git a/tsconfig.json b/tsconfig.json index 08ff110..934b950 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "types": ["node", "bun"], "target": "ES2020", "module": "ESNext", "lib": ["ES2020", "DOM"], diff --git a/typedoc.config.mjs b/typedoc.config.mjs index a97bb29..c9b9476 100644 --- a/typedoc.config.mjs +++ b/typedoc.config.mjs @@ -1,5 +1,7 @@ import { OptionDefaults } from "typedoc"; +const BASE_SDK_DOCS = "https://ts.sdk.modelcontextprotocol.io/v2/"; + /** @type {Partial} */ const config = { name: "MCP Apps", @@ -17,6 +19,7 @@ const config = { "docs/authorization.md", "docs/csp-cors.md", "docs/migrate_from_openai_apps.md", + "docs/migrate-to-2.md", ], entryPoints: [ "src/server/index.ts", @@ -28,7 +31,32 @@ const config = { ], excludePrivate: true, excludeInternal: false, - intentionallyNotExported: ["AppOptions"], + intentionallyNotExported: ["RequestHandlerExtra"], + externalSymbolLinkMappings: { + "@modelcontextprotocol/client": { + ClientOptions: BASE_SDK_DOCS, + ConnectOptions: BASE_SDK_DOCS, + DiscoverResult: BASE_SDK_DOCS, + "MessageExtraInfo.classification": BASE_SDK_DOCS, + ProtocolError: BASE_SDK_DOCS, + "Protocol.close": BASE_SDK_DOCS, + "Protocol.notification": BASE_SDK_DOCS, + ResponseCacheStore: BASE_SDK_DOCS, + SdkError: BASE_SDK_DOCS, + "SdkErrorCode.MethodNotSupportedByProtocolVersion": BASE_SDK_DOCS, + StandardJSONSchemaV1: BASE_SDK_DOCS, + "SdkErrorCode.UnsupportedResultType": BASE_SDK_DOCS, + "__type.enforceStrictCapabilities": BASE_SDK_DOCS, + }, + "@modelcontextprotocol/server": { + LoggingMessageNotification: BASE_SDK_DOCS, + "McpServer.registerTool": BASE_SDK_DOCS, + "MessageExtraInfo.classification": BASE_SDK_DOCS, + "Protocol.close": BASE_SDK_DOCS, + "Protocol.notification": BASE_SDK_DOCS, + "SdkErrorCode.UnsupportedResultType": BASE_SDK_DOCS, + }, + }, blockTags: [...OptionDefaults.blockTags, "@description"], jsDocCompatibility: { exampleTag: false, @@ -49,6 +77,7 @@ const config = { out: "docs/api", plugin: [ "typedoc-github-theme", + "./scripts/typedoc-plugin-base-sdk-links.mjs", "./scripts/typedoc-plugin-fix-mermaid-entities.mjs", "./scripts/typedoc-plugin-seo.mjs", "./scripts/typedoc-plugin-mcpstyle.mjs",