> ## Documentation Index
> Fetch the complete documentation index at: https://docs.atlastix.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Setting Up and Managing Integrations

> Step-by-step guide to configuring, securing, and managing your platform integrations

## Accessing the Integrations Page

Navigate to the **Integrations** page from the sidebar to view and manage all available integrations. This page displays:

* Agent Integrations and Data Ingest sections
* Integration cards showing key information
* Search and filtering tools
* Configuration and enable options

## Understanding the Interface

### Integration Cards

Each integration is displayed as a card showing:

* **Icon/Logo**: Visual identifier for the service
* **Name**: The integration's display name
* **Category Badge**: Type classification (DATABASE, CLOUD, DEVELOPMENT, etc.)
* **Description**: Brief explanation of what the integration provides
* **Action Buttons**:
  * **Configure**: Set up or modify credentials and settings
  * **Enable**: Activate the integration for use

### Search and Filter Tools

Find the integrations you need quickly using the toolbar:

<AccordionGroup>
  <Accordion title="Search">
    Use the search bar to find integrations by name or description. Search is real-time and updates results as you type.
  </Accordion>

  <Accordion title="Filter by Category">
    Click the **All Categories** dropdown to filter by:

    * database
    * cloud
    * development
    * docs
    * payroll
    * technology
  </Accordion>

  <Accordion title="Filter by Tags">
    Click the **Tags** button to filter integrations by assigned tags.
  </Accordion>

  <Accordion title="Clear Filters">
    Click **Clear** to reset all active filters and show all integrations.
  </Accordion>
</AccordionGroup>

### View Options

Toggle between different view modes:

* **Grid View**: See integrations as cards with full details (default)
* **List View**: See integrations in a compact list format

## Configuring Agent Integrations

Agent Integrations connect your agents to external services in real-time using the Model Context Protocol (MCP).

### Authentication Types

Different integrations use different authentication methods. The configuration dialog adapts to show the appropriate fields for each integration type.

#### Manual Credentials

For database and API-based integrations, you'll configure credentials manually:

<Steps>
  <Step title="Open Configuration">
    Click the **Configure** button on the integration card.
  </Step>

  <Step title="Name Your Credential">
    Provide a descriptive name to identify this credential (e.g., "Production Database" or "Client XYZ AWS Account").
  </Step>

  <Step title="Enter Connection Details">
    Fill in the required fields, which vary by integration type:

    **For Database Integrations (ClickHouse, SQL Database):**

    * **Host**: The database server address
    * **User**: Database username
    * **Password**: Database password
    * **Database**: Database name to connect to
    * **Port**: Connection port number
    * **Allowed Patterns**: (Optional) Limit access to specific tables or schemas

    **For Cloud Platform Integrations (AWS, Azure):**

    * **API Keys or Access Tokens**: Platform-specific credentials
    * **Region Settings**: Geographic region for the service
    * **Additional Configuration**: Service-specific parameters
  </Step>

  <Step title="Configure Security Groups">
    Assign the credential to Security Groups to control who can use it. Click **Security Groups** to select which groups have access.
  </Step>

  <Step title="Save the Credential">
    Click **Save** to securely store your credential. All credentials are encrypted at rest.
  </Step>
</Steps>

<Note>
  You can create multiple credentials for the same integration type to connect to different accounts, environments, or clients.
</Note>

#### OAuth Authentication

For integrations that support OAuth (MYOB, Xero OAuth2), the setup process is streamlined:

<Steps>
  <Step title="Open Configuration">
    Click the **Configure** button on the OAuth-enabled integration card.
  </Step>

  <Step title="Review the OAuth Process">
    Read the "What happens next" information to understand the authentication flow:

    * You'll be redirected to the service's secure login page
    * You'll sign in with your credentials for that service
    * You'll grant permission for Atlastix to access your account
    * You'll be redirected back automatically
    * A credential will be created for you
  </Step>

  <Step title="Initiate OAuth Flow">
    Click the **Connect to \[Service]** button. A new window will open showing the service's login page.
  </Step>

  <Step title="Authenticate with the Service">
    Sign in using your credentials for the external service (e.g., your MYOB email and password).
  </Step>

  <Step title="Grant Permissions">
    Review and approve the permissions that Atlastix is requesting. These permissions are typically read-only or limited to specific functions.
  </Step>

  <Step title="Complete Setup">
    After granting permission, you'll be redirected back to Atlastix. The credential will be created automatically and appear in your credentials list.
  </Step>

  <Step title="Configure Additional Settings">
    If needed, configure Security Groups or other settings, then save the credential.
  </Step>
</Steps>

<Tip>
  OAuth credentials can be revoked at any time from your account settings in the external service. The platform will notify you if a credential needs to be re-authorized.
</Tip>

### Viewing and Managing Credentials

After configuration, credentials are listed in the credentials panel:

1. Click **Configure** on an integration to view all saved credentials
2. Select a credential from the list to view its details
3. Edit settings or Security Group assignments as needed
4. Delete credentials you no longer need

<Warning>
  Deleting a credential will immediately remove access for any agents using it. Verify that no active agents depend on a credential before deletion.
</Warning>

## Configuring Data Ingest Integrations

Data Ingest integrations use Meltano-Singer taps to bring external data into the platform.

### One-to-One vs One-to-Many

Data Ingest connectors come in two configurations:

<CardGroup cols={2}>
  <Card title="One-to-One" icon="user">
    For connecting to a single customer or account. Use this when managing your own data.
  </Card>

  <Card title="One-to-Many" icon="users">
    For managed service providers (MSPs) connecting to multiple client accounts. Use this when managing data for many customers.
  </Card>
</CardGroup>

### Setting Up Data Ingest

<Steps>
  <Step title="Select the Appropriate Connector">
    Choose the One-to-One or One-to-Many version based on your use case.
  </Step>

  <Step title="Configure Connection">
    Click **Configure** and provide the required credentials and settings for the data source.
  </Step>

  <Step title="Set Up Security">
    Assign Security Groups to control access to the ingested data.
  </Step>

  <Step title="Enable the Integration">
    Click **Enable** to activate data ingestion. The platform will begin syncing data based on the configured schedule.
  </Step>

  <Step title="Verify Data Availability">
    Once ingestion completes, the data becomes available for your agents to query and analyze.
  </Step>
</Steps>

## Enabling and Disabling Integrations

### Enabling an Integration

To make an integration available for use:

1. Ensure at least one credential is configured
2. Click the **Enable** button on the integration card
3. The integration is now available to add to your agents

### Disabling an Integration

To temporarily disable an integration:

1. Click the **Enable** button again (it toggles to a disable function)
2. Agents using this integration will no longer be able to access it
3. Existing credentials are preserved and can be re-enabled later

## Adding Integrations to Agents

Once an integration is enabled, you can add it to your agents:

<Steps>
  <Step title="Open Agent Configuration">
    Navigate to the **Agents** page and click **Configure** on the agent you want to modify.
  </Step>

  <Step title="Go to Integrations Tab">
    Click the **Integrations** tab in the agent configuration panel.
  </Step>

  <Step title="Add the Integration">
    Find the integration you want to add and click the **Add** button.
  </Step>

  <Step title="Select Credentials">
    If multiple credentials exist for this integration, select which one this agent should use.
  </Step>

  <Step title="Save Agent Configuration">
    Click **Save** in the agent header to apply your changes.
  </Step>
</Steps>

The agent can now use this integration during conversations and task execution.

## Security Best Practices

<CardGroup cols={2}>
  <Card title="Use Security Groups" icon="shield">
    Always assign integrations to appropriate Security Groups to control access by team or role.
  </Card>

  <Card title="Limit Database Access" icon="lock">
    Use Allowed Patterns to restrict database integrations to specific tables or schemas.
  </Card>

  <Card title="Rotate Credentials" icon="key">
    Regularly update and rotate API keys and passwords for enhanced security.
  </Card>

  <Card title="Monitor Usage" icon="eye">
    Review which agents are using each integration and remove access when no longer needed.
  </Card>
</CardGroup>

### Security Notes

<Note>
  All credentials are encrypted and stored securely. The platform enforces read-only access for database connections to prevent accidental data modification or deletion.
</Note>

<Note>
  OAuth credentials include automatic token refresh. If a token expires, the platform will attempt to refresh it automatically. If refresh fails, you'll be prompted to re-authenticate.
</Note>

## Available Integrations

### Agent Integrations (MCP)

<AccordionGroup>
  <Accordion title="Database Integrations">
    * **ClickHouse Database**: Connect to ClickHouse columnar databases for high-performance analytics
    * **SQL Database**: Integrate any standard SQL database with read-only access
  </Accordion>

  <Accordion title="Cloud Services">
    * **Azure**: Microsoft's official MCP Server for Azure cloud services management and operations
    * **Amazon Web Services**: AWS official MCP Server for cloud services management and operations
  </Accordion>

  <Accordion title="Development Tools">
    * **GitHub**: GitHub's official MCP Server for repository management, issues, pull requests, and more
  </Accordion>

  <Accordion title="Business Applications">
    * **MYOB**: Atlastix's MCP server for MYOB accountancy software with OAuth authentication
    * **Xero**: Xero's official MCP Server for payroll and bank management
    * **Xero OAuth2**: Xero integration with OAuth2 authentication for enhanced security
  </Accordion>

  <Accordion title="Documentation and Knowledge">
    * **AWS Knowledge Base**: Amazon's official vector search for AWS documentation
  </Accordion>
</AccordionGroup>

### Data Ingest Integrations

<AccordionGroup>
  <Accordion title="Cisco Products">
    * **Cisco APIX CCW Aggregated**: Split Cisco CCW aggregated datasets into customer records
    * **Cisco Meraki One to One**: Cisco Meraki connector for individual customers
    * **Cisco Meraki One to Many**: Cisco Meraki connector for MSPs managing multiple clients
  </Accordion>

  <Accordion title="Microsoft Services">
    * **Microsoft Azure Advisor** (One to One and One to Many)
    * **Microsoft Intune** (One to One and One to Many)
    * **Microsoft Entra** (One to One and One to Many)
    * **Microsoft Defender** (One to One and One to Many)
  </Accordion>

  <Accordion title="Other Platforms">
    * **Corestack**: Corestack platform connector
  </Accordion>
</AccordionGroup>

## Troubleshooting

<AccordionGroup>
  <Accordion title="Connection failures">
    * Verify that credentials are correct and haven't expired
    * Check that host URLs and ports are accurate
    * Ensure firewall rules allow connections from Atlastix
    * For OAuth, try re-authenticating by clicking Connect again
  </Accordion>

  <Accordion title="Agent can't access integration">
    * Confirm the integration is enabled
    * Verify the integration is added in the agent's configuration
    * Check that the agent has access to the credential's Security Group
    * Ensure the credential hasn't been deleted or revoked
  </Accordion>

  <Accordion title="OAuth authentication fails">
    * Clear browser cache and cookies, then try again
    * Ensure pop-ups are allowed for the Atlastix domain
    * Verify you have the correct permissions in the external service
    * Check that the external service is not experiencing downtime
  </Accordion>

  <Accordion title="Data Ingest not syncing">
    * Verify the connector is enabled
    * Check that credentials have the necessary permissions to read data
    * Review sync logs for error messages
    * Confirm the external service API is accessible
  </Accordion>
</AccordionGroup>

## Next Steps

<CardGroup cols={2}>
  <Card title="Configure Your Agents" icon="robot" href="/agents/managing-agents">
    Add integrations to your agents to unlock their full potential
  </Card>

  <Card title="Learn About Agents" icon="book" href="/agents/overview">
    Understand how agents use integrations to accomplish tasks
  </Card>
</CardGroup>