Support some basic .well-known endpoints by default for LLM integration

Author: keithwhor

lib/gateway.js

@@ -226,6 +226,24 @@ class Gateway extends EventEmitter {
     );
   }
 
+  __wellKnownError__ (req, res, message, status, headers) {
+    headers = headers || {};
+    headers = this.__createHeaders__(req, headers);
+    headers['content-type'] = 'application/json';
+    return this.__endRequest__(
+      status || 403,
+      this.__formatHeaders__(headers),
+      req,
+      res,
+      JSON.stringify({
+        error: {
+          type: 'WellKnownError',
+          message: message
+        }
+      })
+    );
+  }
+
   __clientError__ (req, res, message, status, headers) {
     headers = headers || {};
     headers = this.__createHeaders__(req, headers);
@@ -1315,17 +1333,25 @@ class Gateway extends EventEmitter {
         if (definition.hasOwnProperty('wellKnown')) {
           const wellKnown = definition.wellKnown;
           const definitions = definition.definitions;
+          const pluginSupported = !!data.pluginSupported;
+          const pluginAuthorized = !!data.pluginAuthorized;
+          if (!pluginSupported) {
+            return this.__wellKnownError__(req, res, `Plugin not supported for this service`, 404);
+          } else if (!pluginAuthorized) {
+            return this.__wellKnownError__(req, res, `Plugin access not authorized`, 403);
+          }
+          let plugin;
+          try {
+            plugin = wellKnowns.validatePlugin(data.plugin);
+          } catch (e) {
+            return this.__wellKnownError__(req, res, `Failed to validate plugin: ${e.message}`, 502);
+          }
+          const server = data.server;
+          const origin = data.origin;
+          const identifier = data.identifier;
           let httpResponse;
           try {
-            if (wellKnown === 'ai-plugin') {
-              httpResponse = this.wellKnownAIPlugin(definitions, data);
-            } else if (wellKnown === 'api') {
-              httpResponse = this.wellKnownAPIDefinition(definitions, data);
-            } else if (wellKnown === 'openapi') {
-              httpResponse = this.wellKnownOpenAPIDefinition(definitions, data);
-            } else {
-              return this.__fatalError__(req, res, `No .well-known handler for "${wellKnown}"`);
-            }
+            httpResponse = wellKnowns.handlers[wellKnown](definitions, plugin, server, origin, identifier);
           } catch (e) {
             return this.__fatalError__(req, res, `Error running .well-known handler for "${wellKnown}"`, e.stack);
           }
@@ -1668,9 +1694,9 @@ class Gateway extends EventEmitter {
     name = name.replace(/^\/?(.*?)\/?$/gi, '$1');
     let definition = definitions[name];
     if (!definition) {
-      if (wellKnowns[name]) {
+      if (wellKnowns.handlers[name]) {
         return {
-          wellKnown: wellKnowns[name],
+          wellKnown: name,
           definitions: definitions
         };
       } else {
@@ -1701,6 +1727,12 @@ class Gateway extends EventEmitter {
     }
     let data = {};
     data.canDebug = true;
+    data.pluginSupported = true;
+    data.pluginAuthorized = true;
+    data.plugin = {};
+    data.server = 'FunctionScript Gateway';
+    data.origin = urlinfo.origin;
+    data.identifier = 'service.localhost';
     return callback(null, definition, data, buffer);
   }
 
@@ -2160,53 +2192,6 @@ class Gateway extends EventEmitter {
     }
   }
 
-  wellKnownAIPlugin (definitions, data) {
-    return {
-      headers: {},
-      body: Buffer.from(
-        JSON.stringify(
-          {
-            "schema_version": "v1",
-            "name_for_human": "TODO List (service auth)",
-            "name_for_model": "todo",
-            "description_for_human": "Manage your TODO list. You can add, remove and view your TODOs.",
-            "description_for_model": "Plugin for managing a TODO list, you can add, remove and view your TODOs.",
-            "auth": {
-              "type": "service_http",
-              "authorization_type": "bearer",
-              "verification_tokens": {
-                "openai": "Replace_this_string_with_the_verification_token_generated_in_the_ChatGPT_UI"
-              }
-            },
-            "api": {
-              "type": "openapi",
-              "url": "https://example.com/openapi.yaml"
-            },
-            "logo_url": "https://example.com/logo.png",
-            "contact_email": "support@example.com",
-            "legal_info_url": "https://example.com/legal"
-          },
-          null,
-          2
-        )
-      )
-    };
-  }
-
-  wellKnownAPIDefinition (definitions, data) {
-    return {
-      headers: {},
-      body: Buffer.from(JSON.stringify(definitions, null, 2))
-    }
-  }
-
-  wellKnownOpenAPIDefinition (definitions, data) {
-    return {
-      headers: {},
-      body: Buffer.from('OpenAPI Spec')
-    }
-  }
-
   end (req, value) {
     // do nothing, response completed
     // this.log(req, value, 'result');