@atgs/tapeworm 0.1.2 → 0.1.4

package/README.md

@@ -1,8 +1,14 @@
-![Tapeworm Logo](./tapeworm.svg)
+![Tapeworm Logo](https://raw.githubusercontent.com/andygrace227/tapeworm/main/tapeworm.svg)
 
 # Tapeworm
 
-Tapeworm is an in-browser and node agent framework.
+<h3>In-browser and Node agent framework.</h3>
+
+[![npm version](https://img.shields.io/npm/v/@atgs/tapeworm.svg?style=flat-square)](https://www.npmjs.org/package/@atgs/tapeworm.svg)
+
+[![npm downloads](https://img.shields.io/npm/dm/@atgs/tapeworm?style=flat-square)](https://npm-stat.com/charts.html?package=@atgs/tapeworm)
+
+[repo link](https://github.com/andygrace227/tapeworm)
 
 This is the root package for Tapeworm. You can consume other packages like @atgs/tapeworm_bedrock for AWS Bedrock support.
 
@@ -12,53 +18,128 @@ It provides an object-oriented API to create agents that run either on Node or w
 
 ## Current Features
 
-- Base API Defined
-- Supports `function` tools
-- Supports Ollama models
-
-## Example
-
-```
-import {Agent, OllamaModel, Parameter, Tool, ToolSchema} from '../../dist/tapeworm.es.js';
-
-class SomeTool extends Tool {
-
-    // Get the name of the function
-    getName() {
-        return "AdditionTool";
-    }
-
-    // Tell models what this function does
-    getDescription() {
-        return "Adds two numbers together.";
-    }
+- Base API Defined.
+- Supports `function` tools.
+- Supports Ollama models.
+- Has a Babel plugin to make tool creation really easy.
+
+## Examples
+
+#### With the babel plugin (@atgs/@atgs/babel-plugin-tapeworm-decorator) (recommended, super concise)
+
+```js
+@Tool({ description: "Adds 2 numbers together" })
+class AdditionTool extends Tool {
+  @TParam({
+    name: "a",
+    description: "The first number to add",
+    required: true,
+    type: "number",
+  })
+  @TParam({
+    name: "b",
+    description: "The second number to add",
+    required: true,
+    type: "number",
+  })
+  @TOutput("The sum of inputs a and b")
+  execute(input) {
+    let a = +input.a;
+    let b = +input.b;
+    console.log("Adding " + a + " and " + b + ": " + (a + b));
+    return a + b;
+  }
+}
 
-    // Define the tool schema
-    getToolSchema() {
+const ollama = new OllamaModel("http://localhost:11434", "gpt-oss:20b", {
+  stream: false,
+});
 
-    }
+const agent = Agent.builder()
+  .name("calculatorAgent")
+  .tools([new AdditionTool()])
+  .systemPrompt("You are an agent that runs math operations.")
+  .model(ollama)
+  .build();
 
-    // Actually run the code!
-    execute(input) {
-        let a = input.a;
-        let b = input.b;
-        return a + b;
-    }
+await agent.invoke("What is 9 + 10?");
+```
 
+#### Without the plugin (still pretty readable.)
+
+```js
+import {
+  Agent,
+  OllamaModel,
+  Parameter,
+  Tool,
+  ToolSchema,
+} from "../../dist/tapeworm.es.js";
+
+class AdditionTool extends Tool {
+  /**
+   * Unique name used to reference this tool.
+   * @returns Tool identifier string.
+   */
+  getName() {
+    return "AdditionTool";
+  }
+
+  /**
+   * Short description provided to the model.
+   * @returns Human-readable explanation of the tool.
+   */
+  getDescription() {
+    return "Adds two numbers together.";
+  }
+
+  getToolSchema() {
+    return (
+      ToolSchema.builder()
+        .addParameter(
+          Parameter.builder()
+            .name("a")
+            .description("The first number to add.")
+            .required(true)
+            .type("number")
+            .build(),
+        )
+        //... more parameter additions.
+        .output("A number that is equal to a + b")
+        .build()
+    );
+  }
+
+  execute(input) {
+    let a = +input.a;
+    let b = +input.b;
+    console.log("Adding " + a + " and " + b + ": " + (a + b));
+    return a + b;
+  }
 }
 
-const ollama = new Model();
+// Because this is a test file, we are going to run this locally using Ollama
 
-const agent = new Agent();
-agent.name = "agent";
-agent.tools = [new YourTool(), new YourOtherTool()]
-agent.system_prompt = "You are an agent "
-agent.model = ollama;
+const ollama = new OllamaModel("http://localhost:11434", "gpt-oss:20b", {
+  stream: false,
+});
 
-await agent.invoke("What is 9 + 10"); // Most likely doesn't print 21.
+const agent = Agent.builder()
+  .name("calculatorAgent")
+  .tools([new AdditionTool()])
+  .systemPrompt("You are an agent that runs math operations.")
+  .model(ollama)
+  .build();
 
+await agent.invoke("What is 9 + 10");
 ```
 
+## Tapeworm's Tenets
+
+- **Be the most ergonomic agentic solution for Node and the browser.** Each commit should make it easier to develop and deploy agentic AI solutions.
+- **Be as model-agnostic as possible.** Use your own machine, AWS, Google, a literal potato... we don't care.
+- **Keep things light.** We already waste so much water and energy with AI. The overhead from Tapeworm should be kept to a minimum when possible.
+
 ## Roadmap
 
 Tapeworm seeks to be the most ergonomic agentic solution for Node and the browser.
@@ -67,12 +148,6 @@ It has a long way to go before this project is there, but I believe we're off to
 
 Here are the main areas that will be addressed:
 
-### Better Agent Definitions
-
-Agents will have a dedicated builder, and I will attempt to make tool definitions a lot easier to write so that the `getName()`, `getDescription()`, and `getToolSchema()` can be generated from your JSDoc or with annotations.
-
-In the meantime, schemas are easy to define with builders. See the example calculator bot for an example.
-
 ### More documentation and examples
 
 We will build JS Docs and expose them, and more examples.

package/dist/tool/toolDecorators.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file contains TypeScript decorator functions for Tapeworm.
+ *
+ * They are different from the Babel decorators in @atgs/babel-plugin-tapeworm-decorator, but they achieve the same functionality.
+ *
+ *
+ */
+export declare function ToolName(name: String): (toolClass: Function) => void;
+export declare function ToolDescription(description: String): (toolClass: Function) => void;
+interface ShortHandParameter {
+    name: string;
+    description: string;
+    required: boolean;
+    type: string;
+}
+export declare function ToolParameter(parameter: ShortHandParameter): (toolClass: Function) => void;
+export declare function ToolOutput(output: string): (toolClass: Function) => void;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atgs/tapeworm",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "type": "module",
   "main": "dist/tapeworm.cjs.js",
   "module": "dist/tapeworm.es.js",