@vertesia/tools-sdk 0.82.0 → 0.82.2

package/lib/types/types.d.ts

@@ -0,0 +1,262 @@
+import type { ToolDefinition, ToolUse } from "@llumiverse/common";
+import { VertesiaClient } from "@vertesia/client";
+import { AuthTokenPayload, ToolResult, ToolResultContent } from "@vertesia/common";
+export type ICollection<T = any> = CollectionProperties & Iterable<T>;
+export interface CollectionProperties {
+    /**
+     * A kebab case collection name. Must only contains alphanumeric and dash characters,
+     * The name can be used to generate the path where the collection is exposed.
+     * Example: my-collection
+     */
+    name: string;
+    /**
+     * Optional title for UI display.
+     * If not provided the pascal case version of the name will be used
+     */
+    title?: string;
+    /**
+     * Optional icon for UI display
+     */
+    icon?: string;
+    /**
+     * A short description
+     */
+    description?: string;
+}
+export interface ToolExecutionContext {
+    /**
+     * The raw JWT token to the tool execution request
+     */
+    token: string;
+    /**
+     * The decoded JWT token
+     */
+    payload: AuthTokenPayload;
+    /**
+     * Vertesia client factory using the current auth token.
+     * @returns a vertesia client instance
+     */
+    getClient: () => Promise<VertesiaClient>;
+}
+export interface ToolExecutionResult extends ToolResultContent {
+    /**
+     * Medata can be used to return more info on the tool execution like stats or user messages.
+     */
+    meta?: Record<string, any>;
+}
+export interface ToolExecutionResponse extends ToolExecutionResult, ToolResult {
+    /**
+     * The tool use id of the tool use request. For traceability.
+     */
+    tool_use_id: string;
+}
+export interface ToolExecutionResponseError {
+    /**
+     * The tool use id of the tool use request. For traceability.
+     */
+    tool_use_id: string;
+    /**
+     * The http status code
+     */
+    status: number;
+    /**
+     * the error message
+     */
+    error: string;
+    /**
+     * Additional context information
+     */
+    data?: Record<string, any>;
+}
+export interface ToolExecutionPayload<ParamsT extends Record<string, any>> {
+    tool_use: ToolUse<ParamsT>;
+    /**
+     * Optional metadata related to the current execution request
+     */
+    metadata?: Record<string, any>;
+}
+export type ToolFn<ParamsT extends Record<string, any>> = (payload: ToolExecutionPayload<ParamsT>, context: ToolExecutionContext) => Promise<ToolExecutionResult>;
+export interface Tool<ParamsT extends Record<string, any>> extends ToolDefinition {
+    run: ToolFn<ParamsT>;
+}
+/**
+ * The interface that should be return when requesting a collection endpoint using a GET
+ */
+export interface ToolCollectionDefinition {
+    title: string;
+    description: string;
+    src: string;
+    tools: ToolDefinition[];
+}
+export type { ToolDefinition };
+/**
+ * The details of a connection to a MCP server - including the server URL and an authentication token
+ */
+export interface MCPConnectionDetails {
+    /**
+     * The mcp server name. It will be used to prefix tool names.
+     */
+    name: string;
+    /**
+     * The target mcp server URL
+     */
+    url: string;
+    /**
+     * The bearer authentication token to use when connecting to the mcp server.
+     * If an empty string no authentication will be done
+     */
+    token: string;
+}
+/**
+ * Content type for skill instructions
+ */
+export type SkillContentType = 'md' | 'jst';
+/**
+ * Context triggers for auto-injection of skills
+ */
+export interface SkillContextTriggers {
+    /**
+     * Keywords in user input that should trigger this skill
+     */
+    keywords?: string[];
+    /**
+     * If these tools are being used, suggest this skill
+     */
+    tool_names?: string[];
+    /**
+     * Regex patterns to match against input data
+     */
+    data_patterns?: string[];
+}
+/**
+ * Execution configuration for skills that need code execution
+ */
+export interface SkillExecution {
+    /**
+     * The programming language for execution
+     */
+    language: string;
+    /**
+     * Required packages to install
+     */
+    packages?: string[];
+    /**
+     * System-level packages to install (e.g., apt-get packages)
+     */
+    system_packages?: string[];
+    /**
+     * Code template to execute
+     */
+    template?: string;
+}
+/**
+ * Script file bundled with a skill
+ */
+export interface SkillScript {
+    /**
+     * Filename (e.g., "analyze.py")
+     */
+    name: string;
+    /**
+     * Script content
+     */
+    content: string;
+}
+/**
+ * Skill definition - parsed from SKILL.md or SKILL.jst
+ */
+export interface SkillDefinition {
+    /**
+     * Unique skill name (kebab-case)
+     */
+    name: string;
+    /**
+     * Display title
+     */
+    title?: string;
+    /**
+     * Short description for discovery
+     */
+    description: string;
+    /**
+     * The skill instructions (markdown or JST template)
+     */
+    instructions: string;
+    /**
+     * Content type: 'md' for static markdown, 'jst' for dynamic templates
+     */
+    content_type: SkillContentType;
+    /**
+     * JSON Schema for skill input parameters.
+     * Used when skill is exposed as a tool.
+     */
+    input_schema?: {
+        type: 'object';
+        properties?: Record<string, any>;
+        required?: string[];
+    };
+    /**
+     * Context triggers for auto-injection
+     */
+    context_triggers?: SkillContextTriggers;
+    /**
+     * Execution configuration for code-based skills
+     */
+    execution?: SkillExecution;
+    /**
+     * Related tools that work well with this skill
+     */
+    related_tools?: string[];
+    /**
+     * Scripts bundled with this skill (synced to sandbox when skill is used)
+     */
+    scripts?: SkillScript[];
+}
+/**
+ * Skill execution payload
+ */
+export interface SkillExecutionPayload {
+    /**
+     * The skill name to execute
+     */
+    skill_name: string;
+    /**
+     * Data context for JST template rendering
+     */
+    data?: Record<string, any>;
+    /**
+     * Whether to execute the code template (if present)
+     */
+    execute?: boolean;
+}
+/**
+ * Skill execution result
+ */
+export interface SkillExecutionResult {
+    /**
+     * The skill name
+     */
+    name: string;
+    /**
+     * Rendered instructions
+     */
+    instructions: string;
+    /**
+     * Execution output (if execute=true and skill has code template)
+     */
+    execution_result?: {
+        output: string;
+        files?: string[];
+        is_error: boolean;
+    };
+}
+/**
+ * Skill collection definition - returned by GET endpoint
+ */
+export interface SkillCollectionDefinition {
+    name: string;
+    title: string;
+    description: string;
+    skills: SkillDefinition[];
+}
+//# sourceMappingURL=types.d.ts.map

package/lib/types/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAEnF,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,GAAG,IAAI,oBAAoB,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAA;AAErE,MAAM,WAAW,oBAAoB;IACjC;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,oBAAoB;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,gBAAgB,CAAC;IAC1B;;;OAGG;IACH,SAAS,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;IAC1D;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,qBAAsB,SAAQ,mBAAmB,EAAE,UAAU;IAC1E;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,0BAA0B;IACvC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,oBAAoB,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IACrE,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC;AAED,MAAM,MAAM,MAAM,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,oBAAoB,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,oBAAoB,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAElK,MAAM,WAAW,IAAI,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAE,SAAQ,cAAc;IAC7E,GAAG,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,cAAc,EAAE,CAAC;CAC3B;AAED,YAAY,EAAE,cAAc,EAAE,CAAC;AAE/B;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACjB;AAID;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,IAAI,GAAG,KAAK,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,EAAE,gBAAgB,CAAC;IAC/B;;;OAGG;IACH,YAAY,CAAC,EAAE;QACX,IAAI,EAAE,QAAQ,CAAC;QACf,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;KACvB,CAAC;IACF;;OAEG;IACH,gBAAgB,CAAC,EAAE,oBAAoB,CAAC;IACxC;;OAEG;IACH,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB;;OAEG;IACH,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,gBAAgB,CAAC,EAAE;QACf,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QACjB,QAAQ,EAAE,OAAO,CAAC;KACrB,CAAC;CACL;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,eAAe,EAAE,CAAC;CAC7B"}

package/lib/types/utils.d.ts

@@ -0,0 +1,2 @@
+export declare function kebabCaseToTitle(name: string): string;
+//# sourceMappingURL=utils.d.ts.map

package/lib/types/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,UAE5C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertesia/tools-sdk",
-  "version": "0.82.0",
+  "version": "0.82.2",
   "description": "Tools SDK - utilities for building remote tools",
   "type": "module",
   "types": "./lib/types/index.d.ts",
@@ -31,9 +31,9 @@
   },
   "dependencies": {
     "jose": "^6.0.11",
-    "@llumiverse/common": "0.25.0",
-    "@vertesia/common": "0.82.0",
-    "@vertesia/client": "0.82.0"
+    "@vertesia/client": "0.82.2",
+    "@vertesia/common": "0.82.2",
+    "@llumiverse/common": "0.25.1"
   },
   "repository": {
     "type": "git",