@tomradex/mcp 0.0.0-stage → 0.17.1

package/LICENSE

@@ -0,0 +1,204 @@
+Copyright 2026 Haoyuan Tang
+
+
+                                 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/dist/index.d.ts

@@ -0,0 +1,169 @@
+import { Context, Service } from "cordis";
+import { z } from "zod";
+import type { Author } from "@tomradex/domain";
+import { type McpWords } from "./words.js";
+import { type McpReader } from "@tomradex/contracts";
+export declare const MCP_SERVER_NAME = "tomrade";
+declare module "cordis" {
+    interface Context {
+        mcp: Mcp;
+    }
+    interface Events {
+        /** An outside client's connection closed: the client went away, or ended its MCP session. */
+        "mcp/closed"(connection: string): void;
+    }
+}
+declare module "@tomradex/ipc" {
+    interface Channels {
+        /** The MCP base url, or the per-project endpoint when a project is named. */
+        "mcp.url": (projectId?: string) => string | null;
+    }
+}
+export declare const McpConfig: z.ZodObject<{
+    host: z.ZodDefault<z.ZodString>;
+    port: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    slowCallMs: z.ZodDefault<z.ZodNumber>;
+    instance: z.ZodPrefault<z.ZodObject<{
+        kind: z.ZodDefault<z.ZodEnum<{
+            packaged: "packaged";
+            dev: "dev";
+        }>>;
+        version: z.ZodDefault<z.ZodString>;
+        dataDir: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type McpConfig = z.infer<typeof McpConfig>;
+/** What `GET /instance` answers: enough for another Tomrade to say who holds the port, nothing about its data. */
+export interface InstanceBadge {
+    app: "tomrade";
+    kind: "packaged" | "dev";
+    version: string;
+    pid: number;
+}
+/** The port this instance was configured for, when another program held it. */
+export interface PortClash {
+    port: number;
+    /** The Tomrade holding it, when it answered; null for anything else. */
+    heldBy: InstanceBadge | null;
+}
+interface SyncSummaryLike {
+    state: string;
+    location: string | null;
+    detail?: string;
+    lastSyncAt: number | null;
+    pending: {
+        count: number;
+        since: number | null;
+    } | null;
+}
+/** One line an agent reads after a write: is it still only here, and if so why and for how long. */
+export declare function syncNote(summary: SyncSummaryLike, instance: McpConfig["instance"]): string;
+/**
+ * Gemini CLI (0.64) reads a result whose first block is JSON as its structured
+ * content, which must be an object, and refuses a call that answers an array:
+ * it gets an object holding the value. Every other client reads the text alone.
+ */
+export declare function forClient<R extends {
+    content: {
+        type: "text";
+        text: string;
+    }[];
+    structuredContent?: Record<string, unknown>;
+}>(client: string | undefined, result: R): R;
+/**
+ * An agent run announcing itself: a session opened with the binding's token in
+ * `X-Tomrade-Run` executes tools through the run's own gateway, so the ledger,
+ * the policies and run-scoped undo see a CLI agent exactly as they see the
+ * in-process engine.
+ */
+export interface RunBinding {
+    author: Author;
+    projectId?: string;
+    /** `signal` aborts when the client cancels the call. */
+    execute(name: string, args: unknown, signal?: AbortSignal): Promise<unknown>;
+    /** A lifecycle event posted to `/sessions/<token>/event` — a coding agent's hook reporting it started, stopped, or is waiting. */
+    event?(payload: unknown): unknown | Promise<unknown>;
+}
+/** Where a session stands: its project when it opened on `/mcp/<projectId>`, none on the bare endpoint. */
+export interface McpScope {
+    projectId?: string;
+}
+/**
+ * A prompt the client offers its user as a slash command — Claude Code lists
+ * it as `/tomrade:<name>`. Rendered when invoked, so it reads the project as
+ * it is then.
+ */
+export interface McpPrompt {
+    name: string;
+    title?: string;
+    description: string;
+    render(scope: McpScope): string;
+}
+/**
+ * Every tool in the registry appears here under its own name (the server name
+ * is the namespace), executed as ai:mcp through the same guarded path every
+ * surface uses — or through a run's gateway when the session presented a run
+ * token. Sessions read the registry, prompts and instructions when they open,
+ * so a plugin loaded later is visible to the next one.
+ */
+export declare class Mcp extends Service implements McpReader {
+    readonly config: McpConfig;
+    static provide: string;
+    static inject: string[];
+    static Config: z.ZodObject<{
+        host: z.ZodDefault<z.ZodString>;
+        port: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+        slowCallMs: z.ZodDefault<z.ZodNumber>;
+        instance: z.ZodPrefault<z.ZodObject<{
+            kind: z.ZodDefault<z.ZodEnum<{
+                packaged: "packaged";
+                dev: "dev";
+            }>>;
+            version: z.ZodDefault<z.ZodString>;
+            dataDir: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    url: string | null;
+    /** Set when the configured port was taken and this instance listens elsewhere. */
+    clash: PortClash | null;
+    /** Captured from the injected context: HTTP callbacks run after Cordis's injection frame has closed. */
+    private tools;
+    private bindings;
+    private eventListeners;
+    private prompts;
+    private instructions;
+    constructor(ctx: Context, config: McpConfig);
+    [Service.init](): Promise<() => Promise<void>>;
+    /** This instance, as `GET /instance` tells another one. */
+    badge(): InstanceBadge;
+    private words;
+    /** Who holds the clashed port, in words. */
+    holderText(w?: McpWords): string;
+    /** The first thing a client reads: which Tomrade, and which data, it is talking to. */
+    private introduction;
+    private registerWhoami;
+    /** The endpoint whose sessions are scoped to one project. The same on every machine, because the id lives in the project's own folder. */
+    urlFor(projectId: string): string | null;
+    /** Where a session's hooks post their lifecycle events. */
+    eventUrlFor(token: string): string | null;
+    /** Where hooks with no token post — the ones a repository commits for every developer. */
+    get eventUrl(): string | null;
+    /** Hear tokenless hook events. Reversible: the listener goes with the plugin that registered it. */
+    onEvent(listener: (payload: unknown) => void): () => void;
+    /** Offer a prompt to every session opened from now on. Reversible with the plugin that registered it. */
+    prompt(prompt: McpPrompt): () => void;
+    /**
+     * Add a paragraph to the instructions a client reads when it connects. Only
+     * sessions without a run token get them: a run Tomrade started already has
+     * its brief. Lower `order` comes first — Claude Code keeps only the first
+     * 2048 characters.
+     */
+    instruct(render: (scope: McpScope) => string | null, options?: {
+        order?: number;
+    }): () => void;
+    /** Reversible: the token dies with the run (or the plugin) that registered it. */
+    bindRun(token: string, binding: RunBinding): () => void;
+    private session;
+}
+export default Mcp;
+//# sourceMappingURL=index.d.ts.map

package/dist/runtime.js

@@ -0,0 +1 @@
+throw new Error("@tomradex/mcp is Tomrade's own code: a full-mode plugin gets the running app's copy, so load the plugin in Tomrade");

package/dist/words.d.ts

@@ -0,0 +1,10 @@
+export declare const MCP_WORDS: import("@tomradex/domain").WordBook<{
+    readonly portClash: "MCP on {{port}} · {{clashPort}} held by {{holder}}";
+    readonly portClashTitle: "Agents configured for the usual port reach the other Tomrade and its data, not this one. Quit the other, or give this instance its own port with TOMRADE_MCP_PORT.";
+    readonly holderUnknown: "another program";
+    readonly holderPackaged: "the installed Tomrade";
+    readonly holderDev: "a development Tomrade";
+    readonly holder: "{{kind}} {{version}} (pid {{pid}})";
+}>;
+export type McpWords = ReturnType<typeof MCP_WORDS>;
+//# sourceMappingURL=words.d.ts.map

package/package.json

@@ -1,6 +1,50 @@
 {
   "name": "@tomradex/mcp",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.17.1",
+  "type": "module",
+  "author": "Haoyuan Tang",
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "Apache-2.0",
+  "description": "Projects ctx.tools onto MCP (streamable HTTP on 127.0.0.1) for coding agents — declarations for full-mode plugins; Tomrade provides the code at run time",
+  "keywords": [
+    "tomrade",
+    "tomrade-plugin",
+    "types"
+  ],
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/runtime.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@tomradex/contracts": "0.17.1",
+    "@tomradex/contributions": "0.17.1",
+    "@tomradex/domain": "0.2.26",
+    "@tomradex/ipc": "0.17.1",
+    "@tomradex/tools": "0.17.1",
+    "cordis": "4.0.0-rc.8",
+    "zod": "^4.4.3"
+  },
+  "peerDependencies": {
+    "@modelcontextprotocol/sdk": "^1.30.0",
+    "express": "^4.22.2"
+  },
+  "peerDependenciesMeta": {
+    "@modelcontextprotocol/sdk": {
+      "optional": true
+    },
+    "express": {
+      "optional": true
+    }
+  }
+}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-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.