Asgardeo MCP Server Quickstart

Preview

Welcome to the Asgardeo MCP Server Quickstart! In this document, you will learn how to build, install, and configure the Asgardeo MCP Server with VS Code, Claude Desktop, Cursor, Windsurf, and other MCP-compatible clients.

Note

The Asgardeo MCP Server is currently in Preview. Some features may be subject to changes in future releases.

[//] STEPS_START

Configure Asgardeo access for MCP server

The Asgardeo MCP Server communicates with the Asgardeo Management APIs to perform the actions required by each MCP tool. To enable this, it must first get an access token with the appropriate scopes. This requires configuring access to your Asgardeo organization by creating a Machine-to-Machine (M2M) application and authorizing API Resources and Scopes to access the necessary APIs.

Follow these steps to set up the M2M application:

Sign into Asgardeo console and navigate to Applications > New Application. Then, select M2M Application and complete the wizard popup by providing a suitable name.

Example

name: Asgardeo-MCP-Server

Note down the following values from the Protocol tab of the registered application. You will need them in step-3.

• client-id from the Protocol tab.
• client-secret from the Protocol tab.
• The name of your Asgardeo organization

---

Next, you need to authorize the API resources and corresponding scopes required for the actions performed by the MCP tools. The following table includes the required API resources and scopes for all currently supported tools.

Asgardeo Management API	Required scopes
Application Management API (/api/server/v1/applications)	internal_application_mgt_view, internal_application_mgt_update, internal_application_mgt_create
API Resource Management API (/api/server/v1/api-resources)	internal_api_resource_update, internal_api_resource_create, internal_api_resource_view
Identity Provider Management API (/api/server/v1/identity-providers)	internal_idp_view
Authenticators Management API (/api/server/v1/authenticators)	internal_authenticator_view
Claim Management API (/api/server/v1/claim-dialects)	internal_claim_meta_view
SCIM2 Users API (/scim2/Users)	internal_user_mgt_create
OIDC Scope Management API (/api/server/v1/oidc/scopes)	internal_oidc_scope_mgt_view

To authorize API resources, navigate to the API Authorization tab within your Asgardeo application settings and click the Authorize an API Resource button. In the pop-up window that appears, use the dropdown to search and select the necessary API Resources from the Management APIs and authorize necessary scopes.

Note

You can selectively authorize API Resources and scopes based on the specific MCP tools you plan to use. For detailed guidance on which API Resources and Scopes are needed by each tool, see the API resources and scopes required for MCP tools section.

Once completed, your API Authorization configuration should resemble the example shown in the screenshot.

Build Asgardeo MCP server

Download the source code from the Asgardeo MCP Server GitHub repository. Choose one of the following methods:

Clone the repository locally using GitDownload as a ZIP archive

Make sure Git is installed on your machine, then run the following commands.

Clone the full repo:

git clone https://github.com/asgardeo/asgardeo-mcp-server

Change directory into asgardeo-mcp-server:

cd asgardeo-mcp-server

Checkout the specific release tag:

git checkout tags/v0.1.0

Download the source ZIP from the release page of the repository, then extract the contents to your preferred directory.

Then, install the required dependencies by running the following command.

go mod tidy

Now, you can build the Asgardeo MCP server by running the following command. Make sure you have installed Go as mentioned in prerequisites section.

go build -o asgardeo-mcp

After running the above command, make sure to copy the absolute path to the generated binary. This path will be referenced as <ABSOLUTE-PATH>in the next step.

Configure your code editor

VS Code Cursor Windsurf Claude Desktop Other

1. Open VS Code.
2. Press Ctrl + Shift + P (or Cmd + Shift + P on Mac).
3. Type "Preferences: Open Settings (JSON)" and select it.

Append the following configuration to settings.json file. Replace the <ABSOLUTE-PATH>, <client-id>, <client-secret> and <organization> values from the values you copied from the previous steps.

settings.json

"mcp": {
    "servers": {
        "asgardeo-mcp": {
            "command": "<ABSOLUTE-PATH>/asgardeo-mcp",
            "args": [],
            "env": {
                "ASGARDEO_BASE_URL": "https://api.asgardeo.io/t/<organization>",
                "ASGARDEO_CLIENT_ID": "<client-id>",
                "ASGARDEO_CLIENT_SECRET": "<client-secret>"
            }
        }
    }
}

1. Open Cursor.
2. Click on Cursor > Settings > Cursor Settings.
3. Switch to MCP tab.
4. Click on Add new global MCP server button. This will open mcp.json file in the editor itself.

Append the following configuration to settings.json file. Replace the <ABSOLUTE-PATH>, <client-id>, <client-secret> and <organization> values from the values you copied from the previous steps.

mcp.json

{
    "mcpServers": {
        "asgardeo-mcp": {
            "command": "<ABSOLUTE-PATH>/asgardeo-mcp",
            "args": [],
            "env": {
                "ASGARDEO_BASE_URL": "https://api.asgardeo.io/t/<organization>",
                "ASGARDEO_CLIENT_ID": "<client-id>",
                "ASGARDEO_CLIENT_SECRET": "<client-secret>"
            }
        }
    }
}

1. Open Windsurf.
2. Click on Windsurf > Windsurf Settings > Cursor Cascade.
3. Switch to MCP tab.
4. Click on Add erver button next to Model Context Protocol (MCP) Servers. Then click the Add custom Server button will open mcp_config.json file in the editor itself.

Append the following configuration to mcp_config.json file. Replace the <ABSOLUTE-PATH>, <client-id>, <client-secret> and <organization> values from the values you copied from the previous steps.

`mcp_config.json.json

"{
    "servers": {
        "asgardeo-mcp": {
            "command": "<ABSOLUTE-PATH>/asgardeo-mcp",
            "args": [],
            "env": {
                "ASGARDEO_BASE_URL": "https://api.asgardeo.io/t/<organization>",
                "ASGARDEO_CLIENT_ID": "<client-id>",
                "ASGARDEO_CLIENT_SECRET": "<client-secret>"
            }
        }
    }
}

1. Open Claude Desktop.
2. Click on Claude Desktop > Settings > Developer.
3. Click on Edit Config button. This will open claude_desktop_config.json file location and you can open this file using an text editor.

Append the following configuration to claude_desktop_config.json file. Replace the <ABSOLUTE-PATH>, <client-id>, <client-secret> and <organization> values from the values you copied from the previous steps.

claude_desktop_config.json

{
    "mcpServers": {
        "asgardeo-mcp": {
            "command": "<ABSOLUTE-PATH>/asgardeo-mcp",
            "args": [],
            "env": {
                "ASGARDEO_BASE_URL": "https://api.asgardeo.io/t/<organization>",
                "ASGARDEO_CLIENT_ID": "<client-id>",
                "ASGARDEO_CLIENT_SECRET": "<client-secret>"
            }
        }
    }
}

Use the following settings to configure your MCP-compatible client application.

Make sure to replace the <ABSOLUTE-PATH>, <client-id>, <client-secret> and <organization> values from the values you copied from the previous steps.

{
    "mcpServers": {
        "asgardeo-mcp": {
            "command": "<ABSOLUTE-PATH>/asgardeo-mcp",
            "args": [],
            "env": {
                "ASGARDEO_BASE_URL": "https://api.asgardeo.io/t/<organization>",
                "ASGARDEO_CLIENT_ID": "<client-id>",
                "ASGARDEO_CLIENT_SECRET": "<client-secret>"
            }
        }
    }
}

Verify Asgardeo MCP server setup

Use the following simple prompt to verify whether you have configured Asgardeo MCP Server successfully.

List my Asgardeo applications, names only

Depending on the code editor you're using, you should see a list of results. The output may vary based on the number of applications you've created in Asgardeo, but you should see at least one application name listed.

VS Code Cursor Windsurf Claude Desktop

Asgardeo application list displayed in VS Code.

Asgardeo application list displayed in Cursor.

Asgardeo application list displayed in Windsurf.

Asgardeo application list displayed in Claude Desktop.

Build a real-world sample

Now that you’ve configured and verified the Asgardeo MCP Server with your preferred code editor, it’s time to build a real-world example. The following quickstarts are great starting points to try out the Asgardeo MCP Server alongside your AI toolkit:

• Asgardeo React Quickstart
• Asgardeo Angular Quickstart
• Asgardeo React Spring Quickstart

Explore these guides to put your setup into action and see how natural-language-powered identity management can accelerate your development workflow.

Note

During tool execution, you will be prompted to give explicit consent for the action. It’s recommended to approve actions with "Approve Once" option rather than selecting "Approve Always" option so you retain full control and visibility over the operations performed in your Asgardeo organization.

[//] STEPS_END