@genclass/mcp 0.0.0-stage → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## 0.1.0 (unreleased)
+
+- First version: the GenClass MCP server for coding agents ([docs/runtime/AGENT.md](../../docs/runtime/AGENT.md)).
+  A bridge on 127.0.0.1:47357 that pages connect to through `@genclass/runtime/agent`; eight tools
+  (`genclass_status`, `genclass_findings`, `genclass_explain`, `genclass_explore`, `genclass_replay`,
+  `genclass_analytics`, `genclass_setup`, `genclass_clear`); findings deduplicated and kept in
+  `.genclass/agent/state.json`; explore verdicts from final states against request-order baselines; replays with
+  reproduced / not reproduced verdicts; Playwright regression tests generated from a finding; new findings pushed as
+  Claude Code channel events or through a `UserPromptSubmit` hook; one bridge shared by every agent session on the
+  machine; production numbers read from the developer's GenClass dashboard. No dependencies. The bridge accepts pages
+  only from the developer's machine (or origins listed in `GENCLASS_AGENT_ORIGINS`), binds each run to the page that
+  registered it (origin and token), guards its agent API with a per-user token, quotes every page string it shows the
+  agent and strips invisible characters. A Claude Code plugin (`plugin/`: the server, the prompt hook and a skill) and
+  an MCP Registry entry (`server.json`) ship with it. Needs `@genclass/runtime` 0.3.0-beta.1 or later in the app
+  (`@genclass/runtime/agent`). Released by `.github/workflows/release-mcp.yml` from a `mcp-v<version>` tag.

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,112 @@
-# Temporary Holding Version
+# @genclass/mcp
 
-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.
+### Your coding agent can see the race, replay it, and prove the fix.
+
+An MCP server for Claude Code and other coding agents. It connects to the pages of your app running on your machine
+(through [`@genclass/runtime`](https://www.npmjs.com/package/@genclass/runtime)'s agent link) and gives the agent:
+
+- **What happened, in order.** Every click, request and response, the order the responses were delivered, what each
+  response wrote into the app's state, and uncaught errors with the click and request that led to them.
+- **Bugs that never throw.** A response that overwrote newer data (the classic stale search result or lost edit), the
+  same order submitted twice by two clicks, and the on-device model's own detections.
+- **Races found before users find them.** `genclass_explore` runs your steps again with the network answering in
+  different orders (and slower, if you like) and reports what ends differently from the run where responses came back
+  in order.
+- **Proof.** `genclass_replay` delivers the exact order that produced a bug again, before your fix (reproduced) and
+  after it (not reproduced), and `genclass_explain` writes a Playwright test that fails while the bug is there.
+
+Everything stays on your machine. No dependencies.
+
+## Install
+
+As a Claude Code plugin (the server, a prompt hook that brings new findings to each prompt, and a skill that tells
+Claude when to use it):
+
+```
+/plugin marketplace add genclass-dev/GenClass-lib
+/plugin install genclass@genclass
+```
+
+Or the server alone:
+
+```bash
+claude mcp add genclass -- npx -y @genclass/mcp
+# or, in the project: npx @genclass/mcp init          (adds it to .mcp.json)
+#                     npx @genclass/mcp init --hook   (also a prompt hook that brings new findings to the agent)
+```
+
+Then connect the app's development build (once). The agent link needs `@genclass/runtime` 0.3.0-beta.1 or later
+(`npm install @genclass/runtime@beta` until 0.3.0 is `latest`):
+
+```ts
+import { GenClass } from "@genclass/runtime";
+import { connectAgent } from "@genclass/runtime/agent";
+
+const rt = GenClass.init();
+if (import.meta.env.DEV) connectAgent(rt); // Next.js: process.env.NODE_ENV === "development"
+```
+
+Load a page of the dev server and ask the agent for `genclass_status`. The agent can also ask `genclass_setup`, which
+reads your `package.json` and shows the lines for your framework.
+
+## What the agent does with it
+
+```
+you:    the search results are sometimes for an older query
+agent:  genclass_findings → f1 [stale-write] /search: the response to GET /api/search "?q=reac"
+        overwrote "search.results" after a newer GET /api/search had already written it
+        genclass_explain f1 → steps, delivery order, a replay, a regression test
+        genclass_replay arm f1 → (loads the page, types) → result: REPRODUCED
+        (fixes the handler to keep only the latest answer, adds the test)
+        genclass_replay arm f1 → result: not reproduced
+        genclass_explore start {slow_ms: 600} → 8 runs → report: no race
+```
+
+On a real page in headless Chromium (the package's end-to-end check), explore found that race in 5 of 6 reordered runs
+of a page that never showed it on the developer's fast backend, the generated test failed on the buggy page and passed
+on the fixed one, and explore on the fixed page reported nothing. Details: [docs/runtime/AGENT.md](https://github.com/genclass-dev/GenClass-lib/blob/main/docs/runtime/AGENT.md).
+
+## Tools
+
+| tool | |
+|---|---|
+| `genclass_status` | connected pages, counts of findings, explore and replay state |
+| `genclass_findings` | ranked, deduplicated findings: races, stale writes, errors, duplicate requests, model detections, visual checks |
+| `genclass_explain` | one finding in causal order, the recorded steps, the replay, a Playwright regression test |
+| `genclass_explore` | `start` / `report` / `stop`: find what depends on response order |
+| `genclass_replay` | `arm` / `result`: reproduce one finding exactly |
+| `genclass_analytics` | per-endpoint latency, error rates and request counts, learned relations and flows; production numbers from your GenClass dashboard |
+| `genclass_setup` | the lines to add for your framework |
+| `genclass_clear` | forget recorded runs and findings |
+
+## New findings without asking
+
+- **Channels** (Claude Code research preview): start Claude Code with
+  `claude --dangerously-load-development-channels server:genclass` and new findings arrive in the session as they
+  happen (`notifications/claude/channel`).
+- **Prompt hook**: `npx @genclass/mcp init --hook` adds a `UserPromptSubmit` hook; each prompt then carries the findings
+  that changed since the last one.
+
+## Environment
+
+| variable | default | |
+|---|---|---|
+| `GENCLASS_AGENT_PORT` | `47357` | the bridge's port (the page then needs `connectAgent(rt, { url })`) |
+| `GENCLASS_STATE_DIR` | `.genclass/agent` | where findings persist between sessions; `none` keeps them in memory |
+| `GENCLASS_DASHBOARD` | | your dashboard's private link, for `genclass_analytics` `production` (`sample` reads the public sample) |
+| `GENCLASS_AGENT_ORIGINS` | | exact page origins allowed besides this machine's, e.g. `http://192.168.1.20:5173` (the page then needs `connectAgent(rt, { anyHost: true })`) |
+| `GENCLASS_TOKEN_DIR` | `~/.genclass` | where the bridge keeps its API token (mode 0600) for the hook and other sessions |
+
+## Security
+
+The bridge listens on 127.0.0.1 only and checks the `Host` header. Pages may talk to it only from your machine
+(`localhost`, `127.0.0.1`, `*.localhost`) or an origin you list in `GENCLASS_AGENT_ORIGINS` (a `*.test` or LAN dev host): a public
+website, a router page or a captive portal you visit cannot plant findings, and a page can only add to its own run.
+The agent API refuses browsers and needs a token only your user can read. Everything a page sends is validated,
+capped, stripped of invisible characters and shown to the agent as quoted data, never as instructions. Nothing leaves
+your machine. See section 6 of
+[AGENT.md](https://github.com/genclass-dev/GenClass-lib/blob/main/docs/runtime/AGENT.md).
+
+## License
+
+Apache-2.0

package/bin/genclass-mcp.mjs

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+// genclass-mcp: the GenClass MCP server and its helper commands (see src/cli.ts).
+import { runCli } from "../dist/cli.js";
+
+runCli(process.argv.slice(2), {
+  cwd: process.cwd(),
+  env: process.env,
+  out: (s) => void process.stdout.write(s),
+  err: (s) => void process.stderr.write(s),
+  stdin: process.stdin,
+  stdout: process.stdout,
+  stderr: process.stderr,
+}).then(
+  (code) => {
+    process.exitCode = code;
+  },
+  (e) => {
+    process.stderr.write(`[genclass-mcp] ${e instanceof Error ? e.stack ?? e.message : String(e)}\n`);
+    process.exitCode = 1;
+  },
+);

package/dist/cli.d.ts

@@ -0,0 +1,19 @@
+interface CliIo {
+    cwd: string;
+    env: Record<string, string | undefined>;
+    out: (s: string) => void;
+    err: (s: string) => void;
+}
+declare function init(io: CliIo, hook: boolean): number;
+/**
+ * The prompt hook: findings changed since the cursor stored in hook-cursor (state directory), tied to the bridge's
+ * epoch (a restarted bridge counts from 0 again). Silent when there is nothing new or no bridge.
+ */
+declare function hookCmd(io: CliIo): Promise<number>;
+declare function runCli(argv: string[], io: CliIo & {
+    stdin: NodeJS.ReadableStream;
+    stdout: NodeJS.WritableStream;
+    stderr: NodeJS.WritableStream;
+}): Promise<number>;
+
+export { type CliIo, hookCmd, init, runCli };