VOOZH about

URL: https://www.cdata.com/kb/tech/api-cloud-windsurf.rst

⇱ Integrate Live API Data in the Windsurf IDE via CData Connect AI


Integrate Live API Data in the Windsurf IDE via CData Connect AI

πŸ‘ Yazhini G
Yazhini G
Technical Marketing Engineer
Leverage the CData Connect AI Remote MCP Server to enable Windsurf's Cascade agent to securely access and query live API data from within the IDE.

Windsurf is an AI-native IDE built around Cascade, an autonomous coding agent that understands project context and executes multi-step tasks directly inside the editor. Cascade supports the Model Context Protocol (MCP), allowing the agent to discover and call external tools and data sources without leaving the development environment.

By integrating Windsurf with CData Connect AI through the built-in MCP server, the Cascade agent gains governed, real-time access to live API data. This enables developers to list catalogs, inspect schemas, and query records from API data within the IDE using natural language prompts.

This article explains how to configure API connectivity in Connect AI, generate the required personal access token, configure the Connect AI MCP Server in Windsurf, and verify the integration by querying live API data from the Cascade chat.

Step 1: Configure your API connectivity for Windsurf

Connectivity to your API from Windsurf is made possible through Connect AI's Remote MCP Server. To interact with API data from Windsurf, start by creating and configuring a your API connection in Connect AI.

  1. Log into Connect AI, click Sources, and then click Add Connection
  2. πŸ‘ Adding a connection in Connect AI
  3. Select API from the Add Connection panel
  4. πŸ‘ Selecting data source
  5. Enter the necessary authentication properties to connect to your API.

    To connect to your API, configure the following properties on the Global Settings page:

    • In Authentication, select the Type and fill in the required properties
    • In Headers, add the required HTTP headers for your API
    • In Pagination, select the Type and fill in the required properties

    After the configuring the global settings, navigate to the Tables to add tables. For each table you wish to add:

    1. Click "+ Add"
    2. Set the Name for the table
    3. Set Request URL to the API endpoint you wish to work with πŸ‘ Setting the Request URL (Harvest is shown)
    4. (Optional) In Parameters, add the required URL Parameters for your API endpoint
    5. (Optional) In Headers, add the required HTTP headers for the API endpoint
    6. In Table Data click " Configure"
    7. Review the response from the API and click "Next" πŸ‘ Reviewing the API response (Harvest is shown)
    8. Select which element to use as the Repeated Elements and which elements to use as Columns and click "Next" πŸ‘ Configuring the schema based on the API response(Harvest is shown)
    9. Preview the tabular model of the API response and click "Confirm" πŸ‘ Previewing the tabular model of the API response (Harvest is shown)
  6. Click Save & Test
  7. Navigate to the Permissions tab and update user-based permissions
  8. πŸ‘ Updating permissions

Add a Personal Access Token

A Personal Access Token (PAT) is used to authenticate the connection to Connect AI from Windsurf. It is best practice to create a separate PAT for each integration to maintain granular access control.

  1. Click the gear icon () at the top right of the Connect AI app to open Settings
  2. On the Settings page, go to the Access Tokens section and click Create PAT
  3. Give the PAT a descriptive name and click Create
  4. πŸ‘ Creating a new PAT
  5. Copy the token when displayed and store it securely. It will not be shown again

With the your API connection configured and a PAT generated, Windsurf can now connect to API data.

Step 2: Configure Connect AI MCP in Windsurf

Next, configure the Connect AI Remote MCP Server in Windsurf so that the Cascade agent can discover and call live data tools through Connect AI.

  1. Download and install the Windsurf IDE
  2. Open Windsurf, click your profile icon in the top right, and select Windsurf Settings πŸ‘ Opening Windsurf Settings from the profile menu
  3. Under the Cascade section, locate MCP Servers and click Open MCP Registry πŸ‘ Opening the MCP Registry from Cascade settings
  4. In the MCP Marketplace, click Add custom MCP in the top right πŸ‘ Adding a custom MCP server
  5. This opens the mcp_config.json file. Paste the following JSON:
    {
     "mcpServers": {
     "cdata-mcp": {
     "serverUrl": "https://mcp.cloud.cdata.com/mcp",
     "headers": {
     "Authorization": "Basic your_base64_encoded_email_PAT",
     "Content-Type": "application/json"
     }
     }
     }
    }
    		

    Note: Windsurf will use Basic authentication with Connect AI. Combine your Connect AI user email and the PAT you created earlier in the format email:PAT, base64 encode the combined string, and prefix it with Basic. For example, given [email protected]:ABC123...XYZ789, the Authorization header value becomes something like: Basic dXNlckBkb21haW4uY29tOkFCQzEyMy4uLlhZWjc4OQ==

    πŸ‘ Pasting Connect AI MCP Server configuration
  6. Save the mcp_config.json file and return to the MCP Registry
  7. Under Installed, confirm that cdata-mcp is listed and marked as Enabled πŸ‘ Confirming cdata-mcp is installed and enabled

With the MCP server registered and enabled, Windsurf is ready to query live API data through Connect AI.

Step 3: Query live API data from Windsurf

With the integration complete, use the Cascade chat panel in Windsurf to interact with live API data through natural language prompts.

  1. On the top bar of Windsurf, switch from Editor to Agent to open a new Cascade chat
  2. At the bottom of the chat panel, confirm that the cdata-mcp server is listed and the toggle is enabled πŸ‘ Enabling the cdata-mcp server in the Cascade chat
  3. Start interacting with the agent by entering prompts like:
    • List all catalogs in my cdata-mcp connection
    • Show the available schemas and tables for API
    • Query the top 5 records from a table in API data
  4. The Cascade agent calls the Connect AI MCP Server and returns live results from API data πŸ‘ Querying live data from Cascade in Windsurf

At this point, your Windsurf IDE communicates with the Connect AI MCP Server and retrieves live API data through remote MCP directly from the editor.

Get CData Connect AI

To access hundreds of SaaS, Big Data, and NoSQL sources directly from your cloud applications, try CData Connect AI today! Download a free 14-day trial of CData Connect AI today, and as always, our Support Team is available to assist you with any questions you may have.