@optimizely-opal/opal-tools-sdk 0.1.6-dev → 0.1.9-dev

package/src/decorators.ts

@@ -20,6 +20,7 @@ interface ToolOptions {
   description: string;
   name: string;
   parameters?: ParameterDefinition[];
+  uiResource?: string;
 }
 
 /**
@@ -30,6 +31,7 @@ interface ToolOptions {
  *   - authRequirements: (Optional) Authentication requirements
  *     Format: { provider: "oauth_provider", scopeBundle: "permissions_scope", required: true }
  *     Example: { provider: "google", scopeBundle: "calendar", required: true }
+ *   - uiResource: (Optional) URI of associated UI resource for dynamic rendering (e.g., "ui://my-app/create-form")
  *
  * Note: If your tool requires authentication, define your handler function with two parameters:
  * ```
@@ -87,6 +89,8 @@ export function tool(options: ToolOptions) {
         parameters,
         endpoint,
         authRequirements,
+        false,
+        options.uiResource,
       );
     }
 

package/src/index.ts

@@ -1,10 +1,11 @@
 import "reflect-metadata";
 
 export { requiresAuth } from "./auth";
-export { Block, isBlockResponse } from "./block";
-export type * from "./block";
 export { tool } from "./decorators";
 export * from "./models";
+export { UI } from "./proteus";
+export type * from "./proteus";
+export { registerResource } from "./registerResource";
 export { registerTool } from "./registerTool";
 export type { RequestHandlerExtra } from "./registerTool";
 export { ToolsService } from "./service";

package/src/models.ts

@@ -80,6 +80,7 @@ export class Function {
    * @param parameters Function parameters
    * @param endpoint API endpoint
    * @param authRequirements Authentication requirements (optional)
+   * @param uiResource URI of associated UI resource for dynamic rendering (optional)
    */
   constructor(
     public name: string,
@@ -87,6 +88,7 @@ export class Function {
     public parameters: Parameter[],
     public endpoint: string,
     public authRequirements?: AuthRequirement[],
+    public uiResource?: string,
   ) {}
 
   /**
@@ -108,6 +110,10 @@ export class Function {
       );
     }
 
+    if (this.uiResource !== undefined) {
+      result.ui_resource = this.uiResource;
+    }
+
     return result;
   }
 }
@@ -303,3 +309,24 @@ export class Parameter {
     };
   }
 }
+
+/**
+ * Resource definition for MCP resources
+ */
+export class Resource {
+  /**
+   * Create a new resource definition
+   * @param uri The unique URI for this resource (e.g., "ui://my-app/create-form")
+   * @param name Name of the resource
+   * @param description Description of the resource (optional)
+   * @param mimeType MIME type of the resource content (optional)
+   * @param title Human-readable title for the resource (optional)
+   */
+  constructor(
+    public uri: string,
+    public name: string,
+    public description?: string,
+    public mimeType?: string,
+    public title?: string,
+  ) {}
+}