@squidcloud/client
    Preparing search index...

    Interface AiConnectedIntegrationMetadata<AiConnectedIntegrationOptionsType>

    Metadata for an AI agent connected to an integration.

    interface AiConnectedIntegrationMetadata<
        AiConnectedIntegrationOptionsType = unknown,
    > {
        connectedAsMcp?: boolean;
        description?: string;
        functionsToUse?: string[];
        instructions?: string;
        integrationId: string;
        integrationType:
            | "api"
            | "bedrock"
            | "ai_agents"
            | "active_directory"
            | "ai_chatbot"
            | "algolia"
            | "alloydb"
            | "auth0"
            | "azure_cosmosdb"
            | "azure_postgresql"
            | "azure_sql"
            | "bigquery"
            | "built_in_db"
            | "built_in_gcs"
            | "built_in_queue"
            | "built_in_s3"
            | "cassandra"
            | "clickhouse"
            | "cloudsql"
            | "cockroach"
            | "cognito"
            | "connected_knowledgebases"
            | "confluence"
            | "confluent"
            | "datadog"
            | "db2"
            | "descope"
            | "documentdb"
            | "dynamodb"
            | "elasticsearch"
            | "firebase_auth"
            | "firestore"
            | "gcs"
            | "github"
            | "google_calendar"
            | "google_docs"
            | "google_drive"
            | "graphql"
            | "hubspot"
            | "jira"
            | "jira_jsm"
            | "jwt_hmac"
            | "jwt_rsa"
            | "kafka"
            | "keycloak"
            | "linear"
            | "mariadb"
            | "monday"
            | "mongo"
            | "mssql"
            | "databricks"
            | "mysql"
            | "newrelic"
            | "okta"
            | "onedrive"
            | "oracledb"
            | "pinecone"
            | "postgres"
            | "redis"
            | "s3"
            | "salesforce_crm"
            | "sap_hana"
            | "sentry"
            | "snowflake"
            | "spanner"
            | "xata"
            | "zendesk"
            | "servicenow_csm"
            | "freshdesk"
            | "mail"
            | "slack"
            | "mcp"
            | "a2a"
            | "legend"
            | "teams"
            | "openai_compatible";
        options?: AiConnectedIntegrationOptionsType;
    }

    Type Parameters

    • AiConnectedIntegrationOptionsType = unknown
    Index

    Properties

    connectedAsMcp? description? functionsToUse? instructions? integrationId integrationType options?

    Properties

    connectedAsMcp?: boolean

    Indicates that this integration should be treated as an MCP server. When true, API integrations with exposeAsMcpServer will be handled through the MCP protocol.

    description?: string

    An optional description of the integration for the parent agent context, used as AI function description.

    functionsToUse?: string[]

    A list of AI function IDs that the AI agent can use from this integration.

    • When undefined (not provided), the AI agent has access to all AI functions for this integration type.
    • When an empty array [], the AI agent has access to no AI functions.
    • When an array with function IDs, the AI agent only has access to those specific functions.

    Example function IDs: 'jiraService__searchJiraIssues', 'confluenceService__searchInConfluence'

    instructions?: string

    Optional instructions for the connected integration agent, overriding the default if provided.

    integrationId: string

    The ID of the connected integration.

    integrationType:
        | "api"
        | "bedrock"
        | "ai_agents"
        | "active_directory"
        | "ai_chatbot"
        | "algolia"
        | "alloydb"
        | "auth0"
        | "azure_cosmosdb"
        | "azure_postgresql"
        | "azure_sql"
        | "bigquery"
        | "built_in_db"
        | "built_in_gcs"
        | "built_in_queue"
        | "built_in_s3"
        | "cassandra"
        | "clickhouse"
        | "cloudsql"
        | "cockroach"
        | "cognito"
        | "connected_knowledgebases"
        | "confluence"
        | "confluent"
        | "datadog"
        | "db2"
        | "descope"
        | "documentdb"
        | "dynamodb"
        | "elasticsearch"
        | "firebase_auth"
        | "firestore"
        | "gcs"
        | "github"
        | "google_calendar"
        | "google_docs"
        | "google_drive"
        | "graphql"
        | "hubspot"
        | "jira"
        | "jira_jsm"
        | "jwt_hmac"
        | "jwt_rsa"
        | "kafka"
        | "keycloak"
        | "linear"
        | "mariadb"
        | "monday"
        | "mongo"
        | "mssql"
        | "databricks"
        | "mysql"
        | "newrelic"
        | "okta"
        | "onedrive"
        | "oracledb"
        | "pinecone"
        | "postgres"
        | "redis"
        | "s3"
        | "salesforce_crm"
        | "sap_hana"
        | "sentry"
        | "snowflake"
        | "spanner"
        | "xata"
        | "zendesk"
        | "servicenow_csm"
        | "freshdesk"
        | "mail"
        | "slack"
        | "mcp"
        | "a2a"
        | "legend"
        | "teams"
        | "openai_compatible"

    The type of the connected integration (e.g., API, database).

    options?: AiConnectedIntegrationOptionsType

    Additional options for the connected integration. Squid Core or AI functions in connector packages may use these options to adjust behavior of the integration agent.

    Settings

    Member Visibility

    On This Page

    Properties