npm - @openserv-labs/sdk - Versions diffs - 2.0.1 → 2.2.0 - Mend

@openserv-labs/sdk 2.0.1 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/README.md CHANGED Viewed

@@ -320,6 +320,7 @@ agent.start()
 | `PORT`                | Server port                                | No       | 7378                               |
 | `OPENSERV_AUTH_TOKEN` | Token for authenticating incoming requests | No       | -                                  |
 | `OPENSERV_PROXY_URL`  | Custom proxy URL for tunnel connections    | No       | `https://agents-proxy.openserv.ai` |
+| `DISABLE_TUNNEL`      | Skip tunnel and run HTTP server only       | No       | -                                  |
 \*Required if using OpenAI integration features
@@ -794,12 +795,15 @@ The `run()` function automatically:
 #### Tunnel vs. Deployed Endpoint
-| Aspect            | Tunnel (Local Development) | Deployed Endpoint (Production) |
-| ----------------- | -------------------------- | ------------------------------ |
-| Setup             | Just run your code         | Deploy to cloud/server         |
-| URL Configuration | Not needed                 | Set Agent Endpoint in platform |
-| Connection        | WebSocket via proxy        | Direct HTTP                    |
-| Use case          | Development & testing      | Production                     |
+| Aspect            | Tunnel (Local Development) | Deployed Endpoint (Production)       |
+| ----------------- | -------------------------- | ------------------------------------ |
+| Setup             | Just run your code         | Deploy to cloud/server               |
+| URL Configuration | Not needed                 | Set Agent Endpoint in platform       |
+| Connection        | WebSocket via proxy        | Direct HTTP                          |
+| Tunnel            | Enabled (default)          | Disabled (`DISABLE_TUNNEL=true`)     |
+| Use case          | Development & testing      | Production                           |
+When deploying to a hosting provider like Cloud Run, set `DISABLE_TUNNEL=true` as an environment variable. This makes `run()` start only the HTTP server without opening a WebSocket tunnel to the proxy — the platform reaches your agent directly at its public URL.
 #### Configuration Options

package/dist/agent.d.ts CHANGED Viewed

@@ -19,6 +19,12 @@ export interface AgentOptions<T extends string> {
      * Can also be provided via OPENSERV_API_KEY environment variable.
      */
     apiKey?: string;
+    /**
+     * The auth token for securing agent requests.
+     * Can also be provided via OPENSERV_AUTH_TOKEN environment variable.
+     * Generated by provision() and used to validate incoming requests.
+     */
+    authToken?: string;
     /**
      * The system prompt that defines the agent's behavior and context.
      * Used as the initial system message in OpenAI chat completions.
@@ -82,25 +88,46 @@ export declare class Agent<M extends string = string> {
     protected tools: Array<Capability<M, z.ZodTypeAny>>;
     /**
      * The OpenServ API key used for authentication.
-     * Can be provided in options or via OPENSERV_API_KEY environment variable.
-     * @private
+     * Set via setCredentials() or resolved from options/env in start().
      */
-    private _apiKey;
+    apiKey?: string;
     /**
-     * Gets the OpenServ API key for this agent instance.
-     * Used by run() to pass the correct key to the tunnel.
-     * @returns The API key for this agent
+     * The auth token used to validate incoming requests.
+     * Set via setCredentials() or resolved from options/env in start().
+     */
+    authToken?: string;
+    /**
+     * Set credentials for this agent instance.
+     * This is typically called by provision() to bind the agent to its platform credentials.
+     *
+     * @param credentials - The credentials to set
+     * @param credentials.apiKey - The OpenServ API key for this agent
+     * @param credentials.authToken - Optional auth token for securing agent requests
+     *
+     * @example
+     * ```typescript
+     * // Typically called by provision() automatically:
+     * await provision({
+     *   agent: { instance: myAgent, name: 'my-agent', ... }
+     * })
+     *
+     * // Or manually:
+     * agent.setCredentials({ apiKey: 'key', authToken: 'token' })
+     * ```
      */
-    get apiKey(): string;
+    setCredentials(credentials: {
+        apiKey: string;
+        authToken?: string;
+    }): void;
     /**
      * Axios instance for making requests to the OpenServ API.
-     * Pre-configured with base URL and authentication headers.
+     * Initialized in start() after credentials are resolved.
      * @private
      */
     private apiClient;
     /**
      * Axios instance for making requests to the OpenServ Runtime API.
-     * Pre-configured with base URL and authentication headers.
+     * Initialized in start() after credentials are resolved.
      * @protected
      */
     protected runtimeClient: AxiosInstance;
@@ -132,11 +159,9 @@ export declare class Agent<M extends string = string> {
     private get openai();
     /**
      * Creates a new Agent instance.
-     * Sets up the Express application, middleware, and routes.
-     * Initializes API clients with appropriate authentication.
+     * The agent is configured but not started until start() is called.
      *
      * @param {AgentOptions} options - Configuration options for the agent
-     * @throws {Error} If OpenServ API key is not provided in options or environment
      */
     constructor(options: AgentOptions<M>);
     private initializeMCPClients;
@@ -404,17 +429,17 @@ export declare class Agent<M extends string = string> {
         body: unknown;
     }): Promise<void>;
     /**
-     * Sets up the Express routes for the agent's HTTP server.
-     * Configures health check endpoint and routes for tool execution.
+     * Defines routes on the router (called in constructor).
+     * Routes are attached to the app in start() after middleware is configured.
      * @private
      */
-    private setupRoutes;
+    private defineRoutes;
     /**
      * Starts the agent's HTTP server.
      * If the preferred port is unavailable, it will find an open port.
      *
      * @returns {Promise<void>} Resolves when the server has started
-     * @throws {Error} If server fails to start
+     * @throws {Error} If server fails to start or if API key is missing
      */
     start(): Promise<void>;
     /**

package/dist/agent.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"agent.d.ts","sourceRoot":"","sources":["../src/agent.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,KAAK,aAAa,EAAE,MAAM,OAAO,CAAA;AAUjD,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,uBAAuB,EACvB,kBAAkB,EAClB,qBAAqB,EACrB,mBAAmB,EACnB,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,4BAA4B,EAC5B,sBAAsB,EACtB,aAAa,EACb,sBAAsB,EACtB,qBAAqB,EACrB,yBAAyB,EACzB,gBAAgB,EAEhB,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,qBAAqB,EACrB,iBAAiB,EACjB,gBAAgB,EAChB,kBAAkB,EAOlB,YAAY,EACZ,kBAAkB,EAClB,8BAA8B,EAC/B,MAAM,SAAS,CAAA;AAEhB,OAAO,KAAK,EACV,0BAA0B,EAE1B,cAAc,EACf,MAAM,mCAAmC,CAAA;AAI1C,OAAO,MAAM,MAAM,QAAQ,CAAA;AAC3B,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAGL,KAAK,eAAe,EAEpB,SAAS,EACV,MAAM,OAAO,CAAA;~~AAOd~~;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,MAAM;IAC5C;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAA;IAEnE;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,eAAe,CAAC,CAAA;CACxC;~~AAoBD~~,qBAAa,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;~~IAmI9B~~,OAAO,CAAC,OAAO;~~IAlI3B~~;;;;OAIG;IACH,OAAO,CAAC,GAAG,CAAqB;IAEhC;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAA2B;IAEzC;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAqB;IAEnC;;;;OAIG;IACI,IAAI,EAAE,MAAM,CAAA;IAEnB;;;;OAIG;IACH,SAAS,CAAC,YAAY,EAAE,MAAM,CAAA;IAE9B;;;;OAIG;IACH,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,CAAK;IAExD~~;;;;OAIG~~;~~IACH~~,~~OAAO~~,CAAC,~~OAAO~~,~~CAAQ~~;~~IAEvB;;;;OAIG~~;IACH,~~IAAI~~,MAAM,~~IAAI~~,MAAM,~~CAEnB~~;~~IAED~~;;;;OAIG;IACH,OAAO,CAAC,SAAS,~~CAAe~~;~~IAEhC~~;;;;OAIG;IACH,SAAS,CAAC,aAAa,~~EAAE~~,aAAa,CAAA;~~IAEtC~~;;;;OAIG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IAE1B;;;OAGG;IACI,UAAU,EAAE,MAAM,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAgC;IAE1E;;;;;OAKG;IACH,OAAO,KAAK,WAAW,GAStB;IAED;;;;;;OAMG;IACH,OAAO,KAAK,MAAM,GAWjB;IAED~~;;;;;;;OAOG~~;gBACiB,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC;~~IAgD5C~~,OAAO,CAAC,oBAAoB;IAgB5B;;;;;;;;;;;;;;;;OAgBG;IACH,aAAa,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,EACpC,IAAI,EACJ,WAAW,EACX,MAAM,EACN,GAAG,EACJ,EAAE;QACD,IAAI,EAAE,MAAM,CAAA;QACZ,WAAW,EAAE,MAAM,CAAA;QACnB,MAAM,EAAE,CAAC,CAAA;QACT,GAAG,CACD,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EACd,MAAM,EAAE;YAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAAC,MAAM,CAAC,EAAE,YAAY,CAAA;SAAE,EACnD,QAAQ,EAAE,0BAA0B,EAAE,GACrC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;KAC5B,GAAG,IAAI;IAYR;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,UAAU,EAAE,CAAC,EAAE,YAAY,EAAE;SACjF,CAAC,IAAI,MAAM,CAAC,GAAG;YACd,IAAI,EAAE,MAAM,CAAA;YACZ,WAAW,EAAE,MAAM,CAAA;YACnB,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;YACZ,GAAG,CACD,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EACd,MAAM,EAAE;gBAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAAC,MAAM,CAAC,EAAE,YAAY,CAAA;aAAE,EACtD,QAAQ,EAAE,0BAA0B,EAAE,GACrC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;SAC5B;KACF,GAAG,IAAI;IAOR;;;;;;OAMG;IACG,QAAQ,CAAC,MAAM,EAAE,cAAc;IAOrC;;;;;OAKG;IACG,UAAU,CAAC,MAAM,EAAE,gBAAgB;IAOzC;;;;;OAKG;IACG,cAAc,CAAC,MAAM,EAAE,oBAAoB;IAOjD;;;;;;;;;;OAUG;IACG,UAAU,CAAC,MAAM,EAAE,gBAAgB;IA6BzC;;;;;;;OAOG;IACG,UAAU,CAAC,MAAM,EAAE,gBAAgB;IAOzC;;;;;;;;OAQG;IACG,iBAAiB,CAAC,MAAM,EAAE,uBAAuB;IAUvD;;;;;;;;OAQG;IACG,YAAY,CAAC,MAAM,EAAE,kBAAkB;IAU7C;;;;;;;;OAQG;IACG,eAAe,CAAC,MAAM,EAAE,qBAAqB;IAUnD;;;;;;;OAOG;IACG,aAAa,CAAC,MAAM,EAAE,mBAAmB;IAO/C;;;;;;OAMG;IACG,SAAS,CAAC,MAAM,EAAE,eAAe;IAOvC;;;;;;OAMG;IACG,QAAQ,CAAC,MAAM,EAAE,cAAc;IAOrC;;;;;;;OAOG;IACG,eAAe,CAAC,MAAM,EAAE,qBAAqB;IAOnD;;;;;;;;;;;;OAYG;IACG,UAAU,CAAC,MAAM,EAAE,gBAAgB;IAezC;;;;;;;;;;OAUG;IACG,YAAY,CAAC,MAAM,EAAE,kBAAkB;IAY7C;;;;;;;;;;OAUG;IACG,sBAAsB,CAAC,MAAM,EAAE,4BAA4B;IA0BjE;;;;;;;;OAQG;IACG,gBAAgB,CAAC,MAAM,EAAE,sBAAsB;IAUrD;;;;;;;OAOG;IACG,OAAO,CAAC,EAAE,QAAQ,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IA4FnE;;;;OAIG;cACa,MAAM,CAAC,MAAM,EAAE,kBAAkB;IA6BjD;;;;OAIG;cACa,aAAa,CAAC,MAAM,EAAE,8BAA8B;IA+BpE;;;;;;;;;;;;;OAaG;IACG,eAAe,CAAC,GAAG,EAAE;QACzB,MAAM,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAA;SAAE,CAAA;QAC5B,IAAI,EAAE;YACJ,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,CAAA;YAC5B,MAAM,CAAC,EAAE,YAAY,CAAA;YACrB,QAAQ,CAAC,EAAE,0BAA0B,EAAE,CAAA;SACxC,CAAA;KACF;;;IAyBD;;;;;;;OAOG;IACG,eAAe,CAAC,GAAG,EAAE;QAAE,IAAI,EAAE,OAAO,CAAA;KAAE;IAgB5C;;;;OAIG;IACH,OAAO,CAAC,~~WAAW~~;~~IAuBnB~~;;;;;;OAMG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;~~IAqF5B~~;;;;OAIG;IACG,IAAI;IAQV;;;OAGG;IACH,OAAO,CAAC,WAAW;IAOnB;;;;;;;;;;;;;OAaG;IACG,eAAe,CAAC,WAAW,EAAE,sBAAsB;IASzD;;;;;;;;OAQG;IACH,OAAO,CAAC,yBAAyB;CAsClC"}
1	+ {"version":3,"file":"agent.d.ts","sourceRoot":"","sources":["../src/agent.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,KAAK,aAAa,EAAE,MAAM,OAAO,CAAA;AAUjD,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,uBAAuB,EACvB,kBAAkB,EAClB,qBAAqB,EACrB,mBAAmB,EACnB,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,4BAA4B,EAC5B,sBAAsB,EACtB,aAAa,EACb,sBAAsB,EACtB,qBAAqB,EACrB,yBAAyB,EACzB,gBAAgB,EAEhB,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,qBAAqB,EACrB,iBAAiB,EACjB,gBAAgB,EAChB,kBAAkB,EAOlB,YAAY,EACZ,kBAAkB,EAClB,8BAA8B,EAC/B,MAAM,SAAS,CAAA;AAEhB,OAAO,KAAK,EACV,0BAA0B,EAE1B,cAAc,EACf,MAAM,mCAAmC,CAAA;AAI1C,OAAO,MAAM,MAAM,QAAQ,CAAA;AAC3B,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAGL,KAAK,eAAe,EAEpB,SAAS,EACV,MAAM,OAAO,CAAA;AAMd;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,MAAM;IAC5C;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAA;IAEnE;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,eAAe,CAAC,CAAA;CACxC;AAED,qBAAa,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IAqJ9B,OAAO,CAAC,OAAO;IApJ3B;;;;OAIG;IACH,OAAO,CAAC,GAAG,CAAqB;IAEhC;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAA2B;IAEzC;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAqB;IAEnC;;;;OAIG;IACI,IAAI,EAAE,MAAM,CAAA;IAEnB;;;;OAIG;IACH,SAAS,CAAC,YAAY,EAAE,MAAM,CAAA;IAE9B;;;;OAIG;IACH,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,CAAK;IAExD;;;OAGG;IACI,MAAM,CAAC,EAAE,MAAM,CAAA;IAEtB;;;OAGG;IACI,SAAS,CAAC,EAAE,MAAM,CAAA;IAEzB;;;;;;;;;;;;;;;;;;OAkBG;IACH,cAAc,CAAC,WAAW,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI;IAKzE;;;;OAIG;IACH,OAAO,CAAC,SAAS,CAAgB;IAEjC;;;;OAIG;IACH,SAAS,CAAC,aAAa,EAAG,aAAa,CAAA;IAEvC;;;;OAIG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IAE1B;;;OAGG;IACI,UAAU,EAAE,MAAM,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAgC;IAE1E;;;;;OAKG;IACH,OAAO,KAAK,WAAW,GAStB;IAED;;;;;;OAMG;IACH,OAAO,KAAK,MAAM,GAWjB;IAED;;;;;OAKG;gBACiB,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC;IAa5C,OAAO,CAAC,oBAAoB;IAgB5B;;;;;;;;;;;;;;;;OAgBG;IACH,aAAa,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,EACpC,IAAI,EACJ,WAAW,EACX,MAAM,EACN,GAAG,EACJ,EAAE;QACD,IAAI,EAAE,MAAM,CAAA;QACZ,WAAW,EAAE,MAAM,CAAA;QACnB,MAAM,EAAE,CAAC,CAAA;QACT,GAAG,CACD,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EACd,MAAM,EAAE;YAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAAC,MAAM,CAAC,EAAE,YAAY,CAAA;SAAE,EACnD,QAAQ,EAAE,0BAA0B,EAAE,GACrC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;KAC5B,GAAG,IAAI;IAYR;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,UAAU,EAAE,CAAC,EAAE,YAAY,EAAE;SACjF,CAAC,IAAI,MAAM,CAAC,GAAG;YACd,IAAI,EAAE,MAAM,CAAA;YACZ,WAAW,EAAE,MAAM,CAAA;YACnB,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;YACZ,GAAG,CACD,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EACd,MAAM,EAAE;gBAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAAC,MAAM,CAAC,EAAE,YAAY,CAAA;aAAE,EACtD,QAAQ,EAAE,0BAA0B,EAAE,GACrC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;SAC5B;KACF,GAAG,IAAI;IAOR;;;;;;OAMG;IACG,QAAQ,CAAC,MAAM,EAAE,cAAc;IAOrC;;;;;OAKG;IACG,UAAU,CAAC,MAAM,EAAE,gBAAgB;IAOzC;;;;;OAKG;IACG,cAAc,CAAC,MAAM,EAAE,oBAAoB;IAOjD;;;;;;;;;;OAUG;IACG,UAAU,CAAC,MAAM,EAAE,gBAAgB;IA6BzC;;;;;;;OAOG;IACG,UAAU,CAAC,MAAM,EAAE,gBAAgB;IAOzC;;;;;;;;OAQG;IACG,iBAAiB,CAAC,MAAM,EAAE,uBAAuB;IAUvD;;;;;;;;OAQG;IACG,YAAY,CAAC,MAAM,EAAE,kBAAkB;IAU7C;;;;;;;;OAQG;IACG,eAAe,CAAC,MAAM,EAAE,qBAAqB;IAUnD;;;;;;;OAOG;IACG,aAAa,CAAC,MAAM,EAAE,mBAAmB;IAO/C;;;;;;OAMG;IACG,SAAS,CAAC,MAAM,EAAE,eAAe;IAOvC;;;;;;OAMG;IACG,QAAQ,CAAC,MAAM,EAAE,cAAc;IAOrC;;;;;;;OAOG;IACG,eAAe,CAAC,MAAM,EAAE,qBAAqB;IAOnD;;;;;;;;;;;;OAYG;IACG,UAAU,CAAC,MAAM,EAAE,gBAAgB;IAezC;;;;;;;;;;OAUG;IACG,YAAY,CAAC,MAAM,EAAE,kBAAkB;IAY7C;;;;;;;;;;OAUG;IACG,sBAAsB,CAAC,MAAM,EAAE,4BAA4B;IA0BjE;;;;;;;;OAQG;IACG,gBAAgB,CAAC,MAAM,EAAE,sBAAsB;IAUrD;;;;;;;OAOG;IACG,OAAO,CAAC,EAAE,QAAQ,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IA4FnE;;;;OAIG;cACa,MAAM,CAAC,MAAM,EAAE,kBAAkB;IA6BjD;;;;OAIG;cACa,aAAa,CAAC,MAAM,EAAE,8BAA8B;IA+BpE;;;;;;;;;;;;;OAaG;IACG,eAAe,CAAC,GAAG,EAAE;QACzB,MAAM,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAA;SAAE,CAAA;QAC5B,IAAI,EAAE;YACJ,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,CAAA;YAC5B,MAAM,CAAC,EAAE,YAAY,CAAA;YACrB,QAAQ,CAAC,EAAE,0BAA0B,EAAE,CAAA;SACxC,CAAA;KACF;;;IAyBD;;;;;;;OAOG;IACG,eAAe,CAAC,GAAG,EAAE;QAAE,IAAI,EAAE,OAAO,CAAA;KAAE;IAgB5C;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAqBpB;;;;;;OAMG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAsJ5B;;;;OAIG;IACG,IAAI;IAQV;;;OAGG;IACH,OAAO,CAAC,WAAW;IAOnB;;;;;;;;;;;;;OAaG;IACG,eAAe,CAAC,WAAW,EAAE,sBAAsB;IASzD;;;;;;;;OAQG;IACH,OAAO,CAAC,yBAAyB;CAsClC"}

package/dist/agent.js CHANGED Viewed

@@ -21,20 +21,6 @@ const mcp_1 = require("./mcp");
 const PLATFORM_URL = process.env.OPENSERV_API_URL || 'https://api.openserv.ai';
 const RUNTIME_URL = process.env.OPENSERV_RUNTIME_URL || 'https://agents.openserv.ai';
 const DEFAULT_PORT = Number.parseInt(process.env.PORT || '') || 7378;
-const AUTH_TOKEN = process.env.OPENSERV_AUTH_TOKEN;
-const authTokenMiddleware = async (req, res, next) => {
-    const tokenHash = req.headers['x-openserv-auth-token'];
-    if (!tokenHash || typeof tokenHash !== 'string') {
-        res.status(401).json({ error: 'Unauthorized' });
-        return;
-    }
-    const isTokenValid = await bcryptjs_1.default.compare(AUTH_TOKEN, tokenHash);
-    if (!isTokenValid) {
-        res.status(401).json({ error: 'Unauthorized' });
-        return;
-    }
-    next();
-};
 class Agent {
     options;
     /**
@@ -75,27 +61,46 @@ class Agent {
     tools = [];
     /**
      * The OpenServ API key used for authentication.
-     * Can be provided in options or via OPENSERV_API_KEY environment variable.
-     * @private
+     * Set via setCredentials() or resolved from options/env in start().
+     */
+    apiKey;
+    /**
+     * The auth token used to validate incoming requests.
+     * Set via setCredentials() or resolved from options/env in start().
      */
-    _apiKey;
+    authToken;
     /**
-     * Gets the OpenServ API key for this agent instance.
-     * Used by run() to pass the correct key to the tunnel.
-     * @returns The API key for this agent
+     * Set credentials for this agent instance.
+     * This is typically called by provision() to bind the agent to its platform credentials.
+     *
+     * @param credentials - The credentials to set
+     * @param credentials.apiKey - The OpenServ API key for this agent
+     * @param credentials.authToken - Optional auth token for securing agent requests
+     *
+     * @example
+     * ```typescript
+     * // Typically called by provision() automatically:
+     * await provision({
+     *   agent: { instance: myAgent, name: 'my-agent', ... }
+     * })
+     *
+     * // Or manually:
+     * agent.setCredentials({ apiKey: 'key', authToken: 'token' })
+     * ```
      */
-    get apiKey() {
-        return this._apiKey;
+    setCredentials(credentials) {
+        this.apiKey = credentials.apiKey;
+        this.authToken = credentials.authToken;
     }
     /**
      * Axios instance for making requests to the OpenServ API.
-     * Pre-configured with base URL and authentication headers.
+     * Initialized in start() after credentials are resolved.
      * @private
      */
     apiClient;
     /**
      * Axios instance for making requests to the OpenServ Runtime API.
-     * Pre-configured with base URL and authentication headers.
+     * Initialized in start() after credentials are resolved.
      * @protected
      */
     runtimeClient;
@@ -145,11 +150,9 @@ class Agent {
     }
     /**
      * Creates a new Agent instance.
-     * Sets up the Express application, middleware, and routes.
-     * Initializes API clients with appropriate authentication.
+     * The agent is configured but not started until start() is called.
      *
      * @param {AgentOptions} options - Configuration options for the agent
-     * @throws {Error} If OpenServ API key is not provided in options or environment
      */
     constructor(options) {
         this.options = options;
@@ -157,39 +160,10 @@ class Agent {
         this.router = (0, express_async_router_1.AsyncRouter)();
         this.port = this.options.port || DEFAULT_PORT;
         this.systemPrompt = this.options.systemPrompt;
-        this._apiKey = this.options.apiKey || process.env.OPENSERV_API_KEY || '';
-        if (!this._apiKey) {
-            throw new Error('OpenServ API key is required. Please provide it in options or set OPENSERV_API_KEY environment variable.');
-        }
-        // Initialize API client
-        this.apiClient = axios_1.default.create({
-            baseURL: PLATFORM_URL,
-            headers: {
-                'Content-Type': 'application/json',
-                'x-openserv-key': this.apiKey
-            }
-        });
-        // Initialize runtime client
-        this.runtimeClient = axios_1.default.create({
-            baseURL: `${RUNTIME_URL}/runtime`,
-            headers: {
-                'Content-Type': 'application/json',
-                'x-openserv-key': this.apiKey
-            }
-        });
-        this.app.use(express_1.default.json({ limit: '10mb' }));
-        this.app.use(express_1.default.urlencoded({ extended: false }));
-        this.app.use((0, hpp_1.default)());
-        this.app.use((0, helmet_1.default)());
-        this.app.use((0, compression_1.default)());
-        if (AUTH_TOKEN) {
-            this.app.use(authTokenMiddleware);
-        }
-        else {
-            logger_1.logger.warn('OPENSERV_AUTH_TOKEN is not set. All requests will be allowed.');
-        }
-        this.setupRoutes();
+        // Initialize MCP clients (no credentials needed)
         this.initializeMCPClients();
+        // Define routes (they'll be attached to app in start())
+        this.defineRoutes();
     }
     initializeMCPClients() {
         if (this.options.mcpServers) {
@@ -720,11 +694,11 @@ class Agent {
         }
     }
     /**
-     * Sets up the Express routes for the agent's HTTP server.
-     * Configures health check endpoint and routes for tool execution.
+     * Defines routes on the router (called in constructor).
+     * Routes are attached to the app in start() after middleware is configured.
      * @private
      */
-    setupRoutes() {
+    defineRoutes() {
         this.router.get('/health', async (_req, res) => {
             res.status(200).json({ status: 'ok', uptime: process.uptime() });
         });
@@ -741,16 +715,68 @@ class Agent {
                 body: req.body
             });
         });
-        this.app.use('/', this.router);
     }
     /**
      * Starts the agent's HTTP server.
      * If the preferred port is unavailable, it will find an open port.
      *
      * @returns {Promise<void>} Resolves when the server has started
-     * @throws {Error} If server fails to start
+     * @throws {Error} If server fails to start or if API key is missing
      */
     async start() {
+        // Resolve credentials from options or environment if not already set via setCredentials()
+        if (!this.apiKey) {
+            this.apiKey = this.options.apiKey || process.env.OPENSERV_API_KEY;
+        }
+        if (!this.authToken) {
+            this.authToken = this.options.authToken || process.env.OPENSERV_AUTH_TOKEN;
+        }
+        // Validate API key
+        if (!this.apiKey) {
+            throw new Error('OpenServ API key is required. Please provide it in options, set OPENSERV_API_KEY environment variable, or call provision() first.');
+        }
+        // Initialize API clients
+        this.apiClient = axios_1.default.create({
+            baseURL: PLATFORM_URL,
+            headers: {
+                'Content-Type': 'application/json',
+                'x-openserv-key': this.apiKey
+            }
+        });
+        this.runtimeClient = axios_1.default.create({
+            baseURL: `${RUNTIME_URL}/runtime`,
+            headers: {
+                'Content-Type': 'application/json',
+                'x-openserv-key': this.apiKey
+            }
+        });
+        // Set up middleware
+        this.app.use(express_1.default.json({ limit: '10mb' }));
+        this.app.use(express_1.default.urlencoded({ extended: false }));
+        this.app.use((0, hpp_1.default)());
+        this.app.use((0, helmet_1.default)());
+        this.app.use((0, compression_1.default)());
+        // Auth middleware
+        if (this.authToken) {
+            this.app.use(async (req, res, next) => {
+                const tokenHash = req.headers['x-openserv-auth-token'];
+                if (!tokenHash || typeof tokenHash !== 'string') {
+                    res.status(401).json({ error: 'Unauthorized' });
+                    return;
+                }
+                const isTokenValid = await bcryptjs_1.default.compare(this.authToken, tokenHash);
+                if (!isTokenValid) {
+                    res.status(401).json({ error: 'Unauthorized' });
+                    return;
+                }
+                next();
+            });
+        }
+        else {
+            logger_1.logger.warn('OPENSERV_AUTH_TOKEN is not set. All requests will be allowed.');
+        }
+        // Attach routes to app (routes are defined in constructor)
+        this.app.use('/', this.router);
         const preferredPort = this.port;
         // Try the preferred port first, fallback to an available port if it fails
         await new Promise((resolve, reject) => {

package/dist/run.d.ts CHANGED Viewed

@@ -15,8 +15,9 @@ export interface RunOptions {
 export interface RunResult {
     /**
      * The tunnel instance for advanced control.
+     * Null when the tunnel is disabled (DISABLE_TUNNEL=true).
      */
-    tunnel: OpenServTunnel;
+    tunnel: OpenServTunnel | null;
     /**
      * Stop the agent and tunnel.
      */

package/dist/run.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../src/run.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAEpC,OAAO,EAAE,cAAc,EAAE,KAAK,qBAAqB,EAAE,MAAM,UAAU,CAAA;AAMrE,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC,qBAAqB,EAAE,aAAa,GAAG,WAAW,GAAG,SAAS,CAAC,CAAA;IAE7E;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB;AAED,MAAM,WAAW,SAAS;IACxB~~;;OAEG~~;IACH,MAAM,EAAE,cAAc,CAAA;~~IAEtB~~;;OAEG;IACH,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAC1B;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAsB,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,~~CA8EhF~~"}
1	+ {"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../src/run.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAEpC,OAAO,EAAE,cAAc,EAAE,KAAK,qBAAqB,EAAE,MAAM,UAAU,CAAA;AAMrE,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC,qBAAqB,EAAE,aAAa,GAAG,WAAW,GAAG,SAAS,CAAC,CAAA;IAE7E;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB;AAED,MAAM,WAAW,SAAS;IACxB;;;OAGG;IACH,MAAM,EAAE,cAAc,GAAG,IAAI,CAAA;IAE7B;;OAEG;IACH,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAC1B;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAsB,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,CAsFhF"}

package/dist/run.js CHANGED Viewed

@@ -40,27 +40,34 @@ const tunnel_1 = require("./tunnel");
  */
 async function run(agent, options) {
     await agent.start();
-    const tunnel = new tunnel_1.OpenServTunnel({
-        ...options?.tunnel,
-        // Always use the agent's API key to ensure tunnel authenticates as the correct agent
-        // This prevents issues when running multiple agents with different API keys
-        apiKey: agent.apiKey,
-        onConnected: isReconnect => {
-            if (!isReconnect) {
-                logger_1.logger.info('Agent connected to OpenServ proxy');
+    const tunnelDisabled = process.env.DISABLE_TUNNEL === 'true';
+    let tunnel = null;
+    if (!tunnelDisabled) {
+        tunnel = new tunnel_1.OpenServTunnel({
+            ...options?.tunnel,
+            // Always use the agent's API key to ensure tunnel authenticates as the correct agent
+            // This prevents issues when running multiple agents with different API keys
+            apiKey: agent.apiKey,
+            onConnected: isReconnect => {
+                if (!isReconnect) {
+                    logger_1.logger.info('Agent connected to OpenServ proxy');
+                }
+            },
+            onError: error => {
+                logger_1.logger.error(`Tunnel error: ${error.message}`);
             }
-        },
-        onError: error => {
-            logger_1.logger.error(`Tunnel error: ${error.message}`);
+        });
+        try {
+            await tunnel.start(agent.port);
+        }
+        catch (error) {
+            // Clean up the agent if tunnel fails to connect
+            await agent.stop();
+            throw error;
         }
-    });
-    try {
-        await tunnel.start(agent.port);
     }
-    catch (error) {
-        // Clean up the agent if tunnel fails to connect
-        await agent.stop();
-        throw error;
+    else {
+        logger_1.logger.info(`Agent running on port ${agent.port} (tunnel disabled)`);
     }
     let shutdownPromise = null;
     let sigtermHandler = null;
@@ -80,7 +87,8 @@ async function run(agent, options) {
                 process.removeListener('SIGINT', sigintHandler);
                 sigintHandler = null;
             }
-            await tunnel.stop();
+            if (tunnel)
+                await tunnel.stop();
             await agent.stop();
         })();
         return shutdownPromise;

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@openserv-labs/sdk",
-  "version": "2.0.1",
+  "version": "2.2.0",
   "description": "OpenServ Agent SDK - Create AI agents easily",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",