working towards serverless agents

package.json

@@ -1,6 +1,6 @@
 {
   "name": "agent-adapters",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Configurable AI Agents",
   "license": "MPL-2.0",
   "main": "dist/index.js",
@@ -41,9 +41,16 @@
     "url": "https://github.com/nalbion/agent-adapters/issues"
   },
   "homepage": "https://github.com/nalbion/agent-adapters#readme",
+  "files": [
+    "dist/",
+    "README.md",
+    "package.json",
+    "LICENSE.txt"
+  ],
   "dependencies": {
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
+    "any-cloud-storage": "^1.0.3",
     "js-yaml": "^4.1.0",
     "rimraf": "^5.0.5",
     "yaml-ast-parser": "^0.0.43"

src/agents/adapters/AgentProtocolServer.ts

@@ -9,6 +9,17 @@ import { AgentConfig } from '../../types';
 
 type AgentConfigWithRequiredServer = Required<Pick<AgentConfig, 'server'>> & Partial<Omit<AgentConfig, 'server'>>;
 
+/**
+ * Runs as a singleton service, listening for Agent Protocol requests.
+ *
+ * If `config.server.port` is provided, it will start a server to listen for incoming requests.
+ * Otherwise, serverless Agents need to manually call `createServerless` and provide to the Serverless provider.
+ *
+ * @see ./firebase, google-cloud, lambda
+ * @see https://github.com/AI-Engineer-Foundation/agent-protocol/pull/99
+ * @see https://github.com/AI-Engineer-Foundation/agent-protocol/pull/103
+ * @see https://github.com/AI-Engineer-Foundation/agent-protocol/pull/104
+ */
 export default class AgentProtocolServer extends Agent {
   private static instance: AgentProtocolServer | undefined;
   private taskContexts: Map<string, AgentProtocolContext> = new Map();

src/agents/adapters/agentprotocol/agentprotocol.ts

@@ -2,6 +2,7 @@ import Agent, { type StepHandler, type StepInput, type StepResult, type TaskInpu
 import AgentProtocolServer from '../AgentProtocolServer';
 import { logger } from '../../../utils/Logger';
 import { AgentResponseStatus } from '../../types/AgentResponse';
+import { FileStorage } from 'any-cloud-storage';
 
 /**
  * Handles incoming requests: POST /ap/v1/agent/task
@@ -37,13 +38,36 @@ export const startServer = (config: { port?: number; workspace?: string }) => {
   apAgent.start();
 };
 
-export const createServerless = (config: {
+type ServerRequestHandler<R, S> = (request: R, response: S) => void | Promise<void>;
+type BuildServerConfig = {
+  workspace?: string;
   // Waiting on https://github.com/AI-Engineer-Foundation/agent-protocol/pull/100
   // artifactStorage: ArtifactStorage;
-}) => {
+};
+
+const buildServer = (config: BuildServerConfig) => {
   apAgent = Agent.handleTask(taskHandler, config);
   // Waiting on https://github.com/AI-Engineer-Foundation/agent-protocol/pull/99
-  // return agent.build();
+  const apHandler = (apAgent as any).build() as ServerRequestHandler<R, S>; // the Express app
+  apAgent.start();
+  return apHandler;
+};
+
+export const createServerless = <R = Request, S = Response>(
+  config: BuildServerConfig,
+  promisedStorage?: Promise<FileStorage>,
+) => {
+  if (promisedStorage) {
+    const promisedHandler = promisedStorage.then((storage) => {
+      // config.artifactStorage = ArtifactStorageFactory.create(config.artifactStorage);
+      // config.artifactStorage = new AnyCloudArtifactStorage(storage);
+      return buildServer(config);
+    });
+
+    return (request: R, response: S) => promisedHandler.then((handler) => handler(request, response));
+  }
+
+  return buildServer(config);
 };
 
 // type Artifact = {

src/agents/adapters/agentprotocol/firebase.ts

@@ -1,7 +1,13 @@
-import { onRequest } from 'firebase-functions/v2/https';
+import { Request, onRequest } from 'firebase-functions/v2/https';
 import { createServerless } from './agentprotocol';
+import { useAnyCloudStorage } from '../../../utils/fileStorage';
 
-const app = createServerless({
-  // artifactStorage: new FirebaseStorage(storage),
-});
-// export const agentprotocol = onRequest(app);
+const promisedStorage = useAnyCloudStorage({ type: 'firebase', bucket: 'my-bucket' });
+
+const app = createServerless<Request, Express.Response>(
+  {
+    // artifactStorage: new AnyCloudArtifactStorage(storage),
+  },
+  promisedStorage,
+);
+export const agentprotocol = onRequest(app);

src/agents/adapters/agentprotocol/google-cloud.ts

@@ -1,7 +1,13 @@
 import functions from '@google-cloud/functions-framework';
 import { createServerless } from './agentprotocol';
+import { useAnyCloudStorage } from '../../../utils/fileStorage';
 
-const app = createServerless({
-  // artifactStorage: new GcpStorage(storage, "my-agent-artifacts")
-});
+const promisedStorage = useAnyCloudStorage({ type: 'gcp', bucket: 'my-bucket' });
+
+const app = createServerless(
+  {
+    // artifactStorage: new AnyCloudArtifactStorage(storage)
+  },
+  promisedStorage,
+);
 // functions.http('agentprotocol', app);

src/agents/adapters/agentprotocol/lambda.ts

@@ -1,10 +1,16 @@
 import awsServerlessExpress from 'aws-serverless-express';
 import { createServerless } from './agentprotocol';
 import { APIGatewayProxyEvent, Context } from 'aws-lambda';
+import { useAnyCloudStorage } from '../../../utils/fileStorage';
 
-const app = createServerless({
-  // artifactStorage: new S3Storage(s3, 'my-agent-artifacts'),
-});
+const promisedStorage = useAnyCloudStorage({ type: 's3', bucket: 'my-bucket' });
+
+const app = createServerless(
+  {
+    // artifactStorage: new AnyCloudArtifactStorage(storage),
+  },
+  promisedStorage,
+);
 // const server = awsServerlessExpress.createServer(app);
 
 // exports.handler = (event: APIGatewayProxyEvent, context: Context) => {

src/tools/impl/write_file.ts

@@ -1,8 +1,8 @@
 import path from 'path';
 import { ToolManager } from '../ToolManager';
 import { ToolContext } from '../tool_types';
-import { mkdirSync, writeFileSync } from 'fs';
 import { getAbsolutePathInWorkspace } from '../../utils/fileUtils';
+import { fileStorage } from '../../utils/fileStorage';
 
 export const TOOL_WRITE_FILE = 'write_file';
 
@@ -11,12 +11,11 @@ export const TOOL_WRITE_FILE = 'write_file';
  * @param filename The name of the file to write
  * @param contents The contents of the file to write
  */
-const write_file = (context: ToolContext, filename: string, contents: string) => {
+const write_file = async (context: ToolContext, filename: string, contents: string) => {
   const filePath = getAbsolutePathInWorkspace(context.workspaceFolder, filename);
-  const dir = path.dirname(filePath);
-  // TODO: abstract to ArtifactStorage - https://github.com/AI-Engineer-Foundation/agent-protocol/pull/100
-  mkdirSync(dir, { recursive: true });
-  writeFileSync(filePath, contents, { encoding: 'utf-8' });
+
+  await fileStorage.saveTextFile(filePath, contents);
+
   context.onProgress({ type: 'inlineContentReference', title: filename, inlineReference: filePath });
 };
 

src/tools/tool_types.ts

@@ -13,4 +13,4 @@ export type ToolConfig = {
 export type ToolCallback = (
   context: ToolContext,
   ...parameters: any
-) => string | undefined | void | Promise<string | undefined>;
+) => string | undefined | void | Promise<string | undefined | void>;

src/types/AgentsYml.ts

@@ -1,5 +1,6 @@
 /* eslint-disable */
 
+import { FileStorageConfig } from 'any-cloud-storage';
 import { AIConfigRootMetadata, AiConfigPrompt, ModelSettings } from './AIConfig';
 
 /**
@@ -100,6 +101,9 @@ export interface AgentConfig {
     port?: number;
     /** @default './workspace' */
     workspace?: string;
+
+    /** By default, files will be saved to disk, but serverless agents can use alternatives using `any-cloud-storage` */
+    storage?: FileStorageConfig;
   };
 
   /**

src/utils/fileStorage.ts

@@ -0,0 +1,8 @@
+import createStorage, { FileStorage, FileStorageConfig, LocalFileStorage } from 'any-cloud-storage';
+
+export let fileStorage: FileStorage = new LocalFileStorage({ type: 'file', basePath: '' });
+
+export const useAnyCloudStorage = async (config: FileStorageConfig) => {
+  fileStorage = await createStorage(config);
+  return fileStorage;
+};

tsconfig.json

@@ -5,6 +5,7 @@
     "rootDir": "src",
     "outDir": "./dist",
     "sourceMap": true,
+    "declaration": true,
     "strict": true,
     "lib": ["ES2022"],
     "types": ["node", "jest"],