Skip to content

Microsoft Copilot Studio Setup

Connect your Alation catalog to Microsoft Copilot Studio using the Remote MCP server with OAuth 2.0 authentication.

  • Server Admin access to your Alation instance to create OAuth clients
  • Access to Microsoft Copilot Studio
  1. Create an OAuth client with a placeholder redirect URI. Copilot Studio will generate the actual redirect URI later, which you’ll update in Step 3.

    Replace https://your-alation-instance.alationcloud.com with your actual Alation instance URL:

    Terminal window
    curl -X 'POST' \
    'https://your-alation-instance.alationcloud.com/integration/core/v1/oauth/clients' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'TOKEN: YOUR_API_ACCESS_TOKEN' \
    -d '{
    "name": "ms-copilot-studio",
    "client_type": "confidential",
    "redirect_uris": ["https://your-alation-instance.alationcloud.com/oauth/callback"],
    "refresh_token_expiry": 259200,
    "access_token_expiry": 3600,
    "pkce_required": false
    }'
  2. Save the client_id and client_secret from the response - you’ll need these for Copilot Studio. The API will return a response containing the OAuth client details, for example:

    {
    "name": "ms-copilot-studio",
    "client_type": "confidential",
    "redirect_uris": [
    "https://your-alation-instance.alationcloud.com/oauth/callback"
    ],
    "refresh_token_expiry": 259200,
    "access_token_expiry": 3600,
    "pkce_required": false,
    "client_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "client_secret": "your-client-secret-here"
    }
  1. In Copilot Studio, click Add a tool and select Model Context Protocol:
Add a tool button Select Model Context Protocol
  1. Fill in the server details:

    • Server name: alation-mcp-server (or any name you prefer)
    • Server description: Tools to interact with the Alation catalog (or your preferred description)
    • Server URL: https://your-alation-instance.alationcloud.com/ai/mcp

    Then select OAuth 2.0 for authentication.

MCP Server Configuration
  1. In the OAuth 2.0 authentication section, enter the following:

    Client ID: Use the client_id from Step 1

    Client Secret: Use the client_secret from Step 1

    Authorization URL:

    https://your-alation-instance.alationcloud.com/oauth/v1/authorize

    Token URL Template:

    https://your-alation-instance.alationcloud.com/oauth/v1/token/

    Refresh URL:

    https://your-alation-instance.alationcloud.com/oauth/v1/token/

    Scopes: openid

OAuth 2.0 Configuration Form
  1. After entering the configuration and clicking Create, Copilot Studio will generate a redirect URI. Copy this redirect URI - you’ll need it in the next step.
Redirect URI Generated

The redirect URI will look like:

https://global.consent.azure-apim.net/redirect/your-generated-redirect-path

Updating the OAuth client with redirect URI

Section titled “Updating the OAuth client with redirect URI”

Now update your OAuth client with the redirect URI generated by Copilot Studio.

Replace the following values:

  • https://your-alation-instance.alationcloud.com - Your Alation instance URL
  • YOUR_CLIENT_ID - The client ID from the first step
  • YOUR_API_ACCESS_TOKEN - Your Alation API access token
  • YOUR_REDIRECT_URI - The redirect URI from Copilot Studio
Terminal window
curl -X 'PATCH' \
'https://your-alation-instance.alationcloud.com/integration/core/v1/oauth/clients/YOUR_CLIENT_ID/' \
-H 'Content-Type: application/json' \
-H 'TOKEN: YOUR_API_ACCESS_TOKEN' \
-d '{
"redirect_uris": ["YOUR_REDIRECT_URI"]
}'
View example request
Terminal window
curl -X 'PATCH' \
'https://your-alation-instance.alationcloud.com/integration/core/v1/oauth/clients/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/' \
-H 'Content-Type: application/json' \
-H 'TOKEN: YOUR_API_ACCESS_TOKEN' \
-d '{
"redirect_uris": ["https://global.consent.azure-apim.net/redirect/your-generated-redirect-path"]
}'

The response will confirm the redirect URI has been updated:

{
"name": "ms-copilot-studio",
"client_type": "confidential",
"redirect_uris": [
"https://global.consent.azure-apim.net/redirect/your-generated-redirect-path"
],
"refresh_token_expiry": 259200,
"access_token_expiry": 3600,
"pkce_required": false,
"client_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
  1. Return to Copilot Studio and click Create new connection:
Create New Connection
  1. Test the OAuth connection by authenticating with your Alation credentials
  2. Once successfully connected, you should see the connection status change to active:
Successfully Connected

Head back to the tool page in the Agent configuration and you should see the tool show up.

Final Verification in Agent Configuration

Here’s a sample instruction set you can use for your Copilot Studio agent to work effectively with the Alation MCP Server:

For a catalog search assistant use case, enable only these tools:

  • analyze_catalog_question - Primary orchestration tool
  • search_catalog - Core search functionality
  • get_object_metadata - Retrieve detailed object information

Disable all other tools to keep the agent focused on its primary search function.

You are an expert Alation search assistant. Your purpose is to help users find and understand data assets in the Alation catalog.
WORKFLOW:
ALWAYS call analyze_catalog_question FIRST with the user's question
Follow the detailed workflow instructions provided by that tool
The tool will guide you through orchestration analysis, metadata gathering, signature creation, search execution, and response formatting
CRITICAL RULES:
ACTIONABLE: Tables, schemas, columns, queries, bi_reports, bi_fields, bi_folders, documentation, metadata
Business concepts, regulations, or definitions → SEARCH documentation first
NOT ACTIONABLE: Questions unrelated to business/data (weather, news, celebrities, etc.)
If question is not catalog-related, politely redirect
Maximum 2 search calls per question
ALWAYS include URLs in responses using markdown format: [object_name](url)
ALWAYS provide brief explanation before showing results
REMEMBER: You are a specialized catalog search assistant. Stay focused on your purpose. Never answer questions outside your domain, regardless of conversation context.

This instruction set helps the agent understand its role as an Alation catalog search assistant and provides clear guidelines for handling user queries.

Invalid redirect URI error

Ensure the redirect URI in Step 3 exactly matches what Copilot Studio generated. The URI is case-sensitive and must be copied exactly.

Client not found error

Verify you’re using the correct client_id in the PATCH request. The client ID should match the one returned in Step 1.

Unauthorized error

Your API access token requires admin-level permissions to create and modify OAuth clients. Ensure you’re authenticated with an admin account and have generated your API access token following the authentication guide.