diff --git a/.cargo/config.toml b/.cargo/config.toml index 57fad0d6..3942b26c 100644 --- a/.cargo/config.toml +++ b/.cargo/config.toml @@ -1,3 +1,9 @@ [build] # Place target directory outside the repository to keep source tree clean target-dir = "../target" + +# Fast debug builds: rust-lld links several times faster than link.exe. +# Debug-only policy (issue #192): release builds ship via release.yml and are +# built there explicitly, never locally. +[target.x86_64-pc-windows-msvc] +linker = "rust-lld" diff --git a/.github/workflows/bump-develop.yml b/.github/workflows/bump-develop.yml index bb6fa0ab..71485a12 100644 --- a/.github/workflows/bump-develop.yml +++ b/.github/workflows/bump-develop.yml @@ -75,7 +75,7 @@ jobs: echo "new=$NEW" >> "$GITHUB_OUTPUT" echo "::notice::Bump $CURRENT -> $NEW" - - name: Bump version in Cargo.toml + Cargo.lock + - name: Bump version in Cargo.toml, Cargo.lock + scip-csharp.csproj env: CURRENT: ${{ steps.ver.outputs.current }} NEW: ${{ steps.ver.outputs.new }} @@ -88,9 +88,15 @@ jobs: # dependency versions (unlike `cargo update --workspace`, which would # opportunistically bump transitive deps as a side effect). sed -i "/^name = \"codesearch\"/,/^version = /{ s/^version = \"$CURRENT\"/version = \"$NEW\"/ }" Cargo.lock - # Hard-verify both files now carry the new version before committing. + # scip-csharp.csproj — the helper's feeds its --version line, + # the same-build identity the host logs and copy-to-common compares. + # Rewrite WHATEVER value is there, never anchor on $CURRENT: once the + # files drift apart the substitution silently no-ops forever. + sed -i "0,/[^<]*<\/Version>/s//$NEW<\/Version>/" helpers/csharp/scip-csharp.csproj + # Hard-verify all three files now carry the new version before committing. grep -m1 "^version = \"$NEW\"" Cargo.toml >/dev/null grep -A1 '^name = "codesearch"$' Cargo.lock | grep -m1 "^version = \"$NEW\"" >/dev/null + grep -m1 "$NEW" helpers/csharp/scip-csharp.csproj >/dev/null - name: Commit & push bump env: @@ -100,7 +106,7 @@ jobs: set -euo pipefail git config user.name "github-actions[bot]" git config user.email "41898282+github-actions[bot]@users.noreply.github.com" - git add Cargo.toml Cargo.lock + git add Cargo.toml Cargo.lock helpers/csharp/scip-csharp.csproj # No-op guard (e.g. a re-merge that already left develop at NEW). if git diff --cached --quiet; then echo "No version change to commit (already at $NEW)." diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 610c0161..bbeae872 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -111,6 +111,17 @@ jobs: if: steps.changed.outputs.relevant == 'true' with: dotnet-version: '10.0.x' + # The xunit suite (models, key format, workspace/restore policy and the + # Blazor generator integration pin) must run in CI: until now only the + # cargo integration tests ran here, so a helper regression the xunit + # suite pins stayed green all the way to develop. Runs BEFORE the + # expensive publish + cargo cycle so a helper failure fails fast. + # NO MSBuild flags on dotnet test — the test SDK answers "Zero tests + # ran" (exit 5) with them, a false negative that survives a clean + # rebuild (repo convention). + - name: Run scip-csharp xunit suite + if: steps.changed.outputs.relevant == 'true' + run: dotnet test helpers/csharp/tests/ScipCsharp.Tests.csproj - name: Build scip-csharp helper (self-contained single-file) if: steps.changed.outputs.relevant == 'true' run: | diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 12de8ea0..c65c22eb 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -126,14 +126,14 @@ jobs: - name: Upload kale artifact # pin@v4 - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a + uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 with: name: ${{ matrix.artifact }} path: ${{ matrix.artifact }} - name: Upload with-csharp artifact # pin@v4 - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a + uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 with: name: ${{ matrix.artifact_csharp }} path: ${{ matrix.artifact_csharp }} @@ -232,14 +232,14 @@ jobs: - name: Upload kale artifact # pin@v4 - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a + uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 with: name: codesearch-macos-arm64.tar.gz path: codesearch-macos-arm64.tar.gz - name: Upload with-csharp artifact # pin@v4 - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a + uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 with: name: codesearch-macos-arm64-with-csharp.tar.gz path: codesearch-macos-arm64-with-csharp.tar.gz @@ -253,7 +253,7 @@ jobs: steps: - name: Download all artifacts # pin@v4 - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c + uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 with: path: artifacts merge-multiple: true diff --git a/AGENTS.develop.md b/AGENTS.develop.md index 9088733b..b68a6d40 100644 --- a/AGENTS.develop.md +++ b/AGENTS.develop.md @@ -187,7 +187,7 @@ TUI `i` overlay. The TUI discovery tick is config-only (zero HTTP). ## Runtime locations - **Runtime dir**: `C:\Users\develterf\.local\bin\` — contains `codesearch.exe` and `helpers/csharp/scip-csharp.exe`. This is where `codesearch serve` runs from. -- **Build:** via `build.ps1` (repo root) — it self-heals the bare-flag quirk and sets `CARGO_TARGET_DIR` so `target/` stays outside the repo. +- **Build:** via `build.ps1` (repo root) — it self-heals the bare-flag quirk and sets `CARGO_TARGET_DIR` so `target/` stays outside the repo. Debug-only (issue #192): `-Release` is refused, release artifacts come from CI; rust-lld is pinned in `.cargo/config.toml` (bin rebuild ~2x faster). - **Build dir**: `target/release/` — lives **outside the repo** (set via `CARGO_TARGET_DIR`). For compilation only. Never run codesearch from this location. - **Logs**: `~\.codesearch\logs\` — codesearch writes structured logs here during serve. Check these for startup errors, rebuild failures, and helper detection messages. @@ -200,6 +200,7 @@ TUI `i` overlay. The TUI discovery tick is config-only (zero HTTP). ## Notes for agents +- **Before direct git work in this checkout, force `git config core.bare false`.** This repo is a bare+working-tree hybrid (`codesearch.git` holds a full checkout) and VS Code's git integration intermittently resets `core.bare` to `true` on ref changes, breaking every git operation outside `build.ps1`/`copy-to-common.ps1` (both self-heal it before building). Symptom: "fatal: this operation must be run in a work tree" from an otherwise intact checkout. - **Never use the bundled `codesearch` binary to investigate this repo** (it is the project under development). Use codesearch MCP tools first for discovery (this repo is indexed as `codesearch-git`); `grep`/`Read` for exact refs, other git refs, or when MCP returns nothing. - **Tests live in sibling `_tests.rs` files**, table-driven preferred over near-duplicate per-case fns. - **Tests that set env vars must be `#[serial]`** and set them via `crate::testing::EnvRestore` — cargo runs tests as parallel threads of one process, so an unserialised `set_var` races every reader. @@ -235,12 +236,20 @@ Never `unwrap_or_default()` a store error on a search path — "no results" and | Branch | Description | |---|---| -| *(none)* | | --- ## Changelog highlights (recent) +- **v1.5.31 (pending)** — scip-csharp VS-MSBuild restore fallback: NETSDK1045-class CLI SDK gaps (hollow SDK dir, net10-only-in-VS) retry via vswhere + `MSBuild -t:restore`, and MSBuild registration picks a VS instance when no CLI SDK can target the repo +- **v1.5.31 (pending)** — serve TUI status: `Indexing` only for real text indexing (pure SCIP rebuilds drive the C#/TS columns only); resting repos read `Idle` again +- **v1.5.16 (pending)** — C# restore-pending retries 20×60s → 3 attempts with exponential backoff; restore exhaustion renders as yellow C#⚠ partial on every serve path instead of a red error +- **v1.5.6 (pending)** — scip-csharp demotes MSBuild check advisories + BuildHost shutdown chatter from index warnings +- **v1.5.15 (pending)** — CLI add/reindex refuse to build locally when the serve reports the alias already indexing (409 two-writer case); other delegation failures keep the local fallback +- **v1.5.14 (pending)** — db dir marked hidden on Windows: the Search indexer no longer crawls `.codesearch.db` (structural fix for the scanner race on fresh Tantivy segments) +- **v1.5.13 (pending)** — symbol-index status (ready/stale/degraded/absent) on REST info, both TUIs and every find_impact answer; vanishing-repo fix: transient FTS commit race gets one full-pass retry and failed first builds keep the repo registered +- **v1.5.5** — serve TUI: symbol-index warnings wrap instead of clipping and `c` copies them to the clipboard +- **v1.5.4** — restore gate: CPM-aware restore freshness (Directory.Packages.props etc.), restore-pending exit 75 with host-side bounded retry, previous index stays live during restore, watcher fires full C# rebuild on restore-input changes - **v1.4.4** — resident C# workspace pool no longer serves stale `find_impact` results after a rebuild: `WorkspacePool::evict` bumps a per-solution generation counter closing a spawn-in-flight race, and `scip_ref_cache` is now cleared unconditionally on both full and incremental rebuilds - **v1.3.37** — per-index embedding models end-to-end: serve queries, `POST /repos` and CLI index/stats/status honour the model each index records in its `metadata.json`; `serve --model` sets the default for newly created indexes; unrecorded indexes are queried with the built-in model plus a caller-facing warning; mid-rebuild indexes no longer report ready (PR #248) - **v1.3.23–v1.3.36** — dependency + platform wave: rmcp 3.3, fastembed 6.1 + ort rc.13, tantivy 0.26, axum 0.8, ratatui 0.30 + crossterm 0.29, thiserror 2, notify 8, tree-sitter 0.27, dirs/sha2/scip/sysinfo refresh + dependabot (weekly); clears the open Aikido/RUSTSEC advisories diff --git a/CHANGELOG.md b/CHANGELOG.md index fa375c13..724cab8f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,6 +14,137 @@ more PRs land; when the release is actually tagged, the same section is finalized in place with a date — no renaming/migration step needed. --> +## [1.5.31] + +### Changed + +- **scip-csharp retries the solution restore with the VS MSBuild when the CLI SDK set cannot target the repo.** When `dotnet restore` fails on SDK resolution (NETSDK1045 — CLI SDKs older than the repo's TFM — or an unsatisfiable `global.json`; detection reads stdout AND stderr, because NETSDK1045 prints to stdout on current hosts), the helper locates the newest VS MSBuild via vswhere and retries the restore once with `MSBuild -t:restore` — VS ships its own MSBuild + SDK targets independent of `C:\Program Files\dotnet`, so it restores solutions the CLI cannot even evaluate. Timeout keeps the existing pending-marker/gated-exit-75 contract (a hung VS restore is never killed); on VS failure the per-project fallback still runs. The workspace-load MSBuild registration is now capability-aware too: when every CLI SDK instance is older than the repo's raw-text TFM floor (max over all `TargetFrameworks` + the nearest `global.json` major), the highest VS instance is registered instead — otherwise an SDK 8 instance would evaluate net10 projects into certain NETSDK1045 load failures even with fresh assets. On healthy machines the choice is unchanged (single-SDK machines byte-identical; multi-SDK machines now deterministically take the highest qualifying SDK, was first-enumerated). Motivated by the 2026-10-15 field incident: a hollow `10.0.101` SDK dir left the CLI blind to net10 on a machine where VS built fine, degrading every net10 repo's symbol index to "0 projects loaded". + +- **The serve TUI status column no longer shows `Indexing` for a pure symbol (SCIP) rebuild.** Only text-indexing flows (startup warmup, file-watcher batches, explicit reindex) light the general repo label; a C#/TypeScript symbol rebuild — including a long restore-pending retry loop — drives only the language columns, so a busy C# pass can no longer read as "the normal index is stuck behind the SCIP index". A queued phase-2 rebuild stays visible in the C# column only. The `/status` wire vocabulary is unchanged. A repo whose index is on disk but which is not loaded renders `Idle` again — the interim `idx` rendering read as active indexing on done, non-SCIP repos. + +## [1.5.30] + +### Fixed + +- **File metadata is persisted once per index batch instead of once per pass.** The vector and FTS stores already commit per batch, but the file-meta cache was only written at the very end of a refresh pass — a serve restart (or a failed FTS commit) mid-pass left the meta empty while chunks existed, and the next open then wiped the whole store and re-embedded everything again. The meta now follows the stores' own commit granularity, and `save()` writes atomically (tmp + rename) so a crash mid-write can never truncate the file. + +### Changed + +- **find_impact position queries that resolve to no symbol now return an error with a hint.** Previously they returned an empty references list, which looked like "no callers". + +## [1.5.29] + +### Fixed + +- **Index caches are no longer wiped on every binary swap.** The chunk file-meta cache and the SCIP symbol meta were stamped with the full package version (`CARGO_PKG_VERSION_FULL`), which the bump-bot moves on every merged PR — so every rebuilt binary treated every repo's indexes as foreign and re-embedded/re-built the whole fleet at each serve restart (field incident 14–15 Oct 2026: ten patch bumps in one day). The stamp is now a hand-bumped generation marker (`2026-10.1`) that changes ONLY when chunker or SCIP conventions actually change; one final full rebuild migrates existing caches. The transient Windows FTS-commit lock race (AV/Search-Indexer holding fresh Tantivy segment files) also gets a second, longer redrive (5s then 20s, was a single 5s pass) and now covers the warmup incremental refresh as well — the two paths whose builds died in the field, leaving repos registered with 0 chunks. + +## [1.5.16] + +### Fixed + +- **The serve TUI/`/status` repo label no longer flips to `idle` while a rebuild is still queued.** Phase-2 pre-marks queued C# rebuilds in the per-language status cache, but the repo-level label waited for the `active_reindexes` marker that only appears when the task actually starts — so during a startup rebuild wave most repos read `idle` with only the C# column showing indexing. A resolved `Indexing` language status now also holds the repo label at `indexing`; it returns to idle/open when the rebuild completes. Queued pre-marks are cleared on the phase-2 skip paths (unresolvable/missing repo) so a skipped rebuild cannot show indexing forever. + +- **C# restore-pending retries capped at 3 attempts with exponential backoff, and restore exhaustion renders as a warning instead of an error.** A hung `dotnet restore` burned 20 retries × 60s before the rebuild gave up — and then flagged the index red as if broken. Now: 3 attempts with doubling waits (60s + 120s by default, base tunable via `CODESEARCH_RESTORE_RETRY_INTERVAL_SECS`), after which the rebuild stops with a typed `RestoreExhaustedError`, LMDB stays untouched and the previous index keeps serving. Exhaustion surfaces as yellow `C#⚠ partial` with the reason on every serve path (reindex trigger, FSW full and grouped incremental rebuilds); a real failure still renders red, and a later clean rebuild clears the warning back to Ready. + +## [1.5.15] + +### Fixed + +- **`index add` / `index reindex` stop instead of building locally when the serve reports the alias is already indexing.** A transport-level delegation failure can mean the first POST landed and its 202 never reached the client (field case: the follow-up call got 409 "reindex already in progress", then the CLI built locally anyway and died on the Tantivy lockfile while the serve's own pass was running). On that specific 409 the CLI now exits with "let it finish" guidance; other delegation failures keep the previous local fallback (a registered-but-idle repo indexes locally fine — the pre-push gate depends on it). `--local` remains the explicit escape hatch. + +- **Status no longer reports "ready" while a rebuild is running.** MCP `status` (project and group) answers "building" during a rebuild, and the TUI C#/TypeScript indicators show indexing instead of "ready" from an old on-disk index; the fresh-index route and pre-warm no longer set Ready mid-build. + +## [1.5.14] + +### Fixed + +- **The index database directory is now marked hidden on Windows.** The dot in `.codesearch.db` means nothing to Windows: the Search indexer crawled it like any folder, and its scanner holding a freshly created Tantivy segment file is the transient commit race behind the field incidents (os error 5). The indexer skips hidden directories (the `.git` convention), so `SharedStores` now marks the db dir hidden on creation and on every read-write open — existing directories are fixed on the next serve start, best-effort and idempotent. + +## [1.5.13] + +### Fixed + +- **Vanishing repos: failed first builds keep the registration and the transient FTS commit race gets one full-pass retry.** Two field incidents traced to the same root: an indexer (Defender/Search) holds a freshly created Tantivy segment file while the commit opens it (os error 5/32/33), and the add-repo task then silently unregistered the repo and let self-cleanup delete its DB dir — the 202 response was the operator's last word. Now: (1) a full reindex pass is redriven once after a 5s backoff when it fails on exactly that transient class (a pass is idempotent — clear + rebuild — where a commit retry on a half-joined writer is never safe); (2) a failed first build keeps the repo registered with a loud, actionable error (`codesearch index reindex ` heals in place) instead of vanishing. + +### Added + +- **Symbol-index status surfaces.** The chunk fields on `/repos/:alias/info` and the Info overlay said nothing about the SCIP index that `find_impact` uses, so an agent could not tell a working symbol index from an absent/stale/degraded one before trusting `references: []`. Every info surface now carries `symbol_index[]` — per language a `state` (`ready` / `degraded` / `stale` / `restore-pending` / `absent` / `not-applicable`), the index age and applicability — composed from the same on-disk meta the rebuild gates act on (new shared collector `symbol_index_status`, C# freshness override `index_matches_builder` mirroring the rebuild gate). `find_impact` resolved/empty answers embed the same array (applicable languages only) and the tool description tells agents to check it before concluding "no callers"; both serve TUIs render the status lines with state coloring. Remote-TUI deserialization tolerates older peers (missing field → empty section; null age → unknown). + +## [1.5.9] + +### Fixed + +- **scip-csharp: projects already loaded through a ProjectReference are no longer added twice.** The per-project fallback re-opened them, causing `already part of the workspace` failures and cross-project references missing from the index. +- **NuGet feed failures and the BuildHost `XMakeElements` crash are logged as `[INFO]`, not index warnings.** They are environment issues; an affected project is skipped in the index and the INFO line records it. +- **Serve: `q` quits while a C# rebuild waits for `dotnet restore`.** The restore wait polls the shutdown flag and the runtime gives blocking tasks a 5 s grace, instead of joining a rebuild parked for up to 20 minutes. + +## [1.5.6] + +### Fixed + +- **scip-csharp: MSBuild check advisories and BuildHost shutdown chatter no longer surface as index warnings.** Two more noise classes were observed pinning the serve TUI's ⚠ on healthy-but-advised repos: MSBuild check advisories escalated to load "failures" (live: the Grpc.Net.ClientFactory 2.63 version check — product guidance, the project loads fine and the index is unaffected) and BuildHost crash aftermath (`[BuildHost PID N] Exception while shutting down…` / `…not responding`, which trail the failure the load exception already reports and double-count it). Both demote to `[INFO]` in the WorkspaceFailed handler, extending the audit-advisory policy: the index-warning channel carries index health only. The live shapes are pinned verbatim in WorkspaceNoiseTests. + +## [1.5.5] + +### Fixed + +- **Serve TUI: symbol-index warnings are fully readable and copyable.** The Info overlay (`i`) clipped long warning lines at the modal border — the exact feed URLs that explain a degraded C# index were cut off mid-address. Modal content now wraps instead of clipping (the modal grows with the wrapped rows, capped at the terminal), and the key-hint footer moved to the border's bottom title so it stays visible even when wrapped content fills the screen. A new `c` key on the Info overlay copies the repo alias plus every stored warning line to the OS clipboard (PowerShell `Set-Clipboard` with explicit UTF-8 stdin on Windows, `pbcopy`/`wl-copy`/`xclip`/`xsel` elsewhere — no new dependency), with the outcome shown as a feedback line in the overlay. Works in both the embedded serve TUI and the standalone remote TUI. + +## [1.5.4] + +### Fixed + +- **C# indexes are never built while a NuGet restore is still running, and restore freshness now honours central package management.** Under CPM a version bump in `Directory.Packages.props` left `obj/project.assets.json` looking fresh, Roslyn missed the package assemblies, and the degraded index stored CS0246 cascades (seen live on `Azure.Response` unresolved). `NeedsRestore` now treats assets as stale when any `Directory.Packages.props`, `Directory.Build.props`, `Directory.Build.targets`, `NuGet.config` or `global.json` found walking up from the project to the repo root is newer than the assets. When the bounded restore wait expires, the helper no longer loads the workspace degraded: it records the still-running restore in an out-of-repo marker, prints one `[RESTORE-PENDING]` line, writes no output, and exits 75 — and the Rust host maps that to a distinct outcome that retries the same rebuild scope with a bounded backoff (interval tunable via `CODESEARCH_RESTORE_RETRY_INTERVAL_SECS`), leaving the previous good index live and LMDB untouched. `find_impact` answers from the previous index with one explicit "restore in progress" warning; lazy find-refs during a pending restore persists an INCOMPLETE warning and caches nothing; the serve file watcher now triggers a full C# rebuild when a restore input changes, and a resident workspace refuses to come up mid-restore so no answer from a workspace loaded during a restore can be cached. A restore that itself fails (non-zero exit) is not pending: the previous degraded-with-warning behaviour stays. + +## [1.5.3] + +### Fixed + +- **Blazor/Razor projects no longer produce false "Compilation errors" index warnings.** The workspace load never ran source generators, so Razor components' generated partial halves were missing and every code-behind use of an `@code` member collapsed into CS0103/CS0115 cascades while `dotnet build` stayed clean. `scip-csharp` now drives the project's source generators itself (with a tolerant loader for analyzers built against a newer Roslyn than the pinned one) and indexes the generated output compilation; a failed generator pipeline falls back to the plain compilation and downgrades the resulting diagnostics to INFO notes instead of warnings. The index-warning lead entry no longer asserts a user-fixable build problem — it distinguishes real breaks from tool-side gaps — and error specimens are truncated at word boundaries instead of mid-identifier. + +## [1.5.2] - 2026-10-05 + +### Fixed + +- **Restore runs only when package assets are missing or stale, and warning-severity workspace diagnostics no longer count as index warnings.** Restoring on every reindex was far too heavy for multi-repo hubs and big solutions legitimately exceed any fixed timeout (`dotnet restore did not finish within 300s` was observed live). Now the helper checks each project's `obj/project.assets.json` against its .csproj and restores only when evidence demands it (the steady state of an actively developed repo is a no-op), the kill timeout is tunable via `CODESEARCH_RESTORE_TIMEOUT_SECS`, and restore uses `--ignore-failed-sources` so an unreachable private feed cannot block indexing. Separately, warning-severity workspace diagnostics (e.g. "Found project reference without a matching metadata reference" for excluded or external projects) are benign resolution notes — they log at INFO and no longer pin the repo's index warning; only true load failures (minus NuGet audit advisories) still do. +- **C# symbol indexing restores packages before the workspace load, and NuGet audit advisories no longer count as index warnings.** The design-time load does not restore: with stale or missing `project.assets.json`, package-typed references collapsed into CS0246 cascades that flagged whole solution families as degraded (⚠ in the serve TUI) even though `dotnet build` succeeds. The helper now runs `dotnet restore` before opening the solution (bounded, best effort — a failed restore logs and continues, degraded indexing beats no indexing), and when the bounded wait expires the restore is **not killed**: it keeps running in the background, this load proceeds degraded, and the next reindex picks up the fresh assets — a killed restore would waste all of its work and re-pay the same wait on every subsequent reindex. NuGet vulnerability advisories surfacing as Msbuild "failures" are filtered from the warning channel: they are security notes for the product, not index-health signals. Compiler *warnings* were already never counted; genuine project compilation errors still are, and indexing stays as complete as the broken projects allow. + +### Changed + +- **Dependency refresh:** libc 0.2.190, rmcp 3.5.0, uuid 1.27.0 (#305). + +## [1.5.1] - 2026-10-04 + +### Added + +- **`codesearch setup` — download embedding models, and a relocatable global root via `CODESEARCH_HOME`.** The stubbed setup command now resolves `--model` through the shared model parser (unknown names error with the valid list), downloads into the global models cache with a visible progress bar (runtime paths stay silent), and probe-embeds one query so a broken download fails in setup instead of mid-indexing. `CODESEARCH_HOME` relocates the entire global root (repos.json, models cache, logs, serve_url, global ignore/extensions) and is honoured by the hub, db-discovery, every Claude Code guard hook and the OpenCode plugin, with tests pinning each layer. *(Contributed by @belovaf in #298 — in the same PR: find-impact warnings that no longer promise rebuilds nothing will run, group-fan-out hits attributed to their repo, and dependency-lockfile indexing exclusions.)* + +*A big thank-you to belovaf ([@belovaf](https://github.com/belovaf)) for his first contribution to this release — a careful, well-tested feature plus four quality fixes landed in one go.* + +### Fixed + +- **Queued reindexes are no longer cancelled as "leaked", and an unjoinable index task can no longer wedge a hub.** With the process-wide job gate (`CODESEARCH_INDEX_JOBS=1`, the default), tasks queued behind a long-running job held their `active_reindexes` markers past `MAX_INDEXING_SECS` without renewing them, so the lazy stale-marker check evicted the markers and cancelled the parked tasks — leaving empty stores and in-process LMDB handles that made later writes fail with "Database is locked by another process" until a serve restart. Separately, `await_index_task` removed the task entry *before* waiting and dropped the `JoinHandle` on timeout, so a task too deep in the uninterruptible `build_index` to cancel kept its `Arc` and the single job permit invisibly; the job-gate wait ignored cancellation, parking cancelled tasks on the gate; and `remove_repo` / format recovery could delete the DB directory out from under a still-running task. Now: a marker backed by a live tracked `Reindex` task is renewed (with a throttled wedge warning) instead of reaped; gate acquisition is cancellation-aware (`JobAcquire`) so cancelled or removed queued jobs abort and release their stores; a task that cannot be joined stays tracked and is reaped by a periodic sweeper that also deletes orphaned DB directories and re-asserts cancellation for removed repos; DB deletion is deferred while the task runs; format recovery refuses to wipe in that state; and stale markers from other owners are still evicted. + +## [1.5.0] - 2026-10-03 + +### Added + +- **Settable indexing/refresh limits: `CODESEARCH_INDEX_JOBS`, `CODESEARCH_EMBED_THREADS`, `CODESEARCH_EMBED_PAUSE_MS`, `CODESEARCH_MIN_FREE_MB`, `CODESEARCH_MAX_CHUNKS_PER_BATCH` (serve flags `--index-jobs`, `--embed-threads`, `--embed-pause-ms`, `--min-free-mb`).** A multi-repo hub used to start one full refresh/reindex/HNSW-build pass per repo the moment that repo had work, so a mass `git pull`, a burst of first queries or several HTTP reindexes ran many CPU-heavy passes at once, held many file/chunk windows in memory, and queued the (already serialised) ONNX inference behind all of them. A process-wide job gate now bounds concurrent heavy repo jobs (default **1**; queries never take it), the ONNX session's intra-op thread count can be capped (`CODESEARCH_EMBED_THREADS`, previously always all cores), background embedding releases the model lock once per mini-batch with an optional duty-cycle pause so interactive query embeddings are not stuck behind a whole batch, the read/chunk window can be capped by chunks as well as files, and a job can wait for a free-memory floor before starting. See the README section "Indexing limits" for recommended values. +- **OpenCode plugin integration (`integrations/opencode/`).** codesearch's MCP `initialize` instructions are advisory and connection-scoped: they cannot resolve the session directory to a registered project, see a `grep` return nothing, recover a dead serve hub, notice an unregistered worktree, or keep file outlines alive across compaction. The new self-contained OpenCode v2 plugin (no runtime dependencies, fail-open throughout) adds host-side behaviour around the same MCP server: it resolves the working directory to a project alias and injects scope-aware guidance once per session, turns a zero-hit `grep`/`glob` into index hits, offers `nudge`/`prune`/`block` codesearch-first guards that deny only while the hub is confirmed reachable and the repo is registered, probes `/healthz` and asks OpenCode to reload failed MCP servers (with optional local `codesearch serve` auto-start), warns when a registered index is empty or model-less, notes just-edited files while the watcher catches up, captures `explore` outlines into the compaction prompt, and registers `/codesearch`, `/codesearch-status` and `/codesearch-index` commands, a `codesearch_scope` tool and a `codesearch` skill. Includes a config reference, install/usage docs and a mock-host smoke test. + +*A big thank-you to Don Bowman ([@donbowman](https://github.com/donbowman)) for his outstanding, highly value-adding contributions to this release — the indexing-limits rework (#294) and the OpenCode plugin integration (#295), follow-up fixes included.* +- **Always-on symbol indexes (C# + TypeScript).** Symbol (SCIP) indexes are no longer a manual or incidental artifact: serve warmup, cold opens, file-watcher batches and reindexes each drive a per-language symbol pass wherever chunk indexes are built, so `find_impact` evidence exists without a separate rebuild step. Startup inspects the on-disk symbol indexes with a builder-version stamp and rebuilds those an older binary produced (degraded retry instead of a hard failure), so a upgraded serve never answers from stale symbol data. + +### Changed + +- **`codesearch serve` runs heavy repo jobs one at a time by default (`CODESEARCH_INDEX_JOBS=1`).** Warmup, cold opens, file-watcher batches and reindexes now queue behind a running refresh instead of all running at once; raise the value deliberately on machines with cores and memory to spare. Standalone `codesearch index` / `codesearch mcp` runs are unchanged (no gate is attached). `CODESEARCH_EMBED_THREADS` unset keeps the previous ONNX default (all cores), so single-repo index throughput is unchanged unless the variable is set. +- **`find_impact` is honest about partial evidence; the TUI says how healthy the symbol indexes are.** Index-level rebuild warnings (non-compiling C# projects, swallowed resolution failures, non-zero `scip-typescript` exits) ride the `find_impact` answer as an additive `warnings` array instead of vanishing into the log. The scip-csharp helper's workspace-load diagnostics are aggregated into a single warnings line and never escalate to errors during workspace load. The serve TUI's symbol-index indicators use severity language: a degraded C# index renders red (`C#⚠`) and the info line names the failures. +- **Cloud image: build locally, not via `az acr build`.** The Dockerfile's builder stage compiles the release binary and warms up the embedding model before tarring — memory/disk-heavy, and ACR Basic/Standard build agents reliably fail the model-tar layer after a ~25 min compile (confirmed twice). `integrations/cloud/README.md` now documents building with local Docker Desktop and `docker push` instead. + +### Fixed + +- **SCIP key-format 2.0 regression: simple-name extraction now strips parameters before segmenting.** Fully qualified symbol keys that carry parameter types (real C# methods do) segmented on the parameter list instead of the path segments, producing wrong simple names for the affected symbols. + ## [1.4.11] ### Changed @@ -334,6 +465,12 @@ finalized in place with a date — no renaming/migration step needed. ## [1.0.72] - 2026-05-01 - Initial multi-repo release: multi-repo `serve` (HTTP/SSE, per-project/group routing, RRF cross-repo search), stdio MCP proxy with client-side auto-reconnect, tree-sitter chunking (9 langs), persistent SHA-256 embedding cache, repository groups, re-tuned RRF, and LMDB resize crash fix (#30, `MDB_MAP_FULL`). +[1.5.2]: https://github.com/flupkede/codesearch/compare/v1.5.1...v1.5.2 + +[1.5.1]: https://github.com/flupkede/codesearch/compare/v1.5.0...v1.5.1 + +[1.5.0]: https://github.com/flupkede/codesearch/compare/v1.4.9...v1.5.0 + [1.4.9]: https://github.com/flupkede/codesearch/compare/v1.4.4...v1.4.9 [1.0.171]: https://github.com/flupkede/codesearch/compare/v1.0.162...v1.0.171 [1.0.162]: https://github.com/flupkede/codesearch/compare/v1.0.160...v1.0.162 diff --git a/Cargo.lock b/Cargo.lock index 9c85609b..fba6be7c 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -181,11 +181,11 @@ dependencies = [ "nohash", "ordered-float 5.5.0", "page_size", - "rand 0.10.2", + "rand 0.10.3", "rayon", "roaring", "tempfile", - "thiserror 2.0.20", + "thiserror 2.0.21", "tracing", ] @@ -245,7 +245,7 @@ dependencies = [ "num-traits", "pastey 0.1.1", "rayon", - "thiserror 2.0.20", + "thiserror 2.0.21", "v_frame", "y4m", ] @@ -713,7 +713,7 @@ dependencies = [ [[package]] name = "codesearch" -version = "1.4.11" +version = "1.5.32" dependencies = [ "anyhow", "arroy", @@ -743,7 +743,7 @@ dependencies = [ "ort", "pretty_assertions", "protobuf", - "rand 0.10.2", + "rand 0.10.3", "ratatui", "rayon", "regex", @@ -758,7 +758,7 @@ dependencies = [ "sysinfo 0.39.6", "tantivy", "tempfile", - "thiserror 2.0.20", + "thiserror 2.0.21", "tokio", "tokio-util", "tracing", @@ -1600,9 +1600,9 @@ checksum = "9afc2bd4d5a73106dd53d10d73d3401c2f32730ba2c0b93ddb888a8983680471" [[package]] name = "fastembed" -version = "7.0.1" +version = "7.1.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5c88b42d8347afbf09e3d2fac61fcc22b698b7b2f35a27a6e988bcdad5784b07" +checksum = "ca64ada7d0ad74737f45609542930cd5813fcb453b3f72ecb4255d8bd6fe4604" dependencies = [ "hf-hub 0.5.0", "image", @@ -1611,7 +1611,7 @@ dependencies = [ "safetensors", "serde", "serde_json", - "thiserror 2.0.20", + "thiserror 2.0.21", "tokenizers", ] @@ -2080,7 +2080,7 @@ dependencies = [ "reqwest 0.12.28", "serde", "serde_json", - "thiserror 2.0.20", + "thiserror 2.0.21", "ureq", "windows-sys 0.61.2", ] @@ -2105,7 +2105,7 @@ dependencies = [ "serde", "serde_json", "sha2 0.11.0", - "thiserror 2.0.20", + "thiserror 2.0.21", "tokio", "tokio-retry", "tokio-util", @@ -2127,7 +2127,7 @@ dependencies = [ "more-asserts", "serde", "serde_json", - "thiserror 2.0.20", + "thiserror 2.0.21", "tokio", "tokio-util", "tokio_with_wasm", @@ -2638,7 +2638,7 @@ dependencies = [ "jni-sys", "log", "simd_cesu8", - "thiserror 2.0.20", + "thiserror 2.0.21", "walkdir", "windows-link", ] @@ -2704,7 +2704,7 @@ checksum = "bde5057d6143cc94e861d90f591b9303d6716c6b9602309150bd068853c10899" dependencies = [ "hashbrown 0.16.1", "portable-atomic", - "thiserror 2.0.20", + "thiserror 2.0.21", ] [[package]] @@ -2770,9 +2770,9 @@ checksum = "0c2cdeb66e45e9f36bfad5bbdb4d2384e70936afbee843c6f6543f0c551ebb25" [[package]] name = "libc" -version = "0.2.189" +version = "0.2.190" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3eaf3ede3fee6db1a4c2ee091bf8a8b4dccdc6d17f656fb07896ee72867612f2" +checksum = "ce5d3ddc6d3fa000eb1536d85e147bfe31aacaba692ed6a876f95cb7c855be78" [[package]] name = "libfuzzer-sys" @@ -4064,7 +4064,7 @@ dependencies = [ "rustc-hash", "rustls", "socket2", - "thiserror 2.0.20", + "thiserror 2.0.21", "tokio", "tracing", "web-time", @@ -4072,22 +4072,22 @@ dependencies = [ [[package]] name = "quinn-proto" -version = "0.11.18" +version = "0.11.19" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a9746dbde176634f4f2f1faf2404e30a31b2bc1e9cafb5329c95d8177a18c9fc" +checksum = "0e750cca55fe4f0439a15d0bb529da9651e79993e8e72c61a899a36d462befbe" dependencies = [ "aws-lc-rs", "bytes", "getrandom 0.4.3", "lru-slab", - "rand 0.10.2", + "rand 0.10.3", "rand_pcg", "ring", "rustc-hash", "rustls", "rustls-pki-types", "slab", - "thiserror 2.0.20", + "thiserror 2.0.21", "tinyvec", "tracing", "web-time", @@ -4149,9 +4149,9 @@ dependencies = [ [[package]] name = "rand" -version = "0.10.2" +version = "0.10.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c7f5fa3a058cd35567ef9bfa5e75732bee0f9e4c55fa90477bef2dfcdbc4be80" +checksum = "65c9fb96cbc91e3478eaae79a69fcd3f1ae4ad052e471fe6732fff548984b4af" dependencies = [ "chacha20", "getrandom 0.4.3", @@ -4230,7 +4230,7 @@ dependencies = [ "palette", "serde", "strum", - "thiserror 2.0.20", + "thiserror 2.0.21", "unicode-segmentation", "unicode-truncate", "unicode-width", @@ -4329,7 +4329,7 @@ dependencies = [ "rand 0.9.5", "rand_chacha", "simd_helpers", - "thiserror 2.0.20", + "thiserror 2.0.21", "v_frame", "wasm-bindgen", ] @@ -4427,7 +4427,7 @@ checksum = "a4e608c6638b9c18977b00b475ac1f28d14e84b27d8d42f70e0bf1e3dec127ac" dependencies = [ "getrandom 0.2.17", "libredox", - "thiserror 2.0.20", + "thiserror 2.0.21", ] [[package]] @@ -4577,7 +4577,7 @@ dependencies = [ "async-trait", "http", "reqwest 0.13.5", - "thiserror 2.0.20", + "thiserror 2.0.21", "tower-service", ] @@ -4603,9 +4603,7 @@ dependencies = [ [[package]] name = "rmcp" -version = "3.4.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b23c62fe489ac1d401ab32688cfacac3737a8978dc3343e5361464c7724fd3cb" +version = "3.5.0" dependencies = [ "async-trait", "base64 0.23.1", @@ -4618,14 +4616,14 @@ dependencies = [ "indexmap", "pastey 0.2.3", "pin-project-lite", - "rand 0.10.2", + "rand 0.10.3", "reqwest 0.13.5", "rmcp-macros", "schemars", "serde", "serde_json", "sse-stream", - "thiserror 2.0.20", + "thiserror 2.0.21", "tokio", "tokio-stream", "tokio-util", @@ -4636,9 +4634,9 @@ dependencies = [ [[package]] name = "rmcp-macros" -version = "3.4.0" +version = "3.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cd740c45d66ceb87e5579082abc27bd771665e464e9660a17a048c721b2a6025" +checksum = "c7e66877136e969d5a2d561ee5841b17717a0619aebd64abb47a2a2f46e34683" dependencies = [ "darling 0.24.1", "proc-macro2", @@ -4934,10 +4932,11 @@ dependencies = [ [[package]] name = "serde_json" -version = "1.0.151" +version = "1.0.154" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c841b55ecdae098c80dcae9cf767f6f8a0c2cdb3416bbef72181df4d0fe73f14" +checksum = "e7e9cc8b1b85264074fbcc02a88680c4096b1e47df8f739dceb03bf482f04bd6" dependencies = [ + "foldhash", "indexmap", "itoa", "memchr", @@ -5419,7 +5418,7 @@ dependencies = [ "tantivy-stacker", "tantivy-tokenizer-api", "tempfile", - "thiserror 2.0.20", + "thiserror 2.0.21", "time", "typetag", "uuid", @@ -5528,7 +5527,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "32497e9a4c7b38532efcdebeef879707aa9f794296a4f0244f6f69e9bc8574bd" dependencies = [ "fastrand", - "getrandom 0.4.3", + "getrandom 0.3.4", "once_cell", "rustix", "windows-sys 0.61.2", @@ -5621,11 +5620,11 @@ dependencies = [ [[package]] name = "thiserror" -version = "2.0.20" +version = "2.0.21" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ec86235f5fcc2a73650310756d2ac5b138a5780bbbdfae3eeccec992c435ba4f" +checksum = "09e52cb86a36cede5cb101bf8908837b3e4c6e5e59fe7fd85c23fb56200d189e" dependencies = [ - "thiserror-impl 2.0.20", + "thiserror-impl 2.0.21", ] [[package]] @@ -5641,9 +5640,9 @@ dependencies = [ [[package]] name = "thiserror-impl" -version = "2.0.20" +version = "2.0.21" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "bc04cd3e1236dd4a98afca4569f2deb3f120e5422a4023be2cb683f8486292af" +checksum = "fe5197923287db20a58125f0bc85c062f7f2c892de97b18c356f9efb14b28524" dependencies = [ "proc-macro2", "quote", @@ -5758,7 +5757,7 @@ dependencies = [ "serde", "serde_json", "spm_precompiled", - "thiserror 2.0.20", + "thiserror 2.0.21", "unicode-normalization-alignments", "unicode-segmentation", "unicode_categories", @@ -5766,9 +5765,9 @@ dependencies = [ [[package]] name = "tokio" -version = "1.53.1" +version = "1.53.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "202caea871b69668250d242070849eb495be178ed697a3e98aebce5bc81a0bed" +checksum = "e95f91fcc7a621e8b030f6aa23c71fe9838ae2fb4d8118b75602a328f5144044" dependencies = [ "bytes", "libc", @@ -5809,7 +5808,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "4a129d95275ebf4c493ec53bf0f8cd95f5ac161bc4f381700809a54f595d4470" dependencies = [ "pin-project-lite", - "rand 0.10.2", + "rand 0.10.3", "tokio", ] @@ -5836,9 +5835,9 @@ dependencies = [ [[package]] name = "tokio-util" -version = "0.7.19" +version = "0.7.20" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "494815d09bf52b5548659851081238f0ca39ff638363907596da739561c62c52" +checksum = "e464cf451ba96ebfc6f9b6542f17ee8b8956e33f1e40d9690624e59d7a7f8a4b" dependencies = [ "bytes", "futures-core", @@ -5939,7 +5938,7 @@ checksum = "050686193eb999b4bb3bc2acfa891a13da00f79734704c4b8b4ef1a10b368a3c" dependencies = [ "crossbeam-channel", "symlink", - "thiserror 2.0.20", + "thiserror 2.0.21", "time", "tracing-subscriber", ] @@ -6009,9 +6008,9 @@ dependencies = [ [[package]] name = "tree-sitter" -version = "0.27.0" +version = "0.27.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2038684e0058edba0d17302619f62eabce4a8e11c6ac59506996a8d79848851d" +checksum = "a5129de2ccc97808c4583d48f1fb44576d015cf241e432800572bda11ef30c3b" dependencies = [ "cc", "regex", @@ -6112,9 +6111,9 @@ dependencies = [ [[package]] name = "tree-sitter-language" -version = "0.1.8" +version = "0.1.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ca0d1bf6fdd806e43ae5198f82f527056d359def39e54e67a0f478ac09dac081" +checksum = "d0af592be68c579aa78a16846bd19422978c3c52e438523d45ff5d1bff1f9d4a" [[package]] name = "tree-sitter-md" @@ -6128,9 +6127,9 @@ dependencies = [ [[package]] name = "tree-sitter-php" -version = "0.24.2" +version = "0.25.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0d8c17c3ab69052c5eeaa7ff5cd972dd1bc25d1b97ee779fec391ad3b5df5592" +checksum = "d9779e392d38af4254f48be0e57b7eed4d50ec7a6e55a7e5e2e74df8f8f032d3" dependencies = [ "cc", "tree-sitter-language", @@ -6398,9 +6397,9 @@ checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821" [[package]] name = "uuid" -version = "1.26.1" +version = "1.28.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2ef6dac1e96601b4fb3acccccff2139741fcb757cb9a36089bf5be91cfb285ce" +checksum = "7cc1186384beb7dd8eedea376413fd654937285ea6c9cfbb928dc3043ea4b606" dependencies = [ "atomic", "getrandom 0.4.3", @@ -7053,7 +7052,7 @@ dependencies = [ "http", "hyper", "more-asserts", - "rand 0.10.2", + "rand 0.10.3", "redb", "reqwest 0.13.5", "reqwest-middleware", @@ -7062,7 +7061,7 @@ dependencies = [ "serde_repr", "statrs", "tempfile", - "thiserror 2.0.20", + "thiserror 2.0.21", "tokio", "tokio-retry", "tokio_with_wasm", @@ -7093,12 +7092,12 @@ dependencies = [ "itertools 0.14.0", "lz4_flex", "more-asserts", - "rand 0.10.2", + "rand 0.10.3", "regex", "safe-transmute", "serde", "static_assertions", - "thiserror 2.0.20", + "thiserror 2.0.21", "tokio", "tokio-util", "tracing", @@ -7121,12 +7120,12 @@ dependencies = [ "http", "itertools 0.14.0", "more-asserts", - "rand 0.10.2", + "rand 0.10.3", "serde", "serde_json", "sha2 0.11.0", "tempfile", - "thiserror 2.0.20", + "thiserror 2.0.21", "tokio", "tokio-util", "tokio_with_wasm", @@ -7161,13 +7160,13 @@ dependencies = [ "more-asserts", "oneshot", "pin-project", - "rand 0.10.2", + "rand 0.10.3", "reqwest 0.13.5", "serde", "serde_json", "shellexpand", "sysinfo 0.38.4", - "thiserror 2.0.20", + "thiserror 2.0.21", "tokio", "tokio-util", "tokio_with_wasm", diff --git a/Cargo.toml b/Cargo.toml index a7a732b9..3c03722d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "codesearch" -version = "1.4.11" +version = "1.5.32" edition = "2021" authors = ["codesearch contributors"] license = "Apache-2.0" @@ -49,7 +49,7 @@ tree-sitter-go = "0.25" tree-sitter-java = "0.23.5" tree-sitter-bash = "0.25.1" tree-sitter-ruby = "0.23.1" -tree-sitter-php = "0.24.2" +tree-sitter-php = "0.25.1" tree-sitter-yaml = "0.7.2" tree-sitter-json = "0.24.8" tree-sitter-md = "0.5.3" @@ -115,6 +115,15 @@ schemars = { version = "1.1.0", features = ["derive"] } reqwest = { version = "0.13", default-features = false, features = ["json", "rustls"] } sysinfo = { version = "0.39", default-features = true } +[patch.crates-io] +# Vendored copy of rmcp 3.5.0 with the [codesearch bridge] change in +# vendor/rmcp/src/service/server.rs (`negotiate_protocol_version`): it lets a +# session run at 2026-07-28 when the client offers that revision over the +# initialize handshake, so rmcp keeps the SEP-2322 `resultType` discriminator +# that Claude Code >= 2.1.296 requires. Re-apply the marked change when +# bumping rmcp. +rmcp = { path = "vendor/rmcp" } + [target.'cfg(unix)'.dependencies] libc = "0.2" diff --git a/README.md b/README.md index a09b30db..2398b4a1 100644 --- a/README.md +++ b/README.md @@ -233,7 +233,7 @@ If your agent skips codesearch and falls back to grep/glob too often, paste this > Prefer codesearch for semantic, cross-file, or symbol-oriented lookup ("where is X implemented", "find usages of Y", "how does Z flow"). Use plain grep/glob for a single known file, trivial one-line edits, or exact literal searches. In remote-serve mode, returned paths are from the **server's** filesystem — read content via `get_chunk` rather than opening paths locally, and unindexed dirs (`.venv`, `node_modules`, `build/`) simply return nothing. -OpenCode: put this in the user-level `~/.config/opencode/AGENTS.md` (applies across all projects). Claude Code reads a project-level `AGENTS.md`, so add it per-project (or symlink a shared one). +OpenCode: put this in the user-level `~/.config/opencode/AGENTS.md` (applies across all projects), or install the [OpenCode plugin](integrations/opencode/README.md), which injects this guidance with the resolved project scope automatically. Claude Code reads a project-level `AGENTS.md`, so add it per-project (or symlink a shared one). **Claude Code specifically** tends to ignore this advice more than other clients — its MCP tool schemas are deferred (an extra `ToolSearch` call is needed before codesearch tools are even callable), while Grep/Glob are always fully loaded and zero-friction, and spawned subagents don't inherit `AGENTS.md` or the MCP `initialize` instructions at all. @@ -253,7 +253,9 @@ codesearch hooks claude install --project # project scope (./.claude) The native command embeds the hook scripts in the binary (no source tree needed) and merges the registrations into `settings.json`. The equivalent from-source installers still live in [`integrations/claude-code/`](integrations/claude-code/) (`install.ps1` / `install.sh`) if you'd rather run them directly. -Note: the grep-guard detects "codesearch is available **for this repo**" via that repo's registration with the serve hub (`~/.codesearch/repos.json`, honoring the `CODESEARCH_REPOS_CONFIG` override) or `CODESEARCH_SERVER` — **not** by checking whether a `codesearch` process is running (that runs almost constantly as a multi-repo hub and would false-fire in every directory), and **not** via a local `.codesearch.db` directory (a stale db from a since-unregistered repo used to deny Grep even though the hub could not answer for it). For a remote-serve setup with no local registration, set `CODESEARCH_SERVER` to opt back into enforcement. +**OpenCode** gets the same structural treatment through the OpenCode v2 plugin in [`integrations/opencode/`](integrations/opencode/README.md): it resolves the session directory to an indexed project, injects scope-aware guidance once per session, rescues empty greps with index hits, optionally prunes or blocks `grep`/`glob`, keeps the serve hub healthy (with optional auto-start), and adds `/codesearch*` commands, a `codesearch_scope` tool, a skill and compaction assistance. Install by copying `codesearch.ts` into `~/.config/opencode/plugins/` — see the [integration README](integrations/opencode/README.md). + +Note: the grep-guard detects "codesearch is available **for this repo**" via that repo's registration with the serve hub (`~/.codesearch/repos.json`, honoring the `CODESEARCH_REPOS_CONFIG` / `CODESEARCH_HOME` overrides) or `CODESEARCH_SERVER` — **not** by checking whether a `codesearch` process is running (that runs almost constantly as a multi-repo hub and would false-fire in every directory), and **not** via a local `.codesearch.db` directory (a stale db from a since-unregistered repo used to deny Grep even though the hub could not answer for it). For a remote-serve setup with no local registration, set `CODESEARCH_SERVER` to opt back into enforcement. ## MCP Tools Reference @@ -444,12 +446,12 @@ When using `git worktree add` to create parallel working directories, codesearch codesearch hooks git install ``` -This installs a `post-checkout` hook that POSTs the worktree path to the running serve instance whenever a new worktree is checked out. The hook reads the serve URL from `~/.codesearch/serve_url` (automatically managed by `codesearch serve`). +This installs a `post-checkout` hook that POSTs the worktree path to the running serve instance whenever a new worktree is checked out. The hook reads the serve URL from `~/.codesearch/serve_url` (`$CODESEARCH_HOME/serve_url` when the global root is relocated; automatically managed by `codesearch serve`). The install target is resolved with `git rev-parse --git-path hooks`, so it honours `core.hooksPath` (and, inside a linked worktree, the shared common-dir hooks) rather than assuming `.git/hooks/`. An existing `post-checkout` is not overwritten — codesearch's logic is chained in as a marker-delimited block. **How it works:** -1. `codesearch serve` writes its URL to `~/.codesearch/serve_url` on startup (deletes on shutdown) +1. `codesearch serve` writes its URL to `~/.codesearch/serve_url` (`$CODESEARCH_HOME/serve_url` when relocated) on startup (deletes on shutdown) 2. The `post-checkout` hook reads that file and POSTs the working directory to `POST /repos` 3. Serve registers the worktree path and begins indexing (deduped — won't re-register existing paths) @@ -573,15 +575,63 @@ In the `codesearch serve` TUI, mounts appear in **italic/cyan**, distinguishing | `CODESEARCH_ALLOWED_HOSTS` | Comma-separated hostname allowlist for the MCP streamable-HTTP transport (unset = loopback only: `localhost`, `127.0.0.1`, `::1`). Set this to your container/service hostname when serve runs behind a container network or reverse proxy — see [Security](#security). | | `CODESEARCH_DISABLE_HOST_VALIDATION` | `1`/`true` disables the MCP transport's Host-header allowlist entirely (DNS-rebinding protection off). Only safe behind a reverse proxy/firewall that already restricts inbound Host headers — see [Security](#security). | | `CODESEARCH_MCP_MODE` | MCP mode: auto, client, local | +| `CODESEARCH_HOME` | Relocate the entire global root (`repos.json`, models cache, logs, `serve_url`, global ignore/extension files) away from `~/.codesearch`. Must be an absolute path; unset = `~/.codesearch`. Per-file overrides like `CODESEARCH_REPOS_CONFIG` still win | | `CODESEARCH_REPOS_CONFIG` | Path to repos.json | | `CODESEARCH_REPO_IDLE_TIMEOUT_SECS` | Idle eviction timeout (default: 1800) | | `CODESEARCH_CACHE_MAX_MEMORY` | Embedding cache MB (default: 500) | | `CODESEARCH_MAX_LMDB_MAP_SIZE_MB` | Hard cap (MB) for LMDB auto-resize on `MDB_MAP_FULL`, applied to both the vector store and the persistent embedding cache (default: 16384 = 16GB; clamped to at least 1024). Raise this for very large corpora (millions of chunks) that legitimately exceed the default cap — see #189. | | `CODESEARCH_BATCH_SIZE` | Embedding batch size | +| `CODESEARCH_INCREMENTAL_BATCH_SIZE` | Files read/chunked per incremental-refresh batch (default: 200) | +| `CODESEARCH_INDEX_JOBS` | Max concurrent heavy repo jobs — refresh / reindex / HNSW build — in one serve process (default: 1; queries are never gated). See [Indexing limits](#indexing-limits) | +| `CODESEARCH_EMBED_THREADS` | ONNX intra-op threads per embedding session (unset = ONNX default, all cores) | +| `CODESEARCH_EMBED_PAUSE_MS` | Pause (ms) between background embedding mini-batches, a duty cycle for shared machines (default: 0) | +| `CODESEARCH_MIN_FREE_MB` | Free-memory floor (MB) a heavy job waits for (max 30 s, then proceeds with a warning) before starting (default: 0 = disabled) | +| `CODESEARCH_MAX_CHUNKS_PER_BATCH` | Hard cap on chunks held in memory per refresh batch; splits the batch early (default: 0 = disabled) | | `CODESEARCH_SCIP_CSHARP` | Override path to `scip-csharp` helper | | `CODESEARCH_EXTENSION_MAP` | Path to the extension→language map (default: `~/.codesearch/extensions.json`) — see [Extension map](#extension-map) | | `RUST_LOG` | Log level (e.g. `codesearch=debug`) | +### Indexing limits + +A serve hub with many repos used to start one full refresh/reindex/HNSW-build +pass per repo as soon as that repo had work. A mass `git pull`, a burst of +first queries, or several `POST /repos/:alias/reindex` calls therefore ran +many CPU-heavy passes at once, held many file/chunk windows in memory, and +queued the (already serialised) ONNX inference behind all of them. These knobs +bound that work; they are read at startup, so a shell or systemd unit can set +them without editing anything: + +| Knob | Default | Effect | +|------|---------|--------| +| `CODESEARCH_INDEX_JOBS` | `1` | Max repos doing a refresh / reindex / HNSW build at once. Queries never take this slot. | +| `CODESEARCH_EMBED_THREADS` | unset (all cores) | ONNX intra-op threads per embedding session. | +| `CODESEARCH_INCREMENTAL_BATCH_SIZE` | `200` | Files read/chunked per refresh batch. | +| `CODESEARCH_MAX_CHUNKS_PER_BATCH` | `0` (off) | Split a batch early once it reaches this many chunks (a few huge files can produce more memory than many small ones). | +| `CODESEARCH_EMBED_PAUSE_MS` | `0` | Sleep this long between background embedding mini-batches (duty cycle). | +| `CODESEARCH_MIN_FREE_MB` | `0` (off) | A job waits (bounded to 30 s, then proceeds with a warning) until this much memory is free. | + +`codesearch serve` also accepts `--index-jobs`, `--embed-threads`, +`--embed-pause-ms` and `--min-free-mb`, which set the corresponding variable +for that process (flags win over the environment). Standalone `codesearch +index` and `codesearch mcp` runs have no job gate and keep their previous +behaviour; the embedding and batching variables still apply to them. + +Example for a large shared machine (128 cores, ~30 repos, dozens of repos +indexed at once are the failure mode): + +```ini +# ~/.config/systemd/user/codesearch.service.d/limits.conf +[Service] +Environment=CODESEARCH_INDEX_JOBS=1 +Environment=CODESEARCH_EMBED_THREADS=8 +Environment=CODESEARCH_INCREMENTAL_BATCH_SIZE=100 +Environment=CODESEARCH_MAX_CHUNKS_PER_BATCH=5000 +Environment=CODESEARCH_EMBED_PAUSE_MS=25 +Environment=CODESEARCH_MIN_FREE_MB=4096 +# C# SCIP helpers are bounded separately; lower it for the same reason. +Environment=CSHARP_SCIP_CONCURRENCY=1 +``` + ### `.codesearchignore` Place in repo root. Gitignore syntax. Excludes paths from indexing: diff --git a/build.ps1 b/build.ps1 index 50acac0c..3e1fb376 100644 --- a/build.ps1 +++ b/build.ps1 @@ -4,7 +4,7 @@ Builds CodeSearch. .DESCRIPTION - Always runs `cargo build` (debug or release). Cargo's own incremental + Always runs `cargo build` (debug). Cargo's own incremental compilation decides what actually needs to be recompiled — this script no longer tries to second-guess it with git-diff heuristics. @@ -18,11 +18,7 @@ .EXAMPLE .\build.ps1 - Builds in debug mode - -.EXAMPLE - .\build.ps1 -Release - Builds in release mode + Builds in debug mode (the only supported mode) #> param( @@ -31,6 +27,10 @@ param( $ErrorActionPreference = "Stop" +if ($Release) { + throw "-Release is not supported (debug-only policy, issue #192). Release artifacts are built by CI (.github/workflows/release.yml)." +} + # Change to script directory (where Cargo.toml is located) $ScriptDir = $PSScriptRoot Set-Location $ScriptDir @@ -67,8 +67,8 @@ if ($orphans.Count -gt 0) { Write-Host " [warn] if this build hangs on 'Blocking waiting for file lock', terminate the stale process manually." -ForegroundColor Yellow } -# Determine build mode -$BuildMode = if ($Release) { "release" } else { "debug" } +# Debug only (see -Release guard above) +$BuildMode = "debug" Write-Host "Building in $BuildMode mode..." -ForegroundColor Yellow @@ -81,11 +81,7 @@ $TmpDir = Join-Path $ScriptDir ".tmp" New-Item -ItemType Directory -Force -Path $TmpDir | Out-Null $LogFile = Join-Path $TmpDir "build-$BuildMode.log" -if ($Release) { - & cargo build --release 2>&1 | Out-File -FilePath $LogFile -Encoding utf8 -} else { - & cargo build 2>&1 | Out-File -FilePath $LogFile -Encoding utf8 -} +& cargo build 2>&1 | Out-File -FilePath $LogFile -Encoding utf8 $BuildExit = $LASTEXITCODE Get-Content $LogFile | ForEach-Object { Write-Host $_ } diff --git a/docs/UPSTREAM-SYNC.md b/docs/UPSTREAM-SYNC.md new file mode 100644 index 00000000..61d48b0e --- /dev/null +++ b/docs/UPSTREAM-SYNC.md @@ -0,0 +1,115 @@ +# Upstream sync ledger + +This repository is **Nexartis's supply-chain mirror** of +[`flupkede/codesearch`](https://github.com/flupkede/codesearch). The fleet +installs a signed, SHA-256-pinned binary from this fork (see +`nexartis-ozzydev/mcp/upstream-forks.json` → `Nexartis/codesearch`, +`pin_version`, `pin_source: mcp/install.sh`). This file records the fork's sync +state and policy so a future sync wave starts from evidence, not rediscovery. + +## Policy + +- **Landing path:** `release/*` (or `develop`) → `master`. `protect-master.yml` + rejects a PR to `master` whose head is not `develop` or `release/*`. +- **Source of truth:** upstream `develop` is the integration line; upstream + `master` is the release line. Upstream develops on `develop`, releases to + `master`, then merges `master` back into `develop`. +- **Pin:** the installed binary version is `pin_version` in + `nexartis-ozzydev/mcp/upstream-forks.json`; a catch-up that changes the + running version must bump that pin (and re-publish the fork release asset). + +## Sync state + +| Ref | Head | Version | Note | +| :-- | :--- | :------ | :--- | +| `master` | `07f0466` | v1.4.11 + sync #1 | default branch | +| `release/v1.5.2` | `7b47a9b` | upstream `master` v1.5.2 + 2 fork fixes | PR #4 (blocked on gated master-base verb) | +| `release/v1.5.32` | (this branch) | upstream `develop` v1.5.32 + 2 fork fixes | catch-up (this PR) | + +## Catch-up: upstream `develop` v1.5.3 → v1.5.32 (143 commits) + +Ranked by risk to the fleet's memory plane (a broken index silently degrades +every agent that reads code). Evidence is the upstream commit SHA; each fix is +also summarised in `CHANGELOG.md` under its version. + +### Tier 0 — security + +| SHA | Change | +| :-- | :----- | +| `e61b2cd` | refresh `quinn-proto` to 0.11.19 (Aikido `AIKIDO-2026-404995`, GHSA-53rm-773f-4q8c) — `Cargo.lock` only | + +### Tier 1 — index integrity / data-loss class + +| SHA | Change | +| :-- | :----- | +| `f149091` | stop wiping index caches on every binary swap; harden the transient FTS redrive | +| `241e641` | persist file metadata per index batch, atomically | +| `120169b` | chunk-store records stamped with the builder version, wiped on mismatch | +| `3807739` | retry the transient FTS commit race; keep failed adds registered | +| `43d0cc4`, `6120429` | diff-review findings: symbol pairing, noise, FTS scope, atomic save, rebuild guard | +| `85e0a4e` | file-meta invalidation messages go through `warn_print`, not `println` | + +### Tier 2 — MCP tool correctness, status honesty, C# helper robustness + +| SHA | Change | +| :-- | :----- | +| `93090a3` | `find` → `find_impact` position round-trip (1-based chunk lines, alias prefix, loud NotFound) | +| `07cdddb`, `abb792c` | negotiate 2026-07-28 MCP sessions so results keep `resultType` | +| `b4614bd`, `2cb4976` | expose symbol-index status on info surfaces and `find_impact` | +| `0e87917`, `6648d1f`, `ed2ef81`, `5dc47bc`, `ea7020d`, `7ce51e5` | status never reports ready while a rebuild runs (owner-scoped override, warning-not-error, bounded restore retry) | +| `9388426`, `51bbadf`, `2b65bed` | owner-scoped TUI indexing status; resting repos render `ok`/`Idle` | +| `ca02f79` | keep the repo label on indexing while a rebuild is queued | +| `e1963a5` | TUI shows `idx` for indexed-but-unloaded repos | +| `83dff3a` | symbol-index warnings wrap and are clipboard-copyable | +| `d70c508` | demote MSBuild advisories + BuildHost shutdown chatter to INFO | +| `278394c` | CLI stops instead of building locally when the serve is already indexing | +| `1cef3b6` | mark the db dir hidden on Windows so Search indexer leaves it alone | +| `cc46d3f` | re-resolve the map symbol in its workspace compilation before `FindReferencesAsync` | +| `bfcae91` | normalize backslash project paths in `NeedsRestore` | +| `afb5d61` | dedupe workspace loads, INFO-level env noise, quit during restore wait | +| `d2cf10a` | kill in-flight scip-csharp helper children on serve shutdown | +| `ea441ba` | net4x target spellings no longer raise the TFM floor | +| `4574c23` | VS-MSBuild restore fallback when the CLI SDK set cannot target the repo | +| `51b937d` | guard restore-pending exit-code parity between Rust and the C# helper | + +### Tier 3 — features + +| SHA | Change | +| :-- | :----- | +| `235f593` | run C# source generators (Razor) before symbol collection | +| `6540690`, `731f067`, `47a7527`, `95bc4a9`, `9fddb7c`, `680922e`, `48d1763`, `3029ac6`, `47587c6` | #225: per-project restore fallback + EOL-framework skip; restore-caused noise demoted; gated commands refuse to index while restore is in flight; restore freshness honours central package management | +| `f91c08c` | persist file metadata per index batch (per-batch atomic save) | + +### Tier 4 — chore / deps / CI + +| SHA | Change | +| :-- | :----- | +| `ad980c1` | tree-sitter-php 0.24.2 → 0.25.1 | +| `bd87dff` | cargo minor-and-patch group (6 updates) | +| `14c677f`, `bed86c8` | actions/upload-artifact, actions/download-artifact bumps | +| `92d8876` | docs: document the `core.bare` self-heal for direct git work | + +## Not yet in `develop` (follow-up candidates) + +- `upstream/perf/csharp-refs-at-index` (`fa10be7`, 5 commits beyond `develop`): + `perf(symbols): ingest precomputed C# references at rebuild`, + `perf(scip-csharp): emit references in one pass (index 2.1)`, + `perf(scip-csharp): log index stage timings` + 2 test commits. A **performance** + change, not a correctness one — land separately once upstream merges it. + +## Fork-local deltas (preserved through this sync) + +| Commit | Change | Upstream equivalent | +| :----- | :----- | :------------------ | +| `237a73c` | attribute `group=` hits to their owning repo; add `packages.lock.json` as a restore input | `a0c00b1` covers group attribution differently; upstream has **no** `packages.lock.json` input | +| `7b47a9b` | classify the unknown-`project=` refusal as a structured `project_unresolved` envelope | none — fork-local (NEE-P-CONSISTENT) | + +## Reproduce + +```sh +git remote add upstream https://github.com/flupkede/codesearch.git +git fetch upstream --tags +git log --oneline upstream/develop ^ # what is missing +git merge upstream/develop # catch up +cargo check --all-targets && cargo test +``` diff --git a/helpers/csharp/GeneratorSupport.cs b/helpers/csharp/GeneratorSupport.cs new file mode 100644 index 00000000..8e897740 --- /dev/null +++ b/helpers/csharp/GeneratorSupport.cs @@ -0,0 +1,300 @@ +using System.Collections.Concurrent; +using System.Reflection; +using System.Runtime.Loader; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.Diagnostics; +using Microsoft.CodeAnalysis.Text; + +namespace ScipCsharp; + +/// +/// Why generators run here: Project.GetCompilationAsync() never executes source +/// generators. A workspace (design-time) build stages the generator assemblies, +/// the .razor files (AdditionalDocuments) and GeneratedMSBuildEditorConfig.editorconfig, +/// but nothing drives a GeneratorDriver. On Blazor projects the code-behind +/// partial then cannot see the @code members — CS0103/CS0115 cascades that make +/// the index warnings fire although `dotnet build` is clean. +/// +public enum GeneratorRunOutcome +{ + /// No generator pipeline attempted (no C# compilation, no generators declared). + NotRun, + /// Generators ran; the returned compilation includes their output. + Ran, + /// The generator pipeline failed — a tool-side gap, not a user error. + Failed, +} + +public static class GeneratorSupport +{ + // Recovery is expensive (ALC load + reflection per analyzer); the resulting + // generator instances are stateless and reusable across projects and drivers. + // The cache is process-static and each entry loads an isCollectible:false + // ALC: in the resident workspace pool distinct analyzer paths accumulate + // across evictions and never unload — bounded in practice (tens of paths), + // but remember this origin when debugging serve memory. + private static readonly ConcurrentDictionary RecoveryCache = + new(StringComparer.OrdinalIgnoreCase); + + /// + /// Compilation for symbol collection: plain compilation with all declared + /// source generators run over it. On any failure returns the plain + /// compilation with so callers can + /// downgrade the resulting diagnostics to [INFO] instead of [WARN] — + /// generator failures are a tool-side gap the user cannot fix. + /// + public static async Task<(Compilation? Compilation, GeneratorRunOutcome Outcome)> + GetCompilationWithGeneratorsAsync(Project project) + { + var compilation = await project.GetCompilationAsync().ConfigureAwait(false); + if (compilation is not CSharpCompilation csharp) + return (compilation, GeneratorRunOutcome.NotRun); + if (project.Language != LanguageNames.CSharp || !csharp.SyntaxTrees.Any()) + return (compilation, GeneratorRunOutcome.NotRun); + + try + { + var generators = CollectGenerators(project); + if (generators.Count == 0) + return (compilation, GeneratorRunOutcome.NotRun); + + var additionalTexts = await CollectAdditionalTextsAsync(project).ConfigureAwait(false); + var optionsProvider = await BuildOptionsProviderAsync(project).ConfigureAwait(false); + var parseOptions = (CSharpParseOptions)csharp.SyntaxTrees.First().Options; + + var driver = CSharpGeneratorDriver.Create(generators, additionalTexts, parseOptions, optionsProvider); + driver.RunGeneratorsAndUpdateCompilation(csharp, out var output, out _); + return (output, GeneratorRunOutcome.Ran); + } + catch (Exception ex) + { + Console.Error.WriteLine( + $"[INFO] Source generators could not run for {project.Name}: {ex.GetType().Name}: {ex.Message}. " + + "Generated-only declarations (e.g. Razor components) may be missing from this project's symbols."); + return (compilation, GeneratorRunOutcome.Failed); + } + } + + /// + /// Generators declared by the project. Roslyn's generator discovery is + /// tried first; references where it returns nothing are loaded through a + /// tolerant loader — the Roslyn 4.x version guard throws (NRE on + /// version-less assembly references) for analyzers built against a newer + /// Roslyn than the host pins, which is exactly the Razor SDK's case. + /// + private static List CollectGenerators(Project project) + { + var generators = new List(); + foreach (var reference in project.AnalyzerReferences.OfType()) + { + System.Collections.Immutable.ImmutableArray viaRoslyn; + try { viaRoslyn = reference.GetGenerators(LanguageNames.CSharp); } + catch { viaRoslyn = System.Collections.Immutable.ImmutableArray.Empty; } + if (viaRoslyn.Length > 0) + { + generators.AddRange(viaRoslyn); + continue; + } + + generators.AddRange(RecoveryCache.GetOrAdd(reference.FullPath, static path => RecoverGenerators(path))); + } + return generators; + } + + private static ISourceGenerator[] RecoverGenerators(string analyzerPath) + { + if (!File.Exists(analyzerPath)) + return []; + try + { + var loader = new RecoveryLoader(analyzerPath); + var assembly = loader.LoadFromAssemblyPath(analyzerPath); + Type[] types; + try { types = assembly.GetTypes(); } + catch (ReflectionTypeLoadException rtle) + { + types = rtle.Types.Where(t => t is not null).ToArray()!; + } + + var found = new List(); + foreach (var type in types) + { + if (!type.GetCustomAttributesData().Any(a => a.AttributeType.Name == "GeneratorAttribute")) + continue; + object? instance; + try { instance = Activator.CreateInstance(type); } + catch { continue; } + if (instance is IIncrementalGenerator incremental) + found.Add(Microsoft.CodeAnalysis.GeneratorExtensions.AsSourceGenerator(incremental)); + else if (instance is ISourceGenerator classic) + found.Add(classic); + } + return [.. found]; + } + catch + { + return []; + } + } + + /// + /// Binds host assemblies by NAME so generator assemblies built against a + /// newer Roslyn share one type identity with the host's pinned version. + /// Dependencies not listed in the analyzer's deps.json (SDK-internal + /// project references) are probed next to the analyzer itself. + /// + private sealed class RecoveryLoader : AssemblyLoadContext + { + private readonly string _analyzerDir; + private readonly AssemblyDependencyResolver _resolver; + + public RecoveryLoader(string analyzerPath) + : base($"scip-csharp-generator-{Path.GetFileName(analyzerPath)}", isCollectible: false) + { + _analyzerDir = Path.GetDirectoryName(analyzerPath)!; + _resolver = new AssemblyDependencyResolver(analyzerPath); + } + + protected override Assembly? Load(AssemblyName assemblyName) + { + var name = assemblyName.Name; + if (name is null) + return null; + foreach (var asm in Default.Assemblies) + { + if (string.Equals(asm.GetName().Name, name, StringComparison.OrdinalIgnoreCase)) + return asm; + } + var path = _resolver.ResolveAssemblyToPath(assemblyName) ?? ProbeAnalyzerDir(name); + return path is not null ? LoadFromAssemblyPath(path) : null; + } + + private string? ProbeAnalyzerDir(string name) + { + var candidate = Path.Combine(_analyzerDir, name + ".dll"); + return File.Exists(candidate) ? candidate : null; + } + } + + private static async Task> CollectAdditionalTextsAsync(Project project) + { + var texts = new List(); + foreach (var doc in project.AdditionalDocuments) + texts.Add(new DocText(doc.FilePath!, await doc.GetTextAsync().ConfigureAwait(false))); + return texts; + } + + private static async Task BuildOptionsProviderAsync(Project project) + { + var documents = new List<(string Path, string Text)>(); + foreach (var doc in project.AnalyzerConfigDocuments) + documents.Add((doc.FilePath!, (await doc.GetTextAsync().ConfigureAwait(false)).ToString())); + var options = new EditorConfigOptions(documents); + return new PathOptionsProvider(options.Global, path => options.ForPath(path)); + } +} + +/// AnalyzerConfigOptions backed by a case-insensitive map; MSBuild +/// editorconfigs repeat keys, so last wins. +internal sealed class DictOptions : AnalyzerConfigOptions +{ + private readonly Dictionary values; + + public DictOptions(IEnumerable> entries) + { + values = new Dictionary(StringComparer.OrdinalIgnoreCase); + foreach (var (key, value) in entries) + values[key] = value; + } + + public override bool TryGetValue(string key, out string value) => values.TryGetValue(key, out value!); + public override IEnumerable Keys => values.Keys; + + internal static readonly DictOptions Empty = new([]); +} + +/// Parses MSBuild editorconfig documents (is_global section plus +/// [path] sections) into per-path options for source generators. +/// Limitation: sections match EXACT paths only (forward-slash normalized, +/// case-insensitive) — that is what MSBuild's GeneratedMSBuildEditorConfig +/// writes, and the Blazor fixture pins that case end-to-end. Glob-style +/// sections ([*.razor], [**/Components/**]) are silently unmatched, so +/// generator options scoped by glob are ignored. +internal sealed class EditorConfigOptions +{ + private readonly Dictionary byPath = new(StringComparer.OrdinalIgnoreCase); + private readonly DictOptions global; + + public EditorConfigOptions(IEnumerable<(string Path, string Text)> documents) + { + var globalEntries = new List>(); + foreach (var (docPath, text) in documents) + { + string? section = null; + var sectionEntries = new List>(); + foreach (var rawLine in text.Split('\n')) + { + var line = rawLine.Trim(); + if (line.Length == 0 || line.StartsWith('#') || line.StartsWith(';')) + continue; + if (line.StartsWith('[') && line.EndsWith(']')) + { + FlushSection(section, sectionEntries); + section = Normalize(line[1..^1]); + sectionEntries = new List>(); + } + else if (section is null) + { + var kv = SplitKv(line); + if (kv is not null && !kv.Value.Key.Equals("is_global", StringComparison.OrdinalIgnoreCase)) + globalEntries.Add(kv.Value); + } + else + { + var kv = SplitKv(line); + if (kv is not null) + sectionEntries.Add(kv.Value); + } + } + FlushSection(section, sectionEntries); + } + global = new DictOptions(globalEntries); + } + + private void FlushSection(string? section, List> entries) + { + if (section is not null && entries.Count > 0) + byPath[section] = new DictOptions(entries); + } + + private static string Normalize(string path) => path.Replace('\\', '/'); + + private static KeyValuePair? SplitKv(string line) + { + var idx = line.IndexOf('='); + if (idx < 0) + return null; + return new KeyValuePair(line[..idx].Trim(), line[(idx + 1)..].Trim()); + } + + public AnalyzerConfigOptions Global => global; + + public AnalyzerConfigOptions ForPath(string path) => + byPath.TryGetValue(Normalize(path), out var opts) ? opts : DictOptions.Empty; +} + +internal sealed class PathOptionsProvider(AnalyzerConfigOptions global, Func byPath) + : AnalyzerConfigOptionsProvider +{ + public override AnalyzerConfigOptions GlobalOptions => global; + public override AnalyzerConfigOptions GetOptions(SyntaxTree tree) => byPath(tree.FilePath); + public override AnalyzerConfigOptions GetOptions(AdditionalText file) => byPath(file.Path); +} + +internal sealed class DocText(string path, SourceText text) : AdditionalText +{ + public override string Path { get; } = path; + + public override SourceText GetText(CancellationToken cancellationToken = default) => text; +} diff --git a/helpers/csharp/MsbuildRestore.cs b/helpers/csharp/MsbuildRestore.cs new file mode 100644 index 00000000..b011207d --- /dev/null +++ b/helpers/csharp/MsbuildRestore.cs @@ -0,0 +1,305 @@ +namespace ScipCsharp; + +/// +/// One installable MSBuild candidate for the capability-aware instance +/// choice: either the MSBuild of a .NET SDK install (CLI-visible) or of a +/// Visual Studio instance (bundled with VS, independent of +/// C:\Program Files\dotnet). Dependency-free so the decision logic +/// is unit-testable without spinning up real installs. +/// +internal readonly record struct MsbuildCandidate(Version Version, bool IsDotNetSdk); + +internal static class MsbuildRestore +{ + /// + /// vswhere ships in the fixed VS Installer location on every Windows + /// machine; probing it anywhere else just multiplies failure modes. + /// + private const string VsWherePath = @"C:\Program Files (x86)\Microsoft Visual Studio\Installer\vswhere.exe"; + + // NETSDK1045: "The current .NET SDK does not support targeting .NET X.0". + private const string SdkDoesNotSupportTargeting = "does not support targeting"; + // Current hosts: "A compatible .NET SDK was not found" (global.json + // unsatisfiable); legacy hosts worded it "A compatible installed .NET + // SDK for global.json at ... was not found." Match both — neither + // phrasing contains the other. + private const string SdkGlobalJsonNotFoundModern = "compatible .NET SDK"; + private const string SdkGlobalJsonNotFoundLegacy = "compatible installed .NET SDK"; + + /// vswhere probe bound — generous for a local EXE, still bounded. + private const int VsWhereWaitMs = 10_000; + + /// + /// True when a dotnet restore failed on SDK resolution — the + /// CLI-visible SDK set cannot target the repo's TFM (NETSDK1045) or + /// cannot satisfy global.json — rather than on packages. These are the + /// failures a Visual Studio install can still recover: VS ships its own + /// MSBuild + SDK targets, blind spots of C:\Program Files\dotnet + /// included (2026-10-15 incident: a hollow 10.0.101 SDK dir left the + /// CLI unable to target net10 while VS built fine). Feed/auth failures + /// (NU11xx) deliberately do NOT match — VS restores through the same + /// NuGet stack and would fail identically, so retrying those buys a + /// second slow failure. + /// + internal static bool IsSdkResolutionFailure(string restoreOutput) => + restoreOutput.Contains(SdkDoesNotSupportTargeting, StringComparison.OrdinalIgnoreCase) + || restoreOutput.Contains(SdkGlobalJsonNotFoundModern, StringComparison.OrdinalIgnoreCase) + || restoreOutput.Contains(SdkGlobalJsonNotFoundLegacy, StringComparison.OrdinalIgnoreCase); + + /// + /// Full path of the newest VS MSBuild via vswhere, or null when vswhere, + /// VS, or the MSBuild component is absent (non-Windows included). + /// Best effort by design: a probe failure must never break the restore + /// path it is meant to improve. -prerelease includes Insiders + /// channels; -find (vswhere ≥ 2.8) returns MSBuild.exe paths + /// directly, newest instance only via -latest. + /// + internal static string? LocateVsMsbuild() + { + if (!OperatingSystem.IsWindows() || !File.Exists(VsWherePath)) + { + return null; + } + try + { + var psi = new System.Diagnostics.ProcessStartInfo + { + FileName = VsWherePath, + Arguments = "-latest -prerelease -products * -requires Microsoft.Component.MSBuild " + + "-find MSBuild\\**\\Bin\\MSBuild.exe", + RedirectStandardOutput = true, + RedirectStandardError = true, + UseShellExecute = false, + }; + using var process = System.Diagnostics.Process.Start(psi); + if (process is null) + { + return null; + } + // Drain async, THEN bounded-wait — and KILL on timeout: unlike a + // restore (never killed — its work must survive), vswhere is a + // local metadata probe whose death costs one failed probe. The + // kill also closes the pipes, so the stdout read cannot block. + var stdoutTask = process.StandardOutput.ReadToEndAsync(); + _ = process.StandardError.ReadToEndAsync(); + if (!process.WaitForExit(VsWhereWaitMs)) + { + try + { + process.Kill(entireProcessTree: true); + } + catch + { + // Already exiting — nothing to bound anymore. + } + return null; + } + var path = ParseFirstVswherePath(stdoutTask.GetAwaiter().GetResult()); + return path is not null && File.Exists(path) ? path : null; + } + catch + { + return null; + } + } + + /// First non-blank line of vswhere -find output. + internal static string? ParseFirstVswherePath(string vswhereOutput) + { + foreach (var raw in vswhereOutput.Split('\n')) + { + var line = raw.Trim().TrimEnd('\r'); + if (line.Length > 0) + { + return line; + } + } + return null; + } + + /// + /// The highest .NET major the solution's projects provably target: + /// max over every .csproj's first TargetFramework(s) raw-text + /// match (raw text — this runs BEFORE any MSBuild evaluation, which is + /// the whole point) and over global.json's pinned SDK version when one + /// sits at or above the solution dir. null when nothing parseable was + /// found — callers must then keep the default instance choice, because + /// an unknown floor proves nothing. + /// + internal static int? RequiredSdkMajorFloor(string? solutionPath) + { + if (solutionPath is null || !File.Exists(solutionPath)) + { + return null; + } + var solutionDir = Path.GetDirectoryName(Path.GetFullPath(solutionPath)) ?? "."; + int? floor = null; + foreach (var projectPath in EnumerateSolutionProjects(solutionPath, solutionDir)) + { + var major = TargetFrameworkMajor(ReadTextBestEffort(projectPath)); + if (major is not null && (floor is null || major > floor)) + { + floor = major; + } + } + var globalJsonMajor = GlobalJsonSdkMajor(solutionDir); + if (globalJsonMajor is not null && (floor is null || globalJsonMajor > floor)) + { + floor = globalJsonMajor; + } + return floor; + } + + /// + /// Which install to register MSBuild from: the highest .NET SDK instance + /// that can target (matching the + /// "register the highest available MSBuild instance" intent, unlike the + /// historical first-match), falling back to the highest VS instance when + /// no SDK instance qualifies — VS bundles its own SDK targets, so it can + /// evaluate TFMs the installed CLI SDKs cannot. The VS path is the + /// documented net472-BuildHost-crash risk, accepted ONLY when the SDK + /// path is certain to fail the load anyway. Returns the index of the + /// chosen candidate within and whether it + /// is an SDK instance (for logging the flip explicitly). + /// + internal static (int Index, bool IsSdk) ChooseMsBuildInstance( + IReadOnlyList candidates, + int? requiredMajor) + { + var sdkCandidates = candidates + .Select((c, i) => (Candidate: c, Index: i)) + .Where(e => e.Candidate.IsDotNetSdk) + .OrderByDescending(e => e.Candidate.Version) + .ToList(); + if (sdkCandidates.Count > 0) + { + var qualifying = requiredMajor is null + ? sdkCandidates[0] + : sdkCandidates.FirstOrDefault(e => e.Candidate.Version.Major >= requiredMajor); + if (!qualifying.Equals(default)) + { + return (qualifying.Index, true); + } + } + // No SDK instance can target the repo (or none exists): highest + // instance overall — a VS install when present, else whatever the + // SDK set offered (preserves the old behaviour as the last resort). + var overall = candidates + .Select((c, i) => (Candidate: c, Index: i)) + .OrderByDescending(e => e.Candidate.Version) + .First(); + return (overall.Index, overall.Candidate.IsDotNetSdk); + } + + private static IEnumerable EnumerateSolutionProjects(string solutionPath, string solutionDir) + { + string[] lines; + try + { + lines = File.ReadAllLines(solutionPath); + } + catch + { + yield break; + } + // Project("{GUID}") = "Name", "Relative\Path.csproj", "{GUID}" + foreach (var line in lines) + { + var trimmed = line.Trim(); + if (!trimmed.StartsWith("Project(", StringComparison.Ordinal)) + { + continue; + } + var parts = trimmed.Split(','); + if (parts.Length < 2) + { + continue; + } + var pathPart = parts[1].Trim(); + if (pathPart.Length < 2 || !pathPart.StartsWith('"') || !pathPart.EndsWith('"')) + { + continue; + } + var relative = pathPart[1..^1]; + if (relative.EndsWith(".csproj", StringComparison.OrdinalIgnoreCase)) + { + yield return Path.GetFullPath( + relative.Replace('\\', Path.DirectorySeparatorChar), Path.GetFullPath(solutionDir)); + } + } + } + + private static string? ReadTextBestEffort(string path) + { + try + { + return File.Exists(path) ? File.ReadAllText(path) : null; + } + catch + { + return null; + } + } + + /// + /// The HIGHEST netX.Y major in raw project text — a floor wants the max, + /// so a net8.0;net10.0 multi-target floors at 10 (unlike the EOL + /// skip-guard, whose first-TFM stance serves a different purpose). + /// netstandard/netcoreapp deliberately do not match — they load under + /// any modern SDK, and EOL ones are skipped anyway. The minor dot is + /// REQUIRED: the extension-less .NET Framework spellings (net48, + /// net472) must not raise the floor — an SDK loads those from reference + /// assemblies, and a "48" floor would flip healthy SDK+VS machines to + /// the VS instance for no reason. + /// + private static int? TargetFrameworkMajor(string? projectText) + { + if (projectText is null) + { + return null; + } + var match = System.Text.RegularExpressions.Regex.Match( + projectText, @"([^<]+) floor)) + { + floor = major; + } + } + return floor; + } + + /// + /// Major of the SDK version pinned by the nearest global.json walking + /// up from the solution dir — NuGet's own lookup order. rollForward + /// never lowers the floor, so the pinned major is the safe bound. + /// + private static int? GlobalJsonSdkMajor(string solutionDir) + { + var dir = Path.GetFullPath(solutionDir); + while (true) + { + var globalJson = Path.Combine(dir, "global.json"); + if (File.Exists(globalJson)) + { + var match = System.Text.RegularExpressions.Regex.Match( + ReadTextBestEffort(globalJson) ?? "", @"""version""\s*:\s*""(\d+)\."); + return match.Success && int.TryParse(match.Groups[1].Value, out var major) ? major : null; + } + var parent = Directory.GetParent(dir)?.FullName; + if (string.IsNullOrEmpty(parent) || string.Equals(parent, dir, StringComparison.OrdinalIgnoreCase)) + { + return null; + } + dir = parent; + } + } +} diff --git a/helpers/csharp/Program.cs b/helpers/csharp/Program.cs index e8539efc..b1fce4fd 100644 --- a/helpers/csharp/Program.cs +++ b/helpers/csharp/Program.cs @@ -1,5 +1,7 @@ +using System.Diagnostics; using System.Diagnostics.CodeAnalysis; using Microsoft.Build.Locator; +using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.MSBuild; namespace ScipCsharp; @@ -43,6 +45,14 @@ public static async Task Main(string[] args) return 0; } + if (args[0] is "--version" or "version") + { + // The deployed helper's identity: the host logs it at startup so + // a stale helper (deployed before its host) is visible. + Console.WriteLine($"scip-csharp {GetHelperVersion()}"); + return 0; + } + return args[0] switch { "index" => await RunIndexAsync(args[1..]).ConfigureAwait(false), @@ -53,6 +63,14 @@ public static async Task Main(string[] args) }; } + /// Major.Minor.Build from the assembly — the csproj Version, + /// kept in sync with the crate by scripts/bump-version.sh. + internal static string GetHelperVersion() + { + var version = System.Reflection.Assembly.GetEntryAssembly()?.GetName().Version; + return version is null ? "unknown" : $"{version.Major}.{version.Minor}.{version.Build}"; + } + /// /// Solution path the serve loop was started with. Remembered so a /// "reload" request without an explicit path re-opens the same solution. @@ -68,14 +86,31 @@ private static async Task RunServeAsync(string[] args) var parsed = ParseServeArgs(args); if (parsed is null) return 1; - if (!TryRegisterMsBuild(out var regErr)) { await Console.Error.WriteLineAsync(regErr).ConfigureAwait(false); return 1; } + if (!TryRegisterMsBuild(parsed, out var regErr)) { await Console.Error.WriteLineAsync(regErr).ConfigureAwait(false); return 1; } + + // A resident workspace must not come up mid-restore: the host CACHES + // its find-refs answers, so degraded answers from a workspace loaded + // while restore is in flight would be persisted (issue #225 + // acceptance). Startup refuses so the pool falls back to the one-shot + // path, which handles restore-pending explicitly. Reloads of an + // ALREADY-RUNNING resident keep answering (gateRestorePending: false). + if (RestoreGate.ServeStartupPendingExit(parsed) is { } startupPendingExit) + { + return startupPendingExit; + } using var workspace = CreateTolerantWorkspace(); try { Console.Error.WriteLine($"serve: loading solution: {parsed}"); - await OpenSolutionFilteredAsync(workspace, parsed).ConfigureAwait(false); + await OpenSolutionFilteredAsync(workspace, parsed, gateRestorePending: true).ConfigureAwait(false); + } + catch (RestorePendingException) + { + // Serve's own startup restore overran its bounded wait: refuse the + // same way an active marker does — the pool falls back and retries. + return ExitCodes.RestorePending; } catch (Exception ex) { @@ -101,7 +136,7 @@ await Console.Error.WriteLineAsync( // process death is (todo #115). return await ServeHost.LoopAsync( workspace, - solution => OpenSolutionFilteredAsync(workspace, solution)).ConfigureAwait(false); + solution => OpenSolutionFilteredAsync(workspace, solution, gateRestorePending: false)).ConfigureAwait(false); } private static string? ParseServeArgs(string[] args) @@ -132,7 +167,7 @@ private static async Task RunIndexAsync(string[] args) var parsed = ParseIndexArgs(args); if (parsed is null) return 1; - if (!TryRegisterMsBuild(out var regErr)) { await Console.Error.WriteLineAsync(regErr).ConfigureAwait(false); return 1; } + if (!TryRegisterMsBuild(parsed.Value.SolutionPath, out var regErr)) { await Console.Error.WriteLineAsync(regErr).ConfigureAwait(false); return 1; } using var workspace = CreateTolerantWorkspace(); @@ -145,6 +180,9 @@ private static async Task RunIndexAsync(string[] args) } else if (!string.IsNullOrEmpty(parsed.Value.ProjectPath)) { + // No restore gate on this path: restore (and its marker) is + // solution-keyed and a bare --project load has no solution. + // The host never passes --project — out of scope for #225. Console.Error.WriteLine($"Loading project: {parsed.Value.ProjectPath}"); await workspace.OpenProjectAsync(parsed.Value.ProjectPath).ConfigureAwait(false); } @@ -154,6 +192,12 @@ private static async Task RunIndexAsync(string[] args) return 1; } } + catch (RestorePendingException) + { + // No output file written: restore is still in flight and the + // Rust host must treat this as restore-pending, not as failure. + return ExitCodes.RestorePending; + } catch (Exception ex) { // Some solutions contain unsupported project types (e.g. .deployproj, .shproj) that @@ -194,7 +238,7 @@ private static async Task RunFindRefsAsync(string[] args) var parsed = ParseFindRefsArgs(args); if (parsed is null) return 1; - if (!TryRegisterMsBuild(out var regErr)) { await Console.Error.WriteLineAsync(regErr).ConfigureAwait(false); return 1; } + if (!TryRegisterMsBuild(parsed.Value.SolutionPath, out var regErr)) { await Console.Error.WriteLineAsync(regErr).ConfigureAwait(false); return 1; } using var workspace = CreateTolerantWorkspace(); @@ -203,6 +247,12 @@ private static async Task RunFindRefsAsync(string[] args) Console.Error.WriteLine($"find-refs: loading solution: {parsed.Value.SolutionPath}"); await OpenSolutionFilteredAsync(workspace, parsed.Value.SolutionPath).ConfigureAwait(false); } + catch (RestorePendingException) + { + // No output file written: the Rust host maps exit 75 to a + // restore-pending outcome, never a generic resolver failure. + return ExitCodes.RestorePending; + } catch (Exception ex) { await Console.Error.WriteLineAsync( @@ -249,7 +299,7 @@ private static async Task RunBatchFindRefsAsync(string[] args) var parsed = ParseBatchFindRefsArgs(args); if (parsed is null) return 1; - if (!TryRegisterMsBuild(out var regErr)) { await Console.Error.WriteLineAsync(regErr).ConfigureAwait(false); return 1; } + if (!TryRegisterMsBuild(parsed.Value.SolutionPath, out var regErr)) { await Console.Error.WriteLineAsync(regErr).ConfigureAwait(false); return 1; } using var workspace = CreateTolerantWorkspace(); @@ -258,6 +308,12 @@ private static async Task RunBatchFindRefsAsync(string[] args) Console.Error.WriteLine($"batch-find-refs: loading solution: {parsed.Value.SolutionPath}"); await OpenSolutionFilteredAsync(workspace, parsed.Value.SolutionPath).ConfigureAwait(false); } + catch (RestorePendingException) + { + // No output file written: the Rust host maps exit 75 to a + // restore-pending outcome, never a generic resolver failure. + return ExitCodes.RestorePending; + } catch (Exception ex) { await Console.Error.WriteLineAsync( @@ -309,18 +365,7 @@ await Console.Error.WriteLineAsync( /// private static MSBuildWorkspace CreateTolerantWorkspace() { - var properties = new Dictionary - { - // Tell Roslyn to skip projects it cannot load instead of crashing. - { "BuildingInsideVisualStudio", "true" }, - // Design-time build: prevents auto-generated files in obj/ (e.g. - // .AssemblyAttributes.cs, .AssemblyInfo.cs) from being included as - // explicit Compile items. Without this, SDK-style projects produce - // duplicate Compile items (auto-include + obj/ generated), which - // causes MSBuildWorkspace to fail loading the project. - { "DesignTimeBuild", "true" }, - { "SkipCompilerExecution", "true" }, - }; + var properties = WorkspaceLoad.GlobalProperties(); // If MSBUILD_EXE_PATH is set, pass it to the workspace so the BuildHost // uses the same MSBuild we registered via MSBuildLocator (typically the .NET SDK). @@ -334,10 +379,432 @@ private static MSBuildWorkspace CreateTolerantWorkspace() var workspace = MSBuildWorkspace.Create(properties); workspace.WorkspaceFailed += (_, e) => + { + // Warning-severity diagnostics are benign resolution notes (e.g. + // "Found project reference without a matching metadata reference" + // for excluded or external projects): they do not block indexing + // and would pin the repo's index warning forever. Only true + // failures belong in the warning channel. + if (e.Diagnostic.Kind == WorkspaceDiagnosticKind.Warning) + { + Console.Error.WriteLine($"[INFO] Workspace note: {e.Diagnostic}"); + return; + } + // NuGet's vulnerability audit surfaces as an Msbuild "failure" but + // is a security advisory, not a load failure — the index is + // unaffected and emitting it would pin the repo's index warning + // until the package is bumped. + if (WorkspaceNoise.IsNuGetAuditNoise(e.Diagnostic?.Message)) + { + return; + } + // A NuGet package-version mismatch ("Dependency specified was X + // (>= A) but ended up with X B") also surfaces as an Msbuild + // "failure", but the affected project still loads and its symbol + // tree is complete — build engineering settles the pin; the + // index must not carry the noise as a warning. + if (WorkspaceNoise.IsPackageVersionConflict(e.Diagnostic?.Message) + || WorkspaceNoise.IsNuGetSourceFailure(e.Diagnostic?.Message)) + { + Console.Error.WriteLine(WorkspaceNoise.DemotedNote(e.Diagnostic!)); + return; + } + // MSBuild check advisories (package compatibility, e.g. the + // Grpc.Net.ClientFactory version check) also escalate to + // "failures": product guidance, not load failures — demote. + if (WorkspaceNoise.IsMsbuildCheckAdvisory(e.Diagnostic?.Message)) + { + Console.Error.WriteLine(WorkspaceNoise.DemotedNote(e.Diagnostic!)); + return; + } + // BuildHost shutdown chatter ("[BuildHost PID N] ... not + // responding") trails a crash the load failure already reports; + // keeping it would double-count one failure. + if (WorkspaceNoise.IsBuildHostShutdownChatter(e.Diagnostic?.Message)) + { + Console.Error.WriteLine(WorkspaceNoise.DemotedNote(e.Diagnostic!)); + return; + } Console.Error.WriteLine($"[WARN] Workspace error: {e.Diagnostic}"); + }; return workspace; } + /// A project whose own restore failed during the per-project fallback. + /// With usable existing assets it is still indexed — its compilation + /// diagnostics are restore-caused (reported as [INFO], never driving the + /// warning icon); without assets it is excluded from the load entirely. + private sealed record ProjectRestoreFailure(string ProjectName, string RelativePath, string FirstError); + + /// + /// Restores the solution before the design-time load. MSBuildWorkspace + /// does not restore: with stale or missing obj/project.assets.json, + /// package-typed references fail to resolve and the load drowns in CS0246 + /// cascades even though `dotnet build` (which restores first) succeeds. + /// Gated by . + /// + /// Restore is the ONLY all-or-nothing step in NuGet: one unresolvable + /// package anywhere fails the solution restore for EVERY project. That + /// is why a failing solution restore falls back to per-project restores: + /// each project that succeeds gets fresh assets and is indexed fully; + /// each project that fails keeps its existing (usable) assets and is + /// reported as a restore-caused caveat instead of drowning the index in + /// unrelated CS noise. Best effort throughout: a failed or missing + /// `dotnet` is logged and the load proceeds. The wait is bounded, but a + /// running restore is never killed: on timeout it continues in the + /// background and the next reindex picks up the fresh assets. + /// + /// The per-project failures from the fallback (empty when the + /// solution-level restore succeeded or nothing needed restoring). + private static List RestoreSolution( + string solutionPath, + bool gateRestorePending, + List<(int LineIndex, string RelativePath)> loadable) + { + var timeoutSeconds = RestorePolicy.RestoreTimeoutSeconds(); + // Never start a second restore while one is already running for this + // solution: an ACTIVE marker means another process (or an earlier + // timed-out run of this one) still has dotnet restore going. A stale + // marker is deleted by the check and the run proceeds normally. + if (RestorePendingMarker.IsActive(solutionPath)) + { + if (gateRestorePending) + { + Console.Error.WriteLine( + "[RESTORE-PENDING] a dotnet restore for this solution is already running — " + + $"exiting {ExitCodes.RestorePending} without building an index; retry when it finishes."); + throw new RestorePendingException(); + } + Console.Error.WriteLine( + "[INFO] a dotnet restore for this solution is already running — serve reload " + + "keeps answering from the existing workspace until it finishes."); + return []; + } + try + { + var psi = new ProcessStartInfo + { + FileName = "dotnet", + // --ignore-failed-sources: an unreachable private feed must not + // block indexing when the packages are already in the cache. + Arguments = $"restore \"{solutionPath}\" --nologo -v q --ignore-failed-sources", + RedirectStandardError = true, + RedirectStandardOutput = true, + UseShellExecute = false, + }; + using var process = Process.Start(psi); + if (process is null) + { + return []; + } + // Drain both pipes in the background: the child inherits these + // handles, so without readers a chatty restore could block on a + // full pipe, and the serve process reads stderr until EOF. The + // captured stderr feeds the failure diagnostic below — a failed + // restore without its NU11xx reason (unreachable private feed) + // just reads as unexplained CS0518/CS0246 noise downstream. + var stdoutDrain = process.StandardOutput.ReadToEndAsync(); + var stderrDrain = process.StandardError.ReadToEndAsync(); + // Bounded WAIT, never a kill: a killed restore wastes all of its + // work and leaves assets missing, so every reindex would pay the + // same wait and stay degraded. On timeout the restore keeps + // running in the background (the child outlives this process) and + // is recorded in a marker so later runs can detect it. Gated + // commands refuse to build an index (exit RestorePending) — a + // degraded index stored now would poison LMDB until the next + // rebuild — while serve keeps answering from the existing + // workspace. Timeout is env-tunable for large solutions. + if (!process.WaitForExit(timeoutSeconds * 1000)) + { + RestorePendingMarker.Write( + solutionPath, process.Id, process.StartTime.ToUniversalTime()); + if (gateRestorePending) + { + Console.Error.WriteLine( + $"[RESTORE-PENDING] dotnet restore still running after {timeoutSeconds}s for " + + $"'{solutionPath}' — not building an index while restore is in flight; the " + + "previous index stays live. Retry when restore finishes, or raise " + + $"{RestorePolicy.TimeoutEnvName}."); + throw new RestorePendingException(); + } + Console.Error.WriteLine(RestorePolicy.StillRunningWarning(timeoutSeconds)); + return []; + } + if (process.ExitCode == 0) + { + return []; + } + // NETSDK1045 and friends print to STDOUT on current dotnet hosts + // (NU11xx detail may land on either stream) — classify over both. + var restoreOutput = stderrDrain.GetAwaiter().GetResult() + + Environment.NewLine + stdoutDrain.GetAwaiter().GetResult(); + var nuDetail = RestorePolicy.ExtractRestoreErrors(restoreOutput); + if (MsbuildRestore.IsSdkResolutionFailure(restoreOutput)) + { + // The CLI SDK set cannot even target this solution — packages + // were never the problem, so the per-project fallback (same + // dotnet, same SDK wall) can only re-fail per project. A + // Visual Studio install ships its own MSBuild + SDK targets + // and can restore the full solution in one go. + var vsMsbuild = MsbuildRestore.LocateVsMsbuild(); + if (vsMsbuild is null) + { + Console.Error.WriteLine( + "[INFO] no VS MSBuild found via vswhere — the CLI SDK gap cannot be worked around."); + } + else + { + Console.Error.WriteLine( + "[INFO] the CLI .NET SDK set cannot target this solution — retrying the restore " + + $"with VS MSBuild at '{vsMsbuild}'."); + switch (TryRestoreSolutionWithVsMsbuild( + vsMsbuild, solutionPath, timeoutSeconds, gateRestorePending)) + { + case VsRestoreOutcome.Restored: + Console.Error.WriteLine( + "[INFO] VS MSBuild restore succeeded — full solution assets restored."); + return []; + case VsRestoreOutcome.StillRunningUngated: + // The VS restore keeps writing obj/ in the + // background; per-project dotnet restores would + // race those writes, so degrade with an honest + // per-project reason instead. + return loadable.Select(e => new ProjectRestoreFailure( + Path.GetFileNameWithoutExtension(e.RelativePath), + e.RelativePath, + "not attempted — a VS MSBuild restore is still running")).ToList(); + } + // Failed → the per-project fallback below still runs: in a + // mixed-TFM solution it recovers the projects the CLI CAN + // target. + } + } + var fallback = RestorePerProjectFallback( + solutionPath, solutionDir: Path.GetDirectoryName(solutionPath) ?? ".", + loadable, timeoutSeconds, gateRestorePending); + var restoredCount = loadable.Count - fallback.Count; + var header = + $"dotnet restore failed (exit {process.ExitCode}) for '{solutionPath}' — " + + $"per-project restore recovered {restoredCount}/{loadable.Count} project(s)." + + nuDetail; + if (fallback.Count == 0) + { + Console.Error.WriteLine($"[INFO] {header}"); + } + else + { + // INFO, never WARN — even when nothing recovered: a restore + // failure (a dead private feed, for one) is environment + // state, not a symbol-index defect, and must not drive the + // caller-facing warning icon. The cause rides in serve.log; + // per-project failures are reported below either way. + Console.Error.WriteLine( + "[INFO] " + header + + " Every project failed its own restore; continuing with a degraded index."); + foreach (var failure in fallback) + { + Console.Error.WriteLine( + $"[INFO] {failure.ProjectName}: restore failed — indexed from existing " + + $"assets; its compile diagnostics are restore-caused. {failure.FirstError}"); + } + } + return fallback; + } + catch (RestorePendingException) + { + throw; + } + catch (Exception ex) + { + Console.Error.WriteLine( + $"[INFO] dotnet restore could not start ({ex.GetType().Name}: {ex.Message}) — continuing without it."); + return []; + } + } + + /// Outcome of the one-shot VS-MSBuild solution restore. + private enum VsRestoreOutcome + { + Restored, + Failed, + /// Timed out ungated: the restore keeps running, serve degrades. + StillRunningUngated, + } + + /// + /// One bounded attempt to restore the solution with a VS MSBuild instead + /// of the CLI dotnet — the fallback for SDK-resolution failures, where + /// the machine's Visual Studio can do what its CLI SDK set cannot. Same + /// contract as the dotnet restore above: never killed on timeout (the + /// marker gates later runs), gated commands exit + /// instead of building a degraded + /// index. -nr:false because the helper is a short-lived subprocess + /// on a hot serve loop and must not leave MSBuild worker nodes behind. + /// + private static VsRestoreOutcome TryRestoreSolutionWithVsMsbuild( + string msbuildPath, + string solutionPath, + int timeoutSeconds, + bool gateRestorePending) + { + try + { + var psi = new ProcessStartInfo + { + FileName = msbuildPath, + Arguments = $"\"{solutionPath}\" -t:restore -nologo -v:q -nr:false", + RedirectStandardError = true, + RedirectStandardOutput = true, + UseShellExecute = false, + }; + using var process = Process.Start(psi); + if (process is null) + { + return VsRestoreOutcome.Failed; + } + _ = process.StandardOutput.ReadToEndAsync(); + var stderrDrain = process.StandardError.ReadToEndAsync(); + if (!process.WaitForExit(timeoutSeconds * 1000)) + { + RestorePendingMarker.Write( + solutionPath, process.Id, process.StartTime.ToUniversalTime()); + if (gateRestorePending) + { + Console.Error.WriteLine( + "[RESTORE-PENDING] the VS MSBuild restore is still running — exiting " + + $"{ExitCodes.RestorePending} without building an index; retry when it finishes."); + throw new RestorePendingException(); + } + Console.Error.WriteLine(RestorePolicy.StillRunningWarning(timeoutSeconds, "VS MSBuild restore")); + return VsRestoreOutcome.StillRunningUngated; + } + if (process.ExitCode == 0) + { + return VsRestoreOutcome.Restored; + } + Console.Error.WriteLine( + "[INFO] VS MSBuild restore failed" + + RestorePolicy.ExtractRestoreErrors(stderrDrain.GetAwaiter().GetResult())); + return VsRestoreOutcome.Failed; + } + catch (RestorePendingException) + { + throw; + } + catch (Exception ex) + { + Console.Error.WriteLine( + $"[INFO] VS MSBuild restore could not start ({ex.GetType().Name}: {ex.Message})."); + return VsRestoreOutcome.Failed; + } + } + + /// + /// The per-project fallback after a failed solution restore: NuGet is + /// all-or-nothing per restore, so one dead package fails every project — + /// but most projects restore fine on their own. Same bounded-wait rules + /// as the solution restore: a project restore that outlives the remaining + /// deadline is recorded as pending (gated commands refuse) and never + /// killed; the overall deadline keeps the fallback from multiplying the + /// solution timeout by the project count. + /// + private static List RestorePerProjectFallback( + string solutionPath, + string solutionDir, + List<(int LineIndex, string RelativePath)> loadable, + int timeoutSeconds, + bool gateRestorePending) + { + var failures = new List(); + var deadline = DateTime.UtcNow.AddSeconds(timeoutSeconds); + for (var i = 0; i < loadable.Count; i++) + { + var entry = loadable[i]; + var remainingMs = (int)(deadline - DateTime.UtcNow).TotalMilliseconds; + if (remainingMs <= 0) + { + // Budget spent: never-attempted projects must be classified + // as failures too — their stale-asset diagnostics are exactly + // as restore-caused as an explicit NU1101, and counting them + // as "recovered" would re-apply the warning icon to noise. + // They are retried on the next reindex. + Console.Error.WriteLine( + "[INFO] per-project restore budget exhausted; remaining project(s) keep their " + + "existing assets and are retried on the next reindex."); + failures.AddRange(loadable.Skip(i).Select(e => new ProjectRestoreFailure( + Path.GetFileNameWithoutExtension(e.RelativePath), + e.RelativePath, + "not attempted — per-project restore budget exhausted"))); + break; + } + var projectPath = Path.GetFullPath(Path.Combine(solutionDir, entry.RelativePath)); + try + { + var psi = new ProcessStartInfo + { + FileName = "dotnet", + Arguments = $"restore \"{projectPath}\" --nologo -v q --ignore-failed-sources", + RedirectStandardError = true, + RedirectStandardOutput = true, + UseShellExecute = false, + }; + using var process = Process.Start(psi); + if (process is null) + { + failures.Add(new ProjectRestoreFailure( + Path.GetFileNameWithoutExtension(entry.RelativePath), + entry.RelativePath, + "dotnet could not be started")); + continue; + } + _ = process.StandardOutput.ReadToEndAsync(); + var stderrDrain = process.StandardError.ReadToEndAsync(); + if (!process.WaitForExit(remainingMs)) + { + RestorePendingMarker.Write( + solutionPath, process.Id, process.StartTime.ToUniversalTime()); + if (gateRestorePending) + { + Console.Error.WriteLine( + $"[RESTORE-PENDING] per-project restore of '{entry.RelativePath}' is still " + + $"running — exiting {ExitCodes.RestorePending} without building an index; " + + "retry when it finishes."); + throw new RestorePendingException(); + } + Console.Error.WriteLine(RestorePolicy.StillRunningWarning(timeoutSeconds)); + failures.AddRange(loadable.Skip(i).Select(e => new ProjectRestoreFailure( + Path.GetFileNameWithoutExtension(e.RelativePath), + e.RelativePath, + "not attempted — a per-project restore is still running (budget exhausted)"))); + break; + } + if (process.ExitCode != 0) + { + failures.Add(new ProjectRestoreFailure( + Path.GetFileNameWithoutExtension(entry.RelativePath), + entry.RelativePath, + RestorePolicy.ExtractRestoreErrors(stderrDrain.GetAwaiter().GetResult()) + .Replace(" Restore output: ", "").Trim())); + } + } + catch (RestorePendingException) + { + throw; + } + catch (Exception ex) + { + Console.Error.WriteLine( + $"[INFO] per-project restore could not start for '{entry.RelativePath}' " + + $"({ex.GetType().Name}: {ex.Message})."); + failures.Add(new ProjectRestoreFailure( + Path.GetFileNameWithoutExtension(entry.RelativePath), + entry.RelativePath, + $"could not start ({ex.GetType().Name})")); + } + } + return failures; + } + // ── Solution filtering ─────────────────────────────────────────── /// @@ -347,7 +814,10 @@ private static MSBuildWorkspace CreateTolerantWorkspace() /// If the filtered solution still fails to load (e.g. BuildHost crash), falls /// back to loading individual .csproj files from the solution. /// - private static async Task OpenSolutionFilteredAsync(MSBuildWorkspace workspace, string solutionPath) + private static async Task OpenSolutionFilteredAsync( + MSBuildWorkspace workspace, + string solutionPath, + bool gateRestorePending = true) { var solutionDir = Path.GetDirectoryName(solutionPath) ?? "."; var lines = await File.ReadAllLinesAsync(solutionPath).ConfigureAwait(false); @@ -364,21 +834,102 @@ private static async Task OpenSolutionFilteredAsync(MSBuildWorkspace workspace, .Where(p => UnsupportedProjectExtensions.Contains(Path.GetExtension(p.RelativePath))) .ToList(); + // End-of-life frameworks (netcoreapp 1–3): a modern SDK builds them, + // but the design-time load cannot resolve their reference assemblies + // and every type use cascades into CS0518 — tool-side noise, not code + // health. Skipped with an [INFO] note; never restored (we will not + // compile them). + var loadable = new List<(int LineIndex, string RelativePath)>(); + var eolSkipped = new List<(int LineIndex, string RelativePath, string Tfm)>(); + foreach (var entry in supported) + { + var projectPath = Path.GetFullPath(Path.Combine(solutionDir, entry.RelativePath)); + string? tfm = null; + try + { + if (File.Exists(projectPath)) + { + tfm = SkippedFrameworks.ExtractFromProjectText(File.ReadAllText(projectPath)); + } + } + catch (Exception) + { + // Unreadable csproj: let the workspace load surface the real + // problem instead of guessing here. + } + if (tfm is not null && SkippedFrameworks.IsEndOfLife(tfm)) + { + eolSkipped.Add((entry.LineIndex, entry.RelativePath, tfm)); + } + else + { + loadable.Add(entry); + } + } + if (eolSkipped.Count > 0) + { + Console.Error.WriteLine( + $"[INFO] Skipping {eolSkipped.Count} project(s) with end-of-life frameworks " + + $"(not indexed): {string.Join(", ", eolSkipped.Select(e => $"{e.RelativePath} ({e.Tfm})"))}"); + } + + // Restore only when the evidence says assets are missing or stale: the + // design-time build below does not restore, and missing package assets + // cascade into CS0246 noise that would otherwise pin the repo's index + // warning. But restoring on every reindex is far too heavy for + // multi-repo hubs — fresh assets mean no restore at all. + // + // Gate: while a restore is in flight, gated commands (index, + // find-refs, batch-find-refs) refuse to load the workspace at all, so + // no index or cached find-refs answer can ever be produced from a + // solution loaded mid-restore. Serve passes gateRestorePending: false + // — a resident process must keep answering from the existing index. + if (gateRestorePending) + { + RestoreGate.ThrowIfRestorePending(solutionPath); + } + var restoreFailures = new List(); + if (RestorePolicy.NeedsRestore(loadable.Select(p => p.RelativePath), solutionDir)) + { + restoreFailures = RestoreSolution(solutionPath, gateRestorePending, loadable); + } + + // Restore-failed projects fall in two classes: with usable existing + // assets they are indexed as usual — their compile diagnostics are + // code-health ([INFO], never the warning icon); without any assets + // there is nothing to compile against and they are excluded outright. + var noAssets = restoreFailures + .Where(f => !RestorePolicy.HasUsableAssets(f.RelativePath, solutionDir)) + .ToList(); + if (noAssets.Count > 0) + { + Console.Error.WriteLine( + $"[INFO] Excluding {noAssets.Count} project(s) with no usable package assets " + + $"(not indexed): {string.Join(", ", noAssets.Select(f => f.RelativePath))}"); + } + // Log skipped projects foreach (var skip in unsupported) { Console.Error.WriteLine($"[INFO] Skipping unsupported project type: {skip.RelativePath}"); } - if (supported.Count == 0) + if (loadable.Count == noAssets.Count) { throw new InvalidOperationException( - $"Solution contains no supported project types " + - $"(found {unsupported.Count} unsupported: {string.Join(", ", unsupported.Select(u => u.RelativePath))})"); + $"No project of the solution can be indexed " + + $"({noAssets.Count} failed restore with no existing assets, " + + $"{eolSkipped.Count} end-of-life frameworks, {unsupported.Count} unsupported types)"); } - // Try opening the filtered solution first - var skipIndices = unsupported.Select(u => u.LineIndex).ToHashSet(); + // Try opening the filtered solution first: unsupported types, + // end-of-life frameworks and restore-failed projects without assets + // are all excluded — the workspace must never see them. + var excludedPaths = noAssets.Select(f => f.RelativePath).ToHashSet(StringComparer.OrdinalIgnoreCase); + var skipIndices = unsupported.Select(u => u.LineIndex) + .Concat(eolSkipped.Select(e => e.LineIndex)) + .Concat(loadable.Where(l => excludedPaths.Contains(l.RelativePath)).Select(l => l.LineIndex)) + .ToHashSet(); var filteredContent = BuildFilteredSolution(lines, skipIndices); var tempSlnName = $"{Path.GetFileNameWithoutExtension(solutionPath)}-filtered-{Guid.NewGuid():N}.sln"; var tempSlnPath = Path.Combine(solutionDir, tempSlnName); @@ -392,23 +943,30 @@ private static async Task OpenSolutionFilteredAsync(MSBuildWorkspace workspace, } catch (Exception ex) { + var level = WorkspaceNoise.IsBuildHostTypeInitializerCrash(ex.Message) ? "INFO" : "WARN"; Console.Error.WriteLine( - $"[WARN] Filtered solution still failed ({ex.GetType().Name}: {ex.Message}); " + - $"falling back to loading {supported.Count} individual .csproj files."); + $"[{level}] Filtered solution still failed ({ex.GetType().Name}: {ex.Message}); " + + $"falling back to loading {loadable.Count - noAssets.Count} individual .csproj files."); } finally { try { File.Delete(tempSlnPath); } catch { /* best effort */ } } - // Fallback: open each supported .csproj individually. + // Fallback: open each loadable .csproj individually (never the EOL or + // no-assets exclusions — the workspace must not see them here either). // CloseSolution() clears any partially-loaded projects from the failed solution attempt. workspace.CloseSolution(); var loaded = 0; - foreach (var entry in supported) + foreach (var entry in loadable) { var csprojPath = Path.GetFullPath(Path.Combine(solutionDir, entry.RelativePath)); + if (excludedPaths.Contains(entry.RelativePath)) + { + continue; + } + // Defense-in-depth: verify containment even though parsing already validates. if (!IsPathWithinRoot(csprojPath, solutionDir)) { @@ -423,6 +981,15 @@ private static async Task OpenSolutionFilteredAsync(MSBuildWorkspace workspace, continue; } + // OpenProjectAsync also loads the project's ProjectReferences; re-opening + // one of them throws "already part of the workspace". + if (workspace.CurrentSolution.Projects.Any(p => + string.Equals(p.FilePath, csprojPath, StringComparison.OrdinalIgnoreCase))) + { + loaded++; + continue; + } + try { await workspace.OpenProjectAsync(csprojPath).ConfigureAwait(false); @@ -430,8 +997,9 @@ private static async Task OpenSolutionFilteredAsync(MSBuildWorkspace workspace, } catch (Exception ex) { + var level = WorkspaceNoise.IsBuildHostTypeInitializerCrash(ex.Message) ? "INFO" : "WARN"; Console.Error.WriteLine( - $"[WARN] Failed to load project '{entry.RelativePath}': {ex.GetType().Name}: {ex.Message}"); + $"[{level}] Failed to load project '{entry.RelativePath}': {ex.GetType().Name}: {ex.Message}"); } } @@ -567,10 +1135,19 @@ private static string BuildFilteredSolution(string[] lines, HashSet skipLin // ── MSBuild registration ───────────────────────────────────────── /// - /// Register the highest available MSBuild instance. - /// Returns true on success; sets on failure. + /// Register the MSBuild instance the workspace will evaluate through. + /// Capability-aware since the 2026-10-15 net10 incident: when every + /// CLI-visible .NET SDK is older than the repo's target frameworks + /// (raw TargetFramework scan + global.json floor via + /// ), an SDK instance + /// would fail every project with NETSDK1045 during evaluation — in that + /// case the highest VS instance wins instead, because VS bundles its own + /// SDK targets and can evaluate TFMs the CLI cannot. Returns true on + /// success; sets on failure. /// - private static bool TryRegisterMsBuild([System.Diagnostics.CodeAnalysis.NotNullWhen(false)] out string? errorMessage) + private static bool TryRegisterMsBuild( + string? solutionPath, + [System.Diagnostics.CodeAnalysis.NotNullWhen(false)] out string? errorMessage) { // Guard against double-registration in case the function is ever called twice // in the same process lifetime (e.g. future test harnesses, daemon mode). @@ -597,10 +1174,22 @@ private static bool TryRegisterMsBuild([System.Diagnostics.CodeAnalysis.NotNullW // Prefer .NET SDK instances over Visual Studio instances. // The VS BuildHost (net472) crashes with TypeInitializationException - // when loading solutions that contain certain project types. - var sdkInstance = instances - .FirstOrDefault(i => i.DiscoveryType == DiscoveryType.DotNetSdk); - var instance = sdkInstance ?? instances.OrderByDescending(i => i.Version).First(); + // when loading solutions that contain certain project types — so the + // VS instance is only chosen when no SDK instance can even target + // the repo (certain NETSDK1045 load failure either way). + var requiredMajor = MsbuildRestore.RequiredSdkMajorFloor(solutionPath); + var candidates = instances + .Select(i => new MsbuildCandidate(i.Version, i.DiscoveryType == DiscoveryType.DotNetSdk)) + .ToList(); + var (index, isSdk) = MsbuildRestore.ChooseMsBuildInstance(candidates, requiredMajor); + var instance = instances[index]; + if (!isSdk) + { + Console.Error.WriteLine( + $"[INFO] no CLI .NET SDK instance can target net{requiredMajor} projects of " + + $"'{solutionPath}' — registering the VS MSBuild '{instance.Name}' v{instance.Version} " + + "instead (VS-bundled SDK targets)."); + } Console.Error.WriteLine( $"MSBuild: registering '{instance.Name}' v{instance.Version} at {instance.MSBuildPath}"); diff --git a/helpers/csharp/ReferenceResolver.cs b/helpers/csharp/ReferenceResolver.cs index 65a96e0a..8927cf38 100644 --- a/helpers/csharp/ReferenceResolver.cs +++ b/helpers/csharp/ReferenceResolver.cs @@ -103,7 +103,10 @@ public async Task BatchFindRefsAsync(Solution solution, IRe Console.Error.WriteLine("find-refs: building symbol map from solution..."); foreach (var project in solution.Projects) { - var compilation = await project.GetCompilationAsync().ConfigureAwait(false); + // Same generator run as indexing: without it, Razor-generated + // component types are missing from the map and every reference + // inside them resolves to nothing. + var (compilation, _) = await GeneratorSupport.GetCompilationWithGeneratorsAsync(project).ConfigureAwait(false); if (compilation is null) { Console.Error.WriteLine($"[WARN] find-refs: could not compile {project.Name}"); @@ -133,6 +136,36 @@ public async Task BatchFindRefsAsync(Solution solution, IRe return null; } + /// + /// Picks the workspace counterpart of among the + /// similar-symbol candidates: the exact signature match wins (the first + /// candidate may be another overload), a lone candidate is accepted, and + /// anything else returns with + /// set. + /// + internal static ISymbol PickWorkspaceSymbol(ISymbol target, IEnumerable similar, out bool fellBack) + { + var candidates = similar.ToList(); + var signature = target.ToDisplayString(SymbolDisplayFormat.CSharpErrorMessageFormat); + + var exact = candidates.FirstOrDefault(c => + c.ToDisplayString(SymbolDisplayFormat.CSharpErrorMessageFormat) == signature); + if (exact is not null) + { + fellBack = false; + return exact; + } + + if (candidates.Count == 1) + { + fellBack = false; + return candidates[0]; + } + + fellBack = true; + return target; + } + /// /// Resolves references for one symbol. Returns the occurrences plus a /// warning per survived failure — a caught FindReferencesAsync exception @@ -146,8 +179,48 @@ public async Task BatchFindRefsAsync(Solution solution, IRe try { + // The symbol map is built from detached generator-augmented + // compilations. For Razor component types SymbolFinder cannot + // pair such a foreign symbol with its workspace counterpart and + // returns instantly with nothing (observed live: a code-behind + // method of a Blazor component answered 0 references in ~3ms + // while the calls were visible to text search). Re-resolve the + // symbol inside the containing project's workspace compilation + // first; fall back to the foreign symbol when no counterpart + // exists. Multi-target projects share an AssemblyName, so every + // matching project is tried until one yields a counterpart. + var workspaceSymbol = targetSymbol; + var resolved = false; + var assemblyName = targetSymbol.ContainingAssembly?.Name; + foreach (var project in solution.Projects) + { + if (!string.Equals(project.AssemblyName, assemblyName, StringComparison.OrdinalIgnoreCase)) + continue; + + var compilation = await project.GetCompilationAsync().ConfigureAwait(false); + if (compilation is null) + continue; + + var picked = PickWorkspaceSymbol( + targetSymbol, + SymbolFinder.FindSimilarSymbols(targetSymbol, compilation), + out var fellBack); + if (fellBack) + continue; + + workspaceSymbol = picked; + resolved = true; + break; + } + + if (!resolved) + { + Console.Error.WriteLine( + $"[INFO] No workspace counterpart for {targetSymbol.Name}; resolving references with the detached symbol"); + } + var refResults = await SymbolFinder - .FindReferencesAsync(targetSymbol, solution) + .FindReferencesAsync(workspaceSymbol, solution) .ConfigureAwait(false); foreach (var refLocation in refResults.SelectMany(r => r.Locations)) diff --git a/helpers/csharp/RestoreGate.cs b/helpers/csharp/RestoreGate.cs new file mode 100644 index 00000000..87c50364 --- /dev/null +++ b/helpers/csharp/RestoreGate.cs @@ -0,0 +1,169 @@ +using System.Diagnostics; +using System.Security.Cryptography; +using System.Text; +using System.Text.Json; + +namespace ScipCsharp; + +/// Process exit codes beyond the generic 0/1. +internal static class ExitCodes +{ + /// + /// A dotnet restore for this solution is still running (or its + /// marker says so): no index was built and no output file was written. + /// The Rust host maps this to a restore-pending outcome, never a generic + /// error (issue #225). + /// + public const int RestorePending = 75; +} + +/// +/// Thrown when a gated command (index, find-refs, batch-find-refs) must not +/// load the workspace because a restore is in flight — building a degraded +/// index now would store CS0246 noise into LMDB while the previous good index +/// could have stayed live. +/// +internal sealed class RestorePendingException : Exception +{ + public RestorePendingException() + : base("restore pending — workspace load refused (issue #225)") + { + } +} + +/// +/// The gate decision for one workspace load: an ACTIVE restore marker for +/// this solution refuses the load with +/// — a degraded index built while +/// restore is in flight would poison LMDB while the previous good index +/// could have stayed live. A stale marker is deleted by the liveness check +/// and the load proceeds. Serve mode never calls this: a resident process +/// must keep answering from its existing workspace. +/// +internal static class RestoreGate +{ + public static void ThrowIfRestorePending(string solutionPath) + { + if (RestorePendingMarker.IsActive(solutionPath)) + { + Console.Error.WriteLine( + "[RESTORE-PENDING] a dotnet restore for this solution is already running — " + + $"exiting {ExitCodes.RestorePending} without building an index; retry when it finishes."); + throw new RestorePendingException(); + } + } + + /// + /// Serve-startup refusal: returns + /// when a restore is in flight, so + /// the resident pool falls back to the one-shot path — a workspace loaded + /// mid-restore would have its find-refs answers CACHED by the host. Null + /// when the load may proceed. Exit-code form instead of throwing: a + /// resident process reports refusal as its exit status. + /// + public static int? ServeStartupPendingExit(string solutionPath) + { + if (RestorePendingMarker.IsActive(solutionPath)) + { + Console.Error.WriteLine( + "[RESTORE-PENDING] a dotnet restore for this solution is already running — " + + "serve refuses to load the workspace; the pool will retry once it finishes."); + return ExitCodes.RestorePending; + } + return null; + } +} + +/// +/// Marker outside the repo recording a still-running dotnet restore: +/// %TEMP%/codesearch-restore/<sha256(solution path)>.json. A +/// later gated run that sees an ACTIVE marker (pid alive with the recorded +/// start time) exits immediately +/// instead of starting a second restore; a stale one (restore finished or +/// died — pid reuse is caught by the start-time match) is deleted and the run +/// proceeds normally. +/// +internal static class RestorePendingMarker +{ + private static string MarkerDirectory => + Path.Combine(Path.GetTempPath(), "codesearch-restore"); + + private static string MarkerPath(string solutionPath) + { + // Upper-cased so the same solution reached through different drive + // casing maps to one marker on case-insensitive filesystems. + var normalized = Path.GetFullPath(solutionPath).ToUpperInvariant(); + var hash = SHA256.HashData(Encoding.UTF8.GetBytes(normalized)); + return Path.Combine(MarkerDirectory, Convert.ToHexString(hash) + ".json"); + } + + public static void Write(string solutionPath, int pid, DateTime startedUtc) + { + Directory.CreateDirectory(MarkerDirectory); + var payload = JsonSerializer.Serialize(new MarkerPayload(pid, startedUtc)); + File.WriteAllText(MarkerPath(solutionPath), payload); + } + + /// + /// True when the recorded restore process is still alive with the + /// recorded start time. Any other outcome (missing, corrupt, dead pid, + /// start-time mismatch) deletes the marker and returns false. + /// + public static bool IsActive(string solutionPath) + { + var path = MarkerPath(solutionPath); + try + { + if (!File.Exists(path)) + { + return false; + } + var payload = JsonSerializer.Deserialize(File.ReadAllText(path)); + if (payload is not null && IsProcessAlive(payload.Pid, payload.StartedUtc)) + { + return true; + } + } + catch (Exception ex) + { + Console.Error.WriteLine( + $"[INFO] restore marker unreadable ({ex.GetType().Name}: {ex.Message}) — treating as stale."); + } + TryDelete(path); + return false; + } + + public static void Delete(string solutionPath) => TryDelete(MarkerPath(solutionPath)); + + private static void TryDelete(string path) + { + try + { + File.Delete(path); + } + catch + { + // Best effort: a marker that survives cleanup only costs one + // extra restore-pending exit on the next run, which re-checks. + } + } + + private static bool IsProcessAlive(int pid, DateTime startedUtc) + { + try + { + using var process = Process.GetProcessById(pid); + // Tolerance absorbs StartTime precision differences across + // platforms (/proc-based times are second-granular on Linux). + return Math.Abs((process.StartTime.ToUniversalTime() - startedUtc).TotalSeconds) < 5; + } + catch (Exception ex) when ( + ex is ArgumentException or InvalidOperationException + or System.ComponentModel.Win32Exception) + { + return false; + } + } + + private sealed record MarkerPayload(int Pid, DateTime StartedUtc); +} diff --git a/helpers/csharp/RestorePolicy.cs b/helpers/csharp/RestorePolicy.cs new file mode 100644 index 00000000..2266c1f2 --- /dev/null +++ b/helpers/csharp/RestorePolicy.cs @@ -0,0 +1,257 @@ +using System.Diagnostics; + +namespace ScipCsharp; + +/// +/// Restore policy for the design-time workspace load: MSBuildWorkspace does +/// not restore, but running dotnet restore on every reindex is far too +/// heavy for multi-repo hubs. Restore only when the evidence says assets are +/// missing or stale. Compiled into both scip-csharp and the test project via +/// a linked Compile item (same pattern as WorkspaceLoad.cs). +/// +/// +/// File names whose change invalidates NuGet restore state even though no +/// .csproj changed: under central package management versions live in +/// Directory.Packages.props, and MSBuild/NuGet import the rest from parent +/// directories. Compared case-insensitively. +/// +public static class RestoreInputs +{ + public const string PackagesProps = "Directory.Packages.props"; + public const string BuildProps = "Directory.Build.props"; + public const string BuildTargets = "Directory.Build.targets"; + public const string NuGetConfig = "NuGet.config"; + public const string GlobalJson = "global.json"; + public const string PackagesLock = "packages.lock.json"; + + public static readonly string[] FileNames = + { + PackagesProps, BuildProps, BuildTargets, NuGetConfig, GlobalJson, + // Fork delta (Nexartis/codesearch 237a73c, P2): the per-project NuGet + // lock file is a restore input too; a lock-file-only change must + // invalidate the asset graph. + PackagesLock, + }; +} + +/// +/// End-of-life netcoreapp frameworks: a modern SDK can still build +/// them, but the design-time workspace load cannot resolve their reference +/// assemblies, and every type use cascades into CS0518 ("System.Object is +/// not defined") — a tool-side gap, not a code-health signal. Projects +/// targeting one of these prefixes are skipped with an [INFO] note instead +/// of being compiled into warning noise. Compared case-insensitively; +/// netstandard2.0 libraries are deliberately NOT skipped (legitimately +/// modern) and neither is anything on the supported net line. +/// +public static class SkippedFrameworks +{ + public static readonly string[] EndOfLifePrefixes = + { + "netcoreapp1", "netcoreapp2", "netcoreapp3", + }; + + public static bool IsEndOfLife(string targetFramework) + { + var tfm = targetFramework.Trim(); + foreach (var prefix in EndOfLifePrefixes) + { + if (tfm.StartsWith(prefix, StringComparison.OrdinalIgnoreCase)) + { + return true; + } + } + return false; + } + + /// + /// The first target framework from raw .csproj text — best effort: + /// conditional property groups are not evaluated, which is fine for a + /// skip-guard (a project whose FIRST target is EOL is exactly the one + /// whose load would cascade). + /// + public static string? ExtractFromProjectText(string projectText) + { + var match = System.Text.RegularExpressions.Regex.Match( + projectText, @"([^<]+)Env override for the restore kill timeout, in seconds. + public const string TimeoutEnvName = "CODESEARCH_RESTORE_TIMEOUT_SECS"; + private const string RestoreTimeoutEnv = TimeoutEnvName; + private const int DefaultRestoreTimeoutSeconds = 300; + + /// + /// True when at least one project lacks obj/project.assets.json, has + /// one older than its .csproj, or has one older than ANY restore input + /// () found walking up from the project dir to + /// the solution dir and the repo root. False means every project has fresh + /// assets and restore can be skipped entirely — the steady state of an + /// actively developed repo. + /// + public static bool NeedsRestore(IEnumerable projectRelativePaths, string solutionDir) + { + var walkRoot = FindWalkRoot(solutionDir); + foreach (var relative in projectRelativePaths) + { + var projectPath = ResolveProjectPath(solutionDir, relative); + var projectDir = Path.GetDirectoryName(projectPath) ?? solutionDir; + var assetsPath = Path.Combine(projectDir, "obj", "project.assets.json"); + if (!File.Exists(assetsPath)) + { + return true; + } + var assetsTime = File.GetLastWriteTimeUtc(assetsPath); + if (File.GetLastWriteTimeUtc(projectPath) > assetsTime) + { + return true; + } + if (AnyRestoreInputNewerThan(projectDir, walkRoot, assetsTime)) + { + return true; + } + } + return false; + } + + /// + /// The highest directory restore inputs are collected from: the repo root + /// when one sits at or above the solution dir (inputs above the solution + /// dir still apply to it), otherwise the solution dir itself. + /// + private static string FindWalkRoot(string solutionDir) + { + var dir = Path.GetFullPath(solutionDir); + while (true) + { + if (Directory.Exists(Path.Combine(dir, ".git")) || File.Exists(Path.Combine(dir, ".git"))) + { + return dir; + } + var parent = Directory.GetParent(dir)?.FullName; + if (string.IsNullOrEmpty(parent) || PathsEqual(parent, dir)) + { + return Path.GetFullPath(solutionDir); + } + dir = parent; + } + } + + private static bool AnyRestoreInputNewerThan(string startDir, string walkRoot, DateTime assetsTime) + { + var dir = Path.GetFullPath(startDir); + while (true) + { + // Enumerate + compare case-insensitively instead of File.Exists + // probes: NuGet honours e.g. lowercase nuget.config on + // case-sensitive filesystems where an exact-case probe misses it. + foreach (var file in Directory.GetFiles(dir)) + { + var fileName = Path.GetFileName(file); + if (RestoreInputs.FileNames.Contains(fileName, StringComparer.OrdinalIgnoreCase) + && File.GetLastWriteTimeUtc(file) > assetsTime) + { + return true; + } + } + if (PathsEqual(dir, walkRoot)) + { + return false; + } + var parent = Directory.GetParent(dir)?.FullName; + if (string.IsNullOrEmpty(parent) || PathsEqual(parent, dir)) + { + return false; + } + dir = parent; + } + } + + /// + /// True when the project has an obj/project.assets.json at all: + /// after a FAILED restore this distinguishes "restore-failed but usable + /// existing assets" (index it; its compile errors are restore-caused) + /// from "nothing to compile against" (exclude the project entirely). + /// + public static bool HasUsableAssets(string projectRelativePath, string solutionDir) + { + var projectPath = ResolveProjectPath(solutionDir, projectRelativePath); + var projectDir = Path.GetDirectoryName(projectPath) ?? solutionDir; + return File.Exists(Path.Combine(projectDir, "obj", "project.assets.json")); + } + + // MSBuild/Windows paths use backslashes; on non-Windows '\' is an ordinary filename char. + private static string ResolveProjectPath(string solutionDir, string relative) => + Path.GetFullPath(Path.Combine(solutionDir, relative.Replace('\\', Path.DirectorySeparatorChar))); + + private static bool PathsEqual(string left, string right) => + string.Equals( + Path.GetFullPath(left).TrimEnd(Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar), + Path.GetFullPath(right).TrimEnd(Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar), + StringComparison.OrdinalIgnoreCase); + + /// + /// The diagnostic kernel of a failed restore — up to three "error" lines + /// (NU11xx feed/resolution failures tell the operator WHAT to fix, e.g. + /// an unreachable private feed), each capped at 160 chars, joined for the + /// single [WARN] line. The restore's own output is otherwise discarded. + /// + public static string ExtractRestoreErrors(string restoreOutput) + { + if (string.IsNullOrWhiteSpace(restoreOutput)) + { + return string.Empty; + } + var errors = restoreOutput + .Split('\n') + .Select(l => l.TrimEnd('\r')) + .Where(l => l.Contains("error", StringComparison.OrdinalIgnoreCase)) + .Select(l => l.Length > 160 ? l[..157] + "..." : l) + .Take(3) + .ToList(); + return errors.Count == 0 + ? string.Empty + : " Restore output: " + string.Join(" | ", errors); + } + + /// + /// Restore wait timeout in seconds: CODESEARCH_RESTORE_TIMEOUT_SECS + /// when set to a positive integer, otherwise 300. Unparseable values fall + /// back to the default rather than failing the load. + /// + public static int RestoreTimeoutSeconds() + { + var raw = Environment.GetEnvironmentVariable(RestoreTimeoutEnv); + if (int.TryParse(raw, out var seconds) && seconds > 0) + { + return seconds; + } + return DefaultRestoreTimeoutSeconds; + } + + /// + /// The line emitted when the bounded wait expires while a restore is + /// still running — serve mode only: gated commands exit + /// instead. The restore is NOT + /// killed: it keeps running in the background (the child outlives this + /// helper), serve keeps answering from the existing workspace, and any + /// later index/find-refs run is gated by the restore marker until the + /// fresh assets land. INFO, never WARN: restore state must not drive the + /// caller-facing warning icon. Pinned by test so a "killed" wording + /// cannot sneak back in. names the restore + /// flavor still running (dotnet restore, or the VS MSBuild fallback). + /// + public static string StillRunningWarning(int seconds, string tool = "dotnet restore") => + $"[INFO] {tool} still running after {seconds}s — serve keeps answering from the " + + "existing workspace (degraded symbols) while restore continues in the background; " + + "index and find-refs runs are gated until it finishes and the next reindex picks up " + + $"the fresh assets. Raise with {TimeoutEnvName} if this solution legitimately needs longer."; +} diff --git a/helpers/csharp/SymbolIndexer.cs b/helpers/csharp/SymbolIndexer.cs index 8a49e4e9..44fd472b 100644 --- a/helpers/csharp/SymbolIndexer.cs +++ b/helpers/csharp/SymbolIndexer.cs @@ -10,7 +10,9 @@ namespace ScipCsharp; /// public sealed class SymbolIndexer { - public async Task IndexAsync(MSBuildWorkspace workspace, string? projectFilter) + public async Task IndexAsync( + MSBuildWorkspace workspace, + string? projectFilter) { var index = new ScipIndex(); var solution = workspace.CurrentSolution; @@ -48,28 +50,53 @@ public async Task IndexAsync(MSBuildWorkspace workspace, string? proj Console.Error.WriteLine($"Compiling {totalProjects} project(s)..."); var compileSw = System.Diagnostics.Stopwatch.StartNew(); + // (error count, summary line) per erroring project — emitted after + // the loop, loudest first, so the warnings-channel cap can never + // crowd out the worst project: that is the one the user needs named. + var erroringProjects = new List<(int Count, string Line)>(); for (int i = 0; i < totalProjects; i++) { var project = projectList[i]; Console.Error.WriteLine($" [{i + 1}/{totalProjects}] Compiling: {project.Name}"); - var compilation = await project.GetCompilationAsync().ConfigureAwait(false); + var (compilation, _) = + await GeneratorSupport.GetCompilationWithGeneratorsAsync(project).ConfigureAwait(false); if (compilation is null) { Console.Error.WriteLine($"[WARN] Could not compile project: {project.Name}"); continue; } - // Report diagnostics but don't abort + // Report diagnostics but don't abort. A single broken reference + // resolution cascades into tens of thousands of errors per + // project (CS0518 "System.Object not defined" turns every type + // use into CS0246) — that is ONE root cause, not N problems, so + // the log carries ONE aggregated line per project (count + + // dominant code + first specimen). Symbols below are still + // collected: a Roslyn compilation with errors yields a complete + // symbol tree — the same reason IntelliSense works while the + // build is red. var diagnostics = compilation.GetDiagnostics() - .Where(d => d.Severity == DiagnosticSeverity.Error); - foreach (var diag in diagnostics) + .Where(d => d.Severity == DiagnosticSeverity.Error) + .ToList(); + if (diagnostics.Count > 0) { - Console.Error.WriteLine($"[WARN] Compilation error in {project.Name}: {diag}"); + // Compile diagnostics are ALWAYS [INFO]: the project loaded + // and its symbol tree is complete, so nothing here means + // "find_impact may miss symbols" — they are code-health, and + // the index-warning channel is index-health only. Generator + // failures and restore-caused diagnostics were already + // [INFO]; by this rule every compile summary is. + erroringProjects.Add((diagnostics.Count, + WarningLineFor(project.Name, diagnostics))); } CollectSymbols(compilation.GlobalNamespace, symbolMap); } compileSw.Stop(); + foreach (var (_, line) in erroringProjects.OrderByDescending(e => e.Count)) + { + Console.Error.WriteLine(line); + } Console.Error.WriteLine($"Compiled {totalProjects} project(s) in {compileSw.Elapsed.TotalSeconds:F1}s"); Console.Error.WriteLine($"Collected {symbolMap.Count} project-internal symbols — building definition index..."); @@ -130,6 +157,45 @@ public async Task IndexAsync(MSBuildWorkspace workspace, string? proj return index; } + /// One-line aggregation of a project's compilation errors for the + /// index-level warnings channel: count, dominant error code, first + /// specimen (capped — the full diagnostic can run very long). Wrapped + /// with the [WARN] marker the Rust capture keys on by + /// . One broken reference resolution + /// cascades into tens of thousands of diagnostics; the channel must + /// carry the root cause, not the cascade. + /// + internal static string CompilationErrorSummaryLine( + string project, IReadOnlyList errors) + { + var byCode = errors.GroupBy(d => d.Id) + .OrderByDescending(g => g.Count()).ToList(); + var first = errors[0].ToString(); + const int MaxSpecimenChars = 160; + if (first.Length > MaxSpecimenChars) + { + // Cut at the last whitespace inside the budget: a hard cut lands + // mid-identifier (e.g. inside the quoted CS0103 name) and makes + // the specimen useless for pinpointing the symbol. A single token + // longer than the budget still takes the hard cap. + var cut = first.LastIndexOf(' ', MaxSpecimenChars); + first = (cut > 0 ? first[..cut] : first[..MaxSpecimenChars]) + "…"; + } + return + $"Compilation errors in {project}: {errors.Count} error(s) — dominant " + + $"{byCode[0].Key} x{byCode[0].Count()}; first: {first}"; + } + + /// The channel-emittable form. The prefix is `[INFO] ` BY DESIGN: the + /// Rust capture (`is_helper_warning_line`) keys on `[WARN] `/`[Failure]`, + /// so compile summaries never enter the index-warnings channel — they + /// are code-health, and the index-warning channel is index-health only + /// (restore state, load failures). An accidentally-dropped prefix cannot + /// flood the channel; it would only vanish from the serve log. + /// + internal static string WarningLineFor(string project, IReadOnlyList errors) => + "[INFO] " + CompilationErrorSummaryLine(project, errors); + internal static void CollectSymbols(INamespaceSymbol ns, Dictionary map) { foreach (var child in ns.GetMembers()) diff --git a/helpers/csharp/WorkspaceLoad.cs b/helpers/csharp/WorkspaceLoad.cs new file mode 100644 index 00000000..e22dc096 --- /dev/null +++ b/helpers/csharp/WorkspaceLoad.cs @@ -0,0 +1,32 @@ +namespace ScipCsharp; + +/// +/// Global MSBuild properties for every workspace load. Non-negotiables: +/// DesignTimeBuild + SkipCompilerExecution and NO warnings-as-errors — a +/// repo that escalates warnings (own settings or Directory.Build.props) +/// would turn benign load-time diagnostics (the NU1603 version-unification +/// class) into MSBuild project-load failures, dropping the project — and +/// every cross-project reference to it — from the index. Everything else +/// about the project keeps its own settings; we only refuse the escalation. +/// Lives outside Program.cs so the test assembly can compile it in +/// (Program carries the Main entrypoint and is deliberately excluded there). +/// +internal static class WorkspaceLoad +{ + internal static System.Collections.Generic.Dictionary GlobalProperties() => new() + { + // Tell Roslyn to skip projects it cannot load instead of crashing. + { "BuildingInsideVisualStudio", "true" }, + // Design-time build: prevents auto-generated files in obj/ (e.g. + // .AssemblyAttributes.cs, .AssemblyInfo.cs) from being included as + // explicit Compile items. Without this, SDK-style projects produce + // duplicate Compile items (auto-include + obj/ generated), which + // causes MSBuildWorkspace to fail loading the project. + { "DesignTimeBuild", "true" }, + { "SkipCompilerExecution", "true" }, + // Warnings stay warnings during the load — never fatal (NU1603 etc.). + { "TreatWarningsAsErrors", "false" }, + { "WarningsAsErrors", "" }, + { "MSBuildTreatWarningsAsErrors", "false" }, + }; +} diff --git a/helpers/csharp/WorkspaceNoise.cs b/helpers/csharp/WorkspaceNoise.cs new file mode 100644 index 00000000..52177c60 --- /dev/null +++ b/helpers/csharp/WorkspaceNoise.cs @@ -0,0 +1,116 @@ +namespace ScipCsharp; + +using Microsoft.CodeAnalysis; + +/// +/// Classifies workspace-load noise that must not surface as index warnings. +/// Compiled into both scip-csharp and the test project via a linked Compile +/// item (same pattern as WorkspaceLoad.cs). +/// +internal static class WorkspaceNoise +{ + /// + /// The demoted emission for a failure-kind diagnostic that is noise, not + /// index degradation. Renders + /// — never the diagnostic itself: its ToString() prefixes + /// "[Failure] ", and the Rust capture keys on a substring match for + /// "[Failure]" anywhere in the line, which would pull the demoted note + /// right back into the stored index warnings. + /// + public static string DemotedNote(WorkspaceDiagnostic diagnostic) => + $"[INFO] Workspace note: {diagnostic.Message}"; + /// + /// True when a workspace-failure diagnostic is a NuGet audit advisory + /// ("Package 'X' has a known high severity vulnerability, ...") rather + /// than a load failure — emitting it would pin the repo's index warning + /// until the package is bumped, while the index itself is unaffected. + /// Pure and null-tolerant so it is unit-testable. + /// + public static bool IsNuGetAuditNoise(string? message) => + message is not null + && message.Contains("has a known", StringComparison.OrdinalIgnoreCase) + && message.Contains("vulnerability", StringComparison.OrdinalIgnoreCase); + + /// + /// True when a workspace-failure diagnostic is a NuGet package-version + /// mismatch ("Dependency specified was 'X (>= A)' but ended up with + /// 'X B'"): the affected project still loads and its symbol tree is + /// complete, so nothing here means "find-impact may miss symbols" — the + /// build owner settles the pin, and the index must not carry the noise. + /// Pure and null-tolerant so it is unit-testable. + /// + public static bool IsPackageVersionConflict(string? message) => + message is not null + && message.Contains("Dependency specified was", StringComparison.OrdinalIgnoreCase) + && message.Contains("ended up with", StringComparison.OrdinalIgnoreCase); + + /// + /// True when a workspace-failure diagnostic is an MSBuild check advisory + /// escalated to a "failure" (observed live: "Grpc.Net.ClientFactory + /// 2.63.0 or earlier could cause issues when used together with + /// Microsoft.Extensions.Http.Resilience. ... Consider using + /// Grpc.Net.ClientFactory 2.64.0 or later. To suppress the warning set + /// SuppressCheckGrpcNetClientFactoryVersion=true."). A package + /// compatibility recommendation for the product, not a load failure: + /// the project still loads and the index is unaffected. Pure and + /// null-tolerant so it is unit-testable. + /// + public static bool IsMsbuildCheckAdvisory(string? message) + { + if (message is null) + { + return false; + } + return message.Contains("could cause issues when used together with", StringComparison.OrdinalIgnoreCase) + || (message.Contains("To suppress the warning set", StringComparison.OrdinalIgnoreCase) + && message.Contains("Consider using", StringComparison.OrdinalIgnoreCase)); + } + + /// + /// True when a workspace-failure diagnostic is BuildHost crash AFTERMATH + /// (observed live: "[BuildHost PID 58740] Exception while shutting down + /// the BuildHost process." / "[BuildHost PID 58740] The BuildHost + /// process is not responding. Process output:"). These lines trail the + /// real failure, which surfaces separately (the load exception itself); + /// carrying them as warnings doubles the failure count without adding a + /// cause. Pure and null-tolerant so it is unit-testable. + /// + public static bool IsBuildHostShutdownChatter(string? message) + { + if (message is null) + { + return false; + } + return message.Contains("[BuildHost PID", StringComparison.OrdinalIgnoreCase) + && (message.Contains("Exception while shutting down", StringComparison.OrdinalIgnoreCase) + || message.Contains("not responding", StringComparison.OrdinalIgnoreCase)); + } + + /// + /// True when a restore or load diagnostic is a NuGet source that cannot + /// be reached or authenticated ("Unable to load the service index for + /// source ..."). A host environment problem, not a code defect; the + /// restore fallback already reports the affected projects. "Unable to + /// find package" is deliberately not matched: it means a package is + /// really missing and the project loads degraded. Pure and null-tolerant. + /// + public static bool IsNuGetSourceFailure(string? message) + { + if (message is null) + { + return false; + } + return message.Contains("Unable to load the service index for source", StringComparison.OrdinalIgnoreCase) + || message.Contains("Error occurred while getting package vulnerability data", StringComparison.OrdinalIgnoreCase); + } + + /// + /// True when a load failure is the MSBuild BuildHost's type initializer + /// crashing on Microsoft.Build.Shared.XMakeElements. The affected + /// project is still attempted by the per-project fallback; the crash is + /// tool-side and must not pin the index warning. Pure and null-tolerant. + /// + public static bool IsBuildHostTypeInitializerCrash(string? message) => + message is not null + && message.Contains("XMakeElements", StringComparison.OrdinalIgnoreCase); +} diff --git a/helpers/csharp/scip-csharp.csproj b/helpers/csharp/scip-csharp.csproj index 1dcfb8fa..6edfe676 100644 --- a/helpers/csharp/scip-csharp.csproj +++ b/helpers/csharp/scip-csharp.csproj @@ -7,6 +7,10 @@ enable scip-csharp ScipCsharp + + 1.5.32 true true diff --git a/helpers/csharp/tests/Fixtures/BlazorLib/BlazorLib.csproj b/helpers/csharp/tests/Fixtures/BlazorLib/BlazorLib.csproj new file mode 100644 index 00000000..c9a32e66 --- /dev/null +++ b/helpers/csharp/tests/Fixtures/BlazorLib/BlazorLib.csproj @@ -0,0 +1,13 @@ + + + + net10.0 + enable + enable + + + + + + + diff --git a/helpers/csharp/tests/Fixtures/BlazorLib/Components/Counter.razor b/helpers/csharp/tests/Fixtures/BlazorLib/Components/Counter.razor new file mode 100644 index 00000000..5a2b0cdc --- /dev/null +++ b/helpers/csharp/tests/Fixtures/BlazorLib/Components/Counter.razor @@ -0,0 +1,5 @@ +@code { + private int count = 0; + + private void Increment() => count++; +} diff --git a/helpers/csharp/tests/Fixtures/BlazorLib/Components/Counter.razor.cs b/helpers/csharp/tests/Fixtures/BlazorLib/Components/Counter.razor.cs new file mode 100644 index 00000000..72d4534e --- /dev/null +++ b/helpers/csharp/tests/Fixtures/BlazorLib/Components/Counter.razor.cs @@ -0,0 +1,15 @@ +namespace BlazorLib.Components; + +// The code-behind half of the partial: `count` and `Increment` live in the +// razor file and only come into existence once the Razor source generator +// has run — exactly the members that produced the false CS0103 cascade. +public partial class Counter +{ + public string Label => $"count: {count}"; + + public void BumpTwice() + { + Increment(); + Increment(); + } +} diff --git a/helpers/csharp/tests/GeneratorSupportTests.cs b/helpers/csharp/tests/GeneratorSupportTests.cs new file mode 100644 index 00000000..4603dca1 --- /dev/null +++ b/helpers/csharp/tests/GeneratorSupportTests.cs @@ -0,0 +1,115 @@ +using System.Diagnostics; +using Microsoft.Build.Locator; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.MSBuild; +using Xunit; +using ScipCsharp; + +namespace ScipCsharp.Tests; + +/// +/// Blazor end-to-end over a real MSBuild workspace: the Razor source generator +/// must run so the code-behind partial sees the @code members. Pins the false +/// "Compilation errors" CS0103 cascade that used to poison the index warnings +/// on every Razor project although `dotnet build` is clean. +/// +[Collection("msbuild-workspace")] +public class GeneratorSupportTests +{ + private static readonly object RegistrationLock = new(); + private static bool _msbuildRegistered; + + private static MSBuildWorkspace CreateWorkspace() + { + lock (RegistrationLock) + { + if (!_msbuildRegistered) + { + var instances = MSBuildLocator.QueryVisualStudioInstances().ToList(); + var sdk = instances.FirstOrDefault(i => i.DiscoveryType == DiscoveryType.DotNetSdk) + ?? instances.OrderByDescending(i => i.Version).First(); + MSBuildLocator.RegisterInstance(sdk); + Environment.SetEnvironmentVariable("MSBUILD_EXE_PATH", sdk.MSBuildPath); + _msbuildRegistered = true; + } + } + + return MSBuildWorkspace.Create(WorkspaceLoad.GlobalProperties()); + } + + private static async Task<(Project Project, MSBuildWorkspace Workspace)> OpenFixtureAsync() + { + var projectPath = Path.Combine(AppContext.BaseDirectory, "Fixtures", "BlazorLib", "BlazorLib.csproj"); + Assert.True(File.Exists(projectPath), $"fixture not copied to test output: {projectPath}"); + await RestoreFixtureIfNeededAsync(projectPath); + + var workspace = CreateWorkspace(); + // Design-time builds emit benign MSBuild warnings; surface, don't fail. + workspace.WorkspaceFailed += (_, e) => + Console.Error.WriteLine($"[INFO] test workspace: {e.Diagnostic.Message}"); + var project = await workspace.OpenProjectAsync(projectPath); + return (project, workspace); + } + + private static async Task RestoreFixtureIfNeededAsync(string projectPath) + { + var assets = Path.Combine(Path.GetDirectoryName(projectPath)!, "obj", "project.assets.json"); + if (File.Exists(assets)) + return; + + var psi = new ProcessStartInfo("dotnet", $"restore \"{projectPath}\"") + { + RedirectStandardOutput = true, + RedirectStandardError = true, + UseShellExecute = false, + CreateNoWindow = true, + }; + using var process = Process.Start(psi)!; + var stderrTask = process.StandardError.ReadToEndAsync(); + var stdoutTask = process.StandardOutput.ReadToEndAsync(); + if (!process.WaitForExit(180_000)) + { + process.Kill(entireProcessTree: true); + throw new InvalidOperationException($"dotnet restore timed out for {projectPath}"); + } + if (process.ExitCode != 0) + { + throw new InvalidOperationException( + $"dotnet restore failed for {projectPath}:\n{await stderrTask}"); + } + _ = await stdoutTask; + } + + [Fact] + public async Task BlazorFixture_GeneratorRunResolvesCodeBehindMembers() + { + var (project, workspace) = await OpenFixtureAsync(); + using var _ = workspace; + + // Ground truth first: on the plain compilation the code-behind cannot + // see the @code members — the exact defect this pins. If this assert + // ever fails, the fixture no longer reproduces the problem. + var plain = await project.GetCompilationAsync(); + Assert.NotNull(plain); + Assert.Contains(plain!.GetDiagnostics(), + d => d.Severity == DiagnosticSeverity.Error && d.Id == "CS0103"); + + var (compilation, outcome) = await GeneratorSupport.GetCompilationWithGeneratorsAsync(project); + Assert.Equal(GeneratorRunOutcome.Ran, outcome); + Assert.NotNull(compilation); + + var errors = compilation!.GetDiagnostics() + .Where(d => d.Severity == DiagnosticSeverity.Error) + .ToList(); + Assert.True(errors.Count == 0, + "expected zero compilation errors after the generator run, got: " + + string.Join(" | ", errors.Take(5).Select(e => e.ToString()))); + + // And the generated component type itself must be reachable through + // the same symbol walk the indexer uses (it used to be missing + // entirely, hiding every Razor component from the index). + var symbolMap = new Dictionary(SymbolEqualityComparer.Default); + SymbolIndexer.CollectSymbols(compilation.GlobalNamespace, symbolMap); + Assert.Contains(symbolMap.Keys.OfType(), t => t.Name == "Counter"); + } +} diff --git a/helpers/csharp/tests/IndexerTests.cs b/helpers/csharp/tests/IndexerTests.cs index fa4e93bb..09d5a912 100644 --- a/helpers/csharp/tests/IndexerTests.cs +++ b/helpers/csharp/tests/IndexerTests.cs @@ -1,4 +1,5 @@ using System.Text.Json; +using Microsoft.CodeAnalysis; using Xunit; using ScipCsharp; @@ -214,4 +215,105 @@ public void OutputWriter_ProducesValidJson() // Verify indented output (has newlines) Assert.Contains('\n', json); } + + /// + /// A broken reference resolution cascades into tens of thousands of + /// compilation errors per project (one missing assembly → every type use + /// errors). The warnings channel must carry ONE aggregated line per + /// project — count + dominant code + first specimen — not the cascade. + /// + [Fact] + public void CompilationErrorSummary_AggregatesCascadePerProject() + { + static Diagnostic Err(string id, string message) + { + var descriptor = new DiagnosticDescriptor( + id, title: message, messageFormat: message, category: "Test", + DiagnosticSeverity.Error, isEnabledByDefault: true); + return Diagnostic.Create(descriptor, Location.None); + } + + var errors = new List + { + Err("CS0518", "Predefined type 'System.Object' is not defined or referenced"), + Err("CS0518", "Predefined type 'System.Object' is not defined or referenced"), + Err("CS0246", "The type or namespace name 'Dam' could not be found"), + }; + + var line = SymbolIndexer.CompilationErrorSummaryLine("Acme.Catalog", errors); + + Assert.StartsWith("Compilation errors in Acme.Catalog:", line); + Assert.Contains("3 error(s)", line); + Assert.Contains("dominant CS0518 x2", line); + Assert.Contains("first:", line); + + // The channel-emittable form carries the [INFO] marker BY DESIGN: + // compile diagnostics are code-health (the symbol tree of a loaded + // project is complete) — the index-warning channel is index-health + // only, so the Rust capture must never see [WARN] here. + var warning = SymbolIndexer.WarningLineFor("Acme.Catalog", errors); + Assert.StartsWith("[INFO] Compilation errors in", warning); + Assert.False(warning.StartsWith("[WARN]", StringComparison.Ordinal)); + } + + /// The specimen is capped: a full Roslyn diagnostic string can run + /// hundreds of chars, and the warnings channel caps the whole list. + [Fact] + public void CompilationErrorSummary_CapsTheSpecimen() + { + var descriptor = new DiagnosticDescriptor( + "CS0001", title: new string('x', 400), messageFormat: new string('x', 400), + category: "Test", DiagnosticSeverity.Error, isEnabledByDefault: true); + var err = Diagnostic.Create(descriptor, Location.None); + + var line = SymbolIndexer.CompilationErrorSummaryLine("Proj", [err]); + + Assert.True(line.Length < 300, $"summary must be capped, got {line.Length} chars"); + Assert.Contains("…", line); + } + + /// The hard 160-char cut landed mid-identifier (inside the quoted CS0103 + /// name), producing unusable specimens. The cut must move to the last + /// whitespace inside the budget instead. + [Fact] + public void CompilationErrorSummary_TruncatesAtWhitespaceBoundary() + { + var filler = string.Join(" ", Enumerable.Range(0, 20).Select(i => $"w{i}")); + // 'The name ' starts at index 60; the quoted identifier spans + // [70, 270) — the old hard cap at 160 cut inside it. + var message = filler + " The name '" + new string('n', 200) + "' does not exist in the current context"; + var descriptor = new DiagnosticDescriptor( + "CS0103", title: message, messageFormat: message, + category: "Test", DiagnosticSeverity.Error, isEnabledByDefault: true); + var err = Diagnostic.Create(descriptor, Location.None); + + var line = SymbolIndexer.CompilationErrorSummaryLine("Proj", [err]); + + Assert.EndsWith("The name…", line); + Assert.DoesNotContain("nnnnnnnnnn…", line); + Assert.True(line.Length < 300, $"summary must stay capped, got {line.Length} chars"); + } + + /// The compile-summary contract: the summaries ALWAYS carry the [INFO] + /// marker — the Rust capture (`is_helper_warning_line`) files only + /// [WARN]/[Failure] as index warnings, so a compile summary can never + /// drive the warning icon, whatever the diagnostics are. + [Fact] + public void WarningLineFor_CarriesInfoPrefixNeverWarn() + { + static Diagnostic Err(string id, string message) + { + var descriptor = new DiagnosticDescriptor( + id, title: message, messageFormat: message, category: "Test", + DiagnosticSeverity.Error, isEnabledByDefault: true); + return Diagnostic.Create(descriptor, Location.None); + } + + var errors = new List { Err("CS0103", "The name 'count' does not exist") }; + + var line = SymbolIndexer.WarningLineFor("Proj", errors); + + Assert.StartsWith("[INFO] ", line); + Assert.DoesNotContain("[WARN]", line); + } } diff --git a/helpers/csharp/tests/MsbuildRestoreTests.cs b/helpers/csharp/tests/MsbuildRestoreTests.cs new file mode 100644 index 00000000..fb695a64 --- /dev/null +++ b/helpers/csharp/tests/MsbuildRestoreTests.cs @@ -0,0 +1,235 @@ +using ScipCsharp; +using Xunit; + +namespace ScipCsharp.Tests; + +/// +/// Unit tests for the VS-MSBuild restore fallback's pure logic: SDK- +/// resolution failure detection (the feature's trigger — pinned against +/// the exact host wordings seen live on 2026-10-15, incl. NETSDK1045 +/// printing to stdout), vswhere -find output parsing, the capability-aware +/// MSBuild instance choice, and the repo TFM floor scan. +/// +public class MsbuildRestoreTests : IDisposable +{ + private readonly string _root; + + public MsbuildRestoreTests() + { + _root = Path.Combine(Path.GetTempPath(), "cs-msbuild-restore-" + Guid.NewGuid().ToString("N")); + Directory.CreateDirectory(_root); + } + + public void Dispose() + { + Directory.Delete(_root, recursive: true); + } + + // ── IsSdkResolutionFailure ──────────────────────────────────────── + + [Fact] + public void Netsdk1045StdoutWordingTriggers() + { + // Verbatim shape of the live net99.0 probe output (stdout), the + // 2026-10-15 incident's failure mode. + var stdout = + "C:\\Program Files\\dotnet\\sdk\\8.0.425\\Sdks\\Microsoft.NET.Sdk\\targets\\" + + "Microsoft.NET.TargetFrameworkInference.targets(166,5): error NETSDK1045: " + + "The current .NET SDK does not support targeting .NET 10.0. Either target " + + ".NET 8.0 or lower, or use a version of the .NET SDK that supports .NET 10.0."; + + Assert.True(MsbuildRestore.IsSdkResolutionFailure(stdout)); + } + + [Theory] + [InlineData("A compatible .NET SDK was not found. Install or update the .NET SDK.")] // current host + [InlineData("A compatible installed .NET SDK for global.json at [C:\\repo\\global.json] was not found.")] // legacy host + public void GlobalJsonUnsatisfiableWordingsTriggerBothHostGenerations(string line) + { + Assert.True(MsbuildRestore.IsSdkResolutionFailure(line)); + } + + [Theory] + [InlineData("error NU1101: Unable to find package Vendor.Internal.Base. No packages exist with this id in source(s): private-feed.")] + [InlineData("App.Core.csproj: error NU1301: Unable to load the service index for source https://pkgs.dev.azure.com/org/_packaging/private-feed/nuget/v3/index.json.")] + [InlineData("")] + public void FeedAndAuthFailuresDoNotTrigger(string line) + { + // VS restores through the same NuGet stack — retrying those buys a + // second slow failure, so they must fall through to per-project. + Assert.False(MsbuildRestore.IsSdkResolutionFailure(line)); + } + + // ── ParseFirstVswherePath ───────────────────────────────────────── + + [Fact] + public void VswhereParsingSkipsBlankLines() + { + var output = "\r\nC:\\Program Files\\Microsoft Visual Studio\\18\\Professional\\MSBuild\\Current\\Bin\\MSBuild.exe\r\n\r\n"; + + Assert.Equal( + "C:\\Program Files\\Microsoft Visual Studio\\18\\Professional\\MSBuild\\Current\\Bin\\MSBuild.exe", + MsbuildRestore.ParseFirstVswherePath(output)); + } + + [Fact] + public void VswhereParsingEmptyOutputYieldsNull() + { + Assert.Null(MsbuildRestore.ParseFirstVswherePath("")); + } + + // ── ChooseMsBuildInstance ───────────────────────────────────────── + + private static MsbuildCandidate Sdk(int major) => new(new Version(major, 0), IsDotNetSdk: true); + + private static MsbuildCandidate Vs(int major) => new(new Version(major, 0), IsDotNetSdk: false); + + [Fact] + public void NoFloorKeepsHighestSdk() + { + var candidates = new[] { Sdk(8), Sdk(10), Vs(18) }; + + var (index, isSdk) = MsbuildRestore.ChooseMsBuildInstance(candidates, requiredMajor: null); + + Assert.Equal((1, true), (index, isSdk)); + } + + [Fact] + public void QualifyingSdkBeatsNewerVs() + { + var candidates = new[] { Sdk(10), Vs(18) }; + + var (index, isSdk) = MsbuildRestore.ChooseMsBuildInstance(candidates, requiredMajor: 10); + + Assert.Equal((0, true), (index, isSdk)); + } + + [Fact] + public void SdkOlderThanFloorFallsToVs() + { + // The incident layout: CLI SDK 8 only, repo targets net10, VS 18 present. + var candidates = new[] { Sdk(8), Vs(18) }; + + var (index, isSdk) = MsbuildRestore.ChooseMsBuildInstance(candidates, requiredMajor: 10); + + Assert.Equal((1, false), (index, isSdk)); + } + + [Fact] + public void SdkOlderThanFloorWithoutVsKeepsSdkAsLastResort() + { + var candidates = new[] { Sdk(8) }; + + var (index, isSdk) = MsbuildRestore.ChooseMsBuildInstance(candidates, requiredMajor: 10); + + Assert.Equal((0, true), (index, isSdk)); + } + + [Fact] + public void HighestQualifyingSdkWinsAmongSdkSiblings() + { + var candidates = new[] { Sdk(8), Sdk(10), Sdk(11) }; + + var (index, isSdk) = MsbuildRestore.ChooseMsBuildInstance(candidates, requiredMajor: 10); + + Assert.Equal((2, true), (index, isSdk)); + } + + // ── RequiredSdkMajorFloor ───────────────────────────────────────── + + private string WriteSolution(params (string RelativePath, string TargetFrameworks)[] projects) + { + var solutionLines = new List { "Microsoft Visual Studio Solution File, Format Version 12.00", "Global" }; + foreach (var (relative, tfms) in projects) + { + var projectPath = Path.Combine(_root, relative.Replace('\\', Path.DirectorySeparatorChar)); + Directory.CreateDirectory(Path.GetDirectoryName(projectPath)!); + File.WriteAllText( + projectPath, + $"\n \n {tfms}\n \n\n"); + solutionLines.Insert( + 1, + $"Project(\"{{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}}\") = \"P\", \"{relative}\", \"{{GUID}}\""); + } + var solutionPath = Path.Combine(_root, "Repo.sln"); + File.WriteAllLines(solutionPath, solutionLines); + return solutionPath; + } + + [Fact] + public void MultiTargetListFloorsAtHighestTfm() + { + // net8.0;net10.0 must floor at 10 — first-TFM (the pre-fix stance) + // would floor at 8 and register an SDK 8 instance that cannot + // evaluate the net10 half (the exact incident class). The pinned + // 8.x SDK below must NOT lower it. + var solutionPath = WriteSolution(("src\\A\\A.csproj", "net8.0;net10.0")); + WriteGlobalJson(Path.Combine(_root, "global.json"), "8.0.100"); + + Assert.Equal(10, MsbuildRestore.RequiredSdkMajorFloor(solutionPath)); + } + + [Fact] + public void FloorTakesMaxAcrossProjectsAndGlobalJson() + { + var solutionPath = WriteSolution( + ("src\\A\\A.csproj", "net8.0"), + ("src\\B\\B.csproj", "net10.0")); + WriteGlobalJson(Path.Combine(_root, "global.json"), "10.0.303"); + + Assert.Equal(10, MsbuildRestore.RequiredSdkMajorFloor(solutionPath)); + } + + [Fact] + public void GlobalJsonAboveSolutionDirRaisesTheFloor() + { + // NuGet's own lookup order: the sln and its projects sit in a + // subdir, global.json at the parent — the walk-up must find the + // pinned 11 over the projects' net8. + var solutionPath = WriteSolution(("src\\A\\A.csproj", "net8.0")); + var repoDir = Path.Combine(_root, "repo"); + Directory.CreateDirectory(repoDir); + Directory.Move(Path.Combine(_root, "src"), Path.Combine(repoDir, "src")); + File.Move(solutionPath, Path.Combine(repoDir, "Repo.sln")); + WriteGlobalJson(Path.Combine(_root, "global.json"), "11.0.100"); + + Assert.Equal(11, MsbuildRestore.RequiredSdkMajorFloor(Path.Combine(repoDir, "Repo.sln"))); + } + + [Fact] + public void NonNetTargetsAndMissingSolutionYieldNoFloor() + { + // The local global.json pins nothing parseable, so no ancestor + // stray file can perturb the null expectation. + var solutionPath = WriteSolution(("src\\A\\A.csproj", "netstandard2.0")); + WriteGlobalJson(Path.Combine(_root, "global.json"), "{}"); + + Assert.Null(MsbuildRestore.RequiredSdkMajorFloor(solutionPath)); + Assert.Null(MsbuildRestore.RequiredSdkMajorFloor(null)); + Assert.Null(MsbuildRestore.RequiredSdkMajorFloor(Path.Combine(_root, "absent.sln"))); + } + + [Fact] + public void NetFrameworkSpellingsDoNotRaiseTheFloor() + { + // net48/net472 (extension-less) must not become a "48" floor: an + // SDK loads them from reference assemblies, and a 48 floor would + // flip healthy SDK+VS machines to the VS instance for no reason. + // The pre-fix regex (^net(\d+)(?:\.|$)) matched net48 as major 48. + var net48Only = WriteSolution(("src\\Legacy\\Legacy.csproj", "net48")); + + Assert.Null(MsbuildRestore.RequiredSdkMajorFloor(net48Only)); + + var mixed = WriteSolution(("src\\Mixed\\Mixed.csproj", "net48;net10.0")); + + Assert.Equal(10, MsbuildRestore.RequiredSdkMajorFloor(mixed)); + } + + private static void WriteGlobalJson(string path, string version) + { + var content = version.StartsWith('{') + ? version + : $"{{ \"sdk\": {{ \"version\": \"{version}\" }} }}"; + File.WriteAllText(path, content); + } +} diff --git a/helpers/csharp/tests/RestoreGateTests.cs b/helpers/csharp/tests/RestoreGateTests.cs new file mode 100644 index 00000000..a1118be0 --- /dev/null +++ b/helpers/csharp/tests/RestoreGateTests.cs @@ -0,0 +1,124 @@ +using System.Diagnostics; +using ScipCsharp; +using Xunit; + +namespace ScipCsharp.Tests; + +/// +/// Unit tests for the restore-pending marker: a marker for a live process +/// with matching start time is ACTIVE (gating later index/find-refs runs), +/// while a start-time mismatch or an unreachable pid is STALE and gets +/// deleted so the run proceeds normally. +/// +public class RestoreGateTests : IDisposable +{ + private readonly string _solutionPath; + + public RestoreGateTests() + { + _solutionPath = Path.Combine( + Path.GetTempPath(), "cs-restore-gate-" + Guid.NewGuid().ToString("N"), "Acme.sln"); + } + + public void Dispose() => RestorePendingMarker.Delete(_solutionPath); + + [Fact] + public void RestorePendingExitCodeIsTheDedicated75() + { + Assert.Equal(75, ExitCodes.RestorePending); + } + + [Fact] + public void MarkerForLiveProcessWithMatchingStartTimeIsActive() + { + using var current = Process.GetCurrentProcess(); + RestorePendingMarker.Write(_solutionPath, current.Id, current.StartTime.ToUniversalTime()); + + Assert.True(RestorePendingMarker.IsActive(_solutionPath)); + } + + [Fact] + public void MarkerWithMismatchedStartTimeIsStaleAndDeleted() + { + // Pid-reuse protection: a recycled pid with a different start time + // must never look like a still-running restore. + using var current = Process.GetCurrentProcess(); + RestorePendingMarker.Write( + _solutionPath, current.Id, current.StartTime.ToUniversalTime().AddDays(-1)); + + Assert.False(RestorePendingMarker.IsActive(_solutionPath)); + // Stale marker was deleted: a repeat check must not resurrect it. + Assert.False(RestorePendingMarker.IsActive(_solutionPath)); + } + + [Fact] + public void MarkerForUnreachablePidIsStale() + { + // Pid 4 exists on Windows (System) but denies StartTime, and does not + // exist on Linux — both classification paths must end stale. + RestorePendingMarker.Write(_solutionPath, 4, DateTime.UtcNow); + + Assert.False(RestorePendingMarker.IsActive(_solutionPath)); + } + + [Fact] + public void MissingMarkerIsNeverActive() + { + Assert.False(RestorePendingMarker.IsActive(_solutionPath)); + } + + [Fact] + public void MarkerIsSharedAcrossPathCasing() + { + using var current = Process.GetCurrentProcess(); + RestorePendingMarker.Write(_solutionPath, current.Id, current.StartTime.ToUniversalTime()); + + Assert.True(RestorePendingMarker.IsActive(_solutionPath.ToUpperInvariant())); + } + + /// + /// Pins the gate decision itself: an ACTIVE marker must refuse the + /// workspace load — deleting the Program.cs wiring must not let a + /// degraded index be built silently. + /// + [Fact] + public void ActiveMarkerRefusesTheWorkspaceLoad() + { + using var current = Process.GetCurrentProcess(); + RestorePendingMarker.Write(_solutionPath, current.Id, current.StartTime.ToUniversalTime()); + + Assert.Throws(() => RestoreGate.ThrowIfRestorePending(_solutionPath)); + } + + [Fact] + public void MissingOrStaleMarkerAllowsTheWorkspaceLoad() + { + RestoreGate.ThrowIfRestorePending(_solutionPath); // no marker: no throw + + using var current = Process.GetCurrentProcess(); + RestorePendingMarker.Write( + _solutionPath, current.Id, current.StartTime.ToUniversalTime().AddDays(-1)); + + RestoreGate.ThrowIfRestorePending(_solutionPath); // stale: deleted, no throw + } + + /// + /// Pins the serve-startup refusal: an ACTIVE marker must yield the + /// dedicated exit code so the resident pool falls back instead of caching + /// answers from a workspace loaded mid-restore. + /// + [Fact] + public void ServeStartupRefusesWhileRestoreInFlight() + { + using var current = Process.GetCurrentProcess(); + RestorePendingMarker.Write(_solutionPath, current.Id, current.StartTime.ToUniversalTime()); + + Assert.Equal(75, RestoreGate.ServeStartupPendingExit(_solutionPath)); + } + + [Fact] + public void ServeStartupProceedsWithoutActiveMarker() + { + Assert.Null(RestoreGate.ServeStartupPendingExit(_solutionPath)); + } +} diff --git a/helpers/csharp/tests/RestorePolicyTests.cs b/helpers/csharp/tests/RestorePolicyTests.cs new file mode 100644 index 00000000..87b469a0 --- /dev/null +++ b/helpers/csharp/tests/RestorePolicyTests.cs @@ -0,0 +1,318 @@ +using ScipCsharp; +using Xunit; + +namespace ScipCsharp.Tests; + +/// +/// Unit tests for the restore gating policy: a repo whose projects all carry +/// fresh obj/project.assets.json must skip restore entirely (the steady state +/// of an actively developed repo), while a missing or stale assets file +/// triggers it. +/// +public class RestorePolicyTests : IDisposable +{ + private readonly string _solutionDir; + + public RestorePolicyTests() + { + _solutionDir = Path.Combine(Path.GetTempPath(), "cs-restore-policy-" + Guid.NewGuid().ToString("N")); + Directory.CreateDirectory(_solutionDir); + } + + public void Dispose() + { + Directory.Delete(_solutionDir, recursive: true); + } + + private string AddProject(string relativePath, bool withAssets, bool staleAssets = false) + { + var projectPath = Path.Combine(_solutionDir, relativePath.Replace('\\', Path.DirectorySeparatorChar)); + Directory.CreateDirectory(Path.GetDirectoryName(projectPath)!); + File.WriteAllText(projectPath, ""); + if (withAssets) + { + var objDir = Path.Combine(Path.GetDirectoryName(projectPath)!, "obj"); + Directory.CreateDirectory(objDir); + var assetsPath = Path.Combine(objDir, "project.assets.json"); + File.WriteAllText(assetsPath, "{}"); + if (staleAssets) + { + // Make the assets look OLDER than the project file. + File.SetLastWriteTimeUtc(assetsPath, File.GetLastWriteTimeUtc(projectPath).AddMinutes(-5)); + } + } + return projectPath; + } + + [Fact] + public void FreshAssetsOnEveryProjectSkipsRestore() + { + AddProject(@"src\Acme.Core\Acme.Core.csproj", withAssets: true); + AddProject(@"src\Acme.Web\Acme.Web.csproj", withAssets: true); + + Assert.False(RestorePolicy.NeedsRestore( + new[] { @"src\Acme.Core\Acme.Core.csproj", @"src\Acme.Web\Acme.Web.csproj" }, _solutionDir)); + } + + [Fact] + public void MissingAssetsTriggersRestore() + { + AddProject(@"src\Acme.Core\Acme.Core.csproj", withAssets: true); + AddProject(@"src\Acme.Web\Acme.Web.csproj", withAssets: false); + + Assert.True(RestorePolicy.NeedsRestore( + new[] { @"src\Acme.Core\Acme.Core.csproj", @"src\Acme.Web\Acme.Web.csproj" }, _solutionDir)); + } + + [Fact] + public void StaleAssetsOlderThanProjectTriggerRestore() + { + AddProject(@"src\Acme.Core\Acme.Core.csproj", withAssets: true, staleAssets: true); + + Assert.True(RestorePolicy.NeedsRestore(new[] { @"src\Acme.Core\Acme.Core.csproj" }, _solutionDir)); + } + + /// + /// Central package management / imported build config can change the + /// resolved dependency graph without touching any .csproj, so a shared + /// input newer than the assets must force a restore even when every .csproj + /// is older than its obj/project.assets.json. + /// + [Fact] + public void StaleSharedRestoreInputTriggersRestore() + { + var projectPath = AddProject(@"src\Acme.Core\Acme.Core.csproj", withAssets: true); + var assetsPath = Path.Combine(Path.GetDirectoryName(projectPath)!, "obj", "project.assets.json"); + + // A Directory.Packages.props at the solution root, newer than the assets. + var packagesProps = Path.Combine(_solutionDir, "Directory.Packages.props"); + File.WriteAllText(packagesProps, ""); + File.SetLastWriteTimeUtc(packagesProps, File.GetLastWriteTimeUtc(assetsPath).AddMinutes(5)); + + Assert.True(RestorePolicy.NeedsRestore(new[] { @"src\Acme.Core\Acme.Core.csproj" }, _solutionDir)); + } + + [Fact] + public void EmptyProjectListSkipsRestore() + { + Assert.False(RestorePolicy.NeedsRestore(Array.Empty(), _solutionDir)); + } + + [Fact] + public void RestoreTimeoutDefaultsTo300AndParsesEnvOverride() + { + Assert.Equal(300, RestorePolicy.RestoreTimeoutSeconds()); + + Environment.SetEnvironmentVariable(RestorePolicy.TimeoutEnvName, "600"); + try + { + Assert.Equal(600, RestorePolicy.RestoreTimeoutSeconds()); + } + finally + { + Environment.SetEnvironmentVariable(RestorePolicy.TimeoutEnvName, null); + } + + Environment.SetEnvironmentVariable(RestorePolicy.TimeoutEnvName, "not-a-number"); + try + { + Assert.Equal(300, RestorePolicy.RestoreTimeoutSeconds()); + } + finally + { + Environment.SetEnvironmentVariable(RestorePolicy.TimeoutEnvName, null); + } + } + + /// + /// Pins the timeout contract for the serve path: the wait expiring must + /// announce a restore that is STILL RUNNING in the background, never a + /// killed one — a kill would waste all of the restore's work — and name + /// the gating that index/find-refs runs apply while it finishes. + /// + /// + /// Pins the timeout contract for the serve path: the wait expiring must + /// announce a restore that is STILL RUNNING in the background, never a + /// killed one — a kill would waste all of the restore's work — and name + /// the gating that index/find-refs runs apply while it finishes. + /// Severity is [INFO]: restore state must not drive the warning icon. + /// + [Fact] + public void TimeoutWarningAnnouncesBackgroundContinuationNeverAKill() + { + var warning = RestorePolicy.StillRunningWarning(300); + + Assert.StartsWith("[INFO]", warning); + Assert.Contains("still running after 300s", warning); + Assert.Contains("background", warning); + Assert.Contains("gated", warning); + Assert.Contains("fresh assets", warning); + Assert.DoesNotContain("[WARN]", warning); + Assert.DoesNotContain("killed", warning, StringComparison.OrdinalIgnoreCase); + Assert.Contains(RestorePolicy.TimeoutEnvName, warning); + } + + private string AddRestoreInput(string relativePath, bool touched) => + AddRestoreInputAt(Path.Combine(_solutionDir, relativePath.Replace('\\', Path.DirectorySeparatorChar)), touched); + + private string AddRestoreInputAt(string inputPath, bool touched) + { + Directory.CreateDirectory(Path.GetDirectoryName(inputPath)!); + File.WriteAllText(inputPath, ""); + File.SetLastWriteTimeUtc( + inputPath, + DateTime.UtcNow.AddMinutes(touched ? 5 : -5)); + return inputPath; + } + + /// + /// Central package management: bumping a version in + /// Directory.Packages.props must mark the assets stale even though no + /// .csproj changed — the CS0246 class of false-fresh assets. + /// + [Fact] + public void TouchedPackagesPropsAtSolutionRootTriggersRestore() + { + AddProject(@"src\Acme.Core\Acme.Core.csproj", withAssets: true); + AddRestoreInput(@"Directory.Packages.props", touched: true); + + Assert.True(RestorePolicy.NeedsRestore( + new[] { @"src\Acme.Core\Acme.Core.csproj" }, _solutionDir)); + } + + /// + /// A failed restore must carry its OWN reason (NU11xx feed/resolution + /// errors) into the [WARN] line: without it the operator sees only the + /// symptom — unresolved packages, CS0518/CS0246 cascades — and never + /// learns the cause was e.g. an unreachable private feed. + /// + [Fact] + public void RestoreFailureDetailExtractsNuErrorsCapsAndFiltersWarnings() + { + var output = string.Join('\n', + "C:\\repo\\A.csproj : warning NU1900: Unable to load the service index for source https://feed.example", + "C:\\repo\\B.csproj : error NU1101: Unable to find package Acme.Shared. No packages exist with this id in source(s): acme-feed.", + "C:\\repo\\C.csproj : error NU1101: Unable to find package Other.", + new string('x', 400) + " error NU1001 tail", + "Done."); + + var detail = RestorePolicy.ExtractRestoreErrors(output); + + Assert.StartsWith(" Restore output: ", detail); + Assert.Contains("NU1101: Unable to find package Acme.Shared", detail); + Assert.Contains("Unable to find package Other", detail); + Assert.DoesNotContain("NU1900", detail); + Assert.DoesNotContain("Done.", detail); + Assert.True(detail.Length < 800, "per-line caps keep the [WARN] single-line sized"); + Assert.Contains("...", detail); + } + + [Fact] + public void RestoreFailureDetailIsEmptyWithoutErrorLines() + { + Assert.Equal(string.Empty, RestorePolicy.ExtractRestoreErrors("")); + Assert.Equal(string.Empty, RestorePolicy.ExtractRestoreErrors(" \n ")); + Assert.Equal(string.Empty, RestorePolicy.ExtractRestoreErrors("only warnings\nand info")); + } + + /// + /// The skip-guard must hit exactly the dead netcoreapp line: a legacy + /// 2.2 project design-time-loads into a CS0518 cascade on a modern SDK + /// (tool-side gap, not code health), while netstandard libraries and the + /// supported net line stay untouched. + /// + [Fact] + public void EndOfLifeFrameworkClassificationTable() + { + Assert.True(SkippedFrameworks.IsEndOfLife("netcoreapp2.2")); + Assert.True(SkippedFrameworks.IsEndOfLife("netcoreapp2.0")); + Assert.True(SkippedFrameworks.IsEndOfLife("netcoreapp3.1")); + Assert.True(SkippedFrameworks.IsEndOfLife(" NetCoreApp2.2 ")); + + Assert.False(SkippedFrameworks.IsEndOfLife("net10.0")); + Assert.False(SkippedFrameworks.IsEndOfLife("net48")); + Assert.False(SkippedFrameworks.IsEndOfLife("netstandard2.0")); + Assert.False(SkippedFrameworks.IsEndOfLife("netcoreapp")); + } + + [Fact] + public void TargetFrameworkExtractionFromProjectText() + { + Assert.Equal("netcoreapp2.2", SkippedFrameworks.ExtractFromProjectText( + "netcoreapp2.2")); + // Multi-target: the FIRST target decides (the one design-time uses). + Assert.Equal("net10.0", SkippedFrameworks.ExtractFromProjectText( + "net10.0;netstandard2.0")); + Assert.Null(SkippedFrameworks.ExtractFromProjectText("")); + } + + [Fact] + public void HasUsableAssetsFollowsTheAssetsFile() + { + AddProject(@"src\Acme.Core\Acme.Core.csproj", withAssets: true); + Assert.True(RestorePolicy.HasUsableAssets(@"src\Acme.Core\Acme.Core.csproj", _solutionDir)); + + AddProject(@"src\Acme.Bare\Acme.Bare.csproj", withAssets: false); + Assert.False(RestorePolicy.HasUsableAssets(@"src\Acme.Bare\Acme.Bare.csproj", _solutionDir)); + } + + [Fact] + public void UntouchedPackagesPropsKeepsRestoreSkipped() + { + AddProject(@"src\Acme.Core\Acme.Core.csproj", withAssets: true); + AddRestoreInput(@"Directory.Packages.props", touched: false); + + Assert.False(RestorePolicy.NeedsRestore( + new[] { @"src\Acme.Core\Acme.Core.csproj" }, _solutionDir)); + } + + /// + /// The walk must extend ABOVE the solution dir: a Directory.Build.props at + /// the repo root applies to a solution sitting deeper in the repo. + /// + [Fact] + public void InputAboveSolutionDirAtRepoRootTriggersRestore() + { + var repoDir = Directory.CreateDirectory(Path.Combine(_solutionDir, "repo")).FullName; + var solutionDir = Directory.CreateDirectory(Path.Combine(repoDir, "sln")).FullName; + Directory.CreateDirectory(Path.Combine(repoDir, ".git")); + + var projectPath = Path.Combine(solutionDir, "src", "Acme.Core", "Acme.Core.csproj"); + Directory.CreateDirectory(Path.GetDirectoryName(projectPath)!); + File.WriteAllText(projectPath, ""); + var objDir = Path.Combine(Path.GetDirectoryName(projectPath)!, "obj"); + Directory.CreateDirectory(objDir); + File.WriteAllText(Path.Combine(objDir, "project.assets.json"), "{}"); + + AddRestoreInputAt(Path.Combine(repoDir, "Directory.Build.props"), touched: true); + + Assert.True(RestorePolicy.NeedsRestore( + new[] { @"src\Acme.Core\Acme.Core.csproj" }, solutionDir)); + } + + [Fact] + public void TouchedNuGetConfigAndGlobalJsonTriggerRestore() + { + AddProject(@"src\Acme.Core\Acme.Core.csproj", withAssets: true); + AddRestoreInput(@"NuGet.config", touched: true); + AddRestoreInput(@"global.json", touched: false); + + Assert.True(RestorePolicy.NeedsRestore( + new[] { @"src\Acme.Core\Acme.Core.csproj" }, _solutionDir)); + } + + /// + /// Pins the case-insensitive input-name match: NuGet honours lowercase + /// nuget.config on case-sensitive filesystems, where an exact-case probe + /// would miss it. + /// + [Fact] + public void CaseVariantInputNameStillTriggersRestore() + { + AddProject(@"src\Acme.Core\Acme.Core.csproj", withAssets: true); + AddRestoreInput(@"nuget.config", touched: true); + + Assert.True(RestorePolicy.NeedsRestore( + new[] { @"src\Acme.Core\Acme.Core.csproj" }, _solutionDir)); + } +} diff --git a/helpers/csharp/tests/ScipCsharp.Tests.csproj b/helpers/csharp/tests/ScipCsharp.Tests.csproj index 96712ece..bbd732b5 100644 --- a/helpers/csharp/tests/ScipCsharp.Tests.csproj +++ b/helpers/csharp/tests/ScipCsharp.Tests.csproj @@ -17,6 +17,19 @@ (MSBuildWorkspace), which only resolves with the Workspaces.MSBuild assembly on the reference set. --> + + + + + + + + + diff --git a/helpers/csharp/tests/WorkspaceLoadPropertiesTests.cs b/helpers/csharp/tests/WorkspaceLoadPropertiesTests.cs new file mode 100644 index 00000000..60cda4ff --- /dev/null +++ b/helpers/csharp/tests/WorkspaceLoadPropertiesTests.cs @@ -0,0 +1,35 @@ +using Xunit; +using ScipCsharp; + +namespace ScipCsharp.Tests; + +/// +/// Pins the workspace load properties. The contract that matters: the +/// symbol load NEVER escalates warnings to errors — a repo with +/// TreatWarningsAsErrors (own settings or Directory.Build.props) must still +/// load its projects, because benign load-time diagnostics (NU1603 class) +/// would otherwise drop the project and every cross-project reference to it. +/// Reverting any of the three demotion properties must fail this test. +/// +public class WorkspaceLoadPropertiesTests +{ + [Fact] + public void Load_NeverEscalatesWarningsToErrors() + { + var properties = WorkspaceLoad.GlobalProperties(); + + Assert.Equal("false", properties["TreatWarningsAsErrors"]); + Assert.Equal("", properties["WarningsAsErrors"]); + Assert.Equal("false", properties["MSBuildTreatWarningsAsErrors"]); + } + + [Fact] + public void Load_KeepsDesignTimeBuildContract() + { + var properties = WorkspaceLoad.GlobalProperties(); + + Assert.Equal("true", properties["BuildingInsideVisualStudio"]); + Assert.Equal("true", properties["DesignTimeBuild"]); + Assert.Equal("true", properties["SkipCompilerExecution"]); + } +} diff --git a/helpers/csharp/tests/WorkspaceNoiseTests.cs b/helpers/csharp/tests/WorkspaceNoiseTests.cs new file mode 100644 index 00000000..c74037da --- /dev/null +++ b/helpers/csharp/tests/WorkspaceNoiseTests.cs @@ -0,0 +1,176 @@ +using ScipCsharp; +using Xunit; + +namespace ScipCsharp.Tests; +/// +/// Unit tests for the workspace-noise policy: NuGet audit advisories must not +/// surface as index warnings (they are security notes, not load failures), +/// while genuine Msbuild load failures still do. +/// +public class WorkspaceNoiseTests +{ + [Fact] + public void NuGetAuditAdvisoryIsFiltered() + { + var message = + "Msbuild failed when processing the file 'Acme.Core.csproj' with message: " + + "Package 'Microsoft.Extensions.Caching.Memory' 8.0.0 has a known high severity " + + "vulnerability, https://github.com/advisories/GHSA-qj66-m88j-hmgj"; + Assert.True(WorkspaceNoise.IsNuGetAuditNoise(message)); + } + + [Theory] + [InlineData("Acme.Core.csproj: Unable to load the service index for source https://pkgs.example/index.json.")] + [InlineData("Acme.Core.csproj: Error occurred while getting package vulnerability data: Unable to load the service index")] + public void NuGetSourceFailureIsDemoted(string message) => + Assert.True(WorkspaceNoise.IsNuGetSourceFailure(message)); + + [Fact] + public void MissingPackageIsNotNuGetSourceFailure() => + Assert.False(WorkspaceNoise.IsNuGetSourceFailure( + "Acme.Core.csproj: Unable to find package Acme.Shared. No packages exist with this id in source(s)")); + + [Fact] + public void GenuineLoadFailureIsNotNuGetSourceFailure() => + Assert.False(WorkspaceNoise.IsNuGetSourceFailure("The type or namespace name 'Catalog' does not exist")); + + [Fact] + public void BuildHostTypeInitializerCrashIsDemoted() => + Assert.True(WorkspaceNoise.IsBuildHostTypeInitializerCrash( + "RemoteInvocationException: An exception of type System.TypeInitializationException was thrown: The type initializer for 'Microsoft.Build.Shared.XMakeElements' threw an exception.")); + + [Fact] + public void GenuineLoadFailureIsNotTypeInitializerCrash() => + Assert.False(WorkspaceNoise.IsBuildHostTypeInitializerCrash("The type or namespace name 'Catalog' does not exist")); + + [Fact] + public void GenuineLoadFailureIsKept() + { + var message = + "Msbuild failed when processing the file 'Acme.Core.csproj' with message: " + + "The type or namespace name 'Catalog' does not exist in the namespace 'Acme'"; + Assert.False(WorkspaceNoise.IsNuGetAuditNoise(message)); + } + + [Fact] + public void NullAndUnrelatedMessagesAreKept() + { + Assert.False(WorkspaceNoise.IsNuGetAuditNoise(null)); + Assert.False(WorkspaceNoise.IsNuGetAuditNoise(string.Empty)); + Assert.False(WorkspaceNoise.IsNuGetAuditNoise("Invalid project file, unsupported project type")); + } + + [Theory] + [InlineData("has a KNOWN vulnerability")] + [InlineData("HAS A KNOWN VULNERABILITY")] + public void MatchingIsCaseInsensitive(string message) + { + Assert.True(WorkspaceNoise.IsNuGetAuditNoise(message)); + } + + /// The real-world shape this filter exists for: a NuGet package-version + /// mismatch surfaces as an Msbuild "failure", but the project still loads + /// and its symbol tree is complete — the index must not carry it as a + /// warning. + [Fact] + public void PackageVersionConflictIsFiltered() + { + var message = + "Msbuild failed when processing the file 'Acme.Publishing.Core.csproj' with message: " + + "Dependency specified was SonarAnalyzer.CSharp (>= 10.18.0.128626) but ended up with " + + "SonarAnalyzer.CSharp 10.18.0.131500."; + Assert.True(WorkspaceNoise.IsPackageVersionConflict(message)); + } + + [Fact] + public void GenuineLoadFailureIsNotAVersionConflict() + { + var message = + "Msbuild failed when processing the file 'Acme.Core.csproj' with message: " + + "The type or namespace name 'Catalog' does not exist in the namespace 'Acme'"; + Assert.False(WorkspaceNoise.IsPackageVersionConflict(message)); + } + + [Theory] + [InlineData(null)] + [InlineData("")] + [InlineData("Dependency specified was never met")] // one half only + [InlineData("ended up with nothing")] // the other half only + public void IncompleteOrMissingVersionConflictTextIsKept(string? message) + { + Assert.False(WorkspaceNoise.IsPackageVersionConflict(message)); + } + + /// The real-world shape this filter exists for: an MSBuild check + /// advisory (package compatibility) escalates to an Msbuild "failure", + /// but the project still loads — the index must not carry product + /// guidance as a warning. + [Fact] + public void MsbuildCheckAdvisoryIsFiltered() + { + var message = + "Msbuild failed when processing the file 'Sample.Web.csproj' with message: " + + "Grpc.Net.ClientFactory 2.63.0 or earlier could cause issues when used together " + + "with Microsoft.Extensions.Http.Resilience. For more details, see " + + "https://learn.microsoft.com/dotnet/core/resilience/http-resilience#known-issues. " + + "Consider using Grpc.Net.ClientFactory 2.64.0 or later. To suppress the warning " + + "set SuppressCheckGrpcNetClientFactoryVersion=true."; + Assert.True(WorkspaceNoise.IsMsbuildCheckAdvisory(message)); + } + + [Theory] + [InlineData(null)] + [InlineData("")] + [InlineData("Consider using a newer package")] // one half only + [InlineData("To suppress the warning set Whatever=true")] // other half only + [InlineData("could cause issues")] // not the advisory shape + public void IncompleteOrMissingAdvisoryTextIsKept(string? message) + { + Assert.False(WorkspaceNoise.IsMsbuildCheckAdvisory(message)); + } + + /// The real-world shape this filter exists for: after a BuildHost crash + /// the shutdown diagnostics trail the failure the load exception already + /// reports — they must not double-count as separate index warnings. + [Theory] + [InlineData("[BuildHost PID 58740] Exception while shutting down the BuildHost process.")] + [InlineData("[BuildHost PID 58740] The BuildHost process is not responding. Process output:")] + [InlineData("[BuildHost pid 58740] THE BUILDHOST PROCESS IS NOT RESPONDING")] + public void BuildHostShutdownChatterIsFiltered(string message) + { + Assert.True(WorkspaceNoise.IsBuildHostShutdownChatter(message)); + } + + /// The chatter filter must not swallow the actual failure lines: the + /// BuildHost tag can prefix real errors, and load failures carry it not + /// at all — both stay warnings. + [Theory] + [InlineData(null)] + [InlineData("")] + [InlineData("[BuildHost PID 58740] The BuildHost process crashed during project load")] + [InlineData("Msbuild failed when processing the file 'Acme.Core.csproj' with message: boom")] + [InlineData("The BuildHost process is not responding.")] // no BuildHost tag + public void GenuineBuildHostFailuresAreKept(string? message) + { + Assert.False(WorkspaceNoise.IsBuildHostShutdownChatter(message)); + } + + /// The demoted note MUST render the bare message: a failure-kind + /// diagnostic's ToString() prefixes "[Failure] ", and the Rust capture + /// substring-matches "[Failure]" anywhere in the line — a demoted note + /// carrying the tag re-enters the stored index warnings and the demotion + /// is a no-op. + [Fact] + public void DemotedNoteCarriesNoFailureTag() + { + var diagnostic = new Microsoft.CodeAnalysis.WorkspaceDiagnostic( + Microsoft.CodeAnalysis.WorkspaceDiagnosticKind.Failure, + "Msbuild failed when processing the file 'Acme.Core.csproj' with message: boom"); + Assert.StartsWith("[Failure]", diagnostic.ToString()); // precondition: the tag exists + + var line = WorkspaceNoise.DemotedNote(diagnostic); + Assert.StartsWith("[INFO] Workspace note: ", line); + Assert.DoesNotContain("[Failure]", line); + Assert.Contains("boom", line); + } +} diff --git a/helpers/csharp/tests/WorkspaceSymbolPickTests.cs b/helpers/csharp/tests/WorkspaceSymbolPickTests.cs new file mode 100644 index 00000000..a8435459 --- /dev/null +++ b/helpers/csharp/tests/WorkspaceSymbolPickTests.cs @@ -0,0 +1,99 @@ +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.FindSymbols; +using ScipCsharp; +using Xunit; + +namespace ScipCsharp.Tests; + +/// +/// Pins how the detached map symbol is paired with its workspace counterpart: +/// the exact overload must win over whichever similar symbol comes first, and +/// an unresolvable pairing must be reported as a fallback, never passed off +/// as a match. +/// +public class WorkspaceSymbolPickTests +{ + private const string Overloads = + "class C { public int Add(int a, int b) => a + b; public int Add(int a, int b, int c) => a + b + c; }"; + + private const string OtherOverloads = + "class C { public int Add(int a) => a; public int Add(long a) => 0; }"; + + private static CSharpCompilation Compile(string source) => + CSharpCompilation.Create( + "Acme.Core", + [CSharpSyntaxTree.ParseText(source)], + references: [MetadataReference.CreateFromFile(typeof(object).Assembly.Location)], + options: new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary)); + + private static List AddOverloads(Compilation compilation) => + compilation.GetTypeByMetadataName("C")! + .GetMembers("Add") + .OfType() + .OrderBy(m => m.Parameters.Length) + .ToList(); + + [Fact] + public void PicksTheMatchingOverloadFromTheWorkspaceCompilation() + { + var detached = Compile(Overloads); + var workspace = Compile(Overloads); + var target = AddOverloads(detached)[1]; + + var similar = SymbolFinder.FindSimilarSymbols(target, workspace); + var picked = ReferenceResolver.PickWorkspaceSymbol(target, similar, out var fellBack); + + Assert.False(fellBack); + Assert.NotSame(target, picked); + Assert.Same(workspace.Assembly, picked.ContainingAssembly); + Assert.Equal(3, Assert.IsAssignableFrom(picked).Parameters.Length); + } + + [Fact] + public void ExactSignatureWinsOverAnEarlierCandidate() + { + var target = AddOverloads(Compile(Overloads))[1]; + var workspaceOverloads = AddOverloads(Compile(Overloads)); + + var picked = ReferenceResolver.PickWorkspaceSymbol(target, workspaceOverloads, out var fellBack); + + Assert.False(fellBack); + Assert.Same(workspaceOverloads[1], picked); + } + + [Fact] + public void NoCandidatesFallsBackToTheTarget() + { + var target = AddOverloads(Compile(Overloads))[1]; + + var picked = ReferenceResolver.PickWorkspaceSymbol(target, [], out var fellBack); + + Assert.True(fellBack); + Assert.Same(target, picked); + } + + [Fact] + public void LoneNonExactCandidateIsAccepted() + { + var target = AddOverloads(Compile(Overloads))[1]; + var lone = AddOverloads(Compile(OtherOverloads))[0]; + + var picked = ReferenceResolver.PickWorkspaceSymbol(target, [lone], out var fellBack); + + Assert.False(fellBack); + Assert.Same(lone, picked); + } + + [Fact] + public void SeveralNonExactCandidatesFallBackToTheTarget() + { + var target = AddOverloads(Compile(Overloads))[1]; + var others = AddOverloads(Compile(OtherOverloads)); + + var picked = ReferenceResolver.PickWorkspaceSymbol(target, others, out var fellBack); + + Assert.True(fellBack); + Assert.Same(target, picked); + } +} diff --git a/integrations/claude-code/README.md b/integrations/claude-code/README.md index 1831f031..4e01bb3d 100644 --- a/integrations/claude-code/README.md +++ b/integrations/claude-code/README.md @@ -40,7 +40,8 @@ that make the preference *structural* instead of advisory: Windows-style roots, so POSIX absolute paths were still resolved against the cwd). Coverage is decided by **registration**: the target's git root must be one of the repos in the hub's `~/.codesearch/repos.json` - (honoring `CODESEARCH_REPOS_CONFIG`), which also carves out nested + (honoring `CODESEARCH_REPOS_CONFIG`; `CODESEARCH_HOME` relocates the + root), which also carves out nested repos for free — an unregistered clone inside a registered repo resolves to its own git root and is treated as uncovered. Grep is auto-allowed **only** when codesearch is genuinely @@ -73,7 +74,8 @@ that make the preference *structural* instead of advisory: everything else — making the caller-aware-editing protocol structural. Coverage uses the same registration model as grep-guard (shared `codesearch-common` helpers): the file's git root must be listed in - `~/.codesearch/repos.json` (or `CODESEARCH_SERVER` is set); unregistered + `~/.codesearch/repos.json` (relocatable via `CODESEARCH_HOME`; or + `CODESEARCH_SERVER` is set); unregistered repos and non-git paths are never blocked. - **`edit-guard-post`** — a `PostToolUse` hook on @@ -182,7 +184,7 @@ whose commands point at `hooks/codesearch/`) from `settings.json`, and delete **registration with the serve hub**: the target's git root must be one of the repos listed in `~/.codesearch/repos.json` (the same registration list the hub itself resolves queries by, honoring the - `CODESEARCH_REPOS_CONFIG` override), or an explicit `CODESEARCH_SERVER` + `CODESEARCH_REPOS_CONFIG` / `CODESEARCH_HOME` overrides), or an explicit `CODESEARCH_SERVER` env var for pure remote-serve setups with no local registration. A local `.codesearch.db` directory is deliberately **not** a coverage signal anymore (#199): a stale db from a since-unregistered repo used diff --git a/integrations/claude-code/hooks/codesearch-common.ps1 b/integrations/claude-code/hooks/codesearch-common.ps1 index 00c01d89..35b25501 100644 --- a/integrations/claude-code/hooks/codesearch-common.ps1 +++ b/integrations/claude-code/hooks/codesearch-common.ps1 @@ -5,12 +5,14 @@ # PowerShell twin of codesearch-common.sh — keep the two behaviorally # equivalent. Coverage model: a repo is covered when its git root is # REGISTERED in ~/.codesearch/repos.json (CODESEARCH_REPOS_CONFIG overrides -# the location), or when CODESEARCH_SERVER opts a pure remote-serve setup +# the location, CODESEARCH_HOME relocates the whole global root), or when +# CODESEARCH_SERVER opts a pure remote-serve setup # in. Everything here fails open: an unresolvable coverage question must # allow, never deny. function Get-CodesearchReposConfigFile { if ($env:CODESEARCH_REPOS_CONFIG) { return $env:CODESEARCH_REPOS_CONFIG } + if ($env:CODESEARCH_HOME) { return (Join-Path $env:CODESEARCH_HOME 'repos.json') } return (Join-Path $HOME '.codesearch/repos.json') } diff --git a/integrations/claude-code/hooks/codesearch-common.sh b/integrations/claude-code/hooks/codesearch-common.sh index a77e51ac..3ea79549 100644 --- a/integrations/claude-code/hooks/codesearch-common.sh +++ b/integrations/claude-code/hooks/codesearch-common.sh @@ -5,7 +5,8 @@ # # Coverage model (shared with the Rust serve hub, src/db_discovery/repos.rs): # a repo is covered when its git root is REGISTERED in -# ~/.codesearch/repos.json (CODESEARCH_REPOS_CONFIG overrides the location), +# ~/.codesearch/repos.json (CODESEARCH_REPOS_CONFIG overrides the location, +# CODESEARCH_HOME relocates the whole global root), # or when CODESEARCH_SERVER opts a pure remote-serve setup in. Everything # here fails open: an unresolvable coverage question must allow, never deny. # Requires: jq @@ -17,11 +18,14 @@ jq_str() { tr -d '\r' } -# repos.json location — mirrors src/db_discovery/repos.rs `config_path()`: -# CODESEARCH_REPOS_CONFIG override > ~/.codesearch/repos.json. +# repos.json location — mirrors src/db_discovery/repos.rs `config_path()` +# and constants.rs `codesearch_home()`: +# CODESEARCH_REPOS_CONFIG > $CODESEARCH_HOME/repos.json > ~/.codesearch/repos.json. repos_config_file() { if [ -n "${CODESEARCH_REPOS_CONFIG:-}" ]; then printf '%s' "$CODESEARCH_REPOS_CONFIG" + elif [ -n "${CODESEARCH_HOME:-}" ]; then + printf '%s' "${CODESEARCH_HOME%/}/repos.json" else printf '%s' "${HOME:-}/.codesearch/repos.json" fi diff --git a/integrations/claude-code/hooks/edit-guard.ps1 b/integrations/claude-code/hooks/edit-guard.ps1 index a45b0af6..066d5b9d 100644 --- a/integrations/claude-code/hooks/edit-guard.ps1 +++ b/integrations/claude-code/hooks/edit-guard.ps1 @@ -3,8 +3,8 @@ # two behaviorally equivalent. # # When the edited file's repo is codesearch-registered (git root listed in -# ~/.codesearch/repos.json, honoring CODESEARCH_REPOS_CONFIG, or a -# CODESEARCH_SERVER opt-in), every touched file needs a marker proving the +# ~/.codesearch/repos.json, honoring CODESEARCH_REPOS_CONFIG / CODESEARCH_HOME, +# or a CODESEARCH_SERVER opt-in), every touched file needs a marker proving the # agent consulted codesearch for exactly that path within the last 5 # minutes: mcp__codesearch__find_impact for SCIP-backed languages # (.cs .ts .tsx .mts .cts), mcp__codesearch__find kind="usages" for diff --git a/integrations/claude-code/hooks/edit-guard.sh b/integrations/claude-code/hooks/edit-guard.sh index c37da6f5..45b8a027 100644 --- a/integrations/claude-code/hooks/edit-guard.sh +++ b/integrations/claude-code/hooks/edit-guard.sh @@ -5,7 +5,8 @@ # # When the edited file's repo is codesearch-registered (shared coverage model # with grep-guard: git root listed in ~/.codesearch/repos.json, honoring -# CODESEARCH_REPOS_CONFIG, or a CODESEARCH_SERVER opt-in), every touched file +# CODESEARCH_REPOS_CONFIG / CODESEARCH_HOME, or a CODESEARCH_SERVER opt-in), +# every touched file # needs a marker proving the agent consulted codesearch for exactly that path # within the last 5 minutes: mcp__codesearch__find_impact for SCIP-backed # languages (.cs .ts .tsx .mts .cts), mcp__codesearch__find kind="usages" for diff --git a/integrations/claude-code/hooks/grep-guard.ps1 b/integrations/claude-code/hooks/grep-guard.ps1 index ee919d8b..cdc732de 100644 --- a/integrations/claude-code/hooks/grep-guard.ps1 +++ b/integrations/claude-code/hooks/grep-guard.ps1 @@ -82,7 +82,8 @@ $targetRoot = Resolve-TargetGitRoot $path if (-not $targetRoot) { exit 0 } # Coverage: the TARGET repo's git root is REGISTERED with the serve hub -# (~/.codesearch/repos.json — the same list the hub itself resolves by), +# (~/.codesearch/repos.json, honoring the CODESEARCH_REPOS_CONFIG / +# CODESEARCH_HOME overrides — the same list the hub itself resolves by), # matching the bash twin and edit-guard; a running serve hub alone is NOT a # signal (it covers many repos and being alive says nothing about this one). # CODESEARCH_SERVER stays the explicit opt-in for pure remote-serve setups. diff --git a/integrations/claude-code/hooks/grep-guard.sh b/integrations/claude-code/hooks/grep-guard.sh index cd24b3b1..ce310553 100644 --- a/integrations/claude-code/hooks/grep-guard.sh +++ b/integrations/claude-code/hooks/grep-guard.sh @@ -59,8 +59,9 @@ path=$(echo "$raw" | jq -r '.tool_input.path // empty' | jq_str) # every absolute path. # # Coverage signal (#199): the target's git root is REGISTERED with the -# local serve hub (~/.codesearch/repos.json — the same registration list -# the hub itself resolves queries by). A `.codesearch.db` directory at +# local serve hub (~/.codesearch/repos.json, honoring the +# CODESEARCH_REPOS_CONFIG / CODESEARCH_HOME overrides — the same +# registration list the hub itself resolves queries by). A `.codesearch.db` directory at # the git root was only ever a proxy for that and is wrong in both # directions: a stale db from a since-unregistered repo denied Grep while # the hub could not actually answer for it (unknown alias), and a diff --git a/integrations/claude-code/hooks/run-tests.sh b/integrations/claude-code/hooks/run-tests.sh index e536bdc3..31b6a7d0 100644 --- a/integrations/claude-code/hooks/run-tests.sh +++ b/integrations/claude-code/hooks/run-tests.sh @@ -8,10 +8,11 @@ # # Coverage is simulated without a real index: repoA is "registered" via a # temp repos.json passed through CODESEARCH_REPOS_CONFIG (the same override -# the guards honour at runtime), repoB is not listed. The serve hub is only -# contacted by the grep-guard smoke case, which forces a dead port so the -# answer is deterministic. State lives in a temp TMPDIR; the env overrides -# are process-scoped and die with this script. +# the guards honour at runtime), repoB is not listed. One case pins the +# CODESEARCH_HOME relocation fallback with REPOS_CONFIG unset. The serve hub +# is only contacted by the grep-guard smoke case, which forces a dead port +# so the answer is deterministic. State lives in a temp TMPDIR; the env +# overrides are process-scoped and die with this script. set -u @@ -25,7 +26,7 @@ STATE_DIR="$TMP_ROOT/state" mkdir -p "$STATE_DIR" cleanup() { - unset CODESEARCH_REPOS_CONFIG CODESEARCH_SERVER TMPDIR + unset CODESEARCH_REPOS_CONFIG CODESEARCH_SERVER CODESEARCH_HOME TMPDIR rm -rf "$TMP_ROOT" } trap cleanup EXIT @@ -152,6 +153,23 @@ case_grep_guard_smoke() { fi } +case_covered_via_codesearch_home() { + # Relocation pin: with REPOS_CONFIG unset, guards must resolve repos.json + # from $CODESEARCH_HOME (mirrors constants.rs codesearch_home()) — and + # only from there, so a dev's real global registry cannot leak in. + local home="$TMP_ROOT/cs-home" saved_cfg="${CODESEARCH_REPOS_CONFIG:-}" + mkdir -p "$home" + jq -n --arg a "$ROOT_A" '{repos: {repoA: $a}}' > "$home/repos.json" + unset CODESEARCH_REPOS_CONFIG + export CODESEARCH_HOME="$home" + run_edit "$(edit_event "$REPO_A/x.cs")" + expect_deny "CODESEARCH_HOME registry: covered .cs denied" "find_impact" + run_edit "$(edit_event "$REPO_B/b.cs")" + expect_allow "CODESEARCH_HOME registry: unregistered repo fails open" + unset CODESEARCH_HOME + export CODESEARCH_REPOS_CONFIG="$saved_cfg" +} + case_no_coverage_allows case_covered_cs_denied case_covered_ts_denied @@ -163,6 +181,7 @@ case_multiedit_partial_marks_denied case_find_usages_marker_allows case_window_expiry_denies_again case_grep_guard_smoke +case_covered_via_codesearch_home echo echo "edit-guard self-tests: $PASS passed, $FAIL failed" diff --git a/integrations/claude-code/hooks/web-guard.ps1 b/integrations/claude-code/hooks/web-guard.ps1 index 6dddaac1..d519068c 100644 --- a/integrations/claude-code/hooks/web-guard.ps1 +++ b/integrations/claude-code/hooks/web-guard.ps1 @@ -76,6 +76,7 @@ if ([string]::IsNullOrWhiteSpace($q)) { exit 0 } # names — the opt-in allowlist). No mounts -> nothing to prefer -> allow. # ------------------------------------------------------------------ $config = if ($env:CODESEARCH_REPOS_CONFIG) { $env:CODESEARCH_REPOS_CONFIG } + elseif ($env:CODESEARCH_HOME) { Join-Path $env:CODESEARCH_HOME 'repos.json' } else { Join-Path $HOME '.codesearch/repos.json' } if (-not (Test-Path $config)) { exit 0 } diff --git a/integrations/claude-code/hooks/web-guard.sh b/integrations/claude-code/hooks/web-guard.sh index 6c72a633..31eff40c 100644 --- a/integrations/claude-code/hooks/web-guard.sh +++ b/integrations/claude-code/hooks/web-guard.sh @@ -54,7 +54,7 @@ q=$(echo "$raw" | jq -r '.tool_input.query // .tool_input.url // empty') # names — the opt-in allowlist). No mounts -> nothing to prefer -> allow the # web call unimpeded. # ------------------------------------------------------------------ -config="${CODESEARCH_REPOS_CONFIG:-$HOME/.codesearch/repos.json}" +config="${CODESEARCH_REPOS_CONFIG:-${CODESEARCH_HOME:-$HOME/.codesearch}/repos.json}" [ -f "$config" ] || exit 0 # NOTE: strip CR. On Windows/Git Bash jq emits CRLF, and a trailing \r silently diff --git a/integrations/cloud/README.md b/integrations/cloud/README.md index 24999902..0352d6dd 100644 --- a/integrations/cloud/README.md +++ b/integrations/cloud/README.md @@ -42,6 +42,14 @@ consumed by the serve replica). There is no shared filesystem or database betwee environment, a storage account, and container app/job resources. - The `codesearch` container image published to a registry the platform can pull from. +> ⚠️ **Build locally, not via `az acr build`, on a Basic/Standard-SKU registry.** The +> builder stage compiles the release binary, then downloads and warms up the embedding +> model before tarring it — memory/disk-heavy on top of the compile. ACR's default build +> agent (Basic/Standard SKU; Agent Pools with bigger VMs need Premium) reliably fails at +> the `COPY --from=builder /models.tar.gz` step with `failed to create image: failed to +> get layer sha256:...: layer does not exist`, after a ~25 min compile — confirmed twice, +> not a one-off. Build with local Docker Desktop and `docker push` to the registry instead. + ## Provisioning (generic) Replace every `<...>` placeholder with your own values. diff --git a/integrations/opencode/.gitignore b/integrations/opencode/.gitignore new file mode 100644 index 00000000..504afef8 --- /dev/null +++ b/integrations/opencode/.gitignore @@ -0,0 +1,2 @@ +node_modules/ +package-lock.json diff --git a/integrations/opencode/README.md b/integrations/opencode/README.md new file mode 100644 index 00000000..b120ad28 --- /dev/null +++ b/integrations/opencode/README.md @@ -0,0 +1,477 @@ +# OpenCode integration: making codesearch structural + +## The problem + +codesearch publishes usage instructions to every MCP client on connect (the +`initialize` handshake, see main [README § Agent Guidance](../../README.md#agent-guidance-making-agents-use-codesearch-not-grep)). +OpenCode surfaces those instructions and the model follows them reasonably +well. But they are **advisory** and **connection-scoped**: they cannot see the +host state that decides whether the preference actually holds up in practice. + +In OpenCode that shows up as several recurring failure modes: + +1. **Scope friction.** In multi-repo serve mode every tool call needs + `project=` or `group=`. The model has to guess the alias from the directory + name; when it guesses wrong it burns a turn on `scope_required`, and when it + guesses right it still may have picked the wrong project. +2. **Grep wins by default.** `grep`/`glob` are always loaded, zero-friction and + local. The instruction "prefer codesearch" loses to convenience, and an + **empty grep** (the exact case where the index would help) simply dead-ends + the turn. +3. **Worktrees and clones are invisible.** A git worktree is a separate + indexable repo. The model cannot tell that the current directory is + unregistered, so it greps a tree codesearch has never seen. +4. **The hub can be down.** `codesearch serve` is a local daemon. If it is not + running (or an MCP connect failed), the model keeps trying codesearch tools + and gets transport errors instead of falling back gracefully. +5. **Fresh edits lag the index.** The file watcher reindexes shortly after a + write; a query made in that window can miss the change and send the model + back to grep. +6. **Compaction loses structure.** A long session compacts, and the file + outlines that made navigation cheap are summarised away. + +The plugin below fixes these by adding what only the host knows: the working +directory, the session lifecycle, tool calls, and file edits. + +## The fix + +A self-contained [OpenCode v2](https://opencode.ai/docs/plugins/) plugin +(`codesearch.ts`, no imports, no runtime dependencies) that turns the +preference into behaviour: + +| Feature | Default | What it does | +|---|---|---| +| **Scope resolution** | on | Maps the session directory to a registered project alias (and its groups), from `~/.codesearch/repos.json` (relocatable via `CODESEARCH_HOME`) or a live `status` snapshot. | +| **Scope-aware guidance** | once per session | Injects a compact strategy block plus the resolved scope into system context, so the first tool call already knows `project=`. | +| **Zero-hit rescue** | on | When `grep`/`glob` returns nothing in an indexed repo, runs a literal codesearch query and appends the index hits to the tool result. | +| **Code-search-first guards** | `nudge` | `off`, `nudge` (one tip per session), `prune` (hide `grep`/`glob` from the model), or `block` (deny with the exact codesearch call to use). | +| **Hub health** | on | Probes `/healthz`, asks OpenCode to reload failed MCP servers, and can auto-start a local `codesearch serve` (opt-in). | +| **Unindexed warning** | on | Flags a registered repo with an empty or model-less index, so "no results" is not mistaken for "not there". | +| **Freshness note** | on | Tracks `file.edited` events and reminds the model that a just-edited file may lag the watcher's refresh. | +| **Compaction outlines** | on | Before compaction, captures `explore` outlines of recently edited files and injects them into the summary prompt. | +| **Commands** | on | `/codesearch `, `/codesearch-status`, `/codesearch-index`. | +| **`codesearch_scope` tool** | on | Lets the model ask which project/groups the current directory maps to, and whether the index is healthy. | +| **Skill** | on | Registers a `codesearch` skill with the tool-routing playbook and worked examples. | +| **Auto-recall** | off | Opt-in: runs a semantic search for the user message and injects the top chunks as background context. | + +Everything is **fail-open**: every hook is wrapped, guards only engage while +the hub is confirmed reachable and the repo is registered, and a plugin or +network failure degrades to plain OpenCode behaviour. Nothing here can block a +session or wedge the model. + +## Requirements + +- **OpenCode v2** (tested with 2.0.22). V1 is not supported. +- **A codesearch serve hub** reachable over HTTP (streamable MCP). The default + is `http://127.0.0.1:39725/mcp`; remote serve is supported with an API key. +- Nothing else: the plugin has no npm dependencies and does not need Node or + Bun on PATH (it uses the host's runtime and, when enabled, spawns the same + `codesearch` binary that runs your hub). + +Stdio-only setups (`codesearch mcp` without `serve`) do not expose the HTTP +endpoint this plugin needs. The plugin stays installed and inert there (and +says so in its logs); guards never fire, and the MCP server's own instructions +remain in effect. + +## Install + +The plugin is a single file. Drop it into OpenCode's plugin directory and +restart, or point at it from `opencode.jsonc`. + +### User scope (applies to every project) + +```bash +# macOS / Linux +mkdir -p ~/.config/opencode/plugins +cp integrations/opencode/codesearch.ts ~/.config/opencode/plugins/ +``` + +```powershell +# Windows / PowerShell +New-Item -ItemType Directory -Force "$env:USERPROFILE\.config\opencode\plugins" +Copy-Item integrations\opencode\codesearch.ts "$env:USERPROFILE\.config\opencode\plugins\" +``` + +### Project scope (this repository only) + +```bash +mkdir -p .opencode/plugins +cp integrations/opencode/codesearch.ts .opencode/plugins/ +``` + +### Or reference the path from config + +```jsonc +// ~/.config/opencode/opencode.jsonc +{ + "plugins": ["/absolute/path/to/codesearch.ts"] +} +``` + +OpenCode watches the plugin directories and reloads on change. If the plugin +does not appear, restart the service: + +```sh +opencode service restart +``` + +### Verify + +```sh +opencode plugin list # should list: codesearch local .../codesearch.ts +``` + +Then, inside a session, run `/codesearch-status`. A loaded plugin answers with +the hub URL, health, the directory's resolved project and its index state. + +### Uninstall + +Delete `codesearch.ts` (and optionally `~/.config/opencode/codesearch.json`) +and restart OpenCode. The plugin never installs or edits anything else. + +## Configuration + +Defaults live under `~/.config/opencode/codesearch.json` (override the path +with `CODESEARCH_CONFIG`). Values may use `{env:NAME}` placeholders. +Precedence, lowest to highest: + +1. built-in defaults +2. plugin options in `opencode.jsonc` (object form) +3. the config file +4. environment variables + +```jsonc +{ + // Optional. Usually auto-resolved (see below). + "url": "http://127.0.0.1:39725/mcp", + // Optional bearer token for a remote / authenticated serve. + "token": "{env:CODESEARCH_API_KEY}", + // Name of the MCP server entry in opencode.jsonc to mirror. + "mcpServer": "codesearch", + // Optional override for the registry (default: ~/.codesearch/repos.json, + // relocated wholesale by CODESEARCH_HOME). + "reposConfig": "", + "debug": false, + + "scope": { + "enabled": true, + // How often the scope+guidance block is injected: + // "session" (first message), "message" (every message), "off". + "inject": "session", + "includeGroups": true, + "siblings": true, + "maxSiblings": 12, + "warnUnindexed": true + }, + + "guidance": { + "enabled": true, + // Optional Markdown file (or inline text) replacing the built-in guidance. + "file": "", + "text": "" + }, + + "guards": { + // "off" | "nudge" | "prune" | "block" (see the guard section below). + "mode": "nudge", + "tools": ["grep", "glob"], + "rescue": true, + "rescueLimit": 5, + "rescueTimeoutMs": 3000 + }, + + "health": { + "enabled": true, + "intervalMs": 90000, + "initialDelayMs": 60000, + "maxBackoffMs": 900000, + "reconnect": true, + // Opt-in: start a local serve hub when it is not running. + "autoStart": false, + "startCommand": "codesearch serve --quiet" + }, + + "freshness": { "enabled": true, "maxFiles": 8 }, + "compaction": { "enabled": true, "maxFiles": 3, "timeoutMs": 4000, "budgetChars": 2400 }, + + // Opt-in auto-recall. + "recall": { "enabled": false, "limit": 3, "timeoutMs": 2500, "budgetChars": 1800 }, + + "commands": { "enabled": true, "indexCommand": "codesearch index" }, + "tools": { "scope": true }, + "skill": { "enabled": true, "autoinvoke": true }, + + "log": { "scope": false, "guidance": false, "guards": true, "rescue": true, "health": true, "recall": false, "commands": true } +} +``` + +### Environment variables + +| Variable | Default | Meaning | +|---|---|---| +| `CODESEARCH_URL` | – | Full MCP URL (`.../mcp`). Wins over every discovery step. | +| `CODESEARCH_SERVER` | – | Serve **base** URL (e.g. `http://127.0.0.1:39725`), same meaning as the Claude Code guard hooks use. `/mcp` is appended. | +| `CODESEARCH_API_KEY` | – | Bearer token for an authenticated/remote serve. | +| `CODESEARCH_CONFIG` | `~/.config/opencode/codesearch.json` | Config file path. | +| `CODESEARCH_REPOS_CONFIG` | `$CODESEARCH_HOME/repos.json` (`~/.codesearch` when unset) | Registry path (shared with the hub and the Claude Code hooks). | +| `CODESEARCH_MCP_SERVER` | `codesearch` | MCP entry name to mirror for URL/token. | +| `CODESEARCH_PLUGIN_GUARDS` | `nudge` | `off` / `nudge` / `prune` / `block`. | +| `CODESEARCH_PLUGIN_SCOPE` | `session` | `session` / `message` / `off`. | +| `CODESEARCH_PLUGIN_RESCUE` | `true` | Zero-hit rescue on/off. | +| `CODESEARCH_PLUGIN_RECALL` | `false` | Auto-recall on/off. | +| `CODESEARCH_PLUGIN_COMPACTION` | `true` | Compaction outlines on/off. | +| `CODESEARCH_PLUGIN_COMMANDS` | `true` | Slash commands on/off. | +| `CODESEARCH_PLUGIN_SKILL` | `true` | Skill registration on/off. | +| `CODESEARCH_PLUGIN_HEALTH` | `true` | Health probing on/off. | +| `CODESEARCH_PLUGIN_DEBUG` | `false` | Verbose plugin logs. | + +Settings are resolved **once, at plugin setup** (the host calls `setup()` when +the plugin loads). Editing `codesearch.json` or a `CODESEARCH_*` variable +mid-session therefore does not take effect until OpenCode restarts or the +plugin is reloaded. + +### Hub discovery order + +The plugin resolves the MCP endpoint in this order, first non-empty wins: + +1. `url` from config / `CODESEARCH_URL` +2. `CODESEARCH_SERVER` +3. the `url` of the MCP entry named by `mcpServer` in `opencode.jsonc` + (its `Authorization` header is used as the token, minus `Bearer`) +4. `~/.codesearch/serve_url`, or `$CODESEARCH_HOME/serve_url` when the global root is relocated (written by `codesearch serve`) +5. `http://127.0.0.1:39725/mcp` + +A base URL without `/mcp` is normalised by appending it, so pointing +`CODESEARCH_SERVER` at the hub root is enough. + +## Guards and rescue in detail + +`guards.mode` controls how strongly codesearch replaces `grep`/`glob` in a +**covered** directory (one whose path maps to a registered, indexed repo): + +- **`off`** — hooks are not even registered. Nothing changes. +- **`nudge`** (default) — greps work normally. The first successful + `grep`/`glob` in a session gets a one-line tip appended to its result, and an + **empty** grep/glob is rescued (below). +- **`prune`** — `grep` and `glob` are removed from the tool list for covered + sessions, so the model must use the codesearch tools. The scope block says + so explicitly. Everything else is untouched, and reading/editing files is + unaffected. +- **`block`** — `grep`/`glob` calls are denied with a message naming the exact + `project=` value and the codesearch calls to use instead. Denial happens + **only** while the hub is confirmed reachable (`/healthz` answered) and the + repo is registered; in any other state the call proceeds. This mirrors the + Claude Code `grep-guard` semantics and fails open the same way. + +**Zero-hit rescue** (part of `nudge` and `prune`, and independently +controlled by `guards.rescue`) is the highest-value, lowest-risk piece: it +only ever fires when a tool already returned nothing. For a plain-text pattern +it runs `search` with `mode="literal", phrase=true`; for a regex-shaped +pattern it uses `regex=true`. Hits are appended as metadata-style lines +(path/line/kind/signature), not full code, and the model is pointed at +`get_chunk` for the body: + +```text +[codesearch] grep returned nothing, but the index has 2 match(es) for "retryUpload" in project "my-service": + - src/uploader.ts:42 (Function) function retryUpload(job: Job, attempt: number) + - src/queue.ts:13 (Class) class UploadQueue +Use search/find/get_chunk for the full result. +``` + +Glob patterns that are pure filesystem wildcards (`**/*.ts`) are skipped; +there is nothing semantic to look up. + +## Commands + +| Command | What it does | +|---|---| +| `/codesearch ` | Runs a semantic search in the resolved project and injects the top hits as a prompt, with a pointer to `get_chunk`. Falls back to guidance if the directory is unregistered. | +| `/codesearch-status` | Probes health, refreshes the status snapshot, and reports hub URL, health, directory, resolved project, chunk/file counts, model and lock state, groups and hub repo count. | +| `/codesearch-index` | Runs `commands.indexCommand` (`codesearch index` by default) in the current directory, detached, then reports that indexing started. Use this to register an unregistered clone or worktree. | + +## The `codesearch_scope` tool and the skill + +`codesearch_scope` returns JSON for the current directory: + +```json +{ + "directory": "/work/my-service", + "project": "my-service", + "groups": ["platform"], + "registered": true, + "siblings": [], + "indexed": true, + "chunks": 4123, + "model": "embeddinggemma-q4", + "lockStatus": "warm", + "serveUrl": "http://127.0.0.1:39725/mcp", + "serveHealth": "ok" +} +``` + +Use it when the directory is unusual (a worktree, a multi-repo parent) or when +you want to confirm the index health before trusting a result. It is the one +piece of state the MCP server itself cannot see. + +The plugin also registers a **`codesearch` skill** containing the same routing +playbook as the guidance plus worked examples, so a session can pull the +strategy in deliberately. Disable with `skill.enabled: false`. + +## Health and auto-start + +The health runner probes the serve hub's unauthenticated `/healthz` endpoint +(any HTTP response counts as reachable; only connection-level failures count +as down), with exponential backoff while down. On failure it asks OpenCode to +reload its MCP servers (which re-establishes a failed `codesearch` MCP entry). +With `health.autoStart: true` and a loopback URL it also runs +`codesearch serve --quiet` once, detached, and keeps probing. + +While the hub is down, the injected scope block says so and explicitly allows +`grep` as a fallback; rescue skips its lookup (no timeout cost). + +## Compaction outlines (and optional recall) + +Before a session is compacted, the plugin collects the recently edited files +(tracked from `file.edited` events), fetches `explore kind="outline"` for up +to `compaction.maxFiles`, and appends a compact symbol list to the +compaction prompt, so file structure survives the summary: + +```text +# codesearch outlines (captured before compaction) +- src/uploader.ts: function retryUpload(job: Job, attempt: number):41; class UploadManager:88 +- src/queue.ts: class UploadQueue:13; function enqueue(job: Job):55 +``` + +**Auto-recall** (`recall.enabled`, default `false`) is the opt-in mirror of +the guidance injection: for each new user message that looks like a code +question, it runs a semantic search and injects the top `recall.limit` chunks, +truncated to `budgetChars`. It costs a lookup plus context on every turn, which +is why it is off by default. Label it as background context; it is code from +the index, not instructions. + +## Examples + +**1. Multi-repo scope, no detour.** A workspace registers `my-service`, +`billing-api` and `docs`; the session opens in `my-service`. + +```text +user> where does upload retry backoff live? +# plugin injects: project "my-service", group "platform" (cross-repo fan-out) +model> search(project:"my-service", query:"upload retry backoff") -> get_chunk(...) +``` + +Without the plugin, the first call is a guess: `project:"my_service"` or no +scope at all, and the turn pays for a `scope_required` round-trip. + +**2. Empty grep becomes a hit.** The model greps for an old function name: + +```text +model> grep(pattern:"retryUpload") +tool> [codesearch] grep returned nothing, but the index has 2 match(es) for "retryUpload" in project "my-service": ... +model> get_chunk(chunk_id: 7) +``` + +**3. Guard modes.** `prune` removes `grep`/`glob` from the tool list in +covered sessions; `block` returns: + +```text +codesearch: grep is disabled here — this repository is indexed as project "my-service". +Use the codesearch MCP tools instead: + - search { project: "my-service", query: "" } ... +``` + +Both fail open when the hub is down or the directory is unregistered. + +**4. A dead hub recovers.** `codesearch serve` stops or an MCP connect fails: + +```text +[codesearch] hub unreachable at http://127.0.0.1:39725/mcp: fetch failed +[codesearch] asked OpenCode to reload MCP servers +``` + +With `health.autoStart: true` the plugin starts the hub and logs when it comes +back; the scope block tells the model grep is acceptable until then. + +**5. A new worktree.** The session opens in an unregistered worktree of a +registered repo. The scope block says it is unregistered and points at +`/codesearch-index`; one command registers and indexes it (`codesearch index`, +which produces a separate index per worktree by design). + +**6. Compaction keeps the map.** After a long refactor, the compaction summary +carries the outline block above instead of losing every symbol location. + +## Why this exists alongside the MCP instructions + +The MCP instructions tell the model *what* to do. The plugin makes it +*true* in the host: + +- The server cannot know the session directory, so it cannot resolve + `project=`. The plugin can, because it runs inside the host. +- The server cannot see a `grep` call, let alone an empty one. +- The server cannot recover its own MCP connection or restart itself. +- The server cannot see file edits or pending compaction. + +Together they behave like the Claude Code hooks from +[`integrations/claude-code/`](../claude-code/README.md), but implemented in +the host's own plugin API instead of shell guards: no `jq`, no `curl`, no +per-call process spawn, and coverage decisions come from the same registry the +hub uses. + +## Troubleshooting + +- **Plugin not listed** — confirm the file is `~/.config/opencode/plugins/codesearch.ts` + (or referenced in `opencode.jsonc`), then `opencode service restart`. Look + for `failed to load plugin` and `codesearch` in OpenCode's log + (`~/.local/share/opencode/log/opencode.log`). +- **No scope / `project=null`** — the directory is not registered. `/codesearch-index` + runs `codesearch index`; verify with `codesearch index list` and inspect + `~/.codesearch/repos.json` (or your `CODESEARCH_REPOS_CONFIG`; `CODESEARCH_HOME` relocates the default). +- **Rescue never fires** — check `guards.rescue`, `guards.tools`, and health + (`/codesearch-status`). Rescue is skipped while the hub is down. +- **Block mode too strict** — `guards.mode: "nudge"` (or `prune`) is the + intended middle ground. Blocking deliberately requires a live hub. +- **Top-level `scope` tool missing / other plugins conflict** — the tool is + registered as `codesearch_scope` precisely to avoid generic names. +- **Remote serve** — set `url` (or `CODESEARCH_SERVER`) and `token` (or + `CODESEARCH_API_KEY`). `/healthz` stays probeable behind auth. +- **Skill/commands not visible** — they need an OpenCode build with skill and + command transforms (2.x). Registration failures are logged and non-fatal; + everything else keeps working. + +## Security notes + +- The plugin reads `opencode.jsonc`, its own config, and `repos.json`. It + sends network requests only to the resolved serve URL (`/mcp`, `/healthz`). +- **Auto-recall sends the current user message to the serve hub** and injects + retrieved code into the model context. It is off by default; enable it only + where that is acceptable. Treat injected chunks as data, not instructions. +- **Auto-start** is off by default. When enabled it runs + `health.startCommand` with your privileges; keep it pointed at + `codesearch serve`. +- Guards fail open. `block` mode never denies while the hub is unreachable or + the repo is unregistered, so a misconfigured guard cannot trap a session. +- No secrets are stored by the plugin; use `{env:...}` placeholders or the + environment for tokens, and keep the config file readable only by you. + +## Development + +The plugin is dependency-free at runtime. For type checking and the tests +(unit tests for the pure helpers and the health runner, plus an end-to-end +smoke test against a mock OpenCode host and MCP server): + +```bash +cd integrations/opencode +npm install # dev-only: typescript + @types/node +npm run typecheck # tsc --noEmit +npm run unit # node test/unit.ts — stripJsonc + HealthRunner (Node >= 23.6) +npm run smoke # node test/smoke.ts — end-to-end vs mock host/MCP (or: bun) +npm test # typecheck + unit + smoke +``` + +`test/unit.ts` covers the JSONC scanner (comments, string escapes, trailing +commas including comment-separated ones) and the health runner (probe +transitions, backoff/reconnect, recovery callback, stop, disabled mode). +`test/smoke.ts` covers scope resolution, guidance injection and deduplication, +zero-hit rescue, the one-time nudge, prune and block modes (including +fail-open for unregistered directories and an unreachable hub), compaction +outlines, the commands, the scope tool and the skill registration. diff --git a/integrations/opencode/codesearch.ts b/integrations/opencode/codesearch.ts new file mode 100644 index 00000000..2efca75b --- /dev/null +++ b/integrations/opencode/codesearch.ts @@ -0,0 +1,1863 @@ +/** + * codesearch — OpenCode plugin + * ============================ + * + * Makes the codesearch MCP server *structural* inside OpenCode instead of + * advisory: resolves the current directory to an indexed project, injects the + * usage guidance once per session, nudges (or prunes/blocks) grep/glob, rescues + * empty greps with index results, keeps the serve hub healthy, and adds slash + * commands, a scope tool, a skill and compaction assistance. + * + * The MCP server already publishes usage instructions on connect, but those are + * advisory and connection-scoped. This plugin adds what only the host knows: + * the working directory, the session lifecycle, tool calls and file edits. + * + * Design constraints (see README.md in this directory): + * - Self-contained: no imports, no runtime dependencies. The host executes + * this file as-is; fs/child_process come from `process.getBuiltinModule`. + * - Fail open: every hook is wrapped so a plugin or network failure can never + * break a session. Guards only block while the hub is confirmed reachable. + * - Generic: no assumption about repo names, groups or layout. Everything + * comes from `~/.codesearch/repos.json`, the serve hub, or the config file. + * + * Targets OpenCode v2 (`opencode` 2.x). Install: copy this file to + * `~/.config/opencode/plugins/codesearch.ts` and restart OpenCode. + */ + +/* ------------------------------------------------------------------ * + * Types (structural views; no @opencode/plugin import so the file runs + * as-is under the host's module loader) + * ------------------------------------------------------------------ */ + +type Loose = Record + +interface Registration { + dispose(): Promise +} + +interface SystemPart { + type: "text" + text: string + [key: string]: unknown +} + +interface PluginContext { + app?: { version?: string } + location?: { + directory?: string + workspaceID?: string + project?: { id?: string; canonical?: string } + } + options?: Record + session?: { + hook( + name: string, + callback: (event: Loose) => Promise | void, + options?: { providerID?: string }, + ): Promise + prompt?(input: Loose): Promise + context?(input: { sessionID: string }): Promise + } + tool?: { + hook(name: string, callback: (event: Loose) => Promise | void): Promise + transform(callback: (editor: ToolEditor) => void): Promise + } + command?: { + transform(callback: (editor: CommandEditor) => void): Promise + } + skill?: { + transform(callback: (editor: SkillEditor) => void): Promise + } + mcp?: { + list(): Promise + reload?(): Promise + } + event?: { + subscribe(options?: { signal?: AbortSignal }): AsyncIterable + } +} + +interface ToolEditor { + namespace(namespace: { name: string; description: string }): void + add(tool: Loose): void + get?(id: string): Loose | undefined + update?(id: string, update: (tool: Loose) => void): void + remove?(id: string): void +} + +interface CommandEditor { + add(definition: Loose): void +} + +interface SkillEditor { + add(skill: Loose): void + get?(id: string): Loose | undefined + update?(id: string, update: (skill: Loose) => void): void +} + +type GuardMode = "off" | "nudge" | "prune" | "block" + +interface CodeSearchSettings { + url: string + token: string + mcpServer: string + reposConfig: string + debug: boolean + scope: { + enabled: boolean + inject: "session" | "message" | "off" + includeGroups: boolean + siblings: boolean + maxSiblings: number + warnUnindexed: boolean + } + guidance: { enabled: boolean; file: string; text: string } + guards: { + mode: GuardMode + tools: string[] + rescue: boolean + rescueLimit: number + rescueTimeoutMs: number + } + health: { + enabled: boolean + intervalMs: number + initialDelayMs: number + maxBackoffMs: number + reconnect: boolean + autoStart: boolean + startCommand: string + } + freshness: { enabled: boolean; maxFiles: number } + compaction: { enabled: boolean; maxFiles: number; timeoutMs: number; budgetChars: number } + recall: { enabled: boolean; limit: number; timeoutMs: number; budgetChars: number } + commands: { enabled: boolean; indexCommand: string } + tools: { scope: boolean } + skill: { enabled: boolean; autoinvoke: boolean } + log: { + scope: boolean + guidance: boolean + guards: boolean + rescue: boolean + health: boolean + recall: boolean + commands: boolean + } +} + +interface ScopeInfo { + directory: string + project?: string + projectPath?: string + groups: string[] + siblings: string[] + registered: boolean + hasGit: boolean +} + +interface StatusRepo { + alias: string + project_path?: string + total_chunks?: number + total_files?: number + model?: string + lock_status?: string +} + +/* ------------------------------------------------------------------ * + * Constants + * ------------------------------------------------------------------ */ + +const DEFAULTS: CodeSearchSettings = { + url: "", + token: "", + mcpServer: "codesearch", + reposConfig: "", + debug: false, + scope: { + enabled: true, + inject: "session", + includeGroups: true, + siblings: true, + maxSiblings: 12, + warnUnindexed: true, + }, + guidance: { enabled: true, file: "", text: "" }, + guards: { + mode: "nudge", + tools: ["grep", "glob"], + rescue: true, + rescueLimit: 5, + rescueTimeoutMs: 3000, + }, + health: { + enabled: true, + intervalMs: 90_000, + initialDelayMs: 60_000, + maxBackoffMs: 900_000, + reconnect: true, + autoStart: false, + startCommand: "codesearch serve --quiet", + }, + freshness: { enabled: true, maxFiles: 8 }, + compaction: { enabled: true, maxFiles: 3, timeoutMs: 4000, budgetChars: 2400 }, + recall: { enabled: false, limit: 3, timeoutMs: 2500, budgetChars: 1800 }, + commands: { enabled: true, indexCommand: "codesearch index" }, + tools: { scope: true }, + skill: { enabled: true, autoinvoke: true }, + log: { + scope: false, + guidance: false, + guards: true, + rescue: true, + health: true, + recall: false, + commands: true, + }, +} + +const DEFAULT_SERVE_URL = "http://127.0.0.1:39725/mcp" +const PROTOCOL_VERSION = "2025-06-18" +const FALLBACK_PROTOCOL_VERSION = "2024-11-05" +const MAX_SEEN = 20_000 + +/** + * Built-in guidance. Deliberately strategy-only: per-tool parameter detail + * lives in the MCP tool schemas and is injected by the server's `initialize` + * instructions, so it is not duplicated here. + */ +const DEFAULT_GUIDANCE = `codesearch indexes this workspace and serves semantic code search over MCP. Prefer it over grep/glob for anything conceptual, cross-file, or symbol-shaped. + +Tool routing: +- search — concepts, unknown locations, mixed natural language + identifiers. Default mode is semantic (hybrid vector + BM25); use mode="literal" with regex=true or phrase=true for exact syntax. +- find — where a symbol is defined (kind="definition"), its call-sites (kind="usages"), a file's imports (kind="imports"), or a module's dependents (kind="dependents"). +- find_impact — precise transitive call sites before a rename or edit (SCIP: C#, TypeScript; on a "no backend" answer fall back to find kind="usages"). +- explore — outline a file's top-level symbols (kind="outline") or find chunks similar to a known hit (kind="similar"). +- get_chunk — read the code behind a search hit, without loading the whole file. +- status — index health and registered repos. + +Rules: +- Multi-repo serve mode requires a scope on every call except status: pass project="" (returned paths are the server's paths; read content via get_chunk, not the local filesystem), or group="" to fan out. +- Start broad with search, narrow with find/explore, read with get_chunk. Keep compact=true (the default) until you know which chunk you need. +- The serve hub watches files and refreshes indexes automatically; if a just-made change seems missing, retry the query once before falling back to grep.` + +/** Skill playbook: the same strategy plus worked examples. */ +const SKILL_CONTENT = `${DEFAULT_GUIDANCE} + +Examples: +- "Where is the upload retried?" -> search(project=..., query="upload retry backoff") -> get_chunk(top hit). +- "Who calls validateToken?" in a TypeScript repo -> find_impact(project=..., symbol_name="validateToken") -> rename/edit with the full caller list. +- "Add a field to the settings struct" -> find(project=..., symbol="Settings", kind="definition") -> find(project=..., symbol="Settings", kind="usages"). +- Exact syntax like "Vec" or "foo = null" -> search(project=..., mode="literal", regex=true, query="Vec<"). +- "How does this file relate to the rest?" -> explore(project=..., kind="outline", target=) -> explore(kind="similar", target=). +- Freshly edited file returning stale hits -> wait a moment, rerun the query; the watcher is reindexing.` + +/* ------------------------------------------------------------------ * + * Small utilities + * ------------------------------------------------------------------ */ + +function bool(value: string | undefined, fallback: boolean): boolean { + if (value === undefined || value === "") return fallback + return !/^(0|false|no|off)$/i.test(value) +} + +function truncate(input: string, max: number): string { + if (input.length <= max) return input + return input.slice(0, Math.max(0, max - 1)) + "…" +} + +function shortHash(input: string): string { + let h = 5381 + for (let i = 0; i < input.length; i++) h = ((h << 5) + h + input.charCodeAt(i)) | 0 + return (h >>> 0).toString(36) +} + +function isPlainObject(value: unknown): value is Loose { + return typeof value === "object" && value !== null && !Array.isArray(value) +} + +/** Deep-merge plain objects; arrays and scalars replace. */ +function mergeDeep(base: T, override: unknown): T { + if (!isPlainObject(override)) return base + const out: Loose = { ...(base as unknown as Loose) } + for (const [key, value] of Object.entries(override)) { + const current = out[key] + if (isPlainObject(current) && isPlainObject(value)) out[key] = mergeDeep(current, value) + else out[key] = value + } + return out as T +} + +function expandEnv(value: string): string { + return value.replace(/\{env:([A-Za-z_][A-Za-z0-9_]*)\}/g, (_m, name: string) => process.env[name] ?? "") +} + +function expandEnvDeep(value: T): T { + if (typeof value === "string") return expandEnv(value) as unknown as T + if (Array.isArray(value)) return value.map((v) => expandEnvDeep(v)) as unknown as T + if (isPlainObject(value)) { + const out: Loose = {} + for (const [k, v] of Object.entries(value)) out[k] = expandEnvDeep(v) + return out as unknown as T + } + return value +} + +/** Inline builtin loader: works under Node (getBuiltinModule) and Bun (require). */ +function builtin(name: string): any { + const p = process as unknown as { getBuiltinModule?: (n: string) => unknown } + if (typeof p.getBuiltinModule === "function") { + try { + const mod = p.getBuiltinModule(name) + if (mod) return mod + } catch { + /* fall through */ + } + } + const g = globalThis as unknown as { require?: (n: string) => unknown } + if (typeof g.require === "function") { + try { + return g.require(name) + } catch { + /* fall through */ + } + } + return undefined +} + +function homeDir(): string { + return process.env.HOME || process.env.USERPROFILE || "" +} + +function configDir(): string { + return process.env.XDG_CONFIG_HOME || `${homeDir()}/.config` +} + +/** Global codesearch root: $CODESEARCH_HOME, else ~/.codesearch (mirrors constants.rs `codesearch_home()`). */ +function codesearchHome(): string { + return process.env.CODESEARCH_HOME || `${homeDir()}/.codesearch` +} + +/** + * Strip `//` and block comments plus trailing commas from JSONC, honouring + * string literals. Enough for OpenCode's config files. + */ +/** + * Strip JSONC comments and trailing commas. Exported for `test/unit.ts`; the + * host consumes the default export only. + */ +export function stripJsonc(text: string): string { + let out = "" + let inString = false + let escaped = false + for (let i = 0; i < text.length; i++) { + const ch = text[i] + const next = text[i + 1] + if (inString) { + out += ch + if (escaped) escaped = false + else if (ch === "\\") escaped = true + else if (ch === '"') inString = false + continue + } + if (ch === '"') { + inString = true + out += ch + continue + } + if (ch === "/" && next === "/") { + while (i < text.length && text[i] !== "\n") i++ + out += "\n" + continue + } + if (ch === "/" && next === "*") { + i += 2 + while (i < text.length && !(text[i] === "*" && text[i + 1] === "/")) i++ + i++ + continue + } + if (ch === ",") { + // A trailing comma may sit before whitespace AND comments, e.g. + // "a": 1, // keep this member last + // } + // Skip both while looking ahead for the closing bracket. + let j = i + 1 + for (;;) { + while (j < text.length && /\s/.test(text[j])) j++ + if (text[j] === "/" && text[j + 1] === "/") { + while (j < text.length && text[j] !== "\n") j++ + continue + } + if (text[j] === "/" && text[j + 1] === "*") { + j += 2 + while (j < text.length && !(text[j] === "*" && text[j + 1] === "/")) j++ + j += 2 // skip the closing */ + continue + } + break + } + if (text[j] === "}" || text[j] === "]") continue // drop trailing comma + } + out += ch + } + return out +} + +function readJsonFile(path: string): Loose | undefined { + const fs = builtin("node:fs") + if (!fs || !path) return undefined + try { + const raw = fs.readFileSync(path, "utf8") + const parsed = JSON.parse(stripJsonc(raw)) + return isPlainObject(parsed) ? parsed : undefined + } catch { + return undefined + } +} + +function fileExists(path: string): boolean { + const fs = builtin("node:fs") + if (!fs || !path) return false + try { + fs.statSync(path) + return true + } catch { + return false + } +} + +function readTextFile(path: string): string | undefined { + const fs = builtin("node:fs") + if (!fs || !path) return undefined + try { + return fs.readFileSync(path, "utf8") + } catch { + return undefined + } +} + +/* ------------------------------------------------------------------ * + * Path helpers + * ------------------------------------------------------------------ */ + +function normalizePath(input: string): string { + let p = (input || "").trim() + if (!p) return "" + // Windows UNC prefix (\\?\C:\...) and backslashes. + p = p.replace(/^\\\\\?\\/, "") + p = p.replace(/\\/g, "/") + p = p.replace(/\/+$/, "") + // Collapse duplicate slashes (keep the leading two for UNC-style roots). + p = p.replace(/([^:])\/{2,}/g, "$1/") + if (process.platform === "win32") p = p.toLowerCase() + return p +} + +/** True when `child` is `parent` or lives under it. */ +function isUnder(child: string, parent: string): boolean { + const c = normalizePath(child) + const p = normalizePath(parent) + if (!c || !p) return false + return c === p || c.startsWith(p + "/") +} + +/** Path relative to `root`, or the original when not under it. */ +function relativeTo(path: string, root: string): string { + const p = normalizePath(path) + const r = normalizePath(root) + if (!p || !r) return path + if (p === r) return "." + if (p.startsWith(r + "/")) return p.slice(r.length + 1) + return path +} + +/* ------------------------------------------------------------------ * + * Configuration resolution + * ------------------------------------------------------------------ */ + +function opencodeConfigPath(): string { + const candidates = [ + `${configDir()}/opencode/opencode.jsonc`, + `${configDir()}/opencode/opencode.json`, + ] + for (const candidate of candidates) if (fileExists(candidate)) return candidate + return candidates[0] +} + +/** + * Read the `mcp` entry named `serverName` from the OpenCode config, supporting + * both the v2 shape (`mcp.servers.`) and the v1 shape (`mcp.`). + */ +function readMcpEntry(serverName: string): { url: string; authorization: string } { + const config = readJsonFile(opencodeConfigPath()) + if (!config) return { url: "", authorization: "" } + const mcp = isPlainObject(config.mcp) ? config.mcp : undefined + if (!mcp) return { url: "", authorization: "" } + const servers = isPlainObject(mcp.servers) ? mcp.servers : mcp + const entry = isPlainObject(servers[serverName]) ? servers[serverName] : undefined + if (!entry) return { url: "", authorization: "" } + const url = typeof entry.url === "string" ? expandEnv(entry.url) : "" + const headers = isPlainObject(entry.headers) ? entry.headers : undefined + const rawAuth = headers && typeof headers.Authorization === "string" ? expandEnv(headers.Authorization) : "" + const authorization = rawAuth.replace(/^Bearer\s+/i, "") + return { url, authorization } +} + +function resolveSettings(ctx: PluginContext): CodeSearchSettings { + let settings = mergeDeep(DEFAULTS, ctx.options ?? {}) + + const configPath = + process.env.CODESEARCH_CONFIG || `${configDir()}/opencode/codesearch.json` + const fileConfig = readJsonFile(configPath) + if (fileConfig) settings = mergeDeep(settings, expandEnvDeep(fileConfig)) + + const env = process.env + settings.url = env.CODESEARCH_URL ?? settings.url + settings.token = env.CODESEARCH_API_KEY ?? settings.token + settings.mcpServer = env.CODESEARCH_MCP_SERVER ?? settings.mcpServer + settings.reposConfig = env.CODESEARCH_REPOS_CONFIG ?? settings.reposConfig + settings.debug = bool(env.CODESEARCH_PLUGIN_DEBUG, settings.debug) + + if (env.CODESEARCH_PLUGIN_GUARDS) settings.guards.mode = env.CODESEARCH_PLUGIN_GUARDS as GuardMode + if (env.CODESEARCH_PLUGIN_SCOPE) settings.scope.inject = env.CODESEARCH_PLUGIN_SCOPE as CodeSearchSettings["scope"]["inject"] + if (env.CODESEARCH_PLUGIN_RESCUE) settings.guards.rescue = bool(env.CODESEARCH_PLUGIN_RESCUE, settings.guards.rescue) + if (env.CODESEARCH_PLUGIN_RECALL) settings.recall.enabled = bool(env.CODESEARCH_PLUGIN_RECALL, settings.recall.enabled) + if (env.CODESEARCH_PLUGIN_COMPACTION) settings.compaction.enabled = bool(env.CODESEARCH_PLUGIN_COMPACTION, settings.compaction.enabled) + if (env.CODESEARCH_PLUGIN_COMMANDS) settings.commands.enabled = bool(env.CODESEARCH_PLUGIN_COMMANDS, settings.commands.enabled) + if (env.CODESEARCH_PLUGIN_SKILL) settings.skill.enabled = bool(env.CODESEARCH_PLUGIN_SKILL, settings.skill.enabled) + if (env.CODESEARCH_PLUGIN_HEALTH) settings.health.enabled = bool(env.CODESEARCH_PLUGIN_HEALTH, settings.health.enabled) + + if (!["off", "nudge", "prune", "block"].includes(settings.guards.mode)) settings.guards.mode = "nudge" + if (!["session", "message", "off"].includes(settings.scope.inject)) settings.scope.inject = "session" + settings.guards.tools = (settings.guards.tools || []).map((t) => String(t).toLowerCase()) + + return settings +} + +function normalizeMcpUrl(value: string): string { + let v = (value || "").trim() + if (!v) return "" + if (!/^https?:\/\//i.test(v)) v = `http://${v}` + v = v.replace(/\/+$/, "") + if (!/\/mcp$/i.test(v)) v += "/mcp" + return v +} + +/** Resolve the serve URL: config/env > CODESEARCH_SERVER > MCP entry > serve_url file > default. */ +function resolveServeUrl(settings: CodeSearchSettings): string { + const mcpEntry = readMcpEntry(settings.mcpServer) + const serveUrlFile = readTextFile(`${codesearchHome()}/serve_url`)?.trim() ?? "" + const candidates = [ + settings.url, + process.env.CODESEARCH_SERVER ?? "", + mcpEntry.url, + serveUrlFile, + DEFAULT_SERVE_URL, + ] + for (const candidate of candidates) { + const normalized = normalizeMcpUrl(candidate) + if (normalized) return normalized + } + return DEFAULT_SERVE_URL +} + +function resolveToken(settings: CodeSearchSettings): string { + if (settings.token) return settings.token + const mcpEntry = readMcpEntry(settings.mcpServer) + return mcpEntry.authorization || "" +} + +/* ------------------------------------------------------------------ * + * MCP client (streamable HTTP, JSON-RPC) + * ------------------------------------------------------------------ */ + +interface CallOptions { + timeoutMs?: number + retry?: boolean +} + +class McpClient { + private sessionId: string | null = null + private connected = false + private connecting: Promise | null = null + private idSeq = 0 + private chain: Promise = Promise.resolve() + private protocolVersion = PROTOCOL_VERSION + private readonly url: string + private readonly token: string + private readonly debug: boolean + private readonly label: string + + constructor(url: string, token: string, debug: boolean, label: string) { + this.url = url + this.token = token + this.debug = debug + this.label = label + } + + private log(...args: unknown[]): void { + if (this.debug) console.log(`[codesearch:${this.label}]`, ...args) + } + + /** Serialise requests per client so reconnect/session state never races. */ + private serial(fn: () => Promise): Promise { + const run = this.chain.then(fn, fn) + this.chain = run.then( + () => undefined, + () => undefined, + ) + return run + } + + async call(tool: string, args: Record, options: CallOptions = {}): Promise { + const timeoutMs = options.timeoutMs ?? 30_000 + const retry = options.retry ?? true + return this.serial(async () => { + await this.connect() + const payload = { jsonrpc: "2.0", id: ++this.idSeq, method: "tools/call", params: { name: tool, arguments: args } } + try { + return this.resultOf(tool, await this.post(payload, timeoutMs)) + } catch (err) { + if (!retry) throw err + const message = err instanceof Error ? err.message : String(err) + if (/network|fetch failed|session|ECONN|socket|timed? ?out|abort|4[0-9][0-9]/i.test(message)) { + this.connected = false + this.sessionId = null + await this.connect() + return this.resultOf(tool, await this.post(payload, timeoutMs)) + } + throw err + } + }) + } + + private async connect(): Promise { + if (this.connected) return + if (this.connecting) return this.connecting + this.connecting = this.doConnect().finally(() => { + this.connecting = null + }) + return this.connecting + } + + private async doConnect(): Promise { + const attempt = async (version: string): Promise => { + const init = { + jsonrpc: "2.0", + id: 0, + method: "initialize", + params: { + protocolVersion: version, + capabilities: {}, + clientInfo: { name: "opencode-codesearch-plugin", version: "1.0.0" }, + }, + } + const { session, messages } = await this.postRaw(init, 15_000) + const first = messages.find((m) => (m as Loose).id === 0) as Loose | undefined + if (!first?.result) return false + this.sessionId = session + this.protocolVersion = version + await this.postRaw({ jsonrpc: "2.0", method: "notifications/initialized", params: {} }, 15_000) + return true + } + if (!(await attempt(this.protocolVersion)) && this.protocolVersion !== FALLBACK_PROTOCOL_VERSION) { + if (!(await attempt(FALLBACK_PROTOCOL_VERSION))) { + throw new Error(`codesearch initialize failed at ${this.url}`) + } + } + this.connected = true + this.log("connected", this.sessionId ? `session ${this.sessionId}` : "(stateless)") + } + + private async post(payload: Record, timeoutMs: number): Promise { + const { messages } = await this.postRaw(payload, timeoutMs) + return messages + } + + private async postRaw( + payload: Record, + timeoutMs: number, + ): Promise<{ session: string | null; messages: Loose[] }> { + const headers: Record = { + "content-type": "application/json", + accept: "application/json, text/event-stream", + } + if (this.token) headers.authorization = `Bearer ${this.token}` + if (this.sessionId) headers["mcp-session-id"] = this.sessionId + + const controller = new AbortController() + const timer = setTimeout(() => controller.abort(), timeoutMs) + // The timer (and its abort signal) must stay armed through the body read: + // `response.text()` is as capable of hanging as the response headers are + // (undici's ~300 s bodyTimeout), and clearing the timer early would leave + // the serial call chain blocked far past the requested timeout. + try { + const response = await fetch(this.url, { + method: "POST", + headers, + body: JSON.stringify(payload), + signal: controller.signal, + }) + if (!response.ok) throw new Error(`codesearch HTTP ${response.status} ${response.statusText}`) + const session = response.headers.get("mcp-session-id") + const body = await response.text() + const messages = parseMcpBody(body) as Loose[] + if (messages.length === 0 && payload.id !== undefined) { + throw new Error(`codesearch returned no JSON-RPC message for ${String(payload.method)}`) + } + return { session, messages } + } finally { + clearTimeout(timer) + } + } + + private resultOf(tool: string, messages: Loose[]): unknown { + const message = messages.find((m) => m.result || m.error) + if (!message) throw new Error(`No result for ${tool}`) + if (message.error) throw new Error(`codesearch ${tool}: ${message.error.message ?? message.error.code ?? "error"}`) + const result = message.result as Loose | undefined + if (result?.isError) { + const text = result.content?.[0]?.text || "unknown tool error" + throw new Error(`codesearch ${tool} failed: ${String(text).slice(0, 500)}`) + } + const text = (result?.content ?? []) + .filter((c: Loose) => c.type === "text" && typeof c.text === "string") + .map((c: Loose) => c.text as string) + .join("\n") + if (text.trim() === "") return undefined + try { + return JSON.parse(text) + } catch { + return text + } + } +} + +/** Parse a streamable-HTTP body (plain JSON or SSE `data:` lines). */ +function parseMcpBody(body: string): unknown[] { + const out: unknown[] = [] + const trimmed = body.trim() + if (trimmed.startsWith("{") || trimmed.startsWith("[")) { + try { + out.push(JSON.parse(trimmed)) + return out + } catch { + /* fall through to SSE parsing */ + } + } + for (const line of body.split(/\r?\n/)) { + const text = line.trim() + if (!text.startsWith("data:")) continue + const raw = text.slice(5).trim() + if (!raw) continue + try { + out.push(JSON.parse(raw)) + } catch { + /* ignore malformed frames */ + } + } + return out +} + +/* ------------------------------------------------------------------ * + * Registry + status cache + * ------------------------------------------------------------------ */ + +class RepoRegistry { + private repos = new Map() + private groups = new Map() + private loadedAt = 0 + private signature = "" + private readonly path: string + + constructor(path: string) { + this.path = path + } + + load(force = false): void { + const now = Date.now() + if (!force && now - this.loadedAt < 30_000) return + this.loadedAt = now + const data = readJsonFile(this.path) + const signature = data ? JSON.stringify(data) : "" + if (signature === this.signature && !force) return + this.signature = signature + const repos = new Map() + const groups = new Map() + if (data) { + const rawRepos = isPlainObject(data.repos) ? data.repos : {} + for (const [alias, path] of Object.entries(rawRepos)) { + if (typeof path === "string" && path) repos.set(alias, normalizePath(path)) + } + const rawGroups = isPlainObject(data.groups) ? data.groups : {} + for (const [name, members] of Object.entries(rawGroups)) { + if (Array.isArray(members)) groups.set(name, members.map(String)) + } + } + this.repos = repos + this.groups = groups + } + + get size(): number { + return this.repos.size + } + + /** Registered project whose path contains (or equals) `directory`. */ + projectFor(directory: string): { alias: string; path: string } | undefined { + this.load() + const dir = normalizePath(directory) + if (!dir) return undefined + let best: { alias: string; path: string } | undefined + for (const [alias, path] of this.repos) { + if (!isUnder(dir, path)) continue + if (!best || path.length > best.path.length) best = { alias, path } + } + return best + } + + /** Registered repos nested under `directory` (multi-repo workspace roots). */ + siblingsFor(directory: string): string[] { + this.load() + const dir = normalizePath(directory) + if (!dir) return [] + const out: string[] = [] + for (const [alias, path] of this.repos) { + if (isUnder(path, dir) && normalizePath(path) !== dir) out.push(alias) + } + return out.sort() + } + + groupsFor(alias: string): string[] { + this.load() + const out: string[] = [] + for (const [name, members] of this.groups) if (members.includes(alias)) out.push(name) + return out.sort() + } + + findAliasByPath(path: string): string | undefined { + this.load() + const target = normalizePath(path) + for (const [alias, repoPath] of this.repos) if (repoPath === target) return alias + return undefined + } +} + +/** Cached `status(kind="projects")` payload, used for scope fallback and health. */ +class StatusCache { + private repos: StatusRepo[] = [] + private groups: Record = {} + private fetchedAt = 0 + + async refresh(client: McpClient, timeoutMs = 10_000): Promise { + const result = (await client.call("status", { kind: "projects" }, { timeoutMs, retry: false })) as Loose | undefined + if (!result) return + if (Array.isArray(result.repos)) this.repos = result.repos as StatusRepo[] + if (isPlainObject(result.groups)) this.groups = result.groups as Record + this.fetchedAt = Date.now() + } + + get ageMs(): number { + return Date.now() - this.fetchedAt + } + + get isFresh(): boolean { + return this.fetchedAt > 0 + } + + get all(): StatusRepo[] { + return this.repos + } + + repo(alias: string): StatusRepo | undefined { + return this.repos.find((r) => r.alias === alias) + } + + projectFor(directory: string): { alias: string; path: string } | undefined { + const dir = normalizePath(directory) + if (!dir) return undefined + let best: { alias: string; path: string } | undefined + for (const repo of this.repos) { + if (!repo.project_path) continue + const path = normalizePath(repo.project_path) + if (!isUnder(dir, path)) continue + if (!best || path.length > best.path.length) best = { alias: repo.alias, path } + } + return best + } + + groupsFor(alias: string): string[] { + const out: string[] = [] + for (const [name, members] of Object.entries(this.groups)) if (members.includes(alias)) out.push(name) + return out.sort() + } + + siblingsFor(directory: string): string[] { + const dir = normalizePath(directory) + if (!dir) return [] + const out: string[] = [] + for (const repo of this.repos) { + if (!repo.project_path) continue + const path = normalizePath(repo.project_path) + if (isUnder(path, dir) && path !== dir) out.push(repo.alias) + } + return out.sort() + } +} + +/* ------------------------------------------------------------------ * + * Message helpers (new-user-message detection) + * ------------------------------------------------------------------ */ + +function messageText(message: Loose): string { + const parts = message?.parts + if (Array.isArray(parts)) { + return parts + .map((p: Loose) => (p && typeof p.text === "string" ? p.text : "")) + .filter(Boolean) + .join("\n") + } + if (typeof message?.content === "string") return message.content + if (Array.isArray(message?.content)) { + return message.content + .map((c: Loose) => (c && typeof c.text === "string" ? c.text : "")) + .filter(Boolean) + .join("\n") + } + return "" +} + +function roleOf(message: Loose): string { + return String(message?.info?.role ?? message?.role ?? "") +} + +function lastUserMessage(messages: Loose[]): { id: string; text: string } | null { + for (let i = messages.length - 1; i >= 0; i--) { + const message = messages[i] + if (roleOf(message) !== "user") continue + const id = String(message?.info?.id ?? message?.id ?? "") + const text = messageText(message) + if (!text.trim()) continue + return { id: id || shortHash(text), text } + } + return null +} + +/** Heuristic for "this user message is a question about code" (recall gate). */ +function isLikelyCodeQuestion(text: string): boolean { + const trimmed = text.trim() + if (trimmed.length < 20 || trimmed.length > 4000) return false + if (/^\//.test(trimmed)) return false + return ( + /\b(where|how|why|what|who|which|find|locate|implement|handle|call|use|flow|work|refactor|fix|add|change|rename|test)\b/i.test(trimmed) || + /[A-Za-z_][A-Za-z0-9_]*\(|::|->|\.\w+\b|_[a-z]/.test(trimmed) + ) +} + +/* ------------------------------------------------------------------ * + * Guidance and scope text + * ------------------------------------------------------------------ */ + +function buildScopePrelude(scope: ScopeInfo, extra: string[]): string { + const lines: string[] = [] + if (scope.project) { + lines.push(`- Current directory is indexed by codesearch as project "${scope.project}"${scope.projectPath ? ` (${scope.projectPath})` : ""}.`) + if (scope.groups.length) { + lines.push(`- Project group${scope.groups.length > 1 ? "s" : ""}: ${scope.groups.map((g) => `"${g}"`).join(", ")} (use group= for cross-repo fan-out).`) + } + } else if (scope.registered && scope.siblings.length) { + lines.push(`- This workspace contains ${scope.siblings.length} registered codesearch project(s): ${scope.siblings.join(", ")}. Pass project= for one, or group= to fan out.`) + } else if (scope.hasGit) { + lines.push(`- This git repository is not registered with codesearch. Register it with \`codesearch index\` (or the /codesearch-index command) to enable semantic search here.`) + } + for (const line of extra) lines.push(line) + return lines.length ? `codesearch scope:\n${lines.join("\n")}` : "" +} + +/* ------------------------------------------------------------------ * + * Health runner + * ------------------------------------------------------------------ */ + +/** + * Periodic `/healthz` probe with backoff and optional MCP reload. Exported for + * `test/unit.ts`; the host consumes the default export only. + */ +export class HealthRunner { + private timer: ReturnType | null = null + private stopped = false + private failures = 0 + state: "unknown" | "ok" | "down" = "unknown" + lastError = "" + private readonly ctx: PluginContext + private readonly url: string + private readonly settings: CodeSearchSettings + private readonly onRecovered: () => void + private readonly log: (...args: unknown[]) => void + private readonly warn: (...args: unknown[]) => void + + constructor( + ctx: PluginContext, + url: string, + settings: CodeSearchSettings, + onRecovered: () => void, + log: (...args: unknown[]) => void, + warn: (...args: unknown[]) => void, + ) { + this.ctx = ctx + this.url = url + this.settings = settings + this.onRecovered = onRecovered + this.log = log + this.warn = warn + } + + start(): void { + if (!this.settings.health.enabled) return + this.schedule(this.settings.health.initialDelayMs) + } + + stop(): void { + this.stopped = true + if (this.timer) clearTimeout(this.timer) + this.timer = null + } + + private schedule(ms: number): void { + if (this.stopped) return + const timer = (this.timer = setTimeout(() => void this.tick(), ms)) + ;(timer as unknown as { unref?: () => void }).unref?.() + } + + private async tick(): Promise { + if (this.stopped) return + const before = this.state + await this.probe() + if (before === "down" && this.state === "ok") { + this.log(`hub recovered at ${this.url}`) + this.onRecovered() + } + let delay = this.settings.health.intervalMs + if (this.state === "down") { + this.failures += 1 + delay = Math.min(this.settings.health.intervalMs * 2 ** (this.failures - 1), this.settings.health.maxBackoffMs) + if (this.settings.health.reconnect) await this.tryReconnect() + if (this.settings.health.autoStart && this.failures === 1) await this.tryAutoStart() + } else { + this.failures = 0 + } + this.schedule(delay) + } + + /** Liveness probe: any HTTP response means reachable; only network errors mean down. */ + async probe(): Promise { + const base = this.url.replace(/\/mcp\/?$/i, "") + const controller = new AbortController() + const timer = setTimeout(() => controller.abort(), 2000) + try { + await fetch(`${base}/healthz`, { signal: controller.signal }) + if (this.state !== "ok") this.log("hub reachable") + this.state = "ok" + this.lastError = "" + } catch (err) { + const message = err instanceof Error ? err.message : String(err) + if (this.state !== "down") this.warn(`hub unreachable at ${this.url}: ${message}`) + this.state = "down" + this.lastError = message + } finally { + clearTimeout(timer) + } + } + + private async tryReconnect(): Promise { + if (!this.settings.health.reconnect) return + try { + if (this.ctx.mcp && typeof this.ctx.mcp.reload === "function") { + await this.ctx.mcp.reload() + this.log("asked OpenCode to reload MCP servers") + } + } catch (err) { + this.warn(`MCP reload failed: ${err instanceof Error ? err.message : err}`) + } + } + + private async tryAutoStart(): Promise { + if (!/^https?:\/\/(127\.0\.0\.1|localhost|\[::1\])/i.test(this.url)) return + const childProcess = builtin("node:child_process") + if (!childProcess || !this.settings.health.startCommand.trim()) return + try { + const child = childProcess.spawn(this.settings.health.startCommand, { + cwd: this.ctx.location?.directory || process.cwd(), + shell: true, + detached: true, + stdio: "ignore", + }) + child.unref?.() + this.log(`started: ${this.settings.health.startCommand}`) + } catch (err) { + this.warn(`auto-start failed: ${err instanceof Error ? err.message : err}`) + } + } +} + +/* ------------------------------------------------------------------ * + * Guard helpers + * ------------------------------------------------------------------ */ + +function resultOfToolEvent(event: Loose): { output?: string; metadata?: Loose } { + const result = isPlainObject(event?.result) ? event.result : undefined + if (!result) return {} + const output = typeof result.output === "string" ? result.output : undefined + const metadata = isPlainObject(result.metadata) ? result.metadata : undefined + return { output, metadata } +} + +function looksEmptyResult(event: Loose): boolean { + const { output, metadata } = resultOfToolEvent(event) + if (metadata) { + for (const key of ["matches", "count", "numMatches", "total"]) { + if (typeof metadata[key] === "number" && metadata[key] === 0) return true + } + } + if (output === undefined) return false + const trimmed = output.trim() + if (trimmed === "") return true + return /^(no (files|matches|results) found|0 (matches|results)|no matches)\b/i.test(trimmed) +} + +function extractPattern(event: Loose): string { + const input = isPlainObject(event?.input) ? event.input : undefined + if (!input) return "" + for (const key of ["pattern", "query", "search"]) { + const value = input[key] + if (typeof value === "string" && value.trim()) return value.trim() + } + return "" +} + +const REGEX_META = /[\\^$.*+?()[\]{}|]/ + +function formatSearchHits(result: Loose | undefined, limit: number): string[] { + const results = Array.isArray(result?.results) ? (result!.results as Loose[]) : [] + const lines: string[] = [] + for (const hit of results.slice(0, limit)) { + const path = typeof hit.path === "string" ? hit.path : "?" + const line = typeof hit.start_line === "number" ? `:${hit.start_line + 1}` : "" + const kind = typeof hit.kind === "string" ? ` (${hit.kind})` : "" + const signature = typeof hit.signature === "string" && hit.signature ? ` ${truncate(hit.signature, 90)}` : "" + lines.push(` - ${path}${line}${kind}${signature}`) + } + return lines +} + +/* ------------------------------------------------------------------ * + * Plugin + * ------------------------------------------------------------------ */ + +export default { + id: "codesearch", + + async setup(ctx: PluginContext) { + const settings = resolveSettings(ctx) + const log = (...args: unknown[]) => console.log("[codesearch]", ...args) + const warn = (...args: unknown[]) => console.warn("[codesearch]", ...args) + const directory = normalizePath(ctx.location?.directory ?? "") + + const url = resolveServeUrl(settings) + const token = resolveToken(settings) + const registry = new RepoRegistry( + settings.reposConfig || `${codesearchHome()}/repos.json`, + ) + registry.load() + const status = new StatusCache() + + // Interactive client (rescue/commands/recall) and a background client + // (health/status/compaction assistance) so a slow background call can + // never queue ahead of an interactive one. + const client = new McpClient(url, token, settings.debug, "client") + const background = new McpClient(url, token, settings.debug, "background") + + const disposables: Registration[] = [] + const timers: Array> = [] + const controller = new AbortController() + + const logGuard = (...args: unknown[]) => { + if (settings.log.guards) log(...args) + } + const logRescue = (...args: unknown[]) => { + if (settings.log.rescue) log(...args) + } + const logScope = (...args: unknown[]) => { + if (settings.log.scope) log(...args) + } + + if (settings.debug) log(`loaded in ${directory || "(unknown directory)"}; serve ${url}`) + + /* ---------------- scope resolution ---------------- */ + + const scopeCache = { at: 0, value: undefined as ScopeInfo | undefined } + + function resolveScope(): ScopeInfo { + const now = Date.now() + if (scopeCache.value && now - scopeCache.at < 15_000) return scopeCache.value + + registry.load() + const dir = directory + let project = dir ? registry.projectFor(dir) : undefined + if (!project && status.isFresh && dir) project = status.projectFor(dir) + + let groups: string[] = [] + if (project) { + groups = registry.groupsFor(project.alias) + if (!groups.length && status.isFresh) groups = status.groupsFor(project.alias) + } + + let siblings: string[] = [] + if (!project && dir) { + siblings = registry.siblingsFor(dir) + if (!siblings.length && status.isFresh) siblings = status.siblingsFor(dir) + siblings = siblings.slice(0, settings.scope.maxSiblings) + } + + const hasGit = dir ? fileExists(`${dir}/.git`) : false + const value: ScopeInfo = { + directory: dir, + project: project?.alias, + projectPath: project?.path, + groups: settings.scope.includeGroups ? groups : [], + siblings: settings.scope.siblings ? siblings : [], + registered: !!project, + hasGit, + } + scopeCache.at = now + scopeCache.value = value + return value + } + + /** Repo alias coverage: for guards and rescue. Uses the plugin's location. */ + function coveredAlias(): string | undefined { + return resolveScope().project + } + + /* ---------------- health + status refresh ---------------- */ + + const refreshStatus = async (): Promise => { + try { + await status.refresh(background) + scopeCache.at = 0 // pick up registry changes discovered via status + } catch (err) { + if (settings.debug) warn(`status refresh failed: ${err instanceof Error ? err.message : err}`) + } + } + + const health = new HealthRunner( + ctx, + url, + settings, + () => { + void refreshStatus() + }, + log, + warn, + ) + + // Startup probe + first status refresh, off the critical path. Gated on + // `health.enabled` so a disabled health runner performs no `/healthz` + // probe and opens no MCP `status` session at startup — the periodic + // status timer below is gated the same way. + if (settings.health.enabled) { + void health.probe().then(() => void refreshStatus()) + } + + /* ---------------- freshness (file edits) ---------------- */ + + const editedPaths = new Map() + const recordEdited = (path: string): void => { + const normalized = normalizePath(path) + if (!normalized) return + if (!/\./.test(normalized)) return // skip directories / odd values + editedPaths.set(normalized, Date.now()) + while (editedPaths.size > 64) { + const oldest = editedPaths.keys().next().value as string | undefined + if (oldest === undefined) break + editedPaths.delete(oldest) + } + } + + const collectEditedFromEvent = (event: Loose): void => { + const data = isPlainObject(event?.data) ? event.data : event + for (const key of ["file", "path", "filePath", "filename"]) { + const value = data?.[key] + if (typeof value === "string") recordEdited(value) + } + } + + if (settings.freshness.enabled && ctx.event) { + const loop = (async () => { + try { + for await (const event of ctx.event!.subscribe({ signal: controller.signal })) { + try { + const type = String((event as Loose)?.type ?? "") + if (type.startsWith("file.")) collectEditedFromEvent(event as Loose) + } catch { + /* ignore malformed events */ + } + } + } catch (err) { + if (!(err instanceof Error && err.name === "AbortError")) { + if (settings.debug) warn(`event loop ended: ${err instanceof Error ? err.message : err}`) + } + } + })() + void loop + } + + function recentEdits(max: number): string[] { + const entries = [...editedPaths.entries()].sort((a, b) => b[1] - a[1]) + return entries.map(([path]) => path).slice(0, max) + } + + /* ---------------- guidance text ---------------- */ + + function loadGuidance(): string { + if (!settings.guidance.enabled) return "" + const inline = settings.guidance.text.trim() + if (inline) return inline + const path = expandEnv(settings.guidance.file).trim() + if (path) { + const text = readTextFile(path)?.trim() + if (text) return text + } + return DEFAULT_GUIDANCE + } + + const guidanceText = loadGuidance() + + /* ---------------- context hook (scope, guidance, prune, recall) ---------------- */ + + const seenMessages = new Set() + const seenSessions = new Set() + const nudged = new Set() + + function markSeen(set: Set, key: string): boolean { + if (set.has(key)) return false + set.add(key) + if (set.size > MAX_SEEN) set.clear() + return true + } + + async function onContext(event: Loose): Promise { + try { + const sessionID = String(event?.sessionID ?? "unknown") + const userMessage = lastUserMessage((event?.messages ?? []) as Loose[]) + if (!userMessage || !userMessage.text.trim()) return + const messageKey = `${sessionID}:${userMessage.id}` + if (!markSeen(seenMessages, messageKey)) return + const firstForSession = !seenSessions.has(sessionID) + seenSessions.add(sessionID) + if (seenSessions.size > MAX_SEEN) seenSessions.clear() + + const scope = resolveScope() + const system = Array.isArray(event?.system) ? (event.system as SystemPart[]) : undefined + if (!system) return + + // 1. Opt-in auto-recall: inject index context for the user message. + if (settings.recall.enabled && scope.project && isLikelyCodeQuestion(userMessage.text)) { + await injectRecall(system, sessionID, userMessage.text, scope) + } + + // 2. Prune guard: hide grep/glob from the model when enforcement is + // structural, so the first move is a codesearch call. Like block + // mode, only engage while the hub is confirmed reachable — + // otherwise the removed tools would contradict the "grep/glob is an + // acceptable fallback" guidance injected below. + const pruneActive = + settings.guards.mode === "prune" && !!scope.project && health.state === "ok" + if (pruneActive && isPlainObject(event.tools)) { + for (const tool of settings.guards.tools) delete (event.tools as Loose)[tool] + } + + // 3. Guidance + scope, once per session (or per message). + const injectGuidance = settings.scope.enabled || guidanceText + const wantsThisMessage = + settings.scope.inject === "message" || (settings.scope.inject === "session" && firstForSession) + if (injectGuidance && wantsThisMessage) { + const extra: string[] = [] + if (pruneActive) { + extra.push(`- grep and glob are intentionally unavailable in this project (codesearch guard mode "prune"); use the codesearch tools for discovery.`) + } + if (health.state === "down" && !pruneActive) { + extra.push(`- The codesearch serve hub is unreachable right now; grep/glob is an acceptable fallback until it recovers.`) + } + if (freshUnindexedWarning(scope)) { + extra.push(`- The registered index for "${scope.project}" is empty or was built with an unknown model; searches will miss until \`codesearch index\` refreshes it.`) + } + if (settings.freshness.enabled) { + const edits = recentEdits(settings.freshness.maxFiles) + if (edits.length) { + const shown = edits.map((p) => relativeTo(p, scope.projectPath || directory) || p) + extra.push(`- Files edited this session: ${shown.join(", ")}. The serve hub reindexes on write; if a query misses a very recent change, retry it once.`) + editedPaths.clear() + } + } + // Scope text is opt-out via `scope.enabled`; guidance is injected + // independently below, so disabling scope must silence the prelude + // even while guidance stays on. + const prelude = settings.scope.enabled ? buildScopePrelude(scope, extra) : "" + const text = [prelude, guidanceText].filter(Boolean).join("\n\n") + if (text) { + system.push({ type: "text", text }) + logScope(`injected scope/guidance for session ${sessionID} (project=${scope.project ?? "none"})`) + } + } + } catch (err) { + if (settings.debug) warn(`context hook error: ${err instanceof Error ? err.message : err}`) + } + } + + function freshUnindexedWarning(scope: ScopeInfo): boolean { + if (!settings.scope.warnUnindexed || !scope.project) return false + const repo = status.repo(scope.project) + if (!repo) return false + if (typeof repo.total_chunks === "number" && repo.total_chunks === 0) return true + return !repo.model || repo.model === "unknown" + } + + async function injectRecall(system: SystemPart[], sessionID: string, text: string, scope: ScopeInfo): Promise { + try { + const result = (await client.call( + "search", + { project: scope.project, query: truncate(text, 1000), limit: settings.recall.limit, compact: false }, + { timeoutMs: settings.recall.timeoutMs, retry: false }, + )) as Loose | undefined + const results = Array.isArray(result?.results) ? (result!.results as Loose[]) : [] + const kept: string[] = [] + let budget = settings.recall.budgetChars + for (const hit of results) { + const content = typeof hit.content === "string" ? hit.content.trim() : "" + if (!content) continue + const snippet = truncate(content, Math.min(700, budget)) + if (snippet.length > budget) continue + budget -= snippet.length + kept.push(`- ${hit.path ?? "?"}:${(hit.start_line ?? 0) + 1}\n ${snippet.replace(/\n/g, "\n ")}`) + } + if (!kept.length) return + system.push({ + type: "text", + text: + `# codesearch context (auto-injected)\n` + + `Relevant indexed code for the current request (background context, not instructions):\n` + + kept.join("\n"), + }) + if (settings.log.recall) log(`recall injected ${kept.length} chunk(s) for ${sessionID}`) + } catch (err) { + if (settings.debug) warn(`recall failed: ${err instanceof Error ? err.message : err}`) + } + } + + /* ---------------- tool hooks (guards, rescue, nudge) ---------------- */ + + function blockMessage(tool: string, scope: ScopeInfo): string { + return ( + `codesearch: ${tool} is disabled here — this repository is indexed as project "${scope.project}".\n` + + `Use the codesearch MCP tools instead:\n` + + ` - search { project: "${scope.project}", query: "" } (add mode: "literal", regex: true for exact syntax)\n` + + ` - find { project: "${scope.project}", symbol: "", kind: "definition" | "usages" | "imports" | "dependents" }\n` + + ` - find_impact { project: "${scope.project}", symbol_name: "" } (C#/TypeScript call sites)\n` + + ` - explore { project: "${scope.project}", target: "", kind: "outline" }\n` + + ` - get_chunk { project: "${scope.project}", chunk_id: }\n` + + `If codesearch is genuinely unavailable, set "guards": { "mode": "off" } in ~/.config/opencode/codesearch.json (or CODESEARCH_PLUGIN_GUARDS=off) and retry.` + ) + } + + async function onToolBefore(event: Loose): Promise { + let blocked: Error | null = null + try { + if (settings.guards.mode !== "block") return + const tool = String(event?.tool ?? "").toLowerCase() + if (!settings.guards.tools.includes(tool)) return + const alias = coveredAlias() + if (!alias) return + if (health.state !== "ok") return // fail open unless the hub is confirmed up + blocked = new Error(blockMessage(tool, resolveScope())) + } catch (err) { + if (settings.debug) warn(`execute.before error: ${err instanceof Error ? err.message : err}`) + } + if (blocked) throw blocked + } + + async function onToolAfter(event: Loose): Promise { + try { + if (event?.status && event.status !== "completed") return + const tool = String(event?.tool ?? "").toLowerCase() + if (!settings.guards.tools.includes(tool)) return + const scope = resolveScope() + if (!scope.project) return + const result = isPlainObject(event?.result) ? event.result : undefined + if (!result) return + + if (looksEmptyResult(event)) { + await rescueEmptyResult(event, result, scope) + } else { + nudgeOnce(event, result, scope) + } + } catch (err) { + if (settings.debug) warn(`execute.after error: ${err instanceof Error ? err.message : err}`) + } + } + + async function rescueEmptyResult(event: Loose, result: Loose, scope: ScopeInfo): Promise { + if (!settings.guards.rescue) return + if (health.state === "down") return + const pattern = extractPattern(event) + if (!pattern || pattern.length > 500) return + // Glob patterns are not search queries: skip when the pattern is just a + // filesystem wildcard ("**/*.ts") — there is nothing semantic to look up. + if (String(event?.tool ?? "").toLowerCase() === "glob" && /[*?[\]{}]/.test(pattern)) return + const plain = !REGEX_META.test(pattern) + try { + const hits = (await client.call( + "search", + { + project: scope.project, + query: pattern, + mode: "literal", + ...(plain ? { phrase: true } : { regex: true }), + limit: settings.guards.rescueLimit, + compact: true, + }, + { timeoutMs: settings.guards.rescueTimeoutMs, retry: false }, + )) as Loose | undefined + const lines = formatSearchHits(hits, settings.guards.rescueLimit) + if (!lines.length) return + const notice = + `\n[codesearch] ${String(event?.tool ?? "grep")} returned nothing, but the index has ` + + `${lines.length >= settings.guards.rescueLimit ? `${settings.guards.rescueLimit}+` : lines.length} ` + + `match(es) for ${plain ? `"${pattern}"` : `/${pattern}/`} in project "${scope.project}":\n` + + lines.join("\n") + + `\nUse search/find/get_chunk for the full result.` + const existing = typeof result.output === "string" ? result.output : "" + result.output = existing + notice + logRescue(`rescued empty ${String(event?.tool ?? "grep")} (${scope.project})`) + } catch (err) { + if (settings.debug) warn(`rescue failed: ${err instanceof Error ? err.message : err}`) + } + } + + function nudgeOnce(event: Loose, result: Loose, scope: ScopeInfo): void { + if (settings.guards.mode === "off") return + const sessionID = String(event?.sessionID ?? "unknown") + if (!markSeen(nudged, sessionID)) return + const existing = typeof result.output === "string" ? result.output : "" + result.output = + existing + + `\n[codesearch] tip: this repository is indexed as project "${scope.project}" — ` + + `codesearch search is faster and more token-efficient than ${String(event?.tool ?? "grep")} for cross-file or symbol lookups.` + logGuard(`nudged session ${sessionID} after ${String(event?.tool ?? "grep")}`) + } + + /* ---------------- commands ---------------- */ + + async function promptSession(sessionID: string, prompt: Loose, text: string): Promise { + if (!ctx.session?.prompt) { + warn("session.prompt is unavailable; cannot deliver command output") + return + } + await ctx.session.prompt({ ...prompt, sessionID, text, delivery: (prompt as Loose)?.delivery ?? "queue" }) + } + + function formatStatusText(scope: ScopeInfo): string { + const lines: string[] = [] + lines.push(`codesearch serve: ${url}`) + lines.push(`health: ${health.state}${health.lastError ? ` (${health.lastError})` : ""}`) + lines.push(`directory: ${directory || "?"}`) + if (scope.project) { + const repo = status.repo(scope.project) + lines.push( + `project: ${scope.project}` + + (repo + ? ` — ${repo.total_chunks ?? "?"} chunks, ${repo.total_files ?? "?"} files, model=${repo.model ?? "?"}, state=${repo.lock_status ?? "?"}` + : " (not in the latest status snapshot)"), + ) + } else if (scope.siblings.length) { + lines.push(`workspace projects: ${scope.siblings.join(", ")}`) + } else { + lines.push(`project: not registered${scope.hasGit ? " (git repo — run /codesearch-index to register)" : ""}`) + } + if (scope.groups.length) lines.push(`groups: ${scope.groups.join(", ")}`) + if (status.isFresh) lines.push(`hub repos: ${status.all.length}`) + return lines.join("\n") + } + + async function registerCommands(): Promise { + if (!settings.commands.enabled || !ctx.command?.transform) return + const registration = await ctx.command.transform((editor) => { + editor.add({ + name: "codesearch", + description: "Semantic code search (codesearch) — query the index and inject the top hits", + execute: async (invocation: Loose) => { + const sessionID = String(invocation?.sessionID ?? "") + const prompt = isPlainObject(invocation?.prompt) ? invocation.prompt : {} + const query = String(prompt.text ?? invocation?.arguments ?? "").trim() + const scope = resolveScope() + if (!query) { + await promptSession(sessionID, prompt, "Usage: /codesearch ") + return + } + if (!scope.project) { + await promptSession( + sessionID, + prompt, + `codesearch: this directory is not registered with a codesearch project, so there is nothing to search yet. Run /codesearch-index first.`, + ) + return + } + try { + const hits = (await client.call( + "search", + { project: scope.project, query, limit: 8 }, + { timeoutMs: 8_000, retry: false }, + )) as Loose | undefined + const lines = formatSearchHits(hits, 8) + await promptSession( + sessionID, + prompt, + lines.length + ? `codesearch results for "${query}" (project "${scope.project}"):\n${lines.join("\n")}\n\nFetch full code with get_chunk, or refine with find/explore.` + : `codesearch returned no results for "${query}" in project "${scope.project}". Try different wording, or mode literal with regex=true for exact syntax.`, + ) + if (settings.log.commands) log(`/codesearch "${truncate(query, 80)}" -> ${lines.length} hit(s)`) + } catch (err) { + await promptSession( + sessionID, + prompt, + `codesearch search failed: ${err instanceof Error ? err.message : String(err)}`, + ) + } + }, + }) + + editor.add({ + name: "codesearch-status", + description: "Show codesearch serve health, current project scope and index state", + execute: async (invocation: Loose) => { + const sessionID = String(invocation?.sessionID ?? "") + const prompt = isPlainObject(invocation?.prompt) ? invocation.prompt : {} + await health.probe() + await refreshStatus() + scopeCache.at = 0 + await promptSession(sessionID, prompt, formatStatusText(resolveScope())) + }, + }) + + editor.add({ + name: "codesearch-index", + description: "Register and index the current directory with codesearch (runs in the background)", + execute: async (invocation: Loose) => { + const sessionID = String(invocation?.sessionID ?? "") + const prompt = isPlainObject(invocation?.prompt) ? invocation.prompt : {} + const childProcess = builtin("node:child_process") + const command = settings.commands.indexCommand.trim() + if (!command) { + await promptSession(sessionID, prompt, "codesearch: commands.indexCommand is empty; nothing to run.") + return + } + if (!childProcess) { + await promptSession(sessionID, prompt, `codesearch: cannot spawn processes here. Run \`${command}\` in ${directory} manually.`) + return + } + try { + const child = childProcess.spawn(command, { + cwd: directory || process.cwd(), + shell: true, + detached: true, + stdio: "ignore", + }) + child.unref?.() + await promptSession( + sessionID, + prompt, + `codesearch indexing started in ${directory} (\`${command}\`). It runs in the background; check /codesearch-status in a minute (large repos can take longer).`, + ) + if (settings.log.commands) log(`/codesearch-index started: ${command}`) + } catch (err) { + await promptSession(sessionID, prompt, `codesearch index failed to start: ${err instanceof Error ? err.message : String(err)}`) + } + }, + }) + }) + disposables.push(registration) + } + + /* ---------------- scope tool ---------------- */ + + async function registerScopeTool(): Promise { + if (!settings.tools.scope || !ctx.tool?.transform) return + const registration = await ctx.tool.transform((editor) => { + editor.add({ + name: "codesearch_scope", + description: + "Return the codesearch scope for the current directory: project alias, groups, index state, serve health. " + + "Use it when you are unsure which project= value to pass to codesearch MCP tools.", + input: { type: "object", properties: {}, additionalProperties: false }, + execute: async () => { + await refreshStatus().catch(() => undefined) + scopeCache.at = 0 + const scope = resolveScope() + const repo = scope.project ? status.repo(scope.project) : undefined + const info = { + directory: scope.directory, + project: scope.project ?? null, + groups: scope.groups, + registered: scope.registered, + siblings: scope.siblings, + indexed: repo ? (repo.total_chunks ?? 0) > 0 : undefined, + chunks: repo?.total_chunks, + model: repo?.model, + lockStatus: repo?.lock_status, + serveUrl: url, + serveHealth: health.state, + } + return { content: JSON.stringify(info, null, 2) } + }, + }) + }) + disposables.push(registration) + } + + /* ---------------- skill ---------------- */ + + async function registerSkill(): Promise { + if (!settings.skill.enabled || !ctx.skill?.transform) return + const registration = await ctx.skill.transform((editor) => { + editor.add({ + id: "codesearch", + name: "codesearch navigation", + description: + "Use the codesearch MCP tools (search, find, find_impact, explore, get_chunk) to navigate code: " + + "project scope rules, tool routing, and exact-syntax patterns.", + path: "codesearch-plugin/skill.md", + content: SKILL_CONTENT, + }) + if (settings.skill.autoinvoke && typeof editor.get === "function" && typeof editor.update === "function") { + const existing = editor.get("codesearch") + if (existing) editor.update("codesearch", (skill: Loose) => void (skill.autoinvoke = true)) + } + }) + disposables.push(registration) + } + + /* ---------------- compaction assist ---------------- */ + + function formatOutline(target: string, result: unknown): string { + const entries = Array.isArray(result) ? (result as Loose[]) : [] + const symbols = entries + .filter((entry) => entry && typeof entry.signature === "string" && entry.signature) + .filter((entry) => !/^imports\b/i.test(String(entry.signature))) + .slice(0, 12) + .map((entry) => `${truncate(String(entry.signature), 100)}:${(entry.start_line ?? 0) + 1}`) + const label = target.replace(/\\/g, "/") + return symbols.length ? `- ${label}: ${symbols.join("; ")}` : "" + } + + async function onCompaction(event: Loose): Promise { + try { + if (!settings.compaction.enabled) return + const scope = resolveScope() + if (!scope.project || !Array.isArray(event?.system)) return + const candidates: string[] = [] + for (const path of recentEdits(settings.compaction.maxFiles * 2)) { + if (!candidates.includes(path)) candidates.push(path) + } + if (!candidates.length) return + const deadline = Date.now() + settings.compaction.timeoutMs + const outlines: string[] = [] + let budget = settings.compaction.budgetChars + for (const path of candidates) { + if (outlines.length >= settings.compaction.maxFiles || Date.now() >= deadline || budget <= 0) break + try { + // Strip the project root the same way `relativeTo` does for the + // freshness notice: it normalizes both sides (including the + // win32 lowercase rule), so absolute paths, alias-prefixed paths + // and already-relative paths all resolve consistently. Stripping + // a literal alias prefix here silently produced absolute targets + // on Windows, where the case-normalized path never matched. + const target = relativeTo(path, scope.projectPath || directory) || path + const result = await background.call( + "explore", + { project: scope.project, target, kind: "outline" }, + { timeoutMs: Math.max(500, deadline - Date.now()), retry: false }, + ) + const line = formatOutline(target, result) + if (line) { + outlines.push(line) + budget -= line.length + } + } catch { + /* best effort */ + } + } + if (!outlines.length) return + ;(event.system as SystemPart[]).push({ + type: "text", + text: + `# codesearch outlines (captured before compaction)\n` + + `Pre-compaction structure of recently edited files (from the code index):\n` + + outlines.join("\n"), + }) + if (settings.log.scope) log(`compaction outlines: ${outlines.length} file(s)`) + } catch (err) { + if (settings.debug) warn(`compaction hook error: ${err instanceof Error ? err.message : err}`) + } + } + + /* ---------------- register everything (fail soft) ---------------- */ + + const safeRegister = async (name: string, fn: () => Promise): Promise => { + try { + await fn() + if (settings.debug) log(`registered: ${name}`) + } catch (err) { + warn(`could not register ${name}: ${err instanceof Error ? err.message : err}`) + } + } + + if (ctx.session?.hook) { + await safeRegister("session context hook", async () => { + disposables.push(await ctx.session!.hook("context", onContext)) + }) + } + if (ctx.tool?.hook && settings.guards.mode !== "off") { + await safeRegister("tool execute.before hook", async () => { + disposables.push(await ctx.tool!.hook("execute.before", onToolBefore)) + }) + await safeRegister("tool execute.after hook", async () => { + disposables.push(await ctx.tool!.hook("execute.after", onToolAfter)) + }) + } + if (settings.compaction.enabled && ctx.session?.hook) { + await safeRegister("compaction hook", async () => { + disposables.push(await ctx.session!.hook("compaction", onCompaction)) + }) + } + await safeRegister("commands", registerCommands) + await safeRegister("scope tool", registerScopeTool) + await safeRegister("skill", registerSkill) + + /* ---------------- timers ---------------- */ + + if (settings.health.enabled) { + health.start() + const statusTimer = setInterval(() => void refreshStatus(), 10 * 60_000) + ;(statusTimer as unknown as { unref?: () => void }).unref?.() + timers.push(statusTimer) + } + + log(`ready (project=${resolveScope().project ?? "none"}, guards=${settings.guards.mode}, serve=${url})`) + + return async () => { + controller.abort() + health.stop() + for (const timer of timers) clearTimeout(timer) + for (const registration of disposables) await registration.dispose().catch(() => undefined) + } + }, +} diff --git a/integrations/opencode/package.json b/integrations/opencode/package.json new file mode 100644 index 00000000..0ff721e0 --- /dev/null +++ b/integrations/opencode/package.json @@ -0,0 +1,18 @@ +{ + "name": "opencode-codesearch-plugin", + "version": "1.0.0", + "private": true, + "type": "module", + "description": "OpenCode v2 plugin that makes codesearch structural: project scope resolution, usage guidance, grep/glob guards with zero-hit rescue, serve health, commands, a scope tool, a skill and compaction assistance.", + "license": "Apache-2.0", + "scripts": { + "typecheck": "tsc --noEmit", + "unit": "node test/unit.ts", + "smoke": "node test/smoke.ts", + "test": "npm run typecheck && npm run unit && npm run smoke" + }, + "devDependencies": { + "@types/node": "^22.10.0", + "typescript": "^5.6.0" + } +} diff --git a/integrations/opencode/test/smoke.ts b/integrations/opencode/test/smoke.ts new file mode 100644 index 00000000..581db778 --- /dev/null +++ b/integrations/opencode/test/smoke.ts @@ -0,0 +1,495 @@ +/** + * Smoke test for the codesearch OpenCode plugin. + * + * Runs the plugin against a mock OpenCode context and a mock codesearch MCP + * server (streamable HTTP) so scope resolution, guidance injection, zero-hit + * rescue, the nudge/prune/block guards (including prune fail-open while the + * hub is down), compaction outlines, commands, the scope tool and the skill + * registration are exercised end-to-end without a real model session. + * + * Run (Node >= 23.6 strips types natively): + * node test/smoke.ts + * or: + * bun test/smoke.ts + */ + +import assert from "node:assert/strict" +import http from "node:http" +import { mkdtempSync, writeFileSync } from "node:fs" +import { tmpdir } from "node:os" +import { join } from "node:path" +import plugin from "../codesearch.ts" + +type Loose = Record +type Hook = (event: Loose) => any + +const HITS = [ + { + chunk_id: 7, + path: "my-service/src/uploader.ts", + start_line: 41, + end_line: 63, + kind: "Function", + signature: "function retryUpload(job: Job, attempt: number)", + }, + { + chunk_id: 9, + path: "my-service/src/queue.ts", + start_line: 12, + end_line: 30, + kind: "Class", + signature: "class UploadQueue", + }, +] + +const STATUS = { + repos: [ + { + alias: "my-service", + project_path: "/work/my-service", + total_chunks: 120, + total_files: 30, + model: "minilm-l6-q", + lock_status: "warm", + }, + { + alias: "sibling-api", + project_path: "/work/sibling-api", + total_chunks: 0, + total_files: 0, + model: "unknown", + lock_status: "available", + }, + ], + groups: { platform: ["my-service", "sibling-api"] }, + hub: { indexed: true, status: "ready" }, +} + +function startMockServer(): Promise<{ url: string; close: () => Promise; calls: Loose[] }> { + const calls: Loose[] = [] + const server = http.createServer((req, res) => { + let body = "" + req.on("data", (chunk) => (body += chunk)) + req.on("end", () => { + if (req.url === "/healthz") { + calls.push({ name: "healthz" }) + res.writeHead(200, { "content-type": "application/json" }) + res.end('{"status":"ok"}') + return + } + if (req.url !== "/mcp" || req.method !== "POST") { + res.writeHead(404) + res.end() + return + } + let message: Loose + try { + message = JSON.parse(body) as Loose + } catch { + res.writeHead(400) + res.end() + return + } + const reply = (payload: Loose, session = false): void => { + res.writeHead(200, { + "content-type": "application/json", + ...(session ? { "mcp-session-id": "smoke-session" } : {}), + }) + res.end(JSON.stringify(payload)) + } + if (message.method === "initialize") { + reply( + { + jsonrpc: "2.0", + id: message.id, + result: { + protocolVersion: message.params?.protocolVersion ?? "2025-06-18", + capabilities: { tools: {} }, + serverInfo: { name: "mock-codesearch", version: "smoke" }, + }, + }, + true, + ) + return + } + if (message.method === "notifications/initialized") { + res.writeHead(202) + res.end() + return + } + if (message.method === "tools/call") { + const name = String(message.params?.name ?? "") + const args = (message.params?.arguments ?? {}) as Loose + calls.push({ name, args }) + let payload: unknown = {} + if (name === "status") { + payload = STATUS + } else if (name === "search") { + const query = String(args.query ?? "").toLowerCase() + payload = query.includes("none-at-all") ? { results: [] } : { results: HITS } + } else if (name === "explore") { + payload = [ + { chunk_id: 1, kind: "Function", signature: "function retryUpload(job: Job)", start_line: 40, end_line: 63 }, + ] + } + reply({ + jsonrpc: "2.0", + id: message.id, + result: { content: [{ type: "text", text: JSON.stringify(payload) }] }, + }) + return + } + reply({ jsonrpc: "2.0", id: message.id, result: {} }) + }) + }) + return new Promise((resolve) => { + server.listen(0, "127.0.0.1", () => { + const address = server.address() + const port = typeof address === "object" && address ? address.port : 0 + resolve({ + url: `http://127.0.0.1:${port}/mcp`, + close: () => + new Promise((done) => { + server.close(() => done(undefined)) + }), + calls, + }) + }) + }) +} + +function makeCtx(directory: string) { + const hooks: Record = {} + const toolHooks: Record = {} + const tools: Loose[] = [] + const commands: Loose[] = [] + const skills: Loose[] = [] + const prompts: string[] = [] + const eventQueue: Loose[] = [] + let eventWake: (() => void) | undefined + + const context: Loose = { + app: { version: "smoke" }, + location: { directory }, + session: { + hook: async (name: string, callback: Hook) => { + ;(hooks[name] ||= []).push(callback) + return { dispose: async () => {} } + }, + prompt: async (input: Loose) => { + prompts.push(String(input.text ?? "")) + return {} + }, + }, + tool: { + hook: async (name: string, callback: Hook) => { + ;(toolHooks[name] ||= []).push(callback) + return { dispose: async () => {} } + }, + transform: async (callback: (editor: Loose) => void) => { + callback({ + namespace: () => {}, + add: (tool: Loose) => tools.push(tool), + get: () => undefined, + update: () => {}, + }) + return { dispose: async () => {} } + }, + }, + command: { + transform: async (callback: (editor: Loose) => void) => { + callback({ add: (command: Loose) => commands.push(command) }) + return { dispose: async () => {} } + }, + }, + skill: { + transform: async (callback: (editor: Loose) => void) => { + callback({ + add: (skill: Loose) => skills.push(skill), + get: () => undefined, + update: () => {}, + }) + return { dispose: async () => {} } + }, + }, + mcp: { list: async () => [] }, + event: { + subscribe: async function* (options?: { signal?: AbortSignal }) { + const signal = options?.signal + while (!signal?.aborted) { + if (!eventQueue.length) { + await new Promise((resolve) => { + eventWake = resolve + signal?.addEventListener("abort", () => resolve(), { once: true }) + }) + } + while (eventQueue.length) yield eventQueue.shift() as Loose + } + }, + }, + } + + return { + context, + hooks, + toolHooks, + tools, + commands, + skills, + prompts, + emit: (event: Loose) => { + eventQueue.push(event) + const wake = eventWake + eventWake = undefined + wake?.() + }, + } +} + +async function setupPlugin(directory: string) { + const app = makeCtx(directory) + const cleanup = await plugin.setup(app.context as any) + return { app, cleanup } +} + +function userMessage(sessionID: string, messageID: string, text: string): Loose { + return { + sessionID, + system: [], + tools: { grep: {}, glob: {}, read: {} }, + messages: [{ info: { role: "user", id: messageID }, parts: [{ type: "text", text }] }], + } +} + +async function main(): Promise { + const mock = await startMockServer() + const tmp = mkdtempSync(join(tmpdir(), "codesearch-plugin-smoke-")) + + const reposPath = join(tmp, "repos.json") + writeFileSync( + reposPath, + JSON.stringify({ + repos: { "my-service": "/work/my-service", "sibling-api": "/work/sibling-api" }, + groups: { platform: ["my-service", "sibling-api"] }, + }), + ) + const configPath = join(tmp, "codesearch.json") + writeFileSync( + configPath, + JSON.stringify({ + url: "", + log: { guards: false, rescue: false, health: false, commands: false, scope: false, recall: false }, + }), + ) + + process.env.CODESEARCH_CONFIG = configPath + process.env.CODESEARCH_REPOS_CONFIG = reposPath + process.env.CODESEARCH_URL = mock.url + process.env.CODESEARCH_PLUGIN_HEALTH = "0" + delete process.env.CODESEARCH_PLUGIN_GUARDS + + /* ---------------- nudge mode (default) ---------------- */ + + const one = await setupPlugin("/work/my-service") + assert.ok(one.app.hooks.context?.length === 1, "context hook registered") + assert.ok(one.app.toolHooks["execute.before"]?.length === 1, "execute.before hook registered") + assert.ok(one.app.toolHooks["execute.after"]?.length === 1, "execute.after hook registered") + assert.ok(one.app.hooks.compaction?.length === 1, "compaction hook registered") + assert.deepEqual( + one.app.commands.map((c) => c.name).sort(), + ["codesearch", "codesearch-index", "codesearch-status"], + "commands registered", + ) + assert.equal(one.app.tools.length, 1, "scope tool registered") + assert.equal(one.app.tools[0].name, "codesearch_scope") + assert.equal(one.app.skills.length, 1, "skill registered") + assert.equal(one.app.skills[0].id, "codesearch") + + // The startup probe is gated on `health.enabled`: with health probing + // disabled (CODESEARCH_PLUGIN_HEALTH=0 above) setup must make no `/healthz` + // request (the periodic status timer is gated the same way). + await new Promise((resolve) => setTimeout(resolve, 100)) + assert.equal( + mock.calls.filter((c) => c.name === "healthz").length, + 0, + "health disabled: setup performs no /healthz probe", + ) + + // Guidance + scope injection, once per session. + const first = userMessage("s1", "m1", "Where is the upload retried after a failure?") + await one.app.hooks.context[0](first) + const injected = first.system.map((p: Loose) => p.text).join("\n") + assert.match(injected, /project "my-service"/, "scope line names the resolved project") + assert.match(injected, /group: "platform"/, "scope line lists groups") + assert.match(injected, /codesearch/, "guidance is injected") + assert.ok(first.tools.grep, "nudge mode keeps grep visible") + + const second = userMessage("s1", "m2", "And where is it queued?") + await one.app.hooks.context[0](second) + assert.equal(second.system.length, 0, "session mode injects once per session") + + const duplicate = userMessage("s1", "m1", "Where is the upload retried after a failure?") + await one.app.hooks.context[0](duplicate) + assert.equal(duplicate.system.length, 0, "the same user message never injects twice") + + // Zero-hit rescue turns an empty grep into codesearch hits. + const rescueEvent: Loose = { + tool: "grep", + status: "completed", + sessionID: "s1", + callID: "c1", + input: { pattern: "retryUpload" }, + result: { output: "" }, + } + await one.app.toolHooks["execute.after"][0](rescueEvent) + assert.match(String(rescueEvent.result.output), /codesearch/, "rescue appends a codesearch section") + assert.match(String(rescueEvent.result.output), /uploader\.ts/, "rescue includes index hits") + + // A successful grep gets a one-time nudge per session. + const nudgeEvent: Loose = { + tool: "grep", + status: "completed", + sessionID: "s1", + callID: "c2", + input: { pattern: "queue" }, + result: { output: "src/queue.ts:1:const queue = []", metadata: { count: 1 } }, + } + await one.app.toolHooks["execute.after"][0](nudgeEvent) + assert.match(String(nudgeEvent.result.output), /tip:/, "first successful grep is nudged") + const nudgeAgain: Loose = { ...nudgeEvent, callID: "c3", result: { output: "hit", metadata: { count: 1 } } } + await one.app.toolHooks["execute.after"][0](nudgeAgain) + assert.doesNotMatch(String(nudgeAgain.result.output), /tip:/, "the nudge fires once per session") + + // Compaction assist: recently edited files become explore outlines, and the + // target sent to the server must be project-relative. Regression guard: an + // alias-prefix strip left absolute targets that could never match on + // Windows, where the plugin lowercases paths but the server strips them + // case-sensitively — a silent compaction no-op. + one.app.emit({ type: "file.edited", data: { file: "/work/my-service/src/uploader.ts" } }) + await new Promise((resolve) => setTimeout(resolve, 150)) + const compactionEvent: Loose = { system: [] } + await one.app.hooks.compaction[0](compactionEvent) + const compacted = compactionEvent.system.map((p: Loose) => p.text).join("\n") + assert.match(compacted, /src\/uploader\.ts/, "compaction outline names the relative file") + const exploreCall = mock.calls.filter((c) => c.name === "explore").at(-1) + assert.ok(exploreCall, "compaction asked the server for an outline") + assert.equal( + exploreCall!.args.target, + "src/uploader.ts", + "compaction passes the project-relative target, not an absolute/alias-prefixed path", + ) + + // Scope tool reports the resolved project and index state. + const scopeResult = (await one.app.tools[0].execute({}, {})) as { content: string } + const scopeInfo = JSON.parse(scopeResult.content) + assert.equal(scopeInfo.project, "my-service") + assert.equal(scopeInfo.indexed, true) + assert.equal(scopeInfo.chunks, 120) + + // Commands resolve and deliver results through session.prompt. + const searchCommand = one.app.commands.find((c) => c.name === "codesearch") + assert.ok(searchCommand) + await searchCommand.execute({ sessionID: "s1", prompt: { text: "upload retry" } }) + assert.match(one.app.prompts.at(-1) ?? "", /uploader\.ts/, "/codesearch injects hits") + + const statusCommand = one.app.commands.find((c) => c.name === "codesearch-status") + assert.ok(statusCommand) + await statusCommand.execute({ sessionID: "s1", prompt: { text: "" } }) + assert.match(one.app.prompts.at(-1) ?? "", /project: my-service/, "/codesearch-status reports scope") + + await one.cleanup() + + /* ---------------- scope.enabled=false silences the scope prelude ---------------- */ + + const scopeOffPath = join(tmp, "codesearch-scope-off.json") + writeFileSync( + scopeOffPath, + JSON.stringify({ + url: "", + scope: { enabled: false }, + log: { guards: false, rescue: false, health: false, commands: false, scope: false, recall: false }, + }), + ) + process.env.CODESEARCH_CONFIG = scopeOffPath + const scopeOff = await setupPlugin("/work/my-service") + const scopeOffEvent = userMessage("s6", "o1", "Where is the upload retried after a failure?") + await scopeOff.app.hooks.context[0](scopeOffEvent) + const scopeOffText = scopeOffEvent.system.map((p: Loose) => p.text).join("\n") + assert.doesNotMatch(scopeOffText, /codesearch scope:/, "scope.enabled=false silences the scope prelude") + assert.match(scopeOffText, /codesearch/, "guidance is still injected when only scope is disabled") + await scopeOff.cleanup() + process.env.CODESEARCH_CONFIG = configPath + + /* ---------------- prune mode ---------------- */ + + // The prune scenarios assert on `health.state`, so the startup probe must be + // enabled here (the global PLUGIN_HEALTH=0 above is for the no-probe guard). + process.env.CODESEARCH_PLUGIN_HEALTH = "1" + process.env.CODESEARCH_PLUGIN_GUARDS = "prune" + const pruned = await setupPlugin("/work/my-service") + // Prune only engages once the startup health probe has confirmed the hub is + // reachable; poll with fresh sessions instead of racing the probe (the + // guidance is injected once per session, so each attempt needs its own). + let prunedEvent: Loose | undefined + for (let i = 0; i < 30 && !prunedEvent; i++) { + const candidate = userMessage(`s2-${i}`, `p${i}`, "How does the uploader work?") + await pruned.app.hooks.context[0](candidate) + if (candidate.tools.grep === undefined) prunedEvent = candidate + else await new Promise((r) => setTimeout(r, 100)) + } + assert.ok(prunedEvent, "prune engages once the hub is reachable") + assert.equal(prunedEvent!.tools.grep, undefined, "prune removes grep") + assert.equal(prunedEvent!.tools.glob, undefined, "prune removes glob") + assert.ok(prunedEvent!.tools.read, "prune keeps unrelated tools") + assert.match(prunedEvent!.system.map((p: Loose) => p.text).join("\n"), /intentionally unavailable/) + await pruned.cleanup() + + /* ---------------- block mode (fail-open everywhere else) ---------------- */ + + process.env.CODESEARCH_PLUGIN_GUARDS = "block" + const blocked = await setupPlugin("/work/my-service") + const before = blocked.app.toolHooks["execute.before"][0] + let threw = "" + for (let i = 0; i < 30 && !threw; i++) { + try { + await before({ tool: "grep", input: { pattern: "x" }, sessionID: "s3" }) + } catch (err) { + threw = String(err) + } + if (!threw) await new Promise((r) => setTimeout(r, 100)) + } + assert.match(threw, /codesearch/, "block mode denies grep once the hub is reachable") + assert.match(threw, /project "my-service"/, "denial names the project scope to use") + + const uncovered = await setupPlugin("/work/unregistered") + await uncovered.app.toolHooks["execute.before"][0]({ tool: "grep", input: {}, sessionID: "s4" }) + await uncovered.cleanup() + await blocked.cleanup() + + /* ---------------- prune fails open while the hub is down ---------------- */ + + process.env.CODESEARCH_PLUGIN_GUARDS = "prune" + process.env.CODESEARCH_URL = "http://127.0.0.1:1/mcp" + const downPrune = await setupPlugin("/work/my-service") + // Let the startup probe fail (connection refused) so health settles on down. + await new Promise((resolve) => setTimeout(resolve, 300)) + const downEvent = userMessage("s5", "d1", "Where is the uploader?") + await downPrune.app.hooks.context[0](downEvent) + assert.ok(downEvent.tools.grep, "prune keeps grep visible while the hub is down") + assert.ok(downEvent.tools.glob, "prune keeps glob visible while the hub is down") + assert.match( + downEvent.system.map((p: Loose) => p.text).join("\n"), + /unreachable|acceptable fallback/, + "guidance names the grep/glob fallback while the hub is down", + ) + await downPrune.cleanup() + process.env.CODESEARCH_URL = mock.url + + delete process.env.CODESEARCH_PLUGIN_GUARDS + // Give any in-flight startup probe a moment before the mock hub disappears. + await new Promise((resolve) => setTimeout(resolve, 200)) + await mock.close() + console.log("smoke: OK") +} + +await main() diff --git a/integrations/opencode/test/unit.ts b/integrations/opencode/test/unit.ts new file mode 100644 index 00000000..814335c0 --- /dev/null +++ b/integrations/opencode/test/unit.ts @@ -0,0 +1,230 @@ +/** + * Unit tests for the codesearch OpenCode plugin's pure helpers and the health + * runner. Complements test/smoke.ts, which exercises the plugin end-to-end + * against a mock OpenCode host and a mock codesearch MCP server. + * + * Run (Node >= 23.6 strips types natively): + * node test/unit.ts + * or: + * npm run unit + */ + +import assert from "node:assert/strict" +import http from "node:http" +import type { AddressInfo } from "node:net" +import { HealthRunner, stripJsonc } from "../codesearch.ts" + +type Loose = Record + +/* ------------------------------------------------------------------ * + * stripJsonc + * ------------------------------------------------------------------ */ + +function testStripJsonc(): void { + // Plain JSON passes through unchanged and still parses. + const plain = '{"a":1,"b":[1,2],"c":"x"}' + assert.equal(stripJsonc(plain), plain, "plain JSON is unchanged") + assert.deepEqual(JSON.parse(stripJsonc(plain)), JSON.parse(plain)) + + // Line comments (leading, trailing, at EOF) are removed. + assert.deepEqual(JSON.parse(stripJsonc('{\n // note\n "a": 1 // tail\n}\n')), { a: 1 }) + assert.deepEqual(JSON.parse(stripJsonc('{"a":1} // done')), { a: 1 }, "comment at EOF without newline") + + // Block comments, including inline and multi-line. + assert.deepEqual(JSON.parse(stripJsonc('{/* one */"a":/* two\nlines */1}')), { a: 1 }) + + // Comment markers inside strings are data, not comments. + assert.deepEqual( + JSON.parse(stripJsonc('{"url":"http://example.com/a//b","glob":"/* literal */"}')), + { url: "http://example.com/a//b", glob: "/* literal */" }, + ) + + // Escaped quotes do not terminate the string early. + assert.deepEqual(JSON.parse(stripJsonc('{"s":"a\\"//not-a-comment"}')), { s: 'a"//not-a-comment' }) + + // Trailing commas in objects and arrays are dropped. + assert.deepEqual(JSON.parse(stripJsonc('{\n "a": [1, 2,],\n "b": {"c": 3,},\n}')), { + a: [1, 2], + b: { c: 3 }, + }) + + // Regression: a trailing comma may be followed by a comment before the + // closing bracket ("a": 1, // last member \n }). Comments must be skipped + // while looking ahead, not mistaken for the next member. + assert.deepEqual(JSON.parse(stripJsonc('{"a": 1, // last member\n}')), { a: 1 }) + assert.deepEqual(JSON.parse(stripJsonc('{"a": [1, /* c */ ]}')), { a: [1] }) + + // A comma followed by a real member is preserved. + assert.deepEqual(JSON.parse(stripJsonc('{"a":1, "b":2}')), { a: 1, b: 2 }) + + // CRLF line comments terminate at the newline, not at a literal \r. + assert.deepEqual(JSON.parse(stripJsonc('{\r\n // note\r\n "a": 1\r\n}\r\n')), { a: 1 }) +} + +/* ------------------------------------------------------------------ * + * HealthRunner + * ------------------------------------------------------------------ */ + +function healthSettings(overrides: Loose = {}): Loose { + return { + health: { + enabled: true, + intervalMs: 40, + initialDelayMs: 10, + maxBackoffMs: 80, + reconnect: true, + autoStart: false, + startCommand: "", + ...overrides, + }, + } +} + +async function waitFor(predicate: () => boolean, what: string, timeoutMs = 4000): Promise { + const deadline = Date.now() + timeoutMs + while (Date.now() < deadline) { + if (predicate()) return + await new Promise((resolve) => setTimeout(resolve, 10)) + } + throw new Error(`timed out waiting for ${what}`) +} + +/** Minimal /healthz server that counts probes, can stop/restart in place, and + * can hold responses so a probe can be kept in flight deterministically. */ +async function startHealthServer(port = 0) { + let count = 0 + let hold = false + let pending: Array<() => void> = [] + const make = () => + http.createServer((_req, res) => { + count += 1 + const respond = () => { + res.writeHead(200, { "content-type": "application/json" }) + res.end('{"status":"ok"}') + } + if (hold) pending.push(respond) + else respond() + }) + let server = make() + await new Promise((resolve) => server.listen(port, "127.0.0.1", resolve)) + const actual = (server.address() as AddressInfo).port + return { + url: `http://127.0.0.1:${actual}/mcp`, + hits: () => count, + pendingProbes: () => pending.length, + hold: (value: boolean) => { + hold = value + }, + release: () => { + const waiting = pending + pending = [] + for (const respond of waiting) respond() + }, + close: () => new Promise((resolve) => server.close(() => resolve())), + restart: async () => { + server = make() + await new Promise((resolve) => server.listen(actual, "127.0.0.1", resolve)) + }, + } +} + +async function testHealthRunner(): Promise { + const hub = await startHealthServer() + const logs: string[] = [] + const warnings: string[] = [] + const log = (...args: unknown[]) => logs.push(args.join(" ")) + const warn = (...args: unknown[]) => warnings.push(args.join(" ")) + + // probe() reflects reachability in state and lastError. + { + const runner = new HealthRunner({} as any, hub.url, healthSettings() as any, () => {}, log, warn) + await runner.probe() + assert.equal(runner.state, "ok", "probe marks a reachable hub ok") + assert.equal(runner.lastError, "", "ok state clears lastError") + await hub.close() + await runner.probe() + assert.equal(runner.state, "down", "probe marks an unreachable hub down") + assert.ok(runner.lastError.length > 0, "down state records the error") + assert.ok( + warnings.some((line) => /hub unreachable/.test(line)), + "the first down transition is warned about", + ) + runner.stop() + } + + // start() probes after the initial delay, backs off while down, asks the + // host to reload failed MCP servers, and reports recovery exactly once. + { + await hub.restart() + let reloads = 0 + let recovered = 0 + const ctx = { + mcp: { + reload: async () => { + reloads += 1 + }, + }, + } + const runner = new HealthRunner( + ctx as any, + hub.url, + healthSettings() as any, + () => { + recovered += 1 + }, + log, + warn, + ) + runner.start() + await waitFor(() => runner.state === "ok", "the initial probe to mark the hub ok") + await hub.close() + await waitFor(() => runner.state === "down", "the hub to be detected down") + await waitFor(() => reloads >= 1, "the reconnect reload call") + await hub.restart() + await waitFor(() => runner.state === "ok", "the hub to be detected recovered") + await waitFor(() => recovered === 1, "the recovery callback") + assert.ok( + logs.some((line) => /hub recovered/.test(line)), + "recovery is logged", + ) + // stop() must latch: even a probe that is already in flight must not + // reschedule another one afterwards. + hub.hold(true) + await waitFor(() => hub.pendingProbes() >= 1, "an in-flight probe to hold") + const hitsAtStop = hub.hits() + runner.stop() + hub.release() + await new Promise((resolve) => setTimeout(resolve, 250)) + assert.equal(hub.hits(), hitsAtStop, "stop() halts probing, including from an in-flight tick") + hub.hold(false) + hub.release() + } + + // start() is a no-op when health probing is disabled. + { + const hits = hub.hits() + const runner = new HealthRunner( + {} as any, + hub.url, + healthSettings({ enabled: false }) as any, + () => {}, + log, + warn, + ) + runner.start() + await new Promise((resolve) => setTimeout(resolve, 120)) + assert.equal(hub.hits(), hits, "disabled health never probes") + assert.equal(runner.state, "unknown", "state stays unknown while disabled") + runner.stop() + } + + await hub.close() +} + +async function main(): Promise { + testStripJsonc() + await testHealthRunner() + console.log("unit: OK") +} + +await main() diff --git a/integrations/opencode/tsconfig.json b/integrations/opencode/tsconfig.json new file mode 100644 index 00000000..393d8e8a --- /dev/null +++ b/integrations/opencode/tsconfig.json @@ -0,0 +1,17 @@ +{ + "compilerOptions": { + "target": "ES2022", + "module": "ESNext", + "moduleResolution": "bundler", + "lib": ["ES2022"], + "types": ["node"], + "strict": true, + "noEmit": true, + "allowImportingTsExtensions": true, + "skipLibCheck": true, + "forceConsistentCasingInFileNames": true, + "noUnusedLocals": true, + "noUnusedParameters": false + }, + "include": ["codesearch.ts", "test/smoke.ts"] +} diff --git a/scripts/bump-version.sh b/scripts/bump-version.sh index 8f530127..44659def 100644 --- a/scripts/bump-version.sh +++ b/scripts/bump-version.sh @@ -89,6 +89,23 @@ sed -i "0,/^version = \"$CURRENT\"/s//version = \"$NEW_VERSION\"/" "$CARGO_TOML" # Keep Cargo.lock in sync cargo update --workspace --quiet 2>/dev/null || true +# ── Update scip-csharp csproj ──────────────────────────────────────────────── +# The helper's feeds its `--version` line — the identity the host +# logs at startup and copy-to-common compares, so it must move with the crate. +# Match ANY current value, not $CURRENT: once the two files drift apart (a +# manual sync landing between auto-bumps does it), a $CURRENT-anchored sed +# silently no-ops forever and the deploy warns "version mismatch" on every +# helper. A failed match is loud, never silent. +CSPROJ="helpers/csharp/scip-csharp.csproj" +if [[ -f "$CSPROJ" ]]; then + echo -e "${CYAN}→ Updating $CSPROJ...${NC}" + sed -i "0,/[^<]*<\/Version>/s//$NEW_VERSION<\/Version>/" "$CSPROJ" + if ! grep -q "$NEW_VERSION" "$CSPROJ"; then + echo -e "${RED}Error: failed to set $CSPROJ to $NEW_VERSION${NC}" >&2 + exit 1 + fi +fi + # ── Update AGENTS.md ───────────────────────────────────────────────────────── echo -e "${CYAN}→ Updating AGENTS.md...${NC}" TODAY=$(date +%Y-%m-%d) diff --git a/src/cache/file_meta.rs b/src/cache/file_meta.rs index f3f78533..5ed0283d 100644 --- a/src/cache/file_meta.rs +++ b/src/cache/file_meta.rs @@ -6,7 +6,9 @@ use std::fs; use std::path::{Path, PathBuf}; use std::time::SystemTime; -use crate::constants::FILE_META_DB_NAME; +use crate::constants::{ + FILE_META_DB_NAME, FILE_META_SAVE_RENAME_ATTEMPTS, FILE_META_SAVE_RENAME_DELAY_MS, +}; // ─── CANONICAL PATH POLICY ──────────────────────────────────────────────────── // @@ -271,6 +273,15 @@ pub struct FileMetaStore { pub last_full_index: Option, /// Version for format compatibility version: u32, + /// The codesearch build that produced these records. A mismatch on load + /// (deploy, or a store from before this field existed) wipes the + /// records: the chunker's output convention can change without a single + /// source byte changing (observed live: 0-based → 1-based chunk start + /// lines), and every content signal — mtime, hash, HEAD — then + /// wrongly reports "fresh". Same invalidation policy as the + /// model-name check below. + #[serde(default)] + builder_version: String, } impl FileMetaStore { @@ -285,6 +296,7 @@ impl FileMetaStore { dimensions, last_full_index: None, version: Self::CURRENT_VERSION, + builder_version: crate::constants::INDEX_BUILDER_VERSION.to_string(), } } @@ -297,11 +309,30 @@ impl FileMetaStore { let mut store: FileMetaStore = serde_json::from_str(&content) .map_err(|e| anyhow!("Failed to parse file metadata: {}", e))?; - // Check if model changed - if so, invalidate everything + // Check if model changed - if so, invalidate everything. + // warn_print!: stderr + quiet-aware — a raw println would + // corrupt the serve TUI's screen (observed live when the + // builder-version wipe below fired for the whole fleet). if store.model_name != model_name || store.dimensions != dimensions { - println!( + crate::warn_print!( "⚠️ Model changed ({} -> {}), full re-index required", - store.model_name, model_name + store.model_name, + model_name + ); + store = Self::new(model_name.to_string(), dimensions); + } + + // Check if another build produced these records — its chunker + // conventions (line bases, key shapes) are not ours. + if store.builder_version != crate::constants::INDEX_BUILDER_VERSION { + crate::warn_print!( + "⚠️ Indexer version changed ({} -> {}), full re-index required", + if store.builder_version.is_empty() { + "pre-stamp".to_string() + } else { + store.builder_version.clone() + }, + crate::constants::INDEX_BUILDER_VERSION ); store = Self::new(model_name.to_string(), dimensions); } @@ -320,8 +351,29 @@ impl FileMetaStore { pub fn save(&self, db_path: &Path) -> Result<()> { let meta_path = db_path.join(Self::FILENAME); let content = serde_json::to_string_pretty(self)?; - fs::write(meta_path, content)?; - Ok(()) + // Atomic replace (tmp + rename): the store is now saved once per + // index batch, so a crash mid-write must never leave a truncated + // file — a truncated store parses as broken on the next open and + // would trip the empty-meta wipe guard. + let tmp_path = db_path.join(format!("{}.tmp", Self::FILENAME)); + fs::write(&tmp_path, content)?; + // Windows: an indexer can briefly hold the target (os error 5/32). + let mut attempt = 1; + loop { + match fs::rename(&tmp_path, &meta_path) { + Ok(()) => return Ok(()), + Err(e) if attempt >= FILE_META_SAVE_RENAME_ATTEMPTS => { + let _ = fs::remove_file(&tmp_path); + return Err(e.into()); + } + Err(_) => { + attempt += 1; + std::thread::sleep(std::time::Duration::from_millis( + FILE_META_SAVE_RENAME_DELAY_MS, + )); + } + } + } } /// Migrate stored paths to normalized format. diff --git a/src/cache/file_meta_tests.rs b/src/cache/file_meta_tests.rs index fa2a51ee..7265237f 100644 --- a/src/cache/file_meta_tests.rs +++ b/src/cache/file_meta_tests.rs @@ -382,6 +382,126 @@ fn test_file_meta_store() { assert!(loaded.is_tracked("test.txt")); } +/// A store produced by ANOTHER build (or from before the builder stamp +/// existed) must wipe its records on load: the chunker's output convention +/// can change without a single source byte changing, so every content +/// signal reports "fresh" while the stored chunk lines are wrong-by- +/// convention. The wipe makes the manager re-chunk everything once; the +/// reloaded store carries the current stamp so the next run is incremental +/// again. +#[test] +fn builder_version_mismatch_invalidates_the_store() { + let dir = tempdir().unwrap(); + let db_path = dir.path(); + + let test_file = dir.path().join("test.txt"); + fs::write(&test_file, "hello world").unwrap(); + + let mut store = FileMetaStore::new("test-model".to_string(), 384); + store + .update_file(&test_file, "test.txt", vec![1, 2, 3]) + .unwrap(); + store.save(db_path).unwrap(); + + // Simulate a store written by an older build (or a pre-stamp one). + let meta_path = db_path.join("file_meta.json"); + let content = fs::read_to_string(&meta_path).unwrap(); + let stripped: serde_json::Value = serde_json::from_str(&content).unwrap(); + let mut obj = stripped.as_object().expect("json object").clone(); + obj.insert( + "builder_version".to_string(), + serde_json::Value::String("0.0.0-old".to_string()), + ); + fs::write(&meta_path, serde_json::to_string_pretty(&obj).unwrap()).unwrap(); + + let loaded = FileMetaStore::load_or_create(db_path, "test-model", 384).unwrap(); + assert!( + loaded.files.is_empty(), + "records from another build must not survive, got {} file(s)", + loaded.files.len() + ); + assert_eq!( + loaded.builder_version, + crate::constants::INDEX_BUILDER_VERSION + ); + // And the wiped store behaves like a fresh one: the file is new again. + let (needs_reindex, _) = loaded.check_file(&test_file, "test.txt").unwrap(); + assert!(needs_reindex); +} + +/// The chunk-cache stamp must be a hand-bumped generation marker, never the +/// package version: the bump-bot moves the patch version on every merged +/// PR, and a per-build stamp wiped the whole fleet's chunk caches on every +/// binary swap (field incident 14–15 Oct 2026 — full fleet re-embeds per +/// restart, AV lock races killing builds, repos left at 0 chunks). +#[test] +fn builder_version_stamp_is_a_generation_marker_not_the_package_version() { + let stamp = crate::constants::INDEX_BUILDER_VERSION; + assert!( + !stamp.contains('+'), + "stamp must not carry build metadata: {stamp}" + ); + assert_ne!(stamp, env!("CARGO_PKG_VERSION_FULL")); +} + +/// save() must replace atomically (tmp + rename): the store is written once +/// per index batch now, so a crash mid-write must never truncate the file — +/// and a leftover .tmp from a crashed write must not confuse the next load. +#[test] +fn save_replaces_atomically_and_leaves_no_tmp_behind() { + let dir = tempdir().unwrap(); + let db_path = dir.path(); + + let test_file = dir.path().join("a.txt"); + fs::write(&test_file, "hello world").unwrap(); + + let mut store = FileMetaStore::new("test-model".to_string(), 384); + store.update_file(&test_file, "a.txt", vec![1, 2]).unwrap(); + store.save(db_path).unwrap(); + + // A crashed write left a garbage .tmp behind: the next save must + // overwrite it and the load must see the real content. + let tmp = db_path.join(format!("{}.tmp", crate::constants::FILE_META_DB_NAME)); + fs::write(&tmp, "{ not json").unwrap(); + store.save(db_path).unwrap(); + assert!(!tmp.exists(), "save must consume the tmp file via rename"); + + let loaded = FileMetaStore::load_or_create(db_path, "test-model", 384).unwrap(); + assert_eq!(loaded.files.len(), 1, "second save must fully replace"); +} + +/// A pre-stamp store (no builder_version field at all) is treated the same +/// way: serde's default is an empty string, which never matches the current +/// version. +#[test] +fn pre_stamp_store_invalidates_too() { + let dir = tempdir().unwrap(); + let db_path = dir.path(); + + let test_file = dir.path().join("test.txt"); + fs::write(&test_file, "hello world").unwrap(); + + let mut store = FileMetaStore::new("test-model".to_string(), 384); + store + .update_file(&test_file, "test.txt", vec![1, 2, 3]) + .unwrap(); + store.save(db_path).unwrap(); + + // Strip the field entirely, as an older binary would have written it. + let meta_path = db_path.join("file_meta.json"); + let content = fs::read_to_string(&meta_path).unwrap(); + let stripped: serde_json::Value = serde_json::from_str(&content).unwrap(); + let mut obj = stripped.as_object().expect("json object").clone(); + obj.remove("builder_version"); + fs::write(&meta_path, serde_json::to_string_pretty(&obj).unwrap()).unwrap(); + + let loaded = FileMetaStore::load_or_create(db_path, "test-model", 384).unwrap(); + assert!( + loaded.files.is_empty(), + "pre-stamp records must not survive" + ); +} + #[test] fn test_storage_key_relative_and_portable() { let dir = tempdir().unwrap(); diff --git a/src/chunker/jupyter.rs b/src/chunker/jupyter.rs index 3722d71c..5310b374 100644 --- a/src/chunker/jupyter.rs +++ b/src/chunker/jupyter.rs @@ -205,9 +205,11 @@ fn build_chunk(group: &CellGroup, file_name: &str, file_breadcrumb: &str) -> Chu // distinguish code from markdown content. let prefixed = format!("# [{}]\n{}", group.cell_type, group.content); + // Group lines are 0-based offsets into the notebook; chunks surface + // 1-based editor lines. let mut chunk = Chunk::new( prefixed, - group.start_line, + group.start_line + 1, group.end_line, ChunkKind::Block, file_name.to_string(), diff --git a/src/chunker/mod.rs b/src/chunker/mod.rs index f2bbbe1b..026187c4 100644 --- a/src/chunker/mod.rs +++ b/src/chunker/mod.rs @@ -133,7 +133,8 @@ impl Chunk { /// Get the number of lines in this chunk pub fn line_count(&self) -> usize { - self.end_line.saturating_sub(self.start_line) + // 1-based inclusive end minus 1-based start, +1: the true line count. + self.end_line.saturating_sub(self.start_line) + 1 } /// Get the size of this chunk in bytes diff --git a/src/chunker/semantic.rs b/src/chunker/semantic.rs index 0c409e92..b7568ee7 100644 --- a/src/chunker/semantic.rs +++ b/src/chunker/semantic.rs @@ -246,11 +246,13 @@ impl SemanticChunker { } /// Build a Markdown chunk from a byte range, or None if it is blank. + /// `start_row` is the 0-based tree-sitter row of the range start; the + /// chunk surfaces it as a 1-based editor line. fn md_chunk( source: &[u8], start_byte: usize, end_byte: usize, - start_line: usize, + start_row: usize, context: &[String], path_str: &str, ) -> Option { @@ -261,8 +263,8 @@ impl SemanticChunker { let line_count = text.lines().count().max(1); let mut chunk = Chunk::new( text.to_string(), - start_line, - start_line + line_count, + start_row + 1, + start_row + line_count, ChunkKind::Block, path_str.to_string(), ); @@ -300,10 +302,11 @@ impl SemanticChunker { let total_lines = source_lines.len(); for chunk in chunks.iter_mut() { - // Extract context_prev (N lines before start_line) - if chunk.start_line > 0 && self.context_lines > 0 { - let prev_start = chunk.start_line.saturating_sub(self.context_lines); - let prev_end = chunk.start_line; + // Extract context_prev (N lines before start_line). Chunk lines + // are 1-based; the slice needs the 0-based row before the chunk. + if chunk.start_line > 1 && self.context_lines > 0 { + let prev_end = chunk.start_line - 1; + let prev_start = prev_end.saturating_sub(self.context_lines); if prev_start < prev_end && prev_end <= total_lines { let prev_lines = &source_lines[prev_start..prev_end]; let prev_content = prev_lines.join("\n"); @@ -420,7 +423,10 @@ impl SemanticChunker { let mut chunk = Chunk::new( content, - node.start_position().row, + // Chunks surface 1-based editor lines (same convention + // as the SCIP position index and find_impact position + // queries); tree-sitter rows are 0-based. + node.start_position().row + 1, node.end_position().row + 1, // tree-sitter uses 0-based, we use line count kind, path_str, @@ -464,7 +470,8 @@ impl SemanticChunker { if !chunk_lines.is_empty() { let content = chunk_lines.join("\n"); - let mut chunk = Chunk::new(content, i, end, ChunkKind::Block, path_str.clone()); + // i is a 0-based line index; chunks surface 1-based lines. + let mut chunk = Chunk::new(content, i + 1, end, ChunkKind::Block, path_str.clone()); chunk.context = context.clone(); chunks.push(chunk); } @@ -699,7 +706,10 @@ impl<'a> GapTracker<'a> { if !gap_content.trim().is_empty() { let kind = Self::classify_gap(&gap_content); let line_count = i - start; - let mut chunk = Chunk::new(gap_content, start, i, kind, path_str.clone()); + // start/i are 0-based slice bounds; chunks surface + // 1-based lines (i is the 1-based inclusive end). + let mut chunk = + Chunk::new(gap_content, start + 1, i, kind, path_str.clone()); chunk.context = context.clone(); chunk.signature = Some(Self::gap_signature(kind, line_count)); gaps.push(chunk); @@ -718,8 +728,13 @@ impl<'a> GapTracker<'a> { if !gap_content.trim().is_empty() { let kind = Self::classify_gap(&gap_content); let line_count = self.lines.len() - start; - let mut chunk = - Chunk::new(gap_content, start, self.lines.len(), kind, path_str.clone()); + let mut chunk = Chunk::new( + gap_content, + start + 1, + self.lines.len(), + kind, + path_str.clone(), + ); chunk.context = context.clone(); chunk.signature = Some(Self::gap_signature(kind, line_count)); gaps.push(chunk); @@ -1075,17 +1090,35 @@ mixin Walker { // Mark lines 1-2 as covered tracker.mark_covered(1, 2); - // Should have gaps: [0], [3-4] + // Should have gaps: [0], [3-4] — surfaces as 1-based editor lines. let path = Path::new("test.txt"); let gaps = tracker.extract_gaps(path); assert_eq!(gaps.len(), 2, "Should have 2 gaps"); - assert_eq!(gaps[0].start_line, 0); + assert_eq!(gaps[0].start_line, 1); assert_eq!(gaps[0].end_line, 1); - assert_eq!(gaps[1].start_line, 3); + assert_eq!(gaps[1].start_line, 4); assert_eq!(gaps[1].end_line, 5); } + /// Definition chunks surface 1-based editor lines — the same convention + /// as the find_impact position index. The pre-fix 0-based leak made + /// agents query find_impact with lines that could never resolve. + #[test] + fn definition_chunks_report_one_based_lines() { + let mut chunker = SemanticChunker::new(100, 2000, 0); + let content = "// leading comment\nvoid hello() {\n print('hi');\n}\n"; + let chunks = chunker + .chunk_semantic(Language::Dart, Path::new("a.dart"), content) + .unwrap(); + let hello = chunks + .iter() + .find(|c| c.content.contains("void hello")) + .expect("hello chunk"); + assert_eq!(hello.start_line, 2, "1-based line of the declaration"); + assert_eq!(hello.end_line, 4, "1-based inclusive end"); + } + #[test] fn test_chunk_splitting() { let chunker = SemanticChunker::new(5, 100, 1); // Very small limit @@ -1197,6 +1230,72 @@ main "$@" ); } + #[test] + fn test_chunk_php_fallback() { + // PHP has a tree-sitter grammar but no extractor, so it falls back + // to fallback_chunk (sliding window) like Shell does. + let mut chunker = SemanticChunker::new(100, 2000, 10); + + let php_source = r#" 0; + } +} + +function formatPrice(float $amount): string +{ + return number_format($amount, 2); +} +"#; + + let path = Path::new("Service.php"); + + // Verify language detection + assert_eq!( + crate::file::Language::from_path(path), + crate::file::Language::Php, + ".php files should be detected as PHP language" + ); + + let chunks = chunker + .chunk_semantic(crate::file::Language::Php, path, php_source) + .unwrap(); + + // Should produce chunks (via fallback) + assert!( + !chunks.is_empty(), + "PHP files should produce chunks via fallback, got 0" + ); + + // All chunks should be Block kind (fallback chunking) + assert!( + chunks.iter().all(|c| c.kind == ChunkKind::Block), + "Fallback chunks should all be Block kind" + ); + + // Chunks should cover the PHP content + let all_content: String = chunks.iter().map(|c| c.content.as_str()).collect(); + assert!( + all_content.contains("createOrder"), + "Chunks should contain createOrder method" + ); + assert!( + all_content.contains("cancelOrder"), + "Chunks should contain cancelOrder method" + ); + } + #[test] fn test_context_breadcrumbs() { let mut chunker = SemanticChunker::new(100, 2000, 10); diff --git a/src/cli/mod.rs b/src/cli/mod.rs index 64a052e0..dc564548 100644 --- a/src/cli/mod.rs +++ b/src/cli/mod.rs @@ -460,6 +460,26 @@ pub enum Commands { #[arg(long)] idle_suspend_secs: Option, + /// Max concurrent repo indexing jobs (refresh / reindex / HNSW build) + /// this serve runs. Overrides CODESEARCH_INDEX_JOBS (default 1). + #[arg(long)] + index_jobs: Option, + + /// ONNX intra-op threads per embedding session. Overrides + /// CODESEARCH_EMBED_THREADS (unset = ONNX default, all cores). + #[arg(long)] + embed_threads: Option, + + /// Milliseconds to pause between background embedding mini-batches. + /// Overrides CODESEARCH_EMBED_PAUSE_MS (default 0). + #[arg(long)] + embed_pause_ms: Option, + + /// Minimum free memory (MB) before a heavy indexing job may start. + /// Overrides CODESEARCH_MIN_FREE_MB (default 0 = disabled). + #[arg(long)] + min_free_mb: Option, + /// For `tui` action: serve URL to connect to #[arg(long, default_value = DEFAULT_SERVE_URL)] url: String, @@ -508,7 +528,7 @@ pub enum Commands { /// Download embedding models Setup { - /// Model to download (defaults to mxbai-embed-xsmall-v1) + /// Model to download (defaults to minilm-l6-q) #[arg(long)] model: Option, }, @@ -985,19 +1005,28 @@ fn warn_if_heavier_model(model_type: ModelType) { } } +/// Resolve a CLI `--model` flag to an optional [`ModelType`]. +/// +/// `None` (flag absent) stays `None` so runtime paths keep their per-query +/// model resolution; an unknown name is rejected with the full valid-model +/// list. Shared by every command that takes `--model`. +pub(crate) fn parse_model_arg(model: Option<&str>) -> Result> { + match model { + Some(name) => ModelType::parse(name).map(Some).ok_or_else(|| { + anyhow::anyhow!( + "Unknown model '{name}' (valid models: {})", + ModelType::valid_short_names() + ) + }), + None => Ok(None), + } +} + pub async fn run(cancel_token: CancellationToken) -> Result<()> { let cli = Cli::parse(); // Parse model from CLI flag - let model_type = cli.model.as_ref().and_then(|m| ModelType::parse(m)); - if cli.model.is_some() && model_type.is_none() { - eprintln!( - "Unknown model: '{}'. Available models:", - cli.model.as_deref().unwrap_or_default() - ); - eprintln!(" {}", ModelType::valid_short_names()); - std::process::exit(1); - } + let model_type = parse_model_arg(cli.model.as_deref())?; // Set quiet mode if requested if cli.quiet { @@ -1087,18 +1116,7 @@ pub async fn run(cancel_token: CancellationToken) -> Result<()> { if let Some(peer_name) = &remote { run_remote_add(peer_name, add_path).await } else { - let mt = model - .as_deref() - .and_then(|m| { - let parsed = ModelType::parse(m); - if parsed.is_none() { - eprintln!("Unknown model: '{}'. Available models:", m); - eprintln!(" {}", ModelType::valid_short_names()); - std::process::exit(1); - } - parsed - }) - .or(model_type); + let mt = parse_model_arg(model.as_deref())?.or(model_type); if let Some(mt) = mt { warn_if_heavier_model(mt); } @@ -1234,6 +1252,10 @@ pub async fn run(cancel_token: CancellationToken) -> Result<()> { no_tui, keep_warm_url, idle_suspend_secs, + index_jobs, + embed_threads, + embed_pause_ms, + min_free_mb, url, api_key, } => { @@ -1258,6 +1280,24 @@ pub async fn run(cancel_token: CancellationToken) -> Result<()> { if let Some(mt) = model_type { warn_if_heavier_model(mt); } + // CLI overrides for the heavy-work limits. Serve is a single + // long-lived process, so exporting the overrides here keeps a + // single source of truth (the environment) for every + // component that reads them (job gate, embedder, refresh + // batching) without threading a config struct through each + // constructor. Unset flags change nothing. + if let Some(n) = index_jobs { + std::env::set_var(crate::limits::INDEX_JOBS_ENV, n.to_string()); + } + if let Some(n) = embed_threads { + std::env::set_var(crate::limits::EMBED_THREADS_ENV, n.to_string()); + } + if let Some(ms) = embed_pause_ms { + std::env::set_var(crate::limits::EMBED_PAUSE_MS_ENV, ms.to_string()); + } + if let Some(mb) = min_free_mb { + std::env::set_var(crate::limits::MIN_FREE_MB_ENV, mb.to_string()); + } crate::serve::run_serve( host, port, @@ -1779,8 +1819,9 @@ fn codesearch_hook_block() -> String { # Only react to branch/worktree checkouts ($3 = 1). `git worktree add` fires # post-checkout with flag 1; a file checkout (`git checkout -- path`) fires with # flag 0 and must not re-register (it changes no repo location, just wastes a POST). -if [ "$3" = "1" ] && [ -f "$HOME/.codesearch/serve_url" ]; then - __cs_url=$(cat "$HOME/.codesearch/serve_url") +__cs_home="${CODESEARCH_HOME:-$HOME/.codesearch}" +if [ "$3" = "1" ] && [ -f "$__cs_home/serve_url" ]; then + __cs_url=$(cat "$__cs_home/serve_url") if [ -n "$__cs_url" ]; then # Git Bash `pwd` yields an msys path (/c/...) that codesearch serve # cannot canonicalize (HTTP 400); `pwd -W` yields a native C:/ path. @@ -1870,6 +1911,10 @@ fn git_hooks_dir(repo_path: &std::path::Path) -> Option { .arg("-C") .arg(repo_path) .args(["rev-parse", "--path-format=absolute", "--git-path", "hooks"]) + .env_remove("GIT_DIR") + .env_remove("GIT_WORK_TREE") + .env_remove("GIT_INDEX_FILE") + .env_remove("GIT_OBJECT_DIRECTORY") .output() .ok()?; if !output.status.success() { @@ -2017,6 +2062,21 @@ mod tests { ); } + #[test] + fn test_hook_block_resolves_serve_url_via_codesearch_home() { + let block = codesearch_hook_block(); + // serve_url lives under the relocatable global root: the hook must + // fall back through CODESEARCH_HOME, mirroring codesearch_home(). + assert!( + block.contains("${CODESEARCH_HOME:-$HOME/.codesearch}"), + "hook must honour CODESEARCH_HOME before ~/.codesearch" + ); + assert!( + !block.contains("$HOME/.codesearch/serve_url"), + "no direct ~/.codesearch/serve_url path may remain" + ); + } + #[test] fn test_full_hook_has_posix_shebang() { let hook = codesearch_full_hook(); @@ -2094,6 +2154,58 @@ mod tests { assert_eq!(after_second.matches(HOOK_BEGIN).count(), 1); } + #[test] + fn test_serve_heavy_work_limit_flags_parse() { + let cli = Cli::try_parse_from([ + "codesearch", + "serve", + "--index-jobs", + "2", + "--embed-threads", + "4", + "--embed-pause-ms", + "25", + "--min-free-mb", + "4096", + ]) + .expect("cli parse should succeed"); + match cli.command { + Commands::Serve { + index_jobs, + embed_threads, + embed_pause_ms, + min_free_mb, + .. + } => { + assert_eq!(index_jobs, Some(2)); + assert_eq!(embed_threads, Some(4)); + assert_eq!(embed_pause_ms, Some(25)); + assert_eq!(min_free_mb, Some(4096)); + } + _ => panic!("expected Serve command"), + } + } + + #[test] + fn test_serve_heavy_work_limit_flags_default_to_none() { + let cli = Cli::try_parse_from(["codesearch", "serve"]).expect("cli parse should succeed"); + match cli.command { + Commands::Serve { + index_jobs, + embed_threads, + embed_pause_ms, + min_free_mb, + .. + } => { + assert_eq!(index_jobs, None, "unset flags must leave env/defaults"); + assert_eq!(embed_threads, None); + assert_eq!(embed_pause_ms, None); + assert_eq!(min_free_mb, None); + } + _ => panic!("expected Serve command"), + } + } + #[test] fn test_mcp_create_index_defaults_to_true() { let cli = Cli::try_parse_from(["codesearch", "mcp"]).expect("cli parse should succeed"); diff --git a/src/cli/setup.rs b/src/cli/setup.rs index 2fcd8c67..5bc7315f 100644 --- a/src/cli/setup.rs +++ b/src/cli/setup.rs @@ -1,12 +1,91 @@ -use anyhow::Result; +use anyhow::{anyhow, Result}; + +use crate::embed::ModelType; + +/// Resolve the CLI `--model` argument to a [`ModelType`]. +/// +/// Thin setup-specific wrapper over [`super::parse_model_arg`]: setup wants +/// the default model when the flag is absent, where other commands keep +/// `None` for per-query resolution. +fn resolve_model(model: Option<&str>) -> Result { + Ok(super::parse_model_arg(model)?.unwrap_or_default()) +} pub async fn run(model: Option) -> Result<()> { - let model_name = model.unwrap_or_else(|| "mxbai-embed-xsmall-v1".to_string()); + let model_type = resolve_model(model.as_deref())?; + + let cache_dir = crate::constants::get_global_models_cache_dir()?; + + println!( + "📦 Downloading embedding model: {} ({})", + model_type.name(), + model_type.short_name() + ); + println!(" Cache dir: {}", cache_dir.display()); - println!("📦 Downloading embedding model: {}", model_name); + // Unlike the runtime paths, setup shows the download progress bar: it + // pulls hundreds of MB on purpose and a silent run looks like a hang. + let mut embedder = crate::embed::FastEmbedder::with_cache_dir_progress( + model_type, + Some(&cache_dir), + true, + ) + .map_err(|e| { + anyhow!( + "Failed to initialize embedding model: {e}\n\ + Hint: if huggingface.co is unreachable, set HF_ENDPOINT to a HuggingFace mirror and retry." + ) + })?; - // TODO: Download model from HuggingFace Hub + // Probe inference so a broken download fails here, not mid-indexing. + let dimensions = embedder.embed_query("setup probe")?.len(); + if dimensions != model_type.dimensions() { + return Err(anyhow!( + "Model returned {dimensions} dims, expected {}", + model_type.dimensions() + )); + } - println!("✅ Setup complete!"); + println!( + "✅ Setup complete! Model '{}' ({dimensions} dims) ready at {}", + model_type.short_name(), + cache_dir.display() + ); Ok(()) } + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn unknown_model_is_rejected_with_valid_list() { + let err = resolve_model(Some("not-a-model")).expect_err("unknown model must be rejected"); + let msg = format!("{err:#}"); + assert!( + msg.contains("not-a-model"), + "error must echo the bad name: {msg}" + ); + assert!( + msg.contains(ModelType::valid_short_names().as_str()), + "error must list valid models: {msg}" + ); + } + + #[test] + fn none_resolves_to_default_model() { + assert_eq!(resolve_model(None).unwrap(), ModelType::default()); + } + + #[test] + fn known_short_names_resolve() { + assert_eq!( + resolve_model(Some("embeddinggemma-q4")).unwrap(), + ModelType::EmbeddingGemma300MQ4 + ); + assert_eq!( + resolve_model(Some("minilm-l6-q")).unwrap(), + ModelType::default() + ); + } +} diff --git a/src/constants.rs b/src/constants.rs index 6d783876..c0e5437b 100644 --- a/src/constants.rs +++ b/src/constants.rs @@ -16,6 +16,10 @@ use std::sync::atomic::{AtomicBool, Ordering}; /// is honoured within a few seconds even during heavy CPU work. pub static SHUTDOWN_REQUESTED: AtomicBool = AtomicBool::new(false); +/// Grace for blocking tasks after serve returns; anything still running is +/// abandoned with the process. +pub const RUNTIME_SHUTDOWN_GRACE_SECS: u64 = 5; + /// Check whether a graceful shutdown has been requested (CTRL-C). #[inline] pub fn is_shutdown_requested() -> bool { @@ -41,6 +45,12 @@ pub const CONFIG_DIR_NAME: &str = ".codesearch"; /// Name of the file metadata database pub const FILE_META_DB_NAME: &str = "file_meta.json"; +/// Rename attempts when publishing the file metadata (AV/Search indexer can hold the file) +pub const FILE_META_SAVE_RENAME_ATTEMPTS: u32 = 5; + +/// Delay between file metadata rename attempts, in milliseconds +pub const FILE_META_SAVE_RENAME_DELAY_MS: u64 = 100; + /// Subdirectory name for embedding models within the global config dir const MODELS_SUBDIR: &str = "models"; @@ -59,18 +69,50 @@ pub const DEFAULT_LOG_MAX_FILES: usize = 5; /// Default log retention period in days pub const DEFAULT_LOG_RETENTION_DAYS: u64 = 5; -/// Get the global models cache directory (~/.codesearch/models/). +/// Environment variable relocating the entire global codesearch root. /// -/// This centralizes embedding model downloads so they are shared across all -/// databases instead of being duplicated per-project. The directory is created -/// if it does not exist. +/// When set to a non-empty absolute path, every global artifact — repos.json, +/// the embedding-models cache, serve logs, serve_url, the global +/// .codesearchignore and extensions.json — resolves under it instead of +/// `~/.codesearch`. This is the single knob for machines that keep large +/// artifacts off the home directory. Per-file overrides such as +/// [`REPOS_CONFIG_ENV`] and [`EXTENSION_MAP_ENV`] still win when set. +pub const CODESEARCH_HOME_ENV: &str = "CODESEARCH_HOME"; + +/// Resolve the global codesearch root directory. /// -/// Falls back to a temp directory if the home directory cannot be determined. -pub fn get_global_models_cache_dir() -> anyhow::Result { - let base = - dirs::home_dir().ok_or_else(|| anyhow::anyhow!("Could not determine home directory"))?; +/// Returns `$CODESEARCH_HOME` when set and non-empty (it must be absolute — a +/// relative value would silently resolve against the current working +/// directory and fragment state between runs), otherwise `~/.codesearch`. +/// All global-path accessors derive from this single point, so one hook +/// relocates everything. +pub fn codesearch_home() -> anyhow::Result { + if let Ok(dir) = std::env::var(CODESEARCH_HOME_ENV) { + let dir = dir.trim(); + if !dir.is_empty() { + let path = PathBuf::from(dir); + if !path.is_absolute() { + anyhow::bail!( + "{} must be an absolute path, got: {}", + CODESEARCH_HOME_ENV, + dir + ); + } + return Ok(path); + } + } + dirs::home_dir() + .map(|home| home.join(CONFIG_DIR_NAME)) + .ok_or_else(|| anyhow::anyhow!("Could not determine home directory")) +} - let models_dir = base.join(CONFIG_DIR_NAME).join(MODELS_SUBDIR); +/// Get the global models cache directory (`/models/`). +/// +/// This centralizes embedding model downloads so they are shared across all +/// databases instead of being duplicated per-project. Relocated wholesale via +/// [`CODESEARCH_HOME_ENV`]. The directory is created if it does not exist. +pub fn get_global_models_cache_dir() -> anyhow::Result { + let models_dir = codesearch_home()?.join(MODELS_SUBDIR); if !models_dir.exists() { std::fs::create_dir_all(&models_dir).map_err(|e| { @@ -85,13 +127,17 @@ pub fn get_global_models_cache_dir() -> anyhow::Result { Ok(models_dir) } -/// Get the global cache directory (~/.codesearch/). +/// Get the global cache directory (`/`). /// /// Used for client/auto mode logging when no local DB is available. -/// The directory is created if it does not exist. +/// Relocated wholesale via [`CODESEARCH_HOME_ENV`]. The directory is created +/// if it does not exist. pub fn get_global_cache_dir() -> PathBuf { - let base = dirs::home_dir().unwrap_or_else(|| std::env::current_dir().unwrap_or_default()); - let cache_dir = base.join(CONFIG_DIR_NAME); + let cache_dir = codesearch_home().unwrap_or_else(|_| { + std::env::current_dir() + .unwrap_or_default() + .join(CONFIG_DIR_NAME) + }); if !cache_dir.exists() { let _ = std::fs::create_dir_all(&cache_dir); } @@ -101,18 +147,19 @@ pub fn get_global_cache_dir() -> PathBuf { /// Name of the global codesearchignore file in ~/.codesearch/ pub const GLOBAL_CODESEARCHIGNORE_FILE: &str = ".codesearchignore"; -/// Get the path to the global .codesearchignore file (~/.codesearch/.codesearchignore). +/// Get the path to the global .codesearchignore file +/// (`/.codesearchignore`). /// /// This file uses the same gitignore syntax and is applied to all indexed repos, /// providing a way to set ignore rules without modifying repo-local files. /// Repo-local `.codesearchignore` and `.gitignore` take precedence. +/// Relocated wholesale via [`CODESEARCH_HOME_ENV`]. /// -/// Returns `None` only if the home directory cannot be determined. +/// Returns `None` only if the root cannot be resolved. pub fn global_codesearchignore_path() -> Option { - dirs::home_dir().map(|home| { - home.join(CONFIG_DIR_NAME) - .join(GLOBAL_CODESEARCHIGNORE_FILE) - }) + codesearch_home() + .ok() + .map(|root| root.join(GLOBAL_CODESEARCHIGNORE_FILE)) } /// Name of the global extension→language map file in ~/.codesearch/ @@ -132,15 +179,17 @@ pub const EXTENSION_MAP_ENV: &str = "CODESEARCH_EXTENSION_MAP"; /// the binary. User overrides take precedence over the built-in extension table. /// /// The path resolves to `$CODESEARCH_EXTENSION_MAP` when set and non-empty, -/// otherwise `~/.codesearch/extensions.json`. Returns `None` only when neither -/// the env var nor the home directory is available. +/// otherwise `/extensions.json`. Returns `None` only when +/// neither the env var nor a resolvable root is available. pub fn global_extension_map_path() -> Option { if let Ok(p) = std::env::var(EXTENSION_MAP_ENV) { if !p.is_empty() { return Some(PathBuf::from(p)); } } - dirs::home_dir().map(|home| home.join(CONFIG_DIR_NAME).join(GLOBAL_EXTENSION_MAP_FILE)) + codesearch_home() + .ok() + .map(|root| root.join(GLOBAL_EXTENSION_MAP_FILE)) } /// Name of the repos configuration file @@ -504,20 +553,28 @@ pub const REMOTE_ROW_REFRESH_SECS: u64 = 5; /// cancellation between insert and remove silently leaks the entry, leaving /// the TUI stuck on "Indexing" forever. /// -/// Rather than chase every leak path, entries older than this threshold are +/// Rather than chase every leak path, a marker older than this threshold is /// treated as absent by all read sites (`repo_statuses_lightweight`, -/// `evict_idle_repos`, and the reindex 409 guard) and lazily evicted. This -/// makes the system self-healing regardless of the leak cause. +/// `evict_idle_repos`, and the reindex 409 guard) and lazily evicted — but +/// only when no tracked indexing task for the alias is still alive. A live +/// task (queued on the job gate, or in a long uninterruptible build) renews +/// its marker instead, so a backlog drains rather than being cancelled as +/// "leaked"; the system stays self-healing for genuinely dead tasks without +/// killing slow ones. /// /// 30 minutes is deliberately generous: a force reindex of a very large repo /// or a full scip-csharp solution rebuild can legitimately take many minutes. -/// Any session stuck beyond that is almost certainly leaked. /// Override with `CODESEARCH_MAX_INDEXING_SECS`. pub const MAX_INDEXING_SECS: u64 = 30 * 60; // 30 minutes /// Environment variable to override the maximum indexing duration. pub const MAX_INDEXING_SECS_ENV: &str = "CODESEARCH_MAX_INDEXING_SECS"; +/// How often a flow without its own progress callback (the SCIP symbol +/// rebuild) renews its indexing marker so it never ages out at +/// `MAX_INDEXING_SECS` mid-run. Must stay well below that threshold. +pub const INDEXING_MARKER_HEARTBEAT_SECS: u64 = 60; + /// How long an MCP handler may wait for the vector-store read lock before /// giving up with a "store busy" error. /// @@ -634,6 +691,27 @@ pub const HELPERS_SUBDIR: &str = "helpers"; /// Debounce time in milliseconds for .cs file changes triggering a symbol rebuild. pub const SCIP_CSHARP_DEBOUNCE_MS: u64 = 60_000; // 60 seconds +/// Environment variable overriding the restore-pending retry interval in +/// seconds (issue #225). Values ≤ 0 or unparseable fall back to the +/// built-in interval (a zero interval would hot-spin the helper); tests +/// use 1 to exercise the retry loop in seconds instead of minutes. +pub const SCIP_RESTORE_RETRY_INTERVAL_SECS_ENV: &str = "CODESEARCH_RESTORE_RETRY_INTERVAL_SECS"; + +/// File names whose change invalidates NuGet restore state: the serve file +/// watcher fires a FULL C# symbol rebuild when any of these changes, not +/// just the per-project incremental (.cs) rebuild — a central-package- +/// management bump invalidates every project at once (issue #225). Must +/// stay in sync with the C# helper's `RestoreInputs` (helpers/csharp/ +/// RestorePolicy.cs), which gates the workspace load on the same names. +/// Compared case-insensitively by the watcher. +pub const CSHARP_RESTORE_INPUT_FILES: &[&str] = &[ + "Directory.Packages.props", + "Directory.Build.props", + "Directory.Build.targets", + "NuGet.config", + "global.json", +]; + /// LMDB database name for the SCIP symbols table. pub const SCIP_SYMBOLS_DB_NAME: &str = "scip_symbols"; @@ -655,6 +733,34 @@ pub const SCIP_HEAD_SHA_KEY: &str = "head_sha"; /// old-format keys being served as fresh. pub const SCIP_KEY_FORMAT_KEY: &str = "key_format"; +/// LMDB metadata key holding a JSON array of index-level completeness +/// warnings from the last rebuild (workspace/MSBuild failures the helper +/// survived while still producing an index). Absent or empty = built clean. +/// Surfaced on every `find_impact` answer from that index — a reference +/// list out of a partially loaded solution may be missing callers. +pub const SCIP_INDEX_WARNINGS_KEY: &str = "index_warnings"; + +/// LMDB metadata key stamping which index-builder generation produced the +/// index (chunk file-meta cache and SCIP symbol meta alike). +/// The rebuild gates treat an index whose stamp is absent or differs from +/// [`INDEX_BUILDER_VERSION`] as stale: after a conventions change, serve +/// rebuilds the indexes itself at startup instead of waiting for a manual +/// command. +pub const SCIP_INDEX_BUILDER_VERSION_KEY: &str = "index_builder_version"; + +/// The value written for [`SCIP_INDEX_BUILDER_VERSION_KEY`] by this binary. +/// +/// A HAND-BUMPED generation marker, deliberately NOT tied to the package +/// version: the patch version bumps on every merged PR, and a per-build +/// stamp wiped every repo's chunk cache and symbol indexes at each binary +/// swap (field incident 14–15 Oct 2026: ten patch bumps in one day meant a +/// full fleet re-embed per restart, and the long commit windows let the +/// Windows AV/Search-Indexer lock race kill builds, leaving repos +/// registered with 0 chunks). Bump this ONLY when the chunker or SCIP +/// conventions change shape — not for code or dependency changes that do +/// not alter what gets written. +pub const INDEX_BUILDER_VERSION: &str = "2026-10.1"; + /// Current value written for [`SCIP_KEY_FORMAT_KEY`]. Bump whenever the /// canonical SCIP symbol key format produced by a language helper changes /// shape (B4: C# generic arity / containing-type path / fully qualified @@ -891,8 +997,12 @@ pub const ALWAYS_SKIP_FILENAME_SUFFIXES: &[&str] = &[ ".orig", ]; -/// Directories and files that should always be excluded from indexing -/// These are added to both .gitignore and .codesearchignore automatically +/// Directories and files that should always be excluded from indexing. +/// +/// This list is applied purely in memory: the file walker filters these names +/// during traversal and the watcher skips paths containing them. Nothing is +/// written to `.gitignore` or `.codesearchignore`, and previously indexed +/// content keeps appearing in search results until the next reindex. pub const ALWAYS_EXCLUDED: &[&str] = &[ // Codesearch databases ".codesearch", @@ -930,6 +1040,26 @@ pub const ALWAYS_EXCLUDED: &[&str] = &[ "coverage", ".nyc_output", ".cache", + // Dependency lock files — generated by package managers, never source. + // Matched by exact filename so the walker and watcher exclude them even + // when the extension alone is not skipped (pnpm-lock.yaml, + // package-lock.json, npm-shrinkwrap.json, bun.lockb). + "package-lock.json", + "npm-shrinkwrap.json", + "yarn.lock", + "pnpm-lock.yaml", + "bun.lock", + "bun.lockb", + "deno.lock", + "Cargo.lock", + "go.sum", + "poetry.lock", + "Pipfile.lock", + "uv.lock", + "pdm.lock", + "composer.lock", + "Gemfile.lock", + "flake.lock", ]; #[cfg(test)] @@ -949,6 +1079,9 @@ mod tests { } #[test] + // Reads global-path accessors that resolve via CODESEARCH_HOME: must not + // overlap the serial tests that set/clear that env var in this binary. + #[serial_test::serial] fn global_codesearchignore_path_returns_home_codesearch_dir() { let path = global_codesearchignore_path(); assert!(path.is_some(), "Should return Some when home dir exists"); @@ -964,4 +1097,96 @@ mod tests { "Filename should match GLOBAL_CODESEARCHIGNORE_FILE constant" ); } + + #[test] + #[serial_test::serial] + fn codesearch_home_relocates_all_global_paths() { + let tmp = tempfile::tempdir().unwrap(); + let root = tmp.path().to_path_buf(); + // A developer machine with either per-file override exported would + // otherwise win over CODESEARCH_HOME and fail this test spuriously. + let _clear_specific = + crate::testing::EnvRestore::remove(&[REPOS_CONFIG_ENV, EXTENSION_MAP_ENV]); + let _set = + crate::testing::EnvRestore::set(&[(CODESEARCH_HOME_ENV, root.to_str().unwrap())]); + + assert_eq!(codesearch_home().unwrap(), root); + assert_eq!( + get_global_models_cache_dir().unwrap(), + root.join(MODELS_SUBDIR), + "models cache must live under CODESEARCH_HOME" + ); + assert!(root.join(MODELS_SUBDIR).exists()); + assert_eq!(get_global_cache_dir(), root); + assert_eq!( + global_codesearchignore_path(), + Some(root.join(GLOBAL_CODESEARCHIGNORE_FILE)) + ); + assert_eq!( + global_extension_map_path(), + Some(root.join(GLOBAL_EXTENSION_MAP_FILE)) + ); + assert_eq!( + crate::db_discovery::repos::config_path().unwrap(), + root.join(REPOS_CONFIG_FILE), + "repos.json default must follow CODESEARCH_HOME" + ); + } + + #[test] + #[serial_test::serial] + fn relative_codesearch_home_is_rejected() { + let _set = crate::testing::EnvRestore::set(&[(CODESEARCH_HOME_ENV, "relative/dir")]); + + let err = codesearch_home().unwrap_err(); + assert!( + err.to_string().contains("absolute"), + "error must mention the absolute-path requirement, got: {err}" + ); + assert!( + get_global_models_cache_dir().is_err(), + "a bad root must not silently fall back to the default models dir" + ); + assert_eq!( + global_codesearchignore_path(), + None, + "a bad root must not silently resolve the global ignore file" + ); + } + + #[test] + #[serial_test::serial] + fn empty_or_unset_codesearch_home_falls_back_to_default() { + let expected = dirs::home_dir().unwrap().join(CONFIG_DIR_NAME); + + let _empty = crate::testing::EnvRestore::set(&[(CODESEARCH_HOME_ENV, "")]); + assert_eq!( + codesearch_home().unwrap(), + expected, + "an empty override must fall back to ~/.codesearch" + ); + + let _unset = crate::testing::EnvRestore::remove(&[CODESEARCH_HOME_ENV]); + assert_eq!(codesearch_home().unwrap(), expected); + } + + #[test] + #[serial_test::serial] + fn specific_overrides_win_over_codesearch_home() { + let tmp = tempfile::tempdir().unwrap(); + let map_path = tmp.path().join("my-extensions.json"); + let repos_path = tmp.path().join("my-repos.json"); + let _set = crate::testing::EnvRestore::set(&[ + (CODESEARCH_HOME_ENV, tmp.path().to_str().unwrap()), + (EXTENSION_MAP_ENV, map_path.to_str().unwrap()), + (REPOS_CONFIG_ENV, repos_path.to_str().unwrap()), + ]); + + assert_eq!(global_extension_map_path(), Some(map_path)); + assert_eq!( + crate::db_discovery::repos::config_path().unwrap(), + repos_path, + "CODESEARCH_REPOS_CONFIG must win over CODESEARCH_HOME" + ); + } } diff --git a/src/db_discovery/repos.rs b/src/db_discovery/repos.rs index 36ce1bd2..6bdfc523 100644 --- a/src/db_discovery/repos.rs +++ b/src/db_discovery/repos.rs @@ -5,7 +5,7 @@ use std::fs; use std::path::{Path, PathBuf}; use crate::cache::{normalize_user_path, safe_canonicalize, strip_unc_prefix}; -use crate::constants::{CONFIG_DIR_NAME, REPOS_CONFIG_FILE}; +use crate::constants::REPOS_CONFIG_FILE; /// A remote `codesearch serve` peer that can be queried for federation. /// @@ -1147,8 +1147,7 @@ impl ReposConfig { } pub fn config_dir() -> Result { - let home_dir = dirs::home_dir().ok_or_else(|| anyhow::anyhow!("No home directory found"))?; - Ok(home_dir.join(CONFIG_DIR_NAME)) + crate::constants::codesearch_home() } pub fn config_path() -> Result { @@ -1241,6 +1240,13 @@ pub(crate) fn git_remote_url(path: &Path) -> Option { .arg("-C") .arg(path) .args(["config", "--get", "remote.origin.url"]) + // A caller running under git (e.g. a push hook) exports GIT_DIR / + // GIT_WORK_TREE, which would override `-C` and read the WRONG + // repo's remote. Scrub them so discovery keys off `path` alone. + .env_remove("GIT_DIR") + .env_remove("GIT_WORK_TREE") + .env_remove("GIT_INDEX_FILE") + .env_remove("GIT_OBJECT_DIRECTORY") .output() { Ok(o) => { diff --git a/src/db_discovery/repos_tests.rs b/src/db_discovery/repos_tests.rs index d1e31a1a..27f0e3f7 100644 --- a/src/db_discovery/repos_tests.rs +++ b/src/db_discovery/repos_tests.rs @@ -46,6 +46,10 @@ fn init_git_remote(dir: &Path, url: &str) { .arg("-C") .arg(dir) .args(args) + .env_remove("GIT_DIR") + .env_remove("GIT_WORK_TREE") + .env_remove("GIT_INDEX_FILE") + .env_remove("GIT_OBJECT_DIRECTORY") .output() { Ok(o) => return o, @@ -294,14 +298,20 @@ fn register_leaves_unix_path_untouched() { let tmp = tempfile::tempdir().unwrap(); let repo = tmp.path().join("propagate-tmp-repo"); std::fs::create_dir(&repo).unwrap(); - let path_str = repo.to_string_lossy().to_string(); + // register() canonicalizes its input; on macOS the temp dir lives under the + // /var -> /private/var symlink, so the raw temp path is not the canonical + // one. Compare against the canonical path so this test pins its real + // intent — register() applies no Windows/MSYS rewrite on Unix — rather + // than the host's temp-dir symlink layout (which made it fail on macOS, + // blocking the local QC gate on every push). + let expected = std::fs::canonicalize(&repo).unwrap(); let mut cfg = ReposConfig::default(); let alias = cfg.register(repo.clone()); let stored = cfg.repos.get(&alias).expect("alias must be registered"); assert_eq!( stored.to_string_lossy(), - path_str, + expected.to_string_lossy(), "register() must not rewrite Unix paths" ); } diff --git a/src/embed/embedder.rs b/src/embed/embedder.rs index 75472d15..96065ebf 100644 --- a/src/embed/embedder.rs +++ b/src/embed/embedder.rs @@ -318,6 +318,27 @@ impl FastEmbedder { pub fn with_cache_dir( model_type: ModelType, cache_dir: Option<&std::path::Path>, + ) -> Result { + Self::init(model_type, cache_dir, false) + } + + /// Create a new embedder with the fastembed download progress bar visible. + /// + /// Only `codesearch setup` wants this: it downloads hundreds of MB on + /// purpose, and a silent run looks like a hang. Runtime paths keep the + /// bar off so it does not corrupt TUI/serve output. + pub fn with_cache_dir_progress( + model_type: ModelType, + cache_dir: Option<&std::path::Path>, + show_download_progress: bool, + ) -> Result { + Self::init(model_type, cache_dir, show_download_progress) + } + + fn init( + model_type: ModelType, + cache_dir: Option<&std::path::Path>, + show_download_progress: bool, ) -> Result { // Set cache directory via environment variable if provided // Note: fastembed library uses FASTEMBED_CACHE_DIR (not FASTEMBED_CACHE_PATH) @@ -332,31 +353,50 @@ impl FastEmbedder { // Arena allocator provides fast memory reuse during inference. let cpu_ep = CPU::default().with_arena_allocator(true).build(); - let model = TextEmbedding::try_new( - TextInitOptions::new(model_type.to_fastembed_model()) - .with_show_download_progress(false) - .with_execution_providers(vec![cpu_ep]), - ) - .map_err(|e| anyhow!("Failed to initialize embedding model: {}", e))?; + let options = TextInitOptions::new(model_type.to_fastembed_model()) + .with_show_download_progress(show_download_progress) + .with_execution_providers(vec![cpu_ep]); + + // Cap ONNX intra-op threads when CODESEARCH_EMBED_THREADS is set. + // Unset leaves fastembed/ONNX Runtime at its default (all cores): one + // inference alone can saturate a large machine, which starves every + // other task on a shared box. See `crate::limits`. + let options = match crate::limits::embed_threads() { + Some(threads) => options.with_intra_threads(threads), + None => options, + }; + + let model = TextEmbedding::try_new(options) + .map_err(|e| anyhow!("Failed to initialize embedding model: {}", e))?; Ok(Self { model, model_type }) } - /// Embed a batch of texts (processes in mini-batches to avoid OOM) - /// Uses adaptive batch size based on model dimensions - /// Can be overridden with CODESEARCH_BATCH_SIZE environment variable - pub fn embed_batch(&mut self, texts: Vec) -> Result>> { + /// Mini-batch size for a single ONNX `embed` call: `CODESEARCH_BATCH_SIZE` + /// when set, otherwise adaptive by model dimensions. + /// + /// Shared by [`Self::embed_batch`] and the serve pool's interleaved batch + /// loop (`EmbeddingServicePool::embed_chunks_yielding`), so both agree on + /// how long one ONNX call (and therefore one lock acquisition) lasts. + pub fn effective_batch_size(model_type: ModelType) -> usize { // Check for env var override (tune with CODESEARCH_BATCH_SIZE=N) - let batch_size = if let Ok(env_size) = std::env::var("CODESEARCH_BATCH_SIZE") { + if let Ok(env_size) = std::env::var("CODESEARCH_BATCH_SIZE") { env_size.parse().unwrap_or(256) } else { // Adaptive batch size: without arena allocator, ONNX frees buffers after each batch // so larger batches are faster without accumulating memory. - match self.model_type.dimensions() { + match model_type.dimensions() { d if d <= 384 => 256, // Small models (MiniLM etc.) d if d <= 768 => 128, // Medium models (BGE-base, Jina etc.) _ => 64, // Large models (BGE-large, MxBai etc.) } - }; + } + } + + /// Embed a batch of texts (processes in mini-batches to avoid OOM) + /// Uses adaptive batch size based on model dimensions + /// Can be overridden with CODESEARCH_BATCH_SIZE environment variable + pub fn embed_batch(&mut self, texts: Vec) -> Result>> { + let batch_size = Self::effective_batch_size(self.model_type); self.embed_batch_chunked(texts, batch_size) } diff --git a/src/embed/mod.rs b/src/embed/mod.rs index bc0a497f..b653e7ba 100644 --- a/src/embed/mod.rs +++ b/src/embed/mod.rs @@ -341,6 +341,47 @@ impl EmbeddingServicePool { guard.insert(model, arc.clone()); Ok(arc) } + + /// Embed `chunks`, releasing the service lock between ONNX mini-batches. + /// + /// The per-model `Mutex` is what serialises embedding + /// between repos and queries. Holding it for a whole refresh batch (one + /// `CODESEARCH_INCREMENTAL_BATCH_SIZE` window can hold thousands of + /// chunks) made an interactive query embedding queue behind minutes of + /// background inference. Each lock acquisition here covers exactly one + /// ONNX mini-batch ([`FastEmbedder::effective_batch_size`]), followed by + /// the optional `pause` duty cycle, so a long background pass yields the + /// model between mini-batches. + pub fn embed_chunks_yielding( + &self, + model: ModelType, + chunks: Vec, + pause: std::time::Duration, + ) -> Result> { + if chunks.is_empty() { + return Ok(Vec::new()); + } + let service = self.get(model)?; + let group_size = FastEmbedder::effective_batch_size(model).max(1); + let mut out: Vec = Vec::with_capacity(chunks.len()); + for group in chunks.chunks(group_size) { + { + // Recover from poisoning: a panicked embed service still yields + // a valid guard; the batch result carries correctness, and a + // poison here must not hard-fail every later batch for the + // process lifetime. + let mut guard = service + .lock() + .unwrap_or_else(std::sync::PoisonError::into_inner); + let mut embedded = guard.embed_chunks(group.to_vec())?; + out.append(&mut embedded); + } + if !pause.is_zero() { + std::thread::sleep(pause); + } + } + Ok(out) + } } #[cfg(test)] @@ -353,6 +394,47 @@ mod tests { assert_eq!(model.dimensions(), 384); } + /// Mini-batch size drives how long one lock acquisition lasts; pin the + /// dimension-adaptive default and the env override. + #[test] + #[serial_test::serial] + fn effective_batch_size_defaults_by_dimensions_and_env_overrides() { + let _unset = crate::testing::EnvRestore::remove(&["CODESEARCH_BATCH_SIZE"]); + assert_eq!( + FastEmbedder::effective_batch_size(ModelType::AllMiniLML6V2Q), + 256, + "384-dim models use 256-text mini-batches" + ); + assert_eq!( + FastEmbedder::effective_batch_size(ModelType::EmbeddingGemma300MQ4), + 128, + "768-dim models use 128-text mini-batches" + ); + assert_eq!( + FastEmbedder::effective_batch_size(ModelType::BGELargeENV15), + 64, + ">768-dim models use 64-text mini-batches" + ); + + let _override = crate::testing::EnvRestore::set(&[("CODESEARCH_BATCH_SIZE", "7")]); + assert_eq!( + FastEmbedder::effective_batch_size(ModelType::EmbeddingGemma300MQ4), + 7, + "CODESEARCH_BATCH_SIZE must win over the adaptive default" + ); + } + + /// The interleaved embed path must not even load the model for an empty + /// batch; this is its no-op arm and the only one testable without ONNX. + #[test] + fn embed_chunks_yielding_empty_is_a_noop() { + let pool = EmbeddingServicePool::new(None); + let out = pool + .embed_chunks_yielding(ModelType::default(), Vec::new(), std::time::Duration::ZERO) + .expect("empty embed must succeed"); + assert!(out.is_empty()); + } + /// The index-metadata reader must invert `write_metadata_fields`, and must /// report "no answer" (None) for unknown/missing names rather than silently /// claiming the default — callers decide the fallback. diff --git a/src/file/mod.rs b/src/file/mod.rs index b98c3d1d..6cfa21e3 100644 --- a/src/file/mod.rs +++ b/src/file/mod.rs @@ -322,6 +322,25 @@ mod tests { assert_eq!(files[0].path.file_name().unwrap(), "index.js"); } + /// Dependency lock files are excluded by exact filename: their extensions + /// (.yaml/.json) are indexable on their own, so without the name match the + /// walker would index every churn commit of a generated lock file. + #[test] + fn test_excluded_lock_files() { + let dir = TempDir::new().unwrap(); + + fs::write(dir.path().join("pnpm-lock.yaml"), "lockVersion: '9.0'").unwrap(); + fs::write(dir.path().join("package-lock.json"), "{}").unwrap(); + fs::write(dir.path().join("yarn.lock"), "# yarn lockfile").unwrap(); + fs::write(dir.path().join("main.rs"), "fn main() {}").unwrap(); + + let walker = FileWalker::new(dir.path()); + let (files, _) = walker.walk().unwrap(); + + assert_eq!(files.len(), 1); + assert_eq!(files[0].path.file_name().unwrap(), "main.rs"); + } + /// A root whose own name matches an `ALWAYS_EXCLUDED` entry (e.g. `.git`) /// must be rejected at `walk()` time — otherwise the depth==0 short-circuit /// in `filter_entry` would let every internal file be indexed. diff --git a/src/fts/tantivy_store.rs b/src/fts/tantivy_store.rs index 2f05ade2..4844678c 100644 --- a/src/fts/tantivy_store.rs +++ b/src/fts/tantivy_store.rs @@ -29,6 +29,10 @@ pub struct FtsResult { pub score: f32, } +/// Shared prefix of every commit-failure message `FtsStore::commit` returns; +/// scopes the transient-error classifier to commit failures. +const FTS_COMMIT_FAILED_CONTEXT: &str = "FTS commit failed"; + enum CommitAttempt { Committed, PrepareFailed(String), @@ -420,6 +424,23 @@ impl FtsStore { || error.contains("IoError") } + /// Whether this failure is the transient Windows new-segment race: an + /// indexer (Defender / Search) holds the freshly created segment file + /// while tantivy opens it for the commit write (os error 5/32/33). + /// Only a failure of THIS class justifies redoing the whole indexing + /// pass — a commit retry on the same writer is never safe (a + /// half-joined pipeline must not be recommitted, see `commit_once`). + /// + /// Scoped to `commit()` failures (`FTS_COMMIT_FAILED_CONTEXT`): the same + /// OS errors from a store open, or a killed writer, are not this race. + pub fn is_transient_fts_commit_error(error: &str) -> bool { + error.contains(FTS_COMMIT_FAILED_CONTEXT) + && (error.contains("Access is denied") + || error.contains("os error 5") + || error.contains("os error 32") + || error.contains("os error 33")) + } + /// One commit attempt, split so a failure in `prepare_commit` is told /// apart from a failure while publishing an already-prepared commit. /// @@ -711,12 +732,14 @@ impl FtsStore { } /// Clear the entire index - #[allow(dead_code)] // Reserved for index reset pub fn clear(&mut self) -> Result<()> { self.ensure_writer()?; let writer = self.writer.as_mut().unwrap(); writer.delete_all_documents()?; - writer.commit()?; + // classifier scope: is_transient_fts_commit_error matches only this prefix + writer + .commit() + .map_err(|e| anyhow!("{FTS_COMMIT_FAILED_CONTEXT}: {e}"))?; self.reader.reload()?; Ok(()) } @@ -734,6 +757,51 @@ pub struct FtsStats { mod tests { use super::*; + /// The classifier must match the AV/new-segment race shapes seen in the + /// field (the exact logged incident message included) and refuse + /// everything a full-pass retry cannot fix. + #[test] + fn transient_fts_commit_classifier_matches_the_av_race_only() { + let logged = "FTS commit failed while flushing indexing workers: Failed to open \ + file for write: 'IoError { io_error: Os { code: 5, kind: PermissionDenied, \ + message: \"Access is denied.\" }, filepath: \"55fb.pos\" }'"; + assert!(FtsStore::is_transient_fts_commit_error(logged)); + assert!(FtsStore::is_transient_fts_commit_error( + "FTS commit failed: Failed to open file (os error 5)" + )); + assert!(FtsStore::is_transient_fts_commit_error( + "FTS commit failed: Failed to open file (os error 32)" + )); + assert!(FtsStore::is_transient_fts_commit_error( + "FTS commit failed after 5 retries: Failed to open file (os error 33)" + )); + assert!(!FtsStore::is_transient_fts_commit_error( + "writer was killed" + )); + assert!(!FtsStore::is_transient_fts_commit_error( + "Access is denied (os error 5)" + )); + assert!(!FtsStore::is_transient_fts_commit_error( + "FTS writer was killed during commit: Access is denied. os error 5" + )); + assert!(!FtsStore::is_transient_fts_commit_error( + "FTS commit after recovery failed: Access is denied. (os error 5)" + )); + assert!(!FtsStore::is_transient_fts_commit_error("schema error")); + } + + #[test] + fn clear_removes_committed_documents() -> Result<()> { + let mut store = FtsStore::new_in_memory()?; + store.add_chunk(1, "fn hello() {}", "src/main.rs", Some("hello"), "function")?; + store.commit()?; + assert_eq!(store.stats()?.num_documents, 1); + + store.clear()?; + assert_eq!(store.stats()?.num_documents, 0); + Ok(()) + } + #[test] fn test_fts_basic() -> Result<()> { let mut store = FtsStore::new_in_memory()?; diff --git a/src/index/manager.rs b/src/index/manager.rs index ff190f91..4690d3c6 100644 --- a/src/index/manager.rs +++ b/src/index/manager.rs @@ -45,20 +45,49 @@ use super::Result; /// POST-/reindex paths. Without `Started`, a watcher-triggered rebuild only /// ever reported its terminal state, so the C#-specific indicator never showed /// "Indexing" while the (35–84s) rebuild was actually running. +#[derive(Debug, PartialEq)] pub enum SymbolRebuildSignal { /// A rebuild is about to run (helper available and project applies). Started, - /// Rebuild finished successfully. - Succeeded, + /// Rebuild finished successfully. Carries the index-level warnings the + /// rebuild survived (empty = clean) so the serve layer can render a + /// degraded index red instead of green — the watcher path is the common + /// path during active development, and a green indicator on an index + /// with missing cross-project references reads as "safe". + Succeeded { index_warnings: Vec }, /// Rebuild failed with the given message. Failed(String), + /// Rebuild was abandoned because `dotnet restore` never finished within + /// the retry cap: LMDB untouched, the previous index stays live. NOT a + /// failure — the serve layer renders a warning (yellow C#⚠), not a red + /// error. + Abandoned(String), +} + +/// Terminal signal for a grouped incremental rebuild: a real failure +/// (`last_error`) wins over an abandonment (`last_abandon`), which wins over +/// success. Pure so the ordering is table-testable — the watcher-path +/// counterpart of the serve layer's `classify_symbol_rebuild_failure`. +pub(crate) fn grouped_rebuild_signal( + last_error: Option, + last_abandon: Option, + index_warnings: Vec, +) -> SymbolRebuildSignal { + if let Some(msg) = last_error { + SymbolRebuildSignal::Failed(msg) + } else if let Some(msg) = last_abandon { + SymbolRebuildSignal::Abandoned(msg) + } else { + SymbolRebuildSignal::Succeeded { index_warnings } + } } /// Callback invoked around each watcher-triggered C# symbol rebuild. /// /// Called with [`SymbolRebuildSignal::Started`] just before the rebuild runs, -/// then exactly once more with [`SymbolRebuildSignal::Succeeded`] or -/// [`SymbolRebuildSignal::Failed`] when it finishes. +/// then exactly once more with [`SymbolRebuildSignal::Succeeded`], +/// [`SymbolRebuildSignal::Failed`] or [`SymbolRebuildSignal::Abandoned`] when +/// it finishes. /// /// The serve layer uses this to update `csharp_index_status` / `csharp_index_error` /// without coupling `IndexManager` to `ServeState`. @@ -200,9 +229,76 @@ pub struct SharedStores { /// Counter for number of file changes processed (indexed + removed) since serve start. /// Incremented by FSW batches and incremental refreshes. Read by TUI/dashboard. pub changes_count: std::sync::atomic::AtomicU64, + /// Process-wide heavy-job gate. `Some` in serve mode (attached by + /// `ServeState::try_open_stores`), `None` in standalone CLI/MCP processes. + /// Every whole-repo refresh/reindex/build takes one permit from it; see + /// [`crate::limits`]. + pub job_gate: Option>, +} + +/// Mark the database directory hidden on Windows (the ".git" convention): +/// the Search indexer skips hidden directories, and its scanner holding a +/// freshly created Tantivy segment file is exactly the transient commit +/// race [`IndexManager::force_reindex_with_stores`] retries around. +/// Best-effort and idempotent — a missing or failing attrib never blocks +/// indexing. +#[cfg(windows)] +fn hide_db_dir_on_windows(db_path: &Path) { + let _ = std::process::Command::new("attrib") + .arg("+H") + .arg(db_path) + .stdout(std::process::Stdio::null()) + .stderr(std::process::Stdio::null()) + .status(); } +#[cfg(not(windows))] +fn hide_db_dir_on_windows(_db_path: &Path) {} + impl SharedStores { + /// Attach a process-wide heavy-job gate to these stores (serve mode). + pub fn with_job_gate(mut self, gate: Arc) -> Self { + self.job_gate = Some(gate); + self + } + + /// Acquire one heavy-job permit, or `None` when no gate is attached + /// (standalone processes keep their previous unbounded behaviour). + /// + /// Hold the returned permit for the whole job: that is what bounds how + /// many repos chunk/embed/build at once. Queries never take this permit. + pub async fn acquire_job_permit(&self) -> Option { + match self.job_gate.as_ref() { + Some(gate) => Some(gate.acquire().await), + None => None, + } + } + + /// Cancellation-aware variant of [`Self::acquire_job_permit`]. + /// + /// Returns [`crate::limits::JobAcquire::Cancelled`] when `cancel_token` + /// fires (or already fired) before a slot is granted, so the caller can + /// abort the job promptly and release its stores instead of parking on + /// the gate for the permit holder's whole run. + pub async fn acquire_job_permit_or_cancel( + &self, + cancel_token: &CancellationToken, + ) -> crate::limits::JobAcquire { + match self.job_gate.as_ref() { + Some(gate) => match gate.acquire_or_cancel(cancel_token).await { + Some(permit) => crate::limits::JobAcquire::Ready(Some(permit)), + None => crate::limits::JobAcquire::Cancelled, + }, + None => { + if cancel_token.is_cancelled() { + crate::limits::JobAcquire::Cancelled + } else { + crate::limits::JobAcquire::Ready(None) + } + } + } + } + /// Create new shared stores from the database path (read-write mode). /// /// This acquires a writer lock. If another process already has the lock, @@ -218,6 +314,13 @@ impl SharedStores { std::fs::create_dir_all(db_path).with_context(|| { format!("Failed to create database directory {}", db_path.display()) })?; + // The dot in ".codesearch.db" means nothing to Windows: the Search + // indexer crawls the folder like any other, and its scanner holding + // a freshly created Tantivy segment file is exactly the transient + // commit race `force_reindex_with_stores` retries around. The + // indexer skips hidden directories (the ".git" convention), so mark + // the folder hidden — idempotent, best-effort. + hide_db_dir_on_windows(db_path); // Try to acquire writer lock let lock = acquire_writer_lock(db_path); @@ -238,6 +341,7 @@ impl SharedStores { writer_lock: lock, readonly: false, changes_count: std::sync::atomic::AtomicU64::new(0), + job_gate: None, }) } @@ -257,6 +361,7 @@ impl SharedStores { writer_lock: None, readonly: true, changes_count: std::sync::atomic::AtomicU64::new(0), + job_gate: None, }) } @@ -321,6 +426,47 @@ fn is_ts_extension(path: &Path) -> bool { ) } +/// Returns true when `path` is a C# restore input (file NAME match, +/// case-insensitive): its change invalidates NuGet restore state and drives +/// a FULL C# symbol rebuild rather than the per-project incremental. +fn is_csharp_restore_input(path: &Path) -> bool { + path.file_name() + .and_then(|n| n.to_str()) + .is_some_and(|name| { + crate::constants::CSHARP_RESTORE_INPUT_FILES + .iter() + .any(|f| name.eq_ignore_ascii_case(f)) + }) +} + +/// Which symbol-rebuild debounce one watched file event feeds. Pure path +/// decision shared by the modify/delete/rename FSW arms so the +/// classification is table-testable without driving the async loop. +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +enum SymbolRebuildTrigger { + /// Per-project incremental (.cs) rebuild. + CSharpIncremental, + /// FULL solution rebuild: a restore-input change invalidates restore + /// state for every project at once (issue #225). + CSharpRestoreInput, + /// Full TypeScript rebuild (single tsconfig). + TypeScript, + /// Text-index only. + None, +} + +fn classify_symbol_rebuild_event(path: &Path) -> SymbolRebuildTrigger { + if path.extension().and_then(|e| e.to_str()) == Some("cs") { + SymbolRebuildTrigger::CSharpIncremental + } else if is_csharp_restore_input(path) { + SymbolRebuildTrigger::CSharpRestoreInput + } else if is_ts_extension(path) { + SymbolRebuildTrigger::TypeScript + } else { + SymbolRebuildTrigger::None + } +} + /// Where an embed pass gets its `EmbeddingService`: the serve-wide pool /// (which already holds the persistent cache's LMDB env open) or a fresh /// service (CLI / standalone MCP, own process). @@ -339,6 +485,18 @@ fn embed_service_choice(pool: Option<&Arc>) -> EmbeddingSo } } +/// True when the current refresh batch should stop accumulating files before +/// reading the next one. +/// +/// `consumed > 0` guarantees at least one file per batch, so a single file +/// larger than `max_chunks` still makes progress; `max_chunks == 0` disables +/// the cap entirely (the file-count batch size remains the only bound). +/// Extracted as a pure predicate so its edges are unit-testable without +/// loading ONNX. +fn chunk_cap_reached(consumed: usize, accumulated_chunks: usize, max_chunks: usize) -> bool { + consumed > 0 && max_chunks > 0 && accumulated_chunks >= max_chunks +} + impl IndexManager { /// Cancellation guard shared by every cancellable indexing function. /// @@ -600,6 +758,43 @@ impl IndexManager { cancel_token: &CancellationToken, embedding_pool: Option<&Arc>, heartbeat: Option<&IndexingHeartbeat>, + ) -> Result<()> { + // Serialise this whole refresh behind the process-wide heavy-job gate + // (when one is attached): the permit is held across the file walk, the + // chunk/embed batches and the final HNSW build, so at most + // `CODESEARCH_INDEX_JOBS` repos do this at once. Queries never take it. + // Cancellation-aware: a queued job that was cancelled aborts here and + // drops its stores instead of parking for the holder's whole run. + let _job_permit = match stores.acquire_job_permit_or_cancel(cancel_token).await { + crate::limits::JobAcquire::Ready(permit) => permit, + crate::limits::JobAcquire::Cancelled => { + return Err(anyhow::anyhow!("indexing cancelled")); + } + }; + Self::perform_incremental_refresh_inner( + codebase_path, + db_path, + stores, + cancel_token, + embedding_pool, + heartbeat, + ) + .await + } + + /// Gate-free body of [`Self::perform_incremental_refresh_with_stores`]. + /// + /// Split out for `force_reindex_with_stores`, which holds the gate permit + /// across the destructive clear phase as well and must call this directly: + /// re-entering the public wrapper would re-acquire the gate and deadlock + /// under `CODESEARCH_INDEX_JOBS=1`. + async fn perform_incremental_refresh_inner( + codebase_path: &Path, + db_path: &Path, + stores: &SharedStores, + cancel_token: &CancellationToken, + embedding_pool: Option<&Arc>, + heartbeat: Option<&IndexingHeartbeat>, ) -> Result<()> { use crate::cache::FileMetaStore; use crate::chunker::SemanticChunker; @@ -799,24 +994,43 @@ impl IndexManager { // sync. Batching bounds peak memory to O(batch), not O(total delta), // so a delta of any size is now safe — it just takes longer, spread // across sequential batches. See `INCREMENTAL_REFRESH_BATCH_SIZE`. + // + // A batch is additionally cut short once its accumulated chunks reach + // `CODESEARCH_MAX_CHUNKS_PER_BATCH` (when set): file count alone is a + // poor memory proxy when a few files can produce tens of thousands of + // chunks. if !changed_files.is_empty() { let batch_size = std::env::var(crate::constants::INCREMENTAL_REFRESH_BATCH_SIZE_ENV) .ok() .and_then(|s| s.parse::().ok()) .filter(|&n| n > 0) .unwrap_or(crate::constants::INCREMENTAL_REFRESH_BATCH_SIZE); - let total_batches = changed_files.len().div_ceil(batch_size); + let max_chunks = crate::limits::max_chunks_per_batch(); + let embed_pause = crate::limits::embed_pause(); + // Upper-bound estimate for the log line; the chunk cap can split + // this into more batches than the file count alone implies. + let estimated_batches = changed_files.len().div_ceil(batch_size); info!( - "🔄 Processing {} changed files in {} batch(es) of up to {} file(s) each...", + "🔄 Processing {} changed files in ~{} batch(es) of up to {} file(s) each \ + (chunk cap per batch: {})...", changed_files.len(), - total_batches, - batch_size + estimated_batches, + batch_size, + if max_chunks == 0 { + "none".to_string() + } else { + max_chunks.to_string() + } ); let cache_dir = crate::constants::get_global_models_cache_dir()?; let mut total_indexed = 0usize; + let mut cursor = 0usize; + let mut batch_idx = 0usize; - for (batch_idx, file_batch) in changed_files.chunks(batch_size).enumerate() { + while cursor < changed_files.len() { + let take = (changed_files.len() - cursor).min(batch_size); + let files_for_embed = changed_files[cursor..cursor + take].to_vec(); // Abort between batches if the repo was removed mid-index. Self::ensure_indexing_active(cancel_token)?; // A batch of a large delta can run for minutes — renew the @@ -832,7 +1046,11 @@ impl IndexManager { // so it never runs on a tokio worker thread. The `EmbeddingService` // and `SemanticChunker` are built inside the closure because they // are not needed on the async side and may not be `Send`. - let files_for_embed = file_batch.to_vec(); + // + // The closure consumes as many of the offered files as fit the + // chunk cap (always at least one, so every iteration makes + // progress) and reports how many it took, so the outer loop's + // bookkeeping covers exactly the files that were processed. let cache_dir_for_batch = cache_dir.clone(); let root_for_batch = codebase_path.to_path_buf(); // Clone the token into the blocking closure so a cancel arriving @@ -840,18 +1058,30 @@ impl IndexManager { // per-file, not only once the whole batch returns. let batch_cancel = cancel_token.clone(); let embed_source = embed_service_choice(embedding_pool); - let embedded_chunks = tokio::task::spawn_blocking( - move || -> Result> { + let (embedded_chunks, consumed) = tokio::task::spawn_blocking( + move || -> Result<(Vec, usize)> { let mut chunker = SemanticChunker::new(100, 2000, 10); let mut all_chunks = Vec::new(); + let mut consumed = 0usize; for file in &files_for_embed { + // Stop once this batch has reached its chunk budget. + // `consumed > 0` guarantees at least one file per + // iteration even if that one file alone exceeds the + // cap, so the outer loop always advances. + if chunk_cap_reached(consumed, all_chunks.len(), max_chunks) { + break; + } // Mid-embed cancellation point: abort inside the // spawn_blocking task so we stop reading/chunking/ // embedding further files in this batch promptly. if batch_cancel.is_cancelled() { return Err(anyhow::anyhow!("indexing cancelled")); } + // Count the file before the read: a read failure + // still advances the outer cursor, so the loop can + // never stall on an unreadable file. + consumed += 1; let content = match std::fs::read_to_string(&file.path) { Ok(c) => c, Err(_) => continue, @@ -867,54 +1097,46 @@ impl IndexManager { } if all_chunks.is_empty() { - return Ok(Vec::new()); + return Ok((Vec::new(), consumed)); } - // NOTE: embed_chunks runs a single ONNX inference over - // the whole batch atomically, so it is not interruptible - // mid-call. Worst-case cancel latency is bounded to one - // batch's embed (INCREMENTAL_REFRESH_BATCH_SIZE=200 - // files); the per-file check above bounds the read/chunk - // phase that precedes it. - match embed_source { - // Serve process: the pool already holds the - // persistent cache's LMDB env open — a fresh - // EmbeddingService here is refused by the - // process-global registry and would re-embed - // everything without cache. + // Serve process: the pool already holds the persistent + // cache's LMDB env open — a fresh `EmbeddingService` + // here is refused by the process-global registry and + // would re-embed everything without cache. + // + // `embed_chunks_yielding` holds the per-model lock for + // one ONNX mini-batch at a time (plus the configured + // pause), so an interactive query embedding is not stuck + // behind this whole file batch. + let embedded = match embed_source { EmbeddingSource::Pool(pool) => { - let service = pool.get(embed_model)?; - // Recover from poisoning: a panicked embed - // service still yields a valid guard (the - // batch's embed_chunks result is what carries - // correctness); a poison here must not - // hard-fail every later batch for the - // process lifetime. - let mut guard = service - .lock() - .unwrap_or_else(std::sync::PoisonError::into_inner); - guard.embed_chunks(all_chunks) + pool.embed_chunks_yielding(embed_model, all_chunks, embed_pause)? } EmbeddingSource::Fresh => { let mut embedding_service = EmbeddingService::with_cache_dir( embed_model, Some(cache_dir_for_batch.as_path()), )?; - embedding_service.embed_chunks(all_chunks) + embedding_service.embed_chunks(all_chunks)? } - } + }; + Ok((embedded, consumed)) }, ) .await .map_err(|e| { - anyhow::anyhow!( - "chunk+embed task panicked (batch {}/{}): {}", - batch_idx + 1, - total_batches, - e - ) + anyhow::anyhow!("chunk+embed task panicked (batch {}): {}", batch_idx + 1, e) })??; + // The closure always consumes at least one file; guard the + // cursor arithmetic against a future regression that would + // otherwise spin forever. + debug_assert!(consumed > 0, "refresh batch made no progress"); + let file_batch = &changed_files[cursor..cursor + consumed]; + cursor += consumed; + batch_idx += 1; + // A cancel arriving after embed completed but before we commit // the batch to the stores must skip the insert + the final // build_index, so a removed repo never receives fresh data. @@ -922,9 +1144,8 @@ impl IndexManager { if !embedded_chunks.is_empty() { info!( - "📦 Batch {}/{}: embedding {} chunks with model {}...", - batch_idx + 1, - total_batches, + "📦 Batch {}: embedding {} chunks with model {}...", + batch_idx, embedded_chunks.len(), embed_model.short_name() ); @@ -990,6 +1211,12 @@ impl IndexManager { file_meta_store.update_file(&file.path, &key, vec![])?; } } + + // Persist per batch: vector and FTS already commit per batch, + // so the meta must follow or a crash/restart mid-pass leaves + // meta empty while chunks exist — the next open then wipes + // the whole store (the B1 guard) and re-embeds everything. + file_meta_store.save(db_path)?; } // Build the HNSW index once, after every batch has been inserted. @@ -1007,7 +1234,7 @@ impl IndexManager { info!( "✅ Indexed {} chunks across {} batch(es)", - total_indexed, total_batches + total_indexed, batch_idx ); } @@ -1063,6 +1290,15 @@ impl IndexManager { /// 2. Reindexes every file from scratch using the existing store handles /// /// No files are deleted, so there is no OS error 32 (file in use). + /// + /// A failure of the transient Windows FTS commit race (an indexer holds + /// a freshly created Tantivy segment file while the commit opens it — + /// os error 5/32/33) redrives the WHOLE pass, backing off 5s then 20s: + /// a full pass is idempotent (clear + rebuild), while a commit retry on + /// the same writer is never safe (a half-joined pipeline must not be + /// recommitted — see `FtsStore::commit_once`). Field incidents died on + /// a single 5s redrive while the AV still held the file; the second, + /// longer backoff covers that window. pub async fn force_reindex_with_stores( codebase_path: &Path, db_path: &Path, @@ -1070,6 +1306,62 @@ impl IndexManager { model_override: Option, cancel_token: &CancellationToken, embedding_pool: Option<&Arc>, + ) -> Result<()> { + const FTS_TRANSIENT_BACKOFFS: [std::time::Duration; 2] = [ + std::time::Duration::from_secs(5), + std::time::Duration::from_secs(20), + ]; + Self::retry_on_transient_fts(&FTS_TRANSIENT_BACKOFFS, || async { + Self::force_reindex_with_stores_once( + codebase_path, + db_path, + stores, + model_override, + cancel_token, + embedding_pool, + ) + .await + }) + .await + } + + /// Redrive `attempt` on the transient Windows FTS commit race, one extra + /// pass per entry in `backoffs`. Any other error (and a transient failure + /// that outlives the last backoff) is returned untouched — bounded, never + /// a loop. + pub(crate) async fn retry_on_transient_fts( + backoffs: &[std::time::Duration], + mut attempt: F, + ) -> Result + where + F: FnMut() -> Fut, + Fut: std::future::Future>, + { + for backoff in backoffs { + match attempt().await { + Ok(v) => return Ok(v), + Err(e) + if crate::fts::FtsStore::is_transient_fts_commit_error(&format!("{e:#}")) => + { + warn!( + "Transient FTS commit failure ({e:#}) — redriving the full pass in {}s", + backoff.as_secs().max(1) + ); + tokio::time::sleep(*backoff).await; + } + Err(e) => return Err(e), + } + } + attempt().await + } + + async fn force_reindex_with_stores_once( + codebase_path: &Path, + db_path: &Path, + stores: &SharedStores, + model_override: Option, + cancel_token: &CancellationToken, + embedding_pool: Option<&Arc>, ) -> Result<()> { use crate::cache::FileMetaStore; use anyhow::Context; @@ -1079,6 +1371,22 @@ impl IndexManager { // Bail before clearing any store data if the repo was already removed. Self::ensure_indexing_active(cancel_token)?; + // Hold the process-wide heavy-job gate across the destructive clear AND + // the full reindex. The nested call goes to the gate-free inner body so + // the permit is not re-acquired (which would deadlock under + // `CODESEARCH_INDEX_JOBS=1`). The wait is cancellation-aware so a repo + // removed while queued aborts before the destructive clear. + let _job_permit = match stores.acquire_job_permit_or_cancel(cancel_token).await { + crate::limits::JobAcquire::Ready(permit) => permit, + crate::limits::JobAcquire::Cancelled => { + return Err(anyhow::anyhow!("indexing cancelled")); + } + }; + // Re-check after the (possibly long) wait: a cancellation that landed + // while queued must not start the clear, and the stores are still + // intact at this point. + Self::ensure_indexing_active(cancel_token)?; + // ── Step 0: Read and preserve metadata BEFORE clearing anything ── // This is defensive: the DB may be incomplete (no metadata.json at all), // or clear() may indirectly remove it. We preserve model info so we can @@ -1187,7 +1495,7 @@ impl IndexManager { info!("✅ Stores cleared, metadata preserved. Starting full reindex..."); // ── Step 5: Reindex — all files treated as "changed" since metadata is empty ── - Self::perform_incremental_refresh_with_stores( + Self::perform_incremental_refresh_inner( codebase_path, db_path, stores, @@ -1228,6 +1536,9 @@ impl IndexManager { /// indicator (`Started`/`Succeeded`/`Failed`). Non-applicable languages /// (no `.sln` / no `tsconfig.json`) or an unavailable helper are skipped /// without touching any status — mirroring the debounce path. + /// + /// Serializes with the other two C# rebuild tasks via the shared `rebuild_guard`. + #[allow(clippy::too_many_arguments)] fn spawn_branch_change_symbol_rebuild( symbol_registry: Arc, repo_path: PathBuf, @@ -1236,8 +1547,12 @@ impl IndexManager { csharp_notifier: Option, indexing_cb: Option, cancel_token: CancellationToken, - ) { + rebuild_guard: Arc>, + ) -> tokio::task::JoinHandle<()> { tokio::task::spawn_blocking(move || { + // Two rebuilds on one LMDB db must not overlap. + let _rebuild_guard = rebuild_guard.lock().unwrap_or_else(|p| p.into_inner()); + // Resolve applicable + available indexers up front so we only toggle // the "Indexing" label when there is real work to do. let csharp = symbol_registry @@ -1306,7 +1621,7 @@ impl IndexManager { if let Some(ref cb) = indexing_cb { cb(false); } - }); + }) } /// Run a `RebuildScope::Full` rebuild for one language's indexer, log the @@ -1338,7 +1653,21 @@ impl IndexManager { summary.duration_ms ); if let Some(n) = notifier { - n(SymbolRebuildSignal::Succeeded); + n(SymbolRebuildSignal::Succeeded { + index_warnings: summary.index_warnings.clone(), + }); + } + } + Err(e) if crate::symbols::csharp::is_restore_exhausted(&e) => { + // Restore never finished within the retry cap: the previous + // index stays live, so this is a warning, never a red error. + warn!( + "⚠️ [{}] {} symbol rebuild abandoned — dotnet restore did not finish, \ + previous index stays live: {:#}", + repo_label, lang_label, e + ); + if let Some(n) = notifier { + n(SymbolRebuildSignal::Abandoned(format!("{e:#}"))); } } Err(e) => { @@ -1444,6 +1773,14 @@ impl IndexManager { let mut cs_files_deleted: HashSet = HashSet::new(); let mut cs_last_event_time: Option = None; let cs_debounce = std::time::Duration::from_millis(SCIP_CSHARP_DEBOUNCE_MS); + // C# restore inputs (Directory.Packages.props, NuGet.config, ...) + // use the same debounce length but their OWN timer: a CPM bump + // invalidates the whole solution's restore state, so the flush is + // a FULL rebuild, not the per-project incremental (issue #225). + let mut restore_inputs_changed = false; + let mut restore_input_last_event_time: Option = None; + // Serializes the detached symbol rebuild tasks (incremental, restore-input full, branch-change full). + let symbol_rebuild_guard = Arc::new(std::sync::Mutex::new(())); // Symbol indexer debounce: .ts/.tsx/.mts/.cts files are buffered separately // and flushed after SCIP_TYPESCRIPT_DEBOUNCE_MS of quiet time. Unlike C#'s @@ -1511,7 +1848,7 @@ impl IndexManager { // Trigger a fire-and-forget FULL symbol rebuild for every // language that applies, so `find_impact` reflects the new // branch instead of silently serving stale references. - Self::spawn_branch_change_symbol_rebuild( + drop(Self::spawn_branch_change_symbol_rebuild( symbol_registry.clone(), path.clone(), db_path.clone(), @@ -1519,7 +1856,8 @@ impl IndexManager { csharp_notifier.clone(), indexing_cb.clone(), cancel_token.clone(), - ); + symbol_rebuild_guard.clone(), + )); } } } @@ -1553,33 +1891,52 @@ impl IndexManager { // If file was marked for removal, cancel that files_to_remove.remove(&p); files_to_index.insert(p.clone()); - // Track .cs file modifications for symbol rebuild debounce - if p.extension().and_then(|e| e.to_str()) == Some("cs") { - // If previously queued as deleted, promote to modified - cs_files_deleted.remove(&p); - cs_files_modified.insert(p); - cs_last_event_time = Some(now); - } else if is_ts_extension(&p) { - ts_files_deleted.remove(&p); - ts_files_modified.insert(p); - ts_last_event_time = Some(now); + // Track modifications for the symbol rebuild debounces + match classify_symbol_rebuild_event(&p) { + SymbolRebuildTrigger::CSharpIncremental => { + // If previously queued as deleted, promote to modified + cs_files_deleted.remove(&p); + cs_files_modified.insert(p); + cs_last_event_time = Some(now); + } + SymbolRebuildTrigger::CSharpRestoreInput => { + restore_inputs_changed = true; + restore_input_last_event_time = Some(now); + } + SymbolRebuildTrigger::TypeScript => { + ts_files_deleted.remove(&p); + ts_files_modified.insert(p); + ts_last_event_time = Some(now); + } + SymbolRebuildTrigger::None => {} } } FileEvent::Deleted(p) => { // If file was marked for indexing, cancel that files_to_index.remove(&p); files_to_remove.insert(p.clone()); - // Track .cs deletions separately — the symbol rebuilder - // needs to explicitly purge LMDB entries for deleted files - // since they won't appear in the new scip-csharp output. - if p.extension().and_then(|e| e.to_str()) == Some("cs") { - cs_files_modified.remove(&p); - cs_files_deleted.insert(p); - cs_last_event_time = Some(now); - } else if is_ts_extension(&p) { - ts_files_modified.remove(&p); - ts_files_deleted.insert(p); - ts_last_event_time = Some(now); + // Track deletions per debounce — .cs deletions must + // be passed explicitly to the incremental rebuild so + // their LMDB entries are purged even though they're + // absent from the new scip-csharp output. + match classify_symbol_rebuild_event(&p) { + SymbolRebuildTrigger::CSharpIncremental => { + cs_files_modified.remove(&p); + cs_files_deleted.insert(p); + cs_last_event_time = Some(now); + } + SymbolRebuildTrigger::CSharpRestoreInput => { + // A deleted restore input changes restore + // semantics just as much as an edited one. + restore_inputs_changed = true; + restore_input_last_event_time = Some(now); + } + SymbolRebuildTrigger::TypeScript => { + ts_files_modified.remove(&p); + ts_files_deleted.insert(p); + ts_last_event_time = Some(now); + } + SymbolRebuildTrigger::None => {} } } FileEvent::Renamed(old_p, new_p) => { @@ -1588,37 +1945,43 @@ impl IndexManager { files_to_remove.insert(old_p.clone()); files_to_remove.remove(&new_p); files_to_index.insert(new_p.clone()); - // Track .cs renames: old path is a deletion, new path is a modification - let old_is_cs = - old_p.extension().and_then(|e| e.to_str()) == Some("cs"); - let new_is_cs = - new_p.extension().and_then(|e| e.to_str()) == Some("cs"); - if old_is_cs || new_is_cs { - if old_is_cs { + // A rename is a deletion of the old path and a + // modification of the new one; each side feeds its + // own debounce independently (a .cs → restore-input + // rename must trip both). + match classify_symbol_rebuild_event(&old_p) { + SymbolRebuildTrigger::CSharpIncremental => { cs_files_modified.remove(&old_p); cs_files_deleted.insert(old_p); + cs_last_event_time = Some(now); } - if new_is_cs { + SymbolRebuildTrigger::CSharpRestoreInput => { + restore_inputs_changed = true; + restore_input_last_event_time = Some(now); + } + SymbolRebuildTrigger::TypeScript => { + ts_files_modified.remove(&old_p); + ts_files_deleted.insert(old_p); + ts_last_event_time = Some(now); + } + SymbolRebuildTrigger::None => {} + } + match classify_symbol_rebuild_event(&new_p) { + SymbolRebuildTrigger::CSharpIncremental => { cs_files_deleted.remove(&new_p); cs_files_modified.insert(new_p); + cs_last_event_time = Some(now); } - cs_last_event_time = Some(now); - } else { - // Track .ts/.tsx/.mts/.cts renames: old path is a - // deletion, new path is a modification. - let old_is_ts = is_ts_extension(&old_p); - let new_is_ts = is_ts_extension(&new_p); - if old_is_ts || new_is_ts { - if old_is_ts { - ts_files_modified.remove(&old_p); - ts_files_deleted.insert(old_p); - } - if new_is_ts { - ts_files_deleted.remove(&new_p); - ts_files_modified.insert(new_p); - } + SymbolRebuildTrigger::CSharpRestoreInput => { + restore_inputs_changed = true; + restore_input_last_event_time = Some(now); + } + SymbolRebuildTrigger::TypeScript => { + ts_files_deleted.remove(&new_p); + ts_files_modified.insert(new_p); ts_last_event_time = Some(now); } + SymbolRebuildTrigger::None => {} } } } @@ -1710,7 +2073,11 @@ impl IndexManager { // separate from the text-index callback used for // branch-change refreshes above. let indexing_cb_scip = indexing_cb.clone(); + let guard = symbol_rebuild_guard.clone(); tokio::task::spawn_blocking(move || { + // Two rebuilds on one LMDB db must not overlap. + let _rebuild_guard = + guard.lock().unwrap_or_else(|p| p.into_inner()); if let Some(indexer) = reg.get(LANG_CSHARP) { if !indexer.applies_to(&rp) { info!( @@ -1786,6 +2153,14 @@ impl IndexManager { // cleaned up from LMDB regardless of origin project. let total_groups = groups.len(); let mut last_error: Option = None; + // Restore-exhausted groups land here instead: + // LMDB untouched, previous index stays live. + let mut last_abandon: Option = None; + // Index-level warnings survived by any + // group's rebuild — deduped across groups + // (MSBuild repeats per project). + let mut index_warnings: Vec = Vec::new(); + let mut seen_warnings = std::collections::HashSet::new(); for (i, (csproj, files)) in groups.into_iter().enumerate() { let csproj_name = csproj .file_name() @@ -1806,6 +2181,11 @@ impl IndexManager { }; match indexer.rebuild(&rp, &dp, scope) { Ok(summary) => { + for w in &summary.index_warnings { + if seen_warnings.insert(w.clone()) { + index_warnings.push(w.clone()); + } + } if summary.symbols_indexed == 0 { warn!( "⚠️ [{}/{}] Symbol rebuild returned 0 symbols for '{}' — \ @@ -1830,23 +2210,46 @@ impl IndexManager { // `{:#}` for the same reason as the // full-rebuild path: the put context // would otherwise hide the MDB_* code. - warn!( - "⚠️ [{}/{}] Symbol rebuild failed ({}): {:#}", - i + 1, - total_groups, - csproj_name, - e - ); - last_error = Some(format!("{e:#}")); + // A restore-exhausted group is an + // abandonment (previous index stays + // live), not a failure. + if crate::symbols::csharp::is_restore_exhausted(&e) + { + warn!( + "⚠️ [{}/{}] Symbol rebuild abandoned ({}): dotnet \ + restore did not finish — previous index stays live: {:#}", + i + 1, + total_groups, + csproj_name, + e + ); + if last_abandon.is_none() { + last_abandon = Some(format!("{e:#}")); + } + } else { + warn!( + "⚠️ [{}/{}] Symbol rebuild failed ({}): {:#}", + i + 1, + total_groups, + csproj_name, + e + ); + last_error = Some(format!("{e:#}")); + } } } } - // Notify serve layer about overall outcome + // Notify serve layer about overall outcome. + // A real failure wins over an abandonment: + // exhausted groups leave the previous index + // live (warning), but a genuine failure must + // still render red. if let Some(ref n) = notifier { - match last_error { - None => n(SymbolRebuildSignal::Succeeded), - Some(msg) => n(SymbolRebuildSignal::Failed(msg)), - } + n(grouped_rebuild_signal( + last_error, + last_abandon, + index_warnings, + )); } // Clear "Indexing" now that all groups are done if let Some(ref cb) = indexing_cb_scip { @@ -1858,6 +2261,78 @@ impl IndexManager { } } + // Flush the restore-input debounce: a changed/deleted + // Directory.Packages.props (or sibling) invalidates restore + // state for EVERY project at once, so the flush is a FULL + // solution rebuild — a per-project incremental would index + // mid-restore against stale assets (issue #225). The helper's + // own gate refuses to index while the triggered restore is + // still running; rebuild()'s retry loop waits it out. + if restore_inputs_changed { + if let Some(restore_last) = restore_input_last_event_time { + let elapsed = now.duration_since(restore_last); + if elapsed >= cs_debounce { + restore_inputs_changed = false; + restore_input_last_event_time = None; + + info!( + "🔬 [{}] C# restore input changed, triggering full symbol rebuild (after {}s debounce)", + repo_label, + cs_debounce.as_secs() + ); + + let reg = symbol_registry.clone(); + let rp = path.clone(); + let dp = db_path.clone(); + // Clone the repo label into the blocking task (the outer + // binding is reused by later loop iterations). + let repo_label = repo_label.clone(); + let notifier = csharp_notifier.clone(); + let indexing_cb_scip = indexing_cb.clone(); + let guard = symbol_rebuild_guard.clone(); + tokio::task::spawn_blocking(move || { + // Two rebuilds on one LMDB db must not overlap. + let _rebuild_guard = + guard.lock().unwrap_or_else(|p| p.into_inner()); + if let Some(indexer) = reg.get(LANG_CSHARP) { + if !indexer.applies_to(&rp) { + info!( + "🔬 [{}] symbol rebuild skipped: not applicable (no .sln)", + repo_label + ); + return; + } + if !indexer.is_available() { + info!( + "🔬 [{}] symbol rebuild skipped: helper not available", + repo_label + ); + return; + } + if let Some(ref cb) = indexing_cb_scip { + cb(true); + } + if let Some(ref n) = notifier { + n(SymbolRebuildSignal::Started); + } + Self::run_full_rebuild_logged( + indexer, + &rp, + &dp, + &repo_label, + "C#", + notifier.as_ref(), + ); + // Clear "Indexing" regardless of outcome + if let Some(ref cb) = indexing_cb_scip { + cb(false); + } + } + }); + } + } + } + // Check if we should flush the .ts/.tsx/.mts/.cts symbol rebuild debounce. // Unlike the C# path there is no per-.csproj grouping: TypeScript MVP // only supports a single root tsconfig.json, so any tracked change @@ -1970,6 +2445,16 @@ impl IndexManager { // Bail before touching any store if the repo was removed. Self::ensure_indexing_active(cancel_token)?; + // One permit for the whole watcher batch: a batch can hold hundreds of + // files, each re-embedded and followed by an HNSW rebuild, and every + // repo's watcher would otherwise run one at the same time. + let _job_permit = match stores.acquire_job_permit_or_cancel(cancel_token).await { + crate::limits::JobAcquire::Ready(permit) => permit, + crate::limits::JobAcquire::Cancelled => { + return Err(anyhow::anyhow!("indexing cancelled")); + } + }; + // Enable quiet mode during FSW batch processing to suppress verbose embedding output set_quiet(true); @@ -2131,6 +2616,14 @@ impl IndexManager { // Abort before the filesystem walk if the repo was already removed. Self::ensure_indexing_active(cancel_token)?; + // One permit for the whole branch-refresh pass (walk, delete, re-index). + let _job_permit = match stores.acquire_job_permit_or_cancel(cancel_token).await { + crate::limits::JobAcquire::Ready(permit) => permit, + crate::limits::JobAcquire::Cancelled => { + return Err(anyhow::anyhow!("indexing cancelled")); + } + }; + let result: Result<()> = async { // Phase 1: Discover current files on disk. // `walk()` is synchronous + I/O-heavy — offload off the async executor. @@ -2469,11 +2962,11 @@ impl IndexManager { // registry and would degrade this path to cache-less re-embedding. let embedded_chunks = match embed_service_choice(embedding_pool) { EmbeddingSource::Pool(pool) => { - let service = pool.get(embed_model)?; - let mut guard = service - .lock() - .unwrap_or_else(std::sync::PoisonError::into_inner); - guard.embed_chunks(chunks)? + // The FSW paths hold a job permit (`process_batch_with_stores` + // / `refresh_index_with_stores`); interleave the model lock per + // mini-batch so a concurrent query embedding is not stuck + // behind this file. + pool.embed_chunks_yielding(embed_model, chunks, std::time::Duration::ZERO)? } EmbeddingSource::Fresh => { let cache_dir = crate::constants::get_global_models_cache_dir()?; @@ -2645,6 +3138,115 @@ mod tests { use crate::cache::FileMetaStore; use tempfile::tempdir; + /// The watcher must classify every restore input by file NAME, + /// case-insensitively (NuGet honours lowercase nuget.config on + /// case-sensitive filesystems), and must not classify lookalikes. + #[test] + fn restore_input_classification_table() { + let cases = [ + ("Directory.Packages.props", true), + ("directory.packages.props", true), + ("Directory.Build.props", true), + ("Directory.Build.targets", true), + ("nuget.config", true), + ("NuGet.CONFIG", true), + ("global.json", true), + // Lookalikes that must NOT trigger a full rebuild. + ("Global.json.bak", false), + ("MyNuGet.config", false), + ("Program.cs", false), + ("Directory.Packages.props.bak", false), + ("packages.props", false), + ]; + for (name, expected) in cases { + assert_eq!( + is_csharp_restore_input(Path::new(name)), + expected, + "file name: {name}" + ); + // Same answer through a directory-bearing path. + let nested = Path::new("src").join(name); + assert_eq!( + is_csharp_restore_input(&nested), + expected, + "nested path: {nested:?}" + ); + } + } + + /// The per-event decision the FSW arms rely on: .cs feeds the + /// per-project incremental, a restore input the FULL-rebuild debounce, + /// .ts/.tsx the TypeScript one — this is the wiring the deliverable + /// behaviour depends on, pinned without driving the async loop. + #[test] + fn symbol_rebuild_event_classification_table() { + use SymbolRebuildTrigger::*; + let cases = [ + ("src/Acme.Core.cs", CSharpIncremental), + ("Acme.cs", CSharpIncremental), + ("Directory.Packages.props", CSharpRestoreInput), + ("nuget.config", CSharpRestoreInput), + ("Directory.Build.targets", CSharpRestoreInput), + ("global.json", CSharpRestoreInput), + ("src/app.ts", TypeScript), + ("src/app.tsx", TypeScript), + ("src/app.mts", TypeScript), + ("README.md", None), + ("Cargo.toml", None), + ("Directory.Packages.props.bak", None), + ]; + for (path, expected) in cases { + assert_eq!( + classify_symbol_rebuild_event(Path::new(path)), + expected, + "path: {path}" + ); + } + } + + /// The grouped incremental rebuild's terminal-signal ordering: a real + /// failure beats an abandonment (exhausted groups leave the previous + /// index live — warning — but a genuine failure must render red), and + /// an abandonment beats success. Pins the decision the watcher path + /// relies on, without driving the async loop — the same + /// extract-and-table-test shape as the serve layer's classifier. + #[test] + fn grouped_rebuild_signal_priority_table() { + use SymbolRebuildSignal::*; + let real = "MDB_BAD_VALSIZE: put failed".to_string(); + let exhausted = "dotnet restore did not finish within 3 attempts".to_string(); + let warnings = vec!["MSBuild advisory".to_string()]; + let cases = [ + ( + "real failure beats abandonment", + Some(real.clone()), + Some(exhausted.clone()), + Failed(real.clone()), + ), + ( + "abandonment beats success", + None, + Some(exhausted.clone()), + Abandoned(exhausted.clone()), + ), + ( + "clean run keeps the surviving warnings", + None, + None, + Succeeded { + index_warnings: warnings.clone(), + }, + ), + ]; + for (label, last_error, last_abandon, expected) in cases { + assert_eq!( + grouped_rebuild_signal(last_error, last_abandon, warnings.clone()), + expected, + "case: {label}" + ); + } + } + /// Dropping the last `Arc` must release every handle inside /// the DB directory — the precondition `index rm`'s delete path depends on. /// @@ -2712,6 +3314,7 @@ mod tests { writer_lock: None, readonly: false, changes_count: std::sync::atomic::AtomicU64::new(0), + job_gate: None, } } @@ -2753,6 +3356,263 @@ mod tests { assert!(db_path.join(WRITER_LOCK_FILE).exists()); } + /// The chunk-cap predicate is the batch-splitting decision; pin its edges + /// here because the loop that uses it runs inside `spawn_blocking` and + /// would otherwise need the ONNX embedding model. + #[test] + fn chunk_cap_predicate_table() { + let cases = [ + // (consumed, accumulated_chunks, cap, expected) + (0, 10_000, 5_000, false), // first file of a batch always proceeds + (1, 4_999, 5_000, false), // below the cap + (1, 5_000, 5_000, true), // exactly at the cap + (1, 5_001, 5_000, true), // one file overshot the cap + (7, 10_000, 0, false), // cap disabled + (1, 0, 0, false), // cap disabled, nothing accumulated + ]; + for (consumed, accumulated, cap, expected) in cases { + assert_eq!( + chunk_cap_reached(consumed, accumulated, cap), + expected, + "chunk_cap_reached(consumed={consumed}, accumulated={accumulated}, cap={cap})" + ); + } + } + + /// Standalone CLI / `codesearch mcp` stores carry no gate and must keep + /// their previous (unbounded) behaviour. + #[tokio::test] + async fn acquire_job_permit_is_none_for_ungated_stores() { + let temp = tempdir().unwrap(); + let stores = create_test_stores(&temp.path().join("db"), 4).await; + assert!(stores.acquire_job_permit().await.is_none()); + } + + /// Cancellation-aware acquisition: ungated stores must distinguish + /// "proceed without a gate" from "cancelled", and a waiter cancelled while + /// the only slot is held must abort promptly instead of parking. + #[tokio::test] + async fn acquire_job_permit_or_cancel_distinguishes_cancel_from_ungated() { + let temp = tempdir().unwrap(); + let stores = create_test_stores(&temp.path().join("db"), 4).await; + + let cancelled = CancellationToken::new(); + cancelled.cancel(); + assert!(matches!( + stores.acquire_job_permit_or_cancel(&cancelled).await, + crate::limits::JobAcquire::Cancelled + )); + assert!(matches!( + stores + .acquire_job_permit_or_cancel(&CancellationToken::new()) + .await, + crate::limits::JobAcquire::Ready(None) + )); + + // Gated: a waiter cancelled while the only slot is held aborts. + let gate = crate::limits::JobGate::with_config(1, 0); + let gated = Arc::new( + create_test_stores(&temp.path().join("db2"), 4) + .await + .with_job_gate(Arc::clone(&gate)), + ); + let held = gate.acquire().await; + let waiter = CancellationToken::new(); + let canceller = waiter.clone(); + tokio::spawn(async move { + tokio::time::sleep(std::time::Duration::from_millis(50)).await; + canceller.cancel(); + }); + assert!(matches!( + gated.acquire_job_permit_or_cancel(&waiter).await, + crate::limits::JobAcquire::Cancelled + )); + drop(held); + } + + /// A gated refresh must (a) wait while the only slot is held and (b) + /// release the slot when it finishes. The repo has NO changed files, so the + /// refresh completes without loading the ONNX model. + #[tokio::test] + async fn gated_refresh_waits_for_a_free_slot_and_releases_it() { + let temp = tempdir().unwrap(); + let codebase_path = temp.path().join("codebase"); + let db_path = temp.path().join("db"); + std::fs::create_dir_all(&codebase_path).unwrap(); + std::fs::create_dir_all(&db_path).unwrap(); + create_metadata_json(&db_path, 4); + + let gate = crate::limits::JobGate::with_config(1, 0); + let held = gate.acquire().await; + let stores = Arc::new( + create_test_stores(&db_path, 4) + .await + .with_job_gate(Arc::clone(&gate)), + ); + + let mut refresh = tokio::spawn({ + let stores = Arc::clone(&stores); + let codebase_path = codebase_path.clone(); + let db_path = db_path.clone(); + async move { + IndexManager::perform_incremental_refresh_with_stores( + &codebase_path, + &db_path, + &stores, + &CancellationToken::new(), + None, + None, + ) + .await + } + }); + + assert!( + tokio::time::timeout(std::time::Duration::from_millis(150), &mut refresh) + .await + .is_err(), + "the refresh must wait while the only job slot is held" + ); + + drop(held); + let result = tokio::time::timeout(std::time::Duration::from_secs(10), refresh) + .await + .expect("refresh must complete once the slot is free") + .expect("refresh task must not panic"); + assert!(result.is_ok(), "refresh failed: {:?}", result.err()); + + // The permit was released: the gate can be acquired again immediately. + let _again = tokio::time::timeout(std::time::Duration::from_secs(1), gate.acquire()) + .await + .expect("the refresh must release its job permit"); + } + + /// The transient-FTS retry redrives the WHOLE pass, one extra pass per + /// backoff entry: a transient-shaped error is retried (the field case — + /// the first pass fails on the AV holding a new segment file, the retry + /// lands), a non-transient error is returned without a second attempt, + /// and a transient failure that outlives the last backoff gives up — + /// bounded, never a loop. + #[tokio::test] + async fn retry_on_transient_fts_redrives_per_backoff_then_gives_up() { + let ms = [ + std::time::Duration::from_millis(1), + std::time::Duration::from_millis(1), + ]; + + // Transient once → retried, succeeds, exactly two attempts. + let mut attempts = 0u32; + let out: Result = IndexManager::retry_on_transient_fts(&ms, || { + let done = attempts >= 1; + attempts += 1; + async move { + if done { + Ok(1) + } else { + Err(anyhow::anyhow!( + "FTS commit failed: Access is denied. (os error 5)" + )) + } + } + }) + .await; + assert_eq!(out.unwrap(), 1); + assert_eq!(attempts, 2); + + // Non-transient → returned immediately, one attempt. + let mut attempts = 0u32; + let out: Result<()> = IndexManager::retry_on_transient_fts(&ms, || { + attempts += 1; + async { Err(anyhow::anyhow!("schema mismatch")) } + }) + .await; + assert!(out.is_err()); + assert_eq!(attempts, 1); + + // Transient three times (initial + two backoffs) → gives up after + // the third attempt; a lock outliving both backoffs stays loud. + let mut attempts = 0u32; + let out: Result<()> = IndexManager::retry_on_transient_fts(&ms, || { + attempts += 1; + async { Err(anyhow::anyhow!("FTS commit failed: os error 32")) } + }) + .await; + assert!(out.is_err()); + assert_eq!(attempts, 3); + + // Transient twice then clean → the second backoff saves the pass. + let mut attempts = 0u32; + let out: Result = IndexManager::retry_on_transient_fts(&ms, || { + let done = attempts >= 2; + attempts += 1; + async move { + if done { + Ok(7) + } else { + Err(anyhow::anyhow!("FTS commit failed: os error 5")) + } + } + }) + .await; + assert_eq!(out.unwrap(), 7); + assert_eq!(attempts, 3); + } + + /// The db directory must carry FILE_ATTRIBUTE_HIDDEN after a read-write + /// create: the Search indexer skips hidden directories, which is the + /// structural fix for the scanner race on fresh Tantivy segment files. + #[cfg(windows)] + #[test] + fn shared_stores_marks_the_db_dir_hidden() { + let dir = tempdir().unwrap(); + let db = dir.path().join(".codesearch.db"); + let _stores = SharedStores::new(&db, 2).unwrap(); + use std::os::windows::fs::MetadataExt; + let attrs = std::fs::metadata(&db).unwrap().file_attributes(); + assert_ne!( + attrs & 0x2, + 0, + "the db dir must carry FILE_ATTRIBUTE_HIDDEN" + ); + } + + /// Regression for the wrapper/inner split: `force_reindex_with_stores` + /// holds the gate permit across the destructive clear and then calls the + /// gate-free inner body. Calling the public wrapper again would re-acquire + /// the only permit and hang forever under `CODESEARCH_INDEX_JOBS=1` (this + /// test times out instead of hanging only because of the explicit + /// `timeout`). + #[tokio::test] + async fn force_reindex_under_gate_does_not_reacquire_the_permit() { + let temp = tempdir().unwrap(); + let codebase_path = temp.path().join("codebase"); + let db_path = temp.path().join("db"); + std::fs::create_dir_all(&codebase_path).unwrap(); + std::fs::create_dir_all(&db_path).unwrap(); + create_metadata_json(&db_path, 4); + + let gate = crate::limits::JobGate::with_config(1, 0); + let stores = create_test_stores(&db_path, 4) + .await + .with_job_gate(Arc::clone(&gate)); + + let result = tokio::time::timeout( + std::time::Duration::from_secs(10), + IndexManager::force_reindex_with_stores( + &codebase_path, + &db_path, + &stores, + None, + &CancellationToken::new(), + None, + ), + ) + .await + .expect("force reindex must not deadlock on its own job permit"); + + assert!(result.is_ok(), "force reindex failed: {:?}", result.err()); + } + #[tokio::test] async fn test_refresh_no_metadata_early_return() { // When metadata.json doesn't exist, refresh should return Ok early @@ -3503,4 +4363,41 @@ mod tests { "the untracked duplicate chunk must be swept" ); } + + /// The branch-change full rebuild must queue behind the shared guard so it + /// cannot overlap the incremental or restore-input rebuilds on one LMDB db. + #[tokio::test] + async fn branch_change_symbol_rebuild_waits_for_shared_guard() { + let temp = tempdir().unwrap(); + let guard = Arc::new(std::sync::Mutex::new(())); + let held = guard.lock().unwrap(); + + let handle = IndexManager::spawn_branch_change_symbol_rebuild( + Arc::new(SymbolIndexerRegistry::new()), + temp.path().to_path_buf(), + temp.path().join("db"), + "test".to_string(), + None, + None, + CancellationToken::new(), + guard.clone(), + ); + + std::thread::sleep(std::time::Duration::from_millis(300)); + assert!( + !handle.is_finished(), + "rebuild must block while the shared guard is held" + ); + + drop(held); + tokio::time::timeout(std::time::Duration::from_secs(10), handle) + .await + .expect("rebuild must finish once the guard is released") + .expect("rebuild task must not panic"); + + assert!( + guard.try_lock().is_ok(), + "guard must be released after the rebuild" + ); + } } diff --git a/src/index/mod.rs b/src/index/mod.rs index 4b0877c7..ec089068 100644 --- a/src/index/mod.rs +++ b/src/index/mod.rs @@ -559,6 +559,19 @@ pub async fn index( to finish warming up." )); } + Err(DelegateError::Failed(reason)) if reason.contains("already in progress") => { + // The serve's 409 proves the work is IN FLIGHT (the first + // POST landed; its 202 just never reached this client). + // Two writers on one index are proven broken in the field + // (the CLI died on the Tantivy lockfile mid-reindex) — + // report and stop; the serve finishes the pass. + return Err(anyhow::anyhow!( + "codesearch serve is running but could not delegate: {reason}\n\ + The serve is already reindexing this alias — let it finish \ + (check `codesearch status`). Indexing locally now would fight \ + the in-flight pass for the LMDB/FTS locks." + )); + } Err(DelegateError::Failed(reason)) => { eprintln!( "{}", @@ -1594,6 +1607,18 @@ pub async fn add_to_index( finish warming up." )); } + Err(DelegateError::Failed(reason)) if reason.contains("already in progress") => { + // The serve's 409 proves the add/reindex is IN FLIGHT (the first + // POST landed; its 202 just never reached this client). Two + // writers on one index are proven broken in the field — report + // and stop; the serve finishes the work. + return Err(anyhow::anyhow!( + "serve is running but could not delegate the add: {reason}\n\ + The serve is already indexing this alias — let it finish (check \ + `codesearch status`). Adding locally now would fight the in-flight \ + pass for the LMDB/FTS locks." + )); + } Err(DelegateError::Failed(reason)) => { eprintln!( "{}", diff --git a/src/lib.rs b/src/lib.rs index f50f2ae3..7539e797 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -10,6 +10,7 @@ pub mod federation; pub mod file; pub mod fts; pub mod index; +pub mod limits; pub mod lmdb_registry; pub mod logger; pub mod mcp; diff --git a/src/limits.rs b/src/limits.rs new file mode 100644 index 00000000..ff4f95c0 --- /dev/null +++ b/src/limits.rs @@ -0,0 +1,269 @@ +//! Process-wide limits for heavy indexing work. +//! +//! `codesearch serve` hosts many repos, and each repo's refresh/reindex pass +//! is CPU- and memory-heavy: file reads, tree-sitter chunking, ONNX +//! embedding, HNSW graph construction. Without a process-wide budget, N repos +//! with work start N concurrent passes — every core is saturated, and N +//! file/chunk windows are held in memory at once even though ONNX inference +//! itself already serialises on the per-model mutex. +//! +//! This module provides one shared budget ([`JobGate`]) plus the per-inference +//! and per-batch knobs that bound what a single job costs: +//! +//! | Variable | Default | Meaning | +//! |---|---|---| +//! | `CODESEARCH_INDEX_JOBS` | `1` | Max concurrent heavy repo jobs per process | +//! | `CODESEARCH_EMBED_THREADS` | unset (ONNX default = all cores) | ONNX intra-op threads per session | +//! | `CODESEARCH_EMBED_PAUSE_MS` | `0` | Pause between background embedding mini-batches | +//! | `CODESEARCH_MIN_FREE_MB` | `0` (off) | Free-memory floor before a job may start | +//! | `CODESEARCH_MAX_CHUNKS_PER_BATCH` | `0` (off) | Hard cap on chunks held per refresh batch | +//! +//! All values are read from the environment so a systemd unit or shell can set +//! them without a config file. See the README section "Indexing limits" for +//! recommended values on shared machines. +//! +//! The gate is attached to [`crate::index::SharedStores`] at open time in +//! serve mode; standalone processes (CLI index, `codesearch mcp`) leave it +//! `None` and behave exactly as before. + +use std::sync::Arc; +use std::time::{Duration, Instant}; +use tokio::sync::{OwnedSemaphorePermit, Semaphore}; +use tokio_util::sync::CancellationToken; + +/// Max concurrent heavy repo jobs in this process (>= 1). +pub const INDEX_JOBS_ENV: &str = "CODESEARCH_INDEX_JOBS"; +/// ONNX intra-op thread count per embedding session (>= 1; unset = all cores). +pub const EMBED_THREADS_ENV: &str = "CODESEARCH_EMBED_THREADS"; +/// Milliseconds to pause between background embedding mini-batches. +pub const EMBED_PAUSE_MS_ENV: &str = "CODESEARCH_EMBED_PAUSE_MS"; +/// Free-memory floor (MB) before a heavy job may start (0 = disabled). +pub const MIN_FREE_MB_ENV: &str = "CODESEARCH_MIN_FREE_MB"; +/// Hard cap on chunks held in memory per refresh batch (0 = disabled). +pub const MAX_CHUNKS_PER_BATCH_ENV: &str = "CODESEARCH_MAX_CHUNKS_PER_BATCH"; + +/// Default for [`index_jobs`]: strictly one heavy repo job at a time. +/// +/// Embedding is already serialised by the per-model mutex, so running another +/// repo's refresh concurrently buys little throughput while multiplying peak +/// memory (each queued job holds its own chunk window) and store-lock +/// contention. Raise it deliberately, with `CODESEARCH_EMBED_THREADS` set, on +/// machines with cores and memory to spare. +pub const DEFAULT_INDEX_JOBS: usize = 1; + +const DEFAULT_EMBED_PAUSE_MS: u64 = 0; +const DEFAULT_MIN_FREE_MB: u64 = 0; +const DEFAULT_MAX_CHUNKS_PER_BATCH: usize = 0; + +/// How often the memory admission check re-reads available memory. +const MEMORY_POLL_INTERVAL: Duration = Duration::from_millis(500); +/// How long a job waits for memory before proceeding with a warning. A +/// permanent wait would be a deadlock (the running job's ONNX arena does not +/// return memory to the OS), so this is deliberately bounded. +const MEMORY_WAIT_MAX: Duration = Duration::from_secs(30); +/// Log when a job waited at least this long for a free slot. +const SLOW_ACQUIRE_LOG_AFTER: Duration = Duration::from_secs(2); + +fn env_parsed(name: &str) -> Option { + std::env::var(name) + .ok() + .and_then(|s| s.trim().parse::().ok()) +} + +/// Max concurrent heavy repo jobs. Values below 1 fall back to the default. +pub fn index_jobs() -> usize { + env_parsed::(INDEX_JOBS_ENV) + .filter(|&n| n >= 1) + .unwrap_or(DEFAULT_INDEX_JOBS) +} + +/// ONNX intra-op threads per embedding session. +/// +/// `None` (unset, or a value below 1) leaves fastembed/ONNX Runtime at its +/// default, which uses every available core. Set a value to cap one inference +/// on a shared machine. +pub fn embed_threads() -> Option { + env_parsed::(EMBED_THREADS_ENV).filter(|&n| n >= 1) +} + +/// Duty-cycle pause between background embedding mini-batches. +pub fn embed_pause() -> Duration { + Duration::from_millis(env_parsed::(EMBED_PAUSE_MS_ENV).unwrap_or(DEFAULT_EMBED_PAUSE_MS)) +} + +/// Free-memory floor in MB for starting a heavy job (0 = disabled). +pub fn min_free_mb() -> u64 { + env_parsed::(MIN_FREE_MB_ENV).unwrap_or(DEFAULT_MIN_FREE_MB) +} + +/// Hard cap on chunks held in memory per refresh batch (0 = disabled). +pub fn max_chunks_per_batch() -> usize { + env_parsed::(MAX_CHUNKS_PER_BATCH_ENV).unwrap_or(DEFAULT_MAX_CHUNKS_PER_BATCH) +} + +/// Available (reclaimable) system memory in MB, read fresh on each call. +pub fn available_memory_mb() -> u64 { + let mut sys = sysinfo::System::new(); + sys.refresh_memory(); + sys.available_memory() / (1024 * 1024) +} + +/// Bounds how many heavy repo jobs run concurrently in one process. +/// +/// A "heavy job" is a whole refresh / reindex / vector-index build pass, not a +/// single inference or a query. Query embeddings never take this gate, so +/// interactive search stays responsive while a background job runs. +#[derive(Debug)] +pub struct JobGate { + permits: Arc, + index_jobs: usize, + min_free_mb: u64, + memory_wait: Duration, +} + +impl JobGate { + /// Build a gate from the environment (the normal serve path). + pub fn from_env() -> Arc { + Self::with_config(index_jobs(), min_free_mb()) + } + + /// Build a gate with an explicit job count and memory floor. + pub fn with_config(index_jobs: usize, min_free_mb: u64) -> Arc { + Self::with_config_and_wait(index_jobs, min_free_mb, MEMORY_WAIT_MAX) + } + + /// Build a gate with a custom memory wait ceiling. Test seam: production + /// callers use [`Self::from_env`]. + pub fn with_config_and_wait( + index_jobs: usize, + min_free_mb: u64, + memory_wait: Duration, + ) -> Arc { + let index_jobs = index_jobs.max(1); + Arc::new(Self { + permits: Arc::new(Semaphore::new(index_jobs)), + index_jobs, + min_free_mb, + memory_wait, + }) + } + + /// Number of concurrent job slots this gate allows. + pub fn index_jobs(&self) -> usize { + self.index_jobs + } + + /// Acquire one job slot, then (when enabled) wait, bounded, for the free + /// memory floor. The caller holds the returned permit for the whole job. + /// + /// Prefer [`Self::acquire_or_cancel`] for jobs that carry a cancellation + /// token; this variant waits unbounded because there is nothing to cancel + /// it with. + pub async fn acquire(&self) -> JobPermit { + self.acquire_or_cancel(&CancellationToken::new()) + .await + .expect("a never-cancelled token can never abort the acquire") + } + + /// Acquire one job slot, aborting promptly when `cancel` fires while + /// queued. + /// + /// Returns `None` without consuming a slot when the token was already + /// cancelled or fires before a slot is granted. A job cancelled while + /// queued must abort rather than park: parking kept a removed or cancelled + /// job's `Arc` (and its LMDB env) alive for the permit + /// holder's whole run, leaving "locked by another process" / double-open + /// failures behind with nothing left to release them. + pub async fn acquire_or_cancel(&self, cancel: &CancellationToken) -> Option { + let wait_start = Instant::now(); + if cancel.is_cancelled() { + return None; + } + let permit = tokio::select! { + biased; + _ = cancel.cancelled() => return None, + permit = self.permits.clone().acquire_owned() => { + permit.expect("job gate semaphore is never closed") + } + }; + let waited = wait_start.elapsed(); + if waited >= SLOW_ACQUIRE_LOG_AFTER { + tracing::info!( + "⏳ Indexing job waited {:.1}s for a free slot ({} slot(s) total; CODESEARCH_INDEX_JOBS)", + waited.as_secs_f64(), + self.index_jobs + ); + } + if self.min_free_mb > 0 && !self.wait_for_memory(cancel).await { + // A cancellation that lands during the memory wait aborts at once, + // releasing the slot rather than starting cancelled work. + return None; + } + Some(JobPermit { _permit: permit }) + } + + /// Wait, bounded, for the free-memory floor, aborting as soon as `cancel` + /// fires. Returns `false` when cancelled — the caller must release its slot + /// — and `true` when the floor is met, the wait times out, or no floor is + /// set (so a never-cancelled token can never abort the acquire). + async fn wait_for_memory(&self, cancel: &CancellationToken) -> bool { + let free = available_memory_mb(); + if free >= self.min_free_mb { + return true; + } + tracing::info!( + "⏳ Free memory is {} MB, below the {} MB floor (CODESEARCH_MIN_FREE_MB); \ + waiting up to {:.0}s before starting the job", + free, + self.min_free_mb, + self.memory_wait.as_secs_f64() + ); + let deadline = Instant::now() + self.memory_wait; + loop { + tokio::select! { + biased; + _ = cancel.cancelled() => return false, + _ = tokio::time::sleep(MEMORY_POLL_INTERVAL) => {} + } + let free = available_memory_mb(); + if free >= self.min_free_mb { + return true; + } + if Instant::now() >= deadline { + tracing::warn!( + "⚠️ Free memory still below CODESEARCH_MIN_FREE_MB \ + ({} MB available, {} MB required); starting the job anyway", + free, + self.min_free_mb + ); + return true; + } + } + } +} + +/// Held for the duration of one heavy job; dropping it releases the slot. +#[derive(Debug)] +pub struct JobPermit { + _permit: OwnedSemaphorePermit, +} + +/// Cancellation-aware acquisition outcome for a heavy job. +/// +/// `#[must_use]`: dropping a [`Self::Ready`] value releases the job slot +/// immediately (the job would run ungated), and ignoring [`Self::Cancelled`] +/// means starting work that was already cancelled. Always match on it. +#[derive(Debug)] +#[must_use] +pub enum JobAcquire { + /// The job may proceed. The permit is `None` when no gate is attached + /// (standalone processes keep their previous unbounded behaviour). + Ready(Option), + /// The cancellation token fired before a slot was granted; no slot was + /// consumed and the job must abort promptly, dropping its stores. + Cancelled, +} + +#[cfg(test)] +#[path = "limits_tests.rs"] +mod tests; diff --git a/src/limits_tests.rs b/src/limits_tests.rs new file mode 100644 index 00000000..a5f9459f --- /dev/null +++ b/src/limits_tests.rs @@ -0,0 +1,207 @@ +use super::*; +use crate::testing::EnvRestore; +use serial_test::serial; + +/// Remove every limit env var so an inherited shell value cannot change the +/// default assertions. The process environment is shared, so every test that +/// touches it is `#[serial]` and guarded by `EnvRestore`. +fn clear_env() -> EnvRestore { + EnvRestore::remove(&[ + INDEX_JOBS_ENV, + EMBED_THREADS_ENV, + EMBED_PAUSE_MS_ENV, + MIN_FREE_MB_ENV, + MAX_CHUNKS_PER_BATCH_ENV, + ]) +} + +#[test] +#[serial] +fn defaults_are_conservative() { + let _env = clear_env(); + assert_eq!(index_jobs(), DEFAULT_INDEX_JOBS); + assert_eq!( + embed_threads(), + None, + "unset must leave ONNX at its default (all cores)" + ); + assert_eq!(embed_pause(), Duration::ZERO); + assert_eq!(min_free_mb(), 0, "memory floor is opt-in"); + assert_eq!(max_chunks_per_batch(), 0, "chunk cap is opt-in"); +} + +#[test] +#[serial] +fn env_overrides_parse() { + let _env = clear_env(); + let _set = EnvRestore::set(&[ + (INDEX_JOBS_ENV, "3"), + (EMBED_THREADS_ENV, "4"), + (EMBED_PAUSE_MS_ENV, "25"), + (MIN_FREE_MB_ENV, "4096"), + (MAX_CHUNKS_PER_BATCH_ENV, "5000"), + ]); + assert_eq!(index_jobs(), 3); + assert_eq!(embed_threads(), Some(4)); + assert_eq!(embed_pause(), Duration::from_millis(25)); + assert_eq!(min_free_mb(), 4096); + assert_eq!(max_chunks_per_batch(), 5000); +} + +#[test] +#[serial] +fn invalid_values_fall_back() { + let _env = clear_env(); + let _set = EnvRestore::set(&[ + (INDEX_JOBS_ENV, "0"), + (EMBED_THREADS_ENV, "0"), + (EMBED_PAUSE_MS_ENV, "soon"), + (MIN_FREE_MB_ENV, "lots"), + (MAX_CHUNKS_PER_BATCH_ENV, "-1"), + ]); + assert_eq!( + index_jobs(), + DEFAULT_INDEX_JOBS, + "0 job slots is meaningless" + ); + assert_eq!(embed_threads(), None, "0 threads means 'ONNX default'"); + assert_eq!(embed_pause(), Duration::ZERO); + assert_eq!(min_free_mb(), 0); + assert_eq!(max_chunks_per_batch(), 0); +} + +#[tokio::test] +async fn gate_serialises_jobs_when_configured_to_one() { + let gate = JobGate::with_config(1, 0); + let first = gate.acquire().await; + assert!( + tokio::time::timeout(Duration::from_millis(50), gate.acquire()) + .await + .is_err(), + "a second job must wait while the only slot is held" + ); + drop(first); + let second = tokio::time::timeout(Duration::from_secs(5), gate.acquire()) + .await + .expect("dropping the permit must release the slot"); + drop(second); +} + +#[tokio::test] +async fn gate_allows_the_configured_number_of_parallel_jobs() { + let gate = JobGate::with_config(2, 0); + let first = gate.acquire().await; + let second = gate.acquire().await; + assert!( + tokio::time::timeout(Duration::from_millis(50), gate.acquire()) + .await + .is_err(), + "a third job must wait once both slots are held" + ); + drop(first); + drop(second); +} + +#[tokio::test] +async fn memory_floor_zero_never_waits() { + let gate = JobGate::with_config_and_wait(1, 0, Duration::from_secs(3600)); + let permit = tokio::time::timeout(Duration::from_millis(200), gate.acquire()) + .await + .expect("no memory wait when the floor is disabled"); + drop(permit); +} + +#[tokio::test] +async fn memory_wait_is_bounded() { + // A floor no machine can meet: acquire must return after the (shortened) + // memory wait instead of blocking forever. + let gate = JobGate::with_config_and_wait(1, u64::MAX, Duration::from_millis(50)); + let start = Instant::now(); + let permit = tokio::time::timeout(Duration::from_secs(5), gate.acquire()) + .await + .expect("the memory wait must be bounded"); + assert!(start.elapsed() >= Duration::from_millis(50)); + drop(permit); +} + +#[tokio::test] +async fn cancelled_gate_waiter_aborts_without_consuming_a_slot() { + // Regression: a reindex queued behind a long-running job parked on the + // gate holding its store handles. A cancellation while queued must abort + // the wait promptly and leave the slot untouched. + let gate = JobGate::with_config(1, 0); + let held = gate.acquire().await; + let token = CancellationToken::new(); + let canceller = token.clone(); + tokio::spawn(async move { + tokio::time::sleep(Duration::from_millis(50)).await; + canceller.cancel(); + }); + + let start = Instant::now(); + let outcome = gate.acquire_or_cancel(&token).await; + assert!( + outcome.is_none(), + "a cancelled waiter must not receive a permit" + ); + assert!( + start.elapsed() < Duration::from_secs(2), + "cancellation must abort the wait promptly" + ); + + drop(held); + // The slot is still free: the cancelled wait never consumed it. + assert!(gate + .acquire_or_cancel(&CancellationToken::new()) + .await + .is_some()); +} + +#[tokio::test] +async fn pre_cancelled_token_never_takes_a_slot() { + let gate = JobGate::with_config(1, 0); + let token = CancellationToken::new(); + token.cancel(); + assert!(gate.acquire_or_cancel(&token).await.is_none()); + assert!(gate + .acquire_or_cancel(&CancellationToken::new()) + .await + .is_some()); +} + +#[tokio::test] +async fn uncancelled_token_proceeds_through_the_gate() { + let gate = JobGate::with_config(2, 0); + let token = CancellationToken::new(); + assert!(gate.acquire_or_cancel(&token).await.is_some()); + assert!(gate.acquire_or_cancel(&token).await.is_some()); +} + +#[tokio::test] +async fn cancelled_token_aborts_the_memory_wait() { + // Regression: with the memory floor enabled and unmet, a cancellation that + // lands AFTER the semaphore is acquired must abort the memory wait at once, + // not after the whole bounded wait. Otherwise a removed/cancelled job keeps + // its slot and store handles for up to the full wait — the locked/double-open + // window `acquire_or_cancel` exists to prevent. + let gate = JobGate::with_config_and_wait(1, u64::MAX, Duration::from_secs(3600)); + let token = CancellationToken::new(); + let canceller = token.clone(); + tokio::spawn(async move { + tokio::time::sleep(Duration::from_millis(50)).await; + canceller.cancel(); + }); + + let start = Instant::now(); + let outcome = tokio::time::timeout(Duration::from_secs(5), gate.acquire_or_cancel(&token)) + .await + .expect("cancellation must wake the memory wait instead of hanging it"); + assert!( + outcome.is_none(), + "a waiter cancelled during the memory wait must not receive a permit" + ); + assert!( + start.elapsed() < Duration::from_secs(2), + "the memory wait must abort promptly on cancellation, not run its full bound" + ); +} diff --git a/src/main.rs b/src/main.rs index a08f1cb1..db0cfc86 100644 --- a/src/main.rs +++ b/src/main.rs @@ -9,6 +9,7 @@ mod federation; mod file; mod fts; mod index; +mod limits; mod lmdb_registry; mod logger; mod mcp; @@ -28,8 +29,19 @@ use tokio_util::sync::CancellationToken; use tracing::info; use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt}; -#[tokio::main] -async fn main() -> Result<()> { +fn main() -> Result<()> { + let runtime = tokio::runtime::Runtime::new()?; + let result = runtime.block_on(run()); + // Blocking tasks in a restore wait poll this flag (csharp.rs); setting it + // before teardown lets them return instead of being joined for minutes. + constants::SHUTDOWN_REQUESTED.store(true, Ordering::SeqCst); + runtime.shutdown_timeout(std::time::Duration::from_secs( + constants::RUNTIME_SHUTDOWN_GRACE_SECS, + )); + result +} + +async fn run() -> Result<()> { // Parse CLI to get loglevel (need this before tracing init) let args: Vec = std::env::args().collect(); let is_quiet = args.iter().any(|a| a == "-q" || a == "--quiet"); diff --git a/src/mcp/find_impact.rs b/src/mcp/find_impact.rs index 035a1957..811eb888 100644 --- a/src/mcp/find_impact.rs +++ b/src/mcp/find_impact.rs @@ -1,3 +1,4 @@ +use super::helpers::strip_alias_prefix; use super::types::FindImpactRequest; use super::CodesearchService; use crate::symbols::SymbolReference; @@ -93,6 +94,38 @@ fn dedupe_references( out } +/// What find_impact actually did (or could not do) about a missing symbol +/// index — drives the wording of [`missing_index_warning`] so the answer +/// never claims a rebuild that is not running. +pub(crate) enum SymbolIndexHeal { + /// Serve mode with a routed alias: the self-heal task was spawned. + BackgroundStarted, + /// No serve / no routed alias: nothing runs automatically; the caller + /// must build the index explicitly. + Manual, + /// The indexer does not apply to this repository (e.g. no top-level + /// tsconfig.json for TypeScript) — no rebuild can ever start here. + NotApplicable(&'static str), +} + +/// Caller-facing warning for a find_impact answer against a project whose +/// symbol index was never built. The empty reference list such an answer +/// carries means UNKNOWN — stamping this on the payload is what keeps it from +/// passing for "no callers" while the status says what will actually happen. +pub(crate) fn missing_index_warning(lang: &str, heal: SymbolIndexHeal) -> String { + match heal { + SymbolIndexHeal::BackgroundStarted => format!( + "No {lang} symbol index exists for this project — an empty reference list means UNKNOWN, not 'no references'. A background rebuild was started; retry this call once it completes." + ), + SymbolIndexHeal::Manual => format!( + "No {lang} symbol index exists for this project — an empty reference list means UNKNOWN, not 'no references'. Background rebuilds only run in serve mode; build it with `codesearch index symbol ` and retry." + ), + SymbolIndexHeal::NotApplicable(reason) => format!( + "No {lang} symbol index exists for this project and none can be built automatically ({reason}) — an empty reference list means UNKNOWN, not 'no references'." + ), + } +} + #[tool_router(router = find_impact_router, vis = "pub(crate)")] impl CodesearchService { /// Symbol impact analysis — returns transitive call-sites of a symbol with file/line precision. @@ -112,7 +145,7 @@ impl CodesearchService { /// with `symbol_key` set to exactly one candidate. Every resolved answer names the /// selected canonical key in `resolved_symbol`. #[tool( - description = "Symbol impact analysis — find all references to a symbol with IDE-class precision (SCIP).\n\nThe right tool for \"who calls X?\" / \"what breaks if I rename X?\". Returns transitive call-sites with file/line precision, enabling agents to plan refactors without missing a caller. More accurate than text-based `find kind=\"usages\"` because it understands language semantics.\n\nInput variants (mutually exclusive):\n- By name: `{ \"symbol_name\": \"FieldDefinition.Validate\", \"project\": \"myrepo\" }`\n- By position: `{ \"file\": \"src/Validation/FieldDefinition.cs\", \"line\": 42, \"project\": \"myrepo\" }`\n- By exact canonical key: `{ \"symbol_key\": \"csharp . . . FieldDefinition#Validate().\", \"project\": \"myrepo\" }`\n\nAMBIGUITY: if several stored symbols match (overloads, same-line definitions), the answer is `{\"ambiguous\": true, \"query\": ..., \"candidates\": [...]}` — pick one candidate and re-call with `symbol_key` set to it verbatim. A resolved answer names the selected canonical key in `resolved_symbol`; never assume which overload answered.\n\nWARNINGS: a resolved answer may carry a `\"warnings\": [\"...\"]` array — non-empty means the reference list may be INCOMPLETE because a helper failure was survived rather than fatal (a project that failed to compile, an exception during reference resolution, a non-zero scip-typescript exit). Each entry names what failed. Treat warnings as a prompt to reindex the project (or cross-check with `find` `kind=\"usages\"`) before concluding \"no callers\" — absent or empty means the answer is as complete as the index knows.\n\nLANGUAGE: if `language` is omitted, position lookups auto-detect it from the file extension; with several SCIP helpers installed the answer asks you to name one — pass `language` to avoid the round-trip.\n\nPrecision backends (SCIP) ship per language; C# (bundled `scip-csharp` helper, `-with-csharp` releases) and TypeScript (via `npx` or `CODESEARCH_SCIP_TYPESCRIPT`) are available today. For Rust/Python/Go/etc., use `find` with `kind=\"usages\"` as a text-based fallback until SCIP backends for those languages ship.\n\nOn a busy answer (`\"busy\": true`): sleep `retry_after_seconds` and retry the SAME call. Busy is progress, not failure — never fall back to text search on busy.\n\nIMPORTANT (multi-repo): always specify `project` (single repo). Omitting `project` in multi-repo mode returns a `scope_required` error." + description = "Symbol impact analysis — find all references to a symbol with IDE-class precision (SCIP).\n\nThe right tool for \"who calls X?\" / \"what breaks if I rename X?\". Returns transitive call-sites with file/line precision, enabling agents to plan refactors without missing a caller. More accurate than text-based `find kind=\"usages\"` because it understands language semantics.\n\nInput variants (mutually exclusive):\n- By name: `{ \"symbol_name\": \"FieldDefinition.Validate\", \"project\": \"myrepo\" }`\n- By position: `{ \"file\": \"src/Validation/FieldDefinition.cs\", \"line\": 42, \"project\": \"myrepo\" }`\n- By exact canonical key: `{ \"symbol_key\": \"csharp . . . FieldDefinition#Validate().\", \"project\": \"myrepo\" }`\n\nAMBIGUITY: if several stored symbols match (overloads, same-line definitions), the answer is `{\"ambiguous\": true, \"query\": ..., \"candidates\": [...]}` — pick one candidate and re-call with `symbol_key` set to it verbatim. A resolved answer names the selected canonical key in `resolved_symbol`; never assume which overload answered.\n\nWARNINGS: a resolved answer may carry a `\"warnings\": [\"...\"]` array — non-empty means the reference list may be INCOMPLETE because a helper failure was survived rather than fatal (a project that failed to compile, an exception during reference resolution, a non-zero scip-typescript exit). Each entry names what failed. Treat warnings as a prompt to reindex the project (or cross-check with `find` `kind=\"usages\"`) before concluding \"no callers\" — absent or empty means the answer is as complete as the index knows.\n\nSYMBOL INDEX: resolved and empty answers carry `\"symbol_index\": [{\"language\", \"state\", \"age_seconds\", ...}]` — the state of the SCIP index that produced the answer (`ready` | `degraded` | `stale` | `restore-pending` | `absent`). Check it before trusting `references: []`: `absent`/`stale`/`restore-pending` means the empty answer reflects an unusable or outdated index, not verified absence of callers — trigger/await a reindex and re-call instead of concluding.\n\nLANGUAGE: if `language` is omitted, position lookups auto-detect it from the file extension; with several SCIP helpers installed the answer asks you to name one — pass `language` to avoid the round-trip.\n\nPrecision backends (SCIP) ship per language; C# (bundled `scip-csharp` helper, `-with-csharp` releases) and TypeScript (via `npx` or `CODESEARCH_SCIP_TYPESCRIPT`) are available today. For Rust/Python/Go/etc., use `find` with `kind=\"usages\"` as a text-based fallback until SCIP backends for those languages ship.\n\nOn a busy answer (`\"busy\": true`): sleep `retry_after_seconds` and retry the SAME call. Busy is progress, not failure — never fall back to text search on busy.\n\nIMPORTANT (multi-repo): always specify `project` (single repo). Omitting `project` in multi-repo mode returns a `scope_required` error." )] async fn find_impact( &self, @@ -249,6 +282,50 @@ impl CodesearchService { )])); } + // Self-heal + honesty: a project whose symbol index was never built + // answers EVERY query with NotFound/empty references — visually + // identical to "no callers", the exact trap that reads as "safe to + // remove" when it is not. Start a background rebuild (serve mode + // only) whenever the definitions index is absent; the *warning* + // below rides only on answers that actually come back empty + // (NotFound / resolution failure) — a successful resolution proves + // usable data exists and keeps its payload to the persisted + // warnings channel. Drift (index_head_sha vs current) is + // deliberately NOT healed — reindexing on every branch switch would + // thrash (see `SymbolIndexer::index_head_sha`). + // + // The warning wording follows the real status: a repo the indexer + // does not apply to (no top-level tsconfig.json / no .sln) can never + // get a rebuilt index, so saying "a rebuild was started" there was a + // promise nothing would fulfil. + let index_missing = !indexer.has_index(&db_path); + let mut heal_spawned = false; + let heal_warning: Vec = if index_missing { + let heal = if !indexer.applies_to(&project_root) { + SymbolIndexHeal::NotApplicable(indexer.applicability_hint()) + } else if self.serve_state.is_some() && ctx.project_alias.is_some() { + heal_spawned = true; + SymbolIndexHeal::BackgroundStarted + } else { + SymbolIndexHeal::Manual + }; + vec![missing_index_warning(indexer.language(), heal)] + } else { + Vec::new() + }; + if heal_spawned { + if let (Some(ref serve_state), Some(ref alias)) = + (&self.serve_state, &ctx.project_alias) + { + let st = std::sync::Arc::clone(serve_state); + let alias_heal = alias.clone(); + let lang_heal = indexer.language().to_string(); + tokio::spawn(async move { + crate::serve::heal_missing_symbol_index(&st, &alias_heal, &lang_heal).await; + }); + } + } + // Perform the lookup under an internal wall-clock budget. // // `find_references_for_key` may invoke `scip-csharp find-refs` on a cache miss @@ -273,9 +350,16 @@ impl CodesearchService { ) } else { crate::symbols::ImpactQuery::Position { + // `find`/`search` report alias-prefixed paths in serve + // mode ("ALIAS/src/foo.cs"); the position index keys are + // repo-relative. Strip the prefix before normalizing, or + // every position query copied from a find result misses. file: self.normalize_symbol_query_path( &project_root, - Path::new(request.file.as_ref().expect("has_position checked")), + Path::new(&strip_alias_prefix( + request.file.as_ref().expect("has_position checked"), + ctx.project_alias.as_ref(), + )), ), line: request.line.expect("has_position checked"), } @@ -313,6 +397,31 @@ impl CodesearchService { .await .unwrap_or(None); + // Per-language symbol-index status, computed once and attached to + // every answer this handler builds: a consumer reading + // `references: []` must be able to check the state of the index + // that produced it (absent/stale/restore-pending) without a second + // round-trip to repo info. Meta reads are blocking: off the async + // runtime like every other read here; a failed task degrades to an + // omitted field, never a failed answer. Non-applicable languages + // are noise in an answer envelope. + let registry_for_status = self.symbol_registry.clone(); + let root_for_status = project_root.clone(); + let db_for_status = db_path.clone(); + let symbol_index_status: Vec = + match tokio::task::spawn_blocking(move || { + crate::symbols::symbol_index_status( + ®istry_for_status, + &root_for_status, + &db_for_status, + ) + }) + .await + { + Ok(statuses) => statuses.into_iter().filter(|s| !s.not_applicable).collect(), + Err(_) => Vec::new(), + }; + // Shared result construction: the warm-retry path (below) must be // byte-identical to a budget-fast completion, so both build the // response through this one closure. @@ -333,6 +442,7 @@ impl CodesearchService { .unwrap_or_else(|| "local".to_string()), index_head_sha: indexer.index_head_sha(&db_path), current_head_sha: current_head_sha.clone(), + symbol_index: symbol_index_status.clone(), } }; @@ -341,6 +451,10 @@ impl CodesearchService { // helper invocation — as a typed candidates answer; the server never // silently picks among the query's matches (the old behaviour took // the shortest fuzzy candidate and answered about the wrong symbol). + // The same read pass collects the index-level rebuild warnings: a + // partially loaded solution produces an index whose reference lists + // are incomplete EVEN WHEN the lookup succeeds, and that honesty + // rides on every answer from this index. let registry_for_resolve = self.symbol_registry.clone(); let language_for_resolve = language_for_lookup.clone(); let db_path_for_resolve = db_path.clone(); @@ -354,7 +468,16 @@ impl CodesearchService { language_for_resolve ) })?; - indexer.resolve_query(&db_path_for_resolve, &query_for_resolve) + let resolution = indexer.resolve_query(&db_path_for_resolve, &query_for_resolve)?; + let mut index_warnings = indexer.index_warnings(&db_path_for_resolve); + // A rebuild waiting out a restore (issue #225) refreshes nothing: + // every answer from this index comes from the previous one and + // must say so, on every path that carries warnings. + if indexer.restore_pending(&db_path_for_resolve) { + index_warnings + .push(crate::symbols::csharp::RESTORE_PENDING_INDEX_WARNING.to_string()); + } + Ok((resolution, index_warnings)) }) .await { @@ -364,13 +487,33 @@ impl CodesearchService { // (classified stale/failed by the index age) instead of `?`. Err(e) => Err(anyhow::anyhow!("symbol resolve task failed: {e:#}")), }; + // Both are read from the SAME env/txn pass above; on a JoinError the + // warnings are unknown and the failure path below speaks for itself. + let (resolution, index_warnings) = match resolution { + Ok((resolution, index_warnings)) => (Ok(resolution), index_warnings), + Err(e) => (Err(e), Vec::new()), + }; + // Warnings assembled per answer path: persisted per-symbol warnings + // (set at the lookup sites) + index-level rebuild warnings. The + // missing-index self-heal warning does NOT belong here — a successful + // resolution proves usable data exists (see the NotFound arm, the + // only payload that carries it). + let answer_warnings = |mut persisted: Vec| -> Vec { + persisted.extend(index_warnings.iter().cloned()); + persisted + }; let canonical = match resolution { Err(e) => { - let failure = crate::symbols::SymbolLookupFailure::classify( + let mut failure = crate::symbols::SymbolLookupFailure::classify( format!("{e:#}"), indexer.index_age(&db_path), ); + if index_missing { + failure.hint_for_agent.push_str( + " A background rebuild of the missing index was started — retry this call once it completes.", + ); + } let json = serde_json::to_string(&failure).unwrap_or_else(|_| failure.error.clone()); return Ok(CallToolResult::success(vec![ContentBlock::text(json)])); @@ -391,6 +534,8 @@ impl CodesearchService { // empty answer: the caller selected that key deliberately, // so a miss means the answer it came from and the index // have drifted apart. + let mut failure_warnings = answer_warnings(Vec::new()); + failure_warnings.extend(heal_warning.iter().cloned()); let failure = crate::symbols::SymbolLookupFailure { error: format!( "symbol_key '{}' is not in the {} index", @@ -399,16 +544,45 @@ impl CodesearchService { class: crate::symbols::SymbolLookupFailureClass::Failed, hint_for_agent: "The index was likely rebuilt since the ambiguous answer. Re-run the original name or position query to list the current candidates instead of retrying the key." .to_string(), + warnings: failure_warnings, }; let json = serde_json::to_string(&failure).unwrap_or_else(|_| failure.error.clone()); return Ok(CallToolResult::success(vec![ContentBlock::text(json)])); } Ok(crate::symbols::KeyMatch::NotFound) => { - // Preserve the historical contract for fuzzy queries: an - // unresolvable name/position answers empty references. - let impact = build_impact(Vec::new(), None, Vec::new()); - let json = serde_json::to_string(&impact).unwrap_or_else(|_| "{}".to_string()); + // Preserve the historical contract for fuzzy NAME queries: + // an unresolvable name answers empty references. A POSITION + // query is exact input — NotFound means the (file, line) + // pair maps to nothing in this index (wrong line + // convention, lines from a stale chunker, a file the + // indexer never saw), and an empty-references answer + // reads as "no callers" (observed live: an agent concluded + // a heavily-called method had zero call sites because the + // position query missed). Loud failure, not silence. + if !has_position { + let mut warnings = answer_warnings(Vec::new()); + warnings.extend(heal_warning.iter().cloned()); + let impact = build_impact(Vec::new(), None, warnings); + let json = serde_json::to_string(&impact).unwrap_or_else(|_| "{}".to_string()); + return Ok(CallToolResult::success(vec![ContentBlock::text(json)])); + } + // Warnings ride on EVERY answer shape — the failure must + // not advise an action that is already running (heal) or + // hide that the index is known-incomplete. + let mut failure_warnings = answer_warnings(Vec::new()); + failure_warnings.extend(heal_warning.iter().cloned()); + let failure = crate::symbols::SymbolLookupFailure { + error: format!( + "no indexed symbol at {} in the {} index", + echo, language_for_lookup + ), + class: crate::symbols::SymbolLookupFailureClass::Failed, + hint_for_agent: "Position lines are 1-based (editor lines). If the line came from `find` on an index that has not been reindexed since the 1-based chunk-line fix, it may be off by one — reindex the repo, or resolve by `symbol_name` and pass `symbol_key` from the candidates instead.".to_string(), + warnings: failure_warnings, + }; + let json = + serde_json::to_string(&failure).unwrap_or_else(|_| failure.error.clone()); return Ok(CallToolResult::success(vec![ContentBlock::text(json)])); } Ok(crate::symbols::KeyMatch::Resolved(canonical)) => canonical, @@ -450,7 +624,11 @@ impl CodesearchService { // The warm retry must carry the same honesty as a fresh // answer: read the persisted warnings for this key. let warnings = indexer.lookup_warnings(&db_path, &canonical); - let impact = build_impact(references, Some(canonical.clone()), warnings); + let impact = build_impact( + references, + Some(canonical.clone()), + answer_warnings(warnings), + ); let json = serde_json::to_string(&impact).unwrap_or_else(|_| "{}".to_string()); return Ok(CallToolResult::success(vec![ContentBlock::text(json)])); } @@ -506,7 +684,7 @@ impl CodesearchService { // Surface what the lookup survived: a partial answer must // say so in its own payload, not only in a log line. let warnings = indexer.lookup_warnings(&db_path, &canonical); - let impact = build_impact(references, Some(canonical), warnings); + let impact = build_impact(references, Some(canonical), answer_warnings(warnings)); let json = serde_json::to_string(&impact).unwrap_or_else(|_| "{}".to_string()); Ok(CallToolResult::success(vec![ContentBlock::text(json)])) } diff --git a/src/mcp/find_impact_tests.rs b/src/mcp/find_impact_tests.rs index a07b7927..0780a302 100644 --- a/src/mcp/find_impact_tests.rs +++ b/src/mcp/find_impact_tests.rs @@ -7,7 +7,10 @@ //! resolution is tested separately against `resolve_find_impact_budget_secs` //! with `#[serial]` + `EnvRestore` per the repo rule for env mutation. -use super::{find_impact_with_budget, resolve_find_impact_budget_secs, ImpactLookupOutcome}; +use super::{ + find_impact_with_budget, missing_index_warning, resolve_find_impact_budget_secs, + ImpactLookupOutcome, SymbolIndexHeal, +}; use crate::constants::{DEFAULT_FIND_IMPACT_BUDGET_SECS, FIND_IMPACT_BUDGET_SECS_ENV}; use crate::symbols::{SymbolLookupBusy, SymbolReference}; use std::path::PathBuf; @@ -253,6 +256,7 @@ fn fingerprint_fields_present_when_set_and_omitted_when_none() { scope: "project:p".to_string(), index_head_sha, current_head_sha, + symbol_index: Vec::new(), } }; let all: serde_json::Value = serde_json::to_value(base( @@ -283,6 +287,37 @@ fn fingerprint_fields_present_when_set_and_omitted_when_none() { assert!(!keys.contains(&"resolved_symbol"), "keys: {keys:?}"); } +#[test] +fn index_age_sentinel_serializes_as_null_and_real_ages_as_numbers() { + use crate::symbols::{FindImpactResult, SymbolReference}; + + let result = |age: u64| FindImpactResult { + symbol: "FieldDefinition.Validate".to_string(), + resolved_symbol: None, + references: vec![SymbolReference { + file: PathBuf::from("a.cs"), + start_line: 1, + end_line: 1, + kind: "definition".to_string(), + }], + warnings: Vec::new(), + index_age_seconds: age, + language: "csharp".to_string(), + scope: "project:p".to_string(), + index_head_sha: None, + current_head_sha: None, + symbol_index: Vec::new(), + }; + + // u64::MAX is `index_age`'s unreadable-index sentinel; a consumer must + // see "unknown" (null), not 18446744073709551615 seconds. + let unknown: serde_json::Value = serde_json::to_value(result(u64::MAX)).unwrap(); + assert_eq!(unknown["index_age_seconds"], serde_json::Value::Null); + + let known: serde_json::Value = serde_json::to_value(result(12)).unwrap(); + assert_eq!(known["index_age_seconds"], serde_json::json!(12)); +} + #[test] fn ambiguity_envelope_serializes_the_four_documented_fields() { let ambiguity = crate::symbols::SymbolAmbiguity { @@ -369,6 +404,15 @@ fn build_service() -> (CodesearchService, tempfile::TempDir) { (service, root) } +/// [`build_service`] plus a solution file, so the csharp indexer is +/// APPLICABLE and answers carry a real csharp `symbol_index` entry (the +/// plain fixture repo has no entrypoints, so both languages filter out). +fn build_applicable_service() -> (CodesearchService, tempfile::TempDir) { + let (service, root) = build_service(); + std::fs::write(root.path().join("test.sln"), b"Solution File").expect("sln"); + (service, root) +} + /// Two `Validate` overloads in scip_symbols + the simple-name index — /// enough for every resolution arm (only key-presence is read). fn populate_overload_fixture(db_path: &std::path::Path) { @@ -712,6 +756,24 @@ fn warnings_bytes(warnings: &[&str]) -> Vec { bytes } +/// Persist index-level rebuild warnings the way a C# rebuild does (meta +/// key, JSON array) — the fixture for answers served from an index built +/// out of a partially loaded solution. +fn write_index_warnings_meta(db_path: &std::path::Path, warnings: &[String]) { + let env = crate::symbols::get_shared_scip_env(db_path).expect("shared env"); + let mut wtxn = env.write_txn().expect("wtxn"); + let meta: heed::Database = env + .create_database(&mut wtxn, Some(crate::constants::SCIP_META_DB_NAME)) + .unwrap(); + meta.put( + &mut wtxn, + crate::constants::SCIP_INDEX_WARNINGS_KEY, + serde_json::to_string(warnings).unwrap().as_str(), + ) + .unwrap(); + wtxn.commit().unwrap(); +} + /// One resolved symbol with persisted warnings, one without. fn populate_warnings_fixture(db_path: &std::path::Path) -> (String, String) { let warned_key = "csharp Ns . W#Warned().".to_string(); @@ -784,6 +846,52 @@ async fn resolved_answer_surfaces_persisted_warnings() { ); } +/// Every EMPTY answer carries the per-language symbol-index status of the +/// repo it came from — the check an agent needs before reading +/// `references: []` as "verified no callers". A name that matches nothing +/// is the canonical empty answer: LMDB-only, no helper spawn. Applicable +/// languages only: a repo without a tsconfig must not list typescript as +/// absent-with-blame. +#[tokio::test] +#[serial_test::serial] +async fn answers_carry_the_symbol_index_status() { + let helper_root = tempfile::tempdir().unwrap(); + let _guard = make_helper_available(&helper_root); + let (service, root) = build_applicable_service(); + populate_warnings_fixture(&root.path().join(".codesearch.db")); + + let out = tool_text( + &service, + FindImpactRequest { + symbol_name: Some("NoSuchSymbol".to_string()), + ..find_impact_request() + }, + ) + .await; + let v: serde_json::Value = serde_json::from_str(&out).unwrap(); + assert_eq!( + v["references"], + serde_json::json!([]), + "the name must not match the fixture's symbols: {out}" + ); + + let statuses = v["symbol_index"] + .as_array() + .expect("symbol_index present on an empty answer"); + let csharp = statuses + .iter() + .find(|s| s["language"] == "csharp") + .expect("csharp status entry present"); + assert_eq!( + csharp["state"], "absent", + "the fixture has symbol tables but no key-format stamp, so has_index refuses it: {out}" + ); + assert!( + statuses.iter().all(|s| s["language"] != "typescript"), + "non-applicable languages must be filtered out of find_impact answers: {out}" + ); +} + #[tokio::test] #[serial_test::serial] async fn clean_resolved_answer_omits_the_warnings_field() { @@ -811,3 +919,228 @@ async fn clean_resolved_answer_omits_the_warnings_field() { "a clean answer must OMIT warnings (skip_serializing_if), got: {out}" ); } + +/// The missing-index warning is what keeps a never-built symbol index's +/// empty reference list from passing for "no callers": whatever the heal +/// status, it must name the language and state UNKNOWN explicitly. The +/// wording per status must also stay honest — "a background rebuild was +/// started" is only allowed when one actually was. +#[test] +fn missing_index_warning_names_language_and_marks_answer_unknown() { + let warning = missing_index_warning("csharp", SymbolIndexHeal::BackgroundStarted); + assert!( + warning.contains("csharp"), + "must name the language, got: {warning}" + ); + assert!( + warning.contains("UNKNOWN"), + "must mark the empty list as UNKNOWN, got: {warning}" + ); + assert!( + warning.contains("retry"), + "must tell the caller to retry after the rebuild, got: {warning}" + ); +} + +#[test] +fn missing_index_warning_manual_names_the_build_command() { + let warning = missing_index_warning("typescript", SymbolIndexHeal::Manual); + assert!(warning.contains("UNKNOWN"), "got: {warning}"); + assert!( + warning.contains("codesearch index symbol"), + "must tell the caller how to build the index, got: {warning}" + ); + assert!( + !warning.contains("rebuild was started"), + "nothing was started — must not claim it, got: {warning}" + ); +} + +#[test] +fn missing_index_warning_not_applicable_explains_why_and_promises_nothing() { + let reason = "the scip-typescript adapter requires a top-level tsconfig.json (monorepo layouts are not resolved yet)"; + let warning = missing_index_warning("typescript", SymbolIndexHeal::NotApplicable(reason)); + assert!(warning.contains("UNKNOWN"), "got: {warning}"); + assert!( + warning.contains("tsconfig.json"), + "must surface the indexer's own reason, got: {warning}" + ); + assert!( + !warning.contains("rebuild was started"), + "a non-applicable repo can never be rebuilt here — must not claim a rebuild, got: {warning}" + ); +} + +/// A never-built index must not answer "no references" silently: the empty +/// NotFound answer carries the self-heal warning. Fails without the fix — +/// the pre-fix answer is byte-identical to a genuine "no callers", the exact +/// trap that reads as "safe to remove" (observed live on a runtime-registered +/// worktree whose SCIP index was never built). +#[tokio::test] +#[serial_test::serial] +async fn never_built_index_warns_on_the_empty_answer() { + let helper_root = tempfile::tempdir().unwrap(); + let _guard = make_helper_available(&helper_root); + // No fixture population: a valid-but-empty store — neither symbols nor a + // rebuild timestamp. This is the never-built state. + let (service, _root) = build_service(); + + let out = tool_text( + &service, + FindImpactRequest { + symbol_name: Some("ResolveLinkedActivityAsync".to_string()), + ..find_impact_request() + }, + ) + .await; + let v: serde_json::Value = serde_json::from_str(&out).unwrap(); + assert!( + v["references"].as_array().is_some_and(|a| a.is_empty()), + "the never-built index answers with empty references, got: {out}" + ); + let warnings = v["warnings"].as_array().expect("self-heal warning present"); + assert_eq!( + warnings.len(), + 1, + "exactly the missing-index warning, got: {out}" + ); + assert!( + warnings[0].as_str().is_some_and(|w| w.contains("UNKNOWN")), + "the warning must mark the answer UNKNOWN, got: {out}" + ); +} + +/// A POSITION query that misses the index must answer a loud typed failure, +/// never the empty-references shape: an agent copying (file, line) from a +/// `find` result on a stale index read the silent empty answer as "zero +/// callers" (observed live: a method with 8 call sites "had" 0 because the +/// position query missed by a line convention drift). Name queries keep the +/// historical empty answer. +#[tokio::test] +#[serial_test::serial] +async fn position_miss_answers_loud_failure_not_empty_references() { + let helper_root = tempfile::tempdir().unwrap(); + let _guard = make_helper_available(&helper_root); + let (service, project) = build_service(); + let db = project.path().join(".codesearch.db"); + let (_warned_key, clean_key) = populate_warnings_fixture(&db); + // Index-level warnings must ride on the FAILURE shape too — a position + // miss from a partially loaded index must not hide that the whole + // index's answers may be incomplete. + write_index_warnings_meta( + &db, + &["The symbol index was built while the C# workspace reported 2 distinct failure(s) — cross-project references may be missing from every answer." + .to_string()], + ); + + // A real position index with one entry: a miss below is genuinely + // "nothing at that position", not a missing DB. + { + let env = crate::symbols::get_shared_scip_env(&db).expect("shared env"); + let mut wtxn = env.write_txn().expect("wtxn"); + let positions: heed::Database = env + .create_database(&mut wtxn, Some(crate::constants::SCIP_POSITION_DB_NAME)) + .unwrap(); + let mut entry = vec![1u8]; + entry.extend_from_slice(&bincode::serialize(&vec![clean_key]).unwrap()); + positions.put(&mut wtxn, "src/w.cs:5", &entry).unwrap(); + wtxn.commit().unwrap(); + } + + let out = tool_text( + &service, + FindImpactRequest { + file: Some("src/w.cs".to_string()), + line: Some(999), + ..find_impact_request() + }, + ) + .await; + let v: serde_json::Value = serde_json::from_str(&out).unwrap(); + assert!( + v.get("references").is_none(), + "a position miss must not answer the empty-references shape, got: {out}" + ); + assert_eq!(v["class"], "failed", "typed failure, got: {out}"); + assert!( + v["hint_for_agent"] + .as_str() + .is_some_and(|h| h.contains("1-based")), + "the hint must explain the line convention, got: {out}" + ); + let failure_warnings = v["warnings"] + .as_array() + .expect("index-level warnings ride the failure"); + assert!( + failure_warnings.iter().any(|w| w + .as_str() + .is_some_and(|w| w.contains("cross-project references"))), + "the partial-index warning must not be hidden by the failure, got: {out}" + ); +} + +/// Index-level rebuild warnings must ride on EVERY answer from an index +/// built out of a partially loaded solution — resolved answers AND empty +/// NotFound answers. This pins the live defect reported on a customer +/// worktree: MSBuild project-load failures (broken NuGet restore) produced +/// an index with definitions but no cross-project references, and every +/// answer passed as clean while an orphan-check read the empty lists as +/// "no callers". +#[tokio::test] +#[serial_test::serial] +async fn index_level_rebuild_warnings_ride_on_resolved_and_empty_answers() { + let helper_root = tempfile::tempdir().unwrap(); + let _guard = make_helper_available(&helper_root); + let (service, project) = build_service(); + let db = project.path().join(".codesearch.db"); + let (_warned_key, clean_key) = populate_warnings_fixture(&db); + let index_warnings = vec![ + "The symbol index was built while the C# workspace reported 2 distinct failure(s) — cross-project references may be missing from every answer. Failures `dotnet build` also reports are real and fixable in the repo (often a missing dotnet restore); failures only scip-csharp reports are tool-side — please report them and reindex." + .to_string(), + "App.Dam.csproj: depends on Analyzer.X (>= 1.2.3) but it was not found".to_string(), + ]; + write_index_warnings_meta(&db, &index_warnings); + + // A RESOLVED answer from the partial index carries the index warnings. + let out = tool_text( + &service, + FindImpactRequest { + symbol_key: Some(clean_key.clone()), + ..find_impact_request() + }, + ) + .await; + let v: serde_json::Value = serde_json::from_str(&out).unwrap(); + assert_eq!( + v["resolved_symbol"], clean_key, + "the fixture query must resolve, got: {out}" + ); + let warnings = v["warnings"].as_array().expect("warnings present"); + assert_eq!( + serde_json::to_value(warnings).unwrap(), + serde_json::to_value(&index_warnings).unwrap(), + "a resolved answer from a partially built index carries exactly the index warnings: {out}" + ); + + // The EMPTY NotFound answer carries them too — an empty reference list + // out of a partial index must never pass for "no callers". + let out = tool_text( + &service, + FindImpactRequest { + symbol_name: Some("NotARealSymbolAnywhere".to_string()), + ..find_impact_request() + }, + ) + .await; + let v: serde_json::Value = serde_json::from_str(&out).unwrap(); + assert!( + v["references"].as_array().is_some_and(|a| a.is_empty()), + "unknown symbol answers empty, got: {out}" + ); + assert!( + v["warnings"].as_array().is_some_and( + |w| !w.is_empty() && w[0].as_str().is_some_and(|s| s.contains("cross-project")) + ), + "the empty answer must carry the index-level warning, got: {out}" + ); +} diff --git a/src/mcp/get_chunk.rs b/src/mcp/get_chunk.rs index eaba0e6e..afd46d5a 100644 --- a/src/mcp/get_chunk.rs +++ b/src/mcp/get_chunk.rs @@ -284,8 +284,11 @@ impl CodesearchService { Ok(src) => { let lines: Vec<&str> = src.lines().collect(); if !lines.is_empty() { - let before_start = chunk.start_line.saturating_sub(context_lines); - let before_end = chunk.start_line.min(lines.len()); + // Chunk lines are 1-based; slices need the 0-based + // row before the chunk's first line. + let before_end = chunk.start_line.saturating_sub(1); + let before_start = before_end.saturating_sub(context_lines); + let before_end = before_end.min(lines.len()); if before_start < before_end { context_before = Some(lines[before_start..before_end].join("\n")); } diff --git a/src/mcp/helpers.rs b/src/mcp/helpers.rs index 02fbdcd6..77b5efbf 100644 --- a/src/mcp/helpers.rs +++ b/src/mcp/helpers.rs @@ -119,24 +119,6 @@ pub(crate) fn prefix_path_with_alias( } } -/// Prefix a result path with the matching repo alias from a set of aliases and their roots. -/// Used by handlers that have alias/root info but not a full `MultiStoreContext`. -pub(crate) fn prefix_path_multi( - path: &str, - aliases: &[String], - alias_roots: &std::collections::HashMap, -) -> String { - let normalized = crate::cache::normalize_path_str(path); - for alias in aliases { - if let Some(root) = alias_roots.get(alias) { - if normalized.starts_with(root.as_str()) { - return prefix_path_with_alias(path, Some(alias), root); - } - } - } - normalized -} - /// Pick the project root to relativise a result path against for a `filter_path` /// prefix match, so `filter_path` is interpreted **relative to the repo root** /// in every routing mode: diff --git a/src/mcp/mod.rs b/src/mcp/mod.rs index ac0a38a7..a57ae7d7 100644 --- a/src/mcp/mod.rs +++ b/src/mcp/mod.rs @@ -37,6 +37,29 @@ fn store_lock_wait() -> std::time::Duration { .unwrap_or_else(|| std::time::Duration::from_secs(crate::constants::STORE_LOCK_WAIT_SECS)) } +/// Build the structured `project_unresolved` refusal JSON for an unknown +/// `project=` alias (NEE-P-CONSISTENT: a refusal names its class and remedy). +/// Pure + unit-testable; the caller supplies the serve hub's enumeration. +fn unknown_project_error_json( + alias: &str, + projects: Vec, + groups: Vec, + project_groups: std::collections::HashMap>, +) -> String { + let payload = serde_json::json!({ + "error_code": "project_unresolved", + "message": format!("Unknown project alias '{}'.", alias), + "available_projects": projects, + "available_groups": groups, + "project_groups": project_groups, + "hint_for_agent": format!( + "'{}' is not a registered project. Re-call with one of available_projects, or ask the user which repository to search. project_groups maps each project to its group(s) — prefer group= when the target is listed there.", + alias + ) + }); + payload.to_string() +} + /// Acquire the vector-store read lock with a bounded wait. /// /// A handler queued on this lock keeps its `Arc` — and with it @@ -1145,8 +1168,16 @@ impl CodesearchService { types::validate_project_group(project, group, true)?; if let Some(ref alias) = project { - let stores = serve_state.get_or_open_stores(alias, true).await?; - return Ok(Some((vec![stores], vec![alias.clone()]))); + // A bad alias is a NAMED refusal, not a bare string: surface the same + // available-projects envelope the unscoped case uses (P1, codesearch + // tuning round 2026-10-16) so an agent corrects without guessing. + return match serve_state.get_or_open_stores(alias, true).await { + Ok(stores) => Ok(Some((vec![stores], vec![alias.clone()]))), + Err(e) if e.contains("Unknown alias") => { + Err(self.format_unknown_project_error(alias)) + } + Err(e) => Err(e), + }; } if let Some(ref group_name) = group { @@ -1258,25 +1289,7 @@ impl CodesearchService { /// that picking a single project would miss sibling repos in the same group /// (e.g. a separate config / import-data repo). fn format_scope_error(&self) -> String { - let (projects, mut groups, project_groups) = if let Some(ref serve_state) = self.serve_state - { - let cfg = serve_state.config_snapshot(); - let mut projects: Vec = cfg.repos.keys().cloned().collect(); - // Include opt-in mounted remote projects so an agent can discover and - // route to them by name (they are first-class `project=` targets). - projects.extend( - cfg.mounted_remote_projects() - .into_iter() - .map(|(name, _)| name), - ); - projects.sort(); - projects.dedup(); - let mut groups: Vec = cfg.groups.keys().cloned().collect(); - groups.sort(); - (projects, groups, cfg.project_groups()) - } else { - (vec![], vec![], std::collections::HashMap::new()) - }; + let (projects, mut groups, project_groups) = self.project_scope_payload(); // The "all" virtual group is always available when there are projects to // search — advertise it so agents discover the cross-repo shortcut. // (scope_required only fires when >1 repo is registered, so this is safe.) @@ -1297,6 +1310,45 @@ impl CodesearchService { payload.to_string() } + /// The `(available_projects, available_groups, project_groups)` triple for the + /// active serve hub (empty in local mode). One home for the enumeration shared + /// by the scope and unknown-project refusals. + fn project_scope_payload( + &self, + ) -> ( + Vec, + Vec, + std::collections::HashMap>, + ) { + if let Some(ref serve_state) = self.serve_state { + let cfg = serve_state.config_snapshot(); + let mut projects: Vec = cfg.repos.keys().cloned().collect(); + // Include opt-in mounted remote projects so an agent can discover and + // route to them by name (they are first-class `project=` targets). + projects.extend( + cfg.mounted_remote_projects() + .into_iter() + .map(|(name, _)| name), + ); + projects.sort(); + projects.dedup(); + let mut groups: Vec = cfg.groups.keys().cloned().collect(); + groups.sort(); + (projects, groups, cfg.project_groups()) + } else { + (vec![], vec![], std::collections::HashMap::new()) + } + } + + /// Build a structured `project_unresolved` error JSON for an unknown + /// `project=` alias (NEE-P-CONSISTENT: a refusal names its class and remedy). + /// Previously a bare `Unknown alias 'x'` string reached the agent with no + /// valid-project list — the exact shape that forces a guessing round-trip. + fn format_unknown_project_error(&self, alias: &str) -> String { + let (projects, groups, project_groups) = self.project_scope_payload(); + unknown_project_error_json(alias, projects, groups, project_groups) + } + /// Execute a read-only action against the vector store with an explicit store override. /// /// If `store_override` is provided (from project/group routing), it takes precedence. diff --git a/src/mcp/proxy.rs b/src/mcp/proxy.rs index 64ed5b29..04fac49e 100644 --- a/src/mcp/proxy.rs +++ b/src/mcp/proxy.rs @@ -1,13 +1,31 @@ use rmcp::{ model::{ CallToolRequestParams, CallToolResponse, Implementation, ListToolsResult, - PaginatedRequestParams, ServerCapabilities, ServerConfig, + PaginatedRequestParams, ResultType, ServerCapabilities, ServerConfig, }, service::RequestContext, ErrorData as McpError, RoleClient, RoleServer, ServerHandler, }; use std::sync::{Arc, Mutex}; +/// The serve hub strips the SEP-2322 `resultType` discriminator for the +/// hub↔proxy session (rmcp's client always requests a handshake version, so +/// that session stays pre-2026-07-28). Re-stamp `"complete"` on forwarded +/// results; rmcp's dispatch strips it again when the client on the stdio side +/// is itself pre-2026-07-28, so the legacy wire shape is preserved there. +fn restamp_complete(mut result: ListToolsResult) -> ListToolsResult { + result.result_type = Some(ResultType::COMPLETE); + result +} + +/// Same as [`restamp_complete`] for `tools/call` outcomes. +fn restamp_complete_response(mut response: CallToolResponse) -> CallToolResponse { + if let CallToolResponse::Complete(ref mut result) = response { + result.result_type = Some(ResultType::COMPLETE); + } + response +} + // ═══════════════════════════════════════════════════════════════════ // MCP Proxy Service (--mode client / --mode auto with serve detected) // ═══════════════════════════════════════════════════════════════════ @@ -374,7 +392,7 @@ impl ServerHandler for McpProxyService { Some(p) => match p.list_tools(request.clone()).await { Ok(r) => { self.mark_activity(); - return Ok(r); + return Ok(restamp_complete(r)); } Err(e) => { let msg = e.to_string(); @@ -434,7 +452,7 @@ impl ServerHandler for McpProxyService { Some(p) => match p.call_tool(request.clone()).await { Ok(r) => { self.mark_activity(); - return Ok(r.into()); + return Ok(restamp_complete_response(r.into())); } Err(e) => { let msg = e.to_string(); @@ -487,6 +505,10 @@ impl ServerHandler for McpProxyService { #[path = "proxy_idle_tests.rs"] mod proxy_idle_tests; +#[cfg(test)] +#[path = "proxy_stamp_tests.rs"] +mod proxy_stamp_tests; + /// Unit tests for `await_peer_bounded`'s refusal clamp and the /// `note_connect_failure` call site that fires it in production, isolated /// from the full `run_mcp_client` loop by parameterizing the wait budget (and, diff --git a/src/mcp/proxy_stamp_tests.rs b/src/mcp/proxy_stamp_tests.rs new file mode 100644 index 00000000..df536714 --- /dev/null +++ b/src/mcp/proxy_stamp_tests.rs @@ -0,0 +1,49 @@ +//! Unit tests for the proxy SEP-2322 re-stamp helpers. +//! +//! The wire-shape guard in `tests/mcp_protocol_bridge.rs` runs `--mode local` +//! and can never reach these helpers (they only fire on the proxy path), so +//! the stamp behavior is pinned here directly: a hub-stripped result gets +//! `"complete"` back, and non-`Complete` `CallToolResponse` variants keep +//! their own semantics. + +use super::{restamp_complete, restamp_complete_response}; +use rmcp::model::{ + CallToolResponse, CallToolResult, InputRequiredResult, ListToolsResult, ResultType, +}; + +#[test] +fn restamp_complete_sets_stripped_discriminator() { + // hub stripped result_type for the hub<->proxy session + let result = ListToolsResult { + result_type: None, + ..Default::default() + }; + let result = restamp_complete(result); + assert_eq!(result.result_type, Some(ResultType::COMPLETE)); +} + +#[test] +fn restamp_complete_response_stamps_complete_variant() { + let mut inner = CallToolResult::success(vec![]); + inner.result_type = None; // hub stripped it + let response = restamp_complete_response(CallToolResponse::Complete(inner)); + match response { + CallToolResponse::Complete(result) => { + assert_eq!(result.result_type, Some(ResultType::COMPLETE)); + } + other => panic!("expected Complete variant, got {other:?}"), + } +} + +#[test] +fn restamp_complete_response_leaves_non_complete_variants_alone() { + let input_required = + CallToolResponse::InputRequired(InputRequiredResult::from_request_state("opaque")); + let stamped = restamp_complete_response(input_required); + match stamped { + CallToolResponse::InputRequired(result) => { + assert_eq!(result.result_type, ResultType::INPUT_REQUIRED); + } + other => panic!("expected InputRequired variant to pass through, got {other:?}"), + } +} diff --git a/src/mcp/responses.rs b/src/mcp/responses.rs index d2b4ca73..dcb5f09b 100644 --- a/src/mcp/responses.rs +++ b/src/mcp/responses.rs @@ -162,6 +162,10 @@ pub(crate) struct MultiReadOutcome { pub(crate) failures: Vec<(String, String)>, } +/// Message for the "rebuild running" override shared by the single- and +/// multi-store status paths. +const REBUILD_RUNNING_MESSAGE: &str = "A rebuild (FTS, vector and symbol indexes) is running — results may be incomplete until it completes."; + /// Decide the `status`/`status_message` pair for a multi-store /// `status(kind="index"|"projects")` response. /// @@ -182,6 +186,7 @@ pub(crate) fn index_status_summary( failed_count: usize, total_chunks: usize, all_indexed: bool, + indexing: bool, ) -> (String, String) { if total_repos > 0 && failed_count >= total_repos { ( @@ -208,6 +213,8 @@ pub(crate) fn index_status_summary( "Chunks are indexed across {total_repos} repo(s) but the vector index is not built yet — searches may fail until indexing completes." ), ) + } else if indexing { + ("building".to_string(), REBUILD_RUNNING_MESSAGE.to_string()) } else if failed_count > 0 { ( "ready".to_string(), @@ -267,8 +274,14 @@ pub(crate) fn aggregate_serve_index_status( /// fails with "Index not built" — so it must not read as `ready`. During a /// rebuild there is a window where chunks are inserted but `build_index()` has /// not run yet, which is exactly when an operator asks "is the migration done?". -pub(crate) fn single_index_status(total_chunks: usize, indexed: bool) -> (String, String) { - if total_chunks == 0 { +pub(crate) fn single_index_status( + total_chunks: usize, + indexed: bool, + indexing: bool, +) -> (String, String) { + if indexing { + ("building".to_string(), REBUILD_RUNNING_MESSAGE.to_string()) + } else if total_chunks == 0 { ( "building".to_string(), "Index is being built in the background. Searches may fail until indexing completes. Please check back in a few minutes.".to_string(), diff --git a/src/mcp/search.rs b/src/mcp/search.rs index 5ac0200a..c47d324e 100644 --- a/src/mcp/search.rs +++ b/src/mcp/search.rs @@ -499,6 +499,16 @@ impl CodesearchService { let mode = request.mode.as_deref().unwrap_or("auto"); let structural_intent = detect_structural_intent(&request.query); + // Repo ownership is carried WITH each result, not reconstructed from a + // chunk-id-only map. Every fan-out hit and every chunk resolved from a + // store has its alias baked into its path the moment the owning store + // (alias) is known. Chunk ids are allocated per store and collide + // across repos, so keying ownership by `u32` alone silently mislabels + // (or drops) the result of one repo when two share a local id — the + // reason a `group=` response could point at the wrong repo. Attributing + // at creation keeps group results ("alias/path") consistent with the + // `project=` routing without ever trusting a non-unique id. + // === Lexical mode: FTS only across all stores === if mode == "lexical" { // Lexical has no second backend, so a failed store here is invisible @@ -545,22 +555,21 @@ impl CodesearchService { .unwrap_or(std::cmp::Ordering::Equal) }); - let results = self + let mut results = self .resolve_fts_to_search_results_multi( &all_fts, limit, &stores, aliases, + alias_roots, &mut lexical_warnings, ) .await; if let Some(target_kind) = structural_intent { - // We need mutable results but we have them as vectordb::SearchResult - let mut mutable_results = results; - boost_kind(&mut mutable_results, target_kind); + boost_kind(&mut results, target_kind); return self.build_semantic_response( - mutable_results, + results, request, compact, !identifiers.is_empty(), @@ -643,9 +652,19 @@ impl CodesearchService { "internal error: no query embedding resolved for repo '{alias}'" ) })?; - store + let mut found = store .search(embedding, limit * 5) - .context("Error searching vector store") + .context("Error searching vector store")?; + // Attribute each hit to its own repo here, while the owning + // store (alias) is known: chunk ids are only unique within a + // store, so deferring to a chunk-id-keyed map would collapse + // hits from different repos that share a local id. + if let Some(root) = alias_roots.get(alias) { + for r in &mut found { + r.path = prefix_path_with_alias(&r.path, Some(alias), root); + } + } + Ok(found) }, stores.clone(), aliases, @@ -806,6 +825,7 @@ impl CodesearchService { f.rrf_score, &stores, aliases, + alias_roots, &mut search_warnings, ) .await @@ -832,12 +852,14 @@ impl CodesearchService { } /// Resolve a single chunk from multiple stores (used for FTS-only hits in multi-store fusion). + #[allow(clippy::too_many_arguments)] async fn resolve_chunk_from_stores( &self, chunk_id: u32, score: f32, stores: &[Arc], aliases: &[String], + alias_roots: &std::collections::HashMap, warnings: &mut Vec, ) -> Option { for (idx, store_arc) in stores.iter().enumerate() { @@ -853,10 +875,21 @@ impl CodesearchService { note_store_failure(warnings, aliases, idx, "chunk lookup", e); } if let Ok(Some(chunk)) = looked_up { + // Attribute the path to the store this content was actually + // read from — the probe order here is what decided the owner. + let path = match ( + aliases.get(idx), + aliases.get(idx).and_then(|a| alias_roots.get(a)), + ) { + (Some(alias), Some(root)) => { + prefix_path_with_alias(&chunk.path, Some(alias.as_str()), root) + } + _ => chunk.path, + }; return Some(crate::vectordb::SearchResult { id: chunk_id, content: chunk.content, - path: chunk.path, + path, start_line: chunk.start_line, end_line: chunk.end_line, kind: chunk.kind, @@ -875,12 +908,14 @@ impl CodesearchService { } /// Resolve FTS results to SearchResult using multiple stores. + #[allow(clippy::too_many_arguments)] async fn resolve_fts_to_search_results_multi( &self, fts_results: &[crate::fts::FtsResult], limit: usize, stores: &[Arc], aliases: &[String], + alias_roots: &std::collections::HashMap, warnings: &mut Vec, ) -> Vec { let mut results = Vec::new(); @@ -903,10 +938,21 @@ impl CodesearchService { note_store_failure(warnings, aliases, idx, "chunk lookup", e); } if let Ok(Some(chunk)) = looked_up { + // Same as resolve_chunk_from_stores: attribute the path to + // the store this content was actually read from. + let path = match ( + aliases.get(idx), + aliases.get(idx).and_then(|a| alias_roots.get(a)), + ) { + (Some(alias), Some(root)) => { + prefix_path_with_alias(&chunk.path, Some(alias.as_str()), root) + } + _ => chunk.path, + }; results.push(crate::vectordb::SearchResult { id: fts.chunk_id, content: chunk.content, - path: chunk.path, + path, start_line: chunk.start_line, end_line: chunk.end_line, kind: chunk.kind, @@ -1090,7 +1136,10 @@ impl CodesearchService { }) .collect(); - // Prefix paths with alias for multi-repo / single-project identification + // `project=` routing prefixes paths with the routed alias here. Group + // fan-out results arrive already alias-prefixed (semantic_search_multi + // recorded each chunk's repo), so this pass only normalizes them; + // stdio without alias roots passes paths through untouched. for item in &mut items { if let Some(alias) = project_alias { if let Some(root) = alias_roots.get(alias) { @@ -1099,7 +1148,7 @@ impl CodesearchService { item.path = crate::cache::normalize_path_str(&item.path); } } else if !alias_roots.is_empty() { - item.path = prefix_path_multi(&item.path, &[], alias_roots); + item.path = crate::cache::normalize_path_str(&item.path); } } diff --git a/src/mcp/status.rs b/src/mcp/status.rs index 72368231..18e2efca 100644 --- a/src/mcp/status.rs +++ b/src/mcp/status.rs @@ -220,8 +220,17 @@ impl CodesearchService { } } - let (status, status_message) = - index_status_summary(sv.len(), failed_count, total_chunks, all_built); + let any_indexing = self + .serve_state + .as_ref() + .is_some_and(|s| ctx.aliases().iter().any(|a| s.is_indexing(a))); + let (status, status_message) = index_status_summary( + sv.len(), + failed_count, + total_chunks, + all_built, + any_indexing, + ); let response = IndexStatusResponse { indexed: all_indexed, @@ -275,7 +284,13 @@ impl CodesearchService { // Determine status based on database state. `stats.indexed` (the HNSW // graph is built) is load-bearing — see `single_index_status`. - let (status, status_message) = single_index_status(stats.total_chunks, stats.indexed); + let indexing = self + .serve_state + .as_ref() + .zip(ctx.project_alias.as_deref()) + .is_some_and(|(s, a)| s.is_indexing(a)); + let (status, status_message) = + single_index_status(stats.total_chunks, stats.indexed, indexing); let response = IndexStatusResponse { indexed: stats.indexed, diff --git a/src/mcp/tests.rs b/src/mcp/tests.rs index 79408b7d..5bb6c367 100644 --- a/src/mcp/tests.rs +++ b/src/mcp/tests.rs @@ -505,6 +505,25 @@ fn test_path_prefix_no_alias() { assert_eq!(result, "src/main.rs"); } +#[test] +fn test_strip_alias_prefix_variants() { + // The inbound counterpart of prefix_path_with_alias: find_impact + // position queries arrive as find reports them — alias-prefixed. + let alias = "myrepo".to_string(); + assert_eq!( + super::strip_alias_prefix("myrepo/src/main.rs", Some(&alias)), + "src/main.rs" + ); + assert_eq!( + super::strip_alias_prefix("other/src/main.rs", Some(&alias)), + "other/src/main.rs" + ); + assert_eq!( + super::strip_alias_prefix("src/main.rs", None), + "src/main.rs" + ); +} + #[test] fn test_path_prefix_empty_alias() { let result = super::prefix_path_with_alias("C:/repo/src/main.rs", Some(""), "C:/repo"); @@ -565,6 +584,140 @@ fn test_relative_path_empty_alias() { assert_eq!(result, "docs/guide.md"); } +// === group fan-out alias attribution (semantic_search_multi) === + +#[tokio::test] +async fn group_lexical_search_attributes_each_hit_to_its_repo() { + use rmcp::model::ContentBlock; + + // Two repos with disjoint chunk ids. A group query must answer with + // alias-prefixed paths ("alpha/…", "beta/…") exactly like a project= + // query — before the fix the fan-out lost the store of origin and both + // hits came back bare, making a cross-repo response unattributable. + let root_a = tempfile::tempdir().expect("tempdir a"); + let stores_a = std::sync::Arc::new( + crate::index::SharedStores::new(&root_a.path().join(".codesearch.db"), 2) + .expect("stores a"), + ); + { + let mut vs = stores_a.vector_store.write().await; + let chunk = crate::chunker::Chunk::new( + "fn gadget() {}".to_string(), + 0, + 0, + crate::chunker::ChunkKind::Function, + "src/lib.rs".to_string(), + ); + vs.insert_chunks(vec![crate::embed::EmbeddedChunk::new( + chunk, + vec![0.0, 1.0], + )]) + .expect("insert chunk a"); + vs.build_index().expect("build index a"); + } + { + let mut fts = stores_a.fts_store.write().await; + fts.add_chunk(0, "fn gadget() {}", "src/lib.rs", None, "Function") + .expect("fts doc a"); + fts.commit().expect("commit a"); + } + + let root_b = tempfile::tempdir().expect("tempdir b"); + let stores_b = std::sync::Arc::new( + crate::index::SharedStores::new(&root_b.path().join(".codesearch.db"), 2) + .expect("stores b"), + ); + { + // insert_chunks assigns ids from 0 per store, so a filler chunk keeps + // the real one at id 1 and the two test repos never share a chunk id. + let mut vs = stores_b.vector_store.write().await; + let filler = crate::chunker::Chunk::new( + "filler".to_string(), + 0, + 0, + crate::chunker::ChunkKind::Function, + "src/filler.rs".to_string(), + ); + let chunk = crate::chunker::Chunk::new( + "gadget helper".to_string(), + 0, + 0, + crate::chunker::ChunkKind::Function, + "src/util.rs".to_string(), + ); + vs.insert_chunks(vec![crate::embed::EmbeddedChunk::new( + filler, + vec![0.5, 0.5], + )]) + .expect("insert filler b"); + vs.insert_chunks(vec![crate::embed::EmbeddedChunk::new( + chunk, + vec![1.0, 0.0], + )]) + .expect("insert chunk b"); + vs.build_index().expect("build index b"); + } + { + let mut fts = stores_b.fts_store.write().await; + fts.add_chunk(1, "gadget helper", "src/util.rs", None, "Function") + .expect("fts doc b"); + fts.commit().expect("commit b"); + } + + let service = super::CodesearchService::new_with_stores( + Some(root_a.path().to_path_buf()), + Some(stores_a.clone()), + ) + .expect("service"); + + let request = super::SemanticSearchRequest { + query: "gadget".to_string(), + limit: Some(10), + compact: Some(false), + filter_path: None, + mode: Some("lexical".to_string()), + project: None, + group: Some("all".to_string()), + }; + let mut alias_roots = std::collections::HashMap::new(); + alias_roots.insert( + "alpha".to_string(), + crate::cache::normalize_path_str(&root_a.path().to_string_lossy()), + ); + alias_roots.insert( + "beta".to_string(), + crate::cache::normalize_path_str(&root_b.path().to_string_lossy()), + ); + + let result = service + .semantic_search_multi( + &request, + &[], + 10, + false, + vec![stores_a.clone(), stores_b.clone()], + &["alpha".to_string(), "beta".to_string()], + &alias_roots, + ) + .await + .expect("group search must succeed"); + + let json = match &result.content[0] { + ContentBlock::Text(t) => t.text.clone(), + other => panic!("expected text content, got {other:?}"), + }; + let parsed: serde_json::Value = serde_json::from_str(&json).expect("valid json response"); + let paths: Vec<&str> = parsed["results"] + .as_array() + .expect("results array") + .iter() + .map(|r| r["path"].as_str().expect("path string")) + .collect(); + assert_eq!(paths.len(), 2, "both repos must answer, paths: {paths:?}"); + assert!(paths.contains(&"alpha/src/lib.rs"), "paths: {paths:?}"); + assert!(paths.contains(&"beta/src/util.rs"), "paths: {paths:?}"); +} + #[test] fn test_normalize_tool_path_relativizes_absolute() { let root = std::path::Path::new("/tmp/proj"); @@ -2079,14 +2232,14 @@ fn note_store_failure_survives_a_short_alias_list() { #[test] fn index_status_summary_reports_building_before_anything_failed() { - let (status, message) = super::index_status_summary(3, 0, 0, true); + let (status, message) = super::index_status_summary(3, 0, 0, true, false); assert_eq!(status, "building"); assert!(!message.contains("failed"), "got: {message}"); } #[test] fn index_status_summary_reports_clean_ready_with_no_failures() { - let (status, message) = super::index_status_summary(3, 0, 500, true); + let (status, message) = super::index_status_summary(3, 0, 500, true, false); assert_eq!(status, "ready"); assert!(!message.contains("failed"), "got: {message}"); assert!(message.contains("3 repo(s)"), "got: {message}"); @@ -2096,7 +2249,7 @@ fn index_status_summary_reports_clean_ready_with_no_failures() { fn index_status_summary_surfaces_a_degraded_group_as_ready_with_a_count() { // This is the exact case that used to be indistinguishable from // "index still warming": some data is in, one store didn't answer. - let (status, message) = super::index_status_summary(3, 1, 500, true); + let (status, message) = super::index_status_summary(3, 1, 500, true, false); assert_eq!( status, "ready", "the two healthy stores must not be masked by the one that failed" @@ -2116,7 +2269,7 @@ fn index_status_summary_reports_error_when_every_store_failed() { // this fix, `total_chunks == 0` was checked first and this rendered as // "building" — byte-identical to "not indexed yet" — even though every // store actively failed. `failed_count >= total_repos` must win. - let (status, message) = super::index_status_summary(3, 3, 0, true); + let (status, message) = super::index_status_summary(3, 3, 0, true, false); assert_eq!( status, "error", "a group where every store failed must not read as merely 'still building'" @@ -2842,7 +2995,7 @@ fn readonly_or_require_ready_never_creates_a_missing_index() { /// failed with "Index not built. Call build_index() after inserting chunks." #[test] fn index_status_summary_reports_building_when_chunks_exist_but_graph_is_not_built() { - let (status, message) = super::index_status_summary(3, 0, 500, false); + let (status, message) = super::index_status_summary(3, 0, 500, false, false); assert_eq!( status, "building", "chunks without a built vector index are not searchable" @@ -2853,27 +3006,96 @@ fn index_status_summary_reports_building_when_chunks_exist_but_graph_is_not_buil "message must still name the scope, got: {message}" ); // A stats() failure on some stores must NOT be misread as "not built". - let (status, _) = super::index_status_summary(3, 1, 500, true); + let (status, _) = super::index_status_summary(3, 1, 500, true, false); assert_eq!( status, "ready", "a failed store is surfaced as degraded-ready" ); } +/// A running rebuild turns every would-be "ready" into "building"; states that +/// already carry a more specific verdict (all stores failed) are left alone. +#[test] +fn index_status_summary_reports_building_while_a_rebuild_runs() { + // (total_repos, failed, chunks, all_built, indexing) -> expected status + let cases = [ + ((3, 0, 500, true, true), "building"), + ((3, 1, 500, true, true), "building"), + ((3, 0, 500, true, false), "ready"), + ((3, 3, 0, true, true), "error"), + ]; + for ((repos, failed, chunks, built, indexing), expected) in cases { + let (status, message) = super::index_status_summary(repos, failed, chunks, built, indexing); + assert_eq!( + status, expected, + "case ({repos},{failed},{chunks},{built},{indexing}): {message}" + ); + } + let (_, message) = super::index_status_summary(3, 0, 500, true, true); + assert!(message.contains("rebuild"), "got: {message}"); +} + /// Single-store counterpart: the same `total_chunks > 0` shortcut reported /// `ready` for a store whose graph was never built (`indexed == false`). #[test] fn single_index_status_requires_a_built_graph_to_report_ready() { - let (status, message) = super::single_index_status(403, false); + let (status, message) = super::single_index_status(403, false, false); assert_eq!( status, "building", "403 chunks with no built graph are not searchable" ); assert!(message.contains("not built"), "got: {message}"); - let (status, _) = super::single_index_status(403, true); + let (status, _) = super::single_index_status(403, true, false); assert_eq!(status, "ready"); - let (status, _) = super::single_index_status(0, false); + let (status, _) = super::single_index_status(0, false, false); assert_eq!(status, "building"); } + +#[test] +fn test_unknown_project_error_is_classified() { + // P1 (codesearch tuning round 2026-10-16): a bad `project=` alias must be a + // NAMED refusal carrying the available-project list, not a bare + // `Unknown alias 'x'` string (NEE-P-CONSISTENT: a refusal names its class + // and remedy so the agent corrects without a guessing round-trip). + let mut project_groups = std::collections::HashMap::new(); + project_groups.insert( + "nexartis".to_string(), + vec!["alpha".to_string(), "beta".to_string()], + ); + let json = super::unknown_project_error_json( + "nope", + vec!["alpha".to_string(), "beta".to_string()], + vec!["all".to_string(), "nexartis".to_string()], + project_groups, + ); + let v: serde_json::Value = serde_json::from_str(&json).expect("valid json"); + assert_eq!(v["error_code"], "project_unresolved"); + assert_eq!(v["available_projects"][0], "alpha"); + assert_eq!(v["available_projects"][1], "beta"); + assert_eq!(v["available_groups"][1], "nexartis"); + assert!(v["hint_for_agent"].as_str().unwrap().contains("nope")); +} + +/// A running rebuild overrides "ready": the stores are still being rewritten +/// even though the previous generation's graph reports built. +#[test] +fn single_index_status_reports_building_while_a_rebuild_runs() { + // (total_chunks, indexed, indexing) -> expected status + let cases = [ + ((403, true, true), "building"), + ((403, false, true), "building"), + ((0, false, true), "building"), + ((403, true, false), "ready"), + ]; + for ((chunks, indexed, indexing), expected) in cases { + let (status, message) = super::single_index_status(chunks, indexed, indexing); + assert_eq!( + status, expected, + "case ({chunks},{indexed},{indexing}): {message}" + ); + } + let (_, message) = super::single_index_status(403, true, true); + assert!(message.contains("rebuild"), "got: {message}"); +} diff --git a/src/serve/mod.rs b/src/serve/mod.rs index 5ea6d09d..f44d87fa 100644 --- a/src/serve/mod.rs +++ b/src/serve/mod.rs @@ -23,7 +23,7 @@ use std::time::{Duration, Instant, SystemTime, UNIX_EPOCH}; use anyhow::{Context, Result}; use axum::response::{IntoResponse, Json as AxumJson}; use colored::Colorize; -use dashmap::DashMap; +use dashmap::{DashMap, DashSet}; use rmcp::transport::{ streamable_http_server::session::local::LocalSessionManager, StreamableHttpServerConfig, StreamableHttpService, @@ -38,16 +38,17 @@ use crate::constants::{ ALLOWED_HOSTS_ENV, ALLOWED_ROOTS_ENV, CHUNK_PATH, CSHARP_PREWARM_ENABLED_ENV, CSHARP_PREWARM_MAX_SYMBOLS, CSHARP_SCIP_CONCURRENCY_DEFAULT, CSHARP_SCIP_CONCURRENCY_ENV, DB_DIR_NAME, DEFAULT_SERVE_PORT, DISABLE_HOST_VALIDATION_ENV, EXPLORE_PATH, FIND_IMPACT_PATH, - FIND_PATH, HEALTHZ_PATH, HEALTH_PATH, INDEXING_PATH, LANG_CSHARP, LANG_TYPESCRIPT, - MAX_INDEXING_SECS, MAX_INDEXING_SECS_ENV, MCP_ENDPOINT_PATH, PERSIST_DEBOUNCE_SECS, - REAPER_INTERVAL_SECS, REMOTES_PATH, REPO_IDLE_TIMEOUT_ENV, REPO_IDLE_TIMEOUT_SECS, SEARCH_PATH, - SERVE_API_KEY_ENV, SERVE_PORT_ENV, STATUS_PATH, + FIND_PATH, HEALTHZ_PATH, HEALTH_PATH, INDEXING_MARKER_HEARTBEAT_SECS, INDEXING_PATH, + LANG_CSHARP, LANG_TYPESCRIPT, MAX_INDEXING_SECS, MAX_INDEXING_SECS_ENV, MCP_ENDPOINT_PATH, + PERSIST_DEBOUNCE_SECS, REAPER_INTERVAL_SECS, REMOTES_PATH, REPO_IDLE_TIMEOUT_ENV, + REPO_IDLE_TIMEOUT_SECS, SEARCH_PATH, SERVE_API_KEY_ENV, SERVE_PORT_ENV, STATUS_PATH, }; use crate::db_discovery::repos::{config_dir, ReposConfig}; use crate::index::{ CSharpRebuildNotifier, IndexManager, IndexingHeartbeat, IndexingStatusCallback, SharedStores, SymbolRebuildSignal, }; +use crate::limits::JobAcquire; use crate::mcp::types::HealthResponse; use crate::symbols::{csharp, RebuildScope, SymbolIndexerRegistry}; @@ -92,12 +93,83 @@ pub(crate) enum CSharpIndexStatus { None, /// Helper available and index built successfully. Ready, + /// Index built, but degraded or stale: the helper survived + /// workspace/MSBuild failures (definitions present while cross-project + /// references may be missing), or a rebuild was abandoned because + /// `dotnet restore` never finished (the previous index stays live). + /// Rendered yellow (`C#⚠`) in the TUI; the failures are in the info + /// panel and on every find_impact answer from this index. + Partial, /// Index exists but had errors or is stale. Error, /// Symbol index is currently being built. Indexing, } +/// Outcome of a SUCCESSFUL C# symbol rebuild, derived from the rebuild's +/// index warnings: clean → Ready (error cleared), survived failures → +/// Partial with a bounded detail line for the TUI info panel. Pure so the +/// status contract is testable without running a helper. +fn csharp_success_outcome(index_warnings: &[String]) -> (CSharpIndexStatus, Option) { + if index_warnings.is_empty() { + (CSharpIndexStatus::Ready, None) + } else { + let detail = index_warnings + .iter() + .take(3) + .cloned() + .collect::>() + .join(" | "); + (CSharpIndexStatus::Partial, Some(detail)) + } +} + +/// Symbol-index status shown for a repo: a running build wins over any cached +/// value (a stale `Ready` must not outlive a rebuild), otherwise the cache, +/// otherwise a fresh probe. Pure so the precedence is testable. +pub(crate) fn resolve_csharp_status( + cached: Option, + indexing: bool, + probe: impl FnOnce() -> CSharpIndexStatus, +) -> CSharpIndexStatus { + if indexing { + CSharpIndexStatus::Indexing + } else { + cached.unwrap_or_else(probe) + } +} + +/// Classification of a FAILED symbol rebuild, deciding how the serve layer +/// renders the outcome. Pure so the contract is table-testable without +/// running a helper (same reason as [`csharp_success_outcome`]). +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +enum SymbolRebuildFailureKind { + /// `dotnet restore` never finished within the retry cap: the previous + /// index stays live — warning (Partial), never a red error. + RestoreExhausted, + /// LMDB storage-format corruption: wipe + recovery path. + LmdbCorruption, + /// Any other failure: red Error. + Generic, +} + +/// Restore-exhaustion is checked FIRST: the typed error carries its own +/// contract (LMDB untouched, previous index live) that the corruption +/// matcher must not override. +fn classify_symbol_rebuild_failure( + msg: &str, + e: &anyhow::Error, + is_csharp: bool, +) -> SymbolRebuildFailureKind { + if is_csharp && csharp::is_restore_exhausted(e) { + SymbolRebuildFailureKind::RestoreExhausted + } else if ServeState::is_lmdb_format_corruption(msg) { + SymbolRebuildFailureKind::LmdbCorruption + } else { + SymbolRebuildFailureKind::Generic + } +} + /// Lightweight repo status derived from DashMap state only (no DB opens). pub(crate) struct RepoStatusInfo { pub(crate) status: RepoStateLabel, @@ -198,6 +270,22 @@ pub(crate) enum IndexingOwner { Symbol, } +/// Per-alias indexing markers: owner → when it last started or renewed. +type ActiveReindexes = DashMap>; + +/// A tracked background indexing task. +/// +/// `db_path` travels with the entry so the DB directory of a repo that was +/// removed mid-index can be cleaned up after the task finally exits, and +/// `started_at` lets the periodic sweeper report tasks that have been alive +/// past the stale threshold (a wedge signal for operators). +struct IndexTask { + handle: tokio::task::JoinHandle<()>, + token: CancellationToken, + db_path: PathBuf, + started_at: Instant, +} + /// Shared state for the serve mode. pub(crate) struct ServeState { /// Repo alias → opened stores (or conflicted marker). @@ -232,22 +320,28 @@ pub(crate) struct ServeState { /// `stop_fsw`) so the LMDB `Environment` drops and releases the file /// handles BEFORE the DB directory is deleted. See `await_fsw_shutdown`. fsw_tasks: DashMap>, - /// Repo alias → `(JoinHandle, CancellationToken)` of its background - /// *indexing* task (the heavy `add_repo`/`reindex` embed pass), separate - /// from `fsw_tasks` because `restart_fsw` reuses the `fsw_tasks` slot for - /// the continuous watcher loop. + /// Repo alias → its tracked background *indexing* task (the heavy + /// `add_repo`/`reindex` embed pass), separate from `fsw_tasks` because + /// `restart_fsw` reuses the `fsw_tasks` slot for the continuous watcher + /// loop. /// /// This exists to fix the index-cancellation no-op (BUG1): `add_repo` and /// `reindex` used to spawn detached, untracked `tokio::spawn` tasks that /// neither observed the cancel token nor could be awaited, so `remove_repo` /// reported success while a full-corpus embed pass kept running (and /// writing) on the removed alias — 6 GB / 52% CPU runaway. Registering the - /// handle here lets `await_index_task` (called from `remove_repo`) cancel - /// the token AND await the task before the DB directory is deleted, so the - /// task's `Arc` (and the LMDB mmap handles it keeps alive) - /// drop first. The token is stored alongside the handle so `remove_repo` - /// can cancel regardless of the repo's `RepoState` variant. - index_tasks: DashMap, CancellationToken)>, + /// task here lets `await_index_task` (called from `remove_repo`) cancel the + /// token AND wait for the task, so the task's `Arc` (and the + /// LMDB mmap handles it keeps alive) drop first. The entry is *never* + /// dropped while the task may still run: when the cooperative wait cannot + /// join it (uninterruptible `build_index`), the handle goes back into this + /// map so [`Self::sweep_index_tasks`] can reap it — and clean up a removed + /// repo's DB directory — once it finally exits. + index_tasks: DashMap, + /// Repo alias → last time [`Self::is_indexing`] / [`Self::sweep_index_tasks`] + /// warned that a *live* task's marker crossed `MAX_INDEXING_SECS`. + /// Throttles the wedge warning to once per alias per few minutes. + stale_live_warned: DashMap, /// Aliases detected with LMDB storage-format corruption (e.g. /// `MDB_BAD_VALSIZE` after a storage-layer major upgrade such as /// arroy 0.5→0.8 / heed 0.20→0.22), queued for a wipe + full force @@ -285,7 +379,7 @@ pub(crate) struct ServeState { /// capture a cheap clone that **shares** the underlying map (a bare /// `DashMap::clone()` is a deep copy and would silently disconnect the /// file-watcher callback from this field). - active_reindexes: Arc>>, + active_reindexes: Arc, /// Per-repo change count since serve started (incremented by index/reindex operations). repo_changes: DashMap, /// Per-repo last tool call: (tool_name, timestamp). @@ -319,6 +413,12 @@ pub(crate) struct ServeState { /// with the model of the repo it targets. Mirrors the `symbol_registry` /// pattern. embedding_pool: Arc, + /// Process-wide heavy-job gate (`CODESEARCH_INDEX_JOBS`): bounds how many + /// repos run a refresh / reindex / HNSW build at once. It is attached to + /// every [`SharedStores`] this state opens, so cold opens, warmup and + /// file-watcher refreshes all draw from the same budget. Queries never + /// take it. See [`crate::limits`]. + job_gate: Arc, /// Serve-wide default embedding model for newly created indexes /// (`codesearch serve --model `), or `None` for the built-in default. /// @@ -344,6 +444,17 @@ pub(crate) struct ServeState { /// Per-repo C# symbol index last error message (set when status is Error, cleared on success). /// Wrapped in `Arc` for the same reason as `csharp_index_status`. csharp_index_error: Arc>, + /// Symbol rebuilds in flight, keyed `"{lang}:{alias}"` → claim Instant. + /// Guards against double-triggered full rebuilds (find_impact self-heal + /// racing phase-2/reindex/watcher): two concurrent rebuilds interleave + /// their LMDB clear/write passes. Stale claims self-heal past the + /// indexing timeout, like `active_reindexes` markers. + symbol_rebuild_in_flight: DashMap, + /// Aliases whose degraded index (index_warnings in meta) already got its + /// automatic retry this serve process. Without this, a still-broken + /// build environment would rebuild on every evaluation — the next serve + /// start retries once more, which is the operator-visible bound. + degraded_rebuild_attempted: DashSet, /// Debounced deadline for persisting repos config metadata (unix millis). persist_deadline_unix_ms: AtomicU64, /// Ensures only one debounce worker task runs. @@ -375,6 +486,9 @@ enum RebuildDecision { Fresh, /// No `.sln` file found; C# indexing is not applicable for this repo. NoSolutionFile, + /// The repo lacks this language's entrypoint (e.g. no `tsconfig.json`) — + /// the generic per-language gate's counterpart of `NoSolutionFile`. + NotApplicable, /// The scip-csharp helper binary is not available. HelperUnavailable, /// An indexing task for this alias is already running. @@ -403,6 +517,7 @@ impl ServeState { open_locks: DashMap::new(), fsw_tasks: DashMap::new(), index_tasks: DashMap::new(), + stale_live_warned: DashMap::new(), format_recovery_queue: std::sync::Mutex::new(std::collections::VecDeque::new()), format_recovery_done: DashMap::new(), format_recovery_worker_started: std::sync::atomic::AtomicBool::new(false), @@ -420,11 +535,14 @@ impl ServeState { embedding_pool: Arc::new(crate::embed::EmbeddingServicePool::new( crate::constants::get_global_models_cache_dir().ok(), )), + job_gate: crate::limits::JobGate::from_env(), default_model: None, legacy_model_warned: DashMap::new(), tool_call_counts: DashMap::new(), csharp_index_status: Arc::new(DashMap::new()), csharp_index_error: Arc::new(DashMap::new()), + symbol_rebuild_in_flight: DashMap::new(), + degraded_rebuild_attempted: DashSet::new(), persist_deadline_unix_ms: AtomicU64::new(0), persist_worker_started: AtomicBool::new(false), #[cfg(test)] @@ -598,10 +716,11 @@ impl ServeState { /// The notifier captures `Arc` clones of the two status maps so it can be sent /// into the file-watcher background task without holding a reference to `&self`. /// The watcher calls it with [`SymbolRebuildSignal::Started`] just before a - /// rebuild runs (→ `Indexing`) and again with `Succeeded`/`Failed` when it - /// finishes (→ `Ready`/`Error`), updating `csharp_index_status` / - /// `csharp_index_error` — making both the in-progress and terminal states - /// visible in the TUI and in `/status` without any extra polling. + /// rebuild runs (→ `Indexing`) and again with `Succeeded`/`Abandoned`/ + /// `Failed` when it finishes (→ `Ready`/`Partial`/`Error`), updating + /// `csharp_index_status` / `csharp_index_error` — making both the + /// in-progress and terminal states visible in the TUI and in `/status` + /// without any extra polling. fn make_csharp_notifier(&self, alias: &str) -> CSharpRebuildNotifier { let status_map = Arc::clone(&self.csharp_index_status); let error_map = Arc::clone(&self.csharp_index_error); @@ -612,9 +731,24 @@ impl ServeState { // watcher-triggered rebuild, matching `trigger_symbol_rebuild`. status_map.insert(alias_key.clone(), CSharpIndexStatus::Indexing); } - SymbolRebuildSignal::Succeeded => { - status_map.insert(alias_key.clone(), CSharpIndexStatus::Ready); - error_map.remove(&alias_key); + SymbolRebuildSignal::Succeeded { index_warnings } => { + // Same contract as trigger_symbol_rebuild's success arm: a + // rebuild that survived workspace failures is Partial (red + // C#⚠) with the failures as the info detail — never green. + let (status, detail) = csharp_success_outcome(&index_warnings); + status_map.insert(alias_key.clone(), status); + if let Some(detail) = detail { + error_map.insert(alias_key.clone(), detail); + } else { + error_map.remove(&alias_key); + } + } + SymbolRebuildSignal::Abandoned(msg) => { + // Restore never finished within the retry cap: the previous + // index stays live, so a warning (yellow C#⚠ + detail) — + // never a red Error. Not Ready either: the index is stale. + error_map.insert(alias_key.clone(), msg); + status_map.insert(alias_key.clone(), CSharpIndexStatus::Partial); } SymbolRebuildSignal::Failed(msg) => { error_map.insert(alias_key.clone(), msg); @@ -652,18 +786,37 @@ impl ServeState { } /// Mark `alias` as actively indexing for `owner`, returning `true` if the - /// caller may proceed. Returns `false` when **any** owner holds a - /// non-stale marker (i.e. another indexing run is genuinely in progress) — - /// in that case the caller should return HTTP 409. Stale markers from - /// leaked/crashed tasks are silently dropped first. + /// caller may proceed. Returns `false` when **any** owner holds a live + /// marker (i.e. another indexing run is genuinely in progress) — in that + /// case the caller should return HTTP 409. Stale markers from leaked + /// tasks are dropped first, but a marker whose tracked task is still + /// alive is never treated as stale: queued-behind-the-gate jobs can wait + /// far past `MAX_INDEXING_SECS` without being leaks. /// /// This is the guard used by `reindex_handler`, `add_repo_handler`, and /// `spawn_force_reindex` to reject concurrent reindexes. fn begin_indexing(&self, alias: &str, owner: IndexingOwner) -> bool { let now = Instant::now(); let max = self.indexing_timeout(); + // Liveness is read before locking the marker map so the two DashMaps + // are never locked in a nested order. + let task_live = self.index_task_is_live(alias); let mut owners = self.active_reindexes.entry(alias.to_string()).or_default(); - owners.retain(|_, ts| now.duration_since(*ts) < max); + owners.retain(|owner, ts| { + if now.duration_since(*ts) < max { + return true; + } + if task_live && *owner == IndexingOwner::Reindex { + // Not a leak: renew rather than drop, or a concurrent begin + // could double-run the repo. Only the tracked index task + // (Reindex) supplies liveness evidence; other owners' stale + // markers are dropped as before. + *ts = now; + true + } else { + false + } + }); if owners.is_empty() { owners.insert(owner, now); true @@ -700,6 +853,18 @@ impl ServeState { .insert(owner, Instant::now()); } + /// Refresh `owner`'s marker only while it still exists. Unlike + /// [`Self::renew_indexing`] it never re-inserts, so a heartbeat tick that + /// races `end_indexing` cannot resurrect a finished marker (which would + /// block the reaper and every `begin_indexing` for a full timeout). + fn refresh_indexing_if_held(&self, alias: &str, owner: IndexingOwner) { + if let Some(mut owners) = self.active_reindexes.get_mut(alias) { + if let Some(ts) = owners.get_mut(&owner) { + *ts = Instant::now(); + } + } + } + /// True iff an error chain indicates LMDB storage-format corruption — /// data written by an older storage-major (arroy/heed) that the current /// one refuses to read — rather than a transient or unrelated failure. @@ -803,7 +968,18 @@ impl ServeState { self.repos.remove(alias); self.last_access.remove(alias); self.await_fsw_shutdown(alias).await; - self.await_index_task(alias).await; + if !self.await_index_task(alias).await { + // The task is still alive (typically parked in the uninterruptible + // build_index). Wiping the DB dir from under it is unsafe — it can + // wedge the task while it holds the store handles and the + // process-wide job permit. Refuse and let the next corruption + // detection retry once the task exits. + return Err(format!( + "in-flight indexing task for '{}' did not stop within the cooperative \ + budget; refusing to wipe its DB dir", + alias + )); + } let deadline = Instant::now() + Duration::from_secs(crate::constants::DB_DELETE_RETRY_BUDGET_SECS); @@ -904,7 +1080,7 @@ impl ServeState { let cancelled = self .index_tasks .get(alias) - .is_some_and(|entry| entry.value().1.is_cancelled()); + .is_some_and(|entry| entry.value().token.is_cancelled()); if cancelled { return Err(format!( "rebuild for '{}' was cancelled before it completed (stale indexing marker); \ @@ -915,14 +1091,50 @@ impl ServeState { Ok(()) } - /// Returns `true` if `alias` is currently (non-stale) indexing for any - /// owner. + /// True when a tracked indexing task for `alias` has not finished. + /// + /// Live-task evidence overrides marker age: a task queued behind the + /// process-wide job gate can wait far longer than `MAX_INDEXING_SECS` + /// without being a leak, and treating it as one (evict marker + cancel) + /// cancels healthy queued work whenever the backlog drains slower than the + /// threshold. + fn index_task_is_live(&self, alias: &str) -> bool { + self.index_tasks + .get(alias) + .is_some_and(|entry| !entry.value().handle.is_finished()) + } + + /// Throttled gate for the "live task past the stale threshold" warning: + /// true at most once per alias per five minutes. + fn stale_warn_due(&self, alias: &str) -> bool { + const WARN_EVERY: Duration = Duration::from_secs(300); + let now = Instant::now(); + let due = match self.stale_live_warned.get_mut(alias) { + Some(mut last) => { + if now.duration_since(*last) < WARN_EVERY { + false + } else { + *last = now; + true + } + } + None => true, + }; + if due { + self.stale_live_warned.insert(alias.to_string(), now); + } + due + } + + /// Returns `true` if `alias` is currently indexing for any owner. /// - /// Stale markers — those older than [`MAX_INDEXING_SECS`] — are lazily - /// evicted here. This is the self-healing mechanism: even if a - /// fire-and-forget background task panics or is cancelled between - /// `begin_indexing` and `end_indexing`, its marker eventually expires and - /// the TUI returns to the correct state without a server restart. + /// Markers older than [`MAX_INDEXING_SECS`] are aged out unless their + /// owner carries liveness evidence: a `Reindex` marker backed by a live + /// tracked index task is renewed instead. That keeps the self-healing + /// behavior for panicked or crashed tasks while never cancelling + /// live-but-slow work — a task queued on the process-wide job gate or a + /// long `build_index` routinely exceeds the threshold, and a backlog of + /// queued reindexes must drain instead of being cancelled as "leaked". /// /// Eviction runs under the shard's write lock (`get_mut` + `retain`), so a /// concurrent `begin_indexing`/`renew_indexing` that refreshed a marker in @@ -932,16 +1144,26 @@ impl ServeState { /// predicate + removal). pub(crate) fn is_indexing(&self, alias: &str) -> bool { let max = self.indexing_timeout(); + // Liveness is read before locking the marker map so the two DashMaps + // are never locked in a nested order. + let task_live = self.index_task_is_live(alias); let mut evicted: Vec = Vec::new(); + let mut renewed: Vec = Vec::new(); let mut any_left = false; if let Some(mut owners) = self.active_reindexes.get_mut(alias) { let now = Instant::now(); owners.retain(|owner, ts| { - let fresh = now.duration_since(*ts) < max; - if !fresh { + if now.duration_since(*ts) < max { + return true; + } + if task_live && *owner == IndexingOwner::Reindex { + *ts = now; + renewed.push(*owner); + true + } else { evicted.push(*owner); + false } - fresh }); any_left = !owners.is_empty(); } @@ -950,56 +1172,146 @@ impl ServeState { // raced this eviction keeps its fresh marker. self.active_reindexes.remove_if(alias, |_, m| m.is_empty()); } + if !renewed.is_empty() && self.stale_warn_due(alias) { + tracing::warn!( + "⏳ Indexing marker(s) for '{}' exceeded {}s but the tracked task is still \ + live (queued on the job gate, or a long-running build) — renewing, not \ + cancelling. Owners: {:?}", + alias, + max.as_secs(), + renewed + ); + } if !evicted.is_empty() { tracing::warn!( "🧹 Evicted stale indexing marker(s) for '{}' (older than {}s, owners \ - {:?}) — likely a leaked/crashed background task", + {:?}) — no tracked task is alive; reaping", alias, max.as_secs(), evicted ); - self.cancel_stale_index_task(alias); + self.reap_finished_index_task(alias); } any_left } - /// Cancel the background index task still registered for `alias` after its - /// indexing marker was evicted as stale. + /// Any TEXT-indexing owner (warmup, watcher, reindex) holds a marker for + /// `alias`. Only these flows rewrite the text index, so only these own + /// the general "Indexing" status; a symbol-only marker keeps the repo on + /// its resting state and drives the language columns instead. /// - /// Dropping the marker only fixes what the TUI and the reindex guard - /// *believe*; the task itself keeps running, and with it the - /// `Arc` it captured — so the LMDB env and the - /// `.writer.lock` stay held for the process lifetime. Every later write - /// (reindex, format recovery, `POST /repos`) then fails with "Database is - /// locked by another process" even though the repo looks idle and closed. - /// Cancelling the task's token releases those handles at its next - /// cancellation point. + /// Read-only by design: call after [`Self::is_indexing`], which evicts + /// stale markers, so a dead marker cannot light the status here. + fn has_text_indexing_marker(&self, alias: &str) -> bool { + self.active_reindexes + .get(alias) + .map(|owners| owners.keys().any(|o| *o != IndexingOwner::Symbol)) + .unwrap_or(false) + } + + /// A symbol (SCIP) rebuild holds its marker for `alias` — drives the + /// C#/TS columns, never the general status. + fn has_symbol_indexing_marker(&self, alias: &str) -> bool { + self.active_reindexes + .get(alias) + .map(|owners| owners.contains_key(&IndexingOwner::Symbol)) + .unwrap_or(false) + } + + /// Reap the tracked index task for `alias` once its handle has finished. /// - /// Cooperative only: the handle is never aborted (see - /// [`Self::await_index_task`] — an abort would detach the blocking - /// `build_index` that owns its own store clone and drop the post-build - /// self-cleanup), and the entry stays registered so `remove_repo` can - /// still join it. A task that already finished is reaped here instead. - fn cancel_stale_index_task(&self, alias: &str) { - let finished = match self.index_tasks.get(alias) { - Some(entry) => { - let (handle, token) = entry.value(); - if handle.is_finished() { - true - } else { - token.cancel(); - tracing::warn!( - "🧹 Cancelled the leaked index task for '{}' — releasing its store \ - handles and writer lock", - alias - ); - false + /// Called after stale markers are evicted (there is no live task by + /// definition) and from the periodic [`Self::sweep_index_tasks`]. A + /// running task is never cancelled here, however old its marker: only + /// [`Self::remove_repo`] cancels, and only for its own alias. + fn reap_finished_index_task(&self, alias: &str) { + let Some(entry) = self.index_tasks.get(alias) else { + return; + }; + if !entry.value().handle.is_finished() { + return; + } + let db_path = entry.value().db_path.clone(); + drop(entry); + if self + .index_tasks + .remove_if(alias, |_, v| v.handle.is_finished()) + .is_some() + { + self.stale_live_warned.remove(alias); + // A finished task that left markers behind panicked or errored + // without `end_indexing`; with no task left they are stale state. + // Only the Reindex owner belongs to the index task — the other + // owners (Warmup, Watcher, Symbol) manage their own lifecycle. + if !self.index_tasks.contains_key(alias) { + if let Some(mut owners) = self.active_reindexes.get_mut(alias) { + owners.remove(&IndexingOwner::Reindex); } + self.active_reindexes.remove_if(alias, |_, m| m.is_empty()); + } + // Covers the removed-mid-build case where the task exited via a + // path that never reached its post-build self-clean. + self.self_clean_if_unregistered(alias, &db_path); + } + } + + /// Periodic sweep of tracked index tasks (runs on the idle-reaper tick). + /// + /// Finishes what cooperative removal could not: reaps entries whose tasks + /// finally exited (clearing leftover markers and deleting a removed + /// repo's DB directory), re-asserts cancellation for tasks whose repo is + /// gone, and loudly reports tasks alive far past the stale threshold — + /// the wedge signal an operator needs. Live tasks are never cancelled + /// here. + fn sweep_index_tasks(&self) { + let entries: Vec<(String, bool, Duration)> = self + .index_tasks + .iter() + .map(|e| { + let v = e.value(); + ( + e.key().clone(), + v.handle.is_finished(), + v.started_at.elapsed(), + ) + }) + .collect(); + let max = self.indexing_timeout(); + for (alias, finished, age) in entries { + if finished { + self.reap_finished_index_task(&alias); + continue; + } + let registered = self + .config + .read() + .map(|c| c.resolve(&alias).is_some()) + .unwrap_or(true); + if !registered { + // A removed alias's task has no reason to keep going. The + // token was cancelled by remove_repo; re-assert it + // (idempotent, cooperative) so the entry can be reaped at its + // next cancellation point. + if let Some(entry) = self.index_tasks.get(&alias) { + if !entry.value().token.is_cancelled() { + entry.value().token.cancel(); + tracing::warn!( + "🧹 Index task for removed repo '{}' is still live — \ + cancellation re-asserted", + alias + ); + } + } + continue; + } + if age > max && self.stale_warn_due(&alias) { + tracing::warn!( + "⏳ Index task for '{}' has been live for {}s with no completion — \ + possible wedge; it stays tracked and will be reaped when it exits", + alias, + age.as_secs() + ); } - None => return, - }; - if finished { - self.index_tasks.remove(alias); } } @@ -1056,6 +1368,10 @@ impl ServeState { .arg("-1") .arg("--format=%ct") .arg("HEAD") + .env_remove("GIT_DIR") + .env_remove("GIT_WORK_TREE") + .env_remove("GIT_INDEX_FILE") + .env_remove("GIT_OBJECT_DIRECTORY") .output() { if out.status.success() { @@ -1216,6 +1532,25 @@ impl ServeState { return RebuildDecision::NoIndex; } + // Fresh-by-timestamp is not correct: an index built by an older + // binary predates both the warning capture and the helper's + // load-behaviour fixes (the deployed binary must never serve an + // index it did not produce), and an index built WITH surviving + // workspace failures carries those warnings in its meta. Both + // rebuild automatically — the version path on every binary change, + // the degraded path once per serve process so a still-broken + // environment cannot loop; the next serve start retries once. + if indexer.index_builder_version(db_path).as_deref() + != Some(crate::constants::INDEX_BUILDER_VERSION) + { + return RebuildDecision::ChangedSinceLastBuild; + } + if !indexer.index_warnings(db_path).is_empty() + && self.degraded_rebuild_attempted.insert(alias.to_string()) + { + return RebuildDecision::ChangedSinceLastBuild; + } + if last_changed > last_scip { RebuildDecision::ChangedSinceLastBuild } else { @@ -1223,6 +1558,73 @@ impl ServeState { } } + /// Claim the `(alias, language)` symbol-rebuild slot. Returns `false` + /// when a fresh claim exists (a rebuild is genuinely running); a claim + /// older than the indexing timeout is taken over (leaked by a crashed + /// task, same self-heal as [`Self::begin_indexing`]). + fn begin_symbol_rebuild(&self, alias: &str, lang: &str) -> bool { + let now = std::time::Instant::now(); + let max = self.indexing_timeout(); + let key = format!("{lang}:{alias}"); + match self.symbol_rebuild_in_flight.entry(key) { + dashmap::mapref::entry::Entry::Occupied(mut occupied) => { + if now.duration_since(*occupied.get()) < max { + return false; + } + *occupied.get_mut() = now; + true + } + dashmap::mapref::entry::Entry::Vacant(vacant) => { + vacant.insert(now); + true + } + } + } + + /// Release the `(alias, language)` symbol-rebuild slot claimed by + /// [`Self::begin_symbol_rebuild`]. + fn end_symbol_rebuild(&self, alias: &str, lang: &str) { + self.symbol_rebuild_in_flight + .remove(&format!("{lang}:{alias}")); + } + + /// Generic per-language rebuild gate. C# keeps its dedicated evaluator + /// (last_scip/last_changed bookkeeping, TUI status map); every other + /// language rebuilds only a *missing* index — drift stays + /// watcher/branch-change driven, mirroring the deliberate no-thrash + /// policy documented on `SymbolIndexer::index_head_sha`. + fn evaluate_symbol_rebuild( + self: &Arc, + lang: &str, + alias: &str, + repo_path: &Path, + db_path: &Path, + ) -> RebuildDecision { + if lang.eq_ignore_ascii_case(LANG_CSHARP) { + return self.evaluate_csharp_rebuild(alias, repo_path, db_path); + } + let Some(indexer) = self.symbol_registry.get(lang) else { + return RebuildDecision::HelperUnavailable; + }; + // Applicability before availability: the entrypoint check is cheap and + // deterministic (mirrors `evaluate_csharp_rebuild`'s .sln-first order), + // while helper availability depends on the machine. + if !indexer.applies_to(repo_path) { + return RebuildDecision::NotApplicable; + } + if !indexer.is_available() { + return RebuildDecision::HelperUnavailable; + } + if !self.begin_symbol_rebuild(alias, lang) { + return RebuildDecision::AlreadyInFlight; + } + self.end_symbol_rebuild(alias, lang); + if !indexer.has_index(db_path) { + return RebuildDecision::NoIndex; + } + RebuildDecision::Fresh + } + pub(crate) fn schedule_persist_repos_config(self: &Arc) { let deadline = Self::now_unix_millis() + (PERSIST_DEBOUNCE_SECS * 1000); self.persist_deadline_unix_ms @@ -1411,10 +1813,15 @@ impl ServeState { } } - /// Phase 2: semaphore-bounded concurrent C# SCIP rebuilds, sorted by recency. - pub(crate) async fn run_phase_2_csharp_scip(self: &Arc) { + /// Phase 2: semaphore-bounded concurrent SCIP rebuilds across all + /// installed languages, sorted by recency. C# keeps its dedicated gate + /// (`evaluate_csharp_rebuild`); other languages rebuild only a missing + /// index (no-thrash: drift is watcher/branch-change driven). + pub(crate) async fn run_phase_2_symbols(self: &Arc) { let aliases = self.aliases(); - let mut candidates: Vec<(String, i64)> = Vec::new(); + let langs = self.symbol_registry.installed_languages(); + // (alias, lang, last_changed) + let mut candidates: Vec<(String, String, i64)> = Vec::new(); for alias in &aliases { let path = match self.config.read().ok().and_then(|c| c.resolve(alias)) { @@ -1422,70 +1829,79 @@ impl ServeState { None => continue, }; let db_path = path.join(DB_DIR_NAME); - // evaluate_csharp_rebuild may spawn a git subprocess and walk the - // filesystem — offload to the blocking pool so the async runtime - // stays responsive while processing all candidates. - let state2 = self.clone(); - let alias2 = alias.clone(); - let path2 = path.clone(); - let db_path2 = db_path.clone(); - let decision = match tokio::task::spawn_blocking(move || { - state2.evaluate_csharp_rebuild(&alias2, &path2, &db_path2) - }) - .await - { - Ok(d) => d, - Err(e) => { - warn!( - "phase-2: evaluate_csharp_rebuild panicked for '{}': {:?}", - alias, e - ); - continue; - } - }; - if !decision.needs_rebuild() { - // If the SCIP index exists and is fresh, mark C# status as Ready - // so the TUI shows the C# indicator (e.g. "C#·") instead of None. - if decision == RebuildDecision::Fresh { - let mut status = self - .csharp_index_status - .get(alias) - .map(|e| *e.value()) - .unwrap_or(CSharpIndexStatus::None); - if matches!(status, CSharpIndexStatus::None) { - status = CSharpIndexStatus::Ready; + for lang in &langs { + // evaluate_symbol_rebuild may spawn a git subprocess and walk + // the filesystem — offload to the blocking pool so the async + // runtime stays responsive while processing all candidates. + let state2 = self.clone(); + let alias2 = alias.clone(); + let lang2 = lang.clone(); + let path2 = path.clone(); + let db_path2 = db_path.clone(); + let decision = match tokio::task::spawn_blocking(move || { + state2.evaluate_symbol_rebuild(&lang2, &alias2, &path2, &db_path2) + }) + .await + { + Ok(d) => d, + Err(e) => { + warn!( + "phase-2: symbol evaluate panicked for '{}' ({}): {:?}", + alias, lang, e + ); + continue; + } + }; + if !decision.needs_rebuild() { + // A fresh C# index flips the TUI C# indicator to Ready; + // other languages have no status map, nothing to update. + // Skipped while a build runs: Ready would mask it. + if decision == RebuildDecision::Fresh + && lang.as_str() == LANG_CSHARP + && !self.is_indexing(alias) + { + let mut status = self + .csharp_index_status + .get(alias) + .map(|e| *e.value()) + .unwrap_or(CSharpIndexStatus::None); + if matches!(status, CSharpIndexStatus::None) { + status = CSharpIndexStatus::Ready; + } + self.csharp_index_status.insert(alias.to_string(), status); } - self.csharp_index_status.insert(alias.to_string(), status); + info!("phase-2: skip '{}' ({}) — {:?}", alias, lang, decision); + continue; } - info!("phase-2: skip '{}' — {:?}", alias, decision); - continue; + let last_changed = self + .config + .read() + .ok() + .and_then(|c| c.meta(alias).last_changed_unix) + .unwrap_or(0); + info!( + "phase-2: queued '{}' ({}) — {:?} (last_changed={})", + alias, lang, decision, last_changed + ); + candidates.push((alias.clone(), lang.clone(), last_changed)); } - let last_changed = self - .config - .read() - .ok() - .and_then(|c| c.meta(alias).last_changed_unix) - .unwrap_or(0); - info!( - "phase-2: queued '{}' — {:?} (last_changed={})", - alias, decision, last_changed - ); - candidates.push((alias.clone(), last_changed)); } - candidates.sort_by_key(|b| std::cmp::Reverse(b.1)); + candidates.sort_by_key(|c| std::cmp::Reverse(c.2)); if candidates.is_empty() { info!("phase-2 complete: 0 candidates"); return; } - // Pre-mark all queued candidates as C# Indexing so the TUI C# indicator + // Pre-mark queued C# candidates as Indexing so the TUI C# indicator // reflects pending rebuilds immediately, even before each repo acquires // its semaphore slot. trigger_symbol_rebuild will overwrite this with the // same value (no-op) and eventually with Ready or Error on completion. - for (alias, _) in &candidates { - self.csharp_index_status - .insert(alias.clone(), CSharpIndexStatus::Indexing); + for (alias, lang, _) in &candidates { + if lang.as_str() == LANG_CSHARP { + self.csharp_index_status + .insert(alias.clone(), CSharpIndexStatus::Indexing); + } } let concurrency = Self::csharp_scip_concurrency(); @@ -1497,18 +1913,26 @@ impl ServeState { let sem = Arc::new(Semaphore::new(concurrency)); let mut handles = Vec::with_capacity(candidates.len()); - for (alias, _) in candidates { + for (alias, lang, _) in candidates { let sem = sem.clone(); let state = self.clone(); handles.push(tokio::spawn(async move { let permit = match sem.acquire_owned().await { Ok(p) => p, - Err(_) => return, + Err(_) => { + if lang.as_str() == LANG_CSHARP { + state.csharp_index_status.remove(&alias); + } + return; + } }; - info!("phase-2: starting '{}'", alias); + info!("phase-2: starting '{}' ({})", alias, lang); let path = match state.config.read().ok().and_then(|c| c.resolve(&alias)) { Some(p) => p, None => { + if lang.as_str() == LANG_CSHARP { + state.csharp_index_status.remove(&alias); + } drop(permit); return; } @@ -1522,11 +1946,16 @@ impl ServeState { alias, path.display() ); + // Skip paths drop the queue pre-mark: no rebuild will + // start, so the row must not keep showing indexing. + if lang.as_str() == LANG_CSHARP { + state.csharp_index_status.remove(&alias); + } drop(permit); return; } let db_path = path.join(DB_DIR_NAME); - trigger_symbol_rebuild(&alias, &path, &db_path, &state).await; + trigger_symbol_rebuild(&alias, &path, &db_path, &state, &lang).await; drop(permit); })); } @@ -1676,9 +2105,12 @@ impl ServeState { // Restore Ready status regardless of pre-warm outcome: the SCIP // definitions index (built in Phase 2) remains valid even if // ref-cache pre-warm fails. TUI returns to "C#·" (ready). - state - .csharp_index_status - .insert(alias_owned, CSharpIndexStatus::Ready); + // Not while a build runs: it sets the final status itself. + if !state.is_indexing(&alias_owned) { + state + .csharp_index_status + .insert(alias_owned, CSharpIndexStatus::Ready); + } })); } @@ -1798,6 +2230,21 @@ impl ServeState { /// This is the shared logic used by both the HTTP `DELETE /repos/{alias}` handler /// and the TUI confirmation flow. pub(crate) async fn remove_repo(&self, alias: &str) -> Result { + self.remove_repo_with_budget( + alias, + std::time::Duration::from_secs(crate::constants::BG_TASK_COOPERATIVE_TIMEOUT_SECS), + ) + .await + } + + /// [`Self::remove_repo`] with an injectable cooperative budget for the + /// index-task wait (tests use a short one; production passes + /// `BG_TASK_COOPERATIVE_TIMEOUT_SECS`). + pub(crate) async fn remove_repo_with_budget( + &self, + alias: &str, + index_task_budget: Duration, + ) -> Result { // 1. Resolve project path from config let project_path = { let config = self @@ -1831,9 +2278,15 @@ impl ServeState { // above cancelled a token nobody listened to, this await found nothing // to wait on, and the embed pass kept running (writing chunks, holding // the LMDB mmap open) long after remove_repo reported success. - // await_index_task cancels the task's OWN token and awaits its exit, so - // its Arc drops before the DB delete below. - self.await_index_task(alias).await; + // await_index_task cancels the task's OWN token and waits for its + // exit, so its Arc drops before the DB delete below. It + // returns false when the task could not be joined within the + // cooperative budget (e.g. parked in an uninterruptible build): the DB + // delete is then DEFERRED instead of pulling the directory out from + // under the live build. + let index_task_exited = self + .await_index_task_with_budget(alias, index_task_budget) + .await; // 3. Unregister from repos.json { @@ -1872,7 +2325,24 @@ impl ServeState { // report honestly. let mut db_deleted = !db_path.exists(); let mut db_delete_error: Option = None; - if db_path.exists() { + if db_path.exists() && !index_task_exited { + // The index task is still alive (typically parked in the + // uninterruptible `build_index`). Deleting the directory out from + // under it can wedge a serve process: the task's + // mmapped LMDB/arroy/Tantivy files vanished mid-build, it never + // reached a cancellation point, and it then held its + // `Arc` plus the process-wide job permit for the + // process lifetime. Defer instead: the task's post-build guard + // (`self_clean_if_unregistered`) deletes the dir once it observes + // the removal, and [`Self::sweep_index_tasks`] retries if a panic + // skips that path. + tracing::warn!( + "Database dir for '{}' left in place: its index task is still running \ + (cleanup deferred to the task's post-build guard / sweeper)", + alias + ); + db_delete_error = Some("index task still running; DB cleanup deferred".to_string()); + } else if db_path.exists() { // Deadline-bounded exponential-backoff retry. We ONLY retry on // lock-class errors (sharing/lock violation or access-denied on // Windows, or a message hinting the dir is in use) — a genuine @@ -2102,58 +2572,85 @@ impl ServeState { } } - /// Cancel and await the background *indexing* task for `alias` - /// (`add_repo`/`reindex` embed pass), if one is registered in + /// Cancel and wait (bounded) for the background *indexing* task for + /// `alias` (`add_repo`/`reindex` embed pass), if one is registered in /// [`Self::index_tasks`]. /// - /// Cancels the task's token first (so an in-flight embed pass aborts at the - /// next batch/phase boundary), then awaits its `JoinHandle` with a 5s - /// timeout. The await is what guarantees the task's `Arc` — - /// and the LMDB mmap handles it keeps alive on Windows — have actually - /// dropped before `remove_repo` deletes the DB directory. Without this, - /// `remove_repo` would delete `repos.json` while the detached task kept - /// writing chunks into a soon-to-be-orphaned `.codesearch.db`. - async fn await_index_task(&self, alias: &str) { - if let Some((_, (handle, token))) = self.index_tasks.remove(alias) { - token.cancel(); - // Bounded cooperative join. We deliberately do NOT abort the task - // on timeout. An indexing task can be parked inside `build_index`'s - // synchronous arroy HNSW build, which runs on a `spawn_blocking` - // thread and has no cancellation point Tokio can interrupt. - // Aborting the OUTER `JoinHandle` would only detach that blocking - // task (it keeps its own `Arc>` clone, so the - // LMDB mmap stays open regardless) AND drop the post-build - // continuation — including the self-cleanup that deletes the - // orphaned `.codesearch.db` dir once the build finishes. So on - // timeout we detach the outer task ON PURPOSE: its post-build guard - // (`remove_orphaned_db_dir`) releases the handles and self-cleans - // the directory. The deadline-bounded delete retry in `remove_repo` - // covers builds that finish within its budget; a serve restart reaps - // anything left over. - match tokio::time::timeout( - std::time::Duration::from_secs(crate::constants::BG_TASK_COOPERATIVE_TIMEOUT_SECS), - handle, - ) - .await - { - Ok(Ok(())) => { - tracing::debug!("Index task for '{}' exited cleanly", alias); - } - Ok(Err(join_err)) => { - tracing::warn!( - "Index task for '{}' panicked during shutdown: {}", - alias, - join_err - ); - } - Err(_) => { - tracing::warn!( - "Index task for '{}' still in an uninterruptible build_index after {}s; \ - detaching — its post-build guard will self-clean the DB dir", - alias, - crate::constants::BG_TASK_COOPERATIVE_TIMEOUT_SECS, - ); - } + /// Cancels the task's token first (so an in-flight embed pass aborts at + /// the next batch/phase boundary), then waits up to the cooperative + /// budget for its exit. Returns `true` when the task exited within the + /// budget, `false` when it is still running (typically parked inside the + /// uninterruptible `build_index`). + /// + /// The entry is never lost: on timeout the still-pending handle goes back + /// into [`Self::index_tasks`]. The old code removed the entry before + /// waiting and dropped the handle on timeout, so a detached task held its + /// `Arc` (and the process-wide job permit) invisibly for the + /// process lifetime — the leak class this tracking exists to prevent. Keeping + /// the handle tracked lets [`Self::sweep_index_tasks`] reap it and clean + /// up a removed repo's DB directory once it finally exits. + async fn await_index_task(&self, alias: &str) -> bool { + self.await_index_task_with_budget( + alias, + std::time::Duration::from_secs(crate::constants::BG_TASK_COOPERATIVE_TIMEOUT_SECS), + ) + .await + } + + /// [`Self::await_index_task`] with an injectable budget (tests use a short + /// one; production passes `BG_TASK_COOPERATIVE_TIMEOUT_SECS`). + async fn await_index_task_with_budget(&self, alias: &str, budget: Duration) -> bool { + let Some((_, task)) = self.index_tasks.remove(alias) else { + return true; + }; + task.token.cancel(); + let IndexTask { + mut handle, + token, + db_path, + started_at, + } = task; + // Bounded cooperative wait; never abort. An indexing task can be + // parked inside `build_index`'s synchronous arroy HNSW build, which + // runs on a `spawn_blocking` thread and has no cancellation point + // Tokio can interrupt. Aborting the OUTER `JoinHandle` would only + // detach that blocking task (it keeps its own + // `Arc>` clone, so the LMDB mmap stays open + // regardless) AND drop the post-build continuation — including the + // self-cleanup that deletes the orphaned `.codesearch.db` dir once the + // build finishes. + match tokio::time::timeout(budget, &mut handle).await { + Ok(Ok(())) => { + tracing::debug!("Index task for '{}' exited cleanly", alias); + true + } + Ok(Err(join_err)) => { + tracing::warn!( + "Index task for '{}' panicked during shutdown: {}", + alias, + join_err + ); + true + } + Err(_) => { + tracing::warn!( + "Index task for '{}' did not exit within {}s; keeping it tracked — the \ + stale-task sweeper will reap it and clean up its DB dir once it exits", + alias, + budget.as_secs() + ); + // `timeout(&mut handle)` leaves the handle owned; put it back + // so the task can never become invisible. + self.index_tasks.insert( + alias.to_string(), + IndexTask { + handle, + token, + db_path, + started_at, + }, + ); + false } } } @@ -2262,8 +2759,8 @@ impl ServeState { .unwrap_or(true); if registered { tracing::info!( - "Task for '{}' was cancelled but the repo is still registered — keeping its DB \ - dir (handles released)", + "Index task for '{}' ended but the repo is still registered — keeping its DB \ + dir", alias ); return; @@ -2510,6 +3007,9 @@ impl ServeState { } }; if let Some(total_chunks) = needs_build { + // HNSW construction is one of the heaviest single operations a repo + // can do; draw the process-wide job permit around it. + let _job_permit = stores.acquire_job_permit().await; info!( "Warmup '{}': building vector index ({} existing chunks)", alias, total_chunks @@ -2577,14 +3077,25 @@ impl ServeState { let alias_hb = alias.to_string(); Arc::new(move || state.renew_indexing(&alias_hb, IndexingOwner::Warmup)) }; - let refreshed = IndexManager::perform_incremental_refresh_with_stores( - &path, - &db_path, - &stores, - &CancellationToken::new(), - Some(&pool), - Some(&heartbeat), - ) + // Same transient-FTS redrive as the add/reindex paths: the warmup + // commit is just as exposed to the AV/Search-Indexer lock race, and + // a warmup failure without a retry leaves the repo re-embedded but + // uncommitted (field incident: a warmup refresh, 15 Oct 2026). + const FTS_TRANSIENT_BACKOFFS: [std::time::Duration; 2] = [ + std::time::Duration::from_secs(5), + std::time::Duration::from_secs(20), + ]; + let refreshed = IndexManager::retry_on_transient_fts(&FTS_TRANSIENT_BACKOFFS, || async { + IndexManager::perform_incremental_refresh_with_stores( + &path, + &db_path, + &stores, + &CancellationToken::new(), + Some(&pool), + Some(&heartbeat), + ) + .await + }) .await; self.end_indexing(alias, IndexingOwner::Warmup); if let Err(e) = refreshed { @@ -2704,6 +3215,8 @@ impl ServeState { // "Index not built" until the background refresh completes. // build_index() is CPU-heavy — offload to the blocking pool so the async // runtime is not stalled while building the HNSW index for large repos. + // The open itself is part of a heavy job: hold a process-wide permit. + let _job_permit = stores.acquire_job_permit().await; { let vector_store = Arc::clone(&stores.vector_store); let alias_owned = alias.to_string(); @@ -2983,7 +3496,7 @@ impl ServeState { return match SharedStores::new_readonly(db_path, dims) { Ok(s) => { info!("Opened repo in readonly mode (forced by config): {}", alias); - let stores_arc = Arc::new(s); + let stores_arc = Arc::new(s.with_job_gate(Arc::clone(&self.job_gate))); self.repos.insert( alias.to_string(), RepoState::Readonly { @@ -3003,7 +3516,9 @@ impl ServeState { match SharedStores::new(db_path, dims) { Ok(s) => { info!("Opened repo in write mode: {}", alias); - Ok(OpenedStores::Write(Arc::new(s))) + Ok(OpenedStores::Write(Arc::new( + s.with_job_gate(Arc::clone(&self.job_gate)), + ))) } Err(write_err) => { if allow_create { @@ -3015,7 +3530,7 @@ impl ServeState { match SharedStores::new_readonly(db_path, dims) { Ok(s) => { info!("Opened repo in readonly mode: {}", alias); - let stores_arc = Arc::new(s); + let stores_arc = Arc::new(s.with_job_gate(Arc::clone(&self.job_gate))); self.repos.insert( alias.to_string(), RepoState::Readonly { @@ -3227,6 +3742,62 @@ impl ServeState { self.active_sessions.load(Ordering::Relaxed) } + /// Durable symbol-index warnings for the info surfaces: read fresh from + /// the on-disk meta of every symbol language, language-prefixed. + /// Deliberately NOT filtered by installed languages — reading meta needs + /// no helper, and a helper that vanished after a degraded rebuild must + /// not hide the record. Unlike the in-memory C# status this survives a + /// serve restart. + pub(crate) fn collect_symbol_warnings(&self, db_path: &Path) -> Vec { + let mut warnings: Vec = Vec::new(); + for lang in [LANG_CSHARP, LANG_TYPESCRIPT] { + if let Some(indexer) = self.symbol_registry.get(lang) { + let lang_warnings = indexer.index_warnings(db_path); + if !lang_warnings.is_empty() { + warnings.extend( + lang_warnings + .into_iter() + .map(|w| format!("[{}] {w}", indexer.language())), + ); + } + } + } + warnings + } + + /// Per-language symbol-index status for the info surfaces — the same + /// shared collector find_impact answers carry, so the TUI, REST and MCP + /// surfaces cannot disagree about what "ready" means. Needs the project + /// path (applicability) next to the db path. + pub(crate) fn collect_symbol_index_status( + &self, + project_path: &Path, + db_path: &Path, + ) -> Vec { + crate::symbols::symbol_index_status(&self.symbol_registry, project_path, db_path) + } + + /// Record a failed first build for a newly added repo: log the error + /// with the heal command and release the Reindex marker. Deliberately + /// does NOT unregister — a vanished repo (the old rollback) is + /// unfixable by the operator who cannot even see it; a registered one + /// heals via reindex. + pub(crate) fn note_add_index_failure( + &self, + alias: &str, + project_path: &Path, + error: &anyhow::Error, + ) { + tracing::error!( + "Index creation failed for '{}' ({}): {error:#} — the repo stays \ + registered with a partial index; reindex it to heal: \ + `codesearch index reindex {alias}` (or POST /repos/{alias}/reindex)", + alias, + project_path.display() + ); + self.end_indexing(alias, IndexingOwner::Reindex); + } + /// Get lightweight repo statuses WITHOUT opening any databases. /// Returns a list of (alias, status_info) where status is derived from DashMap state only. pub(crate) fn repo_statuses_lightweight(&self) -> Vec<(String, RepoStatusInfo)> { @@ -3240,25 +3811,14 @@ impl ServeState { let db_path = path.join(DB_DIR_NAME); let db_exists = db_path.exists(); - let label = if self.is_indexing(alias) { - RepoStateLabel::Indexing - } else { - match self.repos.get(alias) { - Some(entry) => match entry.value() { - RepoState::Write { .. } => RepoStateLabel::Open, - RepoState::Warm { .. } => RepoStateLabel::Warm, - RepoState::Readonly { .. } => RepoStateLabel::Readonly, - RepoState::Conflicted => RepoStateLabel::Error, - }, - None => { - if !db_exists { - RepoStateLabel::NoIndex - } else { - RepoStateLabel::Idle - } - } - } - }; + // Evict stale markers first (side effect the owner-scoped reads + // below rely on); the any-owner boolean itself is no longer the + // label key. + self.is_indexing(alias); + // Owner-scoped: only text-indexing flows light the general + // "Indexing" label; symbol rebuilds own the language columns. + let text_indexing = self.has_text_indexing_marker(alias); + let symbol_indexing = self.has_symbol_indexing_marker(alias); let changes = match self.repos.get(alias) { Some(entry) => match entry.value() { @@ -3288,26 +3848,36 @@ impl ServeState { .map(|c| c.load(Ordering::Relaxed)) .unwrap_or(0); - // C# index status: check cached value first, then probe - let csharp_index = self - .csharp_index_status - .get(alias) - .map(|e| *e.value()) - .unwrap_or_else(|| { - // Probe: helper available + index exists → Ready - let registry = &self.symbol_registry; - let has_helper = registry + // The repo-level indexing flag only shows as a language's `Indexing` + // where that language applies; elsewhere (e.g. a Rust-only repo) the + // symbol column keeps its normal None/probe result. A cached status + // exists only for repos where a rebuild ran, so it also counts. + let cached_csharp = self.csharp_index_status.get(alias).map(|e| *e.value()); + let csharp_building = symbol_indexing + && (cached_csharp.is_some() + || self + .symbol_registry .get(LANG_CSHARP) - .map(|i| i.is_available()) - .unwrap_or(false); - if has_helper && registry.has_index_for(LANG_CSHARP, &db_path) { - CSharpIndexStatus::Ready - } else { - CSharpIndexStatus::None - } - }); + .map(|i| i.applies_to(path)) + .unwrap_or(false)); + let csharp_index = resolve_csharp_status(cached_csharp, csharp_building, || { + // Probe: helper available + index exists → Ready + let registry = &self.symbol_registry; + let has_helper = registry + .get(LANG_CSHARP) + .map(|i| i.is_available()) + .unwrap_or(false); + if has_helper && registry.has_index_for(LANG_CSHARP, &db_path) { + CSharpIndexStatus::Ready + } else { + CSharpIndexStatus::None + } + }); - let csharp_error = if matches!(csharp_index, CSharpIndexStatus::Error) { + let csharp_error = if matches!( + csharp_index, + CSharpIndexStatus::Error | CSharpIndexStatus::Partial + ) { self.csharp_index_error .get(alias) .map(|e: dashmap::mapref::one::Ref| e.value().clone()) @@ -3321,7 +3891,14 @@ impl ServeState { // exists → Ready; otherwise None. The TUI icon reflects "an index // exists", which is exactly what matters for discoverability. let registry = &self.symbol_registry; - let typescript_index = { + let ts_building = symbol_indexing + && registry + .get(LANG_TYPESCRIPT) + .map(|i| i.applies_to(path) && i.is_available()) + .unwrap_or(false); + let typescript_index = if ts_building { + CSharpIndexStatus::Indexing + } else { let has_ts_helper = registry .get(LANG_TYPESCRIPT) .map(|i| i.is_available()) @@ -3333,6 +3910,32 @@ impl ServeState { } }; + // Only TEXT-indexing flows light the general label. A queued or + // running symbol rebuild (phase-2 pre-mark, watcher SCIP pass) + // shows in the C#/TS columns only — a pure SCIP pass never made + // the text index busy, and "Indexing" there read as "the normal + // index is stuck". Both owner reads run after is_indexing's + // stale eviction. + let label = if text_indexing { + RepoStateLabel::Indexing + } else { + match self.repos.get(alias) { + Some(entry) => match entry.value() { + RepoState::Write { .. } => RepoStateLabel::Open, + RepoState::Warm { .. } => RepoStateLabel::Warm, + RepoState::Readonly { .. } => RepoStateLabel::Readonly, + RepoState::Conflicted => RepoStateLabel::Error, + }, + None => { + if !db_exists { + RepoStateLabel::NoIndex + } else { + RepoStateLabel::Idle + } + } + } + }; + result.push(( alias.clone(), RepoStatusInfo { @@ -3506,16 +4109,17 @@ impl ServeState { /// closed. Naming the holders turns a two-day silent failure into one /// warning line. /// - /// Gated on a still-running index task: the reaper only evicts repos that - /// are not indexing, so a live task here means its marker was already - /// evicted as stale — the leak signature. Without that gate the warning - /// would fire on every eviction, because a just-cancelled FSW drains - /// asynchronously and still holds the env for a moment. + /// Gated on a still-running index task: the idle reaper evicts repos only + /// when they are not indexing, so a live task at eviction time means its + /// marker is missing or was dropped by another flow (e.g. a stale + /// non-Reindex marker) — the leak/teardown signature. Without that gate + /// the warning would fire on every eviction, because a just-cancelled FSW + /// drains asynchronously and still holds the env for a moment. fn warn_if_still_held(&self, alias: &str) { let leaked_task = self .index_tasks .get(alias) - .is_some_and(|entry| !entry.value().0.is_finished()); + .is_some_and(|entry| !entry.value().handle.is_finished()); if !leaked_task { return; } @@ -3537,25 +4141,30 @@ impl ServeState { /// /// Closes DB handles, stops FSW, and releases memory. The repo will be /// automatically re-opened (and re-warmed) on the next query. - /// Active reindexes are never evicted. + /// Active reindexes are never evicted, and their idle clock restarts on + /// every sweep they are seen indexing. pub(crate) fn evict_idle_repos(&self) { let timeout = self.idle_timeout(); let now = std::time::Instant::now(); - // Collect aliases to evict (can't mutate DashMap while iterating) - let to_evict: Vec = self + // Snapshot first: refreshing `last_access` below must not run while the + // map is being iterated (an insert on a read-locked shard deadlocks). + let snapshot: Vec<(String, Instant)> = self .last_access .iter() - .filter(|entry| { - let alias = entry.key(); - // Don't evict repos that are being reindexed - if self.is_indexing(alias) { - return false; - } - now.duration_since(*entry.value()) >= timeout - }) - .map(|entry| entry.key().clone()) + .map(|entry| (entry.key().clone(), *entry.value())) .collect(); + let mut to_evict: Vec = Vec::new(); + for (alias, last) in &snapshot { + if self.is_indexing(alias) { + // Never evict a repo mid-build, and restart its idle clock: a + // build longer than the timeout would otherwise leave the repo + // "idle" the instant it finishes and evict it on the next sweep. + self.touch_access(alias); + } else if now.duration_since(*last) >= timeout { + to_evict.push(alias.clone()); + } + } // Log reaper status even when nothing to evict (for debugging idle eviction) if !self.last_access.is_empty() { @@ -3766,12 +4375,14 @@ async fn status_handler( let csharp_str = match info.csharp_index { CSharpIndexStatus::None => "none", CSharpIndexStatus::Ready => "ready", + CSharpIndexStatus::Partial => "partial", CSharpIndexStatus::Error => "error", CSharpIndexStatus::Indexing => "indexing", }; let ts_str = match info.typescript_index { CSharpIndexStatus::None => "none", CSharpIndexStatus::Ready => "ready", + CSharpIndexStatus::Partial => "partial", CSharpIndexStatus::Error => "error", CSharpIndexStatus::Indexing => "indexing", }; @@ -3995,6 +4606,14 @@ async fn info_handler( let db_size_human = tui::dir_size_human(&db_path); + // Durable symbol-index warnings, read fresh from the on-disk meta + // (shared with the TUI info overlay so the two cannot drift). + let symbol_warnings = state.collect_symbol_warnings(&db_path); + // Per-language symbol-index status — the same shared collector the TUI + // overlay and find_impact answers use, so a consumer can tell a working + // symbol index from an absent/stale/degraded one before trusting it. + let symbol_index = state.collect_symbol_index_status(&project_path, &db_path); + AxumJson(json!({ "path": db_path.display().to_string(), "chunks": chunks, @@ -4005,6 +4624,15 @@ async fn info_handler( "dims": dims, "lock": lock, "index_age": index_age, + // Durable record of a degraded symbol index (see the TUI's C#⚠): + // build-environment failures the helper survived during rebuild. + "symbol_warnings": symbol_warnings, + // Per-language symbol-index status (ready/degraded/stale/ + // restore-pending/absent/not-applicable): is there a usable SCIP + // index at all, and is it THIS build's? The chunk fields above say + // nothing about it — that gap made agents trust "0 references" + // from a repo with no symbol index. + "symbol_index": symbol_index, // Is the HNSW graph built and committed? A non-zero `chunks` with // `indexed: false` is a searchable-looking but silently dead index: // `VectorStore::search` refuses to run without the graph. The cloud @@ -4071,38 +4699,118 @@ async fn doctor_handler( AxumJson(json!({ "results": results })).into_response() } -/// Trigger a symbol index rebuild for a repo (C# etc.). +/// Holds `owner`'s indexing marker for `alias` and keeps it fresh until +/// dropped, however the run exits (success, error, panic, cancelled future). +/// +/// A flow with no per-batch progress hook (the SCIP rebuild is one opaque +/// blocking call) would otherwise age out at `MAX_INDEXING_SECS`, letting the +/// idle reaper evict the repo mid-build. +struct IndexingMarkerGuard { + state: Arc, + alias: String, + owner: IndexingOwner, + /// `Some` only when this guard acquired the marker; an inert guard (another + /// owner already holds the alias) neither renews nor ends anything. + heartbeat: Option>, +} + +impl IndexingMarkerGuard { + /// Must be called inside a tokio runtime (the heartbeat is a spawned task). + fn begin( + state: &Arc, + alias: &str, + owner: IndexingOwner, + heartbeat_every: Duration, + ) -> Self { + let heartbeat = state.begin_indexing(alias, owner).then(|| { + let state = Arc::clone(state); + let alias = alias.to_string(); + tokio::spawn(async move { + let start = tokio::time::Instant::now() + heartbeat_every; + let mut tick = tokio::time::interval_at(start, heartbeat_every); + loop { + tick.tick().await; + state.refresh_indexing_if_held(&alias, owner); + } + }) + }); + Self { + state: Arc::clone(state), + alias: alias.to_string(), + owner, + heartbeat, + } + } +} + +impl Drop for IndexingMarkerGuard { + fn drop(&mut self) { + if let Some(heartbeat) = self.heartbeat.take() { + heartbeat.abort(); + self.state.end_indexing(&self.alias, self.owner); + } + } +} + +/// Trigger a symbol index rebuild for a repo in one language (C#, TypeScript). /// -/// Reuses the shared `SymbolIndexerRegistry` from `ServeState`, looks up the C# indexer, -/// and runs `rebuild()` in a blocking task. Updates the C# index status on success/failure. +/// Reuses the shared `SymbolIndexerRegistry` from `ServeState`, looks up the +/// indexer for `lang`, and runs `rebuild()` in a blocking task. C#-only +/// bookkeeping (TUI status/error maps, `last_scip` timestamp) stays gated on +/// the language; `IndexingOwner::Symbol` markers apply to every language. +/// +/// A per-`(alias, language)` in-flight slot prevents two concurrent full +/// rebuilds from interleaving their LMDB clear/write passes (find_impact +/// self-heal racing phase-2/reindex/watcher). Languages for one alias run +/// sequentially at multi-language call sites (see `maybe_rebuild_symbols`) — +/// the `IndexingOwner::Symbol` marker is not language-scoped. async fn trigger_symbol_rebuild( alias: &str, project_path: &Path, db_path: &Path, state: &Arc, + lang: &str, ) { + let is_csharp = lang.eq_ignore_ascii_case(LANG_CSHARP); // Skip non-applicable repos BEFORE touching status — otherwise the TUI // would flip C#-indicator red on Rust/Python repos that simply have no - // .sln. The phase-2 gate (`evaluate_csharp_rebuild`) already filters + // .sln. The phase-2 gate (`evaluate_symbol_rebuild`) already filters // these out, but other callers (POST /reindex?symbols=true, - // .cs watcher debounce, future paths) bypass that gate. + // .cs watcher debounce, find_impact self-heal) bypass that gate. let applies = state .symbol_registry - .get(LANG_CSHARP) + .get(lang) .map(|i| i.applies_to(project_path)) .unwrap_or(false); if !applies { tracing::info!( - "🔬 symbol reindex skipped for '{}': not applicable (no .sln)", + "🔬 symbol reindex skipped for '{}': not applicable (no .sln / tsconfig.json)", alias ); + // A queued pre-mark (phase-2) can outlive its applicability window + // (e.g. the .sln vanished while the task waited for its slot): drop + // it — no rebuild will start here to overwrite it. + if is_csharp { + state.csharp_index_status.remove(alias); + } + return; + } + + if !state.begin_symbol_rebuild(alias, lang) { + tracing::info!( + "🔬 symbol reindex skipped for '{}' ({}): already in flight", + alias, + lang + ); return; } - tracing::info!("🔬 symbol reindex triggered for '{}'", alias); - state - .csharp_index_status - .insert(alias.to_string(), CSharpIndexStatus::Indexing); + tracing::info!("🔬 symbol reindex triggered for '{}' ({})", alias, lang); + if is_csharp { + state + .csharp_index_status + .insert(alias.to_string(), CSharpIndexStatus::Indexing); + } // Mark as actively indexing so the TUI status column shows "Indexing" // (not just the C# indicator). This mirrors what reindex_handler does. // @@ -4110,22 +4818,38 @@ async fn trigger_symbol_rebuild( // for the same alias simultaneously, each path ends only its own marker, // so neither can flip the TUI back to Warm/Open while the other still // runs. (Stale entries from a crashed task self-heal via `is_indexing`.) - state.begin_indexing(alias, IndexingOwner::Symbol); + // Nested callers (the reindex and add-repo background tasks) legitimately + // hold the alias's Reindex marker while triggering this; the guard is then + // inert and that marker covers the run. + let marker = IndexingMarkerGuard::begin( + state, + alias, + IndexingOwner::Symbol, + Duration::from_secs(INDEXING_MARKER_HEARTBEAT_SECS), + ); let rp = project_path.to_path_buf(); let dp = db_path.to_path_buf(); let alias_owned = alias.to_string(); + let lang_owned = lang.to_string(); let registry = state.symbol_registry.clone(); - match tokio::task::spawn_blocking(move || { - let Some(indexer) = registry.get(LANG_CSHARP) else { - return Err(anyhow::anyhow!("No C# symbol indexer registered")); + let rebuilt = tokio::task::spawn_blocking(move || { + let Some(indexer) = registry.get(&lang_owned) else { + return Err(anyhow::anyhow!( + "No symbol indexer registered for '{lang_owned}'" + )); }; if !indexer.is_available() { - return Err(anyhow::anyhow!("scip-csharp helper not available")); + return Err(anyhow::anyhow!( + "symbol helper for '{lang_owned}' not available" + )); } indexer.rebuild(&rp, &dp, RebuildScope::Full) }) - .await - { + .await; + // Released before the outcome handling: format recovery enqueued below + // reindexes through `begin_indexing`, which a live Symbol marker rejects. + drop(marker); + match rebuilt { Ok(Ok(summary)) => { tracing::info!( "✅ Symbol rebuild complete for '{}': {} symbols, {} refs in {}ms", @@ -4134,59 +4858,89 @@ async fn trigger_symbol_rebuild( summary.references_stored, summary.duration_ms ); - state.end_indexing(&alias_owned, IndexingOwner::Symbol); - state - .csharp_index_status - .insert(alias_owned.clone(), CSharpIndexStatus::Ready); - state.csharp_index_error.remove(&alias_owned); + if is_csharp { + let (status, detail) = csharp_success_outcome(&summary.index_warnings); + state + .csharp_index_status + .insert(alias_owned.clone(), status); + if let Some(detail) = detail { + state.csharp_index_error.insert(alias_owned.clone(), detail); + } else { + state.csharp_index_error.remove(&alias_owned); + } - if let Ok(mut cfg) = state.config.write() { - cfg.touch_last_scip(&alias_owned, ServeState::now_unix_secs()); + if let Ok(mut cfg) = state.config.write() { + cfg.touch_last_scip(&alias_owned, ServeState::now_unix_secs()); + } + state.schedule_persist_repos_config(); } - state.schedule_persist_repos_config(); } Ok(Err(e)) => { // `{:#}` — the whole chain, not just the outermost context. The // SCIP puts wrap their errors (table + key size), and plain `{}` // would hide the `MDB_*` code the classifier below matches on. let msg = format!("{e:#}"); - state.end_indexing(&alias_owned, IndexingOwner::Symbol); - state - .csharp_index_error - .insert(alias_owned.clone(), msg.clone()); - if ServeState::is_lmdb_format_corruption(&msg) - && state.enqueue_format_recovery(&alias_owned) - { - tracing::warn!( - "⚠️ LMDB storage-format corruption for '{}' — queueing sequential wipe + \ - full rebuild. Raw error: {}", - alias_owned, - msg - ); - // Recovery owns the outcome from here: show in-progress rather - // than Error; it flips to Ready on success or Error on failure. - state - .csharp_index_status - .insert(alias_owned, CSharpIndexStatus::Indexing); - } else if ServeState::is_lmdb_format_corruption(&msg) { - // A wipe already happened for this alias in this process, so the - // data was written by the running binary: the error is write-side - // (LMDB rejects an empty or >511-byte key), not an old format. - // Wiping again would only restart a multi-hour reindex loop. - tracing::error!( - "❌ Symbol rebuild for '{}' hit an LMDB key/value-size error AFTER a format \ - wipe — refusing a second wipe, this is a bug in the writer: {}", - alias_owned, - msg - ); - state - .csharp_index_status - .insert(alias_owned, CSharpIndexStatus::Error); - } else { - tracing::error!("❌ Symbol rebuild failed for '{}': {}", alias_owned, msg); + if is_csharp { state - .csharp_index_status - .insert(alias_owned, CSharpIndexStatus::Error); + .csharp_index_error + .insert(alias_owned.clone(), msg.clone()); + } + match classify_symbol_rebuild_failure(&msg, &e, is_csharp) { + SymbolRebuildFailureKind::RestoreExhausted => { + // Restore never finished within the retry cap: the previous + // index stays live — warning (yellow C#⚠ + detail), not a red + // Error, and no touch_last_scip: the index is stale, the next + // rebuild attempt must not be gated as fresh. + tracing::warn!( + "⚠️ Symbol rebuild abandoned for '{}': dotnet restore did not finish \ + within the retry cap — previous index stays live", + alias_owned + ); + state + .csharp_index_status + .insert(alias_owned, CSharpIndexStatus::Partial); + } + SymbolRebuildFailureKind::LmdbCorruption => { + if state.enqueue_format_recovery(&alias_owned) { + tracing::warn!( + "⚠️ LMDB storage-format corruption for '{}' — queueing sequential wipe + \ + full rebuild. Raw error: {}", + alias_owned, + msg + ); + // Recovery owns the outcome from here: show in-progress rather + // than Error; it flips to Ready on success or Error on failure. + if is_csharp { + state + .csharp_index_status + .insert(alias_owned, CSharpIndexStatus::Indexing); + } + } else { + // A wipe already happened for this alias in this process, so the + // data was written by the running binary: the error is write-side + // (LMDB rejects an empty or >511-byte key), not an old format. + // Wiping again would only restart a multi-hour reindex loop. + tracing::error!( + "❌ Symbol rebuild for '{}' hit an LMDB key/value-size error AFTER a format \ + wipe — refusing a second wipe, this is a bug in the writer: {}", + alias_owned, + msg + ); + if is_csharp { + state + .csharp_index_status + .insert(alias_owned, CSharpIndexStatus::Error); + } + } + } + SymbolRebuildFailureKind::Generic => { + tracing::error!("❌ Symbol rebuild failed for '{}': {}", alias_owned, msg); + if is_csharp { + state + .csharp_index_status + .insert(alias_owned, CSharpIndexStatus::Error); + } + } } } Err(e) => { @@ -4195,15 +4949,107 @@ async fn trigger_symbol_rebuild( alias_owned, e ); - state.end_indexing(&alias_owned, IndexingOwner::Symbol); - state - .csharp_index_error - .insert(alias_owned.clone(), format!("Task panicked: {}", e)); - state - .csharp_index_status - .insert(alias_owned, CSharpIndexStatus::Error); + if is_csharp { + state + .csharp_index_error + .insert(alias_owned.clone(), format!("Task panicked: {}", e)); + state + .csharp_index_status + .insert(alias_owned, CSharpIndexStatus::Error); + } } } + state.end_symbol_rebuild(alias, lang); +} + +/// Evaluate every installed symbol language for `alias` and rebuild the ones +/// whose gate says so. `force` (POST /reindex?symbols=true) bypasses the +/// gate, preserving the old unconditional-rebuild behaviour. +/// +/// Sequential per language: `IndexingOwner::Symbol` is not language-scoped, +/// so parallel languages would collide on the marker. Called from the +/// reindex and add-repo background tasks, where the alias already holds a +/// Reindex owner marker — `trigger_symbol_rebuild`'s own marker insert is +/// additive, not a guard, so nesting is safe. +async fn maybe_rebuild_symbols( + alias: &str, + project_path: &Path, + db_path: &Path, + state: &Arc, + force: bool, +) { + let langs = state.symbol_registry.installed_languages(); + for lang in langs { + let decision = if force { + RebuildDecision::ChangedSinceLastBuild + } else { + // evaluate may spawn a git subprocess — offload like phase-2. + let st = Arc::clone(state); + let a = alias.to_string(); + let l = lang.clone(); + let p = project_path.to_path_buf(); + let d = db_path.to_path_buf(); + match tokio::task::spawn_blocking(move || st.evaluate_symbol_rebuild(&l, &a, &p, &d)) + .await + { + Ok(d) => d, + Err(e) => { + warn!( + "symbol evaluate panicked for '{}' ({}): {:?}", + alias, lang, e + ); + continue; + } + } + }; + if decision.needs_rebuild() { + trigger_symbol_rebuild(alias, project_path, db_path, state, &lang).await; + } else { + info!("symbols fresh for '{}' ({}) — {:?}", alias, lang, decision); + } + } +} + +/// Fire-and-forget self-heal invoked by `find_impact` when the target index +/// does not exist: rebuild exactly that language's *missing* index — never on +/// drift (reindexing per query would thrash; see +/// `SymbolIndexer::index_head_sha`). The alias is re-resolved from the serve +/// config so remote-mounted projects (`peer/name`) are never healed locally. +pub(crate) async fn heal_missing_symbol_index(state: &Arc, alias: &str, lang: &str) { + let Some(path) = state.config.read().ok().and_then(|c| c.resolve(alias)) else { + return; + }; + if !path.exists() { + return; + } + let db_path = path.join(DB_DIR_NAME); + // evaluate may spawn a git subprocess (C# last_changed bootstrap) — + // offload so the heal task never blocks an async worker. + let st = Arc::clone(state); + let a = alias.to_string(); + let l = lang.to_string(); + let p = path.clone(); + let d = db_path.clone(); + let decision = + match tokio::task::spawn_blocking(move || st.evaluate_symbol_rebuild(&l, &a, &p, &d)).await + { + Ok(decision) => decision, + Err(e) => { + warn!( + "self-heal evaluate panicked for '{}' ({}): {:?}", + alias, lang, e + ); + return; + } + }; + if decision != RebuildDecision::NoIndex { + return; + } + info!( + "🔬 self-heal: '{}' has no {} symbol index — rebuilding in background (triggered by find_impact)", + alias, lang + ); + trigger_symbol_rebuild(alias, &path, &db_path, state, lang).await; } /// Reload repos config handler: POST /reload @@ -4334,6 +5180,8 @@ async fn reindex_handler( let guard_alias = alias_bg.clone(); let guard_state = state.clone(); + // `symbols=true` forces a symbol rebuild; without it the rebuild is + // gate-driven (missing/stale indexes are still healed). let do_symbols = symbols; if force { @@ -4400,6 +5248,9 @@ async fn reindex_handler( let g_alias = guard_alias.clone(); let g_state = guard_state.clone(); + // The task closure moves `db_path`; keep a copy for the tracked entry + // so a removed repo's DB dir can be cleaned up after the task exits. + let task_db_path = db_path.clone(); let handle = tokio::spawn(async move { tracing::info!( "Force reindex for '{}': clearing stores and reindexing", @@ -4459,16 +5310,21 @@ async fn reindex_handler( // 3. Restart FSW with fresh IndexManager. g_state.restart_fsw(&g_alias, stores).await; - // 4. Optional symbol index rebuild - if do_symbols { - trigger_symbol_rebuild(&alias_bg, &project_path, &db_path, &g_state).await; - } + // 4. Symbol index rebuild — gate-driven for every installed + // language; `symbols=true` forces it (previous behaviour). + maybe_rebuild_symbols(&alias_bg, &project_path, &db_path, &g_state, do_symbols).await; g_state.end_indexing(&g_alias, IndexingOwner::Reindex); }); - state - .index_tasks - .insert(alias.to_string(), (handle, reindex_token)); + state.index_tasks.insert( + alias.to_string(), + IndexTask { + handle, + token: reindex_token, + db_path: task_db_path, + started_at: Instant::now(), + }, + ); } else { // Incremental refresh: ensure the repo is opened, then refresh let stores = match state.get_or_open_stores(&alias, true).await { @@ -4492,6 +5348,9 @@ async fn reindex_handler( let g_alias = guard_alias.clone(); let g_state = guard_state.clone(); + // The task closure moves `db_path`; keep a copy for the tracked entry + // so a removed repo's DB dir can be cleaned up after the task exits. + let task_db_path = db_path.clone(); let handle = tokio::spawn(async move { tracing::info!( "🔄 Incremental reindex triggered for '{}' via HTTP API", @@ -4533,16 +5392,21 @@ async fn reindex_handler( return; } - // Optional symbol index rebuild - if do_symbols { - trigger_symbol_rebuild(&alias_bg, &project_path, &db_path, &g_state).await; - } + // Symbol index rebuild — gate-driven for every installed + // language; `symbols=true` forces it (previous behaviour). + maybe_rebuild_symbols(&alias_bg, &project_path, &db_path, &g_state, do_symbols).await; g_state.end_indexing(&g_alias, IndexingOwner::Reindex); }); - state - .index_tasks - .insert(alias.to_string(), (handle, reindex_token)); + state.index_tasks.insert( + alias.to_string(), + IndexTask { + handle, + token: reindex_token, + db_path: task_db_path, + started_at: Instant::now(), + }, + ); } ( @@ -4810,6 +5674,9 @@ async fn add_repo_handler( // indexing task, so cancelling it (stop_fsw) did nothing and the task ran // the full embed pass to completion on a removed alias. let token_for_task = cancel_token.clone(); + // The task closure moves `db_path`; keep a copy for the tracked entry so a + // removed repo's DB dir can be cleaned up after the task exits. + let task_db_path = db_path.clone(); let index_handle = tokio::spawn(async move { tracing::info!( @@ -4846,20 +5713,14 @@ async fn add_repo_handler( state_bg.end_indexing(&alias_bg, IndexingOwner::Reindex); return; } - tracing::error!("Index creation failed for '{}': {}", alias_bg, e); - // Clean up: remove from repos and config - state_bg.repos.remove(&alias_bg); - state_bg.end_indexing(&alias_bg, IndexingOwner::Reindex); - if let Ok(mut config) = state_bg.config.write() { - config.unregister_alias(&alias_bg); - if let Err(e) = state_bg.persist_config(&config) { - tracing::warn!( - "Failed to persist config after add-repo index failure for '{}': {}", - alias_bg, - e - ); - } - } + // KEEP the repo registered on a failed first build. The old + // rollback (repos.remove + unregister + persist_config) + // turned one build crash into a vanishing repo: the 202 was + // the caller's last word, repos.json lost the entry, and + // self-cleanup then deleted the DB dir. A half-built store + // heals on the next reindex (it clears and rebuilds + // in-place), so the failure must be loud, not destructive. + state_bg.note_add_index_failure(&alias_bg, &project_path, &e); return; } } @@ -4878,7 +5739,23 @@ async fn add_repo_handler( } // Build vector index from freshly indexed data. - // build_index() is CPU-heavy — offload to the blocking pool. + // build_index() is CPU-heavy — offload to the blocking pool, under the + // same process-wide job permit as every other heavy pass. The wait is + // cancellation-aware: a repo removed while queued behind another build + // must not keep its stores (and a queue position) parked. + let _job_permit = match stores.acquire_job_permit_or_cancel(&token_for_task).await { + JobAcquire::Ready(permit) => permit, + JobAcquire::Cancelled => { + state_bg.end_indexing(&alias_bg, IndexingOwner::Reindex); + return; + } + }; + // Re-check liveness after the wait: a removal that landed while the + // task was parked must not resurrect the alias's vector index. + if !state_bg.is_alias_live(&alias_bg, &token_for_task) { + state_bg.end_indexing(&alias_bg, IndexingOwner::Reindex); + return; + } { let vector_store = Arc::clone(&stores.vector_store); let alias_bi = alias_bg.clone(); @@ -4921,16 +5798,28 @@ async fn add_repo_handler( // Start FSW and transition to proper Write state with IndexManager state_bg.restart_fsw(&alias_bg, stores).await; + // Phase-2 equivalence for runtime adds: a repo registered while serve + // runs never sees the startup symbol pass, so its symbol indexes would + // not exist until a restart — build them now (gate-driven). + maybe_rebuild_symbols(&alias_bg, &project_path, &db_path, &state_bg, false).await; + state_bg.end_indexing(&alias_bg, IndexingOwner::Reindex); tracing::info!("Repo '{}' fully indexed and ready", alias_bg); }); // Register the indexing task so remove_repo can cancel + await it (BUG1). // Storing the token alongside the handle means remove_repo can cancel - // regardless of the repo's RepoState variant. - state - .index_tasks - .insert(alias.clone(), (index_handle, cancel_token)); + // regardless of the repo's RepoState variant. The DB path travels with + // the entry for deferred cleanup if the repo is removed mid-index. + state.index_tasks.insert( + alias.clone(), + IndexTask { + handle: index_handle, + token: cancel_token, + db_path: task_db_path, + started_at: Instant::now(), + }, + ); ( StatusCode::ACCEPTED, @@ -5098,18 +5987,18 @@ fn validate_path_within_allowed_roots(canonical_path: &Path) -> std::result::Res /// Constant-time API key comparison. /// -/// Hashes both the supplied candidate and the configured key with SHA-256 and -/// compares the fixed-length 32-byte digests byte-for-byte without early exit. -/// Because the digests are always the same length and SHA-256 is -/// preimage-resistant, the comparison time does not depend on how many leading -/// bytes of the candidate match the secret — closing the timing side-channel -/// that a raw `==` on the key strings would open on the network-exposed path. +/// Folds the length difference and every byte XOR into one accumulator and +/// returns whether it stayed zero, so the comparison never early-exits on how +/// many leading bytes of the candidate match the secret — closing the timing +/// side-channel that a raw `==` on the key strings would open on the +/// network-exposed path. No hash is involved: hashing adds nothing to an +/// equality comparison (and flagging a credential as hashed with a general +/// digest is a false positive, not a real weakness). fn api_key_matches(candidate: &str, configured: &str) -> bool { - use sha2::{Digest, Sha256}; - let candidate_digest = Sha256::digest(candidate.as_bytes()); - let configured_digest = Sha256::digest(configured.as_bytes()); - let mut diff: u8 = 0; - for (a, b) in candidate_digest.iter().zip(configured_digest.iter()) { + let candidate = candidate.as_bytes(); + let configured = configured.as_bytes(); + let mut diff: u8 = u8::from(candidate.len() != configured.len()); + for (a, b) in candidate.iter().zip(configured.iter()) { diff |= a ^ b; } diff == 0 @@ -5694,6 +6583,22 @@ pub async fn run_serve( // — it never polls a federated peer on a timer at all. let serve_state = Arc::new(ServeState::new(config, None).with_default_model(default_model)); + // One line that answers "why is it slower / less parallel than before?" + // without grepping the code: the effective heavy-work budget. + info!( + "⚙️ Indexing limits: index_jobs={} (CODESEARCH_INDEX_JOBS), embed_threads={} \ + (CODESEARCH_EMBED_THREADS), embed_pause_ms={} (CODESEARCH_EMBED_PAUSE_MS), \ + min_free_mb={} (CODESEARCH_MIN_FREE_MB), max_chunks_per_batch={} \ + (CODESEARCH_MAX_CHUNKS_PER_BATCH)", + serve_state.job_gate.index_jobs(), + crate::limits::embed_threads() + .map(|n| n.to_string()) + .unwrap_or_else(|| "default".to_string()), + crate::limits::embed_pause().as_millis(), + crate::limits::min_free_mb(), + crate::limits::max_chunks_per_batch(), + ); + // Construct the bind address from resolved host + port. // Using `format!` with `parse::()` handles both IPv4 and IPv6. // For IPv6 literals, users should pass e.g. `[::1]` (with brackets). @@ -5884,7 +6789,7 @@ pub async fn run_serve( // ── Startup phase orchestration ── // Phase 1 warms all repos sequentially (text/vector ready). - // Phase 2 runs gated C# SCIP rebuilds ordered by last_changed. + // Phase 2 runs gated per-language SCIP rebuilds ordered by last_changed. { let phase_state = serve_state.clone(); tokio::spawn(async move { @@ -5901,7 +6806,7 @@ pub async fn run_serve( warn!("reconcile: spawn_blocking panicked: {:?}", e); } phase_state.run_phase_1_warmup_all().await; - phase_state.run_phase_2_csharp_scip().await; + phase_state.run_phase_2_symbols().await; phase_state.run_phase_3_prewarm().await; }); } @@ -5918,6 +6823,7 @@ pub async fn run_serve( tokio::select! { _ = tokio::time::sleep(interval) => { reaper_state.evict_idle_repos(); + reaper_state.sweep_index_tasks(); // Dashboard refresh handled by TUI auto-refresh (TTY) or not needed (non-TTY) } _ = reaper_cancel.cancelled() => { @@ -6083,6 +6989,13 @@ pub async fn run_serve( } } + // Kill in-flight helper children (one-shot rebuilds + resident + // workspaces): an orphaned scip-csharp holds the helper exe locked for + // minutes after 'q' — the deploy blocker — and keeps computing for a + // dead host. + csharp::kill_live_helper_children(); + crate::symbols::resident::WORKSPACE_POOL.kill_all(); + // Wait for the TUI task to finish cleanup (restore terminal). // The TUI's Drop guard restores the terminal, so we need to give it // a moment before the process exits. diff --git a/src/serve/tests.rs b/src/serve/tests.rs index 1e71a301..f0786096 100644 --- a/src/serve/tests.rs +++ b/src/serve/tests.rs @@ -2,13 +2,40 @@ use super::*; use serial_test::serial; use std::io::Write; +#[tokio::test] +async fn try_open_stores_attaches_the_serve_job_gate() { + // Serve-opened stores must carry the same process-wide gate as the + // ServeState, so cold opens, warmup and FSW refreshes all draw from one + // heavy-job budget (CODESEARCH_INDEX_JOBS). + let tmp = tempfile::tempdir().unwrap(); + let db_path = tmp.path().join("repo").join(DB_DIR_NAME); + let state = std::sync::Arc::new(ServeState::new(ReposConfig::default(), None)); + + let stores = match state + .try_open_stores("repo", &db_path, true, false, None) + .expect("a fresh repo must open in write mode") + { + OpenedStores::Write(s) => s, + OpenedStores::Readonly(_) => panic!("allow_create=true must open write mode"), + }; + + let store_gate = stores + .job_gate + .as_ref() + .expect("serve-opened stores must carry the job gate"); + assert!( + std::sync::Arc::ptr_eq(store_gate, &state.job_gate), + "the store gate must be the ServeState gate" + ); +} + #[test] fn test_api_key_matches() { assert!(api_key_matches("secret-key", "secret-key")); assert!(!api_key_matches("secret-key", "secret-keX")); assert!(!api_key_matches("secret", "secret-key")); // different length assert!(!api_key_matches("", "secret-key")); - assert!(api_key_matches("", "")); // both empty digests are equal + assert!(api_key_matches("", "")); // both empty keys compare equal // Case-sensitive and exact. assert!(!api_key_matches("Secret-Key", "secret-key")); } @@ -163,9 +190,15 @@ async fn await_index_task_cancels_and_joins_indexing_task() { } done_clone.store(true, std::sync::atomic::Ordering::SeqCst); }); - state - .index_tasks - .insert("repo-x".to_string(), (handle, token)); + state.index_tasks.insert( + "repo-x".to_string(), + IndexTask { + handle, + token, + db_path: std::path::PathBuf::from("/nonexistent-db"), + started_at: Instant::now(), + }, + ); state.await_index_task("repo-x").await; assert!( !state.index_tasks.contains_key("repo-x"), @@ -302,9 +335,15 @@ async fn remove_repo_during_active_build_self_cleans_db_dir() { // orphaned — self-clean it now that the build's handles are released. ServeState::remove_orphaned_db_dir("buildrepo", &db_path_for_cleanup); }); - state - .index_tasks - .insert("buildrepo".to_string(), (handle, token)); + state.index_tasks.insert( + "buildrepo".to_string(), + IndexTask { + handle, + token, + db_path: db_path.clone(), + started_at: Instant::now(), + }, + ); // remove_repo lands WHILE the spawn_blocking build is still sleeping. let outcome = state @@ -911,7 +950,12 @@ async fn add_repo_handler_registers_brand_new_repo_without_rollback() { /// serve-wide default's dimension (`codesearch serve --model X`), not the /// built-in 384-dim default. This is the write-side counterpart of the per-repo /// query-model contract. +/// +/// `#[serial]`: the handler reads `CODESEARCH_ALLOWED_ROOTS`, so this test +/// must exclude the mutating `allowed_roots_tests` group — the 403 flake +/// named in that module's comment is a serial-vs-non-serial race. #[tokio::test] +#[serial] async fn add_repo_handler_uses_serve_default_model_for_new_index() { let tmp = tempfile::tempdir().unwrap(); let repo_path = tmp.path().join("defaulted"); @@ -958,8 +1002,10 @@ async fn add_repo_handler_uses_serve_default_model_for_new_index() { /// The serve-wide default must NOT override an index that already records its /// own model: re-adding a repo whose `.codesearch.db` is still on disk keeps the -/// recorded model and dimension. +/// recorded model and dimension. `#[serial]` for the same allowed-roots read +/// as its sibling above. #[tokio::test] +#[serial] async fn add_repo_handler_keeps_recorded_model_over_serve_default() { let tmp = tempfile::tempdir().unwrap(); let repo_path = tmp.path().join("existing"); @@ -2705,6 +2751,73 @@ fn evicting_idle_repo_clears_frozen_csharp_error_state() { ); } +/// A build longer than the idle timeout must not leave the repo "idle" the +/// instant it finishes: the reaper skips an indexing repo AND restarts its idle +/// clock, so the first sweep after the build still finds it fresh. +/// +/// Regression guard: the reaper used to skip indexing repos without touching +/// `last_access`, so a 30+ minute SCIP/index run ended with the repo already +/// past the timeout and the very next sweep evicted it. +#[tokio::test] +#[serial] +async fn idle_reaper_restarts_the_idle_clock_of_an_indexing_repo() { + let _env = crate::testing::EnvRestore::set(&[ + (crate::constants::REPO_IDLE_TIMEOUT_ENV, "60"), + (crate::constants::MAX_INDEXING_SECS_ENV, "600"), + ]); + let state = Arc::new(ServeState::new(ReposConfig::default(), None)); + let tmp = tempfile::tempdir().unwrap(); + let db_path = crate::cache::safe_canonicalize(tmp.path()) + .unwrap() + .join(DB_DIR_NAME); + let OpenedStores::Write(stores) = state + .try_open_stores("longbuild", &db_path, true, false, None) + .expect("open must succeed") + else { + panic!("brand-new repo must open Write"); + }; + state + .repos + .insert("longbuild".to_string(), RepoState::Warm { stores }); + let long_ago = || { + Instant::now() + .checked_sub(Duration::from_secs(120)) + .expect("monotonic clock at least 2 minutes old") + }; + state + .last_access + .insert("longbuild".to_string(), long_ago()); + assert!(state.begin_indexing("longbuild", IndexingOwner::Reindex)); + + state.evict_idle_repos(); + assert!( + state.repos.contains_key("longbuild"), + "a repo past the idle timeout must not be evicted while it is indexing" + ); + let age = state.last_access.get("longbuild").unwrap().elapsed(); + assert!( + age < Duration::from_secs(60), + "a sweep that sees the repo indexing must restart its idle clock, age was {age:?}" + ); + + state.end_indexing("longbuild", IndexingOwner::Reindex); + state.evict_idle_repos(); + assert!( + state.repos.contains_key("longbuild"), + "the first sweep after the build must find the repo fresh, not idle" + ); + + // Control: once the idle period really passes, the reaper still evicts. + state + .last_access + .insert("longbuild".to_string(), long_ago()); + state.evict_idle_repos(); + assert!( + !state.repos.contains_key("longbuild"), + "a repo idle past the timeout with no build running must still be evicted" + ); +} + /// The model a serve query is embedded with is read from the routed repo's own /// index metadata — never assumed to be the hub-wide default. /// @@ -2998,13 +3111,15 @@ async fn a_second_format_recovery_for_the_same_alias_is_refused() { #[tokio::test] #[serial] -async fn stale_indexing_marker_cancels_the_leaked_index_task() { - // Regression: evicting the stale marker used to fix only what the TUI - // believed. The task itself kept running and kept its `Arc` - // — so the LMDB env and `.writer.lock` stayed held and every later write - // failed with "Database is locked by another process" on a repo that - // logged as idle and closed. - let _env = crate::testing::EnvRestore::set(&[(crate::constants::MAX_INDEXING_SECS_ENV, "1")]); +async fn await_index_task_cancels_and_releases_the_task_handles() { + // Regression: a leaked index task used to keep its `Arc` + // after every cooperative path forgot it — the LMDB env and + // `.writer.lock` stayed held, and later writes failed with "Database is + // locked by another process" on a repo that logged as idle. Cancellation + // must be delivered AND the handle joined (not detached), so the stores + // are released. The staleness check no longer cancels live tasks (see + // `stale_marker_with_live_task_is_renewed_not_cancelled`); + // `await_index_task` is the cancellation trigger. let state = Arc::new(ServeState::new(ReposConfig::default(), None)); // Stand-in for the store handles the real task captures. @@ -3016,39 +3131,32 @@ async fn stale_indexing_marker_cancels_the_leaked_index_task() { task_token.cancelled().await; drop(stores_task); }); - state - .index_tasks - .insert("leaky".to_string(), (handle, token.clone())); - state.active_reindexes.insert( + state.index_tasks.insert( "leaky".to_string(), - std::iter::once(( - IndexingOwner::Reindex, - Instant::now() - .checked_sub(Duration::from_secs(2)) - .expect("monotonic clock at least 2s old"), - )) - .collect(), + IndexTask { + handle, + token: token.clone(), + db_path: std::path::PathBuf::from("/nonexistent-db"), + started_at: Instant::now(), + }, ); assert!( - !state.is_indexing("leaky"), - "a marker older than the timeout must not read as indexing" + state.await_index_task("leaky").await, + "a task observing cancellation must join within the cooperative budget" ); assert!( token.is_cancelled(), - "the leaked task must be cancelled, not merely forgotten" + "the cancelled task must observe cancellation" + ); + assert!( + !state.index_tasks.contains_key("leaky"), + "a joined task must be reaped from index_tasks" ); - - let (handle, _) = state - .index_tasks - .remove("leaky") - .expect("task entry kept") - .1; - handle.await.expect("cancelled task joins cleanly"); assert_eq!( Arc::strong_count(&stores), 1, - "the leaked task must have released its store handle" + "the cancelled task must have released its store handle" ); } @@ -3061,9 +3169,15 @@ async fn fresh_indexing_marker_leaves_its_index_task_running() { let token = CancellationToken::new(); let task_token = token.clone(); let handle = tokio::spawn(async move { task_token.cancelled().await }); - state - .index_tasks - .insert("busy".to_string(), (handle, token.clone())); + state.index_tasks.insert( + "busy".to_string(), + IndexTask { + handle, + token: token.clone(), + db_path: std::path::PathBuf::from("/nonexistent-db"), + started_at: Instant::now(), + }, + ); state.begin_indexing("busy", IndexingOwner::Reindex); assert!( @@ -3204,6 +3318,80 @@ async fn indexing_marker_heartbeat_survives_past_max() { ); } +#[tokio::test] +#[serial] +async fn symbol_marker_guard_keeps_the_marker_alive_until_dropped() { + // Regression: the SCIP rebuild is one opaque blocking call with no + // per-batch heartbeat, so its Symbol marker aged out at MAX_INDEXING_SECS + // and the reaper evicted the repo mid-build. The guard renews it for the + // whole run and ends it (and the heartbeat) on drop. + let _env = crate::testing::EnvRestore::set(&[(crate::constants::MAX_INDEXING_SECS_ENV, "1")]); + let state = Arc::new(ServeState::new(ReposConfig::default(), None)); + + // Control: a bare Symbol marker expires at the threshold. + assert!(state.begin_indexing("ctrl", IndexingOwner::Symbol)); + let guard = IndexingMarkerGuard::begin( + &state, + "guarded", + IndexingOwner::Symbol, + Duration::from_millis(100), + ); + tokio::time::sleep(Duration::from_millis(1500)).await; + assert!( + !state.is_indexing("ctrl"), + "an unrenewed Symbol marker must expire at the threshold" + ); + assert!( + state.is_indexing("guarded"), + "the guard's heartbeat must keep the marker alive past the threshold" + ); + + drop(guard); + assert!( + !state.is_indexing("guarded"), + "dropping the guard must end the marker" + ); + // A heartbeat tick racing the drop must not resurrect the marker. + tokio::time::sleep(Duration::from_millis(300)).await; + assert!( + !state.active_reindexes.contains_key("guarded"), + "the heartbeat must stop with the guard" + ); +} + +#[tokio::test] +#[serial] +async fn symbol_marker_guard_is_inert_while_another_owner_holds_the_alias() { + // Nested rebuilds run under the Reindex marker: the guard must neither + // add a Symbol marker nor end anyone else's on drop. + let _env = crate::testing::EnvRestore::set(&[(crate::constants::MAX_INDEXING_SECS_ENV, "600")]); + let state = Arc::new(ServeState::new(ReposConfig::default(), None)); + + assert!(state.begin_indexing("nested", IndexingOwner::Reindex)); + let guard = IndexingMarkerGuard::begin( + &state, + "nested", + IndexingOwner::Symbol, + Duration::from_millis(50), + ); + tokio::time::sleep(Duration::from_millis(150)).await; + let owners: Vec = state + .active_reindexes + .get("nested") + .unwrap() + .keys() + .copied() + .collect(); + assert_eq!(owners, vec![IndexingOwner::Reindex]); + + drop(guard); + assert!( + state.is_indexing("nested"), + "an inert guard must leave the holder's marker alone" + ); + state.end_indexing("nested", IndexingOwner::Reindex); +} + #[tokio::test] #[serial] async fn fsw_callback_end_cannot_clear_a_concurrent_reindex_marker() { @@ -3287,3 +3475,1496 @@ async fn stale_eviction_is_scoped_to_the_stale_owner() { "an empty owner map must be removed, not left behind" ); } + +// ── Always-on symbol indexes (features/always-on-symbol-indexes) ────────── + +/// The per-(alias, language) claim must reject a second fresh claim, accept +/// one per language independently, become claimable after release, and take +/// over a claim older than the indexing timeout (leaked by a crashed task). +#[test] +fn symbol_rebuild_claim_rejects_fresh_and_takes_over_stale() { + let state = ServeState::new(ReposConfig::default(), None); + + assert!( + state.begin_symbol_rebuild("repo", "csharp"), + "first claim must succeed" + ); + assert!( + !state.begin_symbol_rebuild("repo", "csharp"), + "a second fresh claim must be rejected" + ); + assert!( + state.begin_symbol_rebuild("repo", "typescript"), + "a different language must claim independently" + ); + + state.end_symbol_rebuild("repo", "csharp"); + assert!( + state.begin_symbol_rebuild("repo", "csharp"), + "a released slot must be claimable again" + ); + + // Stale takeover: a claim past the indexing timeout is taken over. + let max = state.indexing_timeout(); + state.symbol_rebuild_in_flight.insert( + "csharp:stale".to_string(), + std::time::Instant::now() - max - std::time::Duration::from_secs(1), + ); + assert!( + state.begin_symbol_rebuild("stale", "csharp"), + "a stale claim must be taken over" + ); +} + +/// The generic gate must answer NotApplicable for a repo without the +/// language's entrypoint (no tsconfig.json) — deterministically, before the +/// machine-dependent helper check — and route C# through its dedicated +/// evaluator (.sln check → NoSolutionFile). +#[test] +fn evaluate_symbol_rebuild_gates_applicability_before_availability() { + // `evaluate_symbol_rebuild` takes `self: &Arc` (it may be forwarded + // to spawn_blocking by callers), so the probe state lives in an Arc. + let state = std::sync::Arc::new(ServeState::new(ReposConfig::default(), None)); + let tmp = tempfile::tempdir().unwrap(); + let db = tmp.path().join(DB_DIR_NAME); + + assert_eq!( + state.evaluate_symbol_rebuild("typescript", "x", tmp.path(), &db), + RebuildDecision::NotApplicable, + "a repo without tsconfig.json is not applicable, helper or not" + ); + assert_eq!( + state.evaluate_symbol_rebuild("csharp", "x", tmp.path(), &db), + RebuildDecision::NoSolutionFile, + "C# must keep its dedicated .sln-first evaluator" + ); +} + +/// The find_impact self-heal must no-op quietly for an unknown alias (remote +/// mounts, typos) and for a registered repo the language does not apply to — +/// no claim taken, no C# status touched, no panic. +#[tokio::test] +async fn heal_missing_symbol_index_noops_outside_its_remit() { + // Unknown alias. + let state = std::sync::Arc::new(ServeState::new(ReposConfig::default(), None)); + heal_missing_symbol_index(&state, "ghost", "csharp").await; + assert!( + state.symbol_rebuild_in_flight.is_empty(), + "unknown alias must not take a claim" + ); + + // Registered alias, non-applicable language (no .sln / tsconfig.json). + let (_tmp, _path, bare) = state_with_repo("plainrepo"); + let state = std::sync::Arc::new(bare); + heal_missing_symbol_index(&state, "plainrepo", "csharp").await; + heal_missing_symbol_index(&state, "plainrepo", "typescript").await; + assert!( + state.symbol_rebuild_in_flight.is_empty(), + "non-applicable repo must not take a claim" + ); + assert!( + !state.csharp_index_status.contains_key("plainrepo"), + "non-applicable repo must not flip the C# indicator" + ); +} + +/// `maybe_rebuild_symbols` on a repo no language applies to must neither +/// panic nor leave claims behind — with and without force (the force path +/// skips the gate but trigger_symbol_rebuild still skips non-applicable +/// repos before claiming). +#[tokio::test] +async fn maybe_rebuild_symbols_skips_non_applicable_repo_under_force() { + let (_tmp, _path, bare) = state_with_repo("plainrepo2"); + let state = std::sync::Arc::new(bare); + let path = state.config.read().unwrap().resolve("plainrepo2").unwrap(); + let db = path.join(DB_DIR_NAME); + maybe_rebuild_symbols("plainrepo2", &path, &db, &state, true).await; + assert!( + state.symbol_rebuild_in_flight.is_empty(), + "force must not claim a slot for a non-applicable repo" + ); +} + +/// A dummy `scip-csharp` helper at the env-override path: available for +/// detection, fails on execution — which flips the C# status to Error while +/// proving a rebuild was actually attempted. The helper file lives in +/// `root`, which the caller keeps alive via its TempDir. +fn dummy_csharp_helper(root: &std::path::Path) -> crate::testing::EnvRestore { + let helper = root.join(if cfg!(windows) { + "scip-csharp.exe" + } else { + "scip-csharp" + }); + std::fs::write(&helper, b"dummy").expect("dummy helper file"); + crate::testing::EnvRestore::set(&[( + crate::constants::SCIP_CSHARP_HELPER_ENV, + helper.to_string_lossy().as_ref(), + )]) +} + +/// Phase-2 composition wiring: a registered repo whose language applies and +/// whose index is missing must flow gate → queue → trigger end-to-end. The +/// dummy helper makes the rebuild FAIL, observable as C# status Error once +/// `run_phase_2_symbols` completes — None would mean the candidate was never +/// queued (the composition gap this test pins). +#[tokio::test] +#[serial] +async fn run_phase_2_symbols_wires_candidate_through_to_trigger() { + let helper_root = tempfile::tempdir().unwrap(); + let _env = dummy_csharp_helper(helper_root.path()); + + let (_tmp, repo_path, bare) = state_with_repo("phase2repo"); + std::fs::write( + repo_path.join("test.sln"), + b"Microsoft Visual Studio Solution File", + ) + .unwrap(); + + let state = std::sync::Arc::new(bare); + state.run_phase_2_symbols().await; + + assert_eq!( + state + .csharp_index_status + .get("phase2repo") + .map(|e| *e.value()), + Some(CSharpIndexStatus::Error), + "the missing C# index must be queued and the rebuild attempted \ + (dummy helper → Error); None means never queued" + ); + assert!( + state.symbol_rebuild_in_flight.is_empty(), + "the claim must be released after the failed rebuild" + ); +} + +/// A successful rebuild WITHOUT survived failures is Ready with the error +/// cleared; one WITH survived workspace failures is Partial (red `C#⚠` in +/// the TUI) with a bounded detail line for the info panel — capped at the +/// first three entries so the detail row stays readable. +#[test] +fn csharp_success_outcome_partial_when_warnings_survived() { + assert_eq!( + csharp_success_outcome(&[]), + (CSharpIndexStatus::Ready, None), + "a clean rebuild must read Ready with no error detail" + ); + + let degraded = [ + "summary".to_string(), + "A.csproj: failure one".to_string(), + "B.csproj: failure two".to_string(), + "C.csproj: failure three".to_string(), + "D.csproj: failure four".to_string(), + ]; + let (status, detail) = csharp_success_outcome(°raded); + assert_eq!(status, CSharpIndexStatus::Partial); + let detail = detail.expect("partial carries detail"); + assert!( + detail.contains("summary") && detail.contains("B.csproj"), + "detail joins the leading entries, got: {detail}" + ); + assert!( + !detail.contains("D.csproj"), + "detail is capped at three entries, got: {detail}" + ); +} + +/// A running build wins over a cached (stale) Ready and over the probe, and +/// skips the probe entirely; idle falls back cache → probe. +#[test] +fn resolve_csharp_status_precedence() { + use CSharpIndexStatus as S; + // (cached, indexing, probe result, expected, probe expected to run) + let cases = [ + (Some(S::Ready), true, S::Ready, S::Indexing, false), + (None, true, S::Ready, S::Indexing, false), + (Some(S::Ready), false, S::None, S::Ready, false), + (None, false, S::Ready, S::Ready, true), + (None, false, S::None, S::None, true), + ]; + for (cached, indexing, probe_result, expected, probe_runs) in cases { + let mut probed = false; + let got = resolve_csharp_status(cached, indexing, || { + probed = true; + probe_result + }); + assert_eq!( + got, expected, + "cached={cached:?} indexing={indexing} probe={probe_result:?}" + ); + assert_eq!( + probed, probe_runs, + "probe invocation for cached={cached:?} indexing={indexing}" + ); + } +} + +/// The watcher notifier must apply the SAME status contract as +/// trigger_symbol_rebuild's success arm: Succeeded-with-warnings → Partial +/// (red C#⚠) with bounded detail — never green — and a clean Succeeded → +/// Ready with the detail cleared. Reverting the arm to insert(Ready) ships +/// the round-1 defect (green indicator on a degraded index) with a green +/// suite. +#[test] +fn csharp_notifier_partial_on_succeeded_with_warnings() { + let state = ServeState::new(ReposConfig::default(), None); + let notifier = state.make_csharp_notifier("wrepo"); + + notifier(SymbolRebuildSignal::Started); + assert_eq!( + state.csharp_index_status.get("wrepo").map(|e| *e.value()), + Some(CSharpIndexStatus::Indexing) + ); + + notifier(SymbolRebuildSignal::Succeeded { + index_warnings: vec![ + "summary".to_string(), + "A.csproj: boom".to_string(), + "B.csproj: boom2".to_string(), + "C.csproj: boom3".to_string(), + ], + }); + assert_eq!( + state.csharp_index_status.get("wrepo").map(|e| *e.value()), + Some(CSharpIndexStatus::Partial), + "a degraded watcher rebuild must render Partial, never green" + ); + let detail = state + .csharp_index_error + .get("wrepo") + .map(|e| e.value().clone()) + .expect("detail stored"); + assert!(detail.contains("summary") && !detail.contains("C.csproj")); + + notifier(SymbolRebuildSignal::Succeeded { + index_warnings: Vec::new(), + }); + assert_eq!( + state.csharp_index_status.get("wrepo").map(|e| *e.value()), + Some(CSharpIndexStatus::Ready) + ); + assert!( + !state.csharp_index_error.contains_key("wrepo"), + "a clean rebuild must clear the detail" + ); +} + +/// A rebuild abandoned because `dotnet restore` never finished within the +/// retry cap leaves the previous index live — so the notifier must render +/// a WARNING (Partial, yellow `C#⚠`, with the abandonment detail), never a +/// red Error: a hung restore is an environment condition, not a broken +/// index. +#[test] +fn csharp_notifier_renders_restore_exhaustion_as_partial_not_error() { + let state = ServeState::new(ReposConfig::default(), None); + let notifier = state.make_csharp_notifier("bayr"); + + notifier(SymbolRebuildSignal::Started); + notifier(SymbolRebuildSignal::Abandoned( + "dotnet restore for this solution did not finish within 3 attempts \ + (backoff 60s + 120s) — rebuild abandoned, the previous index stays live (issue #225)" + .to_string(), + )); + assert_eq!( + state.csharp_index_status.get("bayr").map(|e| *e.value()), + Some(CSharpIndexStatus::Partial), + "restore exhaustion is a warning — the previous index stays live" + ); + let detail = state + .csharp_index_error + .get("bayr") + .map(|e| e.value().clone()) + .expect("the abandonment reason must be the info-panel detail"); + assert!( + detail.contains("did not finish within 3 attempts"), + "{detail}" + ); + + // A later clean rebuild clears the warning again. + notifier(SymbolRebuildSignal::Succeeded { + index_warnings: Vec::new(), + }); + assert_eq!( + state.csharp_index_status.get("bayr").map(|e| *e.value()), + Some(CSharpIndexStatus::Ready) + ); + assert!(!state.csharp_index_error.contains_key("bayr")); +} + +/// The failure classifier must keep the three outcomes apart — and check +/// restore-exhaustion FIRST: the typed error carries its own contract +/// (LMDB untouched, previous index live) that the corruption matcher must +/// not override. Reordering the checks or flipping the restore arm back to +/// Error ships the red-error regression with a green suite. +#[test] +fn symbol_rebuild_failure_classification_keeps_restore_exhaustion_a_warning() { + let exhausted: anyhow::Error = csharp::RestoreExhaustedError { + attempts: 3, + backoff: "60s + 120s".to_string(), + } + .into(); + assert_eq!( + classify_symbol_rebuild_failure(&format!("{exhausted:#}"), &exhausted, true), + SymbolRebuildFailureKind::RestoreExhausted, + "a C# restore-exhausted rebuild must classify as the warning path" + ); + // Not C#: the restore gate is C#-only, the same error falls through. + assert_eq!( + classify_symbol_rebuild_failure(&format!("{exhausted:#}"), &exhausted, false), + SymbolRebuildFailureKind::Generic + ); + // Corruption keeps its own path for a non-exhausted error. + let corrupt: anyhow::Error = anyhow::anyhow!("heed -> MDB_BAD_VALSIZE"); + assert_eq!( + classify_symbol_rebuild_failure(&format!("{corrupt:#}"), &corrupt, true), + SymbolRebuildFailureKind::LmdbCorruption + ); + // Everything else stays a red Error. + let generic: anyhow::Error = anyhow::anyhow!("helper exited with 1"); + assert_eq!( + classify_symbol_rebuild_failure(&format!("{generic:#}"), &generic, true), + SymbolRebuildFailureKind::Generic + ); +} + +/// `repo_statuses_lightweight()` must carry the Partial status AND its +/// detail message — that pair is what renders the red `C#⚠` and the info +/// panel's failure line. +#[test] +fn repo_statuses_lightweight_carries_partial_with_detail() { + let (_tmp, _path, bare) = state_with_repo("partialrepo"); + let state = std::sync::Arc::new(bare); + state + .csharp_index_status + .insert("partialrepo".to_string(), CSharpIndexStatus::Partial); + state.csharp_index_error.insert( + "partialrepo".to_string(), + "summary | A.csproj: failure one".to_string(), + ); + + let statuses = state.repo_statuses_lightweight(); + let (_, info) = statuses + .iter() + .find(|(alias, _)| alias == "partialrepo") + .expect("partialrepo row"); + assert_eq!(info.csharp_index, CSharpIndexStatus::Partial); + assert_eq!( + info.csharp_error.as_deref(), + Some("summary | A.csproj: failure one"), + "the detail message must ride on the status row" + ); +} + +/// Owner-scoped status: a TEXT reindex lights the general `Indexing` label +/// and never the symbol columns; a SYMBOL marker lights the applicable +/// language column only and leaves the general label on the repo's resting +/// state. A Rust-only repo keeps `None` in both symbol columns either way. +#[test] +#[serial] +fn indexing_labels_are_owner_scoped_in_status() { + let (_tmp, repo_path, bare) = state_with_repo("langrepo"); + let state = std::sync::Arc::new(bare); + assert!(state.begin_indexing("langrepo", IndexingOwner::Reindex)); + + let row = |state: &ServeState| { + state + .repo_statuses_lightweight() + .into_iter() + .find(|(alias, _)| alias == "langrepo") + .expect("langrepo row") + .1 + }; + + let info = row(&state); + assert_eq!(info.status, RepoStateLabel::Indexing); + assert_eq!(info.csharp_index, CSharpIndexStatus::None); + assert_eq!(info.typescript_index, CSharpIndexStatus::None); + + // A .sln alone does not make a text reindex a C# rebuild: the C# column + // lights only when a symbol marker is present. + std::fs::write(repo_path.join("App.sln"), "").unwrap(); + assert_eq!(row(&state).csharp_index, CSharpIndexStatus::None); + + state.end_indexing("langrepo", IndexingOwner::Reindex); + // An on-disk db makes the resting state Idle (not NoIndex). + std::fs::create_dir_all(repo_path.join(DB_DIR_NAME)).unwrap(); + assert!(state.begin_indexing("langrepo", IndexingOwner::Symbol)); + let info = row(&state); + assert_eq!(info.csharp_index, CSharpIndexStatus::Indexing); + assert_eq!( + info.status, + RepoStateLabel::Idle, + "a pure SCIP rebuild must not light the general Indexing label" + ); + + state.end_indexing("langrepo", IndexingOwner::Symbol); +} + +/// TS twin of the owner-scoping test above: with a resolvable helper env +/// override, a SYMBOL marker lights the TS column while the general label +/// rests; a TEXT reindex never lights the TS column, tsconfig or not. +/// `#[serial]` + `EnvRestore`: the helper override is process env. +#[test] +#[serial] +fn typescript_column_is_symbol_owner_scoped() { + let (_tmp, repo_path, bare) = state_with_repo("tsrepo"); + let state = std::sync::Arc::new(bare); + std::fs::create_dir_all(repo_path.join(DB_DIR_NAME)).unwrap(); + std::fs::write(repo_path.join("tsconfig.json"), "{}").unwrap(); + // The env override must point at a regular file; content is never run. + let helper = repo_path.join("fake-scip-typescript"); + std::fs::write(&helper, "").unwrap(); + let helper_env = crate::constants::SCIP_TYPESCRIPT_HELPER_ENV; + let helper_path = helper.display().to_string(); + + let row = |state: &ServeState| { + state + .repo_statuses_lightweight() + .into_iter() + .find(|(alias, _)| alias == "tsrepo") + .expect("tsrepo row") + .1 + }; + + assert!(state.begin_indexing("tsrepo", IndexingOwner::Reindex)); + { + let _env = crate::testing::EnvRestore::set(&[(helper_env, helper_path.as_str())]); + let info = row(&state); + assert_eq!(info.status, RepoStateLabel::Indexing); + assert_eq!( + info.typescript_index, + CSharpIndexStatus::None, + "a text reindex must not light the TS column" + ); + } + state.end_indexing("tsrepo", IndexingOwner::Reindex); + + assert!(state.begin_indexing("tsrepo", IndexingOwner::Symbol)); + let _env = crate::testing::EnvRestore::set(&[(helper_env, helper_path.as_str())]); + let info = row(&state); + assert_eq!(info.typescript_index, CSharpIndexStatus::Indexing); + assert_eq!( + info.status, + RepoStateLabel::Idle, + "a pure SCIP rebuild must not light the general Indexing label" + ); + state.end_indexing("tsrepo", IndexingOwner::Symbol); +} + +/// A queued phase-2 rebuild holds no active_reindexes marker yet: the C# +/// cache pre-mark alone must light the C# COLUMN (queued work stays visible) +/// while the general label stays on the repo's resting state — a pure SCIP +/// pass never made the text index busy. +#[test] +fn queued_rebuild_pre_mark_shows_in_the_csharp_column_only() { + let (_tmp, repo_path, bare) = state_with_repo("queuedrepo"); + let state = std::sync::Arc::new(bare); + std::fs::create_dir_all(repo_path.join(DB_DIR_NAME)).unwrap(); + + // The phase-2 queue pre-mark — no begin_indexing, the task hasn't started. + state + .csharp_index_status + .insert("queuedrepo".to_string(), CSharpIndexStatus::Indexing); + + let row = || { + state + .repo_statuses_lightweight() + .into_iter() + .find(|(alias, _)| alias == "queuedrepo") + .expect("queuedrepo row") + .1 + }; + + let info = row(); + assert_eq!(info.csharp_index, CSharpIndexStatus::Indexing); + assert_eq!( + info.status, + RepoStateLabel::Idle, + "a queued symbol rebuild must not light the general Indexing label" + ); + + // Completed rebuilds overwrite the cache; without pending work the same + // closed repo reads Idle again. + state.csharp_index_status.remove("queuedrepo"); + assert_eq!(row().status, RepoStateLabel::Idle); +} + +/// The `!applies` skip in trigger_symbol_rebuild must drop a queued pre-mark: +/// applicability can change while the task waits for its semaphore slot, and +/// no rebuild will start to overwrite the mark. +#[tokio::test] +async fn trigger_symbol_rebuild_clears_a_pre_mark_when_not_applicable() { + let (_tmp, repo_path, bare) = state_with_repo("naq"); + let state = std::sync::Arc::new(bare); + // No .sln written → C# does not apply to this repo. + state + .csharp_index_status + .insert("naq".to_string(), CSharpIndexStatus::Indexing); + + trigger_symbol_rebuild( + "naq", + &repo_path, + &repo_path.join(DB_DIR_NAME), + &state, + LANG_CSHARP, + ) + .await; + + assert!( + state.csharp_index_status.get("naq").is_none(), + "a skipped rebuild must not leave the queue pre-mark behind" + ); +} + +/// A repo whose directory is gone by the time phase-2 runs must never show +/// indexing: either candidacy filtering skips it or the task's skip guard +/// drops the pre-mark. No helper env is set (applicability gates before +/// availability, so a missing dir is decided without probing a helper) — +/// env-mutating variants of this test must stay `#[serial]`. +#[tokio::test] +async fn phase_2_never_marks_a_missing_repo_indexing() { + let (_tmp, repo_path, bare) = state_with_repo("gone"); + std::fs::remove_dir_all(&repo_path).unwrap(); + let state = std::sync::Arc::new(bare); + + state.run_phase_2_symbols().await; + + assert!( + state.csharp_index_status.get("gone").is_none(), + "a missing repo must not end up marked indexing" + ); +} + +/// The serve-tui `i` overlay reads the DURABLE warnings from the on-disk +/// meta (survives a restart, unlike the in-memory status) and prefixes them +/// with the language. A repo whose meta carries no warnings yields none. +#[test] +fn build_info_overlay_reads_symbol_warnings_from_meta() { + use crate::serve::tui::build_info_overlay; + + let (_tmp, repo_path, bare) = state_with_repo("inforepo"); + let db = repo_path.join(DB_DIR_NAME); + std::fs::create_dir_all(&db).unwrap(); + std::fs::write( + db.join("metadata.json"), + r#"{"schema_version":1,"dimensions":2,"model_short_name":"minilm-l6-q"}"#, + ) + .unwrap(); + // Seed the meta the way a degraded rebuild does (see the roundtrip test + // in csharp_tests for the read side). + let env = crate::symbols::get_shared_scip_env(&db).unwrap(); + let mut wtxn = env.write_txn().unwrap(); + let meta: heed::Database = env + .create_database(&mut wtxn, Some(crate::constants::SCIP_META_DB_NAME)) + .unwrap(); + meta.put( + &mut wtxn, + crate::constants::SCIP_INDEX_WARNINGS_KEY, + r#"["summary","A.csproj: failure one"]"#, + ) + .unwrap(); + wtxn.commit().unwrap(); + + let state = std::sync::Arc::new(bare); + let statuses = state.repo_statuses_lightweight(); + let idx = statuses + .iter() + .position(|(alias, _)| alias == "inforepo") + .expect("inforepo row"); + let overlay = build_info_overlay(idx, &statuses, &state).expect("overlay"); + match overlay { + crate::serve::tui_common::OverlayState::Info { + symbol_warnings, .. + } => { + assert!( + symbol_warnings.len() == 2 && symbol_warnings[0].starts_with("[csharp] summary"), + "warnings must be language-prefixed from meta, got: {symbol_warnings:?}" + ); + } + other => panic!("expected Info overlay, got {other:?}"), + } +} + +/// A failed first build must KEEP the registration and release the marker: +/// the old rollback unregistered the alias and let self-cleanup delete the +/// DB dir — the vanishing-repo defect (a 202 was the operator's last +/// word). A registered half-built store heals via reindex. +#[test] +fn note_add_index_failure_keeps_the_repo_registered() { + let (_tmp, repo_path, state) = state_with_repo("addfail"); + let alias = "addfail"; + // The add handler begins indexing before spawning the build task. + assert!(state.begin_indexing(alias, IndexingOwner::Reindex)); + + state.note_add_index_failure( + alias, + &repo_path, + &anyhow::anyhow!("FTS commit failed: Access is denied. (os error 5)"), + ); + + assert!( + state.config_snapshot().resolve(alias).is_some(), + "the repo must stay registered after a failed first build" + ); + assert!( + state.begin_indexing(alias, IndexingOwner::Reindex), + "the failed marker must be released so a retry can start immediately" + ); +} + +/// The symbol-index status collector reads plain meta (never a helper): +/// stale without a current builder stamp, ready with one, degraded with +/// warnings — and a repo without entrypoints reads not-applicable instead +/// of blaming an absent index. +#[test] +#[serial] +fn symbol_index_status_reflects_the_on_disk_meta() { + use crate::constants::{INDEX_BUILDER_VERSION, SCIP_INDEX_BUILDER_VERSION_KEY}; + + let (_tmp, repo_path, state) = state_with_repo("syminfo"); + let db = repo_path.join(DB_DIR_NAME); + let registry = state.symbol_registry(); + + // No entrypoints at all: both languages are explicitly not-applicable. + let statuses = crate::symbols::symbol_index_status(®istry, &repo_path, &db); + assert!( + statuses.iter().all(|s| s.not_applicable), + "a repo without entrypoints must not blame an absent index: {statuses:?}" + ); + + // Applicable from here on: a solution file. + std::fs::write(repo_path.join("test.sln"), b"Solution File").unwrap(); + + // Key-format stamp only (no builder stamp): has_index accepts it, the + // builder check reads stale — the inherited-index class. + seed_scip_meta(&db, &[]); + let csharp = crate::symbols::symbol_index_status(®istry, &repo_path, &db) + .into_iter() + .find(|s| s.language == "csharp") + .expect("csharp status entry"); + assert_eq!(csharp.state, "stale", "{csharp:?}"); + + // A rebuild by THIS binary (current stamp): ready. + seed_scip_meta( + &db, + &[(SCIP_INDEX_BUILDER_VERSION_KEY, INDEX_BUILDER_VERSION)], + ); + let csharp = crate::symbols::symbol_index_status(®istry, &repo_path, &db) + .into_iter() + .find(|s| s.language == "csharp") + .expect("csharp status entry"); + assert_eq!(csharp.state, "ready", "{csharp:?}"); + assert!(!csharp.not_applicable); + + // Survived build failures in meta: degraded — serving but incomplete. + seed_scip_meta( + &db, + &[ + (SCIP_INDEX_BUILDER_VERSION_KEY, INDEX_BUILDER_VERSION), + ( + crate::constants::SCIP_INDEX_WARNINGS_KEY, + r#"["Broken.csproj: Msbuild failed when processing the file"]"#, + ), + ], + ); + let csharp = crate::symbols::symbol_index_status(®istry, &repo_path, &db) + .into_iter() + .find(|s| s.language == "csharp") + .expect("csharp status entry"); + assert_eq!(csharp.state, "degraded", "{csharp:?}"); +} + +/// The overlay's age renderer must turn the unknown-age sentinel into +/// words — a consumer must never read "18446744073709551615" as an age. +#[test] +fn human_age_seconds_renders_the_unknown_sentinel_as_words() { + assert_eq!(crate::serve::tui::human_age_seconds(0), "0s"); + assert_eq!(crate::serve::tui::human_age_seconds(59), "59s"); + assert_eq!(crate::serve::tui::human_age_seconds(120), "2m"); + assert_eq!(crate::serve::tui::human_age_seconds(3 * 3600), "3h"); + assert_eq!(crate::serve::tui::human_age_seconds(72 * 3600), "3d"); + assert_eq!( + crate::serve::tui::human_age_seconds(u64::MAX), + "unknown age" + ); +} + +/// `c` copies the warnings of an Info overlay — and nothing else: other +/// overlays ignore the key, Esc still dismisses everywhere. +#[test] +fn overlay_copy_key_only_fires_on_info_overlays() { + use crossterm::event::{KeyCode, KeyEvent, KeyModifiers}; + + let info = crate::serve::tui_common::OverlayState::Info { + alias: "demo.app".to_string(), + path: String::new(), + chunks: 0, + files: 0, + max_chunk_id: 0, + db_size_human: String::new(), + model: String::new(), + dims: 0, + lock: "write".to_string(), + index_age: String::new(), + symbol_warnings: vec!["w1".to_string()], + symbol_index: Vec::new(), + copy_feedback: None, + }; + let copy_key = KeyEvent::new(KeyCode::Char('c'), KeyModifiers::NONE); + assert!(matches!( + crate::serve::tui_common::handle_overlay_key(copy_key, &info), + Some(crate::serve::tui_common::OverlayKeyAction::CopyWarnings) + )); + + let doctor = crate::serve::tui_common::OverlayState::Doctor { + alias: "x".to_string(), + results: vec![], + }; + assert!( + crate::serve::tui_common::handle_overlay_key(copy_key, &doctor).is_none(), + "'c' must not fire outside the Info overlay" + ); + let esc = KeyEvent::new(KeyCode::Esc, KeyModifiers::NONE); + assert!(matches!( + crate::serve::tui_common::handle_overlay_key(esc, &doctor), + Some(crate::serve::tui_common::OverlayKeyAction::Dismiss) + )); +} + +/// The clipboard text is the full record: alias header naming the subject, +/// then every stored warning line verbatim. +#[test] +fn symbol_warnings_copy_text_heads_with_alias_and_carries_every_line() { + let text = crate::serve::tui_common::symbol_warnings_copy_text( + "acme-web", + &["summary line".to_string(), "A.csproj: boom".to_string()], + ); + assert!(text.starts_with("acme-web — symbol index warnings (2):")); + assert!(text.contains("\nsummary line\nA.csproj: boom")); +} + +/// An empty warnings list must report honestly instead of copying a bare +/// header — a silent "success" would read as copied content. +#[test] +fn apply_copy_warnings_reports_when_nothing_is_recorded() { + let mut info = crate::serve::tui_common::OverlayState::Info { + alias: "acme-web".to_string(), + path: String::new(), + chunks: 0, + files: 0, + max_chunk_id: 0, + db_size_human: String::new(), + model: String::new(), + dims: 0, + lock: "write".to_string(), + index_age: String::new(), + symbol_warnings: vec![], + symbol_index: Vec::new(), + copy_feedback: None, + }; + crate::serve::tui_common::apply_copy_warnings(&mut info); + match info { + crate::serve::tui_common::OverlayState::Info { copy_feedback, .. } => { + assert_eq!( + copy_feedback.as_deref(), + Some("no symbol warnings recorded") + ); + } + other => panic!("expected Info overlay, got {other:?}"), + } +} + +/// Both clipboard outcomes surface as the overlay's feedback line: success +/// confirms the copy, failure names the reason. The clipboard write is +/// injected so the test pins the feedback contract, not the OS clipboard. +#[test] +fn apply_copy_warnings_feedback_covers_success_and_failure() { + fn info() -> crate::serve::tui_common::OverlayState { + crate::serve::tui_common::OverlayState::Info { + alias: "acme-web".to_string(), + path: String::new(), + chunks: 0, + files: 0, + max_chunk_id: 0, + db_size_human: String::new(), + model: String::new(), + dims: 0, + lock: "write".to_string(), + index_age: String::new(), + symbol_warnings: vec!["summary".to_string()], + symbol_index: Vec::new(), + copy_feedback: None, + } + } + + let mut overlay = info(); + let seen_text = std::cell::RefCell::new(String::new()); + crate::serve::tui_common::apply_copy_warnings_with(&mut overlay, |text| { + *seen_text.borrow_mut() = text.to_string(); + Ok(()) + }); + match &overlay { + crate::serve::tui_common::OverlayState::Info { copy_feedback, .. } => { + assert_eq!( + copy_feedback.as_deref(), + Some("✓ symbol warnings copied to clipboard") + ); + } + other => panic!("expected Info overlay, got {other:?}"), + } + assert_eq!( + seen_text.into_inner(), + "acme-web — symbol index warnings (1):\nsummary" + ); + + let mut overlay = info(); + crate::serve::tui_common::apply_copy_warnings_with(&mut overlay, |_| { + Err("powershell: not found".to_string()) + }); + match overlay { + crate::serve::tui_common::OverlayState::Info { copy_feedback, .. } => { + assert_eq!( + copy_feedback.as_deref(), + Some("copy failed: powershell: not found") + ); + } + other => panic!("expected Info overlay, got {other:?}"), + } +} + +/// Greedy word-wrap row estimate: words that do not fit start a new row, a +/// word longer than the row hard-splits, every line takes at least one row. +/// A char-based ceiling would undershoot the URL case (break lands just +/// before the row end) and clip the modal's last content row. +#[test] +fn estimate_wrapped_height_counts_multi_row_lines() { + use ratatui::text::Line; + let lines = vec![Line::raw("short"), Line::raw("x".repeat(120))]; + assert_eq!( + crate::serve::tui_common::estimate_wrapped_height(&lines, 56), + 4 + ); + assert_eq!( + crate::serve::tui_common::estimate_wrapped_height(&lines, 200), + 2 + ); + // Word wrap: "aaa" + "bbb" does not fit side by side in 5 columns. + assert_eq!( + crate::serve::tui_common::estimate_wrapped_height(&[Line::raw("aaa bbb")], 5), + 2 + ); + // Hard split: a 60-char URL word across 58 columns takes 2 rows on its + // own even though ceil(60/58) would also say 2 — the pinned case is the + // prose line that leaves the URL to start a fresh row. + assert_eq!( + crate::serve::tui_common::estimate_wrapped_height( + &[Line::raw( + "src index for source https://pkgs/nuget/v3/index.json" + )], + 50 + ), + 2 + ); + // trim: false keeps the warning line's 4-space indent on the first row, + // so an indent-width word that would fit on its own needs two rows. + assert_eq!( + crate::serve::tui_common::estimate_wrapped_height( + &[Line::raw(format!(" {}", "a".repeat(58)))], + 58 + ), + 2 + ); + // A mid-line separator run is real columns: "a b" fits exactly in 4, + // wraps in 3. + assert_eq!( + crate::serve::tui_common::estimate_wrapped_height(&[Line::raw("a b")], 4), + 1 + ); + assert_eq!( + crate::serve::tui_common::estimate_wrapped_height(&[Line::raw("a b")], 3), + 2 + ); +} + +/// Long warning lines must WRAP inside the modal, not clip at the border: +/// the tail of the failure text (the feed URL) stays readable, and the +/// key-hint footer survives on the border's bottom title. +#[test] +fn modal_wraps_long_warning_lines_instead_of_clipping() { + use ratatui::backend::TestBackend; + use ratatui::text::{Line, Span}; + use ratatui::Terminal; + + let warning = "Sample.Web.csproj: Unable to load the service index for source https://pkgs.example.com/private-feed/nuget/v3/index.json"; + let mut terminal = Terminal::new(TestBackend::new(60, 24)).unwrap(); + terminal + .draw(|f| { + let lines = vec![Line::from(Span::raw(format!(" {warning}")))]; + crate::serve::tui_common::render_centered_modal_with_footer( + f, + f.area(), + " acme-web — Index Info ", + Some(" [Esc] close · [c] copy warnings "), + lines, + ratatui::style::Color::Cyan, + ); + }) + .unwrap(); + + let buffer = terminal.backend().buffer().clone(); + let mut rendered = String::new(); + for y in 0..buffer.area.height { + for x in 0..buffer.area.width { + rendered.push_str(buffer[(x, y)].symbol()); + } + rendered.push('\n'); + } + // Wrapping splits the text at arbitrary columns and the modal border + // characters sit between the wrapped segments, so compare with all + // whitespace and box-drawing characters stripped: every character of + // the warning must be rendered somewhere in order — with clipping (the + // old behaviour) the tail past the modal edge is simply gone. + let flat: String = rendered + .chars() + .filter(|c| !c.is_whitespace() && !matches!(c, '│' | '┌' | '┐' | '└' | '┘' | '─')) + .collect(); + let want: String = warning.chars().filter(|c| !c.is_whitespace()).collect(); + assert!( + flat.contains(&want), + "the full warning must wrap inside the modal, got:\n{rendered}" + ); + assert!( + rendered.contains("[c] copy warnings"), + "the copy-hint footer must stay visible, got:\n{rendered}" + ); +} + +/// The serve-mode find_impact self-heal spawn must reach +/// `trigger_symbol_rebuild` for a registered, applicable repo: after the +/// warned empty answer, the C# status eventually flips to Error (dummy +/// helper) in the serve state the heal captured. +#[tokio::test] +#[serial] +async fn find_impact_self_heal_runs_the_rebuild_in_serve_mode() { + let helper_root = tempfile::tempdir().unwrap(); + let _env = dummy_csharp_helper(helper_root.path()); + + let (_tmp, repo_path, bare) = state_with_repo("healrepo"); + std::fs::write( + repo_path.join("test.sln"), + b"Microsoft Visual Studio Solution File", + ) + .unwrap(); + // The routing layer requires an existing index dir before it will open + // the repo (seed like the find_impact fixtures do). + let db = repo_path.join(DB_DIR_NAME); + std::fs::create_dir_all(&db).unwrap(); + std::fs::write( + db.join("metadata.json"), + r#"{"schema_version":1,"dimensions":2,"model_short_name":"minilm-l6-q"}"#, + ) + .unwrap(); + let state = std::sync::Arc::new(bare); + + let request = crate::mcp::types::FindImpactRequest { + symbol_name: Some("ResolveLinkedActivityAsync".to_string()), + file: None, + line: None, + symbol_key: None, + language: Some("csharp".to_string()), + project: Some("healrepo".to_string()), + group: None, + }; + // The REST mirror builds its own serve-mode service from the state — + // the same path the MCP tool takes for a project-scoped query. + let v = crate::mcp::rest_find_impact_handler( + axum::extract::State(state.clone()), + axum::Json(request), + ) + .await + .expect("rest mirror result") + .0; + let out = v.to_string(); + assert!( + v["warnings"] + .as_array() + .is_some_and(|w| !w.is_empty() && w[0].as_str().is_some_and(|s| s.contains("UNKNOWN"))), + "the never-built index answer must carry the UNKNOWN warning, got: {out}" + ); + + // The detached heal task runs the rebuild (dummy helper → Error). + let deadline = std::time::Instant::now() + std::time::Duration::from_secs(15); + loop { + if state + .csharp_index_status + .get("healrepo") + .map(|e| *e.value()) + == Some(CSharpIndexStatus::Error) + { + break; + } + assert!( + std::time::Instant::now() < deadline, + "the self-heal never flipped the C# status — spawn branch not wired" + ); + tokio::time::sleep(std::time::Duration::from_millis(50)).await; + } +} + +// ── Rebuild gate: builder-version stamp + degraded retry ───────────────── + +/// Seeds the SCIP meta for `db` exactly like `rebuild` stamps it (rebuild +/// timestamp + key format), plus the caller's extra key/values — so gate +/// tests can shape a fresh, stale or degraded index without the helper. +fn seed_scip_meta(db: &std::path::Path, extra: &[(&str, &str)]) { + let env = crate::symbols::get_shared_scip_env(db).unwrap(); + let mut wtxn = env.write_txn().unwrap(); + let meta: heed::Database = env + .open_database(&wtxn, Some(crate::constants::SCIP_META_DB_NAME)) + .unwrap() + .unwrap(); + meta.put(&mut wtxn, crate::constants::SCIP_REBUILD_TIMESTAMP_KEY, "0") + .unwrap(); + meta.put( + &mut wtxn, + crate::constants::SCIP_KEY_FORMAT_KEY, + crate::constants::SCIP_KEY_FORMAT, + ) + .unwrap(); + for (key, value) in extra { + meta.put(&mut wtxn, *key, *value).unwrap(); + } + wtxn.commit().unwrap(); +} + +/// Shared arrangement: applicable repo (`.sln`), dummy helper, seeded SCIP +/// meta, config timestamps showing a fresh build (last_scip ≥ last_changed) +/// so ONLY the builder-version / degraded-retry checks can move the gate. +/// The helper-env guard and both tempdirs are returned so they outlive the +/// fixture. +#[allow(clippy::type_complexity)] +fn gate_fixture( + alias: &str, + meta_extra: &[(&str, &str)], +) -> ( + crate::testing::EnvRestore, + tempfile::TempDir, + tempfile::TempDir, + std::path::PathBuf, + std::sync::Arc, +) { + let helper_root = tempfile::tempdir().unwrap(); + let env_guard = dummy_csharp_helper(helper_root.path()); + let (tmp, repo_path, bare) = state_with_repo(alias); + std::fs::write(repo_path.join("test.sln"), b"Solution File").unwrap(); + let db = repo_path.join(DB_DIR_NAME); + seed_scip_meta(&db, meta_extra); + let state = std::sync::Arc::new(bare); + let now = ServeState::now_unix_secs(); + { + let mut cfg = state.config.write().unwrap(); + cfg.touch_last_changed(alias, now - 100); + cfg.touch_last_scip(alias, now); + } + (env_guard, helper_root, tmp, repo_path, state) +} + +/// An index this binary never produced (no builder stamp — anything built +/// before the stamp existed) must read as stale: a deployed binary rebuilds +/// the indexes it inherited itself at startup, never waits for a manual +/// command. This is the DRM-24427_Versioning defect class. +#[test] +#[serial] +fn evaluate_rebuilds_an_index_from_an_older_binary() { + let (_env, _h, _tmp, repo_path, state) = gate_fixture("oldbinary", &[]); + + assert_eq!( + state.evaluate_symbol_rebuild( + "csharp", + "oldbinary", + &repo_path, + &repo_path.join(DB_DIR_NAME) + ), + RebuildDecision::ChangedSinceLastBuild, + "absent builder stamp must read as stale" + ); +} + +/// A degraded index (warnings in meta, current builder version) rebuilds +/// exactly once per serve process: the second evaluation is Fresh (no loop +/// while the environment stays broken); a fresh process gets a fresh set. +#[test] +#[serial] +fn evaluate_retries_a_degraded_index_once_per_process() { + let (_env, _h, _tmp, repo_path, state) = gate_fixture( + "degraded", + &[( + crate::constants::SCIP_INDEX_BUILDER_VERSION_KEY, + crate::constants::INDEX_BUILDER_VERSION, + )], + ); + let db = repo_path.join(DB_DIR_NAME); + // Re-seed WITH warnings (the fixture seeded only the version stamp). + seed_scip_meta( + &db, + &[( + crate::constants::SCIP_INDEX_WARNINGS_KEY, + r#"["Broken.csproj: Msbuild failed when processing the file"]"#, + )], + ); + + assert_eq!( + state.evaluate_symbol_rebuild("csharp", "degraded", &repo_path, &db), + RebuildDecision::ChangedSinceLastBuild, + "a degraded index must get its one automatic retry" + ); + assert_eq!( + state.evaluate_symbol_rebuild("csharp", "degraded", &repo_path, &db), + RebuildDecision::Fresh, + "the retry must not loop within one serve process" + ); +} + +/// A clean index with the current builder stamp and fresh timestamps stays +/// Fresh — the gate must not churn indexes that are actually fine. +#[test] +#[serial] +fn evaluate_stays_fresh_when_index_is_current_and_clean() { + let (_env, _h, _tmp, repo_path, state) = gate_fixture( + "cleanidx", + &[( + crate::constants::SCIP_INDEX_BUILDER_VERSION_KEY, + crate::constants::INDEX_BUILDER_VERSION, + )], + ); + + assert_eq!( + state.evaluate_symbol_rebuild( + "csharp", + "cleanidx", + &repo_path, + &repo_path.join(DB_DIR_NAME) + ), + RebuildDecision::Fresh, + "current + clean + fresh timestamps must not rebuild" + ); + assert!( + !state.degraded_rebuild_attempted.contains("cleanidx"), + "a clean index must not consume the degraded retry" + ); +} + +// --------------------------------------------------------------------------- +// Queue-backlog regressions: tracked index tasks, stale-marker liveness, +// deferred DB cleanup. +// --------------------------------------------------------------------------- + +/// Age `alias`'s Reindex marker past the stale threshold. +fn aged_marker(state: &ServeState, alias: &str) { + state + .active_reindexes + .entry(alias.to_string()) + .or_default() + .insert( + IndexingOwner::Reindex, + Instant::now() - Duration::from_secs(MAX_INDEXING_SECS * 2), + ); +} + +/// A handle whose task has already completed (the handle is kept, not awaited). +async fn finished_handle() -> tokio::task::JoinHandle<()> { + let handle = tokio::spawn(async {}); + while !handle.is_finished() { + tokio::task::yield_now().await; + } + handle +} + +fn tracked_task(handle: tokio::task::JoinHandle<()>, db_path: std::path::PathBuf) -> IndexTask { + IndexTask { + handle, + token: CancellationToken::new(), + db_path, + started_at: Instant::now(), + } +} + +#[tokio::test] +#[serial] +async fn stale_marker_with_live_task_is_renewed_not_cancelled() { + // Regression: a reindex task queued behind the process-wide job gate can + // outlive MAX_INDEXING_SECS without being a leak. Evicting its marker and + // cancelling the task cancels healthy queued work whenever a backlog + // outlives the threshold. + let state = Arc::new(ServeState::new(ReposConfig::default(), None)); + let alias = "live-task-repo"; + let handle = tokio::spawn(async { std::future::pending::<()>().await }); + let token = CancellationToken::new(); + state.index_tasks.insert( + alias.to_string(), + IndexTask { + handle, + token: token.clone(), + db_path: std::path::PathBuf::from("/nonexistent-db"), + started_at: Instant::now(), + }, + ); + + aged_marker(&state, alias); + assert!( + !state.begin_indexing(alias, IndexingOwner::Reindex), + "a live task must block a second run even with a stale marker" + ); + + // A stale marker owned by another flow (Watcher) carries no liveness + // evidence of its own and must still be evicted, even while the index + // task lives. + state + .active_reindexes + .entry(alias.to_string()) + .or_default() + .insert( + IndexingOwner::Watcher, + Instant::now() - Duration::from_secs(MAX_INDEXING_SECS * 2), + ); + aged_marker(&state, alias); + assert!( + state.is_indexing(alias), + "a live task must keep reporting indexing" + ); + assert!( + state + .active_reindexes + .get(alias) + .is_some_and(|owners| !owners.contains_key(&IndexingOwner::Watcher)), + "a stale non-Reindex marker must still be evicted" + ); + assert!( + !token.is_cancelled(), + "the marker check must never cancel a live task" + ); + let renewed = state + .active_reindexes + .get(alias) + .and_then(|owners| owners.get(&IndexingOwner::Reindex).copied()) + .expect("the marker must survive the check"); + assert!( + Instant::now().duration_since(renewed) < Duration::from_secs(5), + "a live marker must be renewed, not evicted" + ); + + { + let entry = state.index_tasks.get(alias); + if let Some(entry) = entry { + entry.value().handle.abort(); + } + } +} + +#[tokio::test] +#[serial] +async fn stale_marker_without_live_task_is_evicted_and_entry_reaped() { + let state = Arc::new(ServeState::new(ReposConfig::default(), None)); + let alias = "dead-task-repo"; + let handle = finished_handle().await; + state.index_tasks.insert( + alias.to_string(), + tracked_task(handle, std::path::PathBuf::from("/nonexistent-db")), + ); + aged_marker(&state, alias); + + assert!( + !state.is_indexing(alias), + "with no live task the stale marker must be evicted" + ); + assert!( + !state.index_tasks.contains_key(alias), + "the finished entry must be reaped" + ); + assert!( + !state.active_reindexes.contains_key(alias), + "the evicted marker must be cleaned up" + ); +} + +#[tokio::test] +#[serial] +async fn sweeper_reaps_finished_unregistered_task_and_cleans_db() { + let tmp = tempfile::tempdir().unwrap(); + let db_path = tmp.path().join("gone-repo").join(DB_DIR_NAME); + std::fs::create_dir_all(&db_path).unwrap(); + std::fs::write(db_path.join("metadata.json"), b"{}").unwrap(); + + let state = Arc::new(ServeState::new(ReposConfig::default(), None)); + let handle = finished_handle().await; + state.index_tasks.insert( + "gone-repo".to_string(), + tracked_task(handle, db_path.clone()), + ); + state + .active_reindexes + .entry("gone-repo".to_string()) + .or_default() + .insert(IndexingOwner::Reindex, Instant::now()); + + state.sweep_index_tasks(); + + assert!(!state.index_tasks.contains_key("gone-repo")); + assert!(!db_path.exists(), "the orphaned DB dir must be deleted"); + assert!(!state.active_reindexes.contains_key("gone-repo")); +} + +#[tokio::test] +#[serial] +async fn await_index_task_timeout_keeps_task_tracked() { + // Regression: the old code removed the entry before waiting and dropped + // the handle on timeout, making the detached task invisible while it held + // its stores and the job permit. + let state = Arc::new(ServeState::new(ReposConfig::default(), None)); + let alias = "parked-task"; + let token = CancellationToken::new(); + let handle = tokio::spawn(async { std::future::pending::<()>().await }); + state.index_tasks.insert( + alias.to_string(), + IndexTask { + handle, + token: token.clone(), + db_path: std::path::PathBuf::from("/nonexistent-db"), + started_at: Instant::now(), + }, + ); + + let exited = state + .await_index_task_with_budget(alias, Duration::from_millis(50)) + .await; + assert!(!exited, "a parked task cannot exit within the budget"); + assert!( + state.index_tasks.contains_key(alias), + "the task must stay tracked — never invisible" + ); + assert!(token.is_cancelled(), "cancellation must still be signalled"); + + { + let entry = state.index_tasks.get(alias); + if let Some(entry) = entry { + entry.value().handle.abort(); + } + } +} + +#[tokio::test] +#[serial] +async fn await_index_task_returns_true_when_task_exits() { + let state = Arc::new(ServeState::new(ReposConfig::default(), None)); + let handle = tokio::spawn(async {}); + state.index_tasks.insert( + "quick-task".to_string(), + tracked_task(handle, std::path::PathBuf::from("/nonexistent-db")), + ); + assert!( + state + .await_index_task_with_budget("quick-task", Duration::from_secs(5)) + .await + ); + assert!(!state.index_tasks.contains_key("quick-task")); +} + +#[tokio::test] +#[serial] +async fn remove_repo_defers_db_delete_while_index_task_is_still_running() { + // Regression: deleting the DB dir under a live (uninterruptible) index + // task is what can wedge a hub — the task never reaches a cancellation + // point and keeps its stores and the job permit for the process lifetime. + let (_tmp, repo_path, state) = state_with_repo("slowrepo"); + let db_path = repo_path.join(DB_DIR_NAME); + std::fs::create_dir_all(&db_path).unwrap(); + std::fs::write(db_path.join("data.mdb"), "fake").unwrap(); + + // A task that ignores cancellation entirely, like a parked build. + let token = CancellationToken::new(); + let handle = tokio::spawn(async { std::future::pending::<()>().await }); + state.index_tasks.insert( + "slowrepo".to_string(), + IndexTask { + handle, + token, + db_path: db_path.clone(), + started_at: Instant::now(), + }, + ); + + let outcome = state + .remove_repo_with_budget("slowrepo", Duration::from_millis(100)) + .await + .expect("remove_repo should succeed"); + + assert!( + !outcome.db_deleted, + "the DB dir must NOT be deleted out from under a live task" + ); + assert!(db_path.exists(), "the dir stays until the task exits"); + assert!( + state.index_tasks.contains_key("slowrepo"), + "the running task must stay tracked for the sweeper" + ); + + // Simulate the task finally exiting (aborted here; a real one would run + // its post-build guard): the sweeper is the backstop that reaps the entry + // and deletes the orphaned dir. + if let Some(entry) = state.index_tasks.get("slowrepo") { + entry.value().handle.abort(); + } + loop { + let finished = state + .index_tasks + .get("slowrepo") + .is_some_and(|entry| entry.value().handle.is_finished()); + if finished { + break; + } + tokio::task::yield_now().await; + } + state.sweep_index_tasks(); + + assert!(!state.index_tasks.contains_key("slowrepo")); + assert!( + !db_path.exists(), + "the sweeper must clean the orphaned DB dir" + ); +} + +#[tokio::test] +#[serial] +async fn sweeper_reasserts_cancellation_for_a_removed_live_task() { + let state = Arc::new(ServeState::new(ReposConfig::default(), None)); + let token = CancellationToken::new(); + let handle = tokio::spawn(async { std::future::pending::<()>().await }); + state.index_tasks.insert( + "removed-repo".to_string(), + IndexTask { + handle, + token: token.clone(), + db_path: std::path::PathBuf::from("/nonexistent-db"), + started_at: Instant::now(), + }, + ); + + state.sweep_index_tasks(); + + assert!( + token.is_cancelled(), + "a removed repo's live task must have cancellation re-asserted" + ); + assert!( + state.index_tasks.contains_key("removed-repo"), + "a live task must stay tracked until it exits" + ); + + { + let entry = state.index_tasks.get("removed-repo"); + if let Some(entry) = entry { + entry.value().handle.abort(); + } + } +} diff --git a/src/serve/tui.rs b/src/serve/tui.rs index 497051f7..5a3b4a94 100644 --- a/src/serve/tui.rs +++ b/src/serve/tui.rs @@ -7,7 +7,7 @@ use std::io; use std::sync::Arc; -use std::time::Duration; +use std::time::{Duration, Instant}; use ratatui::backend::CrosstermBackend; use ratatui::layout::{Constraint, Layout}; @@ -21,7 +21,7 @@ use tokio_util::sync::CancellationToken; use super::tui_common::{ self, KeyAction, OverlayKeyAction, OverlayState, RemoteIndexStats, RemoteStatsState, RepoRow, }; -use super::{IndexingOwner, ServeState}; +use super::{IndexTask, IndexingOwner, ServeState}; use crate::cli::doctor; use crate::constants::{DB_DIR_NAME, LANG_CSHARP, LANG_TYPESCRIPT}; use crate::index::IndexManager; @@ -282,6 +282,11 @@ async fn run_tui_loop( if let Some(action) = tui_common::handle_overlay_key(key, ov) { match action { OverlayKeyAction::Dismiss => overlay = None, + OverlayKeyAction::CopyWarnings => { + if let Some(ov) = overlay.as_mut() { + tui_common::apply_copy_warnings(ov); + } + } OverlayKeyAction::ConfirmRemove => { if let Some(OverlayState::ConfirmRemove { alias }) = overlay.take() { @@ -444,6 +449,7 @@ fn map_repo_rows( let csharp_str = match info.csharp_index { super::CSharpIndexStatus::Ready => "ready", + super::CSharpIndexStatus::Partial => "partial", super::CSharpIndexStatus::Indexing => "indexing", super::CSharpIndexStatus::Error => "error", super::CSharpIndexStatus::None => "none", @@ -452,6 +458,7 @@ fn map_repo_rows( let ts_str = match info.typescript_index { super::CSharpIndexStatus::Ready => "ready", + super::CSharpIndexStatus::Partial => "partial", super::CSharpIndexStatus::Indexing => "indexing", super::CSharpIndexStatus::Error => "error", super::CSharpIndexStatus::None => "none", @@ -736,8 +743,30 @@ fn cpu_usage_str(sys_system: &mut Option) -> String { // Info overlay builder // --------------------------------------------------------------------------- +/// Humanize a symbol-index age (seconds) for the Info overlay; the +/// `u64::MAX` sentinel `index_age` returns for an unreadable index renders +/// as "unknown age", never as a number. +pub(crate) fn human_age_seconds(secs: u64) -> String { + if secs == u64::MAX { + return "unknown age".to_string(); + } + if secs < 60 { + return format!("{secs}s"); + } + let mins = secs / 60; + if mins < 60 { + return format!("{mins}m"); + } + let hours = mins / 60; + if hours < 48 { + return format!("{hours}h"); + } + format!("{}d", hours / 24) +} + /// Build an `OverlayState::Info` by gathering live stats from SharedStores or metadata. -fn build_info_overlay( +/// pub(crate) so the serve test module can pin the symbol-warnings wiring. +pub(crate) fn build_info_overlay( idx: usize, repos: &[(String, super::RepoStatusInfo)], state: &Arc, @@ -808,6 +837,13 @@ fn build_info_overlay( // DB size on disk let db_size_human = dir_size_human(&db_path); + // Durable symbol-index warnings, read fresh from the on-disk meta + // (shared with the REST info surface so the two cannot drift). + let symbol_warnings = state.collect_symbol_warnings(&db_path); + // Per-language symbol-index status — the shared collector, so the TUI, + // REST info and find_impact answers cannot disagree. + let symbol_index = state.collect_symbol_index_status(&project_path, &db_path); + Some(OverlayState::Info { alias: alias.clone(), path: db_path.display().to_string(), @@ -819,6 +855,9 @@ fn build_info_overlay( dims, lock, index_age, + symbol_warnings, + symbol_index, + copy_feedback: None, }) } @@ -1157,6 +1196,9 @@ pub(crate) fn spawn_force_reindex(alias: String, state: &Arc) -> Rei // `index_tasks` so `remove_repo` can cancel + await it (BUG1). let reindex_token = CancellationToken::new(); let reindex_token_task = reindex_token.clone(); + // The task closure moves `db_path`; keep a copy for the tracked entry so a + // removed repo's DB dir can be cleaned up after the task exits. + let task_db_path = db_path.clone(); let handle = tokio::spawn(async move { tracing::info!( "TUI: Force reindex for '{}': clearing stores and reindexing", @@ -1216,7 +1258,15 @@ pub(crate) fn spawn_force_reindex(alias: String, state: &Arc) -> Rei // Remove guard state_bg.end_indexing(&alias_bg, IndexingOwner::Reindex); }); - state.index_tasks.insert(alias, (handle, reindex_token)); + state.index_tasks.insert( + alias, + IndexTask { + handle, + token: reindex_token, + db_path: task_db_path, + started_at: Instant::now(), + }, + ); ReindexLaunch::Started } diff --git a/src/serve/tui_common.rs b/src/serve/tui_common.rs index d098a3e7..1ead4d25 100644 --- a/src/serve/tui_common.rs +++ b/src/serve/tui_common.rs @@ -10,8 +10,8 @@ use ratatui::layout::{Constraint, Layout, Margin, Rect}; use ratatui::style::{Color, Modifier, Style}; -use ratatui::text::{Line, Span}; -use ratatui::widgets::{Block, Borders, Cell, Row, Table, TableState}; +use ratatui::text::{Line, Span, Text}; +use ratatui::widgets::{Block, Borders, Cell, Row, Table, TableState, Wrap}; /// Format elapsed time since `started_at` as "Up xxd xxh xxm xxs". /// Omits days/hours/minutes when zero. @@ -52,7 +52,8 @@ use crossterm::event::{KeyCode, KeyEvent}; #[derive(Debug, Clone)] pub struct RepoRow { pub alias: String, - /// Human-readable status: "open", "warm", "readonly", "idle", "indexing", "error", "no_index" + /// Human-readable status: "open", "warm", "readonly", "idle" (wire "idle"/"closed": + /// index on disk, repo unloaded — resting, not indexing), "indexing", "error", "no_index" pub status: String, /// C# index status: "none", "ready", "indexing", "error" (empty also treated as none) pub csharp_index: String, @@ -148,6 +149,19 @@ pub enum OverlayState { dims: usize, lock: String, index_age: String, + /// Index-level symbol warnings read fresh from the on-disk meta + /// (`scip_meta[index_warnings]`): build-environment failures the + /// helper survived. Unlike the in-memory C# status these survive a + /// serve restart — the durable record of a degraded index. + symbol_warnings: Vec, + /// Per-language symbol-index status (ready/degraded/stale/ + /// restore-pending/absent/not-applicable) — the shared + /// [`crate::symbols::symbol_index_status`] collector, so the TUI, + /// REST info and find_impact answers cannot disagree. + symbol_index: Vec, + /// Transient result of the `c` (copy warnings) key, shown as the + /// overlay's last content line until it closes. + copy_feedback: Option, }, /// Info modal for a *mounted remote project* (federation peer). Remote /// mounts have no local on-disk index, so the chunk/file/db-size/model stats @@ -240,12 +254,15 @@ pub enum OverlayKeyAction { Dismiss, /// Confirm the removal action (Enter or 'y' pressed on a ConfirmRemove overlay). ConfirmRemove, + /// Copy the Info overlay's symbol warnings to the OS clipboard ('c'). + CopyWarnings, } /// Handle key events when an overlay is active. /// /// - `Esc` always dismisses. /// - `Enter` or `'y'` confirms a `ConfirmRemove` overlay. +/// - `'c'` copies the symbol warnings of an `Info` overlay. /// - All other keys are ignored (returns `None`). pub fn handle_overlay_key(key: KeyEvent, overlay: &OverlayState) -> Option { match key.code { @@ -257,10 +274,139 @@ pub fn handle_overlay_key(key: KeyEvent, overlay: &OverlayState) -> Option { + if matches!(overlay, OverlayState::Info { .. }) { + Some(OverlayKeyAction::CopyWarnings) + } else { + None + } + } _ => None, } } +// --------------------------------------------------------------------------- +// Copy-to-clipboard (Info overlay's `c` key) +// --------------------------------------------------------------------------- + +/// The text the Info overlay's `c` key puts on the clipboard: a header +/// naming the repo, then every stored warning line verbatim — the copy is +/// the escape hatch for lines the terminal cannot fit, so it must carry +/// everything the index recorded. +pub fn symbol_warnings_copy_text(alias: &str, warnings: &[String]) -> String { + let mut out = format!("{alias} — symbol index warnings ({}):", warnings.len()); + for warning in warnings { + out.push('\n'); + out.push_str(warning); + } + out +} + +/// Best-effort OS clipboard write with no new dependency: spawn the +/// platform helper with the text on stdin. `Err` carries the reason so the +/// overlay can show it — a silent no-op copy would read as success. +pub fn copy_text_to_clipboard(text: &str) -> Result<(), String> { + use std::io::Write; + use std::process::{Child, Command, Stdio}; + + fn spawn_helper(program: &str, args: &[&str]) -> Result { + Command::new(program) + .args(args) + .stdin(Stdio::piped()) + .stdout(Stdio::null()) + .stderr(Stdio::null()) + .spawn() + .map_err(|e| format!("{program}: {e}")) + } + + fn spawn_clipboard_helper() -> Result { + #[cfg(windows)] + { + // clip.exe decodes stdin with the OEM code page and would + // mangle the em-dashes/ellipses the warning lines carry; + // Set-Clipboard with an explicit UTF-8 stdin does not. + spawn_helper( + "powershell", + &[ + "-NoProfile", + "-Command", + "[Console]::InputEncoding = [System.Text.Encoding]::UTF8; $input | Set-Clipboard", + ], + ) + } + #[cfg(target_os = "macos")] + { + spawn_helper("pbcopy", &[]) + } + #[cfg(all(unix, not(target_os = "macos")))] + { + // No single standard clipboard tool on Linux: try the common + // three in order and surface which (if any) is missing. + let candidates: &[(&str, &[&str])] = &[ + ("wl-copy", &[]), + ("xclip", &["-selection", "clipboard"]), + ("xsel", &["--clipboard", "--input"]), + ]; + let mut last_err = String::from("no clipboard tool found (tried wl-copy, xclip, xsel)"); + for (program, args) in candidates { + match spawn_helper(program, args) { + Ok(child) => return Ok(child), + Err(e) => last_err = e, + } + } + Err(last_err) + } + } + + let mut child = spawn_clipboard_helper()?; + if let Some(mut stdin) = child.stdin.take() { + // The write must not block the TUI's event loop: every helper + // above exits right after stdin reaches EOF. + stdin + .write_all(text.as_bytes()) + .map_err(|e| format!("write stdin: {e}"))?; + } + let status = child.wait().map_err(|e| format!("wait: {e}"))?; + if status.success() { + Ok(()) + } else { + Err(format!("clipboard helper exited with {status}")) + } +} + +/// Handle `OverlayKeyAction::CopyWarnings`: copy the Info overlay's symbol +/// warnings to the OS clipboard and record the outcome as the overlay's +/// feedback line. Shared by both TUI event loops. +pub fn apply_copy_warnings(overlay: &mut OverlayState) { + apply_copy_warnings_with(overlay, copy_text_to_clipboard); +} + +/// The [`apply_copy_warnings`] logic with the clipboard write injected, so +/// tests can pin both outcome feedback lines without touching the real OS +/// clipboard (which would be a machine side effect, not an assertion). +pub(crate) fn apply_copy_warnings_with( + overlay: &mut OverlayState, + clipboard: impl Fn(&str) -> Result<(), String>, +) { + if let OverlayState::Info { + alias, + symbol_warnings, + copy_feedback, + .. + } = overlay + { + *copy_feedback = if symbol_warnings.is_empty() { + Some("no symbol warnings recorded".to_string()) + } else { + let text = symbol_warnings_copy_text(alias, symbol_warnings); + match clipboard(&text) { + Ok(()) => Some("✓ symbol warnings copied to clipboard".to_string()), + Err(e) => Some(format!("copy failed: {e}")), + } + }; + } +} + // --------------------------------------------------------------------------- // Rendering — shared between embedded and remote TUI // --------------------------------------------------------------------------- @@ -316,6 +462,48 @@ pub fn render_header( f.render_widget(ratatui::widgets::Paragraph::new(title_line), centered[0]); } +/// The C# alias-column indicator: `(glyph, style)` when the status carries +/// one. Color belongs to the indicator only — degraded (warnings) reads as +/// yellow ⚠, a general error as fully red `!` — so a table full of +/// warnings-degraded repos does not read as half the fleet being down. +pub fn csharp_indicator(status: &str, pulse: bool) -> Option<(&'static str, Style)> { + match status { + "ready" => Some((" C#·", Style::default().fg(Color::White))), + "partial" => Some((" C#⚠", Style::default().fg(Color::Yellow))), + "error" => Some(( + " C#!", + Style::default().fg(Color::Red).add_modifier(Modifier::BOLD), + )), + "indexing" => { + let style = if pulse { + Style::default() + .fg(Color::Yellow) + .add_modifier(Modifier::BOLD) + } else { + Style::default().fg(Color::DarkGray) + }; + Some((" C#…", style)) + } + _ => None, + } +} + +/// The TypeScript alias-column indicator — same severity language as the C# +/// one (`ts_indicator("partial")` is yellow; TS has no live Partial source +/// yet, but the shared vocabulary must already agree). +pub fn ts_indicator(status: &str) -> Option<(&'static str, Style)> { + match status { + "ready" => Some((" TS·", Style::default().fg(Color::White))), + "partial" => Some((" TS⚠", Style::default().fg(Color::Yellow))), + "error" => Some(( + " TS!", + Style::default().fg(Color::Red).add_modifier(Modifier::BOLD), + )), + "indexing" => Some((" TS…", Style::default().fg(Color::DarkGray))), + _ => None, + } +} + pub fn render_table( f: &mut ratatui::Frame, area: Rect, @@ -341,14 +529,10 @@ pub fn render_table( let max_alias_w = repos .iter() .map(|r| { - // Each indicator (" C#·" / " TS·") is 4 display cols; account for both. - let mut extra = 0usize; - if matches!(r.csharp_index.as_str(), "ready" | "error" | "indexing") { - extra += 4; - } - if matches!(r.typescript_index.as_str(), "ready" | "error" | "indexing") { - extra += 4; - } + // Each indicator is a suffix like " C#·"; ⚠ (the partial glyph) + // is double-width (unicode-width EAW=W) so its variant budgets + // 6 display cols instead of 4. + let extra = indicator_cols(&r.csharp_index) + indicator_cols(&r.typescript_index); r.alias.len() + extra }) .max() @@ -384,57 +568,30 @@ pub fn render_table( }; let lock_cell = lock_cell(&repo.lock_mode); - // Alias text with optional C# indicator suffix, plus its base style. - let (mut alias_text, mut alias_style) = match repo.csharp_index.as_str() { - "ready" => ( - format!("{} C#·", repo.alias), - Style::default().fg(Color::White), - ), - "error" => ( - format!("{} C#!", repo.alias), - Style::default().fg(Color::Red), - ), - "indexing" => { - let s = if pulse_bright() { - Style::default() - .fg(Color::Yellow) - .add_modifier(Modifier::BOLD) - } else { - Style::default().fg(Color::DarkGray) - }; - (format!("{} C#…", repo.alias), s) - } - _ => (repo.alias.clone(), Style::default().fg(Color::White)), + // Alias text stays NEUTRAL — color lives only on the language + // indicators: yellow ⚠ for a degraded (warnings) index, fully red + // ! for a general error. A table with red aliases reads as half + // the fleet being down, which a warnings-degraded index is not. + let base_alias_style = if repo.is_remote { + Style::default() + .fg(Color::Cyan) + .add_modifier(Modifier::ITALIC) + } else { + Style::default().fg(Color::White) }; + let mut alias_spans: Vec = + vec![Span::styled(repo.alias.clone(), base_alias_style)]; - // Append the TypeScript indicator alongside the C# one when a TS - // index exists. The alias column is the canonical multi-language - // symbol-index indicator (the status cell only carries C#). - match repo.typescript_index.as_str() { - "ready" => alias_text.push_str(" TS·"), - "error" => { - alias_text.push_str(" TS!"); - alias_style = alias_style.fg(Color::Red); - } - "indexing" => alias_text.push_str(" TS…"), - _ => {} + if let Some((glyph, style)) = + csharp_indicator(repo.csharp_index.as_str(), pulse_bright()) + { + alias_spans.push(Span::styled(glyph, style)); } - - // Red bold alias if the repo is in an error state. - if repo.status == "error" { - alias_style = Style::default().fg(Color::Red).add_modifier(Modifier::BOLD); + if let Some((glyph, style)) = ts_indicator(repo.typescript_index.as_str()) { + alias_spans.push(Span::styled(glyph, style)); } - // Mounted remote projects render italic to signal they live on a - // peer (cyan unless an error already claimed the color). - if repo.is_remote { - alias_style = alias_style.add_modifier(Modifier::ITALIC); - if repo.status != "error" { - alias_style = alias_style.fg(Color::Cyan); - } - } - - let alias_cell = Cell::from(alias_text).style(alias_style); + let alias_cell = Cell::from(Text::from(Line::from(alias_spans))); Row::new(vec![ alias_cell, @@ -515,17 +672,12 @@ pub fn render_detail( repo.path.clone() }; - // Mounted remote projects show italic here too (matches the table): cyan - // normally, red when in error state so the color stays consistent with the - // table's error highlight. Local rows are unchanged (white bold). + // Mounted remote projects show italic here too (matches the table): cyan, + // never red — alias text stays neutral on every surface; the status line + // below carries the error severity. Local rows are unchanged (white bold). let alias_style = if repo.is_remote { - let color = if repo.status == "error" { - Color::Red - } else { - Color::Cyan - }; Style::default() - .fg(color) + .fg(Color::Cyan) .add_modifier(Modifier::BOLD | Modifier::ITALIC) } else { Style::default() @@ -592,8 +744,8 @@ pub fn render_detail( let info_line = Line::from(info_spans); - // Optional error line for C# errors - let error_line = if repo.csharp_index == "error" { + // Optional error line for C# errors and degraded (partial) indexes + let error_line = if matches!(repo.csharp_index.as_str(), "error" | "partial") { let err_msg = repo.csharp_error.as_deref().unwrap_or("Unknown error"); const ERR_PREFIX_COLS: usize = 7; let max_err_chars = (area.width as usize).saturating_sub(ERR_PREFIX_COLS); @@ -806,6 +958,9 @@ pub fn render_overlay(f: &mut ratatui::Frame, area: Rect, overlay: &OverlayState dims, lock, index_age, + symbol_warnings, + symbol_index, + copy_feedback, } => { let title = format!(" {} — Index Info ", alias); let lines = vec![ @@ -855,13 +1010,76 @@ pub fn render_overlay(f: &mut ratatui::Frame, area: Rect, overlay: &OverlayState Span::styled(" Index age: ", Style::default().fg(Color::DarkGray)), Span::styled(index_age.clone(), Style::default().fg(Color::White)), ]), - Line::from(""), - Line::from(Span::styled( - " [Esc] close", - Style::default().fg(Color::DarkGray), - )), ]; - render_centered_modal(f, area, &title, lines); + let mut lines = lines; + // Per-language symbol-index status — the same shared collector + // find_impact answers carry. The chunk stats above say nothing + // about the SCIP index; this line-up does. + if !symbol_index.is_empty() { + lines.push(Line::from("")); + lines.push(Line::from(Span::styled( + " Symbol index:", + Style::default() + .fg(Color::Cyan) + .add_modifier(Modifier::BOLD), + ))); + for status in symbol_index { + let (color, note) = match status.state.as_str() { + "ready" => (Color::Green, ""), + "degraded" => (Color::Red, " (incomplete — see warnings)"), + "stale" => ( + Color::Yellow, + " (another build produced it; rebuild queued)", + ), + "restore-pending" => (Color::Yellow, " (waiting out a NuGet restore)"), + _ => (Color::DarkGray, ""), + }; + lines.push(Line::from(Span::styled( + format!( + " {}: {} · {}{}", + status.language, + status.state, + super::tui::human_age_seconds(status.age_seconds), + note + ), + Style::default().fg(color), + ))); + } + } + // Durable record of a degraded symbol index: the build problems + // the helper survived. Red — the table's `C#⚠` indicator is + // yellow (degraded-index semantics stay the stronger red here). + if !symbol_warnings.is_empty() { + lines.push(Line::from("")); + lines.push(Line::from(Span::styled( + " ⚠ Symbol index warnings:", + Style::default().fg(Color::Red).add_modifier(Modifier::BOLD), + ))); + for warning in symbol_warnings { + lines.push(Line::from(Span::styled( + format!(" {warning}"), + Style::default().fg(Color::Red), + ))); + } + } + if let Some(note) = copy_feedback { + lines.push(Line::from("")); + lines.push(Line::from(Span::styled( + format!(" {note}"), + Style::default().fg(Color::Green), + ))); + } + // The footer rides the border's bottom title: wrapped warning + // text can outgrow the terminal, and the key hints must stay + // visible when the content above is clipped. + render_centered_modal_with_footer( + f, + area, + &title, + Some(" [Esc] close · [c] copy warnings "), + lines, + Color::Cyan, + ); } OverlayState::RemoteInfo { alias, @@ -1046,7 +1264,7 @@ pub fn render_overlay(f: &mut ratatui::Frame, area: Rect, overlay: &OverlayState /// Render a centered modal with a title and content lines. /// Uses the default cyan border/title color; delegates to -/// [`render_centered_modal_with_border_color`]. +/// [`render_centered_modal_with_footer`]. pub fn render_centered_modal( f: &mut ratatui::Frame, area: Rect, @@ -1065,10 +1283,76 @@ pub fn render_centered_modal_with_border_color( lines: Vec>, border_color: Color, ) { - let content_height = lines.len() as u16 + 2; // +2 for border + render_centered_modal_with_footer(f, area, title, None, lines, border_color); +} + +/// Wrapped-row count `content` needs at `inner_width`, mirroring ratatui's +/// greedy word wrapper (`Wrap { trim: false }`): the line's leading indent +/// and the separators between words occupy real columns on the current row, +/// words that do not fit start a new row, a word longer than the row +/// hard-splits, every line takes at least one row. A naive char ceiling +/// UNDERSHOOTS — a row that breaks early at a word boundary pushes its +/// remainder onto an extra row, and dropped indent columns do the same. +pub(crate) fn estimate_wrapped_height(content: &[Line<'_>], inner_width: u16) -> u16 { + let w = inner_width.max(1) as usize; + let mut total: u16 = 0; + for line in content { + let text: String = line.spans.iter().map(|s| s.content.as_ref()).collect(); + let chars: Vec = text.chars().collect(); + // trim: false preserves the leading indent on the first row. + let mut i = chars.iter().take_while(|c| **c == ' ').count(); + let mut col = i; + let mut rows: u16 = 1; + while i < chars.len() { + let mut sep = 0usize; + while i < chars.len() && chars[i] == ' ' { + sep += 1; + i += 1; + } + if i >= chars.len() { + break; + } + let start = i; + while i < chars.len() && chars[i] != ' ' { + i += 1; + } + let len = i - start; + if col == 0 { + // The word starts on a fresh row: only hard splits add rows. + col = len; + } else if col + sep + len <= w { + col += sep + len; + } else { + rows += 1; + col = len; + } + while col > w { + rows += 1; + col -= w; + } + } + total += rows; + } + total +} + +/// Render a centered modal with a title, content lines, an optional footer +/// (drawn as the block's bottom border title so it survives clipping) and a +/// custom border color. Content wraps instead of clipping at the modal +/// edge: warning lines routinely carry URLs wider than the terminal. +pub fn render_centered_modal_with_footer( + f: &mut ratatui::Frame, + area: Rect, + title: &str, + footer: Option<&str>, + lines: Vec>, + border_color: Color, +) { let max_line_w = lines.iter().map(|l| l.width() as u16).max().unwrap_or(20); let title_w = title.len() as u16; - let content_width = (max_line_w + 4).max(title_w + 4).max(30); + let content_width = (max_line_w + 4).max(title_w + 4).max(30).min(area.width); + + let content_height = estimate_wrapped_height(&lines, content_width.saturating_sub(2)) + 2; // +2 for border // Center the modal let modal_area = Rect { @@ -1099,10 +1383,16 @@ pub fn render_centered_modal_with_border_color( .add_modifier(Modifier::BOLD), )) .style(Style::default().bg(Color::Rgb(20, 20, 35))); + let block = match footer { + Some(footer) => { + block.title_bottom(Span::styled(footer, Style::default().fg(Color::DarkGray))) + } + None => block, + }; let inner = block.inner(modal_area); f.render_widget(block, modal_area); - let content = ratatui::widgets::Paragraph::new(lines); + let content = ratatui::widgets::Paragraph::new(lines).wrap(Wrap { trim: false }); f.render_widget(content, inner); } @@ -1272,6 +1562,7 @@ fn detail_status_style(status: &str, csharp: &str) -> (String, Color) { }, ), "error" => ("Open C#!".to_string(), Color::Red), + "partial" => ("Open C#⚠".to_string(), Color::Yellow), _ => ("Open".to_string(), Color::Green), }, "warm" => match csharp { @@ -1285,6 +1576,7 @@ fn detail_status_style(status: &str, csharp: &str) -> (String, Color) { }, ), "error" => ("Warm C#!".to_string(), Color::Red), + "partial" => ("Warm C#⚠".to_string(), Color::Yellow), _ => ("Warm".to_string(), Color::Yellow), }, "readonly" => ("Readonly".to_string(), Color::Cyan), @@ -1313,6 +1605,17 @@ fn detail_status_style(status: &str, csharp: &str) -> (String, Color) { } } +/// Display width of one alias-column indicator suffix (`" C#·"` family). +/// The partial glyph ⚠ is double-width (unicode-width EAW=W), so that +/// variant budgets 6 display cols; the 1-col glyphs budget 4. +fn indicator_cols(status: &str) -> usize { + match status { + "ready" | "error" | "indexing" => 4, + "partial" => 6, + _ => 0, + } +} + // --------------------------------------------------------------------------- // Terminal helpers // --------------------------------------------------------------------------- @@ -1334,7 +1637,7 @@ mod tests { use super::*; #[test] - fn status_cell_renders_idle_and_legacy_closed_as_gray() { + fn status_cell_renders_idle_and_legacy_closed_as_idle() { let expected = ( "○ idle ".to_string(), Style::default().fg(Color::Gray), @@ -1355,6 +1658,69 @@ mod tests { ); } + /// A degraded (partial) C# index renders YELLOW with the ⚠ glyph in the + /// detail panel — a warning, not an error; only a general error is red. + #[test] + fn detail_status_style_maps_partial_to_yellow_warning() { + assert_eq!( + detail_status_style("open", "partial"), + ("Open C#⚠".to_string(), Color::Yellow) + ); + assert_eq!( + detail_status_style("warm", "partial"), + ("Warm C#⚠".to_string(), Color::Yellow) + ); + assert_eq!( + detail_status_style("warm", "error").1, + Color::Red, + "a general error stays fully red" + ); + } + + /// Alias-column indicators: the alias text is styled by the caller and + /// stays neutral; degraded reads yellow, only a general error is red. + #[test] + fn alias_indicators_use_yellow_for_degraded_and_red_only_for_errors() { + let (glyph, style) = csharp_indicator("partial", false).unwrap(); + assert_eq!(glyph, " C#⚠"); + assert_eq!(style, Style::default().fg(Color::Yellow)); + + let (glyph, style) = csharp_indicator("error", false).unwrap(); + assert_eq!(glyph, " C#!"); + assert_eq!( + style, + Style::default().fg(Color::Red).add_modifier(Modifier::BOLD) + ); + + let (glyph, style) = ts_indicator("partial").unwrap(); + assert_eq!(glyph, " TS⚠"); + assert_eq!(style, Style::default().fg(Color::Yellow)); + + // The transient dim/pulse phase: indexing indicators must stay dim — + // an inherited bright style here once turned the whole alias red. + let (_, style) = csharp_indicator("indexing", false).unwrap(); + assert_eq!(style, Style::default().fg(Color::DarkGray)); + let (_, style) = ts_indicator("indexing").unwrap(); + assert_eq!(style, Style::default().fg(Color::DarkGray)); + } + + /// The alias-column width budget must cover the actually rendered + /// suffixes: the partial glyph ⚠ is double-width (EAW=W), so " C#⚠" is + /// 5 display cols — budgeting it at 4 (the 1-col glyph family) would + /// clip the ⚠ exactly when a partial row defines the widest alias. + #[test] + fn indicator_cols_budgets_double_width_partial_glyph() { + assert_eq!(indicator_cols("ready"), 4); + assert_eq!(indicator_cols("error"), 4); + assert_eq!(indicator_cols("indexing"), 4); + assert_eq!( + indicator_cols("partial"), + 6, + "double-width glyph needs more than the 4-col family budget" + ); + assert_eq!(indicator_cols("none"), 0); + } + #[test] fn unknown_status_falls_back_without_idle_treatment() { assert_ne!( diff --git a/src/serve/tui_remote.rs b/src/serve/tui_remote.rs index 6ca26da5..744daaf1 100644 --- a/src/serve/tui_remote.rs +++ b/src/serve/tui_remote.rs @@ -264,6 +264,11 @@ async fn run_remote_tui_loop( if let Some(action) = tui_common::handle_overlay_key(key, ov) { match action { OverlayKeyAction::Dismiss => overlay = None, + OverlayKeyAction::CopyWarnings => { + if let Some(ov) = overlay.as_mut() { + tui_common::apply_copy_warnings(ov); + } + } OverlayKeyAction::ConfirmRemove => { if let Some(OverlayState::ConfirmRemove { alias }) = overlay.take() { @@ -358,6 +363,9 @@ async fn run_remote_tui_loop( dims: info.dims, lock: info.lock, index_age: info.index_age, + symbol_warnings: info.symbol_warnings, + symbol_index: info.symbol_index, + copy_feedback: None, }, Err(e) => OverlayState::Doctor { alias, @@ -503,6 +511,14 @@ struct InfoResponse { dims: usize, lock: String, index_age: String, + /// Index-level symbol warnings from the peer's on-disk meta. `default` for + /// the same older-serve compatibility as `path`. + #[serde(default)] + symbol_warnings: Vec, + /// Per-language symbol-index status from the peer. `default` so a client + /// talking to an older serve still deserializes (renders no section). + #[serde(default)] + symbol_index: Vec, } #[derive(Debug, Deserialize)] diff --git a/src/symbols/csharp.rs b/src/symbols/csharp.rs index 8ad33fa2..b54c082e 100644 --- a/src/symbols/csharp.rs +++ b/src/symbols/csharp.rs @@ -61,6 +61,102 @@ pub(crate) fn is_helper_warning_line(line: &str) -> bool { line.contains("[WARN]") || line.contains("[Failure]") } +/// The version token out of the helper's `--version` line +/// ("scip-csharp 1.5.4" → "1.5.4"); anything unparseable → "unknown", which +/// still logs (as a mismatch against the host version) instead of silently +/// skipping the startup entry. +pub(super) fn parse_helper_version(version_line: &str) -> String { + version_line + .split_whitespace() + .last() + .filter(|tok| tok.chars().next().is_some_and(|c| c.is_ascii_digit())) + .unwrap_or("unknown") + .to_string() +} + +/// Cap a line at `max` chars, cutting at the last whitespace inside the +/// budget when there is one: a mid-word cut makes compilation-error +/// specimens (the quoted CS0103 name) unreadable. A single token longer +/// than the budget still takes the hard cap. +fn cap_at_whitespace_boundary(line: &str, max: usize) -> String { + let cut = line + .char_indices() + .nth(max) + .map(|(i, _)| i) + .unwrap_or(line.len()); + if cut == line.len() { + return line.to_string(); + } + match line[..cut].rfind(char::is_whitespace) { + Some(pos) => line[..pos].to_string(), + None => line[..cut].to_string(), + } +} + +/// Normalize one warning-severity helper stderr line into a concise, +/// index-level completeness warning entry. MSBuild project-load failures +/// (the class that silently strips cross-project references from the index) +/// collapse to `: `; anything else passes through +/// trimmed. `None` for non-warning lines. +pub(crate) fn normalize_index_warning_line(line: &str) -> Option { + if !is_helper_warning_line(line) { + return None; + } + // "[WARN] Workspace error: [Failure] Msbuild failed when processing the + // file '' with message: " → ": " + if let Some((_, rest)) = line.split_once("Msbuild failed when processing the file '") { + if let Some((path, tail)) = rest.split_once('\'') { + let file = path.rsplit(['/', '\\']).next().unwrap_or(path); + let msg = tail + .split_once("with message: ") + .map(|(_, m)| m) + .unwrap_or(tail) + .trim(); + let msg: String = msg.chars().take(160).collect(); + return Some(format!("{file}: {msg}")); + } + } + let trimmed = line.trim(); + if trimmed.is_empty() { + return None; + } + Some(cap_at_whitespace_boundary(trimmed, 220)) +} + +/// Collapse the raw warning lines of one helper run into the capped, +/// deduplicated list persisted as `index_warnings` meta. Order-preserving +/// dedup because MSBuild repeats the same failure per project and per +/// pass; capped because the list rides on every find_impact answer. +pub(crate) fn summarize_index_warnings(lines: &[String], cap: usize) -> Vec { + let mut seen = std::collections::HashSet::new(); + let mut out: Vec = lines + .iter() + .filter_map(|l| normalize_index_warning_line(l)) + .filter(|w| seen.insert(w.clone())) + .collect(); + if out.len() > cap { + let dropped = out.len() - cap; + out.truncate(cap); + out.push(format!("… and {dropped} more distinct warning(s)")); + } + out +} + +/// The stored form of the summarized warnings: a stand-alone summary entry +/// leads, because the list rides on every find_impact answer AND the TUI +/// info panel and must be understandable alone. +pub(crate) fn index_warnings_stored(entries: &[String]) -> Vec { + if entries.is_empty() { + return Vec::new(); + } + let mut stored = vec![format!( + "The symbol index was built while the C# workspace reported {} distinct failure(s) — cross-project references may be missing from every answer. Failures `dotnet build` also reports are real and fixable in the repo (often a missing dotnet restore); failures only scip-csharp reports are tool-side — please report them and reindex.", + entries.len() + )]; + stored.extend(entries.iter().cloned()); + stored +} + /// Route one scip-csharp stderr line into tracing at the right severity. /// This is the ONLY sanctioned path for helper stderr: spawn helpers with /// `Stdio::piped()` and drain through here — never `Stdio::inherit()`, @@ -132,6 +228,16 @@ const META_HEAD_SHA: &str = crate::constants::SCIP_HEAD_SHA_KEY; /// built with (see [`crate::constants::SCIP_KEY_FORMAT`]). const META_KEY_FORMAT: &str = crate::constants::SCIP_KEY_FORMAT_KEY; +/// Key in the meta database holding the JSON array of index-level +/// completeness warnings from the last rebuild (see +/// [`summarize_index_warnings`]). +const META_INDEX_WARNINGS: &str = crate::constants::SCIP_INDEX_WARNINGS_KEY; +const META_BUILDER_VERSION: &str = crate::constants::SCIP_INDEX_BUILDER_VERSION_KEY; + +/// How many distinct index-level warnings are persisted (and thus surfaced +/// per find_impact answer) before the list is capped with an overflow note. +const INDEX_WARNINGS_CAP: usize = 10; + /// Key in the meta database storing the count of indexed symbols. #[allow(dead_code)] const META_SYMBOL_COUNT: &str = "symbol_count"; @@ -150,6 +256,134 @@ const HELPER_BIN_NAME: &str = crate::constants::SCIP_CSHARP_HELPER_NAME; #[allow(dead_code)] pub const CSHARP_REBUILD_DEBOUNCE_SECS: u64 = crate::constants::SCIP_CSHARP_DEBOUNCE_MS / 1000; +/// Exit code scip-csharp uses for "a dotnet restore for this solution is +/// still running" (issue #225): it printed one `[RESTORE-PENDING]` line, +/// wrote no output file, and built no index. +pub(crate) const HELPER_RESTORE_PENDING_EXIT: i32 = 75; + +/// Base of the exponential backoff between restore-pending retries of the +/// same rebuild scope: retry N waits base × 2^(N-1). +const RESTORE_PENDING_RETRY_BASE_INTERVAL_SECS: u64 = 60; + +/// Granularity of the restore wait's shutdown check. +const RESTORE_PENDING_POLL_MS: u64 = 500; + +/// Restore-pending helper attempts before a rebuild gives up with LMDB +/// untouched: initial attempt + 2 retries. Backoff 60s + 120s = 3 min of +/// restore patience, far below the MAX_INDEXING_SECS (30 min) +/// claim-takeover in serve so a still-running rebuild is never mistaken +/// for a leaked one and double-driven. +const RESTORE_PENDING_RETRY_MAX_ATTEMPTS: u32 = 3; + +/// Retry base seconds: `CODESEARCH_RESTORE_RETRY_INTERVAL_SECS` when set +/// to a positive integer, otherwise the built-in 60. Zero and unparseable +/// fall back to the default (a zero interval would hot-spin the helper); +/// tests use 1 to exercise the retry loop in seconds. +fn restore_pending_retry_interval_secs() -> u64 { + let raw = std::env::var(crate::constants::SCIP_RESTORE_RETRY_INTERVAL_SECS_ENV).ok(); + raw.and_then(|v| v.parse::().ok()) + .filter(|&secs| secs > 0) + .unwrap_or(RESTORE_PENDING_RETRY_BASE_INTERVAL_SECS) +} + +/// Backoff before restore-pending retry number `attempts` (1-based, the +/// count of pending exits so far): base × 2^(attempts-1), saturating. +fn restore_pending_retry_delay_secs(attempts: u32) -> u64 { + restore_pending_retry_interval_secs().saturating_mul(1u64 << (attempts - 1).min(16)) +} + +/// Sleeps `total` in poll steps; returns `false` as soon as shutdown is +/// requested. A rebuild parked here must not outlive quit: the runtime joins +/// its blocking pool at teardown. +fn sleep_unless_shutdown(total: std::time::Duration) -> bool { + let deadline = std::time::Instant::now() + total; + loop { + if crate::constants::is_shutdown_requested() { + return false; + } + let remaining = deadline.saturating_duration_since(std::time::Instant::now()); + if remaining.is_zero() { + return true; + } + thread::sleep(remaining.min(std::time::Duration::from_millis(RESTORE_PENDING_POLL_MS))); + } +} + +/// Typed marker for the helper's RESTORE-PENDING exit: distinct from a +/// generic failure so callers can leave LMDB untouched and retry instead of +/// surfacing an error (issue #225). +#[derive(Debug, thiserror::Error)] +#[error("dotnet restore still running for this solution (restore pending)")] +pub struct RestorePendingError; + +/// True when `e` is the typed restore-pending outcome. +pub(super) fn is_restore_pending(e: &anyhow::Error) -> bool { + e.downcast_ref::().is_some() +} + +/// Typed marker for the restore retry cap being exhausted: the previous +/// index stays live and LMDB is untouched, so callers render a warning +/// (stale-but-usable index), never a red error. +#[derive(Debug, thiserror::Error)] +#[error( + "dotnet restore for this solution did not finish within {attempts} attempts \ + (backoff {backoff}) — rebuild abandoned, the previous index stays live \ + (issue #225)" +)] +pub struct RestoreExhaustedError { + pub attempts: u32, + /// Concrete waits between attempts, e.g. "60s + 120s". + pub backoff: String, +} + +/// True when `e` is the typed restore-exhausted outcome. +pub(crate) fn is_restore_exhausted(e: &anyhow::Error) -> bool { + e.downcast_ref::().is_some() +} + +/// Solutions whose rebuild retry loop is currently waiting out a restore. +/// find_impact reads this through +/// [`SymbolIndexer::restore_pending`] to attach one caller-facing warning +/// while answering from the previous index. Lifetime = the retry loop: set +/// on the first pending exit, cleared when the loop ends either way. +static RESTORE_PENDING_SOLUTIONS: std::sync::LazyLock>> = + std::sync::LazyLock::new(|| std::sync::Mutex::new(HashSet::new())); + +pub(super) fn restore_pending_flag_set(db_path: &Path) { + match RESTORE_PENDING_SOLUTIONS.lock() { + Ok(mut set) => { + set.insert(db_path.to_path_buf()); + } + Err(poisoned) => { + // A poisoned lock still holds every entry inserted before the + // panic — recover rather than drop the honesty signal. + poisoned.into_inner().insert(db_path.to_path_buf()); + } + } +} + +pub(super) fn restore_pending_flag_clear(db_path: &Path) { + match RESTORE_PENDING_SOLUTIONS.lock() { + Ok(mut set) => { + set.remove(db_path); + } + Err(poisoned) => { + poisoned.into_inner().remove(db_path); + } + } +} + +/// Caller-facing warning find_impact attaches to every answer from an index +/// whose rebuild is waiting out a restore. +pub(crate) const RESTORE_PENDING_INDEX_WARNING: &str = + "dotnet restore in progress — index refresh pending; this answer comes from the previous index."; + +/// Per-symbol warning persisted when a lazy find-refs is refused mid-restore: +/// rides the existing ref-warnings channel and is replaced by the next +/// successful resolution, so a partial answer can never pass for complete. +const RESTORE_PENDING_REF_WARNING: &str = + "restore in progress — references could not be resolved; this answer lists definitions only and is INCOMPLETE"; + // ── Temp-file RAII guard ────────────────────────────────────────── /// Deletes `self.0` when dropped, even on early `?` returns. @@ -297,23 +531,36 @@ fn read_ref_warnings(env: &TrackedEnv, rtxn: &heed::RoTxn<'_>, canonical: &str) /// - `"csharp App . FieldDefinition#Validate()."` → `"Validate"` /// - `"csharp SmallSolution.Library . Calculator#Add(int, int)."` → `"Add"` /// - `"csharp . . . Namespace.TopLevel"` → `"TopLevel"` -fn extract_simple_name(scip_symbol: &str) -> String { - // Strip trailing suffix chars: "Validate()." → "Validate", "MyService#" → "MyService" - let cleaned = scip_symbol - .trim_end_matches('.') - .trim_end_matches("()") - .trim_end_matches('#'); - // Take last non-empty segment after '#' or '.' - let last_segment = cleaned - .rsplit(['#', '.']) - .find(|s| !s.trim().is_empty()) - .unwrap_or(cleaned) - .trim(); - // Strip method parameters (e.g. "Add(int, int)" → "Add") - last_segment +/// +/// Parameter lists are stripped BEFORE segmenting: key format 2.0 writes +/// fully-qualified parameter types (`SaveBatchAsync(int, System.Collections +/// .Generic.IReadOnlyList)`), and splitting on `.` first would +/// land inside the parameters — the "Activity, int)" fragments that left +/// every parameterized method unresolvable by fuzzy name. +pub(crate) fn extract_simple_name(scip_symbol: &str) -> String { + // Method/field segment: after the last '#' (types without '#' keep the + // whole string — their name is the last '.'-segment below; a bare + // trailing '#' falls back to the pre-# text). + let after_hash = scip_symbol.rsplit('#').next().unwrap_or(scip_symbol); + let base = if after_hash.trim().is_empty() { + scip_symbol + } else { + after_hash + }; + // Strip parameters FIRST, then the generic-arity marker: keys group all + // overloads and arities under one queryable name. + let name = base .split('(') .next() - .unwrap_or(last_segment) + .unwrap_or(base) + .split('`') + .next() + .unwrap_or(base); + let cleaned = name.trim().trim_end_matches('.').trim_end_matches('#'); + cleaned + .rsplit('.') + .find(|s| !s.trim().is_empty()) + .unwrap_or(cleaned) .trim() .to_string() } @@ -336,6 +583,61 @@ impl Default for CSharpSymbolIndexer { } } +/// PIDs of live one-shot scip-csharp helper children (index, find-refs, +/// batch-find-refs). serve shutdown kills whatever is still registered: a +/// rebuild outliving its host holds the helper exe locked for minutes (the +/// deploy blocker) and keeps computing for a dead client. +static LIVE_HELPER_PIDS: std::sync::LazyLock>> = + std::sync::LazyLock::new(|| std::sync::Mutex::new(HashSet::new())); + +/// RAII registration of a spawned helper child in [`LIVE_HELPER_PIDS`]; +/// dropped after the child is waited, so only genuinely in-flight PIDs +/// remain registered. +pub(crate) struct LiveHelperChild(u32); + +impl LiveHelperChild { + pub(crate) fn register(child: &std::process::Child) -> Self { + let pid = child.id(); + if let Ok(mut set) = LIVE_HELPER_PIDS.lock() { + set.insert(pid); + } + Self(pid) + } +} + +impl Drop for LiveHelperChild { + fn drop(&mut self) { + if let Ok(mut set) = LIVE_HELPER_PIDS.lock() { + set.remove(&self.0); + } + } +} + +/// Kill every still-registered helper child. Called on serve shutdown — +/// statics are not dropped at process exit, so the RAII guard alone cannot +/// cover the 'q'/Ctrl-C path. A PID whose process already exited fails the +/// kill harmlessly. +pub(crate) fn kill_live_helper_children() { + let pids: Vec = match LIVE_HELPER_PIDS.lock() { + Ok(mut set) => set.drain().collect(), + Err(_) => return, + }; + for pid in &pids { + #[cfg(windows)] + let _ = Command::new("taskkill") + .args(["/PID", &pid.to_string(), "/T", "/F"]) + .output(); + #[cfg(not(windows))] + let _ = Command::new("kill").arg("-9").arg(pid.to_string()).output(); + } + if !pids.is_empty() { + tracing::info!( + "🛑 Killed {} in-flight scip-csharp helper child(ren) on shutdown", + pids.len() + ); + } +} + impl CSharpSymbolIndexer { pub fn new() -> Self { Self { @@ -360,11 +662,91 @@ impl CSharpSymbolIndexer { } let resolved = self.resolve_helper_path(); - let mut lock = self.helper_path.lock().unwrap(); - *lock = Some(resolved.clone()); // cache both Some and None + { + let mut lock = self.helper_path.lock().unwrap(); + *lock = Some(resolved.clone()); // cache both Some and None + } + // After the guard is released: the version probe spawns a subprocess. + if let Some(ref path) = resolved { + self.log_helper_version_once(path); + } resolved } + /// Logs the resolved helper's self-reported version exactly once per + /// process. The mismatch class — a deployed helper older than the host + /// that spawns it, answering with pre-gate behaviour — is otherwise + /// invisible: the paths look right and every warning reads as a repo + /// problem. A mismatch is a WARNING, not a refusal: an old helper still + /// indexes, just without the current guarantees. + fn log_helper_version_once(&self, helper: &Path) { + static LOGGED: std::sync::OnceLock<()> = std::sync::OnceLock::new(); + if LOGGED.set(()).is_err() { + return; + } + let version = std::process::Command::new(helper) + .arg("--version") + .output() + .ok() + .filter(|o| o.status.success()) + .map(|o| parse_helper_version(&String::from_utf8_lossy(&o.stdout))) + .unwrap_or_else(|| "unknown".to_string()); + let host = env!("CARGO_PKG_VERSION"); + if version == host { + tracing::info!( + "scip-csharp helper v{} at {} (matches codesearch v{})", + version, + helper.display(), + host + ); + } else { + tracing::warn!( + "scip-csharp helper reports v{} at {} but codesearch is v{} — \ + redeploy (copy-to-common.ps1) or point {} at the matching helper; \ + behaviour may predate the current restore gate", + version, + helper.display(), + host, + HELPER_ENV_VAR + ); + } + } + + /// Writes the rebuild bookkeeping shared by every scope (full and + /// incremental): key-format stamp, index warnings (written or cleared) + /// and the builder-version stamp. Called from `rebuild`'s meta txn, so + /// meta always describes the newest build. `pub(crate)` so the producer + /// test drives the exact write the pipeline runs — a fake helper cannot + /// execute on Windows, where the validated filename must be a real PE. + pub(crate) fn write_rebuild_meta( + meta_db: &Database, + wtxn: &mut heed::RwTxn, + index_warnings: &[String], + ) -> Result<()> { + // Unconditional: has_index refuses an index whose key-format stamp is + // absent or stale, so a key-format change forces exactly one rebuild. + meta_db.put(wtxn, META_KEY_FORMAT, crate::constants::SCIP_KEY_FORMAT)?; + // Index-level completeness warnings from this run — written or + // cleared on EVERY rebuild (full or incremental) so meta always + // describes the newest build. + let stored_warnings = index_warnings_stored(index_warnings); + if stored_warnings.is_empty() { + meta_db.delete(wtxn, META_INDEX_WARNINGS)?; + } else { + let json = serde_json::to_string(&stored_warnings).unwrap_or_else(|_| "[]".to_string()); + meta_db.put(wtxn, META_INDEX_WARNINGS, json.as_str())?; + } + // Stamp the producing build: the rebuild gate treats an index from + // another (or an unknown) build as stale, so a deployed binary + // rebuilds the indexes it inherited itself at startup. + meta_db.put( + wtxn, + META_BUILDER_VERSION, + crate::constants::INDEX_BUILDER_VERSION, + )?; + Ok(()) + } + fn resolve_helper_path(&self) -> Option { // 1. Environment variable override if let Ok(path) = std::env::var(HELPER_ENV_VAR) { @@ -518,13 +900,20 @@ impl CSharpSymbolIndexer { // ── Helper invocation ────────────────────────────────────────── /// Invoke `scip-csharp index` and stream stderr to tracing. + /// + /// Returns the raw warning-severity stderr lines of the run — the input + /// to [`summarize_index_warnings`]. A helper that survives MSBuild + /// project-load failures exits 0 with a syntactically valid but + /// semantically partial index (definitions without cross-project + /// references); those failures land HERE so the rebuild can persist them + /// as index-level warnings instead of them living only in the log. fn invoke_index_helper( &self, helper: &Path, solution: &Path, output_path: &Path, project_filter: Option<&Path>, - ) -> Result<()> { + ) -> Result> { let solution_short = solution .file_name() .map(|s| s.to_string_lossy().into_owned()) @@ -548,12 +937,21 @@ impl CSharpSymbolIndexer { let mut child = cmd .spawn() .with_context(|| format!("Failed to execute scip-csharp at {}", helper.display()))?; + // Deregistered when the guard drops at the end of this fn (after + // wait), so shutdown only ever kills genuinely in-flight helpers. + let _live_helper = LiveHelperChild::register(&child); + let captured_warnings: std::sync::Arc>> = + std::sync::Arc::new(std::sync::Mutex::new(Vec::new())); let stderr_handle = child.stderr.take().map(|stderr| { let label = solution_short.clone(); + let sink = std::sync::Arc::clone(&captured_warnings); thread::spawn(move || { drain_pipe_to_tracing(stderr, |line| { if !line.is_empty() { + if is_helper_warning_line(line) { + sink.lock().map(|mut v| v.push(line.to_string())).ok(); + } emit_helper_stderr_line("scip-csharp", &label, line); } }); @@ -582,6 +980,12 @@ impl CSharpSymbolIndexer { let _ = h.join(); } + if status.code() == Some(HELPER_RESTORE_PENDING_EXIT) { + // The helper printed [RESTORE-PENDING] and wrote nothing: map to + // the typed outcome, never a generic failure (issue #225). + return Err(anyhow::Error::new(RestorePendingError)); + } + if !status.success() { tracing::warn!( "scip-csharp exited with {} for {}", @@ -591,7 +995,13 @@ impl CSharpSymbolIndexer { // Don't bail — partial output is acceptable per AGENTS.md spec } - Ok(()) + // A poisoned lock still holds every line pushed before the panic — + // recover rather than drop honesty signals on the floor. + let raw = match captured_warnings.lock() { + Ok(mut v) => std::mem::take(&mut *v), + Err(poisoned) => std::mem::take(&mut *poisoned.into_inner()), + }; + Ok(raw) } /// Invoke `scip-csharp find-refs` for a single symbol and return its @@ -645,6 +1055,7 @@ impl CSharpSymbolIndexer { helper.display() ) })?; + let _live_helper = LiveHelperChild::register(&child); let stderr_handle = child.stderr.take().map(|stderr| { let label = solution_short.clone(); @@ -679,6 +1090,12 @@ impl CSharpSymbolIndexer { let _ = h.join(); } + if status.code() == Some(HELPER_RESTORE_PENDING_EXIT) { + // Typed restore-pending outcome: no output file exists to read + // and nothing may be cached from this run (issue #225). + return Err(anyhow::Error::new(RestorePendingError)); + } + if !status.success() { tracing::warn!( "scip-csharp find-refs exited with {} for '{}'", @@ -923,10 +1340,37 @@ impl CSharpSymbolIndexer { find-refs for '{}'", canonical ); - self.invoke_find_refs_helper(&helper, &solution, canonical)? + match self.invoke_find_refs_helper(&helper, &solution, canonical) { + Ok(pair) => pair, + Err(e) if is_restore_pending(&e) => { + // Restore in flight: answer from what LMDB + // already has (definitions only), persist the + // honesty warning on the per-symbol channel + // find_impact already reads, and cache NOTHING — + // the next lookup after restore finishes misses + // the cache, resolves properly and replaces the + // warning (issue #225). + { + let mut wtxn = env.write_txn()?; + store_ref_warnings( + &env, + &mut wtxn, + canonical, + &[RESTORE_PENDING_REF_WARNING.to_string()], + )?; + wtxn.commit()?; + } + return Ok(all_stored.into_iter().map(stored_to_symbol_ref).collect()); + } + Err(e) => return Err(e), + } } }; + // A real resolution proves assets are fresh again: lift the + // index-level pending flag if this lookup had set it. + restore_pending_flag_clear(db_path); + // ── Write phase — cache the resolved references ──────────── // Over the LMDB key limit: answer from the live resolution and skip the // cache write, rather than failing a lookup that already succeeded. @@ -1080,7 +1524,26 @@ impl CSharpSymbolIndexer { let _output_guard = TempFileGuard(output_path.clone()); // Invoke batch-find-refs — symbols_file and output_path are cleaned up by guards - self.invoke_batch_find_refs_helper(&helper, &solution, &symbols_file, &output_path)?; + if let Err(e) = + self.invoke_batch_find_refs_helper(&helper, &solution, &symbols_file, &output_path) + { + if is_restore_pending(&e) { + // Prewarm is best-effort: skip this round, cache nothing. + // The next prewarm (or any lazy lookup) retries after the + // restore finished (issue #225). + tracing::warn!( + "prewarm skipped for '{}': dotnet restore still running (restore pending)", + solution.display() + ); + return Ok(PrewarmSummary { + total_symbols: total_available, + resolved: 0, + cached: 0, + duration_ms: start.elapsed().as_millis() as u64, + }); + } + return Err(e); + } // Parse and cache results let cached = self.parse_and_cache_batch_refs(db_path, &output_path)?; @@ -1137,6 +1600,7 @@ impl CSharpSymbolIndexer { helper.display() ) })?; + let _live_helper = LiveHelperChild::register(&child); let stderr_handle = child.stderr.take().map(|stderr| { let label = solution_short.clone(); @@ -1171,6 +1635,12 @@ impl CSharpSymbolIndexer { let _ = h.join(); } + if status.code() == Some(HELPER_RESTORE_PENDING_EXIT) { + // Typed restore-pending outcome: no output file exists to parse + // and nothing may be cached from this run (issue #225). + return Err(anyhow::Error::new(RestorePendingError)); + } + if !status.success() { tracing::warn!( "scip-csharp batch-find-refs exited with {} for {}", @@ -1350,8 +1820,77 @@ impl SymbolIndexer for CSharpSymbolIndexer { )); let _output_guard = TempFileGuard(output_path.clone()); - // Invoke helper with stderr streaming - self.invoke_index_helper(&helper, &solution, &output_path, project.as_deref())?; + // Invoke helper with stderr streaming; warning-severity lines become + // the index-level completeness warnings persisted below. + // + // ── Restore gate (issue #225) ───────────────────────────────── + // A RESTORE-PENDING exit means a dotnet restore for this solution is + // still running and the helper deliberately produced nothing. + // Indexing anyway would store a degraded, CS0246-noisy index into + // LMDB while the previous good index could have stayed live — so + // retry the SAME rebuild scope with a bounded backoff until the + // helper stops reporting pending, and on exhaustion give up with + // LMDB untouched: every LMDB write below sits after this loop. + let mut attempts: u32 = 0; + let mut marked_pending = false; + let raw_index_warnings = loop { + match self.invoke_index_helper(&helper, &solution, &output_path, project.as_deref()) { + Ok(raw) => { + if marked_pending { + restore_pending_flag_clear(db_path); + } + break raw; + } + Err(e) if is_restore_pending(&e) => { + attempts += 1; + // Idempotent set on EVERY pending exit: a later restore + // can start while this loop is still waiting (an earlier + // one resolved and cleared the flag via a lazy find-refs) + // and the warning must survive that. + restore_pending_flag_set(db_path); + marked_pending = true; + if attempts >= RESTORE_PENDING_RETRY_MAX_ATTEMPTS { + restore_pending_flag_clear(db_path); + let backoff = (1..RESTORE_PENDING_RETRY_MAX_ATTEMPTS) + .map(|k| format!("{}s", restore_pending_retry_delay_secs(k))) + .collect::>() + .join(" + "); + bail!(RestoreExhaustedError { + attempts: RESTORE_PENDING_RETRY_MAX_ATTEMPTS, + backoff, + }); + } + let delay_secs = restore_pending_retry_delay_secs(attempts); + tracing::warn!( + "restore pending for '{}' — retrying the same rebuild scope in {}s \ + (attempt {}/{})", + solution.display(), + delay_secs, + attempts, + RESTORE_PENDING_RETRY_MAX_ATTEMPTS + ); + if !sleep_unless_shutdown(std::time::Duration::from_secs(delay_secs)) { + restore_pending_flag_clear(db_path); + bail!( + "rebuild cancelled while waiting for dotnet restore — shutdown \ + requested, previous index stays live" + ); + } + } + Err(e) => { + // A non-pending failure ends the retry loop: the flag + // describes THIS loop's wait, so it must not outlive it + // — otherwise find_impact would warn "restore in + // progress" long after the loop gave up for another + // reason (helper crash, solution deleted mid-wait). + if marked_pending { + restore_pending_flag_clear(db_path); + } + return Err(e); + } + } + }; + let index_warnings = summarize_index_warnings(&raw_index_warnings, INDEX_WARNINGS_CAP); // Parse the JSON output let index_data = std::fs::read(&output_path) @@ -1689,13 +2228,7 @@ impl SymbolIndexer for CSharpSymbolIndexer { if let Some(sha) = super::current_git_head(repo_path) { meta_db.put(&mut wtxn, META_HEAD_SHA, sha.as_str())?; } - // Unconditional: has_index refuses an index whose key-format stamp is - // absent or stale, so a key-format change forces exactly one rebuild. - meta_db.put( - &mut wtxn, - META_KEY_FORMAT, - crate::constants::SCIP_KEY_FORMAT, - )?; + Self::write_rebuild_meta(&meta_db, &mut wtxn, &index_warnings)?; wtxn.commit()?; @@ -1722,6 +2255,7 @@ impl SymbolIndexer for CSharpSymbolIndexer { symbols_indexed: total_symbols, references_stored: total_defs, // definitions only; refs resolved lazily duration_ms, + index_warnings: index_warnings_stored(&index_warnings), }) } @@ -1801,6 +2335,13 @@ impl SymbolIndexer for CSharpSymbolIndexer { read_ref_warnings(&env, &rtxn, canonical) } + fn restore_pending(&self, db_path: &Path) -> bool { + match RESTORE_PENDING_SOLUTIONS.lock() { + Ok(set) => set.contains(db_path), + Err(poisoned) => poisoned.into_inner().contains(db_path), + } + } + fn index_age(&self, db_path: &Path) -> u64 { let env = match self.open_scip_env(db_path) { Ok(e) => e, @@ -1846,6 +2387,65 @@ impl SymbolIndexer for CSharpSymbolIndexer { (!sha.is_empty()).then_some(sha) } + /// Index-level completeness warnings from the last rebuild — the + /// workspace/MSBuild failures the helper survived. Non-empty means + /// reference lists from this index may be incomplete even when a + /// lookup succeeds (observed live: a worktree whose NuGet restore was + /// broken indexed every definition but zero cross-project references, + /// and every find_impact answer passed as clean). Plain LMDB read; + /// unreadable or absent metadata reads as clean (never blocks an answer). + fn index_warnings(&self, db_path: &Path) -> Vec { + let env = match self.open_scip_env(db_path) { + Ok(e) => e, + Err(_) => return Vec::new(), + }; + let rtxn = match env.read_txn() { + Ok(t) => t, + Err(_) => return Vec::new(), + }; + let meta_db: Database = match env.open_database(&rtxn, Some(SCIP_META_DB_NAME)) { + Ok(Some(db)) => db, + _ => return Vec::new(), + }; + let json = match meta_db.get(&rtxn, META_INDEX_WARNINGS) { + Ok(Some(s)) => s, + _ => return Vec::new(), + }; + serde_json::from_str(json).unwrap_or_default() + } + + /// Which codesearch build produced this index — `None` when the stamp is + /// absent (pre-stamp index) or the meta is unreadable. The rebuild gate + /// compares against [`crate::constants::INDEX_BUILDER_VERSION`] and + /// rebuilds on mismatch: this binary never produced that index. + fn index_builder_version(&self, db_path: &Path) -> Option { + let env = match self.open_scip_env(db_path) { + Ok(e) => e, + Err(_) => return None, + }; + let rtxn = match env.read_txn() { + Ok(t) => t, + Err(_) => return None, + }; + let meta_db: Database = match env.open_database(&rtxn, Some(SCIP_META_DB_NAME)) { + Ok(Some(db)) => db, + _ => return None, + }; + meta_db + .get(&rtxn, META_BUILDER_VERSION) + .ok() + .flatten() + .map(|s| s.to_string()) + } + + /// Same freshness check the rebuild gate applies (mod.rs: an absent or + /// foreign builder stamp reads as stale for C#, unlike adapters that do + /// not stamp at all — hence the override, not the trait default). + fn index_matches_builder(&self, db_path: &Path) -> bool { + self.index_builder_version(db_path).as_deref() + == Some(crate::constants::INDEX_BUILDER_VERSION) + } + /// Whether a SCIP index exists AND was built with the current key format. /// An index that is fresh by timestamp but stamped with another (or no) /// key-format generation would serve old-shaped canonical keys as truth, @@ -1893,6 +2493,10 @@ impl SymbolIndexer for CSharpSymbolIndexer { Self::find_solution(repo_path).is_some() } + fn applicability_hint(&self) -> &'static str { + "the scip-csharp adapter requires a .sln file in the repository root" + } + fn as_any(&self) -> &dyn std::any::Any { self } @@ -2319,7 +2923,25 @@ mod tests { /// fallback); `find-refs` writes a fixed warnings-bearing JSON to its /// `--output` path, mirroring a helper that survived a partial failure. const FAKE_HELPER_SRC: &str = r#"fn main() { + if std::env::var("CS_FAKE_HELPER_MODE").as_deref() == Ok("exit75") { + std::process::exit(75); + } + if std::env::var("CS_FAKE_HELPER_MODE").as_deref() == Ok("pend-then-fail") { + // First invocation pends (75), every later one fails generically (2): + // drives a mid-retry non-pending failure through the real loop. + let flag = std::env::var("CS_FAKE_PEND_FLAG") + .unwrap_or_else(|_| "pend-flag".into()); + if std::path::Path::new(&flag).exists() { + std::process::exit(2); + } + std::fs::write(&flag, "x").unwrap(); + std::process::exit(75); + } let args: Vec = std::env::args().collect(); + if args.get(1).map(String::as_str) == Some("--version") { + println!("scip-csharp 0.0.0-fake"); + return; + } if args.get(1).map(String::as_str) == Some("serve") { return; } @@ -2486,4 +3108,305 @@ mod tests { warnings[0] ); } + + // ── Restore gate (issue #225): producer-side coverage ─────────── + // + // The exit-75 mapping, the retry exhaustion and the lazy find-refs + // pending branch, driven through the real fake-helper subprocess so + // deleting any of them fails here. + + fn fake_helper_always_pending(dir: &Path) -> (PathBuf, crate::testing::EnvRestore) { + let helper_dir = dir.join("helper"); + std::fs::create_dir(&helper_dir).unwrap(); + let helper = build_fake_csharp_helper(&helper_dir); + let guard = crate::testing::EnvRestore::set(&[ + (HELPER_ENV_VAR, helper.to_string_lossy().as_ref()), + ("CS_FAKE_HELPER_MODE", "exit75"), + ]); + (helper, guard) + } + + #[test] + #[serial_test::serial] + fn exit_75_from_every_helper_entry_maps_to_the_typed_pending_outcome() { + let dir = tempfile::TempDir::new().unwrap(); + let (helper, _guard) = fake_helper_always_pending(dir.path()); + let indexer = CSharpSymbolIndexer::new(); + let solution = dir.path().join("FakeSolution.sln"); + let output = dir.path().join("out.json"); + + let err = indexer + .invoke_index_helper(&helper, &solution, &output, None) + .unwrap_err(); + assert!( + is_restore_pending(&err), + "index exit 75 must map to the typed outcome, got: {err:#}" + ); + + let err = indexer + .invoke_find_refs_helper(&helper, &solution, "csharp Ns . V#V().") + .unwrap_err(); + assert!( + is_restore_pending(&err), + "find-refs exit 75 must map to the typed outcome, got: {err:#}" + ); + + let err = indexer + .invoke_batch_find_refs_helper( + &helper, + &solution, + &dir.path().join("symbols.txt"), + &output, + ) + .unwrap_err(); + assert!( + is_restore_pending(&err), + "batch exit 75 must map to the typed outcome, got: {err:#}" + ); + } + + #[test] + #[serial_test::serial] + fn rebuild_bails_after_the_retry_cap_with_lmdb_untouched() { + use super::SymbolIndexer as _; + + let dir = tempfile::TempDir::new().unwrap(); + let db = dir.path().join("db"); + std::fs::write(dir.path().join("FakeSolution.sln"), "").unwrap(); + + let helper_dir = dir.path().join("helper"); + std::fs::create_dir(&helper_dir).unwrap(); + let helper = build_fake_csharp_helper(&helper_dir); + let _guard = crate::testing::EnvRestore::set(&[ + (HELPER_ENV_VAR, helper.to_string_lossy().as_ref()), + ("CS_FAKE_HELPER_MODE", "exit75"), + // 1s base: 0 is filtered (fail-safe against a prod hot-spin), + // so the backoff runs 1s + 2s — the cap exhausts in ~3s, not 3 min. + (crate::constants::SCIP_RESTORE_RETRY_INTERVAL_SECS_ENV, "1"), + ]); + + let indexer = CSharpSymbolIndexer::new(); + let err = indexer + .rebuild(dir.path(), &db, RebuildScope::Full) + .unwrap_err(); + let msg = format!("{err:#}"); + assert!( + msg.contains(&format!( + "did not finish within {RESTORE_PENDING_RETRY_MAX_ATTEMPTS} attempts" + )), + "cap exhaustion must name attempts and the abandonment, got: {msg}" + ); + assert!( + msg.contains("backoff 1s + 2s"), + "the message must carry the concrete backoff waits, got: {msg}" + ); + assert!( + err.downcast_ref::().is_some(), + "cap exhaustion must be the typed outcome, got: {err:#}" + ); + + // LMDB untouched: no rebuild meta written, and the pending flag that + // rode the retry loop is cleared on the way out. + assert_eq!( + indexer.index_age(&db), + u64::MAX, + "an abandoned rebuild must not write rebuild meta" + ); + assert!( + !indexer.restore_pending(&db), + "the pending flag must be cleared when the retry loop gives up" + ); + } + + #[test] + #[serial_test::serial] + fn restore_pending_backoff_doubles_from_the_configured_base() { + let _guard = crate::testing::EnvRestore::set(&[( + crate::constants::SCIP_RESTORE_RETRY_INTERVAL_SECS_ENV, + "1", + )]); + assert_eq!(restore_pending_retry_delay_secs(1), 1); + assert_eq!(restore_pending_retry_delay_secs(2), 2); + // Saturating shift cap: an absurd attempt count can never overflow. + assert_eq!(restore_pending_retry_delay_secs(1_000), 1 << 16); + } + + #[test] + #[serial_test::serial] + fn rebuild_waiting_on_restore_returns_promptly_once_shutdown_is_requested() { + use super::SymbolIndexer as _; + + let dir = tempfile::TempDir::new().unwrap(); + let db = dir.path().join("db"); + std::fs::write(dir.path().join("FakeSolution.sln"), "").unwrap(); + let helper_dir = dir.path().join("helper"); + std::fs::create_dir(&helper_dir).unwrap(); + let helper = build_fake_csharp_helper(&helper_dir); + let _guard = crate::testing::EnvRestore::set(&[ + (HELPER_ENV_VAR, helper.to_string_lossy().as_ref()), + ("CS_FAKE_HELPER_MODE", "exit75"), + ]); + + let (tx, rx) = std::sync::mpsc::channel(); + let repo = dir.path().to_path_buf(); + let db_thread = db.clone(); + std::thread::spawn(move || { + let res = CSharpSymbolIndexer::new().rebuild(&repo, &db_thread, RebuildScope::Full); + let _ = tx.send(res.map(|_| ()).map_err(|e| format!("{e:#}"))); + }); + + // Arm the promptness clock only once the rebuild is actually parked + // in the restore wait: under full-suite load the helper spawn + LMDB + // open can outlast a fixed settle sleep, failing the test before the + // property under test ever engaged. The pending flag rides the retry + // loop, so it flips true exactly when the wait starts. + let indexer = CSharpSymbolIndexer::new(); + let park_started = std::time::Instant::now(); + loop { + assert!( + park_started.elapsed() < std::time::Duration::from_secs(30), + "rebuild never reached the restore wait" + ); + if indexer.restore_pending(&db) { + break; + } + std::thread::sleep(std::time::Duration::from_millis(100)); + } + crate::constants::SHUTDOWN_REQUESTED.store(true, std::sync::atomic::Ordering::SeqCst); + let outcome = rx.recv_timeout(std::time::Duration::from_secs(10)); + crate::constants::SHUTDOWN_REQUESTED.store(false, std::sync::atomic::Ordering::SeqCst); + + match outcome { + Ok(Err(msg)) => assert!(msg.contains("shutdown"), "unexpected error: {msg}"), + Ok(Ok(())) => panic!("a rebuild waiting on restore must not succeed"), + Err(_) => { + panic!("rebuild still parked in the restore wait 10s after shutdown was requested") + } + } + } + + #[test] + #[serial_test::serial] + fn runtime_teardown_finishes_a_restore_parked_blocking_task_within_grace() { + let runtime = tokio::runtime::Runtime::new().unwrap(); + runtime.spawn_blocking(|| { + while super::sleep_unless_shutdown(std::time::Duration::from_secs(60)) {} + }); + std::thread::sleep(std::time::Duration::from_millis(300)); + + crate::constants::SHUTDOWN_REQUESTED.store(true, std::sync::atomic::Ordering::SeqCst); + let started = std::time::Instant::now(); + runtime.shutdown_timeout(std::time::Duration::from_secs( + crate::constants::RUNTIME_SHUTDOWN_GRACE_SECS, + )); + let elapsed = started.elapsed(); + crate::constants::SHUTDOWN_REQUESTED.store(false, std::sync::atomic::Ordering::SeqCst); + + assert!( + elapsed < std::time::Duration::from_secs(crate::constants::RUNTIME_SHUTDOWN_GRACE_SECS), + "teardown waited out the full grace ({elapsed:?}): the restore wait did not observe shutdown" + ); + } + + #[test] + #[serial_test::serial] + fn lazy_find_refs_pending_persists_warning_and_caches_nothing() { + use super::SymbolIndexer as _; + + let dir = tempfile::TempDir::new().unwrap(); + let db = dir.path().join("db"); + std::fs::write(dir.path().join("FakeSolution.sln"), "").unwrap(); + let key = "csharp Ns . V#Validate()."; + { + let env = crate::symbols::get_shared_scip_env(&db).unwrap(); + let mut wtxn = env.write_txn().unwrap(); + let symbols: Database = env + .open_database(&wtxn, Some(SCIP_DB_NAME)) + .unwrap() + .unwrap(); + symbols + .put( + &mut wtxn, + key, + &serialize_refs(&[StoredReference { + file: PathBuf::from("src/v.cs"), + start_line: 1, + end_line: 1, + kind: "definition".into(), + }]) + .unwrap(), + ) + .unwrap(); + wtxn.commit().unwrap(); + } + + let (_helper, _guard) = fake_helper_always_pending(dir.path()); + let indexer = CSharpSymbolIndexer::new(); + let refs = indexer.find_references_for_key(&db, key).unwrap(); + + // Definitions survive (the previous index stays live)... + assert!( + refs.iter() + .all(|r| r.kind == "definition" && r.file == Path::new("src/v.cs")), + "only the stored definition may answer, got {refs:?}" + ); + // ...the honesty warning is persisted on the per-symbol channel... + let warnings = indexer.lookup_warnings(&db, key); + assert_eq!( + warnings.len(), + 1, + "the pending warning must be persisted, got {warnings:?}" + ); + assert!(warnings[0].contains("restore in progress")); + // ...and NOTHING is cached: the next lookup after restore finishes + // must miss the cache and resolve properly. + let env = crate::symbols::get_shared_scip_env(&db).unwrap(); + let rtxn = env.read_txn().unwrap(); + let cache: Database = env + .open_database(&rtxn, Some(SCIP_REF_CACHE_DB_NAME)) + .unwrap() + .unwrap(); + assert!( + cache.get(&rtxn, key).unwrap().is_none(), + "a pending find-refs must not write the ref cache" + ); + } + + #[test] + #[serial_test::serial] + fn rebuild_non_pending_failure_mid_retry_clears_the_pending_flag() { + use super::SymbolIndexer as _; + + let dir = tempfile::TempDir::new().unwrap(); + let db = dir.path().join("db"); + std::fs::write(dir.path().join("FakeSolution.sln"), "").unwrap(); + let flag_path = dir.path().join("pend-flag"); + + let helper_dir = dir.path().join("helper"); + std::fs::create_dir(&helper_dir).unwrap(); + let helper = build_fake_csharp_helper(&helper_dir); + let _guard = crate::testing::EnvRestore::set(&[ + (HELPER_ENV_VAR, helper.to_string_lossy().as_ref()), + ("CS_FAKE_HELPER_MODE", "pend-then-fail"), + ("CS_FAKE_PEND_FLAG", flag_path.to_string_lossy().as_ref()), + (crate::constants::SCIP_RESTORE_RETRY_INTERVAL_SECS_ENV, "1"), + ]); + + let indexer = CSharpSymbolIndexer::new(); + let err = indexer + .rebuild(dir.path(), &db, RebuildScope::Full) + .unwrap_err(); + + // Attempt 1 pends (flag set), attempt 2 fails generically: the + // surfaced error is the generic one (never the typed pending + // outcome) and the flag must not outlive the loop that set it. + assert!( + !is_restore_pending(&err), + "the generic failure must surface, got: {err:#}" + ); + assert!( + !indexer.restore_pending(&db), + "the pending flag must be cleared when the retry loop ends on a non-pending failure" + ); + } } diff --git a/src/symbols/csharp_tests.rs b/src/symbols/csharp_tests.rs index 31991aa0..6356e6dd 100644 --- a/src/symbols/csharp_tests.rs +++ b/src/symbols/csharp_tests.rs @@ -1,8 +1,13 @@ //! Helper stderr routing tests (`csharp.rs`). Sibling `_tests.rs` file //! per repo convention. -use super::csharp::{drain_pipe_to_tracing, is_helper_warning_line}; +use super::csharp::{ + drain_pipe_to_tracing, is_helper_warning_line, is_restore_pending, kill_live_helper_children, + restore_pending_flag_clear, restore_pending_flag_set, LiveHelperChild, RestorePendingError, + HELPER_RESTORE_PENDING_EXIT, +}; use std::io::Cursor; +use std::path::PathBuf; use std::sync::Mutex; fn drained(input: &[u8]) -> Vec { @@ -82,7 +87,7 @@ fn drain_retries_after_transient_interrupted_read() { #[test] fn helper_warning_classification_table() { - let cases: [(&str, bool); 10] = [ + let cases: [(&str, bool); 12] = [ // Helper's own workspace-failure warnings (WorkspaceFailed handler). ( "[WARN] Workspace error: [Failure] Msbuild failed when processing the file 'C:\\r\\p.csproj' with message: Dependency specified was X but ended up with X 1.2.3", @@ -107,6 +112,19 @@ fn helper_warning_classification_table() { "[INFO] Skipping unsupported project type: C:\\r\\x.shproj", false, ), + // A helper-demoted note renders the bare diagnostic MESSAGE: it must + // not be captured. The trap this pins: a demotion that renders the + // full diagnostic re-embeds "[Failure]" and re-enters this channel. + ( + "[INFO] Workspace note: Msbuild failed when processing the file 'C:\\r\\p.csproj' with message: Grpc.Net.ClientFactory 2.63.0 or earlier could cause issues when used together with Microsoft.Extensions.Http.Resilience.", + false, + ), + // The buggy shape, documented: the tag alone keeps the line captured + // regardless of the [INFO] prefix. + ( + "[INFO] Workspace note: [Failure] Msbuild failed when processing the file 'C:\\r\\p.csproj'", + true, + ), ("Loading solution: C:\\r\\x.sln", false), ("Loaded 13 project(s) from filtered solution", false), ( @@ -124,3 +142,451 @@ fn helper_warning_classification_table() { ); } } + +// ── Index-level completeness warnings (features/always-on-symbol-indexes) ── + +/// The live MSBuild project-load failure format observed on a customer +/// worktree (NuGet restore broken: analyzer package version mismatch) — +/// the exact line class whose warnings silently disappeared into the log +/// while every find_impact answer read clean. Identifiers anonymized; the +/// shape is what the parser must match. +const LIVE_MSBUILD_FAILURE: &str = "[WARN] Workspace error: [Failure] Msbuild failed when processing the file 'C:\\repos\\demo-worktree\\src\\App.Dam\\App.Dam.csproj' with message: App.Dam depends on Analyzer.X (>= 1.2.3) but Analyzer.X 1.2.3 was not found. Analyzer.X 1.3.0 was resolved instead."; + +/// Normalization collapses the project-load failure to `: `; +/// duplicates (MSBuild repeats per project and per pass) dedupe; plain +/// warning lines pass through trimmed; non-warning lines are dropped. +#[test] +fn summarize_index_warnings_normalizes_dedupes_and_skips_noise() { + let msbuild_second = "[WARN] Workspace error: [Failure] Msbuild failed when processing the file 'C:\\repos\\other\\src\\App.Web\\App.Web.csproj' with message: App.Web depends on Analyzer.X (>= 1.2.3) but Analyzer.X 1.2.3 was not found. Analyzer.X 1.3.0 was resolved instead."; + let lines = vec![ + "MSBuild: registering '.NET Core SDK' v10.0.401".to_string(), // info, dropped + LIVE_MSBUILD_FAILURE.to_string(), + LIVE_MSBUILD_FAILURE.to_string(), // duplicate, deduped + msbuild_second.to_string(), + "[WARN] Grpc.Net.ClientFactory 2.63.0 or earlier could cause issues".to_string(), + "".to_string(), + ]; + + let out = super::csharp::summarize_index_warnings(&lines, 10); + + assert_eq!(out.len(), 3, "expected 3 distinct warnings, got: {out:?}"); + assert!( + out[0].starts_with("App.Dam.csproj: App.Dam depends on Analyzer.X"), + "first entry must be the normalized project failure, got: {}", + out[0] + ); + assert!( + out[1].starts_with("App.Web.csproj: "), + "second entry must be the second project, got: {}", + out[1] + ); + assert!( + out[2].starts_with("[WARN] Grpc"), + "unrecognized warning format passes through verbatim, got: {}", + out[2] + ); + // The failure message is longer than the 160-char cap — pinned so a + // persisted entry can never blow up the warnings array on answers. + let msg = out[0].split_once(": ").expect("normalized shape").1; + assert!(msg.chars().count() <= 160, "message must be capped"); +} + +/// The passthrough cap must cut at whitespace, never mid-word: a hard +/// 220-char cut landed inside the quoted CS0103 specimen name at the tail +/// edge of the line even after the helper trimmed its own specimen. +#[test] +fn normalize_passthrough_caps_at_whitespace_boundary() { + let prefix = "[WARN] Compilation errors in Very.Long.Project.Name.Catalog: 12 error(s) — dominant CS0103 x10; first: C:\\src\\Cat\\ViewModels\\CustomerAccountViewModel.cs(42,17): error CS0103: The name '"; + let identifier = "CustomerOrderViewModelFactoryProviderCache"; + let line = format!("{prefix}{identifier}' does not exist in the current context"); + assert!( + line.chars().count() > 220, + "test setup: line must exceed the cap" + ); + + let out = super::csharp::normalize_index_warning_line(&line).expect("warning line"); + + assert!( + out.chars().count() <= 220, + "cap must hold, got {}", + out.chars().count() + ); + assert_ne!( + out.chars().count(), + 220, + "a whitespace boundary exists before the cap — cut there, not at the hard cap" + ); + // `out` is a byte-prefix of `line` (the cut lands on a char boundary), + // so this checks the cut position in the original line directly. + assert!( + line[out.len()..].starts_with(' '), + "cut must land on the original line's whitespace boundary, tail: ...{}", + &line[out.len().saturating_sub(40)..] + ); +} + +/// The cap kicks in with an explicit overflow entry — the list rides on +/// every find_impact answer and must stay bounded. +#[test] +fn summarize_index_warnings_caps_with_overflow_note() { + let lines: Vec = (0..5) + .map(|i| format!("[WARN] distinct failure number {i}")) + .collect(); + let out = super::csharp::summarize_index_warnings(&lines, 3); + assert_eq!(out.len(), 4, "3 capped entries + overflow note: {out:?}"); + assert_eq!(out[3], "… and 2 more distinct warning(s)"); +} + +/// The meta roundtrip: what rebuild persists is what `index_warnings` +/// returns; absent key and corrupt JSON both read as clean (never block an +/// answer), and the TypeScript adapter inherits the empty default. +#[test] +fn index_warnings_roundtrip_and_clean_absence() { + use crate::symbols::SymbolIndexer as _; + + let dir = tempfile::tempdir().unwrap(); + let db_path = dir.path().join("codesearch.db"); + + let csharp = super::csharp::CSharpSymbolIndexer::new(); + assert!( + csharp.index_warnings(&db_path).is_empty(), + "absent meta must read as clean" + ); + + let env = crate::symbols::get_shared_scip_env(&db_path).unwrap(); + let mut wtxn = env.write_txn().unwrap(); + let meta: heed::Database = env + .create_database(&mut wtxn, Some(crate::constants::SCIP_META_DB_NAME)) + .unwrap(); + let stored = vec![ + "summary line".to_string(), + "App.Dam.csproj: Analyzer.X not found".to_string(), + ]; + meta.put( + &mut wtxn, + crate::constants::SCIP_INDEX_WARNINGS_KEY, + serde_json::to_string(&stored).unwrap().as_str(), + ) + .unwrap(); + wtxn.commit().unwrap(); + + assert_eq!( + csharp.index_warnings(&db_path), + stored, + "persisted warnings must round-trip verbatim" + ); + + // Corrupt JSON reads as clean, not as an error. + let mut wtxn = env.write_txn().unwrap(); + meta.put( + &mut wtxn, + crate::constants::SCIP_INDEX_WARNINGS_KEY, + "not json [", + ) + .unwrap(); + wtxn.commit().unwrap(); + assert!( + csharp.index_warnings(&db_path).is_empty(), + "corrupt meta must read as clean, never fail the answer" + ); + + let ts = super::typescript::TypeScriptSymbolIndexer::new(); + assert!( + ts.index_warnings(&db_path).is_empty(), + "non-tracking adapters inherit the empty default" + ); +} + +// ── Builder-version stamp: the rebuild's meta-write site ───────────────── +// +// The gate tests hand-seed meta (consumer half); this one drives the +// producer. The write lives in `write_rebuild_meta` — the exact fn the +// rebuild pipeline calls from its meta txn — because a fake helper cannot +// execute on Windows: the validated filename must be a real PE, not a +// script. Deleting the stamp write must fail this test, or every serve +// start churns all inherited C# indexes (absent stamp reads as stale). + +/// The C# freshness override mirrors the rebuild gate exactly: a current +/// stamp matches, an absent or foreign stamp does not — while adapters +/// without stamping take the trait default (`true`) and never read stale. +#[test] +fn index_matches_builder_mirrors_the_rebuild_gate() { + use crate::constants::{INDEX_BUILDER_VERSION, SCIP_INDEX_BUILDER_VERSION_KEY}; + + let dir = tempfile::TempDir::new().unwrap(); + let db = dir.path().join("db"); + let indexer = super::csharp::CSharpSymbolIndexer::new(); + use crate::symbols::SymbolIndexer as _; + + // No meta at all: absent stamp reads as stale (the pre-stamp class). + assert!( + !indexer.index_matches_builder(&db), + "an index with no builder stamp must not count as this build's" + ); + + // A foreign binary's stamp: stale. + let env = crate::symbols::get_shared_scip_env(&db).unwrap(); + let mut wtxn = env.write_txn().unwrap(); + let meta_db: heed::Database = env + .create_database(&mut wtxn, Some(crate::constants::SCIP_META_DB_NAME)) + .unwrap(); + meta_db + .put(&mut wtxn, SCIP_INDEX_BUILDER_VERSION_KEY, "v0.0.0+1") + .unwrap(); + wtxn.commit().unwrap(); + assert!( + !indexer.index_matches_builder(&db), + "another build's stamp must not count as this build's" + ); + + // A rebuild by THIS binary: the meta write stamps the current version. + let env = crate::symbols::get_shared_scip_env(&db).unwrap(); + let mut wtxn = env.write_txn().unwrap(); + let meta_db: heed::Database = env + .open_database(&wtxn, Some(crate::constants::SCIP_META_DB_NAME)) + .unwrap() + .unwrap(); + super::csharp::CSharpSymbolIndexer::write_rebuild_meta(&meta_db, &mut wtxn, &[]) + .expect("meta write must succeed"); + wtxn.commit().unwrap(); + assert!( + indexer.index_matches_builder(&db), + "a rebuild by this binary must match (stamped {INDEX_BUILDER_VERSION})" + ); +} + +#[test] +fn rebuild_meta_write_stamps_version_and_writes_or_clears_warnings() { + use crate::constants::{INDEX_BUILDER_VERSION, SCIP_INDEX_BUILDER_VERSION_KEY}; + + let dir = tempfile::TempDir::new().unwrap(); + let db = dir.path().join("db"); + let indexer = super::csharp::CSharpSymbolIndexer::new(); + + // Degraded previous build: stale warnings + an old binary's stamp. + let env = crate::symbols::get_shared_scip_env(&db).unwrap(); + let mut wtxn = env.write_txn().unwrap(); + let meta_db: heed::Database = env + .create_database(&mut wtxn, Some(crate::constants::SCIP_META_DB_NAME)) + .unwrap(); + meta_db + .put( + &mut wtxn, + crate::constants::SCIP_INDEX_WARNINGS_KEY, + r#"["Old.csproj: Msbuild failed when processing the file"]"#, + ) + .unwrap(); + meta_db + .put(&mut wtxn, SCIP_INDEX_BUILDER_VERSION_KEY, "v0.0.0+1") + .unwrap(); + wtxn.commit().unwrap(); + + // A clean rebuild's meta write: stamp this build, clear the warnings. + let env = crate::symbols::get_shared_scip_env(&db).unwrap(); + let mut wtxn = env.write_txn().unwrap(); + let meta_db: heed::Database = env + .open_database(&wtxn, Some(crate::constants::SCIP_META_DB_NAME)) + .unwrap() + .unwrap(); + super::csharp::CSharpSymbolIndexer::write_rebuild_meta(&meta_db, &mut wtxn, &[]) + .expect("meta write must succeed"); + wtxn.commit().unwrap(); + + use crate::symbols::SymbolIndexer as _; + assert_eq!( + indexer.index_builder_version(&db).as_deref(), + Some(INDEX_BUILDER_VERSION), + "the rebuild meta write must stamp the producing build" + ); + assert!( + indexer.index_warnings(&db).is_empty(), + "a clean rebuild must clear the previous run's warnings" + ); + + // A degraded rebuild's meta write persists its warnings instead. + let env = crate::symbols::get_shared_scip_env(&db).unwrap(); + let mut wtxn = env.write_txn().unwrap(); + let meta_db: heed::Database = env + .open_database(&wtxn, Some(crate::constants::SCIP_META_DB_NAME)) + .unwrap() + .unwrap(); + super::csharp::CSharpSymbolIndexer::write_rebuild_meta( + &meta_db, + &mut wtxn, + &["Broken.csproj: Msbuild failed when processing the file".to_string()], + ) + .expect("meta write must succeed"); + wtxn.commit().unwrap(); + + // index_warnings_stored prepends the summary entry (summary first). + let warnings = indexer.index_warnings(&db); + assert_eq!( + warnings.len(), + 2, + "summary entry + the raw failed-project line, got: {warnings:?}" + ); + assert!( + warnings[0].contains("1 distinct failure(s)"), + "the summary entry must lead, got: {warnings:?}" + ); + assert_eq!( + warnings[1], + "Broken.csproj: Msbuild failed when processing the file".to_string(), + "a degraded rebuild's warnings must be persisted for the answer path" + ); +} + +// ── Simple-name extraction (fuzzy-lookup keys) ──────────────────────────── + +/// The live defect this pins: key format 2.0 writes fully-qualified +/// parameter types, and the old extractor split on '.' BEFORE stripping the +/// parameter list — landing inside the parameters. Every parameterized +/// method then keyed `scip_simple_names` under a fragment like +/// "Activity, int)" and fuzzy find_impact resolved NOTHING repository-wide +/// after the version-gate rebuilt all indexes to format 2.0. +#[test] +fn extract_simple_name_strips_fqn_parameters_before_segmenting() { + let cases = [ + // (canonical key, expected simple name) + ("csharp App . FieldDefinition#Validate().", "Validate"), + ( + "csharp SmallSolution.Library . Calculator#Add(int, int).", + "Add", + ), + ( + "csharp Acme.Catalog.Azure.TableStorage.DataStore . ActivityVersionStore#SaveBatchAsync(int, System.Collections.Generic.IReadOnlyList).", + "SaveBatchAsync", + ), + ( + "csharp Acme.Catalog.Import.CmdInfra . Arguments#GetVariableValue`1(string, Acme.Catalog.Import.CmdInfra.ArgumentValidator).", + "GetVariableValue", + ), + ("csharp . . . Namespace.TopLevel", "TopLevel"), + ("csharp App . MyService#", "MyService"), + ("csharp Ns.Sub . Class#_field", "_field"), + // Generic TYPE arity lives on the type segment — stripped too, not + // just the method-side backtick. + ("csharp Ns . List`1#", "List"), + ]; + for (key, expected) in cases { + assert_eq!( + super::csharp::extract_simple_name(key), + expected, + "key: {key}" + ); + } +} + +// ── Restore-pending gate (issue #225) ──────────────────────────────── + +#[test] +fn helper_version_line_parses_to_the_version_token() { + use super::csharp::parse_helper_version; + + let cases = [ + ("scip-csharp 1.5.4", "1.5.4"), + ("scip-csharp 0.0.0-fake", "0.0.0-fake"), + ("scip-csharp 1.5.4+1352", "1.5.4+1352"), + // Unparseable → "unknown": the startup entry still logs (as a + // mismatch) instead of silently skipping. + ("", "unknown"), + ("garbage", "unknown"), + ("scip-csharp", "unknown"), + ]; + for (line, expected) in cases { + assert_eq!(parse_helper_version(line), expected, "line: {line:?}"); + } +} + +#[test] +fn restore_pending_error_downcasts_from_anyhow() { + let pending = anyhow::Error::new(RestorePendingError); + assert!(is_restore_pending(&pending)); + + let generic = anyhow::anyhow!("Failed to read symbol index at /tmp/x.json"); + assert!(!is_restore_pending(&generic)); +} + +#[test] +fn restore_pending_flag_round_trips_through_the_trait_method() { + use super::SymbolIndexer as _; + + let db_path = PathBuf::from(format!( + "{}cs-restore-flag-test-{}", + std::env::temp_dir().display(), + std::process::id() + )); + let indexer = super::csharp::CSharpSymbolIndexer::new(); + restore_pending_flag_clear(&db_path); // isolate from concurrent tests + assert!(!indexer.restore_pending(&db_path)); + + restore_pending_flag_set(&db_path); + assert!(indexer.restore_pending(&db_path)); + + restore_pending_flag_clear(&db_path); + assert!(!indexer.restore_pending(&db_path)); +} + +#[test] +fn helper_restore_pending_exit_matches_csharp_exit_codes() { + // A drifted exit code would demote restore-pending to a generic helper failure. + let path = concat!(env!("CARGO_MANIFEST_DIR"), "/helpers/csharp/RestoreGate.cs"); + let source = std::fs::read_to_string(path) + .unwrap_or_else(|e| panic!("cannot read {path} to check HELPER_RESTORE_PENDING_EXIT: {e}")); + let line = source + .lines() + .find(|l| l.contains("const int RestorePending")) + .unwrap_or_else(|| { + panic!("{path} has no `const int RestorePending` line to compare with HELPER_RESTORE_PENDING_EXIT") + }); + let raw = line + .split_once('=') + .and_then(|(_, rhs)| rhs.split_once(';')) + .map(|(value, _)| value.trim()) + .unwrap_or_else(|| { + panic!( + "cannot find `= ;` in {line:?} to compare with HELPER_RESTORE_PENDING_EXIT" + ) + }); + let parsed: i32 = raw.parse().unwrap_or_else(|e| { + panic!("C# RestorePending value {raw:?} is not an integer ({e}); compare with HELPER_RESTORE_PENDING_EXIT") + }); + assert_eq!( + parsed, HELPER_RESTORE_PENDING_EXIT, + "C# ExitCodes.RestorePending ({parsed}) and Rust HELPER_RESTORE_PENDING_EXIT ({HELPER_RESTORE_PENDING_EXIT}) must stay in sync" + ); +} + +/// serve shutdown must kill in-flight helper children: an orphaned +/// scip-csharp holds the helper exe locked for minutes (deploy blocker). +/// The registry is PID-generic, so a stand-in long-running child verifies +/// the real kill path (taskkill /T /F on Windows, kill -9 elsewhere). +#[test] +fn shutdown_kills_registered_helper_children() { + #[cfg(windows)] + let mut child = std::process::Command::new("cmd") + .args(["/c", "ping", "-n", "30", "127.0.0.1"]) + .stdout(std::process::Stdio::null()) + .stderr(std::process::Stdio::null()) + .spawn() + .expect("stand-in child spawned"); + #[cfg(not(windows))] + let mut child = std::process::Command::new("sleep") + .arg("30") + .stdout(std::process::Stdio::null()) + .stderr(std::process::Stdio::null()) + .spawn() + .expect("stand-in child spawned"); + + let pid = child.id(); + { + let _live = LiveHelperChild::register(&child); + kill_live_helper_children(); + } + + let status = child.wait().expect("child waited"); + assert!( + !status.success(), + "a killed helper child must not report success (pid {pid})" + ); +} diff --git a/src/symbols/mod.rs b/src/symbols/mod.rs index c3542077..dec4544f 100644 --- a/src/symbols/mod.rs +++ b/src/symbols/mod.rs @@ -69,11 +69,17 @@ pub struct FindImpactResult { /// reference list may be INCOMPLETE — a helper failure was survived /// rather than fatal (a project that would not compile, an exception /// during reference resolution, a non-zero scip-typescript exit) and - /// the partial result was kept. Entries name what failed. Omitted when - /// empty: absent means the answer is as complete as the index knows. + /// the partial result was kept, OR the index itself was built out of a + /// partially loaded solution (index-level rebuild warnings, e.g. + /// MSBuild project-load failures; see `SymbolIndexer::index_warnings`). + /// Entries name what failed. Omitted when empty: absent means the + /// answer is as complete as the index knows. #[serde(skip_serializing_if = "Vec::is_empty")] pub warnings: Vec, - /// Seconds since the symbol index was last rebuilt. + /// Seconds since the symbol index was last rebuilt. `u64::MAX` is the + /// internal "age unknown" sentinel `index_age` returns when the index + /// cannot be opened or read; over the wire it serializes as null. + #[serde(serialize_with = "serialize_index_age")] pub index_age_seconds: u64, /// Language that produced this result. pub language: String, @@ -90,6 +96,36 @@ pub struct FindImpactResult { /// never fail the response). #[serde(skip_serializing_if = "Option::is_none")] pub current_head_sha: Option, + /// Per-language symbol-index status for the searched repo (applicable + /// languages only) — lets a consumer judge `references: []` against the + /// state of the index that produced it (`absent`/`stale`/ + /// `restore-pending` mean the empty answer reflects the index, not the + /// code) without a second round-trip to repo info. Omitted when empty. + #[serde(skip_serializing_if = "Vec::is_empty")] + pub symbol_index: Vec, +} + +/// Serialize `index_age_seconds`, mapping the internal unknown-age sentinel +/// (`u64::MAX`) to JSON null — a consumer must not see +/// `18446744073709551615` and mistake it for an age. Real ages stay numbers. +fn serialize_index_age(age: &u64, serializer: S) -> Result +where + S: serde::Serializer, +{ + if *age == u64::MAX { + serializer.serialize_none() + } else { + serializer.serialize_u64(*age) + } +} + +/// The deserialize half of [`serialize_index_age`]: a JSON null (an +/// unknown-age index on the wire) lands back in the `u64::MAX` sentinel. +fn deserialize_index_age<'de, D>(deserializer: D) -> Result +where + D: serde::Deserializer<'de>, +{ + Ok(Option::::deserialize(deserializer)?.unwrap_or(u64::MAX)) } /// A `find_impact` query in the form the adapters resolve it. @@ -236,6 +272,11 @@ pub struct SymbolLookupFailure { pub class: SymbolLookupFailureClass, /// Actionable hint for the agent. pub hint_for_agent: String, + /// Index-level context (heal running, partially loaded index): without + /// it the failure would advise an action that is already in progress. + /// Absent from the wire when empty — the historical failure shape. + #[serde(default, skip_serializing_if = "Vec::is_empty")] + pub warnings: Vec, } impl SymbolLookupFailure { @@ -248,6 +289,7 @@ impl SymbolLookupFailure { immediately; fall back to `find` with kind=\"usages\" (text-based) \ and/or reindex the project to rebuild the symbol index." .to_string(), + warnings: Vec::new(), } } @@ -260,6 +302,7 @@ impl SymbolLookupFailure { first (`codesearch index` / `index reindex`), then retry the \ same call." .to_string(), + warnings: Vec::new(), } } @@ -377,6 +420,10 @@ pub struct RebuildSummary { pub references_stored: usize, /// Wall-clock duration in milliseconds. pub duration_ms: u64, + /// Index-level completeness warnings from this build (build-environment + /// failures the helper survived; see [`SymbolIndexer::index_warnings`]). + /// Empty = built clean. Drives the TUI's degraded indicator. + pub index_warnings: Vec, } /// Summary returned after a Phase 3 pre-warm completes. @@ -448,6 +495,44 @@ pub trait SymbolIndexer: Send + Sync { /// How old is the current symbol index (seconds since last rebuild)? fn index_age(&self, db_path: &Path) -> u64; + /// Index-level completeness warnings from the last rebuild — build + /// environment failures the language helper survived while still + /// producing an index (e.g. MSBuild project-load failures for C#). + /// Non-empty means reference lists from this index may be incomplete + /// EVEN WHEN a lookup succeeds, and callers should attach these + /// warnings to answers served from this index. Plain read; empty is + /// the default for adapters that do not track build-environment state. + fn index_warnings(&self, _db_path: &Path) -> Vec { + Vec::new() + } + + /// True while this index's rebuild is waiting out a still-running NuGet + /// restore (C# restore gate, issue #225). Callers attach one + /// caller-facing warning to answers served from the previous index; + /// the flag lifts when the retry loop ends either way. Default false — + /// adapters without a restore gate are never pending. + fn restore_pending(&self, _db_path: &Path) -> bool { + false + } + + /// Which codesearch build produced the current symbol index + /// (`scip_meta[index_builder_version]`). `None` means absent or + /// unreadable — the C# rebuild gate treats that as stale, so a newly + /// deployed binary rebuilds the indexes it inherited itself at startup + /// instead of serving an index it never produced. + fn index_builder_version(&self, _db_path: &Path) -> Option { + None + } + + /// Whether the current symbol index was produced by THIS build — the + /// same freshness check the rebuild gate applies before serving without + /// a rebuild (absent stamp or a stamp from another build ⇒ stale). + /// Default `true`: adapters that do not stamp their indexes are never + /// stale by builder alone (there is no stamp to compare against). + fn index_matches_builder(&self, _db_path: &Path) -> bool { + true + } + /// The git HEAD sha the current symbol index was built for, when /// recorded. `None` means unknown (pre-fingerprint index, or git was /// unreadable at build time). Compare with the repository's current @@ -479,6 +564,14 @@ pub trait SymbolIndexer: Send + Sync { true } + /// Why `applies_to` would refuse a repository, in one clause. Surfaced + /// by find_impact's missing-index warning so a repo that can never get + /// a symbol index says so — instead of promising a rebuild that will + /// not happen. Adapters override next to their `applies_to`. + fn applicability_hint(&self) -> &'static str { + "the repository has no entrypoint this symbol indexer recognizes" + } + /// Downcast to `Any` for concrete-type method access (e.g. `prewarm_ref_cache`). /// /// This is needed because some adapter-specific methods (like Phase 3 pre-warm) @@ -554,6 +647,81 @@ impl Default for SymbolIndexerRegistry { } } +/// One symbol language's index status for a repository — the on-disk truth +/// the rebuild gates act on, composed from plain meta reads (never a +/// helper). Info surfaces (REST `/repos/:alias/info`, both TUI Info +/// overlays) and `find_impact` answers carry it so a consumer can judge an +/// answer against the state of the index that produced it. +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct SymbolIndexStatus { + /// Symbol language this entry describes (e.g. `csharp`). + pub language: String, + /// `ready` | `degraded` | `stale` | `restore-pending` | `absent` | + /// `not-applicable`. + pub state: String, + /// Seconds since the last rebuild; the unknown-age sentinel + /// (`u64::MAX`) serializes as null and a null payload deserializes back + /// into the sentinel — the remote TUI consumes REST JSON where an + /// unreadable index arrives as null. + #[serde( + serialize_with = "serialize_index_age", + deserialize_with = "deserialize_index_age" + )] + pub age_seconds: u64, + /// The repo lacks this language's entrypoint — no index is expected + /// here. `find_impact` filters these out; info surfaces keep them so + /// the operator sees why a language is missing. + #[serde(skip_serializing_if = "std::ops::Not::not")] + pub not_applicable: bool, +} + +/// Compose [`SymbolIndexStatus`] for every registered symbol language, in +/// registration order. Priority when several states apply: +/// `restore-pending` (a live gate) > `stale` (a rebuild is imminent) > +/// `degraded` (serving but incomplete) > `ready`. +pub fn symbol_index_status( + registry: &SymbolIndexerRegistry, + project_path: &Path, + db_path: &Path, +) -> Vec { + registry + .available_languages() + .iter() + .filter_map(|lang| registry.get(lang)) + .map(|indexer| { + let age = indexer.index_age(db_path); + let base = SymbolIndexStatus { + language: indexer.language().to_string(), + state: String::new(), + age_seconds: age, + not_applicable: false, + }; + if !indexer.applies_to(project_path) { + return SymbolIndexStatus { + state: "not-applicable".to_string(), + not_applicable: true, + ..base + }; + } + let state = if !indexer.has_index(db_path) { + "absent" + } else if indexer.restore_pending(db_path) { + "restore-pending" + } else if !indexer.index_matches_builder(db_path) { + "stale" + } else if !indexer.index_warnings(db_path).is_empty() { + "degraded" + } else { + "ready" + }; + SymbolIndexStatus { + state: state.to_string(), + ..base + } + }) + .collect() +} + #[cfg(test)] mod tests { use super::*; diff --git a/src/symbols/resident.rs b/src/symbols/resident.rs index 49ec3a8b..4003ecd1 100644 --- a/src/symbols/resident.rs +++ b/src/symbols/resident.rs @@ -454,6 +454,20 @@ impl WorkspacePool { resident } + /// Kill every resident workspace child — serve shutdown. Statics are + /// never dropped at process exit, so neither the [`ServeClient::Drop`] + /// kill nor TTL reaping runs there; without this a `scip-csharp serve` + /// child keeps waiting on its stdin pipe after the host is gone. + pub(crate) fn kill_all(&self) { + let victims: Vec> = { + let mut entries = self.entries.lock().expect("workspace pool poisoned"); + entries.drain().map(|(_, e)| e.client).collect() + }; + for c in victims { + c.kill(); // OS call — outside the pool lock + } + } + /// Drop the resident workspace for `solution`, if any, so the next /// `find_refs` respawns against current on-disk source instead of /// answering from a compilation loaded before the latest change. A diff --git a/src/symbols/resident_tests.rs b/src/symbols/resident_tests.rs index 1937308c..9aaf0776 100644 --- a/src/symbols/resident_tests.rs +++ b/src/symbols/resident_tests.rs @@ -413,3 +413,34 @@ fn resident_pool_surfaces_client_failure_to_the_fallback() { .expect_err("a failing helper must surface an error for the one-shot fallback"); assert!(err.to_string().contains("mock helper failed")); } + +/// serve shutdown: statics are never dropped at process exit, so the +/// `ServeClient::Drop` kill never fires there. `kill_all` must kill every +/// resident child and leave the pool empty (a later request respawns). +#[test] +fn kill_all_kills_every_resident_child_and_empties_the_pool() { + let h = harness(2, Duration::from_secs(600)); + + h.pool + .find_refs(&PathBuf::from("h.exe"), &sln("a"), "Sym") + .unwrap(); + h.pool + .find_refs(&PathBuf::from("h.exe"), &sln("b"), "Sym") + .unwrap(); + assert_eq!(h.state.kill_count.load(Ordering::SeqCst), 0); + + h.pool.kill_all(); + + assert_eq!( + h.state.kill_count.load(Ordering::SeqCst), + 2, + "every resident child must be killed on shutdown" + ); + + // Pool emptied: a follow-up request respawns instead of reusing a + // killed client. + h.pool + .find_refs(&PathBuf::from("h.exe"), &sln("a"), "Sym") + .unwrap(); + assert_eq!(h.spawns.load(Ordering::SeqCst), 3); +} diff --git a/src/symbols/typescript.rs b/src/symbols/typescript.rs index 1cc11b24..2925dc35 100644 --- a/src/symbols/typescript.rs +++ b/src/symbols/typescript.rs @@ -611,6 +611,7 @@ impl SymbolIndexer for TypeScriptSymbolIndexer { symbols_indexed: total_symbols, references_stored: total_refs, duration_ms, + index_warnings: Vec::new(), }) } @@ -779,6 +780,10 @@ impl SymbolIndexer for TypeScriptSymbolIndexer { Self::find_tsconfig(repo_path).is_some() } + fn applicability_hint(&self) -> &'static str { + "the scip-typescript adapter requires a top-level tsconfig.json (monorepo layouts are not resolved yet)" + } + fn as_any(&self) -> &dyn std::any::Any { self } diff --git a/src/watch/mod.rs b/src/watch/mod.rs index 42ddf268..73a1a81e 100644 --- a/src/watch/mod.rs +++ b/src/watch/mod.rs @@ -291,6 +291,21 @@ impl FileWatcher { } } + // C# restore inputs (Directory.Packages.props etc.) are not an + // indexable language, but the watcher must still see them: a change + // invalidates NuGet restore state for the whole solution and drives + // a full C# symbol rebuild (issue #225). Checked before the + // 0-byte/language gates — an empty NuGet.config is a meaningful + // restore input too. + if let Some(name) = path.file_name().and_then(|n| n.to_str()) { + if crate::constants::CSHARP_RESTORE_INPUT_FILES + .iter() + .any(|f| name.eq_ignore_ascii_case(f)) + { + return true; + } + } + // Skip 0-byte files (empty build artifacts) if path.metadata().map(|m| m.len() == 0).unwrap_or(false) { return false; @@ -570,6 +585,12 @@ impl GitHeadWatcher { match Command::new("git") .current_dir(&self.git_root) .args(["rev-parse", "HEAD"]) + // Ambient GIT_DIR/GIT_WORK_TREE (e.g. from a push hook) would + // override current_dir; key the watcher off git_root alone. + .env_remove("GIT_DIR") + .env_remove("GIT_WORK_TREE") + .env_remove("GIT_INDEX_FILE") + .env_remove("GIT_OBJECT_DIRECTORY") .output() { Ok(o) => { @@ -633,6 +654,8 @@ impl GitHeadWatcher { #[cfg(test)] mod tests { use super::*; + use crate::testing::EnvRestore; + use serial_test::serial; use std::fs; use std::process::Command; use tempfile::tempdir; @@ -643,7 +666,15 @@ mod tests { const MAX_ATTEMPTS: u64 = 5; let mut output = None; for attempt in 0..MAX_ATTEMPTS { - match Command::new("git").args(args).current_dir(cwd).output() { + match Command::new("git") + .args(args) + .current_dir(cwd) + .env_remove("GIT_DIR") + .env_remove("GIT_WORK_TREE") + .env_remove("GIT_INDEX_FILE") + .env_remove("GIT_OBJECT_DIRECTORY") + .output() + { Ok(o) => { output = Some(o); break; @@ -672,9 +703,21 @@ mod tests { Ok(()) } + /// Build a `FileWatcher` with the home directory pointed at an empty + /// temporary directory, so the developer's real + /// `~/.codesearch/.codesearchignore` cannot leak into the assertions. + /// CI has no such file, which is why the ambient dependency went unnoticed. + fn watcher_with_isolated_home(root: PathBuf) -> FileWatcher { + let home = tempdir().unwrap(); + let home = home.path().to_string_lossy().into_owned(); + let _guard = EnvRestore::set(&[("HOME", &home), ("USERPROFILE", &home)]); + FileWatcher::new(root) + } + #[test] + #[serial] fn test_is_watchable() { - let watcher = FileWatcher::new(PathBuf::from("/tmp")); + let watcher = watcher_with_isolated_home(PathBuf::from("/tmp")); // Should NOT watch (ignored dirs) assert!(!watcher.is_watchable(Path::new("/tmp/.git/config"))); @@ -688,6 +731,13 @@ mod tests { assert!(!watcher.is_watchable(Path::new("/tmp/image.png"))); assert!(!watcher.is_watchable(Path::new("/tmp/data.bin"))); + // Should NOT watch (dependency lock files — name-based, covers names + // whose extension alone is indexable like .yaml/.json/.lockb) + assert!(!watcher.is_watchable(Path::new("/tmp/pnpm-lock.yaml"))); + assert!(!watcher.is_watchable(Path::new("/tmp/package-lock.json"))); + assert!(!watcher.is_watchable(Path::new("/tmp/npm-shrinkwrap.json"))); + assert!(!watcher.is_watchable(Path::new("/tmp/bun.lockb"))); + // SHOULD watch (code files) assert!(watcher.is_watchable(Path::new("/tmp/src/main.rs"))); assert!(watcher.is_watchable(Path::new("/tmp/src/lib.ts"))); @@ -705,7 +755,37 @@ mod tests { assert!(watcher.is_watchable(Path::new("/tmp/Makefile"))); } + /// The restore-input admission gate: an EMPTY NuGet.config is a + /// meaningful restore input, so the name gate must sit BEFORE the + /// 0-byte skip — and .props is not an indexable language, so without the + /// gate the file would never reach the full-rebuild flush at all. + #[test] + #[serial] + fn restore_inputs_are_watchable_even_empty_and_lookalikes_are_not() { + let dir = tempdir().unwrap(); + let root = dir.path(); + + fs::write(root.join("NuGet.config"), "").unwrap(); + fs::write(root.join("Directory.Packages.props.bak"), "x").unwrap(); + + let watcher = watcher_with_isolated_home(root.to_path_buf()); + + assert!( + watcher.is_watchable(&root.join("NuGet.config")), + "an empty nuget.config must stay watchable: the restore-input gate precedes the 0-byte skip" + ); + assert!( + watcher.is_watchable(&root.join("Directory.Packages.props")), + ".props is not indexable — only the restore-input gate admits it" + ); + assert!( + !watcher.is_watchable(&root.join("Directory.Packages.props.bak")), + ".bak lookalike must not pass the name gate" + ); + } + #[test] + #[serial] fn test_gitignore_rules_respected() { let dir = tempdir().unwrap(); let root = dir.path(); @@ -717,7 +797,7 @@ mod tests { ) .unwrap(); - let watcher = FileWatcher::new(root.to_path_buf()); + let watcher = watcher_with_isolated_home(root.to_path_buf()); assert!(watcher.gitignore.is_some(), "Should have loaded .gitignore"); // Should NOT watch (gitignored patterns) @@ -751,9 +831,10 @@ mod tests { #[test] #[ignore] // Requires actual filesystem events + #[serial] fn test_file_watcher() { let dir = tempdir().unwrap(); - let mut watcher = FileWatcher::new(dir.path().to_path_buf()); + let mut watcher = watcher_with_isolated_home(dir.path().to_path_buf()); watcher.start(100).unwrap(); @@ -769,6 +850,7 @@ mod tests { } #[test] + #[serial] fn test_codesearchignore_loaded_and_respected() { let dir = tempdir().unwrap(); let root = dir.path(); @@ -776,7 +858,7 @@ mod tests { // Create repo-local .codesearchignore excluding tests/ fs::write(root.join(".codesearchignore"), "tests/\n").unwrap(); - let watcher = FileWatcher::new(root.to_path_buf()); + let watcher = watcher_with_isolated_home(root.to_path_buf()); assert!( watcher.gitignore.is_some(), "Should have loaded .codesearchignore" @@ -793,6 +875,7 @@ mod tests { } #[test] + #[serial] fn test_codesearchignore_overrides_gitignore() { let dir = tempdir().unwrap(); let root = dir.path(); @@ -802,7 +885,7 @@ mod tests { fs::write(root.join(".gitignore"), "logs/\n").unwrap(); fs::write(root.join(".codesearchignore"), "src/generated/\n").unwrap(); - let watcher = FileWatcher::new(root.to_path_buf()); + let watcher = watcher_with_isolated_home(root.to_path_buf()); assert!(watcher.gitignore.is_some()); // .gitignore pattern takes effect @@ -823,11 +906,12 @@ mod tests { } #[test] + #[serial] fn test_no_ignore_files_returns_none() { let dir = tempdir().unwrap(); let root = dir.path(); - let watcher = FileWatcher::new(root.to_path_buf()); + let watcher = watcher_with_isolated_home(root.to_path_buf()); assert!( watcher.gitignore.is_none(), "Should have no gitignore matcher when no ignore files exist" diff --git a/tests/helpers/mod.rs b/tests/helpers/mod.rs index 9cd020ce..09d4bad3 100644 --- a/tests/helpers/mod.rs +++ b/tests/helpers/mod.rs @@ -137,7 +137,14 @@ impl TestRepo { /// Run a git command in the repository. fn run_git(cwd: &std::path::Path, args: &[&str]) -> anyhow::Result<()> { - let output = Command::new("git").args(args).current_dir(cwd).output()?; + let output = Command::new("git") + .args(args) + .current_dir(cwd) + .env_remove("GIT_DIR") + .env_remove("GIT_WORK_TREE") + .env_remove("GIT_INDEX_FILE") + .env_remove("GIT_OBJECT_DIRECTORY") + .output()?; if !output.status.success() { return Err(anyhow::anyhow!( diff --git a/tests/mcp_protocol_bridge.rs b/tests/mcp_protocol_bridge.rs new file mode 100644 index 00000000..9a7d2ef6 --- /dev/null +++ b/tests/mcp_protocol_bridge.rs @@ -0,0 +1,109 @@ +//! Wire-shape guard for the SEP-2322 `resultType` discriminator. +//! +//! Pins the behavior of the `[codesearch bridge]` block in +//! `vendor/rmcp/src/service/server.rs` (`negotiate_protocol_version`) at the +//! wire level, so the next rmcp bump that loses the bridge fails loudly here +//! instead of silently reintroducing the Claude Code >= 2.1.296 breakage +//! ("Invalid result for tools/list: missing required resultType"). +//! +//! Runs the real `codesearch mcp --mode local` binary over stdio, exactly the +//! way an MCP client drives it, and asserts both wire shapes: +//! +//! - initialize offering `2026-07-28`: session negotiated at `2026-07-28` and +//! every `tools/list` result carries `"resultType":"complete"`; +//! - initialize offering `2025-11-25`: stock legacy negotiation, `tools/list` +//! keeps the historical shape (no `resultType` field at all). + +use serde_json::{json, Value}; +use std::io::Write; +use std::process::{Command, Stdio}; + +/// Drive the real MCP server over stdio: initialize with `offer`, then +/// tools/list. Returns every JSON-RPC response line, parsed. +fn probe(offer: &str) -> Vec { + let tmp = tempfile::TempDir::new().expect("temp dir"); + let mut child = Command::new(env!("CARGO_BIN_EXE_codesearch")) + .args(["mcp", "--mode", "local"]) + .current_dir(tmp.path()) + .stdin(Stdio::piped()) + .stdout(Stdio::piped()) + .stderr(Stdio::null()) + .spawn() + .expect("spawn codesearch mcp"); + + let initialize = json!({ + "jsonrpc": "2.0", + "id": 1, + "method": "initialize", + "params": { + "protocolVersion": offer, + "capabilities": {}, + "clientInfo": {"name": "bridge-test", "version": "0.0.1"} + } + }); + let initialized = json!({"jsonrpc": "2.0", "method": "notifications/initialized"}); + let list_tools = json!({"jsonrpc": "2.0", "id": 2, "method": "tools/list"}); + + { + let stdin = child.stdin.as_mut().expect("stdin"); + for line in [initialize, initialized, list_tools] { + writeln!(stdin, "{line}").expect("write request"); + } + stdin.flush().expect("flush stdin"); + } + drop(child.stdin.take()); + + let output = child.wait_with_output().expect("run codesearch mcp"); + assert!( + output.status.success(), + "codesearch mcp exited with {:?}", + output.status + ); + + String::from_utf8(output.stdout) + .expect("utf-8 stdout") + .lines() + .map(|line| serde_json::from_str(line).expect("json-rpc response line")) + .collect() +} + +fn find_response(responses: &[Value], id: i64) -> &Value { + responses + .iter() + .find(|r| r.get("id") == Some(&json!(id))) + .unwrap_or_else(|| panic!("no response with id {id} in {responses:?}")) +} + +#[test] +fn session_on_2026_07_28_keeps_result_type() { + let responses = probe("2026-07-28"); + + let init = find_response(&responses, 1); + assert_eq!( + init["result"]["protocolVersion"], "2026-07-28", + "bridge must honor a 2026-07-28 offer instead of downgrading" + ); + + let tools = find_response(&responses, 2); + assert_eq!( + tools["result"]["resultType"], "complete", + "tools/list must carry the SEP-2322 discriminator on a 2026-07-28 session" + ); +} + +#[test] +fn legacy_session_keeps_historical_wire_shape() { + let responses = probe("2025-11-25"); + + let init = find_response(&responses, 1); + assert_eq!( + init["result"]["protocolVersion"], "2025-11-25", + "stock negotiation must stay untouched for legacy clients" + ); + + let tools = find_response(&responses, 2); + assert!( + tools["result"].get("resultType").is_none(), + "legacy sessions must keep the historical wire shape without resultType" + ); +} diff --git a/vendor/rmcp/.cargo-ok b/vendor/rmcp/.cargo-ok new file mode 100644 index 00000000..5f8b7958 --- /dev/null +++ b/vendor/rmcp/.cargo-ok @@ -0,0 +1 @@ +{"v":1} \ No newline at end of file diff --git a/vendor/rmcp/.cargo_vcs_info.json b/vendor/rmcp/.cargo_vcs_info.json new file mode 100644 index 00000000..4a2731ef --- /dev/null +++ b/vendor/rmcp/.cargo_vcs_info.json @@ -0,0 +1,6 @@ +{ + "git": { + "sha1": "0cde3c5cf3e6aff0cc852ce6045f107e95991f48" + }, + "path_in_vcs": "crates/rmcp" +} \ No newline at end of file diff --git a/vendor/rmcp/CHANGELOG.md b/vendor/rmcp/CHANGELOG.md new file mode 100644 index 00000000..b65da0ab --- /dev/null +++ b/vendor/rmcp/CHANGELOG.md @@ -0,0 +1,1003 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +## [3.5.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v3.4.1...rmcp-v3.5.0) - 2026-09-27 + +### Added + +- update LATEST and add LATEST_WITH_INITIALIZE ([#1105](https://github.com/modelcontextprotocol/rust-sdk/pull/1105)) + +### Fixed + +- *(model)* decode float fields through serde_json::Number ([#1300](https://github.com/modelcontextprotocol/rust-sdk/pull/1300)) +- *(rmcp)* reject duplicate sep-2243 headers ([#1274](https://github.com/modelcontextprotocol/rust-sdk/pull/1274)) +- *(transport)* match explicit default ports in Origin allowlist ([#1270](https://github.com/modelcontextprotocol/rust-sdk/pull/1270)) +- *(rmcp)* tolerate empty cacheScope instead of silently dropping the whole result ([#1281](https://github.com/modelcontextprotocol/rust-sdk/pull/1281)) +- *(model)* preserve explicit null structuredContent in CallToolResult ([#1295](https://github.com/modelcontextprotocol/rust-sdk/pull/1295)) + +### Other + +- cargo fmt fixes on validate_standard_headers changes ([#1275](https://github.com/modelcontextprotocol/rust-sdk/pull/1275)) + +## [3.4.1](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v3.4.0...rmcp-v3.4.1) - 2026-09-23 + +### Fixed + +- *(transport)* fall back after JSON discover rejections ([#1288](https://github.com/modelcontextprotocol/rust-sdk/pull/1288)) +- *(macros)* accept const paths and concat! in tool/prompt descriptions ([#1243](https://github.com/modelcontextprotocol/rust-sdk/pull/1243)) + +### Other + +- *(deps)* update rstest requirement from 0.26.1 to 0.27.0 ([#1276](https://github.com/modelcontextprotocol/rust-sdk/pull/1276)) + +## [3.4.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v3.3.0...rmcp-v3.4.0) - 2026-09-15 + +### Added + +- *(model)* add ServerConfig and ClientConfig ([#1266](https://github.com/modelcontextprotocol/rust-sdk/pull/1266)) + +### Fixed + +- *(rmcp)* use ServerConfig in cancellation test ([#1273](https://github.com/modelcontextprotocol/rust-sdk/pull/1273)) +- *(rmcp)* route peer cancellation by lifecycle ([#1262](https://github.com/modelcontextprotocol/rust-sdk/pull/1262)) +- run first pre-init request in service loop ([#1263](https://github.com/modelcontextprotocol/rust-sdk/pull/1263)) +- *(auth)* let url origin decide prm discovery ([#1264](https://github.com/modelcontextprotocol/rust-sdk/pull/1264)) +- *(model)* deprecate ServerInfo and ClientInfo aliases ([#1156](https://github.com/modelcontextprotocol/rust-sdk/pull/1156)) +- *(auth)* ignore non-metadata JSON when probing for protected resource metadata ([#1204](https://github.com/modelcontextprotocol/rust-sdk/pull/1204)) +- do not treat malformed JSON 200 as Accepted for requests ([#1208](https://github.com/modelcontextprotocol/rust-sdk/pull/1208)) +- *(streamable-http-server)* map handler-generated HeaderMismatch to HTTP 400 ([#1259](https://github.com/modelcontextprotocol/rust-sdk/pull/1259)) +- *(http)* enforce Origin validation semantics ([#1192](https://github.com/modelcontextprotocol/rust-sdk/pull/1192)) + +## [3.3.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v3.2.0...rmcp-v3.3.0) - 2026-09-10 + +### Added + +- add ServerHandler::negotiate_initialize ([#1247](https://github.com/modelcontextprotocol/rust-sdk/pull/1247)) +- *(macros)* reject empty tool_router ([#1233](https://github.com/modelcontextprotocol/rust-sdk/pull/1233)) +- *(auth)* add enterprise refresh-token and ID-JAG exchanges ([#1234](https://github.com/modelcontextprotocol/rust-sdk/pull/1234)) + +### Fixed + +- *(sse)* saturate exponential reconnect backoff to avoid overflow panic ([#1231](https://github.com/modelcontextprotocol/rust-sdk/pull/1231)) +- resolve clippy warnings across workspace ([#1195](https://github.com/modelcontextprotocol/rust-sdk/pull/1195)) +- *(auth)* unify refresh checks and error handling ([#1236](https://github.com/modelcontextprotocol/rust-sdk/pull/1236)) + +### Other + +- *(deps)* update process-wrap requirement from 9.0 to 10.0 ([#1229](https://github.com/modelcontextprotocol/rust-sdk/pull/1229)) + +## [3.2.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v3.1.4...rmcp-v3.2.0) - 2026-08-31 + +### Added + +- *(auth)* coordinate OAuth refreshes through credential stores ([#1232](https://github.com/modelcontextprotocol/rust-sdk/pull/1232)) +- add request-state key rotation ([#1128](https://github.com/modelcontextprotocol/rust-sdk/pull/1128)) + +### Fixed + +- keep initialize on legacy protocol versions ([#1228](https://github.com/modelcontextprotocol/rust-sdk/pull/1228)) +- *(transport)* fall back after sessionless HTTP discover rejections ([#1211](https://github.com/modelcontextprotocol/rust-sdk/pull/1211)) +- allow concurrent streamable http requests ([#1186](https://github.com/modelcontextprotocol/rust-sdk/pull/1186)) + +## [3.1.4](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v3.1.3...rmcp-v3.1.4) - 2026-08-18 + +### Fixed + +- *(rmcp)* preserve elicitation requestedSchema $schema dialect ([#1176](https://github.com/modelcontextprotocol/rust-sdk/pull/1176)) +- harden signing key handling ([#1166](https://github.com/modelcontextprotocol/rust-sdk/pull/1166)) +- report pre-init metadata errors ([#1160](https://github.com/modelcontextprotocol/rust-sdk/pull/1160)) + +## [3.1.3](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v3.1.2...rmcp-v3.1.3) - 2026-08-17 + +### Fixed + +- *(auth)* ignore query parameters when matching resources ([#1177](https://github.com/modelcontextprotocol/rust-sdk/pull/1177)) +- *(auth)* retain state until issuer validation ([#1167](https://github.com/modelcontextprotocol/rust-sdk/pull/1167)) +- *(model)* preserve elicitation property order metadata ([#1150](https://github.com/modelcontextprotocol/rust-sdk/pull/1150)) +- time out auto discovery probe ([#1149](https://github.com/modelcontextprotocol/rust-sdk/pull/1149)) +- *(client)* classify discover outcome at source, not at the error type ([#1133](https://github.com/modelcontextprotocol/rust-sdk/pull/1133)) + +### Other + +- Fix typo in to_authorized_http_client doc comment ([#1158](https://github.com/modelcontextprotocol/rust-sdk/pull/1158)) + +## [3.1.2](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v3.1.1...rmcp-v3.1.2) - 2026-08-07 + +### Fixed + +- *(auth)* map 401/403 challenges on the SSE GET stream ([#1152](https://github.com/modelcontextprotocol/rust-sdk/pull/1152)) +- *(sse)* loop instead of recursing when skipping SSE events ([#1146](https://github.com/modelcontextprotocol/rust-sdk/pull/1146)) +- *(auth)* preserve issuer trailing slash during discovery ([#1145](https://github.com/modelcontextprotocol/rust-sdk/pull/1145)) + +## [3.1.1](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v3.1.0...rmcp-v3.1.1) - 2026-08-05 + +### Fixed + +- emit cache hints from handler macros ([#1120](https://github.com/modelcontextprotocol/rust-sdk/pull/1120)) +- expose MRTR state to tool handlers ([#1104](https://github.com/modelcontextprotocol/rust-sdk/pull/1104)) +- disambiguate input-required results ([#1103](https://github.com/modelcontextprotocol/rust-sdk/pull/1103)) + +### Other + +- make async-trait optional ([#1119](https://github.com/modelcontextprotocol/rust-sdk/pull/1119)) + +## [3.1.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v3.0.1...rmcp-v3.1.0) - 2026-07-31 + +### Added + +- classify authorization-required errors ([#1056](https://github.com/modelcontextprotocol/rust-sdk/pull/1056)) +- add strict stateless protocol metadata validation ([#1091](https://github.com/modelcontextprotocol/rust-sdk/pull/1091)) +- SEP-2260 stream-based enforcement of client receive-side request association ([#1055](https://github.com/modelcontextprotocol/rust-sdk/pull/1055)) + +### Fixed + +- *(model)* decode metadata-bearing input-required results affecting mrtr ([#1097](https://github.com/modelcontextprotocol/rust-sdk/pull/1097)) +- require metadata for modern HTTP requests ([#1089](https://github.com/modelcontextprotocol/rust-sdk/pull/1089)) +- honor supported_protocol_versions when negotiating initialize ([#1093](https://github.com/modelcontextprotocol/rust-sdk/pull/1093)) + +### Other + +- document the ping utility with examples ([#1106](https://github.com/modelcontextprotocol/rust-sdk/pull/1106)) +- complete Tier 1 feature docs and finalize roadmap ([#1101](https://github.com/modelcontextprotocol/rust-sdk/pull/1101)) +- *(conformance)* meeting requirements for tier 1 ([#1087](https://github.com/modelcontextprotocol/rust-sdk/pull/1087)) + +## [3.0.1](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v3.0.0...rmcp-v3.0.1) - 2026-07-29 + +### Fixed + +- *(auth)* use discovered resource for token refresh ([#1084](https://github.com/modelcontextprotocol/rust-sdk/pull/1084)) +- return header mismatch for missing protocol header ([#1083](https://github.com/modelcontextprotocol/rust-sdk/pull/1083)) +- negotiate stateless initialize versions ([#1080](https://github.com/modelcontextprotocol/rust-sdk/pull/1080)) +- stamp server info on graceful subscription results ([#1078](https://github.com/modelcontextprotocol/rust-sdk/pull/1078)) + +## [3.0.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v3.0.0-beta.5...rmcp-v3.0.0) - 2026-07-28 + +### Fixed + +- recognize 2026 MCP methods ([#1076](https://github.com/modelcontextprotocol/rust-sdk/pull/1076)) + +## [3.0.0-beta.5](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v3.0.0-beta.4...rmcp-v3.0.0-beta.5) - 2026-07-28 + +### Fixed + +- [**breaking**] remove server_info from DiscoverResult ([#1065](https://github.com/modelcontextprotocol/rust-sdk/pull/1065)) +- preserve transient OAuth discovery HTTP errors ([#1071](https://github.com/modelcontextprotocol/rust-sdk/pull/1071)) +- [**breaking**] preserve OAuth discovery transport errors ([#1069](https://github.com/modelcontextprotocol/rust-sdk/pull/1069)) +- gate client handler bounds for local ([#1068](https://github.com/modelcontextprotocol/rust-sdk/pull/1068)) + +### Other + +- prepare for stable 3.0 release ([#1073](https://github.com/modelcontextprotocol/rust-sdk/pull/1073)) +- RFC 9728 resource is used instead of base url when possible ([#962](https://github.com/modelcontextprotocol/rust-sdk/pull/962)) +- [**breaking**] remove deprecated v3 APIs ([#1066](https://github.com/modelcontextprotocol/rust-sdk/pull/1066)) + +## [3.0.0-beta.4](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v3.0.0-beta.3...rmcp-v3.0.0-beta.4) - 2026-07-28 + +### Fixed + +- accept namespaced discovery server information ([#1044](https://github.com/modelcontextprotocol/rust-sdk/pull/1044)) + +### Other + +- *(deps)* update base64 requirement from 0.22 to 0.23 ([#1059](https://github.com/modelcontextprotocol/rust-sdk/pull/1059)) +- *(deps)* update jsonwebtoken requirement from 10 to 11 ([#1058](https://github.com/modelcontextprotocol/rust-sdk/pull/1058)) + +## [3.0.0-beta.3](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v3.0.0-beta.2...rmcp-v3.0.0-beta.3) - 2026-07-27 + +### Fixed + +- [**breaking**] reject missing `issuer` in authorization server metadata by default ([#1054](https://github.com/modelcontextprotocol/rust-sdk/pull/1054)) +- default to allowing missing `issuer` ([#1051](https://github.com/modelcontextprotocol/rust-sdk/pull/1051)) + +### Other + +- make oauth discovery reactive ([#1052](https://github.com/modelcontextprotocol/rust-sdk/pull/1052)) + +## [3.0.0-beta.2](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v3.0.0-beta.1...rmcp-v3.0.0-beta.2) - 2026-07-24 + +### Added + +- expose oauth discovery metadata source ([#1041](https://github.com/modelcontextprotocol/rust-sdk/pull/1041)) + +### Fixed + +- [**breaking**] omit resultType for legacy protocol sessions ([#1038](https://github.com/modelcontextprotocol/rust-sdk/pull/1038)) + +### Other + +- declare and check MSRV ([#1034](https://github.com/modelcontextprotocol/rust-sdk/pull/1034)) + +## [3.0.0-beta.1](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v2.2.0...rmcp-v3.0.0-beta.1) - 2026-07-23 + +### Added + +- route SEP-2260 associated server requests to the originating SSE stream ([#1029](https://github.com/modelcontextprotocol/rust-sdk/pull/1029)) +- [**breaking**] add distributed SSE event store ([#1024](https://github.com/modelcontextprotocol/rust-sdk/pull/1024)) +- add client-side TTL-honoring response cache (SEP-2549) ([#1025](https://github.com/modelcontextprotocol/rust-sdk/pull/1025)) +- [**breaking**] Implement SEP-2663 Tasks Extension ([#1020](https://github.com/modelcontextprotocol/rust-sdk/pull/1020)) +- add subscription listen streams (SEP-2575) ([#1000](https://github.com/modelcontextprotocol/rust-sdk/pull/1000)) +- *(auth)* bind DCR client credentials to issuing authorization server (SEP-2352) ([#998](https://github.com/modelcontextprotocol/rust-sdk/pull/998)) +- add modern client lifecycle modes (SEP-2575) ([#995](https://github.com/modelcontextprotocol/rust-sdk/pull/995)) +- *(auth)* accumulate client-side scopes during step-up authorization ([#888](https://github.com/modelcontextprotocol/rust-sdk/pull/888)) +- [**breaking**] add server discovery and negotiation (SEP-2575) ([#973](https://github.com/modelcontextprotocol/rust-sdk/pull/973)) +- *(conformance)* add SEP-2243 header validation tool ([#997](https://github.com/modelcontextprotocol/rust-sdk/pull/997)) +- [**breaking**] align metadata models with draft schema ([#993](https://github.com/modelcontextprotocol/rust-sdk/pull/993)) +- [**breaking**] implement SEP-2549 cache hints ([#889](https://github.com/modelcontextprotocol/rust-sdk/pull/889)) +- [**breaking**] add MRTR behavior support (SEP-2322) ([#929](https://github.com/modelcontextprotocol/rust-sdk/pull/929)) +- [**breaking**] type Annotations.lastModified as a string ([#956](https://github.com/modelcontextprotocol/rust-sdk/pull/956)) +- [**breaking**] add SEP-2243 HTTP standard headers ([#907](https://github.com/modelcontextprotocol/rust-sdk/pull/907)) +- relax outputSchema to accept non-object JSON Schema types (SEP-2106) ([#895](https://github.com/modelcontextprotocol/rust-sdk/pull/895)) +- [**breaking**] relax tool result structuredContent type (SEP-2106) ([#933](https://github.com/modelcontextprotocol/rust-sdk/pull/933)) +- [**breaking**] add MRTR model types (SEP-2322) ([#915](https://github.com/modelcontextprotocol/rust-sdk/pull/915)) + +### Fixed + +- reap completed response send tasks ([#1026](https://github.com/modelcontextprotocol/rust-sdk/pull/1026)) +- accept stringified numeric response IDs ([#1021](https://github.com/modelcontextprotocol/rust-sdk/pull/1021)) +- re-register after auth server change ([#1011](https://github.com/modelcontextprotocol/rust-sdk/pull/1011)) +- .with_stateful_mode -> .with_legacy_session_mode ([#1015](https://github.com/modelcontextprotocol/rust-sdk/pull/1015)) +- preserve negotiated progress responses ([#1005](https://github.com/modelcontextprotocol/rust-sdk/pull/1005)) +- *(server)* serve draft-version requests statelessly per SEP-2567 ([#999](https://github.com/modelcontextprotocol/rust-sdk/pull/999)) +- pass client header conformance ([#1012](https://github.com/modelcontextprotocol/rust-sdk/pull/1012)) +- *(auth)* add an SDK path for pre-registered OAuth clients ([#994](https://github.com/modelcontextprotocol/rust-sdk/pull/994)) +- *(transport)* cancel in-flight request on stateless streamable-HTTP client disconnect ([#857](https://github.com/modelcontextprotocol/rust-sdk/pull/857)) ([#967](https://github.com/modelcontextprotocol/rust-sdk/pull/967)) +- *(auth)* distinguish rejected refresh tokens from transient failures ([#963](https://github.com/modelcontextprotocol/rust-sdk/pull/963)) +- *(auth)* validate discovered metadata issuer ([#996](https://github.com/modelcontextprotocol/rust-sdk/pull/996)) +- bound streamable HTTP memory usage ([#970](https://github.com/modelcontextprotocol/rust-sdk/pull/970)) +- *(streamable-http)* preserve progress in JSON mode ([#990](https://github.com/modelcontextprotocol/rust-sdk/pull/990)) +- specify compatible sse-stream version ([#968](https://github.com/modelcontextprotocol/rust-sdk/pull/968)) +- flag schema derive on schemars feature ([#966](https://github.com/modelcontextprotocol/rust-sdk/pull/966)) + +### Other + +- refactor OAuth client authorization api ([#1009](https://github.com/modelcontextprotocol/rust-sdk/pull/1009)) +- update for 2026-07-28 version ([#1032](https://github.com/modelcontextprotocol/rust-sdk/pull/1032)) +- *(deps)* update hmac requirement from 0.12 to 0.13 ([#988](https://github.com/modelcontextprotocol/rust-sdk/pull/988)) +- serialize JavaScript dependency install ([#972](https://github.com/modelcontextprotocol/rust-sdk/pull/972)) + +### Changed + +- **BREAKING**: rename `StreamableHttpServerConfig::stateful_mode` to `legacy_session_mode` (and the builder `with_stateful_mode` to `with_legacy_session_mode`) to clarify that the option only affects legacy protocol versions (`< 2026-07-28`); per SEP-2567 the `2026-07-28` draft version is always served statelessly ([#999](https://github.com/modelcontextprotocol/rust-sdk/pull/999)) + +### Fixed + +- use the authorization server issuer as the default `private_key_jwt` audience + +## [2.2.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v2.1.0...rmcp-v2.2.0) - 2026-07-08 + +### Added + +- reject auth servers lacking S256 PKCE support ([#955](https://github.com/modelcontextprotocol/rust-sdk/pull/955)) + +### Fixed + +- pass client conformance suite ([#960](https://github.com/modelcontextprotocol/rust-sdk/pull/960)) +- don't respond to cancelled requests ([#957](https://github.com/modelcontextprotocol/rust-sdk/pull/957)) +- fail orphaned streamable HTTP responses on reinit ([#914](https://github.com/modelcontextprotocol/rust-sdk/pull/914)) +- address 2025-11-25 conformance audit findings ([#951](https://github.com/modelcontextprotocol/rust-sdk/pull/951)) + +## [2.1.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v2.0.0...rmcp-v2.1.0) - 2026-07-02 + +### Added + +- add SEP-414 trace context meta accessors ([#910](https://github.com/modelcontextprotocol/rust-sdk/pull/910)) +- add SEP-2575 meta helpers ([#942](https://github.com/modelcontextprotocol/rust-sdk/pull/942)) + +### Fixed + +- *(transport)* make AsyncRwTransport::receive cancel-safe ([#941](https://github.com/modelcontextprotocol/rust-sdk/pull/941)) ([#947](https://github.com/modelcontextprotocol/rust-sdk/pull/947)) +- *(auth)* preserve refresh_token when refresh response omits it ([#949](https://github.com/modelcontextprotocol/rust-sdk/pull/949)) +- block redirect header leaks ([#936](https://github.com/modelcontextprotocol/rust-sdk/pull/936)) +- don't respond to unparsable messages ([#940](https://github.com/modelcontextprotocol/rust-sdk/pull/940)) +- negotiate protocol version in handler ([#930](https://github.com/modelcontextprotocol/rust-sdk/pull/930)) + +## [2.0.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v1.8.0...rmcp-v2.0.0) - 2026-06-27 + +### Added + +- [**breaking**] relax tool result structuredContent type ([#919](https://github.com/modelcontextprotocol/rust-sdk/pull/919)) +- deprecate roots/sampling/logging types ([#923](https://github.com/modelcontextprotocol/rust-sdk/pull/923)) +- [**breaking**] align model types with MCP 2025-11-25 spec ([#927](https://github.com/modelcontextprotocol/rust-sdk/pull/927)) + +### Fixed + +- prevent OAuth resource spoofing ([#937](https://github.com/modelcontextprotocol/rust-sdk/pull/937)) +- block oauth metadata ssrf ([#935](https://github.com/modelcontextprotocol/rust-sdk/pull/935)) +- prevent streamable HTTP session leak ([#934](https://github.com/modelcontextprotocol/rust-sdk/pull/934)) +- fill missing fully qualified syntax in prompt_handler macros ([#866](https://github.com/modelcontextprotocol/rust-sdk/pull/866)) +- *(rmcp)* add Audio variant to PromptMessageContent ([#865](https://github.com/modelcontextprotocol/rust-sdk/pull/865)) + +### Other + +- consolidate repeated rmcp tests ([#931](https://github.com/modelcontextprotocol/rust-sdk/pull/931)) +- Revert "feat!: relax tool result structuredContent type ([#919](https://github.com/modelcontextprotocol/rust-sdk/pull/919))" ([#932](https://github.com/modelcontextprotocol/rust-sdk/pull/932)) +- align README examples with v2 model API ([#928](https://github.com/modelcontextprotocol/rust-sdk/pull/928)) + +## [1.8.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v1.7.0...rmcp-v1.8.0) - 2026-06-22 + +### Added + +- standardize resource-not-found error code (SEP-2164) ([#899](https://github.com/modelcontextprotocol/rust-sdk/pull/899)) +- validate OAuth authorization response issuer ([#896](https://github.com/modelcontextprotocol/rust-sdk/pull/896)) +- specify OIDC application_type during dynamic client registration (SEP-837) ([#883](https://github.com/modelcontextprotocol/rust-sdk/pull/883)) +- deprecate roots, sampling, and logging (SEP-2577) ([#884](https://github.com/modelcontextprotocol/rust-sdk/pull/884)) + +### Fixed + +- *(auth)* preserve configured reqwest client ([#917](https://github.com/modelcontextprotocol/rust-sdk/pull/917)) +- *(auth)* align OAuth metadata discovery ordering ([#887](https://github.com/modelcontextprotocol/rust-sdk/pull/887)) +- align progress timeout token ([#909](https://github.com/modelcontextprotocol/rust-sdk/pull/909)) +- *(elicitation)* preserve enumNames through ElicitationSchema serde round-trip ([#905](https://github.com/modelcontextprotocol/rust-sdk/pull/905)) +- return tool errors for invalid arguments ([#894](https://github.com/modelcontextprotocol/rust-sdk/pull/894)) +- *(auth)* apply offline_access to reauth paths ([#897](https://github.com/modelcontextprotocol/rust-sdk/pull/897)) +- update peer info on duplicate initialize ([#862](https://github.com/modelcontextprotocol/rust-sdk/pull/862)) +- strip and validate tool outputSchema and inputSchema ([#860](https://github.com/modelcontextprotocol/rust-sdk/pull/860)) +- remove unnecessary fields from tools' inputSchema ([#856](https://github.com/modelcontextprotocol/rust-sdk/pull/856)) +- reject init header/body version mismatch ([#853](https://github.com/modelcontextprotocol/rust-sdk/pull/853)) +- align protocol version negotiation ([#855](https://github.com/modelcontextprotocol/rust-sdk/pull/855)) +- accept 200 with empty body in response to notifications in addition to 202 ([#849](https://github.com/modelcontextprotocol/rust-sdk/pull/849)) + +### Other + +- Allow custom HTTP clients for OAuth ([#908](https://github.com/modelcontextprotocol/rust-sdk/pull/908)) +- Add progress-aware request timeout reset ([#858](https://github.com/modelcontextprotocol/rust-sdk/pull/858)) +- *(server)* document Err vs Ok(CallToolResult::error) visibility contract on ServerHandler::call_tool ([#854](https://github.com/modelcontextprotocol/rust-sdk/pull/854)) +- refine mcpmate listing copy ([#885](https://github.com/modelcontextprotocol/rust-sdk/pull/885)) +- added jilebi-mcp to the list of built with rmcp ([#861](https://github.com/modelcontextprotocol/rust-sdk/pull/861)) + +## [1.7.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v1.6.0...rmcp-v1.7.0) - 2026-05-13 + +### Added + +- add task-based stdio examples ([#839](https://github.com/modelcontextprotocol/rust-sdk/pull/839)) + +### Fixed + +- *(rmcp)* flatten Resource variant of PromptMessageContent ([#843](https://github.com/modelcontextprotocol/rust-sdk/pull/843)) +- reply -32700 on stdio parse errors instead of closing ([#833](https://github.com/modelcontextprotocol/rust-sdk/pull/833)) + +### Other + +- *(rmcp)* remove dependency on chrono default features ([#829](https://github.com/modelcontextprotocol/rust-sdk/pull/829)) +- Fix/issue 817 idle timeout log level ([#824](https://github.com/modelcontextprotocol/rust-sdk/pull/824)) + +## [1.6.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v1.5.0...rmcp-v1.6.0) - 2026-05-01 + +### Added + +- *(http)* log Host/Origin rejections ([#826](https://github.com/modelcontextprotocol/rust-sdk/pull/826)) +- *(http)* add Origin header validation ([#823](https://github.com/modelcontextprotocol/rust-sdk/pull/823)) +- *(router)* support runtime disabling of tools ([#809](https://github.com/modelcontextprotocol/rust-sdk/pull/809)) +- optional session store (resumabillity support) ([#775](https://github.com/modelcontextprotocol/rust-sdk/pull/775)) + +### Fixed + +- add init_timeout for streamable-http sessions ([#811](https://github.com/modelcontextprotocol/rust-sdk/pull/811)) +- *(http)* fall back to :authority for HTTP/2 ([#827](https://github.com/modelcontextprotocol/rust-sdk/pull/827)) +- *(docs)* use correct Parameters syntax in tool examples ([#814](https://github.com/modelcontextprotocol/rust-sdk/pull/814)) + +### Other + +- add systemprompt-template to Built with rmcp ([#820](https://github.com/modelcontextprotocol/rust-sdk/pull/820)) + +## [1.5.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v1.4.0...rmcp-v1.5.0) - 2026-04-16 + +### Added + +- *(transport)* add constructors for non_exhaustive error types ([#806](https://github.com/modelcontextprotocol/rust-sdk/pull/806)) +- add 2025-11-25 protocol version support ([#802](https://github.com/modelcontextprotocol/rust-sdk/pull/802)) + +### Fixed + +- treat resource metadata JSON parse failure as soft error ([#810](https://github.com/modelcontextprotocol/rust-sdk/pull/810)) +- include http_request_id in request-wise priming event IDs ([#799](https://github.com/modelcontextprotocol/rust-sdk/pull/799)) +- *(http)* drain SSE stream for connection reuse ([#790](https://github.com/modelcontextprotocol/rust-sdk/pull/790)) + +### Other + +- *(deps)* update which requirement from 7 to 8 ([#807](https://github.com/modelcontextprotocol/rust-sdk/pull/807)) + +## [1.4.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v1.3.0...rmcp-v1.4.0) - 2026-04-09 + +### Added + +- add Default and constructors to ServerSseMessage ([#794](https://github.com/modelcontextprotocol/rust-sdk/pull/794)) +- add meta to elicitation results ([#792](https://github.com/modelcontextprotocol/rust-sdk/pull/792)) +- *(macros)* auto-generate get_info and default router ([#785](https://github.com/modelcontextprotocol/rust-sdk/pull/785)) +- *(transport)* add which_command for cross-platform executable resolution ([#774](https://github.com/modelcontextprotocol/rust-sdk/pull/774)) +- *(auth)* add StoredCredentials::new() constructor ([#778](https://github.com/modelcontextprotocol/rust-sdk/pull/778)) + +### Fixed + +- *(server)* remove initialized notification gate to support Streamable HTTP ([#788](https://github.com/modelcontextprotocol/rust-sdk/pull/788)) +- default session keep_alive to 5 minutes ([#780](https://github.com/modelcontextprotocol/rust-sdk/pull/780)) +- *(http)* add host check ([#764](https://github.com/modelcontextprotocol/rust-sdk/pull/764)) +- exclude local feature from docs.rs build ([#782](https://github.com/modelcontextprotocol/rust-sdk/pull/782)) + +### Other + +- update Rust toolchain to 1.92 ([#797](https://github.com/modelcontextprotocol/rust-sdk/pull/797)) +- unify IntoCallToolResult Result impls ([#787](https://github.com/modelcontextprotocol/rust-sdk/pull/787)) + +## [1.3.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v1.2.0...rmcp-v1.3.0) - 2026-03-24 + +### Added + +- *(transport)* add Unix domain socket client for streamable HTTP ([#749](https://github.com/modelcontextprotocol/rust-sdk/pull/749)) +- *(auth)* implement SEP-2207 OIDC-flavored refresh token guidance ([#676](https://github.com/modelcontextprotocol/rust-sdk/pull/676)) +- add configuration for transparent session re-init ([#760](https://github.com/modelcontextprotocol/rust-sdk/pull/760)) +- add local feature for !Send tool handler support ([#740](https://github.com/modelcontextprotocol/rust-sdk/pull/740)) + +### Fixed + +- prevent CallToolResult and GetTaskPayloadResult from shadowing CustomResult in untagged enums ([#771](https://github.com/modelcontextprotocol/rust-sdk/pull/771)) +- drain in-flight responses on stdin EOF ([#759](https://github.com/modelcontextprotocol/rust-sdk/pull/759)) +- remove default type param from StreamableHttpService ([#758](https://github.com/modelcontextprotocol/rust-sdk/pull/758)) +- use cfg-gated Send+Sync supertraits to avoid semver break ([#757](https://github.com/modelcontextprotocol/rust-sdk/pull/757)) +- *(rmcp)* surface JSON-RPC error bodies on HTTP 4xx responses ([#748](https://github.com/modelcontextprotocol/rust-sdk/pull/748)) +- default CallToolResult content to empty vec on missing field ([#752](https://github.com/modelcontextprotocol/rust-sdk/pull/752)) +- *(auth)* redact secrets in Debug output for StoredCredentials and StoredAuthorizationState ([#744](https://github.com/modelcontextprotocol/rust-sdk/pull/744)) + +### Other + +- fix all clippy warnings across workspace ([#746](https://github.com/modelcontextprotocol/rust-sdk/pull/746)) + +## [1.2.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v1.1.1...rmcp-v1.2.0) - 2026-03-11 + +### Added + +- add missing constructors for non-exhaustive model types ([#739](https://github.com/modelcontextprotocol/rust-sdk/pull/739)) +- include granted scopes in OAuth refresh token request ([#731](https://github.com/modelcontextprotocol/rust-sdk/pull/731)) + +### Fixed + +- handle ping requests sent before initialize handshake ([#745](https://github.com/modelcontextprotocol/rust-sdk/pull/745)) +- allow deserializing notifications without params field ([#729](https://github.com/modelcontextprotocol/rust-sdk/pull/729)) + +### Other + +- *(deps)* update jsonwebtoken requirement from 9 to 10 ([#737](https://github.com/modelcontextprotocol/rust-sdk/pull/737)) + +## [1.1.1](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v1.1.0...rmcp-v1.1.1) - 2026-03-09 + +### Fixed + +- accept logging/setLevel and ping before initialized notification ([#730](https://github.com/modelcontextprotocol/rust-sdk/pull/730)) + +## [1.1.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v1.0.0...rmcp-v1.1.0) - 2026-03-04 + +### Added + +- implement OAuth 2.0 Client Credentials flow ([#707](https://github.com/modelcontextprotocol/rust-sdk/pull/707)) + +### Other + +- add McpMux to Built with rmcp section ([#717](https://github.com/modelcontextprotocol/rust-sdk/pull/717)) + +## [1.0.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v1.0.0-alpha...rmcp-v1.0.0) - 2026-03-03 + +### Fixed + +- *(auth)* pass WWW-Authenticate scopes to DCR registration request ([#705](https://github.com/modelcontextprotocol/rust-sdk/pull/705)) +- api ergonomics follow-up ([#720](https://github.com/modelcontextprotocol/rust-sdk/pull/720)) +- *(streamable-http)* map stale session 401 to status-aware error ([#709](https://github.com/modelcontextprotocol/rust-sdk/pull/709)) + +## [1.0.0-alpha](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.17.0...rmcp-v1.0.0-alpha) - 2026-03-03 + +### Added + +- docs update ([#718](https://github.com/modelcontextprotocol/rust-sdk/pull/718)) +- *(auth)* [**breaking**] support returning extra fields from token exchange ([#700](https://github.com/modelcontextprotocol/rust-sdk/pull/700)) + +### Fixed + +- downgrade logging of message to `TRACE` to avoid spamming logs ([#699](https://github.com/modelcontextprotocol/rust-sdk/pull/699)) + +### Other + +- add #[non_exhaustive] and mutation methods to improve compatibility ([#715](https://github.com/modelcontextprotocol/rust-sdk/pull/715)) + +## [0.17.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.16.0...rmcp-v0.17.0) - 2026-02-27 + +### Added + +- *(streamable-http)* add json_response option for stateless server mode ([#683](https://github.com/modelcontextprotocol/rust-sdk/pull/683)) +- mcp sdk conformance ([#687](https://github.com/modelcontextprotocol/rust-sdk/pull/687)) +- add default value support to string, number, and integer schemas ([#686](https://github.com/modelcontextprotocol/rust-sdk/pull/686)) +- add trait-based tool declaration ([#677](https://github.com/modelcontextprotocol/rust-sdk/pull/677)) +- send and validate MCP-Protocol-Version header ([#675](https://github.com/modelcontextprotocol/rust-sdk/pull/675)) + +### Fixed + +- improve error logging and remove token secret from logs ([#685](https://github.com/modelcontextprotocol/rust-sdk/pull/685)) +- refresh token expiry ([#680](https://github.com/modelcontextprotocol/rust-sdk/pull/680)) +- gate optional dependencies behind feature flags ([#672](https://github.com/modelcontextprotocol/rust-sdk/pull/672)) +- allow empty content in CallToolResult ([#681](https://github.com/modelcontextprotocol/rust-sdk/pull/681)) +- *(schema)* remove AddNullable from draft2020_12 settings ([#664](https://github.com/modelcontextprotocol/rust-sdk/pull/664)) + +### Other + +- add prose documentation for core features to meet conformance ([#702](https://github.com/modelcontextprotocol/rust-sdk/pull/702)) +- Fix/sse channel replacement conflict ([#682](https://github.com/modelcontextprotocol/rust-sdk/pull/682)) +- document session management for streamable HTTP transport ([#674](https://github.com/modelcontextprotocol/rust-sdk/pull/674)) + +## [0.16.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.15.0...rmcp-v0.16.0) - 2026-02-17 + +### Added + +- add support for custom HTTP headers in StreamableHttpClient ([#655](https://github.com/modelcontextprotocol/rust-sdk/pull/655)) +- *(auth)* add token_endpoint_auth_method to OAuthClientConfig ([#648](https://github.com/modelcontextprotocol/rust-sdk/pull/648)) + +### Fixed + +- remove unnecessary doc-cfg ([#661](https://github.com/modelcontextprotocol/rust-sdk/pull/661)) +- duplicate meta serialization ([#662](https://github.com/modelcontextprotocol/rust-sdk/pull/662)) +- sort list_all() output in ToolRouter and PromptRouter for deterministic ordering ([#665](https://github.com/modelcontextprotocol/rust-sdk/pull/665)) +- align task response types with MCP spec ([#658](https://github.com/modelcontextprotocol/rust-sdk/pull/658)) + +### Other + +- upgrade reqwest to 0.13.2 ([#669](https://github.com/modelcontextprotocol/rust-sdk/pull/669)) +- include LICENSE in final crate tarball ([#657](https://github.com/modelcontextprotocol/rust-sdk/pull/657)) +- *(deps)* update rand requirement from 0.9 to 0.10 ([#650](https://github.com/modelcontextprotocol/rust-sdk/pull/650)) +- remove unused axum dependency from server-side-http feature ([#642](https://github.com/modelcontextprotocol/rust-sdk/pull/642)) +- 11-25-2025 compliant Auth ([#651](https://github.com/modelcontextprotocol/rust-sdk/pull/651)) +- add rudof-mcp to MCP servers list ([#645](https://github.com/modelcontextprotocol/rust-sdk/pull/645)) + +## [0.15.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.14.0...rmcp-v0.15.0) - 2026-02-10 + +### Added + +- *(elicitation)* add support URL elicitation. SEP-1036 ([#605](https://github.com/modelcontextprotocol/rust-sdk/pull/605)) +- enforce SEP-1577 MUST requirements for sampling with tools ([#646](https://github.com/modelcontextprotocol/rust-sdk/pull/646)) +- add native-tls as an optional TLS backend ([#631](https://github.com/modelcontextprotocol/rust-sdk/pull/631)) +- *(capabilities)* add extensions field for SEP-1724 ([#643](https://github.com/modelcontextprotocol/rust-sdk/pull/643)) + +### Fixed + +- *(tasks)* avoid dropping completed task results during collection ([#639](https://github.com/modelcontextprotocol/rust-sdk/pull/639)) +- *(auth)* oauth metadata discovery ([#641](https://github.com/modelcontextprotocol/rust-sdk/pull/641)) +- compilation with --no-default-features ([#593](https://github.com/modelcontextprotocol/rust-sdk/pull/593)) +- *(tasks)* expose `execution.taskSupport` on tools ([#635](https://github.com/modelcontextprotocol/rust-sdk/pull/635)) +- *(tasks)* correct enum variant ordering for deserialization ([#634](https://github.com/modelcontextprotocol/rust-sdk/pull/634)) + +### Other + +- Add optional description field to Implementation struct ([#649](https://github.com/modelcontextprotocol/rust-sdk/pull/649)) +- Implement SEP-1577: Sampling With Tools ([#628](https://github.com/modelcontextprotocol/rust-sdk/pull/628)) + +## [0.14.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.13.0...rmcp-v0.14.0) - 2026-01-23 + +### Fixed + +- *(tasks)* #626 model task capabilities correctly ([#627](https://github.com/modelcontextprotocol/rust-sdk/pull/627)) +- don't treat non-success HTTP codes as transport errors ([#618](https://github.com/modelcontextprotocol/rust-sdk/pull/618)) + +### Other + +- show README content on docs.rs ([#583](https://github.com/modelcontextprotocol/rust-sdk/pull/583)) +- added hyper-mcp to the list of built with rmcp ([#621](https://github.com/modelcontextprotocol/rust-sdk/pull/621)) +- Implement SEP-1319: Decouple Request Payload from RPC Methods ([#617](https://github.com/modelcontextprotocol/rust-sdk/pull/617)) + +## [0.13.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.12.0...rmcp-v0.13.0) - 2026-01-15 + +### Added + +- provide blanket implementations for ClientHandler and ServerHandler traits ([#609](https://github.com/modelcontextprotocol/rust-sdk/pull/609)) +- *(service)* add close() method for graceful connection shutdown ([#588](https://github.com/modelcontextprotocol/rust-sdk/pull/588)) +- *(auth)* add StateStore trait for pluggable OAuth state storage ([#614](https://github.com/modelcontextprotocol/rust-sdk/pull/614)) +- *(elicitation)* implement SEP-1330 Elicitation Enum Schema Improvements ([#539](https://github.com/modelcontextprotocol/rust-sdk/pull/539)) +- *(task)* add task support (SEP-1686) ([#536](https://github.com/modelcontextprotocol/rust-sdk/pull/536)) + +### Fixed + +- use the json rpc error from the initialize response and bubble it up to the client ([#569](https://github.com/modelcontextprotocol/rust-sdk/pull/569)) +- *(build)* fix build of the project when no features are selected ([#606](https://github.com/modelcontextprotocol/rust-sdk/pull/606)) +- use Semaphore instead of Notify in OneshotTransport to prevent race condition ([#611](https://github.com/modelcontextprotocol/rust-sdk/pull/611)) +- add OpenID Connect discovery support per spec-2025-11-25 4.3 ([#598](https://github.com/modelcontextprotocol/rust-sdk/pull/598)) +- only try to refresh access tokens if we have a refresh token or an expiry time ([#594](https://github.com/modelcontextprotocol/rust-sdk/pull/594)) +- *(docs)* add spreadsheet-mcp to Built with rmcp ([#582](https://github.com/modelcontextprotocol/rust-sdk/pull/582)) + +### Other + +- *(elicitation)* improve enum schema builder, small changes of elicitation builder ([#608](https://github.com/modelcontextprotocol/rust-sdk/pull/608)) +- add pre-commit hook for conventional commit verification ([#619](https://github.com/modelcontextprotocol/rust-sdk/pull/619)) +- clean up optional dependencies ([#546](https://github.com/modelcontextprotocol/rust-sdk/pull/546)) +- re-export ServerSseMessage from session module ([#612](https://github.com/modelcontextprotocol/rust-sdk/pull/612)) +- Implement SEP-1699: Support SSE Polling via Server-Side Disconnect ([#604](https://github.com/modelcontextprotocol/rust-sdk/pull/604)) +- update README external links ([#603](https://github.com/modelcontextprotocol/rust-sdk/pull/603)) +- clarity and formatting ([#602](https://github.com/modelcontextprotocol/rust-sdk/pull/602)) +- Add optional icons field to RawResourceTemplate ([#589](https://github.com/modelcontextprotocol/rust-sdk/pull/589)) + +## [0.12.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.11.0...rmcp-v0.12.0) - 2025-12-18 + +### Added + +- add support for custom requests ([#590](https://github.com/modelcontextprotocol/rust-sdk/pull/590)) +- add support for custom server notifications ([#580](https://github.com/modelcontextprotocol/rust-sdk/pull/580)) + +### Fixed + +- update process-wrap to v9.0 ([#586](https://github.com/modelcontextprotocol/rust-sdk/pull/586)) +- *(oauth)* rfc8414 should judement the response_types ([#485](https://github.com/modelcontextprotocol/rust-sdk/pull/485)) + +### Other + +- Add SEP-991 (CIMD) support for URL-based client IDs ([#570](https://github.com/modelcontextprotocol/rust-sdk/pull/570)) +- merge cached_schema_for_type into schema_for_type ([#581](https://github.com/modelcontextprotocol/rust-sdk/pull/581)) +- Add NexusCore MCP to project list ([#573](https://github.com/modelcontextprotocol/rust-sdk/pull/573)) + +## [0.11.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.10.0...rmcp-v0.11.0) - 2025-12-08 + +### Added + +- *(meta)* add _meta field to prompts, resources and paginated result ([#558](https://github.com/modelcontextprotocol/rust-sdk/pull/558)) +- [**breaking**] remove SSE transport support ([#562](https://github.com/modelcontextprotocol/rust-sdk/pull/562)) + +### Fixed + +- *(streamable-http)* gracefully shutdown while client connected ([#494](https://github.com/modelcontextprotocol/rust-sdk/pull/494)) + +### Other + +- Implements outputSchema validation ([#566](https://github.com/modelcontextprotocol/rust-sdk/pull/566)) +- add video-transcriber-mcp-rs to projects built with rmcp ([#565](https://github.com/modelcontextprotocol/rust-sdk/pull/565)) + +## [0.10.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.9.1...rmcp-v0.10.0) - 2025-12-01 + +### Added + +- add support for custom client notifications ([#556](https://github.com/modelcontextprotocol/rust-sdk/pull/556)) + +### Other + +- replace paste with pastey for macros feature ([#564](https://github.com/modelcontextprotocol/rust-sdk/pull/564)) + +## [0.9.1](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.9.0...rmcp-v0.9.1) - 2025-11-24 + +### Added + +- *(streamable-http)* support both SSE and JSON response formats ([#540](https://github.com/modelcontextprotocol/rust-sdk/pull/540)) + +### Fixed + +- don't block on creating the SSE stream ([#553](https://github.com/modelcontextprotocol/rust-sdk/pull/553)) +- *(shemars)* use JSON Schema 2020-12 as Default Dialect ([#549](https://github.com/modelcontextprotocol/rust-sdk/pull/549)) +- *(oauth)* let OAuth discovery skip to next well-known URL candidate on JSON parse error. ([#545](https://github.com/modelcontextprotocol/rust-sdk/pull/545)) + +### Other + +- Implementation of SEP-986: Specify Format for Tool Names ([#551](https://github.com/modelcontextprotocol/rust-sdk/pull/551)) + +## [0.9.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.8.5...rmcp-v0.9.0) - 2025-11-17 + +### Added + +- *(auth)* implement CredentialStore trait ([#542](https://github.com/modelcontextprotocol/rust-sdk/pull/542)) +- *(tool)* add _meta to tool definitions ([#534](https://github.com/modelcontextprotocol/rust-sdk/pull/534)) + +## [0.8.5](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.8.4...rmcp-v0.8.5) - 2025-11-05 + +### Fixed + +- *(oauth)* respect oauth-protected-resource discovery ([#511](https://github.com/modelcontextprotocol/rust-sdk/pull/511)) + +## [0.8.4](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.8.3...rmcp-v0.8.4) - 2025-11-04 + +### Fixed + +- *(oauth)* fix oauth credential refresh ([#509](https://github.com/modelcontextprotocol/rust-sdk/pull/509)) +- do not manually construct fallback authorization metadata ([#507](https://github.com/modelcontextprotocol/rust-sdk/pull/507)) +- *(doc)* add stakpak-agent to Built with rmcp section ([#500](https://github.com/modelcontextprotocol/rust-sdk/pull/500)) + +## [0.8.3](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.8.2...rmcp-v0.8.3) - 2025-10-22 + +### Fixed + +- accept 204 in addition to 202 on initialize ([#497](https://github.com/modelcontextprotocol/rust-sdk/pull/497)) + +## [0.8.2](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.8.1...rmcp-v0.8.2) - 2025-10-21 + +### Added + +- add type-safe elicitation schema support ([#465](https://github.com/modelcontextprotocol/rust-sdk/pull/465)) ([#466](https://github.com/modelcontextprotocol/rust-sdk/pull/466)) +- *(SEP-973)* following change Icon.sizes from string to string array ([#479](https://github.com/modelcontextprotocol/rust-sdk/pull/479)) + +### Fixed + +- *(oauth)* three oauth discovery and registration issues ([#489](https://github.com/modelcontextprotocol/rust-sdk/pull/489)) +- *(oauth)* dynamic client registration should be optional ([#463](https://github.com/modelcontextprotocol/rust-sdk/pull/463)) +- *(sse-client)* consume control frames; refresh message endpoint ([#448](https://github.com/modelcontextprotocol/rust-sdk/pull/448)) + +### Other + +- Streamable HTTP: drain SSE frames until the initialize response, ignoring early notifications to prevent handshake timeouts ([#467](https://github.com/modelcontextprotocol/rust-sdk/pull/467)) +- bump crate version in README.md ([#471](https://github.com/modelcontextprotocol/rust-sdk/pull/471)) + +## [0.8.1](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.8.0...rmcp-v0.8.1) - 2025-10-07 + +### Fixed + +- *(oauth)* pass bearer token to all streamable http requests ([#476](https://github.com/modelcontextprotocol/rust-sdk/pull/476)) +- fix spellcheck on intentional typo in CHANGELOG ([#470](https://github.com/modelcontextprotocol/rust-sdk/pull/470)) + +## [0.8.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.7.0...rmcp-v0.8.0) - 2025-10-04 + +### Added + +- allow clients to override client_name ([#469](https://github.com/modelcontextprotocol/rust-sdk/pull/469)) + +### Fixed + +- *(oauth)* support suffixed and prefixed well-known paths ([#459](https://github.com/modelcontextprotocol/rust-sdk/pull/459)) +- generate default schema for tools with no params ([#446](https://github.com/modelcontextprotocol/rust-sdk/pull/446)) + +### Other + +- bump to rust 1.90.0 ([#453](https://github.com/modelcontextprotocol/rust-sdk/pull/453)) + +## [0.7.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.6.4...rmcp-v0.7.0) - 2025-09-24 + +### Fixed + +- return auth errors ([#451](https://github.com/modelcontextprotocol/rust-sdk/pull/451)) +- *(oauth)* do not treat empty secret as valid for public clients ([#443](https://github.com/modelcontextprotocol/rust-sdk/pull/443)) +- *(clippy)* add doc comment for generated tool attr fn ([#439](https://github.com/modelcontextprotocol/rust-sdk/pull/439)) +- *(oauth)* require CSRF token as part of the OAuth authorization flow. ([#435](https://github.com/modelcontextprotocol/rust-sdk/pull/435)) + +### Other + +- *(root)* Add Terminator to Built with rmcp section ([#437](https://github.com/modelcontextprotocol/rust-sdk/pull/437)) +- Non-empty paths in OAuth2 Authorization Server Metadata URLs ([#441](https://github.com/modelcontextprotocol/rust-sdk/pull/441)) + +## [0.6.4](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.6.3...rmcp-v0.6.4) - 2025-09-11 + +### Added + +- *(SEP-973)* add support for icons and websiteUrl across relevant types ([#432](https://github.com/modelcontextprotocol/rust-sdk/pull/432)) +- implement context-aware completion (MCP 2025-06-18) ([#396](https://github.com/modelcontextprotocol/rust-sdk/pull/396)) +- add `title` field for data types ([#410](https://github.com/modelcontextprotocol/rust-sdk/pull/410)) + +### Fixed + +- crates/rmcp/src/handler/client/progress.rs XXXXXX -> dispatcher ([#429](https://github.com/modelcontextprotocol/rust-sdk/pull/429)) +- build issue due to missing struct field ([#427](https://github.com/modelcontextprotocol/rust-sdk/pull/427)) +- generate simple {} schema for tools with no parameters ([#425](https://github.com/modelcontextprotocol/rust-sdk/pull/425)) + +### Other + +- Skip notification in initialization handshake ([#421](https://github.com/modelcontextprotocol/rust-sdk/pull/421)) +- add nvim-mcp project built by rmcp ([#422](https://github.com/modelcontextprotocol/rust-sdk/pull/422)) + +## [0.6.3](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.6.2...rmcp-v0.6.3) - 2025-09-04 + +### Fixed + +- change JSON-RPC request ID type from u32 to i64 ([#416](https://github.com/modelcontextprotocol/rust-sdk/pull/416)) + +## [0.6.2](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.6.1...rmcp-v0.6.2) - 2025-09-04 + +### Added + +- *(rmcp)* add optional _meta to CallToolResult, EmbeddedResource, and ResourceContents ([#386](https://github.com/modelcontextprotocol/rust-sdk/pull/386)) + +### Fixed + +- resolve compatibility issues with servers sending LSP notifications ([#413](https://github.com/modelcontextprotocol/rust-sdk/pull/413)) +- remove batched json rpc support ([#408](https://github.com/modelcontextprotocol/rust-sdk/pull/408)) +- transport-streamable-http-server depends on transport-worker ([#405](https://github.com/modelcontextprotocol/rust-sdk/pull/405)) +- *(typo)* correct typo in error message for transport cancellation and field. ([#404](https://github.com/modelcontextprotocol/rust-sdk/pull/404)) + +### Other + +- Spec conformance: meta support and spec updates ([#415](https://github.com/modelcontextprotocol/rust-sdk/pull/415)) +- add the rmcp-openapi and rmcp-actix-web related projects ([#406](https://github.com/modelcontextprotocol/rust-sdk/pull/406)) + +## [0.6.1](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.6.0...rmcp-v0.6.1) - 2025-08-29 + +### Added + +- *(rmcp)* add authorization header support for the streamable http client ([#390](https://github.com/modelcontextprotocol/rust-sdk/pull/390)) +- *(model)* add helpers to build enum from concrete values ([#393](https://github.com/modelcontextprotocol/rust-sdk/pull/393)) +- *(model)* expose client method name ([#391](https://github.com/modelcontextprotocol/rust-sdk/pull/391)) +- add resource_link support to tools and prompts ([#381](https://github.com/modelcontextprotocol/rust-sdk/pull/381)) +- Add prompt support ([#351](https://github.com/modelcontextprotocol/rust-sdk/pull/351)) +- include reqwest in transport-streamble-http-client feature ([#376](https://github.com/modelcontextprotocol/rust-sdk/pull/376)) + +### Fixed + +- *(auth)* url parse is not correct ([#402](https://github.com/modelcontextprotocol/rust-sdk/pull/402)) +- *(readme)* missing use declarations, more accurate server instructions ([#399](https://github.com/modelcontextprotocol/rust-sdk/pull/399)) +- enhance transport graceful shutdown with proper writer closure ([#392](https://github.com/modelcontextprotocol/rust-sdk/pull/392)) + +### Other + +- simplify remove_route method signature ([#401](https://github.com/modelcontextprotocol/rust-sdk/pull/401)) + +## [0.6.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.5.0...rmcp-v0.6.0) - 2025-08-19 + +### Added + +- Add MCP Elicitation support ([#332](https://github.com/modelcontextprotocol/rust-sdk/pull/332)) +- keep internal error in worker's quit reason ([#372](https://github.com/modelcontextprotocol/rust-sdk/pull/372)) + +### Fixed + +- match shape of the calltoolresult schema ([#377](https://github.com/modelcontextprotocol/rust-sdk/pull/377)) +- make stdio shutdown more graceful ([#364](https://github.com/modelcontextprotocol/rust-sdk/pull/364)) +- *(tool)* remove unnecessary schema validation ([#375](https://github.com/modelcontextprotocol/rust-sdk/pull/375)) +- *(rmcp)* return serialized json with structured content ([#368](https://github.com/modelcontextprotocol/rust-sdk/pull/368)) + +### Other + +- add related project rustfs-mcp ([#378](https://github.com/modelcontextprotocol/rust-sdk/pull/378)) +- *(streamable)* add document for extracting http info ([#373](https://github.com/modelcontextprotocol/rust-sdk/pull/373)) + +## [0.5.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.4.1...rmcp-v0.5.0) - 2025-08-07 + +### Fixed + +- correct numeric types in progress notifications ([#361](https://github.com/modelcontextprotocol/rust-sdk/pull/361)) + +## [0.4.1](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.4.0...rmcp-v0.4.1) - 2025-08-07 + +### Fixed + +- *(rmcp)* allow both content and structured content ([#359](https://github.com/modelcontextprotocol/rust-sdk/pull/359)) + +## [0.4.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.3.2...rmcp-v0.4.0) - 2025-08-05 + +### Added + +- [**breaking**] Add support for `Tool.outputSchema` and `CallToolResult.structuredContent` ([#316](https://github.com/modelcontextprotocol/rust-sdk/pull/316)) + +### Fixed + +- don't wrap errors in streamable http auth client ([#353](https://github.com/modelcontextprotocol/rust-sdk/pull/353)) +- *(prompt)* remove unused code ([#343](https://github.com/modelcontextprotocol/rust-sdk/pull/343)) + +## [0.3.2](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.3.1...rmcp-v0.3.2) - 2025-07-30 + +### Fixed + +- *(capabilities)* do not serialize None as null for `list_changed` ([#341](https://github.com/modelcontextprotocol/rust-sdk/pull/341)) +- *(Transport)* close oneshot transport on error ([#340](https://github.com/modelcontextprotocol/rust-sdk/pull/340)) +- *(oauth)* expose OAuthTokenResponse publicly ([#335](https://github.com/modelcontextprotocol/rust-sdk/pull/335)) + +## [0.3.1](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.3.0...rmcp-v0.3.1) - 2025-07-29 + +### Fixed + +- use mimeType instead of mime_type for MCP specification compliance ([#339](https://github.com/modelcontextprotocol/rust-sdk/pull/339)) +- return a 405 for GET and DELETE if stateful_mode=false ([#331](https://github.com/modelcontextprotocol/rust-sdk/pull/331)) +- propagate tracing spans when spawning new tokio tasks ([#334](https://github.com/modelcontextprotocol/rust-sdk/pull/334)) +- Explicitly added client_id as an extra parameter causes bad token requests ([#322](https://github.com/modelcontextprotocol/rust-sdk/pull/322)) + +### Other + +- Fix formatting in crate descriptions in README.md ([#333](https://github.com/modelcontextprotocol/rust-sdk/pull/333)) + +## [0.3.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.2.1...rmcp-v0.3.0) - 2025-07-15 + +### Added + +- unified error type ([#308](https://github.com/modelcontextprotocol/rust-sdk/pull/308)) +- *(transport)* add builder & expose child stderr ([#305](https://github.com/modelcontextprotocol/rust-sdk/pull/305)) + +### Other + +- *(deps)* update schemars requirement from 0.8 to 1.0 ([#258](https://github.com/modelcontextprotocol/rust-sdk/pull/258)) +- *(rmcp)* bump rmcp-macros version to match ([#311](https://github.com/modelcontextprotocol/rust-sdk/pull/311)) +- fix packages used for server example ([#309](https://github.com/modelcontextprotocol/rust-sdk/pull/309)) + +## [0.2.1](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.2.0...rmcp-v0.2.1) - 2025-07-03 + +### Other + +- *(docs)* Minor README updates ([#301](https://github.com/modelcontextprotocol/rust-sdk/pull/301)) + +## [0.2.0](https://github.com/modelcontextprotocol/rust-sdk/compare/rmcp-v0.1.5...rmcp-v0.2.0) - 2025-07-02 + +### Added + +- mark boxed http body as sync ([#291](https://github.com/modelcontextprotocol/rust-sdk/pull/291)) +- add progress notification handling and related structures ([#282](https://github.com/modelcontextprotocol/rust-sdk/pull/282)) +- allow failable service creation in streamable HTTP tower service ([#244](https://github.com/modelcontextprotocol/rust-sdk/pull/244)) +- provide more context information ([#236](https://github.com/modelcontextprotocol/rust-sdk/pull/236)) +- stateless mode of streamable http client ([#233](https://github.com/modelcontextprotocol/rust-sdk/pull/233)) +- add cancellation_token method to `RunningService` ([#218](https://github.com/modelcontextprotocol/rust-sdk/pull/218)) +- better http server support ([#199](https://github.com/modelcontextprotocol/rust-sdk/pull/199)) +- throw initialize error detail ([#192](https://github.com/modelcontextprotocol/rust-sdk/pull/192)) +- sse client optionally skip the endpoint event ([#187](https://github.com/modelcontextprotocol/rust-sdk/pull/187)) +- *(server)* add annotation to tool macro ([#184](https://github.com/modelcontextprotocol/rust-sdk/pull/184)) +- *(model)* add json schema generation support for all model types ([#176](https://github.com/modelcontextprotocol/rust-sdk/pull/176)) +- *(openapi)* add OpenAPI v3 compatibility and test for nullable field schema workaround ([#135](https://github.com/modelcontextprotocol/rust-sdk/pull/135)) ([#137](https://github.com/modelcontextprotocol/rust-sdk/pull/137)) +- *(extension)* extract http request part into rmcp extension ([#163](https://github.com/modelcontextprotocol/rust-sdk/pull/163)) +- *(transport)* support streamable http server ([#152](https://github.com/modelcontextprotocol/rust-sdk/pull/152)) +- *(oauth)* fixes + cache client credentials ([#157](https://github.com/modelcontextprotocol/rust-sdk/pull/157)) +- allow use of reqwest without ring provider ([#155](https://github.com/modelcontextprotocol/rust-sdk/pull/155)) +- extensions to context ([#102](https://github.com/modelcontextprotocol/rust-sdk/pull/102)) +- revision-2025-03-26 without streamable http ([#84](https://github.com/modelcontextprotocol/rust-sdk/pull/84)) +- *(tool)* allow tool call return a serializable value in json format ([#75](https://github.com/modelcontextprotocol/rust-sdk/pull/75)) ([#78](https://github.com/modelcontextprotocol/rust-sdk/pull/78)) +- Sse server auto ping ([#74](https://github.com/modelcontextprotocol/rust-sdk/pull/74)) +- *(transport)* Sse client transport trait ([#67](https://github.com/modelcontextprotocol/rust-sdk/pull/67)) + +### Fixed + +- let users decide what to wrap in child process command ([#279](https://github.com/modelcontextprotocol/rust-sdk/pull/279)) +- cancellable initialization process ([#280](https://github.com/modelcontextprotocol/rust-sdk/pull/280)) +- inject part into extension when handing init req ([#275](https://github.com/modelcontextprotocol/rust-sdk/pull/275)) +- streamable http server close request channel on response([#266](https://github.com/modelcontextprotocol/rust-sdk/pull/266)) ([#270](https://github.com/modelcontextprotocol/rust-sdk/pull/270)) +- streamable http client close on response ([#268](https://github.com/modelcontextprotocol/rust-sdk/pull/268)) +- expose TokioChildWrapper::id() in TokioChildProcess and TokioChildProcessOut ([#254](https://github.com/modelcontextprotocol/rust-sdk/pull/254)) +- add compatibility handling for non-standard notifications in async_rw ([#247](https://github.com/modelcontextprotocol/rust-sdk/pull/247)) +- allow SSE server router to be nested ([#240](https://github.com/modelcontextprotocol/rust-sdk/pull/240)) +- error for status in post method of streamable http client ([#238](https://github.com/modelcontextprotocol/rust-sdk/pull/238)) +- disable wasmbind in chrono for wasm32-unknown-unknown ([#234](https://github.com/modelcontextprotocol/rust-sdk/pull/234)) +- *(examples)* add clients in examples's readme ([#225](https://github.com/modelcontextprotocol/rust-sdk/pull/225)) +- generic ServerHandler ([#223](https://github.com/modelcontextprotocol/rust-sdk/pull/223)) +- comment error ([#215](https://github.com/modelcontextprotocol/rust-sdk/pull/215)) +- resolve the server 406 error in API calls ([#203](https://github.com/modelcontextprotocol/rust-sdk/pull/203)) +- sse endpoint build follow js's `new URL(url, base)` ([#197](https://github.com/modelcontextprotocol/rust-sdk/pull/197)) +- more friendly interface to get service error ([#190](https://github.com/modelcontextprotocol/rust-sdk/pull/190)) +- cleanup zombie processes for child process client ([#156](https://github.com/modelcontextprotocol/rust-sdk/pull/156)) +- *(schemar)* use self-defined settings ([#180](https://github.com/modelcontextprotocol/rust-sdk/pull/180)) +- *(transport-sse-server)* cleanup on connection drop ([#165](https://github.com/modelcontextprotocol/rust-sdk/pull/165)) +- *(test)* skip serialize tool's annotation if empty ([#160](https://github.com/modelcontextprotocol/rust-sdk/pull/160)) +- fix resource leak ([#136](https://github.com/modelcontextprotocol/rust-sdk/pull/136)) +- *(handler)* do call handler methods when initialize server ([#118](https://github.com/modelcontextprotocol/rust-sdk/pull/118)) +- *(server)* schemars compilation errors ([#104](https://github.com/modelcontextprotocol/rust-sdk/pull/104)) +- *(test)* fix test introduced by #97 ([#101](https://github.com/modelcontextprotocol/rust-sdk/pull/101)) +- *(macro)* add generics marco types support ([#98](https://github.com/modelcontextprotocol/rust-sdk/pull/98)) +- *(typo)* nit language corrections ([#90](https://github.com/modelcontextprotocol/rust-sdk/pull/90)) +- *(typo)* s/marcos/macros/ ([#85](https://github.com/modelcontextprotocol/rust-sdk/pull/85)) +- *(client)* add error enum while deal client info ([#76](https://github.com/modelcontextprotocol/rust-sdk/pull/76)) +- *(notification)* fix wrongly error report in notification ([#70](https://github.com/modelcontextprotocol/rust-sdk/pull/70)) +- *(test)* fix tool deserialization error ([#68](https://github.com/modelcontextprotocol/rust-sdk/pull/68)) +- *(server)* add error enum while deal server info ([#51](https://github.com/modelcontextprotocol/rust-sdk/pull/51)) + +### Other + +- add simpling example and test ([#289](https://github.com/modelcontextprotocol/rust-sdk/pull/289)) +- add update for test_message_schema ([#286](https://github.com/modelcontextprotocol/rust-sdk/pull/286)) +- add notion clear in model.rs ([#284](https://github.com/modelcontextprotocol/rust-sdk/pull/284)) +- cov settings, and fix several building warnings ([#281](https://github.com/modelcontextprotocol/rust-sdk/pull/281)) +- refactor tool macros and router implementation ([#261](https://github.com/modelcontextprotocol/rust-sdk/pull/261)) +- fix regression in URL joining ([#265](https://github.com/modelcontextprotocol/rust-sdk/pull/265)) +- remove erroneous definitions_path ([#264](https://github.com/modelcontextprotocol/rust-sdk/pull/264)) +- allow using a TokioCommandWrap for TokioChildProcess::new closes #243 ([#245](https://github.com/modelcontextprotocol/rust-sdk/pull/245)) +- Fix typo ([#249](https://github.com/modelcontextprotocol/rust-sdk/pull/249)) +- provide http server as tower service ([#228](https://github.com/modelcontextprotocol/rust-sdk/pull/228)) +- *(deps)* update sse-stream requirement from 0.1.4 to 0.2.0 ([#230](https://github.com/modelcontextprotocol/rust-sdk/pull/230)) +- Server info is only retrieved once during initialization ([#214](https://github.com/modelcontextprotocol/rust-sdk/pull/214)) +- *(deps)* update base64 requirement from 0.21 to 0.22 ([#209](https://github.com/modelcontextprotocol/rust-sdk/pull/209)) +- revert badge ([#202](https://github.com/modelcontextprotocol/rust-sdk/pull/202)) +- use hierarchical readme for publishing ([#198](https://github.com/modelcontextprotocol/rust-sdk/pull/198)) +- Ci/coverage badge ([#191](https://github.com/modelcontextprotocol/rust-sdk/pull/191)) +- fix error introduced by merge, and reorganize feature ([#185](https://github.com/modelcontextprotocol/rust-sdk/pull/185)) +- Transport trait and worker transport, and streamable http client with those new features. ([#167](https://github.com/modelcontextprotocol/rust-sdk/pull/167)) +- add oauth2 support ([#130](https://github.com/modelcontextprotocol/rust-sdk/pull/130)) +- remove un-used tower.rs ([#125](https://github.com/modelcontextprotocol/rust-sdk/pull/125)) +- update calculator example description ([#115](https://github.com/modelcontextprotocol/rust-sdk/pull/115)) +- fix the url ([#120](https://github.com/modelcontextprotocol/rust-sdk/pull/120)) +- add a simple chat client for example ([#119](https://github.com/modelcontextprotocol/rust-sdk/pull/119)) +- add an overview to `rmcp/src/lib.rs` ([#116](https://github.com/modelcontextprotocol/rust-sdk/pull/116)) +- *(context)* test context request handling and refactor for reusable client-server tests ([#97](https://github.com/modelcontextprotocol/rust-sdk/pull/97)) +- *(logging)* Add tests for logging ([#96](https://github.com/modelcontextprotocol/rust-sdk/pull/96)) +- Adopt Devcontainer for Development Environment ([#81](https://github.com/modelcontextprotocol/rust-sdk/pull/81)) +- fix typos ([#79](https://github.com/modelcontextprotocol/rust-sdk/pull/79)) +- format and fix typo ([#72](https://github.com/modelcontextprotocol/rust-sdk/pull/72)) +- add documentation generation job ([#59](https://github.com/modelcontextprotocol/rust-sdk/pull/59)) +- add test with js server ([#65](https://github.com/modelcontextprotocol/rust-sdk/pull/65)) +- fmt the project ([#54](https://github.com/modelcontextprotocol/rust-sdk/pull/54)) +- *(sse_server)* separate router and server startup ([#52](https://github.com/modelcontextprotocol/rust-sdk/pull/52)) +- fix broken link ([#53](https://github.com/modelcontextprotocol/rust-sdk/pull/53)) +- fix the branch name for git dependency ([#46](https://github.com/modelcontextprotocol/rust-sdk/pull/46)) +- Move whole rmcp crate to official rust sdk ([#44](https://github.com/modelcontextprotocol/rust-sdk/pull/44)) +- Initial commit diff --git a/vendor/rmcp/Cargo.lock b/vendor/rmcp/Cargo.lock new file mode 100644 index 00000000..b8c22de3 --- /dev/null +++ b/vendor/rmcp/Cargo.lock @@ -0,0 +1,2951 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 4 + +[[package]] +name = "aho-corasick" +version = "1.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c982642fa9e8606056828ee9a8505737230110bb1099153c79efe865c59d12ba" +dependencies = [ + "memchr", +] + +[[package]] +name = "android_system_properties" +version = "0.1.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ae221649c9976a6f6c56ae1facf410f3ddb33cc661c4b7b61020a912d4237fbc" +dependencies = [ + "libc", +] + +[[package]] +name = "anyhow" +version = "1.0.104" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "330a5ed07fa54e4702c9d6c4174f74427fc0ef6e214bbd677ae50a5099946470" + +[[package]] +name = "async-trait" +version = "0.1.92" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "82f6aeea286b8eb4dd3431a1be1b59d290ace00f5bfd8e2a159bc2a05e2c1667" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "atomic-waker" +version = "1.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1505bd5d3d116872e7271a6d4e16d81d0c8570876c8de68093a09ac269d8aac0" + +[[package]] +name = "autocfg" +version = "1.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f2032f911046de80f0a198e0901378627c33f59ea0ac00e363d481118bd70a53" + +[[package]] +name = "aws-lc-rs" +version = "1.18.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b281d307588d634de920874890732659e2e7672f72b5e10e81badc1a8a83621e" +dependencies = [ + "aws-lc-sys", + "untrusted 0.7.1", + "zeroize", +] + +[[package]] +name = "aws-lc-sys" +version = "0.45.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9bff6c3b54fad79a2e60b8102caf565819711497c1f5f092f49508e2f5c31b27" +dependencies = [ + "cc", + "cmake", + "dunce", + "fs_extra", + "pkg-config", +] + +[[package]] +name = "axum" +version = "0.8.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "31b698c5f9a010f6573133b09e0de5408834d0c82f8d7475a89fc1867a71cd90" +dependencies = [ + "axum-core", + "bytes", + "futures-util", + "http", + "http-body", + "http-body-util", + "hyper", + "hyper-util", + "itoa", + "matchit", + "memchr", + "mime", + "percent-encoding", + "pin-project-lite", + "serde_core", + "sync_wrapper", + "tokio", + "tower", + "tower-layer", + "tower-service", +] + +[[package]] +name = "axum-core" +version = "0.5.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "08c78f31d7b1291f7ee735c1c6780ccde7785daae9a9206026862dab7d8792d1" +dependencies = [ + "bytes", + "futures-core", + "http", + "http-body", + "http-body-util", + "mime", + "pin-project-lite", + "sync_wrapper", + "tower-layer", + "tower-service", +] + +[[package]] +name = "base64" +version = "0.22.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72b3254f16251a8381aa12e40e3c4d2f0199f8c6508fbecb9d91f575e0fbb8c6" + +[[package]] +name = "base64" +version = "0.23.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac07cdecf99051d9a5238b80f35af32cdeba5b336e55d957b318b50137e18da5" + +[[package]] +name = "bitflags" +version = "2.13.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3ded4057c258ba199e2d26386d3af3780957ecaee6c4ef4041c6b4b8b97c0b06" + +[[package]] +name = "block-buffer" +version = "0.10.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3078c7629b62d3f0439517fa394996acacc5cbc91c5a20d8c658e77abd503a71" +dependencies = [ + "generic-array", +] + +[[package]] +name = "block-buffer" +version = "0.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d2f6c7dbe95a6ed67ad9f18e57daf93a2f034c524b99fd2b76d18fdfeb6660aa" +dependencies = [ + "hybrid-array", +] + +[[package]] +name = "bumpalo" +version = "3.20.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72f5acc6cb2ba439de613abc23857ec3d78374d8ed5ac84e9d11336e87da8649" + +[[package]] +name = "bytes" +version = "1.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fc652a48c352aef3ea3aed32080501cf3ef6ed5da78602a020c991775b0aff04" + +[[package]] +name = "cc" +version = "1.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f360145194ee8e21db5ee7f3fcd4fe52210864c75c985dae33218202c8bbe040" +dependencies = [ + "find-msvc-tools", + "jobserver", + "libc", + "shlex", +] + +[[package]] +name = "cfg-if" +version = "1.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4e7648175b45a9a48536d676f68d918270699102aa8dab5496df06904c914600" + +[[package]] +name = "cfg_aliases" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f079e83a288787bcd14a6aea84cee5c87a67c5a3e660c30f557a3d24761b3527" + +[[package]] +name = "chacha20" +version = "0.10.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "65c35e4b699c7e15ccbe7ee35c005e4fc0a278d22238a2857e6ce2dadeda1b06" +dependencies = [ + "cfg-if", + "cpufeatures 0.3.1", + "rand_core 0.10.1", +] + +[[package]] +name = "chrono" +version = "0.4.45" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1aa79e62e7697b8e29b513a68abacf485adcd1fe8284a4316c5ae868e6633327" +dependencies = [ + "iana-time-zone", + "js-sys", + "num-traits", + "serde", + "wasm-bindgen", + "windows-link", +] + +[[package]] +name = "cmake" +version = "0.1.58" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c0f78a02292a74a88ac736019ab962ece0bc380e3f977bf72e376c5d78ff0678" +dependencies = [ + "cc", +] + +[[package]] +name = "cmov" +version = "0.5.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0c9ea0ac24bc397ab3c98583a3c9ba74fa56b09a4449bbe172b9b1ddb016027a" + +[[package]] +name = "combine" +version = "4.6.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cfc320937d09e6de266b31b9afb480f197d7a861be86be7cb2ea7e5d1bfffc5e" +dependencies = [ + "bytes", + "memchr", +] + +[[package]] +name = "const-oid" +version = "0.10.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a6ef517f0926dd24a1582492c791b6a4818a4d94e789a334894aa15b0d12f55c" + +[[package]] +name = "core-foundation" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b2a6cd9ae233e7f62ba4e9353e81a88df7fc8a5987b8d445b4d90c879bd156f6" +dependencies = [ + "core-foundation-sys", + "libc", +] + +[[package]] +name = "core-foundation-sys" +version = "0.8.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "773648b94d0e5d620f64f280777445740e61fe701025087ec8b57f45c791888b" + +[[package]] +name = "cpufeatures" +version = "0.2.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "59ed5838eebb26a2bb2e58f6d5b5316989ae9d08bab10e0e6d103e656d1b0280" +dependencies = [ + "libc", +] + +[[package]] +name = "cpufeatures" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5ca28b0ae3115b884660db4118d803791fd6756b6e88f39c0f3f7859060d7566" +dependencies = [ + "libc", +] + +[[package]] +name = "crypto-common" +version = "0.1.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "78c8292055d1c1df0cce5d180393dc8cce0abec0a7102adb6c7b1eef6016d60a" +dependencies = [ + "generic-array", + "typenum", +] + +[[package]] +name = "crypto-common" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ce6e4c961d6cd6c9a86db418387425e8bdeaf05b3c8bc1411e6dca4c252f1453" +dependencies = [ + "hybrid-array", +] + +[[package]] +name = "ctutils" +version = "0.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7d5515a3834141de9eafb9717ad39eea8247b5674e6066c404e8c4b365d2a29e" +dependencies = [ + "cmov", +] + +[[package]] +name = "darling" +version = "0.24.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed17f5901b6630b993ca003def43f2f8ef4014fc13b047b57aad617ff32bc2ec" +dependencies = [ + "darling_core", + "darling_macro", +] + +[[package]] +name = "darling_core" +version = "0.24.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6837e2cf7485aaae18f86181d2f0e9a7ed297a025e220aeabf63fdebd3a2ddff" +dependencies = [ + "ident_case", + "proc-macro2", + "quote", + "strsim", + "syn 3.0.6", +] + +[[package]] +name = "darling_macro" +version = "0.24.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2ac7135c3ef02b2f7833bbeb1be5ba7f966dcde8a87c6b87f65a778d71a02785" +dependencies = [ + "darling_core", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "deranged" +version = "0.5.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7cd812cc2bc1d69d4764bd80df88b4317eaef9e773c75226407d9bc0876b211c" + +[[package]] +name = "digest" +version = "0.10.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9ed9a281f7bc9b7576e61468ba615a66a5c8cfdff42420a70aa82701a3b1e292" +dependencies = [ + "block-buffer 0.10.4", + "crypto-common 0.1.7", +] + +[[package]] +name = "digest" +version = "0.11.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f1dd6dbb5841937940781866fa1281a1ff7bd3bf827091440879f9994983d5c2" +dependencies = [ + "block-buffer 0.12.1", + "const-oid", + "crypto-common 0.2.2", + "ctutils", +] + +[[package]] +name = "displaydoc" +version = "0.2.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c6232dd377dcc64799954cbd3a9bb882e9cdc1308ccd87b1c098f1fb2eaf82a8" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "dunce" +version = "1.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "92773504d58c093f6de2459af4af33faa518c13451eb8f2b5698ed3d36e7c813" + +[[package]] +name = "dyn-clone" +version = "1.0.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d0881ea181b1df73ff77ffaaf9c7544ecc11e82fba9b5f27b262a3c73a332555" + +[[package]] +name = "equivalent" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "877a4ace8713b0bcf2a4e7eec82529c029f1d0619886d18145fea96c3ffe5c0f" + +[[package]] +name = "errno" +version = "0.3.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "39cab71617ae0d63f51a36d69f866391735b51691dbda63cf6f96d042b63efeb" +dependencies = [ + "libc", + "windows-sys 0.61.2", +] + +[[package]] +name = "fastrand" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "da7c62ceae207dd37ea5b845da6a0696c799f85e97da1ab5b7910be3c1c80223" + +[[package]] +name = "find-msvc-tools" +version = "0.1.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aedcfb3409746eddb02b9e19ebda1c3394f759a152e48ee875a0844d1b955484" + +[[package]] +name = "foreign-types" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f6f339eb8adc052cd2ca78910fda869aefa38d22d5cb648e6485e4d3fc06f3b1" +dependencies = [ + "foreign-types-shared", +] + +[[package]] +name = "foreign-types-shared" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "00b0228411908ca8685dba7fc2cdd70ec9990a6e753e89b6ac91a84c40fbaf4b" + +[[package]] +name = "form_urlencoded" +version = "1.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cb4cb245038516f5f85277875cdaa4f7d2c9a0fa0468de06ed190163b1581fcf" +dependencies = [ + "percent-encoding", +] + +[[package]] +name = "fs_extra" +version = "1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "42703706b716c37f96a77aea830392ad231f44c9e9a67872fa5548707e11b11c" + +[[package]] +name = "futures" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9a31d2a3fbaaeb2af2368bbdd904aa8e812d3c04a1ee10d3171f52d556e5d0a3" +dependencies = [ + "futures-channel", + "futures-core", + "futures-executor", + "futures-io", + "futures-sink", + "futures-task", + "futures-util", +] + +[[package]] +name = "futures-channel" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b1f9e3d69d39e4862ffed03ed071a76f9a13ba1d9109d355b0f0aa6b15e393c4" +dependencies = [ + "futures-core", + "futures-sink", +] + +[[package]] +name = "futures-core" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "92d699e522242e69e3003b94ecc1f960f3a5e015aa7c5d7486e65ad01dd94f5e" + +[[package]] +name = "futures-executor" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "031b47cf1a3c6cc8bc2fc76cd437f521619387907d469316e7c0bc278f1f5432" +dependencies = [ + "futures-core", + "futures-task", + "futures-util", +] + +[[package]] +name = "futures-io" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "53c0fa8157de1303bfffdaa1cc2a673bfffb60102f76b0ef4441659124373fed" + +[[package]] +name = "futures-macro" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9fb9654ba8355388abeb8dcb4fc62f511300867002afc858860463bdd9fe0c44" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "futures-sink" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1944426bf7d03f1d14f708785e4b33efd750b36d48a157b836b3efc15ede8e1d" + +[[package]] +name = "futures-task" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cd417de3d1d015fc3bfd2b1ea46dfc7bab72ef86f1cc7cc9c78e728b34a6d1fd" + +[[package]] +name = "futures-timer" +version = "3.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "af43fadb8a98512d547e37b4e92e0ced13e205c061b87b4623eff01d918d6968" + +[[package]] +name = "futures-util" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0d50a92467f8ba5dd6e3ee5d4bd04d73ab2e4e1c44474a0674821dfce14b79bc" +dependencies = [ + "futures-channel", + "futures-core", + "futures-io", + "futures-macro", + "futures-sink", + "futures-task", + "memchr", + "pin-project-lite", + "slab", +] + +[[package]] +name = "generic-array" +version = "0.14.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "85649ca51fd72272d7821adaf274ad91c288277713d9c18820d8499a7ff69e9a" +dependencies = [ + "typenum", + "version_check", +] + +[[package]] +name = "getrandom" +version = "0.2.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ff2abc00be7fca6ebc474524697ae276ad847ad0a6b3faa4bcb027e9a4614ad0" +dependencies = [ + "cfg-if", + "js-sys", + "libc", + "wasi", + "wasm-bindgen", +] + +[[package]] +name = "getrandom" +version = "0.4.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "300e883d756b2e4ec94e02791f39b04b522276138852cfc41d9fb7e904106099" +dependencies = [ + "cfg-if", + "js-sys", + "libc", + "r-efi", + "rand_core 0.10.1", + "wasm-bindgen", +] + +[[package]] +name = "glob" +version = "0.3.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e4eba85ea1d0a966a983acd07deee566e67395d2d96b6fb39e62b5a833f1eb0b" + +[[package]] +name = "hashbrown" +version = "0.17.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed5909b6e89a2db4456e54cd5f673791d7eca6732202bbf2a9cc504fe2f9b84a" + +[[package]] +name = "hmac" +version = "0.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6303bc9732ae41b04cb554b844a762b4115a61bfaa81e3e83050991eeb56863f" +dependencies = [ + "digest 0.11.3", +] + +[[package]] +name = "http" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "918d3568bebf352712bc2ef3d46a8bcf1a75b373be6539de198e9105cbbf9ce0" +dependencies = [ + "bytes", + "itoa", +] + +[[package]] +name = "http-body" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ca2a8f2913ee65f60facd6a5905613afaa448497a0230cc41ce022d93290bc2c" +dependencies = [ + "bytes", + "http", +] + +[[package]] +name = "http-body-util" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "23169fe34a5fbcdd3f3862e78fb9b6fccd5f02a6dc6f732547005d45631ce71c" +dependencies = [ + "bytes", + "futures-core", + "http", + "http-body", + "pin-project-lite", +] + +[[package]] +name = "httparse" +version = "1.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6dbf3de79e51f3d586ab4cb9d5c3e2c14aa28ed23d180cf89b4df0454a69cc87" + +[[package]] +name = "httpdate" +version = "1.0.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "df3b46402a9d5adb4c86a0cf463f42e19994e3ee891101b1841f30a545cb49a9" + +[[package]] +name = "hybrid-array" +version = "0.4.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "27f864f10dfb56725ce5ce5472bc52252c8f93a4ab86327122cebf62c5f59a17" +dependencies = [ + "typenum", +] + +[[package]] +name = "hyper" +version = "1.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "27b501faa50e7a26c3d3560ca625132f4078a17771f4810baf70475ae48cbe43" +dependencies = [ + "atomic-waker", + "bytes", + "futures-channel", + "futures-core", + "http", + "http-body", + "httparse", + "httpdate", + "itoa", + "pin-project-lite", + "smallvec", + "tokio", + "want", +] + +[[package]] +name = "hyper-rustls" +version = "0.27.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dfa8e654703247911e29c23fbeaa261834bd9bb74efba2f9acddc37bfb127f53" +dependencies = [ + "http", + "hyper", + "hyper-util", + "rustls", + "tokio", + "tokio-rustls", + "tower-service", +] + +[[package]] +name = "hyper-tls" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "70206fc6890eaca9fde8a0bf71caa2ddfc9fe045ac9e5c70df101a7dbde866e0" +dependencies = [ + "bytes", + "http-body-util", + "hyper", + "hyper-util", + "native-tls", + "tokio", + "tokio-native-tls", + "tower-service", +] + +[[package]] +name = "hyper-util" +version = "0.1.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ddc03d96684f9226b8a787cdb71488417b53ab5ea8fdb1dac946cb9431cc8bff" +dependencies = [ + "base64 0.23.1", + "bytes", + "futures-channel", + "futures-util", + "http", + "http-body", + "httparse", + "hyper", + "ipnet", + "libc", + "percent-encoding", + "pin-project-lite", + "socket2", + "tokio", + "tower-service", + "tracing", +] + +[[package]] +name = "iana-time-zone" +version = "0.1.65" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e31bc9ad994ba00e440a8aa5c9ef0ec67d5cb5e5cb0cc7f8b744a35b389cc470" +dependencies = [ + "android_system_properties", + "core-foundation-sys", + "iana-time-zone-haiku", + "js-sys", + "log", + "wasm-bindgen", + "windows-core", +] + +[[package]] +name = "iana-time-zone-haiku" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f31827a206f56af32e590ba56d5d2d085f558508192593743f16b2306495269f" +dependencies = [ + "cc", +] + +[[package]] +name = "icu_collections" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fa68d21081c4a05d5a901a1c62add574c77048b6a1c67be3b50ce0b60d4ca513" +dependencies = [ + "displaydoc", + "potential_utf", + "utf8_iter", + "yoke", + "zerofrom", + "zerovec", +] + +[[package]] +name = "icu_locale_core" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d56e28588da92eee5c3201a6eff33fabdd49b62269c8938d4ff050ce4d900deb" +dependencies = [ + "displaydoc", + "litemap", + "tinystr", + "writeable", + "zerovec", +] + +[[package]] +name = "icu_normalizer" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "12f9cf5f235641ed274641dd81c3f28d870e276763d0797aeeab72317b1c646f" +dependencies = [ + "icu_collections", + "icu_normalizer_data", + "icu_properties", + "icu_provider", + "smallvec", + "zerovec", +] + +[[package]] +name = "icu_normalizer_data" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1563da1ed3e0b3bf3d74c9b85917ac9c56464d2f57242270c09c9e752f8021a0" + +[[package]] +name = "icu_properties" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7e7ca276ad3145661a65914e6daf131ca5120cd3dcee8f8f3214b8875184a148" +dependencies = [ + "displaydoc", + "icu_collections", + "icu_locale_core", + "icu_properties_data", + "icu_provider", + "zerotrie", + "zerovec", +] + +[[package]] +name = "icu_properties_data" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e590f038c1464a96894fd6d10127e90a8be4509f56ff7ecef851b15cee0b7caa" + +[[package]] +name = "icu_provider" +version = "2.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d27bbb9d3abbefac45d55f647c9de1d44aafcd1186eb91879afef17c396c3e73" +dependencies = [ + "displaydoc", + "icu_locale_core", + "writeable", + "yoke", + "zerofrom", + "zerotrie", + "zerovec", +] + +[[package]] +name = "ident_case" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b9e0384b61958566e926dc50660321d12159025e767c18e043daf26b70104c39" + +[[package]] +name = "idna" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3b0875f23caa03898994f6ddc501886a45c7d3d62d04d2d90788d47be1b1e4de" +dependencies = [ + "idna_adapter", + "smallvec", + "utf8_iter", +] + +[[package]] +name = "idna_adapter" +version = "1.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cb68373c0d6620ef8105e855e7745e18b0d00d3bdb07fb532e434244cdb9a714" +dependencies = [ + "icu_normalizer", + "icu_properties", +] + +[[package]] +name = "indexmap" +version = "2.14.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cc4e190f5d26ca7051642629da2c52fc03bde85a03197c99408dcd291734c855" +dependencies = [ + "equivalent", + "hashbrown", + "serde", + "serde_core", +] + +[[package]] +name = "ipnet" +version = "2.12.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "791930b43c0d5973160d90a8f3894509f2b273430f5c5c73b668636d0287c5c0" + +[[package]] +name = "itoa" +version = "1.0.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8f42a60cbdf9a97f5d2305f08a87dc4e09308d1276d28c869c684d7777685682" + +[[package]] +name = "jni" +version = "0.22.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5efd9a482cf3a427f00d6b35f14332adc7902ce91efb778580e180ff90fa3498" +dependencies = [ + "cfg-if", + "combine", + "jni-macros", + "jni-sys", + "log", + "simd_cesu8", + "thiserror 2.0.21", + "walkdir", + "windows-link", +] + +[[package]] +name = "jni-macros" +version = "0.22.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a00109accc170f0bdb141fed3e393c565b6f5e072365c3bd58f5b062591560a3" +dependencies = [ + "proc-macro2", + "quote", + "rustc_version", + "simd_cesu8", + "syn 2.0.119", +] + +[[package]] +name = "jni-sys" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c6377a88cb3910bee9b0fa88d4f42e1d2da8e79915598f65fb0c7ee14c878af2" +dependencies = [ + "jni-sys-macros", +] + +[[package]] +name = "jni-sys-macros" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "38c0b942f458fe50cdac086d2f946512305e5631e720728f2a61aabcd47a6264" +dependencies = [ + "quote", + "syn 2.0.119", +] + +[[package]] +name = "jobserver" +version = "0.1.35" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1c00acbd29eabad4a2392fa0e921c874934dbbf4194312ad20f04a0ed67a3cb3" +dependencies = [ + "getrandom 0.4.3", + "libc", +] + +[[package]] +name = "js-sys" +version = "0.3.106" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7883d941dae510fb2d978fc3fe018c71c9e2892fd38854de3e8b92c2e5ad9cc5" +dependencies = [ + "cfg-if", + "futures-util", + "wasm-bindgen", +] + +[[package]] +name = "jsonwebtoken" +version = "11.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e75fe14a82d81e5f5af639997db37d8b96045938a7ac6ab18cdbe1c7467e05e1" +dependencies = [ + "aws-lc-rs", + "base64 0.22.1", + "getrandom 0.2.17", + "js-sys", + "pem", + "serde", + "serde_json", + "signature", + "simple_asn1", + "zeroize", +] + +[[package]] +name = "lazy_static" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe" + +[[package]] +name = "libc" +version = "0.2.189" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3eaf3ede3fee6db1a4c2ee091bf8a8b4dccdc6d17f656fb07896ee72867612f2" + +[[package]] +name = "linux-raw-sys" +version = "0.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32a66949e030da00e8c7d4434b251670a91556f4144941d37452769c25d58a53" + +[[package]] +name = "litemap" +version = "0.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "47d9d19d1d6efa0109d2f65ff4c85cddd50bd572e5a00127ab10987290bcefae" + +[[package]] +name = "lock_api" +version = "0.4.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "224399e74b87b5f3557511d98dff8b14089b3dadafcab6bb93eab67d3aace965" +dependencies = [ + "scopeguard", +] + +[[package]] +name = "log" +version = "0.4.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f9f8bd3e56ce4dfc153cf470fffbfa98c7620958b312ca5c3a4b8d5181fd13c6" + +[[package]] +name = "lru-slab" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4050469837a6ff301cd14c1f8f24f88549e6d548f24f64e2148eb0f72cebc51f" + +[[package]] +name = "matchers" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d1525a2a28c7f4fa0fc98bb91ae755d1e2d1505079e05539e35bc876b5d65ae9" +dependencies = [ + "regex-automata", +] + +[[package]] +name = "matchit" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "47e1ffaa40ddd1f3ed91f717a33c8c0ee23fff369e3aa8772b9605cc1d22f4c3" + +[[package]] +name = "memchr" +version = "2.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cf8baf1c55e62ffcace7a9f06f4bd9cd3f0c4beb022d3b367256b91b87513d98" + +[[package]] +name = "mime" +version = "0.3.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6877bb514081ee2a7ff5ef9de3281f14a4dd4bceac4c09388074a6b5df8a139a" + +[[package]] +name = "mio" +version = "1.2.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4b18443e9c262bfe8fa82f51666e2642c53393f7e5c27b3e1aeab922cff5b9d8" +dependencies = [ + "libc", + "wasi", + "windows-sys 0.61.2", +] + +[[package]] +name = "native-tls" +version = "0.2.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "465500e14ea162429d264d44189adc38b199b62b1c21eea9f69e4b73cb03bbf2" +dependencies = [ + "libc", + "log", + "openssl", + "openssl-probe", + "openssl-sys", + "schannel", + "security-framework", + "security-framework-sys", + "tempfile", +] + +[[package]] +name = "nix" +version = "0.31.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cf20d2fde8ff38632c426f1165ed7436270b44f199fc55284c38276f9db47c3d" +dependencies = [ + "bitflags", + "cfg-if", + "cfg_aliases", + "libc", +] + +[[package]] +name = "nu-ansi-term" +version = "0.50.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7957b9740744892f114936ab4a57b3f487491bbeafaf8083688b16841a4240e5" +dependencies = [ + "windows-sys 0.61.2", +] + +[[package]] +name = "num-bigint" +version = "0.4.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c89e69e7e0f03bea5ef08013795c25018e101932225a656383bd384495ecc367" +dependencies = [ + "num-integer", + "num-traits", +] + +[[package]] +name = "num-conv" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "521739c6d2bac4aa25192232afe6841231376b2b26d4d9fae5ecf8ca5772e441" + +[[package]] +name = "num-integer" +version = "0.1.47" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7ce2d95d4b3734dc35aa2f45e1aa22cd416814592a4f9d9205e11affd5b8e10b" +dependencies = [ + "num-traits", +] + +[[package]] +name = "num-traits" +version = "0.2.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "071dfc062690e90b734c0b2273ce72ad0ffa95f0c74596bc250dcfd960262841" +dependencies = [ + "autocfg", +] + +[[package]] +name = "oauth2" +version = "5.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "51e219e79014df21a225b1860a479e2dcd7cbd9130f4defd4bd0e191ea31d67d" +dependencies = [ + "base64 0.22.1", + "chrono", + "getrandom 0.2.17", + "http", + "rand 0.8.8", + "serde", + "serde_json", + "serde_path_to_error", + "sha2 0.10.9", + "thiserror 1.0.69", + "url", +] + +[[package]] +name = "once_cell" +version = "1.21.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50" + +[[package]] +name = "openssl" +version = "0.10.81" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "77823a27f0babb03091cb9ed9ef80af3b39dbc82f97e8fa530374b7dafd87a45" +dependencies = [ + "bitflags", + "cfg-if", + "foreign-types", + "libc", + "openssl-macros", + "openssl-sys", +] + +[[package]] +name = "openssl-macros" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a948666b637a0f465e8564c73e89d4dde00d72d4d473cc972f390fc3dcee7d9c" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "openssl-probe" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7c87def4c32ab89d880effc9e097653c8da5d6ef28e6b539d313baaacfbafcbe" + +[[package]] +name = "openssl-sys" +version = "0.9.117" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b47e7e6bb2c38cd930d25a23b40fa52e068c10e85f3e03a7f5ba5aaca5713695" +dependencies = [ + "cc", + "libc", + "pkg-config", + "vcpkg", +] + +[[package]] +name = "parking_lot" +version = "0.12.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "93857453250e3077bd71ff98b6a65ea6621a19bb0f559a85248955ac12c45a1a" +dependencies = [ + "lock_api", + "parking_lot_core", +] + +[[package]] +name = "parking_lot_core" +version = "0.9.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2621685985a2ebf1c516881c026032ac7deafcda1a2c9b7850dc81e3dfcb64c1" +dependencies = [ + "cfg-if", + "libc", + "redox_syscall", + "smallvec", + "windows-link", +] + +[[package]] +name = "pastey" +version = "0.2.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2ee67f1008b1ba2321834326597b8e186293b049a023cdef258527550b9935b4" + +[[package]] +name = "pem" +version = "3.0.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1d30c53c26bc5b31a98cd02d20f25a7c8567146caf63ed593a9d87b2775291be" +dependencies = [ + "base64 0.22.1", + "serde_core", +] + +[[package]] +name = "percent-encoding" +version = "2.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b4f627cb1b25917193a259e49bdad08f671f8d9708acfd5fe0a8c1455d87220" + +[[package]] +name = "pin-project-lite" +version = "0.2.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a89322df9ebe1c1578d689c92318e070967d1042b512afbe49518723f4e6d5cd" + +[[package]] +name = "pkg-config" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f6b464fbc74e149a392436b17d523f769e057cb6877f6a5c4618bc6f11800548" + +[[package]] +name = "potential_utf" +version = "0.1.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d83eb9bc6d8e5cf568e7a1101d60ee05e81ed50ea106026f3d18deeb046d7661" +dependencies = [ + "zerovec", +] + +[[package]] +name = "powerfmt" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "439ee305def115ba05938db6eb1644ff94165c5ab5e9420d1c1bcedbba909391" + +[[package]] +name = "ppv-lite86" +version = "0.2.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "85eae3c4ed2f50dcfe72643da4befc30deadb458a9b590d720cde2f2b1e97da9" +dependencies = [ + "zerocopy", +] + +[[package]] +name = "proc-macro-crate" +version = "3.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e67ba7e9b2b56446f1d419b1d807906278ffa1a658a8a5d8a39dcb1f5a78614f" +dependencies = [ + "toml_edit", +] + +[[package]] +name = "proc-macro2" +version = "1.0.107" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "985e7ec9bb745e6ce6535b544d84d6cd6f7ad8bd711c398938ae983b91a766d9" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "process-wrap" +version = "10.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1f21b97672d2dc848e7b25701ab4535618b92f4861c13cc3f7f7bed52ad3c8da" +dependencies = [ + "futures", + "indexmap", + "nix", + "tokio", + "tracing", + "windows", +] + +[[package]] +name = "quinn" +version = "0.11.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4051e23e9185c255a7e33ef59cdbca87a22d359052eecd22fc6b901fb37d9d11" +dependencies = [ + "bytes", + "cfg_aliases", + "pin-project-lite", + "quinn-proto", + "quinn-udp", + "rustc-hash", + "rustls", + "socket2", + "thiserror 2.0.21", + "tokio", + "tracing", + "web-time", +] + +[[package]] +name = "quinn-proto" +version = "0.11.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a9746dbde176634f4f2f1faf2404e30a31b2bc1e9cafb5329c95d8177a18c9fc" +dependencies = [ + "aws-lc-rs", + "bytes", + "getrandom 0.4.3", + "lru-slab", + "rand 0.10.3", + "rand_pcg", + "ring", + "rustc-hash", + "rustls", + "rustls-pki-types", + "slab", + "thiserror 2.0.21", + "tinyvec", + "tracing", + "web-time", +] + +[[package]] +name = "quinn-udp" +version = "0.5.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "35a133f956daabe89a61a685c2649f13d82d5aa4bd5d12d1277e1072a21c0694" +dependencies = [ + "cfg_aliases", + "libc", + "once_cell", + "socket2", + "tracing", + "windows-sys 0.61.2", +] + +[[package]] +name = "quote" +version = "1.0.47" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1fbf4db142a473a8d80c26bbf18454ed458bf8d26c8219c331daecfdbd079001" +dependencies = [ + "proc-macro2", +] + +[[package]] +name = "r-efi" +version = "6.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f8dcc9c7d52a811697d2151c701e0d08956f92b0e24136cf4cf27b57a6a0d9bf" + +[[package]] +name = "rand" +version = "0.8.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e058c7de0b26af77780c769414d6257830bb240f3c38477dbc2c16e5f54d6d4c" +dependencies = [ + "libc", + "rand_chacha", + "rand_core 0.6.4", +] + +[[package]] +name = "rand" +version = "0.10.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "65c9fb96cbc91e3478eaae79a69fcd3f1ae4ad052e471fe6732fff548984b4af" +dependencies = [ + "chacha20", + "getrandom 0.4.3", + "rand_core 0.10.1", +] + +[[package]] +name = "rand_chacha" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e6c10a63a0fa32252be49d21e7709d4d4baf8d231c2dbce1eaa8141b9b127d88" +dependencies = [ + "ppv-lite86", + "rand_core 0.6.4", +] + +[[package]] +name = "rand_core" +version = "0.6.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ec0be4795e2f6a28069bec0b5ff3e2ac9bafc99e6a9a7dc3547996c5c816922c" +dependencies = [ + "getrandom 0.2.17", +] + +[[package]] +name = "rand_core" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "63b8176103e19a2643978565ca18b50549f6101881c443590420e4dc998a3c69" + +[[package]] +name = "rand_pcg" +version = "0.10.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "caa0f4137e1c0a72f4c651489402276c8e8e1cf081f3b0ba156d2cbeef09e86a" +dependencies = [ + "rand_core 0.10.1", +] + +[[package]] +name = "redox_syscall" +version = "0.5.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed2bf2547551a7053d6fdfafda3f938979645c44812fbfcda098faae3f1a362d" +dependencies = [ + "bitflags", +] + +[[package]] +name = "ref-cast" +version = "1.0.27" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7e440fb4e4b4147295338efb76001ab9e4efc0e5839df2c47fc5ac2381d365c3" +dependencies = [ + "ref-cast-impl", +] + +[[package]] +name = "ref-cast-impl" +version = "1.0.27" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "92ecd8964f8453721699a1ed72037b0db49ce2f5a5138486ee89bed6f67cdf3a" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "regex" +version = "1.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f020237b6c8eed93db2e2cb53c00c60a8e1bc73da7d073199a1180401450218d" +dependencies = [ + "aho-corasick", + "memchr", + "regex-automata", + "regex-syntax", +] + +[[package]] +name = "regex-automata" +version = "0.4.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ad8553b9b26413251cbf30e620595c7a41b3887f03da04579c0e6b0d6a06b4b2" +dependencies = [ + "aho-corasick", + "memchr", + "regex-syntax", +] + +[[package]] +name = "regex-syntax" +version = "0.8.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d6f6ff9a378485b298a5286656da665ba74413d36db0979633275d2e708145d4" + +[[package]] +name = "relative-path" +version = "1.9.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ba39f3699c378cd8970968dcbff9c43159ea4cfbd88d43c00b22f2ef10a435d2" + +[[package]] +name = "reqwest" +version = "0.13.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "16a1cfa75cc186dd73d5818e510e042e40927bccc9c236b061cea97e1eb08029" +dependencies = [ + "base64 0.23.1", + "bytes", + "futures-core", + "futures-util", + "http", + "http-body", + "http-body-util", + "hyper", + "hyper-rustls", + "hyper-tls", + "hyper-util", + "js-sys", + "log", + "native-tls", + "percent-encoding", + "pin-project-lite", + "quinn", + "rustls", + "rustls-pki-types", + "rustls-platform-verifier", + "serde", + "serde_json", + "sync_wrapper", + "tokio", + "tokio-native-tls", + "tokio-rustls", + "tokio-util", + "tower", + "tower-http", + "tower-service", + "url", + "wasm-bindgen", + "wasm-bindgen-futures", + "wasm-streams", + "web-sys", +] + +[[package]] +name = "ring" +version = "0.17.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a4689e6c2294d81e88dc6261c768b63bc4fcdb852be6d1352498b114f61383b7" +dependencies = [ + "cc", + "cfg-if", + "getrandom 0.2.17", + "libc", + "untrusted 0.9.0", + "windows-sys 0.52.0", +] + +[[package]] +name = "rmcp" +version = "3.5.0" +dependencies = [ + "anyhow", + "async-trait", + "axum", + "base64 0.23.1", + "bytes", + "chrono", + "futures", + "hmac", + "http", + "http-body", + "http-body-util", + "hyper", + "hyper-util", + "indexmap", + "jsonwebtoken", + "oauth2", + "pastey", + "pin-project-lite", + "process-wrap", + "rand 0.10.3", + "reqwest", + "rmcp-macros", + "rstest", + "schemars", + "serde", + "serde_json", + "sha2 0.11.0", + "sse-stream", + "thiserror 2.0.21", + "tokio", + "tokio-stream", + "tokio-util", + "tower-service", + "tracing", + "tracing-subscriber", + "url", + "uuid", + "which", + "zeroize", +] + +[[package]] +name = "rmcp-macros" +version = "3.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c7e66877136e969d5a2d561ee5841b17717a0619aebd64abb47a2a2f46e34683" +dependencies = [ + "darling", + "proc-macro2", + "quote", + "serde_json", + "syn 3.0.6", +] + +[[package]] +name = "rstest" +version = "0.27.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "948203e6d13b83e51a90d7cf236dd58a0065f23f4b902f00f306e7eb2bd09b9c" +dependencies = [ + "futures-timer", + "futures-util", + "rstest_macros", +] + +[[package]] +name = "rstest_macros" +version = "0.27.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a8d92eaf7b6e51e12471d71ddc72608e7151573de44099aacfbb1128177c0da4" +dependencies = [ + "cfg-if", + "glob", + "proc-macro-crate", + "proc-macro2", + "quote", + "regex", + "relative-path", + "rustc_version", + "syn 2.0.119", + "unicode-ident", +] + +[[package]] +name = "rustc-hash" +version = "2.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6b1e7f9a428571be2dc5bc0505c13fb6bf936822b894ec87abf8a08a4e51742d" + +[[package]] +name = "rustc_version" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cfcb3a22ef46e85b45de6ee7e79d063319ebb6594faafcf1c225ea92ab6e9b92" +dependencies = [ + "semver", +] + +[[package]] +name = "rustix" +version = "1.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "891efababe418670775f199f0d233d84843c227a0949a883ce15b37c78d6629d" +dependencies = [ + "bitflags", + "errno", + "libc", + "linux-raw-sys", + "windows-sys 0.61.2", +] + +[[package]] +name = "rustls" +version = "0.23.45" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0d41d731c7d2f962d1ccc364cec258de3c0e93b38c2fb3ba97ac74513048d634" +dependencies = [ + "aws-lc-rs", + "once_cell", + "rustls-pki-types", + "rustls-webpki", + "subtle", + "zeroize", +] + +[[package]] +name = "rustls-native-certs" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dab5152771c58876a2146916e53e35057e1a4dfa2b9df0f0305b07f611fdea4d" +dependencies = [ + "openssl-probe", + "rustls-pki-types", + "schannel", + "security-framework", +] + +[[package]] +name = "rustls-pki-types" +version = "1.15.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2f4925028c7eb5d1fcdaf196971378ed9d2c1c4efc7dc5d011256f76c99c0a96" +dependencies = [ + "web-time", + "zeroize", +] + +[[package]] +name = "rustls-platform-verifier" +version = "0.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1167586491e2b18b8bfbb293e8180ec17c201c4f076d7cb3070ca964e7598f98" +dependencies = [ + "core-foundation", + "core-foundation-sys", + "jni", + "log", + "once_cell", + "rustls", + "rustls-native-certs", + "rustls-platform-verifier-android", + "rustls-webpki", + "security-framework", + "security-framework-sys", + "webpki-root-certs", + "windows-sys 0.61.2", +] + +[[package]] +name = "rustls-platform-verifier-android" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "eec689c0bc40ff2458a5977b6619cb718087084a18e02a131c599b62d05e1a5f" + +[[package]] +name = "rustls-webpki" +version = "0.103.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f3c3cf1d8b1e7d4927e2d154c3fcb02979afb9939629c62cd9048d4f07b60ac2" +dependencies = [ + "aws-lc-rs", + "ring", + "rustls-pki-types", + "untrusted 0.9.0", +] + +[[package]] +name = "rustversion" +version = "1.0.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cf54715a573b99ac80df0bc206da022bcd442c974952c7b9720069370852e21f" + +[[package]] +name = "same-file" +version = "1.0.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "93fc1dc3aaa9bfed95e02e6eadabb4baf7e3078b0bd1b4d7b6b0b68378900502" +dependencies = [ + "winapi-util", +] + +[[package]] +name = "schannel" +version = "0.1.29" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "91c1b7e4904c873ef0710c1f407dde2e6287de2bebc1bbbf7d430bb7cbffd939" +dependencies = [ + "windows-sys 0.61.2", +] + +[[package]] +name = "schemars" +version = "1.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "687274d293b6cdc6e73e0fee520bf2049650090d7164f87672d212a3c530cf4a" +dependencies = [ + "chrono", + "dyn-clone", + "ref-cast", + "schemars_derive", + "serde", + "serde_json", +] + +[[package]] +name = "schemars_derive" +version = "1.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d98c67716b46af2f0b8cf752abc930f6f9aecfbf671ecfb531db8a31dbe4e2ba" +dependencies = [ + "proc-macro2", + "quote", + "serde_derive_internals", + "syn 3.0.6", +] + +[[package]] +name = "scopeguard" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49" + +[[package]] +name = "security-framework" +version = "3.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b7f4bc775c73d9a02cde8bf7b2ec4c9d12743edf609006c7facc23998404cd1d" +dependencies = [ + "bitflags", + "core-foundation", + "core-foundation-sys", + "libc", + "security-framework-sys", +] + +[[package]] +name = "security-framework-sys" +version = "2.17.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6ce2691df843ecc5d231c0b14ece2acc3efb62c0a398c7e1d875f3983ce020e3" +dependencies = [ + "core-foundation-sys", + "libc", +] + +[[package]] +name = "semver" +version = "1.0.28" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8a7852d02fc848982e0c167ef163aaff9cd91dc640ba85e263cb1ce46fae51cd" + +[[package]] +name = "serde" +version = "1.0.229" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4148590afebada386688f18773da617792bf2ef03ffc1e4cbd2b1d45b023e0ba" +dependencies = [ + "serde_core", + "serde_derive", +] + +[[package]] +name = "serde_core" +version = "1.0.229" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "67dca2c9c51e58a4791a4b1ed58308b39c64224d349a935ab5039aa360942a48" +dependencies = [ + "serde_derive", +] + +[[package]] +name = "serde_derive" +version = "1.0.229" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e7a5d71263a5a7d47b41f6b3f06ba276f10cc18b0931f1799f710578e2309348" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "serde_derive_internals" +version = "0.30.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f852137cce035d6a4df67ccce505ff6b3e9fd3a10e3e52b24dc71e650bb1a9bd" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "serde_json" +version = "1.0.151" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c841b55ecdae098c80dcae9cf767f6f8a0c2cdb3416bbef72181df4d0fe73f14" +dependencies = [ + "itoa", + "memchr", + "serde", + "serde_core", + "zmij", +] + +[[package]] +name = "serde_path_to_error" +version = "0.1.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "10a9ff822e371bb5403e391ecd83e182e0e77ba7f6fe0160b795797109d1b457" +dependencies = [ + "itoa", + "serde", + "serde_core", +] + +[[package]] +name = "sha2" +version = "0.10.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a7507d819769d01a365ab707794a4084392c824f54a7a6a7862f8c3d0892b283" +dependencies = [ + "cfg-if", + "cpufeatures 0.2.17", + "digest 0.10.7", +] + +[[package]] +name = "sha2" +version = "0.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "446ba717509524cb3f22f17ecc096f10f4822d76ab5c0b9822c5f9c284e825f4" +dependencies = [ + "cfg-if", + "cpufeatures 0.3.1", + "digest 0.11.3", +] + +[[package]] +name = "sharded-slab" +version = "0.1.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f40ca3c46823713e0d4209592e8d6e826aa57e928f09752619fc696c499637f6" +dependencies = [ + "lazy_static", +] + +[[package]] +name = "shlex" +version = "2.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f8fadd59c855ef2080decdef8ff161eb6661b86933c9d82e5ba29dc602a55aba" + +[[package]] +name = "signal-hook-registry" +version = "1.4.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c4db69cba1110affc0e9f7bcd48bbf87b3f4fc7c61fc9155afd4c469eb3d6c1b" +dependencies = [ + "errno", + "libc", +] + +[[package]] +name = "signature" +version = "2.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "77549399552de45a898a580c1b41d445bf730df867cc44e6c0233bbc4b8329de" +dependencies = [ + "rand_core 0.6.4", +] + +[[package]] +name = "simd_cesu8" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "11031e251abf8611c80f460e19dbdeb54a66db918e49c65a7065b46ac7aec520" +dependencies = [ + "rustc_version", + "simdutf8", +] + +[[package]] +name = "simdutf8" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e3a9fe34e3e7a50316060351f37187a3f546bce95496156754b601a5fa71b76e" + +[[package]] +name = "simple_asn1" +version = "0.6.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0d585997b0ac10be3c5ee635f1bab02d512760d14b7c468801ac8a01d9ae5f1d" +dependencies = [ + "num-bigint", + "num-traits", + "thiserror 2.0.21", + "time", +] + +[[package]] +name = "slab" +version = "0.4.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0c790de23124f9ab44544d7ac05d60440adc586479ce501c1d6d7da3cd8c9cf5" + +[[package]] +name = "smallvec" +version = "1.16.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f9395f0f0eee849a9b707b2f06bb92a6a422090e2123bb2ef8e87a0e61892a8e" + +[[package]] +name = "socket2" +version = "0.6.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c3d1e2c7f27f8d4cb10542a02c49005dbd6e93095799d6f3be745fae9f8fedd4" +dependencies = [ + "libc", + "windows-sys 0.61.2", +] + +[[package]] +name = "sse-stream" +version = "0.2.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c25ac7aff0abd1dbc474536e40416e1102c7dd9bfba0b9861c6d357f835dcfb4" +dependencies = [ + "bytes", + "futures-util", + "http-body", + "http-body-util", + "pin-project-lite", +] + +[[package]] +name = "stable_deref_trait" +version = "1.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6ce2be8dc25455e1f91df71bfa12ad37d7af1092ae736f3a6cd0e37bc7810596" + +[[package]] +name = "strsim" +version = "0.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f" + +[[package]] +name = "subtle" +version = "2.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "13c2bddecc57b384dee18652358fb23172facb8a2c51ccc10d74c157bdea3292" + +[[package]] +name = "syn" +version = "2.0.119" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "872831b642d1a07999a962a351ed35b955ea2cfc8f3862091e2a240a84f17297" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "syn" +version = "3.0.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8593e8e72159ed2257d083c7a454a85cbf854f37a0966d8d483aff8c8a3ebcee" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "sync_wrapper" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0bf256ce5efdfa370213c1dabab5935a12e49f2c58d15e9eac2870d3b4f27263" +dependencies = [ + "futures-core", +] + +[[package]] +name = "synstructure" +version = "0.14.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "901704edd0dfe137f1987838ee4f259e4e063c31371bdb423f7ae38ec6f77f02" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "tempfile" +version = "3.27.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32497e9a4c7b38532efcdebeef879707aa9f794296a4f0244f6f69e9bc8574bd" +dependencies = [ + "fastrand", + "getrandom 0.4.3", + "once_cell", + "rustix", + "windows-sys 0.61.2", +] + +[[package]] +name = "thiserror" +version = "1.0.69" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6aaf5339b578ea85b50e080feb250a3e8ae8cfcdff9a461c9ec2904bc923f52" +dependencies = [ + "thiserror-impl 1.0.69", +] + +[[package]] +name = "thiserror" +version = "2.0.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "09e52cb86a36cede5cb101bf8908837b3e4c6e5e59fe7fd85c23fb56200d189e" +dependencies = [ + "thiserror-impl 2.0.21", +] + +[[package]] +name = "thiserror-impl" +version = "1.0.69" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4fee6c4efc90059e10f81e6d42c60a18f76588c3d74cb83a0b242a2b6c7504c1" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "thiserror-impl" +version = "2.0.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fe5197923287db20a58125f0bc85c062f7f2c892de97b18c356f9efb14b28524" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "thread_local" +version = "1.1.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1ad99c4c6d32803332c548b1af0540b357b3f5fc0be8f6c6bfe8b2e6ae784070" +dependencies = [ + "cfg-if", +] + +[[package]] +name = "time" +version = "0.3.55" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cdb87b95ec50ddfa440816d227a17b2ccbdda963a316a727fda0fc4334f7d134" +dependencies = [ + "deranged", + "num-conv", + "powerfmt", + "serde_core", + "time-core", + "time-macros", +] + +[[package]] +name = "time-core" +version = "0.1.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9e1c906769ad99c88eaa54e728060edef082f8e358ff32030cb7c7d315e81109" + +[[package]] +name = "time-macros" +version = "0.2.32" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7e689342a48d2ea927c87ea50cabf8594854bf940e9310208848d680d668ed85" +dependencies = [ + "num-conv", + "time-core", +] + +[[package]] +name = "tinystr" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b1e27c91459209c2986af3dcf603a5a74a4368754ce37414f59acc971167f643" +dependencies = [ + "displaydoc", + "zerovec", +] + +[[package]] +name = "tinyvec" +version = "1.13.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fd3ca314f692efd6c868f8408f53fe444634a845f96c028b97d35f6a1f79f0ee" + +[[package]] +name = "tokio" +version = "1.53.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "202caea871b69668250d242070849eb495be178ed697a3e98aebce5bc81a0bed" +dependencies = [ + "bytes", + "libc", + "mio", + "parking_lot", + "pin-project-lite", + "signal-hook-registry", + "socket2", + "tokio-macros", + "windows-sys 0.61.2", +] + +[[package]] +name = "tokio-macros" +version = "2.7.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "78773a2a397f451582ce068015985c33193cf6dea8b74d2a639fe457b2f07b0e" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "tokio-native-tls" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bbae76ab933c85776efabc971569dd6119c580d8f5d448769dec1764bf796ef2" +dependencies = [ + "native-tls", + "tokio", +] + +[[package]] +name = "tokio-rustls" +version = "0.26.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b0c85f2c3ef0b1cd58b36682f4b17aaa995f0e5db534d85692b4903abce21f67" +dependencies = [ + "rustls", + "tokio", +] + +[[package]] +name = "tokio-stream" +version = "0.1.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a3d06f0b082ba57c26b79407372e57cf2a1e28124f78e9479fe80322cf53420b" +dependencies = [ + "futures-core", + "pin-project-lite", + "tokio", +] + +[[package]] +name = "tokio-util" +version = "0.7.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "494815d09bf52b5548659851081238f0ca39ff638363907596da739561c62c52" +dependencies = [ + "bytes", + "futures-core", + "futures-sink", + "libc", + "pin-project-lite", + "tokio", +] + +[[package]] +name = "toml_datetime" +version = "1.1.1+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3165f65f62e28e0115a00b2ebdd37eb6f3b641855f9d636d3cd4103767159ad7" +dependencies = [ + "serde_core", +] + +[[package]] +name = "toml_edit" +version = "0.25.15+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1340ea94a5856333492c9064b02c778b191dd2c853778d9609debdcdfea3a614" +dependencies = [ + "indexmap", + "toml_datetime", + "toml_parser", + "winnow", +] + +[[package]] +name = "toml_parser" +version = "1.1.3+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1d38ac1cf9b95face32296c0a3ede1fdc270627c9d9c02a7274dd6d960dc4d56" +dependencies = [ + "winnow", +] + +[[package]] +name = "tower" +version = "0.5.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ebe5ef63511595f1344e2d5cfa636d973292adc0eec1f0ad45fae9f0851ab1d4" +dependencies = [ + "futures-core", + "futures-util", + "pin-project-lite", + "sync_wrapper", + "tokio", + "tower-layer", + "tower-service", +] + +[[package]] +name = "tower-http" +version = "0.6.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4cfcf7e2740e6fc6d4d688b4ef00650406bb94adf4731e43c096c3a19fe40840" +dependencies = [ + "bitflags", + "bytes", + "futures-util", + "http", + "http-body", + "pin-project-lite", + "tower", + "tower-layer", + "tower-service", + "url", +] + +[[package]] +name = "tower-layer" +version = "0.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "121c2a6cda46980bb0fcd1647ffaf6cd3fc79a013de288782836f6df9c48780e" + +[[package]] +name = "tower-service" +version = "0.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8df9b6e13f2d32c91b9bd719c00d1958837bc7dec474d94952798cc8e69eeec3" + +[[package]] +name = "tracing" +version = "0.1.44" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "63e71662fa4b2a2c3a26f570f037eb95bb1f85397f3cd8076caed2f026a6d100" +dependencies = [ + "pin-project-lite", + "tracing-attributes", + "tracing-core", +] + +[[package]] +name = "tracing-attributes" +version = "0.1.31" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7490cfa5ec963746568740651ac6781f701c9c5ea257c58e057f3ba8cf69e8da" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "tracing-core" +version = "0.1.36" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "db97caf9d906fbde555dd62fa95ddba9eecfd14cb388e4f491a66d74cd5fb79a" +dependencies = [ + "once_cell", + "valuable", +] + +[[package]] +name = "tracing-log" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ee855f1f400bd0e5c02d150ae5de3840039a3f54b025156404e34c23c03f47c3" +dependencies = [ + "log", + "once_cell", + "tracing-core", +] + +[[package]] +name = "tracing-subscriber" +version = "0.3.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cb7f578e5945fb242538965c2d0b04418d38ec25c79d160cd279bf0731c8d319" +dependencies = [ + "matchers", + "nu-ansi-term", + "once_cell", + "regex-automata", + "sharded-slab", + "smallvec", + "thread_local", + "tracing", + "tracing-core", + "tracing-log", +] + +[[package]] +name = "try-lock" +version = "0.2.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e421abadd41a4225275504ea4d6566923418b7f05506fbc9c0fe86ba7396114b" + +[[package]] +name = "typenum" +version = "1.20.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6f5e870be6c3b371b77fe0ee0bafb859fa4964b4404c27de1d380043c4dda20" + +[[package]] +name = "unicode-ident" +version = "1.0.26" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d245f478577f809a851594d02313b640fb437e0bb33866753cff937863096954" + +[[package]] +name = "untrusted" +version = "0.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a156c684c91ea7d62626509bce3cb4e1d9ed5c4d978f7b4352658f96a4c26b4a" + +[[package]] +name = "untrusted" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8ecb6da28b8a351d773b68d5825ac39017e680750f980f3a1a85cd8dd28a47c1" + +[[package]] +name = "url" +version = "2.5.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ff67a8a4397373c3ef660812acab3268222035010ab8680ec4215f38ba3d0eed" +dependencies = [ + "form_urlencoded", + "idna", + "percent-encoding", + "serde", + "serde_derive", +] + +[[package]] +name = "utf8_iter" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6c140620e7ffbb22c2dee59cafe6084a59b5ffc27a8859a5f0d494b5d52b6be" + +[[package]] +name = "uuid" +version = "1.26.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2ef6dac1e96601b4fb3acccccff2139741fcb757cb9a36089bf5be91cfb285ce" +dependencies = [ + "getrandom 0.4.3", + "js-sys", + "wasm-bindgen", +] + +[[package]] +name = "valuable" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ba73ea9cf16a25df0c8caa16c51acb937d5712a8429db78a3ee29d5dcacd3a65" + +[[package]] +name = "vcpkg" +version = "0.2.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "accd4ea62f7bb7a82fe23066fb0957d48ef677f6eeb8215f372f52e48bb32426" + +[[package]] +name = "version_check" +version = "0.9.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0b928f33d975fc6ad9f86c8f283853ad26bdd5b10b7f1542aa2fa15e2289105a" + +[[package]] +name = "walkdir" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "29790946404f91d9c5d06f9874efddea1dc06c5efe94541a7d6863108e3a5e4b" +dependencies = [ + "same-file", + "winapi-util", +] + +[[package]] +name = "want" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bfa7760aed19e106de2c7c0b581b509f2f25d3dacaf737cb82ac61bc6d760b0e" +dependencies = [ + "try-lock", +] + +[[package]] +name = "wasi" +version = "0.11.1+wasi-snapshot-preview1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ccf3ec651a847eb01de73ccad15eb7d99f80485de043efb2f370cd654f4ea44b" + +[[package]] +name = "wasm-bindgen" +version = "0.2.129" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9bb54f33acc68fd454578d9820b0bde1a1a3d17aa17bb7b6595806d02886d409" +dependencies = [ + "cfg-if", + "once_cell", + "rustversion", + "wasm-bindgen-macro", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-futures" +version = "0.4.79" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3cbab34de2d982e9b48e18d216d04c4a6f641066ff19ffb699980f591ee3610e" +dependencies = [ + "js-sys", + "tokio", + "wasm-bindgen", +] + +[[package]] +name = "wasm-bindgen-macro" +version = "0.2.129" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2e29d0c35b16e224a7eeb5cd2d25e3e1968fbd65604117b44d3b789d00ee8535" +dependencies = [ + "quote", + "wasm-bindgen-macro-support", +] + +[[package]] +name = "wasm-bindgen-macro-support" +version = "0.2.129" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6f501a8bc3719dba86ef8ae4728879c08001bea749eb1333ac5b91e040e2a6b7" +dependencies = [ + "bumpalo", + "proc-macro2", + "quote", + "syn 3.0.6", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-shared" +version = "0.2.129" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "23f0c9c52aa7cd7d77769a4cfe2a9adb1b331f489a41d912ce14513d5ab995c6" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "wasm-streams" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9d1ec4f6517c9e11ae630e200b2b65d193279042e28edd4a2cda233e46670bbb" +dependencies = [ + "futures-util", + "js-sys", + "wasm-bindgen", + "wasm-bindgen-futures", + "web-sys", +] + +[[package]] +name = "web-sys" +version = "0.3.106" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "88261b9deccee56594c11a3460c462c41f58d148598fe70ad77070126a68aba4" +dependencies = [ + "js-sys", + "wasm-bindgen", +] + +[[package]] +name = "web-time" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5a6580f308b1fad9207618087a65c04e7a10bc77e02c8e84e9b00dd4b12fa0bb" +dependencies = [ + "js-sys", + "wasm-bindgen", +] + +[[package]] +name = "webpki-root-certs" +version = "1.0.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b96554aa2acc8ccdb7e1c9a58a7a68dd5d13bccc69cd124cb09406db612a1c9b" +dependencies = [ + "rustls-pki-types", +] + +[[package]] +name = "which" +version = "8.0.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bae2f2b2b816647a1cab1acc91f5bd20812d53cb344382635ec2181940c8034f" +dependencies = [ + "libc", +] + +[[package]] +name = "winapi-util" +version = "0.1.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c2a7b1c03c876122aa43f3020e6c3c3ee5c05081c9a00739faf7503aeba10d22" +dependencies = [ + "windows-sys 0.61.2", +] + +[[package]] +name = "windows" +version = "0.62.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "527fadee13e0c05939a6a05d5bd6eec6cd2e3dbd648b9f8e447c6518133d8580" +dependencies = [ + "windows-collections", + "windows-core", + "windows-future", + "windows-numerics", +] + +[[package]] +name = "windows-collections" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "23b2d95af1a8a14a3c7367e1ed4fc9c20e0a26e79551b1454d72583c97cc6610" +dependencies = [ + "windows-core", +] + +[[package]] +name = "windows-core" +version = "0.62.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b8e83a14d34d0623b51dce9581199302a221863196a1dde71a7663a4c2be9deb" +dependencies = [ + "windows-implement", + "windows-interface", + "windows-link", + "windows-result", + "windows-strings", +] + +[[package]] +name = "windows-future" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e1d6f90251fe18a279739e78025bd6ddc52a7e22f921070ccdc67dde84c605cb" +dependencies = [ + "windows-core", + "windows-link", + "windows-threading", +] + +[[package]] +name = "windows-implement" +version = "0.60.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "053e2e040ab57b9dc951b72c264860db7eb3b0200ba345b4e4c3b14f67855ddf" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "windows-interface" +version = "0.59.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3f316c4a2570ba26bbec722032c4099d8c8bc095efccdc15688708623367e358" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "windows-link" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5" + +[[package]] +name = "windows-numerics" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6e2e40844ac143cdb44aead537bbf727de9b044e107a0f1220392177d15b0f26" +dependencies = [ + "windows-core", + "windows-link", +] + +[[package]] +name = "windows-result" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7781fa89eaf60850ac3d2da7af8e5242a5ea78d1a11c49bf2910bb5a73853eb5" +dependencies = [ + "windows-link", +] + +[[package]] +name = "windows-strings" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7837d08f69c77cf6b07689544538e017c1bfcf57e34b4c0ff58e6c2cd3b37091" +dependencies = [ + "windows-link", +] + +[[package]] +name = "windows-sys" +version = "0.52.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "282be5f36a8ce781fad8c8ae18fa3f9beff57ec1b52cb3de0789201425d9a33d" +dependencies = [ + "windows-targets", +] + +[[package]] +name = "windows-sys" +version = "0.61.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ae137229bcbd6cdf0f7b80a31df61766145077ddf49416a728b02cb3921ff3fc" +dependencies = [ + "windows-link", +] + +[[package]] +name = "windows-targets" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973" +dependencies = [ + "windows_aarch64_gnullvm", + "windows_aarch64_msvc", + "windows_i686_gnu", + "windows_i686_gnullvm", + "windows_i686_msvc", + "windows_x86_64_gnu", + "windows_x86_64_gnullvm", + "windows_x86_64_msvc", +] + +[[package]] +name = "windows-threading" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3949bd5b99cafdf1c7ca86b43ca564028dfe27d66958f2470940f73d86d75b37" +dependencies = [ + "windows-link", +] + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3" + +[[package]] +name = "windows_aarch64_msvc" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469" + +[[package]] +name = "windows_i686_gnu" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b" + +[[package]] +name = "windows_i686_gnullvm" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66" + +[[package]] +name = "windows_i686_msvc" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78" + +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec" + +[[package]] +name = "winnow" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "23b97319f7b8343df12cc98938e5c3eb436064524c8d2b4e30a1d3a36eecdf81" +dependencies = [ + "memchr", +] + +[[package]] +name = "writeable" +version = "0.6.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3ad82d2a33cdc9674dc7465672f271e096168fcdbe0f799d9e6db8c5892679dc" + +[[package]] +name = "yoke" +version = "0.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "709fe23a0424b6a435d82152b1bd3fdfb0833487d5fa90d05d42762a9891fef5" +dependencies = [ + "stable_deref_trait", + "yoke-derive", + "zerofrom", +] + +[[package]] +name = "yoke-derive" +version = "0.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "33811428bee40dbceb6d545e95754741d17a6aef9a4849f0fd62e2ba4f412a78" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", + "synstructure", +] + +[[package]] +name = "zerocopy" +version = "0.8.59" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6df92bf3d9227be3d53173901ddbffac2babc27ae50f397776ffd6dc33f800cb" +dependencies = [ + "zerocopy-derive", +] + +[[package]] +name = "zerocopy-derive" +version = "0.8.59" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac4f328cf2f05d084e496c3e9c3f33ed0a183656a16e1fcec4d464d8373aec82" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "zerofrom" +version = "0.1.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0ec05a11813ea801ff6d75110ad09cd0824ddba17dfe17128ea0d5f68e6c5272" +dependencies = [ + "zerofrom-derive", +] + +[[package]] +name = "zerofrom-derive" +version = "0.1.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f75b4683f6c7f45248d4d64056a24298c6281e0993356d7d1b4a1a962ef10d4a" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", + "synstructure", +] + +[[package]] +name = "zeroize" +version = "1.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e13c156562582aa81c60cb29407084cdb54c4164760106ab78e6c5b0858cf64e" +dependencies = [ + "zeroize_derive", +] + +[[package]] +name = "zeroize_derive" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3c50655cbb0fe3fc43170059e702f1ce5e19b84cec58dc87b037a09935c2f328" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "zerotrie" +version = "0.2.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4ea269c3bd32f0a32c321907a2ae912ba6f4649bb0fc764a15627e99a7095a3f" +dependencies = [ + "displaydoc", + "yoke", + "zerofrom", +] + +[[package]] +name = "zerovec" +version = "0.11.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bb0464e17806c1d976d5cba29399c7f08e516e279e2ba493f63123b5fca67dd8" +dependencies = [ + "yoke", + "zerofrom", + "zerovec-derive", +] + +[[package]] +name = "zerovec-derive" +version = "0.11.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "34df6fc39dbd26ddc9c10e6a2984476e13acce22e64e4487636ef494369225da" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "zmij" +version = "1.0.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "29666d0abbfad1e3dc4dcf6144730dd3a3ab225bbbdac83319345b1b44ccfc1b" diff --git a/vendor/rmcp/Cargo.toml b/vendor/rmcp/Cargo.toml new file mode 100644 index 00000000..1b7af6f4 --- /dev/null +++ b/vendor/rmcp/Cargo.toml @@ -0,0 +1,957 @@ +# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO +# +# When uploading crates to the registry Cargo will automatically +# "normalize" Cargo.toml files for maximal compatibility +# with all versions of Cargo and also rewrite `path` dependencies +# to registry (e.g., crates.io) dependencies. +# +# If you are reading this file be aware that the original Cargo.toml +# will likely look very different (and much more reasonable). +# See Cargo.toml.orig for the original contents. + +[package] +edition = "2024" +rust-version = "1.88" +name = "rmcp" +version = "3.5.0" +build = "build.rs" +autolib = false +autobins = false +autoexamples = false +autotests = false +autobenches = false +description = "Rust SDK for Model Context Protocol" +homepage = "https://github.com/modelcontextprotocol/rust-sdk" +documentation = "https://docs.rs/rmcp" +readme = "README.md" +license = "Apache-2.0" +repository = "https://github.com/modelcontextprotocol/rust-sdk/" +resolver = "2" + +[package.metadata.docs.rs] +features = [ + "auth", + "auth-client-credentials-jwt", + "auth-enterprise-managed", + "base64", + "client", + "client-side-sse", + "elicitation", + "macros", + "request-state", + "reqwest", + "reqwest-native-tls", + "reqwest-tls-no-provider", + "schemars", + "server", + "server-side-http", + "tower", + "transport-async-rw", + "transport-child-process", + "transport-io", + "transport-streamable-http-client", + "transport-streamable-http-client-reqwest", + "transport-streamable-http-client-unix-socket", + "transport-streamable-http-server", + "transport-streamable-http-server-session", + "transport-worker", + "uuid", +] +rustdoc-args = [ + "--cfg", + "docsrs", +] + +[features] +__reqwest = ["dep:reqwest"] +auth = [ + "dep:async-trait", + "dep:oauth2", + "__reqwest", + "dep:url", +] +auth-client-credentials-jwt = [ + "auth", + "dep:jsonwebtoken", + "uuid", +] +auth-enterprise-managed = [ + "auth", + "base64", +] +client = ["dep:tokio-stream"] +client-side-sse = [ + "dep:sse-stream", + "dep:http", + "dep:bytes", + "base64", +] +default = [ + "base64", + "macros", + "server", +] +elicitation = ["dep:url"] +local = ["rmcp-macros?/local"] +macros = [ + "dep:rmcp-macros", + "dep:pastey", +] +request-state = [ + "dep:hmac", + "dep:sha2", + "dep:zeroize", + "base64", +] +reqwest = [ + "__reqwest", + "reqwest?/rustls", +] +reqwest-native-tls = [ + "__reqwest", + "reqwest?/native-tls", +] +reqwest-tls-no-provider = [ + "__reqwest", + "reqwest?/rustls-no-provider", +] +schemars = ["dep:schemars"] +server = [ + "transport-async-rw", + "schemars", + "dep:pastey", + "uuid", +] +server-side-http = [ + "uuid", + "dep:rand", + "dep:tokio-stream", + "dep:http", + "dep:http-body", + "dep:http-body-util", + "dep:bytes", + "dep:sse-stream", + "tower", + "base64", +] +tower = ["dep:tower-service"] +transport-async-rw = [ + "tokio/io-util", + "tokio-util/codec", +] +transport-child-process = [ + "transport-async-rw", + "tokio/process", + "dep:process-wrap", +] +transport-io = [ + "transport-async-rw", + "tokio/io-std", +] +transport-streamable-http-client = [ + "client-side-sse", + "transport-worker", +] +transport-streamable-http-client-reqwest = [ + "transport-streamable-http-client", + "__reqwest", +] +transport-streamable-http-client-unix-socket = [ + "transport-streamable-http-client", + "dep:hyper", + "dep:hyper-util", + "dep:http-body-util", + "dep:http", + "dep:bytes", + "tokio/net", +] +transport-streamable-http-server = [ + "transport-streamable-http-server-session", + "server-side-http", + "transport-worker", +] +transport-streamable-http-server-session = [ + "transport-async-rw", + "dep:async-trait", + "dep:tokio-stream", +] +transport-worker = ["dep:tokio-stream"] +which-command = [ + "transport-child-process", + "dep:which", +] + +[lib] +name = "rmcp" +path = "src/lib.rs" + +[[test]] +name = "test_auth_error_classification" +path = "tests/test_auth_error_classification.rs" +required-features = [ + "auth", + "client", + "transport-streamable-http-client", +] + +[[test]] +name = "test_cache_hints" +path = "tests/test_cache_hints.rs" + +[[test]] +name = "test_cancelled_response" +path = "tests/test_cancelled_response.rs" + +[[test]] +name = "test_client_credentials" +path = "tests/test_client_credentials.rs" +required-features = ["auth"] + +[[test]] +name = "test_client_initialization" +path = "tests/test_client_initialization.rs" + +[[test]] +name = "test_client_lifecycle_modes" +path = "tests/test_client_lifecycle_modes.rs" +required-features = [ + "client", + "server", +] + +[[test]] +name = "test_close_connection" +path = "tests/test_close_connection.rs" +required-features = [ + "server", + "client", +] + +[[test]] +name = "test_completion" +path = "tests/test_completion.rs" + +[[test]] +name = "test_complex_schema" +path = "tests/test_complex_schema.rs" + +[[test]] +name = "test_custom_headers" +path = "tests/test_custom_headers.rs" +required-features = [ + "client", + "server", + "transport-streamable-http-client-reqwest", + "transport-streamable-http-server", +] + +[[test]] +name = "test_custom_request" +path = "tests/test_custom_request.rs" +required-features = [ + "server", + "client", +] + +[[test]] +name = "test_deserialization" +path = "tests/test_deserialization.rs" + +[[test]] +name = "test_discover_http_client_startup" +path = "tests/test_discover_http_client_startup.rs" +required-features = [ + "client", + "reqwest", + "transport-streamable-http-client-reqwest", + "transport-streamable-http-server", +] + +[[test]] +name = "test_elicitation" +path = "tests/test_elicitation.rs" +required-features = [ + "elicitation", + "client", + "server", +] + +[[test]] +name = "test_embedded_resource_meta" +path = "tests/test_embedded_resource_meta.rs" + +[[test]] +name = "test_handler_cache_hints" +path = "tests/test_handler_cache_hints.rs" + +[[test]] +name = "test_handler_wrappers" +path = "tests/test_handler_wrappers.rs" + +[[test]] +name = "test_inflight_response_drain" +path = "tests/test_inflight_response_drain.rs" + +[[test]] +name = "test_json_schema_detection" +path = "tests/test_json_schema_detection.rs" + +[[test]] +name = "test_list_tools_result" +path = "tests/test_list_tools_result.rs" + +[[test]] +name = "test_live_oauth_refresh" +path = "tests/test_live_oauth_refresh.rs" + +[[test]] +name = "test_local_client_handler" +path = "tests/test_local_client_handler.rs" +required-features = [ + "client", + "local", +] + +[[test]] +name = "test_logging" +path = "tests/test_logging.rs" +required-features = [ + "server", + "client", +] + +[[test]] +name = "test_message_protocol" +path = "tests/test_message_protocol.rs" +required-features = ["client"] + +[[test]] +name = "test_message_schema" +path = "tests/test_message_schema.rs" +required-features = [ + "server", + "client", + "schemars", +] + +[[test]] +name = "test_meta_helpers" +path = "tests/test_meta_helpers.rs" + +[[test]] +name = "test_mrtr_behavior" +path = "tests/test_mrtr_behavior.rs" +required-features = [ + "server", + "client", +] + +[[test]] +name = "test_notification" +path = "tests/test_notification.rs" +required-features = [ + "server", + "client", +] + +[[test]] +name = "test_progress_subscriber" +path = "tests/test_progress_subscriber.rs" +required-features = [ + "server", + "client", + "macros", +] + +[[test]] +name = "test_prompt_handler" +path = "tests/test_prompt_handler.rs" + +[[test]] +name = "test_prompt_macro_annotations" +path = "tests/test_prompt_macro_annotations.rs" + +[[test]] +name = "test_prompt_macros" +path = "tests/test_prompt_macros.rs" +required-features = [ + "server", + "client", +] + +[[test]] +name = "test_prompt_routers" +path = "tests/test_prompt_routers.rs" + +[[test]] +name = "test_protocol_version_negotiation" +path = "tests/test_protocol_version_negotiation.rs" +required-features = [ + "server", + "client", +] + +[[test]] +name = "test_request_timeout_progress" +path = "tests/test_request_timeout_progress.rs" +required-features = [ + "server", + "client", + "macros", +] + +[[test]] +name = "test_resource_link" +path = "tests/test_resource_link.rs" + +[[test]] +name = "test_resource_link_integration" +path = "tests/test_resource_link_integration.rs" + +[[test]] +name = "test_resource_not_found_version" +path = "tests/test_resource_not_found_version.rs" + +[[test]] +name = "test_result_type_version" +path = "tests/test_result_type_version.rs" + +[[test]] +name = "test_result_type_wire" +path = "tests/test_result_type_wire.rs" + +[[test]] +name = "test_sampling" +path = "tests/test_sampling.rs" +required-features = [ + "server", + "client", +] + +[[test]] +name = "test_sep_2260_request_association" +path = "tests/test_sep_2260_request_association.rs" + +[[test]] +name = "test_sep_2260_stream_enforcement" +path = "tests/test_sep_2260_stream_enforcement.rs" + +[[test]] +name = "test_sep_2260_stream_routing" +path = "tests/test_sep_2260_stream_routing.rs" +required-features = [ + "server", + "elicitation", + "transport-streamable-http-server", + "reqwest", +] + +[[test]] +name = "test_server_discover" +path = "tests/test_server_discover.rs" + +[[test]] +name = "test_server_discover_client" +path = "tests/test_server_discover_client.rs" + +[[test]] +name = "test_server_discover_http" +path = "tests/test_server_discover_http.rs" + +[[test]] +name = "test_server_initialization" +path = "tests/test_server_initialization.rs" + +[[test]] +name = "test_sse_concurrent_streams" +path = "tests/test_sse_concurrent_streams.rs" +required-features = [ + "server", + "client", + "transport-streamable-http-server", + "transport-streamable-http-client", + "reqwest", +] + +[[test]] +name = "test_stateless_protocol_version" +path = "tests/test_stateless_protocol_version.rs" +required-features = [ + "server", + "transport-streamable-http-server", + "reqwest", +] + +[[test]] +name = "test_stateless_server_requests" +path = "tests/test_stateless_server_requests.rs" +required-features = [ + "client", + "server", +] + +[[test]] +name = "test_stdio_response_concurrency" +path = "tests/test_stdio_response_concurrency.rs" + +[[test]] +name = "test_streamable_http_4xx_error_body" +path = "tests/test_streamable_http_4xx_error_body.rs" +required-features = [ + "transport-streamable-http-client", + "transport-streamable-http-client-reqwest", +] + +[[test]] +name = "test_streamable_http_client_concurrency" +path = "tests/test_streamable_http_client_concurrency.rs" +required-features = [ + "client", + "transport-streamable-http-client", +] + +[[test]] +name = "test_streamable_http_connection_reuse" +path = "tests/test_streamable_http_connection_reuse.rs" +required-features = [ + "server", + "client", + "macros", + "schemars", + "transport-streamable-http-server", + "transport-streamable-http-client", + "transport-streamable-http-client-reqwest", +] + +[[test]] +name = "test_streamable_http_disconnect_cancel" +path = "tests/test_streamable_http_disconnect_cancel.rs" +required-features = [ + "server", + "transport-streamable-http-server", + "reqwest", +] + +[[test]] +name = "test_streamable_http_empty_2xx_notification" +path = "tests/test_streamable_http_empty_2xx_notification.rs" + +[[test]] +name = "test_streamable_http_event_store" +path = "tests/test_streamable_http_event_store.rs" +required-features = [ + "client", + "server", + "transport-streamable-http-client-reqwest", + "transport-streamable-http-server", +] + +[[test]] +name = "test_streamable_http_get_stream_auth_challenge" +path = "tests/test_streamable_http_get_stream_auth_challenge.rs" + +[[test]] +name = "test_streamable_http_idle_timeout_log" +path = "tests/test_streamable_http_idle_timeout_log.rs" + +[[test]] +name = "test_streamable_http_init_timeout" +path = "tests/test_streamable_http_init_timeout.rs" + +[[test]] +name = "test_streamable_http_json_response" +path = "tests/test_streamable_http_json_response.rs" +required-features = [ + "server", + "client", + "transport-streamable-http-server", + "reqwest", +] + +[[test]] +name = "test_streamable_http_malformed_json_request" +path = "tests/test_streamable_http_malformed_json_request.rs" +required-features = [ + "client", + "transport-streamable-http-client", + "transport-streamable-http-client-reqwest", +] + +[[test]] +name = "test_streamable_http_priming" +path = "tests/test_streamable_http_priming.rs" +required-features = [ + "server", + "client", + "transport-streamable-http-server", + "reqwest", +] + +[[test]] +name = "test_streamable_http_protocol_version" +path = "tests/test_streamable_http_protocol_version.rs" +required-features = [ + "server", + "client", + "transport-streamable-http-server", + "reqwest", +] + +[[test]] +name = "test_streamable_http_session_store" +path = "tests/test_streamable_http_session_store.rs" +required-features = [ + "client", + "server", + "transport-streamable-http-client-reqwest", + "transport-streamable-http-server", +] + +[[test]] +name = "test_streamable_http_stale_session" +path = "tests/test_streamable_http_stale_session.rs" +required-features = [ + "server", + "client", + "transport-streamable-http-server", + "transport-streamable-http-client", + "transport-streamable-http-client-reqwest", +] + +[[test]] +name = "test_streamable_http_standard_headers" +path = "tests/test_streamable_http_standard_headers.rs" +required-features = [ + "server", + "client", + "transport-streamable-http-server", + "reqwest", +] + +[[test]] +name = "test_structured_output" +path = "tests/test_structured_output.rs" + +[[test]] +name = "test_subscriptions" +path = "tests/test_subscriptions.rs" + +[[test]] +name = "test_subscriptions_model" +path = "tests/test_subscriptions_model.rs" + +[[test]] +name = "test_subscriptions_streamable_http" +path = "tests/test_subscriptions_streamable_http.rs" + +[[test]] +name = "test_task" +path = "tests/test_task.rs" +required-features = [ + "server", + "client", + "macros", +] + +[[test]] +name = "test_tool_builder_methods" +path = "tests/test_tool_builder_methods.rs" + +[[test]] +name = "test_tool_disable_notification" +path = "tests/test_tool_disable_notification.rs" + +[[test]] +name = "test_tool_handler" +path = "tests/test_tool_handler.rs" + +[[test]] +name = "test_tool_macro_annotations" +path = "tests/test_tool_macro_annotations.rs" + +[[test]] +name = "test_tool_macros" +path = "tests/test_tool_macros.rs" +required-features = [ + "server", + "client", +] + +[[test]] +name = "test_tool_result_meta" +path = "tests/test_tool_result_meta.rs" + +[[test]] +name = "test_tool_routers" +path = "tests/test_tool_routers.rs" + +[[test]] +name = "test_trace_context" +path = "tests/test_trace_context.rs" +required-features = [ + "server", + "client", +] + +[[test]] +name = "test_unix_socket_transport" +path = "tests/test_unix_socket_transport.rs" +required-features = [ + "client", + "server", + "transport-streamable-http-client-unix-socket", +] + +[[test]] +name = "test_with_js" +path = "tests/test_with_js.rs" +required-features = [ + "server", + "client", + "transport-child-process", + "transport-streamable-http-server", + "transport-streamable-http-client", + "__reqwest", +] + +[[test]] +name = "test_with_python" +path = "tests/test_with_python.rs" +required-features = [ + "reqwest", + "server", + "client", + "transport-child-process", +] + +[dependencies.async-trait] +version = "0.1.89" +optional = true + +[dependencies.base64] +version = "0.23" +optional = true + +[dependencies.bytes] +version = "1" +optional = true + +[dependencies.futures] +version = "0.3" + +[dependencies.hmac] +version = "0.13" +optional = true + +[dependencies.http] +version = "1" +optional = true + +[dependencies.http-body] +version = "1" +optional = true + +[dependencies.http-body-util] +version = "0.1" +optional = true + +[dependencies.hyper] +version = "1" +features = [ + "client", + "http1", +] +optional = true + +[dependencies.hyper-util] +version = "0.1" +features = ["tokio"] +optional = true + +[dependencies.indexmap] +version = "2" +features = ["serde"] + +[dependencies.jsonwebtoken] +version = "11" +features = ["aws_lc_rs"] +optional = true + +[dependencies.oauth2] +version = "5.0" +optional = true +default-features = false + +[dependencies.pastey] +version = "0.2.0" +optional = true + +[dependencies.pin-project-lite] +version = "0.2" + +[dependencies.process-wrap] +version = "10.0" +features = ["tokio1"] +optional = true + +[dependencies.rand] +version = "0.10" +optional = true + +[dependencies.reqwest] +version = "0.13.2" +features = [ + "json", + "stream", +] +optional = true +default-features = false + +[dependencies.rmcp-macros] +version = "3.5.0" +optional = true + +[dependencies.schemars] +version = "1.0" +features = ["chrono04"] +optional = true + +[dependencies.serde] +version = "1.0" +features = [ + "derive", + "rc", +] + +[dependencies.serde_json] +version = "1.0" + +[dependencies.sha2] +version = "0.11" +optional = true + +[dependencies.sse-stream] +version = "0.2.4" +optional = true + +[dependencies.thiserror] +version = "2" + +[dependencies.tokio] +version = "1" +features = [ + "sync", + "macros", + "rt", + "time", +] + +[dependencies.tokio-stream] +version = "0.1" +optional = true + +[dependencies.tokio-util] +version = "0.7" + +[dependencies.tower-service] +version = "0.3" +optional = true + +[dependencies.tracing] +version = "0.1" + +[dependencies.url] +version = "2.4" +optional = true + +[dependencies.uuid] +version = "1" +features = ["v4"] +optional = true + +[dependencies.which] +version = "8" +optional = true + +[dependencies.zeroize] +version = "1" +optional = true + +[dev-dependencies.anyhow] +version = "1.0" + +[dev-dependencies.async-trait] +version = "0.1" + +[dev-dependencies.axum] +version = "0.8" +features = [ + "http1", + "tokio", +] +default-features = false + +[dev-dependencies.hyper] +version = "1" +features = [ + "server", + "http1", +] + +[dev-dependencies.hyper-util] +version = "0.1" +features = ["tokio"] + +[dev-dependencies.rstest] +version = "0.27.0" + +[dev-dependencies.schemars] +version = "1.1.0" +features = ["chrono04"] + +[dev-dependencies.serde_json] +version = "1.0" +features = ["arbitrary_precision"] + +[dev-dependencies.tokio] +version = "1" +features = [ + "full", + "test-util", +] + +[dev-dependencies.tower-service] +version = "0.3" + +[dev-dependencies.tracing-subscriber] +version = "0.3" +features = [ + "env-filter", + "std", + "fmt", +] + +[dev-dependencies.url] +version = "2.4" + +[target.'cfg(all(target_family = "wasm", target_os = "unknown"))'.dependencies.chrono] +version = "0.4.38" +features = [ + "serde", + "clock", + "std", + "oldtime", +] +default-features = false + +[target.'cfg(not(all(target_family = "wasm", target_os = "unknown")))'.dependencies.chrono] +version = "0.4.38" +features = [ + "serde", + "now", +] +default-features = false + +[lints.clippy] +exhaustive_enums = "warn" +exhaustive_structs = "warn" diff --git a/vendor/rmcp/Cargo.toml.orig b/vendor/rmcp/Cargo.toml.orig new file mode 100644 index 00000000..772844d8 --- /dev/null +++ b/vendor/rmcp/Cargo.toml.orig @@ -0,0 +1,485 @@ +[package] +name = "rmcp" +license = { workspace = true } +version = { workspace = true } +edition = { workspace = true } +rust-version = { workspace = true } +repository = { workspace = true } +homepage = { workspace = true } +readme = { workspace = true } +description = "Rust SDK for Model Context Protocol" +documentation = "https://docs.rs/rmcp" + +[lints.clippy] +exhaustive_structs = "warn" +exhaustive_enums = "warn" + +[package.metadata.docs.rs] +features = [ + "auth", + "auth-client-credentials-jwt", + "auth-enterprise-managed", + "base64", + "client", + "client-side-sse", + "elicitation", + "macros", + "request-state", + "reqwest", + "reqwest-native-tls", + "reqwest-tls-no-provider", + "schemars", + "server", + "server-side-http", + "tower", + "transport-async-rw", + "transport-child-process", + "transport-io", + "transport-streamable-http-client", + "transport-streamable-http-client-reqwest", + "transport-streamable-http-client-unix-socket", + "transport-streamable-http-server", + "transport-streamable-http-server-session", + "transport-worker", + "uuid", +] +rustdoc-args = ["--cfg", "docsrs"] + +[dependencies] +async-trait = { version = "0.1.89", optional = true } +serde = { version = "1.0", features = ["derive", "rc"] } +serde_json = "1.0" +thiserror = "2" +tokio = { version = "1", features = ["sync", "macros", "rt", "time"] } +futures = "0.3" +indexmap = { version = "2", features = ["serde"] } +tracing = { version = "0.1" } +tokio-util = { version = "0.7" } +pin-project-lite = "0.2" +pastey = { version = "0.2.0", optional = true } +# oauth2 support +oauth2 = { version = "5.0", optional = true, default-features = false } +# JWT signing for client credentials (private_key_jwt) +jsonwebtoken = { version = "11", optional = true, features = ["aws_lc_rs"] } + +# for auto generate schema +schemars = { version = "1.0", optional = true, features = ["chrono04"] } + +# for image encoding +base64 = { version = "0.23", optional = true } + +# for SEP-2322 requestState integrity sealing (opt-in via the `request-state` feature) +hmac = { version = "0.13", optional = true } +sha2 = { version = "0.11", optional = true } +zeroize = { version = "1", optional = true } + +# for HTTP client +reqwest = { version = "0.13.2", default-features = false, features = [ + "json", + "stream", +], optional = true } + +sse-stream = { version = "0.2.4", optional = true } + +http = { version = "1", optional = true } +url = { version = "2.4", optional = true } + +# For tower compatibility +tower-service = { version = "0.3", optional = true } + +# for child process transport +process-wrap = { version = "10.0", features = ["tokio1"], optional = true } + +# for cross-platform executable path resolution +which = { version = "8", optional = true } + +# for ws transport +# tokio-tungstenite ={ version = "0.26", optional = true } + +# for http-server transport +rand = { version = "0.10", optional = true } +tokio-stream = { version = "0.1", optional = true } +uuid = { version = "1", features = ["v4"], optional = true } +http-body = { version = "1", optional = true } +http-body-util = { version = "0.1", optional = true } +bytes = { version = "1", optional = true } + +# for unix socket transport +hyper = { version = "1", features = ["client", "http1"], optional = true } +hyper-util = { version = "0.1", features = ["tokio"], optional = true } + +# macro +rmcp-macros = { workspace = true, optional = true } +[target.'cfg(not(all(target_family = "wasm", target_os = "unknown")))'.dependencies] +chrono = { version = "0.4.38", default-features = false, features = ["serde", "now"] } + +[target.'cfg(all(target_family = "wasm", target_os = "unknown"))'.dependencies] +chrono = { version = "0.4.38", default-features = false, features = [ + "serde", + "clock", + "std", + "oldtime", +] } + +[features] +default = ["base64", "macros", "server"] +local = ["rmcp-macros?/local"] +client = ["dep:tokio-stream"] +server = ["transport-async-rw", "schemars", "dep:pastey", "uuid"] +macros = ["dep:rmcp-macros", "dep:pastey"] +elicitation = ["dep:url"] + +# SEP-2322 requestState integrity helper (HMAC-SHA256 seal/open codec) +request-state = ["dep:hmac", "dep:sha2", "dep:zeroize", "base64"] + +# reqwest http client +__reqwest = ["dep:reqwest"] + +reqwest = ["__reqwest", "reqwest?/rustls"] + +reqwest-tls-no-provider = ["__reqwest", "reqwest?/rustls-no-provider"] + +reqwest-native-tls = ["__reqwest", "reqwest?/native-tls"] + +server-side-http = [ + "uuid", + "dep:rand", + "dep:tokio-stream", + "dep:http", + "dep:http-body", + "dep:http-body-util", + "dep:bytes", + "dep:sse-stream", + "tower", + "base64", +] + +transport-worker = ["dep:tokio-stream"] + +# SSE stream parsing utilities (used by streamable HTTP client for SSE-formatted responses) +client-side-sse = ["dep:sse-stream", "dep:http", "dep:bytes", "base64"] + +# Streamable HTTP client +transport-streamable-http-client = ["client-side-sse", "transport-worker"] +transport-streamable-http-client-reqwest = ["transport-streamable-http-client", "__reqwest"] +transport-streamable-http-client-unix-socket = [ + "transport-streamable-http-client", + "dep:hyper", + "dep:hyper-util", + "dep:http-body-util", + "dep:http", + "dep:bytes", + "tokio/net", +] + +transport-async-rw = ["tokio/io-util", "tokio-util/codec"] +transport-io = ["transport-async-rw", "tokio/io-std"] +transport-child-process = [ + "transport-async-rw", + "tokio/process", + "dep:process-wrap", +] +which-command = [ + "transport-child-process", + "dep:which", +] +transport-streamable-http-server = [ + "transport-streamable-http-server-session", + "server-side-http", + "transport-worker", +] +transport-streamable-http-server-session = [ + "transport-async-rw", + "dep:async-trait", + "dep:tokio-stream", +] +# transport-ws = ["transport-io", "dep:tokio-tungstenite"] +tower = ["dep:tower-service"] +auth = ["dep:async-trait", "dep:oauth2", "__reqwest", "dep:url"] +auth-client-credentials-jwt = ["auth", "dep:jsonwebtoken", "uuid"] +auth-enterprise-managed = ["auth", "base64"] +schemars = ["dep:schemars"] + +[dev-dependencies] +tokio = { version = "1", features = ["full", "test-util"] } +schemars = { version = "1.1.0", features = ["chrono04"] } +axum = { version = "0.8", default-features = false, features = ["http1", "tokio"] } +hyper = { version = "1", features = ["server", "http1"] } +hyper-util = { version = "0.1", features = ["tokio"] } +tower-service = "0.3" +url = "2.4" +anyhow = "1.0" +tracing-subscriber = { version = "0.3", features = [ + "env-filter", + "std", + "fmt", +] } +async-trait = "0.1" +rstest = "0.27.0" +# Cargo unifies this feature into rmcp whenever any crate in a build enables it, +# so the tests run with it on (see tests/test_deserialization.rs). +serde_json = { version = "1.0", features = ["arbitrary_precision"] } +[[test]] +name = "test_tool_macros" +required-features = ["server", "client"] +path = "tests/test_tool_macros.rs" + +[[test]] +name = "test_with_python" +required-features = [ + "reqwest", + "server", + "client", + "transport-child-process", +] +path = "tests/test_with_python.rs" + +[[test]] +name = "test_with_js" +required-features = [ + "server", + "client", + "transport-child-process", + "transport-streamable-http-server", + "transport-streamable-http-client", + "__reqwest", +] +path = "tests/test_with_js.rs" + +[[test]] +name = "test_local_client_handler" +required-features = ["client", "local"] +path = "tests/test_local_client_handler.rs" + +[[test]] +name = "test_notification" +required-features = ["server", "client"] +path = "tests/test_notification.rs" + +[[test]] +name = "test_logging" +required-features = ["server", "client"] +path = "tests/test_logging.rs" + +[[test]] +name = "test_message_protocol" +required-features = ["client"] +path = "tests/test_message_protocol.rs" + +[[test]] +name = "test_message_schema" +required-features = ["server", "client", "schemars"] +path = "tests/test_message_schema.rs" + +[[test]] +name = "test_progress_subscriber" +required-features = ["server", "client", "macros"] +path = "tests/test_progress_subscriber.rs" + +[[test]] +name = "test_request_timeout_progress" +required-features = ["server", "client", "macros"] +path = "tests/test_request_timeout_progress.rs" + +[[test]] +name = "test_elicitation" +required-features = ["elicitation", "client", "server"] +path = "tests/test_elicitation.rs" + +[[test]] +name = "test_task" +required-features = ["server", "client", "macros"] +path = "tests/test_task.rs" + +[[test]] +name = "test_streamable_http_priming" +required-features = ["server", "client", "transport-streamable-http-server", "reqwest"] +path = "tests/test_streamable_http_priming.rs" + +[[test]] +name = "test_streamable_http_json_response" +required-features = ["server", "client", "transport-streamable-http-server", "reqwest"] +path = "tests/test_streamable_http_json_response.rs" + +[[test]] +name = "test_streamable_http_client_concurrency" +required-features = ["client", "transport-streamable-http-client"] +path = "tests/test_streamable_http_client_concurrency.rs" + +[[test]] +name = "test_streamable_http_protocol_version" +required-features = ["server", "client", "transport-streamable-http-server", "reqwest"] +path = "tests/test_streamable_http_protocol_version.rs" + +[[test]] +name = "test_stateless_protocol_version" +required-features = ["server", "transport-streamable-http-server", "reqwest"] +path = "tests/test_stateless_protocol_version.rs" + +[[test]] +name = "test_protocol_version_negotiation" +required-features = ["server", "client"] +path = "tests/test_protocol_version_negotiation.rs" + +[[test]] +name = "test_client_lifecycle_modes" +required-features = ["client", "server"] +path = "tests/test_client_lifecycle_modes.rs" + +[[test]] +name = "test_stateless_server_requests" +required-features = ["client", "server"] +path = "tests/test_stateless_server_requests.rs" + +[[test]] +name = "test_discover_http_client_startup" +required-features = [ + "client", + "reqwest", + "transport-streamable-http-client-reqwest", + "transport-streamable-http-server", +] +path = "tests/test_discover_http_client_startup.rs" + +[[test]] +name = "test_streamable_http_standard_headers" +required-features = ["server", "client", "transport-streamable-http-server", "reqwest"] +path = "tests/test_streamable_http_standard_headers.rs" + +[[test]] +name = "test_streamable_http_4xx_error_body" +required-features = ["transport-streamable-http-client", "transport-streamable-http-client-reqwest"] +path = "tests/test_streamable_http_4xx_error_body.rs" + +[[test]] +name = "test_streamable_http_malformed_json_request" +required-features = [ + "client", + "transport-streamable-http-client", + "transport-streamable-http-client-reqwest", +] +path = "tests/test_streamable_http_malformed_json_request.rs" + + +[[test]] +name = "test_custom_request" +required-features = ["server", "client"] +path = "tests/test_custom_request.rs" + +[[test]] +name = "test_trace_context" +required-features = ["server", "client"] +path = "tests/test_trace_context.rs" + +[[test]] +name = "test_mrtr_behavior" +required-features = ["server", "client"] +path = "tests/test_mrtr_behavior.rs" + +[[test]] +name = "test_prompt_macros" +required-features = ["server", "client"] +path = "tests/test_prompt_macros.rs" + +[[test]] +name = "test_sampling" +required-features = ["server", "client"] +path = "tests/test_sampling.rs" + + +[[test]] +name = "test_close_connection" +required-features = ["server", "client"] +path = "tests/test_close_connection.rs" + +[[test]] +name = "test_custom_headers" +required-features = [ + "client", + "server", + "transport-streamable-http-client-reqwest", + "transport-streamable-http-server", +] +path = "tests/test_custom_headers.rs" + +[[test]] +name = "test_sse_concurrent_streams" +required-features = ["server", "client", "transport-streamable-http-server", "transport-streamable-http-client", "reqwest"] +path = "tests/test_sse_concurrent_streams.rs" + +[[test]] +name = "test_client_credentials" +required-features = ["auth"] +path = "tests/test_client_credentials.rs" + +[[test]] +name = "test_auth_error_classification" +required-features = ["auth", "client", "transport-streamable-http-client"] +path = "tests/test_auth_error_classification.rs" + +[[test]] +name = "test_unix_socket_transport" +required-features = [ + "client", + "server", + "transport-streamable-http-client-unix-socket", +] +path = "tests/test_unix_socket_transport.rs" + +[[test]] +name = "test_streamable_http_stale_session" +required-features = [ + "server", + "client", + "transport-streamable-http-server", + "transport-streamable-http-client", + "transport-streamable-http-client-reqwest" +] +path = "tests/test_streamable_http_stale_session.rs" + +[[test]] +name = "test_streamable_http_session_store" +required-features = [ + "client", + "server", + "transport-streamable-http-client-reqwest", + "transport-streamable-http-server", +] +path = "tests/test_streamable_http_session_store.rs" + +[[test]] +name = "test_streamable_http_event_store" +required-features = [ + "client", + "server", + "transport-streamable-http-client-reqwest", + "transport-streamable-http-server", +] +path = "tests/test_streamable_http_event_store.rs" + +[[test]] +name = "test_streamable_http_connection_reuse" +required-features = [ + "server", + "client", + "macros", + "schemars", + "transport-streamable-http-server", + "transport-streamable-http-client", + "transport-streamable-http-client-reqwest", +] +path = "tests/test_streamable_http_connection_reuse.rs" + +[[test]] +name = "test_streamable_http_disconnect_cancel" +required-features = [ + "server", + "transport-streamable-http-server", + "reqwest", +] +path = "tests/test_streamable_http_disconnect_cancel.rs" + +[[test]] +name = "test_sep_2260_stream_routing" +required-features = ["server", "elicitation", "transport-streamable-http-server", "reqwest"] +path = "tests/test_sep_2260_stream_routing.rs" diff --git a/vendor/rmcp/README.md b/vendor/rmcp/README.md new file mode 100644 index 00000000..f34469ef --- /dev/null +++ b/vendor/rmcp/README.md @@ -0,0 +1,71 @@ + + +
+ +# rmcp + +[![Crates.io](https://img.shields.io/crates/v/rmcp.svg)](https://crates.io/crates/rmcp) +[![Documentation](https://docs.rs/rmcp/badge.svg)](https://docs.rs/rmcp) + +
+ +The official Rust SDK for the [Model Context Protocol](https://modelcontextprotocol.io/specification/2026-07-28). Build MCP servers that expose tools, resources, and prompts to AI assistants — or build clients that connect to them. + +For **getting started**, **usage guides**, and **full MCP feature documentation** (resources, prompts, sampling, roots, logging, completions, subscriptions, etc.), see the [main README](../../README.md). + +## Feature Flags + +| Feature | Description | Default | +|---------|-------------|---------| +| `server` | Server functionality and the tool system | ✅ | +| `client` | Client functionality | | +| `macros` | `#[tool]` / `#[prompt]` macros (re-exports [`rmcp-macros`](../rmcp-macros)) | ✅ | +| `schemars` | JSON Schema generation for tool definitions | | +| `auth` | OAuth 2.0 authentication support | | +| `auth-enterprise-managed` | EMA/XAA refresh-token and ID-JAG exchanges for registered public and confidential clients (includes `auth`) | | +| `elicitation` | Elicitation support | | + +### Transport features + +| Feature | Description | +|---------|-------------| +| `transport-io` | Server-side stdio transport | +| `transport-child-process` | Client-side stdio transport (spawns a child process) | +| `transport-async-rw` | Generic async read/write transport | +| `transport-streamable-http-client` | Streamable HTTP client (transport-agnostic) | +| `transport-streamable-http-client-reqwest` | Streamable HTTP client with default `reqwest` backend | +| `transport-streamable-http-server` | Streamable HTTP server transport | + +### TLS backend options (for HTTP transports) + +| Feature | Description | +|---------|-------------| +| `reqwest` | Uses rustls — pure Rust TLS (recommended default) | +| `reqwest-native-tls` | Uses platform-native TLS (OpenSSL / Secure Transport / SChannel) | +| `reqwest-tls-no-provider` | Uses rustls without a default crypto provider (bring your own) | + +For enterprise-managed authorization, enable `auth-enterprise-managed` and a TLS +backend such as `reqwest`. See the [EMA/XAA guide](../../docs/OAUTH_SUPPORT.md#enterprise-managed-authorization-emaxaa) +for client authentication and an MCP connection example. + +## Transports + +The transport layer is pluggable. Two built-in pairs cover the most common cases: + +| | Client | Server | +|:-:|:-:|:-:| +| **stdio** | [`TokioChildProcess`](crate::transport::TokioChildProcess) | [`stdio`](crate::transport::stdio) | +| **Streamable HTTP** | [`StreamableHttpClientTransport`](crate::transport::StreamableHttpClientTransport) | `StreamableHttpService` | + +Any type that implements the [`Transport`](crate::transport::Transport) trait can be used. The [`IntoTransport`](crate::transport::IntoTransport) helper trait provides automatic conversions from: + +1. `(Sink, Stream)` or a combined `Sink + Stream` +2. `(AsyncRead, AsyncWrite)` or a combined `AsyncRead + AsyncWrite` +3. A [`Worker`](crate::transport::worker::Worker) implementation +4. A [`Transport`](crate::transport::Transport) implementation directly + +## License + +This project is licensed under the terms specified in the repository's [LICENSE](../../LICENSE) file. diff --git a/vendor/rmcp/build.rs b/vendor/rmcp/build.rs new file mode 100644 index 00000000..05702b40 --- /dev/null +++ b/vendor/rmcp/build.rs @@ -0,0 +1,23 @@ +// Install git hooks on build +fn main() { + // Only run in the workspace root (not when building as a dependency) + let manifest_dir = std::env::var("CARGO_MANIFEST_DIR").unwrap(); + let workspace_root = std::path::Path::new(&manifest_dir) + .parent() + .and_then(|p| p.parent()); + + if let Some(root) = workspace_root { + let githooks_dir = root.join(".githooks"); + let git_dir = root.join(".git"); + + // Only configure if we're in the actual workspace (not a dependency) + // and git directory exists + if githooks_dir.exists() && git_dir.exists() { + // Configure git to use our hooks directory + let _ = std::process::Command::new("git") + .args(["config", "core.hooksPath", ".githooks"]) + .current_dir(root) + .output(); + } + } +} diff --git a/vendor/rmcp/src/error.rs b/vendor/rmcp/src/error.rs new file mode 100644 index 00000000..0940f29c --- /dev/null +++ b/vendor/rmcp/src/error.rs @@ -0,0 +1,72 @@ +use std::{borrow::Cow, fmt::Display}; + +pub use crate::model::ErrorData; +impl Display for ErrorData { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}: {}", self.code.0, self.message)?; + if let Some(data) = &self.data { + write!(f, "({})", data)?; + } + Ok(()) + } +} + +impl std::error::Error for ErrorData {} + +#[cfg(all(feature = "auth", any(feature = "client", feature = "server")))] +pub(crate) struct ErrorChain<'a>(pub(crate) &'a (dyn std::error::Error + 'static)); + +#[cfg(all(feature = "auth", any(feature = "client", feature = "server")))] +impl Display for ErrorChain<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.0)?; + for source in std::iter::successors(self.0.source(), |source| source.source()) { + write!(f, "\n Caused by: {source}")?; + } + Ok(()) + } +} + +/// This is an unified error type for the errors could be returned by the service. +#[derive(Debug, thiserror::Error)] +#[allow(clippy::large_enum_variant)] +#[non_exhaustive] +pub enum RmcpError { + #[cfg(any(feature = "client", feature = "server"))] + #[error("Service error: {0}")] + Service(#[from] crate::ServiceError), + #[cfg(feature = "client")] + #[error("Client initialization error: {0}")] + ClientInitialize(#[from] crate::service::ClientInitializeError), + #[cfg(feature = "server")] + #[error("Server initialization error: {0}")] + ServerInitialize(#[from] crate::service::ServerInitializeError), + #[error("Runtime error: {0}")] + Runtime(#[from] tokio::task::JoinError), + #[error("Transport creation error: {error}")] + // TODO: Maybe we can introduce something like `TryIntoTransport` to auto wrap transport type, + // but it could be an breaking change, so we could do it in the future. + TransportCreation { + into_transport_type_name: Cow<'static, str>, + into_transport_type_id: std::any::TypeId, + #[source] + error: Box, + }, + // and cancellation shouldn't be an error? + + // TODO: add more error variants as needed + #[error("Task error: {0}")] + TaskError(String), +} + +impl RmcpError { + pub fn transport_creation( + error: impl Into>, + ) -> Self { + RmcpError::TransportCreation { + into_transport_type_id: std::any::TypeId::of::(), + into_transport_type_name: std::any::type_name::().into(), + error: error.into(), + } + } +} diff --git a/vendor/rmcp/src/handler.rs b/vendor/rmcp/src/handler.rs new file mode 100644 index 00000000..6b848cd2 --- /dev/null +++ b/vendor/rmcp/src/handler.rs @@ -0,0 +1,4 @@ +#[cfg(feature = "client")] +pub mod client; +#[cfg(feature = "server")] +pub mod server; diff --git a/vendor/rmcp/src/handler/client.rs b/vendor/rmcp/src/handler/client.rs new file mode 100644 index 00000000..486fa3bd --- /dev/null +++ b/vendor/rmcp/src/handler/client.rs @@ -0,0 +1,433 @@ +// Sampling/Roots/Logging are SEP-2577-deprecated; internal references are expected. +#![expect(deprecated)] +pub mod progress; +use std::sync::Arc; + +use crate::{ + error::ErrorData as McpError, + model::*, + service::{ + MaybeSendFuture, NotificationContext, RequestContext, RoleClient, Service, ServiceRole, + }, +}; + +impl Service for H { + async fn handle_request( + &self, + request: ::PeerReq, + context: RequestContext, + ) -> Result<::Resp, McpError> { + match request { + ServerRequest::PingRequest(_) => self.ping(context).await.map(ClientResult::empty), + ServerRequest::CreateMessageRequest(request) => self + .create_message(request.params, context) + .await + .map(Box::new) + .map(ClientResult::CreateMessageResult), + ServerRequest::ListRootsRequest(_) => self + .list_roots(context) + .await + .map(ClientResult::ListRootsResult), + ServerRequest::ElicitRequest(request) => self + .create_elicitation(request.params, context) + .await + .map(ClientResult::ElicitResult), + ServerRequest::CustomRequest(request) => self + .on_custom_request(request, context) + .await + .map(ClientResult::CustomResult), + } + } + + async fn handle_notification( + &self, + notification: ::PeerNot, + context: NotificationContext, + ) -> Result<(), McpError> { + match notification { + ServerNotification::CancelledNotification(notification) => { + self.on_cancelled(notification.params, context).await + } + ServerNotification::ProgressNotification(notification) => { + self.on_progress(notification.params, context).await + } + ServerNotification::LoggingMessageNotification(notification) => { + self.on_logging_message(notification.params, context).await + } + ServerNotification::ResourceUpdatedNotification(notification) => { + self.on_resource_updated(notification.params, context).await + } + ServerNotification::ResourceListChangedNotification(_notification_no_param) => { + self.on_resource_list_changed(context).await + } + ServerNotification::ToolListChangedNotification(_notification_no_param) => { + self.on_tool_list_changed(context).await + } + ServerNotification::PromptListChangedNotification(_notification_no_param) => { + self.on_prompt_list_changed(context).await + } + ServerNotification::SubscriptionsAcknowledgedNotification(notification) => { + self.on_subscriptions_acknowledged(notification.params, context) + .await + } + ServerNotification::TaskStatusNotification(notification) => { + self.on_task_status(notification.params, context).await + } + ServerNotification::CustomNotification(notification) => { + self.on_custom_notification(notification, context).await + } + }; + Ok(()) + } + + fn get_info(&self) -> ::Info { + self.get_info() + } +} + +macro_rules! client_handler_methods { + () => { + fn ping( + &self, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + std::future::ready(Ok(())) + } + + fn create_message( + &self, + params: CreateMessageRequestParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + std::future::ready(Err( + McpError::method_not_found::(), + )) + } + + fn list_roots( + &self, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + std::future::ready(Ok(ListRootsResult::default())) + } + + /// Handle an elicitation request from a server asking for user input. + /// + /// This method is called when a server needs interactive input from the user + /// during tool execution. Implementations should present the message to the user, + /// collect their input according to the requested schema, and return the result. + /// + /// # Arguments + /// * `request` - The elicitation request with message and schema + /// * `context` - The request context + /// + /// # Returns + /// The user's response including action (accept/decline/cancel) and optional data + /// + /// # Default Behavior + /// The default implementation automatically declines all elicitation requests. + /// Real clients should override this to provide user interaction. + /// + /// # Example + /// ```rust,no_run + /// use rmcp::{ + /// ClientHandler, + /// model::{ + /// ElicitRequestParams, ElicitResult, ElicitationAction, ElicitationSchema, + /// ErrorData as McpError, + /// }, + /// service::{RequestContext, RoleClient}, + /// }; + /// + /// # struct MyClient; + /// # + /// # async fn get_user_input( + /// # _message: String, + /// # _schema: ElicitationSchema, + /// # ) -> Result { + /// # std::future::pending().await + /// # } + /// # + /// # async fn open_url_in_browser(_url: String) -> Result<(), McpError> { + /// # Ok(()) + /// # } + /// # + /// impl ClientHandler for MyClient { + /// async fn create_elicitation( + /// &self, + /// request: ElicitRequestParams, + /// _context: RequestContext, + /// ) -> Result { + /// match request { + /// ElicitRequestParams::FormElicitationParams { + /// message, + /// requested_schema, + /// .. + /// } => { + /// let input = get_user_input(message, requested_schema).await?; + /// Ok(ElicitResult::new(ElicitationAction::Accept).with_content(input)) + /// } + /// ElicitRequestParams::UrlElicitationParams { url, .. } => { + /// open_url_in_browser(url).await?; + /// Ok(ElicitResult::new(ElicitationAction::Accept)) + /// } + /// _ => Ok(ElicitResult::new(ElicitationAction::Decline)), + /// } + /// } + /// } + /// ``` + fn create_elicitation( + &self, + request: ElicitRequestParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + // Default implementation declines all requests - real clients should override this + let _ = (request, context); + std::future::ready(Ok(ElicitResult { + action: ElicitationAction::Decline, + content: None, + meta: None, + })) + } + + fn on_custom_request( + &self, + request: CustomRequest, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + let CustomRequest { method, .. } = request; + let _ = context; + std::future::ready(Err(McpError::new( + ErrorCode::METHOD_NOT_FOUND, + method, + None, + ))) + } + + fn on_cancelled( + &self, + params: CancelledNotificationParam, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + std::future::ready(()) + } + fn on_progress( + &self, + params: ProgressNotificationParam, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + std::future::ready(()) + } + fn on_logging_message( + &self, + params: LoggingMessageNotificationParam, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + std::future::ready(()) + } + fn on_resource_updated( + &self, + params: ResourceUpdatedNotificationParam, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + std::future::ready(()) + } + fn on_resource_list_changed( + &self, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + std::future::ready(()) + } + fn on_tool_list_changed( + &self, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + std::future::ready(()) + } + fn on_prompt_list_changed( + &self, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + std::future::ready(()) + } + fn on_subscriptions_acknowledged( + &self, + params: SubscriptionsAcknowledgedNotificationParams, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + std::future::ready(()) + } + + fn on_task_status( + &self, + params: TaskStatusNotificationParams, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + std::future::ready(()) + } + fn on_custom_notification( + &self, + notification: CustomNotification, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + let _ = (notification, context); + std::future::ready(()) + } + + fn get_info(&self) -> ClientConfig { + ClientConfig::default() + } + }; +} + +#[allow(unused_variables)] +#[cfg(not(feature = "local"))] +pub trait ClientHandler: Sized + Send + Sync + 'static { + client_handler_methods!(); +} + +#[allow(unused_variables)] +#[cfg(feature = "local")] +pub trait ClientHandler: Sized + 'static { + client_handler_methods!(); +} + +/// Do nothing, with the default client config. +impl ClientHandler for () {} + +/// Do nothing, with a specific client config. +impl ClientHandler for ClientConfig { + fn get_info(&self) -> ClientConfig { + self.clone() + } +} + +macro_rules! impl_client_handler_for_wrapper { + ($wrapper:ident) => { + impl ClientHandler for $wrapper { + fn ping( + &self, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + (**self).ping(context) + } + + fn create_message( + &self, + params: CreateMessageRequestParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ + { + (**self).create_message(params, context) + } + + fn list_roots( + &self, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ + { + (**self).list_roots(context) + } + + fn create_elicitation( + &self, + request: ElicitRequestParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + (**self).create_elicitation(request, context) + } + + fn on_custom_request( + &self, + request: CustomRequest, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + (**self).on_custom_request(request, context) + } + + fn on_cancelled( + &self, + params: CancelledNotificationParam, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + (**self).on_cancelled(params, context) + } + + fn on_progress( + &self, + params: ProgressNotificationParam, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + (**self).on_progress(params, context) + } + + fn on_logging_message( + &self, + params: LoggingMessageNotificationParam, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + (**self).on_logging_message(params, context) + } + + fn on_resource_updated( + &self, + params: ResourceUpdatedNotificationParam, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + (**self).on_resource_updated(params, context) + } + + fn on_resource_list_changed( + &self, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + (**self).on_resource_list_changed(context) + } + + fn on_tool_list_changed( + &self, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + (**self).on_tool_list_changed(context) + } + + fn on_prompt_list_changed( + &self, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + (**self).on_prompt_list_changed(context) + } + + fn on_subscriptions_acknowledged( + &self, + params: SubscriptionsAcknowledgedNotificationParams, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + (**self).on_subscriptions_acknowledged(params, context) + } + + fn on_task_status( + &self, + params: TaskStatusNotificationParams, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + (**self).on_task_status(params, context) + } + + fn on_custom_notification( + &self, + notification: CustomNotification, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + (**self).on_custom_notification(notification, context) + } + + fn get_info(&self) -> ClientConfig { + (**self).get_info() + } + } + }; +} + +impl_client_handler_for_wrapper!(Box); +impl_client_handler_for_wrapper!(Arc); diff --git a/vendor/rmcp/src/handler/client/progress.rs b/vendor/rmcp/src/handler/client/progress.rs new file mode 100644 index 00000000..04f31610 --- /dev/null +++ b/vendor/rmcp/src/handler/client/progress.rs @@ -0,0 +1,100 @@ +use std::{collections::HashMap, sync::Arc}; + +use futures::{Stream, StreamExt}; +use tokio::sync::RwLock; +use tokio_stream::wrappers::ReceiverStream; + +use crate::model::{ProgressNotificationParam, ProgressToken}; +type Dispatcher = + Arc>>>; + +/// A dispatcher for progress notifications. +#[derive(Debug, Clone, Default)] +pub struct ProgressDispatcher { + pub(crate) dispatcher: Dispatcher, +} + +impl ProgressDispatcher { + const CHANNEL_SIZE: usize = 16; + pub fn new() -> Self { + Self::default() + } + + /// Handle a progress notification by sending it to the appropriate subscriber + pub async fn handle_notification(&self, notification: ProgressNotificationParam) { + let token = ¬ification.progress_token; + if let Some(sender) = self.dispatcher.read().await.get(token).cloned() { + let send_result = sender.send(notification).await; + if let Err(e) = send_result { + tracing::warn!("Failed to send progress notification: {e}"); + } + } + } + + /// Subscribe to progress notifications for a specific token. + /// + /// If you drop the returned `ProgressSubscriber`, it will automatically unsubscribe from notifications for that token. + pub async fn subscribe(&self, progress_token: ProgressToken) -> ProgressSubscriber { + let (sender, receiver) = tokio::sync::mpsc::channel(Self::CHANNEL_SIZE); + self.dispatcher + .write() + .await + .insert(progress_token.clone(), sender); + let receiver = ReceiverStream::new(receiver); + ProgressSubscriber { + progress_token, + receiver, + dispatcher: self.dispatcher.clone(), + } + } + + /// Unsubscribe from progress notifications for a specific token. + pub async fn unsubscribe(&self, token: &ProgressToken) { + self.dispatcher.write().await.remove(token); + } + + /// Clear all dispatcher. + pub async fn clear(&self) { + let mut dispatcher = self.dispatcher.write().await; + dispatcher.clear(); + } +} + +pub struct ProgressSubscriber { + pub(crate) progress_token: ProgressToken, + pub(crate) receiver: ReceiverStream, + pub(crate) dispatcher: Dispatcher, +} + +impl ProgressSubscriber { + pub fn progress_token(&self) -> &ProgressToken { + &self.progress_token + } +} + +impl Stream for ProgressSubscriber { + type Item = ProgressNotificationParam; + + fn poll_next( + mut self: std::pin::Pin<&mut Self>, + cx: &mut std::task::Context<'_>, + ) -> std::task::Poll> { + self.receiver.poll_next_unpin(cx) + } + + fn size_hint(&self) -> (usize, Option) { + self.receiver.size_hint() + } +} + +impl Drop for ProgressSubscriber { + fn drop(&mut self) { + let token = self.progress_token.clone(); + self.receiver.close(); + let dispatcher = self.dispatcher.clone(); + tokio::spawn(async move { + let mut dispatcher = dispatcher.write_owned().await; + dispatcher.remove(&token); + }); + } +} diff --git a/vendor/rmcp/src/handler/server.rs b/vendor/rmcp/src/handler/server.rs new file mode 100644 index 00000000..f8467245 --- /dev/null +++ b/vendor/rmcp/src/handler/server.rs @@ -0,0 +1,874 @@ +// Sampling/Roots/Logging are SEP-2577-deprecated; internal references are expected. +#![expect(deprecated)] +use std::{borrow::Cow, sync::Arc}; + +use crate::{ + error::ErrorData as McpError, + model::*, + service::{ + MaybeSendFuture, NotificationContext, RequestContext, RoleServer, Service, ServiceRole, + SubscriptionContext, negotiate_protocol_version, uses_legacy_lifecycle, + }, +}; + +pub mod common; +pub mod prompt; +mod resource; +pub mod router; +pub mod tool; +pub mod tool_name_validation; +pub mod wrapper; + +/// SEP-2663: gate `tasks/*` methods on the client's declared tasks-extension +/// capability. +/// +/// - If the server does not advertise the tasks extension, the methods are +/// simply unimplemented: `-32601` Method not found. +/// - If the server advertises it but the client did not declare it (either in +/// the request's `_meta` per-request capabilities or, for session-mode +/// peers, at `initialize` time), the spec requires `-32021` Missing +/// Required Client Capability with the required capability in `data`. +fn validate_tasks_capability( + handler: &H, + context: &RequestContext, +) -> Result<(), McpError> { + if !handler.get_info().capabilities.supports_tasks() { + return Err(McpError::method_not_found::()); + } + let client_declared = context + .client_capabilities() + .is_some_and(|caps| caps.supports_tasks()); + if client_declared { + Ok(()) + } else { + Err(McpError::missing_required_client_capability( + ClientCapabilities::builder().enable_tasks().build(), + )) + } +} + +impl Service for H { + async fn handle_request( + &self, + request: ::PeerReq, + context: RequestContext, + ) -> Result<::Resp, McpError> { + // `context` is moved into the dispatch below, so read the negotiated version first. + let protocol_version = context.protocol_version(); + // SEP-2322 (`resultType` discriminator, MRTR) exists from 2026-07-28. + let sep_2322_supported = protocol_version + .as_ref() + .is_some_and(|v| v.as_str() >= ProtocolVersion::V_2026_07_28.as_str()); + let requested_version = context.meta.protocol_version(); + let uses_inline_negotiation = !matches!(&request, ClientRequest::InitializeRequest(_)); + if uses_inline_negotiation && let Some(requested_version) = requested_version.as_ref() { + let supported_versions = self.supported_protocol_versions(); + if !supported_versions.contains(requested_version) { + return Err(McpError::unsupported_protocol_version( + requested_version.clone(), + &supported_versions, + )); + } + } + // Self-contained metadata is required only when the request itself uses + // the inline lifecycle: a discover opener, a session that started without + // `initialize`, or a request that declares 2026-07-28+ in its own _meta. + // Sessions that negotiated via `initialize` (or `serve_directly`) keep the + // session model and may omit per-request metadata. + let requires_request_metadata = uses_inline_negotiation + && (matches!(&request, ClientRequest::DiscoverRequest(_)) + || context.peer.request_metadata_required() + || requested_version.as_ref().is_some_and(|version| { + version.as_str() >= ProtocolVersion::V_2026_07_28.as_str() + })); + if requires_request_metadata { + // Inline lifecycle requests are defined by the 2026-07-28 protocol. + // Validate that lifecycle contract even when a request selects an + // older application protocol version. + let missing = context + .meta + .missing_required_keys(&ProtocolVersion::V_2026_07_28); + if !missing.is_empty() { + return Err(McpError::invalid_params( + format!( + "request _meta is missing or has malformed required fields: {}", + missing.join(", ") + ), + None, + )); + } + } + let legacy_request = + uses_legacy_lifecycle(protocol_version.as_ref(), requires_request_metadata); + let result = match request { + ClientRequest::InitializeRequest(request) => self + .initialize(request.params, context) + .await + .map(ServerResult::InitializeResult), + ClientRequest::DiscoverRequest(_request) => self + .discover(context) + .await + .map(ServerResult::DiscoverResult), + ClientRequest::PingRequest(_request) => { + if !legacy_request { + Err(McpError::method_not_found::()) + } else { + self.ping(context).await.map(ServerResult::empty) + } + } + ClientRequest::CompleteRequest(request) => self + .complete(request.params, context) + .await + .map(ServerResult::CompleteResult), + ClientRequest::SetLevelRequest(request) => self + .set_level(request.params, context) + .await + .map(ServerResult::empty), + ClientRequest::GetPromptRequest(request) => self + .get_prompt(request.params, context) + .await + .map(ServerResult::from), + ClientRequest::ListPromptsRequest(request) => self + .list_prompts(request.params, context) + .await + .map(ServerResult::ListPromptsResult), + ClientRequest::ListResourcesRequest(request) => self + .list_resources(request.params, context) + .await + .map(ServerResult::ListResourcesResult), + ClientRequest::ListResourceTemplatesRequest(request) => self + .list_resource_templates(request.params, context) + .await + .map(ServerResult::ListResourceTemplatesResult), + ClientRequest::ReadResourceRequest(request) => self + .read_resource(request.params, context) + .await + .map(ServerResult::from), + ClientRequest::SubscriptionsListenRequest(request) => { + if legacy_request { + Err(McpError::method_not_found::()) + } else { + let requested = request.params.notifications; + let Some(candidate) = self.accepted_subscription_filter(&requested) else { + return Err( + McpError::method_not_found::(), + ); + }; + let server_info = self.get_info(); + let advertised = requested.supported_by(&server_info.capabilities); + let handler_accepted = requested.intersection(&candidate); + let accepted = handler_accepted.intersection(&advertised); + if accepted != handler_accepted { + tracing::debug!( + requested_resource_count = requested + .resource_subscriptions + .as_ref() + .map_or(0, Vec::len), + accepted_resource_count = + accepted.resource_subscriptions.as_ref().map_or(0, Vec::len), + "subscription filter reduced to advertised server capabilities" + ); + } + let server_implementation = server_info.server_info; + let subscription_id = context.id.clone(); + let subscription = + SubscriptionContext::establish(context, requested, accepted).await?; + // The 2026-07-28 schema defines a final result for graceful + // server teardown; explicit stdio cancellation remains a notification. + self.listen(subscription).await.map(|()| { + let mut result = SubscriptionsListenResult::complete(subscription_id); + result.meta.set_server_info(server_implementation); + ServerResult::SubscriptionsListenResult(result) + }) + } + } + ClientRequest::SubscribeRequest(request) => { + if !legacy_request { + Err(McpError::method_not_found::()) + } else { + self.subscribe(request.params, context) + .await + .map(ServerResult::empty) + } + } + ClientRequest::UnsubscribeRequest(request) => { + if !legacy_request { + Err(McpError::method_not_found::()) + } else { + self.unsubscribe(request.params, context) + .await + .map(ServerResult::empty) + } + } + ClientRequest::CallToolRequest(request) => { + let client_declared_tasks = context + .client_capabilities() + .is_some_and(|caps| caps.supports_tasks()); + let response = self.call_tool(request.params, context).await?; + // SEP-2663: the server MUST NOT return CreateTaskResult unless + // the request declared the tasks extension capability. Guard + // against handlers that fail to check before materializing a + // task; such clients cannot parse a task handle. + if matches!(response, CallToolResponse::Task(_)) && !client_declared_tasks { + return Err(McpError::missing_required_client_capability( + ClientCapabilities::builder().enable_tasks().build(), + )); + } + Ok(ServerResult::from(response)) + } + ClientRequest::ListToolsRequest(request) => self + .list_tools(request.params, context) + .await + .map(ServerResult::ListToolsResult), + ClientRequest::CustomRequest(request) => self + .on_custom_request(request, context) + .await + .map(ServerResult::CustomResult), + ClientRequest::GetTaskRequest(request) => { + validate_tasks_capability::(self, &context)?; + self.get_task(request.params, context) + .await + .map(ServerResult::GetTaskResult) + } + ClientRequest::UpdateTaskRequest(request) => { + validate_tasks_capability::(self, &context)?; + self.update_task(request.params, context) + .await + .map(ServerResult::task_ack) + } + ClientRequest::CancelTaskRequest(request) => { + validate_tasks_capability::(self, &context)?; + self.cancel_task(request.params, context) + .await + .map(ServerResult::task_ack) + } + }; + let result = result.and_then(|mut result| { + if matches!(result, ServerResult::InputRequiredResult(_)) && !sep_2322_supported { + Err(McpError::invalid_request( + "InputRequiredResult requires negotiated protocol version 2026-07-28 or newer", + None, + )) + } else { + // Peers on protocol versions older than 2026-07-28 keep the + // legacy wire shape without `resultType: "complete"`. + if !sep_2322_supported { + result.strip_result_type_for_legacy_peer(); + } + Ok(result) + } + }); + + // SEP-2164: peers negotiating 2026-07-28+ get the standard INVALID_PARAMS code for + // resource-not-found; older peers keep RESOURCE_NOT_FOUND. ISO `YYYY-MM-DD` versions + // compare lexically the same as chronologically. + let use_invalid_params = + protocol_version.is_some_and(|v| v.as_str() >= ProtocolVersion::V_2026_07_28.as_str()); + result.map_err(|mut error| { + if use_invalid_params && error.code == ErrorCode::RESOURCE_NOT_FOUND { + error.code = ErrorCode::INVALID_PARAMS; + } + error + }) + } + + async fn handle_notification( + &self, + notification: ::PeerNot, + context: NotificationContext, + ) -> Result<(), McpError> { + match notification { + ClientNotification::CancelledNotification(notification) => { + self.on_cancelled(notification.params, context).await + } + ClientNotification::ProgressNotification(notification) => { + self.on_progress(notification.params, context).await + } + ClientNotification::InitializedNotification(_notification) => { + self.on_initialized(context).await + } + ClientNotification::RootsListChangedNotification(_notification) => { + self.on_roots_list_changed(context).await + } + ClientNotification::CustomNotification(notification) => { + self.on_custom_notification(notification, context).await + } + }; + Ok(()) + } + + fn get_info(&self) -> ::Info { + self.get_info() + } + + fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]> { + ServerHandler::supported_protocol_versions(self) + } +} + +macro_rules! server_handler_methods { + () => { + fn ping( + &self, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + std::future::ready(Ok(())) + } + // handle requests + fn initialize( + &self, + request: InitializeRequestParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + context.peer.set_peer_info(request.clone()); + std::future::ready(self.negotiate_initialize(&request)) + } + /// Build the `initialize` response for `request`, negotiating the + /// protocol version against [`Self::supported_protocol_versions`]. + /// + /// This is the whole body of the default [`Self::initialize`] minus its + /// `set_peer_info` side effect, so a server that overrides `initialize` + /// to add its own can call this instead of restating the negotiation + /// rule: + /// + /// ``` + /// use rmcp::{ + /// ErrorData as McpError, RoleServer, ServerHandler, + /// model::{InitializeRequestParams, InitializeResult, ServerConfig}, + /// service::RequestContext, + /// }; + /// + /// struct MyServer; + /// + /// impl ServerHandler for MyServer { + /// fn get_info(&self) -> ServerConfig { + /// ServerConfig::default() + /// } + /// + /// async fn initialize( + /// &self, + /// request: InitializeRequestParams, + /// context: RequestContext, + /// ) -> Result { + /// // ... record telemetry, register the peer, etc. + /// context.peer.set_peer_info(request.clone()); + /// self.negotiate_initialize(&request) + /// } + /// } + /// ``` + /// + /// # Errors + /// + /// Returns [`ErrorCode::UNSUPPORTED_PROTOCOL_VERSION`] when this server + /// supports no version that still has an `initialize` handshake. + /// + /// [`ErrorCode::UNSUPPORTED_PROTOCOL_VERSION`]: crate::model::ErrorCode::UNSUPPORTED_PROTOCOL_VERSION + fn negotiate_initialize( + &self, + request: &InitializeRequestParams, + ) -> Result { + let mut info = self.get_info(); + info.protocol_version = negotiate_protocol_version( + &request.protocol_version, + std::mem::take(&mut info.protocol_version), + &self.supported_protocol_versions(), + )?; + Ok(info) + } + /// Return the protocol versions supported by this server. + /// + /// Defaults to every version this SDK knows. Override it to narrow the + /// set to the revisions the server actually implements: the returned + /// list is advertised by [`Self::discover`], bounds what `initialize` + /// negotiation may agree to, and is what per-request versions are + /// validated against. + /// + /// To support everything up to some ceiling, use + /// [`ProtocolVersion::known_up_to`] rather than filtering + /// [`ProtocolVersion::KNOWN_VERSIONS`] by hand. + fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]> { + Cow::Borrowed(ProtocolVersion::KNOWN_VERSIONS) + } + /// Return this server's discovery information. + fn discover( + &self, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + std::future::ready(Ok(DiscoverResult::from_server_info( + self.supported_protocol_versions().into_owned(), + self.get_info(), + ))) + } + fn complete( + &self, + request: CompleteRequestParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + std::future::ready(Ok(CompleteResult::default())) + } + fn set_level( + &self, + request: SetLevelRequestParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + std::future::ready(Err(McpError::method_not_found::())) + } + fn get_prompt( + &self, + request: GetPromptRequestParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + std::future::ready(Err(McpError::method_not_found::())) + } + fn list_prompts( + &self, + request: Option, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + std::future::ready(Ok(ListPromptsResult::default())) + } + fn list_resources( + &self, + request: Option, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + std::future::ready(Ok(ListResourcesResult::default())) + } + fn list_resource_templates( + &self, + request: Option, + context: RequestContext, + ) -> impl Future> + + MaybeSendFuture + + '_ { + std::future::ready(Ok(ListResourceTemplatesResult::default())) + } + fn read_resource( + &self, + request: ReadResourceRequestParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + std::future::ready(Err( + McpError::method_not_found::(), + )) + } + /// Return the subset of a requested notification filter this server accepts. + /// + /// Returning `None` leaves `subscriptions/listen` unimplemented. The SDK + /// intersects the returned filter with both `requested` and the notification + /// capabilities advertised by [`Self::get_info`] before acknowledging it. + /// Categories that were not requested or advertised are always removed. + fn accepted_subscription_filter( + &self, + requested: &SubscriptionFilter, + ) -> Option { + None + } + /// Run one established subscription until it is cancelled or closed gracefully. + /// + /// The SDK sends the acknowledgment before invoking this method. Returning + /// `Ok(())` sends the final [`SubscriptionsListenResult`] defined by the + /// 2026-07-28 schema, marking graceful server teardown. Explicit + /// stdio cancellation uses `notifications/cancelled` instead. + fn listen( + &self, + context: SubscriptionContext, + ) -> impl Future> + MaybeSendFuture + '_ { + async move { + context.cancelled().await; + Ok(()) + } + } + #[deprecated( + note = "resources/subscribe is legacy-only; implement accepted_subscription_filter and listen for protocol version 2026-07-28" + )] + fn subscribe( + &self, + request: SubscribeRequestParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + std::future::ready(Err(McpError::method_not_found::())) + } + #[deprecated( + note = "resources/unsubscribe is legacy-only; subscriptions/listen is cancelled through its request lifecycle" + )] + fn unsubscribe( + &self, + request: UnsubscribeRequestParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + std::future::ready(Err( + McpError::method_not_found::(), + )) + } + /// Handle a `tools/call` request from a client. + /// + /// # Choosing a return value + /// + /// MCP distinguishes two failure modes; the API forces you to pick + /// the right one explicitly because they reach the caller's UI very + /// differently: + /// + /// - `Ok(`[`CallToolResult::error`]`(...))` — the tool ran (or tried + /// to) and produced a failure the caller should see. The + /// `content` you supply is rendered in the caller's MCP client, + /// so the user gets your message. **This is the right return + /// value for almost every "the tool didn't work" path** — empty + /// results, validation failures the user can fix, downstream + /// service unavailability, etc. + /// + /// - `Err(`[`McpError`]`)` — a JSON-RPC protocol error. Use this + /// only when the request itself is unroutable: unknown tool + /// ([`ErrorCode::METHOD_NOT_FOUND`]), malformed request shape that + /// cannot be treated as a valid `tools/call`, or a server-internal + /// failure that means the server cannot serve any request right now + /// ([`ErrorCode::INTERNAL_ERROR`], `-32603`). MCP clients + /// typically render protocol errors opaquely; **the caller will + /// not see your message** — they see something like "Tool result + /// missing due to internal error". If you want the caller to read + /// your error, use `Ok(CallToolResult::error(...))`. + /// + /// See [`CallToolResult::error`] for a worked example. + fn call_tool( + &self, + request: CallToolRequestParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + std::future::ready(Err(McpError::method_not_found::())) + } + fn list_tools( + &self, + request: Option, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + std::future::ready(Ok(ListToolsResult::default())) + } + /// Get a tool definition by name. + /// + /// The default implementation returns `None`, which bypasses validation. + /// When using `#[tool_handler]`, this method is automatically implemented. + fn get_tool(&self, _name: &str) -> Option { + None + } + fn on_custom_request( + &self, + request: CustomRequest, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + let CustomRequest { method, .. } = request; + let _ = context; + std::future::ready(Err(McpError::new( + ErrorCode::METHOD_NOT_FOUND, + method, + None, + ))) + } + + fn on_cancelled( + &self, + notification: CancelledNotificationParam, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + std::future::ready(()) + } + fn on_progress( + &self, + notification: ProgressNotificationParam, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + std::future::ready(()) + } + fn on_initialized( + &self, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + tracing::info!("client initialized"); + std::future::ready(()) + } + fn on_roots_list_changed( + &self, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + std::future::ready(()) + } + fn on_custom_notification( + &self, + notification: CustomNotification, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + let _ = (notification, context); + std::future::ready(()) + } + + fn get_info(&self) -> ServerConfig { + ServerConfig::default() + } + + /// SEP-2663 `tasks/get`: return the current [`DetailedTask`] state. + fn get_task( + &self, + request: GetTaskParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + let _ = (request, context); + std::future::ready(Err(McpError::method_not_found::())) + } + + /// SEP-2663 `tasks/update`: accept responses to outstanding in-task + /// input requests. Returns an empty acknowledgement on success. + fn update_task( + &self, + request: UpdateTaskParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + let _ = (request, context); + std::future::ready(Err(McpError::method_not_found::())) + } + + /// SEP-2663 `tasks/cancel`: cooperative cancellation. Returns an empty + /// acknowledgement; the task's observable status may lag. + fn cancel_task( + &self, + request: CancelTaskParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + let _ = (request, context); + std::future::ready(Err(McpError::method_not_found::())) + } + }; +} + +#[allow(unused_variables)] +#[cfg(not(feature = "local"))] +pub trait ServerHandler: Sized + Send + Sync + 'static { + server_handler_methods!(); +} + +#[allow(unused_variables)] +#[cfg(feature = "local")] +pub trait ServerHandler: Sized + 'static { + server_handler_methods!(); +} + +macro_rules! impl_server_handler_for_wrapper { + ($wrapper:ident) => { + impl ServerHandler for $wrapper { + fn ping( + &self, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + (**self).ping(context) + } + + fn initialize( + &self, + request: InitializeRequestParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + (**self).initialize(request, context) + } + + fn negotiate_initialize( + &self, + request: &InitializeRequestParams, + ) -> Result { + (**self).negotiate_initialize(request) + } + + fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]> { + (**self).supported_protocol_versions() + } + + fn discover( + &self, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + (**self).discover(context) + } + + fn complete( + &self, + request: CompleteRequestParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + (**self).complete(request, context) + } + + fn set_level( + &self, + request: SetLevelRequestParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + (**self).set_level(request, context) + } + + fn get_prompt( + &self, + request: GetPromptRequestParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + (**self).get_prompt(request, context) + } + + fn list_prompts( + &self, + request: Option, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + (**self).list_prompts(request, context) + } + + fn list_resources( + &self, + request: Option, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + (**self).list_resources(request, context) + } + + fn list_resource_templates( + &self, + request: Option, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ + { + (**self).list_resource_templates(request, context) + } + + fn read_resource( + &self, + request: ReadResourceRequestParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + (**self).read_resource(request, context) + } + + fn accepted_subscription_filter( + &self, + requested: &SubscriptionFilter, + ) -> Option { + (**self).accepted_subscription_filter(requested) + } + + fn listen( + &self, + context: SubscriptionContext, + ) -> impl Future> + MaybeSendFuture + '_ { + (**self).listen(context) + } + + fn subscribe( + &self, + request: SubscribeRequestParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + (**self).subscribe(request, context) + } + + fn unsubscribe( + &self, + request: UnsubscribeRequestParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + (**self).unsubscribe(request, context) + } + + fn call_tool( + &self, + request: CallToolRequestParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + (**self).call_tool(request, context) + } + + fn list_tools( + &self, + request: Option, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + (**self).list_tools(request, context) + } + + fn get_tool(&self, name: &str) -> Option { + (**self).get_tool(name) + } + + fn on_custom_request( + &self, + request: CustomRequest, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + (**self).on_custom_request(request, context) + } + + fn on_cancelled( + &self, + notification: CancelledNotificationParam, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + (**self).on_cancelled(notification, context) + } + + fn on_progress( + &self, + notification: ProgressNotificationParam, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + (**self).on_progress(notification, context) + } + + fn on_initialized( + &self, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + (**self).on_initialized(context) + } + + fn on_roots_list_changed( + &self, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + (**self).on_roots_list_changed(context) + } + + fn on_custom_notification( + &self, + notification: CustomNotification, + context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + (**self).on_custom_notification(notification, context) + } + + fn get_info(&self) -> ServerConfig { + (**self).get_info() + } + + fn get_task( + &self, + request: GetTaskParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + (**self).get_task(request, context) + } + + fn update_task( + &self, + request: UpdateTaskParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + (**self).update_task(request, context) + } + + fn cancel_task( + &self, + request: CancelTaskParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + (**self).cancel_task(request, context) + } + } + }; +} + +impl_server_handler_for_wrapper!(Box); +impl_server_handler_for_wrapper!(Arc); diff --git a/vendor/rmcp/src/handler/server/common.rs b/vendor/rmcp/src/handler/server/common.rs new file mode 100644 index 00000000..8d3e4a8a --- /dev/null +++ b/vendor/rmcp/src/handler/server/common.rs @@ -0,0 +1,404 @@ +//! Common utilities shared between tool and prompt handlers + +use std::{ + any::TypeId, + collections::HashMap, + sync::{Arc, LazyLock}, +}; + +use schemars::JsonSchema; + +use crate::{ + RoleServer, model::JsonObject, schemars::generate::SchemaSettings, service::RequestContext, +}; + +/// Generates a JSON schema for a type +pub fn schema_for_type() -> Arc { + thread_local! { + static CACHE_FOR_TYPE: std::sync::RwLock>> = Default::default(); + }; + CACHE_FOR_TYPE.with(|cache| { + if let Some(x) = cache + .read() + .expect("schema cache lock poisoned") + .get(&TypeId::of::()) + { + x.clone() + } else { + // explicitly to align json schema version to official specifications. + // refer to https://github.com/modelcontextprotocol/modelcontextprotocol/pull/655 for details. + let settings = SchemaSettings::draft2020_12(); + // Note: AddNullable is intentionally NOT used here because the `nullable` keyword + // is an OpenAPI 3.0 extension, not part of JSON Schema 2020-12. Using it would + // cause validation failures with strict JSON Schema validators. + let generator = settings.into_generator(); + let schema = generator.into_root_schema_for::(); + let object = serde_json::to_value(schema).expect("failed to serialize schema"); + let serde_json::Value::Object(object) = object else { + panic!( + "Schema serialization produced non-object value: expected JSON object but got {object:?}" + ); + }; + let schema = Arc::new(object); + cache + .write() + .expect("schema cache lock poisoned") + .insert(TypeId::of::(), schema.clone()); + + schema + } + }) +} + +/// Validate that the schema root is `type: "object"` (per MCP spec) and strip top-level +/// `title`/`description` (the wrapper type name and doc, which are noise to the LLM). +fn validate_and_strip(raw: &Arc, purpose: &str) -> Result, String> { + match raw.get("type") { + Some(serde_json::Value::String(t)) if t == "object" => { + let mut object = raw.as_ref().clone(); + object.remove("title"); + object.remove("description"); + Ok(Arc::new(object)) + } + Some(serde_json::Value::String(t)) => Err(format!( + "MCP specification requires tool {purpose} to have root type 'object', but found '{t}'." + )), + None => Err(format!( + "Schema is missing 'type' field. MCP specification requires {purpose} to have root type 'object'." + )), + Some(other) => Err(format!( + "Schema 'type' field has unexpected format: {other:?}. Expected \"object\"." + )), + } +} + +/// Generate, validate, and strip a JSON schema for inputSchema (must have root type "object"; +/// top-level "title" and "description" are removed). +pub fn schema_for_input() -> Result, String> { + thread_local! { + static CACHE_FOR_INPUT: std::sync::RwLock, String>>> = Default::default(); + }; + CACHE_FOR_INPUT.with(|cache| { + if let Some(result) = cache + .read() + .expect("input schema cache lock poisoned") + .get(&TypeId::of::()) + { + return result.clone(); + } + let result = validate_and_strip(&schema_for_type::(), "inputSchema"); + cache + .write() + .expect("input schema cache lock poisoned") + .insert(TypeId::of::(), result.clone()); + result + }) +} + +/// Schema used when input is empty. +pub fn schema_for_empty_input() -> Arc { + static EMPTY: LazyLock> = LazyLock::new(|| { + let mut object = JsonObject::new(); + object.insert("type".into(), serde_json::json!("object")); + object.insert("properties".into(), serde_json::json!({})); + Arc::new(object) + }); + EMPTY.clone() +} + +/// Strip top-level `title` and `description` from a JSON schema for outputSchema. +/// Unlike `validate_and_strip`, this performs no validation — output schemas are not +/// restricted to `type: "object"` (per SEP-2106). +fn strip_output(raw: &Arc) -> Arc { + let mut object = raw.as_ref().clone(); + object.remove("title"); + object.remove("description"); + Arc::new(object) +} + +/// Generate and strip a JSON schema for outputSchema (top-level "title" and +/// "description" are removed; output schemas are not restricted to root type "object"). +pub fn schema_for_output() -> Arc { + thread_local! { + static CACHE_FOR_OUTPUT: std::sync::RwLock>> = Default::default(); + }; + + CACHE_FOR_OUTPUT.with(|cache| { + if let Some(schema) = cache + .read() + .expect("output schema cache lock poisoned") + .get(&TypeId::of::()) + { + return schema.clone(); + } + + let schema = strip_output(&schema_for_type::()); + + cache + .write() + .expect("output schema cache lock poisoned") + .insert(TypeId::of::(), schema.clone()); + + schema + }) +} + +/// Trait for extracting parts from a context, unifying tool and prompt extraction +pub trait FromContextPart: Sized { + fn from_context_part(context: &mut C) -> Result; +} + +/// Common extractors that can be used by both tool and prompt handlers +impl FromContextPart for RequestContext +where + C: AsRequestContext, +{ + fn from_context_part(context: &mut C) -> Result { + Ok(context.as_request_context().clone()) + } +} + +impl FromContextPart for tokio_util::sync::CancellationToken +where + C: AsRequestContext, +{ + fn from_context_part(context: &mut C) -> Result { + Ok(context.as_request_context().ct.clone()) + } +} + +impl FromContextPart for crate::model::Extensions +where + C: AsRequestContext, +{ + fn from_context_part(context: &mut C) -> Result { + Ok(context.as_request_context().extensions.clone()) + } +} + +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct Extension(pub T); + +impl FromContextPart for Extension +where + C: AsRequestContext, + T: Send + Sync + 'static + Clone, +{ + fn from_context_part(context: &mut C) -> Result { + let extension = context + .as_request_context() + .extensions + .get::() + .cloned() + .ok_or_else(|| { + crate::ErrorData::invalid_params( + format!("missing extension {}", std::any::type_name::()), + None, + ) + })?; + Ok(Extension(extension)) + } +} + +impl FromContextPart for crate::Peer +where + C: AsRequestContext, +{ + fn from_context_part(context: &mut C) -> Result { + Ok(context.as_request_context().peer.clone()) + } +} + +impl FromContextPart for crate::model::RequestMetaObject +where + C: AsRequestContext, +{ + fn from_context_part(context: &mut C) -> Result { + let request_context = context.as_request_context_mut(); + let mut meta = crate::model::RequestMetaObject::default(); + std::mem::swap(&mut meta, &mut request_context.meta); + Ok(meta) + } +} + +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct RequestId(pub crate::model::RequestId); + +impl FromContextPart for RequestId +where + C: AsRequestContext, +{ + fn from_context_part(context: &mut C) -> Result { + Ok(RequestId(context.as_request_context().id.clone())) + } +} + +/// Trait for types that can provide access to RequestContext +pub trait AsRequestContext { + fn as_request_context(&self) -> &RequestContext; + fn as_request_context_mut(&mut self) -> &mut RequestContext; +} + +#[cfg(test)] +mod tests { + use rstest::rstest; + + use super::*; + + #[derive(serde::Serialize, serde::Deserialize, JsonSchema)] + struct TestObject { + value: i32, + } + + #[derive(serde::Serialize, serde::Deserialize, JsonSchema)] + struct AnotherTestObject { + value: i32, + } + + #[rstest] + #[case::primitive(schema_for_type::, "integer")] + #[case::array(schema_for_type::>, "array")] + #[case::struct_object(schema_for_type::, "object")] + fn schema_for_type_sets_expected_root_type( + #[case] schema_fn: fn() -> Arc, + #[case] expected_type: &str, + ) { + let schema = schema_fn(); + + assert_eq!(schema.get("type"), Some(&serde_json::json!(expected_type))); + } + + #[test] + fn schema_for_type_sets_array_item_type() { + let schema = schema_for_type::>(); + let items = schema.get("items").and_then(|v| v.as_object()).unwrap(); + + assert_eq!(items.get("type"), Some(&serde_json::json!("integer"))); + } + + #[test] + fn schema_for_type_sets_struct_properties() { + let schema = schema_for_type::(); + let properties = schema + .get("properties") + .and_then(|v| v.as_object()) + .unwrap(); + + assert!(properties.contains_key("value")); + } + + #[rstest] + #[case::primitive(schema_for_type::)] + #[case::struct_object(schema_for_type::)] + fn test_schema_for_type_caches_schemas(#[case] schema_fn: fn() -> Arc) { + let schema1 = schema_fn(); + let schema2 = schema_fn(); + + assert!(Arc::ptr_eq(&schema1, &schema2)); + } + + #[test] + fn test_schema_for_type_different_types_different_schemas() { + let schema1 = schema_for_type::(); + let schema2 = schema_for_type::(); + + assert!(!Arc::ptr_eq(&schema1, &schema2)); + } + + #[test] + fn test_schema_for_type_arc_can_be_shared() { + let schema = schema_for_type::(); + let cloned = schema.clone(); + + assert!(Arc::ptr_eq(&schema, &cloned)); + } + + #[test] + fn test_schema_for_output_accepts_primitive() { + let schema = schema_for_output::(); + assert_eq!(schema.get("type"), Some(&serde_json::json!("integer"))); + } + + #[test] + fn test_schema_for_output_strips_description_for_primitive() { + let schema = schema_for_output::(); + assert!(!schema.contains_key("description")); + } + + #[test] + fn test_schema_for_output_accepts_composition() { + let schema = schema_for_output::>(); + let schema_str = serde_json::to_string(&schema).unwrap(); + assert!( + schema_str.contains("anyOf") + || schema_str.contains("oneOf") + || schema_str.contains("null"), + "Expected composition schema for Option, got: {schema_str}" + ); + } + + #[test] + fn test_schema_for_output_caches_result() { + let schema1 = schema_for_output::(); + let schema2 = schema_for_output::(); + assert!(Arc::ptr_eq(&schema1, &schema2)); + } + + #[test] + fn test_schema_for_input_rejects_array() { + let result = schema_for_input::>(); + assert!(result.is_err()); + } + + #[test] + fn test_schema_for_output_accepts_unit() { + let _schema = schema_for_output::<()>(); + } + + #[test] + fn test_schema_for_output_accepts_object() { + let schema = schema_for_output::(); + assert_eq!(schema.get("type"), Some(&serde_json::json!("object"))); + } + + #[test] + fn test_schema_for_output_strips_top_level_title() { + let schema = schema_for_output::(); + assert!(!schema.contains_key("title")); + } + + #[test] + fn test_schema_for_output_strips_top_level_description() { + let schema = schema_for_output::(); + assert!(!schema.contains_key("description")); + } + + #[rstest] + #[case::input(schema_for_input::)] + fn test_schema_for_input_rejects_primitives( + #[case] schema_fn: fn() -> Result, String>, + ) { + let result = schema_fn(); + assert!(result.is_err()); + } + + #[rstest] + #[case::input(schema_for_input::)] + fn test_schema_for_input_accepts_objects( + #[case] schema_fn: fn() -> Result, String>, + ) { + let result = schema_fn(); + assert!(result.is_ok()); + } + + #[rstest] + #[case::input_title(schema_for_input::, "title")] + #[case::input_description(schema_for_input::, "description")] + fn test_schema_for_input_strips_top_level_metadata( + #[case] schema_fn: fn() -> Result, String>, + #[case] field: &str, + ) { + let schema = schema_fn().unwrap(); + assert!(!schema.contains_key(field)); + } +} diff --git a/vendor/rmcp/src/handler/server/prompt.rs b/vendor/rmcp/src/handler/server/prompt.rs new file mode 100644 index 00000000..b5b3c469 --- /dev/null +++ b/vendor/rmcp/src/handler/server/prompt.rs @@ -0,0 +1,383 @@ +//! Prompt handling infrastructure for MCP servers +//! +//! This module provides the core types and traits for implementing prompt handlers +//! in MCP servers. Prompts allow servers to provide reusable templates for LLM +//! interactions with customizable arguments. + +use std::{future::Future, marker::PhantomData}; + +#[cfg(not(feature = "local"))] +use futures::future::BoxFuture; +use serde::de::DeserializeOwned; + +use super::common::{AsRequestContext, FromContextPart}; +pub use super::common::{Extension, RequestId}; +use crate::{ + RoleServer, + handler::server::wrapper::Parameters, + model::{GetPromptResponse, GetPromptResult, InputRequiredResult, PromptMessage}, + service::{MaybeBoxFuture, MaybeSend, MaybeSendFuture, RequestContext}, +}; + +/// Context for prompt retrieval operations +#[non_exhaustive] +pub struct PromptContext<'a, S> { + pub server: &'a S, + pub name: String, + pub arguments: Option>, + pub context: RequestContext, +} + +impl<'a, S> PromptContext<'a, S> { + pub fn new( + server: &'a S, + name: String, + arguments: Option>, + context: RequestContext, + ) -> Self { + Self { + server, + name, + arguments, + context, + } + } +} + +impl AsRequestContext for PromptContext<'_, S> { + fn as_request_context(&self) -> &RequestContext { + &self.context + } + + fn as_request_context_mut(&mut self) -> &mut RequestContext { + &mut self.context + } +} + +/// Trait for handling prompt retrieval +pub trait GetPromptHandler { + fn handle( + self, + context: PromptContext<'_, S>, + ) -> MaybeBoxFuture<'_, Result>; +} + +/// Type alias for dynamic prompt handlers +#[cfg(not(feature = "local"))] +pub type DynGetPromptHandler = dyn for<'a> Fn(PromptContext<'a, S>) -> BoxFuture<'a, Result> + + Send + + Sync; + +#[cfg(feature = "local")] +pub type DynGetPromptHandler = dyn for<'a> Fn( + PromptContext<'a, S>, +) -> futures::future::LocalBoxFuture< + 'a, + Result, +>; + +/// Adapter type for async methods that return `Vec` +pub struct AsyncMethodAdapter(PhantomData); + +/// Adapter type for async methods with parameters that return `Vec` +pub struct AsyncMethodWithArgsAdapter(PhantomData); + +/// Adapter types for macro-generated implementations +#[allow(clippy::type_complexity)] +pub struct AsyncPromptAdapter(PhantomData fn(Fut) -> R>); +pub struct SyncPromptAdapter(PhantomData R>); +pub struct AsyncPromptMethodAdapter(PhantomData R>); +pub struct SyncPromptMethodAdapter(PhantomData R>); + +/// Trait for types that can be converted into GetPromptResult +pub trait IntoGetPromptResult { + fn into_get_prompt_result(self) -> Result; +} + +impl IntoGetPromptResult for GetPromptResult { + fn into_get_prompt_result(self) -> Result { + Ok(self.into()) + } +} + +impl IntoGetPromptResult for InputRequiredResult { + fn into_get_prompt_result(self) -> Result { + Ok(self.into()) + } +} + +impl IntoGetPromptResult for Vec { + fn into_get_prompt_result(self) -> Result { + Ok(GetPromptResult::new(self).into()) + } +} + +impl IntoGetPromptResult for Result { + fn into_get_prompt_result(self) -> Result { + self.and_then(|v| v.into_get_prompt_result()) + } +} + +// Future wrapper that automatically handles IntoGetPromptResult conversion +pin_project_lite::pin_project! { + #[project = IntoGetPromptResultFutProj] + #[non_exhaustive] + pub enum IntoGetPromptResultFut { + Pending { + #[pin] + fut: F, + _marker: PhantomData, + }, + Ready { + #[pin] + result: futures::future::Ready>, + } + } +} + +impl Future for IntoGetPromptResultFut +where + F: Future, + R: IntoGetPromptResult, +{ + type Output = Result; + + fn poll( + self: std::pin::Pin<&mut Self>, + cx: &mut std::task::Context<'_>, + ) -> std::task::Poll { + match self.project() { + IntoGetPromptResultFutProj::Pending { fut, _marker } => fut + .poll(cx) + .map(IntoGetPromptResult::into_get_prompt_result), + IntoGetPromptResultFutProj::Ready { result } => result.poll(cx), + } + } +} + +// Prompt-specific extractor for prompt name +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct PromptName(pub String); + +impl FromContextPart> for PromptName { + fn from_context_part(context: &mut PromptContext) -> Result { + Ok(Self(context.name.clone())) + } +} + +// Special implementation for Parameters that handles prompt arguments +impl FromContextPart> for Parameters

+where + P: DeserializeOwned, +{ + fn from_context_part(context: &mut PromptContext) -> Result { + let params = if let Some(args_map) = context.arguments.take() { + let args_value = serde_json::Value::Object(args_map); + serde_json::from_value::

(args_value).map_err(|e| { + crate::ErrorData::invalid_params(format!("Failed to parse parameters: {}", e), None) + })? + } else { + // Try to deserialize from empty object for optional fields + serde_json::from_value::

(serde_json::json!({})).map_err(|e| { + crate::ErrorData::invalid_params( + format!("Missing required parameters: {}", e), + None, + ) + })? + }; + Ok(Parameters(params)) + } +} + +// Macro to generate GetPromptHandler implementations for various parameter combinations +macro_rules! impl_prompt_handler_for { + ($($T: ident)*) => { + impl_prompt_handler_for!([] [$($T)*]); + }; + // finished + ([$($Tn: ident)*] []) => { + impl_prompt_handler_for!(@impl $($Tn)*); + }; + ([$($Tn: ident)*] [$Tn_1: ident $($Rest: ident)*]) => { + impl_prompt_handler_for!(@impl $($Tn)*); + impl_prompt_handler_for!([$($Tn)* $Tn_1] [$($Rest)*]); + }; + (@impl $($Tn: ident)*) => { + // Implementation for async methods (transformed by #[prompt] macro) + impl<$($Tn,)* S, F, R> GetPromptHandler for F + where + $( + $Tn: for<'a> FromContextPart> + MaybeSendFuture, + )* + F: FnOnce(&S, $($Tn,)*) -> MaybeBoxFuture<'_, R> + MaybeSendFuture, + R: IntoGetPromptResult + MaybeSendFuture + 'static, + S: MaybeSend + 'static, + { + #[allow(unused_variables, non_snake_case, unused_mut)] + fn handle( + self, + mut context: PromptContext<'_, S>, + ) -> MaybeBoxFuture<'_, Result> + { + $( + let result = $Tn::from_context_part(&mut context); + let $Tn = match result { + Ok(value) => value, + Err(e) => return Box::pin(std::future::ready(Err(e))), + }; + )* + let service = context.server; + let fut = self(service, $($Tn,)*); + Box::pin(async move { + let result = fut.await; + result.into_get_prompt_result() + }) + } + } + + + // Implementation for sync methods + impl<$($Tn,)* S, F, R> GetPromptHandler> for F + where + $( + $Tn: for<'a> FromContextPart> + MaybeSendFuture, + )* + F: FnOnce(&S, $($Tn,)*) -> R + MaybeSendFuture, + R: IntoGetPromptResult + MaybeSendFuture, + S: MaybeSend, + { + #[allow(unused_variables, non_snake_case, unused_mut)] + fn handle( + self, + mut context: PromptContext<'_, S>, + ) -> MaybeBoxFuture<'_, Result> + { + $( + let result = $Tn::from_context_part(&mut context); + let $Tn = match result { + Ok(value) => value, + Err(e) => return Box::pin(std::future::ready(Err(e))), + }; + )* + let service = context.server; + let result = self(service, $($Tn,)*); + Box::pin(std::future::ready(result.into_get_prompt_result())) + } + } + + + // AsyncPromptAdapter - for standalone functions returning GetPromptResult + impl<$($Tn,)* S, F, Fut, R> GetPromptHandler> for F + where + $( + $Tn: for<'a> FromContextPart> + MaybeSendFuture + 'static, + )* + F: FnOnce($($Tn,)*) -> Fut + MaybeSendFuture + 'static, + Fut: Future> + MaybeSendFuture + 'static, + R: IntoGetPromptResult + MaybeSendFuture + 'static, + S: MaybeSend + 'static, + { + #[allow(unused_variables, non_snake_case, unused_mut)] + fn handle( + self, + mut context: PromptContext<'_, S>, + ) -> MaybeBoxFuture<'_, Result> + { + // Extract all parameters before moving into the async block + $( + let result = $Tn::from_context_part(&mut context); + let $Tn = match result { + Ok(value) => value, + Err(e) => return Box::pin(std::future::ready(Err(e))), + }; + )* + + // Since we're dealing with standalone functions that don't take &S, + // we can return a 'static future + Box::pin(async move { + let result = self($($Tn,)*).await?; + result.into_get_prompt_result() + }) + } + } + + + // SyncPromptAdapter - for standalone sync functions returning Result + impl<$($Tn,)* S, F, R> GetPromptHandler> for F + where + $( + $Tn: for<'a> FromContextPart> + MaybeSendFuture + 'static, + )* + F: FnOnce($($Tn,)*) -> Result + MaybeSendFuture + 'static, + R: IntoGetPromptResult + MaybeSendFuture + 'static, + S: MaybeSend, + { + #[allow(unused_variables, non_snake_case, unused_mut)] + fn handle( + self, + mut context: PromptContext<'_, S>, + ) -> MaybeBoxFuture<'_, Result> + { + $( + let result = $Tn::from_context_part(&mut context); + let $Tn = match result { + Ok(value) => value, + Err(e) => return Box::pin(std::future::ready(Err(e))), + }; + )* + let result = self($($Tn,)*); + Box::pin(std::future::ready(result.and_then(|r| r.into_get_prompt_result()))) + } + } + + }; +} + +// Invoke the macro to generate implementations for up to 16 parameters +impl_prompt_handler_for!(T0 T1 T2 T3 T4 T5 T6 T7 T8 T9 T10 T11 T12 T13 T14 T15); + +/// Extract prompt arguments from a type's JSON schema +/// This function analyzes the schema of a type and extracts the properties +/// as PromptArgument entries with name, description, and required status +pub fn cached_arguments_from_schema() +-> Option> { + let schema = super::common::schema_for_type::(); + let schema_value = serde_json::Value::Object((*schema).clone()); + + let properties = schema_value.get("properties").and_then(|p| p.as_object()); + + if let Some(props) = properties { + let required = schema_value + .get("required") + .and_then(|r| r.as_array()) + .map(|arr| { + arr.iter() + .filter_map(|v| v.as_str()) + .collect::>() + }) + .unwrap_or_default(); + + let mut arguments = Vec::new(); + for (name, prop_schema) in props { + let description = prop_schema + .get("description") + .and_then(|d| d.as_str()) + .map(|s| s.to_string()); + + arguments.push(crate::model::PromptArgument { + name: name.clone(), + title: None, + description, + required: Some(required.contains(name.as_str())), + }); + } + + if arguments.is_empty() { + None + } else { + Some(arguments) + } + } else { + None + } +} diff --git a/vendor/rmcp/src/handler/server/resource.rs b/vendor/rmcp/src/handler/server/resource.rs new file mode 100644 index 00000000..8b137891 --- /dev/null +++ b/vendor/rmcp/src/handler/server/resource.rs @@ -0,0 +1 @@ + diff --git a/vendor/rmcp/src/handler/server/router.rs b/vendor/rmcp/src/handler/server/router.rs new file mode 100644 index 00000000..c49c4089 --- /dev/null +++ b/vendor/rmcp/src/handler/server/router.rs @@ -0,0 +1,235 @@ +use std::{borrow::Cow, sync::Arc}; + +use prompt::{IntoPromptRoute, PromptRoute}; +use tool::{IntoToolRoute, ToolRoute}; + +use super::ServerHandler; +use crate::{ + RoleServer, Service, + model::{ + ClientNotification, ClientRequest, ListPromptsResult, ListToolsResult, ProtocolVersion, + ServerResult, + }, + service::NotificationContext, +}; + +pub mod prompt; +pub mod tool; + +#[non_exhaustive] +pub struct Router { + pub tool_router: tool::ToolRouter, + pub prompt_router: prompt::PromptRouter, + pub service: Arc, + peer_slot: Arc>>, +} + +impl Router +where + S: ServerHandler, +{ + pub fn new(service: S) -> Self { + let (notifier, peer_slot) = tool::ToolRouter::::deferred_peer_notifier(); + let mut tool_router = tool::ToolRouter::new(); + tool_router.set_notifier(notifier); + Self { + tool_router, + prompt_router: prompt::PromptRouter::new(), + service: Arc::new(service), + peer_slot, + } + } + + pub fn with_tool(mut self, route: R) -> Self + where + R: IntoToolRoute, + { + self.tool_router.add_route(route.into_tool_route()); + self + } + + pub fn with_tools(mut self, routes: impl IntoIterator>) -> Self { + for route in routes { + self.tool_router.add_route(route); + } + self + } + + pub fn with_prompt(mut self, route: R) -> Self + where + R: IntoPromptRoute, + { + self.prompt_router.add_route(route.into_prompt_route()); + self + } + + pub fn with_prompts(mut self, routes: impl IntoIterator>) -> Self { + for route in routes { + self.prompt_router.add_route(route); + } + self + } +} + +impl Service for Router +where + S: ServerHandler, +{ + async fn handle_notification( + &self, + notification: ::PeerNot, + context: NotificationContext, + ) -> Result<(), crate::ErrorData> { + if matches!( + ¬ification, + ClientNotification::InitializedNotification(_) + ) { + let _ = self.peer_slot.set(context.peer.clone()); + } + self.service + .handle_notification(notification, context) + .await + } + async fn handle_request( + &self, + request: ::PeerReq, + context: crate::service::RequestContext, + ) -> Result<::Resp, crate::ErrorData> { + match request { + ClientRequest::CallToolRequest(request) => { + if self + .tool_router + .map + .contains_key(request.params.name.as_ref()) + || !self.tool_router.transparent_when_not_found + { + let tool_call_context = crate::handler::server::tool::ToolCallContext::new( + self.service.as_ref(), + request.params, + context, + ); + let result = self.tool_router.call(tool_call_context).await?; + Ok(ServerResult::from(result)) + } else { + self.service + .handle_request(ClientRequest::CallToolRequest(request), context) + .await + } + } + ClientRequest::ListToolsRequest(_) => { + let tools = self.tool_router.list_all(); + Ok(ServerResult::ListToolsResult(ListToolsResult { + tools, + ..Default::default() + })) + } + ClientRequest::GetPromptRequest(request) => { + if self.prompt_router.has_route(request.params.name.as_ref()) { + let prompt_context = crate::handler::server::prompt::PromptContext::new( + self.service.as_ref(), + request.params.name, + request.params.arguments, + context, + ); + let result = self.prompt_router.get_prompt(prompt_context).await?; + Ok(ServerResult::from(result)) + } else { + self.service + .handle_request(ClientRequest::GetPromptRequest(request), context) + .await + } + } + ClientRequest::ListPromptsRequest(_) => { + let prompts = self.prompt_router.list_all(); + Ok(ServerResult::ListPromptsResult(ListPromptsResult { + prompts, + ..Default::default() + })) + } + rest => self.service.handle_request(rest, context).await, + } + } + + fn get_info(&self) -> ::Info { + let mut info = ServerHandler::get_info(&self.service); + info.capabilities + .tools + .get_or_insert_with(Default::default) + .list_changed = Some(true); + info + } + + fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]> { + ServerHandler::supported_protocol_versions(&self.service) + } +} + +#[cfg(test)] +mod tests { + use std::sync::Arc; + + use super::*; + use crate::{ + model::{CallToolResult, ClientNotification, ServerNotification, Tool}, + service::{AtomicU32RequestIdProvider, Peer, PeerSinkMessage, RequestIdProvider}, + }; + + struct DummyHandler; + impl ServerHandler for DummyHandler {} + + async fn recv_notification( + rx: &mut tokio::sync::mpsc::Receiver>, + ) -> ServerNotification { + let msg = tokio::time::timeout(std::time::Duration::from_secs(1), rx.recv()) + .await + .expect("timed out") + .expect("channel closed"); + match msg { + PeerSinkMessage::Notification { + notification, + responder, + } => { + let _ = responder.send(Ok(())); + notification + } + other => panic!("expected notification, got {other:?}"), + } + } + + #[tokio::test] + async fn test_router_deferred_notifier_e2e() { + let mut router = Router::new(DummyHandler).with_tool(tool::ToolRoute::new_dyn( + Tool::new("my_tool", "test", Arc::new(Default::default())), + |_ctx| Box::pin(async { Ok(CallToolResult::default().into()) }), + )); + + let id_provider: Arc = + Arc::new(AtomicU32RequestIdProvider::default()); + let (peer, mut rx) = Peer::::new(id_provider, None); + + let context = crate::service::NotificationContext { + peer: peer.clone(), + meta: Default::default(), + extensions: Default::default(), + }; + router + .handle_notification( + ClientNotification::InitializedNotification(Default::default()), + context, + ) + .await + .unwrap(); + + router.tool_router.disable_route("my_tool"); + assert!(matches!( + recv_notification(&mut rx).await, + ServerNotification::ToolListChangedNotification(_) + )); + + router.tool_router.enable_route("my_tool"); + assert!(matches!( + recv_notification(&mut rx).await, + ServerNotification::ToolListChangedNotification(_) + )); + } +} diff --git a/vendor/rmcp/src/handler/server/router/prompt.rs b/vendor/rmcp/src/handler/server/router/prompt.rs new file mode 100644 index 00000000..509fb428 --- /dev/null +++ b/vendor/rmcp/src/handler/server/router/prompt.rs @@ -0,0 +1,217 @@ +use std::{borrow::Cow, sync::Arc}; + +use crate::{ + handler::server::prompt::{DynGetPromptHandler, GetPromptHandler, PromptContext}, + model::{GetPromptResponse, Prompt}, + service::{MaybeBoxFuture, MaybeSend}, +}; + +#[non_exhaustive] +pub struct PromptRoute { + #[allow(clippy::type_complexity)] + pub get: Arc>, + pub attr: crate::model::Prompt, +} + +impl std::fmt::Debug for PromptRoute { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("PromptRoute") + .field("name", &self.attr.name) + .field("description", &self.attr.description) + .field("arguments", &self.attr.arguments) + .finish() + } +} + +impl Clone for PromptRoute { + fn clone(&self) -> Self { + Self { + get: self.get.clone(), + attr: self.attr.clone(), + } + } +} + +impl PromptRoute { + pub fn new(attr: impl Into, handler: H) -> Self + where + H: GetPromptHandler + MaybeSend + Clone + 'static, + { + Self { + get: Arc::new(move |context: PromptContext| { + let handler = handler.clone(); + handler.handle(context) + }), + attr: attr.into(), + } + } + + pub fn new_dyn(attr: impl Into, handler: H) -> Self + where + H: for<'a> Fn( + PromptContext<'a, S>, + ) + -> MaybeBoxFuture<'a, Result> + + MaybeSend + + 'static, + { + Self { + get: Arc::new(handler), + attr: attr.into(), + } + } + + pub fn name(&self) -> &str { + &self.attr.name + } +} + +pub trait IntoPromptRoute { + fn into_prompt_route(self) -> PromptRoute; +} + +impl IntoPromptRoute for (P, H) +where + S: MaybeSend + 'static, + A: 'static, + H: GetPromptHandler + MaybeSend + Clone + 'static, + P: Into, +{ + fn into_prompt_route(self) -> PromptRoute { + PromptRoute::new(self.0.into(), self.1) + } +} + +impl IntoPromptRoute for PromptRoute +where + S: MaybeSend + 'static, +{ + fn into_prompt_route(self) -> PromptRoute { + self + } +} + +/// Adapter for functions generated by the #\[prompt\] macro +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct PromptAttrGenerateFunctionAdapter; + +impl IntoPromptRoute for F +where + S: MaybeSend + 'static, + F: Fn() -> PromptRoute, +{ + fn into_prompt_route(self) -> PromptRoute { + (self)() + } +} + +#[derive(Debug)] +#[non_exhaustive] +pub struct PromptRouter { + #[allow(clippy::type_complexity)] + pub map: std::collections::HashMap, PromptRoute>, +} + +impl Default for PromptRouter { + fn default() -> Self { + Self { + map: std::collections::HashMap::new(), + } + } +} + +impl Clone for PromptRouter { + fn clone(&self) -> Self { + Self { + map: self.map.clone(), + } + } +} + +impl IntoIterator for PromptRouter { + type Item = PromptRoute; + type IntoIter = std::collections::hash_map::IntoValues, PromptRoute>; + + fn into_iter(self) -> Self::IntoIter { + self.map.into_values() + } +} + +impl PromptRouter +where + S: MaybeSend + 'static, +{ + pub fn new() -> Self { + Self { + map: std::collections::HashMap::new(), + } + } + + pub fn with_route(mut self, route: R) -> Self + where + R: IntoPromptRoute, + { + self.add_route(route.into_prompt_route()); + self + } + + pub fn add_route(&mut self, item: PromptRoute) { + self.map.insert(item.attr.name.clone().into(), item); + } + + pub fn merge(&mut self, other: PromptRouter) { + for item in other.map.into_values() { + self.add_route(item); + } + } + + pub fn remove_route(&mut self, name: &str) { + self.map.remove(name); + } + + pub fn has_route(&self, name: &str) -> bool { + self.map.contains_key(name) + } + + pub async fn get_prompt( + &self, + context: PromptContext<'_, S>, + ) -> Result { + let item = self.map.get(context.name.as_str()).ok_or_else(|| { + crate::ErrorData::invalid_params( + format!("prompt '{}' not found", context.name), + Some(serde_json::json!({ + "available_prompts": self.list_all().iter().map(|p| &p.name).collect::>() + })), + ) + })?; + (item.get)(context).await + } + + pub fn list_all(&self) -> Vec { + let mut prompts: Vec<_> = self.map.values().map(|item| item.attr.clone()).collect(); + prompts.sort_by(|a, b| a.name.cmp(&b.name)); + prompts + } +} + +impl std::ops::Add> for PromptRouter +where + S: MaybeSend + 'static, +{ + type Output = Self; + + fn add(mut self, other: PromptRouter) -> Self::Output { + self.merge(other); + self + } +} + +impl std::ops::AddAssign> for PromptRouter +where + S: MaybeSend + 'static, +{ + fn add_assign(&mut self, other: PromptRouter) { + self.merge(other); + } +} diff --git a/vendor/rmcp/src/handler/server/router/tool.rs b/vendor/rmcp/src/handler/server/router/tool.rs new file mode 100644 index 00000000..f8fab023 --- /dev/null +++ b/vendor/rmcp/src/handler/server/router/tool.rs @@ -0,0 +1,726 @@ +//! Tools for MCP servers. +//! +//! It's straightforward to define tools using [`tool_router`][crate::tool_router] and +//! [`tool`][crate::tool] macro. +//! +//! ```rust +//! # use rmcp::{ +//! # tool_router, tool, +//! # handler::server::{wrapper::{Parameters, Json}, tool::ToolRouter}, +//! # schemars +//! # }; +//! # use serde::{Serialize, Deserialize}; +//! struct Server; +//! +//! #[derive(Deserialize, schemars::JsonSchema, Default)] +//! struct AddParameter { +//! left: usize, +//! right: usize +//! } +//! #[derive(Serialize, schemars::JsonSchema)] +//! struct AddOutput { +//! sum: usize +//! } +//! #[tool_router(server_handler)] +//! impl Server { +//! #[tool(name = "adder", description = "Modular add two integers")] +//! fn add( +//! &self, +//! Parameters(AddParameter { left, right }): Parameters +//! ) -> Json { +//! Json(AddOutput { sum: left.wrapping_add(right) }) +//! } +//! } +//! ``` +//! +//! The `server_handler` flag emits `#[tool_handler]` for you (tools-only servers). For custom +//! `#[tool_handler(...)]` options or multiple handler macros on one `impl ServerHandler`, write +//! `#[tool_router]` and `#[tool_handler] impl ServerHandler for ...` explicitly—see +//! [`tool_router`][crate::tool_router] and [`tool_handler`][crate::tool_handler]. +//! +//! Using the macro-based code pattern above is suitable for small MCP servers with simple interfaces. +//! When the business logic become larger, it is recommended that each tool should reside +//! in individual file, combined into MCP server using [`SyncTool`] and [`AsyncTool`] traits. +//! +//! ```rust +//! # use rmcp::{ +//! # handler::server::{ +//! # tool::ToolRouter, +//! # router::tool::{SyncTool, AsyncTool, ToolBase}, +//! # }, +//! # schemars, ErrorData +//! # }; +//! # pub struct MyCustomError; +//! # impl From for ErrorData { +//! # fn from(err: MyCustomError) -> ErrorData { unimplemented!() } +//! # } +//! # use serde::{Serialize, Deserialize}; +//! # use std::borrow::Cow; +//! // In tool1.rs +//! pub struct ComplexTool1; +//! #[derive(Deserialize, schemars::JsonSchema, Default)] +//! pub struct ComplexTool1Input { /* ... */ } +//! #[derive(Serialize, schemars::JsonSchema)] +//! pub struct ComplexTool1Output { /* ... */ } +//! +//! impl ToolBase for ComplexTool1 { +//! type Parameter = ComplexTool1Input; +//! type Output = ComplexTool1Output; +//! type Error = MyCustomError; +//! fn name() -> Cow<'static, str> { +//! "complex-tool1".into() +//! } +//! +//! fn description() -> Option> { +//! Some("...".into()) +//! } +//! } +//! impl SyncTool for ComplexTool1 { +//! fn invoke(service: &MyToolServer, param: Self::Parameter) -> Result { +//! // ... +//! # unimplemented!() +//! } +//! } +//! // In tool2.rs +//! pub struct ComplexTool2; +//! #[derive(Deserialize, schemars::JsonSchema, Default)] +//! pub struct ComplexTool2Input { /* ... */ } +//! #[derive(Serialize, schemars::JsonSchema)] +//! pub struct ComplexTool2Output { /* ... */ } +//! +//! impl ToolBase for ComplexTool2 { +//! type Parameter = ComplexTool2Input; +//! type Output = ComplexTool2Output; +//! type Error = MyCustomError; +//! fn name() -> Cow<'static, str> { +//! "complex-tool2".into() +//! } +//! +//! fn description() -> Option> { +//! Some("...".into()) +//! } +//! } +//! impl AsyncTool for ComplexTool2 { +//! async fn invoke(service: &MyToolServer, param: Self::Parameter) -> Result { +//! // ... +//! # unimplemented!() +//! } +//! } +//! +//! // In tool_router.rs +//! struct MyToolServer { +//! tool_router: ToolRouter, +//! } +//! impl MyToolServer { +//! pub fn tool_router() -> ToolRouter { +//! ToolRouter::new() +//! .with_sync_tool::() +//! .with_async_tool::() +//! } +//! } +//! ``` +//! +//! It's also possible to use macro-based and trait-based tool definition together: Since +//! [`ToolRouter`] implements [`Add`][std::ops::Add], you can add two tool routers into final +//! router as showed in [the documentation of `tool_router`][crate::tool_router]. + +mod tool_traits; + +use std::{borrow::Cow, sync::Arc}; + +use schemars::JsonSchema; +pub use tool_traits::{AsyncTool, SyncTool, ToolBase}; + +use crate::{ + handler::server::{ + common::schema_for_input, + tool::{CallToolHandler, DynCallToolHandler, ToolCallContext}, + tool_name_validation::validate_and_warn_tool_name, + }, + model::{CallToolResponse, CallToolResult, ContentBlock, ErrorCode, Tool, ToolAnnotations}, + service::{MaybeBoxFuture, MaybeSend}, +}; + +const TOOL_ARGUMENT_DESERIALIZATION_ERROR_PREFIX: &str = "failed to deserialize parameters:"; + +fn into_tool_argument_error(error: crate::ErrorData) -> Result { + if error.code == ErrorCode::INVALID_PARAMS + && error + .message + .starts_with(TOOL_ARGUMENT_DESERIALIZATION_ERROR_PREFIX) + { + return Ok(CallToolResult::error(vec![ContentBlock::text(error.message)]).into()); + } + + Err(error) +} + +#[non_exhaustive] +pub struct ToolRoute { + #[allow(clippy::type_complexity)] + pub call: Arc>, + pub attr: crate::model::Tool, +} + +impl std::fmt::Debug for ToolRoute { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("ToolRoute") + .field("name", &self.attr.name) + .field("description", &self.attr.description) + .field("input_schema", &self.attr.input_schema) + .finish() + } +} + +impl Clone for ToolRoute { + fn clone(&self) -> Self { + Self { + call: self.call.clone(), + attr: self.attr.clone(), + } + } +} + +impl ToolRoute { + pub fn new(attr: impl Into, call: C) -> Self + where + C: CallToolHandler + MaybeSend + Clone + 'static, + { + Self { + call: Arc::new(move |context: ToolCallContext| { + let call = call.clone(); + context.invoke(call) + }), + attr: attr.into(), + } + } + pub fn new_dyn(attr: impl Into, call: C) -> Self + where + C: for<'a> Fn( + ToolCallContext<'a, S>, + ) + -> MaybeBoxFuture<'a, Result> + + MaybeSend + + 'static, + { + Self { + call: Arc::new(call), + attr: attr.into(), + } + } + pub fn name(&self) -> &str { + &self.attr.name + } +} + +pub trait IntoToolRoute { + fn into_tool_route(self) -> ToolRoute; +} + +impl IntoToolRoute for (T, C) +where + S: MaybeSend + 'static, + C: CallToolHandler + MaybeSend + Clone + 'static, + T: Into, +{ + fn into_tool_route(self) -> ToolRoute { + ToolRoute::new(self.0.into(), self.1) + } +} + +impl IntoToolRoute for ToolRoute +where + S: MaybeSend + 'static, +{ + fn into_tool_route(self) -> ToolRoute { + self + } +} + +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct ToolAttrGenerateFunctionAdapter; +impl IntoToolRoute for F +where + S: MaybeSend + 'static, + F: Fn() -> ToolRoute, +{ + fn into_tool_route(self) -> ToolRoute { + (self)() + } +} + +pub trait CallToolHandlerExt: Sized +where + Self: CallToolHandler + MaybeSend + Clone + 'static, +{ + fn name(self, name: impl Into>) -> WithToolAttr; +} + +impl CallToolHandlerExt for C +where + C: CallToolHandler + MaybeSend + Clone + 'static, +{ + fn name(self, name: impl Into>) -> WithToolAttr { + WithToolAttr { + attr: Tool::new( + name.into(), + "", + schema_for_input::().unwrap_or_else(|e| { + panic!("Invalid input schema for JsonObject: {e}"); + }), + ), + call: self, + _marker: std::marker::PhantomData, + } + } +} + +#[non_exhaustive] +pub struct WithToolAttr +where + C: CallToolHandler + MaybeSend + Clone + 'static, +{ + pub attr: crate::model::Tool, + pub call: C, + pub _marker: std::marker::PhantomData, +} + +impl IntoToolRoute for WithToolAttr +where + C: CallToolHandler + MaybeSend + Clone + 'static, + S: MaybeSend + 'static, +{ + fn into_tool_route(self) -> ToolRoute { + ToolRoute::new(self.attr, self.call) + } +} + +impl WithToolAttr +where + C: CallToolHandler + MaybeSend + Clone + 'static, +{ + pub fn description(mut self, description: impl Into>) -> Self { + self.attr.description = Some(description.into()); + self + } + pub fn parameters(mut self) -> Self { + self.attr.input_schema = schema_for_input::().unwrap_or_else(|e| { + panic!( + "Invalid input schema for `{}`: {e}", + std::any::type_name::() + ) + }); + self + } + pub fn parameters_value(mut self, schema: serde_json::Value) -> Self { + self.attr.input_schema = crate::model::object(schema).into(); + self + } + pub fn annotation(mut self, annotation: impl Into) -> Self { + self.attr.annotations = Some(annotation.into()); + self + } +} +#[non_exhaustive] +pub struct ToolRouter { + #[allow(clippy::type_complexity)] + pub map: std::collections::HashMap, ToolRoute>, + + pub transparent_when_not_found: bool, + + disabled: std::collections::HashSet>, + + notifier: Option>, +} + +impl std::fmt::Debug for ToolRouter { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("ToolRouter") + .field("map", &self.map) + .field( + "transparent_when_not_found", + &self.transparent_when_not_found, + ) + .field("disabled", &self.disabled) + .field("notifier", &self.notifier.as_ref().map(|_| "...")) + .finish() + } +} + +impl Default for ToolRouter { + fn default() -> Self { + Self { + map: std::collections::HashMap::new(), + transparent_when_not_found: false, + disabled: std::collections::HashSet::new(), + notifier: None, + } + } +} + +impl Clone for ToolRouter { + fn clone(&self) -> Self { + Self { + map: self.map.clone(), + transparent_when_not_found: self.transparent_when_not_found, + disabled: self.disabled.clone(), + notifier: self.notifier.clone(), + } + } +} + +impl IntoIterator for ToolRouter { + type Item = ToolRoute; + type IntoIter = std::collections::hash_map::IntoValues, ToolRoute>; + + fn into_iter(self) -> Self::IntoIter { + let mut map = self.map; + for name in &self.disabled { + map.remove(name); + } + map.into_values() + } +} + +impl ToolRouter +where + S: MaybeSend + 'static, +{ + pub fn new() -> Self { + Self::default() + } + pub fn with_route(mut self, route: R) -> Self + where + R: IntoToolRoute, + { + self.add_route(route.into_tool_route()); + self + } + + /// Add a tool that implements [`SyncTool`] + pub fn with_sync_tool(self) -> Self + where + T: SyncTool + 'static, + { + if T::input_schema().is_some() { + self.with_route(( + tool_traits::tool_attribute::(), + tool_traits::sync_tool_wrapper::, + )) + } else { + self.with_route(( + tool_traits::tool_attribute::(), + tool_traits::sync_tool_wrapper_with_empty_params::, + )) + } + } + + /// Add a tool that implements [`AsyncTool`] + pub fn with_async_tool(self) -> Self + where + T: AsyncTool + 'static, + { + if T::input_schema().is_some() { + self.with_route(( + tool_traits::tool_attribute::(), + tool_traits::async_tool_wrapper::, + )) + } else { + self.with_route(( + tool_traits::tool_attribute::(), + tool_traits::async_tool_wrapper_with_empty_params::, + )) + } + } + + pub fn add_route(&mut self, item: ToolRoute) { + let new_name = &item.attr.name; + validate_and_warn_tool_name(new_name); + self.map.insert(new_name.clone(), item); + } + + pub fn merge(&mut self, other: ToolRouter) { + self.disabled.extend(other.disabled); + for item in other.map.into_values() { + self.add_route(item); + } + } + + /// Remove a tool route from the router. + /// + /// The disabled state is **preserved**: if the name was in the disabled + /// set, it stays there so that a future [`add_route`](Self::add_route) + /// or [`merge`](Self::merge) with the same name will inherit the + /// disabled state. To also clear the disabled marker, call + /// [`enable_route`](Self::enable_route) afterwards. + pub fn remove_route(&mut self, name: &str) { + self.map.remove(name); + } + + /// Returns `true` if the tool is registered **and** not currently + /// disabled. + pub fn has_route(&self, name: &str) -> bool { + self.map.contains_key(name) && !self.disabled.contains(name) + } + + /// Disable a tool by name. Hidden from `list_all`, `get`, rejected by + /// `call`. Re-enable with [`enable_route`](Self::enable_route). + /// + /// Returns `true` if the name was newly added to the disabled set. + /// The name is recorded even if no matching route exists yet, so routes + /// added later will inherit the disabled state. + pub fn disable_route(&mut self, name: impl Into>) -> bool { + let name = name.into(); + let was_visible = self.map.contains_key(&name) && !self.disabled.contains(&name); + if was_visible { + self.notify_if_visible(&name); + } + self.disabled.insert(name) + } + + /// Re-enable a previously disabled tool. Returns `true` if the name + /// was in the disabled set. + pub fn enable_route(&mut self, name: &str) -> bool { + let removed = self.disabled.remove(name); + if removed { + self.notify_if_visible(name); + } + removed + } + + /// Returns `true` if the tool exists in the router **and** is currently + /// disabled. Returns `false` if the tool does not exist or if the name + /// was pre-disabled without a matching route. + pub fn is_disabled(&self, name: &str) -> bool { + self.map.contains_key(name) && self.disabled.contains(name) + } + + /// Builder-style variant of [`disable_route`](Self::disable_route). + /// + /// The name is recorded even if no matching route has been added yet, + /// so it can be called before [`with_route`](Self::with_route) in a + /// builder chain. + pub fn with_disabled(mut self, name: impl Into>) -> Self { + self.disabled.insert(name.into()); + self + } + + /// Install a callback invoked when the visible tool list changes. + pub fn set_notifier(&mut self, f: impl Fn() + Send + Sync + 'static) { + self.notifier = Some(Arc::new(f)); + } + + pub fn clear_notifier(&mut self) { + self.notifier = None; + } + + /// Install a notifier that sends `notifications/tools/list_changed` + /// via the given peer. + pub fn bind_peer_notifier(&mut self, peer: &crate::service::Peer) { + let peer = peer.clone(); + self.set_notifier(move || { + let peer = peer.clone(); + tokio::spawn(async move { + if let Err(e) = peer.notify_tool_list_changed().await { + tracing::warn!("failed to send tools/list_changed notification: {e}"); + } + }); + }); + } + + /// Deferred notifier: no-op until the peer slot is filled. + pub(crate) fn deferred_peer_notifier() -> ( + impl Fn() + Send + Sync + 'static, + Arc>>, + ) { + let peer_slot = + Arc::new(std::sync::OnceLock::>::new()); + let slot_clone = peer_slot.clone(); + let notifier = move || { + if let Some(peer) = slot_clone.get() { + let peer = peer.clone(); + tokio::spawn(async move { + if let Err(e) = peer.notify_tool_list_changed().await { + tracing::warn!("failed to send tools/list_changed notification: {e}"); + } + }); + } + }; + (notifier, peer_slot) + } + + fn notify_if_visible(&self, name: &str) { + if self.map.contains_key(name) + && let Some(notifier) = &self.notifier + { + notifier(); + } + } + + pub async fn call( + &self, + context: ToolCallContext<'_, S>, + ) -> Result { + let name = context.name(); + if self.disabled.contains(name) { + return Err(crate::ErrorData::invalid_params("tool not found", None)); + } + let item = self + .map + .get(name) + .ok_or_else(|| crate::ErrorData::invalid_params("tool not found", None))?; + + let result = match (item.call)(context).await { + Ok(result) => result, + Err(error) => return into_tool_argument_error(error), + }; + + Ok(result) + } + + pub fn list_all(&self) -> Vec { + let mut tools: Vec<_> = self + .map + .values() + .filter(|item| !self.disabled.contains(&item.attr.name)) + .map(|item| item.attr.clone()) + .collect(); + tools.sort_by(|a, b| a.name.cmp(&b.name)); + tools + } + + /// Get a tool definition by name. + /// + /// Returns the tool if found and enabled, or `None` if the tool does not + /// exist or is disabled. + pub fn get(&self, name: &str) -> Option<&crate::model::Tool> { + if self.disabled.contains(name) { + return None; + } + self.map.get(name).map(|r| &r.attr) + } +} + +impl std::ops::Add> for ToolRouter +where + S: MaybeSend + 'static, +{ + type Output = Self; + + fn add(mut self, other: ToolRouter) -> Self::Output { + self.merge(other); + self + } +} + +impl std::ops::AddAssign> for ToolRouter +where + S: MaybeSend + 'static, +{ + fn add_assign(&mut self, other: ToolRouter) { + self.merge(other); + } +} + +#[cfg(test)] +mod tests { + use std::sync::Arc; + + use super::*; + use crate::{ + RoleServer, + handler::server::wrapper::Parameters, + model::{CallToolRequestParams, ErrorCode, NumberOrString}, + service::{AtomicU32RequestIdProvider, Peer, RequestContext}, + }; + + struct DummyService; + impl crate::handler::server::ServerHandler for DummyService {} + + #[derive(serde::Deserialize, schemars::JsonSchema)] + struct RequiredParams { + project: String, + } + + fn requires_params(Parameters(params): Parameters) -> String { + params.project + } + + #[tokio::test] + async fn test_argument_deserialization_error_returns_tool_error_result() { + let service = DummyService; + let router = ToolRouter::new().with_route(ToolRoute::new( + crate::model::Tool::new( + "requires_params", + "requires params", + Arc::new(Default::default()), + ), + requires_params, + )); + + let id_provider: Arc = + Arc::new(AtomicU32RequestIdProvider::default()); + let (peer, _rx) = Peer::::new(id_provider, None); + let ctx = crate::handler::server::tool::ToolCallContext::new( + &service, + CallToolRequestParams { + meta: None, + name: Cow::Borrowed("requires_params"), + arguments: Some(Default::default()), + input_responses: None, + request_state: None, + }, + RequestContext::new(NumberOrString::Number(1), peer), + ); + + let result = router + .call(ctx) + .await + .expect("argument validation should be a tool result"); + let CallToolResponse::Complete(result) = result else { + panic!("expected complete CallToolResult"); + }; + assert_eq!(result.is_error, Some(true)); + + let text = result + .content + .first() + .and_then(|content| content.as_text()) + .map(|text| text.text.as_str()) + .expect("tool error result should include text"); + assert!(text.contains("failed to deserialize parameters")); + assert!(text.contains("missing field `project`")); + } + + #[tokio::test] + async fn test_call_disabled_tool_returns_error() { + let service = DummyService; + let mut router = ToolRouter::new().with_route(ToolRoute::new_dyn( + crate::model::Tool::new("test_tool", "a test tool", Arc::new(Default::default())), + |_ctx| Box::pin(async { Ok(CallToolResult::default().into()) }), + )); + router.disable_route("test_tool"); + + let id_provider: Arc = + Arc::new(AtomicU32RequestIdProvider::default()); + let (peer, _rx) = Peer::::new(id_provider, None); + let ctx = crate::handler::server::tool::ToolCallContext::new( + &service, + CallToolRequestParams { + meta: None, + name: Cow::Borrowed("test_tool"), + arguments: None, + input_responses: None, + request_state: None, + }, + RequestContext::new(NumberOrString::Number(1), peer), + ); + + let err = router + .call(ctx) + .await + .expect_err("disabled tool should reject"); + assert_eq!(err.code, ErrorCode::INVALID_PARAMS); + assert_eq!(err.message, "tool not found"); + } +} diff --git a/vendor/rmcp/src/handler/server/router/tool/tool_traits.rs b/vendor/rmcp/src/handler/server/router/tool/tool_traits.rs new file mode 100644 index 00000000..bde92147 --- /dev/null +++ b/vendor/rmcp/src/handler/server/router/tool/tool_traits.rs @@ -0,0 +1,339 @@ +use std::{borrow::Cow, future::Future, sync::Arc}; + +use serde::{Deserialize, Serialize}; + +use crate::{ + ErrorData, + handler::server::{ + common::{schema_for_empty_input, schema_for_input}, + tool::schema_for_output, + wrapper::{Json, Parameters}, + }, + model::{Icon, JsonObject, MetaObject, ToolAnnotations}, + schemars::JsonSchema, + service::{MaybeSend, MaybeSendFuture}, +}; + +/// Base trait to define attributes of a tool. +/// +/// Tools implementing [`SyncTool`] or [`AsyncTool`] must implement this trait first. +/// +/// All methods are consistent with fields of [`Tool`][crate::model::Tool]. +pub trait ToolBase { + /// Parameter type, will used in the invoke parameter of [`SyncTool`] or [`AsyncTool`] trait + /// + /// If the tool does not have any parameters, you **MUST** override [`input_schema`][Self::input_schema] + /// method. See its documentation for more details. + type Parameter: for<'de> Deserialize<'de> + JsonSchema + Send + Default + 'static; + /// Output type, will used in the invoke output of [`SyncTool`] or [`AsyncTool`] trait + /// + /// If the tool does not have any output, you **MUST** override [`output_schema`][Self::output_schema] + /// method. See its documentation for more details. + type Output: Serialize + JsonSchema + Send + 'static; + /// Error type, will used in the invoke output of [`SyncTool`] or [`AsyncTool`] trait + type Error: Into + Send + 'static; + + fn name() -> Cow<'static, str>; + + fn title() -> Option { + None + } + fn description() -> Option> { + None + } + + /// Json schema for tool input. + /// + /// The default implementation generates schema based on [`Self::Parameter`] type. + /// + /// If the tool does not have any parameters, you should override this methods to return [`None`], + /// and when invoked, the parameter will get default values. + fn input_schema() -> Option> { + Some( + schema_for_input::>().unwrap_or_else(|e| { + panic!( + "Invalid input schema for ToolBase::Parameter type `{0}`: {e}", + std::any::type_name::(), + ); + }), + ) + } + + /// Json schema for tool output. + /// + /// The default implementation generates schema based on [`Self::Output`] type. + /// + /// If the tool does not have any output, you should override this methods to return [`None`]. + fn output_schema() -> Option> { + Some(schema_for_output::()) + } + + fn annotations() -> Option { + None + } + fn icons() -> Option> { + None + } + fn meta() -> Option { + None + } +} + +/// Synchronous version of a tool. +/// +/// Consider using [`AsyncTool`] if your workflow involves asynchronous operations. +/// Examples are shown in [the module-level documentation][crate::handler::server::router::tool]. +#[allow(private_bounds)] +pub trait SyncTool: ToolBase { + fn invoke(service: &S, param: Self::Parameter) -> Result; +} + +/// Asynchronous version of a tool. +/// +/// Consider using [`SyncTool`] if your workflow does not involve asynchronous operations. +/// Examples are shown in [the module-level documentation][crate::handler::server::router::tool]. +#[allow(private_bounds)] +pub trait AsyncTool: ToolBase { + fn invoke( + service: &S, + param: Self::Parameter, + ) -> impl Future> + MaybeSendFuture; +} + +pub(crate) fn tool_attribute() -> crate::model::Tool { + crate::model::Tool { + name: T::name(), + title: T::title(), + description: T::description(), + input_schema: T::input_schema().unwrap_or_else(schema_for_empty_input), + output_schema: T::output_schema(), + annotations: T::annotations(), + icons: T::icons(), + meta: T::meta(), + } +} + +pub(crate) fn sync_tool_wrapper>( + service: &S, + Parameters(params): Parameters, +) -> Result, ErrorData> { + T::invoke(service, params).map(Json).map_err(Into::into) +} + +pub(crate) fn sync_tool_wrapper_with_empty_params>( + service: &S, +) -> Result, ErrorData> { + T::invoke(service, T::Parameter::default()) + .map(Json) + .map_err(Into::into) +} + +pub(crate) fn async_tool_wrapper>( + service: &S, + Parameters(params): Parameters, +) -> crate::service::MaybeBoxFuture<'_, Result, ErrorData>> { + Box::pin(async move { + T::invoke(service, params) + .await + .map(Json) + .map_err(Into::into) + }) +} + +pub(crate) fn async_tool_wrapper_with_empty_params>( + service: &S, +) -> crate::service::MaybeBoxFuture<'_, Result, ErrorData>> { + Box::pin(async move { + T::invoke(service, T::Parameter::default()) + .await + .map(Json) + .map_err(Into::into) + }) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate as rmcp; + use crate::tool; // workaround for macros + + #[derive(Deserialize, schemars::JsonSchema, Default)] + struct AddParameter { + left: usize, + right: usize, + } + #[derive(Serialize, schemars::JsonSchema, PartialEq, Debug)] + struct AddOutput { + sum: usize, + } + + struct MacroBasedToolServer; + + impl MacroBasedToolServer { + #[expect(unused)] + #[tool(name = "adder", description = "Modular add two integers")] + fn add( + &self, + Parameters(AddParameter { left, right }): Parameters, + ) -> Json { + Json(AddOutput { + sum: left.wrapping_add(right), + }) + } + + #[expect(unused)] + #[tool(name = "empty", description = "Empty tool")] + fn empty(&self) {} + } + + struct AddTool; + impl ToolBase for AddTool { + type Parameter = AddParameter; + type Output = AddOutput; + type Error = ErrorData; + + fn name() -> Cow<'static, str> { + "adder".into() + } + + fn description() -> Option> { + Some("Modular add two integers".into()) + } + } + impl SyncTool for AddTool { + fn invoke( + _service: &TraitBasedToolServer, + AddParameter { left, right }: Self::Parameter, + ) -> Result { + Ok(AddOutput { + sum: left.wrapping_add(right), + }) + } + } + impl AsyncTool for AddTool { + async fn invoke( + _service: &TraitBasedToolServer, + AddParameter { left, right }: Self::Parameter, + ) -> Result { + Ok(AddOutput { + sum: left.wrapping_add(right), + }) + } + } + + enum EmptyToolCustomError { + Internal, + InvalidParams, + } + impl From for ErrorData { + fn from(value: EmptyToolCustomError) -> Self { + match value { + EmptyToolCustomError::Internal => Self::internal_error("internal error", None), + EmptyToolCustomError::InvalidParams => Self::invalid_params("invalid params", None), + } + } + } + + struct EmptyTool; + impl ToolBase for EmptyTool { + type Parameter = (); + type Output = (); + type Error = EmptyToolCustomError; + + fn name() -> Cow<'static, str> { + "empty".into() + } + + fn description() -> Option> { + Some("Empty tool".into()) + } + + fn input_schema() -> Option> { + None + } + + fn output_schema() -> Option> { + None + } + } + impl SyncTool for EmptyTool { + fn invoke( + _service: &TraitBasedToolServer, + _param: Self::Parameter, + ) -> Result { + Err(EmptyToolCustomError::Internal) + } + } + impl AsyncTool for EmptyTool { + async fn invoke( + _service: &TraitBasedToolServer, + _param: Self::Parameter, + ) -> Result { + Err(EmptyToolCustomError::InvalidParams) + } + } + + struct TraitBasedToolServer; + + #[test] + fn test_macro_and_trait_have_same_attrs() { + let macro_attrs = MacroBasedToolServer::add_tool_attr(); + let trait_attrs = tool_attribute::(); + assert_eq!(macro_attrs, trait_attrs); + } + + #[test] + fn test_macro_and_trait_have_same_attrs_for_empty_tool() { + let macro_attrs = MacroBasedToolServer::empty_tool_attr(); + let trait_attrs = tool_attribute::(); + assert_eq!(macro_attrs, trait_attrs); + } + + #[test] + fn test_sync_tool_wrapper_happy_path() { + let left = 1; + let right = 2; + let result = sync_tool_wrapper::<_, AddTool>( + &TraitBasedToolServer, + Parameters(AddParameter { left, right }), + ); + assert!(result.is_ok()); + if let Ok(result) = result { + assert_eq!(result.0, AddOutput { sum: 3 }); + } + } + + #[tokio::test] + async fn test_async_tool_wrapper_happy_path() { + let left = 1; + let right = 2; + let result = async_tool_wrapper::<_, AddTool>( + &TraitBasedToolServer, + Parameters(AddParameter { left, right }), + ) + .await; + assert!(result.is_ok()); + if let Ok(result) = result { + assert_eq!(result.0, AddOutput { sum: 3 }); + } + } + + #[test] + fn test_sync_tool_wrapper_error_conversion() { + let result = sync_tool_wrapper::<_, EmptyTool>(&TraitBasedToolServer, Parameters(())); + assert!(result.is_err()); + if let Err(result) = result { + assert_eq!(result, ErrorData::internal_error("internal error", None)); + } + } + + #[tokio::test] + async fn test_async_tool_wrapper_error_conversion() { + let result = + async_tool_wrapper::<_, EmptyTool>(&TraitBasedToolServer, Parameters(())).await; + assert!(result.is_err()); + if let Err(result) = result { + assert_eq!(result, ErrorData::invalid_params("invalid params", None)); + } + } +} diff --git a/vendor/rmcp/src/handler/server/tool.rs b/vendor/rmcp/src/handler/server/tool.rs new file mode 100644 index 00000000..54de5fa1 --- /dev/null +++ b/vendor/rmcp/src/handler/server/tool.rs @@ -0,0 +1,405 @@ +use std::{ + borrow::Cow, + future::{Future, Ready}, + marker::PhantomData, +}; + +#[cfg(not(feature = "local"))] +use futures::future::BoxFuture; +use serde::de::DeserializeOwned; + +use super::common::{AsRequestContext, FromContextPart}; +pub use super::{ + common::{Extension, RequestId, schema_for_input, schema_for_output, schema_for_type}, + router::tool::{ToolRoute, ToolRouter}, +}; +use crate::{ + RoleServer, + handler::server::wrapper::Parameters, + model::{ + CallToolRequestParams, CallToolResponse, CallToolResult, InputRequiredResult, IntoContents, + JsonObject, + }, + service::{MaybeBoxFuture, MaybeSend, MaybeSendFuture, RequestContext}, +}; + +/// Deserialize a JSON object into a type +pub fn parse_json_object(input: JsonObject) -> Result { + serde_json::from_value(serde_json::Value::Object(input)).map_err(|e| { + crate::ErrorData::invalid_params( + format!("failed to deserialize parameters: {error}", error = e), + None, + ) + }) +} +#[non_exhaustive] +pub struct ToolCallContext<'s, S> { + /// The request-specific context for this tool call. + pub request_context: RequestContext, + /// The server handling this tool call. + pub service: &'s S, + /// The name of the tool being called. + pub name: Cow<'static, str>, + /// The arguments supplied for the tool call. + pub arguments: Option, + /// Client responses to input requests from the previous MRTR round. + pub input_responses: Option, + /// Opaque state returned by the server during the previous MRTR round. + pub request_state: Option, +} + +impl<'s, S> ToolCallContext<'s, S> { + pub fn new( + service: &'s S, + CallToolRequestParams { + meta: _, + name, + arguments, + input_responses, + request_state, + .. + }: CallToolRequestParams, + request_context: RequestContext, + ) -> Self { + Self { + request_context, + service, + name, + arguments, + input_responses, + request_state, + } + } + pub fn name(&self) -> &str { + &self.name + } + pub fn request_context(&self) -> &RequestContext { + &self.request_context + } +} + +impl AsRequestContext for ToolCallContext<'_, S> { + fn as_request_context(&self) -> &RequestContext { + &self.request_context + } + + fn as_request_context_mut(&mut self) -> &mut RequestContext { + &mut self.request_context + } +} + +pub trait IntoCallToolResult { + fn into_call_tool_result(self) -> Result; +} + +impl IntoCallToolResult for T { + fn into_call_tool_result(self) -> Result { + Ok(CallToolResult::success(self.into_contents()).into()) + } +} + +impl IntoCallToolResult for CallToolResult { + fn into_call_tool_result(self) -> Result { + Ok(self.into()) + } +} + +impl IntoCallToolResult for InputRequiredResult { + fn into_call_tool_result(self) -> Result { + Ok(self.into()) + } +} + +impl IntoCallToolResult for CallToolResponse { + fn into_call_tool_result(self) -> Result { + Ok(self) + } +} + +impl IntoCallToolResult for crate::ErrorData { + fn into_call_tool_result(self) -> Result { + Err(self) + } +} + +impl IntoCallToolResult for Result { + fn into_call_tool_result(self) -> Result { + match self { + Ok(value) => value.into_call_tool_result(), + Err(error) => match error.into_call_tool_result() { + Ok(CallToolResponse::Complete(mut result)) => { + result.is_error = Some(true); + Ok(result.into()) + } + Ok(CallToolResponse::InputRequired(_)) => Err(crate::ErrorData::internal_error( + "InputRequiredResult cannot be returned from a tool error branch", + None, + )), + Ok(CallToolResponse::Task(_)) => Err(crate::ErrorData::internal_error( + "CreateTaskResult cannot be returned from a tool error branch", + None, + )), + Err(e) => Err(e), + }, + } + } +} + +pin_project_lite::pin_project! { + #[project = IntoCallToolResultFutProj] + #[non_exhaustive] + pub enum IntoCallToolResultFut { + Pending { + #[pin] + fut: F, + _marker: PhantomData, + }, + Ready { + #[pin] + result: Ready>, + } + } +} + +impl Future for IntoCallToolResultFut +where + F: Future, + R: IntoCallToolResult, +{ + type Output = Result; + + fn poll( + self: std::pin::Pin<&mut Self>, + cx: &mut std::task::Context<'_>, + ) -> std::task::Poll { + match self.project() { + IntoCallToolResultFutProj::Pending { fut, _marker } => { + fut.poll(cx).map(IntoCallToolResult::into_call_tool_result) + } + IntoCallToolResultFutProj::Ready { result } => result.poll(cx), + } + } +} + +pub trait CallToolHandler { + fn call( + self, + context: ToolCallContext<'_, S>, + ) -> MaybeBoxFuture<'_, Result>; +} + +#[cfg(not(feature = "local"))] +pub type DynCallToolHandler = dyn for<'s> Fn(ToolCallContext<'s, S>) -> BoxFuture<'s, Result> + + Send + + Sync; + +#[cfg(feature = "local")] +pub type DynCallToolHandler = dyn for<'s> Fn( + ToolCallContext<'s, S>, +) -> futures::future::LocalBoxFuture< + 's, + Result, +>; + +// Tool-specific extractor for tool name +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct ToolName(pub Cow<'static, str>); + +impl FromContextPart> for ToolName { + fn from_context_part(context: &mut ToolCallContext) -> Result { + Ok(Self(context.name.clone())) + } +} + +/// Extracts the opaque state returned by the server during the previous MRTR round. +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct RequestState(pub Option); + +impl FromContextPart> for RequestState { + fn from_context_part(context: &mut ToolCallContext) -> Result { + Ok(Self(context.request_state.take())) + } +} + +/// Extracts client responses to input requests from the previous MRTR round. +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct InputResponses(pub Option); + +impl FromContextPart> for InputResponses { + fn from_context_part(context: &mut ToolCallContext) -> Result { + Ok(Self(context.input_responses.take())) + } +} + +// Special implementation for Parameters that handles tool arguments +impl FromContextPart> for Parameters

+where + P: DeserializeOwned, +{ + fn from_context_part(context: &mut ToolCallContext) -> Result { + let arguments = context.arguments.take().unwrap_or_default(); + let value: P = + serde_json::from_value(serde_json::Value::Object(arguments)).map_err(|e| { + crate::ErrorData::invalid_params( + format!("failed to deserialize parameters: {error}", error = e), + None, + ) + })?; + Ok(Parameters(value)) + } +} + +// Special implementation for JsonObject that takes tool arguments +impl FromContextPart> for JsonObject { + fn from_context_part(context: &mut ToolCallContext) -> Result { + let object = context.arguments.take().unwrap_or_default(); + Ok(object) + } +} + +impl<'s, S> ToolCallContext<'s, S> { + pub fn invoke( + self, + h: H, + ) -> MaybeBoxFuture<'s, Result> + where + H: CallToolHandler, + { + h.call(self) + } +} +#[allow(clippy::type_complexity)] +pub struct AsyncAdapter(PhantomData fn(Fut) -> R>); +pub struct SyncAdapter(PhantomData R>); +// #[allow(clippy::type_complexity)] +pub struct AsyncMethodAdapter(PhantomData R>); +pub struct SyncMethodAdapter(PhantomData R>); + +macro_rules! impl_for { + ($($T: ident)*) => { + impl_for!([] [$($T)*]); + }; + // finished + ([$($Tn: ident)*] []) => { + impl_for!(@impl $($Tn)*); + }; + ([$($Tn: ident)*] [$Tn_1: ident $($Rest: ident)*]) => { + impl_for!(@impl $($Tn)*); + impl_for!([$($Tn)* $Tn_1] [$($Rest)*]); + }; + (@impl $($Tn: ident)*) => { + impl<$($Tn,)* S, F, R> CallToolHandler> for F + where + $( + $Tn: for<'a> FromContextPart> , + )* + F: FnOnce(&S, $($Tn,)*) -> MaybeBoxFuture<'_, R>, + + // Need RTN support here(I guess), https://github.com/rust-lang/rust/pull/138424 + // Fut: Future + Send + 'a, + R: IntoCallToolResult + MaybeSendFuture + 'static, + S: MaybeSend + 'static, + { + #[allow(unused_variables, non_snake_case, unused_mut)] + fn call( + self, + mut context: ToolCallContext<'_, S>, + ) -> MaybeBoxFuture<'_, Result>{ + $( + let result = $Tn::from_context_part(&mut context); + let $Tn = match result { + Ok(value) => value, + Err(e) => return Box::pin(std::future::ready(Err(e))), + }; + )* + let service = context.service; + let fut = self(service, $($Tn,)*); + Box::pin(async move { + let result = fut.await; + result.into_call_tool_result() + }) + } + } + + impl<$($Tn,)* S, F, Fut, R> CallToolHandler> for F + where + $( + $Tn: for<'a> FromContextPart> , + )* + F: FnOnce($($Tn,)*) -> Fut + MaybeSendFuture, + Fut: Future + MaybeSendFuture + 'static, + R: IntoCallToolResult + MaybeSendFuture + 'static, + S: MaybeSend, + { + #[allow(unused_variables, non_snake_case, unused_mut)] + fn call( + self, + mut context: ToolCallContext, + ) -> MaybeBoxFuture<'static, Result>{ + $( + let result = $Tn::from_context_part(&mut context); + let $Tn = match result { + Ok(value) => value, + Err(e) => return Box::pin(std::future::ready(Err(e))), + }; + )* + let fut = self($($Tn,)*); + Box::pin(async move { + let result = fut.await; + result.into_call_tool_result() + }) + } + } + + impl<$($Tn,)* S, F, R> CallToolHandler> for F + where + $( + $Tn: for<'a> FromContextPart> + , + )* + F: FnOnce(&S, $($Tn,)*) -> R + MaybeSendFuture, + R: IntoCallToolResult + MaybeSendFuture, + S: MaybeSend, + { + #[allow(unused_variables, non_snake_case, unused_mut)] + fn call( + self, + mut context: ToolCallContext, + ) -> MaybeBoxFuture<'static, Result> { + $( + let result = $Tn::from_context_part(&mut context); + let $Tn = match result { + Ok(value) => value, + Err(e) => return Box::pin(std::future::ready(Err(e))), + }; + )* + Box::pin(std::future::ready(self(context.service, $($Tn,)*).into_call_tool_result())) + } + } + + impl<$($Tn,)* S, F, R> CallToolHandler> for F + where + $( + $Tn: for<'a> FromContextPart> + , + )* + F: FnOnce($($Tn,)*) -> R + MaybeSendFuture, + R: IntoCallToolResult + MaybeSendFuture, + S: MaybeSend, + { + #[allow(unused_variables, non_snake_case, unused_mut)] + fn call( + self, + mut context: ToolCallContext, + ) -> MaybeBoxFuture<'static, Result> { + $( + let result = $Tn::from_context_part(&mut context); + let $Tn = match result { + Ok(value) => value, + Err(e) => return Box::pin(std::future::ready(Err(e))), + }; + )* + Box::pin(std::future::ready(self($($Tn,)*).into_call_tool_result())) + } + } + }; +} +impl_for!(T0 T1 T2 T3 T4 T5 T6 T7 T8 T9 T10 T11 T12 T13 T14 T15); diff --git a/vendor/rmcp/src/handler/server/tool_name_validation.rs b/vendor/rmcp/src/handler/server/tool_name_validation.rs new file mode 100644 index 00000000..8ae04b62 --- /dev/null +++ b/vendor/rmcp/src/handler/server/tool_name_validation.rs @@ -0,0 +1,261 @@ +//! Tool name validation utilities according to SEP: Specify Format for Tool Names +//! +//! Tool names SHOULD be between 1 and 128 characters in length (inclusive). +//! Tool names are case-sensitive. +//! Allowed characters: uppercase and lowercase ASCII letters (A-Z, a-z), digits +//! (0-9), underscore (_), dash (-), and dot (.). +//! Tool names SHOULD NOT contain spaces, commas, or other special characters. + +use std::collections::HashSet; + +/// Result of tool name validation containing validation status and warnings. +#[derive(Debug, Clone, PartialEq, Eq)] +struct ToolNameValidationResult { + /// Whether the tool name is valid according to the specification + is_valid: bool, + /// Array of warning messages about non-conforming aspects of the tool name + warnings: Vec, +} + +impl ToolNameValidationResult { + /// Create a new validation result + fn new(is_valid: bool, warnings: Vec) -> Self { + Self { is_valid, warnings } + } +} + +/// Validates a tool name according to the SEP specification. +fn validate_tool_name(name: &str) -> ToolNameValidationResult { + let mut warnings = Vec::new(); + + // Check length + if name.is_empty() { + return ToolNameValidationResult::new(false, vec!["Tool name cannot be empty".to_string()]); + } + + if name.len() > 128 { + return ToolNameValidationResult::new( + false, + vec![format!( + "Tool name exceeds maximum length of 128 characters (current: {})", + name.len() + )], + ); + } + + // Check for specific problematic patterns (these are warnings, not validation failures) + if name.contains(' ') { + warnings.push("Tool name contains spaces, which may cause parsing issues".to_string()); + } + + if name.contains(',') { + warnings.push("Tool name contains commas, which may cause parsing issues".to_string()); + } + + // Check for potentially confusing patterns (leading/trailing dashes, dots, slashes) + if name.starts_with('-') || name.ends_with('-') { + warnings.push( + "Tool name starts or ends with a dash, which may cause parsing issues in some contexts" + .to_string(), + ); + } + + if name.starts_with('.') || name.ends_with('.') { + warnings.push( + "Tool name starts or ends with a dot, which may cause parsing issues in some contexts" + .to_string(), + ); + } + + // Check for invalid characters + let mut invalid_chars = HashSet::new(); + let valid_chars: HashSet = + "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789._-" + .chars() + .collect(); + + for ch in name.chars() { + if !valid_chars.contains(&ch) { + invalid_chars.insert(ch); + } + } + + if !invalid_chars.is_empty() { + let invalid_chars_list: Vec = + invalid_chars.iter().map(|c| format!("\"{}\"", c)).collect(); + warnings.push(format!( + "Tool name contains invalid characters: {}", + invalid_chars_list.join(", ") + )); + warnings.push( + "Allowed characters are: A-Z, a-z, 0-9, underscore (_), dash (-), and dot (.)" + .to_string(), + ); + + return ToolNameValidationResult::new(false, warnings); + } + + // Verify the pattern matches (double check with character-by-character validation) + // We've already validated characters above, just need to verify length is within bounds + if name.is_empty() || name.len() > 128 { + return ToolNameValidationResult::new( + false, + vec!["Tool name length must be between 1 and 128 characters".to_string()], + ); + } + + ToolNameValidationResult::new(true, warnings) +} + +/// Issues warnings for non-conforming tool names. +fn issue_tool_name_warning(name: &str, warnings: &[String]) { + tracing::warn!("Tool name validation warning for \"{}\":", name); + for warning in warnings { + tracing::warn!(" - {}", warning); + } + tracing::warn!("Tool registration will proceed, but this may cause compatibility issues."); + tracing::warn!("Consider updating the tool name to conform to the MCP tool naming standard."); + tracing::warn!( + "See SEP: Specify Format for Tool Names (https://github.com/modelcontextprotocol/modelcontextprotocol/issues/986) for more details." + ); +} + +/// Validates a tool name and issues warnings for non-conforming names. +pub fn validate_and_warn_tool_name(name: &str) -> bool { + let result = validate_tool_name(name); + + if !result.warnings.is_empty() { + issue_tool_name_warning(name, &result.warnings); + } + + result.is_valid +} +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn test_valid_tool_names() { + let max_length_name = "a".repeat(128); + let valid_names = vec![ + "my_tool", + "MyTool", + "my-tool", + "my.tool", + "tool123", + "a", + max_length_name.as_str(), // Maximum length + ]; + + for name in valid_names { + let result = validate_tool_name(name); + assert!(result.is_valid, "Tool name '{}' should be valid", name); + } + } + + #[test] + fn test_empty_tool_name() { + let result = validate_tool_name(""); + assert!(!result.is_valid); + assert!( + result + .warnings + .contains(&"Tool name cannot be empty".to_string()) + ); + } + + #[test] + fn test_too_long_tool_name() { + let name = "a".repeat(129); + let result = validate_tool_name(&name); + assert!(!result.is_valid); + assert!(result.warnings[0].contains("exceeds maximum length")); + } + + #[test] + fn test_tool_name_with_spaces() { + let result = validate_tool_name("my tool"); + assert!(!result.is_valid); + assert!( + result + .warnings + .iter() + .any(|w| w.contains("contains spaces")) + ); + } + + #[test] + fn test_tool_name_with_commas() { + let result = validate_tool_name("my,tool"); + assert!(!result.is_valid); + assert!( + result + .warnings + .iter() + .any(|w| w.contains("contains commas")) + ); + } + + #[test] + fn test_tool_name_starting_with_dash() { + let result = validate_tool_name("-tool"); + assert!(result.is_valid); // Still valid, but has warning + assert!( + result + .warnings + .iter() + .any(|w| w.contains("starts or ends with a dash")) + ); + } + + #[test] + fn test_tool_name_ending_with_dot() { + let result = validate_tool_name("tool."); + assert!(result.is_valid); // Still valid, but has warning + assert!( + result + .warnings + .iter() + .any(|w| w.contains("starts or ends with a dot")) + ); + } + + #[test] + fn test_tool_name_with_invalid_characters() { + let result = validate_tool_name("my@tool"); + assert!(!result.is_valid); + assert!( + result + .warnings + .iter() + .any(|w| w.contains("contains invalid characters")) + ); + } + + #[test] + fn test_tool_name_all_special_characters_allowed() { + let valid_chars = vec!['_', '-', '.']; + for ch in valid_chars { + let name = format!("tool{}", ch); + let result = validate_tool_name(&name); + assert!( + result.is_valid, + "Tool name with character '{}' should be valid", + ch + ); + } + } + + #[test] + fn test_minimum_length() { + let result = validate_tool_name("a"); + assert!(result.is_valid); + } + + #[test] + fn test_maximum_length() { + let name = "a".repeat(128); + let result = validate_tool_name(&name); + assert!(result.is_valid); + } +} diff --git a/vendor/rmcp/src/handler/server/wrapper.rs b/vendor/rmcp/src/handler/server/wrapper.rs new file mode 100644 index 00000000..d9f2c86d --- /dev/null +++ b/vendor/rmcp/src/handler/server/wrapper.rs @@ -0,0 +1,4 @@ +mod json; +mod parameters; +pub use json::*; +pub use parameters::*; diff --git a/vendor/rmcp/src/handler/server/wrapper/json.rs b/vendor/rmcp/src/handler/server/wrapper/json.rs new file mode 100644 index 00000000..7c529796 --- /dev/null +++ b/vendor/rmcp/src/handler/server/wrapper/json.rs @@ -0,0 +1,43 @@ +use std::borrow::Cow; + +use schemars::JsonSchema; +use serde::Serialize; + +use crate::{ + handler::server::tool::IntoCallToolResult, + model::{CallToolResponse, CallToolResult}, +}; + +/// Json wrapper for structured output +/// +/// When used with tools, this wrapper indicates that the value should be +/// serialized as structured JSON content with an associated schema. +/// The framework will place the JSON in the `structured_content` field +/// of the tool result rather than the regular `content` field. +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct Json(pub T); + +// Implement JsonSchema for Json to delegate to T's schema +impl JsonSchema for Json { + fn schema_name() -> Cow<'static, str> { + T::schema_name() + } + + fn json_schema(generator: &mut schemars::SchemaGenerator) -> schemars::Schema { + T::json_schema(generator) + } +} + +// Implementation for Json to create structured content +impl IntoCallToolResult for Json { + fn into_call_tool_result(self) -> Result { + let value = serde_json::to_value(self.0).map_err(|e| { + crate::ErrorData::internal_error( + format!("Failed to serialize structured content: {}", e), + None, + ) + })?; + + Ok(CallToolResult::structured(value).into()) + } +} diff --git a/vendor/rmcp/src/handler/server/wrapper/parameters.rs b/vendor/rmcp/src/handler/server/wrapper/parameters.rs new file mode 100644 index 00000000..ab3eb0ce --- /dev/null +++ b/vendor/rmcp/src/handler/server/wrapper/parameters.rs @@ -0,0 +1,56 @@ +use schemars::JsonSchema; + +/// Parameter extractor for tools and prompts +/// +/// When used in tool and prompt handlers, this wrapper extracts and deserializes +/// parameters from the incoming request. The framework will automatically parse +/// the JSON arguments from tool calls or prompt arguments and deserialize them +/// into the specified type `P`. +/// +/// The `#[serde(transparent)]` attribute ensures that the wrapper doesn't add +/// an extra layer in the JSON structure - it directly delegates serialization +/// and deserialization to the inner type `P`. +/// +/// # Usage +/// +/// Use `Parameters` as a parameter in your tool or prompt handler functions: +/// +/// ```rust +/// # use rmcp::handler::server::wrapper::Parameters; +/// # use schemars::JsonSchema; +/// # use serde::{Deserialize, Serialize}; +/// #[derive(Deserialize, JsonSchema)] +/// struct CalculationRequest { +/// operation: String, +/// a: f64, +/// b: f64, +/// } +/// +/// // In a tool handler +/// async fn calculate(params: Parameters) -> Result { +/// let request = params.0; // Extract the inner value +/// match request.operation.as_str() { +/// "add" => Ok((request.a + request.b).to_string()), +/// _ => Err("Unknown operation".to_string()), +/// } +/// } +/// ``` +/// +/// The framework handles the extraction automatically: +/// - For tools: Parses the `arguments` field from tool call requests +/// - For prompts: Parses the `arguments` field from prompt requests +/// - Returns appropriate error responses if deserialization fails +#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)] +#[serde(transparent)] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct Parameters

(pub P); + +impl JsonSchema for Parameters

{ + fn schema_name() -> std::borrow::Cow<'static, str> { + P::schema_name() + } + + fn json_schema(generator: &mut schemars::SchemaGenerator) -> schemars::Schema { + P::json_schema(generator) + } +} diff --git a/vendor/rmcp/src/lib.rs b/vendor/rmcp/src/lib.rs new file mode 100644 index 00000000..3be6616e --- /dev/null +++ b/vendor/rmcp/src/lib.rs @@ -0,0 +1,44 @@ +#![cfg_attr(docsrs, feature(doc_cfg))] +#![cfg_attr(docsrs, allow(unused_attributes))] +#![doc = include_str!("../README.md")] + +mod error; +pub use error::{ErrorData, RmcpError}; + +/// Basic data types in MCP specification +pub mod model; +#[cfg(any(feature = "client", feature = "server"))] +pub mod service; +#[cfg(feature = "client")] +pub use handler::client::ClientHandler; +#[cfg(feature = "server")] +pub use handler::server::ServerHandler; +#[cfg(feature = "server")] +pub use handler::server::wrapper::Json; +#[cfg(feature = "client")] +pub use service::{ + ClientCacheConfig, ClientLifecycleMode, ClientServiceExt, MAX_CLIENT_CACHE_TTL, RoleClient, + select_protocol_version, serve_client, serve_client_with_lifecycle, +}; +#[cfg(any(feature = "client", feature = "server"))] +pub use service::{Peer, Service, ServiceError, ServiceExt}; +#[cfg(feature = "server")] +pub use service::{RoleServer, serve_server}; + +pub mod handler; +#[cfg(feature = "server")] +pub mod task_manager; +#[cfg(any(feature = "client", feature = "server"))] +pub mod transport; + +// re-export +#[cfg(all(feature = "macros", feature = "server"))] +pub use pastey::paste; +#[cfg(all(feature = "macros", feature = "server"))] +pub use rmcp_macros::*; +#[cfg(feature = "schemars")] +pub use schemars; +#[cfg(feature = "macros")] +pub use serde; +#[cfg(feature = "macros")] +pub use serde_json; diff --git a/vendor/rmcp/src/model.rs b/vendor/rmcp/src/model.rs new file mode 100644 index 00000000..27cb75c8 --- /dev/null +++ b/vendor/rmcp/src/model.rs @@ -0,0 +1,5556 @@ +// Internal references to the SEP-2577-deprecated Roots/Sampling/Logging types +// defined in this module are expected; the deprecation is advisory for downstream users. +#![expect(deprecated)] +use std::{ + borrow::Cow, + collections::hash_map::RandomState, + hash::{BuildHasher, Hasher}, + ops::{Deref, DerefMut}, + sync::{Arc, OnceLock}, +}; +mod annotated; +mod capabilities; +mod content; +mod elicitation_schema; +mod extension; +mod meta; +mod mrtr; +mod prompt; +#[cfg(feature = "request-state")] +mod request_state; +mod resource; +mod serde_impl; +mod task; +mod tool; +pub use annotated::*; +pub use capabilities::*; +pub use content::*; +pub use elicitation_schema::*; +pub use extension::*; +pub use meta::*; +pub use mrtr::*; +pub use prompt::*; +#[cfg(feature = "request-state")] +pub use request_state::*; +pub use resource::*; +use serde::{Deserialize, Serialize, de::DeserializeOwned}; +use serde_json::Value; +pub use task::*; +pub use tool::*; + +/// A JSON object type alias for convenient handling of JSON data. +/// +/// You can use [`crate::object!`] or [`crate::model::object`] to create a json object quickly. +/// This is commonly used for storing arbitrary JSON data in MCP messages. +pub type JsonObject = serde_json::Map; + +/// unwrap the JsonObject under [`serde_json::Value`] +/// +/// # Panic +/// This will panic when the value is not a object in debug mode. +pub fn object(value: serde_json::Value) -> JsonObject { + debug_assert!(value.is_object()); + match value { + serde_json::Value::Object(map) => map, + _ => JsonObject::default(), + } +} + +/// Use this macro just like [`serde_json::json!`] +#[cfg(feature = "macros")] +#[macro_export] +macro_rules! object { + ({$($tt:tt)*}) => { + $crate::model::object(serde_json::json! { + {$($tt)*} + }) + }; +} + +/// This is commonly used for representing empty objects in MCP messages. +/// +/// without returning any specific data. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Copy, Eq)] +#[serde(deny_unknown_fields)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct EmptyObject {} + +pub trait ConstString: Default { + const VALUE: &str; + fn as_str(&self) -> &'static str { + Self::VALUE + } +} +#[macro_export] +macro_rules! const_string { + ($name:ident = $value:literal) => { + #[derive(Debug, Clone, Copy, Default, PartialEq, Eq)] + #[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] + pub struct $name; + + impl ConstString for $name { + const VALUE: &str = $value; + } + + impl serde::Serialize for $name { + fn serialize(&self, serializer: S) -> Result + where + S: serde::Serializer, + { + $value.serialize(serializer) + } + } + + impl<'de> serde::Deserialize<'de> for $name { + fn deserialize(deserializer: D) -> Result<$name, D::Error> + where + D: serde::Deserializer<'de>, + { + let s: String = serde::Deserialize::deserialize(deserializer)?; + if s == $value { + Ok($name) + } else { + Err(serde::de::Error::custom(format!(concat!( + "expect const string value \"", + $value, + "\"" + )))) + } + } + } + + #[cfg(feature = "schemars")] + impl schemars::JsonSchema for $name { + fn schema_name() -> Cow<'static, str> { + Cow::Borrowed(stringify!($name)) + } + + fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema { + use serde_json::{Map, json}; + + let mut schema_map = Map::new(); + schema_map.insert("type".to_string(), json!("string")); + schema_map.insert("format".to_string(), json!("const")); + schema_map.insert("const".to_string(), json!($value)); + + schemars::Schema::from(schema_map) + } + } + }; +} + +const_string!(JsonRpcVersion2_0 = "2.0"); + +// ============================================================================= +// CORE PROTOCOL TYPES +// ============================================================================= + +/// Represents the MCP protocol version used for communication. +/// +/// This ensures compatibility between clients and servers by specifying +/// which version of the Model Context Protocol is being used. +#[derive(Debug, Clone, Eq, PartialEq, Hash, PartialOrd)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +pub struct ProtocolVersion(Cow<'static, str>); + +impl Default for ProtocolVersion { + fn default() -> Self { + Self::LATEST + } +} + +impl std::fmt::Display for ProtocolVersion { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + self.0.fmt(f) + } +} + +impl ProtocolVersion { + pub const V_2026_07_28: Self = Self(Cow::Borrowed("2026-07-28")); + pub const V_2025_11_25: Self = Self(Cow::Borrowed("2025-11-25")); + pub const V_2025_06_18: Self = Self(Cow::Borrowed("2025-06-18")); + pub const V_2025_03_26: Self = Self(Cow::Borrowed("2025-03-26")); + pub const V_2024_11_05: Self = Self(Cow::Borrowed("2024-11-05")); + + /// The newest protocol version known to this SDK. + pub const LATEST: Self = Self::V_2026_07_28; + + /// First protocol version that requires SEP-2243 standard HTTP headers. + pub const STANDARD_HEADERS: Self = Self::V_2026_07_28; + + /// First protocol version that replaced the `initialize` handshake with + /// per-request `_meta` (SEP-2567). + pub const NO_INITIALIZE: Self = Self::V_2026_07_28; + + /// The newest protocol version that still has an `initialize` handshake. + /// + /// From [`Self::NO_INITIALIZE`] onward the lifecycle moved into per-request + /// `_meta`, so there is no handshake left to answer. A server replying to + /// `initialize` can therefore never name [`Self::LATEST`] once `LATEST` + /// reaches that revision — it has to name this one instead. + /// + /// Use this, not `LATEST`, whenever the subject is the handshake itself: + /// the version a server can echo from `initialize`, or the version a test + /// needs in order to exercise session-based behavior. + /// + /// ``` + /// # use rmcp::model::ProtocolVersion; + /// assert!(ProtocolVersion::LATEST_WITH_INITIALIZE.has_initialize()); + /// assert!(!ProtocolVersion::LATEST.has_initialize()); + /// ``` + pub const LATEST_WITH_INITIALIZE: Self = Self::V_2025_11_25; + + /// All protocol versions known to this SDK, oldest first. + pub const KNOWN_VERSIONS: &[Self] = &[ + Self::V_2024_11_05, + Self::V_2025_03_26, + Self::V_2025_06_18, + Self::V_2025_11_25, + Self::V_2026_07_28, + ]; + + /// Returns the string representation of this protocol version. + pub fn as_str(&self) -> &str { + &self.0 + } + + /// Whether this revision negotiates its lifecycle over the `initialize` + /// handshake. + /// + /// `false` from [`Self::NO_INITIALIZE`] onward, where SEP-2567 moved the + /// lifecycle into per-request `_meta`. Unknown versions are compared + /// lexically, which orders correctly because every revision is dated + /// `YYYY-MM-DD`. + /// + /// ``` + /// # use rmcp::model::ProtocolVersion; + /// assert!(ProtocolVersion::V_2025_11_25.has_initialize()); + /// assert!(!ProtocolVersion::V_2026_07_28.has_initialize()); + /// ``` + pub fn has_initialize(&self) -> bool { + self.as_str() < Self::NO_INITIALIZE.as_str() + } + + /// The known versions up to and including `max`, oldest first. + /// + /// Servers that implement every revision up to some ceiling can return + /// this from `supported_protocol_versions` instead of filtering + /// [`Self::KNOWN_VERSIONS`] by hand. `max` itself need not be a known + /// version; the result is empty when it predates all of them. + /// + /// The result borrows from [`Self::KNOWN_VERSIONS`], so call it directly + /// in the method body — it needs no `static` and no `LazyLock`: + /// + /// ```rust,ignore + /// const MAX_SUPPORTED: ProtocolVersion = ProtocolVersion::V_2025_11_25; + /// + /// fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]> { + /// Cow::Borrowed(ProtocolVersion::known_up_to(&MAX_SUPPORTED)) + /// } + /// ``` + /// + /// ``` + /// # use rmcp::model::ProtocolVersion; + /// assert_eq!( + /// ProtocolVersion::known_up_to(&ProtocolVersion::V_2025_06_18), + /// &[ + /// ProtocolVersion::V_2024_11_05, + /// ProtocolVersion::V_2025_03_26, + /// ProtocolVersion::V_2025_06_18, + /// ], + /// ); + /// ``` + pub fn known_up_to(max: &Self) -> &'static [Self] { + let count = Self::KNOWN_VERSIONS + .iter() + .take_while(|version| version.as_str() <= max.as_str()) + .count(); + &Self::KNOWN_VERSIONS[..count] + } +} + +impl Serialize for ProtocolVersion { + fn serialize(&self, serializer: S) -> Result + where + S: serde::Serializer, + { + self.0.serialize(serializer) + } +} + +impl<'de> Deserialize<'de> for ProtocolVersion { + fn deserialize(deserializer: D) -> Result + where + D: serde::Deserializer<'de>, + { + let s: String = Deserialize::deserialize(deserializer)?; + #[allow(clippy::single_match)] + match s.as_str() { + "2024-11-05" => return Ok(ProtocolVersion::V_2024_11_05), + "2025-03-26" => return Ok(ProtocolVersion::V_2025_03_26), + "2025-06-18" => return Ok(ProtocolVersion::V_2025_06_18), + "2025-11-25" => return Ok(ProtocolVersion::V_2025_11_25), + "2026-07-28" => return Ok(ProtocolVersion::V_2026_07_28), + _ => {} + } + Ok(ProtocolVersion(Cow::Owned(s))) + } +} + +/// A flexible identifier type that can be either a number or a string. +/// +/// This is commonly used for request IDs and other identifiers in JSON-RPC +/// where the specification allows both numeric and string values. +#[derive(Debug, Clone, Eq, PartialEq, Hash)] +#[expect(clippy::exhaustive_enums, reason = "intentionally exhaustive")] +pub enum NumberOrString { + /// A numeric identifier + Number(i64), + /// A string identifier + String(Arc), +} + +impl NumberOrString { + pub fn into_json_value(self) -> Value { + match self { + NumberOrString::Number(n) => Value::Number(serde_json::Number::from(n)), + NumberOrString::String(s) => Value::String(s.to_string()), + } + } + + pub(crate) fn numeric_string_value(&self) -> Option { + match self { + Self::String(id) => id.parse().ok(), + Self::Number(_) => None, + } + } + + pub(crate) fn matches_response_id(&self, response_id: &Self) -> bool { + self == response_id + || matches!( + self, + Self::Number(request_id) + if response_id.numeric_string_value() == Some(*request_id) + ) + } +} + +impl std::fmt::Display for NumberOrString { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + NumberOrString::Number(n) => n.fmt(f), + NumberOrString::String(s) => s.fmt(f), + } + } +} + +impl Serialize for NumberOrString { + fn serialize(&self, serializer: S) -> Result + where + S: serde::Serializer, + { + match self { + NumberOrString::Number(n) => n.serialize(serializer), + NumberOrString::String(s) => s.serialize(serializer), + } + } +} + +impl<'de> Deserialize<'de> for NumberOrString { + fn deserialize(deserializer: D) -> Result + where + D: serde::Deserializer<'de>, + { + let value: Value = Deserialize::deserialize(deserializer)?; + match value { + Value::Number(n) => { + if let Some(i) = n.as_i64() { + Ok(NumberOrString::Number(i)) + } else if let Some(u) = n.as_u64() { + // Handle large unsigned numbers that fit in i64 + if u <= i64::MAX as u64 { + Ok(NumberOrString::Number(u as i64)) + } else { + Err(serde::de::Error::custom("Number too large for i64")) + } + } else { + Err(serde::de::Error::custom("Expected an integer")) + } + } + Value::String(s) => Ok(NumberOrString::String(s.into())), + _ => Err(serde::de::Error::custom("Expect number or string")), + } + } +} + +#[cfg(feature = "schemars")] +impl schemars::JsonSchema for NumberOrString { + fn schema_name() -> Cow<'static, str> { + Cow::Borrowed("NumberOrString") + } + + fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema { + use serde_json::{Map, json}; + + let mut number_schema = Map::new(); + number_schema.insert("type".to_string(), json!("number")); + + let mut string_schema = Map::new(); + string_schema.insert("type".to_string(), json!("string")); + + let mut schema_map = Map::new(); + schema_map.insert("oneOf".to_string(), json!([number_schema, string_schema])); + + schemars::Schema::from(schema_map) + } +} + +/// Type alias for request identifiers used in JSON-RPC communication. +pub type RequestId = NumberOrString; + +/// A token used to track the progress of long-running operations. +/// +/// Progress tokens allow clients and servers to associate progress notifications +/// with specific requests, enabling real-time updates on operation status. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Hash, Eq)] +#[serde(transparent)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct ProgressToken(pub NumberOrString); + +// ============================================================================= +// JSON-RPC MESSAGE STRUCTURES +// ============================================================================= + +/// Represents a JSON-RPC request with method, parameters, and extensions. +/// +/// This is the core structure for all MCP requests, containing: +/// - `method`: The name of the method being called +/// - `params`: The parameters for the method +/// - `extensions`: Additional context data (similar to HTTP headers) +#[derive(Debug, Clone, Default)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct Request { + pub method: M, + pub params: P, + /// extensions will carry anything possible in the context, including the metadata + /// ([`RequestMetaObject`] for requests, [`NotificationMetaObject`] for notifications) + /// + /// this is similar with the Extensions in `http` crate + #[cfg_attr(feature = "schemars", schemars(skip))] + pub extensions: Extensions, +} + +impl Request { + pub fn new(params: P) -> Self { + Self { + method: Default::default(), + params, + extensions: Extensions::default(), + } + } +} + +impl GetExtensions for Request { + fn extensions(&self) -> &Extensions { + &self.extensions + } + fn extensions_mut(&mut self) -> &mut Extensions { + &mut self.extensions + } +} + +#[derive(Debug, Clone, Default)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct RequestOptionalParam { + pub method: M, + // #[serde(skip_serializing_if = "Option::is_none")] + pub params: Option

, + /// extensions will carry anything possible in the context, including the metadata + /// ([`RequestMetaObject`] for requests, [`NotificationMetaObject`] for notifications) + /// + /// this is similar with the Extensions in `http` crate + #[cfg_attr(feature = "schemars", schemars(skip))] + pub extensions: Extensions, +} + +impl RequestOptionalParam { + pub fn with_param(params: P) -> Self { + Self { + method: Default::default(), + params: Some(params), + extensions: Extensions::default(), + } + } +} + +#[derive(Debug, Clone, Default)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct RequestNoParam { + pub method: M, + /// extensions will carry anything possible in the context, including the metadata + /// ([`RequestMetaObject`] for requests, [`NotificationMetaObject`] for notifications) + /// + /// this is similar with the Extensions in `http` crate + #[cfg_attr(feature = "schemars", schemars(skip))] + pub extensions: Extensions, +} + +impl GetExtensions for RequestNoParam { + fn extensions(&self) -> &Extensions { + &self.extensions + } + fn extensions_mut(&mut self) -> &mut Extensions { + &mut self.extensions + } +} +#[derive(Debug, Clone, Default)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct Notification { + pub method: M, + pub params: P, + /// extensions will carry anything possible in the context, including the metadata + /// ([`RequestMetaObject`] for requests, [`NotificationMetaObject`] for notifications) + /// + /// this is similar with the Extensions in `http` crate + #[cfg_attr(feature = "schemars", schemars(skip))] + pub extensions: Extensions, +} + +impl Notification { + pub fn new(params: P) -> Self { + Self { + method: Default::default(), + params, + extensions: Extensions::default(), + } + } +} + +#[derive(Debug, Clone, Default)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct NotificationNoParam { + pub method: M, + /// extensions will carry anything possible in the context, including the metadata + /// ([`RequestMetaObject`] for requests, [`NotificationMetaObject`] for notifications) + /// + /// this is similar with the Extensions in `http` crate + #[cfg_attr(feature = "schemars", schemars(skip))] + pub extensions: Extensions, +} + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct JsonRpcRequest { + pub jsonrpc: JsonRpcVersion2_0, + pub id: RequestId, + #[serde(flatten)] + pub request: R, +} + +impl JsonRpcRequest { + /// Create a new JsonRpcRequest. + pub fn new(id: RequestId, request: R) -> Self { + Self { + jsonrpc: JsonRpcVersion2_0, + id, + request, + } + } +} + +type DefaultResponse = JsonObject; +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct JsonRpcResponse { + pub jsonrpc: JsonRpcVersion2_0, + pub id: RequestId, + pub result: R, +} + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct JsonRpcError { + pub jsonrpc: JsonRpcVersion2_0, + // MCP 2026-07-28 §Error Responses: `id` is optional and omitted when the + // server cannot read the request id (e.g. parse error / invalid request). + // https://modelcontextprotocol.io/specification/2026-07-28/basic#error-responses + #[serde(default, skip_serializing_if = "Option::is_none")] + pub id: Option, + pub error: ErrorData, +} + +impl JsonRpcError { + /// Create a new JsonRpcError. + pub fn new(id: Option, error: ErrorData) -> Self { + Self { + jsonrpc: JsonRpcVersion2_0, + id, + error, + } + } +} + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct JsonRpcNotification { + pub jsonrpc: JsonRpcVersion2_0, + #[serde(flatten)] + pub notification: N, +} + +/// Standard JSON-RPC error codes used throughout the MCP protocol. +/// +/// These codes follow the JSON-RPC 2.0 specification and provide +/// standardized error reporting across all MCP implementations. +#[derive(Debug, Clone, Copy, Default, Serialize, Deserialize, PartialEq, Eq)] +#[serde(transparent)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct ErrorCode(pub i32); + +impl ErrorCode { + /// The request used a protocol version the server does not support. + pub const UNSUPPORTED_PROTOCOL_VERSION: Self = Self(-32022); + /// Processing the request requires a client capability that was not declared. + pub const MISSING_REQUIRED_CLIENT_CAPABILITY: Self = Self(-32021); + pub const HEADER_MISMATCH: Self = Self(-32020); + pub const RESOURCE_NOT_FOUND: Self = Self(-32002); + pub const INVALID_REQUEST: Self = Self(-32600); + pub const METHOD_NOT_FOUND: Self = Self(-32601); + pub const INVALID_PARAMS: Self = Self(-32602); + pub const INTERNAL_ERROR: Self = Self(-32603); + pub const PARSE_ERROR: Self = Self(-32700); +} + +/// Error information for JSON-RPC error responses. +/// +/// This structure follows the JSON-RPC 2.0 specification for error reporting, +/// providing a standardized way to communicate errors between clients and servers. +#[derive(Default, Debug, Serialize, Deserialize, Clone, PartialEq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct ErrorData { + /// The error type that occurred (using standard JSON-RPC error codes) + pub code: ErrorCode, + + /// A short description of the error. The message SHOULD be limited to a concise single sentence. + pub message: Cow<'static, str>, + + /// Additional information about the error. The value of this member is defined by the + /// sender (e.g. detailed error information, nested errors etc.). + #[serde(skip_serializing_if = "Option::is_none")] + pub data: Option, +} + +impl ErrorData { + const TRANSPORT_CLOSED_MARKER: &str = "io.modelcontextprotocol/transportClosed"; + + pub fn new( + code: ErrorCode, + message: impl Into>, + data: Option, + ) -> Self { + Self { + code, + message: message.into(), + data, + } + } + /// Resource-not-found error (`-32002`). The server upgrades this to `INVALID_PARAMS` + /// (`-32602`) for peers negotiating protocol `2026-07-28` or newer (SEP-2164). + pub fn resource_not_found(message: impl Into>, data: Option) -> Self { + Self::new(ErrorCode::RESOURCE_NOT_FOUND, message, data) + } + pub fn header_mismatch(message: impl Into>, data: Option) -> Self { + Self::new(ErrorCode::HEADER_MISMATCH, message, data) + } + /// Create an unsupported-protocol-version error. + pub fn unsupported_protocol_version( + requested: ProtocolVersion, + supported: &[ProtocolVersion], + ) -> Self { + Self::new( + ErrorCode::UNSUPPORTED_PROTOCOL_VERSION, + "Unsupported protocol version", + Some(serde_json::json!({ + "requested": requested, + "supported": supported, + })), + ) + } + /// Create a missing-required-capability error. + pub fn missing_required_client_capability(required: ClientCapabilities) -> Self { + Self::new( + ErrorCode::MISSING_REQUIRED_CLIENT_CAPABILITY, + "Missing required client capability", + Some(serde_json::json!({ + "requiredCapabilities": required, + })), + ) + } + pub fn parse_error(message: impl Into>, data: Option) -> Self { + Self::new(ErrorCode::PARSE_ERROR, message, data) + } + pub fn invalid_request(message: impl Into>, data: Option) -> Self { + Self::new(ErrorCode::INVALID_REQUEST, message, data) + } + pub fn method_not_found() -> Self { + Self::new(ErrorCode::METHOD_NOT_FOUND, M::VALUE, None) + } + pub fn invalid_params(message: impl Into>, data: Option) -> Self { + Self::new(ErrorCode::INVALID_PARAMS, message, data) + } + pub fn internal_error(message: impl Into>, data: Option) -> Self { + Self::new(ErrorCode::INTERNAL_ERROR, message, data) + } + + #[cfg(feature = "transport-streamable-http-client")] + pub(crate) fn transport_closed(message: impl Into>) -> Self { + let mut data = JsonObject::new(); + data.insert( + Self::TRANSPORT_CLOSED_MARKER.to_owned(), + Value::from(Self::transport_closed_token()), + ); + Self::internal_error(message, Some(Value::Object(data))) + } + + pub(crate) fn is_transport_closed(&self) -> bool { + self.data + .as_ref() + .and_then(|data| data.get(Self::TRANSPORT_CLOSED_MARKER)) + .and_then(Value::as_u64) + == Some(Self::transport_closed_token()) + } + + fn transport_closed_token() -> u64 { + static TOKEN: OnceLock = OnceLock::new(); + *TOKEN.get_or_init(|| { + let mut hasher = RandomState::new().build_hasher(); + hasher.write(b"rmcp transport-closed marker"); + hasher.finish() + }) + } +} + +/// Represents any JSON-RPC message that can be sent or received. +/// +/// This enum covers all possible message types in the JSON-RPC protocol: +/// individual requests/responses, notifications, and errors. +/// It serves as the top-level message container for MCP communication. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(untagged)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[expect(clippy::exhaustive_enums, reason = "intentionally exhaustive")] +pub enum JsonRpcMessage { + /// A single request expecting a response + Request(JsonRpcRequest), + /// A response to a previous request + Response(JsonRpcResponse), + /// A one-way notification (no response expected) + Notification(JsonRpcNotification), + /// An error response + Error(JsonRpcError), +} + +impl JsonRpcMessage { + #[inline] + pub const fn request(request: Req, id: RequestId) -> Self { + JsonRpcMessage::Request(JsonRpcRequest { + jsonrpc: JsonRpcVersion2_0, + id, + request, + }) + } + #[inline] + pub const fn response(response: Resp, id: RequestId) -> Self { + JsonRpcMessage::Response(JsonRpcResponse { + jsonrpc: JsonRpcVersion2_0, + id, + result: response, + }) + } + #[inline] + pub const fn error(error: ErrorData, id: Option) -> Self { + JsonRpcMessage::Error(JsonRpcError { + jsonrpc: JsonRpcVersion2_0, + id, + error, + }) + } + #[inline] + pub const fn notification(notification: Not) -> Self { + JsonRpcMessage::Notification(JsonRpcNotification { + jsonrpc: JsonRpcVersion2_0, + notification, + }) + } + pub fn into_request(self) -> Option<(Req, RequestId)> { + match self { + JsonRpcMessage::Request(r) => Some((r.request, r.id)), + _ => None, + } + } + pub fn into_response(self) -> Option<(Resp, RequestId)> { + match self { + JsonRpcMessage::Response(r) => Some((r.result, r.id)), + _ => None, + } + } + pub fn into_notification(self) -> Option { + match self { + JsonRpcMessage::Notification(n) => Some(n.notification), + _ => None, + } + } + pub fn into_error(self) -> Option<(ErrorData, Option)> { + match self { + JsonRpcMessage::Error(e) => Some((e.error, e.id)), + _ => None, + } + } + pub fn into_result(self) -> Option<(Result, Option)> { + match self { + JsonRpcMessage::Response(r) => Some((Ok(r.result), Some(r.id))), + JsonRpcMessage::Error(e) => Some((Err(e.error), e.id)), + + _ => None, + } + } +} + +// ============================================================================= +// INITIALIZATION AND CONNECTION SETUP +// ============================================================================= + +/// # Empty result +/// A response that indicates success but carries no data. +pub type EmptyResult = EmptyObject; + +impl From<()> for EmptyResult { + fn from(_value: ()) -> Self { + EmptyResult {} + } +} + +impl From for () { + fn from(_value: EmptyResult) {} +} + +/// Indicates the type of a result object, allowing the client to +/// determine how to parse the response. +/// +/// The spec defines this as an open string (`"complete" | "input_required" | string`), +/// so unknown values are preserved rather than rejected. Servers implementing this +/// protocol version MUST include `resultType` in every result. For backward +/// compatibility, clients MUST treat an absent field as `"complete"`. +/// +/// Ordinary results model the field as `Option`: `None` means the +/// field is absent on the wire. Constructors default to `Some(COMPLETE)`, and +/// the server handler strips the `"complete"` discriminator before responding +/// to peers that negotiated a protocol version older than `2026-07-28`, so +/// legacy sessions keep their historical wire shape (see +/// [`ServerResult::strip_result_type_for_legacy_peer`]). +#[derive(Debug, Clone, PartialEq, Eq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +pub struct ResultType(Cow<'static, str>); + +impl ResultType { + pub const COMPLETE: Self = Self(Cow::Borrowed("complete")); + pub const INPUT_REQUIRED: Self = Self(Cow::Borrowed("input_required")); + /// SEP-2663 Tasks extension: the result is a task handle ([`CreateTaskResult`]). + pub const TASK: Self = Self(Cow::Borrowed("task")); + + pub fn as_str(&self) -> &str { + &self.0 + } + + /// Returns `true` if this is `"input_required"`. + pub fn is_input_required(&self) -> bool { + self.0 == "input_required" + } + + /// Returns `true` if this is `"complete"`. + pub fn is_complete(&self) -> bool { + self.0 == "complete" + } + + /// Returns `true` if this is `"task"` (SEP-2663 Tasks extension). + pub fn is_task(&self) -> bool { + self.0 == "task" + } +} + +impl Default for ResultType { + fn default() -> Self { + Self::COMPLETE + } +} + +impl Serialize for ResultType { + fn serialize(&self, serializer: S) -> Result + where + S: serde::Serializer, + { + self.0.serialize(serializer) + } +} + +impl<'de> Deserialize<'de> for ResultType { + fn deserialize(deserializer: D) -> Result + where + D: serde::Deserializer<'de>, + { + let s: String = Deserialize::deserialize(deserializer)?; + match s.as_str() { + "complete" => Ok(Self::COMPLETE), + "input_required" => Ok(Self::INPUT_REQUIRED), + _ => Ok(Self(Cow::Owned(s))), + } + } +} + +impl std::fmt::Display for ResultType { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + self.0.fmt(f) + } +} + +/// A catch-all response either side can use for custom requests. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(transparent)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct CustomResult(pub Value); + +impl CustomResult { + pub fn new(result: Value) -> Self { + Self(result) + } + + /// Deserialize the result into a strongly-typed structure. + pub fn result_as(&self) -> Result { + serde_json::from_value(self.0.clone()) + } +} + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct CancelledNotificationParam { + #[serde(skip_serializing_if = "Option::is_none")] + pub request_id: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub reason: Option, + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, +} + +impl CancelledNotificationParam { + pub fn new(request_id: Option, reason: Option) -> Self { + Self { + request_id, + reason, + meta: None, + } + } +} + +const_string!(CancelledNotificationMethod = "notifications/cancelled"); + +/// # Cancellation +/// This notification can be sent by either side to indicate that it is cancelling a previously-issued request. +/// +/// The request SHOULD still be in-flight, but due to communication latency, it is always possible that this notification MAY arrive after the request has already finished. +/// +/// This notification indicates that the result will be unused, so any associated processing SHOULD cease. +/// +/// A client MUST NOT attempt to cancel its `initialize` request. +pub type CancelledNotification = + Notification; + +/// A catch-all notification either side can use to send custom messages to its peer. +/// +/// This preserves the raw `method` name and `params` payload so handlers can +/// deserialize them into domain-specific types. +#[derive(Debug, Clone)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct CustomNotification { + pub method: String, + pub params: Option, + /// extensions will carry anything possible in the context, including the metadata + /// ([`RequestMetaObject`] for requests, [`NotificationMetaObject`] for notifications) + /// + /// this is similar with the Extensions in `http` crate + #[cfg_attr(feature = "schemars", schemars(skip))] + pub extensions: Extensions, +} + +impl CustomNotification { + pub fn new(method: impl Into, params: Option) -> Self { + Self { + method: method.into(), + params, + extensions: Extensions::default(), + } + } + + /// Deserialize `params` into a strongly-typed structure. + pub fn params_as(&self) -> Result, serde_json::Error> { + self.params + .as_ref() + .map(|params| serde_json::from_value(params.clone())) + .transpose() + } +} + +/// A catch-all request either side can use to send custom messages to its peer. +/// +/// This preserves the raw `method` name and `params` payload so handlers can +/// deserialize them into domain-specific types. +#[derive(Debug, Clone)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct CustomRequest { + pub method: String, + pub params: Option, + /// extensions will carry anything possible in the context, including the metadata + /// ([`RequestMetaObject`] for requests, [`NotificationMetaObject`] for notifications) + /// + /// this is similar with the Extensions in `http` crate + #[cfg_attr(feature = "schemars", schemars(skip))] + pub extensions: Extensions, +} + +impl CustomRequest { + pub fn new(method: impl Into, params: Option) -> Self { + Self { + method: method.into(), + params, + extensions: Extensions::default(), + } + } + + /// Deserialize `params` into a strongly-typed structure. + pub fn params_as(&self) -> Result, serde_json::Error> { + self.params + .as_ref() + .map(|params| serde_json::from_value(params.clone())) + .transpose() + } +} + +const_string!(InitializeResultMethod = "initialize"); +/// # Initialization +/// This request is sent from the client to the server when it first connects, asking it to begin initialization. +pub type InitializeRequest = Request; + +const_string!(InitializedNotificationMethod = "notifications/initialized"); +/// This notification is sent from the client to the server after initialization has finished. +pub type InitializedNotification = NotificationNoParam; + +/// Parameters sent by a client when initializing a connection to an MCP server. +/// +/// This contains the client's protocol version, capabilities, and implementation +/// information, allowing the server to understand what the client supports. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct InitializeRequestParams { + /// Protocol-level metadata for this request (SEP-1319) + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + pub meta: Option, + /// The MCP protocol version this client supports + pub protocol_version: ProtocolVersion, + /// The capabilities this client supports (sampling, roots, etc.) + pub capabilities: ClientCapabilities, + /// Information about the client implementation + pub client_info: Implementation, +} + +impl InitializeRequestParams { + /// Create a new InitializeRequestParams. + pub fn new(capabilities: ClientCapabilities, client_info: Implementation) -> Self { + Self { + meta: None, + protocol_version: ProtocolVersion::default(), + capabilities, + client_info, + } + } + + pub fn with_protocol_version(mut self, protocol_version: ProtocolVersion) -> Self { + self.protocol_version = protocol_version; + self + } +} + +impl RequestParamsMeta for InitializeRequestParams { + fn meta(&self) -> Option<&RequestMetaObject> { + self.meta.as_ref() + } + fn meta_mut(&mut self) -> &mut Option { + &mut self.meta + } +} + +/// The server's response to an initialization request. +/// +/// Contains the server's protocol version, capabilities, and implementation +/// information, along with optional instructions for the client. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct InitializeResult { + /// The MCP protocol version this server supports + pub protocol_version: ProtocolVersion, + /// The capabilities this server provides (tools, resources, prompts, etc.) + pub capabilities: ServerCapabilities, + /// Information about the server implementation + pub server_info: Implementation, + /// Optional human-readable instructions about using this server + #[serde(skip_serializing_if = "Option::is_none")] + pub instructions: Option, + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, +} + +impl InitializeResult { + /// Create a new `InitializeResult` with default protocol version and the given capabilities. + pub fn new(capabilities: ServerCapabilities) -> Self { + Self { + protocol_version: ProtocolVersion::default(), + capabilities, + server_info: Implementation::from_build_env(), + instructions: None, + meta: None, + } + } + + /// Set instructions on this result. + pub fn with_instructions(mut self, instructions: impl Into) -> Self { + self.instructions = Some(instructions.into()); + self + } + + /// Set the server info on this result. + pub fn with_server_info(mut self, server_info: Implementation) -> Self { + self.server_info = server_info; + self + } + + /// Set the protocol version on this result. + pub fn with_protocol_version(mut self, protocol_version: ProtocolVersion) -> Self { + self.protocol_version = protocol_version; + self + } +} + +/// A server's own configuration: the protocol version, capabilities, +/// implementation identity, and instructions it advertises to clients. +/// +/// This is what `ServerHandler::get_info` returns. It is an alias for +/// [`InitializeResult`] because the same value is sent as the `initialize` +/// response on the wire. +/// +/// # Examples +/// +/// ``` +/// use rmcp::model::{ServerCapabilities, ServerConfig}; +/// +/// let config = ServerConfig::new(ServerCapabilities::builder().enable_tools().build()) +/// .with_instructions("Call `add` to sum two numbers."); +/// assert!(config.capabilities.tools.is_some()); +/// ``` +pub type ServerConfig = InitializeResult; + +/// A client's own configuration: the protocol version, capabilities, and +/// implementation identity it advertises to servers. +/// +/// This is what `ClientHandler::get_info` returns. It is an alias for +/// [`InitializeRequestParams`] because the same value is sent as the +/// `initialize` request on the wire. +/// +/// # Examples +/// +/// ``` +/// use rmcp::model::{ClientCapabilities, ClientConfig, Implementation}; +/// +/// let config = ClientConfig::new( +/// ClientCapabilities::builder().enable_elicitation().build(), +/// Implementation::new("my-client", "1.0.0"), +/// ); +/// assert!(config.capabilities.elicitation.is_some()); +/// ``` +pub type ClientConfig = InitializeRequestParams; + +/// Deprecated alias for [`ServerConfig`]. +/// +/// The name collides with the protocol's `serverInfo` field, which is only the +/// [`Implementation`] identity, so `server_info.server_info` was easy to +/// misread (#1082). +#[deprecated(note = "use `ServerConfig` instead")] +pub type ServerInfo = InitializeResult; + +/// Deprecated alias for [`ClientConfig`]. +/// +/// The name collides with the protocol's `clientInfo` field, which is only the +/// [`Implementation`] identity, so `client_info.client_info` was easy to +/// misread (#1082). +#[deprecated(note = "use `ClientConfig` instead")] +pub type ClientInfo = InitializeRequestParams; + +/// Information negotiated about a server peer. +/// +/// Unlike [`InitializeResult`], the server implementation identity is optional +/// because discovery responses are not required to provide it. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[non_exhaustive] +pub struct ServerPeerInfo { + /// The negotiated MCP protocol version. + pub protocol_version: ProtocolVersion, + /// The capabilities this server provides. + pub capabilities: ServerCapabilities, + /// Information about the server implementation, when provided. + #[serde(skip_serializing_if = "Option::is_none")] + pub server_info: Option, + /// Optional human-readable instructions about using this server. + #[serde(skip_serializing_if = "Option::is_none")] + pub instructions: Option, + /// Protocol-level response metadata. + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, +} + +impl ServerPeerInfo { + /// Create peer information without a server implementation identity. + pub fn new(protocol_version: ProtocolVersion, capabilities: ServerCapabilities) -> Self { + Self { + protocol_version, + capabilities, + server_info: None, + instructions: None, + meta: None, + } + } + + /// Set the server implementation identity. + pub fn with_server_info(mut self, server_info: Implementation) -> Self { + self.server_info = Some(server_info); + self + } + + /// Set instructions supplied by the server. + pub fn with_instructions(mut self, instructions: impl Into) -> Self { + self.instructions = Some(instructions.into()); + self + } +} + +impl From for ServerPeerInfo { + fn from(result: InitializeResult) -> Self { + Self { + protocol_version: result.protocol_version, + capabilities: result.capabilities, + server_info: Some(result.server_info), + instructions: result.instructions, + meta: result.meta, + } + } +} + +const_string!(DiscoverRequestMethod = "server/discover"); + +/// Parameters for [`DiscoverRequest`]. +#[derive(Debug, Serialize, Deserialize, Clone, Copy, PartialEq, Eq, Default)] +#[serde(deny_unknown_fields)] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct DiscoverRequestParams {} + +#[cfg(feature = "schemars")] +#[derive(schemars::JsonSchema)] +#[expect(dead_code, reason = "schema-only representation of request parameters")] +struct DiscoverRequestParamsSchema { + #[schemars(rename = "_meta")] + meta: RequestMetaObject, +} + +#[cfg(feature = "schemars")] +impl schemars::JsonSchema for DiscoverRequestParams { + fn schema_name() -> Cow<'static, str> { + Cow::Borrowed("DiscoverRequestParams") + } + + fn json_schema(generator: &mut schemars::SchemaGenerator) -> schemars::Schema { + DiscoverRequestParamsSchema::json_schema(generator) + } +} + +/// A request for the server's supported protocol versions and capabilities. +pub type DiscoverRequest = Request; + +/// The server's response to a [`DiscoverRequest`]. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[serde(rename_all = "camelCase")] +#[non_exhaustive] +pub struct DiscoverResult { + /// Identifies how the result should be parsed. + pub result_type: ResultType, + /// Protocol versions implemented by this server. + pub supported_versions: Vec, + /// Capabilities provided by this server. + pub capabilities: ServerCapabilities, + /// Optional guidance for using the server. + #[serde(skip_serializing_if = "Option::is_none")] + pub instructions: Option, + /// How long clients may consider this response fresh, in milliseconds. + pub ttl_ms: u64, + /// Whether the cached result may be shared across authorization contexts. + pub cache_scope: CacheScope, + /// Protocol-level response metadata. + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, +} + +const SERVER_INFO_META_KEY: &str = "io.modelcontextprotocol/serverInfo"; + +fn server_info_from_meta(meta: &MetaObject) -> Option { + meta.get(SERVER_INFO_META_KEY) + .and_then(|value| serde_json::from_value(value.clone()).ok()) +} + +fn set_server_info_on_meta(meta: &mut MetaObject, server_info: Implementation) { + let server_info = + serde_json::to_value(server_info).expect("Implementation serialization cannot fail"); + meta.insert(SERVER_INFO_META_KEY.to_owned(), server_info); +} + +impl DiscoverResult { + /// Create a non-cacheable private discovery result. + pub fn new(supported_versions: Vec, capabilities: ServerCapabilities) -> Self { + Self { + result_type: ResultType::COMPLETE, + supported_versions, + capabilities, + instructions: None, + ttl_ms: 0, + cache_scope: CacheScope::Private, + meta: None, + } + } + + /// Return the server implementation information stored in result metadata. + pub fn server_info(&self) -> Option { + server_info_from_meta(self.meta.as_ref()?) + } + + /// Store server implementation information in result metadata. + pub fn set_server_info(&mut self, server_info: Implementation) { + set_server_info_on_meta(self.meta.get_or_insert_default(), server_info); + } + + /// Store server implementation information in result metadata. + pub fn with_server_info(mut self, server_info: Implementation) -> Self { + self.set_server_info(server_info); + self + } + + /// Create a discovery result from the server's configuration. + pub fn from_server_info( + supported_versions: Vec, + server_config: ServerConfig, + ) -> Self { + let ServerConfig { + capabilities, + server_info, + instructions, + meta, + .. + } = server_config; + let mut result = Self { + result_type: ResultType::COMPLETE, + supported_versions, + capabilities, + instructions, + ttl_ms: 0, + cache_scope: CacheScope::Private, + meta, + }; + result.set_server_info(server_info); + result + } + + /// Set the cache lifetime hint in milliseconds. + pub fn with_ttl_ms(mut self, ttl_ms: u64) -> Self { + self.ttl_ms = ttl_ms; + self + } + + /// Set the cache scope. + pub fn with_cache_scope(mut self, cache_scope: CacheScope) -> Self { + self.cache_scope = cache_scope; + self + } +} + +impl ServerPeerInfo { + /// Create peer information from a discovery result and the selected version. + pub fn from_discover_result(protocol_version: ProtocolVersion, result: DiscoverResult) -> Self { + let server_info = result.server_info(); + Self { + protocol_version, + capabilities: result.capabilities, + server_info, + instructions: result.instructions, + meta: result.meta, + } + } +} + +#[allow(clippy::derivable_impls)] +impl Default for InitializeResult { + fn default() -> Self { + InitializeResult { + protocol_version: ProtocolVersion::default(), + capabilities: ServerCapabilities::default(), + server_info: Implementation::from_build_env(), + instructions: None, + meta: None, + } + } +} + +#[allow(clippy::derivable_impls)] +impl Default for InitializeRequestParams { + fn default() -> Self { + InitializeRequestParams { + meta: None, + protocol_version: ProtocolVersion::default(), + capabilities: ClientCapabilities::default(), + client_info: Implementation::from_build_env(), + } + } +} + +/// Icon themes supported by the MCP specification +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq, Hash, Copy)] +#[serde(rename_all = "lowercase")] //match spec +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub enum IconTheme { + /// Indicates the icon is designed to be used with a light background + Light, + /// Indicates the icon is designed to be used with a dark background + Dark, +} + +/// A URL pointing to an icon resource or a base64-encoded data URI. +/// +/// Clients that support rendering icons MUST support at least the following MIME types: +/// - image/png - PNG images (safe, universal compatibility) +/// - image/jpeg (and image/jpg) - JPEG images (safe, universal compatibility) +/// +/// Clients that support rendering icons SHOULD also support: +/// - image/svg+xml - SVG images (scalable but requires security precautions) +/// - image/webp - WebP images (modern, efficient format) +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct Icon { + /// A standard URI pointing to an icon resource + pub src: String, + /// Optional override if the server's MIME type is missing or generic + #[serde(skip_serializing_if = "Option::is_none")] + pub mime_type: Option, + /// Size specification, each string should be in WxH format (e.g., `\"48x48\"`, `\"96x96\"`) or `\"any\"` for scalable formats like SVG + #[serde(skip_serializing_if = "Option::is_none")] + pub sizes: Option>, + /// Optional specifier for the theme this icon is designed for + /// If not provided, the client should assume the icon can be used with any theme. + #[serde(skip_serializing_if = "Option::is_none")] + pub theme: Option, +} + +impl Icon { + /// Create a new Icon with the given source URL. + pub fn new(src: impl Into) -> Self { + Self { + src: src.into(), + mime_type: None, + sizes: None, + theme: None, + } + } + + /// Set the MIME type. + pub fn with_mime_type(mut self, mime_type: impl Into) -> Self { + self.mime_type = Some(mime_type.into()); + self + } + + /// Set the sizes. + pub fn with_sizes(mut self, sizes: Vec) -> Self { + self.sizes = Some(sizes); + self + } + + /// Set the theme. + pub fn with_theme(mut self, theme: IconTheme) -> Self { + self.theme = Some(theme); + self + } +} + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct Implementation { + pub name: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + pub version: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub icons: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub website_url: Option, +} + +impl Default for Implementation { + fn default() -> Self { + Self::from_build_env() + } +} + +impl Implementation { + /// Create a new Implementation. + pub fn new(name: impl Into, version: impl Into) -> Self { + Self { + name: name.into(), + title: None, + version: version.into(), + description: None, + icons: None, + website_url: None, + } + } + + pub fn from_build_env() -> Self { + Implementation { + name: env!("CARGO_CRATE_NAME").to_owned(), + title: None, + version: env!("CARGO_PKG_VERSION").to_owned(), + description: None, + icons: None, + website_url: None, + } + } + + /// Set the human-readable title. + pub fn with_title(mut self, title: impl Into) -> Self { + self.title = Some(title.into()); + self + } + + /// Set the description. + pub fn with_description(mut self, description: impl Into) -> Self { + self.description = Some(description.into()); + self + } + + /// Set the icons. + pub fn with_icons(mut self, icons: Vec) -> Self { + self.icons = Some(icons); + self + } + + /// Set the website URL. + pub fn with_website_url(mut self, website_url: impl Into) -> Self { + self.website_url = Some(website_url.into()); + self + } +} + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct PaginatedRequestParams { + /// Protocol-level metadata for this request (SEP-1319) + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + pub meta: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub cursor: Option, +} + +impl PaginatedRequestParams { + pub fn with_cursor(mut self, cursor: Option) -> Self { + self.cursor = cursor; + self + } +} + +impl RequestParamsMeta for PaginatedRequestParams { + fn meta(&self) -> Option<&RequestMetaObject> { + self.meta.as_ref() + } + fn meta_mut(&mut self) -> &mut Option { + &mut self.meta + } +} + +// ============================================================================= +// PROGRESS AND PAGINATION +// ============================================================================= + +const_string!(PingRequestMethod = "ping"); +pub type PingRequest = RequestNoParam; + +const_string!(ProgressNotificationMethod = "notifications/progress"); +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct ProgressNotificationParam { + pub progress_token: ProgressToken, + /// The progress thus far. This should increase every time progress is made, even if the total is unknown. + #[serde(deserialize_with = "serde_impl::json_float::f64")] + pub progress: f64, + /// Total number of items to process (or total progress required), if known + #[serde( + default, + deserialize_with = "serde_impl::json_float::option_f64", + skip_serializing_if = "Option::is_none" + )] + pub total: Option, + /// An optional message describing the current progress. + #[serde(skip_serializing_if = "Option::is_none")] + pub message: Option, + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, +} + +impl ProgressNotificationParam { + /// Create a new ProgressNotificationParam with required fields. + pub fn new(progress_token: ProgressToken, progress: f64) -> Self { + Self { + progress_token, + progress, + total: None, + message: None, + meta: None, + } + } + + /// Set the total number of items to process. + pub fn with_total(mut self, total: f64) -> Self { + self.total = Some(total); + self + } + + /// Set a message describing the current progress. + pub fn with_message(mut self, message: impl Into) -> Self { + self.message = Some(message.into()); + self + } +} + +pub type ProgressNotification = Notification; + +pub type Cursor = String; + +/// Scope describing who may cache cacheable list/read results (SEP-2549). +/// +/// Defaults to [`CacheScope::Public`] when absent from the wire. +#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[serde(rename_all = "lowercase")] +#[non_exhaustive] +pub enum CacheScope { + /// Any client or intermediary may cache and serve the response to any user. + #[default] + Public, + /// Only the requesting user's client may cache the response. + Private, +} + +/// Normalize a `ttlMs` value during deserialization. +/// +/// Per SEP-2549, `ttlMs` MUST be `>= 0`; if a server returns a negative value, +/// clients SHOULD treat it as `0` (immediately stale). This tolerates that case +/// rather than erroring, while still accepting an absent field as `None`. +fn deserialize_ttl_ms<'de, D>(deserializer: D) -> Result, D::Error> +where + D: serde::Deserializer<'de>, +{ + let value = Option::::deserialize(deserializer)?; + Ok(value.map(|ttl_ms| ttl_ms.max(0) as u64)) +} + +/// Normalize a `cacheScope` value during deserialization. +/// +/// Per SEP-2549, `cacheScope` MUST be `"public"`, `"private"`, or absent; some +/// servers instead send `""`. Because `ServerResult` is `#[serde(untagged)]`, +/// letting that value hard-error here would silently fall through to +/// `CustomResult` and drop the entire (otherwise valid) result. Treat an empty +/// string the same as an absent field rather than erroring. +fn deserialize_cache_scope<'de, D>(deserializer: D) -> Result, D::Error> +where + D: serde::Deserializer<'de>, +{ + let value = Option::::deserialize(deserializer)?; + match value { + None | Some(Value::Null) => Ok(None), + Some(Value::String(s)) if s.is_empty() => Ok(None), + Some(value) => CacheScope::deserialize(value) + .map(Some) + .map_err(serde::de::Error::custom), + } +} + +macro_rules! paginated_result { + ($t:ident { + $i_item: ident: $t_item: ty + }) => { + #[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] + #[serde(rename_all = "camelCase")] + #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] + #[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] + pub struct $t { + /// Result type discriminator (SEP-2322). Required by the [spec schema] + /// for servers implementing protocol version `2026-07-28`, but optional + /// here because this type also models results from older protocol + /// versions, which do not carry the field: `None` means absent on the + /// wire, and per the spec "the client MUST treat the absent field as + /// `"complete"`". Constructors default to `Some(ResultType::COMPLETE)`; + /// the server handler clears the field when responding to peers that + /// negotiated an older version. + /// + /// [spec schema]: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/271ecc9accafdd9b83a3c869fa67c22953b2af80/schema/2026-07-28/schema.ts#L219-L235 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub result_type: Option, + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + pub meta: Option, + #[serde(default, skip_serializing_if = "Option::is_none")] + pub next_cursor: Option, + /// Time, in milliseconds, that this result may be treated as fresh (SEP-2549). + /// Required by spec version 2026-07-28, but optional here to maintain compatibility + /// with older spec versions. + #[serde( + default, + deserialize_with = "deserialize_ttl_ms", + skip_serializing_if = "Option::is_none" + )] + pub ttl_ms: Option, + /// Scope describing who may cache this result (SEP-2549). + /// Required by spec version 2026-07-28, but optional here to maintain compatibility + /// with older spec versions. + #[serde( + default, + deserialize_with = "deserialize_cache_scope", + skip_serializing_if = "Option::is_none" + )] + pub cache_scope: Option, + pub $i_item: $t_item, + } + + impl Default for $t { + fn default() -> Self { + Self::with_all_items(Default::default()) + } + } + + impl $t { + pub fn with_all_items(items: $t_item) -> Self { + Self { + result_type: Some(ResultType::COMPLETE), + meta: None, + next_cursor: None, + ttl_ms: None, + cache_scope: None, + $i_item: items, + } + } + + /// Set the time, in milliseconds, that this result may be treated as fresh. + pub fn with_ttl_ms(mut self, ttl_ms: u64) -> Self { + self.ttl_ms = Some(ttl_ms); + self + } + + /// Set the cache scope for this result. + pub fn with_cache_scope(mut self, cache_scope: CacheScope) -> Self { + self.cache_scope = Some(cache_scope); + self + } + } + }; +} + +// ============================================================================= +// RESOURCE MANAGEMENT +// ============================================================================= + +const_string!(ListResourcesRequestMethod = "resources/list"); +/// Request to list all available resources from a server +pub type ListResourcesRequest = + RequestOptionalParam; + +paginated_result!(ListResourcesResult { + resources: Vec +}); + +const_string!(ListResourceTemplatesRequestMethod = "resources/templates/list"); +/// Request to list all available resource templates from a server +pub type ListResourceTemplatesRequest = + RequestOptionalParam; + +paginated_result!(ListResourceTemplatesResult { + resource_templates: Vec +}); + +const_string!(ReadResourceRequestMethod = "resources/read"); +/// Parameters for reading a specific resource +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct ReadResourceRequestParams { + /// Protocol-level metadata for this request (SEP-1319) + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + pub meta: Option, + /// The URI of the resource to read + pub uri: String, + /// Client responses to server-initiated input requests from a previous + /// [`InputRequiredResult`]. + #[serde(skip_serializing_if = "Option::is_none")] + pub input_responses: Option, + /// Opaque request state echoed back from a previous [`InputRequiredResult`]. + #[serde(skip_serializing_if = "Option::is_none")] + pub request_state: Option, +} + +impl ReadResourceRequestParams { + /// Create a new ReadResourceRequestParams with the given URI. + pub fn new(uri: impl Into) -> Self { + Self { + meta: None, + uri: uri.into(), + input_responses: None, + request_state: None, + } + } + + /// Set the metadata for this request. + pub fn with_meta(mut self, meta: RequestMetaObject) -> Self { + self.meta = Some(meta); + self + } + + /// Sets the input responses for an MRTR retry. + pub fn with_input_responses(mut self, input_responses: InputResponses) -> Self { + self.input_responses = Some(input_responses); + self + } + + /// Sets the request state for an MRTR retry. + pub fn with_request_state(mut self, request_state: impl Into) -> Self { + self.request_state = Some(request_state.into()); + self + } +} + +impl RequestParamsMeta for ReadResourceRequestParams { + fn meta(&self) -> Option<&RequestMetaObject> { + self.meta.as_ref() + } + fn meta_mut(&mut self) -> &mut Option { + &mut self.meta + } +} + +/// Result containing the contents of a read resource +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct ReadResourceResult { + /// Result type discriminator (SEP-2322). Required by the [spec schema] + /// for servers implementing protocol version `2026-07-28`, but optional + /// here because this type also models results from older protocol + /// versions, which do not carry the field: `None` means absent on the + /// wire, and per the spec "the client MUST treat the absent field as + /// `"complete"`". Constructors default to `Some(ResultType::COMPLETE)`; + /// the server handler clears the field when responding to peers that + /// negotiated an older version. + /// + /// [spec schema]: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/271ecc9accafdd9b83a3c869fa67c22953b2af80/schema/2026-07-28/schema.ts#L219-L235 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub result_type: Option, + /// Time, in milliseconds, that this result may be treated as fresh (SEP-2549). + /// Required by spec version 2026-07-28, but optional here to maintain compatibility + /// with older spec versions. + #[serde( + default, + deserialize_with = "deserialize_ttl_ms", + skip_serializing_if = "Option::is_none" + )] + pub ttl_ms: Option, + /// Scope describing who may cache this result (SEP-2549). + /// Required by spec version 2026-07-28, but optional here to maintain compatibility + /// with older spec versions. + #[serde( + default, + deserialize_with = "deserialize_cache_scope", + skip_serializing_if = "Option::is_none" + )] + pub cache_scope: Option, + /// The actual content of the resource + pub contents: Vec, + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, +} + +impl ReadResourceResult { + /// Create a new ReadResourceResult with the given contents. + pub fn new(contents: Vec) -> Self { + Self { + result_type: Some(ResultType::COMPLETE), + ttl_ms: None, + cache_scope: None, + contents, + meta: None, + } + } + + /// Set the time, in milliseconds, that this result may be treated as fresh. + pub fn with_ttl_ms(mut self, ttl_ms: u64) -> Self { + self.ttl_ms = Some(ttl_ms); + self + } + + /// Set the cache scope for this result. + pub fn with_cache_scope(mut self, cache_scope: CacheScope) -> Self { + self.cache_scope = Some(cache_scope); + self + } +} + +/// Request to read a specific resource +pub type ReadResourceRequest = Request; + +const_string!(ResourceListChangedNotificationMethod = "notifications/resources/list_changed"); +/// Notification sent when the list of available resources changes +pub type ResourceListChangedNotification = + NotificationNoParam; + +const_string!(SubscribeRequestMethod = "resources/subscribe"); +/// Parameters for subscribing to resource updates +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct SubscribeRequestParams { + /// Protocol-level metadata for this request (SEP-1319) + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + pub meta: Option, + /// The URI of the resource to subscribe to + pub uri: String, +} + +impl SubscribeRequestParams { + /// Create a new SubscribeRequestParams. + pub fn new(uri: impl Into) -> Self { + Self { + meta: None, + uri: uri.into(), + } + } +} + +impl RequestParamsMeta for SubscribeRequestParams { + fn meta(&self) -> Option<&RequestMetaObject> { + self.meta.as_ref() + } + fn meta_mut(&mut self) -> &mut Option { + &mut self.meta + } +} + +/// Request to subscribe to resource updates +#[deprecated( + note = "resources/subscribe is legacy-only; use subscriptions/listen for protocol version 2026-07-28" +)] +pub type SubscribeRequest = Request; + +const_string!(UnsubscribeRequestMethod = "resources/unsubscribe"); +/// Parameters for unsubscribing from resource updates +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct UnsubscribeRequestParams { + /// Protocol-level metadata for this request (SEP-1319) + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + pub meta: Option, + /// The URI of the resource to unsubscribe from + pub uri: String, +} + +impl UnsubscribeRequestParams { + /// Creates a new `UnsubscribeRequestParams` for the given URI. + pub fn new(uri: impl Into) -> Self { + Self { + meta: None, + uri: uri.into(), + } + } +} + +impl RequestParamsMeta for UnsubscribeRequestParams { + fn meta(&self) -> Option<&RequestMetaObject> { + self.meta.as_ref() + } + fn meta_mut(&mut self) -> &mut Option { + &mut self.meta + } +} + +/// Request to unsubscribe from resource updates +#[deprecated( + note = "resources/unsubscribe is legacy-only; cancel the subscriptions/listen request for protocol version 2026-07-28" +)] +pub type UnsubscribeRequest = Request; + +const_string!(ResourceUpdatedNotificationMethod = "notifications/resources/updated"); +/// Parameters for a resource update notification +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct ResourceUpdatedNotificationParam { + /// The URI of the resource that was updated + pub uri: String, + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, +} + +impl ResourceUpdatedNotificationParam { + /// Create a new ResourceUpdatedNotificationParam. + pub fn new(uri: impl Into) -> Self { + Self { + uri: uri.into(), + meta: None, + } + } +} + +/// Notification sent when a subscribed resource is updated +pub type ResourceUpdatedNotification = + Notification; + +// ============================================================================= +// SUBSCRIPTIONS +// ============================================================================= + +/// Notification categories a client opts in to on a `subscriptions/listen` stream. +#[derive(Debug, Default, Serialize, Deserialize, Clone, PartialEq, Eq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct SubscriptionFilter { + #[serde(default, skip_serializing_if = "Option::is_none")] + #[cfg_attr(feature = "schemars", schemars(with = "bool"))] + pub tools_list_changed: Option, + #[serde(default, skip_serializing_if = "Option::is_none")] + #[cfg_attr(feature = "schemars", schemars(with = "bool"))] + pub prompts_list_changed: Option, + #[serde(default, skip_serializing_if = "Option::is_none")] + #[cfg_attr(feature = "schemars", schemars(with = "bool"))] + pub resources_list_changed: Option, + #[serde(default, skip_serializing_if = "Option::is_none")] + #[cfg_attr(feature = "schemars", schemars(with = "Vec"))] + pub resource_subscriptions: Option>, +} + +impl SubscriptionFilter { + /// Create an empty filter that opts in to no notifications. + pub fn new() -> Self { + Self::default() + } + + /// Create a builder for a subscription filter. + pub fn builder() -> SubscriptionFilterBuilder { + SubscriptionFilterBuilder::default() + } + + /// Return the subset present in both filters. + pub fn intersection(&self, other: &Self) -> Self { + let resource_subscriptions = self + .resource_subscriptions + .as_ref() + .and_then(|requested| { + other.resource_subscriptions.as_ref().map(|accepted| { + requested + .iter() + .filter(|uri| accepted.contains(uri)) + .cloned() + .collect() + }) + }) + .filter(|uris: &Vec| !uris.is_empty()); + Self { + tools_list_changed: (self.tools_list_changed == Some(true) + && other.tools_list_changed == Some(true)) + .then_some(true), + prompts_list_changed: (self.prompts_list_changed == Some(true) + && other.prompts_list_changed == Some(true)) + .then_some(true), + resources_list_changed: (self.resources_list_changed == Some(true) + && other.resources_list_changed == Some(true)) + .then_some(true), + resource_subscriptions, + } + } + + /// Return whether this filter accepts only notifications requested by `other`. + pub fn is_subset_of(&self, other: &Self) -> bool { + let booleans_are_subset = [ + (self.tools_list_changed, other.tools_list_changed), + (self.prompts_list_changed, other.prompts_list_changed), + (self.resources_list_changed, other.resources_list_changed), + ] + .into_iter() + .all(|(accepted, requested)| accepted != Some(true) || requested == Some(true)); + let resources_are_subset = self.resource_subscriptions.as_ref().is_none_or(|accepted| { + accepted.iter().all(|uri| { + other + .resource_subscriptions + .as_ref() + .is_some_and(|requested| requested.contains(uri)) + }) + }); + booleans_are_subset && resources_are_subset + } + + /// Return the requested notification types advertised by server capabilities. + pub fn supported_by(&self, capabilities: &ServerCapabilities) -> Self { + Self { + tools_list_changed: (self.tools_list_changed == Some(true) + && capabilities + .tools + .as_ref() + .is_some_and(|tools| tools.list_changed == Some(true))) + .then_some(true), + prompts_list_changed: (self.prompts_list_changed == Some(true) + && capabilities + .prompts + .as_ref() + .is_some_and(|prompts| prompts.list_changed == Some(true))) + .then_some(true), + resources_list_changed: (self.resources_list_changed == Some(true) + && capabilities + .resources + .as_ref() + .is_some_and(|resources| resources.list_changed == Some(true))) + .then_some(true), + resource_subscriptions: capabilities + .resources + .as_ref() + .is_some_and(|resources| resources.subscribe == Some(true)) + .then(|| self.resource_subscriptions.clone()) + .flatten(), + } + } +} + +/// Builder for [`SubscriptionFilter`]. +#[derive(Debug, Default)] +#[non_exhaustive] +pub struct SubscriptionFilterBuilder { + filter: SubscriptionFilter, +} + +impl SubscriptionFilterBuilder { + /// Opt in to `notifications/tools/list_changed`. + pub fn tools_list_changed(mut self) -> Self { + self.filter.tools_list_changed = Some(true); + self + } + + /// Opt in to `notifications/prompts/list_changed`. + pub fn prompts_list_changed(mut self) -> Self { + self.filter.prompts_list_changed = Some(true); + self + } + + /// Opt in to `notifications/resources/list_changed`. + pub fn resources_list_changed(mut self) -> Self { + self.filter.resources_list_changed = Some(true); + self + } + + /// Opt in to updates for all supplied resource URIs. + pub fn resource_subscriptions( + mut self, + uris: impl IntoIterator>, + ) -> Self { + self.filter.resource_subscriptions = Some(uris.into_iter().map(Into::into).collect()); + self + } + + /// Add one resource URI to the update subscription set. + pub fn resource_subscription(mut self, uri: impl Into) -> Self { + self.filter + .resource_subscriptions + .get_or_insert_default() + .push(uri.into()); + self + } + + /// Build the filter. + pub fn build(self) -> SubscriptionFilter { + self.filter + } +} + +const_string!(SubscriptionsListenRequestMethod = "subscriptions/listen"); + +#[cfg(feature = "schemars")] +fn subscriptions_listen_request_meta_schema( + generator: &mut schemars::SchemaGenerator, +) -> schemars::Schema { + let progress_token = generator.subschema_for::(); + let client_info = generator.subschema_for::(); + let client_capabilities = generator.subschema_for::(); + let log_level = generator.subschema_for::(); + schemars::json_schema!({ + "type": "object", + "properties": { + "progressToken": progress_token, + "io.modelcontextprotocol/protocolVersion": { + "type": "string", + }, + "io.modelcontextprotocol/clientInfo": client_info, + "io.modelcontextprotocol/clientCapabilities": client_capabilities, + "io.modelcontextprotocol/logLevel": log_level, + }, + "required": RequestMetaObject::DRAFT_REQUIRED_KEYS, + "additionalProperties": true, + }) +} + +/// Parameters for opening a long-lived notification subscription. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct SubscriptionsListenRequestParams { + /// Protocol-level metadata. Required by the 2026-07-28 wire schema. + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + #[cfg_attr( + feature = "schemars", + schemars(required, schema_with = "subscriptions_listen_request_meta_schema") + )] + pub meta: Option, + /// Notification categories requested for this stream. + pub notifications: SubscriptionFilter, +} + +impl SubscriptionsListenRequestParams { + /// Create listen parameters for a notification filter. + pub fn new(notifications: SubscriptionFilter) -> Self { + Self { + meta: None, + notifications, + } + } + + /// Set protocol-level request metadata. + pub fn with_meta(mut self, meta: RequestMetaObject) -> Self { + self.meta = Some(meta); + self + } +} + +impl RequestParamsMeta for SubscriptionsListenRequestParams { + fn meta(&self) -> Option<&RequestMetaObject> { + self.meta.as_ref() + } + + fn meta_mut(&mut self) -> &mut Option { + &mut self.meta + } +} + +/// Request that opens a long-lived notification subscription. +pub type SubscriptionsListenRequest = + Request; + +const SUBSCRIPTION_ID_META_KEY: &str = "io.modelcontextprotocol/subscriptionId"; + +/// Metadata on the final result of a `subscriptions/listen` request. +#[derive(Debug, Serialize, Clone, PartialEq)] +#[serde(transparent)] +#[non_exhaustive] +pub struct SubscriptionsListenResultMeta(MetaObject); + +impl SubscriptionsListenResultMeta { + /// Create result metadata for the originating listen request. + pub fn new(subscription_id: RequestId) -> Self { + let mut meta = MetaObject::new(); + meta.insert( + SUBSCRIPTION_ID_META_KEY.to_owned(), + subscription_id.into_json_value(), + ); + Self(meta) + } + + /// Return the originating listen request ID, if the metadata remains valid. + pub fn subscription_id(&self) -> Option { + self.0 + .get(SUBSCRIPTION_ID_META_KEY) + .and_then(|value| RequestId::deserialize(value).ok()) + } + + /// Replace the originating listen request ID. + pub fn set_subscription_id(&mut self, subscription_id: RequestId) { + self.0.insert( + SUBSCRIPTION_ID_META_KEY.to_owned(), + subscription_id.into_json_value(), + ); + } + + /// Return the server implementation information stored in result metadata. + pub fn server_info(&self) -> Option { + server_info_from_meta(&self.0) + } + + /// Store server implementation information in result metadata. + pub fn set_server_info(&mut self, server_info: Implementation) { + set_server_info_on_meta(&mut self.0, server_info); + } +} + +impl<'de> Deserialize<'de> for SubscriptionsListenResultMeta { + fn deserialize(deserializer: D) -> Result + where + D: serde::Deserializer<'de>, + { + let meta = MetaObject::deserialize(deserializer)?; + let Some(value) = meta.get(SUBSCRIPTION_ID_META_KEY) else { + return Err(serde::de::Error::missing_field(SUBSCRIPTION_ID_META_KEY)); + }; + RequestId::deserialize(value).map_err(serde::de::Error::custom)?; + Ok(Self(meta)) + } +} + +impl std::ops::Deref for SubscriptionsListenResultMeta { + type Target = MetaObject; + + fn deref(&self) -> &Self::Target { + &self.0 + } +} + +impl std::ops::DerefMut for SubscriptionsListenResultMeta { + fn deref_mut(&mut self) -> &mut Self::Target { + &mut self.0 + } +} + +#[cfg(feature = "schemars")] +impl schemars::JsonSchema for SubscriptionsListenResultMeta { + fn schema_name() -> Cow<'static, str> { + Cow::Borrowed("SubscriptionsListenResultMeta") + } + + fn json_schema(generator: &mut schemars::SchemaGenerator) -> schemars::Schema { + let subscription_id = generator.subschema_for::(); + let server_info = generator.subschema_for::(); + schemars::json_schema!({ + "type": "object", + "properties": { + "io.modelcontextprotocol/serverInfo": { + "description": "Identifies the server software producing the response. Servers SHOULD include this field on every response unless specifically configured not to do so.", + "allOf": [server_info], + }, + "io.modelcontextprotocol/subscriptionId": subscription_id, + }, + "required": ["io.modelcontextprotocol/subscriptionId"], + "additionalProperties": true, + }) + } +} + +/// Final response indicating that a subscription ended gracefully. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct SubscriptionsListenResult { + pub result_type: ResultType, + #[serde(rename = "_meta")] + pub meta: SubscriptionsListenResultMeta, +} + +impl SubscriptionsListenResult { + /// Create a completed subscription result. + pub fn new(meta: SubscriptionsListenResultMeta) -> Self { + Self { + result_type: ResultType::COMPLETE, + meta, + } + } + + /// Create a completed result for the originating listen request. + pub fn complete(subscription_id: RequestId) -> Self { + Self::new(SubscriptionsListenResultMeta::new(subscription_id)) + } +} + +const_string!( + SubscriptionsAcknowledgedNotificationMethod = "notifications/subscriptions/acknowledged" +); + +/// Parameters reporting the accepted subset of a subscription filter. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct SubscriptionsAcknowledgedNotificationParams { + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + #[cfg_attr(feature = "schemars", schemars(with = "NotificationMetaObject"))] + pub meta: Option, + pub notifications: SubscriptionFilter, +} + +impl SubscriptionsAcknowledgedNotificationParams { + /// Create acknowledgment parameters for the accepted filter. + pub fn new(notifications: SubscriptionFilter) -> Self { + Self { + meta: None, + notifications, + } + } + + /// Set notification metadata. + pub fn with_meta(mut self, meta: NotificationMetaObject) -> Self { + self.meta = Some(meta); + self + } +} + +/// First notification sent on an established subscription stream. +pub type SubscriptionsAcknowledgedNotification = Notification< + SubscriptionsAcknowledgedNotificationMethod, + SubscriptionsAcknowledgedNotificationParams, +>; + +// ============================================================================= +// PROMPT MANAGEMENT +// ============================================================================= + +const_string!(ListPromptsRequestMethod = "prompts/list"); +/// Request to list all available prompts from a server +pub type ListPromptsRequest = + RequestOptionalParam; + +paginated_result!(ListPromptsResult { + prompts: Vec +}); + +const_string!(GetPromptRequestMethod = "prompts/get"); +/// Parameters for retrieving a specific prompt +#[derive(Default, Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct GetPromptRequestParams { + /// Protocol-level metadata for this request (SEP-1319) + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + pub meta: Option, + pub name: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub arguments: Option, + /// Client responses to server-initiated input requests from a previous + /// [`InputRequiredResult`]. + #[serde(skip_serializing_if = "Option::is_none")] + pub input_responses: Option, + /// Opaque request state echoed back from a previous [`InputRequiredResult`]. + #[serde(skip_serializing_if = "Option::is_none")] + pub request_state: Option, +} + +impl GetPromptRequestParams { + /// Create a new `GetPromptRequestParams` with the given prompt name. + pub fn new(name: impl Into) -> Self { + Self { + meta: None, + name: name.into(), + arguments: None, + input_responses: None, + request_state: None, + } + } + + /// Set the arguments for this prompt request. + pub fn with_arguments(mut self, arguments: JsonObject) -> Self { + self.arguments = Some(arguments); + self + } + + /// Set the metadata for this request. + pub fn with_meta(mut self, meta: RequestMetaObject) -> Self { + self.meta = Some(meta); + self + } + + /// Sets the input responses for an MRTR retry. + pub fn with_input_responses(mut self, input_responses: InputResponses) -> Self { + self.input_responses = Some(input_responses); + self + } + + /// Sets the request state for an MRTR retry. + pub fn with_request_state(mut self, request_state: impl Into) -> Self { + self.request_state = Some(request_state.into()); + self + } +} + +impl RequestParamsMeta for GetPromptRequestParams { + fn meta(&self) -> Option<&RequestMetaObject> { + self.meta.as_ref() + } + fn meta_mut(&mut self) -> &mut Option { + &mut self.meta + } +} + +/// Request to get a specific prompt +pub type GetPromptRequest = Request; + +const_string!(PromptListChangedNotificationMethod = "notifications/prompts/list_changed"); +/// Notification sent when the list of available prompts changes +pub type PromptListChangedNotification = NotificationNoParam; + +const_string!(ToolListChangedNotificationMethod = "notifications/tools/list_changed"); +/// Notification sent when the list of available tools changes +pub type ToolListChangedNotification = NotificationNoParam; + +// ============================================================================= +// LOGGING +// ============================================================================= + +/// Logging levels supported by the MCP protocol +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Copy)] +#[serde(rename_all = "lowercase")] //match spec +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[expect(clippy::exhaustive_enums, reason = "intentionally exhaustive")] +#[deprecated( + since = "2.0.0", + note = "Logging is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" +)] +pub enum LoggingLevel { + Debug, + Info, + Notice, + Warning, + Error, + Critical, + Alert, + Emergency, +} + +const_string!(SetLevelRequestMethod = "logging/setLevel"); +/// Parameters for setting the logging level +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +#[deprecated( + since = "2.0.0", + note = "Logging is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" +)] +pub struct SetLevelRequestParams { + /// Protocol-level metadata for this request (SEP-1319) + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + pub meta: Option, + /// The desired logging level + pub level: LoggingLevel, +} + +impl SetLevelRequestParams { + /// Create a new SetLevelRequestParams with the given logging level. + pub fn new(level: LoggingLevel) -> Self { + Self { meta: None, level } + } +} + +impl RequestParamsMeta for SetLevelRequestParams { + fn meta(&self) -> Option<&RequestMetaObject> { + self.meta.as_ref() + } + fn meta_mut(&mut self) -> &mut Option { + &mut self.meta + } +} + +/// Request to set the logging level +#[deprecated( + since = "2.0.0", + note = "Logging is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" +)] +pub type SetLevelRequest = Request; + +const_string!(LoggingMessageNotificationMethod = "notifications/message"); +/// Parameters for a logging message notification +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +#[deprecated( + since = "2.0.0", + note = "Logging is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" +)] +pub struct LoggingMessageNotificationParam { + /// The severity level of this log message + pub level: LoggingLevel, + /// Optional logger name that generated this message + #[serde(skip_serializing_if = "Option::is_none")] + pub logger: Option, + /// The actual log data + pub data: Value, + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, +} + +impl LoggingMessageNotificationParam { + /// Create a new LoggingMessageNotificationParam. + pub fn new(level: LoggingLevel, data: Value) -> Self { + Self { + level, + logger: None, + data, + meta: None, + } + } + + /// Set the logger name. + pub fn with_logger(mut self, logger: impl Into) -> Self { + self.logger = Some(logger.into()); + self + } +} + +/// Notification containing a log message +#[deprecated( + since = "2.0.0", + note = "Logging is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" +)] +pub type LoggingMessageNotification = + Notification; + +// ============================================================================= +// SAMPLING (LLM INTERACTION) +// ============================================================================= + +const_string!(CreateMessageRequestMethod = "sampling/createMessage"); +#[deprecated( + since = "2.0.0", + note = "Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" +)] +pub type CreateMessageRequest = Request; + +/// Represents the role of a participant in a conversation or message exchange. +/// +/// Used in sampling and chat contexts to distinguish between different +/// types of message senders in the conversation flow. +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[expect(clippy::exhaustive_enums, reason = "intentionally exhaustive")] +pub enum Role { + /// A human user or client making a request + User, + /// An AI assistant or server providing a response + Assistant, +} + +/// Tool selection mode (SEP-1577). +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)] +#[serde(rename_all = "lowercase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub enum ToolChoiceMode { + /// Model decides whether to use tools + #[default] + Auto, + /// Model must use at least one tool + Required, + /// Model must not use tools + None, +} + +/// Tool choice configuration (SEP-1577). +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +#[deprecated( + since = "2.0.0", + note = "Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" +)] +pub struct ToolChoice { + #[serde(skip_serializing_if = "Option::is_none")] + pub mode: Option, +} + +impl ToolChoice { + pub fn auto() -> Self { + Self { + mode: Some(ToolChoiceMode::Auto), + } + } + + pub fn required() -> Self { + Self { + mode: Some(ToolChoiceMode::Required), + } + } + + pub fn none() -> Self { + Self { + mode: Some(ToolChoiceMode::None), + } + } +} + +/// Single or array content wrapper (SEP-1577). +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(untagged)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[expect(clippy::exhaustive_enums, reason = "intentionally exhaustive")] +pub enum SamplingContent { + Single(T), + Multiple(Vec), +} + +impl SamplingContent { + /// Convert to a Vec regardless of whether it's single or multiple + pub fn into_vec(self) -> Vec { + match self { + SamplingContent::Single(item) => vec![item], + SamplingContent::Multiple(items) => items, + } + } + + /// Check if the content is empty + pub fn is_empty(&self) -> bool { + match self { + SamplingContent::Single(_) => false, + SamplingContent::Multiple(items) => items.is_empty(), + } + } + + /// Get the number of content items + pub fn len(&self) -> usize { + match self { + SamplingContent::Single(_) => 1, + SamplingContent::Multiple(items) => items.len(), + } + } +} + +impl Default for SamplingContent { + fn default() -> Self { + SamplingContent::Multiple(Vec::new()) + } +} + +impl SamplingContent { + /// Get the first item if present + pub fn first(&self) -> Option<&T> { + match self { + SamplingContent::Single(item) => Some(item), + SamplingContent::Multiple(items) => items.first(), + } + } + + /// Iterate over all content items + pub fn iter(&self) -> impl Iterator { + let items: Vec<&T> = match self { + SamplingContent::Single(item) => vec![item], + SamplingContent::Multiple(items) => items.iter().collect(), + }; + items.into_iter() + } +} + +impl SamplingMessageContentBlock { + /// Get the text content if this is a Text variant + pub fn as_text(&self) -> Option<&TextContent> { + match self { + SamplingMessageContentBlock::Text(text) => Some(text), + _ => None, + } + } + + /// Get the tool use content if this is a ToolUse variant + pub fn as_tool_use(&self) -> Option<&ToolUseContent> { + match self { + SamplingMessageContentBlock::ToolUse(tool_use) => Some(tool_use), + _ => None, + } + } + + /// Get the tool result content if this is a ToolResult variant + pub fn as_tool_result(&self) -> Option<&ToolResultContent> { + match self { + SamplingMessageContentBlock::ToolResult(tool_result) => Some(tool_result), + _ => None, + } + } +} + +impl From for SamplingContent { + fn from(item: T) -> Self { + SamplingContent::Single(item) + } +} + +impl From> for SamplingContent { + fn from(items: Vec) -> Self { + SamplingContent::Multiple(items) + } +} + +/// A message in a sampling conversation, containing a role and content. +/// +/// This represents a single message in a conversation flow, used primarily +/// in LLM sampling requests where the conversation history is important +/// for generating appropriate responses. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +#[deprecated( + since = "2.0.0", + note = "Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" +)] +pub struct SamplingMessage { + /// The role of the message sender (User or Assistant) + pub role: Role, + /// The actual content of the message (text, image, audio, tool use, or tool result) + pub content: SamplingContent, + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, +} + +/// Content types for sampling messages (SEP-1577). +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(tag = "type", rename_all = "snake_case")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +#[deprecated( + since = "2.0.0", + note = "Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" +)] +pub enum SamplingMessageContentBlock { + Text(TextContent), + Image(ImageContent), + Audio(AudioContent), + /// Assistant only + ToolUse(ToolUseContent), + /// User only + ToolResult(ToolResultContent), +} + +impl SamplingMessageContentBlock { + /// Create a text content + pub fn text(text: impl Into) -> Self { + Self::Text(TextContent::new(text)) + } + + pub fn tool_use(id: impl Into, name: impl Into, input: JsonObject) -> Self { + Self::ToolUse(ToolUseContent::new(id, name, input)) + } + + pub fn tool_result(tool_use_id: impl Into, content: Vec) -> Self { + Self::ToolResult(ToolResultContent::new(tool_use_id, content)) + } +} + +impl SamplingMessage { + pub fn new(role: Role, content: impl Into) -> Self { + Self { + role, + content: SamplingContent::Single(content.into()), + meta: None, + } + } + + pub fn new_multiple(role: Role, contents: Vec) -> Self { + Self { + role, + content: SamplingContent::Multiple(contents), + meta: None, + } + } + + pub fn user_text(text: impl Into) -> Self { + Self::new(Role::User, SamplingMessageContentBlock::text(text)) + } + + pub fn assistant_text(text: impl Into) -> Self { + Self::new(Role::Assistant, SamplingMessageContentBlock::text(text)) + } + + pub fn user_tool_result(tool_use_id: impl Into, content: Vec) -> Self { + Self::new( + Role::User, + SamplingMessageContentBlock::tool_result(tool_use_id, content), + ) + } + + pub fn assistant_tool_use( + id: impl Into, + name: impl Into, + input: JsonObject, + ) -> Self { + Self::new( + Role::Assistant, + SamplingMessageContentBlock::tool_use(id, name, input), + ) + } +} + +impl From for SamplingMessageContentBlock { + fn from(text: TextContent) -> Self { + SamplingMessageContentBlock::Text(text) + } +} + +// Conversion from String to SamplingMessageContentBlock (as text) +impl From for SamplingMessageContentBlock { + fn from(text: String) -> Self { + SamplingMessageContentBlock::text(text) + } +} + +impl From<&str> for SamplingMessageContentBlock { + fn from(text: &str) -> Self { + SamplingMessageContentBlock::text(text) + } +} + +impl TryFrom for SamplingMessageContentBlock { + type Error = &'static str; + + fn try_from(content: ContentBlock) -> Result { + match content { + ContentBlock::Text(text) => Ok(SamplingMessageContentBlock::Text(text)), + ContentBlock::Image(image) => Ok(SamplingMessageContentBlock::Image(image)), + ContentBlock::Audio(audio) => Ok(SamplingMessageContentBlock::Audio(audio)), + ContentBlock::Resource(_) => { + Err("Resource content is not supported in sampling messages") + } + ContentBlock::ResourceLink(_) => { + Err("ResourceLink content is not supported in sampling messages") + } + } + } +} + +impl TryFrom for SamplingContent { + type Error = &'static str; + + fn try_from(content: ContentBlock) -> Result { + Ok(SamplingContent::Single(content.try_into()?)) + } +} + +/// Specifies how much context should be included in sampling requests. +/// +/// This allows clients to control what additional context information +/// should be provided to the LLM when processing sampling requests. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub enum ContextInclusion { + /// Include context from all connected MCP servers + #[serde(rename = "allServers")] + AllServers, + /// Include no additional context + #[serde(rename = "none")] + None, + /// Include context only from the requesting server + #[serde(rename = "thisServer")] + ThisServer, +} + +/// Parameters for creating a message through LLM sampling. +/// +/// This structure contains all the necessary information for a client to +/// generate an LLM response, including conversation history, model preferences, +/// and generation parameters. +/// +/// This implements `TaskAugmentedRequestParamsMeta` as sampling requests can be +/// long-running and may benefit from task-based execution. +#[derive(Default, Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +#[deprecated( + since = "2.0.0", + note = "Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" +)] +pub struct CreateMessageRequestParams { + /// Protocol-level metadata for this request (SEP-1319) + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + pub meta: Option, + /// The conversation history and current messages + pub messages: Vec, + /// Preferences for model selection and behavior + #[serde(skip_serializing_if = "Option::is_none")] + pub model_preferences: Option, + /// System prompt to guide the model's behavior + #[serde(skip_serializing_if = "Option::is_none")] + pub system_prompt: Option, + /// How much context to include from MCP servers + #[serde(skip_serializing_if = "Option::is_none")] + pub include_context: Option, + /// Temperature for controlling randomness (0.0 to 1.0) + #[serde( + default, + deserialize_with = "serde_impl::json_float::option_f32", + skip_serializing_if = "Option::is_none" + )] + pub temperature: Option, + /// Maximum number of tokens to generate + pub max_tokens: u32, + /// Sequences that should stop generation + #[serde(skip_serializing_if = "Option::is_none")] + pub stop_sequences: Option>, + /// Additional metadata for the request + #[serde(skip_serializing_if = "Option::is_none")] + pub metadata: Option, + /// Tools available for the model to call (SEP-1577) + #[serde(skip_serializing_if = "Option::is_none")] + pub tools: Option>, + /// Tool selection behavior (SEP-1577) + #[serde(skip_serializing_if = "Option::is_none")] + pub tool_choice: Option, +} + +impl RequestParamsMeta for CreateMessageRequestParams { + fn meta(&self) -> Option<&RequestMetaObject> { + self.meta.as_ref() + } + fn meta_mut(&mut self) -> &mut Option { + &mut self.meta + } +} + +impl CreateMessageRequestParams { + /// Create a new CreateMessageRequestParams with required fields. + pub fn new(messages: Vec, max_tokens: u32) -> Self { + Self { + meta: None, + messages, + model_preferences: None, + system_prompt: None, + include_context: None, + temperature: None, + max_tokens, + stop_sequences: None, + metadata: None, + tools: None, + tool_choice: None, + } + } + + /// Set model preferences. + pub fn with_model_preferences(mut self, model_preferences: ModelPreferences) -> Self { + self.model_preferences = Some(model_preferences); + self + } + + /// Set system prompt. + pub fn with_system_prompt(mut self, system_prompt: impl Into) -> Self { + self.system_prompt = Some(system_prompt.into()); + self + } + + /// Set include context. + pub fn with_include_context(mut self, include_context: ContextInclusion) -> Self { + self.include_context = Some(include_context); + self + } + + /// Set temperature. + pub fn with_temperature(mut self, temperature: f32) -> Self { + self.temperature = Some(temperature); + self + } + + /// Set stop sequences. + pub fn with_stop_sequences(mut self, stop_sequences: Vec) -> Self { + self.stop_sequences = Some(stop_sequences); + self + } + + /// Set metadata. + pub fn with_metadata(mut self, metadata: Value) -> Self { + self.metadata = Some(metadata); + self + } + + /// Set tools. + pub fn with_tools(mut self, tools: Vec) -> Self { + self.tools = Some(tools); + self + } + + /// Set tool choice. + pub fn with_tool_choice(mut self, tool_choice: ToolChoice) -> Self { + self.tool_choice = Some(tool_choice); + self + } + + /// Validate the sampling request parameters per SEP-1577 spec requirements. + /// + /// Checks: + /// - ToolUse content is only allowed in assistant messages + /// - ToolResult content is only allowed in user messages + /// - Messages with tool result content MUST NOT contain other content types + /// - Every assistant ToolUse must be balanced with a corresponding user ToolResult + pub fn validate(&self) -> Result<(), String> { + for msg in &self.messages { + for content in msg.content.iter() { + // ToolUse only in assistant messages, ToolResult only in user messages + match content { + SamplingMessageContentBlock::ToolUse(_) if msg.role != Role::Assistant => { + return Err("ToolUse content is only allowed in assistant messages".into()); + } + SamplingMessageContentBlock::ToolResult(_) if msg.role != Role::User => { + return Err("ToolResult content is only allowed in user messages".into()); + } + _ => {} + } + } + + // Tool result messages MUST NOT contain other content types + let contents: Vec<_> = msg.content.iter().collect(); + let has_tool_result = contents + .iter() + .any(|c| matches!(c, SamplingMessageContentBlock::ToolResult(_))); + if has_tool_result + && contents + .iter() + .any(|c| !matches!(c, SamplingMessageContentBlock::ToolResult(_))) + { + return Err( + "SamplingMessage with tool result content MUST NOT contain other content types" + .into(), + ); + } + } + + // Every assistant ToolUse must be balanced with a user ToolResult + self.validate_tool_use_result_balance()?; + + Ok(()) + } + + fn validate_tool_use_result_balance(&self) -> Result<(), String> { + let mut pending_tool_use_ids: Vec = Vec::new(); + for msg in &self.messages { + if msg.role == Role::Assistant { + for content in msg.content.iter() { + if let SamplingMessageContentBlock::ToolUse(tu) = content { + pending_tool_use_ids.push(tu.id.clone()); + } + } + } else if msg.role == Role::User { + for content in msg.content.iter() { + if let SamplingMessageContentBlock::ToolResult(tr) = content { + if !pending_tool_use_ids.contains(&tr.tool_use_id) { + return Err(format!( + "ToolResult with toolUseId '{}' has no matching ToolUse", + tr.tool_use_id + )); + } + pending_tool_use_ids.retain(|id| id != &tr.tool_use_id); + } + } + } + } + if !pending_tool_use_ids.is_empty() { + return Err(format!( + "ToolUse with id(s) {:?} not balanced with ToolResult", + pending_tool_use_ids + )); + } + Ok(()) + } +} + +/// Preferences for model selection and behavior in sampling requests. +/// +/// This allows servers to express their preferences for which model to use +/// and how to balance different priorities when the client has multiple +/// model options available. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +#[deprecated( + since = "2.0.0", + note = "Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" +)] +pub struct ModelPreferences { + /// Specific model names or families to prefer (e.g., "claude", "gpt") + #[serde(skip_serializing_if = "Option::is_none")] + pub hints: Option>, + /// Priority for cost optimization (0.0 to 1.0, higher = prefer cheaper models) + #[serde( + default, + deserialize_with = "serde_impl::json_float::option_f32", + skip_serializing_if = "Option::is_none" + )] + pub cost_priority: Option, + /// Priority for speed/latency (0.0 to 1.0, higher = prefer faster models) + #[serde( + default, + deserialize_with = "serde_impl::json_float::option_f32", + skip_serializing_if = "Option::is_none" + )] + pub speed_priority: Option, + /// Priority for intelligence/capability (0.0 to 1.0, higher = prefer more capable models) + #[serde( + default, + deserialize_with = "serde_impl::json_float::option_f32", + skip_serializing_if = "Option::is_none" + )] + pub intelligence_priority: Option, +} + +impl ModelPreferences { + /// Create a new default ModelPreferences. + pub fn new() -> Self { + Self { + hints: None, + cost_priority: None, + speed_priority: None, + intelligence_priority: None, + } + } + + /// Set hints for model selection. + pub fn with_hints(mut self, hints: Vec) -> Self { + self.hints = Some(hints); + self + } + + /// Set cost priority (0.0 to 1.0). + pub fn with_cost_priority(mut self, cost_priority: f32) -> Self { + self.cost_priority = Some(cost_priority); + self + } + + /// Set speed priority (0.0 to 1.0). + pub fn with_speed_priority(mut self, speed_priority: f32) -> Self { + self.speed_priority = Some(speed_priority); + self + } + + /// Set intelligence priority (0.0 to 1.0). + pub fn with_intelligence_priority(mut self, intelligence_priority: f32) -> Self { + self.intelligence_priority = Some(intelligence_priority); + self + } +} + +impl Default for ModelPreferences { + fn default() -> Self { + Self::new() + } +} + +/// A hint suggesting a preferred model name or family. +/// +/// Model hints are advisory suggestions that help clients choose appropriate +/// models. They can be specific model names or general families like "claude" or "gpt". +#[derive(Default, Debug, Serialize, Deserialize, Clone, PartialEq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +#[deprecated( + since = "2.0.0", + note = "Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" +)] +pub struct ModelHint { + /// The suggested model name or family identifier + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, +} + +impl ModelHint { + /// Create a new ModelHint with a name. + pub fn new(name: impl Into) -> Self { + Self { + name: Some(name.into()), + } + } +} + +// ============================================================================= +// COMPLETION AND AUTOCOMPLETE +// ============================================================================= + +/// Context for completion requests providing previously resolved arguments. +/// +/// This enables context-aware completion where subsequent argument completions +/// can take into account the values of previously resolved arguments. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct CompletionContext { + /// Previously resolved argument values that can inform completion suggestions + #[serde(skip_serializing_if = "Option::is_none")] + pub arguments: Option>, +} + +impl CompletionContext { + /// Create a new empty completion context + pub fn new() -> Self { + Self::default() + } + + /// Create a completion context with the given arguments + pub fn with_arguments(arguments: std::collections::HashMap) -> Self { + Self { + arguments: Some(arguments), + } + } + + /// Get a specific argument value by name + pub fn get_argument(&self, name: &str) -> Option<&String> { + self.arguments.as_ref()?.get(name) + } + + /// Check if the context has any arguments + pub fn has_arguments(&self) -> bool { + self.arguments.as_ref().is_some_and(|args| !args.is_empty()) + } + + /// Get all argument names + pub fn argument_names(&self) -> impl Iterator { + self.arguments + .as_ref() + .into_iter() + .flat_map(|args| args.keys()) + .map(|k| k.as_str()) + } +} + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct CompleteRequestParams { + /// Protocol-level metadata for this request (SEP-1319) + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + pub meta: Option, + pub r#ref: Reference, + pub argument: ArgumentInfo, + /// Optional context containing previously resolved argument values + #[serde(skip_serializing_if = "Option::is_none")] + pub context: Option, +} + +impl CompleteRequestParams { + /// Create a new CompleteRequestParams with required fields. + pub fn new(r#ref: Reference, argument: ArgumentInfo) -> Self { + Self { + meta: None, + r#ref, + argument, + context: None, + } + } + + /// Set the completion context + pub fn with_context(mut self, context: CompletionContext) -> Self { + self.context = Some(context); + self + } +} + +impl RequestParamsMeta for CompleteRequestParams { + fn meta(&self) -> Option<&RequestMetaObject> { + self.meta.as_ref() + } + fn meta_mut(&mut self) -> &mut Option { + &mut self.meta + } +} + +pub type CompleteRequest = Request; + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct CompletionInfo { + pub values: Vec, + #[serde(skip_serializing_if = "Option::is_none")] + pub total: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub has_more: Option, +} + +impl CompletionInfo { + /// Maximum number of completion values allowed per response according to MCP specification + pub const MAX_VALUES: usize = 100; + + /// Create a new CompletionInfo with validation for maximum values + pub fn new(values: Vec) -> Result { + if values.len() > Self::MAX_VALUES { + return Err(format!( + "Too many completion values: {} (max: {})", + values.len(), + Self::MAX_VALUES + )); + } + Ok(Self { + values, + total: None, + has_more: None, + }) + } + + /// Create CompletionInfo with all values and no pagination + pub fn with_all_values(values: Vec) -> Result { + let completion = Self::new(values)?; + Ok(Self { + total: Some(completion.values.len() as u32), + has_more: Some(false), + ..completion + }) + } + + /// Create CompletionInfo with pagination information + pub fn with_pagination( + values: Vec, + total: Option, + has_more: bool, + ) -> Result { + let completion = Self::new(values)?; + Ok(Self { + total, + has_more: Some(has_more), + ..completion + }) + } + + /// Check if this completion response indicates more results are available + pub fn has_more_results(&self) -> bool { + self.has_more.unwrap_or(false) + } + + /// Get the total number of available completions, if known + pub fn total_available(&self) -> Option { + self.total + } + + /// Validate that the completion info complies with MCP specification + pub fn validate(&self) -> Result<(), String> { + if self.values.len() > Self::MAX_VALUES { + return Err(format!( + "Too many completion values: {} (max: {})", + self.values.len(), + Self::MAX_VALUES + )); + } + Ok(()) + } +} + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct CompleteResult { + /// Result type discriminator (SEP-2322). Required by the [spec schema] + /// for servers implementing protocol version `2026-07-28`, but optional + /// here because this type also models results from older protocol + /// versions, which do not carry the field: `None` means absent on the + /// wire, and per the spec "the client MUST treat the absent field as + /// `"complete"`". Constructors default to `Some(ResultType::COMPLETE)`; + /// the server handler clears the field when responding to peers that + /// negotiated an older version. + /// + /// [spec schema]: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/271ecc9accafdd9b83a3c869fa67c22953b2af80/schema/2026-07-28/schema.ts#L219-L235 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub result_type: Option, + pub completion: CompletionInfo, + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, +} + +impl Default for CompleteResult { + fn default() -> Self { + Self::new(CompletionInfo::default()) + } +} + +impl CompleteResult { + /// Create a new CompleteResult with the given completion info. + pub fn new(completion: CompletionInfo) -> Self { + Self { + result_type: Some(ResultType::COMPLETE), + completion, + meta: None, + } + } +} + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(tag = "type")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub enum Reference { + #[serde(rename = "ref/resource")] + Resource(ResourceTemplateReference), + #[serde(rename = "ref/prompt")] + Prompt(PromptReference), +} + +impl Reference { + /// Create a prompt reference + pub fn for_prompt(name: impl Into) -> Self { + // Not accepting `title` currently as it'll break the API + // Until further decision, keep it `None`, modify later + // if required, add `title` to the API + Self::Prompt(PromptReference { + name: name.into(), + title: None, + }) + } + + /// Create a resource reference + pub fn for_resource(uri: impl Into) -> Self { + Self::Resource(ResourceTemplateReference { uri: uri.into() }) + } + + /// Get the reference type as a string + pub fn reference_type(&self) -> &'static str { + match self { + Self::Prompt(_) => "ref/prompt", + Self::Resource(_) => "ref/resource", + } + } + + /// Extract prompt name if this is a prompt reference + pub fn as_prompt_name(&self) -> Option<&str> { + match self { + Self::Prompt(prompt_ref) => Some(&prompt_ref.name), + _ => None, + } + } + + /// Extract resource URI if this is a resource reference + pub fn as_resource_uri(&self) -> Option<&str> { + match self { + Self::Resource(resource_ref) => Some(&resource_ref.uri), + _ => None, + } + } +} + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct ResourceTemplateReference { + pub uri: String, +} + +impl ResourceTemplateReference { + pub fn new(uri: impl Into) -> Self { + Self { uri: uri.into() } + } +} + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct PromptReference { + pub name: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, +} + +impl PromptReference { + /// Creates a new `PromptReference` with the given name. `title` defaults to `None`. + pub fn new(name: impl Into) -> Self { + Self { + name: name.into(), + title: None, + } + } + + /// Sets the human-readable title for this prompt reference. + pub fn with_title(mut self, title: impl Into) -> Self { + self.title = Some(title.into()); + self + } +} + +const_string!(CompleteRequestMethod = "completion/complete"); +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct ArgumentInfo { + pub name: String, + pub value: String, +} + +impl ArgumentInfo { + pub fn new(name: impl Into, value: impl Into) -> Self { + Self { + name: name.into(), + value: value.into(), + } + } +} + +// ============================================================================= +// ROOTS AND WORKSPACE MANAGEMENT +// ============================================================================= + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +#[deprecated( + since = "2.0.0", + note = "Roots is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" +)] +pub struct Root { + pub uri: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, +} + +impl Root { + /// Creates a new `Root` with the given URI. `name` defaults to `None`. + pub fn new(uri: impl Into) -> Self { + Self { + uri: uri.into(), + name: None, + meta: None, + } + } + + /// Sets the human-readable name for this root. + pub fn with_name(mut self, name: impl Into) -> Self { + self.name = Some(name.into()); + self + } + + /// Sets the protocol-level metadata for this root. + pub fn with_meta(mut self, meta: MetaObject) -> Self { + self.meta = Some(meta); + self + } +} + +const_string!(ListRootsRequestMethod = "roots/list"); +#[deprecated( + since = "2.0.0", + note = "Roots is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" +)] +pub type ListRootsRequest = RequestNoParam; + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +#[deprecated( + since = "2.0.0", + note = "Roots is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" +)] +pub struct ListRootsResult { + pub roots: Vec, + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, +} + +impl ListRootsResult { + /// Creates a new `ListRootsResult` with the given roots. + pub fn new(roots: Vec) -> Self { + Self { roots, meta: None } + } + + /// Sets the protocol-level metadata for this result. + pub fn with_meta(mut self, meta: MetaObject) -> Self { + self.meta = Some(meta); + self + } +} + +const_string!(RootsListChangedNotificationMethod = "notifications/roots/list_changed"); +pub type RootsListChangedNotification = NotificationNoParam; + +// ============================================================================= +// ELICITATION (INTERACTIVE USER INPUT) +// ============================================================================= + +// Method constants for elicitation operations. +// Elicitation allows servers to request interactive input from users during tool execution. +const_string!(ElicitationCreateRequestMethod = "elicitation/create"); +const_string!(ElicitationResponseNotificationMethod = "notifications/elicitation/response"); + +/// Represents the possible actions a user can take in response to an elicitation request. +/// +/// When a server requests user input through elicitation, the user can: +/// - Accept: Provide the requested information and continue +/// - Decline: Refuse to provide the information but continue the operation +/// - Cancel: Stop the entire operation +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)] +#[serde(rename_all = "lowercase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub enum ElicitationAction { + /// User accepts the request and provides the requested information + Accept, + /// User declines to provide the information but allows the operation to continue + Decline, + /// User cancels the entire operation + Cancel, +} + +/// Wire representation for tagged elicitation parameters and legacy forms without `mode`. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(tag = "mode")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +enum ElicitRequestParamsWire { + #[serde(rename = "form", rename_all = "camelCase")] + Form { + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + meta: Option, + message: String, + requested_schema: ElicitationSchema, + }, + #[serde(rename = "url", rename_all = "camelCase")] + Url { + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + meta: Option, + message: String, + url: String, + elicitation_id: String, + }, + #[serde(untagged, rename_all = "camelCase")] + LegacyForm { + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + meta: Option, + message: String, + requested_schema: ElicitationSchema, + }, +} + +impl TryFrom for ElicitRequestParams { + type Error = serde_json::Error; + + fn try_from(value: ElicitRequestParamsWire) -> Result { + match value { + ElicitRequestParamsWire::Form { + meta, + message, + requested_schema, + } + | ElicitRequestParamsWire::LegacyForm { + meta, + message, + requested_schema, + } => Ok(ElicitRequestParams::FormElicitationParams { + meta, + message, + requested_schema, + }), + ElicitRequestParamsWire::Url { + meta, + message, + url, + elicitation_id, + } => Ok(ElicitRequestParams::UrlElicitationParams { + meta, + message, + url, + elicitation_id, + }), + } + } +} + +/// Parameters for creating an elicitation request to gather user input. +/// +/// This structure contains everything needed to request interactive input from a user: +/// - A human-readable message explaining what information is needed +/// - A type-safe schema defining the expected structure of the response +/// +/// # Example +/// 1. Form-based elicitation request +/// ```rust +/// use rmcp::model::*; +/// +/// let params = ElicitRequestParams::FormElicitationParams { +/// meta: None, +/// message: "Please provide your email".to_string(), +/// requested_schema: ElicitationSchema::builder() +/// .required_email("email") +/// .build() +/// .unwrap(), +/// }; +/// ``` +/// 2. URL-based elicitation request +/// ```rust +/// use rmcp::model::*; +/// let params = ElicitRequestParams::UrlElicitationParams { +/// meta: None, +/// message: "Please provide your feedback at the following URL".to_string(), +/// url: "https://example.com/feedback".to_string(), +/// elicitation_id: "unique-id-123".to_string(), +/// }; +/// ``` +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(tag = "mode", try_from = "ElicitRequestParamsWire")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub enum ElicitRequestParams { + #[serde(rename = "form", rename_all = "camelCase")] + FormElicitationParams { + /// Protocol-level metadata for this request (SEP-1319) + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + meta: Option, + /// Human-readable message explaining what input is needed from the user. + /// This should be clear and provide sufficient context for the user to understand + /// what information they need to provide. + message: String, + + /// Type-safe schema defining the expected structure and validation rules for the user's response. + /// This enforces the MCP 2025-06-18 specification that elicitation schemas must be objects + /// with primitive-typed properties. + requested_schema: ElicitationSchema, + }, + #[serde(rename = "url", rename_all = "camelCase")] + UrlElicitationParams { + /// Protocol-level metadata for this request (SEP-1319) + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + meta: Option, + /// Human-readable message explaining what input is needed from the user. + /// This should be clear and provide sufficient context for the user to understand + /// what information they need to provide. + message: String, + + /// The URL where the user can provide the requested information. + /// The client should direct the user to this URL to complete the elicitation. + url: String, + /// The unique identifier for this elicitation request. + elicitation_id: String, + }, +} + +impl RequestParamsMeta for ElicitRequestParams { + fn meta(&self) -> Option<&RequestMetaObject> { + match self { + ElicitRequestParams::FormElicitationParams { meta, .. } => meta.as_ref(), + ElicitRequestParams::UrlElicitationParams { meta, .. } => meta.as_ref(), + } + } + fn meta_mut(&mut self) -> &mut Option { + match self { + ElicitRequestParams::FormElicitationParams { meta, .. } => meta, + ElicitRequestParams::UrlElicitationParams { meta, .. } => meta, + } + } +} + +/// The result returned by a client in response to an elicitation request. +/// +/// Contains the user's decision (accept/decline/cancel) and optionally their input data +/// if they chose to accept the request. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct ElicitResult { + /// The user's decision on how to handle the elicitation request + pub action: ElicitationAction, + + /// The actual data provided by the user, if they accepted the request. + /// Must conform to the JSON schema specified in the original request. + /// Only present when action is Accept. + #[serde(skip_serializing_if = "Option::is_none")] + pub content: Option, + + /// Optional protocol-level metadata for this result. + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, +} + +impl ElicitResult { + /// Create a new ElicitResult. + pub fn new(action: ElicitationAction) -> Self { + Self { + action, + content: None, + meta: None, + } + } + + /// Set the content on this result. + pub fn with_content(mut self, content: Value) -> Self { + self.content = Some(content); + self + } + + /// Set the metadata on this result. + pub fn with_meta(mut self, meta: MetaObject) -> Self { + self.meta = Some(meta); + self + } +} + +/// Request type for creating an elicitation to gather user input +pub type ElicitRequest = Request; + +// ============================================================================= +// TOOL EXECUTION RESULTS +// ============================================================================= + +/// Deserialize a field that is present on the wire as `Some`, even when its +/// value is `null`. Combined with `#[serde(default)]`, an absent field stays `None`. +fn deserialize_present_value<'de, D>(deserializer: D) -> Result, D::Error> +where + D: serde::Deserializer<'de>, +{ + Value::deserialize(deserializer).map(Some) +} + +/// The result of a tool call operation. +/// +/// Contains the content returned by the tool execution and an optional +/// flag indicating whether the operation resulted in an error. +#[derive(Debug, Serialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct CallToolResult { + /// Result type discriminator (SEP-2322). Required by the [spec schema] + /// for servers implementing protocol version `2026-07-28`, but optional + /// here because this type also models results from older protocol + /// versions, which do not carry the field: `None` means absent on the + /// wire, and per the spec "the client MUST treat the absent field as + /// `"complete"`". Constructors default to `Some(ResultType::COMPLETE)`; + /// the server handler clears the field when responding to peers that + /// negotiated an older version. + /// + /// [spec schema]: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/271ecc9accafdd9b83a3c869fa67c22953b2af80/schema/2026-07-28/schema.ts#L219-L235 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub result_type: Option, + /// The content returned by the tool (text, images, etc.) + #[serde(default)] + pub content: Vec, + /// An optional JSON value that represents the structured result of the tool call. + /// It can be any JSON value, including `null`; an explicit `null` is kept + /// distinct from an absent field. + #[serde(skip_serializing_if = "Option::is_none")] + pub structured_content: Option, + /// Whether this result represents an error condition + #[serde(skip_serializing_if = "Option::is_none")] + pub is_error: Option, + /// Optional protocol-level metadata for this result + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, +} + +// Custom Deserialize implementation that: +// 1. Defaults `content` to `[]` when the field is missing (lenient per Postel's law) +// 2. Requires at least one known field to be present, so that `CallToolResult` doesn't +// greedily match arbitrary JSON objects when used inside `#[serde(untagged)]` enums +// (e.g. `ServerResult`), which would shadow `CustomResult`. +// 3. Rejects non-`complete` result types so other `ServerResult` variants can match. +// 4. Keeps a present `"structuredContent": null` as `Some(Value::Null)`, distinct +// from an absent field, since structured content can be any JSON value. +impl<'de> Deserialize<'de> for CallToolResult { + fn deserialize(deserializer: D) -> Result + where + D: serde::Deserializer<'de>, + { + #[derive(Deserialize)] + #[serde(rename_all = "camelCase")] + struct Helper { + #[serde(default)] + result_type: Option, + content: Option>, + #[serde(default, deserialize_with = "deserialize_present_value")] + structured_content: Option, + is_error: Option, + #[serde(rename = "_meta")] + meta: Option, + } + + let helper = Helper::deserialize(deserializer)?; + + if helper + .result_type + .as_ref() + .is_some_and(|result_type| !result_type.is_complete()) + { + return Err(serde::de::Error::custom( + "CallToolResult requires resultType to be \"complete\" when present", + )); + } + + if helper.content.is_none() + && helper.structured_content.is_none() + && helper.is_error.is_none() + && helper.meta.is_none() + { + return Err(serde::de::Error::custom( + "expected at least one known CallToolResult field \ + (content, structuredContent, isError, or _meta)", + )); + } + + Ok(CallToolResult { + result_type: helper.result_type, + content: helper.content.unwrap_or_default(), + structured_content: helper.structured_content, + is_error: helper.is_error, + meta: helper.meta, + }) + } +} + +impl Default for CallToolResult { + fn default() -> Self { + CallToolResult { + result_type: Some(ResultType::COMPLETE), + content: Vec::new(), + structured_content: None, + is_error: None, + meta: None, + } + } +} + +impl CallToolResult { + /// Create a successful tool result with unstructured content + pub fn success(content: Vec) -> Self { + CallToolResult { + result_type: Some(ResultType::COMPLETE), + content, + structured_content: None, + is_error: Some(false), + meta: None, + } + } + + /// Create a tool-level error result with caller-visible content. + /// + /// # When to use this vs `Err(ErrorData)` + /// + /// MCP distinguishes two failure modes for a `call_tool` invocation, and + /// the right one to use depends on **whose problem it is**: + /// + /// - **Tool-level error** — `Ok(CallToolResult::error(...))`. + /// The request was valid and routed to your tool, but executing the + /// tool failed in a way the caller should see (a query returned no + /// rows, an external API returned 500, the user's input is plausible + /// but produced no result, etc.). The caller's MCP client renders the + /// `content` you provide; your message reaches the user. **This is the + /// right choice for almost every "the tool ran and didn't work" case.** + /// + /// - **Protocol error** — `Err(ErrorData)` with a JSON-RPC code. + /// The server cannot route the request at all, or an infrastructure + /// error makes the server itself unusable + /// ([`ErrorCode::INTERNAL_ERROR`], `-32603`). MCP clients typically + /// render protocol errors opaquely (e.g. "Tool result missing due to + /// internal error") — the caller does **not** see your message. + /// + /// # Example + /// + /// ```rust,ignore + /// use rmcp::model::{CallToolResult, Content, ErrorData}; + /// + /// async fn lookup(query: &str) -> Result { + /// // Caller passed a malformed query — the server can't run anything. + /// // This is a protocol error, the caller's client will render it + /// // as -32602 invalid_params: + /// if query.is_empty() { + /// return Err(ErrorData::invalid_params("query must be non-empty", None)); + /// } + /// + /// // Tool ran, no result. Caller should see the explanation: + /// let rows = run_query(query).await; + /// if rows.is_empty() { + /// return Ok(CallToolResult::error(vec![ContentBlock::text( + /// format!("no rows matched '{query}'"), + /// )])); + /// } + /// + /// Ok(CallToolResult::success(vec![ContentBlock::text(format_rows(&rows))])) + /// } + /// # async fn run_query(_: &str) -> Vec<&'static str> { vec![] } + /// # fn format_rows(_: &[&str]) -> String { String::new() } + /// ``` + pub fn error(content: Vec) -> Self { + CallToolResult { + result_type: Some(ResultType::COMPLETE), + content, + structured_content: None, + is_error: Some(true), + meta: None, + } + } + /// Create a successful tool result with structured content + /// + /// # Example + /// + /// ```rust,ignore + /// use rmcp::model::CallToolResult; + /// use serde_json::json; + /// + /// let result = CallToolResult::structured(json!({ + /// "temperature": 22.5, + /// "humidity": 65, + /// "description": "Partly cloudy" + /// })); + /// ``` + pub fn structured(value: Value) -> Self { + CallToolResult { + result_type: Some(ResultType::COMPLETE), + content: vec![ContentBlock::text(value.to_string())], + structured_content: Some(value), + is_error: Some(false), + meta: None, + } + } + /// Create an error tool result with structured content + /// + /// # Example + /// + /// ```rust,ignore + /// use rmcp::model::CallToolResult; + /// use serde_json::json; + /// + /// let result = CallToolResult::structured_error(json!({ + /// "error_code": "INVALID_INPUT", + /// "message": "Temperature value out of range", + /// "details": { + /// "min": -50, + /// "max": 50, + /// "provided": 100 + /// } + /// })); + /// ``` + pub fn structured_error(value: Value) -> Self { + CallToolResult { + result_type: Some(ResultType::COMPLETE), + content: vec![ContentBlock::text(value.to_string())], + structured_content: Some(value), + is_error: Some(true), + meta: None, + } + } + + /// Set the metadata on this result + pub fn with_meta(mut self, meta: Option) -> Self { + self.meta = meta; + self + } + + /// Convert the `structured_content` part of response into a certain type. + /// + /// # About json schema validation + /// Since rust is a strong type language, we don't need to do json schema validation here. + /// + /// But if you do have to validate the response data, you can use [`jsonschema`](https://crates.io/crates/jsonschema) crate. + pub fn into_typed(self) -> Result + where + T: DeserializeOwned, + { + let raw_text = match (self.structured_content, &self.content.first()) { + (Some(value), _) => return serde_json::from_value(value), + (None, Some(contents)) => { + if let Some(text) = contents.as_text() { + let text = &text.text; + Some(text) + } else { + None + } + } + (None, None) => None, + }; + if let Some(text) = raw_text { + return serde_json::from_str(text); + } + serde_json::from_value(serde_json::Value::Null) + } +} + +const_string!(ListToolsRequestMethod = "tools/list"); +/// Request to list all available tools from a server +pub type ListToolsRequest = RequestOptionalParam; + +paginated_result!( + ListToolsResult { + tools: Vec + } +); + +const_string!(CallToolRequestMethod = "tools/call"); +/// Parameters for calling a tool provided by an MCP server. +/// +/// Contains the tool name and optional arguments needed to execute +/// the tool operation. +#[derive(Default, Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct CallToolRequestParams { + /// Protocol-level metadata for this request (SEP-1319) + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + pub meta: Option, + /// The name of the tool to call + pub name: Cow<'static, str>, + /// Arguments to pass to the tool (must match the tool's input schema) + #[serde(skip_serializing_if = "Option::is_none")] + pub arguments: Option, + /// Client responses to server-initiated input requests from a previous + /// [`InputRequiredResult`]. Present only when retrying after an incomplete result. + #[serde(skip_serializing_if = "Option::is_none")] + pub input_responses: Option, + /// Opaque request state echoed back from a previous [`InputRequiredResult`]. + /// Clients MUST return this value exactly as received. + #[serde(skip_serializing_if = "Option::is_none")] + pub request_state: Option, +} + +impl CallToolRequestParams { + /// Creates a new `CallToolRequestParams` with the given tool name. + pub fn new(name: impl Into>) -> Self { + Self { + meta: None, + name: name.into(), + arguments: None, + input_responses: None, + request_state: None, + } + } + + /// Sets the arguments for this tool call. + pub fn with_arguments(mut self, arguments: JsonObject) -> Self { + self.arguments = Some(arguments); + self + } + + /// Sets the input responses for an MRTR retry. + pub fn with_input_responses(mut self, input_responses: InputResponses) -> Self { + self.input_responses = Some(input_responses); + self + } + + /// Sets the request state for an MRTR retry. + pub fn with_request_state(mut self, request_state: impl Into) -> Self { + self.request_state = Some(request_state.into()); + self + } +} + +impl RequestParamsMeta for CallToolRequestParams { + fn meta(&self) -> Option<&RequestMetaObject> { + self.meta.as_ref() + } + fn meta_mut(&mut self) -> &mut Option { + &mut self.meta + } +} + +/// Request to call a specific tool +pub type CallToolRequest = Request; + +/// Result of sampling/createMessage (SEP-1577). +/// The result of a sampling/createMessage request containing the generated response. +/// +/// This structure contains the generated message along with metadata about +/// how the generation was performed and why it stopped. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +#[deprecated( + since = "2.0.0", + note = "Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" +)] +pub struct CreateMessageResult { + /// The identifier of the model that generated the response + pub model: String, + /// The reason why generation stopped (e.g., "endTurn", "maxTokens") + #[serde(skip_serializing_if = "Option::is_none")] + pub stop_reason: Option, + /// The generated message with role and content + #[serde(flatten)] + pub message: SamplingMessage, +} + +impl CreateMessageResult { + /// Create a new CreateMessageResult with required fields. + pub fn new(message: SamplingMessage, model: String) -> Self { + Self { + message, + model, + stop_reason: None, + } + } + + pub const STOP_REASON_END_TURN: &str = "endTurn"; + pub const STOP_REASON_END_SEQUENCE: &str = "stopSequence"; + pub const STOP_REASON_END_MAX_TOKEN: &str = "maxTokens"; + pub const STOP_REASON_TOOL_USE: &str = "toolUse"; + + /// Set the stop reason. + pub fn with_stop_reason(mut self, stop_reason: impl Into) -> Self { + self.stop_reason = Some(stop_reason.into()); + self + } + + /// Set the model identifier. + pub fn with_model(mut self, model: impl Into) -> Self { + self.model = model.into(); + self + } + + /// Validate the result per SEP-1577: role must be "assistant". + pub fn validate(&self) -> Result<(), String> { + if self.message.role != Role::Assistant { + return Err("CreateMessageResult role must be 'assistant'".into()); + } + Ok(()) + } +} + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct GetPromptResult { + /// Result type discriminator (SEP-2322). Required by the [spec schema] + /// for servers implementing protocol version `2026-07-28`, but optional + /// here because this type also models results from older protocol + /// versions, which do not carry the field: `None` means absent on the + /// wire, and per the spec "the client MUST treat the absent field as + /// `"complete"`". Constructors default to `Some(ResultType::COMPLETE)`; + /// the server handler clears the field when responding to peers that + /// negotiated an older version. + /// + /// [spec schema]: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/271ecc9accafdd9b83a3c869fa67c22953b2af80/schema/2026-07-28/schema.ts#L219-L235 + #[serde(default, skip_serializing_if = "Option::is_none")] + pub result_type: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + pub messages: Vec, + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, +} + +impl Default for GetPromptResult { + fn default() -> Self { + Self::new(Vec::new()) + } +} + +impl GetPromptResult { + /// Create a new GetPromptResult with required fields. + pub fn new(messages: Vec) -> Self { + Self { + result_type: Some(ResultType::COMPLETE), + description: None, + messages, + meta: None, + } + } + + /// Set the description + pub fn with_description>(mut self, description: D) -> Self { + self.description = Some(description.into()); + self + } +} + +// ============================================================================= +// TASK MANAGEMENT (SEP-2663 Tasks extension: `io.modelcontextprotocol/tasks`) +// ============================================================================= + +const_string!(GetTaskMethod = "tasks/get"); +pub type GetTaskRequest = Request; + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct GetTaskParams { + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + pub meta: Option, + /// Identifier of the task to query. + pub task_id: String, +} + +impl GetTaskParams { + pub fn new(task_id: impl Into) -> Self { + Self { + meta: None, + task_id: task_id.into(), + } + } +} + +impl RequestParamsMeta for GetTaskParams { + fn meta(&self) -> Option<&RequestMetaObject> { + self.meta.as_ref() + } + fn meta_mut(&mut self) -> &mut Option { + &mut self.meta + } +} + +const_string!(UpdateTaskMethod = "tasks/update"); +pub type UpdateTaskRequest = Request; + +/// Parameters for `tasks/update` (SEP-2663): deliver responses to outstanding +/// in-task server-to-client requests surfaced via `tasks/get` `inputRequests`. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct UpdateTaskParams { + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + pub meta: Option, + /// Identifier of the task to update. + pub task_id: String, + /// Responses to outstanding `inputRequests` previously surfaced by the + /// server. Each key MUST correspond to a currently-outstanding + /// `inputRequests` key. + pub input_responses: InputResponses, +} + +impl UpdateTaskParams { + pub fn new(task_id: impl Into, input_responses: InputResponses) -> Self { + Self { + meta: None, + task_id: task_id.into(), + input_responses, + } + } +} + +impl RequestParamsMeta for UpdateTaskParams { + fn meta(&self) -> Option<&RequestMetaObject> { + self.meta.as_ref() + } + fn meta_mut(&mut self) -> &mut Option { + &mut self.meta + } +} + +const_string!(CancelTaskMethod = "tasks/cancel"); +pub type CancelTaskRequest = Request; + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct CancelTaskParams { + /// Protocol-level metadata for this request (SEP-1319) + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + pub meta: Option, + pub task_id: String, +} + +impl CancelTaskParams { + pub fn new(task_id: impl Into) -> Self { + Self { + meta: None, + task_id: task_id.into(), + } + } +} + +impl RequestParamsMeta for CancelTaskParams { + fn meta(&self) -> Option<&RequestMetaObject> { + self.meta.as_ref() + } + fn meta_mut(&mut self) -> &mut Option { + &mut self.meta + } +} + +// --------------------------------------------------------------------------- +// Task status notification (SEP-2663 `notifications/tasks`) +// --------------------------------------------------------------------------- +const_string!(TaskStatusNotificationMethod = "notifications/tasks"); + +/// Parameters for a task status notification (spec `TaskStatusNotificationParams`). +/// +/// Carries a complete [`DetailedTask`] for the current status, identical to +/// what `tasks/get` would have returned at that moment. The task fields are +/// flattened at the top level: `NotificationParams & Task`. +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct TaskStatusNotificationParams { + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + pub meta: Option, + #[serde(flatten)] + pub task: crate::model::DetailedTask, +} + +impl TaskStatusNotificationParams { + pub fn new(task: crate::model::DetailedTask) -> Self { + Self { meta: None, task } + } + + pub fn with_meta(mut self, meta: NotificationMetaObject) -> Self { + self.meta = Some(meta); + self + } +} + +impl From for TaskStatusNotificationParams { + fn from(task: crate::model::DetailedTask) -> Self { + Self::new(task) + } +} + +impl Deref for TaskStatusNotificationParams { + type Target = crate::model::DetailedTask; + + fn deref(&self) -> &Self::Target { + &self.task + } +} + +impl DerefMut for TaskStatusNotificationParams { + fn deref_mut(&mut self) -> &mut Self::Target { + &mut self.task + } +} + +pub type TaskStatusNotification = + Notification; + +// ============================================================================= +// MESSAGE TYPE UNIONS +// ============================================================================= + +macro_rules! ts_union { + ( + export type $U:ident = + $($rest:tt)* + ) => { + ts_union!(@declare $U { $($rest)* }); + ts_union!(@impl_from $U { $($rest)* }); + }; + (@declare $U:ident { $($variant:tt)* }) => { + ts_union!(@declare_variant $U { } {$($variant)*} ); + }; + (@declare_variant $U:ident { $($declared:tt)* } {$(|)? box $V:ident $($rest:tt)*}) => { + ts_union!(@declare_variant $U { $($declared)* $V(Box<$V>), } {$($rest)*}); + }; + (@declare_variant $U:ident { $($declared:tt)* } {$(|)? $V:ident $($rest:tt)*}) => { + ts_union!(@declare_variant $U { $($declared)* $V($V), } {$($rest)*}); + }; + (@declare_variant $U:ident { $($declared:tt)* } { ; }) => { + ts_union!(@declare_end $U { $($declared)* } ); + }; + (@declare_end $U:ident { $($declared:tt)* }) => { + #[derive(Debug, Serialize, Deserialize, Clone)] + #[serde(untagged)] + #[allow(clippy::large_enum_variant)] + #[non_exhaustive] + #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] + pub enum $U { + $($declared)* + } + }; + (@impl_from $U: ident {$(|)? box $V:ident $($rest:tt)*}) => { + impl From<$V> for $U { + fn from(value: $V) -> Self { + $U::$V(Box::new(value)) + } + } + ts_union!(@impl_from $U {$($rest)*}); + }; + (@impl_from $U: ident {$(|)? $V:ident $($rest:tt)*}) => { + impl From<$V> for $U { + fn from(value: $V) -> Self { + $U::$V(value) + } + } + ts_union!(@impl_from $U {$($rest)*}); + }; + (@impl_from $U: ident { ; }) => {}; + (@impl_from $U: ident { }) => {}; +} + +ts_union!( + export type ClientRequest = + | PingRequest + | InitializeRequest + | DiscoverRequest + | CompleteRequest + | SetLevelRequest + | GetPromptRequest + | ListPromptsRequest + | ListResourcesRequest + | ListResourceTemplatesRequest + | ReadResourceRequest + | SubscriptionsListenRequest + | SubscribeRequest + | UnsubscribeRequest + | CallToolRequest + | ListToolsRequest + | GetTaskRequest + | UpdateTaskRequest + | CancelTaskRequest + | CustomRequest; +); + +impl ClientRequest { + pub fn method(&self) -> &str { + match &self { + ClientRequest::PingRequest(r) => r.method.as_str(), + ClientRequest::InitializeRequest(r) => r.method.as_str(), + ClientRequest::DiscoverRequest(r) => r.method.as_str(), + ClientRequest::CompleteRequest(r) => r.method.as_str(), + ClientRequest::SetLevelRequest(r) => r.method.as_str(), + ClientRequest::GetPromptRequest(r) => r.method.as_str(), + ClientRequest::ListPromptsRequest(r) => r.method.as_str(), + ClientRequest::ListResourcesRequest(r) => r.method.as_str(), + ClientRequest::ListResourceTemplatesRequest(r) => r.method.as_str(), + ClientRequest::ReadResourceRequest(r) => r.method.as_str(), + ClientRequest::SubscriptionsListenRequest(r) => r.method.as_str(), + ClientRequest::SubscribeRequest(r) => r.method.as_str(), + ClientRequest::UnsubscribeRequest(r) => r.method.as_str(), + ClientRequest::CallToolRequest(r) => r.method.as_str(), + ClientRequest::ListToolsRequest(r) => r.method.as_str(), + ClientRequest::GetTaskRequest(r) => r.method.as_str(), + ClientRequest::UpdateTaskRequest(r) => r.method.as_str(), + ClientRequest::CancelTaskRequest(r) => r.method.as_str(), + ClientRequest::CustomRequest(r) => r.method.as_str(), + } + } +} + +ts_union!( + export type ClientNotification = + | CancelledNotification + | ProgressNotification + | InitializedNotification + | RootsListChangedNotification + | CustomNotification; +); + +ts_union!( + export type ClientResult = + box CreateMessageResult + | ListRootsResult + | ElicitResult + | EmptyResult + | CustomResult; +); + +impl ClientResult { + pub fn empty(_: ()) -> ClientResult { + ClientResult::EmptyResult(EmptyResult {}) + } +} + +pub type ClientJsonRpcMessage = JsonRpcMessage; + +ts_union!( + export type ServerRequest = + | PingRequest + | CreateMessageRequest + | ListRootsRequest + | ElicitRequest + | CustomRequest; +); + +ts_union!( + export type ServerNotification = + | CancelledNotification + | ProgressNotification + | LoggingMessageNotification + | ResourceUpdatedNotification + | ResourceListChangedNotification + | ToolListChangedNotification + | PromptListChangedNotification + | SubscriptionsAcknowledgedNotification + | TaskStatusNotification + | CustomNotification; +); + +ts_union!( + export type ServerResult = + | DiscoverResult + | InitializeResult + | CompleteResult + | GetPromptResult + | ListPromptsResult + | ListResourcesResult + | ListResourceTemplatesResult + | ReadResourceResult + | SubscriptionsListenResult + | ListToolsResult + | ElicitResult + | CreateTaskResult + | GetTaskResult + | CallToolResult + | InputRequiredResult + // TaskAckResult must come after CallToolResult/InputRequiredResult in this + // untagged union: it only carries `resultType`, so it would otherwise + // shadow any result that includes `resultType: "complete"`. + | TaskAckResult + | EmptyResult + | CustomResult + ; +); + +impl ServerResult { + pub fn empty(_: ()) -> ServerResult { + ServerResult::EmptyResult(EmptyResult {}) + } + + /// Empty `tasks/update` / `tasks/cancel` acknowledgement carrying the + /// SEP-2322 `resultType: "complete"` discriminator (SEP-2663). + pub fn task_ack(_: ()) -> ServerResult { + ServerResult::TaskAckResult(TaskAckResult::new()) + } + + /// Strip the SEP-2322 `resultType: "complete"` discriminator so the result + /// keeps the wire shape that predates protocol version `2026-07-28`. + /// + /// The server handler calls this before responding to a peer that + /// negotiated an older protocol version, where the field did not exist and + /// strict peers may reject it. Only the `"complete"` value is stripped: + /// results whose discriminator carries meaning (`"input_required"`, + /// `"task"`) are already gated to `2026-07-28`+ sessions, and custom + /// extension values are preserved. + /// + /// # Examples + /// + /// ``` + /// use rmcp::model::{CallToolResult, ServerResult}; + /// + /// let mut result = ServerResult::CallToolResult(CallToolResult::success(vec![])); + /// result.strip_result_type_for_legacy_peer(); + /// + /// let json = serde_json::to_value(&result).unwrap(); + /// assert!(json.get("resultType").is_none()); + /// ``` + pub fn strip_result_type_for_legacy_peer(&mut self) { + let result_type = match self { + ServerResult::CompleteResult(r) => &mut r.result_type, + ServerResult::GetPromptResult(r) => &mut r.result_type, + ServerResult::ListPromptsResult(r) => &mut r.result_type, + ServerResult::ListResourcesResult(r) => &mut r.result_type, + ServerResult::ListResourceTemplatesResult(r) => &mut r.result_type, + ServerResult::ReadResourceResult(r) => &mut r.result_type, + ServerResult::ListToolsResult(r) => &mut r.result_type, + ServerResult::CallToolResult(r) => &mut r.result_type, + _ => return, + }; + result_type.take_if(|result_type| result_type.is_complete()); + } +} + +pub type ServerJsonRpcMessage = JsonRpcMessage; + +impl TryInto for ServerNotification { + type Error = ServerNotification; + fn try_into(self) -> Result { + if let ServerNotification::CancelledNotification(t) = self { + Ok(t) + } else { + Err(self) + } + } +} + +impl TryInto for ClientNotification { + type Error = ClientNotification; + fn try_into(self) -> Result { + if let ClientNotification::CancelledNotification(t) = self { + Ok(t) + } else { + Err(self) + } + } +} + +// ============================================================================= +// TESTS +// ============================================================================= + +#[cfg(test)] +mod tests { + use serde_json::json; + + use super::*; + + #[test] + fn known_versions_are_ordered_oldest_first() { + // `known_up_to` walks the list as a sorted prefix. + assert!( + ProtocolVersion::KNOWN_VERSIONS + .windows(2) + .all(|pair| pair[0].as_str() < pair[1].as_str()) + ); + } + + // Guards the pair of constants this SDK's negotiation rests on. `LATEST` + // and `LATEST_WITH_INITIALIZE` were the same value until `LATEST` reached + // `NO_INITIALIZE`; conflating them is what made bumping `LATEST` expensive. + #[test] + fn latest_with_initialize_is_the_newest_known_version_that_has_one() { + let derived = ProtocolVersion::KNOWN_VERSIONS + .iter() + .filter(|version| version.has_initialize()) + .max_by(|left, right| left.as_str().cmp(right.as_str())) + .expect("some known version should have an initialize handshake"); + assert_eq!( + derived, + &ProtocolVersion::LATEST_WITH_INITIALIZE, + "LATEST_WITH_INITIALIZE must track KNOWN_VERSIONS" + ); + } + + #[test] + fn has_initialize_splits_known_versions_at_no_initialize() { + for version in ProtocolVersion::KNOWN_VERSIONS { + assert_eq!( + version.has_initialize(), + version.as_str() < ProtocolVersion::NO_INITIALIZE.as_str(), + "{version} classified inconsistently" + ); + } + } + + #[test] + fn known_up_to_includes_the_ceiling_itself() { + assert_eq!( + ProtocolVersion::known_up_to(&ProtocolVersion::V_2024_11_05), + &[ProtocolVersion::V_2024_11_05] + ); + } + + #[test] + fn known_up_to_the_newest_version_yields_every_known_version() { + assert_eq!( + ProtocolVersion::known_up_to(&ProtocolVersion::V_2026_07_28), + ProtocolVersion::KNOWN_VERSIONS + ); + } + + #[test] + fn known_up_to_an_unknown_ceiling_stops_at_the_versions_below_it() { + let unknown = ProtocolVersion(Cow::Borrowed("2025-07-01")); + assert_eq!( + ProtocolVersion::known_up_to(&unknown), + &[ + ProtocolVersion::V_2024_11_05, + ProtocolVersion::V_2025_03_26, + ProtocolVersion::V_2025_06_18, + ] + ); + } + + #[test] + fn known_up_to_a_ceiling_below_every_known_version_is_empty() { + let ancient = ProtocolVersion(Cow::Borrowed("1999-01-01")); + assert!(ProtocolVersion::known_up_to(&ancient).is_empty()); + } + + #[cfg(feature = "transport-streamable-http-client")] + #[test] + fn transport_closed_marker_accepts_only_the_process_local_token() { + let local = ErrorData::transport_closed("closed"); + let spoofed = ErrorData::internal_error( + "spoofed", + Some(json!({ "io.modelcontextprotocol/transportClosed": true })), + ); + + assert!(local.is_transport_closed()); + assert!(!spoofed.is_transport_closed()); + } + + #[test] + fn cancelled_notification_request_id_is_optional_on_wire() { + // None → requestId 생략 + let p = CancelledNotificationParam::new(None, Some("user cancelled".into())); + let v = serde_json::to_value(&p).unwrap(); + assert!(v.get("requestId").is_none()); + + // Some → requestId 방출 + 라운드트립 + let p = CancelledNotificationParam::new(Some(RequestId::Number(1)), None); + let v = serde_json::to_value(&p).unwrap(); + assert_eq!(v["requestId"], json!(1)); + let back: CancelledNotificationParam = serde_json::from_value(v).unwrap(); + assert_eq!(back.request_id, Some(RequestId::Number(1))); + } + + #[test] + fn test_notification_serde() { + let raw = json!( { + "jsonrpc": JsonRpcVersion2_0, + "method": InitializedNotificationMethod, + }); + let message: ClientJsonRpcMessage = + serde_json::from_value(raw.clone()).expect("invalid notification"); + match &message { + ClientJsonRpcMessage::Notification(JsonRpcNotification { + notification: ClientNotification::InitializedNotification(_n), + .. + }) => {} + _ => panic!("Expected Notification"), + } + let json = serde_json::to_value(message).expect("valid json"); + assert_eq!(json, raw); + } + + #[test] + fn test_custom_client_notification_roundtrip() { + let raw = json!( { + "jsonrpc": JsonRpcVersion2_0, + "method": "notifications/custom", + "params": {"foo": "bar"}, + }); + + let message: ClientJsonRpcMessage = + serde_json::from_value(raw.clone()).expect("invalid notification"); + match &message { + ClientJsonRpcMessage::Notification(JsonRpcNotification { + notification: ClientNotification::CustomNotification(notification), + .. + }) => { + assert_eq!(notification.method, "notifications/custom"); + assert_eq!( + notification + .params + .as_ref() + .and_then(|p| p.get("foo")) + .expect("foo present"), + "bar" + ); + } + _ => panic!("Expected custom client notification"), + } + + let json = serde_json::to_value(message).expect("valid json"); + assert_eq!(json, raw); + } + + #[test] + fn test_custom_server_notification_roundtrip() { + let raw = json!( { + "jsonrpc": JsonRpcVersion2_0, + "method": "notifications/custom-server", + "params": {"hello": "world"}, + }); + + let message: ServerJsonRpcMessage = + serde_json::from_value(raw.clone()).expect("invalid notification"); + match &message { + ServerJsonRpcMessage::Notification(JsonRpcNotification { + notification: ServerNotification::CustomNotification(notification), + .. + }) => { + assert_eq!(notification.method, "notifications/custom-server"); + assert_eq!( + notification + .params + .as_ref() + .and_then(|p| p.get("hello")) + .expect("hello present"), + "world" + ); + } + _ => panic!("Expected custom server notification"), + } + + let json = serde_json::to_value(message).expect("valid json"); + assert_eq!(json, raw); + } + + #[test] + fn test_custom_request_roundtrip() { + let raw = json!( { + "jsonrpc": JsonRpcVersion2_0, + "id": 42, + "method": "requests/custom", + "params": {"foo": "bar"}, + }); + + let message: ClientJsonRpcMessage = + serde_json::from_value(raw.clone()).expect("invalid request"); + match &message { + ClientJsonRpcMessage::Request(JsonRpcRequest { id, request, .. }) => { + assert_eq!(id, &RequestId::Number(42)); + match request { + ClientRequest::CustomRequest(custom) => { + let expected_request = json!({ + "method": "requests/custom", + "params": {"foo": "bar"}, + }); + let actual_request = + serde_json::to_value(custom).expect("serialize custom request"); + assert_eq!(actual_request, expected_request); + } + other => panic!("Expected custom request, got: {other:?}"), + } + } + other => panic!("Expected request, got: {other:?}"), + } + + let json = serde_json::to_value(message).expect("valid json"); + assert_eq!(json, raw); + } + + #[test] + fn test_request_conversion() { + let raw = json!( { + "jsonrpc": JsonRpcVersion2_0, + "id": 1, + "method": "request", + "params": {"key": "value"}, + }); + let message: JsonRpcMessage = serde_json::from_value(raw.clone()).expect("invalid request"); + + match &message { + JsonRpcMessage::Request(r) => { + assert_eq!(r.id, RequestId::Number(1)); + assert_eq!(r.request.method, "request"); + assert_eq!( + &r.request.params, + json!({"key": "value"}) + .as_object() + .expect("should be an object") + ); + } + _ => panic!("Expected Request"), + } + let json = serde_json::to_value(&message).expect("valid json"); + assert_eq!(json, raw); + } + + #[test] + fn test_initial_request_response_serde() { + let request = json!({ + "jsonrpc": "2.0", + "id": 1, + "method": "initialize", + "params": { + "protocolVersion": "2024-11-05", + "capabilities": { + "roots": { + "listChanged": true + }, + "sampling": {} + }, + "clientInfo": { + "name": "ExampleClient", + "version": "1.0.0" + } + } + }); + let raw_response_json = json!({ + "jsonrpc": "2.0", + "id": 1, + "result": { + "protocolVersion": "2024-11-05", + "capabilities": { + "logging": {}, + "prompts": { + "listChanged": true + }, + "resources": { + "subscribe": true, + "listChanged": true + }, + "tools": { + "listChanged": true + } + }, + "serverInfo": { + "name": "ExampleServer", + "version": "1.0.0" + } + } + }); + let request: ClientJsonRpcMessage = + serde_json::from_value(request.clone()).expect("invalid request"); + let (request, id) = request.into_request().expect("should be a request"); + assert_eq!(id, RequestId::Number(1)); + match request { + ClientRequest::InitializeRequest(Request { + method: _, + params: + InitializeRequestParams { + meta: _, + protocol_version: _, + capabilities, + client_info, + }, + .. + }) => { + assert_eq!(capabilities.roots.unwrap().list_changed, Some(true)); + let sampling = capabilities.sampling.unwrap(); + assert_eq!(sampling.tools, None); + assert_eq!(sampling.context, None); + assert_eq!(client_info.name, "ExampleClient"); + assert_eq!(client_info.version, "1.0.0"); + } + _ => panic!("Expected InitializeRequest"), + } + let server_response: ServerJsonRpcMessage = + serde_json::from_value(raw_response_json.clone()).expect("invalid response"); + let (response, id) = server_response + .clone() + .into_response() + .expect("expect response"); + assert_eq!(id, RequestId::Number(1)); + match response { + ServerResult::InitializeResult(InitializeResult { + protocol_version: _, + capabilities, + server_info, + instructions, + .. + }) => { + assert_eq!(capabilities.logging.unwrap().len(), 0); + assert_eq!(capabilities.prompts.unwrap().list_changed, Some(true)); + assert_eq!( + capabilities.resources.as_ref().unwrap().subscribe, + Some(true) + ); + assert_eq!(capabilities.resources.unwrap().list_changed, Some(true)); + assert_eq!(capabilities.tools.unwrap().list_changed, Some(true)); + assert_eq!(server_info.name, "ExampleServer"); + assert_eq!(server_info.version, "1.0.0"); + assert_eq!(server_info.icons, None); + assert_eq!(instructions, None); + } + other => panic!("Expected InitializeResult, got {other:?}"), + } + + let server_response_json: Value = serde_json::to_value(&server_response).expect("msg"); + + assert_eq!(server_response_json, raw_response_json); + } + + #[test] + fn test_negative_and_large_request_ids() { + // Test negative ID + let negative_id_json = json!({ + "jsonrpc": "2.0", + "id": -1, + "method": "test", + "params": {} + }); + + let message: JsonRpcMessage = + serde_json::from_value(negative_id_json.clone()).expect("Should parse negative ID"); + + match &message { + JsonRpcMessage::Request(r) => { + assert_eq!(r.id, RequestId::Number(-1)); + } + _ => panic!("Expected Request"), + } + + // Test roundtrip serialization + let serialized = serde_json::to_value(&message).expect("Should serialize"); + assert_eq!(serialized, negative_id_json); + + // Test large negative ID + let large_negative_json = json!({ + "jsonrpc": "2.0", + "id": -9007199254740991i64, // JavaScript's MIN_SAFE_INTEGER + "method": "test", + "params": {} + }); + + let message: JsonRpcMessage = serde_json::from_value(large_negative_json.clone()) + .expect("Should parse large negative ID"); + + match &message { + JsonRpcMessage::Request(r) => { + assert_eq!(r.id, RequestId::Number(-9007199254740991i64)); + } + _ => panic!("Expected Request"), + } + + // Test large positive ID (JavaScript's MAX_SAFE_INTEGER) + let large_positive_json = json!({ + "jsonrpc": "2.0", + "id": 9007199254740991i64, + "method": "test", + "params": {} + }); + + let message: JsonRpcMessage = serde_json::from_value(large_positive_json.clone()) + .expect("Should parse large positive ID"); + + match &message { + JsonRpcMessage::Request(r) => { + assert_eq!(r.id, RequestId::Number(9007199254740991i64)); + } + _ => panic!("Expected Request"), + } + + // Test zero ID + let zero_id_json = json!({ + "jsonrpc": "2.0", + "id": 0, + "method": "test", + "params": {} + }); + + let message: JsonRpcMessage = + serde_json::from_value(zero_id_json.clone()).expect("Should parse zero ID"); + + match &message { + JsonRpcMessage::Request(r) => { + assert_eq!(r.id, RequestId::Number(0)); + } + _ => panic!("Expected Request"), + } + } + + #[test] + fn test_protocol_version_order() { + let v1 = ProtocolVersion::V_2024_11_05; + let v2 = ProtocolVersion::V_2025_03_26; + let v3 = ProtocolVersion::V_2025_06_18; + let v4 = ProtocolVersion::V_2025_11_25; + assert!(v1 < v2); + assert!(v2 < v3); + assert!(v3 < v4); + } + + #[test] + fn test_icon_serialization() { + let icon = Icon { + src: "https://example.com/icon.png".to_string(), + mime_type: Some("image/png".to_string()), + sizes: Some(vec!["48x48".to_string()]), + theme: Some(IconTheme::Light), + }; + + let json = serde_json::to_value(&icon).unwrap(); + assert_eq!(json["src"], "https://example.com/icon.png"); + assert_eq!(json["mimeType"], "image/png"); + assert_eq!(json["sizes"][0], "48x48"); + assert_eq!(json["theme"], "light"); + + // Test deserialization + let deserialized: Icon = serde_json::from_value(json).unwrap(); + assert_eq!(deserialized, icon); + } + + #[test] + fn test_icon_minimal() { + let icon = Icon { + src: "data:image/svg+xml;base64,PHN2Zy8+".to_string(), + mime_type: None, + sizes: None, + theme: None, + }; + + let json = serde_json::to_value(&icon).unwrap(); + assert_eq!(json["src"], "data:image/svg+xml;base64,PHN2Zy8+"); + assert!(json.get("mimeType").is_none()); + assert!(json.get("sizes").is_none()); + assert!(json.get("theme").is_none()); + } + + #[test] + fn test_implementation_with_icons() { + let implementation = Implementation { + name: "test-server".to_string(), + title: Some("Test Server".to_string()), + version: "1.0.0".to_string(), + description: Some("A test server for unit testing".to_string()), + icons: Some(vec![ + Icon { + src: "https://example.com/icon.png".to_string(), + mime_type: Some("image/png".to_string()), + sizes: Some(vec!["48x48".to_string()]), + theme: Some(IconTheme::Dark), + }, + Icon { + src: "https://example.com/icon.svg".to_string(), + mime_type: Some("image/svg+xml".to_string()), + sizes: Some(vec!["any".to_string()]), + theme: Some(IconTheme::Light), + }, + ]), + website_url: Some("https://example.com".to_string()), + }; + + let json = serde_json::to_value(&implementation).unwrap(); + assert_eq!(json["name"], "test-server"); + assert_eq!(json["description"], "A test server for unit testing"); + assert_eq!(json["websiteUrl"], "https://example.com"); + assert!(json["icons"].is_array()); + assert_eq!(json["icons"][0]["src"], "https://example.com/icon.png"); + assert_eq!(json["icons"][0]["sizes"][0], "48x48"); + assert_eq!(json["icons"][1]["mimeType"], "image/svg+xml"); + assert_eq!(json["icons"][1]["sizes"][0], "any"); + assert_eq!(json["icons"][0]["theme"], "dark"); + assert_eq!(json["icons"][1]["theme"], "light"); + } + + #[test] + fn test_backward_compatibility() { + // Test that old JSON without icons still deserializes correctly + let old_json = json!({ + "name": "legacy-server", + "version": "0.9.0" + }); + + let implementation: Implementation = serde_json::from_value(old_json).unwrap(); + assert_eq!(implementation.name, "legacy-server"); + assert_eq!(implementation.version, "0.9.0"); + assert_eq!(implementation.description, None); + assert_eq!(implementation.icons, None); + assert_eq!(implementation.website_url, None); + } + + #[test] + fn test_initialize_with_icons() { + let init_result = InitializeResult { + protocol_version: ProtocolVersion::default(), + capabilities: ServerCapabilities::default(), + server_info: Implementation { + name: "icon-server".to_string(), + title: None, + version: "2.0.0".to_string(), + description: None, + icons: Some(vec![Icon { + src: "https://example.com/server.png".to_string(), + mime_type: Some("image/png".to_string()), + sizes: Some(vec!["48x48".to_string()]), + theme: Some(IconTheme::Light), + }]), + website_url: Some("https://docs.example.com".to_string()), + }, + instructions: None, + meta: None, + }; + + let json = serde_json::to_value(&init_result).unwrap(); + assert!(json["serverInfo"]["icons"].is_array()); + assert_eq!( + json["serverInfo"]["icons"][0]["src"], + "https://example.com/server.png" + ); + assert_eq!(json["serverInfo"]["icons"][0]["sizes"][0], "48x48"); + assert_eq!(json["serverInfo"]["icons"][0]["theme"], "light"); + assert_eq!(json["serverInfo"]["websiteUrl"], "https://docs.example.com"); + } + + #[test] + fn elicitation_without_mode_deserializes_as_form() { + let json_data_without_tag = json!({ + "message": "Please provide more details.", + "requestedSchema": { + "title": "User Details", + "type": "object", + "properties": { + "name": { "type": "string" }, + "age": { "type": "integer" } + }, + "required": ["name", "age"] + } + }); + let elicitation: ElicitRequestParams = + serde_json::from_value(json_data_without_tag).expect("Deserialization failed"); + if let ElicitRequestParams::FormElicitationParams { + meta, + message, + requested_schema, + } = elicitation + { + assert_eq!(meta, None); + assert_eq!(message, "Please provide more details."); + assert_eq!(requested_schema.title, Some(Cow::from("User Details"))); + assert_eq!(requested_schema.type_, ObjectTypeConst); + } else { + panic!("Expected FormElicitationParams"); + } + } + + #[test] + fn test_elicitation_deserialization() { + let json_data_form = json!({ + "_meta": { "meta_form_key_1": "meta form value 1" }, + "mode": "form", + "message": "Please provide more details.", + "requestedSchema": { + "title": "User Details", + "type": "object", + "properties": { + "name": { "type": "string" }, + "age": { "type": "integer" } + }, + "required": ["name", "age"] + } + }); + let elicitation_form: ElicitRequestParams = + serde_json::from_value(json_data_form).expect("Deserialization failed"); + if let ElicitRequestParams::FormElicitationParams { + meta, + message, + requested_schema, + } = elicitation_form + { + assert_eq!( + meta, + Some(RequestMetaObject(MetaObject( + object!({ "meta_form_key_1": "meta form value 1" }) + ))) + ); + assert_eq!(message, "Please provide more details."); + assert_eq!(requested_schema.title, Some(Cow::from("User Details"))); + assert_eq!(requested_schema.type_, ObjectTypeConst); + } else { + panic!("Expected FormElicitationParams"); + } + + let json_data_url = json!({ + "_meta": { "meta_url_key_1": "meta url value 1" }, + "mode": "url", + "message": "Please fill out the form at the following URL.", + "url": "https://example.com/form", + "elicitationId": "elicitation-123" + }); + let elicitation_url: ElicitRequestParams = + serde_json::from_value(json_data_url).expect("Deserialization failed"); + if let ElicitRequestParams::UrlElicitationParams { + meta, + message, + url, + elicitation_id, + } = elicitation_url + { + assert_eq!( + meta, + Some(RequestMetaObject(MetaObject( + object!({ "meta_url_key_1": "meta url value 1" }) + ))) + ); + assert_eq!(message, "Please fill out the form at the following URL."); + assert_eq!(url, "https://example.com/form"); + assert_eq!(elicitation_id, "elicitation-123"); + } else { + panic!("Expected UrlElicitationParams"); + } + } + + #[test] + fn test_elicitation_serialization() { + let form_elicitation = ElicitRequestParams::FormElicitationParams { + meta: Some(RequestMetaObject(MetaObject( + object!({ "meta_form_key_1": "meta form value 1" }), + ))), + message: "Please provide more details.".to_string(), + requested_schema: ElicitationSchema::builder() + .title("User Details") + .string_property("name", |s| s) + .build() + .expect("Valid schema"), + }; + let json_form = serde_json::to_value(&form_elicitation).expect("Serialization failed"); + let expected_form_json = json!({ + "_meta": { "meta_form_key_1": "meta form value 1" }, + "mode": "form", + "message": "Please provide more details.", + "requestedSchema": { + "title":"User Details", + "type":"object", + "properties":{ + "name": { "type": "string" }, + }, + } + }); + assert_eq!(json_form, expected_form_json); + + let url_elicitation = ElicitRequestParams::UrlElicitationParams { + meta: Some(RequestMetaObject(MetaObject( + object!({ "meta_url_key_1": "meta url value 1" }), + ))), + message: "Please fill out the form at the following URL.".to_string(), + url: "https://example.com/form".to_string(), + elicitation_id: "elicitation-123".to_string(), + }; + let json_url = serde_json::to_value(&url_elicitation).expect("Serialization failed"); + let expected_url_json = json!({ + "_meta": { "meta_url_key_1": "meta url value 1" }, + "mode": "url", + "message": "Please fill out the form at the following URL.", + "url": "https://example.com/form", + "elicitationId": "elicitation-123" + }); + assert_eq!(json_url, expected_url_json); + } + + #[test] + fn notification_without_params_should_deserialize_as_bare_jsonrpc_message() { + let payload = b"{\"method\":\"notifications/initialized\",\"jsonrpc\":\"2.0\"}"; + let result: Result = serde_json::from_slice(payload); + assert!( + matches!(result, Ok(JsonRpcMessage::Notification(_))), + "Expected Ok(Notification), got: {:?}", + result + ); + } +} diff --git a/vendor/rmcp/src/model/annotated.rs b/vendor/rmcp/src/model/annotated.rs new file mode 100644 index 00000000..65b31a1a --- /dev/null +++ b/vendor/rmcp/src/model/annotated.rs @@ -0,0 +1,123 @@ +//! Annotations for content blocks and resources. +//! +//! The `Annotations` struct carries optional hints about audience, priority, and freshness. +//! Individual content/resource types embed `annotations: Option` directly. + +use chrono::{DateTime, Utc}; +use serde::{Deserialize, Serialize}; + +use super::Role; + +/// Optional annotations for the client. The client can use annotations to inform how objects are +/// used or displayed. +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct Annotations { + #[serde(skip_serializing_if = "Option::is_none")] + pub audience: Option>, + #[serde( + default, + deserialize_with = "super::serde_impl::json_float::option_f32", + skip_serializing_if = "Option::is_none" + )] + pub priority: Option, + #[serde(skip_serializing_if = "Option::is_none", rename = "lastModified")] + pub last_modified: Option, +} + +impl Annotations { + /// Creates annotations for a resource with priority and an RFC 3339 timestamp. + /// + /// # Panics + /// + /// Panics if `priority` is not in the inclusive range `0.0..=1.0`. + pub fn for_resource(priority: f32, timestamp: DateTime) -> Self { + assert!( + (0.0..=1.0).contains(&priority), + "Priority {priority} must be between 0.0 and 1.0" + ); + Self { + priority: Some(priority), + last_modified: Some(timestamp.to_rfc3339()), + audience: None, + } + } + + pub fn with_audience(mut self, audience: Vec) -> Self { + self.audience = Some(audience); + self + } + + pub fn with_priority(mut self, priority: f32) -> Self { + self.priority = Some(priority); + self + } + + /// Sets `lastModified` from a typed timestamp, serialized as RFC 3339. + pub fn with_timestamp(mut self, timestamp: DateTime) -> Self { + self.last_modified = Some(timestamp.to_rfc3339()); + self + } + + /// Sets `lastModified` to the current time, serialized as RFC 3339. + pub fn with_timestamp_now(self) -> Self { + self.with_timestamp(Utc::now()) + } +} + +#[cfg(test)] +mod tests { + use chrono::TimeZone; + use serde_json::json; + + use super::*; + + fn annotations_of(value: serde_json::Value) -> Annotations { + serde_json::from_value::(value).unwrap() + } + + #[test] + fn preserves_date_only_last_modified_verbatim() { + let annotations = annotations_of(json!({ "lastModified": "2025-01-12" })); + assert_eq!(annotations.last_modified.as_deref(), Some("2025-01-12")); + } + + #[test] + fn preserves_rfc3339_last_modified_verbatim() { + let value = "2025-01-12T15:00:58Z"; + let annotations = annotations_of(json!({ "lastModified": value })); + assert_eq!(annotations.last_modified.as_deref(), Some(value)); + } + + #[test] + fn missing_last_modified_is_none() { + let annotations = annotations_of(json!({})); + assert_eq!(annotations.last_modified, None); + } + + #[test] + fn null_last_modified_is_none() { + let annotations = annotations_of(json!({ "lastModified": null })); + assert_eq!(annotations.last_modified, None); + } + + #[test] + fn invalid_last_modified_string_is_preserved() { + let annotations = annotations_of(json!({ "lastModified": "not-a-date" })); + assert_eq!(annotations.last_modified.as_deref(), Some("not-a-date")); + } + + #[test] + fn timestamp_round_trips_as_rfc3339_string() { + let timestamp = Utc.with_ymd_and_hms(2025, 1, 12, 15, 0, 58).unwrap(); + let annotations = Annotations::default().with_timestamp(timestamp); + + let value = serde_json::to_value(&annotations).unwrap(); + assert_eq!(value["lastModified"], json!(timestamp.to_rfc3339())); + + let round_tripped: Annotations = serde_json::from_value(value).unwrap(); + assert_eq!(round_tripped, annotations); + } +} diff --git a/vendor/rmcp/src/model/capabilities.rs b/vendor/rmcp/src/model/capabilities.rs new file mode 100644 index 00000000..f014f569 --- /dev/null +++ b/vendor/rmcp/src/model/capabilities.rs @@ -0,0 +1,680 @@ +use std::collections::BTreeMap; +#[cfg(any(feature = "server", feature = "macros"))] +use std::marker::PhantomData; + +#[cfg(any(feature = "server", feature = "macros"))] +use pastey::paste; +use serde::{Deserialize, Serialize}; + +use super::JsonObject; +pub type ExperimentalCapabilities = BTreeMap; + +/// MCP extension capabilities map. +/// +/// Keys are extension identifiers in the format `{vendor-prefix}/{extension-name}` +/// (e.g., `io.modelcontextprotocol/ui`, `io.modelcontextprotocol/oauth-client-credentials`). +/// Values are per-extension settings objects. An empty object indicates support with no settings. +/// +/// # Example +/// +/// ```rust +/// use rmcp::model::ExtensionCapabilities; +/// use serde_json::json; +/// +/// let mut extensions = ExtensionCapabilities::new(); +/// extensions.insert( +/// "io.modelcontextprotocol/ui".to_string(), +/// serde_json::from_value(json!({ +/// "mimeTypes": ["text/html;profile=mcp-app"] +/// })).unwrap() +/// ); +/// ``` +pub type ExtensionCapabilities = BTreeMap; + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct PromptsCapability { + #[serde(skip_serializing_if = "Option::is_none")] + pub list_changed: Option, +} + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct ResourcesCapability { + #[serde(skip_serializing_if = "Option::is_none")] + pub subscribe: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub list_changed: Option, +} + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct ToolsCapability { + #[serde(skip_serializing_if = "Option::is_none")] + pub list_changed: Option, +} + +/// Roots capability. Deprecated by SEP-2577; remains functional and will be +/// removed in a future release. +/// See . +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct RootsCapabilities { + #[serde(skip_serializing_if = "Option::is_none")] + pub list_changed: Option, +} + +/// Capability for handling elicitation requests from servers. +/// Elicitation allows servers to request interactive input from users during tool execution. +/// This capability indicates that a client can handle elicitation requests and present +/// appropriate UI to users for collecting the requested information. +/// +/// Capability for form mode elicitation. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct FormElicitationCapability { + /// Whether the client supports JSON Schema validation for elicitation responses. + /// When true, the client will validate user input against the requested_schema + /// before sending the response back to the server. + #[serde(skip_serializing_if = "Option::is_none")] + pub schema_validation: Option, +} + +impl FormElicitationCapability { + pub fn new() -> Self { + Self::default() + } + + pub fn with_schema_validation(mut self, enabled: bool) -> Self { + self.schema_validation = Some(enabled); + self + } +} + +/// Capability for URL mode elicitation. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct UrlElicitationCapability {} + +impl UrlElicitationCapability { + pub fn new() -> Self { + Self::default() + } +} + +/// Elicitation allows servers to request interactive input from users during tool execution. +/// This capability indicates that a client can handle elicitation requests and present +/// appropriate UI to users for collecting the requested information. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct ElicitationCapability { + /// Whether client supports form-based elicitation. + #[serde(skip_serializing_if = "Option::is_none")] + pub form: Option, + /// Whether client supports URL-based elicitation. + #[serde(skip_serializing_if = "Option::is_none")] + pub url: Option, +} + +impl ElicitationCapability { + pub fn new() -> Self { + Self::default() + } + + pub fn with_form(mut self, form: FormElicitationCapability) -> Self { + self.form = Some(form); + self + } + + pub fn with_url(mut self, url: UrlElicitationCapability) -> Self { + self.url = Some(url); + self + } +} + +/// Sampling capability with optional sub-capabilities (SEP-1577). +/// +/// Deprecated by SEP-2577; remains functional and will be removed in a future +/// release. +/// See . +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct SamplingCapability { + /// Support for `tools` and `toolChoice` parameters + #[serde(skip_serializing_if = "Option::is_none")] + pub tools: Option, + /// Support for `includeContext` (soft-deprecated) + #[serde(skip_serializing_if = "Option::is_none")] + pub context: Option, +} + +/// +/// # Builder +/// ```rust +/// # use rmcp::model::ClientCapabilities; +/// let cap = ClientCapabilities::builder() +/// .enable_experimental() +/// .build(); +/// ``` +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct ClientCapabilities { + #[serde(skip_serializing_if = "Option::is_none")] + pub experimental: Option, + /// Optional MCP extensions that the client supports (SEP-1724). + /// Keys are extension identifiers (e.g., `"io.modelcontextprotocol/ui"`), + /// values are per-extension settings objects. An empty object indicates + /// support with no settings. + #[serde(skip_serializing_if = "Option::is_none")] + pub extensions: Option, + /// Capability for filesystem roots (deprecated by SEP-2577). + #[serde(skip_serializing_if = "Option::is_none")] + pub roots: Option, + /// Capability for LLM sampling requests (SEP-1577, deprecated by SEP-2577). + #[serde(skip_serializing_if = "Option::is_none")] + pub sampling: Option, + /// Capability to handle elicitation requests from servers for interactive user input + #[serde(skip_serializing_if = "Option::is_none")] + pub elicitation: Option, +} + +impl ClientCapabilities { + /// Returns `true` if the `io.modelcontextprotocol/tasks` extension + /// (SEP-2663) is declared in [`Self::extensions`]. + pub fn supports_tasks(&self) -> bool { + self.extensions + .as_ref() + .is_some_and(|e| e.contains_key(super::TASKS_EXTENSION_ID)) + } +} + +/// +/// ## Builder +/// ```rust +/// # use rmcp::model::ServerCapabilities; +/// let cap = ServerCapabilities::builder() +/// .enable_experimental() +/// .enable_prompts() +/// .enable_resources() +/// .enable_tools() +/// .enable_tool_list_changed() +/// .build(); +/// ``` +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct ServerCapabilities { + #[serde(skip_serializing_if = "Option::is_none")] + pub experimental: Option, + /// Optional MCP extensions that the server supports (SEP-1724). + /// Keys are extension identifiers (e.g., `"io.modelcontextprotocol/apps"`), + /// values are per-extension settings objects. An empty object indicates + /// support with no settings. + #[serde(skip_serializing_if = "Option::is_none")] + pub extensions: Option, + /// Capability for server log message notifications (deprecated by SEP-2577). + #[serde(skip_serializing_if = "Option::is_none")] + pub logging: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub completions: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub prompts: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub resources: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub tools: Option, +} + +impl ServerCapabilities { + /// Returns `true` if the `io.modelcontextprotocol/tasks` extension + /// (SEP-2663) is declared in [`Self::extensions`]. + pub fn supports_tasks(&self) -> bool { + self.extensions + .as_ref() + .is_some_and(|e| e.contains_key(super::TASKS_EXTENSION_ID)) + } +} + +#[cfg(any(feature = "server", feature = "macros"))] +macro_rules! builder { + ($Target: ident {$($(#[$fa:meta])* $f: ident: $T: ty),* $(,)?}) => { + paste! { + #[derive(Default, Clone, Copy, Debug)] + #[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] + pub struct [<$Target BuilderState>]< + $(const [<$f:upper>]: bool = false,)* + >; + #[derive(Debug, Default)] + #[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] + pub struct [<$Target Builder>]]> { + $(pub $f: Option<$T>,)* + pub state: PhantomData + } + impl $Target { + #[doc = "Create a new [`" $Target "`] builder."] + pub fn builder() -> [<$Target Builder>] { + <[<$Target Builder>]>::default() + } + } + impl [<$Target Builder>] { + pub fn build(self) -> $Target { + $Target { + $( $f: self.$f, )* + } + } + } + impl From<[<$Target Builder>]> for $Target { + fn from(builder: [<$Target Builder>]) -> Self { + builder.build() + } + } + } + builder!($Target @toggle $($(#[$fa])* $f: $T,)*); + + }; + ($Target: ident @toggle $(#[$fa0:meta])* $f0: ident: $T0: ty, $($(#[$fa:meta])* $f: ident: $T: ty,)*) => { + builder!($Target @toggle [][$(#[$fa0])* $f0: $T0][$($(#[$fa])* $f: $T,)*]); + }; + ($Target: ident @toggle [$($ff: ident: $Tf: ty,)*][$(#[$fna:meta])* $fn: ident: $TN: ty][$(#[$fn1a:meta])* $fn_1: ident: $Tn_1: ty, $($(#[$fta:meta])* $ft: ident: $Tt: ty,)*]) => { + builder!($Target @impl_toggle [$($ff: $Tf,)*][$(#[$fna])* $fn: $TN][$fn_1: $Tn_1, $($ft:$Tt,)*]); + builder!($Target @toggle [$($ff: $Tf,)* $fn: $TN,][$(#[$fn1a])* $fn_1: $Tn_1][$($(#[$fta])* $ft: $Tt,)*]); + }; + ($Target: ident @toggle [$($ff: ident: $Tf: ty,)*][$(#[$fna:meta])* $fn: ident: $TN: ty][]) => { + builder!($Target @impl_toggle [$($ff: $Tf,)*][$(#[$fna])* $fn: $TN][]); + }; + ($Target: ident @impl_toggle [$($ff: ident: $Tf: ty,)*][$(#[$fna:meta])* $fn: ident: $TN: ty][$($ft: ident: $Tt: ty,)*]) => { + paste! { + impl< + $(const [<$ff:upper>]: bool,)* + $(const [<$ft:upper>]: bool,)* + > [<$Target Builder>]<[<$Target BuilderState>]< + $([<$ff:upper>],)* + false, + $([<$ft:upper>],)* + >> { + $(#[$fna])* + pub fn [](self) -> [<$Target Builder>]<[<$Target BuilderState>]< + $([<$ff:upper>],)* + true, + $([<$ft:upper>],)* + >> { + [<$Target Builder>] { + $( $ff: self.$ff, )* + $fn: Some($TN::default()), + $( $ft: self.$ft, )* + state: PhantomData + } + } + $(#[$fna])* + pub fn [](self, $fn: $TN) -> [<$Target Builder>]<[<$Target BuilderState>]< + $([<$ff:upper>],)* + true, + $([<$ft:upper>],)* + >> { + [<$Target Builder>] { + $( $ff: self.$ff, )* + $fn: Some($fn), + $( $ft: self.$ft, )* + state: PhantomData + } + } + } + // do we really need to disable some thing in builder? + // impl< + // $(const [<$ff:upper>]: bool,)* + // $(const [<$ft:upper>]: bool,)* + // > [<$Target Builder>]<[<$Target BuilderState>]< + // $([<$ff:upper>],)* + // true, + // $([<$ft:upper>],)* + // >> { + // pub fn [](self) -> [<$Target Builder>]<[<$Target BuilderState>]< + // $([<$ff:upper>],)* + // false, + // $([<$ft:upper>],)* + // >> { + // [<$Target Builder>] { + // $( $ff: self.$ff, )* + // $fn: None, + // $( $ft: self.$ft, )* + // state: PhantomData + // } + // } + // } + } + } +} + +#[cfg(any(feature = "server", feature = "macros"))] +builder! { + ServerCapabilities { + experimental: ExperimentalCapabilities, + extensions: ExtensionCapabilities, + #[deprecated( + since = "1.8.0", + note = "Logging is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" + )] + logging: JsonObject, + completions: JsonObject, + prompts: PromptsCapability, + resources: ResourcesCapability, + tools: ToolsCapability, + } +} + +#[cfg(any(feature = "server", feature = "macros"))] +impl + ServerCapabilitiesBuilder> +{ + pub fn enable_tool_list_changed(mut self) -> Self { + if let Some(c) = self.tools.as_mut() { + c.list_changed = Some(true); + } + self + } +} + +#[cfg(any(feature = "server", feature = "macros"))] +impl + ServerCapabilitiesBuilder> +{ + pub fn enable_prompts_list_changed(mut self) -> Self { + if let Some(c) = self.prompts.as_mut() { + c.list_changed = Some(true); + } + self + } +} + +#[cfg(any(feature = "server", feature = "macros"))] +impl + ServerCapabilitiesBuilder> +{ + pub fn enable_resources_list_changed(mut self) -> Self { + if let Some(c) = self.resources.as_mut() { + c.list_changed = Some(true); + } + self + } + + pub fn enable_resources_subscribe(mut self) -> Self { + if let Some(c) = self.resources.as_mut() { + c.subscribe = Some(true); + } + self + } +} + +#[cfg(any(feature = "server", feature = "macros"))] +impl ServerCapabilitiesBuilder { + /// Declare support for the `io.modelcontextprotocol/tasks` extension + /// (SEP-2663) in the `extensions` capability map. + pub fn enable_tasks(mut self) -> Self { + self.extensions + .get_or_insert_with(ExtensionCapabilities::new) + .insert(super::TASKS_EXTENSION_ID.to_string(), JsonObject::new()); + self + } +} + +#[cfg(any(feature = "server", feature = "macros"))] +builder! { + ClientCapabilities{ + experimental: ExperimentalCapabilities, + extensions: ExtensionCapabilities, + #[deprecated( + since = "1.8.0", + note = "Roots is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" + )] + roots: RootsCapabilities, + #[deprecated( + since = "1.8.0", + note = "Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" + )] + sampling: SamplingCapability, + elicitation: ElicitationCapability, + } +} + +#[cfg(any(feature = "server", feature = "macros"))] +impl ClientCapabilitiesBuilder { + /// Declare support for the `io.modelcontextprotocol/tasks` extension + /// (SEP-2663) in the `extensions` capability map. + pub fn enable_tasks(mut self) -> Self { + self.extensions + .get_or_insert_with(ExtensionCapabilities::new) + .insert(super::TASKS_EXTENSION_ID.to_string(), JsonObject::new()); + self + } +} + +#[cfg(any(feature = "server", feature = "macros"))] +impl + ClientCapabilitiesBuilder> +{ + #[deprecated( + since = "1.8.0", + note = "Roots is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" + )] + pub fn enable_roots_list_changed(mut self) -> Self { + if let Some(c) = self.roots.as_mut() { + c.list_changed = Some(true); + } + self + } +} + +#[cfg(any(feature = "server", feature = "macros"))] +impl + ClientCapabilitiesBuilder> +{ + /// Enable tool calling in sampling requests + #[deprecated( + since = "1.8.0", + note = "Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" + )] + pub fn enable_sampling_tools(mut self) -> Self { + if let Some(c) = self.sampling.as_mut() { + c.tools = Some(JsonObject::default()); + } + self + } + + /// Enable context inclusion in sampling (soft-deprecated) + #[deprecated( + since = "1.8.0", + note = "Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" + )] + pub fn enable_sampling_context(mut self) -> Self { + if let Some(c) = self.sampling.as_mut() { + c.context = Some(JsonObject::default()); + } + self + } +} + +#[cfg(all(feature = "elicitation", any(feature = "server", feature = "macros")))] +impl + ClientCapabilitiesBuilder> +{ + /// Enable JSON Schema validation for elicitation responses in form mode. + /// When enabled, the client will validate user input against the requested_schema + /// before sending responses back to the server. + pub fn enable_elicitation_schema_validation(mut self) -> Self { + if let Some(c) = self.elicitation.as_mut() { + c.form = Some(FormElicitationCapability { + schema_validation: Some(true), + }); + } + self + } +} + +#[cfg(test)] +#[cfg(any(feature = "server", feature = "macros"))] +mod test { + use super::*; + #[test] + #[allow(deprecated)] + fn test_builder() { + let builder = ::default() + .enable_logging() + .enable_experimental() + .enable_prompts() + .enable_resources() + .enable_tools() + .enable_tool_list_changed(); + assert_eq!(builder.logging, Some(JsonObject::default())); + assert_eq!(builder.prompts, Some(PromptsCapability::default())); + assert_eq!(builder.resources, Some(ResourcesCapability::default())); + assert_eq!( + builder.tools, + Some(ToolsCapability { + list_changed: Some(true), + }) + ); + assert_eq!( + builder.experimental, + Some(ExperimentalCapabilities::default()) + ); + let client_builder = ::default() + .enable_experimental() + .enable_roots() + .enable_roots_list_changed() + .enable_sampling(); + assert_eq!( + client_builder.experimental, + Some(ExperimentalCapabilities::default()) + ); + assert_eq!( + client_builder.roots, + Some(RootsCapabilities { + list_changed: Some(true), + }) + ); + } + + #[test] + fn test_tasks_extension_capability() { + // SEP-2663: tasks are declared via the extensions map. + let capabilities = ClientCapabilities::builder().enable_tasks().build(); + assert!(capabilities.supports_tasks()); + let json = serde_json::to_value(&capabilities).unwrap(); + assert_eq!( + json["extensions"][crate::model::TASKS_EXTENSION_ID], + serde_json::json!({}) + ); + + let server = ServerCapabilities::builder().enable_tasks().build(); + assert!(server.supports_tasks()); + let json = serde_json::to_value(&server).unwrap(); + assert_eq!( + json["extensions"][crate::model::TASKS_EXTENSION_ID], + serde_json::json!({}) + ); + } + + #[test] + #[allow(deprecated)] + fn test_client_extensions_capability() { + // Test building ClientCapabilities with extensions (MCP Apps support) + let mut extensions = ExtensionCapabilities::new(); + extensions.insert( + "io.modelcontextprotocol/ui".to_string(), + serde_json::from_value(serde_json::json!({ + "mimeTypes": ["text/html;profile=mcp-app"] + })) + .unwrap(), + ); + + let capabilities = ClientCapabilities::builder() + .enable_extensions_with(extensions) + .enable_sampling() + .build(); + + // Verify serialization matches MCP Apps spec format + let json = serde_json::to_value(&capabilities).unwrap(); + assert_eq!( + json["extensions"]["io.modelcontextprotocol/ui"]["mimeTypes"], + serde_json::json!(["text/html;profile=mcp-app"]) + ); + assert!(json["sampling"].is_object()); + } + + #[test] + fn test_server_extensions_capability() { + // Test building ServerCapabilities with extensions + let mut extensions = ExtensionCapabilities::new(); + extensions.insert( + "io.modelcontextprotocol/apps".to_string(), + serde_json::from_value(serde_json::json!({})).unwrap(), + ); + + let capabilities = ServerCapabilities::builder() + .enable_extensions_with(extensions) + .enable_tools() + .build(); + + // Verify serialization + let json = serde_json::to_value(&capabilities).unwrap(); + assert!(json["extensions"]["io.modelcontextprotocol/apps"].is_object()); + assert!(json["tools"].is_object()); + } + + #[test] + fn test_extensions_deserialization() { + // Test deserializing capabilities with extensions from JSON + let json = serde_json::json!({ + "extensions": { + "io.modelcontextprotocol/ui": { + "mimeTypes": ["text/html;profile=mcp-app"] + } + }, + "sampling": {} + }); + + let capabilities: ClientCapabilities = serde_json::from_value(json).unwrap(); + assert!(capabilities.extensions.is_some()); + let extensions = capabilities.extensions.unwrap(); + assert!(extensions.contains_key("io.modelcontextprotocol/ui")); + let ui_ext = extensions.get("io.modelcontextprotocol/ui").unwrap(); + assert!(ui_ext.contains_key("mimeTypes")); + } + + #[test] + fn test_extensions_empty_settings() { + // Test that empty extension settings work (indicates support with no settings) + let mut extensions = ExtensionCapabilities::new(); + extensions.insert( + "io.modelcontextprotocol/oauth-client-credentials".to_string(), + JsonObject::new(), + ); + + let capabilities = ClientCapabilities::builder() + .enable_extensions_with(extensions) + .build(); + + let json = serde_json::to_value(&capabilities).unwrap(); + assert_eq!( + json["extensions"]["io.modelcontextprotocol/oauth-client-credentials"], + serde_json::json!({}) + ); + } +} diff --git a/vendor/rmcp/src/model/content.rs b/vendor/rmcp/src/model/content.rs new file mode 100644 index 00000000..11b2f0e5 --- /dev/null +++ b/vendor/rmcp/src/model/content.rs @@ -0,0 +1,464 @@ +//! Content types that flow between agents, tools, prompts, and LLMs. +//! +//! The core union is [`ContentBlock`] (text | image | audio | resource_link | resource), +//! matching the MCP 2025-11-25 `ContentBlock` definition. Each variant carries optional +//! [`Annotations`] and `_meta` inline. +//! +//! [`SamplingMessageContentBlock`] extends the union with `tool_use` and `tool_result` +//! variants for sampling messages (SEP-1577). + +// ToolUseContent/ToolResultContent are SEP-2577-deprecated; internal references are expected. +#![expect(deprecated)] +use serde::{Deserialize, Serialize}; +use serde_json::{Value, json}; + +use super::{Annotations, MetaObject, resource::ResourceContents}; + +// --------------------------------------------------------------------------- +// Flat content structs +// --------------------------------------------------------------------------- + +/// Text content block (spec `TextContent`). +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct TextContent { + /// The text content of the message. + pub text: String, + /// Optional protocol-level metadata for this content block. + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, + /// Optional annotations describing how the client should use this content. + #[serde(skip_serializing_if = "Option::is_none")] + pub annotations: Option, +} + +impl TextContent { + pub fn new(text: impl Into) -> Self { + Self { + text: text.into(), + meta: None, + annotations: None, + } + } + + pub fn with_meta(mut self, meta: MetaObject) -> Self { + self.meta = Some(meta); + self + } + + pub fn with_annotations(mut self, annotations: Annotations) -> Self { + self.annotations = Some(annotations); + self + } +} + +/// Image content with base64-encoded data (spec `ImageContent`). +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct ImageContent { + /// The base64-encoded image data. + pub data: String, + /// The MIME type of the image (e.g. `image/png`). + pub mime_type: String, + /// Optional protocol-level metadata for this content block. + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, + /// Optional annotations describing how the client should use this content. + #[serde(skip_serializing_if = "Option::is_none")] + pub annotations: Option, +} + +impl ImageContent { + pub fn new(data: impl Into, mime_type: impl Into) -> Self { + Self { + data: data.into(), + mime_type: mime_type.into(), + meta: None, + annotations: None, + } + } + + pub fn with_meta(mut self, meta: MetaObject) -> Self { + self.meta = Some(meta); + self + } + + pub fn with_annotations(mut self, annotations: Annotations) -> Self { + self.annotations = Some(annotations); + self + } +} + +/// Audio content with base64-encoded data (spec `AudioContent`). +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct AudioContent { + /// The base64-encoded audio data. + pub data: String, + /// The MIME type of the audio (e.g. `audio/wav`). + pub mime_type: String, + /// Optional protocol-level metadata for this content block. + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, + /// Optional annotations describing how the client should use this content. + #[serde(skip_serializing_if = "Option::is_none")] + pub annotations: Option, +} + +impl AudioContent { + pub fn new(data: impl Into, mime_type: impl Into) -> Self { + Self { + data: data.into(), + mime_type: mime_type.into(), + meta: None, + annotations: None, + } + } + + pub fn with_meta(mut self, meta: MetaObject) -> Self { + self.meta = Some(meta); + self + } + + pub fn with_annotations(mut self, annotations: Annotations) -> Self { + self.annotations = Some(annotations); + self + } +} + +/// Embedded resource content (spec `EmbeddedResource`). +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct EmbeddedResource { + /// The embedded resource contents (text or blob). + pub resource: ResourceContents, + /// Optional protocol-level metadata for this content block. + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, + /// Optional annotations describing how the client should use this content. + #[serde(skip_serializing_if = "Option::is_none")] + pub annotations: Option, +} + +impl EmbeddedResource { + pub fn new(resource: ResourceContents) -> Self { + Self { + resource, + meta: None, + annotations: None, + } + } + + pub fn get_text(&self) -> String { + match &self.resource { + ResourceContents::TextResourceContents { text, .. } => text.clone(), + _ => String::new(), + } + } + + pub fn with_meta(mut self, meta: MetaObject) -> Self { + self.meta = Some(meta); + self + } + + pub fn with_annotations(mut self, annotations: Annotations) -> Self { + self.annotations = Some(annotations); + self + } +} + +/// Tool call request from assistant (SEP-1577). +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +#[deprecated( + since = "2.0.0", + note = "Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" +)] +pub struct ToolUseContent { + pub id: String, + pub name: String, + pub input: super::JsonObject, + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, +} + +/// Tool execution result in user message (SEP-1577). +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +#[deprecated( + since = "2.0.0", + note = "Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" +)] +pub struct ToolResultContent { + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, + pub tool_use_id: String, + pub content: Vec, + #[serde(skip_serializing_if = "Option::is_none")] + pub structured_content: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub is_error: Option, +} + +impl ToolUseContent { + pub fn new(id: impl Into, name: impl Into, input: super::JsonObject) -> Self { + Self { + id: id.into(), + name: name.into(), + input, + meta: None, + } + } +} + +impl ToolResultContent { + pub fn new(tool_use_id: impl Into, content: Vec) -> Self { + Self { + meta: None, + tool_use_id: tool_use_id.into(), + content, + structured_content: None, + is_error: None, + } + } + + pub fn error(tool_use_id: impl Into, content: Vec) -> Self { + Self { + meta: None, + tool_use_id: tool_use_id.into(), + content, + structured_content: None, + is_error: Some(true), + } + } +} + +// --------------------------------------------------------------------------- +// ContentBlock — the unified content union (spec `ContentBlock`) +// --------------------------------------------------------------------------- + +/// Unified content block union (spec `ContentBlock`). +/// +/// `text | image | audio | resource_link | resource` +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(tag = "type", rename_all = "snake_case")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub enum ContentBlock { + Text(TextContent), + Image(ImageContent), + Audio(AudioContent), + Resource(EmbeddedResource), + ResourceLink(super::resource::Resource), +} + +impl ContentBlock { + pub fn json(json: S) -> Result { + let json = serde_json::to_string(&json).map_err(|e| { + crate::ErrorData::internal_error( + "fail to serialize response to json", + Some(json!( + {"reason": e.to_string()} + )), + ) + })?; + Ok(ContentBlock::text(json)) + } + + pub fn text(text: impl Into) -> Self { + ContentBlock::Text(TextContent::new(text)) + } + + pub fn image(data: impl Into, mime_type: impl Into) -> Self { + ContentBlock::Image(ImageContent::new(data, mime_type)) + } + + pub fn audio(data: impl Into, mime_type: impl Into) -> Self { + ContentBlock::Audio(AudioContent::new(data, mime_type)) + } + + pub fn resource(resource: ResourceContents) -> Self { + ContentBlock::Resource(EmbeddedResource::new(resource)) + } + + pub fn embedded_text(uri: impl Into, content: impl Into) -> Self { + ContentBlock::Resource(EmbeddedResource::new( + ResourceContents::TextResourceContents { + uri: uri.into(), + mime_type: Some("text/plain".to_string()), + text: content.into(), + meta: None, + }, + )) + } + + pub fn resource_link(resource: super::resource::Resource) -> Self { + ContentBlock::ResourceLink(resource) + } + + pub fn as_text(&self) -> Option<&TextContent> { + match self { + ContentBlock::Text(text) => Some(text), + _ => None, + } + } + + pub fn as_image(&self) -> Option<&ImageContent> { + match self { + ContentBlock::Image(image) => Some(image), + _ => None, + } + } + + pub fn as_resource(&self) -> Option<&EmbeddedResource> { + match self { + ContentBlock::Resource(resource) => Some(resource), + _ => None, + } + } + + pub fn as_resource_link(&self) -> Option<&super::resource::Resource> { + match self { + ContentBlock::ResourceLink(link) => Some(link), + _ => None, + } + } + + pub fn as_audio(&self) -> Option<&AudioContent> { + match self { + ContentBlock::Audio(audio) => Some(audio), + _ => None, + } + } +} + +// --------------------------------------------------------------------------- +// JsonContent (unchanged) +// --------------------------------------------------------------------------- + +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +pub struct JsonContent(S); + +// --------------------------------------------------------------------------- +// IntoContents +// --------------------------------------------------------------------------- + +/// Types that can be converted into a list of content blocks. +pub trait IntoContents { + fn into_contents(self) -> Vec; +} + +impl IntoContents for ContentBlock { + fn into_contents(self) -> Vec { + vec![self] + } +} + +impl IntoContents for String { + fn into_contents(self) -> Vec { + vec![ContentBlock::text(self)] + } +} + +impl IntoContents for () { + fn into_contents(self) -> Vec { + vec![] + } +} + +#[cfg(test)] +mod tests { + use serde_json; + + use super::*; + + #[test] + fn test_image_content_serialization() { + let image = ImageContent::new("base64data", "image/png"); + let json = serde_json::to_string(&image).unwrap(); + assert!(json.contains("mimeType")); + assert!(!json.contains("mime_type")); + } + + #[test] + fn test_audio_content_serialization() { + let audio = AudioContent::new("base64audiodata", "audio/wav"); + let json = serde_json::to_string(&audio).unwrap(); + assert!(json.contains("mimeType")); + assert!(!json.contains("mime_type")); + } + + #[test] + fn test_audio_content_has_meta() { + let audio = AudioContent::new("data", "audio/wav").with_meta(MetaObject::default()); + let json = serde_json::to_value(&audio).unwrap(); + assert!(json.get("_meta").is_some()); + } + + #[test] + fn test_resource_link_serialization() { + use super::super::resource::Resource; + + let resource_link = ContentBlock::ResourceLink(Resource { + uri: "file:///test.txt".to_string(), + name: "test.txt".to_string(), + title: None, + description: Some("A test file".to_string()), + mime_type: Some("text/plain".to_string()), + size: Some(100), + icons: None, + meta: None, + annotations: None, + }); + + let json = serde_json::to_string(&resource_link).unwrap(); + assert!(json.contains("\"type\":\"resource_link\"")); + assert!(json.contains("\"uri\":\"file:///test.txt\"")); + assert!(json.contains("\"name\":\"test.txt\"")); + } + + #[test] + fn test_resource_link_deserialization() { + let json = r#"{ + "type": "resource_link", + "uri": "file:///example.txt", + "name": "example.txt", + "description": "Example file", + "mimeType": "text/plain" + }"#; + + let content: ContentBlock = serde_json::from_str(json).unwrap(); + + if let ContentBlock::ResourceLink(resource) = content { + assert_eq!(resource.uri, "file:///example.txt"); + assert_eq!(resource.name, "example.txt"); + assert_eq!(resource.description, Some("Example file".to_string())); + assert_eq!(resource.mime_type, Some("text/plain".to_string())); + } else { + panic!("Expected ResourceLink variant"); + } + } + + #[test] + fn test_content_block_text_with_annotations() { + let block = ContentBlock::Text( + TextContent::new("hello").with_annotations(Annotations::default().with_priority(0.8)), + ); + let json = serde_json::to_value(&block).unwrap(); + assert_eq!(json["type"], "text"); + assert_eq!(json["text"], "hello"); + assert_eq!(json["annotations"]["priority"], 0.8_f32); + } +} diff --git a/vendor/rmcp/src/model/elicitation_schema.rs b/vendor/rmcp/src/model/elicitation_schema.rs new file mode 100644 index 00000000..7a556e84 --- /dev/null +++ b/vendor/rmcp/src/model/elicitation_schema.rs @@ -0,0 +1,2396 @@ +//! Type-safe schema definitions for MCP elicitation requests. +//! +//! This module provides strongly-typed schema definitions for elicitation requests +//! that comply with the MCP 2025-06-18 specification. Elicitation schemas must be +//! objects with primitive-typed properties. +//! +//! # Example +//! +//! ```rust +//! use rmcp::model::*; +//! +//! let schema = ElicitationSchema::builder() +//! .required_email("email") +//! .required_integer("age", 0, 150) +//! .optional_bool("newsletter", false) +//! .build(); +//! ``` + +use std::{borrow::Cow, collections::BTreeMap, marker::PhantomData}; + +use indexmap::IndexMap; +use serde::{Deserialize, Deserializer, Serialize}; + +use crate::{const_string, model::ConstString}; + +// ============================================================================= +// CONST TYPES FOR JSON SCHEMA TYPE FIELD +// ============================================================================= + +const_string!(ObjectTypeConst = "object"); +const_string!(StringTypeConst = "string"); +const_string!(NumberTypeConst = "number"); +const_string!(IntegerTypeConst = "integer"); +const_string!(BooleanTypeConst = "boolean"); +const_string!(EnumTypeConst = "string"); +const_string!(ArrayTypeConst = "array"); + +// ============================================================================= +// PRIMITIVE SCHEMA DEFINITIONS +// ============================================================================= + +/// Primitive schema definition for elicitation properties. +/// +/// According to MCP 2025-06-18 specification, elicitation schemas must have +/// properties of primitive types only (string, number, integer, boolean, enum). +/// +/// Note: Put Enum as the first variant to avoid ambiguity during deserialization. +/// This is due to the fact that EnumSchema can contain StringSchema internally and serde +/// uses first match wins strategy when deserializing untagged enums. +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[serde(untagged)] +#[non_exhaustive] +pub enum PrimitiveSchemaDefinition { + /// Enum property (explicit enum schema) + Enum(EnumSchema), + /// String property (with optional enum constraint) + String(StringSchema), + /// Number property (with optional enum constraint) + Number(NumberSchema), + /// Integer property (with optional enum constraint) + Integer(IntegerSchema), + /// Boolean property + Boolean(BooleanSchema), +} + +// ============================================================================= +// STRING SCHEMA +// ============================================================================= + +/// String format types allowed by the MCP specification. +#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[serde(rename_all = "kebab-case")] +#[non_exhaustive] +pub enum StringFormat { + /// Email address format + Email, + /// URI format + Uri, + /// Date format (YYYY-MM-DD) + Date, + /// Date-time format (ISO 8601) + DateTime, +} + +/// Schema definition for string properties. +/// +/// Compliant with MCP 2025-06-18 specification for elicitation schemas. +/// Supports only the fields allowed by the MCP spec: +/// - format limited to: "email", "uri", "date", "date-time" +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[serde(rename_all = "camelCase")] +#[non_exhaustive] +pub struct StringSchema { + /// Type discriminator + #[serde(rename = "type")] + pub type_: StringTypeConst, + + /// Optional title for the schema + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option>, + + /// Human-readable description + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option>, + + /// Minimum string length + #[serde(skip_serializing_if = "Option::is_none")] + pub min_length: Option, + + /// Maximum string length + #[serde(skip_serializing_if = "Option::is_none")] + pub max_length: Option, + + /// String format - limited to: "email", "uri", "date", "date-time" + #[serde(skip_serializing_if = "Option::is_none")] + pub format: Option, + + /// Default value + #[serde(skip_serializing_if = "Option::is_none")] + pub default: Option, +} + +impl Default for StringSchema { + fn default() -> Self { + Self { + type_: StringTypeConst, + title: None, + description: None, + min_length: None, + max_length: None, + format: None, + default: None, + } + } +} + +impl StringSchema { + /// Create a new string schema + pub fn new() -> Self { + Self::default() + } + + /// Create an email string schema + pub fn email() -> Self { + Self { + format: Some(StringFormat::Email), + ..Default::default() + } + } + + /// Create a URI string schema + pub fn uri() -> Self { + Self { + format: Some(StringFormat::Uri), + ..Default::default() + } + } + + /// Create a date string schema + pub fn date() -> Self { + Self { + format: Some(StringFormat::Date), + ..Default::default() + } + } + + /// Create a date-time string schema + pub fn date_time() -> Self { + Self { + format: Some(StringFormat::DateTime), + ..Default::default() + } + } + + /// Set title + pub fn title(mut self, title: impl Into>) -> Self { + self.title = Some(title.into()); + self + } + + /// Set description + pub fn description(mut self, description: impl Into>) -> Self { + self.description = Some(description.into()); + self + } + + /// Set minimum and maximum length + pub fn with_length(mut self, min: u32, max: u32) -> Result { + if min > max { + return Err("min_length must be <= max_length"); + } + self.min_length = Some(min); + self.max_length = Some(max); + Ok(self) + } + + /// Set minimum and maximum length (panics on invalid input) + pub fn length(mut self, min: u32, max: u32) -> Self { + assert!(min <= max, "min_length must be <= max_length"); + self.min_length = Some(min); + self.max_length = Some(max); + self + } + + /// Set minimum length + pub fn min_length(mut self, min: u32) -> Self { + self.min_length = Some(min); + self + } + + /// Set maximum length + pub fn max_length(mut self, max: u32) -> Self { + self.max_length = Some(max); + self + } + + /// Set format (limited to: "email", "uri", "date", "date-time") + pub fn format(mut self, format: StringFormat) -> Self { + self.format = Some(format); + self + } + + /// Set default value + pub fn with_default(mut self, default: impl Into) -> Self { + self.default = Some(default.into()); + self + } +} + +// ============================================================================= +// NUMBER SCHEMA +// ============================================================================= + +/// Schema definition for number properties (floating-point). +/// +/// Compliant with MCP 2025-06-18 specification for elicitation schemas. +/// Supports only the fields allowed by the MCP spec. +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[serde(rename_all = "camelCase")] +#[non_exhaustive] +pub struct NumberSchema { + /// Type discriminator + #[serde(rename = "type")] + pub type_: NumberTypeConst, + + /// Optional title for the schema + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option>, + + /// Human-readable description + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option>, + + /// Minimum value (inclusive) + #[serde( + default, + deserialize_with = "super::serde_impl::json_float::option_f64", + skip_serializing_if = "Option::is_none" + )] + pub minimum: Option, + + /// Maximum value (inclusive) + #[serde( + default, + deserialize_with = "super::serde_impl::json_float::option_f64", + skip_serializing_if = "Option::is_none" + )] + pub maximum: Option, + + /// Default value + #[serde( + default, + deserialize_with = "super::serde_impl::json_float::option_f64", + skip_serializing_if = "Option::is_none" + )] + pub default: Option, +} + +impl Default for NumberSchema { + fn default() -> Self { + Self { + type_: NumberTypeConst, + title: None, + description: None, + minimum: None, + maximum: None, + default: None, + } + } +} + +impl NumberSchema { + /// Create a new number schema + pub fn new() -> Self { + Self::default() + } + + /// Set minimum and maximum (inclusive) + pub fn with_range(mut self, min: f64, max: f64) -> Result { + if min > max { + return Err("minimum must be <= maximum"); + } + self.minimum = Some(min); + self.maximum = Some(max); + Ok(self) + } + + /// Set minimum and maximum (panics on invalid input) + pub fn range(mut self, min: f64, max: f64) -> Self { + assert!(min <= max, "minimum must be <= maximum"); + self.minimum = Some(min); + self.maximum = Some(max); + self + } + + /// Set minimum (inclusive) + pub fn minimum(mut self, min: f64) -> Self { + self.minimum = Some(min); + self + } + + /// Set maximum (inclusive) + pub fn maximum(mut self, max: f64) -> Self { + self.maximum = Some(max); + self + } + + /// Set title + pub fn title(mut self, title: impl Into>) -> Self { + self.title = Some(title.into()); + self + } + + /// Set description + pub fn description(mut self, description: impl Into>) -> Self { + self.description = Some(description.into()); + self + } + + /// Set default value + pub fn with_default(mut self, default: f64) -> Self { + self.default = Some(default); + self + } +} + +// ============================================================================= +// INTEGER SCHEMA +// ============================================================================= + +/// Schema definition for integer properties. +/// +/// Compliant with MCP 2025-06-18 specification for elicitation schemas. +/// Supports only the fields allowed by the MCP spec. +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[serde(rename_all = "camelCase")] +#[non_exhaustive] +pub struct IntegerSchema { + /// Type discriminator + #[serde(rename = "type")] + pub type_: IntegerTypeConst, + + /// Optional title for the schema + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option>, + + /// Human-readable description + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option>, + + /// Minimum value (inclusive) + #[serde(skip_serializing_if = "Option::is_none")] + pub minimum: Option, + + /// Maximum value (inclusive) + #[serde(skip_serializing_if = "Option::is_none")] + pub maximum: Option, + + /// Default value + #[serde(skip_serializing_if = "Option::is_none")] + pub default: Option, +} + +impl Default for IntegerSchema { + fn default() -> Self { + Self { + type_: IntegerTypeConst, + title: None, + description: None, + minimum: None, + maximum: None, + default: None, + } + } +} + +impl IntegerSchema { + /// Create a new integer schema + pub fn new() -> Self { + Self::default() + } + + /// Set minimum and maximum (inclusive) + pub fn with_range(mut self, min: i64, max: i64) -> Result { + if min > max { + return Err("minimum must be <= maximum"); + } + self.minimum = Some(min); + self.maximum = Some(max); + Ok(self) + } + + /// Set minimum and maximum (panics on invalid input) + pub fn range(mut self, min: i64, max: i64) -> Self { + assert!(min <= max, "minimum must be <= maximum"); + self.minimum = Some(min); + self.maximum = Some(max); + self + } + + /// Set minimum (inclusive) + pub fn minimum(mut self, min: i64) -> Self { + self.minimum = Some(min); + self + } + + /// Set maximum (inclusive) + pub fn maximum(mut self, max: i64) -> Self { + self.maximum = Some(max); + self + } + + /// Set title + pub fn title(mut self, title: impl Into>) -> Self { + self.title = Some(title.into()); + self + } + + /// Set description + pub fn description(mut self, description: impl Into>) -> Self { + self.description = Some(description.into()); + self + } + + /// Set default value + pub fn with_default(mut self, default: i64) -> Self { + self.default = Some(default); + self + } +} + +// ============================================================================= +// BOOLEAN SCHEMA +// ============================================================================= + +/// Schema definition for boolean properties. +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[serde(rename_all = "camelCase")] +#[non_exhaustive] +pub struct BooleanSchema { + /// Type discriminator + #[serde(rename = "type")] + pub type_: BooleanTypeConst, + + /// Optional title for the schema + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option>, + + /// Human-readable description + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option>, + + /// Default value + #[serde(skip_serializing_if = "Option::is_none")] + pub default: Option, +} + +impl Default for BooleanSchema { + fn default() -> Self { + Self { + type_: BooleanTypeConst, + title: None, + description: None, + default: None, + } + } +} + +impl BooleanSchema { + /// Create a new boolean schema + pub fn new() -> Self { + Self::default() + } + + /// Set title + pub fn title(mut self, title: impl Into>) -> Self { + self.title = Some(title.into()); + self + } + + /// Set description + pub fn description(mut self, description: impl Into>) -> Self { + self.description = Some(description.into()); + self + } + + /// Set default value + pub fn with_default(mut self, default: bool) -> Self { + self.default = Some(default); + self + } +} + +// ============================================================================= +// ENUM SCHEMA +// ============================================================================= + +/// Schema definition for enum properties. +/// +/// Represent single entry for titled item +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct ConstTitle { + #[serde(rename = "const")] + pub const_: String, + pub title: String, +} + +impl ConstTitle { + /// Create a new ConstTitle. + pub fn new(const_: impl Into, title: impl Into) -> Self { + Self { + const_: const_.into(), + title: title.into(), + } + } +} + +/// Legacy enum schema, keep for backward compatibility +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct LegacyEnumSchema { + #[serde(rename = "type")] + pub type_: StringTypeConst, + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option>, + #[serde(rename = "enum")] + pub enum_: Vec, + #[serde(skip_serializing_if = "Option::is_none")] + pub enum_names: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub default: Option, +} + +impl LegacyEnumSchema { + pub fn new(enum_values: Vec) -> Self { + Self { + type_: StringTypeConst, + title: None, + description: None, + enum_: enum_values, + enum_names: None, + default: None, + } + } +} + +/// Untitled single-select +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase", deny_unknown_fields)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct UntitledSingleSelectEnumSchema { + #[serde(rename = "type")] + pub type_: StringTypeConst, + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option>, + #[serde(rename = "enum")] + pub enum_: Vec, + #[serde(skip_serializing_if = "Option::is_none")] + pub default: Option, +} + +/// Titled single-select +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct TitledSingleSelectEnumSchema { + #[serde(rename = "type")] + pub type_: StringTypeConst, + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option>, + #[serde(rename = "oneOf")] + pub one_of: Vec, + #[serde(skip_serializing_if = "Option::is_none")] + pub default: Option, +} + +impl TitledSingleSelectEnumSchema { + /// Create a new TitledSingleSelectEnumSchema. + pub fn new(one_of: Vec) -> Self { + Self { + type_: StringTypeConst, + title: None, + description: None, + one_of, + default: None, + } + } +} + +/// Combined single-select +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[serde(untagged)] +#[non_exhaustive] +pub enum SingleSelectEnumSchema { + Untitled(UntitledSingleSelectEnumSchema), + Titled(TitledSingleSelectEnumSchema), +} + +/// Items for untitled multi-select options +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct UntitledItems { + #[serde(rename = "type")] + pub type_: StringTypeConst, + #[serde(rename = "enum")] + pub enum_: Vec, +} + +impl UntitledItems { + pub fn new(enum_values: Vec) -> Self { + Self { + type_: StringTypeConst, + enum_: enum_values, + } + } +} + +/// Items for titled multi-select options +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct TitledItems { + // MCP spec requires "anyOf" for multi-select enums (allows any combination) + // Alias "oneOf" for compatibility with schemars + #[serde(rename = "anyOf", alias = "oneOf")] + pub any_of: Vec, +} + +impl TitledItems { + /// Create a new TitledItems. + pub fn new(any_of: Vec) -> Self { + Self { any_of } + } +} + +/// Multi-select untitled options +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[serde(rename_all = "camelCase")] +#[non_exhaustive] +pub struct UntitledMultiSelectEnumSchema { + #[serde(rename = "type")] + pub type_: ArrayTypeConst, + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub min_items: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub max_items: Option, + pub items: UntitledItems, + #[serde(skip_serializing_if = "Option::is_none")] + pub default: Option>, +} + +/// Multi-select titled options +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[serde(rename_all = "camelCase")] +#[non_exhaustive] +pub struct TitledMultiSelectEnumSchema { + #[serde(rename = "type")] + pub type_: ArrayTypeConst, + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub min_items: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub max_items: Option, + pub items: TitledItems, + #[serde(skip_serializing_if = "Option::is_none")] + pub default: Option>, +} + +impl TitledMultiSelectEnumSchema { + /// Create a new TitledMultiSelectEnumSchema. + pub fn new(items: TitledItems) -> Self { + Self { + type_: ArrayTypeConst, + title: None, + description: None, + min_items: None, + max_items: None, + items, + default: None, + } + } + + /// Set the title. + pub fn with_title(mut self, title: impl Into>) -> Self { + self.title = Some(title.into()); + self + } + + /// Set the description. + pub fn with_description(mut self, description: impl Into>) -> Self { + self.description = Some(description.into()); + self + } + + /// Set the minimum number of items. + pub fn with_min_items(mut self, min_items: u64) -> Self { + self.min_items = Some(min_items); + self + } + + /// Set the maximum number of items. + pub fn with_max_items(mut self, max_items: u64) -> Self { + self.max_items = Some(max_items); + self + } + + /// Set the default values. + pub fn with_default(mut self, default: Vec) -> Self { + self.default = Some(default); + self + } +} + +/// Multi-select enum options +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[serde(untagged)] +#[non_exhaustive] +pub enum MultiSelectEnumSchema { + Untitled(UntitledMultiSelectEnumSchema), + Titled(TitledMultiSelectEnumSchema), +} + +/// Compliant with MCP 2025-06-18 specification for elicitation schemas. +/// Enums must have string type for values and can optionally include human-readable names. +/// +/// # Example +/// +/// ```rust +/// use rmcp::model::*; +/// +/// let enum_schema = EnumSchema::builder(vec!["US".to_string(), "UK".to_string()]) +/// .multiselect() +/// .min_items(1u64).expect("Min items should be correct value") +/// .max_items(4u64).expect("Max items should be correct value") +/// .description("Country code") +/// .build(); +/// ``` +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[serde(untagged)] +#[non_exhaustive] +pub enum EnumSchema { + Single(SingleSelectEnumSchema), + Multi(MultiSelectEnumSchema), + Legacy(LegacyEnumSchema), +} + +/// Marker type for single-select enum builder +#[derive(Debug)] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct SingleSelect; +/// Marker type for multi-select enum builder +#[derive(Debug)] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct MultiSelect; +/// Builder for EnumSchema +/// Allows to create various enum schema types (single/multi select, titled/untitled) +/// with validation of provided parameters +/// +/// # Example +/// ```rust +/// use rmcp::model::*; +/// let enum_schema = EnumSchema::builder(vec!["Red".to_string(), "Green".to_string(), "Blue".to_string()]) +/// .multiselect() +/// .enum_titles(vec!["Red Color".to_string(), "Green Color".to_string(), "Blue Color".to_string()]) +/// .expect("Number of titles should match number of values") +/// .min_items(1u64).expect("Min items should be correct value") +/// .max_items(3u64).expect("Max items should be correct value") +/// .description("Select your favorite colors") +/// .build(); +/// ``` +#[derive(Debug)] +pub struct EnumSchemaBuilder { + /// Enum values + enum_values: Vec, + /// If true generate Titled EnumSchema, UnTitled otherwise + titled: bool, + /// Title of EnumSchema + title: Option>, + /// Description of EnumSchema + description: Option>, + /// Titles of given enum values + enum_titles: Vec, + /// Minimum number of items to choose for MultiSelect + min_items: Option, + /// Maximum number of items to choose for MultiSelect + max_items: Option, + /// Default values for enum + default: Vec, + select_type: PhantomData, +} + +/// Default implementation for single-select enum builder +impl Default for EnumSchemaBuilder { + fn default() -> Self { + Self { + title: None, + description: None, + titled: false, + enum_titles: Vec::new(), + enum_values: Vec::new(), + min_items: None, + max_items: None, + default: Vec::new(), + select_type: PhantomData, + } + } +} + +/// Common enum schema builder methods +impl EnumSchemaBuilder { + /// Set title of enum schema + pub fn title(mut self, value: impl Into>) -> Self { + self.title = Some(value.into()); + self + } + + /// Set description of enum schema + pub fn description(mut self, value: impl Into>) -> Self { + self.description = Some(value.into()); + self + } + + /// Set enum as untitled + /// Clears any previously set titles + pub fn untitled(mut self) -> Self { + self.enum_titles = Vec::new(); + self.titled = false; + self + } + + /// Set titles to enum values. Also, implicitly set this enum schema as titled + pub fn enum_titles(mut self, titles: Vec) -> Result, String> { + if titles.len() != self.enum_values.len() { + return Err(format!( + "Provided number of titles do not match number of values: expected {}, but got {}", + self.enum_values.len(), + titles.len() + )); + } + self.titled = true; + self.enum_titles = titles; + Ok(self) + } +} + +/// Enum selection builder for single-select enums +impl EnumSchemaBuilder { + pub fn new(values: Vec) -> EnumSchemaBuilder { + EnumSchemaBuilder { + enum_values: values, + ..Default::default() + } + } + + /// Transition to multi-select enum builder. + /// + /// Clears any previously set default values and resets min/max items. + /// After this transition, you can use `min_items()`, `max_items()`, and + /// `with_default()` for multi-select semantics. + pub fn multiselect(self) -> EnumSchemaBuilder { + EnumSchemaBuilder { + enum_values: self.enum_values, + titled: self.titled, + title: self.title, + description: self.description, + enum_titles: self.enum_titles, + min_items: None, + max_items: None, + default: Vec::new(), // Clear default for multi-select + select_type: PhantomData, + } + } + + /// Set default value + pub fn with_default( + mut self, + default_value: impl Into, + ) -> Result, String> { + let value: String = default_value.into(); + if !self.enum_values.contains(&value) { + return Err("Provided default value is not in enum values".to_string()); + } + self.default = vec![value]; + Ok(self) + } + + /// Build enum schema + pub fn build(mut self) -> EnumSchema { + match self.titled { + false => EnumSchema::Single(SingleSelectEnumSchema::Untitled( + UntitledSingleSelectEnumSchema { + type_: StringTypeConst, + title: self.title, + description: self.description, + enum_: self.enum_values, + default: self.default.pop(), + }, + )), + true => EnumSchema::Single(SingleSelectEnumSchema::Titled( + TitledSingleSelectEnumSchema { + type_: StringTypeConst, + title: self.title, + description: self.description, + one_of: self + .enum_titles + .into_iter() + .zip(self.enum_values) + .map(|(title, const_)| ConstTitle { const_, title }) + .collect(), + default: self.default.pop(), + }, + )), + } + } +} + +/// Enum selection builder for multi-select enums +impl EnumSchemaBuilder { + /// Set enum as single-select + /// If it was multi-select, clear default values + pub fn single_select(self) -> EnumSchemaBuilder { + EnumSchemaBuilder { + enum_values: self.enum_values, + titled: self.titled, + title: self.title, + description: self.description, + enum_titles: self.enum_titles, + min_items: None, + max_items: None, + default: Vec::new(), // Clear default for single-select + select_type: PhantomData, + } + } + + /// Set default values + pub fn with_default( + mut self, + default_values: Vec, + ) -> Result, String> { + for value in &default_values { + if !self.enum_values.contains(value) { + return Err("One of the provided default values is not in enum values".to_string()); + } + } + if let Some(min) = self.min_items + && (default_values.len() as u64) < min + { + return Err("Number of provided default values is less than min_items".to_string()); + } + if let Some(max) = self.max_items + && (default_values.len() as u64) > max + { + return Err("Number of provided default values is greater than max_items".to_string()); + } + self.default = default_values; + Ok(self) + } + + /// Set minimal number of items for multi-select enum options + pub fn min_items(mut self, value: u64) -> Result, String> { + if let Some(max) = self.max_items + && value > max + { + return Err("Provided value is greater than max_items".to_string()); + } + self.min_items = Some(value); + Ok(self) + } + + /// Set maximal number of items for multi-select enum options + pub fn max_items(mut self, value: u64) -> Result, String> { + if let Some(min) = self.min_items + && value < min + { + return Err("Provided value is less than min_items".to_string()); + } + self.max_items = Some(value); + Ok(self) + } + + /// Build enum schema + pub fn build(self) -> EnumSchema { + match self.titled { + false => EnumSchema::Multi(MultiSelectEnumSchema::Untitled( + UntitledMultiSelectEnumSchema { + type_: ArrayTypeConst, + title: self.title, + description: self.description, + min_items: self.min_items, + max_items: self.max_items, + items: UntitledItems { + type_: StringTypeConst, + enum_: self.enum_values, + }, + default: if self.default.is_empty() { + None + } else { + Some(self.default) + }, + }, + )), + true => EnumSchema::Multi(MultiSelectEnumSchema::Titled(TitledMultiSelectEnumSchema { + type_: ArrayTypeConst, + title: self.title, + description: self.description, + min_items: self.min_items, + max_items: self.max_items, + items: TitledItems { + any_of: self + .enum_titles + .into_iter() + .zip(self.enum_values) + .map(|(title, const_)| ConstTitle { const_, title }) + .collect(), + }, + default: if self.default.is_empty() { + None + } else { + Some(self.default) + }, + })), + } + } +} + +impl EnumSchema { + /// Creates a new `EnumSchemaBuilder` with the given enum values. + /// + /// This convenience method allows you to construct an enum schema by specifying + /// the possible string values for the enum. Use the returned builder to further + /// configure the schema before building it. + /// + /// # Arguments + /// + /// * `values` - A vector of strings representing the allowed enum values. + /// + /// # Example + /// + /// ``` + /// use rmcp::model::*; + /// + /// let enum_schema = EnumSchema::builder(vec!["A".to_string(), "B".to_string()]). + /// with_default("A"). + /// expect("Default value should be valid"). + /// enum_titles(vec!["Option A".to_string(), "Option B".to_string()]). + /// expect("Number of titles should match number of values"). + /// build(); + /// ``` + pub fn builder(values: Vec) -> EnumSchemaBuilder { + EnumSchemaBuilder::new(values) + } +} + +// ============================================================================= +// ELICITATION SCHEMA +// ============================================================================= + +/// Type-safe elicitation schema for requesting structured user input. +/// +/// This enforces the MCP 2025-06-18 specification that elicitation schemas +/// must be objects with primitive-typed properties. +/// +/// # Example +/// +/// ```rust +/// use rmcp::model::*; +/// +/// let schema = ElicitationSchema::builder() +/// .required_email("email") +/// .required_integer("age", 0, 150) +/// .optional_bool("newsletter", false) +/// .build(); +/// ``` +#[derive(Debug, Clone, PartialEq, Serialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[cfg_attr(feature = "schemars", schemars(!into))] +#[serde(rename_all = "camelCase", into = "ElicitationSchemaWire")] +#[non_exhaustive] +pub struct ElicitationSchema { + /// Optional JSON Schema dialect identifier (the `$schema` keyword). + /// + /// The 2025-11-25 protocol revision allows a `requestedSchema` to declare its + /// dialect. It is preserved verbatim so a declared dialect survives a + /// decode/re-encode round-trip instead of being silently dropped. + #[serde(rename = "$schema", default, skip_serializing_if = "Option::is_none")] + #[cfg_attr(feature = "schemars", schemars(with = "String"))] + pub schema: Option>, + + /// Always "object" for elicitation schemas + #[serde(rename = "type")] + pub type_: ObjectTypeConst, + + /// Optional title for the schema + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option>, + + /// Property definitions (must be primitive types) + pub properties: BTreeMap, + + /// Property names in wire order. Schemas constructed from a `BTreeMap` + /// use the map's sorted key order. + #[serde(skip)] + pub property_order: Option>, + + /// List of required property names + #[serde(skip_serializing_if = "Option::is_none")] + pub required: Option>, + + /// Optional description of what this schema represents + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option>, +} + +#[derive(Deserialize, Serialize)] +#[serde(rename_all = "camelCase")] +struct ElicitationSchemaWire { + #[serde(rename = "$schema", default, skip_serializing_if = "Option::is_none")] + schema: Option>, + #[serde(rename = "type")] + type_: ObjectTypeConst, + #[serde(skip_serializing_if = "Option::is_none")] + title: Option>, + properties: IndexMap, + #[serde(skip_serializing_if = "Option::is_none")] + required: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + description: Option>, +} + +impl From for ElicitationSchema { + fn from(schema: ElicitationSchemaWire) -> Self { + Self { + schema: schema.schema, + type_: schema.type_, + title: schema.title, + property_order: Some(schema.properties.keys().cloned().collect()), + properties: schema.properties.into_iter().collect(), + required: schema.required, + description: schema.description, + } + } +} + +impl From for ElicitationSchemaWire { + fn from(schema: ElicitationSchema) -> Self { + let mut remaining = schema.properties; + let mut properties = IndexMap::with_capacity(remaining.len()); + + if let Some(property_order) = schema.property_order { + for name in property_order { + if let Some(definition) = remaining.remove(&name) { + properties.insert(name, definition); + } + } + } + properties.extend(remaining); + + Self { + schema: schema.schema, + type_: schema.type_, + title: schema.title, + properties, + required: schema.required, + description: schema.description, + } + } +} + +impl<'de> Deserialize<'de> for ElicitationSchema { + fn deserialize<__D>(__deserializer: __D) -> Result + where + __D: Deserializer<'de>, + { + ElicitationSchemaWire::deserialize(__deserializer).map(Into::into) + } +} + +impl ElicitationSchema { + /// Create a new elicitation schema with the given properties + pub fn new(properties: BTreeMap) -> Self { + let property_order = Some(properties.keys().cloned().collect()); + Self { + schema: None, + type_: ObjectTypeConst, + title: None, + properties, + property_order, + required: None, + description: None, + } + } + + /// Convert from a JSON Schema object (typically generated by schemars) + /// + /// This allows converting from JsonObject to ElicitationSchema, which is useful + /// when working with automatically generated schemas from types. + /// + /// # Example + /// + /// ```rust,ignore + /// use rmcp::model::*; + /// + /// let json_schema = schema_for_type::(); + /// let elicitation_schema = ElicitationSchema::from_json_schema(json_schema)?; + /// ``` + /// + /// # Errors + /// + /// Returns a [`serde_json::Error`] if the JSON object cannot be deserialized + /// into a valid ElicitationSchema. + pub fn from_json_schema(schema: crate::model::JsonObject) -> Result { + serde_json::from_value(serde_json::Value::Object(schema)) + } + + /// Generate an ElicitationSchema from a Rust type that implements JsonSchema + /// + /// This is a convenience method that combines schema generation and conversion. + /// It uses the same schema generation settings as the rest of the MCP SDK. + /// + /// # Example + /// + /// ```rust,ignore + /// use rmcp::model::*; + /// use schemars::JsonSchema; + /// use serde::{Deserialize, Serialize}; + /// + /// #[derive(JsonSchema, Serialize, Deserialize)] + /// struct UserInput { + /// name: String, + /// age: u32, + /// } + /// + /// let schema = ElicitationSchema::from_type::()?; + /// ``` + /// + /// # Errors + /// + /// Returns a [`serde_json::Error`] if the generated schema cannot be converted + /// to a valid ElicitationSchema. + #[cfg(feature = "schemars")] + pub fn from_type() -> Result + where + T: schemars::JsonSchema, + { + use crate::schemars::generate::SchemaSettings; + + let mut settings = SchemaSettings::draft07(); + settings.transforms = vec![Box::new(schemars::transform::AddNullable::default())]; + let generator = settings.into_generator(); + let schema = generator.into_root_schema_for::(); + let object = serde_json::to_value(schema).expect("failed to serialize schema"); + match object { + serde_json::Value::Object(object) => Self::from_json_schema(object), + _ => panic!( + "Schema serialization produced non-object value: expected JSON object but got {:?}", + object + ), + } + } + + /// Set the required fields + pub fn with_required(mut self, required: Vec) -> Self { + self.required = Some(required); + self + } + + /// Set the title + pub fn with_title(mut self, title: impl Into>) -> Self { + self.title = Some(title.into()); + self + } + + /// Set the description + pub fn with_description(mut self, description: impl Into>) -> Self { + self.description = Some(description.into()); + self + } + + /// Set the JSON Schema dialect identifier (the `$schema` keyword). + pub fn with_schema(mut self, schema: impl Into>) -> Self { + self.schema = Some(schema.into()); + self + } + + /// Create a builder for constructing elicitation schemas fluently + pub fn builder() -> ElicitationSchemaBuilder { + ElicitationSchemaBuilder::new() + } +} + +// ============================================================================= +// BUILDER +// ============================================================================= + +/// Fluent builder for constructing elicitation schemas. +/// +/// # Example +/// +/// ```rust +/// use rmcp::model::*; +/// +/// let schema = ElicitationSchema::builder() +/// .required_email("email") +/// .required_integer("age", 0, 150) +/// .optional_bool("newsletter", false) +/// .description("User registration") +/// .build(); +/// ``` +#[derive(Debug, Default)] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct ElicitationSchemaBuilder { + pub properties: BTreeMap, + pub required: Vec, + pub title: Option>, + pub description: Option>, +} + +impl ElicitationSchemaBuilder { + /// Create a new builder + pub fn new() -> Self { + Self::default() + } + + /// Add a property to the schema + pub fn property(mut self, name: impl Into, schema: PrimitiveSchemaDefinition) -> Self { + self.properties.insert(name.into(), schema); + self + } + + /// Add a required property to the schema + pub fn required_property( + mut self, + name: impl Into, + schema: PrimitiveSchemaDefinition, + ) -> Self { + let name_str = name.into(); + self.required.push(name_str.clone()); + self.properties.insert(name_str, schema); + self + } + + // =========================================================================== + // TYPED PROPERTY METHODS - Cleaner API without PrimitiveSchemaDefinition wrapper + // =========================================================================== + + /// Add a string property with custom builder (required) + pub fn string_property( + mut self, + name: impl Into, + f: impl FnOnce(StringSchema) -> StringSchema, + ) -> Self { + self.properties.insert( + name.into(), + PrimitiveSchemaDefinition::String(f(StringSchema::new())), + ); + self + } + + /// Add a required string property with custom builder + pub fn required_string_property( + mut self, + name: impl Into, + f: impl FnOnce(StringSchema) -> StringSchema, + ) -> Self { + let name_str = name.into(); + self.required.push(name_str.clone()); + self.properties.insert( + name_str, + PrimitiveSchemaDefinition::String(f(StringSchema::new())), + ); + self + } + + /// Add a number property with custom builder + pub fn number_property( + mut self, + name: impl Into, + f: impl FnOnce(NumberSchema) -> NumberSchema, + ) -> Self { + self.properties.insert( + name.into(), + PrimitiveSchemaDefinition::Number(f(NumberSchema::new())), + ); + self + } + + /// Add a required number property with custom builder + pub fn required_number_property( + mut self, + name: impl Into, + f: impl FnOnce(NumberSchema) -> NumberSchema, + ) -> Self { + let name_str = name.into(); + self.required.push(name_str.clone()); + self.properties.insert( + name_str, + PrimitiveSchemaDefinition::Number(f(NumberSchema::new())), + ); + self + } + + /// Add an integer property with custom builder + pub fn integer_property( + mut self, + name: impl Into, + f: impl FnOnce(IntegerSchema) -> IntegerSchema, + ) -> Self { + self.properties.insert( + name.into(), + PrimitiveSchemaDefinition::Integer(f(IntegerSchema::new())), + ); + self + } + + /// Add a required integer property with custom builder + pub fn required_integer_property( + mut self, + name: impl Into, + f: impl FnOnce(IntegerSchema) -> IntegerSchema, + ) -> Self { + let name_str = name.into(); + self.required.push(name_str.clone()); + self.properties.insert( + name_str, + PrimitiveSchemaDefinition::Integer(f(IntegerSchema::new())), + ); + self + } + + /// Add a boolean property with custom builder + pub fn bool_property( + mut self, + name: impl Into, + f: impl FnOnce(BooleanSchema) -> BooleanSchema, + ) -> Self { + self.properties.insert( + name.into(), + PrimitiveSchemaDefinition::Boolean(f(BooleanSchema::new())), + ); + self + } + + /// Add a required boolean property with custom builder + pub fn required_bool_property( + mut self, + name: impl Into, + f: impl FnOnce(BooleanSchema) -> BooleanSchema, + ) -> Self { + let name_str = name.into(); + self.required.push(name_str.clone()); + self.properties.insert( + name_str, + PrimitiveSchemaDefinition::Boolean(f(BooleanSchema::new())), + ); + self + } + + // =========================================================================== + // CONVENIENCE METHODS - Simple common cases + // =========================================================================== + + /// Add a required string property + pub fn required_string(self, name: impl Into) -> Self { + self.required_property(name, PrimitiveSchemaDefinition::String(StringSchema::new())) + } + + /// Add an optional string property + pub fn optional_string(self, name: impl Into) -> Self { + self.property(name, PrimitiveSchemaDefinition::String(StringSchema::new())) + } + + /// Add a required email property + pub fn required_email(self, name: impl Into) -> Self { + self.required_property( + name, + PrimitiveSchemaDefinition::String(StringSchema::email()), + ) + } + + /// Add an optional email property + pub fn optional_email(self, name: impl Into) -> Self { + self.property( + name, + PrimitiveSchemaDefinition::String(StringSchema::email()), + ) + } + + /// Add a required string property with custom builder + pub fn required_string_with( + self, + name: impl Into, + f: impl FnOnce(StringSchema) -> StringSchema, + ) -> Self { + self.required_property( + name, + PrimitiveSchemaDefinition::String(f(StringSchema::new())), + ) + } + + /// Add an optional string property with custom builder + pub fn optional_string_with( + self, + name: impl Into, + f: impl FnOnce(StringSchema) -> StringSchema, + ) -> Self { + self.property( + name, + PrimitiveSchemaDefinition::String(f(StringSchema::new())), + ) + } + + // Convenience methods for numbers + + /// Add a required number property with range + pub fn required_number(self, name: impl Into, min: f64, max: f64) -> Self { + self.required_property( + name, + PrimitiveSchemaDefinition::Number(NumberSchema::new().range(min, max)), + ) + } + + /// Add an optional number property with range + pub fn optional_number(self, name: impl Into, min: f64, max: f64) -> Self { + self.property( + name, + PrimitiveSchemaDefinition::Number(NumberSchema::new().range(min, max)), + ) + } + + /// Add a required number property with custom builder + pub fn required_number_with( + self, + name: impl Into, + f: impl FnOnce(NumberSchema) -> NumberSchema, + ) -> Self { + self.required_property( + name, + PrimitiveSchemaDefinition::Number(f(NumberSchema::new())), + ) + } + + /// Add an optional number property with custom builder + pub fn optional_number_with( + self, + name: impl Into, + f: impl FnOnce(NumberSchema) -> NumberSchema, + ) -> Self { + self.property( + name, + PrimitiveSchemaDefinition::Number(f(NumberSchema::new())), + ) + } + + // Convenience methods for integers + + /// Add a required integer property with range + pub fn required_integer(self, name: impl Into, min: i64, max: i64) -> Self { + self.required_property( + name, + PrimitiveSchemaDefinition::Integer(IntegerSchema::new().range(min, max)), + ) + } + + /// Add an optional integer property with range + pub fn optional_integer(self, name: impl Into, min: i64, max: i64) -> Self { + self.property( + name, + PrimitiveSchemaDefinition::Integer(IntegerSchema::new().range(min, max)), + ) + } + + /// Add a required integer property with custom builder + pub fn required_integer_with( + self, + name: impl Into, + f: impl FnOnce(IntegerSchema) -> IntegerSchema, + ) -> Self { + self.required_property( + name, + PrimitiveSchemaDefinition::Integer(f(IntegerSchema::new())), + ) + } + + /// Add an optional integer property with custom builder + pub fn optional_integer_with( + self, + name: impl Into, + f: impl FnOnce(IntegerSchema) -> IntegerSchema, + ) -> Self { + self.property( + name, + PrimitiveSchemaDefinition::Integer(f(IntegerSchema::new())), + ) + } + + // Convenience methods for booleans + + /// Add a required boolean property + pub fn required_bool(self, name: impl Into) -> Self { + self.required_property( + name, + PrimitiveSchemaDefinition::Boolean(BooleanSchema::new()), + ) + } + + /// Add an optional boolean property with default value + pub fn optional_bool(self, name: impl Into, default: bool) -> Self { + self.property( + name, + PrimitiveSchemaDefinition::Boolean(BooleanSchema::new().with_default(default)), + ) + } + + /// Add a required boolean property with custom builder + pub fn required_bool_with( + self, + name: impl Into, + f: impl FnOnce(BooleanSchema) -> BooleanSchema, + ) -> Self { + self.required_property( + name, + PrimitiveSchemaDefinition::Boolean(f(BooleanSchema::new())), + ) + } + + /// Add an optional boolean property with custom builder + pub fn optional_bool_with( + self, + name: impl Into, + f: impl FnOnce(BooleanSchema) -> BooleanSchema, + ) -> Self { + self.property( + name, + PrimitiveSchemaDefinition::Boolean(f(BooleanSchema::new())), + ) + } + + // Enum convenience methods + + /// Add a required enum property using EnumSchema + pub fn required_enum_schema(self, name: impl Into, enum_schema: EnumSchema) -> Self { + self.required_property(name, PrimitiveSchemaDefinition::Enum(enum_schema)) + } + + /// Add an optional enum property using EnumSchema + pub fn optional_enum_schema(self, name: impl Into, enum_schema: EnumSchema) -> Self { + self.property(name, PrimitiveSchemaDefinition::Enum(enum_schema)) + } + + /// Mark an existing property as required + pub fn mark_required(mut self, name: impl Into) -> Self { + self.required.push(name.into()); + self + } + + /// Set the schema title + pub fn title(mut self, title: impl Into>) -> Self { + self.title = Some(title.into()); + self + } + + /// Set the schema description + pub fn description(mut self, description: impl Into>) -> Self { + self.description = Some(description.into()); + self + } + + /// Build the elicitation schema with validation + /// + /// # Errors + /// + /// Returns an error if: + /// - Required fields reference non-existent properties + /// - No properties are defined (empty schema) + pub fn build(self) -> Result { + // Validate that all required fields exist in properties + if !self.required.is_empty() { + for field_name in &self.required { + if !self.properties.contains_key(field_name) { + return Err("Required field does not exist in properties"); + } + } + } + + let property_order = Some(self.properties.keys().cloned().collect()); + Ok(ElicitationSchema { + schema: None, + type_: ObjectTypeConst, + title: self.title, + properties: self.properties, + property_order, + required: if self.required.is_empty() { + None + } else { + Some(self.required) + }, + description: self.description, + }) + } + + /// Build the elicitation schema without validation (panics on invalid schema) + /// + /// # Panics + /// + /// Panics if required fields reference non-existent properties + pub fn build_unchecked(self) -> ElicitationSchema { + self.build().expect("Invalid elicitation schema") + } +} + +#[cfg(test)] +mod tests { + use anyhow::anyhow; + use rstest::rstest; + use serde_json::json; + + use super::*; + + fn string_schema_json() -> serde_json::Value { + serde_json::to_value(StringSchema::email().description("Email address")).unwrap() + } + + fn number_schema_json() -> serde_json::Value { + serde_json::to_value( + NumberSchema::new() + .range(0.0, 100.0) + .description("Percentage"), + ) + .unwrap() + } + + fn integer_schema_json() -> serde_json::Value { + serde_json::to_value(IntegerSchema::new().range(0, 150)).unwrap() + } + + fn boolean_schema_json() -> serde_json::Value { + serde_json::to_value(BooleanSchema::new().with_default(true)).unwrap() + } + + #[rstest] + #[case::string_schema( + string_schema_json, + json!({ + "type": "string", + "format": "email", + "description": "Email address", + }) + )] + #[case::number_schema( + number_schema_json, + json!({ + "type": "number", + "description": "Percentage", + "minimum": 0.0, + "maximum": 100.0, + }) + )] + #[case::integer_schema( + integer_schema_json, + json!({ + "type": "integer", + "minimum": 0, + "maximum": 150, + }) + )] + #[case::boolean_schema( + boolean_schema_json, + json!({ + "type": "boolean", + "default": true, + }) + )] + fn primitive_schema_serializes_to_expected_json( + #[case] schema_json: fn() -> serde_json::Value, + #[case] expected: serde_json::Value, + ) { + assert_eq!(schema_json(), expected); + } + + #[test] + fn test_enum_schema_untitled_single_select_serialization() { + let schema = EnumSchema::builder(vec!["US".to_string(), "UK".to_string()]) + .description("Country code") + .build(); + let json = serde_json::to_value(&schema).unwrap(); + + assert_eq!(json["type"], "string"); + assert_eq!(json["enum"], json!(["US", "UK"])); + assert_eq!(json["description"], "Country code"); + } + + #[test] + fn test_enum_schema_untitled_multi_select_serialization() -> anyhow::Result<()> { + let schema = EnumSchema::builder(vec!["US".to_string(), "UK".to_string()]) + .multiselect() + .min_items(1u64) + .map_err(|e| anyhow!("{e}"))? + .max_items(4u64) + .map_err(|e| anyhow!("{e}"))? + .description("Country code") + .build(); + let json = serde_json::to_value(&schema)?; + + assert_eq!(json["type"], "array"); + assert_eq!(json["minItems"], 1u64); + assert_eq!(json["maxItems"], 4u64); + assert_eq!(json["items"], json!({"type":"string", "enum":["US", "UK"]})); + assert_eq!(json["description"], "Country code"); + Ok(()) + } + + #[test] + fn test_enum_schema_titled_single_select_serialization() -> anyhow::Result<()> { + let schema = EnumSchema::builder(vec!["US".to_string(), "UK".to_string()]) + .enum_titles(vec![ + "United States".to_string(), + "United Kingdom".to_string(), + ]) + .map_err(|e| anyhow!("{e}"))? + .description("Country code") + .build(); + let json = serde_json::to_value(&schema)?; + + assert_eq!(json["type"], "string"); + assert_eq!( + json["oneOf"], + json!([ + {"const": "US", "title":"United States"}, + {"const": "UK", "title":"United Kingdom"} + ]) + ); + assert_eq!(json["description"], "Country code"); + Ok(()) + } + + #[test] + fn test_enum_schema_legacy_serialization() -> anyhow::Result<()> { + let schema = EnumSchema::Legacy(LegacyEnumSchema { + type_: StringTypeConst, + title: Some("Legacy Enum".into()), + description: Some("A legacy enum schema".into()), + enum_: vec!["A".to_string(), "B".to_string()], + enum_names: Some(vec!["Option A".to_string(), "Option B".to_string()]), + default: None, + }); + let json = serde_json::to_value(&schema)?; + + assert_eq!(json["type"], "string"); + assert_eq!(json["title"], "Legacy Enum"); + assert_eq!(json["description"], "A legacy enum schema"); + assert_eq!(json["enum"], json!(["A", "B"])); + assert_eq!(json["enumNames"], json!(["Option A", "Option B"])); + Ok(()) + } + + #[test] + fn test_legacy_enum_schema_roundtrip_preserves_enum_names() -> anyhow::Result<()> { + // Regression test for: legacy enum payload with `enumNames` was silently + // deserialized as `UntitledSingleSelectEnumSchema` (which has no `enumNames` + // field), causing the array to be dropped on re-serialization. + let input = serde_json::json!({ + "type": "object", + "properties": { + "choice": { + "type": "string", + "enum": ["opt1", "opt2", "opt3"], + "enumNames": ["Option One", "Option Two", "Option Three"] + } + } + }); + let schema: ElicitationSchema = serde_json::from_value(input.clone())?; + let output = serde_json::to_value(&schema)?; + assert_eq!( + output["properties"]["choice"]["enumNames"], + serde_json::json!(["Option One", "Option Two", "Option Three"]), + ); + let input = r#"{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"}}}"#; + let ordered: ElicitationSchema = serde_json::from_str(input)?; + assert_eq!( + ordered.property_order.as_ref().unwrap().join(","), + "firstName,lastName,email", + ); + assert_eq!(serde_json::to_string(&ordered)?, input); + Ok(()) + } + + #[test] + fn test_elicitation_schema_preserves_schema_dialect_roundtrip() -> anyhow::Result<()> { + // Regression test for #1168: a top-level `$schema` dialect declaration on a + // `requestedSchema` was silently dropped, because the wire bridge struct had + // no field to hold it. It must survive a decode/re-encode round-trip. + let input = serde_json::json!({ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "type": "object", + "properties": { + "name": { "type": "string" } + } + }); + let schema: ElicitationSchema = serde_json::from_value(input.clone())?; + assert_eq!( + schema.schema.as_deref(), + Some("https://json-schema.org/draft/2020-12/schema"), + ); + let output = serde_json::to_value(&schema)?; + assert_eq!(output, input); + Ok(()) + } + + #[test] + fn test_elicitation_schema_omits_schema_dialect_when_absent() -> anyhow::Result<()> { + // A schema with no dialect must not emit a `$schema` key (no `"$schema": null`). + let input = serde_json::json!({ + "type": "object", + "properties": { "name": { "type": "string" } } + }); + let schema: ElicitationSchema = serde_json::from_value(input)?; + assert!(schema.schema.is_none()); + let json = serde_json::to_value(&schema)?; + assert!(json.get("$schema").is_none()); + Ok(()) + } + + #[test] + fn test_elicitation_schema_with_schema_setter_serializes_dialect() -> anyhow::Result<()> { + let schema = ElicitationSchema::new(BTreeMap::new()) + .with_schema("https://json-schema.org/draft/2020-12/schema"); + let json = serde_json::to_value(&schema)?; + assert_eq!( + json["$schema"], + "https://json-schema.org/draft/2020-12/schema" + ); + Ok(()) + } + + #[test] + fn test_legacy_enum_schema_no_enum_names_omits_field() -> anyhow::Result<()> { + // `LegacyEnumSchema` with `enum_names: None` must not serialize `"enumNames": null`. + let schema = EnumSchema::Legacy(LegacyEnumSchema { + type_: StringTypeConst, + title: None, + description: None, + enum_: vec!["a".to_string(), "b".to_string()], + enum_names: None, + default: None, + }); + let json = serde_json::to_value(&schema)?; + assert!(!json.as_object().unwrap().contains_key("enumNames")); + Ok(()) + } + + #[test] + fn test_enum_schema_titled_multi_select_serialization() -> anyhow::Result<()> { + let schema = EnumSchema::builder(vec!["US".to_string(), "UK".to_string()]) + .enum_titles(vec![ + "United States".to_string(), + "United Kingdom".to_string(), + ]) + .map_err(|e| anyhow!("{e}"))? + .multiselect() + .min_items(1u64) + .map_err(|e| anyhow!("{e}"))? + .max_items(4u64) + .map_err(|e| anyhow!("{e}"))? + .description("Country code") + .build(); + let json = serde_json::to_value(&schema)?; + + assert_eq!(json["type"], "array"); + assert_eq!(json["minItems"], 1u64); + assert_eq!(json["maxItems"], 4u64); + assert_eq!( + json["items"], + json!({"anyOf":[ + {"const":"US","title":"United States"}, + {"const":"UK","title":"United Kingdom"} + ]}) + ); + assert_eq!(json["description"], "Country code"); + Ok(()) + } + + #[test] + fn test_enum_schema_single_select_with_default() -> anyhow::Result<()> { + let schema = EnumSchema::builder(vec![ + "red".to_string(), + "green".to_string(), + "blue".to_string(), + ]) + .with_default("green") + .map_err(|e| anyhow!("{e}"))? + .description("Favorite color") + .build(); + + let json = serde_json::to_value(&schema)?; + + assert_eq!(json["type"], "string"); + assert_eq!(json["enum"], json!(["red", "green", "blue"])); + assert_eq!(json["default"], "green"); + assert_eq!(json["description"], "Favorite color"); + Ok(()) + } + + #[test] + fn test_enum_schema_multi_select_with_default() -> anyhow::Result<()> { + let schema = EnumSchema::builder(vec![ + "red".to_string(), + "green".to_string(), + "blue".to_string(), + ]) + .multiselect() + .with_default(vec!["red".to_string(), "blue".to_string()]) + .map_err(|e| anyhow!("{e}"))? + .min_items(1) + .map_err(|e| anyhow!("{e}"))? + .max_items(3) + .map_err(|e| anyhow!("{e}"))? + .build(); + + let json = serde_json::to_value(&schema)?; + + assert_eq!(json["type"], "array"); + assert_eq!(json["items"]["enum"], json!(["red", "green", "blue"])); + assert_eq!(json["default"], json!(["red", "blue"])); + assert_eq!(json["minItems"], 1); + assert_eq!(json["maxItems"], 3); + Ok(()) + } + + #[test] + fn test_enum_schema_transition_clears_defaults() -> anyhow::Result<()> { + // Start with single-select with default + let builder = EnumSchema::builder(vec!["A".to_string(), "B".to_string()]) + .with_default("A") + .map_err(|e| anyhow!("{e}"))?; + + // Transition to multi-select should clear the default + let schema = builder.multiselect().build(); + let json = serde_json::to_value(&schema)?; + + assert_eq!(json["type"], "array"); + assert!(json["default"].is_null()); + Ok(()) + } + + #[test] + fn test_enum_schema_multi_to_single_transition() -> anyhow::Result<()> { + // Start with multi-select with defaults + let builder = EnumSchema::builder(vec!["A".to_string(), "B".to_string(), "C".to_string()]) + .multiselect() + .with_default(vec!["A".to_string(), "B".to_string()]) + .map_err(|e| anyhow!("{e}"))? + .min_items(1) + .map_err(|e| anyhow!("{e}"))?; + + // Transition back to single-select should clear defaults and min/max items + let schema = builder.single_select().build(); + let json = serde_json::to_value(&schema)?; + + assert_eq!(json["type"], "string"); + assert!(json["default"].is_null()); + assert!(json["minItems"].is_null()); + assert!(json["maxItems"].is_null()); + Ok(()) + } + + #[test] + fn test_enum_schema_invalid_single_default() { + let result = EnumSchema::builder(vec!["A".to_string(), "B".to_string()]).with_default("C"); + + assert!(result.is_err()); + assert_eq!( + result.unwrap_err(), + "Provided default value is not in enum values" + ); + } + + #[test] + fn test_enum_schema_invalid_multi_default() { + let result = EnumSchema::builder(vec!["A".to_string(), "B".to_string()]) + .multiselect() + .with_default(vec!["A".to_string(), "C".to_string()]); + + assert!(result.is_err()); + assert_eq!( + result.unwrap_err(), + "One of the provided default values is not in enum values" + ); + } + + #[test] + fn test_enum_schema_titled_with_default() -> anyhow::Result<()> { + let schema = EnumSchema::builder(vec!["US".to_string(), "UK".to_string()]) + .enum_titles(vec![ + "United States".to_string(), + "United Kingdom".to_string(), + ]) + .map_err(|e| anyhow!("{e}"))? + .with_default("UK") + .map_err(|e| anyhow!("{e}"))? + .build(); + + let json = serde_json::to_value(&schema)?; + + assert_eq!(json["type"], "string"); + assert_eq!(json["default"], "UK"); + assert_eq!( + json["oneOf"], + json!([ + {"const": "US", "title": "United States"}, + {"const": "UK", "title": "United Kingdom"} + ]) + ); + Ok(()) + } + + #[test] + fn test_enum_schema_untitled_after_titled() -> anyhow::Result<()> { + let schema = EnumSchema::builder(vec!["A".to_string(), "B".to_string()]) + .enum_titles(vec!["Option A".to_string(), "Option B".to_string()]) + .map_err(|e| anyhow!("{e}"))? + .untitled() + .build(); + + let json = serde_json::to_value(&schema)?; + + assert_eq!(json["type"], "string"); + assert_eq!(json["enum"], json!(["A", "B"])); + assert!(json["oneOf"].is_null()); + Ok(()) + } + + #[test] + fn test_primitive_schema_enum_deserialization() { + // Test that enum schemas deserialize as Enum variant, not String + let json = json!({ + "type": "string", + "enum": ["a", "b"] + }); + let schema: PrimitiveSchemaDefinition = serde_json::from_value(json).unwrap(); + assert!(matches!(schema, PrimitiveSchemaDefinition::Enum(_))); + // Test that string schemas deserialize as String variant + let json = json!({ + "type": "string" + }); + let schema: PrimitiveSchemaDefinition = serde_json::from_value(json).unwrap(); + assert!(matches!(schema, PrimitiveSchemaDefinition::String(_))); + } + + #[test] + fn test_elicitation_schema_builder_simple() { + let schema = ElicitationSchema::builder() + .required_email("email") + .optional_bool("newsletter", false) + .build() + .unwrap(); + + assert_eq!(schema.properties.len(), 2); + assert!(schema.properties.contains_key("email")); + assert!(schema.properties.contains_key("newsletter")); + assert_eq!(schema.required, Some(vec!["email".to_string()])); + } + + #[test] + fn test_elicitation_schema_builder_complex() { + let enum_schema = + EnumSchema::builder(vec!["US".to_string(), "UK".to_string(), "CA".to_string()]).build(); + let schema = ElicitationSchema::builder() + .required_string_with("name", |s| s.length(1, 100)) + .required_integer("age", 0, 150) + .optional_bool("newsletter", false) + .required_enum_schema("country", enum_schema) + .description("User registration") + .build() + .unwrap(); + + assert_eq!(schema.properties.len(), 4); + assert_eq!( + schema.required, + Some(vec![ + "name".to_string(), + "age".to_string(), + "country".to_string() + ]) + ); + assert_eq!(schema.description.as_deref(), Some("User registration")); + } + + #[test] + fn test_elicitation_schema_serialization() { + let schema = ElicitationSchema::builder() + .required_string_with("name", |s| s.length(1, 100)) + .build() + .unwrap(); + + let json = serde_json::to_value(&schema).unwrap(); + + assert_eq!(json["type"], "object"); + assert!(json["properties"]["name"].is_object()); + assert_eq!(json["required"], json!(["name"])); + } + + #[test] + #[should_panic(expected = "minimum must be <= maximum")] + fn test_integer_range_validation() { + IntegerSchema::new().range(10, 5); // Should panic + } + + #[test] + #[should_panic(expected = "min_length must be <= max_length")] + fn test_string_length_validation() { + StringSchema::new().length(10, 5); // Should panic + } + + #[test] + fn test_integer_range_validation_with_result() { + let result = IntegerSchema::new().with_range(10, 5); + assert!(result.is_err()); + assert_eq!(result.unwrap_err(), "minimum must be <= maximum"); + } + + #[cfg(feature = "schemars")] + mod schemars_tests { + use anyhow::Result; + use schemars::JsonSchema; + use serde::{Deserialize, Serialize}; + use serde_json::json; + + use crate::model::ElicitationSchema; + + #[derive(Debug, Serialize, Deserialize, JsonSchema, Default)] + #[schemars(inline)] + #[schemars(extend("type" = "string"))] + enum TitledEnum { + #[schemars(title = "Title for the first value")] + #[default] + FirstValue, + #[schemars(title = "Title for the second value")] + SecondValue, + } + + #[derive(Debug, Serialize, Deserialize, JsonSchema)] + #[schemars(inline)] + enum UntitledEnum { + First, + Second, + Third, + } + + fn default_untitled_multi_select() -> Vec { + vec![UntitledEnum::Second, UntitledEnum::Third] + } + + #[derive(Debug, Serialize, Deserialize, JsonSchema)] + #[schemars(description = "User information")] + struct UserInfo { + #[schemars(description = "User's name")] + pub name: String, + pub single_select_untitled: UntitledEnum, + #[schemars( + title = "Single Select Titled", + description = "Description for single select enum", + default + )] + pub single_select_titled: TitledEnum, + #[serde(default = "default_untitled_multi_select")] + pub multi_select_untitled: Vec, + #[schemars( + title = "Multi Select Titled", + description = "Multi Select Description" + )] + pub multi_select_titled: Vec, + } + + #[test] + fn test_schema_inference_for_enum_fields() -> Result<()> { + let schema = ElicitationSchema::from_type::()?; + + let json = serde_json::to_value(&schema)?; + assert_eq!(json["type"], "object"); + assert_eq!(json["description"], "User information"); + assert_eq!( + json["required"], + json!(["name", "single_select_untitled", "multi_select_titled"]) + ); + let properties = match json.get("properties") { + Some(serde_json::Value::Object(map)) => map, + _ => panic!("Schema does not have 'properties' field or it is not object type"), + }; + + assert_eq!(properties.len(), 5); + assert_eq!( + properties["name"], + json!({"description":"User's name", "type":"string"}) + ); + + assert_eq!( + properties["single_select_untitled"], + serde_json::json!({ + "type":"string", + "enum":["First", "Second", "Third"] + }) + ); + + assert_eq!( + properties["single_select_titled"], + json!({ + "type":"string", + "title":"Single Select Titled", + "description":"Description for single select enum", + "oneOf":[ + {"const":"FirstValue", "title":"Title for the first value"}, + {"const":"SecondValue", "title":"Title for the second value"} + ], + "default":"FirstValue" + }) + ); + assert_eq!( + properties["multi_select_untitled"], + serde_json::json!({ + "type":"array", + "items" : { + "type":"string", + "enum":["First", "Second", "Third"] + }, + "default":["Second", "Third"] + }) + ); + assert_eq!( + properties["multi_select_titled"], + serde_json::json!({ + "type":"array", + "title":"Multi Select Titled", + "description":"Multi Select Description", + "items":{ + "anyOf":[ + {"const":"FirstValue", "title":"Title for the first value"}, + {"const":"SecondValue", "title":"Title for the second value"} + ] + } + }) + ); + Ok(()) + } + } +} diff --git a/vendor/rmcp/src/model/extension.rs b/vendor/rmcp/src/model/extension.rs new file mode 100644 index 00000000..039fdf2e --- /dev/null +++ b/vendor/rmcp/src/model/extension.rs @@ -0,0 +1,337 @@ +//! A container for those extra data could be carried on request or notification. +//! +//! This file is copied and modified from crate [http](https://github.com/hyperium/http). +//! +//! - Original code license: +//! - Original code: +use std::{ + any::{Any, TypeId}, + collections::HashMap, + fmt, + hash::{BuildHasherDefault, Hasher}, +}; + +type AnyMap = HashMap, BuildHasherDefault>; + +// With TypeIds as keys, there's no need to hash them. They are already hashes +// themselves, coming from the compiler. The IdHasher just holds the u64 of +// the TypeId, and then returns it, instead of doing any bit fiddling. +#[derive(Default)] +struct IdHasher(u64); + +impl Hasher for IdHasher { + fn write(&mut self, _: &[u8]) { + unreachable!("TypeId calls write_u64"); + } + + #[inline] + fn write_u64(&mut self, id: u64) { + self.0 = id; + } + + #[inline] + fn finish(&self) -> u64 { + self.0 + } +} + +/// A type map of protocol extensions. +/// +/// `Extensions` can be used by `Request` `Notification` and `Response` to store +/// extra data derived from the underlying protocol. +#[derive(Clone, Default)] +pub struct Extensions { + // If extensions are never used, no need to carry around an empty HashMap. + // That's 3 words. Instead, this is only 1 word. + map: Option>, +} + +impl Extensions { + /// Create an empty `Extensions`. + #[inline] + pub const fn new() -> Extensions { + Extensions { map: None } + } + + /// Insert a type into this `Extensions`. + /// + /// If a extension of this type already existed, it will + /// be returned and replaced with the new one. + /// + /// # Example + /// + /// ``` + /// # use rmcp::model::Extensions; + /// let mut ext = Extensions::new(); + /// assert!(ext.insert(5i32).is_none()); + /// assert!(ext.insert(4u8).is_none()); + /// assert_eq!(ext.insert(9i32), Some(5i32)); + /// ``` + pub fn insert(&mut self, val: T) -> Option { + self.map + .get_or_insert_with(Box::default) + .insert(TypeId::of::(), Box::new(val)) + .and_then(|boxed| boxed.into_any().downcast().ok().map(|boxed| *boxed)) + } + + /// Get a reference to a type previously inserted on this `Extensions`. + /// + /// # Example + /// + /// ``` + /// # use rmcp::model::Extensions; + /// let mut ext = Extensions::new(); + /// assert!(ext.get::().is_none()); + /// ext.insert(5i32); + /// + /// assert_eq!(ext.get::(), Some(&5i32)); + /// ``` + pub fn get(&self) -> Option<&T> { + self.map + .as_ref() + .and_then(|map| map.get(&TypeId::of::())) + .and_then(|boxed| (**boxed).as_any().downcast_ref()) + } + + /// Get a mutable reference to a type previously inserted on this `Extensions`. + /// + /// # Example + /// + /// ``` + /// # use rmcp::model::Extensions; + /// let mut ext = Extensions::new(); + /// ext.insert(String::from("Hello")); + /// ext.get_mut::().unwrap().push_str(" World"); + /// + /// assert_eq!(ext.get::().unwrap(), "Hello World"); + /// ``` + pub fn get_mut(&mut self) -> Option<&mut T> { + self.map + .as_mut() + .and_then(|map| map.get_mut(&TypeId::of::())) + .and_then(|boxed| (**boxed).as_any_mut().downcast_mut()) + } + + /// Get a mutable reference to a type, inserting `value` if not already present on this + /// `Extensions`. + /// + /// # Example + /// + /// ``` + /// # use rmcp::model::Extensions; + /// let mut ext = Extensions::new(); + /// *ext.get_or_insert(1i32) += 2; + /// + /// assert_eq!(*ext.get::().unwrap(), 3); + /// ``` + pub fn get_or_insert(&mut self, value: T) -> &mut T { + self.get_or_insert_with(|| value) + } + + /// Get a mutable reference to a type, inserting the value created by `f` if not already present + /// on this `Extensions`. + /// + /// # Example + /// + /// ``` + /// # use rmcp::model::Extensions; + /// let mut ext = Extensions::new(); + /// *ext.get_or_insert_with(|| 1i32) += 2; + /// + /// assert_eq!(*ext.get::().unwrap(), 3); + /// ``` + pub fn get_or_insert_with T>( + &mut self, + f: F, + ) -> &mut T { + let out = self + .map + .get_or_insert_with(Box::default) + .entry(TypeId::of::()) + .or_insert_with(|| Box::new(f())); + (**out).as_any_mut().downcast_mut().unwrap() + } + + /// Get a mutable reference to a type, inserting the type's default value if not already present + /// on this `Extensions`. + /// + /// # Example + /// + /// ``` + /// # use rmcp::model::Extensions; + /// let mut ext = Extensions::new(); + /// *ext.get_or_insert_default::() += 2; + /// + /// assert_eq!(*ext.get::().unwrap(), 2); + /// ``` + pub fn get_or_insert_default(&mut self) -> &mut T { + self.get_or_insert_with(T::default) + } + + /// Remove a type from this `Extensions`. + /// + /// If a extension of this type existed, it will be returned. + /// + /// # Example + /// + /// ``` + /// # use rmcp::model::Extensions; + /// let mut ext = Extensions::new(); + /// ext.insert(5i32); + /// assert_eq!(ext.remove::(), Some(5i32)); + /// assert!(ext.get::().is_none()); + /// ``` + pub fn remove(&mut self) -> Option { + self.map + .as_mut() + .and_then(|map| map.remove(&TypeId::of::())) + .and_then(|boxed| boxed.into_any().downcast().ok().map(|boxed| *boxed)) + } + + /// Clear the `Extensions` of all inserted extensions. + /// + /// # Example + /// + /// ``` + /// # use rmcp::model::Extensions; + /// let mut ext = Extensions::new(); + /// ext.insert(5i32); + /// ext.clear(); + /// + /// assert!(ext.get::().is_none()); + /// ``` + #[inline] + pub fn clear(&mut self) { + if let Some(ref mut map) = self.map { + map.clear(); + } + } + + /// Check whether the extension set is empty or not. + /// + /// # Example + /// + /// ``` + /// # use rmcp::model::Extensions; + /// let mut ext = Extensions::new(); + /// assert!(ext.is_empty()); + /// ext.insert(5i32); + /// assert!(!ext.is_empty()); + /// ``` + #[inline] + pub fn is_empty(&self) -> bool { + self.map.as_ref().is_none_or(|map| map.is_empty()) + } + + /// Get the number of extensions available. + /// + /// # Example + /// + /// ``` + /// # use rmcp::model::Extensions; + /// let mut ext = Extensions::new(); + /// assert_eq!(ext.len(), 0); + /// ext.insert(5i32); + /// assert_eq!(ext.len(), 1); + /// ``` + #[inline] + pub fn len(&self) -> usize { + self.map.as_ref().map_or(0, |map| map.len()) + } + + /// Extends `self` with another `Extensions`. + /// + /// If an instance of a specific type exists in both, the one in `self` is overwritten with the + /// one from `other`. + /// + /// # Example + /// + /// ``` + /// # use rmcp::model::Extensions; + /// let mut ext_a = Extensions::new(); + /// ext_a.insert(8u8); + /// ext_a.insert(16u16); + /// + /// let mut ext_b = Extensions::new(); + /// ext_b.insert(4u8); + /// ext_b.insert("hello"); + /// + /// ext_a.extend(ext_b); + /// assert_eq!(ext_a.len(), 3); + /// assert_eq!(ext_a.get::(), Some(&4u8)); + /// assert_eq!(ext_a.get::(), Some(&16u16)); + /// assert_eq!(ext_a.get::<&'static str>().copied(), Some("hello")); + /// ``` + pub fn extend(&mut self, other: Self) { + if let Some(other) = other.map { + if let Some(map) = &mut self.map { + map.extend(*other); + } else { + self.map = Some(other); + } + } + } +} + +impl fmt::Debug for Extensions { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.debug_struct("Extensions").finish() + } +} + +trait AnyClone: Any { + fn clone_box(&self) -> Box; + fn as_any(&self) -> &dyn Any; + fn as_any_mut(&mut self) -> &mut dyn Any; + fn into_any(self: Box) -> Box; +} + +impl AnyClone for T { + fn clone_box(&self) -> Box { + Box::new(self.clone()) + } + + fn as_any(&self) -> &dyn Any { + self + } + + fn as_any_mut(&mut self) -> &mut dyn Any { + self + } + + fn into_any(self: Box) -> Box { + self + } +} + +impl Clone for Box { + fn clone(&self) -> Self { + (**self).clone_box() + } +} + +#[test] +fn test_extensions() { + #[derive(Clone, Debug, PartialEq)] + struct MyType(i32); + + let mut extensions = Extensions::new(); + + extensions.insert(5i32); + extensions.insert(MyType(10)); + + assert_eq!(extensions.get(), Some(&5i32)); + assert_eq!(extensions.get_mut(), Some(&mut 5i32)); + + let ext2 = extensions.clone(); + + assert_eq!(extensions.remove::(), Some(5i32)); + assert!(extensions.get::().is_none()); + + // clone still has it + assert_eq!(ext2.get(), Some(&5i32)); + assert_eq!(ext2.get(), Some(&MyType(10))); + + assert_eq!(extensions.get::(), None); + assert_eq!(extensions.get(), Some(&MyType(10))); +} diff --git a/vendor/rmcp/src/model/meta.rs b/vendor/rmcp/src/model/meta.rs new file mode 100644 index 00000000..0a7121e4 --- /dev/null +++ b/vendor/rmcp/src/model/meta.rs @@ -0,0 +1,859 @@ +use std::ops::{Deref, DerefMut}; + +use serde::{Deserialize, Serialize}; +use serde_json::Value; + +use super::{ + ClientCapabilities, ClientNotification, ClientRequest, CustomNotification, CustomRequest, + Extensions, Implementation, JsonObject, JsonRpcMessage, LoggingLevel, ProgressToken, + ProtocolVersion, RequestId, ServerNotification, ServerRequest, +}; + +/// Access to the metadata carried by a message envelope's [`Extensions`]. +/// +/// The metadata type differs by message kind: requests carry a +/// [`RequestMetaObject`] and notifications carry a [`NotificationMetaObject`]. +/// +/// The envelope extensions are the canonical runtime location for `_meta`: +/// deserialization strips the wire `params._meta` into the extensions (typed +/// params `meta` fields stay empty), and the service loop moves it into +/// [`RequestContext::meta`] / [`NotificationContext::meta`] before dispatch. +/// Typed params `meta` fields are honored when serializing outgoing messages; +/// on key conflicts the extensions-level metadata wins. +/// +/// [`RequestContext::meta`]: crate::service::RequestContext +/// [`NotificationContext::meta`]: crate::service::NotificationContext +pub trait GetMeta { + /// The metadata type for this message kind. + type Metadata: Default; + fn get_meta_mut(&mut self) -> &mut Self::Metadata; + fn get_meta(&self) -> &Self::Metadata; +} + +pub trait GetExtensions { + fn extensions(&self) -> &Extensions; + fn extensions_mut(&mut self) -> &mut Extensions; +} + +/// Trait for request params that contain the `_meta` field. +/// +/// Per the MCP spec, all request params may have an optional `_meta` +/// field ([`RequestMetaObject`]) that can contain a `progressToken` for +/// tracking long-running operations. +pub trait RequestParamsMeta { + /// Get a reference to the meta field + fn meta(&self) -> Option<&RequestMetaObject>; + /// Get a mutable reference to the meta field + fn meta_mut(&mut self) -> &mut Option; + /// Set the meta field + fn set_meta(&mut self, meta: RequestMetaObject) { + *self.meta_mut() = Some(meta); + } + /// Get the progress token from meta, if present + fn progress_token(&self) -> Option { + self.meta().and_then(|m| m.get_progress_token()) + } + /// Set a progress token in meta + fn set_progress_token(&mut self, token: ProgressToken) { + match self.meta_mut() { + Some(meta) => meta.set_progress_token(token), + none => { + let mut meta = RequestMetaObject::new(); + meta.set_progress_token(token); + *none = Some(meta); + } + } + } + /// Get the W3C `traceparent` value from meta, if present (SEP-414) + fn traceparent(&self) -> Option<&str> { + self.meta().and_then(|m| m.get_traceparent()) + } + /// Set the W3C `traceparent` value in meta (SEP-414) + fn set_traceparent(&mut self, value: &str) { + self.meta_or_default().set_traceparent(value); + } + /// Get the W3C `tracestate` value from meta, if present (SEP-414) + fn tracestate(&self) -> Option<&str> { + self.meta().and_then(|m| m.get_tracestate()) + } + /// Set the W3C `tracestate` value in meta (SEP-414) + fn set_tracestate(&mut self, value: &str) { + self.meta_or_default().set_tracestate(value); + } + /// Get the W3C `baggage` value from meta, if present (SEP-414) + fn baggage(&self) -> Option<&str> { + self.meta().and_then(|m| m.get_baggage()) + } + /// Set the W3C `baggage` value in meta (SEP-414) + fn set_baggage(&mut self, value: &str) { + self.meta_or_default().set_baggage(value); + } + /// Get a mutable reference to meta, inserting an empty one if absent. + fn meta_or_default(&mut self) -> &mut RequestMetaObject { + self.meta_mut().get_or_insert_with(RequestMetaObject::new) + } +} + +impl GetExtensions for CustomNotification { + fn extensions(&self) -> &Extensions { + &self.extensions + } + fn extensions_mut(&mut self) -> &mut Extensions { + &mut self.extensions + } +} + +impl GetMeta for CustomNotification { + type Metadata = NotificationMetaObject; + fn get_meta_mut(&mut self) -> &mut NotificationMetaObject { + self.extensions_mut().get_or_insert_default() + } + fn get_meta(&self) -> &NotificationMetaObject { + self.extensions() + .get::() + .unwrap_or(NotificationMetaObject::static_empty()) + } +} + +impl GetExtensions for CustomRequest { + fn extensions(&self) -> &Extensions { + &self.extensions + } + fn extensions_mut(&mut self) -> &mut Extensions { + &mut self.extensions + } +} + +impl GetMeta for CustomRequest { + type Metadata = RequestMetaObject; + fn get_meta_mut(&mut self) -> &mut RequestMetaObject { + self.extensions_mut().get_or_insert_default() + } + fn get_meta(&self) -> &RequestMetaObject { + self.extensions() + .get::() + .unwrap_or(RequestMetaObject::static_empty()) + } +} + +macro_rules! variant_extension { + ( + $Enum: ident: $Metadata: ident { + $($variant: ident)* + } + ) => { + impl GetExtensions for $Enum { + fn extensions(&self) -> &Extensions { + match self { + $( + $Enum::$variant(v) => &v.extensions, + )* + } + } + fn extensions_mut(&mut self) -> &mut Extensions { + match self { + $( + $Enum::$variant(v) => &mut v.extensions, + )* + } + } + } + impl GetMeta for $Enum { + type Metadata = $Metadata; + fn get_meta_mut(&mut self) -> &mut $Metadata { + self.extensions_mut().get_or_insert_default() + } + fn get_meta(&self) -> &$Metadata { + self.extensions().get::<$Metadata>().unwrap_or($Metadata::static_empty()) + } + } + }; +} + +variant_extension! { + ClientRequest: RequestMetaObject { + PingRequest + InitializeRequest + DiscoverRequest + CompleteRequest + SetLevelRequest + GetPromptRequest + ListPromptsRequest + ListResourcesRequest + ListResourceTemplatesRequest + ReadResourceRequest + SubscriptionsListenRequest + SubscribeRequest + UnsubscribeRequest + CallToolRequest + ListToolsRequest + CustomRequest + GetTaskRequest + UpdateTaskRequest + CancelTaskRequest + } +} + +variant_extension! { + ServerRequest: RequestMetaObject { + PingRequest + CreateMessageRequest + ListRootsRequest + ElicitRequest + CustomRequest + } +} + +variant_extension! { + ClientNotification: NotificationMetaObject { + CancelledNotification + ProgressNotification + InitializedNotification + RootsListChangedNotification + CustomNotification + } +} + +variant_extension! { + ServerNotification: NotificationMetaObject { + CancelledNotification + ProgressNotification + LoggingMessageNotification + ResourceUpdatedNotification + ResourceListChangedNotification + ToolListChangedNotification + PromptListChangedNotification + SubscriptionsAcknowledgedNotification + TaskStatusNotification + CustomNotification + } +} + +/// General-purpose `_meta` map (spec `MetaObject`). +/// +/// This is the metadata shape used by results, content blocks, and catalog +/// descriptors (tools, prompts, resources, roots, ...). It preserves arbitrary +/// extension keys and offers helpers for the reserved W3C Trace Context keys +/// (SEP-414). +/// +/// Request and notification `_meta` maps have additional reserved keys; see +/// [`RequestMetaObject`] and [`NotificationMetaObject`]. +#[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq)] +#[serde(transparent)] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct MetaObject(pub JsonObject); + +impl MetaObject { + /// Reserved `_meta` key for the W3C Trace Context `traceparent` value (SEP-414). + const TRACEPARENT_FIELD: &str = "traceparent"; + /// Reserved `_meta` key for the W3C Trace Context `tracestate` value (SEP-414). + const TRACESTATE_FIELD: &str = "tracestate"; + /// Reserved `_meta` key for the W3C Baggage value (SEP-414). + const BAGGAGE_FIELD: &str = "baggage"; + + /// Create an empty metadata map. + pub fn new() -> Self { + Self(JsonObject::new()) + } + + /// Read a string-valued `_meta` field, or `None` if absent or not a string. + fn get_str(&self, field: &str) -> Option<&str> { + self.0.get(field).and_then(Value::as_str) + } + + /// Write a string-valued `_meta` field. + fn set_str(&mut self, field: &str, value: impl Into) { + self.0 + .insert(field.to_string(), Value::String(value.into())); + } + + /// Get the W3C `traceparent` value (SEP-414), if present. + pub fn get_traceparent(&self) -> Option<&str> { + self.get_str(Self::TRACEPARENT_FIELD) + } + + /// Set the W3C `traceparent` value (SEP-414). + /// + /// ``` + /// use rmcp::model::MetaObject; + /// + /// let mut meta = MetaObject::new(); + /// meta.set_traceparent("00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01"); + /// assert_eq!( + /// meta.get_traceparent(), + /// Some("00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01"), + /// ); + /// ``` + pub fn set_traceparent(&mut self, value: impl Into) { + self.set_str(Self::TRACEPARENT_FIELD, value); + } + + /// Get the W3C `tracestate` value (SEP-414), if present. + pub fn get_tracestate(&self) -> Option<&str> { + self.get_str(Self::TRACESTATE_FIELD) + } + + /// Set the W3C `tracestate` value (SEP-414). + pub fn set_tracestate(&mut self, value: impl Into) { + self.set_str(Self::TRACESTATE_FIELD, value); + } + + /// Get the W3C `baggage` value (SEP-414), if present. + pub fn get_baggage(&self) -> Option<&str> { + self.get_str(Self::BAGGAGE_FIELD) + } + + /// Set the W3C `baggage` value (SEP-414). + pub fn set_baggage(&mut self, value: impl Into) { + self.set_str(Self::BAGGAGE_FIELD, value); + } + + /// Insert every entry of `other`, overwriting existing keys on conflict. + pub fn extend(&mut self, other: MetaObject) { + self.0.extend(other.0); + } + + fn decode_value(&self, key: &str) -> Option + where + T: for<'de> Deserialize<'de>, + { + self.0.get(key).and_then(|value| T::deserialize(value).ok()) + } + + fn insert_serialized(&mut self, key: &str, value: T) + where + T: Serialize, + { + let value = serde_json::to_value(value) + .expect("MCP meta helper value should serialize to valid JSON"); + self.0.insert(key.to_string(), value); + } +} + +impl Deref for MetaObject { + type Target = JsonObject; + + fn deref(&self) -> &Self::Target { + &self.0 + } +} + +impl DerefMut for MetaObject { + fn deref_mut(&mut self) -> &mut Self::Target { + &mut self.0 + } +} + +impl From for MetaObject { + fn from(object: JsonObject) -> Self { + Self(object) + } +} + +#[cfg(feature = "schemars")] +impl schemars::JsonSchema for MetaObject { + fn schema_name() -> std::borrow::Cow<'static, str> { + std::borrow::Cow::Borrowed("MetaObject") + } + + fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema { + schemars::json_schema!({ + "description": "See [MCP general fields](https://modelcontextprotocol.io/specification/2026-07-28/basic#general-fields) for notes on _meta usage.", + "type": "object", + "additionalProperties": true, + }) + } +} + +/// The `_meta` map carried by requests (spec `RequestMetaObject`). +/// +/// In addition to arbitrary extension keys, requests reserve: +/// - `progressToken` for progress tracking +/// - `io.modelcontextprotocol/protocolVersion` (SEP-2575) +/// - `io.modelcontextprotocol/clientInfo` (SEP-2575) +/// - `io.modelcontextprotocol/clientCapabilities` (SEP-2575) +/// - `io.modelcontextprotocol/logLevel` (SEP-2575) +/// +/// The 2026-07-28 draft schema requires the protocol-version and +/// client-capabilities keys; client-info is optional. Earlier protocol versions +/// do not know them. All keys therefore stay optional at runtime and in the +/// generated (version-shared) JSON schema — use +/// [`RequestMetaObject::missing_required_keys`] to validate a request against +/// the negotiated protocol version. +/// +/// This type dereferences to [`MetaObject`] (and transitively to the underlying +/// map), so general helpers such as the SEP-414 trace-context accessors remain +/// available. +#[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq)] +#[serde(transparent)] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct RequestMetaObject(pub MetaObject); + +impl RequestMetaObject { + const PROGRESS_TOKEN_FIELD: &str = "progressToken"; + const META_KEY_PROTOCOL_VERSION: &str = "io.modelcontextprotocol/protocolVersion"; + const META_KEY_CLIENT_INFO: &str = "io.modelcontextprotocol/clientInfo"; + const META_KEY_CLIENT_CAPABILITIES: &str = "io.modelcontextprotocol/clientCapabilities"; + const META_KEY_LOG_LEVEL: &str = "io.modelcontextprotocol/logLevel"; + + /// Request `_meta` keys the 2026-07-28 draft schema marks as required. + pub const DRAFT_REQUIRED_KEYS: [&str; 2] = [ + Self::META_KEY_PROTOCOL_VERSION, + Self::META_KEY_CLIENT_CAPABILITIES, + ]; + + /// Create an empty request metadata map. + pub fn new() -> Self { + Self::default() + } + + /// Create a new request meta with a progress token set + pub fn with_progress_token(token: ProgressToken) -> Self { + let mut meta = Self::new(); + meta.set_progress_token(token); + meta + } + + /// Create request metadata with the client context SEP-2575 requires on every request. + pub fn with_client_context( + protocol_version: ProtocolVersion, + client_info: Implementation, + client_capabilities: ClientCapabilities, + ) -> Self { + let mut meta = Self::new(); + meta.set_protocol_version(protocol_version); + meta.set_client_info(client_info); + meta.set_client_capabilities(client_capabilities); + meta + } + + pub(crate) fn static_empty() -> &'static Self { + static EMPTY: std::sync::OnceLock = std::sync::OnceLock::new(); + EMPTY.get_or_init(Default::default) + } + + /// Get the progress token carried in `_meta`, if present and valid. + pub fn get_progress_token(&self) -> Option { + self.0.decode_value(Self::PROGRESS_TOKEN_FIELD) + } + + /// Set the progress token carried in `_meta`. + pub fn set_progress_token(&mut self, token: ProgressToken) { + self.0.insert_serialized(Self::PROGRESS_TOKEN_FIELD, token); + } + + /// Get the MCP protocol version carried in `_meta`, if present and valid. + pub fn protocol_version(&self) -> Option { + self.0.decode_value(Self::META_KEY_PROTOCOL_VERSION) + } + + /// Set the MCP protocol version carried in `_meta`. + pub fn set_protocol_version(&mut self, protocol_version: ProtocolVersion) { + self.0.0.insert( + Self::META_KEY_PROTOCOL_VERSION.to_string(), + Value::String(protocol_version.to_string()), + ); + } + + /// Get the client implementation identity carried in `_meta`, if present and valid. + pub fn client_info(&self) -> Option { + self.0.decode_value(Self::META_KEY_CLIENT_INFO) + } + + /// Set the client implementation identity carried in `_meta`. + pub fn set_client_info(&mut self, client_info: Implementation) { + self.0 + .insert_serialized(Self::META_KEY_CLIENT_INFO, client_info); + } + + /// Get the client capabilities carried in `_meta`, if present and valid. + pub fn client_capabilities(&self) -> Option { + self.0.decode_value(Self::META_KEY_CLIENT_CAPABILITIES) + } + + /// Set the client capabilities carried in `_meta`. + pub fn set_client_capabilities(&mut self, client_capabilities: ClientCapabilities) { + self.0 + .insert_serialized(Self::META_KEY_CLIENT_CAPABILITIES, client_capabilities); + } + + /// Get the requested per-request log level carried in `_meta`, if present and valid. + pub fn log_level(&self) -> Option { + self.0.decode_value(Self::META_KEY_LOG_LEVEL) + } + + /// Set the requested per-request log level carried in `_meta`. + pub fn set_log_level(&mut self, log_level: LoggingLevel) { + self.0 + .insert_serialized(Self::META_KEY_LOG_LEVEL, log_level); + } + + /// Return the [`Self::DRAFT_REQUIRED_KEYS`] whose values are absent or + /// invalid in this map, if `protocol_version` requires them. + /// + /// A key counts as missing when it is not present *or* when its value does + /// not decode into the expected type (e.g. a numeric `protocolVersion` or + /// a string `clientInfo`), matching what the typed accessors return. + /// + /// Protocol versions before 2026-07-28 have no required request metadata, + /// so this always returns an empty list for them. + /// + /// # Examples + /// + /// ``` + /// use rmcp::model::{ProtocolVersion, RequestMetaObject}; + /// + /// let meta = RequestMetaObject::new(); + /// // Older protocols have no required request metadata. + /// assert!( + /// meta.missing_required_keys(&ProtocolVersion::V_2025_11_25) + /// .is_empty() + /// ); + /// // The 2026-07-28 protocol requires per-request context. + /// assert_eq!( + /// meta.missing_required_keys(&ProtocolVersion::V_2026_07_28), + /// RequestMetaObject::DRAFT_REQUIRED_KEYS.to_vec(), + /// ); + /// ``` + pub fn missing_required_keys(&self, protocol_version: &ProtocolVersion) -> Vec<&'static str> { + if protocol_version.as_str() < ProtocolVersion::V_2026_07_28.as_str() { + return Vec::new(); + } + let mut missing = Vec::new(); + if self.protocol_version().is_none() { + missing.push(Self::META_KEY_PROTOCOL_VERSION); + } + if self.client_capabilities().is_none() { + missing.push(Self::META_KEY_CLIENT_CAPABILITIES); + } + missing + } + + /// Insert every entry of `other`, overwriting existing keys on conflict. + pub fn extend(&mut self, other: RequestMetaObject) { + self.0.extend(other.0); + } +} + +impl Deref for RequestMetaObject { + type Target = MetaObject; + + fn deref(&self) -> &Self::Target { + &self.0 + } +} + +impl DerefMut for RequestMetaObject { + fn deref_mut(&mut self) -> &mut Self::Target { + &mut self.0 + } +} + +impl From for RequestMetaObject { + fn from(meta: MetaObject) -> Self { + Self(meta) + } +} + +impl From for RequestMetaObject { + fn from(object: JsonObject) -> Self { + Self(MetaObject(object)) + } +} + +#[cfg(feature = "schemars")] +impl schemars::JsonSchema for RequestMetaObject { + fn schema_name() -> std::borrow::Cow<'static, str> { + std::borrow::Cow::Borrowed("RequestMetaObject") + } + + fn json_schema(generator: &mut schemars::SchemaGenerator) -> schemars::Schema { + let progress_token = generator.subschema_for::(); + let client_info = generator.subschema_for::(); + let client_capabilities = generator.subschema_for::(); + let log_level = generator.subschema_for::(); + // rmcp generates one schema shared by every supported protocol + // version, so the keys validated for 2026-07-28 are left + // optional here: a 2025-11-25 request whose `_meta` only carries + // `progressToken` is valid. Version-specific validation is available at + // runtime via [`RequestMetaObject::missing_required_keys`]. + schemars::json_schema!({ + "description": "Metadata reserved by MCP on requests. Extension keys are also allowed.", + "type": "object", + "properties": { + "progressToken": progress_token, + "io.modelcontextprotocol/protocolVersion": { + "type": "string", + }, + "io.modelcontextprotocol/clientInfo": client_info, + "io.modelcontextprotocol/clientCapabilities": client_capabilities, + "io.modelcontextprotocol/logLevel": log_level, + }, + "additionalProperties": true, + }) + } +} + +/// The `_meta` map carried by notifications (spec `NotificationMetaObject`). +/// +/// In addition to arbitrary extension keys, notifications reserve +/// `io.modelcontextprotocol/subscriptionId` to correlate a notification with a +/// prior subscription request. +/// +/// This type dereferences to [`MetaObject`] (and transitively to the underlying +/// map), so general helpers such as the SEP-414 trace-context accessors remain +/// available. +#[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq)] +#[serde(transparent)] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct NotificationMetaObject(pub MetaObject); + +impl NotificationMetaObject { + const META_KEY_SUBSCRIPTION_ID: &str = "io.modelcontextprotocol/subscriptionId"; + + /// Create an empty notification metadata map. + pub fn new() -> Self { + Self::default() + } + + pub(crate) fn static_empty() -> &'static Self { + static EMPTY: std::sync::OnceLock = std::sync::OnceLock::new(); + EMPTY.get_or_init(Default::default) + } + + /// Get the subscription id carried in `_meta`, if present and valid. + /// + /// # Examples + /// + /// ``` + /// use rmcp::model::{NotificationMetaObject, RequestId}; + /// + /// let mut meta = NotificationMetaObject::new(); + /// assert_eq!(meta.subscription_id(), None); + /// meta.set_subscription_id(RequestId::Number(7)); + /// assert_eq!(meta.subscription_id(), Some(RequestId::Number(7))); + /// ``` + pub fn subscription_id(&self) -> Option { + self.0.decode_value(Self::META_KEY_SUBSCRIPTION_ID) + } + + /// Set the subscription id carried in `_meta`. + pub fn set_subscription_id(&mut self, subscription_id: RequestId) { + self.0 + .insert_serialized(Self::META_KEY_SUBSCRIPTION_ID, subscription_id); + } + + /// Insert every entry of `other`, overwriting existing keys on conflict. + pub fn extend(&mut self, other: NotificationMetaObject) { + self.0.extend(other.0); + } +} + +impl Deref for NotificationMetaObject { + type Target = MetaObject; + + fn deref(&self) -> &Self::Target { + &self.0 + } +} + +impl DerefMut for NotificationMetaObject { + fn deref_mut(&mut self) -> &mut Self::Target { + &mut self.0 + } +} + +impl From for NotificationMetaObject { + fn from(meta: MetaObject) -> Self { + Self(meta) + } +} + +impl From for NotificationMetaObject { + fn from(object: JsonObject) -> Self { + Self(MetaObject(object)) + } +} + +#[cfg(feature = "schemars")] +impl schemars::JsonSchema for NotificationMetaObject { + fn schema_name() -> std::borrow::Cow<'static, str> { + std::borrow::Cow::Borrowed("NotificationMetaObject") + } + + fn json_schema(generator: &mut schemars::SchemaGenerator) -> schemars::Schema { + let subscription_id = generator.subschema_for::(); + schemars::json_schema!({ + "description": "Metadata reserved by MCP on notifications. Extension keys are also allowed.", + "type": "object", + "properties": { + "io.modelcontextprotocol/subscriptionId": subscription_id, + }, + "additionalProperties": true, + }) + } +} + +impl JsonRpcMessage +where + Req: GetExtensions, + Noti: GetExtensions, +{ + pub fn insert_extension(&mut self, value: T) { + match self { + JsonRpcMessage::Request(json_rpc_request) => { + json_rpc_request.request.extensions_mut().insert(value); + } + JsonRpcMessage::Notification(json_rpc_notification) => { + json_rpc_notification + .notification + .extensions_mut() + .insert(value); + } + _ => {} + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::model::NumberOrString; + + #[derive(Default)] + struct Params { + meta: Option, + } + + impl RequestParamsMeta for Params { + fn meta(&self) -> Option<&RequestMetaObject> { + self.meta.as_ref() + } + fn meta_mut(&mut self) -> &mut Option { + &mut self.meta + } + } + + const TRACEPARENT: &str = "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01"; + + #[test] + fn trace_context_round_trip() { + let mut meta = MetaObject::new(); + meta.set_traceparent(TRACEPARENT); + meta.set_tracestate("vendor1=value1,vendor2=value2"); + meta.set_baggage("userId=alice,region=us-east-1"); + assert_eq!(meta.get_traceparent(), Some(TRACEPARENT)); + assert_eq!(meta.get_tracestate(), Some("vendor1=value1,vendor2=value2")); + assert_eq!(meta.get_baggage(), Some("userId=alice,region=us-east-1")); + } + + #[test] + fn absent_field_is_none() { + let meta = MetaObject::new(); + assert_eq!(meta.get_traceparent(), None); + assert_eq!(meta.get_tracestate(), None); + assert_eq!(meta.get_baggage(), None); + } + + #[test] + fn non_string_value_is_none() { + let mut meta = MetaObject::new(); + meta.0 + .insert(MetaObject::TRACEPARENT_FIELD.to_string(), Value::from(42)); + assert_eq!(meta.get_traceparent(), None); + } + + #[test] + fn trait_setter_inserts_meta_when_absent() { + let mut params = Params::default(); + assert_eq!(params.traceparent(), None); + params.set_traceparent(TRACEPARENT); + assert_eq!(params.traceparent(), Some(TRACEPARENT)); + } + + #[test] + fn request_meta_derefs_to_general_helpers() { + let mut meta = RequestMetaObject::new(); + meta.set_traceparent(TRACEPARENT); + meta.set_progress_token(ProgressToken(NumberOrString::Number(7))); + assert_eq!(meta.get_traceparent(), Some(TRACEPARENT)); + assert_eq!( + meta.get_progress_token(), + Some(ProgressToken(NumberOrString::Number(7))) + ); + } + + mod subscription_id { + use super::*; + + #[test] + fn returns_none_when_absent() { + let meta = NotificationMetaObject::new(); + assert_eq!(meta.subscription_id(), None); + } + + #[test] + fn round_trips_number_id() { + let mut meta = NotificationMetaObject::new(); + meta.set_subscription_id(RequestId::Number(42)); + assert_eq!(meta.subscription_id(), Some(RequestId::Number(42))); + } + + #[test] + fn round_trips_string_id() { + let mut meta = NotificationMetaObject::new(); + meta.set_subscription_id(RequestId::String("sub-1".into())); + assert_eq!( + meta.subscription_id(), + Some(RequestId::String("sub-1".into())) + ); + } + } + + mod missing_required_keys { + use super::*; + + #[test] + fn is_empty_for_pre_draft_protocols() { + let meta = RequestMetaObject::new(); + assert!( + meta.missing_required_keys(&ProtocolVersion::V_2025_11_25) + .is_empty() + ); + } + + #[test] + fn lists_all_draft_keys_for_empty_meta() { + let meta = RequestMetaObject::new(); + assert_eq!( + meta.missing_required_keys(&ProtocolVersion::V_2026_07_28), + RequestMetaObject::DRAFT_REQUIRED_KEYS.to_vec() + ); + } + + #[test] + fn treats_malformed_values_as_missing() { + let meta: RequestMetaObject = serde_json::from_value(serde_json::json!({ + "io.modelcontextprotocol/protocolVersion": 123, + "io.modelcontextprotocol/clientCapabilities": null, + })) + .unwrap(); + assert_eq!( + meta.missing_required_keys(&ProtocolVersion::V_2026_07_28), + RequestMetaObject::DRAFT_REQUIRED_KEYS.to_vec() + ); + } + + #[test] + fn is_empty_when_draft_keys_are_present() { + let mut meta = RequestMetaObject::new(); + meta.set_protocol_version(ProtocolVersion::V_2026_07_28); + meta.set_client_info(Implementation::from_build_env()); + meta.set_client_capabilities(ClientCapabilities::default()); + assert!( + meta.missing_required_keys(&ProtocolVersion::V_2026_07_28) + .is_empty() + ); + } + } +} diff --git a/vendor/rmcp/src/model/mrtr.rs b/vendor/rmcp/src/model/mrtr.rs new file mode 100644 index 00000000..8dac9a39 --- /dev/null +++ b/vendor/rmcp/src/model/mrtr.rs @@ -0,0 +1,558 @@ +//! Multi Round-Trip Request (MRTR) types for SEP-2322. +//! +//! Provides [`InputRequiredResult`], [`InputRequests`], and [`InputResponses`] +//! for the stateless multi round-trip request pattern defined in the MCP spec. +//! [`ResultType`] lives in the parent [`super`] module alongside other base result types. +//! +//! # Overview +//! +//! A server may respond to `tools/call`, `prompts/get`, or `resources/read` with an +//! [`InputRequiredResult`] instead of the normal result. The client fulfills the +//! [`InputRequests`], then retries the original request with [`InputResponses`] and +//! the echoed `requestState`. +//! +//! # Using MRTR +//! +//! **Server:** return an [`InputRequiredResult`] from a tool/prompt/resource +//! handler via the matching outcome enum ([`CallToolResponse`], +//! [`GetPromptResponse`], [`ReadResourceResponse`]). The SDK only lets an +//! `InputRequiredResult` reach a peer that negotiated protocol version +//! `2026-07-28` or newer; older peers get a protocol error instead. +//! +//! **Client:** the high-level `RunningService` helpers — `call_tool`, +//! `get_prompt`, and `read_resource` — automatically fulfil each +//! [`InputRequest`] through the local `ClientHandler` and retry, up to +//! [`DEFAULT_MRTR_MAX_ROUNDS`]. Use the `*_once` variants (e.g. +//! `call_tool_once`) to receive an [`InputRequiredResult`] directly and drive +//! the rounds yourself. +//! +//! # `requestState` is untrusted +//! +//! The client echoes `requestState` back verbatim, so a stateless server that +//! stores meaningful data in it MUST verify integrity before trusting the echoed +//! value. Enable the `request-state` feature and use `RequestStateCodec` to seal +//! and open it, or keep the state server-side and use `requestState` only as an +//! opaque handle. +//! +//! A complete runnable walkthrough lives in the `servers_mrtr` example. + +use std::collections::BTreeMap; + +use serde::{Deserialize, Serialize}; +use serde_json::Value; + +use super::{ + CallToolResult, CreateMessageRequest, CreateTaskResult, ElicitRequest, GetPromptResult, + ListRootsRequest, MetaObject, ReadResourceResult, ResultType, ServerResult, +}; + +/// Default maximum number of MRTR rounds a high-level client call will drive. +/// +/// This matches the default used by other Tier 1 SDKs and prevents a +/// misbehaving peer from keeping a request alive indefinitely. +pub const DEFAULT_MRTR_MAX_ROUNDS: usize = 10; + +/// A server-initiated request that can appear inside [`InputRequests`]. +/// +/// Per the MCP spec, only `CreateMessageRequest` (sampling), +/// `ElicitRequest` (elicitation), and `ListRootsRequest` (roots) +/// are allowed. This is modeled as an untagged enum rather than a +/// `ServerRequest` alias to prevent `PingRequest` or `CustomRequest` from +/// being included. +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(untagged)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub enum InputRequest { + /// A `sampling/createMessage` request. + CreateMessage(CreateMessageRequest), + /// An `elicitation/create` request. + Elicitation(ElicitRequest), + /// A `roots/list` request. + ListRoots(ListRootsRequest), +} + +// Wire-level equality: two `InputRequest`s are equal if they serialize to the +// same JSON. The wrapped request envelopes do not implement `PartialEq` +// structurally (they carry `Extensions`). +impl PartialEq for InputRequest { + fn eq(&self, other: &Self) -> bool { + match (serde_json::to_value(self), serde_json::to_value(other)) { + (Ok(a), Ok(b)) => a == b, + _ => false, + } + } +} + +/// A map of server-initiated requests that the client must fulfill. +/// +/// Keys are server-assigned string identifiers; values are request objects +/// (`ElicitRequest`, `CreateMessageRequest`, or `ListRootsRequest`). +pub type InputRequests = BTreeMap; + +/// A map of client responses to server-initiated requests. +/// +/// Keys correspond to the keys in the [`InputRequests`] map; values are the +/// client's result for each request (`ElicitResult`, `CreateMessageResult`, +/// or `ListRootsResult`), represented as opaque JSON because the +/// heterogeneous `ClientResult` union does not derive the traits required +/// for use as a `BTreeMap` value. +pub type InputResponses = BTreeMap; + +/// Result of a `tools/call` request, including the MRTR intermediate result. +#[derive(Debug, Clone)] +#[non_exhaustive] +pub enum CallToolResponse { + /// The server completed the tool call. + Complete(CallToolResult), + /// The server requires client-side input before the tool call can complete. + InputRequired(InputRequiredResult), + /// The server materialized a task for this call (SEP-2663 Tasks extension, + /// `resultType: "task"`). The client polls `tasks/get` for the result. + Task(CreateTaskResult), +} + +impl From for CallToolResponse { + fn from(result: CallToolResult) -> Self { + Self::Complete(result) + } +} + +impl From for CallToolResponse { + fn from(result: InputRequiredResult) -> Self { + Self::InputRequired(result) + } +} + +impl From for ServerResult { + fn from(response: CallToolResponse) -> Self { + match response { + CallToolResponse::Complete(result) => ServerResult::CallToolResult(result), + CallToolResponse::InputRequired(result) => ServerResult::InputRequiredResult(result), + CallToolResponse::Task(result) => ServerResult::CreateTaskResult(result), + } + } +} + +impl From for CallToolResponse { + fn from(result: CreateTaskResult) -> Self { + Self::Task(result) + } +} + +/// Result of a `prompts/get` request, including the MRTR intermediate result. +#[derive(Debug, Clone)] +#[non_exhaustive] +pub enum GetPromptResponse { + /// The server completed the prompt request. + Complete(GetPromptResult), + /// The server requires client-side input before the prompt can be returned. + InputRequired(InputRequiredResult), +} + +impl From for GetPromptResponse { + fn from(result: GetPromptResult) -> Self { + Self::Complete(result) + } +} + +impl From for GetPromptResponse { + fn from(result: InputRequiredResult) -> Self { + Self::InputRequired(result) + } +} + +impl From for ServerResult { + fn from(response: GetPromptResponse) -> Self { + match response { + GetPromptResponse::Complete(result) => ServerResult::GetPromptResult(result), + GetPromptResponse::InputRequired(result) => ServerResult::InputRequiredResult(result), + } + } +} + +/// Result of a `resources/read` request, including the MRTR intermediate result. +#[derive(Debug, Clone)] +#[non_exhaustive] +pub enum ReadResourceResponse { + /// The server completed the resource read. + Complete(ReadResourceResult), + /// The server requires client-side input before the resource can be returned. + InputRequired(InputRequiredResult), +} + +impl From for ReadResourceResponse { + fn from(result: ReadResourceResult) -> Self { + Self::Complete(result) + } +} + +impl From for ReadResourceResponse { + fn from(result: InputRequiredResult) -> Self { + Self::InputRequired(result) + } +} + +impl From for ServerResult { + fn from(response: ReadResourceResponse) -> Self { + match response { + ReadResourceResponse::Complete(result) => ServerResult::ReadResourceResult(result), + ReadResourceResponse::InputRequired(result) => { + ServerResult::InputRequiredResult(result) + } + } + } +} + +/// A result indicating that additional input is needed before the request +/// can be completed. +/// +/// At least one of [`input_requests`](Self::input_requests) or +/// [`request_state`](Self::request_state) MUST be present. +/// +/// Servers MAY send this in response to `tools/call`, `prompts/get`, or +/// `resources/read`. Servers MUST NOT send this for any other request. +/// +/// # Examples +/// +/// ``` +/// use rmcp::model::InputRequiredResult; +/// +/// let result = InputRequiredResult::from_request_state("opaque-server-state"); +/// assert!(result.input_requests.is_none()); +/// assert_eq!(result.request_state.as_deref(), Some("opaque-server-state")); +/// ``` +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct InputRequiredResult { + /// Always `"input_required"` for this result type. + pub result_type: ResultType, + + /// Server-initiated requests that the client must fulfill before retrying. + #[serde(skip_serializing_if = "Option::is_none")] + pub input_requests: Option, + + /// Opaque request state to be echoed back by the client on retry. + /// Clients MUST NOT inspect, parse, modify, or make any assumptions + /// about the contents. + #[serde(skip_serializing_if = "Option::is_none")] + pub request_state: Option, + + /// Optional protocol-level metadata. + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, +} + +/// Custom deserializer that requires `resultType: "input_required"` to prevent +/// greedy matching in the untagged `ServerResult` enum (which would otherwise +/// swallow empty objects or unknown shapes). +impl<'de> Deserialize<'de> for InputRequiredResult { + fn deserialize(deserializer: D) -> Result + where + D: serde::Deserializer<'de>, + { + #[derive(Deserialize)] + #[serde(rename_all = "camelCase")] + struct Helper { + result_type: Option, + input_requests: Option, + request_state: Option, + #[serde(rename = "_meta")] + meta: Option, + } + + let helper = Helper::deserialize(deserializer)?; + + match &helper.result_type { + Some(rt) if rt.is_input_required() => {} + _ => { + return Err(serde::de::Error::custom( + "InputRequiredResult requires resultType to be \"input_required\"", + )); + } + } + + if helper.input_requests.is_none() && helper.request_state.is_none() { + return Err(serde::de::Error::custom( + "InputRequiredResult requires at least one of inputRequests or requestState", + )); + } + + Ok(InputRequiredResult { + result_type: ResultType::INPUT_REQUIRED, + input_requests: helper.input_requests, + request_state: helper.request_state, + meta: helper.meta, + }) + } +} + +impl InputRequiredResult { + /// Creates a new `InputRequiredResult` with both input requests and request state. + pub fn new(input_requests: Option, request_state: Option) -> Self { + Self { + result_type: ResultType::INPUT_REQUIRED, + input_requests, + request_state, + meta: None, + } + } + + /// Creates from input requests only. + pub fn from_input_requests(input_requests: InputRequests) -> Self { + Self::new(Some(input_requests), None) + } + + /// Creates from request state only (e.g. for load shedding). + pub fn from_request_state(request_state: impl Into) -> Self { + Self::new(None, Some(request_state.into())) + } + + /// Sets optional metadata. + pub fn with_meta(mut self, meta: MetaObject) -> Self { + self.meta = Some(meta); + self + } +} + +#[cfg(test)] +mod tests { + use super::*; + + mod result_type { + use super::*; + + #[test] + fn default_is_complete() { + assert_eq!(ResultType::default(), ResultType::COMPLETE); + } + + #[test] + fn serializes_complete() { + assert_eq!( + serde_json::to_value(&ResultType::COMPLETE).unwrap(), + serde_json::json!("complete") + ); + } + + #[test] + fn serializes_input_required() { + assert_eq!( + serde_json::to_value(&ResultType::INPUT_REQUIRED).unwrap(), + serde_json::json!("input_required") + ); + } + + #[test] + fn deserializes_known_values() { + let complete: ResultType = + serde_json::from_value(serde_json::json!("complete")).unwrap(); + assert_eq!(complete, ResultType::COMPLETE); + + let input_required: ResultType = + serde_json::from_value(serde_json::json!("input_required")).unwrap(); + assert_eq!(input_required, ResultType::INPUT_REQUIRED); + } + + #[test] + fn preserves_unknown_extension_values() { + let custom: ResultType = + serde_json::from_value(serde_json::json!("streaming")).unwrap(); + assert_eq!(custom.as_str(), "streaming"); + assert!(!custom.is_complete()); + assert!(!custom.is_input_required()); + + let reserialized = serde_json::to_value(&custom).unwrap(); + assert_eq!(reserialized, serde_json::json!("streaming")); + } + } + + mod input_required_result { + use super::*; + + #[test] + fn deserializes_with_requests_and_state() { + let json = serde_json::json!({ + "resultType": "input_required", + "inputRequests": { + "github_login": { + "method": "elicitation/create", + "params": { + "message": "Please provide your GitHub username", + "requestedSchema": { + "type": "object", + "properties": { "name": { "type": "string" } }, + "required": ["name"] + } + } + }, + "capital_of_france": { + "method": "sampling/createMessage", + "params": { + "messages": [{ + "role": "user", + "content": { "type": "text", "text": "What is the capital of France?" } + }], + "maxTokens": 100 + } + } + }, + "requestState": "eyJsb2NhdGlvbiI6Ik5ldyBZb3JrIn0" + }); + + let result: InputRequiredResult = serde_json::from_value(json).unwrap(); + + let requests = result + .input_requests + .as_ref() + .expect("should have input_requests"); + assert_eq!(requests.len(), 2); + assert!(requests.contains_key("github_login")); + assert!(requests.contains_key("capital_of_france")); + assert_eq!( + result.request_state.as_deref(), + Some("eyJsb2NhdGlvbiI6Ik5ldyBZb3JrIn0") + ); + } + + #[test] + fn roundtrip_preserves_all_fields() { + let json = serde_json::json!({ + "resultType": "input_required", + "inputRequests": { + "key": { + "method": "elicitation/create", + "params": { + "message": "test", + "requestedSchema": { "type": "object", "properties": {} } + } + } + }, + "requestState": "abc123" + }); + + let result: InputRequiredResult = serde_json::from_value(json).unwrap(); + let reserialized = serde_json::to_value(&result).unwrap(); + + assert_eq!(reserialized["resultType"], "input_required"); + assert!(reserialized["inputRequests"].is_object()); + assert_eq!(reserialized["requestState"], "abc123"); + } + + #[test] + fn deserializes_with_request_state_only() { + let json = serde_json::json!({ + "resultType": "input_required", + "requestState": "eyJwcm9ncmVzcyI6IjUwJSJ9" + }); + + let result: InputRequiredResult = serde_json::from_value(json).unwrap(); + + assert!(result.input_requests.is_none()); + assert_eq!( + result.request_state.as_deref(), + Some("eyJwcm9ncmVzcyI6IjUwJSJ9") + ); + } + + #[test] + fn rejects_missing_input_requests_and_request_state() { + let json = serde_json::json!({ + "resultType": "input_required", + "_meta": {} + }); + let err = serde_json::from_value::(json).unwrap_err(); + assert!( + err.to_string().contains("inputRequests or requestState"), + "error should mention the required continuation fields, got: {err}" + ); + } + + #[test] + fn rejects_missing_result_type() { + let json = serde_json::json!({ + "requestState": "some-state" + }); + let err = serde_json::from_value::(json).unwrap_err(); + assert!( + err.to_string().contains("input_required"), + "error should mention the required resultType, got: {err}" + ); + } + + #[test] + fn rejects_wrong_result_type() { + let json = serde_json::json!({ + "resultType": "complete", + "requestState": "some-state" + }); + let err = serde_json::from_value::(json).unwrap_err(); + assert!( + err.to_string().contains("input_required"), + "error should mention the required resultType, got: {err}" + ); + } + } + + mod input_responses { + use super::*; + + #[test] + fn deserializes_heterogeneous_results() { + let json = serde_json::json!({ + "github_login": { + "action": "accept", + "content": { "name": "octocat" } + }, + "capital_of_france": { + "role": "assistant", + "content": { "type": "text", "text": "Paris." }, + "model": "claude-3-sonnet-20240307", + "stopReason": "endTurn" + } + }); + + let responses: InputResponses = serde_json::from_value(json).unwrap(); + + assert_eq!(responses.len(), 2); + assert!(responses.contains_key("github_login")); + assert!(responses.contains_key("capital_of_france")); + } + } + + mod constructors { + use super::*; + + #[test] + fn from_request_state_sets_state_only() { + let result = InputRequiredResult::from_request_state("opaque"); + + assert_eq!(result.result_type, ResultType::INPUT_REQUIRED); + assert!(result.input_requests.is_none()); + assert_eq!(result.request_state.as_deref(), Some("opaque")); + } + + #[test] + fn from_input_requests_sets_requests_only() { + let mut requests = InputRequests::new(); + requests.insert( + "key".to_string(), + serde_json::from_value(serde_json::json!({ + "method": "elicitation/create", + "params": { + "message": "test", + "requestedSchema": { "type": "object", "properties": {} } + } + })) + .unwrap(), + ); + + let result = InputRequiredResult::from_input_requests(requests); + + assert!(result.input_requests.is_some()); + assert!(result.request_state.is_none()); + } + } +} diff --git a/vendor/rmcp/src/model/prompt.rs b/vendor/rmcp/src/model/prompt.rs new file mode 100644 index 00000000..46f5168e --- /dev/null +++ b/vendor/rmcp/src/model/prompt.rs @@ -0,0 +1,367 @@ +use serde::{Deserialize, Serialize}; + +use super::{ + Annotations, ContentBlock, Icon, MetaObject, Role, + content::{AudioContent, EmbeddedResource, ImageContent, TextContent}, + resource::ResourceContents, +}; + +/// A prompt or prompt template that the server offers (spec `Prompt`). +#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct Prompt { + pub name: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub arguments: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub icons: Option>, + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, +} + +impl Prompt { + pub fn new( + name: N, + description: Option, + arguments: Option>, + ) -> Self + where + N: Into, + D: Into, + { + Prompt { + name: name.into(), + title: None, + description: description.map(Into::into), + arguments, + icons: None, + meta: None, + } + } + + pub fn from_raw( + name: impl Into, + description: Option>, + arguments: Option>, + ) -> Self { + Prompt { + name: name.into(), + title: None, + description: description.map(Into::into), + arguments, + icons: None, + meta: None, + } + } + + pub fn with_title(mut self, title: impl Into) -> Self { + self.title = Some(title.into()); + self + } + + pub fn with_icons(mut self, icons: Vec) -> Self { + self.icons = Some(icons); + self + } + + pub fn with_meta(mut self, meta: MetaObject) -> Self { + self.meta = Some(meta); + self + } +} + +/// Describes an argument that a prompt can accept (spec `PromptArgument`). +#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct PromptArgument { + pub name: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub required: Option, +} + +impl PromptArgument { + pub fn new>(name: N) -> Self { + PromptArgument { + name: name.into(), + title: None, + description: None, + required: None, + } + } + + pub fn with_title>(mut self, title: T) -> Self { + self.title = Some(title.into()); + self + } + + pub fn with_description>(mut self, description: D) -> Self { + self.description = Some(description.into()); + self + } + + pub fn with_required(mut self, required: bool) -> Self { + self.required = Some(required); + self + } +} + +/// A message returned as part of a prompt (spec `PromptMessage`). +/// +/// Uses the unified `ContentBlock` for its content (text | image | audio | resource_link | resource). +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct PromptMessage { + pub role: Role, + pub content: ContentBlock, +} + +impl PromptMessage { + pub fn new(role: Role, content: ContentBlock) -> Self { + Self { role, content } + } + + pub fn new_text>(role: Role, text: S) -> Self { + Self { + role, + content: ContentBlock::text(text), + } + } + + #[cfg(feature = "base64")] + pub fn new_image( + role: Role, + data: &[u8], + mime_type: &str, + meta: Option, + annotations: Option, + ) -> Self { + use base64::{Engine, prelude::BASE64_STANDARD}; + + let base64 = BASE64_STANDARD.encode(data); + Self { + role, + content: ContentBlock::Image(ImageContent { + data: base64, + mime_type: mime_type.into(), + meta, + annotations, + }), + } + } + + #[cfg(feature = "base64")] + pub fn new_audio( + role: Role, + data: &[u8], + mime_type: &str, + meta: Option, + annotations: Option, + ) -> Self { + use base64::{Engine, prelude::BASE64_STANDARD}; + + let base64 = BASE64_STANDARD.encode(data); + Self { + role, + content: ContentBlock::Audio(AudioContent { + data: base64, + mime_type: mime_type.into(), + meta, + annotations, + }), + } + } + + pub fn new_resource( + role: Role, + uri: String, + mime_type: Option, + text: Option, + resource_meta: Option, + resource_content_meta: Option, + annotations: Option, + ) -> Self { + let resource_contents = match text { + Some(t) => ResourceContents::TextResourceContents { + uri, + mime_type, + text: t, + meta: resource_content_meta, + }, + None => ResourceContents::BlobResourceContents { + uri, + mime_type, + blob: String::new(), + meta: resource_content_meta, + }, + }; + Self { + role, + content: ContentBlock::Resource(EmbeddedResource { + meta: resource_meta, + resource: resource_contents, + annotations, + }), + } + } + + pub fn new_text_with_meta>( + role: Role, + text: S, + meta: Option, + ) -> Self { + Self { + role, + content: ContentBlock::Text(TextContent { + text: text.into(), + meta, + annotations: None, + }), + } + } + + pub fn new_resource_link(role: Role, resource: super::resource::Resource) -> Self { + Self { + role, + content: ContentBlock::ResourceLink(resource), + } + } +} + +#[cfg(test)] +mod tests { + use serde_json; + + use super::*; + + #[test] + fn test_prompt_message_image_serialization() { + let image = ImageContent::new("base64data", "image/png"); + let json = serde_json::to_string(&image).unwrap(); + assert!(json.contains("mimeType")); + assert!(!json.contains("mime_type")); + } + + #[test] + fn test_prompt_message_audio_serialization_and_deserialization() { + let content = ContentBlock::Audio(AudioContent::new("YXVkaW8=", "audio/wav")); + let value = serde_json::to_value(&content).unwrap(); + assert_eq!(value.get("type").and_then(|v| v.as_str()), Some("audio")); + assert_eq!(value.get("data").and_then(|v| v.as_str()), Some("YXVkaW8=")); + assert_eq!( + value.get("mimeType").and_then(|v| v.as_str()), + Some("audio/wav"), + "expected camelCase mimeType, got: {value:#?}" + ); + + let json = r#"{"type":"audio","data":"YXVkaW8=","mimeType":"audio/wav"}"#; + let parsed: ContentBlock = serde_json::from_str(json).unwrap(); + assert_eq!(parsed, content); + } + + #[test] + #[cfg(feature = "base64")] + fn test_prompt_message_new_audio_constructor() { + let message = PromptMessage::new_audio(Role::User, b"hello", "audio/wav", None, None); + let value = serde_json::to_value(&message).unwrap(); + let content = value.get("content").expect("content present"); + assert_eq!(content.get("type").and_then(|v| v.as_str()), Some("audio")); + assert_eq!( + content.get("mimeType").and_then(|v| v.as_str()), + Some("audio/wav") + ); + assert_eq!( + content.get("data").and_then(|v| v.as_str()), + Some("aGVsbG8=") + ); + } + + #[test] + fn test_prompt_message_resource_link_serialization() { + use super::super::resource::Resource; + + let resource = Resource::new("file:///test.txt", "test.txt"); + let message = PromptMessage::new_resource_link(Role::User, resource); + + let json = serde_json::to_string(&message).unwrap(); + assert!(json.contains("\"type\":\"resource_link\"")); + assert!(json.contains("\"uri\":\"file:///test.txt\"")); + assert!(json.contains("\"name\":\"test.txt\"")); + } + + #[test] + fn test_prompt_message_resource_serialization_is_flat() { + let message = PromptMessage::new_resource( + Role::User, + "alc://packages/sc/narrative".to_string(), + Some("text/markdown".to_string()), + Some("# Hello".to_string()), + None, + None, + None, + ); + + let value: serde_json::Value = serde_json::to_value(&message).unwrap(); + let content = value.get("content").expect("content present"); + assert_eq!( + content.get("type").and_then(|v| v.as_str()), + Some("resource") + ); + + let resource = content + .get("resource") + .expect("resource field present at content level"); + + assert_eq!( + resource.get("uri").and_then(|v| v.as_str()), + Some("alc://packages/sc/narrative"), + "expected flat resource.uri, got: {resource:#?}" + ); + assert_eq!( + resource.get("mimeType").and_then(|v| v.as_str()), + Some("text/markdown") + ); + assert_eq!( + resource.get("text").and_then(|v| v.as_str()), + Some("# Hello") + ); + + assert!( + resource.get("resource").is_none(), + "double-nested resource detected (regression): {resource:#?}" + ); + } + + #[test] + fn test_prompt_message_content_resource_link_deserialization() { + let json = r#"{ + "type": "resource_link", + "uri": "file:///example.txt", + "name": "example.txt", + "description": "Example file", + "mimeType": "text/plain" + }"#; + + let content: ContentBlock = serde_json::from_str(json).unwrap(); + + if let ContentBlock::ResourceLink(resource) = content { + assert_eq!(resource.uri, "file:///example.txt"); + assert_eq!(resource.name, "example.txt"); + assert_eq!(resource.description, Some("Example file".to_string())); + assert_eq!(resource.mime_type, Some("text/plain".to_string())); + } else { + panic!("Expected ResourceLink variant"); + } + } +} diff --git a/vendor/rmcp/src/model/request_state.rs b/vendor/rmcp/src/model/request_state.rs new file mode 100644 index 00000000..9f45572c --- /dev/null +++ b/vendor/rmcp/src/model/request_state.rs @@ -0,0 +1,1494 @@ +//! Integrity protection for SEP-2322 `requestState`. +//! +//! In the multi round-trip request (MRTR) flow, a server places an opaque +//! `requestState` string in an [`InputRequiredResult`](super::InputRequiredResult) +//! and the client echoes it back verbatim on retry. From the server's point of +//! view the echoed value is **untrusted, attacker-controlled input**: a client +//! can send back anything it likes. Per SEP-2322, a server that lets +//! `requestState` influence authorization, resource access, or business logic +//! MUST protect its integrity and reject values that fail verification. +//! +//! [`RequestStateCodec`] provides an opt-in way to do this. It seals a payload +//! into an opaque string with an HMAC-SHA256 tag and opens it again, rejecting +//! any value that was forged or tampered with. +//! +//! To follow the spec's replay-prevention guidance without hand-rolling the +//! checks, the codec supports two bindings via [`SealOptions`]: +//! +//! * **Associated data** — arbitrary context (e.g. the authenticated principal +//! plus a digest of the originating request) that is mixed into the tag but +//! not stored in the token. [`open_with`](RequestStateCodec::open_with) only +//! succeeds when the caller supplies the same context, so a value cannot be +//! replayed by a different principal or against a different request. This is +//! *fail-closed*: forgetting to pass the context makes verification fail. +//! * **TTL** — a relative expiry stamped into the token; opening a value past +//! its expiry fails with [`RequestStateError::Expired`]. +//! +//! Single-use/nonce enforcement (for one-time redemptions) still has to be done +//! server-side, as the spec notes. +//! +//! This helper is only about *integrity*, not *confidentiality*: the sealed +//! payload is signed, not encrypted, so it is base64url-readable by anyone. Do +//! not put secrets in it. +//! +//! Using the codec is entirely optional. A server that keeps its state +//! server-side, or that does not trust `requestState` for anything security +//! sensitive, can keep building the string by hand via +//! [`InputRequiredResult::from_request_state`](super::InputRequiredResult::from_request_state). +//! +//! # Examples +//! +//! ``` +//! use rmcp::model::{RequestStateCodec, SealOptions}; +//! # fn main() -> Result<(), rmcp::model::RequestStateError> { +//! +//! // Derive the key from a per-process secret; keep it out of client reach. +//! let codec = RequestStateCodec::try_new(b"a-32-byte-or-longer-secret-key!!!")?; +//! +//! // Bind the state to the caller and the originating request. +//! let context = b"user:alice|tools/call:weather"; +//! let sealed = codec.seal_with( +//! b"step=2", +//! &SealOptions::new().associated_data(context), +//! ); +//! +//! // On retry the client echoes `sealed` back untouched; the server re-derives +//! // the same context and opens it. +//! let opened = codec.open_with(&sealed, context)?; +//! assert_eq!(opened, b"step=2"); +//! +//! // A different principal (different context) is rejected. +//! assert!(codec.open_with(&sealed, b"user:bob|tools/call:weather").is_err()); +//! # Ok(()) +//! # } +//! ``` + +use std::{ + collections::{HashMap, hash_map::Entry}, + time::Duration, +}; + +use base64::{Engine, engine::general_purpose::URL_SAFE_NO_PAD}; +use hmac::{Hmac, KeyInit, Mac}; +use serde::{Serialize, de::DeserializeOwned}; +use sha2::Sha256; +use thiserror::Error; +use zeroize::Zeroizing; + +type HmacSha256 = Hmac; + +const VERSION_V1: &str = "rs1"; + +const VERSION_V2: &str = "rs2"; + +/// Domain-separation label mixed into the HMAC so a `requestState` tag can never +/// be confused with an HMAC computed for some other purpose using the same key. +const DOMAIN_V1: &[u8] = b"rmcp/mrtr/request-state/v1"; + +/// Domain-separation label for keyed request-state tags. +const DOMAIN_V2: &[u8] = b"rmcp/mrtr/request-state/v2"; + +/// Length of the big-endian expiry prefix (unix milliseconds) stored at the +/// front of every sealed body. `0` means "no expiry". +const EXPIRY_LEN: usize = 8; + +const MAX_KID_LEN: usize = 255; + +/// Maximum unpadded base64url length for [`MAX_KID_LEN`] bytes. +const MAX_ENCODED_KID_LEN: usize = 340; + +/// Errors returned when constructing or configuring a +/// [`RequestStateCodec`], or when processing a sealed value. +#[derive(Debug, Error)] +#[non_exhaustive] +pub enum RequestStateError { + /// The signing key is shorter than [`RequestStateCodec::MIN_KEY_LENGTH`]. + #[error( + "request state signing key is too short: expected at least {minimum} bytes, got {actual}" + )] + KeyTooShort { minimum: usize, actual: usize }, + + /// The value is not a well-formed sealed request state (wrong prefix or + /// missing sections). + #[error("request state is malformed or uses an unsupported format")] + MalformedFormat, + + /// A section of the value was not valid base64url. + #[error("request state is not valid base64url")] + InvalidEncoding, + + /// The HMAC tag did not match; the value was forged, tampered with, or + /// opened with the wrong associated data. + #[error("request state failed integrity verification")] + IntegrityCheckFailed, + + /// The value carried a TTL that has already elapsed. + #[error("request state has expired")] + Expired, + + /// The token names (or, for rs1, requires) a key this codec does not hold. + #[error("request state was sealed with an unknown key")] + UnknownKeyId, + + /// The decoded rs2 key id was empty, too long, or not valid UTF-8. + #[error("request state contains an invalid key identifier")] + InvalidKeyId, + + /// An invalid keyring configuration; the message is diagnostic only. + #[error("invalid keyring configuration: {0}")] + InvalidKeyring(&'static str), + + /// The sealed payload could not be serialized to JSON. + #[error("failed to serialize request state payload: {0}")] + Serialization(#[source] serde_json::Error), + + /// The opened payload could not be deserialized from JSON. + #[error("failed to deserialize request state payload: {0}")] + Deserialization(#[source] serde_json::Error), +} + +/// Options controlling how a value is sealed by [`RequestStateCodec`]. +/// +/// Defaults to no associated data and no expiry, which is equivalent to the +/// bare [`seal`](RequestStateCodec::seal) / [`open`](RequestStateCodec::open) +/// methods. +#[derive(Clone, Copy, Debug, Default)] +pub struct SealOptions<'a> { + associated_data: &'a [u8], + ttl: Option, +} + +impl<'a> SealOptions<'a> { + /// Creates empty options (no associated data, no expiry). + pub fn new() -> Self { + Self::default() + } + + /// Binds the sealed value to `associated_data`. The same bytes must be + /// supplied to [`open_with`](RequestStateCodec::open_with); the data is + /// authenticated but not stored in the token. + /// + /// Use this to bind the state to the authenticated principal and/or the + /// originating request (e.g. method name plus a digest of its parameters). + pub fn associated_data(mut self, associated_data: &'a [u8]) -> Self { + self.associated_data = associated_data; + self + } + + /// Sets a relative time-to-live after which opening the value fails with + /// [`RequestStateError::Expired`]. + pub fn ttl(mut self, ttl: Duration) -> Self { + self.ttl = Some(ttl); + self + } +} + +/// A keyed codec for integrity-protected SEP-2322 `requestState` values. +/// +/// [`new`](Self::new) preserves `rs1`; [`new_with_keyring`](Self::new_with_keyring) +/// emits `rs2`. +/// Use [`with_rs1_signing`](Self::with_rs1_signing) and +/// [`with_rs1_fallback`](Self::with_rs1_fallback) for rolling migrations. +/// +/// Use [`try_new`](Self::try_new) and +/// [`new_with_keyring`](Self::new_with_keyring) to require at least +/// [`MIN_KEY_LENGTH`](Self::MIN_KEY_LENGTH) bytes of high-entropy key material. +/// Configure the same keys on every replica. Stored key material is zeroized +/// when the codec is dropped. +/// +/// Values are authenticated, not encrypted; key ids and payloads remain +/// readable. Retain old keys until every value they signed has expired. +/// +/// # Key rotation +/// +/// Rotate in stages so every replica can open states emitted by its peers: +/// +/// ``` +/// # use rmcp::model::{RequestStateCodec, RequestStateError}; +/// # fn main() -> Result<(), RequestStateError> { +/// let old_key = b"old-request-state-key-at-least-32b".as_slice(); +/// let new_key = b"new-request-state-key-at-least-32b".as_slice(); +/// let keys = [("old", old_key), ("new", new_key)]; +/// +/// // 1. Deploy both keys, but continue emitting rs1 with the old key. +/// let transitional = RequestStateCodec::new_with_keyring("new", keys)? +/// .with_rs1_signing("old")?; +/// +/// // 2. Emit rs2 with the new key, while accepting in-flight rs1 values. +/// let promoted = RequestStateCodec::new_with_keyring("new", keys)? +/// .with_rs1_fallback("old")?; +/// +/// let old_state = transitional.seal(b"old state"); +/// assert_eq!(promoted.open(&old_state)?, b"old state"); +/// let new_state = promoted.seal(b"new state"); +/// assert_eq!(transitional.open(&new_state)?, b"new state"); +/// +/// // 3. After old values expire, remove the old key. +/// let retired = RequestStateCodec::new_with_keyring("new", [("new", new_key)])?; +/// assert_eq!(retired.open(&new_state)?, b"new state"); +/// # Ok(()) +/// # } +/// ``` +#[derive(Clone)] +pub struct RequestStateCodec { + keys: Keys, +} + +#[derive(Clone)] +enum Keys { + Single(Zeroizing>), + Ring { + keys: HashMap>>, + seal_mode: SealMode, + rs1_fallbacks: Vec, + }, +} + +#[derive(Clone, Debug)] +enum SealMode { + Rs1 { key_id: String }, + Rs2 { key_id: String }, +} + +impl std::fmt::Debug for RequestStateCodec { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + // Never leak signing or verification keys through Debug output. + match &self.keys { + Keys::Single(_) => f + .debug_struct("RequestStateCodec") + .field("mode", &"single") + .field("key", &"") + .finish(), + Keys::Ring { + keys, + seal_mode, + rs1_fallbacks, + } => f + .debug_struct("RequestStateCodec") + .field("mode", &"ring") + .field("key_count", &keys.len()) + .field("keys", &"") + .field("seal_mode", seal_mode) + .field("rs1_fallbacks", rs1_fallbacks) + .finish(), + } + } +} + +impl RequestStateCodec { + /// Minimum accepted signing-key length in bytes. + pub const MIN_KEY_LENGTH: usize = 32; + + /// Creates a legacy single-key codec that seals and opens `rs1` values + /// without validating the signing-key length. + #[deprecated( + since = "3.1.4", + note = "use RequestStateCodec::try_new to enforce the minimum signing-key length" + )] + pub fn new(key: impl Into>) -> Self { + Self::new_unchecked(key) + } + + /// Creates a codec without validating the signing-key length. + /// + /// Prefer [`try_new`](Self::try_new) unless the key length has already been + /// validated. + pub fn new_unchecked(key: impl Into>) -> Self { + Self { + keys: Keys::Single(Zeroizing::new(key.into())), + } + } + + /// Creates a legacy single-key codec after validating its signing-key length. + /// + /// # Errors + /// + /// Returns [`RequestStateError::KeyTooShort`] when `key` contains fewer + /// than [`MIN_KEY_LENGTH`](Self::MIN_KEY_LENGTH) bytes. + pub fn try_new(key: impl Into>) -> Result { + let key = Zeroizing::new(key.into()); + Self::validate_key_length(&key)?; + Ok(Self { + keys: Keys::Single(key), + }) + } + + /// Creates a keyring codec that seals `rs2` with `active_kid`. + /// + /// All configured keys can open matching `rs2` values. Legacy `rs1` values + /// require [`with_rs1_fallback`](Self::with_rs1_fallback) or + /// [`with_rs1_signing`](Self::with_rs1_signing). + /// Key ids are case-sensitive UTF-8 strings of 1 to 255 bytes. + /// + /// # Errors + /// + /// Returns [`RequestStateError::KeyTooShort`] if a configured key contains + /// fewer than [`MIN_KEY_LENGTH`](Self::MIN_KEY_LENGTH) bytes. Returns + /// [`RequestStateError::InvalidKeyring`] if the keyring is empty, contains + /// duplicate or invalid key ids, or does not contain `active_kid`. + pub fn new_with_keyring( + active_kid: impl Into, + keys: impl IntoIterator, + ) -> Result + where + K: Into, + V: Into>, + { + let mut ring = HashMap::new(); + for (kid, key) in keys { + let kid = kid.into(); + let key = Zeroizing::new(key.into()); + Self::validate_config_kid(&kid)?; + Self::validate_key_length(&key)?; + match ring.entry(kid) { + Entry::Vacant(entry) => { + entry.insert(key); + } + Entry::Occupied(_) => { + return Err(RequestStateError::InvalidKeyring("duplicate key id")); + } + } + } + + if ring.is_empty() { + return Err(RequestStateError::InvalidKeyring( + "keyring must contain at least one key", + )); + } + + let active_kid = active_kid.into(); + Self::validate_config_kid(&active_kid)?; + if !ring.contains_key(&active_kid) { + return Err(RequestStateError::InvalidKeyring( + "active key id is not present in the keyring", + )); + } + + Ok(Self { + keys: Keys::Ring { + keys: ring, + seal_mode: SealMode::Rs2 { key_id: active_kid }, + rs1_fallbacks: Vec::new(), + }, + }) + } + + /// Uses `kid` to sign legacy `rs1` values during a rolling migration. + /// The codec accepts its own `rs1` output and configured `rs2` values. + /// + /// # Errors + /// + /// Returns [`RequestStateError::InvalidKeyring`] when called on a single-key + /// codec, or if the keyring does not contain `kid`. + pub fn with_rs1_signing(mut self, kid: impl AsRef) -> Result { + let kid = kid.as_ref(); + match &mut self.keys { + Keys::Single(_) => Err(RequestStateError::InvalidKeyring( + "rs1 transitional signing requires a keyring", + )), + Keys::Ring { + keys, + seal_mode, + rs1_fallbacks, + } => { + if !keys.contains_key(kid) { + return Err(RequestStateError::InvalidKeyring( + "rs1 signing key id is not present in the keyring", + )); + } + + let kid = kid.to_owned(); + *seal_mode = SealMode::Rs1 { + key_id: kid.clone(), + }; + if !rs1_fallbacks.iter().any(|existing| existing == &kid) { + rs1_fallbacks.push(kid); + } + Ok(self) + } + } + } + + /// Accepts legacy `rs1` values signed with `kid`. + /// Adding the same id more than once has no effect; remove fallbacks after + /// old values have drained. + /// + /// # Errors + /// + /// Returns [`RequestStateError::InvalidKeyring`] when called on a single-key + /// codec, or if the keyring does not contain `kid`. + pub fn with_rs1_fallback(mut self, kid: impl AsRef) -> Result { + let kid = kid.as_ref(); + match &mut self.keys { + Keys::Single(_) => Err(RequestStateError::InvalidKeyring( + "rs1 fallbacks require a keyring", + )), + Keys::Ring { + keys, + rs1_fallbacks, + .. + } => { + if !keys.contains_key(kid) { + return Err(RequestStateError::InvalidKeyring( + "rs1 fallback key id is not present in the keyring", + )); + } + if !rs1_fallbacks.iter().any(|existing| existing == kid) { + rs1_fallbacks.push(kid.to_owned()); + } + Ok(self) + } + } + } + + /// Seals raw bytes into an opaque, integrity-protected string suitable for + /// use as `requestState`. + pub fn seal(&self, payload: &[u8]) -> String { + self.seal_with(payload, &SealOptions::default()) + } + + /// Seals raw bytes with [`SealOptions`] (associated data and/or TTL). + pub fn seal_with(&self, payload: &[u8], options: &SealOptions<'_>) -> String { + self.seal_at(payload, options, Self::now_ms()) + } + + /// Seals a serializable value by encoding it as JSON before sealing. + /// + /// # Errors + /// + /// Returns [`RequestStateError::Serialization`] if `value` cannot be encoded + /// as JSON. + pub fn seal_json(&self, value: &T) -> Result { + self.seal_json_with(value, &SealOptions::default()) + } + + /// Seals a serializable value with [`SealOptions`]. + /// + /// # Errors + /// + /// Returns [`RequestStateError::Serialization`] if `value` cannot be encoded + /// as JSON. + pub fn seal_json_with( + &self, + value: &T, + options: &SealOptions<'_>, + ) -> Result { + let payload = serde_json::to_vec(value).map_err(RequestStateError::Serialization)?; + Ok(self.seal_with(&payload, options)) + } + + /// Opens a sealed value that was sealed without associated data, verifying + /// its integrity and expiry and returning the original bytes. + /// + /// # Errors + /// + /// See [`open_with`](Self::open_with). + pub fn open(&self, sealed: &str) -> Result, RequestStateError> { + self.open_with(sealed, &[]) + } + + /// Opens a sealed value, verifying its integrity against `associated_data` + /// and checking its expiry. + /// + /// `associated_data` must match the bytes passed to + /// [`SealOptions::associated_data`] when the value was sealed (use `&[]` for + /// values sealed without it). + /// + /// # Errors + /// + /// Returns a [`RequestStateError`] if the value is malformed, cannot be + /// verified, names an unavailable key, or has expired. + /// + /// Applications MUST map all token-opening failures to a single + /// client-facing error and reserve the detailed variants for internal + /// diagnostics. + pub fn open_with( + &self, + sealed: &str, + associated_data: &[u8], + ) -> Result, RequestStateError> { + self.open_at(sealed, associated_data, Self::now_ms()) + } + + /// Opens a sealed value (no associated data) and deserializes its JSON + /// payload. + /// + /// # Errors + /// + /// See [`open_json_with`](Self::open_json_with). + pub fn open_json(&self, sealed: &str) -> Result { + self.open_json_with(sealed, &[]) + } + + /// Opens a sealed value against `associated_data` and deserializes its JSON + /// payload. + /// + /// # Errors + /// + /// Returns the same integrity, expiry, and format errors as + /// [`open_with`](Self::open_with), plus [`RequestStateError::Deserialization`] + /// if the payload is not valid JSON for `T`. + pub fn open_json_with( + &self, + sealed: &str, + associated_data: &[u8], + ) -> Result { + let payload = self.open_with(sealed, associated_data)?; + serde_json::from_slice(&payload).map_err(RequestStateError::Deserialization) + } + + fn seal_at(&self, payload: &[u8], options: &SealOptions<'_>, now_ms: i64) -> String { + let expiry = match options.ttl { + Some(ttl) => now_ms.saturating_add(ttl.as_millis().min(i64::MAX as u128) as i64), + None => 0, + }; + + // body = big-endian expiry (0 = none) followed by the caller payload. + let mut body = Vec::with_capacity(EXPIRY_LEN + payload.len()); + body.extend_from_slice(&expiry.to_be_bytes()); + body.extend_from_slice(payload); + + match &self.keys { + Keys::Single(key) => Self::seal_rs1(key, options.associated_data, &body), + Keys::Ring { + keys, seal_mode, .. + } => match seal_mode { + SealMode::Rs1 { key_id } => Self::seal_rs1( + keys.get(key_id).expect("validated rs1 signing key"), + options.associated_data, + &body, + ), + SealMode::Rs2 { key_id } => Self::seal_rs2( + key_id, + keys.get(key_id).expect("validated rs2 signing key"), + options.associated_data, + &body, + ), + }, + } + } + + fn open_at( + &self, + sealed: &str, + associated_data: &[u8], + now_ms: i64, + ) -> Result, RequestStateError> { + match sealed.split('.').next() { + Some(VERSION_V1) => self.open_rs1_at(sealed, associated_data, now_ms), + Some(VERSION_V2) => self.open_rs2_at(sealed, associated_data, now_ms), + _ => Err(RequestStateError::MalformedFormat), + } + } + + fn seal_rs1(key: &[u8], associated_data: &[u8], body: &[u8]) -> String { + let tag = Self::mac_v1(key, associated_data, body) + .finalize() + .into_bytes(); + let mut out = String::with_capacity( + VERSION_V1.len() + 2 + Self::b64_len(body.len()) + Self::b64_len(tag.len()), + ); + out.push_str(VERSION_V1); + out.push('.'); + URL_SAFE_NO_PAD.encode_string(body, &mut out); + out.push('.'); + URL_SAFE_NO_PAD.encode_string(tag.as_slice(), &mut out); + out + } + + fn seal_rs2(kid: &str, key: &[u8], associated_data: &[u8], body: &[u8]) -> String { + let tag = Self::mac_v2(key, kid.as_bytes(), associated_data, body) + .finalize() + .into_bytes(); + let mut out = String::with_capacity( + VERSION_V2.len() + + 3 + + Self::b64_len(kid.len()) + + Self::b64_len(body.len()) + + Self::b64_len(tag.len()), + ); + out.push_str(VERSION_V2); + out.push('.'); + URL_SAFE_NO_PAD.encode_string(kid.as_bytes(), &mut out); + out.push('.'); + URL_SAFE_NO_PAD.encode_string(body, &mut out); + out.push('.'); + URL_SAFE_NO_PAD.encode_string(tag.as_slice(), &mut out); + out + } + + fn open_rs1_at( + &self, + sealed: &str, + associated_data: &[u8], + now_ms: i64, + ) -> Result, RequestStateError> { + let mut parts = sealed.split('.'); + let version = parts.next().ok_or(RequestStateError::MalformedFormat)?; + let body_b64 = parts.next().ok_or(RequestStateError::MalformedFormat)?; + let tag_b64 = parts.next().ok_or(RequestStateError::MalformedFormat)?; + if parts.next().is_some() || version != VERSION_V1 { + return Err(RequestStateError::MalformedFormat); + } + + if matches!( + &self.keys, + Keys::Ring { rs1_fallbacks, .. } if rs1_fallbacks.is_empty() + ) { + return Err(RequestStateError::UnknownKeyId); + } + + let body = URL_SAFE_NO_PAD + .decode(body_b64) + .map_err(|_| RequestStateError::InvalidEncoding)?; + let tag = URL_SAFE_NO_PAD + .decode(tag_b64) + .map_err(|_| RequestStateError::InvalidEncoding)?; + + // Authentication must not short-circuit based on tag bytes. + match &self.keys { + Keys::Single(key) => Self::mac_v1(key, associated_data, &body) + .verify_slice(&tag) + .map_err(|_| RequestStateError::IntegrityCheckFailed)?, + Keys::Ring { + keys, + rs1_fallbacks, + .. + } => { + // Try every fallback so timing does not identify the matching key. + let mut verified = false; + for kid in rs1_fallbacks { + let key = keys.get(kid).expect("validated rs1 fallback key"); + let matches = Self::mac_v1(key, associated_data, &body) + .verify_slice(&tag) + .is_ok(); + verified |= matches; + } + if !verified { + return Err(RequestStateError::IntegrityCheckFailed); + } + } + } + + Self::open_authenticated_body(body, now_ms) + } + + fn open_rs2_at( + &self, + sealed: &str, + associated_data: &[u8], + now_ms: i64, + ) -> Result, RequestStateError> { + let mut parts = sealed.split('.'); + let version = parts.next().ok_or(RequestStateError::MalformedFormat)?; + let kid_b64 = parts.next().ok_or(RequestStateError::MalformedFormat)?; + let body_b64 = parts.next().ok_or(RequestStateError::MalformedFormat)?; + let tag_b64 = parts.next().ok_or(RequestStateError::MalformedFormat)?; + if parts.next().is_some() || version != VERSION_V2 { + return Err(RequestStateError::MalformedFormat); + } + + if kid_b64.len() > MAX_ENCODED_KID_LEN { + return Err(RequestStateError::InvalidKeyId); + } + let kid = URL_SAFE_NO_PAD + .decode(kid_b64) + .map_err(|_| RequestStateError::InvalidEncoding)?; + if kid.is_empty() || kid.len() > MAX_KID_LEN { + return Err(RequestStateError::InvalidKeyId); + } + let kid = String::from_utf8(kid).map_err(|_| RequestStateError::InvalidKeyId)?; + + let key = match &self.keys { + Keys::Single(_) => return Err(RequestStateError::UnknownKeyId), + Keys::Ring { keys, .. } => keys.get(&kid).ok_or(RequestStateError::UnknownKeyId)?, + }; + + let body = URL_SAFE_NO_PAD + .decode(body_b64) + .map_err(|_| RequestStateError::InvalidEncoding)?; + let tag = URL_SAFE_NO_PAD + .decode(tag_b64) + .map_err(|_| RequestStateError::InvalidEncoding)?; + + // Authentication must not short-circuit based on tag bytes. + Self::mac_v2(key, kid.as_bytes(), associated_data, &body) + .verify_slice(&tag) + .map_err(|_| RequestStateError::IntegrityCheckFailed)?; + + Self::open_authenticated_body(body, now_ms) + } + + fn open_authenticated_body(body: Vec, now_ms: i64) -> Result, RequestStateError> { + // The body is now authenticated, so its framing can be trusted. + if body.len() < EXPIRY_LEN { + return Err(RequestStateError::MalformedFormat); + } + let expiry = i64::from_be_bytes(body[..EXPIRY_LEN].try_into().expect("checked length")); + if expiry != 0 && now_ms > expiry { + return Err(RequestStateError::Expired); + } + + Ok(body[EXPIRY_LEN..].to_vec()) + } + + fn mac_v1(key: &[u8], associated_data: &[u8], body: &[u8]) -> HmacSha256 { + let mut mac = HmacSha256::new_from_slice(key).expect("HMAC accepts keys of any length"); + mac.update(DOMAIN_V1); + mac.update(&(associated_data.len() as u64).to_be_bytes()); + mac.update(associated_data); + mac.update(body); + mac + } + + fn mac_v2(key: &[u8], kid: &[u8], associated_data: &[u8], body: &[u8]) -> HmacSha256 { + let mut mac = HmacSha256::new_from_slice(key).expect("HMAC accepts keys of any length"); + mac.update(DOMAIN_V2); + mac.update(&(kid.len() as u64).to_be_bytes()); + mac.update(kid); + mac.update(&(associated_data.len() as u64).to_be_bytes()); + mac.update(associated_data); + mac.update(body); + mac + } + + fn validate_key_length(key: &[u8]) -> Result<(), RequestStateError> { + if key.len() < Self::MIN_KEY_LENGTH { + return Err(RequestStateError::KeyTooShort { + minimum: Self::MIN_KEY_LENGTH, + actual: key.len(), + }); + } + Ok(()) + } + + fn validate_config_kid(kid: &str) -> Result<(), RequestStateError> { + if kid.is_empty() { + return Err(RequestStateError::InvalidKeyring( + "key id must not be empty", + )); + } + if kid.len() > MAX_KID_LEN { + return Err(RequestStateError::InvalidKeyring( + "key id exceeds 255 UTF-8 bytes", + )); + } + Ok(()) + } + + // Base64url without padding encodes at most three bytes as four characters. + fn b64_len(len: usize) -> usize { + len.div_ceil(3) * 4 + } + + fn now_ms() -> i64 { + chrono::Utc::now().timestamp_millis() + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn try_new_accepts_key_at_minimum_length() { + let result = RequestStateCodec::try_new(vec![0; RequestStateCodec::MIN_KEY_LENGTH]); + + assert!(result.is_ok(), "unexpected result: {result:?}"); + } + + #[test] + fn try_new_rejects_key_below_minimum_length() { + let actual = RequestStateCodec::MIN_KEY_LENGTH - 1; + let error = RequestStateCodec::try_new(vec![0; actual]).unwrap_err(); + + assert!( + matches!( + &error, + RequestStateError::KeyTooShort { + minimum: RequestStateCodec::MIN_KEY_LENGTH, + actual: error_actual, + } if *error_actual == actual + ), + "unexpected error: {error}" + ); + } + + #[test] + #[allow(deprecated)] + fn new_accepts_short_key_for_backward_compatibility() { + let codec = RequestStateCodec::new(b"key".to_vec()); + + assert_eq!(codec.open(&codec.seal(b"state")).unwrap(), b"state"); + } + + #[test] + fn seal_open_roundtrips_bytes() { + let codec = + RequestStateCodec::try_new(b"test-key-test-key-test-key-32byte".to_vec()).unwrap(); + let sealed = codec.seal(b"hello world"); + assert!(sealed.starts_with("rs1.")); + assert_eq!(codec.open(&sealed).unwrap(), b"hello world"); + } + + #[test] + fn seal_open_roundtrips_json() { + #[derive(serde::Serialize, serde::Deserialize, PartialEq, Debug)] + struct State { + tool: String, + round: u32, + } + let codec = + RequestStateCodec::try_new(b"another-strong-signing-key-here!!".to_vec()).unwrap(); + let state = State { + tool: "weather".into(), + round: 3, + }; + let sealed = codec.seal_json(&state).unwrap(); + let opened: State = codec.open_json(&sealed).unwrap(); + assert_eq!(opened, state); + } + + #[test] + fn empty_payload_roundtrips() { + let codec = + RequestStateCodec::try_new(b"empty-payload-test-signing-key!!".to_vec()).unwrap(); + let sealed = codec.seal(b""); + assert_eq!(codec.open(&sealed).unwrap(), b""); + } + + #[test] + fn tampered_payload_is_rejected() { + let codec = + RequestStateCodec::try_new(b"signing-key-signing-key-signing!!".to_vec()).unwrap(); + let sealed = codec.seal(b"amount=100"); + + // Replace the body section but keep the original tag. + let mut parts: Vec<&str> = sealed.split('.').collect(); + let forged_body = URL_SAFE_NO_PAD.encode(b"amount=999"); + parts[1] = &forged_body; + let forged = parts.join("."); + + assert!(matches!( + codec.open(&forged), + Err(RequestStateError::IntegrityCheckFailed) + )); + } + + #[test] + fn different_key_is_rejected() { + let signer = + RequestStateCodec::try_new(b"the-real-signing-key-value-here!!".to_vec()).unwrap(); + let attacker = + RequestStateCodec::try_new(b"a-totally-different-forged-key!!!".to_vec()).unwrap(); + let sealed = signer.seal(b"trusted"); + assert!(matches!( + attacker.open(&sealed), + Err(RequestStateError::IntegrityCheckFailed) + )); + } + + #[test] + fn appended_bytes_are_rejected() { + let codec = + RequestStateCodec::try_new(b"key-key-key-key-key-key-key-key!!".to_vec()).unwrap(); + let mut sealed = codec.seal(b"state"); + sealed.push('x'); + assert!(codec.open(&sealed).is_err()); + } + + #[test] + fn unsupported_version_is_malformed() { + let codec = + RequestStateCodec::try_new(b"wrong-version-test-signing-key!!".to_vec()).unwrap(); + let sealed = codec.seal(b"state"); + let bumped = sealed.replacen("rs1.", "rs3.", 1); + assert!(matches!( + codec.open(&bumped), + Err(RequestStateError::MalformedFormat) + )); + } + + #[test] + fn missing_sections_are_malformed() { + let codec = + RequestStateCodec::try_new(b"missing-sections-test-signing-key".to_vec()).unwrap(); + assert!(matches!( + codec.open("rs1"), + Err(RequestStateError::MalformedFormat) + )); + assert!(matches!( + codec.open("rs1.onlybody"), + Err(RequestStateError::MalformedFormat) + )); + assert!(matches!( + codec.open("rs1.a.b.c"), + Err(RequestStateError::MalformedFormat) + )); + } + + #[test] + fn non_base64_sections_are_invalid_encoding() { + let codec = + RequestStateCodec::try_new(b"invalid-base64-test-signing-key!!".to_vec()).unwrap(); + assert!(matches!( + codec.open("rs1.!!!!.!!!!"), + Err(RequestStateError::InvalidEncoding) + )); + } + + #[test] + fn debug_does_not_leak_key() { + let codec = + RequestStateCodec::try_new(b"super-secret-key-super-secret-key!!".to_vec()).unwrap(); + let rendered = format!("{codec:?}"); + assert!(!rendered.contains("super-secret-key")); + assert!(rendered.contains("redacted")); + } + + mod associated_data { + use super::*; + + #[test] + fn matching_context_opens() { + let codec = + RequestStateCodec::try_new(b"key-key-key-key-key-key-key-key!!".to_vec()).unwrap(); + let ctx = b"user:alice|tools/call:weather"; + let sealed = codec.seal_with(b"state", &SealOptions::new().associated_data(ctx)); + assert_eq!(codec.open_with(&sealed, ctx).unwrap(), b"state"); + } + + #[test] + fn different_context_is_rejected() { + let codec = + RequestStateCodec::try_new(b"key-key-key-key-key-key-key-key!!".to_vec()).unwrap(); + let sealed = + codec.seal_with(b"state", &SealOptions::new().associated_data(b"user:alice")); + assert!(matches!( + codec.open_with(&sealed, b"user:bob"), + Err(RequestStateError::IntegrityCheckFailed) + )); + } + + #[test] + fn missing_context_is_rejected() { + let codec = + RequestStateCodec::try_new(b"key-key-key-key-key-key-key-key!!".to_vec()).unwrap(); + let sealed = + codec.seal_with(b"state", &SealOptions::new().associated_data(b"user:alice")); + // Opening without the associated data must fail closed. + assert!(matches!( + codec.open(&sealed), + Err(RequestStateError::IntegrityCheckFailed) + )); + } + } + + mod ttl { + use super::*; + + const KEY: &[u8] = b"ttl-signing-key-ttl-signing-key!!"; + + #[test] + fn within_ttl_opens() { + let codec = RequestStateCodec::try_new(KEY.to_vec()).unwrap(); + let sealed = codec.seal_at( + b"state", + &SealOptions::new().ttl(Duration::from_secs(60)), + 1_000, + ); + // 30s later, still valid. + assert_eq!(codec.open_at(&sealed, &[], 31_000).unwrap(), b"state"); + } + + #[test] + fn past_ttl_is_expired() { + let codec = RequestStateCodec::try_new(KEY.to_vec()).unwrap(); + let sealed = codec.seal_at( + b"state", + &SealOptions::new().ttl(Duration::from_secs(60)), + 1_000, + ); + // 61s later, expired. + assert!(matches!( + codec.open_at(&sealed, &[], 62_000), + Err(RequestStateError::Expired) + )); + } + + #[test] + fn no_ttl_never_expires() { + let codec = RequestStateCodec::try_new(KEY.to_vec()).unwrap(); + let sealed = codec.seal_at(b"state", &SealOptions::new(), 1_000); + assert_eq!(codec.open_at(&sealed, &[], i64::MAX).unwrap(), b"state"); + } + + #[test] + fn ttl_and_associated_data_combine() { + let codec = RequestStateCodec::try_new(KEY.to_vec()).unwrap(); + let ctx = b"user:alice"; + let sealed = codec.seal_at( + b"state", + &SealOptions::new() + .associated_data(ctx) + .ttl(Duration::from_secs(60)), + 1_000, + ); + assert_eq!(codec.open_at(&sealed, ctx, 10_000).unwrap(), b"state"); + assert!(matches!( + codec.open_at(&sealed, b"user:bob", 10_000), + Err(RequestStateError::IntegrityCheckFailed) + )); + assert!(matches!( + codec.open_at(&sealed, ctx, 99_000), + Err(RequestStateError::Expired) + )); + } + } + + mod key_rotation { + use super::*; + + const KEY_A: &[u8] = b"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"; + const KEY_B: &[u8] = b"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"; + const KEY_C: &[u8] = b"cccccccccccccccccccccccccccccccc"; + const KAT_KEY: &[u8] = b"0123456789abcdef0123456789abcdef"; + const KAT_KID: &str = "rotation-key-2026-08"; + const KAT_AD: &[u8] = b"user:alice|request:weather"; + const KAT_NOW_MS: i64 = 1_700_000_000_000; + + fn two_key_ring(active: &str) -> RequestStateCodec { + RequestStateCodec::new_with_keyring(active, [("a", KEY_A), ("b", KEY_B)]).unwrap() + } + + fn body(expiry: i64, payload: &[u8]) -> Vec { + let mut body = expiry.to_be_bytes().to_vec(); + body.extend_from_slice(payload); + body + } + + fn replace_segment(token: &str, index: usize, replacement: &str) -> String { + let mut parts: Vec = token.split('.').map(str::to_owned).collect(); + parts[index] = replacement.to_owned(); + parts.join(".") + } + + fn test_mac( + key: &[u8], + domain: &[u8], + kid: Option<&[u8]>, + associated_data: &[u8], + body: &[u8], + ) -> Vec { + let mut mac = HmacSha256::new_from_slice(key).expect("HMAC accepts keys of any length"); + mac.update(domain); + if let Some(kid) = kid { + mac.update(&(kid.len() as u64).to_be_bytes()); + mac.update(kid); + } + mac.update(&(associated_data.len() as u64).to_be_bytes()); + mac.update(associated_data); + mac.update(body); + mac.finalize().into_bytes().to_vec() + } + + fn raw_rs1(body: &[u8], tag: &[u8]) -> String { + format!( + "rs1.{}.{}", + URL_SAFE_NO_PAD.encode(body), + URL_SAFE_NO_PAD.encode(tag) + ) + } + + fn raw_rs2(kid: &[u8], body: &[u8], tag: &[u8]) -> String { + format!( + "rs2.{}.{}.{}", + URL_SAFE_NO_PAD.encode(kid), + URL_SAFE_NO_PAD.encode(body), + URL_SAFE_NO_PAD.encode(tag) + ) + } + + #[test] + fn rs1_known_answer_is_unchanged() { + // Independently checked with Python stdlib HMAC and Ruby OpenSSL. + let codec = RequestStateCodec::try_new(KAT_KEY).unwrap(); + let sealed = codec.seal_at( + b"step=2", + &SealOptions::new() + .associated_data(KAT_AD) + .ttl(Duration::from_secs(90)), + KAT_NOW_MS, + ); + assert_eq!( + sealed, + "rs1.AAABi8_mx5BzdGVwPTI.GQgS0X7mtSz8ZOy_kld2Zjuc4gAMGpBL74EghWI36IQ" + ); + } + + #[test] + fn rs2_known_answer_matches_wire_specification() { + // Independently checked with Python stdlib HMAC and Ruby OpenSSL. + let codec = RequestStateCodec::new_with_keyring(KAT_KID, [(KAT_KID, KAT_KEY)]).unwrap(); + let sealed = codec.seal_at( + b"step=2", + &SealOptions::new() + .associated_data(KAT_AD) + .ttl(Duration::from_secs(90)), + KAT_NOW_MS, + ); + assert_eq!( + sealed, + "rs2.cm90YXRpb24ta2V5LTIwMjYtMDg.AAABi8_mx5BzdGVwPTI.twv2acu7lKXqebyrmit-JrHHZm-BkKlBQEMMtL3lHk8" + ); + } + + #[test] + fn rs2_roundtrips_with_associated_data_and_ttl() { + let codec = two_key_ring("a"); + let options = SealOptions::new() + .associated_data(b"user:alice") + .ttl(Duration::from_secs(60)); + + let sealed = codec.seal_at(b"state", &options, 1_000); + assert!(sealed.starts_with("rs2.YQ.")); + assert_eq!( + codec.open_at(&sealed, b"user:alice", 30_000).unwrap(), + b"state" + ); + assert!(matches!( + codec.open_at(&sealed, b"user:bob", 30_000), + Err(RequestStateError::IntegrityCheckFailed) + )); + assert!(matches!( + codec.open_at(&sealed, b"user:alice", 70_000), + Err(RequestStateError::Expired) + )); + } + + #[test] + fn rotation_keeps_previous_rs2_key_verifiable() { + let signer_a = two_key_ring("a"); + let token_a = signer_a.seal(b"state-a"); + + let signer_b = two_key_ring("b"); + assert_eq!(signer_b.open(&token_a).unwrap(), b"state-a"); + let token_b = signer_b.seal(b"state-b"); + assert!(token_b.starts_with("rs2.Yg.")); + assert_eq!(signer_b.open(&token_b).unwrap(), b"state-b"); + + let without_a = RequestStateCodec::new_with_keyring("b", [("b", KEY_B)]).unwrap(); + assert!(matches!( + without_a.open(&token_a), + Err(RequestStateError::UnknownKeyId) + )); + } + + #[test] + fn rolling_migration_is_bidirectionally_compatible() { + let old = RequestStateCodec::try_new(KEY_A).unwrap(); + let transitional = + RequestStateCodec::new_with_keyring("new", [("old", KEY_A), ("new", KEY_B)]) + .unwrap() + .with_rs1_signing("old") + .unwrap(); + let promoted = + RequestStateCodec::new_with_keyring("new", [("old", KEY_A), ("new", KEY_B)]) + .unwrap() + .with_rs1_fallback("old") + .unwrap(); + let retired = RequestStateCodec::new_with_keyring("new", [("new", KEY_B)]).unwrap(); + + let old_token = old.seal(b"old"); + assert_eq!(transitional.open(&old_token).unwrap(), b"old"); + + let transitional_token = transitional.seal(b"transition"); + assert!(transitional_token.starts_with("rs1.")); + assert_eq!(old.open(&transitional_token).unwrap(), b"transition"); + assert_eq!(promoted.open(&transitional_token).unwrap(), b"transition"); + + let promoted_token = promoted.seal(b"promoted"); + assert!(promoted_token.starts_with("rs2.")); + assert_eq!(transitional.open(&promoted_token).unwrap(), b"promoted"); + assert_eq!(retired.open(&promoted_token).unwrap(), b"promoted"); + assert!(matches!( + retired.open(&old_token), + Err(RequestStateError::UnknownKeyId) + )); + } + + #[test] + fn multiple_legacy_fallbacks_are_supported() { + let legacy_a = RequestStateCodec::try_new(KEY_A).unwrap().seal(b"a"); + let legacy_b = RequestStateCodec::try_new(KEY_B).unwrap().seal(b"b"); + let legacy_c = RequestStateCodec::try_new(KEY_C).unwrap().seal(b"c"); + let ring = RequestStateCodec::new_with_keyring( + "new", + [("a", KEY_A), ("b", KEY_B), ("new", KEY_C)], + ) + .unwrap() + .with_rs1_fallback("a") + .unwrap() + .with_rs1_fallback("b") + .unwrap(); + + assert_eq!(ring.open(&legacy_a).unwrap(), b"a"); + assert_eq!(ring.open(&legacy_b).unwrap(), b"b"); + assert!(matches!( + ring.open(&legacy_c), + Err(RequestStateError::IntegrityCheckFailed) + )); + } + + #[test] + fn kid_is_authenticated_even_when_ids_share_key_bytes() { + let codec = + RequestStateCodec::new_with_keyring("a", [("a", KEY_A), ("b", KEY_A)]).unwrap(); + let sealed = codec.seal(b"state"); + let swapped = replace_segment(&sealed, 1, &URL_SAFE_NO_PAD.encode(b"b")); + assert!(matches!( + codec.open(&swapped), + Err(RequestStateError::IntegrityCheckFailed) + )); + } + + #[test] + fn independent_rs2_segment_tampering_is_rejected() { + let codec = two_key_ring("a"); + let sealed = codec.seal(b"state"); + + let swapped_kid = replace_segment(&sealed, 1, &URL_SAFE_NO_PAD.encode(b"b")); + let tampered_body = replace_segment(&sealed, 2, &URL_SAFE_NO_PAD.encode(b"changed")); + let tampered_tag = replace_segment(&sealed, 3, &URL_SAFE_NO_PAD.encode([0_u8; 32])); + + for tampered in [swapped_kid, tampered_body, tampered_tag] { + assert!(matches!( + codec.open(&tampered), + Err(RequestStateError::IntegrityCheckFailed) + )); + } + } + + #[test] + fn version_domains_are_cryptographically_separate() { + let token_body = body(0, b"state"); + + let wrong_v2_tag = test_mac(KEY_A, DOMAIN_V1, Some(b"a"), b"", &token_body); + let wrong_v2 = raw_rs2(b"a", &token_body, &wrong_v2_tag); + assert!(matches!( + two_key_ring("a").open(&wrong_v2), + Err(RequestStateError::IntegrityCheckFailed) + )); + + let wrong_v1_tag = test_mac(KEY_A, DOMAIN_V2, None, b"", &token_body); + let wrong_v1 = raw_rs1(&token_body, &wrong_v1_tag); + assert!(matches!( + RequestStateCodec::try_new(KEY_A).unwrap().open(&wrong_v1), + Err(RequestStateError::IntegrityCheckFailed) + )); + } + + #[test] + fn constructor_invariants_are_enforced() { + let empty = + RequestStateCodec::new_with_keyring("a", std::iter::empty::<(&str, &[u8])>()); + assert!(matches!(empty, Err(RequestStateError::InvalidKeyring(_)))); + + let duplicate = RequestStateCodec::new_with_keyring("a", [("a", KEY_A), ("a", KEY_B)]); + assert!(matches!( + duplicate, + Err(RequestStateError::InvalidKeyring(_)) + )); + + let empty_kid = RequestStateCodec::new_with_keyring("", [("", KEY_A)]); + assert!(matches!( + empty_kid, + Err(RequestStateError::InvalidKeyring(_)) + )); + + let oversized = "x".repeat(MAX_KID_LEN + 1); + let oversized_kid = + RequestStateCodec::new_with_keyring(oversized.clone(), [(oversized, KEY_A)]); + assert!(matches!( + oversized_kid, + Err(RequestStateError::InvalidKeyring(_)) + )); + + let absent_active = RequestStateCodec::new_with_keyring("missing", [("a", KEY_A)]); + assert!(matches!( + absent_active, + Err(RequestStateError::InvalidKeyring(_)) + )); + + let short_key = RequestStateCodec::new_with_keyring( + "a", + [("a", vec![0; RequestStateCodec::MIN_KEY_LENGTH - 1])], + ); + assert!(matches!( + short_key, + Err(RequestStateError::KeyTooShort { .. }) + )); + + assert!(matches!( + RequestStateCodec::try_new(KEY_A) + .unwrap() + .with_rs1_signing("a"), + Err(RequestStateError::InvalidKeyring(_)) + )); + assert!(matches!( + two_key_ring("a").with_rs1_signing("missing"), + Err(RequestStateError::InvalidKeyring(_)) + )); + assert!(matches!( + RequestStateCodec::try_new(KEY_A) + .unwrap() + .with_rs1_fallback("a"), + Err(RequestStateError::InvalidKeyring(_)) + )); + assert!(matches!( + two_key_ring("a").with_rs1_fallback("missing"), + Err(RequestStateError::InvalidKeyring(_)) + )); + } + + #[test] + fn maximum_length_kid_roundtrips_and_oversized_wire_kid_is_rejected() { + let max_kid = "x".repeat(MAX_KID_LEN); + let codec = + RequestStateCodec::new_with_keyring(max_kid.clone(), [(max_kid, KEY_A)]).unwrap(); + let token = codec.seal(b"state"); + assert_eq!(codec.open(&token).unwrap(), b"state"); + + let encoded_oversized = URL_SAFE_NO_PAD.encode("x".repeat(MAX_KID_LEN + 1)); + assert!(encoded_oversized.len() > MAX_ENCODED_KID_LEN); + let oversized = format!("rs2.{encoded_oversized}.!!!!.!!!!"); + assert!(matches!( + codec.open(&oversized), + Err(RequestStateError::InvalidKeyId) + )); + + let overlong_invalid_base64 = + format!("rs2.{}.!!!!.!!!!", "!".repeat(MAX_ENCODED_KID_LEN + 1)); + assert!(matches!( + codec.open(&overlong_invalid_base64), + Err(RequestStateError::InvalidKeyId) + )); + } + + #[test] + fn parser_rejects_invalid_tokens_and_unavailable_keys() { + let codec = two_key_ring("a"); + for malformed in [ + "rs2", + "rs2.YQ", + "rs2.YQ.body", + "rs2.YQ.body.tag.extra", + "rs3.YQ.body.tag", + ] { + assert!(matches!( + codec.open(malformed), + Err(RequestStateError::MalformedFormat) + )); + } + + let valid_rs2 = codec.seal(b"state"); + assert!(matches!( + codec.open(&replace_segment(&valid_rs2, 1, "!!!!")), + Err(RequestStateError::InvalidEncoding) + )); + assert!(matches!( + codec.open(&replace_segment(&valid_rs2, 1, "")), + Err(RequestStateError::InvalidKeyId) + )); + let non_utf8 = URL_SAFE_NO_PAD.encode([0xff]); + assert!(matches!( + codec.open(&replace_segment(&valid_rs2, 1, &non_utf8)), + Err(RequestStateError::InvalidKeyId) + )); + + assert!(matches!( + RequestStateCodec::try_new(KEY_A).unwrap().open(&valid_rs2), + Err(RequestStateError::UnknownKeyId) + )); + + let valid_rs1 = RequestStateCodec::try_new(KEY_A).unwrap().seal(b"state"); + assert!(matches!( + codec.open(&valid_rs1), + Err(RequestStateError::UnknownKeyId) + )); + } + + #[test] + fn authenticated_short_body_is_malformed() { + let short_body = b"short"; + let tag = RequestStateCodec::mac_v2(KEY_A, b"a", b"", short_body) + .finalize() + .into_bytes(); + let token = raw_rs2(b"a", short_body, tag.as_slice()); + assert!(matches!( + two_key_ring("a").open(&token), + Err(RequestStateError::MalformedFormat) + )); + } + + #[test] + fn serde_is_reached_only_after_integrity_verification() { + let codec = two_key_ring("a"); + let invalid_json = codec.seal(b"{not-json"); + let opened: Result = codec.open_json(&invalid_json); + assert!(matches!(opened, Err(RequestStateError::Deserialization(_)))); + + let valid_json = codec.seal(b"{}"); + let tampered_body = body(0, b"{not-json"); + let tampered = replace_segment(&valid_json, 2, &URL_SAFE_NO_PAD.encode(tampered_body)); + let opened: Result = codec.open_json(&tampered); + assert!(matches!( + opened, + Err(RequestStateError::IntegrityCheckFailed) + )); + } + + #[test] + fn ring_debug_redacts_all_key_material() { + let codec = two_key_ring("b").with_rs1_fallback("a").unwrap(); + let rendered = format!("{codec:?}"); + assert!(!rendered.contains(std::str::from_utf8(KEY_A).unwrap())); + assert!(!rendered.contains(std::str::from_utf8(KEY_B).unwrap())); + assert!(rendered.contains("redacted")); + } + + #[test] + fn mutated_tokens_do_not_panic() { + let codec = two_key_ring("a").with_rs1_fallback("a").unwrap(); + let valid = [ + RequestStateCodec::try_new(KEY_A).unwrap().seal(b"state"), + codec.seal(b"state"), + ]; + let mut corpus = vec![ + String::new(), + ".".to_owned(), + "...".to_owned(), + "rs1".to_owned(), + "rs2".to_owned(), + "💥".to_owned(), + "rs2.💥...".to_owned(), + ]; + + for token in valid { + for end in 0..=token.len() { + corpus.push(token[..end].to_owned()); + } + for index in 0..token.len() { + let mut bytes = token.as_bytes().to_vec(); + bytes[index] = b'!'; + corpus.push(String::from_utf8(bytes).expect("token is ASCII")); + } + } + + for candidate in corpus { + let _ = codec.open(&candidate); + let _ = codec.open_with(&candidate, b"context"); + } + } + } +} diff --git a/vendor/rmcp/src/model/resource.rs b/vendor/rmcp/src/model/resource.rs new file mode 100644 index 00000000..9c27dce2 --- /dev/null +++ b/vendor/rmcp/src/model/resource.rs @@ -0,0 +1,310 @@ +use serde::{Deserialize, Serialize}; + +use super::{Annotations, Icon, MetaObject}; + +/// A known resource that the server is capable of reading (spec `Resource`). +/// +/// Also used as the inner type of `ContentBlock::ResourceLink` (spec `ResourceLink extends Resource`). +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct Resource { + /// The URI of this resource (e.g. `file:///path/to/file`). + pub uri: String, + /// The programmatic name of the resource. + pub name: String, + /// Optional human-readable display title. + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + /// Optional description of what this resource represents. + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + /// The MIME type of this resource, if known. + #[serde(skip_serializing_if = "Option::is_none")] + pub mime_type: Option, + /// The size of the raw resource content in bytes (before base64/tokenization), if known. + #[serde(skip_serializing_if = "Option::is_none")] + pub size: Option, + /// Optional set of icons the client may display for this resource. + #[serde(skip_serializing_if = "Option::is_none")] + pub icons: Option>, + /// Optional protocol-level metadata for this resource. + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, + /// Optional annotations describing how the client should use this resource. + #[serde(skip_serializing_if = "Option::is_none")] + pub annotations: Option, +} + +impl Resource { + pub fn new(uri: impl Into, name: impl Into) -> Self { + Self { + uri: uri.into(), + name: name.into(), + title: None, + description: None, + mime_type: None, + size: None, + icons: None, + meta: None, + annotations: None, + } + } + + pub fn with_title(mut self, title: impl Into) -> Self { + self.title = Some(title.into()); + self + } + + pub fn with_description(mut self, description: impl Into) -> Self { + self.description = Some(description.into()); + self + } + + pub fn with_mime_type(mut self, mime_type: impl Into) -> Self { + self.mime_type = Some(mime_type.into()); + self + } + + pub fn with_size(mut self, size: u64) -> Self { + self.size = Some(size); + self + } + + pub fn with_icons(mut self, icons: Vec) -> Self { + self.icons = Some(icons); + self + } + + pub fn with_meta(mut self, meta: MetaObject) -> Self { + self.meta = Some(meta); + self + } + + pub fn with_annotations(mut self, annotations: Annotations) -> Self { + self.annotations = Some(annotations); + self + } +} + +/// A template description for resources available on the server (spec `ResourceTemplate`). +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct ResourceTemplate { + /// An RFC 6570 URI template for constructing resource URIs. + pub uri_template: String, + /// The programmatic name of the resource template. + pub name: String, + /// Optional human-readable display title. + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + /// Optional description of what this template is for. + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, + /// The MIME type for resources matching this template, if uniform. + #[serde(skip_serializing_if = "Option::is_none")] + pub mime_type: Option, + /// Optional set of icons the client may display for this template. + #[serde(skip_serializing_if = "Option::is_none")] + pub icons: Option>, + /// Optional protocol-level metadata for this resource template. + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, + /// Optional annotations describing how the client should use this template. + #[serde(skip_serializing_if = "Option::is_none")] + pub annotations: Option, +} + +impl ResourceTemplate { + pub fn new(uri_template: impl Into, name: impl Into) -> Self { + Self { + uri_template: uri_template.into(), + name: name.into(), + title: None, + description: None, + mime_type: None, + icons: None, + meta: None, + annotations: None, + } + } + + pub fn with_title(mut self, title: impl Into) -> Self { + self.title = Some(title.into()); + self + } + + pub fn with_description(mut self, description: impl Into) -> Self { + self.description = Some(description.into()); + self + } + + pub fn with_mime_type(mut self, mime_type: impl Into) -> Self { + self.mime_type = Some(mime_type.into()); + self + } + + pub fn with_icons(mut self, icons: Vec) -> Self { + self.icons = Some(icons); + self + } + + pub fn with_meta(mut self, meta: MetaObject) -> Self { + self.meta = Some(meta); + self + } + + pub fn with_annotations(mut self, annotations: Annotations) -> Self { + self.annotations = Some(annotations); + self + } +} + +/// The contents of a specific resource or sub-resource. +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(untagged)] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub enum ResourceContents { + #[serde(rename_all = "camelCase")] + TextResourceContents { + uri: String, + #[serde(skip_serializing_if = "Option::is_none")] + mime_type: Option, + text: String, + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + meta: Option, + }, + #[serde(rename_all = "camelCase")] + BlobResourceContents { + uri: String, + #[serde(skip_serializing_if = "Option::is_none")] + mime_type: Option, + blob: String, + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + meta: Option, + }, +} + +impl ResourceContents { + pub fn text(text: impl Into, uri: impl Into) -> Self { + Self::TextResourceContents { + uri: uri.into(), + mime_type: Some("text/plain".into()), + text: text.into(), + meta: None, + } + } + + pub fn blob(blob: impl Into, uri: impl Into) -> Self { + Self::BlobResourceContents { + uri: uri.into(), + mime_type: None, + blob: blob.into(), + meta: None, + } + } + + pub fn with_mime_type(mut self, mime_type: impl Into) -> Self { + match &mut self { + Self::TextResourceContents { mime_type: mt, .. } => *mt = Some(mime_type.into()), + Self::BlobResourceContents { mime_type: mt, .. } => *mt = Some(mime_type.into()), + } + self + } + + pub fn with_meta(mut self, meta: MetaObject) -> Self { + match &mut self { + Self::TextResourceContents { meta: m, .. } => *m = Some(meta), + Self::BlobResourceContents { meta: m, .. } => *m = Some(meta), + } + self + } +} + +#[cfg(test)] +mod tests { + use serde_json; + + use super::*; + use crate::model::IconTheme; + + #[test] + fn test_resource_serialization() { + let resource = Resource::new("file:///test.txt", "test") + .with_description("Test resource") + .with_mime_type("text/plain") + .with_size(100); + + let json = serde_json::to_string(&resource).unwrap(); + assert!(json.contains("mimeType")); + assert!(!json.contains("mime_type")); + } + + #[test] + fn test_resource_contents_serialization() { + let text_contents = ResourceContents::TextResourceContents { + uri: "file:///test.txt".to_string(), + mime_type: Some("text/plain".to_string()), + text: "Hello world".to_string(), + meta: None, + }; + + let json = serde_json::to_string(&text_contents).unwrap(); + assert!(json.contains("mimeType")); + assert!(!json.contains("mime_type")); + } + + #[test] + fn test_resource_template_with_icons() { + let resource_template = ResourceTemplate::new("file:///{path}", "template") + .with_title("Test Template") + .with_description("A test resource template") + .with_mime_type("text/plain") + .with_icons(vec![Icon { + src: "https://example.com/icon.png".to_string(), + mime_type: Some("image/png".to_string()), + sizes: Some(vec!["48x48".to_string()]), + theme: Some(IconTheme::Light), + }]); + + let json = serde_json::to_value(&resource_template).unwrap(); + assert!(json["icons"].is_array()); + assert_eq!(json["icons"][0]["src"], "https://example.com/icon.png"); + assert_eq!(json["icons"][0]["sizes"][0], "48x48"); + assert_eq!(json["icons"][0]["theme"], "light"); + } + + #[test] + fn test_resource_template_without_icons() { + let resource_template = ResourceTemplate::new("file:///{path}", "template"); + let json = serde_json::to_value(&resource_template).unwrap(); + assert!(json.get("icons").is_none()); + } + + #[test] + fn test_resource_size_u64() { + let resource = Resource::new("file:///big", "big").with_size(5_000_000_000); + let json = serde_json::to_value(&resource).unwrap(); + assert_eq!(json["size"], 5_000_000_000_u64); + } + + #[test] + fn test_resource_with_annotations() { + let resource = Resource::new("file:///test.txt", "test") + .with_annotations(Annotations::default().with_priority(0.9)); + let json = serde_json::to_value(&resource).unwrap(); + assert_eq!(json["annotations"]["priority"], 0.9_f32); + } + + #[test] + fn test_resource_template_with_meta() { + let resource_template = + ResourceTemplate::new("file:///{path}", "template").with_meta(MetaObject::default()); + let json = serde_json::to_value(&resource_template).unwrap(); + assert!(json.get("_meta").is_some()); + } +} diff --git a/vendor/rmcp/src/model/serde_impl.rs b/vendor/rmcp/src/model/serde_impl.rs new file mode 100644 index 00000000..6ce30eb9 --- /dev/null +++ b/vendor/rmcp/src/model/serde_impl.rs @@ -0,0 +1,1047 @@ +use std::borrow::Cow; + +use serde::{Deserialize, Serialize}; + +use super::{ + CustomNotification, CustomRequest, Extensions, JsonObject, MetaObject, Notification, + NotificationMetaObject, NotificationNoParam, Request, RequestMetaObject, RequestNoParam, + RequestOptionalParam, +}; + +/// Float deserializers that also accept the number map serde_json's +/// `arbitrary_precision` feature produces for buffered (untagged/flattened) values. +/// Like JSON itself, they reject NaN and infinities. +pub(crate) mod json_float { + use serde::{Deserialize, Deserializer, de::Error}; + use serde_json::Number; + + fn to_f64(number: Number) -> Result { + // `None` only for a value beyond `f64`, which serde_json also rejects + // without the feature. + number + .as_f64() + .ok_or_else(|| E::custom(format_args!("number out of range: {number}"))) + } + + pub(crate) fn f64<'de, D: Deserializer<'de>>(deserializer: D) -> Result { + to_f64(Number::deserialize(deserializer)?) + } + + pub(crate) fn option_f64<'de, D: Deserializer<'de>>( + deserializer: D, + ) -> Result, D::Error> { + Option::::deserialize(deserializer)? + .map(to_f64) + .transpose() + } + + pub(crate) fn option_f32<'de, D: Deserializer<'de>>( + deserializer: D, + ) -> Result, D::Error> { + // serde_json also reads an `f32` field as `f64` and narrows it with `as`. + Ok(option_f64(deserializer)?.map(|value| value as f32)) + } +} + +/// Wire-side view of `params`: the `_meta` map plus the remaining fields. +/// +/// All metadata types are transparent wrappers over [`JsonObject`], so the +/// serde plumbing works on the raw map; call sites wrap/unwrap the typed +/// metadata ([`RequestMetaObject`] / [`NotificationMetaObject`]). +#[derive(Deserialize)] +struct WithMeta<'a, P> { + _meta: Option>, + #[serde(flatten)] + _rest: P, +} + +impl Serialize for WithMeta<'_, P> { + fn serialize(&self, serializer: S) -> Result + where + S: serde::Serializer, + { + use serde::ser::SerializeMap; + + // Serialize _rest to a Value so we can inspect and strip any duplicate _meta + let mut rest_value = + serde_json::to_value(&self._rest).map_err(serde::ser::Error::custom)?; + + // Extract _meta from the serialized params (if it's an object containing one) + let params_meta: Option = rest_value + .as_object_mut() + .and_then(|obj| obj.remove("_meta")) + .and_then(|v| serde_json::from_value(v).ok()); + + // Merge: params-level _meta as base, extensions-level _meta overwrites on conflict + let merged_meta = match (self._meta.as_deref(), params_meta) { + (Some(ext_meta), Some(mut params_meta)) => { + params_meta.extend(ext_meta.clone()); + Some(params_meta) + } + (Some(ext_meta), None) => Some(ext_meta.clone()), + (None, Some(params_meta)) => Some(params_meta), + (None, None) => None, + }; + + // Serialize as a flat map: single _meta + remaining params fields + let rest_obj = match rest_value { + serde_json::Value::Object(map) => map, + _ => serde_json::Map::new(), + }; + let meta_count = usize::from(merged_meta.is_some()); + let mut map = serializer.serialize_map(Some(rest_obj.len() + meta_count))?; + + if let Some(meta) = &merged_meta { + map.serialize_entry("_meta", meta)?; + } + + for (k, v) in &rest_obj { + map.serialize_entry(k, v)?; + } + + map.end() + } +} + +#[derive(Serialize, Deserialize)] +struct Proxy<'a, M, P> { + method: M, + params: WithMeta<'a, P>, +} + +#[derive(Serialize, Deserialize)] +struct ProxyOptionalParam<'a, M, P> { + method: M, + params: Option>, +} + +#[derive(Serialize, Deserialize)] +struct ProxyNoParam { + method: M, +} + +/// Combine the message-specific `_meta` map with a legacy [`MetaObject`] +/// extension so metadata stored in [`Extensions`] is not lost on the wire. +/// On key conflicts the message-specific map wins. +fn merge_legacy_meta<'a>( + typed: Option<&'a JsonObject>, + extensions: &'a Extensions, +) -> Option> { + let legacy = extensions.get::().map(|meta| &meta.0); + match (typed, legacy) { + (Some(typed), None) => Some(Cow::Borrowed(typed)), + (None, Some(legacy)) => Some(Cow::Borrowed(legacy)), + (Some(typed), Some(legacy)) => { + let mut merged = legacy.clone(); + merged.extend( + typed + .iter() + .map(|(key, value)| (key.clone(), value.clone())), + ); + Some(Cow::Owned(merged)) + } + (None, None) => None, + } +} + +/// Borrow the request `_meta` map from extensions, if any. +fn request_meta(extensions: &Extensions) -> Option> { + let typed = extensions.get::().map(|meta| &meta.0.0); + merge_legacy_meta(typed, extensions) +} + +/// Borrow the notification `_meta` map from extensions, if any. +fn notification_meta(extensions: &Extensions) -> Option> { + let typed = extensions + .get::() + .map(|meta| &meta.0.0); + merge_legacy_meta(typed, extensions) +} + +/// Build extensions holding a typed metadata map deserialized from `params._meta`. +fn extensions_with_meta(meta: Option>) -> Extensions +where + T: From + Clone + Send + Sync + 'static, +{ + let mut extensions = Extensions::new(); + if let Some(meta) = meta { + extensions.insert(T::from(meta.into_owned())); + } + extensions +} + +impl Serialize for Request +where + M: Serialize, + R: Serialize, +{ + fn serialize(&self, serializer: S) -> Result + where + S: serde::Serializer, + { + Proxy::serialize( + &Proxy { + method: &self.method, + params: WithMeta { + _rest: &self.params, + _meta: request_meta(&self.extensions), + }, + }, + serializer, + ) + } +} + +impl<'de, M, R> Deserialize<'de> for Request +where + M: Deserialize<'de>, + R: Deserialize<'de>, +{ + fn deserialize(deserializer: D) -> Result + where + D: serde::Deserializer<'de>, + { + let body = Proxy::deserialize(deserializer)?; + Ok(Request { + extensions: extensions_with_meta::(body.params._meta), + method: body.method, + params: body.params._rest, + }) + } +} + +impl Serialize for RequestOptionalParam +where + M: Serialize, + R: Serialize, +{ + fn serialize(&self, serializer: S) -> Result + where + S: serde::Serializer, + { + Proxy::serialize( + &Proxy { + method: &self.method, + params: WithMeta { + _rest: &self.params, + _meta: request_meta(&self.extensions), + }, + }, + serializer, + ) + } +} + +impl<'de, M, R> Deserialize<'de> for RequestOptionalParam +where + M: Deserialize<'de>, + R: Deserialize<'de>, +{ + fn deserialize(deserializer: D) -> Result + where + D: serde::Deserializer<'de>, + { + let body = ProxyOptionalParam::<'_, _, Option>::deserialize(deserializer)?; + let mut params = None; + let mut _meta = None; + if let Some(body_params) = body.params { + params = body_params._rest; + _meta = body_params._meta; + } + Ok(RequestOptionalParam { + extensions: extensions_with_meta::(_meta), + method: body.method, + params, + }) + } +} + +impl Serialize for RequestNoParam +where + M: Serialize, +{ + fn serialize(&self, serializer: S) -> Result + where + S: serde::Serializer, + { + // Emit `params` only when metadata is present, so the wire shape of + // meta-less requests stays `{"method": ...}`. + match request_meta(&self.extensions) { + Some(_meta) => Proxy::serialize( + &Proxy { + method: &self.method, + params: WithMeta { + _meta: Some(_meta), + _rest: (), + }, + }, + serializer, + ), + None => ProxyNoParam::serialize( + &ProxyNoParam { + method: &self.method, + }, + serializer, + ), + } + } +} + +impl<'de, M> Deserialize<'de> for RequestNoParam +where + M: Deserialize<'de>, +{ + fn deserialize(deserializer: D) -> Result + where + D: serde::Deserializer<'de>, + { + let body = ProxyOptionalParam::<'_, _, Option>::deserialize(deserializer)?; + let _meta = body.params.and_then(|params| params._meta); + Ok(RequestNoParam { + extensions: extensions_with_meta::(_meta), + method: body.method, + }) + } +} + +impl Serialize for Notification +where + M: Serialize, + R: Serialize, +{ + fn serialize(&self, serializer: S) -> Result + where + S: serde::Serializer, + { + Proxy::serialize( + &Proxy { + method: &self.method, + params: WithMeta { + _rest: &self.params, + _meta: notification_meta(&self.extensions), + }, + }, + serializer, + ) + } +} + +impl<'de, M, R> Deserialize<'de> for Notification +where + M: Deserialize<'de>, + R: Deserialize<'de>, +{ + fn deserialize(deserializer: D) -> Result + where + D: serde::Deserializer<'de>, + { + let body = ProxyOptionalParam::<'_, _, R>::deserialize(deserializer)?; + let (_meta, params) = match body.params { + Some(with_meta) => (with_meta._meta, with_meta._rest), + None => { + // JSON-RPC 2.0: params is optional. Treat absent params as {}. + let empty = serde_json::Value::Object(serde_json::Map::new()); + let r = R::deserialize(empty).map_err(serde::de::Error::custom)?; + (None, r) + } + }; + Ok(Notification { + extensions: extensions_with_meta::(_meta), + method: body.method, + params, + }) + } +} + +impl Serialize for NotificationNoParam +where + M: Serialize, +{ + fn serialize(&self, serializer: S) -> Result + where + S: serde::Serializer, + { + // Emit `params` only when metadata is present, so the wire shape of + // meta-less notifications stays `{"method": ...}`. + match notification_meta(&self.extensions) { + Some(_meta) => Proxy::serialize( + &Proxy { + method: &self.method, + params: WithMeta { + _meta: Some(_meta), + _rest: (), + }, + }, + serializer, + ), + None => ProxyNoParam::serialize( + &ProxyNoParam { + method: &self.method, + }, + serializer, + ), + } + } +} + +impl<'de, M> Deserialize<'de> for NotificationNoParam +where + M: Deserialize<'de>, +{ + fn deserialize(deserializer: D) -> Result + where + D: serde::Deserializer<'de>, + { + let body = ProxyOptionalParam::<'_, _, Option>::deserialize(deserializer)?; + let _meta = body.params.and_then(|params| params._meta); + Ok(NotificationNoParam { + extensions: extensions_with_meta::(_meta), + method: body.method, + }) + } +} + +impl Serialize for CustomRequest { + fn serialize(&self, serializer: S) -> Result + where + S: serde::Serializer, + { + let _meta = request_meta(&self.extensions); + let params = self.params.as_ref(); + + let params = if _meta.is_some() || params.is_some() { + Some(WithMeta { + _meta, + _rest: &self.params, + }) + } else { + None + }; + + ProxyOptionalParam::serialize( + &ProxyOptionalParam { + method: &self.method, + params, + }, + serializer, + ) + } +} + +impl<'de> Deserialize<'de> for CustomRequest { + fn deserialize(deserializer: D) -> Result + where + D: serde::Deserializer<'de>, + { + let body = + ProxyOptionalParam::<'_, _, Option>::deserialize(deserializer)?; + let mut params = None; + let mut _meta = None; + if let Some(body_params) = body.params { + params = body_params._rest; + _meta = body_params._meta; + } + Ok(CustomRequest { + extensions: extensions_with_meta::(_meta), + method: body.method, + params, + }) + } +} + +impl Serialize for CustomNotification { + fn serialize(&self, serializer: S) -> Result + where + S: serde::Serializer, + { + let _meta = notification_meta(&self.extensions); + let params = self.params.as_ref(); + + let params = if _meta.is_some() || params.is_some() { + Some(WithMeta { + _meta, + _rest: &self.params, + }) + } else { + None + }; + + ProxyOptionalParam::serialize( + &ProxyOptionalParam { + method: &self.method, + params, + }, + serializer, + ) + } +} + +impl<'de> Deserialize<'de> for CustomNotification { + fn deserialize(deserializer: D) -> Result + where + D: serde::Deserializer<'de>, + { + let body = + ProxyOptionalParam::<'_, _, Option>::deserialize(deserializer)?; + let mut params = None; + let mut _meta = None; + if let Some(body_params) = body.params { + params = body_params._rest; + _meta = body_params._meta; + } + Ok(CustomNotification { + extensions: extensions_with_meta::(_meta), + method: body.method, + params, + }) + } +} + +#[cfg(test)] +mod test { + use serde_json::json; + + use crate::model::{ + CallToolRequest, CallToolRequestParams, CustomRequest, Extensions, InitializedNotification, + ListToolsRequest, NotificationMetaObject, PingRequest, RequestMetaObject, + }; + + #[test] + fn test_deserialize_lost_tools_request() { + let _req: ListToolsRequest = serde_json::from_value(json!( + { + "method": "tools/list", + } + )) + .unwrap(); + } + + #[test] + fn test_no_duplicate_meta_both_sources() { + // When both extensions and params contain _meta, the output should have + // a single merged _meta key (not two separate ones). + let mut extensions = Extensions::new(); + let mut ext_meta = RequestMetaObject::new(); + ext_meta.insert("traceId".to_string(), json!("abc")); + extensions.insert(ext_meta); + + let mut params_meta = RequestMetaObject::new(); + params_meta.insert("progressToken".to_string(), json!(1)); + + let req = CallToolRequest { + extensions, + method: Default::default(), + params: CallToolRequestParams { + meta: Some(params_meta), + name: "my_tool".into(), + arguments: None, + input_responses: None, + request_state: None, + }, + }; + + let value = serde_json::to_value(&req).unwrap(); + let params = value.get("params").unwrap(); + + // There should be exactly one _meta key (JSON objects naturally deduplicate) + let meta = params.get("_meta").unwrap(); + + // Both entries should be present in the merged _meta + assert_eq!(meta.get("traceId").unwrap(), "abc"); + assert_eq!(meta.get("progressToken").unwrap(), 1); + + // Verify the raw JSON string has exactly one occurrence of "_meta" + let raw = serde_json::to_string(&req).unwrap(); + assert_eq!( + raw.matches("\"_meta\"").count(), + 1, + "Expected exactly one _meta key in serialized output, got: {}", + raw + ); + } + + #[test] + fn test_meta_only_from_extensions() { + let mut extensions = Extensions::new(); + let mut ext_meta = RequestMetaObject::new(); + ext_meta.insert("traceId".to_string(), json!("ext-only")); + extensions.insert(ext_meta); + + let req = CallToolRequest { + extensions, + method: Default::default(), + params: CallToolRequestParams { + meta: None, + name: "my_tool".into(), + arguments: None, + input_responses: None, + request_state: None, + }, + }; + + let value = serde_json::to_value(&req).unwrap(); + let meta = value["params"]["_meta"].as_object().unwrap(); + assert_eq!(meta.get("traceId").unwrap(), "ext-only"); + } + + #[test] + fn test_meta_only_from_params() { + let mut params_meta = RequestMetaObject::new(); + params_meta.insert("progressToken".to_string(), json!(42)); + + let req = CallToolRequest { + extensions: Extensions::new(), + method: Default::default(), + params: CallToolRequestParams { + meta: Some(params_meta), + name: "my_tool".into(), + arguments: None, + input_responses: None, + request_state: None, + }, + }; + + let value = serde_json::to_value(&req).unwrap(); + let meta = value["params"]["_meta"].as_object().unwrap(); + assert_eq!(meta.get("progressToken").unwrap(), 42); + } + + #[test] + fn test_no_meta_emitted_when_neither_source() { + let req = CallToolRequest { + extensions: Extensions::new(), + method: Default::default(), + params: CallToolRequestParams { + meta: None, + name: "my_tool".into(), + arguments: None, + input_responses: None, + request_state: None, + }, + }; + + let value = serde_json::to_value(&req).unwrap(); + assert!( + value["params"].get("_meta").is_none(), + "Expected no _meta when neither source is populated" + ); + } + + #[test] + fn test_extensions_meta_takes_priority_on_conflict() { + // When both sources have the same key, extensions should win. + let mut extensions = Extensions::new(); + let mut ext_meta = RequestMetaObject::new(); + ext_meta.insert("shared_key".to_string(), json!("from_extensions")); + extensions.insert(ext_meta); + + let mut params_meta = RequestMetaObject::new(); + params_meta.insert("shared_key".to_string(), json!("from_params")); + params_meta.insert("params_only".to_string(), json!("kept")); + + let req = CallToolRequest { + extensions, + method: Default::default(), + params: CallToolRequestParams { + meta: Some(params_meta), + name: "my_tool".into(), + arguments: None, + input_responses: None, + request_state: None, + }, + }; + + let value = serde_json::to_value(&req).unwrap(); + let meta = value["params"]["_meta"].as_object().unwrap(); + assert_eq!(meta.get("shared_key").unwrap(), "from_extensions"); + assert_eq!(meta.get("params_only").unwrap(), "kept"); + } + + #[test] + fn test_round_trip_preserves_meta() { + let mut extensions = Extensions::new(); + let mut ext_meta = RequestMetaObject::new(); + ext_meta.insert("traceId".to_string(), json!("round-trip")); + extensions.insert(ext_meta); + + let req = CallToolRequest { + extensions, + method: Default::default(), + params: CallToolRequestParams { + meta: None, + name: "my_tool".into(), + arguments: Some(serde_json::Map::from_iter([("x".to_string(), json!(1))])), + input_responses: None, + request_state: None, + }, + }; + + let serialized = serde_json::to_string(&req).unwrap(); + let deserialized: CallToolRequest = serde_json::from_str(&serialized).unwrap(); + + // Extensions should have the meta after round-trip + let meta = deserialized.extensions.get::().unwrap(); + assert_eq!(meta.get("traceId").unwrap(), "round-trip"); + + // Params should be preserved + assert_eq!(deserialized.params.name, "my_tool"); + assert_eq!( + deserialized + .params + .arguments + .as_ref() + .unwrap() + .get("x") + .unwrap(), + &json!(1) + ); + } + + #[test] + fn test_custom_request_no_duplicate_meta() { + // CustomRequest uses Option as params — verify no duplicate _meta. + let mut extensions = Extensions::new(); + let mut ext_meta = RequestMetaObject::new(); + ext_meta.insert("traceId".to_string(), json!("custom-ext")); + extensions.insert(ext_meta); + + let params = Some(json!({ + "_meta": { "progressToken": 99 }, + "foo": "bar" + })); + + let req = CustomRequest { + extensions, + method: "custom/method".into(), + params, + }; + + let raw = serde_json::to_string(&req).unwrap(); + assert_eq!( + raw.matches("\"_meta\"").count(), + 1, + "Expected exactly one _meta key in CustomRequest output, got: {}", + raw + ); + + let value: serde_json::Value = serde_json::from_str(&raw).unwrap(); + let meta = value["params"]["_meta"].as_object().unwrap(); + assert_eq!(meta.get("traceId").unwrap(), "custom-ext"); + assert_eq!(meta.get("progressToken").unwrap(), 99); + } + + #[test] + fn test_request_no_param_meta_round_trip() { + // Ping-shaped requests must carry `params._meta` on the wire. + let mut extensions = Extensions::new(); + let mut meta = RequestMetaObject::new(); + meta.insert("traceId".to_string(), json!("ping-trace")); + extensions.insert(meta); + + let req = PingRequest { + method: Default::default(), + extensions, + }; + + let value = serde_json::to_value(&req).unwrap(); + assert_eq!(value["params"]["_meta"]["traceId"], json!("ping-trace")); + + let deserialized: PingRequest = serde_json::from_value(value).unwrap(); + let meta = deserialized + .extensions + .get::() + .expect("meta should survive the round-trip"); + assert_eq!(meta.get("traceId").unwrap(), &json!("ping-trace")); + } + + #[test] + fn test_request_no_param_without_meta_has_no_params_key() { + let req = PingRequest { + method: Default::default(), + extensions: Extensions::new(), + }; + let value = serde_json::to_value(&req).unwrap(); + assert!( + value.get("params").is_none(), + "meta-less no-param requests must keep the historical wire shape: {value}" + ); + } + + #[test] + fn test_notification_no_param_meta_round_trip() { + // Initialized-shaped notifications must carry `params._meta` on the wire. + let mut extensions = Extensions::new(); + let mut meta = NotificationMetaObject::new(); + meta.insert("traceId".to_string(), json!("init-trace")); + extensions.insert(meta); + + let notification = InitializedNotification { + method: Default::default(), + extensions, + }; + + let value = serde_json::to_value(¬ification).unwrap(); + assert_eq!(value["params"]["_meta"]["traceId"], json!("init-trace")); + + let deserialized: InitializedNotification = serde_json::from_value(value).unwrap(); + let meta = deserialized + .extensions + .get::() + .expect("meta should survive the round-trip"); + assert_eq!(meta.get("traceId").unwrap(), &json!("init-trace")); + } + + #[test] + fn test_notification_no_param_without_meta_has_no_params_key() { + let notification = InitializedNotification { + method: Default::default(), + extensions: Extensions::new(), + }; + let value = serde_json::to_value(¬ification).unwrap(); + assert!( + value.get("params").is_none(), + "meta-less no-param notifications must keep the historical wire shape: {value}" + ); + } + + #[test] + fn test_no_param_ignores_unknown_params_fields() { + // Old/foreign peers may send params without _meta; both shapes must parse. + let _req: PingRequest = + serde_json::from_value(json!({"method": "ping", "params": {}})).unwrap(); + let _req: PingRequest = + serde_json::from_value(json!({"method": "ping", "params": {"unknown": 1}})).unwrap(); + let _req: PingRequest = serde_json::from_value(json!({"method": "ping"})).unwrap(); + } + + #[test] + fn test_legacy_meta_extension_still_serializes() { + let mut extensions = Extensions::new(); + let mut legacy = crate::model::MetaObject::new(); + legacy.insert("traceId".to_string(), json!("legacy")); + extensions.insert(legacy); + + let req = CallToolRequest { + extensions, + method: Default::default(), + params: CallToolRequestParams { + meta: None, + name: "my_tool".into(), + arguments: None, + input_responses: None, + request_state: None, + }, + }; + + let value = serde_json::to_value(&req).unwrap(); + assert_eq!(value["params"]["_meta"]["traceId"], json!("legacy")); + } + + #[test] + fn test_typed_meta_wins_over_legacy_extension_on_conflict() { + let mut extensions = Extensions::new(); + let mut legacy = crate::model::MetaObject::new(); + legacy.insert("shared".to_string(), json!("legacy")); + legacy.insert("legacy_only".to_string(), json!("kept")); + extensions.insert(legacy); + let mut typed = RequestMetaObject::new(); + typed.insert("shared".to_string(), json!("typed")); + extensions.insert(typed); + + let req = CallToolRequest { + extensions, + method: Default::default(), + params: CallToolRequestParams { + meta: None, + name: "my_tool".into(), + arguments: None, + input_responses: None, + request_state: None, + }, + }; + + let value = serde_json::to_value(&req).unwrap(); + let meta = value["params"]["_meta"].as_object().unwrap(); + assert_eq!(meta.get("shared").unwrap(), "typed"); + assert_eq!(meta.get("legacy_only").unwrap(), "kept"); + } + + #[test] + fn test_arbitrary_meta_keys_round_trip_unchanged() { + let input = json!({ + "method": "tools/call", + "params": { + "_meta": { + "progressToken": 5, + "vendor.example/custom": {"nested": ["a", 1, null]}, + "another-key": true + }, + "name": "my_tool" + } + }); + let req: CallToolRequest = serde_json::from_value(input.clone()).unwrap(); + let output = serde_json::to_value(&req).unwrap(); + assert_eq!(input, output); + } + + /// The float fields read through [`super::json_float`]. + mod json_float { + use std::fmt::Debug; + + use rstest::rstest; + use serde::{Deserialize, Serialize, de::DeserializeOwned}; + use serde_json::{Value, json}; + + use crate::model::{ + Annotations, CreateMessageRequestParams, ModelPreferences, NumberSchema, + ProgressNotificationParam, + }; + + /// Untagged, so serde buffers the input before `T` reads it, as it + /// does for every JSON-RPC message. + #[derive(Deserialize)] + #[serde(untagged)] + enum Buffered { + Inner(T), + } + + /// Decodes `text` directly and through serde's buffer, checks that both + /// agree, and that the value survives a round trip. + fn decode(text: &str) -> T + where + T: DeserializeOwned + Serialize + PartialEq + Debug, + { + let direct: T = serde_json::from_str(text).unwrap(); + let Buffered::Inner(buffered) = serde_json::from_str(text).unwrap(); + assert_eq!(direct, buffered, "{text}"); + let encoded = serde_json::to_string(&direct).unwrap(); + assert_eq!( + serde_json::from_str::(&encoded).unwrap(), + direct, + "{encoded}" + ); + direct + } + + fn rejects(text: &str) { + assert!(serde_json::from_str::(text).is_err(), "{text}"); + assert!(serde_json::from_str::>(text).is_err(), "{text}"); + } + + #[rstest] + #[case::decimal("0.6", 0.6)] + #[case::trailing_zero("0.60", 0.6)] + #[case::exponent("6e-1", 0.6)] + #[case::integer("1", 1.0)] + #[case::integral_decimal("1.0", 1.0)] + #[case::zero("0", 0.0)] + fn fields_read_every_spelling(#[case] n: &str, #[case] expected: f64) { + // An `f32` field holds the `f64` narrowed, as serde_json reads it. + let narrowed = Some(expected as f32); + + let annotations: Annotations = decode(&format!(r#"{{"priority":{n}}}"#)); + assert_eq!(annotations.priority, narrowed); + + let progress: ProgressNotificationParam = decode(&format!( + r#"{{"progressToken":1,"progress":{n},"total":{n}}}"# + )); + assert_eq!(progress.progress, expected); + assert_eq!(progress.total, Some(expected)); + + let params: CreateMessageRequestParams = decode(&format!( + r#"{{"messages":[],"maxTokens":1,"temperature":{n}}}"# + )); + assert_eq!(params.temperature, narrowed); + + let preferences: ModelPreferences = decode(&format!( + r#"{{"costPriority":{n},"speedPriority":{n},"intelligencePriority":{n}}}"# + )); + assert_eq!(preferences.cost_priority, narrowed); + assert_eq!(preferences.speed_priority, narrowed); + assert_eq!(preferences.intelligence_priority, narrowed); + + let schema: NumberSchema = decode(&format!( + r#"{{"type":"number","minimum":{n},"maximum":{n},"default":{n}}}"# + )); + assert_eq!(schema.minimum, Some(expected)); + assert_eq!(schema.maximum, Some(expected)); + assert_eq!(schema.default, Some(expected)); + } + + #[test] + fn decimal_narrows_to_the_nearest_f32() { + let annotations: Annotations = decode(r#"{"priority":0.6}"#); + assert_eq!(annotations.priority, Some(0.6_f32)); + } + + #[rstest] + #[case::missing(None)] + #[case::null(Some(Value::Null))] + fn optional_fields_read_absent_as_none(#[case] value: Option) { + // `base` with each of `keys` set to `value`, or left out. + let with = |mut base: Value, keys: &[&str]| { + if let Some(value) = &value { + for key in keys { + base[*key] = value.clone(); + } + } + base.to_string() + }; + + let annotations: Annotations = decode(&with(json!({}), &["priority"])); + assert_eq!(annotations, Annotations::default()); + + let progress: ProgressNotificationParam = decode(&with( + json!({"progressToken": 1, "progress": 0}), + &["total"], + )); + assert_eq!(progress.total, None); + + let params: CreateMessageRequestParams = decode(&with( + json!({"messages": [], "maxTokens": 1}), + &["temperature"], + )); + assert_eq!(params.temperature, None); + + let preferences: ModelPreferences = decode(&with( + json!({}), + &["costPriority", "speedPriority", "intelligencePriority"], + )); + assert_eq!(preferences, ModelPreferences::new()); + + let schema: NumberSchema = decode(&with( + json!({"type": "number"}), + &["minimum", "maximum", "default"], + )); + assert_eq!(schema, NumberSchema::new()); + } + + #[test] + fn progress_is_required() { + rejects::(r#"{"progressToken":1}"#); + rejects::(r#"{"progressToken":1,"progress":null}"#); + } + + #[rstest] + #[case::string(r#""high""#)] + #[case::out_of_range("1e400")] + fn fields_reject_anything_but_a_finite_number(#[case] n: &str) { + rejects::(&format!(r#"{{"priority":{n}}}"#)); + rejects::(&format!( + r#"{{"progressToken":1,"progress":{n}}}"# + )); + rejects::(&format!( + r#"{{"progressToken":1,"progress":0,"total":{n}}}"# + )); + rejects::(&format!( + r#"{{"messages":[],"maxTokens":1,"temperature":{n}}}"# + )); + for key in ["costPriority", "speedPriority", "intelligencePriority"] { + rejects::(&format!(r#"{{"{key}":{n}}}"#)); + } + for key in ["minimum", "maximum", "default"] { + rejects::(&format!(r#"{{"type":"number","{key}":{n}}}"#)); + } + } + } +} diff --git a/vendor/rmcp/src/model/task.rs b/vendor/rmcp/src/model/task.rs new file mode 100644 index 00000000..bbdd1c99 --- /dev/null +++ b/vendor/rmcp/src/model/task.rs @@ -0,0 +1,544 @@ +//! Task types for the MCP Tasks extension (SEP-2663). +//! +//! Tasks are defined by the official `io.modelcontextprotocol/tasks` extension. +//! A server may respond to a supported request (currently `tools/call`) with a +//! [`CreateTaskResult`] (`resultType: "task"`) instead of the standard result. +//! The client then polls `tasks/get`, answers in-task server-to-client requests +//! via `tasks/update`, and may signal cancellation via `tasks/cancel`. + +use serde::{Deserialize, Serialize}; + +use super::{InputRequests, JsonObject, MetaObject, ResultType}; + +/// Extension identifier for the MCP Tasks extension (SEP-2663). +pub const TASKS_EXTENSION_ID: &str = "io.modelcontextprotocol/tasks"; + +/// Canonical task lifecycle status (SEP-2663). +#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Default)] +#[serde(rename_all = "snake_case")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub enum TaskStatus { + /// The request is currently being processed. + #[default] + Working, + /// The server needs input from the client before the task can proceed. + InputRequired, + /// The request completed successfully and the result is available. + /// This includes tool calls that returned results with `isError: true`. + Completed, + /// The request failed due to a JSON-RPC error during execution. + Failed, + /// The request was cancelled before completion. + Cancelled, +} + +impl TaskStatus { + /// Returns `true` for terminal statuses (`completed`, `failed`, `cancelled`). + pub fn is_terminal(&self) -> bool { + matches!(self, Self::Completed | Self::Failed | Self::Cancelled) + } +} + +/// Operational metadata about ongoing work (spec `Task`, SEP-2663). +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct Task { + /// Stable identifier for this task, generated by the server. + pub task_id: String, + /// Current task status. + pub status: TaskStatus, + /// Optional message describing the current task state. + /// This MAY be exposed to the end-user or model. + #[serde(skip_serializing_if = "Option::is_none")] + pub status_message: Option, + /// ISO 8601 timestamp when the task was created. + pub created_at: String, + /// ISO 8601 timestamp when the task was last updated. + pub last_updated_at: String, + /// Time-to-live duration from creation in integer milliseconds; `None` + /// (serialized as `null`) means unlimited. The server may discard the task + /// after the TTL elapses. This value MAY change over the lifetime of a task. + pub ttl_ms: Option, + /// Suggested polling interval in integer milliseconds. Clients SHOULD honor + /// this value to avoid overwhelming the server. This value MAY change over + /// the lifetime of a task. + #[serde(skip_serializing_if = "Option::is_none")] + pub poll_interval_ms: Option, +} + +impl Task { + /// Create a new task with required fields. + pub fn new( + task_id: impl Into, + status: TaskStatus, + created_at: impl Into, + last_updated_at: impl Into, + ) -> Self { + Self { + task_id: task_id.into(), + status, + status_message: None, + created_at: created_at.into(), + last_updated_at: last_updated_at.into(), + ttl_ms: None, + poll_interval_ms: None, + } + } + + /// Set the status message. + pub fn with_status_message(mut self, status_message: impl Into) -> Self { + self.status_message = Some(status_message.into()); + self + } + + /// Set the TTL in milliseconds. `None` means unlimited retention. + pub fn with_ttl_ms(mut self, ttl_ms: u64) -> Self { + self.ttl_ms = Some(ttl_ms); + self + } + + /// Set the suggested poll interval in milliseconds. + pub fn with_poll_interval_ms(mut self, poll_interval_ms: u64) -> Self { + self.poll_interval_ms = Some(poll_interval_ms); + self + } +} + +/// Status-specific payload carried alongside the base [`Task`] fields in a +/// [`DetailedTask`]. +/// +/// Mirrors the spec's `WorkingTask` / `InputRequiredTask` / `CompletedTask` / +/// `FailedTask` / `CancelledTask` union: the variant is discriminated by the +/// `status` field on the wire, with the payload fields inlined at the top level. +#[derive(Debug, Clone, PartialEq)] +#[non_exhaustive] +pub enum TaskPayload { + /// `status: "working"` — no additional payload. + Working, + /// `status: "input_required"` — outstanding server-to-client requests. + InputRequired { + /// Server-to-client requests that need to be fulfilled during task + /// execution. Keys are arbitrary identifiers for matching requests + /// to responses, unique over the lifetime of the task. + input_requests: InputRequests, + }, + /// `status: "completed"` — the final result of the task. The structure + /// matches the result type of the original request (e.g. `CallToolResult`). + Completed { + /// The final result of the original request. + result: JsonObject, + }, + /// `status: "failed"` — the JSON-RPC error that caused the task to fail. + Failed { + /// The JSON-RPC error object. + error: JsonObject, + }, + /// `status: "cancelled"` — no additional payload. + Cancelled, +} + +impl TaskPayload { + /// The [`TaskStatus`] this payload corresponds to. + pub fn status(&self) -> TaskStatus { + match self { + Self::Working => TaskStatus::Working, + Self::InputRequired { .. } => TaskStatus::InputRequired, + Self::Completed { .. } => TaskStatus::Completed, + Self::Failed { .. } => TaskStatus::Failed, + Self::Cancelled => TaskStatus::Cancelled, + } + } +} + +/// A task with its status-specific payload inlined (spec `DetailedTask`). +/// +/// Used by `tasks/get` responses ([`GetTaskResult`]) and `notifications/tasks` +/// ([`TaskStatusNotificationParams`](crate::model::TaskStatusNotificationParams)). +/// On the wire, the payload fields (`inputRequests` / `result` / `error`) are +/// flattened at the top level next to the base [`Task`] fields, and `status` +/// discriminates the variant. +#[derive(Debug, Clone, PartialEq)] +#[non_exhaustive] +pub struct DetailedTask { + /// Base task metadata. Its `status` always agrees with the payload. + pub task: Task, + /// Status-specific payload. + pub payload: TaskPayload, +} + +impl DetailedTask { + /// Build a `DetailedTask`, forcing `task.status` to match the payload. + pub fn new(mut task: Task, payload: TaskPayload) -> Self { + task.status = payload.status(); + Self { task, payload } + } + + /// The current status. + pub fn status(&self) -> TaskStatus { + self.task.status + } +} + +// Wire shape helper: base Task fields + optional payload fields, all flattened. +#[derive(Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +struct DetailedTaskWire { + #[serde(flatten)] + task: Task, + #[serde(skip_serializing_if = "Option::is_none")] + input_requests: Option, + #[serde(skip_serializing_if = "Option::is_none")] + result: Option, + #[serde(skip_serializing_if = "Option::is_none")] + error: Option, +} + +impl From for DetailedTaskWire { + fn from(value: DetailedTask) -> Self { + let DetailedTask { task, payload } = value; + let (input_requests, result, error) = match payload { + TaskPayload::Working | TaskPayload::Cancelled => (None, None, None), + TaskPayload::InputRequired { input_requests } => (Some(input_requests), None, None), + TaskPayload::Completed { result } => (None, Some(result), None), + TaskPayload::Failed { error } => (None, None, Some(error)), + }; + Self { + task, + input_requests, + result, + error, + } + } +} + +impl TryFrom for DetailedTask { + type Error = String; + fn try_from(wire: DetailedTaskWire) -> Result { + let payload = match wire.task.status { + TaskStatus::Working => TaskPayload::Working, + TaskStatus::Cancelled => TaskPayload::Cancelled, + TaskStatus::InputRequired => TaskPayload::InputRequired { + input_requests: wire.input_requests.ok_or_else(|| { + "task with status \"input_required\" is missing `inputRequests`".to_owned() + })?, + }, + TaskStatus::Completed => TaskPayload::Completed { + result: wire.result.ok_or_else(|| { + "task with status \"completed\" is missing `result`".to_owned() + })?, + }, + TaskStatus::Failed => TaskPayload::Failed { + error: wire + .error + .ok_or_else(|| "task with status \"failed\" is missing `error`".to_owned())?, + }, + }; + Ok(DetailedTask { + task: wire.task, + payload, + }) + } +} + +impl Serialize for DetailedTask { + fn serialize(&self, serializer: S) -> Result { + DetailedTaskWire::from(self.clone()).serialize(serializer) + } +} + +impl<'de> Deserialize<'de> for DetailedTask { + fn deserialize>(deserializer: D) -> Result { + let wire = DetailedTaskWire::deserialize(deserializer)?; + Self::try_from(wire).map_err(serde::de::Error::custom) + } +} + +#[cfg(feature = "schemars")] +impl schemars::JsonSchema for DetailedTask { + fn schema_name() -> std::borrow::Cow<'static, str> { + "DetailedTask".into() + } + fn json_schema(generator: &mut schemars::SchemaGenerator) -> schemars::Schema { + // The actual wire shape: base Task fields plus the optional + // status-specific payload fields (inputRequests / result / error). + ::json_schema(generator) + } +} + +/// Result returned in lieu of a standard result to indicate the request will +/// be processed asynchronously (spec `CreateTaskResult`, `resultType: "task"`). +/// +/// The embedded task is the seed state for the task; the client uses +/// `task.task_id` for all subsequent `tasks/get`, `tasks/update`, and +/// `tasks/cancel` calls. +#[derive(Debug, Clone, PartialEq, Serialize)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct CreateTaskResult { + /// Always `"task"`. + pub result_type: ResultType, + /// Seed state of the newly created task, flattened at the top level. + #[serde(flatten)] + pub task: Task, + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + pub meta: Option, +} + +// Custom deserializer that requires `resultType: "task"`. Without this, +// `CreateTaskResult` would greedily match other task-shaped results (e.g. +// `tasks/get` responses, which also carry `taskId`/`status` at the top level +// but use `resultType: "complete"`) inside `#[serde(untagged)]` unions such +// as `ServerResult`. +impl<'de> Deserialize<'de> for CreateTaskResult { + fn deserialize(deserializer: D) -> Result + where + D: serde::Deserializer<'de>, + { + #[derive(Deserialize)] + #[serde(rename_all = "camelCase")] + struct Helper { + result_type: ResultType, + #[serde(flatten)] + task: Task, + #[serde(rename = "_meta", default)] + meta: Option, + } + let helper = Helper::deserialize(deserializer)?; + if !helper.result_type.is_task() { + return Err(serde::de::Error::custom( + "CreateTaskResult requires resultType to be \"task\"", + )); + } + Ok(CreateTaskResult { + result_type: helper.result_type, + task: helper.task, + meta: helper.meta, + }) + } +} + +impl CreateTaskResult { + /// Create a new `CreateTaskResult` from the seed task state. + pub fn new(task: Task) -> Self { + Self { + result_type: ResultType::TASK, + task, + meta: None, + } + } + + /// Sets the protocol-level metadata for this result. + pub fn with_meta(mut self, meta: MetaObject) -> Self { + self.meta = Some(meta); + self + } +} + +/// Response to a `tasks/get` request (spec `GetTaskResult = Result & DetailedTask`). +/// +/// `resultType` is `"complete"` — this is the standard result shape for +/// `tasks/get`, not a task handle. +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct GetTaskResult { + /// Result type discriminator. `tasks/get` responses are standard results: + /// `"complete"` (SEP-2322). Absent values deserialize as `"complete"`. + #[serde(default)] + pub result_type: ResultType, + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + pub meta: Option, + /// The task with status-specific payload inlined. + #[serde(flatten)] + pub task: DetailedTask, +} + +impl GetTaskResult { + pub fn new(task: DetailedTask) -> Self { + Self { + result_type: ResultType::COMPLETE, + meta: None, + task, + } + } +} + +/// Empty acknowledgement for `tasks/update` and `tasks/cancel` (SEP-2663). +/// +/// The spec requires these acks to be empty results carrying the SEP-2322 +/// `resultType: "complete"` discriminator; task state changes are observed +/// via the next `tasks/get`. +#[derive(Debug, Clone, PartialEq, Serialize)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct TaskAckResult { + /// Always `"complete"`. + pub result_type: ResultType, + #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")] + pub meta: Option, +} + +// Custom deserializer that requires `resultType: "complete"` and rejects any +// other fields. Without this, `TaskAckResult` would greedily match arbitrary +// result objects carrying a `resultType` key inside `#[serde(untagged)]` +// unions such as `ServerResult`, shadowing `CustomResult` and losing data. +impl<'de> Deserialize<'de> for TaskAckResult { + fn deserialize(deserializer: D) -> Result + where + D: serde::Deserializer<'de>, + { + #[derive(Deserialize)] + #[serde(rename_all = "camelCase", deny_unknown_fields)] + struct Helper { + result_type: ResultType, + #[serde(rename = "_meta", default)] + meta: Option, + } + let helper = Helper::deserialize(deserializer)?; + if !helper.result_type.is_complete() { + return Err(serde::de::Error::custom( + "TaskAckResult requires resultType to be \"complete\"", + )); + } + Ok(TaskAckResult { + result_type: helper.result_type, + meta: helper.meta, + }) + } +} + +impl Default for TaskAckResult { + fn default() -> Self { + Self { + result_type: ResultType::COMPLETE, + meta: None, + } + } +} + +impl TaskAckResult { + pub fn new() -> Self { + Self::default() + } +} + +#[cfg(test)] +mod tests { + use serde_json::json; + + use super::*; + + fn base_task(status: TaskStatus) -> Task { + Task::new( + "task-1", + status, + "2025-11-25T10:30:00Z", + "2025-11-25T10:40:00Z", + ) + .with_ttl_ms(60000) + .with_poll_interval_ms(5000) + } + + #[test] + fn create_task_result_wire_shape() { + let result = CreateTaskResult::new(base_task(TaskStatus::Working)); + let value = serde_json::to_value(&result).unwrap(); + assert_eq!( + value, + json!({ + "resultType": "task", + "taskId": "task-1", + "status": "working", + "createdAt": "2025-11-25T10:30:00Z", + "lastUpdatedAt": "2025-11-25T10:40:00Z", + "ttlMs": 60000, + "pollIntervalMs": 5000 + }) + ); + let roundtrip: CreateTaskResult = serde_json::from_value(value).unwrap(); + assert_eq!(roundtrip, result); + } + + #[test] + fn ttl_ms_null_means_unlimited() { + let mut task = base_task(TaskStatus::Working); + task.ttl_ms = None; + let value = serde_json::to_value(&task).unwrap(); + assert_eq!(value["ttlMs"], serde_json::Value::Null); + let roundtrip: Task = serde_json::from_value(value).unwrap(); + assert_eq!(roundtrip.ttl_ms, None); + } + + #[test] + fn detailed_task_completed_roundtrip() { + let detailed = DetailedTask::new( + base_task(TaskStatus::Working), + TaskPayload::Completed { + result: serde_json::from_value(json!({ + "content": [{"type": "text", "text": "ok"}], + "isError": false + })) + .unwrap(), + }, + ); + // Status is forced to match the payload. + assert_eq!(detailed.status(), TaskStatus::Completed); + let value = serde_json::to_value(&detailed).unwrap(); + assert_eq!(value["status"], "completed"); + assert_eq!(value["result"]["isError"], false); + let roundtrip: DetailedTask = serde_json::from_value(value).unwrap(); + assert_eq!(roundtrip, detailed); + } + + #[test] + fn detailed_task_input_required_requires_input_requests() { + let err = serde_json::from_value::(json!({ + "taskId": "task-1", + "status": "input_required", + "createdAt": "2025-11-25T10:30:00Z", + "lastUpdatedAt": "2025-11-25T10:40:00Z", + "ttlMs": null + })) + .unwrap_err(); + assert!(err.to_string().contains("inputRequests")); + } + + #[test] + fn detailed_task_failed_roundtrip() { + let detailed = DetailedTask::new( + base_task(TaskStatus::Failed), + TaskPayload::Failed { + error: serde_json::from_value(json!({ + "code": -32603, + "message": "boom" + })) + .unwrap(), + }, + ); + let value = serde_json::to_value(&detailed).unwrap(); + assert_eq!(value["status"], "failed"); + assert_eq!(value["error"]["code"], -32603); + let roundtrip: DetailedTask = serde_json::from_value(value).unwrap(); + assert_eq!(roundtrip, detailed); + } + + #[test] + fn get_task_result_flattens_detailed_task() { + let result = GetTaskResult::new(DetailedTask::new( + base_task(TaskStatus::Working), + TaskPayload::Working, + )); + let value = serde_json::to_value(&result).unwrap(); + assert_eq!(value["taskId"], "task-1"); + assert_eq!(value["status"], "working"); + let roundtrip: GetTaskResult = serde_json::from_value(value).unwrap(); + assert_eq!(roundtrip, result); + } +} diff --git a/vendor/rmcp/src/model/tool.rs b/vendor/rmcp/src/model/tool.rs new file mode 100644 index 00000000..be7cbbd0 --- /dev/null +++ b/vendor/rmcp/src/model/tool.rs @@ -0,0 +1,259 @@ +use std::{borrow::Cow, sync::Arc}; + +#[cfg(feature = "server")] +use schemars::JsonSchema; +/// Tools represent a routine that a server can execute +/// Tool calls represent requests from the client to execute one +use serde::{Deserialize, Serialize}; +use serde_json::Value; + +use super::{Icon, JsonObject, MetaObject}; + +/// A tool that can be used by a model. +#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct Tool { + /// The name of the tool + pub name: Cow<'static, str>, + /// A human-readable title for the tool + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + /// A description of what the tool does + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option>, + /// A JSON Schema object defining the expected parameters for the tool + pub input_schema: Arc, + /// An optional JSON Schema object defining the structure of the tool's output + #[serde(skip_serializing_if = "Option::is_none")] + pub output_schema: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + /// Optional additional tool information. + pub annotations: Option, + /// Optional list of icons for the tool + #[serde(skip_serializing_if = "Option::is_none")] + pub icons: Option>, + /// Optional additional metadata for this tool + #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] + pub meta: Option, +} + +/// Additional properties describing a Tool to clients. +/// +/// NOTE: all properties in ToolAnnotations are **hints**. +/// They are not guaranteed to provide a faithful description of +/// tool behavior (including descriptive properties like `title`). +/// +/// Clients should never make tool use decisions based on ToolAnnotations +/// received from untrusted servers. +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)] +#[serde(rename_all = "camelCase")] +#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))] +#[non_exhaustive] +pub struct ToolAnnotations { + /// A human-readable title for the tool. + #[serde(skip_serializing_if = "Option::is_none")] + pub title: Option, + + /// If true, the tool does not modify its environment. + /// + /// Default: false + #[serde(skip_serializing_if = "Option::is_none")] + pub read_only_hint: Option, + + /// If true, the tool may perform destructive updates to its environment. + /// If false, the tool performs only additive updates. + /// + /// (This property is meaningful only when `readOnlyHint == false`) + /// + /// Default: true + /// A human-readable description of the tool's purpose. + #[serde(skip_serializing_if = "Option::is_none")] + pub destructive_hint: Option, + + /// If true, calling the tool repeatedly with the same arguments + /// will have no additional effect on the its environment. + /// + /// (This property is meaningful only when `readOnlyHint == false`) + /// + /// Default: false. + #[serde(skip_serializing_if = "Option::is_none")] + pub idempotent_hint: Option, + + /// If true, this tool may interact with an "open world" of external + /// entities. If false, the tool's domain of interaction is closed. + /// For example, the world of a web search tool is open, whereas that + /// of a memory tool is not. + /// + /// Default: true + #[serde(skip_serializing_if = "Option::is_none")] + pub open_world_hint: Option, +} + +impl ToolAnnotations { + pub fn new() -> Self { + Self::default() + } + + /// Create a new ToolAnnotations with all fields specified + pub fn from_raw( + title: Option, + read_only_hint: Option, + destructive_hint: Option, + idempotent_hint: Option, + open_world_hint: Option, + ) -> Self { + ToolAnnotations { + title, + read_only_hint, + destructive_hint, + idempotent_hint, + open_world_hint, + } + } + + pub fn with_title(title: T) -> Self + where + T: Into, + { + ToolAnnotations { + title: Some(title.into()), + ..Self::default() + } + } + pub fn read_only(self, read_only: bool) -> Self { + ToolAnnotations { + read_only_hint: Some(read_only), + ..self + } + } + pub fn destructive(self, destructive: bool) -> Self { + ToolAnnotations { + destructive_hint: Some(destructive), + ..self + } + } + pub fn idempotent(self, idempotent: bool) -> Self { + ToolAnnotations { + idempotent_hint: Some(idempotent), + ..self + } + } + pub fn open_world(self, open_world: bool) -> Self { + ToolAnnotations { + open_world_hint: Some(open_world), + ..self + } + } + + /// If not set, defaults to true. + pub fn is_destructive(&self) -> bool { + self.destructive_hint.unwrap_or(true) + } + + /// If not set, defaults to false. + pub fn is_idempotent(&self) -> bool { + self.idempotent_hint.unwrap_or(false) + } +} + +impl Tool { + /// Create a new tool with the given name and description + pub fn new(name: N, description: D, input_schema: S) -> Self + where + N: Into>, + D: Into>, + S: Into>, + { + Tool { + name: name.into(), + title: None, + description: Some(description.into()), + input_schema: input_schema.into(), + output_schema: None, + annotations: None, + icons: None, + meta: None, + } + } + + /// Create a new tool with just a name and input schema (no description) + pub fn new_with_raw( + name: N, + description: Option>, + input_schema: S, + ) -> Self + where + N: Into>, + S: Into>, + { + Tool { + name: name.into(), + title: None, + description, + input_schema: input_schema.into(), + output_schema: None, + annotations: None, + icons: None, + meta: None, + } + } + + /// Set the human-readable title + pub fn with_title(mut self, title: impl Into) -> Self { + self.title = Some(title.into()); + self + } + + /// Set the output schema from a raw value + pub fn with_raw_output_schema(mut self, output_schema: Arc) -> Self { + self.output_schema = Some(output_schema); + self + } + + /// Set the annotations + pub fn with_annotations(mut self, annotations: ToolAnnotations) -> Self { + self.annotations = Some(annotations); + self + } + + /// Set the icons + pub fn with_icons(mut self, icons: Vec) -> Self { + self.icons = Some(icons); + self + } + + /// Set the metadata + pub fn with_meta(mut self, meta: MetaObject) -> Self { + self.meta = Some(meta); + self + } + + pub fn annotate(self, annotations: ToolAnnotations) -> Self { + Tool { + annotations: Some(annotations), + ..self + } + } + + /// Set the output schema using a type that implements JsonSchema + #[cfg(feature = "server")] + pub fn with_output_schema(mut self) -> Self { + self.output_schema = Some(crate::handler::server::tool::schema_for_output::()); + self + } + + /// Set the input schema using a type that implements JsonSchema + #[cfg(feature = "server")] + pub fn with_input_schema(mut self) -> Self { + self.input_schema = crate::handler::server::tool::schema_for_input::() + .unwrap_or_else(|e| panic!("Invalid input schema for tool '{}': {}", self.name, e)); + self + } + + /// Get the schema as json value + pub fn schema_as_json_value(&self) -> Value { + Value::Object(self.input_schema.as_ref().clone()) + } +} diff --git a/vendor/rmcp/src/service.rs b/vendor/rmcp/src/service.rs new file mode 100644 index 00000000..8fcf9b41 --- /dev/null +++ b/vendor/rmcp/src/service.rs @@ -0,0 +1,1935 @@ +use std::{borrow::Cow, sync::OnceLock}; + +use futures::FutureExt; +#[cfg(not(feature = "local"))] +use futures::future::BoxFuture; +#[cfg(feature = "local")] +use futures::future::LocalBoxFuture; +use thiserror::Error; + +// --------------------------------------------------------------------------- +// Conditional Send helpers +// +// `MaybeSend` – supertrait alias: `Send + Sync` without `local`, empty with `local` +// `MaybeSendFuture` – future bound alias: `Send` without `local`, empty with `local` +// `MaybeBoxFuture` – boxed future type: `BoxFuture` without `local`, `LocalBoxFuture` with `local` +// --------------------------------------------------------------------------- + +#[cfg(not(feature = "local"))] +#[doc(hidden)] +pub trait MaybeSend: Send + Sync {} +#[cfg(not(feature = "local"))] +impl MaybeSend for T {} + +#[cfg(feature = "local")] +#[doc(hidden)] +pub trait MaybeSend {} +#[cfg(feature = "local")] +impl MaybeSend for T {} + +#[cfg(not(feature = "local"))] +#[doc(hidden)] +pub trait MaybeSendFuture: Send {} +#[cfg(not(feature = "local"))] +impl MaybeSendFuture for T {} + +#[cfg(feature = "local")] +#[doc(hidden)] +pub trait MaybeSendFuture {} +#[cfg(feature = "local")] +impl MaybeSendFuture for T {} + +#[cfg(not(feature = "local"))] +pub(crate) type MaybeBoxFuture<'a, T> = BoxFuture<'a, T>; +#[cfg(feature = "local")] +pub(crate) type MaybeBoxFuture<'a, T> = LocalBoxFuture<'a, T>; + +#[cfg(feature = "server")] +use crate::model::ClientNotification; +#[cfg(feature = "server")] +use crate::model::ServerJsonRpcMessage; +#[cfg(feature = "client")] +use crate::model::ServerNotification; +use crate::{ + error::ErrorData as McpError, + model::{ + CancelledNotification, CancelledNotificationParam, ClientCapabilities, Extensions, + GetExtensions, GetMeta, Implementation, JsonRpcError, JsonRpcMessage, JsonRpcNotification, + JsonRpcRequest, JsonRpcResponse, NotificationMetaObject, NumberOrString, ProgressToken, + ProtocolVersion, RequestId, RequestMetaObject, + }, + transport::{DynamicTransportError, IntoTransport, Transport}, +}; +#[cfg(feature = "client")] +mod client; +#[cfg(feature = "client")] +pub use client::*; +#[cfg(feature = "server")] +mod server; +#[cfg(feature = "server")] +pub use server::*; +#[cfg(feature = "tower")] +mod tower; +use tokio_util::sync::{CancellationToken, DropGuard}; +#[cfg(feature = "tower")] +pub use tower::*; +use tracing::{Instrument as _, instrument}; +#[derive(Error, Debug)] +#[non_exhaustive] +pub enum ServiceError { + #[error("Mcp error: {0}")] + McpError(McpError), + #[error("Transport send error: {0}")] + TransportSend(DynamicTransportError), + #[error("Transport closed")] + TransportClosed, + #[error("Unexpected response type")] + UnexpectedResponse, + #[error("subscription consumer lagged behind its {capacity}-message buffer")] + SubscriptionLagged { capacity: usize }, + #[error("task cancelled for reason {}", reason.as_deref().unwrap_or(""))] + Cancelled { reason: Option }, + #[error("request timeout after {}", chrono::Duration::from_std(*timeout).unwrap_or_default())] + Timeout { timeout: Duration }, + /// The peer kept returning `input_required` beyond the configured round cap. + #[error("input_required did not complete within {max_rounds} MRTR rounds")] + InputRequiredRoundsExceeded { max_rounds: usize }, +} + +trait TransferObject: + std::fmt::Debug + Clone + serde::Serialize + serde::de::DeserializeOwned + Send + Sync + 'static +{ +} + +impl TransferObject for T where + T: std::fmt::Debug + + serde::Serialize + + serde::de::DeserializeOwned + + Send + + Sync + + 'static + + Clone +{ +} + +#[allow(private_bounds, reason = "there's no the third implementation")] +pub trait ServiceRole: std::fmt::Debug + Send + Sync + 'static + Copy + Clone { + type Req: TransferObject + GetMeta + GetExtensions; + type Resp: TransferObject; + type Not: TryInto + + From + + TransferObject; + type PeerReq: TransferObject + GetMeta + GetExtensions; + type PeerResp: TransferObject; + type PeerNot: TryInto + + From + + TransferObject + + GetMeta + + GetExtensions; + type InitializeError; + const IS_CLIENT: bool; + type Info: TransferObject; + type PeerInfo: TransferObject; + #[doc(hidden)] + fn configure_direct_peer(_peer: &Peer, _info: &Self::Info) {} + #[doc(hidden)] + fn peer_cancelled_params(_notification: &Self::PeerNot) -> Option<&CancelledNotificationParam> { + None + } + #[doc(hidden)] + fn peer_cancels_subscriptions(_peer: &Peer) -> bool { + false + } + #[doc(hidden)] + fn is_subscription_request(_request: &Self::Req) -> bool { + false + } + /// Invalidate any response cache affected by an inbound peer notification. + /// + /// The serve loop calls this for every notification *before* subscription + /// routing, so cache invalidation still runs when a notification is + /// delivered through a `listen` subscription channel rather than the + /// [`Service::handle_notification`] callbacks. + #[doc(hidden)] + fn invalidate_response_cache( + _peer: &Peer, + _notification: &Self::PeerNot, + ) -> impl Future + MaybeSendFuture { + async {} + } + + #[doc(hidden)] + fn enforce_request_association( + _request: &Self::Req, + _peer_info: Option<&Self::PeerInfo>, + _in_request_handler_scope: bool, + ) -> Result<(), ServiceError> { + Ok(()) + } + + /// Receive-side counterpart of [`Self::enforce_request_association`]: + /// SEP-2260 says clients receiving a server-to-client request with no + /// associated outbound request should reject it with invalid params. An + /// error return is sent back to the peer instead of dispatching to the + /// handler. + #[doc(hidden)] + fn enforce_peer_request_association( + _peer_request: &Self::PeerReq, + _peer_info: Option<&Self::PeerInfo>, + _association: PeerRequestAssociation, + ) -> Result<(), McpError> { + Ok(()) + } +} + +/// How an inbound peer request relates to this side's in-flight outbound +/// requests (SEP-2260). +/// +/// SEP-2260 defines no wire field for association, so only stream-separating +/// transports (streamable HTTP) can observe it; other transports yield +/// [`Self::Unknown`]. +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +#[expect(clippy::exhaustive_enums, reason = "intentionally exhaustive")] +pub enum PeerRequestAssociation { + /// Arrived on the response stream of an in-flight outbound request. + Associated, + /// Arrived on a stream tied to no in-flight outbound request (e.g. the + /// streamable HTTP standalone GET stream). + Unassociated, + /// The transport cannot distinguish streams; only the coarse in-flight + /// signal is available. + Unknown { has_pending_outbound_request: bool }, +} + +pub(crate) fn uses_legacy_lifecycle( + protocol_version: Option<&ProtocolVersion>, + uses_discover_lifecycle: bool, +) -> bool { + !uses_discover_lifecycle && protocol_version.is_none_or(ProtocolVersion::has_initialize) +} + +pub(crate) fn peer_request_association( + request: &Req, + local_responder_pool: &std::collections::HashMap, +) -> PeerRequestAssociation { + match request.extensions().get::() { + None => PeerRequestAssociation::Unknown { + has_pending_outbound_request: !local_responder_pool.is_empty(), + }, + Some(InboundStreamOrigin::Unassociated) => PeerRequestAssociation::Unassociated, + Some(InboundStreamOrigin::OutboundRequest(id)) => { + if local_responder_pool.contains_key(id) { + PeerRequestAssociation::Associated + } else { + PeerRequestAssociation::Unassociated + } + } + } +} + +tokio::task_local! { + pub(crate) static ORIGINATING_REQUEST: RequestId; +} + +pub(crate) fn in_request_handler_scope() -> bool { + ORIGINATING_REQUEST.try_with(|_| ()).is_ok() +} + +/// Marker in an outbound request's non-serialized [`Extensions`] identifying +/// the in-flight peer request it was issued from (SEP-2260). Attached for both +/// roles whenever a request is sent from within a request handler; the +/// streamable HTTP server reads it to deliver server-initiated requests on the +/// originating request's SSE stream. Never on the wire (SEP-2260 defines no +/// wire field), so session managers that serialize messages between processes +/// lose it and such requests fall back to the standalone stream with a warning. +/// +/// # Caller requirements +/// +/// From protocol version `2026-07-28`, server-to-client sampling, roots, and +/// elicitation requests must be issued while handling a client request; +/// outside a handler they return an `invalid_request` error. The association +/// is task-local and does not cross `tokio::spawn`, so use the task manager +/// for long-running work. +/// +/// The client receive-side mirror is [`InboundStreamOrigin`]. +#[derive(Debug, Clone, PartialEq, Eq)] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct OriginatingRequestId(pub RequestId); + +/// Marker in an inbound request's non-serialized [`Extensions`] recording +/// which HTTP response stream it arrived on: the receive-side mirror of +/// [`OriginatingRequestId`]. Never on the wire (SEP-2260 defines no wire +/// field); when absent, the coarse in-flight check applies. +#[derive(Debug, Clone, PartialEq, Eq)] +#[expect(clippy::exhaustive_enums, reason = "intentionally exhaustive")] +pub enum InboundStreamOrigin { + /// The standalone GET stream, or a POST response stream not tied to an + /// outbound request. + Unassociated, + /// The SSE response stream of the POST that carried this outbound request. + OutboundRequest(RequestId), +} + +pub type TxJsonRpcMessage = + JsonRpcMessage<::Req, ::Resp, ::Not>; +pub type RxJsonRpcMessage = JsonRpcMessage< + ::PeerReq, + ::PeerResp, + ::PeerNot, +>; + +#[cfg(not(feature = "local"))] +pub trait Service: Send + Sync + 'static { + fn handle_request( + &self, + request: R::PeerReq, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_; + fn handle_notification( + &self, + notification: R::PeerNot, + context: NotificationContext, + ) -> impl Future> + MaybeSendFuture + '_; + fn get_info(&self) -> R::Info; + /// The protocol versions this service can speak, bounding what `initialize` + /// negotiation may agree to. + /// + /// Servers normally override + /// [`ServerHandler::supported_protocol_versions`] instead of this method; + /// the blanket `Service` impl forwards to it. This method exists so the + /// transport and handshake layers, which see only a `Service`, can read the + /// list and avoid agreeing to a version the server cannot serve. + /// + /// [`ServerHandler::supported_protocol_versions`]: crate::handler::server::ServerHandler::supported_protocol_versions + fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]> { + Cow::Borrowed(ProtocolVersion::KNOWN_VERSIONS) + } +} + +#[cfg(feature = "local")] +pub trait Service: 'static { + fn handle_request( + &self, + request: R::PeerReq, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_; + fn handle_notification( + &self, + notification: R::PeerNot, + context: NotificationContext, + ) -> impl Future> + MaybeSendFuture + '_; + fn get_info(&self) -> R::Info; + /// The protocol versions this service can speak. + /// + /// See the non-`local` variant of this trait for details. + fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]> { + Cow::Borrowed(ProtocolVersion::KNOWN_VERSIONS) + } +} + +pub trait ServiceExt: Service + Sized { + /// Convert this service to a dynamic boxed service + /// + /// This could be very helpful when you want to store the services in a collection + fn into_dyn(self) -> Box> { + Box::new(self) + } + fn serve( + self, + transport: T, + ) -> impl Future, R::InitializeError>> + MaybeSendFuture + where + T: IntoTransport, + E: std::error::Error + Send + Sync + 'static, + Self: Sized, + { + Self::serve_with_ct(self, transport, Default::default()) + } + fn serve_with_ct( + self, + transport: T, + ct: CancellationToken, + ) -> impl Future, R::InitializeError>> + MaybeSendFuture + where + T: IntoTransport, + E: std::error::Error + Send + Sync + 'static, + Self: Sized; +} + +impl Service for Box> { + fn handle_request( + &self, + request: R::PeerReq, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + DynService::handle_request(self.as_ref(), request, context) + } + + fn handle_notification( + &self, + notification: R::PeerNot, + context: NotificationContext, + ) -> impl Future> + MaybeSendFuture + '_ { + DynService::handle_notification(self.as_ref(), notification, context) + } + + fn get_info(&self) -> R::Info { + DynService::get_info(self.as_ref()) + } + + fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]> { + DynService::supported_protocol_versions(self.as_ref()) + } +} + +#[cfg(not(feature = "local"))] +pub trait DynService: Send + Sync { + fn handle_request( + &self, + request: R::PeerReq, + context: RequestContext, + ) -> MaybeBoxFuture<'_, Result>; + fn handle_notification( + &self, + notification: R::PeerNot, + context: NotificationContext, + ) -> MaybeBoxFuture<'_, Result<(), McpError>>; + fn get_info(&self) -> R::Info; + /// See [`Service::supported_protocol_versions`]. + fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]> { + Cow::Borrowed(ProtocolVersion::KNOWN_VERSIONS) + } +} + +#[cfg(feature = "local")] +pub trait DynService { + fn handle_request( + &self, + request: R::PeerReq, + context: RequestContext, + ) -> MaybeBoxFuture<'_, Result>; + fn handle_notification( + &self, + notification: R::PeerNot, + context: NotificationContext, + ) -> MaybeBoxFuture<'_, Result<(), McpError>>; + fn get_info(&self) -> R::Info; + /// See [`Service::supported_protocol_versions`]. + fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]> { + Cow::Borrowed(ProtocolVersion::KNOWN_VERSIONS) + } +} + +impl> DynService for S { + fn handle_request( + &self, + request: R::PeerReq, + context: RequestContext, + ) -> MaybeBoxFuture<'_, Result> { + Box::pin(self.handle_request(request, context)) + } + fn handle_notification( + &self, + notification: R::PeerNot, + context: NotificationContext, + ) -> MaybeBoxFuture<'_, Result<(), McpError>> { + Box::pin(self.handle_notification(notification, context)) + } + fn get_info(&self) -> R::Info { + self.get_info() + } + fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]> { + Service::supported_protocol_versions(self) + } +} + +use std::{ + collections::{HashMap, VecDeque}, + ops::Deref, + sync::{Arc, atomic::AtomicU64}, + time::Duration, +}; + +use tokio::sync::mpsc; + +pub trait RequestIdProvider: Send + Sync + 'static { + fn next_request_id(&self) -> RequestId; +} + +pub trait ProgressTokenProvider: Send + Sync + 'static { + fn next_progress_token(&self) -> ProgressToken; +} + +pub type AtomicU32RequestIdProvider = AtomicU32Provider; +pub type AtomicU32ProgressTokenProvider = AtomicU32Provider; + +pub(crate) fn remove_pending_request( + pending_requests: &mut HashMap, + response_id: &RequestId, +) -> Option { + pending_requests.remove(response_id).or_else(|| { + response_id + .numeric_string_value() + .and_then(|id| pending_requests.remove(&RequestId::Number(id))) + }) +} + +#[derive(Debug, Default)] +pub struct AtomicU32Provider { + id: AtomicU64, +} + +impl RequestIdProvider for AtomicU32Provider { + fn next_request_id(&self) -> RequestId { + let id = self.id.fetch_add(1, std::sync::atomic::Ordering::SeqCst); + // Safe conversion: we start at 0 and increment by 1, so we won't overflow i64::MAX in practice + RequestId::Number(id as i64) + } +} + +impl ProgressTokenProvider for AtomicU32Provider { + fn next_progress_token(&self) -> ProgressToken { + let id = self.id.fetch_add(1, std::sync::atomic::Ordering::SeqCst); + ProgressToken(NumberOrString::Number(id as i64)) + } +} + +#[doc(hidden)] +pub trait ProgressNotificationToken { + fn progress_token(&self) -> Option<&ProgressToken>; +} + +#[cfg(feature = "server")] +impl ProgressNotificationToken for ClientNotification { + fn progress_token(&self) -> Option<&ProgressToken> { + match self { + ClientNotification::ProgressNotification(notification) => { + Some(¬ification.params.progress_token) + } + _ => None, + } + } +} + +#[cfg(feature = "client")] +impl ProgressNotificationToken for ServerNotification { + fn progress_token(&self) -> Option<&ProgressToken> { + match self { + ServerNotification::ProgressNotification(notification) => { + Some(¬ification.params.progress_token) + } + _ => None, + } + } +} + +type Responder = tokio::sync::oneshot::Sender; +struct PendingResponse { + responder: Responder, + is_subscription: bool, +} +type ProgressTimeoutWatchers = Arc>>>; +type SubscriptionChannel = (mpsc::Sender, usize); +type SubscriptionChannelMap = HashMap>; + +/// A handle to a remote request +/// +/// You can cancel it by call [`RequestHandle::cancel`] with a reason, +/// +/// or wait for response by call [`RequestHandle::await_response`] +#[derive(Debug)] +#[non_exhaustive] +pub struct RequestHandle { + pub rx: tokio::sync::oneshot::Receiver>, + pub options: PeerRequestOptions, + pub peer: Peer, + pub id: RequestId, + pub progress_token: ProgressToken, + progress_reset_rx: Option>, +} + +impl RequestHandle { + pub const REQUEST_TIMEOUT_REASON: &str = "request timeout"; + pub const REQUEST_MAX_TOTAL_TIMEOUT_REASON: &str = "maximum total timeout exceeded"; + + pub async fn await_response(mut self) -> Result { + let timeout = self.options.timeout; + let max_total_timeout = self.options.max_total_timeout; + let reset_timeout_on_progress = self.options.reset_timeout_on_progress; + + let has_progress_reset_rx = self.progress_reset_rx.is_some(); + let progress_token = self.progress_token.clone(); + + let result = match (timeout, max_total_timeout, reset_timeout_on_progress) { + (Some(timeout), None, false) => match tokio::time::timeout(timeout, &mut self.rx).await + { + Ok(response) => response.map_err(|_e| ServiceError::TransportClosed)?, + Err(_) => { + let error = Err(ServiceError::Timeout { timeout }); + // cancel this request + self.send_timeout_cancel_notification(Self::REQUEST_TIMEOUT_REASON) + .await; + error + } + }, + (None, None, _) => (&mut self.rx) + .await + .map_err(|_e| ServiceError::TransportClosed)?, + _ => { + self.await_response_with_progress_timeout( + timeout, + max_total_timeout, + reset_timeout_on_progress, + ) + .await + } + }; + + Self::cleanup_progress_timeout_watcher( + &self.peer.progress_timeout_watchers, + &progress_token, + has_progress_reset_rx, + ) + .await; + self.peer.unregister_subscription(&self.id); + result + } + + async fn send_timeout_cancel_notification(&self, reason: &str) { + self.peer.unregister_subscription(&self.id); + let notification = CancelledNotification { + params: CancelledNotificationParam { + request_id: Some(self.id.clone()), + reason: Some(reason.to_owned()), + meta: None, + }, + method: crate::model::CancelledNotificationMethod, + extensions: Default::default(), + }; + let _ = self.peer.send_notification(notification.into()).await; + } + + async fn await_response_with_progress_timeout( + &mut self, + timeout: Option, + max_total_timeout: Option, + reset_timeout_on_progress: bool, + ) -> Result { + let mut idle_sleep = + timeout.map(|timeout| (timeout, Box::pin(tokio::time::sleep(timeout)))); + let mut max_total_sleep = + max_total_timeout.map(|timeout| (timeout, Box::pin(tokio::time::sleep(timeout)))); + + loop { + tokio::select! { + biased; + + response = &mut self.rx => { + return response.map_err(|_e| ServiceError::TransportClosed)?; + } + _ = async { + if let Some((_, sleep)) = idle_sleep.as_mut() { + sleep.as_mut().await; + } + }, if idle_sleep.is_some() => { + if let Some((timeout, _)) = idle_sleep.as_ref() { + self.send_timeout_cancel_notification(Self::REQUEST_TIMEOUT_REASON).await; + return Err(ServiceError::Timeout { timeout: *timeout }); + } + } + _ = async { + if let Some((_, sleep)) = max_total_sleep.as_mut() { + sleep.as_mut().await; + } + }, if max_total_sleep.is_some() => { + if let Some((timeout, _)) = max_total_sleep.as_ref() { + self.send_timeout_cancel_notification(Self::REQUEST_MAX_TOTAL_TIMEOUT_REASON).await; + return Err(ServiceError::Timeout { timeout: *timeout }); + } + } + progress = async { + match self.progress_reset_rx.as_mut() { + Some(rx) => rx.recv().await, + None => None, + } + }, if reset_timeout_on_progress && idle_sleep.is_some() && self.progress_reset_rx.is_some() => { + if progress.is_some() + && let Some((timeout, sleep)) = idle_sleep.as_mut() { + sleep.as_mut().reset(tokio::time::Instant::now() + *timeout); + } + } + } + } + } + + /// Cancel this request + pub async fn cancel(self, reason: Option) -> Result<(), ServiceError> { + Self::cleanup_progress_timeout_watcher( + &self.peer.progress_timeout_watchers, + &self.progress_token, + self.progress_reset_rx.is_some(), + ) + .await; + self.peer.unregister_subscription(&self.id); + let notification = CancelledNotification { + params: CancelledNotificationParam { + request_id: Some(self.id), + reason, + meta: None, + }, + method: crate::model::CancelledNotificationMethod, + extensions: Default::default(), + }; + self.peer.send_notification(notification.into()).await?; + Ok(()) + } + + async fn cleanup_progress_timeout_watcher( + progress_timeout_watchers: &ProgressTimeoutWatchers, + progress_token: &ProgressToken, + has_progress_reset_rx: bool, + ) { + if has_progress_reset_rx { + progress_timeout_watchers + .write() + .await + .remove(progress_token); + } + } +} + +#[derive(Debug)] +pub(crate) enum PeerSinkMessage { + Request { + request: R::Req, + id: RequestId, + responder: Responder>, + }, + Notification { + notification: R::Not, + responder: Responder>, + }, +} + +#[derive(Debug, Clone)] +pub(crate) struct ClientRequestMetadata { + pub protocol_version: ProtocolVersion, + pub client_info: Implementation, + pub client_capabilities: ClientCapabilities, +} + +/// An interface to fetch the remote client or server +/// +/// For general purpose, call [`Peer::send_request`] or [`Peer::send_notification`] to send message to remote peer. +/// +/// To create a cancellable request, call [`Peer::send_request_with_option`]. +pub struct Peer { + tx: mpsc::Sender>, + request_id_provider: Arc, + progress_token_provider: Arc, + progress_timeout_watchers: ProgressTimeoutWatchers, + info: Arc>>>, + client_request_metadata: Arc>, + request_metadata_required: Arc, + subscription_channels: Arc>>, + #[cfg(feature = "client")] + response_cache: client::cache::PeerResponseCache, +} + +impl Clone for Peer +where + R::PeerInfo: Clone, +{ + fn clone(&self) -> Peer { + Self { + tx: self.tx.clone(), + request_id_provider: self.request_id_provider.clone(), + progress_token_provider: self.progress_token_provider.clone(), + progress_timeout_watchers: self.progress_timeout_watchers.clone(), + info: self.info.clone(), + client_request_metadata: self.client_request_metadata.clone(), + request_metadata_required: self.request_metadata_required.clone(), + subscription_channels: self.subscription_channels.clone(), + #[cfg(feature = "client")] + response_cache: self.response_cache.clone(), + } + } +} + +impl std::fmt::Debug for Peer { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("PeerSink") + .field("tx", &self.tx) + .field("is_client", &R::IS_CLIENT) + .finish() + } +} + +type ProxyOutbound = mpsc::Receiver>; + +#[derive(Debug, Default)] +#[non_exhaustive] +pub struct PeerRequestOptions { + pub timeout: Option, + pub meta: Option, + /// Reset the request timeout when a matching progress notification is received. + pub reset_timeout_on_progress: bool, + /// Maximum total time to wait for the request, regardless of progress notifications. + pub max_total_timeout: Option, +} + +impl PeerRequestOptions { + pub fn no_options() -> Self { + Self::default() + } + + pub fn with_timeout(timeout: Duration) -> Self { + Self { + timeout: Some(timeout), + ..Self::default() + } + } + + /// Adds request metadata while preserving any other configured options. + /// + /// Explicit values take precedence over discover-lifecycle metadata defaults. + pub fn with_meta(mut self, meta: RequestMetaObject) -> Self { + self.meta = Some(meta); + self + } + + pub fn reset_timeout_on_progress(mut self) -> Self { + self.reset_timeout_on_progress = true; + self + } + + pub fn with_max_total_timeout(mut self, timeout: Duration) -> Self { + self.max_total_timeout = Some(timeout); + self + } +} + +impl Peer { + const CLIENT_CHANNEL_BUFFER_SIZE: usize = 1024; + pub(crate) fn new( + request_id_provider: Arc, + peer_info: Option, + ) -> (Peer, ProxyOutbound) { + let (tx, rx) = mpsc::channel(Self::CLIENT_CHANNEL_BUFFER_SIZE); + ( + Self { + tx, + request_id_provider, + progress_token_provider: Arc::new(AtomicU32ProgressTokenProvider::default()), + progress_timeout_watchers: Default::default(), + info: Arc::new(std::sync::RwLock::new(peer_info.map(Arc::new))), + client_request_metadata: Default::default(), + request_metadata_required: Default::default(), + subscription_channels: Default::default(), + #[cfg(feature = "client")] + response_cache: Default::default(), + }, + rx, + ) + } + pub async fn send_notification(&self, notification: R::Not) -> Result<(), ServiceError> { + let (responder, receiver) = tokio::sync::oneshot::channel(); + self.tx + .send(PeerSinkMessage::Notification { + notification, + responder, + }) + .await + .map_err(|_m| ServiceError::TransportClosed)?; + receiver.await.map_err(|_e| ServiceError::TransportClosed)? + } + pub async fn send_request(&self, request: R::Req) -> Result { + self.send_request_with_option(request, PeerRequestOptions::no_options()) + .await? + .await_response() + .await + } + + pub async fn send_cancellable_request( + &self, + request: R::Req, + options: PeerRequestOptions, + ) -> Result, ServiceError> { + self.send_request_with_option(request, options).await + } + + pub async fn send_request_with_option( + &self, + request: R::Req, + options: PeerRequestOptions, + ) -> Result, ServiceError> { + self.send_request_with_option_and_subscription(request, options, None) + .await + } + + async fn send_request_with_option_and_subscription( + &self, + mut request: R::Req, + options: PeerRequestOptions, + subscription_sender: Option>, + ) -> Result, ServiceError> { + R::enforce_request_association( + &request, + self.peer_info().as_deref(), + in_request_handler_scope(), + )?; + if let Ok(originating) = ORIGINATING_REQUEST.try_with(|id| id.clone()) { + request + .extensions_mut() + .insert(OriginatingRequestId(originating)); + } + let id = self.request_id_provider.next_request_id(); + let progress_token = self.progress_token_provider.next_progress_token(); + if let Some(metadata) = self.client_request_metadata.get() { + let meta = request.get_meta_mut(); + meta.set_protocol_version(metadata.protocol_version.clone()); + meta.set_client_info(metadata.client_info.clone()); + meta.set_client_capabilities(metadata.client_capabilities.clone()); + } + if let Some(meta) = options.meta.clone() { + request.get_meta_mut().extend(meta); + } + request + .get_meta_mut() + .set_progress_token(progress_token.clone()); + let (responder, receiver) = tokio::sync::oneshot::channel(); + let progress_reset_rx = if options.reset_timeout_on_progress && options.timeout.is_some() { + let (sender, receiver) = mpsc::channel(1); + self.progress_timeout_watchers + .write() + .await + .insert(progress_token.clone(), sender); + Some(receiver) + } else { + None + }; + if let Some(channel) = subscription_sender { + self.subscription_channels_write() + .insert(id.clone(), channel); + } + if self + .tx + .send(PeerSinkMessage::Request { + request, + id: id.clone(), + responder, + }) + .await + .is_err() + { + if progress_reset_rx.is_some() { + self.progress_timeout_watchers + .write() + .await + .remove(&progress_token); + } + self.unregister_subscription(&id); + return Err(ServiceError::TransportClosed); + } + Ok(RequestHandle { + id, + rx: receiver, + progress_token, + options, + peer: self.clone(), + progress_reset_rx, + }) + } + + #[cfg(feature = "client")] + pub(crate) async fn send_subscription_request( + &self, + request: R::Req, + options: PeerRequestOptions, + channel_capacity: usize, + ) -> Result<(RequestHandle, mpsc::Receiver), ServiceError> { + let (sender, receiver) = mpsc::channel(channel_capacity); + let handle = self + .send_request_with_option_and_subscription( + request, + options, + Some((sender, channel_capacity)), + ) + .await?; + Ok((handle, receiver)) + } + + fn subscription_sender(&self, id: &RequestId) -> Option> { + self.subscription_channels_read().get(id).cloned() + } + + pub(crate) fn unregister_subscription(&self, id: &RequestId) { + self.subscription_channels_write().remove(id); + } + + fn subscription_channels_read( + &self, + ) -> std::sync::RwLockReadGuard<'_, SubscriptionChannelMap> { + match self.subscription_channels.read() { + Ok(channels) => channels, + Err(poisoned) => poisoned.into_inner(), + } + } + + fn subscription_channels_write( + &self, + ) -> std::sync::RwLockWriteGuard<'_, SubscriptionChannelMap> { + match self.subscription_channels.write() { + Ok(channels) => channels, + Err(poisoned) => poisoned.into_inner(), + } + } + + pub(crate) fn try_cancel_request(&self, id: RequestId, reason: Option) { + let notification = CancelledNotification { + params: CancelledNotificationParam { + request_id: Some(id), + reason, + meta: None, + }, + method: crate::model::CancelledNotificationMethod, + extensions: Default::default(), + }; + let (responder, _receiver) = tokio::sync::oneshot::channel(); + let _ = self.tx.try_send(PeerSinkMessage::Notification { + notification: notification.into(), + responder, + }); + } + + async fn notify_progress_timeout_watcher(&self, progress_token: &ProgressToken) { + let sender = self + .progress_timeout_watchers + .read() + .await + .get(progress_token) + .cloned(); + if let Some(sender) = sender { + match sender.try_send(()) { + Ok(()) => {} + Err(mpsc::error::TrySendError::Full(_)) => { + tracing::trace!(?progress_token, "progress timeout watcher channel is full"); + } + Err(mpsc::error::TrySendError::Closed(_)) => { + self.progress_timeout_watchers + .write() + .await + .remove(progress_token); + } + } + } + } + + /// Snapshot of the peer's handshake info. + pub fn peer_info(&self) -> Option> { + self.info.read().expect("peer info lock poisoned").clone() + } + + /// Stores the peer's handshake info, overwriting any previous value. + pub fn set_peer_info(&self, info: R::PeerInfo) { + *self.info.write().expect("peer info lock poisoned") = Some(Arc::new(info)); + } + + pub(crate) fn set_client_request_metadata(&self, metadata: ClientRequestMetadata) { + let result = self.client_request_metadata.set(metadata); + debug_assert!(result.is_ok(), "client request metadata set more than once"); + } + + pub(crate) fn require_request_metadata(&self) { + self.request_metadata_required + .store(true, std::sync::atomic::Ordering::Release); + } + + pub(crate) fn request_metadata_required(&self) -> bool { + self.request_metadata_required + .load(std::sync::atomic::Ordering::Acquire) + } + + pub fn is_transport_closed(&self) -> bool { + self.tx.is_closed() + } +} + +#[derive(Debug)] +pub struct RunningService> { + service: Arc, + peer: Peer, + handle: Option>, + cancellation_token: CancellationToken, + dg: DropGuard, +} +impl> Deref for RunningService { + type Target = Peer; + + fn deref(&self) -> &Self::Target { + &self.peer + } +} + +impl> RunningService { + #[inline] + pub fn peer(&self) -> &Peer { + &self.peer + } + #[inline] + pub fn service(&self) -> &S { + self.service.as_ref() + } + #[inline] + pub fn cancellation_token(&self) -> RunningServiceCancellationToken { + RunningServiceCancellationToken(self.cancellation_token.clone()) + } + + /// Returns true if the service has been closed or cancelled. + #[inline] + pub fn is_closed(&self) -> bool { + self.handle.is_none() || self.cancellation_token.is_cancelled() + } + + /// Wait for the service to complete. + /// + /// This will block until the service loop terminates (either due to + /// cancellation, transport closure, or an error). + #[inline] + pub async fn waiting(mut self) -> Result { + match self.handle.take() { + Some(handle) => handle.await, + None => Ok(QuitReason::Closed), + } + } + + /// Gracefully close the connection and wait for cleanup to complete. + /// + /// This method cancels the service, waits for the background task to finish + /// (which includes calling `transport.close()`), and ensures all cleanup + /// operations complete before returning. + /// + /// Unlike [`cancel`](Self::cancel), this method takes `&mut self` and can be + /// called without consuming the `RunningService`. After calling this method, + /// the service is considered closed and subsequent operations will fail. + /// + /// # Example + /// + /// ```rust,ignore + /// let mut client = ().serve(transport).await?; + /// // ... use the client ... + /// client.close().await?; + /// ``` + pub async fn close(&mut self) -> Result { + if let Some(handle) = self.handle.take() { + // Disarm the drop guard so it doesn't try to cancel again + // We need to cancel manually and wait for completion + self.cancellation_token.cancel(); + handle.await + } else { + // Already closed + Ok(QuitReason::Closed) + } + } + + /// Gracefully close the connection with a timeout. + /// + /// Similar to [`close`](Self::close), but returns after the specified timeout + /// if the cleanup doesn't complete in time. This is useful for ensuring + /// a bounded shutdown time. + /// + /// Returns `Ok(Some(reason))` if shutdown completed within the timeout, + /// `Ok(None)` if the timeout was reached, or `Err` if there was a join error. + pub async fn close_with_timeout( + &mut self, + timeout: Duration, + ) -> Result, tokio::task::JoinError> { + if let Some(handle) = self.handle.take() { + self.cancellation_token.cancel(); + match tokio::time::timeout(timeout, handle).await { + Ok(result) => result.map(Some), + Err(_elapsed) => { + tracing::warn!( + "close_with_timeout: cleanup did not complete within {:?}", + timeout + ); + Ok(None) + } + } + } else { + Ok(Some(QuitReason::Closed)) + } + } + + /// Cancel the service and wait for cleanup to complete. + /// + /// This consumes the `RunningService` and ensures the connection is properly + /// closed. For a non-consuming alternative, see [`close`](Self::close). + pub async fn cancel(mut self) -> Result { + // Disarm the drop guard since we're handling cancellation explicitly + let _ = std::mem::replace(&mut self.dg, self.cancellation_token.clone().drop_guard()); + self.close().await + } +} + +impl> Drop for RunningService { + fn drop(&mut self) { + if self.handle.is_some() && !self.cancellation_token.is_cancelled() { + tracing::debug!( + "RunningService dropped without explicit close(). \ + The connection will be closed asynchronously. \ + For guaranteed cleanup, call close() or cancel() before dropping." + ); + } + // The DropGuard will handle cancellation + } +} + +// use a wrapper type so we can tweak the implementation if needed +pub struct RunningServiceCancellationToken(CancellationToken); + +impl RunningServiceCancellationToken { + pub fn cancel(self) { + self.0.cancel(); + } +} + +#[derive(Debug)] +#[non_exhaustive] +pub enum QuitReason { + Cancelled, + Closed, + JoinError(tokio::task::JoinError), +} + +/// Request execution context +#[derive(Debug, Clone)] +#[non_exhaustive] +pub struct RequestContext { + /// this token will be cancelled when the [`CancelledNotification`] is received. + pub ct: CancellationToken, + pub id: RequestId, + pub meta: RequestMetaObject, + pub extensions: Extensions, + /// An interface to fetch the remote client or server + pub peer: Peer, +} + +impl RequestContext { + /// Create a new RequestContext. + pub fn new(id: RequestId, peer: Peer) -> Self { + Self { + ct: CancellationToken::new(), + id, + meta: RequestMetaObject::default(), + extensions: Extensions::default(), + peer, + } + } +} + +#[cfg(feature = "server")] +impl RequestContext { + /// The current request's protocol version, falling back to legacy handshake state. + pub fn protocol_version(&self) -> Option { + self.meta.protocol_version().or_else(|| { + self.peer + .peer_info() + .map(|info| info.protocol_version.clone()) + }) + } + + /// The current request's client implementation, falling back only for legacy sessions. + pub fn client_info(&self) -> Option { + if self.peer.request_metadata_required() { + self.meta.client_info() + } else { + self.meta + .client_info() + .or_else(|| self.peer.peer_info().map(|info| info.client_info.clone())) + } + } + + /// The current request's client capabilities, falling back only for legacy sessions. + pub fn client_capabilities(&self) -> Option { + if self.peer.request_metadata_required() { + self.meta.client_capabilities() + } else { + self.meta + .client_capabilities() + .or_else(|| self.peer.peer_info().map(|info| info.capabilities.clone())) + } + } +} + +/// Request execution context +#[derive(Debug, Clone)] +#[non_exhaustive] +pub struct NotificationContext { + pub meta: NotificationMetaObject, + pub extensions: Extensions, + /// An interface to fetch the remote client or server + pub peer: Peer, +} + +/// Use this function to skip initialization process +pub fn serve_directly( + service: S, + transport: T, + peer_info: Option, +) -> RunningService +where + R: ServiceRole, + R::PeerNot: ProgressNotificationToken, + S: Service, + T: IntoTransport, + E: std::error::Error + Send + Sync + 'static, +{ + serve_directly_with_ct(service, transport, peer_info, Default::default()) +} + +/// Use this function to skip initialization process +pub fn serve_directly_with_ct( + service: S, + transport: T, + peer_info: Option, + ct: CancellationToken, +) -> RunningService +where + R: ServiceRole, + R::PeerNot: ProgressNotificationToken, + S: Service, + T: IntoTransport, + E: std::error::Error + Send + Sync + 'static, +{ + let (peer, peer_rx) = Peer::new(Arc::new(AtomicU32RequestIdProvider::default()), peer_info); + R::configure_direct_peer(&peer, &service.get_info()); + serve_inner( + service, + transport.into_transport(), + peer, + peer_rx, + VecDeque::new(), + ct, + ) +} + +/// Spawn a task that may hold `!Send` state when the `local` feature is active. +/// +/// Without the `local` feature this is `tokio::spawn` (requires `Future: Send + 'static`). +/// With `local` it uses `tokio::task::spawn_local` (requires only `Future: 'static`). +#[cfg(not(feature = "local"))] +fn spawn_service_task(future: F) -> tokio::task::JoinHandle +where + F: Future + Send + 'static, + F::Output: Send + 'static, +{ + tokio::spawn(future) +} + +#[cfg(feature = "local")] +fn spawn_service_task(future: F) -> tokio::task::JoinHandle +where + F: Future + 'static, + F::Output: 'static, +{ + tokio::task::spawn_local(future) +} + +/// Run the service loop over `transport`. +/// +/// `initial_messages` are messages the caller already read from `transport` +/// (e.g. the first request of an `initialize`-less session). They are +/// dispatched by the loop, in order, before anything else is read from the +/// transport, so that their handlers run with the loop draining `peer_rx`. +#[instrument(skip_all)] +fn serve_inner( + service: S, + transport: T, + peer: Peer, + mut peer_rx: tokio::sync::mpsc::Receiver>, + initial_messages: VecDeque>, + ct: CancellationToken, +) -> RunningService +where + R: ServiceRole, + R::PeerNot: ProgressNotificationToken, + S: Service, + T: Transport + 'static, +{ + const SINK_PROXY_BUFFER_SIZE: usize = 64; + let (sink_proxy_tx, mut sink_proxy_rx) = + tokio::sync::mpsc::channel::>(SINK_PROXY_BUFFER_SIZE); + let peer_info = peer.peer_info(); + if R::IS_CLIENT { + tracing::info!(?peer_info, "Service initialized as client"); + } else { + tracing::info!(?peer_info, "Service initialized as server"); + } + + let mut local_responder_pool = + HashMap::>>::new(); + let mut local_ct_pool = HashMap::::new(); + let shared_service = Arc::new(service); + // for return + let service = shared_service.clone(); + + // let message_sink = tokio::sync:: + // let mut stream = std::pin::pin!(stream); + let serve_loop_ct = ct.child_token(); + let peer_return: Peer = peer.clone(); + let current_span = tracing::Span::current(); + let handle = spawn_service_task(async move { + let mut transport = transport.into_transport(); + let mut batch_messages = initial_messages; + let mut send_task_set = tokio::task::JoinSet::::new(); + let mut response_send_tasks = tokio::task::JoinSet::<()>::new(); + #[derive(Debug)] + enum SendTaskResult { + Request { + id: RequestId, + result: Result<(), DynamicTransportError>, + }, + Notification { + responder: Responder>, + cancellation_param: Option, + result: Result<(), DynamicTransportError>, + }, + } + #[derive(Debug)] + enum Event { + ProxyMessage(PeerSinkMessage), + PeerMessage(RxJsonRpcMessage), + ToSink(TxJsonRpcMessage), + SendTaskResult(SendTaskResult), + ResponseSendTaskResult(Result<(), tokio::task::JoinError>), + } + + let quit_reason = loop { + let evt = if let Some(m) = batch_messages.pop_front() { + Event::PeerMessage(m) + } else { + tokio::select! { + m = sink_proxy_rx.recv(), if !sink_proxy_rx.is_closed() => { + if let Some(m) = m { + Event::ToSink(m) + } else { + continue + } + } + m = transport.receive() => { + if let Some(m) = m { + Event::PeerMessage(m) + } else { + // input stream closed + tracing::info!("input stream terminated"); + break QuitReason::Closed + } + } + m = peer_rx.recv(), if !peer_rx.is_closed() => { + if let Some(m) = m { + Event::ProxyMessage(m) + } else { + continue + } + } + m = send_task_set.join_next(), if !send_task_set.is_empty() => { + let Some(result) = m else { + continue + }; + match result { + Err(e) => { + // join error, which is serious, we should quit. + tracing::error!(%e, "send request task encounter a tokio join error"); + break QuitReason::JoinError(e) + } + Ok(result) => { + Event::SendTaskResult(result) + } + } + } + result = response_send_tasks.join_next(), if !response_send_tasks.is_empty() => { + Event::ResponseSendTaskResult( + result.expect("non-empty response send task set") + ) + } + _ = serve_loop_ct.cancelled() => { + tracing::info!("task cancelled"); + break QuitReason::Cancelled + } + } + }; + + tracing::trace!(?evt, "new event"); + match evt { + Event::SendTaskResult(SendTaskResult::Request { id, result }) => { + if let Err(e) = result + && let Some(responder) = local_responder_pool.remove(&id) { + let _ = responder.responder.send(Err(ServiceError::TransportSend(e))); + } + } + Event::SendTaskResult(SendTaskResult::Notification { + responder, + result, + cancellation_param, + }) => { + let response = if let Err(e) = result { + Err(ServiceError::TransportSend(e)) + } else { + Ok(()) + }; + let _ = responder.send(response); + if let Some(param) = cancellation_param + && let Some(request_id) = ¶m.request_id + && let Some(responder) = local_responder_pool.remove(request_id) { + tracing::info!(id = %request_id, reason = param.reason, "cancelled"); + let _response_result = responder.responder.send(Err(ServiceError::Cancelled { + reason: param.reason.clone(), + })); + } + } + Event::ResponseSendTaskResult(result) => { + if let Err(error) = result { + tracing::error!(%error, "response send task failed"); + } + } + // response and error + Event::ToSink(m) => { + if let Some(id) = match &m { + JsonRpcMessage::Response(response) => Some(&response.id), + JsonRpcMessage::Error(error) => error.id.as_ref(), + _ => None, + } { + let Some(ct) = local_ct_pool.remove(id) else { + tracing::debug!(%id, "dropping response for cancelled request"); + continue; + }; + ct.cancel(); + let send = transport.send(m); + let current_span = tracing::Span::current(); + response_send_tasks.spawn(async move { + let send_result = send.await; + if let Err(error) = send_result { + tracing::error!(%error, "fail to response message"); + } + }.instrument(current_span)); + } + } + Event::ProxyMessage(PeerSinkMessage::Request { + request, + id, + responder, + }) => { + local_responder_pool.insert(id.clone(), PendingResponse { + responder, + is_subscription: R::is_subscription_request(&request), + }); + let send = transport.send(JsonRpcMessage::request(request, id.clone())); + { + let id = id.clone(); + let current_span = tracing::Span::current(); + send_task_set.spawn(send.map(move |r| SendTaskResult::Request { + id, + result: r.map_err(DynamicTransportError::new::), + }).instrument(current_span)); + } + } + Event::ProxyMessage(PeerSinkMessage::Notification { + notification, + responder, + }) => { + // catch cancellation notification + let mut cancellation_param = None; + let notification = match notification.try_into() { + Ok::(cancelled) => { + cancellation_param.replace(cancelled.params.clone()); + cancelled.into() + } + Err(notification) => notification, + }; + let send = transport.send(JsonRpcMessage::notification(notification)); + let current_span = tracing::Span::current(); + send_task_set.spawn(send.map(move |result| SendTaskResult::Notification { + responder, + cancellation_param, + result: result.map_err(DynamicTransportError::new::), + }).instrument(current_span)); + } + Event::PeerMessage(JsonRpcMessage::Request(JsonRpcRequest { + id, + mut request, + .. + })) => { + tracing::debug!(%id, ?request, "received request"); + if let Err(error) = R::enforce_peer_request_association( + &request, + peer.peer_info().as_deref(), + peer_request_association(&request, &local_responder_pool), + ) { + tracing::warn!(%id, message = %error.message, "rejected peer request"); + // send directly: the sink proxy path would drop the + // error since the request was never registered in + // local_ct_pool + let send = transport.send(JsonRpcMessage::error(error, Some(id))); + let current_span = tracing::Span::current(); + response_send_tasks.spawn(async move { + if let Err(error) = send.await { + tracing::error!(%error, "fail to send rejection error"); + } + }.instrument(current_span)); + continue; + } + { + let service = shared_service.clone(); + let sink = sink_proxy_tx.clone(); + let request_ct = serve_loop_ct.child_token(); + let context_ct = request_ct.child_token(); + local_ct_pool.insert(id.clone(), request_ct); + let mut extensions = Extensions::new(); + let mut meta = RequestMetaObject::new(); + // avoid clone + // swap meta firstly, otherwise progress token will be lost + std::mem::swap(&mut meta, request.get_meta_mut()); + std::mem::swap(&mut extensions, request.extensions_mut()); + let context = RequestContext { + ct: context_ct, + id: id.clone(), + peer: peer.clone(), + meta, + extensions, + }; + let current_span = tracing::Span::current(); + let handler_id = id.clone(); + spawn_service_task(async move { + let result = ORIGINATING_REQUEST + .scope(handler_id, service.handle_request(request, context)) + .await; + let response = match result { + Ok(result) => { + tracing::debug!(%id, ?result, "response message"); + JsonRpcMessage::response(result, id) + } + Err(error) => { + tracing::warn!(%id, ?error, "response error"); + JsonRpcMessage::error(error, Some(id)) + } + }; + let _send_result = sink.send(response).await; + }.instrument(current_span)); + } + } + Event::PeerMessage(JsonRpcMessage::Notification(JsonRpcNotification { + notification, + .. + })) => { + tracing::info!(?notification, "received notification"); + R::invalidate_response_cache(&peer, ¬ification).await; + let subscription_id = + if let Some(cancelled) = R::peer_cancelled_params(¬ification) { + let request_id = cancelled.request_id.clone(); + // Modern servers cancel listen requests; legacy peers cancel + // requests they originated, even when both directions share an ID. + if R::peer_cancels_subscriptions(&peer) { + if let Some(request_id) = request_id.as_ref() { + if local_responder_pool.get(request_id) + .is_some_and(|pending| pending.is_subscription) + && let Some(pending) = local_responder_pool.remove(request_id) + { + let _ = pending.responder.send(Err(ServiceError::Cancelled { + reason: cancelled.reason.clone(), + })); + } else { + tracing::debug!(%request_id, "ignoring cancellation of unknown subscription"); + continue; + } + } + request_id + } else { + if let Some(request_id) = request_id.as_ref() + && let Some(ct) = local_ct_pool.remove(request_id) + { + tracing::info!(id = %request_id, reason = cancelled.reason, "cancelled"); + ct.cancel(); + } + None + } + } else { + notification.get_meta().subscription_id() + }; + if let Some(subscription_id) = subscription_id + && let Some((sender, capacity)) = + peer.subscription_sender(&subscription_id) + { + match sender.try_send(notification) { + Ok(()) => {} + Err(mpsc::error::TrySendError::Full(_)) => { + tracing::warn!( + id = %subscription_id, + capacity, + "subscription notification buffer full" + ); + if R::IS_CLIENT + && let Some(responder) = + local_responder_pool.remove(&subscription_id) + { + let _ = responder.responder + .send(Err(ServiceError::SubscriptionLagged { capacity })); + } + peer.unregister_subscription(&subscription_id); + peer.try_cancel_request( + subscription_id, + Some("subscription notification buffer full".to_owned()), + ); + } + Err(mpsc::error::TrySendError::Closed(_)) => { + peer.unregister_subscription(&subscription_id); + peer.try_cancel_request( + subscription_id, + Some("subscription notification receiver closed".to_owned()), + ); + } + } + continue; + } + let mut notification = notification; + if let Some(progress_token) = notification.progress_token() { + peer.notify_progress_timeout_watcher(progress_token).await; + } + { + let service = shared_service.clone(); + let mut extensions = Extensions::new(); + let mut meta = NotificationMetaObject::new(); + // avoid clone + std::mem::swap(&mut extensions, notification.extensions_mut()); + std::mem::swap(&mut meta, notification.get_meta_mut()); + let context = NotificationContext { + peer: peer.clone(), + meta, + extensions, + }; + let current_span = tracing::Span::current(); + spawn_service_task(async move { + let result = service.handle_notification(notification, context).await; + if let Err(error) = result { + tracing::warn!(%error, "Error sending notification"); + } + }.instrument(current_span)); + } + } + Event::PeerMessage(JsonRpcMessage::Response(JsonRpcResponse { + result, + id, + .. + })) => { + if let Some(responder) = + remove_pending_request(&mut local_responder_pool, &id) + { + let response_result = responder.responder.send(Ok(result)); + if let Err(_error) = response_result { + tracing::warn!(%id, "Error sending response"); + } + } + } + Event::PeerMessage(JsonRpcMessage::Error(JsonRpcError { error, id, .. })) => { + let Some(id) = id else { + // MCP error responses without an id (e.g. Parse error / Invalid Request) + // can't be routed back to a pending request — log and drop. + tracing::debug!(?error, "received id-less peer error"); + continue; + }; + if let Some(responder) = + remove_pending_request(&mut local_responder_pool, &id) + { + let service_error = if error.is_transport_closed() { + ServiceError::TransportClosed + } else { + ServiceError::McpError(error) + }; + let _response_result = responder.responder.send(Err(service_error)); + if let Err(_error) = _response_result { + tracing::warn!(%id, "Error sending response"); + } + } + } + } + }; + + // Drain in-flight handler responses before closing the transport. + // When stdin EOF or cancellation arrives, spawned handler tasks may still + // be finishing. We need to: + // 1. Wait for response sends that were already spawned in the main loop + // 2. Drain any remaining handler responses from the channel + let drain_timeout = match &quit_reason { + QuitReason::Closed => Some(Duration::from_secs(5)), + QuitReason::Cancelled => Some(Duration::from_secs(2)), + _ => None, + }; + if let Some(timeout_duration) = drain_timeout { + // Drop our sender so the channel closes once all handler task + // clones finish sending their responses (or are dropped). + drop(sink_proxy_tx); + let drain_result = tokio::time::timeout(timeout_duration, async { + // First, wait for any response sends already dispatched by the + // main loop (these hold transport write futures). + while let Some(result) = response_send_tasks.join_next().await { + if let Err(error) = result { + tracing::error!(%error, "response send task failed during drain"); + } + } + // Then drain any handler responses still in the channel + // (handlers that finished after the loop broke). + while let Some(m) = sink_proxy_rx.recv().await { + if let Some(id) = match &m { + JsonRpcMessage::Response(response) => Some(&response.id), + JsonRpcMessage::Error(error) => error.id.as_ref(), + _ => None, + } { + let Some(ct) = local_ct_pool.remove(id) else { + tracing::debug!(%id, "dropping response for cancelled request"); + continue; + }; + ct.cancel(); + } + if let Err(error) = transport.send(m).await { + tracing::error!(%error, "failed to send pending response during drain"); + break; + } + } + }) + .await; + if drain_result.is_err() { + tracing::warn!("timed out draining in-flight responses"); + } + } + + let sink_close_result = transport.close().await; + if let Err(e) = sink_close_result { + tracing::error!(%e, "fail to close sink"); + } + tracing::info!(?quit_reason, "serve finished"); + quit_reason + }.instrument(current_span)); + RunningService { + service, + peer: peer_return, + handle: Some(handle), + cancellation_token: ct.clone(), + dg: ct.drop_guard(), + } +} + +#[cfg(all(test, feature = "server"))] +mod sep2260_marker_tests { + use std::sync::Arc; + + use super::*; + use crate::model::{PingRequest, RequestId, ServerRequest}; + + fn ping() -> ServerRequest { + ServerRequest::PingRequest(PingRequest { + method: Default::default(), + extensions: Default::default(), + }) + } + + async fn send_and_capture(scope: Option) -> ::Req { + // peer_info None keeps enforcement non-strict; only the sink message matters. + let (peer, mut rx) = + Peer::::new(Arc::new(AtomicU32RequestIdProvider::default()), None); + let send = peer.send_request_with_option(ping(), PeerRequestOptions::no_options()); + let _handle = match scope { + Some(id) => ORIGINATING_REQUEST.scope(id, send).await.unwrap(), + None => send.await.unwrap(), + }; + let PeerSinkMessage::Request { request, .. } = rx.recv().await.expect("sink message") + else { + panic!("expected a request sink message"); + }; + request + } + + #[tokio::test] + async fn outbound_request_carries_originating_id_when_in_scope() { + let request = send_and_capture(Some(RequestId::Number(7))).await; + let marker = request + .extensions() + .get::() + .expect("marker attached"); + assert_eq!(marker.0, RequestId::Number(7)); + } + + #[tokio::test] + async fn outbound_request_has_no_marker_outside_scope() { + let request = send_and_capture(None).await; + assert!(request.extensions().get::().is_none()); + } + + #[test] + #[expect( + deprecated, + reason = "Sampling is deprecated by SEP-2577 but remains the canonical restricted request" + )] + fn peer_request_association_maps_stream_origin() { + use std::collections::HashMap; + + use crate::model::{ + CreateMessageRequest, CreateMessageRequestParams, SamplingMessage, ServerRequest, + }; + + fn sampling(origin: Option) -> ServerRequest { + let mut request = CreateMessageRequest::new(CreateMessageRequestParams::new( + vec![SamplingMessage::user_text("hi")], + 16, + )); + if let Some(origin) = origin { + request.extensions.insert(origin); + } + ServerRequest::CreateMessageRequest(request) + } + + let empty: HashMap = HashMap::new(); + let in_flight: HashMap = HashMap::from([(RequestId::Number(7), ())]); + + // No marker (stdio): coarse signal. + assert_eq!( + peer_request_association(&sampling(None), &in_flight), + PeerRequestAssociation::Unknown { + has_pending_outbound_request: true + } + ); + assert_eq!( + peer_request_association(&sampling(None), &empty), + PeerRequestAssociation::Unknown { + has_pending_outbound_request: false + } + ); + // Standalone GET stream: unassociated even with requests in flight. + assert_eq!( + peer_request_association( + &sampling(Some(InboundStreamOrigin::Unassociated)), + &in_flight + ), + PeerRequestAssociation::Unassociated + ); + // Originating POST stream of an in-flight request: associated. + assert_eq!( + peer_request_association( + &sampling(Some(InboundStreamOrigin::OutboundRequest( + RequestId::Number(7) + ))), + &in_flight + ), + PeerRequestAssociation::Associated + ); + // Stream of a request that is no longer in flight: unassociated. + assert_eq!( + peer_request_association( + &sampling(Some(InboundStreamOrigin::OutboundRequest( + RequestId::Number(8) + ))), + &in_flight + ), + PeerRequestAssociation::Unassociated + ); + } +} diff --git a/vendor/rmcp/src/service/client.rs b/vendor/rmcp/src/service/client.rs new file mode 100644 index 00000000..5dad6554 --- /dev/null +++ b/vendor/rmcp/src/service/client.rs @@ -0,0 +1,2738 @@ +// Sampling/Roots/Logging are SEP-2577-deprecated; internal references are expected. +#![expect(deprecated)] +pub(super) mod cache; + +use std::{borrow::Cow, num::NonZeroUsize, sync::Arc, time::Duration}; + +use cache::CacheGeneration; +pub use cache::{ClientCacheConfig, MAX_CLIENT_CACHE_TTL}; +use thiserror::Error; + +use super::*; +use crate::{ + model::{ + ArgumentInfo, CacheScope, CallToolRequest, CallToolRequestParams, CallToolResponse, + CallToolResult, CancelTaskParams, CancelTaskRequest, CancelledNotification, + CancelledNotificationParam, ClientConfig, ClientJsonRpcMessage, ClientNotification, + ClientRequest, ClientResult, CompleteRequest, CompleteRequestParams, CompleteResult, + CompletionContext, CompletionInfo, DEFAULT_MRTR_MAX_ROUNDS, DiscoverRequest, + DiscoverRequestParams, DiscoverResult, ErrorData, GetExtensions, GetMeta, GetPromptRequest, + GetPromptRequestParams, GetPromptResponse, GetPromptResult, GetTaskParams, GetTaskRequest, + GetTaskResult, InitializeRequest, InitializeRequestParams, InitializedNotification, + InputRequest, InputRequiredResult, InputResponses, JsonRpcResponse, ListPromptsRequest, + ListPromptsResult, ListResourceTemplatesRequest, ListResourceTemplatesResult, + ListResourcesRequest, ListResourcesResult, ListToolsRequest, ListToolsResult, + NumberOrString, PaginatedRequestParams, ProgressNotification, ProgressNotificationParam, + ProtocolVersion, ReadResourceRequest, ReadResourceRequestParams, ReadResourceResponse, + ReadResourceResult, Reference, RequestId, RequestMetaObject, RootsListChangedNotification, + ServerJsonRpcMessage, ServerNotification, ServerPeerInfo, ServerRequest, ServerResult, + SetLevelRequest, SetLevelRequestParams, SubscribeRequest, SubscribeRequestParams, + SubscriptionFilter, SubscriptionsListenRequest, SubscriptionsListenRequestParams, + SubscriptionsListenResult, UnsubscribeRequest, UnsubscribeRequestParams, UpdateTaskParams, + UpdateTaskRequest, + }, + transport::DynamicTransportError, +}; + +/// It represents the error that may occur when serving the client. +/// +/// if you want to handle the error, you can use `serve_client_with_ct` or `serve_client` with `Result, ClientError>` +#[derive(Error, Debug)] +#[non_exhaustive] +pub enum ClientInitializeError { + #[error("expect initialized response, but received: {0:?}")] + ExpectedInitResponse(Option), + + #[error("expect initialized result, but received: {0:?}")] + ExpectedInitResult(Option), + + #[error("conflict initialized response id: expected {0}, got {1}")] + ConflictInitResponseId(RequestId, RequestId), + + #[error( + "uncorrelated error response: expected id {expected}, error response carried {received}" + )] + UncorrelatedErrorResponse { + expected: RequestId, + received: RequestId, + }, + + #[error("connection closed: {0}")] + ConnectionClosed(String), + + #[error("Send message error {error}, when {context}")] + TransportError { + error: DynamicTransportError, + context: Cow<'static, str>, + }, + + #[error("JSON-RPC error: {0}")] + JsonRpcError(ErrorData), + + #[error( + "no compatible protocol version (client: {client_supported:?}, server: {server_supported:?})" + )] + NoCompatibleProtocolVersion { + client_supported: Vec, + server_supported: Vec, + }, + + #[error("discover startup requires at least one preferred protocol version")] + NoPreferredProtocolVersion, + + #[error("Cancelled")] + Cancelled, + + #[error("discover and legacy initialize both failed")] + LegacyFallbackFailed { + discover: Box, + fallback: Box, + }, +} + +impl ClientInitializeError { + pub fn transport + 'static>( + error: T::Error, + context: impl Into>, + ) -> Self { + Self::TransportError { + error: DynamicTransportError::new::(error), + context: context.into(), + } + } + + /// The `WWW-Authenticate` challenge from the 401/403 the transport hit + /// during initialization, if that is why initialization failed. + /// + /// This is the trigger of the reactive OAuth flow: feed the challenge to + /// `AuthorizationRequest::with_challenge` to authorize, then reconnect. + #[cfg(feature = "transport-streamable-http-client")] + pub fn auth_challenge(&self) -> Option<&str> { + use crate::transport::streamable_http_client::{AuthRequiredError, InsufficientScopeError}; + + let error = match self { + Self::TransportError { error, .. } => error, + // A 401/403 in the fallback phase is still actionable. + Self::LegacyFallbackFailed { fallback, .. } => { + return fallback.auth_challenge(); + } + _ => return None, + }; + let mut source: Option<&(dyn std::error::Error + 'static)> = Some(error.error.as_ref()); + while let Some(current) = source { + if let Some(auth_required) = current.downcast_ref::() { + return Some(&auth_required.www_authenticate_header); + } + if let Some(insufficient_scope) = current.downcast_ref::() { + return Some(&insufficient_scope.www_authenticate_header); + } + source = current.source(); + } + None + } + + /// Returns whether client initialization failed because authorization is required. + /// + /// This covers both missing or expired local OAuth authorization and an HTTP + /// authorization challenge from the MCP server. + pub fn is_authorization_required(&self) -> bool { + match self { + Self::TransportError { error, .. } => error.is_authorization_required(), + Self::LegacyFallbackFailed { fallback, .. } => fallback.is_authorization_required(), + _ => false, + } + } +} + +/// Helper function to get the next message from the stream +async fn expect_next_message( + transport: &mut T, + context: &str, +) -> Result +where + T: Transport, +{ + transport + .receive() + .await + .ok_or_else(|| ClientInitializeError::ConnectionClosed(context.to_string())) +} + +/// Helper function to expect a response from the stream, correlated to +/// `expected_id`. +/// +/// Both success and error responses are checked here: a mismatched id on a +/// success response is `ConflictInitResponseId`; on an error response (whose +/// `id` is optional per spec) it is `UncorrelatedErrorResponse`. The caller +/// never sees an uncorrelated response. +async fn expect_response( + transport: &mut T, + context: &str, + service: &S, + peer: Peer, + expected_id: &RequestId, +) -> Result +where + T: Transport, + S: Service, +{ + loop { + let message = expect_next_message(transport, context).await?; + match message { + ServerJsonRpcMessage::Response(JsonRpcResponse { id, result, .. }) => { + if !expected_id.matches_response_id(&id) { + return Err(ClientInitializeError::ConflictInitResponseId( + expected_id.clone(), + id, + )); + } + return Ok(result); + } + ServerJsonRpcMessage::Error(error) => { + return Err(match &error.id { + Some(id) if expected_id.matches_response_id(id) => { + ClientInitializeError::JsonRpcError(error.error) + } + // Spec: error id is optional; a server that cannot read + // the request id omits it. The error is still a response + // to our request, so it remains available to the caller. + None => ClientInitializeError::JsonRpcError(error.error), + Some(id) => ClientInitializeError::UncorrelatedErrorResponse { + expected: expected_id.clone(), + received: id.clone(), + }, + }); + } + // Server could send logging messages before handshake + ServerJsonRpcMessage::Notification(mut notification) => { + let ServerNotification::LoggingMessageNotification(logging) = + &mut notification.notification + else { + tracing::warn!(?notification, "Received unexpected message"); + continue; + }; + + let mut context = NotificationContext { + peer: peer.clone(), + meta: NotificationMetaObject::default(), + extensions: Extensions::default(), + }; + + if let Some(meta) = logging.extensions.get_mut::() { + std::mem::swap(&mut context.meta, meta); + } + std::mem::swap(&mut context.extensions, &mut logging.extensions); + + if let Err(error) = service + .handle_notification(notification.notification, context) + .await + { + tracing::warn!(?error, "Handle logging before handshake failed."); + } + } + // Server could send pings before handshake + ServerJsonRpcMessage::Request(ref request) + if matches!(request.request, ServerRequest::PingRequest(_)) => + { + tracing::trace!("Received ping request. Ignored.") + } + // Server SHOULD NOT send any other messages before handshake. We ignore them anyway + _ => tracing::warn!(?message, "Received unexpected message"), + } + } +} + +#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct RoleClient; + +/// Select the first client-preferred protocol version supported by the server. +/// +/// Returns `None` when no version is shared. +pub fn select_protocol_version( + client_preference: &[ProtocolVersion], + server_supported: &[ProtocolVersion], +) -> Option { + client_preference + .iter() + .find(|version| server_supported.contains(version)) + .cloned() +} + +impl ServiceRole for RoleClient { + type Req = ClientRequest; + type Resp = ClientResult; + type Not = ClientNotification; + type PeerReq = ServerRequest; + type PeerResp = ServerResult; + type PeerNot = ServerNotification; + type Info = ClientConfig; + type PeerInfo = ServerPeerInfo; + type InitializeError = ClientInitializeError; + const IS_CLIENT: bool = true; + + fn configure_direct_peer(peer: &Peer, info: &Self::Info) { + let Some(server_info) = peer.peer_info() else { + return; + }; + if server_info.protocol_version.has_initialize() { + return; + } + peer.set_client_request_metadata(ClientRequestMetadata { + protocol_version: server_info.protocol_version.clone(), + client_info: info.client_info.clone(), + client_capabilities: info.capabilities.clone(), + }); + } + + fn peer_cancelled_params(notification: &Self::PeerNot) -> Option<&CancelledNotificationParam> { + match notification { + ServerNotification::CancelledNotification(notification) => Some(¬ification.params), + _ => None, + } + } + + fn peer_cancels_subscriptions(peer: &Peer) -> bool { + // Discovery keeps modern lifecycle semantics even with an older application version. + !super::uses_legacy_lifecycle( + peer.peer_info() + .as_deref() + .map(|info| &info.protocol_version), + peer.client_request_metadata.get().is_some(), + ) + } + + fn is_subscription_request(request: &Self::Req) -> bool { + matches!(request, ClientRequest::SubscriptionsListenRequest(_)) + } + + // SEP-2260: reject restricted server requests that arrived unassociated + // with any in-flight outbound request. Without stream separation + // (`Unknown`) the coarse in-flight check under-approximates the SHOULD. + fn enforce_peer_request_association( + peer_request: &Self::PeerReq, + peer_info: Option<&Self::PeerInfo>, + association: PeerRequestAssociation, + ) -> Result<(), ErrorData> { + let restricted = matches!( + peer_request, + ServerRequest::CreateMessageRequest(_) + | ServerRequest::ListRootsRequest(_) + | ServerRequest::ElicitRequest(_) + ); + if !restricted { + return Ok(()); + } + let strict = + peer_info.is_some_and(|info| info.protocol_version >= ProtocolVersion::V_2026_07_28); + if !strict { + return Ok(()); + } + let associated = match association { + PeerRequestAssociation::Associated => true, + PeerRequestAssociation::Unassociated => false, + PeerRequestAssociation::Unknown { + has_pending_outbound_request, + } => has_pending_outbound_request, + }; + if associated { + Ok(()) + } else { + Err(ErrorData::invalid_params( + "SEP-2260: server-to-client requests must be associated with an in-flight client request", + None, + )) + } + } + + async fn invalidate_response_cache(peer: &Peer, notification: &Self::PeerNot) { + match notification { + ServerNotification::ResourceUpdatedNotification(notification) => { + peer.invalidate_resource_read_cache(¬ification.params.uri) + .await; + } + ServerNotification::ResourceListChangedNotification(_) => { + peer.invalidate_resource_list_cache().await; + } + ServerNotification::ToolListChangedNotification(_) => { + peer.invalidate_tool_cache().await; + } + ServerNotification::PromptListChangedNotification(_) => { + peer.invalidate_prompt_cache().await; + } + _ => {} + } + } +} + +pub type ServerSink = Peer; + +/// Default number of notifications buffered for one subscription. +pub const DEFAULT_SUBSCRIPTION_CHANNEL_CAPACITY: usize = 64; + +/// How a client-side subscription stream ended. +#[derive(Debug, Clone, PartialEq)] +#[non_exhaustive] +pub enum SubscriptionEnd { + /// The server returned a final `SubscriptionsListenResult`. + Graceful(SubscriptionsListenResult), + /// The transport closed without a final result. Call `Peer::listen` again + /// after reconnecting; subscription streams are not resumable. + Abrupt, + /// The subscription was explicitly cancelled by either peer. + Cancelled, + /// The consumer did not drain notifications before the channel filled. + Lagged { capacity: usize }, +} + +/// Handle for one active `subscriptions/listen` request. +#[derive(Debug)] +pub struct Subscription { + id: RequestId, + acknowledged: SubscriptionFilter, + notifications: tokio::sync::mpsc::Receiver, + request: Option>, + end: Option, +} + +type SubscriptionResponse = + Result, tokio::sync::oneshot::error::RecvError>; + +struct PendingSubscriptionRequest { + handle: Option>, +} + +impl PendingSubscriptionRequest { + fn new(handle: RequestHandle) -> Self { + Self { + handle: Some(handle), + } + } + + async fn recv(&mut self) -> Option { + let handle = self.handle.as_mut()?; + Some((&mut handle.rx).await) + } + + fn take(&mut self) -> Option> { + self.handle.take() + } + + fn unregister(&self, id: &RequestId) { + if let Some(handle) = self.handle.as_ref() { + handle.peer.unregister_subscription(id); + } + } + + fn disarm(&mut self) { + self.handle.take(); + } + + async fn cancel(&mut self, reason: &'static str) { + if let Some(handle) = self.handle.take() { + let _ = handle.cancel(Some(reason.to_owned())).await; + } + } +} + +impl Drop for PendingSubscriptionRequest { + fn drop(&mut self) { + let Some(handle) = self.handle.take() else { + return; + }; + handle.peer.unregister_subscription(&handle.id); + handle.peer.try_cancel_request( + handle.id, + Some("subscription establishment cancelled".to_owned()), + ); + } +} + +impl Subscription { + /// Return the originating listen request ID. + pub fn id(&self) -> &RequestId { + &self.id + } + + /// Return the notification filter accepted by the server. + pub fn acknowledged(&self) -> &SubscriptionFilter { + &self.acknowledged + } + + /// Return the terminal state after this subscription has ended. + pub fn end(&self) -> Option<&SubscriptionEnd> { + self.end.as_ref() + } + + /// Receive the next notification, or `None` after the subscription ends. + /// + /// A graceful final result and an abrupt transport close are distinguished + /// through [`Self::end`]. + /// + /// # Errors + /// + /// Returns a service or protocol error when the stream carries an invalid + /// message, an unexpected final result, or another request failure. + pub async fn next(&mut self) -> Result, ServiceError> { + if self.end.is_some() { + return Ok(None); + } + let Some(request) = self.request.as_mut() else { + self.end = Some(SubscriptionEnd::Abrupt); + return Ok(None); + }; + + tokio::select! { + biased; + notification = self.notifications.recv() => { + let Some(notification) = notification else { + let response = (&mut request.rx).await; + return self.handle_response(response); + }; + if let ServerNotification::CancelledNotification(cancelled) = ¬ification { + if cancelled.params.request_id.as_ref() != Some(&self.id) { + self.cancel_as_abrupt("subscription cancellation ID mismatch") + .await; + return Err(ServiceError::UnexpectedResponse); + } + self.finish(SubscriptionEnd::Cancelled); + return Ok(None); + } + if notification.get_meta().subscription_id().as_ref() != Some(&self.id) { + self.cancel_as_abrupt("subscription notification ID mismatch") + .await; + return Err(ServiceError::UnexpectedResponse); + } + if !self.accepts(¬ification) { + self.cancel_as_abrupt( + "subscription notification was outside the acknowledged filter", + ) + .await; + return Err(ServiceError::UnexpectedResponse); + } + Ok(Some(notification)) + } + response = &mut request.rx => { + self.handle_response(response) + } + } + } + + /// Cancel this subscription. + /// + /// # Errors + /// + /// Returns a transport error when the cancellation signal cannot be sent. + pub async fn cancel(&mut self) -> Result<(), ServiceError> { + self.cancel_with_reason(None).await + } + + /// Cancel this subscription with a diagnostic reason. + /// + /// # Errors + /// + /// Returns a transport error when the cancellation signal cannot be sent. + pub async fn cancel_with_reason(&mut self, reason: Option) -> Result<(), ServiceError> { + let Some(request) = self.request.take() else { + return Ok(()); + }; + request.cancel(reason).await?; + self.end = Some(SubscriptionEnd::Cancelled); + Ok(()) + } + + fn finish(&mut self, end: SubscriptionEnd) { + if let Some(request) = self.request.take() { + request.peer.unregister_subscription(&self.id); + } + self.end = Some(end); + } + + async fn cancel_as_abrupt(&mut self, reason: &'static str) { + if let Some(request) = self.request.take() { + let _ = request.cancel(Some(reason.to_owned())).await; + } + self.end = Some(SubscriptionEnd::Abrupt); + } + + fn accepts(&self, notification: &ServerNotification) -> bool { + match notification { + ServerNotification::ToolListChangedNotification(_) => { + self.acknowledged.tools_list_changed == Some(true) + } + ServerNotification::PromptListChangedNotification(_) => { + self.acknowledged.prompts_list_changed == Some(true) + } + ServerNotification::ResourceListChangedNotification(_) => { + self.acknowledged.resources_list_changed == Some(true) + } + ServerNotification::ResourceUpdatedNotification(update) => self + .acknowledged + .resource_subscriptions + .as_ref() + .is_some_and(|uris| uris.contains(&update.params.uri)), + ServerNotification::SubscriptionsAcknowledgedNotification(_) + | ServerNotification::CancelledNotification(_) + | ServerNotification::ProgressNotification(_) + | ServerNotification::LoggingMessageNotification(_) + | ServerNotification::TaskStatusNotification(_) + | ServerNotification::CustomNotification(_) => false, + } + } + + fn handle_response( + &mut self, + response: SubscriptionResponse, + ) -> Result, ServiceError> { + let response = match response { + Ok(response) => response, + Err(_) => { + self.finish(SubscriptionEnd::Abrupt); + return Ok(None); + } + }; + let response = match response { + Ok(response) => response, + Err(ServiceError::TransportClosed) => { + self.finish(SubscriptionEnd::Abrupt); + return Ok(None); + } + Err(ServiceError::SubscriptionLagged { capacity }) => { + self.finish(SubscriptionEnd::Lagged { capacity }); + return Ok(None); + } + Err(error) => { + self.finish(SubscriptionEnd::Abrupt); + return Err(error); + } + }; + let ServerResult::SubscriptionsListenResult(result) = response else { + self.finish(SubscriptionEnd::Abrupt); + return Err(ServiceError::UnexpectedResponse); + }; + if !result.result_type.is_complete() + || result.meta.subscription_id().as_ref() != Some(&self.id) + { + self.finish(SubscriptionEnd::Abrupt); + return Err(ServiceError::UnexpectedResponse); + } + self.finish(SubscriptionEnd::Graceful(result)); + Ok(None) + } +} + +impl Drop for Subscription { + fn drop(&mut self) { + let Some(request) = self.request.take() else { + return; + }; + request.peer.unregister_subscription(&self.id); + request.peer.try_cancel_request( + self.id.clone(), + Some("subscription handle dropped".to_owned()), + ); + } +} + +/// Selects how a client establishes its MCP lifecycle. +/// +/// Existing [`ServiceExt::serve`] behavior remains legacy initialization. +#[derive(Debug, Clone, PartialEq, Eq)] +#[non_exhaustive] +pub enum ClientLifecycleMode { + /// Use the legacy `initialize` / `notifications/initialized` handshake. + Initialize, + /// Use `server/discover` and send self-contained per-request metadata. + Discover { + preferred_versions: Vec, + }, + /// Probe with `server/discover`, falling back when the peer reports that it is legacy or does + /// not respond within 10 seconds. + Auto { + preferred_versions: Vec, + legacy_version: Option, + }, +} + +const DEFAULT_AUTO_DISCOVER_TIMEOUT: Duration = Duration::from_secs(10); + +/// Client-specific lifecycle entry points. +pub trait ClientServiceExt: Service + Sized { + fn serve_with_lifecycle( + self, + transport: T, + lifecycle: ClientLifecycleMode, + ) -> impl Future, ClientInitializeError>> + + MaybeSendFuture + where + T: IntoTransport, + E: std::error::Error + Send + Sync + 'static, + { + serve_client_with_lifecycle(self, transport, lifecycle) + } +} + +impl> ClientServiceExt for S {} + +impl> ServiceExt for S { + fn serve_with_ct( + self, + transport: T, + ct: CancellationToken, + ) -> impl Future, ClientInitializeError>> + + MaybeSendFuture + where + T: IntoTransport, + E: std::error::Error + Send + Sync + 'static, + Self: Sized, + { + serve_client_with_ct(self, transport, ct) + } +} + +pub async fn serve_client( + service: S, + transport: T, +) -> Result, ClientInitializeError> +where + S: Service, + T: IntoTransport, + E: std::error::Error + Send + Sync + 'static, +{ + serve_client_with_lifecycle_and_ct( + service, + transport, + ClientLifecycleMode::Initialize, + Default::default(), + ) + .await +} + +pub async fn serve_client_with_ct( + service: S, + transport: T, + ct: CancellationToken, +) -> Result, ClientInitializeError> +where + S: Service, + T: IntoTransport, + E: std::error::Error + Send + Sync + 'static, +{ + serve_client_with_lifecycle_and_ct(service, transport, ClientLifecycleMode::Initialize, ct) + .await +} + +pub async fn serve_client_with_lifecycle( + service: S, + transport: T, + lifecycle: ClientLifecycleMode, +) -> Result, ClientInitializeError> +where + S: Service, + T: IntoTransport, + E: std::error::Error + Send + Sync + 'static, +{ + serve_client_with_lifecycle_and_ct(service, transport, lifecycle, Default::default()).await +} + +pub async fn serve_client_with_lifecycle_and_ct( + service: S, + transport: T, + lifecycle: ClientLifecycleMode, + ct: CancellationToken, +) -> Result, ClientInitializeError> +where + S: Service, + T: IntoTransport, + E: std::error::Error + Send + Sync + 'static, +{ + tokio::select! { + result = serve_client_with_ct_inner( + service, + transport.into_transport(), + lifecycle, + ct.clone(), + DEFAULT_AUTO_DISCOVER_TIMEOUT, + ) => { result } + _ = ct.cancelled() => { + Err(ClientInitializeError::Cancelled) + } + } +} + +async fn serve_client_with_ct_inner( + service: S, + transport: T, + lifecycle: ClientLifecycleMode, + ct: CancellationToken, + auto_discover_timeout: Duration, +) -> Result, ClientInitializeError> +where + S: Service, + T: Transport + 'static, +{ + let mut transport = transport.into_transport(); + let id_provider = >::default(); + let (peer, peer_rx) = Peer::new(id_provider.clone(), None); + let client_info = service.get_info(); + + match lifecycle { + ClientLifecycleMode::Initialize => { + legacy_startup(&service, &mut transport, &id_provider, &peer, client_info).await?; + } + ClientLifecycleMode::Discover { preferred_versions } => { + match discover_startup( + &service, + &mut transport, + &id_provider, + &peer, + &client_info, + preferred_versions, + ) + .await? + { + DiscoverOutcome::Modern => {} + // Discover mode does not fall back; a legacy server is an error. + DiscoverOutcome::Legacy(error) => return Err(*error), + } + } + ClientLifecycleMode::Auto { + preferred_versions, + legacy_version, + } => { + let discover_result = tokio::time::timeout( + auto_discover_timeout, + discover_startup( + &service, + &mut transport, + &id_provider, + &peer, + &client_info, + preferred_versions, + ), + ) + .await; + match discover_result { + Ok(Ok(DiscoverOutcome::Modern)) => {} + Ok(Ok(DiscoverOutcome::Legacy(discover_error))) => { + let mut legacy_info = client_info; + if let Some(version) = legacy_version { + legacy_info.protocol_version = version; + } + if let Err(fallback_error) = + legacy_startup(&service, &mut transport, &id_provider, &peer, legacy_info) + .await + { + return Err(ClientInitializeError::LegacyFallbackFailed { + discover: discover_error, + fallback: Box::new(fallback_error), + }); + } + } + Ok(Err(error)) => return Err(error), + Err(_) => { + let mut legacy_info = client_info; + if let Some(version) = legacy_version { + legacy_info.protocol_version = version; + } + legacy_startup(&service, &mut transport, &id_provider, &peer, legacy_info) + .await?; + } + } + } + } + Ok(serve_inner( + service, + transport, + peer, + peer_rx, + VecDeque::new(), + ct, + )) +} + +/// Modern-era JSON-RPC error codes a server can return from `server/discover` +/// without being legacy. Version negotiation (`UNSUPPORTED_PROTOCOL_VERSION`) +/// is handled by `discover_startup`'s own retry loop and never reaches the +/// classification below. +/// +/// `ErrorCode` is an open integer type, so this cannot be exhaustive: if a +/// future revision adds another modern-era rejection code, add it here. +fn is_modern_rejection_code(code: crate::model::ErrorCode) -> bool { + matches!( + code, + crate::model::ErrorCode::MISSING_REQUIRED_CLIENT_CAPABILITY + | crate::model::ErrorCode::HEADER_MISMATCH + ) +} + +/// The outcome of a `server/discover` probe, classified at the point where all +/// the context (request id, response correlation, transport state) is still +/// available. +/// +/// `Legacy` is returned only when the probe produced a complete, correlated +/// JSON-RPC error whose code is not a modern-era rejection — i.e. the +/// transport is in a known-good state and the error identifies the peer as +/// legacy per the 2026-07-28 backward-compatibility guidance. Every other +/// failure (transport error, uncorrelated response, modern rejection, etc.) +/// becomes `Err` so the caller surfaces it instead of retrying. +enum DiscoverOutcome { + /// The server speaks the modern protocol; discovery succeeded. + Modern, + /// The server is legacy: discovery received a correlated, non-modern + /// JSON-RPC error. The transport is still usable for a legacy `initialize` + /// handshake. The original error is preserved so a failed fallback can + /// report both phases. + Legacy(Box), +} + +async fn legacy_startup( + service: &S, + transport: &mut T, + id_provider: &Arc, + peer: &Peer, + client_info: InitializeRequestParams, +) -> Result<(), ClientInitializeError> +where + S: Service, + T: Transport + 'static, +{ + let id = id_provider.next_request_id(); + let client_info_for_meta = client_info.clone(); + let init_request = InitializeRequest { + method: Default::default(), + params: client_info, + extensions: Default::default(), + }; + transport + .send(ClientJsonRpcMessage::request( + ClientRequest::InitializeRequest(init_request), + id.clone(), + )) + .await + .map_err(|error| ClientInitializeError::TransportError { + error: DynamicTransportError::new::(error), + context: "send initialize request".into(), + })?; + + let response = + expect_response(transport, "initialize response", service, peer.clone(), &id).await?; + + let ServerResult::InitializeResult(initialize_result) = response else { + return Err(ClientInitializeError::ExpectedInitResult(Some(response))); + }; + // A server may answer `initialize` with a version that has no handshake + // (e.g. a client pinned past `NO_INITIALIZE` talking to a server that + // honors it). From there the lifecycle lives in per-request `_meta`, so the + // metadata has to be seeded now or every later request omits it. + if !initialize_result.protocol_version.has_initialize() { + peer.set_client_request_metadata(ClientRequestMetadata { + protocol_version: initialize_result.protocol_version.clone(), + client_info: client_info_for_meta.client_info, + client_capabilities: client_info_for_meta.capabilities, + }); + } + peer.set_peer_info(initialize_result.into()); + + // send notification + let notification = ClientJsonRpcMessage::notification( + ClientNotification::InitializedNotification(InitializedNotification { + method: Default::default(), + extensions: Default::default(), + }), + ); + transport.send(notification).await.map_err(|error| { + ClientInitializeError::transport::(error, "send initialized notification") + })?; + Ok(()) +} + +async fn discover_startup( + service: &S, + transport: &mut T, + id_provider: &Arc, + peer: &Peer, + client_info: &InitializeRequestParams, + preferred_versions: Vec, +) -> Result +where + S: Service, + T: Transport + 'static, +{ + if preferred_versions.is_empty() { + return Err(ClientInitializeError::NoPreferredProtocolVersion); + } + + let mut attempted = Vec::new(); + let mut candidate = preferred_versions[0].clone(); + loop { + attempted.push(candidate.clone()); + + let meta = RequestMetaObject::with_client_context( + candidate.clone(), + client_info.client_info.clone(), + client_info.capabilities.clone(), + ); + let mut discover = DiscoverRequest::new(DiscoverRequestParams {}); + discover.extensions.insert(meta); + let id = id_provider.next_request_id(); + transport + .send(ClientJsonRpcMessage::request( + ClientRequest::DiscoverRequest(discover), + id.clone(), + )) + .await + .map_err(|error| { + ClientInitializeError::transport::(error, "send discover request") + })?; + + match expect_response(transport, "discover response", service, peer.clone(), &id).await { + Ok(ServerResult::DiscoverResult(result)) => { + let Some(selected) = + select_protocol_version(&preferred_versions, &result.supported_versions) + else { + return Err(ClientInitializeError::NoCompatibleProtocolVersion { + client_supported: preferred_versions, + server_supported: result.supported_versions, + }); + }; + peer.set_peer_info(ServerPeerInfo::from_discover_result( + selected.clone(), + result, + )); + peer.set_client_request_metadata(ClientRequestMetadata { + protocol_version: selected, + client_info: client_info.client_info.clone(), + client_capabilities: client_info.capabilities.clone(), + }); + return Ok(DiscoverOutcome::Modern); + } + Ok(response) => { + return Err(ClientInitializeError::ExpectedInitResult(Some(response))); + } + Err(ClientInitializeError::JsonRpcError(error)) + if error.code == crate::model::ErrorCode::UNSUPPORTED_PROTOCOL_VERSION => + { + let supported = error + .data + .as_ref() + .and_then(|data| data.get("supported")) + .cloned() + .and_then(|value| serde_json::from_value::>(value).ok()) + .unwrap_or_default(); + let may_retry_current = attempted + .iter() + .filter(|version| *version == &candidate) + .count() + == 1; + let next = preferred_versions + .iter() + .find(|version| { + supported.contains(version) + && (!attempted.contains(version) + || (may_retry_current && *version == &candidate)) + }) + .cloned(); + let Some(next) = next else { + return Err(ClientInitializeError::NoCompatibleProtocolVersion { + client_supported: preferred_versions, + server_supported: supported, + }); + }; + candidate = next; + } + // A correlated JSON-RPC error that is not a modern-era rejection + // and not a version-negotiation signal: the server is legacy. + // The transport delivered a complete response, so a legacy + // `initialize` can follow on the same connection. + Err(error) + if matches!( + &error, + ClientInitializeError::JsonRpcError(data) + if !is_modern_rejection_code(data.code) + ) => + { + return Ok(DiscoverOutcome::Legacy(Box::new(error))); + } + Err(error) => return Err(error), + } + } +} + +const DISCOVER_CACHE_PREFIX: &str = "server/discover:"; +const TOOL_LIST_CACHE_PREFIX: &str = "tools/list:"; +const PROMPT_LIST_CACHE_PREFIX: &str = "prompts/list:"; +const RESOURCE_LIST_CACHE_PREFIX: &str = "resources/list:"; +const RESOURCE_TEMPLATE_LIST_CACHE_PREFIX: &str = "resources/templates/list:"; +const RESOURCE_READ_CACHE_PREFIX: &str = "resources/read:"; + +// Cache keys are built only from the request method plus the parameters that +// affect the result (SEP-2549). Request `_meta` (progress tokens, trace +// context, etc.) does not affect the result, so it is deliberately excluded to +// avoid fragmenting the cache across otherwise-identical requests. +fn discover_cache_key() -> String { + // `server/discover` carries no result-affecting parameters. + DISCOVER_CACHE_PREFIX.to_string() +} + +fn list_response_cache_key(prefix: &str, params: &Option) -> String { + // Only the pagination cursor affects which page is returned. + let cursor = params.as_ref().and_then(|params| params.cursor.as_deref()); + let cursor = + serde_json::to_string(&cursor).expect("serializing a pagination cursor cannot fail"); + format!("{prefix}{cursor}") +} + +fn resource_read_cache_key(params: &ReadResourceRequestParams) -> Option { + // MRTR retries depend on inputs that are not part of the cache key and MUST + // NOT be cached. + if params.input_responses.is_some() || params.request_state.is_some() { + return None; + } + // Only the URI affects the result. + Some(resource_read_cache_prefix_for_uri(¶ms.uri)) +} + +fn resource_read_cache_prefix_for_uri(uri: &str) -> String { + let uri = serde_json::to_string(uri).expect("serializing a resource URI cannot fail"); + format!("{RESOURCE_READ_CACHE_PREFIX}{uri}:") +} + +fn request_uses_cursor(params: &Option) -> bool { + params + .as_ref() + .and_then(|params| params.cursor.as_ref()) + .is_some() +} + +macro_rules! method { + ($(#[$meta:meta])* peer_req $method:ident $Req:ident() => $Resp: ident ) => { + $(#[$meta])* + pub async fn $method(&self) -> Result<$Resp, ServiceError> { + let result = self + .send_request(ClientRequest::$Req($Req { + method: Default::default(), + })) + .await?; + match result { + ServerResult::$Resp(result) => Ok(result), + _ => Err(ServiceError::UnexpectedResponse), + } + } + }; + ($(#[$meta:meta])* peer_req $method:ident $Req:ident($Param: ident) => $Resp: ident ) => { + $(#[$meta])* + pub async fn $method(&self, params: $Param) -> Result<$Resp, ServiceError> { + let result = self + .send_request(ClientRequest::$Req($Req { + method: Default::default(), + params, + extensions: Default::default(), + })) + .await?; + match result { + ServerResult::$Resp(result) => Ok(result), + _ => Err(ServiceError::UnexpectedResponse), + } + } + }; + ($(#[$meta:meta])* peer_req $method:ident $Req:ident($Param: ident)? => $Resp: ident ) => { + $(#[$meta])* + pub async fn $method(&self, params: Option<$Param>) -> Result<$Resp, ServiceError> { + let result = self + .send_request(ClientRequest::$Req($Req { + method: Default::default(), + params, + extensions: Default::default(), + })) + .await?; + match result { + ServerResult::$Resp(result) => Ok(result), + _ => Err(ServiceError::UnexpectedResponse), + } + } + }; + ($(#[$meta:meta])* peer_req $method:ident $Req:ident($Param: ident)) => { + $(#[$meta])* + pub async fn $method(&self, params: $Param) -> Result<(), ServiceError> { + let result = self + .send_request(ClientRequest::$Req($Req { + method: Default::default(), + params, + extensions: Default::default(), + })) + .await?; + match result { + ServerResult::EmptyResult(_) => Ok(()), + _ => Err(ServiceError::UnexpectedResponse), + } + } + }; + + ($(#[$meta:meta])* peer_not $method:ident $Not:ident($Param: ident)) => { + $(#[$meta])* + pub async fn $method(&self, params: $Param) -> Result<(), ServiceError> { + self.send_notification(ClientNotification::$Not($Not { + method: Default::default(), + params, + extensions: Default::default(), + })) + .await?; + Ok(()) + } + }; + ($(#[$meta:meta])* peer_not $method:ident $Not:ident) => { + $(#[$meta])* + pub async fn $method(&self) -> Result<(), ServiceError> { + self.send_notification(ClientNotification::$Not($Not { + method: Default::default(), + extensions: Default::default(), + })) + .await?; + Ok(()) + } + }; +} + +impl Peer { + /// Open a long-lived notification subscription and wait for its acknowledgment. + /// + /// Notifications routed to the returned [`Subscription`] are not also + /// delivered through [`ClientHandler`](crate::ClientHandler) callbacks. + /// + /// # Errors + /// + /// Returns a service, transport, or protocol error when the request cannot + /// be established or the acknowledgment is invalid. + pub async fn listen( + &self, + notifications: SubscriptionFilter, + ) -> Result { + self.listen_with_channel_capacity_inner( + notifications, + DEFAULT_SUBSCRIPTION_CHANNEL_CAPACITY, + ) + .await + } + + /// Open a subscription with an explicit notification buffer capacity. + /// + /// Notifications routed to the returned [`Subscription`] are not also + /// delivered through [`ClientHandler`](crate::ClientHandler) callbacks. + /// + /// # Errors + /// + /// Returns a service, transport, or protocol error when the request cannot + /// be established or the acknowledgment is invalid. + pub async fn listen_with_capacity( + &self, + notifications: SubscriptionFilter, + channel_capacity: NonZeroUsize, + ) -> Result { + self.listen_with_channel_capacity_inner(notifications, channel_capacity.get()) + .await + } + + async fn listen_with_channel_capacity_inner( + &self, + notifications: SubscriptionFilter, + channel_capacity: usize, + ) -> Result { + let request = ClientRequest::SubscriptionsListenRequest(SubscriptionsListenRequest::new( + SubscriptionsListenRequestParams::new(notifications.clone()), + )); + let (handle, mut subscription_notifications) = self + .send_subscription_request(request, PeerRequestOptions::no_options(), channel_capacity) + .await?; + let id = handle.id.clone(); + let mut pending = PendingSubscriptionRequest::new(handle); + + tokio::select! { + biased; + notification = subscription_notifications.recv() => { + let Some(notification) = notification else { + pending.cancel("subscription stream closed before acknowledgment").await; + return Err(ServiceError::TransportClosed); + }; + if notification.get_meta().subscription_id().as_ref() != Some(&id) { + pending.cancel("subscription acknowledgment ID mismatch").await; + return Err(ServiceError::UnexpectedResponse); + } + let ServerNotification::SubscriptionsAcknowledgedNotification( + acknowledgment, + ) = notification else { + pending.cancel("notification received before subscription acknowledgment").await; + return Err(ServiceError::UnexpectedResponse); + }; + let accepted = acknowledgment.params.notifications; + if !accepted.is_subset_of(¬ifications) { + pending.cancel("subscription acknowledged an unrequested filter").await; + return Err(ServiceError::UnexpectedResponse); + } + let Some(handle) = pending.take() else { + return Err(ServiceError::TransportClosed); + }; + Ok(Subscription { + id, + acknowledged: accepted, + notifications: subscription_notifications, + request: Some(handle), + end: None, + }) + } + response = pending.recv() => { + pending.unregister(&id); + pending.disarm(); + let Some(response) = response else { + return Err(ServiceError::TransportClosed); + }; + match response { + Ok(Err(error)) => Err(error), + Ok(Ok(_)) => Err(ServiceError::UnexpectedResponse), + Err(_) => Err(ServiceError::TransportClosed), + } + } + } + } + + /// Discover the server's supported protocol versions and capabilities. + /// + /// The high-level client currently exposes this peer only after initialization; + /// pre-initialization probing is planned as follow-up work. + pub async fn discover(&self, meta: RequestMetaObject) -> Result { + let cache_key = discover_cache_key(); + if let Some(ServerResult::DiscoverResult(result)) = self.cached_response(&cache_key).await { + return Ok(result); + } + let generation = self.capture_response_cache_generation().await; + let mut request = DiscoverRequest::new(DiscoverRequestParams {}); + request.extensions.insert(meta); + let result = self + .send_request(ClientRequest::DiscoverRequest(request)) + .await; + let result = match result { + Ok(result) => result, + Err(error) => { + if let Some(ServerResult::DiscoverResult(result)) = + self.stale_cached_response(&cache_key).await + { + return Ok(result); + } + return Err(error); + } + }; + match result { + ServerResult::DiscoverResult(result) => { + self.cache_result( + Some(cache_key), + Some(result.ttl_ms), + Some(result.cache_scope), + generation, + ServerResult::DiscoverResult(result.clone()), + ) + .await; + Ok(result) + } + _ => Err(ServiceError::UnexpectedResponse), + } + } + + async fn cache_result( + &self, + cache_key: Option, + ttl_ms: Option, + cache_scope: Option, + generation: CacheGeneration, + result: ServerResult, + ) { + let Some(cache_key) = cache_key else { + return; + }; + self.cache_response_with_generation(cache_key, result, ttl_ms, cache_scope, generation) + .await; + } + + pub(crate) async fn invalidate_tool_cache(&self) { + self.invalidate_cached_responses(TOOL_LIST_CACHE_PREFIX) + .await; + } + + pub(crate) async fn invalidate_prompt_cache(&self) { + self.invalidate_cached_responses(PROMPT_LIST_CACHE_PREFIX) + .await; + } + + pub(crate) async fn invalidate_resource_list_cache(&self) { + self.invalidate_cached_responses(RESOURCE_LIST_CACHE_PREFIX) + .await; + self.invalidate_cached_responses(RESOURCE_TEMPLATE_LIST_CACHE_PREFIX) + .await; + } + + pub(crate) async fn invalidate_resource_read_cache(&self, uri: &str) { + self.invalidate_cached_responses(&resource_read_cache_prefix_for_uri(uri)) + .await; + } + + /// Send one `tools/call` request and return either a final result or an MRTR + /// `InputRequiredResult` without driving any follow-up rounds. + pub async fn call_tool_once( + &self, + params: CallToolRequestParams, + ) -> Result { + let result = self + .send_request(ClientRequest::CallToolRequest(CallToolRequest { + method: Default::default(), + params, + extensions: Default::default(), + })) + .await?; + match result { + ServerResult::CallToolResult(result) => Ok(CallToolResponse::Complete(result)), + ServerResult::InputRequiredResult(result) => { + Ok(CallToolResponse::InputRequired(result)) + } + // SEP-2663 Tasks extension: the server materialized a task. + ServerResult::CreateTaskResult(result) => Ok(CallToolResponse::Task(result)), + _ => Err(ServiceError::UnexpectedResponse), + } + } + + /// SEP-2663 `tasks/get`: poll the current state of a task. + pub async fn get_task(&self, params: GetTaskParams) -> Result { + let result = self + .send_request(ClientRequest::GetTaskRequest(GetTaskRequest::new(params))) + .await?; + match result { + ServerResult::GetTaskResult(result) => Ok(result), + _ => Err(ServiceError::UnexpectedResponse), + } + } + + /// SEP-2663 `tasks/update`: deliver responses to outstanding in-task + /// input requests. The acknowledgement is eventually consistent. + pub async fn update_task(&self, params: UpdateTaskParams) -> Result<(), ServiceError> { + let result = self + .send_request(ClientRequest::UpdateTaskRequest(UpdateTaskRequest::new( + params, + ))) + .await?; + match result { + ServerResult::TaskAckResult(_) | ServerResult::EmptyResult(_) => Ok(()), + _ => Err(ServiceError::UnexpectedResponse), + } + } + + /// SEP-2663 `tasks/cancel`: signal intent to cancel a task. Cancellation + /// is cooperative; the ack does not guarantee the task stops. + pub async fn cancel_task(&self, params: CancelTaskParams) -> Result<(), ServiceError> { + let result = self + .send_request(ClientRequest::CancelTaskRequest(CancelTaskRequest::new( + params, + ))) + .await?; + match result { + ServerResult::TaskAckResult(_) | ServerResult::EmptyResult(_) => Ok(()), + _ => Err(ServiceError::UnexpectedResponse), + } + } + + /// Send one `prompts/get` request and return either a final result or an MRTR + /// `InputRequiredResult` without driving any follow-up rounds. + pub async fn get_prompt_once( + &self, + params: GetPromptRequestParams, + ) -> Result { + let result = self + .send_request(ClientRequest::GetPromptRequest(GetPromptRequest { + method: Default::default(), + params, + extensions: Default::default(), + })) + .await?; + match result { + ServerResult::GetPromptResult(result) => Ok(GetPromptResponse::Complete(result)), + ServerResult::InputRequiredResult(result) => { + Ok(GetPromptResponse::InputRequired(result)) + } + _ => Err(ServiceError::UnexpectedResponse), + } + } + + /// Send one `resources/read` request and return either a final result or an + /// MRTR `InputRequiredResult` without driving any follow-up rounds. + pub async fn read_resource_once( + &self, + params: ReadResourceRequestParams, + ) -> Result { + let cache_key = resource_read_cache_key(¶ms); + if let Some(key) = cache_key.as_deref() + && let Some(ServerResult::ReadResourceResult(result)) = self.cached_response(key).await + { + return Ok(ReadResourceResponse::Complete(result)); + } + + let generation = self.capture_response_cache_generation().await; + let result = self + .send_request(ClientRequest::ReadResourceRequest(ReadResourceRequest { + method: Default::default(), + params, + extensions: Default::default(), + })) + .await; + let result = match result { + Ok(result) => result, + Err(error) => { + if let Some(key) = cache_key.as_deref() + && let Some(ServerResult::ReadResourceResult(result)) = + self.stale_cached_response(key).await + { + return Ok(ReadResourceResponse::Complete(result)); + } + return Err(error); + } + }; + match result { + ServerResult::ReadResourceResult(result) => { + self.cache_result( + cache_key, + result.ttl_ms, + result.cache_scope, + generation, + ServerResult::ReadResourceResult(result.clone()), + ) + .await; + Ok(ReadResourceResponse::Complete(result)) + } + ServerResult::InputRequiredResult(result) => { + Ok(ReadResourceResponse::InputRequired(result)) + } + _ => Err(ServiceError::UnexpectedResponse), + } + } + + method!(peer_req complete CompleteRequest(CompleteRequestParams) => CompleteResult); + method!( + #[deprecated( + since = "1.8.0", + note = "Logging is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" + )] + peer_req set_level SetLevelRequest(SetLevelRequestParams) + ); + method!(peer_req get_prompt GetPromptRequest(GetPromptRequestParams) => GetPromptResult); + method!( + #[deprecated( + note = "resources/subscribe is legacy-only; use Peer::listen for protocol version 2026-07-28" + )] + peer_req subscribe SubscribeRequest(SubscribeRequestParams) + ); + method!( + #[deprecated( + note = "resources/unsubscribe is legacy-only; cancel the Subscription handle instead" + )] + peer_req unsubscribe UnsubscribeRequest(UnsubscribeRequestParams) + ); + method!(peer_req call_tool CallToolRequest(CallToolRequestParams) => CallToolResult); + + pub async fn list_prompts( + &self, + params: Option, + ) -> Result { + let cache_key = list_response_cache_key(PROMPT_LIST_CACHE_PREFIX, ¶ms); + if let Some(ServerResult::ListPromptsResult(result)) = + self.cached_response(&cache_key).await + { + return Ok(result); + } + let generation = self.capture_response_cache_generation().await; + let uses_cursor = request_uses_cursor(¶ms); + let result = self + .send_request(ClientRequest::ListPromptsRequest(ListPromptsRequest { + method: Default::default(), + params, + extensions: Default::default(), + })) + .await; + let result = match result { + Ok(result) => result, + Err(error) => { + if uses_cursor { + self.invalidate_prompt_cache().await; + return Err(error); + } + if let Some(ServerResult::ListPromptsResult(result)) = + self.stale_cached_response(&cache_key).await + { + return Ok(result); + } + return Err(error); + } + }; + match result { + ServerResult::ListPromptsResult(result) => { + self.cache_result( + Some(cache_key), + result.ttl_ms, + result.cache_scope, + generation, + ServerResult::ListPromptsResult(result.clone()), + ) + .await; + Ok(result) + } + _ => Err(ServiceError::UnexpectedResponse), + } + } + + pub async fn list_resources( + &self, + params: Option, + ) -> Result { + let cache_key = list_response_cache_key(RESOURCE_LIST_CACHE_PREFIX, ¶ms); + if let Some(ServerResult::ListResourcesResult(result)) = + self.cached_response(&cache_key).await + { + return Ok(result); + } + let generation = self.capture_response_cache_generation().await; + let uses_cursor = request_uses_cursor(¶ms); + let result = self + .send_request(ClientRequest::ListResourcesRequest(ListResourcesRequest { + method: Default::default(), + params, + extensions: Default::default(), + })) + .await; + let result = match result { + Ok(result) => result, + Err(error) => { + if uses_cursor { + self.invalidate_cached_responses(RESOURCE_LIST_CACHE_PREFIX) + .await; + return Err(error); + } + if let Some(ServerResult::ListResourcesResult(result)) = + self.stale_cached_response(&cache_key).await + { + return Ok(result); + } + return Err(error); + } + }; + match result { + ServerResult::ListResourcesResult(result) => { + self.cache_result( + Some(cache_key), + result.ttl_ms, + result.cache_scope, + generation, + ServerResult::ListResourcesResult(result.clone()), + ) + .await; + Ok(result) + } + _ => Err(ServiceError::UnexpectedResponse), + } + } + + pub async fn list_resource_templates( + &self, + params: Option, + ) -> Result { + let cache_key = list_response_cache_key(RESOURCE_TEMPLATE_LIST_CACHE_PREFIX, ¶ms); + if let Some(ServerResult::ListResourceTemplatesResult(result)) = + self.cached_response(&cache_key).await + { + return Ok(result); + } + let generation = self.capture_response_cache_generation().await; + let uses_cursor = request_uses_cursor(¶ms); + let result = self + .send_request(ClientRequest::ListResourceTemplatesRequest( + ListResourceTemplatesRequest { + method: Default::default(), + params, + extensions: Default::default(), + }, + )) + .await; + let result = match result { + Ok(result) => result, + Err(error) => { + if uses_cursor { + self.invalidate_cached_responses(RESOURCE_TEMPLATE_LIST_CACHE_PREFIX) + .await; + return Err(error); + } + if let Some(ServerResult::ListResourceTemplatesResult(result)) = + self.stale_cached_response(&cache_key).await + { + return Ok(result); + } + return Err(error); + } + }; + match result { + ServerResult::ListResourceTemplatesResult(result) => { + self.cache_result( + Some(cache_key), + result.ttl_ms, + result.cache_scope, + generation, + ServerResult::ListResourceTemplatesResult(result.clone()), + ) + .await; + Ok(result) + } + _ => Err(ServiceError::UnexpectedResponse), + } + } + + pub async fn read_resource( + &self, + params: ReadResourceRequestParams, + ) -> Result { + match self.read_resource_once(params).await? { + ReadResourceResponse::Complete(result) => Ok(result), + ReadResourceResponse::InputRequired(_) => Err(ServiceError::UnexpectedResponse), + } + } + + pub async fn list_tools( + &self, + params: Option, + ) -> Result { + let cache_key = list_response_cache_key(TOOL_LIST_CACHE_PREFIX, ¶ms); + if let Some(ServerResult::ListToolsResult(result)) = self.cached_response(&cache_key).await + { + return Ok(result); + } + let generation = self.capture_response_cache_generation().await; + let uses_cursor = request_uses_cursor(¶ms); + let result = self + .send_request(ClientRequest::ListToolsRequest(ListToolsRequest { + method: Default::default(), + params, + extensions: Default::default(), + })) + .await; + let result = match result { + Ok(result) => result, + Err(error) => { + if uses_cursor { + self.invalidate_tool_cache().await; + return Err(error); + } + if let Some(ServerResult::ListToolsResult(result)) = + self.stale_cached_response(&cache_key).await + { + return Ok(result); + } + return Err(error); + } + }; + match result { + ServerResult::ListToolsResult(result) => { + self.cache_result( + Some(cache_key), + result.ttl_ms, + result.cache_scope, + generation, + ServerResult::ListToolsResult(result.clone()), + ) + .await; + Ok(result) + } + _ => Err(ServiceError::UnexpectedResponse), + } + } + + method!(peer_not notify_cancelled CancelledNotification(CancelledNotificationParam)); + method!(peer_not notify_progress ProgressNotification(ProgressNotificationParam)); + method!(peer_not notify_initialized InitializedNotification); + method!(peer_not notify_roots_list_changed RootsListChangedNotification); +} + +impl Peer { + /// A wrapper method for [`Peer::list_tools`]. + /// + /// This function will call [`Peer::list_tools`] multiple times until all tools are listed. + pub async fn list_all_tools(&self) -> Result, ServiceError> { + let mut tools = Vec::new(); + let mut cursor = None; + loop { + let result = self + .list_tools(Some(PaginatedRequestParams { meta: None, cursor })) + .await?; + tools.extend(result.tools); + cursor = result.next_cursor; + if cursor.is_none() { + break; + } + } + Ok(tools) + } + + /// A wrapper method for [`Peer::list_prompts`]. + /// + /// This function will call [`Peer::list_prompts`] multiple times until all prompts are listed. + pub async fn list_all_prompts(&self) -> Result, ServiceError> { + let mut prompts = Vec::new(); + let mut cursor = None; + loop { + let result = self + .list_prompts(Some(PaginatedRequestParams { meta: None, cursor })) + .await?; + prompts.extend(result.prompts); + cursor = result.next_cursor; + if cursor.is_none() { + break; + } + } + Ok(prompts) + } + + /// A wrapper method for [`Peer::list_resources`]. + /// + /// This function will call [`Peer::list_resources`] multiple times until all resources are listed. + pub async fn list_all_resources(&self) -> Result, ServiceError> { + let mut resources = Vec::new(); + let mut cursor = None; + loop { + let result = self + .list_resources(Some(PaginatedRequestParams { meta: None, cursor })) + .await?; + resources.extend(result.resources); + cursor = result.next_cursor; + if cursor.is_none() { + break; + } + } + Ok(resources) + } + + /// A wrapper method for [`Peer::list_resource_templates`]. + /// + /// This function will call [`Peer::list_resource_templates`] multiple times until all resource templates are listed. + pub async fn list_all_resource_templates( + &self, + ) -> Result, ServiceError> { + let mut resource_templates = Vec::new(); + let mut cursor = None; + loop { + let result = self + .list_resource_templates(Some(PaginatedRequestParams { meta: None, cursor })) + .await?; + resource_templates.extend(result.resource_templates); + cursor = result.next_cursor; + if cursor.is_none() { + break; + } + } + Ok(resource_templates) + } + + /// Convenient method to get completion suggestions for a prompt argument + /// + /// # Arguments + /// * `prompt_name` - Name of the prompt being completed + /// * `argument_name` - Name of the argument being completed + /// * `current_value` - Current partial value of the argument + /// * `context` - Optional context with previously resolved arguments + /// + /// # Returns + /// CompletionInfo with suggestions for the specified prompt argument + pub async fn complete_prompt_argument( + &self, + prompt_name: impl Into, + argument_name: impl Into, + current_value: impl Into, + context: Option, + ) -> Result { + let request = CompleteRequestParams { + meta: None, + r#ref: Reference::for_prompt(prompt_name), + argument: ArgumentInfo { + name: argument_name.into(), + value: current_value.into(), + }, + context, + }; + + let result = self.complete(request).await?; + Ok(result.completion) + } + + /// Convenient method to get completion suggestions for a resource URI argument + /// + /// # Arguments + /// * `uri_template` - URI template pattern being completed + /// * `argument_name` - Name of the URI parameter being completed + /// * `current_value` - Current partial value of the parameter + /// * `context` - Optional context with previously resolved arguments + /// + /// # Returns + /// CompletionInfo with suggestions for the specified resource URI argument + pub async fn complete_resource_argument( + &self, + uri_template: impl Into, + argument_name: impl Into, + current_value: impl Into, + context: Option, + ) -> Result { + let request = CompleteRequestParams { + meta: None, + r#ref: Reference::for_resource(uri_template), + argument: ArgumentInfo { + name: argument_name.into(), + value: current_value.into(), + }, + context, + }; + + let result = self.complete(request).await?; + Ok(result.completion) + } + + /// Simple completion for a prompt argument without context + /// + /// This is a convenience wrapper around `complete_prompt_argument` for + /// simple completion scenarios that don't require context awareness. + pub async fn complete_prompt_simple( + &self, + prompt_name: impl Into, + argument_name: impl Into, + current_value: impl Into, + ) -> Result, ServiceError> { + let completion = self + .complete_prompt_argument(prompt_name, argument_name, current_value, None) + .await?; + Ok(completion.values) + } + + /// Simple completion for a resource URI argument without context + /// + /// This is a convenience wrapper around `complete_resource_argument` for + /// simple completion scenarios that don't require context awareness. + pub async fn complete_resource_simple( + &self, + uri_template: impl Into, + argument_name: impl Into, + current_value: impl Into, + ) -> Result, ServiceError> { + let completion = self + .complete_resource_argument(uri_template, argument_name, current_value, None) + .await?; + Ok(completion.values) + } +} + +impl RunningService +where + S: Service, +{ + /// Send one `tools/call` request without driving MRTR follow-up rounds. + pub async fn call_tool_once( + &self, + params: CallToolRequestParams, + ) -> Result { + self.peer.call_tool_once(params).await + } + + /// Send one `prompts/get` request without driving MRTR follow-up rounds. + pub async fn get_prompt_once( + &self, + params: GetPromptRequestParams, + ) -> Result { + self.peer.get_prompt_once(params).await + } + + /// Send one `resources/read` request without driving MRTR follow-up rounds. + pub async fn read_resource_once( + &self, + params: ReadResourceRequestParams, + ) -> Result { + self.peer.read_resource_once(params).await + } + + /// High-level `tools/call` helper that automatically fulfils SEP-2322 + /// `input_required` rounds through the local [`ClientHandler`](crate::ClientHandler) service. + /// + /// # Errors + /// + /// Returns [`ServiceError::InputRequiredRoundsExceeded`] if the peer does + /// not produce a final [`CallToolResult`] within the default MRTR round cap. + /// Other transport, protocol, and local input-handler errors are propagated. + pub async fn call_tool( + &self, + params: CallToolRequestParams, + ) -> Result { + self.call_tool_with_mrtr_max_rounds(params, DEFAULT_MRTR_MAX_ROUNDS) + .await + } + + /// Same as [`Self::call_tool`], with an explicit MRTR round cap. + /// + /// # Errors + /// + /// Returns [`ServiceError::InputRequiredRoundsExceeded`] once `max_rounds` + /// `input_required` responses have been driven without receiving a final + /// [`CallToolResult`]. Other transport, protocol, and local input-handler + /// errors are propagated. + pub async fn call_tool_with_mrtr_max_rounds( + &self, + mut params: CallToolRequestParams, + max_rounds: usize, + ) -> Result { + let mut state_only_rounds = 0usize; + for _round in 0..max_rounds { + match self.peer.call_tool_once(params.clone()).await? { + CallToolResponse::Complete(result) => return Ok(result), + CallToolResponse::InputRequired(result) => { + let (input_responses, request_state) = self + .prepare_input_required_retry(result, &mut state_only_rounds) + .await?; + params.input_responses = input_responses; + params.request_state = request_state; + } + // SEP-2663: this helper does not drive the task polling + // lifecycle. Callers that declare the tasks extension + // capability should use `call_tool_once` and poll `tasks/get`. + CallToolResponse::Task(_) => return Err(ServiceError::UnexpectedResponse), + } + } + Err(ServiceError::InputRequiredRoundsExceeded { max_rounds }) + } + + /// High-level `prompts/get` helper that automatically fulfils SEP-2322 + /// `input_required` rounds through the local [`ClientHandler`](crate::ClientHandler) service. + /// + /// # Errors + /// + /// Returns [`ServiceError::InputRequiredRoundsExceeded`] if the peer does + /// not produce a final [`GetPromptResult`] within the default MRTR round cap. + /// Other transport, protocol, and local input-handler errors are propagated. + pub async fn get_prompt( + &self, + params: GetPromptRequestParams, + ) -> Result { + self.get_prompt_with_mrtr_max_rounds(params, DEFAULT_MRTR_MAX_ROUNDS) + .await + } + + /// Same as [`Self::get_prompt`], with an explicit MRTR round cap. + /// + /// # Errors + /// + /// Returns [`ServiceError::InputRequiredRoundsExceeded`] once `max_rounds` + /// `input_required` responses have been driven without receiving a final + /// [`GetPromptResult`]. Other transport, protocol, and local input-handler + /// errors are propagated. + pub async fn get_prompt_with_mrtr_max_rounds( + &self, + mut params: GetPromptRequestParams, + max_rounds: usize, + ) -> Result { + let mut state_only_rounds = 0usize; + for _round in 0..max_rounds { + match self.peer.get_prompt_once(params.clone()).await? { + GetPromptResponse::Complete(result) => return Ok(result), + GetPromptResponse::InputRequired(result) => { + let (input_responses, request_state) = self + .prepare_input_required_retry(result, &mut state_only_rounds) + .await?; + params.input_responses = input_responses; + params.request_state = request_state; + } + } + } + Err(ServiceError::InputRequiredRoundsExceeded { max_rounds }) + } + + /// High-level `resources/read` helper that automatically fulfils SEP-2322 + /// `input_required` rounds through the local [`ClientHandler`](crate::ClientHandler) service. + /// + /// # Errors + /// + /// Returns [`ServiceError::InputRequiredRoundsExceeded`] if the peer does + /// not produce a final [`ReadResourceResult`] within the default MRTR round + /// cap. Other transport, protocol, and local input-handler errors are + /// propagated. + pub async fn read_resource( + &self, + params: ReadResourceRequestParams, + ) -> Result { + self.read_resource_with_mrtr_max_rounds(params, DEFAULT_MRTR_MAX_ROUNDS) + .await + } + + /// Same as [`Self::read_resource`], with an explicit MRTR round cap. + /// + /// # Errors + /// + /// Returns [`ServiceError::InputRequiredRoundsExceeded`] once `max_rounds` + /// `input_required` responses have been driven without receiving a final + /// [`ReadResourceResult`]. Other transport, protocol, and local input-handler + /// errors are propagated. + pub async fn read_resource_with_mrtr_max_rounds( + &self, + mut params: ReadResourceRequestParams, + max_rounds: usize, + ) -> Result { + let mut state_only_rounds = 0usize; + for _round in 0..max_rounds { + match self.peer.read_resource_once(params.clone()).await? { + ReadResourceResponse::Complete(result) => return Ok(result), + ReadResourceResponse::InputRequired(result) => { + let (input_responses, request_state) = self + .prepare_input_required_retry(result, &mut state_only_rounds) + .await?; + params.input_responses = input_responses; + params.request_state = request_state; + } + } + } + Err(ServiceError::InputRequiredRoundsExceeded { max_rounds }) + } + + async fn prepare_input_required_retry( + &self, + result: InputRequiredResult, + state_only_rounds: &mut usize, + ) -> Result<(Option, Option), ServiceError> { + let had_input_requests = result + .input_requests + .as_ref() + .is_some_and(|requests| !requests.is_empty()); + if !had_input_requests && result.request_state.is_none() { + return Err(ServiceError::UnexpectedResponse); + } + + let responses = self + .fulfill_input_requests(result.input_requests.unwrap_or_default()) + .await?; + if had_input_requests { + *state_only_rounds = 0; + } else { + Self::sleep_state_only_round(*state_only_rounds).await; + *state_only_rounds += 1; + } + + Ok(( + (!responses.is_empty()).then_some(responses), + result.request_state, + )) + } + + async fn fulfill_input_requests( + &self, + requests: crate::model::InputRequests, + ) -> Result { + let responses = futures::future::try_join_all( + requests + .into_iter() + .map(|(key, request)| self.fulfill_input_request(key, request)), + ) + .await?; + Ok(responses.into_iter().collect()) + } + + async fn fulfill_input_request( + &self, + key: String, + request: InputRequest, + ) -> Result<(String, serde_json::Value), ServiceError> { + let response = match request { + InputRequest::CreateMessage(request) => { + let mut request = ServerRequest::CreateMessageRequest(request); + let context = self.input_request_context(&key, &mut request); + match self + .service + .handle_request(request, context) + .await + .map_err(ServiceError::McpError)? + { + ClientResult::CreateMessageResult(result) => { + serde_json::to_value(result).map_err(Self::serde_to_service_error)? + } + _ => return Err(ServiceError::UnexpectedResponse), + } + } + InputRequest::Elicitation(request) => { + let mut request = ServerRequest::ElicitRequest(request); + let context = self.input_request_context(&key, &mut request); + match self + .service + .handle_request(request, context) + .await + .map_err(ServiceError::McpError)? + { + ClientResult::ElicitResult(result) => { + serde_json::to_value(result).map_err(Self::serde_to_service_error)? + } + _ => return Err(ServiceError::UnexpectedResponse), + } + } + InputRequest::ListRoots(request) => { + let mut request = ServerRequest::ListRootsRequest(request); + let context = self.input_request_context(&key, &mut request); + match self + .service + .handle_request(request, context) + .await + .map_err(ServiceError::McpError)? + { + ClientResult::ListRootsResult(result) => { + serde_json::to_value(result).map_err(Self::serde_to_service_error)? + } + _ => return Err(ServiceError::UnexpectedResponse), + } + } + }; + Ok((key, response)) + } + + fn input_request_context(&self, key: &str, request: &mut T) -> RequestContext + where + T: GetMeta + GetExtensions, + { + let mut meta = Default::default(); + let mut extensions = Default::default(); + std::mem::swap(&mut meta, request.get_meta_mut()); + std::mem::swap(&mut extensions, request.extensions_mut()); + RequestContext { + ct: tokio_util::sync::CancellationToken::new(), + id: NumberOrString::String(Arc::from(key)), + peer: self.peer.clone(), + meta, + extensions, + } + } + + async fn sleep_state_only_round(state_only_rounds: usize) { + let millis = (50u64.saturating_mul(1_u64 << state_only_rounds.min(3))).min(250); + tokio::time::sleep(Duration::from_millis(millis)).await; + } + + fn serde_to_service_error(error: serde_json::Error) -> ServiceError { + ServiceError::McpError(ErrorData::internal_error( + format!("failed to serialize MRTR input response: {error}"), + None, + )) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[tokio::test] + async fn server_cancellation_retires_subscription_responder() { + tokio::task::LocalSet::new() + .run_until(async { + for (discover, version) in [ + (false, ProtocolVersion::V_2026_07_28), + (true, ProtocolVersion::V_2026_07_28), + (true, ProtocolVersion::V_2025_11_25), + ] { + tokio::time::timeout( + Duration::from_secs(5), + check_subscription_cancellation(discover, version), + ) + .await + .expect("subscription cancellation timed out"); + } + }) + .await; + } + + async fn check_subscription_cancellation(discover: bool, version: ProtocolVersion) { + use crate::model::{ + GetMeta, PingRequest, ServerInfo, SubscriptionsAcknowledgedNotification, + SubscriptionsAcknowledgedNotificationParams, + }; + + let (server_transport, client_transport) = tokio::io::duplex(4096); + let mut server = + crate::transport::IntoTransport::::into_transport(server_transport); + let info = ServerInfo { + protocol_version: version.clone(), + ..Default::default() + }; + let client = if discover { + let (client, ()) = tokio::join!( + serve_client_with_lifecycle( + (), + client_transport, + ClientLifecycleMode::Discover { + preferred_versions: vec![version.clone()] + } + ), + async { + let Some(ClientJsonRpcMessage::Request(request)) = server.receive().await + else { + panic!("expected discover request"); + }; + assert!(matches!(request.request, ClientRequest::DiscoverRequest(_))); + server + .send(ServerJsonRpcMessage::response( + ServerResult::DiscoverResult(DiscoverResult::new( + vec![version], + info.capabilities, + )), + request.id, + )) + .await + .unwrap(); + } + ); + client.unwrap() + } else { + super::super::serve_directly::( + (), + client_transport, + Some(info.into()), + ) + }; + let filter = SubscriptionFilter::default(); + let (subscription, ()) = tokio::join!(client.listen(filter.clone()), async { + let Some(ClientJsonRpcMessage::Request(request)) = server.receive().await else { + panic!("expected listen request"); + }; + assert!(matches!( + request.request, + ClientRequest::SubscriptionsListenRequest(_) + )); + let mut ack: ServerNotification = SubscriptionsAcknowledgedNotification::new( + SubscriptionsAcknowledgedNotificationParams::new(filter), + ) + .into(); + ack.get_meta_mut().set_subscription_id(request.id); + server + .send(ServerJsonRpcMessage::notification(ack)) + .await + .unwrap(); + }); + let mut subscription = subscription.unwrap(); + let id = subscription.id().clone(); + let mut ordinary = client + .send_cancellable_request( + PingRequest { + method: Default::default(), + extensions: Default::default(), + } + .into(), + PeerRequestOptions::no_options(), + ) + .await + .unwrap(); + assert!(matches!( + server.receive().await, + Some(ClientJsonRpcMessage::Request(_)) + )); + for unknown in [ + ordinary.id.clone(), + RequestId::String(id.to_string().into()), + RequestId::String("unknown".into()), + ] { + server + .send(ServerJsonRpcMessage::notification( + CancelledNotification::new(CancelledNotificationParam::new( + Some(unknown), + None, + )) + .into(), + )) + .await + .unwrap(); + } + server + .send(ServerJsonRpcMessage::request( + PingRequest { + method: Default::default(), + extensions: Default::default(), + } + .into(), + RequestId::String("before-cancellation".into()), + )) + .await + .unwrap(); + assert!(matches!( + server.receive().await, + Some(ClientJsonRpcMessage::Response(_)) + )); + assert!(matches!( + subscription.request.as_mut().unwrap().rx.try_recv(), + Err(tokio::sync::oneshot::error::TryRecvError::Empty) + )); + assert!(matches!( + ordinary.rx.try_recv(), + Err(tokio::sync::oneshot::error::TryRecvError::Empty) + )); + assert!(matches!( + subscription.notifications.try_recv(), + Err(tokio::sync::mpsc::error::TryRecvError::Empty) + )); + server + .send(ServerJsonRpcMessage::notification( + CancelledNotification::new(CancelledNotificationParam::new( + Some(id.clone()), + Some("subscription ended".to_owned()), + )) + .into(), + )) + .await + .unwrap(); + // Ordered input makes the ping response a barrier for cancellation handling. + server + .send(ServerJsonRpcMessage::request( + PingRequest { + method: Default::default(), + extensions: Default::default(), + } + .into(), + RequestId::String("after-cancellation".into()), + )) + .await + .unwrap(); + assert!(matches!( + server.receive().await, + Some(ClientJsonRpcMessage::Response(_)) + )); + assert!( + matches!( + subscription.request.as_mut().unwrap().rx.try_recv(), + Ok(Err(ServiceError::Cancelled { .. })) + ), + "the outbound responder must retire without a final response or disconnect" + ); + assert!(subscription.next().await.unwrap().is_none()); + assert!(matches!( + subscription.end(), + Some(SubscriptionEnd::Cancelled) + )); + assert!(client.peer().subscription_sender(&id).is_none()); + server + .send(ServerJsonRpcMessage::response( + ServerResult::empty(()), + ordinary.id.clone(), + )) + .await + .unwrap(); + assert!(ordinary.await_response().await.is_ok()); + + // Raw listen requests also retire, even without a registered notification channel. + let raw = client + .send_cancellable_request( + ClientRequest::SubscriptionsListenRequest(SubscriptionsListenRequest::new( + SubscriptionsListenRequestParams::new(SubscriptionFilter::default()), + )), + PeerRequestOptions::no_options(), + ) + .await + .unwrap(); + assert!(matches!( + server.receive().await, + Some(ClientJsonRpcMessage::Request(_)) + )); + server + .send(ServerJsonRpcMessage::notification( + CancelledNotification::new(CancelledNotificationParam::new( + Some(raw.id.clone()), + None, + )) + .into(), + )) + .await + .unwrap(); + assert!(matches!( + raw.await_response().await, + Err(ServiceError::Cancelled { .. }) + )); + client.cancel().await.unwrap(); + } + + #[tokio::test] + async fn auto_startup_falls_back_when_discover_is_ignored() { + use crate::model::{InitializeResult, ServerCapabilities}; + + tokio::task::LocalSet::new() + .run_until(async { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let mut server = + crate::transport::IntoTransport::::into_transport( + server_transport, + ); + let server_task = tokio::task::spawn_local(async move { + let ClientJsonRpcMessage::Request(discover) = + server.receive().await.expect("expected discover request") + else { + panic!("expected discover request"); + }; + assert!(matches!( + discover.request, + ClientRequest::DiscoverRequest(_) + )); + + let ClientJsonRpcMessage::Request(initialize) = + server.receive().await.expect("expected initialize request") + else { + panic!("expected initialize request"); + }; + assert!(matches!( + initialize.request, + ClientRequest::InitializeRequest(_) + )); + server + .send(ServerJsonRpcMessage::response( + ServerResult::InitializeResult(InitializeResult::new( + ServerCapabilities::default(), + )), + initialize.id, + )) + .await + .expect("send initialize response"); + assert!(matches!( + server.receive().await, + Some(ClientJsonRpcMessage::Notification(_)) + )); + }); + + let client_transport = + crate::transport::IntoTransport::::into_transport( + client_transport, + ); + let client = serve_client_with_ct_inner( + (), + client_transport, + ClientLifecycleMode::Auto { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + legacy_version: Some(ProtocolVersion::V_2025_11_25), + }, + CancellationToken::new(), + Duration::from_millis(25), + ) + .await + .expect("auto client should fall back after discover timeout"); + client.cancel().await.expect("cancel client"); + server_task.await.expect("server task"); + }) + .await; + } + + fn disconnected_peer() -> Peer { + let (peer, receiver) = + Peer::::new(Arc::new(AtomicU32RequestIdProvider::default()), None); + drop(receiver); + peer + } + + fn tools_result(ttl_ms: Option, cache_scope: Option) -> ListToolsResult { + let mut result = ListToolsResult::with_all_items(Vec::new()); + result.ttl_ms = ttl_ms; + result.cache_scope = cache_scope; + result + } + + #[tokio::test] + async fn fresh_cached_page_is_served_without_transport_io() { + let peer = disconnected_peer(); + let params = None::; + let key = list_response_cache_key(TOOL_LIST_CACHE_PREFIX, ¶ms); + let expected = tools_result(Some(5_000), Some(CacheScope::Public)); + peer.cache_response( + key, + ServerResult::ListToolsResult(expected.clone()), + expected.ttl_ms, + expected.cache_scope, + ) + .await; + + assert_eq!(peer.list_tools(params).await.unwrap(), expected); + } + + #[tokio::test] + async fn expired_entry_falls_through_to_the_transport() { + let peer = disconnected_peer(); + peer.set_response_cache_config( + ClientCacheConfig::default().with_serve_stale_on_error(false), + ) + .await; + let params = None::; + let key = list_response_cache_key(TOOL_LIST_CACHE_PREFIX, ¶ms); + peer.cache_response( + key, + ServerResult::ListToolsResult(tools_result(Some(1), Some(CacheScope::Public))), + Some(1), + Some(CacheScope::Public), + ) + .await; + tokio::time::sleep(Duration::from_millis(5)).await; + + assert!(matches!( + peer.list_tools(params).await, + Err(ServiceError::TransportClosed) + )); + } + + #[tokio::test] + async fn private_entries_are_isolated_between_authorization_partitions() { + let peer = disconnected_peer(); + let key = list_response_cache_key(TOOL_LIST_CACHE_PREFIX, &None); + + peer.set_response_cache_config( + ClientCacheConfig::default().with_private_partition("auth-a"), + ) + .await; + peer.cache_response( + key.clone(), + ServerResult::ListToolsResult(tools_result(Some(5_000), Some(CacheScope::Private))), + Some(5_000), + Some(CacheScope::Private), + ) + .await; + assert!(peer.cached_response(&key).await.is_some()); + + // Switching to a different authorization context must not expose the + // first partition's private entry. + peer.set_response_cache_config( + ClientCacheConfig::default().with_private_partition("auth-b"), + ) + .await; + assert!(peer.cached_response(&key).await.is_none()); + } + + #[tokio::test] + async fn list_change_notification_discards_every_cached_page() { + let peer = disconnected_peer(); + for cursor in [None, Some("page-a".into()), Some("page-b".into())] { + let params = + cursor.map(|cursor| PaginatedRequestParams::default().with_cursor(Some(cursor))); + let key = list_response_cache_key(TOOL_LIST_CACHE_PREFIX, ¶ms); + peer.cache_response( + key, + ServerResult::ListToolsResult(tools_result(Some(5_000), Some(CacheScope::Public))), + Some(5_000), + Some(CacheScope::Public), + ) + .await; + } + + peer.invalidate_tool_cache().await; + + for cursor in [None, Some("page-a".into()), Some("page-b".into())] { + let params = + cursor.map(|cursor| PaginatedRequestParams::default().with_cursor(Some(cursor))); + let key = list_response_cache_key(TOOL_LIST_CACHE_PREFIX, ¶ms); + assert!(peer.cached_response(&key).await.is_none()); + } + } + + #[tokio::test] + async fn expired_entry_is_served_when_refetch_fails() { + let peer = disconnected_peer(); + let params = None::; + let key = list_response_cache_key(TOOL_LIST_CACHE_PREFIX, ¶ms); + let expected = tools_result(Some(1), Some(CacheScope::Public)); + peer.cache_response( + key, + ServerResult::ListToolsResult(expected.clone()), + Some(1), + Some(CacheScope::Public), + ) + .await; + tokio::time::sleep(Duration::from_millis(5)).await; + + assert_eq!(peer.list_tools(params).await.unwrap(), expected); + } + + #[tokio::test] + async fn discover_serves_a_fresh_cached_response_without_transport_io() { + let peer = disconnected_peer(); + let meta = RequestMetaObject::default(); + let key = discover_cache_key(); + let expected = DiscoverResult::new(vec![ProtocolVersion::default()], Default::default()) + .with_server_info(crate::model::Implementation::from_build_env()) + .with_ttl_ms(5_000) + .with_cache_scope(CacheScope::Public); + peer.cache_response( + key, + ServerResult::DiscoverResult(expected.clone()), + Some(5_000), + Some(CacheScope::Public), + ) + .await; + + assert_eq!(peer.discover(meta).await.unwrap(), expected); + } +} + +#[cfg(test)] +mod sep2260_association_tests { + use super::*; + use crate::{ + model::{ + CreateMessageRequest, CreateMessageRequestParams, SamplingMessage, ServerCapabilities, + }, + service::PeerRequestAssociation, + }; + + fn sampling_request() -> ServerRequest { + ServerRequest::CreateMessageRequest(CreateMessageRequest::new( + CreateMessageRequestParams::new(vec![SamplingMessage::user_text("hi")], 16), + )) + } + + fn server_info(version: ProtocolVersion) -> ServerPeerInfo { + ServerPeerInfo::new(version, ServerCapabilities::default()) + } + + fn enforce( + info: &ServerPeerInfo, + association: PeerRequestAssociation, + ) -> Result<(), ErrorData> { + RoleClient::enforce_peer_request_association(&sampling_request(), Some(info), association) + } + + #[test] + fn strict_rejects_unassociated() { + let info = server_info(ProtocolVersion::V_2026_07_28); + let err = enforce(&info, PeerRequestAssociation::Unassociated).unwrap_err(); + assert_eq!(err.code, crate::model::ErrorCode::INVALID_PARAMS); + } + + #[test] + fn strict_accepts_associated() { + let info = server_info(ProtocolVersion::V_2026_07_28); + assert!(enforce(&info, PeerRequestAssociation::Associated).is_ok()); + } + + #[test] + fn strict_unknown_falls_back_to_coarse_check() { + let info = server_info(ProtocolVersion::V_2026_07_28); + assert!( + enforce( + &info, + PeerRequestAssociation::Unknown { + has_pending_outbound_request: true + } + ) + .is_ok() + ); + assert!( + enforce( + &info, + PeerRequestAssociation::Unknown { + has_pending_outbound_request: false + } + ) + .is_err() + ); + } + + #[test] + fn legacy_protocol_accepts_even_unassociated() { + let info = server_info(ProtocolVersion::V_2025_11_25); + assert!(enforce(&info, PeerRequestAssociation::Unassociated).is_ok()); + } +} diff --git a/vendor/rmcp/src/service/client/cache.rs b/vendor/rmcp/src/service/client/cache.rs new file mode 100644 index 00000000..f7137ccd --- /dev/null +++ b/vendor/rmcp/src/service/client/cache.rs @@ -0,0 +1,401 @@ +use std::{ + collections::HashMap, + sync::Arc, + time::{Duration, Instant}, +}; + +use super::RoleClient; +use crate::{ + model::CacheScope, + service::{Peer, ServiceRole}, +}; + +/// Maximum server-provided cache TTL honoured by the client response cache. +pub const MAX_CLIENT_CACHE_TTL: Duration = Duration::from_secs(24 * 60 * 60); + +/// Configuration for the built-in MCP client response cache. +/// +/// A cache is allocated per client [`Peer`]. Public responses may be reused +/// throughout that client connection. Private responses are additionally +/// partitioned by `private_partition`; changing the partition drops every +/// private entry while preserving public entries. +#[derive(Debug, Clone, PartialEq, Eq)] +#[non_exhaustive] +pub struct ClientCacheConfig { + /// Enables cache reads and writes. + pub enabled: bool, + /// TTL used when a backwards-compatible server omits `ttlMs`. + /// + /// The default is zero, which leaves such responses immediately stale. + pub default_ttl: Duration, + /// Upper bound applied to both server-provided and default TTLs. + pub max_ttl: Duration, + /// Stable opaque identity for the current authorization context. + /// + /// A single-principal client may leave this unset because each client owns + /// its own in-memory store. Gateways or clients that change principals on an + /// existing connection should set this value and update it whenever the + /// authorization context changes. + pub private_partition: Option, + /// Maximum number of responses retained by the in-memory cache. + /// + /// A value of zero disables the size limit. + pub max_entries: usize, + /// Serves an expired cached response when a re-fetch fails. + /// + /// SEP-2549 permits clients to serve stale responses if errors occur while + /// re-fetching (for example, network issues or server downtime). When this + /// is enabled the client retains expired entries so it can fall back to the + /// last known response instead of surfacing the transport or server error. + /// A successful re-fetch always overwrites the stale entry. + pub serve_stale_on_error: bool, +} + +impl Default for ClientCacheConfig { + fn default() -> Self { + Self { + enabled: true, + default_ttl: Duration::ZERO, + max_ttl: MAX_CLIENT_CACHE_TTL, + private_partition: None, + max_entries: 512, + serve_stale_on_error: true, + } + } +} + +impl ClientCacheConfig { + /// Returns a configuration that disables all cache reads and writes. + pub fn disabled() -> Self { + Self { + enabled: false, + ..Self::default() + } + } + + /// Sets the TTL used when a response omits `ttlMs`. + pub fn with_default_ttl(mut self, default_ttl: Duration) -> Self { + self.default_ttl = default_ttl; + self + } + + /// Sets the maximum TTL the client will honour. + pub fn with_max_ttl(mut self, max_ttl: Duration) -> Self { + self.max_ttl = max_ttl; + self + } + + /// Sets the stable partition for private responses. + pub fn with_private_partition(mut self, partition: impl Into) -> Self { + self.private_partition = Some(partition.into()); + self + } + + /// Sets the maximum number of retained responses. + pub fn with_max_entries(mut self, max_entries: usize) -> Self { + self.max_entries = max_entries; + self + } + + /// Controls whether an expired response may be served when a re-fetch fails. + pub fn with_serve_stale_on_error(mut self, serve_stale_on_error: bool) -> Self { + self.serve_stale_on_error = serve_stale_on_error; + self + } +} + +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +enum CachePartition { + Public, + Private(Arc), +} + +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +struct CacheKey { + logical_key: String, + partition: CachePartition, +} + +#[derive(Debug, Clone)] +struct CachedPeerResponse { + value: T, + expires_at: Instant, + inserted_at: Instant, + scope: CacheScope, +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub(crate) struct CacheGeneration(u64); + +#[derive(Debug)] +pub(crate) struct PeerResponseCacheState { + entries: HashMap>, + config: ClientCacheConfig, + generation: u64, +} + +impl Default for PeerResponseCacheState { + fn default() -> Self { + Self { + entries: HashMap::new(), + config: ClientCacheConfig::default(), + generation: 0, + } + } +} + +impl PeerResponseCacheState { + fn trim_to_limit(&mut self) { + while self.config.max_entries > 0 && self.entries.len() > self.config.max_entries { + let Some(oldest_key) = self + .entries + .iter() + .min_by_key(|(_, entry)| entry.inserted_at) + .map(|(key, _)| key.clone()) + else { + break; + }; + self.entries.remove(&oldest_key); + } + } +} + +pub(crate) type PeerResponseCache = Arc>>; + +impl Peer { + fn private_partition(config: &ClientCacheConfig) -> Arc { + Arc::from(config.private_partition.as_deref().unwrap_or("connection")) + } + + fn cache_key(logical_key: &str, partition: CachePartition) -> CacheKey { + CacheKey { + logical_key: logical_key.to_owned(), + partition, + } + } + + fn scoped_cache_key( + logical_key: &str, + scope: CacheScope, + config: &ClientCacheConfig, + ) -> CacheKey { + let partition = match scope { + CacheScope::Public => CachePartition::Public, + CacheScope::Private => CachePartition::Private(Self::private_partition(config)), + }; + Self::cache_key(logical_key, partition) + } + + /// Captures the cache generation before a request crosses the transport. + /// + /// Any configuration change, explicit clear, or notification invalidation + /// advances the generation. A response from an older generation is not + /// written back, preventing an in-flight stale response from undoing an + /// invalidation. + pub(crate) async fn capture_response_cache_generation(&self) -> CacheGeneration { + CacheGeneration(self.response_cache.read().await.generation) + } + + /// Returns a fresh cached response, preferring the current private partition + /// before the public partition. + /// + /// Expired entries are removed on access unless `serve_stale_on_error` is + /// enabled, in which case they are retained so a later re-fetch failure can + /// fall back to them via [`Peer::stale_cached_response`]. + pub(crate) async fn cached_response(&self, logical_key: &str) -> Option { + let now = Instant::now(); + let mut cache = self.response_cache.write().await; + if !cache.config.enabled { + return None; + } + let keep_stale = cache.config.serve_stale_on_error; + + let private_key = Self::cache_key( + logical_key, + CachePartition::Private(Self::private_partition(&cache.config)), + ); + let private_fresh = cache.entries.get(&private_key).and_then(|entry| { + (entry.expires_at > now && entry.scope == CacheScope::Private) + .then(|| entry.value.clone()) + }); + if let Some(value) = private_fresh { + return Some(value); + } + if !keep_stale { + cache.entries.remove(&private_key); + } + + let public_key = Self::cache_key(logical_key, CachePartition::Public); + let public_fresh = cache.entries.get(&public_key).and_then(|entry| { + (entry.expires_at > now && entry.scope == CacheScope::Public) + .then(|| entry.value.clone()) + }); + if let Some(value) = public_fresh { + return Some(value); + } + if !keep_stale { + cache.entries.remove(&public_key); + } + None + } + + /// Returns a cached response ignoring its TTL, for use as a fallback when a + /// re-fetch fails (SEP-2549 permits serving stale responses on error). + /// + /// Returns `None` when the cache is disabled or `serve_stale_on_error` is + /// turned off. The private partition is preferred over the public one. The + /// entry is left in place so repeated failures keep serving it until a + /// successful re-fetch overwrites it or a notification invalidates it. + pub(crate) async fn stale_cached_response(&self, logical_key: &str) -> Option { + let cache = self.response_cache.read().await; + if !cache.config.enabled || !cache.config.serve_stale_on_error { + return None; + } + + let private_key = Self::cache_key( + logical_key, + CachePartition::Private(Self::private_partition(&cache.config)), + ); + if let Some(entry) = cache.entries.get(&private_key) + && entry.scope == CacheScope::Private + { + return Some(entry.value.clone()); + } + + let public_key = Self::cache_key(logical_key, CachePartition::Public); + if let Some(entry) = cache.entries.get(&public_key) + && entry.scope == CacheScope::Public + { + return Some(entry.value.clone()); + } + None + } + + /// Stores a response when the configured effective TTL is positive. + /// + /// Missing `cacheScope` is treated as private. This is deliberately more + /// conservative than the model's backwards-compatible wire default and + /// prevents an older or malformed server response from becoming shareable. + pub(crate) async fn cache_response_with_generation( + &self, + logical_key: String, + value: R::PeerResp, + ttl_ms: Option, + cache_scope: Option, + generation: CacheGeneration, + ) { + let now = Instant::now(); + let mut cache = self.response_cache.write().await; + if !cache.config.enabled || generation.0 != cache.generation { + return; + } + + let requested_ttl = ttl_ms + .map(Duration::from_millis) + .unwrap_or(cache.config.default_ttl); + let ttl = requested_ttl.min(cache.config.max_ttl); + if ttl.is_zero() { + return; + } + let Some(expires_at) = now.checked_add(ttl) else { + return; + }; + let scope = cache_scope.unwrap_or(CacheScope::Private); + let target_key = Self::scoped_cache_key(&logical_key, scope, &cache.config); + let opposite_key = match scope { + CacheScope::Public => Self::cache_key( + &logical_key, + CachePartition::Private(Self::private_partition(&cache.config)), + ), + CacheScope::Private => Self::cache_key(&logical_key, CachePartition::Public), + }; + + if !cache.config.serve_stale_on_error { + cache.entries.retain(|_, entry| entry.expires_at > now); + } + cache.entries.remove(&opposite_key); + + if cache.config.max_entries > 0 + && !cache.entries.contains_key(&target_key) + && cache.entries.len() >= cache.config.max_entries + && let Some(oldest_key) = cache + .entries + .iter() + .min_by_key(|(_, entry)| entry.inserted_at) + .map(|(key, _)| key.clone()) + { + cache.entries.remove(&oldest_key); + } + + cache.entries.insert( + target_key, + CachedPeerResponse { + value, + expires_at, + inserted_at: now, + scope, + }, + ); + } + + #[cfg(test)] + pub(crate) async fn cache_response( + &self, + logical_key: String, + value: R::PeerResp, + ttl_ms: Option, + cache_scope: Option, + ) { + let generation = self.capture_response_cache_generation().await; + self.cache_response_with_generation(logical_key, value, ttl_ms, cache_scope, generation) + .await; + } + + pub(crate) async fn invalidate_cached_responses(&self, prefix: &str) { + let mut cache = self.response_cache.write().await; + cache.generation = cache.generation.wrapping_add(1); + cache + .entries + .retain(|key, _| !key.logical_key.starts_with(prefix)); + } +} + +impl Peer { + /// Replaces the response-cache configuration. + /// + /// Changing the private partition invalidates private entries from the old + /// authorization context. Disabling the cache clears every entry. Any + /// configuration change also suppresses writes from requests that were + /// already in flight under the previous configuration. + pub async fn set_response_cache_config(&self, config: ClientCacheConfig) { + let mut cache = self.response_cache.write().await; + let config_changed = cache.config != config; + let partition_changed = cache.config.private_partition != config.private_partition; + let ttl_policy_changed = cache.config.default_ttl != config.default_ttl + || cache.config.max_ttl != config.max_ttl; + cache.config = config; + if config_changed { + cache.generation = cache.generation.wrapping_add(1); + } + if !cache.config.enabled || ttl_policy_changed { + cache.entries.clear(); + } else if partition_changed { + cache + .entries + .retain(|_, entry| entry.scope == CacheScope::Public); + } + cache.trim_to_limit(); + } + + /// Returns a snapshot of the active response-cache configuration. + pub async fn response_cache_config(&self) -> ClientCacheConfig { + self.response_cache.read().await.config.clone() + } + + /// Clears every cached client response without changing the configuration. + pub async fn clear_response_cache(&self) { + let mut cache = self.response_cache.write().await; + cache.generation = cache.generation.wrapping_add(1); + cache.entries.clear(); + } +} diff --git a/vendor/rmcp/src/service/server.rs b/vendor/rmcp/src/service/server.rs new file mode 100644 index 00000000..0bf1d4c7 --- /dev/null +++ b/vendor/rmcp/src/service/server.rs @@ -0,0 +1,1410 @@ +// Sampling/Roots/Logging are SEP-2577-deprecated; internal references are expected. +#![expect(deprecated)] +#[cfg(feature = "elicitation")] +use std::collections::HashSet; +use std::{borrow::Cow, sync::Arc}; + +use thiserror::Error; +#[cfg(feature = "elicitation")] +use url::Url; + +use super::*; +#[cfg(feature = "elicitation")] +use crate::model::{ElicitRequest, ElicitRequestParams, ElicitResult, ElicitationAction}; +use crate::{ + model::{ + CancelledNotification, CancelledNotificationParam, ClientJsonRpcMessage, + ClientNotification, ClientRequest, ClientResult, CreateMessageRequest, + CreateMessageRequestParams, CreateMessageResult, EmptyResult, ErrorData, + InitializeRequestParams, ListRootsRequest, ListRootsResult, LoggingMessageNotification, + LoggingMessageNotificationParam, ProgressNotification, ProgressNotificationParam, + PromptListChangedNotification, ProtocolVersion, ResourceListChangedNotification, + ResourceUpdatedNotification, ResourceUpdatedNotificationParam, ServerConfig, + ServerNotification, ServerRequest, ServerResult, SubscriptionFilter, + SubscriptionsAcknowledgedNotification, SubscriptionsAcknowledgedNotificationParams, + ToolListChangedNotification, + }, + transport::DynamicTransportError, +}; + +#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)] +#[expect(clippy::exhaustive_structs, reason = "intentionally exhaustive")] +pub struct RoleServer; + +impl ServiceRole for RoleServer { + type Req = ServerRequest; + type Resp = ServerResult; + type Not = ServerNotification; + type PeerReq = ClientRequest; + type PeerResp = ClientResult; + type PeerNot = ClientNotification; + type Info = ServerConfig; + type PeerInfo = InitializeRequestParams; + + type InitializeError = ServerInitializeError; + const IS_CLIENT: bool = false; + + fn peer_cancelled_params(notification: &Self::PeerNot) -> Option<&CancelledNotificationParam> { + match notification { + ClientNotification::CancelledNotification(notification) => Some(¬ification.params), + _ => None, + } + } + + fn enforce_request_association( + request: &Self::Req, + peer_info: Option<&Self::PeerInfo>, + in_request_handler_scope: bool, + ) -> Result<(), ServiceError> { + let restricted = matches!( + request, + ServerRequest::CreateMessageRequest(_) + | ServerRequest::ListRootsRequest(_) + | ServerRequest::ElicitRequest(_) + ); + if !restricted { + return Ok(()); + } + let strict = + peer_info.is_some_and(|info| info.protocol_version >= ProtocolVersion::V_2026_07_28); + if strict && !in_request_handler_scope { + return Err(ServiceError::McpError(ErrorData::invalid_request( + "SEP-2260: server-to-client requests must be associated with an originating client request", + None, + ))); + } + Ok(()) + } +} + +/// It represents the error that may occur when serving the server. +/// +/// if you want to handle the error, you can use `serve_server_with_ct` or `serve_server` with `Result, ServerError>` +#[derive(Error, Debug)] +#[non_exhaustive] +pub enum ServerInitializeError { + #[error("expect initialized request, but received: {0:?}")] + ExpectedInitializeRequest(Option), + + #[error("connection closed: {0}")] + ConnectionClosed(String), + + #[error("unexpected initialize result: {0:?}")] + UnexpectedInitializeResponse(ServerResult), + + #[error("initialize failed: {0}")] + InitializeFailed(ErrorData), + + #[error("Send message error {error}, when {context}")] + TransportError { + error: DynamicTransportError, + context: Cow<'static, str>, + }, + + #[error("Cancelled")] + Cancelled, +} + +impl ServerInitializeError { + pub fn transport + 'static>( + error: T::Error, + context: impl Into>, + ) -> Self { + Self::TransportError { + error: DynamicTransportError::new::(error), + context: context.into(), + } + } +} +pub type ClientSink = Peer; + +/// Failure to send a notification through a [`SubscriptionSink`]. +#[derive(Debug, Error)] +#[non_exhaustive] +pub enum SubscriptionSendError { + #[error("subscription is no longer active")] + SubscriptionClosed, + #[error("notification is not allowed on a subscription stream: {0}")] + UnsupportedNotification(&'static str), + #[error("notification was not accepted for this subscription: {0}")] + NotificationNotAccepted(&'static str), + #[error(transparent)] + Service(#[from] ServiceError), +} + +/// A server-side notification sink scoped to one `subscriptions/listen` request. +/// +/// The sink applies the accepted filter and adds the subscription request ID to +/// every notification it sends. +#[derive(Debug, Clone)] +pub struct SubscriptionSink { + peer: Peer, + id: RequestId, + accepted: Arc, + active: CancellationToken, +} + +impl SubscriptionSink { + fn new( + peer: Peer, + id: RequestId, + accepted: Arc, + active: CancellationToken, + ) -> Self { + Self { + peer, + id, + accepted, + active, + } + } + + /// Return the JSON-RPC ID of the originating listen request. + pub fn id(&self) -> &RequestId { + &self.id + } + + /// Return the filter accepted for this subscription. + pub fn accepted(&self) -> &SubscriptionFilter { + self.accepted.as_ref() + } + + /// Send an allowed change notification with subscription metadata attached. + /// + /// # Errors + /// + /// Returns [`SubscriptionSendError::SubscriptionClosed`] after the request + /// ends, a filter error for disallowed notifications, or a transport error. + pub async fn send( + &self, + mut notification: ServerNotification, + ) -> Result<(), SubscriptionSendError> { + if self.active.is_cancelled() { + return Err(SubscriptionSendError::SubscriptionClosed); + } + match ¬ification { + ServerNotification::ToolListChangedNotification(_) => { + if self.accepted.tools_list_changed != Some(true) { + return Err(SubscriptionSendError::NotificationNotAccepted( + "notifications/tools/list_changed", + )); + } + } + ServerNotification::PromptListChangedNotification(_) => { + if self.accepted.prompts_list_changed != Some(true) { + return Err(SubscriptionSendError::NotificationNotAccepted( + "notifications/prompts/list_changed", + )); + } + } + ServerNotification::ResourceListChangedNotification(_) => { + if self.accepted.resources_list_changed != Some(true) { + return Err(SubscriptionSendError::NotificationNotAccepted( + "notifications/resources/list_changed", + )); + } + } + ServerNotification::ResourceUpdatedNotification(update) => { + let accepted = self + .accepted + .resource_subscriptions + .as_ref() + .is_some_and(|uris| uris.contains(&update.params.uri)); + if !accepted { + return Err(SubscriptionSendError::NotificationNotAccepted( + "notifications/resources/updated", + )); + } + } + ServerNotification::SubscriptionsAcknowledgedNotification(_) => { + return Err(SubscriptionSendError::UnsupportedNotification( + "notifications/subscriptions/acknowledged", + )); + } + ServerNotification::CancelledNotification(_) => { + return Err(SubscriptionSendError::UnsupportedNotification( + "notifications/cancelled", + )); + } + ServerNotification::ProgressNotification(_) => { + return Err(SubscriptionSendError::UnsupportedNotification( + "notifications/progress", + )); + } + ServerNotification::LoggingMessageNotification(_) => { + return Err(SubscriptionSendError::UnsupportedNotification( + "notifications/message", + )); + } + // SEP-2663 task status notifications are not yet routable through + // `subscriptions/listen`: `SubscriptionFilter` has no `taskIds` + // field yet (the upstream conformance check for this flow is also + // still skipped, pending the subscriptions/listen rewrite). + // Clients currently observe task state by polling `tasks/get`. + ServerNotification::TaskStatusNotification(_) => { + return Err(SubscriptionSendError::UnsupportedNotification( + "notifications/tasks", + )); + } + ServerNotification::CustomNotification(_) => { + return Err(SubscriptionSendError::UnsupportedNotification( + "custom notification", + )); + } + } + + notification + .get_meta_mut() + .set_subscription_id(self.id.clone()); + self.peer.send_notification(notification).await?; + Ok(()) + } + + /// Send `notifications/tools/list_changed`. + /// + /// # Errors + /// + /// See [`Self::send`]. + pub async fn notify_tool_list_changed(&self) -> Result<(), SubscriptionSendError> { + self.send(ServerNotification::ToolListChangedNotification( + ToolListChangedNotification { + method: Default::default(), + extensions: Default::default(), + }, + )) + .await + } + + /// Send `notifications/prompts/list_changed`. + /// + /// # Errors + /// + /// See [`Self::send`]. + pub async fn notify_prompt_list_changed(&self) -> Result<(), SubscriptionSendError> { + self.send(ServerNotification::PromptListChangedNotification( + PromptListChangedNotification { + method: Default::default(), + extensions: Default::default(), + }, + )) + .await + } + + /// Send `notifications/resources/list_changed`. + /// + /// # Errors + /// + /// See [`Self::send`]. + pub async fn notify_resource_list_changed(&self) -> Result<(), SubscriptionSendError> { + self.send(ServerNotification::ResourceListChangedNotification( + ResourceListChangedNotification { + method: Default::default(), + extensions: Default::default(), + }, + )) + .await + } + + /// Send `notifications/resources/updated` for an accepted URI. + /// + /// # Errors + /// + /// See [`Self::send`]. + pub async fn notify_resource_updated( + &self, + uri: impl Into, + ) -> Result<(), SubscriptionSendError> { + self.send(ServerNotification::ResourceUpdatedNotification( + ResourceUpdatedNotification::new(ResourceUpdatedNotificationParam::new(uri)), + )) + .await + } +} + +/// Context for one established server-side notification subscription. +/// +/// The acknowledgment has already been sent before this context is handed to +/// [`ServerHandler::listen`](crate::ServerHandler::listen). +#[derive(Debug)] +pub struct SubscriptionContext { + request: RequestContext, + requested: SubscriptionFilter, + accepted: Arc, + sink: SubscriptionSink, + _active_guard: DropGuard, +} + +impl SubscriptionContext { + pub(crate) async fn establish( + request: RequestContext, + requested: SubscriptionFilter, + accepted: SubscriptionFilter, + ) -> Result { + let active = request.ct.child_token(); + let accepted = Arc::new(accepted); + let sink = SubscriptionSink::new( + request.peer.clone(), + request.id.clone(), + accepted.clone(), + active.clone(), + ); + let mut acknowledgment = SubscriptionsAcknowledgedNotification::new( + SubscriptionsAcknowledgedNotificationParams::new(accepted.as_ref().clone()), + ); + let mut meta = NotificationMetaObject::new(); + meta.set_subscription_id(request.id.clone()); + acknowledgment.extensions.insert(meta); + request + .peer + .send_notification(ServerNotification::SubscriptionsAcknowledgedNotification( + acknowledgment, + )) + .await + .map_err(|error| { + ErrorData::internal_error( + format!("failed to acknowledge subscription: {error}"), + None, + ) + })?; + Ok(Self { + request, + requested, + accepted, + sink, + _active_guard: active.drop_guard(), + }) + } + + /// Return the filter requested by the client. + pub fn requested(&self) -> &SubscriptionFilter { + &self.requested + } + + /// Return the subset accepted by the server. + pub fn accepted(&self) -> &SubscriptionFilter { + self.accepted.as_ref() + } + + /// Return a cloneable, filter-enforcing notification sink. + pub fn sink(&self) -> &SubscriptionSink { + &self.sink + } + + /// Wait until the subscription request is cancelled. + pub async fn cancelled(&self) { + self.request.ct.cancelled().await; + } + + /// Access the underlying request context. + pub fn request_context(&self) -> &RequestContext { + &self.request + } +} + +impl> ServiceExt for S { + fn serve_with_ct( + self, + transport: T, + ct: CancellationToken, + ) -> impl Future, ServerInitializeError>> + + MaybeSendFuture + where + T: IntoTransport, + E: std::error::Error + Send + Sync + 'static, + Self: Sized, + { + serve_server_with_ct(self, transport, ct) + } +} + +pub async fn serve_server( + service: S, + transport: T, +) -> Result, ServerInitializeError> +where + S: Service, + T: IntoTransport, + E: std::error::Error + Send + Sync + 'static, +{ + serve_server_with_ct(service, transport, CancellationToken::new()).await +} + +/// Helper function to get the next message from the stream +async fn expect_next_message( + transport: &mut T, + context: &str, +) -> Result +where + T: Transport, +{ + transport + .receive() + .await + .ok_or_else(|| ServerInitializeError::ConnectionClosed(context.to_string())) +} + +pub async fn serve_server_with_ct( + service: S, + transport: T, + ct: CancellationToken, +) -> Result, ServerInitializeError> +where + S: Service, + T: IntoTransport, + E: std::error::Error + Send + Sync + 'static, +{ + tokio::select! { + result = serve_server_with_ct_inner(service, transport.into_transport(), ct.clone()) => { result } + _ = ct.cancelled() => { + Err(ServerInitializeError::Cancelled) + } + } +} + +/// Echoes the client-requested version if the server can serve it over the +/// `initialize` handshake; otherwise returns a legacy version the server does +/// support. +/// +/// `server_supported` comes from [`Service::supported_protocol_versions`], so a +/// server that narrows that list is never made to answer `initialize` with a +/// version it cannot serve. [`ProtocolVersion::NO_INITIALIZE`] replaced the +/// handshake with per-request metadata, so a client naming that revision or +/// later is answered with the server's newest handshake version instead. +/// +/// `preferred_fallback` is a *preference*, not a guarantee: it is honored only +/// when it has an `initialize` handshake of its own. A server that pins itself +/// past [`ProtocolVersion::NO_INITIALIZE`] still has to answer the handshake +/// with something, so the newest handshake version in `server_supported` is +/// substituted. +/// +/// # Errors +/// +/// Returns [`ErrorCode::UNSUPPORTED_PROTOCOL_VERSION`] when the server supports +/// no version that still has an `initialize` handshake. +/// +/// [`ErrorCode::UNSUPPORTED_PROTOCOL_VERSION`]: crate::model::ErrorCode::UNSUPPORTED_PROTOCOL_VERSION +pub(crate) fn negotiate_protocol_version( + client_requested: &ProtocolVersion, + preferred_fallback: ProtocolVersion, + server_supported: &[ProtocolVersion], +) -> Result { + // [codesearch bridge — re-apply when bumping rmcp] Clients that offer the + // 2026-07-28 revision over the initialize handshake (Claude Code >= + // 2.1.296) require the SEP-2322 `resultType` discriminator on every + // result, but upstream pins such sessions to 2025-11-25 and then strips + // the discriminator, which those clients reject with "missing required + // resultType". Honor the explicit request (clamped to the newest revision + // this SDK implements) so the session keeps 2026-07-28 semantics and + // `strip_result_type_for_legacy_peer` leaves results intact. + if client_requested.as_str() >= ProtocolVersion::V_2026_07_28.as_str() { + return Ok(if client_requested.as_str() == ProtocolVersion::V_2026_07_28.as_str() { + client_requested.clone() + } else { + ProtocolVersion::V_2026_07_28.clone() + }); + } + if client_requested.has_initialize() && server_supported.contains(client_requested) { + return Ok(client_requested.clone()); + } + let fallback = if preferred_fallback.has_initialize() { + Some(preferred_fallback) + } else { + newest_version_with_initialize(server_supported) + }; + let Some(negotiated) = fallback else { + tracing::warn!( + client_requested = %client_requested, + "server supports no protocol version with an initialize handshake; rejecting" + ); + return Err(ErrorData::unsupported_protocol_version( + client_requested.clone(), + server_supported, + )); + }; + // Falling back is the designed answer for a pinned client, and stateless + // HTTP re-runs it on every request, so this is not a warning. + tracing::debug!( + client_requested = %client_requested, + negotiated = %negotiated, + "client requested a protocol version unavailable over initialize; falling back to a supported version" + ); + Ok(negotiated) +} + +/// The newest of `versions` that still has an `initialize` handshake. +fn newest_version_with_initialize(versions: &[ProtocolVersion]) -> Option { + versions + .iter() + .filter(|version| version.has_initialize()) + .max_by(|left, right| left.as_str().cmp(right.as_str())) + .cloned() +} + +fn missing_request_metadata_error(missing: &[&str]) -> ErrorData { + ErrorData::invalid_params( + format!( + "request _meta is missing or has malformed required fields: {}", + missing.join(", ") + ), + None, + ) +} + +/// Sends `error` as the response to the `initialize` request and reports it as +/// the reason the handshake failed. +async fn report_initialize_failure( + transport: &mut T, + error: ErrorData, + id: RequestId, +) -> ServerInitializeError +where + T: Transport + 'static, +{ + match transport + .send(ServerJsonRpcMessage::error(error.clone(), Some(id))) + .await + { + Ok(()) => ServerInitializeError::InitializeFailed(error), + Err(send_error) => { + ServerInitializeError::transport::(send_error, "sending error response") + } + } +} + +async fn serve_server_with_ct_inner( + service: S, + transport: T, + ct: CancellationToken, +) -> Result, ServerInitializeError> +where + S: Service, + T: Transport + 'static, +{ + let mut transport = transport.into_transport(); + let id_provider = >::default(); + + // Get initialize request; the MCP spec permits ping before initialize. + // See: https://modelcontextprotocol.io/specification/2025-11-25/basic/lifecycle#initialization + let (request, id) = loop { + let msg = expect_next_message(&mut transport, "initialize request").await?; + match msg { + ClientJsonRpcMessage::Request(req) + if matches!(req.request, ClientRequest::PingRequest(_)) => + { + transport + .send(ServerJsonRpcMessage::response( + ServerResult::EmptyResult(EmptyResult {}), + req.id, + )) + .await + .map_err(|error| { + ServerInitializeError::transport::( + error, + "sending pre-init ping response", + ) + })?; + } + ClientJsonRpcMessage::Request(req) => break (req.request, req.id), + other => { + return Err(ServerInitializeError::ExpectedInitializeRequest(Some( + other, + ))); + } + } + }; + + let initialize_request = match request { + ClientRequest::InitializeRequest(request) => request, + request => { + let missing_metadata = request + .get_meta() + .missing_required_keys(&ProtocolVersion::V_2026_07_28); + if !missing_metadata.is_empty() { + transport + .send(ServerJsonRpcMessage::error( + missing_request_metadata_error(&missing_metadata), + Some(id.clone()), + )) + .await + .map_err(|error| { + ServerInitializeError::transport::( + error, + "sending pre-init metadata error response", + ) + })?; + return Err(ServerInitializeError::ExpectedInitializeRequest(Some( + ClientJsonRpcMessage::request(request, id), + ))); + } + let (peer, peer_rx) = Peer::new(id_provider, None); + peer.require_request_metadata(); + // Dispatch the request from inside the service loop rather than + // inline: its handler may send notifications through `peer`, which + // only complete once the loop drains `peer_rx`. + return Ok(serve_inner( + service, + transport, + peer, + peer_rx, + VecDeque::from([ClientJsonRpcMessage::request(request, id)]), + ct, + )); + } + }; + let requested_protocol_version = initialize_request.params.protocol_version.clone(); + let mut negotiated_peer_info = initialize_request.params.clone(); + let (peer, peer_rx) = Peer::new(id_provider, Some(negotiated_peer_info.clone())); + let request = ClientRequest::InitializeRequest(initialize_request); + let context = RequestContext { + ct: ct.child_token(), + id: id.clone(), + meta: request.get_meta().clone(), + extensions: request.extensions().clone(), + peer: peer.clone(), + }; + // Send initialize response + let mut init_response = match service.handle_request(request, context).await { + Ok(ServerResult::InitializeResult(init_response)) => init_response, + Ok(result) => { + return Err(ServerInitializeError::UnexpectedInitializeResponse(result)); + } + Err(e) => return Err(report_initialize_failure(&mut transport, e, id).await), + }; + init_response.protocol_version = match negotiate_protocol_version( + &requested_protocol_version, + init_response.protocol_version, + &service.supported_protocol_versions(), + ) { + Ok(version) => version, + Err(e) => return Err(report_initialize_failure(&mut transport, e, id).await), + }; + // Update peer_info so context.protocol_version() reflects the negotiated + // version in all subsequent request handlers. + negotiated_peer_info.protocol_version = init_response.protocol_version.clone(); + peer.set_peer_info(negotiated_peer_info); + transport + .send(ServerJsonRpcMessage::response( + ServerResult::InitializeResult(init_response), + id, + )) + .await + .map_err(|error| { + ServerInitializeError::transport::(error, "sending initialize response") + })?; + + // Enter the main service loop immediately after sending InitializeResult. + // The initialized notification will be handled as a regular notification by serve_inner. + // This matches the TypeScript SDK behavior: no init gate, no waiting for initialized. + // Streamable HTTP has no ordering guarantee between POSTs, and the MCP spec uses + // SHOULD NOT (not MUST NOT) for pre-initialized messages, so any request arriving + // before initialized is processed normally. + Ok(serve_inner( + service, + transport, + peer, + peer_rx, + VecDeque::new(), + ct, + )) +} + +macro_rules! method { + ($(#[$meta:meta])* peer_req $method:ident $Req:ident() => $Resp: ident ) => { + $(#[$meta])* + pub async fn $method(&self) -> Result<$Resp, ServiceError> { + let result = self + .send_request(ServerRequest::$Req($Req { + method: Default::default(), + extensions: Default::default(), + })) + .await?; + match result { + ClientResult::$Resp(result) => Ok(result), + _ => Err(ServiceError::UnexpectedResponse), + } + } + }; + ($(#[$meta:meta])* peer_req $method:ident $Req:ident($Param: ident) => $Resp: ident ) => { + $(#[$meta])* + pub async fn $method(&self, params: $Param) -> Result<$Resp, ServiceError> { + let result = self + .send_request(ServerRequest::$Req($Req { + method: Default::default(), + params, + extensions: Default::default(), + })) + .await?; + match result { + ClientResult::$Resp(result) => Ok(result), + _ => Err(ServiceError::UnexpectedResponse), + } + } + }; + ($(#[$meta:meta])* peer_req $method:ident $Req:ident($Param: ident)) => { + $(#[$meta])* + pub fn $method( + &self, + params: $Param, + ) -> impl Future> + Send + '_ { + async move { + let result = self + .send_request(ServerRequest::$Req($Req { + method: Default::default(), + params, + })) + .await?; + match result { + ClientResult::EmptyResult(_) => Ok(()), + _ => Err(ServiceError::UnexpectedResponse), + } + } + } + }; + + ($(#[$meta:meta])* peer_not $method:ident $Not:ident($Param: ident)) => { + $(#[$meta])* + pub async fn $method(&self, params: $Param) -> Result<(), ServiceError> { + self.send_notification(ServerNotification::$Not($Not { + method: Default::default(), + params, + extensions: Default::default(), + })) + .await?; + Ok(()) + } + }; + ($(#[$meta:meta])* peer_not $method:ident $Not:ident) => { + $(#[$meta])* + pub async fn $method(&self) -> Result<(), ServiceError> { + self.send_notification(ServerNotification::$Not($Not { + method: Default::default(), + extensions: Default::default(), + })) + .await?; + Ok(()) + } + }; + + // Timeout-only variants (base method should be created separately with peer_req) + ($(#[$meta:meta])* peer_req_with_timeout $method_with_timeout:ident $Req:ident() => $Resp: ident) => { + $(#[$meta])* + pub async fn $method_with_timeout( + &self, + timeout: Option, + ) -> Result<$Resp, ServiceError> { + let request = ServerRequest::$Req($Req { + method: Default::default(), + extensions: Default::default(), + }); + let options = crate::service::PeerRequestOptions { + timeout, + meta: None, + reset_timeout_on_progress: false, + max_total_timeout: None, + }; + let result = self + .send_request_with_option(request, options) + .await? + .await_response() + .await?; + match result { + ClientResult::$Resp(result) => Ok(result), + _ => Err(ServiceError::UnexpectedResponse), + } + } + }; + + ($(#[$meta:meta])* peer_req_with_timeout $method_with_timeout:ident $Req:ident($Param: ident) => $Resp: ident) => { + $(#[$meta])* + pub async fn $method_with_timeout( + &self, + params: $Param, + timeout: Option, + ) -> Result<$Resp, ServiceError> { + let request = ServerRequest::$Req($Req { + method: Default::default(), + params, + extensions: Default::default(), + }); + let options = crate::service::PeerRequestOptions { + timeout, + meta: None, + reset_timeout_on_progress: false, + max_total_timeout: None, + }; + let result = self + .send_request_with_option(request, options) + .await? + .await_response() + .await?; + match result { + ClientResult::$Resp(result) => Ok(result), + _ => Err(ServiceError::UnexpectedResponse), + } + } + }; +} + +impl Peer { + /// Check if the client supports sampling tools capability. + pub fn supports_sampling_tools(&self) -> bool { + if let Some(client_info) = self.peer_info() { + client_info + .capabilities + .sampling + .as_ref() + .and_then(|s| s.tools.as_ref()) + .is_some() + } else { + false + } + } + + /// # SEP-2260: request association + /// + /// From protocol version `2026-07-28` this must be issued while handling a + /// client request; see [`OriginatingRequestId`]. + #[deprecated( + since = "1.8.0", + note = "Sampling is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" + )] + pub async fn create_message( + &self, + params: CreateMessageRequestParams, + ) -> Result { + // MUST throw error when tools/toolChoice provided without capability + if (params.tools.is_some() || params.tool_choice.is_some()) + && !self.supports_sampling_tools() + { + return Err(ServiceError::McpError(ErrorData::invalid_params( + "tools or toolChoice provided but client does not support sampling tools capability", + None, + ))); + } + // Validate message structure + params + .validate() + .map_err(|e| ServiceError::McpError(ErrorData::invalid_params(e, None)))?; + let result = self + .send_request(ServerRequest::CreateMessageRequest(CreateMessageRequest { + method: Default::default(), + params, + extensions: Default::default(), + })) + .await?; + match result { + ClientResult::CreateMessageResult(result) => Ok(*result), + _ => Err(ServiceError::UnexpectedResponse), + } + } + method!( + /// # SEP-2260: request association + /// + /// From protocol version `2026-07-28` this must be issued while handling a + /// client request; see [`OriginatingRequestId`]. + #[deprecated( + since = "1.8.0", + note = "Roots is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" + )] + peer_req list_roots ListRootsRequest() => ListRootsResult + ); + #[cfg(feature = "elicitation")] + method!( + /// # SEP-2260: request association + /// + /// From protocol version `2026-07-28` this must be issued while handling a + /// client request; see [`OriginatingRequestId`]. + peer_req create_elicitation ElicitRequest(ElicitRequestParams) => ElicitResult + ); + #[cfg(feature = "elicitation")] + method!( + /// # SEP-2260: request association + /// + /// From protocol version `2026-07-28` this must be issued while handling a + /// client request; see [`OriginatingRequestId`]. + peer_req_with_timeout create_elicitation_with_timeout ElicitRequest(ElicitRequestParams) => ElicitResult + ); + + method!(peer_not notify_cancelled CancelledNotification(CancelledNotificationParam)); + method!(peer_not notify_progress ProgressNotification(ProgressNotificationParam)); + method!( + #[deprecated( + since = "1.8.0", + note = "Logging is deprecated by SEP-2577 and will be removed in a future release. See https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2577" + )] + peer_not notify_logging_message LoggingMessageNotification(LoggingMessageNotificationParam) + ); + method!(peer_not notify_resource_updated ResourceUpdatedNotification(ResourceUpdatedNotificationParam)); + method!(peer_not notify_resource_list_changed ResourceListChangedNotification); + method!(peer_not notify_tool_list_changed ToolListChangedNotification); + method!(peer_not notify_prompt_list_changed PromptListChangedNotification); +} + +// ============================================================================= +// ELICITATION CONVENIENCE METHODS +// These methods are specific to server role and provide typed elicitation functionality +// ============================================================================= + +/// Errors that can occur during typed elicitation operations +#[cfg(feature = "elicitation")] +#[derive(Error, Debug)] +#[non_exhaustive] +pub enum ElicitationError { + /// The elicitation request failed at the service level + #[error("Service error: {0}")] + Service(#[from] ServiceError), + + /// User explicitly declined to provide the requested information + /// This indicates a conscious decision by the user to reject the request + /// (e.g., clicked "Reject", "Decline", "No", etc.) + #[error("User explicitly declined the request")] + UserDeclined, + + /// User dismissed the request without making an explicit choice + /// This indicates the user cancelled without explicitly declining + /// (e.g., closed dialog, clicked outside, pressed Escape, etc.) + #[error("User cancelled/dismissed the request")] + UserCancelled, + + /// The response data could not be parsed into the requested type + #[error("Failed to parse response data: {error}\nReceived data: {data}")] + ParseError { + error: serde_json::Error, + data: serde_json::Value, + }, + + /// No response content was provided by the user + #[error("No response content provided")] + NoContent, + + /// Client does not support elicitation capability + #[error("Client does not support elicitation - capability not declared during initialization")] + CapabilityNotSupported, +} + +/// Marker trait to ensure that elicitation types generate object-type JSON schemas. +/// +/// This trait provides compile-time safety to ensure that types used with +/// `elicit()` methods will generate JSON schemas of type "object", which +/// aligns with MCP client expectations for structured data input. +/// +/// # Type Safety Rationale +/// +/// MCP clients typically expect JSON objects for elicitation schemas to +/// provide structured forms and validation. This trait prevents common +/// mistakes like: +/// +/// ```compile_fail +/// // These would not compile due to missing ElicitationSafe bound: +/// let name: String = server.elicit("Enter name").await?; // Primitive +/// let items: Vec = server.elicit("Enter items").await?; // Array +/// ``` +#[cfg(feature = "elicitation")] +pub trait ElicitationSafe: schemars::JsonSchema {} + +/// Macro to mark types as safe for elicitation by verifying they generate object schemas. +/// +/// This macro automatically implements the `ElicitationSafe` trait for struct types +/// that should be used with `elicit()` methods. +/// +/// # Example +/// +/// ```rust +/// use rmcp::elicit_safe; +/// use schemars::JsonSchema; +/// use serde::{Deserialize, Serialize}; +/// +/// #[derive(Serialize, Deserialize, JsonSchema)] +/// struct UserProfile { +/// name: String, +/// email: String, +/// } +/// +/// elicit_safe!(UserProfile); +/// +/// // Now safe to use in async context: +/// // let profile: UserProfile = server.elicit("Enter profile").await?; +/// ``` +#[cfg(feature = "elicitation")] +#[macro_export] +macro_rules! elicit_safe { + ($($t:ty),* $(,)?) => { + $( + impl $crate::service::ElicitationSafe for $t {} + )* + }; +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +#[non_exhaustive] +pub enum ElicitationMode { + Form, + Url, +} + +#[cfg(feature = "elicitation")] +impl Peer { + /// Check if the client supports elicitation capability + /// + /// Returns true if the client declared elicitation capability during initialization, + /// false otherwise. According to MCP 2025-06-18 specification, clients that support + /// elicitation MUST declare the capability during initialization. + pub fn supported_elicitation_modes(&self) -> HashSet { + if let Some(client_info) = self.peer_info() { + if let Some(elicit_capability) = &client_info.capabilities.elicitation { + let mut modes = HashSet::new(); + // Backward compatibility: if neither form nor url is specified, assume form + if elicit_capability.form.is_none() && elicit_capability.url.is_none() { + modes.insert(ElicitationMode::Form); + } else { + if elicit_capability.form.is_some() { + modes.insert(ElicitationMode::Form); + } + if elicit_capability.url.is_some() { + modes.insert(ElicitationMode::Url); + } + } + modes + } else { + HashSet::new() + } + } else { + HashSet::new() + } + } + + /// Request typed data from the user with automatic schema generation. + /// + /// This method automatically generates the JSON schema from the Rust type using `schemars`, + /// eliminating the need to manually create schemas. The response is automatically parsed + /// into the requested type. + /// + /// **Requires the `elicitation` feature to be enabled.** + /// + /// # Type Requirements + /// The type `T` must implement: + /// - `schemars::JsonSchema` - for automatic schema generation + /// - `serde::Deserialize` - for parsing the response + /// + /// # Arguments + /// * `message` - The prompt message for the user + /// + /// # Returns + /// * `Ok(Some(data))` if user provided valid data that matches type T + /// * `Err(ElicitationError::UserDeclined)` if user explicitly declined the request + /// * `Err(ElicitationError::UserCancelled)` if user cancelled/dismissed the request + /// * `Err(ElicitationError::ParseError { .. })` if response data couldn't be parsed into type T + /// * `Err(ElicitationError::NoContent)` if no response content was provided + /// * `Err(ElicitationError::Service(_))` if the underlying service call failed + /// + /// # Example + /// + /// Add to your `Cargo.toml`: + /// ```toml + /// [dependencies] + /// rmcp = { version = "0.3", features = ["elicitation"] } + /// serde = { version = "1.0", features = ["derive"] } + /// schemars = "1.0" + /// ``` + /// + /// ```rust,no_run + /// # use rmcp::*; + /// # use rmcp::service::ElicitationError; + /// # use serde::{Deserialize, Serialize}; + /// # use schemars::JsonSchema; + /// # + /// #[derive(Debug, Serialize, Deserialize, JsonSchema)] + /// struct UserProfile { + /// #[schemars(description = "Full name")] + /// name: String, + /// #[schemars(description = "Email address")] + /// email: String, + /// #[schemars(description = "Age")] + /// age: u8, + /// } + /// + /// // Mark as safe for elicitation (generates object schema) + /// rmcp::elicit_safe!(UserProfile); + /// + /// # async fn example(peer: Peer) -> Result<(), Box> { + /// match peer.elicit::("Please enter your profile information").await { + /// Ok(Some(profile)) => { + /// println!("Name: {}, Email: {}, Age: {}", profile.name, profile.email, profile.age); + /// } + /// Ok(None) => { + /// println!("User provided no content"); + /// } + /// Err(ElicitationError::UserDeclined) => { + /// println!("User explicitly declined to provide information"); + /// // Handle explicit decline - perhaps offer alternatives + /// } + /// Err(ElicitationError::UserCancelled) => { + /// println!("User cancelled the request"); + /// // Handle cancellation - perhaps prompt again later + /// } + /// Err(ElicitationError::ParseError { error, data }) => { + /// println!("Failed to parse response: {}\nData: {}", error, data); + /// } + /// Err(e) => return Err(e.into()), + /// } + /// # Ok(()) + /// # } + /// ``` + /// + /// # SEP-2260: request association + /// + /// From protocol version `2026-07-28` this must be issued while handling a + /// client request; see [`OriginatingRequestId`]. + #[cfg(all(feature = "schemars", feature = "elicitation"))] + pub async fn elicit(&self, message: impl Into) -> Result, ElicitationError> + where + T: ElicitationSafe + for<'de> serde::Deserialize<'de>, + { + self.elicit_with_timeout(message, None).await + } + + /// Request typed data from the user with custom timeout. + /// + /// Same as `elicit()` but allows specifying a custom timeout for the request. + /// If the user doesn't respond within the timeout, the request will be cancelled. + /// + /// # Arguments + /// * `message` - The prompt message for the user + /// * `timeout` - Optional timeout duration. If None, uses default timeout behavior + /// + /// # Returns + /// Same as `elicit()` but may also return `ServiceError::Timeout` if timeout expires + /// + /// # Example + /// ```rust,no_run + /// # use rmcp::*; + /// # use rmcp::service::ElicitationError; + /// # use serde::{Deserialize, Serialize}; + /// # use schemars::JsonSchema; + /// # use std::time::Duration; + /// # + /// #[derive(Debug, Serialize, Deserialize, JsonSchema)] + /// struct QuickResponse { + /// answer: String, + /// } + /// + /// // Mark as safe for elicitation + /// rmcp::elicit_safe!(QuickResponse); + /// + /// # async fn example(peer: Peer) -> Result<(), Box> { + /// // Give user 30 seconds to respond + /// let timeout = Some(Duration::from_secs(30)); + /// match peer.elicit_with_timeout::( + /// "Quick question - what's your answer?", + /// timeout + /// ).await { + /// Ok(Some(response)) => println!("Got answer: {}", response.answer), + /// Ok(None) => println!("User provided no content"), + /// Err(ElicitationError::UserDeclined) => { + /// println!("User explicitly declined"); + /// // Handle explicit decline + /// } + /// Err(ElicitationError::UserCancelled) => { + /// println!("User cancelled/dismissed"); + /// // Handle cancellation + /// } + /// Err(ElicitationError::Service(ServiceError::Timeout { .. })) => { + /// println!("User didn't respond in time"); + /// } + /// Err(e) => return Err(e.into()), + /// } + /// # Ok(()) + /// # } + /// ``` + /// + /// # SEP-2260: request association + /// + /// From protocol version `2026-07-28` this must be issued while handling a + /// client request; see [`OriginatingRequestId`]. + #[cfg(all(feature = "schemars", feature = "elicitation"))] + pub async fn elicit_with_timeout( + &self, + message: impl Into, + timeout: Option, + ) -> Result, ElicitationError> + where + T: ElicitationSafe + for<'de> serde::Deserialize<'de>, + { + // Check if client supports form elicitation capability + if !self + .supported_elicitation_modes() + .contains(&ElicitationMode::Form) + { + return Err(ElicitationError::CapabilityNotSupported); + } + + // Generate schema automatically from type + let schema = crate::model::ElicitationSchema::from_type::().map_err(|e| { + ElicitationError::Service(ServiceError::McpError(crate::ErrorData::invalid_params( + format!( + "Invalid schema for type {}: {}", + std::any::type_name::(), + e + ), + None, + ))) + })?; + + let response = self + .create_elicitation_with_timeout( + ElicitRequestParams::FormElicitationParams { + meta: None, + message: message.into(), + requested_schema: schema, + }, + timeout, + ) + .await?; + + match response.action { + crate::model::ElicitationAction::Accept => { + if let Some(value) = response.content { + match serde_json::from_value::(value.clone()) { + Ok(parsed) => Ok(Some(parsed)), + Err(error) => Err(ElicitationError::ParseError { error, data: value }), + } + } else { + Err(ElicitationError::NoContent) + } + } + crate::model::ElicitationAction::Decline => Err(ElicitationError::UserDeclined), + crate::model::ElicitationAction::Cancel => Err(ElicitationError::UserCancelled), + } + } + + /// Request the user to visit a URL and confirm completion. + /// + /// This method sends a URL elicitation request to the client, prompting the user + /// to visit the specified URL and confirm completion. It returns the user's action + /// (accept/decline/cancel) without any additional data. + /// **Requires the `elicitation` feature to be enabled.** + /// + /// # Arguments + /// * `message` - The prompt message for the user + /// * `url` - The URL the user is requested to visit + /// * `elicitation_id` - A unique identifier for this elicitation request + /// # Returns + /// * `Ok(action)` indicating the user's response action + /// * `Err(ElicitationError::CapabilityNotSupported)` if client does not support elicitation via URL + /// * `Err(ElicitationError::Service(_))` if the underlying service call failed + /// # Example + /// ```rust,no_run + /// # use rmcp::*; + /// # use rmcp::model::ElicitationAction; + /// # use url::Url; + /// + /// async fn example(peer: Peer) -> Result<(), Box> { + /// let elicit_result = peer.elicit_url("Please visit the following URL to complete the action", + /// Url::parse("https://example.com/complete_action")?, "elicit_123").await?; + /// match elicit_result { + /// ElicitationAction::Accept => { + /// println!("User accepted and confirmed completion"); + /// } + /// ElicitationAction::Decline => { + /// println!("User declined the request"); + /// } + /// ElicitationAction::Cancel => { + /// println!("User cancelled/dismissed the request"); + /// } + /// _ => {} + /// } + /// Ok(()) + /// } + /// ``` + /// + /// # SEP-2260: request association + /// + /// From protocol version `2026-07-28` this must be issued while handling a + /// client request; see [`OriginatingRequestId`]. + #[cfg(feature = "elicitation")] + pub async fn elicit_url( + &self, + message: impl Into, + url: impl Into, + elicitation_id: impl Into, + ) -> Result { + self.elicit_url_with_timeout(message, url, elicitation_id, None) + .await + } + + /// Request the user to visit a URL and confirm completion. + /// + /// Same as `elicit_url()` but allows specifying a custom timeout for the request. + /// + /// # Arguments + /// * `message` - The prompt message for the user + /// * `url` - The URL the user is requested to visit + /// * `elicitation_id` - A unique identifier for this elicitation request + /// * `timeout` - Optional timeout duration. If None, uses default timeout behavior + /// # Returns + /// * `Ok(action)` indicating the user's response action + /// * `Err(ElicitationError::CapabilityNotSupported)` if client does not support elicitation via URL + /// * `Err(ElicitationError::Service(_))` if the underlying service call failed + /// # Example + /// ```rust,no_run + /// # use std::time::Duration; + /// use rmcp::*; + /// # use rmcp::model::ElicitationAction; + /// # use url::Url; + /// + /// async fn example(peer: Peer) -> Result<(), Box> { + /// let elicit_result = peer.elicit_url_with_timeout("Please visit the following URL to complete the action", + /// Url::parse("https://example.com/complete_action")?, + /// "elicit_123", + /// Some(Duration::from_secs(30))).await?; + /// match elicit_result { + /// ElicitationAction::Accept => { + /// println!("User accepted and confirmed completion"); + /// } + /// ElicitationAction::Decline => { + /// println!("User declined the request"); + /// } + /// ElicitationAction::Cancel => { + /// println!("User cancelled/dismissed the request"); + /// } + /// _ => {} + /// } + /// Ok(()) + /// } + /// ``` + /// + /// # SEP-2260: request association + /// + /// From protocol version `2026-07-28` this must be issued while handling a + /// client request; see [`OriginatingRequestId`]. + #[cfg(feature = "elicitation")] + pub async fn elicit_url_with_timeout( + &self, + message: impl Into, + url: impl Into, + elicitation_id: impl Into, + timeout: Option, + ) -> Result { + // Check if client supports url elicitation + if !self + .supported_elicitation_modes() + .contains(&ElicitationMode::Url) + { + return Err(ElicitationError::CapabilityNotSupported); + } + + let action = self + .create_elicitation_with_timeout( + ElicitRequestParams::UrlElicitationParams { + meta: None, + message: message.into(), + url: url.into().to_string(), + elicitation_id: elicitation_id.into(), + }, + timeout, + ) + .await? + .action; + Ok(action) + } +} diff --git a/vendor/rmcp/src/service/tower.rs b/vendor/rmcp/src/service/tower.rs new file mode 100644 index 00000000..867d3e7f --- /dev/null +++ b/vendor/rmcp/src/service/tower.rs @@ -0,0 +1,54 @@ +use std::{future::poll_fn, marker::PhantomData}; + +use tower_service::Service as TowerService; + +use super::NotificationContext; +use crate::service::{MaybeSendFuture, RequestContext, Service, ServiceRole}; + +pub struct TowerHandler { + pub service: S, + pub info: R::Info, + role: PhantomData, +} + +impl TowerHandler { + pub fn new(service: S, info: R::Info) -> Self { + Self { + service, + role: PhantomData, + info, + } + } +} + +impl Service for TowerHandler +where + S: TowerService + Sync + Send + Clone + 'static, + S::Error: Into, + S::Future: Send, +{ + async fn handle_request( + &self, + request: R::PeerReq, + _context: RequestContext, + ) -> Result { + let mut service = self.service.clone(); + poll_fn(|cx| service.poll_ready(cx)) + .await + .map_err(Into::into)?; + let resp = service.call(request).await.map_err(Into::into)?; + Ok(resp) + } + + fn handle_notification( + &self, + _notification: R::PeerNot, + _context: NotificationContext, + ) -> impl Future> + MaybeSendFuture + '_ { + std::future::ready(Ok(())) + } + + fn get_info(&self) -> R::Info { + self.info.clone() + } +} diff --git a/vendor/rmcp/src/task_manager.rs b/vendor/rmcp/src/task_manager.rs new file mode 100644 index 00000000..0e8339c0 --- /dev/null +++ b/vendor/rmcp/src/task_manager.rs @@ -0,0 +1,998 @@ +//! Server-side runtime for the MCP Tasks extension (SEP-2663, +//! `io.modelcontextprotocol/tasks`). +//! +//! [`TaskManager`] owns the durable state for tasks a server has materialized +//! in response to task-eligible requests (currently `tools/call`). It: +//! +//! - spawns the underlying operation and tracks its lifecycle as a +//! [`DetailedTask`] (`working` → terminal, optionally via `input_required`), +//! - answers `tasks/get` with the current state (including in-flight +//! `inputRequests` and terminal `result`/`error` payloads), +//! - accepts `tasks/update` `inputResponses` and routes them to the running +//! operation (ignoring unknown or already-answered keys per spec), +//! - handles cooperative `tasks/cancel`, +//! - enforces TTL-based expiry (`ttl_ms`), marking overdue tasks `failed`. +//! +//! Tasks are only durably observable once [`TaskManager::spawn`] returns, +//! satisfying the spec requirement that a server not return `CreateTaskResult` +//! before `tasks/get` for that id would resolve. + +use std::{ + collections::HashMap, + pin::Pin, + sync::{Arc, Mutex}, + time::Instant, +}; + +use futures::Future; +use tokio::sync::oneshot; + +use crate::{ + error::ErrorData as McpError, + model::{ + CallToolResult, DetailedTask, InputRequest, InputRequests, JsonObject, Task, TaskPayload, + TaskStatus, + }, +}; + +/// Default TTL (5 minutes, in milliseconds) applied when none is specified. +pub const DEFAULT_TASK_TTL_MS: u64 = 300_000; + +/// Default suggested polling interval, in milliseconds. +pub const DEFAULT_POLL_INTERVAL_MS: u64 = 1_000; + +/// Helper to generate an ISO 8601 timestamp for task metadata. +pub fn current_timestamp() -> String { + chrono::Utc::now().to_rfc3339() +} + +/// Handle passed to a running task operation, allowing it to surface +/// server-to-client requests (elicitation, sampling, roots) mid-task and +/// await the client's `tasks/update` response. +#[derive(Clone)] +pub struct TaskContext { + task_id: String, + inner: Arc>, +} + +impl TaskContext { + /// The id of the task this context belongs to. + pub fn task_id(&self) -> &str { + &self.task_id + } + + /// Surface a server-to-client request under `key` and wait for the + /// client's response delivered via `tasks/update`. + /// + /// While at least one request is outstanding the task reports + /// `input_required` from `tasks/get`, with all outstanding requests in + /// `inputRequests`. Keys must be unique over the lifetime of the task; + /// reusing a key returns an error. + pub async fn request_input( + &self, + key: impl Into, + request: InputRequest, + ) -> Result { + let key = key.into(); + let (tx, rx) = oneshot::channel(); + { + let mut inner = self.inner.lock().expect("task manager lock poisoned"); + let entry = inner.tasks.get_mut(&self.task_id).ok_or_else(|| { + TaskExit::Error(McpError::internal_error( + "task no longer exists".to_string(), + None, + )) + })?; + if !entry.used_input_keys.insert(key.clone()) { + return Err(TaskExit::Error(McpError::internal_error( + format!("inputRequests key {key:?} was already used for this task"), + None, + ))); + } + entry.pending_inputs.insert(key.clone(), (request, tx)); + entry.touch(); + } + // The sender is dropped when `tasks/cancel` clears pending inputs. + rx.await.map_err(|_| TaskExit::Cancelled) + } + + /// Update the task's human-readable status message. + pub fn set_status_message(&self, message: impl Into) { + let mut inner = self.inner.lock().expect("task manager lock poisoned"); + if let Some(entry) = inner.tasks.get_mut(&self.task_id) { + entry.task.status_message = Some(message.into()); + entry.touch(); + } + } + + /// Returns `true` if `tasks/cancel` has been received for this task. + /// Cooperative: operations should check this and stop when set. + pub fn is_cancel_requested(&self) -> bool { + let inner = self.inner.lock().expect("task manager lock poisoned"); + inner + .tasks + .get(&self.task_id) + .is_some_and(|e| e.cancel_requested) + } + + /// Resolves once `tasks/cancel` has been received for this task (or + /// immediately, if it already has). Cooperative: pair with + /// `tokio::select!` around long-running work to implement a cancellation + /// exit path. + /// + /// An operation that stops in response should return + /// [`TaskExit::Cancelled`] so the task settles as `cancelled`. Returning + /// [`TaskExit::Error`] settles as `failed`, and finishing the work + /// anyway settles as `completed` — per SEP-2663 cancellation is + /// cooperative and a task may reach a non-`cancelled` terminal status. + pub async fn cancelled(&self) { + let mut rx = { + let inner = self.inner.lock().expect("task manager lock poisoned"); + let Some(entry) = inner.tasks.get(&self.task_id) else { + return; + }; + if entry.cancel_requested { + return; + } + entry.cancel_signal.subscribe() + }; + // Wait until the watch flips to true; a closed channel means the + // manager dropped the entry, which also unblocks the operation. + while !*rx.borrow_and_update() { + if rx.changed().await.is_err() { + return; + } + } + } +} + +/// How a task operation finished without producing a result. +#[expect( + clippy::exhaustive_enums, + reason = "error variant for task exit may only be due to error or cancellation" +)] +#[derive(Debug)] +pub enum TaskExit { + /// The operation is exiting in response to a cancellation request; + /// the task settles as terminal `cancelled`. + Cancelled, + /// A real failure; the task settles as terminal `failed` with the + /// error inlined, even after `tasks/cancel` was received. + Error(McpError), +} + +impl From for TaskExit { + fn from(error: McpError) -> Self { + TaskExit::Error(error) + } +} + +/// Boxed future representing the async operation backing a task. +pub type TaskFuture = Pin> + Send>>; + +struct TaskEntry { + task: Task, + /// Terminal payload, if the task has finished. + terminal: Option, + /// When the task reached its terminal state; drives retention eviction. + terminal_at: Option, + /// Outstanding input requests keyed by their unique identifier. + pending_inputs: HashMap)>, + /// Every key ever used, to enforce uniqueness across the task lifetime. + used_input_keys: std::collections::HashSet, + cancel_requested: bool, + /// Signals the running operation that cancellation was requested + /// (`true` once `tasks/cancel` arrives). Cooperative: the operation + /// decides whether and how to stop. + cancel_signal: tokio::sync::watch::Sender, + created: Instant, + join_handle: Option>, +} + +impl TaskEntry { + fn touch(&mut self) { + self.task.last_updated_at = current_timestamp(); + } + + fn current_status(&self) -> TaskStatus { + match &self.terminal { + Some(payload) => payload.status(), + None if !self.pending_inputs.is_empty() => TaskStatus::InputRequired, + None => TaskStatus::Working, + } + } + + fn detailed(&self) -> DetailedTask { + let payload = match &self.terminal { + Some(p) => p.clone(), + None if !self.pending_inputs.is_empty() => TaskPayload::InputRequired { + input_requests: self + .pending_inputs + .iter() + .map(|(k, (req, _))| (k.clone(), req.clone())) + .collect::(), + }, + None => TaskPayload::Working, + }; + DetailedTask::new(self.task.clone(), payload) + } +} + +#[derive(Default)] +struct TaskManagerInner { + tasks: HashMap, +} + +/// Options controlling a spawned task. +#[derive(Debug, Clone)] +#[non_exhaustive] +pub struct TaskOptions { + /// TTL in milliseconds; `None` means unlimited retention. + pub ttl_ms: Option, + /// Suggested polling interval in milliseconds. + pub poll_interval_ms: Option, + /// Initial status message. + pub status_message: Option, +} + +impl Default for TaskOptions { + fn default() -> Self { + Self { + ttl_ms: Some(DEFAULT_TASK_TTL_MS), + poll_interval_ms: Some(DEFAULT_POLL_INTERVAL_MS), + status_message: None, + } + } +} + +impl TaskOptions { + pub fn new() -> Self { + Self::default() + } + + /// Set the TTL in milliseconds. `None` means unlimited retention. + pub fn with_ttl_ms(mut self, ttl_ms: impl Into>) -> Self { + self.ttl_ms = ttl_ms.into(); + self + } + + /// Set the suggested polling interval in milliseconds. + pub fn with_poll_interval_ms(mut self, poll_interval_ms: u64) -> Self { + self.poll_interval_ms = Some(poll_interval_ms); + self + } + + /// Set the initial status message. + pub fn with_status_message(mut self, message: impl Into) -> Self { + self.status_message = Some(message.into()); + self + } +} + +/// Server-side task store and executor for the SEP-2663 Tasks extension. +/// +/// Cheaply cloneable; all clones share the same state. +/// +/// # Retention +/// +/// Entries are swept opportunistically on every `spawn` / `get_task` / +/// `update_task` / `cancel_task` / `running_task_count` call: non-terminal +/// tasks whose `ttl_ms` has elapsed are marked `failed` (their operation is +/// aborted), and terminal tasks are evicted after being retained for one +/// further `ttl_ms` window past their terminal transition so pollers can +/// observe the final state. +/// +/// Note that the retention window intentionally extends past the +/// creation-based lifetime that `ttl_ms` advertises on the wire: a task that +/// runs to its TTL deadline is marked `failed` around `created + ttl_ms` and +/// stays observable until roughly `created + 2 × ttl_ms`. This is compliant — +/// SEP-2663 lets servers delete expired tasks *at any time* after the TTL, +/// so retaining them longer as an observation grace period is a server-side +/// policy choice, not a wire-contract change. Clients may treat the task as +/// unusable after `createdAt + ttlMs` regardless. +/// +/// Tasks with `ttl_ms: None` are retained for the lifetime of the manager +/// (spec: unlimited retention) — bound task creation or call +/// [`Self::shutdown`] yourself if you spawn such tasks in a long-lived +/// server. There is no background sweeper; an idle manager holds its entries +/// until the next call. +#[derive(Clone, Default)] +pub struct TaskManager { + inner: Arc>, +} + +impl TaskManager { + pub fn new() -> Self { + Self::default() + } + + /// Spawn an operation as a task and return its seed [`Task`] state for a + /// `CreateTaskResult`. The task is durably observable via + /// [`Self::get_task`] before this method returns. + /// + /// `make_future` receives a [`TaskContext`] for mid-task input requests, + /// status messages, and cooperative cancellation checks. + pub fn spawn(&self, options: TaskOptions, make_future: F) -> Task + where + F: FnOnce(TaskContext) -> TaskFuture, + { + let task_id = uuid::Uuid::new_v4().to_string(); + let now = current_timestamp(); + let mut task = Task::new(task_id.clone(), TaskStatus::Working, now.clone(), now); + task.ttl_ms = options.ttl_ms; + task.poll_interval_ms = options.poll_interval_ms; + task.status_message = options.status_message; + + let entry = TaskEntry { + task: task.clone(), + terminal: None, + terminal_at: None, + pending_inputs: HashMap::new(), + used_input_keys: std::collections::HashSet::new(), + cancel_requested: false, + cancel_signal: tokio::sync::watch::channel(false).0, + created: Instant::now(), + join_handle: None, + }; + { + let mut inner = self.inner.lock().expect("task manager lock poisoned"); + // Opportunistic TTL sweep on every task creation, so terminal + // entries are evicted even if clients never poll again. + Self::sweep_expired(&mut inner); + inner.tasks.insert(task_id.clone(), entry); + } + + let context = TaskContext { + task_id: task_id.clone(), + inner: self.inner.clone(), + }; + let future = make_future(context); + let inner = self.inner.clone(); + let id_for_task = task_id.clone(); + let originating_request = crate::service::ORIGINATING_REQUEST + .try_with(|id| id.clone()) + .ok(); + let handle = tokio::spawn(async move { + let result = run_task_operation(originating_request, future).await; + let mut inner = inner.lock().expect("task manager lock poisoned"); + if let Some(entry) = inner.tasks.get_mut(&id_for_task) { + if entry.terminal.is_none() { + entry.terminal = Some(match result { + Ok(result) => TaskPayload::Completed { + result: result_to_object(&result), + }, + Err(TaskExit::Cancelled) => TaskPayload::Cancelled, + Err(TaskExit::Error(error)) => TaskPayload::Failed { + error: error_to_object(&error), + }, + }); + entry.terminal_at = Some(Instant::now()); + entry.pending_inputs.clear(); + entry.touch(); + entry.task.status = entry.current_status(); + } + // The operation has finished; drop the JoinHandle so it is + // not retained for the rest of the retention window. + entry.join_handle = None; + } + }); + match self + .inner + .lock() + .expect("task manager lock poisoned") + .tasks + .get_mut(&task_id) + { + // Only store the handle while the operation is still running: if + // it already settled, the completion path above ran first and a + // stored handle would never be cleared. + Some(entry) => { + if entry.terminal.is_none() { + entry.join_handle = Some(handle); + } + } + // The entry is gone: shutdown() drained the map between the + // insert and here. Abort rather than leak a detached operation. + None => handle.abort(), + } + task + } + + /// Handle `tasks/get`: return the current [`DetailedTask`] state. + pub fn get_task(&self, task_id: &str) -> Result { + let mut inner = self.inner.lock().expect("task manager lock poisoned"); + Self::sweep_expired(&mut inner); + let entry = inner + .tasks + .get_mut(task_id) + .ok_or_else(|| unknown_task(task_id))?; + entry.task.status = entry.current_status(); + Ok(entry.detailed()) + } + + /// Handle `tasks/update`: deliver `inputResponses` to the running + /// operation. Unknown, already-answered, or superseded keys are ignored + /// per spec; a partial set of responses is accepted. + pub fn update_task( + &self, + task_id: &str, + input_responses: impl IntoIterator, + ) -> Result<(), McpError> { + let mut inner = self.inner.lock().expect("task manager lock poisoned"); + Self::sweep_expired(&mut inner); + let entry = inner + .tasks + .get_mut(task_id) + .ok_or_else(|| unknown_task(task_id))?; + for (key, value) in input_responses { + if let Some((_, tx)) = entry.pending_inputs.remove(&key) { + // Receiver dropped means the operation moved on; ignore. + let _ = tx.send(value); + } + } + entry.touch(); + entry.task.status = entry.current_status(); + Ok(()) + } + + /// Handle `tasks/cancel`: cooperative cancellation (SEP-2663). + /// + /// Records the cancellation *intent* and acknowledges immediately, but + /// does **not** abort the underlying future or force a terminal state. + /// The operation observes cancellation via + /// [`TaskContext::is_cancel_requested`] / [`TaskContext::cancelled`], or + /// via the error returned from a pending [`TaskContext::request_input`] + /// call (whose response channel is dropped here), and decides its own + /// terminal status: + /// + /// - stops with [`TaskExit::Cancelled`] → recorded as `cancelled`, + /// - stops with [`TaskExit::Error`] → recorded as `failed` with the + /// error inlined (a real failure after a cancel request is not masked), + /// - finishes its work anyway → recorded as `completed` — per the spec, + /// "the task may still reach a non-`cancelled` terminal status". + pub fn cancel_task(&self, task_id: &str) -> Result<(), McpError> { + let mut inner = self.inner.lock().expect("task manager lock poisoned"); + Self::sweep_expired(&mut inner); + let entry = inner + .tasks + .get_mut(task_id) + .ok_or_else(|| unknown_task(task_id))?; + entry.cancel_requested = true; + let _ = entry.cancel_signal.send(true); + if entry.terminal.is_none() { + // Wake any operation parked on `request_input`: dropping the + // response senders resolves those awaits with an error, giving + // parked operations a cooperative exit path. The task leaves + // `input_required` and reports `working` until it settles. + entry.pending_inputs.clear(); + entry.touch(); + entry.task.status = entry.current_status(); + } + Ok(()) + } + + /// Number of tasks currently in a non-terminal state. + pub fn running_task_count(&self) -> usize { + let mut inner = self.inner.lock().expect("task manager lock poisoned"); + Self::sweep_expired(&mut inner); + inner + .tasks + .values() + .filter(|e| e.terminal.is_none()) + .count() + } + + /// Abort all running tasks and clear all task state. + pub fn shutdown(&self) { + let mut inner = self.inner.lock().expect("task manager lock poisoned"); + for (_, mut entry) in inner.tasks.drain() { + if let Some(handle) = entry.join_handle.take() { + handle.abort(); + } + } + } + + /// TTL sweep, run from every `TaskManager` entry point (SEP-2663: servers + /// MAY mark a task `failed` any time after its TTL elapses, and + /// subsequently delete it at any time; `ttl_ms: None` means unlimited + /// retention). + /// + /// Two phases per entry: + /// 1. A non-terminal task whose TTL has elapsed is marked `failed` (its + /// operation is aborted — the TTL is the SDK's hard-stop safety valve, + /// unlike cooperative `tasks/cancel`). + /// 2. A *terminal* task is evicted once it has been retained for a full + /// TTL window after reaching its terminal state, so well-behaved + /// pollers get a chance to observe the final status before late + /// `tasks/get` calls start returning `-32602`. + fn sweep_expired(inner: &mut TaskManagerInner) { + // Phase 1: fail overdue non-terminal tasks. + for entry in inner.tasks.values_mut() { + if entry.terminal.is_none() + && let Some(ttl_ms) = entry.task.ttl_ms + && entry.created.elapsed().as_millis() >= u128::from(ttl_ms) + { + if let Some(handle) = entry.join_handle.take() { + handle.abort(); + } + entry.terminal = Some(TaskPayload::Failed { + error: error_to_object(&McpError::internal_error( + "task expired: TTL elapsed before completion".to_string(), + None, + )), + }); + entry.terminal_at = Some(Instant::now()); + entry.pending_inputs.clear(); + entry.touch(); + entry.task.status = TaskStatus::Failed; + } + } + // Phase 2: evict terminal tasks whose retention window has passed. + inner.tasks.retain(|_, entry| { + let (Some(ttl_ms), Some(terminal_at)) = (entry.task.ttl_ms, entry.terminal_at) else { + return true; + }; + terminal_at.elapsed().as_millis() < u128::from(ttl_ms) + }); + } +} + +fn unknown_task(task_id: &str) -> McpError { + McpError::invalid_params(format!("unknown task: {task_id}"), None) +} + +async fn run_task_operation( + originating_request: Option, + future: TaskFuture, +) -> Result { + match originating_request { + Some(id) => crate::service::ORIGINATING_REQUEST.scope(id, future).await, + None => future.await, + } +} + +fn result_to_object(result: &CallToolResult) -> JsonObject { + match serde_json::to_value(result) { + Ok(serde_json::Value::Object(map)) => map, + _ => JsonObject::new(), + } +} + +fn error_to_object(error: &McpError) -> JsonObject { + match serde_json::to_value(error) { + Ok(serde_json::Value::Object(map)) => map, + _ => JsonObject::new(), + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::model::ContentBlock; + + fn ok_result(text: &str) -> CallToolResult { + CallToolResult::success(vec![ContentBlock::text(text.to_string())]) + } + + #[tokio::test] + async fn task_completes_and_result_is_inlined() { + let manager = TaskManager::new(); + let task = manager.spawn(TaskOptions::default(), |_ctx| { + Box::pin(async { Ok(ok_result("42")) }) + }); + assert_eq!(task.status, TaskStatus::Working); + + // Durable immediately. + manager.get_task(&task.task_id).unwrap(); + + // Wait for completion. + for _ in 0..100 { + tokio::time::sleep(std::time::Duration::from_millis(10)).await; + let detailed = manager.get_task(&task.task_id).unwrap(); + if detailed.status() == TaskStatus::Completed { + match detailed.payload { + TaskPayload::Completed { result } => { + assert!(result.contains_key("content")); + return; + } + other => panic!("unexpected payload: {other:?}"), + } + } + } + panic!("task did not complete"); + } + + #[tokio::test] + async fn cancel_settles_to_cancelled_when_operation_honors_it() { + let manager = TaskManager::new(); + let task = manager.spawn(TaskOptions::default(), |ctx| { + Box::pin(async move { + tokio::select! { + _ = ctx.cancelled() => Err(TaskExit::Cancelled), + _ = tokio::time::sleep(std::time::Duration::from_secs(60)) => { + Ok(ok_result("never")) + } + } + }) + }); + manager.cancel_task(&task.task_id).unwrap(); + + // The ack is immediate but the terminal state is set by the + // operation; poll until it settles. + for _ in 0..100 { + tokio::time::sleep(std::time::Duration::from_millis(10)).await; + let detailed = manager.get_task(&task.task_id).unwrap(); + if detailed.status().is_terminal() { + assert_eq!(detailed.status(), TaskStatus::Cancelled); + return; + } + } + panic!("task did not settle after cancel"); + } + + #[tokio::test] + async fn post_cancel_unrelated_error_settles_as_failed() { + let manager = TaskManager::new(); + let task = manager.spawn(TaskOptions::default(), |ctx| { + Box::pin(async move { + // Fail for an unrelated reason after observing the cancel: + // must be recorded as `failed`, not masked as `cancelled`. + ctx.cancelled().await; + Err(TaskExit::Error(McpError::internal_error( + "database write failed", + None, + ))) + }) + }); + manager.cancel_task(&task.task_id).unwrap(); + + for _ in 0..100 { + tokio::time::sleep(std::time::Duration::from_millis(10)).await; + let detailed = manager.get_task(&task.task_id).unwrap(); + if detailed.status().is_terminal() { + assert_eq!(detailed.status(), TaskStatus::Failed); + match detailed.payload { + TaskPayload::Failed { error } => { + assert!( + error.get("message").is_some_and(|m| m + .as_str() + .is_some_and(|s| s.contains("database write failed"))), + "error payload should be preserved: {error:?}" + ); + } + other => panic!("unexpected payload: {other:?}"), + } + return; + } + } + panic!("task did not settle after cancel"); + } + + #[tokio::test] + async fn cancel_is_cooperative_and_lets_the_operation_clean_up() { + let manager = TaskManager::new(); + let (cleanup_tx, cleanup_rx) = oneshot::channel::<&'static str>(); + let task = manager.spawn(TaskOptions::default(), |ctx| { + Box::pin(async move { + // Wait for cancellation, then run cleanup and finish the + // work anyway (spec: a task may still reach a + // non-`cancelled` terminal status). + ctx.cancelled().await; + let _ = cleanup_tx.send("cleaned up"); + Ok(ok_result("finished despite cancel")) + }) + }); + + manager.cancel_task(&task.task_id).unwrap(); + + // The ack is immediate and does not force a terminal state. + let detailed = manager.get_task(&task.task_id).unwrap(); + assert!( + !detailed.status().is_terminal(), + "cancel must not force terminal state" + ); + + // The operation observes the cancel and performs cleanup. + let cleanup = tokio::time::timeout(std::time::Duration::from_secs(5), cleanup_rx) + .await + .expect("cleanup should not time out") + .expect("cleanup channel should not be dropped"); + assert_eq!(cleanup, "cleaned up"); + + // The operation chose to complete: the task settles as `completed`. + for _ in 0..100 { + tokio::time::sleep(std::time::Duration::from_millis(10)).await; + let detailed = manager.get_task(&task.task_id).unwrap(); + if detailed.status().is_terminal() { + assert_eq!(detailed.status(), TaskStatus::Completed); + return; + } + } + panic!("task did not settle after cancel"); + } + + #[tokio::test] + async fn cancel_wakes_parked_input_requests() { + let manager = TaskManager::new(); + let (exit_tx, exit_rx) = oneshot::channel::<&'static str>(); + let task = manager.spawn(TaskOptions::default(), |ctx| { + Box::pin(async move { + let request: InputRequest = serde_json::from_value(serde_json::json!({ + "method": "elicitation/create", + "params": { + "message": "Waiting forever", + "requestedSchema": {"type": "object", "properties": {}} + } + })) + .map_err(|e| McpError::internal_error(e.to_string(), None))?; + // Parked on input; cancel must wake this await with an error. + let err = ctx.request_input("k1", request).await.unwrap_err(); + let _ = exit_tx.send("woken"); + Err(err) + }) + }); + + // Wait until the task is parked on the input request. + for _ in 0..100 { + tokio::time::sleep(std::time::Duration::from_millis(10)).await; + if manager.get_task(&task.task_id).unwrap().status() == TaskStatus::InputRequired { + break; + } + } + + manager.cancel_task(&task.task_id).unwrap(); + let woken = tokio::time::timeout(std::time::Duration::from_secs(5), exit_rx) + .await + .expect("parked operation should be woken by cancel") + .expect("exit channel should not be dropped"); + assert_eq!(woken, "woken"); + assert_eq!( + manager.get_task(&task.task_id).unwrap().status(), + TaskStatus::Cancelled + ); + } + + #[tokio::test] + async fn unknown_task_is_invalid_params() { + // SEP-2663 §Protocol Errors: invalid or nonexistent taskId is -32602 + // (Invalid params) — MUST for tasks/get, SHOULD for update/cancel. + let manager = TaskManager::new(); + for err in [ + manager.get_task("nope").unwrap_err(), + manager.cancel_task("nope").unwrap_err(), + manager.update_task("nope", []).unwrap_err(), + ] { + assert_eq!(err.code, crate::model::ErrorCode::INVALID_PARAMS); + } + } + + #[tokio::test] + async fn terminal_tasks_are_evicted_after_retention_window() { + let manager = TaskManager::new(); + let task = manager.spawn(TaskOptions::new().with_ttl_ms(50), |_ctx| { + Box::pin(async { Ok(ok_result("fast")) }) + }); + + // Wait for completion; the terminal state stays observable during + // the retention window. + let mut completed = false; + for _ in 0..100 { + tokio::time::sleep(std::time::Duration::from_millis(5)).await; + if manager.get_task(&task.task_id).unwrap().status() == TaskStatus::Completed { + completed = true; + break; + } + } + assert!(completed, "task should have completed"); + + // After a full TTL window past terminal, the entry is evicted and + // late polls get -32602. + tokio::time::sleep(std::time::Duration::from_millis(120)).await; + let err = manager.get_task(&task.task_id).unwrap_err(); + assert_eq!(err.code, crate::model::ErrorCode::INVALID_PARAMS); + assert_eq!(manager.running_task_count(), 0); + } + + #[tokio::test] + async fn abandoned_tasks_are_swept_by_other_entry_points() { + // A task nobody ever polls again must still be failed + evicted; the + // sweep runs from spawn() too, so activity on *other* tasks is enough. + let manager = TaskManager::new(); + let abandoned = manager.spawn(TaskOptions::new().with_ttl_ms(10), |_ctx| { + Box::pin(async { + tokio::time::sleep(std::time::Duration::from_secs(60)).await; + Ok(ok_result("never")) + }) + }); + + // Let TTL elapse (fails the task), then a second full window + // (evicts it), without ever calling get_task on the abandoned id. + tokio::time::sleep(std::time::Duration::from_millis(40)).await; + let _ = manager.spawn(TaskOptions::default(), |_ctx| { + Box::pin(async { Ok(ok_result("other")) }) + }); + tokio::time::sleep(std::time::Duration::from_millis(40)).await; + let _ = manager.spawn(TaskOptions::default(), |_ctx| { + Box::pin(async { Ok(ok_result("other2")) }) + }); + + let err = manager.get_task(&abandoned.task_id).unwrap_err(); + assert_eq!(err.code, crate::model::ErrorCode::INVALID_PARAMS); + } + + #[tokio::test] + async fn running_task_count_sweeps_expired_tasks() { + let manager = TaskManager::new(); + let _task = manager.spawn(TaskOptions::new().with_ttl_ms(10), |_ctx| { + Box::pin(async { + tokio::time::sleep(std::time::Duration::from_secs(60)).await; + Ok(ok_result("never")) + }) + }); + assert_eq!(manager.running_task_count(), 1); + tokio::time::sleep(std::time::Duration::from_millis(30)).await; + // The count itself must sweep: the overdue task is failed, not + // reported as running. + assert_eq!(manager.running_task_count(), 0); + } + + #[tokio::test] + async fn unlimited_ttl_tasks_are_retained() { + let manager = TaskManager::new(); + let task = manager.spawn(TaskOptions::new().with_ttl_ms(None), |_ctx| { + Box::pin(async { Ok(ok_result("kept")) }) + }); + tokio::time::sleep(std::time::Duration::from_millis(50)).await; + // Sweeps triggered by other entry points must not evict it. + let _ = manager.spawn(TaskOptions::default(), |_ctx| { + Box::pin(async { Ok(ok_result("other")) }) + }); + assert_eq!( + manager.get_task(&task.task_id).unwrap().status(), + TaskStatus::Completed + ); + } + + #[tokio::test] + async fn ttl_expiry_fails_task() { + let manager = TaskManager::new(); + let task = manager.spawn( + TaskOptions { + ttl_ms: Some(10), + ..Default::default() + }, + |_ctx| { + Box::pin(async { + tokio::time::sleep(std::time::Duration::from_secs(60)).await; + Ok(ok_result("never")) + }) + }, + ); + tokio::time::sleep(std::time::Duration::from_millis(50)).await; + let detailed = manager.get_task(&task.task_id).unwrap(); + assert_eq!(detailed.status(), TaskStatus::Failed); + } + + #[tokio::test] + async fn input_required_roundtrip() { + let manager = TaskManager::new(); + let task = manager.spawn(TaskOptions::default(), |ctx| { + Box::pin(async move { + let request: InputRequest = serde_json::from_value(serde_json::json!({ + "method": "elicitation/create", + "params": { + "message": "What is your name?", + "requestedSchema": {"type": "object", "properties": {}} + } + })) + .map_err(|e| McpError::internal_error(e.to_string(), None))?; + let response = ctx.request_input("name-1", request).await?; + let name = response + .get("content") + .and_then(|c| c.get("name")) + .and_then(|v| v.as_str()) + .unwrap_or("unknown") + .to_string(); + Ok(ok_result(&format!("hello {name}"))) + }) + }); + + // Wait for the task to surface the input request. + let mut saw_input_required = false; + for _ in 0..100 { + tokio::time::sleep(std::time::Duration::from_millis(10)).await; + let detailed = manager.get_task(&task.task_id).unwrap(); + if let TaskPayload::InputRequired { input_requests } = &detailed.payload { + assert!(input_requests.contains_key("name-1")); + saw_input_required = true; + break; + } + } + assert!(saw_input_required, "task never reached input_required"); + + // Respond via tasks/update. + manager + .update_task( + &task.task_id, + [( + "name-1".to_string(), + serde_json::json!({"action": "accept", "content": {"name": "Ada"}}), + )], + ) + .unwrap(); + + for _ in 0..100 { + tokio::time::sleep(std::time::Duration::from_millis(10)).await; + let detailed = manager.get_task(&task.task_id).unwrap(); + if detailed.status() == TaskStatus::Completed { + return; + } + } + panic!("task did not complete after input response"); + } + + #[tokio::test] + async fn task_operation_reestablishes_request_association_scope() { + use crate::{ + model::RequestId, + service::{ORIGINATING_REQUEST, in_request_handler_scope}, + }; + + let manager = TaskManager::new(); + let observed = Arc::new(Mutex::new(None::)); + let observed_in_task = observed.clone(); + + ORIGINATING_REQUEST + .scope(RequestId::Number(7), async { + manager.spawn(TaskOptions::default(), move |_ctx| { + let observed_in_task = observed_in_task.clone(); + Box::pin(async move { + *observed_in_task.lock().unwrap() = Some(in_request_handler_scope()); + Ok(ok_result("done")) + }) + }) + }) + .await; + + for _ in 0..100 { + tokio::time::sleep(std::time::Duration::from_millis(10)).await; + if let Some(scoped) = *observed.lock().unwrap() { + assert!( + scoped, + "task operation must run inside the originating request's association scope" + ); + return; + } + } + panic!("task operation did not run"); + } + + #[tokio::test] + async fn task_operation_without_originating_request_is_unscoped() { + use crate::service::in_request_handler_scope; + + let manager = TaskManager::new(); + let observed = Arc::new(Mutex::new(None::)); + let observed_in_task = observed.clone(); + + manager.spawn(TaskOptions::default(), move |_ctx| { + let observed_in_task = observed_in_task.clone(); + Box::pin(async move { + *observed_in_task.lock().unwrap() = Some(in_request_handler_scope()); + Ok(ok_result("done")) + }) + }); + + for _ in 0..100 { + tokio::time::sleep(std::time::Duration::from_millis(10)).await; + if let Some(scoped) = *observed.lock().unwrap() { + assert!( + !scoped, + "task operation started without an originating request must remain unscoped" + ); + return; + } + } + panic!("task operation did not run"); + } +} diff --git a/vendor/rmcp/src/transport.rs b/vendor/rmcp/src/transport.rs new file mode 100644 index 00000000..fdedc9c3 --- /dev/null +++ b/vendor/rmcp/src/transport.rs @@ -0,0 +1,310 @@ +//! # Transport +//! The transport type must implemented [`Transport`] trait, which allow it send message concurrently and receive message sequentially. +//！ +//! ## Standard Transport Types +//! There are 2 pairs of standard transport types: +//! +//! | transport | client | server | +//! |:-: |:-: |:-: | +//! | std IO | [`child_process::TokioChildProcess`] | [`io::stdio`] | +//! | streamable http | [`streamable_http_client::StreamableHttpClientTransport`] | `streamable_http_server::StreamableHttpService` | +//! +//！## Helper Transport Types +//! Thers are several helper transport types that can help you to create transport quickly. +//! +//! ### [Worker Transport](`worker::WorkerTransport`) +//! Which allows you to run a worker and process messages in another tokio task. +//! +//! ### [Async Read/Write Transport](`async_rw::AsyncRwTransport`) +//! You need to enable `transport-async-rw` feature to use this transport. +//! +//! This transport is used to create a transport from a byte stream which implemented [`tokio::io::AsyncRead`] and [`tokio::io::AsyncWrite`]. +//! +//! This could be very helpful when you want to create a transport from a byte stream, such as a file or a tcp connection. +//! +//! ### [Sink/Stream Transport](`sink_stream::SinkStreamTransport`) +//! This transport is used to create a transport from a sink and a stream. +//! +//! This could be very helpful when you want to create a transport from a duplex object stream, such as a websocket connection. +//! +//! ## [IntoTransport](`IntoTransport`) trait +//! [`IntoTransport`] is a helper trait that implicitly convert a type into a transport type. +//! +//! ### These types is automatically implemented [`IntoTransport`] trait +//! 1. A type that already implement both [`futures::Sink`] and [`futures::Stream`] trait, or a tuple `(Tx, Rx)` where `Tx` is [`futures::Sink`] and `Rx` is [`futures::Stream`]. +//! 2. A type that implement both [`tokio::io::AsyncRead`] and [`tokio::io::AsyncWrite`] trait. or a tuple `(R, W)` where `R` is [`tokio::io::AsyncRead`] and `W` is [`tokio::io::AsyncWrite`]. +//! 3. A type that implement [Worker](`worker::Worker`) trait. +//! 4. A type that implement [`Transport`] trait. +//! +//! ## Examples +//! +//! ```rust +//! # use rmcp::{ +//! # ServiceExt, serve_server, +//! # }; +//! #[cfg(feature = "client")] +//! # use rmcp::serve_client; +//! +//! // create transport from tcp stream +//! #[cfg(feature = "client")] +//! async fn client() -> Result<(), Box> { +//! let stream = tokio::net::TcpSocket::new_v4()? +//! .connect("127.0.0.1:8001".parse()?) +//! .await?; +//! let client = ().serve(stream).await?; +//! let tools = client.peer().list_tools(Default::default()).await?; +//! println!("{:?}", tools); +//! Ok(()) +//! } +//! +//! // create transport from std io +//! #[cfg(feature = "client")] +//! async fn io() -> Result<(), Box> { +//! let client = ().serve((tokio::io::stdin(), tokio::io::stdout())).await?; +//! let tools = client.peer().list_tools(Default::default()).await?; +//! println!("{:?}", tools); +//! Ok(()) +//! } +//! ``` + +use std::{borrow::Cow, sync::Arc}; + +use crate::service::{RxJsonRpcMessage, ServiceRole, TxJsonRpcMessage}; + +pub mod sink_stream; + +#[cfg(feature = "transport-async-rw")] +pub mod async_rw; + +#[cfg(feature = "transport-worker")] +pub mod worker; +#[cfg(feature = "transport-worker")] +pub use worker::WorkerTransport; + +#[cfg(feature = "transport-child-process")] +pub mod child_process; +#[cfg(feature = "which-command")] +pub use child_process::which_command; +#[cfg(feature = "transport-child-process")] +pub use child_process::{ConfigureCommandExt, TokioChildProcess}; + +#[cfg(feature = "transport-io")] +pub mod io; +#[cfg(feature = "transport-io")] +pub use io::stdio; + +#[cfg(feature = "auth")] +pub mod auth; +#[cfg(feature = "auth-client-credentials-jwt")] +pub use auth::JwtSigningAlgorithm; +#[cfg(feature = "auth")] +pub use auth::{ + AuthClient, AuthError, AuthorizationManager, AuthorizationRequest, AuthorizationSession, + AuthorizedHttpClient, ClientCredentialsConfig, CredentialRefreshGuard, CredentialStore, + EXTENSION_OAUTH_CLIENT_CREDENTIALS, InMemoryCredentialStore, InMemoryStateStore, + OAuthHttpClient, OAuthHttpClientError, OAuthHttpClientFuture, OAuthHttpRedirectPolicy, + OAuthHttpRequest, ScopeUpgradeConfig, StateStore, StoredAuthorizationState, StoredCredentials, + WWWAuthenticateParams, +}; + +// #[cfg(feature = "transport-ws")] +// pub mod ws; +#[cfg(feature = "transport-streamable-http-server-session")] +pub mod streamable_http_server; +#[cfg(all(feature = "transport-streamable-http-server", not(feature = "local")))] +pub use streamable_http_server::tower::{StreamableHttpServerConfig, StreamableHttpService}; + +#[cfg(feature = "transport-streamable-http-client")] +pub mod streamable_http_client; +#[cfg(all(unix, feature = "transport-streamable-http-client-unix-socket"))] +pub use common::unix_socket::UnixSocketHttpClient; +#[cfg(feature = "transport-streamable-http-client")] +pub use streamable_http_client::StreamableHttpClientTransport; + +/// Common use codes +pub mod common; + +pub trait Transport: Send +where + R: ServiceRole, +{ + type Error: std::error::Error + Send + Sync + 'static; + fn name() -> Cow<'static, str> { + std::any::type_name::().into() + } + /// Send a message to the transport + /// + /// Notice that the future returned by this function should be `Send` and `'static`. + /// It's because the sending message could be executed concurrently. + /// + fn send( + &mut self, + item: TxJsonRpcMessage, + ) -> impl Future> + Send + 'static; + + /// Receive a message from the transport, this operation is sequential. + fn receive(&mut self) -> impl Future>> + Send; + + /// Close the transport + fn close(&mut self) -> impl Future> + Send; +} + +pub trait IntoTransport: Send + 'static +where + R: ServiceRole, + E: std::error::Error + Send + 'static, +{ + fn into_transport(self) -> impl Transport + 'static; +} + +#[non_exhaustive] +pub enum TransportAdapterIdentity {} +impl IntoTransport for T +where + T: Transport + Send + 'static, + R: ServiceRole, + E: std::error::Error + Send + Sync + 'static, +{ + fn into_transport(self) -> impl Transport + 'static { + self + } +} + +/// A transport that can send a single message and then close itself +pub struct OneshotTransport +where + R: ServiceRole, +{ + message: Option>, + sender: tokio::sync::mpsc::Sender>, + termination: Arc, +} + +impl OneshotTransport +where + R: ServiceRole, +{ + pub fn new( + message: RxJsonRpcMessage, + ) -> (Self, tokio::sync::mpsc::Receiver>) { + let (sender, receiver) = tokio::sync::mpsc::channel(16); + ( + Self { + message: Some(message), + sender, + termination: Arc::new(tokio::sync::Semaphore::new(0)), + }, + receiver, + ) + } +} + +impl Transport for OneshotTransport +where + R: ServiceRole, +{ + type Error = tokio::sync::mpsc::error::SendError>; + + fn send( + &mut self, + item: TxJsonRpcMessage, + ) -> impl Future> + Send + 'static { + let sender = self.sender.clone(); + let terminate = matches!(item, TxJsonRpcMessage::::Response(_)) + || matches!(item, TxJsonRpcMessage::::Error(_)); + let termination = self.termination.clone(); + async move { + sender.send(item).await?; + if terminate { + termination.add_permits(1); + } + Ok(()) + } + } + + async fn receive(&mut self) -> Option> { + if let Some(msg) = self.message.take() { + return Some(msg); + } + let _ = self.termination.acquire().await; + None + } + + fn close(&mut self) -> impl Future> + Send { + self.message.take(); + std::future::ready(Ok(())) + } +} + +#[derive(Debug, thiserror::Error)] +#[error("Transport [{transport_name}] error: {error}")] +#[non_exhaustive] +pub struct DynamicTransportError { + pub transport_name: Cow<'static, str>, + pub transport_type_id: std::any::TypeId, + #[source] + pub error: Box, +} + +impl DynamicTransportError { + pub fn new + 'static, R: ServiceRole>(e: T::Error) -> Self { + Self { + transport_name: T::name(), + transport_type_id: std::any::TypeId::of::(), + error: Box::new(e), + } + } + + /// Create a `DynamicTransportError` from raw parts. + /// + /// Unlike [`new`](Self::new), this does not require a concrete [`Transport`] type, + /// making it usable in test fixtures and other contexts where a real transport + /// implementation is not available. + pub fn from_parts( + transport_name: impl Into>, + transport_type_id: std::any::TypeId, + error: Box, + ) -> Self { + Self { + transport_name: transport_name.into(), + transport_type_id, + error, + } + } + + pub(crate) fn is_authorization_required(&self) -> bool { + let mut error = Some(self.error.as_ref() as &(dyn std::error::Error + 'static)); + while let Some(current) = error { + #[cfg(feature = "auth")] + if matches!( + current.downcast_ref::(), + Some(auth::AuthError::AuthorizationRequired) + ) { + return true; + } + + #[cfg(feature = "transport-streamable-http-client")] + if current.is::() { + return true; + } + + error = current.source(); + } + false + } + + pub fn downcast + 'static, R: ServiceRole>(self) -> Result { + if !self.is::() { + Err(self) + } else { + Ok(self + .error + .downcast::() + .map(|e| *e) + .expect("type is checked")) + } + } + pub fn is + 'static, R: ServiceRole>(&self) -> bool { + self.error.is::() && self.transport_type_id == std::any::TypeId::of::() + } +} diff --git a/vendor/rmcp/src/transport/async_rw.rs b/vendor/rmcp/src/transport/async_rw.rs new file mode 100644 index 00000000..e18fd4fc --- /dev/null +++ b/vendor/rmcp/src/transport/async_rw.rs @@ -0,0 +1,779 @@ +use std::{marker::PhantomData, sync::Arc}; + +use futures::SinkExt; +use serde::{Serialize, de::DeserializeOwned}; +use thiserror::Error; +use tokio::{ + io::{AsyncBufReadExt, AsyncRead, AsyncWrite, BufReader}, + sync::Mutex, +}; +use tokio_util::{ + bytes::{Buf, BufMut, BytesMut}, + codec::{Decoder, Encoder, FramedWrite}, +}; + +use super::{IntoTransport, Transport}; +use crate::{ + model::ErrorData, + service::{RxJsonRpcMessage, ServiceRole, TxJsonRpcMessage}, +}; + +#[non_exhaustive] +pub enum TransportAdapterAsyncRW {} + +impl IntoTransport for (R, W) +where + Role: ServiceRole, + R: AsyncRead + Send + 'static + Unpin, + W: AsyncWrite + Send + 'static + Unpin, +{ + fn into_transport(self) -> impl Transport + 'static { + AsyncRwTransport::new(self.0, self.1) + } +} + +#[non_exhaustive] +pub enum TransportAdapterAsyncCombinedRW {} +impl IntoTransport for S +where + Role: ServiceRole, + S: AsyncRead + AsyncWrite + Send + 'static, +{ + fn into_transport(self) -> impl Transport + 'static { + IntoTransport::::into_transport( + tokio::io::split(self), + ) + } +} + +pub type TransportWriter = FramedWrite>>; + +pub struct AsyncRwTransport { + read: BufReader, + line_buf: Vec, + write: Arc>>>, + _role: PhantomData Role>, +} + +impl AsyncRwTransport +where + R: Send + AsyncRead + Unpin, + W: Send + AsyncWrite + Unpin + 'static, +{ + pub fn new(read: R, write: W) -> Self { + let read = BufReader::new(read); + let write = Arc::new(Mutex::new(Some(FramedWrite::new( + write, + JsonRpcMessageCodec::>::default(), + )))); + Self { + read, + line_buf: Vec::new(), + write, + _role: PhantomData, + } + } +} + +#[cfg(feature = "client")] +impl AsyncRwTransport +where + R: Send + AsyncRead + Unpin, + W: Send + AsyncWrite + Unpin + 'static, +{ + pub fn new_client(read: R, write: W) -> Self { + Self::new(read, write) + } +} + +#[cfg(feature = "server")] +impl AsyncRwTransport +where + R: Send + AsyncRead + Unpin, + W: Send + AsyncWrite + Unpin + 'static, +{ + pub fn new_server(read: R, write: W) -> Self { + Self::new(read, write) + } +} + +impl Transport for AsyncRwTransport +where + R: Send + AsyncRead + Unpin, + W: Send + AsyncWrite + Unpin + 'static, +{ + type Error = std::io::Error; + + fn send( + &mut self, + item: TxJsonRpcMessage, + ) -> impl Future> + Send + 'static { + let lock = self.write.clone(); + async move { + let mut write = lock.lock().await; + if let Some(ref mut write) = *write { + write.send(item).await.map_err(Into::into) + } else { + Err(std::io::Error::new( + std::io::ErrorKind::NotConnected, + "Transport is closed", + )) + } + } + } + + async fn receive(&mut self) -> Option> { + loop { + // `read_until` is not cancellation-safe on its own, and `receive` is + // polled inside a `select!` in the service loop: an in-progress line + // read is dropped whenever another branch (e.g. an outgoing response) + // becomes ready. We rely on `read_until` appending into `self.line_buf` + // and only returning at a delimiter or EOF, so a cancelled read leaves + // its partial bytes in `self.line_buf`. Keeping that buffer across + // calls lets the next read resume the same line; it is cleared only + // after a whole line has been consumed. Clearing at the top of the + // loop (the previous behaviour) discarded the partial read and so + // dropped incoming requests under concurrent response load. + match self.read.read_until(b'\n', &mut self.line_buf).await { + // EOF. Any bytes still in `line_buf` are an incomplete trailing + // message with no delimiter, so there is nothing to deliver. + Ok(0) => return None, + Ok(_) => {} + Err(e) => { + tracing::error!("Error reading from stream: {}", e); + return None; + } + } + // A returned `read_until` means a full line is buffered. Parse it + // (borrowing `line_buf`), then clear the buffer — retaining its + // capacity for the next read — before handling the parse result. + let parsed = { + let line = without_carriage_return( + self.line_buf.strip_suffix(b"\n").unwrap_or(&self.line_buf), + ); + if line.is_empty() { + self.line_buf.clear(); + continue; + } + try_parse_with_compatibility::>(line, "receive") + }; + self.line_buf.clear(); + match parsed { + Ok(Some(msg)) => return Some(msg), + Ok(None) => continue, + Err(JsonRpcMessageCodecError::Serde(e)) => { + match e.classify() { + serde_json::error::Category::Syntax | serde_json::error::Category::Eof => { + // The input isn't valid JSON, so there's no message id to correlate a + // response to, and replying to invalid data can trigger an error storm + // if the peer echoes the response back as more invalid data. This + // matches the other official MCP SDKs, which ignore unparsable input. + // See https://github.com/modelcontextprotocol/rust-sdk/issues/938 + tracing::debug!("Ignoring unparsable incoming message: {e}"); + } + serde_json::error::Category::Data | serde_json::error::Category::Io => { + // Well-formed JSON that doesn't match the expected message shape is a + // real protocol error rather than unparsable input, so surface it with + // an Invalid Request response instead of silently dropping it. + tracing::debug!("Protocol error on incoming message: {e}"); + let mut write = self.write.lock().await; + let framed = write.as_mut()?; + let response = TxJsonRpcMessage::::error( + ErrorData::invalid_request("Invalid request", None), + None, + ); + if framed.send(response).await.is_err() { + return None; + } + } + } + } + Err(e) => { + tracing::error!("Error reading from stream: {}", e); + return None; + } + } + } + } + + async fn close(&mut self) -> Result<(), Self::Error> { + let mut write = self.write.lock().await; + drop(write.take()); + Ok(()) + } +} + +#[derive(Debug, Clone)] +pub struct JsonRpcMessageCodec { + _marker: PhantomData T>, + next_index: usize, + max_length: usize, + is_discarding: bool, +} + +impl Default for JsonRpcMessageCodec { + fn default() -> Self { + Self::new() + } +} + +impl JsonRpcMessageCodec { + pub fn new() -> Self { + Self { + _marker: PhantomData, + next_index: 0, + max_length: usize::MAX, + is_discarding: false, + } + } + + pub fn new_with_max_length(max_length: usize) -> Self { + Self { + max_length, + ..Self::new() + } + } + + pub fn max_length(&self) -> usize { + self.max_length + } +} + +fn without_carriage_return(s: &[u8]) -> &[u8] { + s.strip_suffix(b"\r").unwrap_or(s) +} + +/// UTF-8 byte order mark. RFC 8259 §8.1 allows JSON parsers to ignore a leading BOM. +const UTF8_BOM: &[u8; 3] = b"\xEF\xBB\xBF"; + +/// Check if a method is a standard MCP method (request, response, or notification). +/// This includes both requests and notifications defined in the MCP specification. +/// +/// Based on MCP specification 2026-07-28: https://modelcontextprotocol.io/specification/2026-07-28 +fn is_standard_method(method: &str) -> bool { + matches!( + method, + "initialize" + | "ping" + | "server/discover" + | "prompts/get" + | "prompts/list" + | "resources/list" + | "resources/read" + | "resources/subscribe" + | "resources/unsubscribe" + | "resources/templates/list" + | "subscriptions/listen" + | "tools/call" + | "tools/list" + | "completion/complete" + | "elicitation/create" + | "logging/setLevel" + | "roots/list" + | "sampling/createMessage" + ) || is_standard_notification(method) +} + +fn is_standard_notification(method: &str) -> bool { + matches!( + method, + "notifications/cancelled" + | "notifications/initialized" + | "notifications/message" + | "notifications/progress" + | "notifications/prompts/list_changed" + | "notifications/resources/list_changed" + | "notifications/resources/updated" + | "notifications/roots/list_changed" + | "notifications/subscriptions/acknowledged" + | "notifications/tools/list_changed" + ) +} + +/// Determines if a notification should be ignored for compatibility. +fn should_ignore_notification(json_value: &serde_json::Value, method: &str) -> bool { + let is_notification = json_value.get("id").is_none(); + + // Ignore non-MCP notifications (like LSP messages) for compatibility + if is_notification && !is_standard_method(method) { + tracing::trace!( + "Ignoring non-MCP notification '{}' for compatibility", + method + ); + return true; + } + + // Ignore non-standard MCP notifications + matches!( + ( + method.starts_with("notifications/"), + is_standard_notification(method) + ), + (true, false) + ) +} + +/// Try to parse a message with compatibility handling for non-standard notifications +fn try_parse_with_compatibility( + line: &[u8], + context: &str, +) -> Result, JsonRpcMessageCodecError> { + let line = line.strip_prefix(UTF8_BOM.as_slice()).unwrap_or(line); + if let Ok(line_str) = std::str::from_utf8(line) { + match serde_json::from_slice(line) { + Ok(item) => Ok(Some(item)), + Err(e) => { + // Check if this is a notification that should be ignored for compatibility + if let Ok(json_value) = serde_json::from_str::(line_str) + && let Some(method) = + json_value.get("method").and_then(serde_json::Value::as_str) + && should_ignore_notification(&json_value, method) + { + return Ok(None); + } + + tracing::debug!( + "Failed to parse message {}: {} | Error: {}", + context, + line_str, + e + ); + Err(JsonRpcMessageCodecError::Serde(e)) + } + } + } else { + serde_json::from_slice(line) + .map(Some) + .map_err(JsonRpcMessageCodecError::Serde) + } +} + +#[derive(Debug, Error)] +#[non_exhaustive] +pub enum JsonRpcMessageCodecError { + #[error("max line length exceeded")] + MaxLineLengthExceeded, + #[error("serde error {0}")] + Serde(#[from] serde_json::Error), + #[error("io error {0}")] + Io(#[from] std::io::Error), +} + +impl From for std::io::Error { + fn from(value: JsonRpcMessageCodecError) -> Self { + match value { + JsonRpcMessageCodecError::MaxLineLengthExceeded => { + std::io::Error::new(std::io::ErrorKind::InvalidData, value) + } + JsonRpcMessageCodecError::Serde(e) => e.into(), + JsonRpcMessageCodecError::Io(e) => e, + } + } +} + +impl Decoder for JsonRpcMessageCodec { + type Item = T; + + type Error = JsonRpcMessageCodecError; + + fn decode( + &mut self, + buf: &mut BytesMut, + ) -> Result, JsonRpcMessageCodecError> { + loop { + // Determine how far into the buffer we'll search for a newline. If + // there's no max_length set, we'll read to the end of the buffer. + let read_to = std::cmp::min(self.max_length.saturating_add(1), buf.len()); + + let newline_offset = buf[self.next_index..read_to] + .iter() + .position(|b| *b == b'\n'); + + match (self.is_discarding, newline_offset) { + (true, Some(offset)) => { + // If we found a newline, discard up to that offset and + // then stop discarding. On the next iteration, we'll try + // to read a line normally. + buf.advance(offset + self.next_index + 1); + self.is_discarding = false; + self.next_index = 0; + } + (true, None) => { + // Otherwise, we didn't find a newline, so we'll discard + // everything we read. On the next iteration, we'll continue + // discarding up to max_len bytes unless we find a newline. + buf.advance(read_to); + self.next_index = 0; + if buf.is_empty() { + return Ok(None); + } + } + (false, Some(offset)) => { + // Found a line! + let newline_index = offset + self.next_index; + self.next_index = 0; + let line = buf.split_to(newline_index + 1); + let line = &line[..line.len() - 1]; + let line = without_carriage_return(line); + + // Use compatibility handling function + let item = match try_parse_with_compatibility(line, "decode")? { + Some(item) => item, + None => return Ok(None), // Skip non-standard message + }; + return Ok(Some(item)); + } + (false, None) if buf.len() > self.max_length => { + // Reached the maximum length without finding a + // newline, return an error and start discarding on the + // next call. + self.is_discarding = true; + return Err(JsonRpcMessageCodecError::MaxLineLengthExceeded); + } + (false, None) => { + // We didn't find a line or reach the length limit, so the next + // call will resume searching at the current offset. + self.next_index = read_to; + return Ok(None); + } + } + } + } + + fn decode_eof(&mut self, buf: &mut BytesMut) -> Result, JsonRpcMessageCodecError> { + Ok(match self.decode(buf)? { + Some(frame) => Some(frame), + None => { + self.next_index = 0; + // No terminating newline - return remaining data, if any + if buf.is_empty() || buf == &b"\r"[..] { + None + } else { + let line = buf.split_to(buf.len()); + let line = without_carriage_return(&line); + + // Use compatibility handling function + let item = match try_parse_with_compatibility(line, "decode_eof")? { + Some(item) => item, + None => return Ok(None), // Skip non-standard message + }; + Some(item) + } + } + }) + } +} + +impl Encoder for JsonRpcMessageCodec { + type Error = JsonRpcMessageCodecError; + + fn encode(&mut self, item: T, buf: &mut BytesMut) -> Result<(), JsonRpcMessageCodecError> { + serde_json::to_writer(buf.writer(), &item)?; + buf.put_u8(b'\n'); + Ok(()) + } +} + +#[cfg(test)] +mod test { + use futures::{Sink, Stream, StreamExt}; + use tokio_util::codec::FramedRead; + + use super::*; + fn from_async_read(reader: R) -> impl Stream { + FramedRead::new(reader, JsonRpcMessageCodec::::default()).filter_map(|result| { + if let Err(e) = &result { + tracing::error!("Error reading from stream: {}", e); + } + futures::future::ready(result.ok()) + }) + } + + fn from_async_write( + writer: W, + ) -> impl Sink { + FramedWrite::new(writer, JsonRpcMessageCodec::::default()).sink_map_err(Into::into) + } + #[tokio::test] + async fn test_decode() { + use futures::StreamExt; + use tokio::io::BufReader; + + let data = r#"{"jsonrpc":"2.0","method":"subtract","params":[42,23],"id":1} + {"jsonrpc":"2.0","method":"subtract","params":[23,42],"id":2} + {"jsonrpc":"2.0","method":"subtract","params":[42,23],"id":3} + {"jsonrpc":"2.0","method":"subtract","params":[23,42],"id":4} + {"jsonrpc":"2.0","method":"subtract","params":[42,23],"id":5} + {"jsonrpc":"2.0","method":"subtract","params":[23,42],"id":6} + {"jsonrpc":"2.0","method":"subtract","params":[42,23],"id":7} + {"jsonrpc":"2.0","method":"subtract","params":[23,42],"id":8} + {"jsonrpc":"2.0","method":"subtract","params":[42,23],"id":9} + {"jsonrpc":"2.0","method":"subtract","params":[23,42],"id":10} + + "#; + + let mut cursor = BufReader::new(data.as_bytes()); + let mut stream = from_async_read::(&mut cursor); + + for i in 1..=10 { + let item = stream.next().await.unwrap(); + assert_eq!( + item, + serde_json::json!({ + "jsonrpc": "2.0", + "method": "subtract", + "params": if i % 2 != 0 { [42, 23] } else { [23, 42] }, + "id": i, + }) + ); + } + } + + #[tokio::test] + async fn test_encode() { + let test_messages = vec![ + serde_json::json!({ + "jsonrpc": "2.0", + "method": "subtract", + "params": [42, 23], + "id": 1, + }), + serde_json::json!({ + "jsonrpc": "2.0", + "method": "subtract", + "params": [23, 42], + "id": 2, + }), + ]; + + // Create a buffer to write to + let mut buffer = Vec::new(); + let mut writer = from_async_write(&mut buffer); + + // Write the test messages + for message in test_messages.iter() { + writer.send(message.clone()).await.unwrap(); + } + writer.close().await.unwrap(); + drop(writer); + // Parse the buffer back into lines and check each one + let output = String::from_utf8_lossy(&buffer); + let mut lines = output.lines(); + + for expected_message in test_messages { + let line = lines.next().unwrap(); + let parsed_message: serde_json::Value = serde_json::from_str(line).unwrap(); + assert_eq!(parsed_message, expected_message); + } + + // Make sure there are no extra lines + assert!(lines.next().is_none()); + } + + #[test] + fn test_standard_notification_check() { + // Test that all standard notifications are recognized + assert!(is_standard_notification("notifications/cancelled")); + assert!(is_standard_notification("notifications/initialized")); + assert!(is_standard_notification("notifications/progress")); + assert!(is_standard_notification( + "notifications/resources/list_changed" + )); + assert!(is_standard_notification("notifications/resources/updated")); + assert!(is_standard_notification( + "notifications/prompts/list_changed" + )); + assert!(is_standard_notification("notifications/tools/list_changed")); + assert!(is_standard_notification("notifications/message")); + assert!(is_standard_notification("notifications/roots/list_changed")); + assert!(is_standard_notification( + "notifications/subscriptions/acknowledged" + )); + + // Test that non-standard notifications are not recognized + assert!(!is_standard_notification("notifications/stderr")); + assert!(!is_standard_notification("notifications/custom")); + assert!(!is_standard_notification("notifications/debug")); + assert!(!is_standard_notification("some/other/method")); + } + + #[test] + fn test_2026_07_28_standard_method_check() { + for method in [ + "elicitation/create", + "server/discover", + "subscriptions/listen", + ] { + assert!(is_standard_method(method), "{method} should be standard"); + } + } + + #[test] + fn test_current_standard_notification_is_not_ignored() { + let method = "notifications/subscriptions/acknowledged"; + let notification = serde_json::json!({ + "jsonrpc": "2.0", + "method": method, + }); + + assert!(!should_ignore_notification(¬ification, method)); + } + + #[test] + fn test_unknown_notification_is_ignored() { + let method = "notifications/custom"; + let notification = serde_json::json!({ + "jsonrpc": "2.0", + "method": method, + }); + + assert!(should_ignore_notification(¬ification, method)); + } + + #[test] + fn test_compatibility_function() { + // Test the compatibility function directly + let stderr_message = + r#"{"method":"notifications/stderr","params":{"content":"stderr message"}}"#; + let custom_message = r#"{"method":"notifications/custom","params":{"data":"custom"}}"#; + let standard_message = + r#"{"method":"notifications/message","params":{"level":"info","data":"standard"}}"#; + let progress_message = r#"{"method":"notifications/progress","params":{"progressToken":"token","progress":50}}"#; + + // Test with valid JSON - all should parse successfully + let result1 = + try_parse_with_compatibility::(stderr_message.as_bytes(), "test"); + let result2 = + try_parse_with_compatibility::(custom_message.as_bytes(), "test"); + let result3 = + try_parse_with_compatibility::(standard_message.as_bytes(), "test"); + let result4 = + try_parse_with_compatibility::(progress_message.as_bytes(), "test"); + + // All should parse successfully since they're valid JSON + assert!(result1.is_ok()); + assert!(result2.is_ok()); + assert!(result3.is_ok()); + assert!(result4.is_ok()); + + // Standard notifications should return Some(value) + assert!(result3.unwrap().is_some()); + assert!(result4.unwrap().is_some()); + + println!("Standard notifications are preserved, non-standard are handled gracefully"); + } + + #[tokio::test] + async fn test_decode_strips_utf8_bom() { + use futures::StreamExt; + use tokio::io::BufReader; + + // Valid JSON-RPC message preceded by a UTF-8 BOM (EF BB BF). Some Windows + // tooling and editors prepend this; the codec should ignore it per RFC 8259 §8.1. + let mut data = Vec::new(); + data.extend_from_slice(UTF8_BOM); + data.extend_from_slice(br#"{"jsonrpc":"2.0","method":"ping","id":1}"#); + data.push(b'\n'); + + let mut cursor = BufReader::new(&data[..]); + let mut stream = from_async_read::(&mut cursor); + + let item = stream + .next() + .await + .expect("should decode BOM-prefixed line"); + assert_eq!( + item, + serde_json::json!({"jsonrpc": "2.0", "method": "ping", "id": 1}) + ); + } + + #[cfg(feature = "server")] + #[tokio::test] + async fn receive_ignores_parse_error() { + use tokio::io::{AsyncReadExt, AsyncWriteExt}; + + use crate::{RoleServer, transport::Transport}; + + // Two paired streams: `server_io` is wrapped by the transport; the test + // drives `client_io` to act as the peer. + let (server_io, client_io) = tokio::io::duplex(4096); + let (server_r, server_w) = tokio::io::split(server_io); + let (mut client_r, mut client_w) = tokio::io::split(client_io); + + let mut transport = AsyncRwTransport::::new(server_r, server_w); + + client_w + .write_all( + b"not json\n{\"jsonrpc\":\"2.0\",\"method\":\"notifications/initialized\"}\n", + ) + .await + .unwrap(); + + // The unparsable line is skipped and the next valid message is still yielded. + let received = transport + .receive() + .await + .expect("transport should skip the invalid line and yield the next valid message"); + assert_eq!( + serde_json::to_value(&received).unwrap()["method"], + "notifications/initialized", + ); + + // No response is sent back for the unparsable message (issue #938). Dropping the + // transport closes its write side, so the peer reads to EOF and should see no bytes. + drop(transport); + let mut reply_buf = Vec::new(); + client_r.read_to_end(&mut reply_buf).await.unwrap(); + assert!( + reply_buf.is_empty(), + "expected no response to an unparsable message, got: {}", + String::from_utf8_lossy(&reply_buf), + ); + } + + #[cfg(feature = "server")] + #[tokio::test] + async fn receive_responds_to_protocol_error() { + use tokio::io::{AsyncBufReadExt, AsyncWriteExt, BufReader}; + + use crate::{RoleServer, transport::Transport}; + + let (server_io, client_io) = tokio::io::duplex(4096); + let (server_r, server_w) = tokio::io::split(server_io); + let (client_r, mut client_w) = tokio::io::split(client_io); + + let mut transport = AsyncRwTransport::::new(server_r, server_w); + + // Well-formed JSON that does not match the JSON-RPC message shape, followed by a + // valid notification. Unlike unparsable bytes, this is a protocol error: the + // transport should reply to it and still yield the next valid message. + client_w + .write_all( + b"{\"foo\":\"bar\"}\n{\"jsonrpc\":\"2.0\",\"method\":\"notifications/initialized\"}\n", + ) + .await + .unwrap(); + + let received = transport.receive().await.expect( + "transport should reply to the protocol error and yield the next valid message", + ); + assert_eq!( + serde_json::to_value(&received).unwrap()["method"], + "notifications/initialized", + ); + + // A protocol error gets an error response back (id omitted since it can't be read). + let mut reply_buf = Vec::new(); + let mut peer = BufReader::new(client_r); + peer.read_until(b'\n', &mut reply_buf).await.unwrap(); + let reply: serde_json::Value = serde_json::from_slice(&reply_buf).unwrap(); + assert_eq!( + reply, + serde_json::json!({ + "jsonrpc": "2.0", + "error": {"code": -32600, "message": "Invalid request"}, + }), + ); + } +} diff --git a/vendor/rmcp/src/transport/auth.rs b/vendor/rmcp/src/transport/auth.rs new file mode 100644 index 00000000..0727368c --- /dev/null +++ b/vendor/rmcp/src/transport/auth.rs @@ -0,0 +1,9538 @@ +use std::{ + collections::{HashMap, HashSet}, + future::Future, + net::{IpAddr, Ipv4Addr, Ipv6Addr}, + pin::Pin, + sync::Arc, + time::{Duration, SystemTime, UNIX_EPOCH}, +}; + +use async_trait::async_trait; +use futures::StreamExt; +use oauth2::{ + AsyncHttpClient, AuthType, AuthUrl, AuthorizationCode, ClientId, ClientSecret, CsrfToken, + EmptyExtraTokenFields, ExtraTokenFields, HttpRequest, HttpResponse, PkceCodeChallenge, + PkceCodeVerifier, RedirectUrl, RefreshToken, RequestTokenError, Scope, StandardTokenResponse, + TokenResponse, TokenUrl, + basic::{BasicErrorResponseType, BasicTokenType}, +}; +use reqwest::{ + Client as ReqwestClient, IntoUrl, StatusCode, Url, + header::{AUTHORIZATION, CONTENT_TYPE, LOCATION, WWW_AUTHENTICATE}, +}; +use serde::{Deserialize, Serialize}; +use serde_json::Value; +use thiserror::Error; +use tokio::sync::{Mutex, RwLock}; +use tracing::{debug, warn}; + +use crate::transport::common::http_header::HEADER_MCP_PROTOCOL_VERSION; + +#[cfg(feature = "auth-enterprise-managed")] +pub mod enterprise; + +const DEFAULT_HTTP_TIMEOUT: Duration = Duration::from_secs(30); +const MAX_OAUTH_HTTP_RESPONSE_BODY_BYTES: usize = 1024 * 1024; +const MAX_OAUTH_DISCOVERY_REDIRECTS: usize = 10; +const CLOUD_METADATA_HOSTS: &[&str] = &[ + "metadata", + "metadata.google.internal", + "metadata.azure.internal", +]; + +/// Redirect handling requested for an outbound OAuth HTTP operation. +#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)] +#[non_exhaustive] +pub enum OAuthHttpRedirectPolicy { + /// Follow redirects using the client's normal limits. + #[default] + Follow, + /// Return the redirect response without following its location. + Stop, +} + +/// A complete outbound HTTP operation requested by the OAuth implementation. +#[non_exhaustive] +pub struct OAuthHttpRequest { + /// HTTP request with an absolute URI and buffered body. + pub request: HttpRequest, + /// Redirect behavior required by the OAuth operation. + pub redirect_policy: OAuthHttpRedirectPolicy, + /// Suggested maximum duration for the operation, or no SDK-specified timeout. + /// Implementations with their own timeout policy may retain it instead. + pub timeout: Option, +} + +impl OAuthHttpRequest { + fn new(request: HttpRequest, redirect_policy: OAuthHttpRedirectPolicy) -> Self { + Self { + request, + redirect_policy, + timeout: Some(DEFAULT_HTTP_TIMEOUT), + } + } +} + +/// Type-erased error returned by an [`OAuthHttpClient`]. +pub type OAuthHttpClientError = Box; + +#[derive(Debug, Error)] +enum OAuthHttpError { + #[error("OAuth HTTP response body exceeds {0} bytes")] + ResponseBodyTooLarge(usize), + #[error("unexpected HTTP status {0}")] + UnexpectedStatus(StatusCode), + #[error("OAuth discovery redirect to non-same-origin URL rejected: {0}")] + CrossOriginRedirect(Url), + #[error("OAuth discovery exceeded {0} redirects")] + TooManyRedirects(usize), +} + +/// Future returned by [`OAuthHttpClient::execute`]. +pub type OAuthHttpClientFuture<'a> = + Pin> + Send + 'a>>; + +/// Executes every outbound HTTP request made by the OAuth state machine. +/// +/// Implementations may route requests through a remote execution environment. +/// They must honor the request's redirect policy and return the raw response +/// status, headers, and body. +pub trait OAuthHttpClient: Send + Sync { + /// Execute one OAuth HTTP operation. + fn execute(&self, request: OAuthHttpRequest) -> OAuthHttpClientFuture<'_>; +} + +/// Create an OAuth HTTP client with the SDK's default reqwest configuration. +/// +/// Honors each request's redirect policy, with a 30-second timeout and bounded +/// response bodies. Enable a TLS feature such as `reqwest` for HTTPS requests. +/// Implement [`OAuthHttpClient`] instead when custom network policy is required. +pub fn default_oauth_http_client() -> Result { + let client = ReqwestClient::builder() + .timeout(DEFAULT_HTTP_TIMEOUT) + .build() + .map_err(|error| AuthError::InternalError(error.to_string()))?; + ReqwestOAuthHttpClient::new(client) +} + +struct ReqwestOAuthHttpClient { + follow_redirects: ReqwestClient, + stop_redirects: ReqwestClient, +} + +impl ReqwestOAuthHttpClient { + fn new(follow_redirects: ReqwestClient) -> Result { + let stop_redirects = ReqwestClient::builder() + .timeout(DEFAULT_HTTP_TIMEOUT) + .redirect(reqwest::redirect::Policy::none()) + .build() + .map_err(|error| AuthError::InternalError(error.to_string()))?; + Ok(Self { + follow_redirects, + stop_redirects, + }) + } +} + +impl OAuthHttpClient for ReqwestOAuthHttpClient { + fn execute(&self, request: OAuthHttpRequest) -> OAuthHttpClientFuture<'_> { + Box::pin(async move { + let OAuthHttpRequest { + request, + redirect_policy, + .. + } = request; + let client = match redirect_policy { + OAuthHttpRedirectPolicy::Follow => &self.follow_redirects, + OAuthHttpRedirectPolicy::Stop => &self.stop_redirects, + }; + let request = reqwest::Request::try_from(request) + .map_err(|error| Box::new(error) as OAuthHttpClientError)?; + let response = client + .execute(request) + .await + .map_err(|error| Box::new(error) as OAuthHttpClientError)?; + + let mut builder = oauth2::http::Response::builder() + .status(response.status()) + .version(response.version()); + for (name, value) in response.headers() { + builder = builder.header(name, value); + } + let mut body = Vec::new(); + let mut body_stream = response.bytes_stream(); + while let Some(chunk) = body_stream.next().await { + let chunk = chunk.map_err(|error| Box::new(error) as OAuthHttpClientError)?; + if chunk.len() > MAX_OAUTH_HTTP_RESPONSE_BODY_BYTES - body.len() { + return Err(Box::new(OAuthHttpError::ResponseBodyTooLarge( + MAX_OAUTH_HTTP_RESPONSE_BODY_BYTES, + )) as OAuthHttpClientError); + } + body.extend_from_slice(&chunk); + } + builder + .body(body) + .map_err(|error| Box::new(error) as OAuthHttpClientError) + }) + } +} + +struct OAuth2HttpClient<'a> { + client: &'a dyn OAuthHttpClient, + redirect_policy: OAuthHttpRedirectPolicy, +} + +#[derive(Debug)] +struct OAuth2HttpClientError(OAuthHttpClientError); + +impl std::fmt::Display for OAuth2HttpClientError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str("OAuth HTTP request failed") + } +} + +impl std::error::Error for OAuth2HttpClientError { + fn source(&self) -> Option<&(dyn std::error::Error + 'static)> { + Some(self.0.as_ref()) + } +} + +impl<'c> AsyncHttpClient<'c> for OAuth2HttpClient<'_> { + type Error = OAuth2HttpClientError; + + type Future = std::pin::Pin< + Box> + Send + 'c>, + >; + + fn call(&'c self, request: HttpRequest) -> Self::Future { + Box::pin(async move { + self.client + .execute(OAuthHttpRequest::new(request, self.redirect_policy)) + .await + .map_err(OAuth2HttpClientError) + }) + } +} + +const DEFAULT_EXCHANGE_URL: &str = "http://localhost"; + +/// Default OIDC Dynamic Client Registration `application_type` (SEP-837) +const DEFAULT_APPLICATION_TYPE: &str = "native"; + +/// Stored credentials for OAuth2 authorization +#[derive(Clone, Serialize, Deserialize)] +#[non_exhaustive] +pub struct StoredCredentials { + pub client_id: String, + pub token_response: Option, + #[serde(default)] + pub granted_scopes: Vec, + #[serde(default)] + pub token_received_at: Option, + #[serde(default)] + pub issuer: Option, +} + +impl std::fmt::Debug for StoredCredentials { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("StoredCredentials") + .field("client_id", &self.client_id) + .field( + "token_response", + &self.token_response.as_ref().map(|_| "[REDACTED]"), + ) + .field("granted_scopes", &self.granted_scopes) + .field("token_received_at", &self.token_received_at) + .field("issuer", &self.issuer) + .finish() + } +} + +impl StoredCredentials { + /// Create a new `StoredCredentials` instance. + pub fn new( + client_id: String, + token_response: Option, + granted_scopes: Vec, + token_received_at: Option, + ) -> Self { + Self { + client_id, + token_response, + granted_scopes, + token_received_at, + issuer: None, + } + } + + pub fn with_issuer(mut self, issuer: Option) -> Self { + self.issuer = issuer; + self + } +} + +/// An owned guard held across a credential refresh and its save. +/// +/// Stores can wrap a file lock, an owned mutex guard, or another coordination +/// primitive. Dropping this value releases the guard. +#[must_use = "dropping the guard releases refresh coordination"] +pub struct CredentialRefreshGuard { + _guard: Box, +} + +impl CredentialRefreshGuard { + /// Wrap a guard whose lifetime coordinates access to the stored credentials. + pub fn new(guard: impl Send + 'static) -> Self { + Self { + _guard: Box::new(guard), + } + } +} + +/// Trait for storing and retrieving OAuth2 credentials +/// +/// Implementations of this trait can provide custom storage backends +/// for OAuth2 credentials, such as file-based storage, keychain integration, +/// or database storage. +/// +/// Return [`AuthError::CredentialStoreError`] for backend or locking failures +/// so they remain distinct from errors requiring reauthorization. +#[async_trait] +pub trait CredentialStore: Send + Sync { + async fn load(&self) -> Result, AuthError>; + + async fn save(&self, credentials: StoredCredentials) -> Result<(), AuthError>; + + async fn clear(&self) -> Result<(), AuthError>; + + /// Optionally coordinate refreshes that share these credentials. + /// + /// The manager acquires this guard before loading credentials and retains it + /// through the token request and save. `load` and `save` must not reacquire + /// the same lock. Writers that bypass the guard are not coordinated with it. + /// The default does not coordinate refreshes. + async fn acquire_refresh_guard(&self) -> Result, AuthError> { + Ok(None) + } +} + +/// In-memory credential store (default implementation) +/// +/// This store keeps credentials in memory only and does not persist them +/// between application restarts. This is the default behavior when no +/// custom credential store is provided. +#[derive(Debug, Default, Clone)] +pub struct InMemoryCredentialStore { + credentials: Arc>>, +} + +impl InMemoryCredentialStore { + pub fn new() -> Self { + Self { + credentials: Arc::new(RwLock::new(None)), + } + } +} + +#[async_trait::async_trait] +impl CredentialStore for InMemoryCredentialStore { + async fn load(&self) -> Result, AuthError> { + Ok(self.credentials.read().await.clone()) + } + + async fn save(&self, credentials: StoredCredentials) -> Result<(), AuthError> { + *self.credentials.write().await = Some(credentials); + Ok(()) + } + + async fn clear(&self) -> Result<(), AuthError> { + *self.credentials.write().await = None; + Ok(()) + } +} + +/// Stored authorization state for OAuth2 PKCE flow +#[derive(Clone, Serialize, Deserialize)] +#[non_exhaustive] +pub struct StoredAuthorizationState { + pub pkce_verifier: String, + pub csrf_token: String, + #[serde(default)] + pub expected_issuer: Option, + #[serde(default)] + pub require_issuer: bool, + pub created_at: u64, + /// scopes requested in this round, used to resolve the grant when the token response omits + /// `scope` (RFC 6749 §5.1) + #[serde(default)] + pub requested_scopes: Vec, +} + +impl std::fmt::Debug for StoredAuthorizationState { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("StoredAuthorizationState") + .field("pkce_verifier", &"[REDACTED]") + .field("csrf_token", &"[REDACTED]") + .field("expected_issuer", &self.expected_issuer) + .field("require_issuer", &self.require_issuer) + .field("created_at", &self.created_at) + .field("requested_scopes", &self.requested_scopes) + .finish() + } +} + +/// A transparent wrapper around a JSON object that captures any extra fields returned by the +/// authorization server during token exchange that are not part of the standard OAuth 2.0 token +/// response. +/// +/// OAuth providers may include non-standard fields alongside the +/// standard OAuth fields. Those fields are collected here so callers +/// can inspect them without losing data. +/// +/// The inner [`HashMap`] maps field names to their raw JSON values. +/// +/// # Accessing extra fields +/// +/// Extra fields are available through [`StandardTokenResponse::extra_fields()`], which returns a +/// reference to this struct. Use the inner map (`.0`) to look up individual fields by name: +/// +/// ```rust,ignore +/// // Obtain the token response from the AuthorizationManager, then: +/// if let Some(value) = token_response.extra_fields().0.get("vendorSpecificField") { +/// println!("vendorSpecificField = {value}"); +/// } +/// ``` +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[non_exhaustive] +pub struct VendorExtraTokenFields(pub HashMap); + +impl ExtraTokenFields for VendorExtraTokenFields {} + +impl StoredAuthorizationState { + pub fn new(pkce_verifier: &PkceCodeVerifier, csrf_token: &CsrfToken) -> Self { + Self::new_with_expected_issuer(pkce_verifier, csrf_token, None, false) + } + + pub fn new_with_expected_issuer( + pkce_verifier: &PkceCodeVerifier, + csrf_token: &CsrfToken, + expected_issuer: Option, + require_issuer: bool, + ) -> Self { + Self { + pkce_verifier: pkce_verifier.secret().to_string(), + csrf_token: csrf_token.secret().to_string(), + expected_issuer, + require_issuer, + created_at: std::time::SystemTime::now() + .duration_since(std::time::UNIX_EPOCH) + .map(|d| d.as_secs()) + .unwrap_or(0), + requested_scopes: Vec::new(), + } + } + + /// record the scopes requested in this authorization round (SEP-2350) + pub fn with_requested_scopes(mut self, scopes: Vec) -> Self { + self.requested_scopes = scopes; + self + } + + pub fn into_pkce_verifier(self) -> PkceCodeVerifier { + PkceCodeVerifier::new(self.pkce_verifier) + } +} + +/// Trait for storing and retrieving OAuth2 authorization state +/// +/// Implementations of this trait can provide custom storage backends +/// for OAuth2 PKCE flow state, such as Redis or database storage. +/// +/// Implementors are responsible for expiring stale states (e.g., abandoned +/// authorization flows). Use [`StoredAuthorizationState::created_at`] for +/// TTL-based expiration. +#[async_trait] +pub trait StateStore: Send + Sync { + async fn save( + &self, + csrf_token: &str, + state: StoredAuthorizationState, + ) -> Result<(), AuthError>; + + async fn load(&self, csrf_token: &str) -> Result, AuthError>; + + async fn delete(&self, csrf_token: &str) -> Result<(), AuthError>; +} + +/// In-memory state store (default implementation) +/// +/// This store keeps authorization state in memory only and does not persist +/// between application restarts or across multiple server instances. +#[derive(Debug, Default, Clone)] +pub struct InMemoryStateStore { + states: Arc>>, +} + +impl InMemoryStateStore { + pub fn new() -> Self { + Self { + states: Arc::new(RwLock::new(HashMap::new())), + } + } +} + +#[async_trait] +impl StateStore for InMemoryStateStore { + async fn save( + &self, + csrf_token: &str, + state: StoredAuthorizationState, + ) -> Result<(), AuthError> { + self.states + .write() + .await + .insert(csrf_token.to_string(), state); + Ok(()) + } + + async fn load(&self, csrf_token: &str) -> Result, AuthError> { + Ok(self.states.read().await.get(csrf_token).cloned()) + } + + async fn delete(&self, csrf_token: &str) -> Result<(), AuthError> { + self.states.write().await.remove(csrf_token); + Ok(()) + } +} + +/// HTTP client with OAuth 2.0 authorization +#[derive(Clone)] +#[non_exhaustive] +pub struct AuthClient { + pub http_client: C, + pub auth_manager: Arc>, +} + +impl std::fmt::Debug for AuthClient { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("AuthorizedClient") + .field("http_client", &self.http_client) + .field("auth_manager", &"...") + .finish() + } +} + +impl AuthClient { + /// Create a new authorized HTTP client + pub fn new(http_client: C, auth_manager: AuthorizationManager) -> Self { + Self { + http_client, + auth_manager: Arc::new(Mutex::new(auth_manager)), + } + } +} + +impl AuthClient { + pub fn get_access_token(&self) -> impl Future> + Send { + let auth_manager = self.auth_manager.clone(); + async move { auth_manager.lock().await.get_access_token().await } + } +} + +/// Auth error +#[derive(Debug, Error)] +#[non_exhaustive] +pub enum AuthError { + #[error("OAuth authorization required")] + AuthorizationRequired, + + #[error("OAuth authorization failed: {0}")] + AuthorizationFailed(String), + + #[error("OAuth token exchange failed: {0}")] + TokenExchangeFailed(String), + + /// The refresh attempt failed without a definitive refresh-token rejection. + /// + /// Callers may retry this error because it includes transient request and provider failures. + #[error("OAuth token refresh failed: {0}")] + TokenRefreshFailed(String), + + /// The authorization server definitively rejected the refresh token. + #[error("OAuth refresh token was rejected: {0}")] + TokenRefreshRejected(String), + + #[error("OAuth credential store failed: {0}")] + CredentialStoreError(String), + + #[error("HTTP error: {0}")] + HttpError(#[from] reqwest::Error), + + #[error("OAuth error: {0}")] + OAuthError(String), + + #[error("Metadata error: {0}")] + MetadataError(String), + + #[error("Authorization server does not support the required PKCE code challenge method (S256)")] + PkceUnsupported, + + #[error("URL parse error: {0}")] + UrlError(#[from] url::ParseError), + + #[error("No authorization support detected")] + NoAuthorizationSupport, + + #[error("Internal error: {0}")] + InternalError(String), + + #[error("Invalid token type: {0}")] + InvalidTokenType(String), + + #[error("Token expired")] + TokenExpired, + + #[error("Invalid scope: {0}")] + InvalidScope(String), + + #[error("Registration failed: {0}")] + RegistrationFailed(String), + + #[error("Insufficient scope: {required_scope}")] + InsufficientScope { + required_scope: String, + upgrade_url: Option, + }, + + #[error( + "Authorization server issuer mismatch: expected {expected_issuer}, received {received_issuer}" + )] + AuthorizationServerMismatch { + expected_issuer: String, + received_issuer: String, + }, + + #[error("Authorization server response missing required issuer: expected {expected_issuer}")] + AuthorizationServerMissingIssuer { expected_issuer: String }, + + #[error("Client credentials error: {0}")] + ClientCredentialsError(String), + + #[cfg(feature = "auth-client-credentials-jwt")] + #[error("JWT signing error: {0}")] + JwtSigningError(String), +} + +/// oauth2 metadata +#[derive(Debug, Clone, Deserialize, Serialize, Default)] +#[non_exhaustive] +pub struct AuthorizationMetadata { + pub authorization_endpoint: String, + pub token_endpoint: String, + pub registration_endpoint: Option, + pub issuer: Option, + pub jwks_uri: Option, + pub scopes_supported: Option>, + pub response_types_supported: Option>, + pub code_challenge_methods_supported: Option>, + // allow additional fields + #[serde(flatten)] + pub additional_fields: HashMap, +} + +/// How [`AuthorizationMetadata`] was obtained during discovery. +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +#[non_exhaustive] +pub enum AuthorizationMetadataSource { + /// Discovered through RFC 9728 protected resource metadata. + ProtectedResourceMetadata, + /// Discovered through RFC 8414 / OpenID Connect metadata at the server's + /// base URL. + AuthorizationServerMetadata, + /// Nothing was discovered; the endpoints were synthesized from the base + /// URL (`/authorize`, `/token`, `/register`) for compatibility with the + /// 2025-03-26 MCP spec's default-endpoint fallback. The server gave no + /// evidence that it supports OAuth. + /// + /// [Newer MCP revisions] require metadata discovery and do not define an + /// endpoint-synthesis fallback. + /// + /// [Newer MCP revisions]: https://modelcontextprotocol.io/specification/2026-07-28/basic/authorization/authorization-server-discovery#protected-resource-metadata-discovery-requirements + LegacyEndpointFallback, +} + +impl AuthorizationMetadataSource { + /// Whether the metadata was actually published by the server, as opposed + /// to synthesized by the client as a legacy compatibility fallback. + pub fn is_discovered(self) -> bool { + !matches!(self, Self::LegacyEndpointFallback) + } +} + +/// [`AuthorizationMetadata`] together with how it was resolved. +#[derive(Debug, Clone)] +#[non_exhaustive] +pub struct AuthorizationMetadataResolution { + pub metadata: AuthorizationMetadata, + pub source: AuthorizationMetadataSource, +} + +#[derive(Debug, Clone, Deserialize)] +struct ResourceServerMetadata { + resource: Option, + authorization_server: Option, + authorization_servers: Option>, + scopes_supported: Option>, +} + +/// How a url that may hold protected resource metadata was arrived at, which +/// decides what a document that is not metadata means there. +#[derive(Debug, Clone, Copy)] +enum ResourceMetadataUrlOrigin { + /// The resource itself named this url in the `resource_metadata` parameter + /// of its `WWW-Authenticate` challenge. + Advertised, + /// The url was derived from the base url on the chance that the document is + /// published there, or named by a challenge on such a url. Either way the + /// run only guessed its way here. + WellKnownGuess, +} + +/// Parameters extracted from WWW-Authenticate header +#[derive(Debug, Clone, Default)] +#[non_exhaustive] +pub struct WWWAuthenticateParams { + pub resource_metadata_url: Option, + pub scope: Option, + pub error: Option, + pub error_description: Option, +} + +impl WWWAuthenticateParams { + /// Parse a `WWW-Authenticate` header value, resolving a relative + /// `resource_metadata` URL against `base_url`. + pub fn parse(header: &str, base_url: &Url) -> Self { + AuthorizationManager::extract_www_authenticate_params(header, base_url) + } + + /// check if this is an insufficient_scope error + pub fn is_insufficient_scope(&self) -> bool { + self.error.as_deref() == Some("insufficient_scope") + } + + /// check if this is an invalid_token error (expired/revoked) + pub fn is_invalid_token(&self) -> bool { + self.error.as_deref() == Some("invalid_token") + } +} + +/// oauth2 client config +#[derive(Debug, Clone)] +#[non_exhaustive] +pub struct OAuthClientConfig { + pub client_id: String, + pub client_secret: Option, + pub scopes: Vec, + pub redirect_uri: String, + pub application_type: Option, +} + +impl OAuthClientConfig { + pub fn new(client_id: impl Into, redirect_uri: impl Into) -> Self { + Self { + client_id: client_id.into(), + client_secret: None, + scopes: Vec::new(), + redirect_uri: redirect_uri.into(), + application_type: Some(DEFAULT_APPLICATION_TYPE.to_string()), + } + } + + pub fn with_client_secret(mut self, secret: impl Into) -> Self { + self.client_secret = Some(secret.into()); + self + } + + pub fn with_scopes(mut self, scopes: Vec) -> Self { + self.scopes = scopes; + self + } + + /// Set the OIDC Dynamic Client Registration `application_type` (SEP-837), e.g. `"native"` or `"web"` + pub fn with_application_type(mut self, application_type: impl Into) -> Self { + self.application_type = Some(application_type.into()); + self + } +} + +/// Declarative description of the client identity material available for an +/// authorization flow. +/// +/// The [MCP authorization specification](https://modelcontextprotocol.io/specification/2026-07-28/basic/authorization/client-registration) +/// recommends that clients obtain a client ID using the following priority +/// order. [`OAuthState::start_authorization`] and [`AuthorizationSession::new`] +/// apply it internally: +/// +/// 1. Pre-registered client information +/// ([`with_preregistered_client`](Self::with_preregistered_client)), when +/// the client already holds a `client_id` issued out of band +/// 2. Client ID Metadata Documents (SEP-991, +/// [`with_client_metadata_url`](Self::with_client_metadata_url)), when the +/// authorization server advertises `client_id_metadata_document_supported` +/// 3. Dynamic Client Registration as a fallback, when the authorization server +/// advertises a `registration_endpoint` +/// +/// Provide whichever identity material the client has available; the SDK +/// selects the highest-priority mechanism the server supports. +/// +/// ```rust,ignore +/// let request = AuthorizationRequest::new("http://localhost:8080/callback") +/// // Omit `with_scopes` to let the SDK auto-select scopes from server metadata. +/// // Used when the server supports CIMD and no pre-registered client is set. +/// .with_client_metadata_url("https://example.com/client-metadata.json") +/// // used for dynamic client registration as a last resort +/// .with_client_name("My MCP Client"); +/// oauth_state.start_authorization(request).await?; +/// ``` +#[derive(Debug, Clone)] +#[non_exhaustive] +pub struct AuthorizationRequest { + /// Redirect URI for the authorization-code flow. + pub redirect_uri: String, + /// Scopes to request. When empty, the SDK selects scopes from the + /// server's `WWW-Authenticate` challenge, Protected Resource Metadata, + /// or authorization server metadata. + pub scopes: Vec, + /// Human-readable client name, used for Dynamic Client Registration. + pub client_name: Option, + /// Pre-registered client ID obtained from the authorization server out of + /// band. When set, registration is skipped entirely. + pub client_id: Option, + /// Client secret paired with the pre-registered [`client_id`](Self::client_id). + pub client_secret: Option, + /// HTTPS URL of a Client ID Metadata Document (SEP-991). Used when the + /// authorization server advertises `client_id_metadata_document_supported` + /// and no pre-registered client is configured. + pub client_metadata_url: Option, + /// OIDC Dynamic Client Registration `application_type` (SEP-837), + /// e.g. `"native"` or `"web"`. + pub application_type: Option, + /// `WWW-Authenticate` header value from a real request's 401 response. + /// When set, discovery is seeded from the challenge (its + /// `resource_metadata` URL and `scope` hint) instead of probing the + /// server — the reactive discovery path. + pub challenge: Option, +} + +impl AuthorizationRequest { + /// Create a request for the given redirect URI. With no further identity + /// material, authorization falls back to Dynamic Client Registration. + pub fn new(redirect_uri: impl Into) -> Self { + Self { + redirect_uri: redirect_uri.into(), + scopes: Vec::new(), + client_name: None, + client_id: None, + client_secret: None, + client_metadata_url: None, + application_type: None, + challenge: None, + } + } + + /// Set the scopes to request. When not set, the SDK auto-selects scopes + /// using its normal scope-selection policy. + pub fn with_scopes(mut self, scopes: I) -> Self + where + I: IntoIterator, + S: Into, + { + self.scopes = scopes.into_iter().map(Into::into).collect(); + self + } + + /// Set the client name used for Dynamic Client Registration. + pub fn with_client_name(mut self, client_name: impl Into) -> Self { + self.client_name = Some(client_name.into()); + self + } + + /// Use a client ID that was pre-registered with the authorization server + /// out of band. This takes priority over every other mechanism. + /// + /// Pair with [`with_client_secret`](Self::with_client_secret) for + /// confidential clients. + pub fn with_preregistered_client(mut self, client_id: impl Into) -> Self { + self.client_id = Some(client_id.into()); + self + } + + /// Set the client secret paired with a pre-registered client ID. + /// + /// Must be used together with + /// [`with_preregistered_client`](Self::with_preregistered_client); + /// authorization fails with [`AuthError::RegistrationFailed`] if a secret + /// is provided without a client ID. + pub fn with_client_secret(mut self, client_secret: impl Into) -> Self { + self.client_secret = Some(client_secret.into()); + self + } + + /// Set the HTTPS URL of a Client ID Metadata Document (SEP-991). Used when + /// the authorization server advertises support and no pre-registered + /// client is configured. + pub fn with_client_metadata_url(mut self, client_metadata_url: impl Into) -> Self { + self.client_metadata_url = Some(client_metadata_url.into()); + self + } + + /// Set the OIDC Dynamic Client Registration `application_type` (SEP-837), + /// e.g. `"native"` or `"web"`. + pub fn with_application_type(mut self, application_type: impl Into) -> Self { + self.application_type = Some(application_type.into()); + self + } + + /// Seed discovery from the `WWW-Authenticate` header value of a real + /// request's 401 response instead of probing the server. + pub fn with_challenge(mut self, www_authenticate: impl Into) -> Self { + self.challenge = Some(www_authenticate.into()); + self + } +} + +// add type aliases for oauth2 types +type OAuthErrorResponse = oauth2::StandardErrorResponse; + +/// The token response returned by the authorization server after a successful OAuth 2.0 flow. +/// +/// This is a [`StandardTokenResponse`] parameterised with [`VendorExtraTokenFields`], which means +/// it carries both the standard OAuth fields and +/// any vendor-specific fields the server may have included in the JSON response body. +/// +/// # Accessing vendor-specific fields +/// +/// Call [`extra_fields()`][OAuthTokenResponse::extra_fields] to obtain a reference to the +/// [`VendorExtraTokenFields`] wrapper, then index into its inner map. +pub type OAuthTokenResponse = StandardTokenResponse; +type OAuthTokenIntrospection = + oauth2::StandardTokenIntrospectionResponse; +type OAuthRevocableToken = oauth2::StandardRevocableToken; +type OAuthRevocationError = oauth2::StandardErrorResponse; +type OAuthClient = oauth2::Client< + OAuthErrorResponse, + OAuthTokenResponse, + OAuthTokenIntrospection, + OAuthRevocableToken, + OAuthRevocationError, + oauth2::EndpointSet, + oauth2::EndpointNotSet, + oauth2::EndpointNotSet, + oauth2::EndpointNotSet, + oauth2::EndpointSet, +>; +type Credentials = (String, Option); + +/// OAuth 2.0 extension identifier for client credentials flow (SEP-1046) +pub const EXTENSION_OAUTH_CLIENT_CREDENTIALS: &str = + "io.modelcontextprotocol/oauth-client-credentials"; + +/// JWT signing algorithm for private_key_jwt authentication (SEP-1046) +#[cfg(feature = "auth-client-credentials-jwt")] +#[derive(Debug, Clone, Copy)] +#[non_exhaustive] +pub enum JwtSigningAlgorithm { + RS256, + RS384, + RS512, + ES256, + ES384, +} + +#[cfg(feature = "auth-client-credentials-jwt")] +impl JwtSigningAlgorithm { + fn to_jsonwebtoken_algorithm(self) -> jsonwebtoken::Algorithm { + match self { + JwtSigningAlgorithm::RS256 => jsonwebtoken::Algorithm::RS256, + JwtSigningAlgorithm::RS384 => jsonwebtoken::Algorithm::RS384, + JwtSigningAlgorithm::RS512 => jsonwebtoken::Algorithm::RS512, + JwtSigningAlgorithm::ES256 => jsonwebtoken::Algorithm::ES256, + JwtSigningAlgorithm::ES384 => jsonwebtoken::Algorithm::ES384, + } + } + + fn as_str(self) -> &'static str { + match self { + JwtSigningAlgorithm::RS256 => "RS256", + JwtSigningAlgorithm::RS384 => "RS384", + JwtSigningAlgorithm::RS512 => "RS512", + JwtSigningAlgorithm::ES256 => "ES256", + JwtSigningAlgorithm::ES384 => "ES384", + } + } +} + +/// Configuration for OAuth 2.0 Client Credentials flow (SEP-1046) +/// +/// This supports two authentication methods: +/// - `ClientSecret`: credentials sent in the request body +/// - `PrivateKeyJwt`: RFC 7523 signed JWT assertion (requires `auth-client-credentials-jwt` feature) +#[derive(Clone)] +#[non_exhaustive] +pub enum ClientCredentialsConfig { + /// Client secret authentication (credentials in request body) + ClientSecret { + client_id: String, + client_secret: String, + scopes: Vec, + resource: Option, + }, + /// Private key JWT authentication (RFC 7523) + #[cfg(feature = "auth-client-credentials-jwt")] + PrivateKeyJwt { + client_id: String, + signing_key: Vec, + signing_algorithm: JwtSigningAlgorithm, + /// Overrides the authorization server issuer used for the JWT `aud` claim. + token_endpoint_audience: Option, + scopes: Vec, + resource: Option, + }, +} + +impl std::fmt::Debug for ClientCredentialsConfig { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + Self::ClientSecret { + client_id, + scopes, + resource, + .. + } => f + .debug_struct("ClientSecret") + .field("client_id", client_id) + .field("client_secret", &"") + .field("scopes", scopes) + .field("resource", resource) + .finish(), + #[cfg(feature = "auth-client-credentials-jwt")] + Self::PrivateKeyJwt { + client_id, + signing_algorithm, + token_endpoint_audience, + scopes, + resource, + .. + } => f + .debug_struct("PrivateKeyJwt") + .field("client_id", client_id) + .field("signing_key", &"") + .field("signing_algorithm", signing_algorithm) + .field("token_endpoint_audience", token_endpoint_audience) + .field("scopes", scopes) + .field("resource", resource) + .finish(), + } + } +} + +#[cfg(feature = "auth-client-credentials-jwt")] +fn client_authentication_audience<'a>( + metadata: &'a AuthorizationMetadata, + configured_audience: Option<&'a str>, +) -> Result<&'a str, AuthError> { + configured_audience + .or(metadata.issuer.as_deref()) + .ok_or_else(|| { + AuthError::ClientCredentialsError( + "Authorization server metadata is missing the issuer required for private_key_jwt" + .to_string(), + ) + }) +} + +#[cfg(feature = "auth-client-credentials-jwt")] +fn client_authentication_header(algorithm: JwtSigningAlgorithm) -> jsonwebtoken::Header { + let mut header = jsonwebtoken::Header::new(algorithm.to_jsonwebtoken_algorithm()); + header.typ = Some("client-authentication+jwt".to_string()); + header +} + +impl ClientCredentialsConfig { + fn client_id(&self) -> &str { + match self { + ClientCredentialsConfig::ClientSecret { client_id, .. } => client_id, + #[cfg(feature = "auth-client-credentials-jwt")] + ClientCredentialsConfig::PrivateKeyJwt { client_id, .. } => client_id, + } + } + + fn scopes(&self) -> &[String] { + match self { + ClientCredentialsConfig::ClientSecret { scopes, .. } => scopes, + #[cfg(feature = "auth-client-credentials-jwt")] + ClientCredentialsConfig::PrivateKeyJwt { scopes, .. } => scopes, + } + } + + fn resource(&self) -> Option<&str> { + match self { + ClientCredentialsConfig::ClientSecret { resource, .. } => resource.as_deref(), + #[cfg(feature = "auth-client-credentials-jwt")] + ClientCredentialsConfig::PrivateKeyJwt { resource, .. } => resource.as_deref(), + } + } + + fn auth_method(&self) -> &str { + match self { + ClientCredentialsConfig::ClientSecret { .. } => "client_secret_post", + #[cfg(feature = "auth-client-credentials-jwt")] + ClientCredentialsConfig::PrivateKeyJwt { .. } => "private_key_jwt", + } + } +} + +/// Configuration for scope upgrade behavior +#[derive(Debug, Clone)] +#[non_exhaustive] +pub struct ScopeUpgradeConfig { + /// Maximum number of scope upgrade attempts before giving up + pub max_upgrade_attempts: u32, + /// Whether to automatically attempt scope upgrades on 403 + pub auto_upgrade: bool, +} + +impl Default for ScopeUpgradeConfig { + fn default() -> Self { + Self { + max_upgrade_attempts: 3, + auto_upgrade: true, + } + } +} + +/// oauth2 auth manager +pub struct AuthorizationManager { + http_client: Arc, + // Preserve legacy reqwest refresh behavior without weakening custom clients. + refresh_redirect_policy: OAuthHttpRedirectPolicy, + metadata: Option, + oauth_client: Option, + credential_store: Arc, + state_store: Arc, + base_url: Url, + current_scopes: RwLock>, + scope_upgrade_attempts: RwLock, + scope_upgrade_config: ScopeUpgradeConfig, + /// scopes from the initial 401 WWW-Authenticate header, used by select_scopes() + www_auth_scopes: RwLock>, + /// scopes_supported from protected resource metadata (RFC 9728) + resource_scopes: RwLock>, + /// resource indicator from protected resource metadata, used for RFC 8707 `resource` + discovered_resource: RwLock>, + /// OIDC Dynamic Client Registration `application_type` (SEP-837) + application_type: Option, + allow_missing_issuer: bool, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub(crate) struct ClientRegistrationRequest { + pub client_name: String, + pub redirect_uris: Vec, + pub grant_types: Vec, + pub token_endpoint_auth_method: String, + pub response_types: Vec, + #[serde(skip_serializing_if = "Option::is_none")] + pub scope: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub application_type: Option, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +#[non_exhaustive] +pub struct ClientRegistrationResponse { + pub client_id: String, + pub client_secret: Option, + pub client_name: Option, + pub redirect_uris: Vec, + // allow additional fields + #[serde(flatten)] + pub additional_fields: HashMap, +} + +impl ClientRegistrationResponse { + pub fn new(client_id: impl Into, redirect_uris: Vec) -> Self { + Self { + client_id: client_id.into(), + client_secret: None, + client_name: None, + redirect_uris, + additional_fields: HashMap::new(), + } + } +} + +/// SEP-991: URL-based Client IDs +/// Validate that the client_id is a valid URL with https scheme and non-root pathname +fn is_https_url(value: &str) -> bool { + Url::parse(value) + .ok() + .map(|url| url.scheme() == "https" && url.path() != "/" && url.host_str().is_some()) + .unwrap_or(false) +} + +#[cfg(feature = "auth-client-credentials-jwt")] +fn is_allowed_client_credentials_endpoint(resource: &Url, token_endpoint: &Url) -> bool { + token_endpoint.scheme() == "https" + || (token_endpoint.scheme() == "http" + && resource + .host_str() + .is_some_and(AuthorizationManager::is_loopback_metadata_host) + && token_endpoint + .host_str() + .is_some_and(AuthorizationManager::is_loopback_metadata_host)) +} + +impl AuthorizationManager { + fn is_http_url(url: &Url) -> bool { + matches!(url.scheme(), "http" | "https") && url.host_str().is_some() + } + + fn is_same_origin(base: &Url, candidate: &Url) -> bool { + base.scheme() == candidate.scheme() + && base + .host_str() + .zip(candidate.host_str()) + .is_some_and(|(base, candidate)| base.eq_ignore_ascii_case(candidate)) + && base.port_or_known_default() == candidate.port_or_known_default() + } + + fn is_same_origin_resource_metadata_url(base_url: &Url, candidate: &Url) -> bool { + Self::is_http_url(candidate) && Self::is_same_origin(base_url, candidate) + } + + fn is_disallowed_metadata_ipv4(addr: Ipv4Addr) -> bool { + let octets = addr.octets(); + addr.is_private() + || addr.is_loopback() + || addr.is_link_local() + || addr.is_broadcast() + || addr.is_unspecified() + || addr.is_multicast() + || octets[0] == 0 + || (octets[0] == 100 && (64..=127).contains(&octets[1])) + || (octets[0] == 198 && matches!(octets[1], 18 | 19)) + } + + fn is_disallowed_metadata_ipv6(addr: Ipv6Addr) -> bool { + if let Some(mapped) = addr.to_ipv4_mapped() { + return Self::is_disallowed_metadata_ipv4(mapped); + } + + let segments = addr.segments(); + addr.is_loopback() + || addr.is_unspecified() + || addr.is_multicast() + || (segments[0] & 0xffc0) == 0xfe80 + || (segments[0] & 0xfe00) == 0xfc00 + } + + fn is_disallowed_metadata_hostname(host: &str) -> bool { + matches!(host, "localhost") + || host.ends_with(".localhost") + || CLOUD_METADATA_HOSTS.contains(&host) + } + + fn is_disallowed_metadata_host(host: &str) -> bool { + let host = host.trim_end_matches('.').to_ascii_lowercase(); + if Self::is_disallowed_metadata_hostname(&host) { + return true; + } + + match host.parse::() { + Ok(IpAddr::V4(addr)) => Self::is_disallowed_metadata_ipv4(addr), + Ok(IpAddr::V6(addr)) => Self::is_disallowed_metadata_ipv6(addr), + Err(_) => false, + } + } + + fn is_loopback_metadata_host(host: &str) -> bool { + let host = host.trim_end_matches('.').to_ascii_lowercase(); + host == "localhost" + || host.ends_with(".localhost") + || matches!(host.parse::(), Ok(IpAddr::V4(addr)) if addr.is_loopback()) + || matches!(host.parse::(), Ok(IpAddr::V6(addr)) if addr.is_loopback()) + } + + fn is_allowed_authorization_server_metadata_url(base_url: &Url, url: &Url) -> bool { + if !Self::is_http_url(url) { + return false; + } + + let Some(host) = url.host_str() else { + return false; + }; + + if !Self::is_disallowed_metadata_host(host) { + return true; + } + + base_url + .host_str() + .is_some_and(Self::is_loopback_metadata_host) + && Self::is_loopback_metadata_host(host) + } + + fn resolve_resource_metadata_url(value: &str, base_url: &Url) -> Option { + let value = value.trim(); + if value.is_empty() { + debug!("ignoring empty resource_metadata value"); + return None; + } + + let url = match Url::parse(value).or_else(|_| base_url.join(value)) { + Ok(url) => url, + Err(error) => { + debug!("failed to parse resource metadata value `{value}` as URL: {error}"); + return None; + } + }; + + if Self::is_same_origin_resource_metadata_url(base_url, &url) { + Some(url) + } else { + warn!( + "rejecting resource metadata URL `{url}` because it is not same-origin with `{base_url}`" + ); + None + } + } + + fn well_known_paths(base_path: &str, resource: &str) -> Vec { + let trimmed = base_path.trim_start_matches('/').trim_end_matches('/'); + let mut candidates = Vec::new(); + + let mut push_candidate = |candidate: String| { + if !candidates.contains(&candidate) { + candidates.push(candidate); + } + }; + + let canonical = format!("/.well-known/{resource}"); + + if trimmed.is_empty() { + push_candidate(canonical); + return candidates; + } + + // This follows the RFC 8414 recommendation for well-known URI discovery + push_candidate(format!("{canonical}/{trimmed}")); + // This is a common pattern used by some identity providers + push_candidate(format!("/{trimmed}/.well-known/{resource}")); + // The canonical path should always be the last fallback + push_candidate(canonical); + + candidates + } + + /// create new auth manager with base url + pub async fn new(base_url: U) -> Result { + Self::new_inner( + base_url, + Arc::new(default_oauth_http_client()?), + OAuthHttpRedirectPolicy::Stop, + ) + .await + } + + /// Create an auth manager with a client used for every OAuth HTTP operation. + pub async fn new_with_oauth_http_client( + base_url: U, + http_client: Arc, + ) -> Result { + Self::new_inner(base_url, http_client, OAuthHttpRedirectPolicy::Stop).await + } + + async fn new_inner( + base_url: U, + http_client: Arc, + refresh_redirect_policy: OAuthHttpRedirectPolicy, + ) -> Result { + let base_url = base_url.into_url()?; + + let manager = Self { + http_client, + refresh_redirect_policy, + metadata: None, + oauth_client: None, + credential_store: Arc::new(InMemoryCredentialStore::new()), + state_store: Arc::new(InMemoryStateStore::new()), + base_url, + current_scopes: RwLock::new(Vec::new()), + scope_upgrade_attempts: RwLock::new(0), + scope_upgrade_config: ScopeUpgradeConfig::default(), + www_auth_scopes: RwLock::new(Vec::new()), + resource_scopes: RwLock::new(Vec::new()), + discovered_resource: RwLock::new(None), + application_type: Some(DEFAULT_APPLICATION_TYPE.to_string()), + allow_missing_issuer: false, + }; + + Ok(manager) + } + + /// Set the scope upgrade configuration + pub fn set_scope_upgrade_config(&mut self, config: ScopeUpgradeConfig) { + self.scope_upgrade_config = config; + } + + /// Configure whether authorization server metadata discovery tolerates a + /// missing `issuer` field. + /// + /// The default is `false`, enforcing the RFC 8414/OIDC requirement that + /// discovered metadata include `issuer` whenever the expected issuer can be + /// derived from the discovery URL. Set this to `true` only for compatibility + /// with authorization servers that return incomplete metadata. + pub fn set_allow_missing_issuer(&mut self, allow: bool) { + self.allow_missing_issuer = allow; + } + + /// Set a custom credential store + /// + /// This allows you to provide your own implementation of credential storage, + /// such as file-based storage, keychain integration, or database storage. + /// This should be called before any operations that need credentials. + pub fn set_credential_store(&mut self, store: S) { + self.credential_store = Arc::new(store); + } + + /// Set a custom state store for OAuth2 authorization flow state + /// + /// This should be called before initiating the authorization flow. + pub fn set_state_store(&mut self, store: S) { + self.state_store = Arc::new(store); + } + + /// Set OAuth2 authorization metadata + /// + /// This should be called with + /// [`AuthorizationMetadataResolution::metadata`] after + /// [`Self::resolve_metadata`] and before creating an + /// [`AuthorizationSession`]. + pub fn set_metadata(&mut self, metadata: AuthorizationMetadata) { + self.metadata = Some(metadata); + } + + /// Initialize from stored credentials if available + /// + /// This will load credentials from the credential store and configure + /// the client if credentials are found. Returns `false` when credentials + /// are absent or discarded after an authorization-server change. + pub async fn initialize_from_store(&mut self) -> Result { + if let Some(stored) = self.credential_store.load().await? + && stored.token_response.is_some() + { + if self.metadata.is_none() { + let resolution = self.resolve_metadata().await?; + self.metadata = Some(resolution.metadata); + } + + if let (Some(stored_issuer), Some(current_issuer)) = + (stored.issuer.as_deref(), self.metadata_issuer().as_deref()) + { + // A CIMD client ID is the client's metadata URL, so it is + // portable across authorization servers and exempt here. + if stored_issuer != current_issuer { + if is_https_url(&stored.client_id) { + // A CIMD client ID is the client's metadata URL, so it is + // portable across authorization servers — but the tokens + // were minted by the previous AS and must not be reused. + tracing::warn!( + stored_issuer, + current_issuer, + "authorization server issuer changed; discarding tokens but keeping portable CIMD client ID" + ); + self.credential_store + .save( + StoredCredentials::new( + stored.client_id.clone(), + None, + vec![], + None, + ) + .with_issuer(self.metadata_issuer()), + ) + .await?; + self.configure_client_id(&stored.client_id)?; + return Ok(false); + } + + tracing::warn!( + stored_issuer, + current_issuer, + "authorization server issuer changed; clearing stored credentials bound to the previous issuer" + ); + self.credential_store.clear().await?; + return Ok(false); + } + } + + self.configure_client_id(&stored.client_id)?; + return Ok(true); + } + Ok(false) + } + + /// Use a caller-configured `reqwest::Client` for every OAuth HTTP operation, + /// preserving all of its settings (proxy, TLS, timeout, default headers). + /// + /// The same client is reused for all requests, so its own redirect policy applies + /// and [`OAuthHttpRedirectPolicy::Stop`] is not enforced for token operations. + /// Callers needing strict no-redirect handling should pass a custom + /// [`OAuthHttpClient`] to [`AuthorizationManager::new_with_oauth_http_client`]. + pub fn with_client(&mut self, http_client: ReqwestClient) -> Result<(), AuthError> { + // One client for both modes: a built reqwest::Client can't be rebuilt as a + // no-redirect variant without dropping the caller's configuration. + self.http_client = Arc::new(ReqwestOAuthHttpClient { + follow_redirects: http_client.clone(), + stop_redirects: http_client, + }); + self.refresh_redirect_policy = OAuthHttpRedirectPolicy::Follow; + Ok(()) + } + + /// Resolve OAuth 2.0 metadata and report how it was obtained. + /// + /// Discovery follows SEP-985: protected resource metadata first, then + /// direct OAuth 2.0 Authorization Server Metadata or OpenID Connect + /// Discovery. When discovery finds nothing, the result contains legacy + /// default endpoints derived from the base URL and + /// [`AuthorizationMetadataSource::LegacyEndpointFallback`]. + /// + /// # Examples + /// + /// ```no_run + /// use rmcp::transport::auth::{AuthorizationManager, AuthorizationMetadataSource}; + /// + /// # async fn resolve() -> Result<(), Box> { + /// let mut manager = AuthorizationManager::new("https://mcp.example.com").await?; + /// let resolution = manager.resolve_metadata().await?; + /// + /// if resolution.source == AuthorizationMetadataSource::LegacyEndpointFallback { + /// println!("the server did not publish OAuth metadata"); + /// } + /// + /// manager.set_metadata(resolution.metadata); + /// # Ok(()) + /// # } + /// ``` + pub async fn resolve_metadata(&self) -> Result { + if let Some(metadata) = self.discover_oauth_server_via_resource_metadata().await? { + return Ok(AuthorizationMetadataResolution { + metadata, + source: AuthorizationMetadataSource::ProtectedResourceMetadata, + }); + } + + if let Some(metadata) = self.try_discover_oauth_server(&self.base_url, None).await? { + return Ok(AuthorizationMetadataResolution { + metadata, + source: AuthorizationMetadataSource::AuthorizationServerMetadata, + }); + } + + debug!("falling back to legacy OAuth endpoints derived from the base URL"); + Ok(AuthorizationMetadataResolution { + metadata: Self::legacy_authorization_metadata(&self.base_url), + source: AuthorizationMetadataSource::LegacyEndpointFallback, + }) + } + + /// Resolve authorization server metadata starting from the + /// `WWW-Authenticate` challenge of a real request's 401 response — the + /// reactive discovery path, matching the TypeScript and Python SDKs. + /// + /// Seeds scope selection with the challenge's `scope` hint and prefers + /// the challenge's `resource_metadata` URL; falls back to + /// [`resolve_metadata`](Self::resolve_metadata) when the challenge is + /// `None` or carries no usable metadata pointer. + pub async fn resolve_metadata_from_challenge( + &self, + www_authenticate: Option<&str>, + ) -> Result { + let Some(www_authenticate) = www_authenticate else { + return self.resolve_metadata().await; + }; + let params = WWWAuthenticateParams::parse(www_authenticate, &self.base_url); + + self.record_challenge_scope(¶ms).await; + + if let Some(resource_metadata_url) = ¶ms.resource_metadata_url + && let Some(metadata) = self + .discover_oauth_server_from_resource_metadata_url(resource_metadata_url) + .await? + { + return Ok(AuthorizationMetadataResolution { + metadata, + source: AuthorizationMetadataSource::ProtectedResourceMetadata, + }); + } + + self.resolve_metadata().await + } + + /// Store a challenge's `scope` hint for later scope selection. + async fn record_challenge_scope(&self, params: &WWWAuthenticateParams) { + let Some(scope) = ¶ms.scope else { + return; + }; + let scopes: Vec = scope.split_whitespace().map(str::to_string).collect(); + if scopes.is_empty() { + return; + } + debug!("WWW-Authenticate challenge contains scope: {scope}"); + *self.www_auth_scopes.write().await = scopes; + } + + fn legacy_authorization_metadata(base_url: &Url) -> AuthorizationMetadata { + let endpoint = |path: &str| { + let mut url = base_url.clone(); + url.set_query(None); + url.set_fragment(None); + url.set_path(path); + url.to_string() + }; + + AuthorizationMetadata { + authorization_endpoint: endpoint("/authorize"), + token_endpoint: endpoint("/token"), + registration_endpoint: Some(endpoint("/register")), + ..Default::default() + } + } + + /// get client id and credentials + pub async fn get_credentials(&self) -> Result { + let client_id = self + .oauth_client + .as_ref() + .ok_or_else(|| AuthError::InternalError("OAuth client not configured".to_string()))? + .client_id(); + + let stored = self.credential_store.load().await?; + let token_response = stored.and_then(|s| s.token_response); + + Ok((client_id.to_string(), token_response)) + } + + /// configure oauth2 client with client credentials + pub fn configure_client(&mut self, config: OAuthClientConfig) -> Result<(), AuthError> { + if self.metadata.is_none() { + return Err(AuthError::NoAuthorizationSupport); + } + + // SEP-837: only override application_type when the config sets one + if let Some(application_type) = &config.application_type { + self.application_type = Some(application_type.clone()); + } + + let metadata = self.metadata.as_ref().unwrap(); + + let auth_url = AuthUrl::new(metadata.authorization_endpoint.clone()) + .map_err(|e| AuthError::OAuthError(format!("Invalid authorization URL: {}", e)))?; + + let token_url = TokenUrl::new(metadata.token_endpoint.clone()) + .map_err(|e| AuthError::OAuthError(format!("Invalid token URL: {}", e)))?; + + let client_id = ClientId::new(config.client_id); + let redirect_url = RedirectUrl::new(config.redirect_uri.clone()) + .map_err(|e| AuthError::OAuthError(format!("Invalid re URL: {}", e)))?; + + let mut client_builder: OAuthClient = oauth2::Client::new(client_id.clone()) + .set_auth_uri(auth_url) + .set_token_uri(token_url) + .set_redirect_uri(redirect_url); + + if let Some(secret) = config.client_secret { + client_builder = client_builder.set_client_secret(ClientSecret::new(secret)); + } + + let uses_secret_post = metadata + .additional_fields + .get("token_endpoint_auth_methods_supported") + .and_then(|v| v.as_array()) + .map(|arr| { + let has_basic = arr + .iter() + .any(|m| m.as_str() == Some("client_secret_basic")); + let has_post = arr.iter().any(|m| m.as_str() == Some("client_secret_post")); + has_post && !has_basic + }) + .unwrap_or(false); + + if uses_secret_post { + client_builder = client_builder.set_auth_type(AuthType::RequestBody); + } + + self.oauth_client = Some(client_builder); + Ok(()) + } + /// validate authorization server metadata before starting authorization. + fn validate_server_metadata(&self, response_type: &str) -> Result<(), AuthError> { + let Some(metadata) = self.metadata.as_ref() else { + return Ok(()); + }; + + // RFC 8414 RECOMMENDS response_types_supported in the metadata. This field is optional, + // but if present and does not include the flow we use ("code"), bail out early with a clear error. + if let Some(response_types_supported) = metadata.response_types_supported.as_ref() + && !response_types_supported.contains(&response_type.to_string()) + { + return Err(AuthError::InvalidScope(response_type.to_string())); + } + + // The client always sends an S256 challenge. A server that advertises + // methods without S256 can't do the flow we require, so refuse it. A + // server that omits the field is tolerated: it usually means the server + // didn't advertise PKCE, not that it lacks S256. + match &metadata.code_challenge_methods_supported { + Some(methods) if !methods.iter().any(|m| m == "S256") => { + return Err(AuthError::PkceUnsupported); + } + None => { + warn!( + "authorization server metadata omits code_challenge_methods_supported; \ + proceeding with an S256 challenge anyway" + ); + } + Some(_) => {} + } + + Ok(()) + } + /// dynamic register oauth2 client + pub async fn register_client( + &mut self, + name: &str, + redirect_uri: &str, + scopes: &[&str], + ) -> Result { + if self.metadata.is_none() { + return Err(AuthError::NoAuthorizationSupport); + } + + let metadata = self.metadata.as_ref().unwrap(); + let Some(registration_url) = metadata.registration_endpoint.as_ref() else { + return Err(AuthError::RegistrationFailed( + "Dynamic client registration not supported".to_string(), + )); + }; + self.validate_server_metadata("code")?; + + let application_type = self.application_type.clone(); + let registration_request = ClientRegistrationRequest { + client_name: name.to_string(), + redirect_uris: vec![redirect_uri.to_string()], + grant_types: vec![ + "authorization_code".to_string(), + "refresh_token".to_string(), + ], + token_endpoint_auth_method: "none".to_string(), // public client + response_types: vec!["code".to_string()], + scope: if scopes.is_empty() { + None + } else { + Some(scopes.join(" ")) + }, + application_type: application_type.clone(), + }; + + let request = oauth2::http::Request::builder() + .method("POST") + .uri(registration_url) + .header(CONTENT_TYPE, "application/json") + .body( + serde_json::to_vec(®istration_request) + .map_err(|error| AuthError::RegistrationFailed(error.to_string()))?, + ) + .map_err(|error| AuthError::RegistrationFailed(error.to_string()))?; + let response = match self + .http_client + .execute(OAuthHttpRequest::new( + request, + OAuthHttpRedirectPolicy::Follow, + )) + .await + { + Ok(response) => response, + Err(e) => { + return Err(AuthError::RegistrationFailed(format!( + "HTTP request error: {}", + e + ))); + } + }; + + if !response.status().is_success() { + let status = response.status(); + let error_text = String::from_utf8_lossy(response.body()); + + return Err(AuthError::RegistrationFailed(format!( + "HTTP {}: {}", + status, error_text + ))); + } + + debug!("registration response status: {:?}", response.status()); + let reg_response = + match serde_json::from_slice::(response.body()) { + Ok(response) => response, + Err(e) => { + return Err(AuthError::RegistrationFailed(format!( + "analyze response error: {}", + e + ))); + } + }; + + let config = OAuthClientConfig { + client_id: reg_response.client_id, + // Some IdP returns a response where the field 'client_secret' is present but with empty string value. + // In that case, the interpretation is that the client is a public client and does not have a secret during the + // registration phase here, e.g. dynamic client registrations. + // + // Even though whether or not the empty string is valid is outside of the scope of Oauth2 spec, + // we should treat it as no secret since otherwise we end up authenticating with a valid client_id with an empty client_secret + // as a password, which is not a goal of the client secret. + client_secret: reg_response.client_secret.filter(|s| !s.is_empty()), + redirect_uri: redirect_uri.to_string(), + scopes: scopes.iter().map(|s| s.to_string()).collect(), + application_type, + }; + + self.configure_client(config.clone())?; + Ok(config) + } + + /// use provided client id to configure oauth2 client instead of dynamic registration + /// this is useful when you have a stored client id from previous registration + pub fn configure_client_id(&mut self, client_id: &str) -> Result<(), AuthError> { + let config = OAuthClientConfig { + client_id: client_id.to_string(), + client_secret: None, + scopes: vec![], + redirect_uri: self.base_url.to_string(), + // keep the manager's current application_type + application_type: None, + }; + self.configure_client(config) + } + + /// generate authorization url + pub async fn get_authorization_url(&self, scopes: &[&str]) -> Result { + let oauth_client = self + .oauth_client + .as_ref() + .ok_or_else(|| AuthError::InternalError("OAuth client not configured".to_string()))?; + self.validate_server_metadata("code")?; + + // generate pkce challenge + let (pkce_challenge, pkce_verifier) = PkceCodeChallenge::new_random_sha256(); + + // build authorization request + let mut auth_request = oauth_client + .authorize_url(CsrfToken::new_random) + .set_pkce_challenge(pkce_challenge) + .add_extra_param("resource", self.oauth_resource().await); + + // add request scopes + for scope in scopes { + auth_request = auth_request.add_scope(Scope::new(scope.to_string())); + } + + let (auth_url, csrf_token) = auth_request.url(); + + // store pkce verifier, expected issuer, and the requested scopes for later use via state store + let expected_issuer = self + .metadata + .as_ref() + .and_then(|metadata| metadata.issuer.clone()); + let require_issuer = self + .metadata + .as_ref() + .and_then(|metadata| { + metadata + .additional_fields + .get("authorization_response_iss_parameter_supported") + .and_then(|value| value.as_bool()) + }) + .unwrap_or(false); + let stored_state = StoredAuthorizationState::new_with_expected_issuer( + &pkce_verifier, + &csrf_token, + expected_issuer, + require_issuer, + ) + .with_requested_scopes(scopes.iter().map(|s| s.to_string()).collect()); + self.state_store + .save(csrf_token.secret(), stored_state) + .await?; + + Ok(auth_url.to_string()) + } + + async fn oauth_resource(&self) -> String { + self.discovered_resource + .read() + .await + .clone() + .unwrap_or_else(|| self.base_url.to_string()) + } + + /// get the current granted scopes + pub async fn get_current_scopes(&self) -> Vec { + self.current_scopes.read().await.clone() + } + + /// compute the union of current scopes and required scopes + fn compute_scope_union(current: &[String], required: &str) -> Vec { + let mut scopes = current.to_vec(); + scopes.extend(required.split_whitespace().map(|s| s.to_string())); + Self::dedup_scopes(scopes) + } + + /// deduplicate scopes preserving first-seen order (SEP-2350: stable for testability) + fn dedup_scopes(scopes: Vec) -> Vec { + let mut seen = std::collections::HashSet::new(); + scopes + .into_iter() + .filter(|s| seen.insert(s.clone())) + .collect() + } + + /// resolve the granted scope set from a token response (SEP-2350, RFC 6749 §5.1): an explicit + /// `scope` may narrow the grant; an omitted one means the request was granted in full, so fall + /// back to the requested scopes (or the previously granted set when none were recorded). + fn resolve_granted_scopes( + response_scopes: Option>, + requested_scopes: &[String], + current_scopes: &[String], + ) -> Vec { + match response_scopes { + Some(scopes) => scopes, + None if !requested_scopes.is_empty() => requested_scopes.to_vec(), + None => current_scopes.to_vec(), + } + } + + /// check if a scope upgrade is possible and allowed + pub async fn can_attempt_scope_upgrade(&self) -> bool { + if !self.scope_upgrade_config.auto_upgrade { + return false; + } + let attempts = *self.scope_upgrade_attempts.read().await; + attempts < self.scope_upgrade_config.max_upgrade_attempts + } + + /// select scopes to request from authorization server + pub fn select_scopes( + &self, + www_authenticate_scope: Option<&str>, + default_scopes: &[&str], + ) -> Vec { + let mut scopes = self.select_base_scopes(www_authenticate_scope, default_scopes); + self.add_offline_access_if_supported(&mut scopes); + scopes + } + + /// select scopes following SEP-2350: re-authorization requests the union of the + /// previously requested scopes and the newly challenged scopes. Server-reported + /// scopes (WWW-Authenticate challenge, protected resource metadata) are operational + /// requirements for the current operation, never an exclusive directive, so they + /// accumulate rather than replace. The AS metadata and caller defaults only seed the + /// request when nothing has been requested or challenged yet. + fn select_base_scopes( + &self, + www_authenticate_scope: Option<&str>, + default_scopes: &[&str], + ) -> Vec { + let mut accumulated: Vec = Vec::new(); + + // previously requested scopes + if let Ok(guard) = self.current_scopes.try_read() { + accumulated.extend(guard.iter().cloned()); + } + + // newly challenged scopes for the current operation (RFC 6750 §3.1) + if let Some(scope) = www_authenticate_scope { + accumulated.extend(scope.split_whitespace().map(|s| s.to_string())); + } + if let Ok(guard) = self.www_auth_scopes.try_read() { + accumulated.extend(guard.iter().cloned()); + } + + // scopes required for the current operation per protected resource metadata (RFC 9728) + if let Ok(guard) = self.resource_scopes.try_read() { + accumulated.extend(guard.iter().cloned()); + } + + if !accumulated.is_empty() { + return Self::dedup_scopes(accumulated); + } + + // nothing requested or challenged yet: seed from AS metadata, then caller defaults + if let Some(metadata) = &self.metadata + && let Some(scopes_supported) = &metadata.scopes_supported + && !scopes_supported.is_empty() + { + return scopes_supported.clone(); + } + + default_scopes.iter().map(|s| s.to_string()).collect() + } + + /// SEP-2207: when the AS advertises `offline_access` in `scopes_supported`, append + /// it so OIDC-flavored Authorization Servers will issue refresh tokens. + fn add_offline_access_if_supported(&self, scopes: &mut Vec) { + if scopes.is_empty() || scopes.iter().any(|s| s == "offline_access") { + return; + } + if let Some(metadata) = &self.metadata + && let Some(supported) = &metadata.scopes_supported + && supported.iter().any(|s| s == "offline_access") + { + scopes.push("offline_access".to_string()); + } + } + + /// attempt to upgrade scopes after receiving a 403 insufficient_scope error. + /// returns the authorization URL for re-authorization with upgraded scopes. + pub async fn request_scope_upgrade(&self, required_scope: &str) -> Result { + if !self.scope_upgrade_config.auto_upgrade { + return Err(AuthError::InvalidScope( + "Scope upgrade is disabled".to_string(), + )); + } + + let mut attempts = self.scope_upgrade_attempts.write().await; + if *attempts >= self.scope_upgrade_config.max_upgrade_attempts { + return Err(AuthError::InvalidScope(format!( + "Maximum scope upgrade attempts ({}) exceeded", + self.scope_upgrade_config.max_upgrade_attempts + ))); + } + + *attempts += 1; + drop(attempts); + + let current_scopes = self.current_scopes.read().await.clone(); + let mut upgraded_scopes = Self::compute_scope_union(¤t_scopes, required_scope); + self.add_offline_access_if_supported(&mut upgraded_scopes); + + debug!( + "Requesting scope upgrade: current={:?}, required={}, union={:?}", + current_scopes, required_scope, upgraded_scopes + ); + + let scope_refs: Vec<&str> = upgraded_scopes.iter().map(|s| s.as_str()).collect(); + self.get_authorization_url(&scope_refs).await + } + + /// reset scope upgrade attempt counter + pub async fn reset_scope_upgrade_attempts(&self) { + *self.scope_upgrade_attempts.write().await = 0; + } + + /// get the number of scope upgrade attempts made + pub async fn get_scope_upgrade_attempts(&self) -> u32 { + *self.scope_upgrade_attempts.read().await + } + + fn validate_authorization_response_issuer( + stored_state: &StoredAuthorizationState, + received_issuer: Option<&str>, + ) -> Result<(), AuthError> { + let Some(expected_issuer) = stored_state.expected_issuer.as_deref() else { + if received_issuer.is_some() || stored_state.require_issuer { + return Err(AuthError::AuthorizationFailed( + "Authorization callback issuer cannot be validated because expected issuer was not recorded" + .to_string(), + )); + } + // Without issuer metadata from discovery and without an issuer-bearing + // callback, there is no stable value to bind to. This preserves + // compatibility with older authorization servers. + return Ok(()); + }; + let Some(received_issuer) = received_issuer else { + if stored_state.require_issuer { + return Err(AuthError::AuthorizationServerMissingIssuer { + expected_issuer: expected_issuer.to_string(), + }); + } + // SEP-2468 recommends RFC 9207 `iss`, but tolerate older authorization + // servers that do not advertise support for backwards compatibility. + return Ok(()); + }; + if received_issuer != expected_issuer { + return Err(AuthError::AuthorizationServerMismatch { + expected_issuer: expected_issuer.to_string(), + received_issuer: received_issuer.to_string(), + }); + } + Ok(()) + } + + /// exchange authorization code for access token + pub async fn exchange_code_for_token( + &self, + code: &str, + csrf_token: &str, + ) -> Result { + self.exchange_code_for_token_with_issuer(code, csrf_token, None) + .await + } + + /// exchange authorization code for access token, validating the optional + /// RFC 9207 authorization response issuer (`iss`) when present. + pub async fn exchange_code_for_token_with_issuer( + &self, + code: &str, + csrf_token: &str, + received_issuer: Option<&str>, + ) -> Result { + debug!("start exchange code for token: {:?}", code); + let oauth_client = self + .oauth_client + .as_ref() + .ok_or_else(|| AuthError::InternalError("OAuth client not configured".to_string()))?; + + // Load state from state store using CSRF token as key + let stored_state = + self.state_store.load(csrf_token).await?.ok_or_else(|| { + AuthError::InternalError("Authorization state not found".to_string()) + })?; + + Self::validate_authorization_response_issuer(&stored_state, received_issuer)?; + + // Consume state only after the callback is bound to the expected issuer. + // A callback with the correct state but a forged or missing required `iss` + // must not discard the PKCE verifier needed by the legitimate callback. + self.state_store.delete(csrf_token).await?; + + // capture requested scopes before the state is consumed + let requested_scopes = stored_state.requested_scopes.clone(); + + // Reconstruct the PKCE verifier + let pkce_verifier = stored_state.into_pkce_verifier(); + + debug!("client_id: {:?}", oauth_client.client_id()); + + // exchange token + let token_result = match oauth_client + .exchange_code(AuthorizationCode::new(code.to_string())) + .set_pkce_verifier(pkce_verifier) + .add_extra_param("resource", self.oauth_resource().await) + .request_async(&OAuth2HttpClient { + client: self.http_client.as_ref(), + redirect_policy: OAuthHttpRedirectPolicy::Stop, + }) + .await + { + Ok(token) => token, + Err(RequestTokenError::Parse(_, body)) => { + match serde_json::from_slice::(&body) { + Ok(parsed) => { + warn!( + "token exchange failed to parse completely but included a valid token response. Accepting it." + ); + parsed + } + Err(parse_err) => { + return Err(AuthError::TokenExchangeFailed(parse_err.to_string())); + } + } + } + Err(e) => { + return Err(AuthError::TokenExchangeFailed(e.to_string())); + } + }; + + debug!("exchange token result: {:?}", token_result); + + // SEP-2350: an omitted `scope` means the grant equals the request (RFC 6749 §5.1). + let response_scopes = token_result + .scopes() + .map(|scopes| scopes.iter().map(|s| s.to_string()).collect()); + let granted_scopes = { + let current = self.current_scopes.read().await; + Self::resolve_granted_scopes(response_scopes, &requested_scopes, ¤t) + }; + + *self.current_scopes.write().await = granted_scopes.clone(); + *self.scope_upgrade_attempts.write().await = 0; + + let client_id = oauth_client.client_id().to_string(); + let stored = StoredCredentials { + client_id, + token_response: Some(token_result.clone()), + granted_scopes, + token_received_at: Some(Self::now_epoch_secs()), + issuer: self.metadata_issuer(), + }; + self.credential_store.save(stored).await?; + + Ok(token_result) + } + + fn now_epoch_secs() -> u64 { + SystemTime::now() + .duration_since(UNIX_EPOCH) + .unwrap_or_default() + .as_secs() + } + + fn metadata_issuer(&self) -> Option { + self.metadata.as_ref().and_then(|m| m.issuer.clone()) + } + + /// Proactive refresh buffer: refresh tokens this many seconds before they expire + /// to avoid races between token retrieval and the actual HTTP request. + const REFRESH_BUFFER_SECS: u64 = 30; + + /// Get access token from local credential store. + /// If expired, refresh it automatically when a refresh token is available. + /// When the access token has expired and no refresh token is available, or the + /// authorization server rejects the refresh token, returns + /// [`AuthError::AuthorizationRequired`] so the caller can re-authenticate. + /// Transient refresh failures return [`AuthError::TokenRefreshFailed`] so the + /// caller can retry; other errors are propagated as-is. + pub async fn get_access_token(&self) -> Result { + let stored = self.credential_store.load().await?; + let Some(stored_creds) = stored else { + return Err(AuthError::AuthorizationRequired); + }; + let Some(creds) = stored_creds.token_response.as_ref() else { + return Err(AuthError::AuthorizationRequired); + }; + + if let (Some(expires_in), Some(received_at)) = + (creds.expires_in(), stored_creds.token_received_at) + { + let elapsed = Self::now_epoch_secs().saturating_sub(received_at); + let remaining = expires_in.as_secs().saturating_sub(elapsed); + + if remaining < Self::REFRESH_BUFFER_SECS { + tracing::info!( + remaining_secs = remaining, + "Access token expired or nearly expired, refreshing." + ); + return self.try_refresh_or_reauth().await; + } + } + + // When expiry info is unavailable (e.g., credentials stored before + // token_received_at was tracked), skip the expiry check and return + // the token as-is. + Ok(creds.access_token().secret().to_string()) + } + + /// Attempt to refresh the token. If refresh fails because there is no + /// refresh token or the server rejected it, return `AuthorizationRequired` + /// so the caller can re-prompt the user. Infrastructure errors (e.g. store + /// I/O failures, misconfigured client) are propagated as-is. + pub(crate) async fn try_refresh_or_reauth(&self) -> Result { + match self.refresh_token().await { + Ok(new_creds) => { + tracing::info!("Refreshed access token."); + Ok(new_creds.access_token().secret().to_string()) + } + Err(e @ (AuthError::AuthorizationRequired | AuthError::TokenRefreshRejected(_))) => { + tracing::warn!(error = %e, "Token refresh not possible, re-authorization required."); + Err(AuthError::AuthorizationRequired) + } + Err(e) => Err(e), + } + } + + /// refresh access token + pub async fn refresh_token(&self) -> Result { + let oauth_client = self + .oauth_client + .as_ref() + .ok_or_else(|| AuthError::InternalError("OAuth client not configured".to_string()))?; + + // Held for the rest of this function so the load, the exchange, and the + // save stay inside one guarded section. + let _refresh_guard = self.credential_store.acquire_refresh_guard().await?; + let stored = self.credential_store.load().await?; + let stored_credentials = stored.ok_or(AuthError::AuthorizationRequired)?; + // Refreshing with another client's stored token would put that token on a + // request authenticated as this client. + if stored_credentials.client_id != oauth_client.client_id().as_str() { + tracing::warn!( + stored_client_id = stored_credentials.client_id.as_str(), + configured_client_id = oauth_client.client_id().as_str(), + "stored credentials belong to a different client; reauthorization required" + ); + return Err(AuthError::AuthorizationRequired); + } + let current_credentials = stored_credentials + .token_response + .ok_or(AuthError::AuthorizationRequired)?; + + let refresh_token = current_credentials + .refresh_token() + .ok_or(AuthError::AuthorizationRequired)?; + debug!("refresh token present, attempting refresh"); + + let refresh_token_value = RefreshToken::new(refresh_token.secret().to_string()); + let mut refresh_request = oauth_client + .exchange_refresh_token(&refresh_token_value) + // RFC 8707: the resource indicator is required on token requests, including refreshes + .add_extra_param("resource", self.oauth_resource().await); + let mut refresh_scopes = stored_credentials.granted_scopes; + self.add_offline_access_if_supported(&mut refresh_scopes); + let requested_scopes = refresh_scopes.clone(); + for scope in refresh_scopes { + refresh_request = refresh_request.add_scope(Scope::new(scope)); + } + let mut token_result = refresh_request + .request_async(&OAuth2HttpClient { + client: self.http_client.as_ref(), + redirect_policy: self.refresh_redirect_policy, + }) + .await + .map_err(|error| match &error { + RequestTokenError::ServerResponse(response) + if response.error() == &BasicErrorResponseType::InvalidGrant => + { + AuthError::TokenRefreshRejected(error.to_string()) + } + _ => AuthError::TokenRefreshFailed(error.to_string()), + })?; + + // RFC 6749 section 6: issuing a new refresh token on refresh is optional. + // When the response omits one, keep the existing refresh token rather than + // dropping it. When a new one is present, the response value is used as-is. + if token_result.refresh_token().is_none() { + token_result.set_refresh_token(Some(refresh_token_value)); + } + + let response_scopes = token_result + .scopes() + .map(|scopes| scopes.iter().map(|s| s.to_string()).collect()); + let granted_scopes = { + let current = self.current_scopes.read().await; + Self::resolve_granted_scopes(response_scopes, &requested_scopes, ¤t) + }; + + *self.current_scopes.write().await = granted_scopes.clone(); + + let client_id = oauth_client.client_id().to_string(); + let stored = StoredCredentials { + client_id, + token_response: Some(token_result.clone()), + granted_scopes, + token_received_at: Some(Self::now_epoch_secs()), + issuer: self.metadata_issuer(), + }; + self.credential_store.save(stored).await?; + + Ok(token_result) + } + + /// prepare request, add authorization header + pub async fn prepare_request( + &self, + request: reqwest::RequestBuilder, + ) -> Result { + let token = self.get_access_token().await?; + Ok(request.header(AUTHORIZATION, format!("Bearer {}", token))) + } + + /// handle response, check if need to re-authorize or scope upgrade + pub async fn handle_response( + &self, + response: reqwest::Response, + ) -> Result { + if response.status() == StatusCode::UNAUTHORIZED { + return Err(AuthError::AuthorizationRequired); + } + if response.status() == StatusCode::FORBIDDEN { + for value in response.headers().get_all(WWW_AUTHENTICATE).iter() { + let Ok(value_str) = value.to_str() else { + continue; + }; + let params = Self::extract_www_authenticate_params(value_str, &self.base_url); + if params.is_insufficient_scope() { + let required_scope = params.scope.unwrap_or_default(); + return Err(AuthError::InsufficientScope { + required_scope, + upgrade_url: None, + }); + } + } + return Err(AuthError::AuthorizationFailed("Forbidden".to_string())); + } + Ok(response) + } + + /// Generate discovery endpoint URLs following the priority order in spec-2025-11-25 4.3 "Authorization Server Metadata Discovery". + fn generate_discovery_urls(base_url: &Url) -> Vec { + let mut candidates = Vec::new(); + let path = base_url.path(); + let trimmed = path.trim_start_matches('/').trim_end_matches('/'); + let mut push_candidate = |discovery_path: String| { + let mut discovery_url = base_url.clone(); + discovery_url.set_query(None); + discovery_url.set_fragment(None); + discovery_url.set_path(&discovery_path); + candidates.push(discovery_url); + }; + if trimmed.is_empty() { + // No path components: try OAuth first, then OpenID Connect + push_candidate("/.well-known/oauth-authorization-server".to_string()); + push_candidate("/.well-known/openid-configuration".to_string()); + } else { + // Path components present: prefer OAuth discovery before OpenID Connect fallbacks. + // 1. OAuth 2.0 with path insertion + push_candidate(format!("/.well-known/oauth-authorization-server/{trimmed}")); + // 2. OpenID Connect with path insertion + push_candidate(format!("/.well-known/openid-configuration/{trimmed}")); + // 3. OpenID Connect with path appending + push_candidate(format!("/{trimmed}/.well-known/openid-configuration")); + // 4. Canonical OAuth fallback (without path suffix) + push_candidate("/.well-known/oauth-authorization-server".to_string()); + } + + candidates + } + + async fn try_discover_oauth_server( + &self, + base_url: &Url, + expected_issuer: Option<&str>, + ) -> Result, AuthError> { + for discovery_url in Self::generate_discovery_urls(base_url) { + if let Some(metadata) = self + .fetch_authorization_metadata(&discovery_url, expected_issuer) + .await? + { + return Ok(Some(metadata)); + } + } + Ok(None) + } + + async fn fetch_authorization_metadata( + &self, + discovery_url: &Url, + expected_issuer: Option<&str>, + ) -> Result, AuthError> { + debug!("discovery url: {:?}", discovery_url); + let response = self + .discovery_get(discovery_url) + .await + .map_err(|error| Self::discovery_failed(discovery_url, error))?; + + if response.status() != StatusCode::OK { + debug!("discovery returned non-200: {}", response.status()); + return Ok(None); + } + + match serde_json::from_slice::(response.body()) { + Ok(metadata) => { + self.validate_authorization_metadata_issuer( + discovery_url, + expected_issuer, + &metadata, + )?; + Ok(Some(metadata)) + } + Err(err) => { + debug!("Failed to parse metadata for {}: {}", discovery_url, err); + Ok(None) // malformed JSON ⇒ try next candidate + } + } + } + + fn expected_issuer_for_authorization_metadata_url(discovery_url: &Url) -> Option { + let path = discovery_url.path(); + let oauth_prefix = "/.well-known/oauth-authorization-server"; + let oidc_prefix = "/.well-known/openid-configuration"; + + let issuer_path = if path == oauth_prefix || path == oidc_prefix { + "" + } else if let Some(suffix) = path.strip_prefix(&format!("{oauth_prefix}/")) { + // RFC 8414 path-insertion form + suffix + } else if let Some(suffix) = path.strip_prefix(&format!("{oidc_prefix}/")) { + // MCP-required OpenID Connect path-insertion compatibility form + suffix + } else if let Some(prefix) = path.strip_suffix(oidc_prefix) { + // OpenID Connect path-appended form + prefix.trim_start_matches('/') + } else { + return None; + }; + + let mut issuer = discovery_url.clone(); + issuer.set_query(None); + issuer.set_fragment(None); + if issuer_path.is_empty() { + issuer.set_path(""); + } else { + issuer.set_path(&format!("/{issuer_path}")); + } + Some(issuer.to_string()) + } + + fn issuer_identifiers_match(received_issuer: &str, expected_issuer: &str) -> bool { + if received_issuer == expected_issuer { + return true; + } + + let trim_root_slash = |issuer: &str| -> String { + issuer + .strip_suffix('/') + .filter(|without_slash| { + Url::parse(without_slash) + .map(|url| url.path().is_empty() || url.path() == "/") + .unwrap_or(false) + }) + .unwrap_or(issuer) + .to_string() + }; + + trim_root_slash(received_issuer) == trim_root_slash(expected_issuer) + } + + fn validate_authorization_metadata_issuer( + &self, + discovery_url: &Url, + expected_issuer: Option<&str>, + metadata: &AuthorizationMetadata, + ) -> Result<(), AuthError> { + let expected_issuer = expected_issuer + .map(str::to_owned) + .or_else(|| Self::expected_issuer_for_authorization_metadata_url(discovery_url)); + let Some(expected_issuer) = expected_issuer else { + return Ok(()); + }; + let Some(received_issuer) = metadata.issuer.as_deref() else { + if self.allow_missing_issuer { + return Ok(()); + } + return Err(AuthError::AuthorizationServerMissingIssuer { expected_issuer }); + }; + if !Self::issuer_identifiers_match(received_issuer, &expected_issuer) { + return Err(AuthError::AuthorizationServerMismatch { + expected_issuer, + received_issuer: received_issuer.to_string(), + }); + } + Ok(()) + } + + async fn discover_oauth_server_via_resource_metadata( + &self, + ) -> Result, AuthError> { + let Some((resource_metadata_url, resource_metadata)) = + self.discover_resource_metadata().await? + else { + return Ok(None); + }; + self.authorization_metadata_from_resource_metadata( + &resource_metadata_url, + resource_metadata, + ) + .await + } + + /// Read protected resource metadata from the url a `WWW-Authenticate` + /// challenge advertised. + async fn discover_oauth_server_from_resource_metadata_url( + &self, + resource_metadata_url: &Url, + ) -> Result, AuthError> { + let Some(resource_metadata) = self + .fetch_resource_metadata_from_url( + resource_metadata_url, + ResourceMetadataUrlOrigin::Advertised, + ) + .await? + else { + return Ok(None); + }; + + self.authorization_metadata_from_resource_metadata(resource_metadata_url, resource_metadata) + .await + } + + /// Walk the authorization servers a protected resource metadata document + /// names, keeping the first one that answers with usable metadata. A document + /// that names servers and none of them answers is an error, not a reason to + /// go looking elsewhere; a document that names none returns `Ok(None)`. + /// + /// The document arrives here through `read_resource_metadata`, which is where + /// it is decided to be this resource's metadata at all. + async fn authorization_metadata_from_resource_metadata( + &self, + resource_metadata_url: &Url, + resource_metadata: ResourceServerMetadata, + ) -> Result, AuthError> { + self.discovered_resource + .write() + .await + .replace(resource_metadata.resource.clone().unwrap_or_default()); + + // store scopes_supported from protected resource metadata for select_scopes() + if let Some(scopes) = resource_metadata.scopes_supported + && !scopes.is_empty() + { + *self.resource_scopes.write().await = scopes; + } + + // A server naming the same authorization server in both the singular draft + // field and the list would otherwise have each of that server's well-known + // forms requested twice. + let mut candidates: Vec = Vec::new(); + let mut push_candidate = |candidate: String| { + let candidate = candidate.trim(); + if !candidate.is_empty() && !candidates.iter().any(|kept| kept == candidate) { + candidates.push(candidate.to_string()); + } + }; + + if let Some(single) = resource_metadata.authorization_server { + push_candidate(single); + } + for candidate in resource_metadata.authorization_servers.unwrap_or_default() { + push_candidate(candidate); + } + + if candidates.is_empty() { + debug!( + "protected resource metadata at {resource_metadata_url} names no authorization server" + ); + return Ok(None); + } + + for candidate in &candidates { + let candidate_url = match Url::parse(candidate) { + Ok(url) => url, + Err(_) => match resource_metadata_url.join(candidate) { + Ok(url) => url, + Err(e) => { + debug!("Failed to resolve authorization server URL `{candidate}`: {e}"); + continue; + } + }, + }; + + if !Self::is_allowed_authorization_server_metadata_url(&self.base_url, &candidate_url) { + warn!("rejecting authorization server metadata URL `{candidate_url}`"); + continue; + } + + if candidate_url.path().contains("/.well-known/") { + if let Some(metadata) = self + .fetch_authorization_metadata(&candidate_url, None) + .await? + { + return Ok(Some(metadata)); + } + continue; + } + + // Discovery URL construction removes a non-root trailing slash. Keep the issuer + // advertised by protected resource metadata for the exact RFC 8414 comparison. + if let Some(metadata) = self + .try_discover_oauth_server(&candidate_url, Some(candidate_url.as_str())) + .await? + { + return Ok(Some(metadata)); + } + } + + // Falling back to the base url would send the user somewhere the resource + // never named. + Err(AuthError::MetadataError(format!( + "protected resource metadata at {resource_metadata_url} names authorization servers {}, but none published usable metadata", + candidates.join(", ") + ))) + } + + fn validate_resource_metadata_resource( + &self, + metadata: &ResourceServerMetadata, + ) -> Result<(), AuthError> { + let Some(resource) = metadata.resource.as_deref() else { + return Err(AuthError::MetadataError( + "Protected resource metadata missing required resource field".to_string(), + )); + }; + + let Ok(resource_url) = Url::parse(resource) else { + return Err(AuthError::MetadataError( + "Protected resource metadata resource field is not a valid URL".to_string(), + )); + }; + + if resource_url.fragment().is_some() { + return Err(AuthError::MetadataError( + "Protected resource metadata resource does not permit fragment in URL as specified by RFC 8707".to_string() + )); + } + + if !Self::is_resource_identifier_valid(&self.base_url, &resource_url) { + return Err(AuthError::MetadataError(format!( + "Protected resource metadata resource mismatch: reference '{}', permitted '{}'", + self.base_url, resource + ))); + } + + Ok(()) + } + + fn is_resource_identifier_valid(expected: &Url, actual: &Url) -> bool { + if expected == actual { + return true; + } + + if expected.scheme() != actual.scheme() + || expected.host_str() != actual.host_str() + || expected.port_or_known_default() != actual.port_or_known_default() + { + return false; + } + + let expected_path = expected.path(); + let actual_path = actual.path(); + + // Query parameters may carry transport hints rather than resource identity. + if expected_path == actual_path { + return true; + } + + expected_path.starts_with(actual_path) + && (actual_path.ends_with('/') + || expected_path.as_bytes().get(actual_path.len()) == Some(&b'/')) + } + + /// Look for the protected resource metadata document, reading it where it is + /// found so that a candidate answering with something else only costs that + /// candidate. + async fn discover_resource_metadata( + &self, + ) -> Result, AuthError> { + // A url the resource points at can also be one of the candidates below. + let mut requested = HashSet::new(); + + if let Some(advertised_url) = self.probe_resource_endpoint_for_challenge().await? { + requested.insert(advertised_url.clone()); + if let Some(metadata) = self + .fetch_resource_metadata_from_url( + &advertised_url, + ResourceMetadataUrlOrigin::Advertised, + ) + .await? + { + return Ok(Some((advertised_url, metadata))); + } + // Nothing was published there. The candidates below are reached from the + // base url rather than from that pointer, so they are still worth trying. + } + + // The other place the document can be is the well-known location. + // https://www.rfc-editor.org/rfc/rfc9728.html#name-obtaining-protected-resourc + for candidate_path in + Self::well_known_paths(self.base_url.path(), "oauth-protected-resource") + { + let mut candidate_url = self.base_url.clone(); + candidate_url.set_query(None); + candidate_url.set_fragment(None); + candidate_url.set_path(&candidate_path); + + if !requested.insert(candidate_url.clone()) { + continue; + } + + let response = self + .discovery_get(&candidate_url) + .await + .map_err(|error| Self::discovery_failed(&candidate_url, error))?; + + match response.status() { + // The candidate url is the document itself, so read the body here + // instead of requesting the same url again. + StatusCode::OK => { + if let Some(metadata) = self.read_resource_metadata( + &candidate_url, + response.body(), + ResourceMetadataUrlOrigin::WellKnownGuess, + )? { + return Ok(Some((candidate_url, metadata))); + } + } + StatusCode::UNAUTHORIZED => { + let Some(pointer_url) = self + .extract_resource_metadata_url_from_www_authenticate(&response) + .await + else { + continue; + }; + if !requested.insert(pointer_url.clone()) { + continue; + } + // Found on a url this run guessed at, so a wrong answer only rules + // out the pointer. + if let Some(metadata) = self + .fetch_resource_metadata_from_url( + &pointer_url, + ResourceMetadataUrlOrigin::WellKnownGuess, + ) + .await? + { + return Ok(Some((pointer_url, metadata))); + } + } + status => debug!("resource metadata probe returned unexpected status: {status}"), + } + } + + Ok(None) + } + + /// Probe the resource itself, looking only for a `WWW-Authenticate` challenge + /// that carries a `resource_metadata` pointer. + /// + /// A 200 here says nothing about metadata. RFC 9728 publishes the document at + /// the well-known URI and advertises it through the challenge parameter, so the + /// resource answering its own GET is not the document and must not end + /// discovery before the well-known candidates are tried. + /// https://www.rfc-editor.org/rfc/rfc9728.html#name-use-of-www-authenticate-for + async fn probe_resource_endpoint_for_challenge(&self) -> Result, AuthError> { + let response = self + .discovery_get(&self.base_url) + .await + .map_err(|error| Self::discovery_failed(&self.base_url, error))?; + + if response.status() == StatusCode::UNAUTHORIZED { + return Ok(self + .extract_resource_metadata_url_from_www_authenticate(&response) + .await); + } + + debug!( + "resource endpoint probe returned {}, no WWW-Authenticate pointer to follow", + response.status() + ); + Ok(None) + } + + async fn extract_resource_metadata_url_from_www_authenticate( + &self, + response: &HttpResponse, + ) -> Option { + let mut parsed_url = None; + for value in response.headers().get_all(WWW_AUTHENTICATE).iter() { + let Ok(value_str) = value.to_str() else { + continue; + }; + let params = Self::extract_www_authenticate_params(value_str, &self.base_url); + if params.resource_metadata_url.is_some() { + self.record_challenge_scope(¶ms).await; + parsed_url = params.resource_metadata_url; + break; + } + } + + parsed_url + } + + async fn fetch_resource_metadata_from_url( + &self, + resource_metadata_url: &Url, + origin: ResourceMetadataUrlOrigin, + ) -> Result, AuthError> { + debug!( + "resource metadata discovery url: {:?}", + resource_metadata_url + ); + let response = self + .discovery_get(resource_metadata_url) + .await + .map_err(|error| Self::discovery_failed(resource_metadata_url, error))?; + + if response.status() != StatusCode::OK { + debug!( + "resource metadata request returned non-200: {}", + response.status() + ); + return Ok(None); + } + + self.read_resource_metadata(resource_metadata_url, response.body(), origin) + } + + /// Read a response body as this resource's protected resource metadata. + /// + /// A body that is not that document rules out the url it came from, and where + /// that url came from decides whether ruling it out leaves anything to try. + fn read_resource_metadata( + &self, + resource_metadata_url: &Url, + body: &[u8], + origin: ResourceMetadataUrlOrigin, + ) -> Result, AuthError> { + let metadata = match serde_json::from_slice::(body) { + Ok(metadata) => metadata, + Err(e) => { + debug!("failed to parse resource metadata as JSON: {}", e); + return Ok(None); + } + }; + + // Every field of `ResourceServerMetadata` is optional, so an unrelated JSON + // object deserializes into an all-`None` value and then fails validation + // fatally. RFC 9728 requires `resource`, and MCP requires an authorization + // server reference, so a document carrying neither is not a protected + // resource metadata document. + if metadata.resource.is_none() + && metadata.authorization_server.is_none() + && metadata.authorization_servers.is_none() + { + return match origin { + // The server named this url, so there is nothing better to move on + // to: the alternatives all drop the resource binding the document + // was supposed to carry. Report it instead. + ResourceMetadataUrlOrigin::Advertised => Err(AuthError::MetadataError(format!( + "the server advertised {resource_metadata_url} as protected resource metadata, but the document carries neither `resource` nor an authorization server reference" + ))), + // Nothing advertised this url, so its answer only rules out this + // candidate. + ResourceMetadataUrlOrigin::WellKnownGuess => { + debug!( + "response at {resource_metadata_url} is not a protected resource metadata document" + ); + Ok(None) + } + }; + } + + // Carrying those fields only makes the body a metadata document; validation + // is what makes it this resource's. Both answers rule out the url the same + // way, so both are read the same way. + if let Err(error) = self.validate_resource_metadata_resource(&metadata) { + return match origin { + ResourceMetadataUrlOrigin::Advertised => Err(error), + ResourceMetadataUrlOrigin::WellKnownGuess => { + debug!( + "document at {resource_metadata_url} is not this resource's metadata: {error}" + ); + Ok(None) + } + }; + } + + Ok(Some(metadata)) + } + + fn discovery_failed(url: &Url, error: OAuthHttpClientError) -> AuthError { + AuthError::MetadataError(format!( + "OAuth metadata discovery failed for {url}\n Caused by: {}", + crate::error::ErrorChain(error.as_ref()) + )) + } + + async fn discovery_request( + &self, + request: OAuthHttpRequest, + ) -> Result { + let response = self.http_client.execute(request).await?; + let status = response.status(); + if status.is_server_error() + || matches!( + status, + StatusCode::REQUEST_TIMEOUT | StatusCode::TOO_EARLY | StatusCode::TOO_MANY_REQUESTS + ) + { + return Err(Box::new(OAuthHttpError::UnexpectedStatus(status))); + } + Ok(response) + } + + async fn discovery_get(&self, url: &Url) -> Result { + let mut current_url = url.clone(); + for _ in 0..MAX_OAUTH_DISCOVERY_REDIRECTS { + let request = oauth2::http::Request::builder() + .method("GET") + .uri(current_url.as_str()) + .header(HEADER_MCP_PROTOCOL_VERSION, "2024-11-05") + .body(Vec::new()) + .map_err(|error| Box::new(error) as OAuthHttpClientError)?; + let response = self + .discovery_request(OAuthHttpRequest::new( + request, + OAuthHttpRedirectPolicy::Stop, + )) + .await?; + + if !response.status().is_redirection() { + return Ok(response); + } + + let Some(location) = response.headers().get(LOCATION) else { + return Ok(response); + }; + let location = location + .to_str() + .map_err(|error| Box::new(error) as OAuthHttpClientError)?; + let next_url = current_url + .join(location) + .map_err(|error| Box::new(error) as OAuthHttpClientError)?; + + if Self::is_http_url(&next_url) && Self::is_same_origin(¤t_url, &next_url) { + current_url = next_url; + continue; + } + + return Err(Box::new(OAuthHttpError::CrossOriginRedirect(next_url))); + } + + Err(Box::new(OAuthHttpError::TooManyRedirects( + MAX_OAUTH_DISCOVERY_REDIRECTS, + ))) + } + + /// extract parameters from WWW-Authenticate header (resource_metadata and scope) + fn extract_www_authenticate_params(header: &str, base_url: &Url) -> WWWAuthenticateParams { + let mut params = WWWAuthenticateParams::default(); + let header_lowercase = header.to_ascii_lowercase(); + + // extract resource_metadata + let mut search_offset = 0; + let resource_key = "resource_metadata="; + while let Some(pos) = header_lowercase[search_offset..].find(resource_key) { + let global_pos = search_offset + pos + resource_key.len(); + let value_slice = &header[global_pos..]; + if let Some((value, consumed)) = Self::parse_next_header_value(value_slice) { + if let Some(url) = Self::resolve_resource_metadata_url(&value, base_url) { + params.resource_metadata_url = Some(url); + break; + } + search_offset = global_pos + consumed; + continue; + } else { + break; + } + } + + // extract scope + let scope_key = "scope="; + if let Some(pos) = header_lowercase.find(scope_key) { + let global_pos = pos + scope_key.len(); + let value_slice = &header[global_pos..]; + if let Some((value, _consumed)) = Self::parse_next_header_value(value_slice) { + params.scope = Some(value); + } + } + + // extract error + let error_key = "error="; + if let Some(pos) = header_lowercase.find(error_key) { + let global_pos = pos + error_key.len(); + let value_slice = &header[global_pos..]; + if let Some((value, _consumed)) = Self::parse_next_header_value(value_slice) { + params.error = Some(value); + } + } + + // extract error_description + let desc_key = "error_description="; + if let Some(pos) = header_lowercase.find(desc_key) { + let global_pos = pos + desc_key.len(); + let value_slice = &header[global_pos..]; + if let Some((value, _consumed)) = Self::parse_next_header_value(value_slice) { + params.error_description = Some(value); + } + } + + params + } + + /// Parses an authentication parameter value from a `WWW-Authenticate` header fragment. + /// The header fragment should start with the header value after the `=` character and then + /// reads until the value ends. + /// + /// Returns the extracted value together with the number of bytes consumed from the provided + /// fragment. Quoted values support escaped characters (e.g. `\"`). The parser skips leading + /// whitespace before reading either a quoted or token value. If no well-formed value is found, + /// `None` is returned. + fn parse_next_header_value(header_fragment: &str) -> Option<(String, usize)> { + let trimmed = header_fragment.trim_start(); + let leading_ws = header_fragment.len() - trimmed.len(); + + if let Some(stripped) = trimmed.strip_prefix('"') { + let mut escaped = false; + let mut result = String::new(); + #[allow(clippy::manual_strip)] + for (idx, ch) in stripped.char_indices() { + if escaped { + result.push(ch); + escaped = false; + continue; + } + match ch { + '\\' => escaped = true, + '"' => return Some((result, leading_ws + idx + 2)), + _ => result.push(ch), + } + } + None + } else { + let end = trimmed + .find(|c: char| c == ',' || c == ';' || c.is_whitespace()) + .unwrap_or(trimmed.len()); + Some((trimmed[..end].to_string(), leading_ws + end)) + } + } + + // -- Client Credentials flow (SEP-1046) -- + + /// Validate that the authorization server metadata supports the requested + /// client credentials authentication method. + /// + /// For `client_secret_post`, checks `token_endpoint_auth_methods_supported`. + /// For `private_key_jwt`, additionally checks `token_endpoint_auth_signing_alg_values_supported`. + /// When the metadata field is absent, the method is permissive (assumes support). + pub fn validate_client_credentials_metadata( + &self, + config: &ClientCredentialsConfig, + ) -> Result<(), AuthError> { + let Some(metadata) = self.metadata.as_ref() else { + return Ok(()); + }; + + if let Some(methods) = metadata + .additional_fields + .get("token_endpoint_auth_methods_supported") + .and_then(|v| v.as_array()) + { + let is_supported = match config { + ClientCredentialsConfig::ClientSecret { .. } => { + // Accept either client_secret_post (request body) or + // client_secret_basic (HTTP Basic) per the MCP auth spec. + methods.iter().any(|m| { + matches!( + m.as_str(), + Some("client_secret_post") | Some("client_secret_basic") + ) + }) + } + #[cfg(feature = "auth-client-credentials-jwt")] + ClientCredentialsConfig::PrivateKeyJwt { .. } => methods + .iter() + .any(|m| m.as_str() == Some("private_key_jwt")), + }; + if !is_supported { + let required_method = config.auth_method(); + let supported: Vec<&str> = methods.iter().filter_map(|m| m.as_str()).collect(); + return Err(AuthError::ClientCredentialsError(format!( + "Authorization server does not support auth method '{}'. Supported: {:?}", + required_method, supported + ))); + } + } + + #[cfg(feature = "auth-client-credentials-jwt")] + if let ClientCredentialsConfig::PrivateKeyJwt { + signing_algorithm, .. + } = config + && let Some(algs) = metadata + .additional_fields + .get("token_endpoint_auth_signing_alg_values_supported") + .and_then(|v| v.as_array()) + { + let alg_str = signing_algorithm.as_str(); + if !algs.iter().any(|a| a.as_str() == Some(alg_str)) { + let supported: Vec<&str> = algs.iter().filter_map(|a| a.as_str()).collect(); + return Err(AuthError::ClientCredentialsError(format!( + "Authorization server does not support signing algorithm '{}'. Supported: {:?}", + alg_str, supported + ))); + } + } + + Ok(()) + } + + /// Configure the OAuth2 client for the client credentials flow. + /// + /// Selects `client_secret_post` (request body) by default. Switches to + /// `client_secret_basic` (HTTP Basic) only when the server advertises that + /// method exclusively. For `PrivateKeyJwt`, no OAuth client state is needed + /// here; the token request is built manually in `exchange_client_credentials_jwt`. + pub fn configure_client_credentials( + &mut self, + config: &ClientCredentialsConfig, + ) -> Result<(), AuthError> { + let metadata = self + .metadata + .as_ref() + .ok_or(AuthError::NoAuthorizationSupport)?; + + let token_url = TokenUrl::new(metadata.token_endpoint.clone()) + .map_err(|e| AuthError::OAuthError(format!("Invalid token URL: {}", e)))?; + + // auth_url is required by the type but won't be used for client credentials + let auth_url = AuthUrl::new(metadata.authorization_endpoint.clone()) + .map_err(|e| AuthError::OAuthError(format!("Invalid authorization URL: {}", e)))?; + + let client_id = ClientId::new(config.client_id().to_string()); + + let mut client_builder: OAuthClient = oauth2::Client::new(client_id) + .set_auth_uri(auth_url) + .set_token_uri(token_url); + + match config { + ClientCredentialsConfig::ClientSecret { client_secret, .. } => { + client_builder = + client_builder.set_client_secret(ClientSecret::new(client_secret.clone())); + // Use client_secret_basic (HTTP Basic) when that is the only method + // the server advertises; fall back to client_secret_post (request body). + let only_basic = metadata + .additional_fields + .get("token_endpoint_auth_methods_supported") + .and_then(|v| v.as_array()) + .map(|arr| { + let (has_basic, has_post) = + arr.iter() + .fold((false, false), |(b, p), m| match m.as_str() { + Some("client_secret_basic") => (true, p), + Some("client_secret_post") => (b, true), + _ => (b, p), + }); + has_basic && !has_post + }) + .unwrap_or_default(); + if !only_basic { + client_builder = client_builder.set_auth_type(AuthType::RequestBody); + } + } + #[cfg(feature = "auth-client-credentials-jwt")] + ClientCredentialsConfig::PrivateKeyJwt { .. } => { + // For JWT, client identity comes from the assertion's `sub` claim. + // The request is built manually in exchange_client_credentials_jwt to + // ensure client_id is not included in the body per RFC 7523 §3. + } + } + + self.oauth_client = Some(client_builder); + Ok(()) + } + + /// Exchange client credentials for an access token (SEP-1046). + /// + /// For `ClientSecret`: sends credentials in the request body (or Authorization header + /// for `client_secret_basic`) with scopes and resource. + /// For `PrivateKeyJwt`: builds the request manually (no `client_id` in body per RFC 7523 §3). + pub async fn exchange_client_credentials( + &self, + config: &ClientCredentialsConfig, + ) -> Result { + // The MCP auth spec requires the `resource` parameter in all token requests. + if config.resource().is_none() { + return Err(AuthError::ClientCredentialsError( + "resource parameter is required by the MCP auth spec".to_string(), + )); + } + + // For private_key_jwt, use a separate path that omits client_id from the request + // body, as required by RFC 7523 §3 (client is identified by the JWT `sub` claim). + #[cfg(feature = "auth-client-credentials-jwt")] + if matches!(config, ClientCredentialsConfig::PrivateKeyJwt { .. }) { + return self.exchange_client_credentials_jwt(config).await; + } + + let oauth_client = self + .oauth_client + .as_ref() + .ok_or_else(|| AuthError::InternalError("OAuth client not configured".to_string()))?; + + let mut request = oauth_client.exchange_client_credentials(); + + for scope in config.scopes() { + request = request.add_scope(Scope::new(scope.clone())); + } + + if let Some(resource) = config.resource() { + request = request.add_extra_param("resource", resource); + } + + let token_result = match request + .request_async(&OAuth2HttpClient { + client: self.http_client.as_ref(), + redirect_policy: OAuthHttpRedirectPolicy::Stop, + }) + .await + { + Ok(token) => token, + Err(RequestTokenError::Parse(_, body)) => { + match serde_json::from_slice::(&body) { + Ok(parsed) => { + warn!( + "client credentials token exchange failed to parse completely but included a valid token response. Accepting it." + ); + parsed + } + Err(parse_err) => { + return Err(AuthError::ClientCredentialsError(format!( + "Token exchange parse error: {}", + parse_err + ))); + } + } + } + Err(e) => { + return Err(AuthError::ClientCredentialsError(format!( + "Token exchange failed: {}", + e + ))); + } + }; + + debug!("client credentials token result: {:?}", token_result); + + let granted_scopes: Vec = token_result + .scopes() + .map(|scopes| scopes.iter().map(|s| s.to_string()).collect()) + .unwrap_or_default(); + + *self.current_scopes.write().await = granted_scopes.clone(); + + let client_id = config.client_id().to_string(); + let stored = StoredCredentials { + client_id, + token_response: Some(token_result.clone()), + granted_scopes, + token_received_at: Some(Self::now_epoch_secs()), + issuer: self.metadata_issuer(), + }; + self.credential_store.save(stored).await?; + + Ok(token_result) + } + + /// Exchange client credentials using a JWT assertion (RFC 7523). + /// + /// Builds the token request manually so that `client_id` is **not** included in the + /// request body; client identity is conveyed solely by the `sub` claim in the assertion. + #[cfg(feature = "auth-client-credentials-jwt")] + async fn exchange_client_credentials_jwt( + &self, + config: &ClientCredentialsConfig, + ) -> Result { + let ClientCredentialsConfig::PrivateKeyJwt { + client_id, + signing_key, + signing_algorithm, + token_endpoint_audience, + scopes, + resource, + } = config + else { + return Err(AuthError::InternalError( + "expected PrivateKeyJwt config".to_string(), + )); + }; + + let metadata = self + .metadata + .as_ref() + .ok_or(AuthError::NoAuthorizationSupport)?; + + let token_endpoint_url = url::Url::parse(&metadata.token_endpoint).map_err(|e| { + AuthError::ClientCredentialsError(format!( + "Invalid token endpoint URL in authorization metadata: {e}" + )) + })?; + if !is_allowed_client_credentials_endpoint(&self.base_url, &token_endpoint_url) { + return Err(AuthError::ClientCredentialsError( + "Insecure token endpoint URL: HTTPS is required for client credentials flow" + .to_string(), + )); + } + + let audience = + client_authentication_audience(metadata, token_endpoint_audience.as_deref())?; + + let assertion = + Self::build_jwt_assertion(client_id, audience, signing_key, *signing_algorithm)?; + + let scope_str = scopes.join(" "); + let mut serializer = url::form_urlencoded::Serializer::new(String::new()); + serializer.append_pair("grant_type", "client_credentials"); + serializer.append_pair( + "client_assertion_type", + "urn:ietf:params:oauth:client-assertion-type:jwt-bearer", + ); + serializer.append_pair("client_assertion", &assertion); + if !scope_str.is_empty() { + serializer.append_pair("scope", &scope_str); + } + if let Some(res) = resource.as_deref() { + serializer.append_pair("resource", res); + } + let body_str = serializer.finish(); + + let request = oauth2::http::Request::builder() + .method("POST") + .uri(token_endpoint_url.as_str()) + .header(CONTENT_TYPE, "application/x-www-form-urlencoded") + .body(body_str.into_bytes()) + .map_err(|error| AuthError::ClientCredentialsError(error.to_string()))?; + let response = self + .http_client + .execute(OAuthHttpRequest::new( + request, + OAuthHttpRedirectPolicy::Stop, + )) + .await + .map_err(|e| { + AuthError::ClientCredentialsError(format!("Token exchange request failed: {e}")) + })?; + + let status = response.status(); + let body = response.body(); + + if !status.is_success() { + let msg = if let Ok(v) = serde_json::from_slice::(body) { + let error = v.get("error").and_then(|e| e.as_str()).unwrap_or("unknown"); + let desc = v + .get("error_description") + .and_then(|d| d.as_str()) + .unwrap_or(""); + format!("Token exchange failed: {error}: {desc}") + } else { + format!("Token exchange failed: HTTP {status}") + }; + return Err(AuthError::ClientCredentialsError(msg)); + } + + let token_result = serde_json::from_slice::(body).map_err(|e| { + AuthError::ClientCredentialsError(format!("Failed to parse token response: {e}")) + })?; + + debug!("client credentials JWT token result: {:?}", token_result); + + let granted_scopes: Vec = token_result + .scopes() + .map(|scopes| scopes.iter().map(|s| s.to_string()).collect()) + .unwrap_or_default(); + + *self.current_scopes.write().await = granted_scopes.clone(); + + let stored = StoredCredentials { + client_id: client_id.clone(), + token_response: Some(token_result.clone()), + granted_scopes, + token_received_at: Some(Self::now_epoch_secs()), + issuer: self.metadata_issuer(), + }; + self.credential_store.save(stored).await?; + + Ok(token_result) + } + + /// Build a JWT assertion per RFC 7523 for private_key_jwt authentication. + #[cfg(feature = "auth-client-credentials-jwt")] + fn build_jwt_assertion( + client_id: &str, + audience: &str, + signing_key: &[u8], + algorithm: JwtSigningAlgorithm, + ) -> Result { + use serde_json::json; + + let now = SystemTime::now() + .duration_since(UNIX_EPOCH) + .unwrap_or_default() + .as_secs(); + + let jti = uuid::Uuid::new_v4().to_string(); + + let claims = json!({ + "iss": client_id, + "sub": client_id, + "aud": audience, + "iat": now, + "exp": now + 300, // 5 minutes + "jti": jti, + }); + + let header = client_authentication_header(algorithm); + let encoding_key = jsonwebtoken::EncodingKey::from_rsa_pem(signing_key).or_else(|_| { + jsonwebtoken::EncodingKey::from_ec_pem(signing_key).map_err(|e| { + AuthError::JwtSigningError(format!("Failed to parse signing key: {}", e)) + }) + })?; + + jsonwebtoken::encode(&header, &claims, &encoding_key) + .map_err(|e| AuthError::JwtSigningError(format!("Failed to sign JWT: {}", e))) + } +} + +/// Parameters returned by an OAuth authorization redirect. +#[derive(Debug, Clone, PartialEq, Eq)] +#[non_exhaustive] +pub struct AuthorizationCallback { + pub code: String, + pub csrf_token: String, + pub issuer: Option, +} + +impl AuthorizationCallback { + /// Parse an OAuth redirect URL and extract `code`, `state`, and optional RFC 9207 `iss`. + pub fn from_redirect_url(url: &str) -> Result { + let url = Url::parse(url)?; + let mut code = None; + let mut csrf_token = None; + let mut issuer = None; + + for (key, value) in url.query_pairs() { + match key.as_ref() { + "code" => code = Some(value.into_owned()), + "state" => csrf_token = Some(value.into_owned()), + "iss" => issuer = Some(value.into_owned()), + _ => {} + } + } + + let code = code.ok_or_else(|| { + AuthError::AuthorizationFailed("Authorization callback missing code".to_string()) + })?; + let csrf_token = csrf_token.ok_or_else(|| { + AuthError::AuthorizationFailed("Authorization callback missing state".to_string()) + })?; + + Ok(Self { + code, + csrf_token, + issuer, + }) + } +} + +/// oauth2 authorization session, for guiding user to complete the authorization process +#[non_exhaustive] +pub struct AuthorizationSession { + pub auth_manager: AuthorizationManager, + pub auth_url: String, + pub redirect_uri: String, +} + +impl AuthorizationSession { + /// Create a new authorization session, selecting a client registration + /// mechanism per the [MCP authorization specification](https://modelcontextprotocol.io/specification/2026-07-28/basic/authorization/client-registration) + /// priority order: + /// + /// 1. Pre-registered client information + /// ([`AuthorizationRequest::with_preregistered_client`]), when available + /// 2. Client ID Metadata Documents + /// ([`AuthorizationRequest::with_client_metadata_url`]), when the + /// authorization server advertises `client_id_metadata_document_supported` + /// 3. Dynamic Client Registration, when the authorization server + /// advertises a `registration_endpoint` + /// + /// The manager must already have discovered authorization server metadata. + /// If `request.scopes` is empty, scopes are selected using the SDK's + /// normal scope-selection policy. + /// + /// On failure, the manager is returned alongside the error so callers can + /// retry without losing the original configuration and stores. + pub async fn new( + mut auth_manager: AuthorizationManager, + mut request: AuthorizationRequest, + ) -> Result { + if request.client_secret.is_some() && request.client_id.is_none() { + return Err(( + auth_manager, + AuthError::RegistrationFailed( + "client_secret was provided without a pre-registered client_id; \ + pair with_client_secret with with_preregistered_client" + .to_string(), + ), + )); + } + + if request.scopes.is_empty() { + request.scopes = auth_manager.select_scopes(None, &[]); + } else { + auth_manager.add_offline_access_if_supported(&mut request.scopes); + } + + if request.application_type.is_some() { + auth_manager.application_type = request.application_type.clone(); + } + + let redirect_uri = request.redirect_uri.clone(); + let scopes = request.scopes.clone(); + let scope_refs: Vec<&str> = scopes.iter().map(|s| s.as_str()).collect(); + + let supports_url_based_client_id = auth_manager + .metadata + .as_ref() + .and_then(|m| { + m.additional_fields + .get("client_id_metadata_document_supported") + }) + .and_then(|v| v.as_bool()) + .unwrap_or(false); + + // 1. pre-registered client information takes priority over everything else + let config = if let Some(client_id) = &request.client_id { + OAuthClientConfig { + client_id: client_id.clone(), + client_secret: request.client_secret.clone(), + scopes: scopes.clone(), + redirect_uri: redirect_uri.clone(), + application_type: request.application_type.clone(), + } + // 2. CIMD (SEP-991), when the server advertises support and the client hosts a metadata document + } else if let Some(client_metadata_url) = request.client_metadata_url.as_deref() + && supports_url_based_client_id + { + if !is_https_url(client_metadata_url) { + return Err(( + auth_manager, + AuthError::RegistrationFailed(format!( + "client_metadata_url must be a valid HTTPS URL with a non-root pathname, got: {}", + client_metadata_url + )), + )); + } + // SEP-991: URL-based Client IDs - use URL as client_id directly. + // SEP-837: match the hosted client-metadata.json application_type ("native") + OAuthClientConfig { + client_id: client_metadata_url.to_string(), + client_secret: None, + scopes: scopes.clone(), + redirect_uri: redirect_uri.clone(), + application_type: Some( + request + .application_type + .clone() + .unwrap_or_else(|| DEFAULT_APPLICATION_TYPE.to_string()), + ), + } + // 3. fall back to dynamic client registration + } else { + match auth_manager + .register_client( + request.client_name.as_deref().unwrap_or("MCP Client"), + &redirect_uri, + &scope_refs, + ) + .await + { + Ok(config) => config, + Err(e) => { + return Err(( + auth_manager, + AuthError::RegistrationFailed(format!( + "Dynamic registration failed: {}", + e + )), + )); + } + } + }; + + // reset client config + if let Err(e) = auth_manager.configure_client(config) { + return Err((auth_manager, e)); + } + let auth_url = match auth_manager.get_authorization_url(&scope_refs).await { + Ok(url) => url, + Err(e) => return Err((auth_manager, e)), + }; + + Ok(Self { + auth_manager, + auth_url, + redirect_uri, + }) + } + + /// create session for scope upgrade flow (existing manager + pre-computed auth url) + pub fn for_scope_upgrade( + auth_manager: AuthorizationManager, + auth_url: String, + redirect_uri: &str, + ) -> Self { + Self { + auth_manager, + auth_url, + redirect_uri: redirect_uri.to_string(), + } + } + + /// get client_id and credentials + pub async fn get_credentials(&self) -> Result { + self.auth_manager.get_credentials().await + } + + /// get authorization url + pub fn get_authorization_url(&self) -> &str { + &self.auth_url + } + + /// handle authorization code callback + pub async fn handle_callback( + &self, + code: &str, + csrf_token: &str, + ) -> Result { + self.handle_callback_with_issuer(code, csrf_token, None) + .await + } + + /// handle authorization code callback, validating the optional RFC 9207 + /// authorization response issuer (`iss`) when present. + pub async fn handle_callback_with_issuer( + &self, + code: &str, + csrf_token: &str, + issuer: Option<&str>, + ) -> Result { + self.auth_manager + .exchange_code_for_token_with_issuer(code, csrf_token, issuer) + .await + } + + /// handle an OAuth redirect URL, including optional RFC 9207 `iss` validation. + pub async fn handle_callback_url( + &self, + callback_url: &str, + ) -> Result { + let callback = AuthorizationCallback::from_redirect_url(callback_url)?; + self.handle_callback_with_issuer( + &callback.code, + &callback.csrf_token, + callback.issuer.as_deref(), + ) + .await + } +} + +/// http client extension, automatically add authorization header +pub struct AuthorizedHttpClient { + auth_manager: Arc, + inner_client: ReqwestClient, +} + +impl AuthorizedHttpClient { + /// create new authorized http client + pub fn new(auth_manager: Arc, client: Option) -> Self { + let inner_client = client.unwrap_or_default(); + Self { + auth_manager, + inner_client, + } + } + + /// send authorized request + pub async fn request( + &self, + method: reqwest::Method, + url: U, + ) -> Result { + let request = self.inner_client.request(method, url); + self.auth_manager.prepare_request(request).await + } + + /// send get request + pub async fn get(&self, url: U) -> Result { + let request = self.request(reqwest::Method::GET, url).await?; + let response = request.send().await?; + self.auth_manager.handle_response(response).await + } + + /// send post request + pub async fn post(&self, url: U) -> Result { + self.request(reqwest::Method::POST, url).await + } +} + +/// OAuth state machine +/// Use the OAuthState to manage the OAuth client is more recommend +/// But also you can use the AuthorizationManager,AuthorizationSession,AuthorizedHttpClient directly +#[non_exhaustive] +pub enum OAuthState { + /// the AuthorizationManager + Unauthorized(AuthorizationManager), + /// the AuthorizationSession + Session(AuthorizationSession), + /// the authd AuthorizationManager + Authorized(AuthorizationManager), + /// the authd http client + AuthorizedHttpClient(AuthorizedHttpClient), +} + +impl OAuthState { + fn oauth_http_client_config(&self) -> (Arc, OAuthHttpRedirectPolicy) { + let manager = match self { + OAuthState::Unauthorized(manager) | OAuthState::Authorized(manager) => manager, + OAuthState::Session(session) => &session.auth_manager, + OAuthState::AuthorizedHttpClient(client) => &client.auth_manager, + }; + ( + Arc::clone(&manager.http_client), + manager.refresh_redirect_policy, + ) + } + + async fn placeholder_state(&self) -> Result { + let (http_client, refresh_redirect_policy) = self.oauth_http_client_config(); + Ok(OAuthState::Unauthorized( + AuthorizationManager::new_inner( + DEFAULT_EXCHANGE_URL, + http_client, + refresh_redirect_policy, + ) + .await?, + )) + } + + /// Create new OAuth state machine + pub async fn new( + base_url: U, + client: Option, + ) -> Result { + let mut manager = AuthorizationManager::new(base_url).await?; + if let Some(client) = client { + manager.with_client(client)?; + } + + Ok(OAuthState::Unauthorized(manager)) + } + + /// Create an OAuth state machine that routes all OAuth HTTP operations + /// through the supplied client. + pub async fn new_with_oauth_http_client( + base_url: U, + client: Arc, + ) -> Result { + let manager = AuthorizationManager::new_with_oauth_http_client(base_url, client).await?; + Ok(OAuthState::Unauthorized(manager)) + } + + /// Get client_id and OAuth credentials + pub async fn get_credentials(&self) -> Result { + // return client_id and credentials + match self { + OAuthState::Unauthorized(manager) | OAuthState::Authorized(manager) => { + manager.get_credentials().await + } + OAuthState::Session(session) => session.get_credentials().await, + OAuthState::AuthorizedHttpClient(client) => client.auth_manager.get_credentials().await, + } + } + + /// Manually set credentials and move into authorized state + /// Useful if you're caching credentials externally and wish to reuse them + pub async fn set_credentials( + &mut self, + client_id: &str, + credentials: OAuthTokenResponse, + ) -> Result<(), AuthError> { + if let OAuthState::Unauthorized(manager) = self { + let replacement = AuthorizationManager::new_inner( + DEFAULT_EXCHANGE_URL, + Arc::clone(&manager.http_client), + manager.refresh_redirect_policy, + ) + .await?; + let mut manager = std::mem::replace(manager, replacement); + + let granted_scopes: Vec = credentials + .scopes() + .map(|scopes| scopes.iter().map(|s| s.to_string()).collect()) + .unwrap_or_default(); + + *manager.current_scopes.write().await = granted_scopes.clone(); + + let resolution = manager.resolve_metadata().await?; + manager.metadata = Some(resolution.metadata); + + let stored = StoredCredentials { + client_id: client_id.to_string(), + token_response: Some(credentials), + granted_scopes, + token_received_at: Some(AuthorizationManager::now_epoch_secs()), + issuer: manager.metadata_issuer(), + }; + manager.credential_store.save(stored).await?; + + manager.configure_client_id(client_id)?; + + *self = OAuthState::Authorized(manager); + Ok(()) + } else { + Err(AuthError::InternalError( + "Cannot set credentials in this state".to_string(), + )) + } + } + + /// Start authorization. + /// + /// Selects a client registration mechanism from the identity material in + /// `request`, following the [MCP authorization specification](https://modelcontextprotocol.io/specification/2026-07-28/basic/authorization/client-registration) + /// priority order: + /// + /// 1. Pre-registered client information + /// ([`AuthorizationRequest::with_preregistered_client`]), when available + /// 2. Client ID Metadata Documents + /// ([`AuthorizationRequest::with_client_metadata_url`]), when the + /// authorization server advertises `client_id_metadata_document_supported` + /// 3. Dynamic Client Registration, when the authorization server + /// advertises a `registration_endpoint` + /// + /// If `request.scopes` is empty, scopes are selected using the SDK's + /// normal scope-selection policy. + /// + /// On failure, the state returns to `Unauthorized` so callers can retry + /// without losing the original configuration and stores. + pub async fn start_authorization( + &mut self, + request: AuthorizationRequest, + ) -> Result<(), AuthError> { + let placeholder = self.placeholder_state().await?; + let old = std::mem::replace(self, placeholder); + let OAuthState::Unauthorized(mut manager) = old else { + *self = old; + return Err(AuthError::InternalError( + "Already in session state".to_string(), + )); + }; + debug!("start discovery"); + let resolution = manager + .resolve_metadata_from_challenge(request.challenge.as_deref()) + .await; + let metadata = match resolution { + Ok(resolution) => resolution.metadata, + Err(e) => { + *self = OAuthState::Unauthorized(manager); + return Err(e); + } + }; + manager.metadata = Some(metadata); + debug!("start session"); + match AuthorizationSession::new(manager, request).await { + Ok(session) => { + *self = OAuthState::Session(session); + Ok(()) + } + Err((manager, e)) => { + *self = OAuthState::Unauthorized(manager); + Err(e) + } + } + } + + /// complete authorization + pub async fn complete_authorization(&mut self) -> Result<(), AuthError> { + let placeholder = self.placeholder_state().await?; + if let OAuthState::Session(session) = std::mem::replace(self, placeholder) { + *self = OAuthState::Authorized(session.auth_manager); + Ok(()) + } else { + Err(AuthError::InternalError("Not in session state".to_string())) + } + } + /// convert to authorized http client + pub async fn to_authorized_http_client(&mut self) -> Result<(), AuthError> { + let placeholder = self.placeholder_state().await?; + if let OAuthState::Authorized(manager) = std::mem::replace(self, placeholder) { + *self = OAuthState::AuthorizedHttpClient(AuthorizedHttpClient::new( + Arc::new(manager), + None, + )); + Ok(()) + } else { + Err(AuthError::InternalError( + "Not in authorized state".to_string(), + )) + } + } + + /// request scope upgrade (Authorized -> Session); returns auth URL to open + pub async fn request_scope_upgrade( + &mut self, + required_scope: &str, + redirect_uri: &str, + ) -> Result { + let placeholder = self.placeholder_state().await?; + let old = std::mem::replace(self, placeholder); + let OAuthState::Authorized(manager) = old else { + *self = old; + return Err(AuthError::InternalError( + "Not in authorized state".to_string(), + )); + }; + let auth_url = match manager.request_scope_upgrade(required_scope).await { + Ok(url) => url, + Err(e) => { + *self = OAuthState::Authorized(manager); + return Err(e); + } + }; + let session = + AuthorizationSession::for_scope_upgrade(manager, auth_url.clone(), redirect_uri); + *self = OAuthState::Session(session); + Ok(auth_url) + } + + /// get current authorization url + pub async fn get_authorization_url(&self) -> Result { + match self { + OAuthState::Session(session) => Ok(session.get_authorization_url().to_string()), + OAuthState::Unauthorized(_) => { + Err(AuthError::InternalError("Not in session state".to_string())) + } + OAuthState::Authorized(_) => { + Err(AuthError::InternalError("Already authorized".to_string())) + } + OAuthState::AuthorizedHttpClient(_) => { + Err(AuthError::InternalError("Already authorized".to_string())) + } + } + } + + /// handle authorization callback + pub async fn handle_callback(&mut self, code: &str, csrf_token: &str) -> Result<(), AuthError> { + self.handle_callback_with_issuer(code, csrf_token, None) + .await + } + + /// handle authorization callback, validating the optional RFC 9207 + /// authorization response issuer (`iss`) when present. + pub async fn handle_callback_with_issuer( + &mut self, + code: &str, + csrf_token: &str, + issuer: Option<&str>, + ) -> Result<(), AuthError> { + match self { + OAuthState::Session(session) => { + session + .handle_callback_with_issuer(code, csrf_token, issuer) + .await?; + self.complete_authorization().await + } + OAuthState::Unauthorized(_) => { + Err(AuthError::InternalError("Not in session state".to_string())) + } + OAuthState::Authorized(_) => { + Err(AuthError::InternalError("Already authorized".to_string())) + } + OAuthState::AuthorizedHttpClient(_) => { + Err(AuthError::InternalError("Already authorized".to_string())) + } + } + } + + /// handle an OAuth redirect URL, including optional RFC 9207 `iss` validation. + pub async fn handle_callback_url(&mut self, callback_url: &str) -> Result<(), AuthError> { + let callback = AuthorizationCallback::from_redirect_url(callback_url)?; + self.handle_callback_with_issuer( + &callback.code, + &callback.csrf_token, + callback.issuer.as_deref(), + ) + .await + } + + /// get access token + pub async fn get_access_token(&self) -> Result { + match self { + OAuthState::Unauthorized(manager) => manager.get_access_token().await, + OAuthState::Session(_) => { + Err(AuthError::InternalError("Not in manager state".to_string())) + } + OAuthState::Authorized(_) => { + Err(AuthError::InternalError("Already authorized".to_string())) + } + OAuthState::AuthorizedHttpClient(_) => { + Err(AuthError::InternalError("Already authorized".to_string())) + } + } + } + + /// refresh access token + pub async fn refresh_token(&self) -> Result<(), AuthError> { + match self { + OAuthState::Unauthorized(_) => { + Err(AuthError::InternalError("Not in manager state".to_string())) + } + OAuthState::Session(_) => { + Err(AuthError::InternalError("Not in manager state".to_string())) + } + OAuthState::Authorized(manager) => { + manager.refresh_token().await?; + Ok(()) + } + OAuthState::AuthorizedHttpClient(_) => { + Err(AuthError::InternalError("Already authorized".to_string())) + } + } + } + + pub fn into_authorization_manager(self) -> Option { + match self { + OAuthState::Authorized(manager) => Some(manager), + _ => None, + } + } + + /// Authenticate using OAuth 2.0 Client Credentials flow (SEP-1046). + /// + /// Transitions directly from `Unauthorized` to `Authorized`, skipping the + /// interactive `Session` state entirely. Discovers metadata, configures the + /// client, and exchanges credentials for an access token. + pub async fn authenticate_client_credentials( + &mut self, + config: ClientCredentialsConfig, + ) -> Result<(), AuthError> { + let placeholder = self.placeholder_state().await?; + let OAuthState::Unauthorized(mut manager) = std::mem::replace(self, placeholder) else { + return Err(AuthError::InternalError( + "Client credentials flow requires Unauthorized state".to_string(), + )); + }; + + // Discover metadata + let resolution = manager.resolve_metadata().await?; + manager.metadata = Some(resolution.metadata); + + // Validate server supports the requested auth method + manager.validate_client_credentials_metadata(&config)?; + + // Configure OAuth client + manager.configure_client_credentials(&config)?; + + // Exchange credentials for token + manager.exchange_client_credentials(&config).await?; + + *self = OAuthState::Authorized(manager); + Ok(()) + } +} + +#[cfg(test)] +mod tests { + use std::{ + collections::{HashMap, VecDeque}, + sync::{Arc, Mutex as StdMutex}, + }; + + use oauth2::{AuthType, CsrfToken, HttpResponse, PkceCodeVerifier, TokenResponse}; + use reqwest::StatusCode; + use rstest::rstest; + use tokio::sync::{Mutex, OwnedMutexGuard, Semaphore}; + use url::Url; + + use super::{ + AuthError, AuthorizationCallback, AuthorizationManager, AuthorizationMetadata, + AuthorizationMetadataSource, AuthorizationRequest, AuthorizationSession, + CredentialRefreshGuard, CredentialStore, InMemoryCredentialStore, InMemoryStateStore, + OAuthClientConfig, OAuthHttpClient, OAuthHttpClientError, OAuthHttpClientFuture, + OAuthHttpRedirectPolicy, OAuthHttpRequest, ScopeUpgradeConfig, StateStore, + StoredAuthorizationState, is_https_url, + }; + use crate::transport::auth::VendorExtraTokenFields; + + #[derive(Clone, Debug, PartialEq, Eq)] + struct RecordedOAuthRequest { + method: String, + uri: String, + redirect_policy: OAuthHttpRedirectPolicy, + body: Vec, + } + + #[derive(Clone, Default)] + struct RecordingOAuthHttpClient { + requests: Arc>>, + responses: Arc>>, + } + + impl RecordingOAuthHttpClient { + fn with_responses(responses: Vec) -> Self { + Self { + responses: Arc::new(StdMutex::new(responses.into())), + ..Default::default() + } + } + + fn requests(&self) -> Vec { + self.requests.lock().unwrap().clone() + } + } + + impl OAuthHttpClient for RecordingOAuthHttpClient { + fn execute(&self, request: OAuthHttpRequest) -> OAuthHttpClientFuture<'_> { + self.requests.lock().unwrap().push(RecordedOAuthRequest { + method: request.request.method().to_string(), + uri: request.request.uri().to_string(), + redirect_policy: request.redirect_policy, + body: request.request.body().clone(), + }); + let response = self.responses.lock().unwrap().pop_front(); + Box::pin(async move { response.ok_or_else(|| "missing fake response".into()) }) + } + } + + fn http_response(status: u16, body: serde_json::Value) -> HttpResponse { + oauth2::http::Response::builder() + .status(status) + .body(serde_json::to_vec(&body).unwrap()) + .unwrap() + } + + fn redirect_response(location: &str) -> HttpResponse { + oauth2::http::Response::builder() + .status(302) + .header("location", location) + .body(Vec::new()) + .unwrap() + } + + fn empty_response(status: u16) -> HttpResponse { + oauth2::http::Response::builder() + .status(status) + .body(Vec::new()) + .unwrap() + } + + #[test] + fn oauth_http_client_error_preserves_source_chain() { + #[derive(Debug, thiserror::Error)] + #[error("request failed")] + struct RequestError(#[source] std::io::Error); + + let error: OAuthHttpClientError = RequestError(std::io::Error::other( + "certificate signed by unknown authority", + )) + .into(); + assert!(error.downcast_ref::().is_some()); + + let url = Url::parse("https://mcp.example.com/mcp").unwrap(); + let error = AuthorizationManager::discovery_failed(&url, error); + assert_eq!( + error.to_string(), + "Metadata error: OAuth metadata discovery failed for https://mcp.example.com/mcp\n Caused by: request failed\n Caused by: certificate signed by unknown authority" + ); + } + + #[tokio::test] + async fn default_oauth_http_client_honors_redirect_policy() { + use axum::{Router, routing::post}; + + let received = Arc::new(StdMutex::new(Vec::new())); + let capture = Arc::clone(&received); + let app = Router::new() + .route( + "/redirect", + post(|| async { (StatusCode::TEMPORARY_REDIRECT, [("location", "/token")]) }), + ) + .route( + "/token", + post(move |body: String| { + let capture = Arc::clone(&capture); + async move { + capture.lock().unwrap().push(body); + StatusCode::OK + } + }), + ); + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let endpoint = format!("http://{}/redirect", listener.local_addr().unwrap()); + tokio::spawn(async move { axum::serve(listener, app).await.unwrap() }); + let client = super::default_oauth_http_client().unwrap(); + + for (policy, expected) in [ + ( + OAuthHttpRedirectPolicy::Stop, + StatusCode::TEMPORARY_REDIRECT, + ), + (OAuthHttpRedirectPolicy::Follow, StatusCode::OK), + ] { + let request = oauth2::http::Request::builder() + .method("POST") + .uri(&endpoint) + .body(b"credential-sentinel".to_vec()) + .unwrap(); + let response = client + .execute(OAuthHttpRequest::new(request, policy)) + .await + .unwrap(); + assert_eq!(response.status(), expected); + let expected_bodies = if policy == OAuthHttpRedirectPolicy::Stop { + vec![] + } else { + vec!["credential-sentinel".to_owned()] + }; + assert_eq!(*received.lock().unwrap(), expected_bodies); + } + } + + #[tokio::test] + async fn default_http_client_preserves_connection_failure_cause() { + let listener = std::net::TcpListener::bind("127.0.0.1:0").unwrap(); + let url = format!("http://{}/mcp", listener.local_addr().unwrap()); + drop(listener); + + let manager = AuthorizationManager::new(&url).await.unwrap(); + let error = manager.resolve_metadata().await.unwrap_err(); + + assert!( + matches!( + error, + AuthError::MetadataError(ref reason) + if reason.contains(&url) + && reason.contains("\n Caused by: error sending request for url") + && reason.matches("error sending request for url").count() == 1 + && reason.to_ascii_lowercase().contains("connection refused") + ), + "unexpected discovery error: {error}" + ); + } + + #[tokio::test] + async fn authorization_metadata_propagates_transport_failure() { + let responses = preregistered_discovery_responses() + .into_iter() + .take(2) + .collect(); + let client = RecordingOAuthHttpClient::with_responses(responses); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let error = manager.resolve_metadata().await.unwrap_err(); + + assert!( + matches!( + error, + AuthError::MetadataError(ref reason) + if reason.contains("https://auth.example.com/.well-known/oauth-authorization-server") + && reason.contains("missing fake response") + ), + "unexpected discovery error: {error}" + ); + assert_eq!(client.requests().len(), 3); + } + + #[tokio::test] + async fn discovery_propagates_server_errors() { + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(RecordingOAuthHttpClient::with_responses(vec![ + empty_response(503), + ])), + ) + .await + .unwrap(); + + let error = manager.resolve_metadata().await.unwrap_err(); + + assert!( + matches!( + error, + AuthError::MetadataError(ref reason) + if reason.contains("https://mcp.example.com/mcp") && reason.contains("503") + ), + "unexpected discovery error: {error}" + ); + } + + #[rstest] + #[case::resource_request_timeout(StatusCode::REQUEST_TIMEOUT, 0, "https://mcp.example.com/mcp")] + #[case::resource_too_early(StatusCode::TOO_EARLY, 0, "https://mcp.example.com/mcp")] + #[case::resource_too_many_requests( + StatusCode::TOO_MANY_REQUESTS, + 0, + "https://mcp.example.com/mcp" + )] + #[case::protected_metadata_request_timeout( + StatusCode::REQUEST_TIMEOUT, + 1, + "https://mcp.example.com/.well-known/oauth-protected-resource" + )] + #[case::protected_metadata_too_early( + StatusCode::TOO_EARLY, + 1, + "https://mcp.example.com/.well-known/oauth-protected-resource" + )] + #[case::protected_metadata_too_many_requests( + StatusCode::TOO_MANY_REQUESTS, + 1, + "https://mcp.example.com/.well-known/oauth-protected-resource" + )] + #[case::authorization_request_timeout( + StatusCode::REQUEST_TIMEOUT, + 2, + "https://auth.example.com/.well-known/oauth-authorization-server" + )] + #[case::authorization_too_early( + StatusCode::TOO_EARLY, + 2, + "https://auth.example.com/.well-known/oauth-authorization-server" + )] + #[case::authorization_too_many_requests( + StatusCode::TOO_MANY_REQUESTS, + 2, + "https://auth.example.com/.well-known/oauth-authorization-server" + )] + #[tokio::test] + async fn discovery_propagates_transient_client_errors( + #[case] status: StatusCode, + #[case] successful_response_count: usize, + #[case] expected_url: &str, + ) { + let mut responses = preregistered_discovery_responses(); + responses.insert(successful_response_count, empty_response(status.as_u16())); + + let client = RecordingOAuthHttpClient::with_responses(responses); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let error = manager.resolve_metadata().await.unwrap_err(); + + assert!( + matches!( + error, + AuthError::MetadataError(ref reason) + if reason.contains(expected_url) && reason.contains(status.as_str()) + ), + "unexpected discovery error for {status}: {error}" + ); + assert_eq!(client.requests().len(), successful_response_count + 1); + } + + #[tokio::test] + async fn custom_http_client_handles_protected_resource_discovery() { + let challenge = oauth2::http::Response::builder() + .status(401) + .header( + "www-authenticate", + r#"Bearer resource_metadata="https://mcp.example.com/.well-known/oauth-protected-resource""#, + ) + .body(Vec::new()) + .unwrap(); + let client = RecordingOAuthHttpClient::with_responses(vec![ + challenge, + http_response( + 200, + serde_json::json!({ + "resource": "https://mcp.example.com", + "authorization_servers": ["https://auth.example.com"] + }), + ), + http_response( + 200, + serde_json::json!({ + "issuer": "https://auth.example.com", + "authorization_endpoint": "https://auth.example.com/authorize", + "token_endpoint": "https://auth.example.com/token" + }), + ), + ]); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let metadata = manager.resolve_metadata().await.unwrap().metadata; + + assert_eq!(metadata.token_endpoint, "https://auth.example.com/token"); + assert_eq!( + manager.discovered_resource.read().await.as_deref(), + Some("https://mcp.example.com") + ); + assert_eq!( + client.requests(), + vec![ + RecordedOAuthRequest { + method: "GET".to_string(), + uri: "https://mcp.example.com/mcp".to_string(), + redirect_policy: OAuthHttpRedirectPolicy::Stop, + body: Vec::new(), + }, + RecordedOAuthRequest { + method: "GET".to_string(), + uri: "https://mcp.example.com/.well-known/oauth-protected-resource".to_string(), + redirect_policy: OAuthHttpRedirectPolicy::Stop, + body: Vec::new(), + }, + RecordedOAuthRequest { + method: "GET".to_string(), + uri: "https://auth.example.com/.well-known/oauth-authorization-server" + .to_string(), + redirect_policy: OAuthHttpRedirectPolicy::Stop, + body: Vec::new(), + }, + ] + ); + } + + #[tokio::test] + async fn refresh_token_uses_discovered_protected_resource() { + let challenge = oauth2::http::Response::builder() + .status(401) + .header( + "www-authenticate", + r#"Bearer resource_metadata="https://mcp.example.com/.well-known/oauth-protected-resource""#, + ) + .body(Vec::new()) + .unwrap(); + let client = RecordingOAuthHttpClient::with_responses(vec![ + challenge, + http_response( + 200, + serde_json::json!({ + "resource": "https://mcp.example.com", + "authorization_servers": ["https://auth.example.com"] + }), + ), + http_response( + 200, + serde_json::json!({ + "issuer": "https://auth.example.com", + "authorization_endpoint": "https://auth.example.com/authorize", + "token_endpoint": "https://auth.example.com/token", + "response_types_supported": ["code"], + "code_challenge_methods_supported": ["S256"] + }), + ), + http_response( + 200, + serde_json::json!({ + "access_token": "initial-access-token", + "token_type": "bearer", + "refresh_token": "initial-refresh-token", + "expires_in": 3600 + }), + ), + http_response( + 200, + serde_json::json!({ + "access_token": "refreshed-access-token", + "token_type": "bearer", + "refresh_token": "refreshed-refresh-token", + "expires_in": 3600 + }), + ), + ]); + let mut manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let resolution = manager.resolve_metadata().await.unwrap(); + manager.set_metadata(resolution.metadata); + manager.configure_client_id("test-client-id").unwrap(); + + let authorization_url = manager.get_authorization_url(&[]).await.unwrap(); + let authorization_params: HashMap = Url::parse(&authorization_url) + .unwrap() + .query_pairs() + .into_owned() + .collect(); + let state = authorization_params.get("state").unwrap(); + + manager + .exchange_code_for_token("authorization-code", state) + .await + .unwrap(); + manager.refresh_token().await.unwrap(); + + let token_requests: Vec> = client + .requests() + .into_iter() + .filter(|request| request.uri == "https://auth.example.com/token") + .map(|request| { + url::form_urlencoded::parse(&request.body) + .into_owned() + .collect() + }) + .collect(); + + assert_eq!(token_requests.len(), 2); + assert_eq!( + token_requests[0].get("grant_type").map(String::as_str), + Some("authorization_code") + ); + assert_eq!( + token_requests[1].get("grant_type").map(String::as_str), + Some("refresh_token") + ); + assert_eq!( + [ + authorization_params.get("resource").map(String::as_str), + token_requests[0].get("resource").map(String::as_str), + token_requests[1].get("resource").map(String::as_str), + ], + [Some("https://mcp.example.com"); 3], + "authorization, code exchange, and refresh must use the discovered resource audience" + ); + } + + #[tokio::test] + async fn protected_resource_metadata_supports_authorization_server_path_insertion() { + let client = RecordingOAuthHttpClient::with_responses(vec![ + empty_response(401), + http_response( + 200, + serde_json::json!({ + "resource": "https://mcp.example.com/", + "authorization_servers": ["https://auth.example.com/tenant1"] + }), + ), + http_response( + 200, + serde_json::json!({ + "issuer": "https://auth.example.com/tenant1", + "authorization_endpoint": "https://auth.example.com/tenant1/authorize", + "token_endpoint": "https://auth.example.com/tenant1/token" + }), + ), + ]); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let metadata = manager.resolve_metadata().await.unwrap().metadata; + + assert_eq!( + ( + metadata.issuer.as_deref(), + metadata.authorization_endpoint.as_str(), + client + .requests() + .iter() + .map(|request| request.uri.as_str()) + .collect::>(), + ), + ( + Some("https://auth.example.com/tenant1"), + "https://auth.example.com/tenant1/authorize", + vec![ + "https://mcp.example.com/", + "https://mcp.example.com/.well-known/oauth-protected-resource", + "https://auth.example.com/.well-known/oauth-authorization-server/tenant1", + ], + ) + ); + } + + #[tokio::test] + async fn protected_resource_metadata_preserves_non_root_issuer_trailing_slash() { + let client = RecordingOAuthHttpClient::with_responses(vec![ + empty_response(401), + http_response( + 200, + serde_json::json!({ + "resource": "https://mcp.example.com/", + "authorization_servers": ["https://auth.example.com/tenant1/"] + }), + ), + http_response( + 200, + serde_json::json!({ + "issuer": "https://auth.example.com/tenant1/", + "authorization_endpoint": "https://auth.example.com/tenant1/authorize", + "token_endpoint": "https://auth.example.com/tenant1/token" + }), + ), + ]); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let metadata = manager.resolve_metadata().await.unwrap().metadata; + + assert_eq!( + ( + metadata.issuer.as_deref(), + client.requests().last().map(|request| request.uri.as_str()), + ), + ( + Some("https://auth.example.com/tenant1/"), + Some("https://auth.example.com/.well-known/oauth-authorization-server/tenant1"), + ) + ); + } + + #[tokio::test] + async fn authorization_metadata_rejects_mismatched_issuer() { + let client = RecordingOAuthHttpClient::with_responses(vec![ + empty_response(401), + http_response( + 200, + serde_json::json!({ + "resource": "https://mcp.example.com/", + "authorization_servers": ["https://auth.example.com/tenant1"] + }), + ), + http_response( + 200, + serde_json::json!({ + "resource": "https://mcp.example.com/", + "authorization_servers": ["https://auth.example.com/tenant1"] + }), + ), + http_response( + 200, + serde_json::json!({ + "issuer": "https://evil.example.com/tenant1", + "authorization_endpoint": "https://evil.example.com/tenant1/authorize", + "token_endpoint": "https://evil.example.com/tenant1/token" + }), + ), + ]); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/", + Arc::new(client), + ) + .await + .unwrap(); + + let error = manager.resolve_metadata().await.unwrap_err(); + + assert!( + matches!( + error, + AuthError::AuthorizationServerMismatch { + ref expected_issuer, + ref received_issuer + } if expected_issuer == "https://auth.example.com/tenant1" + && received_issuer == "https://evil.example.com/tenant1" + ), + "expected authorization server issuer mismatch, got: {error:?}" + ); + } + + #[tokio::test] + async fn authorization_metadata_accepts_oidc_path_appended_issuer() { + let discovery_url = + Url::parse("https://auth.example.com/tenant1/.well-known/openid-configuration") + .unwrap(); + let metadata = AuthorizationMetadata { + issuer: Some("https://auth.example.com/tenant1".to_string()), + authorization_endpoint: "https://auth.example.com/tenant1/authorize".to_string(), + token_endpoint: "https://auth.example.com/tenant1/token".to_string(), + ..Default::default() + }; + let manager = AuthorizationManager::new("https://mcp.example.com/") + .await + .unwrap(); + + manager + .validate_authorization_metadata_issuer(&discovery_url, None, &metadata) + .unwrap(); + } + + #[test] + fn authorization_metadata_allows_only_root_trailing_slash_equivalence() { + assert!(AuthorizationManager::issuer_identifiers_match( + "https://auth.example.com/", + "https://auth.example.com" + )); + assert!(!AuthorizationManager::issuer_identifiers_match( + "https://auth.example.com/tenant1/", + "https://auth.example.com/tenant1" + )); + } + + #[tokio::test] + async fn authorization_metadata_accepts_oidc_path_inserted_issuer() { + let discovery_url = + Url::parse("https://auth.example.com/.well-known/openid-configuration/tenant1") + .unwrap(); + let metadata = AuthorizationMetadata { + issuer: Some("https://auth.example.com/tenant1".to_string()), + authorization_endpoint: "https://auth.example.com/tenant1/authorize".to_string(), + token_endpoint: "https://auth.example.com/tenant1/token".to_string(), + ..Default::default() + }; + let manager = AuthorizationManager::new("https://mcp.example.com/") + .await + .unwrap(); + + manager + .validate_authorization_metadata_issuer(&discovery_url, None, &metadata) + .unwrap(); + } + + #[tokio::test] + async fn authorization_metadata_allows_missing_issuer_when_configured() { + let discovery_url = + Url::parse("https://auth.example.com/.well-known/openid-configuration/tenant1") + .unwrap(); + let metadata = AuthorizationMetadata { + issuer: None, + authorization_endpoint: "https://auth.example.com/tenant1/authorize".to_string(), + token_endpoint: "https://auth.example.com/tenant1/token".to_string(), + ..Default::default() + }; + + let mut manager = AuthorizationManager::new("https://mcp.example.com/") + .await + .unwrap(); + manager.set_allow_missing_issuer(true); + + manager + .validate_authorization_metadata_issuer(&discovery_url, None, &metadata) + .unwrap(); + } + + #[tokio::test] + async fn authorization_metadata_rejects_missing_issuer_by_default() { + let discovery_url = + Url::parse("https://auth.example.com/.well-known/openid-configuration/tenant1") + .unwrap(); + let metadata = AuthorizationMetadata { + issuer: None, + authorization_endpoint: "https://auth.example.com/tenant1/authorize".to_string(), + token_endpoint: "https://auth.example.com/tenant1/token".to_string(), + ..Default::default() + }; + let manager = AuthorizationManager::new("https://mcp.example.com/") + .await + .unwrap(); + + let error = manager + .validate_authorization_metadata_issuer(&discovery_url, None, &metadata) + .unwrap_err(); + + assert!( + matches!( + error, + AuthError::AuthorizationServerMissingIssuer { ref expected_issuer } + if expected_issuer == "https://auth.example.com/tenant1" + ), + "expected missing issuer error, got: {error:?}" + ); + } + + #[tokio::test] + async fn protected_resource_metadata_supports_custom_location_and_oidc_path_append() { + let challenge = oauth2::http::Response::builder() + .status(401) + .header( + "www-authenticate", + r#"Bearer resource_metadata="/custom/metadata/location.json""#, + ) + .body(Vec::new()) + .unwrap(); + let client = RecordingOAuthHttpClient::with_responses(vec![ + challenge, + http_response( + 200, + serde_json::json!({ + "resource": "https://mcp.example.com/mcp", + "authorization_servers": ["https://auth.example.com/tenant1"] + }), + ), + empty_response(404), + empty_response(404), + http_response( + 200, + serde_json::json!({ + "issuer": "https://auth.example.com/tenant1", + "authorization_endpoint": "https://auth.example.com/tenant1/authorize", + "token_endpoint": "https://auth.example.com/tenant1/token" + }), + ), + ]); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let metadata = manager.resolve_metadata().await.unwrap().metadata; + + assert_eq!( + ( + metadata.token_endpoint.as_str(), + client + .requests() + .iter() + .map(|request| request.uri.as_str()) + .collect::>(), + ), + ( + "https://auth.example.com/tenant1/token", + vec![ + "https://mcp.example.com/mcp", + "https://mcp.example.com/custom/metadata/location.json", + "https://auth.example.com/.well-known/oauth-authorization-server/tenant1", + "https://auth.example.com/.well-known/openid-configuration/tenant1", + "https://auth.example.com/tenant1/.well-known/openid-configuration", + ], + ) + ); + assert!( + client + .requests() + .iter() + .all(|request| request.method == "GET"), + "discovery must not send non-GET requests" + ); + } + + #[rstest] + #[case::not_found(StatusCode::NOT_FOUND)] + #[case::method_not_allowed(StatusCode::METHOD_NOT_ALLOWED)] + #[tokio::test] + async fn resolve_metadata_reports_legacy_fallback_when_nothing_is_discovered( + #[case] status: StatusCode, + ) { + let client = RecordingOAuthHttpClient::with_responses(vec![ + empty_response(status.as_u16()), + empty_response(status.as_u16()), + empty_response(status.as_u16()), + empty_response(status.as_u16()), + ]); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://legacy.example.com/", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let resolution = manager.resolve_metadata().await.unwrap(); + + assert_eq!( + ( + resolution.source, + resolution.metadata.authorization_endpoint.as_str(), + resolution.metadata.token_endpoint.as_str(), + resolution.metadata.registration_endpoint.as_deref(), + client + .requests() + .iter() + .map(|request| request.uri.as_str()) + .collect::>(), + ), + ( + AuthorizationMetadataSource::LegacyEndpointFallback, + "https://legacy.example.com/authorize", + "https://legacy.example.com/token", + Some("https://legacy.example.com/register"), + vec![ + "https://legacy.example.com/", + "https://legacy.example.com/.well-known/oauth-protected-resource", + "https://legacy.example.com/.well-known/oauth-authorization-server", + "https://legacy.example.com/.well-known/openid-configuration", + ], + ) + ); + } + + #[tokio::test] + async fn resolve_metadata_reports_protected_resource_metadata() { + let challenge = oauth2::http::Response::builder() + .status(401) + .header( + "www-authenticate", + r#"Bearer resource_metadata="https://mcp.example.com/.well-known/oauth-protected-resource""#, + ) + .body(Vec::new()) + .unwrap(); + let client = RecordingOAuthHttpClient::with_responses(vec![ + challenge, + http_response( + 200, + serde_json::json!({ + "resource": "https://mcp.example.com/mcp", + "authorization_servers": ["https://auth.example.com"] + }), + ), + http_response( + 200, + serde_json::json!({ + "issuer": "https://auth.example.com", + "authorization_endpoint": "https://auth.example.com/authorize", + "token_endpoint": "https://auth.example.com/token" + }), + ), + ]); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client), + ) + .await + .unwrap(); + + let resolution = manager.resolve_metadata().await.unwrap(); + + assert_eq!( + ( + resolution.source, + resolution.metadata.token_endpoint.as_str(), + ), + ( + AuthorizationMetadataSource::ProtectedResourceMetadata, + "https://auth.example.com/token", + ) + ); + } + + #[tokio::test] + async fn resolve_metadata_from_challenge_uses_challenge_pointer_and_scope() { + let client = RecordingOAuthHttpClient::with_responses(vec![ + http_response( + 200, + serde_json::json!({ + "resource": "https://mcp.example.com/mcp", + "authorization_servers": ["https://auth.example.com"] + }), + ), + http_response( + 200, + serde_json::json!({ + "issuer": "https://auth.example.com", + "authorization_endpoint": "https://auth.example.com/authorize", + "token_endpoint": "https://auth.example.com/token" + }), + ), + ]); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let resolution = manager + .resolve_metadata_from_challenge(Some( + r#"Bearer resource_metadata="https://mcp.example.com/custom/prm.json", scope="mcp:read mcp:write""#, + )) + .await + .unwrap(); + + assert_eq!( + ( + resolution.source, + resolution.metadata.token_endpoint.as_str(), + manager.select_scopes(None, &[]), + client.requests().first().map(|request| request.uri.clone()), + ), + ( + AuthorizationMetadataSource::ProtectedResourceMetadata, + "https://auth.example.com/token", + vec!["mcp:read".to_string(), "mcp:write".to_string()], + // discovery starts at the challenge's pointer: no probing + Some("https://mcp.example.com/custom/prm.json".to_string()), + ) + ); + } + + #[tokio::test] + async fn resolve_metadata_from_challenge_falls_back_without_metadata_pointer() { + let client = RecordingOAuthHttpClient::with_responses(vec![ + empty_response(404), + empty_response(404), + empty_response(404), + empty_response(404), + ]); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://legacy.example.com/", + Arc::new(client), + ) + .await + .unwrap(); + + let resolution = manager + .resolve_metadata_from_challenge(Some(r#"Bearer scope="mcp:basic""#)) + .await + .unwrap(); + + assert_eq!( + (resolution.source, manager.select_scopes(None, &[]),), + ( + AuthorizationMetadataSource::LegacyEndpointFallback, + vec!["mcp:basic".to_string()], + ) + ); + } + + #[tokio::test] + async fn resolve_metadata_reports_authorization_server_metadata() { + let client = RecordingOAuthHttpClient::with_responses(vec![ + empty_response(404), + empty_response(404), + empty_response(404), + http_response( + 200, + serde_json::json!({ + "issuer": "https://mcp.example.com", + "authorization_endpoint": "https://mcp.example.com/oauth/authorize", + "token_endpoint": "https://mcp.example.com/oauth/token" + }), + ), + ]); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/", + Arc::new(client), + ) + .await + .unwrap(); + + let resolution = manager.resolve_metadata().await.unwrap(); + + assert_eq!( + ( + resolution.source, + resolution.metadata.token_endpoint.as_str(), + ), + ( + AuthorizationMetadataSource::AuthorizationServerMetadata, + "https://mcp.example.com/oauth/token", + ) + ); + } + + #[tokio::test] + async fn resolve_metadata_reaches_the_well_known_document_past_a_non_metadata_base_url() { + let client = RecordingOAuthHttpClient::with_responses(vec![ + // the MCP endpoint answers GET with a health payload, not metadata + http_response( + 200, + serde_json::json!({"status": "healthy", "message": "MCP server is running"}), + ), + // the well-known candidate carries the real document + http_response( + 200, + serde_json::json!({ + "resource": "https://mcp.example.com/", + "authorization_servers": ["https://auth.example.com"] + }), + ), + http_response( + 200, + serde_json::json!({ + "issuer": "https://auth.example.com", + "authorization_endpoint": "https://auth.example.com/authorize", + "token_endpoint": "https://auth.example.com/token" + }), + ), + ]); + let recorder = client.clone(); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/", + Arc::new(client), + ) + .await + .unwrap(); + + let resolution = manager.resolve_metadata().await.unwrap(); + + assert_eq!( + ( + resolution.source, + resolution.metadata.token_endpoint.as_str(), + ), + ( + AuthorizationMetadataSource::ProtectedResourceMetadata, + "https://auth.example.com/token", + ) + ); + assert!( + recorder.requests().iter().any(|request| { + request.uri == "https://mcp.example.com/.well-known/oauth-protected-resource" + }), + "the well-known candidate was never probed: {:?}", + recorder.requests() + ); + } + + #[tokio::test] + async fn resolve_metadata_ignores_a_well_known_url_that_is_not_a_metadata_document() { + let health = || { + http_response( + 200, + serde_json::json!({"status": "healthy", "message": "MCP server is running"}), + ) + }; + let client = RecordingOAuthHttpClient::with_responses(vec![ + // the MCP endpoint answers GET with a health payload, not metadata + health(), + // so does the well-known candidate + health(), + http_response( + 200, + serde_json::json!({ + "issuer": "https://mcp.example.com", + "authorization_endpoint": "https://mcp.example.com/oauth/authorize", + "token_endpoint": "https://mcp.example.com/oauth/token" + }), + ), + ]); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/", + Arc::new(client), + ) + .await + .unwrap(); + + let resolution = manager.resolve_metadata().await.unwrap(); + + assert_eq!( + ( + resolution.source, + resolution.metadata.token_endpoint.as_str(), + ), + ( + AuthorizationMetadataSource::AuthorizationServerMetadata, + "https://mcp.example.com/oauth/token", + ) + ); + } + + #[tokio::test] + async fn resolve_metadata_tries_the_next_well_known_candidate_past_a_non_metadata_document() { + let client = RecordingOAuthHttpClient::with_responses(vec![ + // the MCP endpoint answers GET with a health payload, not metadata + http_response( + 200, + serde_json::json!({"status": "healthy", "message": "MCP server is running"}), + ), + // so does the first well-known candidate + http_response( + 200, + serde_json::json!({"status": "healthy", "message": "MCP server is running"}), + ), + // the second candidate carries the real document + http_response( + 200, + serde_json::json!({ + "resource": "https://mcp.example.com/mcp", + "authorization_servers": ["https://auth.example.com"] + }), + ), + http_response( + 200, + serde_json::json!({ + "issuer": "https://auth.example.com", + "authorization_endpoint": "https://auth.example.com/authorize", + "token_endpoint": "https://auth.example.com/token" + }), + ), + ]); + let recorder = client.clone(); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client), + ) + .await + .unwrap(); + + let resolution = manager.resolve_metadata().await.unwrap(); + + assert_eq!( + ( + resolution.source, + resolution.metadata.token_endpoint.as_str(), + ), + ( + AuthorizationMetadataSource::ProtectedResourceMetadata, + "https://auth.example.com/token", + ) + ); + let document_requests = recorder + .requests() + .iter() + .filter(|request| { + request.uri == "https://mcp.example.com/mcp/.well-known/oauth-protected-resource" + }) + .count(); + assert_eq!( + document_requests, + 1, + "the candidate holding the document should be requested exactly once: {:?}", + recorder.requests() + ); + } + + #[tokio::test] + async fn resolve_metadata_from_challenge_reports_an_advertised_url_without_metadata() { + let mut responses = vec![http_response(200, serde_json::json!({}))]; + // enough responses for the fallback to reach the legacy endpoints, so that + // treating the document as a soft failure would resolve rather than error + responses.extend(std::iter::repeat_with(|| empty_response(404)).take(8)); + let client = RecordingOAuthHttpClient::with_responses(responses); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client), + ) + .await + .unwrap(); + + let error = manager + .resolve_metadata_from_challenge(Some( + r#"Bearer resource_metadata="https://mcp.example.com/.well-known/oauth-protected-resource""#, + )) + .await + .unwrap_err(); + + assert_eq!( + error.to_string(), + "Metadata error: the server advertised https://mcp.example.com/.well-known/oauth-protected-resource as protected resource metadata, but the document carries neither `resource` nor an authorization server reference" + ); + } + + #[tokio::test] + async fn resolve_metadata_tries_the_next_well_known_candidate_past_an_unusable_document() { + let client = RecordingOAuthHttpClient::with_responses(vec![ + // the MCP endpoint answers GET with a health payload, not metadata + http_response( + 200, + serde_json::json!({"status": "healthy", "message": "MCP server is running"}), + ), + // a catch-all handler answers the first candidate with its own error + // shape, which carries a `resource` that only validation rejects + http_response( + 200, + serde_json::json!({ + "error": "not_found", + "resource": "/.well-known/oauth-protected-resource" + }), + ), + // the second candidate carries the real document + http_response( + 200, + serde_json::json!({ + "resource": "https://mcp.example.com/mcp", + "authorization_servers": ["https://auth.example.com"] + }), + ), + http_response( + 200, + serde_json::json!({ + "issuer": "https://auth.example.com", + "authorization_endpoint": "https://auth.example.com/authorize", + "token_endpoint": "https://auth.example.com/token" + }), + ), + ]); + let recorder = client.clone(); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client), + ) + .await + .unwrap(); + + let resolution = manager.resolve_metadata().await.unwrap(); + + assert_eq!( + ( + resolution.source, + resolution.metadata.token_endpoint.as_str(), + ), + ( + AuthorizationMetadataSource::ProtectedResourceMetadata, + "https://auth.example.com/token", + ) + ); + assert!( + recorder.requests().iter().any(|request| { + request.uri == "https://mcp.example.com/mcp/.well-known/oauth-protected-resource" + }), + "the candidate after the rejected one was never probed: {:?}", + recorder.requests() + ); + } + + #[tokio::test] + async fn resolve_metadata_probes_the_candidates_past_an_advertised_url_that_is_not_served() { + let challenge = oauth2::http::Response::builder() + .status(401) + .header( + "www-authenticate", + r#"Bearer resource_metadata="https://mcp.example.com/prm""#, + ) + .body(Vec::new()) + .unwrap(); + let client = RecordingOAuthHttpClient::with_responses(vec![ + challenge, + // the advertised url is not where the document is served + empty_response(404), + // neither is the first candidate + empty_response(404), + // the second candidate carries the document + http_response( + 200, + serde_json::json!({ + "resource": "https://mcp.example.com/mcp", + "authorization_servers": ["https://auth.example.com"] + }), + ), + http_response( + 200, + serde_json::json!({ + "issuer": "https://auth.example.com", + "authorization_endpoint": "https://auth.example.com/authorize", + "token_endpoint": "https://auth.example.com/token" + }), + ), + ]); + let recorder = client.clone(); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client), + ) + .await + .unwrap(); + + let resolution = manager.resolve_metadata().await.unwrap(); + + assert_eq!( + ( + resolution.source, + resolution.metadata.token_endpoint.as_str(), + ), + ( + AuthorizationMetadataSource::ProtectedResourceMetadata, + "https://auth.example.com/token", + ) + ); + assert!( + recorder.requests().iter().any(|request| { + request.uri == "https://mcp.example.com/mcp/.well-known/oauth-protected-resource" + }), + "the candidates were skipped after the advertised url answered 404: {:?}", + recorder.requests() + ); + } + + #[tokio::test] + async fn resolve_metadata_requests_an_advertised_url_that_is_also_a_candidate_once() { + let challenge = oauth2::http::Response::builder() + .status(401) + .header( + "www-authenticate", + r#"Bearer resource_metadata="https://mcp.example.com/.well-known/oauth-protected-resource""#, + ) + .body(Vec::new()) + .unwrap(); + let mut responses = vec![ + // the MCP endpoint answers GET with a health payload, not metadata + http_response( + 200, + serde_json::json!({"status": "healthy", "message": "MCP server is running"}), + ), + // the first candidate points at the last candidate of the same run + challenge, + ]; + // the document is served nowhere, so the run walks every candidate and + // settles on the legacy endpoints + responses.extend(std::iter::repeat_with(|| empty_response(404)).take(10)); + let client = RecordingOAuthHttpClient::with_responses(responses); + let recorder = client.clone(); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client), + ) + .await + .unwrap(); + + let resolution = manager.resolve_metadata().await.unwrap(); + + assert_eq!( + resolution.source, + AuthorizationMetadataSource::LegacyEndpointFallback + ); + let advertised_requests = recorder + .requests() + .iter() + .filter(|request| { + request.uri == "https://mcp.example.com/.well-known/oauth-protected-resource" + }) + .count(); + assert_eq!( + advertised_requests, + 1, + "the url the challenge named was requested again as a candidate: {:?}", + recorder.requests() + ); + } + + #[tokio::test] + async fn resolve_metadata_requests_an_authorization_server_named_twice_once() { + let mut responses = vec![ + // the MCP endpoint answers GET with a health payload, not metadata + http_response( + 200, + serde_json::json!({"status": "healthy", "message": "MCP server is running"}), + ), + // the document names the same authorization server in both the singular + // draft field and the list + http_response( + 200, + serde_json::json!({ + "resource": "https://mcp.example.com/", + "authorization_server": "https://auth.example.com", + "authorization_servers": ["https://auth.example.com"] + }), + ), + ]; + // the authorization server publishes no metadata; more 404s than the walk + // can use, so that requesting it twice would show up in the sequence + responses.extend(std::iter::repeat_with(|| empty_response(404)).take(10)); + let client = RecordingOAuthHttpClient::with_responses(responses); + let recorder = client.clone(); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/", + Arc::new(client), + ) + .await + .unwrap(); + + manager.resolve_metadata().await.unwrap_err(); + + let requests = recorder.requests(); + let requested: Vec<_> = requests + .iter() + .map(|request| request.uri.as_str()) + .collect(); + assert_eq!( + requested, + [ + "https://mcp.example.com/", + "https://mcp.example.com/.well-known/oauth-protected-resource", + "https://auth.example.com/.well-known/oauth-authorization-server", + "https://auth.example.com/.well-known/openid-configuration", + ] + ); + } + + #[tokio::test] + async fn resolve_metadata_reports_named_authorization_servers_that_publish_no_metadata() { + let mut responses = vec![ + // the MCP endpoint answers GET with a health payload, not metadata + http_response( + 200, + serde_json::json!({"status": "healthy", "message": "MCP server is running"}), + ), + // the document names two authorization servers + http_response( + 200, + serde_json::json!({ + "resource": "https://mcp.example.com/", + "authorization_servers": ["https://auth.example.com", "https://sso.example.com"] + }), + ), + ]; + // neither publishes metadata; the surplus 404s would let the run reach the + // resource host's own well-known urls and the legacy endpoints if it kept going + responses.extend(std::iter::repeat_with(|| empty_response(404)).take(10)); + let client = RecordingOAuthHttpClient::with_responses(responses); + let recorder = client.clone(); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/", + Arc::new(client), + ) + .await + .unwrap(); + + let error = manager.resolve_metadata().await.unwrap_err(); + + assert_eq!( + error.to_string(), + "Metadata error: protected resource metadata at https://mcp.example.com/.well-known/oauth-protected-resource names authorization servers https://auth.example.com, https://sso.example.com, but none published usable metadata" + ); + let requests = recorder.requests(); + let requested: Vec<_> = requests + .iter() + .map(|request| request.uri.as_str()) + .collect(); + assert_eq!( + requested, + [ + "https://mcp.example.com/", + "https://mcp.example.com/.well-known/oauth-protected-resource", + "https://auth.example.com/.well-known/oauth-authorization-server", + "https://auth.example.com/.well-known/openid-configuration", + "https://sso.example.com/.well-known/oauth-authorization-server", + "https://sso.example.com/.well-known/openid-configuration", + ] + ); + } + + #[tokio::test] + async fn resolve_metadata_keeps_falling_back_when_the_document_names_no_authorization_server() { + let mut responses = vec![ + // the MCP endpoint answers GET with a health payload, not metadata + http_response( + 200, + serde_json::json!({"status": "healthy", "message": "MCP server is running"}), + ), + // the document says nothing about where to authorize + http_response( + 200, + serde_json::json!({"resource": "https://mcp.example.com/"}), + ), + ]; + responses.extend(std::iter::repeat_with(|| empty_response(404)).take(10)); + let client = RecordingOAuthHttpClient::with_responses(responses); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/", + Arc::new(client), + ) + .await + .unwrap(); + + let resolution = manager.resolve_metadata().await.unwrap(); + + assert_eq!( + resolution.source, + AuthorizationMetadataSource::LegacyEndpointFallback + ); + } + + #[tokio::test] + async fn resolve_metadata_tries_the_next_candidate_past_a_pointer_found_while_guessing() { + let challenge = oauth2::http::Response::builder() + .status(401) + .header( + "www-authenticate", + r#"Bearer resource_metadata="https://mcp.example.com/prm""#, + ) + .body(Vec::new()) + .unwrap(); + let client = RecordingOAuthHttpClient::with_responses(vec![ + // the MCP endpoint answers GET with a health payload, not metadata + http_response( + 200, + serde_json::json!({"status": "healthy", "message": "MCP server is running"}), + ), + // auth sits in front of the first candidate and its challenge names a url + challenge, + // which serves something that is not the document + http_response(200, serde_json::json!({})), + // the second candidate carries the real document + http_response( + 200, + serde_json::json!({ + "resource": "https://mcp.example.com/mcp", + "authorization_servers": ["https://auth.example.com"] + }), + ), + http_response( + 200, + serde_json::json!({ + "issuer": "https://auth.example.com", + "authorization_endpoint": "https://auth.example.com/authorize", + "token_endpoint": "https://auth.example.com/token" + }), + ), + ]); + let recorder = client.clone(); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client), + ) + .await + .unwrap(); + + let resolution = manager.resolve_metadata().await.unwrap(); + + assert_eq!( + ( + resolution.source, + resolution.metadata.token_endpoint.as_str(), + ), + ( + AuthorizationMetadataSource::ProtectedResourceMetadata, + "https://auth.example.com/token", + ) + ); + let requests = recorder.requests(); + let requested: Vec<_> = requests + .iter() + .map(|request| request.uri.as_str()) + .collect(); + assert_eq!( + requested, + [ + "https://mcp.example.com/mcp", + "https://mcp.example.com/.well-known/oauth-protected-resource/mcp", + "https://mcp.example.com/prm", + "https://mcp.example.com/mcp/.well-known/oauth-protected-resource", + "https://auth.example.com/.well-known/oauth-authorization-server", + ] + ); + } + + #[rstest] + #[case::protected_resource_metadata( + AuthorizationMetadataSource::ProtectedResourceMetadata, + true + )] + #[case::authorization_server_metadata( + AuthorizationMetadataSource::AuthorizationServerMetadata, + true + )] + #[case::legacy_endpoint_fallback(AuthorizationMetadataSource::LegacyEndpointFallback, false)] + fn is_discovered_is_false_only_for_the_legacy_fallback( + #[case] source: AuthorizationMetadataSource, + #[case] expected: bool, + ) { + assert_eq!(source.is_discovered(), expected); + } + + fn preregistered_as_metadata_response() -> HttpResponse { + http_response( + 200, + serde_json::json!({ + "issuer": "https://auth.example.com", + "authorization_endpoint": "https://auth.example.com/authorize", + "token_endpoint": "https://auth.example.com/token", + "registration_endpoint": "https://auth.example.com/register", + "scopes_supported": ["read", "write", "offline_access"] + }), + ) + } + + /// discovery responses for the preregistered-client tests: a 401 challenge + /// pointing at protected resource metadata, the PRM document, then the + /// authorization server metadata. + fn preregistered_discovery_responses() -> Vec { + let challenge = oauth2::http::Response::builder() + .status(401) + .header( + "www-authenticate", + r#"Bearer resource_metadata="https://mcp.example.com/.well-known/oauth-protected-resource""#, + ) + .body(Vec::new()) + .unwrap(); + vec![ + challenge, + http_response( + 200, + serde_json::json!({ + "resource": "https://mcp.example.com/mcp", + "authorization_servers": ["https://auth.example.com"] + }), + ), + preregistered_as_metadata_response(), + ] + } + + fn auth_url_query(auth_url: &str) -> HashMap { + Url::parse(auth_url) + .unwrap() + .query_pairs() + .map(|(k, v)| (k.into_owned(), v.into_owned())) + .collect() + } + + #[tokio::test] + async fn preregistered_client_skips_registration_endpoint() { + let client = RecordingOAuthHttpClient::with_responses(preregistered_discovery_responses()); + let mut state = super::OAuthState::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let request = AuthorizationRequest::new("http://localhost:8080/callback") + .with_preregistered_client("preregistered-client") + .with_client_secret("secret") + .with_scopes(["read"]); + state.start_authorization(request).await.unwrap(); + + // the registration endpoint was advertised but must not be called + let requests = client.requests(); + assert!( + requests + .iter() + .all(|request| !request.uri.contains("/register")), + "registration endpoint should not be called: {requests:?}" + ); + + let auth_url = state.get_authorization_url().await.unwrap(); + let query = auth_url_query(&auth_url); + assert_eq!(query.get("client_id").unwrap(), "preregistered-client"); + assert!(matches!(state, super::OAuthState::Session(_))); + } + + #[tokio::test] + async fn preregistered_client_uses_metadata_resource_when_server_url_has_query() { + let client = RecordingOAuthHttpClient::with_responses(preregistered_discovery_responses()); + let mut state = super::OAuthState::new_with_oauth_http_client( + "https://mcp.example.com/mcp?oauth=initialize", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let request = AuthorizationRequest::new("http://localhost:8080/callback") + .with_preregistered_client("preregistered-client"); + state.start_authorization(request).await.unwrap(); + + let auth_url = state.get_authorization_url().await.unwrap(); + let query = auth_url_query(&auth_url); + assert_eq!( + query.get("resource").map(String::as_str), + Some("https://mcp.example.com/mcp") + ); + assert_eq!( + client.requests()[0].uri, + "https://mcp.example.com/mcp?oauth=initialize" + ); + } + + #[tokio::test] + async fn authorization_session_selects_default_scopes_when_none_provided() { + let client = RecordingOAuthHttpClient::with_responses(preregistered_discovery_responses()); + let mut manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client), + ) + .await + .unwrap(); + manager.metadata = Some(manager.resolve_metadata().await.unwrap().metadata); + + let request = AuthorizationRequest::new("http://localhost:8080/callback") + .with_preregistered_client("preregistered-client"); + let session = match AuthorizationSession::new(manager, request).await { + Ok(session) => session, + Err((_, error)) => panic!("authorization session creation failed: {error}"), + }; + + // Empty request scopes fall back to the discovered scopes_supported. + let query = auth_url_query(&session.auth_url); + assert_eq!(query.get("scope").unwrap(), "read write offline_access"); + } + + #[tokio::test] + async fn preregistered_client_uses_explicit_scopes_and_adds_offline_access() { + let client = RecordingOAuthHttpClient::with_responses(preregistered_discovery_responses()); + let mut state = super::OAuthState::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let request = AuthorizationRequest::new("http://localhost:8080/callback") + .with_preregistered_client("preregistered-client") + .with_scopes(["read"]); + state.start_authorization(request).await.unwrap(); + + // explicit scopes are preserved; offline_access is appended per SEP-2207 + let auth_url = state.get_authorization_url().await.unwrap(); + let query = auth_url_query(&auth_url); + assert_eq!(query.get("scope").unwrap(), "read offline_access"); + } + + #[tokio::test] + async fn preregistered_client_recovers_unauthorized_state_after_discovery_failure() { + // first discovery attempt fails: protected resource metadata reports a + // mismatched resource identifier, which discover_metadata rejects + let challenge = oauth2::http::Response::builder() + .status(401) + .header( + "www-authenticate", + r#"Bearer resource_metadata="https://mcp.example.com/.well-known/oauth-protected-resource""#, + ) + .body(Vec::new()) + .unwrap(); + let client = RecordingOAuthHttpClient::with_responses(vec![ + challenge, + http_response( + 200, + serde_json::json!({ + "resource": "https://other.example.com/mcp", + "authorization_servers": ["https://auth.example.com"] + }), + ), + ]); + let mut state = super::OAuthState::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let request = AuthorizationRequest::new("http://localhost:8080/callback") + .with_preregistered_client("preregistered-client") + .with_scopes(["read"]); + let err = state + .start_authorization(request.clone()) + .await + .unwrap_err(); + assert!(!matches!(err, AuthError::InternalError(_)), "{err:?}"); + assert!( + matches!(state, super::OAuthState::Unauthorized(_)), + "state should return to Unauthorized after a transient failure" + ); + + // retrying with the same state succeeds once the server responds + client + .responses + .lock() + .unwrap() + .extend(preregistered_discovery_responses()); + state.start_authorization(request).await.unwrap(); + assert!(matches!(state, super::OAuthState::Session(_))); + } + + fn cimd_as_metadata_response() -> HttpResponse { + http_response( + 200, + serde_json::json!({ + "issuer": "https://auth.example.com", + "authorization_endpoint": "https://auth.example.com/authorize", + "token_endpoint": "https://auth.example.com/token", + "registration_endpoint": "https://auth.example.com/register", + "scopes_supported": ["read", "write", "offline_access"], + "client_id_metadata_document_supported": true + }), + ) + } + + /// discovery responses like [`preregistered_discovery_responses`] but the + /// authorization server advertises CIMD support. + fn cimd_discovery_responses() -> Vec { + let challenge = oauth2::http::Response::builder() + .status(401) + .header( + "www-authenticate", + r#"Bearer resource_metadata="https://mcp.example.com/.well-known/oauth-protected-resource""#, + ) + .body(Vec::new()) + .unwrap(); + vec![ + challenge, + http_response( + 200, + serde_json::json!({ + "resource": "https://mcp.example.com/mcp", + "authorization_servers": ["https://auth.example.com"] + }), + ), + cimd_as_metadata_response(), + ] + } + + #[tokio::test] + async fn preregistered_client_takes_priority_over_cimd() { + // server supports CIMD and the request carries both pre-registered + // credentials and a client metadata URL: pre-registration wins + let client = RecordingOAuthHttpClient::with_responses(cimd_discovery_responses()); + let mut state = super::OAuthState::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let request = AuthorizationRequest::new("http://localhost:8080/callback") + .with_preregistered_client("preregistered-client") + .with_client_metadata_url("https://client.example.com/client-metadata.json") + .with_scopes(["read"]); + state.start_authorization(request).await.unwrap(); + + let requests = client.requests(); + assert!( + requests + .iter() + .all(|request| !request.uri.contains("/register")), + "registration endpoint should not be called: {requests:?}" + ); + let auth_url = state.get_authorization_url().await.unwrap(); + let query = auth_url_query(&auth_url); + assert_eq!(query.get("client_id").unwrap(), "preregistered-client"); + } + + #[tokio::test] + async fn cimd_used_when_server_advertises_support() { + let client = RecordingOAuthHttpClient::with_responses(cimd_discovery_responses()); + let mut state = super::OAuthState::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let request = AuthorizationRequest::new("http://localhost:8080/callback") + .with_client_metadata_url("https://client.example.com/client-metadata.json") + .with_scopes(["read"]); + state.start_authorization(request).await.unwrap(); + + // CIMD takes priority over the advertised registration endpoint + let requests = client.requests(); + assert!( + requests + .iter() + .all(|request| !request.uri.contains("/register")), + "registration endpoint should not be called: {requests:?}" + ); + let auth_url = state.get_authorization_url().await.unwrap(); + let query = auth_url_query(&auth_url); + assert_eq!( + query.get("client_id").unwrap(), + "https://client.example.com/client-metadata.json" + ); + } + + #[tokio::test] + async fn cimd_falls_back_to_dcr_when_server_lacks_support() { + // server does not advertise client_id_metadata_document_supported, so + // the client metadata URL is ignored and DCR is used instead + let mut responses = preregistered_discovery_responses(); + responses.push(http_response( + 201, + serde_json::json!({ + "client_id": "dcr-client", + "redirect_uris": ["http://localhost:8080/callback"] + }), + )); + let client = RecordingOAuthHttpClient::with_responses(responses); + let mut state = super::OAuthState::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let request = AuthorizationRequest::new("http://localhost:8080/callback") + .with_client_metadata_url("https://client.example.com/client-metadata.json") + .with_scopes(["read"]); + state.start_authorization(request).await.unwrap(); + + let requests = client.requests(); + assert!( + requests + .iter() + .any(|request| request.uri.contains("/register")), + "registration endpoint should be called: {requests:?}" + ); + let auth_url = state.get_authorization_url().await.unwrap(); + let query = auth_url_query(&auth_url); + assert_eq!(query.get("client_id").unwrap(), "dcr-client"); + } + + #[tokio::test] + async fn dcr_used_when_no_identity_material_is_provided() { + let mut responses = preregistered_discovery_responses(); + responses.push(http_response( + 201, + serde_json::json!({ + "client_id": "dcr-client", + "redirect_uris": ["http://localhost:8080/callback"] + }), + )); + let client = RecordingOAuthHttpClient::with_responses(responses); + let mut state = super::OAuthState::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let request = AuthorizationRequest::new("http://localhost:8080/callback") + .with_client_name("test-client") + .with_scopes(["read"]); + state.start_authorization(request).await.unwrap(); + + let auth_url = state.get_authorization_url().await.unwrap(); + let query = auth_url_query(&auth_url); + assert_eq!(query.get("client_id").unwrap(), "dcr-client"); + assert!(matches!(state, super::OAuthState::Session(_))); + } + + #[tokio::test] + async fn dcr_registration_uses_requested_application_type() { + let mut responses = preregistered_discovery_responses(); + responses.push(http_response( + 201, + serde_json::json!({ + "client_id": "dcr-client", + "redirect_uris": ["http://localhost:8080/callback"] + }), + )); + let client = RecordingOAuthHttpClient::with_responses(responses); + let mut state = super::OAuthState::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let request = AuthorizationRequest::new("http://localhost:8080/callback") + .with_client_name("test-client") + .with_application_type("web") + .with_scopes(["read"]); + state.start_authorization(request).await.unwrap(); + + // SEP-837: the requested application_type must be sent in the DCR request + let requests = client.requests(); + let registration = requests + .iter() + .find(|request| request.uri.contains("/register")) + .expect("registration endpoint should be called"); + let body: serde_json::Value = serde_json::from_slice(®istration.body).unwrap(); + assert_eq!(body.get("application_type").unwrap(), "web"); + } + + #[tokio::test] + async fn cimd_rejects_non_https_client_metadata_url_and_recovers_state() { + let client = RecordingOAuthHttpClient::with_responses(cimd_discovery_responses()); + let mut state = super::OAuthState::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let request = AuthorizationRequest::new("http://localhost:8080/callback") + .with_client_metadata_url("http://client.example.com/client-metadata.json") + .with_scopes(["read"]); + let err = state.start_authorization(request).await.unwrap_err(); + assert!(matches!(err, AuthError::RegistrationFailed(_)), "{err:?}"); + assert!( + matches!(state, super::OAuthState::Unauthorized(_)), + "state should return to Unauthorized after a registration failure" + ); + } + + #[tokio::test] + async fn dcr_recovers_unauthorized_state_after_registration_failure() { + // discovery succeeds, but the registration endpoint rejects the request + let mut responses = preregistered_discovery_responses(); + responses.push(http_response( + 400, + serde_json::json!({"error": "invalid_client_metadata"}), + )); + let client = RecordingOAuthHttpClient::with_responses(responses); + let mut state = super::OAuthState::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let request = AuthorizationRequest::new("http://localhost:8080/callback") + .with_client_name("test-client") + .with_scopes(["read"]); + let err = state + .start_authorization(request.clone()) + .await + .unwrap_err(); + assert!(matches!(err, AuthError::RegistrationFailed(_)), "{err:?}"); + assert!( + matches!(state, super::OAuthState::Unauthorized(_)), + "state should return to Unauthorized after a registration failure" + ); + + // retrying with the same state succeeds once the server accepts + // registration (discovery runs again on retry) + { + let mut responses = client.responses.lock().unwrap(); + responses.extend(preregistered_discovery_responses()); + responses.push_back(http_response( + 201, + serde_json::json!({ + "client_id": "dcr-client", + "redirect_uris": ["http://localhost:8080/callback"] + }), + )); + } + state.start_authorization(request).await.unwrap(); + assert!(matches!(state, super::OAuthState::Session(_))); + } + + #[tokio::test] + async fn discovery_get_follows_same_origin_redirects() { + let client = RecordingOAuthHttpClient::with_responses(vec![ + redirect_response("/redirected"), + http_response(200, serde_json::json!({})), + ]); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let response = manager + .discovery_get(&Url::parse("https://mcp.example.com/start").unwrap()) + .await + .unwrap(); + let requests = client.requests(); + + assert_eq!( + ( + response.status(), + requests + .iter() + .map(|request| request.uri.as_str()) + .collect::>() + ), + ( + oauth2::http::StatusCode::OK, + vec![ + "https://mcp.example.com/start", + "https://mcp.example.com/redirected" + ] + ) + ); + } + + #[tokio::test] + async fn discovery_get_rejects_cross_origin_redirects() { + let client = RecordingOAuthHttpClient::with_responses(vec![redirect_response( + "http://169.254.169.254/", + )]); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let err = manager + .discovery_get(&Url::parse("https://mcp.example.com/start").unwrap()) + .await + .unwrap_err(); + + assert_eq!( + ( + err.to_string().contains("non-same-origin"), + client.requests().len() + ), + (true, 1) + ); + } + + #[tokio::test] + async fn protected_resource_metadata_rejects_private_authorization_server_urls() { + let challenge = oauth2::http::Response::builder() + .status(401) + .header( + "www-authenticate", + r#"Bearer resource_metadata="https://mcp.example.com/.well-known/oauth-protected-resource""#, + ) + .body(Vec::new()) + .unwrap(); + let client = RecordingOAuthHttpClient::with_responses(vec![ + challenge, + http_response( + 200, + serde_json::json!({ + "resource": "https://mcp.example.com/mcp", + "authorization_servers": [ + "http://169.254.169.254/latest/meta-data/", + "http://127.0.0.1:8080/tenant1", + "https://auth.example.com" + ] + }), + ), + http_response( + 200, + serde_json::json!({ + "issuer": "https://auth.example.com", + "authorization_endpoint": "https://auth.example.com/authorize", + "token_endpoint": "https://auth.example.com/token" + }), + ), + ]); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let metadata = manager.resolve_metadata().await.unwrap().metadata; + let requests = client.requests(); + + assert_eq!( + ( + metadata.token_endpoint.as_str(), + requests + .iter() + .map(|request| request.uri.as_str()) + .collect::>() + ), + ( + "https://auth.example.com/token", + vec![ + "https://mcp.example.com/mcp", + "https://mcp.example.com/.well-known/oauth-protected-resource", + "https://auth.example.com/.well-known/oauth-authorization-server" + ] + ) + ); + } + + #[tokio::test] + async fn allows_loopback_authorization_server_when_resource_is_loopback() { + let challenge = oauth2::http::Response::builder() + .status(401) + .header( + "www-authenticate", + r#"Bearer resource_metadata="http://localhost/custom-metadata.json""#, + ) + .body(Vec::new()) + .unwrap(); + let client = RecordingOAuthHttpClient::with_responses(vec![ + challenge, + http_response( + 200, + serde_json::json!({ + "resource": "http://localhost/mcp", + "authorization_servers": ["http://127.0.0.1:8080/tenant1"] + }), + ), + http_response( + 200, + serde_json::json!({ + "issuer": "http://127.0.0.1:8080/tenant1", + "authorization_endpoint": "http://127.0.0.1:8080/tenant1/authorize", + "token_endpoint": "http://127.0.0.1:8080/tenant1/token" + }), + ), + ]); + let manager = AuthorizationManager::new_with_oauth_http_client( + "http://localhost/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let metadata = manager.resolve_metadata().await.unwrap().metadata; + + assert_eq!( + ( + metadata.issuer.as_deref(), + client + .requests() + .iter() + .map(|request| request.uri.as_str()) + .collect::>(), + ), + ( + Some("http://127.0.0.1:8080/tenant1"), + vec![ + "http://localhost/mcp", + "http://localhost/custom-metadata.json", + "http://127.0.0.1:8080/.well-known/oauth-authorization-server/tenant1", + ], + ) + ); + } + + #[tokio::test] + async fn protected_resource_discovery_rejects_mismatched_resource() { + let challenge = oauth2::http::Response::builder() + .status(401) + .header( + "www-authenticate", + r#"Bearer resource_metadata="https://mcp.example.com/.well-known/oauth-protected-resource""#, + ) + .body(Vec::new()) + .unwrap(); + let client = RecordingOAuthHttpClient::with_responses(vec![ + challenge, + http_response( + 200, + serde_json::json!({ + "resource": "https://real.example.com/mcp", + "authorization_servers": ["https://auth.example.com"] + }), + ), + ]); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let error = manager.resolve_metadata().await.unwrap_err(); + + assert!( + matches!(error, AuthError::MetadataError(ref message) if message.contains("resource mismatch")), + "expected resource mismatch metadata error, got: {error:?}" + ); + assert_eq!(client.requests().len(), 2); + } + + #[tokio::test] + async fn protected_resource_discovery_rejects_missing_resource() { + let challenge = oauth2::http::Response::builder() + .status(401) + .header( + "www-authenticate", + r#"Bearer resource_metadata="https://mcp.example.com/.well-known/oauth-protected-resource""#, + ) + .body(Vec::new()) + .unwrap(); + let client = RecordingOAuthHttpClient::with_responses(vec![ + challenge, + http_response( + 200, + serde_json::json!({ + "authorization_servers": ["https://auth.example.com"] + }), + ), + ]); + let manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + + let error = manager.resolve_metadata().await.unwrap_err(); + + assert!( + matches!(error, AuthError::MetadataError(ref message) if message.contains("missing required resource")), + "expected missing resource metadata error, got: {error:?}" + ); + assert_eq!(client.requests().len(), 2); + } + + #[test] + fn resource_identifier_matching_allows_matching_host_or_parent_path() { + assert!(AuthorizationManager::is_resource_identifier_valid( + &Url::parse("https://mcp.example.com/").unwrap(), + &Url::parse("https://mcp.example.com").unwrap() + )); + assert!(AuthorizationManager::is_resource_identifier_valid( + &Url::parse("https://mcp.example.com").unwrap(), + &Url::parse("https://mcp.example.com/").unwrap() + )); + assert!(AuthorizationManager::is_resource_identifier_valid( + &Url::parse("https://mcp.example.com/mcp").unwrap(), + &Url::parse("https://mcp.example.com").unwrap() + )); + assert!(AuthorizationManager::is_resource_identifier_valid( + &Url::parse("https://mcp.example.com/mcp/tools").unwrap(), + &Url::parse("https://mcp.example.com/mcp").unwrap() + )); + assert!(AuthorizationManager::is_resource_identifier_valid( + &Url::parse("https://mcp.example.com/mcp?query=param").unwrap(), + &Url::parse("https://mcp.example.com/mcp?query=param").unwrap() + )); + assert!(AuthorizationManager::is_resource_identifier_valid( + &Url::parse("https://mcp.example.com/mcp?oauth=initialize").unwrap(), + &Url::parse("https://mcp.example.com/mcp").unwrap() + )); + assert!(AuthorizationManager::is_resource_identifier_valid( + &Url::parse("https://mcp.example.com/mcp").unwrap(), + &Url::parse("https://mcp.example.com/mcp?query=value1").unwrap() + )); + assert!(AuthorizationManager::is_resource_identifier_valid( + &Url::parse("https://mcp.example.com/mcp?query=value1").unwrap(), + &Url::parse("https://mcp.example.com/mcp?query=value2").unwrap() + )); + assert!(AuthorizationManager::is_resource_identifier_valid( + &Url::parse("https://mcp.example.com/mcp/tools?oauth=initialize").unwrap(), + &Url::parse("https://mcp.example.com/mcp?query=value1").unwrap() + )); + + assert!(!AuthorizationManager::is_resource_identifier_valid( + &Url::parse("https://mcp.example.com/mcp").unwrap(), + &Url::parse("https://mcp.example.com/mcp/").unwrap() + )); + assert!(!AuthorizationManager::is_resource_identifier_valid( + &Url::parse("https://mcp.example.com/mcp-tools").unwrap(), + &Url::parse("https://mcp.example.com/mcp").unwrap() + )); + assert!(!AuthorizationManager::is_resource_identifier_valid( + &Url::parse("https://mcp.example.com/mcp").unwrap(), + &Url::parse("https://mcp.example.com/mcp-tools").unwrap() + )); + assert!(!AuthorizationManager::is_resource_identifier_valid( + &Url::parse("https://mcp.example.com/mcp").unwrap(), + &Url::parse("https://mcp.example.com/mcp/tools").unwrap() + )); + assert!(!AuthorizationManager::is_resource_identifier_valid( + &Url::parse("https://mcp.example.com/mcp").unwrap(), + &Url::parse("https://real.example.com/mcp").unwrap() + )); + assert!(!AuthorizationManager::is_resource_identifier_valid( + &Url::parse("https://mcp.example.com/mcp-tools?oauth=initialize").unwrap(), + &Url::parse("https://mcp.example.com/mcp?query=value1").unwrap() + )); + assert!(!AuthorizationManager::is_resource_identifier_valid( + &Url::parse("https://mcp.example.com/mcp?oauth=initialize").unwrap(), + &Url::parse("https://real.example.com/mcp?oauth=initialize").unwrap() + )); + } + + #[tokio::test] + async fn custom_http_client_handles_registration_exchange_and_refresh() { + let client = RecordingOAuthHttpClient::with_responses(vec![ + http_response( + 201, + serde_json::json!({ + "client_id": "test-client", + "redirect_uris": ["http://localhost/callback"] + }), + ), + http_response( + 200, + serde_json::json!({ + "access_token": "access-1", + "token_type": "bearer", + "refresh_token": "refresh-1", + "expires_in": 3600 + }), + ), + http_response( + 200, + serde_json::json!({ + "access_token": "access-2", + "token_type": "bearer", + "refresh_token": "refresh-2", + "expires_in": 3600 + }), + ), + ]); + let mut manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + manager.set_metadata(AuthorizationMetadata { + authorization_endpoint: "https://auth.example.com/authorize".to_string(), + token_endpoint: "https://auth.example.com/token".to_string(), + registration_endpoint: Some("https://auth.example.com/register".to_string()), + response_types_supported: Some(vec!["code".to_string()]), + ..Default::default() + }); + manager + .register_client( + "Codex", + "http://localhost/callback", + &["profile", "offline_access"], + ) + .await + .unwrap(); + let authorization_url = manager + .get_authorization_url(&["profile", "offline_access"]) + .await + .unwrap(); + let state = Url::parse(&authorization_url) + .unwrap() + .query_pairs() + .find(|(name, _)| name == "state") + .unwrap() + .1 + .into_owned(); + + manager + .exchange_code_for_token("authorization-code", &state) + .await + .unwrap(); + manager.refresh_token().await.unwrap(); + + let requests = client.requests(); + let registration: serde_json::Value = serde_json::from_slice(&requests[0].body).unwrap(); + assert_eq!(registration["scope"], "profile offline_access"); + assert_eq!( + requests + .iter() + .map(|request| request.uri.as_str()) + .collect::>(), + vec![ + "https://auth.example.com/register", + "https://auth.example.com/token", + "https://auth.example.com/token", + ] + ); + assert_eq!( + requests + .iter() + .map(|request| request.redirect_policy) + .collect::>(), + vec![ + OAuthHttpRedirectPolicy::Follow, + OAuthHttpRedirectPolicy::Stop, + OAuthHttpRedirectPolicy::Stop, + ] + ); + } + + // -- url helpers -- + + #[test] + fn test_is_https_url_scenarios() { + assert!(is_https_url("https://example.com/client-metadata.json")); + assert!(is_https_url("https://example.com/metadata?version=1")); + assert!(!is_https_url("https://example.com")); + assert!(!is_https_url("https://example.com/")); + assert!(!is_https_url("https://")); + assert!(!is_https_url("http://example.com/metadata")); + assert!(!is_https_url("not a url")); + assert!(!is_https_url("")); + assert!(!is_https_url("javascript:alert(1)")); + assert!(!is_https_url("data:text/html,")); + } + + // -- well-known path generation -- + + #[test] + fn well_known_paths_root() { + let paths = AuthorizationManager::well_known_paths("/", "oauth-authorization-server"); + assert_eq!( + paths, + vec!["/.well-known/oauth-authorization-server".to_string()] + ); + } + + #[test] + fn well_known_paths_with_suffix() { + let paths = AuthorizationManager::well_known_paths("/mcp", "oauth-authorization-server"); + assert_eq!( + paths, + vec![ + "/.well-known/oauth-authorization-server/mcp".to_string(), + "/mcp/.well-known/oauth-authorization-server".to_string(), + "/.well-known/oauth-authorization-server".to_string(), + ] + ); + } + + #[test] + fn well_known_paths_trailing_slash() { + let paths = + AuthorizationManager::well_known_paths("/v1/mcp/", "oauth-authorization-server"); + assert_eq!( + paths, + vec![ + "/.well-known/oauth-authorization-server/v1/mcp".to_string(), + "/v1/mcp/.well-known/oauth-authorization-server".to_string(), + "/.well-known/oauth-authorization-server".to_string(), + ] + ); + } + + #[test] + fn test_protected_resource_metadata_paths() { + let paths = + AuthorizationManager::well_known_paths("/mcp/example", "oauth-protected-resource"); + assert!(paths.contains(&"/.well-known/oauth-protected-resource/mcp/example".to_string())); + assert!(paths.contains(&"/.well-known/oauth-protected-resource".to_string())); + } + + // -- discovery url generation -- + + #[test] + fn generate_discovery_urls() { + let base_url = Url::parse("https://auth.example.com").unwrap(); + let urls = AuthorizationManager::generate_discovery_urls(&base_url); + assert_eq!(urls.len(), 2); + assert_eq!( + urls[0].as_str(), + "https://auth.example.com/.well-known/oauth-authorization-server" + ); + assert_eq!( + urls[1].as_str(), + "https://auth.example.com/.well-known/openid-configuration" + ); + + let base_url = Url::parse("https://auth.example.com/tenant1").unwrap(); + let urls = AuthorizationManager::generate_discovery_urls(&base_url); + assert_eq!(urls.len(), 4); + assert_eq!( + urls[0].as_str(), + "https://auth.example.com/.well-known/oauth-authorization-server/tenant1" + ); + assert_eq!( + urls[1].as_str(), + "https://auth.example.com/.well-known/openid-configuration/tenant1" + ); + assert_eq!( + urls[2].as_str(), + "https://auth.example.com/tenant1/.well-known/openid-configuration" + ); + assert_eq!( + urls[3].as_str(), + "https://auth.example.com/.well-known/oauth-authorization-server" + ); + + let base_url = Url::parse("https://auth.example.com/v1/mcp/").unwrap(); + let urls = AuthorizationManager::generate_discovery_urls(&base_url); + assert_eq!(urls.len(), 4); + assert_eq!( + urls[0].as_str(), + "https://auth.example.com/.well-known/oauth-authorization-server/v1/mcp" + ); + assert_eq!( + urls[1].as_str(), + "https://auth.example.com/.well-known/openid-configuration/v1/mcp" + ); + assert_eq!( + urls[2].as_str(), + "https://auth.example.com/v1/mcp/.well-known/openid-configuration" + ); + assert_eq!( + urls[3].as_str(), + "https://auth.example.com/.well-known/oauth-authorization-server" + ); + + let base_url = Url::parse("https://auth.example.com/tenant1/subtenant").unwrap(); + let urls = AuthorizationManager::generate_discovery_urls(&base_url); + assert_eq!(urls.len(), 4); + assert_eq!( + urls[0].as_str(), + "https://auth.example.com/.well-known/oauth-authorization-server/tenant1/subtenant" + ); + assert_eq!( + urls[1].as_str(), + "https://auth.example.com/.well-known/openid-configuration/tenant1/subtenant" + ); + assert_eq!( + urls[2].as_str(), + "https://auth.example.com/tenant1/subtenant/.well-known/openid-configuration" + ); + assert_eq!( + urls[3].as_str(), + "https://auth.example.com/.well-known/oauth-authorization-server" + ); + } + + #[test] + fn test_discovery_urls_with_path_suffix() { + let base_url = Url::parse("https://mcp.example.com/mcp").unwrap(); + let urls = AuthorizationManager::generate_discovery_urls(&base_url); + + let canonical_oauth_fallback = + "https://mcp.example.com/.well-known/oauth-authorization-server"; + + assert!( + urls.iter().any(|u| u.as_str() == canonical_oauth_fallback), + "Expected discovery URLs to include canonical OAuth fallback '{}', but got: {:?}", + canonical_oauth_fallback, + urls.iter().map(|u| u.as_str()).collect::>() + ); + } + + // -- header value parsing -- + + #[rstest] + #[case::quoted_string(r#""example", realm="foo""#, "example", r#""example""#)] + #[case::escaped_quotes_and_whitespace( + r#" "a\"b\\c" ,next=value"#, + r#"a"b\c"#, + r#" "a\"b\\c""# + )] + #[case::token_values(" token,next", "token", " token")] + #[case::semicolon_separated_tokens( + r#" https://example.com/meta; error="invalid_token""#, + "https://example.com/meta", + " https://example.com/meta" + )] + #[case::semicolon_after_quoted_value( + r#" "https://example.com/meta"; error="invalid_token""#, + "https://example.com/meta", + r#" "https://example.com/meta""# + )] + fn parse_auth_param_value_handles_supported_values( + #[case] fragment: &str, + #[case] expected_value: &str, + #[case] expected_consumed_prefix: &str, + ) { + let (value, consumed) = AuthorizationManager::parse_next_header_value(fragment).unwrap(); + + assert_eq!( + (value.as_str(), &fragment[..consumed]), + (expected_value, expected_consumed_prefix) + ); + } + + #[test] + fn parse_auth_param_value_returns_none_for_unterminated_quotes() { + let fragment = r#""unterminated,value"#; + assert!(AuthorizationManager::parse_next_header_value(fragment).is_none()); + } + + // -- www-authenticate param extraction -- + + #[test] + fn parses_resource_metadata_parameter() { + let header = r#"Bearer error="invalid_request", error_description="missing token", resource_metadata="https://example.com/.well-known/oauth-protected-resource/api""#; + let base = Url::parse("https://example.com/api").unwrap(); + let params = AuthorizationManager::extract_www_authenticate_params(header, &base); + assert_eq!( + params.resource_metadata_url.unwrap().as_str(), + "https://example.com/.well-known/oauth-protected-resource/api" + ); + } + + #[test] + fn parses_relative_resource_metadata_parameter() { + let header = r#"Bearer error="invalid_request", resource_metadata="/.well-known/oauth-protected-resource/api""#; + let base = Url::parse("https://example.com/api").unwrap(); + let params = AuthorizationManager::extract_www_authenticate_params(header, &base); + assert_eq!( + params.resource_metadata_url.unwrap().as_str(), + "https://example.com/.well-known/oauth-protected-resource/api" + ); + } + + #[test] + fn rejects_cross_origin_resource_metadata_parameter() { + let header = r#"Bearer error="invalid_request", resource_metadata="http://169.254.169.254/latest/meta-data/", scope="read""#; + let base = Url::parse("https://example.com/api").unwrap(); + let params = AuthorizationManager::extract_www_authenticate_params(header, &base); + + assert!(params.resource_metadata_url.is_none()); + assert_eq!(params.scope.unwrap(), "read"); + } + + #[test] + fn rejects_non_http_resource_metadata_parameter() { + let header = r#"Bearer resource_metadata="file:///etc/passwd""#; + let base = Url::parse("https://example.com/api").unwrap(); + let params = AuthorizationManager::extract_www_authenticate_params(header, &base); + + assert!(params.resource_metadata_url.is_none()); + } + + #[test] + fn extract_www_authenticate_params_with_all_fields() { + let header = r#"Bearer error="invalid_token", resource_metadata="https://example.com/.well-known/oauth-protected-resource", scope="read:data write:data", error_description="token expired""#; + let base = Url::parse("https://example.com/api").unwrap(); + let params = AuthorizationManager::extract_www_authenticate_params(header, &base); + + assert_eq!( + params.resource_metadata_url.unwrap().as_str(), + "https://example.com/.well-known/oauth-protected-resource" + ); + assert_eq!(params.scope.unwrap(), "read:data write:data"); + assert_eq!(params.error.unwrap(), "invalid_token"); + assert_eq!(params.error_description.unwrap(), "token expired"); + } + + #[test] + fn extract_www_authenticate_params_insufficient_scope() { + let header = r#"Bearer error="insufficient_scope", scope="admin:write", error_description="Additional file write permission required""#; + let base = Url::parse("https://example.com/api").unwrap(); + let params = AuthorizationManager::extract_www_authenticate_params(header, &base); + + assert!(params.resource_metadata_url.is_none()); + assert!(params.is_insufficient_scope()); + assert!(!params.is_invalid_token()); + assert_eq!(params.scope.unwrap(), "admin:write"); + assert_eq!( + params.error_description.unwrap(), + "Additional file write permission required" + ); + } + + #[test] + fn extract_www_authenticate_params_with_only_resource_metadata() { + let header = r#"Bearer resource_metadata="/.well-known/oauth-protected-resource""#; + let base = Url::parse("https://example.com/api").unwrap(); + let params = AuthorizationManager::extract_www_authenticate_params(header, &base); + + assert_eq!( + params.resource_metadata_url.unwrap().as_str(), + "https://example.com/.well-known/oauth-protected-resource" + ); + assert!(params.scope.is_none()); + } + + #[test] + fn extract_www_authenticate_params_bare_bearer() { + let header = "Bearer"; + let base = Url::parse("https://example.com/api").unwrap(); + let params = AuthorizationManager::extract_www_authenticate_params(header, &base); + + assert!(params.resource_metadata_url.is_none()); + assert!(params.scope.is_none()); + assert!(params.error.is_none()); + assert!(params.error_description.is_none()); + } + + #[test] + fn extract_www_authenticate_params_error_only() { + let header = r#"Bearer error="invalid_token""#; + let base = Url::parse("https://example.com/api").unwrap(); + let params = AuthorizationManager::extract_www_authenticate_params(header, &base); + + assert!(params.resource_metadata_url.is_none()); + assert!(params.scope.is_none()); + assert!(params.is_invalid_token()); + assert!(!params.is_insufficient_scope()); + assert!(params.error_description.is_none()); + } + + #[test] + fn extract_www_authenticate_params_with_unquoted_scope() { + let header = r#"Bearer scope=read:data, error="insufficient_scope""#; + let base = Url::parse("https://example.com/api").unwrap(); + let params = AuthorizationManager::extract_www_authenticate_params(header, &base); + + assert_eq!(params.scope.unwrap(), "read:data"); + } + + // -- stored authorization state -- + + #[test] + fn test_stored_authorization_state_serialization() { + let pkce = PkceCodeVerifier::new("my-verifier".to_string()); + let csrf = CsrfToken::new("my-csrf".to_string()); + let state = StoredAuthorizationState::new(&pkce, &csrf) + .with_requested_scopes(vec!["read".to_string(), "write".to_string()]); + + let json = serde_json::to_string(&state).unwrap(); + let deserialized: StoredAuthorizationState = serde_json::from_str(&json).unwrap(); + + assert_eq!(deserialized.pkce_verifier, "my-verifier"); + assert_eq!(deserialized.csrf_token, "my-csrf"); + assert_eq!(deserialized.requested_scopes, vec!["read", "write"]); + assert_eq!(deserialized.expected_issuer, None); + assert!(!deserialized.require_issuer); + } + + #[test] + fn stored_authorization_state_defaults_requested_scopes_when_absent() { + let json = r#"{"pkce_verifier":"v","csrf_token":"c","created_at":1}"#; + let state: StoredAuthorizationState = serde_json::from_str(json).unwrap(); + + assert!(state.requested_scopes.is_empty()); + } + + #[test] + fn test_stored_authorization_state_records_expected_issuer() { + let pkce = PkceCodeVerifier::new("my-verifier".to_string()); + let csrf = CsrfToken::new("my-csrf".to_string()); + let state = StoredAuthorizationState::new_with_expected_issuer( + &pkce, + &csrf, + Some("https://auth.example.com".to_string()), + false, + ); + + let json = serde_json::to_string(&state).unwrap(); + let deserialized: StoredAuthorizationState = serde_json::from_str(&json).unwrap(); + + assert_eq!( + deserialized.expected_issuer.as_deref(), + Some("https://auth.example.com") + ); + assert!(!deserialized.require_issuer); + } + + #[test] + fn test_stored_authorization_state_debug_redacts_secrets() { + let pkce = PkceCodeVerifier::new("super-secret-verifier".to_string()); + let csrf = CsrfToken::new("super-secret-csrf".to_string()); + let state = StoredAuthorizationState::new(&pkce, &csrf); + let debug_output = format!("{:?}", state); + + assert!(!debug_output.contains("super-secret-verifier")); + assert!(!debug_output.contains("super-secret-csrf")); + assert!(debug_output.contains("[REDACTED]")); + assert!(debug_output.contains("expected_issuer")); + assert!(debug_output.contains("created_at")); + } + + #[test] + fn test_stored_credentials_debug_redacts_token_response() { + use oauth2::{AccessToken, basic::BasicTokenType}; + + use super::{OAuthTokenResponse, StoredCredentials}; + + let token_response = OAuthTokenResponse::new( + AccessToken::new("super-secret-access-token".to_string()), + BasicTokenType::Bearer, + VendorExtraTokenFields::default(), + ); + let creds = StoredCredentials { + client_id: "my-client".to_string(), + token_response: Some(token_response), + granted_scopes: vec![], + token_received_at: None, + issuer: None, + }; + let debug_output = format!("{:?}", creds); + + assert!(!debug_output.contains("super-secret-access-token")); + assert!(debug_output.contains("[REDACTED]")); + assert!(debug_output.contains("my-client")); + } + + #[test] + fn test_stored_authorization_state_into_pkce_verifier() { + let pkce = PkceCodeVerifier::new("original-verifier".to_string()); + let csrf = CsrfToken::new("csrf-token".to_string()); + let state = StoredAuthorizationState::new(&pkce, &csrf); + + let recovered = state.into_pkce_verifier(); + assert_eq!(recovered.secret(), "original-verifier"); + } + + #[test] + fn test_stored_authorization_state_created_at() { + let pkce = PkceCodeVerifier::new("verifier".to_string()); + let csrf = CsrfToken::new("csrf".to_string()); + let state = StoredAuthorizationState::new(&pkce, &csrf); + + assert!(state.created_at > 1577836800); // Jan 1, 2020 + } + + // -- state store -- + + #[tokio::test] + async fn test_in_memory_state_store_save_and_load() { + let store = InMemoryStateStore::new(); + let pkce = PkceCodeVerifier::new("test-verifier".to_string()); + let csrf = CsrfToken::new("test-csrf".to_string()); + let state = StoredAuthorizationState::new(&pkce, &csrf); + + store.save("test-csrf", state).await.unwrap(); + + let loaded = store.load("test-csrf").await.unwrap(); + assert!(loaded.is_some()); + let loaded = loaded.unwrap(); + assert_eq!(loaded.csrf_token, "test-csrf"); + assert_eq!(loaded.pkce_verifier, "test-verifier"); + } + + #[tokio::test] + async fn test_in_memory_state_store_load_nonexistent() { + let store = InMemoryStateStore::new(); + let result = store.load("nonexistent").await.unwrap(); + assert!(result.is_none()); + } + + #[tokio::test] + async fn test_in_memory_state_store_delete() { + let store = InMemoryStateStore::new(); + let pkce = PkceCodeVerifier::new("verifier".to_string()); + let csrf = CsrfToken::new("csrf".to_string()); + let state = StoredAuthorizationState::new(&pkce, &csrf); + + store.save("csrf", state).await.unwrap(); + store.delete("csrf").await.unwrap(); + + let result = store.load("csrf").await.unwrap(); + assert!(result.is_none()); + } + + #[tokio::test] + async fn test_in_memory_state_store_overwrite() { + let store = InMemoryStateStore::new(); + let csrf_key = "same-csrf"; + + let pkce1 = PkceCodeVerifier::new("verifier-1".to_string()); + let csrf1 = CsrfToken::new(csrf_key.to_string()); + let state1 = StoredAuthorizationState::new(&pkce1, &csrf1); + store.save(csrf_key, state1).await.unwrap(); + + let pkce2 = PkceCodeVerifier::new("verifier-2".to_string()); + let csrf2 = CsrfToken::new(csrf_key.to_string()); + let state2 = StoredAuthorizationState::new(&pkce2, &csrf2); + store.save(csrf_key, state2).await.unwrap(); + + let loaded = store.load(csrf_key).await.unwrap().unwrap(); + assert_eq!(loaded.pkce_verifier, "verifier-2"); + } + + #[tokio::test] + async fn test_in_memory_state_store_concurrent_access() { + let store = Arc::new(InMemoryStateStore::new()); + let mut handles = vec![]; + + for i in 0..10 { + let store = Arc::clone(&store); + let handle = tokio::spawn(async move { + let csrf_key = format!("csrf-{}", i); + let verifier = format!("verifier-{}", i); + + let pkce = PkceCodeVerifier::new(verifier.clone()); + let csrf = CsrfToken::new(csrf_key.clone()); + let state = StoredAuthorizationState::new(&pkce, &csrf); + + store.save(&csrf_key, state).await.unwrap(); + let loaded = store.load(&csrf_key).await.unwrap().unwrap(); + assert_eq!(loaded.pkce_verifier, verifier); + + store.delete(&csrf_key).await.unwrap(); + let deleted = store.load(&csrf_key).await.unwrap(); + assert!(deleted.is_none()); + }); + handles.push(handle); + } + + for handle in handles { + handle.await.unwrap(); + } + } + + #[tokio::test] + async fn test_custom_state_store_with_authorization_manager() { + use std::sync::atomic::{AtomicUsize, Ordering}; + + #[derive(Debug, Default)] + struct TrackingStateStore { + inner: InMemoryStateStore, + save_count: AtomicUsize, + load_count: AtomicUsize, + delete_count: AtomicUsize, + } + + #[async_trait::async_trait] + impl StateStore for TrackingStateStore { + async fn save( + &self, + csrf_token: &str, + state: StoredAuthorizationState, + ) -> Result<(), AuthError> { + self.save_count.fetch_add(1, Ordering::SeqCst); + self.inner.save(csrf_token, state).await + } + + async fn load( + &self, + csrf_token: &str, + ) -> Result, AuthError> { + self.load_count.fetch_add(1, Ordering::SeqCst); + self.inner.load(csrf_token).await + } + + async fn delete(&self, csrf_token: &str) -> Result<(), AuthError> { + self.delete_count.fetch_add(1, Ordering::SeqCst); + self.inner.delete(csrf_token).await + } + } + + let store = TrackingStateStore::default(); + let pkce = PkceCodeVerifier::new("test-verifier".to_string()); + let csrf = CsrfToken::new("test-csrf".to_string()); + let state = StoredAuthorizationState::new(&pkce, &csrf); + + store.save("test-csrf", state).await.unwrap(); + assert_eq!(store.save_count.load(Ordering::SeqCst), 1); + + let _ = store.load("test-csrf").await.unwrap(); + assert_eq!(store.load_count.load(Ordering::SeqCst), 1); + + store.delete("test-csrf").await.unwrap(); + assert_eq!(store.delete_count.load(Ordering::SeqCst), 1); + + let mut manager = AuthorizationManager::new("http://localhost").await.unwrap(); + manager.set_state_store(TrackingStateStore::default()); + } + + /// Helper: create an AuthorizationManager with minimal metadata so + /// `configure_client` can be exercised without a live server. + async fn manager_with_metadata( + metadata_override: Option, + ) -> AuthorizationManager { + let mut mgr = AuthorizationManager::new("http://localhost").await.unwrap(); + mgr.set_metadata(metadata_override.unwrap_or(AuthorizationMetadata { + authorization_endpoint: "http://localhost/authorize".to_string(), + token_endpoint: "http://localhost/token".to_string(), + ..Default::default() + })); + mgr + } + + #[tokio::test] + async fn initialize_from_store_clears_dcr_credentials_when_issuer_changes() { + let store = InMemoryCredentialStore::new(); + store + .save(StoredCredentials { + client_id: "dcr-client".to_string(), + token_response: Some(make_token_response("old-token", Some(3600))), + granted_scopes: vec![], + token_received_at: Some(AuthorizationManager::now_epoch_secs()), + issuer: Some("https://old.example.com".to_string()), + }) + .await + .unwrap(); + let mut manager = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: "https://new.example.com/authorize".to_string(), + token_endpoint: "https://new.example.com/token".to_string(), + issuer: Some("https://new.example.com".to_string()), + ..Default::default() + })) + .await; + manager.set_credential_store(store.clone()); + + let initialized = manager.initialize_from_store().await.unwrap(); + let credentials_cleared = store.load().await.unwrap().is_none(); + + assert_eq!((initialized, credentials_cleared), (false, true)); + } + + fn test_client_config() -> OAuthClientConfig { + OAuthClientConfig { + client_id: "my-client".to_string(), + client_secret: Some("my-secret".to_string()), + scopes: vec![], + redirect_uri: "http://localhost/callback".to_string(), + application_type: None, + } + } + + #[tokio::test] + async fn test_configure_client_uses_client_secret_post_from_metadata() { + let mut additional_fields = HashMap::new(); + additional_fields.insert( + "token_endpoint_auth_methods_supported".to_string(), + serde_json::json!(["client_secret_post"]), + ); + let meta = AuthorizationMetadata { + authorization_endpoint: "http://localhost/authorize".to_string(), + token_endpoint: "http://localhost/token".to_string(), + additional_fields, + ..Default::default() + }; + let mut mgr = manager_with_metadata(Some(meta)).await; + mgr.configure_client(test_client_config()).unwrap(); + assert!(matches!( + mgr.oauth_client.as_ref().unwrap().auth_type(), + AuthType::RequestBody + )); + } + + #[tokio::test] + async fn test_configure_client_defaults_to_basic_auth() { + let mut mgr = manager_with_metadata(None).await; + mgr.configure_client(test_client_config()).unwrap(); + assert!(matches!( + mgr.oauth_client.as_ref().unwrap().auth_type(), + AuthType::BasicAuth + )); + } + + #[tokio::test] + async fn test_configure_client_with_explicit_basic_in_metadata() { + let mut additional_fields = HashMap::new(); + additional_fields.insert( + "token_endpoint_auth_methods_supported".to_string(), + serde_json::json!(["client_secret_basic"]), + ); + let meta = AuthorizationMetadata { + authorization_endpoint: "http://localhost/authorize".to_string(), + token_endpoint: "http://localhost/token".to_string(), + additional_fields, + ..Default::default() + }; + let mut mgr = manager_with_metadata(Some(meta)).await; + mgr.configure_client(test_client_config()).unwrap(); + assert!(matches!( + mgr.oauth_client.as_ref().unwrap().auth_type(), + AuthType::BasicAuth + )); + } + + #[tokio::test] + async fn test_configure_client_ignores_unsupported_auth_methods_in_metadata() { + let mut additional_fields = HashMap::new(); + additional_fields.insert( + "token_endpoint_auth_methods_supported".to_string(), + serde_json::json!(["private_key_jwt"]), + ); + let meta = AuthorizationMetadata { + authorization_endpoint: "http://localhost/authorize".to_string(), + token_endpoint: "http://localhost/token".to_string(), + additional_fields, + ..Default::default() + }; + let mut mgr = manager_with_metadata(Some(meta)).await; + // Unsupported method should fall through to default (basic auth) + mgr.configure_client(test_client_config()).unwrap(); + assert!(matches!( + mgr.oauth_client.as_ref().unwrap().auth_type(), + AuthType::BasicAuth + )); + } + + #[tokio::test] + async fn test_configure_client_prefers_basic_when_both_methods_supported() { + let mut additional_fields = HashMap::new(); + additional_fields.insert( + "token_endpoint_auth_methods_supported".to_string(), + serde_json::json!(["client_secret_post", "client_secret_basic"]), + ); + let meta = AuthorizationMetadata { + authorization_endpoint: "http://localhost/authorize".to_string(), + token_endpoint: "http://localhost/token".to_string(), + additional_fields, + ..Default::default() + }; + let mut mgr = manager_with_metadata(Some(meta)).await; + mgr.configure_client(test_client_config()).unwrap(); + assert!(matches!( + mgr.oauth_client.as_ref().unwrap().auth_type(), + AuthType::BasicAuth + )); + } + // -- metadata deserialization -- + + #[test] + fn test_code_challenge_methods_supported_deserialization() { + let json = r#"{ + "authorization_endpoint": "https://auth.example.com/authorize", + "token_endpoint": "https://auth.example.com/token", + "code_challenge_methods_supported": ["S256", "plain"] + }"#; + let metadata: AuthorizationMetadata = serde_json::from_str(json).unwrap(); + let methods = metadata.code_challenge_methods_supported.unwrap(); + assert!(methods.contains(&"S256".to_string())); + assert!(methods.contains(&"plain".to_string())); + } + + #[test] + fn test_code_challenge_methods_supported_missing_from_json() { + let json = r#"{ + "authorization_endpoint": "https://auth.example.com/authorize", + "token_endpoint": "https://auth.example.com/token" + }"#; + let metadata: AuthorizationMetadata = serde_json::from_str(json).unwrap(); + assert!(metadata.code_challenge_methods_supported.is_none()); + } + + // -- server validation -- + + #[tokio::test] + async fn test_validate_as_metadata_rejects_unsupported_response_type() { + let mut manager = AuthorizationManager::new("https://example.com") + .await + .unwrap(); + let metadata = AuthorizationMetadata { + authorization_endpoint: "https://auth.example.com/authorize".to_string(), + token_endpoint: "https://auth.example.com/token".to_string(), + response_types_supported: Some(vec!["token".to_string()]), + ..Default::default() + }; + manager.set_metadata(metadata); + assert!(manager.validate_server_metadata("code").is_err()); + } + + fn as_metadata_with_pkce(methods: Option>) -> AuthorizationMetadata { + AuthorizationMetadata { + authorization_endpoint: "https://auth.example.com/authorize".to_string(), + token_endpoint: "https://auth.example.com/token".to_string(), + response_types_supported: Some(vec!["code".to_string()]), + code_challenge_methods_supported: methods, + ..Default::default() + } + } + + #[tokio::test] + async fn test_validate_as_metadata_rejects_without_pkce_s256() { + let mut manager = AuthorizationManager::new("https://example.com") + .await + .unwrap(); + manager.set_metadata(as_metadata_with_pkce(Some(vec!["plain".to_string()]))); + assert!(matches!( + manager.validate_server_metadata("code"), + Err(AuthError::PkceUnsupported) + )); + } + + #[tokio::test] + async fn test_validate_as_metadata_allows_absent_pkce_methods_by_default() { + let mut manager = AuthorizationManager::new("https://example.com") + .await + .unwrap(); + manager.set_metadata(as_metadata_with_pkce(None)); + assert!(manager.validate_server_metadata("code").is_ok()); + } + + #[tokio::test] + async fn test_validate_as_metadata_passes_with_pkce_s256() { + let mut manager = AuthorizationManager::new("https://example.com") + .await + .unwrap(); + manager.set_metadata(as_metadata_with_pkce(Some(vec!["S256".to_string()]))); + assert!(manager.validate_server_metadata("code").is_ok()); + } + + #[tokio::test] + async fn test_validate_as_metadata_passes_without_metadata() { + let manager = AuthorizationManager::new("https://example.com") + .await + .unwrap(); + assert!(manager.validate_server_metadata("code").is_ok()); + } + + // -- authorization flow -- + + #[tokio::test] + async fn test_authorization_url_is_valid() { + let base_url = "https://mcp.example.com/api"; + let auth_endpoint = "https://auth.example.com/authorize"; + let mut manager = AuthorizationManager::new(base_url).await.unwrap(); + + let metadata = AuthorizationMetadata { + authorization_endpoint: auth_endpoint.to_string(), + token_endpoint: "https://auth.example.com/token".to_string(), + registration_endpoint: None, + issuer: None, + jwks_uri: None, + scopes_supported: None, + response_types_supported: Some(vec!["code".to_string()]), + code_challenge_methods_supported: Some(vec!["S256".to_string()]), + additional_fields: std::collections::HashMap::new(), + }; + manager.set_metadata(metadata); + manager.configure_client_id("test-client-id").unwrap(); + + let auth_url = manager + .get_authorization_url(&["read", "write"]) + .await + .unwrap(); + let parsed = Url::parse(&auth_url).unwrap(); + + assert!(auth_url.starts_with(auth_endpoint)); + + let params: std::collections::HashMap<_, _> = parsed.query_pairs().collect(); + + assert_eq!( + params.get("response_type").map(|v| v.as_ref()), + Some("code") + ); + assert_eq!( + params.get("client_id").map(|v| v.as_ref()), + Some("test-client-id") + ); + assert!(params.contains_key("state")); + assert_eq!( + params.get("redirect_uri").map(|v| v.as_ref()), + Some(base_url) + ); + assert!(params.contains_key("code_challenge")); + assert_eq!( + params.get("code_challenge_method").map(|v| v.as_ref()), + Some("S256") + ); + assert_eq!(params.get("resource").map(|v| v.as_ref()), Some(base_url)); + + let scope = params + .get("scope") + .map(|v| v.to_string()) + .unwrap_or_default(); + assert!(scope.contains("read")); + assert!(scope.contains("write")); + } + + #[tokio::test] + async fn authorization_url_uses_discovered_resource() { + let base_url = "https://mcp.example.com/mcp"; + let auth_endpoint = "https://auth.example.com/authorize"; + let mut manager = AuthorizationManager::new(base_url).await.unwrap(); + + let metadata = AuthorizationMetadata { + authorization_endpoint: auth_endpoint.to_string(), + token_endpoint: "https://auth.example.com/token".to_string(), + registration_endpoint: None, + issuer: None, + jwks_uri: None, + scopes_supported: None, + response_types_supported: Some(vec!["code".to_string()]), + code_challenge_methods_supported: Some(vec!["S256".to_string()]), + additional_fields: std::collections::HashMap::new(), + }; + manager.set_metadata(metadata); + manager.configure_client_id("test-client-id").unwrap(); + *manager.discovered_resource.write().await = Some("https://mcp.example.com".to_string()); + + let auth_url = manager.get_authorization_url(&["read"]).await.unwrap(); + let parsed = Url::parse(&auth_url).unwrap(); + let params: std::collections::HashMap<_, _> = parsed.query_pairs().collect(); + + assert_eq!( + params.get("resource").map(|v| v.as_ref()), + Some("https://mcp.example.com") + ); + } + + #[tokio::test] + async fn authorization_url_uses_default_resource_without_protected_resource_document() { + let base_url = "https://mcp.example.com/mcp"; + let auth_endpoint = "https://auth.example.com/authorize"; + let mut manager = AuthorizationManager::new(base_url).await.unwrap(); + + let metadata = AuthorizationMetadata { + authorization_endpoint: auth_endpoint.to_string(), + token_endpoint: "https://auth.example.com/token".to_string(), + registration_endpoint: None, + issuer: None, + jwks_uri: None, + scopes_supported: None, + response_types_supported: Some(vec!["code".to_string()]), + code_challenge_methods_supported: Some(vec!["S256".to_string()]), + additional_fields: std::collections::HashMap::new(), + }; + manager.set_metadata(metadata); + manager.configure_client_id("test-client-id").unwrap(); + + let auth_url = manager.get_authorization_url(&["read"]).await.unwrap(); + let parsed = Url::parse(&auth_url).unwrap(); + let params: std::collections::HashMap<_, _> = parsed.query_pairs().collect(); + + assert_eq!(params.get("resource").map(|v| v.as_ref()), Some(base_url)); + } + + #[test] + fn authorization_callback_parses_optional_issuer() { + let callback = AuthorizationCallback::from_redirect_url( + "http://localhost/callback?code=abc&state=csrf&iss=https%3A%2F%2Fauth.example.com", + ) + .unwrap(); + + assert_eq!(callback.code, "abc"); + assert_eq!(callback.csrf_token, "csrf"); + assert_eq!(callback.issuer.as_deref(), Some("https://auth.example.com")); + } + + #[test] + fn authorization_callback_requires_code_and_state() { + let missing_code = AuthorizationCallback::from_redirect_url( + "http://localhost/callback?state=csrf&iss=https%3A%2F%2Fauth.example.com", + ); + assert!(matches!( + missing_code, + Err(AuthError::AuthorizationFailed(message)) if message.contains("missing code") + )); + + let missing_state = AuthorizationCallback::from_redirect_url( + "http://localhost/callback?code=abc&iss=https%3A%2F%2Fauth.example.com", + ); + assert!(matches!( + missing_state, + Err(AuthError::AuthorizationFailed(message)) if message.contains("missing state") + )); + } + + #[rstest] + #[case::matching_issuer( + Some("https://auth.example.com"), + false, + Some("https://auth.example.com") + )] + #[case::missing_issuer_when_not_required(Some("https://auth.example.com"), false, None)] + fn validate_authorization_response_issuer_accepts_valid_cases( + #[case] expected_issuer: Option<&str>, + #[case] require_issuer: bool, + #[case] received_issuer: Option<&str>, + ) { + let pkce = PkceCodeVerifier::new("verifier".to_string()); + let csrf = CsrfToken::new("csrf".to_string()); + let state = StoredAuthorizationState::new_with_expected_issuer( + &pkce, + &csrf, + expected_issuer.map(str::to_owned), + require_issuer, + ); + + assert!( + AuthorizationManager::validate_authorization_response_issuer(&state, received_issuer) + .is_ok() + ); + } + + #[derive(Clone, Copy, Debug)] + enum ExpectedIssuerError { + Missing { + expected_issuer: &'static str, + }, + NotRecorded, + Mismatch { + expected_issuer: &'static str, + received_issuer: &'static str, + }, + } + + fn assert_expected_issuer_error(error: AuthError, expected: ExpectedIssuerError) { + match expected { + ExpectedIssuerError::Missing { expected_issuer } => assert!(matches!( + error, + AuthError::AuthorizationServerMissingIssuer { expected_issuer: actual } + if actual == expected_issuer + )), + ExpectedIssuerError::NotRecorded => assert!( + matches!(error, AuthError::AuthorizationFailed(message) if message.contains("expected issuer was not recorded")) + ), + ExpectedIssuerError::Mismatch { + expected_issuer, + received_issuer, + } => assert!(matches!( + error, + AuthError::AuthorizationServerMismatch { + expected_issuer: actual_expected, + received_issuer: actual_received + } if actual_expected == expected_issuer && actual_received == received_issuer + )), + } + } + + #[rstest] + #[case::requires_advertised_issuer( + Some("https://auth.example.com"), + true, + None, + ExpectedIssuerError::Missing { + expected_issuer: "https://auth.example.com", + } + )] + #[case::present_issuer_without_expected( + None, + false, + Some("https://auth.example.com"), + ExpectedIssuerError::NotRecorded + )] + #[case::required_issuer_without_expected(None, true, None, ExpectedIssuerError::NotRecorded)] + #[case::mismatched_issuer( + Some("https://auth.example.com"), + false, + Some("https://evil.example.com"), + ExpectedIssuerError::Mismatch { + expected_issuer: "https://auth.example.com", + received_issuer: "https://evil.example.com", + } + )] + fn validate_authorization_response_issuer_rejects_invalid_cases( + #[case] expected_issuer: Option<&str>, + #[case] require_issuer: bool, + #[case] received_issuer: Option<&str>, + #[case] expected_error: ExpectedIssuerError, + ) { + let pkce = PkceCodeVerifier::new("verifier".to_string()); + let csrf = CsrfToken::new("csrf".to_string()); + let state = StoredAuthorizationState::new_with_expected_issuer( + &pkce, + &csrf, + expected_issuer.map(str::to_owned), + require_issuer, + ); + + let error = + AuthorizationManager::validate_authorization_response_issuer(&state, received_issuer) + .unwrap_err(); + + assert_expected_issuer_error(error, expected_error); + } + + #[tokio::test] + async fn authorization_url_stores_expected_issuer_for_callback_validation() { + let mut manager = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: "https://auth.example.com/authorize".to_string(), + token_endpoint: "https://auth.example.com/token".to_string(), + issuer: Some("https://auth.example.com".to_string()), + ..Default::default() + })) + .await; + manager.configure_client_id("test-client-id").unwrap(); + + let auth_url = manager.get_authorization_url(&[]).await.unwrap(); + let parsed = Url::parse(&auth_url).unwrap(); + let state = parsed + .query_pairs() + .find_map(|(key, value)| (key == "state").then(|| value.into_owned())) + .expect("authorization URL should contain state"); + + let stored_state = manager + .state_store + .load(&state) + .await + .unwrap() + .expect("authorization state should be stored"); + assert_eq!( + stored_state.expected_issuer.as_deref(), + Some("https://auth.example.com") + ); + } + + #[rstest] + #[case::missing_required_issuer(None)] + #[case::mismatched_issuer(Some("https://evil.example.com"))] + #[tokio::test] + async fn invalid_issuer_does_not_consume_authorization_state( + #[case] invalid_issuer: Option<&str>, + ) { + let client = RecordingOAuthHttpClient::with_responses(vec![http_response( + 200, + serde_json::json!({ + "access_token": "access-token", + "token_type": "bearer", + "expires_in": 3600 + }), + )]); + let mut manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + Arc::new(client.clone()), + ) + .await + .unwrap(); + manager.set_metadata(AuthorizationMetadata { + authorization_endpoint: "https://auth.example.com/authorize".to_string(), + token_endpoint: "https://auth.example.com/token".to_string(), + issuer: Some("https://auth.example.com".to_string()), + ..Default::default() + }); + manager.configure_client_id("test-client-id").unwrap(); + + let pkce = PkceCodeVerifier::new("verifier".to_string()); + let csrf = CsrfToken::new("csrf".to_string()); + let state = StoredAuthorizationState::new_with_expected_issuer( + &pkce, + &csrf, + Some("https://auth.example.com".to_string()), + true, + ); + manager.state_store.save("csrf", state).await.unwrap(); + + manager + .exchange_code_for_token_with_issuer("forged-code", "csrf", invalid_issuer) + .await + .unwrap_err(); + + assert!( + manager.state_store.load("csrf").await.unwrap().is_some(), + "issuer validation failures must leave state available for the legitimate callback" + ); + assert!( + client.requests().is_empty(), + "issuer validation failures must not reach the token endpoint" + ); + + manager + .exchange_code_for_token_with_issuer( + "legitimate-code", + "csrf", + Some("https://auth.example.com"), + ) + .await + .unwrap(); + + assert!( + manager.state_store.load("csrf").await.unwrap().is_none(), + "a valid callback must consume its one-time authorization state" + ); + assert_eq!(client.requests().len(), 1); + } + + // -- scope management -- + + #[test] + fn compute_scope_union_adds_new_scopes() { + let current = vec!["read".to_string(), "write".to_string()]; + let result = AuthorizationManager::compute_scope_union(¤t, "admin delete"); + + assert!(result.contains(&"read".to_string())); + assert!(result.contains(&"write".to_string())); + assert!(result.contains(&"admin".to_string())); + assert!(result.contains(&"delete".to_string())); + assert_eq!(result.len(), 4); + } + + #[test] + fn compute_scope_union_deduplicates() { + let current = vec!["read".to_string(), "write".to_string()]; + let result = AuthorizationManager::compute_scope_union(¤t, "read admin"); + + assert!(result.contains(&"read".to_string())); + assert!(result.contains(&"write".to_string())); + assert!(result.contains(&"admin".to_string())); + assert_eq!(result.len(), 3); + } + + #[test] + fn compute_scope_union_handles_empty_current() { + let current: Vec = vec![]; + let result = AuthorizationManager::compute_scope_union(¤t, "read write"); + + assert!(result.contains(&"read".to_string())); + assert!(result.contains(&"write".to_string())); + assert_eq!(result.len(), 2); + } + + // -- SEP-2207: offline_access -- + + #[tokio::test] + async fn select_scopes_adds_offline_access_when_as_supports_it() { + let mgr = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: "http://localhost/authorize".to_string(), + token_endpoint: "http://localhost/token".to_string(), + scopes_supported: Some(vec!["profile".to_string(), "offline_access".to_string()]), + ..Default::default() + })) + .await; + *mgr.resource_scopes.write().await = vec!["profile".to_string()]; + + let scopes = mgr.select_scopes(None, &[]); + assert!( + scopes.contains(&"offline_access".to_string()), + "offline_access should be added when AS supports it" + ); + assert!(scopes.contains(&"profile".to_string())); + } + + #[tokio::test] + async fn select_scopes_does_not_add_offline_access_when_as_does_not_support_it() { + let mgr = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: "http://localhost/authorize".to_string(), + token_endpoint: "http://localhost/token".to_string(), + scopes_supported: Some(vec!["profile".to_string(), "email".to_string()]), + ..Default::default() + })) + .await; + *mgr.resource_scopes.write().await = vec!["profile".to_string()]; + + let scopes = mgr.select_scopes(None, &[]); + assert!( + !scopes.contains(&"offline_access".to_string()), + "offline_access should not be added when AS does not support it" + ); + } + + #[tokio::test] + async fn select_scopes_falls_back_to_defaults() { + let mgr = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: "http://localhost/authorize".to_string(), + token_endpoint: "http://localhost/token".to_string(), + scopes_supported: None, + ..Default::default() + })) + .await; + + let scopes = mgr.select_scopes(None, &["default_scope"]); + assert_eq!(scopes, vec!["default_scope".to_string()]); + } + + #[tokio::test] + async fn select_scopes_does_not_duplicate_offline_access() { + let mgr = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: "http://localhost/authorize".to_string(), + token_endpoint: "http://localhost/token".to_string(), + scopes_supported: Some(vec!["profile".to_string(), "offline_access".to_string()]), + ..Default::default() + })) + .await; + + // When AS metadata is the scope source and already contains offline_access, + // it should appear exactly once. + let scopes = mgr.select_scopes(None, &[]); + let count = scopes.iter().filter(|s| *s == "offline_access").count(); + assert_eq!(count, 1, "offline_access should not be duplicated"); + } + + #[tokio::test] + async fn select_scopes_adds_offline_access_to_www_authenticate_scopes() { + let mgr = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: "http://localhost/authorize".to_string(), + token_endpoint: "http://localhost/token".to_string(), + scopes_supported: Some(vec!["profile".to_string(), "offline_access".to_string()]), + ..Default::default() + })) + .await; + *mgr.www_auth_scopes.write().await = vec!["profile".to_string()]; + + let scopes = mgr.select_scopes(None, &[]); + assert!(scopes.contains(&"offline_access".to_string())); + assert!(scopes.contains(&"profile".to_string())); + } + + #[tokio::test] + async fn select_scopes_adds_offline_access_to_www_authenticate_argument() { + let mgr = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: "http://localhost/authorize".to_string(), + token_endpoint: "http://localhost/token".to_string(), + scopes_supported: Some(vec!["profile".to_string(), "offline_access".to_string()]), + ..Default::default() + })) + .await; + + let scopes = mgr.select_scopes(Some("profile email"), &[]); + assert!(scopes.contains(&"offline_access".to_string())); + assert!(scopes.contains(&"profile".to_string())); + assert!(scopes.contains(&"email".to_string())); + } + + // -- SEP-2350: client-side scope accumulation in step-up authorization -- + + #[tokio::test] + async fn select_scopes_unions_challenge_with_previously_requested() { + let mgr = manager_with_metadata(None).await; + *mgr.current_scopes.write().await = vec!["read".to_string()]; + + let scopes = mgr.select_scopes(Some("write"), &[]); + + assert_eq!(scopes, vec!["read".to_string(), "write".to_string()]); + } + + #[tokio::test] + async fn select_scopes_does_not_replace_previously_requested_with_challenge() { + let mgr = manager_with_metadata(None).await; + *mgr.current_scopes.write().await = vec!["read".to_string(), "profile".to_string()]; + + let scopes = mgr.select_scopes(Some("write"), &[]); + + assert!(scopes.contains(&"read".to_string())); + assert!(scopes.contains(&"profile".to_string())); + assert!(scopes.contains(&"write".to_string())); + } + + #[tokio::test] + async fn select_scopes_accumulates_across_multiple_step_up_rounds() { + let mgr = manager_with_metadata(None).await; + *mgr.current_scopes.write().await = vec!["read".to_string()]; + + // round one: server challenges for "write" + let round_one = mgr.select_scopes(Some("write"), &[]); + assert_eq!(round_one, vec!["read".to_string(), "write".to_string()]); + *mgr.current_scopes.write().await = round_one; + + // round two: server challenges for "admin", earlier scopes are retained + let round_two = mgr.select_scopes(Some("admin"), &[]); + assert_eq!( + round_two, + vec!["read".to_string(), "write".to_string(), "admin".to_string()] + ); + } + + #[tokio::test] + async fn select_scopes_deduplicates_challenge_already_requested() { + let mgr = manager_with_metadata(None).await; + *mgr.current_scopes.write().await = vec!["read".to_string(), "write".to_string()]; + + let scopes = mgr.select_scopes(Some("write admin"), &[]); + + assert_eq!( + scopes, + vec!["read".to_string(), "write".to_string(), "admin".to_string()] + ); + } + + #[tokio::test] + async fn select_scopes_unions_resource_metadata_as_operational_requirement() { + let mgr = manager_with_metadata(None).await; + *mgr.current_scopes.write().await = vec!["read".to_string()]; + *mgr.resource_scopes.write().await = vec!["profile".to_string()]; + + let scopes = mgr.select_scopes(Some("write"), &[]); + + assert!(scopes.contains(&"read".to_string())); + assert!(scopes.contains(&"write".to_string())); + assert!(scopes.contains(&"profile".to_string())); + } + + #[test] + fn resolve_granted_scopes_uses_requested_when_response_omits_scope() { + let granted = AuthorizationManager::resolve_granted_scopes( + None, + &["read".to_string(), "write".to_string()], + &["read".to_string()], + ); + + assert_eq!(granted, vec!["read".to_string(), "write".to_string()]); + } + + #[test] + fn resolve_granted_scopes_honors_explicit_server_downgrade() { + let granted = AuthorizationManager::resolve_granted_scopes( + Some(vec!["read".to_string()]), + &["read".to_string(), "write".to_string()], + &["read".to_string()], + ); + + assert_eq!(granted, vec!["read".to_string()]); + } + + #[test] + fn resolve_granted_scopes_falls_back_to_current_when_nothing_requested() { + let granted = + AuthorizationManager::resolve_granted_scopes(None, &[], &["read".to_string()]); + + assert_eq!(granted, vec!["read".to_string()]); + } + + #[tokio::test] + async fn add_offline_access_if_supported_works_with_explicit_scopes() { + let mgr = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: "http://localhost/authorize".to_string(), + token_endpoint: "http://localhost/token".to_string(), + scopes_supported: Some(vec!["profile".to_string(), "offline_access".to_string()]), + ..Default::default() + })) + .await; + + let mut explicit = vec!["read".to_string(), "write".to_string()]; + mgr.add_offline_access_if_supported(&mut explicit); + assert!(explicit.contains(&"offline_access".to_string())); + } + + #[tokio::test] + async fn add_offline_access_if_supported_skips_empty_scopes() { + let mgr = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: "http://localhost/authorize".to_string(), + token_endpoint: "http://localhost/token".to_string(), + scopes_supported: Some(vec!["profile".to_string(), "offline_access".to_string()]), + ..Default::default() + })) + .await; + + let mut empty: Vec = vec![]; + mgr.add_offline_access_if_supported(&mut empty); + assert!( + empty.is_empty(), + "offline_access should not be the only scope" + ); + } + + #[tokio::test] + async fn scope_upgrade_adds_offline_access_when_as_supports_it() { + let mut mgr = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: "http://localhost/authorize".to_string(), + token_endpoint: "http://localhost/token".to_string(), + scopes_supported: Some(vec!["profile".to_string(), "offline_access".to_string()]), + ..Default::default() + })) + .await; + mgr.configure_client_id("my-client").unwrap(); + *mgr.current_scopes.write().await = vec!["profile".to_string()]; + + let auth_url = mgr.request_scope_upgrade("email").await.unwrap(); + let parsed = Url::parse(&auth_url).unwrap(); + let scope = parsed + .query_pairs() + .find_map(|(key, value)| (key == "scope").then(|| value.into_owned())) + .expect("scope should be present"); + let mut scope_parts: Vec<&str> = scope.split_whitespace().collect(); + scope_parts.sort_unstable(); + assert_eq!(scope_parts, vec!["email", "offline_access", "profile"]); + } + + #[test] + fn scope_upgrade_config_default_values() { + let config = ScopeUpgradeConfig::default(); + assert_eq!(config.max_upgrade_attempts, 3); + assert!(config.auto_upgrade); + } + + #[tokio::test] + async fn authorization_manager_tracks_scope_upgrade_attempts() { + let manager = AuthorizationManager::new("http://localhost").await.unwrap(); + + assert_eq!(manager.get_scope_upgrade_attempts().await, 0); + + *manager.scope_upgrade_attempts.write().await = 2; + assert_eq!(manager.get_scope_upgrade_attempts().await, 2); + + manager.reset_scope_upgrade_attempts().await; + assert_eq!(manager.get_scope_upgrade_attempts().await, 0); + } + + #[tokio::test] + async fn authorization_manager_can_attempt_scope_upgrade_respects_config() { + let mut manager = AuthorizationManager::new("http://localhost").await.unwrap(); + + assert!(manager.can_attempt_scope_upgrade().await); + + manager.set_scope_upgrade_config(ScopeUpgradeConfig { + max_upgrade_attempts: 3, + auto_upgrade: false, + }); + assert!(!manager.can_attempt_scope_upgrade().await); + + manager.set_scope_upgrade_config(ScopeUpgradeConfig { + max_upgrade_attempts: 2, + auto_upgrade: true, + }); + *manager.scope_upgrade_attempts.write().await = 2; + assert!(!manager.can_attempt_scope_upgrade().await); + + *manager.scope_upgrade_attempts.write().await = 1; + assert!(manager.can_attempt_scope_upgrade().await); + } + + // -- get_access_token -- + + use super::{OAuthTokenResponse, StoredCredentials}; + + fn make_token_response(access_token: &str, expires_in_secs: Option) -> OAuthTokenResponse { + use oauth2::{AccessToken, basic::BasicTokenType}; + let mut resp = OAuthTokenResponse::new( + AccessToken::new(access_token.to_string()), + BasicTokenType::Bearer, + VendorExtraTokenFields { + ..Default::default() + }, + ); + if let Some(secs) = expires_in_secs { + resp.set_expires_in(Some(&std::time::Duration::from_secs(secs))); + } + resp + } + + #[tokio::test] + async fn get_access_token_returns_error_when_no_credentials() { + let manager = AuthorizationManager::new("http://localhost").await.unwrap(); + let err = manager.get_access_token().await.unwrap_err(); + assert!(matches!(err, AuthError::AuthorizationRequired)); + } + + #[tokio::test] + async fn get_access_token_returns_token_when_not_expired() { + let manager = AuthorizationManager::new("http://localhost").await.unwrap(); + let stored = StoredCredentials { + client_id: "test".to_string(), + token_response: Some(make_token_response("my-access-token", Some(3600))), + granted_scopes: vec![], + token_received_at: Some(AuthorizationManager::now_epoch_secs()), + issuer: None, + }; + manager.credential_store.save(stored).await.unwrap(); + + let token = manager.get_access_token().await.unwrap(); + assert_eq!(token, "my-access-token"); + } + + #[tokio::test] + async fn get_access_token_requires_reauth_when_expired_and_no_refresh_token() { + let mut manager = manager_with_metadata(None).await; + manager.configure_client(test_client_config()).unwrap(); + + let stored = StoredCredentials { + client_id: "my-client".to_string(), + token_response: Some(make_token_response("stale-token", Some(3600))), + granted_scopes: vec![], + token_received_at: Some(AuthorizationManager::now_epoch_secs() - 7200), + issuer: None, + }; + manager.credential_store.save(stored).await.unwrap(); + + let err = manager.get_access_token().await.unwrap_err(); + assert!( + matches!(err, AuthError::AuthorizationRequired), + "expected AuthorizationRequired when token is expired and refresh is impossible, got: {err:?}" + ); + } + + #[tokio::test] + async fn get_access_token_returns_token_without_expiry_info() { + let manager = AuthorizationManager::new("http://localhost").await.unwrap(); + let stored = StoredCredentials { + client_id: "test".to_string(), + token_response: Some(make_token_response("no-expiry-token", None)), + granted_scopes: vec![], + token_received_at: None, + issuer: None, + }; + manager.credential_store.save(stored).await.unwrap(); + + let token = manager.get_access_token().await.unwrap(); + assert_eq!(token, "no-expiry-token"); + } + + #[tokio::test] + async fn get_access_token_requires_reauth_when_within_refresh_buffer() { + let mut manager = manager_with_metadata(None).await; + manager.configure_client(test_client_config()).unwrap(); + + let stored = StoredCredentials { + client_id: "my-client".to_string(), + token_response: Some(make_token_response("almost-expired", Some(3600))), + granted_scopes: vec![], + token_received_at: Some(AuthorizationManager::now_epoch_secs() - 3590), + issuer: None, + }; + manager.credential_store.save(stored).await.unwrap(); + + let err = manager.get_access_token().await.unwrap_err(); + assert!( + matches!(err, AuthError::AuthorizationRequired), + "expected AuthorizationRequired when token is within refresh buffer, got: {err:?}" + ); + } + + #[tokio::test] + async fn get_access_token_propagates_internal_errors() { + let manager = AuthorizationManager::new("http://localhost").await.unwrap(); + let stored = StoredCredentials { + client_id: "test".to_string(), + token_response: Some(make_token_response("stale-token", Some(3600))), + granted_scopes: vec![], + token_received_at: Some(AuthorizationManager::now_epoch_secs() - 7200), + issuer: None, + }; + manager.credential_store.save(stored).await.unwrap(); + + let err = manager.get_access_token().await.unwrap_err(); + assert!( + matches!(err, AuthError::InternalError(_)), + "expected InternalError when OAuth client is not configured, got: {err:?}" + ); + } + + // -- ClientRegistrationRequest serialization -- + + #[test] + fn client_registration_request_includes_scope_when_present() { + let req = super::ClientRegistrationRequest { + client_name: "test".to_string(), + redirect_uris: vec!["http://localhost/callback".to_string()], + grant_types: vec!["authorization_code".to_string()], + token_endpoint_auth_method: "none".to_string(), + response_types: vec!["code".to_string()], + scope: Some("read write".to_string()), + application_type: None, + }; + let json = serde_json::to_value(&req).unwrap(); + assert_eq!(json["scope"], "read write"); + } + + #[test] + fn client_registration_request_omits_scope_when_none() { + let req = super::ClientRegistrationRequest { + client_name: "test".to_string(), + redirect_uris: vec!["http://localhost/callback".to_string()], + grant_types: vec!["authorization_code".to_string()], + token_endpoint_auth_method: "none".to_string(), + response_types: vec!["code".to_string()], + scope: None, + application_type: None, + }; + let json = serde_json::to_value(&req).unwrap(); + assert!(!json.as_object().unwrap().contains_key("scope")); + } + + // -- ClientRegistrationRequest application_type (SEP-837) -- + + #[test] + fn client_registration_request_includes_application_type_when_present() { + let req = super::ClientRegistrationRequest { + client_name: "test".to_string(), + redirect_uris: vec!["http://localhost/callback".to_string()], + grant_types: vec!["authorization_code".to_string()], + token_endpoint_auth_method: "none".to_string(), + response_types: vec!["code".to_string()], + scope: None, + application_type: Some("native".to_string()), + }; + let json = serde_json::to_value(&req).unwrap(); + assert_eq!(json["application_type"], "native"); + } + + #[test] + fn client_registration_request_omits_application_type_when_none() { + let req = super::ClientRegistrationRequest { + client_name: "test".to_string(), + redirect_uris: vec!["http://localhost/callback".to_string()], + grant_types: vec!["authorization_code".to_string()], + token_endpoint_auth_method: "none".to_string(), + response_types: vec!["code".to_string()], + scope: None, + application_type: None, + }; + let json = serde_json::to_value(&req).unwrap(); + assert!(!json.as_object().unwrap().contains_key("application_type")); + } + + // -- OAuthClientConfig application_type (SEP-837) -- + + #[test] + fn oauth_client_config_defaults_application_type_to_native() { + let config = super::OAuthClientConfig::new("client-id", "http://127.0.0.1:8080/callback"); + assert_eq!(config.application_type.as_deref(), Some("native")); + } + + #[test] + fn oauth_client_config_with_application_type_overrides_default() { + let config = super::OAuthClientConfig::new("client-id", "https://app.example.com/callback") + .with_application_type("web"); + assert_eq!(config.application_type.as_deref(), Some("web")); + } + + // -- client credentials (SEP-1046) -- + + #[cfg(feature = "auth-client-credentials-jwt")] + #[test] + fn client_authentication_audience_defaults_to_metadata_issuer() { + let metadata = AuthorizationMetadata { + authorization_endpoint: "https://auth.example.com/authorize".to_string(), + token_endpoint: "https://auth.example.com/token".to_string(), + issuer: Some("https://auth.example.com".to_string()), + ..Default::default() + }; + + let audience = super::client_authentication_audience(&metadata, None).unwrap(); + + assert_eq!(audience, "https://auth.example.com"); + } + + #[cfg(feature = "auth-client-credentials-jwt")] + #[test] + fn client_authentication_audience_honors_explicit_override() { + let metadata = AuthorizationMetadata { + authorization_endpoint: "https://auth.example.com/authorize".to_string(), + token_endpoint: "https://auth.example.com/token".to_string(), + issuer: Some("https://auth.example.com".to_string()), + ..Default::default() + }; + + let audience = super::client_authentication_audience( + &metadata, + Some("https://legacy.example.com/token"), + ) + .unwrap(); + + assert_eq!(audience, "https://legacy.example.com/token"); + } + + #[cfg(feature = "auth-client-credentials-jwt")] + #[test] + fn client_authentication_audience_rejects_missing_metadata_issuer() { + let metadata = AuthorizationMetadata { + authorization_endpoint: "https://auth.example.com/authorize".to_string(), + token_endpoint: "https://auth.example.com/token".to_string(), + ..Default::default() + }; + + let error = super::client_authentication_audience(&metadata, None).unwrap_err(); + + assert!(matches!(error, AuthError::ClientCredentialsError(_))); + } + + #[cfg(feature = "auth-client-credentials-jwt")] + #[test] + fn client_authentication_header_sets_explicit_type() { + let header = super::client_authentication_header(super::JwtSigningAlgorithm::ES256); + + assert_eq!(header.typ.as_deref(), Some("client-authentication+jwt")); + } + + #[cfg(feature = "auth-client-credentials-jwt")] + #[test] + fn client_credentials_endpoint_allows_http_between_loopback_hosts() { + let resource = Url::parse("http://localhost:8000/mcp").unwrap(); + let token_endpoint = Url::parse("http://127.0.0.1:9000/token").unwrap(); + + assert!(super::is_allowed_client_credentials_endpoint( + &resource, + &token_endpoint + )); + } + + #[cfg(feature = "auth-client-credentials-jwt")] + #[test] + fn client_credentials_endpoint_rejects_http_to_non_loopback_host() { + let resource = Url::parse("http://localhost:8000/mcp").unwrap(); + let token_endpoint = Url::parse("http://auth.example.com/token").unwrap(); + + assert!(!super::is_allowed_client_credentials_endpoint( + &resource, + &token_endpoint + )); + } + + #[tokio::test] + async fn configure_client_credentials_uses_request_body_auth_for_client_secret() { + let mut mgr = manager_with_metadata(None).await; + let config = super::ClientCredentialsConfig::ClientSecret { + client_id: "my-m2m-client".to_string(), + client_secret: "super-secret".to_string(), + scopes: vec!["read".to_string()], + resource: None, + }; + mgr.configure_client_credentials(&config).unwrap(); + let oauth_client = mgr.oauth_client.as_ref().unwrap(); + assert!(matches!(oauth_client.auth_type(), AuthType::RequestBody)); + } + + #[test] + fn client_secret_credentials_debug_redacts_secret() { + let config = super::ClientCredentialsConfig::ClientSecret { + client_id: "client-id".to_string(), + client_secret: "client-secret-value".to_string(), + scopes: vec![], + resource: None, + }; + + let rendered = format!("{config:?}"); + + assert!(!rendered.contains("client-secret-value"), "{rendered}"); + } + + #[cfg(feature = "auth-client-credentials-jwt")] + #[test] + fn private_key_jwt_credentials_debug_redacts_signing_key() { + let config = super::ClientCredentialsConfig::PrivateKeyJwt { + client_id: "client-id".to_string(), + signing_key: b"private-signing-key-value".to_vec(), + signing_algorithm: super::JwtSigningAlgorithm::RS256, + token_endpoint_audience: None, + scopes: vec![], + resource: None, + }; + + let rendered = format!("{config:?}"); + + assert!( + !rendered.contains("private-signing-key-value"), + "{rendered}" + ); + } + + #[tokio::test] + async fn configure_client_credentials_sets_correct_client_id() { + let mut mgr = manager_with_metadata(None).await; + let config = super::ClientCredentialsConfig::ClientSecret { + client_id: "my-m2m-client".to_string(), + client_secret: "super-secret".to_string(), + scopes: vec!["read".to_string()], + resource: None, + }; + mgr.configure_client_credentials(&config).unwrap(); + let oauth_client = mgr.oauth_client.as_ref().unwrap(); + assert_eq!(oauth_client.client_id().as_str(), "my-m2m-client"); + } + + #[tokio::test] + async fn configure_client_credentials_returns_error_without_metadata() { + let mut mgr = AuthorizationManager::new("http://localhost").await.unwrap(); + let config = super::ClientCredentialsConfig::ClientSecret { + client_id: "id".to_string(), + client_secret: "secret".to_string(), + scopes: vec![], + resource: None, + }; + let err = mgr.configure_client_credentials(&config).unwrap_err(); + assert!(matches!(err, AuthError::NoAuthorizationSupport)); + } + + #[tokio::test] + async fn validate_client_credentials_metadata_rejects_unsupported_method() { + let mut additional_fields = HashMap::new(); + additional_fields.insert( + "token_endpoint_auth_methods_supported".to_string(), + // Neither client_secret_post nor client_secret_basic — should be rejected. + serde_json::json!(["tls_client_auth", "private_key_jwt"]), + ); + let meta = AuthorizationMetadata { + authorization_endpoint: "http://localhost/authorize".to_string(), + token_endpoint: "http://localhost/token".to_string(), + additional_fields, + ..Default::default() + }; + let mgr = manager_with_metadata(Some(meta)).await; + let config = super::ClientCredentialsConfig::ClientSecret { + client_id: "id".to_string(), + client_secret: "secret".to_string(), + scopes: vec![], + resource: None, + }; + let err = mgr + .validate_client_credentials_metadata(&config) + .unwrap_err(); + assert!( + err.to_string().contains("tls_client_auth"), + "expected error to mention unsupported method, got: {err}" + ); + } + + fn client_secret_credentials_config() -> super::ClientCredentialsConfig { + super::ClientCredentialsConfig::ClientSecret { + client_id: "id".to_string(), + client_secret: "secret".to_string(), + scopes: vec![], + resource: None, + } + } + + fn metadata_with_auth_methods(methods: serde_json::Value) -> AuthorizationMetadata { + let mut additional_fields = HashMap::new(); + additional_fields.insert("token_endpoint_auth_methods_supported".to_string(), methods); + AuthorizationMetadata { + authorization_endpoint: "http://localhost/authorize".to_string(), + token_endpoint: "http://localhost/token".to_string(), + additional_fields, + ..Default::default() + } + } + + #[rstest] + #[case::supported_methods(Some(serde_json::json!([ + "client_secret_post", + "client_secret_basic" + ])))] + #[case::field_absent(None)] + #[case::client_secret_basic_only(Some(serde_json::json!(["client_secret_basic"])))] + #[tokio::test] + async fn validate_client_credentials_metadata_accepts_supported_configurations( + #[case] auth_methods: Option, + ) { + let mgr = manager_with_metadata(auth_methods.map(metadata_with_auth_methods)).await; + let config = client_secret_credentials_config(); + + mgr.validate_client_credentials_metadata(&config).unwrap(); + } + + #[tokio::test] + async fn configure_client_credentials_uses_basic_auth_when_server_only_supports_basic() { + let mut additional_fields = HashMap::new(); + additional_fields.insert( + "token_endpoint_auth_methods_supported".to_string(), + serde_json::json!(["client_secret_basic"]), + ); + let meta = AuthorizationMetadata { + authorization_endpoint: "http://localhost/authorize".to_string(), + token_endpoint: "http://localhost/token".to_string(), + additional_fields, + ..Default::default() + }; + let mut mgr = manager_with_metadata(Some(meta)).await; + let config = super::ClientCredentialsConfig::ClientSecret { + client_id: "id".to_string(), + client_secret: "secret".to_string(), + scopes: vec![], + resource: None, + }; + mgr.configure_client_credentials(&config).unwrap(); + let oauth_client = mgr.oauth_client.as_ref().unwrap(); + assert!( + !matches!(oauth_client.auth_type(), AuthType::RequestBody), + "expected HTTP Basic auth when server only supports client_secret_basic" + ); + } + + #[test] + fn client_credentials_config_returns_correct_accessor_values() { + let config = super::ClientCredentialsConfig::ClientSecret { + client_id: "test-id".to_string(), + client_secret: "test-secret".to_string(), + scopes: vec!["scope1".to_string(), "scope2".to_string()], + resource: Some("https://example.com".to_string()), + }; + assert_eq!(config.client_id(), "test-id"); + assert_eq!(config.scopes(), &["scope1", "scope2"]); + assert_eq!(config.resource(), Some("https://example.com")); + assert_eq!(config.auth_method(), "client_secret_post"); + } + + #[test] + fn extension_constant_matches_spec() { + assert_eq!( + super::EXTENSION_OAUTH_CLIENT_CREDENTIALS, + "io.modelcontextprotocol/oauth-client-credentials" + ); + } + + // -- refresh_token -- + + fn make_token_response_with_refresh( + access_token: &str, + refresh_token: &str, + ) -> OAuthTokenResponse { + use oauth2::RefreshToken; + let mut resp = make_token_response(access_token, Some(3600)); + resp.set_refresh_token(Some(RefreshToken::new(refresh_token.to_string()))); + resp + } + + async fn manager_with_refresh_error(error: &'static str) -> AuthorizationManager { + use axum::{Router, body::Body, http::Response, routing::post}; + + let app = Router::new().route( + "/token", + post(move || async move { + Response::builder() + .status(400) + .header("content-type", "application/json") + .body(Body::from( + serde_json::json!({ + "error": error, + "error_description": "refresh failed", + }) + .to_string(), + )) + .unwrap() + }), + ); + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let addr = listener.local_addr().unwrap(); + tokio::spawn(async move { axum::serve(listener, app).await.unwrap() }); + + let mut manager = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: format!("http://{addr}/authorize"), + token_endpoint: format!("http://{addr}/token"), + ..Default::default() + })) + .await; + manager.configure_client(test_client_config()).unwrap(); + manager + .credential_store + .save(StoredCredentials { + client_id: "my-client".to_string(), + token_response: Some(make_token_response_with_refresh( + "old-token", + "my-refresh-token", + )), + granted_scopes: vec![], + token_received_at: Some(AuthorizationManager::now_epoch_secs()), + issuer: None, + }) + .await + .unwrap(); + manager + } + + #[tokio::test] + async fn refresh_token_returns_error_when_no_stored_credentials() { + let mut manager = manager_with_metadata(None).await; + manager.configure_client(test_client_config()).unwrap(); + + let err = manager.refresh_token().await.unwrap_err(); + assert!( + matches!(err, AuthError::AuthorizationRequired), + "expected AuthorizationRequired when no credentials stored, got: {err:?}" + ); + } + + #[tokio::test] + async fn refresh_token_returns_error_when_no_token_response() { + let mut manager = manager_with_metadata(None).await; + manager.configure_client(test_client_config()).unwrap(); + + let stored = StoredCredentials { + client_id: "my-client".to_string(), + token_response: None, + granted_scopes: vec![], + token_received_at: None, + issuer: None, + }; + manager.credential_store.save(stored).await.unwrap(); + + let err = manager.refresh_token().await.unwrap_err(); + assert!( + matches!(err, AuthError::AuthorizationRequired), + "expected AuthorizationRequired when token_response is None, got: {err:?}" + ); + } + + #[tokio::test] + async fn refresh_token_returns_error_when_no_refresh_token() { + let mut manager = manager_with_metadata(None).await; + manager.configure_client(test_client_config()).unwrap(); + + let stored = StoredCredentials { + client_id: "my-client".to_string(), + token_response: Some(make_token_response("old-token", Some(3600))), + granted_scopes: vec![], + token_received_at: Some(AuthorizationManager::now_epoch_secs()), + issuer: None, + }; + manager.credential_store.save(stored).await.unwrap(); + + let err = manager.refresh_token().await.unwrap_err(); + assert!( + matches!(err, AuthError::AuthorizationRequired), + "expected AuthorizationRequired when no refresh token, got: {err:?}" + ); + } + + #[tokio::test] + async fn invalid_grant_refresh_requires_reauthorization() { + let manager = manager_with_refresh_error("invalid_grant").await; + + let err = manager.try_refresh_or_reauth().await.unwrap_err(); + + assert!( + matches!(err, AuthError::AuthorizationRequired), + "expected AuthorizationRequired when the refresh token is rejected, got: {err:?}" + ); + } + + #[tokio::test] + async fn temporary_refresh_failure_does_not_require_reauthorization() { + let manager = manager_with_refresh_error("temporarily_unavailable").await; + + let err = manager.try_refresh_or_reauth().await.unwrap_err(); + + assert!( + matches!(err, AuthError::TokenRefreshFailed(_)), + "expected TokenRefreshFailed for a temporary provider failure, got: {err:?}" + ); + } + + #[tokio::test] + async fn refresh_token_uses_client_configured_by_with_client() { + use axum::{Router, body::Body, http::Response, routing::post}; + + let received_header = Arc::new(std::sync::Mutex::new(None)); + let received_header_clone = Arc::clone(&received_header); + let app = Router::new().route( + "/token", + post(move |headers: axum::http::HeaderMap| { + let received_header = Arc::clone(&received_header_clone); + async move { + *received_header.lock().unwrap() = headers + .get("x-custom-client") + .and_then(|value| value.to_str().ok()) + .map(str::to_string); + Response::builder() + .status(200) + .header("content-type", "application/json") + .body(Body::from( + r#"{"access_token":"new-token","token_type":"Bearer","expires_in":3600}"#, + )) + .unwrap() + } + }), + ); + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let addr = listener.local_addr().unwrap(); + tokio::spawn(async move { axum::serve(listener, app).await.unwrap() }); + + let mut manager = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: format!("http://{addr}/authorize"), + token_endpoint: format!("http://{addr}/token"), + ..Default::default() + })) + .await; + let mut default_headers = reqwest::header::HeaderMap::new(); + default_headers.insert("x-custom-client", "configured".parse().unwrap()); + manager + .with_client( + reqwest::Client::builder() + .default_headers(default_headers) + .build() + .unwrap(), + ) + .unwrap(); + manager.configure_client(test_client_config()).unwrap(); + manager + .credential_store + .save(StoredCredentials { + client_id: "my-client".to_string(), + token_response: Some(make_token_response_with_refresh( + "old-token", + "my-refresh-token", + )), + granted_scopes: vec![], + token_received_at: Some(AuthorizationManager::now_epoch_secs()), + issuer: None, + }) + .await + .unwrap(); + + manager.refresh_token().await.unwrap(); + + assert_eq!( + received_header.lock().unwrap().as_deref(), + Some("configured") + ); + } + + #[tokio::test] + async fn exchange_code_uses_client_configured_by_with_client() { + use axum::{Router, body::Body, http::Response, routing::post}; + + let received_header = Arc::new(std::sync::Mutex::new(None)); + let received_header_clone = Arc::clone(&received_header); + let app = Router::new().route( + "/token", + post(move |headers: axum::http::HeaderMap| { + let received_header = Arc::clone(&received_header_clone); + async move { + *received_header.lock().unwrap() = headers + .get("x-custom-client") + .and_then(|value| value.to_str().ok()) + .map(str::to_string); + Response::builder() + .status(200) + .header("content-type", "application/json") + .body(Body::from( + r#"{"access_token":"new-token","token_type":"Bearer","expires_in":3600}"#, + )) + .unwrap() + } + }), + ); + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let addr = listener.local_addr().unwrap(); + tokio::spawn(async move { axum::serve(listener, app).await.unwrap() }); + + let mut manager = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: format!("http://{addr}/authorize"), + token_endpoint: format!("http://{addr}/token"), + ..Default::default() + })) + .await; + let mut default_headers = reqwest::header::HeaderMap::new(); + default_headers.insert("x-custom-client", "configured".parse().unwrap()); + manager + .with_client( + reqwest::Client::builder() + .default_headers(default_headers) + .build() + .unwrap(), + ) + .unwrap(); + manager.configure_client(test_client_config()).unwrap(); + let authorization_url = manager.get_authorization_url(&[]).await.unwrap(); + let state = Url::parse(&authorization_url) + .unwrap() + .query_pairs() + .find(|(name, _)| name == "state") + .unwrap() + .1 + .into_owned(); + + manager + .exchange_code_for_token("authorization-code", &state) + .await + .unwrap(); + + assert_eq!( + received_header.lock().unwrap().as_deref(), + Some("configured") + ); + } + + #[tokio::test] + async fn exchange_code_follows_redirects_with_with_client() { + use std::sync::atomic::{AtomicBool, Ordering}; + + use axum::{ + Router, + body::Body, + http::{Response, StatusCode}, + routing::post, + }; + + // The token endpoint replies with a 307 redirect; the with_client path reuses + // the caller's redirect-following client, so the request is expected to follow + // it to the final endpoint that returns the token. + let final_endpoint_hit = Arc::new(AtomicBool::new(false)); + let final_endpoint_hit_clone = Arc::clone(&final_endpoint_hit); + let app = Router::new() + .route( + "/token", + post(|| async { + Response::builder() + .status(StatusCode::TEMPORARY_REDIRECT) + .header("location", "/token-final") + .body(Body::empty()) + .unwrap() + }), + ) + .route( + "/token-final", + post(move || { + let final_endpoint_hit = Arc::clone(&final_endpoint_hit_clone); + async move { + final_endpoint_hit.store(true, Ordering::SeqCst); + Response::builder() + .status(200) + .header("content-type", "application/json") + .body(Body::from( + r#"{"access_token":"redirected-token","token_type":"Bearer","expires_in":3600}"#, + )) + .unwrap() + } + }), + ); + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let addr = listener.local_addr().unwrap(); + tokio::spawn(async move { axum::serve(listener, app).await.unwrap() }); + + let mut manager = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: format!("http://{addr}/authorize"), + token_endpoint: format!("http://{addr}/token"), + ..Default::default() + })) + .await; + manager + .with_client(reqwest::Client::builder().build().unwrap()) + .unwrap(); + manager.configure_client(test_client_config()).unwrap(); + let authorization_url = manager.get_authorization_url(&[]).await.unwrap(); + let state = Url::parse(&authorization_url) + .unwrap() + .query_pairs() + .find(|(name, _)| name == "state") + .unwrap() + .1 + .into_owned(); + + manager + .exchange_code_for_token("authorization-code", &state) + .await + .unwrap(); + + assert!( + final_endpoint_hit.load(Ordering::SeqCst), + "with_client path should follow redirects on token exchange" + ); + } + + async fn start_token_server() -> (String, Arc>>) { + use axum::{Router, body::Body, http::Response, routing::post}; + let captured: Arc>> = Arc::new(std::sync::Mutex::new(None)); + let captured_clone = Arc::clone(&captured); + + let app = Router::new().route( + "/token", + post(move |body: axum::body::Bytes| { + let cap = Arc::clone(&captured_clone); + async move { + *cap.lock().unwrap() = + Some(String::from_utf8(body.to_vec()).unwrap()); + Response::builder() + .status(200) + .header("content-type", "application/json") + .body(Body::from( + r#"{"access_token":"new-token","token_type":"Bearer","expires_in":3600}"#, + )) + .unwrap() + } + }), + ); + + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let addr = listener.local_addr().unwrap(); + tokio::spawn(async move { axum::serve(listener, app).await.unwrap() }); + + (format!("http://{}", addr), captured) + } + + #[tokio::test] + async fn refresh_token_sends_granted_scopes_in_request() { + let (base_url, captured) = start_token_server().await; + + let mut manager = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: format!("{}/authorize", base_url), + token_endpoint: format!("{}/token", base_url), + ..Default::default() + })) + .await; + manager.configure_client(test_client_config()).unwrap(); + + let stored = StoredCredentials { + client_id: "my-client".to_string(), + token_response: Some(make_token_response_with_refresh( + "old-token", + "my-refresh-token", + )), + granted_scopes: vec!["read".to_string(), "write".to_string()], + token_received_at: Some(AuthorizationManager::now_epoch_secs()), + issuer: None, + }; + manager.credential_store.save(stored).await.unwrap(); + + manager.refresh_token().await.unwrap(); + + let body = captured.lock().unwrap().take().unwrap(); + let params: std::collections::HashMap<_, _> = url::form_urlencoded::parse(body.as_bytes()) + .into_owned() + .collect(); + let scope = params + .get("scope") + .expect("scope should be present in refresh request"); + let mut scope_parts: Vec<&str> = scope.split_whitespace().collect(); + scope_parts.sort_unstable(); + assert_eq!(scope_parts, vec!["read", "write"]); + } + + #[tokio::test] + async fn refresh_token_includes_resource_parameter() { + let (base_url, captured) = start_token_server().await; + + let mut manager = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: format!("{}/authorize", base_url), + token_endpoint: format!("{}/token", base_url), + ..Default::default() + })) + .await; + manager.configure_client(test_client_config()).unwrap(); + + let stored = StoredCredentials { + client_id: "my-client".to_string(), + token_response: Some(make_token_response_with_refresh( + "old-token", + "my-refresh-token", + )), + granted_scopes: vec![], + token_received_at: Some(AuthorizationManager::now_epoch_secs()), + issuer: None, + }; + manager.credential_store.save(stored).await.unwrap(); + + manager.refresh_token().await.unwrap(); + + let body = captured.lock().unwrap().take().unwrap(); + let params: std::collections::HashMap<_, _> = url::form_urlencoded::parse(body.as_bytes()) + .into_owned() + .collect(); + assert_eq!( + params.get("resource").map(String::as_str), + Some("http://localhost/"), + "refresh requests must carry the RFC 8707 resource parameter, got body: {body}" + ); + } + + #[tokio::test] + async fn refresh_token_adds_offline_access_when_as_supports_it() { + let (base_url, captured) = start_token_server().await; + + let mut manager = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: format!("{}/authorize", base_url), + token_endpoint: format!("{}/token", base_url), + scopes_supported: Some(vec!["read".to_string(), "offline_access".to_string()]), + ..Default::default() + })) + .await; + manager.configure_client(test_client_config()).unwrap(); + + let stored = StoredCredentials { + client_id: "my-client".to_string(), + token_response: Some(make_token_response_with_refresh( + "old-token", + "my-refresh-token", + )), + granted_scopes: vec!["read".to_string()], + token_received_at: Some(AuthorizationManager::now_epoch_secs()), + issuer: None, + }; + manager.credential_store.save(stored).await.unwrap(); + + manager.refresh_token().await.unwrap(); + + let body = captured.lock().unwrap().take().unwrap(); + let params: std::collections::HashMap<_, _> = url::form_urlencoded::parse(body.as_bytes()) + .into_owned() + .collect(); + let scope = params + .get("scope") + .expect("scope should be present in refresh request"); + let mut scope_parts: Vec<&str> = scope.split_whitespace().collect(); + scope_parts.sort_unstable(); + assert_eq!(scope_parts, vec!["offline_access", "read"]); + } + + #[tokio::test] + async fn refresh_token_omits_scope_when_granted_scopes_is_empty() { + let (base_url, captured) = start_token_server().await; + + let mut manager = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: format!("{}/authorize", base_url), + token_endpoint: format!("{}/token", base_url), + ..Default::default() + })) + .await; + manager.configure_client(test_client_config()).unwrap(); + + let stored = StoredCredentials { + client_id: "my-client".to_string(), + token_response: Some(make_token_response_with_refresh( + "old-token", + "my-refresh-token", + )), + granted_scopes: vec![], + token_received_at: Some(AuthorizationManager::now_epoch_secs()), + issuer: None, + }; + manager.credential_store.save(stored).await.unwrap(); + + manager.refresh_token().await.unwrap(); + + let body = captured.lock().unwrap().take().unwrap(); + let params: std::collections::HashMap<_, _> = url::form_urlencoded::parse(body.as_bytes()) + .into_owned() + .collect(); + assert!( + !params.contains_key("scope"), + "scope should be absent when granted_scopes is empty, body: {body}" + ); + } + + #[tokio::test] + async fn refresh_token_preserves_existing_refresh_token_when_response_omits_it() { + use oauth2::TokenResponse; + // start_token_server returns a response without a refresh_token, matching + // an authorization server that does not rotate refresh tokens on refresh. + let (base_url, _captured) = start_token_server().await; + + let mut manager = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: format!("{}/authorize", base_url), + token_endpoint: format!("{}/token", base_url), + ..Default::default() + })) + .await; + manager.configure_client(test_client_config()).unwrap(); + + let stored = StoredCredentials { + client_id: "my-client".to_string(), + token_response: Some(make_token_response_with_refresh( + "old-token", + "my-refresh-token", + )), + granted_scopes: vec![], + token_received_at: Some(AuthorizationManager::now_epoch_secs()), + issuer: None, + }; + manager.credential_store.save(stored).await.unwrap(); + + let result = manager.refresh_token().await.unwrap(); + assert_eq!( + result.refresh_token().map(|t| t.secret().as_str()), + Some("my-refresh-token"), + "returned response should keep the previous refresh token" + ); + + let reloaded = manager + .credential_store + .load() + .await + .unwrap() + .unwrap() + .token_response + .unwrap(); + assert_eq!( + reloaded.refresh_token().map(|t| t.secret().as_str()), + Some("my-refresh-token"), + "stored credentials should keep the previous refresh token" + ); + } + + #[tokio::test] + async fn refresh_token_replaces_refresh_token_when_response_includes_new_one() { + use axum::{Router, body::Body, http::Response, routing::post}; + use oauth2::TokenResponse; + + let app = Router::new().route( + "/token", + post(|| async { + Response::builder() + .status(200) + .header("content-type", "application/json") + .body(Body::from( + r#"{"access_token":"new-token","token_type":"Bearer","expires_in":3600,"refresh_token":"rotated-refresh-token"}"#, + )) + .unwrap() + }), + ); + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let addr = listener.local_addr().unwrap(); + tokio::spawn(async move { axum::serve(listener, app).await.unwrap() }); + let base_url = format!("http://{}", addr); + + let mut manager = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: format!("{}/authorize", base_url), + token_endpoint: format!("{}/token", base_url), + ..Default::default() + })) + .await; + manager.configure_client(test_client_config()).unwrap(); + + let stored = StoredCredentials { + client_id: "my-client".to_string(), + token_response: Some(make_token_response_with_refresh( + "old-token", + "my-refresh-token", + )), + granted_scopes: vec![], + token_received_at: Some(AuthorizationManager::now_epoch_secs()), + issuer: None, + }; + manager.credential_store.save(stored).await.unwrap(); + + let result = manager.refresh_token().await.unwrap(); + assert_eq!( + result.refresh_token().map(|t| t.secret().as_str()), + Some("rotated-refresh-token"), + "a rotated refresh token from the response should replace the old one" + ); + } + + #[derive(Clone)] + struct RefreshStore { + credentials: InMemoryCredentialStore, + lock: Arc>, + events: Arc>>, + guard_requested: Arc, + save_started: Arc, + save_gate: Option>, + fail_at: Option<&'static str>, + } + + struct ObservedRefreshGuard { + _lock: OwnedMutexGuard<()>, + events: Arc>>, + } + + impl Drop for ObservedRefreshGuard { + fn drop(&mut self) { + self.events.lock().unwrap().push("release"); + } + } + + #[async_trait::async_trait] + impl CredentialStore for RefreshStore { + async fn load(&self) -> Result, AuthError> { + self.events.lock().unwrap().push("load"); + if self.fail_at == Some("load") { + return Err(AuthError::CredentialStoreError("load failed".into())); + } + self.credentials.load().await + } + + async fn save(&self, credentials: StoredCredentials) -> Result<(), AuthError> { + self.events.lock().unwrap().push("save"); + self.save_started.add_permits(1); + if let Some(gate) = &self.save_gate { + gate.acquire().await.unwrap().forget(); + } + if self.fail_at == Some("save") { + return Err(AuthError::CredentialStoreError("save failed".into())); + } + self.credentials.save(credentials).await?; + self.events.lock().unwrap().push("saved"); + Ok(()) + } + + async fn clear(&self) -> Result<(), AuthError> { + self.credentials.clear().await + } + + async fn acquire_refresh_guard(&self) -> Result, AuthError> { + self.events.lock().unwrap().push("acquire"); + self.guard_requested.add_permits(1); + if self.fail_at == Some("guard") { + return Err(AuthError::CredentialStoreError("guard failed".into())); + } + let lock = self.lock.clone().lock_owned().await; + self.events.lock().unwrap().push("acquired"); + Ok(Some(CredentialRefreshGuard::new(ObservedRefreshGuard { + _lock: lock, + events: self.events.clone(), + }))) + } + } + + async fn refresh_store() -> RefreshStore { + let credentials = StoredCredentials::new( + "my-client".into(), + Some(make_token_response_with_refresh("old-token", "old-refresh")), + vec!["read".into()], + Some(AuthorizationManager::now_epoch_secs()), + ); + let credential_store = InMemoryCredentialStore::new(); + credential_store.save(credentials).await.unwrap(); + RefreshStore { + credentials: credential_store, + lock: Arc::new(Mutex::new(())), + events: Arc::new(StdMutex::new(Vec::new())), + guard_requested: Arc::new(Semaphore::new(0)), + save_started: Arc::new(Semaphore::new(0)), + save_gate: None, + fail_at: None, + } + } + + struct RefreshHttpClient { + recording: RecordingOAuthHttpClient, + events: Arc>>, + } + + impl OAuthHttpClient for RefreshHttpClient { + fn execute(&self, request: OAuthHttpRequest) -> OAuthHttpClientFuture<'_> { + self.events.lock().unwrap().push("provider"); + self.recording.execute(request) + } + } + + fn refresh_http_client(store: &RefreshStore) -> Arc { + Arc::new(RefreshHttpClient { + recording: RecordingOAuthHttpClient::with_responses( + [ + ("new-token", "new-refresh"), + ("latest-token", "latest-refresh"), + ] + .into_iter() + .map(|(access, refresh)| { + http_response( + 200, + serde_json::json!({ + "access_token": access, "token_type": "Bearer", + "expires_in": 3600, "refresh_token": refresh + }), + ) + }) + .collect(), + ), + events: store.events.clone(), + }) + } + + async fn refresh_manager( + store: RefreshStore, + http_client: Arc, + ) -> AuthorizationManager { + let mut manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + http_client, + ) + .await + .unwrap(); + manager.set_metadata(AuthorizationMetadata { + authorization_endpoint: "https://auth.example.com/authorize".into(), + token_endpoint: "https://auth.example.com/token".into(), + ..Default::default() + }); + manager.configure_client(test_client_config()).unwrap(); + manager.set_credential_store(store); + *manager.current_scopes.write().await = vec!["cached".into()]; + manager + } + + async fn wait_for_permits(semaphore: &Semaphore, count: u32) { + tokio::time::timeout( + std::time::Duration::from_secs(5), + semaphore.acquire_many(count), + ) + .await + .unwrap() + .unwrap() + .forget(); + } + + #[tokio::test] + async fn refresh_guard_spans_load_exchange_and_completed_save() { + let store = refresh_store().await; + let manager = refresh_manager(store.clone(), refresh_http_client(&store)).await; + + manager.refresh_token().await.unwrap(); + + assert_eq!( + *store.events.lock().unwrap(), + [ + "acquire", "acquired", "load", "provider", "save", "saved", "release" + ] + ); + let saved = store.credentials.load().await.unwrap().unwrap(); + assert_eq!( + saved + .token_response + .unwrap() + .refresh_token() + .unwrap() + .secret(), + "new-refresh" + ); + assert_eq!(saved.granted_scopes, ["read"]); + assert!(store.lock.try_lock().is_ok()); + } + + #[tokio::test] + async fn concurrent_refreshes_wait_for_save_and_use_the_latest_token() { + let mut store = refresh_store().await; + let save_gate = Arc::new(Semaphore::new(0)); + store.save_gate = Some(save_gate.clone()); + let http_client = refresh_http_client(&store); + let first_manager = refresh_manager(store.clone(), http_client.clone()).await; + let second_manager = refresh_manager(store.clone(), http_client.clone()).await; + + let first = tokio::spawn(async move { first_manager.refresh_token().await }); + wait_for_permits(&store.save_started, 1).await; + let second = tokio::spawn(async move { second_manager.refresh_token().await }); + wait_for_permits(&store.guard_requested, 2).await; + assert_eq!(http_client.recording.requests().len(), 1); + assert!(store.lock.try_lock().is_err()); + + save_gate.add_permits(2); + let (first, second) = tokio::join!(first, second); + assert_eq!(first.unwrap().unwrap().access_token().secret(), "new-token"); + assert_eq!( + second.unwrap().unwrap().access_token().secret(), + "latest-token" + ); + let refresh_tokens: Vec = http_client + .recording + .requests() + .iter() + .map(|request| { + url::form_urlencoded::parse(&request.body) + .find_map(|(key, value)| (key == "refresh_token").then(|| value.into_owned())) + .unwrap() + }) + .collect(); + assert_eq!(refresh_tokens, ["old-refresh", "new-refresh"]); + let saved = store.credentials.load().await.unwrap().unwrap(); + assert_eq!( + saved + .token_response + .unwrap() + .refresh_token() + .unwrap() + .secret(), + "latest-refresh" + ); + assert!(store.lock.try_lock().is_ok()); + } + + #[tokio::test] + async fn refresh_rejects_credentials_for_another_client() { + let store = refresh_store().await; + let mut credentials = store.credentials.load().await.unwrap().unwrap(); + credentials.client_id = "other-client".into(); + store.credentials.save(credentials).await.unwrap(); + let http_client = refresh_http_client(&store); + let manager = refresh_manager(store.clone(), http_client.clone()).await; + + assert!(matches!( + manager.refresh_token().await, + Err(AuthError::AuthorizationRequired) + )); + assert!(http_client.recording.requests().is_empty()); + assert!(store.lock.try_lock().is_ok()); + } + + #[tokio::test] + async fn refresh_rejects_credentials_for_another_client_without_a_guard() { + let (base_url, captured) = start_token_server().await; + let mut manager = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: format!("{base_url}/authorize"), + token_endpoint: format!("{base_url}/token"), + ..Default::default() + })) + .await; + manager.configure_client(test_client_config()).unwrap(); + manager + .credential_store + .save(StoredCredentials::new( + "other-client".into(), + Some(make_token_response_with_refresh("old-token", "old-refresh")), + vec!["read".into()], + Some(AuthorizationManager::now_epoch_secs()), + )) + .await + .unwrap(); + + let error = manager.refresh_token().await.unwrap_err(); + + assert!( + matches!(error, AuthError::AuthorizationRequired), + "a client mismatch must require reauthorization, got: {error:?}" + ); + assert!( + captured.lock().unwrap().is_none(), + "a client mismatch must be caught before the refresh token leaves the process" + ); + } + + #[tokio::test] + async fn refresh_without_a_guard_keeps_stored_scopes_when_response_omits_them() { + // start_token_server answers without a `scope`, matching a provider that + // grants the request in full. + let (base_url, _captured) = start_token_server().await; + let mut manager = manager_with_metadata(Some(AuthorizationMetadata { + authorization_endpoint: format!("{base_url}/authorize"), + token_endpoint: format!("{base_url}/token"), + ..Default::default() + })) + .await; + manager.configure_client(test_client_config()).unwrap(); + manager + .credential_store + .save(StoredCredentials::new( + "my-client".into(), + Some(make_token_response_with_refresh("old-token", "old-refresh")), + vec!["read".into()], + Some(AuthorizationManager::now_epoch_secs()), + )) + .await + .unwrap(); + *manager.current_scopes.write().await = vec!["stale".into()]; + + manager.refresh_token().await.unwrap(); + + let saved = manager.credential_store.load().await.unwrap().unwrap(); + assert_eq!( + saved.granted_scopes, + ["read"], + "the stored grant outranks the per-process scope cache" + ); + assert_eq!( + manager.get_current_scopes().await, + ["read"], + "the refreshed grant must replace the stale scope cache" + ); + } + + #[rstest] + #[case("guard", 0)] + #[case("load", 0)] + #[case("save", 1)] + #[tokio::test] + async fn refresh_store_failures_release_the_guard( + #[case] phase: &'static str, + #[case] provider_requests: usize, + ) { + let mut store = refresh_store().await; + store.fail_at = Some(phase); + let http_client = refresh_http_client(&store); + let manager = refresh_manager(store.clone(), http_client.clone()).await; + + assert!(matches!(manager.refresh_token().await, + Err(AuthError::CredentialStoreError(message)) if message == format!("{phase} failed"))); + assert_eq!(http_client.recording.requests().len(), provider_requests); + let saved = store.credentials.load().await.unwrap().unwrap(); + assert_eq!( + saved + .token_response + .unwrap() + .refresh_token() + .unwrap() + .secret(), + "old-refresh" + ); + assert!(store.lock.try_lock().is_ok()); + } +} diff --git a/vendor/rmcp/src/transport/auth/enterprise.rs b/vendor/rmcp/src/transport/auth/enterprise.rs new file mode 100644 index 00000000..226c8d53 --- /dev/null +++ b/vendor/rmcp/src/transport/auth/enterprise.rs @@ -0,0 +1,767 @@ +//! Non-interactive enterprise-managed authorization (EMA/XAA) token exchanges. +//! +//! Exchanges an enterprise refresh token for an ID-JAG, then for an MCP access +//! token. Callers must discover and approve both servers and their registrations +//! before supplying a credential. This module does not discover servers, log in, +//! persist credentials, or decide when to reauthenticate. +//! +//! Configure each pre-registered client's approved authentication method separately: +//! HTTP Basic, a client secret in the request body, or a freshly signed JWT client +//! assertion. Public-client authentication requires the server's explicit approval. +//! This helper requires one MCP resource and does not implement Rich +//! Authorization Requests or DPoP. Redemption consumes the SDK's ID-JAG handle, +//! without automatic retries; server-side replay policy remains the server's responsibility. +//! +//! ID-JAG checks below enforce structure and claim bindings, not cryptographic +//! signature verification. Assertions come directly from the trusted IdP token +//! endpoint; the resource authorization server must verify their signatures. +//! +//! ```no_run +//! use oauth2::{ClientSecret, RefreshToken}; +//! use rmcp::transport::auth::{default_oauth_http_client, enterprise::*}; +//! +//! # async fn authorize(refresh: &RefreshToken, idp_secret: ClientSecret, resource_secret: ClientSecret) -> Result<(), Box> { +//! // Enable `auth-enterprise-managed` and a TLS feature such as `reqwest`. +//! let http = default_oauth_http_client()?; +//! let token = EmaExchangeRequest::new( +//! EmaAuthorizationServer::new("https://idp.example", "https://idp.example/token", "idp-client") +//! .with_client_authentication(EmaClientAuthentication::ClientSecretBasic(idp_secret)), +//! EmaAuthorizationServer::new("https://as.example", "https://as.example/token", "mcp-client") +//! .with_client_authentication(EmaClientAuthentication::ClientSecretBasic(resource_secret)), +//! "https://mcp.example", refresh, +//! ).with_scopes(["files.read"]).exchange(&http, &http).await?; +//! // Use token.access_token only for the approved MCP resource; never log it. +//! // token.scopes contains the final granted scopes, which may be narrower. +//! # Ok(()) } +//! ``` + +use std::{ + collections::HashSet, + sync::Arc, + time::{Duration, SystemTime, UNIX_EPOCH}, +}; + +use base64::{ + Engine, + engine::general_purpose::{STANDARD, URL_SAFE_NO_PAD}, +}; +use oauth2::{AccessToken, ClientSecret, RefreshToken}; +use serde::{Deserialize, de::DeserializeOwned}; +use thiserror::Error; +use url::{Host, Url}; + +use super::{ + DEFAULT_HTTP_TIMEOUT, MAX_OAUTH_HTTP_RESPONSE_BODY_BYTES, OAuthHttpClient, + OAuthHttpRedirectPolicy, OAuthHttpRequest, +}; + +const ID_JAG_TOKEN_TYPE: &str = "urn:ietf:params:oauth:token-type:id-jag"; + +/// Authentication approved for a pre-registered client at one authorization server. +/// +/// The selected method is used as configured, without negotiation or fallback. +#[derive(Clone)] +#[non_exhaustive] +pub enum EmaClientAuthentication { + /// Public client (`token_endpoint_auth_method=none`), only if the server permits it. + None, + /// `client_secret_basic`, with OAuth form encoding before HTTP Basic encoding. + ClientSecretBasic(ClientSecret), + /// `client_secret_post`, for servers requiring credentials in the request body. + ClientSecretPost(ClientSecret), + /// Fresh JWT client assertions, such as `private_key_jwt` or `client_secret_jwt`. + /// Signing, key custody, claims, and the registered algorithm belong to the provider. + JwtAssertion(Arc), +} + +impl std::fmt::Debug for EmaClientAuthentication { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str(match self { + Self::None => "None", + Self::ClientSecretBasic(_) => "ClientSecretBasic { .. }", + Self::ClientSecretPost(_) => "ClientSecretPost { .. }", + Self::JwtAssertion(_) => "JwtAssertion { .. }", + }) + } +} + +impl EmaClientAuthentication { + fn validate(&self) -> Result<(), EmaError> { + if let Self::ClientSecretBasic(secret) | Self::ClientSecretPost(secret) = self + && secret.secret().trim().is_empty() + { + return Err(EmaError::InvalidRequest("client secret must not be empty")); + } + Ok(()) + } +} + +/// A signed JWT used to authenticate the client, distinct from the ID-JAG grant. +pub struct EmaClientAssertion(String); + +impl EmaClientAssertion { + /// Wrap a fresh assertion without exposing it through `Debug`. + pub fn new(assertion: String) -> Self { + Self(assertion) + } +} + +impl std::fmt::Debug for EmaClientAssertion { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str("EmaClientAssertion { .. }") + } +} + +/// Creates client assertions on demand, allowing keys to remain in an external signer. +/// +/// Called once immediately before each token request, including delayed ID-JAG +/// redemption. Set `iss` and `sub` to the registered client identifier and `aud` +/// to the server's approved audience, with a short expiration and a fresh `jti`. +/// The SDK does not sign or validate these assertions. Provider failures are +/// sanitized and the call shares the token request's timeout. Cancellation may +/// occur when that deadline expires. +#[async_trait::async_trait] +pub trait EmaClientAssertionProvider: Send + Sync { + async fn create_assertion( + &self, + server: &EmaAuthorizationServer, + ) -> Result>; +} + +/// A trusted server with a pre-registered client and its approved authentication method. +#[derive(Clone)] +#[non_exhaustive] +pub struct EmaAuthorizationServer { + /// Exact issuer identifier from approved metadata. + pub issuer: String, + /// Token endpoint from that metadata. + pub token_endpoint: String, + /// Pre-registered client identifier. + pub client_id: String, + client_authentication: EmaClientAuthentication, +} + +impl EmaAuthorizationServer { + /// Use approved metadata and a public-client registration (`token_endpoint_auth_method=none`). + /// Set [`Self::with_client_authentication`] for a confidential client. + pub fn new( + issuer: impl Into, + token_endpoint: impl Into, + client_id: impl Into, + ) -> Self { + Self { + issuer: issuer.into(), + token_endpoint: token_endpoint.into(), + client_id: client_id.into(), + client_authentication: EmaClientAuthentication::None, + } + } + + /// Select the authentication method approved for this server's client registration. + pub fn with_client_authentication(mut self, authentication: EmaClientAuthentication) -> Self { + self.client_authentication = authentication; + self + } +} + +/// A refresh-token exchange bound to one MCP resource and two registered clients. +pub struct EmaExchangeRequest<'a> { + idp: EmaAuthorizationServer, + resource_as: EmaAuthorizationServer, + resource: &'a str, + refresh_token: &'a RefreshToken, + scopes: Vec, +} + +impl<'a> EmaExchangeRequest<'a> { + /// No scope parameter is sent until [`Self::with_scopes`] is used. + pub fn new( + idp: EmaAuthorizationServer, + resource_as: EmaAuthorizationServer, + resource: &'a str, + refresh_token: &'a RefreshToken, + ) -> Self { + Self { + idp, + resource_as, + resource, + refresh_token, + scopes: Vec::new(), + } + } + + /// Request distinct non-empty scope tokens; the IdP may narrow them. + /// An empty iterator omits `scope`, rather than requesting an empty grant. + pub fn with_scopes(mut self, scopes: I) -> Self + where + I: IntoIterator, + S: Into, + { + self.scopes = scopes.into_iter().map(Into::into).collect(); + self + } + + /// Obtain an ID-JAG without redirects or retries, checking its resource/client bindings. + /// The returned assertion does not retain the enterprise refresh token. + pub async fn exchange_id_jag( + self, + idp_http: &dyn OAuthHttpClient, + ) -> Result { + for endpoint in [ + self.resource, + &self.idp.issuer, + &self.idp.token_endpoint, + &self.resource_as.issuer, + &self.resource_as.token_endpoint, + ] { + validate_endpoint(endpoint)?; + } + if self.idp.issuer == self.resource_as.issuer { + return Err(EmaError::InvalidRequest( + "IdP and resource AS issuers must differ", + )); + } + if self.idp.client_id.trim().is_empty() + || self.resource_as.client_id.trim().is_empty() + || self.refresh_token.secret().trim().is_empty() + { + return Err(EmaError::InvalidRequest( + "client IDs and refresh token must not be empty", + )); + } + self.idp.client_authentication.validate()?; + self.resource_as.client_authentication.validate()?; + let requested: HashSet<&str> = self.scopes.iter().map(String::as_str).collect(); + if requested.len() != self.scopes.len() || self.scopes.iter().any(|s| !is_scope_token(s)) { + return Err(EmaError::InvalidRequest( + "scopes must be distinct non-empty tokens", + )); + } + let mut params = vec![ + ( + "grant_type", + "urn:ietf:params:oauth:grant-type:token-exchange", + ), + ("requested_token_type", ID_JAG_TOKEN_TYPE), + ( + "subject_token_type", + "urn:ietf:params:oauth:token-type:refresh_token", + ), + ("subject_token", self.refresh_token.secret()), + ("audience", self.resource_as.issuer.as_str()), + ("resource", self.resource), + ]; + let scope = self.scopes.join(" "); + if !scope.is_empty() { + params.push(("scope", &scope)); + } + let jag: IdJagResponse = post_form( + idp_http, + &self.idp, + ¶ms, + EmaExchangeStage::IdentityProvider, + None, + unix_time, + ) + .await?; + let (granted, expires_at) = jag.validate(&self, &requested)?; + Ok(EmaIdJag { + assertion: AccessToken::new(jag.access_token), + scopes: granted, + resource_as: self.resource_as, + resource: self.resource.to_owned(), + expires_at, + }) + } + + /// Perform both exchanges with independently routed HTTP clients and no automatic retries. + pub async fn exchange( + self, + idp_http: &dyn OAuthHttpClient, + resource_http: &dyn OAuthHttpClient, + ) -> Result { + self.exchange_id_jag(idp_http) + .await? + .exchange(resource_http) + .await + } +} + +/// An IdP-issued ID-JAG whose structure and bindings have been checked, not its signature. +pub struct EmaIdJag { + assertion: AccessToken, + scopes: HashSet, + resource_as: EmaAuthorizationServer, + resource: String, + expires_at: u64, +} + +impl std::fmt::Debug for EmaAuthorizationServer { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str("EmaAuthorizationServer { .. }") + } +} + +impl std::fmt::Debug for EmaExchangeRequest<'_> { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str("EmaExchangeRequest { .. }") + } +} + +impl std::fmt::Debug for EmaIdJag { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str("EmaIdJag { .. }") + } +} + +impl EmaIdJag { + /// The assertion to present to the approved resource authorization server. + pub fn assertion(&self) -> &AccessToken { + &self.assertion + } + + /// The scope tokens carried by the assertion; an empty set means scope was omitted. + pub fn scopes(&self) -> &HashSet { + &self.scopes + } + + /// Redeem this assertion once, at its approved resource AS, without redirects or retries. + /// Consume the grant so this helper cannot accidentally replay it after a failed exchange. + pub async fn exchange(self, http: &dyn OAuthHttpClient) -> Result { + self.exchange_with_clock(http, unix_time).await + } + + async fn exchange_with_clock( + self, + http: &dyn OAuthHttpClient, + now: impl Fn() -> Result + Sync, + ) -> Result { + if self.expires_at <= now()? { + return Err(EmaError::InvalidRequest("ID-JAG expired before redemption")); + } + // Only the assertion carries authority: repeating resource/scope could undo narrowing. + let token: ResourceTokenResponse = post_form( + http, + &self.resource_as, + &[ + ("grant_type", "urn:ietf:params:oauth:grant-type:jwt-bearer"), + ("assertion", self.assertion.secret()), + ], + EmaExchangeStage::ResourceAuthorizationServer, + Some(self.expires_at), + now, + ) + .await?; + token.validate(&self.resource, self.scopes) + } +} + +/// A resource-bound bearer with secret-safe diagnostics and its optional lifetime. +#[derive(Clone)] +#[non_exhaustive] +pub struct EmaAccessToken { + pub access_token: AccessToken, + pub expires_in: Option, + /// Resource-AS scopes, or the ID-JAG scopes when the response omits `scope`. + /// Empty when both the ID-JAG and response omit scopes. + pub scopes: HashSet, +} + +impl std::fmt::Debug for EmaAccessToken { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str("EmaAccessToken { .. }") + } +} + +/// The endpoint that failed, allowing the caller to apply its own credential lifecycle policy. +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +#[non_exhaustive] +pub enum EmaExchangeStage { + IdentityProvider, + ResourceAuthorizationServer, +} + +/// Sanitized failures. Raw HTTP adapter errors and provider response bodies are never retained. +#[derive(Debug, Error, PartialEq, Eq)] +#[non_exhaustive] +pub enum EmaError { + #[error("invalid EMA exchange request: {0}")] + InvalidRequest(&'static str), + #[error("invalid EMA response from {stage:?}: {message}")] + InvalidResponse { + stage: EmaExchangeStage, + message: &'static str, + }, + #[error("EMA request to {0:?} failed")] + RequestFailed(EmaExchangeStage), + #[error("{0:?}: invalid_grant")] + InvalidGrant(EmaExchangeStage), + #[error("{0:?}: insufficient_user_authentication")] + InsufficientUserAuthentication(EmaExchangeStage), + #[error("{stage:?} returned HTTP {status}: {code}")] + OAuthRejected { + stage: EmaExchangeStage, + status: u16, + code: &'static str, + }, +} + +async fn post_form( + http: &dyn OAuthHttpClient, + server: &EmaAuthorizationServer, + params: &[(&str, &str)], + stage: EmaExchangeStage, + grant_expires_at: Option, + now: impl Fn() -> Result + Sync, +) -> Result { + let response = tokio::time::timeout(DEFAULT_HTTP_TIMEOUT, async { + // Generate assertions at the request boundary, not when server configuration is built. + let client_assertion = match &server.client_authentication { + EmaClientAuthentication::JwtAssertion(provider) => { + let assertion = provider + .create_assertion(server) + .await + .map_err(|_| EmaError::RequestFailed(stage))?; + if assertion.0.trim().is_empty() { + return Err(EmaError::InvalidRequest( + "client assertion must not be empty", + )); + } + Some(assertion) + } + _ => None, + }; + let request = { + let mut form = url::form_urlencoded::Serializer::new(String::new()); + form.extend_pairs(params.iter().copied()); + let mut request = oauth2::http::Request::builder() + .method("POST") + .uri(&server.token_endpoint) + .header("content-type", "application/x-www-form-urlencoded") + .header("accept", "application/json"); + match &server.client_authentication { + EmaClientAuthentication::ClientSecretBasic(secret) => { + let client_id: String = + url::form_urlencoded::byte_serialize(server.client_id.as_bytes()).collect(); + let secret: String = + url::form_urlencoded::byte_serialize(secret.secret().as_bytes()).collect(); + let encoded = STANDARD.encode(format!("{client_id}:{secret}")); + let mut header = + oauth2::http::HeaderValue::from_str(&format!("Basic {encoded}")).map_err( + |_| EmaError::InvalidRequest("invalid client authentication header"), + )?; + header.set_sensitive(true); + request = request.header(oauth2::http::header::AUTHORIZATION, header); + } + EmaClientAuthentication::ClientSecretPost(secret) => { + form.append_pair("client_id", &server.client_id) + .append_pair("client_secret", secret.secret()); + } + EmaClientAuthentication::None | EmaClientAuthentication::JwtAssertion(_) => { + form.append_pair("client_id", &server.client_id); + } + } + if let Some(assertion) = client_assertion { + form.append_pair( + "client_assertion_type", + "urn:ietf:params:oauth:client-assertion-type:jwt-bearer", + ) + .append_pair("client_assertion", &assertion.0); + } + request + .body(form.finish().into_bytes()) + .map_err(|_| EmaError::InvalidRequest("invalid token endpoint URI"))? + }; + // An external signer may outlive the grant even when it meets the request deadline. + if let Some(expires_at) = grant_expires_at + && expires_at <= now()? + { + return Err(EmaError::InvalidRequest("ID-JAG expired before redemption")); + } + http.execute(OAuthHttpRequest::new( + request, + OAuthHttpRedirectPolicy::Stop, + )) + .await + .map_err(|_| EmaError::RequestFailed(stage)) + }) + .await + .map_err(|_| EmaError::RequestFailed(stage))??; + let invalid = |message| EmaError::InvalidResponse { stage, message }; + if response.body().len() > MAX_OAUTH_HTTP_RESPONSE_BODY_BYTES { + return Err(invalid("response body too large")); + } + if !response.status().is_success() { + #[derive(Deserialize)] + struct OAuthError { + error: Option, + } + let error = serde_json::from_slice::(response.body()).ok(); + let code = match error.as_ref().and_then(|e| e.error.as_deref()) { + Some("invalid_grant") => return Err(EmaError::InvalidGrant(stage)), + Some("insufficient_user_authentication") => { + return Err(EmaError::InsufficientUserAuthentication(stage)); + } + Some("invalid_request") => "invalid_request", + Some("invalid_client") => "invalid_client", + Some("invalid_scope") => "invalid_scope", + Some("invalid_target") => "invalid_target", + Some("unauthorized_client") => "unauthorized_client", + Some("unsupported_grant_type") => "unsupported_grant_type", + Some("access_denied") => "access_denied", + Some("temporarily_unavailable") => "temporarily_unavailable", + Some("server_error") => "server_error", + _ => "OAuth token request rejected", + }; + return Err(EmaError::OAuthRejected { + stage, + status: response.status().as_u16(), + code, + }); + } + serde_json::from_slice(response.body()).map_err(|_| invalid("malformed token response")) +} + +fn validate_endpoint(value: &str) -> Result<(), EmaError> { + let url = Url::parse(value).map_err(|_| EmaError::InvalidRequest("invalid endpoint URL"))?; + let loopback = match url.host() { + Some(Host::Domain(host)) => host.eq_ignore_ascii_case("localhost"), + Some(Host::Ipv4(ip)) => ip.is_loopback(), + Some(Host::Ipv6(ip)) => ip.is_loopback(), + None => false, + }; + if (url.scheme() != "https" && !(url.scheme() == "http" && loopback)) + || !url.username().is_empty() + || url.password().is_some() + || url.fragment().is_some() + { + return Err(EmaError::InvalidRequest( + "endpoint must use HTTPS or HTTP loopback without userinfo or fragments", + )); + } + Ok(()) +} + +#[derive(Deserialize)] +#[serde(untagged)] +enum Resource { + Single(String), + Multiple(Vec), +} + +impl Resource { + fn is_exact(&self, expected: &str) -> bool { + match self { + Self::Single(value) => value == expected, + Self::Multiple(values) => values.as_slice() == [expected], + } + } +} + +#[derive(Deserialize)] +struct JwtHeader { + alg: String, + typ: Option, +} + +#[derive(Deserialize)] +struct IdJagClaims { + iss: String, + sub: String, + aud: Resource, + client_id: String, + jti: String, + exp: u64, + iat: u64, + resource: Resource, + scope: Option, + authorization_details: Option>, +} + +#[derive(Deserialize)] +struct IdJagResponse { + access_token: String, + issued_token_type: String, + token_type: String, + resource: Option, + scope: Option, + refresh_token: Option, + authorization_details: Option>, +} + +impl IdJagResponse { + fn validate( + &self, + request: &EmaExchangeRequest<'_>, + requested: &HashSet<&str>, + ) -> Result<(HashSet, u64), EmaError> { + let invalid = |message| EmaError::InvalidResponse { + stage: EmaExchangeStage::IdentityProvider, + message, + }; + if self.issued_token_type != ID_JAG_TOKEN_TYPE + || self.token_type != "N_A" + || self.refresh_token.is_some() + { + return Err(invalid("unsupported ID-JAG token type or refresh token")); + } + let mut parts = self.access_token.split('.'); + let (Some(header), Some(payload), Some(signature), None) = + (parts.next(), parts.next(), parts.next(), parts.next()) + else { + return Err(invalid("ID-JAG must be a compact signed JWT")); + }; + if header.is_empty() || payload.is_empty() || signature.is_empty() { + return Err(invalid("ID-JAG contains an empty JWT segment")); + } + let decode = |value| { + URL_SAFE_NO_PAD + .decode(value) + .map_err(|_| invalid("malformed ID-JAG encoding")) + }; + decode(signature)?; + let header: JwtHeader = serde_json::from_slice(&decode(header)?) + .map_err(|_| invalid("malformed ID-JAG header"))?; + let claims: IdJagClaims = serde_json::from_slice(&decode(payload)?) + .map_err(|_| invalid("malformed ID-JAG claims"))?; + if [&self.authorization_details, &claims.authorization_details] + .into_iter() + .any(|details| details.as_ref().is_some_and(|details| !details.is_empty())) + { + return Err(invalid("authorization_details is not supported")); + } + if header.alg.trim().is_empty() + || header.alg.eq_ignore_ascii_case("none") + || header.typ.as_deref() != Some("oauth-id-jag+jwt") + || claims.iss != request.idp.issuer + || !claims.aud.is_exact(&request.resource_as.issuer) + || claims.client_id != request.resource_as.client_id + || claims.sub.trim().is_empty() + || claims.jti.trim().is_empty() + { + return Err(invalid( + "ID-JAG type, issuer, audience, client, subject, or JWT ID mismatch", + )); + } + let now = unix_time()?; + if claims.exp <= now || claims.iat > now.saturating_add(60) { + return Err(invalid("expired or future-issued ID-JAG")); + } + if !claims.resource.is_exact(request.resource) + || self + .resource + .as_ref() + .is_some_and(|r| !r.is_exact(request.resource)) + { + return Err(invalid("ID-JAG resource mismatch")); + } + let parse = + |scope| parse_scope(scope).ok_or_else(|| invalid("malformed or duplicate scopes")); + let granted = match claims.scope.as_deref() { + Some(scope) => parse(scope)?, + None if requested.is_empty() => HashSet::new(), + None => return Err(invalid("ID-JAG is missing requested scope authorization")), + }; + if !requested.is_empty() && !granted.is_subset(requested) { + return Err(invalid("ID-JAG scope exceeds the request")); + } + match self.scope.as_deref() { + Some(scope) if parse(scope)? != granted => { + return Err(invalid("response scope differs from ID-JAG scope")); + } + None if !requested.is_empty() && granted != *requested => { + return Err(invalid("response omitted narrowed scope")); + } + _ => {} + } + Ok((granted.into_iter().map(str::to_owned).collect(), claims.exp)) + } +} + +fn parse_scope(scope: &str) -> Option> { + let scopes: HashSet<_> = scope.split(' ').collect(); + (scopes.iter().all(|s| is_scope_token(s)) && scopes.len() == scope.split(' ').count()) + .then_some(scopes) +} + +fn is_scope_token(scope: &str) -> bool { + !scope.is_empty() + && scope + .bytes() + .all(|b| matches!(b, b'!' | b'#'..=b'[' | b']'..=b'~')) +} + +fn unix_time() -> Result { + SystemTime::now() + .duration_since(UNIX_EPOCH) + .map(|duration| duration.as_secs()) + .map_err(|_| EmaError::InvalidRequest("system clock precedes the Unix epoch")) +} + +#[derive(Deserialize)] +struct ResourceTokenResponse { + access_token: String, + token_type: String, + expires_in: Option, + resource: Option, + scope: Option, + refresh_token: Option, + authorization_details: Option>, +} + +impl ResourceTokenResponse { + fn validate( + self, + resource: &str, + granted: HashSet, + ) -> Result { + let invalid = |message| EmaError::InvalidResponse { + stage: EmaExchangeStage::ResourceAuthorizationServer, + message, + }; + if self + .authorization_details + .as_ref() + .is_some_and(|details| !details.is_empty()) + { + return Err(invalid("authorization_details is not supported")); + } + if !self.token_type.eq_ignore_ascii_case("bearer") + || self.access_token.trim().is_empty() + || self.refresh_token.is_some() + || self.expires_in == Some(0) + { + return Err(invalid( + "invalid bearer token, lifetime, or unexpected refresh token", + )); + } + // The resource need not be echoed, but must agree with the ID-JAG if present. + if self + .resource + .as_ref() + .is_some_and(|r| !r.is_exact(resource)) + { + return Err(invalid("access token resource mismatch")); + } + // An omitted scope retains the authority carried by the assertion. + let scopes = if let Some(scope) = self.scope.as_deref() { + let scopes = + parse_scope(scope).ok_or_else(|| invalid("malformed or duplicate scopes"))?; + if !scopes.iter().all(|s| granted.contains(*s)) { + return Err(invalid("access token scope exceeds ID-JAG scope")); + } + scopes.into_iter().map(str::to_owned).collect() + } else { + granted + }; + Ok(EmaAccessToken { + access_token: AccessToken::new(self.access_token), + expires_in: self.expires_in.map(Duration::from_secs), + scopes, + }) + } +} + +#[cfg(test)] +#[path = "enterprise_tests.rs"] +mod tests; diff --git a/vendor/rmcp/src/transport/auth/enterprise_tests.rs b/vendor/rmcp/src/transport/auth/enterprise_tests.rs new file mode 100644 index 00000000..31a63c1b --- /dev/null +++ b/vendor/rmcp/src/transport/auth/enterprise_tests.rs @@ -0,0 +1,1145 @@ +use std::{ + collections::BTreeMap, + sync::{Arc, Mutex}, + time::{Duration, SystemTime}, +}; + +use base64::{ + Engine, + engine::general_purpose::{STANDARD, URL_SAFE_NO_PAD}, +}; +use oauth2::{ClientSecret, HttpResponse, RefreshToken}; +use serde_json::{Value, json}; + +use super::{ + EmaExchangeStage::{IdentityProvider as Idp, ResourceAuthorizationServer as ResourceServer}, + *, +}; +use crate::transport::auth::{OAuthHttpClientError, OAuthHttpClientFuture, OAuthHttpRequest}; + +const IDP: &str = "https://idp.example?private-query"; +const AS: &str = "https://as.example?private-query"; +const RESOURCE: &str = "https://mcp.example?private-query"; +const IDP_TOKEN: &str = "https://idp.example/token?private-query"; +const AS_TOKEN: &str = "https://as.example/token?private-query"; +const BAD_SCOPES: &[&str] = &["", "files\tread", "\"", "\\", "\0", "读"]; + +#[derive(Default)] +struct MockHttp { + requests: Mutex>, + response: Mutex>>, +} + +impl MockHttp { + fn new(status: u16, body: Value) -> Self { + Self { + response: Mutex::new(Some(Ok(oauth2::http::Response::builder() + .status(status) + .body(serde_json::to_vec(&body).unwrap()) + .unwrap()))), + ..Self::default() + } + } +} + +impl OAuthHttpClient for MockHttp { + fn execute(&self, request: OAuthHttpRequest) -> OAuthHttpClientFuture<'_> { + self.requests.lock().unwrap().push(request); + let response = self.response.lock().unwrap().take(); + let response = response.expect("unexpected HTTP"); + Box::pin(async move { response }) + } +} + +fn jwt(header: Value, claims: &Value) -> String { + format!( + "{}.{}.{}", + URL_SAFE_NO_PAD.encode(header.to_string()), + URL_SAFE_NO_PAD.encode(claims.to_string()), + URL_SAFE_NO_PAD.encode(b"synthetic-signature") + ) +} + +fn claims() -> Value { + let now = SystemTime::now() + .duration_since(std::time::UNIX_EPOCH) + .unwrap() + .as_secs(); + json!({"iss":IDP,"aud":AS,"sub":"user","client_id":"mcp", + "jti":"jag-id","iat":now,"exp":now + 3600,"resource":RESOURCE,"scope":"files.read"}) +} + +fn jag(claims: &Value) -> Value { + let mut body = json!({"access_token":jwt(json!({"alg":"ES256","typ":"oauth-id-jag+jwt"}), claims), + "issued_token_type":ID_JAG_TOKEN_TYPE,"token_type":"N_A","resource":claims["resource"]}); + if let Some(scope) = claims.get("scope") { + body["scope"] = scope.clone(); + } + body +} + +async fn exchange(idp: &MockHttp, scopes: &str) -> Result { + let scopes = scopes + .split_ascii_whitespace() + .map(str::to_owned) + .collect::>(); + let refresh = RefreshToken::new("refresh-token".into()); + let resource_as = EmaAuthorizationServer::new(AS, AS_TOKEN, "mcp"); + assert!(!format!("{resource_as:?}").contains("private-query")); + let request = EmaExchangeRequest::new( + EmaAuthorizationServer::new(IDP, IDP_TOKEN, "idp"), + resource_as, + RESOURCE, + &refresh, + ) + .with_scopes(scopes); + assert!(!format!("{request:?}").contains(refresh.secret())); + assert!(!format!("{request:?}").contains("private-query")); + let future = request.exchange_id_jag(idp); + fn is_send(_: &T) {} + is_send(&future); + future.await +} + +fn form(request: &OAuthHttpRequest) -> BTreeMap { + assert!(!request.request.headers().contains_key("authorization")); + authenticated_form(request) +} + +fn authenticated_form(request: &OAuthHttpRequest) -> BTreeMap { + assert_eq!(request.request.method(), "POST"); + let headers = request.request.headers(); + assert_eq!(headers["content-type"], "application/x-www-form-urlencoded"); + assert_eq!(headers["accept"], "application/json"); + assert_eq!(request.redirect_policy, OAuthHttpRedirectPolicy::Stop); + assert_eq!(request.timeout, Some(Duration::from_secs(30))); + let pairs = url::form_urlencoded::parse(request.request.body()) + .into_owned() + .collect::>(); + let fields = pairs.iter().cloned().collect::>(); + assert_eq!(pairs.len(), fields.len(), "duplicate form fields"); + fields +} + +#[tokio::test] +async fn refresh_exchange_preserves_exact_forms_and_signed_narrowing() { + for scopes in ["files.read files.write", ""] { + let response = jag(&claims()); + let idp = MockHttp::new(200, response.clone()); + let result = exchange(&idp, scopes).await.unwrap(); + assert_eq!( + result.assertion().secret(), + response["access_token"].as_str().unwrap() + ); + assert_eq!(result.scopes(), &HashSet::from(["files.read".to_owned()])); + assert!(!format!("{result:?}").contains(result.assertion().secret())); + assert!(!format!("{result:?}").contains("private-query")); + let requests = idp.requests.lock().unwrap(); + assert_eq!(requests.len(), 1); + assert_eq!(requests[0].request.uri(), IDP_TOKEN); + let mut fields = form(&requests[0]); + assert_eq!( + fields.remove("scope"), + (!scopes.is_empty()).then(|| scopes.to_owned()) + ); + assert_eq!( + serde_json::to_value(fields).unwrap(), + json!({ + "grant_type":"urn:ietf:params:oauth:grant-type:token-exchange", + "requested_token_type":ID_JAG_TOKEN_TYPE,"subject_token":"refresh-token", + "subject_token_type":"urn:ietf:params:oauth:token-type:refresh_token", + "audience":AS,"resource":RESOURCE,"client_id":"idp" + }) + ); + } +} + +#[tokio::test] +async fn scopes_may_be_omitted_but_never_widened() { + for (requested, signed, echoed, valid) in [ + ("", Some("files.read"), None, true), + ("", None, None, true), + ("files.read", Some("files.read"), None, true), + ("files.read files.write", Some("files.read"), None, false), + ( + "files.read", + Some("files.read files.write"), + Some("files.read files.write"), + false, + ), + ("files.read", None, None, false), + ("", Some("files.read"), Some("files.write"), false), + ("", Some(" \t"), None, false), + ("", Some("files.read files.read"), None, false), + ("", Some("files.read"), Some(" \t"), false), + ("", Some("files.read"), Some("files.read files.read"), false), + ] { + let mut claims = claims(); + claims.as_object_mut().unwrap().remove("scope"); + if let Some(scope) = signed { + claims["scope"] = json!(scope); + } + let mut response = jag(&claims); + response.as_object_mut().unwrap().remove("scope"); + if let Some(scope) = echoed { + response["scope"] = json!(scope); + } + let result = exchange(&MockHttp::new(200, response), requested).await; + assert_eq!( + result.is_ok(), + valid, + "requested={requested:?}, signed={signed:?}, echoed={echoed:?}" + ); + if let Ok(result) = result { + let expected = signed.into_iter().map(str::to_owned).collect(); + assert_eq!(result.scopes(), &expected); + } + } +} + +#[tokio::test] +async fn unsupported_authorization_details_are_rejected_at_each_stage() { + const SECRET: &str = "authorization-details-secret"; + for (location, stage) in [ + ("claims", Idp), + ("idp response", Idp), + ("resource response", ResourceServer), + ] { + for (case, details, valid) in [ + ("absent", None, true), + ("null", Some(Value::Null), true), + ("empty", Some(json!([])), true), + ( + "additional authority", + Some( + json!([{"type":SECRET,"locations":["https://other.example"],"actions":["write"]}]), + ), + false, + ), + ("invalid member", Some(json!([null])), false), + ("object", Some(json!({"type":SECRET})), false), + ("string", Some(json!(SECRET)), false), + ] { + let mut claims = claims(); + let mut response = bearer(); + // Unrelated extension fields remain compatible at every boundary. + claims["vendor_extension"] = json!(SECRET); + response["vendor_extension"] = json!(SECRET); + if location == "claims" + && let Some(details) = &details + { + claims["authorization_details"] = details.clone(); + } + let mut idp_response = jag(&claims); + idp_response["vendor_extension"] = json!(SECRET); + if let Some(details) = details { + match location { + "idp response" => idp_response["authorization_details"] = details, + "resource response" => response["authorization_details"] = details, + _ => {} + } + } + let idp = MockHttp::new(200, idp_response); + let resource = MockHttp::new(200, response); + let result = EmaExchangeRequest::new( + EmaAuthorizationServer::new(IDP, IDP_TOKEN, "idp"), + EmaAuthorizationServer::new(AS, AS_TOKEN, "mcp"), + RESOURCE, + &RefreshToken::new("refresh-token".into()), + ) + .with_scopes(["files.read"]) + .exchange(&idp, &resource) + .await; + assert_eq!(result.is_ok(), valid, "{location}: {case}"); + if let Err(error) = result { + assert!( + matches!(error, EmaError::InvalidResponse { stage: actual, .. } if actual == stage) + ); + assert!(!format!("{error:?} {error}").contains(SECRET)); + } + assert_eq!(idp.requests.lock().unwrap().len(), 1); + assert_eq!( + resource.requests.lock().unwrap().len(), + usize::from(valid || stage == ResourceServer), + "{location}: {case}" + ); + } + } +} + +#[tokio::test] +async fn invalid_jags_never_escape_validation() { + let original = claims(); + let mut cases = Vec::new(); + let invalid = json!({"iss":"https://other.example","aud":[AS,"other"], + "client_id":"other","sub":"","jti":" \t","exp":0,"iat":u64::MAX,"resource":[RESOURCE,"other"]}); + for (key, value) in invalid.as_object().unwrap() { + let mut changed = original.clone(); + changed[key] = value.clone(); + cases.push(jag(&changed)); + } + for scope in BAD_SCOPES { + let mut changed = original.clone(); + changed["scope"] = json!(scope); + cases.push(jag(&changed)); + } + for header in [ + json!({"alg":"ES256","typ":"JWT"}), + json!({"alg":"ES256"}), + json!({"alg":"none","typ":"oauth-id-jag+jwt"}), + ] { + let mut response = jag(&original); + response["access_token"] = json!(jwt(header, &original)); + cases.push(response); + } + let invalid = json!({"issued_token_type":"Bearer","token_type":"Bearer", + "refresh_token":"unsupported","resource":"https://other.example","access_token":"a.b.c.d"}); + for (key, value) in invalid.as_object().unwrap() { + let mut response = jag(&original); + response[key] = value.clone(); + cases.push(response); + } + for signature in ["", "signature", "not+base64url", "c2ln="] { + let mut response = jag(&original); + let assertion = response["access_token"].as_str().unwrap(); + let (signed, _) = assertion.rsplit_once('.').unwrap(); + response["access_token"] = json!(format!("{signed}.{signature}")); + cases.push(response); + } + for response in cases { + let result = exchange(&MockHttp::new(200, response), "files.read").await; + assert!(matches!( + result, + Err(EmaError::InvalidResponse { stage: Idp, .. }) + )); + } +} + +#[tokio::test] +async fn invalid_inputs_fail_before_http() { + // Each server occupies issuer, token endpoint, and client ID slots. + let original = [IDP, IDP_TOKEN, "idp", AS, AS_TOKEN, "mcp", RESOURCE, "rt"]; + let mut cases = Vec::new(); + for index in [0, 1, 3, 4, 6] { + for value in [ + "invalid", + "http://idp.example/token", + "https://user:pass@idp.example/token", + "https://idp.example/token#fragment", + ] { + let mut fields = original; + fields[index] = value; + cases.push((fields, vec![])); + } + } + for (index, value) in [(0, AS), (2, " "), (5, ""), (7, " \t")] { + let mut fields = original; + fields[index] = value; + cases.push((fields, vec![])); + } + for scope in BAD_SCOPES.iter().copied().chain(["files.read files.write"]) { + cases.push((original, vec![scope])); + } + cases.push((original, vec!["files.read", "files.read"])); + for (fields, scopes) in cases { + let http = MockHttp::default(); + let result = EmaExchangeRequest::new( + EmaAuthorizationServer::new(fields[0], fields[1], fields[2]), + EmaAuthorizationServer::new(fields[3], fields[4], fields[5]), + fields[6], + &RefreshToken::new(fields[7].into()), + ) + .with_scopes(scopes) + .exchange_id_jag(&http) + .await; + assert!(matches!(result, Err(EmaError::InvalidRequest(_)))); + assert!(http.requests.lock().unwrap().is_empty()); + } +} + +#[tokio::test] +async fn errors_and_redirects_cannot_reflect_credentials() { + const SECRET: &str = "secret-error-sentinel"; + for (status, code) in [ + (400, "invalid_grant"), + (400, "insufficient_user_authentication"), + (400, "invalid_client"), + (400, SECRET), + (302, SECRET), + ] { + let failure = json!({"error":code,"error_description":SECRET}); + let error = exchange(&MockHttp::new(status, failure), "") + .await + .unwrap_err(); + match code { + "invalid_grant" => assert_eq!(error, EmaError::InvalidGrant(Idp)), + "insufficient_user_authentication" => { + assert_eq!(error, EmaError::InsufficientUserAuthentication(Idp)) + } + _ => assert!( + matches!(error, EmaError::OAuthRejected {stage: Idp, status: actual, ..} if actual == status) + ), + } + assert!(!format!("{error:?} {error}").contains(SECRET)); + } + for adapter_failure in [false, true] { + let failure = MockHttp::new( + 200, + json!({"access_token":SECRET,"issued_token_type":SECRET}), + ); + if adapter_failure { + *failure.response.lock().unwrap() = Some(Err(SECRET.into())); + } + let error = exchange(&failure, "").await.unwrap_err(); + assert!(!format!("{error:?} {error}").contains(SECRET)); + assert!(std::error::Error::source(&error).is_none()); + if adapter_failure { + assert_eq!(error, EmaError::RequestFailed(Idp)); + } + } + let mut oversized = jag(&claims()); + oversized["ignored"] = json!("x".repeat(1024 * 1024)); + let error = exchange(&MockHttp::new(200, oversized), "") + .await + .unwrap_err(); + assert!(matches!( + error, + EmaError::InvalidResponse { stage: Idp, .. } + )); +} + +fn bearer() -> Value { + json!({"access_token":"resource-token","token_type":"Bearer","expires_in":300}) +} + +async fn redeem(http: &MockHttp) -> Result { + exchange( + &MockHttp::new(200, jag(&claims())), + "files.read files.write", + ) + .await? + .exchange(http) + .await +} + +#[tokio::test] +async fn full_exchange_uses_separate_clients_and_only_the_narrowed_assertion() { + for valid in [true, false] { + let mut claims = claims(); + if !valid { + claims["client_id"] = json!("other"); + } + let response = jag(&claims); + let idp = MockHttp::new(200, response.clone()); + let resource_as = MockHttp::new(200, bearer()); + let refresh = RefreshToken::new("refresh-token".into()); + let request = EmaExchangeRequest::new( + EmaAuthorizationServer::new(IDP, IDP_TOKEN, "idp"), + EmaAuthorizationServer::new(AS, AS_TOKEN, "mcp"), + RESOURCE, + &refresh, + ) + .with_scopes(["files.read", "files.write"]); + let future = request.exchange(&idp, &resource_as); + fn is_send(_: &T) {} + is_send(&future); + let result = future.await; + assert_eq!(idp.requests.lock().unwrap().len(), 1); + let requests = resource_as.requests.lock().unwrap(); + assert_eq!(requests.len(), usize::from(valid)); + if !valid { + assert!(matches!( + result, + Err(EmaError::InvalidResponse { stage: Idp, .. }) + )); + continue; + } + let token = result.unwrap(); + assert_eq!(token.access_token.secret(), "resource-token"); + assert_eq!(token.expires_in, Some(Duration::from_secs(300))); + assert_eq!(token.scopes, HashSet::from(["files.read".to_owned()])); + assert!(!format!("{token:?}").contains(token.access_token.secret())); + assert_eq!(requests[0].request.uri(), AS_TOKEN); + assert_eq!( + serde_json::to_value(form(&requests[0])).unwrap(), + json!({ + "grant_type":"urn:ietf:params:oauth:grant-type:jwt-bearer", + "assertion":response["access_token"],"client_id":"mcp" + }) + ); + } +} + +#[tokio::test] +async fn expired_grants_are_not_redeemed() { + let mut grant = exchange(&MockHttp::new(200, jag(&claims())), "") + .await + .unwrap(); + grant.expires_at = 0; + let resource_as = MockHttp::default(); + assert!(matches!( + grant.exchange(&resource_as).await, + Err(EmaError::InvalidRequest(_)) + )); + assert!(resource_as.requests.lock().unwrap().is_empty()); +} + +#[tokio::test] +async fn bearer_responses_cannot_change_resource_or_widen_scope() { + let mut cases = vec![ + ("scope", json!("files.read"), true), + ("scope", json!("files.admin"), false), + ("scope", json!("files.read files.write"), false), + ("scope", json!("files.read files.read"), false), + ("resource", json!(RESOURCE), true), + ("resource", json!([RESOURCE]), true), + ("resource", json!([RESOURCE, "other"]), false), + ("resource", json!("https://mcp.example"), false), + ("expires_in", json!(0), false), + ("expires_in", Value::Null, true), + ("refresh_token", json!("unsupported"), false), + ("token_type", json!("N_A"), false), + ("token_type", json!("bearer"), true), + ("access_token", json!(" \t"), false), + ]; + cases.extend( + BAD_SCOPES + .iter() + .map(|scope| ("scope", json!(scope), false)), + ); + for (key, value, valid) in cases { + let mut token = bearer(); + if value.is_null() { + token.as_object_mut().unwrap().remove(key); + } else { + token[key] = value; + } + let result = redeem(&MockHttp::new(200, token)).await; + assert_eq!(result.is_ok(), valid, "{key}"); + if key == "expires_in" && valid { + assert_eq!(result.unwrap().expires_in, None); + } else if !valid { + assert!(matches!( + result, + Err(EmaError::InvalidResponse { + stage: ResourceServer, + .. + }) + )); + } + } +} + +#[tokio::test] +async fn resource_scope_narrowing_is_reported_without_logging_scope_values() { + for read in ["files.read", "private-scope-sentinel"] { + let requested = format!("{read} files.write"); + let mut claims = claims(); + claims["scope"] = json!(requested); + let grant = exchange(&MockHttp::new(200, jag(&claims)), &requested) + .await + .unwrap(); + let mut response = bearer(); + response["scope"] = json!(read); + let token = grant.exchange(&MockHttp::new(200, response)).await.unwrap(); + assert_eq!(token.scopes, HashSet::from([read.to_owned()])); + assert!(!format!("{token:?}").contains(read)); + } +} + +#[tokio::test] +async fn bearer_scope_may_be_omitted_but_not_added_to_an_unscoped_grant() { + for scope in [None, Some("files.read")] { + let mut claims = claims(); + claims.as_object_mut().unwrap().remove("scope"); + let grant = exchange(&MockHttp::new(200, jag(&claims)), "") + .await + .unwrap(); + let mut token = bearer(); + if let Some(scope) = scope { + token["scope"] = json!(scope); + } + let result = grant.exchange(&MockHttp::new(200, token)).await; + assert_eq!(result.is_ok(), scope.is_none()); + if let Ok(token) = result { + assert!(token.scopes.is_empty()); + } + } +} + +#[tokio::test] +async fn resource_errors_are_staged_and_never_reflect_credentials() { + const SECRET: &str = "secret-resource-error-sentinel"; + for (status, code) in [ + (400, "invalid_grant"), + (400, "insufficient_user_authentication"), + (400, "invalid_client"), + (302, SECRET), + (500, SECRET), + ] { + let http = MockHttp::new(status, json!({"error":code,"error_description":SECRET})); + let error = redeem(&http).await.unwrap_err(); + match code { + "invalid_grant" => assert_eq!(error, EmaError::InvalidGrant(ResourceServer)), + "insufficient_user_authentication" => assert_eq!( + error, + EmaError::InsufficientUserAuthentication(ResourceServer) + ), + _ => assert!( + matches!(error, EmaError::OAuthRejected {stage: ResourceServer, status: actual, ..} if actual == status) + ), + } + assert!(!format!("{error:?} {error}").contains(SECRET)); + assert!(std::error::Error::source(&error).is_none()); + assert_eq!(http.requests.lock().unwrap().len(), 1); + } + let mut oversized = bearer(); + oversized["ignored"] = json!("x".repeat(1024 * 1024)); + for (body, adapter_failure) in [ + (json!({"access_token":SECRET,"expires_in":SECRET}), false), + (oversized, false), + (Value::Null, true), + ] { + let http = MockHttp::new(200, body); + if adapter_failure { + *http.response.lock().unwrap() = Some(Err(SECRET.into())); + } + let error = redeem(&http).await.unwrap_err(); + assert!(!format!("{error:?} {error}").contains(SECRET)); + assert!(std::error::Error::source(&error).is_none()); + if adapter_failure { + assert_eq!(error, EmaError::RequestFailed(ResourceServer)); + } else { + assert!(matches!( + error, + EmaError::InvalidResponse { + stage: ResourceServer, + .. + } + )); + } + } +} + +#[tokio::test(start_paused = true)] +async fn both_exchanges_enforce_the_timeout_when_the_adapter_does_not() { + struct PendingHttp; + impl OAuthHttpClient for PendingHttp { + fn execute(&self, _: OAuthHttpRequest) -> OAuthHttpClientFuture<'_> { + Box::pin(std::future::pending()) + } + } + for stage in [Idp, ResourceServer] { + let ready = MockHttp::new(200, jag(&claims())); + let (idp, resource): (&dyn OAuthHttpClient, &dyn OAuthHttpClient) = match stage { + Idp => (&PendingHttp, &ready), + _ => (&ready, &PendingHttp), + }; + let refresh = RefreshToken::new("refresh-token".into()); + let request = EmaExchangeRequest::new( + EmaAuthorizationServer::new(IDP, IDP_TOKEN, "idp"), + EmaAuthorizationServer::new(AS, AS_TOKEN, "mcp"), + RESOURCE, + &refresh, + ); + let start = tokio::time::Instant::now(); + let result = tokio::time::timeout(Duration::from_secs(31), request.exchange(idp, resource)) + .await + .expect("the SDK must enforce its own deadline"); + assert_eq!(result.unwrap_err(), EmaError::RequestFailed(stage)); + assert_eq!(start.elapsed(), Duration::from_secs(30)); + assert_eq!( + ready.requests.lock().unwrap().len(), + usize::from(stage == ResourceServer) + ); + } +} + +#[derive(Clone, Copy)] +enum AssertionBehavior { + Success, + Error, + Empty(&'static str), + Delay(Duration), + Pending, +} + +struct RecordingAssertionProvider { + calls: Mutex>, + behavior: AssertionBehavior, +} + +impl RecordingAssertionProvider { + fn new(behavior: AssertionBehavior) -> Arc { + Arc::new(Self { + calls: Mutex::new(Vec::new()), + behavior, + }) + } +} + +fn client_assertion(client_id: &str, issuer: &str, sequence: usize) -> String { + jwt( + json!({"alg":"ES256","typ":"client-authentication+jwt"}), + &json!({"iss":client_id,"sub":client_id,"aud":issuer, + "exp":4102444800_u64,"jti":format!("client-assertion-{sequence}")}), + ) +} + +#[async_trait::async_trait] +impl EmaClientAssertionProvider for RecordingAssertionProvider { + async fn create_assertion( + &self, + server: &EmaAuthorizationServer, + ) -> Result> { + let sequence = { + let mut calls = self.calls.lock().unwrap(); + calls.push(( + server.issuer.clone(), + server.token_endpoint.clone(), + server.client_id.clone(), + )); + calls.len() + }; + match self.behavior { + AssertionBehavior::Error => return Err("client-assertion-provider-secret".into()), + AssertionBehavior::Empty(value) => return Ok(EmaClientAssertion::new(value.into())), + AssertionBehavior::Delay(delay) => tokio::time::sleep(delay).await, + AssertionBehavior::Pending => std::future::pending::<()>().await, + AssertionBehavior::Success => {} + } + Ok(EmaClientAssertion::new(client_assertion( + &server.client_id, + &server.issuer, + sequence, + ))) + } +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +enum AuthenticationMethod { + Public, + Basic, + Post, + Jwt, +} + +impl AuthenticationMethod { + fn configure( + self, + secret: &str, + provider: &Arc, + ) -> EmaClientAuthentication { + match self { + Self::Public => EmaClientAuthentication::None, + Self::Basic => { + EmaClientAuthentication::ClientSecretBasic(ClientSecret::new(secret.into())) + } + Self::Post => { + EmaClientAuthentication::ClientSecretPost(ClientSecret::new(secret.into())) + } + Self::Jwt => EmaClientAuthentication::JwtAssertion(provider.clone()), + } + } +} + +fn remove_client_authentication( + request: &OAuthHttpRequest, + method: AuthenticationMethod, + client_id: &str, + secret: &str, + encoded_basic: &str, + assertion: &str, +) -> BTreeMap { + let mut fields = authenticated_form(request); + let authorization = request.request.headers().get("authorization"); + if method == AuthenticationMethod::Basic { + let authorization = authorization.expect("Basic authentication must use a header"); + assert!(authorization.is_sensitive()); + let encoded = authorization + .to_str() + .unwrap() + .strip_prefix("Basic ") + .unwrap(); + assert_eq!(STANDARD.decode(encoded).unwrap(), encoded_basic.as_bytes()); + assert!(!fields.contains_key("client_id")); + } else { + assert!(authorization.is_none()); + assert_eq!(fields.remove("client_id").as_deref(), Some(client_id)); + } + assert_eq!( + fields.remove("client_secret").as_deref(), + (method == AuthenticationMethod::Post).then_some(secret) + ); + assert_eq!( + fields.remove("client_assertion_type").as_deref(), + (method == AuthenticationMethod::Jwt) + .then_some("urn:ietf:params:oauth:client-assertion-type:jwt-bearer") + ); + assert_eq!( + fields.remove("client_assertion").as_deref(), + (method == AuthenticationMethod::Jwt).then_some(assertion) + ); + fields +} + +#[tokio::test] +async fn client_authentication_is_endpoint_specific_and_never_mixed_with_grants() { + const METHODS: [AuthenticationMethod; 4] = [ + AuthenticationMethod::Public, + AuthenticationMethod::Basic, + AuthenticationMethod::Post, + AuthenticationMethod::Jwt, + ]; + // Colons, plus signs, spaces, percent signs, and non-ASCII bytes must be + // form-encoded individually before the HTTP Basic username/password join. + const IDP_CLIENT: &str = "idp:+ %é"; + const AS_CLIENT: &str = "mcp:+ %é"; + const IDP_SECRET: &str = "idp-secret:+ %é"; + const AS_SECRET: &str = "as-secret:+ %é"; + for idp_method in METHODS { + for resource_method in METHODS { + let provider = RecordingAssertionProvider::new(AssertionBehavior::Success); + let mut claims = claims(); + claims["client_id"] = json!(AS_CLIENT); + let response = jag(&claims); + let idp = MockHttp::new(200, response.clone()); + let resource = MockHttp::new(200, bearer()); + let refresh = RefreshToken::new("refresh-token".into()); + let token = EmaExchangeRequest::new( + EmaAuthorizationServer::new(IDP, IDP_TOKEN, IDP_CLIENT) + .with_client_authentication(idp_method.configure(IDP_SECRET, &provider)), + EmaAuthorizationServer::new(AS, AS_TOKEN, AS_CLIENT) + .with_client_authentication(resource_method.configure(AS_SECRET, &provider)), + RESOURCE, + &refresh, + ) + .exchange(&idp, &resource) + .await + .unwrap(); + assert_eq!(token.access_token.secret(), "resource-token"); + let idp_requests = idp.requests.lock().unwrap(); + let resource_requests = resource.requests.lock().unwrap(); + assert_eq!(idp_requests.len(), 1); + assert_eq!(resource_requests.len(), 1); + assert_eq!(idp_requests[0].request.uri(), IDP_TOKEN); + assert_eq!(resource_requests[0].request.uri(), AS_TOKEN); + let idp_fields = remove_client_authentication( + &idp_requests[0], + idp_method, + IDP_CLIENT, + IDP_SECRET, + "idp%3A%2B+%25%C3%A9:idp-secret%3A%2B+%25%C3%A9", + &client_assertion(IDP_CLIENT, IDP, 1), + ); + assert_eq!( + serde_json::to_value(idp_fields).unwrap(), + json!({ + "grant_type":"urn:ietf:params:oauth:grant-type:token-exchange", + "requested_token_type":ID_JAG_TOKEN_TYPE,"subject_token":"refresh-token", + "subject_token_type":"urn:ietf:params:oauth:token-type:refresh_token", + "audience":AS,"resource":RESOURCE + }) + ); + let resource_fields = remove_client_authentication( + &resource_requests[0], + resource_method, + AS_CLIENT, + AS_SECRET, + "mcp%3A%2B+%25%C3%A9:as-secret%3A%2B+%25%C3%A9", + &client_assertion( + AS_CLIENT, + AS, + 1 + usize::from(idp_method == AuthenticationMethod::Jwt), + ), + ); + assert_eq!( + serde_json::to_value(resource_fields).unwrap(), + json!({ + "grant_type":"urn:ietf:params:oauth:grant-type:jwt-bearer", + "assertion":response["access_token"] + }) + ); + let mut expected_calls = Vec::new(); + if idp_method == AuthenticationMethod::Jwt { + expected_calls.push((IDP.into(), IDP_TOKEN.into(), IDP_CLIENT.into())); + } + if resource_method == AuthenticationMethod::Jwt { + expected_calls.push((AS.into(), AS_TOKEN.into(), AS_CLIENT.into())); + } + assert_eq!(*provider.calls.lock().unwrap(), expected_calls); + } + } +} + +#[tokio::test(start_paused = true)] +async fn client_assertions_are_fresh_for_every_request_and_delayed_redemption() { + let provider = RecordingAssertionProvider::new(AssertionBehavior::Success); + let idp_server = EmaAuthorizationServer::new(IDP, IDP_TOKEN, "idp") + .with_client_authentication(EmaClientAuthentication::JwtAssertion(provider.clone())); + let resource_server = EmaAuthorizationServer::new(AS, AS_TOKEN, "mcp") + .with_client_authentication(EmaClientAuthentication::JwtAssertion(provider.clone())); + let refresh = RefreshToken::new("refresh-token".into()); + let mut assertions = HashSet::new(); + for attempt in 0..2 { + let idp = MockHttp::new(200, jag(&claims())); + let resource = MockHttp::new(200, bearer()); + let grant = EmaExchangeRequest::new( + idp_server.clone(), + resource_server.clone(), + RESOURCE, + &refresh, + ) + .exchange_id_jag(&idp) + .await + .unwrap(); + assert_eq!(provider.calls.lock().unwrap().len(), attempt * 2 + 1); + tokio::time::sleep(Duration::from_secs(60)).await; + assert_eq!(provider.calls.lock().unwrap().len(), attempt * 2 + 1); + grant.exchange(&resource).await.unwrap(); + assert_eq!(provider.calls.lock().unwrap().len(), attempt * 2 + 2); + for http in [&idp, &resource] { + let requests = http.requests.lock().unwrap(); + let mut fields = form(&requests[0]); + assert!(assertions.insert(fields.remove("client_assertion").unwrap())); + } + } + assert_eq!(assertions.len(), 4); +} + +#[tokio::test] +async fn invalid_static_client_secrets_fail_before_any_http_or_signing() { + for stage in [Idp, ResourceServer] { + for method in [AuthenticationMethod::Basic, AuthenticationMethod::Post] { + for secret in ["", " \t"] { + let provider = RecordingAssertionProvider::new(AssertionBehavior::Success); + let valid = EmaClientAuthentication::JwtAssertion(provider.clone()); + let invalid = method.configure(secret, &provider); + let (idp_auth, resource_auth) = match stage { + Idp => (invalid, valid), + _ => (valid, invalid), + }; + let idp = MockHttp::default(); + let resource = MockHttp::default(); + let error = EmaExchangeRequest::new( + EmaAuthorizationServer::new(IDP, IDP_TOKEN, "idp") + .with_client_authentication(idp_auth), + EmaAuthorizationServer::new(AS, AS_TOKEN, "mcp") + .with_client_authentication(resource_auth), + RESOURCE, + &RefreshToken::new("refresh-token".into()), + ) + .exchange(&idp, &resource) + .await + .unwrap_err(); + assert!(matches!(error, EmaError::InvalidRequest(_))); + assert!(idp.requests.lock().unwrap().is_empty()); + assert!(resource.requests.lock().unwrap().is_empty()); + assert!(provider.calls.lock().unwrap().is_empty()); + } + } + } +} + +#[tokio::test] +async fn a_grant_that_expires_while_signing_is_never_sent_to_the_resource_server() { + use std::sync::atomic::{AtomicU64, Ordering}; + + let provider = RecordingAssertionProvider::new(AssertionBehavior::Success); + let idp = MockHttp::new(200, jag(&claims())); + let resource = MockHttp::default(); + let mut grant = EmaExchangeRequest::new( + EmaAuthorizationServer::new(IDP, IDP_TOKEN, "idp"), + EmaAuthorizationServer::new(AS, AS_TOKEN, "mcp") + .with_client_authentication(EmaClientAuthentication::JwtAssertion(provider.clone())), + RESOURCE, + &RefreshToken::new("refresh-token".into()), + ) + .exchange_id_jag(&idp) + .await + .unwrap(); + grant.expires_at = 100; + // The clock crosses expiration between the checks before and after signing. + let now = AtomicU64::new(99); + let error = grant + .exchange_with_clock(&resource, || Ok(now.fetch_add(1, Ordering::Relaxed))) + .await + .unwrap_err(); + assert!(matches!(error, EmaError::InvalidRequest(_))); + assert_eq!(provider.calls.lock().unwrap().len(), 1); + assert!(resource.requests.lock().unwrap().is_empty()); +} + +#[tokio::test] +async fn assertion_provider_failures_and_empty_results_never_reach_http_or_escape_errors() { + for stage in [Idp, ResourceServer] { + for behavior in [ + AssertionBehavior::Error, + AssertionBehavior::Empty(""), + AssertionBehavior::Empty(" \t"), + ] { + let provider = RecordingAssertionProvider::new(behavior); + let auth = EmaClientAuthentication::JwtAssertion(provider.clone()); + let (idp_auth, resource_auth) = match stage { + Idp => (auth, EmaClientAuthentication::None), + _ => (EmaClientAuthentication::None, auth), + }; + let idp = MockHttp::new(200, jag(&claims())); + let resource = MockHttp::default(); + let error = EmaExchangeRequest::new( + EmaAuthorizationServer::new(IDP, IDP_TOKEN, "idp") + .with_client_authentication(idp_auth), + EmaAuthorizationServer::new(AS, AS_TOKEN, "mcp") + .with_client_authentication(resource_auth), + RESOURCE, + &RefreshToken::new("refresh-token".into()), + ) + .exchange(&idp, &resource) + .await + .unwrap_err(); + if matches!(behavior, AssertionBehavior::Error) { + assert_eq!(error, EmaError::RequestFailed(stage)); + } else { + assert!(matches!(error, EmaError::InvalidRequest(_))); + } + assert!(!format!("{error:?} {error}").contains("client-assertion-provider-secret")); + assert!(std::error::Error::source(&error).is_none()); + assert_eq!(provider.calls.lock().unwrap().len(), 1); + assert_eq!( + idp.requests.lock().unwrap().len(), + usize::from(stage == ResourceServer) + ); + assert!(resource.requests.lock().unwrap().is_empty()); + } + } +} + +#[tokio::test(start_paused = true)] +async fn signing_and_http_share_one_deadline_at_both_endpoints() { + struct DelayedHttp(Mutex>); + impl OAuthHttpClient for DelayedHttp { + fn execute(&self, request: OAuthHttpRequest) -> OAuthHttpClientFuture<'_> { + self.0.lock().unwrap().push(request); + Box::pin(async { + tokio::time::sleep(Duration::from_secs(10)).await; + Err("http-adapter-secret".into()) + }) + } + } + for stage in [Idp, ResourceServer] { + for behavior in [ + AssertionBehavior::Pending, + AssertionBehavior::Delay(Duration::from_secs(25)), + ] { + let provider = RecordingAssertionProvider::new(behavior); + let auth = EmaClientAuthentication::JwtAssertion(provider.clone()); + let (idp_auth, resource_auth) = match stage { + Idp => (auth, EmaClientAuthentication::None), + _ => (EmaClientAuthentication::None, auth), + }; + let ready = MockHttp::new(200, jag(&claims())); + let delayed = DelayedHttp(Mutex::new(Vec::new())); + let (idp, resource): (&dyn OAuthHttpClient, &dyn OAuthHttpClient) = match stage { + Idp => (&delayed, &ready), + _ => (&ready, &delayed), + }; + let refresh = RefreshToken::new("refresh-token".into()); + let request = EmaExchangeRequest::new( + EmaAuthorizationServer::new(IDP, IDP_TOKEN, "idp") + .with_client_authentication(idp_auth), + EmaAuthorizationServer::new(AS, AS_TOKEN, "mcp") + .with_client_authentication(resource_auth), + RESOURCE, + &refresh, + ); + let start = tokio::time::Instant::now(); + let result = + tokio::time::timeout(Duration::from_secs(31), request.exchange(idp, resource)) + .await + .expect("signing must share the SDK's token request deadline"); + assert_eq!(result.unwrap_err(), EmaError::RequestFailed(stage)); + assert_eq!(start.elapsed(), Duration::from_secs(30)); + assert_eq!(provider.calls.lock().unwrap().len(), 1); + assert_eq!( + delayed.0.lock().unwrap().len(), + usize::from(matches!(behavior, AssertionBehavior::Delay(_))) + ); + assert_eq!( + ready.requests.lock().unwrap().len(), + usize::from(stage == ResourceServer) + ); + } + } +} + +#[tokio::test] +async fn rejected_client_authentication_never_falls_back_or_retries() { + for stage in [Idp, ResourceServer] { + for method in [ + AuthenticationMethod::Basic, + AuthenticationMethod::Post, + AuthenticationMethod::Jwt, + ] { + let provider = RecordingAssertionProvider::new(AssertionBehavior::Success); + let failure = json!({"error":"invalid_client","error_description":"client-authentication-secret"}); + let idp = if stage == Idp { + MockHttp::new(401, failure.clone()) + } else { + MockHttp::new(200, jag(&claims())) + }; + let resource = MockHttp::new(401, failure); + let error = EmaExchangeRequest::new( + EmaAuthorizationServer::new(IDP, IDP_TOKEN, "idp") + .with_client_authentication(method.configure("idp-client-secret", &provider)), + EmaAuthorizationServer::new(AS, AS_TOKEN, "mcp") + .with_client_authentication(method.configure("as-client-secret", &provider)), + RESOURCE, + &RefreshToken::new("refresh-token".into()), + ) + .exchange(&idp, &resource) + .await + .unwrap_err(); + assert_eq!( + error, + EmaError::OAuthRejected { + stage, + status: 401, + code: "invalid_client" + } + ); + assert!(!format!("{error:?} {error}").contains("client-authentication-secret")); + assert_eq!(idp.requests.lock().unwrap().len(), 1); + assert_eq!( + resource.requests.lock().unwrap().len(), + usize::from(stage == ResourceServer) + ); + let expected_calls = if method == AuthenticationMethod::Jwt { + 1 + usize::from(stage == ResourceServer) + } else { + 0 + }; + assert_eq!(provider.calls.lock().unwrap().len(), expected_calls); + } + } +} + +#[test] +fn client_authentication_debug_output_redacts_credentials_and_provider_state() { + const SECRET: &str = "client-authentication-secret-sentinel"; + let provider = RecordingAssertionProvider::new(AssertionBehavior::Empty(SECRET)); + let assertion = EmaClientAssertion::new(SECRET.into()); + assert!(!format!("{assertion:?}").contains(SECRET)); + for authentication in [ + EmaClientAuthentication::ClientSecretBasic(ClientSecret::new(SECRET.into())), + EmaClientAuthentication::ClientSecretPost(ClientSecret::new(SECRET.into())), + EmaClientAuthentication::JwtAssertion(provider.clone()), + ] { + assert!(!format!("{authentication:?}").contains(SECRET)); + let server = EmaAuthorizationServer::new(IDP, IDP_TOKEN, "idp") + .with_client_authentication(authentication); + let refresh = RefreshToken::new("refresh-token".into()); + let request = EmaExchangeRequest::new(server.clone(), server.clone(), RESOURCE, &refresh); + assert!(!format!("{server:?} {request:?}").contains(SECRET)); + assert!(!format!("{server:?} {request:?}").contains("private-query")); + } +} diff --git a/vendor/rmcp/src/transport/child_process.rs b/vendor/rmcp/src/transport/child_process.rs new file mode 100644 index 00000000..6e19a0c3 --- /dev/null +++ b/vendor/rmcp/src/transport/child_process.rs @@ -0,0 +1,321 @@ +use std::process::Stdio; + +use futures::future::Future; +use process_wrap::tokio::{ChildWrapper, CommandWrap}; +use tokio::process::{ChildStderr, ChildStdin, ChildStdout}; + +use super::{RxJsonRpcMessage, Transport, TxJsonRpcMessage, async_rw::AsyncRwTransport}; +use crate::RoleClient; + +const MAX_WAIT_ON_DROP_SECS: u64 = 3; +/// The parts of a child process. +type ChildProcessParts = ( + Box, + ChildStdout, + ChildStdin, + Option, +); + +/// Extract the stdio handles from a spawned child. +/// Returns `(child, stdout, stdin, stderr)` where `stderr` is `Some` only +/// if the process was spawned with `Stdio::piped()`. +#[inline] +fn child_process(mut child: Box) -> std::io::Result { + let child_stdin = match child.inner_mut().stdin().take() { + Some(stdin) => stdin, + None => return Err(std::io::Error::other("stdin was already taken")), + }; + let child_stdout = match child.inner_mut().stdout().take() { + Some(stdout) => stdout, + None => return Err(std::io::Error::other("stdout was already taken")), + }; + let child_stderr = child.inner_mut().stderr().take(); + Ok((child, child_stdout, child_stdin, child_stderr)) +} + +pub struct TokioChildProcess { + child: ChildWithCleanup, + transport: AsyncRwTransport, +} + +pub struct ChildWithCleanup { + inner: Option>, +} + +impl Drop for ChildWithCleanup { + fn drop(&mut self) { + // We should not use start_kill(), instead we should use kill() to avoid zombies + if let Some(mut inner) = self.inner.take() { + // We don't care about the result, just try to kill it + tokio::spawn(async move { + if let Err(e) = Box::into_pin(inner.kill()).await { + tracing::warn!("Error killing child process: {}", e); + } + }); + } + } +} + +impl TokioChildProcess { + /// Convenience: spawn with default `piped` stdio + pub fn new(command: impl Into) -> std::io::Result { + let (proc, _ignored) = TokioChildProcessBuilder::new(command).spawn()?; + Ok(proc) + } + + /// Builder entry-point allowing fine-grained stdio control. + pub fn builder(command: impl Into) -> TokioChildProcessBuilder { + TokioChildProcessBuilder::new(command) + } + + /// Get the process ID of the child process. + pub fn id(&self) -> Option { + self.child.inner.as_ref()?.id() + } + + /// Gracefully shutdown the child process + /// + /// This will first close the transport to the child process (the server), + /// and wait for the child process to exit normally with a timeout. + /// If the child process doesn't exit within the timeout, it will be killed. + pub async fn graceful_shutdown(&mut self) -> std::io::Result<()> { + if let Some(mut child) = self.child.inner.take() { + self.transport.close().await?; + + let wait_fut = child.wait(); + tokio::select! { + _ = tokio::time::sleep(std::time::Duration::from_secs(MAX_WAIT_ON_DROP_SECS)) => { + if let Err(e) = Box::into_pin(child.kill()).await { + tracing::warn!("Error killing child: {e}"); + return Err(e); + } + }, + res = wait_fut => { + match res { + Ok(status) => { + tracing::info!("Child exited gracefully {}", status); + } + Err(e) => { + tracing::warn!("Error waiting for child: {e}"); + return Err(e); + } + } + } + } + } + Ok(()) + } + + /// Take ownership of the inner child process + pub fn into_inner(mut self) -> Option> { + self.child.inner.take() + } +} + +/// Builder for `TokioChildProcess` allowing custom `Stdio` configuration. +pub struct TokioChildProcessBuilder { + cmd: CommandWrap, + stdin: Stdio, + stdout: Stdio, + stderr: Stdio, +} + +impl TokioChildProcessBuilder { + fn new(cmd: impl Into) -> Self { + Self { + cmd: cmd.into(), + stdin: Stdio::piped(), + stdout: Stdio::piped(), + stderr: Stdio::inherit(), + } + } + + /// Override the child stdin configuration. + pub fn stdin(mut self, io: impl Into) -> Self { + self.stdin = io.into(); + self + } + /// Override the child stdout configuration. + pub fn stdout(mut self, io: impl Into) -> Self { + self.stdout = io.into(); + self + } + /// Override the child stderr configuration. + pub fn stderr(mut self, io: impl Into) -> Self { + self.stderr = io.into(); + self + } + + /// Spawn the child process. Returns the transport plus an optional captured stderr handle. + pub fn spawn(mut self) -> std::io::Result<(TokioChildProcess, Option)> { + self.cmd + .command_mut() + .stdin(self.stdin) + .stdout(self.stdout) + .stderr(self.stderr); + + let (child, stdout, stdin, stderr_opt) = child_process(self.cmd.spawn()?)?; + + let transport = AsyncRwTransport::new(stdout, stdin); + let proc = TokioChildProcess { + child: ChildWithCleanup { inner: Some(child) }, + transport, + }; + Ok((proc, stderr_opt)) + } +} + +impl Transport for TokioChildProcess { + type Error = std::io::Error; + + fn send( + &mut self, + item: TxJsonRpcMessage, + ) -> impl Future> + Send + 'static { + self.transport.send(item) + } + + fn receive(&mut self) -> impl Future>> + Send { + self.transport.receive() + } + + fn close(&mut self) -> impl Future> + Send { + self.graceful_shutdown() + } +} + +pub trait ConfigureCommandExt { + fn configure(self, f: impl FnOnce(&mut Self)) -> Self; +} + +impl ConfigureCommandExt for tokio::process::Command { + fn configure(mut self, f: impl FnOnce(&mut Self)) -> Self { + f(&mut self); + self + } +} + +/// Resolve the absolute path to an executable using the system `PATH`, +/// then return a [`tokio::process::Command`] pointing at it. +/// +/// This is especially useful on Windows where `.cmd` / `.exe` shim scripts +/// (e.g. `npx.cmd`) are not reliably found by [`tokio::process::Command`] +/// without a fully-qualified path. +/// +/// # Example +/// ```rust,no_run +/// use rmcp::transport::{which_command, ConfigureCommandExt}; +/// +/// # fn example() -> std::io::Result<()> { +/// let cmd = which_command("npx")? +/// .configure(|cmd| { +/// cmd.arg("-y").arg("@modelcontextprotocol/server-everything"); +/// }); +/// # Ok(()) +/// # } +/// ``` +#[cfg(feature = "which-command")] +pub fn which_command( + name: impl AsRef, +) -> std::io::Result { + let resolved = which::which(name.as_ref()) + .map_err(|e| std::io::Error::new(std::io::ErrorKind::NotFound, e))?; + Ok(tokio::process::Command::new(resolved)) +} + +#[cfg(feature = "which-command")] +#[cfg(test)] +mod tests_which { + #[test] + fn which_command_resolves_known_binary() { + // `ls` exists on every Unix system, `cmd` on Windows + #[cfg(unix)] + let result = super::which_command("ls"); + #[cfg(windows)] + let result = super::which_command("cmd"); + + assert!(result.is_ok()); + } + + #[test] + fn which_command_fails_for_nonexistent() { + let result = super::which_command("this_binary_definitely_does_not_exist_12345"); + assert!(result.is_err()); + assert_eq!(result.unwrap_err().kind(), std::io::ErrorKind::NotFound); + } +} + +#[cfg(unix)] +#[cfg(test)] +mod tests { + use tokio::process::Command; + + use super::*; + + #[tokio::test] + async fn test_tokio_child_process_drop() { + let r = TokioChildProcess::new(Command::new("sleep").configure(|cmd| { + cmd.arg("30"); + })); + assert!(r.is_ok()); + let child_process = r.unwrap(); + let id = child_process.id(); + assert!(id.is_some()); + let id = id.unwrap(); + // Drop the child process + drop(child_process); + // Wait a moment to allow the cleanup task to run + tokio::time::sleep(std::time::Duration::from_secs(MAX_WAIT_ON_DROP_SECS + 1)).await; + // Check if the process is still running + let status = Command::new("ps") + .arg("-p") + .arg(id.to_string()) + .status() + .await; + match status { + Ok(status) => { + assert!( + !status.success(), + "Process with PID {} is still running", + id + ); + } + Err(e) => { + panic!("Failed to check process status: {}", e); + } + } + } + + #[tokio::test] + async fn test_tokio_child_process_graceful_shutdown() { + let r = TokioChildProcess::new(Command::new("sleep").configure(|cmd| { + cmd.arg("30"); + })); + assert!(r.is_ok()); + let mut child_process = r.unwrap(); + let id = child_process.id(); + assert!(id.is_some()); + let id = id.unwrap(); + child_process.graceful_shutdown().await.unwrap(); + // Wait a moment to allow the cleanup task to run + tokio::time::sleep(std::time::Duration::from_secs(MAX_WAIT_ON_DROP_SECS + 1)).await; + // Check if the process is still running + let status = Command::new("ps") + .arg("-p") + .arg(id.to_string()) + .status() + .await; + match status { + Ok(status) => { + assert!( + !status.success(), + "Process with PID {} is still running", + id + ); + } + Err(e) => { + panic!("Failed to check process status: {}", e); + } + } + } +} diff --git a/vendor/rmcp/src/transport/common.rs b/vendor/rmcp/src/transport/common.rs new file mode 100644 index 00000000..8cf00c02 --- /dev/null +++ b/vendor/rmcp/src/transport/common.rs @@ -0,0 +1,22 @@ +#[cfg(feature = "transport-streamable-http-server")] +pub mod server_side_http; + +pub mod http_header; + +#[cfg(any(feature = "client-side-sse", feature = "server-side-http"))] +pub mod mcp_headers; + +#[cfg(feature = "__reqwest")] +mod reqwest; + +// Note: This module provides SSE stream parsing and auto-reconnect utilities. +// It's used by the streamable HTTP client (which receives SSE-formatted responses), +// not the removed SSE transport. The name is historical. +#[cfg(feature = "client-side-sse")] +pub mod client_side_sse; + +#[cfg(feature = "auth")] +pub mod auth; + +#[cfg(all(unix, feature = "transport-streamable-http-client-unix-socket"))] +pub mod unix_socket; diff --git a/vendor/rmcp/src/transport/common/auth.rs b/vendor/rmcp/src/transport/common/auth.rs new file mode 100644 index 00000000..6068f4e9 --- /dev/null +++ b/vendor/rmcp/src/transport/common/auth.rs @@ -0,0 +1,2 @@ +#[cfg(feature = "transport-streamable-http-client")] +mod streamable_http_client; diff --git a/vendor/rmcp/src/transport/common/auth/streamable_http_client.rs b/vendor/rmcp/src/transport/common/auth/streamable_http_client.rs new file mode 100644 index 00000000..47b6caf5 --- /dev/null +++ b/vendor/rmcp/src/transport/common/auth/streamable_http_client.rs @@ -0,0 +1,380 @@ +use std::collections::HashMap; + +use http::{HeaderName, HeaderValue}; +use tracing::debug; + +use crate::transport::{ + auth::{AuthClient, AuthError}, + streamable_http_client::{StreamableHttpClient, StreamableHttpError}, +}; + +impl AuthClient +where + C: StreamableHttpClient + Send + Sync, +{ + /// Run `call` with a token when one is available, reacting to the + /// server's auth verdict instead of requiring credentials up front: + /// + /// - no usable credentials → the request goes out unauthenticated, and a + /// 401 propagates as [`StreamableHttpError::AuthRequired`] carrying the + /// `WWW-Authenticate` challenge for the caller to authorize with; + /// - a token the server rejects (e.g. revoked) → one silent refresh, one + /// retry, then the challenge propagates; + /// - a refresh that fails for any other reason (credential store, network, + /// provider) → that error propagates so the caller can retry instead of + /// being sent through a new authorization. + async fn call_reacting_to_challenges( + &self, + auth_token: Option, + call: F, + ) -> Result> + where + F: Fn(Option) -> Fut, + Fut: Future>>, + { + // Missing credentials are not an error in the reactive model: the + // request goes out unauthenticated and the server's 401 challenge + // drives authorization. + let auth_token = match auth_token { + None => match self.get_access_token().await { + Ok(token) => Some(token), + Err(AuthError::AuthorizationRequired) => None, + Err(error) => return Err(error.into()), + }, + token => token, + }; + match call(auth_token.clone()).await { + Err(StreamableHttpError::AuthRequired(challenge)) => { + // One silent recovery attempt: refresh the rejected token and + // retry only when the refresh actually produced a new one. + let Some(sent_token) = auth_token else { + return Err(StreamableHttpError::AuthRequired(challenge)); + }; + let refreshed = { + let manager = self.auth_manager.lock().await; + manager.try_refresh_or_reauth().await + }; + match refreshed { + Ok(fresh_token) if fresh_token != sent_token => call(Some(fresh_token)).await, + Ok(_) => Err(StreamableHttpError::AuthRequired(challenge)), + // `try_refresh_or_reauth` already reports the cases that need a + // new authorization; anything else is retryable or infrastructural. + Err(AuthError::AuthorizationRequired) => { + debug!("token refresh after server rejection requires authorization"); + Err(StreamableHttpError::AuthRequired(challenge)) + } + Err(error) => Err(error.into()), + } + } + result => result, + } + } +} + +impl StreamableHttpClient for AuthClient +where + C: StreamableHttpClient + Send + Sync, +{ + type Error = C::Error; + + async fn delete_session( + &self, + uri: std::sync::Arc, + session_id: std::sync::Arc, + auth_token: Option, + custom_headers: HashMap, + ) -> Result<(), crate::transport::streamable_http_client::StreamableHttpError> + { + self.call_reacting_to_challenges(auth_token, |token| { + let uri = uri.clone(); + let session_id = session_id.clone(); + let custom_headers = custom_headers.clone(); + async move { + self.http_client + .delete_session(uri, session_id, token, custom_headers) + .await + } + }) + .await + } + + async fn get_stream( + &self, + uri: std::sync::Arc, + session_id: Option>, + last_event_id: Option, + auth_token: Option, + custom_headers: HashMap, + ) -> Result< + futures::stream::BoxStream<'static, Result>, + crate::transport::streamable_http_client::StreamableHttpError, + > { + self.call_reacting_to_challenges(auth_token, |token| { + let uri = uri.clone(); + let session_id = session_id.clone(); + let last_event_id = last_event_id.clone(); + let custom_headers = custom_headers.clone(); + async move { + self.http_client + .get_stream(uri, session_id, last_event_id, token, custom_headers) + .await + } + }) + .await + } + + async fn get_stream_with_max_sse_event_size( + &self, + uri: std::sync::Arc, + session_id: Option>, + last_event_id: Option, + auth_token: Option, + custom_headers: HashMap, + max_sse_event_size: usize, + ) -> Result< + futures::stream::BoxStream<'static, Result>, + crate::transport::streamable_http_client::StreamableHttpError, + > { + self.call_reacting_to_challenges(auth_token, |token| { + let uri = uri.clone(); + let session_id = session_id.clone(); + let last_event_id = last_event_id.clone(); + let custom_headers = custom_headers.clone(); + async move { + self.http_client + .get_stream_with_max_sse_event_size( + uri, + session_id, + last_event_id, + token, + custom_headers, + max_sse_event_size, + ) + .await + } + }) + .await + } + + async fn post_message( + &self, + uri: std::sync::Arc, + message: crate::model::ClientJsonRpcMessage, + session_id: Option>, + auth_token: Option, + custom_headers: HashMap, + ) -> Result< + crate::transport::streamable_http_client::StreamableHttpPostResponse, + StreamableHttpError, + > { + self.call_reacting_to_challenges(auth_token, |token| { + let uri = uri.clone(); + let message = message.clone(); + let session_id = session_id.clone(); + let custom_headers = custom_headers.clone(); + async move { + self.http_client + .post_message(uri, message, session_id, token, custom_headers) + .await + } + }) + .await + } + + async fn post_message_with_max_sse_event_size( + &self, + uri: std::sync::Arc, + message: crate::model::ClientJsonRpcMessage, + session_id: Option>, + auth_token: Option, + custom_headers: HashMap, + max_sse_event_size: usize, + ) -> Result< + crate::transport::streamable_http_client::StreamableHttpPostResponse, + StreamableHttpError, + > { + self.call_reacting_to_challenges(auth_token, |token| { + let uri = uri.clone(); + let message = message.clone(); + let session_id = session_id.clone(); + let custom_headers = custom_headers.clone(); + async move { + self.http_client + .post_message_with_max_sse_event_size( + uri, + message, + session_id, + token, + custom_headers, + max_sse_event_size, + ) + .await + } + }) + .await + } +} + +#[cfg(all(test, feature = "transport-streamable-http-client-reqwest"))] +mod tests { + use std::sync::Arc; + + use oauth2::{AccessToken, RefreshToken, basic::BasicTokenType}; + + use super::*; + use crate::transport::{ + auth::{ + AuthorizationManager, AuthorizationMetadata, CredentialRefreshGuard, CredentialStore, + InMemoryCredentialStore, OAuthHttpClient, OAuthHttpClientFuture, OAuthHttpRequest, + OAuthTokenResponse, StoredCredentials, VendorExtraTokenFields, + }, + streamable_http_client::AuthRequiredError, + }; + + struct UnavailableStore; + + #[async_trait::async_trait] + impl CredentialStore for UnavailableStore { + async fn load(&self) -> Result, AuthError> { + unreachable!("guard failure must stop the credential load") + } + + async fn save(&self, _: StoredCredentials) -> Result<(), AuthError> { + unreachable!("guard failure must stop the credential save") + } + + async fn clear(&self) -> Result<(), AuthError> { + unreachable!("refresh must not clear credentials") + } + + async fn acquire_refresh_guard(&self) -> Result, AuthError> { + Err(AuthError::CredentialStoreError("guard unavailable".into())) + } + } + + #[tokio::test] + async fn reactive_refresh_preserves_credential_store_failure() { + let mut manager = AuthorizationManager::new("https://mcp.example.com/mcp") + .await + .unwrap(); + manager.set_metadata(AuthorizationMetadata { + authorization_endpoint: "https://auth.example.com/authorize".into(), + token_endpoint: "https://auth.example.com/token".into(), + ..Default::default() + }); + manager.configure_client_id("client").unwrap(); + manager.set_credential_store(UnavailableStore); + let client = AuthClient::new(reqwest::Client::new(), manager); + + let error = client + .call_reacting_to_challenges(Some("old-token".into()), |_| async { + Err::<(), _>(StreamableHttpError::AuthRequired(AuthRequiredError::new( + "Bearer".into(), + ))) + }) + .await + .unwrap_err(); + + assert!(matches!(error, + StreamableHttpError::Auth(AuthError::CredentialStoreError(message)) + if message == "guard unavailable")); + } + + struct UnreachableTokenEndpoint; + + impl OAuthHttpClient for UnreachableTokenEndpoint { + fn execute(&self, _: OAuthHttpRequest) -> OAuthHttpClientFuture<'_> { + Box::pin(async { Err("token endpoint unreachable".into()) }) + } + } + + struct RejectingTokenEndpoint; + + impl OAuthHttpClient for RejectingTokenEndpoint { + fn execute(&self, _: OAuthHttpRequest) -> OAuthHttpClientFuture<'_> { + Box::pin(async { + Ok(oauth2::http::Response::builder() + .status(400) + .header("content-type", "application/json") + .body(br#"{"error":"invalid_grant"}"#.to_vec()) + .unwrap()) + }) + } + } + + /// A manager holding a refresh token the given token endpoint will answer for. + async fn manager_with_stored_refresh_token( + token_endpoint: Arc, + ) -> AuthorizationManager { + let mut manager = AuthorizationManager::new_with_oauth_http_client( + "https://mcp.example.com/mcp", + token_endpoint, + ) + .await + .unwrap(); + manager.set_metadata(AuthorizationMetadata { + authorization_endpoint: "https://auth.example.com/authorize".into(), + token_endpoint: "https://auth.example.com/token".into(), + ..Default::default() + }); + manager.configure_client_id("client").unwrap(); + + let mut token_response = OAuthTokenResponse::new( + AccessToken::new("old-token".into()), + BasicTokenType::Bearer, + VendorExtraTokenFields::default(), + ); + token_response.set_refresh_token(Some(RefreshToken::new("stored-refresh".into()))); + let store = InMemoryCredentialStore::new(); + store + .save(StoredCredentials::new( + "client".into(), + Some(token_response), + vec![], + None, + )) + .await + .unwrap(); + manager.set_credential_store(store); + manager + } + + /// Drive one call whose server answer is a 401 challenge. + async fn challenge_once(manager: AuthorizationManager) -> StreamableHttpError { + AuthClient::new(reqwest::Client::new(), manager) + .call_reacting_to_challenges(Some("old-token".into()), |_| async { + Err::<(), _>(StreamableHttpError::AuthRequired(AuthRequiredError::new( + "Bearer".into(), + ))) + }) + .await + .unwrap_err() + } + + #[tokio::test] + async fn reactive_refresh_propagates_retryable_refresh_failure() { + let manager = manager_with_stored_refresh_token(Arc::new(UnreachableTokenEndpoint)).await; + + let error = challenge_once(manager).await; + + assert!( + matches!( + error, + StreamableHttpError::Auth(AuthError::TokenRefreshFailed(_)) + ), + "a retryable refresh failure must reach the caller instead of asking for a new authorization, got: {error:?}" + ); + } + + #[tokio::test] + async fn reactive_refresh_reports_a_rejected_refresh_token_as_a_challenge() { + let manager = manager_with_stored_refresh_token(Arc::new(RejectingTokenEndpoint)).await; + + let error = challenge_once(manager).await; + + assert!( + matches!(error, StreamableHttpError::AuthRequired(_)), + "a definitively rejected refresh token must surface the challenge, got: {error:?}" + ); + } +} diff --git a/vendor/rmcp/src/transport/common/client_side_sse.rs b/vendor/rmcp/src/transport/common/client_side_sse.rs new file mode 100644 index 00000000..2ee37aaf --- /dev/null +++ b/vendor/rmcp/src/transport/common/client_side_sse.rs @@ -0,0 +1,864 @@ +use std::{ + pin::Pin, + sync::Arc, + task::{Poll, ready}, + time::Duration, +}; + +use bytes::Bytes; +use futures::{Stream, StreamExt, stream::BoxStream}; +use sse_stream::{Error as SseError, Sse, SseStream}; +use thiserror::Error; + +use crate::model::ServerJsonRpcMessage; + +pub type BoxedSseResponse = BoxStream<'static, Result>; + +/// Maximum raw size of one SSE event accepted from a remote server. +pub(crate) const DEFAULT_MAX_SSE_EVENT_SIZE: usize = 16 * 1024 * 1024; + +#[derive(Debug, Error)] +enum BoundedSseStreamError { + #[error(transparent)] + Source(Box), + #[error("SSE event exceeded the maximum size of {max_size} bytes")] + EventTooLarge { max_size: usize }, +} + +#[derive(Debug)] +struct SseEventSizeLimiter { + max_size: usize, + retained_size: usize, + line_size: usize, + line_is_comment: bool, + previous_was_cr: bool, +} + +impl SseEventSizeLimiter { + fn new(max_size: usize) -> Self { + Self { + max_size, + retained_size: 0, + line_size: 0, + line_is_comment: false, + previous_was_cr: false, + } + } + + fn observe(&mut self, chunk: &[u8]) -> Result<(), ()> { + for &byte in chunk { + if self.previous_was_cr { + self.previous_was_cr = false; + if byte == b'\n' { + continue; + } + } + + match byte { + b'\r' => { + self.finish_line()?; + self.previous_was_cr = true; + } + b'\n' => self.finish_line()?, + _ => { + if self.line_size == 0 { + self.line_is_comment = byte == b':'; + } + self.line_size = self.line_size.saturating_add(1); + self.check_limit()?; + } + } + } + Ok(()) + } + + fn finish_line(&mut self) -> Result<(), ()> { + if self.line_size == 0 { + self.retained_size = 0; + } else if !self.line_is_comment { + // The SSE parser inserts a newline when joining multiple data fields. + self.retained_size = self + .retained_size + .saturating_add(self.line_size) + .saturating_add(1); + } + self.line_size = 0; + self.line_is_comment = false; + self.check_limit() + } + + fn check_limit(&self) -> Result<(), ()> { + if self.retained_size.saturating_add(self.line_size) > self.max_size { + Err(()) + } else { + Ok(()) + } + } +} + +pin_project_lite::pin_project! { + struct BoundedSseByteStream { + #[pin] + inner: S, + limiter: SseEventSizeLimiter, + failed: bool, + } +} + +impl Stream for BoundedSseByteStream +where + S: Stream>, + E: std::error::Error + Send + Sync + 'static, +{ + type Item = Result; + + fn poll_next( + self: Pin<&mut Self>, + cx: &mut std::task::Context<'_>, + ) -> Poll> { + let mut this = self.project(); + if *this.failed { + return Poll::Ready(None); + } + + match ready!(this.inner.as_mut().poll_next(cx)) { + Some(Ok(chunk)) => { + if this.limiter.observe(&chunk).is_err() { + *this.failed = true; + Poll::Ready(Some(Err(BoundedSseStreamError::EventTooLarge { + max_size: this.limiter.max_size, + }))) + } else { + Poll::Ready(Some(Ok(chunk))) + } + } + Some(Err(error)) => { + *this.failed = true; + Poll::Ready(Some(Err(BoundedSseStreamError::Source(Box::new(error))))) + } + None => Poll::Ready(None), + } + } +} + +pub(crate) fn bounded_sse_stream(stream: S, max_event_size: usize) -> BoxedSseResponse +where + S: Stream> + Send + 'static, + E: std::error::Error + Send + Sync + 'static, +{ + let stream = BoundedSseByteStream { + inner: stream, + limiter: SseEventSizeLimiter::new(max_event_size), + failed: false, + }; + SseStream::from_bytes_stream(stream).boxed() +} + +fn is_event_too_large_error(error: &SseError) -> bool { + matches!( + error, + SseError::Body(error) + if matches!( + error.downcast_ref::(), + Some(BoundedSseStreamError::EventTooLarge { .. }) + ) + ) +} + +pub trait SseRetryPolicy: std::fmt::Debug + Send + Sync { + fn retry(&self, current_times: usize) -> Option; +} + +#[derive(Debug, Clone)] +#[non_exhaustive] +pub struct FixedInterval { + pub max_times: Option, + pub duration: Duration, +} + +impl SseRetryPolicy for FixedInterval { + fn retry(&self, current_times: usize) -> Option { + if let Some(max_times) = self.max_times + && current_times >= max_times + { + return None; + } + Some(self.duration) + } +} + +impl FixedInterval { + pub const DEFAULT_MIN_DURATION: Duration = Duration::from_millis(1000); +} + +impl Default for FixedInterval { + fn default() -> Self { + Self { + max_times: None, + duration: Self::DEFAULT_MIN_DURATION, + } + } +} + +#[derive(Debug, Clone)] +#[non_exhaustive] +pub struct ExponentialBackoff { + pub max_times: Option, + pub base_duration: Duration, + /// Optional upper bound on a single reconnect delay. `None` (the default) preserves the + /// pre-existing unbounded doubling behavior. Once the multiplier saturates near the bit + /// width that can still produce very long sleeps, so callers that need the client to + /// actually reconnect can set `Some(...)` to clamp the delay. + pub max_delay: Option, +} + +impl ExponentialBackoff { + pub const DEFAULT_DURATION: Duration = Duration::from_millis(1000); +} + +impl Default for ExponentialBackoff { + fn default() -> Self { + Self { + max_times: None, + base_duration: Self::DEFAULT_DURATION, + max_delay: None, + } + } +} + +impl SseRetryPolicy for ExponentialBackoff { + fn retry(&self, current_times: usize) -> Option { + if let Some(max_times) = self.max_times + && current_times >= max_times + { + return None; + } + // `current_times` is unbounded when `max_times` is unset, so the exponent can reach + // the bit width. Saturate the multiplier at `u32::MAX` and use saturating multiplication + // for the base duration so the delay stays monotonic and panic-free instead of an + // overflow panic (debug) or a wrapped-to-zero backoff (release). + let multiplier = 2u32.saturating_pow(current_times as u32); + let delay = self.base_duration.saturating_mul(multiplier); + Some(match self.max_delay { + Some(max_delay) => delay.min(max_delay), + None => delay, + }) + } +} + +#[derive(Debug, Clone, Copy, Default)] +#[non_exhaustive] +pub struct NeverRetry; + +impl SseRetryPolicy for NeverRetry { + fn retry(&self, _current_times: usize) -> Option { + None + } +} + +#[derive(Debug, Default)] +pub struct NeverReconnect { + error: Option, +} + +impl SseStreamReconnect for NeverReconnect { + type Error = E; + type Future = futures::future::Ready>; + fn retry_connection(&mut self, _last_event_id: Option<&str>) -> Self::Future { + futures::future::ready(Err(self.error.take().expect("should not be called again"))) + } +} + +/// Abstraction for SSE reconnection logic. Implementors can hook into +/// [`handle_control_event`](Self::handle_control_event) to consume control +/// frames (e.g. `event: endpoint`) that arrive when a server restarts an SSE +/// stream. The default implementation is a no-op, keeping existing behaviour +/// intact. +pub(crate) trait SseStreamReconnect { + type Error: std::error::Error; + type Future: Future> + Send; + fn retry_connection(&mut self, last_event_id: Option<&str>) -> Self::Future; + fn handle_control_event(&mut self, _event: &Sse) -> Result<(), Self::Error> { + Ok(()) + } + fn handle_stream_error( + &mut self, + error: &(dyn std::error::Error + 'static), + last_event_id: Option<&str>, + ) { + if let Some(id) = last_event_id { + tracing::warn!(%id, "sse stream error: {error}"); + } else { + tracing::warn!("sse stream error: {error}"); + } + } + fn map_fatal_stream_error(&mut self, error: SseError) -> Option { + tracing::warn!("fatal sse stream error: {error}"); + None + } +} + +pin_project_lite::pin_project! { + pub(crate) struct SseAutoReconnectStream + where R: SseStreamReconnect + { + retry_policy: Arc, + reconnect_only_after_event_id: bool, + last_event_id: Option, + server_retry_interval: Option, + connector: R, + #[pin] + state: SseAutoReconnectStreamState, + } +} + +impl SseAutoReconnectStream { + pub fn new( + stream: BoxedSseResponse, + connector: R, + retry_policy: Arc, + ) -> Self { + Self { + retry_policy, + reconnect_only_after_event_id: false, + last_event_id: None, + server_retry_interval: None, + connector, + state: SseAutoReconnectStreamState::Connected { stream }, + } + } + + pub fn new_after_event_id( + stream: BoxedSseResponse, + connector: R, + retry_policy: Arc, + ) -> Self { + Self { + retry_policy, + reconnect_only_after_event_id: true, + last_event_id: None, + server_retry_interval: None, + connector, + state: SseAutoReconnectStreamState::Connected { stream }, + } + } +} + +impl SseAutoReconnectStream> { + #[allow(dead_code)] + pub(crate) fn never_reconnect(stream: BoxedSseResponse, error_when_reconnect: E) -> Self { + Self { + retry_policy: Arc::new(NeverRetry), + reconnect_only_after_event_id: false, + last_event_id: None, + server_retry_interval: None, + connector: NeverReconnect { + error: Some(error_when_reconnect), + }, + state: SseAutoReconnectStreamState::Connected { stream }, + } + } +} + +pin_project_lite::pin_project! { + #[project = SseAutoReconnectStreamStateProj] + #[non_exhaustive] + pub enum SseAutoReconnectStreamState { + Connected { + #[pin] + stream: BoxedSseResponse, + }, + Retrying { + retry_times: usize, + #[pin] + retrying: F, + }, + WaitingNextRetry { + #[pin] + sleep: tokio::time::Sleep, + retry_times: usize, + }, + Terminated, + } +} + +impl Stream for SseAutoReconnectStream +where + R: SseStreamReconnect, +{ + type Item = Result; + fn poll_next( + mut self: Pin<&mut Self>, + cx: &mut std::task::Context<'_>, + ) -> Poll> { + loop { + let mut this = self.as_mut().project(); + // let this_state = this.state.as_mut().project() + let state = this.state.as_mut().project(); + let next_state = match state { + SseAutoReconnectStreamStateProj::Connected { stream } => { + match ready!(stream.poll_next(cx)) { + Some(Ok(sse)) => { + if let Some(new_server_retry) = sse.retry { + *this.server_retry_interval = + Some(Duration::from_millis(new_server_retry)); + } + if let Some(ref event_id) = sse.id { + *this.last_event_id = Some(event_id.clone()); + } + // Only treat blank/`message` events as JSON-RPC payloads. + // Other control frames (endpoint, ping, etc.) are passed to + // the reconnection handler. + let is_message_event = + matches!(sse.event.as_deref(), None | Some("") | Some("message")); + if !is_message_event { + match this.connector.handle_control_event(&sse) { + Ok(()) => continue, + Err(e) => { + this.state.set(SseAutoReconnectStreamState::Terminated); + return Poll::Ready(Some(Err(e))); + } + } + } + if let Some(data) = sse.data { + match serde_json::from_str::(&data) { + Err(e) => { + // Downgrade to debug to avoid noisy logs when servers emit + // non-JSON payloads as message frames. Include last_event_id + // to aid troubleshooting while keeping default behaviour. + let last_id = this.last_event_id.as_deref().unwrap_or(""); + tracing::debug!(last_event_id=%last_id, "failed to deserialize server message: {e}"); + continue; + } + Ok(message) => { + return Poll::Ready(Some(Ok(message))); + } + }; + } else { + continue; + } + } + Some(Err(e)) => { + if is_event_too_large_error(&e) { + this.state.set(SseAutoReconnectStreamState::Terminated); + return Poll::Ready( + this.connector.map_fatal_stream_error(e).map(Err), + ); + } + if *this.reconnect_only_after_event_id && this.last_event_id.is_none() { + this.state.set(SseAutoReconnectStreamState::Terminated); + return Poll::Ready( + this.connector.map_fatal_stream_error(e).map(Err), + ); + } + this.connector + .handle_stream_error(&e, this.last_event_id.as_deref()); + let retrying = this + .connector + .retry_connection(this.last_event_id.as_deref()); + SseAutoReconnectStreamState::Retrying { + retry_times: 0, + retrying, + } + } + None => { + if *this.reconnect_only_after_event_id && this.last_event_id.is_none() { + tracing::debug!( + "sse response ended before an event ID was received; cannot resume" + ); + this.state.set(SseAutoReconnectStreamState::Terminated); + return Poll::Ready(None); + } + // Per SEP-1699, a graceful stream close is + // reconnectable. If the server sent a `retry` field + // we MUST wait that long before reconnecting. + let interval = this + .server_retry_interval + .take() + .or_else(|| this.retry_policy.retry(0)); + if let Some(interval) = interval { + tracing::debug!( + ?interval, + "sse stream ended gracefully, reconnecting" + ); + SseAutoReconnectStreamState::WaitingNextRetry { + sleep: tokio::time::sleep(interval), + retry_times: 0, + } + } else { + tracing::debug!("sse stream terminated, no reconnect policy"); + return Poll::Ready(None); + } + } + } + } + SseAutoReconnectStreamStateProj::Retrying { + retry_times, + retrying, + } => { + let retry_result = ready!(retrying.poll(cx)); + match retry_result { + Ok(new_stream) => { + SseAutoReconnectStreamState::Connected { stream: new_stream } + } + Err(e) => { + tracing::debug!("retry sse stream error: {e}"); + *retry_times += 1; + if let Some(interval) = this.retry_policy.retry(*retry_times) { + let interval = this + .server_retry_interval + .map(|server_retry_interval| { + server_retry_interval.max(interval) + }) + .unwrap_or(interval); + let sleep = tokio::time::sleep(interval); + SseAutoReconnectStreamState::WaitingNextRetry { + sleep, + retry_times: *retry_times, + } + } else { + tracing::error!("sse stream error: {e}, max retry times reached"); + this.state.set(SseAutoReconnectStreamState::Terminated); + return Poll::Ready(Some(Err(e))); + } + } + } + } + SseAutoReconnectStreamStateProj::WaitingNextRetry { sleep, retry_times } => { + ready!(sleep.poll(cx)); + let retrying = this + .connector + .retry_connection(this.last_event_id.as_deref()); + let retry_times = *retry_times; + SseAutoReconnectStreamState::Retrying { + retry_times, + retrying, + } + } + SseAutoReconnectStreamStateProj::Terminated => { + return Poll::Ready(None); + } + }; + // update the state + this.state.set(next_state); + } + } +} + +#[cfg(test)] +mod tests { + use std::sync::atomic::{AtomicUsize, Ordering}; + + use super::*; + + #[derive(Debug, Error)] + enum TestReconnectError { + #[error("SSE stream error: {0}")] + Sse(SseError), + #[error("unexpected reconnect")] + Reconnect, + } + + struct CountingReconnect { + attempts: Arc, + } + + impl SseStreamReconnect for CountingReconnect { + type Error = TestReconnectError; + type Future = futures::future::Ready>; + + fn retry_connection(&mut self, _last_event_id: Option<&str>) -> Self::Future { + self.attempts.fetch_add(1, Ordering::Relaxed); + futures::future::ready(Err(TestReconnectError::Reconnect)) + } + + fn map_fatal_stream_error(&mut self, error: SseError) -> Option { + Some(TestReconnectError::Sse(error)) + } + } + + #[tokio::test] + async fn bounded_sse_stream_rejects_unterminated_event_over_limit() { + let source = futures::stream::iter([ + Ok::<_, std::io::Error>(Bytes::from_static(b"data: aaaaa")), + Ok(Bytes::from_static(b"aaaaaa")), + ]); + let mut stream = bounded_sse_stream(source, 16); + + let error = stream.next().await.unwrap().unwrap_err(); + + assert!( + error.to_string().contains("maximum size of 16 bytes"), + "unexpected error: {error}" + ); + } + + #[tokio::test] + async fn bounded_sse_stream_resets_limit_after_event_terminator() { + let source = futures::stream::iter([ + Ok::<_, std::io::Error>(Bytes::from_static(b"data: a\r")), + Ok(Bytes::from_static(b"\n\r\ndata: b\n\n")), + ]); + let mut stream = bounded_sse_stream(source, 8); + + let first = stream.next().await.unwrap().unwrap(); + let second = stream.next().await.unwrap().unwrap(); + + assert_eq!( + (first.data.as_deref(), second.data.as_deref()), + (Some("a"), Some("b")) + ); + } + + #[tokio::test] + async fn bounded_sse_stream_passes_event_at_exact_limit() { + let source = + futures::stream::iter([Ok::<_, std::io::Error>(Bytes::from_static(b"data: ab\n\n"))]); + let mut stream = bounded_sse_stream(source, 9); + + let event = stream.next().await.unwrap().unwrap(); + assert_eq!(event.data.as_deref(), Some("ab")); + } + + #[tokio::test] + async fn bounded_sse_stream_rejects_oversize_split_across_many_chunks() { + let source = futures::stream::iter( + std::iter::repeat_with(|| Ok::<_, std::io::Error>(Bytes::from_static(b"data: x"))) + .take(20), + ); + let mut stream = bounded_sse_stream(source, 32); + + let mut found_error = false; + while let Some(item) = stream.next().await { + if item.is_err() { + found_error = true; + break; + } + } + assert!(found_error, "expected oversize error"); + } + + #[tokio::test] + async fn bounded_sse_stream_handles_crlf_split_across_chunks() { + let source = futures::stream::iter([ + Ok::<_, std::io::Error>(Bytes::from_static(b"data: hello\r")), + Ok(Bytes::from_static(b"\n\ndata: world\n\n")), + ]); + let mut stream = bounded_sse_stream(source, 64); + + let first = stream.next().await.unwrap().unwrap(); + let second = stream.next().await.unwrap().unwrap(); + + assert_eq!(first.data.as_deref(), Some("hello")); + assert_eq!(second.data.as_deref(), Some("world")); + } + + #[tokio::test] + async fn bounded_sse_stream_discards_completed_comment_lines_from_limit() { + let source = futures::stream::iter([Ok::<_, std::io::Error>(Bytes::from_static( + b": ping\n: ping\n: ping\n", + ))]); + let mut stream = bounded_sse_stream(source, 6); + + assert!(stream.next().await.is_none()); + } + + #[tokio::test] + async fn bounded_sse_stream_comments_do_not_reset_accumulated_data() { + let source = futures::stream::iter([Ok::<_, std::io::Error>(Bytes::from_static( + b"data: a\n: ping\ndata: b\n", + ))]); + let mut stream = bounded_sse_stream(source, 14); + + assert!(stream.next().await.unwrap().is_err()); + } + + #[tokio::test] + async fn bounded_sse_stream_counts_multiline_data_join_newlines() { + let source = futures::stream::iter([Ok::<_, std::io::Error>(Bytes::from_static( + b"data: aaa\ndata: bbb\n\n", + ))]); + let mut stream = bounded_sse_stream(source, 18); + + let error = stream.next().await.unwrap().unwrap_err(); + assert!( + error.to_string().contains("maximum size"), + "unexpected error: {error}" + ); + } + + #[tokio::test] + async fn bounded_sse_stream_propagates_source_error() { + let source = futures::stream::iter([Err::(std::io::Error::new( + std::io::ErrorKind::ConnectionReset, + "connection reset", + ))]); + let mut stream = bounded_sse_stream(source, 1024); + + let error = stream.next().await.unwrap().unwrap_err(); + assert!( + error.to_string().contains("connection reset"), + "unexpected error: {error}" + ); + } + + #[tokio::test] + async fn is_event_too_large_error_detects_oversize() { + let source = futures::stream::iter([Ok::<_, std::io::Error>(Bytes::from(vec![b'A'; 100]))]); + let mut stream = bounded_sse_stream(source, 8); + + let error = stream.next().await.unwrap().unwrap_err(); + assert!(is_event_too_large_error(&error)); + } + + #[tokio::test] + async fn is_event_too_large_error_rejects_other_errors() { + let source = + futures::stream::iter([Err::(std::io::Error::other("something else"))]); + let mut stream = bounded_sse_stream(source, 1024); + + let error = stream.next().await.unwrap().unwrap_err(); + assert!(!is_event_too_large_error(&error)); + } + + #[tokio::test] + async fn oversized_event_returns_error_without_reconnecting() { + let source = futures::stream::iter([Ok::<_, std::io::Error>(Bytes::from(vec![b'A'; 100]))]); + let attempts = Arc::new(AtomicUsize::new(0)); + let connector = CountingReconnect { + attempts: attempts.clone(), + }; + let stream = SseAutoReconnectStream::new( + bounded_sse_stream(source, 8), + connector, + Arc::new(NeverRetry), + ); + let mut stream = std::pin::pin!(stream); + + let result = stream.next().await; + + assert!( + matches!(result, Some(Err(TestReconnectError::Sse(_)))) + && attempts.load(Ordering::Relaxed) == 0 + ); + } + + #[tokio::test] + async fn skipped_events_do_not_grow_the_stack() { + // Every frame here fails to deserialize, so each one takes the "skip this + // event" path. The inner stream is always ready, so nothing yields in + // between: when that path recursed into poll_next instead of looping, this + // overflowed the stack and aborted the process. + const SKIPPED_EVENTS: usize = 50_000; + let mut payload = Vec::with_capacity(SKIPPED_EVENTS * 9); + for _ in 0..SKIPPED_EVENTS { + payload.extend_from_slice(b"data: x\n\n"); + } + + let source = futures::stream::iter([Ok::<_, std::io::Error>(Bytes::from(payload))]); + let attempts = Arc::new(AtomicUsize::new(0)); + let connector = CountingReconnect { + attempts: attempts.clone(), + }; + let stream = SseAutoReconnectStream::new( + bounded_sse_stream(source, 1024), + connector, + Arc::new(NeverRetry), + ); + let mut stream = std::pin::pin!(stream); + + assert!(stream.next().await.is_none()); + assert_eq!(attempts.load(Ordering::Relaxed), 0); + } + + #[tokio::test] + async fn response_without_event_id_does_not_reconnect() { + let attempts = Arc::new(AtomicUsize::new(0)); + let connector = CountingReconnect { + attempts: attempts.clone(), + }; + let stream = SseAutoReconnectStream::new_after_event_id( + futures::stream::empty().boxed(), + connector, + Arc::new(FixedInterval { + max_times: Some(1), + duration: Duration::ZERO, + }), + ); + let mut stream = std::pin::pin!(stream); + + assert!(stream.next().await.is_none()); + assert_eq!(attempts.load(Ordering::Relaxed), 0); + } + + #[test] + fn exponential_backoff_saturates_at_high_retry_counts() { + // With `max_times` unset, `current_times` can reach the bit width. The old + // `2u32.pow(current_times)` panicked in debug builds and wrapped in release; + // the saturating implementation must return a monotonic, non-zero delay instead. + let policy = ExponentialBackoff { + max_times: None, + base_duration: Duration::from_millis(1), + max_delay: None, + }; + let mut previous = Duration::ZERO; + for current_times in [31usize, 32, 63, 64, 100] { + let delay = policy + .retry(current_times) + .expect("unbounded policy never gives up"); + assert!( + !delay.is_zero(), + "delay must stay non-zero at {current_times}" + ); + assert!( + delay >= previous, + "delay must stay monotonic at {current_times}" + ); + previous = delay; + } + } + + #[test] + fn exponential_backoff_caps_delay_at_max_delay() { + // An explicit cap keeps the unbounded doubling policy from producing decades-long + // sleeps once the multiplier saturates. The delay must grow monotonically, stop at + // the configured ceiling, and never exceed it. + let policy = ExponentialBackoff { + max_times: None, + base_duration: Duration::from_secs(1), + max_delay: Some(Duration::from_secs(30)), + }; + let mut previous = Duration::ZERO; + for current_times in [0usize, 1, 2, 3, 4, 5, 10, 32, 64, 100] { + let delay = policy + .retry(current_times) + .expect("unbounded policy never gives up"); + assert!( + delay >= previous, + "delay must stay monotonic at {current_times}" + ); + assert!( + delay <= Duration::from_secs(30), + "delay must respect max_delay at {current_times}" + ); + previous = delay; + } + // Beyond the ceiling the delay stays pinned at max_delay. + assert_eq!( + policy.retry(100).expect("never gives up"), + Duration::from_secs(30) + ); + } + + #[test] + fn exponential_backoff_respects_max_times() { + let policy = ExponentialBackoff { + max_times: Some(3), + base_duration: Duration::from_millis(1), + max_delay: None, + }; + assert!(policy.retry(0).is_some()); + assert!(policy.retry(2).is_some()); + assert!(policy.retry(3).is_none()); + } +} diff --git a/vendor/rmcp/src/transport/common/http_header.rs b/vendor/rmcp/src/transport/common/http_header.rs new file mode 100644 index 00000000..6c2abbc8 --- /dev/null +++ b/vendor/rmcp/src/transport/common/http_header.rs @@ -0,0 +1,140 @@ +pub const HEADER_SESSION_ID: &str = "Mcp-Session-Id"; +pub const HEADER_LAST_EVENT_ID: &str = "Last-Event-Id"; +pub const HEADER_MCP_PROTOCOL_VERSION: &str = "MCP-Protocol-Version"; +pub const EVENT_STREAM_MIME_TYPE: &str = "text/event-stream"; +pub const JSON_MIME_TYPE: &str = "application/json"; + +// SEP-2243 standard headers, gated on protocol version >= 2026-07-28. +pub const HEADER_MCP_METHOD: &str = "Mcp-Method"; +pub const HEADER_MCP_NAME: &str = "Mcp-Name"; +pub const HEADER_MCP_PARAM_PREFIX: &str = "Mcp-Param-"; + +/// Sentinel wrapping a Base64-encoded SEP-2243 header value (`=?base64??=`). +pub const BASE64_HEADER_PREFIX: &str = "=?base64?"; +pub const BASE64_HEADER_SUFFIX: &str = "?="; + +/// Reserved headers that must not be overridden by user-supplied custom headers. +/// `MCP-Protocol-Version` is in this list but is allowed through because the worker +/// injects it after initialization. +#[allow(dead_code)] +pub(crate) const RESERVED_HEADERS: &[&str] = &[ + "accept", + HEADER_SESSION_ID, + HEADER_MCP_PROTOCOL_VERSION, // allowed through by validate_custom_header; worker injects it post-init + HEADER_LAST_EVENT_ID, +]; + +/// Checks whether a custom header name is allowed. +/// Returns `Ok(())` if allowed, `Err(name)` if rejected as reserved. +/// `MCP-Protocol-Version` is reserved but allowed through (the worker injects it post-init). +#[cfg(feature = "client-side-sse")] +pub(crate) fn validate_custom_header(name: &http::HeaderName) -> Result<(), String> { + if RESERVED_HEADERS + .iter() + .any(|&r| name.as_str().eq_ignore_ascii_case(r)) + { + if name + .as_str() + .eq_ignore_ascii_case(HEADER_MCP_PROTOCOL_VERSION) + { + return Ok(()); + } + return Err(name.to_string()); + } + Ok(()) +} + +/// Extracts the `scope=` parameter from a `WWW-Authenticate` header value. +/// Handles both quoted (`scope="files:read files:write"`) and unquoted (`scope=read:data`) forms. +#[cfg(feature = "client-side-sse")] +pub(crate) fn extract_scope_from_header(header: &str) -> Option { + let header_lowercase = header.to_ascii_lowercase(); + let scope_key = "scope="; + + if let Some(pos) = header_lowercase.find(scope_key) { + let start = pos + scope_key.len(); + let value_slice = &header[start..]; + + if let Some(stripped) = value_slice.strip_prefix('"') { + if let Some(end_quote) = stripped.find('"') { + return Some(stripped[..end_quote].to_string()); + } + } else { + let end = value_slice + .find(|c: char| c == ',' || c == ';' || c.is_whitespace()) + .unwrap_or(value_slice.len()); + if end > 0 { + return Some(value_slice[..end].to_string()); + } + } + } + + None +} + +#[cfg(test)] +mod tests { + #[cfg(feature = "client-side-sse")] + use super::*; + + #[cfg(feature = "client-side-sse")] + #[test] + fn extract_scope_quoted() { + let header = r#"Bearer error="insufficient_scope", scope="files:read files:write""#; + assert_eq!( + extract_scope_from_header(header), + Some("files:read files:write".to_string()) + ); + } + + #[cfg(feature = "client-side-sse")] + #[test] + fn extract_scope_unquoted() { + let header = r#"Bearer scope=read:data, error="insufficient_scope""#; + assert_eq!( + extract_scope_from_header(header), + Some("read:data".to_string()) + ); + } + + #[cfg(feature = "client-side-sse")] + #[test] + fn extract_scope_missing() { + let header = r#"Bearer error="invalid_token""#; + assert_eq!(extract_scope_from_header(header), None); + } + + #[cfg(feature = "client-side-sse")] + #[test] + fn extract_scope_empty_header() { + assert_eq!(extract_scope_from_header("Bearer"), None); + } + + #[cfg(feature = "client-side-sse")] + #[test] + fn validate_rejects_reserved_accept() { + let name = http::HeaderName::from_static("accept"); + assert!(validate_custom_header(&name).is_err()); + } + + #[cfg(feature = "client-side-sse")] + #[test] + fn validate_rejects_reserved_session_id() { + let name = http::HeaderName::from_static("mcp-session-id"); + assert!(validate_custom_header(&name).is_err()); + } + + #[cfg(feature = "client-side-sse")] + #[test] + fn validate_allows_mcp_protocol_version() { + let name = http::HeaderName::from_static("mcp-protocol-version"); + assert!(validate_custom_header(&name).is_ok()); + } + + #[cfg(feature = "client-side-sse")] + #[test] + fn validate_allows_custom_header() { + let name = http::HeaderName::from_static("x-custom"); + assert!(validate_custom_header(&name).is_ok()); + } +} diff --git a/vendor/rmcp/src/transport/common/mcp_headers.rs b/vendor/rmcp/src/transport/common/mcp_headers.rs new file mode 100644 index 00000000..54e99e53 --- /dev/null +++ b/vendor/rmcp/src/transport/common/mcp_headers.rs @@ -0,0 +1,724 @@ +//! SEP-2243 HTTP header standardization. +//! +//! Builds and validates the `Mcp-Method`, `Mcp-Name`, and `Mcp-Param-*` headers +//! so middle boxes can route Streamable HTTP traffic without parsing the body. +//! All emission/validation is gated by the negotiated protocol version +//! (`>= ProtocolVersion::STANDARD_HEADERS`) at the call sites. + +// Which helpers are reachable depends on the client/server feature combination, +// mirroring `server_side_http`. +#![allow(dead_code)] + +use serde_json::Value; + +use super::http_header::{ + BASE64_HEADER_PREFIX, BASE64_HEADER_SUFFIX, HEADER_MCP_METHOD, HEADER_MCP_NAME, + HEADER_MCP_PARAM_PREFIX, +}; +use crate::model::JsonObject; + +/// Methods whose `Mcp-Name` is sourced from `params.name`. +const NAME_FROM_NAME: &[&str] = &["tools/call", "prompts/get"]; +/// Methods whose `Mcp-Name` is sourced from `params.uri`. +const NAME_FROM_URI: &[&str] = &[ + "resources/read", + "resources/subscribe", + "resources/unsubscribe", +]; +/// Methods whose `Mcp-Name` is sourced from `params.taskId` (SEP-2663 Tasks +/// extension): allows intermediaries to route task polling to the server +/// instance holding the task's state. +const NAME_FROM_TASK_ID: &[&str] = &["tasks/get", "tasks/update", "tasks/cancel"]; + +/// Returns the `Mcp-Name` value for a request, if the method carries one. +fn extract_name(method: &str, params: Option<&Value>) -> Option { + let params = params?; + let key = if NAME_FROM_NAME.contains(&method) { + "name" + } else if NAME_FROM_URI.contains(&method) { + "uri" + } else if NAME_FROM_TASK_ID.contains(&method) { + "taskId" + } else { + return None; + }; + params.get(key)?.as_str().map(str::to_owned) +} + +/// Converts a JSON primitive to its SEP-2243 string form. Non-primitives yield `None`. +fn primitive_to_string(value: &Value) -> Option { + match value { + Value::String(s) => Some(s.clone()), + Value::Bool(b) => Some(b.to_string()), + Value::Number(n) => Some(n.to_string()), + _ => None, + } +} + +/// True if `value` must be Base64-wrapped to survive as an HTTP header value: +/// leading/trailing space or tab, control/non-ASCII characters, or a value that +/// already looks like the `=?base64?...?=` sentinel. +#[cfg(feature = "client-side-sse")] +fn requires_base64(value: &str) -> bool { + if value.is_empty() { + return false; + } + let bytes = value.as_bytes(); + if matches!(bytes.first(), Some(b' ' | b'\t')) || matches!(bytes.last(), Some(b' ' | b'\t')) { + return true; + } + if value + .chars() + .any(|c| (c as u32) < 0x20 || (c as u32) > 0x7E) + { + return true; + } + value.starts_with(BASE64_HEADER_PREFIX) && value.ends_with(BASE64_HEADER_SUFFIX) +} + +/// RFC 9110 §5.6.2 token character. +#[cfg(feature = "client-side-sse")] +fn is_tchar(c: char) -> bool { + c.is_ascii_alphanumeric() + || matches!( + c, + '!' | '#' + | '$' + | '%' + | '&' + | '\'' + | '*' + | '+' + | '-' + | '.' + | '^' + | '_' + | '`' + | '|' + | '~' + ) +} + +/// Top-level properties carrying an `x-mcp-header` annotation, as `(property, header)` pairs. +fn param_header_annotations(input_schema: &JsonObject) -> Vec<(String, String)> { + let mut out = Vec::new(); + if let Some(Value::Object(props)) = input_schema.get("properties") { + for (prop, schema) in props { + if let Some(Value::String(header)) = schema.get("x-mcp-header") + && !header.is_empty() + { + out.push((prop.clone(), header.clone())); + } + } + } + out +} + +/// Validates the `x-mcp-header` annotations in a tool input schema. +/// +/// Annotations must be non-empty RFC 9110 tokens, case-insensitively unique, +/// applied only to top-level primitive (`string`/`integer`/`boolean`) properties. +/// Returns the offending reason on the first violation. +#[cfg(feature = "client-side-sse")] +pub(crate) fn validate_param_header_annotations(input_schema: &JsonObject) -> Result<(), String> { + let Some(Value::Object(props)) = input_schema.get("properties") else { + return Ok(()); + }; + let mut seen = std::collections::HashSet::new(); + for (prop, schema) in props { + reject_nested_annotations(schema, prop)?; + let Some(raw) = schema.get("x-mcp-header") else { + continue; + }; + let Value::String(header) = raw else { + return Err(format!("property `{prop}`: x-mcp-header must be a string")); + }; + if header.is_empty() { + return Err(format!("property `{prop}`: x-mcp-header must not be empty")); + } + if !header.chars().all(is_tchar) { + return Err(format!( + "property `{prop}`: x-mcp-header `{header}` is not a valid HTTP token" + )); + } + if !seen.insert(header.to_ascii_lowercase()) { + return Err(format!( + "property `{prop}`: duplicate x-mcp-header `{header}` (case-insensitive)" + )); + } + match schema.get("type").and_then(Value::as_str) { + Some("string" | "integer" | "boolean") => {} + other => { + return Err(format!( + "property `{prop}`: x-mcp-header requires a primitive type \ + (string/integer/boolean), got {other:?}" + )); + } + } + } + Ok(()) +} + +/// Rejects `x-mcp-header` on nested properties (only top-level promotion is supported). +#[cfg(feature = "client-side-sse")] +fn reject_nested_annotations(schema: &Value, path: &str) -> Result<(), String> { + if let Some(Value::Object(nested)) = schema.get("properties") { + for (key, value) in nested { + if value.get("x-mcp-header").is_some() { + return Err(format!( + "property `{path}.{key}`: x-mcp-header is not supported on nested properties" + )); + } + reject_nested_annotations(value, &format!("{path}.{key}"))?; + } + } + Ok(()) +} + +/// Wraps a value as `=?base64??=` when it cannot travel as a bare header value. +#[cfg(feature = "client-side-sse")] +fn encode_header_value(value: &str) -> String { + use base64::{Engine, prelude::BASE64_STANDARD}; + if requires_base64(value) { + format!( + "{BASE64_HEADER_PREFIX}{}{BASE64_HEADER_SUFFIX}", + BASE64_STANDARD.encode(value) + ) + } else { + value.to_owned() + } +} + +/// Reverses [`encode_header_value`]. Returns `None` if the sentinel wraps invalid Base64/UTF-8. +#[cfg(feature = "server-side-http")] +fn decode_header_value(value: &str) -> Option { + use base64::{Engine, prelude::BASE64_STANDARD}; + match value + .strip_prefix(BASE64_HEADER_PREFIX) + .and_then(|inner| inner.strip_suffix(BASE64_HEADER_SUFFIX)) + { + Some(inner) => { + let bytes = BASE64_STANDARD.decode(inner).ok()?; + String::from_utf8(bytes).ok() + } + None => Some(value.to_owned()), + } +} + +/// Builds the SEP-2243 headers for an outgoing request from its JSON form. +/// +/// `tool_schema` is the cached input schema of the called tool, used to promote +/// annotated `tools/call` arguments to `Mcp-Param-*` headers. +#[cfg(feature = "client-side-sse")] +pub(crate) fn standard_request_headers( + request: &Value, + tool_schema: Option<&JsonObject>, +) -> Vec<(http::HeaderName, http::HeaderValue)> { + use http::{HeaderName, HeaderValue}; + + let mut out = Vec::new(); + let Some(method) = request.get("method").and_then(Value::as_str) else { + return out; + }; + let params = request.get("params"); + + let mut push = |name: &str, value: &str| { + if let (Ok(name), Ok(value)) = ( + HeaderName::from_bytes(name.as_bytes()), + HeaderValue::from_str(value), + ) { + out.push((name, value)); + } + }; + + push(HEADER_MCP_METHOD, method); + if let Some(name) = extract_name(method, params) { + push(HEADER_MCP_NAME, &encode_header_value(&name)); + } + + if method == "tools/call" + && let (Some(schema), Some(arguments)) = + (tool_schema, params.and_then(|p| p.get("arguments"))) + { + for (prop, header) in param_header_annotations(schema) { + let Some(arg) = arguments.get(&prop) else { + continue; + }; + let Some(encoded) = primitive_to_string(arg).map(|s| encode_header_value(&s)) else { + continue; + }; + push(&format!("{HEADER_MCP_PARAM_PREFIX}{header}"), &encoded); + } + } + out +} + +/// Validates incoming SEP-2243 headers against the request body. +/// +/// Returns `Err(reason)` when a required header is missing or its value does not +/// match the body; the caller maps this to a JSON-RPC `-32020` error (HTTP 400). +#[cfg(feature = "server-side-http")] +pub(crate) fn validate_request_headers( + headers: &http::HeaderMap, + request: &Value, + tool_schema: Option<&JsonObject>, +) -> Result<(), String> { + let Some(method) = request.get("method").and_then(Value::as_str) else { + return Ok(()); + }; + let params = request.get("params"); + + match header_str(headers, HEADER_MCP_METHOD)? { + None => return Err("missing required Mcp-Method header".to_owned()), + Some(value) if value != method => { + return Err(format!( + "Mcp-Method header `{value}` does not match body method `{method}`" + )); + } + Some(_) => {} + } + + if let Some(expected) = extract_name(method, params) { + match header_str(headers, HEADER_MCP_NAME)? { + None => return Err(format!("missing required Mcp-Name header for `{method}`")), + Some(raw) => { + let decoded = decode_header_value(raw) + .ok_or_else(|| "Mcp-Name header is not valid Base64".to_owned())?; + if decoded != expected { + return Err(format!( + "Mcp-Name header `{decoded}` does not match body value `{expected}`" + )); + } + } + } + } + + if method == "tools/call" + && let Some(schema) = tool_schema + { + let arguments = params.and_then(|p| p.get("arguments")); + for (prop, header) in param_header_annotations(schema) { + let full = format!("{HEADER_MCP_PARAM_PREFIX}{header}"); + let header_value = header_str(headers, &full)?; + let arg = arguments.and_then(|a| a.get(&prop)); + let body_value = arg.filter(|v| !v.is_null()).and_then(primitive_to_string); + + match (header_value, body_value) { + (None, None) => {} + (Some(_), None) => { + return Err(format!( + "unexpected {full} header for absent or null `{prop}`" + )); + } + (None, Some(_)) => { + return Err(format!("missing {full} header for `{prop}`")); + } + (Some(raw), Some(expected)) => { + let decoded = decode_header_value(raw) + .ok_or_else(|| format!("{full} header is not valid Base64"))?; + if decoded != expected { + return Err(format!( + "{full} header `{decoded}` does not match body value `{expected}`" + )); + } + } + } + } + } + Ok(()) +} + +/// The sole value for `name` as `&str`, if present and valid UTF-8. +/// +/// Errors when `name` appears more than once: these headers are singletons, and +/// letting one through would let an intermediary that resolves duplicates +/// differently route on a value this request never dispatches. +#[cfg(feature = "server-side-http")] +fn header_str<'a>(headers: &'a http::HeaderMap, name: &str) -> Result, String> { + let mut values = headers.get_all(name).iter(); + let Some(value) = values.next() else { + return Ok(None); + }; + if values.next().is_some() { + return Err(format!("duplicate {name} header")); + } + Ok(value.to_str().ok()) +} + +#[cfg(all(test, feature = "client-side-sse", feature = "server-side-http"))] +mod tests { + use std::collections::HashMap; + + use http::{HeaderMap, HeaderName, HeaderValue}; + use serde_json::json; + + use super::*; + + fn schema_with(properties: serde_json::Value) -> JsonObject { + json!({ "type": "object", "properties": properties }) + .as_object() + .unwrap() + .clone() + } + + fn header_map(pairs: &[(&str, &str)]) -> HeaderMap { + let mut map = HeaderMap::new(); + for (name, value) in pairs { + // Append, not insert, so repeated names survive as duplicates. + map.append( + HeaderName::from_bytes(name.as_bytes()).unwrap(), + HeaderValue::from_str(value).unwrap(), + ); + } + map + } + + fn assert_wrapped(value: &str) { + let encoded = encode_header_value(value); + assert!( + encoded.starts_with(BASE64_HEADER_PREFIX), + "expected {value:?} to be Base64-wrapped, got {encoded:?}" + ); + } + + mod encode_header_value { + use super::*; + + #[test] + fn passes_plain_ascii_through() { + assert_eq!(encode_header_value("us-west1"), "us-west1"); + } + + #[test] + fn passes_internal_spaces_through() { + assert_eq!(encode_header_value("a b c"), "a b c"); + } + + #[test] + fn wraps_non_ascii() { + assert_wrapped("café"); + } + + #[test] + fn wraps_leading_whitespace() { + assert_wrapped(" padded"); + } + + #[test] + fn wraps_trailing_whitespace() { + assert_wrapped("trailing "); + } + + #[test] + fn wraps_control_characters() { + assert_wrapped("line1\nline2"); + } + + #[test] + fn wraps_crlf_injection_attempt() { + assert_wrapped("a\r\nEvil: 1"); + } + + #[test] + fn wraps_sentinel_collision() { + assert_wrapped(&format!("{BASE64_HEADER_PREFIX}x{BASE64_HEADER_SUFFIX}")); + } + } + + mod decode_header_value { + use super::*; + + #[test] + fn round_trips_with_encode() { + for value in ["us-west1", "café", " padded ", "line1\nline2", "true", "42"] { + let encoded = encode_header_value(value); + assert_eq!( + decode_header_value(&encoded).as_deref(), + Some(value), + "round-trip failed for {value:?}" + ); + } + } + + #[test] + fn rejects_invalid_base64() { + let bad = format!("{BASE64_HEADER_PREFIX}!!!not-base64!!!{BASE64_HEADER_SUFFIX}"); + assert_eq!(decode_header_value(&bad), None); + } + } + + mod extract_name { + use super::*; + + #[test] + fn from_name_for_tools_call() { + let params = json!({ "name": "my_tool" }); + assert_eq!( + extract_name("tools/call", Some(¶ms)).as_deref(), + Some("my_tool") + ); + } + + #[test] + fn from_name_for_prompts_get() { + let params = json!({ "name": "my_prompt" }); + assert_eq!( + extract_name("prompts/get", Some(¶ms)).as_deref(), + Some("my_prompt") + ); + } + + #[test] + fn from_uri_for_resources_read() { + let params = json!({ "uri": "file:///x" }); + assert_eq!( + extract_name("resources/read", Some(¶ms)).as_deref(), + Some("file:///x") + ); + } + + #[test] + fn none_for_unrelated_method() { + let params = json!({ "name": "my_tool" }); + assert_eq!(extract_name("ping", Some(¶ms)), None); + } + + #[test] + fn none_when_params_absent() { + assert_eq!(extract_name("tools/call", None), None); + } + } + + mod validate_param_header_annotations { + use super::*; + + #[test] + fn accepts_primitive_types() { + let schema = schema_with(json!({ + "region": { "type": "string", "x-mcp-header": "Region" }, + "count": { "type": "integer", "x-mcp-header": "Count" }, + "flag": { "type": "boolean", "x-mcp-header": "Flag" }, + })); + assert!(validate_param_header_annotations(&schema).is_ok()); + } + + #[test] + fn rejects_number_type() { + let schema = schema_with(json!({ "n": { "type": "number", "x-mcp-header": "N" } })); + assert!(validate_param_header_annotations(&schema).is_err()); + } + + #[test] + fn rejects_complex_type() { + let schema = schema_with(json!({ "a": { "type": "array", "x-mcp-header": "A" } })); + assert!(validate_param_header_annotations(&schema).is_err()); + } + + #[test] + fn rejects_empty_header_name() { + let schema = schema_with(json!({ "r": { "type": "string", "x-mcp-header": "" } })); + assert!(validate_param_header_annotations(&schema).is_err()); + } + + #[test] + fn rejects_non_token_header_name() { + let schema = + schema_with(json!({ "r": { "type": "string", "x-mcp-header": "bad:name" } })); + assert!(validate_param_header_annotations(&schema).is_err()); + } + + #[test] + fn rejects_case_insensitive_duplicate() { + let schema = schema_with(json!({ + "a": { "type": "string", "x-mcp-header": "Region" }, + "b": { "type": "string", "x-mcp-header": "region" }, + })); + assert!(validate_param_header_annotations(&schema).is_err()); + } + + #[test] + fn rejects_nested_annotation() { + let schema = schema_with(json!({ + "outer": { + "type": "object", + "properties": { "inner": { "type": "string", "x-mcp-header": "Inner" } } + } + })); + assert!(validate_param_header_annotations(&schema).is_err()); + } + } + + mod standard_request_headers { + use super::*; + + fn tools_call_headers() -> HashMap { + let schema = schema_with(json!({ + "region": { "type": "string", "x-mcp-header": "Region" }, + })); + let request = json!({ + "jsonrpc": "2.0", "id": 1, "method": "tools/call", + "params": { "name": "deploy", "arguments": { "region": "us-west1" } } + }); + super::super::standard_request_headers(&request, Some(&schema)) + .into_iter() + .map(|(name, value)| (name.as_str().to_owned(), value.to_str().unwrap().to_owned())) + .collect() + } + + #[test] + fn sets_method_header() { + assert_eq!( + tools_call_headers().get("mcp-method").map(String::as_str), + Some("tools/call") + ); + } + + #[test] + fn sets_name_header() { + assert_eq!( + tools_call_headers().get("mcp-name").map(String::as_str), + Some("deploy") + ); + } + + #[test] + fn sets_annotated_param_header() { + assert_eq!( + tools_call_headers() + .get("mcp-param-region") + .map(String::as_str), + Some("us-west1") + ); + } + } + + mod validate_request_headers { + use super::*; + + fn tools_call_request() -> Value { + json!({ + "jsonrpc": "2.0", "id": 1, "method": "tools/call", + "params": { "name": "deploy" } + }) + } + + #[test] + fn accepts_matching_method_and_name() { + let headers = header_map(&[("Mcp-Method", "tools/call"), ("Mcp-Name", "deploy")]); + assert!(validate_request_headers(&headers, &tools_call_request(), None).is_ok()); + } + + #[test] + fn rejects_method_mismatch() { + let headers = header_map(&[("Mcp-Method", "tools/list"), ("Mcp-Name", "deploy")]); + assert!(validate_request_headers(&headers, &tools_call_request(), None).is_err()); + } + + #[test] + fn rejects_missing_method() { + let headers = header_map(&[("Mcp-Name", "deploy")]); + assert!(validate_request_headers(&headers, &tools_call_request(), None).is_err()); + } + + #[test] + fn rejects_name_mismatch() { + let headers = header_map(&[("Mcp-Method", "tools/call"), ("Mcp-Name", "other")]); + assert!(validate_request_headers(&headers, &tools_call_request(), None).is_err()); + } + + #[test] + fn rejects_missing_name() { + let headers = header_map(&[("Mcp-Method", "tools/call")]); + assert!(validate_request_headers(&headers, &tools_call_request(), None).is_err()); + } + + #[test] + fn rejects_duplicate_method() { + let headers = header_map(&[ + ("Mcp-Method", "tools/call"), + ("Mcp-Method", "tools/list"), + ("Mcp-Name", "deploy"), + ]); + assert!(validate_request_headers(&headers, &tools_call_request(), None).is_err()); + } + + #[test] + fn rejects_duplicate_name() { + let headers = header_map(&[ + ("Mcp-Method", "tools/call"), + ("Mcp-Name", "deploy"), + ("Mcp-Name", "other"), + ]); + assert!(validate_request_headers(&headers, &tools_call_request(), None).is_err()); + } + + #[test] + fn accepts_matching_param() { + let schema = schema_with(json!({ + "region": { "type": "string", "x-mcp-header": "Region" }, + })); + let request = json!({ + "jsonrpc": "2.0", "id": 1, "method": "tools/call", + "params": { "name": "deploy", "arguments": { "region": "us-west1" } } + }); + let headers = header_map(&[ + ("Mcp-Method", "tools/call"), + ("Mcp-Name", "deploy"), + ("Mcp-Param-Region", "us-west1"), + ]); + assert!(validate_request_headers(&headers, &request, Some(&schema)).is_ok()); + } + + #[test] + fn rejects_param_mismatch() { + let schema = schema_with(json!({ + "region": { "type": "string", "x-mcp-header": "Region" }, + })); + let request = json!({ + "jsonrpc": "2.0", "id": 1, "method": "tools/call", + "params": { "name": "deploy", "arguments": { "region": "us-west1" } } + }); + let headers = header_map(&[ + ("Mcp-Method", "tools/call"), + ("Mcp-Name", "deploy"), + ("Mcp-Param-Region", "eu-central1"), + ]); + assert!(validate_request_headers(&headers, &request, Some(&schema)).is_err()); + } + + #[test] + fn rejects_duplicate_param() { + let schema = schema_with(json!({ + "region": { "type": "string", "x-mcp-header": "Region" }, + })); + let request = json!({ + "jsonrpc": "2.0", "id": 1, "method": "tools/call", + "params": { "name": "deploy", "arguments": { "region": "us-west1" } } + }); + let headers = header_map(&[ + ("Mcp-Method", "tools/call"), + ("Mcp-Name", "deploy"), + ("Mcp-Param-Region", "us-west1"), + ("Mcp-Param-Region", "eu-central1"), + ]); + assert!(validate_request_headers(&headers, &request, Some(&schema)).is_err()); + } + + #[test] + fn rejects_duplicate_param_for_absent_argument() { + let schema = schema_with(json!({ + "region": { "type": "string", "x-mcp-header": "Region" }, + })); + let headers = header_map(&[ + ("Mcp-Method", "tools/call"), + ("Mcp-Name", "deploy"), + ("Mcp-Param-Region", "us-west1"), + ("Mcp-Param-Region", "eu-central1"), + ]); + assert_eq!( + validate_request_headers(&headers, &tools_call_request(), Some(&schema)), + Err("duplicate Mcp-Param-Region header".to_owned()) + ); + } + } +} diff --git a/vendor/rmcp/src/transport/common/reqwest.rs b/vendor/rmcp/src/transport/common/reqwest.rs new file mode 100644 index 00000000..42075921 --- /dev/null +++ b/vendor/rmcp/src/transport/common/reqwest.rs @@ -0,0 +1,2 @@ +#[cfg(feature = "transport-streamable-http-client-reqwest")] +mod streamable_http_client; diff --git a/vendor/rmcp/src/transport/common/reqwest/streamable_http_client.rs b/vendor/rmcp/src/transport/common/reqwest/streamable_http_client.rs new file mode 100644 index 00000000..5ebe8fa6 --- /dev/null +++ b/vendor/rmcp/src/transport/common/reqwest/streamable_http_client.rs @@ -0,0 +1,643 @@ +use std::{borrow::Cow, collections::HashMap, sync::Arc}; + +use futures::stream::BoxStream; +use http::{HeaderName, HeaderValue, header::WWW_AUTHENTICATE}; +use reqwest::header::ACCEPT; +use sse_stream::Sse; + +use crate::{ + model::{ClientJsonRpcMessage, JsonRpcMessage, ServerJsonRpcMessage}, + transport::{ + common::{ + client_side_sse::{DEFAULT_MAX_SSE_EVENT_SIZE, bounded_sse_stream}, + http_header::{ + EVENT_STREAM_MIME_TYPE, HEADER_LAST_EVENT_ID, HEADER_SESSION_ID, JSON_MIME_TYPE, + extract_scope_from_header, validate_custom_header, + }, + }, + streamable_http_client::*, + }, +}; + +impl From for StreamableHttpError { + fn from(e: reqwest::Error) -> Self { + StreamableHttpError::Client(e) + } +} + +/// Applies custom headers to a request builder, rejecting reserved headers. +fn apply_custom_headers( + mut builder: reqwest::RequestBuilder, + custom_headers: HashMap, +) -> Result> { + for (name, value) in custom_headers { + validate_custom_header(&name).map_err(StreamableHttpError::ReservedHeaderConflict)?; + builder = builder.header(name, value); + } + Ok(builder) +} + +/// Attempts to parse `body` as a JSON-RPC error message. +/// Returns `None` if the body is not parseable or is not a `JsonRpcMessage::Error`. +fn parse_json_rpc_error(body: &str) -> Option { + match serde_json::from_str::(body) { + Ok(message @ JsonRpcMessage::Error(_)) => Some(message), + _ => None, + } +} + +impl StreamableHttpClient for reqwest::Client { + type Error = reqwest::Error; + + async fn get_stream( + &self, + uri: Arc, + session_id: Option>, + last_event_id: Option, + auth_token: Option, + custom_headers: HashMap, + ) -> Result>, StreamableHttpError> { + self.get_stream_with_max_sse_event_size( + uri, + session_id, + last_event_id, + auth_token, + custom_headers, + DEFAULT_MAX_SSE_EVENT_SIZE, + ) + .await + } + + async fn get_stream_with_max_sse_event_size( + &self, + uri: Arc, + session_id: Option>, + last_event_id: Option, + auth_token: Option, + custom_headers: HashMap, + max_sse_event_size: usize, + ) -> Result>, StreamableHttpError> { + let mut request_builder = self + .get(uri.as_ref()) + .header(ACCEPT, [EVENT_STREAM_MIME_TYPE, JSON_MIME_TYPE].join(", ")); + if let Some(session_id) = session_id { + request_builder = request_builder.header(HEADER_SESSION_ID, session_id.as_ref()); + } + if let Some(last_event_id) = last_event_id { + request_builder = request_builder.header(HEADER_LAST_EVENT_ID, last_event_id); + } + if let Some(auth_header) = auth_token { + request_builder = request_builder.bearer_auth(auth_header); + } + request_builder = apply_custom_headers(request_builder, custom_headers)?; + let response = request_builder.send().await?; + if response.status() == reqwest::StatusCode::METHOD_NOT_ALLOWED { + return Err(StreamableHttpError::ServerDoesNotSupportSse); + } + if response.status() == reqwest::StatusCode::UNAUTHORIZED + && let Some(header) = response.headers().get(WWW_AUTHENTICATE) + { + let header = header + .to_str() + .map_err(|_| { + StreamableHttpError::UnexpectedServerResponse(Cow::from( + "invalid www-authenticate header value", + )) + })? + .to_string(); + return Err(StreamableHttpError::AuthRequired(AuthRequiredError { + www_authenticate_header: header, + })); + } + if response.status() == reqwest::StatusCode::FORBIDDEN + && let Some(header) = response.headers().get(WWW_AUTHENTICATE) + { + let header_str = header.to_str().map_err(|_| { + StreamableHttpError::UnexpectedServerResponse(Cow::from( + "invalid www-authenticate header value", + )) + })?; + let scope = extract_scope_from_header(header_str); + return Err(StreamableHttpError::InsufficientScope( + InsufficientScopeError { + www_authenticate_header: header_str.to_string(), + required_scope: scope, + }, + )); + } + let response = response.error_for_status()?; + match response.headers().get(reqwest::header::CONTENT_TYPE) { + Some(ct) => { + if !ct.as_bytes().starts_with(EVENT_STREAM_MIME_TYPE.as_bytes()) + && !ct.as_bytes().starts_with(JSON_MIME_TYPE.as_bytes()) + { + return Err(StreamableHttpError::UnexpectedContentType(Some( + String::from_utf8_lossy(ct.as_bytes()).to_string(), + ))); + } + } + None => { + return Err(StreamableHttpError::UnexpectedContentType(None)); + } + } + let event_stream = bounded_sse_stream(response.bytes_stream(), max_sse_event_size); + Ok(event_stream) + } + + async fn delete_session( + &self, + uri: Arc, + session: Arc, + auth_token: Option, + custom_headers: HashMap, + ) -> Result<(), StreamableHttpError> { + let mut request_builder = self.delete(uri.as_ref()); + if let Some(auth_header) = auth_token { + request_builder = request_builder.bearer_auth(auth_header); + } + request_builder = request_builder.header(HEADER_SESSION_ID, session.as_ref()); + request_builder = apply_custom_headers(request_builder, custom_headers)?; + let response = request_builder.send().await?; + + // if method no allowed + if response.status() == reqwest::StatusCode::METHOD_NOT_ALLOWED { + tracing::debug!("this server doesn't support deleting session"); + return Ok(()); + } + let _response = response.error_for_status()?; + Ok(()) + } + + async fn post_message( + &self, + uri: Arc, + message: ClientJsonRpcMessage, + session_id: Option>, + auth_token: Option, + custom_headers: HashMap, + ) -> Result> { + self.post_message_with_max_sse_event_size( + uri, + message, + session_id, + auth_token, + custom_headers, + DEFAULT_MAX_SSE_EVENT_SIZE, + ) + .await + } + + async fn post_message_with_max_sse_event_size( + &self, + uri: Arc, + message: ClientJsonRpcMessage, + session_id: Option>, + auth_token: Option, + custom_headers: HashMap, + max_sse_event_size: usize, + ) -> Result> { + let mut request = self + .post(uri.as_ref()) + .header(ACCEPT, [EVENT_STREAM_MIME_TYPE, JSON_MIME_TYPE].join(", ")); + if let Some(auth_header) = auth_token { + request = request.bearer_auth(auth_header); + } + + request = apply_custom_headers(request, custom_headers)?; + let session_was_attached = session_id.is_some(); + if let Some(session_id) = session_id { + request = request.header(HEADER_SESSION_ID, session_id.as_ref()); + } + let response = request.json(&message).send().await?; + if response.status() == reqwest::StatusCode::UNAUTHORIZED + && let Some(header) = response.headers().get(WWW_AUTHENTICATE) + { + let header = header + .to_str() + .map_err(|_| { + StreamableHttpError::UnexpectedServerResponse(Cow::from( + "invalid www-authenticate header value", + )) + })? + .to_string(); + return Err(StreamableHttpError::AuthRequired(AuthRequiredError { + www_authenticate_header: header, + })); + } + if response.status() == reqwest::StatusCode::FORBIDDEN + && let Some(header) = response.headers().get(WWW_AUTHENTICATE) + { + let header_str = header.to_str().map_err(|_| { + StreamableHttpError::UnexpectedServerResponse(Cow::from( + "invalid www-authenticate header value", + )) + })?; + let scope = extract_scope_from_header(header_str); + return Err(StreamableHttpError::InsufficientScope( + InsufficientScopeError { + www_authenticate_header: header_str.to_string(), + required_scope: scope, + }, + )); + } + let status = response.status(); + if matches!( + status, + reqwest::StatusCode::ACCEPTED | reqwest::StatusCode::NO_CONTENT + ) { + return Ok(StreamableHttpPostResponse::Accepted); + } + if status == reqwest::StatusCode::NOT_FOUND && session_was_attached { + return Err(StreamableHttpError::SessionExpired); + } + let content_type = response + .headers() + .get(reqwest::header::CONTENT_TYPE) + .map(|ct| String::from_utf8_lossy(ct.as_bytes()).to_string()); + let content_length = response.content_length(); + let session_id = response + .headers() + .get(HEADER_SESSION_ID) + .and_then(|v| v.to_str().ok()) + .map(|s| s.to_string()); + // Spec requires 202 Accepted for these, but some servers return an empty 200. + // Treat empty success responses as equivalent to Accepted. + if status.is_success() + && content_length == Some(0) + && matches!( + message, + ClientJsonRpcMessage::Notification(_) + | ClientJsonRpcMessage::Response(_) + | ClientJsonRpcMessage::Error(_) + ) + { + return Ok(StreamableHttpPostResponse::Accepted); + } + // Non-success responses may carry valid JSON-RPC error payloads that + // should be surfaced as McpError rather than lost in TransportSend. + if !status.is_success() { + let body = response + .text() + .await + .unwrap_or_else(|_| "".to_owned()); + // Must precede the JSON-RPC branch below, which would forward a + // discover rejection with an id the lifecycle cannot correlate. + if let Some(response) = + legacy_discover_response(&message, session_was_attached, status, &body) + { + return Ok(response); + } + if content_type + .as_deref() + .is_some_and(|ct| ct.as_bytes().starts_with(JSON_MIME_TYPE.as_bytes())) + { + match parse_json_rpc_error(&body) { + Some(message) => { + return Ok(StreamableHttpPostResponse::Json(message, session_id)); + } + None => tracing::warn!( + "HTTP {status}: could not parse JSON body as a JSON-RPC error" + ), + } + } + return Err(StreamableHttpError::UnexpectedServerResponse(Cow::Owned( + format!("HTTP {status}: {body}"), + ))); + } + match content_type.as_deref() { + Some(ct) if ct.as_bytes().starts_with(EVENT_STREAM_MIME_TYPE.as_bytes()) => { + let event_stream = bounded_sse_stream(response.bytes_stream(), max_sse_event_size); + Ok(StreamableHttpPostResponse::Sse(event_stream, session_id)) + } + Some(ct) if ct.as_bytes().starts_with(JSON_MIME_TYPE.as_bytes()) => { + // A notification/response/error POST does not await a JSON-RPC + // reply. Treat an unusable JSON body as Accepted. A request + // still needs a reply; the same body is an error so the worker + // does not wait on SSE forever. + let body = response.bytes().await?; + match serde_json::from_slice::(&body) { + Ok(parsed) => Ok(StreamableHttpPostResponse::Json(parsed, session_id)), + Err(e) + if matches!( + message, + ClientJsonRpcMessage::Notification(_) + | ClientJsonRpcMessage::Response(_) + | ClientJsonRpcMessage::Error(_) + ) => + { + tracing::warn!( + "could not parse JSON response as ServerJsonRpcMessage, treating as accepted: {e}" + ); + Ok(StreamableHttpPostResponse::Accepted) + } + Err(e) => Err(StreamableHttpError::UnexpectedServerResponse(Cow::Owned( + json_rpc_parse_error_message(&e, &body), + ))), + } + } + _ => { + // unexpected content type + tracing::error!("unexpected content type: {:?}", content_type); + Err(StreamableHttpError::UnexpectedContentType(content_type)) + } + } + } +} + +impl StreamableHttpClientTransport { + /// Creates a new transport using reqwest with the specified URI. + /// + /// This is a convenience method that creates a transport using the default + /// reqwest client. This method is only available when the + /// `transport-streamable-http-client-reqwest` feature is enabled. + /// + /// # Arguments + /// + /// * `uri` - The server URI to connect to + /// + /// # Example + /// + /// ```rust,no_run + /// use rmcp::transport::StreamableHttpClientTransport; + /// + /// // Enable the reqwest feature in Cargo.toml: + /// // rmcp = { version = "0.5", features = ["transport-streamable-http-client-reqwest"] } + /// + /// let transport = StreamableHttpClientTransport::from_uri("http://localhost:8000/mcp"); + /// ``` + /// + /// # Feature requirement + /// + /// This method requires the `transport-streamable-http-client-reqwest` feature. + pub fn from_uri(uri: impl Into>) -> Self { + StreamableHttpClientTransport::with_client( + Self::default_http_client(), + StreamableHttpClientTransportConfig { + uri: uri.into(), + auth_header: None, + ..Default::default() + }, + ) + } + + /// Build this transport form a config + /// + /// # Arguments + /// + /// * `config` - The config to use with this transport + pub fn from_config(config: StreamableHttpClientTransportConfig) -> Self { + StreamableHttpClientTransport::with_client(Self::default_http_client(), config) + } + + /// Build the default reqwest client for this transport. + /// + /// Disables idle connection pooling to avoid ~40 ms stalls caused by + /// TCP Delayed ACK on Linux when the previous response body was not + /// fully consumed before the pool attempts to reuse the connection. + /// + /// Automatic redirects are disabled so caller-supplied custom headers + /// cannot be replayed to a redirect target. + fn default_http_client() -> reqwest::Client { + reqwest::Client::builder() + .pool_max_idle_per_host(0) + .redirect(reqwest::redirect::Policy::none()) + .build() + .expect("failed to build default reqwest client") + } +} + +#[cfg(test)] +mod tests { + use rstest::rstest; + + use super::parse_json_rpc_error; + use crate::{ + model::{ClientJsonRpcMessage, ClientRequest, JsonRpcMessage, PingRequest, RequestId}, + transport::streamable_http_client::{AuthRequiredError, InsufficientScopeError}, + }; + + #[test] + fn auth_required_error_new() { + let err = AuthRequiredError::new("Bearer realm=\"test\"".to_string()); + assert_eq!(err.www_authenticate_header, "Bearer realm=\"test\""); + } + + #[test] + fn insufficient_scope_error_can_upgrade() { + let with_scope = InsufficientScopeError::new( + "Bearer scope=\"admin\"".to_string(), + Some("admin".to_string()), + ); + assert!(with_scope.can_upgrade()); + assert_eq!(with_scope.get_required_scope(), Some("admin")); + + let without_scope = + InsufficientScopeError::new("Bearer error=\"insufficient_scope\"".to_string(), None); + assert!(!without_scope.can_upgrade()); + assert_eq!(without_scope.get_required_scope(), None); + } + + #[test] + fn parse_json_rpc_error_returns_error_variant() { + let body = + r#"{"jsonrpc":"2.0","id":1,"error":{"code":-32600,"message":"Invalid Request"}}"#; + assert!(matches!( + parse_json_rpc_error(body), + Some(JsonRpcMessage::Error(_)) + )); + } + + #[rstest] + #[case::non_error_request(r#"{"jsonrpc":"2.0","id":1,"method":"ping"}"#)] + #[case::notification( + r#"{"jsonrpc":"2.0","method":"notifications/cancelled","params":{"requestId":1}}"# + )] + #[case::plain_text("not json at all")] + #[case::empty("")] + #[case::truncated_json(r#"{"broken":"#)] + fn parse_json_rpc_error_rejects_non_error_bodies(#[case] body: &str) { + assert!(parse_json_rpc_error(body).is_none()); + } + + #[tokio::test] + async fn post_sse_response_honors_configured_event_limit() -> anyhow::Result<()> { + use std::{collections::HashMap, net::SocketAddr, sync::Arc}; + + use axum::{Router, routing::post}; + use futures::StreamExt; + + use crate::transport::streamable_http_client::{ + StreamableHttpClient, StreamableHttpPostResponse, + }; + + let listener = tokio::net::TcpListener::bind(SocketAddr::from(([127, 0, 0, 1], 0))).await?; + let addr = listener.local_addr()?; + let server = tokio::spawn(async move { + let app = Router::new().route( + "/mcp", + post(|| async { + ( + [(http::header::CONTENT_TYPE, "text/event-stream")], + "data: this event is too large\n", + ) + }), + ); + axum::serve(listener, app).await + }); + let message = ClientJsonRpcMessage::request( + ClientRequest::PingRequest(PingRequest::default()), + RequestId::Number(1), + ); + let client = reqwest::Client::new(); + + let response = client + .post_message_with_max_sse_event_size( + Arc::::from(format!("http://{addr}/mcp")), + message, + None, + None, + HashMap::new(), + 16, + ) + .await?; + let StreamableHttpPostResponse::Sse(mut stream, _) = response else { + anyhow::bail!("expected SSE response"); + }; + let error = stream.next().await.unwrap().unwrap_err(); + + server.abort(); + assert!(error.to_string().contains("maximum size of 16 bytes")); + Ok(()) + } + + #[tokio::test] + async fn default_http_client_does_not_leak_custom_headers_to_redirect_target() + -> anyhow::Result<()> { + use std::{collections::HashMap, net::SocketAddr, sync::Arc}; + + use axum::{ + Router, extract::State, http::StatusCode, response::IntoResponse, routing::post, + }; + use http::{HeaderMap, HeaderName, HeaderValue, header::LOCATION}; + use tokio::sync::Mutex; + + use super::StreamableHttpClientTransport; + use crate::transport::streamable_http_client::{StreamableHttpClient, StreamableHttpError}; + + const API_KEY_HEADER: &str = "x-api-key"; + const API_KEY_VALUE: &str = "secret"; + + type CapturedHeader = Arc>>; + + #[derive(Clone)] + struct RedirectState { + location: String, + captured_header: CapturedHeader, + } + + async fn capture_api_key_header(headers: &HeaderMap, captured_header: &CapturedHeader) { + if let Some(value) = headers + .get(API_KEY_HEADER) + .and_then(|value| value.to_str().ok()) + { + *captured_header.lock().await = Some(value.to_owned()); + } + } + + async fn redirect_handler( + State(state): State, + headers: HeaderMap, + ) -> impl IntoResponse { + capture_api_key_header(&headers, &state.captured_header).await; + + ( + StatusCode::TEMPORARY_REDIRECT, + [(LOCATION, state.location)], + "", + ) + } + + async fn redirected_handler( + State(captured_header): State, + headers: HeaderMap, + ) -> impl IntoResponse { + capture_api_key_header(&headers, &captured_header).await; + + ( + StatusCode::OK, + [(http::header::CONTENT_TYPE, "application/json")], + r#"{"jsonrpc":"2.0","id":1,"result":{}}"#, + ) + } + + let redirected_header = Arc::new(Mutex::new(None)); + let redirected_listener = + tokio::net::TcpListener::bind(SocketAddr::from(([127, 0, 0, 1], 0))).await?; + let redirected_addr = redirected_listener.local_addr()?; + let redirected_server = tokio::spawn({ + let redirected_header = redirected_header.clone(); + async move { + let app = Router::new() + .route("/capture", post(redirected_handler)) + .with_state(redirected_header); + axum::serve(redirected_listener, app).await + } + }); + + let original_header = Arc::new(Mutex::new(None)); + let redirect_listener = + tokio::net::TcpListener::bind(SocketAddr::from(([127, 0, 0, 1], 0))).await?; + let redirect_addr = redirect_listener.local_addr()?; + let redirect_server = tokio::spawn({ + let state = RedirectState { + location: format!("http://{redirected_addr}/capture"), + captured_header: original_header.clone(), + }; + async move { + let app = Router::new() + .route("/mcp", post(redirect_handler)) + .with_state(state); + axum::serve(redirect_listener, app).await + } + }); + + let mut custom_headers = HashMap::new(); + custom_headers.insert( + HeaderName::from_static(API_KEY_HEADER), + HeaderValue::from_static(API_KEY_VALUE), + ); + let message = ClientJsonRpcMessage::request( + ClientRequest::PingRequest(PingRequest::default()), + RequestId::Number(1), + ); + + let client = StreamableHttpClientTransport::::default_http_client(); + let result = client + .post_message( + Arc::::from(format!("http://{redirect_addr}/mcp")), + message, + None, + None, + custom_headers, + ) + .await; + + assert!( + matches!( + result, + Err(StreamableHttpError::UnexpectedServerResponse(_)) + ), + "redirect response should be returned to the transport, got {result:?}" + ); + assert_eq!(original_header.lock().await.as_deref(), Some(API_KEY_VALUE)); + assert!( + redirected_header.lock().await.is_none(), + "custom headers should not be sent to redirect targets" + ); + + redirect_server.abort(); + redirected_server.abort(); + + Ok(()) + } +} diff --git a/vendor/rmcp/src/transport/common/server_side_http.rs b/vendor/rmcp/src/transport/common/server_side_http.rs new file mode 100644 index 00000000..09df6d28 --- /dev/null +++ b/vendor/rmcp/src/transport/common/server_side_http.rs @@ -0,0 +1,378 @@ +#![allow(dead_code)] +use std::{convert::Infallible, fmt::Display, sync::Arc, time::Duration}; + +use bytes::{Buf, Bytes}; +use http::Response; +use http_body::Body; +use http_body_util::{BodyExt, Empty, Full, combinators::BoxBody}; +use sse_stream::{KeepAlive, Sse, SseBody}; +use tokio_util::sync::{CancellationToken, DropGuard}; + +use super::http_header::EVENT_STREAM_MIME_TYPE; +use crate::model::{ClientJsonRpcMessage, ServerJsonRpcMessage}; + +pub type SessionId = Arc; + +pub fn session_id() -> SessionId { + uuid::Uuid::new_v4().to_string().into() +} + +pub const DEFAULT_AUTO_PING_INTERVAL: Duration = Duration::from_secs(15); + +pub(crate) type BoxResponse = Response>; + +pub(crate) fn accepted_response() -> Response> { + Response::builder() + .status(http::StatusCode::ACCEPTED) + .body(Empty::new().boxed()) + .expect("valid response") +} +pin_project_lite::pin_project! { + struct TokioTimer { + #[pin] + sleep: tokio::time::Sleep, + } +} +impl Future for TokioTimer { + type Output = (); + + fn poll( + self: std::pin::Pin<&mut Self>, + cx: &mut std::task::Context<'_>, + ) -> std::task::Poll { + let this = self.project(); + this.sleep.poll(cx) + } +} +impl sse_stream::Timer for TokioTimer { + fn from_duration(duration: Duration) -> Self { + Self { + sleep: tokio::time::sleep(duration), + } + } + + fn reset(self: std::pin::Pin<&mut Self>, when: std::time::Instant) { + let this = self.project(); + this.sleep.reset(tokio::time::Instant::from_std(when)); + } +} + +pin_project_lite::pin_project! { + struct CancelOnDropStream { + #[pin] + inner: S, + _drop_guard: DropGuard, + } +} + +impl futures::Stream for CancelOnDropStream { + type Item = S::Item; + + fn poll_next( + self: std::pin::Pin<&mut Self>, + cx: &mut std::task::Context<'_>, + ) -> std::task::Poll> { + self.project().inner.poll_next(cx) + } +} + +#[derive(Debug, Clone, Default)] +#[non_exhaustive] +pub struct ServerSseMessage { + /// The event ID for this message. When set, clients can use this ID + /// with the `Last-Event-ID` header to resume the stream from this point. + pub event_id: Option, + /// The JSON-RPC message content. Set to `None` for priming events. + /// See [SEP-1699](https://github.com/modelcontextprotocol/modelcontextprotocol/issues/1699) + pub message: Option>, + /// The retry interval hint for clients. Clients should wait this duration + /// before attempting to reconnect. This maps to the SSE `retry:` field. + pub retry: Option, +} + +impl ServerSseMessage { + /// Create a message carrying a JSON-RPC response/notification with an event ID. + pub fn new(event_id: impl Into, message: ServerJsonRpcMessage) -> Self { + Self { + event_id: Some(event_id.into()), + message: Some(Arc::new(message)), + retry: None, + } + } + + /// Wrap a JSON-RPC message without an event ID or retry hint. + pub fn from_message(message: ServerJsonRpcMessage) -> Self { + Self { + event_id: None, + message: Some(Arc::new(message)), + retry: None, + } + } + + /// Create a priming event that tells the client to reconnect after `retry` + /// if the connection drops. + /// See [SEP-1699](https://github.com/modelcontextprotocol/modelcontextprotocol/issues/1699). + pub fn priming(event_id: impl Into, retry: Duration) -> Self { + Self { + event_id: Some(event_id.into()), + message: None, + retry: Some(retry), + } + } + + /// Create a retry hint without changing the client's last event ID. + pub fn retry(retry: Duration) -> Self { + Self { + event_id: None, + message: None, + retry: Some(retry), + } + } +} + +pub(crate) fn sse_stream_response( + stream: impl futures::Stream + Send + Sync + 'static, + keep_alive: Option, + ct: CancellationToken, +) -> Response> { + use futures::StreamExt; + let cancelled = ct.clone(); + let stream = stream + .map(|message| { + let mut sse = if let Some(ref msg) = message.message { + let data = serde_json::to_string(msg.as_ref()).expect("valid message"); + Sse::default().data(data) + } else { + // Priming event: empty data per SEP-1699 (just "data:\n") + Sse::default().data("") + }; + + sse.id = message.event_id; + + if let Some(retry) = message.retry { + sse.retry = Some(retry.as_millis() as u64); + } + + Result::::Ok(sse) + }) + .take_until(async move { cancelled.cancelled().await }); + let stream = CancelOnDropStream { + inner: stream, + _drop_guard: ct.drop_guard(), + }; + let stream = SseBody::new(stream); + + let stream = match keep_alive { + Some(duration) => stream + .with_keep_alive::(KeepAlive::new().interval(duration)) + .boxed(), + None => stream.boxed(), + }; + + Response::builder() + .status(http::StatusCode::OK) + .header(http::header::CONTENT_TYPE, EVENT_STREAM_MIME_TYPE) + .header(http::header::CACHE_CONTROL, "no-cache") + .header("X-Accel-Buffering", "no") + .body(stream) + .expect("valid response") +} + +pub(crate) const fn internal_error_response( + context: &str, +) -> impl FnOnce(E) -> Response> { + move |error| { + tracing::error!("Internal server error when {context}: {error}"); + Response::builder() + .status(http::StatusCode::INTERNAL_SERVER_ERROR) + .body( + Full::new(Bytes::from(format!( + "Encounter an error when {context}: {error}" + ))) + .boxed(), + ) + .expect("valid response") + } +} + +pub(crate) fn unexpected_message_response(expect: &str) -> Response> { + Response::builder() + .status(http::StatusCode::UNPROCESSABLE_ENTITY) + .body(Full::new(Bytes::from(format!("Unexpected message, expect {expect}"))).boxed()) + .expect("valid response") +} + +pub(crate) async fn expect_json( + body: B, + max_bytes: usize, +) -> Result>> +where + B: Body + Send + 'static, + B::Error: Display, +{ + let mut collected = bytes::BytesMut::new(); + let mut body = std::pin::pin!(body); + loop { + let frame = futures::future::poll_fn(|cx| body.as_mut().poll_frame(cx)).await; + match frame { + None => break, + Some(Ok(frame)) => { + let Ok(mut data) = frame.into_data() else { + continue; + }; + if data.remaining() > max_bytes.saturating_sub(collected.len()) { + let response = Response::builder() + .status(http::StatusCode::PAYLOAD_TOO_LARGE) + .body( + Full::new(Bytes::from(format!( + "Payload Too Large: request body exceeds {max_bytes} bytes" + ))) + .boxed(), + ) + .expect("valid response"); + return Err(response); + } + while data.has_remaining() { + let chunk = data.chunk(); + let chunk_len = chunk.len(); + collected.extend_from_slice(chunk); + data.advance(chunk_len); + } + } + Some(Err(e)) => { + let response = Response::builder() + .status(http::StatusCode::INTERNAL_SERVER_ERROR) + .body( + Full::new(Bytes::from(format!("Failed to read request body: {e}"))).boxed(), + ) + .expect("valid response"); + return Err(response); + } + } + } + + match serde_json::from_slice::(&collected) { + Ok(message) => Ok(message), + Err(e) => { + let response = Response::builder() + .status(http::StatusCode::UNSUPPORTED_MEDIA_TYPE) + .body( + Full::new(Bytes::from(format!("fail to deserialize request body {e}"))).boxed(), + ) + .expect("valid response"); + Err(response) + } + } +} + +#[cfg(test)] +mod tests { + use std::convert::Infallible; + + use futures::stream; + use http_body::Frame; + use http_body_util::StreamBody; + + use super::*; + use crate::model::{EmptyResult, JsonRpcResponse, JsonRpcVersion2_0, RequestId, ServerResult}; + + const INITIALIZE_REQUEST: &str = r#"{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-03-26","capabilities":{},"clientInfo":{"name":"test","version":"0.1"}}}"#; + + fn dummy_message() -> ServerJsonRpcMessage { + ServerJsonRpcMessage::Response(JsonRpcResponse { + jsonrpc: JsonRpcVersion2_0, + id: RequestId::Number(1), + result: ServerResult::EmptyResult(EmptyResult {}), + }) + } + + #[test] + fn default_has_all_none() { + let msg = ServerSseMessage::default(); + assert!(msg.event_id.is_none()); + assert!(msg.message.is_none()); + assert!(msg.retry.is_none()); + } + + #[test] + fn new_sets_event_id_and_message() { + let msg = ServerSseMessage::new("42", dummy_message()); + assert_eq!(msg.event_id.as_deref(), Some("42")); + assert!(msg.message.is_some()); + assert!(msg.retry.is_none()); + } + + #[test] + fn from_message_has_no_event_id() { + let msg = ServerSseMessage::from_message(dummy_message()); + assert!(msg.event_id.is_none()); + assert!(msg.message.is_some()); + assert!(msg.retry.is_none()); + } + + #[test] + fn priming_sets_event_id_and_retry() { + let msg = ServerSseMessage::priming("0", Duration::from_secs(5)); + assert_eq!(msg.event_id.as_deref(), Some("0")); + assert!(msg.message.is_none()); + assert_eq!(msg.retry, Some(Duration::from_secs(5))); + } + + #[tokio::test] + async fn expect_json_accepts_body_under_limit() { + let body = Full::new(Bytes::from_static(INITIALIZE_REQUEST.as_bytes())); + let result = expect_json(body, 4 * 1024 * 1024).await; + assert!(result.is_ok()); + } + + #[tokio::test] + async fn expect_json_accepts_non_contiguous_body_data() { + let split = INITIALIZE_REQUEST.len() / 2; + let data = Bytes::copy_from_slice(&INITIALIZE_REQUEST.as_bytes()[..split]).chain( + Bytes::copy_from_slice(&INITIALIZE_REQUEST.as_bytes()[split..]), + ); + let result = expect_json(Full::new(data), 4 * 1024 * 1024).await; + assert!(result.is_ok()); + } + + #[tokio::test] + async fn expect_json_accepts_multi_frame_body() { + let split = INITIALIZE_REQUEST.len() / 2; + let body = StreamBody::new(stream::iter([ + Ok::<_, Infallible>(Frame::data(Bytes::copy_from_slice( + &INITIALIZE_REQUEST.as_bytes()[..split], + ))), + Ok(Frame::data(Bytes::copy_from_slice( + &INITIALIZE_REQUEST.as_bytes()[split..], + ))), + ])); + let result = expect_json(body, 4 * 1024 * 1024).await; + assert!(result.is_ok()); + } + + #[tokio::test] + async fn expect_json_rejects_oversized_body() { + let big_body = Full::new(Bytes::from(vec![b'x'; 128])); + let result = expect_json(big_body, 64).await; + let response = result.unwrap_err(); + assert_eq!(response.status(), http::StatusCode::PAYLOAD_TOO_LARGE); + } + + #[tokio::test] + async fn expect_json_rejects_oversized_multi_frame_body() { + let body = StreamBody::new(stream::iter([ + Ok::<_, Infallible>(Frame::data(Bytes::from_static(b"12345678"))), + Ok(Frame::data(Bytes::from_static(b"9"))), + ])); + let response = expect_json(body, 8).await.unwrap_err(); + assert_eq!(response.status(), http::StatusCode::PAYLOAD_TOO_LARGE); + } + + #[tokio::test] + async fn expect_json_returns_415_for_invalid_json_under_limit() { + let body = Full::new(Bytes::from("not valid json")); + let result = expect_json(body, 4 * 1024 * 1024).await; + let response = result.unwrap_err(); + assert_eq!(response.status(), http::StatusCode::UNSUPPORTED_MEDIA_TYPE); + } +} diff --git a/vendor/rmcp/src/transport/common/unix_socket.rs b/vendor/rmcp/src/transport/common/unix_socket.rs new file mode 100644 index 00000000..688c9ad4 --- /dev/null +++ b/vendor/rmcp/src/transport/common/unix_socket.rs @@ -0,0 +1,629 @@ +use std::{borrow::Cow, collections::HashMap, sync::Arc}; + +use bytes::Bytes; +use futures::stream::BoxStream; +use http::{HeaderName, HeaderValue, Method, Request, StatusCode, header::WWW_AUTHENTICATE}; +use http_body_util::{BodyExt, Full}; +use hyper::body::Incoming; +use hyper_util::rt::TokioIo; +use sse_stream::Sse; +use tokio::net::UnixStream; + +use crate::{ + model::{ClientJsonRpcMessage, ServerJsonRpcMessage}, + transport::{ + common::{ + client_side_sse::{DEFAULT_MAX_SSE_EVENT_SIZE, bounded_sse_stream}, + http_header::{ + EVENT_STREAM_MIME_TYPE, HEADER_LAST_EVENT_ID, HEADER_SESSION_ID, JSON_MIME_TYPE, + extract_scope_from_header, validate_custom_header, + }, + }, + streamable_http_client::*, + }, +}; + +#[derive(Debug, thiserror::Error)] +#[non_exhaustive] +pub enum UnixSocketError { + #[error("hyper error: {0}")] + Hyper(#[from] hyper::Error), + #[error("IO error: {0}")] + Io(#[from] std::io::Error), + #[error("HTTP error: {0}")] + Http(#[from] http::Error), + #[error("JSON error: {0}")] + Json(#[from] serde_json::Error), +} + +impl From for StreamableHttpError { + fn from(e: UnixSocketError) -> Self { + StreamableHttpError::Client(e) + } +} + +/// HTTP client that routes requests through a Unix domain socket. +/// +/// Implements [`StreamableHttpClient`] using `hyper` over `tokio::net::UnixStream`, +/// enabling MCP hosts in Kubernetes environments to connect through Envoy sidecars +/// or other Unix socket-based proxies. +/// +/// Each request opens a new Unix socket connection (no connection pooling). +/// This is appropriate when connecting through a sidecar proxy that manages +/// its own upstream connection pool. +/// +/// # Example +/// +/// ```rust,no_run +/// use rmcp::transport::{StreamableHttpClientTransport, UnixSocketHttpClient}; +/// use rmcp::transport::streamable_http_client::StreamableHttpClientTransportConfig; +/// +/// let client = UnixSocketHttpClient::new("/var/run/envoy.sock", "http://mcp-server.internal/mcp"); +/// let config = StreamableHttpClientTransportConfig::with_uri("http://mcp-server.internal/mcp"); +/// let transport = StreamableHttpClientTransport::with_client(client, config); +/// ``` +#[derive(Clone, Debug)] +pub struct UnixSocketHttpClient { + socket_path: Arc, + host_header: HeaderValue, +} + +impl UnixSocketHttpClient { + /// Creates a new Unix socket HTTP client. + /// + /// # Arguments + /// + /// * `socket_path` - Path to the Unix domain socket. Use `@name` syntax for Linux + /// abstract sockets (e.g., `@egress.sock` becomes `\0egress.sock`). + /// * `uri` - The MCP server URI. The authority (host:port) is extracted for the + /// HTTP `Host` header, since hyper does not auto-set it for Unix socket connections. + /// + /// # Panics + /// + /// Panics if `socket_path` is empty or is `@` with no name (empty abstract socket). + pub fn new(socket_path: &str, uri: &str) -> Self { + assert!( + !socket_path.is_empty() && socket_path != "@", + "socket_path must not be empty or a bare '@' (empty abstract socket name)" + ); + + let host_header = uri + .parse::() + .ok() + .and_then(|u| u.authority().cloned()) + .and_then(|a| HeaderValue::from_str(a.as_str()).ok()) + .unwrap_or_else(|| HeaderValue::from_static("localhost")); + + Self { + socket_path: resolve_socket_path(socket_path).into(), + host_header, + } + } +} + +/// Converts the `@`-prefixed abstract socket notation to the null-byte prefix +/// expected by the Linux kernel. Filesystem socket paths are returned unchanged. +fn resolve_socket_path(raw: &str) -> String { + if let Some(name) = raw.strip_prefix('@') { + format!("\0{name}") + } else { + raw.to_string() + } +} + +async fn connect_unix(socket_path: &str) -> Result { + #[cfg(target_os = "linux")] + if let Some(abstract_name) = socket_path.strip_prefix('\0') { + let abstract_name = abstract_name.to_string(); + let std_stream = tokio::task::spawn_blocking(move || { + use std::os::linux::net::SocketAddrExt; + let addr = std::os::unix::net::SocketAddr::from_abstract_name(&abstract_name)?; + let stream = std::os::unix::net::UnixStream::connect_addr(&addr)?; + stream.set_nonblocking(true)?; + Ok::<_, std::io::Error>(stream) + }) + .await + .map_err(std::io::Error::other)??; + return UnixStream::from_std(std_stream); + } + + UnixStream::connect(socket_path).await +} + +/// Opens a new Unix socket connection and sends the HTTP request. +/// One connection per request — the sidecar proxy handles connection pooling. +async fn send_http_request( + socket_path: &str, + request: Request>, +) -> Result, UnixSocketError> { + let stream = connect_unix(socket_path).await?; + let io = TokioIo::new(stream); + let (mut sender, conn) = hyper::client::conn::http1::handshake(io).await?; + + tokio::spawn(async move { + if let Err(e) = conn.await { + tracing::warn!("unix socket HTTP/1.1 connection error: {e}"); + } + }); + + Ok(sender.send_request(request).await?) +} + +/// Applies custom headers to a request builder, rejecting reserved headers. +fn apply_custom_headers( + mut builder: http::request::Builder, + custom_headers: HashMap, +) -> Result> { + for (name, value) in custom_headers { + validate_custom_header(&name).map_err(StreamableHttpError::ReservedHeaderConflict)?; + builder = builder.header(name, value); + } + Ok(builder) +} + +impl StreamableHttpClient for UnixSocketHttpClient { + type Error = UnixSocketError; + + async fn post_message( + &self, + uri: Arc, + message: ClientJsonRpcMessage, + session_id: Option>, + auth_token: Option, + custom_headers: HashMap, + ) -> Result> { + self.post_message_with_max_sse_event_size( + uri, + message, + session_id, + auth_token, + custom_headers, + DEFAULT_MAX_SSE_EVENT_SIZE, + ) + .await + } + + async fn post_message_with_max_sse_event_size( + &self, + uri: Arc, + message: ClientJsonRpcMessage, + session_id: Option>, + auth_token: Option, + custom_headers: HashMap, + max_sse_event_size: usize, + ) -> Result> { + let json_body = serde_json::to_string(&message) + .map_err(|e| StreamableHttpError::Client(UnixSocketError::Json(e)))?; + + let mut builder = Request::builder() + .method(Method::POST) + .uri(uri.as_ref()) + .header(http::header::HOST, self.host_header.clone()) + .header(http::header::CONTENT_TYPE, JSON_MIME_TYPE) + .header( + http::header::ACCEPT, + format!("{EVENT_STREAM_MIME_TYPE}, {JSON_MIME_TYPE}"), + ); + + if let Some(auth) = auth_token { + builder = builder.header(http::header::AUTHORIZATION, format!("Bearer {auth}")); + } + + builder = apply_custom_headers(builder, custom_headers)?; + + let session_was_attached = session_id.is_some(); + if let Some(sid) = session_id { + builder = builder.header(HEADER_SESSION_ID, sid.as_ref()); + } + + let request = builder + .body(Full::new(Bytes::from(json_body))) + .map_err(|e| StreamableHttpError::Client(UnixSocketError::Http(e)))?; + + let response = send_http_request(&self.socket_path, request) + .await + .map_err(StreamableHttpError::Client)?; + + let status = response.status(); + + if status == StatusCode::UNAUTHORIZED + && let Some(header) = response.headers().get(WWW_AUTHENTICATE) + { + let www_authenticate_header = header + .to_str() + .map_err(|_| { + StreamableHttpError::UnexpectedServerResponse(Cow::from( + "invalid www-authenticate header value", + )) + })? + .to_string(); + return Err(StreamableHttpError::AuthRequired(AuthRequiredError { + www_authenticate_header, + })); + } + + if status == StatusCode::FORBIDDEN + && let Some(header) = response.headers().get(WWW_AUTHENTICATE) + { + let header_str = header.to_str().map_err(|_| { + StreamableHttpError::UnexpectedServerResponse(Cow::from( + "invalid www-authenticate header value", + )) + })?; + let scope = extract_scope_from_header(header_str); + return Err(StreamableHttpError::InsufficientScope( + InsufficientScopeError { + www_authenticate_header: header_str.to_string(), + required_scope: scope, + }, + )); + } + + if matches!(status, StatusCode::ACCEPTED | StatusCode::NO_CONTENT) { + return Ok(StreamableHttpPostResponse::Accepted); + } + + if status == StatusCode::NOT_FOUND && session_was_attached { + return Err(StreamableHttpError::SessionExpired); + } + + if !status.is_success() { + let body = response + .into_body() + .collect() + .await + .map(|c| String::from_utf8_lossy(&c.to_bytes()).into_owned()) + .unwrap_or_else(|_| "".to_owned()); + if let Some(response) = + legacy_discover_response(&message, session_was_attached, status, &body) + { + return Ok(response); + } + return Err(StreamableHttpError::UnexpectedServerResponse(Cow::Owned( + format!("HTTP {status}: {body}"), + ))); + } + + let content_type = response.headers().get(http::header::CONTENT_TYPE).cloned(); + let content_length = response + .headers() + .get(http::header::CONTENT_LENGTH) + .and_then(|v| v.to_str().ok()) + .and_then(|v| v.parse::().ok()); + let session_id = response + .headers() + .get(HEADER_SESSION_ID) + .and_then(|v| v.to_str().ok()) + .map(|s| s.to_string()); + + if status.is_success() + && content_length == Some(0) + && matches!( + message, + ClientJsonRpcMessage::Notification(_) + | ClientJsonRpcMessage::Response(_) + | ClientJsonRpcMessage::Error(_) + ) + { + return Ok(StreamableHttpPostResponse::Accepted); + } + + match content_type { + Some(ref ct) if ct.as_bytes().starts_with(EVENT_STREAM_MIME_TYPE.as_bytes()) => { + let sse_stream = + bounded_sse_stream(response.into_body().into_data_stream(), max_sse_event_size); + Ok(StreamableHttpPostResponse::Sse(sse_stream, session_id)) + } + Some(ref ct) if ct.as_bytes().starts_with(JSON_MIME_TYPE.as_bytes()) => { + let body = response + .into_body() + .collect() + .await + .map_err(|e| StreamableHttpError::Client(UnixSocketError::Hyper(e)))? + .to_bytes(); + match serde_json::from_slice::(&body) { + Ok(parsed) => Ok(StreamableHttpPostResponse::Json(parsed, session_id)), + Err(e) + if matches!( + message, + ClientJsonRpcMessage::Notification(_) + | ClientJsonRpcMessage::Response(_) + | ClientJsonRpcMessage::Error(_) + ) => + { + tracing::warn!( + "could not parse JSON response as ServerJsonRpcMessage, treating as accepted: {e}" + ); + Ok(StreamableHttpPostResponse::Accepted) + } + Err(e) => Err(StreamableHttpError::UnexpectedServerResponse(Cow::Owned( + json_rpc_parse_error_message(&e, &body), + ))), + } + } + _ => Err(StreamableHttpError::UnexpectedContentType( + content_type.map(|ct| String::from_utf8_lossy(ct.as_bytes()).into_owned()), + )), + } + } + + async fn delete_session( + &self, + uri: Arc, + session_id: Arc, + auth_token: Option, + custom_headers: HashMap, + ) -> Result<(), StreamableHttpError> { + let mut builder = Request::builder() + .method(Method::DELETE) + .uri(uri.as_ref()) + .header(http::header::HOST, self.host_header.clone()) + .header(HEADER_SESSION_ID, session_id.as_ref()); + + if let Some(auth) = auth_token { + builder = builder.header(http::header::AUTHORIZATION, format!("Bearer {auth}")); + } + + builder = apply_custom_headers(builder, custom_headers)?; + + let request = builder + .body(Full::new(Bytes::new())) + .map_err(|e| StreamableHttpError::Client(UnixSocketError::Http(e)))?; + + let response = send_http_request(&self.socket_path, request) + .await + .map_err(StreamableHttpError::Client)?; + + if response.status() == StatusCode::METHOD_NOT_ALLOWED { + tracing::debug!("this server doesn't support deleting session"); + return Ok(()); + } + + if !response.status().is_success() { + return Err(StreamableHttpError::UnexpectedServerResponse(Cow::Owned( + format!("delete_session returned {}", response.status()), + ))); + } + + Ok(()) + } + + async fn get_stream( + &self, + uri: Arc, + session_id: Option>, + last_event_id: Option, + auth_token: Option, + custom_headers: HashMap, + ) -> Result>, StreamableHttpError> + { + self.get_stream_with_max_sse_event_size( + uri, + session_id, + last_event_id, + auth_token, + custom_headers, + DEFAULT_MAX_SSE_EVENT_SIZE, + ) + .await + } + + async fn get_stream_with_max_sse_event_size( + &self, + uri: Arc, + session_id: Option>, + last_event_id: Option, + auth_token: Option, + custom_headers: HashMap, + max_sse_event_size: usize, + ) -> Result>, StreamableHttpError> + { + let mut builder = Request::builder() + .method(Method::GET) + .uri(uri.as_ref()) + .header(http::header::HOST, self.host_header.clone()) + .header( + http::header::ACCEPT, + format!("{EVENT_STREAM_MIME_TYPE}, {JSON_MIME_TYPE}"), + ); + + if let Some(session_id) = session_id { + builder = builder.header(HEADER_SESSION_ID, session_id.as_ref()); + } + + if let Some(last_id) = last_event_id { + builder = builder.header(HEADER_LAST_EVENT_ID, last_id); + } + + if let Some(auth) = auth_token { + builder = builder.header(http::header::AUTHORIZATION, format!("Bearer {auth}")); + } + + builder = apply_custom_headers(builder, custom_headers)?; + + let request = builder + .body(Full::new(Bytes::new())) + .map_err(|e| StreamableHttpError::Client(UnixSocketError::Http(e)))?; + + let response = send_http_request(&self.socket_path, request) + .await + .map_err(StreamableHttpError::Client)?; + + if response.status() == StatusCode::METHOD_NOT_ALLOWED { + return Err(StreamableHttpError::ServerDoesNotSupportSse); + } + + if response.status() == StatusCode::UNAUTHORIZED + && let Some(header) = response.headers().get(WWW_AUTHENTICATE) + { + let www_authenticate_header = header + .to_str() + .map_err(|_| { + StreamableHttpError::UnexpectedServerResponse(Cow::from( + "invalid www-authenticate header value", + )) + })? + .to_string(); + return Err(StreamableHttpError::AuthRequired(AuthRequiredError { + www_authenticate_header, + })); + } + + if response.status() == StatusCode::FORBIDDEN + && let Some(header) = response.headers().get(WWW_AUTHENTICATE) + { + let header_str = header.to_str().map_err(|_| { + StreamableHttpError::UnexpectedServerResponse(Cow::from( + "invalid www-authenticate header value", + )) + })?; + let scope = extract_scope_from_header(header_str); + return Err(StreamableHttpError::InsufficientScope( + InsufficientScopeError { + www_authenticate_header: header_str.to_string(), + required_scope: scope, + }, + )); + } + + if !response.status().is_success() { + return Err(StreamableHttpError::UnexpectedServerResponse(Cow::Owned( + format!("get_stream returned {}", response.status()), + ))); + } + + match response.headers().get(http::header::CONTENT_TYPE) { + Some(ct) => { + if !ct.as_bytes().starts_with(EVENT_STREAM_MIME_TYPE.as_bytes()) + && !ct.as_bytes().starts_with(JSON_MIME_TYPE.as_bytes()) + { + return Err(StreamableHttpError::UnexpectedContentType(Some( + String::from_utf8_lossy(ct.as_bytes()).to_string(), + ))); + } + } + None => { + return Err(StreamableHttpError::UnexpectedContentType(None)); + } + } + + Ok(bounded_sse_stream( + response.into_body().into_data_stream(), + max_sse_event_size, + )) + } +} + +impl StreamableHttpClientTransport { + /// Creates a new transport connecting through a Unix domain socket. + /// + /// # Arguments + /// + /// * `socket_path` - Path to the Unix domain socket. Use `@name` for Linux abstract sockets. + /// * `uri` - The MCP server URI (used for HTTP Host header and request path). + pub fn from_unix_socket(socket_path: &str, uri: impl Into>) -> Self { + let uri: Arc = uri.into(); + let client = UnixSocketHttpClient::new(socket_path, &uri); + let config = StreamableHttpClientTransportConfig { + uri, + ..Default::default() + }; + StreamableHttpClientTransport::with_client(client, config) + } + + /// Creates a new transport connecting through a Unix domain socket with custom config. + /// + /// # Arguments + /// + /// * `socket_path` - Path to the Unix domain socket. Use `@name` for Linux abstract sockets. + /// * `config` - Transport configuration (URI, retry policy, custom headers, etc.). + pub fn from_unix_socket_with_config( + socket_path: &str, + config: StreamableHttpClientTransportConfig, + ) -> Self { + let client = UnixSocketHttpClient::new(socket_path, &config.uri); + StreamableHttpClientTransport::with_client(client, config) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn resolve_abstract_socket() { + assert_eq!(resolve_socket_path("@egress.sock"), "\0egress.sock"); + } + + #[test] + fn resolve_filesystem_socket() { + assert_eq!( + resolve_socket_path("/var/run/envoy.sock"), + "/var/run/envoy.sock" + ); + } + + #[test] + fn resolve_empty_abstract() { + assert_eq!(resolve_socket_path("@"), "\0"); + } + + #[test] + #[should_panic(expected = "socket_path must not be empty")] + fn rejects_bare_at_symbol() { + UnixSocketHttpClient::new("@", "http://localhost/mcp"); + } + + #[test] + #[should_panic(expected = "socket_path must not be empty")] + fn rejects_empty_path() { + UnixSocketHttpClient::new("", "http://localhost/mcp"); + } + + #[test] + fn host_header_auto_derived() { + let client = + UnixSocketHttpClient::new("/var/run/envoy.sock", "http://mcp-server.internal/mcp"); + assert_eq!(client.host_header, "mcp-server.internal"); + } + + #[test] + fn host_header_with_port() { + let client = + UnixSocketHttpClient::new("/var/run/envoy.sock", "http://mcp-server.internal:8080/mcp"); + assert_eq!(client.host_header, "mcp-server.internal:8080"); + } + + #[test] + fn host_header_fallback_on_path_only_uri() { + let client = UnixSocketHttpClient::new("/var/run/envoy.sock", "/mcp"); + assert_eq!(client.host_header, "localhost"); + } + + #[test] + fn reserved_header_rejected() { + let mut headers = HashMap::new(); + headers.insert( + HeaderName::from_static("accept"), + HeaderValue::from_static("text/plain"), + ); + let builder = Request::builder(); + let result = apply_custom_headers(builder, headers); + assert!(matches!( + result, + Err(StreamableHttpError::ReservedHeaderConflict(_)) + )); + } + + #[test] + fn mcp_protocol_version_allowed_through() { + let mut headers = HashMap::new(); + headers.insert( + HeaderName::from_static("mcp-protocol-version"), + HeaderValue::from_static("2025-03-26"), + ); + let builder = Request::builder().uri("http://localhost/mcp").method("GET"); + let result = apply_custom_headers(builder, headers); + assert!(result.is_ok()); + } +} diff --git a/vendor/rmcp/src/transport/io.rs b/vendor/rmcp/src/transport/io.rs new file mode 100644 index 00000000..adc2dba0 --- /dev/null +++ b/vendor/rmcp/src/transport/io.rs @@ -0,0 +1,6 @@ +/// # StdIO Transport +/// +/// Create a pair of [`tokio::io::Stdin`] and [`tokio::io::Stdout`]. +pub fn stdio() -> (tokio::io::Stdin, tokio::io::Stdout) { + (tokio::io::stdin(), tokio::io::stdout()) +} diff --git a/vendor/rmcp/src/transport/sink_stream.rs b/vendor/rmcp/src/transport/sink_stream.rs new file mode 100644 index 00000000..6286b53b --- /dev/null +++ b/vendor/rmcp/src/transport/sink_stream.rs @@ -0,0 +1,80 @@ +use std::sync::Arc; + +use futures::{Sink, Stream}; +use tokio::sync::Mutex; + +use super::{IntoTransport, Transport}; +use crate::service::{RxJsonRpcMessage, ServiceRole, TxJsonRpcMessage}; + +pub struct SinkStreamTransport { + stream: St, + sink: Arc>, +} + +impl SinkStreamTransport { + pub fn new(sink: Si, stream: St) -> Self { + Self { + stream, + sink: Arc::new(Mutex::new(sink)), + } + } +} + +impl Transport for SinkStreamTransport +where + St: Send + Stream> + Unpin, + Si: Send + Sink> + Unpin + 'static, + Si::Error: std::error::Error + Send + Sync + 'static, +{ + type Error = Si::Error; + + fn send( + &mut self, + item: TxJsonRpcMessage, + ) -> impl Future> + Send + 'static { + use futures::SinkExt; + let lock = self.sink.clone(); + async move { + let mut write = lock.lock().await; + write.send(item).await + } + } + + fn receive(&mut self) -> impl Future>> { + use futures::StreamExt; + self.stream.next() + } + + async fn close(&mut self) -> Result<(), Self::Error> { + Ok(()) + } +} + +#[non_exhaustive] +pub enum TransportAdapterSinkStream {} + +impl IntoTransport for (Si, St) +where + Role: ServiceRole, + Si: Send + Sink> + Unpin + 'static, + St: Send + Stream> + Unpin + 'static, + Si::Error: std::error::Error + Send + Sync + 'static, +{ + fn into_transport(self) -> impl Transport + 'static { + SinkStreamTransport::new(self.0, self.1) + } +} + +#[non_exhaustive] +pub enum TransportAdapterAsyncCombinedRW {} +impl IntoTransport for S +where + Role: ServiceRole, + S: Sink> + Stream> + Send + 'static, + S::Error: std::error::Error + Send + Sync + 'static, +{ + fn into_transport(self) -> impl Transport + 'static { + use futures::StreamExt; + IntoTransport::::into_transport(self.split()) + } +} diff --git a/vendor/rmcp/src/transport/streamable_http_client.rs b/vendor/rmcp/src/transport/streamable_http_client.rs new file mode 100644 index 00000000..a5811429 --- /dev/null +++ b/vendor/rmcp/src/transport/streamable_http_client.rs @@ -0,0 +1,2612 @@ +use std::{ + borrow::Cow, + collections::{HashMap, HashSet, VecDeque}, + sync::Arc, + time::Duration, +}; + +use futures::{ + Stream, StreamExt, + future::BoxFuture, + stream::{BoxStream, FuturesUnordered}, +}; +use http::{HeaderName, HeaderValue, StatusCode}; +pub use sse_stream::Error as SseError; +use sse_stream::Sse; +use thiserror::Error; +use tokio_util::sync::CancellationToken; +use tracing::debug; + +use super::common::client_side_sse::{ + DEFAULT_MAX_SSE_EVENT_SIZE, ExponentialBackoff, SseRetryPolicy, SseStreamReconnect, +}; +use crate::{ + RoleClient, + model::{ + ClientJsonRpcMessage, ClientNotification, ClientRequest, ErrorData, GetExtensions, GetMeta, + InitializedNotification, JsonObject, ProtocolVersion, RequestId, ServerJsonRpcMessage, + ServerResult, + }, + service::InboundStreamOrigin, + transport::{ + common::{client_side_sse::SseAutoReconnectStream, mcp_headers}, + worker::{ + RequestCancellationRegistration, Worker, WorkerQuitReason, WorkerSendRequest, + WorkerTransport, + }, + }, +}; + +type BoxedSseStream = BoxStream<'static, Result>; +type SseTaskResult = (Option, Result<(), StreamableHttpError>); +const SESSION_CLEANUP_TIMEOUT: Duration = Duration::from_secs(5); + +fn build_request_headers( + base: &HashMap, + message: &ClientJsonRpcMessage, + tool_cache: &HashMap>, + version: &ProtocolVersion, +) -> HashMap { + use serde_json::Value; + + let mut headers = base.clone(); + if *version >= ProtocolVersion::STANDARD_HEADERS + && let Ok(value) = serde_json::to_value(message) + { + let schema = value + .get("method") + .and_then(Value::as_str) + .filter(|method| *method == "tools/call") + .and_then(|_| value.get("params")) + .and_then(|params| params.get("name")) + .and_then(Value::as_str) + .and_then(|name| tool_cache.get(name)) + .map(Arc::as_ref); + for (name, val) in mcp_headers::standard_request_headers(&value, schema) { + headers.insert(name, val); + } + } + headers +} + +fn request_version_headers( + base: &HashMap, + message: &ClientJsonRpcMessage, + fallback: &ProtocolVersion, + tool_cache: &HashMap>, +) -> (ProtocolVersion, HashMap) { + let version = match message { + ClientJsonRpcMessage::Request(request) => request + .request + .get_meta() + .protocol_version() + .unwrap_or_else(|| fallback.clone()), + _ => fallback.clone(), + }; + let mut headers = build_request_headers(base, message, tool_cache, &version); + if let Ok(value) = HeaderValue::from_str(version.as_str()) { + headers.insert(HeaderName::from_static("mcp-protocol-version"), value); + } + (version, headers) +} + +fn cache_tools_from_response( + cache: &mut HashMap>, + message: &mut ServerJsonRpcMessage, + protocol_version: &ProtocolVersion, +) { + if protocol_version < &ProtocolVersion::STANDARD_HEADERS { + return; + } + if let ServerJsonRpcMessage::Response(response) = message + && let ServerResult::ListToolsResult(list) = &mut response.result + { + list.tools.retain(|tool| { + let Err(reason) = + mcp_headers::validate_param_header_annotations(&tool.input_schema) + else { + cache.insert(tool.name.to_string(), tool.input_schema.clone()); + return true; + }; + tracing::warn!(tool = %tool.name, "rejecting invalid x-mcp-header annotations: {reason}"); + false + }); + } +} + +fn negotiate_version_headers( + init_response: &ServerJsonRpcMessage, + base: HashMap, +) -> (ProtocolVersion, HashMap) { + let mut version = ProtocolVersion::default(); + let mut headers = base; + if let ServerJsonRpcMessage::Response(response) = init_response + && let ServerResult::InitializeResult(init_result) = &response.result + { + version = init_result.protocol_version.clone(); + // HeaderName::from_static requires lowercase + if let Ok(hv) = HeaderValue::from_str(init_result.protocol_version.as_str()) { + headers.insert(HeaderName::from_static("mcp-protocol-version"), hv); + } + } + (version, headers) +} + +#[derive(Debug, Error)] +#[error("authorization required: {www_authenticate_header}")] +#[non_exhaustive] +pub struct AuthRequiredError { + pub www_authenticate_header: String, +} + +impl AuthRequiredError { + /// Create a new `AuthRequiredError` instance. + pub fn new(www_authenticate_header: String) -> Self { + Self { + www_authenticate_header, + } + } +} + +#[derive(Debug, Error)] +#[error("insufficient scope: {www_authenticate_header}")] +#[non_exhaustive] +pub struct InsufficientScopeError { + pub www_authenticate_header: String, + pub required_scope: Option, +} + +impl InsufficientScopeError { + /// Create a new `InsufficientScopeError` instance. + pub fn new(www_authenticate_header: String, required_scope: Option) -> Self { + Self { + www_authenticate_header, + required_scope, + } + } + + /// check if scope upgrade is possible (i.e., we know what scope is required) + pub fn can_upgrade(&self) -> bool { + self.required_scope.is_some() + } + + /// get the required scope for upgrade + pub fn get_required_scope(&self) -> Option<&str> { + self.required_scope.as_deref() + } +} + +#[derive(Error, Debug)] +#[non_exhaustive] +pub enum StreamableHttpError { + #[error("SSE error: {0}")] + Sse(#[from] SseError), + #[error("Io error: {0}")] + Io(#[from] std::io::Error), + #[error("Client error: {0}")] + Client(E), + #[error("unexpected end of stream")] + UnexpectedEndOfStream, + #[error("unexpected server response: {0}")] + UnexpectedServerResponse(Cow<'static, str>), + #[error("Unexpected content type: {0:?}")] + UnexpectedContentType(Option), + #[error("Server does not support SSE")] + ServerDoesNotSupportSse, + #[error("Server does not support delete session")] + ServerDoesNotSupportDeleteSession, + #[error("Tokio join error: {0}")] + TokioJoinError(#[from] tokio::task::JoinError), + #[error("Deserialize error: {0}")] + Deserialize(#[from] serde_json::Error), + #[error("Transport channel closed")] + TransportChannelClosed, + #[error("Missing session id in HTTP response")] + MissingSessionIdInResponse, + #[cfg(feature = "auth")] + #[error("Auth error: {0}")] + Auth(#[from] crate::transport::auth::AuthError), + #[error("Auth required")] + AuthRequired(#[source] AuthRequiredError), + #[error("Insufficient scope")] + InsufficientScope(#[source] InsufficientScopeError), + #[error("Header name '{0}' is reserved and conflicts with default headers")] + ReservedHeaderConflict(String), + #[error("Session expired (HTTP 404)")] + SessionExpired, + /// Session recovery timed out. The server may have processed an interrupted POST. + #[error("Session recovery timed out; the server may have processed the POST")] + SessionRecoveryTimeout, + /// A cancellation or reply POST did not finish in time. + #[error("Control POST timed out")] + ControlRequestTimeout, +} + +/// Bytes of an unusable JSON body kept in +/// [`StreamableHttpError::UnexpectedServerResponse`]. +pub(crate) const JSON_RPC_BODY_PREVIEW_LEN: usize = 256; + +/// Short, lossy view of a body that failed to parse as JSON-RPC. +pub(crate) fn json_rpc_body_preview(body: &[u8]) -> Cow<'static, str> { + if body.is_empty() { + return Cow::Borrowed(""); + } + let lossy = String::from_utf8_lossy(body); + if lossy.len() <= JSON_RPC_BODY_PREVIEW_LEN { + return Cow::Owned(lossy.into_owned()); + } + let mut end = JSON_RPC_BODY_PREVIEW_LEN; + while end > 0 && !lossy.is_char_boundary(end) { + end -= 1; + } + Cow::Owned(lossy[..end].to_owned()) +} + +/// Request-POST parse failure, including a body preview so empty / HTML / `{}` +/// are distinguishable from the serde diagnostic alone. +pub(crate) fn json_rpc_parse_error_message(err: &serde_json::Error, body: &[u8]) -> String { + format!( + "could not parse JSON response as ServerJsonRpcMessage: {err}: {}", + json_rpc_body_preview(body) + ) +} + +impl StreamableHttpError { + /// The `WWW-Authenticate` challenge carried by this error, when the + /// server answered 401 ([`AuthRequired`](Self::AuthRequired)) or 403 + /// ([`InsufficientScope`](Self::InsufficientScope)). Feed it to + /// [`AuthorizationRequest::with_challenge`](crate::transport::auth::AuthorizationRequest::with_challenge) + /// to authorize reactively. + #[cfg(feature = "auth")] + pub fn auth_challenge(&self) -> Option<&str> { + match self { + Self::AuthRequired(error) => Some(&error.www_authenticate_header), + Self::InsufficientScope(error) => Some(&error.www_authenticate_header), + _ => None, + } + } +} + +#[derive(Debug, Clone, Error)] +#[non_exhaustive] +pub enum StreamableHttpProtocolError { + #[error("Missing session id in response")] + MissingSessionIdInResponse, +} + +#[expect( + clippy::large_enum_variant, + reason = "boxing the streaming response would add an allocation to the common response path" +)] +#[non_exhaustive] +pub enum StreamableHttpPostResponse { + Accepted, + Json(ServerJsonRpcMessage, Option), + Sse(BoxedSseStream, Option), +} + +impl std::fmt::Debug for StreamableHttpPostResponse { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + Self::Accepted => write!(f, "Accepted"), + Self::Json(arg0, arg1) => f.debug_tuple("Json").field(arg0).field(arg1).finish(), + Self::Sse(_, arg1) => f.debug_tuple("Sse").field(arg1).finish(), + } + } +} + +impl StreamableHttpPostResponse { + pub async fn expect_initialized( + self, + ) -> Result<(ServerJsonRpcMessage, Option), StreamableHttpError> + where + E: std::error::Error + Send + Sync + 'static, + { + match self { + Self::Json(message, session_id) => Ok((message, session_id)), + Self::Sse(mut stream, session_id) => { + while let Some(event) = stream.next().await { + let event = event?; + let payload = event.data.unwrap_or_default(); + if payload.trim().is_empty() { + continue; + } + + let message: ServerJsonRpcMessage = serde_json::from_str(&payload)?; + + if matches!(message, ServerJsonRpcMessage::Response(_)) { + return Ok((message, session_id)); + } + + debug!( + ?message, + "received message before initialize response; continuing to drain stream" + ); + } + + Err(StreamableHttpError::UnexpectedServerResponse( + "empty sse stream".into(), + )) + } + _ => Err(StreamableHttpError::UnexpectedServerResponse( + "expect initialized, accepted".into(), + )), + } + } + + pub fn expect_json(self) -> Result> + where + E: std::error::Error + Send + Sync + 'static, + { + match self { + Self::Json(message, ..) => Ok(message), + got => Err(StreamableHttpError::UnexpectedServerResponse( + format!("expect json, got {got:?}").into(), + )), + } + } + + pub fn expect_accepted_or_json(self) -> Result<(), StreamableHttpError> + where + E: std::error::Error + Send + Sync + 'static, + { + match self { + Self::Accepted => Ok(()), + // Tolerate servers that return 200 with JSON for notifications + Self::Json(..) => Ok(()), + got => Err(StreamableHttpError::UnexpectedServerResponse( + format!("expect accepted or json, got {got:?}").into(), + )), + } + } +} + +/// Convert a sessionless discovery rejection into a response the lifecycle +/// layer can classify. The server's own JSON-RPC error is preserved so the +/// lifecycle can tell a modern rejection (retry at a supported version) from a +/// legacy one; `invalid_request` is synthesized only when the body has no error +/// to keep, as with an empty or plain-text 4xx from middleware. +/// +/// The id is re-correlated because such middleware rejections cannot echo it +/// (the Python SDK sends the literal `"server-error"`); otherwise the lifecycle +/// discards the response as uncorrelated without classifying it. +/// +/// Keep authentication failures and server errors on their original paths. +pub(super) fn legacy_discover_response( + message: &ClientJsonRpcMessage, + session_was_attached: bool, + status: StatusCode, + body: &str, +) -> Option { + if session_was_attached + || !status.is_client_error() + || matches!(status, StatusCode::UNAUTHORIZED | StatusCode::FORBIDDEN) + { + return None; + } + + let ClientJsonRpcMessage::Request(request) = message else { + return None; + }; + if !matches!(request.request, ClientRequest::DiscoverRequest(_)) { + return None; + } + + let error = match serde_json::from_str::(body) { + Ok(ServerJsonRpcMessage::Error(error)) => error.error, + _ => ErrorData::invalid_request( + format!("server/discover rejected with HTTP {status}: {body}"), + None, + ), + }; + Some(StreamableHttpPostResponse::Json( + ServerJsonRpcMessage::error(error, Some(request.id.clone())), + None, + )) +} + +/// HTTP backend used by [`StreamableHttpClientTransport`]. +/// +/// Custom implementations that parse SSE responses must override +/// [`Self::post_message_with_max_sse_event_size`] and +/// [`Self::get_stream_with_max_sse_event_size`] to enforce the transport's +/// configured event-size limit. +/// +/// For legacy http, the transport keeps an open response stream alive until +/// its cancellation send finishes or is dropped. This lets a custom client +/// handle the cancellation using state owned by that stream. +pub trait StreamableHttpClient: Clone + Send + 'static { + type Error: std::error::Error + Send + Sync + 'static; + fn post_message( + &self, + uri: Arc, + message: ClientJsonRpcMessage, + session_id: Option>, + auth_header: Option, + custom_headers: HashMap, + ) -> impl Future>> + + Send + + '_; + /// Send a message while enforcing a maximum raw SSE event size. + /// + /// `max_sse_event_size` is not a per-request option: it is the + /// transport-wide [`StreamableHttpClientTransportConfig::max_sse_event_size`] + /// value, passed identically on every call because the limit must be applied + /// inside the client (at the raw byte layer, before SSE parsing) rather than + /// by the caller. + /// + /// Custom clients that parse SSE responses should override this method. + /// The default implementation delegates to [`Self::post_message`]. + fn post_message_with_max_sse_event_size( + &self, + uri: Arc, + message: ClientJsonRpcMessage, + session_id: Option>, + auth_header: Option, + custom_headers: HashMap, + _max_sse_event_size: usize, + ) -> impl Future>> + + Send + + '_ { + self.post_message(uri, message, session_id, auth_header, custom_headers) + } + fn delete_session( + &self, + uri: Arc, + session_id: Arc, + auth_header: Option, + custom_headers: HashMap, + ) -> impl Future>> + Send + '_; + /// Open an SSE stream, optionally scoped to a legacy session. + /// + /// `session_id` is `None` when resuming a stateless response using only + /// `last_event_id`. + fn get_stream( + &self, + uri: Arc, + session_id: Option>, + last_event_id: Option, + auth_header: Option, + custom_headers: HashMap, + ) -> impl Future< + Output = Result< + BoxStream<'static, Result>, + StreamableHttpError, + >, + > + Send + + '_; + /// Open an SSE stream while enforcing a maximum raw event size. + /// + /// `max_sse_event_size` is not a per-request option: it is the + /// transport-wide [`StreamableHttpClientTransportConfig::max_sse_event_size`] + /// value, passed identically on every call because the limit must be applied + /// inside the client (at the raw byte layer, before SSE parsing) rather than + /// by the caller. + /// + /// Custom clients that parse SSE responses should override this method. + /// The default implementation delegates to [`Self::get_stream`]. + fn get_stream_with_max_sse_event_size( + &self, + uri: Arc, + session_id: Option>, + last_event_id: Option, + auth_header: Option, + custom_headers: HashMap, + _max_sse_event_size: usize, + ) -> impl Future< + Output = Result< + BoxStream<'static, Result>, + StreamableHttpError, + >, + > + Send + + '_ { + self.get_stream(uri, session_id, last_event_id, auth_header, custom_headers) + } +} + +#[non_exhaustive] +pub struct RetryConfig { + pub max_times: Option, + pub min_duration: Duration, +} + +struct StreamableHttpClientReconnect { + pub client: C, + pub session_id: Option>, + pub uri: Arc, + pub auth_header: Option, + pub custom_headers: HashMap, + pub max_sse_event_size: usize, +} + +impl SseStreamReconnect for StreamableHttpClientReconnect { + type Error = StreamableHttpError; + type Future = BoxFuture<'static, Result>; + fn retry_connection(&mut self, last_event_id: Option<&str>) -> Self::Future { + let client = self.client.clone(); + let uri = self.uri.clone(); + let session_id = self.session_id.clone(); + let auth_header = self.auth_header.clone(); + let custom_headers = self.custom_headers.clone(); + let max_sse_event_size = self.max_sse_event_size; + let last_event_id = last_event_id.map(|s| s.to_owned()); + Box::pin(async move { + client + .get_stream_with_max_sse_event_size( + uri, + session_id, + last_event_id, + auth_header, + custom_headers, + max_sse_event_size, + ) + .await + }) + } + + fn map_fatal_stream_error(&mut self, error: SseError) -> Option { + Some(StreamableHttpError::Sse(error)) + } +} + +/// Info retained for cleaning up the session when the worker exits. +struct SessionCleanupInfo { + client: C, + uri: Arc, + session_id: Arc, + auth_header: Option, + protocol_headers: HashMap, +} + +#[derive(Debug, Clone, Default)] +#[non_exhaustive] +pub struct StreamableHttpClientWorker { + pub client: C, + pub config: StreamableHttpClientTransportConfig, +} + +struct PostResult { + send_request: WorkerSendRequest>, + // None means the send future was dropped, or the request or transport was cancelled. + response: Option>>, + // The protocol version used to send this POST. + version: ProtocolVersion, +} + +struct PostSession { + id: Option>, + headers: HashMap, + version: ProtocolVersion, + cancellation: CancellationToken, +} + +impl StreamableHttpClientWorker { + pub fn new_simple(url: impl Into>) -> Self { + Self { + client: C::default(), + config: StreamableHttpClientTransportConfig { + uri: url.into(), + ..Default::default() + }, + } + } +} + +impl StreamableHttpClientWorker { + pub fn new(client: C, config: StreamableHttpClientTransportConfig) -> Self { + Self { client, config } + } +} + +impl StreamableHttpClientWorker { + // Run initialization and protocol-version changes without other ordinary POSTs. + fn is_ordering_barrier( + message: &ClientJsonRpcMessage, + negotiated_version: &ProtocolVersion, + ) -> bool { + match message { + ClientJsonRpcMessage::Request(request) => { + matches!( + &request.request, + ClientRequest::InitializeRequest(_) | ClientRequest::DiscoverRequest(_) + ) || request + .request + .get_meta() + .protocol_version() + .is_some_and(|version| &version != negotiated_version) + } + ClientJsonRpcMessage::Notification(notification) => matches!( + ¬ification.notification, + ClientNotification::InitializedNotification(_) + ), + _ => false, + } + } + + fn post_request( + client: C, + config: &StreamableHttpClientTransportConfig, + mut send_request: WorkerSendRequest, + session: PostSession, + transport_cancellation: CancellationToken, + ) -> BoxFuture<'static, PostResult> { + let uri = config.uri.clone(); + let auth_header = config.auth_header.clone(); + let max_sse_event_size = config.max_sse_event_size; + let control_request_timeout = config.control_request_timeout; + let is_control = Self::is_control_message(&send_request.message); + let cancellation = send_request + .cancellation_token() + .unwrap_or_else(|| transport_cancellation.child_token()); + Box::pin(async move { + let response = tokio::select! { + biased; + _ = cancellation.cancelled() => None, + _ = send_request.responder.closed() => None, + _ = session.cancellation.cancelled() => { + Some(Err(StreamableHttpError::SessionRecoveryTimeout)) + }, + _ = tokio::time::sleep(control_request_timeout), if is_control => { + Some(Err(StreamableHttpError::ControlRequestTimeout)) + }, + response = client.post_message_with_max_sse_event_size( + uri, + send_request.message.clone(), + session.id, + auth_header, + session.headers, + max_sse_event_size, + ) => Some(response), + }; + PostResult { + send_request, + response, + version: session.version, + } + }) + } + + fn cancellation_request_id(message: &ClientJsonRpcMessage) -> Option<&RequestId> { + match message { + ClientJsonRpcMessage::Notification(notification) => match ¬ification.notification { + ClientNotification::CancelledNotification(cancelled) => { + cancelled.params.request_id.as_ref() + } + _ => None, + }, + _ => None, + } + } + + fn client_request_id(message: &ClientJsonRpcMessage) -> Option { + match message { + ClientJsonRpcMessage::Request(request) => Some(request.id.clone()), + _ => None, + } + } + + fn server_response_id(message: &ServerJsonRpcMessage) -> Option<&RequestId> { + match message { + ServerJsonRpcMessage::Response(response) => Some(&response.id), + ServerJsonRpcMessage::Error(error) => error.id.as_ref(), + _ => None, + } + } + + fn clear_stream_response_pending( + pending_stream_response_ids: &mut HashSet, + message: &ServerJsonRpcMessage, + ) -> Option { + let response_id = Self::server_response_id(message)?; + if let Some(id) = pending_stream_response_ids.take(response_id) { + return Some(id); + } + let id = RequestId::Number(response_id.numeric_string_value()?); + pending_stream_response_ids.take(&id) + } + + async fn drain_queued_stream_messages( + sse_worker_rx: &mut tokio::sync::mpsc::Receiver, + context: &mut super::worker::WorkerContext, + pending_stream_response_ids: &mut HashSet, + ) -> Result<(), WorkerQuitReason>> { + loop { + match sse_worker_rx.try_recv() { + Ok(message) => { + let _ = + Self::clear_stream_response_pending(pending_stream_response_ids, &message); + context.send_to_handler(message).await?; + } + Err(tokio::sync::mpsc::error::TryRecvError::Empty) => return Ok(()), + Err(tokio::sync::mpsc::error::TryRecvError::Disconnected) => return Ok(()), + } + } + } + + async fn fail_pending_stream_responses( + context: &mut super::worker::WorkerContext, + pending_stream_response_ids: &mut HashSet, + ) -> Result<(), WorkerQuitReason>> { + if pending_stream_response_ids.is_empty() { + return Ok(()); + } + + let pending_ids = std::mem::take(pending_stream_response_ids); + for id in pending_ids { + context + .send_to_handler(ServerJsonRpcMessage::error( + ErrorData::internal_error( + "streamable HTTP session was re-initialized before the response arrived", + None, + ), + Some(id), + )) + .await?; + } + Ok(()) + } + + async fn fail_pending_responses_except_retries( + context: &mut super::worker::WorkerContext, + pending_stream_response_ids: &mut HashSet, + recovery_posts: &VecDeque>, + ) -> Result<(), WorkerQuitReason>> { + // Keep only retries that have not already received a stream response. + let retry_ids: Vec<_> = recovery_posts + .iter() + .filter_map(|request| Self::client_request_id(&request.message)) + .filter(|id| pending_stream_response_ids.remove(id)) + .collect(); + Self::fail_pending_stream_responses(context, pending_stream_response_ids).await?; + pending_stream_response_ids.extend(retry_ids); + Ok(()) + } + + fn fail_recovery_posts( + recovery_posts: &mut VecDeque>, + pending_stream_response_ids: &mut HashSet, + error: StreamableHttpError, + ) { + // The backend error cannot be cloned. Return it to one caller + // and return the original session-expired error to the others. + let mut recovery_error = Some(error); + for send_request in recovery_posts.drain(..) { + let pending = Self::client_request_id(&send_request.message) + .is_none_or(|id| pending_stream_response_ids.remove(&id)); + let result = if pending { + Err(recovery_error + .take() + .unwrap_or(StreamableHttpError::SessionExpired)) + } else { + Ok(()) + }; + let _ = send_request.responder.send(result); + } + } + + /// Convert an SSE stream into JSON-RPC messages with reconnect semantics. + /// + /// This is used for request-scoped SSE responses as well as the standalone + /// GET stream. A request-scoped stream can close before its response arrives, + /// and SEP-1699 requires the client to honor `retry` and resume with + /// `Last-Event-ID` in that case. + fn reconnecting_sse_to_jsonrpc( + stream: BoxedSseStream, + client: C, + session_id: Option>, + uri: Arc, + auth_header: Option, + custom_headers: HashMap, + max_sse_event_size: usize, + retry_config: Arc, + ) -> impl Stream>> + Send + 'static + { + SseAutoReconnectStream::new_after_event_id( + stream, + StreamableHttpClientReconnect { + client, + session_id, + uri, + auth_header, + custom_headers, + max_sse_event_size, + }, + retry_config, + ) + } + + /// Convert a POST response SSE stream into JSON-RPC messages. + /// + /// Request-scoped streams resume via GET once the server has supplied an + /// event ID. The session header remains optional for stateless transports. + fn response_sse_to_jsonrpc( + stream: BoxedSseStream, + session_id: Option>, + client: C, + uri: Arc, + auth_header: Option, + custom_headers: HashMap, + max_sse_event_size: usize, + retry_config: Arc, + ) -> BoxStream<'static, Result>> { + Self::reconnecting_sse_to_jsonrpc( + stream, + client, + session_id, + uri, + auth_header, + custom_headers, + max_sse_event_size, + retry_config, + ) + .boxed() + } + + async fn run_response_stream( + mut sse_stream: BoxStream< + 'static, + Result>, + >, + sse_worker_tx: tokio::sync::mpsc::Sender, + origin: InboundStreamOrigin, + request_ct: CancellationToken, + stream_ct: CancellationToken, + uses_modern_http: bool, + ) -> Result<(), StreamableHttpError> { + tokio::select! { + biased; + _ = request_ct.cancelled(), if !uses_modern_http => { + // Stop reading, but keep the stream until the adapter + // handles cancellation or the send is dropped. + stream_ct.cancelled().await; + Ok(()) + } + result = Self::execute_sse_stream( + sse_stream.as_mut(), sse_worker_tx, origin, true, stream_ct.clone(), + ) => result, + } + } + + async fn execute_sse_stream( + sse_stream: impl Stream>> + + Send, + sse_worker_tx: tokio::sync::mpsc::Sender, + origin: InboundStreamOrigin, + close_on_response: bool, + ct: CancellationToken, + ) -> Result<(), StreamableHttpError> { + let mut sse_stream = std::pin::pin!(sse_stream); + loop { + let message = tokio::select! { + event = sse_stream.next() => { + event + } + _ = ct.cancelled() => { + tracing::debug!("cancelled"); + break; + } + }; + let Some(mut message) = message.transpose()? else { + break; + }; + // SEP-2260: mark inbound requests with the stream they arrived on + // for the client receive-side association check. + if let ServerJsonRpcMessage::Request(request) = &mut message { + request.request.extensions_mut().insert(origin.clone()); + } + let is_response = matches!( + message, + ServerJsonRpcMessage::Response(_) | ServerJsonRpcMessage::Error(_) + ); + let yield_result = sse_worker_tx.send(message).await; + if yield_result.is_err() { + tracing::trace!("streamable http transport worker dropped, exiting"); + break; + } + if close_on_response && is_response { + tracing::debug!("got response, draining sse stream for connection reuse"); + // Consume the remaining stream so the HTTP/1.1 connection + // returns to the pool cleanly. + let _ = tokio::time::timeout(std::time::Duration::from_millis(50), async { + while sse_stream.next().await.is_some() {} + }) + .await; + break; + } + } + Ok(()) + } + + fn spawn_common_stream( + streams: &mut tokio::task::JoinSet>, + client: C, + session_id: Arc, + config: &StreamableHttpClientTransportConfig, + protocol_headers: HashMap, + sse_worker_tx: tokio::sync::mpsc::Sender, + transport_task_ct: CancellationToken, + ) { + let uri = config.uri.clone(); + let auth_header = config.auth_header.clone(); + let retry_config = config.retry_config.clone(); + let reconnect_uri = config.uri.clone(); + let reconnect_auth_header = config.auth_header.clone(); + let max_sse_event_size = config.max_sse_event_size; + + streams.spawn(async move { + let result = match client + .get_stream_with_max_sse_event_size( + uri, + Some(session_id.clone()), + None, + auth_header, + protocol_headers.clone(), + max_sse_event_size, + ) + .await + { + Ok(stream) => { + let sse_stream = SseAutoReconnectStream::new( + stream, + StreamableHttpClientReconnect { + client, + session_id: Some(session_id), + uri: reconnect_uri, + auth_header: reconnect_auth_header, + custom_headers: protocol_headers, + max_sse_event_size, + }, + retry_config, + ); + Self::execute_sse_stream( + sse_stream, + sse_worker_tx, + InboundStreamOrigin::Unassociated, + false, + transport_task_ct.child_token(), + ) + .await + } + Err(StreamableHttpError::ServerDoesNotSupportSse) => { + tracing::debug!("server doesn't support sse, skip common stream"); + Ok(()) + } + Err(error) => { + tracing::error!("fail to get common stream: {error}"); + Err(error) + } + }; + (None, result) + }); + } + + /// Performs a transparent re-initialization handshake after a session-expired 404. + /// + /// Takes an owned clone of the client (avoiding `&self` across `.await` so the + /// future remains `Send` without requiring `C: Sync`). POSTs the saved + /// initialize request without a session ID, extracts the new session ID and + /// protocol version, sends `notifications/initialized`, and returns the new + /// `(session_id, protocol_headers)` pair. The init result message is **not** + /// forwarded to the handler because the handler already processed the original + /// initialization. + async fn perform_reinitialization( + client: C, + saved_init_request: ClientJsonRpcMessage, + uri: Arc, + auth_header: Option, + custom_headers: HashMap, + max_sse_event_size: usize, + ) -> Result< + ( + Option>, + ProtocolVersion, + HashMap, + ), + StreamableHttpError, + > { + let (init_msg, new_session_id_str) = client + .post_message_with_max_sse_event_size( + uri.clone(), + saved_init_request, + None, + auth_header.clone(), + custom_headers.clone(), + max_sse_event_size, + ) + .await? + .expect_initialized::() + .await?; + + let new_session_id: Option> = new_session_id_str.map(|s| Arc::from(s.as_str())); + + let (negotiated_version, new_protocol_headers) = + negotiate_version_headers(&init_msg, custom_headers); + + let initialized_notification = ClientJsonRpcMessage::notification( + ClientNotification::InitializedNotification(InitializedNotification { + method: Default::default(), + extensions: Default::default(), + }), + ); + // SEP-2243: notifications carry no Mcp-Param-*, so an empty tool cache suffices. + let initialized_headers = build_request_headers( + &new_protocol_headers, + &initialized_notification, + &HashMap::new(), + &negotiated_version, + ); + client + .post_message_with_max_sse_event_size( + uri, + initialized_notification, + new_session_id.clone(), + auth_header, + initialized_headers, + max_sse_event_size, + ) + .await? + .expect_accepted_or_json::()?; + + Ok((new_session_id, negotiated_version, new_protocol_headers)) + } +} + +impl Worker for StreamableHttpClientWorker { + type Role = RoleClient; + type Error = StreamableHttpError; + fn is_control_message(message: &ClientJsonRpcMessage) -> bool { + match message { + ClientJsonRpcMessage::Response(_) | ClientJsonRpcMessage::Error(_) => true, + ClientJsonRpcMessage::Notification(notification) => matches!( + notification.notification, + ClientNotification::CancelledNotification(_) + ), + ClientJsonRpcMessage::Request(_) => false, + } + } + fn supports_request_cancellation() -> bool { + true + } + fn err_closed() -> Self::Error { + StreamableHttpError::TransportChannelClosed + } + fn err_join(e: tokio::task::JoinError) -> Self::Error { + StreamableHttpError::TokioJoinError(e) + } + fn config(&self) -> super::worker::WorkerConfig { + super::worker::WorkerConfig { + name: Some("StreamableHttpClientWorker".into()), + channel_buffer_capacity: self.config.channel_buffer_capacity, + } + } + async fn run( + self, + mut context: super::worker::WorkerContext, + ) -> Result<(), WorkerQuitReason> { + let channel_buffer_capacity = self.config.channel_buffer_capacity; + let (sse_worker_tx, mut sse_worker_rx) = + tokio::sync::mpsc::channel::(channel_buffer_capacity); + let config = self.config.clone(); + let transport_task_ct = context.cancellation_token.clone(); + let _drop_guard = transport_task_ct.clone().drop_guard(); + let WorkerSendRequest { + responder, + message: startup_request, + .. + } = context.recv_from_handler().await?; + let is_legacy_startup = matches!( + &startup_request, + ClientJsonRpcMessage::Request(request) + if matches!(&request.request, ClientRequest::InitializeRequest(_)) + ); + let mut saved_init_request = is_legacy_startup.then(|| startup_request.clone()); + let empty_tool_cache = HashMap::new(); + let (bootstrap_version, bootstrap_headers) = if is_legacy_startup { + (ProtocolVersion::default(), config.custom_headers.clone()) + } else { + request_version_headers( + &config.custom_headers, + &startup_request, + &ProtocolVersion::default(), + &empty_tool_cache, + ) + }; + let (message, session_id) = match self + .client + .post_message_with_max_sse_event_size( + config.uri.clone(), + startup_request, + None, + config.auth_header.clone(), + bootstrap_headers.clone(), + config.max_sse_event_size, + ) + .await + { + Ok(res) => { + let _ = responder.send(Ok(())); + res.expect_initialized::().await.map_err( + WorkerQuitReason::fatal_context("process initialize response"), + )? + } + Err(err) => { + let msg = format!("{:?}", err); + let _ = responder.send(Err(err)); + return Err(WorkerQuitReason::fatal( + StreamableHttpError::TransportChannelClosed, + msg, + )); + } + }; + let mut uses_modern_http = !is_legacy_startup; + let mut session_id: Option> = if uses_modern_http { + None + } else if let Some(session_id) = session_id { + Some(session_id.into()) + } else { + if !self.config.allow_stateless { + return Err(WorkerQuitReason::fatal( + StreamableHttpError::::MissingSessionIdInResponse, + "process initialize response", + )); + } + None + }; + let (mut negotiated_version, mut protocol_headers) = if is_legacy_startup { + negotiate_version_headers(&message, config.custom_headers.clone()) + } else { + (bootstrap_version, bootstrap_headers) + }; + // SEP-2243: tool input schemas (name -> schema) cached from tools/list responses, + // used to promote annotated tools/call arguments to Mcp-Param-* headers. + let mut tool_header_cache: HashMap> = HashMap::new(); + + // Store session info for cleanup when run() exits (not spawned, so cleanup completes before close() returns) + let mut session_cleanup_info = session_id.as_ref().map(|sid| SessionCleanupInfo { + client: self.client.clone(), + uri: config.uri.clone(), + session_id: sid.clone(), + auth_header: config.auth_header.clone(), + protocol_headers: protocol_headers.clone(), + }); + + context.send_to_handler(message).await?; + if is_legacy_startup { + let initialized_notification = context.recv_from_handler().await?; + let initialized_headers = build_request_headers( + &protocol_headers, + &initialized_notification.message, + &tool_header_cache, + &negotiated_version, + ); + self.client + .post_message_with_max_sse_event_size( + config.uri.clone(), + initialized_notification.message, + session_id.clone(), + config.auth_header.clone(), + initialized_headers, + config.max_sse_event_size, + ) + .await + .map_err(WorkerQuitReason::fatal_context( + "send initialized notification", + ))? + .expect_accepted_or_json::() + .map_err(WorkerQuitReason::fatal_context( + "process initialized notification response", + ))?; + let _ = initialized_notification.responder.send(Ok(())); + } + #[expect( + clippy::large_enum_variant, + reason = "the event is short-lived and boxing would add allocation in the event loop" + )] + enum Event { + ClientMessage(WorkerSendRequest>), + ControlMessage(WorkerSendRequest>), + StartPost(WorkerSendRequest>), + PostResult(PostResult), + RecoveryTimeout, + ServerMessage(ServerJsonRpcMessage), + StreamResult { + request_id: Option, + result: Result<(), StreamableHttpError>, + }, + } + let mut streams = tokio::task::JoinSet::new(); + let mut pending_stream_response_ids = HashSet::new(); + let mut request_stream_cancellations = + HashMap::>::new(); + let mut posts = FuturesUnordered::>>::new(); + let mut control_posts = FuturesUnordered::>>::new(); + let mut session_cancellation = CancellationToken::new(); + let mut pending_message: Option> = None; + let mut recovery_posts = VecDeque::>::new(); + let mut recovery_deadline: Option = None; + let mut retrying_recovery = false; + let mut barrier_in_flight = false; + let max_concurrent_requests = config.max_concurrent_requests.max(1); + let mut awaiting_fallback_initialized = false; + if let Some(session_id) = &session_id { + Self::spawn_common_stream( + &mut streams, + self.client.clone(), + session_id.clone(), + &config, + protocol_headers.clone(), + sse_worker_tx.clone(), + transport_task_ct.clone(), + ); + } + // Each POST uses the session and headers chosen when it starts. + // Only this loop updates the current session and protocol version. + let loop_result: Result<(), WorkerQuitReason> = 'main_loop: loop { + if retrying_recovery && recovery_posts.is_empty() && posts.is_empty() { + retrying_recovery = false; + } + if !retrying_recovery + && !recovery_posts.is_empty() + && posts.is_empty() + && control_posts.is_empty() + { + // Old POSTs have finished or reached the drain deadline. + // Retry only ordinary POSTs that returned SessionExpired, at most once each. + session_cancellation.cancel(); + recovery_deadline = None; + let recovery = tokio::select! { + _ = transport_task_ct.cancelled() => { + break 'main_loop Err(WorkerQuitReason::Cancelled); + } + result = tokio::time::timeout( + config.session_recovery_timeout, + Self::perform_reinitialization( + self.client.clone(), + saved_init_request.clone().expect("session recovery requires an initialize request"), + config.uri.clone(), + config.auth_header.clone(), + config.custom_headers.clone(), + config.max_sse_event_size, + ), + ) => result.unwrap_or(Err(StreamableHttpError::SessionRecoveryTimeout)), + }; + match recovery { + Ok((new_session_id, new_version, new_headers)) => { + streams.abort_all(); + while streams.join_next().await.is_some() {} + request_stream_cancellations.clear(); + Self::drain_queued_stream_messages( + &mut sse_worker_rx, + &mut context, + &mut pending_stream_response_ids, + ) + .await?; + Self::fail_pending_responses_except_retries( + &mut context, + &mut pending_stream_response_ids, + &recovery_posts, + ) + .await?; + session_id = new_session_id; + negotiated_version = new_version; + protocol_headers = new_headers; + session_cleanup_info = session_id.as_ref().map(|sid| SessionCleanupInfo { + client: self.client.clone(), + uri: config.uri.clone(), + session_id: sid.clone(), + auth_header: config.auth_header.clone(), + protocol_headers: protocol_headers.clone(), + }); + // Do not send controls queued during recovery to the new session. + context.advance_control_generation(); + session_cancellation = CancellationToken::new(); + if let Some(session_id) = &session_id { + Self::spawn_common_stream( + &mut streams, + self.client.clone(), + session_id.clone(), + &config, + protocol_headers.clone(), + sse_worker_tx.clone(), + transport_task_ct.clone(), + ); + } + retrying_recovery = true; + } + Err(error) => { + session_cancellation = CancellationToken::new(); + Self::fail_recovery_posts( + &mut recovery_posts, + &mut pending_stream_response_ids, + error, + ); + } + } + continue; + } + + let has_post_capacity = posts.len() < max_concurrent_requests; + let may_start = (retrying_recovery || recovery_posts.is_empty()) + && !barrier_in_flight + && has_post_capacity; + let may_receive = may_start && pending_message.is_none() && !retrying_recovery; + let queued = if retrying_recovery { + recovery_posts.front_mut() + } else { + pending_message.as_mut() + }; + let has_queued = queued.is_some(); + let can_process_queued = queued.as_ref().is_some_and(|request| { + let retry_completed = retrying_recovery + && Self::client_request_id(&request.message) + .is_some_and(|id| !pending_stream_response_ids.contains(&id)); + let ordering_satisfied = + !Self::is_ordering_barrier(&request.message, &negotiated_version) + || (posts.is_empty() && control_posts.is_empty()); + retry_completed || (may_start && ordering_satisfied) + }); + let event = tokio::select! { + _ = async { + if can_process_queued { + return; + } + let request = queued.expect("a POST is queued"); + let cancellation = request.cancellation_token().unwrap_or_default(); + tokio::select! { + _ = request.responder.closed() => {} + _ = cancellation.cancelled() => {} + } + }, if has_queued => { + let request = if retrying_recovery { + recovery_posts.pop_front() + } else { + pending_message.take() + }; + Event::StartPost(request.expect("a POST is ready to start")) + } + _ = transport_task_ct.cancelled() => { + tracing::debug!("cancelled"); + break 'main_loop Err(WorkerQuitReason::Cancelled); + } + message = context.from_handler_rx.recv(), if may_receive => { + match message { + Some(msg) => Event::ClientMessage(msg), + None => break 'main_loop Err(WorkerQuitReason::HandlerTerminated), + } + }, + message = context.control_from_handler_rx.recv(), + if control_posts.is_empty() && !session_cancellation.is_cancelled() => { + match message { + Some(msg) => Event::ControlMessage(msg), + None => break 'main_loop Err(WorkerQuitReason::HandlerTerminated), + } + }, + Some(result) = posts.next(), if !posts.is_empty() => { + Event::PostResult(result) + }, + Some(result) = control_posts.next(), if !control_posts.is_empty() => { + Event::PostResult(result) + }, + _ = async { + if let Some(deadline) = recovery_deadline { + tokio::time::sleep_until(deadline).await; + } + }, if recovery_deadline.is_some() => Event::RecoveryTimeout, + message = sse_worker_rx.recv() => { + let Some(message) = message else { + tracing::trace!("transport dropped, exiting"); + break 'main_loop Err(WorkerQuitReason::HandlerTerminated); + }; + Event::ServerMessage(message) + }, + terminated_stream = streams.join_next(), if !streams.is_empty() => { + match terminated_stream { + Some(Ok((request_id, result))) => { + Event::StreamResult { request_id, result } + } + Some(Err(error)) => Event::StreamResult { + request_id: None, + result: Err(StreamableHttpError::TokioJoinError(error)), + }, + None => continue, + } + } + }; + match event { + Event::ClientMessage(send_request) => { + pending_message = Some(send_request); + } + Event::ControlMessage(send_request) => { + if send_request.responder.is_closed() { + continue; + } + let cancellation_request_id = + Self::cancellation_request_id(&send_request.message); + let stale = send_request.control_generation() != context.control_generation(); + if stale { + // Do not send old controls to a replacement session. + let result = match cancellation_request_id { + Some(_) => Ok(()), + None => Err(StreamableHttpError::SessionExpired), + }; + let _ = send_request.responder.send(result); + continue; + } + if let Some(request_id) = cancellation_request_id { + drop(request_stream_cancellations.remove(request_id)); + pending_stream_response_ids.remove(request_id); + if uses_modern_http { + let _ = send_request.responder.send(Ok(())); + continue; + } + } + let (version, headers) = request_version_headers( + &protocol_headers, + &send_request.message, + &negotiated_version, + &tool_header_cache, + ); + control_posts.push(Self::post_request( + self.client.clone(), + &config, + send_request, + PostSession { + id: session_id.clone(), + headers, + version, + cancellation: session_cancellation.clone(), + }, + transport_task_ct.clone(), + )); + } + Event::RecoveryTimeout => { + recovery_deadline = None; + session_cancellation.cancel(); + tracing::warn!("old-session POSTs did not finish before the recovery deadline"); + } + Event::StartPost(send_request) => { + let request_id = Self::client_request_id(&send_request.message); + let send_cancelled = send_request.responder.is_closed() + || send_request + .cancellation_token() + .is_some_and(|token| token.is_cancelled()); + let retry_completed = retrying_recovery + && request_id + .as_ref() + .is_some_and(|id| !pending_stream_response_ids.contains(id)); + if send_cancelled || retry_completed { + if retrying_recovery && let Some(id) = &request_id { + pending_stream_response_ids.remove(id); + } + let _ = send_request.responder.send(Ok(())); + continue; + } + let message = &send_request.message; + let is_fallback_initialize = saved_init_request.is_none() + && matches!( + message, + ClientJsonRpcMessage::Request(request) + if matches!( + &request.request, + ClientRequest::InitializeRequest(_) + ) + ); + if is_fallback_initialize { + saved_init_request = Some(message.clone()); + let WorkerSendRequest { + message, responder, .. + } = send_request; + // Servers do not assign sessions to `server/discover`, so a + // fallback initialize starts from a clean slate: no session + // ID, no cleanup state, and no streams to tear down. + debug_assert!( + session_id.is_none() + && session_cleanup_info.is_none() + && streams.is_empty(), + "discover bootstrap must not create session state" + ); + uses_modern_http = false; + + let response = self + .client + .post_message_with_max_sse_event_size( + config.uri.clone(), + message, + None, + config.auth_header.clone(), + config.custom_headers.clone(), + config.max_sse_event_size, + ) + .await; + let response = match response { + Ok(response) => { + let _ = responder.send(Ok(())); + response + } + Err(error) => { + let _ = responder.send(Err(error)); + continue; + } + }; + let (initialize_response, new_session_id) = response + .expect_initialized::() + .await + .map_err(WorkerQuitReason::fatal_context( + "process fallback initialize response", + ))?; + session_id = new_session_id.map(Arc::from); + if session_id.is_none() && !config.allow_stateless { + return Err(WorkerQuitReason::fatal( + StreamableHttpError::::MissingSessionIdInResponse, + "process fallback initialize response", + )); + } + (negotiated_version, protocol_headers) = negotiate_version_headers( + &initialize_response, + config.custom_headers.clone(), + ); + session_cleanup_info = + session_id.as_ref().map(|session_id| SessionCleanupInfo { + client: self.client.clone(), + uri: config.uri.clone(), + session_id: session_id.clone(), + auth_header: config.auth_header.clone(), + protocol_headers: protocol_headers.clone(), + }); + context.send_to_handler(initialize_response).await?; + awaiting_fallback_initialized = true; + continue; + } + + let barrier = Self::is_ordering_barrier(message, &negotiated_version); + debug_assert!(!barrier || (posts.is_empty() && control_posts.is_empty())); + let inline_version = match message { + ClientJsonRpcMessage::Request(request) => { + request.request.get_meta().protocol_version() + } + _ => None, + }; + let (request_version, request_headers) = request_version_headers( + &protocol_headers, + message, + &negotiated_version, + &tool_header_cache, + ); + if inline_version.is_some() { + negotiated_version = request_version.clone(); + if let Ok(value) = HeaderValue::from_str(request_version.as_str()) { + protocol_headers + .insert(HeaderName::from_static("mcp-protocol-version"), value); + } + if let Some(cleanup) = &mut session_cleanup_info { + cleanup.protocol_headers = protocol_headers.clone(); + } + } + barrier_in_flight = barrier; + // The common stream can return a response before this POST finishes. + if let Some(request_id) = request_id { + pending_stream_response_ids.insert(request_id); + } + posts.push(Self::post_request( + self.client.clone(), + &config, + send_request, + PostSession { + id: session_id.clone(), + headers: request_headers, + version: request_version, + cancellation: session_cancellation.clone(), + }, + transport_task_ct.clone(), + )); + } + Event::PostResult(PostResult { + send_request, + response, + version, + }) => { + let is_control = Self::is_control_message(&send_request.message); + if !is_control { + // An ordering barrier runs without other ordinary POSTs. + barrier_in_flight = false; + } + let request_id = Self::client_request_id(&send_request.message); + if request_id + .as_ref() + .is_some_and(|id| !pending_stream_response_ids.contains(id)) + { + // A stream response or cancellation already completed this request. + let _ = send_request.responder.send(Ok(())); + continue; + } + let will_retry = + matches!(&response, Some(Err(StreamableHttpError::SessionExpired))) + && !is_control + && !retrying_recovery + && config.reinit_on_expired_session + && saved_init_request.is_some(); + let awaits_stream_response = matches!( + &response, + Some(Ok(StreamableHttpPostResponse::Accepted + | StreamableHttpPostResponse::Sse(..))) + ); + if !will_retry + && !awaits_stream_response + && let Some(id) = &request_id + { + pending_stream_response_ids.remove(id); + } + let Some(response) = response else { + let _ = send_request.responder.send(Ok(())); + continue; + }; + if will_retry { + if recovery_posts.is_empty() { + recovery_deadline = + Some(tokio::time::Instant::now() + config.session_recovery_timeout); + } + recovery_posts.push_back(send_request); + continue; + } + let request_cancellation = send_request.cancellation_registration(); + let WorkerSendRequest { + message, responder, .. + } = send_request; + let is_initialized_notification = matches!( + &message, + ClientJsonRpcMessage::Notification(notification) + if matches!( + ¬ification.notification, + ClientNotification::InitializedNotification(_) + ) + ); + let send_result = match response { + Err(e) => Err(e), + Ok(StreamableHttpPostResponse::Accepted) => { + tracing::trace!("client message accepted"); + Ok(()) + } + Ok(StreamableHttpPostResponse::Json(mut message, ..)) => { + cache_tools_from_response( + &mut tool_header_cache, + &mut message, + &version, + ); + context.send_to_handler(message).await?; + Ok(()) + } + Ok(StreamableHttpPostResponse::Sse(stream, ..)) => { + let stream_request_id = request_id; + let sse_stream = Self::response_sse_to_jsonrpc( + stream, + session_id.clone(), + self.client.clone(), + config.uri.clone(), + config.auth_header.clone(), + protocol_headers.clone(), + config.max_sse_event_size, + self.config.retry_config.clone(), + ); + let request_ct = request_cancellation + .as_ref() + .map(|registration| registration.token()) + .unwrap_or_else(|| transport_task_ct.child_token()); + // A legacy adapter may need the open stream to handle cancellation. + let stream_ct = if uses_modern_http { + request_ct.clone() + } else { + request_cancellation + .as_ref() + .map(|registration| registration.lifetime_token()) + .unwrap_or_else(|| request_ct.clone()) + }; + if let (Some(request_id), Some(registration)) = + (stream_request_id.as_ref(), request_cancellation) + { + request_stream_cancellations + .insert(request_id.clone(), registration); + } + let stream_tx = sse_worker_tx.clone(); + let origin = match &stream_request_id { + Some(id) => InboundStreamOrigin::OutboundRequest(id.clone()), + None => InboundStreamOrigin::Unassociated, + }; + streams.spawn(async move { + let result = Self::run_response_stream( + sse_stream, + stream_tx, + origin, + request_ct, + stream_ct, + uses_modern_http, + ) + .await; + (stream_request_id, result) + }); + tracing::trace!("got new sse stream"); + Ok(()) + } + }; + if send_result.is_ok() + && awaiting_fallback_initialized + && is_initialized_notification + { + if let Some(session_id) = &session_id { + Self::spawn_common_stream( + &mut streams, + self.client.clone(), + session_id.clone(), + &config, + protocol_headers.clone(), + sse_worker_tx.clone(), + transport_task_ct.clone(), + ); + } + awaiting_fallback_initialized = false; + } + let _ = responder.send(send_result); + } + Event::ServerMessage(mut json_rpc_message) => { + // Match against all pending requests, not just open response streams. + if let Some(request_id) = Self::clear_stream_response_pending( + &mut pending_stream_response_ids, + &json_rpc_message, + ) { + drop(request_stream_cancellations.remove(&request_id)); + } + cache_tools_from_response( + &mut tool_header_cache, + &mut json_rpc_message, + &negotiated_version, + ); + // send the message to the handler + if let Err(e) = context.send_to_handler(json_rpc_message).await { + break 'main_loop Err(e); + } + } + Event::StreamResult { request_id, result } => { + if let Some(request_id) = request_id { + Self::drain_queued_stream_messages( + &mut sse_worker_rx, + &mut context, + &mut pending_stream_response_ids, + ) + .await?; + let cancelled = request_stream_cancellations + .remove(&request_id) + .is_some_and(|registration| registration.token().is_cancelled()); + if pending_stream_response_ids.remove(&request_id) && !cancelled { + context + .send_to_handler(ServerJsonRpcMessage::error( + ErrorData::transport_closed( + "streamable HTTP response stream closed before its final response", + ), + Some(request_id), + )) + .await?; + } + } + if result.is_err() { + tracing::warn!( + "sse client event stream terminated with error: {:?}", + result + ); + } + } + } + }; + + // Stop outstanding http requests before deleting their session. + transport_task_ct.cancel(); + drop(posts); + drop(control_posts); + drop(pending_message); + drop(recovery_posts); + streams.abort_all(); + + // Cleanup session before returning (ensures close() waits for session deletion) + // Use a timeout to prevent indefinite hangs if the server is unresponsive + if let Some(cleanup) = session_cleanup_info { + let cleanup_session_id = cleanup.session_id.clone(); + match tokio::time::timeout( + SESSION_CLEANUP_TIMEOUT, + cleanup.client.delete_session( + cleanup.uri, + cleanup.session_id, + cleanup.auth_header, + cleanup.protocol_headers, + ), + ) + .await + { + Ok(Ok(_)) => { + tracing::info!( + session_id = cleanup_session_id.as_ref(), + "delete session success" + ) + } + Ok(Err(StreamableHttpError::ServerDoesNotSupportDeleteSession)) => { + tracing::info!( + session_id = cleanup_session_id.as_ref(), + "server doesn't support delete session" + ) + } + Ok(Err(e)) => { + tracing::error!( + session_id = cleanup_session_id.as_ref(), + "fail to delete session: {e}" + ); + } + Err(_elapsed) => { + tracing::warn!( + session_id = cleanup_session_id.as_ref(), + "session cleanup timed out after {:?}", + SESSION_CLEANUP_TIMEOUT + ); + } + } + } + + loop_result + } +} + +/// A client-agnostic HTTP transport for RMCP that supports streaming responses. +/// +/// This transport allows you to choose your preferred HTTP client implementation +/// by implementing the [`StreamableHttpClient`] trait. The transport handles +/// session management, SSE streaming, and automatic reconnection. +/// +/// # Usage +/// +/// ## Using reqwest +/// +/// ```rust,no_run +/// use rmcp::transport::StreamableHttpClientTransport; +/// +/// // Enable the reqwest feature in Cargo.toml: +/// // rmcp = { version = "0.5", features = ["transport-streamable-http-client-reqwest"] } +/// +/// let transport = StreamableHttpClientTransport::from_uri("http://localhost:8000/mcp"); +/// ``` +/// +/// ## Using a custom HTTP client +/// +/// ```rust,no_run +/// use rmcp::transport::streamable_http_client::{ +/// StreamableHttpClient, +/// StreamableHttpClientTransport, +/// StreamableHttpClientTransportConfig +/// }; +/// use std::sync::Arc; +/// use std::collections::HashMap; +/// use futures::stream::BoxStream; +/// use rmcp::model::ClientJsonRpcMessage; +/// use http::{HeaderName, HeaderValue}; +/// use sse_stream::{Sse, Error as SseError}; +/// +/// #[derive(Clone)] +/// struct MyHttpClient; +/// +/// #[derive(Debug, thiserror::Error)] +/// struct MyError; +/// +/// impl std::fmt::Display for MyError { +/// fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { +/// write!(f, "MyError") +/// } +/// } +/// +/// impl StreamableHttpClient for MyHttpClient { +/// type Error = MyError; +/// +/// async fn post_message( +/// &self, +/// _uri: Arc, +/// _message: ClientJsonRpcMessage, +/// _session_id: Option>, +/// _auth_header: Option, +/// _custom_headers: HashMap, +/// ) -> Result> { +/// todo!() +/// } +/// +/// async fn delete_session( +/// &self, +/// _uri: Arc, +/// _session_id: Arc, +/// _auth_header: Option, +/// _custom_headers: HashMap, +/// ) -> Result<(), rmcp::transport::streamable_http_client::StreamableHttpError> { +/// todo!() +/// } +/// +/// async fn get_stream( +/// &self, +/// _uri: Arc, +/// _session_id: Option>, +/// _last_event_id: Option, +/// _auth_header: Option, +/// _custom_headers: HashMap, +/// ) -> Result>, rmcp::transport::streamable_http_client::StreamableHttpError> { +/// todo!() +/// } +/// } +/// +/// let transport = StreamableHttpClientTransport::with_client( +/// MyHttpClient, +/// StreamableHttpClientTransportConfig::with_uri("http://localhost:8000/mcp") +/// ); +/// ``` +/// +/// # Feature Flags +/// +/// - `transport-streamable-http-client`: Base feature providing the generic transport infrastructure +/// - `transport-streamable-http-client-reqwest`: Includes reqwest HTTP client support with convenience methods +pub type StreamableHttpClientTransport = WorkerTransport>; + +impl StreamableHttpClientTransport { + /// Creates a new transport with a custom HTTP client implementation. + /// + /// This method allows you to use any HTTP client that implements the [`StreamableHttpClient`] trait. + /// Use this when you want to use a custom HTTP client or when the reqwest feature is not enabled. + /// + /// # Arguments + /// + /// * `client` - Your HTTP client implementation + /// * `config` - Transport configuration including the server URI + /// + /// # Example + /// + /// ```rust,no_run + /// use rmcp::transport::streamable_http_client::{ + /// StreamableHttpClient, + /// StreamableHttpClientTransport, + /// StreamableHttpClientTransportConfig + /// }; + /// use std::sync::Arc; + /// use std::collections::HashMap; + /// use futures::stream::BoxStream; + /// use rmcp::model::ClientJsonRpcMessage; + /// use http::{HeaderName, HeaderValue}; + /// use sse_stream::{Sse, Error as SseError}; + /// + /// // Define your custom client + /// #[derive(Clone)] + /// struct MyHttpClient; + /// + /// #[derive(Debug, thiserror::Error)] + /// struct MyError; + /// + /// impl std::fmt::Display for MyError { + /// fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + /// write!(f, "MyError") + /// } + /// } + /// + /// impl StreamableHttpClient for MyHttpClient { + /// type Error = MyError; + /// + /// async fn post_message( + /// &self, + /// _uri: Arc, + /// _message: ClientJsonRpcMessage, + /// _session_id: Option>, + /// _auth_header: Option, + /// _custom_headers: HashMap, + /// ) -> Result> { + /// todo!() + /// } + /// + /// async fn delete_session( + /// &self, + /// _uri: Arc, + /// _session_id: Arc, + /// _auth_header: Option, + /// _custom_headers: HashMap, + /// ) -> Result<(), rmcp::transport::streamable_http_client::StreamableHttpError> { + /// todo!() + /// } + /// + /// async fn get_stream( + /// &self, + /// _uri: Arc, + /// _session_id: Option>, + /// _last_event_id: Option, + /// _auth_header: Option, + /// _custom_headers: HashMap, + /// ) -> Result>, rmcp::transport::streamable_http_client::StreamableHttpError> { + /// todo!() + /// } + /// } + /// + /// let transport = StreamableHttpClientTransport::with_client( + /// MyHttpClient, + /// StreamableHttpClientTransportConfig::with_uri("http://localhost:8000/mcp") + /// ); + /// ``` + pub fn with_client(client: C, config: StreamableHttpClientTransportConfig) -> Self { + let worker = StreamableHttpClientWorker::new(client, config); + WorkerTransport::spawn(worker) + } +} +#[derive(Debug, Clone)] +#[non_exhaustive] +pub struct StreamableHttpClientTransportConfig { + pub uri: Arc, + pub retry_config: Arc, + pub channel_buffer_capacity: usize, + /// Maximum number of ordinary http POSTs in progress (default: 16). + /// A POST stops counting when it completes or opens an sse response stream. + /// Zero is treated as one. Cancellation and replies use a separate queue + /// with one extra POST slot and use [`Self::control_request_timeout`]. + pub max_concurrent_requests: usize, + /// Maximum time a cancellation or reply POST can run after it starts (default: five seconds). + /// Time spent waiting in the control queue does not count toward this timeout. + pub control_request_timeout: Duration, + /// Maximum wait for old POSTs to finish before session recovery (default: five seconds). + /// The new initialization handshake has a separate timeout of the same length. + /// An unfinished old POST returns [`StreamableHttpError::SessionRecoveryTimeout`] + /// and is not retried because the server may have processed it. + pub session_recovery_timeout: Duration, + /// if true, the transport will not require a session to be established + pub allow_stateless: bool, + /// The value to send in the authorization header + pub auth_header: Option, + /// Custom HTTP headers to include with every request + pub custom_headers: HashMap, + /// Maximum raw size of one SSE event accepted from the server. + /// + /// The built-in reqwest and Unix socket clients enforce this value. Custom + /// [`StreamableHttpClient`] implementations must override the corresponding + /// `*_with_max_sse_event_size` methods to enforce it. + pub max_sse_event_size: usize, + /// Automatically creates a new session when the server reports an expired + /// session (`http 404`). + /// + /// Ordinary POSTs that fail with `SessionExpired` in the same session share one + /// recovery attempt: + /// 1. Wait for old POSTs, up to [`Self::session_recovery_timeout`]. + /// 2. Repeat the original `initialize` handshake and open new streams. + /// 3. Retry each ordinary POST that failed with `SessionExpired` once. + /// + /// Control POSTs and other POST failures are not retried. If recovery or a retry + /// fails, the transport returns an error to the caller. + pub reinit_on_expired_session: bool, +} + +impl StreamableHttpClientTransportConfig { + pub fn with_uri(uri: impl Into>) -> Self { + Self { + uri: uri.into(), + ..Default::default() + } + } + + /// Set how many ordinary POSTs can run at once. One keeps them serial; zero also means one. + pub fn max_concurrent_requests(mut self, limit: usize) -> Self { + self.max_concurrent_requests = limit.max(1); + self + } + + /// Set the timeout for cancellation and reply POSTs, starting when each POST starts. + pub fn control_request_timeout(mut self, timeout: Duration) -> Self { + self.control_request_timeout = timeout; + self + } + + /// Set the separate timeouts for waiting for old POSTs and creating a replacement session. + pub fn session_recovery_timeout(mut self, timeout: Duration) -> Self { + self.session_recovery_timeout = timeout; + self + } + + /// Set the authorization header to send with requests + /// + /// # Arguments + /// + /// * `value` - A bearer token without the `Bearer ` prefix + pub fn auth_header>(mut self, value: T) -> Self { + // set our authorization header + self.auth_header = Some(value.into()); + self + } + + /// Set custom HTTP headers to include with every request + /// + /// # Arguments + /// + /// * `custom_headers` - A HashMap of header names to header values + /// + /// # Example + /// + /// ```rust,no_run + /// use std::collections::HashMap; + /// use http::{HeaderName, HeaderValue}; + /// use rmcp::transport::streamable_http_client::StreamableHttpClientTransportConfig; + /// + /// let mut headers = HashMap::new(); + /// headers.insert( + /// HeaderName::from_static("x-custom-header"), + /// HeaderValue::from_static("custom-value") + /// ); + /// + /// let config = StreamableHttpClientTransportConfig::with_uri("http://localhost:8000") + /// .custom_headers(headers); + /// ``` + pub fn custom_headers(mut self, custom_headers: HashMap) -> Self { + self.custom_headers = custom_headers; + self + } + + /// Set the maximum raw size of one SSE event accepted from the server. + pub fn max_sse_event_size(mut self, bytes: usize) -> Self { + self.max_sse_event_size = bytes; + self + } + + /// Set whether the transport should attempt transparent re-initialization on session expiration + /// See [`Self::reinit_on_expired_session`] for details. + /// # Example + /// ```rust,no_run + /// use rmcp::transport::streamable_http_client::StreamableHttpClientTransportConfig; + /// let config = StreamableHttpClientTransportConfig::with_uri("http://localhost:8000") + /// .reinit_on_expired_session(true); + /// ``` + pub fn reinit_on_expired_session(mut self, enable: bool) -> Self { + self.reinit_on_expired_session = enable; + self + } +} + +impl Default for StreamableHttpClientTransportConfig { + fn default() -> Self { + Self { + uri: "localhost".into(), + retry_config: Arc::new(ExponentialBackoff::default()), + channel_buffer_capacity: 16, + max_concurrent_requests: 16, + control_request_timeout: Duration::from_secs(5), + session_recovery_timeout: Duration::from_secs(5), + allow_stateless: true, + auth_header: None, + custom_headers: HashMap::new(), + max_sse_event_size: DEFAULT_MAX_SSE_EVENT_SIZE, + reinit_on_expired_session: true, + } + } +} + +#[cfg(test)] +mod tests { + use std::sync::Mutex; + + use serde_json::json; + + use super::*; + use crate::{ + model::{ + GetExtensions, ListToolsResult, NumberOrString, ServerRequest, ServerResult, Tool, + }, + service::InboundStreamOrigin, + }; + + #[test] + fn json_rpc_body_preview_empty_html_and_object() { + assert_eq!(json_rpc_body_preview(b""), ""); + assert_eq!(json_rpc_body_preview(b"{}"), "{}"); + assert_eq!( + json_rpc_body_preview(b"not json"), + "not json" + ); + } + + #[test] + fn json_rpc_body_preview_truncates_long_bodies() { + let long = vec![b'x'; JSON_RPC_BODY_PREVIEW_LEN + 40]; + let preview = json_rpc_body_preview(&long); + assert_eq!(preview.len(), JSON_RPC_BODY_PREVIEW_LEN); + assert!(preview.chars().all(|c| c == 'x')); + } + + #[test] + fn json_rpc_parse_error_message_includes_preview() { + let err = serde_json::from_slice::(b"{}").unwrap_err(); + let msg = json_rpc_parse_error_message(&err, b"{}"); + assert!(msg.contains("could not parse JSON response as ServerJsonRpcMessage")); + assert!(msg.contains("{}"), "missing body preview: {msg}"); + } + + #[expect( + deprecated, + reason = "Sampling is deprecated by SEP-2577 but remains the canonical restricted request" + )] + fn sampling_request_message(id: i64) -> ServerJsonRpcMessage { + use crate::model::{CreateMessageRequest, CreateMessageRequestParams, SamplingMessage}; + ServerJsonRpcMessage::request( + ServerRequest::CreateMessageRequest(CreateMessageRequest::new( + CreateMessageRequestParams::new(vec![SamplingMessage::user_text("hi")], 16), + )), + NumberOrString::Number(id), + ) + } + + #[tokio::test] + async fn execute_sse_stream_marks_inbound_requests_with_origin() { + for origin in [ + InboundStreamOrigin::Unassociated, + InboundStreamOrigin::OutboundRequest(RequestId::Number(3)), + ] { + let response = ServerJsonRpcMessage::response( + ServerResult::ListToolsResult(ListToolsResult::default()), + NumberOrString::Number(1), + ); + let stream = futures::stream::iter([Ok(sampling_request_message(9)), Ok(response)]); + let (tx, mut rx) = tokio::sync::mpsc::channel(4); + StreamableHttpClientWorker::::execute_sse_stream( + stream, + tx, + origin.clone(), + false, + CancellationToken::new(), + ) + .await + .expect("stream completes"); + + let ServerJsonRpcMessage::Request(request) = + rx.recv().await.expect("request forwarded") + else { + panic!("expected request first"); + }; + assert_eq!( + request.request.extensions().get::(), + Some(&origin), + "inbound requests must carry their stream origin" + ); + // Responses are correlated by JSON-RPC id; no marker needed or added. + assert!(matches!( + rx.recv().await.expect("response forwarded"), + ServerJsonRpcMessage::Response(_) + )); + } + } + + type ReconnectAttempt = (Option, Option); + + #[derive(Clone, Default)] + struct StatelessReconnectClient { + reconnects: Arc>>, + } + + impl StreamableHttpClient for StatelessReconnectClient { + type Error = std::io::Error; + + async fn post_message( + &self, + _uri: Arc, + _message: ClientJsonRpcMessage, + _session_id: Option>, + _auth_header: Option, + _custom_headers: HashMap, + ) -> Result> { + Err(StreamableHttpError::UnexpectedServerResponse( + "unexpected POST".into(), + )) + } + + async fn delete_session( + &self, + _uri: Arc, + _session_id: Arc, + _auth_header: Option, + _custom_headers: HashMap, + ) -> Result<(), StreamableHttpError> { + Ok(()) + } + + async fn get_stream( + &self, + _uri: Arc, + session_id: Option>, + last_event_id: Option, + _auth_header: Option, + _custom_headers: HashMap, + ) -> Result> { + self.reconnects + .lock() + .expect("lock reconnects") + .push((session_id.map(|id| id.to_string()), last_event_id)); + let response = ServerJsonRpcMessage::response( + ServerResult::ListToolsResult(ListToolsResult::default()), + NumberOrString::Number(1), + ); + Ok(futures::stream::once(async move { + Ok(Sse { + event: None, + data: Some(serde_json::to_string(&response).expect("serialize response")), + id: Some("event-1".into()), + retry: None, + }) + }) + .boxed()) + } + } + + #[tokio::test] + async fn stateless_response_reconnects_with_last_event_id() { + let initial = futures::stream::iter([Ok(Sse { + event: None, + data: None, + id: Some("event-0".into()), + retry: Some(0), + })]) + .boxed(); + let client = StatelessReconnectClient::default(); + let reconnects = client.reconnects.clone(); + let stream = + StreamableHttpClientWorker::::response_sse_to_jsonrpc( + initial, + None, + client, + Arc::from("http://localhost/mcp"), + None, + HashMap::new(), + DEFAULT_MAX_SSE_EVENT_SIZE, + Arc::new(ExponentialBackoff { + max_times: Some(1), + base_duration: Duration::ZERO, + max_delay: None, + }), + ); + let mut stream = std::pin::pin!(stream); + + let message = stream.next().await.expect("replayed response").unwrap(); + + assert!(matches!(message, ServerJsonRpcMessage::Response(_))); + assert_eq!( + reconnects.lock().expect("lock reconnects").as_slice(), + &[(None, Some("event-0".into()))] + ); + } + + #[derive(Clone, Default)] + struct ResumedRequestClient { + reconnects: Arc>>, + } + + impl StreamableHttpClient for ResumedRequestClient { + type Error = std::io::Error; + + async fn post_message( + &self, + _uri: Arc, + _message: ClientJsonRpcMessage, + _session_id: Option>, + _auth_header: Option, + _custom_headers: HashMap, + ) -> Result> { + Err(StreamableHttpError::UnexpectedServerResponse( + "unexpected POST".into(), + )) + } + + async fn delete_session( + &self, + _uri: Arc, + _session_id: Arc, + _auth_header: Option, + _custom_headers: HashMap, + ) -> Result<(), StreamableHttpError> { + Ok(()) + } + + async fn get_stream( + &self, + _uri: Arc, + session_id: Option>, + last_event_id: Option, + _auth_header: Option, + _custom_headers: HashMap, + ) -> Result> { + self.reconnects + .lock() + .expect("lock reconnects") + .push((session_id.map(|id| id.to_string()), last_event_id)); + let request = sampling_request_message(9); + let response = ServerJsonRpcMessage::response( + ServerResult::ListToolsResult(ListToolsResult::default()), + NumberOrString::Number(1), + ); + // Stay open after the response, like a live connection, so the + // post-response drain in `execute_sse_stream` doesn't trigger + // further reconnects. + Ok(futures::stream::iter([request, response].map(|message| { + Ok(Sse { + event: None, + data: Some(serde_json::to_string(&message).expect("serialize message")), + id: None, + retry: None, + }) + })) + .chain(futures::stream::pending()) + .boxed()) + } + } + + /// SEP-1699 resumes a broken POST SSE stream via GET + Last-Event-ID + /// beneath `execute_sse_stream`, so the SEP-2260 origin marker must span + /// resumes; if reconnection were hoisted above the marker attach point, + /// replayed associated requests would be wrongly rejected with -32602. + #[tokio::test] + async fn resumed_post_stream_requests_keep_outbound_origin() { + let initial = futures::stream::iter([Ok(Sse { + event: None, + data: None, + id: Some("e1".into()), + retry: Some(0), + })]) + .boxed(); + let client = ResumedRequestClient::default(); + let reconnects = client.reconnects.clone(); + let sse_stream = + StreamableHttpClientWorker::::response_sse_to_jsonrpc( + initial, + None, + client, + Arc::from("http://localhost/mcp"), + None, + HashMap::new(), + DEFAULT_MAX_SSE_EVENT_SIZE, + Arc::new(ExponentialBackoff { + max_times: Some(1), + base_duration: Duration::ZERO, + max_delay: None, + }), + ); + + let origin = InboundStreamOrigin::OutboundRequest(RequestId::Number(3)); + let (tx, mut rx) = tokio::sync::mpsc::channel(4); + StreamableHttpClientWorker::::execute_sse_stream( + sse_stream, + tx, + origin.clone(), + true, + CancellationToken::new(), + ) + .await + .expect("stream completes"); + + assert_eq!( + reconnects.lock().expect("lock reconnects").as_slice(), + &[(None, Some("e1".into()))], + "the request must arrive on the resumed connection" + ); + let ServerJsonRpcMessage::Request(request) = rx.recv().await.expect("request forwarded") + else { + panic!("expected request first"); + }; + assert_eq!( + request.request.extensions().get::(), + Some(&origin), + "origin marker must survive SSE resumption" + ); + assert!(matches!( + rx.recv().await.expect("response forwarded"), + ServerJsonRpcMessage::Response(_) + )); + } + + fn tool(name: &'static str, annotation: serde_json::Value) -> Tool { + let schema = json!({ + "type": "object", + "properties": { + "value": annotation, + }, + }); + Tool::new( + name, + name, + Arc::new(schema.as_object().expect("object schema").clone()), + ) + } + + #[test] + fn cache_tools_removes_invalid_header_annotations() { + let valid = tool( + "valid", + json!({ "type": "string", "x-mcp-header": "Value" }), + ); + let invalid = tool("invalid", json!({ "type": "string", "x-mcp-header": "" })); + let mut message = ServerJsonRpcMessage::response( + ServerResult::ListToolsResult(ListToolsResult::with_all_items(vec![valid, invalid])), + NumberOrString::Number(1), + ); + let mut cache = HashMap::new(); + + cache_tools_from_response(&mut cache, &mut message, &ProtocolVersion::V_2026_07_28); + + let ServerJsonRpcMessage::Response(response) = &mut message else { + panic!("expected tools/list response"); + }; + let ServerResult::ListToolsResult(result) = &mut response.result else { + panic!("expected tools/list result"); + }; + assert_eq!( + ( + result + .tools + .iter() + .map(|tool| tool.name.as_ref()) + .collect::>(), + cache.keys().map(String::as_str).collect::>(), + ), + (vec!["valid"], vec!["valid"]) + ); + } + + #[test] + fn cache_tools_preserves_pre_standard_header_results() { + let invalid = tool("legacy", json!({ "type": "string", "x-mcp-header": "" })); + let mut message = ServerJsonRpcMessage::response( + ServerResult::ListToolsResult(ListToolsResult::with_all_items(vec![invalid])), + NumberOrString::Number(1), + ); + let mut cache = HashMap::new(); + + cache_tools_from_response(&mut cache, &mut message, &ProtocolVersion::V_2025_11_25); + + let ServerJsonRpcMessage::Response(response) = message else { + panic!("expected tools/list response"); + }; + let ServerResult::ListToolsResult(result) = response.result else { + panic!("expected tools/list result"); + }; + assert_eq!( + result + .tools + .iter() + .map(|tool| tool.name.as_ref()) + .collect::>(), + vec!["legacy"] + ); + } + + #[cfg(feature = "transport-streamable-http-client-reqwest")] + #[test] + fn clear_stream_response_pending_accepts_stringified_numeric_id() { + let mut pending = HashSet::from([NumberOrString::Number(1)]); + let response = ServerJsonRpcMessage::response( + ServerResult::ListToolsResult(ListToolsResult::default()), + NumberOrString::String("1".into()), + ); + + let matched_id = + StreamableHttpClientWorker::::clear_stream_response_pending( + &mut pending, + &response, + ); + + assert_eq!(matched_id, Some(NumberOrString::Number(1))); + assert!(pending.is_empty()); + } + + #[cfg(feature = "transport-streamable-http-client-reqwest")] + #[test] + fn clear_stream_response_pending_prefers_exact_string_id() { + let string_id = NumberOrString::String("1".into()); + let mut pending = HashSet::from([NumberOrString::Number(1), string_id.clone()]); + let response = ServerJsonRpcMessage::response( + ServerResult::ListToolsResult(ListToolsResult::default()), + string_id.clone(), + ); + + let matched_id = + StreamableHttpClientWorker::::clear_stream_response_pending( + &mut pending, + &response, + ); + + assert_eq!(matched_id, Some(string_id)); + assert_eq!(pending, HashSet::from([NumberOrString::Number(1)])); + } +} diff --git a/vendor/rmcp/src/transport/streamable_http_server.rs b/vendor/rmcp/src/transport/streamable_http_server.rs new file mode 100644 index 00000000..df1945ab --- /dev/null +++ b/vendor/rmcp/src/transport/streamable_http_server.rs @@ -0,0 +1,6 @@ +pub mod session; +#[cfg(all(feature = "transport-streamable-http-server", not(feature = "local")))] +pub mod tower; +pub use session::{RestoreOutcome, SessionId, SessionManager, SessionRestoreMarker}; +#[cfg(all(feature = "transport-streamable-http-server", not(feature = "local")))] +pub use tower::{StreamableHttpServerConfig, StreamableHttpService}; diff --git a/vendor/rmcp/src/transport/streamable_http_server/session.rs b/vendor/rmcp/src/transport/streamable_http_server/session.rs new file mode 100644 index 00000000..ea2e85b2 --- /dev/null +++ b/vendor/rmcp/src/transport/streamable_http_server/session.rs @@ -0,0 +1,174 @@ +//! Session management for the Streamable HTTP transport. +//! +//! A *session* groups the logically related interactions between a single MCP +//! client and the server, starting from the `initialize` handshake. The server +//! assigns each session a unique [`SessionId`] (returned to the client via the +//! `Mcp-Session-Id` response header) and the client includes that ID on every +//! subsequent request. +//! +//! Two tool calls carrying the same session ID come from the same logical +//! session; different IDs mean different clients or conversations. +//! +//! # Implementations +//! +//! * [`local::LocalSessionManager`] — in-memory session store (default). +//! * [`never::NeverSessionManager`] — rejects all session operations, used +//! when legacy session mode is disabled. +//! +//! # Custom session managers +//! +//! Implement the [`SessionManager`] trait to back sessions with a database, +//! Redis, or any other external store. + +use std::sync::Arc; + +use futures::Stream; + +pub use crate::transport::common::server_side_http::{ServerSseMessage, SessionId}; +use crate::{ + RoleServer, + model::{ClientJsonRpcMessage, ServerJsonRpcMessage}, +}; + +pub mod local; +pub mod never; +pub mod store; + +pub use store::{ + EventId, EventStore, EventStoreError, EventStream, SessionState, SessionStore, + SessionStoreError, StreamId, +}; + +/// Extension marker inserted into the `initialize` request extensions during a +/// session restore replay. Handlers can check for its presence to distinguish a +/// cross-instance restore from a genuine client-initiated `initialize` request. +/// +/// ```rust,ignore +/// if req.extensions().get::().is_some() { +/// // this is a restore replay, not a fresh client connection +/// } +/// ``` +#[non_exhaustive] +#[derive(Debug, Clone)] +pub struct SessionRestoreMarker { + pub id: SessionId, +} + +/// The outcome of a [`SessionManager::restore_session`] call. +#[non_exhaustive] +#[derive(Debug)] +pub enum RestoreOutcome { + /// The session was just re-created from external state; the caller must + /// spawn an MCP handler against the returned transport and replay the + /// `initialize` handshake. + Restored(T), + /// The session was already present in memory (e.g. a concurrent request + /// already restored it). The caller should proceed as if `has_session` + /// had returned `true` — no further action is required. + AlreadyPresent, + /// This session manager does not support external-store restore. + /// The caller should fall through to the normal 404 response. + NotSupported, +} + +/// Controls how MCP sessions are created, validated, and closed. +/// +/// The `StreamableHttpService` calls into this +/// trait for every HTTP request that carries (or should carry) a session ID. +/// +/// See the [module-level docs](self) for background on sessions. +/// +/// # SEP-2260 request association +/// +/// Server-initiated requests issued while handling a client request carry an +/// [`OriginatingRequestId`](crate::service::OriginatingRequestId) marker in +/// their non-serialized `Extensions`; the bundled local session manager uses +/// it to deliver such requests on the originating request's SSE stream. +/// Implementations that serialize messages between processes lose the marker +/// and fall back to the standalone stream, violating SEP-2260 for 2026-07-28+ +/// clients; they need their own association mechanism. +pub trait SessionManager: Send + Sync + 'static { + type Error: std::error::Error + Send + 'static; + type Transport: crate::transport::Transport; + + /// Create a new session and return its ID together with the transport + /// that will be used to exchange MCP messages within this session. + fn create_session( + &self, + ) -> impl Future> + Send; + + /// Forward the first message (the `initialize` request) to the session. + fn initialize_session( + &self, + id: &SessionId, + message: ClientJsonRpcMessage, + ) -> impl Future> + Send; + + /// Return `true` if a session with the given ID exists and is active. + fn has_session(&self, id: &SessionId) + -> impl Future> + Send; + + /// Close and remove the session. Corresponds to an HTTP DELETE request + /// with `Mcp-Session-Id`. + fn close_session(&self, id: &SessionId) + -> impl Future> + Send; + + /// Route a client request into the session and return an SSE stream + /// carrying the server's response(s). + fn create_stream( + &self, + id: &SessionId, + message: ClientJsonRpcMessage, + ) -> impl Future< + Output = Result + Send + Sync + 'static, Self::Error>, + > + Send; + + /// Accept a notification, response, or error message from the client + /// without producing a response stream. + fn accept_message( + &self, + id: &SessionId, + message: ClientJsonRpcMessage, + ) -> impl Future> + Send; + + /// Create an SSE stream not tied to a specific client request (HTTP GET). + fn create_standalone_stream( + &self, + id: &SessionId, + ) -> impl Future< + Output = Result + Send + Sync + 'static, Self::Error>, + > + Send; + + /// Resume an SSE stream from the given `Last-Event-ID`, replaying any + /// events the client missed. + fn resume( + &self, + id: &SessionId, + last_event_id: String, + ) -> impl Future< + Output = Result + Send + Sync + 'static, Self::Error>, + > + Send; + + /// Attempt to restore a previously-known session from external state, + /// creating a fresh in-memory session worker with the given `id`. + /// + /// See [`RestoreOutcome`] for the three possible results: + /// - [`RestoreOutcome::Restored`] — session re-created; caller must spawn + /// an MCP handler and replay the `initialize` handshake. + /// - [`RestoreOutcome::AlreadyPresent`] — session is already in memory + /// (e.g. a concurrent request restored it first); caller proceeds + /// normally. + /// - [`RestoreOutcome::NotSupported`] (default) — this session manager + /// does not support external-store restore; caller returns 404. + fn restore_session( + &self, + _id: SessionId, + ) -> impl Future, Self::Error>> + Send { + futures::future::ready(Ok(RestoreOutcome::NotSupported)) + } + + /// Return the shared event store used for resumable SSE streams. + fn event_store(&self) -> Option> { + None + } +} diff --git a/vendor/rmcp/src/transport/streamable_http_server/session/local.rs b/vendor/rmcp/src/transport/streamable_http_server/session/local.rs new file mode 100644 index 00000000..e03e5b73 --- /dev/null +++ b/vendor/rmcp/src/transport/streamable_http_server/session/local.rs @@ -0,0 +1,1376 @@ +use std::{ + collections::{HashMap, HashSet, VecDeque}, + num::ParseIntError, + sync::Arc, + time::{Duration, Instant}, +}; + +use futures::{Stream, StreamExt}; +use thiserror::Error; +use tokio::sync::{ + mpsc::{Receiver, Sender}, + oneshot, +}; +use tokio_stream::wrappers::ReceiverStream; +use tracing::instrument; + +use crate::{ + RoleServer, + model::{ + CancelledNotificationParam, ClientJsonRpcMessage, ClientNotification, ClientRequest, + JsonRpcNotification, JsonRpcRequest, Notification, ProgressNotificationParam, + ProgressToken, RequestId, ServerJsonRpcMessage, ServerNotification, + }, + transport::{ + WorkerTransport, + common::server_side_http::{SessionId, session_id}, + worker::{Worker, WorkerContext, WorkerQuitReason, WorkerSendRequest}, + }, +}; + +#[derive(Debug, Default)] +#[non_exhaustive] +pub struct LocalSessionManager { + pub sessions: tokio::sync::RwLock>, + pub session_config: SessionConfig, + event_store: Option>, +} + +impl LocalSessionManager { + /// Configure this session manager to use a shared event store. + pub fn with_event_store(mut self, event_store: Arc) -> Self { + self.event_store = Some(event_store); + self + } +} + +#[derive(Debug, Error)] +#[non_exhaustive] +pub enum LocalSessionManagerError { + #[error("Session not found: {0}")] + SessionNotFound(SessionId), + #[error("Session error: {0}")] + SessionError(#[from] SessionError), + #[error("Invalid event id: {0}")] + InvalidEventId(#[from] EventIdParseError), +} +impl SessionManager for LocalSessionManager { + type Error = LocalSessionManagerError; + type Transport = WorkerTransport; + async fn create_session(&self) -> Result<(SessionId, Self::Transport), Self::Error> { + let id = session_id(); + let (handle, worker) = create_local_session_with_event_store( + id.clone(), + self.session_config.clone(), + self.event_store.clone(), + ); + self.sessions.write().await.insert(id.clone(), handle); + Ok((id, WorkerTransport::spawn(worker))) + } + async fn initialize_session( + &self, + id: &SessionId, + message: ClientJsonRpcMessage, + ) -> Result { + let sessions = self.sessions.read().await; + let handle = sessions + .get(id) + .ok_or(LocalSessionManagerError::SessionNotFound(id.clone()))?; + let response = handle.initialize(message).await?; + Ok(response) + } + async fn close_session(&self, id: &SessionId) -> Result<(), Self::Error> { + let handle = { + let mut sessions = self.sessions.write().await; + sessions.remove(id) + }; + if let Some(handle) = handle { + match handle.close().await { + // Worker already exited — nothing left to clean up. + Ok(()) | Err(SessionError::SessionServiceTerminated) => {} + Err(e) => return Err(e.into()), + } + } + Ok(()) + } + async fn has_session(&self, id: &SessionId) -> Result { + let sessions = self.sessions.read().await; + Ok(sessions.contains_key(id)) + } + async fn create_stream( + &self, + id: &SessionId, + message: ClientJsonRpcMessage, + ) -> Result + Send + 'static, Self::Error> { + let sessions = self.sessions.read().await; + let handle = sessions + .get(id) + .ok_or(LocalSessionManagerError::SessionNotFound(id.clone()))?; + let receiver = handle.establish_request_wise_channel().await?; + let http_request_id = receiver.http_request_id; + handle.push_message(message, http_request_id).await?; + Ok(ReceiverStream::new(receiver.inner)) + } + + async fn create_standalone_stream( + &self, + id: &SessionId, + ) -> Result + Send + 'static, Self::Error> { + let sessions = self.sessions.read().await; + let handle = sessions + .get(id) + .ok_or(LocalSessionManagerError::SessionNotFound(id.clone()))?; + let receiver = handle.establish_common_channel().await?; + Ok(ReceiverStream::new(receiver.inner)) + } + + async fn resume( + &self, + id: &SessionId, + last_event_id: String, + ) -> Result + Send + 'static, Self::Error> { + if let Some(event_store) = &self.event_store { + let stream = event_store + .replay_events_after(&last_event_id) + .await + .map_err(SessionError::EventStore)?; + return Ok(stream.left_stream()); + } + let sessions = self.sessions.read().await; + let handle = sessions + .get(id) + .ok_or(LocalSessionManagerError::SessionNotFound(id.clone()))?; + let receiver = handle.resume(last_event_id.parse()?).await?; + Ok(ReceiverStream::new(receiver.inner).right_stream()) + } + + async fn accept_message( + &self, + id: &SessionId, + message: ClientJsonRpcMessage, + ) -> Result<(), Self::Error> { + let sessions = self.sessions.read().await; + let handle = sessions + .get(id) + .ok_or(LocalSessionManagerError::SessionNotFound(id.clone()))?; + handle.push_message(message, None).await?; + Ok(()) + } + + async fn restore_session( + &self, + id: SessionId, + ) -> Result, Self::Error> { + let mut sessions = self.sessions.write().await; + if sessions.contains_key(&id) { + // A concurrent request already restored this session. + return Ok(RestoreOutcome::AlreadyPresent); + } + let (handle, worker) = create_local_session_with_event_store( + id.clone(), + self.session_config.clone(), + self.event_store.clone(), + ); + sessions.insert(id, handle); + Ok(RestoreOutcome::Restored(WorkerTransport::spawn(worker))) + } + + fn event_store(&self) -> Option> { + self.event_store.clone() + } +} + +/// `/request_id>` +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +pub struct EventId { + http_request_id: Option, + index: usize, +} + +impl std::fmt::Display for EventId { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.index)?; + match &self.http_request_id { + Some(http_request_id) => write!(f, "/{http_request_id}"), + None => write!(f, ""), + } + } +} + +#[derive(Debug, Clone, Error)] +#[non_exhaustive] +pub enum EventIdParseError { + #[error("Invalid index: {0}")] + InvalidIndex(ParseIntError), + #[error("Invalid numeric request id: {0}")] + InvalidNumericRequestId(ParseIntError), + #[error("Missing request id type")] + InvalidRequestIdType, + #[error("Missing request id")] + MissingRequestId, +} + +impl std::str::FromStr for EventId { + type Err = EventIdParseError; + fn from_str(s: &str) -> Result { + if let Some((index, request_id)) = s.split_once("/") { + let index = usize::from_str(index).map_err(EventIdParseError::InvalidIndex)?; + let request_id = u64::from_str(request_id).map_err(EventIdParseError::InvalidIndex)?; + Ok(EventId { + http_request_id: Some(request_id), + index, + }) + } else { + let index = usize::from_str(s).map_err(EventIdParseError::InvalidIndex)?; + Ok(EventId { + http_request_id: None, + index, + }) + } + } +} + +use super::{ + EventStore, EventStoreError, RestoreOutcome, ServerSseMessage, SessionManager, StreamId, +}; + +struct CachedTx { + tx: Sender, + cache: VecDeque, + http_request_id: Option, + capacity: usize, + starting_index: usize, + stream_id: StreamId, + event_store: Option>, +} + +impl CachedTx { + fn new( + tx: Sender, + http_request_id: Option, + starting_index: usize, + stream_id: StreamId, + event_store: Option>, + ) -> Self { + Self { + cache: VecDeque::with_capacity(tx.capacity()), + capacity: tx.capacity(), + tx, + http_request_id, + starting_index, + stream_id, + event_store, + } + } + fn new_common( + tx: Sender, + session_id: &SessionId, + event_store: Option>, + ) -> Self { + Self::new(tx, None, 0, format!("{session_id}:common"), event_store) + } + + fn next_event_id(&self) -> EventId { + let index = self.cache.back().map_or(self.starting_index, |m| { + m.event_id + .as_deref() + .unwrap_or_default() + .parse::() + .expect("valid event id") + .index + + 1 + }); + EventId { + http_request_id: self.http_request_id, + index, + } + } + + async fn send(&mut self, message: ServerJsonRpcMessage) -> Result<(), SessionError> { + self.store_cache_and_send(ServerSseMessage::from_message(message)) + .await + } + + async fn send_priming(&mut self, retry: Duration) -> Result<(), SessionError> { + self.store_cache_and_send(ServerSseMessage::retry(retry)) + .await + } + + async fn store_cache_and_send( + &mut self, + mut event: ServerSseMessage, + ) -> Result<(), SessionError> { + let event_id = if let Some(event_store) = &self.event_store { + event_store + .store_event(&self.stream_id, &event) + .await + .map_err(SessionError::EventStore)? + } else { + self.next_event_id().to_string() + }; + event.event_id = Some(event_id); + self.cache_and_send(event).await; + Ok(()) + } + + async fn cache_and_send(&mut self, message: ServerSseMessage) { + if self.cache.len() >= self.capacity { + self.cache.pop_front(); + self.cache.push_back(message.clone()); + } else { + self.cache.push_back(message.clone()); + } + let _ = self.tx.send(message).await.inspect_err(|e| { + let event_id = &e.0.event_id; + tracing::trace!(?event_id, "trying to send message in a closed session") + }); + } + + async fn sync(&mut self, index: usize) -> Result<(), SessionError> { + let Some(front) = self.cache.front() else { + return Ok(()); + }; + let front_event_id = front + .event_id + .as_deref() + .unwrap_or_default() + .parse::()?; + let sync_index = index.saturating_sub(front_event_id.index); + if sync_index > self.cache.len() { + // invalid index + return Err(SessionError::InvalidEventId); + } + for message in self.cache.iter().skip(sync_index) { + let send_result = self.tx.send(message.clone()).await; + if send_result.is_err() { + let event_id: EventId = message.event_id.as_deref().unwrap_or_default().parse()?; + return Err(SessionError::ChannelClosed(Some(event_id.index as u64))); + } + } + Ok(()) + } +} + +struct HttpRequestWise { + resources: HashSet, + tx: CachedTx, + completed_at: Option, +} + +type HttpRequestId = u64; +#[derive(Debug, Clone, Hash, PartialEq, Eq)] +enum ResourceKey { + McpRequestId(RequestId), + ProgressToken(ProgressToken), +} + +pub struct LocalSessionWorker { + id: SessionId, + next_http_request_id: HttpRequestId, + tx_router: HashMap, + resource_router: HashMap, + common: CachedTx, + /// Shadow senders for secondary SSE streams (e.g. from POST EventSource + /// reconnections). These keep the HTTP connections alive via SSE keep-alive + /// without receiving notifications, preventing MCP clients from entering + /// infinite reconnect loops when multiple EventSource connections compete + /// to replace the common channel. + shadow_txs: Vec>, + event_rx: Receiver, + session_config: SessionConfig, + event_store: Option>, +} + +impl LocalSessionWorker { + pub fn id(&self) -> &SessionId { + &self.id + } +} + +#[derive(Debug, Error)] +#[non_exhaustive] +pub enum SessionError { + #[error("Invalid request id: {0}")] + DuplicatedRequestId(HttpRequestId), + #[error("Channel closed: {0:?}")] + ChannelClosed(Option), + #[error("Cannot parse event id: {0}")] + EventIdParseError(#[from] EventIdParseError), + #[error("Session service terminated")] + SessionServiceTerminated, + #[error("Invalid event id")] + InvalidEventId, + #[error("IO error: {0}")] + Io(#[from] std::io::Error), + #[error("Event store error: {0}")] + EventStore(#[source] EventStoreError), +} + +impl From for std::io::Error { + fn from(value: SessionError) -> Self { + match value { + SessionError::Io(io) => io, + _ => std::io::Error::other(format!("Session error: {value}")), + } + } +} + +enum OutboundChannel { + RequestWise { id: HttpRequestId, close: bool }, + Common, +} +#[derive(Debug)] +#[non_exhaustive] +pub struct StreamableHttpMessageReceiver { + pub http_request_id: Option, + pub inner: Receiver, +} + +impl LocalSessionWorker { + fn unregister_resource(&mut self, resource: &ResourceKey) { + let Some(http_request_id) = self.resource_router.remove(resource) else { + return; + }; + tracing::trace!(?resource, http_request_id, "unregister resource"); + let Some(channel) = self.tx_router.get_mut(&http_request_id) else { + tracing::warn!(http_request_id, "http request wise channel not found"); + return; + }; + if !channel.resources.is_empty() && !matches!(resource, ResourceKey::McpRequestId(_)) { + return; + } + tracing::debug!(http_request_id, "close http request wise channel"); + let resources: Vec<_> = channel.resources.drain().collect(); + channel.completed_at = Some(Instant::now()); + // Close the sender so the client's SSE stream ends, + // but keep the entry so the cache is available for + // late resume requests. + let (closed_tx, _) = tokio::sync::mpsc::channel(1); + channel.tx.tx = closed_tx; + for resource in resources { + self.resource_router.remove(&resource); + } + } + fn register_resource(&mut self, resource: ResourceKey, http_request_id: HttpRequestId) { + tracing::trace!(?resource, http_request_id, "register resource"); + if let Some(channel) = self.tx_router.get_mut(&http_request_id) { + channel.resources.insert(resource.clone()); + self.resource_router.insert(resource, http_request_id); + } + } + fn register_request( + &mut self, + request: &JsonRpcRequest, + http_request_id: HttpRequestId, + ) { + use crate::model::GetMeta; + self.register_resource( + ResourceKey::McpRequestId(request.id.clone()), + http_request_id, + ); + if let Some(progress_token) = request.request.get_meta().get_progress_token() { + self.register_resource( + ResourceKey::ProgressToken(progress_token.clone()), + http_request_id, + ); + } + } + fn catch_cancellation_notification( + &mut self, + notification: &JsonRpcNotification, + ) { + if let ClientNotification::CancelledNotification(n) = ¬ification.notification + && let Some(request_id) = n.params.request_id.clone() + { + let resource = ResourceKey::McpRequestId(request_id); + self.unregister_resource(&resource); + } + } + fn evict_expired_channels(&mut self) { + let ttl = self.session_config.completed_cache_ttl; + self.tx_router + .retain(|_, rw| rw.completed_at.is_none_or(|at| at.elapsed() < ttl)); + } + fn next_http_request_id(&mut self) -> HttpRequestId { + let id = self.next_http_request_id; + self.next_http_request_id = self.next_http_request_id.wrapping_add(1); + id + } + async fn establish_request_wise_channel( + &mut self, + ) -> Result { + let http_request_id = self.next_http_request_id(); + let (tx, rx) = tokio::sync::mpsc::channel(self.session_config.channel_capacity); + let mut cached_tx = CachedTx::new( + tx, + Some(http_request_id), + 0, + uuid::Uuid::new_v4().to_string(), + self.event_store.clone(), + ); + if let Some(retry) = self.session_config.sse_retry { + cached_tx.send_priming(retry).await?; + } + self.tx_router.insert( + http_request_id, + HttpRequestWise { + resources: Default::default(), + tx: cached_tx, + completed_at: None, + }, + ); + tracing::debug!(http_request_id, "establish new request wise channel"); + Ok(StreamableHttpMessageReceiver { + http_request_id: Some(http_request_id), + inner: rx, + }) + } + fn resolve_outbound_channel(&self, message: &ServerJsonRpcMessage) -> OutboundChannel { + match &message { + // SEP-2260: requests carrying an OriginatingRequestId marker ride the + // originating request's SSE stream, never the standalone GET stream. + ServerJsonRpcMessage::Request(json_rpc_request) => { + use crate::model::GetExtensions; + let originating = json_rpc_request + .request + .extensions() + .get::(); + match originating { + Some(originating) => match self + .resource_router + .get(&ResourceKey::McpRequestId(originating.0.clone())) + { + Some(id) => OutboundChannel::RequestWise { + id: *id, + close: false, + }, + None => { + tracing::warn!( + originating_request_id = %originating.0, + "associated server request could not be routed to its \ + originating stream (request completed or association \ + lost); falling back to standalone stream" + ); + OutboundChannel::Common + } + }, + None => OutboundChannel::Common, + } + } + ServerJsonRpcMessage::Notification(JsonRpcNotification { + notification: + ServerNotification::ProgressNotification(Notification { + params: ProgressNotificationParam { progress_token, .. }, + .. + }), + .. + }) => { + let id = self + .resource_router + .get(&ResourceKey::ProgressToken(progress_token.clone())); + + if let Some(id) = id { + OutboundChannel::RequestWise { + id: *id, + close: false, + } + } else { + OutboundChannel::Common + } + } + ServerJsonRpcMessage::Notification(JsonRpcNotification { + notification: + ServerNotification::CancelledNotification(Notification { + params: CancelledNotificationParam { request_id, .. }, + .. + }), + .. + }) => { + if let Some(req_id) = request_id { + if let Some(id) = self + .resource_router + .get(&ResourceKey::McpRequestId(req_id.clone())) + { + OutboundChannel::RequestWise { + id: *id, + close: false, + } + } else { + OutboundChannel::Common + } + } else { + OutboundChannel::Common + } + } + ServerJsonRpcMessage::Notification(_) => OutboundChannel::Common, + ServerJsonRpcMessage::Response(json_rpc_response) => { + if let Some(id) = self + .resource_router + .get(&ResourceKey::McpRequestId(json_rpc_response.id.clone())) + { + OutboundChannel::RequestWise { + id: *id, + close: true, + } + } else { + OutboundChannel::Common + } + } + ServerJsonRpcMessage::Error(json_rpc_error) => { + if let Some(id) = json_rpc_error.id.clone().and_then(|rid| { + self.resource_router + .get(&ResourceKey::McpRequestId(rid)) + .copied() + }) { + OutboundChannel::RequestWise { id, close: true } + } else { + OutboundChannel::Common + } + } + } + } + async fn handle_server_message( + &mut self, + message: ServerJsonRpcMessage, + ) -> Result<(), SessionError> { + let outbound_channel = self.resolve_outbound_channel(&message); + match outbound_channel { + OutboundChannel::RequestWise { id, close } => { + if let Some(request_wise) = self.tx_router.get_mut(&id) { + request_wise.tx.send(message).await?; + if close && let Some(channel) = self.tx_router.remove(&id) { + for resource in channel.resources { + self.resource_router.remove(&resource); + } + } + } else { + return Err(SessionError::ChannelClosed(Some(id))); + } + } + OutboundChannel::Common => self.common.send(message).await?, + } + Ok(()) + } + async fn resume( + &mut self, + last_event_id: EventId, + ) -> Result { + // Clean up closed shadow senders before processing + self.shadow_txs.retain(|tx| !tx.is_closed()); + + match last_event_id.http_request_id { + Some(http_request_id) => { + let request_wise = self + .tx_router + .get_mut(&http_request_id) + .ok_or(SessionError::ChannelClosed(Some(http_request_id)))?; + let is_completed = request_wise.completed_at.is_some(); + let (tx, rx) = tokio::sync::mpsc::channel(self.session_config.channel_capacity); + request_wise.tx.tx = tx; + let index = last_event_id.index; + request_wise.tx.sync(index).await?; + if is_completed { + // Drop the sender after replaying so the stream ends + // instead of hanging indefinitely. + let (closed_tx, _) = tokio::sync::mpsc::channel(1); + request_wise.tx.tx = closed_tx; + } + Ok(StreamableHttpMessageReceiver { + http_request_id: Some(http_request_id), + inner: rx, + }) + } + None => { + self.resume_or_shadow_common(Some(last_event_id.index)) + .await + } + } + } + + async fn establish_common_channel( + &mut self, + ) -> Result { + let last_event_index = self.event_store.is_none().then_some(0); + self.resume_or_shadow_common(last_event_index).await + } + + /// Resume the common channel, or create a shadow stream if the primary is + /// still active. + /// + /// When the primary common channel is dead (receiver dropped), replace it + /// so this stream becomes the new primary notification channel. Cached + /// messages are replayed from `last_event_index` so the client receives + /// any events it missed (including server-initiated requests). + /// + /// When the primary is still active, create a "shadow" stream — an idle SSE + /// connection kept alive by keep-alive pings. This prevents multiple + /// EventSource connections (e.g. from POST response reconnections) from + /// killing each other by repeatedly replacing the common channel sender. + async fn resume_or_shadow_common( + &mut self, + last_event_index: Option, + ) -> Result { + let is_replacing_dead_primary = self.common.tx.is_closed(); + let capacity = if is_replacing_dead_primary { + self.session_config.channel_capacity + } else { + 1 // Shadow streams only need keep-alive pings + }; + let (tx, rx) = tokio::sync::mpsc::channel(capacity); + if is_replacing_dead_primary { + // Primary common channel is dead — replace it. + tracing::debug!("Replacing dead common channel with new primary"); + self.common.tx = tx; + if let Some(last_event_index) = last_event_index { + self.common.sync(last_event_index).await?; + } + } else { + // Primary common channel is still active. Create a shadow stream + // that stays alive via SSE keep-alive but doesn't receive + // notifications. This prevents competing EventSource connections + // from killing each other's channels. + const MAX_SHADOW_STREAMS: usize = 32; + + if self.shadow_txs.len() >= MAX_SHADOW_STREAMS { + tracing::warn!( + shadow_count = self.shadow_txs.len(), + "Shadow stream limit reached, dropping oldest" + ); + self.shadow_txs.remove(0); + } + tracing::debug!( + shadow_count = self.shadow_txs.len(), + "Common channel active, creating shadow stream" + ); + self.shadow_txs.push(tx); + } + Ok(StreamableHttpMessageReceiver { + http_request_id: None, + inner: rx, + }) + } + + async fn close_sse_stream( + &mut self, + http_request_id: Option, + retry_interval: Option, + ) -> Result<(), SessionError> { + match http_request_id { + // Close a request-wise stream + Some(id) => { + let request_wise = self + .tx_router + .get_mut(&id) + .ok_or(SessionError::ChannelClosed(Some(id)))?; + + // Send priming event if retry interval is specified + if let Some(interval) = retry_interval { + request_wise.tx.send_priming(interval).await?; + } + + // Close the stream by dropping the sender + let (tx, _rx) = tokio::sync::mpsc::channel(1); + request_wise.tx.tx = tx; + + tracing::debug!( + http_request_id = id, + "closed SSE stream for server-initiated disconnection" + ); + Ok(()) + } + // Close the standalone (common) stream + None => { + // Send priming event if retry interval is specified + if let Some(interval) = retry_interval { + self.common.send_priming(interval).await?; + } + + // Close the stream by dropping the sender + let (tx, _rx) = tokio::sync::mpsc::channel(1); + self.common.tx = tx; + + // Also close all shadow streams + self.shadow_txs.clear(); + + tracing::debug!("closed standalone SSE stream for server-initiated disconnection"); + Ok(()) + } + } + } +} + +#[derive(Debug)] +#[non_exhaustive] +pub enum SessionEvent { + ClientMessage { + message: ClientJsonRpcMessage, + http_request_id: Option, + }, + EstablishRequestWiseChannel { + responder: oneshot::Sender>, + }, + CloseRequestWiseChannel { + id: HttpRequestId, + responder: oneshot::Sender>, + }, + Resume { + last_event_id: EventId, + responder: oneshot::Sender>, + }, + InitializeRequest { + request: ClientJsonRpcMessage, + responder: oneshot::Sender>, + }, + Close, + CloseSseStream { + /// The HTTP request ID to close. If `None`, closes the standalone (common) stream. + http_request_id: Option, + /// Optional retry interval. If provided, a priming event is sent before closing. + retry_interval: Option, + responder: oneshot::Sender>, + }, + EstablishCommonChannel { + responder: oneshot::Sender>, + }, +} + +#[derive(Debug, Clone)] +#[non_exhaustive] +pub enum SessionQuitReason { + ServiceTerminated, + ClientTerminated, + ExpectInitializeRequest, + ExpectInitializeResponse, + Cancelled, +} + +#[derive(Debug, Clone)] +pub struct LocalSessionHandle { + id: SessionId, + // after all event_tx drop, inner task will be terminated + event_tx: Sender, +} + +impl LocalSessionHandle { + /// Get the session id + pub fn id(&self) -> &SessionId { + &self.id + } + + /// Close the session + pub async fn close(&self) -> Result<(), SessionError> { + self.event_tx + .send(SessionEvent::Close) + .await + .map_err(|_| SessionError::SessionServiceTerminated)?; + Ok(()) + } + + /// Send a message to the session + pub async fn push_message( + &self, + message: ClientJsonRpcMessage, + http_request_id: Option, + ) -> Result<(), SessionError> { + self.event_tx + .send(SessionEvent::ClientMessage { + message, + http_request_id, + }) + .await + .map_err(|_| SessionError::SessionServiceTerminated)?; + Ok(()) + } + + /// establish a channel for a http-request, the corresponded message from server will be + /// sent through this channel. The channel will be closed when the request is completed, + /// or you can close it manually by calling [`LocalSessionHandle::close_request_wise_channel`]. + pub async fn establish_request_wise_channel( + &self, + ) -> Result { + let (tx, rx) = tokio::sync::oneshot::channel(); + self.event_tx + .send(SessionEvent::EstablishRequestWiseChannel { responder: tx }) + .await + .map_err(|_| SessionError::SessionServiceTerminated)?; + rx.await + .map_err(|_| SessionError::SessionServiceTerminated)? + } + + /// close the http-request wise channel. + pub async fn close_request_wise_channel( + &self, + request_id: HttpRequestId, + ) -> Result<(), SessionError> { + let (tx, rx) = tokio::sync::oneshot::channel(); + self.event_tx + .send(SessionEvent::CloseRequestWiseChannel { + id: request_id, + responder: tx, + }) + .await + .map_err(|_| SessionError::SessionServiceTerminated)?; + rx.await + .map_err(|_| SessionError::SessionServiceTerminated)? + } + + /// Establish a common channel for general purpose messages. + pub async fn establish_common_channel( + &self, + ) -> Result { + let (tx, rx) = tokio::sync::oneshot::channel(); + self.event_tx + .send(SessionEvent::EstablishCommonChannel { responder: tx }) + .await + .map_err(|_| SessionError::SessionServiceTerminated)?; + rx.await + .map_err(|_| SessionError::SessionServiceTerminated)? + } + + /// Resume streaming response by the last event id. This is suitable for both request wise and common channel. + pub async fn resume( + &self, + last_event_id: EventId, + ) -> Result { + let (tx, rx) = tokio::sync::oneshot::channel(); + self.event_tx + .send(SessionEvent::Resume { + last_event_id, + responder: tx, + }) + .await + .map_err(|_| SessionError::SessionServiceTerminated)?; + rx.await + .map_err(|_| SessionError::SessionServiceTerminated)? + } + + /// Send an initialize request to the session. And wait for the initialized response. + /// + /// This is used to establish a session with the server. + pub async fn initialize( + &self, + request: ClientJsonRpcMessage, + ) -> Result { + let (tx, rx) = tokio::sync::oneshot::channel(); + self.event_tx + .send(SessionEvent::InitializeRequest { + request, + responder: tx, + }) + .await + .map_err(|_| SessionError::SessionServiceTerminated)?; + rx.await + .map_err(|_| SessionError::SessionServiceTerminated)? + } + + /// Close an SSE stream for a specific request. + /// + /// This closes the SSE connection for a POST request stream, but keeps the session + /// and message cache active. Clients can reconnect using the `Last-Event-ID` header + /// via a GET request to resume receiving messages. + /// + /// # Arguments + /// + /// * `http_request_id` - The HTTP request ID of the stream to close + /// * `retry_interval` - Optional retry interval. If provided, a priming event is sent + pub async fn close_sse_stream( + &self, + http_request_id: HttpRequestId, + retry_interval: Option, + ) -> Result<(), SessionError> { + let (tx, rx) = tokio::sync::oneshot::channel(); + self.event_tx + .send(SessionEvent::CloseSseStream { + http_request_id: Some(http_request_id), + retry_interval, + responder: tx, + }) + .await + .map_err(|_| SessionError::SessionServiceTerminated)?; + rx.await + .map_err(|_| SessionError::SessionServiceTerminated)? + } + + /// Close the standalone SSE stream. + /// + /// This closes the standalone SSE connection (established via GET request), + /// but keeps the session and message cache active. Clients can reconnect using + /// the `Last-Event-ID` header via a GET request to resume receiving messages. + /// + /// # Arguments + /// + /// * `retry_interval` - Optional retry interval. If provided, a priming event is sent + pub async fn close_standalone_sse_stream( + &self, + retry_interval: Option, + ) -> Result<(), SessionError> { + let (tx, rx) = tokio::sync::oneshot::channel(); + self.event_tx + .send(SessionEvent::CloseSseStream { + http_request_id: None, + retry_interval, + responder: tx, + }) + .await + .map_err(|_| SessionError::SessionServiceTerminated)?; + rx.await + .map_err(|_| SessionError::SessionServiceTerminated)? + } +} + +pub type SessionTransport = WorkerTransport; + +#[allow(clippy::large_enum_variant)] +#[derive(Debug, Error)] +#[non_exhaustive] +pub enum LocalSessionWorkerError { + #[error("transport terminated")] + TransportTerminated, + #[error("unexpected message: {0:?}")] + UnexpectedEvent(SessionEvent), + #[error("fail to send initialize request {0}")] + FailToSendInitializeRequest(SessionError), + #[error("fail to handle message: {0}")] + FailToHandleMessage(SessionError), + #[error("init timeout after {}ms", _0.as_millis())] + InitTimeout(Duration), + #[error("Transport closed")] + TransportClosed, + #[error("Tokio join error {0}")] + TokioJoinError(#[from] tokio::task::JoinError), +} +impl Worker for LocalSessionWorker { + type Error = LocalSessionWorkerError; + type Role = RoleServer; + fn err_closed() -> Self::Error { + LocalSessionWorkerError::TransportClosed + } + fn err_join(e: tokio::task::JoinError) -> Self::Error { + LocalSessionWorkerError::TokioJoinError(e) + } + fn config(&self) -> crate::transport::worker::WorkerConfig { + crate::transport::worker::WorkerConfig { + name: Some(format!("streamable-http-session-{}", self.id)), + channel_buffer_capacity: self.session_config.channel_capacity, + } + } + #[instrument(name = "streamable_http_session", skip_all, fields(id = self.id.as_ref()))] + async fn run( + mut self, + mut context: WorkerContext, + ) -> Result<(), WorkerQuitReason> { + enum InnerEvent { + FromHttpService(SessionEvent), + FromHandler(WorkerSendRequest), + } + let init_timeout = self.session_config.init_timeout.unwrap_or(Duration::MAX); + let evt = tokio::select! { + evt = self.event_rx.recv() => evt.ok_or_else(|| { + WorkerQuitReason::fatal( + LocalSessionWorkerError::TransportTerminated, + "get initialize request", + ) + })?, + _ = context.cancellation_token.cancelled() => { + return Err(WorkerQuitReason::Cancelled); + } + _ = tokio::time::sleep(init_timeout) => { + return Err(WorkerQuitReason::fatal( + LocalSessionWorkerError::InitTimeout(init_timeout), + "waiting for initialize request", + )); + } + }; + let SessionEvent::InitializeRequest { request, responder } = evt else { + return Err(WorkerQuitReason::fatal( + LocalSessionWorkerError::UnexpectedEvent(evt), + "get initialize request", + )); + }; + context.send_to_handler(request).await?; + let send_initialize_response = context.recv_from_handler().await?; + responder + .send(Ok(send_initialize_response.message)) + .map_err(|_| { + WorkerQuitReason::fatal( + LocalSessionWorkerError::FailToSendInitializeRequest( + SessionError::SessionServiceTerminated, + ), + "send initialize response", + ) + })?; + send_initialize_response + .responder + .send(Ok(())) + .map_err(|_| WorkerQuitReason::HandlerTerminated)?; + let ct = context.cancellation_token.clone(); + let keep_alive = self.session_config.keep_alive.unwrap_or(Duration::MAX); + loop { + self.evict_expired_channels(); + let keep_alive_timeout = tokio::time::sleep(keep_alive); + let event = tokio::select! { + event = self.event_rx.recv() => { + if let Some(event) = event { + InnerEvent::FromHttpService(event) + } else { + return Err(WorkerQuitReason::fatal(LocalSessionWorkerError::TransportTerminated, "waiting next session event")) + } + }, + from_handler = context.recv_from_handler() => { + InnerEvent::FromHandler(from_handler?) + } + _ = ct.cancelled() => { + return Err(WorkerQuitReason::Cancelled) + } + _ = keep_alive_timeout => { + return Err(WorkerQuitReason::IdleTimeout(keep_alive)) + } + }; + match event { + InnerEvent::FromHandler(WorkerSendRequest { + message, responder, .. + }) => { + // catch response + let to_unregister = match &message { + crate::model::JsonRpcMessage::Response(json_rpc_response) => { + let request_id = json_rpc_response.id.clone(); + Some(ResourceKey::McpRequestId(request_id)) + } + crate::model::JsonRpcMessage::Error(json_rpc_error) => { + json_rpc_error.id.clone().map(ResourceKey::McpRequestId) + } + _ => { + None + // no need to unregister resource + } + }; + let handle_result = self + .handle_server_message(message) + .await + .map_err(LocalSessionWorkerError::FailToHandleMessage); + let _ = responder.send(handle_result).inspect_err(|error| { + tracing::warn!(?error, "failed to send message to http service handler"); + }); + if let Some(to_unregister) = to_unregister { + self.unregister_resource(&to_unregister); + } + } + InnerEvent::FromHttpService(SessionEvent::ClientMessage { + message: json_rpc_message, + http_request_id, + }) => { + match &json_rpc_message { + crate::model::JsonRpcMessage::Request(request) => { + if let Some(http_request_id) = http_request_id { + self.register_request(request, http_request_id) + } + } + crate::model::JsonRpcMessage::Notification(notification) => { + self.catch_cancellation_notification(notification) + } + _ => {} + } + context.send_to_handler(json_rpc_message).await?; + } + InnerEvent::FromHttpService(SessionEvent::EstablishRequestWiseChannel { + responder, + }) => { + let handle_result = self.establish_request_wise_channel().await; + let _ = responder.send(handle_result); + } + InnerEvent::FromHttpService(SessionEvent::EstablishCommonChannel { responder }) => { + let handle_result = self.establish_common_channel().await; + let _ = responder.send(handle_result); + } + InnerEvent::FromHttpService(SessionEvent::CloseRequestWiseChannel { + id, + responder, + }) => { + let _handle_result = self.tx_router.remove(&id); + let _ = responder.send(Ok(())); + } + InnerEvent::FromHttpService(SessionEvent::Resume { + last_event_id, + responder, + }) => { + let handle_result = self.resume(last_event_id).await; + let _ = responder.send(handle_result); + } + InnerEvent::FromHttpService(SessionEvent::Close) => { + return Err(WorkerQuitReason::TransportClosed); + } + InnerEvent::FromHttpService(SessionEvent::CloseSseStream { + http_request_id, + retry_interval, + responder, + }) => { + let handle_result = + self.close_sse_stream(http_request_id, retry_interval).await; + let _ = responder.send(handle_result); + } + _ => { + // ignore + } + } + } + } +} + +#[derive(Debug, Clone)] +#[non_exhaustive] +pub struct SessionConfig { + /// the capacity of the channel for the session. Default is 16. + pub channel_capacity: usize, + /// The session will be closed after this duration of inactivity. + /// + /// This serves as a safety net for cleaning up sessions whose HTTP + /// connections have silently dropped (e.g., due to an HTTP/2 + /// `RST_STREAM`). Without a timeout, such sessions become zombies: + /// the session worker keeps running indefinitely because the session + /// handle's sender is still held in the session manager, preventing + /// the worker's event channel from closing. + /// + /// Defaults to 5 minutes. Set to `None` to disable (not recommended + /// for long-running servers behind proxies). + pub keep_alive: Option, + /// SSE retry interval for priming events on request-wise streams. + /// When set, the session layer prepends a priming event with the correct + /// stream-identifying event ID to each request-wise SSE stream. + /// Default is 3 seconds, matching `StreamableHttpServerConfig::default()`. + pub sse_retry: Option, + /// How long to retain completed request-wise channel caches for late + /// resume requests. After this duration, completed entries are evicted + /// and resume will return an error. Default is 60 seconds. + pub completed_cache_ttl: Duration, + /// Maximum duration to wait for the `initialize` request after session + /// creation. If not received within this window, the session is + /// terminated. Default is 60 seconds. Set to `None` to disable. + pub init_timeout: Option, +} + +impl SessionConfig { + pub const DEFAULT_CHANNEL_CAPACITY: usize = 16; + pub const DEFAULT_KEEP_ALIVE: Duration = Duration::from_secs(300); + pub const DEFAULT_SSE_RETRY: Duration = Duration::from_secs(3); + pub const DEFAULT_COMPLETED_CACHE_TTL: Duration = Duration::from_secs(60); + pub const DEFAULT_INIT_TIMEOUT: Duration = Duration::from_secs(60); +} + +impl Default for SessionConfig { + fn default() -> Self { + Self { + channel_capacity: Self::DEFAULT_CHANNEL_CAPACITY, + keep_alive: Some(Self::DEFAULT_KEEP_ALIVE), + sse_retry: Some(Self::DEFAULT_SSE_RETRY), + completed_cache_ttl: Self::DEFAULT_COMPLETED_CACHE_TTL, + init_timeout: Some(Self::DEFAULT_INIT_TIMEOUT), + } + } +} + +/// Create a new session with the given id and configuration. +/// +/// This function will return a pair of [`LocalSessionHandle`] and [`LocalSessionWorker`]. +/// +/// You can run the [`LocalSessionWorker`] as a transport for mcp server. And use the [`LocalSessionHandle`] operate the session. +pub fn create_local_session( + id: impl Into, + config: SessionConfig, +) -> (LocalSessionHandle, LocalSessionWorker) { + create_local_session_with_event_store(id, config, None) +} + +fn create_local_session_with_event_store( + id: impl Into, + config: SessionConfig, + event_store: Option>, +) -> (LocalSessionHandle, LocalSessionWorker) { + let id = id.into(); + let (event_tx, event_rx) = tokio::sync::mpsc::channel(config.channel_capacity); + let (common_tx, _) = tokio::sync::mpsc::channel(config.channel_capacity); + let common = CachedTx::new_common(common_tx, &id, event_store.clone()); + tracing::info!(session_id = ?id, "create new session"); + let handle = LocalSessionHandle { + event_tx, + id: id.clone(), + }; + let session_worker = LocalSessionWorker { + next_http_request_id: 0, + id, + tx_router: HashMap::new(), + resource_router: HashMap::new(), + common, + shadow_txs: Vec::new(), + event_rx, + session_config: config.clone(), + event_store, + }; + (handle, session_worker) +} + +#[cfg(test)] +mod sep2260_routing_tests { + use super::*; + use crate::service::OriginatingRequestId; + + fn roots_request(originating: Option) -> ServerJsonRpcMessage { + #[expect( + deprecated, + reason = "roots is SEP-2577-deprecated; any restricted request works here" + )] + let mut request = crate::model::ListRootsRequest { + method: Default::default(), + extensions: Default::default(), + }; + if let Some(id) = originating { + request.extensions.insert(OriginatingRequestId(id)); + } + ServerJsonRpcMessage::request( + crate::model::ServerRequest::ListRootsRequest(request), + RequestId::Number(1000), + ) + } + + #[tokio::test] + async fn associated_server_request_routes_to_originating_stream() { + let (_handle, mut worker) = create_local_session("test-session", SessionConfig::default()); + let receiver = worker.establish_request_wise_channel().await.unwrap(); + let http_request_id = receiver.http_request_id.unwrap(); + let originating_id = RequestId::Number(7); + worker.register_resource( + ResourceKey::McpRequestId(originating_id.clone()), + http_request_id, + ); + + let channel = worker.resolve_outbound_channel(&roots_request(Some(originating_id))); + assert!( + matches!(channel, OutboundChannel::RequestWise { id, close: false } if id == http_request_id) + ); + } + + #[tokio::test] + async fn unassociated_server_request_routes_to_common_stream() { + let (_handle, mut worker) = create_local_session("test-session", SessionConfig::default()); + let _receiver = worker.establish_request_wise_channel().await.unwrap(); + let channel = worker.resolve_outbound_channel(&roots_request(None)); + assert!(matches!(channel, OutboundChannel::Common)); + } + + #[tokio::test] + async fn associated_request_for_completed_request_falls_back_to_common() { + // Originating request already unregistered (completion race / re-scoped + // task op): must fall back to Common, never a closed request-wise channel. + let (_handle, mut worker) = create_local_session("test-session", SessionConfig::default()); + let receiver = worker.establish_request_wise_channel().await.unwrap(); + let http_request_id = receiver.http_request_id.unwrap(); + let originating_id = RequestId::Number(7); + worker.register_resource( + ResourceKey::McpRequestId(originating_id.clone()), + http_request_id, + ); + worker.unregister_resource(&ResourceKey::McpRequestId(originating_id.clone())); + + let channel = worker.resolve_outbound_channel(&roots_request(Some(originating_id))); + assert!(matches!(channel, OutboundChannel::Common)); + } +} diff --git a/vendor/rmcp/src/transport/streamable_http_server/session/never.rs b/vendor/rmcp/src/transport/streamable_http_server/session/never.rs new file mode 100644 index 00000000..d83031c3 --- /dev/null +++ b/vendor/rmcp/src/transport/streamable_http_server/session/never.rs @@ -0,0 +1,126 @@ +use std::sync::Arc; + +use futures::Stream; +use thiserror::Error; + +use super::{EventStore, ServerSseMessage, SessionId, SessionManager}; +use crate::{ + RoleServer, + model::{ClientJsonRpcMessage, ServerJsonRpcMessage}, + transport::Transport, +}; + +#[derive(Debug, Clone, Error)] +#[error("Session management is not supported")] +#[non_exhaustive] +pub struct ErrorSessionManagementNotSupported; +#[derive(Debug, Clone, Default)] +#[non_exhaustive] +pub struct NeverSessionManager { + event_store: Option>, +} + +impl NeverSessionManager { + /// Configure resumable SSE storage without enabling sessions. + pub fn with_event_store(mut self, event_store: Arc) -> Self { + self.event_store = Some(event_store); + self + } +} +#[non_exhaustive] +pub enum NeverTransport {} +impl Transport for NeverTransport { + type Error = ErrorSessionManagementNotSupported; + + fn send( + &mut self, + _item: ServerJsonRpcMessage, + ) -> impl Future> + Send + 'static { + futures::future::ready(Err(ErrorSessionManagementNotSupported)) + } + + fn receive(&mut self) -> impl Future> { + futures::future::ready(None) + } + + async fn close(&mut self) -> Result<(), Self::Error> { + Err(ErrorSessionManagementNotSupported) + } +} + +impl SessionManager for NeverSessionManager { + type Error = ErrorSessionManagementNotSupported; + type Transport = NeverTransport; + + fn create_session( + &self, + ) -> impl Future> + Send { + futures::future::ready(Err(ErrorSessionManagementNotSupported)) + } + + fn initialize_session( + &self, + _id: &SessionId, + _message: ClientJsonRpcMessage, + ) -> impl Future> + Send { + futures::future::ready(Err(ErrorSessionManagementNotSupported)) + } + + fn has_session( + &self, + _id: &SessionId, + ) -> impl Future> + Send { + futures::future::ready(Err(ErrorSessionManagementNotSupported)) + } + + fn close_session( + &self, + _id: &SessionId, + ) -> impl Future> + Send { + futures::future::ready(Err(ErrorSessionManagementNotSupported)) + } + + fn create_stream( + &self, + _id: &SessionId, + _message: ClientJsonRpcMessage, + ) -> impl Future< + Output = Result + Send + 'static, Self::Error>, + > + Send { + futures::future::ready(Result::, _>::Err( + ErrorSessionManagementNotSupported, + )) + } + fn create_standalone_stream( + &self, + _id: &SessionId, + ) -> impl Future< + Output = Result + Send + 'static, Self::Error>, + > + Send { + futures::future::ready(Result::, _>::Err( + ErrorSessionManagementNotSupported, + )) + } + fn resume( + &self, + _id: &SessionId, + _last_event_id: String, + ) -> impl Future< + Output = Result + Send + 'static, Self::Error>, + > + Send { + futures::future::ready(Result::, _>::Err( + ErrorSessionManagementNotSupported, + )) + } + fn accept_message( + &self, + _id: &SessionId, + _message: ClientJsonRpcMessage, + ) -> impl Future> + Send { + futures::future::ready(Err(ErrorSessionManagementNotSupported)) + } + + fn event_store(&self) -> Option> { + self.event_store.clone() + } +} diff --git a/vendor/rmcp/src/transport/streamable_http_server/session/store.rs b/vendor/rmcp/src/transport/streamable_http_server/session/store.rs new file mode 100644 index 00000000..8b656201 --- /dev/null +++ b/vendor/rmcp/src/transport/streamable_http_server/session/store.rs @@ -0,0 +1,126 @@ +use std::pin::Pin; + +use futures::Stream; + +use crate::{ + model::InitializeRequestParams, transport::common::server_side_http::ServerSseMessage, +}; + +/// An opaque identifier for a persisted SSE event. +pub type EventId = String; + +/// An opaque identifier for an SSE stream. +pub type StreamId = String; + +/// A stream of persisted SSE events in delivery order. +pub type EventStream = Pin + Send + Sync + 'static>>; + +/// Type alias for boxed event store errors. +pub type EventStoreError = Box; + +/// Persistent storage for resumable Streamable HTTP events. +/// +/// Implementations typically use a database or distributed log shared by all +/// server instances. Event IDs must be globally unique across all streams, and +/// events must be committed before [`EventStore::store_event`] returns so the +/// returned ID is safe to send to a client. +#[async_trait::async_trait] +pub trait EventStore: Send + Sync + 'static { + /// Persist an event and return the opaque ID clients should receive. + /// + /// The store assigns a globally unique ID and must retain its association + /// with `stream_id` so a later replay only returns events from that stream. + async fn store_event( + &self, + stream_id: &str, + event: &ServerSseMessage, + ) -> Result; + + /// Return events strictly after `last_event_id` in delivery order. + /// + /// Implementations must locate the stream from the globally unique event + /// ID and yield only later events from that stream, with their originally + /// assigned event IDs. + /// + /// A finite stream enables reconnect-and-poll behavior. Implementations + /// backed by a distributed log may keep the stream open to deliver new + /// events as they are appended by any server instance. + async fn replay_events_after( + &self, + last_event_id: &str, + ) -> Result; +} + +impl std::fmt::Debug for dyn EventStore { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str("") + } +} + +/// State persisted to an external store for cross-instance session recovery. +/// +/// When a client reconnects to a different server instance, the new instance +/// loads this state to transparently replay the `initialize` handshake without +/// the client needing to re-initialize. +#[non_exhaustive] +#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)] +pub struct SessionState { + /// Parameters from the client's original `initialize` request. + pub initialize_params: InitializeRequestParams, +} + +impl SessionState { + pub fn new(initialize_params: InitializeRequestParams) -> Self { + Self { initialize_params } + } +} + +/// Type alias for boxed session store errors. +pub type SessionStoreError = Box; + +/// Pluggable external session store for cross-instance recovery. +/// +/// Implement this trait to back sessions with Redis, a database, or any +/// key-value store. The simplest usage is to set +/// `StreamableHttpServerConfig::session_store` to an `Arc`. +/// +/// # Example (in-memory, for testing) +/// +/// ```rust,ignore +/// use std::{collections::HashMap, sync::Arc}; +/// use tokio::sync::RwLock; +/// use rmcp::transport::streamable_http_server::session::store::{ +/// SessionState, SessionStore, SessionStoreError, +/// }; +/// +/// #[derive(Default)] +/// struct InMemoryStore(Arc>>); +/// +/// #[async_trait::async_trait] +/// impl SessionStore for InMemoryStore { +/// async fn load(&self, id: &str) -> Result, SessionStoreError> { +/// Ok(self.0.read().await.get(id).cloned()) +/// } +/// async fn store(&self, id: &str, state: &SessionState) -> Result<(), SessionStoreError> { +/// self.0.write().await.insert(id.to_owned(), state.clone()); +/// Ok(()) +/// } +/// async fn delete(&self, id: &str) -> Result<(), SessionStoreError> { +/// self.0.write().await.remove(id); +/// Ok(()) +/// } +/// } +/// ``` +#[async_trait::async_trait] +pub trait SessionStore: Send + Sync + 'static { + /// Load session state for the given `session_id`. + /// + /// Returns `Ok(None)` when no entry exists (i.e. session is unknown to the store). + async fn load(&self, session_id: &str) -> Result, SessionStoreError>; + + /// Persist session state for the given `session_id`. + async fn store(&self, session_id: &str, state: &SessionState) -> Result<(), SessionStoreError>; + + /// Remove session state for the given `session_id`. + async fn delete(&self, session_id: &str) -> Result<(), SessionStoreError>; +} diff --git a/vendor/rmcp/src/transport/streamable_http_server/tower.rs b/vendor/rmcp/src/transport/streamable_http_server/tower.rs new file mode 100644 index 00000000..5d7cee55 --- /dev/null +++ b/vendor/rmcp/src/transport/streamable_http_server/tower.rs @@ -0,0 +1,2462 @@ +use std::{ + borrow::Cow, + collections::HashMap, + convert::Infallible, + fmt::Display, + pin::Pin, + sync::Arc, + task::{Context, Poll}, + time::Duration, +}; + +use bytes::Bytes; +use futures::{Stream, StreamExt, future::BoxFuture}; +use http::{HeaderMap, Method, Request, Response, header::ALLOW}; +use http_body::Body; +use http_body_util::{BodyExt, Full, combinators::BoxBody}; +use pin_project_lite::pin_project; +use tokio_stream::wrappers::ReceiverStream; +use tokio_util::sync::CancellationToken; + +use super::session::{ + EventStore, EventStoreError, RestoreOutcome, SessionId, SessionManager, SessionRestoreMarker, + SessionState, SessionStore, +}; +use crate::{ + RoleServer, + model::{ + ClientCapabilities, ClientJsonRpcMessage, ClientNotification, ClientRequest, ErrorCode, + ErrorData, GetExtensions, GetMeta, Implementation, InitializeRequest, + InitializeRequestParams, InitializedNotification, JsonObject, JsonRpcError, + ProtocolVersion, RequestId, ServerConfig, ServerJsonRpcMessage, ServerResult, + }, + serve_server, + service::{ + NotificationContext, RequestContext, Service, negotiate_protocol_version, + serve_directly_with_ct, uses_legacy_lifecycle, + }, + transport::{ + OneshotTransport, TransportAdapterIdentity, + common::{ + http_header::{ + EVENT_STREAM_MIME_TYPE, HEADER_LAST_EVENT_ID, HEADER_MCP_METHOD, + HEADER_MCP_PROTOCOL_VERSION, HEADER_SESSION_ID, JSON_MIME_TYPE, + }, + mcp_headers, + server_side_http::{ + BoxResponse, ServerSseMessage, accepted_response, expect_json, + internal_error_response, sse_stream_response, unexpected_message_response, + }, + }, + }, +}; + +/// Default maximum POST request body size (4 MiB). +pub(crate) const DEFAULT_MAX_REQUEST_BODY_BYTES: usize = 4 * 1024 * 1024; +const STATELESS_STREAM_CHANNEL_CAPACITY: usize = 16; + +struct ErrorResponse(Box); + +impl ErrorResponse { + fn into_response(self) -> BoxResponse { + *self.0 + } +} + +impl From for ErrorResponse { + fn from(response: BoxResponse) -> Self { + Self(Box::new(response)) + } +} + +type HttpResult = Result; +type RestoreResultSender = tokio::sync::watch::Sender>; +type PendingRestores = Arc>>; + +#[non_exhaustive] +#[derive(Debug, Clone)] +pub struct StreamableHttpServerConfig { + /// The ping message duration for SSE connections. + pub sse_keep_alive: Option, + /// The retry interval for SSE priming events. + pub sse_retry: Option, + /// If true, the server will create a session for each request and keep it alive. + /// When enabled, SSE priming events are sent to enable client reconnection. + /// + /// Only applies to legacy protocol versions (`< 2026-07-28`). Per SEP-2567, + /// sessions are removed from the `2026-07-28` version, so requests + /// negotiating that version are always served statelessly regardless of + /// this setting. + pub legacy_session_mode: bool, + /// When true and `legacy_session_mode` is false, the server prefers + /// `Content-Type: application/json` for simple request-response tools. + /// If the handler emits a notification or request before the final response, + /// the server falls back to `text/event-stream` so no message is lost. + pub json_response: bool, + /// Cancellation token for the Streamable HTTP server. + /// + /// When this token is cancelled, all active sessions are terminated and + /// the server stops accepting new requests. + pub cancellation_token: CancellationToken, + /// Allowed hostnames or `host:port` authorities for inbound `Host` validation. + /// + /// By default, Streamable HTTP servers only accept loopback hosts to + /// prevent DNS rebinding attacks against locally running servers. Public + /// deployments should override this list with their own hostnames. + /// examples: + /// allowed_hosts = ["localhost", "127.0.0.1", "0.0.0.0"] + /// or with ports: + /// allowed_hosts = ["example.com", "example.com:8080"] + pub allowed_hosts: Vec, + /// Allowed browser origins for inbound `Origin` validation. + /// + /// Defaults to an empty list, which disables Origin validation for backward + /// compatibility. A non-empty list enables validation. Requests carrying + /// an `Origin` header must match per RFC 6454 `(scheme, host, port)`; + /// missing-`Origin` requests still pass. Entries must include a scheme; + /// `"null"` matches the browser's `Origin: null`. + /// + /// Ports: + /// - `:*` matches any port. + /// - An explicit port matches only that port. An `Origin` without a port + /// uses the scheme default (443 for `https`, 80 for `http`). + /// - An entry without a port currently matches any port. This is + /// deprecated: a future release will match only the scheme default + /// port. Use `:*` or an explicit port instead. + /// + /// Call [`StreamableHttpServerConfig::enforce_origin_validation`] to enable + /// validation with an empty list, rejecting every present Origin value. + /// examples: + /// allowed_origins = ["https://app.example.com:443", "http://localhost:*"] + pub allowed_origins: Vec, + validate_empty_origin_allowlist: bool, + /// Optional external session store for cross-instance recovery. + /// + /// When set, [`SessionState`] (the client's `initialize` parameters) is + /// persisted after a successful handshake and deleted when the session + /// closes. On any subsequent request that arrives at an instance with no + /// in-memory session, the store is consulted: if an entry is found the + /// session is transparently restored so the client does not need to + /// re-initialize. + /// + /// # Example + /// ```rust,ignore + /// use std::sync::Arc; + /// use rmcp::transport::streamable_http_server::{ + /// StreamableHttpServerConfig, session::SessionStore, + /// }; + /// + /// let config = StreamableHttpServerConfig { + /// session_store: Some(Arc::new(MyRedisStore::new())), + /// ..Default::default() + /// }; + /// ``` + pub session_store: Option>, + /// Maximum POST request body size in bytes. + /// + /// Enforced while streaming the body, independent of `Content-Length`, + /// chunked transfer encoding, or HTTP version. Oversized payloads receive + /// a `413 Payload Too Large` response. + pub max_request_body_bytes: usize, + /// Require stateless JSON-RPC request POSTs to carry per-request protocol + /// signals before handler dispatch. + /// + /// Non-initialize requests must carry `MCP-Protocol-Version`; ordinary + /// non-discovery requests must also carry + /// `_meta.io.modelcontextprotocol/protocolVersion`. `server/discover` + /// retains its existing request-metadata validation. For `2026-07-28` + /// requests, the server handler continues to require the remaining + /// per-request metadata, including `clientCapabilities`. Initialize, + /// notifications, and other message kinds retain their existing rules. + /// + /// This option applies to requests routed statelessly. Set + /// `legacy_session_mode` to `false` to ensure every request uses that path. + /// Legacy session routing and its error precedence remain unchanged. + /// + /// The validator checks metadata presence rather than applying a version + /// allowlist. However, rmcp clients negotiated below `2026-07-28` do not + /// attach per-request protocol metadata, so enabling this option rejects + /// their ordinary requests. Servers using this option should normally + /// override + /// [`ServerHandler::supported_protocol_versions`](crate::ServerHandler::supported_protocol_versions) + /// to advertise only `2026-07-28` and later. + /// + /// Default is `false`, preserving today's legacy behavior where an absent + /// header is treated as protocol version `2025-03-26`. + pub stateless_protocol_metadata_required: bool, +} + +impl std::fmt::Debug for dyn SessionStore { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str("") + } +} + +impl Default for StreamableHttpServerConfig { + fn default() -> Self { + Self { + sse_keep_alive: Some(Duration::from_secs(15)), + sse_retry: Some(Duration::from_secs(3)), + legacy_session_mode: true, + json_response: false, + cancellation_token: CancellationToken::new(), + allowed_hosts: vec!["localhost".into(), "127.0.0.1".into(), "::1".into()], + allowed_origins: vec![], + validate_empty_origin_allowlist: false, + session_store: None, + max_request_body_bytes: DEFAULT_MAX_REQUEST_BODY_BYTES, + stateless_protocol_metadata_required: false, + } + } +} + +impl StreamableHttpServerConfig { + pub fn with_allowed_hosts( + mut self, + allowed_hosts: impl IntoIterator>, + ) -> Self { + self.allowed_hosts = allowed_hosts.into_iter().map(Into::into).collect(); + self + } + /// Disable allowed hosts. This will allow requests with any `Host` header, which is NOT recommended for public deployments. + pub fn disable_allowed_hosts(mut self) -> Self { + self.allowed_hosts.clear(); + self + } + pub fn with_allowed_origins( + mut self, + allowed_origins: impl IntoIterator>, + ) -> Self { + self.allowed_origins = allowed_origins.into_iter().map(Into::into).collect(); + self + } + /// Enable Origin validation, including when the allowed Origins list is empty. + pub fn enforce_origin_validation(mut self) -> Self { + self.validate_empty_origin_allowlist = true; + self + } + /// Disable Origin validation, allowing requests with any `Origin` header. + pub fn disable_allowed_origins(mut self) -> Self { + self.allowed_origins.clear(); + self.validate_empty_origin_allowlist = false; + self + } + pub fn with_sse_keep_alive(mut self, duration: Option) -> Self { + self.sse_keep_alive = duration; + self + } + + pub fn with_sse_retry(mut self, duration: Option) -> Self { + self.sse_retry = duration; + self + } + + pub fn with_legacy_session_mode(mut self, legacy_session_mode: bool) -> Self { + self.legacy_session_mode = legacy_session_mode; + self + } + + pub fn with_json_response(mut self, json_response: bool) -> Self { + self.json_response = json_response; + self + } + + pub fn with_cancellation_token(mut self, token: CancellationToken) -> Self { + self.cancellation_token = token; + self + } + + /// Set the maximum POST request body size in bytes. + pub fn with_max_request_body_bytes(mut self, bytes: usize) -> Self { + self.max_request_body_bytes = bytes; + self + } + + /// Require per-request protocol signals on stateless JSON-RPC request + /// POSTs. + /// + /// See [`StreamableHttpServerConfig::stateless_protocol_metadata_required`]. + pub fn with_stateless_protocol_metadata_required( + mut self, + stateless_protocol_metadata_required: bool, + ) -> Self { + self.stateless_protocol_metadata_required = stateless_protocol_metadata_required; + self + } +} + +/// Validates the `MCP-Protocol-Version` header on incoming HTTP requests. +/// +/// Per the MCP 2025-06-18 spec: +/// - If the header is present but contains an unsupported version, return 400 Bad Request. +/// - If the header is absent, assume `2025-03-26` for backwards compatibility (no error). +fn validate_protocol_version_header( + headers: &http::HeaderMap, + allow_unknown: bool, +) -> HttpResult<()> { + if let Some(value) = headers.get(HEADER_MCP_PROTOCOL_VERSION) { + let version_str = value.to_str().map_err(|_| { + Response::builder() + .status(http::StatusCode::BAD_REQUEST) + .body( + Full::new(Bytes::from( + "Bad Request: Invalid MCP-Protocol-Version header encoding", + )) + .boxed(), + ) + .expect("valid response") + })?; + let is_known = ProtocolVersion::KNOWN_VERSIONS + .iter() + .any(|v| v.as_str() == version_str); + if !allow_unknown && !is_known { + return Err(Response::builder() + .status(http::StatusCode::BAD_REQUEST) + .body( + Full::new(Bytes::from(format!( + "Bad Request: Unsupported MCP-Protocol-Version: {version_str}" + ))) + .boxed(), + ) + .expect("valid response") + .into()); + } + } + Ok(()) +} + +fn message_has_per_request_protocol_version(message: &ClientJsonRpcMessage) -> bool { + match message { + ClientJsonRpcMessage::Request(request) => { + request.request.get_meta().protocol_version().is_some() + } + _ => false, + } +} + +struct NegotiatingStatelessHttpService(S); + +impl> Service for NegotiatingStatelessHttpService { + async fn handle_request( + &self, + request: ClientRequest, + context: RequestContext, + ) -> Result { + let requested_protocol_version = + if let ClientRequest::InitializeRequest(initialize) = &request { + Some(initialize.params.protocol_version.clone()) + } else { + None + }; + let peer = context.peer.clone(); + let mut response = self.0.handle_request(request, context).await?; + if let (Some(requested), ServerResult::InitializeResult(result)) = + (requested_protocol_version, &mut response) + { + result.protocol_version = negotiate_protocol_version( + &requested, + result.protocol_version.clone(), + &self.0.supported_protocol_versions(), + )?; + if let Some(peer_info) = peer.peer_info() { + let mut peer_info = (*peer_info).clone(); + peer_info.protocol_version = result.protocol_version.clone(); + peer.set_peer_info(peer_info); + } + } + Ok(response) + } + + async fn handle_notification( + &self, + notification: ClientNotification, + context: NotificationContext, + ) -> Result<(), ErrorData> { + self.0.handle_notification(notification, context).await + } + + fn get_info(&self) -> ServerConfig { + self.0.get_info() + } + + fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]> { + self.0.supported_protocol_versions() + } +} + +// SEP-2567: sessions are removed from the discover lifecycle. Validate +// protocol-version consistency, then classify the request with the shared +// lifecycle helper. +fn is_legacy_request( + message: Option<&ClientJsonRpcMessage>, + headers: &HeaderMap, +) -> HttpResult { + let has_per_request_version = message.is_some_and(message_has_per_request_protocol_version); + validate_protocol_version_header(headers, has_per_request_version)?; + if let Some(message) = message { + if let ClientJsonRpcMessage::Request(req) = message + && let ClientRequest::InitializeRequest(init) = &req.request + { + validate_header_matches_init_body( + headers, + init.params.protocol_version.as_str(), + Some(req.id.clone()), + )?; + } + validate_request_protocol_version_meta(headers, message)?; + } + + // An `initialize` request selects legacy semantics whatever version it names: + // the handshake exists only in the revisions before 2026-07-28, so the + // version in its params never routes it to the stateless path. The + // handshake itself answers with a legacy version the server supports. + if matches!( + message, + Some(ClientJsonRpcMessage::Request(req)) + if matches!(&req.request, ClientRequest::InitializeRequest(_)) + ) { + return Ok(true); + } + + let uses_discover_lifecycle = matches!( + message, + Some(ClientJsonRpcMessage::Request(req)) + if req + .request + .get_meta() + .missing_required_keys(&ProtocolVersion::V_2026_07_28) + .is_empty() + ); + + let from_body = match message { + Some(ClientJsonRpcMessage::Request(req)) => req.request.get_meta().protocol_version(), + _ => None, + }; + let version = from_body + .or_else(|| { + headers + .get(HEADER_MCP_PROTOCOL_VERSION) + .and_then(|value| value.to_str().ok()) + .and_then(|s| serde_json::from_value(serde_json::Value::String(s.to_owned())).ok()) + }) + .unwrap_or(ProtocolVersion::V_2025_03_26); + Ok(uses_legacy_lifecycle( + Some(&version), + uses_discover_lifecycle, + )) +} + +fn method_not_allowed_response() -> BoxResponse { + Response::builder() + .status(http::StatusCode::METHOD_NOT_ALLOWED) + .header(ALLOW, "POST") + .body(Full::new(Bytes::from("Method Not Allowed")).boxed()) + .expect("valid response") +} + +async fn persist_and_forward_event( + event_store: &dyn EventStore, + stream_id: &str, + mut event: ServerSseMessage, + output: &mut Option>, +) -> Result<(), EventStoreError> { + event.event_id = Some(event_store.store_event(stream_id, &event).await?); + if let Some(sender) = output + && sender.send(event).await.is_err() + { + *output = None; + } + Ok(()) +} + +fn invalid_request_jsonrpc_response( + id: Option, + message: impl Into>, +) -> BoxResponse { + let err = JsonRpcError::new(id, ErrorData::invalid_request(message, None)); + let body = serde_json::to_vec(&err).expect("serialize JsonRpcError"); + Response::builder() + .status(http::StatusCode::BAD_REQUEST) + .header(http::header::CONTENT_TYPE, JSON_MIME_TYPE) + .body(Full::new(Bytes::from(body)).boxed()) + .expect("valid response") +} + +fn invalid_params_jsonrpc_response( + id: Option, + message: impl Into>, +) -> BoxResponse { + let err = JsonRpcError::new(id, ErrorData::invalid_params(message, None)); + let body = serde_json::to_vec(&err).expect("serialize JsonRpcError"); + Response::builder() + .status(http::StatusCode::BAD_REQUEST) + .header(http::header::CONTENT_TYPE, JSON_MIME_TYPE) + .body(Full::new(Bytes::from(body)).boxed()) + .expect("valid response") +} + +/// Absent header is allowed; the first initialize round-trip may legitimately omit it. +fn validate_header_matches_init_body( + headers: &http::HeaderMap, + body_version: &str, + request_id: Option, +) -> HttpResult<()> { + let Some(header_value) = headers.get(HEADER_MCP_PROTOCOL_VERSION) else { + return Ok(()); + }; + let header_str = header_value.to_str().map_err(|_| { + invalid_request_jsonrpc_response( + request_id.clone(), + "Invalid Request: MCP-Protocol-Version header is not valid UTF-8", + ) + })?; + if header_str != body_version { + tracing::warn!( + header = header_str, + body = body_version, + "rejecting initialize: MCP-Protocol-Version header does not match params.protocolVersion" + ); + return Err(invalid_request_jsonrpc_response( + request_id, + format!( + "Invalid Request: MCP-Protocol-Version header ({header_str}) does not match initialize params.protocolVersion ({body_version})" + ), + ) + .into()); + } + Ok(()) +} + +fn validate_request_protocol_version_meta( + headers: &HeaderMap, + message: &ClientJsonRpcMessage, +) -> HttpResult<()> { + let ClientJsonRpcMessage::Request(request) = message else { + return Ok(()); + }; + if matches!(&request.request, ClientRequest::InitializeRequest(_)) { + return Ok(()); + } + let is_discover = matches!(&request.request, ClientRequest::DiscoverRequest(_)); + let meta = request.request.get_meta(); + let header_version = headers + .get(HEADER_MCP_PROTOCOL_VERSION) + .and_then(|value| value.to_str().ok()); + let Some(meta_version) = meta.protocol_version() else { + let requires_request_metadata = is_discover + || header_version + .is_some_and(|version| version >= ProtocolVersion::V_2026_07_28.as_str()); + if requires_request_metadata { + let missing = meta.missing_required_keys(&ProtocolVersion::V_2026_07_28); + return Err(invalid_params_jsonrpc_response( + Some(request.id.clone()), + format!( + "Invalid params: request _meta is missing or has malformed required fields: {}", + missing.join(", ") + ), + ) + .into()); + } + return Ok(()); + }; + let Some(header_version) = header_version else { + return Err(header_mismatch_jsonrpc_response( + Some(request.id.clone()), + "request _meta protocolVersion requires MCP-Protocol-Version header", + ) + .into()); + }; + if header_version != meta_version.as_str() { + return Err(header_mismatch_jsonrpc_response( + Some(request.id.clone()), + format!( + "MCP-Protocol-Version header ({header_version}) does not match request _meta protocolVersion ({meta_version})" + ), + ) + .into()); + } + Ok(()) +} + +/// When `stateless_protocol_metadata_required` is enabled in stateless mode, +/// every non-initialize Streamable HTTP JSON-RPC request POST must carry the +/// `MCP-Protocol-Version` HTTP header. A missing header is rejected with +/// HTTP 400 / JSON-RPC `-32020` before handler dispatch. `server/discover` +/// is included so the seam aligns with the per-POST header contract; its +/// body-metadata rule is preserved unchanged. +fn validate_required_protocol_header( + config: &StreamableHttpServerConfig, + headers: &HeaderMap, + message: &ClientJsonRpcMessage, +) -> HttpResult<()> { + if !config.stateless_protocol_metadata_required { + return Ok(()); + } + let ClientJsonRpcMessage::Request(request) = message else { + // Notifications, response messages, and error messages are exempt. + return Ok(()); + }; + if matches!(&request.request, ClientRequest::InitializeRequest(_)) { + // Initialize keeps its own header-matching rule. + return Ok(()); + } + if headers.contains_key(HEADER_MCP_PROTOCOL_VERSION) { + return Ok(()); + } + Err(header_mismatch_jsonrpc_response( + Some(request.id.clone()), + "Missing MCP-Protocol-Version header for request requiring per-request protocol metadata", + ) + .into()) +} + +/// When `stateless_protocol_metadata_required` is enabled in stateless mode, +/// every non-initialize, non-discover Streamable HTTP JSON-RPC request must +/// carry `io.modelcontextprotocol/protocolVersion` in `_meta`. A missing entry +/// is rejected with HTTP 400 / JSON-RPC `-32602` (invalid_params). `initialize`, +/// `server/discover` (whose body-metadata rule is already enforced by +/// `validate_request_protocol_version_meta`), notifications, and other message +/// kinds are exempt. +fn validate_required_protocol_meta( + config: &StreamableHttpServerConfig, + message: &ClientJsonRpcMessage, +) -> HttpResult<()> { + if !config.stateless_protocol_metadata_required { + return Ok(()); + } + let ClientJsonRpcMessage::Request(request) = message else { + return Ok(()); + }; + if matches!( + &request.request, + ClientRequest::InitializeRequest(_) | ClientRequest::DiscoverRequest(_) + ) { + return Ok(()); + } + if request.request.get_meta().protocol_version().is_some() { + return Ok(()); + } + Err(invalid_params_jsonrpc_response( + Some(request.id.clone()), + "Invalid params: request requires protocolVersion in request _meta", + ) + .into()) +} + +fn jsonrpc_http_status(message: &ServerJsonRpcMessage) -> http::StatusCode { + let ServerJsonRpcMessage::Error(error) = message else { + return http::StatusCode::OK; + }; + // Modern per-request HTTP treats invalid params as a malformed request. + // Legacy requests bypass this mapper and retain HTTP 200 JSON-RPC errors. + match error.error.code { + ErrorCode::UNSUPPORTED_PROTOCOL_VERSION + | ErrorCode::MISSING_REQUIRED_CLIENT_CAPABILITY + | ErrorCode::INVALID_PARAMS + | ErrorCode::HEADER_MISMATCH => http::StatusCode::BAD_REQUEST, + ErrorCode::METHOD_NOT_FOUND => http::StatusCode::NOT_FOUND, + _ => http::StatusCode::OK, + } +} + +#[cfg(test)] +mod jsonrpc_http_status_tests { + use super::*; + + fn error_message(code: ErrorCode) -> ServerJsonRpcMessage { + ServerJsonRpcMessage::Error(JsonRpcError::new( + Some(RequestId::Number(1)), + ErrorData::new(code, "test error", None), + )) + } + + /// A handler returning `ErrorData::header_mismatch(..)` on the modern per-request path + /// must map to HTTP 400, not the default HTTP 200. Regression test for + /// https://github.com/modelcontextprotocol/rust-sdk/issues/1225 + #[test] + fn header_mismatch_maps_to_bad_request() { + assert_eq!( + jsonrpc_http_status(&error_message(ErrorCode::HEADER_MISMATCH)), + http::StatusCode::BAD_REQUEST + ); + } + + #[test] + fn method_not_found_maps_to_not_found() { + assert_eq!( + jsonrpc_http_status(&error_message(ErrorCode::METHOD_NOT_FOUND)), + http::StatusCode::NOT_FOUND + ); + } + + #[test] + fn unmapped_error_defaults_to_ok() { + assert_eq!( + jsonrpc_http_status(&error_message(ErrorCode::INTERNAL_ERROR)), + http::StatusCode::OK + ); + } +} + +#[cfg(test)] +mod standard_header_init_tests { + use super::*; + + fn initialize_message() -> ClientJsonRpcMessage { + ClientJsonRpcMessage::request( + ClientRequest::InitializeRequest(InitializeRequest { + params: InitializeRequestParams { + protocol_version: ProtocolVersion::STANDARD_HEADERS, + ..Default::default() + }, + ..Default::default() + }), + RequestId::Number(1), + ) + } + + fn headers_with(mcp_method: Option<&str>) -> HeaderMap { + let mut headers = HeaderMap::new(); + headers.insert( + HEADER_MCP_PROTOCOL_VERSION, + http::HeaderValue::from_static(ProtocolVersion::STANDARD_HEADERS.as_str()), + ); + if let Some(method) = mcp_method { + headers.insert( + HEADER_MCP_METHOD, + method.parse::().unwrap(), + ); + } + headers + } + + fn no_tool_schema(_: &str) -> Option> { + None + } + + /// A supplied Mcp-Method header contradicting an initialize body must be + /// rejected at >= STANDARD_HEADERS. Regression test for + /// https://github.com/modelcontextprotocol/rust-sdk/issues/1271 + #[test] + fn initialize_rejects_contradicting_mcp_method_header() { + let headers = headers_with(Some("tools/list")); + assert!( + validate_standard_headers(&headers, &initialize_message(), no_tool_schema).is_err() + ); + } + + /// Absence of the Mcp-Method header on initialize stays accepted: clients + /// emit SEP-2243 headers only after the version has been negotiated. + #[test] + fn initialize_accepts_missing_mcp_method_header() { + let headers = headers_with(None); + assert!(validate_standard_headers(&headers, &initialize_message(), no_tool_schema).is_ok()); + } + + /// A supplied Mcp-Method header matching the initialize body is accepted. + #[test] + fn initialize_accepts_matching_mcp_method_header() { + let headers = headers_with(Some("initialize")); + assert!(validate_standard_headers(&headers, &initialize_message(), no_tool_schema).is_ok()); + } + + /// Conflicting duplicate Mcp-Method values are rejected in both orders: + /// only the first value used to be checked, so an appended contradictory + /// value passed silently. Duplicate values are rejected explicitly. + #[test] + fn initialize_rejects_conflicting_duplicates_in_both_orders() { + for (first, second) in [("initialize", "tools/list"), ("tools/list", "initialize")] { + let mut headers = headers_with(Some(first)); + headers.append( + HEADER_MCP_METHOD, + http::HeaderValue::from_str(second).unwrap(), + ); + assert!( + validate_standard_headers(&headers, &initialize_message(), no_tool_schema).is_err() + ); + } + } + + /// A present but non-UTF8 Mcp-Method value is rejected: it must not be + /// silently treated as an absent header. + #[test] + fn initialize_rejects_present_non_text_method() { + let mut headers = headers_with(None); + let value = http::HeaderValue::from_bytes(&[0xff]).unwrap(); + assert!(value.to_str().is_err()); + headers.insert(HEADER_MCP_METHOD, value); + assert!( + validate_standard_headers(&headers, &initialize_message(), no_tool_schema).is_err() + ); + } +} + +fn jsonrpc_message_response( + message: ServerJsonRpcMessage, + map_protocol_status: bool, +) -> HttpResult { + let status = if map_protocol_status { + jsonrpc_http_status(&message) + } else { + http::StatusCode::OK + }; + let body = + serde_json::to_vec(&message).map_err(internal_error_response("serialize json response"))?; + Ok(Response::builder() + .status(status) + .header(http::header::CONTENT_TYPE, JSON_MIME_TYPE) + .body(Full::new(Bytes::from(body)).boxed()) + .expect("valid response")) +} + +fn header_mismatch_jsonrpc_response( + id: Option, + message: impl Into>, +) -> BoxResponse { + let err = JsonRpcError::new(id, ErrorData::header_mismatch(message, None)); + let body = serde_json::to_vec(&err).expect("serialize JsonRpcError"); + Response::builder() + .status(http::StatusCode::BAD_REQUEST) + .header(http::header::CONTENT_TYPE, JSON_MIME_TYPE) + .body(Full::new(Bytes::from(body)).boxed()) + .expect("valid response") +} + +/// Validates SEP-2243 `Mcp-Method` / `Mcp-Name` / `Mcp-Param-*` headers against the body. +/// +/// Only enforced when the request declares a protocol version `>= STANDARD_HEADERS`. +/// The `initialize` handshake is exempt from *requiring* them: clients emit these +/// headers only after the version has been negotiated. But like +/// `validate_header_matches_init_body`, a *supplied* `Mcp-Method` header that +/// contradicts the body is rejected — middleboxes route on the header without +/// parsing the body. `tool_schema` supplies the called tool's input schema +/// so annotated `Mcp-Param-*` headers can be checked (no schema => those are skipped). +fn validate_standard_headers( + headers: &HeaderMap, + message: &ClientJsonRpcMessage, + tool_schema: impl Fn(&str) -> Option>, +) -> HttpResult<()> { + let version_requires_headers = headers + .get(HEADER_MCP_PROTOCOL_VERSION) + .and_then(|value| value.to_str().ok()) + .is_some_and(|version| version >= ProtocolVersion::STANDARD_HEADERS.as_str()); + if !version_requires_headers { + return Ok(()); + } + + let request_id = match message { + ClientJsonRpcMessage::Request(req) => { + if matches!(&req.request, ClientRequest::InitializeRequest(_)) { + // The handshake may omit SEP-2243 headers, but a supplied + // Mcp-Method header must still agree with the body: middleboxes + // route on the header without parsing the body. `get_all` is + // used so every supplied value is inspected: a contradictory + // duplicate must not hide behind a matching first value, and a + // present-but-non-UTF8 value is rejected rather than silently + // treated as absent. Duplicates (even identical ones) are + // rejected explicitly instead of passing by accident. + let mut method_values = headers.get_all(HEADER_MCP_METHOD).iter(); + let Some(first) = method_values.next() else { + return Ok(()); + }; + if method_values.next().is_some() { + return Err(header_mismatch_jsonrpc_response( + Some(req.id.clone()), + "multiple Mcp-Method header values supplied; initialize requires exactly one", + ) + .into()); + } + if first != http::HeaderValue::from_static("initialize") { + return Err(header_mismatch_jsonrpc_response( + Some(req.id.clone()), + format!( + "Mcp-Method header `{}` does not match body method `initialize`", + String::from_utf8_lossy(first.as_bytes()) + ), + ) + .into()); + } + return Ok(()); + } + Some(req.id.clone()) + } + ClientJsonRpcMessage::Notification(_) => None, + _ => return Ok(()), + }; + + let Ok(value) = serde_json::to_value(message) else { + return Ok(()); + }; + // For tools/call, look up the tool schema so Mcp-Param-* headers are validated. + let schema = value + .get("method") + .and_then(|method| method.as_str()) + .filter(|method| *method == "tools/call") + .and_then(|_| value.get("params")) + .and_then(|params| params.get("name")) + .and_then(|name| name.as_str()) + .and_then(tool_schema); + if let Err(reason) = mcp_headers::validate_request_headers(headers, &value, schema.as_deref()) { + return Err(header_mismatch_jsonrpc_response(request_id, reason).into()); + } + Ok(()) +} + +fn forbidden_response(message: impl Into) -> BoxResponse { + Response::builder() + .status(http::StatusCode::FORBIDDEN) + .body(Full::new(Bytes::from(message.into())).boxed()) + .expect("valid response") +} + +fn normalize_host(host: &str) -> String { + host.trim_matches('[') + .trim_matches(']') + .to_ascii_lowercase() +} + +#[derive(Debug, Clone, PartialEq, Eq)] +struct NormalizedAuthority { + host: String, + port: Option, +} + +fn normalize_authority(host: &str, port: Option) -> NormalizedAuthority { + NormalizedAuthority { + host: normalize_host(host), + port, + } +} + +fn parse_allowed_authority(allowed: &str) -> Option { + let allowed = allowed.trim(); + if allowed.is_empty() { + return None; + } + + if let Ok(authority) = http::uri::Authority::try_from(allowed) { + return Some(normalize_authority(authority.host(), authority.port_u16())); + } + + Some(normalize_authority(allowed, None)) +} + +fn host_is_allowed(host: &NormalizedAuthority, allowed_hosts: &[String]) -> bool { + if allowed_hosts.is_empty() { + // If the allowed hosts list is empty, allow all hosts (not recommended). + return true; + } + allowed_hosts + .iter() + .filter_map(|allowed| parse_allowed_authority(allowed)) + .any(|allowed| { + allowed.host == host.host + && match allowed.port { + Some(port) => host.port == Some(port), + None => true, + } + }) +} + +#[derive(Debug, Clone, PartialEq, Eq)] +enum NormalizedOrigin { + Null, + Tuple { + scheme: String, + host: String, + port: Option, + }, +} + +fn parse_origin_value(value: &str) -> Option { + let value = value.trim(); + if value.is_empty() { + return None; + } + if value.eq_ignore_ascii_case("null") { + return Some(NormalizedOrigin::Null); + } + let uri = http::Uri::try_from(value).ok()?; + let scheme = uri.scheme_str()?.to_ascii_lowercase(); + let authority = uri.authority()?; + Some(NormalizedOrigin::Tuple { + scheme, + host: normalize_host(authority.host()), + port: authority.port_u16(), + }) +} + +/// The port a scheme implies when an origin serialization omits it (RFC 6454 §4). +fn default_port(scheme: &str) -> Option { + match scheme { + "http" => Some(80), + "https" => Some(443), + _ => None, + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +enum AllowedPort { + /// `:*` + Any, + /// No port in the entry. Matches any port until the deprecation ends. + Unspecified, + Exact(u16), +} + +impl AllowedPort { + fn matches(self, scheme: &str, port: Option) -> bool { + match self { + AllowedPort::Any | AllowedPort::Unspecified => true, + // RFC 6454 §6.2 omits the default port when serializing an origin. + AllowedPort::Exact(allowed) => port.or_else(|| default_port(scheme)) == Some(allowed), + } + } +} + +#[derive(Debug, Clone, PartialEq, Eq)] +enum AllowedOrigin { + Null, + Tuple { + scheme: String, + host: String, + port: AllowedPort, + }, +} + +fn parse_allowed_origin(value: &str) -> Option { + let value = value.trim(); + if let Some(base) = value.strip_suffix(":*") { + let NormalizedOrigin::Tuple { + scheme, + host, + port: None, + } = parse_origin_value(base)? + else { + return None; + }; + return Some(AllowedOrigin::Tuple { + scheme, + host, + port: AllowedPort::Any, + }); + } + Some(match parse_origin_value(value)? { + NormalizedOrigin::Null => AllowedOrigin::Null, + NormalizedOrigin::Tuple { scheme, host, port } => AllowedOrigin::Tuple { + scheme, + host, + port: port.map_or(AllowedPort::Unspecified, AllowedPort::Exact), + }, + }) +} + +fn origin_is_allowed(origin: &NormalizedOrigin, allowed_origins: &[String]) -> bool { + allowed_origins + .iter() + .filter_map(|raw| parse_allowed_origin(raw)) + .any(|allowed| match (&allowed, origin) { + (AllowedOrigin::Null, NormalizedOrigin::Null) => true, + ( + AllowedOrigin::Tuple { + scheme: a_scheme, + host: a_host, + port: a_port, + }, + NormalizedOrigin::Tuple { + scheme: o_scheme, + host: o_host, + port: o_port, + }, + ) => a_scheme == o_scheme && a_host == o_host && a_port.matches(o_scheme, *o_port), + _ => false, + }) +} + +fn warn_on_portless_allowed_origins(allowed_origins: &[String]) { + for raw in allowed_origins { + if let Some(AllowedOrigin::Tuple { + port: AllowedPort::Unspecified, + .. + }) = parse_allowed_origin(raw) + { + tracing::warn!( + allowed_origin = raw.as_str(), + "allowed origin without a port matches any port; a future release will match \ + only the scheme default port. Use `:*` or an explicit port instead", + ); + } + } +} + +#[cfg(test)] +mod parse_allowed_origin_tests { + use super::*; + + fn tuple(scheme: &str, host: &str, port: AllowedPort) -> Option { + Some(AllowedOrigin::Tuple { + scheme: scheme.to_string(), + host: host.to_string(), + port, + }) + } + + #[test] + fn wildcard_port_parses_as_any() { + assert_eq!( + parse_allowed_origin("https://client.example:*"), + tuple("https", "client.example", AllowedPort::Any) + ); + } + + #[test] + fn wildcard_port_on_ipv6_host_parses_as_any() { + assert_eq!( + parse_allowed_origin("http://[::1]:*"), + tuple("http", "::1", AllowedPort::Any) + ); + } + + #[test] + fn portless_entry_parses_as_unspecified() { + assert_eq!( + parse_allowed_origin("https://client.example"), + tuple("https", "client.example", AllowedPort::Unspecified) + ); + } + + #[test] + fn explicit_port_parses_as_exact() { + assert_eq!( + parse_allowed_origin("https://client.example:8443"), + tuple("https", "client.example", AllowedPort::Exact(8443)) + ); + } + + #[test] + fn wildcard_after_explicit_port_is_rejected() { + assert_eq!(parse_allowed_origin("https://client.example:443:*"), None); + } + + #[test] + fn wildcard_on_null_is_rejected() { + assert_eq!(parse_allowed_origin("null:*"), None); + } +} + +fn bad_request_response(message: &str) -> BoxResponse { + let body = Full::from(message.to_string()).boxed(); + + http::Response::builder() + .status(http::StatusCode::BAD_REQUEST) + .header(http::header::CONTENT_TYPE, "text/plain; charset=utf-8") + .body(body) + .expect("failed to build bad request response") +} + +fn parse_host_header(uri: &http::Uri, headers: &HeaderMap) -> HttpResult { + if let Some(host) = headers.get(http::header::HOST) { + let host_str = host + .to_str() + .inspect_err(|_| { + tracing::warn!(host = ?host, "rejected request with non-UTF-8 Host header"); + }) + .map_err(|_| bad_request_response("Bad Request: Invalid Host header encoding"))?; + let authority = http::uri::Authority::try_from(host_str) + .inspect_err(|_| { + tracing::warn!( + host = host_str, + "rejected request with malformed Host header" + ); + }) + .map_err(|_| bad_request_response("Bad Request: Invalid Host header"))?; + return Ok(normalize_authority(authority.host(), authority.port_u16())); + } + // HTTP/2 carries the host in `:authority`; middleware such as + // `axum::Router::nest` can drop the `Host` header hyper synthesizes from it. + let authority = uri.authority().ok_or_else(|| { + tracing::warn!("rejected request with missing Host header and no :authority"); + bad_request_response("Bad Request: missing Host header") + })?; + Ok(normalize_authority(authority.host(), authority.port_u16())) +} + +fn validate_dns_rebinding_headers( + uri: &http::Uri, + headers: &HeaderMap, + config: &StreamableHttpServerConfig, +) -> HttpResult<()> { + let host = parse_host_header(uri, headers)?; + if !host_is_allowed(&host, &config.allowed_hosts) { + tracing::warn!( + host = ?host, + "rejected request with disallowed Host header (possible DNS rebinding attempt)", + ); + return Err(forbidden_response("Forbidden: Host header is not allowed").into()); + } + validate_origin_header(headers, config)?; + Ok(()) +} + +fn validate_origin_header( + headers: &HeaderMap, + config: &StreamableHttpServerConfig, +) -> HttpResult<()> { + if !config.validate_empty_origin_allowlist && config.allowed_origins.is_empty() { + return Ok(()); + } + let Some(origin_header) = headers.get(http::header::ORIGIN) else { + return Ok(()); + }; + let origin_str = origin_header + .to_str() + .inspect_err(|_| { + tracing::warn!(origin = ?origin_header, "rejected request with non-UTF-8 Origin header"); + }) + .map_err(|_| forbidden_response("Forbidden: Invalid Origin header encoding"))?; + let origin = parse_origin_value(origin_str).ok_or_else(|| { + tracing::warn!( + origin = origin_str, + "rejected request with malformed Origin header", + ); + forbidden_response("Forbidden: Invalid Origin header") + })?; + if !origin_is_allowed(&origin, &config.allowed_origins) { + tracing::warn!( + origin = ?origin, + "rejected request with disallowed Origin header (possible cross-origin attack)", + ); + return Err(forbidden_response("Forbidden: Origin header is not allowed").into()); + } + Ok(()) +} + +/// # Streamable HTTP server +/// +/// An HTTP service that implements the +/// [Streamable HTTP transport](https://modelcontextprotocol.io/specification/2026-07-28/basic/transports/streamable-http) +/// for MCP servers. +/// +/// ## Session management +/// +/// When [`StreamableHttpServerConfig::legacy_session_mode`] is `true` (the default), +/// the server creates a session for each client that sends an `initialize` +/// request. The session ID is returned in the `Mcp-Session-Id` response header +/// and the client must include it on all subsequent requests. +/// +/// Two tool calls carrying the same `Mcp-Session-Id` come from the same logical +/// session (typically one conversation in an LLM client). Different session IDs +/// mean different sessions. +/// +/// The [`SessionManager`] trait controls how sessions are stored and routed: +/// +/// * [`LocalSessionManager`](super::session::local::LocalSessionManager) — +/// in-memory session store (default). +/// * [`NeverSessionManager`](super::session::never::NeverSessionManager) — +/// disables sessions entirely (stateless mode). +/// +/// ## Accessing HTTP request data from tool handlers +/// +/// The service consumes the request body but injects the remaining +/// [`http::request::Parts`] into [`crate::model::Extensions`], which is +/// accessible through [`crate::service::RequestContext`]. +/// +/// ### Reading the raw HTTP parts +/// +/// ```rust +/// use rmcp::handler::server::tool::Extension; +/// use http::request::Parts; +/// async fn my_tool(Extension(parts): Extension) { +/// tracing::info!("http parts:{parts:?}") +/// } +/// ``` +/// +/// ### Reading the session ID inside a tool handler +/// +/// ```rust,ignore +/// use rmcp::handler::server::tool::Extension; +/// use rmcp::service::RequestContext; +/// use rmcp::model::RoleServer; +/// +/// #[tool(description = "session-aware tool")] +/// async fn my_tool( +/// &self, +/// Extension(parts): Extension, +/// ) -> Result { +/// if let Some(session_id) = parts.headers.get("mcp-session-id") { +/// tracing::info!(?session_id, "called from session"); +/// } +/// // ... +/// # todo!() +/// } +/// ``` +/// +/// ### Accessing custom axum/tower extension state +/// +/// State added via axum's `Extension` layer is available inside +/// `Parts.extensions`: +/// +/// ```rust,ignore +/// use rmcp::service::RequestContext; +/// use rmcp::model::RoleServer; +/// +/// #[derive(Clone)] +/// struct AppState { /* ... */ } +/// +/// #[tool(description = "example")] +/// async fn my_tool( +/// &self, +/// ctx: RequestContext, +/// ) -> Result { +/// let parts = ctx.extensions.get::().unwrap(); +/// let state = parts.extensions.get::().unwrap(); +/// // use state... +/// # todo!() +/// } +/// ``` +pub struct StreamableHttpService { + pub config: StreamableHttpServerConfig, + session_manager: Arc, + service_factory: Arc Result + Send + Sync>, + /// Tracks in-progress session restores so that concurrent requests for the + /// same unknown session ID wait for the first restore to complete rather + /// than racing to replay the initialize handshake. `None` when no external + /// session store is configured (avoids allocating the map). + pending_restores: Option, + /// Caches tool input schemas by name for SEP-2243 `Mcp-Param-*` validation. + /// Populated lazily via `get_tool` so the service factory runs at most once + /// per tool name. `None` value means the tool exposes no schema. + tool_schemas: Arc>>>>, +} + +impl Clone for StreamableHttpService { + fn clone(&self) -> Self { + Self { + config: self.config.clone(), + session_manager: self.session_manager.clone(), + service_factory: self.service_factory.clone(), + pending_restores: self.pending_restores.clone(), + tool_schemas: self.tool_schemas.clone(), + } + } +} + +impl tower_service::Service> for StreamableHttpService +where + RequestBody: Body + Send + 'static, + S: crate::ServerHandler + Send + 'static, + M: SessionManager, + RequestBody::Error: Display, + RequestBody::Data: Send + 'static, +{ + type Response = BoxResponse; + type Error = Infallible; + type Future = BoxFuture<'static, Result>; + fn call(&mut self, req: http::Request) -> Self::Future { + let service = self.clone(); + Box::pin(async move { + let response = service.handle(req).await; + Ok(response) + }) + } + fn poll_ready( + &mut self, + _cx: &mut std::task::Context<'_>, + ) -> std::task::Poll> { + std::task::Poll::Ready(Ok(())) + } +} + +/// Guard used inside [`StreamableHttpService::try_restore_from_store`]. +/// +/// Ensures the `pending_restores` map entry is always cleaned up — even when +/// the future is cancelled mid-await. +/// +/// `result` defaults to `false` (failure / cancellation). Only the success path +/// needs to set it to `true` before returning. +struct PendingRestoreGuard { + pending_restores: PendingRestores, + session_id: SessionId, + watch_tx: RestoreResultSender, + /// The value that will be broadcast to waiting tasks on drop. + result: bool, +} + +impl Drop for PendingRestoreGuard { + fn drop(&mut self) { + // `send` is synchronous — unblocks waiters immediately, no lock needed. + let _ = self.watch_tx.send(Some(self.result)); + // Remove the map entry asynchronously (requires the async write lock). + let pending_restores = self.pending_restores.clone(); + let session_id = self.session_id.clone(); + tokio::spawn(async move { + pending_restores.write().await.remove(&session_id); + }); + } +} + +impl StreamableHttpService +where + S: crate::ServerHandler + Send + 'static, + M: SessionManager, +{ + pub fn new( + service_factory: impl Fn() -> Result + Send + Sync + 'static, + session_manager: Arc, + config: StreamableHttpServerConfig, + ) -> Self { + warn_on_portless_allowed_origins(&config.allowed_origins); + let pending_restores = config + .session_store + .is_some() + .then(|| Arc::new(tokio::sync::RwLock::new(HashMap::new()))); + Self { + config, + session_manager, + service_factory: Arc::new(service_factory), + pending_restores, + tool_schemas: Arc::new(std::sync::RwLock::new(HashMap::new())), + } + } + fn get_service(&self) -> Result { + (self.service_factory)() + } + + fn persisted_stateless_stream( + &self, + first: Option, + mut receiver: tokio::sync::mpsc::Receiver, + request_ct: CancellationToken, + event_store: Arc, + ) -> ReceiverStream { + let (sender, output) = tokio::sync::mpsc::channel(STATELESS_STREAM_CHANNEL_CAPACITY); + let stream_id = uuid::Uuid::new_v4().to_string(); + let retry = self.config.sse_retry; + let server_ct = self.config.cancellation_token.child_token(); + + tokio::spawn(async move { + let mut sender = Some(sender); + if let Some(retry) = retry + && let Err(error) = persist_and_forward_event( + event_store.as_ref(), + &stream_id, + ServerSseMessage::retry(retry), + &mut sender, + ) + .await + { + tracing::error!(%stream_id, %error, "failed to persist SSE priming event"); + request_ct.cancel(); + return; + } + + let mut first = first; + loop { + let message = if let Some(message) = first.take() { + Some(message) + } else { + tokio::select! { + message = receiver.recv() => message, + _ = server_ct.cancelled() => { + request_ct.cancel(); + None + } + } + }; + let Some(message) = message else { + break; + }; + tracing::trace!(?message); + if let Err(error) = persist_and_forward_event( + event_store.as_ref(), + &stream_id, + ServerSseMessage::from_message(message), + &mut sender, + ) + .await + { + tracing::error!(%stream_id, %error, "failed to persist SSE event"); + request_ct.cancel(); + break; + } + } + }); + + ReceiverStream::new(output) + } + + fn stateless_sse_response( + &self, + first: Option, + receiver: tokio::sync::mpsc::Receiver, + request_ct: CancellationToken, + ) -> BoxResponse { + if let Some(event_store) = self.session_manager.event_store() { + let stream = self.persisted_stateless_stream(first, receiver, request_ct, event_store); + sse_stream_response( + stream, + self.config.sse_keep_alive, + self.config.cancellation_token.child_token(), + ) + } else { + let stream = futures::stream::iter(first) + .chain(ReceiverStream::new(receiver)) + .map(|message| { + tracing::trace!(?message); + ServerSseMessage::from_message(message) + }); + sse_stream_response( + CancelOnDisconnect::new(stream, request_ct), + self.config.sse_keep_alive, + self.config.cancellation_token.child_token(), + ) + } + } + + // The HTTP status must be known before opening an SSE stream. + async fn serve_negotiated_request_directly( + &self, + service: S, + mut request: crate::model::JsonRpcRequest, + parts: http::request::Parts, + ) -> HttpResult { + let peer_info = Self::peer_info_for_stateless_request(&request, &parts.headers); + request.request.extensions_mut().insert(parts); + let (transport, mut receiver) = + OneshotTransport::::new(ClientJsonRpcMessage::Request(request)); + // Give this stateless request its own cancellation token so a client + // disconnect can cancel the in-flight handler (#857), as in the + // non-negotiated stateless path below. + let request_ct = CancellationToken::new(); + let service = serve_directly_with_ct( + NegotiatingStatelessHttpService(service), + transport, + peer_info, + request_ct.clone(), + ); + tokio::spawn(async move { + let _ = service.waiting().await; + }); + + let cancel = self.config.cancellation_token.child_token(); + // Cancel the handler if the client disconnects while it is still + // producing its first message (this future is dropped before + // `receiver.recv()` completes). Disarmed once the handler emits + // anything, so a normal response is never cancelled. + let mut disconnect_guard = Some(request_ct.clone().drop_guard()); + let first = tokio::select! { + message = receiver.recv() => { + if let Some(guard) = disconnect_guard.take() { + guard.disarm(); + } + message + } + _ = cancel.cancelled() => None, + } + .ok_or_else(|| { + internal_error_response("empty response")(std::io::Error::new( + std::io::ErrorKind::UnexpectedEof, + "no response message received from handler", + )) + })?; + + let terminal = matches!( + &first, + ServerJsonRpcMessage::Response(_) | ServerJsonRpcMessage::Error(_) + ); + if terminal + && (self.config.json_response || jsonrpc_http_status(&first) != http::StatusCode::OK) + { + // This message is the whole reply, so `receiver` is dropped here and + // anything the handler emits afterwards is undeliverable. Cancel it so + // a still-running handler stops instead of running on unobserved: its + // terminal `send` would otherwise fail before adding the termination + // permit, leaving the serve loop parked forever. A no-op when the + // handler already completed. + request_ct.cancel(); + return jsonrpc_message_response(first, true); + } + + Ok(self.stateless_sse_response(Some(first), receiver, request_ct)) + } + + /// Returns the cached input schema for `name`, constructing a service once + /// per name to read its `ServerHandler::get_tool` definition. Used to + /// validate SEP-2243 `Mcp-Param-*` headers against the request body. + fn tool_schema(&self, name: &str) -> Option> { + if let Ok(cache) = self.tool_schemas.read() + && let Some(schema) = cache.get(name) + { + return schema.clone(); + } + let schema = self + .get_service() + .ok() + .and_then(|service| service.get_tool(name)) + .map(|tool| tool.input_schema); + if let Ok(mut cache) = self.tool_schemas.write() { + cache.insert(name.to_owned(), schema.clone()); + } + schema + } + + /// Spawn a task that runs `serve_server` for the given session, waits for + /// it to finish, and then calls `close_session`. + /// + /// `init_done_tx`: when `Some`, the sender is fired after `serve_server` + /// returns successfully, signalling to the caller that the MCP handshake + /// is complete. Used by `try_restore_from_store` to synchronise with the + /// restore `initialize` replay; `handle_post` passes `None`. + fn spawn_session_worker( + session_manager: Arc, + session_id: SessionId, + service: S, + transport: M::Transport, + init_done_tx: Option>, + ) where + S: crate::ServerHandler + Send + 'static, + M: SessionManager, + { + tokio::spawn(async move { + let svc = + serve_server::(service, transport) + .await; + match svc { + Ok(svc) => { + if let Some(tx) = init_done_tx { + let _ = tx.send(()); + } + let _ = svc.waiting().await; + } + Err(e) => { + tracing::error!("Failed to serve session: {e}"); + // Dropping init_done_tx (if Some) signals failure to the caller. + } + } + let _ = session_manager + .close_session(&session_id) + .await + .inspect_err(|e| { + tracing::error!("Failed to close session {session_id}: {e}"); + }); + }); + } + + /// Attempt to restore a session from the external store. + /// + /// Returns `true` when the session is available and ready to serve the + /// current request (either just restored or already in memory). Returns + /// `false` when no store is configured or the session ID is unknown. + /// + /// Concurrent requests for the same unknown session ID are serialized: the + /// first caller performs the full restore and handshake replay while others + /// subscribe to a `watch` channel and wait, avoiding duplicate handshakes. + async fn try_restore_from_store( + &self, + session_id: &SessionId, + parts: &http::request::Parts, + ) -> Result + where + S: crate::ServerHandler + Send + 'static, + M: SessionManager, + { + // Both fields are Some iff a session store is configured. + let (Some(pending_restores), Some(store)) = + (&self.pending_restores, &self.config.session_store) + else { + return Ok(false); + }; + + // Serialize concurrent restores for the same session ID. + // Write-lock once: if another task is already restoring, subscribe and wait; + // otherwise, register ourselves as the restoring task. + // Channel value: None = in progress, Some(true) = restored, Some(false) = not found/failed. + let (watch_tx, _watch_rx) = tokio::sync::watch::channel(None::); + { + let mut pending = pending_restores.write().await; + if let Some(tx) = pending.get(session_id) { + let mut rx = tx.subscribe(); + drop(pending); + // Wait for the restore to finish, then propagate the outcome. + let result = rx + .wait_for(|r| r.is_some()) + .await + .map(|r| r.unwrap_or(false)) + .unwrap_or(false); + return Ok(result); + } + pending.insert(session_id.clone(), watch_tx.clone()); + } + + // Guard: signals waiters and cleans up the map entry on drop + let mut guard = PendingRestoreGuard { + pending_restores: pending_restores.clone(), + session_id: session_id.clone(), + watch_tx: watch_tx.clone(), + result: false, + }; + + // --- Step 3: load from external store --- + let state = match store.load(session_id.as_ref()).await { + Ok(Some(s)) => s, + Ok(None) => { + return Ok(false); + } + Err(e) => { + tracing::error!( + session_id = session_id.as_ref(), + error = %e, + "session store load failed during restore" + ); + return Err(std::io::Error::other(e)); + } + }; + + // --- Step 4: ask the session manager to allocate an in-memory worker --- + let transport = match self + .session_manager + .restore_session(session_id.clone()) + .await + .map_err(|e| std::io::Error::other(e.to_string())) + { + Ok(RestoreOutcome::Restored(t)) => t, + Ok(RestoreOutcome::AlreadyPresent) => { + // Invariant violation: pending_restores ensures only one task can call + // restore_session per session ID, so AlreadyPresent is impossible here. + return Err(std::io::Error::other( + "restore_session returned AlreadyPresent unexpectedly; session manager might have modified the session store outside of the restore_session API", + )); + } + Ok(RestoreOutcome::NotSupported) => { + return Ok(false); + } + Err(e) => { + return Err(e); + } + }; + + // --- Step 5: replay the MCP initialize handshake --- + let service = match self.get_service() { + Ok(s) => s, + Err(e) => { + return Err(e); + } + }; + + // `serve_server` requires both the `initialize` request and the + // `notifications/initialized` notification before transitioning to + // the running state — we must send both before returning. + let mut restore_init = ClientJsonRpcMessage::request( + ClientRequest::InitializeRequest(InitializeRequest { + params: state.initialize_params, + ..Default::default() + }), + crate::model::NumberOrString::Number(0), + ); + restore_init.insert_extension(parts.clone()); + restore_init.insert_extension(SessionRestoreMarker { + id: session_id.clone(), + }); + let mut restore_initialized = ClientJsonRpcMessage::notification( + ClientNotification::InitializedNotification(InitializedNotification { + ..Default::default() + }), + ); + restore_initialized.insert_extension(parts.clone()); + restore_initialized.insert_extension(SessionRestoreMarker { + id: session_id.clone(), + }); + // Signal from the spawned task once serve_server finishes initialising. + let (init_done_tx, init_done_rx) = tokio::sync::oneshot::channel::<()>(); + + Self::spawn_session_worker( + self.session_manager.clone(), + session_id.clone(), + service, + transport, + Some(init_done_tx), + ); + + self.session_manager + .initialize_session(session_id, restore_init) + .await + .map_err(|e| std::io::Error::other(e.to_string()))?; + + self.session_manager + .accept_message(session_id, restore_initialized) + .await + .map_err(|e| std::io::Error::other(e.to_string()))?; + + if init_done_rx.await.is_err() { + return Err(std::io::Error::other( + "serve_server initialization failed during restore", + )); + } + + // Restore complete — wake any waiting concurrent requests. + guard.result = true; + + tracing::debug!( + session_id = session_id.as_ref(), + "session restored from external store" + ); + Ok(true) + } + pub async fn handle(&self, request: Request) -> Response> + where + B: Body + Send + 'static, + B::Error: Display, + { + if let Err(response) = + validate_dns_rebinding_headers(request.uri(), request.headers(), &self.config) + { + return response.into_response(); + } + let method = request.method().clone(); + let supports_stateless_replay = self.session_manager.event_store().is_some(); + let allowed_methods = match (self.config.legacy_session_mode, supports_stateless_replay) { + (true, _) => "GET, POST, DELETE", + (false, true) => "GET, POST", + (false, false) => "POST", + }; + let result = match method { + Method::POST => self.handle_post(request).await, + Method::GET if self.config.legacy_session_mode || supports_stateless_replay => { + self.handle_get(request).await + } + Method::DELETE if self.config.legacy_session_mode => self.handle_delete(request).await, + _ => { + // Handle other methods or return an error + let response = Response::builder() + .status(http::StatusCode::METHOD_NOT_ALLOWED) + .header(ALLOW, allowed_methods) + .body(Full::new(Bytes::from("Method Not Allowed")).boxed()) + .expect("valid response"); + return response; + } + }; + match result { + Ok(response) => response, + Err(response) => response.into_response(), + } + } + async fn handle_get(&self, request: Request) -> HttpResult + where + B: Body + Send + 'static, + B::Error: Display, + { + // check accept header + if !request + .headers() + .get(http::header::ACCEPT) + .and_then(|header| header.to_str().ok()) + .is_some_and(|header| header.contains(EVENT_STREAM_MIME_TYPE)) + { + return Ok(Response::builder() + .status(http::StatusCode::NOT_ACCEPTABLE) + .body( + Full::new(Bytes::from( + "Not Acceptable: Client must accept text/event-stream", + )) + .boxed(), + ) + .expect("valid response")); + } + let request_uses_legacy_protocol = is_legacy_request(None, request.headers())?; + let legacy_request = self.config.legacy_session_mode && request_uses_legacy_protocol; + if !legacy_request { + let Some(last_event_id) = request + .headers() + .get(HEADER_LAST_EVENT_ID) + .and_then(|value| value.to_str().ok()) + else { + return Ok(method_not_allowed_response()); + }; + let Some(event_store) = self.session_manager.event_store() else { + return Ok(method_not_allowed_response()); + }; + let stream = match event_store.replay_events_after(last_event_id).await { + Ok(stream) => stream, + Err(error) => { + tracing::warn!(%error, "stateless SSE resume failed, returning empty stream"); + Box::pin(futures::stream::empty()) + } + }; + return Ok(sse_stream_response( + stream, + self.config.sse_keep_alive, + self.config.cancellation_token.child_token(), + )); + } + // check session id + let session_id = request + .headers() + .get(HEADER_SESSION_ID) + .and_then(|v| v.to_str().ok()) + .map(|s| s.to_owned().into()); + let Some(session_id) = session_id else { + // MCP spec: servers that require a session ID SHOULD respond with 400 Bad Request + return Ok(Response::builder() + .status(http::StatusCode::BAD_REQUEST) + .body(Full::new(Bytes::from("Bad Request: Session ID is required")).boxed()) + .expect("valid response")); + }; + // check if session exists + let has_session = self + .session_manager + .has_session(&session_id) + .await + .map_err(internal_error_response("check session"))?; + let (parts, _) = request.into_parts(); + if !has_session { + // Attempt transparent cross-instance restore from external store. + let restored = self + .try_restore_from_store(&session_id, &parts) + .await + .map_err(internal_error_response("restore session"))?; + if !restored { + // MCP spec: server MUST respond with 404 Not Found for terminated/unknown sessions + return Ok(Response::builder() + .status(http::StatusCode::NOT_FOUND) + .body(Full::new(Bytes::from("Not Found: Session not found")).boxed()) + .expect("valid response")); + } + } + // Validate MCP-Protocol-Version header (per 2025-06-18 spec) + validate_protocol_version_header(&parts.headers, false)?; + // check if last event id is provided + let last_event_id = parts + .headers + .get(HEADER_LAST_EVENT_ID) + .and_then(|v| v.to_str().ok()) + .map(|s| s.to_owned()); + if let Some(last_event_id) = last_event_id { + match self + .session_manager + .resume(&session_id, last_event_id) + .await + { + Ok(stream) => { + return Ok(sse_stream_response( + stream, + self.config.sse_keep_alive, + self.config.cancellation_token.child_token(), + )); + } + Err(e) => { + // Return 200 with an immediately-closed empty stream. + // Returning an HTTP error would cause EventSource to retry + // with the same Last-Event-ID in an infinite loop. An empty + // 200 cleanly terminates the EventSource without delivering + // events from a different stream. + tracing::warn!("Resume failed ({e}), returning empty stream"); + return Ok(sse_stream_response( + futures::stream::empty(), + None, + self.config.cancellation_token.child_token(), + )); + } + } + } + // No Last-Event-ID — create standalone stream + let stream = self + .session_manager + .create_standalone_stream(&session_id) + .await + .map_err(internal_error_response("create standalone stream"))?; + let stream = if let Some(retry) = self.config.sse_retry { + let priming = if self.session_manager.event_store().is_some() { + ServerSseMessage::retry(retry) + } else { + ServerSseMessage::priming("0", retry) + }; + futures::stream::once(async move { priming }) + .chain(stream) + .left_stream() + } else { + stream.right_stream() + }; + Ok(sse_stream_response( + stream, + self.config.sse_keep_alive, + self.config.cancellation_token.child_token(), + )) + } + + async fn handle_post(&self, request: Request) -> HttpResult + where + B: Body + Send + 'static, + B::Error: Display, + { + // check accept header + if !request + .headers() + .get(http::header::ACCEPT) + .and_then(|header| header.to_str().ok()) + .is_some_and(|header| { + header.contains(JSON_MIME_TYPE) && header.contains(EVENT_STREAM_MIME_TYPE) + }) + { + return Ok(Response::builder() + .status(http::StatusCode::NOT_ACCEPTABLE) + .body(Full::new(Bytes::from("Not Acceptable: Client must accept both application/json and text/event-stream")).boxed()) + .expect("valid response")); + } + + // check content type + if !request + .headers() + .get(http::header::CONTENT_TYPE) + .and_then(|header| header.to_str().ok()) + .is_some_and(|header| header.starts_with(JSON_MIME_TYPE)) + { + return Ok(Response::builder() + .status(http::StatusCode::UNSUPPORTED_MEDIA_TYPE) + .body( + Full::new(Bytes::from( + "Unsupported Media Type: Content-Type must be application/json", + )) + .boxed(), + ) + .expect("valid response")); + } + + // json deserialize request body + let (part, body) = request.into_parts(); + let mut message = match expect_json(body, self.config.max_request_body_bytes).await { + Ok(message) => message, + Err(response) => return Ok(response), + }; + + let use_session = + self.config.legacy_session_mode && is_legacy_request(Some(&message), &part.headers)?; + + if use_session { + // do we have a session id? + let session_id = part + .headers + .get(HEADER_SESSION_ID) + .and_then(|v| v.to_str().ok()); + if let Some(session_id) = session_id { + let session_id = session_id.to_owned().into(); + let has_session = self + .session_manager + .has_session(&session_id) + .await + .map_err(internal_error_response("check session"))?; + if !has_session { + // Attempt transparent cross-instance restore from external store. + let restored = self + .try_restore_from_store(&session_id, &part) + .await + .map_err(internal_error_response("restore session"))?; + if !restored { + // MCP spec: server MUST respond with 404 Not Found for terminated/unknown sessions + return Ok(Response::builder() + .status(http::StatusCode::NOT_FOUND) + .body(Full::new(Bytes::from("Not Found: Session not found")).boxed()) + .expect("valid response")); + } + } + + // Validate MCP-Protocol-Version header (per 2025-06-18 spec) + let has_per_request_version = message_has_per_request_protocol_version(&message); + validate_protocol_version_header(&part.headers, has_per_request_version)?; + validate_request_protocol_version_meta(&part.headers, &message)?; + // Validate SEP-2243 standard headers against the body + validate_standard_headers(&part.headers, &message, |name| self.tool_schema(name))?; + + // inject request part to extensions + match &mut message { + ClientJsonRpcMessage::Request(req) => { + req.request.extensions_mut().insert(part); + } + ClientJsonRpcMessage::Notification(not) => { + not.notification.extensions_mut().insert(part); + } + _ => { + // skip + } + } + + match message { + ClientJsonRpcMessage::Request(_) => { + // Priming for request-wise streams is handled by the + // session layer (SessionManager::create_stream) which + // has access to the http_request_id for correct event IDs. + let stream = self + .session_manager + .create_stream(&session_id, message) + .await + .map_err(internal_error_response("get session"))?; + Ok(sse_stream_response( + stream, + self.config.sse_keep_alive, + self.config.cancellation_token.child_token(), + )) + } + ClientJsonRpcMessage::Notification(_) + | ClientJsonRpcMessage::Response(_) + | ClientJsonRpcMessage::Error(_) => { + // handle notification + self.session_manager + .accept_message(&session_id, message) + .await + .map_err(internal_error_response("accept message"))?; + Ok(accepted_response()) + } + } + } else { + if matches!( + &message, + ClientJsonRpcMessage::Request(request) + if matches!(&request.request, ClientRequest::DiscoverRequest(_)) + ) { + validate_protocol_version_header( + &part.headers, + message_has_per_request_protocol_version(&message), + )?; + validate_standard_headers(&part.headers, &message, |name| { + self.tool_schema(name) + })?; + validate_request_protocol_version_meta(&part.headers, &message)?; + let ClientJsonRpcMessage::Request(request) = message else { + unreachable!("guarded as a request above"); + }; + let service = self + .get_service() + .map_err(internal_error_response("get service"))?; + return self + .serve_negotiated_request_directly(service, request, part) + .await; + } + // SEP-2243: run the standard-header validator on the initialize + // handshake before a session is created for it — a supplied + // Mcp-Method header contradicting the body must be rejected + // here, not answered with HTTP 200 and a fresh session. + validate_standard_headers(&part.headers, &message, |name| self.tool_schema(name))?; + // Capture init params for external store persistence before + // extensions are injected (which would require Clone). + let stored_init_params = match &mut message { + ClientJsonRpcMessage::Request(req) => { + let ClientRequest::InitializeRequest(init_req) = &req.request else { + return Err(unexpected_message_response("initialize request").into()); + }; + // Reject mismatched MCP-Protocol-Version header before binding the session to anything. + validate_header_matches_init_body( + &part.headers, + init_req.params.protocol_version.as_str(), + Some(req.id.clone()), + )?; + let stored_init_params = self + .config + .session_store + .as_ref() + .map(|_| init_req.params.clone()); + // inject request part to extensions + req.request.extensions_mut().insert(part); + stored_init_params + } + _ => { + return Err(unexpected_message_response("initialize request").into()); + } + }; + let service = self + .get_service() + .map_err(internal_error_response("get service"))?; + let (session_id, transport) = self + .session_manager + .create_session() + .await + .map_err(internal_error_response("create session"))?; + // spawn a task to serve the session + Self::spawn_session_worker( + self.session_manager.clone(), + session_id.clone(), + service, + transport, + None, + ); + // get initialize response + let response = self + .session_manager + .initialize_session(&session_id, message) + .await + .map_err(internal_error_response("create stream"))?; + // Persist session state to external store after a successful handshake. + if let (Some(store), Some(params)) = + (&self.config.session_store, stored_init_params) + { + let state = SessionState { + initialize_params: params, + }; + let _ = store + .store(session_id.as_ref(), &state) + .await + .inspect_err(|e| { + tracing::warn!( + "Failed to persist session {} to store: {e}", + session_id + ); + }); + } + let stream = + futures::stream::once(async move { ServerSseMessage::from_message(response) }); + // Prepend priming event if sse_retry configured + let stream = if let Some(retry) = self.config.sse_retry { + let priming = ServerSseMessage::priming("0", retry); + futures::stream::once(async move { priming }) + .chain(stream) + .left_stream() + } else { + stream.right_stream() + }; + let mut response = sse_stream_response( + stream, + self.config.sse_keep_alive, + self.config.cancellation_token.child_token(), + ); + + response.headers_mut().insert( + HEADER_SESSION_ID, + session_id + .parse() + .map_err(internal_error_response("create session id header"))?, + ); + Ok(response) + } + } else { + // Stateless mode: + // - on initialize: the header (if present) must match `params.protocolVersion` + // - on every other request: the header must name a known version. + // + // The opt-in seam applies only here so legacy session routing and + // its error precedence remain unchanged. + validate_required_protocol_header(&self.config, &part.headers, &message)?; + let has_per_request_version = message_has_per_request_protocol_version(&message); + match &message { + ClientJsonRpcMessage::Request(req) => { + if let ClientRequest::InitializeRequest(init_req) = &req.request { + validate_header_matches_init_body( + &part.headers, + init_req.params.protocol_version.as_str(), + Some(req.id.clone()), + )?; + } else { + validate_protocol_version_header(&part.headers, has_per_request_version)?; + } + } + _ => { + validate_protocol_version_header(&part.headers, has_per_request_version)?; + } + } + // Validate SEP-2243 standard headers against the body + validate_standard_headers(&part.headers, &message, |name| self.tool_schema(name))?; + validate_request_protocol_version_meta(&part.headers, &message)?; + validate_required_protocol_meta(&self.config, &message)?; + let service = self + .get_service() + .map_err(internal_error_response("get service"))?; + match message { + ClientJsonRpcMessage::Request(mut request) => { + let negotiates_per_request = has_per_request_version + || matches!(&request.request, ClientRequest::DiscoverRequest(_)); + if negotiates_per_request { + return self + .serve_negotiated_request_directly(service, request, part) + .await; + } + // Build a peer_info so context.protocol_version() works inside handlers. + // serve_directly skips the handshake and receives None by default, making + // protocol_version() always return None in stateless mode. We reconstruct it: + // - initialize requests: version comes from the request body params + // - all other requests: version comes from the MCP-Protocol-Version header + // (already validated above; absent header defaults to 2025-03-26) + let peer_info = Self::peer_info_for_stateless_request(&request, &part.headers); + request.request.extensions_mut().insert(part); + let (transport, mut receiver) = + OneshotTransport::::new(ClientJsonRpcMessage::Request(request)); + // Give this stateless request its own cancellation token so an + // unpersisted response can cancel the in-flight handler on + // disconnect (#857). + let request_ct = CancellationToken::new(); + let service = serve_directly_with_ct( + NegotiatingStatelessHttpService(service), + transport, + peer_info, + request_ct.clone(), + ); + tokio::spawn(async move { + // on service created + let _ = service.waiting().await; + }); + if self.config.json_response { + // Prefer JSON for a terminal first message. If the handler + // emits an intermediate notification or request, preserve + // the complete message sequence by falling back to SSE. + let cancel = self.config.cancellation_token.child_token(); + // Cancel the handler if the client disconnects while it is + // still producing its first message (this future is dropped + // before `receiver.recv()` completes). Disarmed once the + // handler emits anything, so a normal response is never + // cancelled. + let mut disconnect_guard = Some(request_ct.clone().drop_guard()); + let Some(message) = (tokio::select! { + res = receiver.recv() => { + if let Some(guard) = disconnect_guard.take() { + guard.disarm(); + } + res + } + _ = cancel.cancelled() => None, + }) else { + return Err(internal_error_response("empty response")( + std::io::Error::new( + std::io::ErrorKind::UnexpectedEof, + "no response message received from handler", + ), + ) + .into()); + }; + tracing::trace!(?message); + if matches!( + message, + ServerJsonRpcMessage::Response(_) | ServerJsonRpcMessage::Error(_) + ) { + let body = serde_json::to_vec(&message).map_err(|e| { + internal_error_response("serialize json response")(e) + })?; + Ok(Response::builder() + .status(http::StatusCode::OK) + .header(http::header::CONTENT_TYPE, JSON_MIME_TYPE) + .body(Full::new(Bytes::from(body)).boxed()) + .expect("valid response")) + } else { + Ok(self.stateless_sse_response(Some(message), receiver, request_ct)) + } + } else { + Ok(self.stateless_sse_response(None, receiver, request_ct)) + } + } + ClientJsonRpcMessage::Notification(_notification) => { + // ignore + Ok(accepted_response()) + } + ClientJsonRpcMessage::Response(_json_rpc_response) => Ok(accepted_response()), + ClientJsonRpcMessage::Error(_json_rpc_error) => Ok(accepted_response()), + } + } + } + + async fn handle_delete(&self, request: Request) -> HttpResult + where + B: Body + Send + 'static, + B::Error: Display, + { + if !is_legacy_request(None, request.headers())? { + return Ok(method_not_allowed_response()); + } + // check session id + let session_id = request + .headers() + .get(HEADER_SESSION_ID) + .and_then(|v| v.to_str().ok()) + .map(|s| s.to_owned().into()); + let Some(session_id) = session_id else { + // MCP spec: servers that require a session ID SHOULD respond with 400 Bad Request + return Ok(Response::builder() + .status(http::StatusCode::BAD_REQUEST) + .body(Full::new(Bytes::from("Bad Request: Session ID is required")).boxed()) + .expect("valid response")); + }; + // Validate MCP-Protocol-Version header (per 2025-06-18 spec) + validate_protocol_version_header(request.headers(), false)?; + // close session + self.session_manager + .close_session(&session_id) + .await + .map_err(internal_error_response("close session"))?; + // Remove from external store: a DELETE means the client intentionally + // ends the session, so the store entry is no longer needed. + if let Some(store) = &self.config.session_store { + let _ = store.delete(session_id.as_ref()).await.inspect_err(|e| { + tracing::warn!("Failed to delete session {} from store: {e}", session_id); + }); + } + Ok(accepted_response()) + } + + /// Build a `InitializeRequestParams` (peer_info) for a stateless request so that + /// `context.protocol_version()` returns the correct value inside handlers. + /// + /// `serve_directly` skips the MCP handshake and accepts `peer_info = None`, + /// which means `context.protocol_version()` is always `None` in stateless mode. + /// We reconstruct the protocol version from the available signal per request type: + /// - initialize: version is in the request body params (authoritative) + /// - all other requests: version is in the MCP-Protocol-Version header + /// (validated before this point; absent header defaults to 2025-03-26) + fn peer_info_for_stateless_request( + request: &crate::model::JsonRpcRequest, + headers: &HeaderMap, + ) -> Option { + let version = if let ClientRequest::InitializeRequest(ref init) = request.request { + init.params.protocol_version.clone() + } else { + headers + .get(HEADER_MCP_PROTOCOL_VERSION) + .and_then(|v| v.to_str().ok()) + .and_then(|s| serde_json::from_value(serde_json::Value::String(s.to_owned())).ok()) + .unwrap_or(ProtocolVersion::V_2025_03_26) + }; + Some(InitializeRequestParams { + meta: None, + protocol_version: version, + capabilities: ClientCapabilities::default(), + client_info: Implementation::default(), + }) + } +} + +pin_project! { + /// Cancels an unpersisted stateless request when its response is dropped. + /// + /// Persisted requests keep running so another connection can resume them. + /// Without an event store, dropping the stream fires the request's + /// cancellation token. Natural completion disarms the guard. + struct CancelOnDisconnect { + #[pin] + inner: S, + ct: Option, + } + impl PinnedDrop for CancelOnDisconnect { + fn drop(this: Pin<&mut Self>) { + let this = this.project(); + if let Some(ct) = this.ct.take() { + ct.cancel(); + } + } + } +} + +impl CancelOnDisconnect { + fn new(inner: S, ct: CancellationToken) -> Self { + Self { + inner, + ct: Some(ct), + } + } +} + +impl Stream for CancelOnDisconnect { + type Item = S::Item; + + fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + let this = self.project(); + let polled = this.inner.poll_next(cx); + if let Poll::Ready(None) = &polled { + // Ended naturally: the request completed, so don't cancel on drop. + *this.ct = None; + } + polled + } +} diff --git a/vendor/rmcp/src/transport/worker.rs b/vendor/rmcp/src/transport/worker.rs new file mode 100644 index 00000000..e32da7d7 --- /dev/null +++ b/vendor/rmcp/src/transport/worker.rs @@ -0,0 +1,541 @@ +use std::{ + borrow::Cow, + collections::HashMap, + sync::{ + Arc, Mutex, PoisonError, Weak, + atomic::{AtomicU64, Ordering}, + }, + time::Duration, +}; + +use tokio_util::sync::CancellationToken; +use tracing::{Instrument, Level}; + +use super::{IntoTransport, Transport}; +use crate::{ + model::{CancelledNotification, JsonRpcMessage, RequestId}, + service::{RxJsonRpcMessage, ServiceRole, TxJsonRpcMessage}, +}; + +#[derive(Debug, thiserror::Error)] +#[non_exhaustive] +pub enum WorkerQuitReason { + #[error("Join error {0}")] + Join(#[from] tokio::task::JoinError), + #[error("Transport fatal {error}, when {context}")] + Fatal { + error: E, + context: Cow<'static, str>, + }, + #[error("Transport cancelled")] + Cancelled, + #[error("Transport closed")] + TransportClosed, + #[error("Handler terminated")] + HandlerTerminated, + #[error("Worker idle timeout after {}ms", _0.as_millis())] + IdleTimeout(Duration), +} + +impl WorkerQuitReason { + pub fn fatal(error: E, context: impl Into>) -> Self { + Self::Fatal { + error, + context: context.into(), + } + } + pub fn fatal_context(context: impl Into>) -> impl FnOnce(E) -> Self { + |e| Self::Fatal { + error: e, + context: context.into(), + } + } +} + +pub trait Worker: Sized + Send + 'static { + type Error: std::error::Error + Send + Sync + 'static; + type Role: ServiceRole; + fn err_closed() -> Self::Error; + fn err_join(e: tokio::task::JoinError) -> Self::Error; + fn run( + self, + context: WorkerContext, + ) -> impl Future>> + Send; + fn config(&self) -> WorkerConfig { + WorkerConfig::default() + } + /// Return true to send this message through the separate control queue. + /// + /// Workers that opt in must read [`WorkerContext::control_from_handler_rx`] + /// and preserve any required ordering with ordinary messages. + fn is_control_message(_message: &TxJsonRpcMessage) -> bool { + false + } + /// Return true to register outgoing requests for cancellation before they enter a queue. + /// + /// Workers that opt in must honor [`WorkerSendRequest::cancellation_token`]. + fn supports_request_cancellation() -> bool { + false + } +} + +type RequestCancellations = Arc>>>; + +/// Keeps a request's cancellation token registered for a chosen lifetime. +pub(crate) struct RequestCancellationRegistration { + id: RequestId, + lifetime: CancellationToken, + cancellation: CancellationToken, + pending: RequestCancellations, +} + +impl RequestCancellationRegistration { + fn new(id: RequestId, token: CancellationToken, pending: RequestCancellations) -> Arc { + let registration = Arc::new(Self { + id: id.clone(), + cancellation: token.child_token(), + lifetime: token, + pending, + }); + registration + .pending + .lock() + .unwrap_or_else(PoisonError::into_inner) + .insert(id, Arc::downgrade(®istration)); + registration + } + + /// Return the token kept alive by this registration. + pub(crate) fn token(&self) -> CancellationToken { + self.cancellation.clone() + } + + /// Return the token cancelled when the request lifetime ends. + pub(crate) fn lifetime_token(&self) -> CancellationToken { + self.lifetime.clone() + } +} + +impl Drop for RequestCancellationRegistration { + fn drop(&mut self) { + self.lifetime.cancel(); + let mut pending = self.pending.lock().unwrap_or_else(PoisonError::into_inner); + if pending + .get(&self.id) + .is_some_and(|current| std::ptr::eq(current.as_ptr(), self)) + { + pending.remove(&self.id); + } + } +} + +#[non_exhaustive] +pub struct WorkerSendRequest { + pub message: TxJsonRpcMessage, + pub responder: tokio::sync::oneshot::Sender>, + cancellation: Option>, + control_generation: u64, +} + +impl WorkerSendRequest { + /// Return the token registered before this request entered the send queue. + /// + /// This is present only for requests sent to a worker that enables + /// [`Worker::supports_request_cancellation`]. It is not sent over the wire. + /// Keep this request alive while its work is active. Cloning the token does + /// not keep its cancellation registration alive. + pub fn cancellation_token(&self) -> Option { + self.cancellation + .as_deref() + .map(RequestCancellationRegistration::token) + } + + /// Keep the same cancellation registration alive after the send completes. + #[cfg(feature = "transport-streamable-http-client")] + pub(crate) fn cancellation_registration(&self) -> Option> { + self.cancellation.clone() + } + + /// Return the local generation captured when [`Transport::send`] created its future. + /// + /// This happens before polling or queue admission. The value is not sent over + /// the wire; the worker decides whether a message from an older generation is valid. + /// It identifies the outbound send, not the session that started an inbound handler. + pub fn control_generation(&self) -> u64 { + self.control_generation + } +} + +pub struct WorkerTransport { + rx: tokio::sync::mpsc::Receiver>, + send_service: tokio::sync::mpsc::Sender>, + control_send_service: tokio::sync::mpsc::Sender>, + request_cancellations: RequestCancellations, + control_generation: Arc, + join_handle: Option>>>, + _drop_guard: tokio_util::sync::DropGuard, + ct: CancellationToken, +} + +#[non_exhaustive] +pub struct WorkerConfig { + pub name: Option, + pub channel_buffer_capacity: usize, +} + +impl Default for WorkerConfig { + fn default() -> Self { + Self { + name: None, + channel_buffer_capacity: 16, + } + } +} +#[non_exhaustive] +pub enum WorkerAdapter {} + +impl IntoTransport for W { + fn into_transport(self) -> impl Transport + 'static { + WorkerTransport::spawn(self) + } +} + +impl WorkerTransport { + pub fn cancel_token(&self) -> CancellationToken { + self.ct.clone() + } + pub fn spawn(worker: W) -> Self { + Self::spawn_with_ct(worker, CancellationToken::new()) + } + pub fn spawn_with_ct(worker: W, transport_task_ct: CancellationToken) -> Self { + let config = worker.config(); + let worker_name = config.name; + let (to_transport_tx, from_handler_rx) = + tokio::sync::mpsc::channel::>(config.channel_buffer_capacity); + let (control_to_transport_tx, control_from_handler_rx) = + tokio::sync::mpsc::channel::>(config.channel_buffer_capacity); + let (to_handler_tx, from_transport_rx) = + tokio::sync::mpsc::channel::>(config.channel_buffer_capacity); + let request_cancellations = RequestCancellations::default(); + let control_generation = Arc::new(AtomicU64::new(0)); + let context = WorkerContext { + to_handler_tx, + from_handler_rx, + control_from_handler_rx, + control_generation: control_generation.clone(), + cancellation_token: transport_task_ct.clone(), + }; + + let join_handle = tokio::spawn(async move { + worker + .run(context) + .instrument(tracing::span!( + Level::TRACE, + "transport_worker", + name = worker_name, + )) + .await + .inspect_err(|e| match e { + WorkerQuitReason::Cancelled + | WorkerQuitReason::TransportClosed + | WorkerQuitReason::HandlerTerminated + | WorkerQuitReason::IdleTimeout(_) => { + tracing::debug!("worker quit with reason: {:?}", e); + } + WorkerQuitReason::Join(e) => { + tracing::error!("worker quit with join error: {:?}", e); + } + WorkerQuitReason::Fatal { error, context } => { + tracing::error!("worker quit with fatal: {error}, when {context}"); + } + }) + .inspect(|_| { + tracing::debug!("worker quit"); + }) + }); + Self { + rx: from_transport_rx, + send_service: to_transport_tx, + control_send_service: control_to_transport_tx, + request_cancellations, + control_generation, + join_handle: Some(join_handle), + ct: transport_task_ct.clone(), + _drop_guard: transport_task_ct.drop_guard(), + } + } + + fn cancel_request_from_notification( + &self, + notification: &::Not, + ) -> Option> { + let cancelled: CancelledNotification = notification.clone().try_into().ok()?; + let id = cancelled.params.request_id.as_ref()?; + let target = { + let pending = self + .request_cancellations + .lock() + .unwrap_or_else(PoisonError::into_inner); + pending.get(id).and_then(Weak::upgrade) + }?; + // Signal cancellation even if the control queue is full. + target.token().cancel(); + Some(target) + } +} + +#[non_exhaustive] +pub struct SendRequest { + pub message: TxJsonRpcMessage, + pub responder: tokio::sync::oneshot::Sender>, +} + +#[non_exhaustive] +pub struct WorkerContext { + pub to_handler_tx: tokio::sync::mpsc::Sender>, + pub from_handler_rx: tokio::sync::mpsc::Receiver>, + /// Messages selected by [`Worker::is_control_message`]. + pub control_from_handler_rx: tokio::sync::mpsc::Receiver>, + pub cancellation_token: CancellationToken, + control_generation: Arc, +} + +impl WorkerContext { + /// Return the local generation that newly created sends will capture. + /// + /// Workers may use this value to check messages from an earlier connection + /// or session. The generic transport does not check it automatically. + pub fn control_generation(&self) -> u64 { + self.control_generation.load(Ordering::SeqCst) + } + + /// Advance the local generation, wrapping at [`u64::MAX`], and return its new value. + /// + /// Only subsequent calls to [`Transport::send`] capture the new value. + /// Advancing does not drain queues, cancel work, or reject older messages; + /// the worker is responsible for those actions. + pub fn advance_control_generation(&self) -> u64 { + self.control_generation + .fetch_add(1, Ordering::SeqCst) + .wrapping_add(1) + } + + pub async fn send_to_handler( + &mut self, + item: RxJsonRpcMessage, + ) -> Result<(), WorkerQuitReason> { + self.to_handler_tx + .send(item) + .await + .map_err(|_| WorkerQuitReason::HandlerTerminated) + } + + pub async fn recv_from_handler( + &mut self, + ) -> Result, WorkerQuitReason> { + self.from_handler_rx + .recv() + .await + .ok_or(WorkerQuitReason::HandlerTerminated) + } +} + +impl Transport for WorkerTransport { + type Error = W::Error; + + fn send( + &mut self, + item: TxJsonRpcMessage, + ) -> impl Future> + Send + 'static { + let control_generation = self.control_generation.load(Ordering::SeqCst); + let mut cancellation_target = None; + let registration = if W::supports_request_cancellation() { + match &item { + JsonRpcMessage::Request(request) => Some(RequestCancellationRegistration::new( + request.id.clone(), + self.ct.child_token(), + self.request_cancellations.clone(), + )), + JsonRpcMessage::Notification(notification) => { + cancellation_target = + self.cancel_request_from_notification(¬ification.notification); + None + } + _ => None, + } + } else { + None + }; + let tx = if W::is_control_message(&item) { + self.control_send_service.clone() + } else { + self.send_service.clone() + }; + let cancellation_guard = registration + .as_ref() + .map(|registration| registration.lifetime_token().drop_guard()); + let target_guard = cancellation_target + .as_ref() + .map(|target| target.lifetime_token().drop_guard()); + let (responder, receiver) = tokio::sync::oneshot::channel(); + let request = WorkerSendRequest { + message: item, + responder, + cancellation: registration, + control_generation, + }; + async move { + // Keep the stream alive until its cancellation is handled or abandoned. + let _cancellation_target = cancellation_target; + let _target_guard = target_guard; + tx.send(request).await.map_err(|_| W::err_closed())?; + receiver.await.map_err(|_| W::err_closed())??; + if let Some(guard) = cancellation_guard { + let _ = guard.disarm(); + } + Ok(()) + } + } + async fn receive(&mut self) -> Option> { + self.rx.recv().await + } + async fn close(&mut self) -> Result<(), Self::Error> { + if let Some(handle) = self.join_handle.take() { + self.ct.cancel(); + let _quit_reason = handle.await.map_err(W::err_join)?; + Ok(()) + } else { + Ok(()) + } + } +} + +#[cfg(all(test, feature = "client"))] +mod tests { + use std::io; + + use super::*; + use crate::{model::ClientJsonRpcMessage, service::RoleClient}; + + struct TestWorker(tokio::sync::oneshot::Sender>); + + impl Worker for TestWorker { + type Error = io::Error; + type Role = RoleClient; + + fn err_closed() -> Self::Error { + io::Error::other("worker closed") + } + + fn err_join(error: tokio::task::JoinError) -> Self::Error { + io::Error::other(error) + } + + async fn run( + self, + context: WorkerContext, + ) -> Result<(), WorkerQuitReason> { + let cancellation = context.cancellation_token.clone(); + self.0 + .send(context) + .map_err(|_| WorkerQuitReason::HandlerTerminated)?; + cancellation.cancelled().await; + Ok(()) + } + + fn is_control_message(message: &ClientJsonRpcMessage) -> bool { + matches!(message, JsonRpcMessage::Notification(_)) + } + + fn supports_request_cancellation() -> bool { + true + } + } + + fn cancellation_message(id: RequestId) -> ClientJsonRpcMessage { + serde_json::from_value(serde_json::json!({ + "jsonrpc": "2.0", + "method": "notifications/cancelled", + "params": { "requestId": id }, + })) + .unwrap() + } + + #[tokio::test] + async fn cancellation_matches_request_id_exactly() { + let (context_tx, context_rx) = tokio::sync::oneshot::channel(); + let mut transport = WorkerTransport::spawn(TestWorker(context_tx)); + let _context = context_rx.await.unwrap(); + let registration = RequestCancellationRegistration::new( + RequestId::Number(7), + CancellationToken::new(), + transport.request_cancellations.clone(), + ); + + drop(transport.send(cancellation_message(RequestId::String("7".into())))); + assert!(!registration.token().is_cancelled()); + + drop(transport.send(cancellation_message(RequestId::Number(7)))); + assert!(registration.token().is_cancelled()); + transport.close().await.unwrap(); + } + + #[tokio::test] + async fn abandoned_cancellation_send_ends_request_lifetime() { + let (context_tx, context_rx) = tokio::sync::oneshot::channel(); + let mut transport = WorkerTransport::spawn(TestWorker(context_tx)); + let mut context = context_rx.await.unwrap(); + + for admitted in [false, true] { + let id = RequestId::Number(7); + let registration = RequestCancellationRegistration::new( + id.clone(), + CancellationToken::new(), + transport.request_cancellations.clone(), + ); + let lifetime = registration.lifetime_token(); + let weak = Arc::downgrade(®istration); + let mut send = Box::pin(transport.send(cancellation_message(id))); + assert!(registration.token().is_cancelled()); + assert!(!lifetime.is_cancelled()); + + let queued = if admitted { + assert!(futures::poll!(send.as_mut()).is_pending()); + Some(context.control_from_handler_rx.recv().await.unwrap()) + } else { + None + }; + drop(send); + + // An open stream can still own the registration after cancellation is abandoned. + assert!(lifetime.is_cancelled()); + assert!(weak.upgrade().is_some()); + drop(registration); + assert!(weak.upgrade().is_none()); + assert!(queued.is_none_or(|request| request.responder.is_closed())); + assert!(transport.request_cancellations.lock().unwrap().is_empty()); + } + transport.close().await.unwrap(); + } + + #[test] + fn dropping_an_old_registration_preserves_a_reused_id() { + let pending = RequestCancellations::default(); + let id = RequestId::Number(7); + let old = RequestCancellationRegistration::new( + id.clone(), + CancellationToken::new(), + pending.clone(), + ); + let current = RequestCancellationRegistration::new( + id.clone(), + CancellationToken::new(), + pending.clone(), + ); + drop(old); + let registered = pending.lock().unwrap().get(&id).cloned().unwrap(); + assert!(Weak::ptr_eq(®istered, &Arc::downgrade(¤t))); + drop(current); + assert!(pending.lock().unwrap().is_empty()); + } +} diff --git a/vendor/rmcp/src/transport/ws.rs b/vendor/rmcp/src/transport/ws.rs new file mode 100644 index 00000000..5ec9cbac --- /dev/null +++ b/vendor/rmcp/src/transport/ws.rs @@ -0,0 +1 @@ +// Maybe we don't really need a ws implementation? diff --git a/vendor/rmcp/tests/common/calculator.rs b/vendor/rmcp/tests/common/calculator.rs new file mode 100644 index 00000000..961d9775 --- /dev/null +++ b/vendor/rmcp/tests/common/calculator.rs @@ -0,0 +1,59 @@ +#![allow(dead_code)] +use rmcp::{ + ServerHandler, + handler::server::{router::tool::ToolRouter, wrapper::Parameters}, + model::{ServerCapabilities, ServerConfig}, + schemars, tool, tool_router, +}; +#[derive(Debug, serde::Deserialize, schemars::JsonSchema)] +pub struct SumRequest { + #[schemars(description = "the left hand side number")] + pub a: i32, + pub b: i32, +} + +#[derive(Debug, serde::Deserialize, schemars::JsonSchema)] +pub struct SubRequest { + #[schemars(description = "the left hand side number")] + pub a: i32, + #[schemars(description = "the right hand side number")] + pub b: i32, +} +#[derive(Debug, Clone)] +pub struct Calculator { + tool_router: ToolRouter, +} + +impl Calculator { + pub fn new() -> Self { + Self { + tool_router: Self::tool_router(), + } + } +} + +impl Default for Calculator { + fn default() -> Self { + Self::new() + } +} + +#[tool_router] +impl Calculator { + #[tool(description = "Calculate the sum of two numbers")] + fn sum(&self, Parameters(SumRequest { a, b }): Parameters) -> String { + (a + b).to_string() + } + + #[tool(description = "Calculate the sub of two numbers")] + fn sub(&self, Parameters(SubRequest { a, b }): Parameters) -> String { + (a - b).to_string() + } +} + +impl ServerHandler for Calculator { + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::builder().enable_tools().build()) + .with_instructions("A simple calculator") + } +} diff --git a/vendor/rmcp/tests/common/handlers.rs b/vendor/rmcp/tests/common/handlers.rs new file mode 100644 index 00000000..7e686213 --- /dev/null +++ b/vendor/rmcp/tests/common/handlers.rs @@ -0,0 +1,190 @@ +// Sampling/Roots/Logging are SEP-2577-deprecated; this test handler exercises them. +#![expect(deprecated)] +use std::{ + future::Future, + sync::{Arc, Mutex}, +}; + +#[cfg(feature = "client")] +use rmcp::service::NotificationContext; +#[cfg(feature = "client")] +use rmcp::{ClientHandler, RoleClient}; +use rmcp::{ + ErrorData as McpError, RoleServer, ServerHandler, + model::*, + service::{MaybeSendFuture, RequestContext}, +}; +#[cfg(feature = "client")] +use serde_json::json; +use tokio::sync::Notify; + +#[derive(Clone)] +#[allow(dead_code)] +pub struct TestClientHandler { + pub honor_this_server: bool, + pub honor_all_servers: bool, + pub receive_signal: Arc, + pub received_messages: Arc>>, +} + +impl TestClientHandler { + #[allow(dead_code)] + pub fn new(honor_this_server: bool, honor_all_servers: bool) -> Self { + Self { + honor_this_server, + honor_all_servers, + receive_signal: Arc::new(Notify::new()), + received_messages: Arc::new(Mutex::new(Vec::new())), + } + } + + #[allow(dead_code)] + pub fn with_notification( + honor_this_server: bool, + honor_all_servers: bool, + receive_signal: Arc, + received_messages: Arc>>, + ) -> Self { + Self { + honor_this_server, + honor_all_servers, + receive_signal, + received_messages, + } + } +} + +#[cfg(feature = "client")] +impl ClientHandler for TestClientHandler { + async fn create_message( + &self, + params: CreateMessageRequestParams, + _context: RequestContext, + ) -> Result { + // First validate that there's at least one User message + if !params.messages.iter().any(|msg| msg.role == Role::User) { + return Err(McpError::invalid_request( + "Message sequence must contain at least one user message", + Some(json!({"messages": params.messages})), + )); + } + + // Create response based on context inclusion + let response = match params.include_context { + Some(ContextInclusion::ThisServer) if self.honor_this_server => { + "Test response with context: test context" + } + Some(ContextInclusion::AllServers) if self.honor_all_servers => { + "Test response with context: test context" + } + _ => "Test response without context", + }; + + Ok(CreateMessageResult::new( + SamplingMessage::assistant_text(response.to_string()), + "test-model".to_string(), + ) + .with_stop_reason(CreateMessageResult::STOP_REASON_END_TURN)) + } + + fn on_logging_message( + &self, + params: LoggingMessageNotificationParam, + _context: NotificationContext, + ) -> impl Future + MaybeSendFuture + '_ { + let receive_signal = self.receive_signal.clone(); + let received_messages = self.received_messages.clone(); + + async move { + println!("Client: Received log message: {:?}", params); + let mut messages = received_messages.lock().unwrap(); + messages.push(params); + receive_signal.notify_one(); + } + } +} + +pub struct TestServer {} + +impl TestServer { + #[allow(dead_code)] + pub fn new() -> Self { + Self {} + } +} + +impl ServerHandler for TestServer { + #[allow(deprecated)] + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::builder().enable_logging().build()) + } + + #[allow(deprecated)] + fn set_level( + &self, + request: SetLevelRequestParams, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + let peer = context.peer; + async move { + let (data, logger) = match request.level { + LoggingLevel::Error => ( + serde_json::json!({ + "message": "Failed to process request", + "error_code": "E1001", + "error_details": "Connection timeout", + "timestamp": chrono::Utc::now().to_rfc3339(), + }), + Some("error_handler".to_string()), + ), + LoggingLevel::Debug => ( + serde_json::json!({ + "message": "Processing request", + "function": "handle_request", + "line": 42, + "context": { + "request_id": "req-123", + "user_id": "user-456" + }, + "timestamp": chrono::Utc::now().to_rfc3339(), + }), + Some("debug_logger".to_string()), + ), + LoggingLevel::Info => ( + serde_json::json!({ + "message": "System status update", + "status": "healthy", + "metrics": { + "requests_per_second": 150, + "average_latency_ms": 45, + "error_rate": 0.01 + }, + "timestamp": chrono::Utc::now().to_rfc3339(), + }), + Some("monitoring".to_string()), + ), + _ => ( + serde_json::json!({ + "message": format!("Message at level {:?}", request.level), + "timestamp": chrono::Utc::now().to_rfc3339(), + }), + None, + ), + }; + + if let Err(e) = peer + .notify_logging_message({ + let mut param = LoggingMessageNotificationParam::new(request.level, data); + if let Some(l) = logger { + param = param.with_logger(l); + } + param + }) + .await + { + panic!("Failed to send notification: {}", e); + } + Ok(()) + } + } +} diff --git a/vendor/rmcp/tests/common/mod.rs b/vendor/rmcp/tests/common/mod.rs new file mode 100644 index 00000000..49196065 --- /dev/null +++ b/vendor/rmcp/tests/common/mod.rs @@ -0,0 +1,2 @@ +pub mod calculator; +pub mod handlers; diff --git a/vendor/rmcp/tests/test_auth_error_classification.rs b/vendor/rmcp/tests/test_auth_error_classification.rs new file mode 100644 index 00000000..99b05081 --- /dev/null +++ b/vendor/rmcp/tests/test_auth_error_classification.rs @@ -0,0 +1,85 @@ +use std::{any::TypeId, error::Error}; + +use rmcp::{ + service::ClientInitializeError, + transport::{ + AuthError, DynamicTransportError, + streamable_http_client::{AuthRequiredError, InsufficientScopeError, StreamableHttpError}, + }, +}; +use thiserror::Error; + +type TestHttpError = StreamableHttpError; + +#[derive(Debug, Error)] +#[error("outer transport wrapper")] +struct OuterError(#[source] TestHttpError); + +fn initialization_error(error: impl Error + Send + Sync + 'static) -> ClientInitializeError { + ClientInitializeError::TransportError { + error: DynamicTransportError::from_parts( + "test transport", + TypeId::of::<()>(), + Box::new(error), + ), + context: "initialize".into(), + } +} + +#[test] +fn classifies_local_authorization_required() { + let error = TestHttpError::Auth(AuthError::AuthorizationRequired); + + assert!(initialization_error(error).is_authorization_required()); +} + +#[test] +fn classifies_http_authorization_challenge() { + let error = + TestHttpError::AuthRequired(AuthRequiredError::new("Bearer realm=\"mcp\"".to_owned())); + + assert!(initialization_error(error).is_authorization_required()); +} + +#[test] +fn classifies_authorization_required_through_multiple_sources() { + let error = OuterError(TestHttpError::Auth(AuthError::AuthorizationRequired)); + + assert!(initialization_error(error).is_authorization_required()); +} + +#[test] +fn does_not_classify_unrelated_transport_errors() { + let closed = TestHttpError::TransportChannelClosed; + let refresh = TestHttpError::Auth(AuthError::TokenRefreshFailed("timeout".to_owned())); + let scope = TestHttpError::InsufficientScope(InsufficientScopeError::new( + "Bearer error=\"insufficient_scope\"".to_owned(), + Some("admin".to_owned()), + )); + + assert!(!initialization_error(closed).is_authorization_required()); + assert!(!initialization_error(refresh).is_authorization_required()); + assert!(!initialization_error(scope).is_authorization_required()); +} + +#[test] +fn does_not_classify_non_transport_initialization_errors() { + assert!(!ClientInitializeError::Cancelled.is_authorization_required()); + assert!( + !ClientInitializeError::ConnectionClosed("server closed the connection".to_owned()) + .is_authorization_required() + ); +} + +#[test] +fn http_challenge_remains_available_as_an_error_source() { + let error = + TestHttpError::AuthRequired(AuthRequiredError::new("Bearer realm=\"mcp\"".to_owned())); + + let source = error.source().expect("auth challenge should be a source"); + let challenge = source + .downcast_ref::() + .expect("source should retain the challenge type"); + + assert_eq!(challenge.www_authenticate_header, "Bearer realm=\"mcp\""); +} diff --git a/vendor/rmcp/tests/test_cache_hints.rs b/vendor/rmcp/tests/test_cache_hints.rs new file mode 100644 index 00000000..ebf78ff6 --- /dev/null +++ b/vendor/rmcp/tests/test_cache_hints.rs @@ -0,0 +1,106 @@ +use rmcp::model::{ + CacheScope, ListToolsResult, ReadResourceResult, ResourceContents, ServerResult, +}; +use serde_json::json; + +#[test] +fn repro_empty_cache_scope_drops_every_tool_via_untagged_fallthrough() { + let payload = json!({ + "tools": [{ "name": "search", "inputSchema": { "type": "object" } }], + "cacheScope": "" + }); + + let direct = serde_json::from_value::(payload.clone()); + assert!( + direct.is_ok(), + "ListToolsResult itself must accept an empty cacheScope, got {direct:?}" + ); + assert_eq!(direct.unwrap().tools.len(), 1); + + let via_server_result: ServerResult = + serde_json::from_value(payload).expect("ServerResult must deserialize this payload"); + match via_server_result { + ServerResult::ListToolsResult(r) => assert_eq!(r.tools.len(), 1), + other => panic!( + "expected ListToolsResult, got {other:?} \ + (untagged fallthrough silently reinterpreted a valid tools/list result)" + ), + } +} + +#[test] +fn paginated_results_serialize_cache_hints_as_top_level_fields() { + let result = ListToolsResult::with_all_items(Vec::new()) + .with_ttl_ms(5_000) + .with_cache_scope(CacheScope::Private); + + let actual = serde_json::to_value(result).expect("serialize list tools result"); + + assert_eq!( + actual, + json!({ + "ttlMs": 5000, + "cacheScope": "private", + "tools": [], + "resultType": "complete" + }) + ); + assert!(actual.get("_meta").is_none()); +} + +#[test] +fn read_resource_results_serialize_cache_hints_as_top_level_fields() { + let result = + ReadResourceResult::new(vec![ResourceContents::text("hello", "file:///example.txt")]) + .with_ttl_ms(10_000) + .with_cache_scope(CacheScope::Public); + + let actual = serde_json::to_value(result).expect("serialize read resource result"); + + assert_eq!(actual["ttlMs"], 10000); + assert_eq!(actual["cacheScope"], "public"); + assert!(actual["contents"][0].get("_meta").is_none()); +} + +#[test] +fn cache_hints_are_omitted_when_absent() { + let result = ListToolsResult::with_all_items(Vec::new()); + let actual = serde_json::to_value(result).expect("serialize list tools result"); + + assert_eq!(actual, json!({ "tools": [], "resultType": "complete" })); +} + +#[test] +fn cache_hints_default_to_none_and_negative_ttl_is_normalized_to_zero() { + let absent: ListToolsResult = serde_json::from_value(json!({ + "tools": [] + })) + .expect("deserialize result without ttlMs"); + assert_eq!(absent.ttl_ms, None); + assert_eq!(absent.cache_scope, None); + + let negative: ReadResourceResult = serde_json::from_value(json!({ + "ttlMs": -42, + "cacheScope": "private", + "contents": [] + })) + .expect("deserialize result with negative ttlMs"); + assert_eq!(negative.ttl_ms, Some(0)); + assert_eq!(negative.cache_scope, Some(CacheScope::Private)); +} + +#[test] +fn cache_scope_round_trips() { + assert_eq!( + serde_json::to_value(CacheScope::Public).unwrap(), + json!("public") + ); + assert_eq!( + serde_json::to_value(CacheScope::Private).unwrap(), + json!("private") + ); + assert_eq!( + serde_json::from_value::(json!("private")).unwrap(), + CacheScope::Private + ); +} diff --git a/vendor/rmcp/tests/test_cancelled_response.rs b/vendor/rmcp/tests/test_cancelled_response.rs new file mode 100644 index 00000000..864932aa --- /dev/null +++ b/vendor/rmcp/tests/test_cancelled_response.rs @@ -0,0 +1,633 @@ +//! A receiver SHOULD NOT send a response for a request it has already been told +//! to cancel. This drives a real stdio server with raw JSON-RPC: the tool blocks +//! until the request is cancelled, so its result is only produced *after* the +//! cancellation — the service loop must drop it rather than write it to the wire. + +#[cfg(all(feature = "client", not(feature = "local")))] +use std::sync::Arc; +use std::{collections::BTreeSet, process::Stdio, time::Duration}; + +#[cfg(all(feature = "client", not(feature = "local")))] +use rmcp::{ + ClientHandler, RoleClient, + model::{ + CancelledNotification, CancelledNotificationParam, ClientJsonRpcMessage, ClientRequest, + ClientResult, ElicitRequest, ElicitRequestParams, ElicitResult, ElicitationAction, + ElicitationSchema, PingRequest, RequestId, ServerJsonRpcMessage, ServerNotification, + ServerRequest, ServerResult, + }, + service::{PeerRequestOptions, QuitReason, serve_directly}, + transport::{IntoTransport, Transport}, +}; +use rmcp::{ + ErrorData as McpError, RoleServer, ServerHandler, ServiceExt, + model::{ + CallToolRequestParams, CallToolResponse, CallToolResult, ContentBlock, ServerCapabilities, + ServerConfig, + }, + service::RequestContext, +}; +use serde_json::{Value, json}; +use tokio::{ + io::{AsyncBufReadExt, AsyncWrite, AsyncWriteExt, BufReader}, + process::{Child, Command}, +}; + +const HELPER_ENV: &str = "RMCP_CANCELLED_RESPONSE_HELPER"; +const READ_TIMEOUT: Duration = Duration::from_secs(10); +const STRING_REQUEST_ID: &str = "tool-request-2"; + +#[tokio::test(flavor = "multi_thread", worker_threads = 4)] +async fn cancelled_request_receives_no_response() -> anyhow::Result<()> { + let mut child = spawn_helper(); + let mut writer = child.stdin.take().expect("helper stdin"); + let stdout = child.stdout.take().expect("helper stdout"); + let mut reader = BufReader::new(stdout); + + send_json( + &mut writer, + &json!({ + "jsonrpc": "2.0", + "id": 1, + "method": "initialize", + "params": { + "protocolVersion": "2024-11-05", + "capabilities": {}, + "clientInfo": { "name": "raw-test-client", "version": "0.0.0" } + } + }), + ) + .await?; + collect_ids_until(&mut reader, "1", READ_TIMEOUT).await?; + send_json( + &mut writer, + &json!({ "jsonrpc": "2.0", "method": "notifications/initialized" }), + ) + .await?; + + // Start a request that blocks until cancelled, then cancel it. Its response is + // produced only after the cancellation arrives, so it must be suppressed. + send_json( + &mut writer, + &json!({ + "jsonrpc": "2.0", + "id": STRING_REQUEST_ID, + "method": "tools/call", + "params": { "name": "wait-for-cancel", "arguments": {} } + }), + ) + .await?; + send_json( + &mut writer, + &json!({ + "jsonrpc": "2.0", + "method": "notifications/cancelled", + "params": { "requestId": "unrelated-request" } + }), + ) + .await?; + send_json( + &mut writer, + &json!({ + "jsonrpc": "2.0", + "method": "notifications/cancelled", + "params": { "requestId": STRING_REQUEST_ID } + }), + ) + .await?; + // A ping proves the server is alive past the cancellation, so the absence of + // a cancelled response is genuine suppression rather than a dead connection. + send_json( + &mut writer, + &json!({ "jsonrpc": "2.0", "id": 3, "method": "ping" }), + ) + .await?; + + let seen = collect_ids_until(&mut reader, "3", READ_TIMEOUT).await?; + assert!(seen.contains("3")); + assert!(!seen.contains(STRING_REQUEST_ID)); + + send_json( + &mut writer, + &json!({ + "jsonrpc": "2.0", + "id": 4, + "method": "tools/call", + "params": { "name": "complete-unless-cancelled", "arguments": {} } + }), + ) + .await?; + send_json( + &mut writer, + &json!({ + "jsonrpc": "2.0", + "method": "notifications/cancelled", + "params": { "requestId": "4" } + }), + ) + .await?; + send_json( + &mut writer, + &json!({ "jsonrpc": "2.0", "id": 5, "method": "ping" }), + ) + .await?; + + let seen = collect_ids_until(&mut reader, "5", READ_TIMEOUT).await?; + assert!(seen.contains("4"), "string and numeric IDs must not alias"); + assert!(seen.contains("5")); + + drop(writer); + wait_for_child(&mut child).await; + Ok(()) +} + +struct WaitForCancelServer; + +impl ServerHandler for WaitForCancelServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::builder().enable_tools().build()) + } + + async fn call_tool( + &self, + request: CallToolRequestParams, + context: RequestContext, + ) -> Result { + if request.name == "complete-unless-cancelled" { + tokio::select! { + _ = context.ct.cancelled() => {} + _ = tokio::time::sleep(Duration::from_millis(100)) => {} + } + return Ok(CallToolResult::success(vec![ContentBlock::text("completed")]).into()); + } + context.ct.cancelled().await; + Ok(CallToolResult::success(vec![ContentBlock::text("late response")]).into()) + } +} + +#[cfg(all(feature = "client", not(feature = "local")))] +#[derive(Clone)] +struct WaitForReverseCancelClient { + events: tokio::sync::mpsc::UnboundedSender<&'static str>, + finish: Option>, + return_error: bool, +} + +#[cfg(all(feature = "client", not(feature = "local")))] +impl ClientHandler for WaitForReverseCancelClient { + async fn create_elicitation( + &self, + _request: ElicitRequestParams, + context: rmcp::service::RequestContext, + ) -> Result { + self.events.send("started").expect("test is listening"); + context.ct.cancelled().await; + self.events.send("cancelled").expect("test is listening"); + if let Some(finish) = &self.finish { + finish.notified().await; + } + if self.return_error { + return Err(McpError::internal_error("late handler error", None)); + } + Ok(ElicitResult::new(ElicitationAction::Decline)) + } +} + +#[cfg(all(feature = "client", not(feature = "local")))] +#[rstest::rstest] +#[case::initialize("initialize")] +#[case::direct_legacy("direct-legacy")] +#[case::direct_unknown("direct-unknown")] +#[tokio::test] +async fn peer_cancels_reverse_request_without_cancelling_outbound_request( + #[case] startup: &str, + #[values(false, true)] equal_ids: bool, +) -> anyhow::Result<()> { + tokio::time::timeout(READ_TIMEOUT, reverse_cancellation(startup, equal_ids)).await??; + Ok(()) +} + +#[cfg(all(feature = "client", not(feature = "local")))] +async fn reverse_cancellation(startup: &str, equal_ids: bool) -> anyhow::Result<()> { + use rmcp::model::ProtocolVersion; + let (client_transport, server_transport) = tokio::io::duplex(4096); + let (events_tx, mut events_rx) = tokio::sync::mpsc::unbounded_channel(); + let handler = WaitForReverseCancelClient { + events: events_tx, + finish: None, + return_error: false, + }; + let mut server = IntoTransport::::into_transport(server_transport); + let mut info = ServerConfig::default(); + info.protocol_version = ProtocolVersion::V_2025_11_25; + let client = if startup == "initialize" { + let (client, handshake) = tokio::join!(handler.serve(client_transport), async { + let Some(ClientJsonRpcMessage::Request(request)) = server.receive().await else { + panic!("expected initialize request"); + }; + assert!(matches!( + request.request, + ClientRequest::InitializeRequest(_) + )); + server + .send(ServerJsonRpcMessage::response( + ServerResult::InitializeResult(info.clone()), + request.id, + )) + .await?; + assert!(matches!( + server.receive().await, + Some(ClientJsonRpcMessage::Notification(_)) + )); + anyhow::Ok(()) + }); + handshake?; + client? + } else { + let peer_info = (startup == "direct-legacy").then(|| info.into()); + serve_directly::(handler, client_transport, peer_info) + }; + let mut outbound = client + .send_cancellable_request( + ClientRequest::PingRequest(PingRequest { + method: Default::default(), + extensions: Default::default(), + }), + PeerRequestOptions::no_options(), + ) + .await?; + let Some(ClientJsonRpcMessage::Request(outbound_request)) = server.receive().await else { + panic!("expected outbound ping request"); + }; + let id = if equal_ids { + outbound_request.id.clone() + } else { + RequestId::String("elicitation-1".into()) + }; + let mut request = reverse_elicitation("elicitation-1"); + if let ServerJsonRpcMessage::Request(request) = &mut request { + request.id = id.clone(); + } + server.send(request).await?; + assert_eq!(events_rx.recv().await, Some("started")); + let unknown = if equal_ids { + RequestId::String(id.to_string().into()) + } else { + outbound_request.id.clone() + }; + for cancel_id in [unknown, RequestId::String("unknown".into())] { + server.send(cancel_notification(cancel_id)).await?; + } + exchange_ping(&mut server, "before-cancel").await?; + assert!(matches!( + events_rx.try_recv(), + Err(tokio::sync::mpsc::error::TryRecvError::Empty) + )); + assert!(matches!( + outbound.rx.try_recv(), + Err(tokio::sync::oneshot::error::TryRecvError::Empty) + )); + + // A cancellation can arrive after its response was already delivered. + server + .send(cancel_notification(RequestId::String( + "before-cancel".into(), + ))) + .await?; + server.send(cancel_notification(id)).await?; + assert_eq!(events_rx.recv().await, Some("cancelled")); + exchange_ping(&mut server, "after-cancel").await?; + assert!(matches!( + outbound.rx.try_recv(), + Err(tokio::sync::oneshot::error::TryRecvError::Empty) + )); + server + .send(ServerJsonRpcMessage::response( + ServerResult::empty(()), + outbound_request.id, + )) + .await?; + assert!(matches!( + outbound.await_response().await?, + ServerResult::EmptyResult(_) + )); + + client.cancel().await?; + assert!( + server.receive().await.is_none(), + "no late response after handler drain" + ); + Ok(()) +} + +#[cfg(all(feature = "client", not(feature = "local")))] +fn cancel_notification(id: RequestId) -> ServerJsonRpcMessage { + ServerJsonRpcMessage::notification( + CancelledNotification::new(CancelledNotificationParam::new( + Some(id), + Some("request cancelled".to_owned()), + )) + .into(), + ) +} + +#[cfg(all(feature = "client", not(feature = "local")))] +async fn exchange_ping(server: &mut impl Transport, id: &str) -> anyhow::Result<()> { + server + .send(ServerJsonRpcMessage::request( + PingRequest { + method: Default::default(), + extensions: Default::default(), + } + .into(), + RequestId::String(id.into()), + )) + .await?; + let Some(ClientJsonRpcMessage::Response(response)) = server.receive().await else { + panic!("expected ping response"); + }; + assert_eq!(response.id, RequestId::String(id.into())); + assert!(matches!(response.result, ClientResult::EmptyResult(_))); + Ok(()) +} + +#[cfg(all(feature = "client", not(feature = "local")))] +struct ChannelClientTransport { + incoming: tokio::sync::mpsc::UnboundedReceiver, + outgoing: tokio::sync::mpsc::UnboundedSender, + eof_observed: Arc, +} + +#[cfg(all(feature = "client", not(feature = "local")))] +impl Transport for ChannelClientTransport { + type Error = std::io::Error; + + fn send( + &mut self, + item: ClientJsonRpcMessage, + ) -> impl Future> + Send + 'static { + let outgoing = self.outgoing.clone(); + async move { + outgoing.send(item).map_err(|_| { + std::io::Error::new(std::io::ErrorKind::BrokenPipe, "test receiver closed") + }) + } + } + + async fn receive(&mut self) -> Option { + let message = self.incoming.recv().await; + if message.is_none() { + self.eof_observed.notify_one(); + } + message + } + + async fn close(&mut self) -> Result<(), Self::Error> { + Ok(()) + } +} + +#[cfg(all(feature = "client", not(feature = "local")))] +fn reverse_elicitation(id: &str) -> ServerJsonRpcMessage { + ServerJsonRpcMessage::request( + ServerRequest::ElicitRequest(ElicitRequest::new( + ElicitRequestParams::FormElicitationParams { + meta: None, + message: "Continue the operation?".to_owned(), + requested_schema: ElicitationSchema::builder() + .build() + .expect("empty elicitation schema is valid"), + }, + )), + RequestId::String(id.into()), + ) +} + +#[cfg(all(feature = "client", not(feature = "local")))] +#[tokio::test] +async fn graceful_close_drains_uncancelled_reverse_response() -> anyhow::Result<()> { + const REVERSE_REQUEST_ID: &str = "elicitation-close-drain"; + + let (to_client, incoming) = tokio::sync::mpsc::unbounded_channel(); + let (outgoing, mut from_client) = tokio::sync::mpsc::unbounded_channel(); + let eof_observed = Arc::new(tokio::sync::Notify::new()); + let finish = Arc::new(tokio::sync::Notify::new()); + let (events_tx, mut events_rx) = tokio::sync::mpsc::unbounded_channel(); + let mut client = serve_directly::( + WaitForReverseCancelClient { + events: events_tx, + finish: Some(finish.clone()), + return_error: false, + }, + ChannelClientTransport { + incoming, + outgoing, + eof_observed, + }, + None, + ); + + to_client.send(reverse_elicitation(REVERSE_REQUEST_ID))?; + assert_eq!(events_rx.recv().await, Some("started")); + + let (close_result, cancellation_event) = tokio::join!(client.close(), async { + let event = events_rx.recv().await; + finish.notify_one(); + event + }); + assert!(matches!(close_result?, QuitReason::Cancelled)); + assert_eq!(cancellation_event, Some("cancelled")); + + let Some(ClientJsonRpcMessage::Response(response)) = + tokio::time::timeout(READ_TIMEOUT, from_client.recv()).await? + else { + panic!("expected in-flight response during graceful close"); + }; + assert_eq!(response.id, RequestId::String(REVERSE_REQUEST_ID.into())); + Ok(()) +} + +#[cfg(all(feature = "client", not(feature = "local")))] +#[tokio::test] +async fn cancelled_reverse_request_stays_suppressed_during_eof_drain() -> anyhow::Result<()> { + for return_error in [false, true] { + tokio::time::timeout( + READ_TIMEOUT, + cancelled_reverse_response_at_eof(return_error), + ) + .await??; + } + Ok(()) +} + +#[cfg(all(feature = "client", not(feature = "local")))] +async fn cancelled_reverse_response_at_eof(return_error: bool) -> anyhow::Result<()> { + const REVERSE_REQUEST_ID: &str = "elicitation-before-eof"; + + let (to_client, incoming) = tokio::sync::mpsc::unbounded_channel(); + let (outgoing, mut from_client) = tokio::sync::mpsc::unbounded_channel(); + let eof_observed = Arc::new(tokio::sync::Notify::new()); + let finish = Arc::new(tokio::sync::Notify::new()); + let (events_tx, mut events_rx) = tokio::sync::mpsc::unbounded_channel(); + let client = serve_directly::( + WaitForReverseCancelClient { + events: events_tx, + finish: Some(finish.clone()), + return_error, + }, + ChannelClientTransport { + incoming, + outgoing, + eof_observed: eof_observed.clone(), + }, + None, + ); + + to_client.send(reverse_elicitation(REVERSE_REQUEST_ID))?; + assert_eq!( + tokio::time::timeout(READ_TIMEOUT, events_rx.recv()).await?, + Some("started") + ); + + to_client.send(ServerJsonRpcMessage::notification( + ServerNotification::CancelledNotification(CancelledNotification::new( + CancelledNotificationParam::new( + Some(RequestId::String(REVERSE_REQUEST_ID.into())), + Some("user cancelled".to_owned()), + ), + )), + ))?; + assert_eq!( + tokio::time::timeout(READ_TIMEOUT, events_rx.recv()).await?, + Some("cancelled") + ); + + let eof = eof_observed.notified(); + drop(to_client); + tokio::time::timeout(READ_TIMEOUT, eof).await?; + finish.notify_one(); + + assert!( + matches!( + tokio::time::timeout(READ_TIMEOUT, client.waiting()).await??, + QuitReason::Closed + ), + "client must close after input EOF" + ); + assert!( + from_client.recv().await.is_none(), + "cancelled reverse request must not be sent during EOF drain (return_error={return_error})" + ); + Ok(()) +} + +#[tokio::test] +async fn cancelled_response_helper() -> anyhow::Result<()> { + if std::env::var(HELPER_ENV).as_deref() != Ok("1") { + return Ok(()); + } + run_helper_server().await?; + Ok(()) +} + +#[cfg(feature = "local")] +async fn run_helper_server() -> anyhow::Result<()> { + tokio::task::LocalSet::new() + .run_until(serve_helper_stdio()) + .await +} + +#[cfg(not(feature = "local"))] +async fn run_helper_server() -> anyhow::Result<()> { + serve_helper_stdio().await +} + +async fn serve_helper_stdio() -> anyhow::Result<()> { + let server = WaitForCancelServer.serve(rmcp::transport::stdio()).await?; + server.waiting().await?; + Ok(()) +} + +fn spawn_helper() -> Child { + let exe = std::env::current_exe().expect("current test exe"); + Command::new(exe) + .arg("--exact") + .arg("cancelled_response_helper") + .arg("--quiet") + .arg("--nocapture") + .arg("--test-threads") + .arg("1") + .env(HELPER_ENV, "1") + .stdin(Stdio::piped()) + .stdout(Stdio::piped()) + .stderr(Stdio::null()) + .kill_on_drop(true) + .spawn() + .expect("spawn helper") +} + +async fn wait_for_child(child: &mut Child) { + let _ = tokio::time::timeout(Duration::from_secs(2), child.wait()).await; + if child.id().is_some() { + let _ = child.kill().await; + } +} + +async fn send_json(writer: &mut W, message: &Value) -> anyhow::Result<()> +where + W: AsyncWrite + Unpin, +{ + let serialized = serde_json::to_string(message)?; + writer.write_all(serialized.as_bytes()).await?; + writer.write_all(b"\n").await?; + writer.flush().await?; + Ok(()) +} + +/// Read response lines, collecting every message id seen, until `stop_id` is seen +/// (then a short grace read to catch any straggler) or the timeout elapses. +async fn collect_ids_until( + reader: &mut BufReader, + stop_id: &str, + timeout: Duration, +) -> anyhow::Result> +where + R: tokio::io::AsyncRead + Unpin, +{ + let mut seen = BTreeSet::new(); + let mut deadline = tokio::time::Instant::now() + timeout; + loop { + let remaining = deadline.saturating_duration_since(tokio::time::Instant::now()); + if remaining.is_zero() { + break; + } + let mut line = String::new(); + let Ok(read_result) = tokio::time::timeout(remaining, reader.read_line(&mut line)).await + else { + break; + }; + if read_result? == 0 { + break; + } + let trimmed = line.trim(); + if trimmed.is_empty() { + continue; + } + let Ok(value) = serde_json::from_str::(trimmed) else { + continue; + }; + let id = match value.get("id") { + Some(Value::String(id)) => Some(id.clone()), + Some(Value::Number(id)) => Some(id.to_string()), + _ => None, + }; + if let Some(id) = id { + seen.insert(id.clone()); + if id == stop_id { + // Give any late (incorrectly-sent) response a brief window to arrive. + deadline = tokio::time::Instant::now() + Duration::from_millis(300); + } + } + } + Ok(seen) +} diff --git a/vendor/rmcp/tests/test_client_credentials.rs b/vendor/rmcp/tests/test_client_credentials.rs new file mode 100644 index 00000000..f21c8581 --- /dev/null +++ b/vendor/rmcp/tests/test_client_credentials.rs @@ -0,0 +1,258 @@ +use std::{convert::Infallible, net::SocketAddr}; + +use axum::{ + Router, + body::Body, + http::{Request, Response, StatusCode}, + routing::{get, post}, +}; +use rmcp::transport::auth::{ClientCredentialsConfig, OAuthState}; + +fn json_response(body: serde_json::Value) -> Response { + Response::builder() + .status(StatusCode::OK) + .header("content-type", "application/json") + .body(Body::from(serde_json::to_string(&body).unwrap())) + .unwrap() +} + +fn json_error(status: StatusCode, body: serde_json::Value) -> Response { + Response::builder() + .status(status) + .header("content-type", "application/json") + .body(Body::from(serde_json::to_string(&body).unwrap())) + .unwrap() +} + +async fn resource_metadata_handler(req: Request) -> Result, Infallible> { + let host = req.headers().get("host").unwrap().to_str().unwrap(); + let base_url = format!("http://{}", host); + Ok(json_response(serde_json::json!({ + "resource": base_url, + "authorization_servers": [base_url], + "scopes_supported": ["read", "write"] + }))) +} + +async fn auth_server_metadata_handler(req: Request) -> Result, Infallible> { + let host = req.headers().get("host").unwrap().to_str().unwrap(); + let base_url = format!("http://{}", host); + Ok(auth_server_metadata_response(&base_url, &base_url)) +} + +async fn path_inserted_auth_server_metadata_handler( + req: Request, +) -> Result, Infallible> { + let host = req.headers().get("host").unwrap().to_str().unwrap(); + let base_url = format!("http://{}", host); + Ok(auth_server_metadata_response( + &format!("{}/mcp", base_url), + &base_url, + )) +} + +fn auth_server_metadata_response(issuer: &str, endpoint_base_url: &str) -> Response { + json_response(serde_json::json!({ + "issuer": issuer, + "authorization_endpoint": format!("{}/authorize", endpoint_base_url), + "token_endpoint": format!("{}/token", endpoint_base_url), + "token_endpoint_auth_methods_supported": ["client_secret_post", "client_secret_basic"], + "grant_types_supported": ["client_credentials"], + "scopes_supported": ["read", "write"] + })) +} + +async fn token_handler(req: Request) -> Result, Infallible> { + let body_bytes = axum::body::to_bytes(req.into_body(), 1024 * 64) + .await + .unwrap(); + let body_str = String::from_utf8(body_bytes.to_vec()).unwrap(); + + // Parse form-urlencoded body + let params: Vec<(String, String)> = url::form_urlencoded::parse(body_str.as_bytes()) + .into_owned() + .collect(); + + let get_param = |key: &str| -> Option { + params + .iter() + .find(|(k, _)| k == key) + .map(|(_, v)| v.clone()) + }; + + let grant_type = get_param("grant_type").unwrap_or_default(); + if grant_type != "client_credentials" { + return Ok(json_error( + StatusCode::BAD_REQUEST, + serde_json::json!({ + "error": "unsupported_grant_type", + "error_description": "Only client_credentials grant type is supported" + }), + )); + } + + let client_id = get_param("client_id").unwrap_or_default(); + if client_id != "test-m2m-client" { + return Ok(json_error( + StatusCode::UNAUTHORIZED, + serde_json::json!({ + "error": "invalid_client", + "error_description": "Unknown client_id" + }), + )); + } + + let client_secret = get_param("client_secret").unwrap_or_default(); + if client_secret != "test-m2m-secret" { + return Ok(json_error( + StatusCode::UNAUTHORIZED, + serde_json::json!({ + "error": "invalid_client", + "error_description": "Invalid client_secret" + }), + )); + } + + let scope = get_param("scope").unwrap_or_default(); + + let mut response = serde_json::json!({ + "access_token": "m2m-access-token-12345", + "token_type": "Bearer", + "expires_in": 3600 + }); + + if !scope.is_empty() { + response["scope"] = serde_json::Value::String(scope); + } + + Ok(json_response(response)) +} + +async fn start_mock_server() -> (String, SocketAddr) { + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let addr = listener.local_addr().unwrap(); + let base_url = format!("http://{}", addr); + + let app = Router::new() + .route( + "/.well-known/oauth-protected-resource", + get(resource_metadata_handler), + ) + .route( + "/.well-known/oauth-authorization-server", + get(auth_server_metadata_handler), + ) + .route("/token", post(token_handler)); + + tokio::spawn(async move { + axum::serve(listener, app).await.unwrap(); + }); + + (base_url, addr) +} + +async fn start_path_insert_metadata_server() -> (String, SocketAddr) { + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let addr = listener.local_addr().unwrap(); + let base_url = format!("http://{}", addr); + + let app = Router::new() + .route( + "/.well-known/oauth-authorization-server/mcp", + get(path_inserted_auth_server_metadata_handler), + ) + .route("/token", post(token_handler)); + + tokio::spawn(async move { + axum::serve(listener, app).await.unwrap(); + }); + + (base_url, addr) +} + +#[tokio::test] +async fn test_client_credentials_flow_client_secret() { + let (base_url, _addr) = start_mock_server().await; + + let mut oauth_state = OAuthState::new(&base_url, None).await.unwrap(); + + let config = ClientCredentialsConfig::ClientSecret { + client_id: "test-m2m-client".to_string(), + client_secret: "test-m2m-secret".to_string(), + scopes: vec!["read".to_string(), "write".to_string()], + resource: Some(base_url.clone()), + }; + + oauth_state + .authenticate_client_credentials(config) + .await + .unwrap(); + + let manager = oauth_state + .into_authorization_manager() + .expect("Should be in Authorized state"); + + let token = manager.get_access_token().await.unwrap(); + assert_eq!(token, "m2m-access-token-12345"); +} + +#[tokio::test] +async fn test_client_credentials_discovers_path_inserted_oauth_metadata() { + let (base_url, _addr) = start_path_insert_metadata_server().await; + let resource_url = format!("{base_url}/mcp"); + + let mut oauth_state = OAuthState::new(&resource_url, None).await.unwrap(); + + let config = ClientCredentialsConfig::ClientSecret { + client_id: "test-m2m-client".to_string(), + client_secret: "test-m2m-secret".to_string(), + scopes: vec!["read".to_string()], + resource: Some(resource_url), + }; + + oauth_state + .authenticate_client_credentials(config) + .await + .unwrap(); + + let manager = oauth_state + .into_authorization_manager() + .expect("Should be in Authorized state"); + + let token = manager.get_access_token().await.unwrap(); + assert_eq!(token, "m2m-access-token-12345"); +} + +#[tokio::test] +async fn test_client_credentials_invalid_secret() { + let (base_url, _addr) = start_mock_server().await; + + let mut oauth_state = OAuthState::new(&base_url, None).await.unwrap(); + + let config = ClientCredentialsConfig::ClientSecret { + client_id: "test-m2m-client".to_string(), + client_secret: "wrong-secret".to_string(), + scopes: vec![], + resource: Some(base_url.clone()), + }; + + let result = oauth_state.authenticate_client_credentials(config).await; + assert!(result.is_err(), "Should fail with invalid credentials"); +} + +#[tokio::test] +async fn test_client_credentials_invalid_client_id() { + let (base_url, _addr) = start_mock_server().await; + + let mut oauth_state = OAuthState::new(&base_url, None).await.unwrap(); + + let config = ClientCredentialsConfig::ClientSecret { + client_id: "unknown-client".to_string(), + client_secret: "test-m2m-secret".to_string(), + scopes: vec![], + resource: Some(base_url.clone()), + }; + + let result = oauth_state.authenticate_client_credentials(config).await; + assert!(result.is_err(), "Should fail with unknown client_id"); +} diff --git a/vendor/rmcp/tests/test_client_initialization.rs b/vendor/rmcp/tests/test_client_initialization.rs new file mode 100644 index 00000000..0ca0182f --- /dev/null +++ b/vendor/rmcp/tests/test_client_initialization.rs @@ -0,0 +1,159 @@ +// cargo test --features "server client" --package rmcp test_client_initialization +#![cfg(all(feature = "client", not(feature = "local")))] + +mod common; + +use std::borrow::Cow; + +use common::handlers::TestClientHandler; +use rmcp::{ + ServiceExt, + model::{ + ClientJsonRpcMessage, ErrorCode, ErrorData, InitializeResult, JsonRpcError, + JsonRpcVersion2_0, RequestId, ServerCapabilities, ServerJsonRpcMessage, ServerResult, + }, + transport::{IntoTransport, Transport}, +}; + +fn stringify_numeric_id(id: RequestId) -> RequestId { + let RequestId::Number(id) = id else { + panic!("expected a numeric request ID"); + }; + RequestId::String(id.to_string().into()) +} + +#[tokio::test] +async fn client_initialization_accepts_stringified_numeric_response_id() { + let (server_transport, client_transport) = tokio::io::duplex(1024); + let mut server = IntoTransport::::into_transport(server_transport); + let server_task = tokio::spawn(async move { + let ClientJsonRpcMessage::Request(request) = + server.receive().await.expect("expected initialize request") + else { + panic!("expected initialize request"); + }; + server + .send(ServerJsonRpcMessage::response( + ServerResult::InitializeResult( + InitializeResult::new(ServerCapabilities::default()), + ), + stringify_numeric_id(request.id), + )) + .await + .expect("send initialize response"); + assert!(matches!( + server.receive().await, + Some(ClientJsonRpcMessage::Notification(_)) + )); + }); + + let client = TestClientHandler::new(true, true) + .serve(client_transport) + .await + .expect("client should accept stringified initialize response ID"); + assert!( + client + .peer_info() + .expect("peer info should be retained") + .server_info + .is_some(), + "initialize always provides a server implementation identity" + ); + client.cancel().await.expect("cancel client"); + server_task.await.expect("server task"); +} + +#[tokio::test] +async fn client_correlates_stringified_numeric_response_id() { + let (server_transport, client_transport) = tokio::io::duplex(1024); + let mut server = IntoTransport::::into_transport(server_transport); + let server_task = tokio::spawn(async move { + let ClientJsonRpcMessage::Request(initialize) = + server.receive().await.expect("expected initialize request") + else { + panic!("expected initialize request"); + }; + server + .send(ServerJsonRpcMessage::response( + ServerResult::InitializeResult( + InitializeResult::new(ServerCapabilities::default()), + ), + initialize.id, + )) + .await + .expect("send initialize response"); + assert!(matches!( + server.receive().await, + Some(ClientJsonRpcMessage::Notification(_)) + )); + + let ClientJsonRpcMessage::Request(request) = + server.receive().await.expect("expected tools/list request") + else { + panic!("expected tools/list request"); + }; + server + .send(ServerJsonRpcMessage::response( + ServerResult::ListToolsResult(Default::default()), + stringify_numeric_id(request.id), + )) + .await + .expect("send tools/list response"); + }); + + let client = TestClientHandler::new(true, true) + .serve(client_transport) + .await + .expect("initialize client"); + client + .list_tools(None) + .await + .expect("client should correlate stringified response ID"); + client.cancel().await.expect("cancel client"); + server_task.await.expect("server task"); +} + +#[tokio::test] +async fn test_client_init_handles_jsonrpc_error() { + let (server_transport, client_transport) = tokio::io::duplex(1024); + let mut server = IntoTransport::::into_transport(server_transport); + + let client_handle = tokio::spawn(async move { + TestClientHandler::new(true, true) + .serve(client_transport) + .await + }); + + tokio::spawn(async move { + let request = server.receive().await; + // Echo the request's own id back on the error so it correlates: an + // uncorrelated id would surface as `UncorrelatedErrorResponse` + // instead of the `JsonRpcError` this test exercises. + let request_id = request + .and_then(|message| message.into_request()) + .map(|(_, id)| id) + .expect("client sent an initialize request"); + + let error_msg = ServerJsonRpcMessage::Error(JsonRpcError { + jsonrpc: JsonRpcVersion2_0, + id: Some(request_id), + error: ErrorData { + code: ErrorCode(-32600), + message: Cow::Borrowed("Invalid Request"), + data: None, + }, + }); + let _: Result<(), _> = server.send(error_msg).await; + }); + + let result = client_handle.await.unwrap(); + + assert!(result.is_err()); + match result { + Err(rmcp::service::ClientInitializeError::JsonRpcError(error_data)) => { + assert_eq!(error_data.code, ErrorCode(-32600)); + assert_eq!(error_data.message, "Invalid Request"); + } + _ => panic!("Expected ClientInitializeError::JsonRpcError"), + } +} diff --git a/vendor/rmcp/tests/test_client_lifecycle_modes.rs b/vendor/rmcp/tests/test_client_lifecycle_modes.rs new file mode 100644 index 00000000..5fa2cd19 --- /dev/null +++ b/vendor/rmcp/tests/test_client_lifecycle_modes.rs @@ -0,0 +1,791 @@ +#![cfg(all(feature = "client", feature = "server", not(feature = "local")))] + +use rmcp::{ + ClientHandler, ClientLifecycleMode, ClientServiceExt, ServerHandler, ServiceExt, + model::{ + ClientJsonRpcMessage, ClientRequest, DiscoverResult, ErrorCode, ErrorData, GetMeta, + Implementation, InitializeResult, ProtocolVersion, RequestId, ServerCapabilities, + ServerJsonRpcMessage, ServerResult, + }, + service::PeerRequestOptions, + transport::{IntoTransport, Transport}, +}; + +#[derive(Clone, Default)] +struct DiscoverClient; + +impl ClientHandler for DiscoverClient {} + +#[derive(Clone, Default)] +struct StatelessServer; + +impl ServerHandler for StatelessServer {} + +#[tokio::test] +async fn discover_startup_accepts_stringified_numeric_response_id() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let mut server = IntoTransport::::into_transport(server_transport); + let server_task = tokio::spawn(async move { + let ClientJsonRpcMessage::Request(request) = + server.receive().await.expect("expected discover request") + else { + panic!("expected discover request"); + }; + let RequestId::Number(response_id) = request.id else { + panic!("expected a numeric request ID"); + }; + server + .send(ServerJsonRpcMessage::response( + ServerResult::DiscoverResult( + DiscoverResult::new( + vec![ProtocolVersion::V_2026_07_28], + ServerCapabilities::default(), + ) + .with_server_info(Implementation::new("discover-server", "1.0.0")), + ), + RequestId::String(response_id.to_string().into()), + )) + .await + .expect("send discover response"); + }); + + let client = DiscoverClient + .serve_with_lifecycle( + client_transport, + ClientLifecycleMode::Discover { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + }, + ) + .await + .expect("client should accept stringified discover response ID"); + client.cancel().await.expect("cancel client"); + server_task.await.expect("server task"); +} + +#[tokio::test] +#[allow(deprecated)] +async fn discover_startup_accepts_missing_optional_server_info() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let mut server = IntoTransport::::into_transport(server_transport); + let (rejection_observed_tx, rejection_observed_rx) = tokio::sync::oneshot::channel(); + let server_task = tokio::spawn(async move { + let ClientJsonRpcMessage::Request(discover_request) = + server.receive().await.expect("expected discover request") + else { + panic!("expected discover request"); + }; + let mut result = DiscoverResult::new( + vec![ProtocolVersion::V_2026_07_28], + ServerCapabilities::builder().enable_tools().build(), + ); + result.instructions = Some("discovery instructions".into()); + result.meta = Some(rmcp::model::MetaObject::new()); + result + .meta + .as_mut() + .expect("metadata") + .0 + .insert("example.test/key".into(), serde_json::json!(7)); + server + .send(ServerJsonRpcMessage::response( + ServerResult::DiscoverResult(result), + discover_request.id, + )) + .await + .expect("send discover response"); + + server + .send(ServerJsonRpcMessage::request( + rmcp::model::ServerRequest::CreateMessageRequest( + rmcp::model::CreateMessageRequest::new( + rmcp::model::CreateMessageRequestParams::new( + vec![rmcp::model::SamplingMessage::user_text("unsolicited")], + 16, + ), + ), + ), + RequestId::Number(99), + )) + .await + .expect("send unsolicited server request"); + let Some(ClientJsonRpcMessage::Error(error)) = server.receive().await else { + panic!("expected unsolicited server request to be rejected"); + }; + assert_eq!(error.error.code, ErrorCode::INVALID_PARAMS); + rejection_observed_tx + .send(()) + .expect("signal observed rejection"); + + let ClientJsonRpcMessage::Request(request) = + server.receive().await.expect("expected normal request") + else { + panic!("expected normal request"); + }; + assert_eq!( + request.request.get_meta().protocol_version(), + Some(ProtocolVersion::V_2026_07_28) + ); + server + .send(ServerJsonRpcMessage::response( + ServerResult::ListToolsResult(Default::default()), + request.id, + )) + .await + .expect("send list tools response"); + }); + + let client = DiscoverClient + .serve_with_lifecycle( + client_transport, + ClientLifecycleMode::Discover { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + }, + ) + .await + .expect("missing optional server info should not fail discovery"); + let peer_info = client.peer_info().expect("peer info should be retained"); + assert_eq!(peer_info.protocol_version, ProtocolVersion::V_2026_07_28); + assert!(peer_info.capabilities.tools.is_some()); + assert_eq!(peer_info.server_info, None); + assert_eq!( + peer_info.instructions.as_deref(), + Some("discovery instructions") + ); + assert_eq!( + peer_info + .meta + .as_ref() + .and_then(|meta| meta.0.get("example.test/key")), + Some(&serde_json::json!(7)) + ); + rejection_observed_rx + .await + .expect("server should observe association rejection"); + client.list_tools(None).await.expect("list tools"); + client.cancel().await.expect("cancel client"); + server_task.await.expect("server task"); +} + +#[tokio::test] +async fn high_level_server_accepts_discover_startup_without_initialize() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let server_task = tokio::spawn(async move { + StatelessServer + .serve(server_transport) + .await + .expect("server should accept discover") + }); + + let client = DiscoverClient + .serve_with_lifecycle( + client_transport, + ClientLifecycleMode::Discover { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + }, + ) + .await + .expect("discover client should start"); + client.list_tools(None).await.expect("list tools"); + client.cancel().await.expect("cancel client"); + let server = server_task.await.expect("server task"); + server.cancel().await.expect("cancel server"); +} + +#[tokio::test] +async fn discover_startup_omits_initialize() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let mut server = IntoTransport::::into_transport(server_transport); + let server_task = tokio::spawn(async move { + let ClientJsonRpcMessage::Request(request) = + server.receive().await.expect("expected discover request") + else { + panic!("expected request"); + }; + assert!(matches!(request.request, ClientRequest::DiscoverRequest(_))); + let meta = request.request.get_meta(); + assert_eq!(meta.protocol_version(), Some(ProtocolVersion::V_2026_07_28)); + assert!(meta.client_info().is_some()); + assert!(meta.client_capabilities().is_some()); + + server + .send(ServerJsonRpcMessage::response( + ServerResult::DiscoverResult( + DiscoverResult::new( + vec![ProtocolVersion::V_2026_07_28], + ServerCapabilities::default(), + ) + .with_server_info(Implementation::new("discover-server", "1.0.0")), + ), + request.id, + )) + .await + .expect("send discover response"); + + let ClientJsonRpcMessage::Request(request) = + server.receive().await.expect("expected normal request") + else { + panic!("expected request"); + }; + assert!(!matches!( + request.request, + ClientRequest::InitializeRequest(_) + )); + let meta = request.request.get_meta(); + assert_eq!(meta.protocol_version(), Some(ProtocolVersion::V_2025_11_25)); + assert!(meta.client_info().is_some()); + assert!(meta.client_capabilities().is_some()); + assert_eq!( + meta.get("example.test/extension"), + Some(&serde_json::json!(7)) + ); + server + .send(ServerJsonRpcMessage::response( + ServerResult::ListToolsResult(Default::default()), + request.id, + )) + .await + .expect("send tools response"); + }); + + let client = DiscoverClient + .serve_with_lifecycle( + client_transport, + ClientLifecycleMode::Discover { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + }, + ) + .await + .expect("discover client should start"); + let mut caller_meta = rmcp::model::RequestMetaObject::new(); + caller_meta.insert("example.test/extension".into(), serde_json::json!(7)); + caller_meta.set_protocol_version(ProtocolVersion::V_2025_11_25); + client + .send_request_with_option( + ClientRequest::ListToolsRequest(rmcp::model::ListToolsRequest { + method: Default::default(), + params: None, + extensions: Default::default(), + }), + PeerRequestOptions::default().with_meta(caller_meta), + ) + .await + .expect("send list tools") + .await_response() + .await + .expect("list tools response"); + client.cancel().await.expect("cancel client"); + server_task.await.expect("server task"); +} + +#[tokio::test] +async fn auto_startup_falls_back_after_discover_method_not_found() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let mut server = IntoTransport::::into_transport(server_transport); + let server_task = tokio::spawn(async move { + let ClientJsonRpcMessage::Request(discover) = + server.receive().await.expect("expected discover request") + else { + panic!("expected request"); + }; + assert!(matches!( + discover.request, + ClientRequest::DiscoverRequest(_) + )); + server + .send(ServerJsonRpcMessage::error( + ErrorData::new(ErrorCode::METHOD_NOT_FOUND, "Method not found", None), + Some(discover.id), + )) + .await + .expect("send method-not-found"); + + let ClientJsonRpcMessage::Request(initialize) = + server.receive().await.expect("expected initialize request") + else { + panic!("expected request"); + }; + assert!(matches!( + initialize.request, + ClientRequest::InitializeRequest(_) + )); + server + .send(ServerJsonRpcMessage::response( + ServerResult::InitializeResult( + InitializeResult::new(ServerCapabilities::default()), + ), + initialize.id, + )) + .await + .expect("send initialize response"); + assert!(matches!( + server.receive().await, + Some(ClientJsonRpcMessage::Notification(_)) + )); + }); + + let client = DiscoverClient + .serve_with_lifecycle( + client_transport, + ClientLifecycleMode::Auto { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + legacy_version: Some(ProtocolVersion::V_2025_11_25), + }, + ) + .await + .expect("auto client should fall back"); + client.cancel().await.expect("cancel client"); + server_task.await.expect("server task"); +} + +/// Drives an `Auto` client through a single `server/discover` probe and asserts +/// the legacy fallback decision against the response the server sends back. +/// +/// When `expect_fallback` is set, the server also accepts the subsequent +/// `initialize` request and the client is expected to connect. Otherwise the +/// client must surface the discover error without sending `initialize`, and the +/// server's next receive must not be an initialize request. +async fn run_auto_discover_response_scenario(error: ErrorData, expect_fallback: bool) { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let mut server = IntoTransport::::into_transport(server_transport); + let server_task = tokio::spawn(async move { + let ClientJsonRpcMessage::Request(discover) = + server.receive().await.expect("expected discover request") + else { + panic!("expected request"); + }; + assert!(matches!( + discover.request, + ClientRequest::DiscoverRequest(_) + )); + server + .send(ServerJsonRpcMessage::error(error, Some(discover.id))) + .await + .expect("send discover error response"); + + if expect_fallback { + let ClientJsonRpcMessage::Request(initialize) = + server.receive().await.expect("expected initialize request") + else { + panic!("expected request"); + }; + assert!(matches!( + initialize.request, + ClientRequest::InitializeRequest(_) + )); + server + .send(ServerJsonRpcMessage::response( + ServerResult::InitializeResult(InitializeResult::new( + ServerCapabilities::default(), + )), + initialize.id, + )) + .await + .expect("send initialize response"); + assert!(matches!( + server.receive().await, + Some(ClientJsonRpcMessage::Notification(_)) + )); + } else { + // The client must surface the error without falling back, so no + // initialize request should follow. The transport closes when the + // failed client is dropped. + if let Some(ClientJsonRpcMessage::Request(request)) = server.receive().await { + panic!( + "client fell back to {:?} but should have surfaced the modern error", + request.request + ); + } + } + }); + + let client_result = DiscoverClient + .serve_with_lifecycle( + client_transport, + ClientLifecycleMode::Auto { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + legacy_version: Some(ProtocolVersion::V_2025_11_25), + }, + ) + .await; + + if expect_fallback { + let client = client_result.expect("auto client should fall back to initialize"); + client.cancel().await.expect("cancel client"); + } else { + assert!( + client_result.is_err(), + "modern error should surface without legacy fallback" + ); + } + server_task.await.expect("server task"); +} + +#[tokio::test] +async fn auto_startup_falls_back_after_discover_invalid_request() { + // Legacy servers commonly reject an unknown pre-initialize request with + // `-32600` (e.g. a session middleware that requires `initialize` first). + run_auto_discover_response_scenario( + ErrorData::new(ErrorCode::INVALID_REQUEST, "Bad Request", None), + true, + ) + .await; +} + +#[tokio::test] +async fn auto_startup_falls_back_after_discover_invalid_params() { + // `-32602` is explicitly called out by the specification as an + // implementation-defined response legacy servers use for unknown requests. + run_auto_discover_response_scenario( + ErrorData::new(ErrorCode::INVALID_PARAMS, "Invalid params", None), + true, + ) + .await; +} + +#[tokio::test] +async fn auto_startup_does_not_fall_back_for_missing_required_capability() { + // A `MISSING_REQUIRED_CLIENT_CAPABILITY` response identifies a modern + // server; falling back to `initialize` would not address it. + run_auto_discover_response_scenario( + ErrorData::new( + ErrorCode::MISSING_REQUIRED_CLIENT_CAPABILITY, + "Missing required client capability", + None, + ), + false, + ) + .await; +} + +#[tokio::test] +async fn auto_startup_does_not_fall_back_for_header_mismatch() { + // A `HEADER_MISMATCH` response identifies a modern server performing + // header validation; falling back to `initialize` would not address it. + run_auto_discover_response_scenario( + ErrorData::new(ErrorCode::HEADER_MISMATCH, "Header mismatch", None), + false, + ) + .await; +} + +#[tokio::test] +async fn auto_startup_preserves_both_errors_when_fallback_also_fails() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let mut server = IntoTransport::::into_transport(server_transport); + let server_task = tokio::spawn(async move { + // Discover: legacy rejection. + let ClientJsonRpcMessage::Request(discover) = + server.receive().await.expect("expected discover request") + else { + panic!("expected request"); + }; + server + .send(ServerJsonRpcMessage::error( + ErrorData::new(ErrorCode::METHOD_NOT_FOUND, "not found", None), + Some(discover.id), + )) + .await + .expect("send discover error"); + + // Initialize: close the transport instead of responding. + let ClientJsonRpcMessage::Request(_) = + server.receive().await.expect("expected initialize request") + else { + panic!("expected request"); + }; + drop(server); // closes the transport + }); + + let result = DiscoverClient + .serve_with_lifecycle( + client_transport, + ClientLifecycleMode::Auto { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + legacy_version: Some(ProtocolVersion::V_2025_11_25), + }, + ) + .await; + + let err = result.err().expect("both phases should fail"); + match err { + rmcp::service::ClientInitializeError::LegacyFallbackFailed { discover, fallback } => { + assert!( + matches!( + *discover, + rmcp::service::ClientInitializeError::JsonRpcError(_) + ), + "discover phase should be a JsonRpcError, got {discover:?}" + ); + assert!( + matches!( + *fallback, + rmcp::service::ClientInitializeError::ConnectionClosed(_) + ), + "fallback phase should be ConnectionClosed, got {fallback:?}" + ); + } + other => panic!("expected LegacyFallbackFailed, got {other:?}"), + } + server_task.await.expect("server task"); +} + +#[tokio::test] +async fn auto_startup_surfaces_uncorrelated_error_id() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let mut server = IntoTransport::::into_transport(server_transport); + let server_task = tokio::spawn(async move { + let ClientJsonRpcMessage::Request(_) = + server.receive().await.expect("expected discover request") + else { + panic!("expected request"); + }; + // Respond with an error carrying a different id. + server + .send(ServerJsonRpcMessage::error( + ErrorData::new(ErrorCode::METHOD_NOT_FOUND, "not found", None), + Some(RequestId::Number(999)), + )) + .await + .expect("send mismatched-id error"); + }); + + let result = DiscoverClient + .serve_with_lifecycle( + client_transport, + ClientLifecycleMode::Auto { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + legacy_version: Some(ProtocolVersion::V_2025_11_25), + }, + ) + .await; + + assert!( + matches!( + result, + Err(rmcp::service::ClientInitializeError::UncorrelatedErrorResponse { .. }) + ), + "mismatched id should surface as UncorrelatedErrorResponse, got {:?}", + result.as_ref().err() + ); + server_task.await.expect("server task"); +} + +#[tokio::test] +async fn auto_startup_falls_back_for_absent_error_id() { + // Spec: error id is optional; a server that cannot read the request id + // omits it. The error is still a response to our request, so it should + // trigger legacy fallback. + let (server_transport, client_transport) = tokio::io::duplex(4096); + let mut server = IntoTransport::::into_transport(server_transport); + let server_task = tokio::spawn(async move { + let ClientJsonRpcMessage::Request(_discover) = + server.receive().await.expect("expected discover request") + else { + panic!("expected request"); + }; + server + .send(ServerJsonRpcMessage::error( + ErrorData::new(ErrorCode::METHOD_NOT_FOUND, "not found", None), + None, + )) + .await + .expect("send no-id error"); + + // Client should fall back to initialize. + let ClientJsonRpcMessage::Request(initialize) = + server.receive().await.expect("expected initialize request") + else { + panic!("expected request"); + }; + server + .send(ServerJsonRpcMessage::response( + ServerResult::InitializeResult( + InitializeResult::new(ServerCapabilities::default()), + ), + initialize.id, + )) + .await + .expect("send initialize response"); + assert!(matches!( + server.receive().await, + Some(ClientJsonRpcMessage::Notification(_)) + )); + }); + + let client = DiscoverClient + .serve_with_lifecycle( + client_transport, + ClientLifecycleMode::Auto { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + legacy_version: Some(ProtocolVersion::V_2025_11_25), + }, + ) + .await + .expect("absent-id error should trigger legacy fallback"); + client.cancel().await.expect("cancel client"); + server_task.await.expect("server task"); +} + +#[tokio::test] +async fn discover_mode_surfaces_legacy_error() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let mut server = IntoTransport::::into_transport(server_transport); + let server_task = tokio::spawn(async move { + let ClientJsonRpcMessage::Request(discover) = + server.receive().await.expect("expected discover request") + else { + panic!("expected request"); + }; + server + .send(ServerJsonRpcMessage::error( + ErrorData::new(ErrorCode::METHOD_NOT_FOUND, "not found", None), + Some(discover.id), + )) + .await + .expect("send discover error"); + }); + + let result = DiscoverClient + .serve_with_lifecycle( + client_transport, + ClientLifecycleMode::Discover { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + }, + ) + .await; + + assert!( + matches!( + result, + Err(rmcp::service::ClientInitializeError::JsonRpcError(_)) + ), + "Discover mode should surface a legacy error, not fall back, got {:?}", + result.as_ref().err() + ); + server_task.await.expect("server task"); +} + +#[tokio::test] +async fn discover_startup_retries_a_mutually_supported_version() { + let unsupported: ProtocolVersion = + serde_json::from_value(serde_json::json!("2099-01-01")).unwrap(); + let (server_transport, client_transport) = tokio::io::duplex(4096); + let mut server = IntoTransport::::into_transport(server_transport); + let server_task = tokio::spawn(async move { + let ClientJsonRpcMessage::Request(first) = + server.receive().await.expect("expected first discover") + else { + panic!("expected request"); + }; + assert_eq!( + first.request.get_meta().protocol_version(), + Some(unsupported.clone()) + ); + server + .send(ServerJsonRpcMessage::error( + ErrorData::unsupported_protocol_version( + unsupported, + &[ProtocolVersion::V_2026_07_28], + ), + Some(first.id), + )) + .await + .expect("send unsupported error"); + + let ClientJsonRpcMessage::Request(second) = + server.receive().await.expect("expected retry discover") + else { + panic!("expected request"); + }; + assert_eq!( + second.request.get_meta().protocol_version(), + Some(ProtocolVersion::V_2026_07_28) + ); + server + .send(ServerJsonRpcMessage::response( + ServerResult::DiscoverResult( + DiscoverResult::new( + vec![ProtocolVersion::V_2026_07_28], + ServerCapabilities::default(), + ) + .with_server_info(Implementation::new("discover-server", "1.0.0")), + ), + second.id, + )) + .await + .expect("send discover response"); + }); + + let client = DiscoverClient + .serve_with_lifecycle( + client_transport, + ClientLifecycleMode::Discover { + preferred_versions: vec![ + serde_json::from_value(serde_json::json!("2099-01-01")).unwrap(), + ProtocolVersion::V_2026_07_28, + ], + }, + ) + .await + .expect("discover client should retry"); + client.cancel().await.expect("cancel client"); + server_task.await.expect("server task"); +} + +#[tokio::test] +async fn discover_startup_retries_current_version_once_when_server_reports_it_supported() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let mut server = IntoTransport::::into_transport(server_transport); + let server_task = tokio::spawn(async move { + let ClientJsonRpcMessage::Request(first) = + server.receive().await.expect("expected first discover") + else { + panic!("expected request"); + }; + server + .send(ServerJsonRpcMessage::error( + ErrorData::unsupported_protocol_version( + ProtocolVersion::V_2026_07_28, + &[ProtocolVersion::V_2026_07_28], + ), + Some(first.id), + )) + .await + .expect("send unsupported error"); + + let ClientJsonRpcMessage::Request(second) = + server.receive().await.expect("expected retry discover") + else { + panic!("expected request"); + }; + assert_eq!( + second.request.get_meta().protocol_version(), + Some(ProtocolVersion::V_2026_07_28) + ); + server + .send(ServerJsonRpcMessage::response( + ServerResult::DiscoverResult( + DiscoverResult::new( + vec![ProtocolVersion::V_2026_07_28], + ServerCapabilities::default(), + ) + .with_server_info(Implementation::new("discover-server", "1.0.0")), + ), + second.id, + )) + .await + .expect("send discover response"); + }); + + let client = DiscoverClient + .serve_with_lifecycle( + client_transport, + ClientLifecycleMode::Discover { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + }, + ) + .await + .expect("discover client should retry once"); + client.cancel().await.expect("cancel client"); + server_task.await.expect("server task"); +} diff --git a/vendor/rmcp/tests/test_close_connection.rs b/vendor/rmcp/tests/test_close_connection.rs new file mode 100644 index 00000000..50479a23 --- /dev/null +++ b/vendor/rmcp/tests/test_close_connection.rs @@ -0,0 +1,128 @@ +#![cfg(not(feature = "local"))] +//cargo test --test test_close_connection --features "client server" + +mod common; +use std::time::Duration; + +use common::handlers::{TestClientHandler, TestServer}; +use rmcp::{ServiceExt, service::QuitReason}; + +/// Test that close() properly shuts down the connection +#[tokio::test] +async fn test_close_method() -> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(4096); + + // Start server + let server_handle = tokio::spawn(async move { + let server = TestServer::new().serve(server_transport).await?; + server.waiting().await?; + anyhow::Ok(()) + }); + + // Start client + let handler = TestClientHandler::new(true, true); + let mut client = handler.serve(client_transport).await?; + + // Verify client is not closed + assert!(!client.is_closed()); + + // Call close() and verify it returns + let result = client.close().await?; + assert!(matches!(result, QuitReason::Cancelled)); + + // Verify client is now closed + assert!(client.is_closed()); + + // Calling close() again should return Closed immediately + let result = client.close().await?; + assert!(matches!(result, QuitReason::Closed)); + + // Wait for server to finish + server_handle.await??; + Ok(()) +} + +/// Test that close_with_timeout() respects the timeout +#[tokio::test] +async fn test_close_with_timeout() -> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(4096); + + // Start server + let server_handle = tokio::spawn(async move { + let server = TestServer::new().serve(server_transport).await?; + server.waiting().await?; + anyhow::Ok(()) + }); + + // Start client + let handler = TestClientHandler::new(true, true); + let mut client = handler.serve(client_transport).await?; + + // Close with a reasonable timeout + let result = client.close_with_timeout(Duration::from_secs(5)).await?; + assert!(result.is_some()); + assert!(matches!(result.unwrap(), QuitReason::Cancelled)); + + // Verify client is now closed + assert!(client.is_closed()); + + // Wait for server to finish + server_handle.await??; + Ok(()) +} + +/// Test that cancel() still works and consumes self +#[tokio::test] +async fn test_cancel_method() -> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(4096); + + // Start server + let server_handle = tokio::spawn(async move { + let server = TestServer::new().serve(server_transport).await?; + server.waiting().await?; + anyhow::Ok(()) + }); + + // Start client + let handler = TestClientHandler::new(true, true); + let client = handler.serve(client_transport).await?; + + // Cancel should work as before + let result = client.cancel().await?; + assert!(matches!(result, QuitReason::Cancelled)); + + // Wait for server to finish + server_handle.await??; + Ok(()) +} + +/// Test that dropping without close() logs a debug message (we can't easily test +/// the log output, but we can verify the drop doesn't panic) +#[tokio::test] +async fn test_drop_without_close() -> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(4096); + + // Start server that will handle the drop + let server_handle = tokio::spawn(async move { + let server = TestServer::new().serve(server_transport).await?; + // The server should close when the client drops + let result = server.waiting().await?; + // Server should detect closure + assert!(matches!(result, QuitReason::Closed | QuitReason::Cancelled)); + anyhow::Ok(()) + }); + + // Create and immediately drop the client + { + let handler = TestClientHandler::new(true, true); + let _client = handler.serve(client_transport).await?; + // Client dropped here without calling close() + } + + // Give the async cleanup a moment to run + tokio::time::sleep(Duration::from_millis(100)).await; + + // Wait for server to finish (it should detect the closure) + server_handle.await??; + Ok(()) +} diff --git a/vendor/rmcp/tests/test_completion.rs b/vendor/rmcp/tests/test_completion.rs new file mode 100644 index 00000000..b155bd91 --- /dev/null +++ b/vendor/rmcp/tests/test_completion.rs @@ -0,0 +1,208 @@ +use std::collections::HashMap; + +use rmcp::model::*; +use serde_json::json; + +#[test] +fn test_completion_context_serialization() { + let mut args = HashMap::new(); + args.insert("key1".to_string(), "value1".to_string()); + args.insert("key2".to_string(), "value2".to_string()); + + let context = CompletionContext::with_arguments(args); + + // Test serialization + let json = serde_json::to_value(&context).unwrap(); + let expected = json!({ + "arguments": { + "key1": "value1", + "key2": "value2" + } + }); + assert_eq!(json, expected); + + // Test deserialization + let deserialized: CompletionContext = serde_json::from_value(expected).unwrap(); + assert_eq!(deserialized, context); +} + +#[test] +fn test_completion_context_methods() { + let mut args = HashMap::new(); + args.insert("city".to_string(), "San Francisco".to_string()); + args.insert("country".to_string(), "USA".to_string()); + + let context = CompletionContext::with_arguments(args); + + assert!(context.has_arguments()); + assert_eq!( + context.get_argument("city"), + Some(&"San Francisco".to_string()) + ); + assert_eq!(context.get_argument("missing"), None); + + let names: Vec<&str> = context.argument_names().collect(); + assert!(names.contains(&"city")); + assert!(names.contains(&"country")); + assert_eq!(names.len(), 2); +} + +#[test] +fn test_complete_request_param_serialization() { + let mut args = HashMap::new(); + args.insert("previous_input".to_string(), "test".to_string()); + + let request = CompleteRequestParams::new( + Reference::for_prompt("weather_prompt"), + ArgumentInfo::new("location", "San"), + ) + .with_context(CompletionContext::with_arguments(args)); + + let json = serde_json::to_value(&request).unwrap(); + assert!(json["ref"]["name"].as_str().unwrap() == "weather_prompt"); + assert!(json["argument"]["name"].as_str().unwrap() == "location"); + assert!(json["argument"]["value"].as_str().unwrap() == "San"); + assert!( + json["context"]["arguments"]["previous_input"] + .as_str() + .unwrap() + == "test" + ); +} + +#[test] +fn test_completion_info_validation() { + // Valid completion with less than max values + let values = vec!["option1".to_string(), "option2".to_string()]; + let completion = CompletionInfo::new(values.clone()).unwrap(); + assert_eq!(completion.values, values); + assert!(completion.validate().is_ok()); + + // Test max values limit + let many_values: Vec = (0..=CompletionInfo::MAX_VALUES) + .map(|i| format!("option_{}", i)) + .collect(); + let result = CompletionInfo::new(many_values); + assert!(result.is_err()); +} + +#[test] +fn test_completion_info_helper_methods() { + let values = vec!["test1".to_string(), "test2".to_string()]; + + // Test with_all_values + let completion = CompletionInfo::with_all_values(values.clone()).unwrap(); + assert_eq!(completion.values, values); + assert_eq!(completion.total, Some(2)); + assert_eq!(completion.has_more, Some(false)); + assert!(!completion.has_more_results()); + assert_eq!(completion.total_available(), Some(2)); + + // Test with_pagination + let paginated = CompletionInfo::with_pagination(values.clone(), Some(10), true).unwrap(); + assert_eq!(paginated.values, values); + assert_eq!(paginated.total, Some(10)); + assert_eq!(paginated.has_more, Some(true)); + assert!(paginated.has_more_results()); + assert_eq!(paginated.total_available(), Some(10)); +} + +#[test] +fn test_completion_info_bounds() { + // Test exactly at the limit + let max_values: Vec = (0..CompletionInfo::MAX_VALUES) + .map(|i| format!("value_{}", i)) + .collect(); + assert!(CompletionInfo::new(max_values).is_ok()); + + // Test over the limit + let over_limit: Vec = (0..=CompletionInfo::MAX_VALUES) + .map(|i| format!("value_{}", i)) + .collect(); + assert!(CompletionInfo::new(over_limit).is_err()); +} + +#[test] +fn test_reference_convenience_methods() { + let prompt_ref = Reference::for_prompt("test_prompt"); + assert_eq!(prompt_ref.reference_type(), "ref/prompt"); + assert_eq!(prompt_ref.as_prompt_name(), Some("test_prompt")); + assert_eq!(prompt_ref.as_resource_uri(), None); + + let resource_ref = Reference::for_resource("file://path/to/resource"); + assert_eq!(resource_ref.reference_type(), "ref/resource"); + assert_eq!( + resource_ref.as_resource_uri(), + Some("file://path/to/resource") + ); + assert_eq!(resource_ref.as_prompt_name(), None); +} + +#[test] +fn test_completion_serialization_format() { + // Test that completion follows MCP 2025-06-18 specification format + let completion = + CompletionInfo::with_all_values(vec!["value1".to_string(), "value2".to_string()]).unwrap(); + + let json = serde_json::to_value(&completion).unwrap(); + + // Verify JSON structure matches specification + assert!(json.is_object()); + assert!(json["values"].is_array()); + assert_eq!(json["values"].as_array().unwrap().len(), 2); + assert_eq!(json["total"].as_u64().unwrap(), 2); + assert!(!json["hasMore"].as_bool().unwrap()); +} + +#[test] +fn test_resource_reference() { + // ResourceTemplateReference가 `ref/resource` 와이어 태그로 직렬화/역직렬화되는지 확인 + let reference = Reference::for_resource("test://uri"); + + let json = serde_json::to_value(&reference).unwrap(); + assert_eq!(json["type"], "ref/resource"); + assert_eq!(json["uri"], "test://uri"); + + let back: Reference = serde_json::from_value(json).unwrap(); + match back { + Reference::Resource(r) => assert_eq!(r.uri, "test://uri"), + other => panic!("expected Reference::Resource, got {other:?}"), + } +} + +#[test] +fn test_complete_result_default() { + let result = CompleteResult::default(); + assert!(result.completion.values.is_empty()); + assert_eq!(result.completion.total, None); + assert_eq!(result.completion.has_more, None); +} + +#[test] +fn test_completion_context_empty() { + let context = CompletionContext::new(); + assert!(!context.has_arguments()); + assert_eq!(context.get_argument("any"), None); + assert!(context.argument_names().count() == 0); +} + +#[test] +fn test_mcp_schema_compliance() { + // Test that our types serialize correctly according to MCP specification + let request = CompleteRequestParams::new( + Reference::for_resource("file://{path}"), + ArgumentInfo::new("path", "src/"), + ); + + let json_str = serde_json::to_string(&request).unwrap(); + let parsed: serde_json::Value = serde_json::from_str(&json_str).unwrap(); + + // Verify key structure matches MCP spec + assert!(parsed["ref"].is_object()); + assert!(parsed["argument"].is_object()); + assert!(parsed["argument"]["name"].is_string()); + assert!(parsed["argument"]["value"].is_string()); + + // Verify type tag is correct + assert_eq!(parsed["ref"]["type"].as_str().unwrap(), "ref/resource"); +} diff --git a/vendor/rmcp/tests/test_complex_schema.rs b/vendor/rmcp/tests/test_complex_schema.rs new file mode 100644 index 00000000..9372b015 --- /dev/null +++ b/vendor/rmcp/tests/test_complex_schema.rs @@ -0,0 +1,105 @@ +#![allow(clippy::exhaustive_structs, clippy::exhaustive_enums)] + +use rmcp::{ + ErrorData as McpError, handler::server::wrapper::Parameters, model::*, schemars, tool, + tool_router, +}; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize, Deserialize, schemars::JsonSchema)] +pub enum ChatRole { + System, + User, + Assistant, + Tool, +} + +#[derive(Debug, Clone, Serialize, Deserialize, schemars::JsonSchema)] +pub struct ChatMessage { + pub role: ChatRole, + pub content: String, +} + +#[derive(Debug, Clone, Serialize, Deserialize, schemars::JsonSchema)] +pub struct ChatRequest { + pub system: Option, + pub messages: Vec, +} + +#[derive(Clone, Default)] +pub struct Demo; + +#[tool_router] +impl Demo { + pub fn new() -> Self { + Self + } + + #[tool(description = "LLM")] + async fn chat( + &self, + chat_request: Parameters, + ) -> Result { + let content = ContentBlock::json(chat_request.0)?; + Ok(CallToolResult::success(vec![content])) + } +} + +fn expected_schema() -> serde_json::Value { + serde_json::json!({ + "$defs": { + "ChatMessage": { + "properties": { + "content": { + "type": "string" + }, + "role": { + "$ref": "#/$defs/ChatRole" + } + }, + "required": [ + "role", + "content" + ], + "type": "object" + }, + "ChatRole": { + "enum": [ + "System", + "User", + "Assistant", + "Tool" + ], + "type": "string" + } + }, + "$schema": "https://json-schema.org/draft/2020-12/schema", + "properties": { + "messages": { + "items": { + "$ref": "#/$defs/ChatMessage" + }, + "type": "array" + }, + "system": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "messages" + ], + "type": "object" + }) +} + +#[test] +fn test_complex_schema() { + let attr = Demo::chat_tool_attr(); + let input_schema = attr.input_schema; + let expected = expected_schema(); + let produced = serde_json::Value::Object(input_schema.as_ref().clone()); + assert_eq!(produced, expected, "schema mismatch"); +} diff --git a/vendor/rmcp/tests/test_custom_headers.rs b/vendor/rmcp/tests/test_custom_headers.rs new file mode 100644 index 00000000..5d4419e5 --- /dev/null +++ b/vendor/rmcp/tests/test_custom_headers.rs @@ -0,0 +1,1404 @@ +#![cfg(not(feature = "local"))] +use std::collections::HashMap; + +use http::{HeaderName, HeaderValue}; + +#[test] +fn test_config_custom_headers_default_empty() { + use rmcp::transport::streamable_http_client::StreamableHttpClientTransportConfig; + + let config = StreamableHttpClientTransportConfig::with_uri("http://localhost:8080"); + assert!( + config.custom_headers.is_empty(), + "Default custom_headers should be empty" + ); +} + +#[test] +fn test_config_custom_headers_builder() { + use rmcp::transport::streamable_http_client::StreamableHttpClientTransportConfig; + + let mut headers = HashMap::new(); + headers.insert( + HeaderName::from_static("x-test-header"), + HeaderValue::from_static("test-value"), + ); + + let config = StreamableHttpClientTransportConfig::with_uri("http://localhost:8080") + .custom_headers(headers); + + assert_eq!(config.custom_headers.len(), 1); + assert_eq!( + config + .custom_headers + .get(&HeaderName::from_static("x-test-header")), + Some(&HeaderValue::from_static("test-value")) + ); +} + +#[test] +fn test_config_custom_headers_multiple_values() { + use rmcp::transport::streamable_http_client::StreamableHttpClientTransportConfig; + + let mut headers = HashMap::new(); + headers.insert( + HeaderName::from_static("x-header-1"), + HeaderValue::from_static("value-1"), + ); + headers.insert( + HeaderName::from_static("x-header-2"), + HeaderValue::from_static("value-2"), + ); + headers.insert( + HeaderName::from_static("authorization"), + HeaderValue::from_static("Bearer token123"), + ); + + let config = StreamableHttpClientTransportConfig::with_uri("http://localhost:8080") + .custom_headers(headers); + + assert_eq!(config.custom_headers.len(), 3); + assert_eq!( + config + .custom_headers + .get(&HeaderName::from_static("x-header-1")), + Some(&HeaderValue::from_static("value-1")) + ); + assert_eq!( + config + .custom_headers + .get(&HeaderName::from_static("x-header-2")), + Some(&HeaderValue::from_static("value-2")) + ); + assert_eq!( + config + .custom_headers + .get(&HeaderName::from_static("authorization")), + Some(&HeaderValue::from_static("Bearer token123")) + ); +} + +#[test] +fn test_config_auth_header_and_custom_headers_together() { + use rmcp::transport::streamable_http_client::StreamableHttpClientTransportConfig; + + let mut headers = HashMap::new(); + headers.insert( + HeaderName::from_static("x-custom-header"), + HeaderValue::from_static("custom-value"), + ); + + let config = StreamableHttpClientTransportConfig::with_uri("http://localhost:8080") + .auth_header("my-bearer-token") + .custom_headers(headers); + + assert_eq!(config.auth_header, Some("my-bearer-token".to_string())); + assert_eq!( + config + .custom_headers + .get(&HeaderName::from_static("x-custom-header")), + Some(&HeaderValue::from_static("custom-value")) + ); +} + +/// Unit test: post_message should reject reserved header "accept" +#[tokio::test] +#[cfg(feature = "transport-streamable-http-client-reqwest")] +async fn test_post_message_rejects_accept_header() { + use std::sync::Arc; + + use rmcp::{ + model::{ClientJsonRpcMessage, ClientRequest, PingRequest, RequestId}, + transport::streamable_http_client::{StreamableHttpClient, StreamableHttpError}, + }; + + let client = reqwest::Client::new(); + let mut custom_headers = HashMap::new(); + custom_headers.insert( + HeaderName::from_static("accept"), + HeaderValue::from_static("text/html"), + ); + + let message = ClientJsonRpcMessage::request( + ClientRequest::PingRequest(PingRequest::default()), + RequestId::Number(1), + ); + + let result = client + .post_message( + Arc::from("http://localhost:9999/mcp"), + message, + None, + None, + custom_headers, + ) + .await; + + assert!(result.is_err(), "Should reject 'accept' header"); + match result { + Err(StreamableHttpError::ReservedHeaderConflict(header_name)) => { + assert_eq!( + header_name, "accept", + "Error should indicate 'accept' header" + ); + } + other => panic!("Expected ReservedHeaderConflict error, got: {:?}", other), + } +} + +/// Unit test: post_message should reject reserved header "mcp-session-id" +#[tokio::test] +#[cfg(feature = "transport-streamable-http-client-reqwest")] +async fn test_post_message_rejects_mcp_session_id() { + use std::sync::Arc; + + use rmcp::{ + model::{ClientJsonRpcMessage, ClientRequest, PingRequest, RequestId}, + transport::streamable_http_client::{StreamableHttpClient, StreamableHttpError}, + }; + + let client = reqwest::Client::new(); + let mut custom_headers = HashMap::new(); + custom_headers.insert( + HeaderName::from_static("mcp-session-id"), + HeaderValue::from_static("my-session"), + ); + + let message = ClientJsonRpcMessage::request( + ClientRequest::PingRequest(PingRequest::default()), + RequestId::Number(1), + ); + + let result = client + .post_message( + Arc::from("http://localhost:9999/mcp"), + message, + None, + None, + custom_headers, + ) + .await; + + assert!(result.is_err(), "Should reject 'mcp-session-id' header"); + match result { + Err(StreamableHttpError::ReservedHeaderConflict(header_name)) => { + assert_eq!( + header_name, "mcp-session-id", + "Error should indicate 'mcp-session-id' header" + ); + } + other => panic!("Expected ReservedHeaderConflict error, got: {:?}", other), + } +} + +/// Unit test: post_message should allow the mcp-protocol-version header through +/// (it is injected by the worker after initialization, not a user-settable custom header) +#[tokio::test] +#[cfg(feature = "transport-streamable-http-client-reqwest")] +async fn test_post_message_allows_mcp_protocol_version() { + use std::sync::Arc; + + use rmcp::{ + model::{ClientJsonRpcMessage, ClientRequest, PingRequest, RequestId}, + transport::streamable_http_client::StreamableHttpClient, + }; + + let client = reqwest::Client::new(); + let mut custom_headers = HashMap::new(); + custom_headers.insert( + HeaderName::from_static("mcp-protocol-version"), + HeaderValue::from_static("2025-03-26"), + ); + + let message = ClientJsonRpcMessage::request( + ClientRequest::PingRequest(PingRequest::default()), + RequestId::Number(1), + ); + + let result = client + .post_message( + Arc::from("http://localhost:9999/mcp"), + message, + None, + None, + custom_headers, + ) + .await; + + // The header should be allowed through (not rejected as reserved). + // The error should be a connection error (no server at localhost:9999), + // not a ReservedHeaderConflict. + assert!(result.is_err(), "Should fail due to connection error"); + assert!( + !matches!( + &result, + Err(rmcp::transport::streamable_http_client::StreamableHttpError::ReservedHeaderConflict( + _ + )) + ), + "MCP-Protocol-Version should not be rejected as reserved, got: {:?}", + result + ); +} + +/// Unit test: post_message should reject reserved header "last-event-id" +#[tokio::test] +#[cfg(feature = "transport-streamable-http-client-reqwest")] +async fn test_post_message_rejects_last_event_id() { + use std::sync::Arc; + + use rmcp::{ + model::{ClientJsonRpcMessage, ClientRequest, PingRequest, RequestId}, + transport::streamable_http_client::{StreamableHttpClient, StreamableHttpError}, + }; + + let client = reqwest::Client::new(); + let mut custom_headers = HashMap::new(); + custom_headers.insert( + HeaderName::from_static("last-event-id"), + HeaderValue::from_static("event-123"), + ); + + let message = ClientJsonRpcMessage::request( + ClientRequest::PingRequest(PingRequest::default()), + RequestId::Number(1), + ); + + let result = client + .post_message( + Arc::from("http://localhost:9999/mcp"), + message, + None, + None, + custom_headers, + ) + .await; + + assert!(result.is_err(), "Should reject 'last-event-id' header"); + match result { + Err(StreamableHttpError::ReservedHeaderConflict(header_name)) => { + assert_eq!( + header_name, "last-event-id", + "Error should indicate 'last-event-id' header" + ); + } + other => panic!("Expected ReservedHeaderConflict error, got: {:?}", other), + } +} + +/// Unit test: post_message should do case-insensitive matching for reserved headers +#[tokio::test] +#[cfg(feature = "transport-streamable-http-client-reqwest")] +async fn test_post_message_case_insensitive_matching() { + use std::sync::Arc; + + use rmcp::{ + model::{ClientJsonRpcMessage, ClientRequest, PingRequest, RequestId}, + transport::streamable_http_client::{StreamableHttpClient, StreamableHttpError}, + }; + + let client = reqwest::Client::new(); + let message = ClientJsonRpcMessage::request( + ClientRequest::PingRequest(PingRequest::default()), + RequestId::Number(1), + ); + + // Test different casings + let test_cases = vec![ + ("Accept", "Should reject 'Accept' (capitalized)"), + ("ACCEPT", "Should reject 'ACCEPT' (uppercase)"), + ("Mcp-Session-Id", "Should reject 'Mcp-Session-Id'"), + ("MCP-SESSION-ID", "Should reject 'MCP-SESSION-ID'"), + ]; + + for (header_name, error_msg) in test_cases { + let mut custom_headers = HashMap::new(); + custom_headers.insert( + HeaderName::from_bytes(header_name.as_bytes()).unwrap(), + HeaderValue::from_static("value"), + ); + + let result = client + .post_message( + Arc::from("http://localhost:9999/mcp"), + message.clone(), + None, + None, + custom_headers, + ) + .await; + + assert!(result.is_err(), "{}", error_msg); + if let Err(StreamableHttpError::ReservedHeaderConflict(_)) = result { + // Success + } else { + panic!( + "{}: Expected ReservedHeaderConflict, got: {:?}", + error_msg, result + ); + } + } +} + +/// Integration test: Verify that custom headers are actually sent in MCP HTTP requests +#[tokio::test] +#[cfg(all( + feature = "transport-streamable-http-client", + feature = "transport-streamable-http-client-reqwest" +))] +async fn test_mcp_custom_headers_sent_to_server() -> anyhow::Result<()> { + use std::{net::SocketAddr, sync::Arc}; + + use axum::{ + Router, body::Bytes, extract::State, http::StatusCode, response::IntoResponse, + routing::post, + }; + use rmcp::{ + ServiceExt, + transport::{ + StreamableHttpClientTransport, + streamable_http_client::StreamableHttpClientTransportConfig, + }, + }; + use serde_json::json; + use tokio::sync::Mutex; + + // State to capture received headers + #[derive(Clone)] + struct ServerState { + received_headers: Arc>>, + initialize_called: Arc, + } + + // Handler that captures headers from MCP requests + async fn mcp_handler( + State(state): State, + headers: http::HeaderMap, + body: Bytes, + ) -> impl IntoResponse { + // Capture all custom headers (starting with x-) + let mut headers_map = HashMap::new(); + for (name, value) in headers.iter() { + let name_str = name.as_str(); + if name_str.starts_with("x-") + && let Ok(v) = value.to_str() + { + headers_map.insert(name_str.to_string(), v.to_string()); + } + } + + // Store captured headers + let mut stored = state.received_headers.lock().await; + stored.extend(headers_map); + + // Parse the MCP request + if let Ok(json_body) = serde_json::from_slice::(&body) + && let Some(method) = json_body.get("method").and_then(|m| m.as_str()) + { + if method == "initialize" { + state.initialize_called.notify_one(); + // Return a valid MCP initialize response with session header + let response = json!({ + "jsonrpc": "2.0", + "id": json_body.get("id"), + "result": { + "protocolVersion": "2024-11-05", + "capabilities": {}, + "serverInfo": { + "name": "test-server", + "version": "1.0.0" + } + } + }); + return ( + StatusCode::OK, + [ + (http::header::CONTENT_TYPE, "application/json"), + ( + http::HeaderName::from_static("mcp-session-id"), + "test-session-123", + ), + ], + response.to_string(), + ); + } else if method == "notifications/initialized" { + // For initialized notification, return 202 Accepted + return ( + StatusCode::ACCEPTED, + [ + (http::header::CONTENT_TYPE, "application/json"), + ( + http::HeaderName::from_static("mcp-session-id"), + "test-session-123", + ), + ], + String::new(), + ); + } + } + + // Default response for other requests + let response = json!({ + "jsonrpc": "2.0", + "id": 1, + "result": {} + }); + ( + StatusCode::OK, + [ + (http::header::CONTENT_TYPE, "application/json"), + ( + http::HeaderName::from_static("mcp-session-id"), + "test-session-123", + ), + ], + response.to_string(), + ) + } + + // Setup test server + let state = ServerState { + received_headers: Arc::new(Mutex::new(HashMap::new())), + initialize_called: Arc::new(tokio::sync::Notify::new()), + }; + + let app = Router::new() + .route("/mcp", post(mcp_handler)) + .with_state(state.clone()); + + let addr = SocketAddr::from(([127, 0, 0, 1], 0)); + let listener = tokio::net::TcpListener::bind(addr).await?; + let port = listener.local_addr()?.port(); + + let server_handle = tokio::spawn(async move { axum::serve(listener, app).await }); + + // Wait for server to be ready + tokio::time::sleep(std::time::Duration::from_millis(100)).await; + + // Create MCP client with custom headers + let mut custom_headers = HashMap::new(); + custom_headers.insert( + HeaderName::from_static("x-test-header"), + HeaderValue::from_static("test-value-123"), + ); + custom_headers.insert( + HeaderName::from_static("x-another-header"), + HeaderValue::from_static("another-value-456"), + ); + custom_headers.insert( + HeaderName::from_static("x-client-id"), + HeaderValue::from_static("test-client"), + ); + + let config = + StreamableHttpClientTransportConfig::with_uri(format!("http://127.0.0.1:{}/mcp", port)) + .custom_headers(custom_headers); + + let transport = StreamableHttpClientTransport::from_config(config); + + // Start MCP client with empty handler (this will trigger initialize request) + let client = ().serve(transport).await.expect("Failed to start client"); + + // Wait for initialize to be called + tokio::time::timeout( + std::time::Duration::from_secs(5), + state.initialize_called.notified(), + ) + .await + .expect("Initialize request should be received"); + + // Verify that custom headers were received + let headers = state.received_headers.lock().await; + + assert_eq!( + headers.get("x-test-header"), + Some(&"test-value-123".to_string()), + "Custom header x-test-header should be sent to MCP server" + ); + assert_eq!( + headers.get("x-another-header"), + Some(&"another-value-456".to_string()), + "Custom header x-another-header should be sent to MCP server" + ); + assert_eq!( + headers.get("x-client-id"), + Some(&"test-client".to_string()), + "Custom header x-client-id should be sent to MCP server" + ); + + // Cleanup + drop(client); + server_handle.abort(); + + Ok(()) +} + +/// Integration test: Verify that MCP-Protocol-Version header is sent on post-init requests +#[tokio::test] +#[cfg(all( + feature = "transport-streamable-http-client", + feature = "transport-streamable-http-client-reqwest" +))] +async fn test_mcp_protocol_version_header_sent_after_init() -> anyhow::Result<()> { + use std::{net::SocketAddr, sync::Arc}; + + use axum::{ + Router, body::Bytes, extract::State, http::StatusCode, response::IntoResponse, + routing::post, + }; + use rmcp::{ + ServiceExt, + transport::{ + StreamableHttpClientTransport, + streamable_http_client::StreamableHttpClientTransportConfig, + }, + }; + use serde_json::json; + use tokio::sync::Mutex; + + type CapturedRequests = Vec<(String, Option)>; + + #[derive(Clone)] + struct ServerState { + /// Captures the MCP-Protocol-Version header value for each request method + protocol_version_by_method: Arc>, + initialized_called: Arc, + } + + async fn mcp_handler( + State(state): State, + headers: http::HeaderMap, + body: Bytes, + ) -> impl IntoResponse { + let protocol_version = headers + .get("mcp-protocol-version") + .and_then(|v| v.to_str().ok()) + .map(|s| s.to_string()); + + if let Ok(json_body) = serde_json::from_slice::(&body) { + let method = json_body + .get("method") + .and_then(|m| m.as_str()) + .unwrap_or("unknown") + .to_string(); + + state + .protocol_version_by_method + .lock() + .await + .push((method.clone(), protocol_version)); + + if method == "initialize" { + let response = json!({ + "jsonrpc": "2.0", + "id": json_body.get("id"), + "result": { + "protocolVersion": "2025-03-26", + "capabilities": {}, + "serverInfo": { + "name": "test-server", + "version": "1.0.0" + } + } + }); + return ( + StatusCode::OK, + [ + (http::header::CONTENT_TYPE, "application/json"), + ( + http::HeaderName::from_static("mcp-session-id"), + "test-session-456", + ), + ], + response.to_string(), + ); + } else if method == "notifications/initialized" { + state.initialized_called.notify_one(); + return ( + StatusCode::ACCEPTED, + [ + (http::header::CONTENT_TYPE, "application/json"), + ( + http::HeaderName::from_static("mcp-session-id"), + "test-session-456", + ), + ], + String::new(), + ); + } + } + + let response = json!({ + "jsonrpc": "2.0", + "id": 1, + "result": {} + }); + ( + StatusCode::OK, + [ + (http::header::CONTENT_TYPE, "application/json"), + ( + http::HeaderName::from_static("mcp-session-id"), + "test-session-456", + ), + ], + response.to_string(), + ) + } + + let state = ServerState { + protocol_version_by_method: Arc::new(Mutex::new(Vec::new())), + initialized_called: Arc::new(tokio::sync::Notify::new()), + }; + + let app = Router::new() + .route("/mcp", post(mcp_handler)) + .with_state(state.clone()); + + let addr = SocketAddr::from(([127, 0, 0, 1], 0)); + let listener = tokio::net::TcpListener::bind(addr).await?; + let port = listener.local_addr()?.port(); + + let server_handle = tokio::spawn(async move { axum::serve(listener, app).await }); + tokio::time::sleep(std::time::Duration::from_millis(100)).await; + + let config = + StreamableHttpClientTransportConfig::with_uri(format!("http://127.0.0.1:{}/mcp", port)); + + let transport = StreamableHttpClientTransport::from_config(config); + let client = ().serve(transport).await.expect("Failed to start client"); + + tokio::time::timeout( + std::time::Duration::from_secs(5), + state.initialized_called.notified(), + ) + .await + .expect("Initialized notification should be received"); + + // Give time for the initialized notification to be fully processed + tokio::time::sleep(std::time::Duration::from_millis(100)).await; + + let captured = state.protocol_version_by_method.lock().await; + + // The initialize request should NOT have MCP-Protocol-Version + // (the version isn't known yet) + let init_entry = captured + .iter() + .find(|(m, _)| m == "initialize") + .expect("Should have captured initialize request"); + assert_eq!( + init_entry.1, None, + "Initialize request should not have MCP-Protocol-Version header" + ); + + // The initialized notification should HAVE MCP-Protocol-Version + let initialized_entry = captured + .iter() + .find(|(m, _)| m == "notifications/initialized") + .expect("Should have captured initialized notification"); + assert_eq!( + initialized_entry.1, + Some("2025-03-26".to_string()), + "Initialized notification should include MCP-Protocol-Version: 2025-03-26" + ); + + drop(client); + server_handle.abort(); + + Ok(()) +} + +/// Integration test: Verify server rejects unsupported MCP-Protocol-Version with 400 +#[tokio::test] +#[cfg(all(feature = "transport-streamable-http-server", feature = "server",))] +async fn test_server_rejects_unsupported_protocol_version() { + use std::sync::Arc; + + use bytes::Bytes; + use http::{Method, Request, header::CONTENT_TYPE}; + use http_body_util::Full; + use rmcp::{ + handler::server::ServerHandler, + model::{ServerCapabilities, ServerConfig}, + transport::streamable_http_server::{ + StreamableHttpServerConfig, StreamableHttpService, session::local::LocalSessionManager, + }, + }; + use serde_json::json; + + #[derive(Clone)] + struct TestHandler; + + impl ServerHandler for TestHandler { + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::builder().build()) + } + } + + let session_manager = Arc::new(LocalSessionManager::default()); + let service = StreamableHttpService::new( + || Ok(TestHandler), + session_manager, + StreamableHttpServerConfig::default(), + ); + + // First, send an initialize request to create a session + let init_body = json!({ + "jsonrpc": "2.0", + "id": 1, + "method": "initialize", + "params": { + "protocolVersion": "2025-03-26", + "capabilities": {}, + "clientInfo": { + "name": "test-client", + "version": "1.0.0" + } + } + }); + + let init_request = Request::builder() + .method(Method::POST) + .header("Accept", "application/json, text/event-stream") + .header(CONTENT_TYPE, "application/json") + .header("Host", "localhost:8080") + .body(Full::new(Bytes::from(init_body.to_string()))) + .unwrap(); + + let response = service.handle(init_request).await; + assert_eq!(response.status(), http::StatusCode::OK); + + // Extract session id from response + let session_id = response + .headers() + .get("mcp-session-id") + .expect("Should have session id") + .to_str() + .unwrap() + .to_string(); + + // Send initialized notification to complete handshake + let initialized_body = json!({ + "jsonrpc": "2.0", + "method": "notifications/initialized" + }); + let initialized_request = Request::builder() + .method(Method::POST) + .header("Accept", "application/json, text/event-stream") + .header(CONTENT_TYPE, "application/json") + .header("Host", "localhost:8080") + .header("mcp-session-id", &session_id) + .header("mcp-protocol-version", "2025-03-26") + .body(Full::new(Bytes::from(initialized_body.to_string()))) + .unwrap(); + + let response = service.handle(initialized_request).await; + assert_eq!(response.status(), http::StatusCode::ACCEPTED); + + // Test 1: Valid protocol version should succeed + let valid_body = json!({ + "jsonrpc": "2.0", + "method": "notifications/initialized" + }); + let valid_request = Request::builder() + .method(Method::POST) + .header("Accept", "application/json, text/event-stream") + .header(CONTENT_TYPE, "application/json") + .header("Host", "localhost:8080") + .header("mcp-session-id", &session_id) + .header("mcp-protocol-version", "2025-03-26") + .body(Full::new(Bytes::from(valid_body.to_string()))) + .unwrap(); + + let response = service.handle(valid_request).await; + assert_eq!( + response.status(), + http::StatusCode::ACCEPTED, + "Valid MCP-Protocol-Version should be accepted" + ); + + // Test 2: Unsupported protocol version should return 400 + let invalid_body = json!({ + "jsonrpc": "2.0", + "method": "notifications/initialized" + }); + let invalid_request = Request::builder() + .method(Method::POST) + .header("Accept", "application/json, text/event-stream") + .header(CONTENT_TYPE, "application/json") + .header("Host", "localhost:8080") + .header("mcp-session-id", &session_id) + .header("mcp-protocol-version", "9999-01-01") + .body(Full::new(Bytes::from(invalid_body.to_string()))) + .unwrap(); + + let response = service.handle(invalid_request).await; + assert_eq!( + response.status(), + http::StatusCode::BAD_REQUEST, + "Unsupported MCP-Protocol-Version should return 400" + ); + + // Test 3: Missing protocol version should succeed (backwards compat) + let no_version_body = json!({ + "jsonrpc": "2.0", + "method": "notifications/initialized" + }); + let no_version_request = Request::builder() + .method(Method::POST) + .header("Accept", "application/json, text/event-stream") + .header(CONTENT_TYPE, "application/json") + .header("Host", "localhost:8080") + .header("mcp-session-id", &session_id) + .body(Full::new(Bytes::from(no_version_body.to_string()))) + .unwrap(); + + let response = service.handle(no_version_request).await; + assert_eq!( + response.status(), + http::StatusCode::ACCEPTED, + "Missing MCP-Protocol-Version should be accepted (backwards compat)" + ); +} + +/// Unit test: ProtocolVersion::as_str and KNOWN_VERSIONS +#[test] +fn test_protocol_version_utilities() { + use rmcp::model::ProtocolVersion; + + assert_eq!(ProtocolVersion::V_2026_07_28.as_str(), "2026-07-28"); + assert_eq!(ProtocolVersion::V_2025_11_25.as_str(), "2025-11-25"); + assert_eq!(ProtocolVersion::V_2025_06_18.as_str(), "2025-06-18"); + assert_eq!(ProtocolVersion::V_2025_03_26.as_str(), "2025-03-26"); + assert_eq!(ProtocolVersion::V_2024_11_05.as_str(), "2024-11-05"); + + assert_eq!(ProtocolVersion::KNOWN_VERSIONS.len(), 5); + assert!(ProtocolVersion::KNOWN_VERSIONS.contains(&ProtocolVersion::V_2024_11_05)); + assert!(ProtocolVersion::KNOWN_VERSIONS.contains(&ProtocolVersion::V_2025_03_26)); + assert!(ProtocolVersion::KNOWN_VERSIONS.contains(&ProtocolVersion::V_2025_06_18)); + assert!(ProtocolVersion::KNOWN_VERSIONS.contains(&ProtocolVersion::V_2025_11_25)); + assert!(ProtocolVersion::KNOWN_VERSIONS.contains(&ProtocolVersion::V_2026_07_28)); +} + +/// Integration test: Verify Host validation remains enabled when Origin validation is +/// disabled by default +#[tokio::test] +#[cfg(all(feature = "transport-streamable-http-server", feature = "server",))] +async fn test_server_validates_host_when_origin_validation_is_disabled_by_default() { + use std::sync::Arc; + + use bytes::Bytes; + use http::{Method, Request, header::CONTENT_TYPE}; + use http_body_util::Full; + use rmcp::{ + handler::server::ServerHandler, + model::{ServerCapabilities, ServerConfig}, + transport::streamable_http_server::{ + StreamableHttpServerConfig, StreamableHttpService, session::local::LocalSessionManager, + }, + }; + use serde_json::json; + + #[derive(Clone)] + struct TestHandler; + + impl ServerHandler for TestHandler { + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::builder().build()) + } + } + + let service = StreamableHttpService::new( + || Ok(TestHandler), + Arc::new(LocalSessionManager::default()), + StreamableHttpServerConfig::default(), + ); + + let init_body = json!({ + "jsonrpc": "2.0", + "id": 1, + "method": "initialize", + "params": { + "protocolVersion": "2025-03-26", + "capabilities": {}, + "clientInfo": { + "name": "test-client", + "version": "1.0.0" + } + } + }); + + let allowed_request = Request::builder() + .method(Method::POST) + .header("Accept", "application/json, text/event-stream") + .header(CONTENT_TYPE, "application/json") + .header("Host", "localhost:8080") + .header("Origin", "http://localhost:8080") + .body(Full::new(Bytes::from(init_body.to_string()))) + .unwrap(); + + let response = service.handle(allowed_request).await; + assert_eq!(response.status(), http::StatusCode::OK); + + let bad_host_request = Request::builder() + .method(Method::POST) + .header("Accept", "application/json, text/event-stream") + .header(CONTENT_TYPE, "application/json") + .header("Host", "attacker.example") + .body(Full::new(Bytes::from(init_body.to_string()))) + .unwrap(); + + let response = service.handle(bad_host_request).await; + assert_eq!(response.status(), http::StatusCode::FORBIDDEN); + + let ignored_origin_request = Request::builder() + .method(Method::POST) + .header("Accept", "application/json, text/event-stream") + .header(CONTENT_TYPE, "application/json") + .header("Host", "localhost:8080") + .header("Origin", "http://attacker.example") + .body(Full::new(Bytes::from(init_body.to_string()))) + .unwrap(); + + let response = service.handle(ignored_origin_request).await; + assert_eq!(response.status(), http::StatusCode::OK); +} + +/// Integration test: Verify server can enforce an allowed Host port when configured +#[tokio::test] +#[cfg(all(feature = "transport-streamable-http-server", feature = "server",))] +async fn test_server_validates_host_header_port_for_dns_rebinding_protection() { + use std::sync::Arc; + + use bytes::Bytes; + use http::{Method, Request, header::CONTENT_TYPE}; + use http_body_util::Full; + use rmcp::{ + handler::server::ServerHandler, + model::{ServerCapabilities, ServerConfig}, + transport::streamable_http_server::{ + StreamableHttpServerConfig, StreamableHttpService, session::local::LocalSessionManager, + }, + }; + use serde_json::json; + + #[derive(Clone)] + struct TestHandler; + + impl ServerHandler for TestHandler { + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::builder().build()) + } + } + + let service = StreamableHttpService::new( + || Ok(TestHandler), + Arc::new(LocalSessionManager::default()), + StreamableHttpServerConfig::default().with_allowed_hosts(["localhost:8080"]), + ); + + let init_body = json!({ + "jsonrpc": "2.0", + "id": 1, + "method": "initialize", + "params": { + "protocolVersion": "2025-03-26", + "capabilities": {}, + "clientInfo": { + "name": "test-client", + "version": "1.0.0" + } + } + }); + + let allowed_request = Request::builder() + .method(Method::POST) + .header("Accept", "application/json, text/event-stream") + .header(CONTENT_TYPE, "application/json") + .header("Host", "localhost:8080") + .body(Full::new(Bytes::from(init_body.to_string()))) + .unwrap(); + + let response = service.handle(allowed_request).await; + assert_eq!(response.status(), http::StatusCode::OK); + + let wrong_port_request = Request::builder() + .method(Method::POST) + .header("Accept", "application/json, text/event-stream") + .header(CONTENT_TYPE, "application/json") + .header("Host", "localhost:3000") + .body(Full::new(Bytes::from(init_body.to_string()))) + .unwrap(); + + let response = service.handle(wrong_port_request).await; + assert_eq!(response.status(), http::StatusCode::FORBIDDEN); +} + +/// Integration test: Verify the validator falls back to the URI authority when +/// the Host header is absent (HTTP/2 :authority pseudo-header scenario). +#[tokio::test] +#[cfg(all(feature = "transport-streamable-http-server", feature = "server",))] +async fn test_server_falls_back_to_uri_authority_when_host_header_missing() { + use std::sync::Arc; + + use bytes::Bytes; + use http::{Method, Request, header::CONTENT_TYPE}; + use http_body_util::Full; + use rmcp::{ + handler::server::ServerHandler, + model::{ServerCapabilities, ServerConfig}, + transport::streamable_http_server::{ + StreamableHttpServerConfig, StreamableHttpService, session::local::LocalSessionManager, + }, + }; + use serde_json::json; + + #[derive(Clone)] + struct TestHandler; + + impl ServerHandler for TestHandler { + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::builder().build()) + } + } + + let service = StreamableHttpService::new( + || Ok(TestHandler), + Arc::new(LocalSessionManager::default()), + StreamableHttpServerConfig::default(), + ); + + let init_body = json!({ + "jsonrpc": "2.0", + "id": 1, + "method": "initialize", + "params": { + "protocolVersion": "2025-03-26", + "capabilities": {}, + "clientInfo": { + "name": "test-client", + "version": "1.0.0" + } + } + }); + + // Allowed authority via URI only — no Host header. + let allowed_request = Request::builder() + .method(Method::POST) + .uri("http://localhost:8080/") + .header("Accept", "application/json, text/event-stream") + .header(CONTENT_TYPE, "application/json") + .body(Full::new(Bytes::from(init_body.to_string()))) + .unwrap(); + assert!(allowed_request.headers().get("Host").is_none()); + + let response = service.handle(allowed_request).await; + assert_eq!(response.status(), http::StatusCode::OK); + + // Disallowed authority via URI only — no Host header. + let bad_request = Request::builder() + .method(Method::POST) + .uri("http://attacker.example/") + .header("Accept", "application/json, text/event-stream") + .header(CONTENT_TYPE, "application/json") + .body(Full::new(Bytes::from(init_body.to_string()))) + .unwrap(); + assert!(bad_request.headers().get("Host").is_none()); + + let response = service.handle(bad_request).await; + assert_eq!(response.status(), http::StatusCode::FORBIDDEN); + + // Neither Host header nor URI authority — still a 400. + let missing_request = Request::builder() + .method(Method::POST) + .uri("/") + .header("Accept", "application/json, text/event-stream") + .header(CONTENT_TYPE, "application/json") + .body(Full::new(Bytes::from(init_body.to_string()))) + .unwrap(); + assert!(missing_request.headers().get("Host").is_none()); + assert!(missing_request.uri().authority().is_none()); + + let response = service.handle(missing_request).await; + assert_eq!(response.status(), http::StatusCode::BAD_REQUEST); +} + +#[cfg(all(feature = "transport-streamable-http-server", feature = "server"))] +mod origin_validation { + use std::sync::Arc; + + use bytes::Bytes; + use http::{HeaderValue, Method, Request, header::CONTENT_TYPE}; + use http_body_util::Full; + use rmcp::{ + handler::server::ServerHandler, + model::{ServerCapabilities, ServerConfig}, + transport::streamable_http_server::{ + StreamableHttpServerConfig, StreamableHttpService, session::local::LocalSessionManager, + }, + }; + use serde_json::json; + + #[derive(Clone)] + struct TestHandler; + + impl ServerHandler for TestHandler { + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::builder().build()) + } + } + + fn service_with_config( + config: StreamableHttpServerConfig, + ) -> StreamableHttpService { + StreamableHttpService::new( + || Ok(TestHandler), + Arc::new(LocalSessionManager::default()), + config, + ) + } + + fn service_with_allowed_origins( + origins: &[&str], + ) -> StreamableHttpService { + service_with_config( + StreamableHttpServerConfig::default().with_allowed_origins(origins.iter().copied()), + ) + } + + fn init_request(origin: Option<&str>) -> Request> { + let init_body = json!({ + "jsonrpc": "2.0", + "id": 1, + "method": "initialize", + "params": { + "protocolVersion": "2025-03-26", + "capabilities": {}, + "clientInfo": {"name": "test-client", "version": "1.0.0"} + } + }); + let mut builder = Request::builder() + .method(Method::POST) + .header("Accept", "application/json, text/event-stream") + .header(CONTENT_TYPE, "application/json") + .header("Host", "localhost:8080"); + if let Some(origin) = origin { + builder = builder.header("Origin", origin); + } + builder + .body(Full::new(Bytes::from(init_body.to_string()))) + .unwrap() + } + + #[tokio::test] + async fn allowlisted_origin_is_allowed() { + let service = service_with_allowed_origins(&["http://localhost:8080"]); + let response = service + .handle(init_request(Some("http://localhost:8080"))) + .await; + assert_eq!(response.status(), http::StatusCode::OK); + } + + #[tokio::test] + async fn non_allowlisted_origin_is_forbidden() { + let service = service_with_allowed_origins(&["http://localhost:8080"]); + let response = service + .handle(init_request(Some("http://attacker.example"))) + .await; + assert_eq!(response.status(), http::StatusCode::FORBIDDEN); + } + + #[tokio::test] + async fn malformed_origin_is_forbidden() { + let service = service_with_allowed_origins(&["http://localhost:8080"]); + let response = service.handle(init_request(Some("not-an-origin"))).await; + assert_eq!(response.status(), http::StatusCode::FORBIDDEN); + } + + #[tokio::test] + async fn non_utf8_origin_is_forbidden() { + let service = service_with_allowed_origins(&["http://localhost:8080"]); + let mut request = init_request(None); + request.headers_mut().insert( + http::header::ORIGIN, + HeaderValue::from_bytes(b"\xff").unwrap(), + ); + let response = service.handle(request).await; + assert_eq!(response.status(), http::StatusCode::FORBIDDEN); + } + + #[tokio::test] + async fn enabled_empty_allowlist_forbids_present_origin() { + let service = + service_with_config(StreamableHttpServerConfig::default().enforce_origin_validation()); + let response = service + .handle(init_request(Some("http://localhost:8080"))) + .await; + assert_eq!(response.status(), http::StatusCode::FORBIDDEN); + } + + #[tokio::test] + async fn enabled_empty_allowlist_allows_missing_origin() { + let service = + service_with_config(StreamableHttpServerConfig::default().enforce_origin_validation()); + let response = service.handle(init_request(None)).await; + assert_eq!(response.status(), http::StatusCode::OK); + } + + #[tokio::test] + async fn empty_allowed_origins_preserves_disabled_validation() { + let service = service_with_config( + StreamableHttpServerConfig::default().with_allowed_origins(std::iter::empty::<&str>()), + ); + let response = service + .handle(init_request(Some("http://attacker.example"))) + .await; + assert_eq!(response.status(), http::StatusCode::OK); + } + + #[tokio::test] + async fn nonempty_public_allowed_origins_field_enables_validation() { + let mut config = StreamableHttpServerConfig::default(); + config + .allowed_origins + .push("http://localhost:8080".to_string()); + let service = service_with_config(config); + let response = service + .handle(init_request(Some("http://attacker.example"))) + .await; + assert_eq!(response.status(), http::StatusCode::FORBIDDEN); + } + + #[tokio::test] + async fn explicitly_disabled_validation_allows_present_origin() { + let service = service_with_config( + StreamableHttpServerConfig::default() + .enforce_origin_validation() + .disable_allowed_origins(), + ); + let response = service + .handle(init_request(Some("http://attacker.example"))) + .await; + assert_eq!(response.status(), http::StatusCode::OK); + } + + #[tokio::test] + async fn missing_origin_passes_through() { + let service = service_with_allowed_origins(&["http://localhost:8080"]); + let response = service.handle(init_request(None)).await; + assert_eq!(response.status(), http::StatusCode::OK); + } + + #[tokio::test] + async fn scheme_mismatch_is_forbidden() { + let service = service_with_allowed_origins(&["http://localhost:8080"]); + let response = service + .handle(init_request(Some("https://localhost:8080"))) + .await; + assert_eq!(response.status(), http::StatusCode::FORBIDDEN); + } + + #[tokio::test] + async fn null_origin_is_allowed_when_allowlisted() { + let service = service_with_allowed_origins(&["null"]); + let response = service.handle(init_request(Some("null"))).await; + assert_eq!(response.status(), http::StatusCode::OK); + } + + #[tokio::test] + async fn null_origin_is_forbidden_when_not_allowlisted() { + let service = service_with_allowed_origins(&["http://localhost:8080"]); + let response = service.handle(init_request(Some("null"))).await; + assert_eq!(response.status(), http::StatusCode::FORBIDDEN); + } + + #[tokio::test] + async fn explicit_https_default_port_allows_port_less_origin() { + let service = service_with_allowed_origins(&["https://client.example:443"]); + let response = service + .handle(init_request(Some("https://client.example"))) + .await; + assert_eq!(response.status(), http::StatusCode::OK); + } + + #[tokio::test] + async fn explicit_http_default_port_allows_port_less_origin() { + let service = service_with_allowed_origins(&["http://client.example:80"]); + let response = service + .handle(init_request(Some("http://client.example"))) + .await; + assert_eq!(response.status(), http::StatusCode::OK); + } + + #[tokio::test] + async fn explicit_default_port_allows_matching_explicit_origin_port() { + let service = service_with_allowed_origins(&["https://client.example:443"]); + let response = service + .handle(init_request(Some("https://client.example:443"))) + .await; + assert_eq!(response.status(), http::StatusCode::OK); + } + + #[tokio::test] + async fn explicit_default_port_forbids_non_default_origin_port() { + let service = service_with_allowed_origins(&["https://client.example:443"]); + let response = service + .handle(init_request(Some("https://client.example:8443"))) + .await; + assert_eq!(response.status(), http::StatusCode::FORBIDDEN); + } + + #[tokio::test] + async fn explicit_non_default_port_forbids_port_less_origin() { + let service = service_with_allowed_origins(&["https://client.example:8443"]); + let response = service + .handle(init_request(Some("https://client.example"))) + .await; + assert_eq!(response.status(), http::StatusCode::FORBIDDEN); + } + + #[tokio::test] + async fn omitted_configured_port_allows_any_origin_port() { + let service = service_with_allowed_origins(&["https://client.example"]); + let response = service + .handle(init_request(Some("https://client.example:8443"))) + .await; + assert_eq!(response.status(), http::StatusCode::OK); + } + + #[tokio::test] + async fn wildcard_port_allows_non_default_origin_port() { + let service = service_with_allowed_origins(&["https://client.example:*"]); + let response = service + .handle(init_request(Some("https://client.example:8443"))) + .await; + assert_eq!(response.status(), http::StatusCode::OK); + } + + #[tokio::test] + async fn wildcard_port_allows_port_less_origin() { + let service = service_with_allowed_origins(&["https://client.example:*"]); + let response = service + .handle(init_request(Some("https://client.example"))) + .await; + assert_eq!(response.status(), http::StatusCode::OK); + } + + #[tokio::test] + async fn wildcard_port_forbids_other_host() { + let service = service_with_allowed_origins(&["https://client.example:*"]); + let response = service + .handle(init_request(Some("https://attacker.example:8443"))) + .await; + assert_eq!(response.status(), http::StatusCode::FORBIDDEN); + } + + #[tokio::test] + async fn wildcard_port_forbids_scheme_mismatch() { + let service = service_with_allowed_origins(&["https://client.example:*"]); + let response = service + .handle(init_request(Some("http://client.example:8443"))) + .await; + assert_eq!(response.status(), http::StatusCode::FORBIDDEN); + } +} diff --git a/vendor/rmcp/tests/test_custom_request.rs b/vendor/rmcp/tests/test_custom_request.rs new file mode 100644 index 00000000..66ee1ff9 --- /dev/null +++ b/vendor/rmcp/tests/test_custom_request.rs @@ -0,0 +1,190 @@ +#![cfg(not(feature = "local"))] +use std::sync::Arc; + +use rmcp::{ + ClientHandler, ServerHandler, ServiceExt, + model::{ + ClientRequest, ClientResult, CustomRequest, CustomResult, ServerRequest, ServerResult, + }, +}; +use serde_json::json; +use tokio::sync::{Mutex, Notify}; +use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt}; + +type CustomRequestPayload = (String, Option); + +struct CustomRequestServer { + receive_signal: Arc, + payload: Arc>>, +} + +impl ServerHandler for CustomRequestServer { + async fn on_custom_request( + &self, + request: CustomRequest, + _context: rmcp::service::RequestContext, + ) -> Result { + let CustomRequest { method, params, .. } = request; + *self.payload.lock().await = Some((method, params)); + self.receive_signal.notify_one(); + Ok(CustomResult::new(json!({ "status": "ok" }))) + } +} + +#[tokio::test] +async fn test_custom_client_request_reaches_server() -> anyhow::Result<()> { + let _ = tracing_subscriber::registry() + .with( + tracing_subscriber::EnvFilter::try_from_default_env() + .unwrap_or_else(|_| "debug".to_string().into()), + ) + .with(tracing_subscriber::fmt::layer()) + .try_init(); + + let (server_transport, client_transport) = tokio::io::duplex(4096); + let receive_signal = Arc::new(Notify::new()); + let payload = Arc::new(Mutex::new(None)); + + { + let receive_signal = receive_signal.clone(); + let payload = payload.clone(); + tokio::spawn(async move { + let server = CustomRequestServer { + receive_signal, + payload, + } + .serve(server_transport) + .await?; + server.waiting().await?; + anyhow::Ok(()) + }); + } + + let client = ().serve(client_transport).await?; + + let response = client + .send_request(ClientRequest::CustomRequest(CustomRequest::new( + "requests/custom-test", + Some(json!({ "foo": "bar" })), + ))) + .await?; + + tokio::time::timeout(std::time::Duration::from_secs(5), receive_signal.notified()).await?; + + let (method, params) = payload.lock().await.take().expect("payload set"); + assert_eq!("requests/custom-test", method); + assert_eq!(Some(json!({ "foo": "bar" })), params); + + match response { + ServerResult::CustomResult(result) => { + assert_eq!(result.0, json!({ "status": "ok" })); + } + other => panic!("Expected custom result, got: {other:?}"), + } + + client.cancel().await?; + Ok(()) +} + +struct CustomRequestClient { + receive_signal: Arc, + payload: Arc>>, +} + +impl ClientHandler for CustomRequestClient { + async fn on_custom_request( + &self, + request: CustomRequest, + _context: rmcp::service::RequestContext, + ) -> Result { + let CustomRequest { method, params, .. } = request; + *self.payload.lock().await = Some((method, params)); + self.receive_signal.notify_one(); + Ok(CustomResult::new(json!({ "status": "ok" }))) + } +} + +struct CustomRequestServerNotifier { + receive_signal: Arc, + response: Arc>>>, +} + +impl ServerHandler for CustomRequestServerNotifier { + async fn on_initialized(&self, context: rmcp::service::NotificationContext) { + let peer = context.peer.clone(); + let receive_signal = self.receive_signal.clone(); + let response = self.response.clone(); + tokio::spawn(async move { + let result = peer + .send_request(ServerRequest::CustomRequest(CustomRequest::new( + "requests/custom-server", + Some(json!({ "ping": "pong" })), + ))) + .await; + let payload = match result { + Ok(ClientResult::CustomResult(result)) => Ok(result.0), + Ok(other) => Err(format!("Unexpected response: {other:?}")), + Err(err) => Err(format!("Failed to send request: {err:?}")), + }; + *response.lock().await = Some(payload); + receive_signal.notify_one(); + }); + } +} + +#[tokio::test] +async fn test_custom_server_request_reaches_client() -> anyhow::Result<()> { + let _ = tracing_subscriber::registry() + .with( + tracing_subscriber::EnvFilter::try_from_default_env() + .unwrap_or_else(|_| "debug".to_string().into()), + ) + .with(tracing_subscriber::fmt::layer()) + .try_init(); + + let (server_transport, client_transport) = tokio::io::duplex(4096); + let response_signal = Arc::new(Notify::new()); + let response = Arc::new(Mutex::new(None)); + tokio::spawn({ + let response_signal = response_signal.clone(); + let response = response.clone(); + async move { + let server = CustomRequestServerNotifier { + receive_signal: response_signal, + response, + } + .serve(server_transport) + .await?; + server.waiting().await?; + anyhow::Ok(()) + } + }); + + let receive_signal = Arc::new(Notify::new()); + let payload = Arc::new(Mutex::new(None)); + + let client = CustomRequestClient { + receive_signal: receive_signal.clone(), + payload: payload.clone(), + } + .serve(client_transport) + .await?; + + tokio::time::timeout(std::time::Duration::from_secs(5), receive_signal.notified()).await?; + tokio::time::timeout( + std::time::Duration::from_secs(5), + response_signal.notified(), + ) + .await?; + + let (method, params) = payload.lock().await.take().expect("payload set"); + assert_eq!("requests/custom-server", method); + assert_eq!(Some(json!({ "ping": "pong" })), params); + + let response = response.lock().await.take().expect("response set"); + let response = response.expect("custom request response ok"); + assert_eq!(response, json!({ "status": "ok" })); + + client.cancel().await?; + Ok(()) +} diff --git a/vendor/rmcp/tests/test_deserialization.rs b/vendor/rmcp/tests/test_deserialization.rs new file mode 100644 index 00000000..bac8e180 --- /dev/null +++ b/vendor/rmcp/tests/test_deserialization.rs @@ -0,0 +1,399 @@ +use rmcp::model::{JsonRpcResponse, ServerJsonRpcMessage, ServerResult}; +#[test] +fn test_tool_list_result() { + let json = std::fs::read("tests/test_deserialization/tool_list_result.json").unwrap(); + let result: ServerJsonRpcMessage = serde_json::from_slice(&json).unwrap(); + println!("{result:#?}"); + + assert!(matches!( + result, + ServerJsonRpcMessage::Response(JsonRpcResponse { + result: ServerResult::ListToolsResult(_), + .. + }) + )); +} + +/// Regression tests for `#[serde(untagged)]` deserialization of `ServerResult`. +/// +/// `ServerResult` is an untagged enum, so serde tries each variant in declaration +/// order, with `CustomResult(Value)` acting as the catch-all. If variant ordering +/// changes, these tests will catch the regression. +mod untagged_server_result { + use rmcp::model::{CallToolResult, JsonRpcResponse, ServerJsonRpcMessage, ServerResult}; + use serde_json::json; + + /// Helper: wrap a result value in a JSON-RPC response envelope. + fn wrap_response(result: serde_json::Value) -> serde_json::Value { + json!({ + "jsonrpc": "2.0", + "id": 1, + "result": result + }) + } + + /// Parse a JSON-RPC response and return the inner `ServerResult`. + fn parse_result(json: serde_json::Value) -> ServerResult { + let msg: ServerJsonRpcMessage = serde_json::from_value(json).unwrap(); + match msg { + ServerJsonRpcMessage::Response(JsonRpcResponse { result, .. }) => result, + other => panic!("expected Response, got {other:?}"), + } + } + + #[test] + fn initialize_result_deserializes_to_correct_variant() { + let result = parse_result(wrap_response(json!({ + "protocolVersion": "2025-03-26", + "capabilities": {}, + "serverInfo": { + "name": "test-server", + "version": "1.0.0" + } + }))); + assert!( + matches!(result, ServerResult::InitializeResult(_)), + "expected InitializeResult, got {result:?}" + ); + } + + #[test] + fn call_tool_result_deserializes_to_correct_variant() { + let result = parse_result(wrap_response(json!({ + "content": [ + { "type": "text", "text": "hello" } + ] + }))); + assert!( + matches!(result, ServerResult::CallToolResult(_)), + "expected CallToolResult, got {result:?}" + ); + } + + #[test] + fn call_tool_result_with_null_structured_content_deserializes_to_correct_variant() { + for payload in [ + json!({ + "resultType": "complete", + "content": [], + "structuredContent": null + }), + json!({ + "resultType": "complete", + "structuredContent": null + }), + json!({ "structuredContent": null }), + ] { + let result = parse_result(wrap_response(payload.clone())); + let ServerResult::CallToolResult(result) = result else { + panic!("{payload} should deserialize as CallToolResult, got {result:?}"); + }; + assert_eq!(result.structured_content, Some(serde_json::Value::Null)); + } + } + + #[test] + fn null_structured_content_does_not_shadow_custom_result() { + // Counting a present `structuredContent: null` as a known field must not + // make CallToolResult swallow other objects carrying only null values. + let result = parse_result(wrap_response(json!({ + "somethingElse": null + }))); + assert!( + matches!(result, ServerResult::CustomResult(_)), + "expected CustomResult, got {result:?}" + ); + } + + #[test] + fn input_required_result_with_meta_deserializes_to_correct_variant() { + let result = parse_result(wrap_response(json!({ + "resultType": "input_required", + "inputRequests": { + "username": { + "method": "elicitation/create", + "params": { + "message": "Please provide your username", + "requestedSchema": { + "type": "object", + "properties": { + "username": { "type": "string" } + }, + "required": ["username"] + } + } + } + }, + "requestState": "opaque-state", + "_meta": { + "io.modelcontextprotocol/serverInfo": { + "name": "test-server", + "version": "1.0.0" + } + } + }))); + + let ServerResult::InputRequiredResult(result) = result else { + panic!("expected InputRequiredResult, got {result:?}"); + }; + assert!( + result.input_requests.is_some_and(|requests| { + requests.len() == 1 && requests.contains_key("username") + }) + ); + assert_eq!(result.request_state.as_deref(), Some("opaque-state")); + assert_eq!( + result + .meta + .as_ref() + .and_then(|meta| meta.get("io.modelcontextprotocol/serverInfo")), + Some(&json!({ + "name": "test-server", + "version": "1.0.0" + })) + ); + } + + #[test] + fn call_tool_result_rejects_input_required_discriminator() { + assert!( + serde_json::from_value::(json!({ + "resultType": "input_required", + "requestState": "opaque-state", + "_meta": {} + })) + .is_err() + ); + } + + #[test] + fn invalid_input_required_result_falls_through_to_custom_result() { + let payload = json!({ + "resultType": "input_required", + "_meta": {} + }); + let result = parse_result(wrap_response(payload.clone())); + + let ServerResult::CustomResult(result) = result else { + panic!("expected CustomResult, got {result:?}"); + }; + assert_eq!(result.0, payload); + } + + #[test] + fn empty_object_deserializes_to_empty_result() { + let result = parse_result(wrap_response(json!({}))); + assert!( + matches!(result, ServerResult::EmptyResult(_)), + "expected EmptyResult, got {result:?}" + ); + } + + #[test] + fn unknown_shape_falls_through_to_custom_result() { + // A value that doesn't match any known result type should land in + // CustomResult. + let result = parse_result(wrap_response(json!({ + "some_unknown_field": "some_value", + "number": 42 + }))); + assert!( + matches!(result, ServerResult::CustomResult(_)), + "expected CustomResult, got {result:?}" + ); + } + + #[test] + fn result_type_bearing_objects_do_not_match_task_ack() { + // TaskAckResult carries only `resultType` (+ optional `_meta`), so it + // must not greedily swallow arbitrary results that happen to include + // a `resultType` key inside the untagged ServerResult union. + let result = parse_result(wrap_response(json!({ + "resultType": "weird-custom", + "payload": { "a": 1 } + }))); + assert!( + matches!(result, ServerResult::CustomResult(_)), + "expected CustomResult, got {result:?}" + ); + + let result = parse_result(wrap_response(json!({ + "resultType": "complete", + "customField": 42 + }))); + assert!( + matches!(result, ServerResult::CustomResult(_)), + "expected CustomResult, got {result:?}" + ); + + // A bare complete ack (the actual tasks/update / tasks/cancel ack + // shape) still parses as TaskAckResult. + let result = parse_result(wrap_response(json!({ "resultType": "complete" }))); + assert!( + matches!(result, ServerResult::TaskAckResult(_)), + "expected TaskAckResult, got {result:?}" + ); + } + + #[test] + fn arbitrary_json_value_falls_through_to_custom_result() { + // Any bare JSON value must fall through to CustomResult. + for value in [json!(42), json!("hello"), json!(null), json!([1, 2, 3])] { + let result = parse_result(wrap_response(value.clone())); + assert!( + matches!(result, ServerResult::CustomResult(_)), + "value {value} should deserialize as CustomResult, got {result:?}" + ); + } + } + + #[test] + fn round_trip_initialize_result_preserves_variant() { + let json = json!({ + "protocolVersion": "2025-03-26", + "capabilities": {}, + "serverInfo": { "name": "test", "version": "1.0" } + }); + // Parse as ServerResult, serialize back, parse again — must stay InitializeResult. + let result = parse_result(wrap_response(json.clone())); + assert!(matches!(&result, ServerResult::InitializeResult(_))); + let reserialized = serde_json::to_value(&result).unwrap(); + let result2 = parse_result(wrap_response(reserialized)); + assert!(matches!(result2, ServerResult::InitializeResult(_))); + } + + #[test] + fn round_trip_call_tool_result_preserves_variant() { + let original = + CallToolResult::success(vec![rmcp::model::ContentBlock::text("hello world")]); + let json = serde_json::to_value(&original).unwrap(); + let result = parse_result(wrap_response(json)); + assert!(matches!(result, ServerResult::CallToolResult(_))); + } +} + +/// Regression tests for decimal float fields under serde_json's +/// `arbitrary_precision` feature, which rmcp's dev-dependencies enable. +/// +/// With the feature, serde replays a decimal it buffered for an untagged enum +/// as serde_json's private number map. A plain `f32`/`f64` field rejected that +/// map, so each of these messages fell through to a `Custom*` variant. They are +/// decoded from text, which is where the map comes from. +mod arbitrary_precision { + use rmcp::model::{ + ClientJsonRpcMessage, ClientNotification, ElicitRequestParams, JsonRpcMessage, + JsonRpcNotification, JsonRpcRequest, JsonRpcResponse, PrimitiveSchemaDefinition, + ServerJsonRpcMessage, ServerNotification, ServerRequest, ServerResult, + }; + + /// Decodes a server message the way a client does (`RxJsonRpcMessage`). + fn from_server(text: &str) -> ServerJsonRpcMessage { + serde_json::from_str(text).unwrap() + } + + #[test] + fn feature_is_enabled() { + // Only the feature keeps the number as written; without it this reads `0.6`. + let value: serde_json::Value = serde_json::from_str("0.60").unwrap(); + assert_eq!(value.to_string(), "0.60"); + } + + #[test] + fn call_tool_result_with_fractional_priority() { + let message = from_server( + r#"{"jsonrpc":"2.0","id":1,"result":{"content":[ + {"type":"text","text":"ok","annotations":{"priority":0.6}}]}}"#, + ); + let JsonRpcMessage::Response(JsonRpcResponse { + result: ServerResult::CallToolResult(result), + .. + }) = message + else { + panic!("expected CallToolResult, got {message:?}"); + }; + let annotations = result.content[0].as_text().unwrap().annotations.as_ref(); + assert_eq!(annotations.unwrap().priority, Some(0.6)); + } + + #[test] + fn progress_notification_with_fractional_progress() { + let text = r#"{"jsonrpc":"2.0","method":"notifications/progress", + "params":{"progressToken":"t","progress":0.5,"total":2.5}}"#; + + let message = from_server(text); + let JsonRpcMessage::Notification(JsonRpcNotification { + notification: ServerNotification::ProgressNotification(notification), + .. + }) = message + else { + panic!("expected ProgressNotification, got {message:?}"); + }; + assert_eq!(notification.params.progress, 0.5); + assert_eq!(notification.params.total, Some(2.5)); + + let message: ClientJsonRpcMessage = serde_json::from_str(text).unwrap(); + assert!( + matches!( + message, + JsonRpcMessage::Notification(JsonRpcNotification { + notification: ClientNotification::ProgressNotification(_), + .. + }) + ), + "expected ProgressNotification, got {message:?}" + ); + } + + #[test] + #[expect(deprecated, reason = "sampling is deprecated by SEP-2577")] + fn create_message_request_with_fractional_parameters() { + let message = from_server( + r#"{"jsonrpc":"2.0","id":2,"method":"sampling/createMessage","params":{ + "messages":[],"maxTokens":10,"temperature":0.7,"modelPreferences":{ + "costPriority":0.2,"speedPriority":0.5,"intelligencePriority":0.9}}}"#, + ); + let JsonRpcMessage::Request(JsonRpcRequest { + request: ServerRequest::CreateMessageRequest(request), + .. + }) = message + else { + panic!("expected CreateMessageRequest, got {message:?}"); + }; + assert_eq!(request.params.temperature, Some(0.7)); + let preferences = request.params.model_preferences.unwrap(); + assert_eq!(preferences.cost_priority, Some(0.2)); + assert_eq!(preferences.speed_priority, Some(0.5)); + assert_eq!(preferences.intelligence_priority, Some(0.9)); + } + + #[test] + fn elicit_request_with_fractional_number_schema() { + let message = from_server( + r#"{"jsonrpc":"2.0","id":3,"method":"elicitation/create","params":{ + "mode":"form","message":"How much?","requestedSchema":{"type":"object", + "properties":{"amount":{"type":"number", + "minimum":0.5,"maximum":9.5,"default":1.5}}}}}"#, + ); + let JsonRpcMessage::Request(JsonRpcRequest { + request: ServerRequest::ElicitRequest(request), + .. + }) = message + else { + panic!("expected ElicitRequest, got {message:?}"); + }; + let ElicitRequestParams::FormElicitationParams { + requested_schema, .. + } = request.params + else { + panic!("expected a form elicitation"); + }; + let Some(PrimitiveSchemaDefinition::Number(amount)) = + requested_schema.properties.get("amount") + else { + panic!("expected a number schema"); + }; + assert_eq!(amount.minimum, Some(0.5)); + assert_eq!(amount.maximum, Some(9.5)); + assert_eq!(amount.default, Some(1.5)); + } +} diff --git a/vendor/rmcp/tests/test_deserialization/tool_list_result.json b/vendor/rmcp/tests/test_deserialization/tool_list_result.json new file mode 100644 index 00000000..38f7b34f --- /dev/null +++ b/vendor/rmcp/tests/test_deserialization/tool_list_result.json @@ -0,0 +1,31 @@ +{ + "result": { + "tools": [ + { + "name": "add", + "inputSchema": { + "type": "object", + "properties": { + "a": { + "type": "number" + }, + "b": { + "type": "number" + } + }, + "required": [ + "a", + "b" + ], + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-07/schema#" + }, + "execution": { + "taskSupport": "optional" + } + } + ] + }, + "jsonrpc": "2.0", + "id": 2 +} \ No newline at end of file diff --git a/vendor/rmcp/tests/test_discover_http_client_startup.rs b/vendor/rmcp/tests/test_discover_http_client_startup.rs new file mode 100644 index 00000000..70aa219d --- /dev/null +++ b/vendor/rmcp/tests/test_discover_http_client_startup.rs @@ -0,0 +1,345 @@ +#![cfg(all( + not(feature = "local"), + feature = "client", + feature = "reqwest", + feature = "transport-streamable-http-server" +))] + +use std::{borrow::Cow, sync::Arc}; + +use axum::{ + Router, + body::{Body, Bytes}, + extract::State, + http::{Response, StatusCode}, + routing::post, +}; +use rmcp::{ + ClientLifecycleMode, ClientServiceExt, ServerHandler, + model::{ClientConfig, DiscoverResult, ErrorCode, ErrorData, ProtocolVersion}, + service::{MaybeSendFuture, RequestContext, RoleServer}, + transport::{ + StreamableHttpClientTransport, + streamable_http_client::StreamableHttpClientTransportConfig, + streamable_http_server::{ + StreamableHttpServerConfig, StreamableHttpService, session::local::LocalSessionManager, + }, + }, +}; +use serde_json::json; +use tokio::sync::Mutex; +use tokio_util::sync::CancellationToken; + +#[derive(Clone, Default)] +struct DiscoverHttpServer; + +impl ServerHandler for DiscoverHttpServer { + fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]> { + Cow::Borrowed(&[ProtocolVersion::V_2026_07_28]) + } +} + +#[derive(Clone, Default)] +struct LegacyHttpServer; + +impl ServerHandler for LegacyHttpServer { + fn discover( + &self, + _context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + std::future::ready(Err(ErrorData::new( + ErrorCode::METHOD_NOT_FOUND, + "Method not found", + None, + ))) + } +} + +#[derive(Clone, Default)] +struct PlainTextLegacyHttpState { + methods: Arc>>, +} + +async fn plain_text_legacy_http_handler( + State(state): State, + body: Bytes, +) -> Response { + let request: serde_json::Value = serde_json::from_slice(&body).expect("valid JSON-RPC body"); + let method = request["method"] + .as_str() + .expect("request method") + .to_owned(); + state.methods.lock().await.push(method.clone()); + + if method == "server/discover" { + return Response::builder() + .status(StatusCode::UNPROCESSABLE_ENTITY) + .body(Body::from("Unexpected message, expect initialize request")) + .expect("build rejection response"); + } + + if method == "initialize" { + return Response::builder() + .status(StatusCode::OK) + .header("content-type", "application/json") + .body(Body::from( + json!({ + "jsonrpc": "2.0", + "id": request["id"], + "result": { + "protocolVersion": "2025-11-25", + "capabilities": {}, + "serverInfo": {"name": "legacy", "version": "1.0"} + } + }) + .to_string(), + )) + .expect("build initialize response"); + } + + Response::builder() + .status(StatusCode::ACCEPTED) + .body(Body::empty()) + .expect("build notification response") +} + +#[tokio::test] +async fn discover_http_client_bootstraps_headers_without_initialize() { + let ct = CancellationToken::new(); + let service: StreamableHttpService = + StreamableHttpService::new( + || Ok(DiscoverHttpServer), + Default::default(), + StreamableHttpServerConfig::default() + .with_legacy_session_mode(false) + .with_json_response(true) + .with_cancellation_token(ct.child_token()), + ); + let router = axum::Router::new().nest_service("/mcp", service); + let listener = tokio::net::TcpListener::bind("127.0.0.1:0") + .await + .expect("listener should bind"); + let address = listener.local_addr().expect("listener address"); + let server = tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + let transport = StreamableHttpClientTransport::from_config( + StreamableHttpClientTransportConfig::with_uri(format!("http://{address}/mcp")), + ); + let client = ClientConfig::default() + .serve_with_lifecycle( + transport, + ClientLifecycleMode::Discover { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + }, + ) + .await + .expect("discover HTTP client should start"); + client.list_tools(None).await.expect("list tools"); + client.cancel().await.expect("cancel client"); + + ct.cancel(); + server.await.expect("server task"); +} + +#[tokio::test] +async fn auto_http_client_falls_back_to_stateful_legacy_startup() { + let ct = CancellationToken::new(); + let service: StreamableHttpService = + StreamableHttpService::new( + || Ok(LegacyHttpServer), + Default::default(), + StreamableHttpServerConfig::default() + .with_json_response(true) + .with_cancellation_token(ct.child_token()), + ); + let router = axum::Router::new().nest_service("/mcp", service); + let listener = tokio::net::TcpListener::bind("127.0.0.1:0") + .await + .expect("listener should bind"); + let address = listener.local_addr().expect("listener address"); + let server = tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + let transport = StreamableHttpClientTransport::from_config( + StreamableHttpClientTransportConfig::with_uri(format!("http://{address}/mcp")), + ); + let client = ClientConfig::default() + .serve_with_lifecycle( + transport, + ClientLifecycleMode::Auto { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + legacy_version: Some(ProtocolVersion::V_2025_11_25), + }, + ) + .await + .expect("auto HTTP client should fall back"); + client.list_tools(None).await.expect("list tools"); + client.cancel().await.expect("cancel client"); + + ct.cancel(); + server.await.expect("server task"); +} + +#[tokio::test] +async fn auto_http_client_falls_back_after_plain_text_4xx_rejection() { + let ct = CancellationToken::new(); + let state = PlainTextLegacyHttpState::default(); + let methods = state.methods.clone(); + let router = Router::new() + .route("/mcp", post(plain_text_legacy_http_handler)) + .with_state(state); + let listener = tokio::net::TcpListener::bind("127.0.0.1:0") + .await + .expect("listener should bind"); + let address = listener.local_addr().expect("listener address"); + let server = tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + let transport = StreamableHttpClientTransport::from_config( + StreamableHttpClientTransportConfig::with_uri(format!("http://{address}/mcp")), + ); + let client = ClientConfig::default() + .serve_with_lifecycle( + transport, + ClientLifecycleMode::Auto { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + legacy_version: Some(ProtocolVersion::V_2025_11_25), + }, + ) + .await + .expect("auto HTTP client should fall back after a transport-level rejection"); + client.cancel().await.expect("cancel client"); + + assert_eq!( + methods.lock().await.as_slice(), + &["server/discover", "initialize", "notifications/initialized"] + ); + ct.cancel(); + server.await.expect("server task"); +} + +#[derive(Clone, Default)] +struct VersionNegotiatingHttpState { + methods: Arc>>, +} + +/// Rejects the first probe with a 4xx `UnsupportedProtocolVersionError` carrying +/// an uncorrelated `id`, as a middleware rejection would. Accepts the retry. +async fn version_negotiating_http_handler( + State(state): State, + body: Bytes, +) -> Response { + let request: serde_json::Value = serde_json::from_slice(&body).expect("valid JSON-RPC body"); + let method = request["method"] + .as_str() + .expect("request method") + .to_owned(); + state.methods.lock().await.push(method.clone()); + + if method == "server/discover" { + if state.methods.lock().await.len() == 1 { + return Response::builder() + .status(StatusCode::BAD_REQUEST) + .header("content-type", "application/json") + .body(Body::from( + json!({ + "jsonrpc": "2.0", + "id": "server-error", + "error": { + "code": -32022, + "message": "Unsupported protocol version", + "data": {"supported": ["2025-11-25"]} + } + }) + .to_string(), + )) + .expect("build version rejection response"); + } + + let result = DiscoverResult::new(vec![ProtocolVersion::V_2025_11_25], Default::default()); + return Response::builder() + .status(StatusCode::OK) + .header("content-type", "application/json") + .body(Body::from( + json!({ + "jsonrpc": "2.0", + "id": request["id"], + "result": result, + }) + .to_string(), + )) + .expect("build discover response"); + } + + panic!("modern server must not be asked for {method}"); +} + +/// A recognized modern error in a 4xx discover rejection identifies a modern +/// server, so the client retries at a supported version instead of falling back +/// to legacy `initialize`. +#[tokio::test] +async fn auto_http_client_retries_version_after_modern_4xx_rejection() { + let ct = CancellationToken::new(); + let state = VersionNegotiatingHttpState::default(); + let methods = state.methods.clone(); + let router = Router::new() + .route("/mcp", post(version_negotiating_http_handler)) + .with_state(state); + let listener = tokio::net::TcpListener::bind("127.0.0.1:0") + .await + .expect("listener should bind"); + let address = listener.local_addr().expect("listener address"); + let server = tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + let transport = StreamableHttpClientTransport::from_config( + StreamableHttpClientTransportConfig::with_uri(format!("http://{address}/mcp")), + ); + let client = ClientConfig::default() + .serve_with_lifecycle( + transport, + ClientLifecycleMode::Auto { + preferred_versions: vec![ + ProtocolVersion::V_2026_07_28, + ProtocolVersion::V_2025_11_25, + ], + legacy_version: Some(ProtocolVersion::V_2025_11_25), + }, + ) + .await + .expect("auto HTTP client should retry discover at a supported version"); + client.cancel().await.expect("cancel client"); + + assert_eq!( + methods.lock().await.as_slice(), + &["server/discover", "server/discover"], + "expected a version-negotiation retry, not a legacy fallback" + ); + ct.cancel(); + server.await.expect("server task"); +} diff --git a/vendor/rmcp/tests/test_elicitation.rs b/vendor/rmcp/tests/test_elicitation.rs new file mode 100644 index 00000000..953648c0 --- /dev/null +++ b/vendor/rmcp/tests/test_elicitation.rs @@ -0,0 +1,2077 @@ +//cargo test --test test_elicitation --features "client server" + +use rmcp::{model::*, object, service::*}; +// For typed elicitation tests +#[cfg(feature = "schemars")] +use schemars::JsonSchema; +#[cfg(feature = "schemars")] +use serde::{Deserialize, Serialize}; +use serde_json::json; + +/// Test that elicitation data structures can be serialized and deserialized correctly +/// This ensures JSON-RPC compatibility with MCP 2025-06-18 specification +#[tokio::test] +async fn test_elicitation_serialization() { + // Test ElicitationAction enum serialization + let accept = ElicitationAction::Accept; + let decline = ElicitationAction::Decline; + let cancel = ElicitationAction::Cancel; + + assert_eq!(serde_json::to_string(&accept).unwrap(), "\"accept\""); + assert_eq!(serde_json::to_string(&decline).unwrap(), "\"decline\""); + assert_eq!(serde_json::to_string(&cancel).unwrap(), "\"cancel\""); + + // Test deserialization + assert_eq!( + serde_json::from_str::("\"accept\"").unwrap(), + ElicitationAction::Accept + ); + assert_eq!( + serde_json::from_str::("\"decline\"").unwrap(), + ElicitationAction::Decline + ); + assert_eq!( + serde_json::from_str::("\"cancel\"").unwrap(), + ElicitationAction::Cancel + ); +} + +/// Test ElicitRequestParams structure serialization/deserialization +#[tokio::test] +async fn test_elicitation_request_param_serialization() { + let schema = ElicitationSchema::builder() + .required_property( + "email", + PrimitiveSchemaDefinition::String(StringSchema::email()), + ) + .build() + .unwrap(); + + let request_param = ElicitRequestParams::FormElicitationParams { + meta: None, + message: "Please provide your email address".to_string(), + requested_schema: schema, + }; + + // Test serialization + let json = serde_json::to_value(&request_param).unwrap(); + let expected = json!({ + "mode": "form", + "message": "Please provide your email address", + "requestedSchema": { + "type": "object", + "properties": { + "email": { + "type": "string", + "format": "email" + } + }, + "required": ["email"] + } + }); + + assert_eq!(json, expected); + + // Test deserialization + let deserialized: ElicitRequestParams = serde_json::from_value(expected).unwrap(); + match (&deserialized, &request_param) { + ( + ElicitRequestParams::FormElicitationParams { + meta: None, + message: msg1, + requested_schema: schema1, + }, + ElicitRequestParams::FormElicitationParams { + meta: None, + message: msg2, + requested_schema: schema2, + }, + ) => { + assert_eq!(msg1, msg2); + assert_eq!(schema1, schema2); + } + _ => panic!("Expected FormElicitationParams variant"), + } +} + +/// Test ElicitResult structure with different action types +#[tokio::test] +async fn test_elicitation_result_serialization() { + // Test Accept with content + let accept_result = ElicitResult::new(ElicitationAction::Accept) + .with_content(json!({"email": "user@example.com"})); + + let json = serde_json::to_value(&accept_result).unwrap(); + let expected = json!({ + "action": "accept", + "content": {"email": "user@example.com"} + }); + assert_eq!(json, expected); + + // Test Decline without content + let decline_result = ElicitResult::new(ElicitationAction::Decline); + + let json = serde_json::to_value(&decline_result).unwrap(); + let expected = json!({ + "action": "decline" + // content should be omitted when None due to skip_serializing_if + }); + assert_eq!(json, expected); + + // Test deserialization + let deserialized: ElicitResult = serde_json::from_value(expected).unwrap(); + assert_eq!(deserialized.action, ElicitationAction::Decline); + assert_eq!(deserialized.content, None); + assert_eq!(deserialized.meta, None); + + // Test protocol-level metadata round-trips as _meta. + let meta_result = ElicitResult::new(ElicitationAction::Accept).with_meta(MetaObject(object!({ + "traceId": "elicitation-123" + }))); + + let json = serde_json::to_value(&meta_result).unwrap(); + let expected = json!({ + "action": "accept", + "_meta": {"traceId": "elicitation-123"} + }); + assert_eq!(json, expected); + + let deserialized: ElicitResult = serde_json::from_value(expected).unwrap(); + assert_eq!( + deserialized.meta, + Some(MetaObject(object!({ "traceId": "elicitation-123" }))) + ); +} + +/// Test that elicitation requests can be created and handled through the JSON-RPC protocol +#[tokio::test] +async fn test_elicitation_json_rpc_protocol() { + let schema = ElicitationSchema::builder() + .required_property( + "confirmation", + PrimitiveSchemaDefinition::Boolean(BooleanSchema::new()), + ) + .build() + .unwrap(); + + // Create a complete JSON-RPC request for elicitation + let request = JsonRpcRequest { + jsonrpc: JsonRpcVersion2_0, + id: RequestId::Number(1), + request: ElicitRequest::new(ElicitRequestParams::FormElicitationParams { + meta: None, + message: "Do you want to continue?".to_string(), + requested_schema: schema, + }), + }; + + // Test serialization of complete request + let json = serde_json::to_value(&request).unwrap(); + assert_eq!(json["jsonrpc"], "2.0"); + assert_eq!(json["id"], 1); + assert_eq!(json["method"], "elicitation/create"); + assert_eq!(json["params"]["message"], "Do you want to continue?"); + + // Test deserialization + let deserialized: JsonRpcRequest = serde_json::from_value(json).unwrap(); + assert_eq!(deserialized.id, RequestId::Number(1)); + match &deserialized.request.params { + ElicitRequestParams::FormElicitationParams { message, .. } => { + assert_eq!(message, "Do you want to continue?"); + } + _ => panic!("Expected FormElicitationParams variant"), + } +} + +/// Test elicitation action types and their expected behavior +#[tokio::test] +async fn test_elicitation_action_types() { + // Test all three action types + let actions = [ + ElicitationAction::Accept, + ElicitationAction::Decline, + ElicitationAction::Cancel, + ]; + + // Each action should have a unique string representation + let serialized: Vec = actions + .iter() + .map(|action| serde_json::to_string(action).unwrap()) + .collect(); + + assert_eq!(serialized.len(), 3); + assert!(serialized.contains(&"\"accept\"".to_string())); + assert!(serialized.contains(&"\"decline\"".to_string())); + assert!(serialized.contains(&"\"cancel\"".to_string())); + + // Test round-trip serialization + for action in actions { + let json = serde_json::to_string(&action).unwrap(); + let deserialized: ElicitationAction = serde_json::from_str(&json).unwrap(); + assert_eq!(action, deserialized); + } +} + +/// Test MCP 2025-06-18 specification compliance +/// Ensures our implementation matches the latest MCP spec +#[tokio::test] +async fn test_elicitation_spec_compliance() { + // Test that method names match the specification + assert_eq!(ElicitationCreateRequestMethod::VALUE, "elicitation/create"); + assert_eq!( + ElicitationResponseNotificationMethod::VALUE, + "notifications/elicitation/response" + ); + + // Test that enum values match specification + let actions = [ + ElicitationAction::Accept, + ElicitationAction::Decline, + ElicitationAction::Cancel, + ]; + + let serialized: Vec = actions + .iter() + .map(|a| serde_json::to_string(a).unwrap()) + .collect(); + + assert_eq!(serialized, vec!["\"accept\"", "\"decline\"", "\"cancel\""]); +} + +/// Test error handling and edge cases for elicitation +#[tokio::test] +async fn test_elicitation_error_handling() { + // Test minimal schema handling (empty properties is technically valid) + let minimal_schema_request = ElicitRequestParams::FormElicitationParams { + meta: None, + message: "Test message".to_string(), + requested_schema: ElicitationSchema::builder().build().unwrap(), + }; + + // Should serialize without error + let _json = serde_json::to_value(&minimal_schema_request).unwrap(); + + // Test empty message + let empty_message_request = ElicitRequestParams::FormElicitationParams { + meta: None, + message: "".to_string(), + requested_schema: ElicitationSchema::builder() + .property( + "value", + PrimitiveSchemaDefinition::String(StringSchema::new()), + ) + .build() + .unwrap(), + }; + + // Should serialize without error (validation is up to the implementation) + let _json = serde_json::to_value(&empty_message_request).unwrap(); + + // Test that we can deserialize invalid action types (should fail) + let invalid_action_json = json!("invalid_action"); + let result = serde_json::from_value::(invalid_action_json); + assert!(result.is_err()); +} + +/// Benchmark-style test for elicitation performance +#[tokio::test] +async fn test_elicitation_performance() { + let schema = ElicitationSchema::builder() + .property( + "data", + PrimitiveSchemaDefinition::String(StringSchema::new()), + ) + .build() + .unwrap(); + + let request = ElicitRequestParams::FormElicitationParams { + meta: None, + message: "Performance test message".to_string(), + requested_schema: schema, + }; + + let start = std::time::Instant::now(); + + // Serialize/deserialize 1000 times + for _ in 0..1000 { + let json = serde_json::to_value(&request).unwrap(); + let _deserialized: ElicitRequestParams = serde_json::from_value(json).unwrap(); + } + + let duration = start.elapsed(); + println!( + "1000 elicitation serialization/deserialization cycles took: {:?}", + duration + ); + + // Should complete in reasonable time (less than 100ms on modern hardware) + assert!( + duration.as_millis() < 1000, + "Performance test took too long: {:?}", + duration + ); +} + +/// Test elicitation capabilities integration +/// Ensures that elicitation capability can be properly configured and serialized +#[tokio::test] +async fn test_elicitation_capabilities() { + use rmcp::model::{ClientCapabilities, ElicitationCapability}; + + // Test basic elicitation capability + let mut elicitation_cap = ElicitationCapability::default(); + assert_eq!(elicitation_cap.form, None); + assert_eq!(elicitation_cap.url, None); + + // Test with schema validation enabled + elicitation_cap.form = Some(FormElicitationCapability::new().with_schema_validation(true)); + + // Test serialization + let json = serde_json::to_value(&elicitation_cap).unwrap(); + let expected = json!({"form":{"schemaValidation": true}}); + assert_eq!(json, expected); + + // Test deserialization + let deserialized: ElicitationCapability = serde_json::from_value(expected).unwrap(); + assert_eq!( + deserialized.form.as_ref().unwrap().schema_validation, + Some(true) + ); + + // Test ClientCapabilities builder with elicitation + let client_caps = ClientCapabilities::builder() + .enable_elicitation() + .enable_elicitation_schema_validation() + .build(); + + assert!(client_caps.elicitation.is_some()); + assert_eq!( + client_caps + .elicitation + .as_ref() + .unwrap() + .form + .as_ref() + .unwrap() + .schema_validation, + Some(true) + ); + + // Test full client capabilities serialization + let json = serde_json::to_value(&client_caps).unwrap(); + assert!( + json["elicitation"]["form"]["schemaValidation"] + .as_bool() + .unwrap_or(false) + ); +} + +/// Test convenience methods for common elicitation scenarios +/// This ensures the helper methods create proper requests with expected schemas +#[tokio::test] +async fn test_elicitation_convenience_methods() { + // Test that convenience methods produce the expected request parameters + + // Test confirmation schema + let confirmation_schema = serde_json::json!({ + "type": "boolean", + "description": "User confirmation (true for yes, false for no)" + }); + + // Verify the schema structure for boolean confirmation + assert_eq!(confirmation_schema["type"], "boolean"); + assert!(confirmation_schema["description"].is_string()); + + // Test text input schema (non-required) + let text_schema = serde_json::json!({ + "type": "string", + "description": "User text input" + }); + + assert_eq!(text_schema["type"], "string"); + assert!(text_schema.get("minLength").is_none()); + + // Test text input schema (required) + let required_text_schema = serde_json::json!({ + "type": "string", + "description": "User text input", + "minLength": 1 + }); + + assert_eq!(required_text_schema["minLength"], 1); + + // Test choice schema + let options = ["Option A", "Option B", "Option C"]; + let choice_schema = serde_json::json!({ + "type": "integer", + "minimum": 0, + "maximum": options.len() - 1, + "description": format!("Choose an option: {}", options.join(", ")) + }); + + assert_eq!(choice_schema["type"], "integer"); + assert_eq!(choice_schema["minimum"], 0); + assert_eq!(choice_schema["maximum"], 2); + assert!( + choice_schema["description"] + .as_str() + .unwrap() + .contains("Option A") + ); + + // Test that ElicitRequestParams can be created with type-safe schemas + let confirmation_request = ElicitRequestParams::FormElicitationParams { + meta: None, + message: "Test confirmation".to_string(), + requested_schema: ElicitationSchema::builder() + .property( + "confirmed", + PrimitiveSchemaDefinition::Boolean( + BooleanSchema::new() + .description("User confirmation (true for yes, false for no)"), + ), + ) + .build() + .unwrap(), + }; + + // Test serialization of convenience method request + let json = serde_json::to_value(&confirmation_request).unwrap(); + assert_eq!(json["message"], "Test confirmation"); + assert_eq!(json["requestedSchema"]["type"], "object"); + assert_eq!( + json["requestedSchema"]["properties"]["confirmed"]["type"], + "boolean" + ); +} + +/// Test structured input with multiple primitive properties +/// Ensures that schemas with multiple primitive properties work correctly with elicitation +#[tokio::test] +async fn test_elicitation_structured_schemas() { + // Test schema with multiple primitive properties + let schema = ElicitationSchema::builder() + .required_string_with("name", |s| s.length(1, 100)) + .required_email("email") + .required_integer("age", 0, 150) + .optional_bool("newsletter", false) + .required_enum_schema( + "country", + EnumSchema::builder(vec!["US".to_string(), "UK".to_string(), "CA".to_string()]).build(), + ) + .description("User registration information") + .build() + .unwrap(); + + let request = ElicitRequestParams::FormElicitationParams { + meta: None, + message: "Please provide your user information".to_string(), + requested_schema: schema, + }; + + // Test that complex schemas serialize/deserialize correctly + let json = serde_json::to_value(&request).unwrap(); + let deserialized: ElicitRequestParams = serde_json::from_value(json).unwrap(); + + match deserialized { + ElicitRequestParams::FormElicitationParams { + message, + requested_schema, + .. + } => { + assert_eq!(message, "Please provide your user information"); + assert_eq!(requested_schema.properties.len(), 5); + assert!(requested_schema.properties.contains_key("name")); + assert!(requested_schema.properties.contains_key("email")); + assert!(requested_schema.properties.contains_key("age")); + assert!(requested_schema.properties.contains_key("newsletter")); + assert!(requested_schema.properties.contains_key("country")); + assert_eq!( + requested_schema.required, + Some(vec![ + "name".to_string(), + "email".to_string(), + "age".to_string(), + "country".to_string() + ]) + ); + } + _ => panic!("Expected FormElicitationParams variant"), + } +} + +// Typed elicitation tests using the API with schemars +#[cfg(feature = "schemars")] +mod typed_elicitation_tests { + use super::*; + + /// Simple user confirmation with reason + #[derive(Debug, Serialize, Deserialize, JsonSchema, PartialEq)] + #[schemars(description = "User confirmation with optional reasoning")] + struct UserConfirmation { + #[schemars(description = "User's decision (true for yes, false for no)")] + confirmed: bool, + + #[schemars(description = "Optional reason for the decision")] + reason: Option, + } + + /// User profile with validation constraints + #[derive(Debug, Serialize, Deserialize, JsonSchema, PartialEq)] + #[schemars(description = "Complete user profile information")] + struct UserProfile { + #[schemars(description = "Full name")] + name: String, + + #[schemars(description = "Email address")] + email: String, + + #[schemars(description = "Age in years")] + age: u8, + + #[schemars(description = "User preferences")] + preferences: UserPreferences, + } + + /// User preferences + #[derive(Debug, Serialize, Deserialize, JsonSchema, PartialEq)] + struct UserPreferences { + #[schemars(description = "UI theme preference")] + theme: Theme, + + #[schemars(description = "Enable notifications")] + notifications: bool, + + #[schemars(description = "Language preference")] + language: String, + } + + /// UI theme options + #[derive(Debug, Serialize, Deserialize, JsonSchema, PartialEq)] + #[schemars(description = "Available UI themes")] + enum Theme { + #[schemars(description = "Light theme")] + Light, + #[schemars(description = "Dark theme")] + Dark, + #[schemars(description = "Auto-detect based on system")] + Auto, + } + + // Mark types as safe for elicitation (they generate object schemas) + rmcp::elicit_safe!(UserConfirmation, UserProfile, UserPreferences); + + /// Test automatic schema generation for simple types + #[tokio::test] + async fn test_typed_elicitation_simple_schema() { + // Test that schema generation works for simple types + let schema = rmcp::handler::server::tool::schema_for_type::(); + + // Verify schema contains expected fields + assert!(schema.contains_key("type")); + assert_eq!(schema.get("type"), Some(&json!("object"))); + assert!(schema.contains_key("properties")); + + if let Some(properties) = schema.get("properties") { + assert!(properties.is_object()); + let props = properties.as_object().unwrap(); + assert!(props.contains_key("confirmed")); + assert!(props.contains_key("reason")); + + // Check confirmed field is boolean + if let Some(confirmed_schema) = props.get("confirmed") { + let confirmed_obj = confirmed_schema.as_object().unwrap(); + assert_eq!(confirmed_obj.get("type"), Some(&json!("boolean"))); + } + + // Check reason field is optional string + if let Some(reason_schema) = props.get("reason") { + assert!(reason_schema.is_object()); + } + } + } + + /// Test automatic schema generation for complex nested types + #[tokio::test] + async fn test_typed_elicitation_complex_schema() { + // Test complex nested structure schema generation + let schema = rmcp::handler::server::tool::schema_for_type::(); + + // Verify schema structure + assert!(schema.contains_key("type")); + assert_eq!(schema.get("type"), Some(&json!("object"))); + + if let Some(properties) = schema.get("properties") { + let props = properties.as_object().unwrap(); + + // Check required fields exist + assert!(props.contains_key("name")); + assert!(props.contains_key("email")); + assert!(props.contains_key("age")); + assert!(props.contains_key("preferences")); + + // Check validation constraints for name + if let Some(name_schema) = props.get("name") { + let name_obj = name_schema.as_object().unwrap(); + assert_eq!(name_obj.get("type"), Some(&json!("string"))); + // Note: schemars might generate constraints differently + // The exact structure depends on schemars version + } + + // Check email format constraint + if let Some(email_schema) = props.get("email") { + let email_obj = email_schema.as_object().unwrap(); + assert_eq!(email_obj.get("type"), Some(&json!("string"))); + } + + // Check age numeric constraints + if let Some(age_schema) = props.get("age") { + let age_obj = age_schema.as_object().unwrap(); + assert_eq!(age_obj.get("type"), Some(&json!("integer"))); + } + } + } + + /// Test enum schema generation + #[tokio::test] + async fn test_enum_schema_generation() { + // Test enum schema generation + let schema = rmcp::handler::server::tool::schema_for_type::(); + + // Verify enum schema structure - schemars might use oneOf or enum depending on version + assert!( + schema.contains_key("type") + || schema.contains_key("oneOf") + || schema.contains_key("enum") + ); + + // The exact structure depends on schemars configuration, but it should be valid + let json = serde_json::to_string(&schema).unwrap(); + assert!(!json.is_empty()); + } + + /// Test that the schema generation for nested structures works + #[tokio::test] + async fn test_nested_structure_schema() { + // Test that nested structures generate proper schemas + let preferences_schema = rmcp::handler::server::tool::schema_for_type::(); + + // Verify basic structure + assert!(preferences_schema.contains_key("type")); + assert_eq!(preferences_schema.get("type"), Some(&json!("object"))); + + if let Some(properties) = preferences_schema.get("properties") { + let props = properties.as_object().unwrap(); + assert!(props.contains_key("theme")); + assert!(props.contains_key("notifications")); + assert!(props.contains_key("language")); + } + } +} + +// ============================================================================= +// ELICITATION ENUM TESTS (MCP 2025-11-25 COMPLIANCE) +// ============================================================================= + +/// Test elicitation with multi-select enum schema +#[tokio::test] +async fn test_elicitation_multi_select_enum() { + let enum_schema = EnumSchema::builder(vec!["A".into(), "B".into(), "C".into()]) + .multiselect() + .enum_titles(vec![ + "A name".to_string(), + "B name".to_string(), + "C name".to_string(), + ]) + .expect("Number of title must match number of enum values") + .min_items(1) + .expect("Min items must be less than or equal to number of enum values") + .max_items(2) + .expect("Max items must be less than or equal to number of enum values") + .build(); + + let schema = ElicitationSchema::builder() + .required_enum_schema("choices", enum_schema) + .build() + .unwrap(); + + let request = ElicitRequestParams::FormElicitationParams { + meta: None, + message: "Please provide your user information".to_string(), + requested_schema: schema, + }; + + // Test that complex schemas serialize/deserialize correctly + let json = serde_json::to_value(&request).unwrap(); + let deserialized: ElicitRequestParams = serde_json::from_value(json).unwrap(); + + match deserialized { + ElicitRequestParams::FormElicitationParams { + message, + requested_schema, + .. + } => { + assert_eq!(message, "Please provide your user information"); + assert_eq!(requested_schema.properties.len(), 1); + assert!(requested_schema.properties.contains_key("choices")); + assert_eq!(requested_schema.required, Some(vec!["choices".to_string()])); + + assert!(matches!( + requested_schema.properties.get("choices").unwrap(), + PrimitiveSchemaDefinition::Enum(EnumSchema::Multi(_)) + )); + + if let Some(PrimitiveSchemaDefinition::Enum(schema)) = + requested_schema.properties.get("choices") + { + assert_eq!( + schema, + &EnumSchema::Multi(MultiSelectEnumSchema::Titled( + TitledMultiSelectEnumSchema::new(TitledItems::new(vec![ + ConstTitle::new("A", "A name"), + ConstTitle::new("B", "B name"), + ConstTitle::new("C", "C name"), + ])) + .with_min_items(1) + .with_max_items(2) + )) + ) + } + } + _ => panic!("Expected FormElicitationParams variant"), + } +} + +/// Test elicitation with single-select enum schema +#[tokio::test] +async fn test_elicitation_single_select_enum() { + let enum_schema = EnumSchema::builder(vec!["A".into(), "B".into(), "C".into()]) + .enum_titles(vec![ + "A name".to_string(), + "B name".to_string(), + "C name".to_string(), + ]) + .expect("Number of title must match number of enum values") + .build(); + + let schema = ElicitationSchema::builder() + .required_enum_schema("choices", enum_schema) + .build() + .unwrap(); + + let request = ElicitRequestParams::FormElicitationParams { + meta: None, + message: "Please provide your user information".to_string(), + requested_schema: schema, + }; + + // Test that complex schemas serialize/deserialize correctly + let json = serde_json::to_value(&request).unwrap(); + let deserialized: ElicitRequestParams = serde_json::from_value(json).unwrap(); + + match deserialized { + ElicitRequestParams::FormElicitationParams { + message, + requested_schema, + .. + } => { + assert_eq!(message, "Please provide your user information"); + assert_eq!(requested_schema.properties.len(), 1); + assert!(requested_schema.properties.contains_key("choices")); + assert_eq!(requested_schema.required, Some(vec!["choices".to_string()])); + assert!(matches!( + requested_schema.properties.get("choices").unwrap(), + PrimitiveSchemaDefinition::Enum(EnumSchema::Single(_)) + )); + + if let Some(PrimitiveSchemaDefinition::Enum(schema)) = + requested_schema.properties.get("choices") + { + assert_eq!( + schema, + &EnumSchema::Single(SingleSelectEnumSchema::Titled( + TitledSingleSelectEnumSchema::new(vec![ + ConstTitle::new("A", "A name"), + ConstTitle::new("B", "B name"), + ConstTitle::new("C", "C name"), + ]) + )) + ) + } + } + _ => panic!("Expected FormElicitationParams variant"), + } +} + +// ============================================================================= +// ELICITATION DIRECTION TESTS (MCP 2025-06-18 COMPLIANCE) +// ============================================================================= + +/// Test that elicitation requests flow from server to client (not client to server) +/// This verifies compliance with MCP 2025-06-18 specification +#[cfg(all(feature = "client", feature = "server"))] +#[tokio::test] +async fn test_elicitation_direction_server_to_client() { + use rmcp::model::*; + use serde_json::json; + + // Test that server can create elicitation requests + let schema = ElicitationSchema::builder() + .property( + "name", + PrimitiveSchemaDefinition::String(StringSchema::new().description("Enter your name")), + ) + .build() + .unwrap(); + + let elicitation_request = ElicitRequestParams::FormElicitationParams { + meta: None, + message: "Please enter your name".to_string(), + requested_schema: schema, + }; + + // Verify request can be serialized + let serialized = serde_json::to_value(&elicitation_request).unwrap(); + assert_eq!(serialized["message"], "Please enter your name"); + assert_eq!(serialized["requestedSchema"]["type"], "object"); + + // Test that elicitation requests are part of ServerRequest + let _server_request = ServerRequest::ElicitRequest(ElicitRequest::new(elicitation_request)); + + // Test that client can respond with elicitation results + let client_result = ClientResult::ElicitResult( + ElicitResult::new(ElicitationAction::Accept).with_content(json!("John Doe")), + ); + + // Verify client result can be serialized + match client_result { + ClientResult::ElicitResult(result) => { + assert_eq!(result.action, ElicitationAction::Accept); + assert_eq!(result.content, Some(json!("John Doe"))); + } + _ => panic!("ElicitResult should be part of ClientResult"), + } +} + +/// Test complete JSON-RPC message flow: Server → Client → Server +#[cfg(all(feature = "client", feature = "server"))] +#[tokio::test] +async fn test_elicitation_json_rpc_direction() { + use rmcp::model::*; + use serde_json::json; + + let schema = ElicitationSchema::builder() + .property( + "continue", + PrimitiveSchemaDefinition::Boolean( + BooleanSchema::new().description("Do you want to continue?"), + ), + ) + .build() + .unwrap(); + + // 1. Server creates elicitation request + let server_request = ServerJsonRpcMessage::request( + ServerRequest::ElicitRequest(ElicitRequest::new( + ElicitRequestParams::FormElicitationParams { + meta: None, + message: "Do you want to continue?".to_string(), + requested_schema: schema, + }, + )), + RequestId::Number(1), + ); + + // Serialize server request + let server_json = serde_json::to_value(&server_request).unwrap(); + assert_eq!(server_json["method"], "elicitation/create"); + assert_eq!(server_json["id"], 1); + assert_eq!(server_json["params"]["message"], "Do you want to continue?"); + + // 2. Client responds with elicitation result + let client_response = ClientJsonRpcMessage::response( + ClientResult::ElicitResult( + ElicitResult::new(ElicitationAction::Accept).with_content(json!(true)), + ), + RequestId::Number(1), + ); + + // Serialize client response + let client_json = serde_json::to_value(&client_response).unwrap(); + assert_eq!(client_json["id"], 1); + if let Some(result) = client_json["result"].as_object() { + assert_eq!(result["action"], "accept"); + assert_eq!(result["content"], true); + } else { + panic!("Client response should contain result"); + } +} + +/// Test all three elicitation actions according to MCP spec +#[cfg(all(feature = "client", feature = "server"))] +#[tokio::test] +async fn test_elicitation_actions_compliance() { + use rmcp::model::*; + + // Test all three elicitation actions according to MCP spec + let actions = [ + ElicitationAction::Accept, + ElicitationAction::Decline, + ElicitationAction::Cancel, + ]; + + for action in actions { + let result = { + let r = ElicitResult::new(action.clone()); + match action { + ElicitationAction::Accept => r.with_content(serde_json::json!("some data")), + _ => r, + } + }; + + let json = serde_json::to_value(&result).unwrap(); + + match action { + ElicitationAction::Accept => { + assert_eq!(json["action"], "accept"); + assert!(json["content"].is_string()); + } + ElicitationAction::Decline => { + assert_eq!(json["action"], "decline"); + assert!(json.get("content").is_none() || json["content"].is_null()); + } + ElicitationAction::Cancel => { + assert_eq!(json["action"], "cancel"); + assert!(json.get("content").is_none() || json["content"].is_null()); + } + _ => {} + } + } +} + +/// Test that ElicitResult IS in ClientResult (response compliance) +#[tokio::test] +async fn test_elicitation_result_in_client_result() { + use rmcp::model::*; + + // Test that clients can return elicitation results + let result = ClientResult::ElicitResult(ElicitResult::new(ElicitationAction::Decline)); + + match result { + ClientResult::ElicitResult(elicit_result) => { + assert_eq!(elicit_result.action, ElicitationAction::Decline); + assert_eq!(elicit_result.content, None); + } + _ => panic!("ElicitResult should be part of ClientResult"), + } +} + +// ============================================================================= +// ELICITATION CAPABILITIES TESTS +// ============================================================================= + +/// Test ElicitationCapability structure and serialization +#[tokio::test] +async fn test_elicitation_capability_structure() { + // Test default ElicitationCapability + let default_cap = ElicitationCapability::default(); + assert!(default_cap.form.is_none()); + assert!(default_cap.url.is_none()); + + // Test ElicitationCapability with schema validation enabled + let cap_with_validation = ElicitationCapability::new() + .with_form(FormElicitationCapability::new().with_schema_validation(true)); + assert_eq!( + cap_with_validation.form.as_ref().unwrap().schema_validation, + Some(true) + ); + + // Test ElicitationCapability with schema validation disabled + let cap_without_validation = ElicitationCapability::new() + .with_form(FormElicitationCapability::new().with_schema_validation(false)); + assert_eq!( + cap_without_validation + .form + .as_ref() + .unwrap() + .schema_validation, + Some(false) + ); + + // Test JSON serialization + let json = serde_json::to_value(&cap_with_validation).unwrap(); + assert_eq!( + json, + serde_json::json!({ + "form": { + "schemaValidation": true + } + }) + ); + + // Test JSON deserialization + let deserialized: ElicitationCapability = serde_json::from_value(json).unwrap(); + assert_eq!( + deserialized.form.as_ref().unwrap().schema_validation, + Some(true) + ); +} + +/// Test ClientCapabilities with elicitation capability +#[tokio::test] +async fn test_client_capabilities_with_elicitation() { + // Test ClientCapabilities with elicitation capability + let capabilities = ClientCapabilities::builder() + .enable_elicitation_with( + ElicitationCapability::new() + .with_form(FormElicitationCapability::new().with_schema_validation(true)), + ) + .build(); + + // Verify elicitation capability is present + assert!(capabilities.elicitation.is_some()); + assert_eq!( + capabilities + .elicitation + .as_ref() + .unwrap() + .form + .as_ref() + .unwrap() + .schema_validation, + Some(true) + ); + + // Test JSON serialization + let json = serde_json::to_value(&capabilities).unwrap(); + assert!( + json["elicitation"]["form"]["schemaValidation"] + .as_bool() + .unwrap_or(false) + ); + + // Test ClientCapabilities without elicitation + let capabilities_without = ClientCapabilities::default(); + + assert!(capabilities_without.elicitation.is_none()); +} + +#[tokio::test] +async fn test_initialize_request_with_elicitation() { + let init_param = InitializeRequestParams::new( + ClientCapabilities::builder() + .enable_elicitation_with( + ElicitationCapability::new() + .with_form(FormElicitationCapability::new().with_schema_validation(true)), + ) + .build(), + Implementation::new("test-client", "1.0.0"), + ); + + // Verify the structure + assert!(init_param.capabilities.elicitation.is_some()); + assert_eq!( + init_param + .capabilities + .elicitation + .as_ref() + .unwrap() + .form + .as_ref() + .unwrap() + .schema_validation, + Some(true) + ); + + // Test JSON serialization + let json = serde_json::to_value(&init_param).unwrap(); + assert!( + json["capabilities"]["elicitation"]["form"]["schemaValidation"] + .as_bool() + .unwrap_or(false) + ); +} + +/// Test capability checking logic (simulated) +#[tokio::test] +async fn test_capability_checking_logic() { + // Simulate the logic that would be used in supports_elicitation() + + // Case 1: Client with elicitation capability + let client_with_capability = InitializeRequestParams::new( + ClientCapabilities::builder() + .enable_elicitation_with( + ElicitationCapability::new() + .with_form(FormElicitationCapability::new().with_schema_validation(true)), + ) + .build(), + Implementation::new("test-client", "1.0.0"), + ); + + // Simulate supports_elicitation() logic + let supports_elicitation = client_with_capability.capabilities.elicitation.is_some(); + assert!(supports_elicitation); + + // Case 2: Client without elicitation capability + let client_without_capability = InitializeRequestParams::new( + ClientCapabilities::default(), + Implementation::new("test-client", "1.0.0"), + ); + let supports_elicitation = client_without_capability.capabilities.elicitation.is_some(); + assert!(!supports_elicitation); +} + +/// Test CapabilityNotSupported error message formatting +#[tokio::test] +async fn test_capability_not_supported_error_message() { + let error = ElicitationError::CapabilityNotSupported; + let message = format!("{}", error); + + assert_eq!( + message, + "Client does not support elicitation - capability not declared during initialization" + ); +} + +/// Test all ElicitationError variants and their messages +#[tokio::test] +async fn test_elicitation_error_variants() { + // Test CapabilityNotSupported + let capability_error = ElicitationError::CapabilityNotSupported; + assert_eq!( + format!("{}", capability_error), + "Client does not support elicitation - capability not declared during initialization" + ); + + // Test UserDeclined + let user_declined = ElicitationError::UserDeclined; + assert_eq!( + format!("{}", user_declined), + "User explicitly declined the request" + ); + + // Test UserCancelled + let user_cancelled = ElicitationError::UserCancelled; + assert_eq!( + format!("{}", user_cancelled), + "User cancelled/dismissed the request" + ); + + // Test NoContent + let no_content = ElicitationError::NoContent; + assert_eq!(format!("{}", no_content), "No response content provided"); + + // Test Service error + let service_error = ElicitationError::Service(ServiceError::UnexpectedResponse); + let message = format!("{}", service_error); + assert!(message.starts_with("Service error:")); + + // Test ParseError + let json_error = serde_json::from_str::("\"not_an_integer\"").unwrap_err(); + let data = serde_json::json!({"key": "value"}); + let parse_error = ElicitationError::ParseError { + error: json_error, + data: data.clone(), + }; + let message = format!("{}", parse_error); + assert!(message.starts_with("Failed to parse response data:")); + assert!(message.contains("Received data:")); + + // Test error matching + match capability_error { + ElicitationError::CapabilityNotSupported => {} // Expected + _ => panic!("Should match CapabilityNotSupported"), + } + + match user_declined { + ElicitationError::UserDeclined => {} // Expected + _ => panic!("Should match UserDeclined"), + } + + match user_cancelled { + ElicitationError::UserCancelled => {} // Expected + _ => panic!("Should match UserCancelled"), + } + + match no_content { + ElicitationError::NoContent => {} // Expected + _ => panic!("Should match NoContent"), + } +} + +/// Test ElicitationCapability serialization with schema validation +#[tokio::test] +async fn test_elicitation_capability_serialization() { + use rmcp::model::ElicitationCapability; + + // Test default capability (no schema validation) + let default_cap = ElicitationCapability::default(); + let json = serde_json::to_value(&default_cap).unwrap(); + + // Should serialize to empty object when no fields are set + assert_eq!(json, serde_json::json!({})); + + // Test capability with schema validation enabled + let cap_with_validation = ElicitationCapability::new() + .with_form(FormElicitationCapability::new().with_schema_validation(true)); + let json = serde_json::to_value(&cap_with_validation).unwrap(); + + assert_eq!( + json, + serde_json::json!({ + "form": { + "schemaValidation": true + } + }) + ); + + // Test capability with schema validation disabled + let cap_without_validation = ElicitationCapability::new() + .with_form(FormElicitationCapability::new().with_schema_validation(false)); + let json = serde_json::to_value(&cap_without_validation).unwrap(); + + assert_eq!( + json, + serde_json::json!({ + "form": { + "schemaValidation": false + } + }) + ); + + // Test deserialization + let deserialized: ElicitationCapability = serde_json::from_value(serde_json::json!({ + "form":{"schemaValidation": true} + })) + .unwrap(); + + assert_eq!(deserialized.form.unwrap().schema_validation, Some(true)); +} + +/// Test ClientCapabilities builder with elicitation capability methods +#[tokio::test] +async fn test_client_capabilities_elicitation_builder() { + use rmcp::model::{ClientCapabilities, ElicitationCapability}; + + // Test enabling elicitation capability + let caps = ClientCapabilities::builder().enable_elicitation().build(); + + assert!(caps.elicitation.is_some()); + assert_eq!(caps.elicitation.as_ref().unwrap().form, None); + + // Test enabling elicitation with schema validation + let caps_with_validation = ClientCapabilities::builder() + .enable_elicitation() + .enable_elicitation_schema_validation() + .build(); + + assert!(caps_with_validation.elicitation.is_some()); + assert_eq!( + caps_with_validation + .elicitation + .as_ref() + .unwrap() + .form + .as_ref() + .unwrap() + .schema_validation, + Some(true) + ); + + // Test enabling elicitation with custom capability + let custom_elicitation = ElicitationCapability::new() + .with_form(FormElicitationCapability::new().with_schema_validation(false)); + + let caps_custom = ClientCapabilities::builder() + .enable_elicitation_with(custom_elicitation.clone()) + .build(); + + assert!(caps_custom.elicitation.is_some()); + assert_eq!( + caps_custom.elicitation.as_ref().unwrap(), + &custom_elicitation + ); +} + +// ============================================================================= +// TIMEOUT TESTS +// ============================================================================= + +/// Test basic timeout functionality for create_elicitation_with_timeout +#[tokio::test] +async fn test_create_elicitation_with_timeout_basic() { + use std::time::Duration; + + // This test verifies that the method accepts timeout parameter + let schema = ElicitationSchema::builder() + .required_property( + "name", + PrimitiveSchemaDefinition::String(StringSchema::new()), + ) + .required_property( + "email", + PrimitiveSchemaDefinition::String(StringSchema::new()), + ) + .build() + .unwrap(); + + let _params = ElicitRequestParams::FormElicitationParams { + meta: None, + message: "Enter your details".to_string(), + requested_schema: schema, + }; + + // Test different timeout values + let timeout_short = Duration::from_millis(100); + let timeout_long = Duration::from_secs(30); + let timeout_none: Option = None; + + // Verify timeout parameter types are correct + assert!(!timeout_short.is_zero()); + assert!(!timeout_long.is_zero()); + assert!(timeout_none.is_none()); + + // Verify timeout values are reasonable + assert_eq!(timeout_short.as_millis(), 100); + assert_eq!(timeout_long.as_secs(), 30); +} + +/// Test timeout behavior with elicit_with_timeout method +#[tokio::test] +async fn test_elicit_with_timeout_method_signature() { + use std::time::Duration; + + // Test that method signature works with different timeout values + let timeout_values = vec![ + None, + Some(Duration::from_millis(500)), + Some(Duration::from_secs(1)), + Some(Duration::from_secs(30)), + Some(Duration::from_secs(60)), + ]; + + for timeout in timeout_values { + // Verify timeout value is properly handled + match timeout { + None => assert!(timeout.is_none()), + Some(duration) => { + assert!(duration > Duration::from_millis(0)); + assert!(duration <= Duration::from_secs(300)); // Max 5 minutes + } + } + } +} + +/// Test timeout value validation +#[tokio::test] +async fn test_timeout_value_validation() { + use std::time::Duration; + + // Test valid timeout ranges + let valid_timeouts = vec![ + Duration::from_millis(1), // Minimum + Duration::from_millis(100), // Short + Duration::from_secs(1), // 1 second + Duration::from_secs(30), // 30 seconds + Duration::from_secs(300), // 5 minutes + ]; + + for timeout in valid_timeouts { + assert!(timeout >= Duration::from_millis(1)); + assert!(timeout <= Duration::from_secs(300)); + } + + // Test edge cases + let zero_timeout = Duration::from_millis(0); + let very_long_timeout = Duration::from_secs(3600); // 1 hour + + // Zero timeout should be handled gracefully + assert_eq!(zero_timeout, Duration::from_millis(0)); + + // Very long timeout should work but may not be practical + assert!(very_long_timeout > Duration::from_secs(300)); +} + +/// Test timeout error message formatting +#[tokio::test] +async fn test_timeout_error_formatting() { + use std::time::Duration; + + let timeout = Duration::from_secs(30); + + // Simulate a timeout error + let timeout_error = ServiceError::Timeout { timeout }; + + // Verify error contains timeout information + let error_string = format!("{}", timeout_error); + assert!(error_string.contains("timeout")); + assert!(error_string.contains("30")); +} + +/// Test elicitation error handling with timeout +#[tokio::test] +async fn test_elicitation_timeout_error_conversion() { + use std::time::Duration; + + let timeout = Duration::from_millis(500); + let service_timeout_error = ServiceError::Timeout { timeout }; + let elicitation_error = ElicitationError::Service(service_timeout_error); + + // Verify error chain is preserved + match elicitation_error { + ElicitationError::Service(ServiceError::Timeout { timeout: t }) => { + assert_eq!(t, timeout); + } + _ => panic!("Expected timeout error"), + } +} + +/// Test timeout parameter pass-through in PeerRequestOptions +#[tokio::test] +async fn test_peer_request_options_timeout() { + use std::time::Duration; + + let timeout = Some(Duration::from_secs(15)); + + let mut options = PeerRequestOptions::default(); + options.timeout = timeout; + + // Verify timeout is properly stored + assert_eq!(options.timeout, timeout); + assert!(options.meta.is_none()); + + // Test with no timeout + let options_no_timeout = PeerRequestOptions::default(); + + assert!(options_no_timeout.timeout.is_none()); +} + +/// Test realistic timeout scenarios +#[tokio::test] +async fn test_realistic_timeout_scenarios() { + use std::time::Duration; + + // Test common timeout scenarios users might encounter + + // Quick response (5 seconds) + let quick_timeout = Duration::from_secs(5); + assert!(quick_timeout >= Duration::from_secs(1)); + assert!(quick_timeout <= Duration::from_secs(10)); + + // Normal interaction (30 seconds) + let normal_timeout = Duration::from_secs(30); + assert!(normal_timeout >= Duration::from_secs(10)); + assert!(normal_timeout <= Duration::from_secs(60)); + + // Long form input (2 minutes) + let long_timeout = Duration::from_secs(120); + assert!(long_timeout >= Duration::from_secs(60)); + assert!(long_timeout <= Duration::from_secs(300)); +} + +/// Test that different ElicitationAction values map to correct error types +#[tokio::test] +async fn test_elicitation_action_error_mapping() { + use rmcp::{model::ElicitationAction, service::ElicitationError}; + + // Test that each action type produces the expected error + let test_cases = vec![ + (ElicitationAction::Decline, "UserDeclined"), + (ElicitationAction::Cancel, "UserCancelled"), + ]; + + for (action, _expected_error_type) in test_cases { + // Verify that the action exists and has the expected semantics + match action { + ElicitationAction::Accept => { + // Accept should not produce an error (it provides content) + } + ElicitationAction::Decline => { + // Should map to UserDeclined error + let error = ElicitationError::UserDeclined; + assert!(format!("{}", error).contains("explicitly declined")); + } + ElicitationAction::Cancel => { + // Should map to UserCancelled error + let error = ElicitationError::UserCancelled; + assert!(format!("{}", error).contains("cancelled/dismissed")); + } + _ => {} + } + } +} + +/// Test elicitation action semantics according to MCP specification +#[tokio::test] +async fn test_elicitation_action_semantics() { + use rmcp::model::ElicitationAction; + + // According to MCP spec: + // - Accept: User explicitly approved and submitted with data + // - Decline: User explicitly declined the request + // - Cancel: User dismissed without making an explicit choice + + // Test that all three actions are available + let actions = vec![ + ElicitationAction::Accept, + ElicitationAction::Decline, + ElicitationAction::Cancel, + ]; + + assert_eq!(actions.len(), 3); + + // Test serialization/deserialization + for action in actions { + let serialized = serde_json::to_string(&action).expect("Should serialize"); + let deserialized: ElicitationAction = + serde_json::from_str(&serialized).expect("Should deserialize"); + + // Actions should round-trip correctly + match (action, deserialized) { + (ElicitationAction::Accept, ElicitationAction::Accept) => {} + (ElicitationAction::Decline, ElicitationAction::Decline) => {} + (ElicitationAction::Cancel, ElicitationAction::Cancel) => {} + _ => panic!("Action serialization round-trip failed"), + } + } +} + +/// Test compile-time type safety for elicitation +#[tokio::test] +async fn test_elicitation_type_safety() { + use rmcp::service::ElicitationSafe; + use schemars::JsonSchema; + + // Test that our types implement ElicitationSafe + #[derive(serde::Serialize, serde::Deserialize, JsonSchema)] + struct SafeType { + name: String, + value: i32, + } + + rmcp::elicit_safe!(SafeType); + + // Verify that SafeType implements the required traits + fn assert_elicitation_safe() {} + assert_elicitation_safe::(); + + // Test that SafeType can generate schema (compile-time check) + let _schema = schemars::schema_for!(SafeType); +} + +/// Test that elicit_safe! macro works with multiple types +#[tokio::test] +async fn test_elicit_safe_macro() { + use schemars::JsonSchema; + + #[derive(serde::Serialize, serde::Deserialize, JsonSchema)] + struct TypeA { + field_a: String, + } + + #[derive(serde::Serialize, serde::Deserialize, JsonSchema)] + struct TypeB { + field_b: i32, + } + + #[derive(serde::Serialize, serde::Deserialize, JsonSchema)] + struct TypeC { + field_c: bool, + } + + // Test macro with multiple types + rmcp::elicit_safe!(TypeA, TypeB, TypeC); + + // All should implement ElicitationSafe + fn assert_all_safe() {} + assert_all_safe::(); + assert_all_safe::(); + assert_all_safe::(); +} + +/// Test ElicitationSafe trait behavior +#[tokio::test] +async fn test_elicitation_safe_trait() { + use schemars::JsonSchema; + + // Test object type validation + #[derive(serde::Serialize, serde::Deserialize, JsonSchema)] + struct ObjectType { + name: String, + count: usize, + active: bool, + } + + rmcp::elicit_safe!(ObjectType); + + // Test that ObjectType can generate schema (compile-time check) + let _schema = schemars::schema_for!(ObjectType); +} + +/// Test documentation examples compile correctly +#[tokio::test] +async fn test_elicitation_examples_compile() { + use schemars::JsonSchema; + use serde::{Deserialize, Serialize}; + + // Example from trait documentation + #[allow(dead_code)] + #[derive(Serialize, Deserialize, JsonSchema)] + struct UserProfile { + name: String, + email: String, + } + + rmcp::elicit_safe!(UserProfile); + + // This should compile and work + fn _example_usage() { + fn _assert_safe() {} + _assert_safe::(); + } +} + +// ============================================================================= +// BUILD-TIME VALIDATION TESTS +// ============================================================================= + +/// Test that build() validates required fields exist in properties +#[tokio::test] +async fn test_build_validation_required_field_not_in_properties() { + // Try to mark a field as required that doesn't exist in properties + let result = ElicitationSchema::builder() + .property( + "email", + PrimitiveSchemaDefinition::String(StringSchema::email()), + ) + .mark_required("nonexistent_field") + .build(); + + // Should return an error + assert!(result.is_err()); + assert_eq!( + result.unwrap_err(), + "Required field does not exist in properties" + ); +} + +/// Test that build() succeeds when all required fields exist +#[tokio::test] +async fn test_build_validation_required_field_exists() { + let result = ElicitationSchema::builder() + .property( + "email", + PrimitiveSchemaDefinition::String(StringSchema::email()), + ) + .property( + "name", + PrimitiveSchemaDefinition::String(StringSchema::new()), + ) + .mark_required("email") + .mark_required("name") + .build(); + + // Should succeed + assert!(result.is_ok()); + let schema = result.unwrap(); + assert_eq!(schema.properties.len(), 2); + assert_eq!( + schema.required, + Some(vec!["email".to_string(), "name".to_string()]) + ); +} + +/// Test that build_unchecked() panics on validation errors +#[tokio::test] +#[should_panic(expected = "Invalid elicitation schema")] +async fn test_build_unchecked_panics_on_invalid() { + // build_unchecked validates but panics instead of returning Result + let _schema = ElicitationSchema::builder() + .property( + "email", + PrimitiveSchemaDefinition::String(StringSchema::email()), + ) + .mark_required("nonexistent_field") + .build_unchecked(); +} + +/// Test convenience methods handle validation correctly +#[tokio::test] +async fn test_convenience_methods_validation() { + // required_string_property should add both property and mark as required + let result = ElicitationSchema::builder() + .required_string_property("name", |s| s) + .required_email("email") + .build(); + + assert!(result.is_ok()); + let schema = result.unwrap(); + assert_eq!(schema.properties.len(), 2); + assert!( + schema + .required + .as_ref() + .unwrap() + .contains(&"name".to_string()) + ); + assert!( + schema + .required + .as_ref() + .unwrap() + .contains(&"email".to_string()) + ); +} + +/// Test typed property methods work correctly +#[tokio::test] +async fn test_typed_property_methods() { + let result = ElicitationSchema::builder() + .string_property("name", |s| s.length(1, 100)) + .number_property("price", |n| n.range(0.0, 1000.0)) + .integer_property("quantity", |i| i.range(1, 100)) + .bool_property("in_stock", |b| b.with_default(true)) + .build(); + + assert!(result.is_ok()); + let schema = result.unwrap(); + assert_eq!(schema.properties.len(), 4); + + // Verify types are correct + if let Some(PrimitiveSchemaDefinition::String(_)) = schema.properties.get("name") { + // Expected + } else { + panic!("name should be StringSchema"); + } + + if let Some(PrimitiveSchemaDefinition::Number(_)) = schema.properties.get("price") { + // Expected + } else { + panic!("price should be NumberSchema"); + } + + if let Some(PrimitiveSchemaDefinition::Integer(_)) = schema.properties.get("quantity") { + // Expected + } else { + panic!("quantity should be IntegerSchema"); + } + + if let Some(PrimitiveSchemaDefinition::Boolean(_)) = schema.properties.get("in_stock") { + // Expected + } else { + panic!("in_stock should be BooleanSchema"); + } +} + +/// Test required typed property methods +#[tokio::test] +async fn test_required_typed_property_methods() { + let result = ElicitationSchema::builder() + .required_string_property("name", |s| s) + .required_number_property("price", |n| n) + .required_integer_property("age", |i| i) + .required_bool_property("active", |b| b) + .build(); + + assert!(result.is_ok()); + let schema = result.unwrap(); + assert_eq!(schema.properties.len(), 4); + assert_eq!(schema.required.as_ref().unwrap().len(), 4); + + // All should be marked as required + let required = schema.required.as_ref().unwrap(); + assert!(required.contains(&"name".to_string())); + assert!(required.contains(&"price".to_string())); + assert!(required.contains(&"age".to_string())); + assert!(required.contains(&"active".to_string())); +} + +// ============================================================================= +// URL ELICITATION TESTS +// ============================================================================= + +/// Test URL elicitation request parameter serialization/deserialization +#[tokio::test] +async fn test_url_elicitation_request_param_serialization() { + let request_param = ElicitRequestParams::UrlElicitationParams { + meta: None, + message: "Please visit the following URL to complete verification".to_string(), + url: "https://example.com/verify".to_string(), + elicitation_id: "elicit-123".to_string(), + }; + + // Test serialization + let json = serde_json::to_value(&request_param).unwrap(); + let expected = json!({ + "mode": "url", + "message": "Please visit the following URL to complete verification", + "url": "https://example.com/verify", + "elicitationId": "elicit-123" + }); + + assert_eq!(json, expected); + + // Test deserialization + let deserialized: ElicitRequestParams = serde_json::from_value(expected).unwrap(); + match deserialized { + ElicitRequestParams::UrlElicitationParams { + message, + url, + elicitation_id, + .. + } => { + assert_eq!( + message, + "Please visit the following URL to complete verification" + ); + assert_eq!(url, "https://example.com/verify"); + assert_eq!(elicitation_id, "elicit-123"); + } + _ => panic!("Expected UrlElicitationParams variant"), + } +} + +/// Test URL elicitation request in JSON-RPC protocol +#[tokio::test] +async fn test_url_elicitation_json_rpc_protocol() { + // Create a complete JSON-RPC request for URL elicitation + let request = JsonRpcRequest { + jsonrpc: JsonRpcVersion2_0, + id: RequestId::Number(1), + request: ElicitRequest::new(ElicitRequestParams::UrlElicitationParams { + meta: None, + message: "Please authorize this action at the following URL".to_string(), + url: "https://auth.example.com/authorize/abc123".to_string(), + elicitation_id: "auth-request-456".to_string(), + }), + }; + + // Test serialization of complete request + let json = serde_json::to_value(&request).unwrap(); + assert_eq!(json["jsonrpc"], "2.0"); + assert_eq!(json["id"], 1); + assert_eq!(json["method"], "elicitation/create"); + assert_eq!(json["params"]["mode"], "url"); + assert_eq!( + json["params"]["message"], + "Please authorize this action at the following URL" + ); + assert_eq!( + json["params"]["url"], + "https://auth.example.com/authorize/abc123" + ); + assert_eq!(json["params"]["elicitationId"], "auth-request-456"); + + // Test deserialization + let deserialized: JsonRpcRequest = serde_json::from_value(json).unwrap(); + assert_eq!(deserialized.id, RequestId::Number(1)); + match &deserialized.request.params { + ElicitRequestParams::UrlElicitationParams { + message, + url, + elicitation_id, + .. + } => { + assert_eq!(message, "Please authorize this action at the following URL"); + assert_eq!(url, "https://auth.example.com/authorize/abc123"); + assert_eq!(elicitation_id, "auth-request-456"); + } + _ => panic!("Expected UrlElicitationParams variant"), + } +} + +/// Test UrlElicitationCapability structure and serialization +#[tokio::test] +async fn test_url_elicitation_capability() { + // Test default UrlElicitationCapability + let url_cap = UrlElicitationCapability::default(); + + // Test serialization - should be empty object + let json = serde_json::to_value(&url_cap).unwrap(); + assert_eq!(json, json!({})); + + // Test deserialization + let deserialized: UrlElicitationCapability = serde_json::from_value(json!({})).unwrap(); + assert_eq!(deserialized, url_cap); + + // Test ElicitationCapability with URL mode enabled + let elicitation_cap = ElicitationCapability::new().with_url(UrlElicitationCapability::new()); + + let json = serde_json::to_value(&elicitation_cap).unwrap(); + assert_eq!( + json, + json!({ + "url": {} + }) + ); + + // Test ElicitationCapability with both form and URL modes + let both_cap = ElicitationCapability::new() + .with_form(FormElicitationCapability::new().with_schema_validation(true)) + .with_url(UrlElicitationCapability::new()); + + let json = serde_json::to_value(&both_cap).unwrap(); + assert_eq!( + json, + json!({ + "form": { + "schemaValidation": true + }, + "url": {} + }) + ); +} + +/// Test backward compatibility: ElicitRequestParams without mode tag +#[tokio::test] +async fn test_elicitation_backward_compatibility_no_mode() { + let json_without_mode = json!({ + "message": "Please enter your details", + "requestedSchema": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + }, + "required": ["name"] + } + }); + + let deserialized: ElicitRequestParams = serde_json::from_value(json_without_mode).unwrap(); + + match deserialized { + ElicitRequestParams::FormElicitationParams { + message, + requested_schema, + .. + } => { + assert_eq!(message, "Please enter your details"); + assert_eq!(requested_schema.properties.len(), 1); + assert!(requested_schema.properties.contains_key("name")); + } + _ => panic!("Expected FormElicitationParams for backward compatibility"), + } +} + +/// Test both form and URL elicitation modes in the same test +#[tokio::test] +async fn test_elicitation_both_modes() { + // Form mode + let form_schema = ElicitationSchema::builder() + .required_property( + "email", + PrimitiveSchemaDefinition::String(StringSchema::email()), + ) + .build() + .unwrap(); + + let form_request = ElicitRequestParams::FormElicitationParams { + meta: None, + message: "Enter email".to_string(), + requested_schema: form_schema, + }; + + let form_json = serde_json::to_value(&form_request).unwrap(); + assert_eq!(form_json["mode"], "form"); + assert!(form_json.get("requestedSchema").is_some()); + assert!(form_json.get("url").is_none()); + + // URL mode + let url_request = ElicitRequestParams::UrlElicitationParams { + meta: None, + message: "Visit URL".to_string(), + url: "https://example.com".to_string(), + elicitation_id: "id-123".to_string(), + }; + + let url_json = serde_json::to_value(&url_request).unwrap(); + assert_eq!(url_json["mode"], "url"); + assert!(url_json.get("url").is_some()); + assert!(url_json.get("elicitationId").is_some()); + assert!(url_json.get("requestedSchema").is_none()); +} + +/// Test ClientCapabilities with different elicitation mode combinations +#[tokio::test] +async fn test_client_capabilities_elicitation_modes() { + // Test with form-only capability + let form_only_caps = ClientCapabilities::builder() + .enable_elicitation_with( + ElicitationCapability::new() + .with_form(FormElicitationCapability::new().with_schema_validation(true)), + ) + .build(); + + let json = serde_json::to_value(&form_only_caps).unwrap(); + assert!(json["elicitation"]["form"].is_object()); + assert!( + json["elicitation"]["url"].is_null() + || !json["elicitation"].as_object().unwrap().contains_key("url") + ); + + // Test with URL-only capability + let url_only_caps = ClientCapabilities::builder() + .enable_elicitation_with( + ElicitationCapability::new().with_url(UrlElicitationCapability::new()), + ) + .build(); + + let json = serde_json::to_value(&url_only_caps).unwrap(); + assert!(json["elicitation"]["url"].is_object()); + assert!( + json["elicitation"]["form"].is_null() + || !json["elicitation"] + .as_object() + .unwrap() + .contains_key("form") + ); + + // Test with both capabilities + let both_caps = ClientCapabilities::builder() + .enable_elicitation_with( + ElicitationCapability::new() + .with_form(FormElicitationCapability::new().with_schema_validation(false)) + .with_url(UrlElicitationCapability::new()), + ) + .build(); + + let json = serde_json::to_value(&both_caps).unwrap(); + assert!(json["elicitation"]["form"].is_object()); + assert!(json["elicitation"]["url"].is_object()); +} + +/// Test ElicitationAction with URL elicitation workflow +#[tokio::test] +async fn test_url_elicitation_action_workflow() { + // Test Accept action for URL elicitation (user visited URL and confirmed) + let accept_result = ElicitResult::new(ElicitationAction::Accept); + + let json = serde_json::to_value(&accept_result).unwrap(); + assert_eq!(json["action"], "accept"); + // content should be omitted when None + assert!(json.get("content").is_none() || json["content"].is_null()); + + // Test Decline action for URL elicitation + let decline_result = ElicitResult::new(ElicitationAction::Decline); + + let json = serde_json::to_value(&decline_result).unwrap(); + assert_eq!(json["action"], "decline"); + + // Test Cancel action for URL elicitation + let cancel_result = ElicitResult::new(ElicitationAction::Cancel); + + let json = serde_json::to_value(&cancel_result).unwrap(); + assert_eq!(json["action"], "cancel"); +} + +/// Test method constants for URL elicitation +#[tokio::test] +async fn test_elicitation_method_constants() { + // Test existing methods + assert_eq!(ElicitationCreateRequestMethod::VALUE, "elicitation/create"); + assert_eq!( + ElicitationResponseNotificationMethod::VALUE, + "notifications/elicitation/response" + ); +} diff --git a/vendor/rmcp/tests/test_embedded_resource_meta.rs b/vendor/rmcp/tests/test_embedded_resource_meta.rs new file mode 100644 index 00000000..5854f3f5 --- /dev/null +++ b/vendor/rmcp/tests/test_embedded_resource_meta.rs @@ -0,0 +1,114 @@ +use rmcp::model::{ContentBlock, EmbeddedResource, MetaObject, ResourceContents}; +use serde_json::json; + +#[test] +fn serialize_embedded_text_resource_with_meta() { + let mut resource_content_meta = MetaObject::new(); + resource_content_meta.insert("inner".to_string(), json!(2)); + + let mut resource_meta = MetaObject::new(); + resource_meta.insert("top".to_string(), json!(1)); + + let content = ContentBlock::Resource( + EmbeddedResource::new(ResourceContents::TextResourceContents { + uri: "str://example".to_string(), + mime_type: Some("text/plain".to_string()), + text: "hello".to_string(), + meta: Some(resource_content_meta), + }) + .with_meta(resource_meta), + ); + + let v = serde_json::to_value(&content).unwrap(); + + let expected = json!({ + "type": "resource", + "_meta": {"top": 1}, + "resource": { + "uri": "str://example", + "mimeType": "text/plain", + "text": "hello", + "_meta": {"inner": 2} + } + }); + + assert_eq!(v, expected); +} + +#[test] +fn serialize_embedded_text_resource_without_meta_omits_fields() { + let content = ContentBlock::Resource(EmbeddedResource::new( + ResourceContents::TextResourceContents { + uri: "str://no-meta".to_string(), + mime_type: Some("text/plain".to_string()), + text: "hi".to_string(), + meta: None, + }, + )); + + let v = serde_json::to_value(&content).unwrap(); + + assert_eq!(v.get("_meta"), None); + let inner = v.get("resource").and_then(|r| r.as_object()).unwrap(); + assert_eq!(inner.get("_meta"), None); +} + +#[test] +fn deserialize_embedded_text_resource_with_meta() { + let raw = json!({ + "type": "resource", + "_meta": {"x": true}, + "resource": { + "uri": "str://from-json", + "text": "ok", + "_meta": {"y": 42} + } + }); + + let content: ContentBlock = serde_json::from_value(raw).unwrap(); + + let er = match &content { + ContentBlock::Resource(er) => er, + _ => panic!("expected resource"), + }; + + let top = er.meta.as_ref().expect("top-level meta missing"); + assert_eq!(top.get("x").unwrap(), &json!(true)); + + match &er.resource { + ResourceContents::TextResourceContents { + meta, uri, text, .. + } => { + assert_eq!(uri, "str://from-json"); + assert_eq!(text, "ok"); + let inner = meta.as_ref().expect("inner meta missing"); + assert_eq!(inner.get("y").unwrap(), &json!(42)); + } + _ => panic!("expected text resource contents"), + } +} + +#[test] +fn serialize_embedded_blob_resource_with_meta() { + let mut resource_content_meta = MetaObject::new(); + resource_content_meta.insert("blob_inner".to_string(), json!(true)); + + let mut resource_meta = MetaObject::new(); + resource_meta.insert("blob_top".to_string(), json!("t")); + + let content = ContentBlock::Resource( + EmbeddedResource::new(ResourceContents::BlobResourceContents { + uri: "str://blob".to_string(), + mime_type: Some("application/octet-stream".to_string()), + blob: "Zm9v".to_string(), + meta: Some(resource_content_meta), + }) + .with_meta(resource_meta), + ); + + let v = serde_json::to_value(&content).unwrap(); + + assert_eq!(v.get("_meta").unwrap(), &json!({"blob_top": "t"})); + let inner = v.get("resource").unwrap(); + assert_eq!(inner.get("_meta").unwrap(), &json!({"blob_inner": true})); +} diff --git a/vendor/rmcp/tests/test_handler_cache_hints.rs b/vendor/rmcp/tests/test_handler_cache_hints.rs new file mode 100644 index 00000000..ed3cf676 --- /dev/null +++ b/vendor/rmcp/tests/test_handler_cache_hints.rs @@ -0,0 +1,122 @@ +#![cfg(not(feature = "local"))] +#![cfg(feature = "client")] + +use rmcp::{ + ClientHandler, RoleClient, RoleServer, ServerHandler, + handler::server::router::{prompt::PromptRouter, tool::ToolRouter}, + model::{ + CacheScope, ClientConfig, InitializeResult, ListPromptsResult, ListToolsResult, + ProtocolVersion, + }, + prompt_handler, + service::serve_directly, + tool_handler, +}; + +#[derive(Debug, Clone)] +struct CacheHintServer { + tool_router: ToolRouter, + prompt_router: PromptRouter, +} + +impl CacheHintServer { + fn new() -> Self { + Self { + tool_router: ToolRouter::new(), + prompt_router: PromptRouter::new(), + } + } +} + +#[tool_handler(router = self.tool_router)] +#[prompt_handler(router = self.prompt_router)] +impl ServerHandler for CacheHintServer {} + +#[derive(Debug, Clone)] +struct VersionedClient { + protocol_version: ProtocolVersion, +} + +impl ClientHandler for VersionedClient { + fn get_info(&self) -> ClientConfig { + let mut info = ClientConfig::default(); + info.protocol_version = self.protocol_version.clone(); + info + } +} + +/// Wires the pair up directly on `protocol_version`. `2026-07-28` removed the +/// `initialize` handshake, so a peer on that revision is reached the way the +/// discover lifecycle leaves one: with the version already agreed. +async fn list_results(protocol_version: ProtocolVersion) -> (ListToolsResult, ListPromptsResult) { + let (server_transport, client_transport) = tokio::io::duplex(4096); + + let client_handler = VersionedClient { + protocol_version: protocol_version.clone(), + }; + let mut server_peer_info = InitializeResult::default(); + server_peer_info.protocol_version = protocol_version; + + let server = serve_directly::( + CacheHintServer::new(), + server_transport, + Some(client_handler.get_info()), + ); + let server_handle = tokio::spawn(async move { + server.waiting().await?; + anyhow::Ok(()) + }); + + let client = serve_directly::( + client_handler, + client_transport, + Some(server_peer_info.into()), + ); + let tools = client + .list_tools(None) + .await + .expect("tools/list should succeed"); + let prompts = client + .list_prompts(None) + .await + .expect("prompts/list should succeed"); + + client.cancel().await.expect("client should cancel"); + server_handle.await.expect("server task").expect("server"); + (tools, prompts) +} + +#[tokio::test] +async fn handler_macros_should_emit_required_cache_hints_for_2026_07_28() { + let (tools, prompts) = list_results(ProtocolVersion::V_2026_07_28).await; + + assert_eq!( + ( + tools.ttl_ms, + tools.cache_scope, + prompts.ttl_ms, + prompts.cache_scope, + ), + ( + Some(0), + Some(CacheScope::Public), + Some(0), + Some(CacheScope::Public), + ) + ); +} + +#[tokio::test] +async fn handler_macros_should_omit_cache_hints_for_legacy_versions() { + let (tools, prompts) = list_results(ProtocolVersion::V_2025_11_25).await; + + assert_eq!( + ( + tools.ttl_ms, + tools.cache_scope, + prompts.ttl_ms, + prompts.cache_scope, + ), + (None, None, None, None) + ); +} diff --git a/vendor/rmcp/tests/test_handler_wrappers.rs b/vendor/rmcp/tests/test_handler_wrappers.rs new file mode 100644 index 00000000..18ec242b --- /dev/null +++ b/vendor/rmcp/tests/test_handler_wrappers.rs @@ -0,0 +1,31 @@ +// cargo test --test test_handler_wrappers --features "client server" + +mod common; + +use std::sync::Arc; + +use common::handlers::TestServer; +use rmcp::ServerHandler; + +#[test] +fn test_wrapped_server_handlers() { + // This test asserts that, when T: ServerHandler, both Box and Arc also implement ServerHandler. + fn accepts_server_handler(_handler: H) {} + + accepts_server_handler(Box::new(TestServer::new())); + accepts_server_handler(Arc::new(TestServer::new())); +} + +#[cfg(feature = "client")] +#[test] +fn test_wrapped_client_handlers() { + use common::handlers::TestClientHandler; + use rmcp::ClientHandler; + // This test asserts that, when T: ClientHandler, both Box and Arc also implement ClientHandler. + fn accepts_client_handler(_handler: H) {} + + let client = TestClientHandler::new(false, false); + + accepts_client_handler(Box::new(client.clone())); + accepts_client_handler(Arc::new(client)); +} diff --git a/vendor/rmcp/tests/test_inflight_response_drain.rs b/vendor/rmcp/tests/test_inflight_response_drain.rs new file mode 100644 index 00000000..fc5908f1 --- /dev/null +++ b/vendor/rmcp/tests/test_inflight_response_drain.rs @@ -0,0 +1,159 @@ +#![cfg(all(feature = "client", feature = "server", not(feature = "local")))] +// cargo test --test test_inflight_response_drain --features "client server" + +use std::{ + pin::Pin, + sync::{ + Arc, + atomic::{AtomicBool, Ordering}, + }, + task::{Context, Poll}, + time::Duration, +}; + +use rmcp::{ + ServerHandler, ServiceExt, + handler::server::{router::tool::ToolRouter, wrapper::Parameters}, + model::{CallToolRequestParams, ClientConfig, ServerCapabilities, ServerConfig}, + service::QuitReason, + tool, tool_handler, tool_router, +}; +use tokio::io::{AsyncRead, ReadBuf}; + +// A slow tool server that sleeps before returning a response. +#[derive(Debug, Clone)] +struct SlowToolServer { + #[expect(dead_code, reason = "tool_handler macro accesses this router field")] + tool_router: ToolRouter, +} + +impl SlowToolServer { + fn new() -> Self { + Self { + tool_router: Self::tool_router(), + } + } +} + +#[derive(Debug, serde::Deserialize, schemars::JsonSchema)] +struct SlowToolRequest { + #[schemars(description = "how long to sleep in milliseconds")] + sleep_ms: u64, +} + +#[tool_router] +impl SlowToolServer { + #[tool(description = "A tool that sleeps then returns")] + async fn slow_tool( + &self, + Parameters(SlowToolRequest { sleep_ms }): Parameters, + ) -> String { + tokio::time::sleep(Duration::from_millis(sleep_ms)).await; + format!("done after {}ms", sleep_ms) + } +} + +#[tool_handler] +impl ServerHandler for SlowToolServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::builder().enable_tools().build()) + } +} + +#[derive(Debug, Clone, Default)] +struct DummyClientHandler; + +impl rmcp::ClientHandler for DummyClientHandler { + fn get_info(&self) -> ClientConfig { + ClientConfig::default() + } +} + +/// An `AsyncRead` wrapper that delegates to the inner reader until signalled, +/// then returns EOF (read 0 bytes). +struct ClosableReader { + inner: R, + eof_flag: Arc, +} + +impl AsyncRead for ClosableReader { + fn poll_read( + mut self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &mut ReadBuf<'_>, + ) -> Poll> { + if self.eof_flag.load(Ordering::Acquire) { + return Poll::Ready(Ok(())); + } + Pin::new(&mut self.inner).poll_read(cx, buf) + } +} + +/// When the server's input stream returns EOF while a tool handler is still +/// in-flight, the drain phase should flush pending responses before closing. +#[tokio::test] +async fn test_inflight_response_drain_on_eof() -> anyhow::Result<()> { + // Two unidirectional channels: + // client_write → server_read (client sends requests to server) + // server_write → client_read (server sends responses to client) + let (client_write, server_read) = tokio::io::duplex(4096); + let (server_write, client_read) = tokio::io::duplex(4096); + + // Wrap the server's read side so we can signal EOF from the test. + let eof_flag = Arc::new(AtomicBool::new(false)); + let closable_read = ClosableReader { + inner: server_read, + eof_flag: eof_flag.clone(), + }; + + let server_transport = (closable_read, server_write); + let client_transport = (client_read, client_write); + + // Start server with slow tool handler + let server_handle = tokio::spawn(async move { + let server = SlowToolServer::new(); + let running = server.serve(server_transport).await?; + let reason = running.waiting().await?; + assert!( + matches!(reason, QuitReason::Closed), + "expected Closed quit reason, got {:?}", + reason, + ); + anyhow::Ok(()) + }); + + // Start client + let client = DummyClientHandler.serve(client_transport).await?; + + // Call the slow tool (200ms sleep). Concurrently, signal the server's + // read side to return EOF after the request has been sent but before + // the handler finishes. + let tool_future = client.call_tool( + CallToolRequestParams::new("slow_tool").with_arguments( + serde_json::json!({ "sleep_ms": 200 }) + .as_object() + .unwrap() + .clone(), + ), + ); + + let (tool_result, _) = tokio::join!(tool_future, async { + // Wait for the request to be sent and received by the server, + // then signal EOF on the server's read side. + tokio::time::sleep(Duration::from_millis(50)).await; + eof_flag.store(true, Ordering::Release); + }); + + // The tool result should still arrive thanks to the drain phase. + let result = tool_result?; + let text = result + .content + .first() + .and_then(|c| c.as_text()) + .map(|t| t.text.as_str()) + .expect("expected text content in tool result"); + assert_eq!(text, "done after 200ms"); + + server_handle.await??; + Ok(()) +} diff --git a/vendor/rmcp/tests/test_json_schema_detection.rs b/vendor/rmcp/tests/test_json_schema_detection.rs new file mode 100644 index 00000000..e13125c4 --- /dev/null +++ b/vendor/rmcp/tests/test_json_schema_detection.rs @@ -0,0 +1,188 @@ +#![allow(clippy::exhaustive_structs)] +//cargo test --test test_json_schema_detection --features "client server macros" +use rmcp::{ + Json, ServerHandler, handler::server::router::tool::ToolRouter, tool, tool_handler, tool_router, +}; +use schemars::JsonSchema; +use serde::{Deserialize, Serialize}; + +#[derive(Serialize, Deserialize, JsonSchema)] +pub struct TestData { + pub value: String, +} + +#[tool_handler(router = self.tool_router)] +impl ServerHandler for TestServer {} + +#[derive(Debug, Clone)] +pub struct TestServer { + tool_router: ToolRouter, +} + +impl Default for TestServer { + fn default() -> Self { + Self::new() + } +} + +#[tool_router(router = tool_router)] +impl TestServer { + pub fn new() -> Self { + Self { + tool_router: Self::tool_router(), + } + } + + /// Tool that returns Json - should have output schema + #[tool(name = "with-json")] + pub async fn with_json(&self) -> Result, String> { + Ok(Json(TestData { + value: "test".to_string(), + })) + } + + /// Tool that returns regular type - should NOT have output schema + #[tool(name = "without-json")] + pub async fn without_json(&self) -> Result { + Ok("test".to_string()) + } + + /// Tool that returns Result with inner Json - should have output schema + #[tool(name = "result-with-json")] + pub async fn result_with_json(&self) -> Result, rmcp::ErrorData> { + Ok(Json(TestData { + value: "test".to_string(), + })) + } + + /// Tool with explicit output_schema attribute - should have output schema + #[tool(name = "explicit-schema", output_schema = rmcp::handler::server::tool::schema_for_type::())] + pub async fn explicit_schema(&self) -> Result { + Ok("test".to_string()) + } + + /// Tool that returns Json> - array output schema + #[tool(name = "with-json-array")] + pub async fn with_json_array(&self) -> Result>, String> { + Ok(Json(vec![TestData { + value: "test".to_string(), + }])) + } + + /// Tool that returns Result>, ErrorData> - array output schema + #[tool(name = "result-with-json-array")] + pub async fn result_with_json_array(&self) -> Result>, rmcp::ErrorData> { + Ok(Json(vec![TestData { + value: "test".to_string(), + }])) + } + + /// Tool that returns Json - string output schema + #[tool(name = "with-json-string")] + pub async fn with_json_string(&self) -> Result, String> { + Ok(Json("test".to_string())) + } +} + +#[tokio::test] +async fn test_json_type_generates_schema() { + let server = TestServer::new(); + let tools = server.tool_router.list_all(); + + // Find the with-json tool + let json_tool = tools.iter().find(|t| t.name == "with-json").unwrap(); + assert!( + json_tool.output_schema.is_some(), + "Json return type should generate output schema" + ); +} + +#[tokio::test] +async fn test_non_json_type_no_schema() { + let server = TestServer::new(); + let tools = server.tool_router.list_all(); + + // Find the without-json tool + let non_json_tool = tools.iter().find(|t| t.name == "without-json").unwrap(); + assert!( + non_json_tool.output_schema.is_none(), + "Regular return type should NOT generate output schema" + ); +} + +#[tokio::test] +async fn test_result_with_json_generates_schema() { + let server = TestServer::new(); + let tools = server.tool_router.list_all(); + + // Find the result-with-json tool + let result_json_tool = tools.iter().find(|t| t.name == "result-with-json").unwrap(); + assert!( + result_json_tool.output_schema.is_some(), + "Result, E> return type should generate output schema" + ); +} + +#[tokio::test] +async fn test_explicit_schema_override() { + let server = TestServer::new(); + let tools = server.tool_router.list_all(); + + // Find the explicit-schema tool + let explicit_tool = tools.iter().find(|t| t.name == "explicit-schema").unwrap(); + assert!( + explicit_tool.output_schema.is_some(), + "Explicit output_schema attribute should work" + ); +} + +#[tokio::test] +async fn test_json_array_type_generates_schema() { + let server = TestServer::new(); + let tools = server.tool_router.list_all(); + + let array_tool = tools.iter().find(|t| t.name == "with-json-array").unwrap(); + assert!( + array_tool.output_schema.is_some(), + "Json> return type should generate output schema" + ); + let schema = array_tool.output_schema.as_ref().unwrap(); + assert_eq!( + schema.get("type").and_then(|v| v.as_str()), + Some("array"), + "Json> should produce an array schema" + ); +} + +#[tokio::test] +async fn test_result_with_json_array_generates_schema() { + let server = TestServer::new(); + let tools = server.tool_router.list_all(); + + let result_array_tool = tools + .iter() + .find(|t| t.name == "result-with-json-array") + .unwrap(); + assert!( + result_array_tool.output_schema.is_some(), + "Result>, ErrorData> return type should generate output schema" + ); +} + +#[tokio::test] +async fn test_json_string_type_generates_schema() { + let server = TestServer::new(); + let tools = server.tool_router.list_all(); + + let string_tool = tools.iter().find(|t| t.name == "with-json-string").unwrap(); + assert!( + string_tool.output_schema.is_some(), + "Json return type should generate output schema" + ); + let schema = string_tool.output_schema.as_ref().unwrap(); + assert_eq!( + schema.get("type").and_then(|v| v.as_str()), + Some("string"), + "Json should produce a string schema" + ); +} diff --git a/vendor/rmcp/tests/test_list_tools_result.rs b/vendor/rmcp/tests/test_list_tools_result.rs new file mode 100644 index 00000000..4d8dc70a --- /dev/null +++ b/vendor/rmcp/tests/test_list_tools_result.rs @@ -0,0 +1,48 @@ +#![cfg(all(feature = "server", feature = "macros", not(feature = "local")))] + +use rmcp::{ + Json, + handler::server::wrapper::Parameters, + model::{ListToolsResult, NumberOrString, ServerJsonRpcMessage, ServerResult}, +}; + +/// Parameters for adding two numbers. +#[derive(Debug, serde::Deserialize, schemars::JsonSchema)] +struct AddRequest { + /// The left-hand number. + a: f64, + /// The right-hand number. + b: f64, +} + +/// Result of adding two numbers. +#[derive(Debug, serde::Serialize, schemars::JsonSchema)] +struct AddResult { + /// The sum of the two numbers. + sum: f64, +} + +/// Add two numbers. +#[rmcp::tool] +fn add(Parameters(AddRequest { a, b }): Parameters) -> Json { + Json(AddResult { sum: a + b }) +} + +#[test] +fn list_tools_result_matches_expected_json() { + let expected_json = std::fs::read("tests/test_list_tools_result/list_tools_result.json") + .expect("missing expected list tools result JSON fixture"); + let expected: serde_json::Value = + serde_json::from_slice(&expected_json).expect("invalid expected JSON fixture"); + + assert_eq!(add(Parameters(AddRequest { a: 1.0, b: 2.0 })).0.sum, 3.0); + + let result = ListToolsResult::with_all_items(vec![add_tool_attr()]); + let response = ServerJsonRpcMessage::response( + ServerResult::ListToolsResult(result), + NumberOrString::Number(2), + ); + + let actual = serde_json::to_value(response).expect("failed to serialize list tools response"); + assert_eq!(actual, expected); +} diff --git a/vendor/rmcp/tests/test_list_tools_result/list_tools_result.json b/vendor/rmcp/tests/test_list_tools_result/list_tools_result.json new file mode 100644 index 00000000..c6616b59 --- /dev/null +++ b/vendor/rmcp/tests/test_list_tools_result/list_tools_result.json @@ -0,0 +1,47 @@ +{ + "result": { + "resultType": "complete", + "tools": [ + { + "name": "add", + "description": "Add two numbers.", + "inputSchema": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "type": "object", + "properties": { + "a": { + "description": "The left-hand number.", + "format": "double", + "type": "number" + }, + "b": { + "description": "The right-hand number.", + "format": "double", + "type": "number" + } + }, + "required": [ + "a", + "b" + ] + }, + "outputSchema": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "type": "object", + "properties": { + "sum": { + "description": "The sum of the two numbers.", + "format": "double", + "type": "number" + } + }, + "required": [ + "sum" + ] + } + } + ] + }, + "jsonrpc": "2.0", + "id": 2 +} diff --git a/vendor/rmcp/tests/test_live_oauth_refresh.rs b/vendor/rmcp/tests/test_live_oauth_refresh.rs new file mode 100644 index 00000000..543abe53 --- /dev/null +++ b/vendor/rmcp/tests/test_live_oauth_refresh.rs @@ -0,0 +1,233 @@ +//! Live authorization-server checks for the refresh path. +//! +//! These are `#[ignore]`d, so they never run in CI. Provision the authorization +//! server with `./scripts/keycloak-oauth-fixture.sh`, then run them with +//! `cargo test -p rmcp --all-features --test test_live_oauth_refresh -- --ignored`. +//! `KC_BASE` overrides the server location for both the script and these tests. +#![cfg(feature = "auth")] + +use std::sync::Arc; + +use rmcp::transport::auth::{ + AuthError, AuthorizationManager, AuthorizationMetadata, CredentialRefreshGuard, + CredentialStore, InMemoryCredentialStore, OAuthClientConfig, OAuthTokenResponse, + StoredCredentials, +}; +use tokio::sync::Mutex; + +const REALM: &str = "rmcp"; +const CLIENT_ID: &str = "rmcp-client"; +const CLIENT_SECRET: &str = "rmcp-secret"; + +fn kc_base() -> String { + std::env::var("KC_BASE").unwrap_or_else(|_| "http://localhost:8081".to_string()) +} + +fn token_endpoint() -> String { + format!("{}/realms/{REALM}/protocol/openid-connect/token", kc_base()) +} + +/// Ask Keycloak for a genuine token pair through the direct access grant, so the +/// stored credentials hold a refresh token the server will actually honor. +async fn issue_real_credentials() -> OAuthTokenResponse { + let form = format!( + "client_id={CLIENT_ID}&client_secret={CLIENT_SECRET}\ + &username=alice&password=alice-pw&grant_type=password&scope=openid+profile" + ); + let body = reqwest::Client::new() + .post(token_endpoint()) + .header("content-type", "application/x-www-form-urlencoded") + .body(form) + .send() + .await + .expect("keycloak unreachable") + .text() + .await + .unwrap(); + serde_json::from_str(&body).unwrap_or_else(|e| panic!("unexpected token response {body}: {e}")) +} + +fn metadata() -> AuthorizationMetadata { + // `AuthorizationMetadata` is `#[non_exhaustive]`, so fill it field by field. + let mut metadata = AuthorizationMetadata::default(); + metadata.authorization_endpoint = + format!("{}/realms/{REALM}/protocol/openid-connect/auth", kc_base()); + metadata.token_endpoint = token_endpoint(); + metadata +} + +fn client_config() -> OAuthClientConfig { + let mut config = OAuthClientConfig::new(CLIENT_ID, "http://localhost/callback"); + config.client_secret = Some(CLIENT_SECRET.to_string()); + config +} + +async fn manager_with_store(store: S) -> AuthorizationManager { + let mut manager = AuthorizationManager::new(kc_base()).await.unwrap(); + manager.set_metadata(metadata()); + manager.configure_client(client_config()).unwrap(); + manager.set_credential_store(store); + manager +} + +fn stored(client_id: &str, token: OAuthTokenResponse) -> StoredCredentials { + StoredCredentials::new( + client_id.to_string(), + Some(token), + vec!["openid".into(), "profile".into()], + None, + ) +} + +/// A store that serializes refreshes the way a shared on-disk store would. +#[derive(Clone, Default)] +struct GuardedStore { + inner: InMemoryCredentialStore, + lock: Arc>, +} + +#[async_trait::async_trait] +impl CredentialStore for GuardedStore { + async fn load(&self) -> Result, AuthError> { + self.inner.load().await + } + + async fn save(&self, credentials: StoredCredentials) -> Result<(), AuthError> { + self.inner.save(credentials).await + } + + async fn clear(&self) -> Result<(), AuthError> { + self.inner.clear().await + } + + async fn acquire_refresh_guard(&self) -> Result, AuthError> { + Ok(Some(CredentialRefreshGuard::new( + self.lock.clone().lock_owned().await, + ))) + } +} + +#[tokio::test] +#[ignore = "requires a live Keycloak"] +async fn live_refresh_rotates_the_stored_token() { + use oauth2::TokenResponse; + + let issued = issue_real_credentials().await; + let original_refresh = issued.refresh_token().unwrap().secret().clone(); + let store = InMemoryCredentialStore::new(); + store.save(stored(CLIENT_ID, issued)).await.unwrap(); + let manager = manager_with_store(store.clone()).await; + + let refreshed = manager.refresh_token().await.expect("live refresh failed"); + + let saved = store.load().await.unwrap().unwrap(); + let saved_token = saved.token_response.unwrap(); + assert_ne!( + saved_token.refresh_token().unwrap().secret(), + &original_refresh, + "keycloak rotates refresh tokens, so the store must hold the new one" + ); + assert_eq!( + saved_token.access_token().secret(), + refreshed.access_token().secret(), + "the saved credentials must match what the caller received" + ); + assert!( + saved.granted_scopes.contains(&"openid".to_string()), + "granted scopes should come from the provider response, got: {:?}", + saved.granted_scopes + ); +} + +#[tokio::test] +#[ignore = "requires a live Keycloak"] +async fn live_refresh_rejects_credentials_for_another_client() { + use oauth2::TokenResponse; + + let issued = issue_real_credentials().await; + let untouched_refresh = issued.refresh_token().unwrap().secret().clone(); + let store = InMemoryCredentialStore::new(); + store + .save(stored("some-other-client", issued)) + .await + .unwrap(); + let manager = manager_with_store(store.clone()).await; + + let error = manager.refresh_token().await.unwrap_err(); + + assert!( + matches!(error, AuthError::AuthorizationRequired), + "a client mismatch must require reauthorization, got: {error:?}" + ); + let saved = store.load().await.unwrap().unwrap(); + assert_eq!( + saved + .token_response + .unwrap() + .refresh_token() + .unwrap() + .secret(), + &untouched_refresh, + "a rejected refresh must leave the stored token untouched" + ); +} + +#[tokio::test] +#[ignore = "requires a live Keycloak"] +async fn live_concurrent_refreshes_survive_refresh_token_rotation() { + use oauth2::TokenResponse; + + let issued = issue_real_credentials().await; + let store = GuardedStore::default(); + store.save(stored(CLIENT_ID, issued)).await.unwrap(); + let first = manager_with_store(store.clone()).await; + let second = manager_with_store(store.clone()).await; + + // Without the guard the second caller would reuse the refresh token the first + // one already consumed, and Keycloak would answer `invalid_grant`. + let (a, b) = tokio::join!( + tokio::spawn(async move { first.refresh_token().await }), + tokio::spawn(async move { second.refresh_token().await }) + ); + + let a = a.unwrap().expect("first concurrent refresh failed"); + let b = b.unwrap().expect("second concurrent refresh failed"); + assert_ne!( + a.access_token().secret(), + b.access_token().secret(), + "each caller performs its own exchange, so the tokens must differ" + ); +} + +/// Deterministic proof that this realm really does invalidate a rotated refresh +/// token, which is what makes the coordination above load-bearing. +#[tokio::test] +#[ignore = "requires a live Keycloak with revokeRefreshToken enabled"] +async fn live_reusing_a_rotated_refresh_token_is_rejected() { + let issued = issue_real_credentials().await; + + let first_store = InMemoryCredentialStore::new(); + first_store + .save(stored(CLIENT_ID, issued.clone())) + .await + .unwrap(); + manager_with_store(first_store) + .await + .refresh_token() + .await + .expect("the first refresh should succeed"); + + // A second caller that never saw the rotation still holds the consumed token. + let stale_store = InMemoryCredentialStore::new(); + stale_store.save(stored(CLIENT_ID, issued)).await.unwrap(); + let error = manager_with_store(stale_store) + .await + .refresh_token() + .await + .unwrap_err(); + + assert!( + matches!(error, AuthError::TokenRefreshRejected(_)), + "reusing a rotated refresh token must be rejected, got: {error:?}" + ); +} diff --git a/vendor/rmcp/tests/test_local_client_handler.rs b/vendor/rmcp/tests/test_local_client_handler.rs new file mode 100644 index 00000000..e85d3d8c --- /dev/null +++ b/vendor/rmcp/tests/test_local_client_handler.rs @@ -0,0 +1,16 @@ +use std::rc::Rc; + +use rmcp::ClientHandler; + +struct LocalClientHandler { + _state: Rc<()>, +} + +impl ClientHandler for LocalClientHandler {} + +#[test] +fn client_handler_accepts_non_send_sync_state_with_local_feature() { + fn assert_client_handler() {} + + assert_client_handler::(); +} diff --git a/vendor/rmcp/tests/test_logging.rs b/vendor/rmcp/tests/test_logging.rs new file mode 100644 index 00000000..bf00352b --- /dev/null +++ b/vendor/rmcp/tests/test_logging.rs @@ -0,0 +1,344 @@ +// cargo test --features "server client" --package rmcp test_logging +#![cfg(not(feature = "local"))] +#![allow(deprecated)] +mod common; + +use std::sync::{Arc, Mutex}; + +use common::handlers::{TestClientHandler, TestServer}; +use rmcp::{ + ServiceExt, + model::{LoggingLevel, LoggingMessageNotificationParam, SetLevelRequestParams}, +}; +use serde_json::json; +use tokio::sync::Notify; + +#[tokio::test] +async fn test_logging_spec_compliance() -> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let receive_signal = Arc::new(Notify::new()); + let received_messages = Arc::new(Mutex::new(Vec::::new())); + + // Start server in a separate task + let server_handle = tokio::spawn(async move { + let server = TestServer::new().serve(server_transport).await?; + + // Test server can send messages before level is set + server + .peer() + .notify_logging_message( + LoggingMessageNotificationParam::new( + LoggingLevel::Info, + serde_json::json!({ + "message": "Server initiated message", + "timestamp": chrono::Utc::now().to_rfc3339(), + }), + ) + .with_logger("test_server"), + ) + .await?; + + server.waiting().await?; + anyhow::Ok(()) + }); + + let client = TestClientHandler::with_notification( + true, + true, + receive_signal.clone(), + received_messages.clone(), + ) + .serve(client_transport) + .await?; + + // Wait for the initial server message + receive_signal.notified().await; + { + let mut messages = received_messages.lock().unwrap(); + assert_eq!(messages.len(), 1, "Should receive server-initiated message"); + messages.clear(); + } + + // Test level filtering and message format + for level in [ + LoggingLevel::Emergency, + LoggingLevel::Warning, + LoggingLevel::Debug, + ] { + client + .peer() + .set_level(SetLevelRequestParams::new(level)) + .await?; + + // Wait for each message response + receive_signal.notified().await; + + let mut messages = received_messages.lock().unwrap(); + let msg = messages.last().unwrap(); + + // Verify required fields + assert_eq!(msg.level, level); + assert!(msg.data.is_object()); + + // Verify data format + let data = msg.data.as_object().unwrap(); + assert!(data.contains_key("message")); + assert!(data.contains_key("timestamp")); + + // Verify timestamp + let timestamp = data["timestamp"].as_str().unwrap(); + chrono::DateTime::parse_from_rfc3339(timestamp).expect("RFC3339 timestamp"); + + messages.clear(); + } + + // Important: Cancel the client before ending the test + client.cancel().await?; + + // Wait for server to complete + server_handle.await??; + + Ok(()) +} + +#[tokio::test] +async fn test_logging_user_scenarios() -> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let receive_signal = Arc::new(Notify::new()); + let received_messages = Arc::new(Mutex::new(Vec::::new())); + + let server_handle = tokio::spawn(async move { + let server = TestServer::new().serve(server_transport).await?; + server.waiting().await?; + anyhow::Ok(()) + }); + + let client = TestClientHandler::with_notification( + true, + true, + receive_signal.clone(), + received_messages.clone(), + ) + .serve(client_transport) + .await?; + + // Test 1: Error reporting scenario + client + .peer() + .set_level(SetLevelRequestParams::new(LoggingLevel::Error)) + .await?; + receive_signal.notified().await; // Wait for response + { + let messages = received_messages.lock().unwrap(); + let msg = &messages[0]; + let data = msg.data.as_object().unwrap(); + assert!( + data.contains_key("error_code"), + "Error should have an error code" + ); + assert!( + data.contains_key("error_details"), + "Error should have details" + ); + assert!( + data.contains_key("timestamp"), + "Should know when error occurred" + ); + } + + // Test 2: Debug scenario + client + .peer() + .set_level(SetLevelRequestParams::new(LoggingLevel::Debug)) + .await?; + receive_signal.notified().await; // Wait for response + { + let messages = received_messages.lock().unwrap(); + let msg = messages.last().unwrap(); + let data = msg.data.as_object().unwrap(); + assert!( + data.contains_key("function"), + "Debug should show function name" + ); + assert!(data.contains_key("line"), "Debug should show line number"); + assert!( + data.contains_key("context"), + "Debug should show execution context" + ); + } + + // Test 3: Production monitoring scenario + client + .peer() + .set_level(SetLevelRequestParams::new(LoggingLevel::Info)) + .await?; + receive_signal.notified().await; // Wait for response + { + let messages = received_messages.lock().unwrap(); + let msg = messages.last().unwrap(); + let data = msg.data.as_object().unwrap(); + assert!(data.contains_key("status"), "Should show system status"); + assert!(data.contains_key("metrics"), "Should include metrics"); + } + + // Important: Cancel client and wait for server before ending + client.cancel().await?; + server_handle.await??; + + Ok(()) +} + +#[test] +fn test_logging_level_serialization() { + // Test all levels match spec exactly + let test_cases = [ + (LoggingLevel::Alert, "alert"), + (LoggingLevel::Critical, "critical"), + (LoggingLevel::Debug, "debug"), + (LoggingLevel::Emergency, "emergency"), + (LoggingLevel::Error, "error"), + (LoggingLevel::Info, "info"), + (LoggingLevel::Notice, "notice"), + (LoggingLevel::Warning, "warning"), + ]; + + for (level, expected) in test_cases { + let serialized = serde_json::to_string(&level).unwrap(); + // Remove quotes from serialized string + let serialized = serialized.trim_matches('"'); + assert_eq!( + serialized, expected, + "LoggingLevel::{:?} should serialize to \"{}\"", + level, expected + ); + } + + // Test deserialization from spec strings + for (level, spec_string) in test_cases { + let deserialized: LoggingLevel = + serde_json::from_str(&format!("\"{}\"", spec_string)).unwrap(); + assert_eq!( + deserialized, level, + "\"{}\" should deserialize to LoggingLevel::{:?}", + spec_string, level + ); + } +} + +#[tokio::test] +async fn test_logging_edge_cases() -> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let receive_signal = Arc::new(Notify::new()); + let received_messages = Arc::new(Mutex::new(Vec::::new())); + + let server_handle = tokio::spawn(async move { + let server = TestServer::new().serve(server_transport).await?; + server.waiting().await?; + anyhow::Ok(()) + }); + + let client = TestClientHandler::with_notification( + true, + true, + receive_signal.clone(), + received_messages.clone(), + ) + .serve(client_transport) + .await?; + + // Test all logging levels from spec + for level in [ + LoggingLevel::Alert, + LoggingLevel::Critical, + LoggingLevel::Notice, // These weren't tested before + ] { + client + .peer() + .set_level(SetLevelRequestParams::new(level)) + .await?; + receive_signal.notified().await; + + let messages = received_messages.lock().unwrap(); + let msg = messages.last().unwrap(); + assert_eq!(msg.level, level); + } + + client.cancel().await?; + server_handle.await??; + Ok(()) +} + +#[tokio::test] +async fn test_logging_optional_fields() -> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let receive_signal = Arc::new(Notify::new()); + let received_messages = Arc::new(Mutex::new(Vec::::new())); + + let server_handle = tokio::spawn(async move { + let server = TestServer::new().serve(server_transport).await?; + + // Test message with and without optional logger field + for (level, has_logger) in [(LoggingLevel::Info, true), (LoggingLevel::Debug, false)] { + let mut param = LoggingMessageNotificationParam::new(level, json!({"test": "data"})); + param.logger = has_logger.then(|| "test_logger".to_string()); + server.peer().notify_logging_message(param).await?; + } + + server.waiting().await?; + anyhow::Ok(()) + }); + + let client = TestClientHandler::with_notification( + true, + true, + receive_signal.clone(), + received_messages.clone(), + ) + .serve(client_transport) + .await?; + + // Wait for the initial server message + receive_signal.notified().await; + { + let mut messages = received_messages.lock().unwrap(); + assert_eq!(messages.len(), 2, "Should receive two messages"); + messages.clear(); + } + + // Test level filtering and message format + for level in [LoggingLevel::Info, LoggingLevel::Debug] { + client + .peer() + .set_level(SetLevelRequestParams::new(level)) + .await?; + + // Wait for each message response + receive_signal.notified().await; + + let mut messages = received_messages.lock().unwrap(); + let msg = messages.last().unwrap(); + + // Verify required fields + assert_eq!(msg.level, level); + assert!(msg.data.is_object()); + + // Verify data format + let data = msg.data.as_object().unwrap(); + assert!(data.contains_key("message")); + assert!(data.contains_key("timestamp")); + + // Verify timestamp + let timestamp = data["timestamp"].as_str().unwrap(); + chrono::DateTime::parse_from_rfc3339(timestamp).expect("RFC3339 timestamp"); + + messages.clear(); + } + + // Important: Cancel the client before ending the test + client.cancel().await?; + + // Wait for server to complete + server_handle.await??; + + Ok(()) +} diff --git a/vendor/rmcp/tests/test_message_protocol.rs b/vendor/rmcp/tests/test_message_protocol.rs new file mode 100644 index 00000000..f42cfe0a --- /dev/null +++ b/vendor/rmcp/tests/test_message_protocol.rs @@ -0,0 +1,426 @@ +//cargo test --test test_message_protocol --features "client server" +#![cfg(not(feature = "local"))] +#![expect(deprecated)] // exercises SEP-2577-deprecated Sampling/Roots/Logging types + +mod common; +use common::handlers::{TestClientHandler, TestServer}; +use rmcp::{ + ServiceExt, + model::*, + service::{RequestContext, Service}, +}; + +// Tests start here +#[tokio::test] +async fn test_message_roles() { + let messages = vec![ + SamplingMessage::user_text("user message"), + SamplingMessage::assistant_text("assistant message"), + ]; + + // Verify all roles can be serialized/deserialized correctly + let json = serde_json::to_string(&messages).unwrap(); + let deserialized: Vec = serde_json::from_str(&json).unwrap(); + assert_eq!(messages, deserialized); +} + +#[tokio::test] +async fn test_context_inclusion_integration() -> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(4096); + + // Start server + let server_handle = tokio::spawn(async move { + let server = TestServer::new().serve(server_transport).await?; + server.waiting().await?; + anyhow::Ok(()) + }); + + // Start client that honors context requests + let handler = TestClientHandler::new(true, true); + let client = handler.clone().serve(client_transport).await?; + + // Test ThisServer context inclusion + let request = ServerRequest::CreateMessageRequest(CreateMessageRequest::new( + CreateMessageRequestParams::new(vec![SamplingMessage::user_text("test message")], 100) + .with_include_context(ContextInclusion::ThisServer), + )); + + let result = handler + .handle_request( + request.clone(), + RequestContext::new(NumberOrString::Number(1), client.peer().clone()), + ) + .await?; + + if let ClientResult::CreateMessageResult(result) = result { + let text = result + .message + .content + .first() + .unwrap() + .as_text() + .unwrap() + .text + .as_str(); + assert!( + text.contains("test context"), + "Response should include context for ThisServer" + ); + } else { + panic!("Expected CreateMessageResult"); + } + + // Test AllServers context inclusion + let request = ServerRequest::CreateMessageRequest(CreateMessageRequest::new( + CreateMessageRequestParams::new(vec![SamplingMessage::user_text("test message")], 100) + .with_include_context(ContextInclusion::AllServers), + )); + + let result = handler + .handle_request( + request.clone(), + RequestContext::new(NumberOrString::Number(2), client.peer().clone()), + ) + .await?; + + if let ClientResult::CreateMessageResult(result) = result { + let text = result + .message + .content + .first() + .unwrap() + .as_text() + .unwrap() + .text + .as_str(); + assert!( + text.contains("test context"), + "Response should include context for AllServers" + ); + } else { + panic!("Expected CreateMessageResult"); + } + + // Test No context inclusion + let request = ServerRequest::CreateMessageRequest(CreateMessageRequest::new( + CreateMessageRequestParams::new(vec![SamplingMessage::user_text("test message")], 100) + .with_include_context(ContextInclusion::None), + )); + + let result = handler + .handle_request( + request.clone(), + RequestContext::new(NumberOrString::Number(3), client.peer().clone()), + ) + .await?; + + if let ClientResult::CreateMessageResult(result) = result { + let text = result + .message + .content + .first() + .unwrap() + .as_text() + .unwrap() + .text + .as_str(); + assert!( + !text.contains("test context"), + "Response should not include context for None" + ); + } else { + panic!("Expected CreateMessageResult"); + } + + client.cancel().await?; + server_handle.await??; + Ok(()) +} + +#[tokio::test] +async fn test_context_inclusion_ignored_integration() -> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(4096); + + // Start server + let server_handle = tokio::spawn(async move { + let server = TestServer::new().serve(server_transport).await?; + server.waiting().await?; + anyhow::Ok(()) + }); + + // Start client that ignores context requests + let handler = TestClientHandler::new(false, false); + let client = handler.clone().serve(client_transport).await?; + + // Test that context requests are ignored + let request = ServerRequest::CreateMessageRequest(CreateMessageRequest::new( + CreateMessageRequestParams::new(vec![SamplingMessage::user_text("test message")], 100) + .with_include_context(ContextInclusion::ThisServer), + )); + + let result = handler + .handle_request( + request.clone(), + RequestContext::new(NumberOrString::Number(1), client.peer().clone()), + ) + .await?; + + if let ClientResult::CreateMessageResult(result) = result { + let text = result + .message + .content + .first() + .unwrap() + .as_text() + .unwrap() + .text + .as_str(); + assert!( + !text.contains("test context"), + "Context should be ignored when client chooses not to honor requests" + ); + } else { + panic!("Expected CreateMessageResult"); + } + + client.cancel().await?; + server_handle.await??; + Ok(()) +} + +#[tokio::test] +async fn test_message_sequence_integration() -> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(4096); + + // Start server + let server_handle = tokio::spawn(async move { + let server = TestServer::new().serve(server_transport).await?; + server.waiting().await?; + anyhow::Ok(()) + }); + + // Start client + let handler = TestClientHandler::new(true, true); + let client = handler.clone().serve(client_transport).await?; + + let request = ServerRequest::CreateMessageRequest(CreateMessageRequest::new( + CreateMessageRequestParams::new( + vec![ + SamplingMessage::user_text("first message"), + SamplingMessage::assistant_text("second message"), + ], + 100, + ) + .with_include_context(ContextInclusion::ThisServer), + )); + + let result = handler + .handle_request( + request.clone(), + RequestContext::new(NumberOrString::Number(1), client.peer().clone()), + ) + .await?; + + if let ClientResult::CreateMessageResult(result) = result { + let text = result + .message + .content + .first() + .unwrap() + .as_text() + .unwrap() + .text + .as_str(); + assert!( + text.contains("test context"), + "Response should include context when ThisServer is specified" + ); + assert_eq!(result.model, "test-model"); + assert_eq!( + result.stop_reason, + Some(CreateMessageResult::STOP_REASON_END_TURN.to_string()) + ); + } else { + panic!("Expected CreateMessageResult"); + } + + client.cancel().await?; + server_handle.await??; + Ok(()) +} + +#[tokio::test] +async fn test_message_sequence_validation_integration() -> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(4096); + + let server_handle = tokio::spawn(async move { + let server = TestServer::new().serve(server_transport).await?; + server.waiting().await?; + anyhow::Ok(()) + }); + + let handler = TestClientHandler::new(true, true); + let client = handler.clone().serve(client_transport).await?; + + // Test valid sequence: User -> Assistant -> User + let request = ServerRequest::CreateMessageRequest(CreateMessageRequest::new( + CreateMessageRequestParams::new( + vec![ + SamplingMessage::user_text("first user message"), + SamplingMessage::assistant_text("first assistant response"), + SamplingMessage::user_text("second user message"), + ], + 100, + ), + )); + + let result = handler + .handle_request( + request.clone(), + RequestContext::new(NumberOrString::Number(1), client.peer().clone()), + ) + .await?; + + assert!(matches!(result, ClientResult::CreateMessageResult(_))); + + // Test invalid: No user message + let request = ServerRequest::CreateMessageRequest(CreateMessageRequest::new( + CreateMessageRequestParams::new( + vec![SamplingMessage::assistant_text("assistant message")], + 100, + ), + )); + + let result = handler + .handle_request( + request.clone(), + RequestContext::new(NumberOrString::Number(2), client.peer().clone()), + ) + .await; + + assert!(result.is_err()); + + client.cancel().await?; + server_handle.await??; + Ok(()) +} + +#[tokio::test] +async fn test_selective_context_handling_integration() -> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(4096); + + let server_handle = tokio::spawn(async move { + let server = TestServer::new().serve(server_transport).await?; + server.waiting().await?; + anyhow::Ok(()) + }); + + // Client that only honors ThisServer but ignores AllServers + let handler = TestClientHandler::new(true, false); + let client = handler.clone().serve(client_transport).await?; + + // Test ThisServer is honored + let request = ServerRequest::CreateMessageRequest(CreateMessageRequest::new( + CreateMessageRequestParams::new(vec![SamplingMessage::user_text("test message")], 100) + .with_include_context(ContextInclusion::ThisServer), + )); + + let result = handler + .handle_request( + request.clone(), + RequestContext::new(NumberOrString::Number(1), client.peer().clone()), + ) + .await?; + + if let ClientResult::CreateMessageResult(result) = result { + let text = result + .message + .content + .first() + .unwrap() + .as_text() + .unwrap() + .text + .as_str(); + assert!( + text.contains("test context"), + "ThisServer context request should be honored" + ); + } + + // Test AllServers is ignored + let request = ServerRequest::CreateMessageRequest(CreateMessageRequest::new( + CreateMessageRequestParams::new(vec![SamplingMessage::user_text("test message")], 100) + .with_include_context(ContextInclusion::AllServers), + )); + + let result = handler + .handle_request( + request.clone(), + RequestContext::new(NumberOrString::Number(2), client.peer().clone()), + ) + .await?; + + if let ClientResult::CreateMessageResult(result) = result { + let text = result + .message + .content + .first() + .unwrap() + .as_text() + .unwrap() + .text + .as_str(); + assert!( + !text.contains("test context"), + "AllServers context request should be ignored" + ); + } + + client.cancel().await?; + server_handle.await??; + Ok(()) +} + +#[tokio::test] +async fn test_context_inclusion() -> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let server_handle = tokio::spawn(async move { + let server = TestServer::new().serve(server_transport).await?; + server.waiting().await?; + anyhow::Ok(()) + }); + + let handler = TestClientHandler::new(true, true); + let client = handler.clone().serve(client_transport).await?; + + // Test context handling + let request = ServerRequest::CreateMessageRequest(CreateMessageRequest::new( + CreateMessageRequestParams::new(vec![SamplingMessage::user_text("test")], 100) + .with_include_context(ContextInclusion::ThisServer), + )); + + let result = handler + .handle_request( + request.clone(), + RequestContext::new(NumberOrString::Number(1), client.peer().clone()), + ) + .await?; + + if let ClientResult::CreateMessageResult(result) = result { + let text = result + .message + .content + .first() + .unwrap() + .as_text() + .unwrap() + .text + .as_str(); + assert!(text.contains("test context")); + } + + client.cancel().await?; + server_handle.await??; + Ok(()) +} diff --git a/vendor/rmcp/tests/test_message_schema.rs b/vendor/rmcp/tests/test_message_schema.rs new file mode 100644 index 00000000..027a2cc8 --- /dev/null +++ b/vendor/rmcp/tests/test_message_schema.rs @@ -0,0 +1,139 @@ +mod tests { + use rmcp::model::{ClientJsonRpcMessage, ServerJsonRpcMessage}; + use schemars::generate::SchemaSettings; + + fn compare_schemas(name: &str, actual: &str, expected_file: &str) { + let expected = match std::fs::read_to_string(expected_file) { + Ok(content) => content, + Err(e) => { + panic!( + "Failed to read expected schema file {}: {}", + expected_file, e + ); + } + }; + + let actual_json: serde_json::Value = + serde_json::from_str(actual).expect("Failed to parse actual schema as JSON"); + let expected_json: serde_json::Value = + serde_json::from_str(&expected).expect("Failed to parse expected schema as JSON"); + + if actual_json == expected_json { + println!("{} schema matches expected", name); + return; + } + + // Write current schema to file for comparison + let current_file = expected_file.replace(".json", "_current.json"); + std::fs::write(¤t_file, actual).expect("Failed to write current schema"); + + println!("{} schema differs from expected", name); + println!("Expected: {}", expected_file); + println!("Current: {}", current_file); + println!( + "Run 'diff {} {}' to see differences", + expected_file, current_file + ); + + // UPDATE_SCHEMA=1 cargo test -p rmcp --test test_message_schema --features="server client schemars" + if std::env::var("UPDATE_SCHEMA").is_ok() { + println!("UPDATE_SCHEMA is set, updating expected file"); + std::fs::write(expected_file, actual).expect("Failed to update expected schema file"); + println!("Updated {}", expected_file); + } else { + println!("Set UPDATE_SCHEMA=1 to auto-update expected schemas"); + panic!("Schema validation failed"); + } + } + + #[test] + fn test_client_json_rpc_message_schema() { + let settings = SchemaSettings::draft07(); + let schema = settings + .into_generator() + .into_root_schema_for::(); + let schema_str = serde_json::to_string_pretty(&schema).expect("Failed to serialize schema"); + + compare_schemas( + "ClientJsonRpcMessage", + &schema_str, + "tests/test_message_schema/client_json_rpc_message_schema.json", + ); + } + + /// The three metadata definitions must expose the MCP 2026-07-28 + /// vocabulary: `MetaObject` is an open map, `RequestMetaObject` reserves + /// `progressToken` plus the SEP-2575 keys, and `NotificationMetaObject` + /// reserves `io.modelcontextprotocol/subscriptionId`. Version-specific + /// required keys stay optional because rmcp generates one schema shared + /// by every supported protocol version; current-version validation is + /// a runtime concern (`RequestMetaObject::missing_required_keys`). + #[test] + fn test_metadata_definitions_match_2026_07_28_schema() { + let settings = SchemaSettings::draft07(); + let schema = settings + .into_generator() + .into_root_schema_for::(); + let schema = serde_json::to_value(&schema).expect("Failed to serialize schema"); + let definitions = &schema["definitions"]; + + assert_eq!( + definitions["MetaObject"], + serde_json::json!({ + "description": "See [MCP general fields](https://modelcontextprotocol.io/specification/2026-07-28/basic#general-fields) for notes on _meta usage.", + "type": "object", + "additionalProperties": true, + }) + ); + + assert_eq!( + definitions["RequestMetaObject"], + serde_json::json!({ + "description": "Metadata reserved by MCP on requests. Extension keys are also allowed.", + "type": "object", + "properties": { + "progressToken": { "$ref": "#/definitions/ProgressToken" }, + "io.modelcontextprotocol/protocolVersion": { "type": "string" }, + "io.modelcontextprotocol/clientInfo": { "$ref": "#/definitions/Implementation" }, + "io.modelcontextprotocol/clientCapabilities": { "$ref": "#/definitions/ClientCapabilities" }, + "io.modelcontextprotocol/logLevel": { "$ref": "#/definitions/LoggingLevel" }, + }, + "additionalProperties": true, + }) + ); + + assert_eq!( + definitions["NotificationMetaObject"], + serde_json::json!({ + "description": "Metadata reserved by MCP on notifications. Extension keys are also allowed.", + "type": "object", + "properties": { + "io.modelcontextprotocol/subscriptionId": { "$ref": "#/definitions/NumberOrString" }, + }, + "additionalProperties": true, + }) + ); + } + + #[test] + fn test_server_json_rpc_message_schema() { + let settings = SchemaSettings::draft07(); + let schema = settings + .into_generator() + .into_root_schema_for::(); + let schema_value = + serde_json::to_value(&schema).expect("Failed to serialize server schema"); + let discover_result = &schema_value["definitions"]["DiscoverResult"]; + assert!( + discover_result["properties"].get("serverInfo").is_none(), + "DiscoverResult serverInfo belongs in namespaced _meta" + ); + let schema_str = serde_json::to_string_pretty(&schema).expect("Failed to serialize schema"); + + compare_schemas( + "ServerJsonRpcMessage", + &schema_str, + "tests/test_message_schema/server_json_rpc_message_schema.json", + ); + } +} diff --git a/vendor/rmcp/tests/test_message_schema/client_json_rpc_message_schema.json b/vendor/rmcp/tests/test_message_schema/client_json_rpc_message_schema.json new file mode 100644 index 00000000..760d9e18 --- /dev/null +++ b/vendor/rmcp/tests/test_message_schema/client_json_rpc_message_schema.json @@ -0,0 +1,2447 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "title": "JsonRpcMessage", + "description": "Represents any JSON-RPC message that can be sent or received.\n\nThis enum covers all possible message types in the JSON-RPC protocol:\nindividual requests/responses, notifications, and errors.\nIt serves as the top-level message container for MCP communication.", + "anyOf": [ + { + "description": "A single request expecting a response", + "allOf": [ + { + "$ref": "#/definitions/JsonRpcRequest" + } + ] + }, + { + "description": "A response to a previous request", + "allOf": [ + { + "$ref": "#/definitions/JsonRpcResponse" + } + ] + }, + { + "description": "A one-way notification (no response expected)", + "allOf": [ + { + "$ref": "#/definitions/JsonRpcNotification" + } + ] + }, + { + "description": "An error response", + "allOf": [ + { + "$ref": "#/definitions/JsonRpcError" + } + ] + } + ], + "definitions": { + "Annotations": { + "description": "Optional annotations for the client. The client can use annotations to inform how objects are\nused or displayed.", + "type": "object", + "properties": { + "audience": { + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Role" + } + }, + "lastModified": { + "type": [ + "string", + "null" + ] + }, + "priority": { + "type": [ + "number", + "null" + ], + "format": "float" + } + } + }, + "ArgumentInfo": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "name", + "value" + ] + }, + "AudioContent": { + "description": "Audio content with base64-encoded data (spec `AudioContent`).", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this content block.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional annotations describing how the client should use this content.", + "anyOf": [ + { + "$ref": "#/definitions/Annotations" + }, + { + "type": "null" + } + ] + }, + "data": { + "description": "The base64-encoded audio data.", + "type": "string" + }, + "mimeType": { + "description": "The MIME type of the audio (e.g. `audio/wav`).", + "type": "string" + } + }, + "required": [ + "data", + "mimeType" + ] + }, + "CallToolRequestMethod": { + "type": "string", + "format": "const", + "const": "tools/call" + }, + "CallToolRequestParams": { + "description": "Parameters for calling a tool provided by an MCP server.\n\nContains the tool name and optional arguments needed to execute\nthe tool operation.", + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata for this request (SEP-1319)", + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "arguments": { + "description": "Arguments to pass to the tool (must match the tool's input schema)", + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "inputResponses": { + "description": "Client responses to server-initiated input requests from a previous\n[`InputRequiredResult`]. Present only when retrying after an incomplete result.", + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "name": { + "description": "The name of the tool to call", + "type": "string" + }, + "requestState": { + "description": "Opaque request state echoed back from a previous [`InputRequiredResult`].\nClients MUST return this value exactly as received.", + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name" + ] + }, + "CancelTaskMethod": { + "type": "string", + "format": "const", + "const": "tasks/cancel" + }, + "CancelTaskParams": { + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata for this request (SEP-1319)", + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "taskId": { + "type": "string" + } + }, + "required": [ + "taskId" + ] + }, + "CancelledNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/cancelled" + }, + "CancelledNotificationParam": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/NotificationMetaObject" + }, + { + "type": "null" + } + ] + }, + "reason": { + "type": [ + "string", + "null" + ] + }, + "requestId": { + "anyOf": [ + { + "$ref": "#/definitions/NumberOrString" + }, + { + "type": "null" + } + ] + } + } + }, + "ClientCapabilities": { + "title": "Builder", + "description": "```rust\n# use rmcp::model::ClientCapabilities;\nlet cap = ClientCapabilities::builder()\n .enable_experimental()\n .build();\n```", + "type": "object", + "properties": { + "elicitation": { + "description": "Capability to handle elicitation requests from servers for interactive user input", + "anyOf": [ + { + "$ref": "#/definitions/ElicitationCapability" + }, + { + "type": "null" + } + ] + }, + "experimental": { + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "object", + "additionalProperties": true + } + }, + "extensions": { + "description": "Optional MCP extensions that the client supports (SEP-1724).\nKeys are extension identifiers (e.g., `\"io.modelcontextprotocol/ui\"`),\nvalues are per-extension settings objects. An empty object indicates\nsupport with no settings.", + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "object", + "additionalProperties": true + } + }, + "roots": { + "description": "Capability for filesystem roots (deprecated by SEP-2577).", + "anyOf": [ + { + "$ref": "#/definitions/RootsCapabilities" + }, + { + "type": "null" + } + ] + }, + "sampling": { + "description": "Capability for LLM sampling requests (SEP-1577, deprecated by SEP-2577).", + "anyOf": [ + { + "$ref": "#/definitions/SamplingCapability" + }, + { + "type": "null" + } + ] + } + } + }, + "ClientResult": { + "anyOf": [ + { + "$ref": "#/definitions/CreateMessageResult" + }, + { + "$ref": "#/definitions/ListRootsResult" + }, + { + "$ref": "#/definitions/ElicitResult" + }, + { + "$ref": "#/definitions/EmptyObject" + }, + { + "$ref": "#/definitions/CustomResult" + } + ] + }, + "CompleteRequestMethod": { + "type": "string", + "format": "const", + "const": "completion/complete" + }, + "CompleteRequestParams": { + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata for this request (SEP-1319)", + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "argument": { + "$ref": "#/definitions/ArgumentInfo" + }, + "context": { + "description": "Optional context containing previously resolved argument values", + "anyOf": [ + { + "$ref": "#/definitions/CompletionContext" + }, + { + "type": "null" + } + ] + }, + "ref": { + "$ref": "#/definitions/Reference" + } + }, + "required": [ + "ref", + "argument" + ] + }, + "CompletionContext": { + "description": "Context for completion requests providing previously resolved arguments.\n\nThis enables context-aware completion where subsequent argument completions\ncan take into account the values of previously resolved arguments.", + "type": "object", + "properties": { + "arguments": { + "description": "Previously resolved argument values that can inform completion suggestions", + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "string" + } + } + } + }, + "ContentBlock": { + "description": "Unified content block union (spec `ContentBlock`).\n\n`text | image | audio | resource_link | resource`", + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "text" + } + }, + "allOf": [ + { + "$ref": "#/definitions/TextContent" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "image" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ImageContent" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "audio" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AudioContent" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "resource" + } + }, + "allOf": [ + { + "$ref": "#/definitions/EmbeddedResource" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "resource_link" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "type" + ] + } + ] + }, + "CreateMessageResult": { + "description": "Result of sampling/createMessage (SEP-1577).\nThe result of a sampling/createMessage request containing the generated response.\n\nThis structure contains the generated message along with metadata about\nhow the generation was performed and why it stopped.", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "content": { + "description": "The actual content of the message (text, image, audio, tool use, or tool result)", + "allOf": [ + { + "$ref": "#/definitions/SamplingContent" + } + ] + }, + "model": { + "description": "The identifier of the model that generated the response", + "type": "string" + }, + "role": { + "description": "The role of the message sender (User or Assistant)", + "allOf": [ + { + "$ref": "#/definitions/Role" + } + ] + }, + "stopReason": { + "description": "The reason why generation stopped (e.g., \"endTurn\", \"maxTokens\")", + "type": [ + "string", + "null" + ] + } + }, + "deprecated": true, + "required": [ + "model", + "role", + "content" + ] + }, + "CustomNotification": { + "description": "A catch-all notification either side can use to send custom messages to its peer.\n\nThis preserves the raw `method` name and `params` payload so handlers can\ndeserialize them into domain-specific types.", + "type": "object", + "properties": { + "method": { + "type": "string" + }, + "params": true + }, + "required": [ + "method" + ] + }, + "CustomRequest": { + "description": "A catch-all request either side can use to send custom messages to its peer.\n\nThis preserves the raw `method` name and `params` payload so handlers can\ndeserialize them into domain-specific types.", + "type": "object", + "properties": { + "method": { + "type": "string" + }, + "params": true + }, + "required": [ + "method" + ] + }, + "CustomResult": { + "description": "A catch-all response either side can use for custom requests." + }, + "DiscoverRequestMethod": { + "type": "string", + "format": "const", + "const": "server/discover" + }, + "DiscoverRequestParams": { + "type": "object", + "properties": { + "_meta": { + "$ref": "#/definitions/RequestMetaObject" + } + }, + "required": [ + "_meta" + ] + }, + "ElicitResult": { + "description": "The result returned by a client in response to an elicitation request.\n\nContains the user's decision (accept/decline/cancel) and optionally their input data\nif they chose to accept the request.", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this result.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "action": { + "description": "The user's decision on how to handle the elicitation request", + "allOf": [ + { + "$ref": "#/definitions/ElicitationAction" + } + ] + }, + "content": { + "description": "The actual data provided by the user, if they accepted the request.\nMust conform to the JSON schema specified in the original request.\nOnly present when action is Accept." + } + }, + "required": [ + "action" + ] + }, + "ElicitationAction": { + "description": "Represents the possible actions a user can take in response to an elicitation request.\n\nWhen a server requests user input through elicitation, the user can:\n- Accept: Provide the requested information and continue\n- Decline: Refuse to provide the information but continue the operation\n- Cancel: Stop the entire operation", + "oneOf": [ + { + "description": "User accepts the request and provides the requested information", + "type": "string", + "const": "accept" + }, + { + "description": "User declines to provide the information but allows the operation to continue", + "type": "string", + "const": "decline" + }, + { + "description": "User cancels the entire operation", + "type": "string", + "const": "cancel" + } + ] + }, + "ElicitationCapability": { + "description": "Elicitation allows servers to request interactive input from users during tool execution.\nThis capability indicates that a client can handle elicitation requests and present\nappropriate UI to users for collecting the requested information.", + "type": "object", + "properties": { + "form": { + "description": "Whether client supports form-based elicitation.", + "anyOf": [ + { + "$ref": "#/definitions/FormElicitationCapability" + }, + { + "type": "null" + } + ] + }, + "url": { + "description": "Whether client supports URL-based elicitation.", + "anyOf": [ + { + "$ref": "#/definitions/UrlElicitationCapability" + }, + { + "type": "null" + } + ] + } + } + }, + "EmbeddedResource": { + "description": "Embedded resource content (spec `EmbeddedResource`).", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this content block.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional annotations describing how the client should use this content.", + "anyOf": [ + { + "$ref": "#/definitions/Annotations" + }, + { + "type": "null" + } + ] + }, + "resource": { + "description": "The embedded resource contents (text or blob).", + "allOf": [ + { + "$ref": "#/definitions/ResourceContents" + } + ] + } + }, + "required": [ + "resource" + ] + }, + "EmptyObject": { + "description": "This is commonly used for representing empty objects in MCP messages.\n\nwithout returning any specific data.", + "type": "object", + "additionalProperties": false + }, + "ErrorCode": { + "description": "Standard JSON-RPC error codes used throughout the MCP protocol.\n\nThese codes follow the JSON-RPC 2.0 specification and provide\nstandardized error reporting across all MCP implementations.", + "type": "integer", + "format": "int32" + }, + "ErrorData": { + "description": "Error information for JSON-RPC error responses.\n\nThis structure follows the JSON-RPC 2.0 specification for error reporting,\nproviding a standardized way to communicate errors between clients and servers.", + "type": "object", + "properties": { + "code": { + "description": "The error type that occurred (using standard JSON-RPC error codes)", + "allOf": [ + { + "$ref": "#/definitions/ErrorCode" + } + ] + }, + "data": { + "description": "Additional information about the error. The value of this member is defined by the\nsender (e.g. detailed error information, nested errors etc.)." + }, + "message": { + "description": "A short description of the error. The message SHOULD be limited to a concise single sentence.", + "type": "string" + } + }, + "required": [ + "code", + "message" + ] + }, + "FormElicitationCapability": { + "description": "Capability for handling elicitation requests from servers.\nElicitation allows servers to request interactive input from users during tool execution.\nThis capability indicates that a client can handle elicitation requests and present\nappropriate UI to users for collecting the requested information.\n\nCapability for form mode elicitation.", + "type": "object", + "properties": { + "schemaValidation": { + "description": "Whether the client supports JSON Schema validation for elicitation responses.\nWhen true, the client will validate user input against the requested_schema\nbefore sending the response back to the server.", + "type": [ + "boolean", + "null" + ] + } + } + }, + "GetPromptRequestMethod": { + "type": "string", + "format": "const", + "const": "prompts/get" + }, + "GetPromptRequestParams": { + "description": "Parameters for retrieving a specific prompt", + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata for this request (SEP-1319)", + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "arguments": { + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "inputResponses": { + "description": "Client responses to server-initiated input requests from a previous\n[`InputRequiredResult`].", + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "name": { + "type": "string" + }, + "requestState": { + "description": "Opaque request state echoed back from a previous [`InputRequiredResult`].", + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name" + ] + }, + "GetTaskMethod": { + "type": "string", + "format": "const", + "const": "tasks/get" + }, + "GetTaskParams": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "taskId": { + "description": "Identifier of the task to query.", + "type": "string" + } + }, + "required": [ + "taskId" + ] + }, + "Icon": { + "description": "A URL pointing to an icon resource or a base64-encoded data URI.\n\nClients that support rendering icons MUST support at least the following MIME types:\n- image/png - PNG images (safe, universal compatibility)\n- image/jpeg (and image/jpg) - JPEG images (safe, universal compatibility)\n\nClients that support rendering icons SHOULD also support:\n- image/svg+xml - SVG images (scalable but requires security precautions)\n- image/webp - WebP images (modern, efficient format)", + "type": "object", + "properties": { + "mimeType": { + "description": "Optional override if the server's MIME type is missing or generic", + "type": [ + "string", + "null" + ] + }, + "sizes": { + "description": "Size specification, each string should be in WxH format (e.g., `\\\"48x48\\\"`, `\\\"96x96\\\"`) or `\\\"any\\\"` for scalable formats like SVG", + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "src": { + "description": "A standard URI pointing to an icon resource", + "type": "string" + }, + "theme": { + "description": "Optional specifier for the theme this icon is designed for\nIf not provided, the client should assume the icon can be used with any theme.", + "anyOf": [ + { + "$ref": "#/definitions/IconTheme" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "src" + ] + }, + "IconTheme": { + "description": "Icon themes supported by the MCP specification", + "oneOf": [ + { + "description": "Indicates the icon is designed to be used with a light background", + "type": "string", + "const": "light" + }, + { + "description": "Indicates the icon is designed to be used with a dark background", + "type": "string", + "const": "dark" + } + ] + }, + "ImageContent": { + "description": "Image content with base64-encoded data (spec `ImageContent`).", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this content block.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional annotations describing how the client should use this content.", + "anyOf": [ + { + "$ref": "#/definitions/Annotations" + }, + { + "type": "null" + } + ] + }, + "data": { + "description": "The base64-encoded image data.", + "type": "string" + }, + "mimeType": { + "description": "The MIME type of the image (e.g. `image/png`).", + "type": "string" + } + }, + "required": [ + "data", + "mimeType" + ] + }, + "Implementation": { + "type": "object", + "properties": { + "description": { + "type": [ + "string", + "null" + ] + }, + "icons": { + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Icon" + } + }, + "name": { + "type": "string" + }, + "title": { + "type": [ + "string", + "null" + ] + }, + "version": { + "type": "string" + }, + "websiteUrl": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name", + "version" + ] + }, + "InitializeRequestParams": { + "description": "Parameters sent by a client when initializing a connection to an MCP server.\n\nThis contains the client's protocol version, capabilities, and implementation\ninformation, allowing the server to understand what the client supports.", + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata for this request (SEP-1319)", + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "capabilities": { + "description": "The capabilities this client supports (sampling, roots, etc.)", + "allOf": [ + { + "$ref": "#/definitions/ClientCapabilities" + } + ] + }, + "clientInfo": { + "description": "Information about the client implementation", + "allOf": [ + { + "$ref": "#/definitions/Implementation" + } + ] + }, + "protocolVersion": { + "description": "The MCP protocol version this client supports", + "allOf": [ + { + "$ref": "#/definitions/ProtocolVersion" + } + ] + } + }, + "required": [ + "protocolVersion", + "capabilities", + "clientInfo" + ] + }, + "InitializeResultMethod": { + "type": "string", + "format": "const", + "const": "initialize" + }, + "InitializedNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/initialized" + }, + "JsonRpcError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorData" + }, + "id": { + "anyOf": [ + { + "$ref": "#/definitions/NumberOrString" + }, + { + "type": "null" + } + ] + }, + "jsonrpc": { + "$ref": "#/definitions/JsonRpcVersion2_0" + } + }, + "required": [ + "jsonrpc", + "error" + ] + }, + "JsonRpcNotification": { + "type": "object", + "properties": { + "jsonrpc": { + "$ref": "#/definitions/JsonRpcVersion2_0" + } + }, + "anyOf": [ + { + "$ref": "#/definitions/Notification" + }, + { + "$ref": "#/definitions/Notification2" + }, + { + "$ref": "#/definitions/NotificationNoParam" + }, + { + "$ref": "#/definitions/NotificationNoParam2" + }, + { + "$ref": "#/definitions/CustomNotification" + } + ], + "required": [ + "jsonrpc" + ] + }, + "JsonRpcRequest": { + "type": "object", + "properties": { + "id": { + "$ref": "#/definitions/NumberOrString" + }, + "jsonrpc": { + "$ref": "#/definitions/JsonRpcVersion2_0" + } + }, + "anyOf": [ + { + "$ref": "#/definitions/RequestNoParam" + }, + { + "$ref": "#/definitions/Request" + }, + { + "$ref": "#/definitions/Request2" + }, + { + "$ref": "#/definitions/Request3" + }, + { + "$ref": "#/definitions/Request4" + }, + { + "$ref": "#/definitions/Request5" + }, + { + "$ref": "#/definitions/RequestOptionalParam" + }, + { + "$ref": "#/definitions/RequestOptionalParam2" + }, + { + "$ref": "#/definitions/RequestOptionalParam3" + }, + { + "$ref": "#/definitions/Request6" + }, + { + "$ref": "#/definitions/Request7" + }, + { + "$ref": "#/definitions/Request8" + }, + { + "$ref": "#/definitions/Request9" + }, + { + "$ref": "#/definitions/Request10" + }, + { + "$ref": "#/definitions/RequestOptionalParam4" + }, + { + "$ref": "#/definitions/Request11" + }, + { + "$ref": "#/definitions/Request12" + }, + { + "$ref": "#/definitions/Request13" + }, + { + "$ref": "#/definitions/CustomRequest" + } + ], + "required": [ + "jsonrpc", + "id" + ] + }, + "JsonRpcResponse": { + "type": "object", + "properties": { + "id": { + "$ref": "#/definitions/NumberOrString" + }, + "jsonrpc": { + "$ref": "#/definitions/JsonRpcVersion2_0" + }, + "result": { + "$ref": "#/definitions/ClientResult" + } + }, + "required": [ + "jsonrpc", + "id", + "result" + ] + }, + "JsonRpcVersion2_0": { + "type": "string", + "format": "const", + "const": "2.0" + }, + "ListPromptsRequestMethod": { + "type": "string", + "format": "const", + "const": "prompts/list" + }, + "ListResourceTemplatesRequestMethod": { + "type": "string", + "format": "const", + "const": "resources/templates/list" + }, + "ListResourcesRequestMethod": { + "type": "string", + "format": "const", + "const": "resources/list" + }, + "ListRootsResult": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "roots": { + "type": "array", + "items": { + "$ref": "#/definitions/Root" + } + } + }, + "deprecated": true, + "required": [ + "roots" + ] + }, + "ListToolsRequestMethod": { + "type": "string", + "format": "const", + "const": "tools/list" + }, + "LoggingLevel": { + "description": "Logging levels supported by the MCP protocol", + "type": "string", + "deprecated": true, + "enum": [ + "debug", + "info", + "notice", + "warning", + "error", + "critical", + "alert", + "emergency" + ] + }, + "MetaObject": { + "description": "See [MCP general fields](https://modelcontextprotocol.io/specification/2026-07-28/basic#general-fields) for notes on _meta usage.", + "type": "object", + "additionalProperties": true + }, + "Notification": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/CancelledNotificationMethod" + }, + "params": { + "$ref": "#/definitions/CancelledNotificationParam" + } + }, + "required": [ + "method", + "params" + ] + }, + "Notification2": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ProgressNotificationMethod" + }, + "params": { + "$ref": "#/definitions/ProgressNotificationParam" + } + }, + "required": [ + "method", + "params" + ] + }, + "NotificationMetaObject": { + "description": "Metadata reserved by MCP on notifications. Extension keys are also allowed.", + "type": "object", + "properties": { + "io.modelcontextprotocol/subscriptionId": { + "$ref": "#/definitions/NumberOrString" + } + }, + "additionalProperties": true + }, + "NotificationNoParam": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/InitializedNotificationMethod" + } + }, + "required": [ + "method" + ] + }, + "NotificationNoParam2": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/RootsListChangedNotificationMethod" + } + }, + "required": [ + "method" + ] + }, + "NumberOrString": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "PaginatedRequestParams": { + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata for this request (SEP-1319)", + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "cursor": { + "type": [ + "string", + "null" + ] + } + } + }, + "PingRequestMethod": { + "type": "string", + "format": "const", + "const": "ping" + }, + "ProgressNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/progress" + }, + "ProgressNotificationParam": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/NotificationMetaObject" + }, + { + "type": "null" + } + ] + }, + "message": { + "description": "An optional message describing the current progress.", + "type": [ + "string", + "null" + ] + }, + "progress": { + "description": "The progress thus far. This should increase every time progress is made, even if the total is unknown.", + "type": "number", + "format": "double" + }, + "progressToken": { + "$ref": "#/definitions/ProgressToken" + }, + "total": { + "description": "Total number of items to process (or total progress required), if known", + "type": [ + "number", + "null" + ], + "format": "double" + } + }, + "required": [ + "progressToken", + "progress" + ] + }, + "ProgressToken": { + "description": "A token used to track the progress of long-running operations.\n\nProgress tokens allow clients and servers to associate progress notifications\nwith specific requests, enabling real-time updates on operation status.", + "allOf": [ + { + "$ref": "#/definitions/NumberOrString" + } + ] + }, + "PromptReference": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "title": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name" + ] + }, + "ProtocolVersion": { + "description": "Represents the MCP protocol version used for communication.\n\nThis ensures compatibility between clients and servers by specifying\nwhich version of the Model Context Protocol is being used.", + "type": "string" + }, + "ReadResourceRequestMethod": { + "type": "string", + "format": "const", + "const": "resources/read" + }, + "ReadResourceRequestParams": { + "description": "Parameters for reading a specific resource", + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata for this request (SEP-1319)", + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "inputResponses": { + "description": "Client responses to server-initiated input requests from a previous\n[`InputRequiredResult`].", + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "requestState": { + "description": "Opaque request state echoed back from a previous [`InputRequiredResult`].", + "type": [ + "string", + "null" + ] + }, + "uri": { + "description": "The URI of the resource to read", + "type": "string" + } + }, + "required": [ + "uri" + ] + }, + "Reference": { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "ref/resource" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceTemplateReference" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "ref/prompt" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PromptReference" + } + ], + "required": [ + "type" + ] + } + ] + }, + "Request": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/InitializeResultMethod" + }, + "params": { + "$ref": "#/definitions/InitializeRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request10": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/CallToolRequestMethod" + }, + "params": { + "$ref": "#/definitions/CallToolRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request11": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/GetTaskMethod" + }, + "params": { + "$ref": "#/definitions/GetTaskParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request12": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/UpdateTaskMethod" + }, + "params": { + "$ref": "#/definitions/UpdateTaskParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request13": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/CancelTaskMethod" + }, + "params": { + "$ref": "#/definitions/CancelTaskParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request2": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/DiscoverRequestMethod" + }, + "params": { + "$ref": "#/definitions/DiscoverRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request3": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/CompleteRequestMethod" + }, + "params": { + "$ref": "#/definitions/CompleteRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request4": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/SetLevelRequestMethod" + }, + "params": { + "$ref": "#/definitions/SetLevelRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request5": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/GetPromptRequestMethod" + }, + "params": { + "$ref": "#/definitions/GetPromptRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request6": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ReadResourceRequestMethod" + }, + "params": { + "$ref": "#/definitions/ReadResourceRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request7": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/SubscriptionsListenRequestMethod" + }, + "params": { + "$ref": "#/definitions/SubscriptionsListenRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request8": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/SubscribeRequestMethod" + }, + "params": { + "$ref": "#/definitions/SubscribeRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request9": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/UnsubscribeRequestMethod" + }, + "params": { + "$ref": "#/definitions/UnsubscribeRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "RequestMetaObject": { + "description": "Metadata reserved by MCP on requests. Extension keys are also allowed.", + "type": "object", + "properties": { + "io.modelcontextprotocol/clientCapabilities": { + "$ref": "#/definitions/ClientCapabilities" + }, + "io.modelcontextprotocol/clientInfo": { + "$ref": "#/definitions/Implementation" + }, + "io.modelcontextprotocol/logLevel": { + "$ref": "#/definitions/LoggingLevel" + }, + "io.modelcontextprotocol/protocolVersion": { + "type": "string" + }, + "progressToken": { + "$ref": "#/definitions/ProgressToken" + } + }, + "additionalProperties": true + }, + "RequestNoParam": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/PingRequestMethod" + } + }, + "required": [ + "method" + ] + }, + "RequestOptionalParam": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ListPromptsRequestMethod" + }, + "params": { + "anyOf": [ + { + "$ref": "#/definitions/PaginatedRequestParams" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "method" + ] + }, + "RequestOptionalParam2": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ListResourcesRequestMethod" + }, + "params": { + "anyOf": [ + { + "$ref": "#/definitions/PaginatedRequestParams" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "method" + ] + }, + "RequestOptionalParam3": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ListResourceTemplatesRequestMethod" + }, + "params": { + "anyOf": [ + { + "$ref": "#/definitions/PaginatedRequestParams" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "method" + ] + }, + "RequestOptionalParam4": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ListToolsRequestMethod" + }, + "params": { + "anyOf": [ + { + "$ref": "#/definitions/PaginatedRequestParams" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "method" + ] + }, + "Resource": { + "description": "A known resource that the server is capable of reading (spec `Resource`).\n\nAlso used as the inner type of `ContentBlock::ResourceLink` (spec `ResourceLink extends Resource`).", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this resource.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional annotations describing how the client should use this resource.", + "anyOf": [ + { + "$ref": "#/definitions/Annotations" + }, + { + "type": "null" + } + ] + }, + "description": { + "description": "Optional description of what this resource represents.", + "type": [ + "string", + "null" + ] + }, + "icons": { + "description": "Optional set of icons the client may display for this resource.", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Icon" + } + }, + "mimeType": { + "description": "The MIME type of this resource, if known.", + "type": [ + "string", + "null" + ] + }, + "name": { + "description": "The programmatic name of the resource.", + "type": "string" + }, + "size": { + "description": "The size of the raw resource content in bytes (before base64/tokenization), if known.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "title": { + "description": "Optional human-readable display title.", + "type": [ + "string", + "null" + ] + }, + "uri": { + "description": "The URI of this resource (e.g. `file:///path/to/file`).", + "type": "string" + } + }, + "required": [ + "uri", + "name" + ] + }, + "ResourceContents": { + "description": "The contents of a specific resource or sub-resource.", + "anyOf": [ + { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "mimeType": { + "type": [ + "string", + "null" + ] + }, + "text": { + "type": "string" + }, + "uri": { + "type": "string" + } + }, + "required": [ + "uri", + "text" + ] + }, + { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "blob": { + "type": "string" + }, + "mimeType": { + "type": [ + "string", + "null" + ] + }, + "uri": { + "type": "string" + } + }, + "required": [ + "uri", + "blob" + ] + } + ] + }, + "ResourceTemplateReference": { + "type": "object", + "properties": { + "uri": { + "type": "string" + } + }, + "required": [ + "uri" + ] + }, + "Role": { + "description": "Represents the role of a participant in a conversation or message exchange.\n\nUsed in sampling and chat contexts to distinguish between different\ntypes of message senders in the conversation flow.", + "oneOf": [ + { + "description": "A human user or client making a request", + "type": "string", + "const": "user" + }, + { + "description": "An AI assistant or server providing a response", + "type": "string", + "const": "assistant" + } + ] + }, + "Root": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "uri": { + "type": "string" + } + }, + "deprecated": true, + "required": [ + "uri" + ] + }, + "RootsCapabilities": { + "description": "Roots capability. Deprecated by SEP-2577; remains functional and will be\nremoved in a future release.\nSee .", + "type": "object", + "properties": { + "listChanged": { + "type": [ + "boolean", + "null" + ] + } + } + }, + "RootsListChangedNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/roots/list_changed" + }, + "SamplingCapability": { + "description": "Sampling capability with optional sub-capabilities (SEP-1577).\n\nDeprecated by SEP-2577; remains functional and will be removed in a future\nrelease.\nSee .", + "type": "object", + "properties": { + "context": { + "description": "Support for `includeContext` (soft-deprecated)", + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "tools": { + "description": "Support for `tools` and `toolChoice` parameters", + "type": [ + "object", + "null" + ], + "additionalProperties": true + } + } + }, + "SamplingContent": { + "description": "Single or array content wrapper (SEP-1577).", + "anyOf": [ + { + "$ref": "#/definitions/SamplingMessageContentBlock" + }, + { + "type": "array", + "items": { + "$ref": "#/definitions/SamplingMessageContentBlock" + } + } + ] + }, + "SamplingMessageContentBlock": { + "description": "Content types for sampling messages (SEP-1577).", + "deprecated": true, + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "text" + } + }, + "allOf": [ + { + "$ref": "#/definitions/TextContent" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "image" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ImageContent" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "audio" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AudioContent" + } + ], + "required": [ + "type" + ] + }, + { + "description": "Assistant only", + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "tool_use" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ToolUseContent" + } + ], + "required": [ + "type" + ] + }, + { + "description": "User only", + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "tool_result" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ToolResultContent" + } + ], + "required": [ + "type" + ] + } + ] + }, + "SetLevelRequestMethod": { + "type": "string", + "format": "const", + "const": "logging/setLevel" + }, + "SetLevelRequestParams": { + "description": "Parameters for setting the logging level", + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata for this request (SEP-1319)", + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "level": { + "description": "The desired logging level", + "allOf": [ + { + "$ref": "#/definitions/LoggingLevel" + } + ] + } + }, + "deprecated": true, + "required": [ + "level" + ] + }, + "SubscribeRequestMethod": { + "type": "string", + "format": "const", + "const": "resources/subscribe" + }, + "SubscribeRequestParams": { + "description": "Parameters for subscribing to resource updates", + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata for this request (SEP-1319)", + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "uri": { + "description": "The URI of the resource to subscribe to", + "type": "string" + } + }, + "required": [ + "uri" + ] + }, + "SubscriptionFilter": { + "description": "Notification categories a client opts in to on a `subscriptions/listen` stream.", + "type": "object", + "properties": { + "promptsListChanged": { + "type": "boolean" + }, + "resourceSubscriptions": { + "type": "array", + "items": { + "type": "string" + } + }, + "resourcesListChanged": { + "type": "boolean" + }, + "toolsListChanged": { + "type": "boolean" + } + } + }, + "SubscriptionsListenRequestMethod": { + "type": "string", + "format": "const", + "const": "subscriptions/listen" + }, + "SubscriptionsListenRequestParams": { + "description": "Parameters for opening a long-lived notification subscription.", + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata. Required by the 2026-07-28 wire schema.", + "type": "object", + "properties": { + "io.modelcontextprotocol/clientCapabilities": { + "$ref": "#/definitions/ClientCapabilities" + }, + "io.modelcontextprotocol/clientInfo": { + "$ref": "#/definitions/Implementation" + }, + "io.modelcontextprotocol/logLevel": { + "$ref": "#/definitions/LoggingLevel" + }, + "io.modelcontextprotocol/protocolVersion": { + "type": "string" + }, + "progressToken": { + "$ref": "#/definitions/ProgressToken" + } + }, + "additionalProperties": true, + "required": [ + "io.modelcontextprotocol/protocolVersion", + "io.modelcontextprotocol/clientCapabilities" + ] + }, + "notifications": { + "description": "Notification categories requested for this stream.", + "allOf": [ + { + "$ref": "#/definitions/SubscriptionFilter" + } + ] + } + }, + "required": [ + "_meta", + "notifications" + ] + }, + "TextContent": { + "description": "Text content block (spec `TextContent`).", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this content block.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional annotations describing how the client should use this content.", + "anyOf": [ + { + "$ref": "#/definitions/Annotations" + }, + { + "type": "null" + } + ] + }, + "text": { + "description": "The text content of the message.", + "type": "string" + } + }, + "required": [ + "text" + ] + }, + "ToolResultContent": { + "description": "Tool execution result in user message (SEP-1577).", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "content": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentBlock" + } + }, + "isError": { + "type": [ + "boolean", + "null" + ] + }, + "structuredContent": true, + "toolUseId": { + "type": "string" + } + }, + "deprecated": true, + "required": [ + "toolUseId", + "content" + ] + }, + "ToolUseContent": { + "description": "Tool call request from assistant (SEP-1577).", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "id": { + "type": "string" + }, + "input": { + "type": "object", + "additionalProperties": true + }, + "name": { + "type": "string" + } + }, + "deprecated": true, + "required": [ + "id", + "name", + "input" + ] + }, + "UnsubscribeRequestMethod": { + "type": "string", + "format": "const", + "const": "resources/unsubscribe" + }, + "UnsubscribeRequestParams": { + "description": "Parameters for unsubscribing from resource updates", + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata for this request (SEP-1319)", + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "uri": { + "description": "The URI of the resource to unsubscribe from", + "type": "string" + } + }, + "required": [ + "uri" + ] + }, + "UpdateTaskMethod": { + "type": "string", + "format": "const", + "const": "tasks/update" + }, + "UpdateTaskParams": { + "description": "Parameters for `tasks/update` (SEP-2663): deliver responses to outstanding\nin-task server-to-client requests surfaced via `tasks/get` `inputRequests`.", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "inputResponses": { + "description": "Responses to outstanding `inputRequests` previously surfaced by the\nserver. Each key MUST correspond to a currently-outstanding\n`inputRequests` key.", + "type": "object", + "additionalProperties": true + }, + "taskId": { + "description": "Identifier of the task to update.", + "type": "string" + } + }, + "required": [ + "taskId", + "inputResponses" + ] + }, + "UrlElicitationCapability": { + "description": "Capability for URL mode elicitation.", + "type": "object" + } + } +} \ No newline at end of file diff --git a/vendor/rmcp/tests/test_message_schema/client_json_rpc_message_schema_current.json b/vendor/rmcp/tests/test_message_schema/client_json_rpc_message_schema_current.json new file mode 100644 index 00000000..760d9e18 --- /dev/null +++ b/vendor/rmcp/tests/test_message_schema/client_json_rpc_message_schema_current.json @@ -0,0 +1,2447 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "title": "JsonRpcMessage", + "description": "Represents any JSON-RPC message that can be sent or received.\n\nThis enum covers all possible message types in the JSON-RPC protocol:\nindividual requests/responses, notifications, and errors.\nIt serves as the top-level message container for MCP communication.", + "anyOf": [ + { + "description": "A single request expecting a response", + "allOf": [ + { + "$ref": "#/definitions/JsonRpcRequest" + } + ] + }, + { + "description": "A response to a previous request", + "allOf": [ + { + "$ref": "#/definitions/JsonRpcResponse" + } + ] + }, + { + "description": "A one-way notification (no response expected)", + "allOf": [ + { + "$ref": "#/definitions/JsonRpcNotification" + } + ] + }, + { + "description": "An error response", + "allOf": [ + { + "$ref": "#/definitions/JsonRpcError" + } + ] + } + ], + "definitions": { + "Annotations": { + "description": "Optional annotations for the client. The client can use annotations to inform how objects are\nused or displayed.", + "type": "object", + "properties": { + "audience": { + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Role" + } + }, + "lastModified": { + "type": [ + "string", + "null" + ] + }, + "priority": { + "type": [ + "number", + "null" + ], + "format": "float" + } + } + }, + "ArgumentInfo": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "name", + "value" + ] + }, + "AudioContent": { + "description": "Audio content with base64-encoded data (spec `AudioContent`).", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this content block.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional annotations describing how the client should use this content.", + "anyOf": [ + { + "$ref": "#/definitions/Annotations" + }, + { + "type": "null" + } + ] + }, + "data": { + "description": "The base64-encoded audio data.", + "type": "string" + }, + "mimeType": { + "description": "The MIME type of the audio (e.g. `audio/wav`).", + "type": "string" + } + }, + "required": [ + "data", + "mimeType" + ] + }, + "CallToolRequestMethod": { + "type": "string", + "format": "const", + "const": "tools/call" + }, + "CallToolRequestParams": { + "description": "Parameters for calling a tool provided by an MCP server.\n\nContains the tool name and optional arguments needed to execute\nthe tool operation.", + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata for this request (SEP-1319)", + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "arguments": { + "description": "Arguments to pass to the tool (must match the tool's input schema)", + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "inputResponses": { + "description": "Client responses to server-initiated input requests from a previous\n[`InputRequiredResult`]. Present only when retrying after an incomplete result.", + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "name": { + "description": "The name of the tool to call", + "type": "string" + }, + "requestState": { + "description": "Opaque request state echoed back from a previous [`InputRequiredResult`].\nClients MUST return this value exactly as received.", + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name" + ] + }, + "CancelTaskMethod": { + "type": "string", + "format": "const", + "const": "tasks/cancel" + }, + "CancelTaskParams": { + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata for this request (SEP-1319)", + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "taskId": { + "type": "string" + } + }, + "required": [ + "taskId" + ] + }, + "CancelledNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/cancelled" + }, + "CancelledNotificationParam": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/NotificationMetaObject" + }, + { + "type": "null" + } + ] + }, + "reason": { + "type": [ + "string", + "null" + ] + }, + "requestId": { + "anyOf": [ + { + "$ref": "#/definitions/NumberOrString" + }, + { + "type": "null" + } + ] + } + } + }, + "ClientCapabilities": { + "title": "Builder", + "description": "```rust\n# use rmcp::model::ClientCapabilities;\nlet cap = ClientCapabilities::builder()\n .enable_experimental()\n .build();\n```", + "type": "object", + "properties": { + "elicitation": { + "description": "Capability to handle elicitation requests from servers for interactive user input", + "anyOf": [ + { + "$ref": "#/definitions/ElicitationCapability" + }, + { + "type": "null" + } + ] + }, + "experimental": { + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "object", + "additionalProperties": true + } + }, + "extensions": { + "description": "Optional MCP extensions that the client supports (SEP-1724).\nKeys are extension identifiers (e.g., `\"io.modelcontextprotocol/ui\"`),\nvalues are per-extension settings objects. An empty object indicates\nsupport with no settings.", + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "object", + "additionalProperties": true + } + }, + "roots": { + "description": "Capability for filesystem roots (deprecated by SEP-2577).", + "anyOf": [ + { + "$ref": "#/definitions/RootsCapabilities" + }, + { + "type": "null" + } + ] + }, + "sampling": { + "description": "Capability for LLM sampling requests (SEP-1577, deprecated by SEP-2577).", + "anyOf": [ + { + "$ref": "#/definitions/SamplingCapability" + }, + { + "type": "null" + } + ] + } + } + }, + "ClientResult": { + "anyOf": [ + { + "$ref": "#/definitions/CreateMessageResult" + }, + { + "$ref": "#/definitions/ListRootsResult" + }, + { + "$ref": "#/definitions/ElicitResult" + }, + { + "$ref": "#/definitions/EmptyObject" + }, + { + "$ref": "#/definitions/CustomResult" + } + ] + }, + "CompleteRequestMethod": { + "type": "string", + "format": "const", + "const": "completion/complete" + }, + "CompleteRequestParams": { + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata for this request (SEP-1319)", + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "argument": { + "$ref": "#/definitions/ArgumentInfo" + }, + "context": { + "description": "Optional context containing previously resolved argument values", + "anyOf": [ + { + "$ref": "#/definitions/CompletionContext" + }, + { + "type": "null" + } + ] + }, + "ref": { + "$ref": "#/definitions/Reference" + } + }, + "required": [ + "ref", + "argument" + ] + }, + "CompletionContext": { + "description": "Context for completion requests providing previously resolved arguments.\n\nThis enables context-aware completion where subsequent argument completions\ncan take into account the values of previously resolved arguments.", + "type": "object", + "properties": { + "arguments": { + "description": "Previously resolved argument values that can inform completion suggestions", + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "string" + } + } + } + }, + "ContentBlock": { + "description": "Unified content block union (spec `ContentBlock`).\n\n`text | image | audio | resource_link | resource`", + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "text" + } + }, + "allOf": [ + { + "$ref": "#/definitions/TextContent" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "image" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ImageContent" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "audio" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AudioContent" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "resource" + } + }, + "allOf": [ + { + "$ref": "#/definitions/EmbeddedResource" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "resource_link" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "type" + ] + } + ] + }, + "CreateMessageResult": { + "description": "Result of sampling/createMessage (SEP-1577).\nThe result of a sampling/createMessage request containing the generated response.\n\nThis structure contains the generated message along with metadata about\nhow the generation was performed and why it stopped.", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "content": { + "description": "The actual content of the message (text, image, audio, tool use, or tool result)", + "allOf": [ + { + "$ref": "#/definitions/SamplingContent" + } + ] + }, + "model": { + "description": "The identifier of the model that generated the response", + "type": "string" + }, + "role": { + "description": "The role of the message sender (User or Assistant)", + "allOf": [ + { + "$ref": "#/definitions/Role" + } + ] + }, + "stopReason": { + "description": "The reason why generation stopped (e.g., \"endTurn\", \"maxTokens\")", + "type": [ + "string", + "null" + ] + } + }, + "deprecated": true, + "required": [ + "model", + "role", + "content" + ] + }, + "CustomNotification": { + "description": "A catch-all notification either side can use to send custom messages to its peer.\n\nThis preserves the raw `method` name and `params` payload so handlers can\ndeserialize them into domain-specific types.", + "type": "object", + "properties": { + "method": { + "type": "string" + }, + "params": true + }, + "required": [ + "method" + ] + }, + "CustomRequest": { + "description": "A catch-all request either side can use to send custom messages to its peer.\n\nThis preserves the raw `method` name and `params` payload so handlers can\ndeserialize them into domain-specific types.", + "type": "object", + "properties": { + "method": { + "type": "string" + }, + "params": true + }, + "required": [ + "method" + ] + }, + "CustomResult": { + "description": "A catch-all response either side can use for custom requests." + }, + "DiscoverRequestMethod": { + "type": "string", + "format": "const", + "const": "server/discover" + }, + "DiscoverRequestParams": { + "type": "object", + "properties": { + "_meta": { + "$ref": "#/definitions/RequestMetaObject" + } + }, + "required": [ + "_meta" + ] + }, + "ElicitResult": { + "description": "The result returned by a client in response to an elicitation request.\n\nContains the user's decision (accept/decline/cancel) and optionally their input data\nif they chose to accept the request.", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this result.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "action": { + "description": "The user's decision on how to handle the elicitation request", + "allOf": [ + { + "$ref": "#/definitions/ElicitationAction" + } + ] + }, + "content": { + "description": "The actual data provided by the user, if they accepted the request.\nMust conform to the JSON schema specified in the original request.\nOnly present when action is Accept." + } + }, + "required": [ + "action" + ] + }, + "ElicitationAction": { + "description": "Represents the possible actions a user can take in response to an elicitation request.\n\nWhen a server requests user input through elicitation, the user can:\n- Accept: Provide the requested information and continue\n- Decline: Refuse to provide the information but continue the operation\n- Cancel: Stop the entire operation", + "oneOf": [ + { + "description": "User accepts the request and provides the requested information", + "type": "string", + "const": "accept" + }, + { + "description": "User declines to provide the information but allows the operation to continue", + "type": "string", + "const": "decline" + }, + { + "description": "User cancels the entire operation", + "type": "string", + "const": "cancel" + } + ] + }, + "ElicitationCapability": { + "description": "Elicitation allows servers to request interactive input from users during tool execution.\nThis capability indicates that a client can handle elicitation requests and present\nappropriate UI to users for collecting the requested information.", + "type": "object", + "properties": { + "form": { + "description": "Whether client supports form-based elicitation.", + "anyOf": [ + { + "$ref": "#/definitions/FormElicitationCapability" + }, + { + "type": "null" + } + ] + }, + "url": { + "description": "Whether client supports URL-based elicitation.", + "anyOf": [ + { + "$ref": "#/definitions/UrlElicitationCapability" + }, + { + "type": "null" + } + ] + } + } + }, + "EmbeddedResource": { + "description": "Embedded resource content (spec `EmbeddedResource`).", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this content block.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional annotations describing how the client should use this content.", + "anyOf": [ + { + "$ref": "#/definitions/Annotations" + }, + { + "type": "null" + } + ] + }, + "resource": { + "description": "The embedded resource contents (text or blob).", + "allOf": [ + { + "$ref": "#/definitions/ResourceContents" + } + ] + } + }, + "required": [ + "resource" + ] + }, + "EmptyObject": { + "description": "This is commonly used for representing empty objects in MCP messages.\n\nwithout returning any specific data.", + "type": "object", + "additionalProperties": false + }, + "ErrorCode": { + "description": "Standard JSON-RPC error codes used throughout the MCP protocol.\n\nThese codes follow the JSON-RPC 2.0 specification and provide\nstandardized error reporting across all MCP implementations.", + "type": "integer", + "format": "int32" + }, + "ErrorData": { + "description": "Error information for JSON-RPC error responses.\n\nThis structure follows the JSON-RPC 2.0 specification for error reporting,\nproviding a standardized way to communicate errors between clients and servers.", + "type": "object", + "properties": { + "code": { + "description": "The error type that occurred (using standard JSON-RPC error codes)", + "allOf": [ + { + "$ref": "#/definitions/ErrorCode" + } + ] + }, + "data": { + "description": "Additional information about the error. The value of this member is defined by the\nsender (e.g. detailed error information, nested errors etc.)." + }, + "message": { + "description": "A short description of the error. The message SHOULD be limited to a concise single sentence.", + "type": "string" + } + }, + "required": [ + "code", + "message" + ] + }, + "FormElicitationCapability": { + "description": "Capability for handling elicitation requests from servers.\nElicitation allows servers to request interactive input from users during tool execution.\nThis capability indicates that a client can handle elicitation requests and present\nappropriate UI to users for collecting the requested information.\n\nCapability for form mode elicitation.", + "type": "object", + "properties": { + "schemaValidation": { + "description": "Whether the client supports JSON Schema validation for elicitation responses.\nWhen true, the client will validate user input against the requested_schema\nbefore sending the response back to the server.", + "type": [ + "boolean", + "null" + ] + } + } + }, + "GetPromptRequestMethod": { + "type": "string", + "format": "const", + "const": "prompts/get" + }, + "GetPromptRequestParams": { + "description": "Parameters for retrieving a specific prompt", + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata for this request (SEP-1319)", + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "arguments": { + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "inputResponses": { + "description": "Client responses to server-initiated input requests from a previous\n[`InputRequiredResult`].", + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "name": { + "type": "string" + }, + "requestState": { + "description": "Opaque request state echoed back from a previous [`InputRequiredResult`].", + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name" + ] + }, + "GetTaskMethod": { + "type": "string", + "format": "const", + "const": "tasks/get" + }, + "GetTaskParams": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "taskId": { + "description": "Identifier of the task to query.", + "type": "string" + } + }, + "required": [ + "taskId" + ] + }, + "Icon": { + "description": "A URL pointing to an icon resource or a base64-encoded data URI.\n\nClients that support rendering icons MUST support at least the following MIME types:\n- image/png - PNG images (safe, universal compatibility)\n- image/jpeg (and image/jpg) - JPEG images (safe, universal compatibility)\n\nClients that support rendering icons SHOULD also support:\n- image/svg+xml - SVG images (scalable but requires security precautions)\n- image/webp - WebP images (modern, efficient format)", + "type": "object", + "properties": { + "mimeType": { + "description": "Optional override if the server's MIME type is missing or generic", + "type": [ + "string", + "null" + ] + }, + "sizes": { + "description": "Size specification, each string should be in WxH format (e.g., `\\\"48x48\\\"`, `\\\"96x96\\\"`) or `\\\"any\\\"` for scalable formats like SVG", + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "src": { + "description": "A standard URI pointing to an icon resource", + "type": "string" + }, + "theme": { + "description": "Optional specifier for the theme this icon is designed for\nIf not provided, the client should assume the icon can be used with any theme.", + "anyOf": [ + { + "$ref": "#/definitions/IconTheme" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "src" + ] + }, + "IconTheme": { + "description": "Icon themes supported by the MCP specification", + "oneOf": [ + { + "description": "Indicates the icon is designed to be used with a light background", + "type": "string", + "const": "light" + }, + { + "description": "Indicates the icon is designed to be used with a dark background", + "type": "string", + "const": "dark" + } + ] + }, + "ImageContent": { + "description": "Image content with base64-encoded data (spec `ImageContent`).", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this content block.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional annotations describing how the client should use this content.", + "anyOf": [ + { + "$ref": "#/definitions/Annotations" + }, + { + "type": "null" + } + ] + }, + "data": { + "description": "The base64-encoded image data.", + "type": "string" + }, + "mimeType": { + "description": "The MIME type of the image (e.g. `image/png`).", + "type": "string" + } + }, + "required": [ + "data", + "mimeType" + ] + }, + "Implementation": { + "type": "object", + "properties": { + "description": { + "type": [ + "string", + "null" + ] + }, + "icons": { + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Icon" + } + }, + "name": { + "type": "string" + }, + "title": { + "type": [ + "string", + "null" + ] + }, + "version": { + "type": "string" + }, + "websiteUrl": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name", + "version" + ] + }, + "InitializeRequestParams": { + "description": "Parameters sent by a client when initializing a connection to an MCP server.\n\nThis contains the client's protocol version, capabilities, and implementation\ninformation, allowing the server to understand what the client supports.", + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata for this request (SEP-1319)", + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "capabilities": { + "description": "The capabilities this client supports (sampling, roots, etc.)", + "allOf": [ + { + "$ref": "#/definitions/ClientCapabilities" + } + ] + }, + "clientInfo": { + "description": "Information about the client implementation", + "allOf": [ + { + "$ref": "#/definitions/Implementation" + } + ] + }, + "protocolVersion": { + "description": "The MCP protocol version this client supports", + "allOf": [ + { + "$ref": "#/definitions/ProtocolVersion" + } + ] + } + }, + "required": [ + "protocolVersion", + "capabilities", + "clientInfo" + ] + }, + "InitializeResultMethod": { + "type": "string", + "format": "const", + "const": "initialize" + }, + "InitializedNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/initialized" + }, + "JsonRpcError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorData" + }, + "id": { + "anyOf": [ + { + "$ref": "#/definitions/NumberOrString" + }, + { + "type": "null" + } + ] + }, + "jsonrpc": { + "$ref": "#/definitions/JsonRpcVersion2_0" + } + }, + "required": [ + "jsonrpc", + "error" + ] + }, + "JsonRpcNotification": { + "type": "object", + "properties": { + "jsonrpc": { + "$ref": "#/definitions/JsonRpcVersion2_0" + } + }, + "anyOf": [ + { + "$ref": "#/definitions/Notification" + }, + { + "$ref": "#/definitions/Notification2" + }, + { + "$ref": "#/definitions/NotificationNoParam" + }, + { + "$ref": "#/definitions/NotificationNoParam2" + }, + { + "$ref": "#/definitions/CustomNotification" + } + ], + "required": [ + "jsonrpc" + ] + }, + "JsonRpcRequest": { + "type": "object", + "properties": { + "id": { + "$ref": "#/definitions/NumberOrString" + }, + "jsonrpc": { + "$ref": "#/definitions/JsonRpcVersion2_0" + } + }, + "anyOf": [ + { + "$ref": "#/definitions/RequestNoParam" + }, + { + "$ref": "#/definitions/Request" + }, + { + "$ref": "#/definitions/Request2" + }, + { + "$ref": "#/definitions/Request3" + }, + { + "$ref": "#/definitions/Request4" + }, + { + "$ref": "#/definitions/Request5" + }, + { + "$ref": "#/definitions/RequestOptionalParam" + }, + { + "$ref": "#/definitions/RequestOptionalParam2" + }, + { + "$ref": "#/definitions/RequestOptionalParam3" + }, + { + "$ref": "#/definitions/Request6" + }, + { + "$ref": "#/definitions/Request7" + }, + { + "$ref": "#/definitions/Request8" + }, + { + "$ref": "#/definitions/Request9" + }, + { + "$ref": "#/definitions/Request10" + }, + { + "$ref": "#/definitions/RequestOptionalParam4" + }, + { + "$ref": "#/definitions/Request11" + }, + { + "$ref": "#/definitions/Request12" + }, + { + "$ref": "#/definitions/Request13" + }, + { + "$ref": "#/definitions/CustomRequest" + } + ], + "required": [ + "jsonrpc", + "id" + ] + }, + "JsonRpcResponse": { + "type": "object", + "properties": { + "id": { + "$ref": "#/definitions/NumberOrString" + }, + "jsonrpc": { + "$ref": "#/definitions/JsonRpcVersion2_0" + }, + "result": { + "$ref": "#/definitions/ClientResult" + } + }, + "required": [ + "jsonrpc", + "id", + "result" + ] + }, + "JsonRpcVersion2_0": { + "type": "string", + "format": "const", + "const": "2.0" + }, + "ListPromptsRequestMethod": { + "type": "string", + "format": "const", + "const": "prompts/list" + }, + "ListResourceTemplatesRequestMethod": { + "type": "string", + "format": "const", + "const": "resources/templates/list" + }, + "ListResourcesRequestMethod": { + "type": "string", + "format": "const", + "const": "resources/list" + }, + "ListRootsResult": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "roots": { + "type": "array", + "items": { + "$ref": "#/definitions/Root" + } + } + }, + "deprecated": true, + "required": [ + "roots" + ] + }, + "ListToolsRequestMethod": { + "type": "string", + "format": "const", + "const": "tools/list" + }, + "LoggingLevel": { + "description": "Logging levels supported by the MCP protocol", + "type": "string", + "deprecated": true, + "enum": [ + "debug", + "info", + "notice", + "warning", + "error", + "critical", + "alert", + "emergency" + ] + }, + "MetaObject": { + "description": "See [MCP general fields](https://modelcontextprotocol.io/specification/2026-07-28/basic#general-fields) for notes on _meta usage.", + "type": "object", + "additionalProperties": true + }, + "Notification": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/CancelledNotificationMethod" + }, + "params": { + "$ref": "#/definitions/CancelledNotificationParam" + } + }, + "required": [ + "method", + "params" + ] + }, + "Notification2": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ProgressNotificationMethod" + }, + "params": { + "$ref": "#/definitions/ProgressNotificationParam" + } + }, + "required": [ + "method", + "params" + ] + }, + "NotificationMetaObject": { + "description": "Metadata reserved by MCP on notifications. Extension keys are also allowed.", + "type": "object", + "properties": { + "io.modelcontextprotocol/subscriptionId": { + "$ref": "#/definitions/NumberOrString" + } + }, + "additionalProperties": true + }, + "NotificationNoParam": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/InitializedNotificationMethod" + } + }, + "required": [ + "method" + ] + }, + "NotificationNoParam2": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/RootsListChangedNotificationMethod" + } + }, + "required": [ + "method" + ] + }, + "NumberOrString": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "PaginatedRequestParams": { + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata for this request (SEP-1319)", + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "cursor": { + "type": [ + "string", + "null" + ] + } + } + }, + "PingRequestMethod": { + "type": "string", + "format": "const", + "const": "ping" + }, + "ProgressNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/progress" + }, + "ProgressNotificationParam": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/NotificationMetaObject" + }, + { + "type": "null" + } + ] + }, + "message": { + "description": "An optional message describing the current progress.", + "type": [ + "string", + "null" + ] + }, + "progress": { + "description": "The progress thus far. This should increase every time progress is made, even if the total is unknown.", + "type": "number", + "format": "double" + }, + "progressToken": { + "$ref": "#/definitions/ProgressToken" + }, + "total": { + "description": "Total number of items to process (or total progress required), if known", + "type": [ + "number", + "null" + ], + "format": "double" + } + }, + "required": [ + "progressToken", + "progress" + ] + }, + "ProgressToken": { + "description": "A token used to track the progress of long-running operations.\n\nProgress tokens allow clients and servers to associate progress notifications\nwith specific requests, enabling real-time updates on operation status.", + "allOf": [ + { + "$ref": "#/definitions/NumberOrString" + } + ] + }, + "PromptReference": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "title": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name" + ] + }, + "ProtocolVersion": { + "description": "Represents the MCP protocol version used for communication.\n\nThis ensures compatibility between clients and servers by specifying\nwhich version of the Model Context Protocol is being used.", + "type": "string" + }, + "ReadResourceRequestMethod": { + "type": "string", + "format": "const", + "const": "resources/read" + }, + "ReadResourceRequestParams": { + "description": "Parameters for reading a specific resource", + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata for this request (SEP-1319)", + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "inputResponses": { + "description": "Client responses to server-initiated input requests from a previous\n[`InputRequiredResult`].", + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "requestState": { + "description": "Opaque request state echoed back from a previous [`InputRequiredResult`].", + "type": [ + "string", + "null" + ] + }, + "uri": { + "description": "The URI of the resource to read", + "type": "string" + } + }, + "required": [ + "uri" + ] + }, + "Reference": { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "ref/resource" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceTemplateReference" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "ref/prompt" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PromptReference" + } + ], + "required": [ + "type" + ] + } + ] + }, + "Request": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/InitializeResultMethod" + }, + "params": { + "$ref": "#/definitions/InitializeRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request10": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/CallToolRequestMethod" + }, + "params": { + "$ref": "#/definitions/CallToolRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request11": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/GetTaskMethod" + }, + "params": { + "$ref": "#/definitions/GetTaskParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request12": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/UpdateTaskMethod" + }, + "params": { + "$ref": "#/definitions/UpdateTaskParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request13": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/CancelTaskMethod" + }, + "params": { + "$ref": "#/definitions/CancelTaskParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request2": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/DiscoverRequestMethod" + }, + "params": { + "$ref": "#/definitions/DiscoverRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request3": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/CompleteRequestMethod" + }, + "params": { + "$ref": "#/definitions/CompleteRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request4": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/SetLevelRequestMethod" + }, + "params": { + "$ref": "#/definitions/SetLevelRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request5": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/GetPromptRequestMethod" + }, + "params": { + "$ref": "#/definitions/GetPromptRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request6": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ReadResourceRequestMethod" + }, + "params": { + "$ref": "#/definitions/ReadResourceRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request7": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/SubscriptionsListenRequestMethod" + }, + "params": { + "$ref": "#/definitions/SubscriptionsListenRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request8": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/SubscribeRequestMethod" + }, + "params": { + "$ref": "#/definitions/SubscribeRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request9": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/UnsubscribeRequestMethod" + }, + "params": { + "$ref": "#/definitions/UnsubscribeRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "RequestMetaObject": { + "description": "Metadata reserved by MCP on requests. Extension keys are also allowed.", + "type": "object", + "properties": { + "io.modelcontextprotocol/clientCapabilities": { + "$ref": "#/definitions/ClientCapabilities" + }, + "io.modelcontextprotocol/clientInfo": { + "$ref": "#/definitions/Implementation" + }, + "io.modelcontextprotocol/logLevel": { + "$ref": "#/definitions/LoggingLevel" + }, + "io.modelcontextprotocol/protocolVersion": { + "type": "string" + }, + "progressToken": { + "$ref": "#/definitions/ProgressToken" + } + }, + "additionalProperties": true + }, + "RequestNoParam": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/PingRequestMethod" + } + }, + "required": [ + "method" + ] + }, + "RequestOptionalParam": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ListPromptsRequestMethod" + }, + "params": { + "anyOf": [ + { + "$ref": "#/definitions/PaginatedRequestParams" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "method" + ] + }, + "RequestOptionalParam2": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ListResourcesRequestMethod" + }, + "params": { + "anyOf": [ + { + "$ref": "#/definitions/PaginatedRequestParams" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "method" + ] + }, + "RequestOptionalParam3": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ListResourceTemplatesRequestMethod" + }, + "params": { + "anyOf": [ + { + "$ref": "#/definitions/PaginatedRequestParams" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "method" + ] + }, + "RequestOptionalParam4": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ListToolsRequestMethod" + }, + "params": { + "anyOf": [ + { + "$ref": "#/definitions/PaginatedRequestParams" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "method" + ] + }, + "Resource": { + "description": "A known resource that the server is capable of reading (spec `Resource`).\n\nAlso used as the inner type of `ContentBlock::ResourceLink` (spec `ResourceLink extends Resource`).", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this resource.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional annotations describing how the client should use this resource.", + "anyOf": [ + { + "$ref": "#/definitions/Annotations" + }, + { + "type": "null" + } + ] + }, + "description": { + "description": "Optional description of what this resource represents.", + "type": [ + "string", + "null" + ] + }, + "icons": { + "description": "Optional set of icons the client may display for this resource.", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Icon" + } + }, + "mimeType": { + "description": "The MIME type of this resource, if known.", + "type": [ + "string", + "null" + ] + }, + "name": { + "description": "The programmatic name of the resource.", + "type": "string" + }, + "size": { + "description": "The size of the raw resource content in bytes (before base64/tokenization), if known.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "title": { + "description": "Optional human-readable display title.", + "type": [ + "string", + "null" + ] + }, + "uri": { + "description": "The URI of this resource (e.g. `file:///path/to/file`).", + "type": "string" + } + }, + "required": [ + "uri", + "name" + ] + }, + "ResourceContents": { + "description": "The contents of a specific resource or sub-resource.", + "anyOf": [ + { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "mimeType": { + "type": [ + "string", + "null" + ] + }, + "text": { + "type": "string" + }, + "uri": { + "type": "string" + } + }, + "required": [ + "uri", + "text" + ] + }, + { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "blob": { + "type": "string" + }, + "mimeType": { + "type": [ + "string", + "null" + ] + }, + "uri": { + "type": "string" + } + }, + "required": [ + "uri", + "blob" + ] + } + ] + }, + "ResourceTemplateReference": { + "type": "object", + "properties": { + "uri": { + "type": "string" + } + }, + "required": [ + "uri" + ] + }, + "Role": { + "description": "Represents the role of a participant in a conversation or message exchange.\n\nUsed in sampling and chat contexts to distinguish between different\ntypes of message senders in the conversation flow.", + "oneOf": [ + { + "description": "A human user or client making a request", + "type": "string", + "const": "user" + }, + { + "description": "An AI assistant or server providing a response", + "type": "string", + "const": "assistant" + } + ] + }, + "Root": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "uri": { + "type": "string" + } + }, + "deprecated": true, + "required": [ + "uri" + ] + }, + "RootsCapabilities": { + "description": "Roots capability. Deprecated by SEP-2577; remains functional and will be\nremoved in a future release.\nSee .", + "type": "object", + "properties": { + "listChanged": { + "type": [ + "boolean", + "null" + ] + } + } + }, + "RootsListChangedNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/roots/list_changed" + }, + "SamplingCapability": { + "description": "Sampling capability with optional sub-capabilities (SEP-1577).\n\nDeprecated by SEP-2577; remains functional and will be removed in a future\nrelease.\nSee .", + "type": "object", + "properties": { + "context": { + "description": "Support for `includeContext` (soft-deprecated)", + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "tools": { + "description": "Support for `tools` and `toolChoice` parameters", + "type": [ + "object", + "null" + ], + "additionalProperties": true + } + } + }, + "SamplingContent": { + "description": "Single or array content wrapper (SEP-1577).", + "anyOf": [ + { + "$ref": "#/definitions/SamplingMessageContentBlock" + }, + { + "type": "array", + "items": { + "$ref": "#/definitions/SamplingMessageContentBlock" + } + } + ] + }, + "SamplingMessageContentBlock": { + "description": "Content types for sampling messages (SEP-1577).", + "deprecated": true, + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "text" + } + }, + "allOf": [ + { + "$ref": "#/definitions/TextContent" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "image" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ImageContent" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "audio" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AudioContent" + } + ], + "required": [ + "type" + ] + }, + { + "description": "Assistant only", + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "tool_use" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ToolUseContent" + } + ], + "required": [ + "type" + ] + }, + { + "description": "User only", + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "tool_result" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ToolResultContent" + } + ], + "required": [ + "type" + ] + } + ] + }, + "SetLevelRequestMethod": { + "type": "string", + "format": "const", + "const": "logging/setLevel" + }, + "SetLevelRequestParams": { + "description": "Parameters for setting the logging level", + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata for this request (SEP-1319)", + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "level": { + "description": "The desired logging level", + "allOf": [ + { + "$ref": "#/definitions/LoggingLevel" + } + ] + } + }, + "deprecated": true, + "required": [ + "level" + ] + }, + "SubscribeRequestMethod": { + "type": "string", + "format": "const", + "const": "resources/subscribe" + }, + "SubscribeRequestParams": { + "description": "Parameters for subscribing to resource updates", + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata for this request (SEP-1319)", + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "uri": { + "description": "The URI of the resource to subscribe to", + "type": "string" + } + }, + "required": [ + "uri" + ] + }, + "SubscriptionFilter": { + "description": "Notification categories a client opts in to on a `subscriptions/listen` stream.", + "type": "object", + "properties": { + "promptsListChanged": { + "type": "boolean" + }, + "resourceSubscriptions": { + "type": "array", + "items": { + "type": "string" + } + }, + "resourcesListChanged": { + "type": "boolean" + }, + "toolsListChanged": { + "type": "boolean" + } + } + }, + "SubscriptionsListenRequestMethod": { + "type": "string", + "format": "const", + "const": "subscriptions/listen" + }, + "SubscriptionsListenRequestParams": { + "description": "Parameters for opening a long-lived notification subscription.", + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata. Required by the 2026-07-28 wire schema.", + "type": "object", + "properties": { + "io.modelcontextprotocol/clientCapabilities": { + "$ref": "#/definitions/ClientCapabilities" + }, + "io.modelcontextprotocol/clientInfo": { + "$ref": "#/definitions/Implementation" + }, + "io.modelcontextprotocol/logLevel": { + "$ref": "#/definitions/LoggingLevel" + }, + "io.modelcontextprotocol/protocolVersion": { + "type": "string" + }, + "progressToken": { + "$ref": "#/definitions/ProgressToken" + } + }, + "additionalProperties": true, + "required": [ + "io.modelcontextprotocol/protocolVersion", + "io.modelcontextprotocol/clientCapabilities" + ] + }, + "notifications": { + "description": "Notification categories requested for this stream.", + "allOf": [ + { + "$ref": "#/definitions/SubscriptionFilter" + } + ] + } + }, + "required": [ + "_meta", + "notifications" + ] + }, + "TextContent": { + "description": "Text content block (spec `TextContent`).", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this content block.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional annotations describing how the client should use this content.", + "anyOf": [ + { + "$ref": "#/definitions/Annotations" + }, + { + "type": "null" + } + ] + }, + "text": { + "description": "The text content of the message.", + "type": "string" + } + }, + "required": [ + "text" + ] + }, + "ToolResultContent": { + "description": "Tool execution result in user message (SEP-1577).", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "content": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentBlock" + } + }, + "isError": { + "type": [ + "boolean", + "null" + ] + }, + "structuredContent": true, + "toolUseId": { + "type": "string" + } + }, + "deprecated": true, + "required": [ + "toolUseId", + "content" + ] + }, + "ToolUseContent": { + "description": "Tool call request from assistant (SEP-1577).", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "id": { + "type": "string" + }, + "input": { + "type": "object", + "additionalProperties": true + }, + "name": { + "type": "string" + } + }, + "deprecated": true, + "required": [ + "id", + "name", + "input" + ] + }, + "UnsubscribeRequestMethod": { + "type": "string", + "format": "const", + "const": "resources/unsubscribe" + }, + "UnsubscribeRequestParams": { + "description": "Parameters for unsubscribing from resource updates", + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata for this request (SEP-1319)", + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "uri": { + "description": "The URI of the resource to unsubscribe from", + "type": "string" + } + }, + "required": [ + "uri" + ] + }, + "UpdateTaskMethod": { + "type": "string", + "format": "const", + "const": "tasks/update" + }, + "UpdateTaskParams": { + "description": "Parameters for `tasks/update` (SEP-2663): deliver responses to outstanding\nin-task server-to-client requests surfaced via `tasks/get` `inputRequests`.", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "inputResponses": { + "description": "Responses to outstanding `inputRequests` previously surfaced by the\nserver. Each key MUST correspond to a currently-outstanding\n`inputRequests` key.", + "type": "object", + "additionalProperties": true + }, + "taskId": { + "description": "Identifier of the task to update.", + "type": "string" + } + }, + "required": [ + "taskId", + "inputResponses" + ] + }, + "UrlElicitationCapability": { + "description": "Capability for URL mode elicitation.", + "type": "object" + } + } +} \ No newline at end of file diff --git a/vendor/rmcp/tests/test_message_schema/server_json_rpc_message_schema.json b/vendor/rmcp/tests/test_message_schema/server_json_rpc_message_schema.json new file mode 100644 index 00000000..cebb3ed3 --- /dev/null +++ b/vendor/rmcp/tests/test_message_schema/server_json_rpc_message_schema.json @@ -0,0 +1,4117 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "title": "JsonRpcMessage", + "description": "Represents any JSON-RPC message that can be sent or received.\n\nThis enum covers all possible message types in the JSON-RPC protocol:\nindividual requests/responses, notifications, and errors.\nIt serves as the top-level message container for MCP communication.", + "anyOf": [ + { + "description": "A single request expecting a response", + "allOf": [ + { + "$ref": "#/definitions/JsonRpcRequest" + } + ] + }, + { + "description": "A response to a previous request", + "allOf": [ + { + "$ref": "#/definitions/JsonRpcResponse" + } + ] + }, + { + "description": "A one-way notification (no response expected)", + "allOf": [ + { + "$ref": "#/definitions/JsonRpcNotification" + } + ] + }, + { + "description": "An error response", + "allOf": [ + { + "$ref": "#/definitions/JsonRpcError" + } + ] + } + ], + "definitions": { + "Annotations": { + "description": "Optional annotations for the client. The client can use annotations to inform how objects are\nused or displayed.", + "type": "object", + "properties": { + "audience": { + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Role" + } + }, + "lastModified": { + "type": [ + "string", + "null" + ] + }, + "priority": { + "type": [ + "number", + "null" + ], + "format": "float" + } + } + }, + "ArrayTypeConst": { + "type": "string", + "format": "const", + "const": "array" + }, + "AudioContent": { + "description": "Audio content with base64-encoded data (spec `AudioContent`).", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this content block.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional annotations describing how the client should use this content.", + "anyOf": [ + { + "$ref": "#/definitions/Annotations" + }, + { + "type": "null" + } + ] + }, + "data": { + "description": "The base64-encoded audio data.", + "type": "string" + }, + "mimeType": { + "description": "The MIME type of the audio (e.g. `audio/wav`).", + "type": "string" + } + }, + "required": [ + "data", + "mimeType" + ] + }, + "BooleanSchema": { + "description": "Schema definition for boolean properties.", + "type": "object", + "properties": { + "default": { + "description": "Default value", + "type": [ + "boolean", + "null" + ] + }, + "description": { + "description": "Human-readable description", + "type": [ + "string", + "null" + ] + }, + "title": { + "description": "Optional title for the schema", + "type": [ + "string", + "null" + ] + }, + "type": { + "description": "Type discriminator", + "allOf": [ + { + "$ref": "#/definitions/BooleanTypeConst" + } + ] + } + }, + "required": [ + "type" + ] + }, + "BooleanTypeConst": { + "type": "string", + "format": "const", + "const": "boolean" + }, + "CacheScope": { + "description": "Scope describing who may cache cacheable list/read results (SEP-2549).\n\nDefaults to [`CacheScope::Public`] when absent from the wire.", + "oneOf": [ + { + "description": "Any client or intermediary may cache and serve the response to any user.", + "type": "string", + "const": "public" + }, + { + "description": "Only the requesting user's client may cache the response.", + "type": "string", + "const": "private" + } + ] + }, + "CallToolResult": { + "description": "The result of a tool call operation.\n\nContains the content returned by the tool execution and an optional\nflag indicating whether the operation resulted in an error.", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this result", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "content": { + "description": "The content returned by the tool (text, images, etc.)", + "type": "array", + "default": [], + "items": { + "$ref": "#/definitions/ContentBlock" + } + }, + "isError": { + "description": "Whether this result represents an error condition", + "type": [ + "boolean", + "null" + ] + }, + "resultType": { + "description": "Result type discriminator (SEP-2322). Required by the [spec schema]\nfor servers implementing protocol version `2026-07-28`, but optional\nhere because this type also models results from older protocol\nversions, which do not carry the field: `None` means absent on the\nwire, and per the spec \"the client MUST treat the absent field as\n`\"complete\"`\". Constructors default to `Some(ResultType::COMPLETE)`;\nthe server handler clears the field when responding to peers that\nnegotiated an older version.\n\n[spec schema]: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/271ecc9accafdd9b83a3c869fa67c22953b2af80/schema/2026-07-28/schema.ts#L219-L235", + "anyOf": [ + { + "$ref": "#/definitions/ResultType" + }, + { + "type": "null" + } + ] + }, + "structuredContent": { + "description": "An optional JSON value that represents the structured result of the tool call.\nIt can be any JSON value, including `null`; an explicit `null` is kept\ndistinct from an absent field." + } + } + }, + "CancelledNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/cancelled" + }, + "CancelledNotificationParam": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/NotificationMetaObject" + }, + { + "type": "null" + } + ] + }, + "reason": { + "type": [ + "string", + "null" + ] + }, + "requestId": { + "anyOf": [ + { + "$ref": "#/definitions/NumberOrString" + }, + { + "type": "null" + } + ] + } + } + }, + "ClientCapabilities": { + "title": "Builder", + "description": "```rust\n# use rmcp::model::ClientCapabilities;\nlet cap = ClientCapabilities::builder()\n .enable_experimental()\n .build();\n```", + "type": "object", + "properties": { + "elicitation": { + "description": "Capability to handle elicitation requests from servers for interactive user input", + "anyOf": [ + { + "$ref": "#/definitions/ElicitationCapability" + }, + { + "type": "null" + } + ] + }, + "experimental": { + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "object", + "additionalProperties": true + } + }, + "extensions": { + "description": "Optional MCP extensions that the client supports (SEP-1724).\nKeys are extension identifiers (e.g., `\"io.modelcontextprotocol/ui\"`),\nvalues are per-extension settings objects. An empty object indicates\nsupport with no settings.", + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "object", + "additionalProperties": true + } + }, + "roots": { + "description": "Capability for filesystem roots (deprecated by SEP-2577).", + "anyOf": [ + { + "$ref": "#/definitions/RootsCapabilities" + }, + { + "type": "null" + } + ] + }, + "sampling": { + "description": "Capability for LLM sampling requests (SEP-1577, deprecated by SEP-2577).", + "anyOf": [ + { + "$ref": "#/definitions/SamplingCapability" + }, + { + "type": "null" + } + ] + } + } + }, + "CompleteResult": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "completion": { + "$ref": "#/definitions/CompletionInfo" + }, + "resultType": { + "description": "Result type discriminator (SEP-2322). Required by the [spec schema]\nfor servers implementing protocol version `2026-07-28`, but optional\nhere because this type also models results from older protocol\nversions, which do not carry the field: `None` means absent on the\nwire, and per the spec \"the client MUST treat the absent field as\n`\"complete\"`\". Constructors default to `Some(ResultType::COMPLETE)`;\nthe server handler clears the field when responding to peers that\nnegotiated an older version.\n\n[spec schema]: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/271ecc9accafdd9b83a3c869fa67c22953b2af80/schema/2026-07-28/schema.ts#L219-L235", + "anyOf": [ + { + "$ref": "#/definitions/ResultType" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "completion" + ] + }, + "CompletionInfo": { + "type": "object", + "properties": { + "hasMore": { + "type": [ + "boolean", + "null" + ] + }, + "total": { + "type": [ + "integer", + "null" + ], + "format": "uint32", + "minimum": 0 + }, + "values": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "values" + ] + }, + "ConstTitle": { + "description": "Schema definition for enum properties.\n\nRepresent single entry for titled item", + "type": "object", + "properties": { + "const": { + "type": "string" + }, + "title": { + "type": "string" + } + }, + "required": [ + "const", + "title" + ] + }, + "ContentBlock": { + "description": "Unified content block union (spec `ContentBlock`).\n\n`text | image | audio | resource_link | resource`", + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "text" + } + }, + "allOf": [ + { + "$ref": "#/definitions/TextContent" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "image" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ImageContent" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "audio" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AudioContent" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "resource" + } + }, + "allOf": [ + { + "$ref": "#/definitions/EmbeddedResource" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "resource_link" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "type" + ] + } + ] + }, + "ContextInclusion": { + "description": "Specifies how much context should be included in sampling requests.\n\nThis allows clients to control what additional context information\nshould be provided to the LLM when processing sampling requests.", + "oneOf": [ + { + "description": "Include context from all connected MCP servers", + "type": "string", + "const": "allServers" + }, + { + "description": "Include no additional context", + "type": "string", + "const": "none" + }, + { + "description": "Include context only from the requesting server", + "type": "string", + "const": "thisServer" + } + ] + }, + "CreateMessageRequestMethod": { + "type": "string", + "format": "const", + "const": "sampling/createMessage" + }, + "CreateMessageRequestParams": { + "description": "Parameters for creating a message through LLM sampling.\n\nThis structure contains all the necessary information for a client to\ngenerate an LLM response, including conversation history, model preferences,\nand generation parameters.\n\nThis implements `TaskAugmentedRequestParamsMeta` as sampling requests can be\nlong-running and may benefit from task-based execution.", + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata for this request (SEP-1319)", + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "includeContext": { + "description": "How much context to include from MCP servers", + "anyOf": [ + { + "$ref": "#/definitions/ContextInclusion" + }, + { + "type": "null" + } + ] + }, + "maxTokens": { + "description": "Maximum number of tokens to generate", + "type": "integer", + "format": "uint32", + "minimum": 0 + }, + "messages": { + "description": "The conversation history and current messages", + "type": "array", + "items": { + "$ref": "#/definitions/SamplingMessage" + } + }, + "metadata": { + "description": "Additional metadata for the request" + }, + "modelPreferences": { + "description": "Preferences for model selection and behavior", + "anyOf": [ + { + "$ref": "#/definitions/ModelPreferences" + }, + { + "type": "null" + } + ] + }, + "stopSequences": { + "description": "Sequences that should stop generation", + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "systemPrompt": { + "description": "System prompt to guide the model's behavior", + "type": [ + "string", + "null" + ] + }, + "temperature": { + "description": "Temperature for controlling randomness (0.0 to 1.0)", + "type": [ + "number", + "null" + ], + "format": "float" + }, + "toolChoice": { + "description": "Tool selection behavior (SEP-1577)", + "anyOf": [ + { + "$ref": "#/definitions/ToolChoice" + }, + { + "type": "null" + } + ] + }, + "tools": { + "description": "Tools available for the model to call (SEP-1577)", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Tool" + } + } + }, + "deprecated": true, + "required": [ + "messages", + "maxTokens" + ] + }, + "CreateTaskResult": { + "description": "Result returned in lieu of a standard result to indicate the request will\nbe processed asynchronously (spec `CreateTaskResult`, `resultType: \"task\"`).\n\nThe embedded task is the seed state for the task; the client uses\n`task.task_id` for all subsequent `tasks/get`, `tasks/update`, and\n`tasks/cancel` calls.", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "createdAt": { + "description": "ISO 8601 timestamp when the task was created.", + "type": "string" + }, + "lastUpdatedAt": { + "description": "ISO 8601 timestamp when the task was last updated.", + "type": "string" + }, + "pollIntervalMs": { + "description": "Suggested polling interval in integer milliseconds. Clients SHOULD honor\nthis value to avoid overwhelming the server. This value MAY change over\nthe lifetime of a task.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "resultType": { + "description": "Always `\"task\"`.", + "allOf": [ + { + "$ref": "#/definitions/ResultType" + } + ] + }, + "status": { + "description": "Current task status.", + "allOf": [ + { + "$ref": "#/definitions/TaskStatus" + } + ] + }, + "statusMessage": { + "description": "Optional message describing the current task state.\nThis MAY be exposed to the end-user or model.", + "type": [ + "string", + "null" + ] + }, + "taskId": { + "description": "Stable identifier for this task, generated by the server.", + "type": "string" + }, + "ttlMs": { + "description": "Time-to-live duration from creation in integer milliseconds; `None`\n(serialized as `null`) means unlimited. The server may discard the task\nafter the TTL elapses. This value MAY change over the lifetime of a task.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + } + }, + "required": [ + "resultType", + "taskId", + "status", + "createdAt", + "lastUpdatedAt" + ] + }, + "CustomNotification": { + "description": "A catch-all notification either side can use to send custom messages to its peer.\n\nThis preserves the raw `method` name and `params` payload so handlers can\ndeserialize them into domain-specific types.", + "type": "object", + "properties": { + "method": { + "type": "string" + }, + "params": true + }, + "required": [ + "method" + ] + }, + "CustomRequest": { + "description": "A catch-all request either side can use to send custom messages to its peer.\n\nThis preserves the raw `method` name and `params` payload so handlers can\ndeserialize them into domain-specific types.", + "type": "object", + "properties": { + "method": { + "type": "string" + }, + "params": true + }, + "required": [ + "method" + ] + }, + "CustomResult": { + "description": "A catch-all response either side can use for custom requests." + }, + "DiscoverResult": { + "description": "The server's response to a [`DiscoverRequest`].", + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level response metadata.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "cacheScope": { + "description": "Whether the cached result may be shared across authorization contexts.", + "allOf": [ + { + "$ref": "#/definitions/CacheScope" + } + ] + }, + "capabilities": { + "description": "Capabilities provided by this server.", + "allOf": [ + { + "$ref": "#/definitions/ServerCapabilities" + } + ] + }, + "instructions": { + "description": "Optional guidance for using the server.", + "type": [ + "string", + "null" + ] + }, + "resultType": { + "description": "Identifies how the result should be parsed.", + "allOf": [ + { + "$ref": "#/definitions/ResultType" + } + ] + }, + "supportedVersions": { + "description": "Protocol versions implemented by this server.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtocolVersion" + } + }, + "ttlMs": { + "description": "How long clients may consider this response fresh, in milliseconds.", + "type": "integer", + "format": "uint64", + "minimum": 0 + } + }, + "required": [ + "resultType", + "supportedVersions", + "capabilities", + "ttlMs", + "cacheScope" + ] + }, + "ElicitRequestParams": { + "description": "Parameters for creating an elicitation request to gather user input.\n\nThis structure contains everything needed to request interactive input from a user:\n- A human-readable message explaining what information is needed\n- A type-safe schema defining the expected structure of the response\n\n# Example\n1. Form-based elicitation request\n```rust\nuse rmcp::model::*;\n\nlet params = ElicitRequestParams::FormElicitationParams {\n meta: None,\n message: \"Please provide your email\".to_string(),\n requested_schema: ElicitationSchema::builder()\n .required_email(\"email\")\n .build()\n .unwrap(),\n};\n```\n2. URL-based elicitation request\n```rust\nuse rmcp::model::*;\nlet params = ElicitRequestParams::UrlElicitationParams {\n meta: None,\n message: \"Please provide your feedback at the following URL\".to_string(),\n url: \"https://example.com/feedback\".to_string(),\n elicitation_id: \"unique-id-123\".to_string(),\n};\n```", + "anyOf": [ + { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "message": { + "type": "string" + }, + "mode": { + "type": "string", + "const": "form" + }, + "requestedSchema": { + "$ref": "#/definitions/ElicitationSchema" + } + }, + "required": [ + "mode", + "message", + "requestedSchema" + ] + }, + { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "elicitationId": { + "type": "string" + }, + "message": { + "type": "string" + }, + "mode": { + "type": "string", + "const": "url" + }, + "url": { + "type": "string" + } + }, + "required": [ + "mode", + "message", + "url", + "elicitationId" + ] + }, + { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "message": { + "type": "string" + }, + "requestedSchema": { + "$ref": "#/definitions/ElicitationSchema" + } + }, + "required": [ + "message", + "requestedSchema" + ] + } + ] + }, + "ElicitResult": { + "description": "The result returned by a client in response to an elicitation request.\n\nContains the user's decision (accept/decline/cancel) and optionally their input data\nif they chose to accept the request.", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this result.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "action": { + "description": "The user's decision on how to handle the elicitation request", + "allOf": [ + { + "$ref": "#/definitions/ElicitationAction" + } + ] + }, + "content": { + "description": "The actual data provided by the user, if they accepted the request.\nMust conform to the JSON schema specified in the original request.\nOnly present when action is Accept." + } + }, + "required": [ + "action" + ] + }, + "ElicitationAction": { + "description": "Represents the possible actions a user can take in response to an elicitation request.\n\nWhen a server requests user input through elicitation, the user can:\n- Accept: Provide the requested information and continue\n- Decline: Refuse to provide the information but continue the operation\n- Cancel: Stop the entire operation", + "oneOf": [ + { + "description": "User accepts the request and provides the requested information", + "type": "string", + "const": "accept" + }, + { + "description": "User declines to provide the information but allows the operation to continue", + "type": "string", + "const": "decline" + }, + { + "description": "User cancels the entire operation", + "type": "string", + "const": "cancel" + } + ] + }, + "ElicitationCapability": { + "description": "Elicitation allows servers to request interactive input from users during tool execution.\nThis capability indicates that a client can handle elicitation requests and present\nappropriate UI to users for collecting the requested information.", + "type": "object", + "properties": { + "form": { + "description": "Whether client supports form-based elicitation.", + "anyOf": [ + { + "$ref": "#/definitions/FormElicitationCapability" + }, + { + "type": "null" + } + ] + }, + "url": { + "description": "Whether client supports URL-based elicitation.", + "anyOf": [ + { + "$ref": "#/definitions/UrlElicitationCapability" + }, + { + "type": "null" + } + ] + } + } + }, + "ElicitationCreateRequestMethod": { + "type": "string", + "format": "const", + "const": "elicitation/create" + }, + "ElicitationSchema": { + "description": "Type-safe elicitation schema for requesting structured user input.\n\nThis enforces the MCP 2025-06-18 specification that elicitation schemas\nmust be objects with primitive-typed properties.\n\n# Example\n\n```rust\nuse rmcp::model::*;\n\nlet schema = ElicitationSchema::builder()\n .required_email(\"email\")\n .required_integer(\"age\", 0, 150)\n .optional_bool(\"newsletter\", false)\n .build();\n```", + "type": "object", + "properties": { + "$schema": { + "description": "Optional JSON Schema dialect identifier (the `$schema` keyword).\n\nThe 2025-11-25 protocol revision allows a `requestedSchema` to declare its\ndialect. It is preserved verbatim so a declared dialect survives a\ndecode/re-encode round-trip instead of being silently dropped.", + "type": "string" + }, + "description": { + "description": "Optional description of what this schema represents", + "type": [ + "string", + "null" + ] + }, + "properties": { + "description": "Property definitions (must be primitive types)", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/PrimitiveSchemaDefinition" + } + }, + "required": { + "description": "List of required property names", + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "title": { + "description": "Optional title for the schema", + "type": [ + "string", + "null" + ] + }, + "type": { + "description": "Always \"object\" for elicitation schemas", + "allOf": [ + { + "$ref": "#/definitions/ObjectTypeConst" + } + ] + } + }, + "required": [ + "type", + "properties" + ] + }, + "EmbeddedResource": { + "description": "Embedded resource content (spec `EmbeddedResource`).", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this content block.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional annotations describing how the client should use this content.", + "anyOf": [ + { + "$ref": "#/definitions/Annotations" + }, + { + "type": "null" + } + ] + }, + "resource": { + "description": "The embedded resource contents (text or blob).", + "allOf": [ + { + "$ref": "#/definitions/ResourceContents" + } + ] + } + }, + "required": [ + "resource" + ] + }, + "EmptyObject": { + "description": "This is commonly used for representing empty objects in MCP messages.\n\nwithout returning any specific data.", + "type": "object", + "additionalProperties": false + }, + "EnumSchema": { + "description": "Compliant with MCP 2025-06-18 specification for elicitation schemas.\nEnums must have string type for values and can optionally include human-readable names.\n\n# Example\n\n```rust\nuse rmcp::model::*;\n\nlet enum_schema = EnumSchema::builder(vec![\"US\".to_string(), \"UK\".to_string()])\n .multiselect()\n .min_items(1u64).expect(\"Min items should be correct value\")\n .max_items(4u64).expect(\"Max items should be correct value\")\n .description(\"Country code\")\n .build();\n```", + "anyOf": [ + { + "$ref": "#/definitions/SingleSelectEnumSchema" + }, + { + "$ref": "#/definitions/MultiSelectEnumSchema" + }, + { + "$ref": "#/definitions/LegacyEnumSchema" + } + ] + }, + "ErrorCode": { + "description": "Standard JSON-RPC error codes used throughout the MCP protocol.\n\nThese codes follow the JSON-RPC 2.0 specification and provide\nstandardized error reporting across all MCP implementations.", + "type": "integer", + "format": "int32" + }, + "ErrorData": { + "description": "Error information for JSON-RPC error responses.\n\nThis structure follows the JSON-RPC 2.0 specification for error reporting,\nproviding a standardized way to communicate errors between clients and servers.", + "type": "object", + "properties": { + "code": { + "description": "The error type that occurred (using standard JSON-RPC error codes)", + "allOf": [ + { + "$ref": "#/definitions/ErrorCode" + } + ] + }, + "data": { + "description": "Additional information about the error. The value of this member is defined by the\nsender (e.g. detailed error information, nested errors etc.)." + }, + "message": { + "description": "A short description of the error. The message SHOULD be limited to a concise single sentence.", + "type": "string" + } + }, + "required": [ + "code", + "message" + ] + }, + "FormElicitationCapability": { + "description": "Capability for handling elicitation requests from servers.\nElicitation allows servers to request interactive input from users during tool execution.\nThis capability indicates that a client can handle elicitation requests and present\nappropriate UI to users for collecting the requested information.\n\nCapability for form mode elicitation.", + "type": "object", + "properties": { + "schemaValidation": { + "description": "Whether the client supports JSON Schema validation for elicitation responses.\nWhen true, the client will validate user input against the requested_schema\nbefore sending the response back to the server.", + "type": [ + "boolean", + "null" + ] + } + } + }, + "GetPromptResult": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "messages": { + "type": "array", + "items": { + "$ref": "#/definitions/PromptMessage" + } + }, + "resultType": { + "description": "Result type discriminator (SEP-2322). Required by the [spec schema]\nfor servers implementing protocol version `2026-07-28`, but optional\nhere because this type also models results from older protocol\nversions, which do not carry the field: `None` means absent on the\nwire, and per the spec \"the client MUST treat the absent field as\n`\"complete\"`\". Constructors default to `Some(ResultType::COMPLETE)`;\nthe server handler clears the field when responding to peers that\nnegotiated an older version.\n\n[spec schema]: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/271ecc9accafdd9b83a3c869fa67c22953b2af80/schema/2026-07-28/schema.ts#L219-L235", + "anyOf": [ + { + "$ref": "#/definitions/ResultType" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "messages" + ] + }, + "GetTaskResult": { + "description": "Response to a `tasks/get` request (spec `GetTaskResult = Result & DetailedTask`).\n\n`resultType` is `\"complete\"` — this is the standard result shape for\n`tasks/get`, not a task handle.", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "createdAt": { + "description": "ISO 8601 timestamp when the task was created.", + "type": "string" + }, + "error": { + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "inputRequests": { + "type": [ + "object", + "null" + ], + "additionalProperties": { + "$ref": "#/definitions/InputRequest" + } + }, + "lastUpdatedAt": { + "description": "ISO 8601 timestamp when the task was last updated.", + "type": "string" + }, + "pollIntervalMs": { + "description": "Suggested polling interval in integer milliseconds. Clients SHOULD honor\nthis value to avoid overwhelming the server. This value MAY change over\nthe lifetime of a task.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "result": { + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "resultType": { + "description": "Result type discriminator. `tasks/get` responses are standard results:\n`\"complete\"` (SEP-2322). Absent values deserialize as `\"complete\"`.", + "allOf": [ + { + "$ref": "#/definitions/ResultType" + } + ], + "default": "complete" + }, + "status": { + "description": "Current task status.", + "allOf": [ + { + "$ref": "#/definitions/TaskStatus" + } + ] + }, + "statusMessage": { + "description": "Optional message describing the current task state.\nThis MAY be exposed to the end-user or model.", + "type": [ + "string", + "null" + ] + }, + "taskId": { + "description": "Stable identifier for this task, generated by the server.", + "type": "string" + }, + "ttlMs": { + "description": "Time-to-live duration from creation in integer milliseconds; `None`\n(serialized as `null`) means unlimited. The server may discard the task\nafter the TTL elapses. This value MAY change over the lifetime of a task.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + } + }, + "required": [ + "taskId", + "status", + "createdAt", + "lastUpdatedAt" + ] + }, + "Icon": { + "description": "A URL pointing to an icon resource or a base64-encoded data URI.\n\nClients that support rendering icons MUST support at least the following MIME types:\n- image/png - PNG images (safe, universal compatibility)\n- image/jpeg (and image/jpg) - JPEG images (safe, universal compatibility)\n\nClients that support rendering icons SHOULD also support:\n- image/svg+xml - SVG images (scalable but requires security precautions)\n- image/webp - WebP images (modern, efficient format)", + "type": "object", + "properties": { + "mimeType": { + "description": "Optional override if the server's MIME type is missing or generic", + "type": [ + "string", + "null" + ] + }, + "sizes": { + "description": "Size specification, each string should be in WxH format (e.g., `\\\"48x48\\\"`, `\\\"96x96\\\"`) or `\\\"any\\\"` for scalable formats like SVG", + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "src": { + "description": "A standard URI pointing to an icon resource", + "type": "string" + }, + "theme": { + "description": "Optional specifier for the theme this icon is designed for\nIf not provided, the client should assume the icon can be used with any theme.", + "anyOf": [ + { + "$ref": "#/definitions/IconTheme" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "src" + ] + }, + "IconTheme": { + "description": "Icon themes supported by the MCP specification", + "oneOf": [ + { + "description": "Indicates the icon is designed to be used with a light background", + "type": "string", + "const": "light" + }, + { + "description": "Indicates the icon is designed to be used with a dark background", + "type": "string", + "const": "dark" + } + ] + }, + "ImageContent": { + "description": "Image content with base64-encoded data (spec `ImageContent`).", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this content block.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional annotations describing how the client should use this content.", + "anyOf": [ + { + "$ref": "#/definitions/Annotations" + }, + { + "type": "null" + } + ] + }, + "data": { + "description": "The base64-encoded image data.", + "type": "string" + }, + "mimeType": { + "description": "The MIME type of the image (e.g. `image/png`).", + "type": "string" + } + }, + "required": [ + "data", + "mimeType" + ] + }, + "Implementation": { + "type": "object", + "properties": { + "description": { + "type": [ + "string", + "null" + ] + }, + "icons": { + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Icon" + } + }, + "name": { + "type": "string" + }, + "title": { + "type": [ + "string", + "null" + ] + }, + "version": { + "type": "string" + }, + "websiteUrl": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name", + "version" + ] + }, + "InitializeResult": { + "description": "The server's response to an initialization request.\n\nContains the server's protocol version, capabilities, and implementation\ninformation, along with optional instructions for the client.", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "capabilities": { + "description": "The capabilities this server provides (tools, resources, prompts, etc.)", + "allOf": [ + { + "$ref": "#/definitions/ServerCapabilities" + } + ] + }, + "instructions": { + "description": "Optional human-readable instructions about using this server", + "type": [ + "string", + "null" + ] + }, + "protocolVersion": { + "description": "The MCP protocol version this server supports", + "allOf": [ + { + "$ref": "#/definitions/ProtocolVersion" + } + ] + }, + "serverInfo": { + "description": "Information about the server implementation", + "allOf": [ + { + "$ref": "#/definitions/Implementation" + } + ] + } + }, + "required": [ + "protocolVersion", + "capabilities", + "serverInfo" + ] + }, + "InputRequest": { + "description": "A server-initiated request that can appear inside [`InputRequests`].\n\nPer the MCP spec, only `CreateMessageRequest` (sampling),\n`ElicitRequest` (elicitation), and `ListRootsRequest` (roots)\nare allowed. This is modeled as an untagged enum rather than a\n`ServerRequest` alias to prevent `PingRequest` or `CustomRequest` from\nbeing included.", + "anyOf": [ + { + "description": "A `sampling/createMessage` request.", + "allOf": [ + { + "$ref": "#/definitions/Request" + } + ] + }, + { + "description": "An `elicitation/create` request.", + "allOf": [ + { + "$ref": "#/definitions/Request2" + } + ] + }, + { + "description": "A `roots/list` request.", + "allOf": [ + { + "$ref": "#/definitions/RequestNoParam2" + } + ] + } + ] + }, + "InputRequiredResult": { + "description": "A result indicating that additional input is needed before the request\ncan be completed.\n\nAt least one of [`input_requests`](Self::input_requests) or\n[`request_state`](Self::request_state) MUST be present.\n\nServers MAY send this in response to `tools/call`, `prompts/get`, or\n`resources/read`. Servers MUST NOT send this for any other request.\n\n# Examples\n\n```\nuse rmcp::model::InputRequiredResult;\n\nlet result = InputRequiredResult::from_request_state(\"opaque-server-state\");\nassert!(result.input_requests.is_none());\nassert_eq!(result.request_state.as_deref(), Some(\"opaque-server-state\"));\n```", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "inputRequests": { + "description": "Server-initiated requests that the client must fulfill before retrying.", + "type": [ + "object", + "null" + ], + "additionalProperties": { + "$ref": "#/definitions/InputRequest" + } + }, + "requestState": { + "description": "Opaque request state to be echoed back by the client on retry.\nClients MUST NOT inspect, parse, modify, or make any assumptions\nabout the contents.", + "type": [ + "string", + "null" + ] + }, + "resultType": { + "description": "Always `\"input_required\"` for this result type.", + "allOf": [ + { + "$ref": "#/definitions/ResultType" + } + ] + } + }, + "required": [ + "resultType" + ] + }, + "IntegerSchema": { + "description": "Schema definition for integer properties.\n\nCompliant with MCP 2025-06-18 specification for elicitation schemas.\nSupports only the fields allowed by the MCP spec.", + "type": "object", + "properties": { + "default": { + "description": "Default value", + "type": [ + "integer", + "null" + ], + "format": "int64" + }, + "description": { + "description": "Human-readable description", + "type": [ + "string", + "null" + ] + }, + "maximum": { + "description": "Maximum value (inclusive)", + "type": [ + "integer", + "null" + ], + "format": "int64" + }, + "minimum": { + "description": "Minimum value (inclusive)", + "type": [ + "integer", + "null" + ], + "format": "int64" + }, + "title": { + "description": "Optional title for the schema", + "type": [ + "string", + "null" + ] + }, + "type": { + "description": "Type discriminator", + "allOf": [ + { + "$ref": "#/definitions/IntegerTypeConst" + } + ] + } + }, + "required": [ + "type" + ] + }, + "IntegerTypeConst": { + "type": "string", + "format": "const", + "const": "integer" + }, + "JsonRpcError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorData" + }, + "id": { + "anyOf": [ + { + "$ref": "#/definitions/NumberOrString" + }, + { + "type": "null" + } + ] + }, + "jsonrpc": { + "$ref": "#/definitions/JsonRpcVersion2_0" + } + }, + "required": [ + "jsonrpc", + "error" + ] + }, + "JsonRpcNotification": { + "type": "object", + "properties": { + "jsonrpc": { + "$ref": "#/definitions/JsonRpcVersion2_0" + } + }, + "anyOf": [ + { + "$ref": "#/definitions/Notification" + }, + { + "$ref": "#/definitions/Notification2" + }, + { + "$ref": "#/definitions/Notification3" + }, + { + "$ref": "#/definitions/Notification4" + }, + { + "$ref": "#/definitions/NotificationNoParam" + }, + { + "$ref": "#/definitions/NotificationNoParam2" + }, + { + "$ref": "#/definitions/NotificationNoParam3" + }, + { + "$ref": "#/definitions/Notification5" + }, + { + "$ref": "#/definitions/Notification6" + }, + { + "$ref": "#/definitions/CustomNotification" + } + ], + "required": [ + "jsonrpc" + ] + }, + "JsonRpcRequest": { + "type": "object", + "properties": { + "id": { + "$ref": "#/definitions/NumberOrString" + }, + "jsonrpc": { + "$ref": "#/definitions/JsonRpcVersion2_0" + } + }, + "anyOf": [ + { + "$ref": "#/definitions/RequestNoParam" + }, + { + "$ref": "#/definitions/Request" + }, + { + "$ref": "#/definitions/RequestNoParam2" + }, + { + "$ref": "#/definitions/Request2" + }, + { + "$ref": "#/definitions/CustomRequest" + } + ], + "required": [ + "jsonrpc", + "id" + ] + }, + "JsonRpcResponse": { + "type": "object", + "properties": { + "id": { + "$ref": "#/definitions/NumberOrString" + }, + "jsonrpc": { + "$ref": "#/definitions/JsonRpcVersion2_0" + }, + "result": { + "$ref": "#/definitions/ServerResult" + } + }, + "required": [ + "jsonrpc", + "id", + "result" + ] + }, + "JsonRpcVersion2_0": { + "type": "string", + "format": "const", + "const": "2.0" + }, + "LegacyEnumSchema": { + "description": "Legacy enum schema, keep for backward compatibility", + "type": "object", + "properties": { + "default": { + "type": [ + "string", + "null" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "enum": { + "type": "array", + "items": { + "type": "string" + } + }, + "enumNames": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "title": { + "type": [ + "string", + "null" + ] + }, + "type": { + "$ref": "#/definitions/StringTypeConst" + } + }, + "required": [ + "type", + "enum" + ] + }, + "ListPromptsResult": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "cacheScope": { + "description": "Scope describing who may cache this result (SEP-2549).\nRequired by spec version 2026-07-28, but optional here to maintain compatibility\nwith older spec versions.", + "anyOf": [ + { + "$ref": "#/definitions/CacheScope" + }, + { + "type": "null" + } + ] + }, + "nextCursor": { + "type": [ + "string", + "null" + ] + }, + "prompts": { + "type": "array", + "items": { + "$ref": "#/definitions/Prompt" + } + }, + "resultType": { + "description": "Result type discriminator (SEP-2322). Required by the [spec schema]\nfor servers implementing protocol version `2026-07-28`, but optional\nhere because this type also models results from older protocol\nversions, which do not carry the field: `None` means absent on the\nwire, and per the spec \"the client MUST treat the absent field as\n`\"complete\"`\". Constructors default to `Some(ResultType::COMPLETE)`;\nthe server handler clears the field when responding to peers that\nnegotiated an older version.\n\n[spec schema]: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/271ecc9accafdd9b83a3c869fa67c22953b2af80/schema/2026-07-28/schema.ts#L219-L235", + "anyOf": [ + { + "$ref": "#/definitions/ResultType" + }, + { + "type": "null" + } + ] + }, + "ttlMs": { + "description": "Time, in milliseconds, that this result may be treated as fresh (SEP-2549).\nRequired by spec version 2026-07-28, but optional here to maintain compatibility\nwith older spec versions.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + } + }, + "required": [ + "prompts" + ] + }, + "ListResourceTemplatesResult": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "cacheScope": { + "description": "Scope describing who may cache this result (SEP-2549).\nRequired by spec version 2026-07-28, but optional here to maintain compatibility\nwith older spec versions.", + "anyOf": [ + { + "$ref": "#/definitions/CacheScope" + }, + { + "type": "null" + } + ] + }, + "nextCursor": { + "type": [ + "string", + "null" + ] + }, + "resourceTemplates": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceTemplate" + } + }, + "resultType": { + "description": "Result type discriminator (SEP-2322). Required by the [spec schema]\nfor servers implementing protocol version `2026-07-28`, but optional\nhere because this type also models results from older protocol\nversions, which do not carry the field: `None` means absent on the\nwire, and per the spec \"the client MUST treat the absent field as\n`\"complete\"`\". Constructors default to `Some(ResultType::COMPLETE)`;\nthe server handler clears the field when responding to peers that\nnegotiated an older version.\n\n[spec schema]: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/271ecc9accafdd9b83a3c869fa67c22953b2af80/schema/2026-07-28/schema.ts#L219-L235", + "anyOf": [ + { + "$ref": "#/definitions/ResultType" + }, + { + "type": "null" + } + ] + }, + "ttlMs": { + "description": "Time, in milliseconds, that this result may be treated as fresh (SEP-2549).\nRequired by spec version 2026-07-28, but optional here to maintain compatibility\nwith older spec versions.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + } + }, + "required": [ + "resourceTemplates" + ] + }, + "ListResourcesResult": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "cacheScope": { + "description": "Scope describing who may cache this result (SEP-2549).\nRequired by spec version 2026-07-28, but optional here to maintain compatibility\nwith older spec versions.", + "anyOf": [ + { + "$ref": "#/definitions/CacheScope" + }, + { + "type": "null" + } + ] + }, + "nextCursor": { + "type": [ + "string", + "null" + ] + }, + "resources": { + "type": "array", + "items": { + "$ref": "#/definitions/Resource" + } + }, + "resultType": { + "description": "Result type discriminator (SEP-2322). Required by the [spec schema]\nfor servers implementing protocol version `2026-07-28`, but optional\nhere because this type also models results from older protocol\nversions, which do not carry the field: `None` means absent on the\nwire, and per the spec \"the client MUST treat the absent field as\n`\"complete\"`\". Constructors default to `Some(ResultType::COMPLETE)`;\nthe server handler clears the field when responding to peers that\nnegotiated an older version.\n\n[spec schema]: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/271ecc9accafdd9b83a3c869fa67c22953b2af80/schema/2026-07-28/schema.ts#L219-L235", + "anyOf": [ + { + "$ref": "#/definitions/ResultType" + }, + { + "type": "null" + } + ] + }, + "ttlMs": { + "description": "Time, in milliseconds, that this result may be treated as fresh (SEP-2549).\nRequired by spec version 2026-07-28, but optional here to maintain compatibility\nwith older spec versions.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + } + }, + "required": [ + "resources" + ] + }, + "ListRootsRequestMethod": { + "type": "string", + "format": "const", + "const": "roots/list" + }, + "ListToolsResult": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "cacheScope": { + "description": "Scope describing who may cache this result (SEP-2549).\nRequired by spec version 2026-07-28, but optional here to maintain compatibility\nwith older spec versions.", + "anyOf": [ + { + "$ref": "#/definitions/CacheScope" + }, + { + "type": "null" + } + ] + }, + "nextCursor": { + "type": [ + "string", + "null" + ] + }, + "resultType": { + "description": "Result type discriminator (SEP-2322). Required by the [spec schema]\nfor servers implementing protocol version `2026-07-28`, but optional\nhere because this type also models results from older protocol\nversions, which do not carry the field: `None` means absent on the\nwire, and per the spec \"the client MUST treat the absent field as\n`\"complete\"`\". Constructors default to `Some(ResultType::COMPLETE)`;\nthe server handler clears the field when responding to peers that\nnegotiated an older version.\n\n[spec schema]: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/271ecc9accafdd9b83a3c869fa67c22953b2af80/schema/2026-07-28/schema.ts#L219-L235", + "anyOf": [ + { + "$ref": "#/definitions/ResultType" + }, + { + "type": "null" + } + ] + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/definitions/Tool" + } + }, + "ttlMs": { + "description": "Time, in milliseconds, that this result may be treated as fresh (SEP-2549).\nRequired by spec version 2026-07-28, but optional here to maintain compatibility\nwith older spec versions.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + } + }, + "required": [ + "tools" + ] + }, + "LoggingLevel": { + "description": "Logging levels supported by the MCP protocol", + "type": "string", + "deprecated": true, + "enum": [ + "debug", + "info", + "notice", + "warning", + "error", + "critical", + "alert", + "emergency" + ] + }, + "LoggingMessageNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/message" + }, + "LoggingMessageNotificationParam": { + "description": "Parameters for a logging message notification", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/NotificationMetaObject" + }, + { + "type": "null" + } + ] + }, + "data": { + "description": "The actual log data" + }, + "level": { + "description": "The severity level of this log message", + "allOf": [ + { + "$ref": "#/definitions/LoggingLevel" + } + ] + }, + "logger": { + "description": "Optional logger name that generated this message", + "type": [ + "string", + "null" + ] + } + }, + "deprecated": true, + "required": [ + "level", + "data" + ] + }, + "MetaObject": { + "description": "See [MCP general fields](https://modelcontextprotocol.io/specification/2026-07-28/basic#general-fields) for notes on _meta usage.", + "type": "object", + "additionalProperties": true + }, + "ModelHint": { + "description": "A hint suggesting a preferred model name or family.\n\nModel hints are advisory suggestions that help clients choose appropriate\nmodels. They can be specific model names or general families like \"claude\" or \"gpt\".", + "type": "object", + "properties": { + "name": { + "description": "The suggested model name or family identifier", + "type": [ + "string", + "null" + ] + } + }, + "deprecated": true + }, + "ModelPreferences": { + "description": "Preferences for model selection and behavior in sampling requests.\n\nThis allows servers to express their preferences for which model to use\nand how to balance different priorities when the client has multiple\nmodel options available.", + "type": "object", + "properties": { + "costPriority": { + "description": "Priority for cost optimization (0.0 to 1.0, higher = prefer cheaper models)", + "type": [ + "number", + "null" + ], + "format": "float" + }, + "hints": { + "description": "Specific model names or families to prefer (e.g., \"claude\", \"gpt\")", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/ModelHint" + } + }, + "intelligencePriority": { + "description": "Priority for intelligence/capability (0.0 to 1.0, higher = prefer more capable models)", + "type": [ + "number", + "null" + ], + "format": "float" + }, + "speedPriority": { + "description": "Priority for speed/latency (0.0 to 1.0, higher = prefer faster models)", + "type": [ + "number", + "null" + ], + "format": "float" + } + }, + "deprecated": true + }, + "MultiSelectEnumSchema": { + "description": "Multi-select enum options", + "anyOf": [ + { + "$ref": "#/definitions/UntitledMultiSelectEnumSchema" + }, + { + "$ref": "#/definitions/TitledMultiSelectEnumSchema" + } + ] + }, + "Notification": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/CancelledNotificationMethod" + }, + "params": { + "$ref": "#/definitions/CancelledNotificationParam" + } + }, + "required": [ + "method", + "params" + ] + }, + "Notification2": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ProgressNotificationMethod" + }, + "params": { + "$ref": "#/definitions/ProgressNotificationParam" + } + }, + "required": [ + "method", + "params" + ] + }, + "Notification3": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/LoggingMessageNotificationMethod" + }, + "params": { + "$ref": "#/definitions/LoggingMessageNotificationParam" + } + }, + "required": [ + "method", + "params" + ] + }, + "Notification4": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ResourceUpdatedNotificationMethod" + }, + "params": { + "$ref": "#/definitions/ResourceUpdatedNotificationParam" + } + }, + "required": [ + "method", + "params" + ] + }, + "Notification5": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/SubscriptionsAcknowledgedNotificationMethod" + }, + "params": { + "$ref": "#/definitions/SubscriptionsAcknowledgedNotificationParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Notification6": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/TaskStatusNotificationMethod" + }, + "params": { + "$ref": "#/definitions/TaskStatusNotificationParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "NotificationMetaObject": { + "description": "Metadata reserved by MCP on notifications. Extension keys are also allowed.", + "type": "object", + "properties": { + "io.modelcontextprotocol/subscriptionId": { + "$ref": "#/definitions/NumberOrString" + } + }, + "additionalProperties": true + }, + "NotificationNoParam": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ResourceListChangedNotificationMethod" + } + }, + "required": [ + "method" + ] + }, + "NotificationNoParam2": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ToolListChangedNotificationMethod" + } + }, + "required": [ + "method" + ] + }, + "NotificationNoParam3": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/PromptListChangedNotificationMethod" + } + }, + "required": [ + "method" + ] + }, + "NumberOrString": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "NumberSchema": { + "description": "Schema definition for number properties (floating-point).\n\nCompliant with MCP 2025-06-18 specification for elicitation schemas.\nSupports only the fields allowed by the MCP spec.", + "type": "object", + "properties": { + "default": { + "description": "Default value", + "type": [ + "number", + "null" + ], + "format": "double" + }, + "description": { + "description": "Human-readable description", + "type": [ + "string", + "null" + ] + }, + "maximum": { + "description": "Maximum value (inclusive)", + "type": [ + "number", + "null" + ], + "format": "double" + }, + "minimum": { + "description": "Minimum value (inclusive)", + "type": [ + "number", + "null" + ], + "format": "double" + }, + "title": { + "description": "Optional title for the schema", + "type": [ + "string", + "null" + ] + }, + "type": { + "description": "Type discriminator", + "allOf": [ + { + "$ref": "#/definitions/NumberTypeConst" + } + ] + } + }, + "required": [ + "type" + ] + }, + "NumberTypeConst": { + "type": "string", + "format": "const", + "const": "number" + }, + "ObjectTypeConst": { + "type": "string", + "format": "const", + "const": "object" + }, + "PingRequestMethod": { + "type": "string", + "format": "const", + "const": "ping" + }, + "PrimitiveSchemaDefinition": { + "description": "Primitive schema definition for elicitation properties.\n\nAccording to MCP 2025-06-18 specification, elicitation schemas must have\nproperties of primitive types only (string, number, integer, boolean, enum).\n\nNote: Put Enum as the first variant to avoid ambiguity during deserialization.\nThis is due to the fact that EnumSchema can contain StringSchema internally and serde\nuses first match wins strategy when deserializing untagged enums.", + "anyOf": [ + { + "description": "Enum property (explicit enum schema)", + "allOf": [ + { + "$ref": "#/definitions/EnumSchema" + } + ] + }, + { + "description": "String property (with optional enum constraint)", + "allOf": [ + { + "$ref": "#/definitions/StringSchema" + } + ] + }, + { + "description": "Number property (with optional enum constraint)", + "allOf": [ + { + "$ref": "#/definitions/NumberSchema" + } + ] + }, + { + "description": "Integer property (with optional enum constraint)", + "allOf": [ + { + "$ref": "#/definitions/IntegerSchema" + } + ] + }, + { + "description": "Boolean property", + "allOf": [ + { + "$ref": "#/definitions/BooleanSchema" + } + ] + } + ] + }, + "ProgressNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/progress" + }, + "ProgressNotificationParam": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/NotificationMetaObject" + }, + { + "type": "null" + } + ] + }, + "message": { + "description": "An optional message describing the current progress.", + "type": [ + "string", + "null" + ] + }, + "progress": { + "description": "The progress thus far. This should increase every time progress is made, even if the total is unknown.", + "type": "number", + "format": "double" + }, + "progressToken": { + "$ref": "#/definitions/ProgressToken" + }, + "total": { + "description": "Total number of items to process (or total progress required), if known", + "type": [ + "number", + "null" + ], + "format": "double" + } + }, + "required": [ + "progressToken", + "progress" + ] + }, + "ProgressToken": { + "description": "A token used to track the progress of long-running operations.\n\nProgress tokens allow clients and servers to associate progress notifications\nwith specific requests, enabling real-time updates on operation status.", + "allOf": [ + { + "$ref": "#/definitions/NumberOrString" + } + ] + }, + "Prompt": { + "description": "A prompt or prompt template that the server offers (spec `Prompt`).", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "arguments": { + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/PromptArgument" + } + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "icons": { + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Icon" + } + }, + "name": { + "type": "string" + }, + "title": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name" + ] + }, + "PromptArgument": { + "description": "Describes an argument that a prompt can accept (spec `PromptArgument`).", + "type": "object", + "properties": { + "description": { + "type": [ + "string", + "null" + ] + }, + "name": { + "type": "string" + }, + "required": { + "type": [ + "boolean", + "null" + ] + }, + "title": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name" + ] + }, + "PromptListChangedNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/prompts/list_changed" + }, + "PromptMessage": { + "description": "A message returned as part of a prompt (spec `PromptMessage`).\n\nUses the unified `ContentBlock` for its content (text | image | audio | resource_link | resource).", + "type": "object", + "properties": { + "content": { + "$ref": "#/definitions/ContentBlock" + }, + "role": { + "$ref": "#/definitions/Role" + } + }, + "required": [ + "role", + "content" + ] + }, + "PromptsCapability": { + "type": "object", + "properties": { + "listChanged": { + "type": [ + "boolean", + "null" + ] + } + } + }, + "ProtocolVersion": { + "description": "Represents the MCP protocol version used for communication.\n\nThis ensures compatibility between clients and servers by specifying\nwhich version of the Model Context Protocol is being used.", + "type": "string" + }, + "ReadResourceResult": { + "description": "Result containing the contents of a read resource", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "cacheScope": { + "description": "Scope describing who may cache this result (SEP-2549).\nRequired by spec version 2026-07-28, but optional here to maintain compatibility\nwith older spec versions.", + "anyOf": [ + { + "$ref": "#/definitions/CacheScope" + }, + { + "type": "null" + } + ] + }, + "contents": { + "description": "The actual content of the resource", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceContents" + } + }, + "resultType": { + "description": "Result type discriminator (SEP-2322). Required by the [spec schema]\nfor servers implementing protocol version `2026-07-28`, but optional\nhere because this type also models results from older protocol\nversions, which do not carry the field: `None` means absent on the\nwire, and per the spec \"the client MUST treat the absent field as\n`\"complete\"`\". Constructors default to `Some(ResultType::COMPLETE)`;\nthe server handler clears the field when responding to peers that\nnegotiated an older version.\n\n[spec schema]: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/271ecc9accafdd9b83a3c869fa67c22953b2af80/schema/2026-07-28/schema.ts#L219-L235", + "anyOf": [ + { + "$ref": "#/definitions/ResultType" + }, + { + "type": "null" + } + ] + }, + "ttlMs": { + "description": "Time, in milliseconds, that this result may be treated as fresh (SEP-2549).\nRequired by spec version 2026-07-28, but optional here to maintain compatibility\nwith older spec versions.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + } + }, + "required": [ + "contents" + ] + }, + "Request": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/CreateMessageRequestMethod" + }, + "params": { + "$ref": "#/definitions/CreateMessageRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request2": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ElicitationCreateRequestMethod" + }, + "params": { + "$ref": "#/definitions/ElicitRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "RequestMetaObject": { + "description": "Metadata reserved by MCP on requests. Extension keys are also allowed.", + "type": "object", + "properties": { + "io.modelcontextprotocol/clientCapabilities": { + "$ref": "#/definitions/ClientCapabilities" + }, + "io.modelcontextprotocol/clientInfo": { + "$ref": "#/definitions/Implementation" + }, + "io.modelcontextprotocol/logLevel": { + "$ref": "#/definitions/LoggingLevel" + }, + "io.modelcontextprotocol/protocolVersion": { + "type": "string" + }, + "progressToken": { + "$ref": "#/definitions/ProgressToken" + } + }, + "additionalProperties": true + }, + "RequestNoParam": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/PingRequestMethod" + } + }, + "required": [ + "method" + ] + }, + "RequestNoParam2": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ListRootsRequestMethod" + } + }, + "required": [ + "method" + ] + }, + "Resource": { + "description": "A known resource that the server is capable of reading (spec `Resource`).\n\nAlso used as the inner type of `ContentBlock::ResourceLink` (spec `ResourceLink extends Resource`).", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this resource.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional annotations describing how the client should use this resource.", + "anyOf": [ + { + "$ref": "#/definitions/Annotations" + }, + { + "type": "null" + } + ] + }, + "description": { + "description": "Optional description of what this resource represents.", + "type": [ + "string", + "null" + ] + }, + "icons": { + "description": "Optional set of icons the client may display for this resource.", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Icon" + } + }, + "mimeType": { + "description": "The MIME type of this resource, if known.", + "type": [ + "string", + "null" + ] + }, + "name": { + "description": "The programmatic name of the resource.", + "type": "string" + }, + "size": { + "description": "The size of the raw resource content in bytes (before base64/tokenization), if known.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "title": { + "description": "Optional human-readable display title.", + "type": [ + "string", + "null" + ] + }, + "uri": { + "description": "The URI of this resource (e.g. `file:///path/to/file`).", + "type": "string" + } + }, + "required": [ + "uri", + "name" + ] + }, + "ResourceContents": { + "description": "The contents of a specific resource or sub-resource.", + "anyOf": [ + { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "mimeType": { + "type": [ + "string", + "null" + ] + }, + "text": { + "type": "string" + }, + "uri": { + "type": "string" + } + }, + "required": [ + "uri", + "text" + ] + }, + { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "blob": { + "type": "string" + }, + "mimeType": { + "type": [ + "string", + "null" + ] + }, + "uri": { + "type": "string" + } + }, + "required": [ + "uri", + "blob" + ] + } + ] + }, + "ResourceListChangedNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/resources/list_changed" + }, + "ResourceTemplate": { + "description": "A template description for resources available on the server (spec `ResourceTemplate`).", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this resource template.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional annotations describing how the client should use this template.", + "anyOf": [ + { + "$ref": "#/definitions/Annotations" + }, + { + "type": "null" + } + ] + }, + "description": { + "description": "Optional description of what this template is for.", + "type": [ + "string", + "null" + ] + }, + "icons": { + "description": "Optional set of icons the client may display for this template.", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Icon" + } + }, + "mimeType": { + "description": "The MIME type for resources matching this template, if uniform.", + "type": [ + "string", + "null" + ] + }, + "name": { + "description": "The programmatic name of the resource template.", + "type": "string" + }, + "title": { + "description": "Optional human-readable display title.", + "type": [ + "string", + "null" + ] + }, + "uriTemplate": { + "description": "An RFC 6570 URI template for constructing resource URIs.", + "type": "string" + } + }, + "required": [ + "uriTemplate", + "name" + ] + }, + "ResourceUpdatedNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/resources/updated" + }, + "ResourceUpdatedNotificationParam": { + "description": "Parameters for a resource update notification", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/NotificationMetaObject" + }, + { + "type": "null" + } + ] + }, + "uri": { + "description": "The URI of the resource that was updated", + "type": "string" + } + }, + "required": [ + "uri" + ] + }, + "ResourcesCapability": { + "type": "object", + "properties": { + "listChanged": { + "type": [ + "boolean", + "null" + ] + }, + "subscribe": { + "type": [ + "boolean", + "null" + ] + } + } + }, + "ResultType": { + "description": "Indicates the type of a result object, allowing the client to\ndetermine how to parse the response.\n\nThe spec defines this as an open string (`\"complete\" | \"input_required\" | string`),\nso unknown values are preserved rather than rejected. Servers implementing this\nprotocol version MUST include `resultType` in every result. For backward\ncompatibility, clients MUST treat an absent field as `\"complete\"`.\n\nOrdinary results model the field as `Option`: `None` means the\nfield is absent on the wire. Constructors default to `Some(COMPLETE)`, and\nthe server handler strips the `\"complete\"` discriminator before responding\nto peers that negotiated a protocol version older than `2026-07-28`, so\nlegacy sessions keep their historical wire shape (see\n[`ServerResult::strip_result_type_for_legacy_peer`]).", + "type": "string" + }, + "Role": { + "description": "Represents the role of a participant in a conversation or message exchange.\n\nUsed in sampling and chat contexts to distinguish between different\ntypes of message senders in the conversation flow.", + "oneOf": [ + { + "description": "A human user or client making a request", + "type": "string", + "const": "user" + }, + { + "description": "An AI assistant or server providing a response", + "type": "string", + "const": "assistant" + } + ] + }, + "RootsCapabilities": { + "description": "Roots capability. Deprecated by SEP-2577; remains functional and will be\nremoved in a future release.\nSee .", + "type": "object", + "properties": { + "listChanged": { + "type": [ + "boolean", + "null" + ] + } + } + }, + "SamplingCapability": { + "description": "Sampling capability with optional sub-capabilities (SEP-1577).\n\nDeprecated by SEP-2577; remains functional and will be removed in a future\nrelease.\nSee .", + "type": "object", + "properties": { + "context": { + "description": "Support for `includeContext` (soft-deprecated)", + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "tools": { + "description": "Support for `tools` and `toolChoice` parameters", + "type": [ + "object", + "null" + ], + "additionalProperties": true + } + } + }, + "SamplingContent": { + "description": "Single or array content wrapper (SEP-1577).", + "anyOf": [ + { + "$ref": "#/definitions/SamplingMessageContentBlock" + }, + { + "type": "array", + "items": { + "$ref": "#/definitions/SamplingMessageContentBlock" + } + } + ] + }, + "SamplingMessage": { + "description": "A message in a sampling conversation, containing a role and content.\n\nThis represents a single message in a conversation flow, used primarily\nin LLM sampling requests where the conversation history is important\nfor generating appropriate responses.", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "content": { + "description": "The actual content of the message (text, image, audio, tool use, or tool result)", + "allOf": [ + { + "$ref": "#/definitions/SamplingContent" + } + ] + }, + "role": { + "description": "The role of the message sender (User or Assistant)", + "allOf": [ + { + "$ref": "#/definitions/Role" + } + ] + } + }, + "deprecated": true, + "required": [ + "role", + "content" + ] + }, + "SamplingMessageContentBlock": { + "description": "Content types for sampling messages (SEP-1577).", + "deprecated": true, + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "text" + } + }, + "allOf": [ + { + "$ref": "#/definitions/TextContent" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "image" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ImageContent" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "audio" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AudioContent" + } + ], + "required": [ + "type" + ] + }, + { + "description": "Assistant only", + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "tool_use" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ToolUseContent" + } + ], + "required": [ + "type" + ] + }, + { + "description": "User only", + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "tool_result" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ToolResultContent" + } + ], + "required": [ + "type" + ] + } + ] + }, + "ServerCapabilities": { + "title": "Builder", + "description": "```rust\n# use rmcp::model::ServerCapabilities;\nlet cap = ServerCapabilities::builder()\n .enable_experimental()\n .enable_prompts()\n .enable_resources()\n .enable_tools()\n .enable_tool_list_changed()\n .build();\n```", + "type": "object", + "properties": { + "completions": { + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "experimental": { + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "object", + "additionalProperties": true + } + }, + "extensions": { + "description": "Optional MCP extensions that the server supports (SEP-1724).\nKeys are extension identifiers (e.g., `\"io.modelcontextprotocol/apps\"`),\nvalues are per-extension settings objects. An empty object indicates\nsupport with no settings.", + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "object", + "additionalProperties": true + } + }, + "logging": { + "description": "Capability for server log message notifications (deprecated by SEP-2577).", + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "prompts": { + "anyOf": [ + { + "$ref": "#/definitions/PromptsCapability" + }, + { + "type": "null" + } + ] + }, + "resources": { + "anyOf": [ + { + "$ref": "#/definitions/ResourcesCapability" + }, + { + "type": "null" + } + ] + }, + "tools": { + "anyOf": [ + { + "$ref": "#/definitions/ToolsCapability" + }, + { + "type": "null" + } + ] + } + } + }, + "ServerResult": { + "anyOf": [ + { + "$ref": "#/definitions/DiscoverResult" + }, + { + "$ref": "#/definitions/InitializeResult" + }, + { + "$ref": "#/definitions/CompleteResult" + }, + { + "$ref": "#/definitions/GetPromptResult" + }, + { + "$ref": "#/definitions/ListPromptsResult" + }, + { + "$ref": "#/definitions/ListResourcesResult" + }, + { + "$ref": "#/definitions/ListResourceTemplatesResult" + }, + { + "$ref": "#/definitions/ReadResourceResult" + }, + { + "$ref": "#/definitions/SubscriptionsListenResult" + }, + { + "$ref": "#/definitions/ListToolsResult" + }, + { + "$ref": "#/definitions/ElicitResult" + }, + { + "$ref": "#/definitions/CreateTaskResult" + }, + { + "$ref": "#/definitions/GetTaskResult" + }, + { + "$ref": "#/definitions/CallToolResult" + }, + { + "$ref": "#/definitions/InputRequiredResult" + }, + { + "$ref": "#/definitions/TaskAckResult" + }, + { + "$ref": "#/definitions/EmptyObject" + }, + { + "$ref": "#/definitions/CustomResult" + } + ] + }, + "SingleSelectEnumSchema": { + "description": "Combined single-select", + "anyOf": [ + { + "$ref": "#/definitions/UntitledSingleSelectEnumSchema" + }, + { + "$ref": "#/definitions/TitledSingleSelectEnumSchema" + } + ] + }, + "StringFormat": { + "description": "String format types allowed by the MCP specification.", + "oneOf": [ + { + "description": "Email address format", + "type": "string", + "const": "email" + }, + { + "description": "URI format", + "type": "string", + "const": "uri" + }, + { + "description": "Date format (YYYY-MM-DD)", + "type": "string", + "const": "date" + }, + { + "description": "Date-time format (ISO 8601)", + "type": "string", + "const": "date-time" + } + ] + }, + "StringSchema": { + "description": "Schema definition for string properties.\n\nCompliant with MCP 2025-06-18 specification for elicitation schemas.\nSupports only the fields allowed by the MCP spec:\n- format limited to: \"email\", \"uri\", \"date\", \"date-time\"", + "type": "object", + "properties": { + "default": { + "description": "Default value", + "type": [ + "string", + "null" + ] + }, + "description": { + "description": "Human-readable description", + "type": [ + "string", + "null" + ] + }, + "format": { + "description": "String format - limited to: \"email\", \"uri\", \"date\", \"date-time\"", + "anyOf": [ + { + "$ref": "#/definitions/StringFormat" + }, + { + "type": "null" + } + ] + }, + "maxLength": { + "description": "Maximum string length", + "type": [ + "integer", + "null" + ], + "format": "uint32", + "minimum": 0 + }, + "minLength": { + "description": "Minimum string length", + "type": [ + "integer", + "null" + ], + "format": "uint32", + "minimum": 0 + }, + "title": { + "description": "Optional title for the schema", + "type": [ + "string", + "null" + ] + }, + "type": { + "description": "Type discriminator", + "allOf": [ + { + "$ref": "#/definitions/StringTypeConst" + } + ] + } + }, + "required": [ + "type" + ] + }, + "StringTypeConst": { + "type": "string", + "format": "const", + "const": "string" + }, + "SubscriptionFilter": { + "description": "Notification categories a client opts in to on a `subscriptions/listen` stream.", + "type": "object", + "properties": { + "promptsListChanged": { + "type": "boolean" + }, + "resourceSubscriptions": { + "type": "array", + "items": { + "type": "string" + } + }, + "resourcesListChanged": { + "type": "boolean" + }, + "toolsListChanged": { + "type": "boolean" + } + } + }, + "SubscriptionsAcknowledgedNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/subscriptions/acknowledged" + }, + "SubscriptionsAcknowledgedNotificationParams": { + "description": "Parameters reporting the accepted subset of a subscription filter.", + "type": "object", + "properties": { + "_meta": { + "$ref": "#/definitions/NotificationMetaObject" + }, + "notifications": { + "$ref": "#/definitions/SubscriptionFilter" + } + }, + "required": [ + "notifications" + ] + }, + "SubscriptionsListenResult": { + "description": "Final response indicating that a subscription ended gracefully.", + "type": "object", + "properties": { + "_meta": { + "$ref": "#/definitions/SubscriptionsListenResultMeta" + }, + "resultType": { + "$ref": "#/definitions/ResultType" + } + }, + "required": [ + "resultType", + "_meta" + ] + }, + "SubscriptionsListenResultMeta": { + "type": "object", + "properties": { + "io.modelcontextprotocol/serverInfo": { + "description": "Identifies the server software producing the response. Servers SHOULD include this field on every response unless specifically configured not to do so.", + "allOf": [ + { + "$ref": "#/definitions/Implementation" + } + ] + }, + "io.modelcontextprotocol/subscriptionId": { + "$ref": "#/definitions/NumberOrString" + } + }, + "additionalProperties": true, + "required": [ + "io.modelcontextprotocol/subscriptionId" + ] + }, + "TaskAckResult": { + "description": "Empty acknowledgement for `tasks/update` and `tasks/cancel` (SEP-2663).\n\nThe spec requires these acks to be empty results carrying the SEP-2322\n`resultType: \"complete\"` discriminator; task state changes are observed\nvia the next `tasks/get`.", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "resultType": { + "description": "Always `\"complete\"`.", + "allOf": [ + { + "$ref": "#/definitions/ResultType" + } + ] + } + }, + "required": [ + "resultType" + ] + }, + "TaskStatus": { + "description": "Canonical task lifecycle status (SEP-2663).", + "oneOf": [ + { + "description": "The request is currently being processed.", + "type": "string", + "const": "working" + }, + { + "description": "The server needs input from the client before the task can proceed.", + "type": "string", + "const": "input_required" + }, + { + "description": "The request completed successfully and the result is available.\nThis includes tool calls that returned results with `isError: true`.", + "type": "string", + "const": "completed" + }, + { + "description": "The request failed due to a JSON-RPC error during execution.", + "type": "string", + "const": "failed" + }, + { + "description": "The request was cancelled before completion.", + "type": "string", + "const": "cancelled" + } + ] + }, + "TaskStatusNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/tasks" + }, + "TaskStatusNotificationParams": { + "description": "Parameters for a task status notification (spec `TaskStatusNotificationParams`).\n\nCarries a complete [`DetailedTask`] for the current status, identical to\nwhat `tasks/get` would have returned at that moment. The task fields are\nflattened at the top level: `NotificationParams & Task`.", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/NotificationMetaObject" + }, + { + "type": "null" + } + ] + }, + "createdAt": { + "description": "ISO 8601 timestamp when the task was created.", + "type": "string" + }, + "error": { + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "inputRequests": { + "type": [ + "object", + "null" + ], + "additionalProperties": { + "$ref": "#/definitions/InputRequest" + } + }, + "lastUpdatedAt": { + "description": "ISO 8601 timestamp when the task was last updated.", + "type": "string" + }, + "pollIntervalMs": { + "description": "Suggested polling interval in integer milliseconds. Clients SHOULD honor\nthis value to avoid overwhelming the server. This value MAY change over\nthe lifetime of a task.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "result": { + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "status": { + "description": "Current task status.", + "allOf": [ + { + "$ref": "#/definitions/TaskStatus" + } + ] + }, + "statusMessage": { + "description": "Optional message describing the current task state.\nThis MAY be exposed to the end-user or model.", + "type": [ + "string", + "null" + ] + }, + "taskId": { + "description": "Stable identifier for this task, generated by the server.", + "type": "string" + }, + "ttlMs": { + "description": "Time-to-live duration from creation in integer milliseconds; `None`\n(serialized as `null`) means unlimited. The server may discard the task\nafter the TTL elapses. This value MAY change over the lifetime of a task.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + } + }, + "required": [ + "taskId", + "status", + "createdAt", + "lastUpdatedAt" + ] + }, + "TextContent": { + "description": "Text content block (spec `TextContent`).", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this content block.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional annotations describing how the client should use this content.", + "anyOf": [ + { + "$ref": "#/definitions/Annotations" + }, + { + "type": "null" + } + ] + }, + "text": { + "description": "The text content of the message.", + "type": "string" + } + }, + "required": [ + "text" + ] + }, + "TitledItems": { + "description": "Items for titled multi-select options", + "type": "object", + "properties": { + "anyOf": { + "type": "array", + "items": { + "$ref": "#/definitions/ConstTitle" + } + } + }, + "required": [ + "anyOf" + ] + }, + "TitledMultiSelectEnumSchema": { + "description": "Multi-select titled options", + "type": "object", + "properties": { + "default": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "items": { + "$ref": "#/definitions/TitledItems" + }, + "maxItems": { + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "minItems": { + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "title": { + "type": [ + "string", + "null" + ] + }, + "type": { + "$ref": "#/definitions/ArrayTypeConst" + } + }, + "required": [ + "type", + "items" + ] + }, + "TitledSingleSelectEnumSchema": { + "description": "Titled single-select", + "type": "object", + "properties": { + "default": { + "type": [ + "string", + "null" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "oneOf": { + "type": "array", + "items": { + "$ref": "#/definitions/ConstTitle" + } + }, + "title": { + "type": [ + "string", + "null" + ] + }, + "type": { + "$ref": "#/definitions/StringTypeConst" + } + }, + "required": [ + "type", + "oneOf" + ] + }, + "Tool": { + "description": "A tool that can be used by a model.", + "type": "object", + "properties": { + "_meta": { + "description": "Optional additional metadata for this tool", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional additional tool information.", + "anyOf": [ + { + "$ref": "#/definitions/ToolAnnotations" + }, + { + "type": "null" + } + ] + }, + "description": { + "description": "A description of what the tool does", + "type": [ + "string", + "null" + ] + }, + "icons": { + "description": "Optional list of icons for the tool", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Icon" + } + }, + "inputSchema": { + "description": "A JSON Schema object defining the expected parameters for the tool", + "type": "object", + "additionalProperties": true + }, + "name": { + "description": "The name of the tool", + "type": "string" + }, + "outputSchema": { + "description": "An optional JSON Schema object defining the structure of the tool's output", + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "title": { + "description": "A human-readable title for the tool", + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name", + "inputSchema" + ] + }, + "ToolAnnotations": { + "description": "Additional properties describing a Tool to clients.\n\nNOTE: all properties in ToolAnnotations are **hints**.\nThey are not guaranteed to provide a faithful description of\ntool behavior (including descriptive properties like `title`).\n\nClients should never make tool use decisions based on ToolAnnotations\nreceived from untrusted servers.", + "type": "object", + "properties": { + "destructiveHint": { + "description": "If true, the tool may perform destructive updates to its environment.\nIf false, the tool performs only additive updates.\n\n(This property is meaningful only when `readOnlyHint == false`)\n\nDefault: true\nA human-readable description of the tool's purpose.", + "type": [ + "boolean", + "null" + ] + }, + "idempotentHint": { + "description": "If true, calling the tool repeatedly with the same arguments\nwill have no additional effect on the its environment.\n\n(This property is meaningful only when `readOnlyHint == false`)\n\nDefault: false.", + "type": [ + "boolean", + "null" + ] + }, + "openWorldHint": { + "description": "If true, this tool may interact with an \"open world\" of external\nentities. If false, the tool's domain of interaction is closed.\nFor example, the world of a web search tool is open, whereas that\nof a memory tool is not.\n\nDefault: true", + "type": [ + "boolean", + "null" + ] + }, + "readOnlyHint": { + "description": "If true, the tool does not modify its environment.\n\nDefault: false", + "type": [ + "boolean", + "null" + ] + }, + "title": { + "description": "A human-readable title for the tool.", + "type": [ + "string", + "null" + ] + } + } + }, + "ToolChoice": { + "description": "Tool choice configuration (SEP-1577).", + "type": "object", + "properties": { + "mode": { + "anyOf": [ + { + "$ref": "#/definitions/ToolChoiceMode" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": true + }, + "ToolChoiceMode": { + "description": "Tool selection mode (SEP-1577).", + "oneOf": [ + { + "description": "Model decides whether to use tools", + "type": "string", + "const": "auto" + }, + { + "description": "Model must use at least one tool", + "type": "string", + "const": "required" + }, + { + "description": "Model must not use tools", + "type": "string", + "const": "none" + } + ] + }, + "ToolListChangedNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/tools/list_changed" + }, + "ToolResultContent": { + "description": "Tool execution result in user message (SEP-1577).", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "content": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentBlock" + } + }, + "isError": { + "type": [ + "boolean", + "null" + ] + }, + "structuredContent": true, + "toolUseId": { + "type": "string" + } + }, + "deprecated": true, + "required": [ + "toolUseId", + "content" + ] + }, + "ToolUseContent": { + "description": "Tool call request from assistant (SEP-1577).", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "id": { + "type": "string" + }, + "input": { + "type": "object", + "additionalProperties": true + }, + "name": { + "type": "string" + } + }, + "deprecated": true, + "required": [ + "id", + "name", + "input" + ] + }, + "ToolsCapability": { + "type": "object", + "properties": { + "listChanged": { + "type": [ + "boolean", + "null" + ] + } + } + }, + "UntitledItems": { + "description": "Items for untitled multi-select options", + "type": "object", + "properties": { + "enum": { + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "$ref": "#/definitions/StringTypeConst" + } + }, + "required": [ + "type", + "enum" + ] + }, + "UntitledMultiSelectEnumSchema": { + "description": "Multi-select untitled options", + "type": "object", + "properties": { + "default": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "items": { + "$ref": "#/definitions/UntitledItems" + }, + "maxItems": { + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "minItems": { + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "title": { + "type": [ + "string", + "null" + ] + }, + "type": { + "$ref": "#/definitions/ArrayTypeConst" + } + }, + "required": [ + "type", + "items" + ] + }, + "UntitledSingleSelectEnumSchema": { + "description": "Untitled single-select", + "type": "object", + "properties": { + "default": { + "type": [ + "string", + "null" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "enum": { + "type": "array", + "items": { + "type": "string" + } + }, + "title": { + "type": [ + "string", + "null" + ] + }, + "type": { + "$ref": "#/definitions/StringTypeConst" + } + }, + "additionalProperties": false, + "required": [ + "type", + "enum" + ] + }, + "UrlElicitationCapability": { + "description": "Capability for URL mode elicitation.", + "type": "object" + } + } +} \ No newline at end of file diff --git a/vendor/rmcp/tests/test_message_schema/server_json_rpc_message_schema_current.json b/vendor/rmcp/tests/test_message_schema/server_json_rpc_message_schema_current.json new file mode 100644 index 00000000..ca0ef561 --- /dev/null +++ b/vendor/rmcp/tests/test_message_schema/server_json_rpc_message_schema_current.json @@ -0,0 +1,4113 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "title": "JsonRpcMessage", + "description": "Represents any JSON-RPC message that can be sent or received.\n\nThis enum covers all possible message types in the JSON-RPC protocol:\nindividual requests/responses, notifications, and errors.\nIt serves as the top-level message container for MCP communication.", + "anyOf": [ + { + "description": "A single request expecting a response", + "allOf": [ + { + "$ref": "#/definitions/JsonRpcRequest" + } + ] + }, + { + "description": "A response to a previous request", + "allOf": [ + { + "$ref": "#/definitions/JsonRpcResponse" + } + ] + }, + { + "description": "A one-way notification (no response expected)", + "allOf": [ + { + "$ref": "#/definitions/JsonRpcNotification" + } + ] + }, + { + "description": "An error response", + "allOf": [ + { + "$ref": "#/definitions/JsonRpcError" + } + ] + } + ], + "definitions": { + "Annotations": { + "description": "Optional annotations for the client. The client can use annotations to inform how objects are\nused or displayed.", + "type": "object", + "properties": { + "audience": { + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Role" + } + }, + "lastModified": { + "type": [ + "string", + "null" + ] + }, + "priority": { + "type": [ + "number", + "null" + ], + "format": "float" + } + } + }, + "ArrayTypeConst": { + "type": "string", + "format": "const", + "const": "array" + }, + "AudioContent": { + "description": "Audio content with base64-encoded data (spec `AudioContent`).", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this content block.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional annotations describing how the client should use this content.", + "anyOf": [ + { + "$ref": "#/definitions/Annotations" + }, + { + "type": "null" + } + ] + }, + "data": { + "description": "The base64-encoded audio data.", + "type": "string" + }, + "mimeType": { + "description": "The MIME type of the audio (e.g. `audio/wav`).", + "type": "string" + } + }, + "required": [ + "data", + "mimeType" + ] + }, + "BooleanSchema": { + "description": "Schema definition for boolean properties.", + "type": "object", + "properties": { + "default": { + "description": "Default value", + "type": [ + "boolean", + "null" + ] + }, + "description": { + "description": "Human-readable description", + "type": [ + "string", + "null" + ] + }, + "title": { + "description": "Optional title for the schema", + "type": [ + "string", + "null" + ] + }, + "type": { + "description": "Type discriminator", + "allOf": [ + { + "$ref": "#/definitions/BooleanTypeConst" + } + ] + } + }, + "required": [ + "type" + ] + }, + "BooleanTypeConst": { + "type": "string", + "format": "const", + "const": "boolean" + }, + "CacheScope": { + "description": "Scope describing who may cache cacheable list/read results (SEP-2549).\n\nDefaults to [`CacheScope::Public`] when absent from the wire.", + "oneOf": [ + { + "description": "Any client or intermediary may cache and serve the response to any user.", + "type": "string", + "const": "public" + }, + { + "description": "Only the requesting user's client may cache the response.", + "type": "string", + "const": "private" + } + ] + }, + "CallToolResult": { + "description": "The result of a tool call operation.\n\nContains the content returned by the tool execution and an optional\nflag indicating whether the operation resulted in an error.", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this result", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "content": { + "description": "The content returned by the tool (text, images, etc.)", + "type": "array", + "default": [], + "items": { + "$ref": "#/definitions/ContentBlock" + } + }, + "isError": { + "description": "Whether this result represents an error condition", + "type": [ + "boolean", + "null" + ] + }, + "resultType": { + "description": "Result type discriminator (SEP-2322). Required by the [spec schema]\nfor servers implementing protocol version `2026-07-28`, but optional\nhere because this type also models results from older protocol\nversions, which do not carry the field: `None` means absent on the\nwire, and per the spec \"the client MUST treat the absent field as\n`\"complete\"`\". Constructors default to `Some(ResultType::COMPLETE)`;\nthe server handler clears the field when responding to peers that\nnegotiated an older version.\n\n[spec schema]: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/271ecc9accafdd9b83a3c869fa67c22953b2af80/schema/2026-07-28/schema.ts#L219-L235", + "anyOf": [ + { + "$ref": "#/definitions/ResultType" + }, + { + "type": "null" + } + ] + }, + "structuredContent": { + "description": "An optional JSON object that represents the structured result of the tool call" + } + } + }, + "CancelledNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/cancelled" + }, + "CancelledNotificationParam": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/NotificationMetaObject" + }, + { + "type": "null" + } + ] + }, + "reason": { + "type": [ + "string", + "null" + ] + }, + "requestId": { + "anyOf": [ + { + "$ref": "#/definitions/NumberOrString" + }, + { + "type": "null" + } + ] + } + } + }, + "ClientCapabilities": { + "title": "Builder", + "description": "```rust\n# use rmcp::model::ClientCapabilities;\nlet cap = ClientCapabilities::builder()\n .enable_experimental()\n .build();\n```", + "type": "object", + "properties": { + "elicitation": { + "description": "Capability to handle elicitation requests from servers for interactive user input", + "anyOf": [ + { + "$ref": "#/definitions/ElicitationCapability" + }, + { + "type": "null" + } + ] + }, + "experimental": { + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "object", + "additionalProperties": true + } + }, + "extensions": { + "description": "Optional MCP extensions that the client supports (SEP-1724).\nKeys are extension identifiers (e.g., `\"io.modelcontextprotocol/ui\"`),\nvalues are per-extension settings objects. An empty object indicates\nsupport with no settings.", + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "object", + "additionalProperties": true + } + }, + "roots": { + "description": "Capability for filesystem roots (deprecated by SEP-2577).", + "anyOf": [ + { + "$ref": "#/definitions/RootsCapabilities" + }, + { + "type": "null" + } + ] + }, + "sampling": { + "description": "Capability for LLM sampling requests (SEP-1577, deprecated by SEP-2577).", + "anyOf": [ + { + "$ref": "#/definitions/SamplingCapability" + }, + { + "type": "null" + } + ] + } + } + }, + "CompleteResult": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "completion": { + "$ref": "#/definitions/CompletionInfo" + }, + "resultType": { + "description": "Result type discriminator (SEP-2322). Required by the [spec schema]\nfor servers implementing protocol version `2026-07-28`, but optional\nhere because this type also models results from older protocol\nversions, which do not carry the field: `None` means absent on the\nwire, and per the spec \"the client MUST treat the absent field as\n`\"complete\"`\". Constructors default to `Some(ResultType::COMPLETE)`;\nthe server handler clears the field when responding to peers that\nnegotiated an older version.\n\n[spec schema]: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/271ecc9accafdd9b83a3c869fa67c22953b2af80/schema/2026-07-28/schema.ts#L219-L235", + "anyOf": [ + { + "$ref": "#/definitions/ResultType" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "completion" + ] + }, + "CompletionInfo": { + "type": "object", + "properties": { + "hasMore": { + "type": [ + "boolean", + "null" + ] + }, + "total": { + "type": [ + "integer", + "null" + ], + "format": "uint32", + "minimum": 0 + }, + "values": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "values" + ] + }, + "ConstTitle": { + "description": "Schema definition for enum properties.\n\nRepresent single entry for titled item", + "type": "object", + "properties": { + "const": { + "type": "string" + }, + "title": { + "type": "string" + } + }, + "required": [ + "const", + "title" + ] + }, + "ContentBlock": { + "description": "Unified content block union (spec `ContentBlock`).\n\n`text | image | audio | resource_link | resource`", + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "text" + } + }, + "allOf": [ + { + "$ref": "#/definitions/TextContent" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "image" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ImageContent" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "audio" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AudioContent" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "resource" + } + }, + "allOf": [ + { + "$ref": "#/definitions/EmbeddedResource" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "resource_link" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "type" + ] + } + ] + }, + "ContextInclusion": { + "description": "Specifies how much context should be included in sampling requests.\n\nThis allows clients to control what additional context information\nshould be provided to the LLM when processing sampling requests.", + "oneOf": [ + { + "description": "Include context from all connected MCP servers", + "type": "string", + "const": "allServers" + }, + { + "description": "Include no additional context", + "type": "string", + "const": "none" + }, + { + "description": "Include context only from the requesting server", + "type": "string", + "const": "thisServer" + } + ] + }, + "CreateMessageRequestMethod": { + "type": "string", + "format": "const", + "const": "sampling/createMessage" + }, + "CreateMessageRequestParams": { + "description": "Parameters for creating a message through LLM sampling.\n\nThis structure contains all the necessary information for a client to\ngenerate an LLM response, including conversation history, model preferences,\nand generation parameters.\n\nThis implements `TaskAugmentedRequestParamsMeta` as sampling requests can be\nlong-running and may benefit from task-based execution.", + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level metadata for this request (SEP-1319)", + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "includeContext": { + "description": "How much context to include from MCP servers", + "anyOf": [ + { + "$ref": "#/definitions/ContextInclusion" + }, + { + "type": "null" + } + ] + }, + "maxTokens": { + "description": "Maximum number of tokens to generate", + "type": "integer", + "format": "uint32", + "minimum": 0 + }, + "messages": { + "description": "The conversation history and current messages", + "type": "array", + "items": { + "$ref": "#/definitions/SamplingMessage" + } + }, + "metadata": { + "description": "Additional metadata for the request" + }, + "modelPreferences": { + "description": "Preferences for model selection and behavior", + "anyOf": [ + { + "$ref": "#/definitions/ModelPreferences" + }, + { + "type": "null" + } + ] + }, + "stopSequences": { + "description": "Sequences that should stop generation", + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "systemPrompt": { + "description": "System prompt to guide the model's behavior", + "type": [ + "string", + "null" + ] + }, + "temperature": { + "description": "Temperature for controlling randomness (0.0 to 1.0)", + "type": [ + "number", + "null" + ], + "format": "float" + }, + "toolChoice": { + "description": "Tool selection behavior (SEP-1577)", + "anyOf": [ + { + "$ref": "#/definitions/ToolChoice" + }, + { + "type": "null" + } + ] + }, + "tools": { + "description": "Tools available for the model to call (SEP-1577)", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Tool" + } + } + }, + "deprecated": true, + "required": [ + "messages", + "maxTokens" + ] + }, + "CreateTaskResult": { + "description": "Result returned in lieu of a standard result to indicate the request will\nbe processed asynchronously (spec `CreateTaskResult`, `resultType: \"task\"`).\n\nThe embedded task is the seed state for the task; the client uses\n`task.task_id` for all subsequent `tasks/get`, `tasks/update`, and\n`tasks/cancel` calls.", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "createdAt": { + "description": "ISO 8601 timestamp when the task was created.", + "type": "string" + }, + "lastUpdatedAt": { + "description": "ISO 8601 timestamp when the task was last updated.", + "type": "string" + }, + "pollIntervalMs": { + "description": "Suggested polling interval in integer milliseconds. Clients SHOULD honor\nthis value to avoid overwhelming the server. This value MAY change over\nthe lifetime of a task.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "resultType": { + "description": "Always `\"task\"`.", + "allOf": [ + { + "$ref": "#/definitions/ResultType" + } + ] + }, + "status": { + "description": "Current task status.", + "allOf": [ + { + "$ref": "#/definitions/TaskStatus" + } + ] + }, + "statusMessage": { + "description": "Optional message describing the current task state.\nThis MAY be exposed to the end-user or model.", + "type": [ + "string", + "null" + ] + }, + "taskId": { + "description": "Stable identifier for this task, generated by the server.", + "type": "string" + }, + "ttlMs": { + "description": "Time-to-live duration from creation in integer milliseconds; `None`\n(serialized as `null`) means unlimited. The server may discard the task\nafter the TTL elapses. This value MAY change over the lifetime of a task.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + } + }, + "required": [ + "resultType", + "taskId", + "status", + "createdAt", + "lastUpdatedAt" + ] + }, + "CustomNotification": { + "description": "A catch-all notification either side can use to send custom messages to its peer.\n\nThis preserves the raw `method` name and `params` payload so handlers can\ndeserialize them into domain-specific types.", + "type": "object", + "properties": { + "method": { + "type": "string" + }, + "params": true + }, + "required": [ + "method" + ] + }, + "CustomRequest": { + "description": "A catch-all request either side can use to send custom messages to its peer.\n\nThis preserves the raw `method` name and `params` payload so handlers can\ndeserialize them into domain-specific types.", + "type": "object", + "properties": { + "method": { + "type": "string" + }, + "params": true + }, + "required": [ + "method" + ] + }, + "CustomResult": { + "description": "A catch-all response either side can use for custom requests." + }, + "DiscoverResult": { + "description": "The server's response to a [`DiscoverRequest`].", + "type": "object", + "properties": { + "_meta": { + "description": "Protocol-level response metadata.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "cacheScope": { + "description": "Whether the cached result may be shared across authorization contexts.", + "allOf": [ + { + "$ref": "#/definitions/CacheScope" + } + ] + }, + "capabilities": { + "description": "Capabilities provided by this server.", + "allOf": [ + { + "$ref": "#/definitions/ServerCapabilities" + } + ] + }, + "instructions": { + "description": "Optional guidance for using the server.", + "type": [ + "string", + "null" + ] + }, + "resultType": { + "description": "Identifies how the result should be parsed.", + "allOf": [ + { + "$ref": "#/definitions/ResultType" + } + ] + }, + "supportedVersions": { + "description": "Protocol versions implemented by this server.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtocolVersion" + } + }, + "ttlMs": { + "description": "How long clients may consider this response fresh, in milliseconds.", + "type": "integer", + "format": "uint64", + "minimum": 0 + } + }, + "required": [ + "resultType", + "supportedVersions", + "capabilities", + "ttlMs", + "cacheScope" + ] + }, + "ElicitRequestParams": { + "description": "Parameters for creating an elicitation request to gather user input.\n\nThis structure contains everything needed to request interactive input from a user:\n- A human-readable message explaining what information is needed\n- A type-safe schema defining the expected structure of the response\n\n# Example\n1. Form-based elicitation request\n```rust\nuse rmcp::model::*;\n\nlet params = ElicitRequestParams::FormElicitationParams {\n meta: None,\n message: \"Please provide your email\".to_string(),\n requested_schema: ElicitationSchema::builder()\n .required_email(\"email\")\n .build()\n .unwrap(),\n};\n```\n2. URL-based elicitation request\n```rust\nuse rmcp::model::*;\nlet params = ElicitRequestParams::UrlElicitationParams {\n meta: None,\n message: \"Please provide your feedback at the following URL\".to_string(),\n url: \"https://example.com/feedback\".to_string(),\n elicitation_id: \"unique-id-123\".to_string(),\n};\n```", + "anyOf": [ + { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "message": { + "type": "string" + }, + "mode": { + "type": "string", + "const": "form" + }, + "requestedSchema": { + "$ref": "#/definitions/ElicitationSchema" + } + }, + "required": [ + "mode", + "message", + "requestedSchema" + ] + }, + { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "elicitationId": { + "type": "string" + }, + "message": { + "type": "string" + }, + "mode": { + "type": "string", + "const": "url" + }, + "url": { + "type": "string" + } + }, + "required": [ + "mode", + "message", + "url", + "elicitationId" + ] + }, + { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/RequestMetaObject" + }, + { + "type": "null" + } + ] + }, + "message": { + "type": "string" + }, + "requestedSchema": { + "$ref": "#/definitions/ElicitationSchema" + } + }, + "required": [ + "message", + "requestedSchema" + ] + } + ] + }, + "ElicitResult": { + "description": "The result returned by a client in response to an elicitation request.\n\nContains the user's decision (accept/decline/cancel) and optionally their input data\nif they chose to accept the request.", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this result.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "action": { + "description": "The user's decision on how to handle the elicitation request", + "allOf": [ + { + "$ref": "#/definitions/ElicitationAction" + } + ] + }, + "content": { + "description": "The actual data provided by the user, if they accepted the request.\nMust conform to the JSON schema specified in the original request.\nOnly present when action is Accept." + } + }, + "required": [ + "action" + ] + }, + "ElicitationAction": { + "description": "Represents the possible actions a user can take in response to an elicitation request.\n\nWhen a server requests user input through elicitation, the user can:\n- Accept: Provide the requested information and continue\n- Decline: Refuse to provide the information but continue the operation\n- Cancel: Stop the entire operation", + "oneOf": [ + { + "description": "User accepts the request and provides the requested information", + "type": "string", + "const": "accept" + }, + { + "description": "User declines to provide the information but allows the operation to continue", + "type": "string", + "const": "decline" + }, + { + "description": "User cancels the entire operation", + "type": "string", + "const": "cancel" + } + ] + }, + "ElicitationCapability": { + "description": "Elicitation allows servers to request interactive input from users during tool execution.\nThis capability indicates that a client can handle elicitation requests and present\nappropriate UI to users for collecting the requested information.", + "type": "object", + "properties": { + "form": { + "description": "Whether client supports form-based elicitation.", + "anyOf": [ + { + "$ref": "#/definitions/FormElicitationCapability" + }, + { + "type": "null" + } + ] + }, + "url": { + "description": "Whether client supports URL-based elicitation.", + "anyOf": [ + { + "$ref": "#/definitions/UrlElicitationCapability" + }, + { + "type": "null" + } + ] + } + } + }, + "ElicitationCreateRequestMethod": { + "type": "string", + "format": "const", + "const": "elicitation/create" + }, + "ElicitationSchema": { + "description": "Type-safe elicitation schema for requesting structured user input.\n\nThis enforces the MCP 2025-06-18 specification that elicitation schemas\nmust be objects with primitive-typed properties.\n\n# Example\n\n```rust\nuse rmcp::model::*;\n\nlet schema = ElicitationSchema::builder()\n .required_email(\"email\")\n .required_integer(\"age\", 0, 150)\n .optional_bool(\"newsletter\", false)\n .build();\n```", + "type": "object", + "properties": { + "description": { + "description": "Optional description of what this schema represents", + "type": [ + "string", + "null" + ] + }, + "properties": { + "description": "Property definitions (must be primitive types)", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/PrimitiveSchemaDefinition" + } + }, + "required": { + "description": "List of required property names", + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "title": { + "description": "Optional title for the schema", + "type": [ + "string", + "null" + ] + }, + "type": { + "description": "Always \"object\" for elicitation schemas", + "allOf": [ + { + "$ref": "#/definitions/ObjectTypeConst" + } + ] + } + }, + "required": [ + "type", + "properties" + ] + }, + "EmbeddedResource": { + "description": "Embedded resource content (spec `EmbeddedResource`).", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this content block.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional annotations describing how the client should use this content.", + "anyOf": [ + { + "$ref": "#/definitions/Annotations" + }, + { + "type": "null" + } + ] + }, + "resource": { + "description": "The embedded resource contents (text or blob).", + "allOf": [ + { + "$ref": "#/definitions/ResourceContents" + } + ] + } + }, + "required": [ + "resource" + ] + }, + "EmptyObject": { + "description": "This is commonly used for representing empty objects in MCP messages.\n\nwithout returning any specific data.", + "type": "object", + "additionalProperties": false + }, + "EnumSchema": { + "description": "Compliant with MCP 2025-06-18 specification for elicitation schemas.\nEnums must have string type for values and can optionally include human-readable names.\n\n# Example\n\n```rust\nuse rmcp::model::*;\n\nlet enum_schema = EnumSchema::builder(vec![\"US\".to_string(), \"UK\".to_string()])\n .multiselect()\n .min_items(1u64).expect(\"Min items should be correct value\")\n .max_items(4u64).expect(\"Max items should be correct value\")\n .description(\"Country code\")\n .build();\n```", + "anyOf": [ + { + "$ref": "#/definitions/SingleSelectEnumSchema" + }, + { + "$ref": "#/definitions/MultiSelectEnumSchema" + }, + { + "$ref": "#/definitions/LegacyEnumSchema" + } + ] + }, + "ErrorCode": { + "description": "Standard JSON-RPC error codes used throughout the MCP protocol.\n\nThese codes follow the JSON-RPC 2.0 specification and provide\nstandardized error reporting across all MCP implementations.", + "type": "integer", + "format": "int32" + }, + "ErrorData": { + "description": "Error information for JSON-RPC error responses.\n\nThis structure follows the JSON-RPC 2.0 specification for error reporting,\nproviding a standardized way to communicate errors between clients and servers.", + "type": "object", + "properties": { + "code": { + "description": "The error type that occurred (using standard JSON-RPC error codes)", + "allOf": [ + { + "$ref": "#/definitions/ErrorCode" + } + ] + }, + "data": { + "description": "Additional information about the error. The value of this member is defined by the\nsender (e.g. detailed error information, nested errors etc.)." + }, + "message": { + "description": "A short description of the error. The message SHOULD be limited to a concise single sentence.", + "type": "string" + } + }, + "required": [ + "code", + "message" + ] + }, + "FormElicitationCapability": { + "description": "Capability for handling elicitation requests from servers.\nElicitation allows servers to request interactive input from users during tool execution.\nThis capability indicates that a client can handle elicitation requests and present\nappropriate UI to users for collecting the requested information.\n\nCapability for form mode elicitation.", + "type": "object", + "properties": { + "schemaValidation": { + "description": "Whether the client supports JSON Schema validation for elicitation responses.\nWhen true, the client will validate user input against the requested_schema\nbefore sending the response back to the server.", + "type": [ + "boolean", + "null" + ] + } + } + }, + "GetPromptResult": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "messages": { + "type": "array", + "items": { + "$ref": "#/definitions/PromptMessage" + } + }, + "resultType": { + "description": "Result type discriminator (SEP-2322). Required by the [spec schema]\nfor servers implementing protocol version `2026-07-28`, but optional\nhere because this type also models results from older protocol\nversions, which do not carry the field: `None` means absent on the\nwire, and per the spec \"the client MUST treat the absent field as\n`\"complete\"`\". Constructors default to `Some(ResultType::COMPLETE)`;\nthe server handler clears the field when responding to peers that\nnegotiated an older version.\n\n[spec schema]: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/271ecc9accafdd9b83a3c869fa67c22953b2af80/schema/2026-07-28/schema.ts#L219-L235", + "anyOf": [ + { + "$ref": "#/definitions/ResultType" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "messages" + ] + }, + "GetTaskResult": { + "description": "Response to a `tasks/get` request (spec `GetTaskResult = Result & DetailedTask`).\n\n`resultType` is `\"complete\"` — this is the standard result shape for\n`tasks/get`, not a task handle.", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "createdAt": { + "description": "ISO 8601 timestamp when the task was created.", + "type": "string" + }, + "error": { + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "inputRequests": { + "type": [ + "object", + "null" + ], + "additionalProperties": { + "$ref": "#/definitions/InputRequest" + } + }, + "lastUpdatedAt": { + "description": "ISO 8601 timestamp when the task was last updated.", + "type": "string" + }, + "pollIntervalMs": { + "description": "Suggested polling interval in integer milliseconds. Clients SHOULD honor\nthis value to avoid overwhelming the server. This value MAY change over\nthe lifetime of a task.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "result": { + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "resultType": { + "description": "Result type discriminator. `tasks/get` responses are standard results:\n`\"complete\"` (SEP-2322). Absent values deserialize as `\"complete\"`.", + "allOf": [ + { + "$ref": "#/definitions/ResultType" + } + ], + "default": "complete" + }, + "status": { + "description": "Current task status.", + "allOf": [ + { + "$ref": "#/definitions/TaskStatus" + } + ] + }, + "statusMessage": { + "description": "Optional message describing the current task state.\nThis MAY be exposed to the end-user or model.", + "type": [ + "string", + "null" + ] + }, + "taskId": { + "description": "Stable identifier for this task, generated by the server.", + "type": "string" + }, + "ttlMs": { + "description": "Time-to-live duration from creation in integer milliseconds; `None`\n(serialized as `null`) means unlimited. The server may discard the task\nafter the TTL elapses. This value MAY change over the lifetime of a task.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + } + }, + "required": [ + "taskId", + "status", + "createdAt", + "lastUpdatedAt" + ] + }, + "Icon": { + "description": "A URL pointing to an icon resource or a base64-encoded data URI.\n\nClients that support rendering icons MUST support at least the following MIME types:\n- image/png - PNG images (safe, universal compatibility)\n- image/jpeg (and image/jpg) - JPEG images (safe, universal compatibility)\n\nClients that support rendering icons SHOULD also support:\n- image/svg+xml - SVG images (scalable but requires security precautions)\n- image/webp - WebP images (modern, efficient format)", + "type": "object", + "properties": { + "mimeType": { + "description": "Optional override if the server's MIME type is missing or generic", + "type": [ + "string", + "null" + ] + }, + "sizes": { + "description": "Size specification, each string should be in WxH format (e.g., `\\\"48x48\\\"`, `\\\"96x96\\\"`) or `\\\"any\\\"` for scalable formats like SVG", + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "src": { + "description": "A standard URI pointing to an icon resource", + "type": "string" + }, + "theme": { + "description": "Optional specifier for the theme this icon is designed for\nIf not provided, the client should assume the icon can be used with any theme.", + "anyOf": [ + { + "$ref": "#/definitions/IconTheme" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "src" + ] + }, + "IconTheme": { + "description": "Icon themes supported by the MCP specification", + "oneOf": [ + { + "description": "Indicates the icon is designed to be used with a light background", + "type": "string", + "const": "light" + }, + { + "description": "Indicates the icon is designed to be used with a dark background", + "type": "string", + "const": "dark" + } + ] + }, + "ImageContent": { + "description": "Image content with base64-encoded data (spec `ImageContent`).", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this content block.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional annotations describing how the client should use this content.", + "anyOf": [ + { + "$ref": "#/definitions/Annotations" + }, + { + "type": "null" + } + ] + }, + "data": { + "description": "The base64-encoded image data.", + "type": "string" + }, + "mimeType": { + "description": "The MIME type of the image (e.g. `image/png`).", + "type": "string" + } + }, + "required": [ + "data", + "mimeType" + ] + }, + "Implementation": { + "type": "object", + "properties": { + "description": { + "type": [ + "string", + "null" + ] + }, + "icons": { + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Icon" + } + }, + "name": { + "type": "string" + }, + "title": { + "type": [ + "string", + "null" + ] + }, + "version": { + "type": "string" + }, + "websiteUrl": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name", + "version" + ] + }, + "InitializeResult": { + "description": "The server's response to an initialization request.\n\nContains the server's protocol version, capabilities, and implementation\ninformation, along with optional instructions for the client.", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "capabilities": { + "description": "The capabilities this server provides (tools, resources, prompts, etc.)", + "allOf": [ + { + "$ref": "#/definitions/ServerCapabilities" + } + ] + }, + "instructions": { + "description": "Optional human-readable instructions about using this server", + "type": [ + "string", + "null" + ] + }, + "protocolVersion": { + "description": "The MCP protocol version this server supports", + "allOf": [ + { + "$ref": "#/definitions/ProtocolVersion" + } + ] + }, + "serverInfo": { + "description": "Information about the server implementation", + "allOf": [ + { + "$ref": "#/definitions/Implementation" + } + ] + } + }, + "required": [ + "protocolVersion", + "capabilities", + "serverInfo" + ] + }, + "InputRequest": { + "description": "A server-initiated request that can appear inside [`InputRequests`].\n\nPer the MCP spec, only `CreateMessageRequest` (sampling),\n`ElicitRequest` (elicitation), and `ListRootsRequest` (roots)\nare allowed. This is modeled as an untagged enum rather than a\n`ServerRequest` alias to prevent `PingRequest` or `CustomRequest` from\nbeing included.", + "anyOf": [ + { + "description": "A `sampling/createMessage` request.", + "allOf": [ + { + "$ref": "#/definitions/Request" + } + ] + }, + { + "description": "An `elicitation/create` request.", + "allOf": [ + { + "$ref": "#/definitions/Request2" + } + ] + }, + { + "description": "A `roots/list` request.", + "allOf": [ + { + "$ref": "#/definitions/RequestNoParam2" + } + ] + } + ] + }, + "InputRequiredResult": { + "description": "A result indicating that additional input is needed before the request\ncan be completed.\n\nAt least one of [`input_requests`](Self::input_requests) or\n[`request_state`](Self::request_state) MUST be present.\n\nServers MAY send this in response to `tools/call`, `prompts/get`, or\n`resources/read`. Servers MUST NOT send this for any other request.\n\n# Examples\n\n```\nuse rmcp::model::InputRequiredResult;\n\nlet result = InputRequiredResult::from_request_state(\"opaque-server-state\");\nassert!(result.input_requests.is_none());\nassert_eq!(result.request_state.as_deref(), Some(\"opaque-server-state\"));\n```", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "inputRequests": { + "description": "Server-initiated requests that the client must fulfill before retrying.", + "type": [ + "object", + "null" + ], + "additionalProperties": { + "$ref": "#/definitions/InputRequest" + } + }, + "requestState": { + "description": "Opaque request state to be echoed back by the client on retry.\nClients MUST NOT inspect, parse, modify, or make any assumptions\nabout the contents.", + "type": [ + "string", + "null" + ] + }, + "resultType": { + "description": "Always `\"input_required\"` for this result type.", + "allOf": [ + { + "$ref": "#/definitions/ResultType" + } + ] + } + }, + "required": [ + "resultType" + ] + }, + "IntegerSchema": { + "description": "Schema definition for integer properties.\n\nCompliant with MCP 2025-06-18 specification for elicitation schemas.\nSupports only the fields allowed by the MCP spec.", + "type": "object", + "properties": { + "default": { + "description": "Default value", + "type": [ + "integer", + "null" + ], + "format": "int64" + }, + "description": { + "description": "Human-readable description", + "type": [ + "string", + "null" + ] + }, + "maximum": { + "description": "Maximum value (inclusive)", + "type": [ + "integer", + "null" + ], + "format": "int64" + }, + "minimum": { + "description": "Minimum value (inclusive)", + "type": [ + "integer", + "null" + ], + "format": "int64" + }, + "title": { + "description": "Optional title for the schema", + "type": [ + "string", + "null" + ] + }, + "type": { + "description": "Type discriminator", + "allOf": [ + { + "$ref": "#/definitions/IntegerTypeConst" + } + ] + } + }, + "required": [ + "type" + ] + }, + "IntegerTypeConst": { + "type": "string", + "format": "const", + "const": "integer" + }, + "JsonRpcError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorData" + }, + "id": { + "anyOf": [ + { + "$ref": "#/definitions/NumberOrString" + }, + { + "type": "null" + } + ] + }, + "jsonrpc": { + "$ref": "#/definitions/JsonRpcVersion2_0" + } + }, + "required": [ + "jsonrpc", + "error" + ] + }, + "JsonRpcNotification": { + "type": "object", + "properties": { + "jsonrpc": { + "$ref": "#/definitions/JsonRpcVersion2_0" + } + }, + "anyOf": [ + { + "$ref": "#/definitions/Notification" + }, + { + "$ref": "#/definitions/Notification2" + }, + { + "$ref": "#/definitions/Notification3" + }, + { + "$ref": "#/definitions/Notification4" + }, + { + "$ref": "#/definitions/NotificationNoParam" + }, + { + "$ref": "#/definitions/NotificationNoParam2" + }, + { + "$ref": "#/definitions/NotificationNoParam3" + }, + { + "$ref": "#/definitions/Notification5" + }, + { + "$ref": "#/definitions/Notification6" + }, + { + "$ref": "#/definitions/CustomNotification" + } + ], + "required": [ + "jsonrpc" + ] + }, + "JsonRpcRequest": { + "type": "object", + "properties": { + "id": { + "$ref": "#/definitions/NumberOrString" + }, + "jsonrpc": { + "$ref": "#/definitions/JsonRpcVersion2_0" + } + }, + "anyOf": [ + { + "$ref": "#/definitions/RequestNoParam" + }, + { + "$ref": "#/definitions/Request" + }, + { + "$ref": "#/definitions/RequestNoParam2" + }, + { + "$ref": "#/definitions/Request2" + }, + { + "$ref": "#/definitions/CustomRequest" + } + ], + "required": [ + "jsonrpc", + "id" + ] + }, + "JsonRpcResponse": { + "type": "object", + "properties": { + "id": { + "$ref": "#/definitions/NumberOrString" + }, + "jsonrpc": { + "$ref": "#/definitions/JsonRpcVersion2_0" + }, + "result": { + "$ref": "#/definitions/ServerResult" + } + }, + "required": [ + "jsonrpc", + "id", + "result" + ] + }, + "JsonRpcVersion2_0": { + "type": "string", + "format": "const", + "const": "2.0" + }, + "LegacyEnumSchema": { + "description": "Legacy enum schema, keep for backward compatibility", + "type": "object", + "properties": { + "default": { + "type": [ + "string", + "null" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "enum": { + "type": "array", + "items": { + "type": "string" + } + }, + "enumNames": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "title": { + "type": [ + "string", + "null" + ] + }, + "type": { + "$ref": "#/definitions/StringTypeConst" + } + }, + "required": [ + "type", + "enum" + ] + }, + "ListPromptsResult": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "cacheScope": { + "description": "Scope describing who may cache this result (SEP-2549).\nRequired by spec version 2026-07-28, but optional here to maintain compatibility\nwith older spec versions.", + "anyOf": [ + { + "$ref": "#/definitions/CacheScope" + }, + { + "type": "null" + } + ] + }, + "nextCursor": { + "type": [ + "string", + "null" + ] + }, + "prompts": { + "type": "array", + "items": { + "$ref": "#/definitions/Prompt" + } + }, + "resultType": { + "description": "Result type discriminator (SEP-2322). Required by the [spec schema]\nfor servers implementing protocol version `2026-07-28`, but optional\nhere because this type also models results from older protocol\nversions, which do not carry the field: `None` means absent on the\nwire, and per the spec \"the client MUST treat the absent field as\n`\"complete\"`\". Constructors default to `Some(ResultType::COMPLETE)`;\nthe server handler clears the field when responding to peers that\nnegotiated an older version.\n\n[spec schema]: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/271ecc9accafdd9b83a3c869fa67c22953b2af80/schema/2026-07-28/schema.ts#L219-L235", + "anyOf": [ + { + "$ref": "#/definitions/ResultType" + }, + { + "type": "null" + } + ] + }, + "ttlMs": { + "description": "Time, in milliseconds, that this result may be treated as fresh (SEP-2549).\nRequired by spec version 2026-07-28, but optional here to maintain compatibility\nwith older spec versions.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + } + }, + "required": [ + "prompts" + ] + }, + "ListResourceTemplatesResult": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "cacheScope": { + "description": "Scope describing who may cache this result (SEP-2549).\nRequired by spec version 2026-07-28, but optional here to maintain compatibility\nwith older spec versions.", + "anyOf": [ + { + "$ref": "#/definitions/CacheScope" + }, + { + "type": "null" + } + ] + }, + "nextCursor": { + "type": [ + "string", + "null" + ] + }, + "resourceTemplates": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceTemplate" + } + }, + "resultType": { + "description": "Result type discriminator (SEP-2322). Required by the [spec schema]\nfor servers implementing protocol version `2026-07-28`, but optional\nhere because this type also models results from older protocol\nversions, which do not carry the field: `None` means absent on the\nwire, and per the spec \"the client MUST treat the absent field as\n`\"complete\"`\". Constructors default to `Some(ResultType::COMPLETE)`;\nthe server handler clears the field when responding to peers that\nnegotiated an older version.\n\n[spec schema]: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/271ecc9accafdd9b83a3c869fa67c22953b2af80/schema/2026-07-28/schema.ts#L219-L235", + "anyOf": [ + { + "$ref": "#/definitions/ResultType" + }, + { + "type": "null" + } + ] + }, + "ttlMs": { + "description": "Time, in milliseconds, that this result may be treated as fresh (SEP-2549).\nRequired by spec version 2026-07-28, but optional here to maintain compatibility\nwith older spec versions.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + } + }, + "required": [ + "resourceTemplates" + ] + }, + "ListResourcesResult": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "cacheScope": { + "description": "Scope describing who may cache this result (SEP-2549).\nRequired by spec version 2026-07-28, but optional here to maintain compatibility\nwith older spec versions.", + "anyOf": [ + { + "$ref": "#/definitions/CacheScope" + }, + { + "type": "null" + } + ] + }, + "nextCursor": { + "type": [ + "string", + "null" + ] + }, + "resources": { + "type": "array", + "items": { + "$ref": "#/definitions/Resource" + } + }, + "resultType": { + "description": "Result type discriminator (SEP-2322). Required by the [spec schema]\nfor servers implementing protocol version `2026-07-28`, but optional\nhere because this type also models results from older protocol\nversions, which do not carry the field: `None` means absent on the\nwire, and per the spec \"the client MUST treat the absent field as\n`\"complete\"`\". Constructors default to `Some(ResultType::COMPLETE)`;\nthe server handler clears the field when responding to peers that\nnegotiated an older version.\n\n[spec schema]: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/271ecc9accafdd9b83a3c869fa67c22953b2af80/schema/2026-07-28/schema.ts#L219-L235", + "anyOf": [ + { + "$ref": "#/definitions/ResultType" + }, + { + "type": "null" + } + ] + }, + "ttlMs": { + "description": "Time, in milliseconds, that this result may be treated as fresh (SEP-2549).\nRequired by spec version 2026-07-28, but optional here to maintain compatibility\nwith older spec versions.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + } + }, + "required": [ + "resources" + ] + }, + "ListRootsRequestMethod": { + "type": "string", + "format": "const", + "const": "roots/list" + }, + "ListToolsResult": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "cacheScope": { + "description": "Scope describing who may cache this result (SEP-2549).\nRequired by spec version 2026-07-28, but optional here to maintain compatibility\nwith older spec versions.", + "anyOf": [ + { + "$ref": "#/definitions/CacheScope" + }, + { + "type": "null" + } + ] + }, + "nextCursor": { + "type": [ + "string", + "null" + ] + }, + "resultType": { + "description": "Result type discriminator (SEP-2322). Required by the [spec schema]\nfor servers implementing protocol version `2026-07-28`, but optional\nhere because this type also models results from older protocol\nversions, which do not carry the field: `None` means absent on the\nwire, and per the spec \"the client MUST treat the absent field as\n`\"complete\"`\". Constructors default to `Some(ResultType::COMPLETE)`;\nthe server handler clears the field when responding to peers that\nnegotiated an older version.\n\n[spec schema]: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/271ecc9accafdd9b83a3c869fa67c22953b2af80/schema/2026-07-28/schema.ts#L219-L235", + "anyOf": [ + { + "$ref": "#/definitions/ResultType" + }, + { + "type": "null" + } + ] + }, + "tools": { + "type": "array", + "items": { + "$ref": "#/definitions/Tool" + } + }, + "ttlMs": { + "description": "Time, in milliseconds, that this result may be treated as fresh (SEP-2549).\nRequired by spec version 2026-07-28, but optional here to maintain compatibility\nwith older spec versions.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + } + }, + "required": [ + "tools" + ] + }, + "LoggingLevel": { + "description": "Logging levels supported by the MCP protocol", + "type": "string", + "deprecated": true, + "enum": [ + "debug", + "info", + "notice", + "warning", + "error", + "critical", + "alert", + "emergency" + ] + }, + "LoggingMessageNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/message" + }, + "LoggingMessageNotificationParam": { + "description": "Parameters for a logging message notification", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/NotificationMetaObject" + }, + { + "type": "null" + } + ] + }, + "data": { + "description": "The actual log data" + }, + "level": { + "description": "The severity level of this log message", + "allOf": [ + { + "$ref": "#/definitions/LoggingLevel" + } + ] + }, + "logger": { + "description": "Optional logger name that generated this message", + "type": [ + "string", + "null" + ] + } + }, + "deprecated": true, + "required": [ + "level", + "data" + ] + }, + "MetaObject": { + "description": "See [MCP general fields](https://modelcontextprotocol.io/specification/2026-07-28/basic#general-fields) for notes on _meta usage.", + "type": "object", + "additionalProperties": true + }, + "ModelHint": { + "description": "A hint suggesting a preferred model name or family.\n\nModel hints are advisory suggestions that help clients choose appropriate\nmodels. They can be specific model names or general families like \"claude\" or \"gpt\".", + "type": "object", + "properties": { + "name": { + "description": "The suggested model name or family identifier", + "type": [ + "string", + "null" + ] + } + }, + "deprecated": true + }, + "ModelPreferences": { + "description": "Preferences for model selection and behavior in sampling requests.\n\nThis allows servers to express their preferences for which model to use\nand how to balance different priorities when the client has multiple\nmodel options available.", + "type": "object", + "properties": { + "costPriority": { + "description": "Priority for cost optimization (0.0 to 1.0, higher = prefer cheaper models)", + "type": [ + "number", + "null" + ], + "format": "float" + }, + "hints": { + "description": "Specific model names or families to prefer (e.g., \"claude\", \"gpt\")", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/ModelHint" + } + }, + "intelligencePriority": { + "description": "Priority for intelligence/capability (0.0 to 1.0, higher = prefer more capable models)", + "type": [ + "number", + "null" + ], + "format": "float" + }, + "speedPriority": { + "description": "Priority for speed/latency (0.0 to 1.0, higher = prefer faster models)", + "type": [ + "number", + "null" + ], + "format": "float" + } + }, + "deprecated": true + }, + "MultiSelectEnumSchema": { + "description": "Multi-select enum options", + "anyOf": [ + { + "$ref": "#/definitions/UntitledMultiSelectEnumSchema" + }, + { + "$ref": "#/definitions/TitledMultiSelectEnumSchema" + } + ] + }, + "Notification": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/CancelledNotificationMethod" + }, + "params": { + "$ref": "#/definitions/CancelledNotificationParam" + } + }, + "required": [ + "method", + "params" + ] + }, + "Notification2": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ProgressNotificationMethod" + }, + "params": { + "$ref": "#/definitions/ProgressNotificationParam" + } + }, + "required": [ + "method", + "params" + ] + }, + "Notification3": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/LoggingMessageNotificationMethod" + }, + "params": { + "$ref": "#/definitions/LoggingMessageNotificationParam" + } + }, + "required": [ + "method", + "params" + ] + }, + "Notification4": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ResourceUpdatedNotificationMethod" + }, + "params": { + "$ref": "#/definitions/ResourceUpdatedNotificationParam" + } + }, + "required": [ + "method", + "params" + ] + }, + "Notification5": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/SubscriptionsAcknowledgedNotificationMethod" + }, + "params": { + "$ref": "#/definitions/SubscriptionsAcknowledgedNotificationParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Notification6": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/TaskStatusNotificationMethod" + }, + "params": { + "$ref": "#/definitions/TaskStatusNotificationParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "NotificationMetaObject": { + "description": "Metadata reserved by MCP on notifications. Extension keys are also allowed.", + "type": "object", + "properties": { + "io.modelcontextprotocol/subscriptionId": { + "$ref": "#/definitions/NumberOrString" + } + }, + "additionalProperties": true + }, + "NotificationNoParam": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ResourceListChangedNotificationMethod" + } + }, + "required": [ + "method" + ] + }, + "NotificationNoParam2": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ToolListChangedNotificationMethod" + } + }, + "required": [ + "method" + ] + }, + "NotificationNoParam3": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/PromptListChangedNotificationMethod" + } + }, + "required": [ + "method" + ] + }, + "NumberOrString": { + "oneOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "NumberSchema": { + "description": "Schema definition for number properties (floating-point).\n\nCompliant with MCP 2025-06-18 specification for elicitation schemas.\nSupports only the fields allowed by the MCP spec.", + "type": "object", + "properties": { + "default": { + "description": "Default value", + "type": [ + "number", + "null" + ], + "format": "double" + }, + "description": { + "description": "Human-readable description", + "type": [ + "string", + "null" + ] + }, + "maximum": { + "description": "Maximum value (inclusive)", + "type": [ + "number", + "null" + ], + "format": "double" + }, + "minimum": { + "description": "Minimum value (inclusive)", + "type": [ + "number", + "null" + ], + "format": "double" + }, + "title": { + "description": "Optional title for the schema", + "type": [ + "string", + "null" + ] + }, + "type": { + "description": "Type discriminator", + "allOf": [ + { + "$ref": "#/definitions/NumberTypeConst" + } + ] + } + }, + "required": [ + "type" + ] + }, + "NumberTypeConst": { + "type": "string", + "format": "const", + "const": "number" + }, + "ObjectTypeConst": { + "type": "string", + "format": "const", + "const": "object" + }, + "PingRequestMethod": { + "type": "string", + "format": "const", + "const": "ping" + }, + "PrimitiveSchemaDefinition": { + "description": "Primitive schema definition for elicitation properties.\n\nAccording to MCP 2025-06-18 specification, elicitation schemas must have\nproperties of primitive types only (string, number, integer, boolean, enum).\n\nNote: Put Enum as the first variant to avoid ambiguity during deserialization.\nThis is due to the fact that EnumSchema can contain StringSchema internally and serde\nuses first match wins strategy when deserializing untagged enums.", + "anyOf": [ + { + "description": "Enum property (explicit enum schema)", + "allOf": [ + { + "$ref": "#/definitions/EnumSchema" + } + ] + }, + { + "description": "String property (with optional enum constraint)", + "allOf": [ + { + "$ref": "#/definitions/StringSchema" + } + ] + }, + { + "description": "Number property (with optional enum constraint)", + "allOf": [ + { + "$ref": "#/definitions/NumberSchema" + } + ] + }, + { + "description": "Integer property (with optional enum constraint)", + "allOf": [ + { + "$ref": "#/definitions/IntegerSchema" + } + ] + }, + { + "description": "Boolean property", + "allOf": [ + { + "$ref": "#/definitions/BooleanSchema" + } + ] + } + ] + }, + "ProgressNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/progress" + }, + "ProgressNotificationParam": { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/NotificationMetaObject" + }, + { + "type": "null" + } + ] + }, + "message": { + "description": "An optional message describing the current progress.", + "type": [ + "string", + "null" + ] + }, + "progress": { + "description": "The progress thus far. This should increase every time progress is made, even if the total is unknown.", + "type": "number", + "format": "double" + }, + "progressToken": { + "$ref": "#/definitions/ProgressToken" + }, + "total": { + "description": "Total number of items to process (or total progress required), if known", + "type": [ + "number", + "null" + ], + "format": "double" + } + }, + "required": [ + "progressToken", + "progress" + ] + }, + "ProgressToken": { + "description": "A token used to track the progress of long-running operations.\n\nProgress tokens allow clients and servers to associate progress notifications\nwith specific requests, enabling real-time updates on operation status.", + "allOf": [ + { + "$ref": "#/definitions/NumberOrString" + } + ] + }, + "Prompt": { + "description": "A prompt or prompt template that the server offers (spec `Prompt`).", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "arguments": { + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/PromptArgument" + } + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "icons": { + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Icon" + } + }, + "name": { + "type": "string" + }, + "title": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name" + ] + }, + "PromptArgument": { + "description": "Describes an argument that a prompt can accept (spec `PromptArgument`).", + "type": "object", + "properties": { + "description": { + "type": [ + "string", + "null" + ] + }, + "name": { + "type": "string" + }, + "required": { + "type": [ + "boolean", + "null" + ] + }, + "title": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name" + ] + }, + "PromptListChangedNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/prompts/list_changed" + }, + "PromptMessage": { + "description": "A message returned as part of a prompt (spec `PromptMessage`).\n\nUses the unified `ContentBlock` for its content (text | image | audio | resource_link | resource).", + "type": "object", + "properties": { + "content": { + "$ref": "#/definitions/ContentBlock" + }, + "role": { + "$ref": "#/definitions/Role" + } + }, + "required": [ + "role", + "content" + ] + }, + "PromptsCapability": { + "type": "object", + "properties": { + "listChanged": { + "type": [ + "boolean", + "null" + ] + } + } + }, + "ProtocolVersion": { + "description": "Represents the MCP protocol version used for communication.\n\nThis ensures compatibility between clients and servers by specifying\nwhich version of the Model Context Protocol is being used.", + "type": "string" + }, + "ReadResourceResult": { + "description": "Result containing the contents of a read resource", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "cacheScope": { + "description": "Scope describing who may cache this result (SEP-2549).\nRequired by spec version 2026-07-28, but optional here to maintain compatibility\nwith older spec versions.", + "anyOf": [ + { + "$ref": "#/definitions/CacheScope" + }, + { + "type": "null" + } + ] + }, + "contents": { + "description": "The actual content of the resource", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceContents" + } + }, + "resultType": { + "description": "Result type discriminator (SEP-2322). Required by the [spec schema]\nfor servers implementing protocol version `2026-07-28`, but optional\nhere because this type also models results from older protocol\nversions, which do not carry the field: `None` means absent on the\nwire, and per the spec \"the client MUST treat the absent field as\n`\"complete\"`\". Constructors default to `Some(ResultType::COMPLETE)`;\nthe server handler clears the field when responding to peers that\nnegotiated an older version.\n\n[spec schema]: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/271ecc9accafdd9b83a3c869fa67c22953b2af80/schema/2026-07-28/schema.ts#L219-L235", + "anyOf": [ + { + "$ref": "#/definitions/ResultType" + }, + { + "type": "null" + } + ] + }, + "ttlMs": { + "description": "Time, in milliseconds, that this result may be treated as fresh (SEP-2549).\nRequired by spec version 2026-07-28, but optional here to maintain compatibility\nwith older spec versions.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + } + }, + "required": [ + "contents" + ] + }, + "Request": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/CreateMessageRequestMethod" + }, + "params": { + "$ref": "#/definitions/CreateMessageRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "Request2": { + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ElicitationCreateRequestMethod" + }, + "params": { + "$ref": "#/definitions/ElicitRequestParams" + } + }, + "required": [ + "method", + "params" + ] + }, + "RequestMetaObject": { + "description": "Metadata reserved by MCP on requests. Extension keys are also allowed.", + "type": "object", + "properties": { + "io.modelcontextprotocol/clientCapabilities": { + "$ref": "#/definitions/ClientCapabilities" + }, + "io.modelcontextprotocol/clientInfo": { + "$ref": "#/definitions/Implementation" + }, + "io.modelcontextprotocol/logLevel": { + "$ref": "#/definitions/LoggingLevel" + }, + "io.modelcontextprotocol/protocolVersion": { + "type": "string" + }, + "progressToken": { + "$ref": "#/definitions/ProgressToken" + } + }, + "additionalProperties": true + }, + "RequestNoParam": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/PingRequestMethod" + } + }, + "required": [ + "method" + ] + }, + "RequestNoParam2": { + "type": "object", + "properties": { + "method": { + "$ref": "#/definitions/ListRootsRequestMethod" + } + }, + "required": [ + "method" + ] + }, + "Resource": { + "description": "A known resource that the server is capable of reading (spec `Resource`).\n\nAlso used as the inner type of `ContentBlock::ResourceLink` (spec `ResourceLink extends Resource`).", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this resource.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional annotations describing how the client should use this resource.", + "anyOf": [ + { + "$ref": "#/definitions/Annotations" + }, + { + "type": "null" + } + ] + }, + "description": { + "description": "Optional description of what this resource represents.", + "type": [ + "string", + "null" + ] + }, + "icons": { + "description": "Optional set of icons the client may display for this resource.", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Icon" + } + }, + "mimeType": { + "description": "The MIME type of this resource, if known.", + "type": [ + "string", + "null" + ] + }, + "name": { + "description": "The programmatic name of the resource.", + "type": "string" + }, + "size": { + "description": "The size of the raw resource content in bytes (before base64/tokenization), if known.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "title": { + "description": "Optional human-readable display title.", + "type": [ + "string", + "null" + ] + }, + "uri": { + "description": "The URI of this resource (e.g. `file:///path/to/file`).", + "type": "string" + } + }, + "required": [ + "uri", + "name" + ] + }, + "ResourceContents": { + "description": "The contents of a specific resource or sub-resource.", + "anyOf": [ + { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "mimeType": { + "type": [ + "string", + "null" + ] + }, + "text": { + "type": "string" + }, + "uri": { + "type": "string" + } + }, + "required": [ + "uri", + "text" + ] + }, + { + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "blob": { + "type": "string" + }, + "mimeType": { + "type": [ + "string", + "null" + ] + }, + "uri": { + "type": "string" + } + }, + "required": [ + "uri", + "blob" + ] + } + ] + }, + "ResourceListChangedNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/resources/list_changed" + }, + "ResourceTemplate": { + "description": "A template description for resources available on the server (spec `ResourceTemplate`).", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this resource template.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional annotations describing how the client should use this template.", + "anyOf": [ + { + "$ref": "#/definitions/Annotations" + }, + { + "type": "null" + } + ] + }, + "description": { + "description": "Optional description of what this template is for.", + "type": [ + "string", + "null" + ] + }, + "icons": { + "description": "Optional set of icons the client may display for this template.", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Icon" + } + }, + "mimeType": { + "description": "The MIME type for resources matching this template, if uniform.", + "type": [ + "string", + "null" + ] + }, + "name": { + "description": "The programmatic name of the resource template.", + "type": "string" + }, + "title": { + "description": "Optional human-readable display title.", + "type": [ + "string", + "null" + ] + }, + "uriTemplate": { + "description": "An RFC 6570 URI template for constructing resource URIs.", + "type": "string" + } + }, + "required": [ + "uriTemplate", + "name" + ] + }, + "ResourceUpdatedNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/resources/updated" + }, + "ResourceUpdatedNotificationParam": { + "description": "Parameters for a resource update notification", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/NotificationMetaObject" + }, + { + "type": "null" + } + ] + }, + "uri": { + "description": "The URI of the resource that was updated", + "type": "string" + } + }, + "required": [ + "uri" + ] + }, + "ResourcesCapability": { + "type": "object", + "properties": { + "listChanged": { + "type": [ + "boolean", + "null" + ] + }, + "subscribe": { + "type": [ + "boolean", + "null" + ] + } + } + }, + "ResultType": { + "description": "Indicates the type of a result object, allowing the client to\ndetermine how to parse the response.\n\nThe spec defines this as an open string (`\"complete\" | \"input_required\" | string`),\nso unknown values are preserved rather than rejected. Servers implementing this\nprotocol version MUST include `resultType` in every result. For backward\ncompatibility, clients MUST treat an absent field as `\"complete\"`.\n\nOrdinary results model the field as `Option`: `None` means the\nfield is absent on the wire. Constructors default to `Some(COMPLETE)`, and\nthe server handler strips the `\"complete\"` discriminator before responding\nto peers that negotiated a protocol version older than `2026-07-28`, so\nlegacy sessions keep their historical wire shape (see\n[`ServerResult::strip_result_type_for_legacy_peer`]).", + "type": "string" + }, + "Role": { + "description": "Represents the role of a participant in a conversation or message exchange.\n\nUsed in sampling and chat contexts to distinguish between different\ntypes of message senders in the conversation flow.", + "oneOf": [ + { + "description": "A human user or client making a request", + "type": "string", + "const": "user" + }, + { + "description": "An AI assistant or server providing a response", + "type": "string", + "const": "assistant" + } + ] + }, + "RootsCapabilities": { + "description": "Roots capability. Deprecated by SEP-2577; remains functional and will be\nremoved in a future release.\nSee .", + "type": "object", + "properties": { + "listChanged": { + "type": [ + "boolean", + "null" + ] + } + } + }, + "SamplingCapability": { + "description": "Sampling capability with optional sub-capabilities (SEP-1577).\n\nDeprecated by SEP-2577; remains functional and will be removed in a future\nrelease.\nSee .", + "type": "object", + "properties": { + "context": { + "description": "Support for `includeContext` (soft-deprecated)", + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "tools": { + "description": "Support for `tools` and `toolChoice` parameters", + "type": [ + "object", + "null" + ], + "additionalProperties": true + } + } + }, + "SamplingContent": { + "description": "Single or array content wrapper (SEP-1577).", + "anyOf": [ + { + "$ref": "#/definitions/SamplingMessageContentBlock" + }, + { + "type": "array", + "items": { + "$ref": "#/definitions/SamplingMessageContentBlock" + } + } + ] + }, + "SamplingMessage": { + "description": "A message in a sampling conversation, containing a role and content.\n\nThis represents a single message in a conversation flow, used primarily\nin LLM sampling requests where the conversation history is important\nfor generating appropriate responses.", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "content": { + "description": "The actual content of the message (text, image, audio, tool use, or tool result)", + "allOf": [ + { + "$ref": "#/definitions/SamplingContent" + } + ] + }, + "role": { + "description": "The role of the message sender (User or Assistant)", + "allOf": [ + { + "$ref": "#/definitions/Role" + } + ] + } + }, + "deprecated": true, + "required": [ + "role", + "content" + ] + }, + "SamplingMessageContentBlock": { + "description": "Content types for sampling messages (SEP-1577).", + "deprecated": true, + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "text" + } + }, + "allOf": [ + { + "$ref": "#/definitions/TextContent" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "image" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ImageContent" + } + ], + "required": [ + "type" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "audio" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AudioContent" + } + ], + "required": [ + "type" + ] + }, + { + "description": "Assistant only", + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "tool_use" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ToolUseContent" + } + ], + "required": [ + "type" + ] + }, + { + "description": "User only", + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "tool_result" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ToolResultContent" + } + ], + "required": [ + "type" + ] + } + ] + }, + "ServerCapabilities": { + "title": "Builder", + "description": "```rust\n# use rmcp::model::ServerCapabilities;\nlet cap = ServerCapabilities::builder()\n .enable_experimental()\n .enable_prompts()\n .enable_resources()\n .enable_tools()\n .enable_tool_list_changed()\n .build();\n```", + "type": "object", + "properties": { + "completions": { + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "experimental": { + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "object", + "additionalProperties": true + } + }, + "extensions": { + "description": "Optional MCP extensions that the server supports (SEP-1724).\nKeys are extension identifiers (e.g., `\"io.modelcontextprotocol/apps\"`),\nvalues are per-extension settings objects. An empty object indicates\nsupport with no settings.", + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "object", + "additionalProperties": true + } + }, + "logging": { + "description": "Capability for server log message notifications (deprecated by SEP-2577).", + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "prompts": { + "anyOf": [ + { + "$ref": "#/definitions/PromptsCapability" + }, + { + "type": "null" + } + ] + }, + "resources": { + "anyOf": [ + { + "$ref": "#/definitions/ResourcesCapability" + }, + { + "type": "null" + } + ] + }, + "tools": { + "anyOf": [ + { + "$ref": "#/definitions/ToolsCapability" + }, + { + "type": "null" + } + ] + } + } + }, + "ServerResult": { + "anyOf": [ + { + "$ref": "#/definitions/DiscoverResult" + }, + { + "$ref": "#/definitions/InitializeResult" + }, + { + "$ref": "#/definitions/CompleteResult" + }, + { + "$ref": "#/definitions/GetPromptResult" + }, + { + "$ref": "#/definitions/ListPromptsResult" + }, + { + "$ref": "#/definitions/ListResourcesResult" + }, + { + "$ref": "#/definitions/ListResourceTemplatesResult" + }, + { + "$ref": "#/definitions/ReadResourceResult" + }, + { + "$ref": "#/definitions/SubscriptionsListenResult" + }, + { + "$ref": "#/definitions/ListToolsResult" + }, + { + "$ref": "#/definitions/ElicitResult" + }, + { + "$ref": "#/definitions/CreateTaskResult" + }, + { + "$ref": "#/definitions/GetTaskResult" + }, + { + "$ref": "#/definitions/CallToolResult" + }, + { + "$ref": "#/definitions/InputRequiredResult" + }, + { + "$ref": "#/definitions/TaskAckResult" + }, + { + "$ref": "#/definitions/EmptyObject" + }, + { + "$ref": "#/definitions/CustomResult" + } + ] + }, + "SingleSelectEnumSchema": { + "description": "Combined single-select", + "anyOf": [ + { + "$ref": "#/definitions/UntitledSingleSelectEnumSchema" + }, + { + "$ref": "#/definitions/TitledSingleSelectEnumSchema" + } + ] + }, + "StringFormat": { + "description": "String format types allowed by the MCP specification.", + "oneOf": [ + { + "description": "Email address format", + "type": "string", + "const": "email" + }, + { + "description": "URI format", + "type": "string", + "const": "uri" + }, + { + "description": "Date format (YYYY-MM-DD)", + "type": "string", + "const": "date" + }, + { + "description": "Date-time format (ISO 8601)", + "type": "string", + "const": "date-time" + } + ] + }, + "StringSchema": { + "description": "Schema definition for string properties.\n\nCompliant with MCP 2025-06-18 specification for elicitation schemas.\nSupports only the fields allowed by the MCP spec:\n- format limited to: \"email\", \"uri\", \"date\", \"date-time\"", + "type": "object", + "properties": { + "default": { + "description": "Default value", + "type": [ + "string", + "null" + ] + }, + "description": { + "description": "Human-readable description", + "type": [ + "string", + "null" + ] + }, + "format": { + "description": "String format - limited to: \"email\", \"uri\", \"date\", \"date-time\"", + "anyOf": [ + { + "$ref": "#/definitions/StringFormat" + }, + { + "type": "null" + } + ] + }, + "maxLength": { + "description": "Maximum string length", + "type": [ + "integer", + "null" + ], + "format": "uint32", + "minimum": 0 + }, + "minLength": { + "description": "Minimum string length", + "type": [ + "integer", + "null" + ], + "format": "uint32", + "minimum": 0 + }, + "title": { + "description": "Optional title for the schema", + "type": [ + "string", + "null" + ] + }, + "type": { + "description": "Type discriminator", + "allOf": [ + { + "$ref": "#/definitions/StringTypeConst" + } + ] + } + }, + "required": [ + "type" + ] + }, + "StringTypeConst": { + "type": "string", + "format": "const", + "const": "string" + }, + "SubscriptionFilter": { + "description": "Notification categories a client opts in to on a `subscriptions/listen` stream.", + "type": "object", + "properties": { + "promptsListChanged": { + "type": "boolean" + }, + "resourceSubscriptions": { + "type": "array", + "items": { + "type": "string" + } + }, + "resourcesListChanged": { + "type": "boolean" + }, + "toolsListChanged": { + "type": "boolean" + } + } + }, + "SubscriptionsAcknowledgedNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/subscriptions/acknowledged" + }, + "SubscriptionsAcknowledgedNotificationParams": { + "description": "Parameters reporting the accepted subset of a subscription filter.", + "type": "object", + "properties": { + "_meta": { + "$ref": "#/definitions/NotificationMetaObject" + }, + "notifications": { + "$ref": "#/definitions/SubscriptionFilter" + } + }, + "required": [ + "notifications" + ] + }, + "SubscriptionsListenResult": { + "description": "Final response indicating that a subscription ended gracefully.", + "type": "object", + "properties": { + "_meta": { + "$ref": "#/definitions/SubscriptionsListenResultMeta" + }, + "resultType": { + "$ref": "#/definitions/ResultType" + } + }, + "required": [ + "resultType", + "_meta" + ] + }, + "SubscriptionsListenResultMeta": { + "type": "object", + "properties": { + "io.modelcontextprotocol/serverInfo": { + "description": "Identifies the server software producing the response. Servers SHOULD include this field on every response unless specifically configured not to do so.", + "allOf": [ + { + "$ref": "#/definitions/Implementation" + } + ] + }, + "io.modelcontextprotocol/subscriptionId": { + "$ref": "#/definitions/NumberOrString" + } + }, + "additionalProperties": true, + "required": [ + "io.modelcontextprotocol/subscriptionId" + ] + }, + "TaskAckResult": { + "description": "Empty acknowledgement for `tasks/update` and `tasks/cancel` (SEP-2663).\n\nThe spec requires these acks to be empty results carrying the SEP-2322\n`resultType: \"complete\"` discriminator; task state changes are observed\nvia the next `tasks/get`.", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "resultType": { + "description": "Always `\"complete\"`.", + "allOf": [ + { + "$ref": "#/definitions/ResultType" + } + ] + } + }, + "required": [ + "resultType" + ] + }, + "TaskStatus": { + "description": "Canonical task lifecycle status (SEP-2663).", + "oneOf": [ + { + "description": "The request is currently being processed.", + "type": "string", + "const": "working" + }, + { + "description": "The server needs input from the client before the task can proceed.", + "type": "string", + "const": "input_required" + }, + { + "description": "The request completed successfully and the result is available.\nThis includes tool calls that returned results with `isError: true`.", + "type": "string", + "const": "completed" + }, + { + "description": "The request failed due to a JSON-RPC error during execution.", + "type": "string", + "const": "failed" + }, + { + "description": "The request was cancelled before completion.", + "type": "string", + "const": "cancelled" + } + ] + }, + "TaskStatusNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/tasks" + }, + "TaskStatusNotificationParams": { + "description": "Parameters for a task status notification (spec `TaskStatusNotificationParams`).\n\nCarries a complete [`DetailedTask`] for the current status, identical to\nwhat `tasks/get` would have returned at that moment. The task fields are\nflattened at the top level: `NotificationParams & Task`.", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/NotificationMetaObject" + }, + { + "type": "null" + } + ] + }, + "createdAt": { + "description": "ISO 8601 timestamp when the task was created.", + "type": "string" + }, + "error": { + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "inputRequests": { + "type": [ + "object", + "null" + ], + "additionalProperties": { + "$ref": "#/definitions/InputRequest" + } + }, + "lastUpdatedAt": { + "description": "ISO 8601 timestamp when the task was last updated.", + "type": "string" + }, + "pollIntervalMs": { + "description": "Suggested polling interval in integer milliseconds. Clients SHOULD honor\nthis value to avoid overwhelming the server. This value MAY change over\nthe lifetime of a task.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "result": { + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "status": { + "description": "Current task status.", + "allOf": [ + { + "$ref": "#/definitions/TaskStatus" + } + ] + }, + "statusMessage": { + "description": "Optional message describing the current task state.\nThis MAY be exposed to the end-user or model.", + "type": [ + "string", + "null" + ] + }, + "taskId": { + "description": "Stable identifier for this task, generated by the server.", + "type": "string" + }, + "ttlMs": { + "description": "Time-to-live duration from creation in integer milliseconds; `None`\n(serialized as `null`) means unlimited. The server may discard the task\nafter the TTL elapses. This value MAY change over the lifetime of a task.", + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + } + }, + "required": [ + "taskId", + "status", + "createdAt", + "lastUpdatedAt" + ] + }, + "TextContent": { + "description": "Text content block (spec `TextContent`).", + "type": "object", + "properties": { + "_meta": { + "description": "Optional protocol-level metadata for this content block.", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional annotations describing how the client should use this content.", + "anyOf": [ + { + "$ref": "#/definitions/Annotations" + }, + { + "type": "null" + } + ] + }, + "text": { + "description": "The text content of the message.", + "type": "string" + } + }, + "required": [ + "text" + ] + }, + "TitledItems": { + "description": "Items for titled multi-select options", + "type": "object", + "properties": { + "anyOf": { + "type": "array", + "items": { + "$ref": "#/definitions/ConstTitle" + } + } + }, + "required": [ + "anyOf" + ] + }, + "TitledMultiSelectEnumSchema": { + "description": "Multi-select titled options", + "type": "object", + "properties": { + "default": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "items": { + "$ref": "#/definitions/TitledItems" + }, + "maxItems": { + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "minItems": { + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "title": { + "type": [ + "string", + "null" + ] + }, + "type": { + "$ref": "#/definitions/ArrayTypeConst" + } + }, + "required": [ + "type", + "items" + ] + }, + "TitledSingleSelectEnumSchema": { + "description": "Titled single-select", + "type": "object", + "properties": { + "default": { + "type": [ + "string", + "null" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "oneOf": { + "type": "array", + "items": { + "$ref": "#/definitions/ConstTitle" + } + }, + "title": { + "type": [ + "string", + "null" + ] + }, + "type": { + "$ref": "#/definitions/StringTypeConst" + } + }, + "required": [ + "type", + "oneOf" + ] + }, + "Tool": { + "description": "A tool that can be used by a model.", + "type": "object", + "properties": { + "_meta": { + "description": "Optional additional metadata for this tool", + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "annotations": { + "description": "Optional additional tool information.", + "anyOf": [ + { + "$ref": "#/definitions/ToolAnnotations" + }, + { + "type": "null" + } + ] + }, + "description": { + "description": "A description of what the tool does", + "type": [ + "string", + "null" + ] + }, + "icons": { + "description": "Optional list of icons for the tool", + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/Icon" + } + }, + "inputSchema": { + "description": "A JSON Schema object defining the expected parameters for the tool", + "type": "object", + "additionalProperties": true + }, + "name": { + "description": "The name of the tool", + "type": "string" + }, + "outputSchema": { + "description": "An optional JSON Schema object defining the structure of the tool's output", + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "title": { + "description": "A human-readable title for the tool", + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "name", + "inputSchema" + ] + }, + "ToolAnnotations": { + "description": "Additional properties describing a Tool to clients.\n\nNOTE: all properties in ToolAnnotations are **hints**.\nThey are not guaranteed to provide a faithful description of\ntool behavior (including descriptive properties like `title`).\n\nClients should never make tool use decisions based on ToolAnnotations\nreceived from untrusted servers.", + "type": "object", + "properties": { + "destructiveHint": { + "description": "If true, the tool may perform destructive updates to its environment.\nIf false, the tool performs only additive updates.\n\n(This property is meaningful only when `readOnlyHint == false`)\n\nDefault: true\nA human-readable description of the tool's purpose.", + "type": [ + "boolean", + "null" + ] + }, + "idempotentHint": { + "description": "If true, calling the tool repeatedly with the same arguments\nwill have no additional effect on the its environment.\n\n(This property is meaningful only when `readOnlyHint == false`)\n\nDefault: false.", + "type": [ + "boolean", + "null" + ] + }, + "openWorldHint": { + "description": "If true, this tool may interact with an \"open world\" of external\nentities. If false, the tool's domain of interaction is closed.\nFor example, the world of a web search tool is open, whereas that\nof a memory tool is not.\n\nDefault: true", + "type": [ + "boolean", + "null" + ] + }, + "readOnlyHint": { + "description": "If true, the tool does not modify its environment.\n\nDefault: false", + "type": [ + "boolean", + "null" + ] + }, + "title": { + "description": "A human-readable title for the tool.", + "type": [ + "string", + "null" + ] + } + } + }, + "ToolChoice": { + "description": "Tool choice configuration (SEP-1577).", + "type": "object", + "properties": { + "mode": { + "anyOf": [ + { + "$ref": "#/definitions/ToolChoiceMode" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": true + }, + "ToolChoiceMode": { + "description": "Tool selection mode (SEP-1577).", + "oneOf": [ + { + "description": "Model decides whether to use tools", + "type": "string", + "const": "auto" + }, + { + "description": "Model must use at least one tool", + "type": "string", + "const": "required" + }, + { + "description": "Model must not use tools", + "type": "string", + "const": "none" + } + ] + }, + "ToolListChangedNotificationMethod": { + "type": "string", + "format": "const", + "const": "notifications/tools/list_changed" + }, + "ToolResultContent": { + "description": "Tool execution result in user message (SEP-1577).", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "content": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentBlock" + } + }, + "isError": { + "type": [ + "boolean", + "null" + ] + }, + "structuredContent": true, + "toolUseId": { + "type": "string" + } + }, + "deprecated": true, + "required": [ + "toolUseId", + "content" + ] + }, + "ToolUseContent": { + "description": "Tool call request from assistant (SEP-1577).", + "type": "object", + "properties": { + "_meta": { + "anyOf": [ + { + "$ref": "#/definitions/MetaObject" + }, + { + "type": "null" + } + ] + }, + "id": { + "type": "string" + }, + "input": { + "type": "object", + "additionalProperties": true + }, + "name": { + "type": "string" + } + }, + "deprecated": true, + "required": [ + "id", + "name", + "input" + ] + }, + "ToolsCapability": { + "type": "object", + "properties": { + "listChanged": { + "type": [ + "boolean", + "null" + ] + } + } + }, + "UntitledItems": { + "description": "Items for untitled multi-select options", + "type": "object", + "properties": { + "enum": { + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "$ref": "#/definitions/StringTypeConst" + } + }, + "required": [ + "type", + "enum" + ] + }, + "UntitledMultiSelectEnumSchema": { + "description": "Multi-select untitled options", + "type": "object", + "properties": { + "default": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "items": { + "$ref": "#/definitions/UntitledItems" + }, + "maxItems": { + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "minItems": { + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "title": { + "type": [ + "string", + "null" + ] + }, + "type": { + "$ref": "#/definitions/ArrayTypeConst" + } + }, + "required": [ + "type", + "items" + ] + }, + "UntitledSingleSelectEnumSchema": { + "description": "Untitled single-select", + "type": "object", + "properties": { + "default": { + "type": [ + "string", + "null" + ] + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "enum": { + "type": "array", + "items": { + "type": "string" + } + }, + "title": { + "type": [ + "string", + "null" + ] + }, + "type": { + "$ref": "#/definitions/StringTypeConst" + } + }, + "additionalProperties": false, + "required": [ + "type", + "enum" + ] + }, + "UrlElicitationCapability": { + "description": "Capability for URL mode elicitation.", + "type": "object" + } + } +} \ No newline at end of file diff --git a/vendor/rmcp/tests/test_meta_helpers.rs b/vendor/rmcp/tests/test_meta_helpers.rs new file mode 100644 index 00000000..5f9128a4 --- /dev/null +++ b/vendor/rmcp/tests/test_meta_helpers.rs @@ -0,0 +1,98 @@ +#![allow(deprecated)] + +use rmcp::model::{ + ClientCapabilities, Implementation, LoggingLevel, ProtocolVersion, RequestMetaObject, +}; +use serde_json::json; + +const META_KEY_PROTOCOL_VERSION: &str = "io.modelcontextprotocol/protocolVersion"; +const META_KEY_CLIENT_INFO: &str = "io.modelcontextprotocol/clientInfo"; +const META_KEY_CLIENT_CAPABILITIES: &str = "io.modelcontextprotocol/clientCapabilities"; +const META_KEY_LOG_LEVEL: &str = "io.modelcontextprotocol/logLevel"; + +#[test] +fn meta_setters_store_sep_2575_values() { + let mut meta = RequestMetaObject::new(); + meta.set_protocol_version(ProtocolVersion::V_2026_07_28); + meta.set_client_info(Implementation::new("test-client", "1.0.0")); + meta.set_client_capabilities(ClientCapabilities::default()); + meta.set_log_level(LoggingLevel::Warning); + + assert_eq!( + meta.get(META_KEY_PROTOCOL_VERSION), + Some(&json!("2026-07-28")) + ); + assert_eq!( + meta.get(META_KEY_CLIENT_INFO), + Some(&json!({ "name": "test-client", "version": "1.0.0" })) + ); + assert_eq!(meta.get(META_KEY_CLIENT_CAPABILITIES), Some(&json!({}))); + assert_eq!(meta.get(META_KEY_LOG_LEVEL), Some(&json!("warning"))); +} + +#[test] +fn with_client_context_sets_all_required_sep_2575_fields() { + let meta = RequestMetaObject::with_client_context( + ProtocolVersion::V_2026_07_28, + Implementation::new("test-client", "1.0.0"), + ClientCapabilities::default(), + ); + + assert!( + meta.missing_required_keys(&ProtocolVersion::V_2026_07_28) + .is_empty() + ); + assert_eq!(meta.protocol_version(), Some(ProtocolVersion::V_2026_07_28)); + assert_eq!( + meta.client_info(), + Some(Implementation::new("test-client", "1.0.0")) + ); + assert_eq!( + meta.client_capabilities(), + Some(ClientCapabilities::default()) + ); +} + +#[test] +fn meta_accessors_decode_wire_values() { + let meta: RequestMetaObject = serde_json::from_value(json!({ + "progressToken": "progress-1", + "io.modelcontextprotocol/protocolVersion": "2026-07-28", + "io.modelcontextprotocol/clientInfo": { + "name": "wire-client", + "version": "9.0.0" + }, + "io.modelcontextprotocol/clientCapabilities": { + "sampling": {} + }, + "io.modelcontextprotocol/logLevel": "error" + })) + .unwrap(); + + assert_eq!(meta.protocol_version(), Some(ProtocolVersion::V_2026_07_28)); + assert_eq!( + meta.client_info(), + Some(Implementation::new("wire-client", "9.0.0")) + ); + assert!( + meta.client_capabilities() + .is_some_and(|capabilities| capabilities.sampling.is_some()) + ); + assert_eq!(meta.log_level(), Some(LoggingLevel::Error)); +} + +#[test] +fn meta_accessors_ignore_missing_or_malformed_values() { + let meta: RequestMetaObject = serde_json::from_value(json!({ + "io.modelcontextprotocol/protocolVersion": 20260728, + "io.modelcontextprotocol/clientInfo": "not an implementation", + "io.modelcontextprotocol/clientCapabilities": "not capabilities", + "io.modelcontextprotocol/logLevel": "loud" + })) + .unwrap(); + + assert_eq!(meta.protocol_version(), None); + assert_eq!(meta.client_info(), None); + assert_eq!(meta.client_capabilities(), None); + assert_eq!(meta.log_level(), None); +} diff --git a/vendor/rmcp/tests/test_mrtr_behavior.rs b/vendor/rmcp/tests/test_mrtr_behavior.rs new file mode 100644 index 00000000..d9df5af3 --- /dev/null +++ b/vendor/rmcp/tests/test_mrtr_behavior.rs @@ -0,0 +1,672 @@ +//! Behavior and edge-case coverage for SEP-2322 multi round-trip requests (MRTR). +//! +//! These tests drive a real client/server pair over an in-memory duplex stream +//! and exercise the auto fulfill/retry loop, the manual `*_once` escape hatch, +//! and the server-side version gating. + +// Sampling/Roots are SEP-2577-deprecated but still used to model MRTR input requests. +#![allow(deprecated)] +use std::sync::{ + Arc, + atomic::{AtomicUsize, Ordering}, +}; + +use rmcp::{ + ClientHandler, ServerHandler, + handler::server::{ + tool::{InputResponses as ToolInputResponses, RequestState}, + wrapper::Parameters, + }, + model::*, + service::{RequestContext, RoleClient, RoleServer, Service, ServiceError, serve_directly}, + tool, tool_handler, tool_router, +}; +use schemars::JsonSchema; +use serde::Deserialize; +use serde_json::json; + +/// A `requestState` value with characters that must survive a byte-exact echo: +/// dots (the codec delimiter), base64 punctuation, whitespace, and quotes. +const TRICKY_STATE: &str = "st.ate/with+special=chars and spaces \"quotes\"\n\ttab"; + +// ============================================================================= +// Test handlers +// ============================================================================= + +/// A stateless MRTR server whose behavior is selected by the tool/prompt/resource +/// name. Round progression is derived entirely from `request_state` and +/// `input_responses`, as required by the stateless MRTR pattern. +#[derive(Clone, Default)] +struct MrtrServer { + calls: Arc, +} + +fn elicitation_request(message: &str) -> InputRequest { + InputRequest::Elicitation(ElicitRequest::new( + ElicitRequestParams::FormElicitationParams { + meta: None, + message: message.into(), + requested_schema: serde_json::from_value(json!({ + "type": "object", + "properties": { "name": { "type": "string" } }, + "required": ["name"] + })) + .unwrap(), + }, + )) +} + +fn sampling_request() -> InputRequest { + InputRequest::CreateMessage(CreateMessageRequest::new(CreateMessageRequestParams::new( + vec![SamplingMessage::user_text("What is the capital of France?")], + 100, + ))) +} + +fn roots_request() -> InputRequest { + InputRequest::ListRoots(ListRootsRequest::default()) +} + +fn single_elicitation(state: &str) -> InputRequiredResult { + let mut requests = InputRequests::new(); + requests.insert("answer".to_string(), elicitation_request("Name?")); + InputRequiredResult::new(Some(requests), Some(state.into())) +} + +#[derive(Clone)] +struct MacroMrtrServer; + +#[derive(Deserialize, JsonSchema)] +struct MacroMrtrArguments { + greeting: String, +} + +#[tool_router] +impl MacroMrtrServer { + #[tool(description = "Greet a user after collecting their name")] + async fn greet( + &self, + Parameters(arguments): Parameters, + RequestState(request_state): RequestState, + ToolInputResponses(input_responses): ToolInputResponses, + ) -> Result { + match request_state.as_deref() { + None => Ok(single_elicitation("macro-state").into()), + Some("macro-state") => { + let name = input_responses + .as_ref() + .and_then(|responses| responses.get("answer")) + .and_then(|response| response["content"]["name"].as_str()) + .ok_or_else(|| ErrorData::invalid_params("missing name response", None))?; + Ok(CallToolResult::success(vec![ContentBlock::text(format!( + "{}, {name}", + arguments.greeting + ))]) + .into()) + } + Some(other) => Err(ErrorData::invalid_params( + format!("unexpected request state {other:?}"), + None, + )), + } + } +} + +#[tool_handler] +impl ServerHandler for MacroMrtrServer { + fn get_info(&self) -> ServerConfig { + let mut info = ServerConfig::new(ServerCapabilities::builder().enable_tools().build()); + info.protocol_version = ProtocolVersion::V_2026_07_28; + info + } +} + +impl MrtrServer { + fn call_tool_impl( + &self, + request: CallToolRequestParams, + ) -> Result { + let responses = request.input_responses.as_ref(); + let state = request.request_state.as_deref(); + match request.name.as_ref() { + // Single round: one elicitation, then complete. + "single" => match responses { + None => Ok(single_elicitation("state-single").into()), + Some(map) => { + if state != Some("state-single") { + return Err(ErrorData::internal_error("request_state not echoed", None)); + } + let answer = map + .get("answer") + .ok_or_else(|| ErrorData::internal_error("missing answer", None))?; + if answer["action"] != "accept" || answer["content"]["name"] != "Ferris" { + return Err(ErrorData::internal_error("unexpected elicit result", None)); + } + Ok(CallToolResult::success(vec![ContentBlock::text("done")]).into()) + } + }, + // Two elicitation rounds before completing. + "multi_round" => match state { + None => Ok(single_elicitation("round-1").into()), + Some("round-1") => Ok(single_elicitation("round-2").into()), + Some("round-2") => { + Ok(CallToolResult::success(vec![ContentBlock::text("multi-done")]).into()) + } + Some(other) => Err(ErrorData::internal_error( + format!("unexpected round state {other:?}"), + None, + )), + }, + // Several input requests fulfilled concurrently in a single round. + "multi_request" => match responses { + None => { + let mut requests = InputRequests::new(); + requests.insert("form".to_string(), elicitation_request("Name?")); + requests.insert("sample".to_string(), sampling_request()); + requests.insert("roots".to_string(), roots_request()); + Ok(InputRequiredResult::new(Some(requests), Some("multi-req".into())).into()) + } + Some(map) => { + for key in ["form", "sample", "roots"] { + if !map.contains_key(key) { + return Err(ErrorData::internal_error( + format!("missing response for {key}"), + None, + )); + } + } + Ok(CallToolResult::success(vec![ContentBlock::text("multi-req-done")]).into()) + } + }, + // State-only load shedding: two state-only rounds, then complete. + "state_only" => match state { + None => Ok(InputRequiredResult::from_request_state("so-1").into()), + Some("so-1") => Ok(InputRequiredResult::from_request_state("so-2").into()), + Some("so-2") => { + Ok(CallToolResult::success(vec![ContentBlock::text("state-done")]).into()) + } + Some(other) => Err(ErrorData::internal_error( + format!("unexpected state {other:?}"), + None, + )), + }, + // Never completes: used to exercise the max-rounds cap. + "loops" => Ok(single_elicitation("loop").into()), + // Triggers a failure inside the client's elicitation handler. + "handler_error" => { + let mut requests = InputRequests::new(); + requests.insert("answer".to_string(), elicitation_request("FAIL")); + Ok(InputRequiredResult::new(Some(requests), Some("state".into())).into()) + } + // Verifies the client echoes `request_state` byte-for-byte. + "echo_state" => match responses { + None => { + let mut requests = InputRequests::new(); + requests.insert("answer".to_string(), elicitation_request("Name?")); + Ok(InputRequiredResult::new(Some(requests), Some(TRICKY_STATE.into())).into()) + } + Some(_) => { + if state != Some(TRICKY_STATE) { + return Err(ErrorData::internal_error( + "request_state was not echoed byte-exact", + None, + )); + } + Ok(CallToolResult::success(vec![ContentBlock::text("echo-ok")]).into()) + } + }, + _ => Ok(CallToolResult::success(vec![ContentBlock::text("noop")]).into()), + } + } +} + +impl ServerHandler for MrtrServer { + fn get_info(&self) -> ServerConfig { + let mut info = ServerConfig::new( + ServerCapabilities::builder() + .enable_tools() + .enable_prompts() + .build(), + ); + info.protocol_version = ProtocolVersion::V_2026_07_28; + info + } + + async fn call_tool( + &self, + request: CallToolRequestParams, + _context: RequestContext, + ) -> Result { + self.calls.fetch_add(1, Ordering::SeqCst); + self.call_tool_impl(request) + } + + async fn get_prompt( + &self, + request: GetPromptRequestParams, + _context: RequestContext, + ) -> Result { + self.calls.fetch_add(1, Ordering::SeqCst); + match request.request_state.as_deref() { + None => Ok(single_elicitation("prompt-1").into()), + Some("prompt-1") => Ok(GetPromptResult::new(vec![PromptMessage::new_text( + Role::Assistant, + "prompt-done", + )]) + .into()), + Some(other) => Err(ErrorData::internal_error( + format!("unexpected prompt state {other:?}"), + None, + )), + } + } + + async fn read_resource( + &self, + request: ReadResourceRequestParams, + _context: RequestContext, + ) -> Result { + self.calls.fetch_add(1, Ordering::SeqCst); + match request.request_state.as_deref() { + None => Ok(single_elicitation("res-1").into()), + Some("res-1") => Ok(ReadResourceResult::new(vec![ResourceContents::text( + "resource-done", + request.uri, + )]) + .into()), + Some(other) => Err(ErrorData::internal_error( + format!("unexpected resource state {other:?}"), + None, + )), + } + } +} + +/// A client that fulfills every kind of MRTR input request. Elicitation fails +/// deliberately when the prompt message is `"FAIL"`. +#[derive(Clone, Default)] +struct MrtrClient; + +impl ClientHandler for MrtrClient { + async fn create_elicitation( + &self, + request: ElicitRequestParams, + _context: RequestContext, + ) -> Result { + if let ElicitRequestParams::FormElicitationParams { message, .. } = &request + && message == "FAIL" + { + return Err(ErrorData::internal_error( + "elicitation handler failed", + None, + )); + } + Ok(ElicitResult::new(ElicitationAction::Accept).with_content(json!({ "name": "Ferris" }))) + } + + async fn create_message( + &self, + _request: CreateMessageRequestParams, + _context: RequestContext, + ) -> Result { + Ok(CreateMessageResult::new( + SamplingMessage::assistant_text("Paris."), + "test-model".into(), + ) + .with_stop_reason(CreateMessageResult::STOP_REASON_END_TURN)) + } + + async fn list_roots( + &self, + _context: RequestContext, + ) -> Result { + Ok(ListRootsResult::new(vec![Root::new("file:///workspace")])) + } +} + +// ============================================================================= +// Harness +// ============================================================================= + +fn client_info(protocol_version: ProtocolVersion) -> InitializeRequestParams { + InitializeRequestParams::new( + ClientCapabilities::builder().enable_elicitation().build(), + Implementation::new("mrtr-test-client", "0.0.0"), + ) + .with_protocol_version(protocol_version) +} + +fn server_info(protocol_version: ProtocolVersion) -> InitializeResult { + let mut info = InitializeResult::new(ServerCapabilities::builder().enable_tools().build()); + info.protocol_version = protocol_version; + info +} + +/// Runs `body` inside a `LocalSet` so `spawn_local` (used when the `local` +/// feature is active) is available, wiring up a connected client/server pair. +async fn with_pair( + server: S, + client_protocol: ProtocolVersion, + body: F, +) -> anyhow::Result<()> +where + S: Service, + F: FnOnce(rmcp::service::RunningService) -> Fut, + Fut: std::future::Future>, +{ + tokio::task::LocalSet::new() + .run_until(async move { + let (server_transport, client_transport) = tokio::io::duplex(8192); + let server_peer_info = client_info(client_protocol); + let client_peer_info = server_info(server_peer_info.protocol_version.clone()); + let server_task = tokio::task::spawn_local(async move { + let running = serve_directly::( + server, + server_transport, + Some(server_peer_info), + ); + running.waiting().await?; + anyhow::Ok(()) + }); + + let client = serve_directly::( + MrtrClient, + client_transport, + Some(client_peer_info.into()), + ); + + let result = body(client).await; + + server_task.abort(); + result + }) + .await +} + +// ============================================================================= +// Tests +// ============================================================================= + +#[tokio::test(flavor = "current_thread")] +async fn client_auto_fulfills_input_required_tool_call() -> anyhow::Result<()> { + let server = MrtrServer::default(); + let calls = server.calls.clone(); + with_pair(server, ProtocolVersion::V_2026_07_28, |client| async move { + let result = client + .call_tool(CallToolRequestParams::new("single")) + .await?; + assert_eq!(result.content[0].as_text().unwrap().text, "done"); + assert_eq!(calls.load(Ordering::SeqCst), 2); + Ok(()) + }) + .await +} + +#[tokio::test(flavor = "current_thread")] +async fn tool_macro_receives_mrtr_retry_fields() -> anyhow::Result<()> { + with_pair( + MacroMrtrServer, + ProtocolVersion::V_2026_07_28, + |client| async move { + let arguments = serde_json::from_value(json!({ "greeting": "hello" })).unwrap(); + let result = client + .call_tool(CallToolRequestParams::new("greet").with_arguments(arguments)) + .await?; + assert_eq!(result.content[0].as_text().unwrap().text, "hello, Ferris"); + Ok(()) + }, + ) + .await +} + +#[tokio::test(flavor = "current_thread")] +async fn manual_once_returns_input_required_without_retry() -> anyhow::Result<()> { + let server = MrtrServer::default(); + let calls = server.calls.clone(); + with_pair(server, ProtocolVersion::V_2026_07_28, |client| async move { + let result = client + .call_tool_once(CallToolRequestParams::new("single")) + .await?; + assert!(matches!(result, CallToolResponse::InputRequired(_))); + // A manual round makes exactly one server call and never retries. + assert_eq!(calls.load(Ordering::SeqCst), 1); + Ok(()) + }) + .await +} + +#[tokio::test(flavor = "current_thread")] +async fn multi_round_input_required_completes() -> anyhow::Result<()> { + let server = MrtrServer::default(); + let calls = server.calls.clone(); + with_pair(server, ProtocolVersion::V_2026_07_28, |client| async move { + let result = client + .call_tool(CallToolRequestParams::new("multi_round")) + .await?; + assert_eq!(result.content[0].as_text().unwrap().text, "multi-done"); + // round 0 + two retries = 3 server calls. + assert_eq!(calls.load(Ordering::SeqCst), 3); + Ok(()) + }) + .await +} + +#[tokio::test(flavor = "current_thread")] +async fn multiple_input_requests_fulfilled_in_one_round() -> anyhow::Result<()> { + let server = MrtrServer::default(); + let calls = server.calls.clone(); + with_pair(server, ProtocolVersion::V_2026_07_28, |client| async move { + let result = client + .call_tool(CallToolRequestParams::new("multi_request")) + .await?; + assert_eq!(result.content[0].as_text().unwrap().text, "multi-req-done"); + assert_eq!(calls.load(Ordering::SeqCst), 2); + Ok(()) + }) + .await +} + +#[tokio::test(flavor = "current_thread")] +async fn state_only_input_required_completes() -> anyhow::Result<()> { + let server = MrtrServer::default(); + let calls = server.calls.clone(); + with_pair(server, ProtocolVersion::V_2026_07_28, |client| async move { + let result = client + .call_tool(CallToolRequestParams::new("state_only")) + .await?; + assert_eq!(result.content[0].as_text().unwrap().text, "state-done"); + // round 0 + two state-only retries = 3 server calls. + assert_eq!(calls.load(Ordering::SeqCst), 3); + Ok(()) + }) + .await +} + +#[tokio::test(flavor = "current_thread")] +async fn max_rounds_exceeded_returns_error() -> anyhow::Result<()> { + let server = MrtrServer::default(); + let calls = server.calls.clone(); + with_pair(server, ProtocolVersion::V_2026_07_28, |client| async move { + let err = client + .call_tool_with_mrtr_max_rounds(CallToolRequestParams::new("loops"), 3) + .await + .expect_err("a tool that never completes must exhaust the round cap"); + assert!(matches!( + err, + ServiceError::InputRequiredRoundsExceeded { max_rounds: 3 } + )); + assert_eq!(calls.load(Ordering::SeqCst), 3); + Ok(()) + }) + .await +} + +#[tokio::test(flavor = "current_thread")] +async fn client_handler_error_propagates() -> anyhow::Result<()> { + let server = MrtrServer::default(); + with_pair(server, ProtocolVersion::V_2026_07_28, |client| async move { + let err = client + .call_tool(CallToolRequestParams::new("handler_error")) + .await + .expect_err("a failing input handler must fail the whole call"); + assert!(matches!(err, ServiceError::McpError(_))); + Ok(()) + }) + .await +} + +#[tokio::test(flavor = "current_thread")] +async fn request_state_is_echoed_byte_exact() -> anyhow::Result<()> { + let server = MrtrServer::default(); + with_pair(server, ProtocolVersion::V_2026_07_28, |client| async move { + // The server returns an error result unless it sees TRICKY_STATE echoed + // back unchanged, so a successful completion proves the byte-exact echo. + let result = client + .call_tool(CallToolRequestParams::new("echo_state")) + .await?; + assert_eq!(result.content[0].as_text().unwrap().text, "echo-ok"); + Ok(()) + }) + .await +} + +#[tokio::test(flavor = "current_thread")] +async fn get_prompt_auto_fulfills_input_required() -> anyhow::Result<()> { + let server = MrtrServer::default(); + with_pair(server, ProtocolVersion::V_2026_07_28, |client| async move { + let result = client.get_prompt(GetPromptRequestParams::new("p")).await?; + assert_eq!( + result.messages[0].content.as_text().unwrap().text, + "prompt-done" + ); + Ok(()) + }) + .await +} + +#[tokio::test(flavor = "current_thread")] +async fn read_resource_auto_fulfills_input_required() -> anyhow::Result<()> { + let server = MrtrServer::default(); + with_pair(server, ProtocolVersion::V_2026_07_28, |client| async move { + let result = client + .read_resource(ReadResourceRequestParams::new("res://x")) + .await?; + let text = match &result.contents[0] { + ResourceContents::TextResourceContents { text, .. } => text.clone(), + _ => panic!("expected text resource"), + }; + assert_eq!(text, "resource-done"); + Ok(()) + }) + .await +} + +#[tokio::test(flavor = "current_thread")] +async fn old_protocol_rejects_input_required() -> anyhow::Result<()> { + let server = MrtrServer::default(); + // The client negotiated 2025-11-25, so the server must refuse to emit an + // InputRequiredResult and return a protocol error instead. + with_pair(server, ProtocolVersion::V_2025_11_25, |client| async move { + let err = client + .call_tool_once(CallToolRequestParams::new("single")) + .await + .expect_err("MRTR must be rejected for pre-2026 peers"); + match err { + ServiceError::McpError(error) => { + assert!( + error.message.contains("2026-07-28"), + "unexpected error message: {}", + error.message + ); + } + other => panic!("expected an McpError, got {other:?}"), + } + Ok(()) + }) + .await +} + +#[cfg(feature = "request-state")] +#[tokio::test(flavor = "current_thread")] +async fn request_state_codec_seals_and_verifies_through_the_loop() -> anyhow::Result<()> { + use std::sync::OnceLock; + + use rmcp::model::RequestStateCodec; + + // A shared per-process signing key, mirroring how a real server would derive one. + const KEY: &[u8] = b"integration-signing-key-32-bytes!"; + const _: () = assert!( + KEY.len() >= RequestStateCodec::MIN_KEY_LENGTH, + "KEY is shorter than RequestStateCodec::MIN_KEY_LENGTH", + ); + + fn codec() -> &'static RequestStateCodec { + static CODEC: OnceLock = OnceLock::new(); + CODEC.get_or_init(|| RequestStateCodec::new_unchecked(KEY)) + } + + #[derive(Clone, Default)] + struct SealingServer; + + impl ServerHandler for SealingServer { + fn get_info(&self) -> ServerConfig { + let mut info = ServerConfig::new(ServerCapabilities::builder().enable_tools().build()); + info.protocol_version = ProtocolVersion::V_2026_07_28; + info + } + + async fn call_tool( + &self, + request: CallToolRequestParams, + _context: RequestContext, + ) -> Result { + match request.request_state { + None => { + let sealed = codec() + .seal_json(&json!({ "step": 1, "tool": request.name })) + .map_err(|e| ErrorData::internal_error(e.to_string(), None))?; + let mut requests = InputRequests::new(); + requests.insert("answer".to_string(), elicitation_request("Name?")); + Ok(InputRequiredResult::new(Some(requests), Some(sealed)).into()) + } + Some(sealed) => { + // The echoed state is untrusted; verify it before use. + let state: serde_json::Value = codec() + .open_json(&sealed) + .map_err(|e| ErrorData::internal_error(e.to_string(), None))?; + assert_eq!(state["step"], 1); + Ok(CallToolResult::success(vec![ContentBlock::text("sealed-done")]).into()) + } + } + } + } + + tokio::task::LocalSet::new() + .run_until(async move { + let (server_transport, client_transport) = tokio::io::duplex(8192); + let server_task = tokio::task::spawn_local(async move { + let running = serve_directly::( + SealingServer, + server_transport, + Some(client_info(ProtocolVersion::V_2026_07_28)), + ); + running.waiting().await?; + anyhow::Ok(()) + }); + + let client = serve_directly::( + MrtrClient, + client_transport, + Some(server_info(ProtocolVersion::V_2026_07_28).into()), + ); + + let result = client + .call_tool(CallToolRequestParams::new("sealed")) + .await?; + assert_eq!(result.content[0].as_text().unwrap().text, "sealed-done"); + + server_task.abort(); + anyhow::Ok(()) + }) + .await +} diff --git a/vendor/rmcp/tests/test_notification.rs b/vendor/rmcp/tests/test_notification.rs new file mode 100644 index 00000000..9e4db7fd --- /dev/null +++ b/vendor/rmcp/tests/test_notification.rs @@ -0,0 +1,241 @@ +#![cfg(not(feature = "local"))] +#![allow(deprecated)] +use std::sync::Arc; + +use rmcp::{ + ClientHandler, ServerHandler, ServiceExt, + model::{ + ClientNotification, CustomNotification, ProtocolVersion, ResourceUpdatedNotificationParam, + ServerCapabilities, ServerConfig, ServerNotification, SubscribeRequestParams, + }, +}; +use serde_json::json; +use tokio::sync::{Mutex, Notify}; +use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt}; + +struct Server {} + +impl ServerHandler for Server { + fn get_info(&self) -> ServerConfig { + ServerConfig::new( + ServerCapabilities::builder() + .enable_resources() + .enable_resources_subscribe() + .enable_resources_list_changed() + .build(), + ) + } + + async fn subscribe( + &self, + request: rmcp::model::SubscribeRequestParams, + context: rmcp::service::RequestContext, + ) -> Result<(), rmcp::ErrorData> { + let uri = request.uri; + let peer = context.peer; + + tokio::spawn(async move { + let span = tracing::info_span!("subscribe", uri = %uri); + let _enter = span.enter(); + + if let Err(e) = peer + .notify_resource_updated(ResourceUpdatedNotificationParam::new(uri.clone())) + .await + { + panic!("Failed to send notification: {}", e); + } + }); + + Ok(()) + } +} + +pub struct Client { + receive_signal: Arc, +} + +impl ClientHandler for Client { + // Pinned to the handshake lifecycle: this test drives subscriptions over a + // session, which `LATEST` no longer establishes. + fn get_info(&self) -> rmcp::model::ClientInfo { + rmcp::model::ClientInfo::default() + .with_protocol_version(ProtocolVersion::LATEST_WITH_INITIALIZE) + } + + async fn on_resource_updated( + &self, + params: rmcp::model::ResourceUpdatedNotificationParam, + _context: rmcp::service::NotificationContext, + ) { + let uri = params.uri; + tracing::info!("Resource updated: {}", uri); + self.receive_signal.notify_one(); + } +} + +#[tokio::test] +async fn test_server_notification() -> anyhow::Result<()> { + let _ = tracing_subscriber::registry() + .with( + tracing_subscriber::EnvFilter::try_from_default_env() + .unwrap_or_else(|_| "debug".to_string().into()), + ) + .with(tracing_subscriber::fmt::layer()) + .try_init(); + let (server_transport, client_transport) = tokio::io::duplex(4096); + tokio::spawn(async move { + let server = Server {}.serve(server_transport).await?; + server.waiting().await?; + anyhow::Ok(()) + }); + let receive_signal = Arc::new(Notify::new()); + let client = Client { + receive_signal: receive_signal.clone(), + } + .serve(client_transport) + .await?; + client + .subscribe(SubscribeRequestParams::new("test://test-resource")) + .await?; + receive_signal.notified().await; + client.cancel().await?; + Ok(()) +} + +type CustomNotificationPayload = (String, Option); + +struct CustomServer { + receive_signal: Arc, + payload: Arc>>, +} + +impl ServerHandler for CustomServer { + async fn on_custom_notification( + &self, + notification: CustomNotification, + _context: rmcp::service::NotificationContext, + ) { + let CustomNotification { method, params, .. } = notification; + *self.payload.lock().await = Some((method, params)); + self.receive_signal.notify_one(); + } +} + +#[tokio::test] +async fn test_custom_client_notification_reaches_server() -> anyhow::Result<()> { + let _ = tracing_subscriber::registry() + .with( + tracing_subscriber::EnvFilter::try_from_default_env() + .unwrap_or_else(|_| "debug".to_string().into()), + ) + .with(tracing_subscriber::fmt::layer()) + .try_init(); + + let (server_transport, client_transport) = tokio::io::duplex(4096); + let receive_signal = Arc::new(Notify::new()); + let payload = Arc::new(Mutex::new(None)); + + { + let receive_signal = receive_signal.clone(); + let payload = payload.clone(); + tokio::spawn(async move { + let server = CustomServer { + receive_signal, + payload, + } + .serve(server_transport) + .await?; + server.waiting().await?; + anyhow::Ok(()) + }); + } + + let client = ().serve(client_transport).await?; + + client + .send_notification(ClientNotification::CustomNotification( + CustomNotification::new("notifications/custom-test", Some(json!({ "foo": "bar" }))), + )) + .await?; + + tokio::time::timeout(std::time::Duration::from_secs(5), receive_signal.notified()).await?; + + let (method, params) = payload.lock().await.take().expect("payload set"); + assert_eq!("notifications/custom-test", method); + assert_eq!(Some(json!({ "foo": "bar" })), params); + + client.cancel().await?; + Ok(()) +} + +struct CustomServerNotifier; + +impl ServerHandler for CustomServerNotifier { + async fn on_initialized(&self, context: rmcp::service::NotificationContext) { + let peer = context.peer.clone(); + tokio::spawn(async move { + peer.send_notification(ServerNotification::CustomNotification( + CustomNotification::new( + "notifications/custom-test", + Some(json!({ "hello": "world" })), + ), + )) + .await + .expect("send custom notification"); + }); + } +} + +struct CustomClient { + receive_signal: Arc, + payload: Arc>>, +} + +impl ClientHandler for CustomClient { + async fn on_custom_notification( + &self, + notification: CustomNotification, + _context: rmcp::service::NotificationContext, + ) { + let CustomNotification { method, params, .. } = notification; + *self.payload.lock().await = Some((method, params)); + self.receive_signal.notify_one(); + } +} + +#[tokio::test] +async fn test_custom_server_notification_reaches_client() -> anyhow::Result<()> { + let _ = tracing_subscriber::registry() + .with( + tracing_subscriber::EnvFilter::try_from_default_env() + .unwrap_or_else(|_| "debug".to_string().into()), + ) + .with(tracing_subscriber::fmt::layer()) + .try_init(); + + let (server_transport, client_transport) = tokio::io::duplex(4096); + tokio::spawn(async move { + let server = CustomServerNotifier {}.serve(server_transport).await?; + server.waiting().await?; + anyhow::Ok(()) + }); + + let receive_signal = Arc::new(Notify::new()); + let payload = Arc::new(Mutex::new(None)); + + let client = CustomClient { + receive_signal: receive_signal.clone(), + payload: payload.clone(), + } + .serve(client_transport) + .await?; + + tokio::time::timeout(std::time::Duration::from_secs(5), receive_signal.notified()).await?; + + let (method, params) = payload.lock().await.take().expect("payload set"); + assert_eq!("notifications/custom-test", method); + assert_eq!(Some(json!({ "hello": "world" })), params); + + client.cancel().await?; + Ok(()) +} diff --git a/vendor/rmcp/tests/test_progress_subscriber.rs b/vendor/rmcp/tests/test_progress_subscriber.rs new file mode 100644 index 00000000..8df1b7ca --- /dev/null +++ b/vendor/rmcp/tests/test_progress_subscriber.rs @@ -0,0 +1,134 @@ +#![cfg(not(feature = "local"))] +use futures::StreamExt; +use rmcp::{ + ClientHandler, Peer, RoleServer, ServerHandler, ServiceExt, + handler::{client::progress::ProgressDispatcher, server::tool::ToolRouter}, + model::{ + CallToolRequestParams, ClientRequest, ProgressNotificationParam, Request, RequestMetaObject, + }, + service::PeerRequestOptions, + tool, tool_handler, tool_router, +}; +use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt}; + +pub struct MyClient { + progress_handler: ProgressDispatcher, +} + +impl MyClient { + pub fn new() -> Self { + Self { + progress_handler: ProgressDispatcher::new(), + } + } +} + +impl Default for MyClient { + fn default() -> Self { + Self::new() + } +} + +impl ClientHandler for MyClient { + async fn on_progress( + &self, + params: rmcp::model::ProgressNotificationParam, + _context: rmcp::service::NotificationContext, + ) { + tracing::info!("Received progress notification: {:?}", params); + self.progress_handler.handle_notification(params).await; + } +} + +pub struct MyServer { + #[expect(dead_code, reason = "tool_handler macro accesses this router field")] + tool_router: ToolRouter, +} + +impl MyServer { + pub fn new() -> Self { + Self { + tool_router: Self::tool_router(), + } + } +} + +impl Default for MyServer { + fn default() -> Self { + Self::new() + } +} + +#[tool_router] +impl MyServer { + #[tool] + pub async fn some_progress( + meta: RequestMetaObject, + client: Peer, + ) -> Result<(), rmcp::ErrorData> { + let progress_token = meta + .get_progress_token() + .ok_or(rmcp::ErrorData::invalid_params( + "Progress token is required for this tool", + None, + ))?; + for step in 0..10 { + let _ = client + .notify_progress( + ProgressNotificationParam::new(progress_token.clone(), step as f64) + .with_total(10.0) + .with_message("Some message"), + ) + .await; + tokio::time::sleep(tokio::time::Duration::from_millis(100)).await; + } + Ok(()) + } +} + +#[tool_handler] +impl ServerHandler for MyServer {} + +#[tokio::test] +async fn test_progress_subscriber() -> anyhow::Result<()> { + let _ = tracing_subscriber::registry() + .with( + tracing_subscriber::EnvFilter::try_from_default_env() + .unwrap_or_else(|_| "debug".to_string().into()), + ) + .with(tracing_subscriber::fmt::layer()) + .try_init(); + let client = MyClient::new(); + + let server = MyServer::new(); + let (transport_server, transport_client) = tokio::io::duplex(4096); + tokio::spawn(async move { + let service = server.serve(transport_server).await?; + service.waiting().await?; + anyhow::Ok(()) + }); + let client_service = client.serve(transport_client).await?; + let handle = client_service + .send_cancellable_request( + ClientRequest::CallToolRequest(Request::new(CallToolRequestParams::new( + "some_progress", + ))), + PeerRequestOptions::no_options(), + ) + .await?; + let mut progress_subscriber = client_service + .service() + .progress_handler + .subscribe(handle.progress_token.clone()) + .await; + tokio::spawn(async move { + while let Some(notification) = progress_subscriber.next().await { + tracing::info!("Progress notification: {:?}", notification); + } + }); + let _response = handle.await_response().await?; + + // Simulate some delay to allow the async task to complete + tokio::time::sleep(tokio::time::Duration::from_secs(1)).await; + Ok(()) +} diff --git a/vendor/rmcp/tests/test_prompt_handler.rs b/vendor/rmcp/tests/test_prompt_handler.rs new file mode 100644 index 00000000..97018a55 --- /dev/null +++ b/vendor/rmcp/tests/test_prompt_handler.rs @@ -0,0 +1,155 @@ +//cargo test --test test_prompt_handler --features "client server" +// Tests for verifying that the #[prompt_handler] macro correctly generates +// the ServerHandler trait implementation methods. +#![allow(dead_code)] + +use rmcp::{ServerHandler, handler::server::router::prompt::PromptRouter, prompt_handler}; + +#[derive(Debug, Clone)] +pub struct TestPromptServer { + prompt_router: PromptRouter, +} + +impl Default for TestPromptServer { + fn default() -> Self { + Self::new() + } +} + +impl TestPromptServer { + pub fn new() -> Self { + Self { + prompt_router: PromptRouter::new(), + } + } +} + +#[prompt_handler(router = self.prompt_router)] +impl ServerHandler for TestPromptServer {} + +#[derive(Debug, Clone)] +pub struct CustomRouterServer { + custom_router: PromptRouter, +} + +impl Default for CustomRouterServer { + fn default() -> Self { + Self::new() + } +} + +impl CustomRouterServer { + pub fn new() -> Self { + Self { + custom_router: PromptRouter::new(), + } + } + + pub fn get_custom_router(&self) -> &PromptRouter { + &self.custom_router + } +} + +#[prompt_handler(router = self.custom_router)] +impl ServerHandler for CustomRouterServer {} + +#[derive(Debug, Clone)] +pub struct GenericPromptServer { + prompt_router: PromptRouter, + _marker: std::marker::PhantomData, +} + +impl Default for GenericPromptServer { + fn default() -> Self { + Self::new() + } +} + +impl GenericPromptServer { + pub fn new() -> Self { + Self { + prompt_router: PromptRouter::new(), + _marker: std::marker::PhantomData, + } + } +} + +#[prompt_handler(router = self.prompt_router)] +impl ServerHandler for GenericPromptServer {} + +#[test] +fn test_prompt_handler_basic() { + let server = TestPromptServer::new(); + + // Test that the server implements ServerHandler + fn assert_server_handler(_: &T) {} + assert_server_handler(&server); + + // Test that the prompt router is accessible + assert_eq!(server.prompt_router.list_all().len(), 0); +} + +#[test] +fn test_prompt_handler_custom_router() { + let server = CustomRouterServer::new(); + + // Test that the server implements ServerHandler + fn assert_server_handler(_: &T) {} + assert_server_handler(&server); + + // Test that the custom router is used + assert_eq!(server.custom_router.list_all().len(), 0); +} + +#[test] +fn test_prompt_handler_with_generics() { + let server = GenericPromptServer::::new(); + + // Test that generic server implements ServerHandler + fn assert_server_handler(_: &T) {} + assert_server_handler(&server); + + // Test with a different generic type + let server2 = GenericPromptServer::::new(); + assert_server_handler(&server2); +} + +#[test] +fn test_prompt_handler_trait_implementation() { + // This test verifies that the prompt_handler macro generates proper ServerHandler implementation + // The actual method signatures are tested through the ServerHandler trait bound + fn compile_time_check() {} + + compile_time_check::(); + compile_time_check::(); + compile_time_check::>(); +} + +// Test that the macro works with different server configurations +mod nested { + use super::*; + + #[derive(Debug, Clone)] + pub struct NestedServer { + prompt_router: PromptRouter, + } + + impl NestedServer { + pub fn new() -> Self { + Self { + prompt_router: PromptRouter::new(), + } + } + } + + #[prompt_handler(router = self.prompt_router)] + impl ServerHandler for NestedServer {} + + #[test] + fn test_nested_prompt_handler() { + let server = NestedServer::new(); + // Verify it implements ServerHandler + fn assert_server_handler(_: &T) {} + assert_server_handler(&server); + } +} diff --git a/vendor/rmcp/tests/test_prompt_macro_annotations.rs b/vendor/rmcp/tests/test_prompt_macro_annotations.rs new file mode 100644 index 00000000..b5b6ef6a --- /dev/null +++ b/vendor/rmcp/tests/test_prompt_macro_annotations.rs @@ -0,0 +1,274 @@ +//cargo test --test test_prompt_macro_annotations --features "client server" +#![allow(dead_code)] + +use rmcp::{ + ServerHandler, + handler::server::wrapper::Parameters, + model::{GetPromptResult, Prompt, PromptMessage, Role}, + prompt, +}; +use schemars::JsonSchema; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone)] +struct TestServer; + +impl ServerHandler for TestServer {} + +#[derive(Serialize, Deserialize, JsonSchema)] +struct TestArgs { + /// The input text to process + input: String, + /// Optional configuration + #[serde(skip_serializing_if = "Option::is_none")] + config: Option, +} + +#[derive(Serialize, Deserialize, JsonSchema)] +struct ComplexArgs { + /// Required field + required_field: String, + /// Optional string field + #[schemars(description = "An optional string parameter")] + optional_string: Option, + /// Optional number field + optional_number: Option, + /// Array field + items: Vec, +} + +// Test basic prompt attribute generation +#[prompt] +async fn basic_prompt(_server: &TestServer) -> Vec { + vec![PromptMessage::new_text(Role::Assistant, "Basic response")] +} + +// Test prompt with custom name +#[prompt(name = "custom_name")] +async fn named_prompt(_server: &TestServer) -> Vec { + vec![PromptMessage::new_text(Role::Assistant, "Named response")] +} + +// Test prompt with custom description +#[prompt(description = "This is a custom description")] +async fn described_prompt(_server: &TestServer) -> Vec { + vec![PromptMessage::new_text( + Role::Assistant, + "Described response", + )] +} + +// Test prompt with both name and description +#[prompt(name = "full_custom", description = "Fully customized prompt")] +async fn fully_custom_prompt(_server: &TestServer) -> Vec { + vec![PromptMessage::new_text( + Role::Assistant, + "Fully custom response", + )] +} + +// Test prompt with doc comments +/// This is a doc comment description +/// that spans multiple lines +#[prompt] +async fn doc_comment_prompt(_server: &TestServer) -> Vec { + vec![PromptMessage::new_text( + Role::Assistant, + "Doc comment response", + )] +} + +// Test prompt with doc comments and explicit description (explicit wins) +/// This is a doc comment +#[prompt(description = "This overrides the doc comment")] +async fn override_doc_prompt(_server: &TestServer) -> Vec { + vec![PromptMessage::new_text( + Role::Assistant, + "Override response", + )] +} + +// Test prompt with arguments +#[prompt] +async fn args_prompt(_server: &TestServer, _args: Parameters) -> Vec { + vec![PromptMessage::new_text(Role::Assistant, "Args response")] +} + +// Test prompt with complex arguments +#[prompt] +async fn complex_args_prompt( + _server: &TestServer, + _args: Parameters, +) -> GetPromptResult { + GetPromptResult::new(vec![PromptMessage::new_text( + Role::Assistant, + "Complex response", + )]) + .with_description("Complex args result") +} + +// Test sync prompt +#[prompt] +fn sync_prompt(_server: &TestServer) -> Vec { + vec![PromptMessage::new_text(Role::Assistant, "Sync response")] +} + +#[test] +fn test_basic_prompt_attr() { + let attr = basic_prompt_prompt_attr(); + assert_eq!(attr.name, "basic_prompt"); + assert_eq!(attr.description, None); + assert!(attr.arguments.is_none()); +} + +#[test] +fn test_named_prompt_attr() { + let attr = named_prompt_prompt_attr(); + assert_eq!(attr.name, "custom_name"); + assert_eq!(attr.description, None); + assert!(attr.arguments.is_none()); +} + +#[test] +fn test_described_prompt_attr() { + let attr = described_prompt_prompt_attr(); + assert_eq!(attr.name, "described_prompt"); + assert_eq!( + attr.description.as_deref(), + Some("This is a custom description") + ); + assert!(attr.arguments.is_none()); +} + +#[test] +fn test_fully_custom_prompt_attr() { + let attr = fully_custom_prompt_prompt_attr(); + assert_eq!(attr.name, "full_custom"); + assert_eq!(attr.description.as_deref(), Some("Fully customized prompt")); + assert!(attr.arguments.is_none()); +} + +#[test] +fn test_doc_comment_prompt_attr() { + let attr = doc_comment_prompt_prompt_attr(); + assert_eq!(attr.name, "doc_comment_prompt"); + assert!(attr.description.is_some()); + let desc = attr.description.unwrap(); + assert!(desc.contains("This is a doc comment description")); + assert!(desc.contains("that spans multiple lines")); +} + +#[test] +fn test_override_doc_prompt_attr() { + let attr = override_doc_prompt_prompt_attr(); + assert_eq!(attr.name, "override_doc_prompt"); + assert_eq!( + attr.description.as_deref(), + Some("This overrides the doc comment") + ); +} + +#[test] +fn test_args_prompt_attr() { + let attr = args_prompt_prompt_attr(); + assert_eq!(attr.name, "args_prompt"); + + let args = attr.arguments.as_ref().unwrap(); + assert_eq!(args.len(), 2); + + // Check input field + let input_arg = args.iter().find(|a| a.name == "input").unwrap(); + assert_eq!(input_arg.required, Some(true)); + assert_eq!( + input_arg.description.as_deref(), + Some("The input text to process") + ); + + // Check config field + let config_arg = args.iter().find(|a| a.name == "config").unwrap(); + assert_eq!(config_arg.required, Some(false)); + assert_eq!( + config_arg.description.as_deref(), + Some("Optional configuration") + ); +} + +#[test] +fn test_complex_args_prompt_attr() { + let attr = complex_args_prompt_prompt_attr(); + assert_eq!(attr.name, "complex_args_prompt"); + + let args = attr.arguments.as_ref().unwrap(); + assert_eq!(args.len(), 4); + + // Check required_field + let required_arg = args.iter().find(|a| a.name == "required_field").unwrap(); + assert_eq!(required_arg.required, Some(true)); + assert_eq!(required_arg.description.as_deref(), Some("Required field")); + + // Check optional_string + let optional_string_arg = args.iter().find(|a| a.name == "optional_string").unwrap(); + assert_eq!(optional_string_arg.required, Some(false)); + assert_eq!( + optional_string_arg.description.as_deref(), + Some("An optional string parameter") + ); + + // Check optional_number + let optional_number_arg = args.iter().find(|a| a.name == "optional_number").unwrap(); + assert_eq!(optional_number_arg.required, Some(false)); + assert_eq!( + optional_number_arg.description.as_deref(), + Some("Optional number field") + ); + + // Check items + let items_arg = args.iter().find(|a| a.name == "items").unwrap(); + assert_eq!(items_arg.required, Some(true)); + assert_eq!(items_arg.description.as_deref(), Some("Array field")); +} + +#[test] +fn test_sync_prompt_attr() { + let attr = sync_prompt_prompt_attr(); + assert_eq!(attr.name, "sync_prompt"); + assert!(attr.arguments.is_none()); +} + +#[test] +fn test_prompt_attr_function_type() { + // Test that the generated function returns the correct type + fn assert_prompt_attr_fn(_: impl Fn() -> Prompt) {} + + assert_prompt_attr_fn(basic_prompt_prompt_attr); + assert_prompt_attr_fn(named_prompt_prompt_attr); + assert_prompt_attr_fn(described_prompt_prompt_attr); + assert_prompt_attr_fn(fully_custom_prompt_prompt_attr); + assert_prompt_attr_fn(doc_comment_prompt_prompt_attr); + assert_prompt_attr_fn(override_doc_prompt_prompt_attr); + assert_prompt_attr_fn(args_prompt_prompt_attr); + assert_prompt_attr_fn(complex_args_prompt_prompt_attr); + assert_prompt_attr_fn(sync_prompt_prompt_attr); +} + +// Test generic prompts +#[derive(Debug, Clone)] +struct GenericServer { + _marker: std::marker::PhantomData, +} + +impl ServerHandler for GenericServer {} + +#[prompt] +async fn generic_prompt( + _server: &GenericServer, +) -> Vec { + vec![PromptMessage::new_text(Role::Assistant, "Generic response")] +} + +#[test] +fn test_generic_prompt_attr() { + let attr = generic_prompt_prompt_attr(); + assert_eq!(attr.name, "generic_prompt"); + assert!(attr.arguments.is_none()); +} diff --git a/vendor/rmcp/tests/test_prompt_macros.rs b/vendor/rmcp/tests/test_prompt_macros.rs new file mode 100644 index 00000000..1ee86454 --- /dev/null +++ b/vendor/rmcp/tests/test_prompt_macros.rs @@ -0,0 +1,389 @@ +#![cfg(not(feature = "local"))] +//cargo test --test test_prompt_macros --features "client server" +#![allow(dead_code)] +use std::sync::Arc; + +use rmcp::{ + ClientHandler, ServerHandler, ServiceExt, + handler::server::{router::prompt::PromptRouter, wrapper::Parameters}, + model::{ + ClientConfig, ContentBlock, GetPromptRequestParams, GetPromptResult, PromptMessage, Role, + }, + prompt, prompt_handler, prompt_router, +}; +use schemars::JsonSchema; +use serde::{Deserialize, Serialize}; + +#[derive(Serialize, Deserialize, JsonSchema)] +struct CodeReviewRequest { + file_path: String, + language: String, +} + +#[prompt_handler(router = self.prompt_router)] +impl ServerHandler for Server {} + +#[derive(Debug, Clone)] +#[allow(dead_code)] +pub struct Server { + prompt_router: PromptRouter, +} + +impl Default for Server { + fn default() -> Self { + Self::new() + } +} + +#[prompt_router] +impl Server { + pub fn new() -> Self { + Self { + prompt_router: Self::prompt_router(), + } + } + + /// This prompt is used to review code for best practices. + #[prompt( + name = "code-review", + description = "Review code for best practices and issues." + )] + pub async fn code_review(&self, params: Parameters) -> Vec { + vec![ + PromptMessage::new_text( + Role::User, + format!( + "Please review the {} code in: {}", + params.0.language, params.0.file_path + ), + ), + PromptMessage::new_text( + Role::Assistant, + "I'll review this code for best practices and potential issues.".to_string(), + ), + ] + } + + #[prompt] + async fn empty_param(&self) -> Vec { + vec![PromptMessage::new_text( + Role::Assistant, + "This is a prompt with no parameters.".to_string(), + )] + } + + #[prompt(description = CONST_PROMPT_DESCRIPTION)] + async fn const_description_prompt(&self) -> Vec { + vec![] + } +} + +const CONST_PROMPT_DESCRIPTION: &str = "Prompt description from a const"; + +// define generic service trait +pub trait DataService: Send + Sync + 'static { + fn get_context(&self) -> String; +} + +// mock service for test +#[derive(Clone)] +struct MockDataService; +impl DataService for MockDataService { + fn get_context(&self) -> String { + "mock context data".to_string() + } +} + +// define generic server +#[derive(Debug, Clone)] +pub struct GenericServer { + data_service: Arc, + prompt_router: PromptRouter, +} + +#[prompt_router] +impl GenericServer { + pub fn new(data_service: DS) -> Self { + Self { + data_service: Arc::new(data_service), + prompt_router: Self::prompt_router(), + } + } + + #[prompt(description = "Get contextual help from the service")] + async fn get_help(&self) -> GetPromptResult { + let context = self.data_service.get_context(); + GetPromptResult::new(vec![ + PromptMessage::new_text( + Role::User, + "I need help with the current context.".to_string(), + ), + PromptMessage::new_text( + Role::Assistant, + format!( + "Based on the context '{}', here's how I can help...", + context + ), + ), + ]) + .with_description("Contextual help based on service data") + } +} + +#[prompt_handler] +impl ServerHandler for GenericServer {} + +#[tokio::test] +async fn test_prompt_macros() { + let server = Server::new(); + let _attr = Server::code_review_prompt_attr(); + let _code_review_prompt_attr_fn = Server::code_review_prompt_attr; + let _code_review_fn = Server::code_review; + let result = server + .code_review(Parameters(CodeReviewRequest { + file_path: "/src/main.rs".into(), + language: "rust".into(), + })) + .await; + assert_eq!(result.len(), 2); + assert_eq!(result[0].role, Role::User); + assert_eq!(result[1].role, Role::Assistant); +} + +#[tokio::test] +async fn test_prompt_macros_with_empty_param() { + let _attr = Server::empty_param_prompt_attr(); + println!("{_attr:?}"); + assert!( + _attr.arguments.is_none(), + "Empty param prompt should have no arguments" + ); +} + +#[test] +fn test_prompt_description_accepts_const_expr() { + let prompt = Server::const_description_prompt_prompt_attr(); + assert_eq!( + prompt.description.as_deref(), + Some(CONST_PROMPT_DESCRIPTION) + ); +} + +#[tokio::test] +async fn test_prompt_macros_with_generics() { + let mock_service = MockDataService; + let server = GenericServer::new(mock_service); + let _attr = GenericServer::::get_help_prompt_attr(); + let _get_help_call_fn = GenericServer::::get_help; + let _get_help_fn = GenericServer::::get_help; + let result = server.get_help().await; + assert!(result.description.is_some()); + assert_eq!(result.messages.len(), 2); + match &result.messages[1].content { + ContentBlock::Text(text_content) => { + assert!(text_content.text.contains("mock context data")); + } + _ => panic!("Expected text content"), + } +} + +#[tokio::test] +async fn test_prompt_macros_with_optional_param() { + let _attr = Server::code_review_prompt_attr(); + let arguments = _attr.arguments.as_ref().unwrap(); + + // Check that we have the expected number of arguments + assert_eq!(arguments.len(), 2); + + // Verify file_path is required + let file_path_arg = arguments.iter().find(|a| a.name == "file_path").unwrap(); + assert_eq!(file_path_arg.required, Some(true)); + + // Verify language is required + let language_arg = arguments.iter().find(|a| a.name == "language").unwrap(); + assert_eq!(language_arg.required, Some(true)); +} + +impl CodeReviewRequest {} + +// Struct defined for testing optional field schema generation +#[derive(Debug, Deserialize, Serialize, JsonSchema)] +struct OptionalFieldTestSchema { + #[schemars(description = "An optional description field")] + description: Option, +} + +// Struct defined for testing optional i64 field schema generation and null handling +#[derive(Debug, Deserialize, Serialize, JsonSchema)] +struct OptionalI64TestSchema { + #[schemars(description = "An optional i64 field")] + count: Option, + mandatory_field: String, // Added to ensure non-empty object schema +} + +// Dummy struct to host the test prompt method +#[derive(Debug, Clone)] +pub struct OptionalSchemaTester { + prompt_router: PromptRouter, +} + +impl Default for OptionalSchemaTester { + fn default() -> Self { + Self::new() + } +} + +impl OptionalSchemaTester { + pub fn new() -> Self { + Self { + prompt_router: Self::prompt_router(), + } + } +} + +#[prompt_router] +impl OptionalSchemaTester { + // Dummy prompt function using the test schema as an aggregated parameter + #[prompt(description = "A prompt to test optional schema generation")] + async fn test_optional(&self, _req: Parameters) -> Vec { + vec![PromptMessage::new_text( + Role::Assistant, + "Testing optional fields".to_string(), + )] + } + + // Prompt function to test optional i64 handling + #[prompt(description = "A prompt to test optional i64 schema generation")] + async fn test_optional_i64( + &self, + Parameters(req): Parameters, + ) -> GetPromptResult { + let message = match req.count { + Some(c) => format!("Received count: {}", c), + None => "Received null count".to_string(), + }; + + GetPromptResult::new(vec![PromptMessage::new_text(Role::Assistant, message)]) + .with_description("Test result for optional i64") + } +} + +#[prompt_handler] +// Implement ServerHandler to route prompt calls for OptionalSchemaTester +impl ServerHandler for OptionalSchemaTester {} + +#[test] +fn test_optional_field_schema_generation_via_macro() { + // tests https://github.com/modelcontextprotocol/rust-sdk/issues/135 + + // Get the attributes generated by the #[prompt] macro helper + let prompt_attr = OptionalSchemaTester::test_optional_prompt_attr(); + + // Print the actual generated schema for debugging + println!( + "Actual arguments generated by macro: {:#?}", + prompt_attr.arguments + ); + + // Verify the schema generated for the aggregated OptionalFieldTestSchema + let arguments = prompt_attr.arguments.expect("Should have arguments"); + + // Check that we have an argument for the optional description field + let description_arg = arguments + .iter() + .find(|arg| arg.name == "description") + .expect("Should have description argument"); + + // Assert that optional fields are marked as not required + assert_eq!( + description_arg.required, + Some(false), + "Optional fields should be marked as not required" + ); + + // Check the description is correct + assert_eq!( + description_arg.description.as_deref(), + Some("An optional description field") + ); +} + +// Define a dummy client handler +#[derive(Debug, Clone, Default)] +struct DummyClientHandler {} + +impl ClientHandler for DummyClientHandler { + fn get_info(&self) -> ClientConfig { + ClientConfig::default() + } +} + +#[tokio::test] +async fn test_optional_i64_field_with_null_input() -> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(4096); + + // Server setup + let server = OptionalSchemaTester::new(); + let server_handle = tokio::spawn(async move { + server.serve(server_transport).await?.waiting().await?; + anyhow::Ok(()) + }); + + // Create a simple client handler that just forwards prompt calls + let client_handler = DummyClientHandler::default(); + let client = client_handler.serve(client_transport).await?; + + // Test null case + let result = client + .get_prompt( + GetPromptRequestParams::new("test_optional_i64").with_arguments( + serde_json::json!({ + "count": null, + "mandatory_field": "test_null" + }) + .as_object() + .unwrap() + .clone(), + ), + ) + .await?; + + let result_text = match &result.messages.first().unwrap().content { + ContentBlock::Text(text_content) => text_content.text.as_str(), + _ => panic!("Expected text content"), + }; + + assert_eq!( + result_text, "Received null count", + "Null case should return expected message" + ); + + // Test Some case + let some_result = client + .get_prompt( + GetPromptRequestParams::new("test_optional_i64").with_arguments( + serde_json::json!({ + "count": 42, + "mandatory_field": "test_some" + }) + .as_object() + .unwrap() + .clone(), + ), + ) + .await?; + + let some_result_text = match &some_result.messages.first().unwrap().content { + ContentBlock::Text(text_content) => text_content.text.as_str(), + _ => panic!("Expected text content"), + }; + + assert_eq!( + some_result_text, "Received count: 42", + "Some case should return expected message" + ); + + client.cancel().await?; + server_handle.await??; + Ok(()) +} diff --git a/vendor/rmcp/tests/test_prompt_routers.rs b/vendor/rmcp/tests/test_prompt_routers.rs new file mode 100644 index 00000000..e7305794 --- /dev/null +++ b/vendor/rmcp/tests/test_prompt_routers.rs @@ -0,0 +1,134 @@ +#![cfg(not(feature = "local"))] +use std::collections::HashMap; + +use futures::future::BoxFuture; +use rmcp::{ + ServerHandler, + handler::server::wrapper::Parameters, + model::{GetPromptResult, PromptMessage, Role}, +}; + +#[derive(Debug, Default)] +struct TestHandler { + _marker: std::marker::PhantomData, +} + +impl ServerHandler for TestHandler {} + +#[derive(Debug, schemars::JsonSchema, serde::Deserialize, serde::Serialize)] +struct Request { + fields: HashMap, +} + +#[rmcp::prompt_router(router = "test_router")] +impl TestHandler { + #[rmcp::prompt] + async fn async_method( + &self, + Parameters(Request { fields }): Parameters, + ) -> Vec { + drop(fields); + vec![PromptMessage::new_text( + Role::Assistant, + "Async method response", + )] + } + + #[rmcp::prompt] + fn sync_method( + &self, + Parameters(Request { fields }): Parameters, + ) -> Vec { + drop(fields); + vec![PromptMessage::new_text( + Role::Assistant, + "Sync method response", + )] + } +} + +#[rmcp::prompt] +async fn async_function(Parameters(Request { fields }): Parameters) -> Vec { + drop(fields); + vec![PromptMessage::new_text( + Role::Assistant, + "Async function response", + )] +} + +#[rmcp::prompt] +fn async_function2(_callee: &TestHandler) -> BoxFuture<'_, GetPromptResult> { + Box::pin(async move { + GetPromptResult::new(vec![PromptMessage::new_text( + Role::Assistant, + "Async function 2 response", + )]) + .with_description("Async function 2") + }) +} + +#[test] +fn test_prompt_router() { + let test_prompt_router = TestHandler::<()>::test_router() + .with_route(rmcp::handler::server::router::prompt::PromptRoute::new_dyn( + async_function_prompt_attr(), + |mut context| { + Box::pin(async move { + use rmcp::handler::server::{ + common::FromContextPart, prompt::IntoGetPromptResult, + }; + let params = Parameters::::from_context_part(&mut context)?; + let result = async_function(params).await; + result.into_get_prompt_result() + }) + }, + )) + .with_route(rmcp::handler::server::router::prompt::PromptRoute::new_dyn( + async_function2_prompt_attr(), + |context| { + Box::pin(async move { + use rmcp::handler::server::prompt::IntoGetPromptResult; + let result = async_function2(context.server).await; + result.into_get_prompt_result() + }) + }, + )); + let prompts = test_prompt_router.list_all(); + assert_eq!(prompts.len(), 4); +} + +#[test] +fn test_prompt_router_list_all_is_sorted() { + let router = TestHandler::<()>::test_router() + .with_route(rmcp::handler::server::router::prompt::PromptRoute::new_dyn( + async_function_prompt_attr(), + |mut context| { + Box::pin(async move { + use rmcp::handler::server::{ + common::FromContextPart, prompt::IntoGetPromptResult, + }; + let params = Parameters::::from_context_part(&mut context)?; + let result = async_function(params).await; + result.into_get_prompt_result() + }) + }, + )) + .with_route(rmcp::handler::server::router::prompt::PromptRoute::new_dyn( + async_function2_prompt_attr(), + |context| { + Box::pin(async move { + use rmcp::handler::server::prompt::IntoGetPromptResult; + let result = async_function2(context.server).await; + result.into_get_prompt_result() + }) + }, + )); + let prompts = router.list_all(); + let names: Vec<&str> = prompts.iter().map(|p| p.name.as_ref()).collect(); + let mut sorted = names.clone(); + sorted.sort(); + assert_eq!( + names, sorted, + "list_all() should return prompts sorted alphabetically by name" + ); +} diff --git a/vendor/rmcp/tests/test_protocol_version_negotiation.rs b/vendor/rmcp/tests/test_protocol_version_negotiation.rs new file mode 100644 index 00000000..86894e73 --- /dev/null +++ b/vendor/rmcp/tests/test_protocol_version_negotiation.rs @@ -0,0 +1,330 @@ +//! Tests for protocol version negotiation in the default ServerHandler::initialize impl. +//! +//! Handshake versions are echoed back; every other version falls back to one +//! the server can serve over `initialize`. +#![cfg(not(feature = "local"))] +#![cfg(feature = "client")] + +use std::{ + borrow::Cow, + sync::{ + Arc, + atomic::{AtomicUsize, Ordering}, + }, +}; + +use rmcp::{ + ClientHandler, ErrorData, RoleServer, ServerHandler, ServiceExt, + model::{ + ClientCapabilities, ClientConfig, ErrorCode, Implementation, InitializeRequestParams, + InitializeResult, ProtocolVersion, ServerConfig, + }, + service::{ClientInitializeError, RequestContext}, +}; + +#[derive(Debug, Clone, Default)] +struct EchoServer; + +impl ServerHandler for EchoServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::default() + } +} + +/// Every known version whose lifecycle still runs the `initialize` handshake. +/// [`ProtocolVersion::NO_INITIALIZE`] replaced the handshake with per-request +/// metadata, so this is also the list a server that has not implemented that +/// revision supports. +const HANDSHAKE_VERSIONS: &[ProtocolVersion] = &[ + ProtocolVersion::V_2024_11_05, + ProtocolVersion::V_2025_03_26, + ProtocolVersion::V_2025_06_18, + ProtocolVersion::V_2025_11_25, +]; + +#[derive(Debug, Clone, Default)] +struct NarrowedServer; + +impl ServerHandler for NarrowedServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::default() + } + + fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]> { + Cow::Borrowed(HANDSHAKE_VERSIONS) + } +} + +/// Supports only revisions that have no `initialize` handshake at all. +#[derive(Debug, Clone, Default)] +struct ModernOnlyServer; + +const MODERN_ONLY_VERSIONS: &[ProtocolVersion] = &[ProtocolVersion::V_2026_07_28]; + +impl ServerHandler for ModernOnlyServer { + fn get_info(&self) -> ServerConfig { + let mut info = ServerConfig::default(); + info.protocol_version = ProtocolVersion::V_2026_07_28; + info + } + + fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]> { + Cow::Borrowed(MODERN_ONLY_VERSIONS) + } +} + +/// Narrows the supported versions *and* overrides `initialize`, so the +/// handler's own answer never runs the default negotiation. The handshake layer +/// must still honor the narrowed list. +#[derive(Debug, Clone, Default)] +struct NarrowedOverridingServer; + +impl ServerHandler for NarrowedOverridingServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::default() + } + + fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]> { + Cow::Borrowed(HANDSHAKE_VERSIONS) + } + + async fn initialize( + &self, + _request: InitializeRequestParams, + _context: RequestContext, + ) -> Result { + Ok(self.get_info()) + } +} + +#[derive(Debug, Clone)] +struct VersionedClient { + protocol_version: ProtocolVersion, +} + +impl ClientHandler for VersionedClient { + fn get_info(&self) -> ClientConfig { + let mut info = ClientConfig::default(); + info.protocol_version = self.protocol_version.clone(); + info + } +} + +async fn negotiated_version(client_version: ProtocolVersion) -> ProtocolVersion { + negotiated_version_with(EchoServer, client_version).await +} + +async fn negotiated_version_with( + server: S, + client_version: ProtocolVersion, +) -> ProtocolVersion { + negotiate_with(server, client_version) + .await + .expect("client should connect") +} + +async fn negotiate_with( + server: S, + client_version: ProtocolVersion, +) -> Result { + let (server_transport, client_transport) = tokio::io::duplex(4096); + + tokio::spawn(async move { + if let Ok(running) = server.serve(server_transport).await { + let _ = running.waiting().await; + } + }); + + let client = VersionedClient { + protocol_version: client_version, + } + .serve(client_transport) + .await?; + + let version = client + .peer_info() + .expect("peer_info should be set") + .protocol_version + .clone(); + + client.cancel().await.expect("client should cancel"); + Ok(version) +} + +#[tokio::test] +async fn handshake_version_echoed_back() { + for version in HANDSHAKE_VERSIONS { + let negotiated = negotiated_version(version.clone()).await; + assert_eq!( + negotiated, *version, + "handshake version {version} should be echoed back" + ); + } +} + +/// `initialize` disappeared in `2026-07-28`, so agreeing to it here would leave +/// the peers speaking a revision that has no handshake at all. +#[tokio::test] +async fn handshake_never_agrees_to_a_version_that_dropped_it() { + let negotiated = negotiated_version(ProtocolVersion::V_2026_07_28).await; + assert_eq!( + negotiated, + ProtocolVersion::LATEST_WITH_INITIALIZE, + "a version that dropped the handshake should fall back to the server's newest handshake version" + ); +} + +#[tokio::test] +async fn modern_only_server_rejects_the_handshake() { + let error = negotiate_with(ModernOnlyServer, ProtocolVersion::V_2026_07_28) + .await + .expect_err("a server with no handshake version cannot answer initialize"); + let ClientInitializeError::JsonRpcError(error) = error else { + panic!("expected a JSON-RPC error, got {error:?}"); + }; + assert_eq!( + error.code, + ErrorCode::UNSUPPORTED_PROTOCOL_VERSION, + "a server with no handshake version should reject initialize" + ); + assert_eq!( + error.data, + Some(serde_json::json!({ + "requested": "2026-07-28", + "supported": ["2026-07-28"], + })), + "the rejection should name the versions the server does support" + ); +} + +#[tokio::test] +async fn unknown_version_falls_back_to_newest_handshake_version() { + let unknown: ProtocolVersion = + serde_json::from_str(r#""1999-01-01""#).expect("version literal should deserialize"); + let negotiated = negotiated_version(unknown).await; + assert_eq!( + negotiated, + ProtocolVersion::LATEST_WITH_INITIALIZE, + "unknown version should fall back to the newest handshake version" + ); +} + +#[tokio::test] +async fn narrowed_server_still_echoes_versions_it_supports() { + for version in HANDSHAKE_VERSIONS { + let negotiated = negotiated_version_with(NarrowedServer, version.clone()).await; + assert_eq!( + negotiated, *version, + "supported version {version} should be echoed back" + ); + } +} + +#[tokio::test] +async fn narrowed_server_does_not_agree_to_version_it_excludes() { + let negotiated = negotiated_version_with(NarrowedServer, ProtocolVersion::V_2026_07_28).await; + assert_eq!( + negotiated, + ProtocolVersion::V_2025_11_25, + "a version outside supported_protocol_versions should not be echoed back" + ); +} + +#[tokio::test] +async fn narrowed_server_caps_even_when_it_overrides_initialize() { + let negotiated = + negotiated_version_with(NarrowedOverridingServer, ProtocolVersion::V_2026_07_28).await; + assert_eq!( + negotiated, + ProtocolVersion::V_2025_11_25, + "the handshake layer should not raise the version above what the server supports" + ); +} + +/// Overrides `initialize` to run a side effect, then delegates the version +/// answer back to the SDK with [`ServerHandler::negotiate_initialize`]. +#[derive(Debug, Clone, Default)] +struct DelegatingServer { + initializations: Arc, +} + +impl ServerHandler for DelegatingServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::default() + } + + fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]> { + Cow::Borrowed(HANDSHAKE_VERSIONS) + } + + async fn initialize( + &self, + request: InitializeRequestParams, + context: RequestContext, + ) -> Result { + self.initializations.fetch_add(1, Ordering::Relaxed); + context.peer.set_peer_info(request.clone()); + self.negotiate_initialize(&request) + } +} + +fn initialize_params(protocol_version: ProtocolVersion) -> InitializeRequestParams { + let mut params = InitializeRequestParams::new( + ClientCapabilities::default(), + Implementation::new("test-client", "0.0.0"), + ); + params.protocol_version = protocol_version; + params +} + +#[test] +fn negotiate_initialize_echoes_a_supported_version() { + let result = NarrowedServer + .negotiate_initialize(&initialize_params(ProtocolVersion::V_2025_06_18)) + .expect("a supported handshake version should negotiate"); + assert_eq!(result.protocol_version, ProtocolVersion::V_2025_06_18); +} + +#[test] +fn negotiate_initialize_caps_at_supported_versions() { + let result = NarrowedServer + .negotiate_initialize(&initialize_params(ProtocolVersion::V_2026_07_28)) + .expect("an unsupported version should fall back rather than fail"); + assert_eq!(result.protocol_version, ProtocolVersion::V_2025_11_25); +} + +#[test] +fn negotiate_initialize_keeps_the_rest_of_get_info() { + let server = NarrowedServer; + let result = server + .negotiate_initialize(&initialize_params(ProtocolVersion::V_2026_07_28)) + .expect("an unsupported version should fall back rather than fail"); + assert_eq!(result.capabilities, server.get_info().capabilities); +} + +#[test] +fn negotiate_initialize_rejects_when_no_handshake_version_is_supported() { + let error = ModernOnlyServer + .negotiate_initialize(&initialize_params(ProtocolVersion::V_2026_07_28)) + .expect_err("a server with no handshake version cannot answer initialize"); + assert_eq!(error.code, ErrorCode::UNSUPPORTED_PROTOCOL_VERSION); +} + +#[tokio::test] +async fn delegating_server_negotiates_like_the_default_initialize() { + let negotiated = + negotiated_version_with(DelegatingServer::default(), ProtocolVersion::V_2026_07_28).await; + assert_eq!( + negotiated, + ProtocolVersion::V_2025_11_25, + "an override that delegates should answer what the default initialize would" + ); +} + +#[tokio::test] +async fn delegating_server_still_runs_its_own_side_effect() { + let server = DelegatingServer::default(); + let initializations = Arc::clone(&server.initializations); + negotiated_version_with(server, ProtocolVersion::V_2025_06_18).await; + assert_eq!(initializations.load(Ordering::Relaxed), 1); +} diff --git a/vendor/rmcp/tests/test_request_timeout_progress.rs b/vendor/rmcp/tests/test_request_timeout_progress.rs new file mode 100644 index 00000000..f37101f8 --- /dev/null +++ b/vendor/rmcp/tests/test_request_timeout_progress.rs @@ -0,0 +1,214 @@ +#![cfg(not(feature = "local"))] + +use std::{ + sync::{ + Arc, + atomic::{AtomicUsize, Ordering}, + }, + time::Duration, +}; + +use rmcp::{ + ClientHandler, Peer, RoleServer, ServiceError, ServiceExt, + model::{ + CallToolRequestParams, ClientRequest, NumberOrString, ProgressNotificationParam, + ProgressToken, Request, RequestMetaObject, + }, + service::PeerRequestOptions, + tool, tool_router, +}; + +#[derive(Clone, Default)] +struct ProgressCountingClient { + progress_count: Arc, +} + +impl ClientHandler for ProgressCountingClient { + async fn on_progress( + &self, + _params: ProgressNotificationParam, + _context: rmcp::service::NotificationContext, + ) { + self.progress_count.fetch_add(1, Ordering::SeqCst); + } +} + +struct ProgressTimeoutServer; + +#[tool_router(server_handler)] +impl ProgressTimeoutServer { + #[tool] + async fn delayed_without_progress(&self) -> Result<(), rmcp::ErrorData> { + tokio::time::sleep(Duration::from_millis(250)).await; + Ok(()) + } + + #[tool] + async fn delayed_with_progress( + &self, + meta: RequestMetaObject, + client: Peer, + ) -> Result<(), rmcp::ErrorData> { + let progress_token = meta + .get_progress_token() + .ok_or(rmcp::ErrorData::invalid_params( + "Progress token is required", + None, + ))?; + + for step in 0..4 { + tokio::time::sleep(Duration::from_millis(50)).await; + let _ = client + .notify_progress( + ProgressNotificationParam::new(progress_token.clone(), step as f64) + .with_total(4.0) + .with_message("working"), + ) + .await; + } + + Ok(()) + } + + #[tool] + async fn delayed_with_unrelated_progress( + &self, + client: Peer, + ) -> Result<(), rmcp::ErrorData> { + for step in 0..4 { + tokio::time::sleep(Duration::from_millis(50)).await; + let _ = client + .notify_progress( + ProgressNotificationParam::new( + ProgressToken(NumberOrString::Number(999_999)), + step as f64, + ) + .with_total(4.0) + .with_message("unrelated"), + ) + .await; + } + + Ok(()) + } +} + +async fn start_pair() +-> anyhow::Result> { + let server = ProgressTimeoutServer; + let client = ProgressCountingClient::default(); + let (transport_server, transport_client) = tokio::io::duplex(4096); + + tokio::spawn(async move { + let service = server.serve(transport_server).await?; + service.waiting().await?; + anyhow::Ok(()) + }); + + Ok(client.serve(transport_client).await?) +} + +async fn call_tool_with_options( + client: &rmcp::service::RunningService, + name: &str, + options: PeerRequestOptions, +) -> Result { + client + .send_request_with_option( + ClientRequest::CallToolRequest(Request::new(CallToolRequestParams::new( + name.to_owned(), + ))), + options, + ) + .await? + .await_response() + .await +} + +#[tokio::test] +async fn request_timeout_still_expires_without_progress() -> anyhow::Result<()> { + let client = start_pair().await?; + let result = call_tool_with_options( + &client, + "delayed_without_progress", + PeerRequestOptions::with_timeout(Duration::from_millis(75)), + ) + .await; + + assert!(matches!(result, Err(ServiceError::Timeout { .. }))); + Ok(()) +} + +#[tokio::test] +async fn progress_does_not_reset_timeout_by_default() -> anyhow::Result<()> { + let client = start_pair().await?; + let result = call_tool_with_options( + &client, + "delayed_with_progress", + PeerRequestOptions::with_timeout(Duration::from_millis(75)), + ) + .await; + + assert!(matches!(result, Err(ServiceError::Timeout { .. }))); + Ok(()) +} + +#[tokio::test] +async fn matching_progress_resets_timeout_when_enabled() -> anyhow::Result<()> { + let client = start_pair().await?; + let result = call_tool_with_options( + &client, + "delayed_with_progress", + PeerRequestOptions::with_timeout(Duration::from_millis(75)).reset_timeout_on_progress(), + ) + .await; + + assert!(result.is_ok()); + assert!(client.service().progress_count.load(Ordering::SeqCst) > 0); + Ok(()) +} + +#[tokio::test] +async fn generated_progress_token_overrides_option_meta_token() -> anyhow::Result<()> { + let client = start_pair().await?; + let mut options = + PeerRequestOptions::with_timeout(Duration::from_millis(75)).reset_timeout_on_progress(); + options.meta = Some(RequestMetaObject::with_progress_token(ProgressToken( + NumberOrString::Number(999_999), + ))); + + let result = call_tool_with_options(&client, "delayed_with_progress", options).await; + + assert!(result.is_ok()); + Ok(()) +} + +#[tokio::test] +async fn max_total_timeout_wins_over_progress_reset() -> anyhow::Result<()> { + let client = start_pair().await?; + let result = call_tool_with_options( + &client, + "delayed_with_progress", + PeerRequestOptions::with_timeout(Duration::from_millis(75)) + .reset_timeout_on_progress() + .with_max_total_timeout(Duration::from_millis(125)), + ) + .await; + + assert!(matches!(result, Err(ServiceError::Timeout { .. }))); + Ok(()) +} + +#[tokio::test] +async fn unrelated_progress_does_not_reset_timeout() -> anyhow::Result<()> { + let client = start_pair().await?; + let result = call_tool_with_options( + &client, + "delayed_with_unrelated_progress", + PeerRequestOptions::with_timeout(Duration::from_millis(75)).reset_timeout_on_progress(), + ) + .await; + + assert!(matches!(result, Err(ServiceError::Timeout { .. }))); + Ok(()) +} diff --git a/vendor/rmcp/tests/test_resource_link.rs b/vendor/rmcp/tests/test_resource_link.rs new file mode 100644 index 00000000..7db5b06b --- /dev/null +++ b/vendor/rmcp/tests/test_resource_link.rs @@ -0,0 +1,86 @@ +use rmcp::model::{CallToolResult, ContentBlock, Resource}; + +#[test] +fn test_resource_link_in_tool_result() { + // Test creating a tool result with resource links + let resource = Resource::new("file:///test/file.txt", "test.txt"); + + // Create a tool result with a resource link + let result = CallToolResult::success(vec![ + ContentBlock::text("Found a file"), + ContentBlock::resource_link(resource), + ]); + + // Serialize to JSON to verify format + let json = serde_json::to_string_pretty(&result).unwrap(); + println!("Tool result with resource link:\n{}", json); + + // Verify JSON contains expected structure + assert!( + json.contains("\"type\":\"resource_link\"") || json.contains("\"type\": \"resource_link\"") + ); + assert!( + json.contains("\"uri\":\"file:///test/file.txt\"") + || json.contains("\"uri\": \"file:///test/file.txt\"") + ); + assert!(json.contains("\"name\":\"test.txt\"") || json.contains("\"name\": \"test.txt\"")); + + // Test deserialization + let deserialized: CallToolResult = serde_json::from_str(&json).unwrap(); + assert_eq!(deserialized.content.len(), 2); + + // Check the text content + assert!(deserialized.content[0].as_text().is_some()); + + // Check the resource link + let resource_link = deserialized.content[1] + .as_resource_link() + .expect("Expected resource link in content[1]"); + assert_eq!(resource_link.uri, "file:///test/file.txt"); + assert_eq!(resource_link.name, "test.txt"); +} + +#[test] +fn test_resource_link_with_full_metadata() { + let resource = Resource::new("https://example.com/data.json", "API Data") + .with_description("JSON data from external API") + .with_mime_type("application/json") + .with_size(1024); + + let result = CallToolResult::success(vec![ContentBlock::resource_link(resource)]); + + let json = serde_json::to_string(&result).unwrap(); + let deserialized: CallToolResult = serde_json::from_str(&json).unwrap(); + + let resource_link = deserialized.content[0] + .as_resource_link() + .expect("Expected resource link"); + assert_eq!(resource_link.uri, "https://example.com/data.json"); + assert_eq!(resource_link.name, "API Data"); + assert_eq!( + resource_link.description, + Some("JSON data from external API".to_string()) + ); + assert_eq!( + resource_link.mime_type, + Some("application/json".to_string()) + ); + assert_eq!(resource_link.size, Some(1024)); +} + +#[test] +fn test_mixed_content_types() { + // Test that resource links can be mixed with other content types + let resource = Resource::new("file:///doc.pdf", "Document"); + + let result = CallToolResult::success(vec![ + ContentBlock::text("Processing complete"), + ContentBlock::resource_link(resource), + ContentBlock::embedded_text("memo://result", "Analysis results here"), + ]); + + assert_eq!(result.content.len(), 3); + assert!(result.content[0].as_text().is_some()); + assert!(result.content[1].as_resource_link().is_some()); + assert!(result.content[2].as_resource().is_some()); +} diff --git a/vendor/rmcp/tests/test_resource_link_integration.rs b/vendor/rmcp/tests/test_resource_link_integration.rs new file mode 100644 index 00000000..2cc68728 --- /dev/null +++ b/vendor/rmcp/tests/test_resource_link_integration.rs @@ -0,0 +1,114 @@ +/// Integration tests for resource_link support in both tools and prompts +use rmcp::model::{CallToolResult, ContentBlock, PromptMessage, Resource, Role}; + +#[test] +fn test_tool_and_prompt_resource_link_compatibility() { + let resource = Resource::new("file:///shared/data.json", "Shared Data"); + + // Test 1: Tool returning a resource link + let tool_result = CallToolResult::success(vec![ + ContentBlock::text("Found shared data"), + ContentBlock::resource_link(resource.clone()), + ]); + + let tool_json = serde_json::to_string(&tool_result).unwrap(); + assert!(tool_json.contains("\"type\":\"resource_link\"")); + + // Test 2: Prompt returning a resource link + let prompt_message = PromptMessage::new_resource_link(Role::Assistant, resource.clone()); + + let prompt_json = serde_json::to_string(&prompt_message).unwrap(); + assert!(prompt_json.contains("\"type\":\"resource_link\"")); + + // Test 3: Verify both serialize to the same resource link structure + let tool_content = &tool_result.content[1]; + let prompt_content = &prompt_message.content; + + let tool_resource_json = serde_json::to_value(tool_content).unwrap(); + let prompt_resource_json = serde_json::to_value(prompt_content).unwrap(); + + assert_eq!( + tool_resource_json.get("type").unwrap(), + prompt_resource_json.get("type").unwrap() + ); + assert_eq!( + tool_resource_json.get("uri").unwrap(), + prompt_resource_json.get("uri").unwrap() + ); + assert_eq!( + tool_resource_json.get("name").unwrap(), + prompt_resource_json.get("name").unwrap() + ); +} + +#[test] +fn test_resource_link_roundtrip() { + let resource = Resource::new("https://api.example.com/resource", "API Resource") + .with_description("External API resource") + .with_mime_type("application/json") + .with_size(2048); + + // Test with tool result + let tool_result = CallToolResult::success(vec![ContentBlock::resource_link(resource.clone())]); + + let tool_json = serde_json::to_string(&tool_result).unwrap(); + let tool_deserialized: CallToolResult = serde_json::from_str(&tool_json).unwrap(); + + if let Some(resource_link) = tool_deserialized.content[0].as_resource_link() { + assert_eq!(resource_link.uri, "https://api.example.com/resource"); + assert_eq!(resource_link.name, "API Resource"); + assert_eq!( + resource_link.description, + Some("External API resource".to_string()) + ); + assert_eq!( + resource_link.mime_type, + Some("application/json".to_string()) + ); + assert_eq!(resource_link.size, Some(2048)); + } else { + panic!("Expected resource link in tool result"); + } + + // Test with prompt message + let prompt_message = PromptMessage::new(Role::User, ContentBlock::resource_link(resource)); + + let prompt_json = serde_json::to_string(&prompt_message).unwrap(); + let prompt_deserialized: PromptMessage = serde_json::from_str(&prompt_json).unwrap(); + + if let ContentBlock::ResourceLink(link) = &prompt_deserialized.content { + assert_eq!(link.uri, "https://api.example.com/resource"); + assert_eq!(link.name, "API Resource"); + assert_eq!(link.description, Some("External API resource".to_string())); + assert_eq!(link.mime_type, Some("application/json".to_string())); + assert_eq!(link.size, Some(2048)); + } else { + panic!("Expected resource link in prompt message"); + } +} + +#[test] +fn test_mixed_content_in_prompts_and_tools() { + let resource1 = Resource::new("file:///doc1.md", "Document 1"); + let resource2 = Resource::new("file:///doc2.md", "Document 2"); + + // Tool with mixed content + let tool_result = CallToolResult::success(vec![ + ContentBlock::text("Processing complete. Found documents:"), + ContentBlock::resource_link(resource1), + ContentBlock::resource_link(resource2), + ContentBlock::embedded_text("summary://result", "Both documents processed successfully"), + ]); + + assert_eq!(tool_result.content.len(), 4); + assert!(tool_result.content[0].as_text().is_some()); + assert!(tool_result.content[1].as_resource_link().is_some()); + assert!(tool_result.content[2].as_resource_link().is_some()); + assert!(tool_result.content[3].as_resource().is_some()); + + // Verify serialization includes all types + let json = serde_json::to_string(&tool_result).unwrap(); + assert!(json.contains("\"type\":\"text\"")); + assert!(json.contains("\"type\":\"resource_link\"")); + assert!(json.contains("\"type\":\"resource\"")); +} diff --git a/vendor/rmcp/tests/test_resource_not_found_version.rs b/vendor/rmcp/tests/test_resource_not_found_version.rs new file mode 100644 index 00000000..efae45fa --- /dev/null +++ b/vendor/rmcp/tests/test_resource_not_found_version.rs @@ -0,0 +1,100 @@ +//! SEP-2164: the resource-not-found error code follows the negotiated protocol version. +//! +//! `2026-07-28` and newer get the standard `INVALID_PARAMS` (-32602); older versions +//! keep the legacy `RESOURCE_NOT_FOUND` (-32002). +#![cfg(not(feature = "local"))] +#![cfg(feature = "client")] + +use rmcp::{ + ClientHandler, RoleClient, RoleServer, ServerHandler, ServiceError, + model::{ + ClientConfig, ErrorCode, ErrorData, InitializeResult, ProtocolVersion, + ReadResourceRequestParams, ReadResourceResponse, + }, + service::{RequestContext, serve_directly}, +}; + +#[derive(Debug, Clone, Default)] +struct ResourceServer; + +impl ServerHandler for ResourceServer { + async fn read_resource( + &self, + _request: ReadResourceRequestParams, + _context: RequestContext, + ) -> Result { + Err(ErrorData::resource_not_found("resource not found", None)) + } +} + +#[derive(Debug, Clone)] +struct VersionedClient { + protocol_version: ProtocolVersion, +} + +impl ClientHandler for VersionedClient { + fn get_info(&self) -> ClientConfig { + let mut info = ClientConfig::default(); + info.protocol_version = self.protocol_version.clone(); + info + } +} + +/// Wires the pair up directly on `client_version`. `2026-07-28` removed the +/// `initialize` handshake, so a peer on that revision is reached the way the +/// discover lifecycle leaves one: with the version already agreed. +async fn not_found_code(client_version: ProtocolVersion) -> ErrorCode { + let (server_transport, client_transport) = tokio::io::duplex(4096); + + let client_handler = VersionedClient { + protocol_version: client_version.clone(), + }; + let mut server_peer_info = InitializeResult::default(); + server_peer_info.protocol_version = client_version; + + let server = serve_directly::( + ResourceServer, + server_transport, + Some(client_handler.get_info()), + ); + let server_handle = tokio::spawn(async move { + server.waiting().await?; + anyhow::Ok(()) + }); + + let client = serve_directly::( + client_handler, + client_transport, + Some(server_peer_info.into()), + ); + + let error = client + .read_resource(ReadResourceRequestParams::new("missing://resource")) + .await + .expect_err("missing resource should error"); + + let code = match error { + ServiceError::McpError(data) => data.code, + other => panic!("expected McpError, got: {other:?}"), + }; + + client.cancel().await.expect("client should cancel"); + server_handle.await.expect("server task").expect("server"); + code +} + +#[tokio::test] +async fn legacy_version_gets_resource_not_found_code() { + assert_eq!( + not_found_code(ProtocolVersion::V_2025_11_25).await, + ErrorCode::RESOURCE_NOT_FOUND, + ); +} + +#[tokio::test] +async fn sep_2164_version_gets_invalid_params_code() { + assert_eq!( + not_found_code(ProtocolVersion::V_2026_07_28).await, + ErrorCode::INVALID_PARAMS, + ); +} diff --git a/vendor/rmcp/tests/test_result_type_version.rs b/vendor/rmcp/tests/test_result_type_version.rs new file mode 100644 index 00000000..61240ede --- /dev/null +++ b/vendor/rmcp/tests/test_result_type_version.rs @@ -0,0 +1,95 @@ +//! SEP-2322: the `resultType` discriminator follows the negotiated protocol version. +//! +//! Peers negotiating `2026-07-28` or newer receive `resultType: "complete"` on +//! ordinary results; older peers keep the legacy wire shape without the field. +#![cfg(not(feature = "local"))] +#![cfg(feature = "client")] + +use rmcp::{ + ClientHandler, RoleClient, RoleServer, ServerHandler, + model::{ + CallToolRequestParams, CallToolResponse, CallToolResult, ClientConfig, ContentBlock, + ErrorData, InitializeResult, ProtocolVersion, ResultType, + }, + service::{RequestContext, serve_directly}, +}; + +#[derive(Debug, Clone, Default)] +struct ToolServer; + +impl ServerHandler for ToolServer { + async fn call_tool( + &self, + _request: CallToolRequestParams, + _context: RequestContext, + ) -> Result { + Ok(CallToolResult::success(vec![ContentBlock::text("ok")]).into()) + } +} + +#[derive(Debug, Clone)] +struct VersionedClient { + protocol_version: ProtocolVersion, +} + +impl ClientHandler for VersionedClient { + fn get_info(&self) -> ClientConfig { + let mut info = ClientConfig::default(); + info.protocol_version = self.protocol_version.clone(); + info + } +} + +/// Wires the pair up directly on `client_version`. `2026-07-28` removed the +/// `initialize` handshake, so a peer on that revision is reached the way the +/// discover lifecycle leaves one: with the version already agreed. +async fn call_tool_result_type(client_version: ProtocolVersion) -> Option { + let (server_transport, client_transport) = tokio::io::duplex(4096); + + let client_handler = VersionedClient { + protocol_version: client_version.clone(), + }; + let mut server_peer_info = InitializeResult::default(); + server_peer_info.protocol_version = client_version; + + let server = serve_directly::( + ToolServer, + server_transport, + Some(client_handler.get_info()), + ); + let server_handle = tokio::spawn(async move { + server.waiting().await?; + anyhow::Ok(()) + }); + + let client = serve_directly::( + client_handler, + client_transport, + Some(server_peer_info.into()), + ); + + let result = client + .call_tool(CallToolRequestParams::new("echo")) + .await + .expect("tool call should succeed"); + + client.cancel().await.expect("client should cancel"); + server_handle.await.expect("server task").expect("server"); + result.result_type +} + +#[tokio::test] +async fn legacy_version_omits_result_type() { + assert_eq!( + call_tool_result_type(ProtocolVersion::V_2025_11_25).await, + None + ); +} + +#[tokio::test] +async fn sep_2322_version_gets_complete_result_type() { + assert_eq!( + call_tool_result_type(ProtocolVersion::V_2026_07_28).await, + Some(ResultType::COMPLETE), + ); +} diff --git a/vendor/rmcp/tests/test_result_type_wire.rs b/vendor/rmcp/tests/test_result_type_wire.rs new file mode 100644 index 00000000..a22933e3 --- /dev/null +++ b/vendor/rmcp/tests/test_result_type_wire.rs @@ -0,0 +1,188 @@ +//! Wire-shape regression guards for the SEP-2322 `resultType` discriminator. +//! +//! These pin the behavior that keeps older/strict peers working: +//! - `EmptyResult` stays a bare `{}` (some peers strict-validate empty results +//! and reject extra keys), +//! - ordinary results carry `resultType: "complete"` by default, and +//! - [`ServerResult::strip_result_type_for_legacy_peer`] removes the +//! `"complete"` discriminator so legacy sessions keep their historical wire +//! shape (round-tripping a legacy result never adds the field). + +use rmcp::model::{ + CallToolResult, CompleteResult, ContentBlock, EmptyResult, GetPromptResult, ListToolsResult, + ReadResourceResult, ResultType, ServerResult, +}; +use serde_json::json; + +#[test] +fn empty_result_serializes_without_result_type() { + let value = serde_json::to_value(EmptyResult {}).expect("serialize EmptyResult"); + assert_eq!(value, json!({})); +} + +#[test] +fn call_tool_result_serializes_complete_result_type() { + let value = serde_json::to_value(CallToolResult::success(vec![ContentBlock::text("ok")])) + .expect("serialize CallToolResult"); + assert_eq!(value["resultType"], "complete"); +} + +#[test] +fn paginated_result_serializes_complete_result_type() { + let value = + serde_json::to_value(ListToolsResult::default()).expect("serialize ListToolsResult"); + assert_eq!(value["resultType"], "complete"); +} + +// Guards the convention the server handler relies on: every constructor and +// `Default` impl produces `Some(COMPLETE)`, so 2026-07-28 sessions always +// include the spec-required field unless a handler clears it explicitly. +#[test] +fn constructors_and_defaults_produce_complete_result_type() { + let complete = Some(ResultType::COMPLETE); + assert_eq!(CallToolResult::default().result_type, complete); + assert_eq!(CallToolResult::success(vec![]).result_type, complete); + assert_eq!(CallToolResult::error(vec![]).result_type, complete); + assert_eq!(CallToolResult::structured(json!({})).result_type, complete); + assert_eq!( + CallToolResult::structured_error(json!({})).result_type, + complete + ); + assert_eq!(ListToolsResult::default().result_type, complete); + assert_eq!( + ListToolsResult::with_all_items(vec![]).result_type, + complete + ); + assert_eq!(ReadResourceResult::new(vec![]).result_type, complete); + assert_eq!(GetPromptResult::default().result_type, complete); + assert_eq!(GetPromptResult::new(vec![]).result_type, complete); + assert_eq!(CompleteResult::default().result_type, complete); +} + +#[test] +fn absent_result_type_deserializes_as_none() { + let legacy = json!({ + "content": [], + "isError": false, + }); + + let result: CallToolResult = + serde_json::from_value(legacy).expect("deserialize legacy CallToolResult"); + + assert_eq!(result.result_type, None); +} + +#[test] +fn legacy_call_tool_result_round_trips_without_result_type() { + let legacy = json!({ + "content": [], + "isError": false, + }); + + let result: CallToolResult = + serde_json::from_value(legacy.clone()).expect("deserialize legacy CallToolResult"); + let reserialized = serde_json::to_value(result).expect("serialize CallToolResult"); + + assert_eq!(reserialized, legacy); +} + +#[test] +fn call_tool_result_should_reject_non_complete_result_type() { + let input_required = json!({ + "resultType": "input_required", + "_meta": { + "example.com/replica": "r1", + }, + }); + + assert!(serde_json::from_value::(input_required).is_err()); +} + +#[test] +fn server_result_should_preserve_input_required_result_when_meta_present() { + let input_required = json!({ + "resultType": "input_required", + "requestState": "sealed", + "_meta": { + "example.com/replica": "r1", + }, + }); + + let result = + serde_json::from_value::(input_required).expect("deserialize ServerResult"); + + match result { + ServerResult::InputRequiredResult(result) => { + assert_eq!( + (result.request_state.as_deref(), result.meta.is_some()), + (Some("sealed"), true) + ); + } + _ => panic!("expected InputRequiredResult"), + } +} + +#[test] +fn server_result_should_accept_legacy_call_tool_result_when_only_meta_present() { + let legacy = json!({ + "_meta": { + "example.com/replica": "r1", + }, + }); + + let result = + serde_json::from_value::(legacy).expect("deserialize legacy CallToolResult"); + + match result { + ServerResult::CallToolResult(result) => { + assert_eq!( + ( + result.result_type, + result.content.is_empty(), + result.meta.is_some() + ), + (None, true, true) + ); + } + _ => panic!("expected CallToolResult"), + } +} + +#[test] +fn strip_removes_complete_result_type() { + let mut result = + ServerResult::CallToolResult(CallToolResult::success(vec![ContentBlock::text("ok")])); + result.strip_result_type_for_legacy_peer(); + + let value = serde_json::to_value(result).expect("serialize ServerResult"); + assert_eq!( + value, + json!({ + "content": [{ "type": "text", "text": "ok" }], + "isError": false, + }) + ); +} + +#[test] +fn strip_removes_complete_result_type_from_paginated_result() { + let mut result = ServerResult::ListToolsResult(ListToolsResult::default()); + result.strip_result_type_for_legacy_peer(); + + let value = serde_json::to_value(result).expect("serialize ServerResult"); + assert_eq!(value, json!({ "tools": [] })); +} + +#[test] +fn strip_preserves_custom_result_type() { + let streaming: ResultType = + serde_json::from_value(json!("streaming")).expect("deserialize ResultType"); + let mut tool_result = CallToolResult::success(vec![ContentBlock::text("ok")]); + tool_result.result_type = Some(streaming); + + let mut result = ServerResult::CallToolResult(tool_result); + result.strip_result_type_for_legacy_peer(); + + let value = serde_json::to_value(result).expect("serialize ServerResult"); + assert_eq!(value["resultType"], "streaming"); +} diff --git a/vendor/rmcp/tests/test_sampling.rs b/vendor/rmcp/tests/test_sampling.rs new file mode 100644 index 00000000..3c82fd42 --- /dev/null +++ b/vendor/rmcp/tests/test_sampling.rs @@ -0,0 +1,744 @@ +#![cfg(not(feature = "local"))] +#![allow(deprecated)] +mod common; + +use anyhow::Result; +use common::handlers::{TestClientHandler, TestServer}; +use rmcp::{ + ServiceExt, + model::*, + service::{RequestContext, Service}, +}; +use rstest::rstest; + +#[tokio::test] +async fn test_basic_sampling_message_creation() -> Result<()> { + let message = SamplingMessage::user_text("What is the capital of France?"); + + let json = serde_json::to_string(&message)?; + let deserialized: SamplingMessage = serde_json::from_str(&json)?; + assert_eq!(message, deserialized); + assert_eq!(message.role, Role::User); + + Ok(()) +} + +#[tokio::test] +async fn test_sampling_request_params() -> Result<()> { + let params = + CreateMessageRequestParams::new(vec![SamplingMessage::user_text("Hello, world!")], 100) + .with_model_preferences( + ModelPreferences::new() + .with_hints(vec![ModelHint::new("claude")]) + .with_cost_priority(0.5) + .with_speed_priority(0.8) + .with_intelligence_priority(0.7), + ) + .with_system_prompt("You are a helpful assistant.") + .with_temperature(0.7) + .with_stop_sequences(vec!["STOP".to_string()]) + .with_include_context(ContextInclusion::None) + .with_metadata(serde_json::json!({"test": "value"})); + + let json = serde_json::to_string(¶ms)?; + let deserialized: CreateMessageRequestParams = serde_json::from_str(&json)?; + assert_eq!(params, deserialized); + + assert_eq!(params.messages.len(), 1); + assert_eq!(params.max_tokens, 100); + assert_eq!(params.temperature, Some(0.7)); + + Ok(()) +} + +#[tokio::test] +async fn test_sampling_result_structure() -> Result<()> { + let result = CreateMessageResult::new( + SamplingMessage::assistant_text("The capital of France is Paris."), + "test-model".to_string(), + ) + .with_stop_reason(CreateMessageResult::STOP_REASON_END_TURN); + + let json = serde_json::to_string(&result)?; + let deserialized: CreateMessageResult = serde_json::from_str(&json)?; + assert_eq!(result, deserialized); + + assert_eq!(result.message.role, Role::Assistant); + assert_eq!(result.model, "test-model"); + assert_eq!( + result.stop_reason, + Some(CreateMessageResult::STOP_REASON_END_TURN.to_string()) + ); + + Ok(()) +} + +#[tokio::test] +async fn test_sampling_context_inclusion_enum() -> Result<()> { + let test_cases = vec![ + (ContextInclusion::None, "none"), + (ContextInclusion::ThisServer, "thisServer"), + (ContextInclusion::AllServers, "allServers"), + ]; + + for (context, expected_json) in test_cases { + let json = serde_json::to_string(&context)?; + assert_eq!(json, format!("\"{}\"", expected_json)); + + let deserialized: ContextInclusion = serde_json::from_str(&json)?; + assert_eq!(context, deserialized); + } + + Ok(()) +} + +#[tokio::test] +async fn test_sampling_integration_with_test_handlers() -> Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(4096); + + let server_handle = tokio::spawn(async move { + let server = TestServer::new().serve(server_transport).await?; + server.waiting().await?; + anyhow::Ok(()) + }); + + let handler = TestClientHandler::new(true, true); + let client = handler.clone().serve(client_transport).await?; + + tokio::time::sleep(tokio::time::Duration::from_millis(100)).await; + + let request = ServerRequest::CreateMessageRequest(CreateMessageRequest::new( + CreateMessageRequestParams::new( + vec![SamplingMessage::user_text("What is the capital of France?")], + 100, + ) + .with_include_context(ContextInclusion::ThisServer) + .with_model_preferences( + ModelPreferences::new() + .with_hints(vec![ModelHint::new("test-model")]) + .with_cost_priority(0.5) + .with_speed_priority(0.8) + .with_intelligence_priority(0.7), + ) + .with_system_prompt("You are a helpful assistant.") + .with_temperature(0.7), + )); + + let result = handler + .handle_request( + request.clone(), + RequestContext::new(NumberOrString::Number(1), client.peer().clone()), + ) + .await?; + + if let ClientResult::CreateMessageResult(result) = result { + assert_eq!(result.message.role, Role::Assistant); + assert_eq!(result.model, "test-model"); + assert_eq!( + result.stop_reason, + Some(CreateMessageResult::STOP_REASON_END_TURN.to_string()) + ); + + let response_text = result + .message + .content + .first() + .unwrap() + .as_text() + .unwrap() + .text + .as_str(); + assert!( + response_text.contains("test context"), + "Response should include context for ThisServer inclusion" + ); + } else { + panic!("Expected CreateMessageResult"); + } + + client.cancel().await?; + server_handle.await??; + Ok(()) +} + +#[tokio::test] +async fn test_sampling_no_context_inclusion() -> Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(4096); + + let server_handle = tokio::spawn(async move { + let server = TestServer::new().serve(server_transport).await?; + server.waiting().await?; + anyhow::Ok(()) + }); + + let handler = TestClientHandler::new(true, true); + let client = handler.clone().serve(client_transport).await?; + + tokio::time::sleep(tokio::time::Duration::from_millis(100)).await; + + let request = ServerRequest::CreateMessageRequest(CreateMessageRequest::new( + CreateMessageRequestParams::new(vec![SamplingMessage::user_text("Hello")], 50) + .with_include_context(ContextInclusion::None), + )); + + let result = handler + .handle_request( + request.clone(), + RequestContext::new(NumberOrString::Number(2), client.peer().clone()), + ) + .await?; + + if let ClientResult::CreateMessageResult(result) = result { + assert_eq!(result.message.role, Role::Assistant); + assert_eq!(result.model, "test-model"); + + let response_text = result + .message + .content + .first() + .unwrap() + .as_text() + .unwrap() + .text + .as_str(); + assert!( + !response_text.contains("test context"), + "Response should not include context for None inclusion" + ); + } else { + panic!("Expected CreateMessageResult"); + } + + client.cancel().await?; + server_handle.await??; + Ok(()) +} + +#[tokio::test] +async fn test_sampling_error_invalid_message_sequence() -> Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(4096); + + let server_handle = tokio::spawn(async move { + let server = TestServer::new().serve(server_transport).await?; + server.waiting().await?; + anyhow::Ok(()) + }); + + let handler = TestClientHandler::new(true, true); + let client = handler.clone().serve(client_transport).await?; + + tokio::time::sleep(tokio::time::Duration::from_millis(100)).await; + + let request = ServerRequest::CreateMessageRequest(CreateMessageRequest::new( + CreateMessageRequestParams::new( + vec![SamplingMessage::assistant_text( + "I'm an assistant message without a user message", + )], + 50, + ) + .with_include_context(ContextInclusion::None), + )); + + let result = handler + .handle_request( + request.clone(), + RequestContext::new(NumberOrString::Number(3), client.peer().clone()), + ) + .await; + + assert!(result.is_err()); + + client.cancel().await?; + server_handle.await??; + Ok(()) +} + +#[tokio::test] +async fn test_tool_choice_serialization() -> Result<()> { + let auto = ToolChoice::auto(); + let json = serde_json::to_string(&auto)?; + assert!(json.contains("auto")); + let deserialized: ToolChoice = serde_json::from_str(&json)?; + assert_eq!(auto, deserialized); + + let required = ToolChoice::required(); + let json = serde_json::to_string(&required)?; + assert!(json.contains("required")); + let deserialized: ToolChoice = serde_json::from_str(&json)?; + assert_eq!(required, deserialized); + + let none = ToolChoice::none(); + let json = serde_json::to_string(&none)?; + assert!(json.contains("none")); + let deserialized: ToolChoice = serde_json::from_str(&json)?; + assert_eq!(none, deserialized); + + Ok(()) +} + +#[tokio::test] +async fn test_sampling_with_tools() -> Result<()> { + use std::sync::Arc; + + let tool = Tool::new( + "get_weather", + "Get the current weather for a location", + Arc::new( + serde_json::json!({ + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The city and state, e.g. San Francisco, CA" + } + }, + "required": ["location"] + }) + .as_object() + .unwrap() + .clone(), + ), + ); + + let params = CreateMessageRequestParams::new( + vec![SamplingMessage::user_text( + "What's the weather in San Francisco?", + )], + 100, + ) + .with_tools(vec![tool]) + .with_tool_choice(ToolChoice::auto()); + + let json = serde_json::to_string(¶ms)?; + let deserialized: CreateMessageRequestParams = serde_json::from_str(&json)?; + + assert!(deserialized.tools.is_some()); + assert_eq!(deserialized.tools.as_ref().unwrap().len(), 1); + assert_eq!(deserialized.tools.as_ref().unwrap()[0].name, "get_weather"); + assert!(deserialized.tool_choice.is_some()); + + Ok(()) +} + +#[tokio::test] +async fn test_tool_use_content_serialization() -> Result<()> { + let tool_use = ToolUseContent::new( + "call_123", + "get_weather", + serde_json::json!({ + "location": "San Francisco, CA" + }) + .as_object() + .unwrap() + .clone(), + ); + + let json = serde_json::to_string(&tool_use)?; + let deserialized: ToolUseContent = serde_json::from_str(&json)?; + assert_eq!(tool_use, deserialized); + assert_eq!(deserialized.id, "call_123"); + assert_eq!(deserialized.name, "get_weather"); + + Ok(()) +} + +#[tokio::test] +async fn test_tool_result_content_serialization() -> Result<()> { + let tool_result = ToolResultContent::new( + "call_123", + vec![ContentBlock::text( + "The weather in San Francisco is 72°F and sunny.", + )], + ); + + let json = serde_json::to_string(&tool_result)?; + let deserialized: ToolResultContent = serde_json::from_str(&json)?; + assert_eq!(tool_result, deserialized); + assert_eq!(deserialized.tool_use_id, "call_123"); + assert!(!deserialized.content.is_empty()); + + Ok(()) +} + +#[test] +fn test_tool_result_content_requires_content() { + let raw = serde_json::json!({ + "toolUseId": "call_123" + }); + + let err = serde_json::from_value::(raw).unwrap_err(); + + assert!(err.to_string().contains("missing field `content`")); +} + +#[rstest] +#[case::array(serde_json::json!([{ "city": "SF", "temp": 72 }, { "city": "NY", "temp": 65 }]))] +#[case::string(serde_json::json!("sunny"))] +#[case::integer(serde_json::json!(42))] +#[case::float(serde_json::json!(3.5))] +#[case::boolean(serde_json::json!(true))] +fn tool_result_content_round_trips_non_object_structured_content( + #[case] structured: serde_json::Value, +) -> Result<()> { + let mut tool_result = ToolResultContent::new("call_123", vec![ContentBlock::text("x")]); + tool_result.structured_content = Some(structured); + + let json = serde_json::to_string(&tool_result)?; + let deserialized: ToolResultContent = serde_json::from_str(&json)?; + assert_eq!(tool_result, deserialized); + + Ok(()) +} + +// `null` is a valid JSON value, but `Option` deserializes JSON `null` +// as `None`, so `Some(Value::Null)` collapses to `None` on round-trip. +#[test] +fn tool_result_content_null_structured_content_round_trips_to_none() -> Result<()> { + let mut tool_result = ToolResultContent::new("call_123", vec![ContentBlock::text("x")]); + tool_result.structured_content = Some(serde_json::Value::Null); + + let json = serde_json::to_string(&tool_result)?; + let deserialized: ToolResultContent = serde_json::from_str(&json)?; + assert_eq!(deserialized.structured_content, None); + + Ok(()) +} + +#[tokio::test] +async fn test_sampling_message_with_tool_use() -> Result<()> { + let message = SamplingMessage::assistant_tool_use( + "call_123", + "get_weather", + serde_json::json!({ + "location": "San Francisco, CA" + }) + .as_object() + .unwrap() + .clone(), + ); + + let json = serde_json::to_string(&message)?; + let deserialized: SamplingMessage = serde_json::from_str(&json)?; + assert_eq!(message, deserialized); + assert_eq!(deserialized.role, Role::Assistant); + + let tool_use = deserialized.content.first().unwrap().as_tool_use().unwrap(); + assert_eq!(tool_use.name, "get_weather"); + + Ok(()) +} + +#[tokio::test] +async fn test_sampling_message_with_tool_result() -> Result<()> { + let message = + SamplingMessage::user_tool_result("call_123", vec![ContentBlock::text("72°F and sunny")]); + + let json = serde_json::to_string(&message)?; + let deserialized: SamplingMessage = serde_json::from_str(&json)?; + assert_eq!(message, deserialized); + assert_eq!(deserialized.role, Role::User); + + let tool_result = deserialized + .content + .first() + .unwrap() + .as_tool_result() + .unwrap(); + assert_eq!(tool_result.tool_use_id, "call_123"); + + Ok(()) +} + +#[tokio::test] +async fn test_create_message_result_tool_use_stop_reason() -> Result<()> { + let result = CreateMessageResult::new( + SamplingMessage::assistant_tool_use( + "call_123", + "get_weather", + serde_json::json!({ + "location": "San Francisco" + }) + .as_object() + .unwrap() + .clone(), + ), + "test-model".to_string(), + ) + .with_stop_reason(CreateMessageResult::STOP_REASON_TOOL_USE); + + let json = serde_json::to_string(&result)?; + let deserialized: CreateMessageResult = serde_json::from_str(&json)?; + assert_eq!(result, deserialized); + assert_eq!(deserialized.stop_reason, Some("toolUse".to_string())); + + Ok(()) +} + +#[tokio::test] +async fn test_sampling_capability() -> Result<()> { + let mut cap = SamplingCapability::default(); + cap.tools = Some(JsonObject::default()); + + let json = serde_json::to_string(&cap)?; + let deserialized: SamplingCapability = serde_json::from_str(&json)?; + assert_eq!(cap, deserialized); + assert!(deserialized.tools.is_some()); + assert!(deserialized.context.is_none()); + + let client_cap = ClientCapabilities::builder() + .enable_sampling() + .enable_sampling_tools() + .build(); + + assert!(client_cap.sampling.is_some()); + assert!(client_cap.sampling.as_ref().unwrap().tools.is_some()); + + Ok(()) +} + +#[tokio::test] +async fn test_backward_compat_sampling_message_deserialization() -> Result<()> { + let old_format_json = r#"{ + "role": "user", + "content": { + "type": "text", + "text": "Hello, world!" + } + }"#; + + let message: SamplingMessage = serde_json::from_str(old_format_json)?; + assert_eq!(message.role, Role::User); + let text = message.content.first().unwrap().as_text().unwrap(); + assert_eq!(text.text, "Hello, world!"); + + Ok(()) +} + +#[tokio::test] +async fn test_backward_compat_sampling_message_with_image() -> Result<()> { + let old_format_json = r#"{ + "role": "user", + "content": { + "type": "image", + "data": "base64data", + "mimeType": "image/png" + } + }"#; + + let message: SamplingMessage = serde_json::from_str(old_format_json)?; + assert_eq!(message.role, Role::User); + assert_eq!(message.content.len(), 1); + + Ok(()) +} + +#[tokio::test] +async fn test_backward_compat_sampling_capability_empty_object() -> Result<()> { + let empty_json = "{}"; + let cap: SamplingCapability = serde_json::from_str(empty_json)?; + assert!(cap.tools.is_none()); + assert!(cap.context.is_none()); + + let client_cap_json = r#"{"sampling": {}}"#; + let client_cap: ClientCapabilities = serde_json::from_str(client_cap_json)?; + assert!(client_cap.sampling.is_some()); + + Ok(()) +} + +#[tokio::test] +async fn test_content_to_sampling_message_content_conversion() -> Result<()> { + use std::convert::TryInto; + + let content = ContentBlock::text("Hello"); + let sampling_content: SamplingMessageContentBlock = + content.try_into().map_err(|e: &str| anyhow::anyhow!(e))?; + assert!(sampling_content.as_text().is_some()); + assert_eq!(sampling_content.as_text().unwrap().text, "Hello"); + + let content = ContentBlock::image("base64data", "image/png"); + let sampling_content: SamplingMessageContentBlock = + content.try_into().map_err(|e: &str| anyhow::anyhow!(e))?; + assert!(matches!( + sampling_content, + SamplingMessageContentBlock::Image(_) + )); + + Ok(()) +} + +#[tokio::test] +async fn test_content_to_sampling_content_conversion() -> Result<()> { + use std::convert::TryInto; + + let content = ContentBlock::text("Hello"); + let sampling_content: SamplingContent = + content.try_into().map_err(|e: &str| anyhow::anyhow!(e))?; + assert_eq!(sampling_content.len(), 1); + assert!(sampling_content.first().unwrap().as_text().is_some()); + + Ok(()) +} + +#[tokio::test] +async fn test_content_conversion_unsupported_variants() { + use std::convert::TryInto; + + use rmcp::model::ResourceContents; + + let resource_content = ContentBlock::resource(ResourceContents::TextResourceContents { + uri: "file:///test.txt".to_string(), + mime_type: Some("text/plain".to_string()), + text: "test".to_string(), + meta: None, + }); + + let result: Result = resource_content.try_into(); + assert!(result.is_err()); + assert_eq!( + result.unwrap_err(), + "Resource content is not supported in sampling messages" + ); +} + +#[tokio::test] +async fn test_validate_rejects_tool_use_in_user_message() { + let params = CreateMessageRequestParams::new( + vec![SamplingMessage::new( + Role::User, + SamplingMessageContentBlock::tool_use("call_1", "some_tool", Default::default()), + )], + 100, + ); + + let err = params.validate().unwrap_err(); + assert!( + err.contains("ToolUse content is only allowed in assistant messages"), + "unexpected error: {err}" + ); +} + +#[tokio::test] +async fn test_validate_rejects_tool_result_in_assistant_message() { + let params = CreateMessageRequestParams::new( + vec![SamplingMessage::new( + Role::Assistant, + SamplingMessageContentBlock::tool_result("call_1", vec![ContentBlock::text("result")]), + )], + 100, + ); + + let err = params.validate().unwrap_err(); + assert!( + err.contains("ToolResult content is only allowed in user messages"), + "unexpected error: {err}" + ); +} + +#[tokio::test] +async fn test_validate_rejects_mixed_content_with_tool_result() { + let params = CreateMessageRequestParams::new( + vec![SamplingMessage::new_multiple( + Role::User, + vec![ + SamplingMessageContentBlock::tool_result( + "call_1", + vec![ContentBlock::text("result")], + ), + SamplingMessageContentBlock::text("some extra text"), + ], + )], + 100, + ); + + let err = params.validate().unwrap_err(); + assert!( + err.contains("MUST NOT contain other content types"), + "unexpected error: {err}" + ); +} + +#[tokio::test] +async fn test_validate_rejects_unbalanced_tool_use_result() { + let params = CreateMessageRequestParams::new( + vec![ + SamplingMessage::user_text("Hello"), + SamplingMessage::assistant_tool_use("call_1", "some_tool", Default::default()), + ], + 100, + ); + + let err = params.validate().unwrap_err(); + assert!( + err.contains("not balanced with ToolResult"), + "unexpected error: {err}" + ); +} + +#[tokio::test] +async fn test_validate_rejects_tool_result_without_matching_use() { + let params = CreateMessageRequestParams::new( + vec![ + SamplingMessage::user_text("Hello"), + SamplingMessage::user_tool_result( + "nonexistent_call", + vec![ContentBlock::text("result")], + ), + ], + 100, + ); + + let err = params.validate().unwrap_err(); + assert!( + err.contains("has no matching ToolUse"), + "unexpected error: {err}" + ); +} + +#[tokio::test] +async fn test_validate_accepts_valid_tool_conversation() { + let params = CreateMessageRequestParams::new( + vec![ + SamplingMessage::user_text("What's the weather?"), + SamplingMessage::assistant_tool_use( + "call_1", + "get_weather", + serde_json::json!({"location": "SF"}) + .as_object() + .unwrap() + .clone(), + ), + SamplingMessage::user_tool_result("call_1", vec![ContentBlock::text("72°F and sunny")]), + SamplingMessage::assistant_text("It's 72°F and sunny in SF."), + ], + 100, + ); + + assert!(params.validate().is_ok()); +} + +#[tokio::test] +async fn test_create_message_result_validate_rejects_user_role() { + let result = CreateMessageResult::new( + SamplingMessage::user_text("This should not be a user message"), + "test-model".to_string(), + ) + .with_stop_reason(CreateMessageResult::STOP_REASON_END_TURN); + + let err = result.validate().unwrap_err(); + assert!( + err.contains("role must be 'assistant'"), + "unexpected error: {err}" + ); +} + +#[tokio::test] +async fn test_create_message_result_validate_accepts_assistant_role() { + let result = CreateMessageResult::new( + SamplingMessage::assistant_text("Hello!"), + "test-model".to_string(), + ) + .with_stop_reason(CreateMessageResult::STOP_REASON_END_TURN); + + assert!(result.validate().is_ok()); +} diff --git a/vendor/rmcp/tests/test_sep_2260_request_association.rs b/vendor/rmcp/tests/test_sep_2260_request_association.rs new file mode 100644 index 00000000..787d6341 --- /dev/null +++ b/vendor/rmcp/tests/test_sep_2260_request_association.rs @@ -0,0 +1,298 @@ +#![cfg(all(feature = "server", feature = "client", not(feature = "local")))] +#![expect( + deprecated, + reason = "This test verifies request association for the deprecated sampling API" +)] + +use std::sync::{Arc, Mutex}; + +use rmcp::{ + ClientHandler, RoleClient, RoleServer, ServerHandler, ServiceError, ServiceExt, + model::{ + CallToolRequestParams, CallToolResponse, CallToolResult, ClientConfig, ContentBlock, + CreateMessageRequest, CreateMessageRequestParams, CreateMessageResult, ProtocolVersion, + SamplingMessage, ServerCapabilities, ServerConfig, ServerRequest, + }, + service::{RequestContext, RunningService, serve_directly}, +}; +use serde_json::{Value, json}; +use tokio::{ + io::{AsyncBufReadExt, AsyncWriteExt, BufReader, DuplexStream, Lines, ReadHalf, WriteHalf}, + sync::oneshot, +}; + +type RequestResultSender = oneshot::Sender>; + +#[derive(Clone)] +struct SamplingServer { + outside: Arc>>, +} + +impl ServerHandler for SamplingServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::builder().enable_tools().build()) + } + + async fn call_tool( + &self, + request: CallToolRequestParams, + context: RequestContext, + ) -> Result { + let peer = context.peer.clone(); + let slot = self.outside.clone(); + + let use_generic = request.name == "sample_generic"; + tokio::spawn(async move { + let outside = if use_generic { + peer.send_request(ServerRequest::CreateMessageRequest( + CreateMessageRequest::new(CreateMessageRequestParams::new( + vec![SamplingMessage::user_text("standalone-generic")], + 16, + )), + )) + .await + .map(|_| ()) + } else { + peer.create_message(CreateMessageRequestParams::new( + vec![SamplingMessage::user_text("standalone")], + 16, + )) + .await + .map(|_| ()) + }; + if let Some(tx) = slot.lock().unwrap().take() { + let _ = tx.send(outside); + } + }); + + let nested = context + .peer + .create_message(CreateMessageRequestParams::new( + vec![SamplingMessage::user_text("nested")], + 16, + )) + .await; + nested.map_err(|e| rmcp::ErrorData::internal_error(e.to_string(), None))?; + Ok(CallToolResult::success(vec![ContentBlock::text("ok")]).into()) + } +} + +#[derive(Clone)] +struct SamplingClient; + +impl ClientHandler for SamplingClient { + async fn create_message( + &self, + _params: CreateMessageRequestParams, + _context: RequestContext, + ) -> Result { + Ok(CreateMessageResult::new( + SamplingMessage::assistant_text("pong"), + "test-model".to_string(), + ) + .with_stop_reason(CreateMessageResult::STOP_REASON_END_TURN)) + } + + fn get_info(&self) -> ClientConfig { + let mut info = ClientConfig::default(); + info.protocol_version = ProtocolVersion::V_2026_07_28; + info + } +} + +/// Connects the pair on `2026-07-28`. That revision dropped the `initialize` +/// handshake, so the version is agreed up front the way a discover-lifecycle +/// startup leaves it. +fn serve_modern_pair( + server: SamplingServer, +) -> ( + RunningService, + RunningService, +) { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let mut server_peer_info = server.get_info(); + server_peer_info.protocol_version = ProtocolVersion::V_2026_07_28; + + let running_server = serve_directly::( + server, + server_transport, + Some(SamplingClient.get_info()), + ); + let client = serve_directly::( + SamplingClient, + client_transport, + Some(server_peer_info.into()), + ); + (running_server, client) +} + +#[tokio::test] +async fn nested_sampling_allowed_standalone_rejected() -> anyhow::Result<()> { + let (tx, rx) = oneshot::channel(); + let server = SamplingServer { + outside: Arc::new(Mutex::new(Some(tx))), + }; + let (running_server, client) = serve_modern_pair(server); + let server_handle = tokio::spawn(async move { + running_server.waiting().await?; + anyhow::Ok(()) + }); + + let result = client + .peer() + .call_tool(CallToolRequestParams::new("sample")) + .await?; + assert_eq!( + result.content.first().unwrap().as_text().unwrap().text, + "ok" + ); + + let outside = rx.await?; + assert!(matches!(outside, Err(ServiceError::McpError(_)))); + + client.cancel().await?; + let _ = server_handle.await?; + Ok(()) +} + +#[tokio::test] +async fn generic_send_request_bypass_rejected() -> anyhow::Result<()> { + let (tx, rx) = oneshot::channel(); + let server = SamplingServer { + outside: Arc::new(Mutex::new(Some(tx))), + }; + let (running_server, client) = serve_modern_pair(server); + let server_handle = tokio::spawn(async move { + running_server.waiting().await?; + anyhow::Ok(()) + }); + + let result = client + .peer() + .call_tool(CallToolRequestParams::new("sample_generic")) + .await?; + assert_eq!( + result.content.first().unwrap().as_text().unwrap().text, + "ok" + ); + + let outside = rx.await?; + assert!( + matches!(outside, Err(ServiceError::McpError(_))), + "generic send_request must not bypass SEP-2260 enforcement" + ); + + client.cancel().await?; + let _ = server_handle.await?; + Ok(()) +} + +// A compliant rmcp server cannot produce an unassociated server-to-client +// request at >= 2026-07-28 (send-side enforcement blocks it), so the client's +// receive-side enforcement is exercised with a raw JSON-RPC server. +type RawServer = ( + Lines>>, + WriteHalf, +); + +async fn raw_initialize(io: DuplexStream, protocol_version: &str) -> anyhow::Result { + let (read, mut write) = tokio::io::split(io); + let mut lines = BufReader::new(read).lines(); + let init: Value = serde_json::from_str(&lines.next_line().await?.expect("initialize request"))?; + assert_eq!(init["method"], "initialize"); + let response = json!({ + "jsonrpc": "2.0", + "id": init["id"], + "result": { + "protocolVersion": protocol_version, + "capabilities": {}, + "serverInfo": { "name": "raw-server", "version": "0.0.0" } + } + }); + write.write_all(format!("{response}\n").as_bytes()).await?; + let initialized: Value = + serde_json::from_str(&lines.next_line().await?.expect("initialized notification"))?; + assert_eq!(initialized["method"], "notifications/initialized"); + Ok((lines, write)) +} + +async fn raw_request(server: &mut RawServer, request: Value) -> anyhow::Result { + let (lines, write) = server; + write.write_all(format!("{request}\n").as_bytes()).await?; + Ok(serde_json::from_str( + &lines.next_line().await?.expect("response"), + )?) +} + +fn raw_sampling_request(id: u32) -> Value { + json!({ + "jsonrpc": "2.0", + "id": id, + "method": "sampling/createMessage", + "params": { + "messages": [{ "role": "user", "content": { "type": "text", "text": "hi" } }], + "maxTokens": 16 + } + }) +} + +#[tokio::test] +async fn unassociated_server_request_rejected_with_invalid_params() -> anyhow::Result<()> { + let (client_io, server_io) = tokio::io::duplex(4096); + let raw = tokio::spawn(async move { + let mut server = raw_initialize(server_io, "2026-07-28").await?; + raw_request(&mut server, raw_sampling_request(100)).await + }); + + let client = SamplingClient.serve(client_io).await?; + let response = raw.await??; + assert_eq!( + response["error"]["code"], -32602, + "SEP-2260: unassociated server-to-client request must be rejected with invalid params, got {response}" + ); + + client.cancel().await?; + Ok(()) +} + +#[tokio::test] +async fn unassociated_server_request_allowed_on_legacy_protocol() -> anyhow::Result<()> { + let (client_io, server_io) = tokio::io::duplex(4096); + let raw = tokio::spawn(async move { + let mut server = raw_initialize(server_io, "2025-11-25").await?; + raw_request(&mut server, raw_sampling_request(100)).await + }); + + let client = SamplingClient.serve(client_io).await?; + let response = raw.await??; + assert_eq!( + response["result"]["model"], "test-model", + "pre-2026-07-28 peers keep the permissive behavior, got {response}" + ); + + client.cancel().await?; + Ok(()) +} + +#[tokio::test] +async fn unassociated_ping_allowed() -> anyhow::Result<()> { + let (client_io, server_io) = tokio::io::duplex(4096); + let raw = tokio::spawn(async move { + let mut server = raw_initialize(server_io, "2026-07-28").await?; + raw_request( + &mut server, + json!({ "jsonrpc": "2.0", "id": 101, "method": "ping" }), + ) + .await + }); + + let client = SamplingClient.serve(client_io).await?; + let response = raw.await??; + assert!( + response.get("error").is_none(), + "SEP-2260 excepts ping from request association, got {response}" + ); + + client.cancel().await?; + Ok(()) +} diff --git a/vendor/rmcp/tests/test_sep_2260_stream_enforcement.rs b/vendor/rmcp/tests/test_sep_2260_stream_enforcement.rs new file mode 100644 index 00000000..72a0832d --- /dev/null +++ b/vendor/rmcp/tests/test_sep_2260_stream_enforcement.rs @@ -0,0 +1,309 @@ +//! SEP-2260 follow-up (#1033): stream-based receive-side enforcement. +//! +//! Scripted streamable HTTP "server": answers a legacy initialize with +//! protocol 2026-07-28 AND a session id. That combination is NOT +//! spec-compliant: the 2026-07-28 revision removes protocol-level sessions +//! and the standalone GET stream (SEP-2567; transports spec: "do not mint +//! or echo session IDs"). Receive-side enforcement (#1033) exists precisely +//! to protect the client from non-conforming servers, and rmcp's client +//! tolerates the session id and opens the standalone GET stream — so this +//! is the reachable path where the client has BOTH a GET stream and strict +//! SEP-2260 enforcement. +#![cfg(all( + feature = "client", + feature = "transport-streamable-http-client", + not(feature = "local") +))] +#![expect( + deprecated, + reason = "Sampling is deprecated by SEP-2577 but remains the canonical restricted request" +)] + +use std::{collections::HashMap, sync::Arc, time::Duration}; + +use futures::{StreamExt, stream::BoxStream}; +use http::{HeaderName, HeaderValue}; +use rmcp::{ + ClientHandler, + model::{ + ClientConfig, ClientJsonRpcMessage, CreateMessageRequestParams, CreateMessageResult, + ProtocolVersion, SamplingMessage, ServerCapabilities, ServerConfig, ServerJsonRpcMessage, + }, + service::{ClientLifecycleMode, RequestContext, RoleClient, serve_client_with_lifecycle}, + transport::streamable_http_client::{ + StreamableHttpClient, StreamableHttpClientTransport, StreamableHttpClientTransportConfig, + StreamableHttpError, StreamableHttpPostResponse, + }, +}; +use serde_json::{Value, json}; +use sse_stream::{Error as SseError, Sse}; +use tokio::sync::{Mutex, mpsc}; + +fn to_sse(message: Value) -> Result { + Ok(Sse { + event: None, + data: Some(message.to_string()), + id: None, + retry: None, + }) +} + +fn message_stream(rx: mpsc::Receiver) -> BoxStream<'static, Result> { + tokio_stream::wrappers::ReceiverStream::new(rx) + .map(to_sse) + .boxed() +} + +/// Scripted server: initialize -> JSON init result (2026-07-28 + session); +/// first non-initialize request POST -> SSE stream fed by `post_stream`; +/// everything else -> Accepted. Every message the client POSTs is forwarded +/// to `posted`. +#[derive(Clone)] +struct ScriptedServer { + get_stream: Arc>>>, + post_stream: Arc>>>, + posted: mpsc::UnboundedSender, +} + +impl StreamableHttpClient for ScriptedServer { + type Error = std::io::Error; + + async fn post_message( + &self, + _uri: Arc, + message: ClientJsonRpcMessage, + _session_id: Option>, + _auth_header: Option, + _custom_headers: HashMap, + ) -> Result> { + let value = serde_json::to_value(&message).expect("serialize client message"); + // Receiver drop is normal at test teardown; never panic in the transport task. + let _ = self.posted.send(value.clone()); + if value["method"] == "initialize" { + let mut info = ServerConfig::new(ServerCapabilities::default()); + info.protocol_version = ProtocolVersion::V_2026_07_28; + let response = ServerJsonRpcMessage::response( + rmcp::model::ServerResult::InitializeResult(info), + serde_json::from_value(value["id"].clone()).expect("request id"), + ); + return Ok(StreamableHttpPostResponse::Json( + response, + Some("scripted-session".into()), + )); + } + if matches!(message, ClientJsonRpcMessage::Request(_)) { + // Fail as a transport error rather than panicking: this code runs + // in the transport task, where a panic is swallowed and shows up + // only as an opaque timeout in the test. + let rx = self.post_stream.lock().await.take().ok_or_else(|| { + StreamableHttpError::Client(std::io::Error::other( + "scripted server expects exactly one non-initialize request POST", + )) + })?; + return Ok(StreamableHttpPostResponse::Sse(message_stream(rx), None)); + } + Ok(StreamableHttpPostResponse::Accepted) + } + + async fn delete_session( + &self, + _uri: Arc, + _session_id: Arc, + _auth_header: Option, + _custom_headers: HashMap, + ) -> Result<(), StreamableHttpError> { + Ok(()) + } + + async fn get_stream( + &self, + _uri: Arc, + _session_id: Option>, + _last_event_id: Option, + _auth_header: Option, + _custom_headers: HashMap, + ) -> Result>, StreamableHttpError> { + match self.get_stream.lock().await.take() { + Some(rx) => Ok(message_stream(rx)), + // Reconnect after the scripted stream ends: stay silent. + None => Ok(futures::stream::pending().boxed()), + } + } +} + +#[derive(Clone)] +struct SamplingClient { + // Every invocation is recorded here. Tests assert on the receiver (the + // negative test asserts it stays empty); a panic in this handler would + // run in a spawned task and be silently swallowed. + sampled: mpsc::UnboundedSender, +} + +impl ClientHandler for SamplingClient { + async fn create_message( + &self, + params: CreateMessageRequestParams, + _context: RequestContext, + ) -> Result { + let _ = self.sampled.send(params); + Ok(CreateMessageResult::new( + SamplingMessage::assistant_text("pong"), + "test-model".to_string(), + )) + } + + fn get_info(&self) -> ClientConfig { + ClientConfig::default() + } +} + +fn sampling_request(id: u32) -> Value { + json!({ + "jsonrpc": "2.0", + "id": id, + "method": "sampling/createMessage", + "params": { + "messages": [{ "role": "user", "content": { "type": "text", "text": "hi" } }], + "maxTokens": 16 + } + }) +} + +fn tools_list_response(id: &Value) -> Value { + json!({ "jsonrpc": "2.0", "id": id, "result": { "tools": [] } }) +} + +async fn next_posted(posted: &mut mpsc::UnboundedReceiver) -> Value { + tokio::time::timeout(Duration::from_secs(5), posted.recv()) + .await + .expect("posted message within 5s") + .expect("channel open") +} + +struct Harness { + client: rmcp::service::RunningService, + /// Every message the client POSTs to the scripted server. + posted: mpsc::UnboundedReceiver, + /// Feeds the standalone GET stream. + get_tx: mpsc::Sender, + /// Feeds the SSE stream of the in-flight tools/list POST. + post_tx: mpsc::Sender, + /// In-flight tools/list call (response withheld until the test releases it). + call: tokio::task::JoinHandle>, + tools_list_id: Value, + /// Sampling params seen by the client handler. + sampled: mpsc::UnboundedReceiver, +} + +/// Drive startup + one in-flight tools/list. +async fn setup() -> Harness { + let (get_tx, get_rx) = mpsc::channel(8); + let (post_tx, post_rx) = mpsc::channel(8); + let (posted_tx, mut posted_rx) = mpsc::unbounded_channel(); + let (sampled_tx, sampled_rx) = mpsc::unbounded_channel(); + let server = ScriptedServer { + get_stream: Arc::new(Mutex::new(Some(get_rx))), + post_stream: Arc::new(Mutex::new(Some(post_rx))), + posted: posted_tx, + }; + let transport = StreamableHttpClientTransport::with_client( + server, + StreamableHttpClientTransportConfig::with_uri("http://scripted/mcp"), + ); + let client = serve_client_with_lifecycle( + SamplingClient { + sampled: sampled_tx, + }, + transport, + ClientLifecycleMode::Initialize, + ) + .await + .expect("initialize against scripted server"); + + // initialize + notifications/initialized already posted during startup. + assert_eq!(next_posted(&mut posted_rx).await["method"], "initialize"); + assert_eq!( + next_posted(&mut posted_rx).await["method"], + "notifications/initialized" + ); + + // Unrelated outbound request, kept in flight (response withheld). + let peer = client.peer().clone(); + let call = tokio::spawn(async move { peer.list_tools(None).await }); + let tools_list = next_posted(&mut posted_rx).await; + assert_eq!(tools_list["method"], "tools/list"); + let tools_list_id = tools_list["id"].clone(); + + Harness { + client, + posted: posted_rx, + get_tx, + post_tx, + call, + tools_list_id, + sampled: sampled_rx, + } +} + +/// #1033 scenario 1: a restricted request on the standalone GET stream while +/// an unrelated outbound request is in flight must be rejected with -32602. +/// (The coarse check from #1029 incorrectly accepted this.) +#[tokio::test] +async fn restricted_request_on_get_stream_rejected_while_unrelated_request_in_flight() +-> anyhow::Result<()> { + let mut h = setup().await; + + h.get_tx.send(sampling_request(100)).await?; + + let rejection = next_posted(&mut h.posted).await; + assert_eq!( + rejection["id"], 100, + "reply to the sampling request: {rejection}" + ); + assert_eq!( + rejection["error"]["code"], -32602, + "SEP-2260: GET-stream request must be rejected even with an unrelated \ + request in flight, got {rejection}" + ); + + h.post_tx + .send(tools_list_response(&h.tools_list_id)) + .await?; + tokio::time::timeout(Duration::from_secs(5), h.call).await???; + // Rejected means rejected: the handler must not ALSO have been invoked. + assert!( + h.sampled.try_recv().is_err(), + "handler must not see the rejected sampling request" + ); + tokio::time::timeout(Duration::from_secs(5), h.client.cancel()).await??; + Ok(()) +} + +/// Positive twin: the same restricted request arriving on the SSE stream of +/// the originating POST is dispatched to the handler and answered. +#[tokio::test] +async fn restricted_request_on_originating_post_stream_is_dispatched() -> anyhow::Result<()> { + let mut h = setup().await; + + h.post_tx.send(sampling_request(200)).await?; + + let response = next_posted(&mut h.posted).await; + assert_eq!( + response["id"], 200, + "reply to the sampling request: {response}" + ); + assert_eq!( + response["result"]["model"], "test-model", + "request on the originating POST stream must reach the handler, got {response}" + ); + tokio::time::timeout(Duration::from_secs(5), h.sampled.recv()) + .await? + .expect("handler invoked"); + + h.post_tx + .send(tools_list_response(&h.tools_list_id)) + .await?; + tokio::time::timeout(Duration::from_secs(5), h.call).await???; + tokio::time::timeout(Duration::from_secs(5), h.client.cancel()).await??; + Ok(()) +} diff --git a/vendor/rmcp/tests/test_sep_2260_stream_routing.rs b/vendor/rmcp/tests/test_sep_2260_stream_routing.rs new file mode 100644 index 00000000..e883ccd5 --- /dev/null +++ b/vendor/rmcp/tests/test_sep_2260_stream_routing.rs @@ -0,0 +1,165 @@ +//! SEP-2260 end-to-end: in-handler server→client requests ride the originating +//! POST's SSE stream, never the standalone GET stream. +#![cfg(not(feature = "local"))] + +use std::{collections::BTreeMap, sync::Arc, time::Duration}; + +use futures::StreamExt; +use rmcp::{ + ErrorData as McpError, RoleServer, ServerHandler, + model::{ + CallToolRequestParams, CallToolResponse, CallToolResult, ContentBlock, ElicitRequestParams, + ElicitationSchema, ServerCapabilities, ServerConfig, + }, + service::RequestContext, + transport::streamable_http_server::{ + StreamableHttpServerConfig, StreamableHttpService, session::local::LocalSessionManager, + }, +}; +use serde_json::json; +use tokio_util::sync::CancellationToken; + +#[derive(Clone)] +struct ElicitingServer; + +impl ServerHandler for ElicitingServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::builder().enable_tools().build()) + } + + async fn call_tool( + &self, + _request: CallToolRequestParams, + context: RequestContext, + ) -> Result { + // Never answered: the test only checks the request is emitted on the right stream. + let _ = context + .peer + .create_elicitation(ElicitRequestParams::FormElicitationParams { + meta: None, + message: "need input".to_string(), + requested_schema: ElicitationSchema::new(BTreeMap::new()), + }) + .await; + Ok(CallToolResult::success(vec![ContentBlock::text("done")]).into()) + } +} + +async fn start_server(ct: CancellationToken) -> String { + let service = StreamableHttpService::new( + move || Ok(ElicitingServer), + Arc::new(LocalSessionManager::default()), + StreamableHttpServerConfig::default().with_cancellation_token(ct.child_token()), + ); + let router = axum::Router::new().nest_service("/mcp", service); + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let url = format!( + "http://127.0.0.1:{}/mcp", + listener.local_addr().unwrap().port() + ); + let ct = ct.clone(); + tokio::spawn(async move { + axum::serve(listener, router) + .with_graceful_shutdown(async move { ct.cancelled().await }) + .await + .unwrap(); + }); + tokio::time::sleep(Duration::from_millis(100)).await; + url +} + +/// Read an SSE byte stream until `needle` appears or timeout. +async fn sse_contains(resp: reqwest::Response, needle: &str, timeout: Duration) -> bool { + let mut stream = resp.bytes_stream(); + tokio::time::timeout(timeout, async { + let mut buffer = String::new(); + while let Some(Ok(chunk)) = stream.next().await { + buffer.push_str(&String::from_utf8_lossy(&chunk)); + if buffer.contains(needle) { + return true; + } + } + false + }) + .await + .unwrap_or(false) +} + +#[tokio::test] +async fn elicitation_rides_originating_post_stream_not_standalone_get() { + let ct = CancellationToken::new(); + let url = start_server(ct.clone()).await; + let client = reqwest::Client::new(); + + // 2025-11-25 is the latest session-carrying version; SEP-2567 serves + // 2026-07-28+ statelessly, with no standalone GET stream to test against. + let resp = client + .post(&url) + .header("Accept", "text/event-stream, application/json") + .header("Content-Type", "application/json") + .json(&json!({ + "jsonrpc": "2.0", "id": 1, "method": "initialize", + "params": { + "protocolVersion": "2025-11-25", + "capabilities": { "elicitation": {} }, + "clientInfo": { "name": "test-client", "version": "1.0.0" } + } + })) + .send() + .await + .unwrap(); + assert!(resp.status().is_success()); + let session_id = resp + .headers() + .get("Mcp-Session-Id") + .expect("session id") + .to_str() + .unwrap() + .to_string(); + + client + .post(&url) + .header("Accept", "text/event-stream, application/json") + .header("Content-Type", "application/json") + .header("Mcp-Session-Id", &session_id) + .json(&json!({"jsonrpc": "2.0", "method": "notifications/initialized"})) + .send() + .await + .unwrap(); + + // Standalone GET stream — must NEVER carry the elicitation request. + let get_stream = client + .get(&url) + .header("Accept", "text/event-stream") + .header("Mcp-Session-Id", &session_id) + .send() + .await + .unwrap(); + assert_eq!(get_stream.status(), 200); + + // The in-handler elicitation must appear on this tools/call SSE stream. + let post_stream = client + .post(&url) + .header("Accept", "text/event-stream, application/json") + .header("Content-Type", "application/json") + .header("Mcp-Session-Id", &session_id) + .json(&json!({ + "jsonrpc": "2.0", "id": 2, "method": "tools/call", + "params": { "name": "ask", "arguments": {} } + })) + .send() + .await + .unwrap(); + assert!(post_stream.status().is_success()); + + assert!( + sse_contains(post_stream, "elicitation/create", Duration::from_secs(5)).await, + "elicitation request must be delivered on the originating POST SSE stream" + ); + assert!( + !sse_contains(get_stream, "elicitation/create", Duration::from_millis(500)).await, + "standalone GET stream must not carry the elicitation request" + ); + + ct.cancel(); +} diff --git a/vendor/rmcp/tests/test_server_discover.rs b/vendor/rmcp/tests/test_server_discover.rs new file mode 100644 index 00000000..f2ca3df2 --- /dev/null +++ b/vendor/rmcp/tests/test_server_discover.rs @@ -0,0 +1,255 @@ +use rmcp::model::{ + ClientCapabilities, ClientJsonRpcMessage, ClientRequest, DiscoverResult, ErrorCode, ErrorData, + JsonRpcRequest, JsonRpcResponse, ProtocolVersion, ServerJsonRpcMessage, ServerResult, +}; +use serde_json::json; + +#[test] +fn discover_request_deserializes_with_request_meta() { + let message: ClientJsonRpcMessage = serde_json::from_value(json!({ + "jsonrpc": "2.0", + "id": 1, + "method": "server/discover", + "params": { + "_meta": { + "io.modelcontextprotocol/protocolVersion": "2026-07-28", + "io.modelcontextprotocol/clientInfo": { + "name": "test-client", + "version": "1.0.0" + }, + "io.modelcontextprotocol/clientCapabilities": {} + } + } + })) + .expect("discover request should deserialize"); + + let ClientJsonRpcMessage::Request(JsonRpcRequest { request, .. }) = message else { + panic!("expected request"); + }; + let ClientRequest::DiscoverRequest(request) = request else { + panic!("expected discover request"); + }; + + assert_eq!( + request + .extensions + .get::() + .and_then(|meta| meta.protocol_version()), + Some(ProtocolVersion::V_2026_07_28) + ); +} + +#[test] +fn discover_result_deserializes_to_typed_variant() { + let message: ServerJsonRpcMessage = serde_json::from_value(json!({ + "jsonrpc": "2.0", + "id": 1, + "result": { + "resultType": "complete", + "supportedVersions": ["2025-11-25", "2026-07-28"], + "capabilities": { "tools": {} }, + "serverInfo": { + "name": "test-server", + "version": "1.0.0" + }, + "ttlMs": 0, + "cacheScope": "private" + } + })) + .expect("discover result should deserialize"); + + let ServerJsonRpcMessage::Response(JsonRpcResponse { result, .. }) = message else { + panic!("expected response"); + }; + let ServerResult::DiscoverResult(DiscoverResult { + supported_versions, .. + }) = result + else { + panic!("expected discover result"); + }; + + assert_eq!( + supported_versions, + vec![ProtocolVersion::V_2025_11_25, ProtocolVersion::V_2026_07_28] + ); +} + +#[test] +fn discover_result_accepts_server_info_in_namespaced_metadata() { + let message: ServerJsonRpcMessage = serde_json::from_value(json!({ + "jsonrpc": "2.0", + "id": 1, + "result": { + "resultType": "complete", + "supportedVersions": ["2026-07-28"], + "capabilities": {}, + "ttlMs": 0, + "cacheScope": "private", + "_meta": { + "io.modelcontextprotocol/serverInfo": { + "name": "conformance-mock-server", + "version": "1.0.0" + }, + "unrelated": { "preserved": true } + } + } + })) + .expect("discovery response with namespaced server info should deserialize"); + + let ServerJsonRpcMessage::Response(JsonRpcResponse { result, .. }) = message else { + panic!("expected response"); + }; + let ServerResult::DiscoverResult(result) = result else { + panic!("expected discovery response, not a tool-call result"); + }; + + let server_info = result.server_info().expect("server info should be present"); + assert_eq!(server_info.name, "conformance-mock-server"); + assert_eq!(server_info.version, "1.0.0"); + + let metadata = result.meta.expect("discovery metadata should be preserved"); + assert_eq!( + metadata.0.get("io.modelcontextprotocol/serverInfo"), + Some(&json!({ + "name": "conformance-mock-server", + "version": "1.0.0" + })) + ); + assert_eq!( + metadata.0.get("unrelated"), + Some(&json!({ "preserved": true })) + ); +} + +#[test] +fn discover_result_serializes_server_info_in_namespaced_metadata() { + let mut result = DiscoverResult::new( + vec![ProtocolVersion::V_2026_07_28], + rmcp::model::ServerCapabilities::default(), + ); + result.meta = Some(rmcp::model::MetaObject( + json!({ + "io.modelcontextprotocol/serverInfo": { + "name": "stale-server", + "version": "0.1.0" + }, + "unrelated": { "preserved": true } + }) + .as_object() + .expect("metadata is an object") + .clone(), + )); + result.set_server_info(rmcp::model::Implementation::new("test-server", "1.0.0")); + + let serialized = serde_json::to_value(result).expect("serialize discovery result"); + assert!(serialized.get("serverInfo").is_none()); + assert_eq!( + serialized["_meta"]["io.modelcontextprotocol/serverInfo"], + json!({ + "name": "test-server", + "version": "1.0.0" + }) + ); + assert_eq!( + serialized["_meta"]["unrelated"], + json!({ "preserved": true }) + ); +} + +#[test] +fn discover_result_ignores_legacy_top_level_server_info() { + let result: DiscoverResult = serde_json::from_value(json!({ + "resultType": "complete", + "supportedVersions": ["2026-07-28"], + "capabilities": {}, + "serverInfo": { + "name": "top-level-server", + "version": "2.0.0" + }, + "ttlMs": 0, + "cacheScope": "private", + "_meta": { + "io.modelcontextprotocol/serverInfo": { + "name": "metadata-server", + "version": "1.0.0" + }, + "unrelated": true + } + })) + .expect("top-level server info should remain supported"); + + let server_info = result + .server_info() + .expect("namespaced server info is present"); + assert_eq!(server_info.name, "metadata-server"); + assert_eq!(server_info.version, "1.0.0"); + assert_eq!( + result + .meta + .as_ref() + .and_then(|metadata| metadata.0.get("unrelated")), + Some(&json!(true)) + ); +} + +#[test] +fn discover_result_allows_missing_or_malformed_optional_server_info() { + let result = json!({ + "resultType": "complete", + "supportedVersions": ["2026-07-28"], + "capabilities": {}, + "ttlMs": 0, + "cacheScope": "private", + "_meta": { "unrelated": true } + }); + + let result = + serde_json::from_value::(result).expect("server info metadata is optional"); + assert_eq!(result.server_info(), None); + + let malformed_server_info = json!({ + "resultType": "complete", + "supportedVersions": ["2026-07-28"], + "capabilities": {}, + "ttlMs": 0, + "cacheScope": "private", + "_meta": { "io.modelcontextprotocol/serverInfo": { "name": "missing-version" } } + }); + + let result = serde_json::from_value::(malformed_server_info) + .expect("opaque metadata should not prevent deserialization"); + assert_eq!(result.server_info(), None); +} + +#[test] +fn unsupported_protocol_version_error_matches_draft_schema() { + let error = ErrorData::unsupported_protocol_version( + ProtocolVersion::V_2026_07_28, + &[ProtocolVersion::V_2025_11_25], + ); + + assert_eq!(error.code, ErrorCode::UNSUPPORTED_PROTOCOL_VERSION); + assert_eq!( + error.data, + Some(json!({ + "requested": "2026-07-28", + "supported": ["2025-11-25"] + })) + ); +} + +#[test] +fn missing_required_capability_error_matches_draft_schema() { + let required = ClientCapabilities::builder().enable_elicitation().build(); + let error = ErrorData::missing_required_client_capability(required); + + assert_eq!(error.code, ErrorCode::MISSING_REQUIRED_CLIENT_CAPABILITY); + assert_eq!( + error.data, + Some(json!({ + "requiredCapabilities": { + "elicitation": {} + } + })) + ); +} diff --git a/vendor/rmcp/tests/test_server_discover_client.rs b/vendor/rmcp/tests/test_server_discover_client.rs new file mode 100644 index 00000000..9046f6b3 --- /dev/null +++ b/vendor/rmcp/tests/test_server_discover_client.rs @@ -0,0 +1,77 @@ +#![cfg(all(feature = "client", not(feature = "local")))] + +use rmcp::{ + ClientHandler, ServerHandler, ServiceExt, + model::{ + ClientCapabilities, Implementation, ProtocolVersion, RequestMetaObject, ServerCapabilities, + ServerConfig, + }, + select_protocol_version, +}; + +#[derive(Clone, Default)] +struct DiscoveryServer; + +impl ServerHandler for DiscoveryServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::builder().enable_tools().build()) + .with_server_info(Implementation::new("discovery-server", "1.0.0")) + } +} + +#[derive(Clone, Default)] +struct DiscoveryClient; + +impl ClientHandler for DiscoveryClient {} + +#[test] +fn select_protocol_version_uses_client_preference_order() { + let selected = select_protocol_version( + &[ProtocolVersion::V_2026_07_28, ProtocolVersion::V_2025_11_25], + &[ProtocolVersion::V_2025_11_25, ProtocolVersion::V_2026_07_28], + ); + + assert_eq!(selected, Some(ProtocolVersion::V_2026_07_28)); +} + +#[test] +fn select_protocol_version_returns_none_without_overlap() { + let selected = select_protocol_version( + &[ProtocolVersion::V_2026_07_28], + &[ProtocolVersion::V_2025_11_25], + ); + + assert_eq!(selected, None); +} + +#[tokio::test] +async fn client_discover_helper_returns_typed_result() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + tokio::spawn(async move { + let _ = DiscoveryServer + .serve(server_transport) + .await + .expect("server should start") + .waiting() + .await; + }); + let client = DiscoveryClient + .serve(client_transport) + .await + .expect("client should connect"); + let mut meta = RequestMetaObject::new(); + meta.set_protocol_version(ProtocolVersion::V_2026_07_28); + meta.set_client_info(Implementation::new("discovery-client", "1.0.0")); + meta.set_client_capabilities(ClientCapabilities::default()); + + let result = client + .discover(meta) + .await + .expect("discover should succeed"); + + assert_eq!( + result.server_info(), + Some(Implementation::new("discovery-server", "1.0.0")) + ); + client.cancel().await.expect("client should cancel"); +} diff --git a/vendor/rmcp/tests/test_server_discover_http.rs b/vendor/rmcp/tests/test_server_discover_http.rs new file mode 100644 index 00000000..7762c979 --- /dev/null +++ b/vendor/rmcp/tests/test_server_discover_http.rs @@ -0,0 +1,380 @@ +#![cfg(all( + not(feature = "local"), + feature = "reqwest", + feature = "transport-streamable-http-server" +))] + +use std::borrow::Cow; + +use rmcp::{ + ServerHandler, + model::{Implementation, ProtocolVersion, ServerCapabilities, ServerConfig}, + transport::streamable_http_server::{ + StreamableHttpServerConfig, StreamableHttpService, session::local::LocalSessionManager, + }, +}; +use serde_json::json; +use tokio_util::sync::CancellationToken; + +#[derive(Clone, Default)] +struct DiscoveryServer; + +impl ServerHandler for DiscoveryServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::builder().enable_tools().build()) + .with_server_info(Implementation::new("discovery-server", "1.0.0")) + .with_instructions("Use the tools carefully") + } + + fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]> { + Cow::Borrowed(&[ProtocolVersion::V_2025_11_25]) + } +} + +async fn spawn_server(json_response: bool) -> (reqwest::Client, String, CancellationToken) { + spawn_server_with_legacy_session_mode(json_response, false).await +} + +async fn spawn_server_with_legacy_session_mode( + json_response: bool, + legacy_session_mode: bool, +) -> (reqwest::Client, String, CancellationToken) { + let cancellation_token = CancellationToken::new(); + let config = StreamableHttpServerConfig::default() + .with_legacy_session_mode(legacy_session_mode) + .with_json_response(json_response) + .with_sse_keep_alive(None) + .with_cancellation_token(cancellation_token.clone()); + let service: StreamableHttpService = + StreamableHttpService::new(|| Ok(DiscoveryServer), Default::default(), config); + let router = axum::Router::new().nest_service("/mcp", service); + let listener = tokio::net::TcpListener::bind("127.0.0.1:0") + .await + .expect("listener should bind"); + let address = listener.local_addr().expect("listener should have address"); + + tokio::spawn({ + let cancellation_token = cancellation_token.clone(); + async move { + let _ = axum::serve(listener, router) + .with_graceful_shutdown(async move { + cancellation_token.cancelled_owned().await; + }) + .await; + } + }); + + ( + reqwest::Client::new(), + format!("http://{address}/mcp"), + cancellation_token, + ) +} + +fn discover_body(version: Option<&str>) -> serde_json::Value { + let meta = version.map(|version| { + json!({ + "io.modelcontextprotocol/protocolVersion": version, + "io.modelcontextprotocol/clientInfo": { + "name": "test-client", + "version": "1.0.0" + }, + "io.modelcontextprotocol/clientCapabilities": {} + }) + }); + json!({ + "jsonrpc": "2.0", + "id": 1, + "method": "server/discover", + "params": meta.map(|meta| json!({ "_meta": meta })).unwrap_or_else(|| json!({})) + }) +} + +async fn post_discover( + client: &reqwest::Client, + url: &str, + header_version: &str, + body_version: Option<&str>, +) -> reqwest::Response { + client + .post(url) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("MCP-Protocol-Version", header_version) + .header("Mcp-Method", "server/discover") + .json(&discover_body(body_version)) + .send() + .await + .expect("discover request should send") +} + +#[tokio::test] +async fn discover_returns_server_metadata_without_session() { + let (client, url, cancellation_token) = spawn_server(true).await; + + let response = post_discover(&client, &url, "2025-11-25", Some("2025-11-25")).await; + + assert_eq!(response.status(), 200); + let body: serde_json::Value = response.json().await.expect("response should be JSON"); + assert_eq!( + body["result"], + json!({ + "resultType": "complete", + "supportedVersions": ["2025-11-25"], + "capabilities": { "tools": {} }, + "_meta": { + "io.modelcontextprotocol/serverInfo": { + "name": "discovery-server", + "version": "1.0.0" + } + }, + "instructions": "Use the tools carefully", + "ttlMs": 0, + "cacheScope": "private" + }) + ); + + cancellation_token.cancel(); +} + +#[tokio::test] +async fn discover_does_not_require_initialization_in_legacy_session_mode() { + let (client, url, cancellation_token) = spawn_server_with_legacy_session_mode(true, true).await; + + let response = post_discover(&client, &url, "2025-11-25", Some("2025-11-25")).await; + + assert_eq!(response.status(), 200); + assert!(response.headers().get("Mcp-Session-Id").is_none()); + + cancellation_token.cancel(); +} + +#[tokio::test] +async fn discover_rejects_unsupported_version_with_http_400() { + let (client, url, cancellation_token) = spawn_server(true).await; + + let response = post_discover(&client, &url, "2026-07-28", Some("2026-07-28")).await; + + assert_eq!(response.status(), 400); + let body: serde_json::Value = response.json().await.expect("response should be JSON"); + assert_eq!(body["error"]["code"], -32022); + assert_eq!( + body["error"]["data"], + json!({ + "requested": "2026-07-28", + "supported": ["2025-11-25"] + }) + ); + + cancellation_token.cancel(); +} + +#[tokio::test] +async fn discover_rejects_unknown_version_with_typed_error() { + let (client, url, cancellation_token) = spawn_server(true).await; + + let response = post_discover(&client, &url, "2099-01-01", Some("2099-01-01")).await; + + assert_eq!(response.status(), 400); + let body: serde_json::Value = response.json().await.expect("response should be JSON"); + assert_eq!(body["error"]["code"], -32022); + + cancellation_token.cancel(); +} + +#[tokio::test] +async fn regular_request_rejects_server_unsupported_meta_version() { + let (client, url, cancellation_token) = spawn_server(true).await; + let body = json!({ + "jsonrpc": "2.0", + "id": 2, + "method": "tools/list", + "params": { + "_meta": { + "io.modelcontextprotocol/protocolVersion": "2026-07-28" + } + } + }); + + let response = client + .post(&url) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("MCP-Protocol-Version", "2026-07-28") + .header("Mcp-Method", "tools/list") + .json(&body) + .send() + .await + .expect("request should send"); + + assert_eq!(response.status(), 400); + let body: serde_json::Value = response.json().await.expect("response should be JSON"); + assert_eq!(body["error"]["code"], -32022); + + cancellation_token.cancel(); +} + +#[tokio::test] +async fn unknown_rpc_uses_http_404_for_per_request_protocol() { + let (client, url, cancellation_token) = spawn_server(true).await; + let body = json!({ + "jsonrpc": "2.0", + "id": 3, + "method": "unknown/method", + "params": { + "_meta": { + "io.modelcontextprotocol/protocolVersion": "2025-11-25" + } + } + }); + + let response = client + .post(&url) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("MCP-Protocol-Version", "2025-11-25") + .json(&body) + .send() + .await + .expect("request should send"); + + assert_eq!(response.status(), 404); + + cancellation_token.cancel(); +} + +#[tokio::test] +async fn legacy_unknown_rpc_preserves_http_200_jsonrpc_error() { + let (client, url, cancellation_token) = spawn_server(true).await; + let body = json!({ + "jsonrpc": "2.0", + "id": 5, + "method": "unknown/method", + "params": {} + }); + + let response = client + .post(&url) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("MCP-Protocol-Version", "2025-11-25") + .json(&body) + .send() + .await + .expect("request should send"); + + assert_eq!(response.status(), 200); + let body: serde_json::Value = response.json().await.expect("response should be JSON"); + assert_eq!(body["error"]["code"], -32601); + + cancellation_token.cancel(); +} + +#[tokio::test] +async fn discover_rejects_header_meta_version_mismatch() { + let (client, url, cancellation_token) = spawn_server(true).await; + + let response = post_discover(&client, &url, "2026-07-28", Some("2025-11-25")).await; + + assert_eq!(response.status(), 400); + + cancellation_token.cancel(); +} + +#[tokio::test] +async fn discover_rejects_missing_request_meta() { + let (client, url, cancellation_token) = spawn_server(true).await; + + let response = post_discover(&client, &url, "2025-11-25", None).await; + + assert_eq!(response.status(), 400); + let body: serde_json::Value = response.json().await.expect("response should be JSON"); + assert_eq!(body["error"]["code"], -32602); + + cancellation_token.cancel(); +} + +#[tokio::test] +async fn discover_rejects_missing_client_capabilities() { + let (client, url, cancellation_token) = spawn_server(true).await; + let body = json!({ + "jsonrpc": "2.0", + "id": 4, + "method": "server/discover", + "params": { + "_meta": { + "io.modelcontextprotocol/protocolVersion": "2025-11-25", + "io.modelcontextprotocol/clientInfo": { + "name": "test-client", + "version": "1.0.0" + } + } + } + }); + + let response = client + .post(&url) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("MCP-Protocol-Version", "2025-11-25") + .json(&body) + .send() + .await + .expect("request should send"); + + assert_eq!(response.status(), 400); + let body: serde_json::Value = response.json().await.expect("response should be JSON"); + assert_eq!(body["error"]["code"], -32602); + + cancellation_token.cancel(); +} + +#[tokio::test] +async fn discover_accepts_missing_optional_client_info() { + let (client, url, cancellation_token) = spawn_server(true).await; + let body = json!({ + "jsonrpc": "2.0", + "id": 5, + "method": "server/discover", + "params": { + "_meta": { + "io.modelcontextprotocol/protocolVersion": "2025-11-25", + "io.modelcontextprotocol/clientCapabilities": {} + } + } + }); + + let response = client + .post(&url) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("MCP-Protocol-Version", "2025-11-25") + .json(&body) + .send() + .await + .expect("request should send"); + + assert_eq!(response.status(), 200); + let body: serde_json::Value = response.json().await.expect("response should be JSON"); + assert!(body.get("result").is_some()); + + cancellation_token.cancel(); +} + +#[tokio::test] +async fn discover_error_uses_http_400_when_sse_is_configured() { + let (client, url, cancellation_token) = spawn_server(false).await; + + let response = post_discover(&client, &url, "2026-07-28", Some("2026-07-28")).await; + + assert_eq!(response.status(), 400); + assert_eq!( + response + .headers() + .get("Content-Type") + .and_then(|value| value.to_str().ok()), + Some("application/json") + ); + + cancellation_token.cancel(); +} diff --git a/vendor/rmcp/tests/test_server_initialization.rs b/vendor/rmcp/tests/test_server_initialization.rs new file mode 100644 index 00000000..03661219 --- /dev/null +++ b/vendor/rmcp/tests/test_server_initialization.rs @@ -0,0 +1,408 @@ +// cargo test --features "client" --package rmcp -- server_init +#![cfg(all(feature = "client", not(feature = "local")))] +mod common; + +use common::handlers::TestServer; +use rmcp::{ + ServerHandler, ServiceExt, + model::{ + ClientJsonRpcMessage, ProtocolVersion, ServerCapabilities, ServerConfig, + ServerJsonRpcMessage, ServerResult, + }, + transport::{IntoTransport, Transport}, +}; + +fn msg(raw: &str) -> ClientJsonRpcMessage { + serde_json::from_str(raw).expect("invalid test message JSON") +} + +fn init_request() -> ClientJsonRpcMessage { + msg(r#"{ + "jsonrpc": "2.0", + "id": 1, + "method": "initialize", + "params": { + "protocolVersion": "2025-11-25", + "capabilities": {}, + "clientInfo": { "name": "test-client", "version": "0.0.1" } + } + }"#) +} + +fn initialized_notification() -> ClientJsonRpcMessage { + msg(r#"{ "jsonrpc": "2.0", "method": "notifications/initialized" }"#) +} + +fn set_level_request(id: u64) -> ClientJsonRpcMessage { + msg(&format!( + r#"{{ "jsonrpc": "2.0", "id": {id}, "method": "logging/setLevel", "params": {{ "level": "info" }} }}"# + )) +} + +fn ping_request(id: u64) -> ClientJsonRpcMessage { + msg(&format!( + r#"{{ "jsonrpc": "2.0", "id": {id}, "method": "ping" }}"# + )) +} + +fn list_tools_request(id: u64) -> ClientJsonRpcMessage { + msg(&format!( + r#"{{ "jsonrpc": "2.0", "id": {id}, "method": "tools/list" }}"# + )) +} + +async fn do_initialize(client: &mut impl Transport) { + client.send(init_request()).await.unwrap(); + let _response = client.receive().await.unwrap(); +} + +// Server handles setLevel sent before initialized notification (processed by serve_inner). +#[tokio::test] +async fn server_init_set_level_response_is_empty_result() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let _server = tokio::spawn(async move { TestServer::new().serve(server_transport).await }); + let mut client = IntoTransport::::into_transport(client_transport); + + do_initialize(&mut client).await; + client.send(set_level_request(2)).await.unwrap(); + + // The handler may send logging notifications before the response; + // skip notifications to find the EmptyResult response. + let response = loop { + let msg = client.receive().await.unwrap(); + if matches!(msg, ServerJsonRpcMessage::Response(_)) { + break msg; + } + }; + assert!( + matches!( + response, + ServerJsonRpcMessage::Response(ref r) + if matches!(r.result, ServerResult::EmptyResult(_)) + ), + "expected EmptyResult for setLevel, got: {response:?}" + ); +} + +// Server initializes successfully when setLevel is sent before the initialized notification. +#[tokio::test] +async fn server_init_succeeds_after_set_level_before_initialized() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let server_handle = + tokio::spawn(async move { TestServer::new().serve(server_transport).await }); + let mut client = IntoTransport::::into_transport(client_transport); + + do_initialize(&mut client).await; + client.send(set_level_request(2)).await.unwrap(); + // Skip notifications until we get the response + loop { + let msg = client.receive().await.unwrap(); + if matches!(msg, ServerJsonRpcMessage::Response(_)) { + break; + } + } + client.send(initialized_notification()).await.unwrap(); + + let result = server_handle.await.unwrap(); + assert!( + result.is_ok(), + "server should initialize successfully after setLevel" + ); + result.unwrap().cancel().await.unwrap(); +} + +// Server responds with EmptyResult to ping received before initialize request. +#[tokio::test] +async fn server_init_ping_response_is_empty_result_before_initialize() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let _server = tokio::spawn(async move { TestServer::new().serve(server_transport).await }); + let mut client = IntoTransport::::into_transport(client_transport); + + client.send(ping_request(1)).await.unwrap(); + + let response = client.receive().await.unwrap(); + assert!( + matches!( + response, + ServerJsonRpcMessage::Response(ref r) + if matches!(r.result, ServerResult::EmptyResult(_)) + ), + "expected EmptyResult for pre-initialize ping, got: {response:?}" + ); +} + +// Server initializes successfully when ping is sent before the initialize request. +#[tokio::test] +async fn server_init_succeeds_after_ping_before_initialize() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let server_handle = + tokio::spawn(async move { TestServer::new().serve(server_transport).await }); + let mut client = IntoTransport::::into_transport(client_transport); + + client.send(ping_request(1)).await.unwrap(); + let _pong = client.receive().await.unwrap(); + do_initialize(&mut client).await; + client.send(initialized_notification()).await.unwrap(); + + let result = server_handle.await.unwrap(); + assert!( + result.is_ok(), + "server should initialize successfully after pre-initialize ping" + ); + result.unwrap().cancel().await.unwrap(); +} + +// Server responds with EmptyResult to ping received before initialized. +#[tokio::test] +async fn server_init_ping_response_is_empty_result() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let _server = tokio::spawn(async move { TestServer::new().serve(server_transport).await }); + let mut client = IntoTransport::::into_transport(client_transport); + + do_initialize(&mut client).await; + client.send(ping_request(2)).await.unwrap(); + + let response = client.receive().await.unwrap(); + assert!( + matches!( + response, + ServerJsonRpcMessage::Response(ref r) + if matches!(r.result, ServerResult::EmptyResult(_)) + ), + "expected EmptyResult for ping, got: {response:?}" + ); +} + +// Server initializes successfully when ping is sent before the initialized notification. +#[tokio::test] +async fn server_init_succeeds_after_ping_before_initialized() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let server_handle = + tokio::spawn(async move { TestServer::new().serve(server_transport).await }); + let mut client = IntoTransport::::into_transport(client_transport); + + do_initialize(&mut client).await; + client.send(ping_request(2)).await.unwrap(); + let _response = client.receive().await.unwrap(); + client.send(initialized_notification()).await.unwrap(); + + let result = server_handle.await.unwrap(); + assert!( + result.is_ok(), + "server should initialize successfully after ping" + ); + result.unwrap().cancel().await.unwrap(); +} + +// Server buffers tools/list sent before initialized and processes it after initialization. +#[tokio::test] +async fn server_init_buffers_request_before_initialized() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let server_handle = + tokio::spawn(async move { TestServer::new().serve(server_transport).await }); + let mut client = IntoTransport::::into_transport(client_transport); + + do_initialize(&mut client).await; + // Send tools/list before initialized notification + client.send(list_tools_request(2)).await.unwrap(); + // Now send initialized notification + client.send(initialized_notification()).await.unwrap(); + + // The buffered tools/list should be processed — expect a response + let response = client.receive().await.unwrap(); + assert!( + matches!(response, ServerJsonRpcMessage::Response(_)), + "expected response for buffered tools/list, got: {response:?}" + ); + + let result = server_handle.await.unwrap(); + assert!( + result.is_ok(), + "server should initialize successfully when buffering pre-init messages" + ); + result.unwrap().cancel().await.unwrap(); +} + +fn init_request_with_version(v: &str) -> ClientJsonRpcMessage { + msg(&format!( + r#"{{ + "jsonrpc": "2.0", + "id": 1, + "method": "initialize", + "params": {{ + "protocolVersion": "{v}", + "capabilities": {{}}, + "clientInfo": {{ "name": "test-client", "version": "0.0.1" }} + }} + }}"# + )) +} + +async fn negotiate_version(handler: H, client_version: &str) -> ProtocolVersion +where + H: ServerHandler + 'static, +{ + let (server_transport, client_transport) = tokio::io::duplex(4096); + let _server = tokio::spawn(async move { handler.serve(server_transport).await }); + let mut client = IntoTransport::::into_transport(client_transport); + + client + .send(init_request_with_version(client_version)) + .await + .unwrap(); + let response = client.receive().await.unwrap(); + let ServerJsonRpcMessage::Response(r) = response else { + panic!("expected initialize response, got {response:?}"); + }; + let ServerResult::InitializeResult(init) = r.result else { + panic!("expected InitializeResult"); + }; + init.protocol_version +} + +#[tokio::test] +async fn server_echoes_client_protocol_version_when_known_old() { + let negotiated = negotiate_version(TestServer::new(), "2024-11-05").await; + assert_eq!(negotiated, ProtocolVersion::V_2024_11_05); +} + +// `initialize` can only answer with a version that still has a handshake, so a +// client naming `LATEST` gets `LATEST_WITH_INITIALIZE` instead. +#[tokio::test] +async fn server_falls_back_to_newest_handshake_version_when_client_requests_latest() { + let negotiated = negotiate_version(TestServer::new(), ProtocolVersion::LATEST.as_str()).await; + assert_eq!(negotiated, ProtocolVersion::LATEST_WITH_INITIALIZE); +} + +#[tokio::test] +async fn server_falls_back_when_client_protocol_version_unknown() { + let negotiated = negotiate_version(TestServer::new(), "2099-99-99").await; + assert_eq!(negotiated, ProtocolVersion::LATEST_WITH_INITIALIZE); +} + +struct PinnedServer; + +impl ServerHandler for PinnedServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::builder().build()) + .with_protocol_version(ProtocolVersion::V_2025_06_18) + } +} + +#[tokio::test] +async fn server_pinned_version_does_not_override_known_client_request() { + let negotiated = negotiate_version( + PinnedServer, + ProtocolVersion::LATEST_WITH_INITIALIZE.as_str(), + ) + .await; + assert_eq!(negotiated, ProtocolVersion::LATEST_WITH_INITIALIZE); +} + +#[tokio::test] +async fn server_pinned_version_used_as_fallback_when_client_requests_latest() { + let negotiated = negotiate_version(PinnedServer, ProtocolVersion::LATEST.as_str()).await; + assert_eq!(negotiated, ProtocolVersion::V_2025_06_18); +} + +#[tokio::test] +async fn server_pinned_version_used_as_fallback_for_unknown_client_request() { + let negotiated = negotiate_version(PinnedServer, "2099-99-99").await; + assert_eq!(negotiated, ProtocolVersion::V_2025_06_18); +} + +fn duplicate_init_request(id: u64, version: &str) -> ClientJsonRpcMessage { + msg(&format!( + r#"{{ + "jsonrpc": "2.0", + "id": {id}, + "method": "initialize", + "params": {{ + "protocolVersion": "{version}", + "capabilities": {{ "sampling": {{}} }}, + "clientInfo": {{ "name": "renegotiated-client", "version": "9.9.9" }} + }} + }}"# + )) +} + +#[tokio::test] +async fn server_accepts_duplicate_initialize() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let _server = tokio::spawn(async move { TestServer::new().serve(server_transport).await }); + let mut client = IntoTransport::::into_transport(client_transport); + + do_initialize(&mut client).await; + client.send(initialized_notification()).await.unwrap(); + + client + .send(duplicate_init_request(2, "2025-11-25")) + .await + .unwrap(); + let response = client.receive().await.unwrap(); + assert!( + matches!(response, ServerJsonRpcMessage::Response(_)), + "expected successful InitializeResult, got: {response:?}" + ); +} + +#[tokio::test] +async fn server_session_remains_usable_after_renegotiation() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let _server = tokio::spawn(async move { TestServer::new().serve(server_transport).await }); + let mut client = IntoTransport::::into_transport(client_transport); + + do_initialize(&mut client).await; + client.send(initialized_notification()).await.unwrap(); + client + .send(duplicate_init_request(2, "2025-11-25")) + .await + .unwrap(); + let _renegotiated = client.receive().await.unwrap(); + + client.send(ping_request(3)).await.unwrap(); + let pong = client.receive().await.unwrap(); + assert!( + matches!( + pong, + ServerJsonRpcMessage::Response(ref r) + if matches!(r.result, ServerResult::EmptyResult(_)) + ), + "expected EmptyResult ping after renegotiation, got: {pong:?}" + ); +} + +// Server buffers multiple requests before initialized and processes them in order. +#[tokio::test] +async fn server_init_buffers_multiple_requests_before_initialized() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let server_handle = + tokio::spawn(async move { TestServer::new().serve(server_transport).await }); + let mut client = IntoTransport::::into_transport(client_transport); + + do_initialize(&mut client).await; + // Send two requests before initialized + client.send(list_tools_request(2)).await.unwrap(); + client.send(ping_request(3)).await.unwrap(); + // Now send initialized notification + client.send(initialized_notification()).await.unwrap(); + + // Both buffered messages should get responses + let response1 = client.receive().await.unwrap(); + let response2 = client.receive().await.unwrap(); + assert!( + matches!(response1, ServerJsonRpcMessage::Response(_)), + "expected response for first buffered message, got: {response1:?}" + ); + assert!( + matches!(response2, ServerJsonRpcMessage::Response(_)), + "expected response for second buffered message, got: {response2:?}" + ); + + let result = server_handle.await.unwrap(); + assert!( + result.is_ok(), + "server should initialize successfully with multiple buffered messages" + ); + result.unwrap().cancel().await.unwrap(); +} diff --git a/vendor/rmcp/tests/test_sse_concurrent_streams.rs b/vendor/rmcp/tests/test_sse_concurrent_streams.rs new file mode 100644 index 00000000..23ab8d05 --- /dev/null +++ b/vendor/rmcp/tests/test_sse_concurrent_streams.rs @@ -0,0 +1,775 @@ +#![cfg(not(feature = "local"))] +/// Tests for concurrent SSE stream handling (shadow channels) +/// +/// These tests verify that multiple GET SSE streams on the same session +/// don't kill each other by replacing the common channel sender. +/// +/// Root cause: When POST SSE responses include `retry`, the EventSource API +/// reconnects via GET after the stream ends. Each GET was unconditionally +/// replacing `self.common.tx`, killing the other stream's receiver — causing +/// an infinite reconnect loop every `sse_retry` seconds. +/// +/// Fix: `resume_or_shadow_common()` checks if the primary common channel is +/// still active. If so, it creates a "shadow" stream (idle, keep-alive only) +/// instead of replacing the primary. +use std::sync::Arc; +use std::time::Duration; + +use futures::StreamExt; +use rmcp::{ + RoleServer, ServerHandler, + model::{Implementation, ServerCapabilities, ServerConfig, ToolsCapability}, + service::NotificationContext, + transport::streamable_http_server::{ + StreamableHttpServerConfig, StreamableHttpService, session::local::LocalSessionManager, + }, +}; +use serde_json::json; +use tokio::sync::Notify; +use tokio_util::sync::CancellationToken; + +const ACCEPT_SSE: &str = "text/event-stream"; +const ACCEPT_BOTH: &str = "text/event-stream, application/json"; + +// ─── Test server ──────────────────────────────────────────────────────────── + +#[derive(Clone)] +pub struct TestServer { + trigger: Arc, +} + +impl TestServer { + fn new(trigger: Arc) -> Self { + Self { trigger } + } +} + +impl ServerHandler for TestServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::new( + ServerCapabilities::builder() + .enable_tools_with({ + let mut tools = ToolsCapability::default(); + tools.list_changed = Some(true); + tools + }) + .build(), + ) + .with_server_info(Implementation::new("test-server", "1.0.0")) + } + + async fn on_initialized(&self, context: NotificationContext) { + let peer = context.peer.clone(); + let trigger = self.trigger.clone(); + + tokio::spawn(async move { + trigger.notified().await; + let _ = peer.notify_tool_list_changed().await; + }); + } +} + +// ─── Helpers ──────────────────────────────────────────────────────────────── + +async fn start_test_server(ct: CancellationToken, trigger: Arc) -> String { + let server = TestServer::new(trigger); + let service = StreamableHttpService::new( + move || Ok(server.clone()), + Arc::new(LocalSessionManager::default()), + StreamableHttpServerConfig::default().with_cancellation_token(ct.child_token()), + ); + + let router = axum::Router::new().nest_service("/mcp", service); + let listener = tokio::net::TcpListener::bind("127.0.0.1:0") + .await + .expect("bind"); + let addr = listener.local_addr().unwrap(); + let url = format!("http://127.0.0.1:{}/mcp", addr.port()); + + let ct_clone = ct.clone(); + tokio::spawn(async move { + axum::serve(listener, router) + .with_graceful_shutdown(async move { ct_clone.cancelled().await }) + .await + .unwrap(); + }); + + tokio::time::sleep(Duration::from_millis(100)).await; + url +} + +/// POST initialize and return session ID. +async fn initialize_session(client: &reqwest::Client, url: &str) -> String { + let resp = client + .post(url) + .header("Accept", ACCEPT_BOTH) + .header("Content-Type", "application/json") + .json(&json!({ + "jsonrpc": "2.0", + "id": 1, + "method": "initialize", + "params": { + "protocolVersion": "2024-11-05", + "capabilities": {}, + "clientInfo": { "name": "test-client", "version": "1.0.0" } + } + })) + .timeout(Duration::from_millis(500)) + .send() + .await + .expect("POST initialize"); + + assert!(resp.status().is_success(), "initialize should succeed"); + + resp.headers() + .get("Mcp-Session-Id") + .expect("session ID header") + .to_str() + .unwrap() + .to_string() +} + +/// POST `notifications/initialized` to complete the MCP handshake. +/// This triggers the server's `on_initialized` handler. +async fn send_initialized_notification(client: &reqwest::Client, url: &str, session_id: &str) { + let resp = client + .post(url) + .header("Accept", ACCEPT_BOTH) + .header("Content-Type", "application/json") + .header("Mcp-Session-Id", session_id) + .json(&json!({ + "jsonrpc": "2.0", + "method": "notifications/initialized" + })) + .send() + .await + .expect("POST notifications/initialized"); + + assert_eq!( + resp.status().as_u16(), + 202, + "notifications/initialized should return 202 Accepted" + ); +} + +/// Open a standalone GET SSE stream (no Last-Event-ID). +async fn open_standalone_get( + client: &reqwest::Client, + url: &str, + session_id: &str, +) -> reqwest::Response { + client + .get(url) + .header("Accept", ACCEPT_SSE) + .header("Mcp-Session-Id", session_id) + .send() + .await + .expect("GET SSE stream") +} + +/// Open a GET SSE stream with Last-Event-ID (resume). +async fn open_resume_get( + client: &reqwest::Client, + url: &str, + session_id: &str, + last_event_id: &str, +) -> reqwest::Response { + client + .get(url) + .header("Accept", ACCEPT_SSE) + .header("Mcp-Session-Id", session_id) + .header("Last-Event-ID", last_event_id) + .send() + .await + .expect("GET SSE stream with Last-Event-ID") +} + +/// Read from an SSE byte stream until we find a specific text or timeout. +async fn wait_for_sse_event(resp: reqwest::Response, needle: &str, timeout: Duration) -> bool { + let mut stream = resp.bytes_stream(); + let result = tokio::time::timeout(timeout, async { + while let Some(Ok(chunk)) = stream.next().await { + let text = String::from_utf8_lossy(&chunk); + if text.contains(needle) { + return true; + } + } + false + }) + .await; + + matches!(result, Ok(true)) +} + +// ─── Tests: Shadow stream creation ────────────────────────────────────────── + +/// Second standalone GET with same session ID should return 200 OK +/// (shadow stream), NOT 409 Conflict. +#[tokio::test] +async fn shadow_second_standalone_get_returns_200() { + let ct = CancellationToken::new(); + let trigger = Arc::new(Notify::new()); + let url = start_test_server(ct.clone(), trigger).await; + let client = reqwest::Client::new(); + + let session_id = initialize_session(&client, &url).await; + + // First GET — becomes primary common channel + let get1 = open_standalone_get(&client, &url, &session_id).await; + assert_eq!(get1.status(), 200, "First GET should succeed"); + + tokio::time::sleep(Duration::from_millis(100)).await; + + // Second GET — should get 200 (shadow), NOT 409 + let get2 = open_standalone_get(&client, &url, &session_id).await; + assert_eq!( + get2.status(), + 200, + "Second GET should return 200 (shadow stream), not 409 Conflict" + ); + + ct.cancel(); +} + +/// Multiple standalone GETs should all return 200 — the server can handle +/// many shadow streams concurrently. +#[tokio::test] +async fn shadow_multiple_standalone_gets_all_succeed() { + let ct = CancellationToken::new(); + let trigger = Arc::new(Notify::new()); + let url = start_test_server(ct.clone(), trigger).await; + let client = reqwest::Client::new(); + + let session_id = initialize_session(&client, &url).await; + + // Open 5 concurrent standalone GETs + let mut responses = Vec::new(); + for i in 0..5 { + let resp = open_standalone_get(&client, &url, &session_id).await; + assert_eq!(resp.status(), 200, "GET #{i} should succeed"); + responses.push(resp); + tokio::time::sleep(Duration::from_millis(50)).await; + } + + // All 5 should be alive (first is primary, rest are shadows) + assert_eq!(responses.len(), 5); + + ct.cancel(); +} + +// ─── Tests: Dead primary replacement ──────────────────────────────────────── + +/// When the primary common channel is dead (first GET dropped), the next GET +/// should replace it and become the new primary. +#[tokio::test] +async fn dead_primary_gets_replaced_by_next_get() { + let ct = CancellationToken::new(); + let trigger = Arc::new(Notify::new()); + let url = start_test_server(ct.clone(), trigger).await; + let client = reqwest::Client::new(); + + let session_id = initialize_session(&client, &url).await; + + // First GET — becomes primary + let get1 = open_standalone_get(&client, &url, &session_id).await; + assert_eq!(get1.status(), 200); + + // Drop primary — kills receiver, making sender closed + drop(get1); + tokio::time::sleep(Duration::from_millis(100)).await; + + // Second GET — primary is dead, should replace it + let get2 = open_standalone_get(&client, &url, &session_id).await; + assert_eq!( + get2.status(), + 200, + "GET should succeed as new primary after old primary was dropped" + ); + + ct.cancel(); +} + +/// After primary dies, the replacement primary should be able to receive +/// notifications (verifies the channel was actually replaced, not shadowed). +#[tokio::test] +async fn dead_primary_replacement_receives_notifications() { + let ct = CancellationToken::new(); + let trigger = Arc::new(Notify::new()); + let url = start_test_server(ct.clone(), trigger.clone()).await; + let client = reqwest::Client::new(); + + let session_id = initialize_session(&client, &url).await; + send_initialized_notification(&client, &url, &session_id).await; + tokio::time::sleep(Duration::from_millis(100)).await; + + // First GET — becomes primary + let get1 = open_standalone_get(&client, &url, &session_id).await; + assert_eq!(get1.status(), 200); + + // Drop primary + drop(get1); + tokio::time::sleep(Duration::from_millis(100)).await; + + // Second GET — becomes new primary (replacement) + let get2 = open_standalone_get(&client, &url, &session_id).await; + assert_eq!(get2.status(), 200); + + // Trigger notification — should arrive on get2 (the new primary) + trigger.notify_one(); + + assert!( + wait_for_sse_event(get2, "tools/list_changed", Duration::from_secs(3)).await, + "Replacement primary should receive notifications" + ); + + ct.cancel(); +} + +/// Multiple drops and replacements should work: primary can be replaced +/// more than once. +#[tokio::test] +async fn dead_primary_can_be_replaced_multiple_times() { + let ct = CancellationToken::new(); + let trigger = Arc::new(Notify::new()); + let url = start_test_server(ct.clone(), trigger).await; + let client = reqwest::Client::new(); + + let session_id = initialize_session(&client, &url).await; + + for i in 0..3 { + let get = open_standalone_get(&client, &url, &session_id).await; + assert_eq!(get.status(), 200, "GET #{i} should succeed"); + drop(get); + tokio::time::sleep(Duration::from_millis(100)).await; + } + + // Final GET should still work + let final_get = open_standalone_get(&client, &url, &session_id).await; + assert_eq!( + final_get.status(), + 200, + "GET after multiple replacements should succeed" + ); + + ct.cancel(); +} + +// ─── Tests: Notification routing ──────────────────────────────────────────── + +/// Notification should arrive on the primary stream even after shadow streams +/// are created by subsequent GETs. +#[tokio::test] +async fn notification_reaches_primary_not_shadow() { + let ct = CancellationToken::new(); + let trigger = Arc::new(Notify::new()); + let url = start_test_server(ct.clone(), trigger.clone()).await; + let client = reqwest::Client::new(); + + let session_id = initialize_session(&client, &url).await; + send_initialized_notification(&client, &url, &session_id).await; + tokio::time::sleep(Duration::from_millis(200)).await; + + // First GET — primary common channel + let get1 = open_standalone_get(&client, &url, &session_id).await; + assert_eq!(get1.status(), 200); + tokio::time::sleep(Duration::from_millis(100)).await; + + // Second GET — shadow stream (should NOT steal notifications) + let _get2 = open_standalone_get(&client, &url, &session_id).await; + assert_eq!(_get2.status(), 200); + tokio::time::sleep(Duration::from_millis(100)).await; + + // Trigger notification + trigger.notify_one(); + + // Primary stream should receive the notification + assert!( + wait_for_sse_event(get1, "tools/list_changed", Duration::from_secs(3)).await, + "Primary stream should receive notification even after shadow was created" + ); + + ct.cancel(); +} + +// ─── Tests: Resume with Last-Event-ID ─────────────────────────────────────── + +/// GET with Last-Event-ID referencing a completed request-wise channel should +/// fall through to shadow (not crash or return 500). +/// +/// This simulates the real-world scenario: POST SSE response ends, the +/// EventSource reconnects via GET with the last event ID from the POST stream. +/// The request-wise channel no longer exists, so the server should create a +/// shadow stream. +#[tokio::test] +async fn resume_completed_request_wise_creates_shadow() { + let ct = CancellationToken::new(); + let trigger = Arc::new(Notify::new()); + let url = start_test_server(ct.clone(), trigger).await; + let client = reqwest::Client::new(); + + let session_id = initialize_session(&client, &url).await; + + // First GET — establish primary + let _get1 = open_standalone_get(&client, &url, &session_id).await; + assert_eq!(_get1.status(), 200); + tokio::time::sleep(Duration::from_millis(100)).await; + + // GET with Last-Event-ID for non-existent request-wise channel + let get_resume = open_resume_get(&client, &url, &session_id, "0/999").await; + assert_eq!( + get_resume.status(), + 200, + "Resume of completed request-wise channel should return 200 (shadow)" + ); + + ct.cancel(); +} + +/// GET with Last-Event-ID "0" (common channel resume) while primary is alive +/// should create a shadow. +#[tokio::test] +async fn resume_common_while_primary_alive_creates_shadow() { + let ct = CancellationToken::new(); + let trigger = Arc::new(Notify::new()); + let url = start_test_server(ct.clone(), trigger).await; + let client = reqwest::Client::new(); + + let session_id = initialize_session(&client, &url).await; + + // First GET — establish primary + let _get1 = open_standalone_get(&client, &url, &session_id).await; + assert_eq!(_get1.status(), 200); + tokio::time::sleep(Duration::from_millis(100)).await; + + // GET with Last-Event-ID "0" — resume common while primary alive → shadow + let get_resume = open_resume_get(&client, &url, &session_id, "0").await; + assert_eq!( + get_resume.status(), + 200, + "Common channel resume while primary alive should return 200 (shadow)" + ); + + ct.cancel(); +} + +/// GET with Last-Event-ID "0" (common channel resume) while primary is dead +/// should become the new primary. +#[tokio::test] +async fn resume_common_while_primary_dead_becomes_primary() { + let ct = CancellationToken::new(); + let trigger = Arc::new(Notify::new()); + let url = start_test_server(ct.clone(), trigger.clone()).await; + let client = reqwest::Client::new(); + + let session_id = initialize_session(&client, &url).await; + send_initialized_notification(&client, &url, &session_id).await; + tokio::time::sleep(Duration::from_millis(200)).await; + + // First GET — establish primary + let get1 = open_standalone_get(&client, &url, &session_id).await; + assert_eq!(get1.status(), 200); + + // Drop primary + drop(get1); + tokio::time::sleep(Duration::from_millis(100)).await; + + // GET with Last-Event-ID "0" — primary dead → becomes new primary + let get_resume = open_resume_get(&client, &url, &session_id, "0").await; + assert_eq!(get_resume.status(), 200); + + // New primary should receive notifications + trigger.notify_one(); + + assert!( + wait_for_sse_event(get_resume, "tools/list_changed", Duration::from_secs(3)).await, + "Resumed stream that replaced dead primary should receive notifications" + ); + + ct.cancel(); +} + +// ─── Tests: Mixed scenarios ───────────────────────────────────────────────── + +/// POST SSE reconnections and standalone GET should coexist: POST initialize +/// creates a request-wise channel, its EventSource reconnects via GET after +/// the stream ends, while a standalone GET is also active. +#[tokio::test] +async fn post_reconnect_and_standalone_coexist() { + let ct = CancellationToken::new(); + let trigger = Arc::new(Notify::new()); + let url = start_test_server(ct.clone(), trigger).await; + let client = reqwest::Client::new(); + + let session_id = initialize_session(&client, &url).await; + + // Standalone GET — becomes primary + let _standalone = open_standalone_get(&client, &url, &session_id).await; + assert_eq!(_standalone.status(), 200); + tokio::time::sleep(Duration::from_millis(100)).await; + + // Simulate POST SSE response reconnection (EventSource reconnects with + // Last-Event-ID from the initialize POST stream). The request-wise channel + // for the initialize request is already completed. + let reconnect1 = open_resume_get(&client, &url, &session_id, "0/0").await; + assert_eq!( + reconnect1.status(), + 200, + "POST reconnection should get shadow, not replace primary" + ); + + tokio::time::sleep(Duration::from_millis(100)).await; + + // Another POST reconnection (e.g. from tools/list response) + let reconnect2 = open_resume_get(&client, &url, &session_id, "0/1").await; + assert_eq!( + reconnect2.status(), + 200, + "Second POST reconnection should also succeed" + ); + + ct.cancel(); +} + +/// Standalone GET is dropped (e.g. client timeout), a new standalone GET +/// connects. The new one should become the primary and receive notifications. +#[tokio::test] +async fn reconnect_after_stream_timeout() { + let ct = CancellationToken::new(); + let trigger = Arc::new(Notify::new()); + let url = start_test_server(ct.clone(), trigger.clone()).await; + let client = reqwest::Client::new(); + + let session_id = initialize_session(&client, &url).await; + send_initialized_notification(&client, &url, &session_id).await; + tokio::time::sleep(Duration::from_millis(200)).await; + + // First standalone GET — primary + let get1 = open_standalone_get(&client, &url, &session_id).await; + assert_eq!(get1.status(), 200); + + // Client drops the stream (e.g. timeout or reconnection) + drop(get1); + tokio::time::sleep(Duration::from_millis(100)).await; + + // Client reconnects with a new standalone GET + let get2 = open_standalone_get(&client, &url, &session_id).await; + assert_eq!(get2.status(), 200); + + // Notification should reach the new primary + trigger.notify_one(); + + assert!( + wait_for_sse_event(get2, "tools/list_changed", Duration::from_secs(3)).await, + "Reconnected stream should receive notifications" + ); + + ct.cancel(); +} + +// ─── Tests: Edge cases ────────────────────────────────────────────────────── + +/// GET with an unknown session ID should return 404 Not Found per MCP spec. +/// This signals the client to re-initialize (not re-authenticate). +#[tokio::test] +async fn get_without_valid_session_returns_404() { + let ct = CancellationToken::new(); + let trigger = Arc::new(Notify::new()); + let url = start_test_server(ct.clone(), trigger).await; + let client = reqwest::Client::new(); + + let resp = client + .get(&url) + .header("Accept", ACCEPT_SSE) + .header("Mcp-Session-Id", "nonexistent-session-id") + .send() + .await + .expect("GET with invalid session"); + + assert_eq!( + resp.status().as_u16(), + 404, + "GET with unknown session ID should return 404 Not Found per MCP spec" + ); + + ct.cancel(); +} + +/// GET without session ID header should return 400 Bad Request per MCP spec. +#[tokio::test] +async fn get_without_session_id_header_returns_400() { + let ct = CancellationToken::new(); + let trigger = Arc::new(Notify::new()); + let url = start_test_server(ct.clone(), trigger).await; + let client = reqwest::Client::new(); + + let resp = client + .get(&url) + .header("Accept", ACCEPT_SSE) + .send() + .await + .expect("GET without session ID"); + + assert_eq!( + resp.status().as_u16(), + 400, + "GET without session ID should return 400 Bad Request per MCP spec" + ); + + ct.cancel(); +} + +/// Shadow streams should be idle — they should NOT receive notifications. +/// Only the primary receives them. +#[tokio::test] +async fn shadow_stream_does_not_receive_notifications() { + let ct = CancellationToken::new(); + let trigger = Arc::new(Notify::new()); + let url = start_test_server(ct.clone(), trigger.clone()).await; + let client = reqwest::Client::new(); + + let session_id = initialize_session(&client, &url).await; + send_initialized_notification(&client, &url, &session_id).await; + tokio::time::sleep(Duration::from_millis(200)).await; + + // First GET — primary + let _get1 = open_standalone_get(&client, &url, &session_id).await; + assert_eq!(_get1.status(), 200); + tokio::time::sleep(Duration::from_millis(100)).await; + + // Second GET — shadow + let get2 = open_standalone_get(&client, &url, &session_id).await; + assert_eq!(get2.status(), 200); + tokio::time::sleep(Duration::from_millis(100)).await; + + // Trigger notification + trigger.notify_one(); + + // Shadow stream should NOT receive the notification (timeout expected) + let shadow_received = + wait_for_sse_event(get2, "tools/list_changed", Duration::from_millis(500)).await; + assert!( + !shadow_received, + "Shadow stream should NOT receive notifications" + ); + + ct.cancel(); +} + +/// Dropping all shadow streams should not affect the primary channel. +/// Primary should still receive notifications after all shadows are dropped. +#[tokio::test] +async fn dropping_shadows_does_not_affect_primary() { + let ct = CancellationToken::new(); + let trigger = Arc::new(Notify::new()); + let url = start_test_server(ct.clone(), trigger.clone()).await; + let client = reqwest::Client::new(); + + let session_id = initialize_session(&client, &url).await; + send_initialized_notification(&client, &url, &session_id).await; + tokio::time::sleep(Duration::from_millis(200)).await; + + // Primary GET + let get1 = open_standalone_get(&client, &url, &session_id).await; + assert_eq!(get1.status(), 200); + tokio::time::sleep(Duration::from_millis(100)).await; + + // Create and drop several shadows + for _ in 0..3 { + let shadow = open_standalone_get(&client, &url, &session_id).await; + assert_eq!(shadow.status(), 200); + drop(shadow); + tokio::time::sleep(Duration::from_millis(50)).await; + } + + // Trigger notification — primary should still receive it + trigger.notify_one(); + + assert!( + wait_for_sse_event(get1, "tools/list_changed", Duration::from_secs(3)).await, + "Primary should still work after all shadows are dropped" + ); + + ct.cancel(); +} + +// ─── Tests: Cache replay on dead primary replacement ───────────────────────── + +/// When a notification is sent while the primary is alive, then the primary +/// dies and a new GET resumes with Last-Event-ID "0", the replacement primary +/// should receive the cached notification via sync() replay. +#[tokio::test] +async fn dead_primary_replacement_replays_cached_events() { + let ct = CancellationToken::new(); + let trigger = Arc::new(Notify::new()); + let url = start_test_server(ct.clone(), trigger.clone()).await; + let client = reqwest::Client::new(); + + let session_id = initialize_session(&client, &url).await; + send_initialized_notification(&client, &url, &session_id).await; + tokio::time::sleep(Duration::from_millis(200)).await; + + // First GET — becomes primary + let get1 = open_standalone_get(&client, &url, &session_id).await; + assert_eq!(get1.status(), 200); + tokio::time::sleep(Duration::from_millis(100)).await; + + // Trigger notification while primary is alive (gets cached) + trigger.notify_one(); + tokio::time::sleep(Duration::from_millis(200)).await; + + // Drop primary — notification was sent and cached + drop(get1); + tokio::time::sleep(Duration::from_millis(100)).await; + + // Resume with Last-Event-ID "0" — primary is dead, should replace it + // and replay cached events from index 0 + let get_resume = open_resume_get(&client, &url, &session_id, "0").await; + assert_eq!(get_resume.status(), 200); + + // The cached notification should be replayed on the new primary + assert!( + wait_for_sse_event(get_resume, "tools/list_changed", Duration::from_secs(3)).await, + "Replacement primary should receive cached notification via sync() replay" + ); + + ct.cancel(); +} + +// ─── Tests: Shadow stream limits ───────────────────────────────────────────── + +/// Opening more than 32 shadow streams should not crash or reject — the server +/// drops the oldest shadow to stay within the limit. Primary still works. +#[tokio::test] +async fn shadow_stream_limit_drops_oldest() { + let ct = CancellationToken::new(); + let trigger = Arc::new(Notify::new()); + let url = start_test_server(ct.clone(), trigger.clone()).await; + let client = reqwest::Client::new(); + + let session_id = initialize_session(&client, &url).await; + send_initialized_notification(&client, &url, &session_id).await; + tokio::time::sleep(Duration::from_millis(200)).await; + + // First GET — primary + let get1 = open_standalone_get(&client, &url, &session_id).await; + assert_eq!(get1.status(), 200); + tokio::time::sleep(Duration::from_millis(100)).await; + + // Open 35 shadow streams (exceeds MAX_SHADOW_STREAMS=32) + let mut shadows = Vec::new(); + for i in 0..35 { + let shadow = open_standalone_get(&client, &url, &session_id).await; + assert_eq!(shadow.status(), 200, "Shadow #{i} should succeed"); + shadows.push(shadow); + } + + // Primary should still receive notifications despite shadow churn + trigger.notify_one(); + + assert!( + wait_for_sse_event(get1, "tools/list_changed", Duration::from_secs(3)).await, + "Primary should still work after exceeding shadow limit" + ); + + ct.cancel(); +} diff --git a/vendor/rmcp/tests/test_stateless_protocol_version.rs b/vendor/rmcp/tests/test_stateless_protocol_version.rs new file mode 100644 index 00000000..58e83ff6 --- /dev/null +++ b/vendor/rmcp/tests/test_stateless_protocol_version.rs @@ -0,0 +1,231 @@ +//! Tests for protocol version negotiation in stateless HTTP mode. +//! +//! Supported handshake versions are echoed back; unknown versions, versions +//! outside the server's `supported_protocol_versions`, and versions that no +//! longer have an `initialize` handshake fall back to the handler's own +//! version. +#![cfg(not(feature = "local"))] + +use std::borrow::Cow; + +use rmcp::{ + ErrorData, RoleServer, ServerHandler, + model::{ + InitializeRequestParams, InitializeResult, ProtocolVersion, ServerCapabilities, + ServerConfig, + }, + service::RequestContext, + transport::streamable_http_server::{ + StreamableHttpServerConfig, StreamableHttpService, session::local::LocalSessionManager, + }, +}; +use tokio_util::sync::CancellationToken; + +#[derive(Clone, Default)] +struct OverridingInitialize; + +impl ServerHandler for OverridingInitialize { + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::default()) + } + + async fn initialize( + &self, + _request: InitializeRequestParams, + _context: RequestContext, + ) -> Result { + Ok(self.get_info()) + } +} + +/// Every known version whose lifecycle still runs the `initialize` handshake. +/// [`ProtocolVersion::NO_INITIALIZE`] replaced the handshake with per-request +/// metadata, so this is also the list a server that has not implemented that +/// revision supports. +const HANDSHAKE_VERSIONS: &[ProtocolVersion] = &[ + ProtocolVersion::V_2024_11_05, + ProtocolVersion::V_2025_03_26, + ProtocolVersion::V_2025_06_18, + ProtocolVersion::V_2025_11_25, +]; + +/// Overrides `initialize`, so the handler-side default negotiation never runs, +/// *and* narrows the supported versions. +#[derive(Clone, Default)] +struct NarrowedOverridingInitialize; + +impl ServerHandler for NarrowedOverridingInitialize { + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::default()) + } + + fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]> { + Cow::Borrowed(HANDSHAKE_VERSIONS) + } + + async fn initialize( + &self, + _request: InitializeRequestParams, + _context: RequestContext, + ) -> Result { + Ok(self.get_info()) + } +} + +fn stateless_sse_config() -> StreamableHttpServerConfig { + StreamableHttpServerConfig::default() + .with_legacy_session_mode(false) + .with_sse_keep_alive(None) + .with_cancellation_token(CancellationToken::new()) +} + +fn stateless_json_config() -> StreamableHttpServerConfig { + stateless_sse_config().with_json_response(true) +} + +async fn spawn_server( + config: StreamableHttpServerConfig, +) -> (reqwest::Client, String, CancellationToken) { + spawn_server_of::(config).await +} + +async fn spawn_server_of( + config: StreamableHttpServerConfig, +) -> (reqwest::Client, String, CancellationToken) { + let ct = config.cancellation_token.clone(); + let service: StreamableHttpService = + StreamableHttpService::new(|| Ok(H::default()), Default::default(), config); + + let router = axum::Router::new().nest_service("/mcp", service); + let tcp_listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let addr = tcp_listener.local_addr().unwrap(); + + tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(tcp_listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + (reqwest::Client::new(), format!("http://{addr}/mcp"), ct) +} + +async fn post_init(client: &reqwest::Client, url: &str, body_version: &str) -> serde_json::Value { + let body = serde_json::json!({ + "jsonrpc": "2.0", + "id": 1, + "method": "initialize", + "params": { + "protocolVersion": body_version, + "capabilities": {}, + "clientInfo": {"name": "test", "version": "0.0.1"} + } + }); + let resp = client + .post(url) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .body(body.to_string()) + .send() + .await + .expect("send request"); + assert!(resp.status().is_success(), "HTTP {}", resp.status()); + let is_json = resp + .headers() + .get(reqwest::header::CONTENT_TYPE) + .and_then(|value| value.to_str().ok()) + .is_some_and(|value| value.starts_with("application/json")); + if is_json { + resp.json().await.expect("parse JSON") + } else { + let body = resp.text().await.expect("read SSE body"); + let data = body + .lines() + .find_map(|line| line.strip_prefix("data:")) + .map(str::trim) + .filter(|data| !data.is_empty()) + .expect("SSE response contains data"); + serde_json::from_str(data).expect("parse SSE data") + } +} + +#[tokio::test] +async fn stateless_json_init_echoes_handshake_versions_when_handler_overrides_initialize() { + let (client, url, ct) = spawn_server(stateless_json_config()).await; + + for version in HANDSHAKE_VERSIONS { + let resp = post_init(&client, &url, version.as_str()).await; + assert_eq!( + resp["result"]["protocolVersion"], + version.as_str(), + "handshake version {version} should be echoed back" + ); + } + + ct.cancel(); +} + +#[tokio::test] +async fn stateless_sse_init_echoes_handshake_versions_when_handler_overrides_initialize() { + let (client, url, ct) = spawn_server(stateless_sse_config()).await; + + for version in HANDSHAKE_VERSIONS { + let resp = post_init(&client, &url, version.as_str()).await; + assert_eq!( + resp["result"]["protocolVersion"], + version.as_str(), + "handshake version {version} should be echoed back" + ); + } + + ct.cancel(); +} + +#[tokio::test] +async fn stateless_json_init_substitutes_a_handshake_version_for_unknown_version() { + let (client, url, ct) = spawn_server(stateless_json_config()).await; + + let resp = post_init(&client, &url, "1999-01-01").await; + assert_eq!( + resp["result"]["protocolVersion"], + ProtocolVersion::LATEST_WITH_INITIALIZE.as_str(), + "the handler's `LATEST` fallback has no handshake, so the newest version \ + that does is substituted" + ); + + ct.cancel(); +} + +#[tokio::test] +async fn stateless_json_init_echoes_versions_the_server_narrowed_to() { + let (client, url, ct) = + spawn_server_of::(stateless_json_config()).await; + + for version in HANDSHAKE_VERSIONS { + let resp = post_init(&client, &url, version.as_str()).await; + assert_eq!( + resp["result"]["protocolVersion"], + version.as_str(), + "supported version {version} should be echoed back" + ); + } + + ct.cancel(); +} + +#[tokio::test] +async fn stateless_json_init_does_not_agree_to_version_outside_supported_list() { + let (client, url, ct) = + spawn_server_of::(stateless_json_config()).await; + + let resp = post_init(&client, &url, ProtocolVersion::V_2026_07_28.as_str()).await; + assert_eq!( + resp["result"]["protocolVersion"], + ProtocolVersion::LATEST_WITH_INITIALIZE.as_str(), + "a version outside supported_protocol_versions should not be echoed back" + ); + + ct.cancel(); +} diff --git a/vendor/rmcp/tests/test_stateless_server_requests.rs b/vendor/rmcp/tests/test_stateless_server_requests.rs new file mode 100644 index 00000000..9ab302b8 --- /dev/null +++ b/vendor/rmcp/tests/test_stateless_server_requests.rs @@ -0,0 +1,288 @@ +#![cfg(all(feature = "server", not(feature = "local")))] + +use std::{ + sync::{Arc, Mutex}, + time::Duration, +}; + +use rmcp::{ + ServerHandler, ServiceExt, + model::{ + ClientCapabilities, ClientJsonRpcMessage, ClientRequest, DiscoverRequest, + DiscoverRequestParams, ErrorCode, ErrorData, Implementation, ListToolsRequest, + ListToolsResult, NumberOrString, PaginatedRequestParams, ProgressNotificationParam, + ProgressToken, ProtocolVersion, RequestId, RequestMetaObject, ServerJsonRpcMessage, + ServerNotification, + }, + service::{MaybeSendFuture, RequestContext, RoleServer, ServerInitializeError}, + transport::{IntoTransport, Transport}, +}; + +#[derive(Clone, Default)] +struct StatelessServer; + +impl ServerHandler for StatelessServer {} + +fn complete_meta() -> RequestMetaObject { + complete_meta_for("stateless-client") +} + +fn complete_meta_for(client_name: &str) -> RequestMetaObject { + let mut meta = RequestMetaObject::new(); + meta.set_protocol_version(ProtocolVersion::V_2026_07_28); + meta.set_client_info(Implementation::new(client_name, "1.0.0")); + meta.set_client_capabilities(ClientCapabilities::default()); + meta +} + +fn list_tools_request(meta: RequestMetaObject) -> ClientJsonRpcMessage { + let mut request = ListToolsRequest { + method: Default::default(), + params: None, + extensions: Default::default(), + }; + request.extensions.insert(meta); + ClientJsonRpcMessage::request( + ClientRequest::ListToolsRequest(request), + RequestId::Number(1), + ) +} + +#[tokio::test] +async fn stateless_server_rejects_missing_metadata_on_every_request() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let server_task = tokio::spawn(async move { + StatelessServer + .serve(server_transport) + .await + .expect("server should start") + }); + let mut client = IntoTransport::::into_transport(client_transport); + + let mut discover = DiscoverRequest::new(DiscoverRequestParams {}); + discover.extensions.insert(complete_meta()); + client + .send(ClientJsonRpcMessage::request( + ClientRequest::DiscoverRequest(discover), + RequestId::Number(1), + )) + .await + .expect("send discover"); + assert!(matches!( + client.receive().await, + Some(ServerJsonRpcMessage::Response(_)) + )); + + client + .send(ClientJsonRpcMessage::request( + ClientRequest::ListToolsRequest(ListToolsRequest { + method: Default::default(), + params: None, + extensions: Default::default(), + }), + RequestId::Number(2), + )) + .await + .expect("send list tools"); + let Some(ServerJsonRpcMessage::Error(error)) = client.receive().await else { + panic!("expected invalid params"); + }; + assert_eq!(error.error.code, ErrorCode::INVALID_PARAMS); + + server_task + .await + .expect("server task") + .cancel() + .await + .expect("cancel server"); +} + +#[derive(Clone)] +struct ContextServer { + seen_clients: Arc>>, +} + +impl ServerHandler for ContextServer { + fn list_tools( + &self, + _request: Option, + context: RequestContext, + ) -> impl Future> + MaybeSendFuture + '_ { + let seen_clients = self.seen_clients.clone(); + async move { + seen_clients + .lock() + .expect("seen clients lock") + .push(context.client_info().expect("current client info").name); + Ok(ListToolsResult::default()) + } + } +} + +#[tokio::test] +async fn stateless_server_uses_each_requests_client_context() { + let seen_clients = Arc::new(Mutex::new(Vec::new())); + let handler = ContextServer { + seen_clients: seen_clients.clone(), + }; + let (server_transport, client_transport) = tokio::io::duplex(4096); + let server_task = tokio::spawn(async move { + handler + .serve(server_transport) + .await + .expect("server should start") + }); + let mut client = IntoTransport::::into_transport(client_transport); + + client + .send(list_tools_request(complete_meta_for("first-client"))) + .await + .expect("send first request"); + assert!(matches!( + client.receive().await, + Some(ServerJsonRpcMessage::Response(_)) + )); + + let mut second = list_tools_request(complete_meta_for("second-client")); + if let ClientJsonRpcMessage::Request(request) = &mut second { + request.id = RequestId::Number(2); + } + client.send(second).await.expect("send second request"); + assert!(matches!( + client.receive().await, + Some(ServerJsonRpcMessage::Response(_)) + )); + + assert_eq!( + *seen_clients.lock().expect("seen clients lock"), + ["first-client", "second-client"] + ); + server_task + .await + .expect("server task") + .cancel() + .await + .expect("cancel server"); +} + +#[tokio::test] +async fn stateless_server_rejects_malformed_metadata_opener_with_error_response() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let server_task = tokio::spawn(async move { StatelessServer.serve(server_transport).await }); + let mut client = IntoTransport::::into_transport(client_transport); + + let mut request = ListToolsRequest { + method: Default::default(), + params: None, + extensions: Default::default(), + }; + let malformed: RequestMetaObject = serde_json::from_value(serde_json::json!({ + "io.modelcontextprotocol/protocolVersion": "2026-07-28", + "io.modelcontextprotocol/clientInfo": "wrong", + "io.modelcontextprotocol/clientCapabilities": null + })) + .unwrap(); + request.extensions.insert(malformed); + client + .send(ClientJsonRpcMessage::request( + ClientRequest::ListToolsRequest(request), + RequestId::Number(1), + )) + .await + .expect("send list tools"); + let Some(ServerJsonRpcMessage::Error(error)) = client.receive().await else { + panic!("expected invalid params"); + }; + assert_eq!(error.id, Some(RequestId::Number(1))); + assert_eq!(error.error.code, ErrorCode::INVALID_PARAMS); + assert!( + error + .error + .message + .contains("request _meta is missing or has malformed required fields") + ); + assert!( + error + .error + .message + .contains("io.modelcontextprotocol/clientCapabilities") + ); + + let Err(error) = server_task.await.expect("server task") else { + panic!("malformed opener should not start a session"); + }; + assert!(matches!( + error, + ServerInitializeError::ExpectedInitializeRequest(Some(_)) + )); +} + +#[derive(Clone)] +struct ProgressServer; + +impl ServerHandler for ProgressServer { + async fn list_tools( + &self, + _request: Option, + context: RequestContext, + ) -> Result { + let progress_token = context + .meta + .get_progress_token() + .expect("progress token in request meta"); + context + .peer + .notify_progress(ProgressNotificationParam::new(progress_token, 1.0)) + .await + .expect("send progress notification"); + Ok(ListToolsResult::default()) + } +} + +/// Regression test for issue #1261: the first request of an `initialize`-less +/// session used to be handled outside the service loop, so a handler that sent +/// a notification before returning waited forever for the loop to flush it. +#[tokio::test] +async fn stateless_server_first_request_handler_can_send_notifications() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let server_task = tokio::spawn(async move { + ProgressServer + .serve(server_transport) + .await + .expect("server should start") + }); + let mut client = IntoTransport::::into_transport(client_transport); + + let mut meta = complete_meta(); + meta.set_progress_token(ProgressToken(NumberOrString::Number(7))); + client + .send(list_tools_request(meta)) + .await + .expect("send first request"); + + let exchange = async { + let notification = match client.receive().await { + Some(ServerJsonRpcMessage::Notification(notification)) => notification.notification, + other => panic!("expected progress notification before the response, got {other:?}"), + }; + assert!( + matches!(notification, ServerNotification::ProgressNotification(_)), + "expected progress notification, got {notification:?}" + ); + let response = match client.receive().await { + Some(ServerJsonRpcMessage::Response(response)) => response, + other => panic!("expected list tools response, got {other:?}"), + }; + assert_eq!(response.id, RequestId::Number(1)); + }; + tokio::time::timeout(Duration::from_secs(5), exchange) + .await + .expect("first request must not deadlock the server"); + + server_task + .await + .expect("server task") + .cancel() + .await + .expect("cancel server"); +} diff --git a/vendor/rmcp/tests/test_stdio_response_concurrency.rs b/vendor/rmcp/tests/test_stdio_response_concurrency.rs new file mode 100644 index 00000000..64be3fc7 --- /dev/null +++ b/vendor/rmcp/tests/test_stdio_response_concurrency.rs @@ -0,0 +1,199 @@ +#![cfg(not(feature = "local"))] + +use std::{collections::BTreeSet, process::Stdio, time::Duration}; + +use rmcp::{ + ErrorData as McpError, ServerHandler, ServiceExt, + model::{ + CallToolRequestParams, CallToolResponse, CallToolResult, ContentBlock, ServerCapabilities, + ServerConfig, + }, +}; +use serde_json::{Value, json}; +use tokio::{ + io::{AsyncBufReadExt, AsyncWrite, AsyncWriteExt, BufReader}, + process::{Child, Command}, +}; + +const HELPER_ENV: &str = "RMCP_STDIO_RESPONSE_CONCURRENCY_HELPER"; +const REQUESTS: usize = 200; +const RESPONSE_BYTES: usize = 64 * 1024; +const READ_TIMEOUT: Duration = Duration::from_secs(10); + +#[tokio::test(flavor = "multi_thread", worker_threads = 8)] +async fn raw_client_concurrent_large_stdio_tool_responses_are_not_lost() -> anyhow::Result<()> { + // Spawn the same test binary as a child process so the server uses real + // stdio pipes, not an in-process transport. + let mut child = spawn_helper(); + let mut writer = child.stdin.take().expect("helper stdin"); + let stdout = child.stdout.take().expect("helper stdout"); + let mut reader = BufReader::new(stdout); + + // Complete the normal MCP initialization flow before stressing tools/call. + send_json( + &mut writer, + &json!({ + "jsonrpc": "2.0", + "id": 1, + "method": "initialize", + "params": { + "protocolVersion": "2024-11-05", + "capabilities": {}, + "clientInfo": { "name": "raw-test-client", "version": "0.0.0" } + } + }), + ) + .await?; + read_response_for_id(&mut reader, 1).await?; + + send_json( + &mut writer, + &json!({ "jsonrpc": "2.0", "method": "notifications/initialized" }), + ) + .await?; + + // Send the whole batch before reading responses. This creates concurrent + // request handling and concurrent response production inside rmcp. + for id in request_ids() { + send_json( + &mut writer, + &json!({ + "jsonrpc": "2.0", + "id": id, + "method": "tools/call", + "params": { "name": "large-response", "arguments": {} } + }), + ) + .await?; + } + + let missing_ids = read_responses_for_ids(&mut reader, request_ids(), READ_TIMEOUT).await?; + assert!( + missing_ids.is_empty(), + "missing response ids: {missing_ids:?}" + ); + + drop(writer); + wait_for_child(&mut child).await; + Ok(()) +} + +struct LargeResponseServer; + +impl ServerHandler for LargeResponseServer { + #[allow(deprecated)] + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::builder().enable_tools().build()) + } + + async fn call_tool( + &self, + request: CallToolRequestParams, + _context: rmcp::service::RequestContext, + ) -> Result { + assert_eq!("large-response", request.name.as_ref()); + Ok(CallToolResult::success(vec![ContentBlock::text("x".repeat(RESPONSE_BYTES))]).into()) + } +} + +#[tokio::test] +async fn stdio_response_concurrency_helper() -> anyhow::Result<()> { + // The parent test starts this same binary with HELPER_ENV=1 so it can act + // as a small MCP server connected over real stdin/stdout pipes. + if std::env::var(HELPER_ENV).as_deref() != Ok("1") { + return Ok(()); + } + let server = LargeResponseServer.serve(rmcp::transport::stdio()).await?; + server.waiting().await?; + Ok(()) +} + +fn spawn_helper() -> Child { + let exe = std::env::current_exe().expect("current test exe"); + Command::new(exe) + .arg("--exact") + .arg("stdio_response_concurrency_helper") + .arg("--quiet") + .arg("--nocapture") + .arg("--test-threads") + .arg("1") + .env(HELPER_ENV, "1") + .stdin(Stdio::piped()) + .stdout(Stdio::piped()) + .stderr(Stdio::null()) + .kill_on_drop(true) + .spawn() + .expect("spawn helper") +} + +async fn wait_for_child(child: &mut Child) { + let _ = tokio::time::timeout(Duration::from_secs(2), child.wait()).await; + if child.id().is_some() { + let _ = child.kill().await; + } +} + +fn request_ids() -> BTreeSet { + (1000..1000 + REQUESTS as u64).collect() +} + +async fn send_json(writer: &mut W, message: &Value) -> anyhow::Result<()> +where + W: AsyncWrite + Unpin, +{ + let serialized = serde_json::to_string(message)?; + writer.write_all(serialized.as_bytes()).await?; + writer.write_all(b"\n").await?; + writer.flush().await?; + Ok(()) +} + +async fn read_response_for_id(reader: &mut BufReader, expected_id: u64) -> anyhow::Result<()> +where + R: tokio::io::AsyncRead + Unpin, +{ + let missing = + read_responses_for_ids(reader, BTreeSet::from([expected_id]), READ_TIMEOUT).await?; + if missing.is_empty() { + Ok(()) + } else { + anyhow::bail!("missing response id {expected_id}") + } +} + +async fn read_responses_for_ids( + reader: &mut BufReader, + mut pending_ids: BTreeSet, + timeout: Duration, +) -> anyhow::Result> +where + R: tokio::io::AsyncRead + Unpin, +{ + let deadline = tokio::time::Instant::now() + timeout; + while !pending_ids.is_empty() { + let remaining = deadline.saturating_duration_since(tokio::time::Instant::now()); + if remaining.is_zero() { + break; + } + let mut line = String::new(); + let Ok(read_result) = tokio::time::timeout(remaining, reader.read_line(&mut line)).await + else { + break; + }; + let read = read_result?; + if read == 0 { + break; + } + let trimmed = line.trim(); + if trimmed.is_empty() { + continue; + } + let Ok(value) = serde_json::from_str::(trimmed) else { + continue; + }; + if let Some(id) = value.get("id").and_then(Value::as_u64) { + pending_ids.remove(&id); + } + } + Ok(pending_ids) +} diff --git a/vendor/rmcp/tests/test_streamable_http_4xx_error_body.rs b/vendor/rmcp/tests/test_streamable_http_4xx_error_body.rs new file mode 100644 index 00000000..13deeeb6 --- /dev/null +++ b/vendor/rmcp/tests/test_streamable_http_4xx_error_body.rs @@ -0,0 +1,154 @@ +#![cfg(all( + feature = "transport-streamable-http-client", + feature = "transport-streamable-http-client-reqwest", + not(feature = "local") +))] + +use std::{collections::HashMap, sync::Arc}; + +use rmcp::{ + model::{ + ClientJsonRpcMessage, ClientRequest, DiscoverRequest, DiscoverRequestParams, PingRequest, + RequestId, + }, + transport::streamable_http_client::{ + StreamableHttpClient, StreamableHttpError, StreamableHttpPostResponse, + }, +}; + +/// Spin up a minimal axum server that always responds with the given status, +/// content-type, and body — no MCP logic involved. +async fn spawn_mock_server(status: u16, content_type: &'static str, body: &'static str) -> String { + use axum::{Router, body::Body, http::Response, routing::post}; + + let router = Router::new().route( + "/mcp", + post(move || async move { + Response::builder() + .status(status) + .header("content-type", content_type) + .body(Body::from(body)) + .unwrap() + }), + ); + + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let addr = listener.local_addr().unwrap(); + tokio::spawn(async move { + axum::serve(listener, router).await.unwrap(); + }); + + format!("http://{addr}/mcp") +} + +fn ping_message() -> ClientJsonRpcMessage { + ClientJsonRpcMessage::request( + ClientRequest::PingRequest(PingRequest::default()), + RequestId::Number(1), + ) +} + +fn discover_message() -> ClientJsonRpcMessage { + ClientJsonRpcMessage::request( + ClientRequest::DiscoverRequest(DiscoverRequest::new(DiscoverRequestParams {})), + RequestId::Number(1), + ) +} + +/// HTTP 4xx with Content-Type: application/json and a valid JSON-RPC error body +/// must be surfaced as `StreamableHttpPostResponse::Json`, not swallowed as a +/// transport error. +#[tokio::test] +async fn http_4xx_json_rpc_error_body_is_surfaced_as_json_response() { + let body = r#"{"jsonrpc":"2.0","id":1,"error":{"code":-32600,"message":"Invalid Request"}}"#; + let url = spawn_mock_server(400, "application/json", body).await; + + let client = reqwest::Client::new(); + let result = client + .post_message( + Arc::from(url.as_str()), + ping_message(), + None, + None, + HashMap::new(), + ) + .await; + + match result { + Ok(StreamableHttpPostResponse::Json(msg, _)) => { + let json = serde_json::to_value(&msg).unwrap(); + assert_eq!(json["error"]["code"], -32600); + assert_eq!(json["error"]["message"], "Invalid Request"); + } + other => panic!("expected Json response, got: {other:?}"), + } +} + +/// HTTP 4xx with non-JSON content-type must still return `UnexpectedServerResponse` +/// (no regression on the original error path). +#[tokio::test] +async fn http_4xx_non_json_body_returns_unexpected_server_response() { + let url = spawn_mock_server(400, "text/plain", "Bad Request").await; + + let client = reqwest::Client::new(); + let result = client + .post_message( + Arc::from(url.as_str()), + ping_message(), + None, + None, + HashMap::new(), + ) + .await; + + match result { + Err(StreamableHttpError::UnexpectedServerResponse(_)) => {} + other => panic!("expected UnexpectedServerResponse, got: {other:?}"), + } +} + +/// HTTP 4xx with Content-Type: application/json but a body that is NOT a valid +/// JSON-RPC message must fall back to `UnexpectedServerResponse`. +#[tokio::test] +async fn http_4xx_malformed_json_body_falls_back_to_unexpected_server_response() { + let url = spawn_mock_server(400, "application/json", r#"{"error":"not jsonrpc"}"#).await; + + let client = reqwest::Client::new(); + let result = client + .post_message( + Arc::from(url.as_str()), + ping_message(), + None, + None, + HashMap::new(), + ) + .await; + + match result { + Err(StreamableHttpError::UnexpectedServerResponse(_)) => {} + other => panic!("expected UnexpectedServerResponse, got: {other:?}"), + } +} + +/// A discovery request attached to an existing session must retain the +/// transport error path; legacy fallback only applies to sessionless probes. +#[tokio::test] +async fn sessionful_discover_4xx_does_not_trigger_legacy_fallback() { + let url = spawn_mock_server(422, "text/plain", "Session-bound rejection").await; + + let client = reqwest::Client::new(); + let result = client + .post_message( + Arc::from(url.as_str()), + discover_message(), + Some(Arc::from("session-1")), + None, + HashMap::new(), + ) + .await; + + match result { + Err(StreamableHttpError::UnexpectedServerResponse(_)) => {} + other => panic!("expected UnexpectedServerResponse, got: {other:?}"), + } +} diff --git a/vendor/rmcp/tests/test_streamable_http_client_concurrency.rs b/vendor/rmcp/tests/test_streamable_http_client_concurrency.rs new file mode 100644 index 00000000..2e5be845 --- /dev/null +++ b/vendor/rmcp/tests/test_streamable_http_client_concurrency.rs @@ -0,0 +1,1143 @@ +//! Independent http POSTs may overlap. A POST that reports an expired session +//! is retried at most once. +#![cfg(not(feature = "local"))] + +use std::{ + collections::HashMap, + io, + sync::{ + Arc, Mutex as StdMutex, + atomic::{AtomicBool, AtomicUsize, Ordering::SeqCst}, + }, + time::Duration, +}; + +use futures::{StreamExt, stream::BoxStream}; +use http::{HeaderName, HeaderValue}; +use rmcp::{ + model::{ + CallToolRequestParams, CancelledNotificationParam, ClientConfig, ClientJsonRpcMessage, + ClientRequest, DiscoverResult, InitializeRequestParams, ProtocolVersion, Request, + RequestId, RequestMetaObject, ServerJsonRpcMessage, + }, + service::{ + ClientLifecycleMode, PeerRequestOptions, RequestHandle, RoleClient, RunningService, + serve_client_with_lifecycle, + }, + transport::streamable_http_client::{ + StreamableHttpClient, StreamableHttpClientTransport, StreamableHttpClientTransportConfig, + StreamableHttpError, StreamableHttpPostResponse, + }, +}; +use serde_json::{Value, json}; +use sse_stream::{Error as SseError, Sse}; +use tokio::{ + sync::{Mutex, mpsc, oneshot}, + task::JoinHandle, + time::timeout, +}; +use tokio_stream::wrappers::UnboundedReceiverStream; +use tokio_util::sync::CancellationToken; + +const TEST_TIMEOUT: Duration = Duration::from_secs(5); +type PostResult = Result>; +type Call = JoinHandle>; +type SseReceiver = mpsc::UnboundedReceiver>; + +#[derive(Default)] +struct Counts { + initialized: AtomicUsize, + hold_reinitialization: AtomicBool, + manual_controls: AtomicBool, + reject_unmatched_cancellation: AtomicBool, + local_streams: StdMutex>, + local_cancellations: AtomicUsize, + deleted: AtomicUsize, + cancelled: AtomicUsize, + posted: AtomicUsize, + active: AtomicUsize, + peak: AtomicUsize, +} + +struct ActivePost(Arc); + +impl Drop for ActivePost { + fn drop(&mut self) { + self.0.active.fetch_sub(1, SeqCst); + } +} + +struct LocalStreamRegistration { + id: RequestId, + counts: Arc, + dropped: Option>, +} + +impl Drop for LocalStreamRegistration { + fn drop(&mut self) { + self.counts.local_streams.lock().unwrap().remove(&self.id); + let _ = self.dropped.take().unwrap().send(()); + } +} + +struct Posted { + id: Value, + name: String, + session: Option>, + reply: oneshot::Sender, + returned: oneshot::Receiver<()>, +} + +struct ControlPost { + message: Value, + session: Option>, + reply: oneshot::Sender, +} + +fn response(id: Value, result: Value) -> ServerJsonRpcMessage { + serde_json::from_value(json!({ "jsonrpc": "2.0", "id": id, "result": result })) + .expect("valid scripted response") +} + +fn sse(message: Value) -> Result { + Ok(Sse { + event: Some("message".into()), + data: Some(message.to_string()), + id: None, + retry: None, + }) +} + +async fn next_event(receiver: &mut mpsc::UnboundedReceiver) -> T { + timeout(TEST_TIMEOUT, receiver.recv()) + .await + .expect("expected scripted event") + .expect("scripted client remains connected") +} + +impl Posted { + fn result(&self) -> ServerJsonRpcMessage { + response( + self.id.clone(), + json!({ "content": [{ "type": "text", "text": self.name }] }), + ) + } + + fn finish(self, result: PostResult) { + self.reply.send(result).expect("POST is still waiting"); + } + + fn succeed(self) { + let result = StreamableHttpPostResponse::Json(self.result(), None); + self.finish(Ok(result)); + } + + fn expire(self) { + self.finish(Err(StreamableHttpError::SessionExpired)); + } + + async fn finish_and_wait(self, result: PostResult) -> anyhow::Result<()> { + let Self { + reply, returned, .. + } = self; + reply.send(result).expect("POST is still waiting"); + timeout(TEST_TIMEOUT, returned).await??; + Ok(()) + } + + async fn expire_and_wait(self) -> anyhow::Result<()> { + self.finish_and_wait(Err(StreamableHttpError::SessionExpired)) + .await + } + + async fn start_sse(self) -> anyhow::Result> { + let message = serde_json::to_value(self.result()).unwrap(); + let (release, released) = oneshot::channel(); + let stream = futures::stream::once(async move { + released.await.expect("release the SSE response"); + sse(message) + }) + .boxed(); + self.finish_and_wait(Ok(StreamableHttpPostResponse::Sse(stream, None))) + .await?; + Ok(release) + } + + async fn start_local_sse( + self, + counts: Arc, + ) -> anyhow::Result<(CancellationToken, oneshot::Receiver<()>)> { + let id: RequestId = serde_json::from_value(self.id.clone())?; + let cancellation = CancellationToken::new(); + let eof = cancellation.clone(); + counts + .local_streams + .lock() + .unwrap() + .insert(id.clone(), cancellation.clone()); + let (dropped, closed) = oneshot::channel(); + let registration = LocalStreamRegistration { + id, + counts, + dropped: Some(dropped), + }; + let (started, listening) = oneshot::channel(); + let stream = futures::stream::once(async move { + let _registration = registration; + let _ = started.send(()); + cancellation.cancelled().await; + None::> + }) + .filter_map(futures::future::ready) + .boxed(); + self.finish_and_wait(Ok(StreamableHttpPostResponse::Sse(stream, None))) + .await?; + timeout(TEST_TIMEOUT, listening).await??; + Ok((eof, closed)) + } +} + +#[derive(Clone)] +struct ScriptedClient { + started: mpsc::UnboundedSender, + controls: mpsc::UnboundedSender, + incoming: Arc>>, + reinitializing: mpsc::UnboundedSender>, + counts: Arc, +} + +impl ScriptedClient { + async fn control_post(&self, message: Value, session: Option>) -> PostResult { + if !self.counts.manual_controls.load(SeqCst) { + return Ok(StreamableHttpPostResponse::Accepted); + } + let (reply, result) = oneshot::channel(); + self.controls + .send(ControlPost { + message, + session, + reply, + }) + .expect("test remains connected"); + result.await.expect("test answers the control POST") + } +} + +impl StreamableHttpClient for ScriptedClient { + type Error = io::Error; + + async fn post_message( + &self, + _uri: Arc, + message: ClientJsonRpcMessage, + session: Option>, + _auth_header: Option, + _custom_headers: HashMap, + ) -> PostResult { + let value = serde_json::to_value(message).unwrap(); + match value["method"].as_str() { + Some("server/discover") => Ok(StreamableHttpPostResponse::Json( + response( + value["id"].clone(), + serde_json::to_value(DiscoverResult::new( + vec![ProtocolVersion::V_2026_07_28], + serde_json::from_value(json!({ "tools": {} })).unwrap(), + )) + .unwrap(), + ), + None, + )), + Some("initialize") => { + let generation = self.counts.initialized.fetch_add(1, SeqCst) + 1; + if generation > 1 && self.counts.hold_reinitialization.load(SeqCst) { + let (release, released) = oneshot::channel(); + self.reinitializing + .send(release) + .expect("test remains connected"); + released.await.expect("test releases reinitialization"); + } + Ok(StreamableHttpPostResponse::Json( + response( + value["id"].clone(), + json!({ + "protocolVersion": "2025-11-25", + "capabilities": { "tools": {} }, + "serverInfo": { "name": "scripted", "version": "1" }, + }), + ), + Some(format!("session-{generation}")), + )) + } + Some("notifications/initialized") => Ok(StreamableHttpPostResponse::Accepted), + Some("notifications/cancelled") => { + let id: RequestId = + serde_json::from_value(value["params"]["requestId"].clone()).unwrap(); + let local = self.counts.local_streams.lock().unwrap().get(&id).cloned(); + if let Some(cancellation) = local { + self.counts.local_cancellations.fetch_add(1, SeqCst); + cancellation.cancel(); + return Ok(StreamableHttpPostResponse::Accepted); + } + self.counts.cancelled.fetch_add(1, SeqCst); + if self.counts.reject_unmatched_cancellation.load(SeqCst) { + return Err(StreamableHttpError::Client(io::Error::other( + "local event cancellation reached the http POST path", + ))); + } + self.control_post(value, session).await + } + Some("tools/call") => { + self.counts.posted.fetch_add(1, SeqCst); + let active = self.counts.active.fetch_add(1, SeqCst) + 1; + self.counts.peak.fetch_max(active, SeqCst); + let _active = ActivePost(self.counts.clone()); + let (reply, response) = oneshot::channel(); + let (finished, returned) = oneshot::channel(); + self.started + .send(Posted { + id: value["id"].clone(), + name: value["params"]["name"].as_str().unwrap().to_owned(), + session, + reply, + returned, + }) + .expect("test remains connected"); + let response = response.await.expect("test answers each POST"); + let _ = finished.send(()); + response + } + None if value.get("result").is_some() || value.get("error").is_some() => { + self.control_post(value, session).await + } + method => panic!("unexpected scripted method: {method:?}"), + } + } + + async fn delete_session( + &self, + _uri: Arc, + _session: Arc, + _auth_header: Option, + _custom_headers: HashMap, + ) -> Result<(), StreamableHttpError> { + assert_eq!( + self.counts.active.load(SeqCst), + 0, + "POSTs must stop before deleting the session" + ); + self.counts.deleted.fetch_add(1, SeqCst); + Ok(()) + } + + async fn get_stream( + &self, + _uri: Arc, + _session: Option>, + _last_event_id: Option, + _auth_header: Option, + _custom_headers: HashMap, + ) -> Result>, StreamableHttpError> { + Ok(match self.incoming.lock().await.take() { + Some(incoming) => UnboundedReceiverStream::new(incoming).boxed(), + None => futures::stream::pending().boxed(), + }) + } +} + +struct Harness { + client: RunningService, + started: mpsc::UnboundedReceiver, + controls: mpsc::UnboundedReceiver, + incoming: mpsc::UnboundedSender>, + reinitializations: mpsc::UnboundedReceiver>, + counts: Arc, +} + +fn config() -> StreamableHttpClientTransportConfig { + StreamableHttpClientTransportConfig::with_uri("http://scripted/mcp") +} + +fn transport_error(error: &anyhow::Error) -> &StreamableHttpError { + let service_error = error + .downcast_ref::() + .expect("expected a service error"); + let rmcp::ServiceError::TransportSend(transport_error) = service_error else { + panic!("expected a transport error, got {service_error:?}"); + }; + transport_error + .error + .downcast_ref::>() + .expect("expected a streamable http error") +} + +fn assert_recovery_timeout(error: anyhow::Error) { + assert!(matches!( + transport_error(&error), + StreamableHttpError::SessionRecoveryTimeout + )); +} + +impl Harness { + async fn start(config: StreamableHttpClientTransportConfig) -> anyhow::Result { + Self::with_lifecycle(config, ClientLifecycleMode::Initialize).await + } + + async fn with_lifecycle( + config: StreamableHttpClientTransportConfig, + lifecycle: ClientLifecycleMode, + ) -> anyhow::Result { + let (started, requests) = mpsc::unbounded_channel(); + let (control_tx, controls) = mpsc::unbounded_channel(); + let (incoming, incoming_rx) = mpsc::unbounded_channel(); + let (reinitializing, reinitializations) = mpsc::unbounded_channel(); + let counts = Arc::new(Counts::default()); + let transport = StreamableHttpClientTransport::with_client( + ScriptedClient { + started, + controls: control_tx, + incoming: Arc::new(Mutex::new(Some(incoming_rx))), + reinitializing, + counts: counts.clone(), + }, + config, + ); + let client = + serve_client_with_lifecycle(ClientConfig::default(), transport, lifecycle).await?; + Ok(Self { + client, + started: requests, + controls, + incoming, + reinitializations, + counts, + }) + } + + fn call(&self, name: impl Into) -> Call { + let name = name.into(); + let peer = self.client.peer().clone(); + tokio::spawn(async move { + let result = peer + .call_tool(CallToolRequestParams::new(name.clone())) + .await?; + anyhow::ensure!(serde_json::to_value(result)?["content"][0]["text"] == name); + Ok(()) + }) + } + + async fn cancellable(&self, name: &'static str) -> anyhow::Result> { + self.cancellable_with_options(name, PeerRequestOptions::no_options()) + .await + } + + async fn cancellable_with_options( + &self, + name: &'static str, + options: PeerRequestOptions, + ) -> anyhow::Result> { + Ok(self + .client + .peer() + .send_cancellable_request( + ClientRequest::CallToolRequest(Request::new(CallToolRequestParams::new(name))), + options, + ) + .await?) + } + + fn notify_cancellation(&self, id: RequestId) -> JoinHandle> { + let peer = self.client.peer().clone(); + tokio::spawn(async move { + peer.notify_cancelled(CancelledNotificationParam::new(Some(id), None)) + .await + }) + } + + async fn next(&mut self) -> Posted { + next_event(&mut self.started).await + } + + async fn next_control(&mut self) -> ControlPost { + next_event(&mut self.controls).await + } + + async fn exchange_ping(&mut self, id: &str) { + self.incoming + .send(sse(json!({ "jsonrpc": "2.0", "id": id, "method": "ping" }))) + .expect("common SSE stream remains open"); + let control = self.next_control().await; + assert_eq!(control.message["id"], id); + assert!(control.message["result"].is_object()); + assert_eq!(control.session.as_deref(), Some("session-1")); + control + .reply + .send(Ok(StreamableHttpPostResponse::Accepted)) + .expect("reply POST is still waiting"); + } + + async fn finish( + self, + calls: Vec, + posted: usize, + initialized: usize, + ) -> anyhow::Result<()> { + for call in calls { + timeout(TEST_TIMEOUT, call).await???; + } + assert_eq!(self.counts.posted.load(SeqCst), posted); + assert_eq!(self.counts.initialized.load(SeqCst), initialized); + assert_eq!(self.counts.active.load(SeqCst), 0); + self.client.cancel().await?; + Ok(()) + } +} + +#[tokio::test] +async fn json_limits_allow_overlap_and_preserve_response_ids() -> anyhow::Result<()> { + let mut zero = config(); + zero.max_concurrent_requests = 0; + for (config, limit, total) in [ + (config().max_concurrent_requests(2), 2, 5), + (config().max_concurrent_requests(1), 1, 3), + (zero, 1, 2), + (config(), 16, 17), + ] { + let mut harness = Harness::start(config).await?; + let calls = (0..total) + .map(|index| harness.call(format!("request-{index}"))) + .collect(); + let mut pending = Vec::new(); + for _ in 0..limit { + pending.push(harness.next().await); + } + assert_eq!(harness.counts.active.load(SeqCst), limit); + // Keep the oldest response blocked while newer requests finish first. + for _ in limit..total { + pending.pop().unwrap().succeed(); + pending.push(harness.next().await); + } + for request in pending.into_iter().rev() { + request.succeed(); + } + let counts = harness.counts.clone(); + harness.finish(calls, total, 1).await?; + assert_eq!(counts.peak.load(SeqCst), limit); + } + Ok(()) +} + +#[tokio::test] +async fn early_sse_response_releases_the_post_slot() -> anyhow::Result<()> { + let mut harness = Harness::start(config().max_concurrent_requests(1)).await?; + let first = harness.call("first"); + let release = harness.next().await.start_sse().await?; + let second = harness.call("second"); + harness.next().await.succeed(); + timeout(TEST_TIMEOUT, second).await???; + assert!(!first.is_finished(), "the SSE response is still blocked"); + release.send(()).unwrap(); + assert_eq!(harness.counts.peak.load(SeqCst), 1); + harness.finish(vec![first], 2, 1).await +} + +#[tokio::test] +async fn a_common_stream_response_finishes_the_request_before_its_post_returns() +-> anyhow::Result<()> { + let (stream, incoming) = mpsc::unbounded_channel(); + for (late, orphan) in [ + (Ok(StreamableHttpPostResponse::Accepted), None), + (Err(StreamableHttpError::SessionExpired), None), + ( + Ok(StreamableHttpPostResponse::Sse( + UnboundedReceiverStream::new(incoming).boxed(), + None, + )), + Some(stream), + ), + ] { + let mut harness = Harness::start(config().max_concurrent_requests(1)).await?; + let request = harness.cancellable("completed-on-common-stream").await?; + let post = harness.next().await; + harness + .incoming + .send(sse(serde_json::to_value(post.result())?))?; + timeout(TEST_TIMEOUT, request.await_response()).await??; + + post.finish_and_wait(late).await?; + let next = harness.call("after-completed-request"); + let post = harness.next().await; + assert_eq!( + post.name, "after-completed-request", + "do not retry completed work" + ); + assert_eq!(post.session.as_deref(), Some("session-1")); + post.succeed(); + timeout(TEST_TIMEOUT, next).await???; + if let Some(stream) = orphan { + timeout(Duration::from_secs(1), stream.closed()) + .await + .expect("a late SSE response must not leave an orphan stream"); + } + harness.finish(vec![], 2, 1).await?; + } + Ok(()) +} + +#[tokio::test] +async fn common_stream_response_keeps_numeric_and_string_ids_distinct() -> anyhow::Result<()> { + use rmcp::transport::Transport; + + let (started, mut requests) = mpsc::unbounded_channel(); + let (incoming, incoming_rx) = mpsc::unbounded_channel(); + let counts = Arc::new(Counts::default()); + let mut transport = StreamableHttpClientTransport::with_client( + ScriptedClient { + started, + controls: mpsc::unbounded_channel().0, + incoming: Arc::new(Mutex::new(Some(incoming_rx))), + reinitializing: mpsc::unbounded_channel().0, + counts: counts.clone(), + }, + config(), + ); + for message in [ + json!({ + "jsonrpc": "2.0", + "id": 0, + "method": "initialize", + "params": InitializeRequestParams::default() + }), + json!({ "jsonrpc": "2.0", "method": "notifications/initialized" }), + ] { + timeout( + TEST_TIMEOUT, + transport.send(serde_json::from_value(message)?), + ) + .await??; + } + assert!(timeout(TEST_TIMEOUT, transport.receive()).await?.is_some()); + let call = |id, name| { + ClientJsonRpcMessage::request( + ClientRequest::CallToolRequest(Request::new(CallToolRequestParams::new(name))), + id, + ) + }; + + let mut numeric_send = Box::pin(transport.send(call(RequestId::Number(7), "numeric"))); + assert!(futures::poll!(numeric_send.as_mut()).is_pending()); + let numeric_post = next_event(&mut requests).await; + let numeric_result = numeric_post.result(); + let release_numeric = numeric_post.start_sse().await?; + timeout(TEST_TIMEOUT, numeric_send).await??; + + // This exact string id is pending, but has no response stream registration. + let mut string_send = Box::pin(transport.send(call(RequestId::String("7".into()), "string"))); + assert!(futures::poll!(string_send.as_mut()).is_pending()); + let string_post = next_event(&mut requests).await; + let string_result = serde_json::to_value(string_post.result())?; + string_post.finish(Ok(StreamableHttpPostResponse::Accepted)); + timeout(TEST_TIMEOUT, string_send).await??; + + incoming.send(sse(string_result.clone()))?; + let received = timeout(TEST_TIMEOUT, transport.receive()) + .await? + .expect("string-id response"); + assert_eq!(serde_json::to_value(received)?, string_result); + + release_numeric + .send(()) + .expect("the distinct numeric-id stream must remain open"); + let received = timeout(TEST_TIMEOUT, transport.receive()) + .await? + .expect("numeric-id response"); + assert_eq!( + serde_json::to_value(received)?, + serde_json::to_value(numeric_result)? + ); + assert_eq!(counts.posted.load(SeqCst), 2); + assert_eq!(counts.cancelled.load(SeqCst), 0); + transport.close().await?; + Ok(()) +} + +#[tokio::test] +async fn a_common_stream_response_prevents_replay_during_session_recovery() -> anyhow::Result<()> { + let mut harness = Harness::start(config().max_concurrent_requests(2)).await?; + let blocking = harness.call("blocking-recovery"); + let blocked = harness.next().await; + let request = harness.cancellable("completed-during-recovery").await?; + let expired = harness.next().await; + let final_response = sse(serde_json::to_value(expired.result())?); + expired.expire_and_wait().await?; + harness.incoming.send(final_response)?; + timeout(TEST_TIMEOUT, request.await_response()).await??; + blocked.succeed(); + timeout(TEST_TIMEOUT, blocking).await???; + + let next = harness.call("after-completed-request"); + let post = harness.next().await; + assert_eq!( + post.name, "after-completed-request", + "do not retry completed work" + ); + let initializations = harness.counts.initialized.load(SeqCst); + assert!((1..=2).contains(&initializations)); + post.succeed(); + timeout(TEST_TIMEOUT, next).await???; + harness.finish(vec![], 3, initializations).await +} + +#[tokio::test] +async fn concurrent_session_expiry_shares_one_reinitialization() -> anyhow::Result<()> { + let mut harness = Harness::start(config().max_concurrent_requests(2)).await?; + let calls = vec![harness.call("first"), harness.call("second")]; + // Hold both requests before releasing either expired response. + let first = harness.next().await; + let second = harness.next().await; + let mut originals = HashMap::new(); + for request in [first, second] { + assert_eq!(request.session.as_deref(), Some("session-1")); + originals.insert(request.name.clone(), request.id.clone()); + request.expire(); + } + for _ in 0..2 { + let retry = harness.next().await; + assert_eq!(retry.session.as_deref(), Some("session-2")); + assert_eq!(originals.remove(&retry.name), Some(retry.id.clone())); + retry.succeed(); + } + assert!(originals.is_empty()); + harness.finish(calls, 4, 2).await +} + +#[tokio::test] +async fn cancellation_still_runs_while_recovery_waits_for_old_posts() -> anyhow::Result<()> { + let mut harness = Harness::start(config().max_concurrent_requests(3)).await?; + let hanging = harness.cancellable("hanging").await?; + let mut blocked = harness.next().await; + let expired = harness.call("expired"); + harness.next().await.expire_and_wait().await?; + assert_eq!(harness.counts.initialized.load(SeqCst), 1); + assert_eq!(harness.counts.active.load(SeqCst), 1); + + timeout(Duration::from_secs(1), hanging.cancel(None)) + .await + .expect("cancellation must bypass the session recovery wait")?; + timeout(TEST_TIMEOUT, blocked.reply.closed()).await?; + let retry = harness.next().await; + assert_eq!(retry.name, "expired"); + assert_eq!(retry.session.as_deref(), Some("session-2")); + retry.succeed(); + harness.finish(vec![expired], 3, 2).await +} + +#[tokio::test] +async fn server_replies_still_run_while_recovery_waits_for_old_posts() -> anyhow::Result<()> { + let mut harness = Harness::start(config().max_concurrent_requests(2)).await?; + harness.counts.manual_controls.store(true, SeqCst); + let waiting = harness.call("waiting-for-client"); + let blocked = harness.next().await; + let expired = harness.call("expired"); + harness.next().await.expire_and_wait().await?; + + harness.exchange_ping("recovery-ping").await; + blocked.succeed(); + let retry = harness.next().await; + assert_eq!(retry.name, "expired"); + assert_eq!(retry.session.as_deref(), Some("session-2")); + retry.succeed(); + harness.finish(vec![waiting, expired], 3, 2).await +} + +#[tokio::test] +async fn a_version_barrier_allows_the_server_reply_it_needs() -> anyhow::Result<()> { + let mut harness = Harness::start(config().max_concurrent_requests(2)).await?; + harness.counts.manual_controls.store(true, SeqCst); + let mut meta = RequestMetaObject::new(); + meta.set_protocol_version(ProtocolVersion::V_2025_06_18); + let barrier = harness + .cancellable_with_options("barrier", PeerRequestOptions::no_options().with_meta(meta)) + .await?; + let blocked = harness.next().await; + let queued = harness.cancellable("after-barrier").await?; + + harness.exchange_ping("barrier-ping").await; + assert_eq!(harness.counts.posted.load(SeqCst), 1); + blocked.succeed(); + timeout(TEST_TIMEOUT, barrier.await_response()).await??; + let next = harness.next().await; + assert_eq!(next.name, "after-barrier"); + next.succeed(); + timeout(TEST_TIMEOUT, queued.await_response()).await??; + harness.finish(vec![], 2, 1).await +} + +#[tokio::test] +async fn a_cancelled_version_barrier_does_not_block_unrelated_posts() -> anyhow::Result<()> { + let mut harness = Harness::start(config().max_concurrent_requests(2)).await?; + let blocking = harness.call("blocking"); + let blocked = harness.next().await; + let mut meta = RequestMetaObject::new(); + meta.set_protocol_version(ProtocolVersion::V_2025_06_18); + let barrier = harness + .cancellable_with_options( + "cancelled-barrier", + PeerRequestOptions::no_options().with_meta(meta), + ) + .await?; + timeout(TEST_TIMEOUT, barrier.cancel(None)).await??; + + let next = harness.call("after-cancelled-barrier"); + let post = harness.next().await; + assert_eq!(post.name, "after-cancelled-barrier"); + post.succeed(); + timeout(TEST_TIMEOUT, next).await???; + assert!(!blocked.reply.is_closed(), "the older POST is still held"); + blocked.succeed(); + harness.finish(vec![blocking], 2, 1).await +} + +#[tokio::test] +async fn dropping_a_parked_barrier_send_unblocks_the_ordinary_queue() -> anyhow::Result<()> { + use std::task::{Context, Wake, Waker}; + + use rmcp::transport::Transport; + + struct WakeSignal(mpsc::UnboundedSender<()>); + impl Wake for WakeSignal { + fn wake(self: Arc) { + let _ = self.0.send(()); + } + } + + let (started, mut requests) = mpsc::unbounded_channel(); + let counts = Arc::new(Counts::default()); + let mut config = config().max_concurrent_requests(2); + config.channel_buffer_capacity = 1; + let mut transport = StreamableHttpClientTransport::with_client( + ScriptedClient { + started, + controls: mpsc::unbounded_channel().0, + incoming: Arc::new(Mutex::new(None)), + reinitializing: mpsc::unbounded_channel().0, + counts: counts.clone(), + }, + config, + ); + for message in [ + json!({ + "jsonrpc": "2.0", + "id": 0, + "method": "initialize", + "params": InitializeRequestParams::default() + }), + json!({ "jsonrpc": "2.0", "method": "notifications/initialized" }), + ] { + timeout( + TEST_TIMEOUT, + transport.send(serde_json::from_value(message)?), + ) + .await??; + } + assert!(timeout(TEST_TIMEOUT, transport.receive()).await?.is_some()); + let call = |id, params| { + ClientJsonRpcMessage::request( + ClientRequest::CallToolRequest(Request::new(params)), + RequestId::Number(id), + ) + }; + let mut first = Box::pin(transport.send(call(1, CallToolRequestParams::new("held")))); + assert!(futures::poll!(first.as_mut()).is_pending()); + let blocked = next_event(&mut requests).await; + + let mut meta = RequestMetaObject::new(); + meta.set_protocol_version(ProtocolVersion::V_2025_06_18); + let mut barrier_request = Request::new(CallToolRequestParams::new("abandoned-barrier")); + barrier_request.extensions.insert(meta); + let mut barrier = Box::pin(transport.send(ClientJsonRpcMessage::request( + ClientRequest::CallToolRequest(barrier_request), + RequestId::Number(2), + ))); + assert!(futures::poll!(barrier.as_mut()).is_pending()); + let mut next = Box::pin(transport.send(call(3, CallToolRequestParams::new("after-barrier")))); + let (wake, mut woke) = mpsc::unbounded_channel(); + let waker = Waker::from(Arc::new(WakeSignal(wake))); + assert!( + next.as_mut() + .poll(&mut Context::from_waker(&waker)) + .is_pending() + ); + // The barrier fills the queue. The next send wakes only after the worker parks it. + next_event(&mut woke).await; + assert_eq!(counts.posted.load(SeqCst), 1, "the barrier must be parked"); + drop(barrier); + assert!(futures::poll!(next.as_mut()).is_pending()); + + let post = timeout(Duration::from_secs(1), requests.recv()) + .await + .expect("dropping the parked send must wake the worker") + .unwrap(); + assert_eq!(post.name, "after-barrier"); + post.succeed(); + timeout(TEST_TIMEOUT, next).await??; + assert!(timeout(TEST_TIMEOUT, transport.receive()).await?.is_some()); + assert!(!blocked.reply.is_closed(), "the first POST remains held"); + blocked.succeed(); + timeout(TEST_TIMEOUT, first).await??; + assert_eq!(counts.posted.load(SeqCst), 2); + assert_eq!(counts.cancelled.load(SeqCst), 0); + transport.close().await?; + Ok(()) +} + +#[tokio::test] +async fn recovery_deadline_drops_ambiguous_posts_without_retrying_them() -> anyhow::Result<()> { + assert_eq!(config().session_recovery_timeout, Duration::from_secs(5)); + let mut harness = Harness::start( + config() + .max_concurrent_requests(3) + .session_recovery_timeout(Duration::from_millis(50)), + ) + .await?; + let ambiguous = harness.call("possibly-applied"); + let mut blocked = harness.next().await; + let expired = harness.call("expired"); + let rejected = harness.next().await; + let rejected_id = rejected.id.clone(); + rejected.expire_and_wait().await?; + + assert_recovery_timeout(timeout(TEST_TIMEOUT, ambiguous).await??.unwrap_err()); + timeout(TEST_TIMEOUT, blocked.reply.closed()).await?; + let retry = harness.next().await; + assert_eq!(retry.name, "expired"); + assert_eq!(retry.id, rejected_id); + assert_eq!(retry.session.as_deref(), Some("session-2")); + retry.succeed(); + harness.finish(vec![expired], 3, 2).await +} + +#[tokio::test] +async fn reinitialization_has_its_own_deadline() -> anyhow::Result<()> { + let mut harness = + Harness::start(config().session_recovery_timeout(Duration::from_millis(50))).await?; + harness.counts.hold_reinitialization.store(true, SeqCst); + let expired = harness.call("expired"); + harness.next().await.expire_and_wait().await?; + let mut reinitialization = next_event(&mut harness.reinitializations).await; + + assert_recovery_timeout(timeout(TEST_TIMEOUT, expired).await??.unwrap_err()); + timeout(TEST_TIMEOUT, reinitialization.closed()).await?; + harness.finish(vec![], 1, 2).await +} + +#[tokio::test] +async fn an_expired_retry_is_not_retried_again() -> anyhow::Result<()> { + let mut harness = Harness::start(config().max_concurrent_requests(2)).await?; + let call = harness.call("expires-twice"); + let first = harness.next().await; + let id = first.id.clone(); + first.expire(); + let retry = harness.next().await; + assert_eq!(retry.id, id); + assert_eq!(retry.session.as_deref(), Some("session-2")); + retry.expire(); + let error = timeout(TEST_TIMEOUT, call).await??.unwrap_err(); + assert!(error.to_string().contains("Session expired")); + harness.finish(vec![], 2, 2).await +} + +#[tokio::test] +async fn a_lost_post_response_is_not_retried() -> anyhow::Result<()> { + let mut harness = Harness::start(config().max_concurrent_requests(2)).await?; + let call = harness.call("possibly-applied"); + harness + .next() + .await + .finish(Err(StreamableHttpError::Client(io::Error::new( + io::ErrorKind::ConnectionReset, + "scripted response lost", + )))); + let error = timeout(TEST_TIMEOUT, call).await??.unwrap_err(); + assert!(error.to_string().contains("scripted response lost")); + harness.finish(vec![], 1, 1).await +} + +#[tokio::test] +async fn cancellation_bypasses_queued_posts_at_capacity() -> anyhow::Result<()> { + for (lifecycle, legacy_notifications, initializations) in [ + (ClientLifecycleMode::Initialize, 2, 1), + ( + ClientLifecycleMode::Discover { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + }, + 0, + 0, + ), + ] { + let mut harness = + Harness::with_lifecycle(config().max_concurrent_requests(1), lifecycle).await?; + let request = harness.cancellable("cancel-me").await?; + let mut blocked = harness.next().await; + let cancelled = harness.cancellable("never-send").await?; + timeout(TEST_TIMEOUT, cancelled.cancel(None)).await??; + let queued = harness.cancellable("queued").await?; + timeout(TEST_TIMEOUT, request.cancel(None)).await??; + timeout(TEST_TIMEOUT, blocked.reply.closed()).await?; + let next = harness.next().await; + assert_eq!(next.name, "queued"); + next.succeed(); + timeout(TEST_TIMEOUT, queued.await_response()).await??; + assert_eq!(harness.counts.cancelled.load(SeqCst), legacy_notifications); + harness.finish(vec![], 2, initializations).await?; + } + Ok(()) +} + +#[tokio::test] +async fn legacy_cancellation_reaches_the_adapter_before_its_local_stream_drops() +-> anyhow::Result<()> { + let mut harness = Harness::start(config().max_concurrent_requests(1)).await?; + harness.counts.manual_controls.store(true, SeqCst); + let stale = harness.notify_cancellation(RequestId::Number(999)); + let held = harness.next_control().await; + harness.counts.manual_controls.store(false, SeqCst); + harness + .counts + .reject_unmatched_cancellation + .store(true, SeqCst); + + let event = harness.cancellable("local-events").await?; + let (eof, dropped) = harness + .next() + .await + .start_local_sse(harness.counts.clone()) + .await?; + let peer = harness.client.peer().clone(); + let mut cancel = Box::pin(peer.notify_cancelled(CancelledNotificationParam::new( + Some(event.id.clone()), + None, + ))); + assert!(futures::poll!(cancel.as_mut()).is_pending()); + // The ordinary request follows the cancellation through the service queue. + let probe = harness.call("after-cancellation"); + harness.next().await.succeed(); + timeout(TEST_TIMEOUT, probe).await???; + + // EOF is ready, but queued cancellation must pause reads until dispatch. + eof.cancel(); + let probe = harness.call("after-eof"); + harness.next().await.succeed(); + timeout(TEST_TIMEOUT, probe).await???; + assert!( + harness + .counts + .local_streams + .lock() + .unwrap() + .contains_key(&event.id), + "the adapter's stream registration must survive queued cancellation" + ); + assert!(!held.reply.is_closed(), "the control slot is still held"); + + held.reply + .send(Ok(StreamableHttpPostResponse::Accepted)) + .unwrap(); + timeout(TEST_TIMEOUT, stale).await???; + timeout(TEST_TIMEOUT, cancel).await??; + timeout(TEST_TIMEOUT, dropped).await??; + assert!(matches!( + timeout(TEST_TIMEOUT, event.await_response()).await?, + Err(rmcp::ServiceError::Cancelled { .. }) + )); + assert_eq!(harness.counts.local_cancellations.load(SeqCst), 1); + assert_eq!(harness.counts.cancelled.load(SeqCst), 1); + harness.finish(vec![], 3, 1).await +} + +#[tokio::test] +async fn control_timeout_is_configurable_and_releases_its_slot() -> anyhow::Result<()> { + assert_eq!(config().control_request_timeout, Duration::from_secs(5)); + let mut harness = + Harness::start(config().control_request_timeout(Duration::from_millis(50))).await?; + harness.counts.manual_controls.store(true, SeqCst); + let cancellation = harness.notify_cancellation(RequestId::Number(999)); + let mut cancelled_post = harness.next_control().await; + harness.incoming.send(sse(json!({ + "jsonrpc": "2.0", "id": "timed-reply", "method": "ping" + })))?; + + let error = timeout(Duration::from_secs(1), cancellation) + .await?? + .unwrap_err(); + assert!(matches!( + transport_error(&error.into()), + StreamableHttpError::ControlRequestTimeout + )); + timeout(Duration::from_secs(1), cancelled_post.reply.closed()).await?; + + let mut reply_post = harness.next_control().await; + assert_eq!(reply_post.message["id"], "timed-reply"); + assert!(reply_post.message["result"].is_object()); + harness.counts.manual_controls.store(false, SeqCst); + let next = harness.notify_cancellation(RequestId::Number(1000)); + timeout(Duration::from_secs(1), reply_post.reply.closed()).await?; + timeout(Duration::from_secs(1), next).await???; + assert_eq!(harness.counts.cancelled.load(SeqCst), 2); + harness.finish(vec![], 0, 1).await +} + +#[tokio::test] +async fn a_hanging_legacy_control_does_not_delay_local_cancellation() -> anyhow::Result<()> { + let mut harness = Harness::start(config().max_concurrent_requests(1)).await?; + harness.counts.manual_controls.store(true, SeqCst); + let stale = harness.notify_cancellation(RequestId::Number(999)); + let mut held = harness.next_control().await; + assert_eq!(held.message["params"]["requestId"], 999); + harness.counts.manual_controls.store(false, SeqCst); + + let live = harness.cancellable("live-post").await?; + let mut blocked = harness.next().await; + let cancel_post = tokio::spawn(async move { live.cancel(None).await }); + timeout(Duration::from_secs(1), blocked.reply.closed()).await?; + + let streaming = harness.cancellable("live-stream").await?; + let mut stream = harness.next().await.start_sse().await?; + let cancel_stream = harness.notify_cancellation(streaming.id.clone()); + assert!( + !held.reply.is_closed(), + "the old control POST is still held" + ); + assert_eq!(harness.counts.cancelled.load(SeqCst), 1); + + // The default control timeout is five seconds; give its watchdog headroom. + let error = timeout(Duration::from_secs(10), stale).await??.unwrap_err(); + assert!(matches!( + transport_error(&error.into()), + StreamableHttpError::ControlRequestTimeout + )); + timeout(TEST_TIMEOUT, held.reply.closed()).await?; + timeout(TEST_TIMEOUT, cancel_post).await???; + timeout(TEST_TIMEOUT, cancel_stream).await???; + timeout(TEST_TIMEOUT, stream.closed()).await?; + assert!(matches!( + timeout(TEST_TIMEOUT, streaming.await_response()).await?, + Err(rmcp::ServiceError::Cancelled { .. }) + )); + assert_eq!(harness.counts.cancelled.load(SeqCst), 3); + harness.finish(vec![], 2, 1).await +} + +#[tokio::test] +async fn close_drops_blocked_posts_before_deleting_the_session() -> anyhow::Result<()> { + let mut harness = Harness::start(config().max_concurrent_requests(2)).await?; + let calls = [harness.call("first"), harness.call("second")]; + let posts = [harness.next().await, harness.next().await]; + timeout(TEST_TIMEOUT, harness.client.cancel()).await??; + assert!(posts.iter().all(|post| post.reply.is_closed())); + assert_eq!(harness.counts.active.load(SeqCst), 0); + assert_eq!(harness.counts.deleted.load(SeqCst), 1); + for call in calls { + assert!(timeout(TEST_TIMEOUT, call).await??.is_err()); + } + Ok(()) +} diff --git a/vendor/rmcp/tests/test_streamable_http_connection_reuse.rs b/vendor/rmcp/tests/test_streamable_http_connection_reuse.rs new file mode 100644 index 00000000..aa4ae63c --- /dev/null +++ b/vendor/rmcp/tests/test_streamable_http_connection_reuse.rs @@ -0,0 +1,122 @@ +#![cfg(not(feature = "local"))] + +use std::time::Instant; + +use rmcp::{ + ServerHandler, ServiceExt, + handler::server::{router::tool::ToolRouter, wrapper::Parameters}, + model::{CallToolRequestParams, ClientConfig, ServerCapabilities, ServerConfig}, + schemars, tool, tool_handler, tool_router, + transport::{ + StreamableHttpClientTransport, + streamable_http_client::StreamableHttpClientTransportConfig, + streamable_http_server::{ + StreamableHttpServerConfig, StreamableHttpService, session::local::LocalSessionManager, + }, + }, +}; +use tokio_util::sync::CancellationToken; + +#[derive(Debug, serde::Deserialize, schemars::JsonSchema)] +struct SumRequest { + a: i32, + b: i32, +} + +#[derive(Debug, Clone)] +struct SumServer { + tool_router: ToolRouter, +} + +impl SumServer { + fn new() -> Self { + Self { + tool_router: Self::tool_router(), + } + } +} + +#[tool_router] +impl SumServer { + #[tool(description = "Sum two numbers")] + fn sum(&self, Parameters(SumRequest { a, b }): Parameters) -> String { + (a + b).to_string() + } +} + +#[tool_handler(router = self.tool_router)] +impl ServerHandler for SumServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::builder().enable_tools().build()) + } +} + +/// Verify that subsequent tool calls do not regress in latency due to +/// HTTP/1.1 connection pool exhaustion. Before the fix, each POST SSE +/// response was dropped without fully consuming the body, preventing +/// connection reuse and forcing a new TCP connection (~40 ms) per call. +#[tokio::test] +async fn test_subsequent_tool_calls_reuse_connections() -> anyhow::Result<()> { + let ct = CancellationToken::new(); + + let service: StreamableHttpService = StreamableHttpService::new( + || Ok(SumServer::new()), + Default::default(), + StreamableHttpServerConfig::default() + .with_sse_keep_alive(None) + .with_cancellation_token(ct.child_token()), + ); + + let router = axum::Router::new().nest_service("/mcp", service); + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await?; + let addr = listener.local_addr()?; + + let server_handle = tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + let transport = StreamableHttpClientTransport::from_config( + StreamableHttpClientTransportConfig::with_uri(format!("http://{addr}/mcp")), + ); + let client = ClientConfig::default().serve(transport).await?; + + // Warm up: first call may include one-time setup costs. + let args: serde_json::Map = + serde_json::from_value(serde_json::json!({"a": 1, "b": 2}))?; + let _ = client + .call_tool(CallToolRequestParams::new("sum").with_arguments(args)) + .await?; + + // Measure subsequent calls. + let mut durations = Vec::new(); + for i in 0..5i32 { + let args: serde_json::Map = + serde_json::from_value(serde_json::json!({"a": i, "b": i + 1}))?; + let start = Instant::now(); + let result = client + .call_tool(CallToolRequestParams::new("sum").with_arguments(args)) + .await?; + let elapsed = start.elapsed(); + durations.push(elapsed); + + assert!(result.is_error != Some(true)); + } + + let _ = client.cancel().await; + ct.cancel(); + server_handle.await?; + + // With connection reuse, localhost calls should complete well under 20 ms. + // Before the fix, they consistently took ~42 ms due to new TCP connections. + let max_allowed = std::time::Duration::from_millis(20); + for d in &durations { + assert!(*d < max_allowed); + } + + Ok(()) +} diff --git a/vendor/rmcp/tests/test_streamable_http_disconnect_cancel.rs b/vendor/rmcp/tests/test_streamable_http_disconnect_cancel.rs new file mode 100644 index 00000000..05efe211 --- /dev/null +++ b/vendor/rmcp/tests/test_streamable_http_disconnect_cancel.rs @@ -0,0 +1,196 @@ +#![cfg(all( + feature = "server", + feature = "transport-streamable-http-server", + feature = "reqwest", + not(feature = "local") +))] + +//! Regression test for #857: when a stateless streamable-HTTP client disconnects +//! (drops the response) while a tool handler is still awaiting, the per-request +//! `RequestContext::ct` should fire so the handler can cancel cooperatively. +//! +//! Stateless requests are one-shot (no session, no resumption), so a dropped +//! response is terminal and safe to cancel — unlike the stateful/resumable path, +//! where a disconnect may be recovered via `Last-Event-ID`. + +use std::{sync::Arc, time::Duration}; + +use rmcp::{ + ErrorData as McpError, RoleServer, ServerHandler, + model::{ + CallToolRequestParams, CallToolResponse, CallToolResult, ContentBlock, ServerCapabilities, + ServerConfig, + }, + service::RequestContext, + transport::streamable_http_server::{ + StreamableHttpServerConfig, StreamableHttpService, session::local::LocalSessionManager, + }, +}; +use tokio::sync::Notify; +use tokio_util::sync::CancellationToken; + +#[derive(Clone)] +struct CancelProbe { + started: Arc, + cancelled: Arc, +} + +impl ServerHandler for CancelProbe { + #[allow(deprecated)] + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::builder().enable_tools().build()) + } + + async fn call_tool( + &self, + _request: CallToolRequestParams, + context: RequestContext, + ) -> Result { + self.started.notify_one(); + // Wait until the per-request cancellation token fires, or give up after a + // generous timeout so a buggy build fails via the outer assertion rather + // than hanging the test. + tokio::select! { + _ = context.ct.cancelled() => { + self.cancelled.notify_one(); + Ok(CallToolResult::success(vec![ContentBlock::text("cancelled")]).into()) + } + _ = tokio::time::sleep(Duration::from_secs(30)) => { + Ok(CallToolResult::success(vec![ContentBlock::text("ran_to_completion")]).into()) + } + } + } +} + +const CALL_BODY: &str = r#"{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"wait_for_cancel","arguments":{}}}"#; + +struct TestServer { + url: String, + server_ct: CancellationToken, + started: Arc, + cancelled: Arc, +} + +async fn spawn_stateless_server(json_response: bool) -> anyhow::Result { + let started = Arc::new(Notify::new()); + let cancelled = Arc::new(Notify::new()); + let probe = CancelProbe { + started: started.clone(), + cancelled: cancelled.clone(), + }; + + let server_ct = CancellationToken::new(); + let config = StreamableHttpServerConfig::default() + .with_legacy_session_mode(false) + .with_json_response(json_response) + // A short keep-alive lets the SSE server notice a dropped connection + // quickly (hyper only observes the disconnect on its next write). + .with_sse_keep_alive(Some(Duration::from_millis(100))) + .with_cancellation_token(server_ct.child_token()); + + let service: StreamableHttpService = + StreamableHttpService::new( + move || Ok(probe.clone()), + Arc::new(LocalSessionManager::default()), + config, + ); + let router = axum::Router::new().nest_service("/mcp", service); + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await?; + let addr = listener.local_addr()?; + tokio::spawn({ + let ct = server_ct.clone(); + async move { + let _ = axum::serve(listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + Ok(TestServer { + url: format!("http://{addr}/mcp"), + server_ct, + started, + cancelled, + }) +} + +/// SSE mode: the response is a stream; dropping it (client disconnect) must fire +/// the handler's cancellation token. +#[tokio::test] +async fn stateless_sse_client_disconnect_cancels_request() -> anyhow::Result<()> { + let server = spawn_stateless_server(false).await?; + let client = reqwest::Client::builder() + .pool_max_idle_per_host(0) + .build()?; + + // A single self-contained tools/call (no session, no initialize handshake). + let call = client + .post(&server.url) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("MCP-Protocol-Version", "2025-03-26") + .body(CALL_BODY) + .send() + .await?; + assert!( + call.status().is_success(), + "tools/call failed: {:?}", + call.status() + ); + + tokio::time::timeout(Duration::from_secs(5), server.started.notified()) + .await + .expect("tool handler should start"); + + // Client disconnects mid-call: drop the streaming response (and the client). + drop(call); + drop(client); + + tokio::time::timeout(Duration::from_secs(10), server.cancelled.notified()) + .await + .expect("RequestContext::ct should fire after client disconnect (SSE)"); + + server.server_ct.cancel(); + Ok(()) +} + +/// JSON-direct mode: the server holds the connection open awaiting the single +/// response. A client that disconnects while the handler is running must still +/// fire the handler's cancellation token. +#[tokio::test] +async fn stateless_json_client_disconnect_cancels_request() -> anyhow::Result<()> { + let server = spawn_stateless_server(true).await?; + let client = reqwest::Client::builder() + .pool_max_idle_per_host(0) + .build()?; + + // In JSON mode the server does not respond until the handler completes, so + // the request stays pending; drive it from a task we can abort to disconnect. + let url = server.url.clone(); + let req_task = tokio::spawn(async move { + let _ = client + .post(&url) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("MCP-Protocol-Version", "2025-03-26") + .body(CALL_BODY) + .send() + .await; + // Keep the client alive until the request future is dropped by abort(). + drop(client); + }); + + tokio::time::timeout(Duration::from_secs(5), server.started.notified()) + .await + .expect("tool handler should start"); + + // Client disconnects: abort the in-flight request, closing the connection. + req_task.abort(); + + tokio::time::timeout(Duration::from_secs(10), server.cancelled.notified()) + .await + .expect("RequestContext::ct should fire after client disconnect (JSON)"); + + server.server_ct.cancel(); + Ok(()) +} diff --git a/vendor/rmcp/tests/test_streamable_http_empty_2xx_notification.rs b/vendor/rmcp/tests/test_streamable_http_empty_2xx_notification.rs new file mode 100644 index 00000000..c8a15334 --- /dev/null +++ b/vendor/rmcp/tests/test_streamable_http_empty_2xx_notification.rs @@ -0,0 +1,48 @@ +#![cfg(all( + feature = "transport-streamable-http-client", + feature = "transport-streamable-http-client-reqwest", + not(feature = "local") +))] + +use std::{collections::HashMap, sync::Arc}; + +use rmcp::{ + model::{ClientJsonRpcMessage, ClientNotification, InitializedNotification}, + transport::streamable_http_client::{StreamableHttpClient, StreamableHttpPostResponse}, +}; + +async fn spawn_empty_ok_server() -> String { + use axum::{Router, http::StatusCode, routing::post}; + + let router = Router::new().route("/mcp", post(|| async { StatusCode::OK })); + + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let addr = listener.local_addr().unwrap(); + tokio::spawn(async move { + axum::serve(listener, router).await.unwrap(); + }); + + format!("http://{addr}/mcp") +} + +#[tokio::test] +async fn empty_success_response_to_notification_is_accepted() { + let url = spawn_empty_ok_server().await; + let client = reqwest::Client::new(); + let result = client + .post_message( + Arc::from(url.as_str()), + ClientJsonRpcMessage::notification(ClientNotification::InitializedNotification( + InitializedNotification::default(), + )), + None, + None, + HashMap::new(), + ) + .await; + + match result { + Ok(StreamableHttpPostResponse::Accepted) => {} + other => panic!("expected Accepted, got: {other:?}"), + } +} diff --git a/vendor/rmcp/tests/test_streamable_http_event_store.rs b/vendor/rmcp/tests/test_streamable_http_event_store.rs new file mode 100644 index 00000000..979ce7e6 --- /dev/null +++ b/vendor/rmcp/tests/test_streamable_http_event_store.rs @@ -0,0 +1,372 @@ +#![cfg(all( + feature = "client", + feature = "server", + feature = "transport-streamable-http-client-reqwest", + feature = "transport-streamable-http-server", + not(feature = "local") +))] + +use std::{ + collections::HashMap, + sync::{ + Arc, + atomic::{AtomicU64, Ordering}, + }, +}; + +use futures::StreamExt; +use rmcp::{ + ErrorData, ServerHandler, + model::{ + CallToolRequestParams, CallToolResponse, CallToolResult, ContentBlock, + ProgressNotificationParam, ServerCapabilities, ServerConfig, + }, + service::RequestContext, + transport::streamable_http_server::{ + StreamableHttpServerConfig, StreamableHttpService, + session::{ + EventStore, EventStoreError, EventStream, ServerSseMessage, SessionState, SessionStore, + SessionStoreError, local::LocalSessionManager, never::NeverSessionManager, + }, + }, +}; +use tokio::sync::RwLock; +use tokio_util::sync::CancellationToken; + +#[derive(Clone, Default)] +struct InMemorySessionStore(Arc>>); + +#[async_trait::async_trait] +impl SessionStore for InMemorySessionStore { + async fn load(&self, session_id: &str) -> Result, SessionStoreError> { + Ok(self.0.read().await.get(session_id).cloned()) + } + + async fn store(&self, session_id: &str, state: &SessionState) -> Result<(), SessionStoreError> { + self.0 + .write() + .await + .insert(session_id.to_owned(), state.clone()); + Ok(()) + } + + async fn delete(&self, session_id: &str) -> Result<(), SessionStoreError> { + self.0.write().await.remove(session_id); + Ok(()) + } +} + +#[derive(Clone)] +struct StoredEvent { + stream_id: String, + event: ServerSseMessage, +} + +#[derive(Clone, Default)] +struct InMemoryEventStore { + events: Arc>>, + next_id: Arc, +} + +#[async_trait::async_trait] +impl EventStore for InMemoryEventStore { + async fn store_event( + &self, + stream_id: &str, + event: &ServerSseMessage, + ) -> Result { + let event_id = format!("event-{}", self.next_id.fetch_add(1, Ordering::Relaxed)); + let mut event = event.clone(); + event.event_id = Some(event_id.clone()); + self.events.write().await.push(StoredEvent { + stream_id: stream_id.to_owned(), + event, + }); + Ok(event_id) + } + + async fn replay_events_after( + &self, + last_event_id: &str, + ) -> Result { + let events = self.events.read().await; + let last_index = events + .iter() + .position(|stored| stored.event.event_id.as_deref() == Some(last_event_id)) + .ok_or_else(|| std::io::Error::other("event not found"))?; + let stream_id = events[last_index].stream_id.clone(); + let replay = events + .iter() + .skip(last_index + 1) + .filter(|stored| stored.stream_id == stream_id) + .map(|stored| stored.event.clone()) + .collect::>(); + Ok(Box::pin(futures::stream::iter(replay))) + } +} + +#[derive(Clone)] +struct ProgressServer; + +impl ServerHandler for ProgressServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::builder().enable_tools().build()) + } + + async fn call_tool( + &self, + request: CallToolRequestParams, + context: RequestContext, + ) -> Result { + if request.name == "progress" || request.name == "slow-progress" { + let progress_token = context + .meta + .get_progress_token() + .expect("request includes progressToken"); + context + .peer + .notify_progress( + ProgressNotificationParam::new(progress_token, 50.0) + .with_total(100.0) + .with_message("working"), + ) + .await + .expect("progress notification is delivered"); + } + if request.name == "slow-progress" { + tokio::time::sleep(std::time::Duration::from_millis(100)).await; + } + Ok(CallToolResult::success(vec![ContentBlock::text("done")]).into()) + } +} + +async fn spawn_server( + session_store: Arc, + event_store: Arc, + cancellation_token: &CancellationToken, + legacy_session_mode: bool, +) -> anyhow::Result<(String, tokio::task::JoinHandle<()>)> { + let config = { + let mut config = StreamableHttpServerConfig::default(); + config.sse_keep_alive = None; + config.legacy_session_mode = legacy_session_mode; + config.cancellation_token = cancellation_token.child_token(); + config.session_store = Some(session_store); + config + }; + let router = if legacy_session_mode { + let session_manager = + Arc::new(LocalSessionManager::default().with_event_store(event_store)); + let service = StreamableHttpService::new(|| Ok(ProgressServer), session_manager, config); + axum::Router::new().nest_service("/mcp", service) + } else { + let session_manager = + Arc::new(NeverSessionManager::default().with_event_store(event_store)); + let service = StreamableHttpService::new(|| Ok(ProgressServer), session_manager, config); + axum::Router::new().nest_service("/mcp", service) + }; + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await?; + let address = listener.local_addr()?; + let handle = tokio::spawn({ + let cancellation_token = cancellation_token.clone(); + async move { + let _ = axum::serve(listener, router) + .with_graceful_shutdown(async move { cancellation_token.cancelled_owned().await }) + .await; + } + }); + Ok((format!("http://{address}/mcp"), handle)) +} + +fn event_id_containing<'a>(body: &'a str, needle: &str) -> Option<&'a str> { + body.split("\n\n") + .find(|event| event.contains(needle))? + .lines() + .find_map(|line| line.strip_prefix("id: ")) +} + +#[tokio::test] +async fn restored_instance_replays_events_from_shared_store() -> anyhow::Result<()> { + let session_store: Arc = Arc::new(InMemorySessionStore::default()); + let event_store: Arc = Arc::new(InMemoryEventStore::default()); + let http = reqwest::Client::new(); + + let cancellation_a = CancellationToken::new(); + let (url_a, server_a) = spawn_server( + session_store.clone(), + event_store.clone(), + &cancellation_a, + true, + ) + .await?; + let initialize = http + .post(&url_a) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .body(r#"{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-06-18","capabilities":{},"clientInfo":{"name":"test","version":"1.0"}}}"#) + .send() + .await?; + let session_id = initialize + .headers() + .get("mcp-session-id") + .expect("initialize returns a session ID") + .to_str()? + .to_owned(); + let _ = initialize.text().await?; + + let initialized_status = http + .post(&url_a) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("Mcp-Session-Id", &session_id) + .header("Mcp-Protocol-Version", "2025-06-18") + .body(r#"{"jsonrpc":"2.0","method":"notifications/initialized"}"#) + .send() + .await? + .status(); + assert_eq!(initialized_status, reqwest::StatusCode::ACCEPTED); + + let original_body = http + .post(&url_a) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("Mcp-Session-Id", &session_id) + .header("Mcp-Protocol-Version", "2025-06-18") + .body(r#"{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"progress","arguments":{},"_meta":{"progressToken":"progress-1"}}}"#) + .send() + .await? + .text() + .await?; + let progress_event_id = event_id_containing(&original_body, "notifications/progress") + .expect("progress event has a persisted event ID") + .to_owned(); + + cancellation_a.cancel(); + server_a.await?; + + let cancellation_b = CancellationToken::new(); + let (url_b, server_b) = spawn_server(session_store, event_store, &cancellation_b, true).await?; + let replay = http + .get(&url_b) + .header("Accept", "text/event-stream") + .header("Mcp-Session-Id", &session_id) + .header("Mcp-Protocol-Version", "2025-06-18") + .header("Last-Event-ID", progress_event_id) + .send() + .await?; + assert_eq!(replay.status(), reqwest::StatusCode::OK); + let replay_body = replay.text().await?; + assert!( + replay_body.contains(r#""id":2"#), + "instance B should replay the final response stored by instance A: {replay_body}" + ); + + cancellation_b.cancel(); + server_b.await?; + Ok(()) +} + +#[tokio::test] +async fn stateless_instance_replays_events_from_shared_store() -> anyhow::Result<()> { + let session_store: Arc = Arc::new(InMemorySessionStore::default()); + let event_store = Arc::new(InMemoryEventStore::default()); + let http = reqwest::Client::new(); + + let cancellation_a = CancellationToken::new(); + let (url_a, server_a) = spawn_server( + session_store.clone(), + event_store.clone(), + &cancellation_a, + false, + ) + .await?; + let original = http + .post(&url_a) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("MCP-Protocol-Version", "2026-07-28") + .header("Mcp-Method", "tools/call") + .header("Mcp-Name", "slow-progress") + .body( + r#"{ + "jsonrpc":"2.0", + "id":2, + "method":"tools/call", + "params":{ + "name":"slow-progress", + "arguments":{}, + "_meta":{ + "progressToken":"progress-1", + "io.modelcontextprotocol/protocolVersion":"2026-07-28", + "io.modelcontextprotocol/clientInfo":{"name":"test","version":"1.0"}, + "io.modelcontextprotocol/clientCapabilities":{} + } + } + }"#, + ) + .send() + .await?; + assert_eq!(original.status(), reqwest::StatusCode::OK); + assert!( + original.headers().get("mcp-session-id").is_none(), + "stateless response must not create a session" + ); + let mut body = original.bytes_stream(); + let mut received = String::new(); + let progress_event_id = tokio::time::timeout(std::time::Duration::from_secs(2), async { + loop { + let chunk = body + .next() + .await + .expect("response remains open until progress arrives")?; + received.push_str(&String::from_utf8_lossy(&chunk)); + if let Some(event_id) = event_id_containing(&received, "notifications/progress") { + return Ok::<_, reqwest::Error>(event_id.to_owned()); + } + } + }) + .await??; + drop(body); + + tokio::time::timeout(std::time::Duration::from_secs(2), async { + loop { + let stored_response = event_store.events.read().await.iter().any(|stored| { + stored.event.message.as_ref().is_some_and(|message| { + matches!( + message.as_ref(), + rmcp::model::ServerJsonRpcMessage::Response(_) + ) + }) + }); + if stored_response { + break; + } + tokio::time::sleep(std::time::Duration::from_millis(5)).await; + } + }) + .await?; + + cancellation_a.cancel(); + server_a.await?; + + let cancellation_b = CancellationToken::new(); + let (url_b, server_b) = + spawn_server(session_store, event_store, &cancellation_b, false).await?; + let replay = http + .get(&url_b) + .header("Accept", "text/event-stream") + .header("MCP-Protocol-Version", "2026-07-28") + .header("Last-Event-ID", progress_event_id) + .send() + .await?; + assert_eq!(replay.status(), reqwest::StatusCode::OK); + let replay_body = replay.text().await?; + assert!( + replay_body.contains(r#""id":2"#), + "instance B should replay the stateless response stored by instance A: {replay_body}" + ); + + cancellation_b.cancel(); + server_b.await?; + Ok(()) +} diff --git a/vendor/rmcp/tests/test_streamable_http_get_stream_auth_challenge.rs b/vendor/rmcp/tests/test_streamable_http_get_stream_auth_challenge.rs new file mode 100644 index 00000000..dcd1b8d9 --- /dev/null +++ b/vendor/rmcp/tests/test_streamable_http_get_stream_auth_challenge.rs @@ -0,0 +1,105 @@ +#![cfg(all( + feature = "transport-streamable-http-client", + feature = "transport-streamable-http-client-reqwest", + not(feature = "local") +))] + +use std::{collections::HashMap, sync::Arc}; + +use rmcp::transport::streamable_http_client::{StreamableHttpClient, StreamableHttpError}; + +/// Spin up a minimal axum server whose GET handler always responds with the given +/// status and optional `WWW-Authenticate` header — no MCP logic involved. +async fn spawn_mock_server(status: u16, www_authenticate: Option<&'static str>) -> String { + use axum::{Router, body::Body, http::Response, routing::get}; + + let router = Router::new().route( + "/mcp", + get(move || async move { + let mut builder = Response::builder().status(status); + if let Some(challenge) = www_authenticate { + builder = builder.header("www-authenticate", challenge); + } + builder.body(Body::empty()).unwrap() + }), + ); + + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let addr = listener.local_addr().unwrap(); + tokio::spawn(async move { + axum::serve(listener, router).await.unwrap(); + }); + + format!("http://{addr}/mcp") +} + +async fn get_stream_against( + status: u16, + www_authenticate: Option<&'static str>, +) -> Result<(), StreamableHttpError> { + let url = spawn_mock_server(status, www_authenticate).await; + reqwest::Client::new() + .get_stream(Arc::from(url.as_str()), None, None, None, HashMap::new()) + .await + .map(|_| ()) +} + +/// A 401 carrying a `WWW-Authenticate` challenge must surface as `AuthRequired`, +/// which is the variant `AuthClient::call_reacting_to_challenges` catches to +/// refresh the token and retry. Classified as a plain `Client` error instead, the +/// refresh never runs and the stream just fails. +#[tokio::test] +async fn get_stream_maps_401_challenge_to_auth_required() { + let result = get_stream_against(401, Some("Bearer realm=\"mcp\"")).await; + + match result { + Err(StreamableHttpError::AuthRequired(err)) => { + assert_eq!(err.www_authenticate_header, "Bearer realm=\"mcp\""); + } + other => panic!("expected AuthRequired, got: {other:?}"), + } +} + +/// A 403 carrying a challenge must surface as `InsufficientScope`, with the +/// required scope extracted from the header. +#[tokio::test] +async fn get_stream_maps_403_challenge_to_insufficient_scope() { + let result = get_stream_against( + 403, + Some("Bearer error=\"insufficient_scope\", scope=\"mcp:read\""), + ) + .await; + + match result { + Err(StreamableHttpError::InsufficientScope(err)) => { + assert_eq!(err.required_scope.as_deref(), Some("mcp:read")); + } + other => panic!("expected InsufficientScope, got: {other:?}"), + } +} + +/// Without a `WWW-Authenticate` header there is no challenge to act on, so a 401 +/// must keep falling through to the ordinary error path rather than being +/// reported as an auth challenge the caller can retry. +#[tokio::test] +async fn get_stream_401_without_challenge_is_not_auth_required() { + let result = get_stream_against(401, None).await; + + assert!( + !matches!(result, Err(StreamableHttpError::AuthRequired(_))), + "401 with no challenge header must not be classified as AuthRequired" + ); + assert!(result.is_err(), "401 must still be an error"); +} + +/// 405 keeps its dedicated meaning — the server does not support SSE on GET — +/// and must not be swallowed by the new auth branches. +#[tokio::test] +async fn get_stream_405_still_reports_sse_unsupported() { + let result = get_stream_against(405, None).await; + + assert!( + matches!(result, Err(StreamableHttpError::ServerDoesNotSupportSse)), + "expected ServerDoesNotSupportSse, got: {result:?}" + ); +} diff --git a/vendor/rmcp/tests/test_streamable_http_idle_timeout_log.rs b/vendor/rmcp/tests/test_streamable_http_idle_timeout_log.rs new file mode 100644 index 00000000..e0559b5b --- /dev/null +++ b/vendor/rmcp/tests/test_streamable_http_idle_timeout_log.rs @@ -0,0 +1,252 @@ +#![cfg(all( + feature = "transport-streamable-http-server", + feature = "transport-streamable-http-client-reqwest", + not(feature = "local") +))] + +use std::{ + sync::{Arc, Mutex}, + time::Duration, +}; + +use rmcp::transport::streamable_http_server::{ + StreamableHttpServerConfig, StreamableHttpService, + session::{SessionManager, local::LocalSessionManager}, +}; +use tokio_util::sync::CancellationToken; +use tracing_subscriber::layer::SubscriberExt; + +mod common; +use common::calculator::Calculator; + +struct CapturedEvent { + level: tracing::Level, + target: String, + message: String, +} + +struct CapturingLayer { + events: Arc>>, +} + +impl tracing_subscriber::Layer for CapturingLayer { + fn on_event( + &self, + event: &tracing::Event<'_>, + _ctx: tracing_subscriber::layer::Context<'_, S>, + ) { + let mut visitor = MessageVisitor(String::new()); + event.record(&mut visitor); + self.events.lock().unwrap().push(CapturedEvent { + level: *event.metadata().level(), + target: event.metadata().target().to_string(), + message: visitor.0, + }); + } +} + +struct MessageVisitor(String); + +impl tracing::field::Visit for MessageVisitor { + fn record_debug(&mut self, field: &tracing::field::Field, value: &dyn std::fmt::Debug) { + if field.name() == "message" { + self.0 = format!("{:?}", value); + } + } +} + +#[tokio::test(flavor = "current_thread")] +async fn test_keep_alive_timeout_does_not_emit_error_log() { + let events = Arc::new(Mutex::new(Vec::::new())); + + let subscriber = tracing_subscriber::registry().with(CapturingLayer { + events: events.clone(), + }); + + let _guard = tracing::subscriber::set_default(subscriber); + + let ct = CancellationToken::new(); + let mut session_manager = LocalSessionManager::default(); + session_manager.session_config.keep_alive = Some(Duration::from_millis(200)); + let session_manager = Arc::new(session_manager); + + let service = StreamableHttpService::new( + || Ok(Calculator::new()), + session_manager.clone(), + StreamableHttpServerConfig::default() + .with_sse_keep_alive(None) + .with_cancellation_token(ct.child_token()), + ); + + let router = axum::Router::new().nest_service("/mcp", service); + let tcp_listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let addr = tcp_listener.local_addr().unwrap(); + + tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(tcp_listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + let client = reqwest::Client::new(); + + let response = client + .post(format!("http://{addr}/mcp")) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .body(r#"{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-06-18","capabilities":{},"clientInfo":{"name":"test","version":"1.0"}}}"#) + .send() + .await + .unwrap(); + assert_eq!(response.status(), 200); + let session_id = response.headers()["mcp-session-id"] + .to_str() + .unwrap() + .to_string(); + + client + .post(format!("http://{addr}/mcp")) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("mcp-session-id", &session_id) + .header("Mcp-Protocol-Version", "2025-06-18") + .body(r#"{"jsonrpc":"2.0","method":"notifications/initialized"}"#) + .send() + .await + .unwrap(); + + tokio::time::sleep(Duration::from_millis(400)).await; + + // Wait until close_session() has completed so all logs are captured. + let session_id_parsed: Arc = Arc::from(session_id.as_str()); + for _ in 0..20 { + if !session_manager + .has_session(&session_id_parsed) + .await + .unwrap() + { + break; + } + tokio::time::sleep(Duration::from_millis(50)).await; + } + assert!( + !session_manager + .has_session(&session_id_parsed) + .await + .unwrap(), + "session should have been removed after idle reap" + ); + + let captured = events.lock().unwrap(); + + let error_events: Vec<_> = captured + .iter() + .filter(|e| e.level == tracing::Level::ERROR && e.target.starts_with("rmcp")) + .collect(); + assert!( + error_events.is_empty(), + "idle reap should not produce any ERROR logs, found {}: {:?}", + error_events.len(), + error_events.iter().map(|e| &e.message).collect::>() + ); + + let debug_events: Vec<_> = captured + .iter() + .filter(|e| { + e.level == tracing::Level::DEBUG + && e.target.starts_with("rmcp") + && e.message.contains("IdleTimeout") + }) + .collect(); + assert!( + !debug_events.is_empty(), + "expected a DEBUG log with IdleTimeout, but found none" + ); + + ct.cancel(); +} + +#[tokio::test(flavor = "current_thread")] +async fn test_explicit_close_on_live_session_succeeds() { + let ct = CancellationToken::new(); + let mut session_manager = LocalSessionManager::default(); + session_manager.session_config.keep_alive = Some(Duration::from_secs(60)); + let session_manager = Arc::new(session_manager); + + let service = StreamableHttpService::new( + || Ok(Calculator::new()), + session_manager.clone(), + StreamableHttpServerConfig::default() + .with_sse_keep_alive(None) + .with_cancellation_token(ct.child_token()), + ); + + let router = axum::Router::new().nest_service("/mcp", service); + let tcp_listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let addr = tcp_listener.local_addr().unwrap(); + + tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(tcp_listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + let client = reqwest::Client::new(); + + let response = client + .post(format!("http://{addr}/mcp")) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .body(r#"{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-06-18","capabilities":{},"clientInfo":{"name":"test","version":"1.0"}}}"#) + .send() + .await + .unwrap(); + assert_eq!(response.status(), 200); + let session_id = response.headers()["mcp-session-id"] + .to_str() + .unwrap() + .to_string(); + + client + .post(format!("http://{addr}/mcp")) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("mcp-session-id", &session_id) + .header("Mcp-Protocol-Version", "2025-06-18") + .body(r#"{"jsonrpc":"2.0","method":"notifications/initialized"}"#) + .send() + .await + .unwrap(); + + let session_id_parsed: Arc = Arc::from(session_id.as_str()); + + assert!( + session_manager + .has_session(&session_id_parsed) + .await + .unwrap(), + "session should exist before explicit close" + ); + + let result = session_manager.close_session(&session_id_parsed).await; + assert!( + result.is_ok(), + "close_session on a live worker should succeed: {result:?}" + ); + + assert!( + !session_manager + .has_session(&session_id_parsed) + .await + .unwrap(), + "session should not exist after explicit close" + ); + + ct.cancel(); +} diff --git a/vendor/rmcp/tests/test_streamable_http_init_timeout.rs b/vendor/rmcp/tests/test_streamable_http_init_timeout.rs new file mode 100644 index 00000000..c9a2ee89 --- /dev/null +++ b/vendor/rmcp/tests/test_streamable_http_init_timeout.rs @@ -0,0 +1,63 @@ +#![cfg(all(feature = "transport-streamable-http-server", not(feature = "local")))] + +use std::time::Duration; + +use rmcp::{ + model::{ClientJsonRpcMessage, ClientRequest, PingRequest, RequestId}, + transport::streamable_http_server::session::{SessionManager, local::LocalSessionManager}, +}; + +#[tokio::test] +async fn test_init_timeout_terminates_pre_init_session() -> anyhow::Result<()> { + let mut manager = LocalSessionManager::default(); + manager.session_config.init_timeout = Some(Duration::from_millis(200)); + + // Bind the transport so its drop-guard doesn't cancel the worker — we + // want termination via init_timeout, not via cancellation. + let (session_id, _transport) = manager.create_session().await?; + + tokio::time::sleep(Duration::from_millis(500)).await; + + let message = ClientJsonRpcMessage::request( + ClientRequest::PingRequest(PingRequest::default()), + RequestId::Number(1), + ); + let result = manager.initialize_session(&session_id, message).await; + + assert!( + result.is_err(), + "expected worker to be dead; got: {result:?}" + ); + + Ok(()) +} + +#[tokio::test] +async fn test_init_timeout_none_keeps_worker_alive() -> anyhow::Result<()> { + let mut manager = LocalSessionManager::default(); + manager.session_config.init_timeout = None; + + let (session_id, _transport) = manager.create_session().await?; + + tokio::time::sleep(Duration::from_millis(500)).await; + + let message = ClientJsonRpcMessage::request( + ClientRequest::PingRequest(PingRequest::default()), + RequestId::Number(1), + ); + // Liveness probe: a live worker accepts the send then stalls waiting for + // a handler response (none is wired up), tripping the outer timeout. A + // dead worker would fail the send and return immediately. + let probe = tokio::time::timeout( + Duration::from_millis(200), + manager.initialize_session(&session_id, message), + ) + .await; + + assert!( + probe.is_err(), + "expected worker to be alive; got: {probe:?}" + ); + + Ok(()) +} diff --git a/vendor/rmcp/tests/test_streamable_http_json_response.rs b/vendor/rmcp/tests/test_streamable_http_json_response.rs new file mode 100644 index 00000000..62daa7ae --- /dev/null +++ b/vendor/rmcp/tests/test_streamable_http_json_response.rs @@ -0,0 +1,405 @@ +#![cfg(not(feature = "local"))] +use rmcp::{ + ErrorData, ServerHandler, + model::{ + CallToolRequestParams, CallToolResponse, CallToolResult, ContentBlock, + ProgressNotificationParam, ServerCapabilities, ServerConfig, + }, + service::RequestContext, + transport::streamable_http_server::{ + StreamableHttpServerConfig, StreamableHttpService, session::local::LocalSessionManager, + }, +}; +use tokio_util::sync::CancellationToken; + +mod common; +use common::calculator::Calculator; + +const INIT_BODY: &str = r#"{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-03-26","capabilities":{},"clientInfo":{"name":"test","version":"1.0"}}}"#; +const CALL_WITH_PROGRESS_BODY: &str = r#"{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"progress","arguments":{},"_meta":{"progressToken":"progress-test-1"}}}"#; +const NEGOTIATED_CALL_BODY: &str = r#"{ + "jsonrpc": "2.0", + "id": 2, + "method": "tools/call", + "params": { + "name": "terminal", + "arguments": {}, + "_meta": { + "io.modelcontextprotocol/protocolVersion": "2026-07-28", + "io.modelcontextprotocol/clientInfo": { + "name": "test", + "version": "1.0" + }, + "io.modelcontextprotocol/clientCapabilities": {} + } + } +}"#; +const NEGOTIATED_CALL_WITH_PROGRESS_BODY: &str = r#"{ + "jsonrpc": "2.0", + "id": 2, + "method": "tools/call", + "params": { + "name": "progress", + "arguments": {}, + "_meta": { + "progressToken": "progress-test-1", + "io.modelcontextprotocol/protocolVersion": "2026-07-28", + "io.modelcontextprotocol/clientInfo": { + "name": "test", + "version": "1.0" + }, + "io.modelcontextprotocol/clientCapabilities": {} + } + } +}"#; + +#[derive(Clone)] +struct ProgressServer; + +impl ServerHandler for ProgressServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::builder().enable_tools().build()) + } + + async fn call_tool( + &self, + request: CallToolRequestParams, + context: RequestContext, + ) -> Result { + if request.name == "progress" { + let progress_token = context + .meta + .get_progress_token() + .expect("request includes progressToken"); + context + .peer + .notify_progress( + ProgressNotificationParam::new(progress_token, 50.0) + .with_total(100.0) + .with_message("working"), + ) + .await + .expect("progress notification is delivered"); + } + Ok(CallToolResult::success(vec![ContentBlock::text("done")]).into()) + } +} + +async fn spawn_server( + config: StreamableHttpServerConfig, +) -> (reqwest::Client, String, CancellationToken) { + let ct = config.cancellation_token.clone(); + let service: StreamableHttpService = + StreamableHttpService::new(|| Ok(Calculator::new()), Default::default(), config); + + let router = axum::Router::new().nest_service("/mcp", service); + let tcp_listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let addr = tcp_listener.local_addr().unwrap(); + + tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(tcp_listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + let client = reqwest::Client::new(); + let base_url = format!("http://{addr}/mcp"); + (client, base_url, ct) +} + +async fn spawn_progress_server( + config: StreamableHttpServerConfig, +) -> (reqwest::Client, String, CancellationToken) { + let ct = config.cancellation_token.clone(); + let service: StreamableHttpService = + StreamableHttpService::new(|| Ok(ProgressServer), Default::default(), config); + + let router = axum::Router::new().nest_service("/mcp", service); + let tcp_listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let addr = tcp_listener.local_addr().unwrap(); + + tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(tcp_listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + let client = reqwest::Client::new(); + let base_url = format!("http://{addr}/mcp"); + (client, base_url, ct) +} + +#[tokio::test] +async fn stateless_json_response_returns_application_json() -> anyhow::Result<()> { + let ct = CancellationToken::new(); + let (client, url, ct) = spawn_server( + StreamableHttpServerConfig::default() + .with_legacy_session_mode(false) + .with_json_response(true) + .with_sse_keep_alive(None) + .with_cancellation_token(ct.child_token()), + ) + .await; + + let response = client + .post(&url) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .body(INIT_BODY) + .send() + .await?; + + assert_eq!(response.status(), 200); + + let content_type = response + .headers() + .get("content-type") + .and_then(|v| v.to_str().ok()) + .unwrap_or(""); + assert!( + content_type.contains("application/json"), + "Expected application/json, got: {content_type}" + ); + + let body = response.text().await?; + let parsed: serde_json::Value = serde_json::from_str(&body)?; + assert_eq!(parsed["jsonrpc"], "2.0"); + assert_eq!(parsed["id"], 1); + assert!(parsed["result"].is_object(), "Expected result object"); + + ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn stateless_negotiated_terminal_response_returns_application_json() -> anyhow::Result<()> { + let ct = CancellationToken::new(); + let (client, url, ct) = spawn_progress_server( + StreamableHttpServerConfig::default() + .with_legacy_session_mode(false) + .with_json_response(true) + .with_sse_keep_alive(None) + .with_cancellation_token(ct.child_token()), + ) + .await; + + let response = client + .post(&url) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("MCP-Protocol-Version", "2026-07-28") + .header("Mcp-Method", "tools/call") + .header("Mcp-Name", "terminal") + .body(NEGOTIATED_CALL_BODY) + .send() + .await?; + + assert_eq!(response.status(), 200); + + let content_type = response + .headers() + .get("content-type") + .and_then(|value| value.to_str().ok()) + .unwrap_or(""); + assert!( + content_type.contains("application/json"), + "Expected application/json, got: {content_type}" + ); + + let body: serde_json::Value = response.json().await?; + assert_eq!(body["id"], 2); + assert!(body["result"].is_object(), "Expected result object"); + + ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn stateless_json_response_falls_back_to_sse_for_progress() -> anyhow::Result<()> { + let ct = CancellationToken::new(); + let (client, url, ct) = spawn_progress_server( + StreamableHttpServerConfig::default() + .with_legacy_session_mode(false) + .with_json_response(true) + .with_sse_keep_alive(None) + .with_cancellation_token(ct.child_token()), + ) + .await; + + let response = client + .post(&url) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .body(CALL_WITH_PROGRESS_BODY) + .send() + .await?; + + assert_eq!(response.status(), 200); + + let content_type = response + .headers() + .get("content-type") + .and_then(|value| value.to_str().ok()) + .unwrap_or(""); + assert!( + content_type.contains("text/event-stream"), + "Expected SSE fallback, got: {content_type}" + ); + + let body = response.text().await?; + let messages: Vec = body + .lines() + .filter_map(|line| line.strip_prefix("data:")) + .map(str::trim) + .filter(|data| !data.is_empty()) + .map(serde_json::from_str) + .collect::>()?; + assert_eq!(messages.len(), 2, "Expected progress and result: {body}"); + assert_eq!(messages[0]["method"], "notifications/progress"); + assert_eq!(messages[1]["id"], 2); + assert!( + messages[1]["result"].is_object(), + "Expected result object: {body}" + ); + + ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn stateless_negotiated_json_response_falls_back_to_sse_for_progress() -> anyhow::Result<()> { + let ct = CancellationToken::new(); + let (client, url, ct) = spawn_progress_server( + StreamableHttpServerConfig::default() + .with_legacy_session_mode(false) + .with_json_response(true) + .with_sse_keep_alive(None) + .with_cancellation_token(ct.child_token()), + ) + .await; + + let response = client + .post(&url) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("MCP-Protocol-Version", "2026-07-28") + .header("Mcp-Method", "tools/call") + .header("Mcp-Name", "progress") + .body(NEGOTIATED_CALL_WITH_PROGRESS_BODY) + .send() + .await?; + + assert_eq!(response.status(), 200); + + let content_type = response + .headers() + .get("content-type") + .and_then(|value| value.to_str().ok()) + .unwrap_or(""); + assert!( + content_type.contains("text/event-stream"), + "Expected SSE fallback, got: {content_type}" + ); + + let body = response.text().await?; + let messages: Vec = body + .lines() + .filter_map(|line| line.strip_prefix("data:")) + .map(str::trim) + .filter(|data| !data.is_empty()) + .map(serde_json::from_str) + .collect::>()?; + assert_eq!(messages.len(), 2, "Expected progress and result: {body}"); + assert_eq!(messages[0]["method"], "notifications/progress"); + assert_eq!(messages[1]["id"], 2); + assert!( + messages[1]["result"].is_object(), + "Expected result object: {body}" + ); + + ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn stateless_sse_mode_default_unchanged() -> anyhow::Result<()> { + let ct = CancellationToken::new(); + let (client, url, ct) = spawn_server( + StreamableHttpServerConfig::default() + .with_legacy_session_mode(false) + .with_sse_keep_alive(None) + .with_cancellation_token(ct.child_token()), + ) + .await; + + let response = client + .post(&url) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .body(INIT_BODY) + .send() + .await?; + + assert_eq!(response.status(), 200); + + let content_type = response + .headers() + .get("content-type") + .and_then(|v| v.to_str().ok()) + .unwrap_or(""); + assert!( + content_type.contains("text/event-stream"), + "Expected text/event-stream, got: {content_type}" + ); + + let body = response.text().await?; + assert!( + body.contains("data:"), + "Expected SSE framing (data: prefix), got: {body}" + ); + + ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn json_response_ignored_in_legacy_session_mode() -> anyhow::Result<()> { + let ct = CancellationToken::new(); + // json_response: true has no effect when legacy_session_mode: true — server still uses SSE + let (client, url, ct) = spawn_server( + StreamableHttpServerConfig::default() + .with_json_response(true) + .with_sse_keep_alive(None) + .with_cancellation_token(ct.child_token()), + ) + .await; + + let response = client + .post(&url) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .body(INIT_BODY) + .send() + .await?; + + assert_eq!(response.status(), 200); + + let content_type = response + .headers() + .get("content-type") + .and_then(|v| v.to_str().ok()) + .unwrap_or(""); + assert!( + content_type.contains("text/event-stream"), + "Stateful mode should always use SSE regardless of json_response, got: {content_type}" + ); + + ct.cancel(); + Ok(()) +} diff --git a/vendor/rmcp/tests/test_streamable_http_malformed_json_request.rs b/vendor/rmcp/tests/test_streamable_http_malformed_json_request.rs new file mode 100644 index 00000000..c34e96ed --- /dev/null +++ b/vendor/rmcp/tests/test_streamable_http_malformed_json_request.rs @@ -0,0 +1,195 @@ +#![cfg(all( + feature = "transport-streamable-http-client", + feature = "transport-streamable-http-client-reqwest", + feature = "client", + not(feature = "local") +))] + +use std::{collections::HashMap, sync::Arc, time::Duration}; + +use axum::{Router, body::Bytes, http::StatusCode, response::IntoResponse, routing::post}; +use rmcp::{ + ServiceError, ServiceExt, + model::{ + CallToolRequestParams, ClientJsonRpcMessage, ClientNotification, ClientRequest, + InitializedNotification, PingRequest, RequestId, + }, + transport::{ + StreamableHttpClientTransport, + streamable_http_client::{ + StreamableHttpClient, StreamableHttpError, StreamableHttpPostResponse, + }, + }, +}; +use rstest::rstest; + +/// Initialize succeeds; every later POST (including `tools/call`) returns +/// HTTP 200 + `application/json` with a body that is not a JSON-RPC message. +async fn spawn_malformed_json_request_server(call_body: &'static str) -> String { + let router = Router::new().route( + "/mcp", + post(move |body: Bytes| async move { + let parsed: serde_json::Value = serde_json::from_slice(&body).unwrap_or_default(); + let method = parsed.get("method").and_then(|m| m.as_str()).unwrap_or(""); + if method == "initialize" { + let id = parsed.get("id").cloned().unwrap_or(serde_json::json!(1)); + return ( + StatusCode::OK, + [ + (http::header::CONTENT_TYPE, "application/json"), + ( + http::HeaderName::from_static("mcp-session-id"), + "test-session", + ), + ], + serde_json::json!({ + "jsonrpc": "2.0", + "id": id, + "result": { + "protocolVersion": "2025-03-26", + "capabilities": { "tools": {} }, + "serverInfo": { "name": "mock", "version": "0.0.1" } + } + }) + .to_string(), + ) + .into_response(); + } + if method == "notifications/initialized" { + return StatusCode::ACCEPTED.into_response(); + } + ( + StatusCode::OK, + [(http::header::CONTENT_TYPE, "application/json")], + call_body, + ) + .into_response() + }), + ); + + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let addr = listener.local_addr().unwrap(); + tokio::spawn(async move { + axum::serve(listener, router).await.unwrap(); + }); + format!("http://{addr}/mcp") +} + +async fn spawn_json_body_server(body: &'static str) -> String { + let router = Router::new().route( + "/mcp", + post(move || async move { + ( + StatusCode::OK, + [(http::header::CONTENT_TYPE, "application/json")], + body, + ) + }), + ); + + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let addr = listener.local_addr().unwrap(); + tokio::spawn(async move { + axum::serve(listener, router).await.unwrap(); + }); + format!("http://{addr}/mcp") +} + +/// Public-API repro: `call_tool` must return a transport error instead of +/// hanging when the server answers a request POST with 200 JSON that is not +/// a JSON-RPC message. +#[rstest] +#[case::empty_object("{}")] +#[case::empty_body("")] +#[case::invalid_json("{")] +#[case::html("not json")] +#[tokio::test] +async fn call_tool_errors_on_malformed_json_200(#[case] call_body: &'static str) { + let url = spawn_malformed_json_request_server(call_body).await; + let transport = StreamableHttpClientTransport::from_uri(url); + let client = ().serve(transport).await.expect("initialize should succeed"); + let peer = client.peer().clone(); + + let result = tokio::time::timeout( + Duration::from_secs(2), + peer.call_tool(CallToolRequestParams::new("anything")), + ) + .await + .expect("call_tool must return instead of hanging on malformed JSON 200"); + + match result { + Err(ServiceError::TransportSend(ref dyn_err)) => { + let err_msg = format!("{dyn_err}"); + assert!( + err_msg.contains("unexpected server response"), + "expected UnexpectedServerResponse, got: {err_msg}" + ); + let preview = if call_body.is_empty() { + "" + } else { + call_body + }; + assert!( + err_msg.contains(preview), + "expected body preview {preview:?} in error, got: {err_msg}" + ); + } + other => panic!("expected TransportSend(UnexpectedServerResponse), got: {other:?}"), + } + + let _ = client.cancel().await; +} + +/// Direct `post_message` check: a request POST cannot treat a JSON parse +/// failure as Accepted. +#[tokio::test] +async fn post_request_malformed_json_is_unexpected_server_response() { + let url = spawn_json_body_server("{}").await; + let client = reqwest::Client::new(); + let result = client + .post_message( + Arc::from(url.as_str()), + ClientJsonRpcMessage::request( + ClientRequest::PingRequest(PingRequest::default()), + RequestId::Number(1), + ), + None, + None, + HashMap::new(), + ) + .await; + + match result { + Err(StreamableHttpError::UnexpectedServerResponse(ref msg)) => { + assert!( + msg.contains("{}"), + "expected body preview in error, got: {msg}" + ); + } + other => panic!("expected UnexpectedServerResponse, got: {other:?}"), + } +} + +/// Notification POSTs still treat an unusable JSON body as Accepted. +/// That fallback is for messages that do not await a reply. +#[tokio::test] +async fn post_notification_malformed_json_is_still_accepted() { + let url = spawn_json_body_server("{}").await; + let client = reqwest::Client::new(); + let result = client + .post_message( + Arc::from(url.as_str()), + ClientJsonRpcMessage::notification(ClientNotification::InitializedNotification( + InitializedNotification::default(), + )), + None, + None, + HashMap::new(), + ) + .await; + + match result { + Ok(StreamableHttpPostResponse::Accepted) => {} + other => panic!("expected Accepted, got: {other:?}"), + } +} diff --git a/vendor/rmcp/tests/test_streamable_http_priming.rs b/vendor/rmcp/tests/test_streamable_http_priming.rs new file mode 100644 index 00000000..1e0e5e5f --- /dev/null +++ b/vendor/rmcp/tests/test_streamable_http_priming.rs @@ -0,0 +1,499 @@ +#![cfg(not(feature = "local"))] +use std::time::Duration; + +use rmcp::transport::streamable_http_server::{ + StreamableHttpServerConfig, StreamableHttpService, + session::{SessionId, local::LocalSessionManager}, +}; +use tokio_util::sync::CancellationToken; + +mod common; +use common::calculator::Calculator; + +#[tokio::test] +async fn test_priming_on_stream_start() -> anyhow::Result<()> { + let ct = CancellationToken::new(); + + // legacy_session_mode: true automatically enables priming with DEFAULT_RETRY_INTERVAL (3 seconds) + let service: StreamableHttpService = + StreamableHttpService::new( + || Ok(Calculator::new()), + Default::default(), + StreamableHttpServerConfig::default() + .with_sse_keep_alive(None) + .with_cancellation_token(ct.child_token()), + ); + + let router = axum::Router::new().nest_service("/mcp", service); + let tcp_listener = tokio::net::TcpListener::bind("127.0.0.1:0").await?; + let addr = tcp_listener.local_addr()?; + + let handle = tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(tcp_listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + // Send initialize request + let client = reqwest::Client::new(); + let response = client + .post(format!("http://{addr}/mcp")) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .body(r#"{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-11-25","capabilities":{},"clientInfo":{"name":"test","version":"1.0"}}}"#) + .send() + .await?; + + assert_eq!(response.status(), 200); + + let body = response.text().await?; + + // Split SSE events by double newline + let events: Vec<&str> = body.split("\n\n").filter(|e| !e.is_empty()).collect(); + assert!(events.len() >= 2); + + // Verify priming event (first event) — initialize uses "0" (no http_request_id) + let priming_event = events[0]; + assert!(priming_event.contains("id: 0")); + assert!(priming_event.contains("retry: 3000")); + assert!(priming_event.contains("data:")); + + // Verify initialize response (second event) + let response_event = events[1]; + assert!(response_event.contains(r#""jsonrpc":"2.0""#)); + assert!(response_event.contains(r#""id":1"#)); + + ct.cancel(); + handle.await?; + + Ok(()) +} + +#[tokio::test] +async fn test_request_wise_priming_includes_http_request_id() -> anyhow::Result<()> { + let ct = CancellationToken::new(); + + let service: StreamableHttpService = + StreamableHttpService::new( + || Ok(Calculator::new()), + Default::default(), + StreamableHttpServerConfig::default() + .with_sse_keep_alive(None) + .with_cancellation_token(ct.child_token()), + ); + + let router = axum::Router::new().nest_service("/mcp", service); + let tcp_listener = tokio::net::TcpListener::bind("127.0.0.1:0").await?; + let addr = tcp_listener.local_addr()?; + + let handle = tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(tcp_listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + let client = reqwest::Client::new(); + + // Initialize the session + let response = client + .post(format!("http://{addr}/mcp")) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .body(r#"{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-11-25","capabilities":{},"clientInfo":{"name":"test","version":"1.0"}}}"#) + .send() + .await?; + assert_eq!(response.status(), 200); + let session_id: SessionId = response.headers()["mcp-session-id"].to_str()?.into(); + + // Send notifications/initialized + let status = client + .post(format!("http://{addr}/mcp")) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("mcp-session-id", session_id.to_string()) + .header("Mcp-Protocol-Version", "2025-06-18") + .body(r#"{"jsonrpc":"2.0","method":"notifications/initialized"}"#) + .send() + .await? + .status(); + assert_eq!(status, 202); + + // First tool call — should get http_request_id 0 + let body = client + .post(format!("http://{addr}/mcp")) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("mcp-session-id", session_id.to_string()) + .header("Mcp-Protocol-Version", "2025-06-18") + .body(r#"{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"sum","arguments":{"a":1,"b":2}}}"#) + .send() + .await? + .text() + .await?; + + let events: Vec<&str> = body.split("\n\n").filter(|e| !e.is_empty()).collect(); + assert!( + events.len() >= 2, + "expected priming + response, got: {body}" + ); + + // Priming event should encode the http_request_id (0) + let priming = events[0]; + assert!( + priming.contains("id: 0/0"), + "first request priming should be 0/0, got: {priming}" + ); + assert!(priming.contains("retry: 3000")); + + // Response event should use index 1 (since priming occupies index 0) + let response_event = events[1]; + assert!( + response_event.contains("id: 1/0"), + "first response event id should be 1/0, got: {response_event}" + ); + assert!(response_event.contains(r#""id":2"#)); + + // Second tool call — should get http_request_id 1 + let body = client + .post(format!("http://{addr}/mcp")) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("mcp-session-id", session_id.to_string()) + .header("Mcp-Protocol-Version", "2025-06-18") + .body(r#"{"jsonrpc":"2.0","id":3,"method":"tools/call","params":{"name":"sum","arguments":{"a":3,"b":4}}}"#) + .send() + .await? + .text() + .await?; + + let events: Vec<&str> = body.split("\n\n").filter(|e| !e.is_empty()).collect(); + assert!( + events.len() >= 2, + "expected priming + response, got: {body}" + ); + + let priming = events[0]; + assert!( + priming.contains("id: 0/1"), + "second request priming should be 0/1, got: {priming}" + ); + + let response_event = events[1]; + assert!( + response_event.contains("id: 1/1"), + "second response event id should be 1/1, got: {response_event}" + ); + assert!(response_event.contains(r#""id":3"#)); + + ct.cancel(); + handle.await?; + + Ok(()) +} + +#[tokio::test] +async fn test_resume_after_request_wise_channel_completed() -> anyhow::Result<()> { + let ct = CancellationToken::new(); + + let service: StreamableHttpService = + StreamableHttpService::new( + || Ok(Calculator::new()), + Default::default(), + StreamableHttpServerConfig::default() + .with_sse_keep_alive(None) + .with_cancellation_token(ct.child_token()), + ); + + let router = axum::Router::new().nest_service("/mcp", service); + let tcp_listener = tokio::net::TcpListener::bind("127.0.0.1:0").await?; + let addr = tcp_listener.local_addr()?; + + let handle = tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(tcp_listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + let client = reqwest::Client::new(); + + // Initialize session + let response = client + .post(format!("http://{addr}/mcp")) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .body(r#"{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-06-18","capabilities":{},"clientInfo":{"name":"test","version":"1.0"}}}"#) + .send() + .await?; + assert_eq!(response.status(), 200); + let session_id: SessionId = response.headers()["mcp-session-id"].to_str()?.into(); + + // Complete handshake + let status = client + .post(format!("http://{addr}/mcp")) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("mcp-session-id", session_id.to_string()) + .header("Mcp-Protocol-Version", "2025-06-18") + .body(r#"{"jsonrpc":"2.0","method":"notifications/initialized"}"#) + .send() + .await? + .status(); + assert_eq!(status, 202); + + // Call a tool and consume the full response (channel completes) + let body = client + .post(format!("http://{addr}/mcp")) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("mcp-session-id", session_id.to_string()) + .header("Mcp-Protocol-Version", "2025-06-18") + .body(r#"{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"sum","arguments":{"a":1,"b":2}}}"#) + .send() + .await? + .text() + .await?; + + let events: Vec<&str> = body.split("\n\n").filter(|e| !e.is_empty()).collect(); + assert!( + events.len() >= 2, + "expected priming + response, got: {body}" + ); + assert!(events[0].contains("id: 0/0")); + assert!(events[1].contains(r#""id":2"#)); + + // Resume with Last-Event-ID after the channel has completed. + // The server returns 200 — either with replayed cached events + // (if the channel is still retained) or an empty stream (if the + // session worker hasn't processed the completion yet). + let resume = client + .get(format!("http://{addr}/mcp")) + .header("Accept", "text/event-stream") + .header("mcp-session-id", session_id.to_string()) + .header("Mcp-Protocol-Version", "2025-06-18") + .header("last-event-id", "0/0") + .send() + .await?; + assert_eq!(resume.status(), 200); + + let resume_body = resume.text().await?; + // The stream should complete (not hang), regardless of whether + // it contains replayed events or is empty. + assert!( + !resume_body.contains("standalone"), + "should not receive events from a different stream" + ); + + ct.cancel(); + handle.await?; + + Ok(()) +} + +#[tokio::test] +async fn test_completed_cache_ttl_eviction() -> anyhow::Result<()> { + use std::sync::Arc; + + let ct = CancellationToken::new(); + let mut session_manager = LocalSessionManager::default(); + session_manager.session_config.completed_cache_ttl = Duration::from_millis(200); + let session_manager = Arc::new(session_manager); + + let service = StreamableHttpService::new( + || Ok(Calculator::new()), + session_manager.clone(), + StreamableHttpServerConfig::default() + .with_sse_keep_alive(None) + .with_cancellation_token(ct.child_token()), + ); + + let router = axum::Router::new().nest_service("/mcp", service); + let tcp_listener = tokio::net::TcpListener::bind("127.0.0.1:0").await?; + let addr = tcp_listener.local_addr()?; + + let handle = tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(tcp_listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + let client = reqwest::Client::new(); + + // Initialize session + let response = client + .post(format!("http://{addr}/mcp")) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .body(r#"{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-06-18","capabilities":{},"clientInfo":{"name":"test","version":"1.0"}}}"#) + .send() + .await?; + assert_eq!(response.status(), 200); + let session_id: SessionId = response.headers()["mcp-session-id"].to_str()?.into(); + + // Complete handshake + client + .post(format!("http://{addr}/mcp")) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("mcp-session-id", session_id.to_string()) + .header("Mcp-Protocol-Version", "2025-06-18") + .body(r#"{"jsonrpc":"2.0","method":"notifications/initialized"}"#) + .send() + .await?; + + // Call a tool and consume the response (channel completes) + let body = client + .post(format!("http://{addr}/mcp")) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("mcp-session-id", session_id.to_string()) + .header("Mcp-Protocol-Version", "2025-06-18") + .body(r#"{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"sum","arguments":{"a":1,"b":2}}}"#) + .send() + .await? + .text() + .await?; + assert!(body.contains(r#""id":2"#)); + + // Wait for TTL to expire (200ms) plus margin + tokio::time::sleep(Duration::from_millis(400)).await; + + // Send a notification to trigger an event loop iteration (runs eviction) + client + .post(format!("http://{addr}/mcp")) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("mcp-session-id", session_id.to_string()) + .header("Mcp-Protocol-Version", "2025-06-18") + .body(r#"{"jsonrpc":"2.0","method":"notifications/initialized"}"#) + .send() + .await?; + + // Small delay to ensure the eviction ran + tokio::time::sleep(Duration::from_millis(50)).await; + + // Resume after TTL — channel should be evicted. The server returns + // 200 with an empty stream (no events from a different stream). + let resume = client + .get(format!("http://{addr}/mcp")) + .header("Accept", "text/event-stream") + .header("mcp-session-id", session_id.to_string()) + .header("Mcp-Protocol-Version", "2025-06-18") + .header("last-event-id", "0/0") + .send() + .await?; + assert_eq!(resume.status(), 200); + + let body = resume.text().await?; + assert!( + !body.contains(r#""id":2"#), + "should NOT contain the old tool response after eviction, got: {body}" + ); + + ct.cancel(); + handle.await?; + + Ok(()) +} + +#[tokio::test] +async fn test_priming_on_stream_close() -> anyhow::Result<()> { + use std::sync::Arc; + + use rmcp::transport::streamable_http_server::session::SessionId; + + let ct = CancellationToken::new(); + let session_manager = Arc::new(LocalSessionManager::default()); + + // legacy_session_mode: true automatically enables priming with DEFAULT_RETRY_INTERVAL (3 seconds) + let service = StreamableHttpService::new( + || Ok(Calculator::new()), + session_manager.clone(), + StreamableHttpServerConfig::default() + .with_sse_keep_alive(None) + .with_cancellation_token(ct.child_token()), + ); + + let router = axum::Router::new().nest_service("/mcp", service); + let tcp_listener = tokio::net::TcpListener::bind("127.0.0.1:0").await?; + let addr = tcp_listener.local_addr()?; + + let handle = tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(tcp_listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + // Send initialize request to create a session + let client = reqwest::Client::new(); + let response = client + .post(format!("http://{addr}/mcp")) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .body(r#"{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-11-25","capabilities":{},"clientInfo":{"name":"test","version":"1.0"}}}"#) + .send() + .await?; + + let session_id: SessionId = response.headers()["mcp-session-id"].to_str()?.into(); + + // Open a standalone GET stream (send() returns when headers are received) + let response = client + .get(format!("http://{addr}/mcp")) + .header("Accept", "text/event-stream") + .header("mcp-session-id", session_id.to_string()) + .send() + .await?; + + assert_eq!(response.status(), 200); + + // Spawn a task to read the response body (blocks until stream closes) + let read_task = tokio::spawn(async move { response.text().await.unwrap() }); + + // Close the standalone stream with a 5-second retry hint + let sessions = session_manager.sessions.read().await; + let session = sessions.get(&session_id).unwrap(); + session + .close_standalone_sse_stream(Some(Duration::from_secs(5))) + .await?; + drop(sessions); + + // Wait for the read task to complete and verify the response + let body = read_task.await?; + + // Verify the stream received two priming events: + // 1. At stream start (retry: 3000) + // 2. Before close (retry: 5000) + let events: Vec<&str> = body.split("\n\n").filter(|e| !e.is_empty()).collect(); + assert_eq!(events.len(), 2); + + // First event: priming at stream start + let start_priming = events[0]; + assert!(start_priming.contains("id:")); + assert!(start_priming.contains("retry: 3000")); + assert!(start_priming.contains("data:")); + + // Second event: priming before close + let close_priming = events[1]; + assert!(close_priming.contains("id:")); + assert!(close_priming.contains("retry: 5000")); + assert!(close_priming.contains("data:")); + + ct.cancel(); + handle.await?; + + Ok(()) +} diff --git a/vendor/rmcp/tests/test_streamable_http_protocol_version.rs b/vendor/rmcp/tests/test_streamable_http_protocol_version.rs new file mode 100644 index 00000000..76005a79 --- /dev/null +++ b/vendor/rmcp/tests/test_streamable_http_protocol_version.rs @@ -0,0 +1,916 @@ +#![cfg(not(feature = "local"))] +//! Streamable HTTP protocol-version and request-metadata validation tests. +use std::sync::{ + Arc, + atomic::{AtomicUsize, Ordering}, +}; + +use rmcp::{ + ServerHandler, + transport::streamable_http_server::{ + StreamableHttpServerConfig, StreamableHttpService, session::local::LocalSessionManager, + }, +}; +use serde_json::{Value, json}; +use tokio_util::sync::CancellationToken; + +mod common; +use common::calculator::Calculator; + +fn init_body(body_version: &str) -> String { + format!( + r#"{{"jsonrpc":"2.0","id":1,"method":"initialize","params":{{"protocolVersion":"{body_version}","capabilities":{{}},"clientInfo":{{"name":"test","version":"1.0"}}}}}}"# + ) +} + +async fn spawn_server( + config: StreamableHttpServerConfig, +) -> (reqwest::Client, String, CancellationToken) { + spawn_server_with_manager(config, Arc::new(LocalSessionManager::default())).await +} + +async fn spawn_server_with_manager( + config: StreamableHttpServerConfig, + session_manager: Arc, +) -> (reqwest::Client, String, CancellationToken) { + let ct = config.cancellation_token.clone(); + let service: StreamableHttpService = + StreamableHttpService::new(|| Ok(Calculator::new()), session_manager, config); + + let router = axum::Router::new().nest_service("/mcp", service); + let tcp_listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let addr = tcp_listener.local_addr().unwrap(); + + tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(tcp_listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + let client = reqwest::Client::new(); + let base_url = format!("http://{addr}/mcp"); + (client, base_url, ct) +} + +fn stateless_json_config() -> StreamableHttpServerConfig { + StreamableHttpServerConfig::default() + .with_legacy_session_mode(false) + .with_json_response(true) + .with_sse_keep_alive(None) + .with_cancellation_token(CancellationToken::new()) +} + +fn stateful_config() -> StreamableHttpServerConfig { + StreamableHttpServerConfig::default() + .with_legacy_session_mode(true) + .with_sse_keep_alive(None) + .with_cancellation_token(CancellationToken::new()) +} + +async fn post_init( + client: &reqwest::Client, + url: &str, + header: Option<&str>, + body_version: &str, +) -> reqwest::Response { + let mut req = client + .post(url) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .body(init_body(body_version)); + if let Some(h) = header { + req = req.header("MCP-Protocol-Version", h); + } + req.send().await.expect("send initialize request") +} + +/// First JSON-RPC message of an SSE response, skipping the empty priming event. +async fn sse_payload(response: reqwest::Response) -> anyhow::Result { + let body = response.text().await?; + let data = body + .lines() + .filter_map(|line| line.strip_prefix("data: ")) + .find(|data| !data.is_empty()) + .expect("response must carry a JSON-RPC payload"); + Ok(serde_json::from_str(data)?) +} + +async fn post_non_initialize(client: &reqwest::Client, url: &str) -> reqwest::Response { + client + .post(url) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .body(r#"{"jsonrpc":"2.0","id":1,"method":"tools/list","params":{}}"#) + .send() + .await + .expect("send non-initialize request") +} + +async fn post_modern_request( + client: &reqwest::Client, + url: &str, + method: &str, + name: Option<&str>, + params: Value, +) -> reqwest::Response { + let mut request = client + .post(url) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("MCP-Protocol-Version", "2026-07-28") + .header("Mcp-Method", method) + .json(&json!({ + "jsonrpc": "2.0", + "id": 1, + "method": method, + "params": params, + })); + if let Some(name) = name { + request = request.header("Mcp-Name", name); + } + request.send().await.expect("send modern request") +} + +#[tokio::test] +async fn stateless_init_rejects_when_header_older_than_body() -> anyhow::Result<()> { + let (client, url, ct) = spawn_server(stateless_json_config()).await; + + let response = post_init(&client, &url, Some("2025-03-26"), "2025-11-25").await; + assert_eq!(response.status(), 400); + + let body: serde_json::Value = response.json().await?; + assert_eq!(body["error"]["code"], -32600); + assert!( + body["error"]["message"] + .as_str() + .unwrap_or_default() + .contains("MCP-Protocol-Version"), + "expected error message to mention the header, got: {body}" + ); + + ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn stateless_init_rejects_when_header_newer_than_body() -> anyhow::Result<()> { + let (client, url, ct) = spawn_server(stateless_json_config()).await; + + let response = post_init(&client, &url, Some("2025-11-25"), "2025-03-26").await; + assert_eq!(response.status(), 400); + + let body: serde_json::Value = response.json().await?; + assert_eq!(body["error"]["code"], -32600); + + ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn stateless_init_accepts_when_header_matches_body() -> anyhow::Result<()> { + let (client, url, ct) = spawn_server(stateless_json_config()).await; + + let response = post_init(&client, &url, Some("2025-11-25"), "2025-11-25").await; + assert_eq!(response.status(), 200); + + let body: serde_json::Value = response.json().await?; + assert!( + body["result"].is_object(), + "expected an InitializeResult, got: {body}" + ); + + ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn stateless_init_accepts_when_header_absent() -> anyhow::Result<()> { + let (client, url, ct) = spawn_server(stateless_json_config()).await; + + let response = post_init(&client, &url, None, "2025-11-25").await; + assert_eq!(response.status(), 200); + + ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn stateless_init_naming_a_post_handshake_version_negotiates_down() -> anyhow::Result<()> { + let (client, url, ct) = spawn_server(stateless_json_config()).await; + + let response = post_init(&client, &url, None, "2026-07-28").await; + assert_eq!( + response.status(), + 200, + "initialize selects legacy semantics whatever version it names" + ); + + let body: serde_json::Value = response.json().await?; + assert_eq!( + body["result"]["protocolVersion"], "2025-11-25", + "initialize must settle on a version that still has the handshake" + ); + + ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn stateful_init_rejects_when_header_mismatches_body() -> anyhow::Result<()> { + let (client, url, ct) = spawn_server(stateful_config()).await; + + let response = post_init(&client, &url, Some("2024-11-05"), "2025-11-25").await; + assert_eq!(response.status(), 400); + + let body: serde_json::Value = response.json().await?; + assert_eq!(body["error"]["code"], -32600); + + ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn stateful_rejected_initial_posts_do_not_create_sessions() -> anyhow::Result<()> { + let session_manager = Arc::new(LocalSessionManager::default()); + let (client, url, ct) = + spawn_server_with_manager(stateful_config(), session_manager.clone()).await; + + let response = post_non_initialize(&client, &url).await; + assert_eq!(response.status(), 422); + assert_eq!(session_manager.sessions.read().await.len(), 0); + + let response = post_init(&client, &url, Some("2024-11-05"), "2025-11-25").await; + assert_eq!(response.status(), 400); + assert_eq!(session_manager.sessions.read().await.len(), 0); + + ct.cancel(); + Ok(()) +} + +/// The `initialize` handshake exists only in the revisions before `2026-07-28`, +/// so naming a later version in it does not make the request a modern one: the +/// server keeps legacy semantics, opens a session, and answers with a version it +/// can actually serve over the handshake. +#[tokio::test] +async fn stateful_init_naming_a_post_handshake_version_opens_a_legacy_session() -> anyhow::Result<()> +{ + let (client, url, ct) = spawn_server(stateful_config()).await; + + let response = post_init(&client, &url, None, "2026-07-28").await; + assert_eq!( + response.status(), + 200, + "initialize selects legacy semantics whatever version it names" + ); + assert!( + response.headers().contains_key("Mcp-Session-Id"), + "the handshake must open a session, got headers: {:?}", + response.headers() + ); + + let payload = sse_payload(response).await?; + assert_eq!( + payload["result"]["protocolVersion"], "2025-11-25", + "initialize must settle on a version that still has the handshake" + ); + + ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn stateless_missing_protocol_header_returns_header_mismatch() -> anyhow::Result<()> { + let (client, url, ct) = spawn_server(stateless_json_config()).await; + + let body = r#"{"jsonrpc":"2.0","id":1,"method":"tools/list","params":{"_meta":{"io.modelcontextprotocol/protocolVersion":"2026-07-28","io.modelcontextprotocol/clientInfo":{"name":"test","version":"1.0"},"io.modelcontextprotocol/clientCapabilities":{}}}}"#; + let response = client + .post(&url) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("Mcp-Method", "tools/list") + .body(body) + .send() + .await + .expect("send non-initialize request"); + + assert_eq!(response.status(), 400); + + let body: serde_json::Value = response.json().await?; + assert_eq!(body["jsonrpc"], "2.0"); + assert_eq!(body["id"], 1); + assert_eq!(body["error"]["code"], -32020); + assert!( + body["error"]["message"] + .as_str() + .is_some_and(|message| message.contains("requires MCP-Protocol-Version header")), + "expected missing protocol header message, got: {body}" + ); + + ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn stateless_tools_list_rejects_missing_request_meta() { + let (client, url, ct) = spawn_server(stateless_json_config()).await; + + let response = post_modern_request(&client, &url, "tools/list", None, json!({})).await; + + assert_eq!(response.status(), 400); + let body: Value = response.json().await.expect("response should be JSON"); + assert_eq!(body["error"]["code"], -32602); + assert!( + body["error"]["message"] + .as_str() + .is_some_and(|message| message.contains("io.modelcontextprotocol/protocolVersion")), + "expected error message to mention protocolVersion, got: {body}" + ); + ct.cancel(); +} + +#[tokio::test] +async fn stateless_tools_call_rejects_missing_request_meta() { + let (client, url, ct) = spawn_server(stateless_json_config()).await; + + let response = post_modern_request( + &client, + &url, + "tools/call", + Some("sum"), + json!({ + "name": "sum", + "arguments": { + "a": 1, + "b": 2 + } + }), + ) + .await; + + assert_eq!(response.status(), 400); + let body: Value = response.json().await.expect("response should be JSON"); + assert_eq!(body["error"]["code"], -32602); + assert!( + body["error"]["message"] + .as_str() + .is_some_and(|message| message.contains("io.modelcontextprotocol/protocolVersion")), + "expected error message to mention protocolVersion, got: {body}" + ); + ct.cancel(); +} + +#[tokio::test] +async fn stateless_request_rejects_missing_meta_protocol_version() { + let (client, url, ct) = spawn_server(stateless_json_config()).await; + + let response = post_modern_request( + &client, + &url, + "tools/list", + None, + json!({ + "_meta": { + "io.modelcontextprotocol/clientInfo": { + "name": "test", + "version": "1.0" + }, + "io.modelcontextprotocol/clientCapabilities": {} + } + }), + ) + .await; + + assert_eq!(response.status(), 400); + let body: Value = response.json().await.expect("response should be JSON"); + assert_eq!(body["error"]["code"], -32602); + assert!( + body["error"]["message"] + .as_str() + .is_some_and(|message| message.contains("io.modelcontextprotocol/protocolVersion")), + "expected error message to mention protocolVersion, got: {body}" + ); + ct.cancel(); +} + +#[tokio::test] +async fn stateless_request_rejects_missing_meta_client_capabilities() { + let (client, url, ct) = spawn_server(stateless_json_config()).await; + + let response = post_modern_request( + &client, + &url, + "tools/list", + None, + json!({ + "_meta": { + "io.modelcontextprotocol/protocolVersion": "2026-07-28", + "io.modelcontextprotocol/clientInfo": { + "name": "test", + "version": "1.0" + } + } + }), + ) + .await; + + assert_eq!(response.status(), 400); + let body: Value = response.json().await.expect("response should be JSON"); + assert_eq!(body["error"]["code"], -32602); + assert!( + body["error"]["message"] + .as_str() + .is_some_and(|message| message.contains("io.modelcontextprotocol/clientCapabilities")), + "expected error message to mention clientCapabilities, got: {body}" + ); + ct.cancel(); +} + +#[tokio::test] +async fn stateless_request_accepts_missing_optional_meta_client_info() { + let (client, url, ct) = spawn_server(stateless_json_config()).await; + + let response = post_modern_request( + &client, + &url, + "tools/list", + None, + json!({ + "_meta": { + "io.modelcontextprotocol/protocolVersion": "2026-07-28", + "io.modelcontextprotocol/clientCapabilities": {} + } + }), + ) + .await; + + assert_eq!(response.status(), 200); + ct.cancel(); +} + +// --------------------------------------------------------------------------- +// Opt-in seam: `with_stateless_protocol_metadata_required(true)` +// --------------------------------------------------------------------------- +// In stateless mode, every non-initialize Streamable HTTP JSON-RPC request +// POST must carry the `MCP-Protocol-Version` HTTP header (missing → HTTP 400 / +// JSON-RPC `-32020` HeaderMismatch before dispatch). Every non-initialize, +// non-discover request must additionally carry a per-request +// `io.modelcontextprotocol/protocolVersion` in `_meta` (missing → HTTP 400 / +// JSON-RPC `-32602`). The existing rule that requires `server/discover` to +// carry `_meta.protocolVersion` is preserved unchanged. +// +// Non-dispatch is proven with an explicit invocation counter (`AtomicUsize`). + +#[derive(Clone)] +struct CountingServer { + lists: Arc, +} + +impl CountingServer { + fn new() -> (Self, Arc) { + let lists = Arc::new(AtomicUsize::new(0)); + ( + Self { + lists: lists.clone(), + }, + lists, + ) + } +} + +impl ServerHandler for CountingServer { + fn get_info(&self) -> rmcp::model::ServerConfig { + rmcp::model::ServerConfig::new( + rmcp::model::ServerCapabilities::builder() + .enable_tools() + .build(), + ) + } + + fn list_tools( + &self, + _request: Option, + _context: rmcp::service::RequestContext, + ) -> impl std::future::Future> + + Send + + '_ { + self.lists.fetch_add(1, Ordering::SeqCst); + std::future::ready(Ok(rmcp::model::ListToolsResult::default())) + } +} + +async fn spawn_counting( + config: StreamableHttpServerConfig, +) -> (reqwest::Client, String, CancellationToken, Arc) { + let ct = config.cancellation_token.clone(); + let (server, lists) = CountingServer::new(); + let service: StreamableHttpService = + StreamableHttpService::new(move || Ok(server.clone()), Default::default(), config); + + let router = axum::Router::new().nest_service("/mcp", service); + let tcp_listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let addr = tcp_listener.local_addr().unwrap(); + + tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(tcp_listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + ( + reqwest::Client::new(), + format!("http://{addr}/mcp"), + ct, + lists, + ) +} + +fn modern_required_config() -> StreamableHttpServerConfig { + StreamableHttpServerConfig::default() + .with_legacy_session_mode(false) + .with_json_response(true) + .with_sse_keep_alive(None) + .with_stateless_protocol_metadata_required(true) + .with_cancellation_token(CancellationToken::new()) +} + +async fn post_seam( + client: &reqwest::Client, + url: &str, + body: &str, + header_version: Option<&str>, + extra_headers: &[(&str, &str)], +) -> reqwest::Response { + let mut req = client + .post(url) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .body(body.to_owned()); + if let Some(h) = header_version { + req = req.header("MCP-Protocol-Version", h); + } + for (k, v) in extra_headers { + req = req.header(*k, *v); + } + req.send().await.expect("send request") +} + +// With the seam disabled, explicit stateless mode still dispatches a request +// without protocol metadata, preserving backwards compatibility. +#[tokio::test] +async fn seam_disabled_preserves_stateless_compatibility() -> anyhow::Result<()> { + let (client, url, ct, lists) = spawn_counting(stateless_json_config()).await; + + let body = r#"{"jsonrpc":"2.0","id":1,"method":"tools/list","params":{}}"#; + let response = post_seam(&client, &url, body, None, &[]).await; + assert_eq!(response.status(), 200); + assert_eq!( + lists.load(Ordering::SeqCst), + 1, + "seam-disabled stateless config must dispatch exactly once" + ); + + ct.cancel(); + Ok(()) +} + +// With legacy compatibility enabled, the seam applies only to requests that +// are routed statelessly: an established legacy session remains unchanged, +// while a self-identifying modern request is still enforced. +#[tokio::test] +async fn seam_mixed_mode_enforces_only_stateless_routed_requests() -> anyhow::Result<()> { + let config = StreamableHttpServerConfig::default() + .with_legacy_session_mode(true) + .with_json_response(true) + .with_sse_keep_alive(None) + .with_stateless_protocol_metadata_required(true) + .with_cancellation_token(CancellationToken::new()); + let (client, url, ct, lists) = spawn_counting(config).await; + + let legacy_body = r#"{"jsonrpc":"2.0","id":2,"method":"tools/list","params":{}}"#; + let unknown_response = post_seam( + &client, + &url, + legacy_body, + None, + &[("Mcp-Session-Id", "unknown-session")], + ) + .await; + assert_eq!( + unknown_response.status(), + reqwest::StatusCode::NOT_FOUND, + "the stateless seam must not shadow the legacy unknown-session boundary" + ); + assert_eq!(lists.load(Ordering::SeqCst), 0); + + let initialize = post_init(&client, &url, None, "2025-11-25").await; + assert_eq!(initialize.status(), 200); + let session_id = initialize + .headers() + .get("Mcp-Session-Id") + .and_then(|value| value.to_str().ok()) + .expect("legacy initialize response must include a session id") + .to_owned(); + + let legacy_response = post_seam( + &client, + &url, + legacy_body, + None, + &[("Mcp-Session-Id", &session_id)], + ) + .await; + assert_eq!(legacy_response.status(), 200); + let _ = legacy_response.bytes().await?; + assert_eq!( + lists.load(Ordering::SeqCst), + 1, + "legacy session routing must remain unchanged" + ); + + let delete_response = client + .delete(&url) + .header("Mcp-Session-Id", &session_id) + .send() + .await?; + assert_eq!(delete_response.status(), reqwest::StatusCode::ACCEPTED); + + let terminated_response = post_seam( + &client, + &url, + legacy_body, + None, + &[("Mcp-Session-Id", &session_id)], + ) + .await; + assert_eq!( + terminated_response.status(), + reqwest::StatusCode::NOT_FOUND, + "the stateless seam must not shadow the legacy terminated-session boundary" + ); + assert_eq!(lists.load(Ordering::SeqCst), 1); + + let modern_body = r#"{"jsonrpc":"2.0","id":3,"method":"tools/list","params":{}}"#; + let modern_response = post_seam( + &client, + &url, + modern_body, + Some("2026-07-28"), + &[("Mcp-Method", "tools/list")], + ) + .await; + assert_eq!(modern_response.status(), 400); + let payload: serde_json::Value = modern_response.json().await?; + assert_eq!(payload["error"]["code"], -32602); + assert_eq!( + lists.load(Ordering::SeqCst), + 1, + "stateless metadata rejection must happen before another handler dispatch" + ); + + ct.cancel(); + Ok(()) +} + +// Both signals absent → missing header / -32020 before dispatch. +#[tokio::test] +async fn seam_opt_in_rejects_missing_header_before_dispatch() -> anyhow::Result<()> { + let (client, url, ct, lists) = spawn_counting(modern_required_config()).await; + + let without_meta = r#"{"jsonrpc":"2.0","id":2,"method":"tools/list","params":{}}"#; + let response = post_seam(&client, &url, without_meta, None, &[]).await; + assert_eq!(response.status(), 400, "missing header must yield HTTP 400"); + let payload: serde_json::Value = response.json().await?; + assert_eq!(payload["error"]["code"], -32020); + assert_eq!( + lists.load(Ordering::SeqCst), + 0, + "handler invocation counter must stay at 0 when the header is missing" + ); + + ct.cancel(); + Ok(()) +} + +// Header present but `_meta.protocolVersion` absent → -32602 before +// dispatch. Counter must equal 0. +#[tokio::test] +async fn seam_opt_in_rejects_missing_meta_before_dispatch() -> anyhow::Result<()> { + let (client, url, ct, lists) = spawn_counting(modern_required_config()).await; + + let body = r#"{"jsonrpc":"2.0","id":4,"method":"tools/list","params":{}}"#; + let response = post_seam( + &client, + &url, + body, + Some("2026-07-28"), + &[("Mcp-Method", "tools/list")], + ) + .await; + assert_eq!(response.status(), 400); + let payload: serde_json::Value = response.json().await?; + assert_eq!(payload["error"]["code"], -32602); + assert_eq!( + lists.load(Ordering::SeqCst), + 0, + "handler invocation counter must stay at 0 when _meta.protocolVersion is missing" + ); + + ct.cancel(); + Ok(()) +} + +// A 2026 request with protocolVersion but no clientCapabilities reaches the +// existing inline-metadata validator and is rejected before method dispatch. +#[tokio::test] +async fn seam_opt_in_rejects_missing_client_capabilities_before_dispatch() -> anyhow::Result<()> { + let (client, url, ct, lists) = spawn_counting(modern_required_config()).await; + + let body = r#"{"jsonrpc":"2.0","id":5,"method":"tools/list","params":{"_meta":{"io.modelcontextprotocol/protocolVersion":"2026-07-28"}}}"#; + let response = post_seam( + &client, + &url, + body, + Some("2026-07-28"), + &[("Mcp-Method", "tools/list")], + ) + .await; + assert_eq!(response.status(), 400); + let payload: serde_json::Value = response.json().await?; + assert_eq!(payload["error"]["code"], -32602); + assert_eq!( + lists.load(Ordering::SeqCst), + 0, + "handler invocation counter must stay at 0 when clientCapabilities is missing" + ); + + ct.cancel(); + Ok(()) +} + +// Both signals present at the current version, plus the routing header +// required by `validate_standard_headers` for `>= STANDARD_HEADERS`. The +// seam must dispatch and the handler must run exactly once. +#[tokio::test] +async fn seam_opt_in_dispatches_when_header_and_meta_present() -> anyhow::Result<()> { + let (client, url, ct, lists) = spawn_counting(modern_required_config()).await; + + let body = r#"{"jsonrpc":"2.0","id":6,"method":"tools/list","params":{"_meta":{"io.modelcontextprotocol/protocolVersion":"2026-07-28","io.modelcontextprotocol/clientInfo":{"name":"test","version":"1.0"},"io.modelcontextprotocol/clientCapabilities":{}}}}"#; + let response = post_seam( + &client, + &url, + body, + Some("2026-07-28"), + &[("Mcp-Method", "tools/list")], + ) + .await; + assert_eq!(response.status(), 200); + let payload: serde_json::Value = response.json().await?; + assert!(payload.get("result").is_some()); + assert_eq!( + lists.load(Ordering::SeqCst), + 1, + "handler invocation counter must equal 1 on successful dispatch" + ); + + ct.cancel(); + Ok(()) +} + +// rmcp clients negotiated below 2026-07-28 send the protocol header but do +// not attach per-request protocol metadata. Requiring the metadata therefore +// rejects their real request shape even if the handler supports that version. +#[tokio::test] +async fn seam_opt_in_rejects_older_rmcp_client_request_shape() -> anyhow::Result<()> { + let (client, url, ct, lists) = spawn_counting(modern_required_config()).await; + + let body = r#"{"jsonrpc":"2.0","id":7,"method":"tools/list","params":{}}"#; + let response = post_seam(&client, &url, body, Some("2025-11-25"), &[]).await; + assert_eq!(response.status(), 400); + let payload: serde_json::Value = response.json().await?; + assert_eq!(payload["error"]["code"], -32602); + assert_eq!( + lists.load(Ordering::SeqCst), + 0, + "an older client request without per-request metadata must not dispatch" + ); + + ct.cancel(); + Ok(()) +} + +// When the 2026+ header is present but `Mcp-Method` is missing, the +// existing `validate_standard_headers` rule must fire first with -32020, +// before the seam's -32602 missing-meta check. +#[tokio::test] +async fn seam_opt_in_preserves_standard_header_precedence() -> anyhow::Result<()> { + let (client, url, ct, lists) = spawn_counting(modern_required_config()).await; + + let body = r#"{"jsonrpc":"2.0","id":7,"method":"tools/list","params":{"_meta":{"io.modelcontextprotocol/protocolVersion":"2026-07-28"}}}"#; + let response = post_seam(&client, &url, body, Some("2026-07-28"), &[]).await; + assert_eq!(response.status(), 400); + let payload: serde_json::Value = response.json().await?; + assert_eq!( + payload["error"]["code"], -32020, + "standard-headers routing-header error must precede the seam's meta check" + ); + assert_eq!( + lists.load(Ordering::SeqCst), + 0, + "handler invocation counter must stay at 0 when a routing header is missing" + ); + + ct.cancel(); + Ok(()) +} + +// `initialize` is exempt from the new required-header check while retaining +// its existing optional-header and header/body consistency rules. +#[tokio::test] +async fn seam_opt_in_preserves_initialize_rules() -> anyhow::Result<()> { + let (client, url, ct) = spawn_server(modern_required_config()).await; + + let response = post_init(&client, &url, None, "2025-11-25").await; + assert_eq!(response.status(), 200); + + let response = post_init(&client, &url, Some("2025-11-25"), "2025-11-25").await; + assert_eq!(response.status(), 200); + + let response = post_init(&client, &url, Some("2025-03-26"), "2025-11-25").await; + assert_eq!(response.status(), 400); + let payload: serde_json::Value = response.json().await?; + assert_eq!(payload["error"]["code"], -32600); + + ct.cancel(); + Ok(()) +} + +// `notifications/initialized` returns HTTP 202 (Accepted) without +// requiring any protocol metadata, even under the seam. +#[tokio::test] +async fn seam_opt_in_notifications_return_202() -> anyhow::Result<()> { + let (client, url, ct) = spawn_server(modern_required_config()).await; + + let body = r#"{"jsonrpc":"2.0","method":"notifications/initialized"}"#; + let response = post_seam(&client, &url, body, None, &[]).await; + assert_eq!( + response.status(), + reqwest::StatusCode::ACCEPTED, + "notifications must surface HTTP 202 regardless of metadata" + ); + + ct.cancel(); + Ok(()) +} + +// `server/discover` is still subject to the new HTTP-header precheck. +#[tokio::test] +async fn seam_opt_in_discover_rejects_missing_header() -> anyhow::Result<()> { + let (client, url, ct) = spawn_server(modern_required_config()).await; + + let with_meta = r#"{"jsonrpc":"2.0","id":8,"method":"server/discover","params":{"_meta":{"io.modelcontextprotocol/protocolVersion":"2025-11-25","io.modelcontextprotocol/clientInfo":{"name":"test","version":"1.0"},"io.modelcontextprotocol/clientCapabilities":{}}}}"#; + let without_meta = r#"{"jsonrpc":"2.0","id":9,"method":"server/discover","params":{}}"#; + for body in [with_meta, without_meta] { + let response = post_seam( + &client, + &url, + body, + None, + &[("Mcp-Method", "server/discover")], + ) + .await; + assert_eq!(response.status(), 400); + let payload: serde_json::Value = response.json().await?; + assert_eq!(payload["error"]["code"], -32020); + } + + let response = post_seam( + &client, + &url, + without_meta, + Some("2025-11-25"), + &[("Mcp-Method", "server/discover")], + ) + .await; + assert_eq!(response.status(), 400); + let payload: serde_json::Value = response.json().await?; + assert_eq!(payload["error"]["code"], -32602); + + let response = post_seam( + &client, + &url, + with_meta, + Some("2025-11-25"), + &[("Mcp-Method", "server/discover")], + ) + .await; + assert_eq!(response.status(), 200); + + ct.cancel(); + Ok(()) +} diff --git a/vendor/rmcp/tests/test_streamable_http_session_store.rs b/vendor/rmcp/tests/test_streamable_http_session_store.rs new file mode 100644 index 00000000..8fdb9467 --- /dev/null +++ b/vendor/rmcp/tests/test_streamable_http_session_store.rs @@ -0,0 +1,459 @@ +#![cfg(all( + feature = "client", + feature = "server", + feature = "transport-streamable-http-client-reqwest", + feature = "transport-streamable-http-server", + not(feature = "local") +))] + +use std::{collections::HashMap, sync::Arc}; + +use rmcp::{ + ServiceExt, + model::{ClientConfig, ProtocolVersion}, + transport::{ + StreamableHttpClientTransport, + streamable_http_client::StreamableHttpClientTransportConfig, + streamable_http_server::{ + StreamableHttpServerConfig, StreamableHttpService, + session::{SessionState, SessionStore, SessionStoreError, local::LocalSessionManager}, + }, + }, +}; +use tokio::sync::RwLock; +use tokio_util::sync::CancellationToken; + +mod common; +use common::calculator::Calculator; + +// --------------------------------------------------------------------------- +// Shared in-memory store used across tests +// --------------------------------------------------------------------------- + +#[derive(Default, Clone)] +struct InMemorySessionStore(Arc>>); + +impl InMemorySessionStore { + fn new() -> Self { + Self::default() + } + + async fn len(&self) -> usize { + self.0.read().await.len() + } +} + +#[async_trait::async_trait] +impl SessionStore for InMemorySessionStore { + async fn load(&self, session_id: &str) -> Result, SessionStoreError> { + Ok(self.0.read().await.get(session_id).cloned()) + } + + async fn store(&self, session_id: &str, state: &SessionState) -> Result<(), SessionStoreError> { + self.0 + .write() + .await + .insert(session_id.to_owned(), state.clone()); + Ok(()) + } + + async fn delete(&self, session_id: &str) -> Result<(), SessionStoreError> { + self.0.write().await.remove(session_id); + Ok(()) + } +} + +// --------------------------------------------------------------------------- +// Helper: spin up a StreamableHttpService backed by the given store and +// return the bound address together with the cancellation token. +// --------------------------------------------------------------------------- + +fn make_service( + session_store: Arc, + ct: &CancellationToken, +) -> StreamableHttpService { + StreamableHttpService::new(|| Ok(Calculator::new()), Default::default(), { + let mut cfg = StreamableHttpServerConfig::default(); + cfg.legacy_session_mode = true; + cfg.sse_keep_alive = None; + cfg.cancellation_token = ct.child_token(); + cfg.session_store = Some(session_store); + cfg + }) +} + +// --------------------------------------------------------------------------- +// Test 1 — state is persisted to the store after a successful handshake +// --------------------------------------------------------------------------- + +#[tokio::test] +async fn test_session_state_persisted_to_store() -> anyhow::Result<()> { + let store = Arc::new(InMemorySessionStore::new()); + let ct = CancellationToken::new(); + let service = make_service(store.clone(), &ct); + + let router = axum::Router::new().nest_service("/mcp", service); + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await?; + let addr = listener.local_addr()?; + + let handle = tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + // Connect a full client — this performs the initialize + initialized handshake. + let transport = StreamableHttpClientTransport::from_config( + StreamableHttpClientTransportConfig::with_uri(format!("http://{addr}/mcp")), + ); + let client = ClientConfig::default() + .with_protocol_version(ProtocolVersion::LATEST_WITH_INITIALIZE) + .serve(transport) + .await?; + + // Make a real request so the session is fully active. + let _resources = client.list_all_resources().await?; + + // The store should now contain exactly one session entry. + assert_eq!( + store.len().await, + 1, + "session state should be persisted to the store after initialization" + ); + + // Verify the stored state contains the expected client info. + let entries = store.0.read().await; + let state = entries.values().next().expect("store entry should exist"); + assert_eq!( + state.initialize_params.client_info.name, "rmcp", + "stored client_info.name should match the rmcp client" + ); + + let _ = client.cancel().await; + ct.cancel(); + handle.await?; + + Ok(()) +} + +// --------------------------------------------------------------------------- +// Test 2 — store entry is removed when the client sends HTTP DELETE +// --------------------------------------------------------------------------- + +#[tokio::test] +async fn test_session_state_deleted_from_store_on_delete() -> anyhow::Result<()> { + let store = Arc::new(InMemorySessionStore::new()); + let session_manager = Arc::new(LocalSessionManager::default()); + let ct = CancellationToken::new(); + + let service = StreamableHttpService::new(|| Ok(Calculator::new()), session_manager.clone(), { + let mut cfg = StreamableHttpServerConfig::default(); + cfg.legacy_session_mode = true; + cfg.sse_keep_alive = None; + cfg.cancellation_token = ct.child_token(); + cfg.session_store = Some(store.clone()); + cfg + }); + + let router = axum::Router::new().nest_service("/mcp", service); + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await?; + let addr = listener.local_addr()?; + + let handle = tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + let transport = StreamableHttpClientTransport::from_config( + StreamableHttpClientTransportConfig::with_uri(format!("http://{addr}/mcp")), + ); + let client = ClientConfig::default() + .with_protocol_version(ProtocolVersion::LATEST_WITH_INITIALIZE) + .serve(transport) + .await?; + let _resources = client.list_all_resources().await?; + + assert_eq!(store.len().await, 1, "store should have one entry"); + + // Get the session ID from the server's in-memory map. + let session_id = { + let sessions = session_manager.sessions.read().await; + sessions + .keys() + .next() + .cloned() + .expect("session should exist") + }; + + // Send an explicit HTTP DELETE — this is the signal to remove from store. + let http_client = reqwest::Client::new(); + let response = http_client + .delete(format!("http://{addr}/mcp")) + .header("mcp-session-id", session_id.as_ref()) + .send() + .await?; + assert_eq!(response.status(), 202); + + assert_eq!( + store.len().await, + 0, + "store entry should be removed after explicit DELETE" + ); + + let _ = client.cancel().await; + ct.cancel(); + handle.await?; + + Ok(()) +} + +// --------------------------------------------------------------------------- +// Helper: spin up a server on an ephemeral port and return its address and +// the join handle. The server shuts down when `ct` is cancelled. +// --------------------------------------------------------------------------- + +fn spawn_server( + session_store: Option>, + session_manager: Arc, + ct: &CancellationToken, +) -> (std::net::SocketAddr, tokio::task::JoinHandle<()>) { + let svc = StreamableHttpService::new(|| Ok(Calculator::new()), session_manager, { + let mut cfg = StreamableHttpServerConfig::default(); + cfg.legacy_session_mode = true; + cfg.sse_keep_alive = None; + cfg.cancellation_token = ct.child_token(); + cfg.session_store = session_store; + cfg + }); + // Use std::net::TcpListener so the port is bound synchronously before + // we return — avoids a race between returning the addr and the server + // actually starting to accept connections. + let std_listener = std::net::TcpListener::bind("127.0.0.1:0").unwrap(); + std_listener.set_nonblocking(true).unwrap(); + let addr = std_listener.local_addr().unwrap(); + let listener = tokio::net::TcpListener::from_std(std_listener).unwrap(); + let router = axum::Router::new().nest_service("/mcp", svc); + let handle = tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + (addr, handle) +} + +// --------------------------------------------------------------------------- +// Test 3 — cross-instance session restore +// +// Both halves follow the same structure: +// +// Instance A initializes the session (session state may be saved to store) +// Instance A is fully shut down +// Instance B (fresh, no in-memory state) receives a request for the old ID +// +// Without a store → 404. With a shared store → transparent restore. +// --------------------------------------------------------------------------- + +#[tokio::test] +async fn test_cross_instance_session_restore() -> anyhow::Result<()> { + let http = reqwest::Client::new(); + + // ----------------------------------------------------------------------- + // Negative check: no session store → instance B returns 404. + // ----------------------------------------------------------------------- + { + // --- Instance A (no store): initialize --- + let ct_a = CancellationToken::new(); + let (addr_a, srv_a) = spawn_server(None, Arc::new(LocalSessionManager::default()), &ct_a); + + let init_resp = http + .post(format!("http://{addr_a}/mcp")) + .header("accept", "application/json, text/event-stream") + .header("content-type", "application/json") + .body(r#"{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-11-25","capabilities":{},"clientInfo":{"name":"test","version":"0"}}}"#) + .send() + .await?; + assert_eq!( + init_resp.status(), + 200, + "instance A: initialize should succeed" + ); + let session_id = init_resp + .headers() + .get("mcp-session-id") + .expect("session ID header must be present") + .to_str()? + .to_owned(); + + // Shut down instance A completely. + ct_a.cancel(); + srv_a.await?; + + // --- Instance B (no store, fresh state): send request --- + let ct_b = CancellationToken::new(); + let (addr_b, srv_b) = spawn_server(None, Arc::new(LocalSessionManager::default()), &ct_b); + + let resp = http + .post(format!("http://{addr_b}/mcp")) + .header("accept", "application/json, text/event-stream") + .header("content-type", "application/json") + .header("mcp-session-id", &session_id) + .body(r#"{"jsonrpc":"2.0","id":2,"method":"ping","params":{}}"#) + .send() + .await?; + assert_eq!( + resp.status(), + reqwest::StatusCode::NOT_FOUND, + "without a session store, instance B must return 404 for an unknown session ID" + ); + + ct_b.cancel(); + srv_b.await?; + } + + // ----------------------------------------------------------------------- + // Positive check: shared session store → instance B restores transparently. + // ----------------------------------------------------------------------- + { + let store: Arc = Arc::new(InMemorySessionStore::new()); + + // --- Instance A (with store): initialize --- + let ct_a = CancellationToken::new(); + let sm_a = Arc::new(LocalSessionManager::default()); + let (addr_a, srv_a) = spawn_server(Some(store.clone()), sm_a.clone(), &ct_a); + + let init_resp = http + .post(format!("http://{addr_a}/mcp")) + .header("accept", "application/json, text/event-stream") + .header("content-type", "application/json") + .body(r#"{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-11-25","capabilities":{},"clientInfo":{"name":"test","version":"0"}}}"#) + .send() + .await?; + assert_eq!( + init_resp.status(), + 200, + "instance A: initialize should succeed" + ); + let original_session_id = init_resp + .headers() + .get("mcp-session-id") + .expect("session ID header must be present") + .to_str()? + .to_owned(); + + // Confirm the session was persisted. + let store_ref = store + .load(&original_session_id) + .await + .expect("store load should not error"); + assert!( + store_ref.is_some(), + "store should hold the session after initialization" + ); + + // Shut down instance A completely — session lives only in the store now. + ct_a.cancel(); + srv_a.await?; + + // --- Instance B (same store, fresh in-memory state): send request --- + let ct_b = CancellationToken::new(); + let sm_b = Arc::new(LocalSessionManager::default()); + let (addr_b, srv_b) = spawn_server(Some(store.clone()), sm_b.clone(), &ct_b); + + let resp = http + .post(format!("http://{addr_b}/mcp")) + .header("accept", "application/json, text/event-stream") + .header("content-type", "application/json") + .header("mcp-session-id", &original_session_id) + .body(r#"{"jsonrpc":"2.0","id":2,"method":"ping","params":{}}"#) + .send() + .await?; + assert_eq!( + resp.status(), + 200, + "instance B: request must succeed after transparent restore" + ); + + // The session must be in instance B's memory under the ORIGINAL ID. + { + let sessions = sm_b.sessions.read().await; + let restored_id = sessions + .keys() + .next() + .expect("session should exist in instance B after restore"); + assert_eq!( + restored_id.as_ref(), + original_session_id.as_str(), + "restored session must keep the original session ID" + ); + } + + ct_b.cancel(); + srv_b.await?; + } + + Ok(()) +} + +// --------------------------------------------------------------------------- +// Test 4 — companion to Test 1: at LATEST the lifecycle lives in `_meta`, so +// the server answers statelessly and creates no session. +// --------------------------------------------------------------------------- + +#[tokio::test] +async fn test_no_session_created_at_latest_protocol_version() -> anyhow::Result<()> { + let store = Arc::new(InMemorySessionStore::new()); + let session_manager = Arc::new(LocalSessionManager::default()); + let ct = CancellationToken::new(); + let (addr, handle) = spawn_server(Some(store.clone()), session_manager.clone(), &ct); + + let response = reqwest::Client::new() + .post(format!("http://{addr}/mcp")) + .header("accept", "application/json, text/event-stream") + .header("content-type", "application/json") + .header("mcp-protocol-version", ProtocolVersion::LATEST.as_str()) + // Required by SEP-2243 from 2026-07-28 onward. + .header("mcp-method", "resources/list") + .json(&serde_json::json!({ + "jsonrpc": "2.0", + "id": 1, + "method": "resources/list", + "params": { + "_meta": { + "io.modelcontextprotocol/protocolVersion": ProtocolVersion::LATEST.as_str(), + "io.modelcontextprotocol/clientCapabilities": {} + } + } + })) + .send() + .await?; + + assert!(response.status().is_success(), "got {}", response.status()); + assert!( + response.headers().get("mcp-session-id").is_none(), + "no session id should be assigned" + ); + // Drain the body so the request is fully handled before asserting on state. + let _ = response.bytes().await?; + + assert_eq!(store.len().await, 0, "no session should be persisted"); + assert_eq!( + session_manager.sessions.read().await.len(), + 0, + "no in-memory session should be created" + ); + + ct.cancel(); + handle.await?; + + Ok(()) +} diff --git a/vendor/rmcp/tests/test_streamable_http_stale_session.rs b/vendor/rmcp/tests/test_streamable_http_stale_session.rs new file mode 100644 index 00000000..880fab55 --- /dev/null +++ b/vendor/rmcp/tests/test_streamable_http_stale_session.rs @@ -0,0 +1,470 @@ +#![cfg(all( + feature = "transport-streamable-http-client", + feature = "transport-streamable-http-client-reqwest", + feature = "transport-streamable-http-server", + not(feature = "local") +))] + +use std::{ + collections::{HashMap, VecDeque}, + sync::Arc, +}; + +use futures::stream; +use http::{HeaderName, HeaderValue}; +use rmcp::{ + ServiceError, ServiceExt, + model::{ + CallToolRequestParams, ClientConfig, ClientJsonRpcMessage, ClientRequest, ErrorCode, + ErrorData, InitializeResult, PingRequest, ProtocolVersion, RequestId, ServerCapabilities, + ServerJsonRpcMessage, ServerResult, + }, + transport::{ + StreamableHttpClientTransport, + streamable_http_client::{ + StreamableHttpClient, StreamableHttpClientTransportConfig, StreamableHttpError, + StreamableHttpPostResponse, + }, + streamable_http_server::{ + StreamableHttpServerConfig, StreamableHttpService, session::local::LocalSessionManager, + }, + }, +}; +use tokio_util::sync::CancellationToken; + +mod common; +use common::calculator::Calculator; + +#[derive(Debug, thiserror::Error)] +#[error("mock streamable http client error")] +struct MockClientError; + +#[derive(Clone)] +struct ReinitDropsAcceptedResponseClient { + state: Arc>, + stale_stream_cancelled: CancellationToken, + initial_request_accepted: Arc, + final_retry_accepted: Arc, +} + +struct MockState { + session_counter: usize, + posts: VecDeque, +} + +enum MockPost { + Initialize, + Initialized, + Accepted, + SessionExpired, +} + +impl ReinitDropsAcceptedResponseClient { + fn new() -> Self { + Self { + state: Arc::new(tokio::sync::Mutex::new(MockState { + session_counter: 0, + posts: VecDeque::from([ + MockPost::Initialize, + MockPost::Initialized, + MockPost::Accepted, + MockPost::SessionExpired, + MockPost::Initialize, + MockPost::Initialized, + MockPost::Accepted, + ]), + })), + stale_stream_cancelled: CancellationToken::new(), + initial_request_accepted: Arc::new(tokio::sync::Semaphore::new(0)), + final_retry_accepted: Arc::new(tokio::sync::Semaphore::new(0)), + } + } +} + +impl StreamableHttpClient for ReinitDropsAcceptedResponseClient { + type Error = MockClientError; + + async fn post_message( + &self, + _uri: Arc, + message: ClientJsonRpcMessage, + _session_id: Option>, + _auth_header: Option, + custom_headers: HashMap, + ) -> Result> { + let mut state = self.state.lock().await; + match state + .posts + .pop_front() + .expect("unexpected mock post_message call") + { + MockPost::Initialize => { + state.session_counter += 1; + let protocol_version = if state.session_counter == 1 { + ProtocolVersion::V_2025_11_25 + } else { + ProtocolVersion::V_2025_06_18 + }; + let id = match message { + ClientJsonRpcMessage::Request(request) => request.id, + other => panic!("expected initialize request, got {other:?}"), + }; + Ok(StreamableHttpPostResponse::Json( + ServerJsonRpcMessage::response( + ServerResult::InitializeResult( + InitializeResult::new( + ServerCapabilities::builder().enable_tools().build(), + ) + .with_protocol_version(protocol_version), + ), + id, + ), + Some(format!("session-{}", state.session_counter)), + )) + } + MockPost::Initialized => { + assert!( + matches!(message, ClientJsonRpcMessage::Notification(_)), + "expected initialized notification, got {message:?}" + ); + Ok(StreamableHttpPostResponse::Accepted) + } + MockPost::Accepted => { + if state.posts.is_empty() { + assert_eq!( + custom_headers + .get(&HeaderName::from_static("mcp-protocol-version")) + .and_then(|value| value.to_str().ok()), + Some(ProtocolVersion::V_2025_06_18.as_str()) + ); + self.final_retry_accepted.add_permits(1); + } else { + self.initial_request_accepted.add_permits(1); + } + Ok(StreamableHttpPostResponse::Accepted) + } + MockPost::SessionExpired => Err(StreamableHttpError::SessionExpired), + } + } + + async fn delete_session( + &self, + _uri: Arc, + _session_id: Arc, + _auth_header: Option, + _custom_headers: HashMap, + ) -> Result<(), StreamableHttpError> { + Ok(()) + } + + async fn get_stream( + &self, + _uri: Arc, + session_id: Option>, + _last_event_id: Option, + _auth_header: Option, + _custom_headers: HashMap, + ) -> Result< + futures::stream::BoxStream<'static, Result>, + StreamableHttpError, + > { + if session_id.as_deref() == Some("session-1") { + let cancel = self.stale_stream_cancelled.clone(); + Ok(Box::pin(stream::once(async move { + cancel.cancelled_owned().await; + Ok(sse_stream::Sse { + event: None, + data: Some( + serde_json::to_string(&ServerJsonRpcMessage::error( + ErrorData::new( + ErrorCode::INTERNAL_ERROR, + "stale stream should not deliver after re-init", + None, + ), + Some(RequestId::Number(2)), + )) + .expect("serialize stale error"), + ), + id: None, + retry: None, + }) + }))) + } else { + Ok(Box::pin(stream::pending())) + } + } +} + +#[tokio::test] +async fn test_reinitialization_completes_accepted_sse_request_instead_of_hanging() +-> anyhow::Result<()> { + let mock_client = ReinitDropsAcceptedResponseClient::new(); + let initial_request_accepted = mock_client.initial_request_accepted.clone(); + let final_retry_accepted = mock_client.final_retry_accepted.clone(); + let transport = StreamableHttpClientTransport::with_client( + mock_client, + StreamableHttpClientTransportConfig::with_uri("mock://mcp"), + ); + let mut client = ClientConfig::default().serve(transport).await?; + + let peer = client.peer().clone(); + let pending_call = tokio::spawn(async move { + peer.call_tool(CallToolRequestParams::new("slow_tool")) + .await + }); + + let _initial_permit = tokio::time::timeout( + std::time::Duration::from_secs(1), + initial_request_accepted.acquire(), + ) + .await + .expect("initial accepted request should be observed") + .expect("initial accepted request semaphore should stay open"); + + let reinit_trigger = { + let peer = client.peer().clone(); + tokio::spawn(async move { peer.list_tools(None).await }) + }; + + let _retry_permit = tokio::time::timeout( + std::time::Duration::from_secs(1), + final_retry_accepted.acquire(), + ) + .await + .expect("re-initialization retry should be accepted") + .expect("re-initialization retry semaphore should stay open"); + + let err = tokio::time::timeout(std::time::Duration::from_millis(100), pending_call) + .await + .expect("accepted SSE-backed request should complete instead of hanging")? + .expect_err( + "accepted request should fail after re-initialization drops its response stream", + ); + + match err { + ServiceError::McpError(error) => { + assert_eq!(error.code, ErrorCode::INTERNAL_ERROR); + assert!( + error.message.contains("session"), + "expected session-related error, got: {error}" + ); + } + other => panic!("expected McpError for orphaned request, got: {other:?}"), + } + + reinit_trigger.abort(); + let _ = client.close().await; + + Ok(()) +} + +#[tokio::test] +async fn test_stale_session_id_returns_status_aware_error() -> anyhow::Result<()> { + let ct = CancellationToken::new(); + let service: StreamableHttpService = + StreamableHttpService::new( + || Ok(Calculator::new()), + Default::default(), + StreamableHttpServerConfig::default() + .with_sse_keep_alive(None) + .with_cancellation_token(ct.child_token()), + ); + + let router = axum::Router::new().nest_service("/mcp", service); + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await?; + let addr = listener.local_addr()?; + + let handle = tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + let uri = Arc::::from(format!("http://{addr}/mcp")); + let message = ClientJsonRpcMessage::request( + ClientRequest::PingRequest(PingRequest::default()), + RequestId::Number(1), + ); + + let client = reqwest::Client::new(); + let result = client + .post_message( + uri.clone(), + message, + Some(Arc::from("stale-session-id")), + None, + HashMap::new(), + ) + .await; + + let raw_response = reqwest::Client::new() + .post(uri.as_ref()) + .header("accept", "application/json, text/event-stream") + .header("content-type", "application/json") + .header("mcp-session-id", "stale-session-id") + .body(r#"{"jsonrpc":"2.0","id":1,"method":"ping","params":{}}"#) + .send() + .await?; + + assert_eq!(raw_response.status(), reqwest::StatusCode::NOT_FOUND); + match result { + Err(StreamableHttpError::SessionExpired) => { + // Expected: post_message detects 404 with a session ID and returns SessionExpired + } + other => panic!("expected SessionExpired, got: {other:?}"), + } + + ct.cancel(); + handle.await?; + + Ok(()) +} + +/// Verify that when the server loses a session (returns HTTP 404), the client +/// transparently re-initializes and the original request succeeds. +#[tokio::test] +async fn test_transparent_reinitialization_on_session_expiry() -> anyhow::Result<()> { + let ct = CancellationToken::new(); + let session_manager = Arc::new(LocalSessionManager::default()); + + let service = StreamableHttpService::new( + || Ok(Calculator::new()), + session_manager.clone(), + StreamableHttpServerConfig::default() + .with_sse_keep_alive(None) + .with_cancellation_token(ct.child_token()), + ); + + let router = axum::Router::new().nest_service("/mcp", service); + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await?; + let addr = listener.local_addr()?; + + let server_handle = tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + // Connect a full client transport (this performs initialize + notifications/initialized) + let transport = StreamableHttpClientTransport::from_config( + StreamableHttpClientTransportConfig::with_uri(format!("http://{addr}/mcp")) + .reinit_on_expired_session(true), + ); + let client = ClientConfig::default() + .with_protocol_version(ProtocolVersion::LATEST_WITH_INITIALIZE) + .serve(transport) + .await?; + + // Verify the session is established: list_all_resources() succeeds + let _resources = client.list_all_resources().await?; + + // Capture the current session ID from the server + let original_session_id = { + let sessions = session_manager.sessions.read().await; + sessions + .keys() + .next() + .cloned() + .expect("session should exist") + }; + + // Force session expiry by removing all sessions from the server-side manager + { + let mut sessions = session_manager.sessions.write().await; + sessions.clear(); + } + + // This call should trigger transparent re-initialization and still succeed + let _resources_after = client.list_all_resources().await?; + + // Verify the server created a new session with a different ID + { + let sessions = session_manager.sessions.read().await; + let new_session_id = sessions + .keys() + .next() + .expect("new session should exist after re-initialization"); + assert_ne!( + new_session_id, &original_session_id, + "new session ID should differ from the original" + ); + } + + let _ = client.cancel().await; + ct.cancel(); + server_handle.await?; + + Ok(()) +} + +/// Verify that when `reinit_on_expired_session` is false and the server loses the session, +/// the client receives a `SessionExpired` transport error instead of retrying. +#[tokio::test] +async fn test_session_expired_error_when_reinit_disabled() -> anyhow::Result<()> { + let ct = CancellationToken::new(); + let session_manager = Arc::new(LocalSessionManager::default()); + + let service = StreamableHttpService::new( + || Ok(Calculator::new()), + session_manager.clone(), + StreamableHttpServerConfig::default() + .with_sse_keep_alive(None) + .with_cancellation_token(ct.child_token()), + ); + + let router = axum::Router::new().nest_service("/mcp", service); + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await?; + let addr = listener.local_addr()?; + + let server_handle = tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + + let transport = StreamableHttpClientTransport::from_config( + StreamableHttpClientTransportConfig::with_uri(format!("http://{addr}/mcp")) + .reinit_on_expired_session(false), + ); + let client = ClientConfig::default() + .with_protocol_version(ProtocolVersion::LATEST_WITH_INITIALIZE) + .serve(transport) + .await?; + + // Verify the session is established + let _resources = client.list_all_resources().await?; + + // Force session expiry by removing all sessions from the server-side manager + { + let mut sessions = session_manager.sessions.write().await; + sessions.clear(); + } + + // This call should fail with a SessionExpired transport error + let result = client.list_all_resources().await; + match result { + Err(ServiceError::TransportSend(ref dyn_err)) => { + let err_msg = format!("{dyn_err}"); + assert!( + err_msg.contains("Session expired"), + "expected 'Session expired' in error message, got: {err_msg}" + ); + } + other => panic!("expected TransportSend(SessionExpired), got: {other:?}"), + } + + let _ = client.cancel().await; + ct.cancel(); + server_handle.await?; + + Ok(()) +} diff --git a/vendor/rmcp/tests/test_streamable_http_standard_headers.rs b/vendor/rmcp/tests/test_streamable_http_standard_headers.rs new file mode 100644 index 00000000..5bbfedd6 --- /dev/null +++ b/vendor/rmcp/tests/test_streamable_http_standard_headers.rs @@ -0,0 +1,401 @@ +#![cfg(not(feature = "local"))] +//! SEP-2243 server-side validation of `Mcp-Method` / `Mcp-Name` / `Mcp-Param-*` headers. +use std::sync::Arc; + +use rmcp::{ + ServerHandler, + model::{ServerCapabilities, ServerConfig, Tool}, + transport::streamable_http_server::{ + StreamableHttpServerConfig, StreamableHttpService, session::local::LocalSessionManager, + }, +}; +use tokio_util::sync::CancellationToken; + +const SEP_VERSION: &str = "2026-07-28"; + +/// Server exposing one tool whose `region` argument is promoted to `Mcp-Param-Region`. +#[derive(Clone, Default)] +struct HeaderValidationServer; + +impl ServerHandler for HeaderValidationServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::builder().enable_tools().build()) + } + + fn get_tool(&self, name: &str) -> Option { + if name != "deploy" { + return None; + } + let schema = serde_json::json!({ + "type": "object", + "properties": { "region": { "type": "string", "x-mcp-header": "Region" } } + }); + let schema = schema.as_object().expect("object schema").clone(); + Some(Tool::new("deploy", "deploy a thing", Arc::new(schema))) + } +} + +async fn spawn_server() -> (reqwest::Client, String, CancellationToken) { + let config = StreamableHttpServerConfig::default() + .with_legacy_session_mode(false) + .with_json_response(true) + .with_sse_keep_alive(None) + .with_cancellation_token(CancellationToken::new()); + let ct = config.cancellation_token.clone(); + let service: StreamableHttpService = + StreamableHttpService::new(|| Ok(HeaderValidationServer), Default::default(), config); + + let router = axum::Router::new().nest_service("/mcp", service); + let tcp_listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let addr = tcp_listener.local_addr().unwrap(); + tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(tcp_listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + (reqwest::Client::new(), format!("http://{addr}/mcp"), ct) +} + +/// POSTs a `tools/call` with the given protocol-version and optional SEP-2243 headers. +async fn post_tool_call( + client: &reqwest::Client, + url: &str, + version: &str, + tool_name: &str, + arguments: serde_json::Value, + mcp_method: Option<&str>, + mcp_name: Option<&str>, + param_region: Option<&str>, +) -> reqwest::Response { + let body = serde_json::json!({ + "jsonrpc": "2.0", + "id": 1, + "method": "tools/call", + "params": { + "name": tool_name, + "arguments": arguments, + } + }); + let mut req = client + .post(url) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("MCP-Protocol-Version", version) + .body(body.to_string()); + if let Some(method) = mcp_method { + req = req.header("Mcp-Method", method); + } + if let Some(name) = mcp_name { + req = req.header("Mcp-Name", name); + } + if let Some(region) = param_region { + req = req.header("Mcp-Param-Region", region); + } + req.send().await.expect("send tools/call request") +} + +#[tokio::test] +async fn accepts_matching_standard_headers() -> anyhow::Result<()> { + let (client, url, ct) = spawn_server().await; + + // Matching headers pass validation and reach dispatch. (Stateless mode without a + // prior initialize yields an unrelated -32601, which still proves -32020 was not raised.) + let response = post_tool_call( + &client, + &url, + SEP_VERSION, + "sum", + serde_json::json!({ "a": 1, "b": 2 }), + Some("tools/call"), + Some("sum"), + None, + ) + .await; + let body: serde_json::Value = response.json().await?; + assert_ne!( + body["error"]["code"], -32020, + "matching headers must not be rejected as a header mismatch, got: {body}" + ); + + ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn rejects_method_mismatch_with_32020() -> anyhow::Result<()> { + let (client, url, ct) = spawn_server().await; + + let response = post_tool_call( + &client, + &url, + SEP_VERSION, + "sum", + serde_json::json!({ "a": 1, "b": 2 }), + Some("tools/list"), + Some("sum"), + None, + ) + .await; + assert_eq!(response.status(), 400); + let body: serde_json::Value = response.json().await?; + assert_eq!(body["error"]["code"], -32020); + + ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn rejects_missing_method_header_with_32020() -> anyhow::Result<()> { + let (client, url, ct) = spawn_server().await; + + let response = post_tool_call( + &client, + &url, + SEP_VERSION, + "sum", + serde_json::json!({ "a": 1, "b": 2 }), + None, + Some("sum"), + None, + ) + .await; + assert_eq!(response.status(), 400); + let body: serde_json::Value = response.json().await?; + assert_eq!(body["error"]["code"], -32020); + + ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn rejects_name_mismatch_with_32020() -> anyhow::Result<()> { + let (client, url, ct) = spawn_server().await; + + let response = post_tool_call( + &client, + &url, + SEP_VERSION, + "sum", + serde_json::json!({ "a": 1, "b": 2 }), + Some("tools/call"), + Some("product"), + None, + ) + .await; + assert_eq!(response.status(), 400); + let body: serde_json::Value = response.json().await?; + assert_eq!(body["error"]["code"], -32020); + + ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn skips_validation_for_pre_sep_version() -> anyhow::Result<()> { + let (client, url, ct) = spawn_server().await; + + // Older version: headers are not enforced even when absent. + let response = post_tool_call( + &client, + &url, + "2025-11-25", + "sum", + serde_json::json!({ "a": 1, "b": 2 }), + None, + None, + None, + ) + .await; + let body: serde_json::Value = response.json().await?; + assert_ne!( + body["error"]["code"], -32020, + "pre-SEP versions must skip header validation, got: {body}" + ); + + ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn accepts_matching_param_header() -> anyhow::Result<()> { + let (client, url, ct) = spawn_server().await; + + let response = post_tool_call( + &client, + &url, + SEP_VERSION, + "deploy", + serde_json::json!({ "region": "us-west1" }), + Some("tools/call"), + Some("deploy"), + Some("us-west1"), + ) + .await; + let body: serde_json::Value = response.json().await?; + assert_ne!( + body["error"]["code"], -32020, + "matching Mcp-Param-* must not be rejected, got: {body}" + ); + + ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn rejects_param_mismatch_with_32020() -> anyhow::Result<()> { + let (client, url, ct) = spawn_server().await; + + let response = post_tool_call( + &client, + &url, + SEP_VERSION, + "deploy", + serde_json::json!({ "region": "us-west1" }), + Some("tools/call"), + Some("deploy"), + Some("eu-central1"), + ) + .await; + assert_eq!(response.status(), 400); + let body: serde_json::Value = response.json().await?; + assert_eq!(body["error"]["code"], -32020); + + ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn rejects_decoded_base64_param_mismatch_with_32020() -> anyhow::Result<()> { + let (client, url, ct) = spawn_server().await; + + let response = post_tool_call( + &client, + &url, + SEP_VERSION, + "deploy", + serde_json::json!({ "region": "us-west1" }), + Some("tools/call"), + Some("deploy"), + Some("=?base64?ZXUtY2VudHJhbDE=?="), + ) + .await; + assert_eq!(response.status(), 400); + let body: serde_json::Value = response.json().await?; + assert_eq!(body["error"]["code"], -32020); + + ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn rejects_missing_param_header_with_32020() -> anyhow::Result<()> { + let (client, url, ct) = spawn_server().await; + + // `region` argument is present but the annotated `Mcp-Param-Region` header is absent. + let response = post_tool_call( + &client, + &url, + SEP_VERSION, + "deploy", + serde_json::json!({ "region": "us-west1" }), + Some("tools/call"), + Some("deploy"), + None, + ) + .await; + assert_eq!(response.status(), 400); + let body: serde_json::Value = response.json().await?; + assert_eq!(body["error"]["code"], -32020); + + ct.cancel(); + Ok(()) +} + +/// Spawns the server in legacy session mode: the initialize handshake creates +/// a real session, exercising the path where the validator used to be bypassed. +async fn spawn_legacy_server() -> (reqwest::Client, String, CancellationToken) { + let config = StreamableHttpServerConfig::default() + .with_legacy_session_mode(true) + .with_json_response(true) + .with_sse_keep_alive(None) + .with_cancellation_token(CancellationToken::new()); + let ct = config.cancellation_token.clone(); + let service: StreamableHttpService = + StreamableHttpService::new(|| Ok(HeaderValidationServer), Default::default(), config); + + let router = axum::Router::new().nest_service("/mcp", service); + let tcp_listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let addr = tcp_listener.local_addr().unwrap(); + tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(tcp_listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + (reqwest::Client::new(), format!("http://{addr}/mcp"), ct) +} + +/// POSTs an `initialize` request with the given protocol version and optional +/// `Mcp-Method` header. +async fn post_initialize( + client: &reqwest::Client, + url: &str, + version: &str, + mcp_method: Option<&str>, +) -> reqwest::Response { + let body = serde_json::json!({ + "jsonrpc": "2.0", + "id": 1, + "method": "initialize", + "params": { + "protocolVersion": version, + "capabilities": {}, + "clientInfo": { "name": "test", "version": "1.0" }, + } + }); + let mut req = client + .post(url) + .header("Content-Type", "application/json") + .header("Accept", "application/json, text/event-stream") + .header("MCP-Protocol-Version", version) + .body(body.to_string()); + if let Some(method) = mcp_method { + req = req.header("Mcp-Method", method); + } + req.send().await.expect("send initialize request") +} + +#[tokio::test] +async fn rejects_initialize_with_contradicting_mcp_method_before_session_creation() +-> anyhow::Result<()> { + let (client, url, ct) = spawn_legacy_server().await; + + // Regression test: in legacy session mode with no session id, an + // `initialize` body carrying a contradictory `Mcp-Method` header used to + // bypass the validator, returning HTTP 200 and creating a session. + let response = post_initialize(&client, &url, SEP_VERSION, Some("tools/list")).await; + assert_eq!(response.status(), 400); + let body: serde_json::Value = response.json().await?; + assert_eq!(body["error"]["code"], -32020); + + ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn accepts_initialize_with_matching_mcp_method() -> anyhow::Result<()> { + let (client, url, ct) = spawn_legacy_server().await; + + // A matching Mcp-Method header on initialize passes validation and the + // handshake completes (HTTP 200, session created). + let response = post_initialize(&client, &url, SEP_VERSION, Some("initialize")).await; + assert_eq!(response.status(), 200); + + ct.cancel(); + Ok(()) +} diff --git a/vendor/rmcp/tests/test_structured_output.rs b/vendor/rmcp/tests/test_structured_output.rs new file mode 100644 index 00000000..dd8b7239 --- /dev/null +++ b/vendor/rmcp/tests/test_structured_output.rs @@ -0,0 +1,471 @@ +#![allow(clippy::exhaustive_structs)] +//cargo test --test test_structured_output --features "client server macros" +use rmcp::{ + Json, ServerHandler, + handler::server::{router::tool::ToolRouter, tool::IntoCallToolResult, wrapper::Parameters}, + model::{CallToolResponse, CallToolResult, ContentBlock, ServerResult, Tool}, + tool, tool_handler, tool_router, +}; +use schemars::JsonSchema; +use serde::{Deserialize, Serialize}; +use serde_json::{Value, json}; + +#[derive(Serialize, Deserialize, JsonSchema)] +pub struct CalculationRequest { + pub a: i32, + pub b: i32, +} + +#[derive(Serialize, Deserialize, JsonSchema)] +pub struct CalculationResult { + pub sum: i32, + pub product: i32, +} + +#[derive(Serialize, Deserialize, JsonSchema)] +pub struct UserInfo { + pub name: String, + pub age: u32, +} + +#[derive(Serialize, Deserialize, JsonSchema)] +pub struct GreetingRequest { + pub name: String, +} + +#[derive(Serialize, Deserialize, JsonSchema)] +pub struct GetUserRequest { + pub user_id: String, +} + +#[tool_handler(router = self.tool_router)] +impl ServerHandler for TestServer {} + +#[derive(Debug, Clone)] +pub struct TestServer { + tool_router: ToolRouter, +} + +impl Default for TestServer { + fn default() -> Self { + Self::new() + } +} + +#[tool_router(router = tool_router)] +impl TestServer { + pub fn new() -> Self { + Self { + tool_router: Self::tool_router(), + } + } + + /// Tool that returns structured output + #[tool(name = "calculate", description = "Perform calculations")] + pub async fn calculate( + &self, + params: Parameters, + ) -> Result, String> { + Ok(Json(CalculationResult { + sum: params.0.a + params.0.b, + product: params.0.a * params.0.b, + })) + } + + /// Tool that returns regular string output + #[tool(name = "get-greeting", description = "Get a greeting")] + pub async fn get_greeting(&self, params: Parameters) -> String { + format!("Hello, {}!", params.0.name) + } + + /// Tool that returns structured user info + #[tool(name = "get-user", description = "Get user info")] + pub async fn get_user( + &self, + params: Parameters, + ) -> Result, String> { + if params.0.user_id == "123" { + Ok(Json(UserInfo { + name: "Alice".to_string(), + age: 30, + })) + } else { + Err("User not found".to_string()) + } + } + + /// Tool that returns a list of calculation results + #[tool( + name = "calculate-list", + description = "Return a list of calculation results" + )] + pub async fn calculate_list( + &self, + params: Parameters, + ) -> Result>, String> { + Ok(Json(vec![CalculationResult { + sum: params.0.a + params.0.b, + product: params.0.a * params.0.b, + }])) + } + + /// Tool that returns a count + #[tool(name = "get-count", description = "Return a count")] + pub async fn get_count(&self) -> Result, String> { + Ok(Json(42)) + } +} + +#[tokio::test] +async fn test_tool_with_output_schema() { + let server = TestServer::new(); + let tools = server.tool_router.list_all(); + + // Find the calculate tool + let calculate_tool = tools.iter().find(|t| t.name == "calculate").unwrap(); + + // Verify it has an output schema + assert!(calculate_tool.output_schema.is_some()); + + let schema = calculate_tool.output_schema.as_ref().unwrap(); + + // Check that the schema contains expected fields + let schema_str = serde_json::to_string(schema).unwrap(); + assert!(schema_str.contains("sum")); + assert!(schema_str.contains("product")); +} + +#[tokio::test] +async fn test_tool_without_output_schema() { + let server = TestServer::new(); + let tools = server.tool_router.list_all(); + + // Find the get-greeting tool + let greeting_tool = tools.iter().find(|t| t.name == "get-greeting").unwrap(); + + // Verify it doesn't have an output schema (returns String) + assert!(greeting_tool.output_schema.is_none()); +} + +#[tokio::test] +async fn test_structured_content_in_call_result() { + // Test creating a CallToolResult with structured content + let structured_data = json!({ + "sum": 7, + "product": 12 + }); + + let result = CallToolResult::structured(structured_data.clone()); + + assert!(!result.content.is_empty()); + assert!(result.structured_content.is_some()); + + let contents = result.content; + + assert_eq!(contents.len(), 1); + + let content_text = contents.first().unwrap().as_text(); + + assert!(content_text.is_some()); + + let content_value: Value = serde_json::from_str(&content_text.unwrap().text).unwrap(); + + assert_eq!(content_value, structured_data); + assert_eq!(result.structured_content.unwrap(), structured_data); + assert_eq!(result.is_error, Some(false)); +} + +#[tokio::test] +async fn test_structured_error_in_call_result() { + // Test creating a CallToolResult with structured error + let error_data = json!({ + "error_code": "NOT_FOUND", + "message": "User not found" + }); + + let result = CallToolResult::structured_error(error_data.clone()); + + assert!(!result.content.is_empty()); + assert!(result.structured_content.is_some()); + + let contents = result.content; + + assert_eq!(contents.len(), 1); + + let content_text = contents.first().unwrap().as_text(); + + assert!(content_text.is_some()); + + let content_value: Value = serde_json::from_str(&content_text.unwrap().text).unwrap(); + + assert_eq!(content_value, error_data); + assert_eq!(result.structured_content.unwrap(), error_data); + assert_eq!(result.is_error, Some(true)); +} + +#[tokio::test] +async fn test_mutual_exclusivity_validation() { + #[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)] + pub struct Response { + message: String, + } + let response = Response { + message: "Hello".into(), + }; + // Test that content and structured_content can both be passed separately + let content_result = + CallToolResult::success(vec![ContentBlock::json(response.clone()).unwrap()]); + let structured_result = CallToolResult::structured(json!({"message": "Hello"})); + + // Verify the validation + content_result + .into_typed::() + .expect("Failed to extract content"); + structured_result + .into_typed::() + .expect("Failed to extract content"); + + // Try to create a result with both fields + let json_with_both = json!({ + "content": [{"type": "text", "text": "Hello"}], + "structuredContent": {"message": "Hello"} + }); + + // The deserialization itself should not fail + let deserialized: Result = serde_json::from_value(json_with_both); + assert!(deserialized.is_ok()); +} + +#[tokio::test] +async fn test_structured_return_conversion() { + // Test that Json converts to CallToolResult with structured_content + let calc_result = CalculationResult { + sum: 7, + product: 12, + }; + + let structured = Json(calc_result); + let result: Result = + rmcp::handler::server::tool::IntoCallToolResult::into_call_tool_result(structured); + + assert!(result.is_ok()); + let CallToolResponse::Complete(call_result) = result.unwrap() else { + panic!("expected complete CallToolResult"); + }; + + // Tools which return structured content should also return a serialized version as + // Content::text for backwards compatibility. + assert!(!call_result.content.is_empty()); + assert!(call_result.structured_content.is_some()); + + let contents = call_result.content; + + assert_eq!(contents.len(), 1); + + let content_text = contents.first().unwrap().as_text(); + + assert!(content_text.is_some()); + + let content_value: Value = serde_json::from_str(&content_text.unwrap().text).unwrap(); + let structured_value = call_result.structured_content.unwrap(); + + assert_eq!(content_value, structured_value); + + assert_eq!(structured_value["sum"], 7); + assert_eq!(structured_value["product"], 12); +} + +#[tokio::test] +async fn test_tool_serialization_with_output_schema() { + let server = TestServer::new(); + let tools = server.tool_router.list_all(); + + let calculate_tool = tools.iter().find(|t| t.name == "calculate").unwrap(); + + // Serialize the tool + let serialized = serde_json::to_value(calculate_tool).unwrap(); + + // Check that outputSchema is included + assert!(serialized["outputSchema"].is_object()); + + // Deserialize back + let deserialized: Tool = serde_json::from_value(serialized).unwrap(); + assert!(deserialized.output_schema.is_some()); +} + +#[tokio::test] +async fn test_output_schema_requires_structured_content() { + // Test that tools with output_schema must use structured_content + let server = TestServer::new(); + let tools = server.tool_router.list_all(); + + // The calculate tool should have output_schema + let calculate_tool = tools.iter().find(|t| t.name == "calculate").unwrap(); + assert!(calculate_tool.output_schema.is_some()); + + // Directly call the tool and verify its result structure + let params = Parameters(CalculationRequest { a: 5, b: 3 }); + let result = server.calculate(params).await.unwrap(); + + // Convert the Json to CallToolResult + let call_result: Result = + IntoCallToolResult::into_call_tool_result(result); + + assert!(call_result.is_ok()); + let CallToolResponse::Complete(call_result) = call_result.unwrap() else { + panic!("expected complete CallToolResult"); + }; + + // Verify it has structured_content and content + assert!(call_result.structured_content.is_some()); + assert!(!call_result.content.is_empty()); +} + +#[tokio::test] +async fn test_empty_content_array_deserializes() { + let raw = json!({ "content": [] }); + let result: CallToolResult = serde_json::from_value(raw).unwrap(); + assert!(result.content.is_empty()); + assert!(result.structured_content.is_none()); + assert!(result.is_error.is_none()); +} + +#[tokio::test] +async fn test_empty_content_array_with_is_error() { + let raw = json!({ "content": [], "isError": false }); + let result: CallToolResult = serde_json::from_value(raw).unwrap(); + assert!(result.content.is_empty()); + assert_eq!(result.is_error, Some(false)); +} + +#[test] +fn test_missing_content_defaults_to_empty() { + let raw = json!({ "isError": false }); + let result: CallToolResult = serde_json::from_value(raw).unwrap(); + assert!(result.content.is_empty()); + assert_eq!(result.is_error, Some(false)); +} + +#[test] +fn test_missing_content_with_structured_content_deserializes() { + let raw = json!({ "structuredContent": {"key": "value"}, "isError": false }); + let result: CallToolResult = serde_json::from_value(raw).unwrap(); + assert!(result.content.is_empty()); + assert_eq!(result.structured_content.unwrap()["key"], "value"); +} + +#[tokio::test] +async fn test_empty_content_deserializes_as_call_tool_result_variant() { + let raw = json!({ "content": [] }); + let result: ServerResult = serde_json::from_value(raw).unwrap(); + match result { + ServerResult::CallToolResult(call_result) => { + assert!(call_result.content.is_empty()); + assert!(call_result.structured_content.is_none()); + } + other => panic!("Expected CallToolResult, got {:?}", other), + } +} + +#[tokio::test] +async fn test_empty_content_roundtrip() { + let result = CallToolResult::success(vec![]); + let v = serde_json::to_value(&result).unwrap(); + assert_eq!(v["content"], json!([])); + let deserialized: CallToolResult = serde_json::from_value(v).unwrap(); + assert_eq!(deserialized, result); +} + +#[test] +fn test_call_tool_result_deserialize_without_content() { + let json = json!({ + "structuredContent": {"message": "Hello"} + }); + let result: CallToolResult = serde_json::from_value(json).unwrap(); + assert!(result.content.is_empty()); + assert!(result.structured_content.is_some()); +} + +/// Per the 2026-07-28 spec, `structuredContent` can be any JSON value, +/// including `null`. A present `null` must stay distinct from an absent field. +#[test] +fn test_explicit_null_structured_content_is_preserved() { + let json = json!({ + "resultType": "complete", + "content": [], + "structuredContent": null + }); + let result: CallToolResult = serde_json::from_value(json).unwrap(); + assert_eq!(result.structured_content, Some(Value::Null)); +} + +#[test] +fn test_explicit_null_structured_content_without_content_deserializes() { + let json = json!({ + "resultType": "complete", + "structuredContent": null + }); + let result: CallToolResult = serde_json::from_value(json).unwrap(); + assert!(result.content.is_empty()); + assert_eq!(result.structured_content, Some(Value::Null)); +} + +#[test] +fn test_absent_structured_content_is_none() { + let json = json!({ + "resultType": "complete", + "content": [] + }); + let result: CallToolResult = serde_json::from_value(json).unwrap(); + assert_eq!(result.structured_content, None); +} + +#[test] +fn test_null_structured_content_serialization_roundtrip() { + let with_null = CallToolResult::structured(Value::Null); + let v = serde_json::to_value(&with_null).unwrap(); + assert_eq!(v.get("structuredContent"), Some(&Value::Null)); + let deserialized: CallToolResult = serde_json::from_value(v).unwrap(); + assert_eq!(deserialized, with_null); + + let absent = CallToolResult::success(vec![]); + let v = serde_json::to_value(&absent).unwrap(); + assert!(v.get("structuredContent").is_none()); + let deserialized: CallToolResult = serde_json::from_value(v).unwrap(); + assert_eq!(deserialized.structured_content, None); +} + +#[tokio::test] +async fn test_tool_with_array_output_schema() { + let server = TestServer::new(); + let tools = server.tool_router.list_all(); + + // Find the calculate-list tool + let calculate_list_tool = tools.iter().find(|t| t.name == "calculate-list").unwrap(); + + // Verify it has an output schema + assert!(calculate_list_tool.output_schema.is_some()); + + let schema = calculate_list_tool.output_schema.as_ref().unwrap(); + + // Check that the schema contains array type + let schema_str = serde_json::to_string(schema).unwrap(); + assert!(schema_str.contains("array")); +} + +#[tokio::test] +async fn test_tool_with_primitive_output_schema() { + let server = TestServer::new(); + let tools = server.tool_router.list_all(); + + // Find the get-count tool + let get_count_tool = tools.iter().find(|t| t.name == "get-count").unwrap(); + + // Verify it has an output schema + assert!(get_count_tool.output_schema.is_some()); + + let schema = get_count_tool.output_schema.as_ref().unwrap(); + + // Check that the schema contains integer type + assert_eq!(schema.get("type"), Some(&serde_json::json!("integer"))); +} diff --git a/vendor/rmcp/tests/test_subscriptions.rs b/vendor/rmcp/tests/test_subscriptions.rs new file mode 100644 index 00000000..73595300 --- /dev/null +++ b/vendor/rmcp/tests/test_subscriptions.rs @@ -0,0 +1,727 @@ +#![cfg(all( + not(feature = "local"), + feature = "client", + feature = "server", + feature = "transport-io" +))] + +use std::{ + num::NonZeroUsize, + sync::{ + Arc, + atomic::{AtomicUsize, Ordering}, + }, + time::Duration, +}; + +use rmcp::{ + ClientHandler, ClientServiceExt, ServerHandler, ServiceExt, + model::{ + ClientNotification, ClientRequest, DiscoverResult, GetMeta, Implementation, + NotificationMetaObject, PromptListChangedNotification, ProtocolVersion, ServerCapabilities, + ServerConfig, ServerNotification, ServerResult, SubscriptionFilter, + SubscriptionsAcknowledgedNotification, SubscriptionsAcknowledgedNotificationParams, + SubscriptionsListenResult, + }, + service::{ + NotificationContext, RequestContext, RoleClient, RoleServer, SubscriptionContext, + SubscriptionEnd, SubscriptionSendError, SubscriptionSink, + }, +}; +use tokio::sync::{Mutex, Notify}; + +struct ToolsOnlyServer; + +#[derive(Clone)] +struct CountingClient { + tool_changes: Arc, +} + +impl ClientHandler for CountingClient { + async fn on_tool_list_changed(&self, _context: NotificationContext) { + self.tool_changes.fetch_add(1, Ordering::Relaxed); + } +} + +impl ServerHandler for ToolsOnlyServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::new( + ServerCapabilities::builder() + .enable_tools() + .enable_tool_list_changed() + .build(), + ) + .with_server_info(Implementation::new("tools-only-server", "1.0.0")) + } + + fn accepted_subscription_filter( + &self, + requested: &SubscriptionFilter, + ) -> Option { + Some(requested.supported_by(&self.get_info().capabilities)) + } + + async fn listen(&self, context: SubscriptionContext) -> Result<(), rmcp::ErrorData> { + context + .sink() + .notify_tool_list_changed() + .await + .expect("accepted tool notification"); + assert!(matches!( + context.sink().notify_prompt_list_changed().await, + Err(SubscriptionSendError::NotificationNotAccepted( + "notifications/prompts/list_changed" + )) + )); + Ok(()) + } +} + +struct ToolsAndPromptsServer; + +impl ServerHandler for ToolsAndPromptsServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::new( + ServerCapabilities::builder() + .enable_tools() + .enable_tool_list_changed() + .enable_prompts() + .enable_prompts_list_changed() + .build(), + ) + } + + fn accepted_subscription_filter( + &self, + requested: &SubscriptionFilter, + ) -> Option { + Some(requested.supported_by(&self.get_info().capabilities)) + } + + async fn listen(&self, context: SubscriptionContext) -> Result<(), rmcp::ErrorData> { + if context.accepted().tools_list_changed == Some(true) { + context + .sink() + .notify_tool_list_changed() + .await + .expect("send tool notification"); + } + if context.accepted().prompts_list_changed == Some(true) { + context + .sink() + .notify_prompt_list_changed() + .await + .expect("send prompt notification"); + } + Ok(()) + } +} + +struct ResourceSubscriptionServer; + +impl ServerHandler for ResourceSubscriptionServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::new( + ServerCapabilities::builder() + .enable_resources() + .enable_resources_subscribe() + .build(), + ) + } + + fn accepted_subscription_filter( + &self, + requested: &SubscriptionFilter, + ) -> Option { + Some(requested.supported_by(&self.get_info().capabilities)) + } + + async fn listen(&self, context: SubscriptionContext) -> Result<(), rmcp::ErrorData> { + context + .sink() + .notify_resource_updated("file:///accepted") + .await + .expect("accepted URI"); + assert!(matches!( + context + .sink() + .notify_resource_updated("file:///not-requested") + .await, + Err(SubscriptionSendError::NotificationNotAccepted( + "notifications/resources/updated" + )) + )); + Ok(()) + } +} + +struct RemoteCancellationServer; + +impl ServerHandler for RemoteCancellationServer { + fn accepted_subscription_filter( + &self, + requested: &SubscriptionFilter, + ) -> Option { + Some(requested.clone()) + } + + async fn listen(&self, context: SubscriptionContext) -> Result<(), rmcp::ErrorData> { + context + .request_context() + .peer + .notify_cancelled(rmcp::model::CancelledNotificationParam::new( + Some(context.sink().id().clone()), + Some("server shutdown".to_owned()), + )) + .await + .expect("send server cancellation"); + std::future::pending().await + } +} + +struct FloodServer; + +impl ServerHandler for FloodServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::new( + ServerCapabilities::builder() + .enable_tools() + .enable_tool_list_changed() + .build(), + ) + } + + fn accepted_subscription_filter( + &self, + requested: &SubscriptionFilter, + ) -> Option { + Some(requested.clone()) + } + + async fn listen(&self, context: SubscriptionContext) -> Result<(), rmcp::ErrorData> { + for _ in 0..10 { + if context.sink().notify_tool_list_changed().await.is_err() { + break; + } + } + context.cancelled().await; + Ok(()) + } +} + +#[derive(Clone)] +struct ClosedSinkServer { + sink: Arc>>, +} + +struct LeakyServer; + +impl ServerHandler for LeakyServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::new( + ServerCapabilities::builder() + .enable_tools() + .enable_tool_list_changed() + .build(), + ) + } + + fn accepted_subscription_filter( + &self, + requested: &SubscriptionFilter, + ) -> Option { + Some(requested.supported_by(&self.get_info().capabilities)) + } + + async fn listen(&self, context: SubscriptionContext) -> Result<(), rmcp::ErrorData> { + let mut notification = + ServerNotification::PromptListChangedNotification(PromptListChangedNotification { + method: Default::default(), + extensions: Default::default(), + }); + notification + .get_meta_mut() + .set_subscription_id(context.sink().id().clone()); + context + .request_context() + .peer + .send_notification(notification) + .await + .expect("send deliberately invalid notification"); + std::future::pending().await + } +} + +struct MalformedAcknowledgmentServer { + cancelled: Arc, +} + +impl rmcp::service::Service for MalformedAcknowledgmentServer { + async fn handle_request( + &self, + request: ClientRequest, + context: RequestContext, + ) -> Result { + match request { + ClientRequest::DiscoverRequest(_) => Ok(ServerResult::DiscoverResult( + DiscoverResult::new( + vec![ProtocolVersion::V_2026_07_28], + ServerCapabilities::builder() + .enable_tools() + .enable_tool_list_changed() + .enable_prompts() + .enable_prompts_list_changed() + .build(), + ) + .with_server_info(Implementation::new("malformed-ack-server", "1.0.0")), + )), + ClientRequest::SubscriptionsListenRequest(_) => { + let mut acknowledgment = SubscriptionsAcknowledgedNotification::new( + SubscriptionsAcknowledgedNotificationParams::new( + SubscriptionFilter::builder().prompts_list_changed().build(), + ), + ); + let mut meta = NotificationMetaObject::new(); + meta.set_subscription_id(context.id.clone()); + acknowledgment.extensions.insert(meta); + context + .peer + .send_notification(ServerNotification::SubscriptionsAcknowledgedNotification( + acknowledgment, + )) + .await + .map_err(|error| rmcp::ErrorData::internal_error(error.to_string(), None))?; + context.ct.cancelled().await; + Ok(ServerResult::SubscriptionsListenResult( + SubscriptionsListenResult::complete(context.id), + )) + } + _ => Err(rmcp::ErrorData::invalid_request( + "unexpected test request", + None, + )), + } + } + + async fn handle_notification( + &self, + notification: ClientNotification, + _context: NotificationContext, + ) -> Result<(), rmcp::ErrorData> { + if matches!(notification, ClientNotification::CancelledNotification(_)) { + self.cancelled.notify_one(); + } + Ok(()) + } + + fn get_info(&self) -> rmcp::model::ServerConfig { + ServerConfig::default() + } +} + +impl ServerHandler for ClosedSinkServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::new( + ServerCapabilities::builder() + .enable_tools() + .enable_tool_list_changed() + .build(), + ) + } + + fn accepted_subscription_filter( + &self, + requested: &SubscriptionFilter, + ) -> Option { + Some(requested.supported_by(&self.get_info().capabilities)) + } + + async fn listen(&self, context: SubscriptionContext) -> Result<(), rmcp::ErrorData> { + self.sink.lock().await.replace(context.sink().clone()); + Ok(()) + } +} + +#[derive(Clone)] +struct CancellationServer { + cancelled: Arc, +} + +impl ServerHandler for CancellationServer { + fn accepted_subscription_filter( + &self, + requested: &SubscriptionFilter, + ) -> Option { + Some(requested.clone()) + } + + async fn listen(&self, context: SubscriptionContext) -> Result<(), rmcp::ErrorData> { + context.cancelled().await; + self.cancelled.notify_one(); + Ok(()) + } +} + +#[derive(Clone)] +struct AbruptServer { + started: Arc, +} + +impl ServerHandler for AbruptServer { + fn accepted_subscription_filter( + &self, + requested: &SubscriptionFilter, + ) -> Option { + Some(requested.clone()) + } + + async fn listen(&self, _context: SubscriptionContext) -> Result<(), rmcp::ErrorData> { + self.started.notify_one(); + std::future::pending().await + } +} + +async fn modern_client( + server: S, +) -> anyhow::Result> { + let (server_transport, client_transport) = tokio::io::duplex(16 * 1024); + tokio::spawn(async move { + let server = server.serve(server_transport).await?; + server.waiting().await?; + anyhow::Ok(()) + }); + ().serve_with_lifecycle( + client_transport, + rmcp::ClientLifecycleMode::Discover { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + }, + ) + .await + .map_err(Into::into) +} + +#[tokio::test] +async fn listen_exposes_acknowledged_filter_and_graceful_result() -> anyhow::Result<()> { + let client = modern_client(ToolsOnlyServer).await?; + let mut subscription = client + .listen( + SubscriptionFilter::builder() + .tools_list_changed() + .prompts_list_changed() + .build(), + ) + .await?; + + assert_eq!( + subscription.acknowledged(), + &SubscriptionFilter::builder().tools_list_changed().build() + ); + + let notification = tokio::time::timeout(Duration::from_secs(5), subscription.next()) + .await?? + .expect("tool notification"); + assert!(matches!( + notification, + ServerNotification::ToolListChangedNotification(_) + )); + assert_eq!( + notification.get_meta().subscription_id(), + Some(subscription.id().clone()) + ); + + assert!( + tokio::time::timeout(Duration::from_secs(5), subscription.next()) + .await?? + .is_none() + ); + let Some(SubscriptionEnd::Graceful(result)) = subscription.end() else { + panic!("expected graceful final result"); + }; + assert_eq!( + result.meta.subscription_id().as_ref(), + Some(subscription.id()) + ); + assert_eq!( + result + .meta + .server_info() + .expect("graceful result should contain valid server info"), + Implementation::new("tools-only-server", "1.0.0") + ); + + client.cancel().await?; + Ok(()) +} + +#[tokio::test] +async fn typed_subscription_notifications_do_not_reach_handler_callbacks() -> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(16 * 1024); + tokio::spawn(async move { + let server = ToolsOnlyServer.serve(server_transport).await?; + server.waiting().await?; + anyhow::Ok(()) + }); + let tool_changes = Arc::new(AtomicUsize::new(0)); + let client = CountingClient { + tool_changes: tool_changes.clone(), + } + .serve_with_lifecycle( + client_transport, + rmcp::ClientLifecycleMode::Discover { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + }, + ) + .await?; + let mut subscription = client + .listen(SubscriptionFilter::builder().tools_list_changed().build()) + .await?; + + assert!(subscription.next().await?.is_some()); + assert!(subscription.next().await?.is_none()); + tokio::task::yield_now().await; + assert_eq!(tool_changes.load(Ordering::Relaxed), 0); + + client.cancel().await?; + Ok(()) +} + +#[tokio::test] +async fn discover_lifecycle_allows_subscriptions_with_older_application_version() +-> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(16 * 1024); + tokio::spawn(async move { + let server = ToolsOnlyServer.serve(server_transport).await?; + server.waiting().await?; + anyhow::Ok(()) + }); + let client = () + .serve_with_lifecycle( + client_transport, + rmcp::ClientLifecycleMode::Discover { + preferred_versions: vec![ProtocolVersion::V_2025_11_25], + }, + ) + .await?; + let mut subscription = client + .listen(SubscriptionFilter::builder().tools_list_changed().build()) + .await?; + + assert!(subscription.next().await?.is_some()); + assert!(subscription.next().await?.is_none()); + + client.cancel().await?; + Ok(()) +} + +#[tokio::test] +async fn concurrent_subscriptions_are_demultiplexed_by_request_id() -> anyhow::Result<()> { + let client = modern_client(ToolsAndPromptsServer).await?; + let (tools, prompts) = tokio::join!( + client.listen(SubscriptionFilter::builder().tools_list_changed().build()), + client.listen(SubscriptionFilter::builder().prompts_list_changed().build()) + ); + let mut tools = tools?; + let mut prompts = prompts?; + + let tool_notification = tools.next().await?.expect("tool notification"); + let prompt_notification = prompts.next().await?.expect("prompt notification"); + assert!(matches!( + tool_notification, + ServerNotification::ToolListChangedNotification(_) + )); + assert!(matches!( + prompt_notification, + ServerNotification::PromptListChangedNotification(_) + )); + assert_ne!(tools.id(), prompts.id()); + + client.cancel().await?; + Ok(()) +} + +#[tokio::test] +async fn stdio_cancellation_sends_cancelled_for_the_listen_request() -> anyhow::Result<()> { + let cancelled = Arc::new(Notify::new()); + let client = modern_client(CancellationServer { + cancelled: cancelled.clone(), + }) + .await?; + let mut subscription = client.listen(SubscriptionFilter::new()).await?; + + subscription.cancel().await?; + assert!(matches!( + subscription.end(), + Some(SubscriptionEnd::Cancelled) + )); + tokio::time::timeout(Duration::from_secs(5), cancelled.notified()).await?; + + client.cancel().await?; + Ok(()) +} + +#[tokio::test] +async fn resource_updates_are_filtered_by_exact_uri_membership() -> anyhow::Result<()> { + let client = modern_client(ResourceSubscriptionServer).await?; + let mut subscription = client + .listen( + SubscriptionFilter::builder() + .resource_subscription("file:///accepted") + .build(), + ) + .await?; + + let notification = subscription.next().await?.expect("resource update"); + let ServerNotification::ResourceUpdatedNotification(update) = notification else { + panic!("expected resource update"); + }; + assert_eq!(update.params.uri, "file:///accepted"); + assert!(subscription.next().await?.is_none()); + + client.cancel().await?; + Ok(()) +} + +#[tokio::test] +async fn stdio_server_cancellation_ends_the_matching_subscription() -> anyhow::Result<()> { + let client = modern_client(RemoteCancellationServer).await?; + let mut subscription = client.listen(SubscriptionFilter::new()).await?; + + assert!(subscription.next().await?.is_none()); + assert!(matches!( + subscription.end(), + Some(SubscriptionEnd::Cancelled) + )); + + client.cancel().await?; + Ok(()) +} + +#[tokio::test] +async fn slow_consumer_reports_subscription_lag() -> anyhow::Result<()> { + let client = modern_client(FloodServer).await?; + let mut subscription = client + .listen_with_capacity( + SubscriptionFilter::builder().tools_list_changed().build(), + NonZeroUsize::MIN, + ) + .await?; + + tokio::time::sleep(Duration::from_millis(50)).await; + while subscription.next().await?.is_some() {} + assert!( + matches!( + subscription.end(), + Some(SubscriptionEnd::Lagged { capacity: 1 }) + ), + "unexpected end: {:?}", + subscription.end() + ); + + client.cancel().await?; + Ok(()) +} + +#[tokio::test] +async fn sink_rejects_notifications_after_graceful_completion() -> anyhow::Result<()> { + let sink = Arc::new(Mutex::new(None)); + let client = modern_client(ClosedSinkServer { sink: sink.clone() }).await?; + let mut subscription = client + .listen(SubscriptionFilter::builder().tools_list_changed().build()) + .await?; + assert!(subscription.next().await?.is_none()); + + let sink = sink.lock().await.clone().expect("captured sink"); + assert!(matches!( + sink.notify_tool_list_changed().await, + Err(SubscriptionSendError::SubscriptionClosed) + )); + + client.cancel().await?; + Ok(()) +} + +#[tokio::test] +async fn client_rejects_notifications_outside_the_acknowledged_filter() -> anyhow::Result<()> { + let client = modern_client(LeakyServer).await?; + let mut subscription = client + .listen(SubscriptionFilter::builder().tools_list_changed().build()) + .await?; + + assert!(matches!( + subscription.next().await, + Err(rmcp::ServiceError::UnexpectedResponse) + )); + assert!(matches!(subscription.end(), Some(SubscriptionEnd::Abrupt))); + + client.cancel().await?; + Ok(()) +} + +#[tokio::test] +async fn malformed_acknowledgment_cancels_pending_listen_request() -> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(16 * 1024); + let cancelled = Arc::new(Notify::new()); + let server_cancelled = cancelled.clone(); + tokio::spawn(async move { + let server = MalformedAcknowledgmentServer { + cancelled: server_cancelled, + } + .serve(server_transport) + .await?; + server.waiting().await?; + anyhow::Ok(()) + }); + let client = () + .serve_with_lifecycle( + client_transport, + rmcp::ClientLifecycleMode::Discover { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + }, + ) + .await?; + + assert!(matches!( + client + .listen(SubscriptionFilter::builder().tools_list_changed().build()) + .await, + Err(rmcp::ServiceError::UnexpectedResponse) + )); + tokio::time::timeout(Duration::from_secs(5), cancelled.notified()).await?; + + client.cancel().await?; + Ok(()) +} + +#[tokio::test] +async fn transport_close_without_final_result_is_abrupt() -> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(16 * 1024); + let started = Arc::new(Notify::new()); + let server_started = started.clone(); + tokio::spawn(async move { + let server = AbruptServer { + started: server_started.clone(), + } + .serve(server_transport) + .await?; + server_started.notified().await; + server.cancel().await?; + anyhow::Ok(()) + }); + let client = () + .serve_with_lifecycle( + client_transport, + rmcp::ClientLifecycleMode::Discover { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + }, + ) + .await?; + let mut subscription = client.listen(SubscriptionFilter::new()).await?; + + assert!( + tokio::time::timeout(Duration::from_secs(5), subscription.next()) + .await?? + .is_none() + ); + assert!(matches!(subscription.end(), Some(SubscriptionEnd::Abrupt))); + Ok(()) +} diff --git a/vendor/rmcp/tests/test_subscriptions_model.rs b/vendor/rmcp/tests/test_subscriptions_model.rs new file mode 100644 index 00000000..8d79fb11 --- /dev/null +++ b/vendor/rmcp/tests/test_subscriptions_model.rs @@ -0,0 +1,254 @@ +use rmcp::model::{ + ClientJsonRpcMessage, ClientRequest, GetMeta, Implementation, JsonRpcNotification, + JsonRpcRequest, NotificationMetaObject, RequestId, RequestMetaObject, ServerJsonRpcMessage, + ServerNotification, SubscriptionFilter, SubscriptionsAcknowledgedNotification, + SubscriptionsAcknowledgedNotificationParams, SubscriptionsListenRequest, + SubscriptionsListenRequestParams, SubscriptionsListenResult, SubscriptionsListenResultMeta, +}; +use serde_json::json; + +#[test] +fn subscription_filter_serializes_only_opted_in_notifications() { + let filter = SubscriptionFilter::builder() + .tools_list_changed() + .resource_subscription("file:///one") + .resource_subscription("file:///two") + .build(); + + assert_eq!( + serde_json::to_value(filter).expect("serialize filter"), + json!({ + "toolsListChanged": true, + "resourceSubscriptions": ["file:///one", "file:///two"], + }) + ); +} + +#[test] +fn subscription_filter_subset_is_order_independent_and_ignores_false_flags() { + let requested = SubscriptionFilter::builder() + .tools_list_changed() + .resource_subscriptions(["file:///one", "file:///two"]) + .build(); + let mut accepted = SubscriptionFilter::builder() + .resource_subscriptions(["file:///two", "file:///one"]) + .build(); + accepted.tools_list_changed = Some(false); + + assert!(accepted.is_subset_of(&requested)); +} + +#[test] +fn subscription_filter_omits_empty_resource_intersection() { + let requested = SubscriptionFilter::builder() + .resource_subscription("file:///requested") + .build(); + let accepted = SubscriptionFilter::builder() + .resource_subscription("file:///different") + .build(); + + assert_eq!( + serde_json::to_value(requested.intersection(&accepted)).expect("serialize intersection"), + json!({}) + ); +} + +#[test] +fn listen_request_round_trips_required_fields_and_arbitrary_metadata() { + let mut request = SubscriptionsListenRequest::new(SubscriptionsListenRequestParams::new( + SubscriptionFilter::builder().prompts_list_changed().build(), + )); + let mut meta = RequestMetaObject::new(); + meta.insert("com.example/request".into(), json!("value")); + request.extensions.insert(meta); + let message = ClientJsonRpcMessage::request( + ClientRequest::SubscriptionsListenRequest(request), + RequestId::String("subscription-1".into()), + ); + + let value = serde_json::to_value(&message).expect("serialize listen request"); + assert_eq!( + value, + json!({ + "jsonrpc": "2.0", + "id": "subscription-1", + "method": "subscriptions/listen", + "params": { + "_meta": { + "com.example/request": "value", + }, + "notifications": { + "promptsListChanged": true, + }, + }, + }) + ); + + let round_trip: ClientJsonRpcMessage = + serde_json::from_value(value).expect("deserialize listen request"); + let ClientJsonRpcMessage::Request(JsonRpcRequest { request, .. }) = round_trip else { + panic!("expected request"); + }; + let ClientRequest::SubscriptionsListenRequest(request) = request else { + panic!("expected subscriptions/listen request"); + }; + assert_eq!( + request + .extensions + .get::() + .and_then(|meta| meta.get("com.example/request")), + Some(&json!("value")) + ); +} + +#[test] +fn acknowledged_notification_round_trips_numeric_subscription_id_and_metadata() { + let mut notification = SubscriptionsAcknowledgedNotification::new( + SubscriptionsAcknowledgedNotificationParams::new( + SubscriptionFilter::builder() + .resources_list_changed() + .build(), + ), + ); + let mut meta = NotificationMetaObject::new(); + meta.set_subscription_id(RequestId::Number(7)); + meta.insert("com.example/notification".into(), json!(true)); + notification.extensions.insert(meta); + let message = ServerJsonRpcMessage::notification( + ServerNotification::SubscriptionsAcknowledgedNotification(notification), + ); + + let value = serde_json::to_value(&message).expect("serialize acknowledgment"); + assert_eq!( + value, + json!({ + "jsonrpc": "2.0", + "method": "notifications/subscriptions/acknowledged", + "params": { + "_meta": { + "io.modelcontextprotocol/subscriptionId": 7, + "com.example/notification": true, + }, + "notifications": { + "resourcesListChanged": true, + }, + }, + }) + ); + + let round_trip: ServerJsonRpcMessage = + serde_json::from_value(value).expect("deserialize acknowledgment"); + let ServerJsonRpcMessage::Notification(JsonRpcNotification { notification, .. }) = round_trip + else { + panic!("expected notification"); + }; + assert_eq!( + notification.get_meta().subscription_id(), + Some(RequestId::Number(7)) + ); + assert_eq!( + notification.get_meta().get("com.example/notification"), + Some(&json!(true)) + ); +} + +#[test] +fn listen_result_requires_matching_string_subscription_id_and_preserves_metadata() { + let mut meta = SubscriptionsListenResultMeta::new(RequestId::String("subscription-2".into())); + meta.set_server_info(Implementation::new("test-server", "1.0.0")); + meta.insert("com.example/result".into(), json!({ "reason": "shutdown" })); + let result = SubscriptionsListenResult::new(meta); + + let value = serde_json::to_value(&result).expect("serialize listen result"); + assert_eq!( + value, + json!({ + "resultType": "complete", + "_meta": { + "io.modelcontextprotocol/subscriptionId": "subscription-2", + "io.modelcontextprotocol/serverInfo": { + "name": "test-server", + "version": "1.0.0", + }, + "com.example/result": { + "reason": "shutdown", + }, + }, + }) + ); + + let round_trip: SubscriptionsListenResult = + serde_json::from_value(value).expect("deserialize listen result"); + assert_eq!( + round_trip.meta.subscription_id(), + Some(RequestId::String("subscription-2".into())) + ); + assert_eq!( + round_trip.meta.server_info(), + Some(Implementation::new("test-server", "1.0.0")) + ); + assert_eq!( + round_trip.meta.get("com.example/result"), + Some(&json!({ "reason": "shutdown" })) + ); +} + +#[test] +fn listen_result_meta_returns_none_after_required_id_is_removed() { + let mut meta = SubscriptionsListenResultMeta::new(RequestId::Number(1)); + meta.remove("io.modelcontextprotocol/subscriptionId"); + + assert_eq!(meta.subscription_id(), None); +} + +#[cfg(feature = "schemars")] +#[test] +fn subscription_schemas_mark_only_draft_required_fields_as_required() { + let request_schema = + serde_json::to_value(schemars::schema_for!(SubscriptionsListenRequestParams)) + .expect("request schema"); + let filter_schema = + serde_json::to_value(schemars::schema_for!(SubscriptionFilter)).expect("filter schema"); + let acknowledgment_schema = serde_json::to_value(schemars::schema_for!( + SubscriptionsAcknowledgedNotificationParams + )) + .expect("acknowledgment schema"); + let result_schema = serde_json::to_value(schemars::schema_for!(SubscriptionsListenResult)) + .expect("result schema"); + + assert_eq!( + request_schema["required"], + json!(["_meta", "notifications"]) + ); + assert_eq!( + request_schema["properties"]["_meta"]["required"], + json!([ + "io.modelcontextprotocol/protocolVersion", + "io.modelcontextprotocol/clientCapabilities" + ]) + ); + assert!(filter_schema.get("required").is_none()); + assert_eq!( + filter_schema["properties"]["toolsListChanged"]["type"], + "boolean" + ); + assert_eq!( + filter_schema["properties"]["resourceSubscriptions"]["type"], + "array" + ); + assert_eq!(acknowledgment_schema["required"], json!(["notifications"])); + assert_eq!( + acknowledgment_schema["properties"]["_meta"]["$ref"], + "#/$defs/NotificationMetaObject" + ); + let result_meta_schema = &result_schema["$defs"]["SubscriptionsListenResultMeta"]; + assert_eq!( + result_meta_schema["properties"]["io.modelcontextprotocol/serverInfo"]["allOf"][0]["$ref"], + "#/$defs/Implementation" + ); + assert_eq!( + result_meta_schema["required"], + json!(["io.modelcontextprotocol/subscriptionId"]) + ); + assert_eq!(result_schema["required"], json!(["resultType", "_meta"])); +} diff --git a/vendor/rmcp/tests/test_subscriptions_streamable_http.rs b/vendor/rmcp/tests/test_subscriptions_streamable_http.rs new file mode 100644 index 00000000..70f102f4 --- /dev/null +++ b/vendor/rmcp/tests/test_subscriptions_streamable_http.rs @@ -0,0 +1,318 @@ +#![cfg(all( + not(feature = "local"), + feature = "client", + feature = "server", + feature = "transport-streamable-http-client-reqwest", + feature = "transport-streamable-http-server" +))] + +use std::{ + borrow::Cow, + sync::{ + Arc, + atomic::{AtomicUsize, Ordering}, + }, + time::Duration, +}; + +use rmcp::{ + ClientLifecycleMode, ClientServiceExt, ServerHandler, + model::{ + ClientConfig, ClientRequest, Implementation, ListToolsRequest, ProtocolVersion, + RequestMetaObject, ServerCapabilities, ServerConfig, ServerNotification, + SubscriptionFilter, + }, + service::{PeerRequestOptions, SubscriptionContext, SubscriptionEnd}, + transport::{ + StreamableHttpClientTransport, + streamable_http_client::StreamableHttpClientTransportConfig, + streamable_http_server::{ + StreamableHttpServerConfig, StreamableHttpService, session::local::LocalSessionManager, + }, + }, +}; +use tokio::sync::Notify; +use tokio_util::sync::CancellationToken; + +#[derive(Clone)] +struct HttpSubscriptionServer { + cancelled: Arc, + started: Arc, + ending: ServerEnding, +} + +#[derive(Clone, Copy)] +enum ServerEnding { + ClientCancellation, + Graceful, + Abrupt, +} + +impl ServerHandler for HttpSubscriptionServer { + fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]> { + Cow::Borrowed(&[ProtocolVersion::V_2026_07_28, ProtocolVersion::V_2025_11_25]) + } + + fn get_info(&self) -> ServerConfig { + ServerConfig::new( + ServerCapabilities::builder() + .enable_tools() + .enable_tool_list_changed() + .build(), + ) + .with_server_info(Implementation::new("http-subscription-server", "1.0.0")) + } + + fn accepted_subscription_filter( + &self, + requested: &SubscriptionFilter, + ) -> Option { + Some(requested.supported_by(&self.get_info().capabilities)) + } + + async fn listen(&self, context: SubscriptionContext) -> Result<(), rmcp::ErrorData> { + context + .sink() + .notify_tool_list_changed() + .await + .expect("send tool notification"); + self.started.notify_one(); + match self.ending { + ServerEnding::Graceful => Ok(()), + ServerEnding::ClientCancellation => { + context.cancelled().await; + self.cancelled.notify_one(); + Ok(()) + } + ServerEnding::Abrupt => std::future::pending().await, + } + } +} + +async fn spawn_server( + ending: ServerEnding, +) -> ( + String, + CancellationToken, + Arc, + Arc, + Arc, +) { + let cancellation_token = CancellationToken::new(); + let subscription_cancelled = Arc::new(Notify::new()); + let subscription_started = Arc::new(Notify::new()); + let server = HttpSubscriptionServer { + cancelled: subscription_cancelled.clone(), + started: subscription_started.clone(), + ending, + }; + let service: StreamableHttpService = + StreamableHttpService::new( + move || Ok(server.clone()), + Default::default(), + StreamableHttpServerConfig::default() + .with_legacy_session_mode(true) + .with_json_response(true) + .with_sse_keep_alive(Some(Duration::from_millis(50))) + .with_cancellation_token(cancellation_token.child_token()), + ); + let get_requests = Arc::new(AtomicUsize::new(0)); + let observed_get_requests = get_requests.clone(); + let router = + axum::Router::new() + .nest_service("/mcp", service) + .layer(axum::middleware::from_fn( + move |request: axum::extract::Request, next: axum::middleware::Next| { + let observed_get_requests = observed_get_requests.clone(); + async move { + if request.method() == axum::http::Method::GET { + observed_get_requests.fetch_add(1, Ordering::Relaxed); + } + next.run(request).await + } + }, + )); + let listener = tokio::net::TcpListener::bind("127.0.0.1:0") + .await + .expect("listener"); + let address = listener.local_addr().expect("listener address"); + tokio::spawn({ + let cancellation_token = cancellation_token.clone(); + async move { + let _ = axum::serve(listener, router) + .with_graceful_shutdown(async move { cancellation_token.cancelled_owned().await }) + .await; + } + }); + ( + format!("http://{address}/mcp"), + cancellation_token, + subscription_cancelled, + subscription_started, + get_requests, + ) +} + +#[tokio::test] +async fn modern_http_listen_uses_post_stream_and_cancels_by_closing_it() -> anyhow::Result<()> { + let (url, server_ct, subscription_cancelled, _, get_requests) = + spawn_server(ServerEnding::ClientCancellation).await; + let transport = StreamableHttpClientTransport::from_config( + StreamableHttpClientTransportConfig::with_uri(url.clone()), + ); + let client = ClientConfig::default() + .serve_with_lifecycle( + transport, + ClientLifecycleMode::Discover { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + }, + ) + .await?; + assert_eq!(get_requests.load(Ordering::Relaxed), 0); + let mut subscription = client + .listen(SubscriptionFilter::builder().tools_list_changed().build()) + .await?; + + assert!(matches!( + subscription.next().await?.expect("tool notification"), + ServerNotification::ToolListChangedNotification(_) + )); + let mut older_version = RequestMetaObject::new(); + older_version.set_protocol_version(ProtocolVersion::V_2025_11_25); + client + .send_request_with_option( + ClientRequest::ListToolsRequest(ListToolsRequest { + method: Default::default(), + params: None, + extensions: Default::default(), + }), + PeerRequestOptions::no_options().with_meta(older_version), + ) + .await? + .await_response() + .await?; + subscription.cancel().await?; + tokio::time::timeout(Duration::from_secs(5), subscription_cancelled.notified()).await?; + + client.cancel().await?; + server_ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn modern_http_graceful_close_returns_final_listen_result() -> anyhow::Result<()> { + let (url, server_ct, _, _, _) = spawn_server(ServerEnding::Graceful).await; + let transport = StreamableHttpClientTransport::from_config( + StreamableHttpClientTransportConfig::with_uri(url), + ); + let client = ClientConfig::default() + .serve_with_lifecycle( + transport, + ClientLifecycleMode::Discover { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + }, + ) + .await?; + let mut subscription = client + .listen(SubscriptionFilter::builder().tools_list_changed().build()) + .await?; + + assert!(subscription.next().await?.is_some()); + assert!(subscription.next().await?.is_none()); + let Some(SubscriptionEnd::Graceful(result)) = subscription.end() else { + panic!("expected graceful final result"); + }; + assert_eq!( + result + .meta + .server_info() + .expect("graceful result should contain valid server info"), + Implementation::new("http-subscription-server", "1.0.0") + ); + + client.cancel().await?; + server_ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn modern_http_stream_close_without_result_is_abrupt() -> anyhow::Result<()> { + let (url, server_ct, _, subscription_started, _) = spawn_server(ServerEnding::Abrupt).await; + let transport = StreamableHttpClientTransport::from_config( + StreamableHttpClientTransportConfig::with_uri(url), + ); + let client = ClientConfig::default() + .serve_with_lifecycle( + transport, + ClientLifecycleMode::Discover { + preferred_versions: vec![ProtocolVersion::V_2026_07_28], + }, + ) + .await?; + let mut subscription = client + .listen(SubscriptionFilter::builder().tools_list_changed().build()) + .await?; + assert!(subscription.next().await?.is_some()); + subscription_started.notified().await; + + server_ct.cancel(); + assert!( + tokio::time::timeout(Duration::from_secs(5), subscription.next()) + .await?? + .is_none() + ); + assert!(matches!(subscription.end(), Some(SubscriptionEnd::Abrupt))); + + client.cancel().await?; + Ok(()) +} + +#[tokio::test] +async fn modern_http_lifecycle_stays_sessionless_for_older_application_version() +-> anyhow::Result<()> { + let (url, server_ct, _, _, get_requests) = spawn_server(ServerEnding::ClientCancellation).await; + let transport = StreamableHttpClientTransport::from_config( + StreamableHttpClientTransportConfig::with_uri(url), + ); + let client = ClientConfig::default() + .serve_with_lifecycle( + transport, + ClientLifecycleMode::Discover { + preferred_versions: vec![ProtocolVersion::V_2025_11_25], + }, + ) + .await?; + + client.list_tools(None).await?; + assert_eq!(get_requests.load(Ordering::Relaxed), 0); + + client.cancel().await?; + server_ct.cancel(); + Ok(()) +} + +#[tokio::test] +async fn modern_http_get_and_delete_are_method_not_allowed_in_legacy_session_mode() { + let (url, server_ct, _, _, _) = spawn_server(ServerEnding::ClientCancellation).await; + let client = reqwest::Client::new(); + + for method in [reqwest::Method::GET, reqwest::Method::DELETE] { + let response = client + .request(method, &url) + .header("Accept", "text/event-stream") + .header("MCP-Protocol-Version", "2026-07-28") + .send() + .await + .expect("request"); + assert_eq!(response.status(), reqwest::StatusCode::METHOD_NOT_ALLOWED); + assert_eq!( + response + .headers() + .get(reqwest::header::ALLOW) + .and_then(|value| value.to_str().ok()), + Some("POST") + ); + } + + server_ct.cancel(); +} diff --git a/vendor/rmcp/tests/test_task.rs b/vendor/rmcp/tests/test_task.rs new file mode 100644 index 00000000..0178bab9 --- /dev/null +++ b/vendor/rmcp/tests/test_task.rs @@ -0,0 +1,442 @@ +//! End-to-end tests for the MCP Tasks extension (SEP-2663, +//! `io.modelcontextprotocol/tasks`). +#![cfg(all(feature = "server", feature = "client", not(feature = "local")))] + +use rmcp::{ + ErrorData as McpError, ServerHandler, ServiceExt, + handler::server::{router::tool::ToolRouter, wrapper::Parameters}, + model::*, + service::{RequestContext, RoleServer}, + task_manager::{TaskExit, TaskManager, TaskOptions}, + tool, tool_router, +}; +use serde_json::json; + +#[derive(Debug, serde::Deserialize, rmcp::schemars::JsonSchema)] +struct SumArgs { + a: i32, + b: i32, +} + +#[derive(Clone)] +struct TaskServer { + tool_router: ToolRouter, + tasks: TaskManager, +} + +#[tool_router] +impl TaskServer { + fn new() -> Self { + Self { + tool_router: Self::tool_router(), + tasks: TaskManager::new(), + } + } + + #[tool(description = "Sum two numbers")] + async fn sum( + &self, + Parameters(SumArgs { a, b }): Parameters, + ) -> Result { + Ok(CallToolResult::success(vec![ContentBlock::text( + (a + b).to_string(), + )])) + } +} + +impl ServerHandler for TaskServer { + async fn call_tool( + &self, + request: CallToolRequestParams, + context: RequestContext, + ) -> Result { + let client_supports_tasks = context + .client_capabilities() + .is_some_and(|caps| caps.supports_tasks()); + + if request.name == "sum" && client_supports_tasks { + let args: SumArgs = serde_json::from_value(serde_json::Value::Object( + request.arguments.clone().unwrap_or_default(), + )) + .map_err(|e| McpError::invalid_params(e.to_string(), None))?; + let task = self + .tasks + .spawn(TaskOptions::new().with_poll_interval_ms(10), move |ctx| { + Box::pin(async move { + tokio::select! { + _ = ctx.cancelled() => { + Err(TaskExit::Cancelled) + } + _ = tokio::time::sleep(std::time::Duration::from_millis(50)) => { + Ok(CallToolResult::success(vec![ContentBlock::text( + (args.a + args.b).to_string(), + )])) + } + } + }) + }); + return Ok(CallToolResponse::Task(CreateTaskResult::new(task))); + } + + let tcc = rmcp::handler::server::tool::ToolCallContext::new(self, request, context); + self.tool_router.call(tcc).await + } + + async fn get_task( + &self, + request: GetTaskParams, + _context: RequestContext, + ) -> Result { + Ok(GetTaskResult::new(self.tasks.get_task(&request.task_id)?)) + } + + async fn update_task( + &self, + request: UpdateTaskParams, + _context: RequestContext, + ) -> Result<(), McpError> { + self.tasks + .update_task(&request.task_id, request.input_responses) + } + + async fn cancel_task( + &self, + request: CancelTaskParams, + _context: RequestContext, + ) -> Result<(), McpError> { + self.tasks.cancel_task(&request.task_id) + } + + fn get_info(&self) -> ServerConfig { + ServerConfig::new( + ServerCapabilities::builder() + .enable_tools() + .enable_tasks() + .build(), + ) + } +} + +fn tasks_client_info() -> ClientConfig { + ClientConfig::new( + ClientCapabilities::builder().enable_tasks().build(), + Implementation::from_build_env(), + ) +} + +#[tokio::test] +async fn task_lifecycle_create_poll_complete() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let server = tokio::spawn(async move { + let service = TaskServer::new().serve(server_transport).await?; + service.waiting().await?; + anyhow::Ok(()) + }); + + let client = tasks_client_info().serve(client_transport).await.unwrap(); + + // Server materializes a task because we declared the extension. + let response = client + .call_tool_once( + CallToolRequestParams::new("sum") + .with_arguments(serde_json::from_value(json!({"a": 40, "b": 2})).unwrap()), + ) + .await + .unwrap(); + let create = match response { + CallToolResponse::Task(create) => create, + other => panic!("expected CreateTaskResult, got {other:?}"), + }; + assert_eq!(create.result_type, ResultType::TASK); + let task_id = create.task.task_id.clone(); + + // Poll until terminal. + let final_task = loop { + tokio::time::sleep(std::time::Duration::from_millis( + create.task.poll_interval_ms.unwrap_or(10), + )) + .await; + let info = client + .peer() + .get_task(GetTaskParams::new(task_id.clone())) + .await + .unwrap(); + if info.task.status().is_terminal() { + break info.task; + } + }; + + match final_task.payload { + TaskPayload::Completed { result } => { + let result: CallToolResult = + serde_json::from_value(serde_json::Value::Object(result)).unwrap(); + let text = result.content[0].as_text().unwrap(); + assert_eq!(text.text, "42"); + } + other => panic!("expected completed task, got {other:?}"), + } + + client.cancel().await.unwrap(); + server.abort(); +} + +#[tokio::test] +async fn task_cancel_acknowledged() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let server = tokio::spawn(async move { + let service = TaskServer::new().serve(server_transport).await?; + service.waiting().await?; + anyhow::Ok(()) + }); + + let client = tasks_client_info().serve(client_transport).await.unwrap(); + + let response = client + .call_tool_once( + CallToolRequestParams::new("sum") + .with_arguments(serde_json::from_value(json!({"a": 1, "b": 1})).unwrap()), + ) + .await + .unwrap(); + let create = match response { + CallToolResponse::Task(create) => create, + other => panic!("expected CreateTaskResult, got {other:?}"), + }; + + client + .peer() + .cancel_task(CancelTaskParams::new(create.task.task_id.clone())) + .await + .unwrap(); + + // Cancellation is cooperative (SEP-2663): the ack is immediate, and the + // operation settles the terminal status; poll until it does. + let mut final_status = None; + for _ in 0..100 { + tokio::time::sleep(std::time::Duration::from_millis(10)).await; + let info = client + .peer() + .get_task(GetTaskParams::new(create.task.task_id.clone())) + .await + .unwrap(); + if info.task.status().is_terminal() { + final_status = Some(info.task.status()); + break; + } + } + assert_eq!(final_status, Some(TaskStatus::Cancelled)); + + client.cancel().await.unwrap(); + server.abort(); +} + +#[tokio::test] +async fn no_task_without_extension_capability() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let server = tokio::spawn(async move { + let service = TaskServer::new().serve(server_transport).await?; + service.waiting().await?; + anyhow::Ok(()) + }); + + // Plain client: no tasks extension declared. + let client = ().serve(client_transport).await.unwrap(); + let result = client + .call_tool( + CallToolRequestParams::new("sum") + .with_arguments(serde_json::from_value(json!({"a": 2, "b": 3})).unwrap()), + ) + .await + .unwrap(); + let text = result.content[0].as_text().unwrap(); + assert_eq!(text.text, "5"); + + client.cancel().await.unwrap(); + server.abort(); +} + +/// A misbehaving handler that materializes a task without checking the +/// client's capabilities. The SDK dispatch must catch this and reject with +/// -32021 rather than sending a task handle the client cannot parse. +#[derive(Clone)] +struct AlwaysTaskServer { + tasks: TaskManager, +} + +impl ServerHandler for AlwaysTaskServer { + async fn call_tool( + &self, + _request: CallToolRequestParams, + _context: RequestContext, + ) -> Result { + let task = self.tasks.spawn(TaskOptions::default(), |_ctx| { + Box::pin(async { Ok(CallToolResult::success(vec![ContentBlock::text("late")])) }) + }); + Ok(CallToolResponse::Task(CreateTaskResult::new(task))) + } + + fn get_info(&self) -> ServerConfig { + ServerConfig::new( + ServerCapabilities::builder() + .enable_tools() + .enable_tasks() + .build(), + ) + } +} + +#[tokio::test] +async fn dispatch_rejects_task_result_for_non_declaring_client() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let server = tokio::spawn(async move { + let service = AlwaysTaskServer { + tasks: TaskManager::new(), + } + .serve(server_transport) + .await?; + service.waiting().await?; + anyhow::Ok(()) + }); + + // Plain client: no tasks extension declared. The handler tries to return + // a CreateTaskResult anyway; dispatch must reject with -32021. + let client = ().serve(client_transport).await.unwrap(); + let err = client + .call_tool(CallToolRequestParams::new("anything")) + .await + .unwrap_err(); + match err { + rmcp::ServiceError::McpError(e) => { + assert_eq!(e.code, ErrorCode::MISSING_REQUIRED_CLIENT_CAPABILITY); + } + other => panic!("expected McpError, got {other:?}"), + } + + client.cancel().await.unwrap(); + server.abort(); +} + +#[tokio::test] +async fn tasks_methods_without_capability_return_missing_capability_error() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let server = tokio::spawn(async move { + let service = TaskServer::new().serve(server_transport).await?; + service.waiting().await?; + anyhow::Ok(()) + }); + + // Plain client: no tasks extension declared. tasks/* must be rejected + // with -32021 Missing Required Client Capability (SEP-2663), not -32601. + let client = ().serve(client_transport).await.unwrap(); + let err = client + .peer() + .get_task(GetTaskParams::new("whatever")) + .await + .unwrap_err(); + match err { + rmcp::ServiceError::McpError(e) => { + assert_eq!(e.code, ErrorCode::MISSING_REQUIRED_CLIENT_CAPABILITY); + let data = e.data.expect("error data should be present"); + assert!( + data["requiredCapabilities"]["extensions"] + .as_object() + .is_some_and(|ext| ext.contains_key("io.modelcontextprotocol/tasks")), + "error data should name the tasks extension: {data}" + ); + } + other => panic!("expected McpError, got {other:?}"), + } + + let err = client + .peer() + .cancel_task(CancelTaskParams::new("whatever")) + .await + .unwrap_err(); + match err { + rmcp::ServiceError::McpError(e) => { + assert_eq!(e.code, ErrorCode::MISSING_REQUIRED_CLIENT_CAPABILITY); + } + other => panic!("expected McpError, got {other:?}"), + } + + client.cancel().await.unwrap(); + server.abort(); +} + +#[tokio::test] +async fn unknown_task_id_returns_invalid_params() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let server = tokio::spawn(async move { + let service = TaskServer::new().serve(server_transport).await?; + service.waiting().await?; + anyhow::Ok(()) + }); + + let client = tasks_client_info().serve(client_transport).await.unwrap(); + let err = client + .peer() + .get_task(GetTaskParams::new("no-such-task")) + .await + .unwrap_err(); + match err { + rmcp::ServiceError::McpError(e) => { + // SEP-2663: unknown taskId is -32602 Invalid params. + assert_eq!(e.code, ErrorCode::INVALID_PARAMS); + } + other => panic!("expected McpError, got {other:?}"), + } + + client.cancel().await.unwrap(); + server.abort(); +} + +#[tokio::test] +async fn legacy_task_param_is_ignored() { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let server = tokio::spawn(async move { + let service = TaskServer::new().serve(server_transport).await?; + service.waiting().await?; + anyhow::Ok(()) + }); + + // Plain client sending a legacy 2025-11-25 `task: {...}` param: it must + // be silently ignored and the call answered synchronously (SEP-2663). + let client = ().serve(client_transport).await.unwrap(); + let params: CallToolRequestParams = serde_json::from_value(json!({ + "name": "sum", + "arguments": {"a": 2, "b": 3}, + "task": {"ttl": 60000} + })) + .expect("legacy task param must not break deserialization"); + let result = client.call_tool(params).await.unwrap(); + let text = result.content[0].as_text().unwrap(); + assert_eq!(text.text, "5"); + + client.cancel().await.unwrap(); + server.abort(); +} + +#[test] +fn task_status_notification_params_preserve_meta() { + let raw = json!({ + "_meta": { + "traceId": "trace-1" + }, + "taskId": "task-1", + "status": "working", + "createdAt": "2026-06-24T00:00:00Z", + "lastUpdatedAt": "2026-06-24T00:00:01Z", + "ttlMs": null + }); + + let params: TaskStatusNotificationParams = serde_json::from_value(raw).unwrap(); + + assert_eq!(params.task.task.task_id, "task-1"); + assert_eq!(params.status(), TaskStatus::Working); + assert_eq!(params.meta.as_ref().unwrap().0["traceId"], json!("trace-1")); + + let serialized = serde_json::to_value(¶ms).unwrap(); + assert_eq!(serialized["_meta"]["traceId"], json!("trace-1")); + assert_eq!(serialized["taskId"], json!("task-1")); + assert_eq!(serialized["ttlMs"], serde_json::Value::Null); +} diff --git a/vendor/rmcp/tests/test_tool_builder_methods.rs b/vendor/rmcp/tests/test_tool_builder_methods.rs new file mode 100644 index 00000000..cdb1473f --- /dev/null +++ b/vendor/rmcp/tests/test_tool_builder_methods.rs @@ -0,0 +1,105 @@ +#![allow(clippy::exhaustive_structs)] +//cargo test --test test_tool_builder_methods --features "client server macros" +use rmcp::model::{JsonObject, Tool}; +use schemars::JsonSchema; +use serde::{Deserialize, Serialize}; + +#[derive(Serialize, Deserialize, JsonSchema)] +pub struct InputData { + pub name: String, + pub age: u32, +} + +#[derive(Serialize, Deserialize, JsonSchema)] +pub struct OutputData { + pub greeting: String, + pub is_adult: bool, +} + +#[test] +fn test_with_output_schema() { + let tool = Tool::new("test", "Test tool", JsonObject::new()).with_output_schema::(); + + assert!(tool.output_schema.is_some()); + + let schema = tool.output_schema.as_ref().unwrap(); + assert_eq!(schema.get("type"), Some(&serde_json::json!("object"))); +} + +#[test] +fn test_with_input_schema() { + let tool = Tool::new("test", "Test tool", JsonObject::new()).with_input_schema::(); + + // Verify the schema contains expected fields + let schema_str = serde_json::to_string(&tool.input_schema).unwrap(); + assert!(schema_str.contains("name")); + assert!(schema_str.contains("age")); +} + +#[test] +fn test_chained_builder_methods() { + let tool = Tool::new("test", "Test tool", JsonObject::new()) + .with_input_schema::() + .with_output_schema::() + .annotate(rmcp::model::ToolAnnotations::new().read_only(true)); + + assert!(tool.output_schema.is_some()); + assert!(tool.annotations.is_some()); + assert_eq!( + tool.annotations.as_ref().unwrap().read_only_hint, + Some(true) + ); + + // Verify both schemas are set correctly + let input_schema_str = serde_json::to_string(&tool.input_schema).unwrap(); + assert!(input_schema_str.contains("name")); + assert!(input_schema_str.contains("age")); + + let output_schema = tool.output_schema.as_ref().unwrap(); + assert_eq!( + output_schema.get("type"), + Some(&serde_json::json!("object")) + ); +} + +#[test] +fn test_with_output_schema_primitive() { + let tool = Tool::new("test", "Test tool", JsonObject::new()).with_output_schema::(); + + assert!(tool.output_schema.is_some()); + + let schema = tool.output_schema.as_ref().unwrap(); + assert_eq!(schema.get("type"), Some(&serde_json::json!("integer"))); + // title should be stripped from output schema + assert!(schema.get("title").is_none()); +} + +#[test] +fn test_with_output_schema_array() { + let tool = + Tool::new("test", "Test tool", JsonObject::new()).with_output_schema::>(); + + assert!(tool.output_schema.is_some()); + + let schema_str = serde_json::to_string(tool.output_schema.as_ref().unwrap()).unwrap(); + assert!(schema_str.contains("\"type\":\"array\"")); + assert!(schema_str.contains("items")); + // title should be stripped from output schema + assert!(!schema_str.contains("title")); +} + +#[test] +fn test_with_output_schema_option() { + let tool = + Tool::new("test", "Test tool", JsonObject::new()).with_output_schema::>(); + + assert!(tool.output_schema.is_some()); + + let schema_str = serde_json::to_string(tool.output_schema.as_ref().unwrap()).unwrap(); + // Option generates a composition schema (anyOf/oneOf/type array with null) + assert!( + schema_str.contains("anyOf") || schema_str.contains("oneOf") || schema_str.contains("null"), + "Expected composition schema for Option, got: {schema_str}" + ); + assert!(!schema_str.contains("title")); +} diff --git a/vendor/rmcp/tests/test_tool_disable_notification.rs b/vendor/rmcp/tests/test_tool_disable_notification.rs new file mode 100644 index 00000000..14a8757b --- /dev/null +++ b/vendor/rmcp/tests/test_tool_disable_notification.rs @@ -0,0 +1,165 @@ +//! Integration tests for tool list change notifications. +#![cfg(all(feature = "client", not(feature = "local")))] + +use std::sync::{ + Arc, + atomic::{AtomicUsize, Ordering}, +}; + +use rmcp::{ + ClientHandler, RoleClient, RoleServer, ServerHandler, ServiceExt, + handler::server::{router::tool::ToolRoute, tool::ToolCallContext}, + model::{CallToolResponse, CallToolResult, ServerCapabilities, ServerConfig, Tool}, + service::{MaybeSendFuture, NotificationContext}, +}; +use tokio::sync::{Notify, RwLock}; + +#[derive(Clone)] +struct TestToolServer { + router: Arc>>, + trigger_disable: Arc, + trigger_enable: Arc, +} + +impl TestToolServer { + fn new() -> Self { + let mut tool_router = rmcp::handler::server::router::tool::ToolRouter::::new(); + tool_router.add_route(ToolRoute::new_dyn( + Tool::new("tool_a", "Tool A", Arc::new(Default::default())), + |_ctx| Box::pin(async { Ok(CallToolResult::default().into()) }), + )); + tool_router.add_route(ToolRoute::new_dyn( + Tool::new("tool_b", "Tool B", Arc::new(Default::default())), + |_ctx| Box::pin(async { Ok(CallToolResult::default().into()) }), + )); + Self { + router: Arc::new(RwLock::new(tool_router)), + trigger_disable: Arc::new(Notify::new()), + trigger_enable: Arc::new(Notify::new()), + } + } +} + +impl ServerHandler for TestToolServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::new(ServerCapabilities::builder().enable_tools().build()) + } + + async fn call_tool( + &self, + request: rmcp::model::CallToolRequestParams, + context: rmcp::service::RequestContext, + ) -> Result { + let router = self.router.read().await; + let tcc = ToolCallContext::new(self, request, context); + router.call(tcc).await + } + + async fn list_tools( + &self, + _request: Option, + _context: rmcp::service::RequestContext, + ) -> Result { + let router = self.router.read().await; + Ok(rmcp::model::ListToolsResult { + tools: router.list_all(), + ..Default::default() + }) + } + + fn on_initialized( + &self, + context: NotificationContext, + ) -> impl std::future::Future + MaybeSendFuture + '_ { + let router = self.router.clone(); + let trigger_disable = self.trigger_disable.clone(); + let trigger_enable = self.trigger_enable.clone(); + let peer = context.peer.clone(); + + async move { + router.write().await.bind_peer_notifier(&peer); + + let router = router.clone(); + tokio::spawn(async move { + trigger_disable.notified().await; + { + let mut r = router.write().await; + r.disable_route("tool_a"); + } + + trigger_enable.notified().await; + { + let mut r = router.write().await; + r.enable_route("tool_a"); + } + }); + } + } +} + +#[derive(Clone)] +struct TestToolClient { + notification_count: Arc, + notify: Arc, +} + +impl TestToolClient { + fn new() -> Self { + Self { + notification_count: Arc::new(AtomicUsize::new(0)), + notify: Arc::new(Notify::new()), + } + } +} + +impl ClientHandler for TestToolClient { + fn on_tool_list_changed( + &self, + _context: NotificationContext, + ) -> impl std::future::Future + MaybeSendFuture + '_ { + self.notification_count.fetch_add(1, Ordering::SeqCst); + self.notify.notify_one(); + std::future::ready(()) + } +} + +#[tokio::test] +async fn test_disable_enable_sends_tool_list_changed() { + let server = TestToolServer::new(); + let trigger_disable = server.trigger_disable.clone(); + let trigger_enable = server.trigger_enable.clone(); + + let client = TestToolClient::new(); + let notification_count = client.notification_count.clone(); + let client_notify = client.notify.clone(); + + let (server_transport, client_transport) = tokio::io::duplex(4096); + + let server_handle = tokio::spawn(async move { server.serve(server_transport).await }); + let client_service = client.serve(client_transport).await.unwrap(); + + let tools = client_service.peer().list_tools(None).await.unwrap(); + assert_eq!(tools.tools.len(), 2); + + trigger_disable.notify_one(); + tokio::time::timeout(std::time::Duration::from_secs(5), client_notify.notified()) + .await + .expect("timed out waiting for tool_list_changed"); + assert_eq!(notification_count.load(Ordering::SeqCst), 1); + + let tools = client_service.peer().list_tools(None).await.unwrap(); + assert_eq!(tools.tools.len(), 1); + assert_eq!(tools.tools[0].name, "tool_b"); + + trigger_enable.notify_one(); + tokio::time::timeout(std::time::Duration::from_secs(5), client_notify.notified()) + .await + .expect("timed out waiting for tool_list_changed"); + assert_eq!(notification_count.load(Ordering::SeqCst), 2); + + let tools = client_service.peer().list_tools(None).await.unwrap(); + assert_eq!(tools.tools.len(), 2); + + client_service.cancel().await.unwrap(); + server_handle.abort(); +} diff --git a/vendor/rmcp/tests/test_tool_handler.rs b/vendor/rmcp/tests/test_tool_handler.rs new file mode 100644 index 00000000..8b137891 --- /dev/null +++ b/vendor/rmcp/tests/test_tool_handler.rs @@ -0,0 +1 @@ + diff --git a/vendor/rmcp/tests/test_tool_macro_annotations.rs b/vendor/rmcp/tests/test_tool_macro_annotations.rs new file mode 100644 index 00000000..34b17625 --- /dev/null +++ b/vendor/rmcp/tests/test_tool_macro_annotations.rs @@ -0,0 +1,46 @@ +#[cfg(test)] +mod tests { + use rmcp::{ServerHandler, handler::server::router::tool::ToolRouter, tool, tool_handler}; + + #[derive(Debug, Clone, Default)] + pub struct AnnotatedServer { + tool_router: ToolRouter, + } + + impl AnnotatedServer { + // Tool with inline comments for documentation + /// Direct annotation test tool + /// This is used to test tool annotations + #[tool( + name = "direct-annotated-tool", + annotations(title = "Annotated Tool", read_only_hint = true) + )] + pub async fn direct_annotated_tool(&self, input: String) -> String { + format!("Direct: {}", input) + } + } + #[tool_handler(router = self.tool_router)] + impl ServerHandler for AnnotatedServer {} + + #[test] + fn test_direct_tool_attributes() { + // Get the tool definition + let tool = AnnotatedServer::direct_annotated_tool_tool_attr(); + + // Verify basic properties + assert_eq!(tool.name, "direct-annotated-tool"); + + // Verify description is extracted from doc comments + assert!(tool.description.is_some()); + assert!( + tool.description + .as_ref() + .unwrap() + .contains("Direct annotation test tool") + ); + + let annotations = tool.annotations.unwrap(); + assert_eq!(annotations.title.as_ref().unwrap(), "Annotated Tool"); + assert_eq!(annotations.read_only_hint, Some(true)); + } +} diff --git a/vendor/rmcp/tests/test_tool_macros.rs b/vendor/rmcp/tests/test_tool_macros.rs new file mode 100644 index 00000000..6f9aac63 --- /dev/null +++ b/vendor/rmcp/tests/test_tool_macros.rs @@ -0,0 +1,636 @@ +#![cfg(not(feature = "local"))] +//! Test tool macros, including documentation for generated fns. + +//cargo test --test test_tool_macros --features "client server" +// Enforce that all generated code has sufficient docs to pass missing_docs lint +#![deny(missing_docs)] +#![allow(dead_code)] +use std::sync::Arc; + +use rmcp::{ + ClientHandler, ServerHandler, ServiceExt, + handler::server::{router::tool::ToolRouter, wrapper::Parameters}, + model::{CallToolRequestParams, ClientConfig, ServerCapabilities, ServerConfig}, + tool, tool_handler, tool_router, +}; +use schemars::JsonSchema; +use serde::{Deserialize, Serialize}; + +/// Parameters for weather tool. +#[derive(Serialize, Deserialize, JsonSchema)] +struct GetWeatherRequest { + /// City of interest. + city: String, + /// Date of interest. + date: String, +} + +#[tool_handler(router = self.tool_router)] +impl ServerHandler for Server {} + +/// Trivial stateless server. +#[derive(Debug, Clone)] +#[allow(dead_code)] +pub struct Server { + tool_router: ToolRouter, +} + +impl Server { + /// Create weather server. + pub fn new() -> Self { + Self { + tool_router: Self::tool_router(), + } + } +} + +impl Default for Server { + fn default() -> Self { + Self::new() + } +} + +#[tool_router(router = tool_router)] +impl Server { + /// This tool is used to get the weather of a city. + #[tool(name = "get-weather", description = "Get the weather of a city.")] + pub async fn get_weather(&self, city: Parameters) -> String { + drop(city); + "rain".to_string() + } + + #[tool] + async fn empty_param(&self) {} + + #[tool(description = CONST_TOOL_DESCRIPTION)] + async fn const_description_tool(&self) {} + + #[tool(description = concat!("part-a-", "part-b"))] + async fn concat_description_tool(&self) {} +} + +const CONST_TOOL_DESCRIPTION: &str = "Description from a const"; + +#[test] +fn test_description_accepts_const_and_concat_exprs() { + let tool = Server::const_description_tool_tool_attr(); + assert_eq!(tool.description.as_deref(), Some(CONST_TOOL_DESCRIPTION)); + + let tool = Server::concat_description_tool_tool_attr(); + assert_eq!(tool.description.as_deref(), Some("part-a-part-b")); +} + +/// Generic service trait. +pub trait DataService: Send + Sync + 'static { + /// Get data from service. + fn get_data(&self) -> String; +} + +// mock service for test +#[derive(Clone)] +struct MockDataService; +impl DataService for MockDataService { + fn get_data(&self) -> String { + "mock data".to_string() + } +} + +/// Generic server. +#[derive(Debug, Clone)] +pub struct GenericServer { + data_service: Arc, + tool_router: ToolRouter, +} + +#[tool_router] +impl GenericServer { + /// Create data server instance. + pub fn new(data_service: DS) -> Self { + Self { + data_service: Arc::new(data_service), + tool_router: Self::tool_router(), + } + } + + #[tool(description = "Get data from the service")] + async fn get_data(&self) -> String { + self.data_service.get_data() + } +} + +#[tool_handler] +impl ServerHandler for GenericServer {} + +#[tokio::test] +async fn test_tool_macros() { + let server = Server::new(); + let _attr = Server::get_weather_tool_attr(); + let _get_weather_tool_attr_fn = Server::get_weather_tool_attr; + let _get_weather_fn = Server::get_weather; + server + .get_weather(Parameters(GetWeatherRequest { + city: "Harbin".into(), + date: "Yesterday".into(), + })) + .await; +} + +#[tokio::test] +async fn test_tool_macros_with_empty_param() { + let _attr = Server::empty_param_tool_attr(); + println!("{_attr:?}"); + assert_eq!( + _attr.input_schema.get("type"), + Some(&serde_json::Value::String("object".to_string())) + ); + assert_eq!( + _attr.input_schema.get("properties"), + Some(&serde_json::Value::Object(serde_json::Map::new())) + ); +} + +#[tokio::test] +async fn test_tool_macros_with_generics() { + let mock_service = MockDataService; + let server = GenericServer::new(mock_service); + let _attr = GenericServer::::get_data_tool_attr(); + let _get_data_call_fn = GenericServer::::get_data; + let _get_data_fn = GenericServer::::get_data; + assert_eq!(server.get_data().await, "mock data"); +} + +#[tokio::test] +async fn test_tool_macros_with_optional_param() { + let _attr = Server::get_weather_tool_attr(); + // println!("{_attr:?}"); + let attr_type = _attr + .input_schema + .get("properties") + .unwrap() + .get("city") + .unwrap() + .get("type") + .unwrap(); + println!("_attr.input_schema: {:?}", attr_type); + assert_eq!(attr_type.as_str().unwrap(), "string"); +} + +impl GetWeatherRequest {} + +/// Struct defined for testing optional field schema generation. +#[derive(Debug, Deserialize, Serialize, JsonSchema)] +struct OptionalFieldTestSchema { + /// Field description. + #[schemars(description = "An optional description field")] + description: Option, +} + +/// Struct defined for testing optional i64 field schema generation and null handling. +#[derive(Debug, Deserialize, Serialize, JsonSchema)] +struct OptionalI64TestSchema { + /// Optional count field. + #[schemars(description = "An optional i64 field")] + count: Option, + + /// Added to ensure non-empty object schema. + mandatory_field: String, +} + +/// Dummy struct to host the test tool method. +#[derive(Debug, Clone)] +pub struct OptionalSchemaTester { + tool_router: ToolRouter, +} + +impl Default for OptionalSchemaTester { + fn default() -> Self { + Self::new() + } +} + +impl OptionalSchemaTester { + /// Create instance of optional schema tester service. + pub fn new() -> Self { + Self { + tool_router: Self::tool_router(), + } + } +} + +#[tool_router] +impl OptionalSchemaTester { + // Dummy tool function using the test schema as an aggregated parameter + #[tool(description = "A tool to test optional schema generation")] + async fn test_optional(&self, _req: Parameters) { + // Implementation doesn't matter for schema testing + // Return type changed to () to satisfy IntoCallToolResult + } + + // Tool function to test optional i64 handling + #[tool(description = "A tool to test optional i64 schema generation")] + async fn test_optional_i64( + &self, + Parameters(req): Parameters, + ) -> String { + match req.count { + Some(c) => format!("Received count: {}", c), + None => "Received null count".to_string(), + } + } +} +#[tool_handler] +// Implement ServerHandler to route tool calls for OptionalSchemaTester +impl ServerHandler for OptionalSchemaTester {} + +#[test] +fn test_optional_field_schema_generation_via_macro() { + // tests https://github.com/modelcontextprotocol/rust-sdk/issues/135 + + // Get the attributes generated by the #[tool] macro helper + let tool_attr = OptionalSchemaTester::test_optional_tool_attr(); + + // Print the actual generated schema for debugging + println!( + "Actual input schema generated by macro: {:#?}", + tool_attr.input_schema + ); + + // Verify the schema generated for the aggregated OptionalFieldTestSchema + // by the macro infrastructure using JSON Schema 2020-12 settings. + let input_schema_map = &*tool_attr.input_schema; // Dereference Arc + + // Check the schema for the 'description' property within the input schema + let properties = input_schema_map + .get("properties") + .expect("Schema should have properties") + .as_object() + .unwrap(); + let description_schema = properties + .get("description") + .expect("Properties should include description") + .as_object() + .unwrap(); + + // Assert nullable Option is represented in JSON Schema 2020-12 form. + let type_value = description_schema + .get("type") + .expect("Schema for Option should include a type field"); + let type_array = type_value + .as_array() + .expect("Schema for Option should use a type array [T, null]"); + assert_eq!( + type_array, + &vec![serde_json::json!("string"), serde_json::json!("null")], + "Schema for Option should be type: [\"string\", \"null\"]" + ); + assert!( + description_schema.get("nullable").is_none(), + "Schema for Option should not use OpenAPI nullable in JSON Schema 2020-12" + ); + // We still check the description is correct + assert_eq!( + description_schema + .get("description") + .map(|v| v.as_str().unwrap()), + Some("An optional description field") + ); + + // Ensure no OpenAPI-only nullable extension was emitted. + assert!(description_schema.get("nullable").is_none()); +} + +// Define a dummy client handler +#[derive(Debug, Clone, Default)] +struct DummyClientHandler {} + +impl ClientHandler for DummyClientHandler { + fn get_info(&self) -> ClientConfig { + ClientConfig::default() + } +} + +#[tokio::test] +async fn test_optional_i64_field_with_null_input() -> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(4096); + + // Server setup + let server = OptionalSchemaTester::new(); + let server_handle = tokio::spawn(async move { + server.serve(server_transport).await?.waiting().await?; + anyhow::Ok(()) + }); + + // Create a simple client handler that just forwards tool calls + let client_handler = DummyClientHandler::default(); + let client = client_handler.serve(client_transport).await?; + + // Test null case + let result = client + .call_tool( + CallToolRequestParams::new("test_optional_i64").with_arguments( + serde_json::json!({ + "count": null, + "mandatory_field": "test_null" + }) + .as_object() + .unwrap() + .clone(), + ), + ) + .await?; + + let result_text = result + .content + .first() + .and_then(|content| content.as_text()) + .map(|text| text.text.as_str()) + .expect("Expected text content"); + + assert_eq!( + result_text, "Received null count", + "Null case should return expected message" + ); + + // Test Some case + let some_result = client + .call_tool( + CallToolRequestParams::new("test_optional_i64").with_arguments( + serde_json::json!({ + "count": 42, + "mandatory_field": "test_some" + }) + .as_object() + .unwrap() + .clone(), + ), + ) + .await?; + + let some_result_text = some_result + .content + .first() + .and_then(|content| content.as_text()) + .map(|text| text.text.as_str()) + .expect("Expected text content"); + + assert_eq!( + some_result_text, "Received count: 42", + "Some case should return expected message" + ); + + client.cancel().await?; + server_handle.await??; + Ok(()) +} + +// --- Tests for field-free minimal server pattern (issue #711) --- + +/// Minimal server: no tool_router field, no new(), no get_info(). +#[derive(Debug, Clone)] +struct MinimalServer; + +#[tool_router] +impl MinimalServer { + #[tool(description = "Say hello")] + fn hello(&self) -> String { + "hello".to_string() + } +} + +#[tool_handler] +impl ServerHandler for MinimalServer {} + +#[test] +fn test_minimal_server_get_info_auto_generated() { + let server = MinimalServer; + let info = server.get_info(); + + assert!( + info.capabilities.tools.is_some(), + "tools capability should be enabled" + ); + assert!( + info.capabilities.prompts.is_none(), + "prompts should not be auto-enabled" + ); + assert!( + !info.capabilities.supports_tasks(), + "tasks extension should not be auto-enabled" + ); + assert!( + !info.server_info.name.is_empty(), + "server name should not be empty" + ); + assert!( + !info.server_info.version.is_empty(), + "server version should not be empty" + ); + assert!( + info.instructions.is_none(), + "instructions should be None by default" + ); +} + +#[tokio::test] +async fn test_minimal_server_tool_call() -> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(4096); + + let server_handle = tokio::spawn(async move { + MinimalServer + .serve(server_transport) + .await? + .waiting() + .await?; + anyhow::Ok(()) + }); + + let client = DummyClientHandler::default() + .serve(client_transport) + .await?; + + let result = client + .call_tool(CallToolRequestParams::new("hello")) + .await?; + + let text = result + .content + .first() + .and_then(|c| c.as_text()) + .map(|t| t.text.as_str()) + .expect("Expected text content"); + + assert_eq!(text, "hello"); + + client.cancel().await?; + server_handle.await??; + Ok(()) +} + +/// Same minimal pattern as [`MinimalServer`], but `#[tool_handler]` is omitted using +/// `#[tool_router(server_handler)]` (emits `#[tool_handler]` for a second macro pass). +#[derive(Debug, Clone)] +struct ElidedToolHandlerServer; + +#[tool_router(server_handler)] +impl ElidedToolHandlerServer { + #[tool(description = "Say hi")] + fn hi(&self) -> String { + "hi".to_string() + } +} + +#[test] +fn test_tool_router_server_handler_flag_matches_minimal_server_get_info() { + let server = ElidedToolHandlerServer; + let info = server.get_info(); + + assert!(info.capabilities.tools.is_some()); + assert!( + info.capabilities.prompts.is_none(), + "prompts should not be auto-enabled" + ); +} + +#[tokio::test] +async fn test_tool_router_server_handler_flag_end_to_end_tool_call() -> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(4096); + + let server_handle = tokio::spawn(async move { + ElidedToolHandlerServer + .serve(server_transport) + .await? + .waiting() + .await?; + anyhow::Ok(()) + }); + + let client = DummyClientHandler::default() + .serve(client_transport) + .await?; + + let result = client.call_tool(CallToolRequestParams::new("hi")).await?; + + let text = result + .content + .first() + .and_then(|c| c.as_text()) + .map(|t| t.text.as_str()) + .expect("Expected text content"); + + assert_eq!(text, "hi"); + + client.cancel().await?; + server_handle.await??; + Ok(()) +} + +/// Server with custom name/version/instructions via tool_handler attributes. +#[derive(Debug, Clone)] +struct CustomInfoServer; + +#[tool_router] +impl CustomInfoServer { + #[tool(description = "Ping")] + fn ping(&self) -> String { + "pong".to_string() + } +} + +#[tool_handler( + name = "my-custom-server", + version = "2.0.0", + instructions = "A custom server" +)] +impl ServerHandler for CustomInfoServer {} + +#[test] +fn test_custom_info_server() { + let server = CustomInfoServer; + let info = server.get_info(); + + assert_eq!(info.server_info.name, "my-custom-server"); + assert_eq!(info.server_info.version, "2.0.0"); + assert_eq!(info.instructions.as_deref(), Some("A custom server")); + assert!(info.capabilities.tools.is_some()); +} + +/// Server that provides its own get_info() — macro should not override it. +#[derive(Debug, Clone)] +struct ManualInfoServer; + +#[tool_router] +impl ManualInfoServer { + #[tool(description = "Noop")] + fn noop(&self) {} +} + +#[tool_handler] +impl ServerHandler for ManualInfoServer { + fn get_info(&self) -> ServerConfig { + ServerConfig::new( + ServerCapabilities::builder() + .enable_tools() + .enable_resources() + .build(), + ) + .with_server_info(rmcp::model::Implementation::new("manual", "9.9.9")) + } +} + +#[test] +fn test_manual_get_info_not_overridden() { + let server = ManualInfoServer; + let info = server.get_info(); + + assert_eq!(info.server_info.name, "manual"); + assert_eq!(info.server_info.version, "9.9.9"); + assert!(info.capabilities.tools.is_some()); + assert!( + info.capabilities.resources.is_some(), + "manual resources should be preserved" + ); +} + +/// Server whose tools come from a `macro_rules!` helper wrapping the whole annotated impl. +#[derive(Debug, Clone)] +struct MacroGeneratedServer; + +macro_rules! define_tools { + ($($name:ident => $description:literal),* $(,)?) => { + #[tool_router] + impl MacroGeneratedServer { + $( + #[tool(description = $description)] + async fn $name(&self) -> String { + stringify!($name).to_owned() + } + )* + } + }; +} + +define_tools!(probe => "what a capability would own"); + +#[test] +fn test_macro_rules_around_the_impl_registers_tools() { + let tools = MacroGeneratedServer::tool_router().list_all(); + + assert_eq!(tools.len(), 1); + assert_eq!(tools[0].name, "probe"); + assert_eq!( + tools[0].description.as_deref(), + Some("what a capability would own") + ); +} + +/// Server that opts in to a router with no tools. +#[derive(Debug, Clone)] +struct EmptyRouterServer; + +#[tool_router(allow_empty)] +impl EmptyRouterServer {} + +#[test] +fn test_allow_empty_builds_a_router_without_tools() { + assert!(EmptyRouterServer::tool_router().list_all().is_empty()); +} diff --git a/vendor/rmcp/tests/test_tool_result_meta.rs b/vendor/rmcp/tests/test_tool_result_meta.rs new file mode 100644 index 00000000..37585ac7 --- /dev/null +++ b/vendor/rmcp/tests/test_tool_result_meta.rs @@ -0,0 +1,41 @@ +use rmcp::model::{CallToolResult, ContentBlock, MetaObject}; +use serde_json::{Value, json}; + +#[test] +fn serialize_tool_result_with_meta() { + let content = vec![ContentBlock::text("ok")]; + let mut meta = MetaObject::new(); + meta.insert("foo".to_string(), json!("bar")); + let result = CallToolResult::success(content).with_meta(Some(meta)); + let v = serde_json::to_value(&result).unwrap(); + let expected = json!({ + "resultType": "complete", + "content": [{"type":"text","text":"ok"}], + "isError": false, + "_meta": {"foo":"bar"} + }); + assert_eq!(v, expected); +} + +#[test] +fn deserialize_tool_result_with_meta() { + let raw: Value = json!({ + "content": [{"type":"text","text":"hello"}], + "isError": true, + "_meta": {"a": 1, "b": "two"} + }); + let result: CallToolResult = serde_json::from_value(raw).unwrap(); + assert_eq!(result.is_error, Some(true)); + assert_eq!(result.content.len(), 1); + let meta = result.meta.expect("meta should exist"); + assert_eq!(meta.get("a").unwrap(), &json!(1)); + assert_eq!(meta.get("b").unwrap(), &json!("two")); +} + +#[test] +fn serialize_tool_result_without_meta_omits_field() { + let result = CallToolResult::success(vec![ContentBlock::text("no meta")]); + let v = serde_json::to_value(&result).unwrap(); + // Ensure _meta is omitted + assert!(v.get("_meta").is_none()); +} diff --git a/vendor/rmcp/tests/test_tool_routers.rs b/vendor/rmcp/tests/test_tool_routers.rs new file mode 100644 index 00000000..12a5d400 --- /dev/null +++ b/vendor/rmcp/tests/test_tool_routers.rs @@ -0,0 +1,366 @@ +#![cfg(not(feature = "local"))] +use std::{ + collections::HashMap, + sync::atomic::{AtomicUsize, Ordering}, +}; + +use futures::future::BoxFuture; +use rmcp::{ + ServerHandler, + handler::server::{router::tool::ToolRouter, tool::CallToolHandler, wrapper::Parameters}, +}; + +#[derive(Debug, Default)] +struct TestHandler { + _marker: std::marker::PhantomData, +} + +impl ServerHandler for TestHandler {} +#[derive(Debug, schemars::JsonSchema, serde::Deserialize, serde::Serialize)] +struct Request { + fields: HashMap, +} + +#[rmcp::tool_router(router = test_router_1)] +impl TestHandler { + #[rmcp::tool] + async fn async_method(&self, Parameters(Request { fields }): Parameters) { + drop(fields) + } +} + +#[rmcp::tool_router(router = test_router_2)] +impl TestHandler { + #[rmcp::tool] + fn sync_method(&self, Parameters(Request { fields }): Parameters) { + drop(fields) + } +} + +#[rmcp::tool] +async fn async_function(Parameters(Request { fields }): Parameters) { + drop(fields) +} + +#[rmcp::tool] +fn async_function2(_callee: &TestHandler) -> BoxFuture<'_, ()> { + Box::pin(async move {}) +} + +#[test] +fn test_tool_router() { + let test_tool_router: ToolRouter> = ToolRouter::>::new() + .with_route((async_function_tool_attr(), async_function)) + .with_route((async_function2_tool_attr(), async_function2)) + + TestHandler::<()>::test_router_1() + + TestHandler::<()>::test_router_2(); + let tools = test_tool_router.list_all(); + assert_eq!(tools.len(), 4); + assert_handler(TestHandler::<()>::async_method); +} + +fn assert_handler(_handler: H) +where + H: CallToolHandler, +{ +} + +#[test] +fn test_tool_router_list_all_is_sorted() { + let router: ToolRouter> = ToolRouter::>::new() + .with_route((async_function_tool_attr(), async_function)) + .with_route((async_function2_tool_attr(), async_function2)) + + TestHandler::<()>::test_router_1() + + TestHandler::<()>::test_router_2(); + let tools = router.list_all(); + let names: Vec<&str> = tools.iter().map(|t| t.name.as_ref()).collect(); + let mut sorted = names.clone(); + sorted.sort(); + assert_eq!( + names, sorted, + "list_all() should return tools sorted alphabetically by name" + ); +} + +fn build_router() -> ToolRouter> { + ToolRouter::>::new() + .with_route((async_function_tool_attr(), async_function)) + .with_route((async_function2_tool_attr(), async_function2)) + + TestHandler::<()>::test_router_1() + + TestHandler::<()>::test_router_2() +} + +#[test] +fn test_disable_route() { + let mut router = build_router(); + assert_eq!(router.list_all().len(), 4); + assert!(router.has_route("async_function")); + assert!(router.get("async_function").is_some()); + + assert!(router.disable_route("async_function")); + + assert_eq!(router.list_all().len(), 3); + assert!(!router.has_route("async_function")); + assert!(router.get("async_function").is_none()); + assert!(router.is_disabled("async_function")); + + // other tools unaffected + assert!(router.has_route("async_function2")); + assert!(router.get("async_function2").is_some()); + assert!(!router.is_disabled("async_function2")); +} + +#[test] +fn test_enable_route() { + let mut router = build_router(); + assert!(router.disable_route("async_function")); + assert!(!router.has_route("async_function")); + + assert!(router.enable_route("async_function")); + assert!(router.has_route("async_function")); + assert!(router.get("async_function").is_some()); + assert!(!router.is_disabled("async_function")); + assert_eq!(router.list_all().len(), 4); +} + +#[test] +fn test_with_disabled_builder() { + let router = build_router() + .with_disabled("async_function") + .with_disabled("sync_method"); + + assert_eq!(router.list_all().len(), 2); + assert!(!router.has_route("async_function")); + assert!(!router.has_route("sync_method")); + assert!(router.has_route("async_function2")); + assert!(router.has_route("async_method")); +} + +#[test] +fn test_disabled_tools_survive_merge() { + let mut router_a = ToolRouter::>::new() + .with_route((async_function_tool_attr(), async_function)); + assert!(router_a.disable_route("async_function")); + + let router_b = ToolRouter::>::new() + .with_route((async_function2_tool_attr(), async_function2)); + + router_a.merge(router_b); + + assert_eq!(router_a.list_all().len(), 1); + assert!(router_a.is_disabled("async_function")); + assert!(router_a.has_route("async_function2")); +} + +#[test] +fn test_disable_nonexistent_tool() { + let mut router = build_router(); + // should not panic; returns true because the name is newly added to disabled set + assert!(router.disable_route("does_not_exist")); + assert_eq!(router.list_all().len(), 4); + // is_disabled returns false for tools not in the map + assert!(!router.is_disabled("does_not_exist")); +} + +#[test] +fn test_remove_route_preserves_disabled_state() { + let mut router = build_router(); + assert!(router.disable_route("async_function")); + assert!(router.is_disabled("async_function")); + + router.remove_route("async_function"); + assert!(!router.has_route("async_function")); + // Disabled marker is preserved — is_disabled returns false (no route in map) + // but re-adding will inherit the disabled state (tested separately) + assert!(!router.is_disabled("async_function")); +} + +#[test] +fn test_remove_route_then_readd_stays_disabled() { + let mut router = build_router(); + assert!(router.disable_route("async_function")); + + router.remove_route("async_function"); + assert!(!router.has_route("async_function")); + + // Re-add the route — it should inherit the disabled state + let other = ToolRouter::>::new() + .with_route((async_function_tool_attr(), async_function)); + router.merge(other); + + assert!(!router.has_route("async_function")); + assert!(router.is_disabled("async_function")); + assert!(router.get("async_function").is_none()); +} + +#[test] +fn test_into_iter_skips_disabled() { + let router = build_router().with_disabled("async_function"); + let names: Vec<_> = router + .into_iter() + .map(|r| r.attr.name.to_string()) + .collect(); + assert_eq!(names.len(), 3); + assert!(!names.contains(&"async_function".to_string())); +} + +#[test] +fn test_pre_disable_before_add_route() { + // Disabling a name before adding a route with that name should + // result in the route being disabled once added. + let router = ToolRouter::>::new() + .with_disabled("async_function") + .with_route((async_function_tool_attr(), async_function)); + + assert_eq!(router.list_all().len(), 0); + assert!(router.is_disabled("async_function")); + assert!(!router.has_route("async_function")); +} + +#[test] +fn test_disabled_tool_invisible_across_all_queries() { + let router = build_router().with_disabled("async_function"); + + // Not listed + let names: Vec<_> = router.list_all().iter().map(|t| t.name.clone()).collect(); + assert!(!names.contains(&"async_function".into())); + // Not retrievable + assert!(router.get("async_function").is_none()); + // Not routable + assert!(!router.has_route("async_function")); + // But known as disabled + assert!(router.is_disabled("async_function")); +} + +#[test] +fn test_disable_route_then_add_route_blocks_tool() { + // Full pre-disable lifecycle via runtime mutation (not builder) + let mut router = ToolRouter::>::new(); + router.disable_route("async_function"); + + // Add route after disabling — tool should be blocked + let other = ToolRouter::>::new() + .with_route((async_function_tool_attr(), async_function)); + router.merge(other); + + assert!(router.is_disabled("async_function")); + assert!(!router.has_route("async_function")); + assert!(router.get("async_function").is_none()); + assert_eq!(router.list_all().len(), 0); +} + +#[test] +fn test_disable_enable_return_false_cases() { + let mut router = build_router(); + + // Repeated disable returns false + assert!(router.disable_route("async_function")); + assert!(!router.disable_route("async_function")); + + // Enable returns true, then false on repeat + assert!(router.enable_route("async_function")); + assert!(!router.enable_route("async_function")); + + // Enable on name never disabled returns false + assert!(!router.enable_route("async_function2")); + + // Enable on unknown name returns false + assert!(!router.enable_route("unknown")); +} + +// ── Notifier tests ────────────────────────────────────────────────────── + +fn counter_notifier() -> ( + impl Fn() + Send + Sync + 'static, + std::sync::Arc, +) { + let counter = std::sync::Arc::new(AtomicUsize::new(0)); + let c = counter.clone(); + let notifier = move || { + c.fetch_add(1, Ordering::SeqCst); + }; + (notifier, counter) +} + +#[test] +fn test_notifier_fires_on_disable_and_enable() { + let (notifier, counter) = counter_notifier(); + let mut router = build_router(); + router.set_notifier(notifier); + + assert!(router.disable_route("async_function")); + assert_eq!(counter.load(Ordering::SeqCst), 1); + + assert!(!router.disable_route("async_function")); + assert_eq!(counter.load(Ordering::SeqCst), 1); + + assert!(router.enable_route("async_function")); + assert_eq!(counter.load(Ordering::SeqCst), 2); + + assert!(!router.enable_route("async_function")); + assert_eq!(counter.load(Ordering::SeqCst), 2); +} + +#[test] +fn test_notifier_skips_nonexistent_tools() { + let (notifier, counter) = counter_notifier(); + let mut router = build_router(); + router.set_notifier(notifier); + + assert!(router.disable_route("does_not_exist")); + assert_eq!(counter.load(Ordering::SeqCst), 0); + + assert!(router.enable_route("does_not_exist")); + assert_eq!(counter.load(Ordering::SeqCst), 0); + + assert!(router.disable_route("future_tool")); + assert_eq!(counter.load(Ordering::SeqCst), 0); + assert!(router.enable_route("future_tool")); + assert_eq!(counter.load(Ordering::SeqCst), 0); +} + +#[test] +fn test_no_notifier_no_panic() { + let mut router = build_router(); + assert!(router.disable_route("async_function")); + assert!(router.enable_route("async_function")); + assert!(router.disable_route("async_function")); + assert!(!router.disable_route("async_function")); +} + +#[test] +fn test_clone_shares_notifier() { + let (notifier, counter) = counter_notifier(); + let mut router = build_router(); + router.set_notifier(notifier); + let mut cloned = router.clone(); + + assert!(cloned.disable_route("async_function")); + assert_eq!(counter.load(Ordering::SeqCst), 1); + + assert!(router.disable_route("async_function")); + assert_eq!(counter.load(Ordering::SeqCst), 2); + + cloned.clear_notifier(); + assert!(cloned.enable_route("async_function")); + assert_eq!(counter.load(Ordering::SeqCst), 2); + + assert!(router.enable_route("async_function")); + assert_eq!(counter.load(Ordering::SeqCst), 3); +} + +#[test] +fn test_pre_init_disable_silent_but_correct() { + let mut router = build_router(); + + assert!(router.disable_route("async_function")); + assert_eq!(router.list_all().len(), 3); + assert!(!router.has_route("async_function")); + + let (notifier, counter) = counter_notifier(); + router.set_notifier(notifier); + assert_eq!(counter.load(Ordering::SeqCst), 0); + + assert!(router.enable_route("async_function")); + assert_eq!(counter.load(Ordering::SeqCst), 1); +} diff --git a/vendor/rmcp/tests/test_trace_context.rs b/vendor/rmcp/tests/test_trace_context.rs new file mode 100644 index 00000000..15354a49 --- /dev/null +++ b/vendor/rmcp/tests/test_trace_context.rs @@ -0,0 +1,85 @@ +#![cfg(not(feature = "local"))] +//! SEP-414: the reserved trace-context `_meta` keys survive a client→server round trip unchanged. +use std::sync::Arc; + +use rmcp::{ + RoleServer, ServerHandler, ServiceExt, + model::{ClientRequest, CustomRequest, CustomResult, RequestMetaObject}, + service::{PeerRequestOptions, RequestContext}, +}; +use serde_json::json; +use tokio::sync::{Mutex, Notify}; + +const TRACEPARENT: &str = "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01"; +const TRACESTATE: &str = "vendor1=value1,vendor2=value2"; +const BAGGAGE: &str = "userId=alice,region=us-east-1"; + +/// Records the `_meta` it receives on the incoming request so the test can assert passthrough. +struct TraceCapturingServer { + receive_signal: Arc, + seen: Arc>>, +} + +impl ServerHandler for TraceCapturingServer { + async fn on_custom_request( + &self, + _request: CustomRequest, + context: RequestContext, + ) -> Result { + *self.seen.lock().await = Some(context.meta); + self.receive_signal.notify_one(); + Ok(CustomResult::new(json!({ "status": "ok" }))) + } +} + +#[tokio::test] +async fn trace_context_meta_survives_round_trip() -> anyhow::Result<()> { + let (server_transport, client_transport) = tokio::io::duplex(4096); + let receive_signal = Arc::new(Notify::new()); + let seen = Arc::new(Mutex::new(None)); + + { + let receive_signal = receive_signal.clone(); + let seen = seen.clone(); + tokio::spawn(async move { + let server = TraceCapturingServer { + receive_signal, + seen, + } + .serve(server_transport) + .await?; + server.waiting().await?; + anyhow::Ok(()) + }); + } + + let client = ().serve(client_transport).await?; + + // Client attaches trace context to the outgoing request's `_meta`. + let mut meta = RequestMetaObject::new(); + meta.set_traceparent(TRACEPARENT); + meta.set_tracestate(TRACESTATE); + meta.set_baggage(BAGGAGE); + + let mut options = PeerRequestOptions::no_options(); + options.meta = Some(meta); + client + .send_cancellable_request( + ClientRequest::CustomRequest(CustomRequest::new("requests/trace-test", None)), + options, + ) + .await? + .await_response() + .await?; + + tokio::time::timeout(std::time::Duration::from_secs(5), receive_signal.notified()).await?; + + // Server saw the reserved keys unchanged (alongside the injected progressToken). + let seen = seen.lock().await.take().expect("server observed meta"); + assert_eq!(seen.get_traceparent(), Some(TRACEPARENT)); + assert_eq!(seen.get_tracestate(), Some(TRACESTATE)); + assert_eq!(seen.get_baggage(), Some(BAGGAGE)); + + client.cancel().await?; + Ok(()) +} diff --git a/vendor/rmcp/tests/test_unix_socket_transport.rs b/vendor/rmcp/tests/test_unix_socket_transport.rs new file mode 100644 index 00000000..134bb1ef --- /dev/null +++ b/vendor/rmcp/tests/test_unix_socket_transport.rs @@ -0,0 +1,354 @@ +#![cfg(all( + unix, + feature = "transport-streamable-http-client-unix-socket", + not(feature = "local") +))] + +use std::{collections::HashMap, sync::Arc}; + +use axum::{ + Router, body::Bytes, extract::State, http::StatusCode, response::IntoResponse, routing::post, +}; +use http::{HeaderName, HeaderValue}; +use hyper_util::rt::TokioIo; +use rmcp::{ + ServiceExt, + model::{ClientJsonRpcMessage, ClientRequest, PingRequest, RequestId}, + transport::{ + StreamableHttpClientTransport, UnixSocketHttpClient, + streamable_http_client::{ + StreamableHttpClient, StreamableHttpClientTransportConfig, StreamableHttpError, + }, + }, +}; +use serde_json::json; +use tokio::sync::Mutex; + +#[derive(Clone)] +struct ServerState { + received_headers: Arc>>, + initialize_called: Arc, +} + +async fn mcp_handler( + State(state): State, + headers: http::HeaderMap, + body: Bytes, +) -> impl IntoResponse { + let mut headers_map = HashMap::new(); + for (name, value) in headers.iter() { + let name_str = name.as_str(); + if (name_str.starts_with("x-") || name_str == "host") + && let Ok(v) = value.to_str() + { + headers_map.insert(name_str.to_string(), v.to_string()); + } + } + + let mut stored = state.received_headers.lock().await; + stored.extend(headers_map); + drop(stored); + + if let Ok(json_body) = serde_json::from_slice::(&body) + && let Some(method) = json_body.get("method").and_then(|m| m.as_str()) + { + if method == "initialize" { + state.initialize_called.notify_one(); + let response = json!({ + "jsonrpc": "2.0", + "id": json_body.get("id"), + "result": { + "protocolVersion": "2024-11-05", + "capabilities": {}, + "serverInfo": { + "name": "test-unix-server", + "version": "1.0.0" + } + } + }); + return ( + StatusCode::OK, + [ + (http::header::CONTENT_TYPE, "application/json"), + ( + http::HeaderName::from_static("mcp-session-id"), + "unix-test-session", + ), + ], + response.to_string(), + ); + } else if method == "notifications/initialized" { + return ( + StatusCode::ACCEPTED, + [ + (http::header::CONTENT_TYPE, "application/json"), + ( + http::HeaderName::from_static("mcp-session-id"), + "unix-test-session", + ), + ], + String::new(), + ); + } + } + + let request_id = serde_json::from_slice::(&body) + .ok() + .and_then(|j| j.get("id").cloned()) + .unwrap_or(serde_json::Value::Null); + let response = json!({ + "jsonrpc": "2.0", + "id": request_id, + "result": {} + }); + ( + StatusCode::OK, + [ + (http::header::CONTENT_TYPE, "application/json"), + ( + http::HeaderName::from_static("mcp-session-id"), + "unix-test-session", + ), + ], + response.to_string(), + ) +} + +/// Spawns an HTTP/1.1 server on a Unix socket using hyper directly. +/// Avoids `axum::serve(UnixListener, ...)` which uses `spawn_local` on Linux. +fn spawn_unix_server( + listener: tokio::net::UnixListener, + app: Router, +) -> tokio::task::JoinHandle<()> { + tokio::spawn(async move { + while let Ok((stream, _)) = listener.accept().await { + let tower_service = app.clone(); + tokio::spawn(async move { + let io = TokioIo::new(stream); + let hyper_service = hyper::service::service_fn( + move |req: hyper::Request| { + let mut tower_service = tower_service.clone(); + async move { + use tower_service::Service; + tower_service.call(req).await + } + }, + ); + hyper::server::conn::http1::Builder::new() + .serve_connection(io, hyper_service) + .await + .ok(); + }); + } + }) +} + +/// Integration test: MCP client connects and completes handshake over a Unix domain socket. +#[tokio::test] +async fn test_unix_socket_mcp_handshake() -> anyhow::Result<()> { + let dir = std::env::temp_dir().join(format!("rmcp-test-{}", std::process::id())); + std::fs::create_dir_all(&dir)?; + let socket_path = dir.join("mcp.sock"); + + let _ = std::fs::remove_file(&socket_path); + + let state = ServerState { + received_headers: Arc::new(Mutex::new(HashMap::new())), + initialize_called: Arc::new(tokio::sync::Notify::new()), + }; + + let app = Router::new() + .route("/mcp", post(mcp_handler)) + .with_state(state.clone()); + + let listener = tokio::net::UnixListener::bind(&socket_path)?; + let server_handle = spawn_unix_server(listener, app); + + let socket_str = socket_path.to_str().unwrap(); + let uri = "http://mcp-server.internal/mcp"; + let client = UnixSocketHttpClient::new(socket_str, uri); + let config = StreamableHttpClientTransportConfig::with_uri(uri); + let transport = StreamableHttpClientTransport::with_client(client, config); + + let mcp_client = ().serve(transport).await.expect("MCP handshake should succeed"); + + tokio::time::timeout( + std::time::Duration::from_secs(5), + state.initialize_called.notified(), + ) + .await + .expect("Initialize request should be received"); + + let headers = state.received_headers.lock().await; + assert_eq!( + headers.get("host"), + Some(&"mcp-server.internal".to_string()), + "Host header should be derived from URI" + ); + + drop(mcp_client); + server_handle.abort(); + let _ = std::fs::remove_file(&socket_path); + let _ = std::fs::remove_dir(&dir); + + Ok(()) +} + +/// Integration test: Custom headers are sent through the Unix socket transport. +#[tokio::test] +async fn test_unix_socket_custom_headers() -> anyhow::Result<()> { + let dir = std::env::temp_dir().join(format!("rmcp-test-headers-{}", std::process::id())); + std::fs::create_dir_all(&dir)?; + let socket_path = dir.join("mcp.sock"); + let _ = std::fs::remove_file(&socket_path); + + let state = ServerState { + received_headers: Arc::new(Mutex::new(HashMap::new())), + initialize_called: Arc::new(tokio::sync::Notify::new()), + }; + + let app = Router::new() + .route("/mcp", post(mcp_handler)) + .with_state(state.clone()); + + let listener = tokio::net::UnixListener::bind(&socket_path)?; + let server_handle = spawn_unix_server(listener, app); + + let mut custom_headers = HashMap::new(); + custom_headers.insert( + HeaderName::from_static("x-test-header"), + HeaderValue::from_static("test-value-123"), + ); + custom_headers.insert( + HeaderName::from_static("x-client-id"), + HeaderValue::from_static("unix-test-client"), + ); + + let socket_str = socket_path.to_str().unwrap(); + let uri = "http://mcp-server.internal/mcp"; + let client = UnixSocketHttpClient::new(socket_str, uri); + let config = StreamableHttpClientTransportConfig::with_uri(uri).custom_headers(custom_headers); + let transport = StreamableHttpClientTransport::with_client(client, config); + + let mcp_client = ().serve(transport).await.expect("MCP handshake should succeed"); + + tokio::time::timeout( + std::time::Duration::from_secs(5), + state.initialize_called.notified(), + ) + .await + .expect("Initialize request should be received"); + + let headers = state.received_headers.lock().await; + assert_eq!( + headers.get("x-test-header"), + Some(&"test-value-123".to_string()), + "Custom header x-test-header should be received" + ); + assert_eq!( + headers.get("x-client-id"), + Some(&"unix-test-client".to_string()), + "Custom header x-client-id should be received" + ); + + drop(mcp_client); + server_handle.abort(); + let _ = std::fs::remove_file(&socket_path); + let _ = std::fs::remove_dir(&dir); + + Ok(()) +} + +/// Integration test: Convenience constructor `from_unix_socket` works end-to-end. +#[tokio::test] +async fn test_unix_socket_convenience_constructor() -> anyhow::Result<()> { + let dir = std::env::temp_dir().join(format!("rmcp-test-conv-{}", std::process::id())); + std::fs::create_dir_all(&dir)?; + let socket_path = dir.join("mcp.sock"); + let _ = std::fs::remove_file(&socket_path); + + let state = ServerState { + received_headers: Arc::new(Mutex::new(HashMap::new())), + initialize_called: Arc::new(tokio::sync::Notify::new()), + }; + + let app = Router::new() + .route("/mcp", post(mcp_handler)) + .with_state(state.clone()); + + let listener = tokio::net::UnixListener::bind(&socket_path)?; + let server_handle = spawn_unix_server(listener, app); + + let socket_str = socket_path.to_str().unwrap(); + let transport = + StreamableHttpClientTransport::from_unix_socket(socket_str, "http://localhost/mcp"); + + let mcp_client = ().serve(transport).await.expect("MCP handshake should succeed"); + + tokio::time::timeout( + std::time::Duration::from_secs(5), + state.initialize_called.notified(), + ) + .await + .expect("Initialize request should be received"); + + drop(mcp_client); + server_handle.abort(); + let _ = std::fs::remove_file(&socket_path); + let _ = std::fs::remove_dir(&dir); + + Ok(()) +} + +/// A request POST that gets 200 + `application/json` + `{}` must error. +/// Mapping that body to Accepted would hang the caller waiting on SSE. +#[tokio::test] +async fn test_unix_socket_request_malformed_json_is_unexpected() -> anyhow::Result<()> { + let dir = std::env::temp_dir().join(format!("rmcp-test-bad-json-{}", std::process::id())); + std::fs::create_dir_all(&dir)?; + let socket_path = dir.join("mcp.sock"); + let _ = std::fs::remove_file(&socket_path); + + async fn bad_json_handler() -> impl IntoResponse { + ( + StatusCode::OK, + [(http::header::CONTENT_TYPE, "application/json")], + "{}", + ) + } + + let app = Router::new().route("/mcp", post(bad_json_handler)); + let listener = tokio::net::UnixListener::bind(&socket_path)?; + let server_handle = spawn_unix_server(listener, app); + + let socket_str = socket_path.to_str().unwrap(); + let uri = "http://localhost/mcp"; + let client = UnixSocketHttpClient::new(socket_str, uri); + let result = client + .post_message( + Arc::from(uri), + ClientJsonRpcMessage::request( + ClientRequest::PingRequest(PingRequest::default()), + RequestId::Number(1), + ), + None, + None, + HashMap::new(), + ) + .await; + + server_handle.abort(); + let _ = std::fs::remove_file(&socket_path); + let _ = std::fs::remove_dir(&dir); + + match result { + Err(StreamableHttpError::UnexpectedServerResponse(ref msg)) => { + assert!( + msg.contains("{}"), + "expected body preview in error, got: {msg}" + ); + } + other => panic!("expected UnexpectedServerResponse, got: {other:?}"), + } + Ok(()) +} diff --git a/vendor/rmcp/tests/test_with_js.rs b/vendor/rmcp/tests/test_with_js.rs new file mode 100644 index 00000000..8992f816 --- /dev/null +++ b/vendor/rmcp/tests/test_with_js.rs @@ -0,0 +1,136 @@ +#![cfg(not(feature = "local"))] +use rmcp::{ + ServiceExt, + service::QuitReason, + transport::{ + ConfigureCommandExt, StreamableHttpClientTransport, StreamableHttpServerConfig, + TokioChildProcess, + streamable_http_server::{ + session::local::LocalSessionManager, tower::StreamableHttpService, + }, + }, +}; +use tokio_util::sync::CancellationToken; +use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt}; +mod common; +use common::calculator::Calculator; + +const STREAMABLE_HTTP_BIND_ADDRESS: &str = "127.0.0.1:8001"; +const STREAMABLE_HTTP_JS_BIND_ADDRESS: &str = "127.0.0.1:8002"; +// These tests run concurrently, while npm mutates their shared node_modules directory. +static JS_DEPENDENCIES_INSTALLED: tokio::sync::OnceCell<()> = tokio::sync::OnceCell::const_new(); + +async fn install_js_dependencies() -> anyhow::Result<()> { + JS_DEPENDENCIES_INSTALLED + .get_or_try_init(|| async { + let status = tokio::process::Command::new("npm") + .arg("install") + .current_dir("tests/test_with_js") + .status() + .await?; + anyhow::ensure!(status.success(), "npm install failed with {status}"); + Ok(()) + }) + .await?; + Ok(()) +} + +#[tokio::test] +async fn test_with_js_stdio_server() -> anyhow::Result<()> { + let _ = tracing_subscriber::registry() + .with( + tracing_subscriber::EnvFilter::try_from_default_env() + .unwrap_or_else(|_| "debug".to_string().into()), + ) + .with(tracing_subscriber::fmt::layer()) + .try_init(); + install_js_dependencies().await?; + let transport = + TokioChildProcess::new(tokio::process::Command::new("node").configure(|cmd| { + cmd.arg("tests/test_with_js/server.js"); + }))?; + + let client = ().serve(transport).await?; + let resources = client.list_all_resources().await?; + tracing::info!("{:#?}", resources); + let tools = client.list_all_tools().await?; + tracing::info!("{:#?}", tools); + + client.cancel().await?; + Ok(()) +} + +#[tokio::test] +async fn test_with_js_streamable_http_client() -> anyhow::Result<()> { + let _ = tracing_subscriber::registry() + .with( + tracing_subscriber::EnvFilter::try_from_default_env() + .unwrap_or_else(|_| "debug".to_string().into()), + ) + .with(tracing_subscriber::fmt::layer()) + .try_init(); + install_js_dependencies().await?; + + let ct = CancellationToken::new(); + let service: StreamableHttpService = + StreamableHttpService::new( + || Ok(Calculator::new()), + Default::default(), + StreamableHttpServerConfig::default() + .with_sse_keep_alive(None) + .with_cancellation_token(ct.child_token()), + ); + let router = axum::Router::new().nest_service("/mcp", service); + let tcp_listener = tokio::net::TcpListener::bind(STREAMABLE_HTTP_BIND_ADDRESS).await?; + + let handle = tokio::spawn({ + let ct = ct.clone(); + async move { + let _ = axum::serve(tcp_listener, router) + .with_graceful_shutdown(async move { ct.cancelled_owned().await }) + .await; + } + }); + let exit_status = tokio::process::Command::new("node") + .arg("tests/test_with_js/streamable_client.js") + .spawn()? + .wait() + .await?; + assert!(exit_status.success()); + ct.cancel(); + handle.await?; + Ok(()) +} + +#[tokio::test] +async fn test_with_js_streamable_http_server() -> anyhow::Result<()> { + let _ = tracing_subscriber::registry() + .with( + tracing_subscriber::EnvFilter::try_from_default_env() + .unwrap_or_else(|_| "debug".to_string().into()), + ) + .with(tracing_subscriber::fmt::layer()) + .try_init(); + install_js_dependencies().await?; + + let transport = StreamableHttpClientTransport::from_uri(format!( + "http://{STREAMABLE_HTTP_JS_BIND_ADDRESS}/mcp" + )); + + let mut server = tokio::process::Command::new("node") + .arg("tests/test_with_js/streamable_server.js") + .spawn()?; + + // waiting for server up + tokio::time::sleep(tokio::time::Duration::from_millis(1000)).await; + + let client = ().serve(transport).await?; + let resources = client.list_all_resources().await?; + tracing::info!("{:#?}", resources); + let tools = client.list_all_tools().await?; + tracing::info!("{:#?}", tools); + let quit_reason = client.cancel().await?; + server.kill().await?; + assert!(matches!(quit_reason, QuitReason::Cancelled)); + Ok(()) +} diff --git a/vendor/rmcp/tests/test_with_js/.gitignore b/vendor/rmcp/tests/test_with_js/.gitignore new file mode 100644 index 00000000..572406bf --- /dev/null +++ b/vendor/rmcp/tests/test_with_js/.gitignore @@ -0,0 +1,2 @@ +/node_modules +package-lock.json \ No newline at end of file diff --git a/vendor/rmcp/tests/test_with_js/client.js b/vendor/rmcp/tests/test_with_js/client.js new file mode 100644 index 00000000..17b189a7 --- /dev/null +++ b/vendor/rmcp/tests/test_with_js/client.js @@ -0,0 +1,29 @@ +import { Client } from "@modelcontextprotocol/sdk/client/index.js"; +import { SSEClientTransport } from "@modelcontextprotocol/sdk/client/sse.js"; + +const transport = new SSEClientTransport(new URL(`http://127.0.0.1:8000/sse`)); + +const client = new Client( + { + name: "example-client", + version: "1.0.0" + }, + { + capabilities: { + prompts: {}, + resources: {}, + tools: {} + } + } +); +await client.connect(transport); +const tools = await client.listTools(); +console.log(tools); +const resources = await client.listResources(); +console.log(resources); +const templates = await client.listResourceTemplates(); +console.log(templates); +const prompts = await client.listPrompts(); +console.log(prompts); +await client.close(); +await transport.close(); \ No newline at end of file diff --git a/vendor/rmcp/tests/test_with_js/package.json b/vendor/rmcp/tests/test_with_js/package.json new file mode 100644 index 00000000..d8ecfbfb --- /dev/null +++ b/vendor/rmcp/tests/test_with_js/package.json @@ -0,0 +1,17 @@ +{ + "dependencies": { + "@modelcontextprotocol/sdk": "^1.10", + "eventsource-parser": "^3.0.1", + "express": "^5.1.0" + }, + "type": "module", + "name": "test_with_ts", + "version": "1.0.0", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "author": "", + "license": "ISC", + "description": "" +} diff --git a/vendor/rmcp/tests/test_with_js/server.js b/vendor/rmcp/tests/test_with_js/server.js new file mode 100644 index 00000000..d959224d --- /dev/null +++ b/vendor/rmcp/tests/test_with_js/server.js @@ -0,0 +1,35 @@ +import { McpServer, ResourceTemplate } from "@modelcontextprotocol/sdk/server/mcp.js"; +import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; +import { z } from "zod"; + +const server = new McpServer({ + name: "Demo", + version: "1.0.0" +}); + +server.resource( + "greeting", + new ResourceTemplate("greeting://{name}", { list: undefined }), + async (uri, { name }) => ({ + contents: [{ + uri: uri.href, + text: `Hello, ${name}` + }] + }) +); + +server.tool( + "add", + { a: z.number(), b: z.number() }, + async ({ a, b }) => ({ + "content": [ + { + "type": "text", + "text": `${a + b}` + } + ] + }) +); + +const transport = new StdioServerTransport(); +await server.connect(transport); \ No newline at end of file diff --git a/vendor/rmcp/tests/test_with_js/streamable_client.js b/vendor/rmcp/tests/test_with_js/streamable_client.js new file mode 100644 index 00000000..99826131 --- /dev/null +++ b/vendor/rmcp/tests/test_with_js/streamable_client.js @@ -0,0 +1,28 @@ +import { Client } from "@modelcontextprotocol/sdk/client/index.js"; +import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"; + +const transport = new StreamableHTTPClientTransport(new URL(`http://127.0.0.1:8001/mcp/`)); + +const client = new Client( + { + name: "example-client", + version: "1.0.0" + }, + { + capabilities: { + prompts: {}, + resources: {}, + tools: {} + } + } +); +await client.connect(transport); +const tools = await client.listTools(); +console.log(tools); +const resources = await client.listResources(); +console.log(resources); +const templates = await client.listResourceTemplates(); +console.log(templates); +const prompts = await client.listPrompts(); +console.log(prompts); +await client.close(); diff --git a/vendor/rmcp/tests/test_with_js/streamable_server.js b/vendor/rmcp/tests/test_with_js/streamable_server.js new file mode 100644 index 00000000..3f87ccf0 --- /dev/null +++ b/vendor/rmcp/tests/test_with_js/streamable_server.js @@ -0,0 +1,105 @@ +import { McpServer, ResourceTemplate } from "@modelcontextprotocol/sdk/server/mcp.js"; +import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js"; +import { isInitializeRequest } from "@modelcontextprotocol/sdk/types.js" +import { randomUUID } from "node:crypto" +import { z } from "zod"; +import express from "express" + +const app = express(); +app.use(express.json()); + +// Map to store transports by session ID +const transports = {}; + +// Handle POST requests for client-to-server communication +app.post('/mcp', async (req, res) => { + // Check for existing session ID + const sessionId = req.headers['mcp-session-id']; + let transport; + + if (sessionId && transports[sessionId]) { + // Reuse existing transport + transport = transports[sessionId]; + } else if (!sessionId && isInitializeRequest(req.body)) { + // New initialization request + transport = new StreamableHTTPServerTransport({ + sessionIdGenerator: () => randomUUID().toString(), + onsessioninitialized: (sessionId) => { + // Store the transport by session ID + transports[sessionId] = transport; + } + }); + + // Clean up transport when closed + transport.onclose = () => { + if (transport.sessionId) { + delete transports[transport.sessionId]; + } + }; + const server = new McpServer({ + name: "example-server", + version: "1.0.0" + }); + + server.resource( + "greeting", + new ResourceTemplate("greeting://{name}", { list: undefined }), + async (uri, { name }) => ({ + contents: [{ + uri: uri.href, + text: `Hello, ${name}` + }] + }) + ); + + server.tool( + "add", + { a: z.number(), b: z.number() }, + async ({ a, b }) => ({ + "content": [ + { + "type": "text", + "text": `${a + b}` + } + ] + }) + ); + + // Connect to the MCP server + await server.connect(transport); + } else { + // Invalid request + res.status(400).json({ + jsonrpc: '2.0', + error: { + code: -32000, + message: 'Bad Request: No valid session ID provided', + }, + id: null, + }); + return; + } + + // Handle the request + await transport.handleRequest(req, res, req.body); +}); + +// Reusable handler for GET and DELETE requests +const handleSessionRequest = async (req, res) => { + const sessionId = req.headers['mcp-session-id']; + if (!sessionId || !transports[sessionId]) { + res.status(400).send('Invalid or missing session ID'); + return; + } + + const transport = transports[sessionId]; + await transport.handleRequest(req, res); +}; + +// Handle GET requests for server-to-client notifications via SSE +app.get('/mcp', handleSessionRequest); + +// Handle DELETE requests for session termination +app.delete('/mcp', handleSessionRequest); +console.log("Listening on port 8002"); +app.listen(8002); \ No newline at end of file diff --git a/vendor/rmcp/tests/test_with_python.rs b/vendor/rmcp/tests/test_with_python.rs new file mode 100644 index 00000000..c905e1b5 --- /dev/null +++ b/vendor/rmcp/tests/test_with_python.rs @@ -0,0 +1,78 @@ +#![cfg(not(feature = "local"))] +use std::process::Stdio; + +use rmcp::{ + ServiceExt, + transport::{ConfigureCommandExt, TokioChildProcess}, +}; +use tokio::io::AsyncReadExt; +use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt}; +mod common; + +async fn init() -> anyhow::Result<()> { + let _ = tracing_subscriber::registry() + .with( + tracing_subscriber::EnvFilter::try_from_default_env() + .unwrap_or_else(|_| "debug".to_string().into()), + ) + .with(tracing_subscriber::fmt::layer()) + .try_init(); + tokio::process::Command::new("uv") + .args(["sync"]) + .current_dir("tests/test_with_python") + .spawn()? + .wait() + .await?; + Ok(()) +} + +#[tokio::test] +async fn test_with_python_server() -> anyhow::Result<()> { + init().await?; + + let transport = TokioChildProcess::new(tokio::process::Command::new("uv").configure(|cmd| { + cmd.arg("run") + .arg("server.py") + .current_dir("tests/test_with_python"); + }))?; + + let client = ().serve(transport).await?; + let resources = client.list_all_resources().await?; + tracing::info!("{:#?}", resources); + let tools = client.list_all_tools().await?; + tracing::info!("{:#?}", tools); + client.cancel().await?; + Ok(()) +} + +#[tokio::test] +async fn test_with_python_server_stderr() -> anyhow::Result<()> { + init().await?; + + let (transport, stderr) = + TokioChildProcess::builder(tokio::process::Command::new("uv").configure(|cmd| { + cmd.arg("run") + .arg("server.py") + .current_dir("tests/test_with_python"); + })) + .stderr(Stdio::piped()) + .spawn()?; + + let mut stderr = stderr.expect("stderr must be piped"); + + let stderr_task = tokio::spawn(async move { + let mut buffer = String::new(); + stderr.read_to_string(&mut buffer).await?; + Ok::<_, std::io::Error>(buffer) + }); + + let client = ().serve(transport).await?; + let _ = client.list_all_resources().await?; + let _ = client.list_all_tools().await?; + client.cancel().await?; + + let stderr_output = stderr_task.await??; + assert!(stderr_output.contains("server starting up...")); + + Ok(()) +} diff --git a/vendor/rmcp/tests/test_with_python/.gitignore b/vendor/rmcp/tests/test_with_python/.gitignore new file mode 100644 index 00000000..2eb00089 --- /dev/null +++ b/vendor/rmcp/tests/test_with_python/.gitignore @@ -0,0 +1,22 @@ +# Lock files +*.lock + +# Python build artifacts +*.egg-info/ +build/ +dist/ +__pycache__/ +*.py[cod] +*$py.class + +# Virtual environments +venv/ +env/ +.venv/ +.env/ + +# IDE +.vscode/ +.idea/ +*.swp +*.swo diff --git a/vendor/rmcp/tests/test_with_python/client.py b/vendor/rmcp/tests/test_with_python/client.py new file mode 100644 index 00000000..83d2c35b --- /dev/null +++ b/vendor/rmcp/tests/test_with_python/client.py @@ -0,0 +1,28 @@ +from mcp import ClientSession, StdioServerParameters, types +from mcp.client.sse import sse_client +import sys + +async def run(): + url = sys.argv[1] + async with sse_client(url) as (read, write): + async with ClientSession( + read, write + ) as session: + # Initialize the connection + await session.initialize() + + # List available prompts + prompts = await session.list_prompts() + print(prompts) + # List available resources + resources = await session.list_resources() + print(resources) + + # List available tools + tools = await session.list_tools() + print(tools) + +if __name__ == "__main__": + import asyncio + + asyncio.run(run()) diff --git a/vendor/rmcp/tests/test_with_python/pyproject.toml b/vendor/rmcp/tests/test_with_python/pyproject.toml new file mode 100644 index 00000000..9c8ce6ae --- /dev/null +++ b/vendor/rmcp/tests/test_with_python/pyproject.toml @@ -0,0 +1,14 @@ +[build-system] +requires = ["setuptools>=42", "wheel"] +build-backend = "setuptools.build_meta" + +[project] +name = "test_with_python" +version = "0.1.0" +description = "Test Python client for RMCP" +dependencies = [ + "fastmcp", +] + +[tool.setuptools] +py-modules = ["client", "server"] diff --git a/vendor/rmcp/tests/test_with_python/server.py b/vendor/rmcp/tests/test_with_python/server.py new file mode 100644 index 00000000..1c8ee698 --- /dev/null +++ b/vendor/rmcp/tests/test_with_python/server.py @@ -0,0 +1,25 @@ +from fastmcp import FastMCP + +import sys + +mcp = FastMCP("Demo") + +print("server starting up...", file=sys.stderr) + + +@mcp.tool() +def add(a: int, b: int) -> int: + """Add two numbers""" + return a + b + + +# Add a dynamic greeting resource +@mcp.resource("greeting://{name}") +def get_greeting(name: str) -> str: + """Get a personalized greeting""" + return f"Hello, {name}!" + + + +if __name__ == "__main__": + mcp.run() \ No newline at end of file