Skip to content

Conversation

@VivekVinushanth
Copy link
Contributor

@VivekVinushanth VivekVinushanth commented May 29, 2025

Add Asgardeo-specific guide for configuring API resources, scopes, and RBAC to support tutorials.

@gao-sun gao-sun requested review from Copilot and xiaoyijun May 29, 2025 05:02
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds Asgardeo-specific instructions to the existing Whoami and Todo Manager tutorials, guiding users through Asgardeo configuration for user info retrieval, client registration, API resources, scopes, and RBAC.

  • Added new <TabItem value="asgardeo"> sections in both tutorials for Asgardeo integration.
  • Included step-by-step guides for client registration, scope configuration, and role setup in the Asgardeo Console.
  • Updated links and notes to reflect Asgardeo’s signup and console URLs.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 7 comments.

File Description
docs/tutorials/whoami/README.mdx Inserted Asgardeo tabs for userinfo endpoint and client setup.
docs/tutorials/todo-manager/README.mdx Added Asgardeo sections for API resource/scopes config and client registration.
Comments suppressed due to low confidence (1)

docs/tutorials/whoami/README.mdx:70

  • [nitpick] Indentation on this closing </TabItem> has an extra leading space. Align it with other closing tags for consistency.
 </TabItem>

@xiaoyijun
Copy link
Contributor

Hi @VivekVinushanth , I just rebased your branch with the latest codes.
However, the document you submitted is missing some content:

  1. Missing issuer config in "whoami#set-up-mcp-auth"
  2. Missing scope configuration in "todo-manager#access-tokens-with-scopes"

@VivekVinushanth
Copy link
Contributor Author

Hi @VivekVinushanth , I just rebased your branch with the latest codes. However, the document you submitted is missing some content:

  1. Missing issuer config in "whoami#set-up-mcp-auth"
  2. Missing scope configuration in "todo-manager#access-tokens-with-scopes"

Hi @xiaoyijun apologies for the delay in responding. Have addressed the comments. Can you please check and let me know how I can be of help to get this added to your documents ?

@VivekVinushanth
Copy link
Contributor Author

@xiaoyijun a gentle reminder on this.

@xiaoyijun xiaoyijun changed the title Add Asgardeo for the tutorials docs: add Asgardeo for the tutorials Jun 13, 2025
@xiaoyijun
Copy link
Contributor

Hi @VivekVinushanth, currently, merging is blocked because the commits are missing GPG signatures (verified signature).
Please sign your commits. You can refer to this guide: GitHub GPG Signature Guide

# This is the 1st commit message:

docs: merge upstream

# This is the commit message mcp-auth#2:

docs: address comments
@xiaoyijun xiaoyijun force-pushed the vv-add-asgardeo branch 2 times, most recently from 3887ebf to 36ed787 Compare June 13, 2025 14:05
@xiaoyijun
Copy link
Contributor

Hi @VivekVinushanth , thank you for the update!

I’ve reviewed the changes, and currently the structure doesn’t fully align with our tutorial framework.

  • For every section where users switch between different auth providers, we expect Asgardeo to be included consistently, just like the others.
  • In the “Register MCP Inspector as a client” section of the Todo Manager tutorial, I didn’t see instructions for creating a client in Asgardeo (although it was mentioned elsewhere). Even if Asgardeo supports Dynamic Client Registration, this should still be clearly indicated in the relevant section.

To ensure a smooth and consistent experience for users, we’d like the Asgardeo instructions to follow the same structure and flow as the rest of the tutorial. You might want to refer to the Logto example as a guide for reorganizing the content.

Please feel free to reach out if you have any questions.

@VivekVinushanth
Copy link
Contributor Author

Hi @xiaoyijun will check on this

@VivekVinushanth
Copy link
Contributor Author

Hi @xiaoyijun added the necessary content. Can you please let me know if that make sense?

@VivekVinushanth
Copy link
Contributor Author

@xiaoyijun A kind reminder on this

@VivekVinushanth
Copy link
Contributor Author

Sincere apologies for bugging again @xiaoyijun. If there is anything needed from our end please let us know so that we can shape this document.

Thanks and regards,

@pavinduLakshan
Copy link
Contributor

Hi @xiaoyijun a kind reminder on this. Thanks in advance for your time!

@xiaoyijun
Copy link
Contributor

Hi @pavinduLakshan @VivekVinushanth ,

Sorry for the delay—I’ve been busy with a lot of things recently and haven’t had time to go through and test your tutorial yet. Thanks so much for your patience and for the reminders. I’ll do my best to check it out in the next few days.

Thanks again for your understanding!

@xiaoyijun
Copy link
Contributor

I noticed that many steps in the tutorial mention creating an application. Is there a way to optimize the process into more progressive, step-by-step instructions?

@VivekVinushanth
Copy link
Contributor Author

I noticed that many steps in the tutorial mention creating an application. Is there a way to optimize the process into more progressive, step-by-step instructions?

@xiaoyijun we truely appreciat your time and efforts. Thanks a lot.
And I have addressed the other comments. To be clear, I hope you are referring to :https://github.com/mcp-auth/docs/pull/40/files#diff-8943d0a44b2b2db5374e0c209460918b21acd6aac00d4d84c43ebfc7a2644793R336

If you have already created the application
    - Navigate to **Application > MCP Inspector Application > Roles tab**
    - Select **Application Role** as the audience type, then click **New Role**
    - Create an `Admin` role and attach all three scopes
    - Create a `User` role and attach only the `create:todos` scope

Please note that only https://github.com/mcp-auth/docs/pull/40/files#diff-8943d0a44b2b2db5374e0c209460918b21acd6aac00d4d84c43ebfc7a2644793R728 talks about creating an application.

https://github.com/mcp-auth/docs/pull/40/files#diff-8943d0a44b2b2db5374e0c209460918b21acd6aac00d4d84c43ebfc7a2644793R336 section refers how to attach api-resources to the application created. In Asgardeo , API resources has to be added to the created application.

@VivekVinushanth
Copy link
Contributor Author

A kind reminder on this @xiaoyijun

@xiaoyijun xiaoyijun merged commit ed2b057 into mcp-auth:master Jul 31, 2025
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants