@superblocksteam/shared 0.9618.2 → 0.9619.0

package/src/plugins/templates/mcp.ts

@@ -0,0 +1,190 @@
+import {
+  EditorLanguage,
+  ExtendedIntegrationPluginId,
+  FormComponentType,
+  FormSectionLayout,
+  IntegrationAuthType,
+  type Plugin,
+  PluginResponseType,
+  PluginType,
+  TokenScope
+} from '../../types/index.js';
+import { PUBLIC_INTEGRATIONS_LOGO_URL } from './constants.js';
+import { RestApiIntegrationPluginMergedFieldNames, authSections } from './shared/index.js';
+
+export const McpPluginVersions = {
+  V1: '0.0.1'
+};
+
+export const MCP_PLUGIN_NAME = 'MCP Server';
+
+// JSON-RPC methods a step may send. The plugin rejects everything else.
+export const MCP_METHOD_TOOLS_CALL = 'tools/call';
+export const MCP_METHOD_TOOLS_LIST = 'tools/list';
+
+/**
+ * The auth types an MCP Server integration may be saved with. This is the server-side
+ * allowlist (validateConfigurationsByPluginType); the dropdown order below derives from it, so
+ * a type is offered and accepted together or not at all.
+ */
+export const MCP_AUTH_TYPES: readonly IntegrationAuthType[] = [
+  IntegrationAuthType.OAUTH2_CODE,
+  IntegrationAuthType.OAUTH2_TOKEN_EXCHANGE,
+  IntegrationAuthType.OAUTH2_CLIENT_CREDS,
+  IntegrationAuthType.BEARER,
+  IntegrationAuthType.API_KEY,
+  IntegrationAuthType.NONE
+];
+
+// Display order of the Authentication dropdown. PKCE is the code flow with a flag, not its own
+// authType, so it is a display-only entry next to the code flow.
+export const MCP_AUTH_TYPE_ORDER: readonly string[] = [
+  IntegrationAuthType.OAUTH2_CODE,
+  `${IntegrationAuthType.OAUTH2_CODE}-pkce`,
+  ...MCP_AUTH_TYPES.filter((authType) => authType !== IntegrationAuthType.OAUTH2_CODE)
+];
+
+// MCP Server integration: Superblocks acts as an MCP client against a customer's
+// MCP server. A step sends one JSON-RPC request (method + params) plus optional
+// headers; the plugin's metadata call returns the server's initialize result.
+export const McpPlugin: Plugin = {
+  id: ExtendedIntegrationPluginId.MCP,
+  name: MCP_PLUGIN_NAME,
+  moduleName: 'McpPlugin',
+  modulePath: 'plugins/mcpintegration/McpPlugin',
+  iconLocation: `${PUBLIC_INTEGRATIONS_LOGO_URL}/mcp.png`,
+  type: PluginType.API,
+  responseType: PluginResponseType.JSON,
+  hasRawRequest: false,
+  hasMetadata: true,
+  datasourceTemplate: {
+    sections: [
+      {
+        name: 'main',
+        items: [
+          {
+            label: 'Display name',
+            name: 'name',
+            startVersion: McpPluginVersions.V1,
+            componentType: FormComponentType.INPUT_TEXT,
+            placeholder: 'My MCP Server',
+            rules: [{ required: true, message: 'Display name is required' }]
+          },
+          {
+            label: 'Server URL',
+            name: 'urlBase',
+            startVersion: McpPluginVersions.V1,
+            componentType: FormComponentType.DYNAMIC_INPUT_TEXT,
+            placeholder: 'https://mcp.linear.app/mcp',
+            tooltip: {
+              markdownText: 'The HTTP endpoint of the MCP server.'
+            },
+            singleLine: true,
+            rules: [{ required: true, message: 'Server URL is required' }]
+          }
+        ]
+      },
+      ...authSections({
+        startVersion: McpPluginVersions.V1,
+        pkceStartVersion: McpPluginVersions.V1,
+        confidentialPkceStartVersion: McpPluginVersions.V1,
+        pluginId: ExtendedIntegrationPluginId.MCP,
+        pluginName: MCP_PLUGIN_NAME,
+        enabledMethods: {
+          oauth: true,
+          bearer: true,
+          // The key is the header name the server reads the token from; the value is the full header value.
+          apiKey: { key: { placeholder: 'Authorization' }, value: { placeholder: 'Bearer <token>' } }
+        },
+        // MCP servers are OAuth 2.1 resource servers: no implicit or password
+        // grant, and the IdP passthrough needs an interactive session.
+        excludedAuthTypes: [
+          IntegrationAuthType.OAUTH2_IMPLICIT,
+          IntegrationAuthType.OAUTH2_PASSWORD,
+          IntegrationAuthType.OAUTH2_IDP_TOKEN_PASSTHROUGH
+        ],
+        authTypeOrder: MCP_AUTH_TYPE_ORDER,
+        oauthConnect: true,
+        // Client credentials: the plugin reads the Authorization header, it has no {{ oauth.token }} binding.
+        sendBearerHeader: true,
+        // Each user connects their own account unless the admin shares one.
+        defaultTokenScope: TokenScope.USER
+      }),
+      {
+        name: 'tabs',
+        layout: FormSectionLayout.TABS,
+        items: [
+          {
+            name: RestApiIntegrationPluginMergedFieldNames.HEADERS,
+            label: 'Headers',
+            startVersion: McpPluginVersions.V1,
+            componentType: FormComponentType.FIELD_LIST,
+            secretsNames: ['Authorization']
+          }
+        ]
+      }
+    ]
+  },
+  actionTemplate: {
+    sections: [
+      {
+        name: 'main',
+        items: [
+          {
+            label: 'Method',
+            name: 'request.method',
+            startVersion: McpPluginVersions.V1,
+            componentType: FormComponentType.DROPDOWN,
+            initialValue: MCP_METHOD_TOOLS_CALL,
+            rules: [{ required: true }],
+            options: [
+              {
+                key: MCP_METHOD_TOOLS_CALL,
+                value: MCP_METHOD_TOOLS_CALL,
+                displayName: 'Call a tool (tools/call)'
+              },
+              {
+                key: MCP_METHOD_TOOLS_LIST,
+                value: MCP_METHOD_TOOLS_LIST,
+                displayName: 'List tools (tools/list)'
+              }
+            ],
+            tooltip: {
+              markdownText: 'The JSON-RPC method sent to the server. Only tool calls and tool listing are supported.'
+            }
+          },
+          {
+            label: 'Params',
+            name: 'request.params',
+            startVersion: McpPluginVersions.V1,
+            componentType: FormComponentType.CODE_EDITOR,
+            language: EditorLanguage.JSON,
+            placeholder: `{
+  "name": "list_issues",
+  "arguments": {
+    "query": "{{ Input1.value }}"
+  }
+}`,
+            tooltip: {
+              markdownText:
+                'The JSON-RPC params for the selected method. For tools/call: the tool name from the server and a JSON object matching its input schema. For tools/list: optionally `{ "cursor": "..." }` from a previous page.'
+            }
+          }
+        ]
+      },
+      {
+        name: 'tabs',
+        layout: FormSectionLayout.TABS,
+        items: [
+          {
+            name: RestApiIntegrationPluginMergedFieldNames.HEADERS,
+            label: 'Headers',
+            startVersion: McpPluginVersions.V1,
+            componentType: FormComponentType.FIELD_LIST,
+            collapseValue: 'Hide auto-generated headers'
+          }
+        ]
+      }
+    ]
+  }
+};

package/src/plugins/templates/mistral.ts

@@ -1,4 +1,4 @@
-import { ExtendedIntegrationPluginId, Plugin } from '../../types/index.js';
+import { ExtendedIntegrationPluginId, type Plugin } from '../../types/index.js';
 import { getNativeOpenApiPlugin } from './shared/index.js';
 
 export const MistralPlugin: Plugin = getNativeOpenApiPlugin({

package/src/plugins/templates/mongodb.ts

@@ -1,4 +1,4 @@
-import { EditorLanguage, FormComponentType, Plugin, PluginResponseType, PluginType } from '../../types/index.js';
+import { EditorLanguage, FormComponentType, type Plugin, PluginResponseType, PluginType } from '../../types/index.js';
 import { PUBLIC_INTEGRATIONS_LOGO_URL, DOCS_BASE_URL } from './constants.js';
 
 const MongoDBPluginVersions = {

package/src/plugins/templates/mssql.ts

@@ -2,9 +2,9 @@ import {
   DB_SQL_INITIAL_TEXT,
   EditorLanguage,
   FormComponentType,
-  FormItem,
+  type FormItem,
   InputDataType,
-  Plugin,
+  type Plugin,
   PluginResponseType,
   PluginType
 } from '../../types/index.js';

package/src/plugins/templates/mysql.ts

@@ -2,9 +2,9 @@ import {
   DB_SQL_INITIAL_TEXT,
   EditorLanguage,
   FormComponentType,
-  FormItem,
+  type FormItem,
   InputDataType,
-  Plugin,
+  type Plugin,
   PluginResponseType,
   PluginType
 } from '../../types/index.js';

package/src/plugins/templates/notion.ts

@@ -1,4 +1,4 @@
-import { ExtendedIntegrationPluginId, Plugin } from '../../types/index.js';
+import { ExtendedIntegrationPluginId, type Plugin } from '../../types/index.js';
 import { ClientAuthMethod, getNativeOpenApiPlugin } from './shared/index.js';
 
 export const NotionPlugin: Plugin = getNativeOpenApiPlugin({

package/src/plugins/templates/openai.ts

@@ -1,4 +1,4 @@
-import { FormComponentType, InputDataType, Plugin, PluginResponseType, PluginType } from '../../types/index.js';
+import { FormComponentType, InputDataType, type Plugin, PluginResponseType, PluginType } from '../../types/index.js';
 import {
   AUDIO_AI_MODELS_AND_DESCRIPTIONS,
   CHAT_COMPLETION_AI_MODELS_AND_DESCRIPTIONS,

package/src/plugins/templates/openai_v2.ts

@@ -1,4 +1,4 @@
-import { ExtendedIntegrationPluginId, Plugin } from '../../types/index.js';
+import { ExtendedIntegrationPluginId, type Plugin } from '../../types/index.js';
 import { DOCS_BASE_URL, PUBLIC_INTEGRATIONS_CDN_URL, PUBLIC_INTEGRATIONS_LOGO_URL } from './constants.js';
 import { getNativeOpenApiPlugin } from './shared/index.js';
 

package/src/plugins/templates/oracledb.ts

@@ -2,9 +2,9 @@ import {
   DB_SQL_INITIAL_TEXT,
   EditorLanguage,
   FormComponentType,
-  FormItem,
+  type FormItem,
   InputDataType,
-  Plugin,
+  type Plugin,
   PluginResponseType,
   PluginType
 } from '../../types/index.js';

package/src/plugins/templates/pagerduty.ts

@@ -1,4 +1,4 @@
-import { ExtendedIntegrationPluginId, Plugin } from '../../types/index.js';
+import { ExtendedIntegrationPluginId, type Plugin } from '../../types/index.js';
 import { getNativeOpenApiPlugin } from './shared/index.js';
 
 export const PagerDutyPlugin: Plugin = getNativeOpenApiPlugin({

package/src/plugins/templates/perplexity.ts

@@ -1,4 +1,4 @@
-import { ExtendedIntegrationPluginId, Plugin } from '../../types/index.js';
+import { ExtendedIntegrationPluginId, type Plugin } from '../../types/index.js';
 import { getNativeOpenApiPlugin } from './shared/index.js';
 
 export const PerplexityPlugin: Plugin = getNativeOpenApiPlugin({

package/src/plugins/templates/postgres.ts

@@ -2,9 +2,9 @@ import {
   DB_SQL_INITIAL_TEXT,
   EditorLanguage,
   FormComponentType,
-  FormItem,
+  type FormItem,
   InputDataType,
-  Plugin,
+  type Plugin,
   PluginResponseType,
   PluginType,
   PostgresAuthType

package/src/plugins/templates/python.ts

@@ -1,4 +1,4 @@
-import { EditorLanguage, FormComponentType, LanguagePluginID, Plugin, PluginResponseType, PluginType } from '../../types/index.js';
+import { EditorLanguage, FormComponentType, LanguagePluginID, type Plugin, PluginResponseType, PluginType } from '../../types/index.js';
 import { PUBLIC_INTEGRATIONS_LOGO_URL } from './constants.js';
 
 const PythonPluginVersions = {

package/src/plugins/templates/redis.ts

@@ -1,4 +1,4 @@
-import { FormComponentType, InputDataType, Plugin, PluginResponseType, PluginType } from '../../types/index.js';
+import { FormComponentType, InputDataType, type Plugin, PluginResponseType, PluginType } from '../../types/index.js';
 import { PUBLIC_INTEGRATIONS_LOGO_URL } from './constants.js';
 
 const RedisPluginVersions = {

package/src/plugins/templates/redshift.ts

@@ -1,4 +1,12 @@
-import { EditorLanguage, FormComponentType, FormItem, InputDataType, Plugin, PluginResponseType, PluginType } from '../../types/index.js';
+import {
+  EditorLanguage,
+  FormComponentType,
+  type FormItem,
+  InputDataType,
+  type Plugin,
+  PluginResponseType,
+  PluginType
+} from '../../types/index.js';
 import { PARAMETERIZED_SQL_DESCRIPTION, SQL_INITIAL_TEXT, PUBLIC_INTEGRATIONS_LOGO_URL, DOCS_BASE_URL } from './constants.js';
 import { CONNECTION_METHODS_AND_DISPLAY_NAMES, makeDropdownItem } from './shared/db.js';
 

package/src/plugins/templates/restApi.ts

@@ -4,7 +4,7 @@ import {
   FormComponentType,
   FormSectionLayout,
   HttpMethod,
-  Plugin,
+  type Plugin,
   PluginResponseType,
   PluginType,
   REST_API_BASE_PLUGIN_ID,

package/src/plugins/templates/restApiIntegration.ts

@@ -7,7 +7,7 @@ import {
   GENERIC_HTTP_REQUEST,
   HttpMethod,
   IntegrationAuthType,
-  Plugin,
+  type Plugin,
   PluginResponseType,
   PluginType,
   RestApiBodyDataType,

package/src/plugins/templates/s3.ts

@@ -4,7 +4,7 @@ import {
   EditorLanguage,
   FormComponentType,
   InputDataType,
-  Plugin,
+  type Plugin,
   PluginResponseType,
   PluginType
 } from '../../types/index.js';

package/src/plugins/templates/salesforce.ts

@@ -2,10 +2,10 @@ import {
   EditorLanguage,
   ExtendedIntegrationPluginId,
   FormComponentType,
-  FormItem,
+  type FormItem,
   InputDataType,
   IntegrationAuthType,
-  Plugin,
+  type Plugin,
   PluginResponseType,
   PluginType
 } from '../../types/index.js';

package/src/plugins/templates/secrets/akeylessSecretsManager.ts

@@ -1,4 +1,4 @@
-import { FormComponentType, InputDataType, IntegrationKind, Plugin, PluginResponseType, PluginType } from '../../../types/index.js';
+import { FormComponentType, InputDataType, IntegrationKind, type Plugin, PluginResponseType, PluginType } from '../../../types/index.js';
 import { PUBLIC_INTEGRATIONS_LOGO_URL } from '../constants.js';
 
 const AkeylessSecretsManagerVersions = {

package/src/plugins/templates/secrets/awsSecretsManager.ts

@@ -2,7 +2,7 @@ import {
   FormComponentType,
   InputDataType,
   IntegrationKind,
-  Plugin,
+  type Plugin,
   PluginResponseType,
   PluginType,
   TooltipIconType

package/src/plugins/templates/secrets/gcpSecretsManager.ts

@@ -4,7 +4,7 @@ import {
   FormItemTransformation,
   InputDataType,
   IntegrationKind,
-  Plugin,
+  type Plugin,
   PluginResponseType,
   PluginType
 } from '../../../types/index.js';

package/src/plugins/templates/secrets/hashicorpVault.ts

@@ -1,4 +1,4 @@
-import { FormComponentType, InputDataType, IntegrationKind, Plugin, PluginResponseType, PluginType } from '../../../types/index.js';
+import { FormComponentType, InputDataType, IntegrationKind, type Plugin, PluginResponseType, PluginType } from '../../../types/index.js';
 import { PUBLIC_INTEGRATIONS_LOGO_URL } from '../constants.js';
 
 const HashicorpVaultVersions = {

package/src/plugins/templates/segment.ts

@@ -1,4 +1,4 @@
-import { ExtendedIntegrationPluginId, Plugin } from '../../types/index.js';
+import { ExtendedIntegrationPluginId, type Plugin } from '../../types/index.js';
 import { getNativeOpenApiPlugin } from './shared/index.js';
 
 export const SegmentPlugin: Plugin = getNativeOpenApiPlugin({

package/src/plugins/templates/sendgrid.ts

@@ -1,4 +1,4 @@
-import { ExtendedIntegrationPluginId, Plugin } from '../../types/index.js';
+import { ExtendedIntegrationPluginId, type Plugin } from '../../types/index.js';
 import { getNativeOpenApiPlugin } from './shared/index.js';
 
 export const SendGridPlugin: Plugin = getNativeOpenApiPlugin({

package/src/plugins/templates/shared/auth.test.ts

@@ -3,10 +3,11 @@ import { describe, expect, test } from 'vitest';
 import {
   ExtendedIntegrationPluginId,
   FormComponentType,
-  FormItem,
+  type FormItem,
   getDisplayName,
   getRowItemsFromSectionItem,
-  IntegrationAuthType
+  IntegrationAuthType,
+  TokenScope
 } from '../../../types/index.js';
 import { authSections, ClientAuthMethod } from './auth.js';
 
@@ -278,3 +279,98 @@ describe('OAuth client credentials method', () => {
     ).toThrow('twice');
   });
 });
+
+describe('share-token checkbox default', () => {
+  const bringYourOwn = {
+    tokenUrl: 'https://provider.example.com/token',
+    authorizationUrl: 'https://provider.example.com/authorize',
+    revokeTokenUrl: 'https://provider.example.com/revoke',
+    iconUrl: 'https://provider.example.com/icon.png'
+  };
+  const tokenScopeCheckbox = (sections: ReturnType<typeof authSections>): FormItem | undefined =>
+    sections
+      .flatMap((section) => section.items.flatMap((item) => getRowItemsFromSectionItem(item)))
+      .find((field) => field.name === 'authConfig.tokenScope');
+
+  test('keeps sharing by default for templates that do not ask', () => {
+    const checkbox = tokenScopeCheckbox(
+      authSections({
+        startVersion: '0.0.1',
+        pluginId: ExtendedIntegrationPluginId.SLACK,
+        pluginName: 'Slack',
+        enabledMethods: { oauth2BringYourOwn: bringYourOwn }
+      })
+    );
+
+    expect(checkbox?.initialValue).toBe(TokenScope.DATASOURCE);
+  });
+
+  test('honors defaultTokenScope on the bring-your-own and generic flows alike', () => {
+    for (const enabledMethods of [{ oauth2BringYourOwn: bringYourOwn }, { oauth: true }]) {
+      const checkbox = tokenScopeCheckbox(
+        authSections({
+          startVersion: '0.0.1',
+          pluginId: ExtendedIntegrationPluginId.MCP,
+          pluginName: 'MCP Server',
+          enabledMethods,
+          oauthConnect: true,
+          defaultTokenScope: TokenScope.USER
+        })
+      );
+
+      expect(checkbox?.initialValue, JSON.stringify(enabledMethods)).toBe(TokenScope.USER);
+      expect(checkbox && 'mapBooleansTo' in checkbox ? checkbox.mapBooleansTo : undefined).toEqual({
+        true: TokenScope.DATASOURCE,
+        false: TokenScope.USER
+      });
+    }
+  });
+
+  test('leaves the generic flow without a checkbox or Connect button unless oauthConnect is set', () => {
+    // REST API and GraphQL use this shape today; their OAuth tokens are always
+    // per user and connected at run time, so the form must stay as it is.
+    const fields = authSections({
+      startVersion: '0.0.1',
+      pluginId: ExtendedIntegrationPluginId.REST_API,
+      pluginName: 'REST API',
+      enabledMethods: { oauth: true },
+      defaultTokenScope: TokenScope.USER
+    }).flatMap((section) => section.items.flatMap((item) => getRowItemsFromSectionItem(item)));
+
+    expect(fields.some((field) => field.name === 'authConfig.tokenScope')).toBe(false);
+    expect(fields.some((field) => field.name === 'oauth-connect-button')).toBe(false);
+  });
+});
+
+describe('auth type dropdown shaping', () => {
+  const options = (overrides: Partial<Parameters<typeof authSections>[0]>) => {
+    const authType = authSections({
+      startVersion: '0.0.1',
+      pluginId: ExtendedIntegrationPluginId.REST_API,
+      pluginName: 'REST API',
+      enabledMethods: { oauth: true, bearer: true },
+      ...overrides
+    })
+      .flatMap((section) => section.items.flatMap((item) => getRowItemsFromSectionItem(item)))
+      .find((field) => field.name === 'authType');
+    return authType && 'options' in authType ? authType.options : [];
+  };
+
+  test('drops excluded auth types from the dropdown only', () => {
+    const shaped = options({ excludedAuthTypes: [IntegrationAuthType.OAUTH2_IMPLICIT] });
+
+    expect(shaped.map((option) => option.value)).not.toContain(IntegrationAuthType.OAUTH2_IMPLICIT);
+    expect(shaped.map((option) => option.value)).toContain(IntegrationAuthType.OAUTH2_CODE);
+    expect(shaped).toHaveLength(options({}).length - 1);
+  });
+
+  test('orders listed options first and keeps the rest in their default order', () => {
+    const shaped = options({ authTypeOrder: [IntegrationAuthType.BEARER, IntegrationAuthType.NONE] });
+    const defaults = options({});
+
+    expect(shaped.slice(0, 2).map((option) => option.key)).toEqual([IntegrationAuthType.BEARER, IntegrationAuthType.NONE]);
+    expect(shaped.slice(2).map((option) => option.key)).toEqual(
+      defaults.map((option) => option.key).filter((key) => key !== IntegrationAuthType.BEARER && key !== IntegrationAuthType.NONE)
+    );
+  });
+});