@cloudhal/mcp-server 0.0.0-stage → 0.1.0

package/LICENSE

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

package/README.md

@@ -1,3 +1,19 @@
-# Temporary Holding Version
+# @cloudhal/mcp-server
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The Model Context Protocol surface of Cloudhal (spec 2026-07-28, `@modelcontextprotocol/server` 2.3). ADR-0004 and ADR-0011.
+
+**Tools (deterministic order):** `list_sites, get_site, list_pages, get_page, create_page, update_page, delete_page, list_entries, get_entry, create_entry, update_entry, add_correction, delete_entry`, then the taxonomy tools (RFC-0002 §6.2) `list_taxonomies, list_terms, resolve_terms, propose_term, update_term, rename_term, merge_terms, retire_term, set_term_parent, set_term_visibility, review_term, taxonomy_report, create_taxonomy, update_taxonomy, list_redirects, create_redirect, delete_redirect`, then `create_snapshot, list_snapshots, diff_snapshots, preview_page, publish, rollback`, the read-only analytics tools (RFC-0006 §9.3, scope `analytics:read`, every mode) `get_analytics, top_content, content_stats, broken_links`, then `get_mode, request_elevation`. Every tool has JSON Schema input/output (built from the contract schemas), honest annotations and `structuredContent`. Updates need the current `rev` (optimistic locking). Every mutation snapshots automatically (exactly one snapshot per call; governance snapshots carry `cloudhal.opId`).
+
+**Taxonomy (RFC-0002):** `create_entry` / `update_entry` take `terms: { [taxonomy]: { set?, add?, remove?, primary? } }` with values by id, slug, old slug, name, synonym or singular/plural, resolved by the store; an unknown or ambiguous value is an error with suggestions (`unknown_term`, `ambiguous_term`), never an implicit create. `tags` is a deprecated alias for `terms.tag.add`. `list_entries` takes the RFC §5 `filter`. Agents add terms only through `propose_term` (`allowNewTerms`: none → denied, propose → proposed, free → active; an existing match is returned). Structural tools (`site:write`) always wait for a person; their prompts list the articles touched and every redirect. Agents never redirect off-site, never reclaim slugs and never approve their own proposals (checked before anyone is asked). Store invariant errors map to stable codes (`required_term`, `too_many_terms`, …) with the next step in the text. Assignment deltas and governance results (`opId`, counts, redirects) go into the audit row's `input.effect`.
+
+**Approval:** `publish`, `rollback`, `delete_*` and the structural taxonomy/redirect tools return MCP's multi-round-trip `input_required` with an elicitation (the message carries the diff summary) and an HMAC-signed `requestState` bound to the tool, the arguments and the principal. The person answers in their client; the call completes only on an explicit accept. Clients without elicitation get a `confirmToken` to pass on a second identical call (`confirmTokenFallback: false` turns that off).
+
+**Skills:** `skill://<name>/SKILL.md` and `skill://<name>/references/<file>` resources. A client that follows a skill sends `_meta["cloudhal.skill"] = "<name>"`; the policy engine then limits the call to that skill's declared scopes.
+
+```ts
+import { createCloudhalMcpServer } from "@cloudhal/mcp-server";          // McpServer for one principal
+import { serveCloudhalStdio } from "@cloudhal/mcp-server/stdio";          // what `cloudhal mcp` runs
+import { createCloudhalMcpHandler } from "@cloudhal/mcp-server/http";     // fetch(request, principal) — mounted at /mcp by @cloudhal/api
+```
+
+`tools.ts` is SDK-independent (`defineTools()`, `runTool()` = policy → audit → handler) and is what the tests exercise first; `test/e2e.test.ts` runs a real client ↔ server pair over the in-memory transport and proves the Sprint 5 exit criterion.

package/dist/src/analytics-reports.d.ts

@@ -0,0 +1,164 @@
+/**
+ * Analytics reports shared by the REST routes (`packages/api/src/routes/analytics.ts`) and the MCP
+ * tools (`analytics-tools.ts`), RFC-0006 §9: queries of the model through `AnalyticsService`, joined
+ * to the **current** graph by node id (a renamed article shows its new title and path; a deleted
+ * one reads as gone). Every string returned is graph data, an enum, a hostname, a UTM token or —
+ * for render reports only — a percent-encoded requested path (§5.5, invariant A9).
+ */
+import type { AnalyticsResult, AnalyticsSource, BotTrafficReason, BotTrafficSignal, Dimension, Filter, Range, SummaryData, TopRow, VitalsData } from "@cloudhal/analytics";
+import { type AnalyticsService } from "@cloudhal/analytics/service";
+import type { Site } from "@cloudhal/core-contracts";
+import { type SiteGraphStore } from "@cloudhal/core-ts";
+export type AnalyticsNodeKind = "page" | "entry" | "archive";
+/** A node of analytics rows as the current graph knows it. */
+export interface AnalyticsNode {
+    readonly nodeId: string;
+    /** From the id's prefix; `null` for an id of another kind. */
+    readonly kind: AnalyticsNodeKind | null;
+    /** `false`: the node no longer exists (its history stays under its id). */
+    readonly exists: boolean;
+    readonly title: string | null;
+    /** Its current path (archives: the term's archive page). */
+    readonly path: string | null;
+    /** Publish status (pages, entries) or term status. */
+    readonly status: string | null;
+}
+/** Where a combined answer came from (the REST envelope's `source`, `estimated`, `partial`). */
+export interface AnalyticsMeta {
+    readonly source: AnalyticsSource;
+    readonly estimated: boolean;
+    readonly partial?: boolean;
+}
+export declare function combineMeta(results: readonly AnalyticsResult[]): AnalyticsMeta;
+export declare function nodeKindOf(id: string): AnalyticsNodeKind | null;
+/** The current graph's view of analytics node ids, in a bounded number of reads. */
+export declare function analyticsNodes(store: SiteGraphStore, site: Site, ids: readonly string[]): Promise<Map<string, AnalyticsNode>>;
+export interface SummaryReport extends SummaryData {
+    /** Page views per visit; `null` without visits. */
+    readonly viewsPerVisit: number | null;
+    /**
+     * **Estimated** cache-hit ratio, `1 − renders ÷ page views` (RFC-0006 §5.4), 0–1: only on
+     * Cloudflare (`store: "wae"`), `null` without page views or a render count. Page views come from
+     * the script (no-JS visitors are missed) and only a zone sees real cache statistics.
+     */
+    readonly cacheHitRatio: number | null;
+    /**
+     * Share of page views whose request carried GPC or DNT (0–1): counted but never hashed, so
+     * unique visitors are a lower bound. `null` when unknown or without page views.
+     */
+    readonly privacySignalShare: number | null;
+    /** The period of the same length just before, when asked for. */
+    readonly previous?: SummaryData & {
+        readonly range: Range;
+    };
+    /** Relative change against `previous` (0.12 = +12 %); `null` where the previous value was 0. */
+    readonly change?: {
+        readonly pageviews: number | null;
+        readonly visits: number | null;
+        readonly visitors: number | null;
+    };
+}
+export declare function summaryReport(analytics: AnalyticsService, siteId: string, range: Range, options?: {
+    filter?: Filter | undefined;
+    compare?: boolean | undefined;
+}): Promise<{
+    data: SummaryReport;
+    results: AnalyticsResult[];
+}>;
+/** A reason of the signal; `single_page` carries the page as the current graph knows it. */
+export type BotTrafficReportReason = BotTrafficReason & {
+    readonly node?: AnalyticsNode;
+};
+export interface BotTrafficReport extends Omit<BotTrafficSignal, "reasons"> {
+    readonly reasons: readonly BotTrafficReportReason[];
+}
+/**
+ * The "possible bot traffic" signal (RFC-0006 §5.5) for REST `…/analytics/bots` and
+ * `get_analytics`: the period's last 7 days by the hour; a `single_page` reason is joined to the
+ * graph (title and current path), so people and agents see which page drew the burst.
+ */
+export declare function botTrafficReport(analytics: AnalyticsService, store: SiteGraphStore, site: Site, range: Range): Promise<{
+    data: BotTrafficReport;
+    results: AnalyticsResult[];
+}>;
+export interface TopContentRow extends AnalyticsNode {
+    readonly pageviews: number;
+    readonly visits: number;
+    /** Relative change of page views against the previous period, when asked for. */
+    readonly change?: number | null;
+}
+/** Top content joined to the graph. `kind` and `channel` narrow it; `compare` adds the change. */
+export declare function topContentReport(analytics: AnalyticsService, store: SiteGraphStore, site: Site, range: Range, options: {
+    limit: number;
+    kind?: AnalyticsNodeKind | undefined;
+    filter?: Filter | undefined;
+    compare?: boolean | undefined;
+}): Promise<{
+    rows: TopContentRow[];
+    results: AnalyticsResult[];
+}>;
+/** A plain top list (no join): channels, referrers, countries, devices, … */
+export declare function topList(analytics: AnalyticsService, siteId: string, range: Range, dimension: Dimension, limit: number, filter?: Filter): Promise<AnalyticsResult & {
+    data: {
+        rows: readonly TopRow[];
+    };
+}>;
+export interface OldPath {
+    /** The earlier path a slug change (or merge, retirement) left behind. */
+    readonly from: string;
+    readonly to: string;
+    readonly status: number;
+    readonly reason: string;
+    /** Redirect hits on it in the range. */
+    readonly hits: number;
+}
+export interface NodeReport {
+    readonly node: AnalyticsNode;
+    readonly summary: SummaryReport;
+    readonly series: {
+        interval: "hour" | "day";
+        points: readonly {
+            t: string;
+            pageviews: number;
+            visits: number;
+        }[];
+    };
+    /** Entrances (visits) and page views by channel. */
+    readonly channels: readonly TopRow[];
+    readonly referrers: readonly TopRow[];
+    readonly countries: readonly TopRow[];
+    readonly devices: readonly TopRow[];
+    readonly vitals: VitalsData;
+    /** Slug history: earlier paths of this node and the redirects they left, with hits. */
+    readonly oldPaths: readonly OldPath[];
+    /** Redirect hits that brought readers here in the range ("old addresses still bring readers"). */
+    readonly redirectHits: number;
+}
+/** Hourly buckets for ranges of at most two days, daily otherwise (§10.1). */
+export declare function seriesInterval(range: Range): "hour" | "day";
+export declare function nodeReport(analytics: AnalyticsService, store: SiteGraphStore, site: Site, nodeId: string, range: Range, options?: {
+    compare?: boolean | undefined;
+}): Promise<{
+    data: NodeReport;
+    meta: AnalyticsMeta;
+}>;
+export interface BrokenLink {
+    /** Requested path as received: percent-encoded ASCII ≤ 256 characters, visitor-controlled. */
+    readonly path: string;
+    readonly status: number;
+    readonly hits: number;
+    /** Same-site pages that linked here (published paths). */
+    readonly linkedFrom: readonly string[];
+    readonly lastSeen: string | null;
+    /** A redirect that now answers this path, or a published node with a similar slug. */
+    readonly suggestedTarget: {
+        path: string;
+        nodeId?: string;
+        reason: "redirect" | "similar";
+    } | null;
+}
+/** 404 and 410 paths with hits, the pages linking to them, and a suggested target. */
+export declare function brokenLinksReport(analytics: AnalyticsService, store: SiteGraphStore, site: Site, range: Range, limit: number): Promise<{
+    rows: BrokenLink[];
+    meta: AnalyticsMeta;
+}>;