@tomradex/tools 0.0.0-stage → 0.18.0

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,5 @@
+export { Tools, ToolInputError, UnknownToolError, defineTool, nearestParam, requireProjectId, strictInput } from "./service.js";
+export type { LedgerEntry, RunHandle, ToolCall, ToolDefinition, ToolDescriptor, ToolInvocation, ToolOutcome } from "./service.js";
+export { Tools as default } from "./service.js";
+export { LONG_RESULT, compactList, compactRow } from "./render.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/render.d.ts

@@ -0,0 +1,16 @@
+/** Past this many characters of JSON a result is too long to read whole. */
+export declare const LONG_RESULT = 6000;
+/** One row of a long list, shorn of what a listing does not need: empties, nested records, the tail of long text. */
+export declare function compactRow(row: unknown): unknown;
+/**
+ * A long list of records as a model should read it, or null when the result
+ * is not one. A list that does not fit is not cut mid-record — that read as
+ * "there is more, query again" and sent weaker models re-slicing the same rows
+ * by status and sort — every row stays in a shortened form, and only past the
+ * list cap do rows drop. `note` says which, and goes before the rows.
+ */
+export declare function compactList(result: unknown): {
+    note: string;
+    json: string;
+} | null;
+//# sourceMappingURL=render.d.ts.map

package/dist/runtime.js

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

package/dist/service.d.ts

@@ -0,0 +1,167 @@
+import { Context, Service } from "cordis";
+import { z } from "zod";
+import type { Author } from "@tomradex/domain";
+/** One tool call as the run's ledger remembers it. */
+export interface LedgerEntry {
+    seq: number;
+    tool: string;
+    args: unknown;
+    ok: boolean;
+    /** One line of what came back (or the error message). */
+    summary: string;
+    ms: number;
+}
+/**
+ * One agent run, as tools and policies see it. Every write made while a tool
+ * executes under a run is stamped with `id` in the oplog, which is what makes
+ * the whole run revertible at once.
+ */
+export interface RunHandle {
+    id: string;
+    threadId: string;
+    projectId: string;
+    author: Author;
+    ledger: {
+        all(): LedgerEntry[];
+        find(pred: (entry: LedgerEntry) => boolean): LedgerEntry | undefined;
+    };
+    /** Rule ids the user explicitly waived for this run (through ask_user). */
+    waivers: Set<string>;
+    /** Run-scoped scratch space; proposals live here between tool calls. */
+    scratch: Map<string, unknown>;
+    /** Where the run works once its turn is prepared: the thread's workstream checkout. */
+    cwd?: string;
+    /** Credentials plugins supplied for the run's subprocesses; never persisted. */
+    env?: Record<string, string>;
+}
+export interface ToolInvocation {
+    by: Author;
+    /** The project the caller is scoped to; tools default their filters to it. */
+    projectId?: string;
+    /** Present when the call belongs to an agent run; policies read its ledger. */
+    run?: RunHandle;
+    /** Aborted when the caller stops waiting — a cancelled run, a client that withdrew the call. Work outside the process should stop with it. */
+    signal?: AbortSignal;
+    /**
+     * The outside client's connection the call came over (its MCP session id):
+     * the same for every call one agent process makes until it reconnects,
+     * whichever agent it is. Absent for calls made inside this process.
+     */
+    connection?: string;
+    /** The folders an outside client says it works in (its MCP roots), as absolute paths. Absent when the client declares none. */
+    roots?(): Promise<string[]>;
+    /** Ask the person behind the call to pick one of `options`; null when the call was cancelled. Absent when nobody can be asked. */
+    ask?(text: string, options: string[]): Promise<string | null>;
+}
+export interface ToolDefinition<S extends z.ZodObject = z.ZodObject> {
+    name: string;
+    title: string;
+    description: string;
+    input: S;
+    execute(args: z.output<S>, invocation: ToolInvocation): unknown;
+    /**
+     * False keeps the tool off the MCP server, so only engines in this process can call it — for what no outside client may reach, like a shell.
+     * "run" serves it only to a Tomrade conversation's own agent (a run-bound session), never to an outside client.
+     */
+    mcp?: boolean | "run";
+    /** True when the tool only reads: MCP clients such as Codex then run it without asking (`readOnlyHint`). */
+    readOnly?: boolean;
+    /** The result is reference the model needs in full — a schema, a playbook: never compacted into short rows, and the loop reads up to 100k characters of it. */
+    whole?: boolean;
+    /**
+     * Listed to an in-process agent only on threads of this surface (the
+     * troubleshooter's tools: "doctor"), so no other conversation carries it.
+     * The MCP server still serves it; the tool refuses calls from elsewhere.
+     */
+    surface?: string;
+    /**
+     * A kit of tools few conversations use (routines, plugins, diagrams…). A
+     * conversation whose kind does not carry the kit is offered it on request:
+     * the engine loads it when the model asks, or opens a playbook naming it.
+     */
+    kit?: string;
+    /** How to undo this tool's non-oplog effects; undoRun calls it for ledger entries whose tool declares one. */
+    revert?(args: z.output<S>, result: unknown, invocation: ToolInvocation): void | Promise<void>;
+}
+export interface ToolCall {
+    name: string;
+    args: unknown;
+    by: Author;
+    projectId?: string;
+    run?: RunHandle;
+}
+export type ToolOutcome = {
+    ok: true;
+    result: unknown;
+} | {
+    ok: false;
+    error: unknown;
+};
+/** Model-facing description of a tool: what every surface (assistant prompt, MCP listing) is generated from. */
+export interface ToolDescriptor {
+    name: string;
+    title: string;
+    description: string;
+    inputSchema: Record<string, unknown>;
+    whole?: boolean;
+    kit?: string;
+}
+declare module "cordis" {
+    interface Context {
+        tools: Tools;
+    }
+    interface Events {
+        "tools/pre-execute"(call: ToolCall, next: () => Promise<unknown>): Promise<unknown>;
+        "tools/result"(call: ToolCall, outcome: ToolOutcome): void;
+    }
+}
+export declare const defineTool: <S extends z.ZodObject>(tool: ToolDefinition<S>) => ToolDefinition<S>;
+export declare class ToolInputError extends Error {
+    readonly tool: string;
+    readonly issues: z.core.$ZodIssue[];
+    constructor(tool: string, issues: z.core.$ZodIssue[]);
+}
+/** The accepted name a mistyped one most likely meant, if any is close. */
+export declare function nearestParam(given: string, accepted: string[]): string | undefined;
+/**
+ * The schema refusing keys it does not declare, at every depth. Zod strips them by default, so a
+ * misspelt parameter (query for search) used to vanish and the call answered something else.
+ */
+export declare function strictInput<S extends z.ZodType>(schema: S): S;
+/**
+ * Tools scope to the caller's project. Without one there is nothing to default
+ * to — guessing would write into the wrong project the moment a second exists —
+ * so the call is refused with the tool that answers the question.
+ */
+/**
+ * The project a call works in. A call bound to one (an assistant thread's run,
+ * a project's MCP session) stays in it: naming another is refused, so an agent
+ * cannot wander into a project the user is not looking at.
+ */
+export declare function requireProjectId(tool: string, given: string | undefined, invocation: {
+    projectId?: string;
+}): string;
+export declare class UnknownToolError extends Error {
+    readonly tool: string;
+    constructor(tool: string);
+}
+export declare class Tools extends Service {
+    static provide: string;
+    private registry;
+    private kitNotes;
+    constructor(ctx: Context);
+    /** What a kit is for, in a few words the model reads before it loads the kit ("recurring tickets on a schedule"). Reversible. */
+    kit(id: string, purpose: string): () => void;
+    kits(): Record<string, string>;
+    /** Reversible: the tool is removed when the registering plugin unloads. */
+    register<S extends z.ZodObject>(tool: ToolDefinition<S>): () => void;
+    list(): ToolDefinition[];
+    /** What the MCP server offers: every tool but those kept in this process; a conversation's own agent also gets the "run" ones. */
+    served(audience?: "public" | "run"): ToolDefinition[];
+    get(name: string): ToolDefinition | undefined;
+    has(name: string): boolean;
+    describe(): ToolDescriptor[];
+    /** Validate, pass the tools/pre-execute gate, run, and report the outcome. */
+    execute(name: string, rawArgs: unknown, invocation: ToolInvocation): Promise<unknown>;
+}
+//# sourceMappingURL=service.d.ts.map

package/package.json

@@ -1,6 +1,35 @@
 {
   "name": "@tomradex/tools",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.18.0",
+  "type": "module",
+  "author": "Haoyuan Tang",
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "Apache-2.0",
+  "description": "ctx.tools — one tool registry with guarded execution, feeding the assistant and MCP alike — 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/domain": "0.2.26",
+    "@tomradex/write": "0.18.0",
+    "cordis": "4.0.0-rc.8",
+    "zod": "^4.4.3"
+  }
+}

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.