@frontmcp/adapters 0.2.1 → 0.2.3

package/README.md

@@ -1,3 +1,27 @@
-# FrontMcp Adapters
+# FrontMCP Adapters
 
-TBD
+This package contains adapters that extend FrontMCP servers with external capabilities by auto-generating, transforming, or delegating MCP tools.
+
+## Available adapters
+
+### OpenAPI Adapter
+Generate MCP tools from an OpenAPI spec. Each operation becomes an MCP tool with strong input validation and automatic request/response handling.
+
+- Code: `libs/adapters/src/openapi`
+- README: `libs/adapters/src/openapi/README.md`
+- Demo usage: `apps/demo/src/apps/expenses/index.ts`
+- Example spec (used by the demo): https://frontmcp-test.proxy.beeceptor.com/openapi.json
+- Generator library: https://www.npmjs.com/package/openapi-mcp-generator
+
+Quick example:
+```ts
+import { OpenapiAdapter } from '@frontmcp/adapters';
+
+OpenapiAdapter.init({
+  name: 'backend:api',
+  url: 'https://frontmcp-test.proxy.beeceptor.com/openapi.json',
+  baseUrl: 'https://frontmcp-test.proxy.beeceptor.com',
+});
+```
+
+For detailed options and advanced usage, see the adapter README and the docs page `docs/adapters/openapi-adapter.mdx`.

package/package.json

@@ -1,7 +1,6 @@
 {
   "name": "@frontmcp/adapters",
-  "version": "0.2.1",
-  "type": "commonjs",
+  "version": "0.2.3",
   "main": "./src/index.js",
   "types": "./src/index.d.ts",
   "exports": {
@@ -14,8 +13,9 @@
   },
   "dependencies": {
     "tslib": "^2.3.0",
-    "@frontmcp/sdk": "^0.2.1",
+    "@frontmcp/sdk": "^0.2.3",
     "openapi-mcp-generator": "^3.2.0",
     "json-schema-to-zod": "^2.6.1"
-  }
+  },
+  "type": "commonjs"
 }

package/src/openapi/openapi.adapter.js

@@ -10,9 +10,18 @@ let OpenapiAdapter = class OpenapiAdapter extends sdk_1.DynamicAdapter {
         this.options = options;
     }
     async fetch() {
-        const openapiLink = this.options.url;
+        let urlOrSpec = '';
+        if ('url' in this.options) {
+            urlOrSpec = this.options.url;
+        }
+        else if ('spec' in this.options) {
+            urlOrSpec = this.options.spec;
+        }
+        else {
+            throw new Error('Either url or spec must be provided');
+        }
         const { baseUrl, filterFn, defaultInclude, excludeOperationIds } = this.options;
-        const openApiTools = await (0, openapi_mcp_generator_1.getToolsFromOpenApi)(openapiLink, {
+        const openApiTools = await (0, openapi_mcp_generator_1.getToolsFromOpenApi)(urlOrSpec, {
             baseUrl,
             filterFn,
             defaultInclude,
@@ -37,20 +46,4 @@ OpenapiAdapter = tslib_1.__decorate([
     tslib_1.__metadata("design:paramtypes", [Object])
 ], OpenapiAdapter);
 exports.default = OpenapiAdapter;
-async function withSilencedConsole(fn) {
-    const methods = ['log', 'info', 'debug', 'warn', 'error', 'table', 'group', 'groupCollapsed', 'groupEnd', 'dir'];
-    const originals = {};
-    try {
-        for (const m of methods) {
-            originals[m] = console[m];
-            console[m] = () => {
-            };
-        }
-        return await fn;
-    }
-    finally {
-        for (const m of Object.keys(originals))
-            console[m] = originals[m];
-    }
-}
 //# sourceMappingURL=openapi.adapter.js.map

package/src/openapi/openapi.adapter.js.map

@@ -1 +1 @@
-{"version":3,"file":"openapi.adapter.js","sourceRoot":"","sources":["../../../src/openapi/openapi.adapter.ts"],"names":[],"mappings":";;;AAAA,uCAIuB;AAEvB,iEAA6E;AAC7E,iDAAiD;AAOlC,IAAM,cAAc,GAApB,MAAM,cAAe,SAAQ,oBAAqC;IAG/E,YAAY,OAA8B;QACxC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAGD,KAAK,CAAC,KAAK;QACT,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAA;QACpC,MAAM,EAAC,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,mBAAmB,EAAC,GAAG,IAAI,CAAC,OAAO,CAAC;QAC9E,MAAM,YAAY,GAAG,MAAM,IAAA,2CAAmB,EAAC,WAAW,EAAE;YAC1D,OAAO;YACP,QAAQ;YACR,cAAc;YACd,mBAAmB;YACnB,WAAW,EAAE,KAAK;SACnB,CAAC,CAAC;QAEH,OAAO;YACL,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;SACrC,CAAC;IACJ,CAAC;IAEO,UAAU,CAAC,YAAiC;QAClD,OAAO,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAC7B,OAAO,IAAA,gCAAiB,EAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;IACL,CAAC;CAGF,CAAA;AAhCoB,cAAc;IAJlC,IAAA,aAAO,EAAC;QACP,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,8CAA8C;KAC5D,CAAC;;GACmB,cAAc,CAgClC;kBAhCoB,cAAc;AAkCnC,KAAK,UAAU,mBAAmB,CAAC,EAAgB;IACjD,MAAM,OAAO,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;IACjH,MAAM,SAAS,GAAG,EAAE,CAAC;IACrB,IAAI,CAAC;QACH,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;YACxB,SAAS,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;YAC1B,OAAO,CAAC,CAAC,CAAC,GAAG,GAAG,EAAE;YAClB,CAAC,CAAC;QACJ,CAAC;QACD,OAAO,MAAM,EAAE,CAAC;IAClB,CAAC;YAAS,CAAC;QACT,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;YAAE,OAAO,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;IACpE,CAAC;AACH,CAAC","sourcesContent":["import {\n  Adapter,\n  DynamicAdapter,\n  FrontMcpAdapterResponse,\n} from '@frontmcp/sdk';\nimport {OpenApiAdapterOptions} from './openapi.types';\nimport {getToolsFromOpenApi, McpToolDefinition} from 'openapi-mcp-generator';\nimport {createOpenApiTool} from \"./openapi.tool\";\n\n\n@Adapter({\n  name: 'openapi',\n  description: 'OpenAPI adapter that  plugin for expense-mcp',\n})\nexport default class OpenapiAdapter extends DynamicAdapter<OpenApiAdapterOptions> {\n  options: OpenApiAdapterOptions;\n\n  constructor(options: OpenApiAdapterOptions) {\n    super();\n    this.options = options;\n  }\n\n\n  async fetch(): Promise<FrontMcpAdapterResponse> {\n    const openapiLink = this.options.url\n    const {baseUrl, filterFn, defaultInclude, excludeOperationIds} = this.options;\n    const openApiTools = await getToolsFromOpenApi(openapiLink, {\n      baseUrl,\n      filterFn,\n      defaultInclude,\n      excludeOperationIds,\n      dereference: false,\n    });\n\n    return {\n      tools: this.parseTools(openApiTools),\n    };\n  }\n\n  private parseTools(openApiTools: McpToolDefinition[]) {\n    return openApiTools.map(tool => {\n      return createOpenApiTool(tool, this.options);\n    });\n  }\n\n\n}\n\nasync function withSilencedConsole(fn: Promise<any>) {\n  const methods = ['log', 'info', 'debug', 'warn', 'error', 'table', 'group', 'groupCollapsed', 'groupEnd', 'dir'];\n  const originals = {};\n  try {\n    for (const m of methods) {\n      originals[m] = console[m];\n      console[m] = () => {\n      };\n    }\n    return await fn;\n  } finally {\n    for (const m of Object.keys(originals)) console[m] = originals[m];\n  }\n}\n"]}
+{"version":3,"file":"openapi.adapter.js","sourceRoot":"","sources":["../../../src/openapi/openapi.adapter.ts"],"names":[],"mappings":";;;AAAA,uCAIuB;AAEvB,iEAA6E;AAC7E,iDAAiD;AAOlC,IAAM,cAAc,GAApB,MAAM,cAAe,SAAQ,oBAAqC;IAG/E,YAAY,OAA8B;QACxC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAGD,KAAK,CAAC,KAAK;QACT,IAAI,SAAS,GAAgC,EAAE,CAAA;QAC/C,IAAI,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAC1B,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;QAC/B,CAAC;aAAM,IAAI,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAClC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;QAChC,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QACD,MAAM,EAAC,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,mBAAmB,EAAC,GAAG,IAAI,CAAC,OAAO,CAAC;QAC9E,MAAM,YAAY,GAAG,MAAM,IAAA,2CAAmB,EAAC,SAAS,EAAE;YACxD,OAAO;YACP,QAAQ;YACR,cAAc;YACd,mBAAmB;YACnB,WAAW,EAAE,KAAK;SACnB,CAAC,CAAC;QAEH,OAAO;YACL,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;SACrC,CAAC;IACJ,CAAC;IAEO,UAAU,CAAC,YAAiC;QAClD,OAAO,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAC7B,OAAO,IAAA,gCAAiB,EAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;IACL,CAAC;CACF,CAAA;AArCoB,cAAc;IAJlC,IAAA,aAAO,EAAC;QACP,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,8CAA8C;KAC5D,CAAC;;GACmB,cAAc,CAqClC;kBArCoB,cAAc","sourcesContent":["import {\n  Adapter,\n  DynamicAdapter,\n  FrontMcpAdapterResponse,\n} from '@frontmcp/sdk';\nimport {OpenApiAdapterOptions} from './openapi.types';\nimport {getToolsFromOpenApi, McpToolDefinition} from 'openapi-mcp-generator';\nimport {createOpenApiTool} from \"./openapi.tool\";\nimport {OpenAPIV3} from \"openapi-types\";\n\n@Adapter({\n  name: 'openapi',\n  description: 'OpenAPI adapter that  plugin for expense-mcp',\n})\nexport default class OpenapiAdapter extends DynamicAdapter<OpenApiAdapterOptions> {\n  options: OpenApiAdapterOptions;\n\n  constructor(options: OpenApiAdapterOptions) {\n    super();\n    this.options = options;\n  }\n\n\n  async fetch(): Promise<FrontMcpAdapterResponse> {\n    let urlOrSpec: string | OpenAPIV3.Document = ''\n    if ('url' in this.options) {\n      urlOrSpec = this.options.url;\n    } else if ('spec' in this.options) {\n      urlOrSpec = this.options.spec;\n    } else {\n      throw new Error('Either url or spec must be provided');\n    }\n    const {baseUrl, filterFn, defaultInclude, excludeOperationIds} = this.options;\n    const openApiTools = await getToolsFromOpenApi(urlOrSpec, {\n      baseUrl,\n      filterFn,\n      defaultInclude,\n      excludeOperationIds,\n      dereference: false,\n    });\n\n    return {\n      tools: this.parseTools(openApiTools),\n    };\n  }\n\n  private parseTools(openApiTools: McpToolDefinition[]) {\n    return openApiTools.map(tool => {\n      return createOpenApiTool(tool, this.options);\n    });\n  }\n}"]}

package/src/openapi/openapi.types.d.ts

@@ -1,19 +1,60 @@
 import { AuthInfo } from "@modelcontextprotocol/sdk/server/auth/types.js";
 import { GetToolsOptions } from "openapi-mcp-generator/dist/api";
-export interface OpenApiAdapterOptions extends Omit<GetToolsOptions, 'dereference'> {
+import { OpenAPIV3 } from "openapi-types";
+interface BaseOptions extends Omit<GetToolsOptions, 'dereference'> {
+    /**
+     * The name of the adapter.
+     * This is used to identify the adapter in the MCP configuration.
+     * Also used to prefix tools if conflicted with other adapters in the same app.
+     */
     name: string;
-    url: string;
+    /**
+     * The base URL of the API.
+     * This is used to construct the full URL for each request.
+     * For example, if the API is hosted at https://api.example.com/v1,
+     * the baseUrl should be set to https://api.example.com/v1.
+     */
+    baseUrl: string;
+    /**
+     * Additional headers to be sent with each request.
+     * This can be used to set authentication headers,
+     * such as Authorization or API Key.
+     */
     additionalHeaders?: Record<string, string>;
+    /**
+     * This can be used to map request information to specific
+     * headers as required by the API.
+     * For example, mapping tenantId from authenticated session payload to
+     * a specific header, this key will be hidden to mcp clients
+     * and filled by the adapter before sending the request to the API.
+     * @param authInfo
+     * @param headers
+     */
     headersMapper?: (authInfo: AuthInfo, headers: Headers) => Headers;
-    bodyMapper?: (authInfo: AuthInfo, body: any) => any;
     /**
      * This can be used to map request information to specific
-     * input schema values as required by the API.
+     * body values as required by the API.
      * For example, mapping tenantId from authenticated session payload to
-     * a specific proprty in the input schema, this key will be hidden to mcp clients
+     * a specific property in the body, this key will be hidden to mcp clients
      * and filled by the adapter before sending the request to the API.
+     *
      * @param authInfo
-     * @param request
+     * @param body
      */
-    inputSchemaMapper?: (inputSchema: any) => any;
+    bodyMapper?: (authInfo: AuthInfo, body: any) => any;
+}
+interface SpecOptions extends BaseOptions {
+    /**
+     * The OpenAPI specification the OpenAPI specification.
+     */
+    spec: OpenAPIV3.Document;
+}
+interface UrlOptions extends BaseOptions {
+    /**
+     * The URL of the OpenAPI specification.
+     * Can be a local file path or a remote URL.
+     */
+    url: string;
 }
+export type OpenApiAdapterOptions = SpecOptions | UrlOptions;
+export {};

package/src/openapi/openapi.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"openapi.types.js","sourceRoot":"","sources":["../../../src/openapi/openapi.types.ts"],"names":[],"mappings":"","sourcesContent":["import {AuthInfo} from \"@modelcontextprotocol/sdk/server/auth/types.js\";\nimport {GetToolsOptions} from \"openapi-mcp-generator/dist/api\";\n\nexport interface OpenApiAdapterOptions extends Omit<GetToolsOptions, 'dereference'> {\n  name: string;\n  url: string;\n\n  additionalHeaders?: Record<string, string>;\n  headersMapper?: (authInfo: AuthInfo, headers: Headers) => Headers;\n  bodyMapper?: (authInfo: AuthInfo, body: any) => any;\n  /**\n   * This can be used to map request information to specific\n   * input schema values as required by the API.\n   * For example, mapping tenantId from authenticated session payload to\n   * a specific proprty in the input schema, this key will be hidden to mcp clients\n   * and filled by the adapter before sending the request to the API.\n   * @param authInfo\n   * @param request\n   */\n  inputSchemaMapper?: (inputSchema: any) => any;\n}\n"]}
+{"version":3,"file":"openapi.types.js","sourceRoot":"","sources":["../../../src/openapi/openapi.types.ts"],"names":[],"mappings":"","sourcesContent":["import {AuthInfo} from \"@modelcontextprotocol/sdk/server/auth/types.js\";\nimport {GetToolsOptions} from \"openapi-mcp-generator/dist/api\";\nimport {OpenAPIV3} from \"openapi-types\";\n\ninterface BaseOptions extends Omit<GetToolsOptions, 'dereference'> {\n  /**\n   * The name of the adapter.\n   * This is used to identify the adapter in the MCP configuration.\n   * Also used to prefix tools if conflicted with other adapters in the same app.\n   */\n  name: string;\n\n  /**\n   * The base URL of the API.\n   * This is used to construct the full URL for each request.\n   * For example, if the API is hosted at https://api.example.com/v1,\n   * the baseUrl should be set to https://api.example.com/v1.\n   */\n  baseUrl: string;\n\n  /**\n   * Additional headers to be sent with each request.\n   * This can be used to set authentication headers,\n   * such as Authorization or API Key.\n   */\n  additionalHeaders?: Record<string, string>;\n  /**\n   * This can be used to map request information to specific\n   * headers as required by the API.\n   * For example, mapping tenantId from authenticated session payload to\n   * a specific header, this key will be hidden to mcp clients\n   * and filled by the adapter before sending the request to the API.\n   * @param authInfo\n   * @param headers\n   */\n  headersMapper?: (authInfo: AuthInfo, headers: Headers) => Headers;\n  /**\n   * This can be used to map request information to specific\n   * body values as required by the API.\n   * For example, mapping tenantId from authenticated session payload to\n   * a specific property in the body, this key will be hidden to mcp clients\n   * and filled by the adapter before sending the request to the API.\n   *\n   * @param authInfo\n   * @param body\n   */\n  bodyMapper?: (authInfo: AuthInfo, body: any) => any;\n}\n\ninterface SpecOptions extends BaseOptions {\n  /**\n   * The OpenAPI specification the OpenAPI specification.\n   */\n  spec: OpenAPIV3.Document;\n}\n\ninterface UrlOptions extends BaseOptions {\n  /**\n   * The URL of the OpenAPI specification.\n   * Can be a local file path or a remote URL.\n   */\n  url: string;\n}\n\nexport type OpenApiAdapterOptions = SpecOptions | UrlOptions;\n"]}