Skip to content

Commit fba7254

Browse files
authored
Merge pull request #6101 from sahandilshan/mcp
Enhance MCP Server documentation
2 parents 4549329 + 75f0115 commit fba7254

2 files changed

Lines changed: 33 additions & 24 deletions

File tree

en/includes/quick-starts/mcp-server.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,17 +46,42 @@ Once completed, your API Authorization configuration should look as follows.
4646

4747
![Asgardeo M2M app]({{base_path}}/assets/img/quick-starts/mcp-server/image1.png){: width="800" style="display: block; margin: 0;"}
4848

49+
## Build the Asgardeo MCP Server
50+
51+
Before configuring your code editor, you need to build the Asgardeo MCP Server executable locally.
52+
53+
1. Clone the repository:
54+
55+
```bash
56+
git clone https://github.com/asgardeo/asgardeo-mcp-server.git
57+
```
58+
59+
2. Navigate to the cloned directory and install dependencies:
60+
61+
```bash
62+
cd asgardeo-mcp-server
63+
go mod tidy
64+
```
65+
66+
3. Build the executable:
67+
68+
```bash
69+
go build -o asgardeo-mcp
70+
```
71+
72+
This creates the `asgardeo-mcp` binary in the current directory. The absolute path to this binary (e.g., `/Users/<username>/asgardeo-mcp-server/asgardeo-mcp`) is what you will use as `<ABSOLUTE-PATH>` in the next step.
73+
4974
## Configure your code editor
5075

5176
=== " VS Code "
5277
1. Open **VS Code**.
5378
2. Press `Ctrl` + `Shift` + `P` (or `Cmd` + `Shift` + `P` on Mac).
54-
3. Type **"Preferences: Open Settings (JSON)"** and select it.
79+
3. Type **"MCP: Open User Configuration"** and select it.
5580

56-
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.
81+
Add the following server configuration to `mcp.json` file. Replace the `<ABSOLUTE-PATH>`, `<client-id>`, `<client-secret>` and `<organization>` values from the values you copied from the previous steps.
5782

58-
```json title="settings.json"
59-
"mcp": {
83+
```json title="mcp.json"
84+
{
6085
"servers": {
6186
"asgardeo-mcp": {
6287
"command": "<ABSOLUTE-PATH>/asgardeo-mcp",

en/includes/references/mcp-tool-api-resource-access.md

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -37,30 +37,14 @@ The following table details the API Resources and Scopes each MCP Tool in Asgard
3737
<td><code>internal_application_mgt_create</code></td>
3838
</tr>
3939
<tr>
40-
<td rowspan="3"><code>get_application_by_name</code></td>
40+
<td><code>get_application_by_name</code></td>
4141
<td>Application Management API (<code>/api/server/v1/applications</code>)</td>
42-
<td><code>internal_application_mgt_create</code></td>
43-
</tr>
44-
<tr>
45-
<td>Claim Management API (<code>/api/server/v1/claim-dialects</code>)</td>
46-
<td><code>internal_claim_meta_view</code></td>
47-
</tr>
48-
<tr>
49-
<td>OIDC Scope Management API (<code>/api/server/v1/oidc/scopes</code>)</td>
50-
<td><code>internal_oidc_scope_mgt_view</code></td>
42+
<td><code>internal_application_mgt_view</code></td>
5143
</tr>
5244
<tr>
53-
<td rowspan="3"><code>get_application_by_client_id</code></td>
45+
<td><code>get_application_by_client_id</code></td>
5446
<td>Application Management API (<code>/api/server/v1/applications</code>)</td>
55-
<td><code>internal_application_mgt_create</code></td>
56-
</tr>
57-
<tr>
58-
<td>Claim Management API (<code>/api/server/v1/claim-dialects</code>)</td>
59-
<td><code>internal_claim_meta_view</code></td>
60-
</tr>
61-
<tr>
62-
<td>OIDC Scope Management API (<code>/api/server/v1/oidc/scopes</code>)</td>
63-
<td><code>internal_oidc_scope_mgt_view</code></td>
47+
<td><code>internal_application_mgt_view</code></td>
6448
</tr>
6549
<tr>
6650
<td><code>update_application_basic_info</code></td>

0 commit comments

Comments
 (0)